Configuration

This module includes the platform abstraction for radio configuration.

Summary

Functions

otPlatRadioGetCaps(otInstance *aInstance)
Get the radio capabilities.
otPlatRadioGetIeeeEui64(otInstance *aInstance, uint8_t *aIeeeEui64)
void
Get the factory-assigned IEEE EUI-64 for this interface.
otPlatRadioGetPromiscuous(otInstance *aInstance)
bool
Get the status of promiscuous mode.
otPlatRadioGetReceiveSensitivity(otInstance *aInstance)
int8_t
Get the radio receive sensitivity value.
otPlatRadioGetTransmitPower(otInstance *aInstance, int8_t *aPower)
Get the radio's transmit power in dBm.
otPlatRadioGetVersionString(otInstance *aInstance)
const char *
Get the radio version string.
otPlatRadioSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
void
Set the Extended Address for address filtering.
otPlatRadioSetPanId(otInstance *aInstance, otPanId aPanId)
void
Set the PAN ID for address filtering.
otPlatRadioSetPromiscuous(otInstance *aInstance, bool aEnable)
void
Enable or disable promiscuous mode.
otPlatRadioSetShortAddress(otInstance *aInstance, otShortAddress aShortAddress)
void
Set the Short Address for address filtering.
otPlatRadioSetTransmitPower(otInstance *aInstance, int8_t aPower)
Set the radio's transmit power in dBm.

Functions

otPlatRadioGetCaps

otRadioCaps otPlatRadioGetCaps(
  otInstance *aInstance
)

Get the radio capabilities.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
Returns
The radio capability bit vector (see OT_RADIO_CAP_* definitions).

otPlatRadioGetIeeeEui64

void otPlatRadioGetIeeeEui64(
  otInstance *aInstance,
  uint8_t *aIeeeEui64
)

Get the factory-assigned IEEE EUI-64 for this interface.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[out] aIeeeEui64
A pointer to the factory-assigned IEEE EUI-64.

otPlatRadioGetPromiscuous

bool otPlatRadioGetPromiscuous(
  otInstance *aInstance
)

Get the status of promiscuous mode.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
Return Values
TRUE
Promiscuous mode is enabled.
FALSE
Promiscuous mode is disabled.

otPlatRadioGetReceiveSensitivity

int8_t otPlatRadioGetReceiveSensitivity(
  otInstance *aInstance
)

Get the radio receive sensitivity value.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
Returns
The radio receive sensitivity value in dBm.

otPlatRadioGetTransmitPower

otError otPlatRadioGetTransmitPower(
  otInstance *aInstance,
  int8_t *aPower
)

Get the radio's transmit power in dBm.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[out] aPower
The transmit power in dBm.
Return Values
OT_ERROR_NONE
Successfully retrieved the transmit power.
OT_ERROR_INVALID_ARGS
aPower was NULL.
OT_ERROR_NOT_IMPLEMENTED
Transmit power configuration via dBm is not implemented.

otPlatRadioGetVersionString

const char * otPlatRadioGetVersionString(
  otInstance *aInstance
)

Get the radio version string.

This is an optional radio driver platform function. If not provided by platform radio driver, OpenThread uses the OpenThread version instead (

Details
Parameters
[in] aInstance
The OpenThread instance structure.
Returns
A pointer to the OpenThread radio version.
See also:
otGetVersionString()).

otPlatRadioSetExtendedAddress

void otPlatRadioSetExtendedAddress(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Set the Extended Address for address filtering.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aExtAddress
A pointer to the IEEE 802.15.4 Extended Address stored in little-endian byte order.

otPlatRadioSetPanId

void otPlatRadioSetPanId(
  otInstance *aInstance,
  otPanId aPanId
)

Set the PAN ID for address filtering.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aPanId
The IEEE 802.15.4 PAN ID.

otPlatRadioSetPromiscuous

void otPlatRadioSetPromiscuous(
  otInstance *aInstance,
  bool aEnable
)

Enable or disable promiscuous mode.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aEnable
TRUE to enable or FALSE to disable promiscuous mode.

otPlatRadioSetShortAddress

void otPlatRadioSetShortAddress(
  otInstance *aInstance,
  otShortAddress aShortAddress
)

Set the Short Address for address filtering.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aShortAddress
The IEEE 802.15.4 Short Address.

otPlatRadioSetTransmitPower

otError otPlatRadioSetTransmitPower(
  otInstance *aInstance,
  int8_t aPower
)

Set the radio's transmit power in dBm.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aPower
The transmit power in dBm.
Return Values
OT_ERROR_NONE
Successfully set the transmit power.
OT_ERROR_NOT_IMPLEMENTED
Transmit power configuration via dBm is not implemented.