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::*;

/// Reads a number of bytes from a specified memory location
#[derive(Debug)]
pub struct MemoryRead {
    /// The memory area to read from
    pub area: MemoryArea,
    /// Address of the first byte to read
    pub start_address: u32,
    /// Number of bytes to read
    pub size: u32,
}

impl TransmitCommandData for MemoryRead {
    fn command_data(&self) -> CommandData {
        CommandData {
            opcode: 0x52,
            has_size_field: true,
            payload: {
                let mut payload = vec![];
                payload.push(match self.area {
                    MemoryArea::UserBootArea => 0x00,
                    MemoryArea::UserArea => 0x01,
                });
                payload.extend(&self.start_address.to_be_bytes());
                payload.extend(&self.size.to_be_bytes());
                payload
            },
        }
    }
}

impl Receive for MemoryRead {
    type Response = Vec<u8>;

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

        reader
            .read_response()?
            .map(|SizedResponse { data, .. }| data)
            .map_err(|error_code| match error_code {
                0x11 => CommandError::Checksum.into(),
                0x2A => CommandError::Address.into(),
                0x2B => CommandError::DataSize.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 = MemoryRead {
            area: MemoryArea::UserArea,
            start_address: 0x12345678,
            size: 0x0A,
        };
        let command_bytes = [
            0x52, 0x09, 0x01, 0x12, 0x34, 0x56, 0x78, 0x00, 0x00, 0x00, 0x0A, 0x86,
        ];
        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 = MemoryRead {
            area: MemoryArea::UserArea,
            start_address: 0x12345678,
            size: 0x0A,
        };
        let response_bytes = [
            0x52, 0x00, 0x00, 0x00, 0x0A, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09,
            0x0A, 0x6D,
        ];
        let mut p = mock_io::Builder::new().read(&response_bytes).build();

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

        assert_eq!(
            response,
            Ok(vec![
                0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A
            ])
        );
        assert!(is_script_complete(&mut p));
    }

    #[test]
    fn test_rx_fail() {
        let cmd = MemoryRead {
            area: MemoryArea::UserArea,
            start_address: 0x12345678,
            size: 0x10,
        };
        let response_bytes = [0xD2, 0x2A];
        let mut p = mock_io::Builder::new().read(&response_bytes).build();

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

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