Modules#
Radio Types#
This module includes the platform abstraction for a radio frame.
Enumerations#
This enumeration defines the channel page.
This enumeration defines the frequency band channel range.
This enumeration defines constants that are used to indicate different radio capabilities.
This enumeration defines constants about size of header IE in ACK.
This enumeration defines constants about key types.
This structure represents the state of a radio.
Typedefs#
This type represents radio capabilities.
This type represents the IEEE 802.15.4 PAN ID.
This type represents the IEEE 802.15.4 Short Address.
This structure represents the IEEE 802.15.4 Extended Address.
This type represents a MAC Key Ref used by PSA.
This structure represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame.
This structure represents an IEEE 802.15.4 radio frame.
This structure represents the state of a radio.
The following are valid radio state transitions:
This structure represents what metrics are specified to query.
Variables#
Macros#
IEEE 802.15.4 Broadcast PAN ID.
Size of an IEEE 802.15.4 Extended Address (bytes)
Fixed CSL IE header first byte.
Fixed CSL IE header second byte.
Size of the MAC Key in bytes.
Compiler-specific indication at the end of a byte packed class or struct.
Enumeration Documentation#
@13#
@13
Enumerator | |
---|---|
OT_RADIO_FRAME_MAX_SIZE | aMaxPHYPacketSize (IEEE 802.15.4-2006) |
OT_RADIO_FRAME_MIN_SIZE | Minimal size of frame FCS + CONTROL. |
OT_RADIO_SYMBOLS_PER_OCTET | 2.4 GHz IEEE 802.15.4-2006 |
OT_RADIO_BIT_RATE | 2.4 GHz IEEE 802.15.4 (bits per second) |
OT_RADIO_BITS_PER_OCTET | Number of bits per octet. |
OT_RADIO_SYMBOL_RATE | The O-QPSK PHY symbol rate when operating in the 780MHz, 915MHz, 2380MHz, 2450MHz. |
OT_RADIO_SYMBOL_TIME | Symbol duration time in unit of microseconds. |
OT_RADIO_TEN_SYMBOLS_TIME | Time for 10 symbols in unit of microseconds. |
OT_RADIO_LQI_NONE | LQI measurement not supported. |
OT_RADIO_RSSI_INVALID | Invalid or unknown RSSI value. |
OT_RADIO_POWER_INVALID | Invalid or unknown power value. |
69
of file include/openthread/platform/radio.h
@14#
@14
This enumeration defines the channel page.
Enumerator | |
---|---|
OT_RADIO_CHANNEL_PAGE_0 | 2.4 GHz IEEE 802.15.4-2006 |
OT_RADIO_CHANNEL_PAGE_0_MASK | 2.4 GHz IEEE 802.15.4-2006 |
OT_RADIO_CHANNEL_PAGE_2 | 915 MHz IEEE 802.15.4-2006 |
OT_RADIO_CHANNEL_PAGE_2_MASK | 915 MHz IEEE 802.15.4-2006 |
94
of file include/openthread/platform/radio.h
@15#
@15
This enumeration defines the frequency band channel range.
Enumerator | |
---|---|
OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN | 915 MHz IEEE 802.15.4-2006 |
OT_RADIO_915MHZ_OQPSK_CHANNEL_MAX | 915 MHz IEEE 802.15.4-2006 |
OT_RADIO_915MHZ_OQPSK_CHANNEL_MASK | 915 MHz IEEE 802.15.4-2006 |
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MIN | 2.4 GHz IEEE 802.15.4-2006 |
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MAX | 2.4 GHz IEEE 802.15.4-2006 |
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MASK | 2.4 GHz IEEE 802.15.4-2006 |
106
of file include/openthread/platform/radio.h
@16#
@16
This enumeration defines constants that are used to indicate different radio capabilities.
See otRadioCaps
.
Enumerator | |
---|---|
OT_RADIO_CAPS_NONE | Radio supports no capability. |
OT_RADIO_CAPS_ACK_TIMEOUT | Radio supports AckTime event. |
OT_RADIO_CAPS_ENERGY_SCAN | Radio supports Energy Scans. |
OT_RADIO_CAPS_TRANSMIT_RETRIES | Radio supports tx retry logic with collision avoidance (CSMA). |
OT_RADIO_CAPS_CSMA_BACKOFF | Radio supports CSMA backoff for frame transmission (but no retry). |
OT_RADIO_CAPS_SLEEP_TO_TX | Radio supports direct transition from sleep to TX with CSMA. |
OT_RADIO_CAPS_TRANSMIT_SEC | Radio supports tx security. |
OT_RADIO_CAPS_TRANSMIT_TIMING | Radio supports tx at specific time. |
OT_RADIO_CAPS_RECEIVE_TIMING | Radio supports rx at specific time. |
128
of file include/openthread/platform/radio.h
@17#
@17
This enumeration defines constants about size of header IE in ACK.
Enumerator | |
---|---|
OT_IE_HEADER_SIZE | Size of IE header in bytes. |
OT_CSL_IE_SIZE | Size of CSL IE content in bytes. |
OT_ACK_IE_MAX_SIZE | Max length for header IE in ACK. |
OT_ENH_PROBING_IE_DATA_MAX_SIZE | Max length of Link Metrics data in Vendor-Specific IE. |
161
of file include/openthread/platform/radio.h
otRadioKeyType#
otRadioKeyType
This enumeration defines constants about key types.
Enumerator | |
---|---|
OT_KEY_TYPE_LITERAL_KEY | Use Literal Keys. |
OT_KEY_TYPE_KEY_REF | Use Reference to Key. |
235
of file include/openthread/platform/radio.h
otRadioState#
otRadioState
This structure represents the state of a radio.
Initially, a radio is in the Disabled state.
Enumerator | |
---|---|
OT_RADIO_STATE_DISABLED | |
OT_RADIO_STATE_SLEEP | |
OT_RADIO_STATE_RECEIVE | |
OT_RADIO_STATE_TRANSMIT | |
OT_RADIO_STATE_INVALID |
375
of file include/openthread/platform/radio.h
Typedef Documentation#
otRadioCaps#
typedef uint8_t otRadioCaps
This type represents radio capabilities.
The value is a bit-field indicating the capabilities supported by the radio. See OT_RADIO_CAPS_*
definitions.
122
of file include/openthread/platform/radio.h
otPanId#
typedef uint16_t otPanId
This type represents the IEEE 802.15.4 PAN ID.
147
of file include/openthread/platform/radio.h
otShortAddress#
typedef uint16_t otShortAddress
This type represents the IEEE 802.15.4 Short Address.
153
of file include/openthread/platform/radio.h
otExtAddress#
typedef struct otExtAddress otExtAddress
This structure represents the IEEE 802.15.4 Extended Address.
188
of file include/openthread/platform/radio.h
otMacKey#
typedef struct otMacKey otMacKey
This structure represents a MAC Key.
208
of file include/openthread/platform/radio.h
otMacKeyRef#
typedef otCryptoKeyRef otMacKeyRef
This type represents a MAC Key Ref used by PSA.
214
of file include/openthread/platform/radio.h
otMacKeyMaterial#
typedef struct otMacKeyMaterial otMacKeyMaterial
229
of file include/openthread/platform/radio.h
otRadioIeInfo#
typedef struct otRadioIeInfo otRadioIeInfo
This structure represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame.
249
of file include/openthread/platform/radio.h
otRadioFrame#
typedef struct otRadioFrame otRadioFrame
This structure represents an IEEE 802.15.4 radio frame.
369
of file include/openthread/platform/radio.h
otRadioState#
typedef enum otRadioState otRadioState
This structure represents the state of a radio.
Initially, a radio is in the Disabled state.
382
of file include/openthread/platform/radio.h
otRadioCoexMetrics#
typedef struct otRadioCoexMetrics otRadioCoexMetrics
The following are valid radio state transitions:
(Radio ON)
+-------—+ Enable() +----—+ Receive() +------—+ Transmit() +-------—+ | |--------—>| |--------—>| |-----------—>| | | Disabled | | Sleep | | Receive | | Transmit | | |<--------—| |<--------—| |<-----------—| | +-------—+ Disable() +----—+ Sleep() +------—+ Receive() +-------—+ (Radio OFF) or signal TransmitDone
During the IEEE 802.15.4 data request command the transition Sleep->Receive->Transmit can be shortened to direct transition from Sleep to Transmit if the platform supports the OT_RADIO_CAPS_SLEEP_TO_TX capability. This structure represents radio coexistence metrics.
425
of file include/openthread/platform/radio.h
otLinkMetrics#
typedef struct otLinkMetrics otLinkMetrics
This structure represents what metrics are specified to query.
438
of file include/openthread/platform/radio.h
Variable Documentation#
OT_TOOL_PACKED_END#
OT_TOOL_PACKED_BEGIN struct otMacKey OT_TOOL_PACKED_END
182
of file include/openthread/platform/radio.h
Macro Definition Documentation#
OT_PANID_BROADCAST#
#define OT_PANID_BROADCASTValue:
0xffff
IEEE 802.15.4 Broadcast PAN ID.
141
of file include/openthread/platform/radio.h
OT_EXT_ADDRESS_SIZE#
#define OT_EXT_ADDRESS_SIZEValue:
8
Size of an IEEE 802.15.4 Extended Address (bytes)
155
of file include/openthread/platform/radio.h
CSL_IE_HEADER_BYTES_LO#
#define CSL_IE_HEADER_BYTES_LOValue:
0x04
Fixed CSL IE header first byte.
169
of file include/openthread/platform/radio.h
CSL_IE_HEADER_BYTES_HI#
#define CSL_IE_HEADER_BYTES_HIValue:
0x0d
Fixed CSL IE header second byte.
170
of file include/openthread/platform/radio.h
OT_MAC_KEY_SIZE#
#define OT_MAC_KEY_SIZEValue:
16
Size of the MAC Key in bytes.
190
of file include/openthread/platform/radio.h
OT_TOOL_PACKED_END#
#define OT_TOOL_PACKED_END
Compiler-specific indication at the end of a byte packed class or struct.
178
of file include/openthread/platform/toolchain.h