Controller && VHCI

Overview

Instructions

Application Example

Check bluetooth folder in ESP-IDF examples, which contains the following application:

  • This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising - bluetooth/ble_adv.

API Reference

Header File

Functions

esp_err_t esp_ble_tx_power_set(esp_ble_power_type_t power_type, esp_power_level_t power_level)

Set BLE TX power Connection Tx power should only be set after connection created.

Return
ESP_OK - success, other - failed
Parameters
  • power_type: : The type of which tx power, could set Advertising/Connection/Default and etc
  • power_level: Power level(index) corresponding to absolute value(dbm)

esp_power_level_t esp_ble_tx_power_get(esp_ble_power_type_t power_type)

Get BLE TX power Connection Tx power should only be get after connection created.

Return
>= 0 - Power level, < 0 - Invalid
Parameters
  • power_type: : The type of which tx power, could set Advertising/Connection/Default and etc

esp_err_t esp_bt_controller_init(esp_bt_controller_config_t *cfg)

Initialize BT controller to allocate task and other resource.

Return
ESP_OK - success, other - failed
Parameters
  • cfg: Initial configuration of BT controller. This function should be called only once, before any other BT functions are called.

esp_err_t esp_bt_controller_deinit(void)

De-initialize BT controller to free resource and delete task.

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_enable(esp_bt_mode_t mode)

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.

Return
ESP_OK - success, other - failed
Parameters
  • mode: : the mode(BLE/BT/BTDM) to enable.

esp_err_t esp_bt_controller_disable(void)

Disable BT controller.

Return
ESP_OK - success, other - failed

esp_bt_controller_status_t esp_bt_controller_get_status(void)

Get BT controller is initialised/de-initialised/enabled/disabled.

Return
status value

bool esp_vhci_host_check_send_available(void)

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

void esp_vhci_host_send_packet(uint8_t *data, uint16_t len)

esp_vhci_host_send_packet host send packet to controller

Parameters
  • data: the packet point ,
  • len: the packet length

void esp_vhci_host_register_callback(const esp_vhci_host_callback_t *callback)

esp_vhci_host_register_callback register the vhci referece callback, the call back struct defined by vhci_host_callback structure.

Parameters

esp_err_t esp_bt_controller_mem_release(esp_bt_mode_t mode)

esp_bt_controller_mem_release release the memory by mode, if never use the bluetooth mode it can release the .bbs, .data and other section to heap. The total size is about 70k bytes.

If esp_bt_controller_enable(mode) has already been called, calling esp_bt_controller_mem_release(ESP_BT_MODE_BTDM) will automatically release all memory which is not needed for the currently enabled Bluetooth controller mode.

For example, calling esp_bt_controller_enable(ESP_BT_MODE_BLE) then esp_bt_controller_mem_release(ESP_BT_MODE_BTDM) will enable BLE modes and release memory only used by BT Classic. Also, call esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT) is the same.

Note that once BT controller memory is released, the process cannot be reversed. If your firmware will later upgrade the Bluetooth controller mode (BLE -> BT Classic or disabled -> enabled) then do not call this function.

If user never use bluetooth controller, could call esp_bt_controller_mem_release(ESP_BT_MODE_BTDM) before esp_bt_controller_init or after esp_bt_controller_deinit.

For example, user only use bluetooth to config SSID and PASSWORD of WIFI, after config, will never use bluetooth. Then, could call esp_bt_controller_mem_release(ESP_BT_MODE_BTDM) after esp_bt_controller_deinit.

Return
ESP_OK - success, other - failed
Parameters
  • mode: : the mode want to release memory

Structures

struct esp_bt_controller_config_t

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.

Public Members

uint16_t controller_task_stack_size

Bluetooth controller task stack size

uint8_t controller_task_prio

Bluetooth controller task priority

uint8_t hci_uart_no

If use UART1/2 as HCI IO interface, indicate UART number

uint32_t hci_uart_baudrate

If use UART1/2 as HCI IO interface, indicate UART baudrate

struct esp_vhci_host_callback

esp_vhci_host_callback used for vhci call host function to notify what host need to do

Public Members

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

Macros

BT_CONTROLLER_INIT_CONFIG_DEFAULT

Type Definitions

typedef struct esp_vhci_host_callback esp_vhci_host_callback_t

esp_vhci_host_callback used for vhci call host function to notify what host need to do

Enumerations

enum esp_bt_mode_t

Bluetooth mode for controller enable/disable.

Values:

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

enum esp_bt_controller_status_t

Bluetooth controller enable/disable/initialised/de-initialised status.

Values:

ESP_BT_CONTROLLER_STATUS_IDLE = 0
ESP_BT_CONTROLLER_STATUS_INITED
ESP_BT_CONTROLLER_STATUS_ENABLED
ESP_BT_CONTROLLER_STATUS_NUM
enum esp_ble_power_type_t

BLE tx power type ESP_BLE_PWR_TYPE_CONN_HDL0-8: for each connection, and only be set after connetion 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_P1 as default for ADV/SCAN/CONN0-9.

Values:

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

enum esp_power_level_t

Bluetooth TX power level(index), it’s just a index corresponding to power(dbm).

Values:

ESP_PWR_LVL_N14 = 0

Corresponding to -14dbm

ESP_PWR_LVL_N11 = 1

Corresponding to -11dbm

ESP_PWR_LVL_N8 = 2

Corresponding to -8dbm

ESP_PWR_LVL_N5 = 3

Corresponding to -5dbm

ESP_PWR_LVL_N2 = 4

Corresponding to -2dbm

ESP_PWR_LVL_P1 = 5

Corresponding to 1dbm

ESP_PWR_LVL_P4 = 6

Corresponding to 4dbm

ESP_PWR_LVL_P7 = 7

Corresponding to 7dbm