sdc_hci_cmd_vs_zephyr_write_tx_power()

uint8_t sdc_hci_cmd_vs_zephyr_write_tx_power	(	const sdc_hci_cmd_vs_zephyr_write_tx_power_t *	p_params,
		sdc_hci_cmd_vs_zephyr_write_tx_power_return_t *	p_return )

#include <softdevice_controller/include/sdc_hci_vs.h>

Zephyr Write Tx Power Level (per Role/Connection).

This command dynamically modifies Bluetooth LE Tx power level at the antenna given a handle and a handle type.

The Tx power of the Bluetooth LE radio interface is modified for any low-level link by the controller with a high degree of flexibility. The Bluetooth LE link whose power is set is identified based on a handle type and handle pair.

The role/state defining input parameter is the Handle_Type, whereas its corresponding handle is provided by the Handle input parameter. Note that for Advertisements, the Handle input parameter is ignored in the case that Advertising Extensions are not configured, whereas Advertising Sets are to be identified by their corresponding Handle in case Advertising Extensions are enabled.

The desired transmitter power level for the selected link instance is inputted as Tx_Power_Level. This value represents the actual power level fed to the antenna. When a Front-End Module is used, gain values for the SoC and FEM are calculated automatically to guarantee closest possible match to the value requested by the user at the RF output. The power setup and control can be performed dynamically without the need of restarting the advertiser and scanner role/states. In case of connections, the Tx power changes take effect only if the connections are in a connected state.

The inputs Handle_Type and Handle are passed through as outputs to aid the asynchronous service of the command as well. In addition, the command returns also with the Selected_Tx_Power by the controller which addresses and corrects the possible mismatches between the desired Tx_Power_Level and the achievable Tx powers given each individual controller capabilities.

Event(s) generated (unless masked away): When the command has completed, an HCI_Command_Complete event shall be generated.

Parameters

[in]	p_params	Input parameters.
[out]	p_return	Extra return parameters.

Return values

0	if success.

Returns

Returns value between 0x01-0xFF in case of error. See Vol 2, Part D, Error for a list of error codes and descriptions.