Bluetooth HCI

Interfaces for Bluetooth Host Controller Interface (HCI). More...

Files
file	bluetooth.h
	Bluetooth HCI driver API.

Data Structures
struct	bt_hci_setup_params
struct	bt_hci_driver_config
	Common Bluetooth HCI driver configuration. More...
struct	bt_hci_driver_data
	Common Bluetooth HCI driver data. More...
struct	bt_hci_driver_api
	@driver_ops{Bluetooth HCI} More...

Macros
#define	BT_DT_HCI_QUIRK_OR(node_id, prop, idx)
#define	BT_DT_HCI_QUIRKS_GET(node_id)
#define	BT_DT_HCI_QUIRKS_INST_GET(inst)
#define	BT_DT_HCI_NAME_GET(node_id)
#define	BT_DT_HCI_NAME_INST_GET(inst)
#define	BT_PRIV_HCI_BUS_DEFAULT   (0)
#define	BT_DT_HCI_BUS_GET(node_id)
#define	BT_DT_HCI_BUS_INST_GET(inst)
#define	BT_DT_HCI_DRIVER_CONFIG_GET(node_id)
	Static initializer for bt_hci_driver_config struct.
#define	BT_DT_HCI_DRIVER_CONFIG_INST_GET(inst)
	Static initializer for bt_hci_driver_config struct from DT_DRV_COMPAT instance.

Enumerations
enum	{ BT_HCI_QUIRK_NO_RESET = BIT(0) , BT_HCI_QUIRK_NO_AUTO_DLE = BIT(1) }

Functions
static int	bt_hci_recv_err (const struct device *dev, struct net_buf *buf)
	Deliver an HCI packet from the driver.
static void	bt_hci_recv (const struct device *dev, struct net_buf *buf)
	Deliver an HCI packet from the driver.
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.
typedef int(*	bt_hci_recv_t) (const struct device *dev, struct net_buf *buf)
	@def_driverbackendgroup{Bluetooth HCI,bt_hci_api}
typedef int(*	bt_hci_api_open_t) (const struct device *dev)
	Callback API to open the HCI transport.
typedef int(*	bt_hci_api_close_t) (const struct device *dev)
	Callback API to close the HCI transport.
typedef int(*	bt_hci_api_send_t) (const struct device *dev, struct net_buf *buf)
	Callback API to send an HCI buffer to the controller.
typedef int(*	bt_hci_api_setup_t) (const struct device *dev, const struct bt_hci_setup_params *param)
	Callback API for HCI vendor-specific setup.

Detailed Description

Interfaces for Bluetooth Host Controller Interface (HCI).

Since

3.7

Version

0.2.0

Macro Definition Documentation

BT_DT_HCI_BUS_GET

#define BT_DT_HCI_BUS_GET

(

node_id

)

#include <bluetooth.h>

Value:

DT_ENUM_IDX_OR(node_id, bt_hci_bus, BT_PRIV_HCI_BUS_DEFAULT)

BT_DT_HCI_BUS_INST_GET

#define BT_DT_HCI_BUS_INST_GET

(

inst

)

#include <bluetooth.h>

Value:

BT_DT_HCI_BUS_GET(DT_DRV_INST(inst))

BT_DT_HCI_DRIVER_CONFIG_GET

#define BT_DT_HCI_DRIVER_CONFIG_GET

(

node_id

)

#include <bluetooth.h>

Value:

{                                                                                       \
        .quirks = (uint32_t)BT_DT_HCI_QUIRKS_GET(node_id),                                \
}

Static initializer for bt_hci_driver_config struct.

Parameters

node_id

Devicetree node identifier

BT_DT_HCI_DRIVER_CONFIG_INST_GET

#define BT_DT_HCI_DRIVER_CONFIG_INST_GET

(

inst

)

#include <bluetooth.h>

Value:

BT_DT_HCI_DRIVER_CONFIG_GET(DT_DRV_INST(inst))

Static initializer for bt_hci_driver_config struct from DT_DRV_COMPAT instance.

Parameters

inst	DT_DRV_COMPAT instance number

See also

BT_DT_HCI_DRIVER_CONFIG_GET()

BT_DT_HCI_NAME_GET

#define BT_DT_HCI_NAME_GET

(

node_id

)

#include <bluetooth.h>

Value:

DT_PROP_OR(node_id, bt_hci_name, "HCI")

BT_DT_HCI_NAME_INST_GET

#define BT_DT_HCI_NAME_INST_GET

(

inst

)

#include <bluetooth.h>

Value:

BT_DT_HCI_NAME_GET(DT_DRV_INST(inst))

BT_DT_HCI_QUIRK_OR

#define BT_DT_HCI_QUIRK_OR	(		node_id,
			prop,
			idx )

#include <bluetooth.h>

Value:

UTIL_CAT(BT_HCI_QUIRK_, DT_STRING_UPPER_TOKEN_BY_IDX(node_id, prop, idx))

BT_DT_HCI_QUIRKS_GET

#define BT_DT_HCI_QUIRKS_GET

(

node_id

)

#include <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

)

#include <bluetooth.h>

Value:

BT_DT_HCI_QUIRKS_GET(DT_DRV_INST(inst))

BT_PRIV_HCI_BUS_DEFAULT

#define BT_PRIV_HCI_BUS_DEFAULT   (0)

#include <bluetooth.h>

Typedef Documentation

bt_hci_api_close_t

typedef int(* bt_hci_api_close_t) (const struct device *dev)

#include <bluetooth.h>

Callback API to close the HCI transport.

See bt_hci_close() for argument description

bt_hci_api_open_t

typedef int(* bt_hci_api_open_t) (const struct device *dev)

#include <bluetooth.h>

Callback API to open the HCI transport.

See bt_hci_open() for argument description

bt_hci_api_send_t

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

#include <bluetooth.h>

Callback API to send an HCI buffer to the controller.

See bt_hci_send() for argument description

bt_hci_api_setup_t

typedef int(* bt_hci_api_setup_t) (const struct device *dev, const struct bt_hci_setup_params *param)

#include <bluetooth.h>

Callback API for HCI vendor-specific setup.

See bt_hci_setup() for argument description

bt_hci_recv_t

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

#include <bluetooth.h>

@def_driverbackendgroup{Bluetooth HCI,bt_hci_api}

Deliver HCI data from the controller to the host

Registered with bt_hci_open(). The HCI driver invokes this callback from thread context.

Enumeration Type Documentation

anonymous enum

anonymous enum

#include <bluetooth.h>

Enumerator
BT_HCI_QUIRK_NO_RESET
BT_HCI_QUIRK_NO_AUTO_DLE

Function Documentation

bt_hci_close()

int bt_hci_close ( const struct device * dev )

inlinestatic

#include <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()

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

inlinestatic

#include <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 callback is expected to be called from thread context, and it may be called already before bt_hci_open() returns.

Returns

0 on success or negative POSIX error number on failure.

Return values

-EALREADY

The HCI transport is already open.

bt_hci_recv()

void bt_hci_recv ( const struct device * dev, struct net_buf * buf )

inlinestatic

#include <bluetooth.h>

Deliver an HCI packet from the driver.

This function is the same as bt_hci_recv_err except that it will internally handle error situations and always consume the buffer reference.

Parameters

dev	HCI device
buf	Buffer containing data received from the controller.

bt_hci_recv_err()

int bt_hci_recv_err ( const struct device * dev, struct net_buf * buf )

inlinestatic

#include <bluetooth.h>

Deliver an HCI packet from the driver.

This function is called by the HCI driver to deliver data received from the controller to the host. The buffer contains the raw HCI packet, including the packet type prefix encoded in the H:4 format.

If the function returns 0 (success) the reference to buf was moved to the higher layer (e.g. host stack). On error, the caller (HCI driver) still owns the reference and is responsible for eventually calling net_buf_unref on it.

Parameters

dev	HCI device
buf	Buffer containing data received from the controller.

Returns

0 on success or negative POSIX error number on failure.

Return values

-ENOTCONN

The HCI transport is not open.

bt_hci_send()

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

inlinestatic

#include <bluetooth.h>

Send HCI buffer to controller.

Send an HCI packet to the controller. The packet type is encoded as H:4, i.e. the UART transport encoding, as a prefix to the actual payload. This means that HCI drivers that use H:4 as their native encoding don't need to do any special handling of the packet type.

If the function returns 0 (success) the reference to buf was moved to the HCI driver. On error, the caller still owns the reference and is responsible for eventually calling net_buf_unref on it.

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()

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

inlinestatic

#include <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.