bt_conn_le_cs_subevent_result Struct Reference

Subevent data for LE connections supporting CS. More...

#include <conn.h>

Data Fields
struct {
uint8_t   config_id
	CS configuration identifier. More...
uint16_t   start_acl_conn_event
	Starting ACL connection event counter. More...
uint16_t   procedure_counter
	CS procedure count associated with these results. More...
uint16_t   frequency_compensation
	Frequency compensation value in units of 0.01 ppm. More...
int8_t   reference_power_level
	Reference power level in dBm. More...
enum bt_conn_le_cs_procedure_done_status   procedure_done_status
	Procedure status. More...
enum bt_conn_le_cs_subevent_done_status   subevent_done_status
	Subevent status. More...
enum bt_conn_le_cs_procedure_abort_reason   procedure_abort_reason
	Abort reason. More...
enum bt_conn_le_cs_subevent_abort_reason   subevent_abort_reason
	Abort reason. More...
uint8_t   num_antenna_paths
	Number of antenna paths used during the phase measurement stage. More...
uint8_t   num_steps_reported
	Number of CS steps in the subevent. More...
uint8_t   abort_step
	Step number, on which the subevent was aborted if subevent_done_status is BT_CONN_LE_CS_SUBEVENT_COMPLETE then abort_step will be unused and set to 255. More...
}	header
struct net_buf_simple *	step_data_buf
	Pointer to buffer containing step data.

Detailed Description

Subevent data for LE connections supporting CS.

Field Documentation

abort_step

uint8_t bt_conn_le_cs_subevent_result::abort_step

Step number, on which the subevent was aborted if subevent_done_status is BT_CONN_LE_CS_SUBEVENT_COMPLETE then abort_step will be unused and set to 255.

config_id

uint8_t bt_conn_le_cs_subevent_result::config_id

CS configuration identifier.

Range: 0 to 3

If these results were generated by a CS Test, this value will be set to 0 and has no meaning.

frequency_compensation

uint16_t bt_conn_le_cs_subevent_result::frequency_compensation

Frequency compensation value in units of 0.01 ppm.

This is a 15-bit signed integer in the range [-100, 100] ppm.

A value of BT_HCI_LE_CS_SUBEVENT_RESULT_FREQ_COMPENSATION_NOT_AVAILABLE indicates that the role is not the initiator, or that the frequency compensation value is unavailable.

[struct]

struct { ... } bt_conn_le_cs_subevent_result::header

num_antenna_paths

uint8_t bt_conn_le_cs_subevent_result::num_antenna_paths

Number of antenna paths used during the phase measurement stage.

num_steps_reported

uint8_t bt_conn_le_cs_subevent_result::num_steps_reported

Number of CS steps in the subevent.

procedure_abort_reason

enum bt_conn_le_cs_procedure_abort_reason bt_conn_le_cs_subevent_result::procedure_abort_reason

Abort reason.

If the procedure status is BT_CONN_LE_CS_PROCEDURE_ABORTED, this field will specify the reason for the abortion.

procedure_counter

uint16_t bt_conn_le_cs_subevent_result::procedure_counter

CS procedure count associated with these results.

This is the CS procedure count since the completion of the Channel Sounding Security Start procedure.

procedure_done_status

enum bt_conn_le_cs_procedure_done_status bt_conn_le_cs_subevent_result::procedure_done_status

Procedure status.

reference_power_level

int8_t bt_conn_le_cs_subevent_result::reference_power_level

Reference power level in dBm.

Range: -127 to 20

A value of BT_HCI_LE_CS_REF_POWER_LEVEL_UNAVAILABLE indicates that the reference power level was not available during a subevent.

start_acl_conn_event

uint16_t bt_conn_le_cs_subevent_result::start_acl_conn_event

Starting ACL connection event counter.

If these results were generated by a CS Test, this value will be set to 0 and has no meaning.

step_data_buf

struct net_buf_simple* bt_conn_le_cs_subevent_result::step_data_buf

Pointer to buffer containing step data.

NULL if num_steps_reported is 0.

subevent_abort_reason

enum bt_conn_le_cs_subevent_abort_reason bt_conn_le_cs_subevent_result::subevent_abort_reason

Abort reason.

If the subevent status is BT_CONN_LE_CS_SUBEVENT_ABORTED, this field will specify the reason for the abortion.

subevent_done_status

enum bt_conn_le_cs_subevent_done_status bt_conn_le_cs_subevent_result::subevent_done_status

Subevent status.

For aborted subevents, this will be set to BT_CONN_LE_CS_SUBEVENT_ABORTED and abort_step will contain the step number on which the subevent was aborted. Consider the following example:

subevent_done_status = BT_CONN_LE_CS_SUBEVENT_ABORTED num_steps_reported = 160 abort_step = 100

this would mean that steps from 0 to 99 are complete and steps from 100 to 159 are aborted.

---

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

• zephyr/bluetooth/conn.h