Radio Operation

This module includes the platform abstraction for radio operations.

Summary

Functions
otPlatDiagRadioReceiveDone(otInstance *aInstance, otRadioFrame *aFrame, otError aError)	void The radio driver calls this method to notify OpenThread diagnostics module of a received frame.
otPlatDiagRadioTransmitDone(otInstance *aInstance, otRadioFrame *aFrame, otError aError)	void The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed.
otPlatRadioAddSrcMatchExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)	otError Add an extended address to the source address match table.
otPlatRadioAddSrcMatchShortEntry(otInstance *aInstance, otShortAddress aShortAddress)	otError Add a short address to the source address match table.
otPlatRadioClearSrcMatchExtEntries(otInstance *aInstance)	void Clear all the extended/long addresses from source address match table.
otPlatRadioClearSrcMatchExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)	otError Remove an extended address from the source address match table.
otPlatRadioClearSrcMatchShortEntries(otInstance *aInstance)	void Clear all short addresses from the source address match table.
otPlatRadioClearSrcMatchShortEntry(otInstance *aInstance, otShortAddress aShortAddress)	otError Remove a short address from the source address match table.
otPlatRadioConfigureEnhAckProbing(otInstance *aInstance, otLinkMetrics aLinkMetrics, otShortAddress aShortAddress, const otExtAddress *aExtAddress)	otError Enable/disable or update Enhanced-ACK Based Probing in radio for a specific Initiator.
otPlatRadioDisable(otInstance *aInstance)	otError Disable the radio.
otPlatRadioEnable(otInstance *aInstance)	otError Enable the radio.
otPlatRadioEnableCsl(otInstance *aInstance, uint32_t aCslPeriod, otShortAddress aShortAddr, const otExtAddress *aExtAddr)	otError Enable or disable CSL receiver.
otPlatRadioEnableSrcMatch(otInstance *aInstance, bool aEnable)	void Enable/Disable source address match feature.
otPlatRadioEnergyScan(otInstance *aInstance, uint8_t aScanChannel, uint16_t aScanDuration)	otError Begin the energy scan sequence on the radio.
otPlatRadioEnergyScanDone(otInstance *aInstance, int8_t aEnergyScanMaxRssi)	void The radio driver calls this method to notify OpenThread that the energy scan is complete.
otPlatRadioGetCoexMetrics(otInstance *aInstance, otRadioCoexMetrics *aCoexMetrics)	otError Get the radio coexistence metrics.
otPlatRadioGetCslAccuracy(otInstance *aInstance)	uint8_t Get the current accuracy, in units of ± ppm, of the clock used for scheduling CSL operations.
otPlatRadioGetCslUncertainty(otInstance *aInstance)	uint8_t The fixed uncertainty of the Device for scheduling CSL Transmissions in units of 10 microseconds.
otPlatRadioGetPreferredChannelMask(otInstance *aInstance)	uint32_t Get the radio preferred channel mask that the device prefers to form on.
otPlatRadioGetRegion(otInstance *aInstance, uint16_t *aRegionCode)	otError Get the region code.
otPlatRadioGetRssi(otInstance *aInstance)	int8_t Get the most recent RSSI measurement.
otPlatRadioGetState(otInstance *aInstance)	otRadioState Get current state of the radio.
otPlatRadioGetSupportedChannelMask(otInstance *aInstance)	uint32_t Get the radio supported channel mask that the device is allowed to be on.
otPlatRadioGetTransmitBuffer(otInstance *aInstance)	otRadioFrame * Get the radio transmit frame buffer.
otPlatRadioIsCoexEnabled(otInstance *aInstance)	bool Check whether radio coex is enabled or not.
otPlatRadioIsEnabled(otInstance *aInstance)	bool Check whether radio is enabled or not.
otPlatRadioReceive(otInstance *aInstance, uint8_t aChannel)	otError Transition the radio from Sleep to Receive (turn on the radio).
otPlatRadioReceiveAt(otInstance *aInstance, uint8_t aChannel, uint32_t aStart, uint32_t aDuration)	otError Schedule a radio reception window at a specific time and duration.
otPlatRadioReceiveDone(otInstance *aInstance, otRadioFrame *aFrame, otError aError)	void The radio driver calls this method to notify OpenThread of a received frame.
otPlatRadioSetChannelMaxTransmitPower(otInstance *aInstance, uint8_t aChannel, int8_t aMaxPower)	otError Set the max transmit power for a specific channel.
otPlatRadioSetCoexEnabled(otInstance *aInstance, bool aEnabled)	otError Enable the radio coex.
otPlatRadioSetRegion(otInstance *aInstance, uint16_t aRegionCode)	otError Set the region code.
otPlatRadioSleep(otInstance *aInstance)	otError Transition the radio from Receive to Sleep (turn off the radio).
otPlatRadioTransmit(otInstance *aInstance, otRadioFrame *aFrame)	otError Begin the transmit sequence on the radio.
otPlatRadioTxDone(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError)	void The radio driver calls this function to notify OpenThread that the transmit operation has completed, providing both the transmitted frame and, if applicable, the received ack frame.
otPlatRadioTxStarted(otInstance *aInstance, otRadioFrame *aFrame)	void The radio driver calls this method to notify OpenThread that the transmission has started.
otPlatRadioUpdateCslSampleTime(otInstance *aInstance, uint32_t aCslSampleTime)	void Update CSL sample time in radio driver.

Functions

otPlatDiagRadioReceiveDone

void otPlatDiagRadioReceiveDone(
  otInstance *aInstance,
  otRadioFrame *aFrame,
  otError aError
)

The radio driver calls this method to notify OpenThread diagnostics module of a received frame.

This function is used when diagnostics is enabled.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aFrame A pointer to the received frame or NULL if the receive operation failed. [in] aError OT_ERROR_NONE when successfully received a frame, OT_ERROR_ABORT when reception was aborted and a frame was not received, OT_ERROR_NO_BUFS when a frame could not be received due to lack of rx buffer space.

otPlatDiagRadioTransmitDone

void otPlatDiagRadioTransmitDone(
  otInstance *aInstance,
  otRadioFrame *aFrame,
  otError aError
)

The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed.

This function is used when diagnostics is enabled.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aFrame A pointer to the frame that was transmitted. [in] aError OT_ERROR_NONE when the frame was transmitted, OT_ERROR_CHANNEL_ACCESS_FAILURE tx could not take place due to activity on the channel, OT_ERROR_ABORT when transmission was aborted for other reasons.

otPlatRadioAddSrcMatchExtEntry

otError otPlatRadioAddSrcMatchExtEntry(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Add an extended address to the source address match table.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aExtAddress The extended address to be added stored in little-endian byte order.
Return Values	OT_ERROR_NONE Successfully added extended address to the source match table. OT_ERROR_NO_BUFS No available entry in the source match table.

otPlatRadioAddSrcMatchShortEntry

otError otPlatRadioAddSrcMatchShortEntry(
  otInstance *aInstance,
  otShortAddress aShortAddress
)

Add a short address to the source address match table.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aShortAddress The short address to be added.
Return Values	OT_ERROR_NONE Successfully added short address to the source match table. OT_ERROR_NO_BUFS No available entry in the source match table.

otPlatRadioClearSrcMatchExtEntries

void otPlatRadioClearSrcMatchExtEntries(
  otInstance *aInstance
)

Clear all the extended/long addresses from source address match table.

Details
Parameters	[in] aInstance The OpenThread instance structure.

otPlatRadioClearSrcMatchExtEntry

otError otPlatRadioClearSrcMatchExtEntry(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Remove an extended address from the source address match table.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aExtAddress The extended address to be removed stored in little-endian byte order.
Return Values	OT_ERROR_NONE Successfully removed the extended address from the source match table. OT_ERROR_NO_ADDRESS The extended address is not in source address match table.

otPlatRadioClearSrcMatchShortEntries

void otPlatRadioClearSrcMatchShortEntries(
  otInstance *aInstance
)

Clear all short addresses from the source address match table.

Details
Parameters	[in] aInstance The OpenThread instance structure.

otPlatRadioClearSrcMatchShortEntry

otError otPlatRadioClearSrcMatchShortEntry(
  otInstance *aInstance,
  otShortAddress aShortAddress
)

Remove a short address from the source address match table.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aShortAddress The short address to be removed.
Return Values	OT_ERROR_NONE Successfully removed short address from the source match table. OT_ERROR_NO_ADDRESS The short address is not in source address match table.

otPlatRadioConfigureEnhAckProbing

otError otPlatRadioConfigureEnhAckProbing(
  otInstance *aInstance,
  otLinkMetrics aLinkMetrics,
  otShortAddress aShortAddress,
  const otExtAddress *aExtAddress
)

Enable/disable or update Enhanced-ACK Based Probing in radio for a specific Initiator.

After Enhanced-ACK Based Probing is configured by a specific Probing Initiator, the Enhanced-ACK sent to that node should include Vendor-Specific IE containing Link Metrics data. This method informs the radio to start/stop to collect Link Metrics data and include Vendor-Specific IE that containing the data in Enhanced-ACK sent to that Probing Initiator.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aLinkMetrics This parameter specifies what metrics to query. Per spec 4.11.3.4.4.6, at most 2 metrics can be specified. The probing would be disabled if aLinkMetrics is bitwise 0. [in] aShortAddress The short address of the Probing Initiator. [in] aExtAddress The extended source address of the Probing Initiator. aExtAddr MUST NOT be NULL.
Return Values	OT_ERROR_NONE Successfully configured the Enhanced-ACK Based Probing. OT_ERROR_INVALID_ARGS aExtAddress is NULL. OT_ERROR_NOT_FOUND The Initiator indicated by aShortAddress is not found when trying to clear. OT_ERROR_NO_BUFS No more Initiator can be supported.

otPlatRadioDisable

otError otPlatRadioDisable(
  otInstance *aInstance
)

Disable the radio.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Return Values	OT_ERROR_NONE Successfully transitioned to Disabled. OT_ERROR_INVALID_STATE The radio was not in sleep state.

otPlatRadioEnable

otError otPlatRadioEnable(
  otInstance *aInstance
)

Enable the radio.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Return Values	OT_ERROR_NONE Successfully enabled. OT_ERROR_FAILED The radio could not be enabled.

otPlatRadioEnableCsl

otError otPlatRadioEnableCsl(
  otInstance *aInstance,
  uint32_t aCslPeriod,
  otShortAddress aShortAddr,
  const otExtAddress *aExtAddr
)

Enable or disable CSL receiver.

Note: Platforms should use CSL peer addresses to include CSL IE when generating enhanced acks.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aCslPeriod CSL period, 0 for disabling CSL. [in] aShortAddr The short source address of CSL receiver's peer. [in] aExtAddr The extended source address of CSL receiver's peer.
Return Values	kErrorNotImplemented Radio driver doesn't support CSL. kErrorFailed Other platform specific errors. kErrorNone Successfully enabled or disabled CSL.

otPlatRadioEnableSrcMatch

void otPlatRadioEnableSrcMatch(
  otInstance *aInstance,
  bool aEnable
)

Enable/Disable source address match feature.

The source address match feature controls how the radio layer decides the "frame pending" bit for acks sent in response to data request commands from children.

If disabled, the radio layer must set the "frame pending" on all acks to data request commands.

If enabled, the radio layer uses the source address match table to determine whether to set or clear the "frame pending" bit in an ack to a data request command.

The source address match table provides the list of children for which there is a pending frame. Either a short address or an extended/long address can be added to the source address match table.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aEnable Enable/disable source address match feature.

otPlatRadioEnergyScan

otError otPlatRadioEnergyScan(
  otInstance *aInstance,
  uint8_t aScanChannel,
  uint16_t aScanDuration
)

Begin the energy scan sequence on the radio.

This function is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aScanChannel The channel to perform the energy scan on. [in] aScanDuration The duration, in milliseconds, for the channel to be scanned.
Return Values	OT_ERROR_NONE Successfully started scanning the channel. OT_ERROR_BUSY The radio is performing enery scanning. OT_ERROR_NOT_IMPLEMENTED The radio doesn't support energy scanning.

otPlatRadioEnergyScanDone

void otPlatRadioEnergyScanDone(
  otInstance *aInstance,
  int8_t aEnergyScanMaxRssi
)

The radio driver calls this method to notify OpenThread that the energy scan is complete.

This function is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aEnergyScanMaxRssi The maximum RSSI encountered on the scanned channel.

otPlatRadioGetCoexMetrics

otError otPlatRadioGetCoexMetrics(
  otInstance *aInstance,
  otRadioCoexMetrics *aCoexMetrics
)

Get the radio coexistence metrics.

This function is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.

Details
Parameters	[in] aInstance The OpenThread instance structure. [out] aCoexMetrics A pointer to the coexistence metrics structure.
Return Values	OT_ERROR_NONE Successfully retrieved the coex metrics. OT_ERROR_INVALID_ARGS aCoexMetrics was NULL.

otPlatRadioGetCslAccuracy

uint8_t otPlatRadioGetCslAccuracy(
  otInstance *aInstance
)

Get the current accuracy, in units of ± ppm, of the clock used for scheduling CSL operations.

Note: Platforms may optimize this value based on operational conditions (i.e.: temperature).

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The current CSL rx/tx scheduling drift, in units of ± ppm.

otPlatRadioGetCslUncertainty

uint8_t otPlatRadioGetCslUncertainty(
  otInstance *aInstance
)

The fixed uncertainty of the Device for scheduling CSL Transmissions in units of 10 microseconds.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The CSL Uncertainty in units of 10 us.

otPlatRadioGetPreferredChannelMask

uint32_t otPlatRadioGetPreferredChannelMask(
  otInstance *aInstance
)

Get the radio preferred channel mask that the device prefers to form on.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Returns	The radio preferred channel mask.

otPlatRadioGetRegion

otError otPlatRadioGetRegion(
  otInstance *aInstance,
  uint16_t *aRegionCode
)

Get the region code.

The radio region format is the 2-bytes ascii representation of the ISO 3166 alpha-2 code.

Details
Parameters	[in] aInstance The OpenThread instance structure. [out] aRegionCode The radio region.
Return Values	OT_ERROR_INVALID_ARGS aRegionCode is nullptr. OT_ERROR_FAILED Other platform specific errors. OT_ERROR_NONE Successfully got region code.

otPlatRadioGetRssi

int8_t otPlatRadioGetRssi(
  otInstance *aInstance
)

Get the most recent RSSI measurement.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Returns	The RSSI in dBm when it is valid. 127 when RSSI is invalid.

otPlatRadioGetState

otRadioState otPlatRadioGetState(
  otInstance *aInstance
)

Get current state of the radio.

This function is not required by OpenThread. It may be used for debugging and/or application-specific purposes.

Note: This function may be not implemented. It does not affect OpenThread.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Returns	Current state of the radio.

otPlatRadioGetSupportedChannelMask

uint32_t otPlatRadioGetSupportedChannelMask(
  otInstance *aInstance
)

Get the radio supported channel mask that the device is allowed to be on.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Returns	The radio supported channel mask.

otPlatRadioGetTransmitBuffer

otRadioFrame * otPlatRadioGetTransmitBuffer(
  otInstance *aInstance
)

Get the radio transmit frame buffer.

OpenThread forms the IEEE 802.15.4 frame in this buffer then calls otPlatRadioTransmit() to request transmission.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Returns	A pointer to the transmit frame buffer.

otPlatRadioIsCoexEnabled

bool otPlatRadioIsCoexEnabled(
  otInstance *aInstance
)

Check whether radio coex is enabled or not.

This function is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Returns	TRUE if the radio coex is enabled, FALSE otherwise.

otPlatRadioIsEnabled

bool otPlatRadioIsEnabled(
  otInstance *aInstance
)

Check whether radio is enabled or not.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Returns	TRUE if the radio is enabled, FALSE otherwise.

otPlatRadioReceive

otError otPlatRadioReceive(
  otInstance *aInstance,
  uint8_t aChannel
)

Transition the radio from Sleep to Receive (turn on the radio).

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aChannel The channel to use for receiving.
Return Values	OT_ERROR_NONE Successfully transitioned to Receive. OT_ERROR_INVALID_STATE The radio was disabled or transmitting.

otPlatRadioReceiveAt

otError otPlatRadioReceiveAt(
  otInstance *aInstance,
  uint8_t aChannel,
  uint32_t aStart,
  uint32_t aDuration
)

Schedule a radio reception window at a specific time and duration.

Details
Parameters	[in] aChannel The radio channel on which to receive. [in] aStart The receive window start time, in microseconds. [in] aDuration The receive window duration, in microseconds
Return Values	OT_ERROR_NONE Successfully scheduled receive window. OT_ERROR_FAILED The receive window could not be scheduled.

otPlatRadioReceiveDone

void otPlatRadioReceiveDone(
  otInstance *aInstance,
  otRadioFrame *aFrame,
  otError aError
)

The radio driver calls this method to notify OpenThread of a received frame.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aFrame A pointer to the received frame or NULL if the receive operation failed. [in] aError OT_ERROR_NONE when successfully received a frame, OT_ERROR_ABORT when reception was aborted and a frame was not received, OT_ERROR_NO_BUFS when a frame could not be received due to lack of rx buffer space.

otPlatRadioSetChannelMaxTransmitPower

otError otPlatRadioSetChannelMaxTransmitPower(
  otInstance *aInstance,
  uint8_t aChannel,
  int8_t aMaxPower
)

Set the max transmit power for a specific channel.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aChannel The radio channel. [in] aMaxPower The max power in dBm, passing OT_RADIO_RSSI_INVALID will disable this channel.
Return Values	OT_ERROR_NOT_IMPLEMENTED The feature is not implemented OT_ERROR_INVALID_ARGS The specified channel is not valid. OT_ERROR_FAILED Other platform specific errors. OT_ERROR_NONE Successfully set max transmit power.

otPlatRadioSetCoexEnabled

otError otPlatRadioSetCoexEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Enable the radio coex.

This function is used when feature OPENTHREAD_CONFIG_PLATFORM_RADIO_COEX_ENABLE is enabled.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aEnabled TRUE to enable the radio coex, FALSE otherwise.
Return Values	OT_ERROR_NONE Successfully enabled. OT_ERROR_FAILED The radio coex could not be enabled.

otPlatRadioSetRegion

otError otPlatRadioSetRegion(
  otInstance *aInstance,
  uint16_t aRegionCode
)

Set the region code.

The radio region format is the 2-bytes ascii representation of the ISO 3166 alpha-2 code.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aRegionCode The radio region.
Return Values	OT_ERROR_FAILED Other platform specific errors. OT_ERROR_NONE Successfully set region code.

otPlatRadioSleep

otError otPlatRadioSleep(
  otInstance *aInstance
)

Transition the radio from Receive to Sleep (turn off the radio).

Details
Parameters	[in] aInstance The OpenThread instance structure.
Return Values	OT_ERROR_NONE Successfully transitioned to Sleep. OT_ERROR_BUSY The radio was transmitting. OT_ERROR_INVALID_STATE The radio was disabled.

otPlatRadioTransmit

otError otPlatRadioTransmit(
  otInstance *aInstance,
  otRadioFrame *aFrame
)

Begin the transmit sequence on the radio.

The caller must form the IEEE 802.15.4 frame in the buffer provided by otPlatRadioGetTransmitBuffer() before requesting transmission. The channel and transmit power are also included in the otRadioFrame structure.

The transmit sequence consists of:

1. Transitioning the radio to Transmit from one of the following states:
   • Receive if RX is on when the device is idle or OT_RADIO_CAPS_SLEEP_TO_TX is not supported
   • Sleep if RX is off when the device is idle and OT_RADIO_CAPS_SLEEP_TO_TX is supported.
2. Transmits the psdu on the given channel and at the given transmit power.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aFrame A pointer to the frame to be transmitted.
Return Values	OT_ERROR_NONE Successfully transitioned to Transmit. OT_ERROR_INVALID_STATE The radio was not in the Receive state.

otPlatRadioTxDone

void otPlatRadioTxDone(
  otInstance *aInstance,
  otRadioFrame *aFrame,
  otRadioFrame *aAckFrame,
  otError aError
)

The radio driver calls this function to notify OpenThread that the transmit operation has completed, providing both the transmitted frame and, if applicable, the received ack frame.

When radio provides OT_RADIO_CAPS_TRANSMIT_SEC capability, radio platform layer updates aFrame with the security frame counter and key index values maintained by the radio.

Details

Parameters

[in] aInstance The OpenThread instance structure. [in] aFrame A pointer to the frame that was transmitted. [in] aAckFrame A pointer to the ACK frame, NULL if no ACK was received. [in] aError OT_ERROR_NONE when the frame was transmitted, OT_ERROR_NO_ACK when the frame was transmitted but no ACK was received, OT_ERROR_CHANNEL_ACCESS_FAILURE tx could not take place due to activity on the channel, OT_ERROR_ABORT when transmission was aborted for other reasons.

otPlatRadioTxStarted

void otPlatRadioTxStarted(
  otInstance *aInstance,
  otRadioFrame *aFrame
)

The radio driver calls this method to notify OpenThread that the transmission has started.

Note: This function should be called by the same thread that executes all of the other OpenThread code. It should not be called by ISR or any other task.

Details
Parameters	[in] aInstance A pointer to the OpenThread instance structure. [in] aFrame A pointer to the frame that is being transmitted.

otPlatRadioUpdateCslSampleTime

void otPlatRadioUpdateCslSampleTime(
  otInstance *aInstance,
  uint32_t aCslSampleTime
)

Update CSL sample time in radio driver.

Sample time is stored in radio driver as a copy to calculate phase when sending ACK with CSL IE.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aCslSampleTime The latest sample time.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.