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.3, Vol 4, Part E, Section 7.8.134

This 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.

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

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.

Errors:

See Section 4.5.2 for a list of error types and descriptions.

Type   Condition                                                  Error code
MC     The bit for a role which has a valid CS configuration      Invalid HCI Command
       present is set to 0 in Role_Enable.                        Parameters (0x12)
MC     CS_SYNC_Antenna_Selection indicates an unsupported         Unsupported Feature or
       antenna identifier.                                        Parameter Value (0x11)
MC     The bit for an unsupported role is set to 1 in             Unsupported Feature or
       Role_Enable.                                               Parameter Value (0x11)
MC     Connection_Handle does not identify an ACL.                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_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.