Skip to content

Commit 6f8e19f

Browse files
Tsjerfellnordicjm
authored andcommitted
doc: Update documentation for Channel Sounding Kconfig options
Update documentation for Channel Sounding Kconfig options Signed-off-by: Erik Omre <[email protected]>
1 parent fd116a4 commit 6f8e19f

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

subsys/bluetooth/controller/Kconfig

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -583,25 +583,41 @@ config BT_CTLR_SDC_CIS_SUBEVENT_LENGTH_US
583583
config BT_CTLR_CHANNEL_SOUNDING
584584
bool "Channel Sounding support [EXPERIMENTAL]"
585585
select EXPERIMENTAL
586+
help
587+
Enable Channel Sounding support.
586588

587589
config BT_CTLR_SDC_CS_COUNT
588590
int "Number of concurrent connections supporting CS procedure [EXPERIMENTAL]"
589591
default 1
592+
range 1 BT_MAX_CONN
590593
depends on BT_CTLR_CHANNEL_SOUNDING
591594
help
592-
Set the number of concurrent connections that can support Channel Sounding procedure.
595+
Set the number of concurrent connections that can support Channel Sounding.
596+
Needs to be equal to or less than BT_MAX_CONN.
593597

594598
config BT_CTLR_SDC_CS_MAX_ANTENNA_PATHS
595599
int "Max number of Channel Sounding antenna paths supported by the controller [EXPERIMENTAL]"
596600
default 1
597601
range 1 4
598602
depends on BT_CTLR_CHANNEL_SOUNDING
603+
help
604+
Sets the max number of antenna paths the controller supports.
605+
The number of antenna paths used during channel sounding
606+
depends on the tone antenna configuration index selected in the procedure parameters.
607+
For instance, an A2_B2 configuration requires four antenna paths.
608+
Reducing the value of this kconfig will reduce the RAM usage per CS context.
599609

600610
config BT_CTLR_SDC_CS_NUM_ANTENNAS
601611
int "Number of antennas used in Channel Sounding procedure supported by the controller [EXPERIMENTAL]"
602612
default 1
603613
range 1 BT_CTLR_SDC_CS_MAX_ANTENNA_PATHS
604614
depends on BT_CTLR_CHANNEL_SOUNDING
615+
help
616+
Configure the maximum number of antennas the local controller can support.
617+
Must be equal to or less than BT_CTLR_SDC_CS_MAX_ANTENNA_PATHS.
618+
This value also configures whether to use the antenna switching API or not.
619+
When this value is not 1, the controller requires an antenna switching callback to function.
620+
For more information see the Multiple antennas support documentation in SDC.
605621

606622
config BT_CTLR_SDC_CS_MULTIPLE_ANTENNA_SUPPORT
607623
bool
@@ -612,8 +628,12 @@ config BT_CTLR_SDC_CS_MULTIPLE_ANTENNA_SUPPORT
612628
Internal helper config. Not intended for use.
613629

614630
config BT_CTLR_SDC_CS_STEP_MODE3
615-
bool "Enable optional step mode-3 capability [EXPERIMENTAL]"
631+
bool "Enable optional step mode-3 support [EXPERIMENTAL]"
616632
depends on BT_CTLR_CHANNEL_SOUNDING
633+
select EXPERIMENTAL
634+
help
635+
Enable optional step mode-3 support. Channel sounding will not automatically start using step mode-3 if this
636+
config is set. To use step mode-3, modify the configuration which is created using the LE CS Create config command.
617637

618638
config BT_CTLR_SDC_LE_POWER_CLASS_1
619639
bool "Device supports transmitting at LE Power Class 1 level"

0 commit comments

Comments
 (0)