 |
nrfxlib API 3.3.99
|
|
nrfxlib API 3.3.99
|
| uint8_t sdc_hci_cmd_le_cs_create_config | ( | const sdc_hci_cmd_le_cs_create_config_t * | p_params | ) |
#include <softdevice_controller/include/sdc_hci_cmd_le.h>
LE CS Create Config.
The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.8.137
This command is used by a Host to create a new CS configuration or update an existing CS configuration with the identifier Config_ID on the connection identified by the Connection_Handle in the local and/or the remote Controller.
When the Create_Context parameter is set to 0x00, the CS configuration is written only in the local Controller. Otherwise when set to 0x01, the CS configuration is written in both the local and remote Controllers using the Channel Sounding Configuration procedure.
The Main_Mode_Type and the Sub_Mode_Type parameters indicate the CS modes (see [Vol 6] Part H, Table 4.11 for valid combinations) to be used during the CS procedure for the specified CS configuration.
The Min_Main_Mode_Steps and Max_Main_Mode_Steps parameters indicate the range of main mode CS steps to be executed before a submode CS step is executed during the CS procedure. When the Sub_Mode_Type parameter is set to 0xFF, the Min_Main_Mode_Steps and Max_Main_Mode_Steps parameters are reserved for future use. The Main_Mode_Repetition parameter indicates the number of main mode CS steps repeated from the last CS subevent at the beginning of the current CS subevent.
The Mode_0_Steps parameter indicates the number of mode-0 CS steps to be included at the beginning of each CS subevent.
The Role parameter indicates the CS role for the local Controller for the specified CS configuration. The RTT_Type parameter indicates the RTT variant to be used during the CS procedure, and the CS_SYNC_PHY parameter indicates the PHY to be used for CS_SYNC exchanges during the CS procedure for the specified CS configuration.
The Channel_Map parameter indicates the channels to be used or unused during the CS procedure, and the Channel_Map_Repetition parameter indicates the number of times the channels specified by Channel_Map are to be repeated for non-mode-0 steps during the CS procedure (see [Vol 6] Part H, Section 4.1.4).
The Channel_Selection_Type parameter indicates the Channel Selection Algorithm to be used during the CS procedure for non-mode-0 steps. When the Channel_Selection_Type is set to 0x01, the Ch3c_Shape and the Ch3c_Jump parameters shall each be set to the selected shape and channels to be skipped as described in [Vol 6] Part H, Section 4.1.4.2. Otherwise, the Ch3c_Shape and the Ch3c_Jump parameters shall be ignored.
The CS_Enhancements parameter indicates which CS enhancements to be used during the CS procedure. For each enhancement that is not enabled, the corresponding bit shall be set to 0.
If the Host issues this command before a Channel Sounding Capability Exchange procedure has been completed or an HCI_LE_CS_Write_Cached_Remote_- Supported_Capabilities command has been issued for the connection identified by the Connection_Handle parameter, then the Controller may autonomously initiate the Channel Sounding Capability Exchange procedure.
Errors:
See Section 4.5.2 for a list of error types and descriptions.
Type Condition Error code
MC Some parameters are not supported by the local or remote Controller. Unsupported
Feature or
Parameter Value
(0x11)
MC The parameters specify an invalid configuration according to [Vol 6] Invalid HCI
Part H (e.g., a combination of Main_Mode_Type and Sub_Mode_Type not Command
specified in [Vol 6] Part H, Table 4.11). Parameters (0x12)
M Less than 15 channels are enabled. Invalid HCI
Command
Parameters (0x12)
M Any of bits 0, 1, 23, 24, 25, 77, or 78 are set to 1. Invalid HCI
Command
Parameters (0x12)
MC Role has not been enabled by a prior HCI_LE_CS_Set_Default_Settings Invalid HCI
command. Command
Parameters (0x12)
MC Connection_Handle identifies a connection where a Channel Sounding Command
Capability Exchange procedure has been completed. Disallowed (0x0C)
MC Connection_Handle identifies a connection where an Command
HCI_LE_CS_Write_Cached_Remote_Supported_Capabilities command has Disallowed (0x0C)
been issued.
MC Config_ID identifies a CS configuration that is already enabled. Command
Disallowed (0x0C)
MC Connection_Handle does not identify an ACL. Unknown
Connection
Identifier (0x02)
Event(s) generated (unless masked away):
When the Controller receives the HCI_LE_CS_Create_Config command, the Controller shall send the HCI_Command_Status event to the Host. When the Controller has completed the Channel Sounding Configuration procedure with the remote Controller or when the Create_Context parameter is set to 0x00, the Controller shall generate an LE_CS_Config_Complete event.
| [in] | p_params | Input parameters. |
| 0 | if success. |
1.12.0