Struct capsules_extra::ieee802154::virtual_mac::MacUser

pub struct MacUser<'a, M: MacDevice<'a>> { /* private fields */ }

Keep state for each Mac user. All users of the virtualized MAC interface need to create one of these and register it with the MAC device muxer MuxMac by calling MuxMac#add_user. Then, each MacUser behaves exactly like an independent MAC device, except MAC device state is shared between all MacUsers because there is only one MAC device. For example, the MAC device address is shared, so calling set_address on one MacUser sets the MAC address for all MacUsers.

Implementations

impl<'a, M: MacDevice<'a>> MacUser<'a, M>

pub const fn new(mux: &'a MuxMac<'a, M>) -> Self

Trait Implementations

impl<'a, M: MacDevice<'a>> ListNode<'a, MacUser<'a, M>> for MacUser<'a, M>

fn next(&'a self) -> &'a ListLink<'a, MacUser<'a, M>>

impl<'a, M: MacDevice<'a>> MacDevice<'a> for MacUser<'a, M>

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 set_receive_secured_frame_no_decrypt_client( &self, client: &'a dyn SecuredFrameNoDecryptRxClient )

Sets the secure frame no decrypt 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 buf_to_frame( &self, buf: &'static mut [u8], len: usize ) -> Result<Frame, (ErrorCode, &'static mut [u8])>

Creates an IEEE 802.15.4 Frame object that is compatible with the MAC transmit and append payload methods. This serves to provide functionality for sending packets fully formed by the userprocess and that the 15.4 capsule does not modify. The len field may be less than the length of the buffer as the len field is the length of the current frame while the buffer is the maximum 15.4 frame size.

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.