Macros
RF_CTRL

Macros

#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_RAT_RTC_ERR_TOL_VAL   3
 Control code used by RF_control to set max error tolerence for RAT/RTC. More...
 
#define RF_CTRL_SET_POWER_MGMT   4
 Control code used by RF_control to set power management. More...
 
#define RF_CTRL_SET_HWI_PRIORITY   5
 Control code used by RF_control to set the hardware interrupt priority level of the RF driver. More...
 
#define RF_CTRL_SET_SWI_PRIORITY   6
 Control code used by RF_control to set the software interrupt priority level of the RF driver. More...
 

Detailed Description

RF_CTRL_* macros are control codes defined in the RF.h driver implementation and need to:

Macro Definition Documentation

§ 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_RAT_RTC_ERR_TOL_VAL

#define RF_CTRL_SET_RAT_RTC_ERR_TOL_VAL   3

Control code used by RF_control to set max error tolerence 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   4

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   5

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   6

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);
Copyright 2017, Texas Instruments Incorporated