Collaboration diagram for Rf_driver_cc13x2_cc26x2:

Macros
#define	RF_convertUsToRatTicks(microseconds) ((microseconds) * (RF_RAT_TICKS_PER_US))
	Converts a duration given in microseconds into radio timer (RAT) ticks. More...

#define	RF_convertMsToRatTicks(milliseconds) ((milliseconds) * 1000 * (RF_RAT_TICKS_PER_US))
	Converts a duration given in milliseconds into radio timer (RAT) ticks. More...

#define	RF_convertRatTicksToUs(ticks) ((ticks) / (RF_RAT_TICKS_PER_US))
	Converts a duration given in radio timer (RAT) ticks into microseconds. More...

#define	RF_convertRatTicksToMs(ticks) ((ticks) / (1000 * (RF_RAT_TICKS_PER_US)))
	Converts a duration given in radio timer (RAT) ticks into milliseconds. More...

RF Core Events
Events originating on the RF core and caused during command execution. They are aliases for the corresponding interrupt flags. RF Core Events are command-specific and are explained in the Technical Reference Manual. See also RF_postCmd(), RF_pendCmd(), RF_runCmd()
#define	RF_EventCmdDone (1 << 0)
	A radio operation command in a chain finished. More...

#define	RF_EventLastCmdDone (1 << 1)
	A stand-alone radio operation command or the last radio operation command in a chain finished. More...

#define	RF_EventFGCmdDone (1 << 2)
	A IEEE-mode radio operation command in a chain finished. More...

#define	RF_EventLastFGCmdDone (1 << 3)
	A stand-alone IEEE-mode radio operation command or the last command in a chain finished. More...

#define	RF_EventTxDone (1 << 4)
	Packet transmitted. More...

#define	RF_EventTXAck (1 << 5)
	ACK packet transmitted. More...

#define	RF_EventTxCtrl (1 << 6)
	Control packet transmitted. More...

#define	RF_EventTxCtrlAck (1 << 7)
	Acknowledgement received on a transmitted control packet. More...

#define	RF_EventTxCtrlAckAck (1 << 8)
	Acknowledgement received on a transmitted control packet, and acknowledgement transmitted for that packet. More...

#define	RF_EventTxRetrans (1 << 9)
	Packet retransmitted. More...

#define	RF_EventTxEntryDone (1 << 10)
	Tx queue data entry state changed to Finished. More...

#define	RF_EventTxBufferChange (1 << 11)
	A buffer change is complete. More...

#define	RF_EventPaChanged (1 << 14)
	The PA was reconfigured on the fly. More...

#define	RF_EventSamplesEntryDone (1 << 15)
	CTE data has been copied, only valid if autocopy feature is enabled. More...

#define	RF_EventRxOk (1 << 16)
	Packet received with CRC OK, payload, and not to be ignored. More...

#define	RF_EventRxNOk (1 << 17)
	Packet received with CRC error. More...

#define	RF_EventRxIgnored (1 << 18)
	Packet received with CRC OK, but to be ignored. More...

#define	RF_EventRxEmpty (1 << 19)
	Packet received with CRC OK, not to be ignored, no payload. More...

#define	RF_EventRxCtrl (1 << 20)
	Control packet received with CRC OK, not to be ignored. More...

#define	RF_EventRxCtrlAck (1 << 21)
	Control packet received with CRC OK, not to be ignored, then ACK sent. More...

#define	RF_EventRxBufFull (1 << 22)
	Packet received that did not fit in the Rx queue. More...

#define	RF_EventRxEntryDone (1 << 23)
	Rx queue data entry changing state to Finished. More...

#define	RF_EventDataWritten (1 << 24)
	Data written to partial read Rx buffer. More...

#define	RF_EventNDataWritten (1 << 25)
	Specified number of bytes written to partial read Rx buffer. More...

#define	RF_EventRxAborted (1 << 26)
	Packet reception stopped before packet was done. More...

#define	RF_EventRxCollisionDetected (1 << 27)
	A collision was indicated during packet reception. More...

#define	RF_EventModulesUnlocked (1 << 29)
	As part of the boot process, the CM0 has opened access to RF core modules and memories. More...

#define	RF_EventInternalError (uint32_t)(1 << 31)
	Internal error observed. More...

#define	RF_EventMdmSoft 0x0000002000000000
	Synchronization word detected (MDMSOFT interrupt flag) More...

RF Driver Events
Event flags generated by the RF Driver.
#define	RF_EventCmdCancelled 0x1000000000000000
	Command canceled before it was started. More...

#define	RF_EventCmdAborted 0x2000000000000000
	Abrupt command termination caused by RF_cancelCmd() or RF_flushCmd(). More...

#define	RF_EventCmdStopped 0x4000000000000000
	Graceful command termination caused by RF_cancelCmd() or RF_flushCmd(). More...

#define	RF_EventRatCh 0x0800000000000000
	A user-programmable RAT channel triggered an event. More...

#define	RF_EventPowerUp 0x0400000000000000
	RF power up event. More...

#define	RF_EventError 0x0200000000000000
	Event flag used for error callback functions to indicate an error. See RF_Params::pErrCb. More...

#define	RF_EventCmdPreempted 0x0100000000000000
	Command preempted by another command with higher priority. Applies only to multi-client applications. More...

Control codes for driver configuration
Control codes are used in RF_control().
#define	RF_CTRL_SET_INACTIVITY_TIMEOUT 0
	Control code used by RF_control to set inactivity timeout. More...

#define	RF_CTRL_UPDATE_SETUP_CMD 1
	Control code used by RF_control to update setup command. More...

#define	RF_CTRL_SET_POWERUP_DURATION_MARGIN 2
	Control code used by RF_control to set powerup duration margin. More...

#define	RF_CTRL_SET_PHYSWITCHING_DURATION_MARGIN 3
	Control code used by RF_control to set the phy switching margin. More...

#define	RF_CTRL_SET_RAT_RTC_ERR_TOL_VAL 4
	Control code used by RF_control to set max error tolerance for RAT/RTC. More...

#define	RF_CTRL_SET_POWER_MGMT 5
	Control code used by RF_control to set power management. More...

#define	RF_CTRL_SET_HWI_PRIORITY 6
	Control code used by RF_control to set the hardware interrupt priority level of the RF driver. More...

#define	RF_CTRL_SET_SWI_PRIORITY 7
	Control code used by RF_control to set the software interrupt priority level of the RF driver. More...

#define	RF_CTRL_SET_AVAILABLE_RAT_CHANNELS_MASK 8
	Control code used by RF_control to mask the available RAT channels manually. More...

#define	RF_CTRL_COEX_CONTROL 9
	Control code used by RF_control to enable or disable the coexistence feature at runtime. More...

TX Power Table defines
#define	RF_TxPowerTable_MIN_DBM -128

#define	RF_TxPowerTable_MAX_DBM 126

#define	RF_TxPowerTable_INVALID_DBM 127

#define	RF_TxPowerTable_INVALID_VALUE 0x3fffff

#define	RF_TxPowerTable_TERMINATION_ENTRY { .power = RF_TxPowerTable_INVALID_DBM, .value = { .rawValue = RF_TxPowerTable_INVALID_VALUE, .paType = RF_TxPowerTable_DefaultPA } }

#define	RF_TxPowerTable_DEFAULT_PA_ENTRY(bias, gain, boost, coefficient) { .rawValue = ((bias) << 0) \| ((gain) << 6) \| ((boost) << 8) \| ((coefficient) << 9), .paType = RF_TxPowerTable_DefaultPA }

#define	RF_TxPowerTable_HIGH_PA_ENTRY(bias, ibboost, boost, coefficient, ldotrim) { .rawValue = ((bias) << 0) \| ((ibboost) << 6) \| ((boost) << 8) \| ((coefficient) << 9) \| ((ldotrim) << 16), .paType = RF_TxPowerTable_HighPA }

Other defines
#define	RF_GET_RSSI_ERROR_VAL (-128)
	Error return value for RF_getRssi() More...

#define	RF_CMDHANDLE_FLUSH_ALL (-1)
	RF command handle to flush all RF commands. More...

#define	RF_ALLOC_ERROR (-2)
	RF command or RAT channel allocation error. More...

#define	RF_SCHEDULE_CMD_ERROR (-3)
	RF command schedule error. More...

#define	RF_ERROR_RAT_PROG (-255)
	A rat channel could not be programmed. More...

#define	RF_ERROR_INVALID_RFMODE (-256)
	Invalid RF_Mode. Used in error callback. More...

#define	RF_ERROR_CMDFS_SYNTH_PROG (-257)
	Synthesizer error with CMD_FS. Used in error callback. If this error occurred in error callback, user needs to resend CMD_FS to recover. See the device's errata for more details. More...

#define	RF_NUM_SCHEDULE_ACCESS_ENTRIES 2
	Number of access request entries. More...

#define	RF_NUM_SCHEDULE_COMMAND_ENTRIES 8
	Number of scheduled command entries. More...

#define	RF_NUM_SCHEDULE_MAP_ENTRIES (RF_NUM_SCHEDULE_ACCESS_ENTRIES + RF_NUM_SCHEDULE_COMMAND_ENTRIES)
	Number of schedule map entries. This is the sum of access request and scheduled command entries. More...

#define	RF_SCH_MAP_CURRENT_CMD_OFFSET RF_NUM_SCHEDULE_ACCESS_ENTRIES
	Offset of the current command entry in the schedule map. More...

#define	RF_SCH_MAP_PENDING_CMD_OFFSET (RF_SCH_MAP_CURRENT_CMD_OFFSET + 2)
	Offset of the first pending command entry in the schedule map. More...

#define	RF_ABORT_PREEMPTION (1<<2)
	Used with RF_cancelCmd() to provoke subscription to RadioFreeCallback. More...

#define	RF_ABORT_GRACEFULLY (1<<0)
	Used with RF_cancelCmd() for graceful command termination. More...

#define	RF_SCH_CMD_EXECUTION_TIME_UNKNOWN 0
	For unknown execution time for RF scheduler. More...

#define	RF_RAT_ANY_CHANNEL (-1)
	To be used within the channel configuration structure. Allocate any of the available channels. More...

#define	RF_RAT_TICKS_PER_US 4
	Radio timer (RAT) ticks per microsecond. More...

#define	RF_LODIVIDER_MASK 0x7F
	Mask to be used to determine the effective value of the setup command's loDivider field. More...

Stack ID defines
Reserved values to identify which stack owns an RF_Handle h (stored as h->clientConfig.nID)
#define	RF_STACK_ID_DEFAULT 0x00000000
	No value is set. More...

#define	RF_STACK_ID_154 0x8000F154
	ID for TI 15.4 Stack. More...

#define	RF_STACK_ID_BLE 0x8000FB1E
	ID for TI BLE Stack. More...

#define	RF_STACK_ID_EASYLINK 0x8000FEA2
	ID for TI EasyLink Stack. More...

#define	RF_STACK_ID_THREAD 0x8000FEAD
	ID for TI Thread Stack. More...

#define	RF_STACK_ID_TOF 0x8000F00F
	ID for TI TOF Stack. More...

#define	RF_STACK_ID_CUSTOM 0x0000FC00
	ID for Custom Stack. More...

Detailed Description

Macro Definition Documentation

§ RF_EventCmdDone

#define RF_EventCmdDone (1 << 0)

A radio operation command in a chain finished.

§ RF_EventLastCmdDone

#define RF_EventLastCmdDone (1 << 1)

A stand-alone radio operation command or the last radio operation command in a chain finished.

§ RF_EventFGCmdDone

#define RF_EventFGCmdDone (1 << 2)

A IEEE-mode radio operation command in a chain finished.

§ RF_EventLastFGCmdDone

#define RF_EventLastFGCmdDone (1 << 3)

A stand-alone IEEE-mode radio operation command or the last command in a chain finished.

§ RF_EventTxDone

#define RF_EventTxDone (1 << 4)

Packet transmitted.

§ RF_EventTXAck

#define RF_EventTXAck (1 << 5)

ACK packet transmitted.

§ RF_EventTxCtrl

#define RF_EventTxCtrl (1 << 6)

Control packet transmitted.

§ RF_EventTxCtrlAck

#define RF_EventTxCtrlAck (1 << 7)

Acknowledgement received on a transmitted control packet.

§ RF_EventTxCtrlAckAck

#define RF_EventTxCtrlAckAck (1 << 8)

Acknowledgement received on a transmitted control packet, and acknowledgement transmitted for that packet.

§ RF_EventTxRetrans

#define RF_EventTxRetrans (1 << 9)

Packet retransmitted.

§ RF_EventTxEntryDone

#define RF_EventTxEntryDone (1 << 10)

Tx queue data entry state changed to Finished.

§ RF_EventTxBufferChange

#define RF_EventTxBufferChange (1 << 11)

A buffer change is complete.

§ RF_EventPaChanged

#define RF_EventPaChanged (1 << 14)

The PA was reconfigured on the fly.

§ RF_EventSamplesEntryDone

#define RF_EventSamplesEntryDone (1 << 15)

CTE data has been copied, only valid if autocopy feature is enabled.

§ RF_EventRxOk

#define RF_EventRxOk (1 << 16)

Packet received with CRC OK, payload, and not to be ignored.

§ RF_EventRxNOk

#define RF_EventRxNOk (1 << 17)

Packet received with CRC error.

§ RF_EventRxIgnored

#define RF_EventRxIgnored (1 << 18)

Packet received with CRC OK, but to be ignored.

§ RF_EventRxEmpty

#define RF_EventRxEmpty (1 << 19)

Packet received with CRC OK, not to be ignored, no payload.

§ RF_EventRxCtrl

#define RF_EventRxCtrl (1 << 20)

Control packet received with CRC OK, not to be ignored.

§ RF_EventRxCtrlAck

#define RF_EventRxCtrlAck (1 << 21)

Control packet received with CRC OK, not to be ignored, then ACK sent.

§ RF_EventRxBufFull

#define RF_EventRxBufFull (1 << 22)

Packet received that did not fit in the Rx queue.

§ RF_EventRxEntryDone

#define RF_EventRxEntryDone (1 << 23)

Rx queue data entry changing state to Finished.

§ RF_EventDataWritten

#define RF_EventDataWritten (1 << 24)

Data written to partial read Rx buffer.

§ RF_EventNDataWritten

#define RF_EventNDataWritten (1 << 25)

Specified number of bytes written to partial read Rx buffer.

§ RF_EventRxAborted

#define RF_EventRxAborted (1 << 26)

Packet reception stopped before packet was done.

§ RF_EventRxCollisionDetected

#define RF_EventRxCollisionDetected (1 << 27)

A collision was indicated during packet reception.

§ RF_EventModulesUnlocked

#define RF_EventModulesUnlocked (1 << 29)

As part of the boot process, the CM0 has opened access to RF core modules and memories.

§ RF_EventInternalError

#define RF_EventInternalError (uint32_t)(1 << 31)

Internal error observed.

§ RF_EventMdmSoft

#define RF_EventMdmSoft 0x0000002000000000

Synchronization word detected (MDMSOFT interrupt flag)

§ RF_EventCmdCancelled

#define RF_EventCmdCancelled 0x1000000000000000

Command canceled before it was started.

§ RF_EventCmdAborted

#define RF_EventCmdAborted 0x2000000000000000

Abrupt command termination caused by RF_cancelCmd() or RF_flushCmd().

§ RF_EventCmdStopped

#define RF_EventCmdStopped 0x4000000000000000

Graceful command termination caused by RF_cancelCmd() or RF_flushCmd().

§ RF_EventRatCh

#define RF_EventRatCh 0x0800000000000000

A user-programmable RAT channel triggered an event.

§ RF_EventPowerUp

#define RF_EventPowerUp 0x0400000000000000

RF power up event.

Deprecated:: This event is deprecated. Use RF_ClientEventPowerUpFinished instead.

§ RF_EventError

#define RF_EventError 0x0200000000000000

Event flag used for error callback functions to indicate an error. See RF_Params::pErrCb.

§ RF_EventCmdPreempted

#define RF_EventCmdPreempted 0x0100000000000000

Command preempted by another command with higher priority. Applies only to multi-client applications.

§ RF_CTRL_SET_INACTIVITY_TIMEOUT

#define RF_CTRL_SET_INACTIVITY_TIMEOUT 0

Control code used by RF_control to set inactivity timeout.

Setting this control allows RF to power down the radio upon completion of a radio command after a specified timeout period (in us) With this control code arg is a pointer to the timeout variable and returns RF_StatSuccess.

§ RF_CTRL_UPDATE_SETUP_CMD

#define RF_CTRL_UPDATE_SETUP_CMD 1

Control code used by RF_control to update setup command.

Setting this control notifies RF that the setup command is to be updated, so that RF will take proper actions when executing the next setup command. Note the updated setup command will take effect in the next power up cycle when RF executes the setup command. Prior to updating the setup command, user should make sure all pending commands have completed.

§ RF_CTRL_SET_POWERUP_DURATION_MARGIN

#define RF_CTRL_SET_POWERUP_DURATION_MARGIN 2

Control code used by RF_control to set powerup duration margin.

Setting this control updates the powerup duration margin. Default is RF_DEFAULT_POWER_UP_MARGIN.

§ RF_CTRL_SET_PHYSWITCHING_DURATION_MARGIN

#define RF_CTRL_SET_PHYSWITCHING_DURATION_MARGIN 3

Control code used by RF_control to set the phy switching margin.

Setting this control updates the phy switching duration margin, which is used to calculate when run-time conflicts shall be evaluated in case of colliding radio operations issued from two different clients. Default is RF_DEFAULT_PHY_SWITCHING_MARGIN.

§ RF_CTRL_SET_RAT_RTC_ERR_TOL_VAL

#define RF_CTRL_SET_RAT_RTC_ERR_TOL_VAL 4

Control code used by RF_control to set max error tolerance for RAT/RTC.

Setting this control updates the error tol for how frequently the CMD_RAT_SYNC_STOP is sent. Default is RF_DEFAULT_RAT_RTC_ERR_TOL_IN_US (5 us) Client is recommeneded to change this setting before sending any commands.

§ RF_CTRL_SET_POWER_MGMT

#define RF_CTRL_SET_POWER_MGMT 5

Control code used by RF_control to set power management.

Setting this control configures RF driver to enable or disable power management. By default power management is enabled. If disabled, once RF core wakes up, RF driver will not go to standby and will not power down RF core. To configure power management, use this control to pass a parameter value of 0 to disable power management, and pass a parameter value of 1 to re-enable power management. This control is valid for dual-mode code only. Setting this control when using single-mode code has no effect (power management always enabled).

§ RF_CTRL_SET_HWI_PRIORITY

#define RF_CTRL_SET_HWI_PRIORITY 6

Control code used by RF_control to set the hardware interrupt priority level of the RF driver.

This control code sets the hardware interrupt priority level that is used by the RF driver. Valid values are INT_PRI_LEVEL1 (highest) until INT_PRI_LEVEL7 (lowest). The default interrupt priority is set in the board support file. The default value is -1 which means "lowest possible priority".

When using the TI-RTOS kernel, INT_PRI_LEVEL0 is reserved for zero-latency interrupts and must not be used.

Execute this control code only while the RF core is powered down and the RF driver command queue is empty. This is usually the case after calling RF_open(). Changing the interrupt priority level while the RF driver is active will result in RF_StatBusyError being returned.

Example:

#include DeviceFamily_constructPath(driverlib/interrupt.h)
int32_t hwiPriority = INT_PRI_LEVEL5;
RF_control(rfHandle, RF_CTRL_SET_HWI_PRIORITY, &hwiPriority);

§ RF_CTRL_SET_SWI_PRIORITY

#define RF_CTRL_SET_SWI_PRIORITY 7

Control code used by RF_control to set the software interrupt priority level of the RF driver.

This control code sets the software interrupt priority level that is used by the RF driver. Valid values are integers starting at 0 (lowest) until Swi_numPriorities - 1 (highest). The default interrupt priority is set in the board support file. The default value is 0 which means means "lowest possible priority".

Execute this control code only while the RF core is powered down and the RF driver command queue is empty. This is usually the case after calling RF_open(). Changing the interrupt priority level while the RF driver is active will result in RF_StatBusyError being returned.

Example:

#include <ti/sysbios/knl/Swi.h>
// Set highest possible priority
uint32_t swiPriority = ~0;
RF_control(rfHandle, RF_CTRL_SET_SWI_PRIORITY, &swiPriority);

§ RF_CTRL_SET_AVAILABLE_RAT_CHANNELS_MASK

#define RF_CTRL_SET_AVAILABLE_RAT_CHANNELS_MASK 8

Control code used by RF_control to mask the available RAT channels manually.

This control code can be used to manually disallow/allow access to certain RAT channels from the RAT APIs. A typical use case is when a RAT channel is programmed through chained radio operations, and hence is used outside the scope of the RF driver. By disallowing access to this channel one can prevent collision between the automatic channel allocation through RF_ratCompare()/RF_ratCapture() and the direct configuration through RF_postCmd().

§ RF_CTRL_COEX_CONTROL

#define RF_CTRL_COEX_CONTROL 9

Control code used by RF_control to enable or disable the coexistence feature at runtime.

This control code can be used to manually override the statically configured setting for global enable/disable of the coexistence feature. It will have no effect if coexistence is not originally enabled and included in the compiled project.

Example:

// Disable the CoEx feature
uint32_t coexEnabled = 0;
RF_control(rfHandle, RF_CTRL_COEX_CONTROL, &coexEnabled);

§ RF_TxPowerTable_MIN_DBM

#define RF_TxPowerTable_MIN_DBM -128

Refers to the the minimum available power in dBm when accessing a power table.

See also: RF_TxPowerTable_findValue()

§ RF_TxPowerTable_MAX_DBM

#define RF_TxPowerTable_MAX_DBM 126

Refers to the the maximum available power in dBm when accessing a power table.

See also: RF_TxPowerTable_findValue()

§ RF_TxPowerTable_INVALID_DBM

#define RF_TxPowerTable_INVALID_DBM 127

Refers to an invalid power level in a TX power table.

See also: RF_TxPowerTable_findPowerLevel()

§ RF_TxPowerTable_INVALID_VALUE

#define RF_TxPowerTable_INVALID_VALUE 0x3fffff

Refers to an invalid power value in a TX power table.

This is the raw value part of a TX power configuration. In order to check whether a given power configuration is valid, do:

RF_TxPowerTable_Value value = ...;
if (value.rawValue == RF_TxPowerTable_INVALID_VALUE) {
    // error, value not valid
}

A TX power table is always terminated by an invalid power configuration.

See also: RF_getTxPower(), RF_TxPowerTable_findValue

§ RF_TxPowerTable_TERMINATION_ENTRY

#define RF_TxPowerTable_TERMINATION_ENTRY { .power = RF_TxPowerTable_INVALID_DBM, .value = { .rawValue = RF_TxPowerTable_INVALID_VALUE, .paType = RF_TxPowerTable_DefaultPA } }

Marks the last entry in a TX power table.

In order to use RF_TxPowerTable_findValue() and RF_TxPowerTable_findPowerLevel(), every power table must be terminated by a RF_TxPowerTable_TERMINATION_ENTRY:

RF_TxPowerTable_Entry txPowerTable[] =
{
    { 20,  RF_TxPowerTable_HIGH_PA_ENTRY(1, 2, 3) },
    // ... ,
    RF_TxPowerTable_TERMINATION_ENTRY
};

§ RF_TxPowerTable_DEFAULT_PA_ENTRY

#define RF_TxPowerTable_DEFAULT_PA_ENTRY	(	bias,
		gain,
		boost,
		coefficient
	)	{ .rawValue = ((bias) << 0) \| ((gain) << 6) \| ((boost) << 8) \| ((coefficient) << 9), .paType = RF_TxPowerTable_DefaultPA }

Creates a TX power table entry for the default PA.

The values for bias, gain, boost and coefficient are usually measured by Texas Instruments for a specific front-end configuration. They can then be obtained from SmartRFStudio.

§ RF_TxPowerTable_HIGH_PA_ENTRY

#define RF_TxPowerTable_HIGH_PA_ENTRY	(	bias,
		ibboost,
		boost,
		coefficient,
		ldotrim
	)	{ .rawValue = ((bias) << 0) \| ((ibboost) << 6) \| ((boost) << 8) \| ((coefficient) << 9) \| ((ldotrim) << 16), .paType = RF_TxPowerTable_HighPA }

Creates a TX power table entry for the High-power PA.

The values for bias, ibboost, boost, coefficient and ldoTrim are usually measured by Texas Instruments for a specific front-end configuration. They can then be obtained from SmartRFStudio.

§ RF_GET_RSSI_ERROR_VAL

#define RF_GET_RSSI_ERROR_VAL (-128)

Error return value for RF_getRssi()

§ RF_CMDHANDLE_FLUSH_ALL

#define RF_CMDHANDLE_FLUSH_ALL (-1)

RF command handle to flush all RF commands.

§ RF_ALLOC_ERROR

#define RF_ALLOC_ERROR (-2)

RF command or RAT channel allocation error.

§ RF_SCHEDULE_CMD_ERROR

#define RF_SCHEDULE_CMD_ERROR (-3)

RF command schedule error.

§ RF_ERROR_RAT_PROG

#define RF_ERROR_RAT_PROG (-255)

A rat channel could not be programmed.

§ RF_ERROR_INVALID_RFMODE

#define RF_ERROR_INVALID_RFMODE (-256)

Invalid RF_Mode. Used in error callback.

§ RF_ERROR_CMDFS_SYNTH_PROG

#define RF_ERROR_CMDFS_SYNTH_PROG (-257)

Synthesizer error with CMD_FS. Used in error callback. If this error occurred in error callback, user needs to resend CMD_FS to recover. See the device's errata for more details.

§ RF_NUM_SCHEDULE_ACCESS_ENTRIES

#define RF_NUM_SCHEDULE_ACCESS_ENTRIES 2

Number of access request entries.

§ RF_NUM_SCHEDULE_COMMAND_ENTRIES

#define RF_NUM_SCHEDULE_COMMAND_ENTRIES 8

Number of scheduled command entries.

§ RF_NUM_SCHEDULE_MAP_ENTRIES

#define RF_NUM_SCHEDULE_MAP_ENTRIES (RF_NUM_SCHEDULE_ACCESS_ENTRIES + RF_NUM_SCHEDULE_COMMAND_ENTRIES)

Number of schedule map entries. This is the sum of access request and scheduled command entries.

§ RF_SCH_MAP_CURRENT_CMD_OFFSET

#define RF_SCH_MAP_CURRENT_CMD_OFFSET RF_NUM_SCHEDULE_ACCESS_ENTRIES

Offset of the current command entry in the schedule map.

§ RF_SCH_MAP_PENDING_CMD_OFFSET

#define RF_SCH_MAP_PENDING_CMD_OFFSET (RF_SCH_MAP_CURRENT_CMD_OFFSET + 2)

Offset of the first pending command entry in the schedule map.

§ RF_ABORT_PREEMPTION

#define RF_ABORT_PREEMPTION (1<<2)

Used with RF_cancelCmd() to provoke subscription to RadioFreeCallback.

§ RF_ABORT_GRACEFULLY

#define RF_ABORT_GRACEFULLY (1<<0)

Used with RF_cancelCmd() for graceful command termination.

§ RF_SCH_CMD_EXECUTION_TIME_UNKNOWN

#define RF_SCH_CMD_EXECUTION_TIME_UNKNOWN 0

For unknown execution time for RF scheduler.

§ RF_RAT_ANY_CHANNEL

#define RF_RAT_ANY_CHANNEL (-1)

To be used within the channel configuration structure. Allocate any of the available channels.

§ RF_RAT_TICKS_PER_US

#define RF_RAT_TICKS_PER_US 4

Radio timer (RAT) ticks per microsecond.

§ RF_LODIVIDER_MASK

#define RF_LODIVIDER_MASK 0x7F

Mask to be used to determine the effective value of the setup command's loDivider field.

§ RF_STACK_ID_DEFAULT

#define RF_STACK_ID_DEFAULT 0x00000000

No value is set.

§ RF_STACK_ID_154

#define RF_STACK_ID_154 0x8000F154

ID for TI 15.4 Stack.

§ RF_STACK_ID_BLE

#define RF_STACK_ID_BLE 0x8000FB1E

ID for TI BLE Stack.

§ RF_STACK_ID_EASYLINK

#define RF_STACK_ID_EASYLINK 0x8000FEA2

ID for TI EasyLink Stack.

§ RF_STACK_ID_THREAD

#define RF_STACK_ID_THREAD 0x8000FEAD

ID for TI Thread Stack.

§ RF_STACK_ID_TOF

#define RF_STACK_ID_TOF 0x8000F00F

ID for TI TOF Stack.

§ RF_STACK_ID_CUSTOM

#define RF_STACK_ID_CUSTOM 0x0000FC00

ID for Custom Stack.

§ RF_convertUsToRatTicks

#define RF_convertUsToRatTicks ( microseconds ) ((microseconds) * (RF_RAT_TICKS_PER_US))

Converts a duration given in microseconds into radio timer (RAT) ticks.

§ RF_convertMsToRatTicks

#define RF_convertMsToRatTicks ( milliseconds ) ((milliseconds) * 1000 * (RF_RAT_TICKS_PER_US))

Converts a duration given in milliseconds into radio timer (RAT) ticks.

§ RF_convertRatTicksToUs

#define RF_convertRatTicksToUs ( ticks ) ((ticks) / (RF_RAT_TICKS_PER_US))

Converts a duration given in radio timer (RAT) ticks into microseconds.

§ RF_convertRatTicksToMs

#define RF_convertRatTicksToMs ( ticks ) ((ticks) / (1000 * (RF_RAT_TICKS_PER_US)))

Converts a duration given in radio timer (RAT) ticks into milliseconds.

Macros

RF Core Events

RF Driver Events

Control codes for driver configuration

TX Power Table defines

Other defines

Stack ID defines

Detailed Description

Macro Definition Documentation

§ RF_EventCmdDone

§ RF_EventLastCmdDone

§ RF_EventFGCmdDone

§ RF_EventLastFGCmdDone

§ RF_EventTxDone

§ RF_EventTXAck

§ RF_EventTxCtrl

§ RF_EventTxCtrlAck

§ RF_EventTxCtrlAckAck

§ RF_EventTxRetrans

§ RF_EventTxEntryDone

§ RF_EventTxBufferChange

§ RF_EventPaChanged

§ RF_EventSamplesEntryDone

§ RF_EventRxOk

§ RF_EventRxNOk

§ RF_EventRxIgnored

§ RF_EventRxEmpty

§ RF_EventRxCtrl

§ RF_EventRxCtrlAck

§ RF_EventRxBufFull

§ RF_EventRxEntryDone

§ RF_EventDataWritten

§ RF_EventNDataWritten

§ RF_EventRxAborted

§ RF_EventRxCollisionDetected

§ RF_EventModulesUnlocked

§ RF_EventInternalError

§ RF_EventMdmSoft

§ RF_EventCmdCancelled

§ RF_EventCmdAborted

§ RF_EventCmdStopped

§ RF_EventRatCh

§ RF_EventPowerUp

§ RF_EventError

§ RF_EventCmdPreempted

§ RF_CTRL_SET_INACTIVITY_TIMEOUT

§ RF_CTRL_UPDATE_SETUP_CMD

§ RF_CTRL_SET_POWERUP_DURATION_MARGIN

§ RF_CTRL_SET_PHYSWITCHING_DURATION_MARGIN

§ RF_CTRL_SET_RAT_RTC_ERR_TOL_VAL

§ RF_CTRL_SET_POWER_MGMT

§ RF_CTRL_SET_HWI_PRIORITY

§ RF_CTRL_SET_SWI_PRIORITY

§ RF_CTRL_SET_AVAILABLE_RAT_CHANNELS_MASK

§ RF_CTRL_COEX_CONTROL

§ RF_TxPowerTable_MIN_DBM

§ RF_TxPowerTable_MAX_DBM

§ RF_TxPowerTable_INVALID_DBM

§ RF_TxPowerTable_INVALID_VALUE

§ RF_TxPowerTable_TERMINATION_ENTRY

§ RF_TxPowerTable_DEFAULT_PA_ENTRY

§ RF_TxPowerTable_HIGH_PA_ENTRY

§ RF_GET_RSSI_ERROR_VAL

§ RF_CMDHANDLE_FLUSH_ALL

§ RF_ALLOC_ERROR

§ RF_SCHEDULE_CMD_ERROR

§ RF_ERROR_RAT_PROG

§ RF_ERROR_INVALID_RFMODE

§ RF_ERROR_CMDFS_SYNTH_PROG

§ RF_NUM_SCHEDULE_ACCESS_ENTRIES

§ RF_NUM_SCHEDULE_COMMAND_ENTRIES

§ RF_NUM_SCHEDULE_MAP_ENTRIES

§ RF_SCH_MAP_CURRENT_CMD_OFFSET

§ RF_SCH_MAP_PENDING_CMD_OFFSET

§ RF_ABORT_PREEMPTION

§ RF_ABORT_GRACEFULLY

§ RF_SCH_CMD_EXECUTION_TIME_UNKNOWN

§ RF_RAT_ANY_CHANNEL

§ RF_RAT_TICKS_PER_US

§ RF_LODIVIDER_MASK