bt_le_cs_test_param Struct Reference

CS Test parameters. More...

#include <cs.h>

Data Fields
enum bt_conn_le_cs_main_mode	main_mode
	CS mode to be used during the CS procedure.
enum bt_conn_le_cs_sub_mode	sub_mode
	CS sub-mode to be used during the CS procedure.
uint8_t	main_mode_repetition
	Number of main mode steps taken from the end of the last CS subevent to be repeated at the beginning of the current CS subevent directly after the last mode-0 step of that event.
uint8_t	mode_0_steps
	Number of CS mode-0 steps at the beginning of the test CS subevent.
enum bt_conn_le_cs_role	role
	CS Test role.
enum bt_conn_le_cs_rtt_type	rtt_type
	RTT variant.
enum bt_conn_le_cs_sync_phy	cs_sync_phy
	CS_SYNC PHY.
enum bt_le_cs_test_cs_sync_antenna_selection	cs_sync_antenna_selection
	Antenna identifier to be used for CS_SYNC packets.
uint32_t	subevent_len
	CS subevent length in microseconds.
uint16_t	subevent_interval
	Gap between the start of two consecutive CS subevents (N * 0.625 ms)
uint8_t	max_num_subevents
	Maximum allowed number of subevents in the procedure.
uint8_t	transmit_power_level
	Desired TX power level for the CS procedure.
uint8_t	t_ip1_time
	Interlude time in microseconds between the RTT packets.
uint8_t	t_ip2_time
	Interlude time in microseconds between the CS tones.
uint8_t	t_fcs_time
	Time in microseconds for frequency changes.
uint8_t	t_pm_time
	Time in microseconds for the phase measurement period of the CS tones.
uint8_t	t_sw_time
	Time in microseconds for the antenna switch period of the CS tones.
enum bt_conn_le_cs_tone_antenna_config_selection	tone_antenna_config_selection
	Antenna Configuration Index used during antenna switching during the tone phases of CS steps.
enum bt_le_cs_initiator_snr_control	initiator_snr_control
	Initiator SNR control options.
enum bt_le_cs_reflector_snr_control	reflector_snr_control
	Reflector SNR control options.
uint16_t	drbg_nonce
	Determines octets 14 and 15 of the initial value of the DRBG nonce.
uint16_t	override_config
	Override configuration.
struct {
uint8_t   channel_map_repetition
	Number of times the channels indicated by the channel map or channel field are cycled through for non-mode-0 steps within a CS procedure. More...
union {
struct {
uint8_t   num_channels
uint8_t *   channels
}   set
struct {
uint8_t   channel_map [10]
enum bt_conn_le_cs_chsel_type   channel_selection_type
enum bt_conn_le_cs_ch3c_shape   ch3c_shape
uint8_t   ch3c_jump
}   not_set
}
}	override_config_0
	override config bit 0.
struct {
uint8_t   main_mode_steps
}	override_config_2
	Override config bit 2.
struct {
enum bt_le_cs_test_override_3_pm_tone_ext   t_pm_tone_ext
}	override_config_3
	Override config bit 3.
struct {
enum bt_le_cs_test_override_4_tone_antenna_permutation   tone_antenna_permutation
}	override_config_4
	Override config bit 4.
struct {
uint32_t   cs_sync_aa_initiator
	Access Address used in CS_SYNC packets sent by the initiator. More...
uint32_t   cs_sync_aa_reflector
	Access Address used in CS_SYNC packets sent by the reflector. More...
}	override_config_5
	Override config bit 5.
struct {
uint8_t   ss_marker1_position
	Bit number where the first marker in the channel sounding sequence starts. More...
uint8_t   ss_marker2_position
	Bit number where the second marker in the channel sounding sequence starts. More...
}	override_config_6
	Override config bit 6.
struct {
enum bt_le_cs_test_override_7_ss_marker_value   ss_marker_value
	Value of the Sounding Sequence marker. More...
}	override_config_7
	Override config bit 7.
struct {
enum bt_le_cs_test_override_8_cs_sync_payload_pattern   cs_sync_payload_pattern
	CS_SYNC payload pattern selection. More...
uint8_t   cs_sync_user_payload [16]
	User payload for CS_SYNC packets. More...
}	override_config_8
	Override config bit 8.

Detailed Description

CS Test parameters.

Field Documentation

ch3c_jump

uint8_t bt_le_cs_test_param::ch3c_jump

ch3c_shape

enum bt_conn_le_cs_ch3c_shape bt_le_cs_test_param::ch3c_shape

channel_map

uint8_t bt_le_cs_test_param::channel_map[10]

channel_map_repetition

uint8_t bt_le_cs_test_param::channel_map_repetition

Number of times the channels indicated by the channel map or channel field are cycled through for non-mode-0 steps within a CS procedure.

channel_selection_type

enum bt_conn_le_cs_chsel_type bt_le_cs_test_param::channel_selection_type

channels

uint8_t* bt_le_cs_test_param::channels

cs_sync_aa_initiator

uint32_t bt_le_cs_test_param::cs_sync_aa_initiator

Access Address used in CS_SYNC packets sent by the initiator.

cs_sync_aa_reflector

uint32_t bt_le_cs_test_param::cs_sync_aa_reflector

Access Address used in CS_SYNC packets sent by the reflector.

cs_sync_antenna_selection

enum bt_le_cs_test_cs_sync_antenna_selection bt_le_cs_test_param::cs_sync_antenna_selection

Antenna identifier to be used for CS_SYNC packets.

cs_sync_payload_pattern

enum bt_le_cs_test_override_8_cs_sync_payload_pattern bt_le_cs_test_param::cs_sync_payload_pattern

CS_SYNC payload pattern selection.

cs_sync_phy

enum bt_conn_le_cs_sync_phy bt_le_cs_test_param::cs_sync_phy

CS_SYNC PHY.

cs_sync_user_payload

uint8_t bt_le_cs_test_param::cs_sync_user_payload[16]

User payload for CS_SYNC packets.

This parameter is only used when using BT_LE_CS_TEST_OVERRIDE_8_PAYLOAD_PATTERN_USER

The least significant bit corresponds to the most significant bit of the CS payload. When the sequence is less than 16 octets, the least significant octets shall be padded with zeros.

drbg_nonce

uint16_t bt_le_cs_test_param::drbg_nonce

Determines octets 14 and 15 of the initial value of the DRBG nonce.

initiator_snr_control

enum bt_le_cs_initiator_snr_control bt_le_cs_test_param::initiator_snr_control

Initiator SNR control options.

main_mode

enum bt_conn_le_cs_main_mode bt_le_cs_test_param::main_mode

CS mode to be used during the CS procedure.

main_mode_repetition

uint8_t bt_le_cs_test_param::main_mode_repetition

Number of main mode steps taken from the end of the last CS subevent to be repeated at the beginning of the current CS subevent directly after the last mode-0 step of that event.

main_mode_steps

uint8_t bt_le_cs_test_param::main_mode_steps

max_num_subevents

uint8_t bt_le_cs_test_param::max_num_subevents

Maximum allowed number of subevents in the procedure.

A value of 0 means that this parameter is ignored.

mode_0_steps

uint8_t bt_le_cs_test_param::mode_0_steps

Number of CS mode-0 steps at the beginning of the test CS subevent.

[struct]

struct { ... } bt_le_cs_test_param::not_set

num_channels

uint8_t bt_le_cs_test_param::num_channels

override_config

uint16_t bt_le_cs_test_param::override_config

Override configuration.

This parameter is used to override CS parameters from the DRBG. Each bit configures a different set of parameters.

All overrides are optional, except for those configured by bit 0.

These are:

• Bit 0 set: Override using list of channels
• Bit 0 not set: Override using channel map
• Bit 2 set: Override main mode steps
• Bit 3 set: Override T_PM_Tone_Ext
• Bit 4 set: Override tone antenna permutation
• Bit 5 set: Override CS_SYNC AA
• Bit 6 set: Override SS marker positions
• Bit 7 set: Override SS marker value
• Bit 8 set: Override CS_SYNC payload pattern and user payload
• Bit 10 set: Procedure is replaced with a stable phase test

[struct]

struct { ... } bt_le_cs_test_param::override_config_0

override config bit 0.

[struct]

struct { ... } bt_le_cs_test_param::override_config_2

Override config bit 2.

These parameters are ignored if the bit is not set.

[struct]

struct { ... } bt_le_cs_test_param::override_config_3

Override config bit 3.

These parameters are ignored if the bit is not set.

[struct]

struct { ... } bt_le_cs_test_param::override_config_4

Override config bit 4.

These parameters are ignored if the bit is not set.

[struct]

struct { ... } bt_le_cs_test_param::override_config_5

Override config bit 5.

These parameters are ignored if the bit is not set.

[struct]

struct { ... } bt_le_cs_test_param::override_config_6

Override config bit 6.

These parameters are ignored if the bit is not set.

[struct]

struct { ... } bt_le_cs_test_param::override_config_7

Override config bit 7.

These parameters are ignored if the bit is not set.

[struct]

struct { ... } bt_le_cs_test_param::override_config_8

Override config bit 8.

These parameters are ignored if the bit is not set.

reflector_snr_control

enum bt_le_cs_reflector_snr_control bt_le_cs_test_param::reflector_snr_control

Reflector SNR control options.

role

enum bt_conn_le_cs_role bt_le_cs_test_param::role

CS Test role.

rtt_type

enum bt_conn_le_cs_rtt_type bt_le_cs_test_param::rtt_type

RTT variant.

[struct]

struct { ... } bt_le_cs_test_param::set

ss_marker1_position

uint8_t bt_le_cs_test_param::ss_marker1_position

Bit number where the first marker in the channel sounding sequence starts.

Must be between 0 and 28 when using BT_CONN_LE_CS_RTT_TYPE_32_BIT_SOUNDING.

ss_marker2_position

uint8_t bt_le_cs_test_param::ss_marker2_position

Bit number where the second marker in the channel sounding sequence starts.

Must be between 67 and 92 when using BT_CONN_LE_CS_RTT_TYPE_96_BIT_SOUNDING.

A value of BT_HCI_OP_LE_CS_TEST_SS_MARKER_2_POSITION_NOT_PRESENT indicates that this sounding sequence or marker is not present.

ss_marker_value

enum bt_le_cs_test_override_7_ss_marker_value bt_le_cs_test_param::ss_marker_value

Value of the Sounding Sequence marker.

sub_mode

enum bt_conn_le_cs_sub_mode bt_le_cs_test_param::sub_mode

CS sub-mode to be used during the CS procedure.

subevent_interval

uint16_t bt_le_cs_test_param::subevent_interval

Gap between the start of two consecutive CS subevents (N * 0.625 ms)

A value of 0 means that there is only one CS subevent.

subevent_len

uint32_t bt_le_cs_test_param::subevent_len

CS subevent length in microseconds.

Range: 1250us to 4s

t_fcs_time

uint8_t bt_le_cs_test_param::t_fcs_time

Time in microseconds for frequency changes.

Valid options are:

• 15 us
• 20 us
• 30 us
• 40 us
• 50 us
• 60 us
• 80 us
• 100 us
• 120 us
• 150 us

t_ip1_time

uint8_t bt_le_cs_test_param::t_ip1_time

Interlude time in microseconds between the RTT packets.

Valid options are:

• 10 us
• 20 us
• 30 us
• 40 us
• 50 us
• 60 us
• 80 us
• 145 us

t_ip2_time

uint8_t bt_le_cs_test_param::t_ip2_time

Interlude time in microseconds between the CS tones.

Valid options are:

• 10 us
• 20 us
• 30 us
• 40 us
• 50 us
• 60 us
• 80 us
• 145 us

t_pm_time

uint8_t bt_le_cs_test_param::t_pm_time

Time in microseconds for the phase measurement period of the CS tones.

Valid options are:

• 10 us
• 20 us
• 40 us

t_pm_tone_ext

enum bt_le_cs_test_override_3_pm_tone_ext bt_le_cs_test_param::t_pm_tone_ext

t_sw_time

uint8_t bt_le_cs_test_param::t_sw_time

Time in microseconds for the antenna switch period of the CS tones.

Valid options are:

• 0 us
• 1 us
• 2 us
• 4 us
• 10 us

tone_antenna_config_selection

enum bt_conn_le_cs_tone_antenna_config_selection bt_le_cs_test_param::tone_antenna_config_selection

Antenna Configuration Index used during antenna switching during the tone phases of CS steps.

tone_antenna_permutation

enum bt_le_cs_test_override_4_tone_antenna_permutation bt_le_cs_test_param::tone_antenna_permutation

transmit_power_level

uint8_t bt_le_cs_test_param::transmit_power_level

Desired TX power level for the CS procedure.

Value range is BT_HCI_OP_LE_CS_MIN_MAX_TX_POWER to BT_HCI_OP_LE_CS_MAX_MAX_TX_POWER.

Special values:

• BT_HCI_OP_LE_CS_TEST_MAXIMIZE_TX_POWER tells the controller it should use as high a transmit power as possible
• BT_HCI_OP_LE_CS_TEST_MINIMIZE_TX_POWER tells the controller it should use as low a transmit power as possible

---

The documentation for this struct was generated from the following file:

• include/zephyr/bluetooth/cs.h