/****************************************************************************** * * Copyright 1999-2012 Broadcom Corporation * * 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. * ******************************************************************************/ /****************************************************************************** * * This file contains functions that handle BTM interface functions for the * Bluetooth device including Rest, HCI buffer size and others * ******************************************************************************/ #define LOG_TAG "devctl" #include #include #include #include #include "acl_api_types.h" #include "btm_sec_cb.h" #include "btm_sec_int_types.h" #include "hci/controller_interface.h" #include "main/shim/btm_api.h" #include "main/shim/entry.h" #include "stack/btm/btm_int_types.h" #include "stack/btm/btm_sec.h" #include "stack/connection_manager/connection_manager.h" #include "stack/include/acl_api.h" #include "stack/include/acl_api_types.h" #include "stack/include/acl_hci_link_interface.h" #include "stack/include/bt_types.h" #include "stack/include/btm_ble_privacy.h" #include "stack/include/btm_inq.h" #include "stack/include/btm_status.h" #include "stack/include/hcidefs.h" #include "stack/include/l2cap_controller_interface.h" #include "types/raw_address.h" // TODO(b/369381361) Enfore -Wmissing-prototypes #pragma GCC diagnostic ignored "-Wmissing-prototypes" using namespace ::bluetooth; extern tBTM_CB btm_cb; void btm_inq_db_reset(void); /******************************************************************************/ /* L O C A L D A T A D E F I N I T I O N S */ /******************************************************************************/ #ifndef BTM_DEV_RESET_TIMEOUT #define BTM_DEV_RESET_TIMEOUT 4 #endif // TODO: Reevaluate this value in the context of timers with ms granularity #define BTM_DEV_NAME_REPLY_TIMEOUT_MS \ (2 * 1000) /* 2 seconds for name reply \ */ #define BTM_INFO_TIMEOUT 5 /* 5 seconds for info response */ /******************************************************************************/ /* L O C A L F U N C T I O N P R O T O T Y P E S */ /******************************************************************************/ static void decode_controller_support(); /******************************************************************************* * * Function btm_dev_init * * Description This function is on the BTM startup * * Returns void * ******************************************************************************/ void btm_dev_init() { /* Initialize nonzero defaults */ memset(btm_sec_cb.cfg.bd_name, 0, sizeof(BD_NAME)); btm_cb.devcb.read_rssi_timer = alarm_new("btm.read_rssi_timer"); btm_cb.devcb.read_failed_contact_counter_timer = alarm_new("btm.read_failed_contact_counter_timer"); btm_cb.devcb.read_automatic_flush_timeout_timer = alarm_new("btm.read_automatic_flush_timeout_timer"); btm_cb.devcb.read_tx_power_timer = alarm_new("btm.read_tx_power_timer"); } void btm_dev_free() { alarm_free(btm_cb.devcb.read_rssi_timer); alarm_free(btm_cb.devcb.read_failed_contact_counter_timer); alarm_free(btm_cb.devcb.read_automatic_flush_timeout_timer); alarm_free(btm_cb.devcb.read_tx_power_timer); } /******************************************************************************* * * Function btm_db_reset * * Returns void * ******************************************************************************/ void BTM_db_reset(void) { tBTM_CMPL_CB* p_cb; btm_inq_db_reset(); if (btm_cb.devcb.p_rln_cmpl_cb) { p_cb = btm_cb.devcb.p_rln_cmpl_cb; btm_cb.devcb.p_rln_cmpl_cb = NULL; if (p_cb) { (*p_cb)(nullptr); } } if (btm_cb.devcb.p_rssi_cmpl_cb) { p_cb = btm_cb.devcb.p_rssi_cmpl_cb; btm_cb.devcb.p_rssi_cmpl_cb = NULL; if (p_cb) { tBTM_RSSI_RESULT btm_rssi_result; btm_rssi_result.status = tBTM_STATUS::BTM_DEV_RESET; (*p_cb)(&btm_rssi_result); } } if (btm_cb.devcb.p_failed_contact_counter_cmpl_cb) { p_cb = btm_cb.devcb.p_failed_contact_counter_cmpl_cb; btm_cb.devcb.p_failed_contact_counter_cmpl_cb = NULL; if (p_cb) { tBTM_FAILED_CONTACT_COUNTER_RESULT btm_failed_contact_counter_result; btm_failed_contact_counter_result.status = tBTM_STATUS::BTM_DEV_RESET; (*p_cb)(&btm_failed_contact_counter_result); } } if (btm_cb.devcb.p_automatic_flush_timeout_cmpl_cb) { p_cb = btm_cb.devcb.p_automatic_flush_timeout_cmpl_cb; btm_cb.devcb.p_automatic_flush_timeout_cmpl_cb = NULL; if (p_cb) { tBTM_AUTOMATIC_FLUSH_TIMEOUT_RESULT btm_automatic_flush_timeout_result; btm_automatic_flush_timeout_result.status = tBTM_STATUS::BTM_DEV_RESET; (*p_cb)(&btm_automatic_flush_timeout_result); } } } static bool set_sec_state_idle(void* data, void* /* context */) { tBTM_SEC_DEV_REC* p_dev_rec = static_cast(data); p_dev_rec->sec_rec.le_link = tSECURITY_STATE::IDLE; p_dev_rec->sec_rec.classic_link = tSECURITY_STATE::IDLE; return true; } void BTM_reset_complete() { /* Tell L2CAP that all connections are gone */ l2cu_device_reset(); /* Clear current security state */ list_foreach(btm_sec_cb.sec_dev_rec, set_sec_state_idle, NULL); /* After the reset controller should restore all parameters to defaults. */ btm_cb.btm_inq_vars.inq_counter = 1; btm_cb.btm_inq_vars.inq_scan_window = HCI_DEF_INQUIRYSCAN_WINDOW; btm_cb.btm_inq_vars.inq_scan_period = HCI_DEF_INQUIRYSCAN_INTERVAL; btm_cb.btm_inq_vars.inq_scan_type = HCI_DEF_SCAN_TYPE; btm_cb.btm_inq_vars.page_scan_window = HCI_DEF_PAGESCAN_WINDOW; btm_cb.btm_inq_vars.page_scan_period = HCI_DEF_PAGESCAN_INTERVAL; btm_cb.btm_inq_vars.page_scan_type = HCI_DEF_SCAN_TYPE; btm_cb.ble_ctr_cb.set_connection_state_idle(); connection_manager::reset(true); btm_pm_reset(); l2c_link_init(bluetooth::shim::GetController()->GetNumAclPacketBuffers()); // setup the random number generator std::srand(std::time(nullptr)); /* Set up the BLE privacy settings */ if (bluetooth::shim::GetController()->SupportsBle() && bluetooth::shim::GetController()->SupportsBlePrivacy() && bluetooth::shim::GetController()->GetLeResolvingListSize() > 0) { btm_ble_resolving_list_init(bluetooth::shim::GetController()->GetLeResolvingListSize()); /* set the default random private address timeout */ btsnd_hcic_ble_set_rand_priv_addr_timeout(btm_get_next_private_address_interval_ms() / 1000); } else { log::info("Le Address Resolving list disabled due to lack of controller support"); } if (bluetooth::shim::GetController()->SupportsBle()) { l2c_link_process_ble_num_bufs( bluetooth::shim::GetController()->GetLeBufferSize().total_num_le_packets_); } BTM_SetPinType(btm_sec_cb.cfg.pin_type, btm_sec_cb.cfg.pin_code, btm_sec_cb.cfg.pin_code_len); decode_controller_support(); } /******************************************************************************* * * Function BTM_IsDeviceUp * * Description This function is called to check if the device is up. * * Returns true if device is up, else false * ******************************************************************************/ bool BTM_IsDeviceUp(void) { return bluetooth::shim::GetController() != nullptr; } static void decode_controller_support() { /* Create (e)SCO supported packet types mask */ btm_cb.btm_sco_pkt_types_supported = 0; btm_cb.sco_cb.esco_supported = false; if (bluetooth::shim::GetController()->SupportsSco()) { btm_cb.btm_sco_pkt_types_supported = ESCO_PKT_TYPES_MASK_HV1; if (bluetooth::shim::GetController()->SupportsHv2Packets()) { btm_cb.btm_sco_pkt_types_supported |= ESCO_PKT_TYPES_MASK_HV2; } if (bluetooth::shim::GetController()->SupportsHv3Packets()) { btm_cb.btm_sco_pkt_types_supported |= ESCO_PKT_TYPES_MASK_HV3; } } if (bluetooth::shim::GetController()->SupportsEv3Packets()) { btm_cb.btm_sco_pkt_types_supported |= ESCO_PKT_TYPES_MASK_EV3; } if (bluetooth::shim::GetController()->SupportsEv4Packets()) { btm_cb.btm_sco_pkt_types_supported |= ESCO_PKT_TYPES_MASK_EV4; } if (bluetooth::shim::GetController()->SupportsEv5Packets()) { btm_cb.btm_sco_pkt_types_supported |= ESCO_PKT_TYPES_MASK_EV5; } if (btm_cb.btm_sco_pkt_types_supported & BTM_ESCO_LINK_ONLY_MASK) { btm_cb.sco_cb.esco_supported = true; /* Add in EDR related eSCO types */ if (bluetooth::shim::GetController()->SupportsEsco2mPhy()) { if (!bluetooth::shim::GetController()->Supports3SlotEdrPackets()) { btm_cb.btm_sco_pkt_types_supported |= ESCO_PKT_TYPES_MASK_NO_2_EV5; } } else { btm_cb.btm_sco_pkt_types_supported |= (ESCO_PKT_TYPES_MASK_NO_2_EV3 + ESCO_PKT_TYPES_MASK_NO_2_EV5); } if (bluetooth::shim::GetController()->SupportsEsco3mPhy()) { if (!bluetooth::shim::GetController()->Supports3SlotEdrPackets()) { btm_cb.btm_sco_pkt_types_supported |= ESCO_PKT_TYPES_MASK_NO_3_EV5; } } else { btm_cb.btm_sco_pkt_types_supported |= (ESCO_PKT_TYPES_MASK_NO_3_EV3 + ESCO_PKT_TYPES_MASK_NO_3_EV5); } } log::verbose("Local supported SCO packet types: 0x{:04x}", btm_cb.btm_sco_pkt_types_supported); BTM_acl_after_controller_started(); btm_sec_dev_reset(); if (bluetooth::shim::GetController()->SupportsRssiWithInquiryResults()) { if (bluetooth::shim::GetController()->SupportsExtendedInquiryResponse()) { if (BTM_SetInquiryMode(BTM_INQ_RESULT_EXTENDED) != tBTM_STATUS::BTM_SUCCESS) { log::warn("Unable to set inquiry mode BTM_INQ_RESULT_EXTENDED"); } } else { if (BTM_SetInquiryMode(BTM_INQ_RESULT_WITH_RSSI) != tBTM_STATUS::BTM_SUCCESS) { log::warn("Unable to set inquiry mode BTM_INQ_RESULT_WITH_RSSI"); } } } l2cu_set_non_flushable_pbf(bluetooth::shim::GetController()->SupportsNonFlushablePb()); BTM_EnableInterlacedPageScan(); BTM_EnableInterlacedInquiryScan(); } /******************************************************************************* * * Function BTM_SetLocalDeviceName * * Description This function is called to set the local device name. * * Returns status of the operation * ******************************************************************************/ tBTM_STATUS BTM_SetLocalDeviceName(const char* p_name) { if (!p_name || !p_name[0] || (strlen(p_name) > BD_NAME_LEN)) { return tBTM_STATUS::BTM_ILLEGAL_VALUE; } if (bluetooth::shim::GetController() == nullptr) { return tBTM_STATUS::BTM_DEV_RESET; } /* Save the device name if local storage is enabled */ bd_name_from_char_pointer(btm_sec_cb.cfg.bd_name, p_name); bluetooth::shim::GetController()->WriteLocalName(p_name); return tBTM_STATUS::BTM_CMD_STARTED; } /******************************************************************************* * * Function BTM_ReadLocalDeviceName * * Description This function is called to read the local device name. * * Returns status of the operation * If success, tBTM_STATUS::BTM_SUCCESS is returned and p_name points stored * local device name * If BTM doesn't store local device name, tBTM_STATUS::BTM_NO_RESOURCES is * is returned and p_name is set to NULL * ******************************************************************************/ tBTM_STATUS BTM_ReadLocalDeviceName(const char** p_name) { *p_name = (const char*)btm_sec_cb.cfg.bd_name; return tBTM_STATUS::BTM_SUCCESS; } /******************************************************************************* * * Function BTM_SetDeviceClass * * Description This function is called to set the local device class * * Returns status of the operation * ******************************************************************************/ tBTM_STATUS BTM_SetDeviceClass(DEV_CLASS dev_class) { if (btm_cb.devcb.dev_class == dev_class) { return tBTM_STATUS::BTM_SUCCESS; } btm_cb.devcb.dev_class = dev_class; if (bluetooth::shim::GetController() == nullptr) { return tBTM_STATUS::BTM_DEV_RESET; } btsnd_hcic_write_dev_class(dev_class); return tBTM_STATUS::BTM_SUCCESS; } /******************************************************************************* * * Function BTM_ReadDeviceClass * * Description This function is called to read the local device class * * Returns the device class * ******************************************************************************/ DEV_CLASS BTM_ReadDeviceClass(void) { return btm_cb.devcb.dev_class; } /******************************************************************************* * * Function BTM_VendorSpecificCommand * * Description Send a vendor specific HCI command to the controller. * * Notes * Opcode will be OR'd with HCI_GRP_VENDOR_SPECIFIC. * ******************************************************************************/ void BTM_VendorSpecificCommand(uint16_t opcode, uint8_t param_len, uint8_t* p_param_buf, tBTM_VSC_CMPL_CB* p_cb) { log::verbose("BTM: Opcode: 0x{:04X}, ParamLen: {}.", opcode, param_len); /* Send the HCI command (opcode will be OR'd with HCI_GRP_VENDOR_SPECIFIC) */ btsnd_hcic_vendor_spec_cmd(opcode, param_len, p_param_buf, p_cb); } /******************************************************************************* * * Function BTM_WritePageTimeout * * Description Send HCI Write Page Timeout. * ******************************************************************************/ void BTM_WritePageTimeout(uint16_t timeout) { log::verbose("BTM: BTM_WritePageTimeout: Timeout: {}.", timeout); /* Send the HCI command */ btsnd_hcic_write_page_tout(timeout); } /******************************************************************************* * * Function BTM_WriteVoiceSettings * * Description Send HCI Write Voice Settings command. * See hcidefs.h for settings bitmask values. * ******************************************************************************/ void BTM_WriteVoiceSettings(uint16_t settings) { log::verbose("BTM: BTM_WriteVoiceSettings: Settings: 0x{:04x}.", settings); /* Send the HCI command */ btsnd_hcic_write_voice_settings((uint16_t)(settings & 0x03ff)); } /******************************************************************************* * * Function BTM_EnableTestMode * * Description Send HCI the enable device under test command. * * Note: Controller can only be taken out of this mode by * resetting the controller. * * Returns * tBTM_STATUS::BTM_SUCCESS Command sent. * tBTM_STATUS::BTM_NO_RESOURCES If out of resources to send the command. * * ******************************************************************************/ tBTM_STATUS BTM_EnableTestMode(void) { uint8_t cond; log::verbose("BTM: BTM_EnableTestMode"); /* set auto accept connection as this is needed during test mode */ /* Allocate a buffer to hold HCI command */ cond = HCI_DO_AUTO_ACCEPT_CONNECT; btsnd_hcic_set_event_filter(HCI_FILTER_CONNECTION_SETUP, HCI_FILTER_COND_NEW_DEVICE, &cond, sizeof(cond)); /* put device to connectable mode */ if (BTM_SetConnectability(BTM_CONNECTABLE) != tBTM_STATUS::BTM_SUCCESS) { return tBTM_STATUS::BTM_NO_RESOURCES; } /* put device to discoverable mode */ if (BTM_SetDiscoverability(BTM_GENERAL_DISCOVERABLE) != tBTM_STATUS::BTM_SUCCESS) { return tBTM_STATUS::BTM_NO_RESOURCES; } /* mask off all of event from controller */ bluetooth::shim::BTM_ClearEventMask(); /* Send the HCI command */ btsnd_hcic_enable_test_mode(); return tBTM_STATUS::BTM_SUCCESS; } /******************************************************************************* * * Function BTM_DeleteStoredLinkKey * * Description This function is called to delete link key for the specified * device addresses from the NVRAM storage attached to the * Bluetooth controller. * * Parameters: bd_addr - Addresses of the devices * p_cb - Call back function to be called to return * the results * ******************************************************************************/ tBTM_STATUS BTM_DeleteStoredLinkKey(const RawAddress* bd_addr, tBTM_CMPL_CB* p_cb) { /* Read and Write STORED link key stems from a legacy use-case and is no * longer expected to be used. Disable explicitly for Floss and queue overall * deletion from Fluoride. */ #if !defined(TARGET_FLOSS) /* Check if the previous command is completed */ if (btm_sec_cb.devcb.p_stored_link_key_cmpl_cb) { return tBTM_STATUS::BTM_BUSY; } bool delete_all_flag = !bd_addr; log::verbose("BTM: BTM_DeleteStoredLinkKey: delete_all_flag: {}", delete_all_flag); btm_sec_cb.devcb.p_stored_link_key_cmpl_cb = p_cb; if (!bd_addr) { /* This is to delete all link keys */ /* We don't care the BD address. Just pass a non zero pointer */ RawAddress local_bd_addr = RawAddress::kEmpty; btsnd_hcic_delete_stored_key(local_bd_addr, delete_all_flag); } else { btsnd_hcic_delete_stored_key(*bd_addr, delete_all_flag); } #endif return tBTM_STATUS::BTM_SUCCESS; } /******************************************************************************* * * Function btm_delete_stored_link_key_complete * * Description This function is called when the command complete message * is received from the HCI for the delete stored link key * command. * * Returns void * ******************************************************************************/ void btm_delete_stored_link_key_complete(uint8_t* p, uint16_t evt_len) { tBTM_CMPL_CB* p_cb = btm_sec_cb.devcb.p_stored_link_key_cmpl_cb; tBTM_DELETE_STORED_LINK_KEY_COMPLETE result; /* If there was a callback registered for read stored link key, call it */ btm_sec_cb.devcb.p_stored_link_key_cmpl_cb = NULL; if (p_cb) { /* Set the call back event to indicate command complete */ result.event = BTM_CB_EVT_DELETE_STORED_LINK_KEYS; if (evt_len < 3) { log::error("Malformatted event packet, too short"); return; } /* Extract the result fields from the HCI event */ STREAM_TO_UINT8(result.status, p); STREAM_TO_UINT16(result.num_keys, p); /* Call the call back and pass the result */ (*p_cb)(&result); } }