Zephyr API Documentation  3.7.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
direction.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2020 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_BLUETOOTH_DF_H_
8#define ZEPHYR_INCLUDE_BLUETOOTH_DF_H_
9
10#include <stdint.h>
11
32};
33
38};
39
55};
56
79};
80
104};
105
113};
114
135 union {
138 };
139};
140
154};
155
163};
164
189 union {
192 };
193};
205};
206
224};
225
234int bt_df_set_adv_cte_tx_param(struct bt_le_ext_adv *adv,
235 const struct bt_df_adv_cte_tx_param *params);
236
248int bt_df_adv_cte_tx_enable(struct bt_le_ext_adv *adv);
249
257int bt_df_adv_cte_tx_disable(struct bt_le_ext_adv *adv);
258
270int bt_df_per_adv_sync_cte_rx_enable(struct bt_le_per_adv_sync *sync,
271 const struct bt_df_per_adv_sync_cte_rx_param *params);
272
280int bt_df_per_adv_sync_cte_rx_disable(struct bt_le_per_adv_sync *sync);
281
290int bt_df_conn_cte_rx_enable(struct bt_conn *conn, const struct bt_df_conn_cte_rx_param *params);
291
299int bt_df_conn_cte_rx_disable(struct bt_conn *conn);
300
315int bt_df_set_conn_cte_tx_param(struct bt_conn *conn, const struct bt_df_conn_cte_tx_param *params);
316
327int bt_df_conn_cte_req_enable(struct bt_conn *conn, const struct bt_df_conn_cte_req_params *params);
328
338int bt_df_conn_cte_req_disable(struct bt_conn *conn);
339
349int bt_df_conn_cte_rsp_enable(struct bt_conn *conn);
350
360int bt_df_conn_cte_rsp_disable(struct bt_conn *conn);
361
362#endif /* ZEPHYR_INCLUDE_BLUETOOTH_DF_H_ */
int bt_df_adv_cte_tx_disable(struct bt_le_ext_adv *adv)
Disable transmission of Constant Tone Extension for the given advertising set.
int bt_df_per_adv_sync_cte_rx_enable(struct bt_le_per_adv_sync *sync, const struct bt_df_per_adv_sync_cte_rx_param *params)
Enable receive and sampling of Constant Tone Extension for the given sync set.
bt_df_iq_sample
Definition: direction.h:106
@ BT_DF_IQ_SAMPLE_16_BITS_INT
Reported IQ samples have 16 bits signed integer format.
Definition: direction.h:112
@ BT_DF_IQ_SAMPLE_8_BITS_INT
Reported IQ samples have 8 bits signed integer format.
Definition: direction.h:110
bt_df_antenna_switching_slot
Allowed antenna switching slots: 1 us or 2 us.
Definition: direction.h:35
@ BT_DF_ANTENNA_SWITCHING_SLOT_1US
Definition: direction.h:36
@ BT_DF_ANTENNA_SWITCHING_SLOT_2US
Definition: direction.h:37
int bt_df_conn_cte_rsp_enable(struct bt_conn *conn)
Enable Constant Tone Extension response procedure for a connection.
bt_df_cte_type
Constant Tone Extension (CTE) types.
Definition: direction.h:13
@ BT_DF_CTE_TYPE_NONE
Convenience value for purposes where non of CTE types is allowed.
Definition: direction.h:15
@ BT_DF_CTE_TYPE_AOD_1US
Angle of Departure mode with 1 us antenna switching slots.
Definition: direction.h:23
@ BT_DF_CTE_TYPE_ALL
Convenience value that collects all possible CTE types in one entry.
Definition: direction.h:31
@ BT_DF_CTE_TYPE_AOA
Angle of Arrival mode.
Definition: direction.h:17
@ BT_DF_CTE_TYPE_AOD_2US
Angle of Departure mode with 2 us antenna switching slots.
Definition: direction.h:29
int bt_df_conn_cte_req_enable(struct bt_conn *conn, const struct bt_df_conn_cte_req_params *params)
Enable Constant Tone Extension request procedure for a connection.
int bt_df_conn_cte_rsp_disable(struct bt_conn *conn)
Disable Constant Tone Extension response procedure for a connection.
int bt_df_conn_cte_rx_disable(struct bt_conn *conn)
Disable receive and sampling of Constant Tone Extension for the connection object.
int bt_df_conn_cte_rx_enable(struct bt_conn *conn, const struct bt_df_conn_cte_rx_param *params)
Enable receive and sampling of Constant Tone Extension for the connection object.
bt_df_conn_iq_report_err
Definition: direction.h:156
@ BT_DF_IQ_REPORT_ERR_NO_CTE
Received PDU without CTE.
Definition: direction.h:160
@ BT_DF_IQ_REPORT_ERR_PEER_REJECTED
Peer rejected CTE request.
Definition: direction.h:162
@ BT_DF_IQ_REPORT_ERR_SUCCESS
IQ samples report received successfully.
Definition: direction.h:158
int bt_df_set_conn_cte_tx_param(struct bt_conn *conn, const struct bt_df_conn_cte_tx_param *params)
Set Constant Tone Extension transmission parameters for a connection.
int bt_df_adv_cte_tx_enable(struct bt_le_ext_adv *adv)
Enable transmission of Constant Tone Extension for the given advertising set.
bt_df_packet_status
Possible statuses of PDU that contained reported CTE.
Definition: direction.h:41
@ BT_DF_CTE_CRC_OK
Received PDU had CRC OK.
Definition: direction.h:43
@ BT_DF_CTE_INSUFFICIENT_RESOURCES
There were no sufficient resources to sample CTE.
Definition: direction.h:54
@ BT_DF_CTE_CRC_ERR_CTE_BASED_OTHER
Received PDU had incorrect CRC, but Radio peripheral was able to process sampling of CTE in some othe...
Definition: direction.h:52
@ BT_DF_CTE_CRC_ERR_CTE_BASED_TIME
Received PDU had incorrect CRC, but Radio peripheral was able to parse CTEInfo field of the PDU and p...
Definition: direction.h:48
int bt_df_per_adv_sync_cte_rx_disable(struct bt_le_per_adv_sync *sync)
Disable receive and sampling of Constant Tone Extension for the given sync set.
int bt_df_conn_cte_req_disable(struct bt_conn *conn)
Disable Constant Tone Extension request procedure for a connection.
int bt_df_set_adv_cte_tx_param(struct bt_le_ext_adv *adv, const struct bt_df_adv_cte_tx_param *params)
Set or update the Constant Tone Extension parameters for periodic advertising set.
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition: util_macro.h:44
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
__INT16_TYPE__ int16_t
Definition: stdint.h:73
Constant Tone Extension parameters for connectionless transmission.
Definition: direction.h:63
uint8_t cte_count
Number of CTE to transmit in each periodic adv interval.
Definition: direction.h:74
uint8_t cte_len
Length of CTE in 8us units.
Definition: direction.h:65
uint8_t cte_type
CTE type.
Definition: direction.h:72
uint8_t * ant_ids
List of antenna IDs in the pattern.
Definition: direction.h:78
uint8_t num_ant_ids
Number of Antenna IDs in the switch pattern.
Definition: direction.h:76
Definition: direction.h:207
uint8_t cte_length
Requested length of the CTE in 8 us units.
Definition: direction.h:216
uint16_t interval
Requested interval for initiating the CTE Request procedure.
Definition: direction.h:214
uint8_t cte_type
Requested type of the CTE.
Definition: direction.h:223
Definition: direction.h:141
uint8_t cte_types
Bitfield with allowed CTE types.
Definition: direction.h:147
const uint8_t * ant_ids
Antenna switch pattern.
Definition: direction.h:153
uint8_t num_ant_ids
Length of antenna switch pattern.
Definition: direction.h:151
uint8_t slot_durations
Antenna switching slots (bt_df_antenna_switching_slot).
Definition: direction.h:149
Constant Tone Extension parameters for CTE transmission in connected mode.
Definition: direction.h:195
const uint8_t * ant_ids
Antenna switch pattern.
Definition: direction.h:204
uint8_t num_ant_ids
Number of antenna switch pattern.
Definition: direction.h:202
uint8_t cte_types
Bitfield with allowed CTE types (bt_df_cte_type.
Definition: direction.h:200
Definition: direction.h:165
enum bt_df_iq_sample sample_type
Type of IQ samples provided in a report.
Definition: direction.h:185
uint8_t cte_type
Type of CTE (bt_df_cte_type).
Definition: direction.h:177
struct bt_hci_le_iq_sample16 const * sample16
Definition: direction.h:191
uint8_t slot_durations
Duration of slots when received CTE type is AoA (bt_df_antenna_switching_slot).
Definition: direction.h:179
uint8_t sample_count
Number of IQ samples in report.
Definition: direction.h:187
uint8_t rssi_ant_id
Id of antenna used to measure the RSSI.
Definition: direction.h:175
uint8_t chan_idx
Channel index used to receive PDU with CTE that was sampled.
Definition: direction.h:171
struct bt_hci_le_iq_sample const * sample
Definition: direction.h:190
int16_t rssi
The RSSI of the PDU with CTE (excluding CTE).
Definition: direction.h:173
enum bt_df_conn_iq_report_err err
Report receive failed reason.
Definition: direction.h:167
uint8_t rx_phy
PHY that was used to receive PDU with CTE that was sampled.
Definition: direction.h:169
uint16_t conn_evt_counter
Value of connection event counter when the CTE was received and sampled.
Definition: direction.h:183
uint8_t packet_status
Status of received PDU with CTE (bt_df_packet_status).
Definition: direction.h:181
Constant Tone Extension parameters for connectionless reception.
Definition: direction.h:89
uint8_t cte_types
Bitfield with allowed CTE types.
Definition: direction.h:95
uint8_t slot_durations
Antenna switching slots (bt_df_antenna_switching_slot).
Definition: direction.h:97
uint8_t max_cte_count
Max number of CTEs to receive.
Definition: direction.h:99
const uint8_t * ant_ids
Antenna switch pattern.
Definition: direction.h:103
uint8_t num_ant_ids
Length of antenna switch pattern.
Definition: direction.h:101
Definition: direction.h:115
uint8_t rssi_ant_id
Id of antenna used to measure the RSSI.
Definition: direction.h:121
uint16_t per_evt_counter
Value of the paEventCounter of the AUX_SYNC_IND PDU.
Definition: direction.h:129
int16_t rssi
The RSSI of the PDU with CTE (excluding CTE).
Definition: direction.h:119
uint8_t sample_count
Number of IQ samples in report.
Definition: direction.h:131
struct bt_hci_le_iq_sample const * sample
Definition: direction.h:136
uint8_t packet_status
Status of received PDU with CTE (bt_df_packet_status).
Definition: direction.h:127
enum bt_df_iq_sample sample_type
Type of IQ samples provided in a report.
Definition: direction.h:133
uint8_t cte_type
Type of CTE (bt_df_cte_type).
Definition: direction.h:123
uint8_t slot_durations
Duration of slots when received CTE type is AoA (bt_df_antenna_switching_slot).
Definition: direction.h:125
uint8_t chan_idx
Channel index used to receive PDU with CTE that was sampled.
Definition: direction.h:117
struct bt_hci_le_iq_sample16 const * sample16
Definition: direction.h:137
Definition: hci_vs.h:270
Definition: hci_types.h:2914