Struct capsules::ieee802154::xmac::XMac

pub struct XMac<'a, R: Radio + 'a, A: Alarm + 'a> {
    radio: &'a R,
    alarm: &'a A,
    rng: &'a RNG,
    tx_client: Cell<Option<&'static TxClient>>,
    rx_client: Cell<Option<&'static RxClient>>,
    state: Cell<XMacState>,
    delay_sleep: Cell<bool>,
    tx_header: Cell<Option<XMacHeaderInfo>>,
    tx_payload: TakeCell<'static, [u8]>,
    tx_len: Cell<usize>,
    tx_preamble_pending: Cell<bool>,
    tx_preamble_seq_num: Cell<u8>,
    tx_preamble_buf: TakeCell<'static, [u8]>,
    rx_pending: Cell<bool>,
}

Fields

radio: &'a R

alarm: &'a A

rng: &'a RNG

tx_client: Cell<Option<&'static TxClient>>

rx_client: Cell<Option<&'static RxClient>>

state: Cell<XMacState>

delay_sleep: Cell<bool>

tx_header: Cell<Option<XMacHeaderInfo>>

tx_payload: TakeCell<'static, [u8]>

tx_len: Cell<usize>

tx_preamble_pending: Cell<bool>

tx_preamble_seq_num: Cell<u8>

tx_preamble_buf: TakeCell<'static, [u8]>

rx_pending: Cell<bool>

Methods

impl<'a, R: Radio + 'a, A: Alarm + 'a> XMac<'a, R, A>

pub fn new(radio: &'a R, alarm: &'a A, rng: &'a RNG) -> XMac<'a, R, A>

fn sleep_time(&self) -> u32

fn sleep(&self)

fn set_timer_ms<T: Time>(&self, ms: u32)

fn transmit_preamble(&self)

fn transmit_packet(&self)

fn call_tx_client(
    &self,
    buf: &'static mut [u8],
    acked: bool,
    result: ReturnCode
)

fn call_rx_client(
    &self,
    buf: &'static mut [u8],
    len: usize,
    crc_valid: bool,
    result: ReturnCode
)

Trait Implementations

impl<'a, R: Radio + 'a, A: Alarm + 'a> Client for XMac<'a, R, A>

fn randomness_available(
    &self,
    randomness: &mut Iterator<Item = u32>
) -> Continue

Called by the (RNG)[trait.RNG.html] when there are one or more random numbers available

impl<'a, R: Radio + 'a, A: Alarm> Mac for XMac<'a, R, A>

fn initialize(&self, mac_buf: &'static mut [u8]) -> ReturnCode

Initializes the layer; may require a buffer to temporarily retaining frames to be transmitted

fn is_on(&self) -> bool

Indicates whether or not the MAC protocol is active and can send frames

fn set_config_client(&self, client: &'static ConfigClient)

Sets the notified client for configuration changes

fn set_address(&self, addr: u16)

Sets the short 16-bit address of the radio

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

Sets the long 64-bit address of the radio

fn set_pan(&self, id: u16)

Sets the 16-bit PAN id of the radio

fn get_address(&self) -> u16

The short 16-bit address of the radio

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

The long 64-bit address of the radio

fn get_pan(&self) -> u16

The 16-bit PAN id of the radio

fn config_commit(&self)

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 protocol implementation. The specificed config_client is notified on completed reconfiguration.

fn set_transmit_client(&self, client: &'static TxClient)

Sets the notified client for transmission completions

fn set_receive_client(&self, client: &'static RxClient)

Sets the notified client for frame receptions

fn set_receive_buffer(&self, buffer: &'static mut [u8])

Sets the buffer for packet reception

fn transmit(
    &self,
    full_mac_frame: &'static mut [u8],
    frame_len: usize
) -> (ReturnCode, Option<&'static mut [u8]>)

Transmits complete MAC frames, which must be prepared by an ieee802154::device::MacDevice before being passed to the Mac layer. Returns the frame buffer in case of an error.

impl<'a, R: Radio + 'a, A: Alarm + 'a> Client for XMac<'a, R, A>

fn fired(&self)

Callback signaled when the alarm's clock reaches the value set in Alarm#set_alarm.

impl<'a, R: Radio + 'a, A: Alarm + 'a> PowerClient for XMac<'a, R, A>

fn changed(&self, on: bool)

impl<'a, R: Radio + 'a, A: Alarm + 'a> TxClient for XMac<'a, R, A>

fn send_done(&self, buf: &'static mut [u8], acked: bool, result: ReturnCode)

impl<'a, R: Radio + 'a, A: Alarm + 'a> RxClient for XMac<'a, R, A>

fn receive(
    &self,
    buf: &'static mut [u8],
    frame_len: usize,
    crc_valid: bool,
    result: ReturnCode
)