Channel Sounding#

Connection handle

Connection handle

Enum sl_bt_cs_role_status_t. Enable or disable status of the Initiator role. Values:

• sl_bt_cs_role_status_disable (0x0): The given role is disabled

• sl_bt_cs_role_status_enable (0x1): The given role is enabled

Enum sl_bt_cs_role_status_t. Enable or disable status of the Reflector role. Values:

• sl_bt_cs_role_status_disable (0x0): The given role is disabled

• sl_bt_cs_role_status_enable (0x1): The given role is enabled

Antenna identifier to be used for CS sync packets.

• Range: 1 to 4

Maximum transmit power level to be used in all CS transmissions. Units: dBm.

• Range: -127 to +20

The connection handle

CS configuration identifier.

• Range: 0 to 3

Defines in which device the created configuration will be written

• Value: 0x00. Write CS configuration in the local controller only

• Value: 0x01. Write CS configuration in both the local and remote controller using a configuration procedure

Enum sl_bt_cs_mode_t. Main mode type. Values:

• sl_bt_cs_mode_rtt (0x1): Round Trip Time (RTT) measurement

• sl_bt_cs_mode_pbr (0x2): Phase-Based Ranging (PBR) measurement

• sl_bt_cs_submode_disabled (0xff): Submode disabled for the procedure.

Enum sl_bt_cs_mode_t. Sub mode type. Values:

• sl_bt_cs_mode_rtt (0x1): Round Trip Time (RTT) measurement

• sl_bt_cs_mode_pbr (0x2): Phase-Based Ranging (PBR) measurement

• sl_bt_cs_submode_disabled (0xff): Submode disabled for the procedure.

Minimum number of CS main mode steps to be executed prior to a sub mode step.

• Range: 1 to 160

Maximum number of CS main mode steps to be executed prior to a sub mode step.

• Range: 1 to 160

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 value r last Mode 0 step of that event.

• Range: 0 to 3

Number of Mode 0 steps to be included at the beginning of the test CS subevent

• Range: 1 to 3

Enum sl_bt_cs_role_t. Device's role during the CS procedure Values:

• sl_bt_cs_role_initiator (0x0): The device will initiate the procedure

• sl_bt_cs_role_reflector (0x1): The device will reciprocate transmission

Enum sl_bt_cs_rtt_type_t. RTT payload type used in the CS procedure Values:

• sl_bt_cs_rtt_type_aa_only (0x0): RTT Access Address (AA) only

• sl_bt_cs_rtt_type_fractional_96_bit_sounding (0x2): RTT Fractional with 96-bit Sounding Sequence

• sl_bt_cs_rtt_type_fractional_32_bit_random (0x3): RTT Fractional with 32-bit Random Sequence

• sl_bt_cs_rtt_type_fractional_64_bit_random (0x4): RTT Fractional with 64-bit Random Sequence

• sl_bt_cs_rtt_type_fractional_96_bit_random (0x5): RTT Fractional with 96-bit Random Sequence

• sl_bt_cs_rtt_type_fractional_128_bit_random (0x6): RTT Fractional with 128-bit Random Sequence

Enum sl_bt_gap_phy_t. Used PHY for CS SYNC exchanges during a procedure Values:

• sl_bt_gap_phy_1m (0x1): 1M PHY

A fixed length byte array of 10 bytes consisting of 79 1-bit fields.

The nth such field (in the range 0 to 78) contains the value for the CS channel index n.

• Bit value 0: Channel n is disabled

• Bit value 1: Channel n is enabled

The rest of most significant bits are reserved for future use and must be set to 0. Channels n = 0, 1, 23, 24, 25, 77 and 78 shall be ignored and not used for CS. At least 15 channels shall be marked as used.

Number of times the channel_map field will be cycled through for non-Mode 0 steps within an CS procedure.

• Range: 1 to 255

Enum sl_bt_cs_channel_selection_algorithm_t. Channel selection algorithm Values:

• sl_bt_cs_channel_selection_algorithm_3b (0x0): Use Channel Selection Algorithm #3b for non-mode 0 CS steps

• sl_bt_cs_channel_selection_algorithm_3c (0x1): Use Channel Selection Algorithm #3c for non-mode 0 CS steps

• sl_bt_cs_channel_selection_algorithm_user_shape_interleaved (0x2): Use Interleaved shape for user specified channel sequence

Enum sl_bt_cs_ch3c_shape_t. Ch3c shape Values:

• sl_bt_cs_ch3c_shape_hat (0x0): Use Hat shape for user specified channel sequence

• sl_bt_cs_chc3_shape_interleaved (0x1): Use Interleaved shape for user specified channel sequence

Number of channels skipped in each rising and falling sequence.

• Range: 2 to 8

Enum sl_bt_cs_companion_signal_status_t. Companion device's signal status Values:

• sl_bt_cs_companion_signal_status_disable (0x0): The companion signal is disabled

• sl_bt_cs_companion_signal_status_enable (0x1): The companion signal is enabled

Connection handle

CS configuration identifier

• Range: 0 to 3

A fixed length byte array of 10 bytes consisting of 79 1-bit fields.

The nth field (in the range 0 to 78) contains the value for the link layer channel index n.

• Bit value 0: Channel n is disabled.

• Bit value 1: Channel n is enabled.

The rest of most significant bits are reserved for future use and must be set to 0. Channels n = 0, 1, 23, 24, 25, 77 and 78 shall be ignored and not used for CS.

The connection handle

CS configuration identifier.

• Range: 0 to 3

Maximum duration for each measurement procedure. Value in units of 0.625 ms.

• Range: 1 to 65535

• Time: N x 0.625ms. N being the input.

• Time range: 0.625 ms to 40.959375 s.

Minimum duration in number of connection events between consecutive measurement procedure.

• Range: 1 to 65535

Maximum duration in number of connection events between consecutive measurement procedure.

• Range: 1 to 65535

Maximum number of CS procedures to be scheduled.

• Range: 1 to 65535

• Value: 0x00. Procedures to continue until disabled.

Minimum suggested duration for each CS subevent. Units: microseconds.

• Range: 1 to 16777215

• Time range: 1250 us to 4s

Maximum suggested duration for each CS subevent. Units: microseconds.

• Range: 1 to 16777215

• Time range: 1250 us to 4s

Antenna configuration index

• Range: 0 to 7

Enum sl_bt_gap_phy_t. PHY on which the CS transmission will take place Values:

• sl_bt_gap_phy_1m (0x1): 1M PHY

• sl_bt_gap_phy_2m (0x2): 2M PHY

• sl_bt_gap_phy_coded (0x4): Coded PHY, 125k (S=8) or 500k (S=2)

• sl_bt_gap_phy_any (0xff): Any PHYs the device supports

Transmit power delta. Units: dB.

• Value: 0x80. Host does not have a recommendation for transmit power delta

Preferred peer-ordered antenna elements to be used by the remote device for the antenna configuration denoted by the tone antenna config selection.

• Bit 0: Use first ordered antenna element

• Bit 1: Use second ordered antenna element

• Bit 2: Use third ordered antenna element

• Bit 3: Use fourth ordered antenna element

Enum sl_bt_cs_snr_control_adjustment_t. The Signal Noise Ratio (SNR) control adjustment for the CS_SYNC transmissions of the initiator. Values:

• sl_bt_cs_snr_control_adjustment_18_db (0x0): SNR control adjustment of 18 dB

• sl_bt_cs_snr_control_adjustment_21_db (0x1): SNR control adjustment of 21 dB

• sl_bt_cs_snr_control_adjustment_24_db (0x2): SNR control adjustment of 24 dB

• sl_bt_cs_snr_control_adjustment_27_db (0x3): SNR control adjustment of 27 dB

• sl_bt_cs_snr_control_adjustment_30_db (0x4): SNR control adjustment of 30 dB

• sl_bt_cs_snr_control_adjustment_not_applied (0xff): SNR control adjustment not to be applied

Enum sl_bt_cs_snr_control_adjustment_t. The Signal Noise Ratio (SNR) control adjustment for the CS_SYNC transmissions of the reflector. Values:

• sl_bt_cs_snr_control_adjustment_18_db (0x0): SNR control adjustment of 18 dB

• sl_bt_cs_snr_control_adjustment_21_db (0x1): SNR control adjustment of 21 dB

• sl_bt_cs_snr_control_adjustment_24_db (0x2): SNR control adjustment of 24 dB

• sl_bt_cs_snr_control_adjustment_27_db (0x3): SNR control adjustment of 27 dB

• sl_bt_cs_snr_control_adjustment_30_db (0x4): SNR control adjustment of 30 dB

• sl_bt_cs_snr_control_adjustment_not_applied (0xff): SNR control adjustment not to be applied

The connection handle

Enum sl_bt_cs_procedure_state_t. Enabled or disabled CS procedure state. Values:

• sl_bt_cs_procedure_state_disabled (0x0): CS procedures are disabled

• sl_bt_cs_procedure_state_enabled (0x1): CS procedures are enabled

CS configuration identifier

Length of data in antenna_element_offset

Offset of each antenna, each element is a signed 16-bit integer stored in two consecutive bytes in little-endian order. Units: 1 cm.

The number of CS configurations supported per connection.

• Range: 1 to 4

The maximum number of consecutive CS procedures supported.

• Range: 1 to 65535

• 0x00: Fixed number of consecutive procedures and for an indefinite number of procedures until termination

The number of antenna elements available for CS tone exchanges.

• Range: 0x01 to 0x04

The maximum number of antenna paths supported.

• Range: 1 to 4

This value is a bitmask of flags to indicate which CS roles are supported by the controller. Flags:

• 0x01, bit 0: Initiator role

• 0x02, bit 1: Reflector role

This value is a bitmask of flags to indicate which Optional CS modes are supported. Flags:

• 0x02, bit 0: Mode 3 is supported

This value is a bitmask of flags to indicate which Round Trip Time (RTT) CS capabilities accuracy requirement in rtt_aa_only_n, rtt_sounding_n, and rtt_random_payload. Flags:

• 0x01, bit 0: 10 ns time-of-flight (ToF) precision requirement for rtt_aa_only if set; otherwise 150 ns ToF

• 0x02, bit 1: 10 ns ToF precision requirement for rtt_sounding if set; otherwise 150 ns ToF

• 0x04, bit 2: 10 ns ToF precision requirement for rtt_random_payload if set; otherwise 150 ns ToF

The support status of RTT Access Address(AA) in the local controller. When supported it establishes the number of SYNC changes needed to satisfy the precision requirements.

• Range: 1 to 255

• 0x00: RTT AA Only is not supported

The support status of RTT Sounding is supported in the local controller. When supported it establishes the number of SYNC changes needed to satisfy the precision requirements.

• Range: 1 to 255

• 0x00: RTT Sounding is not supported

The support status of RTT Random Payload in the local controller. When supported it establishes the number of SYNC changes needed to satisfy the precision requirements.

• Range: 1 to 255

• 0x00: RTT Random Payload is not supported

This value is a bitmask of flags to indicate which CS_SYNC packages supported in an specific PHY. Flags:

• 0x02, bit 1: LE 2M PHY CS_SYNC packages are supported

• 0x04, bit 2: LE 2M 2BT PHY CS_SYNC packages are supported

This value is a bitmask of flags to indicate which Optional CS subfeatures supported is supported. Flags:

• 0x01, bit 0: CS Companion Signal is supported

• 0x02, bit 1: CS with zero Frequency Actuation Error relative to Mode 0 transmissions in reflector role is supported

• 0x04, bit 2: CS Channel Selection Algorithm #3c is supported

• 0x08, bit 3: CS phase-based ranging from a sounding sequence is supported

This value is a bitmask of flags to indicate which Time for Interlude Period 1 (IP1) supported is supported. Flags:

• 0x0001, bit 0: Time durantion of 10 microseconds is supported

• 0x0002, bit 1: Time durantion of 20 microseconds is supported

• 0x0004, bit 2: Time durantion of 30 microseconds is supported

• 0x0008, bit 3: Time durantion of 40 microseconds is supported

• 0x0010, bit 4: Time durantion of 50 microseconds is supported

• 0x0020, bit 5: Time durantion of 60 microseconds is supported

• 0x0040, bit 6: Time durantion of 80 microseconds is supported

This value is a bitmask of flags to indicate which Time for Interlude Period 2 (IP2) supported is supported. Flags:

• 0x0001, bit 0: Time duration of 10 microseconds is supported

• 0x0002, bit 1: Time duration of 20 microseconds is supported

• 0x0004, bit 2: Time duration of 30 microseconds is supported

• 0x0008, bit 3: Time duration of 40 microseconds is supported

• 0x0010, bit 4: Time duration of 50 microseconds is supported

• 0x0020, bit 5: Time duration of 60 microseconds is supported

• 0x0040, bit 6: Time duration of 80 microseconds is supported

This value is a bitmask of flags to indicate which Time for Frequency Change Spaceing (FCS) is supported. Flags:

• 0x0001, bit 0: Time duration of 10 microseconds is supported

• 0x0002, bit 1: Time duration of 20 microseconds is supported

• 0x0004, bit 2: Time duration of 30 microseconds is supported

• 0x0008, bit 3: Time duration of 40 microseconds is supported

• 0x0010, bit 4: Time duration of 50 microseconds is supported

• 0x0020, bit 5: Time duration of 60 microseconds is supported

• 0x0040, bit 6: Time duration of 80 microseconds is supported

• 0x0100, bit 7: Time duration of 100 microseconds is supported

• 0x0200, bit 8: Time duration of 120 microseconds is supported

This value is a bitmask of flags to indicate which Time for Phase Measurement (PM) supported is supported. Flags:

• 0x0001, bit 0: Time duration of 10 microseconds is supported

• 0x0002, bit 1: Time duration of 20 microseconds is supported

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

• Values: 0x02, 0x02, 0x04 and 0x0A

This value is a bitmask of flags to indicate the supported SNR levels used in RTT packets. Flags:

• 0x01, bit 0: 18 dB supported

• 0x02, bit 1: 21 dB supported

• 0x04, bit 2: 24 dB supported

• 0x08, bit 3: 27 dB supported

• 0x10, bit 4: 30 dB supported

Connection handle