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

/*
 * 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 nom::le_u16;
use rust_i2c::Command;

/// Checksum
///
/// This command instructs the node to self-inspect its ROM contents in order
/// to generate a checksum. The value retrieved can be used to determine whether
/// the contents of the ROM have changed during the operation of the device.

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Checksum {
    /// Motherboard ROM checksum
    pub motherboard: u16,
    /// Daughterboard ROM checksum
    pub daughterboard: Option<u16>,
}

impl Default for Checksum {
    fn default() -> Self {
        Checksum {
            motherboard: 0,
            daughterboard: None,
        }
    }
}

fn parse_checksum(data: &[u8]) -> EpsResult<u16> {
    match le_u16(data) {
        Ok((_rem, res)) => Ok(res),
        Err(_) => Err(EpsError::parsing_failure("Checksum")),
    }
}

pub fn parse(data: &[u8]) -> EpsResult<Checksum> {
    if data.len() == 4 {
        Ok(Checksum {
            motherboard: parse_checksum(&data[2..])?,
            daughterboard: Some(parse_checksum(data)?),
        })
    } else if data.len() == 2 {
        Ok(Checksum {
            motherboard: parse_checksum(data)?,
            daughterboard: None,
        })
    } else {
        Err(EpsError::parsing_failure("Checksum"))
    }
}

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

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

    #[test]
    fn test_parse_motherboard_checksum() {
        assert_eq!(
            Checksum {
                motherboard: 0xCDAB,
                daughterboard: None,
            },
            parse(&vec![0xAB, 0xCD]).unwrap()
        );
    }

    #[test]
    fn test_parse_both_checksum() {
        assert_eq!(
            Checksum {
                motherboard: 0x3412,
                daughterboard: Some(0xCDAB),
            },
            parse(&vec![0xAB, 0xCD, 0x12, 0x34]).unwrap()
        );
    }

    #[test]
    fn test_parse_one_byte() {
        assert_eq!(
            EpsError::parsing_failure("Checksum"),
            parse(&vec![0]).err().unwrap()
        );
    }

    #[test]
    fn test_parse_three_bytes() {
        assert_eq!(
            EpsError::parsing_failure("Checksum"),
            parse(&vec![1, 2, 3]).err().unwrap()
        );
    }
}