rxprog 1.0.2

Library implementing the Boot Mode protocol for specific Renesas microcontrollers and CLI for programming firmware images
Documentation 
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

use super::command_impl_prelude::*;

/// Selects a new bit rate for the programmer connection. Must be followed by a
/// `NewBitRateSelectionConfirmation`.
#[derive(Debug)]
pub struct NewBitRateSelection {
    /// New bit rate in bps / 100
    pub bit_rate: u16,
    /// Device input frequency in MHz * 100
    pub input_frequency: u16,
    /// Clock multiplication ratios
    pub multiplication_ratios: Vec<MultiplicationRatio>,
}

impl TransmitCommandData for NewBitRateSelection {
    fn command_data(&self) -> CommandData {
        CommandData {
            opcode: 0x3F,
            has_size_field: true,
            payload: {
                let mut payload = vec![];
                payload.extend_from_slice(&self.bit_rate.to_be_bytes());
                payload.extend_from_slice(&self.input_frequency.to_be_bytes());
                payload.push(self.multiplication_ratios.len() as u8);
                payload.extend(self.multiplication_ratios.iter().map(|&x| u8::from(x)));
                payload
            },
        }
    }
}

impl Receive for NewBitRateSelection {
    type Response = ();

    fn rx<T: io::Read>(&self, p: &mut T) -> Result<Self::Response> {
        let mut reader = ResponseReader::<_, SimpleResponse, WithError>::new(
            p,
            ResponseFirstByte::Byte(0x06),
            ErrorFirstByte(0xBF),
        );

        reader
            .read_response()?
            .map(|_| ())
            .map_err(|error_code| match error_code {
                0x11 => CommandError::Checksum.into(),
                0x24 => CommandError::BitRateSelection.into(),
                0x25 => CommandError::InputFrequency.into(),
                0x26 => CommandError::MultiplicationRatio.into(),
                0x27 => CommandError::OperatingFrequency.into(),
                _ => panic!("Unknown error code"),
            })
    }
}

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

    #[test]
    fn test_tx() -> Result<()> {
        let cmd = NewBitRateSelection {
            bit_rate: 0x00C0,
            input_frequency: 0x04E2,
            multiplication_ratios: vec![
                MultiplicationRatio::MultiplyBy(4),
                MultiplicationRatio::DivideBy(2),
            ],
        };
        let command_bytes = [0x3F, 0x07, 0x00, 0xC0, 0x04, 0xE2, 0x02, 0x04, 0xFE, 0x10];
        let mut p = mock_io::Builder::new().write(&command_bytes).build();

        cmd.tx(&mut p)?;

        assert!(is_script_complete(&mut p));

        Ok(())
    }

    #[test]
    fn test_rx_success() {
        let cmd = NewBitRateSelection {
            bit_rate: 0x00C0,
            input_frequency: 0x04E2,
            multiplication_ratios: vec![
                MultiplicationRatio::MultiplyBy(4),
                MultiplicationRatio::DivideBy(2),
            ],
        };
        let response_bytes = [0x06];
        let mut p = mock_io::Builder::new().read(&response_bytes).build();

        let response = cmd.rx(&mut p);

        assert_eq!(response, Ok(()));
        assert!(is_script_complete(&mut p));
    }

    #[test]
    fn test_rx_fail() {
        let cmd = NewBitRateSelection {
            bit_rate: 0x00C0,
            input_frequency: 0x04E2,
            multiplication_ratios: vec![
                MultiplicationRatio::MultiplyBy(4),
                MultiplicationRatio::DivideBy(2),
            ],
        };
        let response_bytes = [0xBF, 0x24];
        let mut p = mock_io::Builder::new().read(&response_bytes).build();

        let response = cmd.rx(&mut p);

        assert_eq!(response, Err(CommandError::BitRateSelection.into()));
        assert!(is_script_complete(&mut p));
    }
}