Files
adcs_api
cbor_protocol
channel_protocol
clyde_3g_eps_api
clyde_3g_eps_service
comms_service
db_test
eps_api
example_rust_c_service
example_rust_service
extern_lib
file_protocol
file_service
iobc_supervisor_service
isis_ants
isis_ants_api
isis_ants_service
isis_imtq_api
isis_iobc_supervisor
kubos_app
kubos_app_service
kubos_build_helper
kubos_file_client
kubos_service
kubos_shell_client
kubos_system
kubos_telemetry_db
large_download
large_upload
local_comms_service
mai400
mai400_api
mai400_service
monitor_service
novatel_oem6_api
novatel_oem6_service
nsl_duplex_d2
nsl_duplex_d2_comms_service
obc_hs
radio_api
rust_i2c
rust_mission_app
rust_uart
scheduler_service
serial_comms_service
shell_protocol
shell_service
telemetry_service
uart_comms_client
udp_client
utils
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 * Copyright (C) 2018 Kubos Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use eps_api::{EpsError, EpsResult};
use rust_i2c::Command;

/// Version
///
/// The version number of the firmware will be returned on this command.
/// The revision number returns the current revision of the firmware that is
/// present on the board. The firmware number returns the current firmware on the board.

/// Structure containing board firmware versions
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Version {
    /// Current firmware revision on board
    pub revision: u8,
    /// Current firmware on board
    pub firmware_number: u16,
}

/// Structure containing version information for the EPS motherboard
/// and daughterboard if present
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct VersionInfo {
    /// Motherboard version information
    pub motherboard: Version,
    /// Optional daughterboard version information
    pub daughterboard: Option<Version>,
}

fn get_firmware(num1: u8, num2: u8) -> u16 {
    u16::from(num1) | (u16::from(num2) & 0xF) << 8
}

fn get_revision(num: u8) -> u8 {
    (num & 0xF0) >> 4
}

pub fn parse(data: &[u8]) -> EpsResult<VersionInfo> {
    if data.len() == 2 {
        Ok(VersionInfo {
            motherboard: Version {
                firmware_number: get_firmware(data[0], data[1]),
                revision: get_revision(data[1]),
            },
            daughterboard: None,
        })
    } else if data.len() == 4 {
        Ok(VersionInfo {
            motherboard: Version {
                firmware_number: get_firmware(data[2], data[3]),
                revision: get_revision(data[3]),
            },
            daughterboard: Some(Version {
                firmware_number: get_firmware(data[0], data[1]),
                revision: get_revision(data[1]),
            }),
        })
    } else {
        Err(EpsError::parsing_failure("Version Info"))
    }
}

pub fn command() -> (Command, usize) {
    (
        Command {
            cmd: 0x04,
            data: vec![0x00],
        },
        4,
    )
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_motherboard() {
        assert_eq!(
            VersionInfo {
                motherboard: Version {
                    revision: 0xD,
                    firmware_number: 0xCBA,
                },
                daughterboard: None,
            },
            parse(&[0xBA, 0xDC]).unwrap()
        )
    }

    #[test]
    fn test_parse_both() {
        assert_eq!(
            VersionInfo {
                motherboard: Version {
                    revision: 0xD,
                    firmware_number: 0xCBA,
                },
                daughterboard: Some(Version {
                    revision: 0x4,
                    firmware_number: 0x321,
                }),
            },
            parse(&[0x21, 0x43, 0xBA, 0xDC]).unwrap()
        );
    }

    #[test]
    fn test_parse_one() {
        assert_eq!(
            EpsError::parsing_failure("Version Info"),
            parse(&[0x0]).err().unwrap()
        )
    }

    #[test]
    fn test_parse_three() {
        assert_eq!(
            EpsError::parsing_failure("Version Info"),
            parse(&[0x0, 0x1, 0x3]).err().unwrap()
        )
    }
}