hci_driver.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2015-2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_HCI_DRIVER_H_
#define ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_HCI_DRIVER_H_
 
#include <stdbool.h>
#include <zephyr/net/buf.h>
#include <zephyr/bluetooth/buf.h>
#include <zephyr/bluetooth/hci_vs.h>
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum {
        /* The host should never send HCI_Reset */
        BT_QUIRK_NO_RESET = BIT(0),
        /* The controller does not auto-initiate a DLE procedure when the
         * initial connection data length parameters are not equal to the
         * default data length parameters. Therefore the host should initiate
         * the DLE procedure after connection establishment. */
        BT_QUIRK_NO_AUTO_DLE = BIT(1),
};
 
#define IS_BT_QUIRK_NO_AUTO_DLE(bt_dev) ((bt_dev)->drv->quirks & BT_QUIRK_NO_AUTO_DLE)
 
/* @brief The HCI event shall be given to bt_recv_prio */
#define BT_HCI_EVT_FLAG_RECV_PRIO BIT(0)
/* @brief  The HCI event shall be given to bt_recv. */
#define BT_HCI_EVT_FLAG_RECV      BIT(1)
 
static inline uint8_t bt_hci_evt_get_flags(uint8_t evt)
{
        switch (evt) {
        case BT_HCI_EVT_DISCONN_COMPLETE:
                return BT_HCI_EVT_FLAG_RECV | BT_HCI_EVT_FLAG_RECV_PRIO;
                /* fallthrough */
#if defined(CONFIG_BT_CONN) || defined(CONFIG_BT_ISO)
        case BT_HCI_EVT_NUM_COMPLETED_PACKETS:
#if defined(CONFIG_BT_CONN)
        case BT_HCI_EVT_DATA_BUF_OVERFLOW:
                __fallthrough;
#endif /* defined(CONFIG_BT_CONN) */
#endif /* CONFIG_BT_CONN ||  CONFIG_BT_ISO */
        case BT_HCI_EVT_CMD_COMPLETE:
        case BT_HCI_EVT_CMD_STATUS:
                return BT_HCI_EVT_FLAG_RECV_PRIO;
        default:
                return BT_HCI_EVT_FLAG_RECV;
        }
}
 
int bt_recv(struct net_buf *buf);
 
int bt_recv_prio(struct net_buf *buf);
 
uint8_t bt_read_static_addr(struct bt_hci_vs_static_addr addrs[], uint8_t size);
 
enum bt_hci_driver_bus {
        BT_HCI_DRIVER_BUS_VIRTUAL       = 0,
        BT_HCI_DRIVER_BUS_USB           = 1,
        BT_HCI_DRIVER_BUS_PCCARD        = 2,
        BT_HCI_DRIVER_BUS_UART          = 3,
        BT_HCI_DRIVER_BUS_RS232         = 4,
        BT_HCI_DRIVER_BUS_PCI           = 5,
        BT_HCI_DRIVER_BUS_SDIO          = 6,
        BT_HCI_DRIVER_BUS_SPI           = 7,
        BT_HCI_DRIVER_BUS_I2C           = 8,
        BT_HCI_DRIVER_BUS_IPM           = 9,
};
 
struct bt_hci_driver {
        const char *name;
 
        enum bt_hci_driver_bus bus;
 
        uint32_t quirks;
 
        int (*open)(void);
 
        int (*close)(void);
 
        int (*send)(struct net_buf *buf);
 
#if defined(CONFIG_BT_HCI_SETUP) || defined(__DOXYGEN__)
        int (*setup)(void);
#endif /* defined(CONFIG_BT_HCI_SETUP) || defined(__DOXYGEN__)*/
};
 
int bt_hci_driver_register(const struct bt_hci_driver *drv);
 
int bt_hci_transport_setup(const struct device *dev);
 
int bt_hci_transport_teardown(const struct device *dev);
 
struct net_buf *bt_hci_evt_create(uint8_t evt, uint8_t len);
 
struct net_buf *bt_hci_cmd_complete_create(uint16_t op, uint8_t plen);
 
struct net_buf *bt_hci_cmd_status_create(uint16_t op, uint8_t status);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_BLUETOOTH_HCI_DRIVER_H_ */