Radio Operation

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

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

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.

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

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

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.

otError otPlatRadioAddCalibratedPower(
  otInstance *aInstance,
  uint8_t aChannel,
  int16_t aActualPower,
  const uint8_t *aRawPowerSetting,
  uint16_t aRawPowerSettingLength
)

Add a calibrated power of the specified channel to the power calibration table.

The aActualPower is the actual measured output power when the parameters of the radio hardware modules are set to the aRawPowerSetting.

The raw power setting is an opaque byte array. OpenThread doesn't define the format of the raw power setting. Its format is radio hardware related and it should be defined by the developers in the platform radio driver. For example, if the radio hardware contains both the radio chip and the FEM chip, the raw power setting can be a combination of the radio power register and the FEM gain value.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aChannel The radio channel. [in] aActualPower The actual power in 0.01dBm. [in] aRawPowerSetting A pointer to the raw power setting byte array. [in] aRawPowerSettingLength The length of the aRawPowerSetting.
Return Values	OT_ERROR_NONE Successfully added the calibrated power to the power calibration table. OT_ERROR_NO_BUFS No available entry in the power calibration table. OT_ERROR_INVALID_ARGS The aChannel, aActualPower or aRawPowerSetting is invalid or the aActualPower already exists in the power calibration table. OT_ERROR_NOT_IMPLEMENTED This feature is not implemented.

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.

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.

void otPlatRadioBusLatencyChanged(
  otInstance *aInstance
)

The radio driver calls this method to notify OpenThread that the spinel bus latency has been changed.

Details
Parameters	[in] aInstance The OpenThread instance structure.

otError otPlatRadioClearCalibratedPowers(
  otInstance *aInstance
)

Clear all calibrated powers from the power calibration table.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Return Values	OT_ERROR_NONE Successfully cleared all calibrated powers from the power calibration table. OT_ERROR_NOT_IMPLEMENTED This feature is not implemented.

void otPlatRadioClearSrcMatchExtEntries(
  otInstance *aInstance
)

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

Details
Parameters	[in] aInstance The OpenThread instance structure.

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.

void otPlatRadioClearSrcMatchShortEntries(
  otInstance *aInstance
)

Clear all short addresses from the source address match table.

Details
Parameters	[in] aInstance The OpenThread instance structure.

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.

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. OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.

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.

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.

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

Enable or disable CSL receiver.

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

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.

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

Begin the energy scan sequence on the radio.

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 energy scanning. OT_ERROR_NOT_IMPLEMENTED The radio doesn't support energy scanning.

void otPlatRadioEnergyScanDone(
  otInstance *aInstance,
  int8_t aEnergyScanMaxRssi
)

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

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.

otError otPlatRadioGetCoexMetrics(
  otInstance *aInstance,
  otRadioCoexMetrics *aCoexMetrics
)

Get the radio coexistence metrics.

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.

uint8_t otPlatRadioGetCslAccuracy(
  otInstance *aInstance
)

Get the current estimated worst case accuracy (maximum ± deviation from the nominal frequency) of the local radio clock in units of PPM.

This is the clock used to schedule CSL operations.

In case the implementation does not estimate the current value but returns a fixed value, this value MUST be the worst-case accuracy over all possible foreseen operating conditions (temperature, pressure, etc) of the implementation.

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

uint8_t otPlatRadioGetCslUncertainty(
  otInstance *aInstance
)

The fixed uncertainty (i.e.

random jitter) of the arrival time of CSL transmissions received by this device in units of 10 microseconds.

This designates the worst case constant positive or negative deviation of the actual arrival time of a transmission from the transmission time calculated relative to the local radio clock independent of elapsed time. In addition to uncertainty accumulated over elapsed time, the CSL channel sample ("RX window") must be extended by twice this deviation such that an actual transmission is guaranteed to be detected by the local receiver in the presence of random arrival time jitter.

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

uint32_t otPlatRadioGetPreferredChannelMask(
  otInstance *aInstance
)

Gets 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.

otError otPlatRadioGetRawPowerSetting(
  otInstance *aInstance,
  uint8_t aChannel,
  uint8_t *aRawPowerSetting,
  uint16_t *aRawPowerSettingLength
)

Get the raw power setting for the given channel.

Platform radio layer should parse the raw power setting based on the radio layer defined format and set the parameters of each radio hardware module.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aChannel The radio channel. [out] aRawPowerSetting A pointer to the raw power setting byte array. [in,out] aRawPowerSettingLength On input, a pointer to the size of aRawPowerSetting. On output, a pointer to the length of the raw power setting data.
Return Values	OT_ERROR_NONE Successfully got the target power. OT_ERROR_INVALID_ARGS The aChannel is invalid, aRawPowerSetting or aRawPowerSettingLength is NULL or is too short. OT_ERROR_NOT_FOUND The raw power setting for the aChannel was not found.

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. OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.

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.

otRadioState otPlatRadioGetState(
  otInstance *aInstance
)

Get current state of the radio.

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

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

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.

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.

bool otPlatRadioIsCoexEnabled(
  otInstance *aInstance
)

Check whether radio coex is enabled or not.

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.

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.

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.

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 relative to the local radio clock, see otPlatRadioGetNow. The radio receiver SHALL be on and ready to receive the first symbol of a frame's SHR at the window start time. [in] aDuration The receive window duration, in microseconds, as measured by the local radio clock. The radio SHOULD be turned off (or switched to TX mode if an ACK frame needs to be sent) after that duration unless it is still actively receiving a frame. In the latter case the radio SHALL be kept in reception mode until frame reception has either succeeded or failed.
Return Values	OT_ERROR_NONE Successfully scheduled receive window. OT_ERROR_FAILED The receive window could not be scheduled.

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.

otError otPlatRadioResetCsl(
  otInstance *aInstance
)

Reset CSL receiver in the platform.

Details
Parameters	[in] aInstance The OpenThread instance structure.
Return Values	OT_ERROR_NOT_IMPLEMENTED Radio driver doesn't support CSL. OT_ERROR_FAILED Other platform specific errors. OT_ERROR_NONE Successfully disabled CSL.

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.

otError otPlatRadioSetChannelTargetPower(
  otInstance *aInstance,
  uint8_t aChannel,
  int16_t aTargetPower
)

Set the target power for the given channel.

The radio driver should set the actual output power to be less than or equal to the aTargetPower and as close as possible to the aTargetPower. If the aTargetPower is lower than the minimum output power supported by the platform, the output power should be set to the minimum output power supported by the platform. If the aTargetPower is higher than the maximum output power supported by the platform, the output power should be set to the maximum output power supported by the platform. If the aTargetPower is set to INT16_MAX, the corresponding channel is disabled.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aChannel The radio channel. [in] aTargetPower The target power in 0.01dBm.
Return Values	OT_ERROR_NONE Successfully set the target power. OT_ERROR_INVALID_ARGS The aChannel is invalid. OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.

otError otPlatRadioSetCoexEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Enable the radio coex.

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.

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 code. The aRegionCode >> 8 is first ascii char and the aRegionCode & 0xff is the second ascii char.
Return Values	OT_ERROR_FAILED Other platform specific errors. OT_ERROR_NONE Successfully set region code. OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.

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.

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.

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.

void otPlatRadioTxStarted(
  otInstance *aInstance,
  otRadioFrame *aFrame
)

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

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

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. The CSL sample (window) of the CSL receiver extends before and after the sample time. The CSL sample time marks a timestamp in the CSL sample window when a frame should be received in "ideal conditions" if there would be no inaccuracy/clock-drift.

Details
Parameters	[in] aInstance The OpenThread instance structure. [in] aCslSampleTime The next sample time, in microseconds. It is the time when the first symbol of the MHR of the frame is expected.