Collaboration diagram for Rf_driver:

Modules
	Rf_driver_cc13x2_cc26x2

Data Structures
struct	RF_TxPowerTable_Value
	PA configuration value for a certain power level. More...

struct	RF_TxPowerTable_Entry
	TX power configuration entry in a TX power table. More...

struct	RF_Mode
	Specifies a RF core firmware configuration. More...

struct	RF_CoexOverride
	Runtime coexistence override parameters. More...

struct	RF_CoexOverride_BLEUseCases
	Coexistence override settings for BLE5 application scenarios. More...

union	RF_RadioSetup
	A unified type for radio setup commands of different PHYs. More...

union	RF_InfoVal
	Stores output parameters for RF_getInfo(). More...

struct	RF_ScheduleMapElement
	RF schedule map entry structure. More...

struct	RF_ScheduleMap
	RF schedule map structure. More...

struct	RF_Params
	RF driver configuration parameters. More...

struct	RF_Cmd_s

struct	RFCC26XX_HWAttrsV2
	RF Hardware attributes. More...

struct	RFCC26XX_SchedulerPolicy
	RF scheduler policy. More...

struct	RF_ScheduleCmdParams

struct	RF_AccessParams
	RF request access parameter struct. More...

struct	RF_RatConfigCapture
	RF_ratCapture parameter structure. More...

struct	RF_RatConfigCompare
	RF_ratCompare parameter structure. More...

struct	RF_RatConfigOutput
	RAT related IO parameter structure. More...

struct	RF_Object
	Stores the client's internal configuration and states. More...

Typedefs
typedef rfc_radioOp_t	RF_Op
	Base type for all radio operation commands. More...

typedef uint64_t	RF_EventMask
	Data type for events during command execution. More...

typedef uint32_t	RF_ClientEventMask
	Event mask for combining RF_ClientEvent event flags in RF_Params::nClientEventMask. More...

typedef uint32_t	RF_GlobalEventMask
	Event mask for combining RF_GlobalEvent event flags in RFCC26XX_HWAttrsV2::globalEventMask. More...

typedef int16_t	RF_CmdHandle
	Command handle that is returned by RF_postCmd(). More...

typedef RF_Object *	RF_Handle
	A handle that is returned by to RF_open(). More...

typedef int8_t	RF_RatHandle
	RAT handle that is returned by RF_ratCompare() or RF_ratCapture(). More...

typedef void(*	RF_Callback) (RF_Handle h, RF_CmdHandle ch, RF_EventMask e)
	Handles events related to RF command execution. More...

typedef void(*	RF_RatCallback) (RF_Handle h, RF_RatHandle rh, RF_EventMask e, uint32_t compareCaptureTime)
	Handles events related to the Radio Timer (RAT). More...

typedef void(*	RF_ClientCallback) (RF_Handle h, RF_ClientEvent event, void *arg)
	Handles events related to a driver instance. More...

typedef void(*	RF_GlobalCallback) (RF_Handle h, RF_GlobalEvent event, void *arg)
	Handles global events as part of PHY configuration. More...

typedef struct RF_Cmd_s	RF_Cmd

typedef RF_ScheduleStatus(*	RF_SubmitHook) (RF_Cmd pCmdNew, RF_Cmd pCmdBg, RF_Cmd pCmdFg, List_List pPendQueue, List_List *pDoneQueue)
	Handles the queue sorting algorithm when a new command is submitted to the driver from any of the active clients. More...

typedef RF_ExecuteAction(*	RF_ExecuteHook) (RF_Cmd pCmdBg, RF_Cmd pCmdFg, List_List pPendQueue, List_List pDoneQueue, bool bConflict, RF_Cmd *conflictCmd)
	Defines the execution and conflict resolution hook at runtime. More...

Enumerations
enum	RF_TxPowerTable_PAType { RF_TxPowerTable_DefaultPA = 0, RF_TxPowerTable_HighPA = 1 }
	Selects a power amplifier path in a TX power value. More...

enum	RF_Priority { RF_PriorityHighest = 2, RF_PriorityHigh = 1, RF_PriorityNormal = 0 }
	Scheduling priority of RF operation commands. More...

enum	RF_PriorityCoex { RF_PriorityCoexDefault = 0, RF_PriorityCoexLow = 1, RF_PriorityCoexHigh = 2 }
	Priority level for coexistence priority signal. More...

enum	RF_RequestCoex { RF_RequestCoexDefault = 0, RF_RequestCoexAssertRx = 1, RF_RequestCoexNoAssertRx = 2 }
	Behavior for coexistence request signal. More...

enum	RF_Stat { RF_StatBusyError, RF_StatRadioInactiveError, RF_StatCmdDoneError, RF_StatInvalidParamsError, RF_StatCmdEnded, RF_StatError = 0x80, RF_StatCmdDoneSuccess, RF_StatCmdSch, RF_StatSuccess }
	Status codes for various RF driver functions. More...

enum	RF_ClientEvent { RF_ClientEventPowerUpFinished = (1 << 0), RF_ClientEventRadioFree = (1 << 1), RF_ClientEventSwitchClientEntered = (1 << 2) }
	Client-related RF driver events. More...

enum	RF_GlobalEvent { RF_GlobalEventRadioSetup = (1 << 0), RF_GlobalEventRadioPowerDown = (1 << 1), RF_GlobalEventInit = (1 << 2), RF_GlobalEventCmdStart = (1 << 3), RF_GlobalEventCmdStop = (1 << 4), RF_GlobalEventCoexControl = (1 << 5), RF_GlobalEventTempNotifyFail = (1 << 6) }
	Global RF driver events. More...

enum	RF_InfoType { RF_GET_CURR_CMD, RF_GET_AVAIL_RAT_CH, RF_GET_RADIO_STATE, RF_GET_SCHEDULE_MAP, RF_GET_CLIENT_LIST, RF_GET_CLIENT_SWITCHING_TIME }
	Selects the entry of interest in RF_getInfo(). More...

enum	RF_StartType { RF_StartNotSpecified = 0, RF_StartAbs = 1 }
	Controls the behavior of the RF_scheduleCmd() API. More...

enum	RF_EndType { RF_EndNotSpecified = 0, RF_EndAbs = 1, RF_EndRel = 2, RF_EndInfinit = 3 }
	Controls the behavior of the RF_scheduleCmd() API. More...

enum	RF_ExecuteAction { RF_ExecuteActionNone = 0, RF_ExecuteActionRejectIncoming = 1, RF_ExecuteActionAbortOngoing = 2 }
	Controls the behavior of the state machine of the RF driver when a conflict is identified run-time between the commands waiting on the pend queue and the commands being actively executed by the radio. More...

enum	RF_ScheduleStatus { RF_ScheduleStatusError = -3, RF_ScheduleStatusNone = 0, RF_ScheduleStatusTop = 1, RF_ScheduleStatusMiddle = 2, RF_ScheduleStatusTail = 4, RF_ScheduleStatusPreempt = 8 }
	Describes the location within the pend queue where the new command was inserted by the scheduler. More...

enum	RF_AllowDelay { RF_AllowDelayNone = 0, RF_AllowDelayAny = UINT32_MAX }
	Controls the behavior of the RF_scheduleCmd() API. More...

enum	RF_RatSelectChannel { RF_RatChannelAny = -1, RF_RatChannel0 = 0, RF_RatChannel1 = 1, RF_RatChannel2 = 2 }
	Select the preferred RAT channel through the configuration of RF_ratCompare() or RF_ratCapture(). More...

enum	RF_RatCaptureSource { RF_RatCaptureSourceRtcUpdate = 20, RF_RatCaptureSourceEventGeneric = 21, RF_RatCaptureSourceRfcGpi0 = 22, RF_RatCaptureSourceRfcGpi1 = 23 }
	Selects the source signal for RF_ratCapture(). More...

enum	RF_RatCaptureMode { RF_RatCaptureModeRising = 0, RF_RatCaptureModeFalling = 1, RF_RatCaptureModeBoth = 2 }
	Selects the mode of RF_ratCapture(). More...

enum	RF_RatCaptureRepetition { RF_RatCaptureSingle = 0, RF_RatCaptureRepeat = 1 }
	Selects the repetition of RF_ratCapture(). More...

enum	RF_RatOutputMode { RF_RatOutputModePulse = 0, RF_RatOutputModeSet = 1, RF_RatOutputModeClear = 2, RF_RatOutputModeToggle = 3, RF_RatOutputModeAlwaysZero = 4, RF_RatOutputModeAlwaysOne = 5 }
	Selects the mode of the RAT_GPO[x] for RF_ratCompare() or RF_ratCapture(). More...

enum	RF_RatOutputSelect { RF_RatOutputSelectRatGpo1 = 1, RF_RatOutputSelectRatGpo2 = 2, RF_RatOutputSelectRatGpo3 = 3, RF_RatOutputSelectRatGpo4 = 4, RF_RatOutputSelectRatGpo5 = 5, RF_RatOutputSelectRatGpo6 = 6, RF_RatOutputSelectRatGpo7 = 7 }
	Selects GPO to be used with RF_ratCompare() or RF_ratCapture(). More...

Functions
RF_Handle	RF_open (RF_Object pObj, RF_Mode pRfMode, RF_RadioSetup pRadioSetup, RF_Params params)
	Creates a a new client instance of the RF driver. More...

void	RF_close (RF_Handle h)
	Close client connection to RF driver. More...

uint32_t	RF_getCurrentTime (void)
	Return current radio timer value. More...

RF_CmdHandle	RF_postCmd (RF_Handle h, RF_Op *pOp, RF_Priority ePri, RF_Callback pCb, RF_EventMask bmEvent)
	Appends RF operation commands to the driver's command queue and returns a command handle. More...

RF_ScheduleStatus	RF_defaultSubmitPolicy (RF_Cmd pCmdNew, RF_Cmd pCmdBg, RF_Cmd pCmdFg, List_List pPendQueue, List_List *pDoneQueue)
	Sorts and adds commands to the RF driver internal command queue. More...

RF_ExecuteAction	RF_defaultExecutionPolicy (RF_Cmd pCmdBg, RF_Cmd pCmdFg, List_List pPendQueue, List_List pDoneQueue, bool bConflict, RF_Cmd *conflictCmd)
	Makes a final decision before dispatching a scheduled command. More...

void	RF_ScheduleCmdParams_init (RF_ScheduleCmdParams *pSchParams)
	Initialize the configuration structure to default values to be used with the RF_scheduleCmd() API. More...

RF_CmdHandle	RF_scheduleCmd (RF_Handle h, RF_Op pOp, RF_ScheduleCmdParams pSchParams, RF_Callback pCb, RF_EventMask bmEvent)
	Schedule an RF operation (chain) to the command queue. More...

RF_EventMask	RF_pendCmd (RF_Handle h, RF_CmdHandle ch, RF_EventMask bmEvent)
	Synchronizes the calling task to an RF operation command ch and returns accumulated event flags. More...

RF_EventMask	RF_runCmd (RF_Handle h, RF_Op *pOp, RF_Priority ePri, RF_Callback pCb, RF_EventMask bmEvent)
	Runs synchronously an RF operation command or a chain of commands and returns the termination reason. More...

RF_EventMask	RF_runScheduleCmd (RF_Handle h, RF_Op pOp, RF_ScheduleCmdParams pSchParams, RF_Callback pCb, RF_EventMask bmEvent)
	Runs synchronously a (chain of) RF operation(s) for dual or single-mode. More...

RF_Stat	RF_cancelCmd (RF_Handle h, RF_CmdHandle ch, uint8_t mode)
	Abort/stop/cancel single command in command queue. More...

RF_Stat	RF_flushCmd (RF_Handle h, RF_CmdHandle ch, uint8_t mode)
	Abort/stop/cancel command and any subsequent commands in command queue. More...

RF_Stat	RF_runImmediateCmd (RF_Handle h, uint32_t *pCmdStruct)
	Send any Immediate command. More...

RF_Stat	RF_runDirectCmd (RF_Handle h, uint32_t cmd)
	Send any Direct command. More...

void	RF_yield (RF_Handle h)
	Signal that radio client is not going to issue more commands in a while. More...

void	RF_Params_init (RF_Params *params)
	Function to initialize the RF_Params struct to its defaults. More...

RF_Stat	RF_getInfo (RF_Handle h, RF_InfoType type, RF_InfoVal *pValue)
	Get value for some RF driver parameters. More...

int8_t	RF_getRssi (RF_Handle h)
	Get RSSI value. More...

RF_Op *	RF_getCmdOp (RF_Handle h, RF_CmdHandle cmdHnd)
	Get command structure pointer. More...

void	RF_RatConfigCompare_init (RF_RatConfigCompare *channelConfig)
	Initialize the configuration structure to be used to set up a RAT compare event. More...

void	RF_RatConfigCapture_init (RF_RatConfigCapture *channelConfig)
	Initialize the configuration structure to be used to set up a RAT capture event. More...

void	RF_RatConfigOutput_init (RF_RatConfigOutput *ioConfig)
	Initialize the configuration structure to be used to set up a RAT IO. More...

RF_RatHandle	RF_ratCompare (RF_Handle rfHandle, RF_RatConfigCompare channelConfig, RF_RatConfigOutput ioConfig)
	Setup a Radio Timer (RAT) channel in compare mode. More...

RF_RatHandle	RF_ratCapture (RF_Handle rfHandle, RF_RatConfigCapture channelConfig, RF_RatConfigOutput ioConfig)
	Setup a Radio Timer (RAT) channel in capture mode. More...

RF_Stat	RF_ratDisableChannel (RF_Handle rfHandle, RF_RatHandle ratHandle)
	Disable a RAT channel. More...

RF_Stat	RF_control (RF_Handle h, int8_t ctrl, void *args)
	Set RF control parameters. More...

RF_Stat	RF_requestAccess (RF_Handle h, RF_AccessParams *pParams)
	Request radio access. More...

RF_TxPowerTable_Value	RF_getTxPower (RF_Handle h)
	Returns the currently configured transmit power configuration. More...

RF_Stat	RF_setTxPower (RF_Handle h, RF_TxPowerTable_Value value)
	Updates the transmit power configuration of the RF core. More...

int8_t	RF_TxPowerTable_findPowerLevel (RF_TxPowerTable_Entry table[], RF_TxPowerTable_Value value)
	Retrieves a power level in dBm for a given power configuration value. More...

RF_TxPowerTable_Value	RF_TxPowerTable_findValue (RF_TxPowerTable_Entry table[], int8_t powerLevel)
	Retrieves a power configuration value for a given power level in dBm. More...

RF_Stat	RF_enableHPOSCTemperatureCompensation (void)
	Enables temperature monitoring and temperature based drift compensation. More...

Detailed Description

Typedef Documentation

§ RF_Op

typedef rfc_radioOp_t RF_Op

Base type for all radio operation commands.

All radio operation commands share a common part. That includes the command id, a status field, chaining properties and a start trigger. Whenever an RF operation command is used with the RF driver, it needs to be casted to an RF_Op.

More information about RF operation commands can be found in the Proprietary RF User's Guide.

See also: RF_runCmd(), RF_postCmd(), RF_pendCmd()

§ RF_EventMask

typedef uint64_t RF_EventMask

Data type for events during command execution.

Possible event flags are listed in RF_Core_Events and RF_Driver_Events.

§ RF_ClientEventMask

typedef uint32_t RF_ClientEventMask

Event mask for combining RF_ClientEvent event flags in RF_Params::nClientEventMask.

§ RF_GlobalEventMask

typedef uint32_t RF_GlobalEventMask

Event mask for combining RF_GlobalEvent event flags in RFCC26XX_HWAttrsV2::globalEventMask.

§ RF_CmdHandle

typedef int16_t RF_CmdHandle

Command handle that is returned by RF_postCmd().

A command handle is an integer number greater equals zero and identifies a command container in the RF driver's internal command queue. A client can dispatch a command with RF_postCmd() and use the command handle later on to make the RF driver interact with the command.

A negative value has either a special meaning or indicates an error.

See also: RF_pendCmd(), RF_flushCmd(), RF_cancelCmd(), RF_ALLOC_ERROR, RF_CMDHANDLE_FLUSH_ALL

§ RF_Handle

typedef RF_Object* RF_Handle

A handle that is returned by to RF_open().

RF_Handle is used for further RF client interaction with the RF driver. An invalid handle has the value NULL.

§ RF_RatHandle

typedef int8_t RF_RatHandle

RAT handle that is returned by RF_ratCompare() or RF_ratCapture().

An RF_RatHandle is an integer number with value greater than or equal to zero and identifies a Radio Timer Channel in the RF driver's internal RAT module. A client can interact with the RAT module through the RF_ratCompare(), RF_ratCapture() or RF_ratDisableChannel() APIs.

A negative value indicates an error. A typical example when RF_ratCompare() returns with RF_ALLOC_ERROR.

§ RF_Callback

typedef void(* RF_Callback) (RF_Handle h, RF_CmdHandle ch, RF_EventMask e)

Handles events related to RF command execution.

RF command callbacks notify the application of any events happening during RF command execution. Events may either refer to RF core interrupts (RF_Core_Events) or may be generated by the RF driver (RF_Driver_Events).

RF command callbacks are set up as parameter to RF_postCmd() or RF_runCmd() and provide:

the relevant driver client handle h which was returned by RF_open(),
the relevant radio operation command handle ch,
an event mask e containing the occurred events.

RF command callbacks are executed in Software Interrupt (SWI) context and must not perform any blocking operation. The priority is configurable via RFCC26XX_HWAttrsV2 in the board file or RF_CTRL_SET_SWI_PRIORITY in RF_control().

The RF_Callback function type is also used for signaling power events and errors. These are set in RF_Params::pPowerCb and RF_Params::pErrCb respectively. In case of a power event, ch can be ignored and e has RF_EventPowerUp set. In case of an error callback, ch contains an error code instead of a command handle and e has the RF_EventError flag set.

Note: Error and power callbacks will be replaced by RF_ClientCallback in future releases.

§ RF_RatCallback

typedef void(* RF_RatCallback) (RF_Handle h, RF_RatHandle rh, RF_EventMask e, uint32_t compareCaptureTime)

Handles events related to the Radio Timer (RAT).

The RF driver provides an interface to the Radio Timer through RF_ratCompare(), RF_ratCapture() and RF_ratDisableChannel() APIs. Each API call receives an optional input argument of the type RF_RatCallback. When a timer event occurs (compare, capture or error events), the registered callback is invoked.

The RF_RatCallback provides the following argument:

the relevant driver client handle h which was returned by RF_open(),
the relevant rat timer handle rh which the event is caused by,
an event mask e containing the occurred event (RF_EventRatCh or RF_EventError)
the captured value or the compare time compareCaptureTime read from the Radio Timer channel.

§ RF_ClientCallback

typedef void(* RF_ClientCallback) (RF_Handle h, RF_ClientEvent event, void *arg)

Handles events related to a driver instance.

The RF driver produces additional events that are not directly related to the execution of a certain command, but happen during general RF driver operations. This includes power-up events, client switching events and others.

A client callback provides the following arguments:

the relevant driver client handle h which was returned by RF_open(),
an event identifier event,
an optional argument arg depending on the event.

RF client callbacks are executed in Software Interrupt (SWI) context and must not perform any blocking operation. The priority is configurable via RFCC26XX_HWAttrsV2 in the board file or RF_CTRL_SET_SWI_PRIORITY in RF_control().

§ RF_GlobalCallback

typedef void(* RF_GlobalCallback) (RF_Handle h, RF_GlobalEvent event, void *arg)

Handles global events as part of PHY configuration.

The RF driver serves additional global, client independent events by invoking the RF_GlobalCallback function registered through RFCC26XX_HWAttrsV2::globalCallback in the board file. The function can subscribe to particular events through the RFCC26XX_HWAttrsV2::globalEventMask, and receives the following arguments:

the relevant driver client handle h which was returned by RF_open(),
an event identifier event,
an optional argument arg depending on the event.

If multiple events happen at the same time, the callback is always invoked separately for each event. Depending on the event, the callback might be invoked in SWI or HWI context.

§ RF_Cmd

typedef struct RF_Cmd_s RF_Cmd

§ RF_SubmitHook

typedef RF_ScheduleStatus(* RF_SubmitHook) (RF_Cmd *pCmdNew, RF_Cmd *pCmdBg, RF_Cmd *pCmdFg, List_List *pPendQueue, List_List *pDoneQueue)

Handles the queue sorting algorithm when a new command is submitted to the driver from any of the active clients.

The function is invoked within the RF_scheduleCmd API.

The default algorithm is subscribed through the RFCC26XX_SchedulerPolicy::submitHook and implemented in the RF driver. The arguments are:

pCmdNew points to the command to be submitted.
pCmdBg is the running background command.
pCmdFg is the running foreground command.
pPendQueue points to the head structure of pend queue.
pDoneQueue points to the head structure of done queue.

In case the radio APIs do not distinguish between background and foreground contexts, the active operation will be returned within the pCmdBg pointer. If there are no commands being executed, both the pCmdBg and pCmdFg pointers are returned as NULL.

§ RF_ExecuteHook

typedef RF_ExecuteAction(* RF_ExecuteHook) (RF_Cmd *pCmdBg, RF_Cmd *pCmdFg, List_List *pPendQueue, List_List *pDoneQueue, bool bConflict, RF_Cmd *conflictCmd)

Defines the execution and conflict resolution hook at runtime.

The function is invoked before a scheduled command is about to be executed. If a conflict is identified before the start-time of the next radio command in the pending queue, this information is passed to the hook. The return value of type RF_ExecuteAction determines the policy to be followed by the RF driver.

The arguments are:

pCmdBg is the running background command.
pCmdFg is the running foreground command.
pPendQueue points to the head structure of pend queue.
pDoneQueue points to the head structure of done queue.
bConflict whether the incoming command conflicts with ongoing.
conflictCmd command that conflicts with ongoing.

Enumeration Type Documentation

§ RF_TxPowerTable_PAType

enum RF_TxPowerTable_PAType

Selects a power amplifier path in a TX power value.

RF_TxPowerTable_PAType selects one of the available power amplifiers on the RF core. It is usually included in a RF_TxPowerTable_Value.

Enumerator
RF_TxPowerTable_DefaultPA	Default PA.
RF_TxPowerTable_HighPA	High-power PA.

§ RF_Priority

enum RF_Priority

Scheduling priority of RF operation commands.

When multiple RF driver instances are used at the same time, commands from different clients may overlap. If an RF operation with a higher priority than the currently running operation is scheduled by RF_scheduleCmd(), then the running operation is interrupted.

In single-client applications, RF_PriorityNormal should be used.

Enumerator
RF_PriorityHighest	Highest priority. Only use this for urgent commands.
RF_PriorityHigh	High priority. Use this for time-critical commands in synchronous protocols.
RF_PriorityNormal	Default priority. Use this in single-client applications.

§ RF_PriorityCoex

enum RF_PriorityCoex

Priority level for coexistence priority signal.

When the RF driver is configured for three-wire coexistence mode, one of the output wires will signal the priority level of the coexistence request. When RF operations are scheduled with RF_scheduleCmd(), the scheduler can be configured to override the default coexistence priority level for the RF operation.

The coexistence priority level is binary because it translates to a high/low output signal.

Enumerator
RF_PriorityCoexDefault	Default priority. Use value configured by setup command.
RF_PriorityCoexLow	Low priority. Override default value configured by setup command.
RF_PriorityCoexHigh	High priority. Override default value configured by setup command.

§ RF_RequestCoex

enum RF_RequestCoex

Behavior for coexistence request signal.

When the RF driver is configured for three-wire coexistence mode, one of the output wires will signal the request level of the coexistence request. When RF operations are scheduled with RF_scheduleCmd(), the scheduler can be configured to override the default coexistence request line behavior for the RF operation in RX.

This override will be ignored if the option to set request for an entire chain is active.

Enumerator
RF_RequestCoexDefault	Default request line behavior. Use value configured by setup command.
RF_RequestCoexAssertRx	Assert REQUEST in RX. Override default value configured by setup command.
RF_RequestCoexNoAssertRx	Do not assert REQUEST in RX. Override default value configured by setup command.

§ RF_Stat

enum RF_Stat

Status codes for various RF driver functions.

RF_Stat is reported as return value for RF driver functions which execute direct and immediate commands. Such commands are executed by RF_runDirectCmd() and RF_runImmediateCmd() in the first place, but also by some convenience functions like RF_cancelCmd(), RF_flushCmd(), RF_getInfo() and others.

Enumerator
RF_StatBusyError	Command not executed because RF driver is busy.
RF_StatRadioInactiveError	Command not executed because RF core is powered down.
RF_StatCmdDoneError	Command finished with an error.
RF_StatInvalidParamsError	Function was called with an invalid parameter.
RF_StatCmdEnded	Cmd is found in the pool but was already ended.
RF_StatError	General error specifier.
RF_StatCmdDoneSuccess	Command finished with success.
RF_StatCmdSch	Command successfully scheduled for execution.
RF_StatSuccess	Function finished with success.

§ RF_ClientEvent

enum RF_ClientEvent

Client-related RF driver events.

Events originating in the RF driver but not directly related to a specific radio command, are called client events. Clients may subscribe to these events by specifying a callback function RF_Params::pClientEventCb. Events are activated by specifying a bitmask RF_Params::nClientEventMask. The callback is called separately for every event providing an optional argument.

void onClientEvent(RF_Handle h, RF_ClientEvent event, void* arg)
{
    switch (event)
    {
    case RF_ClientEventPowerUpFinished:
        // Set output port
        break;
    default:
        // Unsubscribed events must not be issued.
        assert(false);
    }
}
RF_Params params;
params.pClientEventCb = &onClientEvent;
params.nClientEventMask = RF_ClientEventPowerUpFinished;
RF_open(...);

Enumerator
RF_ClientEventPowerUpFinished	The RF core has been powered up the radio setup has been finished.
RF_ClientEventRadioFree	Radio becomes free after a command has been preempted by a high-priority command of another client. This event is only triggered on a client that has been preempted. Clients may use this event to retry running their low-priority RF operation.
RF_ClientEventSwitchClientEntered	Signals the client that the RF driver is about to switch over from another client.

§ RF_GlobalEvent

enum RF_GlobalEvent

Global RF driver events.

The RF driver provides an interface through the global RFCC26XX_hwAttrs struct to register a global, client independent callback. This callback is typically used to control board related configurations such as antenna switches.

void globalCallback(RF_Handle h, RF_GlobalEvent event, void* arg)
{
    switch (event)
    {
    case RF_GlobalEventRadioSetup:
    {
        RF_RadioSetup* setupCommand = (RF_RadioSetup*)arg;
        // Select antenna path
        if (setupCommand->common.commandNo == CMD_PROP_RADIO_DIV_SETUP) {
            // Sub-1 GHz ...
        } else {
            // 2.4 GHz ...
        }
    }
        break;
    case RF_GlobalEventRadioPowerDown:
        // Disable antenna switch
        break;
    default:
        // Unsubscribed events must not be issued.
        assert(false);
    }
}

For the coexistence (coex) feature, some of the events are used to handle the I/O muxing of the GPIO signals for REQUEST, PRIORITY and GRANT.

void globalCallback(RF_Handle h, RF_GlobalEvent event, void* arg)
{
    RF_Cmd* pCurrentCmd = (RF_Cmd*)arg;
    if (event & RF_GlobalEventInit) {
        // Initialize and mux coex I/O pins to RF Core I/O signals
    }
    else if (event & RF_GlobalEventCmdStart) {
        if (pCurrentCmd->coexPriority != RF_PriorityCoexDefault){
            // Release PRIORITY pin from RF Core and set it to value of coexPriority
        }
    }
    else if (event & RF_GlobalEventCmdStop) {
        if (pCurrentCmd->coexPriority != RF_PriorityCoexDefault) {
            // Mux PRIORITY pin to RF Core signal to return to default priority level
        }
    }
}

See also: RF_GlobalCallback

Enumerator
RF_GlobalEventRadioSetup	The RF core is being reconfigured through a setup command. The arg argument is a pointer to the setup command. HWI context.
RF_GlobalEventRadioPowerDown	The RF core is being powered down. The arg argument is empty. SWI context.
RF_GlobalEventInit	RF_open() is called for the first time (number of registered clients changes from 0 to 1). The arg argument is empty. Task context.
RF_GlobalEventCmdStart	A command chain is being dispatched to the radio. The arg argument is a pointer to the current command. HWI context.
RF_GlobalEventCmdStop	Command termination event is handled. The arg argument is a pointer to the current command. HWI context.
RF_GlobalEventCoexControl	Change to coex configuration is requested The arg argument is pointer to at least 8-bit wide int with value 1=enable, or 0=disable Task/HWI context.
RF_GlobalEventTempNotifyFail	Registration of temperature notification was unsuccessful (failure returned from temperature driver) The arg argument is empty. HWI context

§ RF_InfoType

enum RF_InfoType

Selects the entry of interest in RF_getInfo().

Enumerator
RF_GET_CURR_CMD	Retrieve a command handle of the current command.
RF_GET_AVAIL_RAT_CH	Create a bitmask showing available RAT channels.
RF_GET_RADIO_STATE	Show the current RF core power state. 0: Radio OFF, 1: Radio ON.
RF_GET_SCHEDULE_MAP	Deprecated. Not supported.
RF_GET_CLIENT_LIST	Provide the client list.
RF_GET_CLIENT_SWITCHING_TIME	Provide the client to client switching times.

§ RF_StartType

enum RF_StartType

Controls the behavior of the RF_scheduleCmd() API.

Enumerator
RF_StartNotSpecified
RF_StartAbs

§ RF_EndType

enum RF_EndType

Controls the behavior of the RF_scheduleCmd() API.

Enumerator
RF_EndNotSpecified
RF_EndAbs
RF_EndRel
RF_EndInfinit

§ RF_ExecuteAction

enum RF_ExecuteAction

Controls the behavior of the state machine of the RF driver when a conflict is identified run-time between the commands waiting on the pend queue and the commands being actively executed by the radio.

Enumerator
RF_ExecuteActionNone	Execute if no conflict, let current command finish if conflict.
RF_ExecuteActionRejectIncoming	Abort the incoming command, letting the ongoing command finish.
RF_ExecuteActionAbortOngoing	Abort the ongoing command and run dispatcher again.

§ RF_ScheduleStatus

enum RF_ScheduleStatus

Describes the location within the pend queue where the new command was inserted by the scheduler.

Enumerator
RF_ScheduleStatusError
RF_ScheduleStatusNone
RF_ScheduleStatusTop
RF_ScheduleStatusMiddle
RF_ScheduleStatusTail
RF_ScheduleStatusPreempt

§ RF_AllowDelay

enum RF_AllowDelay

Controls the behavior of the RF_scheduleCmd() API.

Enumerator
RF_AllowDelayNone
RF_AllowDelayAny

§ RF_RatSelectChannel

enum RF_RatSelectChannel

Select the preferred RAT channel through the configuration of RF_ratCompare() or RF_ratCapture().

If RF_RatChannelAny is provided within the channel configuration (default), the API will allocate the first available channel. Otherwise, it tries to allocate the requested channel, and if it is not available, returns with RF_ALLOC_ERROR.

Enumerator
RF_RatChannelAny	Chose the first available channel.
RF_RatChannel0	Use RAT user channel 0.
RF_RatChannel1	Use RAT user channel 1.
RF_RatChannel2	Use RAT user channel 2.

§ RF_RatCaptureSource

enum RF_RatCaptureSource

Selects the source signal for RF_ratCapture().

The source of a capture event can be selected through the source field of the RF_RatConfigCapture configuration structure.

Enumerator
RF_RatCaptureSourceRtcUpdate	Selects the RTC update signal source.
RF_RatCaptureSourceEventGeneric	Selects the Generic event of Event Fabric as source.
RF_RatCaptureSourceRfcGpi0	Selects the RFC_GPI[0] as source. This can be used i.e. to capture events on a GPIO. This requires that the GPIO is connected to RFC_GPO[0] from the GPIO driver.
RF_RatCaptureSourceRfcGpi1	Selects the RFC_GPO[1] as source. This can be used i.e. to capture events on a GPIO. This requires that the GPIO is connected to RFC_GPO[1] from the GPIO driver.

§ RF_RatCaptureMode

enum RF_RatCaptureMode

Selects the mode of RF_ratCapture().

The trigger mode of a capture event can be selected through the mode field of RF_RatConfigCapture configuration structure.

Enumerator
RF_RatCaptureModeRising	Rising edge of the selected source will trigger a capture event.
RF_RatCaptureModeFalling	Falling edge of the selected source will trigger a capture event.
RF_RatCaptureModeBoth	Both rising and falling edges of the selected source will generate capture events.

§ RF_RatCaptureRepetition

enum RF_RatCaptureRepetition

Selects the repetition of RF_ratCapture().

The configuration of a capture channel also defines whether the channel should be freed or automatically rearmed after a capture event occurred. In the latter case, the user needs to free the channel manually through the RF_ratDisableChannel() API.

Enumerator
RF_RatCaptureSingle	Free the channel after the first capture event.
RF_RatCaptureRepeat	Rearm the channel after each capture events.

§ RF_RatOutputMode

enum RF_RatOutputMode

Selects the mode of the RAT_GPO[x] for RF_ratCompare() or RF_ratCapture().

In case of compare mode, the channel can generate an output signal of the selected mode on the configured RAT_GPO[x] interface, and can be interconnected with other subsystems through the RFC_GPO[x] or Event Fabric. An example use case is to generate a pulse on a GPIO.

In case of capture mode, the channel can also generate an output signal of the selected mode on the configured RAT_GPO[x] interface. Note that the configuration of this output event is independent of the source signal of the capture event. An example use case is to generate a pulse on a GPIO on each raising edge of another GPIO source.

Enumerator
RF_RatOutputModePulse	Generates a one-clock period width pulse.
RF_RatOutputModeSet	Sets the output high on a RAT event.
RF_RatOutputModeClear	Sets the output low on a RAT event.
RF_RatOutputModeToggle	Inverts the polarity of the output.
RF_RatOutputModeAlwaysZero	Sets the output low independently of any RAT events.
RF_RatOutputModeAlwaysOne	Sets the output high independently of any RAT events.

§ RF_RatOutputSelect

enum RF_RatOutputSelect

Selects GPO to be used with RF_ratCompare() or RF_ratCapture().

RAT_GPO[0] - Reserved by the RF core. User shall not modify the configuration, but can observe the signal through any of RFC_GPO[0:3]. RAT_GPO[1] - Reserved by the RF core only if sync word detection is enabled. Otherwise can be used through RFC_GPO[0:3]. RAT_GPO[2:3] - Available and can be used through any of the RFC_GPO[0:3]. RAT_GPO[4:7] - Available and can be used through the Event fabric.

Enumerator
RF_RatOutputSelectRatGpo1	Configure RAT_CHANNEL[x] to interface with RAT_GPO[1].
RF_RatOutputSelectRatGpo2	Configure RAT_CHANNEL[x] to interface with RAT_GPO[2].
RF_RatOutputSelectRatGpo3	Configure RAT_CHANNEL[x] to interface with RAT_GPO[3].
RF_RatOutputSelectRatGpo4	Configure RAT_CHANNEL[x] to interface with RAT_GPO[4].
RF_RatOutputSelectRatGpo5	Configure RAT_CHANNEL[x] to interface with RAT_GPO[5].
RF_RatOutputSelectRatGpo6	Configure RAT_CHANNEL[x] to interface with RAT_GPO[6].
RF_RatOutputSelectRatGpo7	Configure RAT_CHANNEL[x] to interface with RAT_GPO[7].

Function Documentation

§ RF_open()

RF_Handle RF_open	(	RF_Object *	pObj,
		RF_Mode *	pRfMode,
		RF_RadioSetup *	pRadioSetup,
		RF_Params *	params
	)

Creates a a new client instance of the RF driver.

This function initializes an RF driver client instance using pObj as storage. It does not power up the RF core. Once the client starts the first RF operation command later in the application, the RF core is powered up and set into a PHY mode specified by pRfMode. The chosen PHY is then configured by a radio setup command pRadioSetup. Whenever the RF core is powered up, the RF driver re-executes the radio setup command pRadioSetup. Additional driver behavior may be set by an optional params.

// Define parameters
RF_Params rfParams;
rfParams.nInactivityTimeout = 4;
RF_Params_init(&rfParams);
rfParams.nInactivityTimeout = 1701; // microseconds
RF_Handle rfHandle = RF_open(&rfObject, &RF_prop, (RF_RadioSetup*)&RF_cmdPropRadioDivSetup, &rfParams);

Note: Calling context : Task

Parameters

pObj	Pointer to a RF_Object that will hold the state for this RF client. The object must be in persistent and writable memory.
pRfMode	Pointer to a RF_Mode struct holding PHY information
pRadioSetup	Pointer to the radio setup command used for this client. This is re-executed by the RF Driver on each power-up.
params	Pointer to an RF_Params object with the desired driver configuration. A NULL pointer results in the default configuration being loaded.

Returns: A handle for further RF driver calls on success. Otherwise NULL.

§ RF_close()

void RF_close ( RF_Handle h )

Close client connection to RF driver.

Allows a RF client (high-level driver or application) to close its connection to the RF driver. RF_close pends on all commands in the command queue before closing the connection. If a client has access to the radio by using RF_RequestAccess API, and the same client calls RF_close, then the connection to the RF driver is closed immediately without waiting for the access duration to be over.

Note: Calling context : Task

Parameters

h	Handle previously returned by RF_open()

§ RF_getCurrentTime()

uint32_t RF_getCurrentTime ( void )

Return current radio timer value.

If the radio is powered returns the current radio timer value, if not returns a conservative estimate of the current radio timer value

Note: Calling context : Task/SWI/HWI

Returns: Current radio timer value

§ RF_postCmd()

RF_CmdHandle RF_postCmd	(	RF_Handle	h,
		RF_Op *	pOp,
		RF_Priority	ePri,
		RF_Callback	pCb,
		RF_EventMask	bmEvent
	)

Appends RF operation commands to the driver's command queue and returns a command handle.

The RF operation pOp may either represent a single operation or may be the first operation in a chain. If the command queue is empty, the pCmd is dispatched immediately. If there are other operations pending, then pCmd is processed after all other commands have been finished. The RF operation command must be compatible to the RF_Mode selected by RF_open(), e.g. proprietary commands can only be used when the RF core is configured for proprietary mode.

The returned command handle is an identifier that can be used to control command execution later on, for instance with RF_pendCmd() or RF_cancelCmd(). It is a 16 Bit signed integer value, incremented on every new command. If the RF driver runs out of command containers, RF_ALLOC_ERROR is returned.

The priority ePri is only relevant in multi-client applications where commands of distinct clients may interrupt each other. Only commands started by RF_scheduleCmd() can preempt running commands. RF_postCmd() or RF_runCmd() do never interrupt a running command. In single-client applications, ePri is ignored and should be set to RF_PriorityNormal.

A callback function pCb might be specified to get notified about events during command execution. Events are subscribed by the bit mask bmEvent. Valid event flags are specified in RF_Core_Events and RF_Driver_Events. If no callback is set, RF_pendCmd() can be used to synchronize the current task to command execution. For this it is necessary to subscribe all relevant events. The termination events RF_EventLastCmdDone, RF_EventCmdCancelled, RF_EventCmdAborted and RF_EventCmdStopped are always implicitly subscribed.

The following limitations apply to the execution of command chains:

If TRIG_ABSTIME is used as a start trigger for the first command, TRIG_REL_FIRST_START can not be used for any other command. This is because the RF driver may insert a frequency-select command (CMD_FS) at the front of the chain when it performs an automatic power-up.
If a command chain has more than one CMD_FS, the first CMD_FS in the chain is cached. This CMD_FS is used on the next automatic power-up.
To avoid execution of cached CMD_FS and directly use a new CMD_FS on power up, place CMD_FS at the head of the command chain.

Note: Calling context : Task/SWI

See also: RF_pendCmd(), RF_runCmd(), RF_scheduleCmd(), RF_RF_cancelCmd(), RF_flushCmd(), RF_getCmdOp()

Parameters

h	Driver handle previously returned by RF_open()
pOp	Pointer to the RF operation command.
ePri	Priority of this RF command (used for arbitration in multi-client systems)
pCb	Callback function called during command execution and upon completion. If RF_postCmd() fails, no callback is made.
bmEvent	Bitmask of events that will trigger the callback or that can be pended on.

Returns: A handle to the RF command. Return value of RF_ALLOC_ERROR indicates error.

§ RF_defaultSubmitPolicy()

RF_ScheduleStatus RF_defaultSubmitPolicy	(	RF_Cmd *	pCmdNew,
		RF_Cmd *	pCmdBg,
		RF_Cmd *	pCmdFg,
		List_List *	pPendQueue,
		List_List *	pDoneQueue
	)

Sorts and adds commands to the RF driver internal command queue.

Parameters

pCmdNew	Pointer to the command to be submitted.
pCmdBg	Running background command.
pCmdFg	Running foreground command.
pPendQueue	Pointer to the head structure of pend queue.
pDoneQueue	Pointer to the head structure of done queue..

Returns: RF_defaultSubmitPolicy identifies the success or failure of queuing.

§ RF_defaultExecutionPolicy()

RF_ExecuteAction RF_defaultExecutionPolicy	(	RF_Cmd *	pCmdBg,
		RF_Cmd *	pCmdFg,
		List_List *	pPendQueue,
		List_List *	pDoneQueue,
		bool	bConflict,
		RF_Cmd *	conflictCmd
	)

Makes a final decision before dispatching a scheduled command.

Parameters

pCmdBg	Running background command.
pCmdFg	Running foreground command.
pPendQueue	Pointer to the head structure of pend queue.
pDoneQueue	Pointer to the head structure of done queue.
bConflict	Whether the incoming command conflicts with the ongoing.
conflictCmd	Command that conflicts with ongoing.

Returns: RF_defaultSubmitPolicy identifies the success or failure of queuing.

§ RF_ScheduleCmdParams_init()

void RF_ScheduleCmdParams_init ( RF_ScheduleCmdParams * pSchParams )

Initialize the configuration structure to default values to be used with the RF_scheduleCmd() API.

Note: Calling context : Task/SWI/HWI

Parameters

pSchParams Pointer to the configuration structure.

Returns: none

§ RF_scheduleCmd()

RF_CmdHandle RF_scheduleCmd	(	RF_Handle	h,
		RF_Op *	pOp,
		RF_ScheduleCmdParams *	pSchParams,
		RF_Callback	pCb,
		RF_EventMask	bmEvent
	)

Schedule an RF operation (chain) to the command queue.

Schedule an RF_Op to the RF command queue of the client with handle h.
The command can be the first in a chain of RF operations or a standalone RF operation. If a chain of operations are posted they are treated atomically, i.e. either all or none of the chained operations are run.
All operations must be posted in strictly increasing chronological order. Function returns immediately.

Limitations apply to the operations posted:

The operation must be in the set supported in the chosen radio mode when RF_open() was called
Only a subset of radio operations are supported
Only some of the trigger modes are supported with potential power saving (TRIG_NOW, TRIG_ABSTIME)

Note: Calling context : Task/SWI

Parameters

h	Handle previously returned by RF_open()
pOp	Pointer to the RF_Op. Must normally be in persistent and writable memory
pSchParams	Pointer to the schedule command parameter structure
pCb	Callback function called upon command completion (and some other events). If RF_scheduleCmd() fails no callback is made
bmEvent	Bitmask of events that will trigger the callback.

Returns: A handle to the RF command. Return value of RF_ALLOC_ERROR indicates error.

§ RF_pendCmd()

RF_EventMask RF_pendCmd	(	RF_Handle	h,
		RF_CmdHandle	ch,
		RF_EventMask	bmEvent
	)

Synchronizes the calling task to an RF operation command ch and returns accumulated event flags.

After having dispatched an RF operation represented by ch with RF_postCmd(), the command is running in parallel on the RF core. Thus, it might be desirable to synchronize the calling task to the execution of the command. With RF_pendCmd(), the application can block until one of the events specified in bmEvent occurs or until the command finishes. The function consumes and returns all accumulated event flags that occurred during execution if they have been previously subscribed by RF_postCmd(). Possible events are specified in RF_Core_Events and RF_Driver_Events. The termination events RF_EventLastCmdDone, RF_EventCmdCancelled, RF_EventCmdAborted and RF_EventCmdStopped are always implicitly subscribed and can not be masked.

RF_pendCmd() may be called multiple times for the same command.

If RF_pendCmd() is called for a command handle representing a finished command, then only the RF_EventLastCmdDone flag is returned, regardless of how the command finished.

If the command has also a callback set, the callback is executed before RF_pendCmd() returns.

Example:

// Dispatch a command to the RF driver's command queue
RF_CmdHandle ch = RF_postCmd(driver, (RF_Op*)&CMD_PROP_RX, RF_PriorityNormal, NULL, RF_EventRxEntryDone);
assert(ch != RF_ALLOC_ERROR);
bool finished = false;
while (finished == false)
{
    // Synchronize to events during command execution.
    uint32_t events = RF_pendCmd(driver, ch, RF_EventRxEntryDone);
    // Check events that happen during execution
    if (events & RF_EventRxEntryDone)
    {
        // Process packet
    }
    if (events & (RF_EventLastCmdDone | RF_EventCmdStopped | RF_EventCmdAborted | RF_EventCmdCancelled))
    {
        finished = true;
    }
    // ...
}

Note: Calling context : Task

Parameters

h	Driver handle previously returned by RF_open()
ch	Command handle previously returned by RF_postCmd().
bmEvent	Bitmask of events that make RF_pendCmd() return. Termination events are always implicitly subscribed.

Returns: Event flags accumulated during command execution.

See also: RF_postCmd()

§ RF_runCmd()

RF_EventMask RF_runCmd	(	RF_Handle	h,
		RF_Op *	pOp,
		RF_Priority	ePri,
		RF_Callback	pCb,
		RF_EventMask	bmEvent
	)

Runs synchronously an RF operation command or a chain of commands and returns the termination reason.

This function appends an RF operation command or a chain of commands to the RF driver's command queue and then waits for it to complete. A command is completed if one of the termination events RF_EventLastCmdDone, RF_EventCmdCancelled, RF_EventCmdAborted, RF_EventCmdStopped occurred.

This function is a combination of RF_postCmd() and RF_pendCmd(). All options and limitations for RF_postCmd() apply here as well.

An application should always ensure that the command completed in the expected way and with an expected status code.

Note: Calling context : Task

Parameters

h	Driver handle previously returned by RF_open()
pOp	Pointer to the RF operation command.
ePri	Priority of this RF command (used for arbitration in multi-client systems)
pCb	Callback function called during command execution and upon completion. If RF_runCmd() fails, no callback is made.
bmEvent	Bitmask of events that will trigger the callback or that can be pended on.

Returns: The relevant termination event.

See also: RF_postCmd(), RF_pendCmd(), RF_cancelCmd(), RF_flushCmd()

§ RF_runScheduleCmd()

RF_EventMask RF_runScheduleCmd	(	RF_Handle	h,
		RF_Op *	pOp,
		RF_ScheduleCmdParams *	pSchParams,
		RF_Callback	pCb,
		RF_EventMask	bmEvent
	)

Runs synchronously a (chain of) RF operation(s) for dual or single-mode.

Allows a (chain of) operation(s) to be scheduled to the command queue and then waits for it to complete.
A command is completed if one of the RF_EventLastCmdDone, RF_EventCmdCancelled, RF_EventCmdAborted, RF_EventCmdStopped occurred.

Note: Calling context : Task; Only one call to RF_pendCmd() or RF_runScheduleCmd() can be made at a time for each client

Parameters

h	Handle previously returned by RF_open()
pOp	Pointer to the RF_Op. Must normally be in persistent and writable memory
pSchParams	Pointer to the schedule command parameter structure
pCb	Callback function called upon command completion (and some other events). If RF_runScheduleCmd() fails, no callback is made.
bmEvent	Bitmask of events that will trigger the callback.

Returns: The relevant command completed event.

§ RF_cancelCmd()

RF_Stat RF_cancelCmd	(	RF_Handle	h,
		RF_CmdHandle	ch,
		uint8_t	mode
	)

Abort/stop/cancel single command in command queue.

If command is running, aborts/stops it and posts callback for the aborted/stopped command.
If command has not yet run, cancels it it and posts callback for the canceled command.
If command has already run or been aborted/stopped/canceled, has no effect.
If RF_cancelCmd is called from a Swi context with same or higher priority than RF Driver Swi, when the RF core is powered OFF -> the cancel callback will be delayed until the next power-up cycle.

Note: Calling context : Task/SWI

Parameters

h	Handle previously returned by RF_open()
ch	Command handle previously returned by RF_postCmd().
mode	1: Stop gracefully, 0: abort abruptly

Returns: RF_Stat indicates if command was successfully completed

§ RF_flushCmd()

RF_Stat RF_flushCmd	(	RF_Handle	h,
		RF_CmdHandle	ch,
		uint8_t	mode
	)

Abort/stop/cancel command and any subsequent commands in command queue.

If command is running, aborts/stops it and then cancels all later commands in queue.
If command has not yet run, cancels it and all later commands in queue.
If command has already run or been aborted/stopped/canceled, has no effect.
The callbacks for all canceled commands are issued in chronological order.
If RF_flushCmd is called from a Swi context with same or higher priority than RF Driver Swi, when the RF core is powered OFF -> the cancel callback will be delayed until the next power-up cycle.

Note: Calling context : Task/SWI

Parameters

h	Handle previously returned by RF_open()
ch	Command handle previously returned by RF_postCmd().
mode	1: Stop gracefully, 0: abort abruptly

Returns: RF_Stat indicates if command was successfully completed

§ RF_runImmediateCmd()

RF_Stat RF_runImmediateCmd	(	RF_Handle	h,
		uint32_t *	pCmdStruct
	)

Send any Immediate command.

Immediate Command is send to RDBELL, if radio is active and the RF_Handle points to the current client.
In other appropriate RF_Stat values are returned.

Note: Calling context : Task/SWI/HWI

Parameters

h	Handle previously returned by RF_open()
pCmdStruct	Pointer to the immediate command structure

Returns: RF_Stat indicates if command was successfully completed

§ RF_runDirectCmd()

RF_Stat RF_runDirectCmd	(	RF_Handle	h,
		uint32_t	cmd
	)

Send any Direct command.

Direct Command value is send to RDBELL immediately, if radio is active and the RF_Handle point to the current client.
In other appropriate RF_Stat values are returned.

Note: Calling context : Task/SWI/HWI

Parameters

h	Handle previously returned by RF_open()
cmd	Direct command value.

Returns: RF_Stat indicates if command was successfully completed.

§ RF_yield()

void RF_yield ( RF_Handle h )

Signal that radio client is not going to issue more commands in a while.

Hint to RF driver that, irrespective of inactivity timeout, no new further commands will be issued for a while and thus the radio can be powered down at the earliest convenience. In case the RF_yield() is called within a callback, the callback will need to finish and return before the power down sequence is initiated. Posting new commands to the queue will cancel any pending RF_yield() request.

Note: Calling context : Task

Parameters

h	Handle previously returned by RF_open()

§ RF_Params_init()

void RF_Params_init ( RF_Params * params )

Function to initialize the RF_Params struct to its defaults.

Parameters

params An pointer to RF_Params structure for initialization

Defaults values are: nInactivityTimeout = BIOS_WAIT_FOREVER nPowerUpDuration = RF_DEFAULT_POWER_UP_TIME

§ RF_getInfo()

RF_Stat RF_getInfo	(	RF_Handle	h,
		RF_InfoType	type,
		RF_InfoVal *	pValue
	)

Get value for some RF driver parameters.

Note: Calling context : Task/SWI/HWI

Parameters

h	Handle previously returned by RF_open()
type	Request value parameter defined by RF_InfoType
pValue	Pointer to return parameter values specified by RF_InfoVal

Returns: RF_Stat indicates if command was successfully completed

§ RF_getRssi()

int8_t RF_getRssi ( RF_Handle h )

Get RSSI value.

Note: Calling context : Task/SWI/HWI

Parameters

h	Handle previously returned by RF_open()

Returns: RSSI value. Return value of RF_GET_RSSI_ERROR_VAL indicates error case.

§ RF_getCmdOp()

RF_Op* RF_getCmdOp	(	RF_Handle	h,
		RF_CmdHandle	cmdHnd
	)

Get command structure pointer.

Note: Calling context : Task/SWI/HWI

Parameters

h	Handle previously returned by RF_open()
cmdHnd	Command handle returned by RF_postCmd()

Returns: Pointer to the command structure.

§ RF_RatConfigCompare_init()

void RF_RatConfigCompare_init ( RF_RatConfigCompare * channelConfig )

Initialize the configuration structure to be used to set up a RAT compare event.

Note: Calling context : Task/SWI/HWI

Parameters

channelConfig Pointer to the compare configuration structure.

Returns: none

§ RF_RatConfigCapture_init()

void RF_RatConfigCapture_init ( RF_RatConfigCapture * channelConfig )

Initialize the configuration structure to be used to set up a RAT capture event.

Note: Calling context : Task/SWI/HWI

Parameters

channelConfig Pointer to the capture configuration structure.

Returns: none

§ RF_RatConfigOutput_init()

void RF_RatConfigOutput_init ( RF_RatConfigOutput * ioConfig )

Initialize the configuration structure to be used to set up a RAT IO.

Note: Calling context : Task/SWI/HWI

Parameters

ioConfig Pointer to the IO configuration structure.

Returns: none

§ RF_ratCompare()

RF_RatHandle RF_ratCompare	(	RF_Handle	rfHandle,
		RF_RatConfigCompare *	channelConfig,
		RF_RatConfigOutput *	ioConfig
	)

Setup a Radio Timer (RAT) channel in compare mode.

The RF_ratCompare() API sets up one of the three available RAT channels in compare mode. When the compare event happens at the given compare time, the registered callback is invoked.

The RF driver handles power management. If the provided compare time is far into the future (and there is no other constraint set i.e. due to radio command execution), the RF core will be powered OFF and the device will enter the lowest possible power state. The RF core will be automatically powered ON just before the registered compare event. The callback function is served upon expiration of the allocated channel. The function is invoked with event type RF_EventRatCh and runs in SWI context.

The API generates a "one-shot" compare event. Since the channel is automatically freed before the callback is served, the same channel can be reallocated from the callback itself through a new API call.

In case there were no available channels at the time of API call, the function returns with RF_ALLOC_ERROR and no callback is invoked.

In case a runtime error occurs after the API successfully allocated a channel, the registered callback is invoked with event type RF_EventError. A typical example is when the provided compare time is in the past and rejected by the RF core itself.

The events issued by the RAT timer can be output from the timer module through the RAT_GPO interface, and can be interconnected with other parts of the system through the RFC_GPO or the Event Fabric. The mapping between the allocated RAT channel and the selected RAT_GPO can be controlled through the optional ioConfig argument of RF_ratCompare(). The possible RAT_GPO[x] are defined in RF_RatOutputSelect.

Note: Calling context : Task/SWI

Parameters

rfHandle	Handle previously returned by RF_open().
channelConfig	Pointer to configuration structure needed to set up a channel in compare mode.
ioConfig	Pointer to a configuration structure to set up the RAT_GPOs for the allocated channel (optional).

Returns: Allocated RAT channel. If allocation fails, RF_ALLOC_ERROR is returned.

See also: RF_RatConfigCompare_init(), RF_RatConfigOutput_init(), RF_ratDisableChannel(), RF_ratCapture()

§ RF_ratCapture()

RF_RatHandle RF_ratCapture	(	RF_Handle	rfHandle,
		RF_RatConfigCapture *	channelConfig,
		RF_RatConfigOutput *	ioConfig
	)

Setup a Radio Timer (RAT) channel in capture mode.

The RF_ratCapture() API sets up one of the three available RAT channels in capture mode. The registered callback is invoked on the capture event.

The RF driver handles power management. If the RF core is OFF when the RF_ratCapture() is called, it will be powered ON immediately and the RAT channel will be configured to capture mode. As long as at least one of the three RAT channels are in capture mode, the RF core will be kept ON. The callback function is served upon a capture event occurs. The function is invoked with event type RF_EventRatCh and runs in SWI context.

In case the channel is configured into single capture mode, the channel is automatically freed before the callback is called. In repeated capture mode, the channel remains allocated and automatically rearmed.

In case there were no available channels at the time of API call, the function returns with RF_ALLOC_ERROR and no callback is invoked.

In case a runtime error occurs after the API successfully allocated a channel, the registered callback is invoked with event type RF_EventError. A typical example is when the provided compare time is in the past and rejected by the RF core itself.

The events issued by the RAT timer can be output from the timer module through the RAT_GPO interface, and can be interconnected with other parts of the system through the RFC_GPO or the Event Fabric. The mapping between the allocated RAT channel and the selected RAT_GPO can be controlled through the optional ioConfig argument of RF_ratCapture(). The possible RAT_GPO[x] are defined in RF_RatOutputSelect. Note that this configuration is independent of the source signal of the capture event.

Note: Calling context : Task/SWI

Parameters

rfHandle	Handle previously returned by RF_open().
channelConfig	Pointer to configuration structure needed to set up a channel in compare mode.
ioConfig	Pointer to a configuration structure to set up the RAT_GPO for the allocated channel (optional).

Returns: Allocated RAT channel. If allocation fails, RF_ALLOC_ERROR is returned.

See also: RF_RatConfigCapture_init(), RF_RatConfigOutput_init() , RF_ratDisableChannel(), RF_ratCompare()

§ RF_ratDisableChannel()

RF_Stat RF_ratDisableChannel	(	RF_Handle	rfHandle,
		RF_RatHandle	ratHandle
	)

Disable a RAT channel.

The RF_RatHandle returned by the RF_ratCompare() or RF_ratCapture() APIs can be used for further interaction with the Radio Timer. Passing the handle to RF_ratDisableChannel() will abort a compare/capture event, and the provided channel is deallocated. No callback is invoked. This API can be called both if the RF core is ON or OFF. After the channel is freed, the next radio event will be rescheduled. A typical use case if a channel is configured in repeated capture mode, and the application decides to abort this operation.

Note: Calling context : Task/SWI

Parameters

rfHandle	Handle previously returned by RF_open().
ratHandle	RF_RatHandle returned by RF_ratCompare() or RF_ratCapture().

Returns: RF_Stat indicates if command was successfully completed.

See also: RF_ratCompare(), RF_ratCapture()

§ RF_control()

RF_Stat RF_control	(	RF_Handle	h,
		int8_t	ctrl,
		void *	args
	)

Set RF control parameters.

Note: Calling context : Task

Parameters

h	Handle previously returned by RF_open()
ctrl	Control codes
args	Pointer to control arguments

Returns: RF_Stat indicates if API call was successfully completed.

§ RF_requestAccess()

RF_Stat RF_requestAccess	(	RF_Handle	h,
		RF_AccessParams *	pParams
	)

Request radio access.

Scope:

Only supports request access which start immediately.
The RF_AccessParams duration should be less than a pre-defined value RF_REQ_ACCESS_MAX_DUR_US in RFCC26X2_multiMode.c.
The RF_AccessParams priority should be set RF_PriorityHighest.
Single request for a client at anytime.
Command from different client are blocked until the radio access period is completed.

Note: Calling context : Task

Parameters

h	Handle previously returned by RF_open()
pParams	Pointer to RF_AccessRequest parameters

Returns: RF_Stat indicates if API call was successfully completed.

§ RF_getTxPower()

RF_TxPowerTable_Value RF_getTxPower ( RF_Handle h )

Returns the currently configured transmit power configuration.

This function returns the currently configured transmit power configuration under the assumption that it has been previously set by RF_setTxPower(). The value might be used for reverse lookup in a TX power table. If no power has been programmed, it returns an invalid value.

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

Parameters

h	Handle previously returned by RF_open()

Returns: PA configuration struct

See also: RF_setTxPower(), RF_TxPowerTable_findPowerLevel()

§ RF_setTxPower()

RF_Stat RF_setTxPower	(	RF_Handle	h,
		RF_TxPowerTable_Value	value
	)

Updates the transmit power configuration of the RF core.

This function programs a new TX power value and returns a status code. The API will return with RF_StatBusyError if there are still pending commands in the internal queue. In case of success, RF_StatSuccess is returned and the new configuration becomes effective from the next radio operation.

Some devices provide an integrated high-power PA in addition to the Default PA. On these devices the API accepts configurations for both, and if value selects a different PA, the globalCallback is invoked. The implementation of globalCallback is board specific and can be used to reconfigure the external RF switches (if any).

Parameters

h	Handle previously returned by RF_open()
value	TX power configuration value.

Returns: RF_StatSuccess on success, otherwise an error code.

See also: RF_getTxPower(), RF_TxPowerTable_Value, RF_TxPowerTable_findValue()

§ RF_TxPowerTable_findPowerLevel()

int8_t RF_TxPowerTable_findPowerLevel	(	RF_TxPowerTable_Entry	table[],
		RF_TxPowerTable_Value	value
	)

Retrieves a power level in dBm for a given power configuration value.

RF_TxPowerTable_findPowerLevel() searches in a lookup table for a given transmit power configuration value and returns the power level in dBm if a matching configuration is found. If value can not be found, RF_TxPowerTable_INVALID_DBM is returned.

This function does a reverse lookup compared to RF_TxPowerTable_findValue() and has O(n). It is assumed that table is terminated by a RF_TxPowerTable_TERMINATION_ENTRY.

Parameters

table	List of RF_TxPowerTable_Entry entries, terminated by RF_TxPowerTable_TERMINATION_ENTRY.
value	Power configuration value.

Returns: Human readable power level in dBm on success, otherwise RF_TxPowerTable_INVALID_DBM.

§ RF_TxPowerTable_findValue()

RF_TxPowerTable_Value RF_TxPowerTable_findValue	(	RF_TxPowerTable_Entry	table[],
		int8_t	powerLevel
	)

Retrieves a power configuration value for a given power level in dBm.

RF_TxPowerTable_findValue() searches in a lookup table for a given transmit power level powerLevel in dBm and returns a matching power configuration. If powerLevel can not be found, RF_TxPowerTable_INVALID_VALUE is returned.

This function performs a linear search in table and has O(n). It is assumed that table is defined in ascending order and is terminated by a RF_TxPowerTable_TERMINATION_ENTRY.

The following special values for powerLevel are also accepted:

RF_TxPowerTable_MIN_DBM which returns always the lowest power value in the table
RF_TxPowerTable_MAX_DBM which returns always the highest power value in the table

Parameters

table	List of RF_TxPowerTable_Entry entries, terminated by RF_TxPowerTable_TERMINATION_ENTRY.
powerLevel	Human-readable power level in dBm.

Returns: PA configuration value on success. otherwise RF_TxPowerTable_INVALID_VALUE.

§ RF_enableHPOSCTemperatureCompensation()

RF_Stat RF_enableHPOSCTemperatureCompensation ( void )

Enables temperature monitoring and temperature based drift compensation.

Returns: RF_StatSuccess if succesful or RF_StatInvalidParamsError if temperature notification fails to register.

Modules

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

§ RF_Op

§ RF_EventMask

§ RF_ClientEventMask

§ RF_GlobalEventMask

§ RF_CmdHandle

§ RF_Handle

§ RF_RatHandle

§ RF_Callback

§ RF_RatCallback

§ RF_ClientCallback

§ RF_GlobalCallback

§ RF_Cmd

§ RF_SubmitHook

§ RF_ExecuteHook

Enumeration Type Documentation

§ RF_TxPowerTable_PAType

§ RF_Priority

§ RF_PriorityCoex

§ RF_RequestCoex

§ RF_Stat

§ RF_ClientEvent

§ RF_GlobalEvent

§ RF_InfoType

§ RF_StartType

§ RF_EndType

§ RF_ExecuteAction

§ RF_ScheduleStatus

§ RF_AllowDelay

§ RF_RatSelectChannel

§ RF_RatCaptureSource

§ RF_RatCaptureMode

§ RF_RatCaptureRepetition

§ RF_RatOutputMode

§ RF_RatOutputSelect

Function Documentation

§ RF_open()

§ RF_close()

§ RF_getCurrentTime()

§ RF_postCmd()

§ RF_defaultSubmitPolicy()

§ RF_defaultExecutionPolicy()

§ RF_ScheduleCmdParams_init()

§ RF_scheduleCmd()

§ RF_pendCmd()

§ RF_runCmd()

§ RF_runScheduleCmd()

§ RF_cancelCmd()

§ RF_flushCmd()

§ RF_runImmediateCmd()

§ RF_runDirectCmd()

§ RF_yield()

§ RF_Params_init()

§ RF_getInfo()

§ RF_getRssi()

§ RF_getCmdOp()

§ RF_RatConfigCompare_init()

§ RF_RatConfigCapture_init()

§ RF_RatConfigOutput_init()

§ RF_ratCompare()

§ RF_ratCapture()

§ RF_ratDisableChannel()

§ RF_control()

§ RF_requestAccess()

§ RF_getTxPower()

§ RF_setTxPower()

§ RF_TxPowerTable_findPowerLevel()

§ RF_TxPowerTable_findValue()

§ RF_enableHPOSCTemperatureCompensation()