 |
nrfxlib API 3.3.99
|
|
nrfxlib API 3.3.99
|
LE CS Subevent Result. More...
#include <sdc_hci_cmd_le.h>
Data Fields | |
| uint16_t | conn_handle |
| uint8_t | config_id |
| uint16_t | start_acl_conn_event_counter |
| uint16_t | procedure_counter |
| uint16_t | frequency_compensation |
| int8_t | reference_power_level |
| uint8_t | procedure_done_status |
| uint8_t | subevent_done_status |
| uint8_t | abort_reason |
| uint8_t | num_antenna_paths |
| uint8_t | num_steps_reported |
| uint8_t | data [] |
LE CS Subevent Result.
The description below is extracted from Core_v6.3, Vol 4, Part E, Section 7.7.65.44
This event shall be generated when the local Controller has results to report for a CS subevent during the CS procedure. Depending on the number of CS steps in the CS subevent, the Controller may choose to report complete or partial results. When the number of CS steps exceeds the maximum HCI event size, the Controller may report further results for the CS subevent using the HCI_LE_CS_Subevent_Result_Continue event.
When Connection_Handle is set to 0x0FFF, the Config_ID and Start_ACL_Conn_- Event_Counter parameters shall be ignored.
The Start_ACL_Conn_Event_Counter parameter indicates the starting ACL connection event count from which the CS event results reported in this HCI event are anchored. A CS procedure may have CS subevents in multiple ACL connection events anchored to the same ACL connection event count as defined by the Event_Interval return parameter in the HCI_LE_CS_Procedure_Enable_Complete event.
The Procedure_Counter parameter indicates the associated CS procedure count for the results reported in this HCI event (see [Vol 6] Part B, Section 5.1.26). The Frequency_Compensation parameter indicates the value of the fractional frequency offset (FFO) used by the initiator device to align the timing of CS steps and transmit frequencies during non-mode-0 CS steps (see FFORX* in [Vol 6] Part A, Section 3.5.1).
The Reference_Power_Level parameter is expressed in dBm and is described in [Vol 6] Part H, Section 4.6 and [Vol 6] Part H, Section 3.3.1. If the reference power level value is not available during a subevent, then this value shall be set to 0x7F.
When bits 0 to 3 of Subevent_Done_Status are set to 0x1, the Controller shall send one or more LE CS Subevent Result Continue events for the current CS subevent. Otherwise, the Controller sends no further events for the current CS subevent.
When bits 0 to 3 of Procedure_Done_Status are set to 0x1, the Controller shall send one or more LE CS Subevent Result or LE CS Subevent Result Continue events for the current or subsequent CS procedure. Otherwise, the Controller sends no further events for the current CS procedure. When bits 0 to 3 of Procedure_Done_Status are set to 0xF or when results of all CS procedures are sent to the Host, the Controller sends no further events until a new CS procedure is enabled by the Host.
The allowed combinations of Procedure_Done_Status and Subevent_Done_Status are shown in Table 7.2.
Procedure_Done_Status Allowed values of Subevent_Done_Status (Bits 0 to 3) (Bits 0 to 3) 0x0 0x0, 0xF 0x1 0x0, 0x1, 0xF 0xF 0x0, 0xF Table 7.2: Allowed combinations of done status
The Num_Antenna_Paths parameter indicates the number of antenna paths used for CS tone exchanges.
The Num_Steps_Reported parameter indicates the number of CS steps for which results are reported. The Step_Mode[i] parameter indicates the CS mode for each CS step, and the Step_Channel[i] parameter indicates the channel used for each CS step. A Controller may return a value 0 when a subevent is aborted.
The Step_Data_Length[i] and Step_Data[i] parameters indicate the reported data that varies based on the CS mode and the CS role of the local device. When Step_Data_Length[i] is set to zero, it indicates that the Step may have been aborted for unspecified reasons. Otherwise, the Step_Data[i] indicates the mode- and role-specific information being reported.
For each CS procedure in a repeat sequence, the Controller shall report the results for each CS step in each CS subevent of the CS procedure even if the CS step has been aborted for any reason. In order to terminate reporting of pending CS steps in a CS subevent, the Controller shall set the Subevent_Done_Status parameter to 0xF in the HCI_LE_CS_Subevent_Result or the HCI_LE_CS_Subevent_Result_Continue event and shall not report any additional HCI_LE_CS_Subevent_Result_Continue events for that CS subevent. The Controller may terminate reporting of pending CS procedures by setting the Procedure_Done_Status parameter to 0xF in the HCI_LE_CS_Subevent_Result or the HCI_LE_CS_Subevent_Result_Continue event and shall not report any additional HCI_LE_CS_Subevent_Result_Continue events for that CS procedure.
1.12.0