Files

adcs_api

lib.rs

cbor_protocol

lib.rs

channel_protocol

error.rslib.rsparsers.rsprotocol.rs

clyde_3g_eps_api

commands

board_status.rschecksum.rslast_error.rsmod.rsreset.rsversion.rswatchdog.rs

telemetry

daughterboard.rslib.rsmod.rsmotherboard.rsreset.rs

eps.rslib.rs

clyde_3g_eps_service

models

board_status.rsdaughterboard_telemetry.rslast_error.rsmod.rsmotherboard_telemetry.rsreset_telemetry.rssubsystem.rsversion.rs

schema

mod.rsmutation.rsquery.rs

main.rs

comms_service

config.rserrors.rslib.rspacket.rsservice.rsspacepacket.rstelemetry.rs

db_test

main.rs

eps_api

lib.rs

example_rust_c_service

main.rsmodel.rsschema.rs

example_rust_service

main.rsmodel.rsschema.rs

extern_lib

lib.rs

file_protocol

error.rslib.rsmessages.rsparsers.rsprotocol.rsstorage.rs

file_service

lib.rs

iobc_supervisor_service

main.rsmodel.rsschema.rs

isis_ants

main.rs

isis_ants_api

ants.rsffi.rslib.rsparse.rs

isis_ants_service

main.rsmodel.rsobjects.rsschema.rs

isis_imtq_api

ffi.rsimtq.rslib.rs

isis_iobc_supervisor

ffi.rslib.rs

kubos_app

framework.rslib.rsquery.rs

kubos_app_service

app_entry.rserror.rsmain.rsmonitor.rsobjects.rsregistry.rsschema.rs

kubos_build_helper

lib.rs

kubos_file_client

main.rs

kubos_service

lib.rsmacros.rsservice.rs

kubos_shell_client

main.rs

kubos_system

config.rslib.rslogger.rsuboot.rs

kubos_telemetry_db

lib.rsmodels.rs

large_download

main.rs

large_upload

main.rs

local_comms_service

comms.rsmain.rs

mai400

main.rs

mai400_api

messages

rx

irehs.rsmod.rsraw_imu.rsrotating.rsstd_telem.rs

mod.rstx.rs

lib.rsmai400.rs

mai400_service

main.rsmodel.rsobjects.rsschema.rs

monitor_service

main.rsmeminfo.rsobjects.rsprocess.rsschema.rsuserinfo.rs

novatel_oem6_api

messages

commands

log.rsmod.rsunlog.rsunlog_all.rs

logs

best_xyz.rsmod.rsrxstatusevent.rsversion.rs

mod.rs

crc32.rslib.rsoem6.rs

novatel_oem6_service

main.rsmodel.rsobjects.rsschema.rs

nsl_duplex_d2

messages

file.rsgeo_record.rsmod.rsstate_of_health.rs

duplex_d2.rslib.rsserial_comm.rs

nsl_duplex_d2_comms_service

comms.rsmain.rsmodel.rsschema.rs

obc_hs

check_fs.rscheck_mem.rscheck_reset.rsclean_db.rsmain.rsping.rs

radio_api

lib.rs

rust_i2c

lib.rs

rust_mission_app

main.rs

rust_uart

error.rslib.rsmock.rs

scheduler_service

app.rserror.rsmain.rsmode.rsscheduler.rsschema.rstask.rstask_list.rs

serial_comms_service

comms.rskiss.rsmain.rsmodel.rsschema.rs

shell_protocol

messages

error.rsexit.rskill.rslist.rsmod.rspid.rsspawn.rsstderr.rsstdin.rsstdout.rs

error.rslib.rsprocess.rsprotocol.rs

shell_service

lib.rs

telemetry_service

main.rsschema.rsudp.rs

uart_comms_client

comms.rskiss.rsmain.rs

udp_client

main.rs

utils

lib.rstesting.rs

>

/*
 * 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()
        )
    }
}