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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

/*
 * 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.
 */

//! Reset Telemetry
//!
//! This module provides the enum, commands and parsers necessary for working
//! with reset telemetry from the EPS motherboard and daughterboard (if present).
//!
//! The macro `make_reset_telemetry!` is responsibly for generating the enum `Type`,
//! and the `command` function.

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

/// Macro for generating `ResetType` enum and `command` function
/// for reset telemetry items.
#[macro_export]
macro_rules! make_reset_telemetry {
    (
        $(
            $(#[$meta:meta])+
                $type: ident => $cmd: expr,
        )+
    ) => {

        #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
        /// Reset Telemetry Variants
        pub enum Type {
            $(
                $(#[$meta])+
                    $type,
            )+
        }

        /// Helper function storing telemetry command information
        ///
        /// # Arguments
        ///
        /// `telem_type` - `Type` of telemetry to return command for
        pub fn command(reset_type: Type) -> (Command, usize) {
            (
                Command {
                    cmd: match reset_type {
                        $(Type::$type => $cmd,)+
                    },
                    data: vec![0x00],
                },
                4,
            )
        }
    }
}

/// Common Reset Telemetry Structure
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Data {
    /// Motherboard telemetry value
    pub motherboard: u8,
    /// Optional daughterboard telemetry value
    pub daughterboard: Option<u8>,
}

/// Each of these reset telemetry commands may return two bytes or four bytes,
/// depending on whether or not a daughterboard exists. The first two bytes
/// will always represent the motherboard, the second two will represent
/// the daughterboard. All counters roll over at 255 to 0.
make_reset_telemetry!(
    /// Get Number of Brown-out Resets
    BrownOut => 0x31,
    /// Get Number of Automatic Software Resets
    /// If the on-board microcontroller has experienced a malfunction, such as being stuck
    /// in a loop, it will reset itself into a pre-defined initial state.
    AutomaticSoftware => 0x32,
    /// Get Number of Manual Resets
    /// This is the count of the number of times the device has been manually reset using
    /// the Reset command.
    Manual => 0x33,
    /// Get Number of Communications Watchdog Resets
    /// The device will reset itself if it does not receive any
    /// data via i2c for a predefined length of time. The communications node keeps a count
    /// of the number of times such an event has taken place.
    Watchdog => 0x34,
);

/// Parses ResetTelemetry message
///
/// # Arguments
///
/// `data` - Data received from Eps
pub fn parse(data: &[u8]) -> EpsResult<Data> {
    if data.len() == 2 {
        Ok(Data {
            motherboard: data[1],
            daughterboard: None,
        })
    } else if data.len() == 4 {
        Ok(Data {
            motherboard: data[1],
            daughterboard: Some(data[3]),
        })
    } else {
        Err(EpsError::parsing_failure("Reset Telemetry"))
    }
}

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

    #[test]
    fn test_make_reset_telemetry() {
        make_reset_telemetry!(
            /// TestValue1
            TestVal1 => 0x30,
        );

        assert_eq!(
            command(Type::TestVal1),
            (
                Command {
                    cmd: 0x30,
                    data: vec![0x00],
                },
                4,
            )
        );
    }

    #[test]
    fn test_parse_motherboard() {
        let input = vec![0x0, 0x1];
        assert_eq!(
            parse(&input),
            Ok(Data {
                motherboard: 1,
                daughterboard: None,
            })
        );
    }

    #[test]
    fn test_parse_motherboard_daughterboard() {
        let input = vec![0x0, 0x1, 0x0, 0x10];
        assert_eq!(
            parse(&input),
            Ok(Data {
                motherboard: 1,
                daughterboard: Some(0x10),
            })
        );
    }

    #[test]
    fn test_parse_bad_data() {
        let input = vec![0x0, 0x1, 0x2, 0x3, 0x4, 0x4];
        assert_eq!(
            parse(&input),
            Err(EpsError::parsing_failure("Reset Telemetry"))
        );
    }
}