Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
st_ble_vs_set_rf_ctrl_param_t Struct Reference

This is the RF parameters used in R_BLE_VS_SetRfControl() . More...

Data Fields

uint8_t power
 RF power on/off. More...
 
uint8_t option
 This field indicates whether the parameters change in RF power on. More...
 
uint8_t clval
 RF rapid clock frequency adjust value(OSC internal CL adjust). More...
 
uint8_t slow_clock
 RF slow clock configurations. More...
 
uint8_t tx_power
 Set tx power in power on. More...
 
uint8_t rf_option
 Set RF option. More...
 

Detailed Description

This is the RF parameters used in R_BLE_VS_SetRfControl() .

Field Documentation

◆ power

uint8_t st_ble_vs_set_rf_ctrl_param_t::power

RF power on/off.

Select one of the following.

macro description
BLE_VS_RF_OFF(0x00) RF power off. If this value is selected, other fields are ignored.
BLE_VS_RF_ON(0x01) RF power on.

◆ option

uint8_t st_ble_vs_set_rf_ctrl_param_t::option

This field indicates whether the parameters change in RF power on.

macro description
BLE_VS_RF_INIT_PARAM_NOT_CHG(0x00) The parameters are not changed in RF power on. If this value is selected, all subsequent fields are ignored.
BLE_VS_RF_INIT_PARAM_CHG(0x01) The parameters are changed in RF power on.

◆ clval

uint8_t st_ble_vs_set_rf_ctrl_param_t::clval

RF rapid clock frequency adjust value(OSC internal CL adjust).

The valid range is 0x00-0x0F. All other values are reserved.

◆ slow_clock

uint8_t st_ble_vs_set_rf_ctrl_param_t::slow_clock

RF slow clock configurations.

bit description
bit0 RF slow clock.
value description
0 RF internal low oscillator(RF_LOCO).
1 Use external low CLK.
bit1 Select MCU CLKOUT output frequency when external input is selected.
value description
0 32.768kHz
1 16.384kHz
bit2 Select MCU CLKOUT output port when external input is selected.
value description
0 PE3
1 PE4
bit3 Reserved for future use.
bit6-4 Sleep Clock Accuracy(SCA). This parameter depends on the RF slow clock configuration(bit0).
value RF slow clock(bit0)
External low CLK(1) RF internal low oscillator(0)
0 251 - 500 ppm 251 - 500 ppm
1 151 - 250 ppm 151 - 250 ppm
2 101 - 150 ppm
3 76 - 100 ppm
4 51 - 75 ppm
5 31 - 50 ppm
6 21 - 30 ppm
7 0 - 20 ppm
bit7 Reserved for future use.

◆ tx_power

uint8_t st_ble_vs_set_rf_ctrl_param_t::tx_power

Set tx power in power on.

Select one of the following.

macro description
BLE_VS_TX_POWER_HIGH(0x00) High
BLE_VS_TX_POWER_MID(0x01) Middle
BLE_VS_TX_POWER_LOW(0x02) Low

◆ rf_option

uint8_t st_ble_vs_set_rf_ctrl_param_t::rf_option

Set RF option.

It is a bitwise OR of the following values.

bit description
bit0 RF DC-DC converter.
value description
0 Not used(LDO mode)
1 Use DC-DC converter.
bit1 Select maximum tx power.
value description
0 max 0dBm
1 max +4dBm
Other than the above Reserved for future use.