Skip to content

Commit 0e39e85

Browse files
committed
doc: Update documentation for Channel Sounding Kconfig options
Update documentation for Channel Sounding Kconfig options Signed-off-by: Erik Semb Omre <erik.omre@nordicsemi.no>
1 parent 9eb862a commit 0e39e85

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

subsys/bluetooth/controller/Kconfig

+23-2
Original file line numberDiff line numberDiff line change
@@ -584,25 +584,42 @@ config BT_CTLR_SDC_CIS_SUBEVENT_LENGTH_US
584584
config BT_CTLR_CHANNEL_SOUNDING
585585
bool "Channel Sounding support [EXPERIMENTAL]"
586586
select EXPERIMENTAL
587+
help
588+
Enable Channel Sounding support.
587589

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

595599
config BT_CTLR_SDC_CS_MAX_ANTENNA_PATHS
596600
int "Max number of Channel Sounding antenna paths supported by the controller [EXPERIMENTAL]"
597601
default 1
598602
range 1 4
599603
depends on BT_CTLR_CHANNEL_SOUNDING
604+
help
605+
Set the max number of antenna paths the controller supports. This differs from BT_CTLR_SDC_CS_NUM_ANTENNAS
606+
since you can run a setup where local controller only has one antenna, but peer controller has two antennas.
607+
In this configuration, set BT_CTLR_SDC_CS_NUM_ANTENNAS to 1 and BT_CTLR_SDC_CS_MAX_ANTENNA_PATHS to 2
608+
(since local controller can send to both of the peer antennas, creating a total of 2 antenna paths)
609+
This option is purely a RAM-usage optimisation. If this option is set to 4, the controller has to reserve space for
610+
a total of 5 measurements per CS-step. However, if you set this to 1, the controller will only reserve space for
611+
2 measurements per CS-step.
600612

601613
config BT_CTLR_SDC_CS_NUM_ANTENNAS
602614
int "Number of antennas used in Channel Sounding procedure supported by the controller [EXPERIMENTAL]"
603615
default 1
604616
range 1 BT_CTLR_SDC_CS_MAX_ANTENNA_PATHS
605617
depends on BT_CTLR_CHANNEL_SOUNDING
618+
help
619+
Set the max number of antennas supported by local controller. This differs from BT_CTLR_SDC_CS_MAX_ANTENNA_PATHS
620+
since you can run a setup where both local controller and peer controller has 2 antennas.
621+
In this configuration, set BT_CTLR_SDC_CS_NUM_ANTENNAS to 2 and BT_CTLR_SDC_CS_MAX_ANTENNA_PATHS to 4
622+
(since both of the local antennas can send to both of the peer's antennas, creating a total of 4 antenna paths).
606623

607624
config BT_CTLR_SDC_CS_MULTIPLE_ANTENNA_SUPPORT
608625
bool
@@ -613,8 +630,12 @@ config BT_CTLR_SDC_CS_MULTIPLE_ANTENNA_SUPPORT
613630
Internal helper config. Not intended for use.
614631

615632
config BT_CTLR_SDC_CS_STEP_MODE3
616-
bool "Enable optional step mode-3 capability [EXPERIMENTAL]"
633+
bool "Enable optional step mode-3 support [EXPERIMENTAL]"
634+
default n
617635
depends on BT_CTLR_CHANNEL_SOUNDING
636+
help
637+
Enable optional step mode-3 support. Channel sounding will not automatically start using step mode-3 if this
638+
config is set. To use step mode-3, you need to modify the configuration which is created using the LE CS Create config command.
618639

619640
config BT_CTLR_SDC_LE_POWER_CLASS_1
620641
bool "Device supports transmitting at LE Power Class 1 level"

0 commit comments

Comments
 (0)