CS ACP#

Channel Sounding (CS) Application Co-Processor (ACP) provides the ACP commands and events to the CS device roles.

Modules#

cs_acp_get_target_config_rsp_t

cs_acp_cmd_t

cs_acp_result_evt_t

cs_acp_intermediate_result_evt_t

cs_acp_extended_result_evt_t

cs_acp_status_t

cs_acp_event_t

cs_acp_cmd_t.data

cs_acp_event_t.data

CS ACP commands#

Command enumerator defines the available ACP commands between the host application and target device.

enum
cs_acp_cmd_id_t {
CS_ACP_CMD_CREATE_INITIATOR = 0
CS_ACP_CMD_CREATE_REFLECTOR = 1
CS_ACP_CMD_INITIATOR_ACTION = 2
CS_ACP_CMD_REFLECTOR_ACTION = 3
CS_ACP_CMD_ANTENNA_CONFIGURE = 4
CS_ACP_CMD_ENABLE_TRACE = 5
CS_ACP_CMD_GET_TARGET_CONFIG = 6
}

ACP initiator actions#

Initiator role related action enumerator.

enum
cs_acp_initiator_action_t {
CS_ACP_ACTION_DELETE_INITIATOR = 0
}

ACP reflector actions#

Reflector role related action enumerator.

enum
cs_acp_reflector_action_t {
CS_ACP_ACTION_DELETE_REFLECTOR = 0
}

CS ACP event enumerator#

Event enumerator defines the available ACP events coming from target device to the host application.

enum
cs_acp_event_id_t {
CS_ACP_EVT_RESULT_ID = 0
CS_ACP_EVT_STATUS_ID = 1
CS_ACP_EVT_INTERMEDIATE_RESULT_ID = 2
CS_ACP_EVT_EXTENDED_RESULT_ID = 3
}

Variables#

uint8_t
target_config_bitfield

Target config bitfield.

uint8_t
max_initiator_instance_count

Maximum initiator instance count.

uint8_t
max_bluetooth_connections

Maximum BLE connections.

cs_acp_cmd_id_t
cmd_id

CS ACP command enumerator.

uint8_t
antenna_config_wired

Antenna configuration for wired offset.

uint8_t
enable_trace

Enable BGAPI trace feature.

union cs_acp_cmd_t::@1
data
uint8_t
type_value_list

Result data in type-value pairs.

float
progress_percentage

Progress percentage.

uint8_t
fragments_left

Number of fragments left.

uint8array
fragment

Content of the fragment.

uint32_t
sc

Status code.

uint8_t
error

Error code.

uint8_t
connection_id

Connection ID.

cs_acp_event_id_t
acp_evt_id

CS ACP event enumerator.

cs_acp_result_evt_t
result

Result event data.

cs_acp_extended_result_evt_t
ext_result

Extended result event data.

cs_acp_status_t
stat

Status change event data.

union cs_acp_event_t::@2
data

Macros#

#define
CS_ACP_FIRST_FRAGMENT_MASK 0x80

The MSB of the fragments_left field indicates the start of a fragmented message.

#define
CS_ACP_FRAGMENTS_LEFT_MASK 0x7F

The remaining bits of the fragments_left field indicate the number of fragments left.

#define
CS_ACP_TARGET_CONFIG_RAS_MODE_BIT_POS 0x00

Bitmask for the RAS mode bit in the target config.

CS ACP commands Documentation#

cs_acp_cmd_id_t#

cs_acp_cmd_id_t
Enumerator
CS_ACP_CMD_CREATE_INITIATOR

Create initiator instance.

CS_ACP_CMD_CREATE_REFLECTOR

Create reflector instance.

CS_ACP_CMD_INITIATOR_ACTION

Initiator action (eg. delete instance)

CS_ACP_CMD_REFLECTOR_ACTION

Reflector action (eg. delete instance)

CS_ACP_CMD_ANTENNA_CONFIGURE

Configure antenna.

CS_ACP_CMD_ENABLE_TRACE

Enable BGAPI trace feature.

CS_ACP_CMD_GET_TARGET_CONFIG

Get ACP target configuration.


ACP initiator actions Documentation#

cs_acp_initiator_action_t#

cs_acp_initiator_action_t
Enumerator
CS_ACP_ACTION_DELETE_INITIATOR

Delete initiator instance.


ACP reflector actions Documentation#

cs_acp_reflector_action_t#

cs_acp_reflector_action_t
Enumerator
CS_ACP_ACTION_DELETE_REFLECTOR

Delete reflector instance.


CS ACP event enumerator Documentation#

cs_acp_event_id_t#

cs_acp_event_id_t
Enumerator
CS_ACP_EVT_RESULT_ID

Result event (includes distance, likeliness etc.)

CS_ACP_EVT_STATUS_ID

Status change event (error, success etc.)

CS_ACP_EVT_INTERMEDIATE_RESULT_ID

Intermediate result event (progress percentage)

CS_ACP_EVT_EXTENDED_RESULT_ID

Extended result event (fragments)


Variable Documentation#

target_config_bitfield#

uint8_t cs_acp_get_target_config_rsp_t::target_config_bitfield

Target config bitfield.


max_initiator_instance_count#

uint8_t cs_acp_get_target_config_rsp_t::max_initiator_instance_count

Maximum initiator instance count.


max_bluetooth_connections#

uint8_t cs_acp_get_target_config_rsp_t::max_bluetooth_connections

Maximum BLE connections.


cmd_id#

cs_acp_cmd_id_t cs_acp_cmd_t::cmd_id

CS ACP command enumerator.


antenna_config_wired#

uint8_t cs_acp_cmd_t::@1::antenna_config_wired

Antenna configuration for wired offset.


enable_trace#

uint8_t cs_acp_cmd_t::@1::enable_trace

Enable BGAPI trace feature.


data#

union cs_acp_cmd_t::@1 cs_acp_cmd_t::data

type_value_list#

uint8_t cs_acp_result_evt_t::type_value_list[CS_RESULT_MAX_BUFFER_SIZE]

Result data in type-value pairs.


progress_percentage#

float cs_acp_intermediate_result_evt_t::progress_percentage

Progress percentage.


fragments_left#

uint8_t cs_acp_extended_result_evt_t::fragments_left

Number of fragments left.


fragment#

uint8array cs_acp_extended_result_evt_t::fragment

Content of the fragment.


sc#

uint32_t cs_acp_status_t::sc

Status code.


error#

uint8_t cs_acp_status_t::error

Error code.


connection_id#

uint8_t cs_acp_event_t::connection_id

Connection ID.


acp_evt_id#

cs_acp_event_id_t cs_acp_event_t::acp_evt_id

CS ACP event enumerator.


result#

cs_acp_result_evt_t cs_acp_event_t::@2::result

Result event data.


intermediate_result#

cs_acp_intermediate_result_evt_t cs_acp_event_t::@2::intermediate_result

Intermediate result event data.


ext_result#

cs_acp_extended_result_evt_t cs_acp_event_t::@2::ext_result

Extended result event data.


stat#

cs_acp_status_t cs_acp_event_t::@2::stat

Status change event data.


data#

union cs_acp_event_t::@2 cs_acp_event_t::data