 |
nrfxlib API 2.8.99
|
|
nrfxlib API 2.8.99
|
| uint8_t sdc_hci_cmd_le_cs_set_procedure_params | ( | const sdc_hci_cmd_le_cs_set_procedure_params_t * | p_params, |
| sdc_hci_cmd_le_cs_set_procedure_params_return_t * | p_return ) |
#include <softdevice_controller/include/sdc_hci_cmd_le.h>
LE CS Set Procedure Parameters.
The description below is extracted from Core_v6.0, Vol 4, Part E, Section 7.8.140
The HCI_LE_CS_Set_Procedure_Parameters command is used by a Host to set the parameters for the scheduling of one or more CS procedures by the local Controller, with the remote device for the CS configuration identified by Config_ID and the connection identified by the Connection_Handle parameter.
The Max_Procedure_Len parameter indicates the maximum duration of each CS procedure. The Min_Procedure_Interval and Max_Procedure_Interval parameters indicate the minimum and maximum interval period between consecutive CS procedures. The Max_Procedure_Count parameter indicates the maximum number of consecutive CS procedures to be scheduled as part of this measurement. If Max_Procedure_Count is set to 1, then Min_Procedure_Interval and Max_Procedure_Interval shall be ignored.
The Min_Subevent_Len and Max_Subevent_Len parameters indicate the minimum and maximum duration of each CS subevent during the CS procedure.
The values for Min_Procedure_Interval, Max_Procedure_Interval, Min_Subevent_Len, and Max_Subevent_Len are recommendations to the Controller which it may ignore.
The Tone_Antenna_Config_Selection parameter indicates the Antenna Configuration Index to be used in the CS procedure. The power delta value Tx_Power_Delta indicates the recommended difference between the remote device’s power level for the CS tones and RTT packets and the power level for the PHY indicated by the PHY parameter.
The Preferred_Peer_Antenna parameter indicates the preferred peer-ordered antenna elements to be used by the remote device for the antenna configuration denoted by the Tone_Antenna_Config_Selection parameter. The number of bits set in this field shall be greater than or equal to the number of antenna elements denoted by the Tone_Antenna_Config_Selection parameter.
The SNR_Control_Initiator parameter indicates the SNR control adjustment for the CS_SYNC transmissions of the initiator.
The SNR_Control_Reflector parameter indicates the SNR control adjustment for the CS_SYNC transmissions of the reflector.
If the Host issues this command with parameters that exceed the CS capabilities or any coexistence constraints, then the Controller shall return the error code Connection Rejected Due to Limited Resources (0x0D).
If the CS configuration corresponding to Config_ID does not exist or is removed using the HCI_LE_CS_Remove_Config command, then the Controller shall return the error code Invalid HCI Command Parameters (0x12).
If the Host issues this command when a CS procedure measurement is already enabled for the specified Config_ID in the Controller using the HCI_LE_CS_Procedure_Enable command, then the Controller shall return the error code Command Disallowed (0x0C).
The parameters specified by this command for the CS configuration identified by the Config_ID parameter become invalid after the Host issues the HCI_LE_CS_Remove_Config command for the given Config_ID.
If the number of channels available for Channel Sounding before the start of a new CS procedure measurement is less than 15, then the Controller shall return the error code Insufficient Channels (0x48).
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_Procedure_Parameters command has completed, an HCI_Command_Complete event shall be generated.
| [in] | p_params | Input parameters. |
| [out] | p_return | Extra return parameters. |
| 0 | if success. |
1.12.0