kernel::hil

Module radio

Source
Expand description

Interface for sending and receiving IEEE 802.15.4 packets.

Hardware independent interface for an 802.15.4 radio. Note that configuration commands are asynchronous and must be committed with a call to config_commit. For example, calling set_address will change the source address of packets but does not change the address stored in hardware used for address recognition. This must be committed to hardware with a call to config_commit. Please see the relevant TRD for more details.

Enums§

Constants§

  • LQI_SIZE
    Length of the reserved space in the buffer for LQI information.
  • MAX_BUF_SIZE
    Required buffer size for implementations of this HIL.
  • MAX_FRAME_SIZE
    Maximum length of a MAC frame.
  • MAX_MTU
    Maximum length of a MAC frame.
  • MFR_SIZE
    Length of the MAC footer. Contains the CRC.
  • MHR_FC_SIZE
    Length of the Frame Control field in the MAC header.
  • MIN_FRAME_SIZE
    Minimum length of the MAC frame (except for acknowledgements). This is explained in Table 21 of the specification.
  • PHR_OFFSET
    Location in the buffer of the physical layer header. This is the location of the Frame length byte.
  • PHR_SIZE
    Length of the physical layer header. This is the Frame length field.
  • PSDU_OFFSET
    Location in the buffer of the PSDU. This is equivalent to the start of the MAC payload.
  • SPI_HEADER_SIZE
    Length of the reserved space in the buffer for a SPI command.

Traits§

  • ConfigClient
    Client for callbacks after the radio is configured.
  • PowerClient
    Client for callbacks when the radio’s power state changes.
  • Radio
    General Radio trait that supports configuration and TX/RX.
  • RadioConfig
    Configure the 802.15.4 radio.
  • RadioData
    Send and receive packets with the 802.15.4 radio.
  • RxClient
    Client for receiving packets.
  • TxClient
    Client trait for when sending a packet is finished.