Bluetooth HCI APIs

Bluetooth HCI APIs. More...

Data Structures
struct	bt_hci_setup_params
struct	bt_hci_driver_api

Macros
#define	BT_DT_HCI_QUIRK_OR(node_id, prop, idx)   DT_STRING_TOKEN_BY_IDX(node_id, prop, idx)
#define	BT_DT_HCI_QUIRKS_GET(node_id)
#define	BT_DT_HCI_QUIRKS_INST_GET(inst)   BT_DT_HCI_QUIRKS_GET(DT_DRV_INST(inst))
#define	BT_DT_HCI_NAME_GET(node_id)   DT_PROP_OR(node_id, bt_hci_name, "HCI")
#define	BT_DT_HCI_NAME_INST_GET(inst)   BT_DT_HCI_NAME_GET(DT_DRV_INST(inst))
#define	BT_DT_HCI_BUS_GET(node_id)   DT_STRING_TOKEN_OR(node_id, bt_hci_bus, BT_HCI_BUS_VIRTUAL)
#define	BT_DT_HCI_BUS_INST_GET(inst)   BT_DT_HCI_BUS_GET(DT_DRV_INST(inst))

Typedefs
typedef int(*	bt_hci_recv_t) (const struct device *dev, struct net_buf *buf)

Enumerations
enum	{ BT_HCI_QUIRK_NO_RESET = BIT(0) , BT_HCI_QUIRK_NO_AUTO_DLE = BIT(1) }
enum	bt_hci_bus {   BT_HCI_BUS_VIRTUAL = 0 , BT_HCI_BUS_USB = 1 , BT_HCI_BUS_PCCARD = 2 , BT_HCI_BUS_UART = 3 ,   BT_HCI_BUS_RS232 = 4 , BT_HCI_BUS_PCI = 5 , BT_HCI_BUS_SDIO = 6 , BT_HCI_BUS_SPI = 7 ,   BT_HCI_BUS_I2C = 8 , BT_HCI_BUS_IPM = 9 }
	Possible values for the 'bus' member of the bt_hci_driver struct. More...

Functions
static int	bt_hci_open (const struct device *dev, bt_hci_recv_t recv)
	Open the HCI transport.
static int	bt_hci_close (const struct device *dev)
	Close the HCI transport.
static int	bt_hci_send (const struct device *dev, struct net_buf *buf)
	Send HCI buffer to controller.
static int	bt_hci_setup (const struct device *dev, struct bt_hci_setup_params *params)
	HCI vendor-specific setup.

Detailed Description

Bluetooth HCI APIs.

Since

3.7

Version

0.2.0

Macro Definition Documentation

BT_DT_HCI_BUS_GET

#define BT_DT_HCI_BUS_GET

(

node_id

)

DT_STRING_TOKEN_OR(node_id, bt_hci_bus, BT_HCI_BUS_VIRTUAL)

#include <include/zephyr/drivers/bluetooth.h>

BT_DT_HCI_BUS_INST_GET

#define BT_DT_HCI_BUS_INST_GET

(

inst

)

BT_DT_HCI_BUS_GET(DT_DRV_INST(inst))

#include <include/zephyr/drivers/bluetooth.h>

BT_DT_HCI_NAME_GET

#define BT_DT_HCI_NAME_GET

(

node_id

)

DT_PROP_OR(node_id, bt_hci_name, "HCI")

#include <include/zephyr/drivers/bluetooth.h>

BT_DT_HCI_NAME_INST_GET

#define BT_DT_HCI_NAME_INST_GET

(

inst

)

BT_DT_HCI_NAME_GET(DT_DRV_INST(inst))

#include <include/zephyr/drivers/bluetooth.h>

BT_DT_HCI_QUIRK_OR

#define BT_DT_HCI_QUIRK_OR	(		node_id,
			prop,
			idx
	)		DT_STRING_TOKEN_BY_IDX(node_id, prop, idx)

#include <include/zephyr/drivers/bluetooth.h>

BT_DT_HCI_QUIRKS_GET

#define BT_DT_HCI_QUIRKS_GET

(

node_id

)

#include <include/zephyr/drivers/bluetooth.h>

Value:

                                                  COND_CODE_1(DT_NODE_HAS_PROP(node_id, bt_hci_quirks), \
                                                  (DT_FOREACH_PROP_ELEM_SEP(node_id, \
                                                                            bt_hci_quirks, \
                                                                            BT_DT_HCI_QUIRK_OR, \
                                                                            (|))), \
                                                  (0))

BT_DT_HCI_QUIRKS_INST_GET

#define BT_DT_HCI_QUIRKS_INST_GET

(

inst

)

BT_DT_HCI_QUIRKS_GET(DT_DRV_INST(inst))

#include <include/zephyr/drivers/bluetooth.h>

Typedef Documentation

bt_hci_recv_t

typedef int(* bt_hci_recv_t) (const struct device *dev, struct net_buf *buf)

#include <include/zephyr/drivers/bluetooth.h>

Enumeration Type Documentation

anonymous enum

anonymous enum

#include <include/zephyr/drivers/bluetooth.h>

Enumerator
BT_HCI_QUIRK_NO_RESET
BT_HCI_QUIRK_NO_AUTO_DLE

bt_hci_bus

enum bt_hci_bus

#include <include/zephyr/drivers/bluetooth.h>

Possible values for the 'bus' member of the bt_hci_driver struct.

Enumerator
BT_HCI_BUS_VIRTUAL
BT_HCI_BUS_USB
BT_HCI_BUS_PCCARD
BT_HCI_BUS_UART
BT_HCI_BUS_RS232
BT_HCI_BUS_PCI
BT_HCI_BUS_SDIO
BT_HCI_BUS_SPI
BT_HCI_BUS_I2C
BT_HCI_BUS_IPM

Function Documentation

bt_hci_close()

static int bt_hci_close ( const struct device *  dev )

inlinestatic

#include <include/zephyr/drivers/bluetooth.h>

Close the HCI transport.

Closes the HCI transport. This function must not return until the transport is closed.

Parameters

dev	HCI device

Returns

0 on success or negative POSIX error number on failure.

bt_hci_open()

static int bt_hci_open ( const struct device *  dev, bt_hci_recv_t  recv  )

inlinestatic

#include <include/zephyr/drivers/bluetooth.h>

Open the HCI transport.

Opens the HCI transport for operation. This function must not return until the transport is ready for operation, meaning it is safe to start calling the send() handler.

Parameters

dev	HCI device
recv	This is callback through which the HCI driver provides the host with data from the controller. The buffer passed to the callback will have its type set with bt_buf_set_type(). The callback is expected to be called from thread context.

Returns

0 on success or negative POSIX error number on failure.

bt_hci_send()

static int bt_hci_send ( const struct device *  dev, struct net_buf *  buf  )

inlinestatic

#include <include/zephyr/drivers/bluetooth.h>

Send HCI buffer to controller.

Send an HCI packet to the controller. The packet type of the buffer must be set using bt_buf_set_type().

Note

This function must only be called from a cooperative thread.

Parameters

dev	HCI device
buf	Buffer containing data to be sent to the controller.

Returns

0 on success or negative POSIX error number on failure.

bt_hci_setup()

static int bt_hci_setup ( const struct device *  dev, struct bt_hci_setup_params *  params  )

inlinestatic

#include <include/zephyr/drivers/bluetooth.h>

HCI vendor-specific setup.

Executes vendor-specific commands sequence to initialize BT Controller before BT Host executes Reset sequence. This is normally called directly after bt_hci_open().

Note

CONFIG_BT_HCI_SETUP must be selected for this field to be available.

Returns

0 on success or negative POSIX error number on failure.