Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bluetooth.h
Go to the documentation of this file.
1
8#ifndef ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_H_
9#define ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_H_
10
22#include <stdbool.h>
23#include <stdint.h>
24#include <zephyr/net_buf.h>
28#include <zephyr/device.h>
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
41
42enum {
43 /* The host should never send HCI_Reset */
45 /* The controller does not auto-initiate a DLE procedure when the
46 * initial connection data length parameters are not equal to the
47 * default data length parameters. Therefore the host should initiate
48 * the DLE procedure after connection establishment.
49 *
50 * That requirement is stated in Core Spec v5.4 Vol 6 Part B. 4.5.10
51 * Data PDU length management:
52 *
53 * > For a new connection:
54 * > - ... If either value is not 27, then the Controller should
55 * > initiate the Data Length Update procedure at the earliest
56 * > practical opportunity.
57 */
59};
60
78
79#define BT_DT_HCI_QUIRK_OR(node_id, prop, idx) \
80 UTIL_CAT(BT_HCI_QUIRK_, DT_STRING_UPPER_TOKEN_BY_IDX(node_id, prop, idx))
81#define BT_DT_HCI_QUIRKS_GET(node_id) COND_CODE_1(DT_NODE_HAS_PROP(node_id, bt_hci_quirks), \
82 (DT_FOREACH_PROP_ELEM_SEP(node_id, \
83 bt_hci_quirks, \
84 BT_DT_HCI_QUIRK_OR, \
85 (|))), \
86 (0))
87#define BT_DT_HCI_QUIRKS_INST_GET(inst) BT_DT_HCI_QUIRKS_GET(DT_DRV_INST(inst))
88
89#define BT_DT_HCI_NAME_GET(node_id) DT_PROP_OR(node_id, bt_hci_name, "HCI")
90#define BT_DT_HCI_NAME_INST_GET(inst) BT_DT_HCI_NAME_GET(DT_DRV_INST(inst))
91
92#define BT_DT_HCI_BUS_GET(node_id) \
93 UTIL_CAT(BT_HCI_BUS_, DT_STRING_UPPER_TOKEN_OR(node_id, bt_hci_bus, VIRTUAL))
94#define BT_DT_HCI_BUS_INST_GET(inst) BT_DT_HCI_BUS_GET(DT_DRV_INST(inst))
95
96typedef int (*bt_hci_recv_t)(const struct device *dev, struct net_buf *buf);
97
98__subsystem struct bt_hci_driver_api {
99 int (*open)(const struct device *dev, bt_hci_recv_t recv);
100 int (*close)(const struct device *dev);
101 int (*send)(const struct device *dev, struct net_buf *buf);
102#if defined(CONFIG_BT_HCI_SETUP)
103 int (*setup)(const struct device *dev,
104 const struct bt_hci_setup_params *param);
105#endif /* defined(CONFIG_BT_HCI_SETUP) */
106};
107
123static inline int bt_hci_open(const struct device *dev, bt_hci_recv_t recv)
124{
125 const struct bt_hci_driver_api *api = (const struct bt_hci_driver_api *)dev->api;
126
127 return api->open(dev, recv);
128}
129
140static inline int bt_hci_close(const struct device *dev)
141{
142 const struct bt_hci_driver_api *api = (const struct bt_hci_driver_api *)dev->api;
143
144 if (api->close == NULL) {
145 return -ENOSYS;
146 }
147
148 return api->close(dev);
149}
150
164static inline int bt_hci_send(const struct device *dev, struct net_buf *buf)
165{
166 const struct bt_hci_driver_api *api = (const struct bt_hci_driver_api *)dev->api;
167
168 return api->send(dev, buf);
169}
170
171#if defined(CONFIG_BT_HCI_SETUP) || defined(__DOXYGEN__)
184static inline int bt_hci_setup(const struct device *dev, struct bt_hci_setup_params *params)
185{
186 const struct bt_hci_driver_api *api = (const struct bt_hci_driver_api *)dev->api;
187
188 if (api->setup == NULL) {
189 return -ENOSYS;
190 }
191
192 return api->setup(dev, params);
193}
194#endif
195
200/* The following functions are not strictly part of the HCI driver API, in that
201 * they do not take as input a struct device which implements the HCI driver API.
202 */
203
215int bt_hci_transport_setup(const struct device *dev);
216
228int bt_hci_transport_teardown(const struct device *dev);
229
242
256
270
271#ifdef __cplusplus
272}
273#endif
274
275#endif /* ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_H_ */
Bluetooth device address definitions and utilities.
Bluetooth data buffer API.
struct net_buf * bt_hci_evt_create(uint8_t evt, uint8_t len)
Allocate an HCI event buffer.
struct net_buf * bt_hci_cmd_complete_create(uint16_t op, uint8_t plen)
Allocate an HCI Command Complete event buffer.
struct net_buf * bt_hci_cmd_status_create(uint16_t op, uint8_t status)
Allocate an HCI Command Status event buffer.
int bt_hci_transport_setup(const struct device *dev)
Setup the HCI transport, which usually means to reset the Bluetooth IC.
int bt_hci_transport_teardown(const struct device *dev)
Teardown the HCI transport.
static ssize_t recv(int sock, void *buf, size_t max_len, int flags)
POSIX wrapper for zsock_recv.
Definition socket.h:873
static int bt_hci_setup(const struct device *dev, struct bt_hci_setup_params *params)
HCI vendor-specific setup.
Definition bluetooth.h:184
static int bt_hci_send(const struct device *dev, struct net_buf *buf)
Send HCI buffer to controller.
Definition bluetooth.h:164
int(* bt_hci_recv_t)(const struct device *dev, struct net_buf *buf)
Definition bluetooth.h:96
bt_hci_bus
Possible values for the 'bus' member of the bt_hci_driver struct.
Definition bluetooth.h:62
static int bt_hci_open(const struct device *dev, bt_hci_recv_t recv)
Open the HCI transport.
Definition bluetooth.h:123
static int bt_hci_close(const struct device *dev)
Close the HCI transport.
Definition bluetooth.h:140
@ BT_HCI_BUS_VIRTUAL
Definition bluetooth.h:63
@ BT_HCI_BUS_USB
Definition bluetooth.h:64
@ BT_HCI_BUS_IPM
Definition bluetooth.h:76
@ BT_HCI_BUS_PCCARD
Definition bluetooth.h:65
@ BT_HCI_BUS_VIRTIO
Definition bluetooth.h:73
@ BT_HCI_BUS_SPI
Definition bluetooth.h:70
@ BT_HCI_BUS_UART
Definition bluetooth.h:66
@ BT_HCI_BUS_IPC
Definition bluetooth.h:74
@ BT_HCI_BUS_PCI
Definition bluetooth.h:68
@ BT_HCI_BUS_RS232
Definition bluetooth.h:67
@ BT_HCI_BUS_SDIO
Definition bluetooth.h:69
@ BT_HCI_BUS_I2C
Definition bluetooth.h:71
@ BT_HCI_BUS_SMD
Definition bluetooth.h:72
@ BT_HCI_QUIRK_NO_AUTO_DLE
Definition bluetooth.h:58
@ BT_HCI_QUIRK_NO_RESET
Definition bluetooth.h:44
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define ENOSYS
Function not implemented.
Definition errno.h:82
Buffer management.
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Bluetooth Device Address.
Definition addr.h:40
Definition bluetooth.h:98
int(* open)(const struct device *dev, bt_hci_recv_t recv)
Definition bluetooth.h:99
int(* close)(const struct device *dev)
Definition bluetooth.h:100
int(* send)(const struct device *dev, struct net_buf *buf)
Definition bluetooth.h:101
Definition bluetooth.h:34
bt_addr_t public_addr
The public identity address to give to the controller.
Definition bluetooth.h:39
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:418
Network buffer representation.
Definition net_buf.h:1006
uint16_t len
Length of the data behind the data pointer.
Definition net_buf.h:1035