Struct capsules_extra::ieee802154::framer::Framer

pub struct Framer<'a, M: Mac<'a>, A: AES128CCM<'a>> { /* private fields */ }

This struct wraps an IEEE 802.15.4 radio device kernel::hil::radio::Radio and exposes IEEE 802.15.4 MAC device functionality as the trait capsules::mac::Mac. It hides header preparation, transmission and processing logic from the user by essentially maintaining multiple state machines corresponding to the transmission, reception and encryption/decryption pipelines. See the documentation in capsules/src/mac.rs for more details.

Implementations

impl<'a, M: Mac<'a>, A: AES128CCM<'a>> Framer<'a, M, A>

pub fn new( mac: &'a M, aes_ccm: &'a A, crypt_buf: SubSliceMut<'static, u8>, ) -> Framer<'a, M, A>

pub fn set_key_procedure(&self, key_procedure: &'a dyn KeyProcedure)

Sets the IEEE 802.15.4 key lookup procedure to be used.

pub fn set_device_procedure(&self, device_procedure: &'a dyn DeviceProcedure)

Sets the IEEE 802.15.4 key lookup procedure to be used.

Trait Implementations

impl<'a, M: Mac<'a>, A: AES128CCM<'a>> CCMClient for Framer<'a, M, A>

fn crypt_done( &self, buf: &'static mut [u8], res: Result<(), ErrorCode>, tag_is_valid: bool, )

res is Ok(()) if the encryption/decryption process succeeded. This does not mean that the message has been verified in the case of decryption. If we are encrypting: tag_is_valid is true iff res is Ok(()). If we are decrypting: tag_is_valid is true iff res is Ok(()) and the message authentication tag is valid.

impl<'a, M: Mac<'a>, A: AES128CCM<'a>> ConfigClient for Framer<'a, M, A>

fn config_done(&self, _: Result<(), ErrorCode>)

Configuring the radio has finished.

impl<'a, M: Mac<'a>, A: AES128CCM<'a>> MacDevice<'a> for Framer<'a, M, A>

fn set_transmit_client(&self, client: &'a dyn TxClient)

Sets the transmission client of this MAC device

fn set_receive_client(&self, client: &'a dyn RxClient)

Sets the receive client of this MAC device

fn get_address(&self) -> u16

The short 16-bit address of the MAC device

fn get_address_long(&self) -> [u8; 8]

The long 64-bit address (EUI-64) of the MAC device

fn get_pan(&self) -> u16

The 16-bit PAN ID of the MAC device

fn set_address(&self, addr: u16)

Set the short 16-bit address of the MAC device

fn set_address_long(&self, addr: [u8; 8])

Set the long 64-bit address (EUI-64) of the MAC device

fn set_pan(&self, id: u16)

Set the 16-bit PAN ID of the MAC device

fn config_commit(&self)

This method must be called after one or more calls to set_*. If set_* is called without calling config_commit, there is no guarantee that the underlying hardware configuration (addresses, pan ID) is in line with this MAC device implementation.

fn is_on(&self) -> bool

Returns if the MAC device is currently on.

fn prepare_data_frame( &self, buf: &'static mut [u8], dst_pan: PanID, dst_addr: MacAddress, src_pan: PanID, src_addr: MacAddress, security_needed: Option<(SecurityLevel, KeyId)>, ) -> Result<Frame, &'static mut [u8]>

Prepares a mutable buffer slice as an 802.15.4 frame by writing the appropriate header bytes into the buffer. This needs to be done before adding the payload because the length of the header is not fixed.

fn transmit(&self, frame: Frame) -> Result<(), (ErrorCode, &'static mut [u8])>

Transmits a frame that has been prepared by the above process. If the transmission process fails, the buffer inside the frame is returned so that it can be re-used.

impl<'a, M: Mac<'a>, A: AES128CCM<'a>> RxClient for Framer<'a, M, A>

fn receive( &self, buf: &'static mut [u8], frame_len: usize, lqi: u8, crc_valid: bool, _: Result<(), ErrorCode>, )

Packet was received.

impl<'a, M: Mac<'a>, A: AES128CCM<'a>> TxClient for Framer<'a, M, A>

fn send_done( &self, buf: &'static mut [u8], acked: bool, result: Result<(), ErrorCode>, )

Send is complete or an error occurred during transmission.