openthread_sys::spinel

Constant SPINEL_PROP_STREAM_RAW

Source
pub const SPINEL_PROP_STREAM_RAW: _bindgen_ty_24 = 113;
Expand description

Raw Stream ** Format: dD (stream, read only)

  • Required Capability: SPINEL_CAP_MAC_RAW or SPINEL_CAP_CONFIG_RADIO

  • This stream provides the capability of sending and receiving raw 15.4 frames

  • to and from the radio. The exact format of the frame metadata and data is

  • dependent on the MAC and PHY being used.

  • This property is a streaming property, meaning that you cannot explicitly

  • fetch the value of this property. To receive traffic, you wait for

  • CMD_PROP_VALUE_IS commands with this property id from the NCP.

  • The general format of this property is:

  • d : frame data

  • D : frame meta data

  • The frame meta data is optional. Frame metadata MAY be empty or partially

  • specified. Partially specified metadata MUST be accepted. Default values

  • are used for all unspecified fields.

  • The frame metadata field consists of the following fields:

  • c : Received Signal Strength (RSSI) in dBm - default is -128

  • c : Noise floor in dBm - default is -128

  • S : Flags (see below).

  • d : PHY-specific data/struct

  • d : Vendor-specific data/struct

  • Flags fields are defined by the following enumeration bitfields:

  • SPINEL_MD_FLAG_TX = 0x0001 : Packet was transmitted, not received.

  • SPINEL_MD_FLAG_BAD_FCS = 0x0004 : Packet was received with bad FCS

  • SPINEL_MD_FLAG_DUPE = 0x0008 : Packet seems to be a duplicate

  • SPINEL_MD_FLAG_RESERVED = 0xFFF2 : Flags reserved for future use.

  • The format of PHY-specific data for a Thread device contains the following

  • optional fields:

  • C : 802.15.4 channel (Receive channel)

  • C : IEEE 802.15.4 LQI

  • L : The timestamp milliseconds

  • S : The timestamp microseconds, offset to mMsec

  • Frames written to this stream with CMD_PROP_VALUE_SET will be sent out

  • over the radio. This allows the caller to use the radio directly.

  • The frame meta data for the CMD_PROP_VALUE_SET contains the following

  • fields. Default values are used for all unspecified fields.

  • C : Channel (for frame tx) - MUST be included.

  • C : Maximum number of backoffs attempts before declaring CCA failure

  •    (use Thread stack default if not specified)
  • C : Maximum number of retries allowed after a transmission failure

  •    (use Thread stack default if not specified)
  • b : Set to true to enable CSMA-CA for this packet, false otherwise.

  •    (default true).
  • b : Set to true to indicate if header is updated - related to

  •    `mIsHeaderUpdated` in `otRadioFrame` (default false).
  • b : Set to true to indicate it is a retransmission - related to

  •    `mIsARetx` in `otRadioFrame` (default false).
  • b : Set to true to indicate security was processed on tx frame

  •    `mIsSecurityProcessed` in `otRadioFrame` (default false).
  • L : TX delay interval used for CSL - related to mTxDelay in

  •    `otRadioFrame` (default zero).
  • L : TX delay based time used for CSL - related to mTxDelayBaseTime

  •    in `otRadioFrame` (default zero).
  • C : RX channel after TX done (default assumed to be same as

  •    channel in metadata)

*/