nrfxlib API 2.7.99
Loading...
Searching...
No Matches

◆ sdc_hci_cmd_le_cs_set_default_settings()

uint8_t sdc_hci_cmd_le_cs_set_default_settings ( const sdc_hci_cmd_le_cs_set_default_settings_t p_params,
sdc_hci_cmd_le_cs_set_default_settings_return_t p_return 
)

#include <softdevice_controller/include/sdc_hci_cmd_le.h>

LE CS Set Default Settings.

The description below is extracted from Core_v6.0, Vol 4, Part E, Section 7.8.134

The HCI_LE_CS_Set_Default_Settings command is used by a Host to set default CS settings in the local Controller for the connection identified by the Connection_Handle parameter. The default settings specify that all roles are disabled in a Controller and CS_SYNC_Antenna_Selection is set to 0x01.

The Role_Enable parameter is used to enable or disable the CS roles in the local Controller. If the Host issues this command to disable a Role for which a valid CS configuration is present, then the Controller shall return the error code Invalid HCI Command Parameters (0x12).

The CS_SYNC_Antenna_Selection parameter indicates the antenna identifier to be used for transmitting and receiving CS_SYNC packets.

If the Role_Enable parameter is used to enable an unsupported role or the CS_SYNC_Antenna_Selection parameter indicates an unsupported antenna identifier, then the Controller shall return the error code Unsupported Feature or Parameter Value (0x11).

The Max_TX_Power parameter is used to set the maximum output power, EIRP, to be used for all CS transmissions. If the value provided in this parameter is higher than the maximum output power supported by the Controller, then the Controller shall use the maximum output power that it supports. If the Controller is unable to use the exact output power requested by the Host, then the Controller shall use an output power that is lower but closest to the requested value.

If the Host sends this command with a Connection_Handle that does not exist, or the Connection_Handle is not for an ACL, then the Controller shall return the error code Unknown Connection Identifier (0x02).

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

Parameters
[in]p_paramsInput parameters.
[out]p_returnExtra return parameters.
Return values
0if 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.