1 /******************************************************************************
3 * Copyright (C) 2009-2012 Broadcom Corporation
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 ******************************************************************************/
19 /******************************************************************************
21 * Filename: bte_main.c
23 * Description: Contains BTE core stack initialization and shutdown code
25 ******************************************************************************/
31 #include <hardware/bluetooth.h>
39 #include "bt_hci_bdroid.h"
41 /*******************************************************************************
43 *******************************************************************************/
45 /* Run-time configuration file */
46 #ifndef BTE_STACK_CONF_FILE
47 #define BTE_STACK_CONF_FILE "/etc/bluetooth/bt_stack.conf"
49 /* Run-time configuration file for BLE*/
50 #ifndef BTE_BLE_STACK_CONF_FILE
51 #define BTE_BLE_STACK_CONF_FILE "/etc/bluetooth/ble_stack.conf"
54 /* if not specified in .txt file then use this as default */
55 #ifndef HCI_LOGGING_FILENAME
56 #define HCI_LOGGING_FILENAME "/data/misc/bluedroid/btsnoop_hci.log"
59 /* Stack preload process timeout period */
60 #ifndef PRELOAD_START_TIMEOUT_MS
61 #define PRELOAD_START_TIMEOUT_MS 3000 // 3 seconds
64 /* Stack preload process maximum retry attempts */
65 #ifndef PRELOAD_MAX_RETRY_ATTEMPTS
66 #define PRELOAD_MAX_RETRY_ATTEMPTS 0
69 /*******************************************************************************
70 ** Local type definitions
71 *******************************************************************************/
72 /* Preload retry control block */
76 BOOLEAN timer_created;
78 } bt_preload_retry_cb_t;
80 /******************************************************************************
82 ******************************************************************************/
83 BOOLEAN hci_logging_enabled = FALSE; /* by default, turn hci log off */
84 BOOLEAN hci_logging_config = FALSE; /* configured from bluetooth framework */
85 BOOLEAN hci_save_log = FALSE; /* save a copy of the log before starting again */
86 char hci_logfile[256] = HCI_LOGGING_FILENAME;
88 /*******************************************************************************
90 *******************************************************************************/
91 static bt_hc_interface_t *bt_hc_if=NULL;
92 static const bt_hc_callbacks_t hc_callbacks;
93 static BOOLEAN lpm_enabled = FALSE;
94 static bt_preload_retry_cb_t preload_retry_cb;
95 // Lock to serialize cleanup requests from upper layer.
96 static pthread_mutex_t cleanup_lock;
98 /*******************************************************************************
100 *******************************************************************************/
101 static void bte_main_in_hw_init(void);
102 static void bte_hci_enable(void);
103 static void bte_hci_disable(void);
104 static void preload_start_wait_timer(void);
105 static void preload_stop_wait_timer(void);
107 /*******************************************************************************
109 *******************************************************************************/
110 BTU_API extern UINT32 btu_task (UINT32 param);
111 BTU_API extern void BTE_Init (void);
112 BT_API extern void BTE_LoadStack(void);
113 BT_API void BTE_UnloadStack(void);
114 extern void scru_flip_bda (BD_ADDR dst, const BD_ADDR src);
115 extern void bte_load_conf(const char *p_path);
116 extern void bte_load_ble_conf(const char *p_path);
117 extern bt_bdaddr_t btif_local_bd_addr;
120 /*******************************************************************************
121 ** System Task Configuration
122 *******************************************************************************/
124 /* bluetooth protocol stack (BTU) task */
125 #ifndef BTE_BTU_STACK_SIZE
126 #define BTE_BTU_STACK_SIZE 0//0x2000 /* In bytes */
128 #define BTE_BTU_TASK_STR ((INT8 *) "BTU")
129 UINT32 bte_btu_stack[(BTE_BTU_STACK_SIZE + 3) / 4];
131 /******************************************************************************
133 ** Function bte_main_in_hw_init
135 ** Description Internal helper function for chip hardware init
139 ******************************************************************************/
140 static void bte_main_in_hw_init(void)
142 if ( (bt_hc_if = (bt_hc_interface_t *) bt_hc_get_interface()) \
145 APPL_TRACE_ERROR("!!! Failed to get BtHostControllerInterface !!!");
148 memset(&preload_retry_cb, 0, sizeof(bt_preload_retry_cb_t));
151 /******************************************************************************
153 ** Function bte_main_boot_entry
155 ** Description BTE MAIN API - Entry point for BTE chip/stack initialization
159 ******************************************************************************/
160 void bte_main_boot_entry(void)
165 bte_main_in_hw_init();
167 bte_load_conf(BTE_STACK_CONF_FILE);
168 #if (defined(BLE_INCLUDED) && (BLE_INCLUDED == TRUE))
169 bte_load_ble_conf(BTE_BLE_STACK_CONF_FILE);
172 #if (BTTRC_INCLUDED == TRUE)
173 /* Initialize trace feature */
174 BTTRC_TraceInit(MAX_TRACE_RAM_SIZE, &BTE_TraceLogBuf[0], BTTRC_METHOD_RAM);
177 pthread_mutex_init(&cleanup_lock, NULL);
181 /******************************************************************************
183 ** Function bte_main_shutdown
185 ** Description BTE MAIN API - Shutdown code for BTE chip/stack
189 ******************************************************************************/
190 void bte_main_shutdown()
192 pthread_mutex_destroy(&cleanup_lock);
197 /******************************************************************************
199 ** Function bte_main_enable
201 ** Description BTE MAIN API - Creates all the BTE tasks. Should be called
202 ** part of the Bluetooth stack enable sequence
206 ******************************************************************************/
207 void bte_main_enable()
209 APPL_TRACE_DEBUG("%s", __FUNCTION__);
211 /* Initialize BTE control block */
216 GKI_create_task((TASKPTR)btu_task, BTU_TASK, BTE_BTU_TASK_STR,
217 (UINT16 *) ((UINT8 *)bte_btu_stack + BTE_BTU_STACK_SIZE),
218 sizeof(bte_btu_stack));
225 /******************************************************************************
227 ** Function bte_main_disable
229 ** Description BTE MAIN API - Destroys all the BTE tasks. Should be called
230 ** part of the Bluetooth stack disable sequence
234 ******************************************************************************/
235 void bte_main_disable(void)
237 APPL_TRACE_DEBUG("%s", __FUNCTION__);
239 preload_stop_wait_timer();
241 GKI_destroy_task(BTU_TASK);
244 /******************************************************************************
246 ** Function bte_main_config_hci_logging
248 ** Description enable or disable HIC snoop logging
252 ******************************************************************************/
253 void bte_main_config_hci_logging(BOOLEAN enable, BOOLEAN bt_disabled)
255 int old = (hci_logging_enabled == TRUE) || (hci_logging_config == TRUE);
259 hci_logging_config = TRUE;
261 hci_logging_config = FALSE;
264 new = (hci_logging_enabled == TRUE) || (hci_logging_config == TRUE);
266 if ((old == new) || bt_disabled || (bt_hc_if == NULL)) {
270 bt_hc_if->logging(new ? BT_HC_LOGGING_ON : BT_HC_LOGGING_OFF, hci_logfile, hci_save_log);
273 /******************************************************************************
275 ** Function bte_hci_enable
277 ** Description Enable HCI & Vendor modules
281 ******************************************************************************/
282 static void bte_hci_enable(void)
284 APPL_TRACE_DEBUG("%s", __FUNCTION__);
286 preload_start_wait_timer();
290 int result = bt_hc_if->init(&hc_callbacks, btif_local_bd_addr.address);
291 APPL_TRACE_EVENT("libbt-hci init returns %d", result);
293 assert(result == BT_HC_STATUS_SUCCESS);
295 if (hci_logging_enabled == TRUE || hci_logging_config == TRUE)
296 bt_hc_if->logging(BT_HC_LOGGING_ON, hci_logfile, hci_save_log);
298 #if (defined (BT_CLEAN_TURN_ON_DISABLED) && BT_CLEAN_TURN_ON_DISABLED == TRUE)
299 APPL_TRACE_DEBUG("%s Not Turninig Off the BT before Turninig ON", __FUNCTION__);
301 /* Do not power off the chip before powering on if BT_CLEAN_TURN_ON_DISABLED flag
302 is defined and set to TRUE to avoid below mentioned issue.
304 Wingray kernel driver maintains a combined counter to keep track of
305 BT-Wifi state. Invoking set_power(BT_HC_CHIP_PWR_OFF) when the BT is already
306 in OFF state causes this counter to be incorrectly decremented and results in undesired
307 behavior of the chip.
309 This is only a workaround and when the issue is fixed in the kernel this work around
310 should be removed. */
312 /* toggle chip power to ensure we will reset chip in case
313 a previous stack shutdown wasn't completed gracefully */
314 bt_hc_if->set_power(BT_HC_CHIP_PWR_OFF);
316 bt_hc_if->set_power(BT_HC_CHIP_PWR_ON);
318 bt_hc_if->preload(NULL);
322 /******************************************************************************
324 ** Function bte_hci_disable
326 ** Description Disable HCI & Vendor modules
330 ******************************************************************************/
331 static void bte_hci_disable(void)
333 APPL_TRACE_DEBUG("%s", __FUNCTION__);
338 // Cleanup is not thread safe and must be protected.
339 pthread_mutex_lock(&cleanup_lock);
341 if (hci_logging_enabled == TRUE || hci_logging_config == TRUE)
342 bt_hc_if->logging(BT_HC_LOGGING_OFF, hci_logfile, hci_save_log);
345 pthread_mutex_unlock(&cleanup_lock);
348 /*******************************************************************************
350 ** Function preload_wait_timeout
352 ** Description Timeout thread of preload watchdog timer
356 *******************************************************************************/
357 static void preload_wait_timeout(union sigval arg)
361 APPL_TRACE_ERROR("...preload_wait_timeout (retried:%d/max-retry:%d)...",
362 preload_retry_cb.retry_counts,
363 PRELOAD_MAX_RETRY_ATTEMPTS);
365 if (preload_retry_cb.retry_counts++ < PRELOAD_MAX_RETRY_ATTEMPTS)
373 /* Notify BTIF_TASK that the init procedure had failed*/
374 GKI_send_event(BTIF_TASK, BT_EVT_HARDWARE_INIT_FAIL);
378 /*******************************************************************************
380 ** Function preload_start_wait_timer
382 ** Description Launch startup watchdog timer
386 *******************************************************************************/
387 static void preload_start_wait_timer(void)
390 struct itimerspec ts;
392 UINT32 timeout_ms = PRELOAD_START_TIMEOUT_MS;
394 if (preload_retry_cb.timer_created == FALSE)
396 se.sigev_notify = SIGEV_THREAD;
397 se.sigev_value.sival_ptr = &preload_retry_cb.timer_id;
398 se.sigev_notify_function = preload_wait_timeout;
399 se.sigev_notify_attributes = NULL;
401 status = timer_create(CLOCK_MONOTONIC, &se, &preload_retry_cb.timer_id);
404 preload_retry_cb.timer_created = TRUE;
407 if (preload_retry_cb.timer_created == TRUE)
409 ts.it_value.tv_sec = timeout_ms/1000;
410 ts.it_value.tv_nsec = 1000000*(timeout_ms%1000);
411 ts.it_interval.tv_sec = 0;
412 ts.it_interval.tv_nsec = 0;
414 status = timer_settime(preload_retry_cb.timer_id, 0, &ts, 0);
416 APPL_TRACE_ERROR("Failed to fire preload watchdog timer");
420 /*******************************************************************************
422 ** Function preload_stop_wait_timer
424 ** Description Stop preload watchdog timer
428 *******************************************************************************/
429 static void preload_stop_wait_timer(void)
431 if (preload_retry_cb.timer_created == TRUE)
433 timer_delete(preload_retry_cb.timer_id);
434 preload_retry_cb.timer_created = FALSE;
438 /******************************************************************************
440 ** Function bte_main_postload_cfg
442 ** Description BTE MAIN API - Stack postload configuration
446 ******************************************************************************/
447 void bte_main_postload_cfg(void)
450 bt_hc_if->postload(NULL);
453 #if (defined(HCILP_INCLUDED) && HCILP_INCLUDED == TRUE)
454 /******************************************************************************
456 ** Function bte_main_enable_lpm
458 ** Description BTE MAIN API - Enable/Disable low power mode operation
462 ******************************************************************************/
463 void bte_main_enable_lpm(BOOLEAN enable)
468 result = bt_hc_if->lpm( \
469 (enable == TRUE) ? BT_HC_LPM_ENABLE : BT_HC_LPM_DISABLE \
472 APPL_TRACE_EVENT("HC lib lpm enable=%d return %d", enable, result);
475 /******************************************************************************
477 ** Function bte_main_lpm_allow_bt_device_sleep
479 ** Description BTE MAIN API - Allow BT controller goest to sleep
483 ******************************************************************************/
484 void bte_main_lpm_allow_bt_device_sleep()
488 if ((bt_hc_if) && (lpm_enabled == TRUE))
489 result = bt_hc_if->lpm(BT_HC_LPM_WAKE_DEASSERT);
491 APPL_TRACE_DEBUG("HC lib lpm deassertion return %d", result);
494 /******************************************************************************
496 ** Function bte_main_lpm_wake_bt_device
498 ** Description BTE MAIN API - Wake BT controller up if it is in sleep mode
502 ******************************************************************************/
503 void bte_main_lpm_wake_bt_device()
507 if ((bt_hc_if) && (lpm_enabled == TRUE))
508 result = bt_hc_if->lpm(BT_HC_LPM_WAKE_ASSERT);
510 APPL_TRACE_DEBUG("HC lib lpm assertion return %d", result);
512 #endif // HCILP_INCLUDED
516 * Definitions for audio state structure, this type needs to match to
517 * the bt_vendor_op_audio_state_t type defined in bt_vendor_lib.h
523 } bt_hc_audio_state_t;
525 struct bt_audio_state_tag {
527 bt_hc_audio_state_t audio;
530 /******************************************************************************
532 ** Function set_audio_state
534 ** Description Sets audio state on controller state for SCO (PCM, WBS, FM)
536 ** Parameters handle: codec related handle for SCO: sco cb idx, unused for
537 ** codec: BTA_AG_CODEC_MSBC, BTA_AG_CODEC_CSVD or FM codec
538 ** state: codec state, eg. BTA_AG_CO_AUD_STATE_SETUP
539 ** param: future extensions, e.g. call-in structure/event.
543 ******************************************************************************/
544 int set_audio_state(UINT16 handle, UINT16 codec, UINT8 state, void *param)
546 struct bt_audio_state_tag *p_msg;
549 APPL_TRACE_API("set_audio_state(handle: %d, codec: 0x%x, state: %d)", handle,
552 APPL_TRACE_WARNING("set_audio_state() non-null param not supported");
553 p_msg = (struct bt_audio_state_tag *)GKI_getbuf(sizeof(*p_msg));
556 p_msg->audio.handle = handle;
557 p_msg->audio.peer_codec = codec;
558 p_msg->audio.state = state;
560 p_msg->hdr.event = MSG_CTRL_TO_HC_CMD | (MSG_SUB_EVT_MASK & BT_HC_AUDIO_STATE);
561 p_msg->hdr.len = sizeof(p_msg->audio);
562 p_msg->hdr.offset = 0;
563 /* layer_specific shall contain return path event! for BTA events!
564 * 0 means no return message is expected. */
565 p_msg->hdr.layer_specific = 0;
568 bt_hc_if->tx_cmd((TRANSAC)p_msg, (char *)(&p_msg->audio), sizeof(*p_msg));
574 /******************************************************************************
576 ** Function bte_main_hci_send
578 ** Description BTE MAIN API - This function is called by the upper stack to
579 ** send an HCI message. The function displays a protocol trace
580 ** message (if enabled), and then calls the 'transmit' function
581 ** associated with the currently selected HCI transport
585 ******************************************************************************/
586 void bte_main_hci_send (BT_HDR *p_msg, UINT16 event)
588 UINT16 sub_event = event & BT_SUB_EVT_MASK; /* local controller ID */
590 p_msg->event = event;
593 if((sub_event == LOCAL_BR_EDR_CONTROLLER_ID) || \
594 (sub_event == LOCAL_BLE_CONTROLLER_ID))
597 bt_hc_if->transmit_buf((TRANSAC)p_msg, \
598 (char *) (p_msg + 1), \
605 APPL_TRACE_ERROR("Invalid Controller ID. Discarding message.");
610 /******************************************************************************
612 ** Function bte_main_post_reset_init
614 ** Description BTE MAIN API - This function is mapped to BTM_APP_DEV_INIT
615 ** and shall be automatically called from BTE after HCI_Reset
619 ******************************************************************************/
620 void bte_main_post_reset_init()
625 /*****************************************************************************
627 ** libbt-hci Callback Functions
629 *****************************************************************************/
631 /******************************************************************************
633 ** Function preload_cb
635 ** Description HOST/CONTROLLER LIB CALLBACK API - This function is called
636 ** when the libbt-hci completed stack preload process
640 ******************************************************************************/
641 static void preload_cb(TRANSAC transac, bt_hc_preload_result_t result)
645 APPL_TRACE_EVENT("HC preload_cb %d [0:SUCCESS 1:FAIL]", result);
647 if (result == BT_HC_PRELOAD_SUCCESS)
649 preload_stop_wait_timer();
651 /* notify BTU task that libbt-hci is ready */
652 GKI_send_event(BTU_TASK, BT_EVT_PRELOAD_CMPL);
656 /******************************************************************************
658 ** Function postload_cb
660 ** Description HOST/CONTROLLER LIB CALLBACK API - This function is called
661 ** when the libbt-hci lib completed stack postload process
665 ******************************************************************************/
666 static void postload_cb(TRANSAC transac, bt_hc_postload_result_t result)
670 APPL_TRACE_EVENT("HC postload_cb %d", result);
673 /******************************************************************************
677 ** Description HOST/CONTROLLER LIB CALLBACK API - This function is called
678 ** back from the libbt-hci to indicate the current LPM state
682 ******************************************************************************/
683 static void lpm_cb(bt_hc_lpm_request_result_t result)
685 APPL_TRACE_EVENT("HC lpm_result_cb %d", result);
686 lpm_enabled = (result == BT_HC_LPM_ENABLED) ? TRUE : FALSE;
689 /******************************************************************************
691 ** Function hostwake_ind
693 ** Description HOST/CONTROLLER LIB CALLOUT API - This function is called
694 ** from the libbt-hci to indicate the HostWake event
698 ******************************************************************************/
699 static void hostwake_ind(bt_hc_low_power_event_t event)
701 APPL_TRACE_EVENT("HC hostwake_ind %d", event);
704 /******************************************************************************
708 ** Description HOST/CONTROLLER LIB CALLOUT API - This function is called
709 ** from the libbt-hci to request for data buffer allocation
711 ** Returns NULL / pointer to allocated buffer
713 ******************************************************************************/
714 static char *alloc(int size)
716 BT_HDR *p_hdr = NULL;
719 APPL_TRACE_DEBUG("HC alloc size=%d", size);
722 /* Requested buffer size cannot exceed GKI_MAX_BUF_SIZE. */
723 if (size > GKI_MAX_BUF_SIZE)
725 APPL_TRACE_ERROR("HCI DATA SIZE %d greater than MAX %d",
726 size, GKI_MAX_BUF_SIZE);
730 p_hdr = (BT_HDR *) GKI_getbuf ((UINT16) size);
734 APPL_TRACE_WARNING("alloc returns NO BUFFER! (sz %d)", size);
737 return ((char *) p_hdr);
740 /******************************************************************************
744 ** Description HOST/CONTROLLER LIB CALLOUT API - This function is called
745 ** from the libbt-hci to release the data buffer allocated
746 ** through the alloc call earlier
748 ** Bluedroid libbt-hci library uses 'transac' parameter to
749 ** pass data-path buffer/packet across bt_hci_lib interface
752 ******************************************************************************/
753 static void dealloc(TRANSAC transac)
755 GKI_freebuf(transac);
758 /******************************************************************************
762 ** Description HOST/CONTROLLER LIB CALLOUT API - This function is called
763 ** from the libbt-hci to pass in the received HCI packets
765 ** The core stack is responsible for releasing the data buffer
766 ** passed in from the libbt-hci once the core stack has done
769 ** Bluedroid libbt-hci library uses 'transac' parameter to
770 ** pass data-path buffer/packet across bt_hci_lib interface
771 ** boundary. The 'p_buf' and 'len' parameters are not intended
772 ** to be used here but might point to data portion in data-
773 ** path buffer and length of valid data respectively.
775 ** Returns bt_hc_status_t
777 ******************************************************************************/
778 static int data_ind(TRANSAC transac, char *p_buf, int len)
784 APPL_TRACE_DEBUG("HC data_ind event=0x%04X (len=%d)", p_msg->event, len);
787 GKI_send_msg (BTU_TASK, BTU_HCI_RCV_MBOX, transac);
788 return BT_HC_STATUS_SUCCESS;
791 /******************************************************************************
793 ** Function tx_result
795 ** Description HOST/CONTROLLER LIB CALLBACK API - This function is called
796 ** from the libbt-hci once it has processed/sent the prior data
797 ** buffer which core stack passed to it through transmit_buf
800 ** The core stack is responsible for releasing the data buffer
801 ** if it has been completedly processed.
803 ** Bluedroid libbt-hci library uses 'transac' parameter to
804 ** pass data-path buffer/packet across bt_hci_lib interface
805 ** boundary. The 'p_buf' is not intended to be used here
806 ** but might point to data portion in data-path buffer.
808 ** Returns bt_hc_status_t
810 ******************************************************************************/
811 static int tx_result(TRANSAC transac, char *p_buf, bt_hc_transmit_result_t result)
815 APPL_TRACE_DEBUG("HC tx_result %d (event=%04X)", result, \
816 ((BT_HDR *)transac)->event);
819 if (result == BT_HC_TX_FRAGMENT)
821 GKI_send_msg (BTU_TASK, BTU_HCI_RCV_MBOX, transac);
825 GKI_freebuf(transac);
828 return BT_HC_STATUS_SUCCESS;
831 /*****************************************************************************
832 ** The libbt-hci Callback Functions Table
833 *****************************************************************************/
834 static const bt_hc_callbacks_t hc_callbacks = {
835 sizeof(bt_hc_callbacks_t),