mirror of
https://github.com/espressif/esp-idf.git
synced 2026-09-22 13:01:16 +03:00
367 lines
18 KiB
C
367 lines
18 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2026 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef __ESP_BT_H__
|
|
#define __ESP_BT_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
#include "sdkconfig.h"
|
|
#include "esp_task.h"
|
|
#include "esp_assert.h"
|
|
|
|
#include "btdm_user_cfg.h"
|
|
|
|
#if SOC_BT_CLASSIC_SUPPORTED
|
|
#include "../../common/btdm_bredr.h"
|
|
#endif // SOC_BT_CLASSIC_SUPPORTED
|
|
|
|
#ifdef CONFIG_BT_LE_HCI_INTERFACE_USE_UART
|
|
#include "driver/uart.h"
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Bluetooth mode for controller enable/disable.
|
|
*/
|
|
typedef enum {
|
|
ESP_BT_MODE_IDLE = 0x00, /*!< Bluetooth is not running */
|
|
ESP_BT_MODE_BLE = 0x01, /*!< Run BLE mode */
|
|
ESP_BT_MODE_CLASSIC_BT = 0x02, /*!< Run Classic BT mode */
|
|
ESP_BT_MODE_BTDM = 0x03, /*!< Run dual mode */
|
|
} esp_bt_mode_t;
|
|
|
|
/**
|
|
* @brief Bluetooth controller enable/disable/initialised/de-initialised status.
|
|
*/
|
|
typedef enum {
|
|
ESP_BT_CONTROLLER_STATUS_IDLE = 0, /*!< Controller is in idle state */
|
|
ESP_BT_CONTROLLER_STATUS_INITED, /*!< Controller is in initialising state */
|
|
ESP_BT_CONTROLLER_STATUS_ENABLED, /*!< Controller is in enabled state */
|
|
ESP_BT_CONTROLLER_STATUS_NUM, /*!< Controller is in disabled state */
|
|
} esp_bt_controller_status_t;
|
|
|
|
/**
|
|
* @brief BLE tx power type
|
|
* ESP_BLE_PWR_TYPE_CONN_HDL0-8: for each connection, and only be set after connection completed.
|
|
* when disconnect, the correspond TX power is not effected.
|
|
* ESP_BLE_PWR_TYPE_ADV : for advertising/scan response.
|
|
* ESP_BLE_PWR_TYPE_SCAN : for scan.
|
|
* ESP_BLE_PWR_TYPE_DEFAULT : if each connection's TX power is not set, it will use this default value.
|
|
* if neither in scan mode nor in adv mode, it will use this default value.
|
|
* If none of power type is set, system will use ESP_PWR_LVL_P3 as default for ADV/SCAN/CONN0-9.
|
|
*/
|
|
typedef enum esp_ble_power_type {
|
|
ESP_BLE_PWR_TYPE_CONN_HDL0 = 0, /*!< For connection handle 0 */
|
|
ESP_BLE_PWR_TYPE_CONN_HDL1 = 1, /*!< For connection handle 1 */
|
|
ESP_BLE_PWR_TYPE_CONN_HDL2 = 2, /*!< For connection handle 2 */
|
|
ESP_BLE_PWR_TYPE_CONN_HDL3 = 3, /*!< For connection handle 3 */
|
|
ESP_BLE_PWR_TYPE_CONN_HDL4 = 4, /*!< For connection handle 4 */
|
|
ESP_BLE_PWR_TYPE_CONN_HDL5 = 5, /*!< For connection handle 5 */
|
|
ESP_BLE_PWR_TYPE_CONN_HDL6 = 6, /*!< For connection handle 6 */
|
|
ESP_BLE_PWR_TYPE_CONN_HDL7 = 7, /*!< For connection handle 7 */
|
|
ESP_BLE_PWR_TYPE_CONN_HDL8 = 8, /*!< For connection handle 8 */
|
|
ESP_BLE_PWR_TYPE_ADV = 9, /*!< For advertising */
|
|
ESP_BLE_PWR_TYPE_SCAN = 10, /*!< For scan */
|
|
ESP_BLE_PWR_TYPE_DEFAULT = 11, /*!< For default, if not set other, it will use default value */
|
|
ESP_BLE_PWR_TYPE_NUM = 12, /*!< TYPE numbers */
|
|
} esp_ble_power_type_t;
|
|
|
|
/**
|
|
* @brief Bluetooth TX power level(index), it's just a index corresponding to power(dbm).
|
|
*/
|
|
typedef enum esp_power_level {
|
|
ESP_PWR_LVL_N24 = 0, /*!< Corresponding to -24dbm */
|
|
ESP_PWR_LVL_N21 = 1, /*!< Corresponding to -21dbm */
|
|
ESP_PWR_LVL_N18 = 2, /*!< Corresponding to -18dbm */
|
|
ESP_PWR_LVL_N15 = 3, /*!< Corresponding to -15dbm */
|
|
ESP_PWR_LVL_N12 = 4, /*!< Corresponding to -12dbm */
|
|
ESP_PWR_LVL_N9 = 5, /*!< Corresponding to -9dbm */
|
|
ESP_PWR_LVL_N6 = 6, /*!< Corresponding to -6dbm */
|
|
ESP_PWR_LVL_N3 = 7, /*!< Corresponding to -3dbm */
|
|
ESP_PWR_LVL_N0 = 8, /*!< Corresponding to 0dbm */
|
|
ESP_PWR_LVL_P3 = 9, /*!< Corresponding to +3dbm */
|
|
ESP_PWR_LVL_P6 = 10, /*!< Corresponding to +6dbm */
|
|
ESP_PWR_LVL_P9 = 11, /*!< Corresponding to +9dbm */
|
|
ESP_PWR_LVL_P12 = 12, /*!< Corresponding to +12dbm */
|
|
ESP_PWR_LVL_P15 = 13, /*!< Corresponding to +15dbm */
|
|
ESP_PWR_LVL_P16 = 14, /*!< Corresponding to +16dbm */
|
|
ESP_PWR_LVL_P17 = 15, /*!< Corresponding to +17dbm */
|
|
ESP_PWR_LVL_P18 = 16, /*!< Corresponding to +18dbm */
|
|
ESP_PWR_LVL_P19 = 17, /*!< Corresponding to +19dbm */
|
|
ESP_PWR_LVL_P20 = 18, /*!< Corresponding to +20dbm */
|
|
ESP_PWR_LVL_INVALID = 0xFF, /*!< Indicates an invalid value */
|
|
} esp_power_level_t;
|
|
|
|
/**
|
|
* @brief Address type and address value.
|
|
*/
|
|
typedef struct {
|
|
uint8_t type; /*!< Type of the Bluetooth address (public, random, etc.) */
|
|
uint8_t val[6]; /*!< Array containing the 6-byte Bluetooth address value */
|
|
} esp_ble_addr_t;
|
|
|
|
#if SOC_BLE_SUPPORTED
|
|
#include "../../common/btdm_le.h"
|
|
#endif /* SOC_BLE_SUPPORTED */
|
|
|
|
#define BTDM_CONFIG_VERSION 0x20260911
|
|
#define BTDM_CONFIG_MAGIC_VALUE 0x5a5aa5a5
|
|
|
|
/* Types definition
|
|
************************************************************************
|
|
*/
|
|
|
|
/**
|
|
* @brief BTDM controller common configuration options
|
|
*/
|
|
typedef struct {
|
|
uint32_t version; /*!< Version number of the defined structure */
|
|
uint16_t task_stack_size; /*!< Size of Bluetooth controller task stack */
|
|
uint8_t task_prio; /*!< Priority of the Bluetooth controller task */
|
|
uint8_t task_run_cpu; /*!< CPU number on which the Bluetooth controller task runs */
|
|
uint8_t hci_cmd_num; /*!< HCI command buffer number */
|
|
uint8_t nonblocking_cmd_buf; /*!< Non-blocking mode for command buffer allocation */
|
|
uint8_t sleep_en; /*!< Enable sleep functionality */
|
|
uint8_t version_num; /*!< Hardware version number of this chip */
|
|
uint8_t bluetooth_mode; /*!< Controller mode: BR/EDR, BLE or Dual Mode */
|
|
uint32_t magic; /*!< Magic number for configuration validation */
|
|
} esp_bt_ctrl_btdm_config_t;
|
|
|
|
/**
|
|
* @brief Controller config options, depend on config mask.
|
|
* Config mask indicate which functions enabled, this means
|
|
* some options or parameters of some functions enabled by config mask.
|
|
*/
|
|
typedef struct {
|
|
esp_bt_ctrl_le_config_t ble; /*!< Bluetooth LE controller configuration options */
|
|
#if SOC_BT_CLASSIC_SUPPORTED
|
|
esp_bt_ctrl_bredr_config_t bredr; /*!< Bluetooth Classic controller configuration options */
|
|
#endif // SOC_BT_CLASSIC_SUPPORTED
|
|
esp_bt_ctrl_btdm_config_t btdm; /*!< Bluetooth controller common configuration options */
|
|
} esp_bt_controller_config_t;
|
|
|
|
#if defined(CONFIG_BTDM_CTRL_MODE_BLE_ONLY)
|
|
#define BTDM_CONTROLLER_MODE_EFF ESP_BT_MODE_BLE
|
|
#elif defined(CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY)
|
|
#define BTDM_CONTROLLER_MODE_EFF ESP_BT_MODE_CLASSIC_BT
|
|
#else
|
|
#define BTDM_CONTROLLER_MODE_EFF ESP_BT_MODE_BTDM
|
|
#endif // defined(CONFIG_BTDM_CTRL_MODE_BLE_ONLY)
|
|
|
|
#if SOC_BT_CLASSIC_SUPPORTED
|
|
#define BT_CONTROLLER_INIT_CONFIG_DEFAULT() \
|
|
{ \
|
|
.ble = _BT_CTRL_LE_INIT_CONFIG_DEFAULT(), \
|
|
.bredr = _BT_CTRL_BREDR_INIT_CONFIG_DEFAULT(), \
|
|
.btdm = \
|
|
{ \
|
|
.version = BTDM_CONFIG_VERSION, \
|
|
.task_stack_size = UC_BT_CTRL_TASK_STACK_SIZE, \
|
|
.task_prio = ESP_TASK_BT_CONTROLLER_PRIO, \
|
|
.task_run_cpu = CONFIG_BT_CTRL_PINNED_TO_CORE, \
|
|
.hci_cmd_num = CONFIG_BT_CTRL_HCI_CMD_NUM, \
|
|
.nonblocking_cmd_buf = UC_BT_CTRL_NONBLOCK_CMD_BUF, \
|
|
.sleep_en = UC_BT_CTRL_SLEEP_ENABLE, \
|
|
.version_num = 0, \
|
|
.bluetooth_mode = BTDM_CONTROLLER_MODE_EFF, \
|
|
.magic = BTDM_CONFIG_MAGIC_VALUE, \
|
|
}, \
|
|
}
|
|
#else
|
|
#define BT_CONTROLLER_INIT_CONFIG_DEFAULT() \
|
|
{ \
|
|
.ble = _BT_CTRL_LE_INIT_CONFIG_DEFAULT(), \
|
|
.btdm = \
|
|
{ \
|
|
.version = BTDM_CONFIG_VERSION, \
|
|
.task_stack_size = UC_BT_CTRL_TASK_STACK_SIZE, \
|
|
.task_prio = ESP_TASK_BT_CONTROLLER_PRIO, \
|
|
.task_run_cpu = CONFIG_BT_CTRL_PINNED_TO_CORE, \
|
|
.hci_cmd_num = CONFIG_BT_CTRL_HCI_CMD_NUM, \
|
|
.nonblocking_cmd_buf = UC_BT_CTRL_NONBLOCK_CMD_BUF, \
|
|
.sleep_en = UC_BT_CTRL_SLEEP_ENABLE, \
|
|
.version_num = 0, \
|
|
.bluetooth_mode = BTDM_CONTROLLER_MODE_EFF, \
|
|
.magic = BTDM_CONFIG_MAGIC_VALUE, \
|
|
}, \
|
|
}
|
|
#endif // SOC_BT_CLASSIC_SUPPORTED
|
|
|
|
/**
|
|
* @brief Initialize BT controller to allocate task and other resource.
|
|
* This function should be called only once, before any other BT functions are called.
|
|
* @param cfg: Initial configuration of BT controller. Different from previous version, there's a mode and some
|
|
* connection configuration in "cfg" to configure controller work mode and allocate the resource which is needed.
|
|
* @return ESP_OK - success, other - failed
|
|
*/
|
|
esp_err_t esp_bt_controller_init(esp_bt_controller_config_t *cfg);
|
|
|
|
/**
|
|
* @brief Get BT controller is initialised/de-initialised/enabled/disabled
|
|
* @return status value
|
|
*/
|
|
esp_bt_controller_status_t esp_bt_controller_get_status(void);
|
|
|
|
/**
|
|
* @brief De-initialize BT controller to free resource and delete task.
|
|
* You should stop advertising and scanning, as well as
|
|
* disconnect all existing connections before de-initializing BT controller.
|
|
*
|
|
* This function should be called only once, after any other BT functions are called.
|
|
* This function is not whole completed, esp_bt_controller_init cannot called after this function.
|
|
* @return ESP_OK - success, other - failed
|
|
*/
|
|
esp_err_t esp_bt_controller_deinit(void);
|
|
|
|
/**
|
|
* @brief Enable BT controller.
|
|
* Due to a known issue, you cannot call esp_bt_controller_enable() a second time
|
|
* to change the controller mode dynamically. To change controller mode, call
|
|
* esp_bt_controller_disable() and then call esp_bt_controller_enable() with the new mode.
|
|
* @param mode : the mode(BLE/BT/BTDM) to enable. For compatible of API, retain this argument. This mode must be
|
|
* equal as the mode in "cfg" of esp_bt_controller_init().
|
|
* @return ESP_OK - success, other - failed
|
|
*/
|
|
esp_err_t esp_bt_controller_enable(esp_bt_mode_t mode);
|
|
|
|
/**
|
|
* @brief Disable BT controller
|
|
* @return ESP_OK - success, other - failed
|
|
*/
|
|
esp_err_t esp_bt_controller_disable(void);
|
|
|
|
#if (UC_BT_CTRL_BR_EDR_IS_ENABLE)
|
|
/**
|
|
* @brief Get the BR/EDR TX power range (in dBm) actually supported by this chip.
|
|
*
|
|
* The TX power range configurable in menuconfig represents the maximum possible range.
|
|
* The values that can actually be applied depend on the chip and are reported by this function.
|
|
*
|
|
* @param[out] min_power : pointer to store the minimum supported TX power in dBm
|
|
* @param[out] max_power : pointer to store the maximum supported TX power in dBm
|
|
* @return
|
|
* - ESP_OK: success
|
|
* - ESP_ERR_INVALID_ARG: invalid argument
|
|
* - ESP_ERR_NOT_SUPPORTED: not supported
|
|
*/
|
|
esp_err_t esp_bredr_tx_power_range_get(int8_t *min_power, int8_t *max_power);
|
|
#endif // (UC_BT_CTRL_BR_EDR_IS_ENABLE)
|
|
|
|
/** @brief esp_vhci_host_callback
|
|
* used for vhci call host function to notify what host need to do
|
|
*/
|
|
typedef struct esp_vhci_host_callback {
|
|
void (*notify_host_send_available)(void); /*!< callback used to notify that the host can send packet to controller */
|
|
int (*notify_host_recv)(uint8_t *data, uint16_t len); /*!< callback used to notify that the controller has a packet to send to the host*/
|
|
} esp_vhci_host_callback_t;
|
|
|
|
/** @brief esp_vhci_host_check_send_available
|
|
* used for check actively if the host can send packet to controller or not.
|
|
* @return true for ready to send, false means cannot send packet
|
|
*/
|
|
bool esp_vhci_host_check_send_available(void);
|
|
|
|
/** @brief esp_vhci_host_send_packet
|
|
* host send packet to controller
|
|
*
|
|
* Should not call this function from within a critical section
|
|
* or when the scheduler is suspended.
|
|
*
|
|
* @param data the packet point
|
|
* @param len the packet length
|
|
*/
|
|
void esp_vhci_host_send_packet(uint8_t *data, uint16_t len);
|
|
|
|
/** @brief esp_vhci_host_register_callback
|
|
* register the vhci reference callback
|
|
* struct defined by vhci_host_callback structure.
|
|
* @param callback esp_vhci_host_callback type variable
|
|
* @return ESP_OK - success, ESP_FAIL - failed
|
|
*/
|
|
esp_err_t esp_vhci_host_register_callback(const esp_vhci_host_callback_t *callback);
|
|
|
|
/** @brief esp_bt_controller_mem_release
|
|
* release the controller memory as per the mode
|
|
*
|
|
* This function releases the BSS, data and other sections of the controller to heap. The total size is about 70k bytes.
|
|
*
|
|
* esp_bt_controller_mem_release(mode) should be called only before esp_bt_controller_init()
|
|
* or after esp_bt_controller_deinit().
|
|
*
|
|
* Note that once BT controller memory is released, the process cannot be reversed. It means you cannot use the bluetooth
|
|
* mode which you have released by this function.
|
|
*
|
|
* If your firmware will later upgrade the Bluetooth controller mode (BLE -> BT Classic or disabled -> enabled)
|
|
* then do not call this function.
|
|
*
|
|
* If the app calls esp_bt_controller_enable(ESP_BT_MODE_BLE) to use BLE only then it is safe to call
|
|
* esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT) at initialization time to free unused BT Classic memory.
|
|
*
|
|
* If the mode is ESP_BT_MODE_BTDM, then it may be useful to call API esp_bt_mem_release(ESP_BT_MODE_BTDM) instead,
|
|
* which internally calls esp_bt_controller_mem_release(ESP_BT_MODE_BTDM) and additionally releases the BSS and data
|
|
* consumed by the BT/BLE host stack to heap. For more details about usage please refer to the documentation of
|
|
* esp_bt_mem_release() function
|
|
*
|
|
* @param mode : the mode want to release memory
|
|
* @return ESP_OK - success, other - failed
|
|
*/
|
|
esp_err_t esp_bt_controller_mem_release(esp_bt_mode_t mode);
|
|
|
|
/** @brief esp_bt_mem_release
|
|
* release controller memory and BSS and data section of the BT/BLE host stack as per the mode
|
|
*
|
|
* This function first releases controller memory by internally calling esp_bt_controller_mem_release().
|
|
* Additionally, if the mode is set to ESP_BT_MODE_BTDM, it also releases the BSS and data consumed by the BT/BLE host stack to heap
|
|
*
|
|
* Note that once BT memory is released, the process cannot be reversed. It means you cannot use the bluetooth
|
|
* mode which you have released by this function.
|
|
*
|
|
* If your firmware will later upgrade the Bluetooth controller mode (BLE -> BT Classic or disabled -> enabled)
|
|
* then do not call this function.
|
|
*
|
|
* If you never intend to use bluetooth in a current boot-up cycle, you can call esp_bt_mem_release(ESP_BT_MODE_BTDM)
|
|
* before esp_bt_controller_init or after esp_bt_controller_deinit.
|
|
*
|
|
* For example, if a user only uses bluetooth for setting the WiFi configuration, and does not use bluetooth in the rest of the product operation".
|
|
* In such cases, after receiving the WiFi configuration, you can disable/deinit bluetooth and release its memory.
|
|
* Below is the sequence of APIs to be called for such scenarios:
|
|
*
|
|
* esp_bluedroid_disable();
|
|
* esp_bluedroid_deinit();
|
|
* esp_bt_controller_disable();
|
|
* esp_bt_controller_deinit();
|
|
* esp_bt_mem_release(ESP_BT_MODE_BTDM);
|
|
*
|
|
* @param mode : the mode whose memory is to be released
|
|
* @return ESP_OK - success, other - failed
|
|
*/
|
|
esp_err_t esp_bt_mem_release(esp_bt_mode_t mode);
|
|
|
|
/**
|
|
* @brief Returns random static address or -1 if not present.
|
|
* @return ESP_OK - success, other - failed
|
|
*/
|
|
extern int esp_ble_hw_get_static_addr(esp_ble_addr_t *addr);
|
|
|
|
#if CONFIG_BT_LE_CONTROLLER_LOG_ENABLED
|
|
/**
|
|
* @brief dump all log information cached in buffers.
|
|
* @param output : true for log dump, false will take no effect
|
|
*/
|
|
void esp_ble_controller_log_dump_all(bool output);
|
|
#endif // CONFIG_BT_LE_CONTROLLER_LOG_ENABLED
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ESP_BT_H__ */
|