// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #include #include #include #include #include "esp_heap_caps_init.h" #include "freertos/FreeRTOS.h" #include "freertos/task.h" #include "freertos/queue.h" #include "freertos/semphr.h" #include "freertos/xtensa_api.h" #include "freertos/portmacro.h" #include "esp_types.h" #include "esp_system.h" #include "esp_task.h" #include "esp_intr.h" #include "esp_attr.h" #include "esp_phy_init.h" #include "bt.h" #include "esp_err.h" #include "esp_log.h" #if CONFIG_BT_ENABLED #define BTDM_LOG_TAG "BTDM_INIT" #define BTDM_INIT_PERIOD (5000) /* ms */ /* Bluetooth system and controller config */ #define BTDM_CFG_BT_DATA_RELEASE (1<<0) #define BTDM_CFG_HCI_UART (1<<1) #define BTDM_CFG_CONTROLLER_RUN_APP_CPU (1<<2) /* Other reserved for future */ /* not for user call, so don't put to include file */ extern void btdm_osi_funcs_register(void *osi_funcs); extern int btdm_controller_init(uint32_t config_mask, esp_bt_controller_config_t *config_opts); extern int btdm_controller_deinit(void); extern int btdm_controller_enable(esp_bt_mode_t mode); extern int btdm_controller_disable(esp_bt_mode_t mode); extern uint8_t btdm_controller_get_mode(void); extern void btdm_rf_bb_init(void); /* VHCI function interface */ typedef struct 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*/ } vhci_host_callback_t; extern bool API_vhci_host_check_send_available(void); extern void API_vhci_host_send_packet(uint8_t *data, uint16_t len); extern void API_vhci_host_register_callback(const vhci_host_callback_t *callback); extern int ble_txpwr_set(int power_type, int power_level); extern int ble_txpwr_get(int power_type); extern char _bss_start_btdm; extern char _bss_end_btdm; extern char _data_start_btdm; extern char _data_end_btdm; extern uint32_t _data_start_btdm_rom; extern uint32_t _data_end_btdm_rom; #define BT_DEBUG(...) #define BT_API_CALL_CHECK(info, api_call, ret) \ do{\ esp_err_t __err = (api_call);\ if ((ret) != __err) {\ BT_DEBUG("%s %d %s ret=%d\n", __FUNCTION__, __LINE__, (info), __err);\ return __err;\ }\ } while(0) #define OSI_FUNCS_TIME_BLOCKING 0xffffffff typedef struct { esp_bt_mode_t mode; intptr_t start; intptr_t end; } btdm_dram_available_region_t; /* the mode column will be modifid by release function to indicate the available region */ static btdm_dram_available_region_t btdm_dram_available_region[] = { //following is .data {ESP_BT_MODE_BTDM, 0x3ffae6e0, 0x3ffaff10}, //following is memory which HW will use {ESP_BT_MODE_BTDM, 0x3ffb0000, 0x3ffb09a8}, {ESP_BT_MODE_BLE, 0x3ffb09a8, 0x3ffb1ddc}, {ESP_BT_MODE_BTDM, 0x3ffb1ddc, 0x3ffb2730}, {ESP_BT_MODE_CLASSIC_BT, 0x3ffb2730, 0x3ffb8000}, //following is .bss {ESP_BT_MODE_BTDM, 0x3ffb8000, 0x3ffbbb28}, {ESP_BT_MODE_CLASSIC_BT, 0x3ffbbb28, 0x3ffbdb28}, {ESP_BT_MODE_BTDM, 0x3ffbdb28, 0x3ffc0000}, }; struct osi_funcs_t { xt_handler (*_set_isr)(int n, xt_handler f, void *arg); void (*_ints_on)(unsigned int mask); void (*_interrupt_disable)(void); void (*_interrupt_restore)(void); void (*_task_yield)(void); void (*_task_yield_from_isr)(void); void *(*_semphr_create)(uint32_t max, uint32_t init); void (*_semphr_delete)(void *semphr); int32_t (*_semphr_take_from_isr)(void *semphr, void *hptw); int32_t (*_semphr_give_from_isr)(void *semphr, void *hptw); int32_t (*_semphr_take)(void *semphr, uint32_t block_time_ms); int32_t (*_semphr_give)(void *semphr); void *(*_mutex_create)(void); void (*_mutex_delete)(void *mutex); int32_t (*_mutex_lock)(void *mutex); int32_t (*_mutex_unlock)(void *mutex); void *(* _queue_create)(uint32_t queue_len, uint32_t item_size); void (* _queue_delete)(void *queue); int32_t (* _queue_send)(void *queue, void *item, uint32_t block_time_ms); int32_t (* _queue_send_from_isr)(void *queue, void *item, void *hptw); int32_t (* _queue_recv)(void *queue, void *item, uint32_t block_time_ms); int32_t (* _queue_recv_from_isr)(void *queue, void *item, void *hptw); int32_t (* _task_create)(void *task_func, const char *name, uint32_t stack_depth, void *param, uint32_t prio, void *task_handle, uint32_t core_id); void (* _task_delete)(void *task_handle); bool (* _is_in_isr)(void); void *(* _malloc)(uint32_t size); void (* _free)(void *p); int32_t (* _read_efuse_mac)(uint8_t mac[6]); void (* _srand)(unsigned int seed); int (* _rand)(void); }; /* Static variable declare */ static bool btdm_bb_init_flag = false; static esp_bt_controller_status_t btdm_controller_status = ESP_BT_CONTROLLER_STATUS_IDLE; static portMUX_TYPE global_int_mux = portMUX_INITIALIZER_UNLOCKED; static void IRAM_ATTR interrupt_disable(void) { portENTER_CRITICAL(&global_int_mux); } static void IRAM_ATTR interrupt_restore(void) { portEXIT_CRITICAL(&global_int_mux); } static void IRAM_ATTR task_yield_from_isr(void) { portYIELD_FROM_ISR(); } static void *IRAM_ATTR semphr_create_wrapper(uint32_t max, uint32_t init) { return (void *)xSemaphoreCreateCounting(max, init); } static void IRAM_ATTR semphr_delete_wrapper(void *semphr) { vSemaphoreDelete(semphr); } static int32_t IRAM_ATTR semphr_take_from_isr_wrapper(void *semphr, void *hptw) { return (int32_t)xSemaphoreTakeFromISR(semphr, hptw); } static int32_t IRAM_ATTR semphr_give_from_isr_wrapper(void *semphr, void *hptw) { return (int32_t)xSemaphoreGiveFromISR(semphr, hptw); } static int32_t IRAM_ATTR semphr_take_wrapper(void *semphr, uint32_t block_time_ms) { if (block_time_ms == OSI_FUNCS_TIME_BLOCKING) { return (int32_t)xSemaphoreTake(semphr, portMAX_DELAY); } else { return (int32_t)xSemaphoreTake(semphr, block_time_ms / portTICK_PERIOD_MS); } } static int32_t IRAM_ATTR semphr_give_wrapper(void *semphr) { return (int32_t)xSemaphoreGive(semphr); } static void *IRAM_ATTR mutex_create_wrapper(void) { return (void *)xSemaphoreCreateMutex(); } static void IRAM_ATTR mutex_delete_wrapper(void *mutex) { vSemaphoreDelete(mutex); } static int32_t IRAM_ATTR mutex_lock_wrapper(void *mutex) { return (int32_t)xSemaphoreTake(mutex, portMAX_DELAY); } static int32_t IRAM_ATTR mutex_unlock_wrapper(void *mutex) { return (int32_t)xSemaphoreGive(mutex); } static void *IRAM_ATTR queue_create_wrapper(uint32_t queue_len, uint32_t item_size) { return (void *)xQueueCreate(queue_len, item_size); } static void IRAM_ATTR queue_delete_wrapper(void *queue) { vQueueDelete(queue); } static int32_t IRAM_ATTR queue_send_wrapper(void *queue, void *item, uint32_t block_time_ms) { if (block_time_ms == OSI_FUNCS_TIME_BLOCKING) { return (int32_t)xQueueSend(queue, item, portMAX_DELAY); } else { return (int32_t)xQueueSend(queue, item, block_time_ms / portTICK_PERIOD_MS); } } static int32_t IRAM_ATTR queue_send_from_isr_wrapper(void *queue, void *item, void *hptw) { return (int32_t)xQueueSendFromISR(queue, item, hptw); } static int32_t IRAM_ATTR queue_recv_wrapper(void *queue, void *item, uint32_t block_time_ms) { if (block_time_ms == OSI_FUNCS_TIME_BLOCKING) { return (int32_t)xQueueReceive(queue, item, portMAX_DELAY); } else { return (int32_t)xQueueReceive(queue, item, block_time_ms / portTICK_PERIOD_MS); } } static int32_t IRAM_ATTR queue_recv_from_isr_wrapper(void *queue, void *item, void *hptw) { return (int32_t)xQueueReceiveFromISR(queue, item, hptw); } static int32_t IRAM_ATTR task_create_wrapper(void *task_func, const char *name, uint32_t stack_depth, void *param, uint32_t prio, void *task_handle, uint32_t core_id) { return (uint32_t)xTaskCreatePinnedToCore(task_func, name, stack_depth, param, prio, task_handle, (core_id < portNUM_PROCESSORS ? core_id : tskNO_AFFINITY)); } static void IRAM_ATTR task_delete_wrapper(void *task_handle) { vTaskDelete(task_handle); } static bool IRAM_ATTR is_in_isr_wrapper(void) { return (bool)xPortInIsrContext(); } static int32_t IRAM_ATTR read_mac_wrapper(uint8_t mac[6]) { return esp_read_mac(mac, ESP_MAC_BT); } static void IRAM_ATTR srand_wrapper(unsigned int seed) { /* empty function */ } static int IRAM_ATTR rand_wrapper(void) { return (int)esp_random(); } static struct osi_funcs_t osi_funcs = { ._set_isr = xt_set_interrupt_handler, ._ints_on = xt_ints_on, ._interrupt_disable = interrupt_disable, ._interrupt_restore = interrupt_restore, ._task_yield = vPortYield, ._task_yield_from_isr = task_yield_from_isr, ._semphr_create = semphr_create_wrapper, ._semphr_delete = semphr_delete_wrapper, ._semphr_take_from_isr = semphr_take_from_isr_wrapper, ._semphr_give_from_isr = semphr_give_from_isr_wrapper, ._semphr_take = semphr_take_wrapper, ._semphr_give = semphr_give_wrapper, ._mutex_create = mutex_create_wrapper, ._mutex_delete = mutex_delete_wrapper, ._mutex_lock = mutex_lock_wrapper, ._mutex_unlock = mutex_unlock_wrapper, ._queue_create = queue_create_wrapper, ._queue_delete = queue_delete_wrapper, ._queue_send = queue_send_wrapper, ._queue_send_from_isr = queue_send_from_isr_wrapper, ._queue_recv = queue_recv_wrapper, ._queue_recv_from_isr = queue_recv_from_isr_wrapper, ._task_create = task_create_wrapper, ._task_delete = task_delete_wrapper, ._is_in_isr = is_in_isr_wrapper, ._malloc = malloc, ._free = free, ._read_efuse_mac = read_mac_wrapper, ._srand = srand_wrapper, ._rand = rand_wrapper, }; bool esp_vhci_host_check_send_available(void) { return API_vhci_host_check_send_available(); } void esp_vhci_host_send_packet(uint8_t *data, uint16_t len) { API_vhci_host_send_packet(data, len); } void esp_vhci_host_register_callback(const esp_vhci_host_callback_t *callback) { API_vhci_host_register_callback((const vhci_host_callback_t *)callback); } static uint32_t btdm_config_mask_load(void) { uint32_t mask = 0x0; if (btdm_dram_available_region[0].mode == ESP_BT_MODE_BLE) { mask |= BTDM_CFG_BT_DATA_RELEASE; } #ifdef CONFIG_BT_HCI_UART mask |= BTDM_CFG_HCI_UART; #endif #ifdef CONFIG_BTDM_CONTROLLER_RUN_APP_CPU mask |= BTDM_CFG_CONTROLLER_RUN_APP_CPU; #endif return mask; } static void btdm_controller_mem_init(void) { /* initialise .bss, .data and .etc section */ memcpy(&_data_start_btdm, (void *)_data_start_btdm_rom, &_data_end_btdm - &_data_start_btdm); ESP_LOGD(BTDM_LOG_TAG, ".data initialise [0x%08x] <== [0x%08x]\n", (uint32_t)&_data_start_btdm, _data_start_btdm_rom); for (int i = 1; i < sizeof(btdm_dram_available_region)/sizeof(btdm_dram_available_region_t); i++) { if (btdm_dram_available_region[i].mode != ESP_BT_MODE_IDLE) { memset((void *)btdm_dram_available_region[i].start, 0x0, btdm_dram_available_region[i].end - btdm_dram_available_region[i].start); ESP_LOGD(BTDM_LOG_TAG, ".bss initialise [0x%08x] - [0x%08x]\n", btdm_dram_available_region[i].start, btdm_dram_available_region[i].end); } } } esp_err_t esp_bt_controller_mem_release(esp_bt_mode_t mode) { bool update = true; intptr_t mem_start, mem_end; //get the mode which can be released, skip the mode which is running mode &= ~btdm_controller_get_mode(); if (mode == 0x0) { return ESP_ERR_INVALID_ARG; } //already relesed if (!(mode & btdm_dram_available_region[0].mode)) { return ESP_ERR_INVALID_STATE; } for (int i = 0; i < sizeof(btdm_dram_available_region)/sizeof(btdm_dram_available_region_t); i++) { //skip the share mode, idle mode and other mode if (btdm_dram_available_region[i].mode == ESP_BT_MODE_IDLE || (mode & btdm_dram_available_region[i].mode) != btdm_dram_available_region[i].mode) { //clear the bit of the mode which will be released btdm_dram_available_region[i].mode &= ~mode; continue; } else { //clear the bit of the mode which will be released btdm_dram_available_region[i].mode &= ~mode; } if (update) { mem_start = btdm_dram_available_region[i].start; mem_end = btdm_dram_available_region[i].end; update = false; } if (i < sizeof(btdm_dram_available_region)/sizeof(btdm_dram_available_region_t) - 1) { mem_end = btdm_dram_available_region[i].end; if (btdm_dram_available_region[i+1].mode != ESP_BT_MODE_IDLE && (mode & btdm_dram_available_region[i+1].mode) == btdm_dram_available_region[i+1].mode && mem_end == btdm_dram_available_region[i+1].start) { continue; } else { ESP_LOGD(BTDM_LOG_TAG, "Release DRAM [0x%08x] - [0x%08x]\n", mem_start, mem_end); ESP_ERROR_CHECK( heap_caps_add_region(mem_start, mem_end)); update = true; } } else { mem_end = btdm_dram_available_region[i].end; ESP_LOGD(BTDM_LOG_TAG, "Release DRAM [0x%08x] - [0x%08x]\n", mem_start, mem_end); ESP_ERROR_CHECK( heap_caps_add_region(mem_start, mem_end)); update = true; } } return ESP_OK; } esp_err_t esp_bt_controller_init(esp_bt_controller_config_t *cfg) { BaseType_t ret; uint32_t btdm_cfg_mask = 0; if (btdm_controller_status != ESP_BT_CONTROLLER_STATUS_IDLE) { return ESP_ERR_INVALID_STATE; } //if all the bt available memory was already released, cannot initialize bluetooth controller if (btdm_dram_available_region[0].mode == ESP_BT_MODE_IDLE) { return ESP_ERR_INVALID_STATE; } if (cfg == NULL) { return ESP_ERR_INVALID_ARG; } if (cfg->controller_task_prio != ESP_TASK_BT_CONTROLLER_PRIO || cfg->controller_task_stack_size < ESP_TASK_BT_CONTROLLER_STACK) { return ESP_ERR_INVALID_ARG; } btdm_osi_funcs_register(&osi_funcs); btdm_controller_mem_init(); btdm_cfg_mask = btdm_config_mask_load(); ret = btdm_controller_init(btdm_cfg_mask, cfg); if (ret) { return ESP_ERR_NO_MEM; } btdm_controller_status = ESP_BT_CONTROLLER_STATUS_INITED; return ESP_OK; } esp_err_t esp_bt_controller_deinit(void) { if (btdm_controller_status != ESP_BT_CONTROLLER_STATUS_INITED) { return ESP_ERR_INVALID_STATE; } if (btdm_controller_deinit() != 0) { return ESP_ERR_NO_MEM; } btdm_controller_status = ESP_BT_CONTROLLER_STATUS_SHUTDOWN; return ESP_OK; } esp_err_t esp_bt_controller_enable(esp_bt_mode_t mode) { int ret; if (btdm_controller_status != ESP_BT_CONTROLLER_STATUS_INITED) { return ESP_ERR_INVALID_STATE; } //check the mode is available mode if (mode & ~btdm_dram_available_region[0].mode) { return ESP_ERR_INVALID_ARG; } esp_phy_load_cal_and_init(); if (btdm_bb_init_flag == false) { btdm_bb_init_flag = true; btdm_rf_bb_init(); /* only initialise once */ } ret = btdm_controller_enable(mode); if (ret) { return ESP_ERR_INVALID_STATE; } btdm_controller_status = ESP_BT_CONTROLLER_STATUS_ENABLED; return ESP_OK; } esp_err_t esp_bt_controller_disable(void) { int ret; if (btdm_controller_status != ESP_BT_CONTROLLER_STATUS_ENABLED) { return ESP_ERR_INVALID_STATE; } ret = btdm_controller_disable(btdm_controller_get_mode()); if (ret < 0) { return ESP_ERR_INVALID_STATE; } if (ret == ESP_BT_MODE_IDLE) { esp_phy_rf_deinit(); btdm_controller_status = ESP_BT_CONTROLLER_STATUS_INITED; } return ESP_OK; } esp_bt_controller_status_t esp_bt_controller_get_status(void) { return btdm_controller_status; } /* extra functions */ esp_err_t esp_ble_tx_power_set(esp_ble_power_type_t power_type, esp_power_level_t power_level) { if (ble_txpwr_set(power_type, power_level) != 0) { return ESP_ERR_INVALID_ARG; } return ESP_OK; } esp_power_level_t esp_ble_tx_power_get(esp_ble_power_type_t power_type) { return (esp_power_level_t)ble_txpwr_get(power_type); } #endif /* CONFIG_BT_ENABLED */