ssp 0.5.4

Messages and related types for implementing the SSP/eSSP serial communication protocol
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

use crate::{
    impl_default, impl_message_from_buf, impl_message_ops, impl_response_display,
    impl_response_ops, len::PROGRAM_FIRMWARE_RESPONSE, message::MessageOps, MessageType,
};

mod index {
    pub const BLOCK_LEN: usize = 4;
    pub const BLOCK_LEN_END: usize = 5;
}

/// ProgramFirmware - Response (0x0B)
///
/// Represents a response to an [ProgramFirmwareCommand](crate::ProgramFirmwareCommand) message.
#[repr(C)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ProgramFirmwareResponse {
    buf: [u8; PROGRAM_FIRMWARE_RESPONSE],
}

impl ProgramFirmwareResponse {
    /// Creates a new [ProgramFirmwareResponse] message.
    pub fn new() -> Self {
        let mut msg = Self {
            buf: [0u8; PROGRAM_FIRMWARE_RESPONSE],
        };

        msg.init();

        msg
    }

    /// Gets the expected block length from the device.
    ///
    /// Example:
    ///
    /// ```
    /// # use ssp;
    /// let fw_res = ssp::ProgramFirmwareResponse::new();
    /// assert_eq!(fw_res.block_len(), 0);
    /// ```
    pub fn block_len(&self) -> u16 {
        u16::from_le_bytes([self.buf[index::BLOCK_LEN], self.buf[index::BLOCK_LEN_END]])
    }

    /// Sets the expected block length from the device.
    ///
    /// Example:
    ///
    /// ```
    /// # use ssp;
    /// let mut fw_res = ssp::ProgramFirmwareResponse::new();
    /// fw_res.set_block_len(128);
    /// assert_eq!(fw_res.block_len(), 128);
    /// ```
    pub fn set_block_len(&mut self, len: u16) {
        self.buf[index::BLOCK_LEN..=index::BLOCK_LEN_END].copy_from_slice(&len.to_le_bytes());
    }
}

impl_default!(ProgramFirmwareResponse);
impl_message_from_buf!(ProgramFirmwareResponse);
impl_message_ops!(ProgramFirmwareResponse, MessageType::ProgramFirmware);
impl_response_ops!(ProgramFirmwareResponse);
impl_response_display!(ProgramFirmwareResponse);