btm_api.h revision e28055315f96c0d06e73a66a9bb06df85247b5a7
1/****************************************************************************** 2 * 3 * Copyright (C) 1999-2012 Broadcom Corporation 4 * 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: 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 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. 16 * 17 ******************************************************************************/ 18 19/****************************************************************************** 20 * 21 * This file contains the Bluetooth Manager (BTM) API function external 22 * definitions. 23 * 24 ******************************************************************************/ 25#ifndef BTM_API_H 26#define BTM_API_H 27 28#include "bt_target.h" 29#include "sdp_api.h" 30#include "hcidefs.h" 31 32#include "smp_api.h" 33/***************************************************************************** 34** DEVICE CONTROL and COMMON 35*****************************************************************************/ 36/***************************** 37** Device Control Constants 38******************************/ 39/* Maximum number of bytes allowed for vendor specific command parameters */ 40#define BTM_MAX_VENDOR_SPECIFIC_LEN HCI_COMMAND_SIZE 41 42/* BTM application return status codes */ 43enum 44{ 45 BTM_SUCCESS = 0, /* 0 Command succeeded */ 46 BTM_CMD_STARTED, /* 1 Command started OK. */ 47 BTM_BUSY, /* 2 Device busy with another command */ 48 BTM_NO_RESOURCES, /* 3 No resources to issue command */ 49 BTM_MODE_UNSUPPORTED, /* 4 Request for 1 or more unsupported modes */ 50 BTM_ILLEGAL_VALUE, /* 5 Illegal parameter value */ 51 BTM_WRONG_MODE, /* 6 Device in wrong mode for request */ 52 BTM_UNKNOWN_ADDR, /* 7 Unknown remote BD address */ 53 BTM_DEVICE_TIMEOUT, /* 8 Device timeout */ 54 BTM_BAD_VALUE_RET, /* 9 A bad value was received from HCI */ 55 BTM_ERR_PROCESSING, /* 10 Generic error */ 56 BTM_NOT_AUTHORIZED, /* 11 Authorization failed */ 57 BTM_DEV_RESET, /* 12 Device has been reset */ 58 BTM_CMD_STORED, /* 13 request is stored in control block */ 59 BTM_ILLEGAL_ACTION, /* 14 state machine gets illegal command */ 60 BTM_DELAY_CHECK, /* 15 delay the check on encryption */ 61 BTM_SCO_BAD_LENGTH, /* 16 Bad SCO over HCI data length */ 62 BTM_SUCCESS_NO_SECURITY, /* 17 security passed, no security set */ 63 BTM_FAILED_ON_SECURITY, /* 18 security failed */ 64 BTM_REPEATED_ATTEMPTS, /* 19 repeated attempts for LE security requests */ 65 BTM_MODE4_LEVEL4_NOT_SUPPORTED /* 20 Secure Connections Only Mode can't be supported */ 66}; 67typedef UINT8 tBTM_STATUS; 68 69#if (defined(BTA_HOST_INTERLEAVE_SEARCH) && BTA_HOST_INTERLEAVE_SEARCH == TRUE) 70typedef enum 71{ 72 BTM_BR_ONE, /*0 First state or BR/EDR scan 1*/ 73 BTM_BLE_ONE, /*1BLE scan 1*/ 74 BTM_BR_TWO, /*2 BR/EDR scan 2*/ 75 BTM_BLE_TWO, /*3 BLE scan 2*/ 76 BTM_FINISH, /*4 End of Interleave Scan, or normal scan*/ 77 BTM_NO_INTERLEAVING /*5 No Interleaving*/ 78}btm_inq_state; 79#endif 80 81 82 83/************************* 84** Device Control Types 85**************************/ 86#define BTM_DEVICE_ROLE_BR 0x01 87#define BTM_DEVICE_ROLE_DUAL 0x02 88#define BTM_MAX_DEVICE_ROLE BTM_DEVICE_ROLE_DUAL 89typedef UINT8 tBTM_DEVICE_ROLE; 90 91/* Device name of peer (may be truncated to save space in BTM database) */ 92typedef UINT8 tBTM_BD_NAME[BTM_MAX_REM_BD_NAME_LEN + 1]; 93 94/* Structure returned with local version information */ 95typedef struct 96{ 97 UINT8 hci_version; 98 UINT16 hci_revision; 99 UINT8 lmp_version; 100 UINT16 manufacturer; 101 UINT16 lmp_subversion; 102} tBTM_VERSION_INFO; 103 104/* Structure returned with Vendor Specific Command complete callback */ 105typedef struct 106{ 107 UINT16 opcode; 108 UINT16 param_len; 109 UINT8 *p_param_buf; 110} tBTM_VSC_CMPL; 111 112#define BTM_VSC_CMPL_DATA_SIZE (BTM_MAX_VENDOR_SPECIFIC_LEN + sizeof(tBTM_VSC_CMPL)) 113/************************************************** 114** Device Control and General Callback Functions 115***************************************************/ 116/* Callback function for when device status changes. Appl must poll for 117** what the new state is (BTM_IsDeviceUp). The event occurs whenever the stack 118** has detected that the controller status has changed. This asynchronous event 119** is enabled/disabled by calling BTM_RegisterForDeviceStatusNotif(). 120*/ 121enum 122{ 123 BTM_DEV_STATUS_UP, 124 BTM_DEV_STATUS_DOWN, 125 BTM_DEV_STATUS_CMD_TOUT 126}; 127 128typedef UINT8 tBTM_DEV_STATUS; 129 130 131typedef void (tBTM_DEV_STATUS_CB) (tBTM_DEV_STATUS status); 132 133 134/* Callback function for when a vendor specific event occurs. The length and 135** array of returned parameter bytes are included. This asynchronous event 136** is enabled/disabled by calling BTM_RegisterForVSEvents(). 137*/ 138typedef void (tBTM_VS_EVT_CB) (UINT8 len, UINT8 *p); 139 140 141/* General callback function for notifying an application that a synchronous 142** BTM function is complete. The pointer contains the address of any returned data. 143*/ 144typedef void (tBTM_CMPL_CB) (void *p1); 145 146/* VSC callback function for notifying an application that a synchronous 147** BTM function is complete. The pointer contains the address of any returned data. 148*/ 149typedef void (tBTM_VSC_CMPL_CB) (tBTM_VSC_CMPL *p1); 150 151/* Callback for apps to check connection and inquiry filters. 152** Parameters are the BD Address of remote and the Dev Class of remote. 153** If the app returns none zero, the connection or inquiry result will be dropped. 154*/ 155typedef UINT8 (tBTM_FILTER_CB) (BD_ADDR bd_addr, DEV_CLASS dc); 156 157/***************************************************************************** 158** DEVICE DISCOVERY - Inquiry, Remote Name, Discovery, Class of Device 159*****************************************************************************/ 160/******************************* 161** Device Discovery Constants 162********************************/ 163/* Discoverable modes */ 164#define BTM_NON_DISCOVERABLE 0 165#define BTM_LIMITED_DISCOVERABLE 1 166#define BTM_GENERAL_DISCOVERABLE 2 167#define BTM_DISCOVERABLE_MASK (BTM_LIMITED_DISCOVERABLE|BTM_GENERAL_DISCOVERABLE) 168#define BTM_MAX_DISCOVERABLE BTM_GENERAL_DISCOVERABLE 169/* high byte for BLE Discoverable modes */ 170#define BTM_BLE_NON_DISCOVERABLE 0x0000 171#define BTM_BLE_LIMITED_DISCOVERABLE 0x0100 172#define BTM_BLE_GENERAL_DISCOVERABLE 0x0200 173#define BTM_BLE_MAX_DISCOVERABLE BTM_BLE_GENERAL_DISCOVERABLE 174#define BTM_BLE_DISCOVERABLE_MASK (BTM_BLE_NON_DISCOVERABLE|BTM_BLE_LIMITED_DISCOVERABLE|BTM_BLE_GENERAL_DISCOVERABLE) 175 176/* Connectable modes */ 177#define BTM_NON_CONNECTABLE 0 178#define BTM_CONNECTABLE 1 179#define BTM_CONNECTABLE_MASK (BTM_NON_CONNECTABLE | BTM_CONNECTABLE) 180/* high byte for BLE Connectable modes */ 181#define BTM_BLE_NON_CONNECTABLE 0x0000 182#define BTM_BLE_CONNECTABLE 0x0100 183#define BTM_BLE_MAX_CONNECTABLE BTM_BLE_CONNECTABLE 184#define BTM_BLE_CONNECTABLE_MASK (BTM_BLE_NON_CONNECTABLE | BTM_BLE_CONNECTABLE) 185 186/* Inquiry modes 187 * Note: These modes are associated with the inquiry active values (BTM_*ACTIVE) */ 188#define BTM_INQUIRY_NONE 0 189#define BTM_GENERAL_INQUIRY 0x01 190#define BTM_LIMITED_INQUIRY 0x02 191#define BTM_BR_INQUIRY_MASK (BTM_GENERAL_INQUIRY | BTM_LIMITED_INQUIRY) 192 193/* high byte of inquiry mode for BLE inquiry mode */ 194#define BTM_BLE_INQUIRY_NONE 0x00 195#define BTM_BLE_GENERAL_INQUIRY 0x10 196#define BTM_BLE_LIMITED_INQUIRY 0x20 197#define BTM_BLE_INQUIRY_MASK (BTM_BLE_GENERAL_INQUIRY|BTM_BLE_LIMITED_INQUIRY) 198 199/* BTM_IsInquiryActive return values (Bit Mask) 200 * Note: These bit masks are associated with the inquiry modes (BTM_*_INQUIRY) */ 201#define BTM_INQUIRY_INACTIVE 0x0 /* no inquiry in progress */ 202#define BTM_GENERAL_INQUIRY_ACTIVE BTM_GENERAL_INQUIRY /* a general inquiry is in progress */ 203#define BTM_LIMITED_INQUIRY_ACTIVE BTM_LIMITED_INQUIRY /* a limited inquiry is in progress */ 204#define BTM_PERIODIC_INQUIRY_ACTIVE 0x8 /* a periodic inquiry is active */ 205#define BTM_SSP_INQUIRY_ACTIVE 0x4 /* SSP is active, so inquiry is disallowed (work around for FW bug) */ 206#define BTM_LE_GENERAL_INQUIRY_ACTIVE BTM_BLE_GENERAL_INQUIRY /* a general inquiry is in progress */ 207#define BTM_LE_LIMITED_INQUIRY_ACTIVE BTM_BLE_LIMITED_INQUIRY /* a limited inquiry is in progress */ 208 209/* inquiry activity mask */ 210#define BTM_BR_INQ_ACTIVE_MASK (BTM_GENERAL_INQUIRY_ACTIVE|BTM_LIMITED_INQUIRY_ACTIVE|BTM_PERIODIC_INQUIRY_ACTIVE) /* BR/EDR inquiry activity mask */ 211#define BTM_BLE_SCAN_ACTIVE_MASK 0xF0 /* LE scan activity mask */ 212#define BTM_BLE_INQ_ACTIVE_MASK (BTM_LE_GENERAL_INQUIRY_ACTIVE|BTM_LE_LIMITED_INQUIRY_ACTIVE) /* LE inquiry activity mask*/ 213#define BTM_INQUIRY_ACTIVE_MASK (BTM_BR_INQ_ACTIVE_MASK | BTM_BLE_INQ_ACTIVE_MASK) /* inquiry activity mask */ 214 215/* Define scan types */ 216#define BTM_SCAN_TYPE_STANDARD 0 217#define BTM_SCAN_TYPE_INTERLACED 1 /* 1.2 devices only */ 218 219/* Define inquiry results mode */ 220#define BTM_INQ_RESULT_STANDARD 0 221#define BTM_INQ_RESULT_WITH_RSSI 1 222#define BTM_INQ_RESULT_EXTENDED 2 223 224#define BTM_INQ_RES_IGNORE_RSSI 0x7f /* RSSI value not supplied (ignore it) */ 225 226/* Inquiry Filter Condition types (see tBTM_INQ_PARMS) */ 227#define BTM_CLR_INQUIRY_FILTER 0 /* Inquiry Filtering is turned off */ 228#define BTM_FILTER_COND_DEVICE_CLASS HCI_FILTER_COND_DEVICE_CLASS /* Filter on device class */ 229#define BTM_FILTER_COND_BD_ADDR HCI_FILTER_COND_BD_ADDR /* Filter on device addr */ 230 231/* State of the remote name retrieval during inquiry operations. 232** Used in the tBTM_INQ_INFO structure, and returned in the 233** BTM_InqDbRead, BTM_InqDbFirst, and BTM_InqDbNext functions. 234** The name field is valid when the state returned is 235** BTM_INQ_RMT_NAME_DONE */ 236#define BTM_INQ_RMT_NAME_EMPTY 0 237#define BTM_INQ_RMT_NAME_PENDING 1 238#define BTM_INQ_RMT_NAME_DONE 2 239#define BTM_INQ_RMT_NAME_FAILED 3 240 241/********************************* 242 *** Class of Device constants *** 243 *********************************/ 244#define BTM_FORMAT_TYPE_1 0x00 245 246/**************************** 247** minor device class field 248*****************************/ 249 250/* 0x00 is used as unclassified for all minor device classes */ 251#define BTM_COD_MINOR_UNCLASSIFIED 0x00 252 253/* minor device class field for Computer Major Class */ 254/* #define BTM_COD_MINOR_UNCLASSIFIED 0x00 */ 255#define BTM_COD_MINOR_DESKTOP_WORKSTATION 0x04 256#define BTM_COD_MINOR_SERVER_COMPUTER 0x08 257#define BTM_COD_MINOR_LAPTOP 0x0C 258#define BTM_COD_MINOR_HANDHELD_PC_PDA 0x10 /* clam shell */ 259#define BTM_COD_MINOR_PALM_SIZE_PC_PDA 0x14 260#define BTM_COD_MINOR_WEARABLE_COMPUTER 0x18 /* watch sized */ 261 262/* minor device class field for Phone Major Class */ 263/* #define BTM_COD_MINOR_UNCLASSIFIED 0x00 */ 264#define BTM_COD_MINOR_CELLULAR 0x04 265#define BTM_COD_MINOR_CORDLESS 0x08 266#define BTM_COD_MINOR_SMART_PHONE 0x0C 267#define BTM_COD_MINOR_WIRED_MDM_V_GTWY 0x10 /* wired modem or voice gatway */ 268#define BTM_COD_MINOR_ISDN_ACCESS 0x14 269 270/* minor device class field for LAN Access Point Major Class */ 271/* Load Factor Field bit 5-7 */ 272#define BTM_COD_MINOR_FULLY_AVAILABLE 0x00 273#define BTM_COD_MINOR_1_17_UTILIZED 0x20 274#define BTM_COD_MINOR_17_33_UTILIZED 0x40 275#define BTM_COD_MINOR_33_50_UTILIZED 0x60 276#define BTM_COD_MINOR_50_67_UTILIZED 0x80 277#define BTM_COD_MINOR_67_83_UTILIZED 0xA0 278#define BTM_COD_MINOR_83_99_UTILIZED 0xC0 279#define BTM_COD_MINOR_NO_SERVICE_AVAILABLE 0xE0 280/* sub-Field bit 2-4 */ 281/* #define BTM_COD_MINOR_UNCLASSIFIED 0x00 */ 282 283/* minor device class field for Audio/Video Major Class */ 284/* #define BTM_COD_MINOR_UNCLASSIFIED 0x00 */ 285#define BTM_COD_MINOR_CONFM_HEADSET 0x04 286#define BTM_COD_MINOR_CONFM_HANDSFREE 0x08 287#define BTM_COD_MINOR_MICROPHONE 0x10 288#define BTM_COD_MINOR_LOUDSPEAKER 0x14 289#define BTM_COD_MINOR_HEADPHONES 0x18 290#define BTM_COD_MINOR_PORTABLE_AUDIO 0x1C 291#define BTM_COD_MINOR_CAR_AUDIO 0x20 292#define BTM_COD_MINOR_SET_TOP_BOX 0x24 293#define BTM_COD_MINOR_HIFI_AUDIO 0x28 294#define BTM_COD_MINOR_VCR 0x2C 295#define BTM_COD_MINOR_VIDEO_CAMERA 0x30 296#define BTM_COD_MINOR_CAMCORDER 0x34 297#define BTM_COD_MINOR_VIDEO_MONITOR 0x38 298#define BTM_COD_MINOR_VIDDISP_LDSPKR 0x3C 299#define BTM_COD_MINOR_VIDEO_CONFERENCING 0x40 300#define BTM_COD_MINOR_GAMING_TOY 0x48 301 302/* minor device class field for Peripheral Major Class */ 303/* Bits 6-7 independently specify mouse, keyboard, or combo mouse/keyboard */ 304#define BTM_COD_MINOR_KEYBOARD 0x40 305#define BTM_COD_MINOR_POINTING 0x80 306#define BTM_COD_MINOR_COMBO 0xC0 307/* Bits 2-5 OR'd with selection from bits 6-7 */ 308/* #define BTM_COD_MINOR_UNCLASSIFIED 0x00 */ 309#define BTM_COD_MINOR_JOYSTICK 0x04 310#define BTM_COD_MINOR_GAMEPAD 0x08 311#define BTM_COD_MINOR_REMOTE_CONTROL 0x0C 312#define BTM_COD_MINOR_SENSING_DEVICE 0x10 313#define BTM_COD_MINOR_DIGITIZING_TABLET 0x14 314#define BTM_COD_MINOR_CARD_READER 0x18 /* e.g. SIM card reader */ 315#define BTM_COD_MINOR_DIGITAL_PAN 0x1C 316#define BTM_COD_MINOR_HAND_SCANNER 0x20 317#define BTM_COD_MINOR_HAND_GESTURAL_INPUT 0x24 318 319/* minor device class field for Imaging Major Class */ 320/* Bits 5-7 independently specify display, camera, scanner, or printer */ 321#define BTM_COD_MINOR_DISPLAY 0x10 322#define BTM_COD_MINOR_CAMERA 0x20 323#define BTM_COD_MINOR_SCANNER 0x40 324#define BTM_COD_MINOR_PRINTER 0x80 325/* Bits 2-3 Reserved */ 326/* #define BTM_COD_MINOR_UNCLASSIFIED 0x00 */ 327 328/* minor device class field for Wearable Major Class */ 329/* Bits 2-7 meaningful */ 330#define BTM_COD_MINOR_WRIST_WATCH 0x04 331#define BTM_COD_MINOR_PAGER 0x08 332#define BTM_COD_MINOR_JACKET 0x0C 333#define BTM_COD_MINOR_HELMET 0x10 334#define BTM_COD_MINOR_GLASSES 0x14 335 336/* minor device class field for Toy Major Class */ 337/* Bits 2-7 meaningful */ 338#define BTM_COD_MINOR_ROBOT 0x04 339#define BTM_COD_MINOR_VEHICLE 0x08 340#define BTM_COD_MINOR_DOLL_ACTION_FIGURE 0x0C 341#define BTM_COD_MINOR_CONTROLLER 0x10 342#define BTM_COD_MINOR_GAME 0x14 343 344/* minor device class field for Health Major Class */ 345/* Bits 2-7 meaningful */ 346#define BTM_COD_MINOR_BLOOD_MONITOR 0x04 347#define BTM_COD_MINOR_THERMOMETER 0x08 348#define BTM_COD_MINOR_WEIGHING_SCALE 0x0C 349#define BTM_COD_MINOR_GLUCOSE_METER 0x10 350#define BTM_COD_MINOR_PULSE_OXIMETER 0x14 351#define BTM_COD_MINOR_HEART_PULSE_MONITOR 0x18 352#define BTM_COD_MINOR_HEALTH_DATA_DISPLAY 0x1C 353#define BTM_COD_MINOR_STEP_COUNTER 0x20 354#define BTM_COD_MINOR_BODY_COM_ANALYZER 0x24 355#define BTM_COD_MINOR_PEAK_FLOW_MONITOR 0x28 356#define BTM_COD_MINOR_MEDICATION_MONITOR 0x2C 357#define BTM_COD_MINOR_KNEE_PROSTHESIS 0x30 358#define BTM_COD_MINOR_ANKLE_PROSTHESIS 0x34 359 360 361/*************************** 362** major device class field 363****************************/ 364#define BTM_COD_MAJOR_MISCELLANEOUS 0x00 365#define BTM_COD_MAJOR_COMPUTER 0x01 366#define BTM_COD_MAJOR_PHONE 0x02 367#define BTM_COD_MAJOR_LAN_ACCESS_PT 0x03 368#define BTM_COD_MAJOR_AUDIO 0x04 369#define BTM_COD_MAJOR_PERIPHERAL 0x05 370#define BTM_COD_MAJOR_IMAGING 0x06 371#define BTM_COD_MAJOR_WEARABLE 0x07 372#define BTM_COD_MAJOR_TOY 0x08 373#define BTM_COD_MAJOR_HEALTH 0x09 374#define BTM_COD_MAJOR_UNCLASSIFIED 0x1F 375 376/*************************** 377** service class fields 378****************************/ 379#define BTM_COD_SERVICE_LMTD_DISCOVER 0x0020 380#define BTM_COD_SERVICE_POSITIONING 0x0100 381#define BTM_COD_SERVICE_NETWORKING 0x0200 382#define BTM_COD_SERVICE_RENDERING 0x0400 383#define BTM_COD_SERVICE_CAPTURING 0x0800 384#define BTM_COD_SERVICE_OBJ_TRANSFER 0x1000 385#define BTM_COD_SERVICE_AUDIO 0x2000 386#define BTM_COD_SERVICE_TELEPHONY 0x4000 387#define BTM_COD_SERVICE_INFORMATION 0x8000 388 389/* class of device field macros */ 390#define BTM_COD_FORMAT_TYPE(u8, pd) {u8 = pd[2]&0x03;} 391#define BTM_COD_MINOR_CLASS(u8, pd) {u8 = pd[2]&0xFC;} 392#define BTM_COD_MAJOR_CLASS(u8, pd) {u8 = pd[1]&0x1F;} 393#define BTM_COD_SERVICE_CLASS(u16, pd) {u16 = pd[0]; u16<<=8; u16 += pd[1]&0xE0;} 394 395/* to set the fields (assumes that format type is always 0) */ 396#define FIELDS_TO_COD(pd, mn, mj, sv) {pd[2] = mn; pd[1] = \ 397 mj+ ((sv)&BTM_COD_SERVICE_CLASS_LO_B); \ 398 pd[0] = (sv) >> 8;} 399 400/* the COD masks */ 401#define BTM_COD_FORMAT_TYPE_MASK 0x03 402#define BTM_COD_MINOR_CLASS_MASK 0xFC 403#define BTM_COD_MAJOR_CLASS_MASK 0x1F 404#define BTM_COD_SERVICE_CLASS_LO_B 0x00E0 405#define BTM_COD_SERVICE_CLASS_MASK 0xFFE0 406 407 408/* BTM service definitions 409** Used for storing EIR data to bit mask 410*/ 411enum 412{ 413 BTM_EIR_UUID_SERVCLASS_SERVICE_DISCOVERY_SERVER, 414/* BTM_EIR_UUID_SERVCLASS_BROWSE_GROUP_DESCRIPTOR, */ 415/* BTM_EIR_UUID_SERVCLASS_PUBLIC_BROWSE_GROUP, */ 416 BTM_EIR_UUID_SERVCLASS_SERIAL_PORT, 417 BTM_EIR_UUID_SERVCLASS_LAN_ACCESS_USING_PPP, 418 BTM_EIR_UUID_SERVCLASS_DIALUP_NETWORKING, 419 BTM_EIR_UUID_SERVCLASS_IRMC_SYNC, 420 BTM_EIR_UUID_SERVCLASS_OBEX_OBJECT_PUSH, 421 BTM_EIR_UUID_SERVCLASS_OBEX_FILE_TRANSFER, 422 BTM_EIR_UUID_SERVCLASS_IRMC_SYNC_COMMAND, 423 BTM_EIR_UUID_SERVCLASS_HEADSET, 424 BTM_EIR_UUID_SERVCLASS_CORDLESS_TELEPHONY, 425 BTM_EIR_UUID_SERVCLASS_AUDIO_SOURCE, 426 BTM_EIR_UUID_SERVCLASS_AUDIO_SINK, 427 BTM_EIR_UUID_SERVCLASS_AV_REM_CTRL_TARGET, 428/* BTM_EIR_UUID_SERVCLASS_ADV_AUDIO_DISTRIBUTION, */ 429 BTM_EIR_UUID_SERVCLASS_AV_REMOTE_CONTROL, 430/* BTM_EIR_UUID_SERVCLASS_VIDEO_CONFERENCING, */ 431 BTM_EIR_UUID_SERVCLASS_INTERCOM, 432 BTM_EIR_UUID_SERVCLASS_FAX, 433 BTM_EIR_UUID_SERVCLASS_HEADSET_AUDIO_GATEWAY, 434/* BTM_EIR_UUID_SERVCLASS_WAP, */ 435/* BTM_EIR_UUID_SERVCLASS_WAP_CLIENT, */ 436 BTM_EIR_UUID_SERVCLASS_PANU, 437 BTM_EIR_UUID_SERVCLASS_NAP, 438 BTM_EIR_UUID_SERVCLASS_GN, 439 BTM_EIR_UUID_SERVCLASS_DIRECT_PRINTING, 440/* BTM_EIR_UUID_SERVCLASS_REFERENCE_PRINTING, */ 441 BTM_EIR_UUID_SERVCLASS_IMAGING, 442 BTM_EIR_UUID_SERVCLASS_IMAGING_RESPONDER, 443 BTM_EIR_UUID_SERVCLASS_IMAGING_AUTO_ARCHIVE, 444 BTM_EIR_UUID_SERVCLASS_IMAGING_REF_OBJECTS, 445 BTM_EIR_UUID_SERVCLASS_HF_HANDSFREE, 446 BTM_EIR_UUID_SERVCLASS_AG_HANDSFREE, 447 BTM_EIR_UUID_SERVCLASS_DIR_PRT_REF_OBJ_SERVICE, 448/* BTM_EIR_UUID_SERVCLASS_REFLECTED_UI, */ 449 BTM_EIR_UUID_SERVCLASS_BASIC_PRINTING, 450 BTM_EIR_UUID_SERVCLASS_PRINTING_STATUS, 451 BTM_EIR_UUID_SERVCLASS_HUMAN_INTERFACE, 452 BTM_EIR_UUID_SERVCLASS_CABLE_REPLACEMENT, 453 BTM_EIR_UUID_SERVCLASS_HCRP_PRINT, 454 BTM_EIR_UUID_SERVCLASS_HCRP_SCAN, 455/* BTM_EIR_UUID_SERVCLASS_COMMON_ISDN_ACCESS, */ 456/* BTM_EIR_UUID_SERVCLASS_VIDEO_CONFERENCING_GW, */ 457/* BTM_EIR_UUID_SERVCLASS_UDI_MT, */ 458/* BTM_EIR_UUID_SERVCLASS_UDI_TA, */ 459/* BTM_EIR_UUID_SERVCLASS_VCP, */ 460 BTM_EIR_UUID_SERVCLASS_SAP, 461 BTM_EIR_UUID_SERVCLASS_PBAP_PCE, 462 BTM_EIR_UUID_SERVCLASS_PBAP_PSE, 463/* BTM_EIR_UUID_SERVCLASS_TE_PHONE_ACCESS, */ 464/* BTM_EIR_UUID_SERVCLASS_ME_PHONE_ACCESS, */ 465 BTM_EIR_UUID_SERVCLASS_PHONE_ACCESS, 466 BTM_EIR_UUID_SERVCLASS_HEADSET_HS, 467 BTM_EIR_UUID_SERVCLASS_PNP_INFORMATION, 468/* BTM_EIR_UUID_SERVCLASS_GENERIC_NETWORKING, */ 469/* BTM_EIR_UUID_SERVCLASS_GENERIC_FILETRANSFER, */ 470/* BTM_EIR_UUID_SERVCLASS_GENERIC_AUDIO, */ 471/* BTM_EIR_UUID_SERVCLASS_GENERIC_TELEPHONY, */ 472/* BTM_EIR_UUID_SERVCLASS_UPNP_SERVICE, */ 473/* BTM_EIR_UUID_SERVCLASS_UPNP_IP_SERVICE, */ 474/* BTM_EIR_UUID_SERVCLASS_ESDP_UPNP_IP_PAN, */ 475/* BTM_EIR_UUID_SERVCLASS_ESDP_UPNP_IP_LAP, */ 476/* BTM_EIR_UUID_SERVCLASS_ESDP_UPNP_IP_L2CAP, */ 477 BTM_EIR_UUID_SERVCLASS_VIDEO_SOURCE, 478 BTM_EIR_UUID_SERVCLASS_VIDEO_SINK, 479/* BTM_EIR_UUID_SERVCLASS_VIDEO_DISTRIBUTION */ 480/* BTM_EIR_UUID_SERVCLASS_HDP_PROFILE */ 481 BTM_EIR_UUID_SERVCLASS_MESSAGE_ACCESS, 482 BTM_EIR_UUID_SERVCLASS_MESSAGE_NOTIFICATION, 483 BTM_EIR_UUID_SERVCLASS_HDP_SOURCE, 484 BTM_EIR_UUID_SERVCLASS_HDP_SINK, 485 BTM_EIR_MAX_SERVICES 486}; 487 488/* search result in EIR of inquiry database */ 489#define BTM_EIR_FOUND 0 490#define BTM_EIR_NOT_FOUND 1 491#define BTM_EIR_UNKNOWN 2 492 493typedef UINT8 tBTM_EIR_SEARCH_RESULT; 494 495#define BTM_EIR_FLAGS_TYPE HCI_EIR_FLAGS_TYPE /* 0x01 */ 496#define BTM_EIR_MORE_16BITS_UUID_TYPE HCI_EIR_MORE_16BITS_UUID_TYPE /* 0x02 */ 497#define BTM_EIR_COMPLETE_16BITS_UUID_TYPE HCI_EIR_COMPLETE_16BITS_UUID_TYPE /* 0x03 */ 498#define BTM_EIR_MORE_32BITS_UUID_TYPE HCI_EIR_MORE_32BITS_UUID_TYPE /* 0x04 */ 499#define BTM_EIR_COMPLETE_32BITS_UUID_TYPE HCI_EIR_COMPLETE_32BITS_UUID_TYPE /* 0x05 */ 500#define BTM_EIR_MORE_128BITS_UUID_TYPE HCI_EIR_MORE_128BITS_UUID_TYPE /* 0x06 */ 501#define BTM_EIR_COMPLETE_128BITS_UUID_TYPE HCI_EIR_COMPLETE_128BITS_UUID_TYPE /* 0x07 */ 502#define BTM_EIR_SHORTENED_LOCAL_NAME_TYPE HCI_EIR_SHORTENED_LOCAL_NAME_TYPE /* 0x08 */ 503#define BTM_EIR_COMPLETE_LOCAL_NAME_TYPE HCI_EIR_COMPLETE_LOCAL_NAME_TYPE /* 0x09 */ 504#define BTM_EIR_TX_POWER_LEVEL_TYPE HCI_EIR_TX_POWER_LEVEL_TYPE /* 0x0A */ 505#define BTM_EIR_MANUFACTURER_SPECIFIC_TYPE HCI_EIR_MANUFACTURER_SPECIFIC_TYPE /* 0xFF */ 506 507/* the following EIR tags are defined to OOB, not regular EIR data */ 508#define BTM_EIR_OOB_BD_ADDR_TYPE HCI_EIR_OOB_BD_ADDR_TYPE /* 6 bytes */ 509#define BTM_EIR_OOB_COD_TYPE HCI_EIR_OOB_COD_TYPE /* 3 bytes */ 510#define BTM_EIR_OOB_SSP_HASH_C_TYPE HCI_EIR_OOB_SSP_HASH_C_TYPE /* 16 bytes */ 511#define BTM_EIR_OOB_SSP_RAND_R_TYPE HCI_EIR_OOB_SSP_RAND_R_TYPE /* 16 bytes */ 512 513#define BTM_OOB_MANDATORY_SIZE 8 /* include 2 bytes length & 6 bytes bd_addr */ 514#define BTM_OOB_DATA_LEN_SIZE 2 515#define BTM_OOB_BD_ADDR_SIZE 6 516#define BTM_OOB_COD_SIZE BT_OOB_COD_SIZE 517#define BTM_OOB_HASH_C_SIZE BT_OOB_HASH_C_SIZE 518#define BTM_OOB_RAND_R_SIZE BT_OOB_RAND_R_SIZE 519 520 521#if BLE_INCLUDED == TRUE 522#define BTM_BLE_SEC_NONE 0 523#define BTM_BLE_SEC_ENCRYPT 1 /* encrypt the link using current key */ 524#define BTM_BLE_SEC_ENCRYPT_NO_MITM 2 525#define BTM_BLE_SEC_ENCRYPT_MITM 3 526typedef UINT8 tBTM_BLE_SEC_ACT; 527#endif 528/************************************************************************************************ 529** BTM Services MACROS handle array of UINT32 bits for more than 32 services 530*************************************************************************************************/ 531/* Determine the number of UINT32's necessary for services */ 532#define BTM_EIR_ARRAY_BITS 32 /* Number of bits in each array element */ 533#define BTM_EIR_SERVICE_ARRAY_SIZE (((UINT32)BTM_EIR_MAX_SERVICES / BTM_EIR_ARRAY_BITS) + \ 534 (((UINT32)BTM_EIR_MAX_SERVICES % BTM_EIR_ARRAY_BITS) ? 1 : 0)) 535 536/* MACRO to set the service bit mask in a bit stream */ 537#define BTM_EIR_SET_SERVICE(p, service) (((UINT32 *)(p))[(((UINT32)(service)) / BTM_EIR_ARRAY_BITS)] |= \ 538 ((UINT32)1 << (((UINT32)(service)) % BTM_EIR_ARRAY_BITS))) 539 540 541/* MACRO to clear the service bit mask in a bit stream */ 542#define BTM_EIR_CLR_SERVICE(p, service) (((UINT32 *)(p))[(((UINT32)(service)) / BTM_EIR_ARRAY_BITS)] &= \ 543 ~((UINT32)1 << (((UINT32)(service)) % BTM_EIR_ARRAY_BITS))) 544 545/* MACRO to check the service bit mask in a bit stream */ 546#define BTM_EIR_HAS_SERVICE(p, service) ((((UINT32 *)(p))[(((UINT32)(service)) / BTM_EIR_ARRAY_BITS)] & \ 547 ((UINT32)1 << (((UINT32)(service)) % BTM_EIR_ARRAY_BITS))) >> (((UINT32)(service)) % BTM_EIR_ARRAY_BITS)) 548 549/* start of EIR in HCI buffer, 4 bytes = HCI Command(2) + Length(1) + FEC_Req(1) */ 550#define BTM_HCI_EIR_OFFSET (BT_HDR_SIZE + 4) 551 552/*************************** 553** Device Discovery Types 554****************************/ 555/* Definitions of the parameters passed to BTM_StartInquiry and 556** BTM_SetPeriodicInquiryMode. 557*/ 558typedef struct /* contains the two device class condition fields */ 559{ 560 DEV_CLASS dev_class; 561 DEV_CLASS dev_class_mask; 562} tBTM_COD_COND; 563 564 565typedef union /* contains the inquiry filter condition */ 566{ 567 BD_ADDR bdaddr_cond; 568 tBTM_COD_COND cod_cond; 569} tBTM_INQ_FILT_COND; 570 571 572typedef struct /* contains the parameters passed to the inquiry functions */ 573{ 574 UINT8 mode; /* general or limited */ 575 UINT8 duration; /* duration of the inquiry (1.28 sec increments) */ 576 UINT8 max_resps; /* maximum number of responses to return */ 577 BOOLEAN report_dup; /* report duplicated inquiry response with higher RSSI value */ 578 UINT8 filter_cond_type; /* new devices, BD ADDR, COD, or No filtering */ 579 tBTM_INQ_FILT_COND filter_cond; /* filter value based on filter cond type */ 580#if (defined(BTA_HOST_INTERLEAVE_SEARCH) && BTA_HOST_INTERLEAVE_SEARCH == TRUE) 581 UINT8 intl_duration[4]; /*duration array storing the interleave scan's time portions*/ 582#endif 583} tBTM_INQ_PARMS; 584 585#define BTM_INQ_RESULT_BR 0x01 586#define BTM_INQ_RESULT_BLE 0x02 587 588#if (BLE_INCLUDED == TRUE) 589#define BTM_BLE_EVT_CONN_ADV 0x00 590#define BTM_BLE_EVT_CONN_DIR_ADV 0x01 591#define BTM_BLE_EVT_DISC_ADV 0x02 592#define BTM_BLE_EVT_NON_CONN_ADV 0x03 593#define BTM_BLE_EVT_SCAN_RSP 0x04 594typedef UINT8 tBTM_BLE_EVT_TYPE; 595#endif 596 597/* These are the fields returned in each device's response to the inquiry. It 598** is returned in the results callback if registered. 599*/ 600typedef struct 601{ 602 UINT16 clock_offset; 603 BD_ADDR remote_bd_addr; 604 DEV_CLASS dev_class; 605 UINT8 page_scan_rep_mode; 606 UINT8 page_scan_per_mode; 607 UINT8 page_scan_mode; 608 INT8 rssi; /* Set to BTM_INQ_RES_IGNORE_RSSI if not valid */ 609 UINT32 eir_uuid[BTM_EIR_SERVICE_ARRAY_SIZE]; 610 BOOLEAN eir_complete_list; 611#if (BLE_INCLUDED == TRUE) 612 tBT_DEVICE_TYPE device_type; 613 UINT8 inq_result_type; 614 UINT8 ble_addr_type; 615 tBTM_BLE_EVT_TYPE ble_evt_type; 616 UINT8 flag; 617#endif 618} tBTM_INQ_RESULTS; 619 620 621/* This is the inquiry response information held in its database by BTM, and available 622** to applications via BTM_InqDbRead, BTM_InqDbFirst, and BTM_InqDbNext. 623*/ 624typedef struct 625{ 626 tBTM_INQ_RESULTS results; 627 628 BOOLEAN appl_knows_rem_name; /* set by application if it knows the remote name of the peer device. 629 This is later used by application to determine if remote name request is 630 required to be done. Having the flag here avoid duplicate store of inquiry results */ 631} tBTM_INQ_INFO; 632 633 634/* Structure returned with inquiry complete callback */ 635typedef struct 636{ 637 tBTM_STATUS status; 638 UINT8 num_resp; /* Number of results from the current inquiry */ 639} tBTM_INQUIRY_CMPL; 640 641 642/* Structure returned with remote name request */ 643typedef struct 644{ 645 UINT16 status; 646 BD_ADDR bd_addr; 647 UINT16 length; 648 BD_NAME remote_bd_name; 649} tBTM_REMOTE_DEV_NAME; 650 651typedef struct 652{ 653 UINT8 pcm_intf_rate; /* PCM interface rate: 0: 128kbps, 1: 256 kbps; 654 2:512 bps; 3: 1024kbps; 4: 2048kbps */ 655 UINT8 frame_type; /* frame type: 0: short; 1: long */ 656 UINT8 sync_mode; /* sync mode: 0: slave; 1: master */ 657 UINT8 clock_mode; /* clock mode: 0: slave; 1: master */ 658 659}tBTM_SCO_PCM_PARAM; 660 661/**************************************** 662** Device Discovery Callback Functions 663*****************************************/ 664/* Callback function for asynchronous notifications when the BTM inquiry DB 665** changes. First param is inquiry database, second is if added to or removed 666** from the inquiry database. 667*/ 668typedef void (tBTM_INQ_DB_CHANGE_CB) (void *p1, BOOLEAN is_new); 669 670/* Callback function for notifications when the BTM gets inquiry response. 671** First param is inquiry results database, second is pointer of EIR. 672*/ 673typedef void (tBTM_INQ_RESULTS_CB) (tBTM_INQ_RESULTS *p_inq_results, UINT8 *p_eir); 674 675/***************************************************************************** 676** ACL CHANNEL MANAGEMENT 677*****************************************************************************/ 678/****************** 679** ACL Constants 680*******************/ 681 682/* ACL modes */ 683#define BTM_ACL_MODE_NORMAL HCI_MODE_ACTIVE 684#define BTM_ACL_MODE_HOLD HCI_MODE_HOLD 685#define BTM_ACL_MODE_SNIFF HCI_MODE_SNIFF 686#define BTM_ACL_MODE_PARK HCI_MODE_PARK 687 688/* Returned with structure in role switch callback (tBTM_ROLE_SWITCH_CMPL) */ 689#define BTM_ROLE_MASTER HCI_ROLE_MASTER 690#define BTM_ROLE_SLAVE HCI_ROLE_SLAVE 691#define BTM_ROLE_UNDEFINED 0xff /* undefined value (error status) */ 692 693/* ACL Packet Types */ 694#define BTM_ACL_PKT_TYPES_MASK_DM1 HCI_PKT_TYPES_MASK_DM1 695#define BTM_ACL_PKT_TYPES_MASK_DH1 HCI_PKT_TYPES_MASK_DH1 696#define BTM_ACL_PKT_TYPES_MASK_DM3 HCI_PKT_TYPES_MASK_DM3 697#define BTM_ACL_PKT_TYPES_MASK_DH3 HCI_PKT_TYPES_MASK_DH3 698#define BTM_ACL_PKT_TYPES_MASK_DM5 HCI_PKT_TYPES_MASK_DM5 699#define BTM_ACL_PKT_TYPES_MASK_DH5 HCI_PKT_TYPES_MASK_DH5 700#define BTM_ACL_PKT_TYPES_MASK_NO_2_DH1 HCI_PKT_TYPES_MASK_NO_2_DH1 701#define BTM_ACL_PKT_TYPES_MASK_NO_3_DH1 HCI_PKT_TYPES_MASK_NO_3_DH1 702#define BTM_ACL_PKT_TYPES_MASK_NO_2_DH3 HCI_PKT_TYPES_MASK_NO_2_DH3 703#define BTM_ACL_PKT_TYPES_MASK_NO_3_DH3 HCI_PKT_TYPES_MASK_NO_3_DH3 704#define BTM_ACL_PKT_TYPES_MASK_NO_2_DH5 HCI_PKT_TYPES_MASK_NO_2_DH5 705#define BTM_ACL_PKT_TYPES_MASK_NO_3_DH5 HCI_PKT_TYPES_MASK_NO_3_DH5 706 707/*************** 708** ACL Types 709****************/ 710 711/* Structure returned with Role Switch information (in tBTM_CMPL_CB callback function) 712** in response to BTM_SwitchRole call. 713*/ 714typedef struct 715{ 716 UINT8 hci_status; /* HCI status returned with the event */ 717 UINT8 role; /* BTM_ROLE_MASTER or BTM_ROLE_SLAVE */ 718 BD_ADDR remote_bd_addr; /* Remote BD addr involved with the switch */ 719} tBTM_ROLE_SWITCH_CMPL; 720 721/* Structure returned with QoS information (in tBTM_CMPL_CB callback function) 722** in response to BTM_SetQoS call. 723*/ 724typedef struct 725{ 726 FLOW_SPEC flow; 727 UINT16 handle; 728 UINT8 status; 729} tBTM_QOS_SETUP_CMPL; 730 731 732/* Structure returned with read RSSI event (in tBTM_CMPL_CB callback function) 733** in response to BTM_ReadRSSI call. 734*/ 735typedef struct 736{ 737 tBTM_STATUS status; 738 UINT8 hci_status; 739 INT8 rssi; 740 BD_ADDR rem_bda; 741} tBTM_RSSI_RESULTS; 742 743/* Structure returned with read current TX power event (in tBTM_CMPL_CB callback function) 744** in response to BTM_ReadTxPower call. 745*/ 746typedef struct 747{ 748 tBTM_STATUS status; 749 UINT8 hci_status; 750 INT8 tx_power; 751 BD_ADDR rem_bda; 752} tBTM_TX_POWER_RESULTS; 753 754/* Structure returned with read link quality event (in tBTM_CMPL_CB callback function) 755** in response to BTM_ReadLinkQuality call. 756*/ 757typedef struct 758{ 759 tBTM_STATUS status; 760 UINT8 hci_status; 761 UINT8 link_quality; 762 BD_ADDR rem_bda; 763} tBTM_LINK_QUALITY_RESULTS; 764 765/* Structure returned with read inq tx power quality event (in tBTM_CMPL_CB callback function) 766** in response to BTM_ReadInquiryRspTxPower call. 767*/ 768typedef struct 769{ 770 tBTM_STATUS status; 771 UINT8 hci_status; 772 INT8 tx_power; 773} tBTM_INQ_TXPWR_RESULTS; 774 775enum 776{ 777 BTM_BL_CONN_EVT, 778 BTM_BL_DISCN_EVT, 779 BTM_BL_UPDATE_EVT, 780 BTM_BL_ROLE_CHG_EVT, 781 BTM_BL_COLLISION_EVT 782}; 783typedef UINT8 tBTM_BL_EVENT; 784typedef UINT16 tBTM_BL_EVENT_MASK; 785 786#define BTM_BL_CONN_MASK 0x0001 787#define BTM_BL_DISCN_MASK 0x0002 788#define BTM_BL_UPDATE_MASK 0x0004 789#define BTM_BL_ROLE_CHG_MASK 0x0008 790 791/* Device features mask definitions */ 792#define BTM_FEATURE_BYTES_PER_PAGE HCI_FEATURE_BYTES_PER_PAGE 793#define BTM_EXT_FEATURES_PAGE_MAX HCI_EXT_FEATURES_PAGE_MAX 794 795/* the data type associated with BTM_BL_CONN_EVT */ 796typedef struct 797{ 798 tBTM_BL_EVENT event; /* The event reported. */ 799 BD_ADDR_PTR p_bda; /* The address of the newly connected device */ 800 DEV_CLASS_PTR p_dc; /* The device class */ 801 BD_NAME_PTR p_bdn; /* The device name */ 802 UINT8 *p_features; /* pointer to the remote device's features page[0] (supported features page) */ 803#if BLE_INCLUDED == TRUE 804 UINT16 handle; /* connection handle */ 805 tBT_TRANSPORT transport; /* link is LE or not */ 806#endif 807} tBTM_BL_CONN_DATA; 808 809/* the data type associated with BTM_BL_DISCN_EVT */ 810typedef struct 811{ 812 tBTM_BL_EVENT event; /* The event reported. */ 813 BD_ADDR_PTR p_bda; /* The address of the disconnected device */ 814#if BLE_INCLUDED == TRUE 815 UINT16 handle; /* disconnected connection handle */ 816 tBT_TRANSPORT transport; /* link is LE link or not */ 817#endif 818} tBTM_BL_DISCN_DATA; 819 820/* Busy-Level shall have the inquiry_paging mask set when 821 * inquiry/paging is in progress, Else the number of ACL links */ 822#define BTM_BL_INQUIRY_PAGING_MASK 0x10 823#define BTM_BL_INQUIRY_STARTED (BTM_BL_INQUIRY_PAGING_MASK | 0x1) 824#define BTM_BL_INQUIRY_CANCELLED (BTM_BL_INQUIRY_PAGING_MASK | 0x2) 825#define BTM_BL_INQUIRY_COMPLETE (BTM_BL_INQUIRY_PAGING_MASK | 0x3) 826#define BTM_BL_PAGING_STARTED (BTM_BL_INQUIRY_PAGING_MASK | 0x4) 827#define BTM_BL_PAGING_COMPLETE (BTM_BL_INQUIRY_PAGING_MASK | 0x5) 828/* the data type associated with BTM_BL_UPDATE_EVT */ 829typedef struct 830{ 831 tBTM_BL_EVENT event; /* The event reported. */ 832 UINT8 busy_level;/* when paging or inquiring, level is 10. 833 * Otherwise, the number of ACL links. */ 834 UINT8 busy_level_flags; /* Notifies actual inquiry/page activities */ 835} tBTM_BL_UPDATE_DATA; 836 837/* the data type associated with BTM_BL_ROLE_CHG_EVT */ 838typedef struct 839{ 840 tBTM_BL_EVENT event; /* The event reported. */ 841 BD_ADDR_PTR p_bda; /* The address of the peer connected device */ 842 UINT8 new_role; 843 UINT8 hci_status; /* HCI status returned with the event */ 844} tBTM_BL_ROLE_CHG_DATA; 845 846typedef union 847{ 848 tBTM_BL_EVENT event; /* The event reported. */ 849 tBTM_BL_CONN_DATA conn; /* The data associated with BTM_BL_CONN_EVT */ 850 tBTM_BL_DISCN_DATA discn; /* The data associated with BTM_BL_DISCN_EVT */ 851 tBTM_BL_UPDATE_DATA update; /* The data associated with BTM_BL_UPDATE_EVT */ 852 tBTM_BL_ROLE_CHG_DATA role_chg;/*The data associated with BTM_BL_ROLE_CHG_EVT */ 853} tBTM_BL_EVENT_DATA; 854 855/* Callback function for notifications when the BTM busy level 856** changes. 857*/ 858typedef void (tBTM_BL_CHANGE_CB) (tBTM_BL_EVENT_DATA *p_data); 859 860/*************************** 861** ACL Callback Functions 862****************************/ 863/* Callback function for notifications when the BTM ACL connection DB 864** changes. First param is BD address, second is if added or removed. 865** Registered through BTM_AclRegisterForChanges call. 866*/ 867#if BLE_INCLUDED == TRUE 868typedef void (tBTM_ACL_DB_CHANGE_CB) (BD_ADDR p_bda, DEV_CLASS p_dc, 869 BD_NAME p_bdn, UINT8 *features, 870 BOOLEAN is_new, UINT16 handle, 871 tBT_TRANSPORT transport); 872#else 873typedef void (tBTM_ACL_DB_CHANGE_CB) (BD_ADDR p_bda, DEV_CLASS p_dc, 874 BD_NAME p_bdn, UINT8 *features, 875 BOOLEAN is_new); 876#endif 877/***************************************************************************** 878** SCO CHANNEL MANAGEMENT 879*****************************************************************************/ 880/****************** 881** SCO Constants 882*******************/ 883 884/* Define an invalid SCO index and an invalid HCI handle */ 885#define BTM_INVALID_SCO_INDEX 0xFFFF 886#define BTM_INVALID_HCI_HANDLE 0xFFFF 887 888/* Define an invalid SCO disconnect reason */ 889#define BTM_INVALID_SCO_DISC_REASON 0xFFFF 890 891/* Define first active SCO index */ 892#define BTM_FIRST_ACTIVE_SCO_INDEX BTM_MAX_SCO_LINKS 893 894/* Define SCO packet types used in APIs */ 895#define BTM_SCO_PKT_TYPES_MASK_HV1 HCI_ESCO_PKT_TYPES_MASK_HV1 896#define BTM_SCO_PKT_TYPES_MASK_HV2 HCI_ESCO_PKT_TYPES_MASK_HV2 897#define BTM_SCO_PKT_TYPES_MASK_HV3 HCI_ESCO_PKT_TYPES_MASK_HV3 898#define BTM_SCO_PKT_TYPES_MASK_EV3 HCI_ESCO_PKT_TYPES_MASK_EV3 899#define BTM_SCO_PKT_TYPES_MASK_EV4 HCI_ESCO_PKT_TYPES_MASK_EV4 900#define BTM_SCO_PKT_TYPES_MASK_EV5 HCI_ESCO_PKT_TYPES_MASK_EV5 901#define BTM_SCO_PKT_TYPES_MASK_NO_2_EV3 HCI_ESCO_PKT_TYPES_MASK_NO_2_EV3 902#define BTM_SCO_PKT_TYPES_MASK_NO_3_EV3 HCI_ESCO_PKT_TYPES_MASK_NO_3_EV3 903#define BTM_SCO_PKT_TYPES_MASK_NO_2_EV5 HCI_ESCO_PKT_TYPES_MASK_NO_2_EV5 904#define BTM_SCO_PKT_TYPES_MASK_NO_3_EV5 HCI_ESCO_PKT_TYPES_MASK_NO_3_EV5 905 906#define BTM_SCO_LINK_ONLY_MASK (BTM_SCO_PKT_TYPES_MASK_HV1 | \ 907 BTM_SCO_PKT_TYPES_MASK_HV2 | \ 908 BTM_SCO_PKT_TYPES_MASK_HV3) 909 910#define BTM_ESCO_LINK_ONLY_MASK (BTM_SCO_PKT_TYPES_MASK_EV3 | \ 911 BTM_SCO_PKT_TYPES_MASK_EV4 | \ 912 BTM_SCO_PKT_TYPES_MASK_EV5) 913 914#define BTM_SCO_LINK_ALL_PKT_MASK (BTM_SCO_LINK_ONLY_MASK | \ 915 BTM_ESCO_LINK_ONLY_MASK) 916 917#define BTM_VALID_SCO_ALL_PKT_TYPE HCI_VALID_SCO_ALL_PKT_TYPE 918 919/* Passed in BTM_CreateSco if the packet type parameter should be ignored */ 920#define BTM_IGNORE_SCO_PKT_TYPE 0 921 922/*************** 923** SCO Types 924****************/ 925#define BTM_LINK_TYPE_SCO HCI_LINK_TYPE_SCO 926#define BTM_LINK_TYPE_ESCO HCI_LINK_TYPE_ESCO 927typedef UINT8 tBTM_SCO_TYPE; 928 929 930/******************* 931** SCO Routing Path 932********************/ 933#define BTM_SCO_ROUTE_PCM HCI_BRCM_SCO_ROUTE_PCM 934#define BTM_SCO_ROUTE_HCI HCI_BRCM_SCO_ROUTE_HCI 935typedef UINT8 tBTM_SCO_ROUTE_TYPE; 936 937 938/******************* 939** SCO Codec Types 940********************/ 941// TODO(google) This should use common definitions 942// in hci/include/hci_audio.h 943#define BTM_SCO_CODEC_NONE 0x0000 944#define BTM_SCO_CODEC_CVSD 0x0001 945#define BTM_SCO_CODEC_MSBC 0x0002 946typedef UINT16 tBTM_SCO_CODEC_TYPE; 947 948 949 950/******************* 951** SCO Air Mode Types 952********************/ 953#define BTM_SCO_AIR_MODE_U_LAW 0 954#define BTM_SCO_AIR_MODE_A_LAW 1 955#define BTM_SCO_AIR_MODE_CVSD 2 956#define BTM_SCO_AIR_MODE_TRANSPNT 3 957typedef UINT8 tBTM_SCO_AIR_MODE_TYPE; 958 959/******************* 960** SCO Voice Settings 961********************/ 962#define BTM_VOICE_SETTING_CVSD ((UINT16) (HCI_INP_CODING_LINEAR | \ 963 HCI_INP_DATA_FMT_2S_COMPLEMENT | \ 964 HCI_INP_SAMPLE_SIZE_16BIT | \ 965 HCI_AIR_CODING_FORMAT_CVSD)) 966 967#define BTM_VOICE_SETTING_TRANS ((UINT16) (HCI_INP_CODING_LINEAR | \ 968 HCI_INP_DATA_FMT_2S_COMPLEMENT | \ 969 HCI_INP_SAMPLE_SIZE_16BIT | \ 970 HCI_AIR_CODING_FORMAT_TRANSPNT)) 971 972/******************* 973** SCO Data Status 974********************/ 975enum 976{ 977 BTM_SCO_DATA_CORRECT, 978 BTM_SCO_DATA_PAR_ERR, 979 BTM_SCO_DATA_NONE, 980 BTM_SCO_DATA_PAR_LOST 981}; 982typedef UINT8 tBTM_SCO_DATA_FLAG; 983 984/*************************** 985** SCO Callback Functions 986****************************/ 987typedef void (tBTM_SCO_CB) (UINT16 sco_inx); 988typedef void (tBTM_SCO_DATA_CB) (UINT16 sco_inx, BT_HDR *p_data, tBTM_SCO_DATA_FLAG status); 989 990/****************** 991** eSCO Constants 992*******************/ 993#define BTM_64KBITS_RATE 0x00001f40 /* 64 kbits/sec data rate */ 994 995/* Retransmission effort */ 996#define BTM_ESCO_RETRANS_OFF 0 997#define BTM_ESCO_RETRANS_POWER 1 998#define BTM_ESCO_RETRANS_QUALITY 2 999#define BTM_ESCO_RETRANS_DONTCARE 0xff 1000 1001/* Max Latency Don't Care */ 1002#define BTM_ESCO_MAX_LAT_DONTCARE 0xffff 1003 1004/*************** 1005** eSCO Types 1006****************/ 1007/* tBTM_ESCO_CBACK event types */ 1008#define BTM_ESCO_CHG_EVT 1 1009#define BTM_ESCO_CONN_REQ_EVT 2 1010typedef UINT8 tBTM_ESCO_EVT; 1011 1012/* Passed into BTM_SetEScoMode() */ 1013typedef struct 1014{ 1015 UINT32 tx_bw; 1016 UINT32 rx_bw; 1017 UINT16 max_latency; 1018 UINT16 voice_contfmt; /* Voice Settings or Content Format */ 1019 UINT16 packet_types; 1020 UINT8 retrans_effort; 1021} tBTM_ESCO_PARAMS; 1022 1023typedef struct 1024{ 1025 UINT16 max_latency; 1026 UINT16 packet_types; 1027 UINT8 retrans_effort; 1028} tBTM_CHG_ESCO_PARAMS; 1029 1030/* Returned by BTM_ReadEScoLinkParms() */ 1031typedef struct 1032{ 1033 UINT16 rx_pkt_len; 1034 UINT16 tx_pkt_len; 1035 BD_ADDR bd_addr; 1036 UINT8 link_type; /* BTM_LINK_TYPE_SCO or BTM_LINK_TYPE_ESCO */ 1037 UINT8 tx_interval; 1038 UINT8 retrans_window; 1039 UINT8 air_mode; 1040} tBTM_ESCO_DATA; 1041 1042typedef struct 1043{ 1044 UINT16 sco_inx; 1045 UINT16 rx_pkt_len; 1046 UINT16 tx_pkt_len; 1047 BD_ADDR bd_addr; 1048 UINT8 hci_status; 1049 UINT8 tx_interval; 1050 UINT8 retrans_window; 1051} tBTM_CHG_ESCO_EVT_DATA; 1052 1053typedef struct 1054{ 1055 UINT16 sco_inx; 1056 BD_ADDR bd_addr; 1057 DEV_CLASS dev_class; 1058 tBTM_SCO_TYPE link_type; 1059} tBTM_ESCO_CONN_REQ_EVT_DATA; 1060 1061typedef union 1062{ 1063 tBTM_CHG_ESCO_EVT_DATA chg_evt; 1064 tBTM_ESCO_CONN_REQ_EVT_DATA conn_evt; 1065} tBTM_ESCO_EVT_DATA; 1066 1067/*************************** 1068** eSCO Callback Functions 1069****************************/ 1070typedef void (tBTM_ESCO_CBACK) (tBTM_ESCO_EVT event, tBTM_ESCO_EVT_DATA *p_data); 1071 1072 1073/***************************************************************************** 1074** SECURITY MANAGEMENT 1075*****************************************************************************/ 1076/******************************* 1077** Security Manager Constants 1078********************************/ 1079 1080/* Security Mode (BTM_SetSecurityMode) */ 1081#define BTM_SEC_MODE_UNDEFINED 0 1082#define BTM_SEC_MODE_NONE 1 1083#define BTM_SEC_MODE_SERVICE 2 1084#define BTM_SEC_MODE_LINK 3 1085#define BTM_SEC_MODE_SP 4 1086#define BTM_SEC_MODE_SP_DEBUG 5 1087#define BTM_SEC_MODE_SC 6 1088 1089/* Maximum Number of BTM Security Modes */ 1090#define BTM_SEC_MODES_MAX 7 1091 1092/* Security Service Levels [bit mask] (BTM_SetSecurityLevel) 1093** Encryption should not be used without authentication 1094*/ 1095#define BTM_SEC_NONE 0x0000 /* Nothing required */ 1096#define BTM_SEC_IN_AUTHORIZE 0x0001 /* Inbound call requires authorization */ 1097#define BTM_SEC_IN_AUTHENTICATE 0x0002 /* Inbound call requires authentication */ 1098#define BTM_SEC_IN_ENCRYPT 0x0004 /* Inbound call requires encryption */ 1099#define BTM_SEC_OUT_AUTHORIZE 0x0008 /* Outbound call requires authorization */ 1100#define BTM_SEC_OUT_AUTHENTICATE 0x0010 /* Outbound call requires authentication */ 1101#define BTM_SEC_OUT_ENCRYPT 0x0020 /* Outbound call requires encryption */ 1102#define BTM_SEC_MODE4_LEVEL4 0x0040 /* Secure Connections Only Mode */ 1103#define BTM_SEC_FORCE_MASTER 0x0100 /* Need to switch connection to be master */ 1104#define BTM_SEC_ATTEMPT_MASTER 0x0200 /* Try to switch connection to be master */ 1105#define BTM_SEC_FORCE_SLAVE 0x0400 /* Need to switch connection to be master */ 1106#define BTM_SEC_ATTEMPT_SLAVE 0x0800 /* Try to switch connection to be slave */ 1107#define BTM_SEC_IN_MITM 0x1000 /* inbound Do man in the middle protection */ 1108#define BTM_SEC_OUT_MITM 0x2000 /* outbound Do man in the middle protection */ 1109 1110/* Security Flags [bit mask] (BTM_GetSecurityFlags) 1111*/ 1112#define BTM_SEC_FLAG_AUTHORIZED 0x01 1113#define BTM_SEC_FLAG_AUTHENTICATED 0x02 1114#define BTM_SEC_FLAG_ENCRYPTED 0x04 1115#define BTM_SEC_FLAG_LKEY_KNOWN 0x10 1116#define BTM_SEC_FLAG_LKEY_AUTHED 0x20 1117 1118/* PIN types */ 1119#define BTM_PIN_TYPE_VARIABLE HCI_PIN_TYPE_VARIABLE 1120#define BTM_PIN_TYPE_FIXED HCI_PIN_TYPE_FIXED 1121 1122/* Link Key types used to generate the new link key. 1123** returned in link key notification callback function 1124*/ 1125#define BTM_LKEY_TYPE_COMBINATION HCI_LKEY_TYPE_COMBINATION 1126#define BTM_LKEY_TYPE_LOCAL_UNIT HCI_LKEY_TYPE_LOCAL_UNIT 1127#define BTM_LKEY_TYPE_REMOTE_UNIT HCI_LKEY_TYPE_REMOTE_UNIT 1128#define BTM_LKEY_TYPE_DEBUG_COMB HCI_LKEY_TYPE_DEBUG_COMB 1129#define BTM_LKEY_TYPE_UNAUTH_COMB HCI_LKEY_TYPE_UNAUTH_COMB 1130#define BTM_LKEY_TYPE_AUTH_COMB HCI_LKEY_TYPE_AUTH_COMB 1131#define BTM_LKEY_TYPE_CHANGED_COMB HCI_LKEY_TYPE_CHANGED_COMB 1132 1133#define BTM_LKEY_TYPE_UNAUTH_COMB_P_256 HCI_LKEY_TYPE_UNAUTH_COMB_P_256 1134#define BTM_LKEY_TYPE_AUTH_COMB_P_256 HCI_LKEY_TYPE_AUTH_COMB_P_256 1135 1136#define BTM_LTK_DERIVED_LKEY_OFFSET 0x20 /* "easy" requirements for LK derived from LTK */ 1137#define BTM_LKEY_TYPE_IGNORE 0xff /* used when event is response from 1138 hci return link keys request */ 1139 1140typedef UINT8 tBTM_LINK_KEY_TYPE; 1141 1142/* Protocol level security (BTM_SetSecurityLevel) */ 1143#define BTM_SEC_PROTO_L2CAP 0 1144#define BTM_SEC_PROTO_SDP 1 1145#define BTM_SEC_PROTO_TCS 2 1146#define BTM_SEC_PROTO_RFCOMM 3 1147#define BTM_SEC_PROTO_OBEX 4 1148#define BTM_SEC_PROTO_BNEP 5 1149#define BTM_SEC_PROTO_HID 6 /* HID */ 1150#define BTM_SEC_PROTO_AVDT 7 1151#define BTM_SEC_PROTO_MCA 8 1152 1153/* Determine the number of UINT32's necessary for security services */ 1154#define BTM_SEC_ARRAY_BITS 32 /* Number of bits in each array element */ 1155#define BTM_SEC_SERVICE_ARRAY_SIZE (((UINT32)BTM_SEC_MAX_SERVICES / BTM_SEC_ARRAY_BITS) + \ 1156 (((UINT32)BTM_SEC_MAX_SERVICES % BTM_SEC_ARRAY_BITS) ? 1 : 0)) 1157 1158/* Security service definitions (BTM_SetSecurityLevel) 1159** Used for Authorization APIs 1160*/ 1161#define BTM_SEC_SERVICE_SDP_SERVER 0 1162#define BTM_SEC_SERVICE_SERIAL_PORT 1 1163#define BTM_SEC_SERVICE_LAN_ACCESS 2 1164#define BTM_SEC_SERVICE_DUN 3 1165#define BTM_SEC_SERVICE_IRMC_SYNC 4 1166#define BTM_SEC_SERVICE_IRMC_SYNC_CMD 5 1167#define BTM_SEC_SERVICE_OBEX 6 1168#define BTM_SEC_SERVICE_OBEX_FTP 7 1169#define BTM_SEC_SERVICE_HEADSET 8 1170#define BTM_SEC_SERVICE_CORDLESS 9 1171#define BTM_SEC_SERVICE_INTERCOM 10 1172#define BTM_SEC_SERVICE_FAX 11 1173#define BTM_SEC_SERVICE_HEADSET_AG 12 1174#define BTM_SEC_SERVICE_PNP_INFO 13 1175#define BTM_SEC_SERVICE_GEN_NET 14 1176#define BTM_SEC_SERVICE_GEN_FILE 15 1177#define BTM_SEC_SERVICE_GEN_AUDIO 16 1178#define BTM_SEC_SERVICE_GEN_TEL 17 1179#define BTM_SEC_SERVICE_CTP_DATA 18 1180#define BTM_SEC_SERVICE_HCRP_CTRL 19 1181#define BTM_SEC_SERVICE_HCRP_DATA 20 1182#define BTM_SEC_SERVICE_HCRP_NOTIF 21 1183#define BTM_SEC_SERVICE_BPP_JOB 22 1184#define BTM_SEC_SERVICE_BPP_STATUS 23 1185#define BTM_SEC_SERVICE_BPP_REF 24 1186#define BTM_SEC_SERVICE_BNEP_PANU 25 1187#define BTM_SEC_SERVICE_BNEP_GN 26 1188#define BTM_SEC_SERVICE_BNEP_NAP 27 1189#define BTM_SEC_SERVICE_HF_HANDSFREE 28 1190#define BTM_SEC_SERVICE_AG_HANDSFREE 29 1191#define BTM_SEC_SERVICE_TE_PHONE_ACCESS 30 1192#define BTM_SEC_SERVICE_ME_PHONE_ACCESS 31 1193 1194#define BTM_SEC_SERVICE_HIDH_SEC_CTRL 32 1195#define BTM_SEC_SERVICE_HIDH_NOSEC_CTRL 33 1196#define BTM_SEC_SERVICE_HIDH_INTR 34 1197#define BTM_SEC_SERVICE_BIP 35 1198#define BTM_SEC_SERVICE_BIP_REF 36 1199#define BTM_SEC_SERVICE_AVDTP 37 1200#define BTM_SEC_SERVICE_AVDTP_NOSEC 38 1201#define BTM_SEC_SERVICE_AVCTP 39 1202#define BTM_SEC_SERVICE_SAP 40 1203#define BTM_SEC_SERVICE_PBAP 41 1204#define BTM_SEC_SERVICE_RFC_MUX 42 1205#define BTM_SEC_SERVICE_AVCTP_BROWSE 43 1206#define BTM_SEC_SERVICE_MAP 44 1207#define BTM_SEC_SERVICE_MAP_NOTIF 45 1208#define BTM_SEC_SERVICE_MCAP_CTRL 46 1209#define BTM_SEC_SERVICE_MCAP_DATA 47 1210#define BTM_SEC_SERVICE_HDP_SNK 48 1211#define BTM_SEC_SERVICE_HDP_SRC 49 1212#define BTM_SEC_SERVICE_ATT 50 1213 1214/* Update these as services are added */ 1215#define BTM_SEC_SERVICE_FIRST_EMPTY 51 1216 1217#ifndef BTM_SEC_MAX_SERVICES 1218#define BTM_SEC_MAX_SERVICES 65 1219#endif 1220 1221/************************************************************************************************ 1222** Security Services MACROS handle array of UINT32 bits for more than 32 trusted services 1223*************************************************************************************************/ 1224/* MACRO to set the security service bit mask in a bit stream */ 1225#define BTM_SEC_SET_SERVICE(p, service) (((UINT32 *)(p))[(((UINT32)(service)) / BTM_SEC_ARRAY_BITS)] |= \ 1226 ((UINT32)1 << (((UINT32)(service)) % BTM_SEC_ARRAY_BITS))) 1227 1228 1229/* MACRO to clear the security service bit mask in a bit stream */ 1230#define BTM_SEC_CLR_SERVICE(p, service) (((UINT32 *)(p))[(((UINT32)(service)) / BTM_SEC_ARRAY_BITS)] &= \ 1231 ~((UINT32)1 << (((UINT32)(service)) % BTM_SEC_ARRAY_BITS))) 1232 1233/* MACRO to check the security service bit mask in a bit stream (Returns TRUE or FALSE) */ 1234#define BTM_SEC_IS_SERVICE_TRUSTED(p, service) (((((UINT32 *)(p))[(((UINT32)(service)) / BTM_SEC_ARRAY_BITS)]) & \ 1235 (UINT32)(((UINT32)1 << (((UINT32)(service)) % BTM_SEC_ARRAY_BITS)))) ? TRUE : FALSE) 1236 1237/* MACRO to copy two trusted device bitmask */ 1238#define BTM_SEC_COPY_TRUSTED_DEVICE(p_src, p_dst) {UINT32 trst; for (trst = 0; trst < BTM_SEC_SERVICE_ARRAY_SIZE; trst++) \ 1239 ((UINT32 *)(p_dst))[trst] = ((UINT32 *)(p_src))[trst];} 1240 1241/* MACRO to clear two trusted device bitmask */ 1242#define BTM_SEC_CLR_TRUSTED_DEVICE(p_dst) {UINT32 trst; for (trst = 0; trst < BTM_SEC_SERVICE_ARRAY_SIZE; trst++) \ 1243 ((UINT32 *)(p_dst))[trst] = 0;} 1244 1245/* Following bits can be provided by host in the trusted_mask array */ 1246/* 0..31 bits of mask[0] (Least Significant Word) */ 1247#define BTM_SEC_TRUST_SDP_SERVER (1 << BTM_SEC_SERVICE_SDP_SERVER) 1248#define BTM_SEC_TRUST_SERIAL_PORT (1 << BTM_SEC_SERVICE_SERIAL_PORT) 1249#define BTM_SEC_TRUST_LAN_ACCESS (1 << BTM_SEC_SERVICE_LAN_ACCESS) 1250#define BTM_SEC_TRUST_DUN (1 << BTM_SEC_SERVICE_DUN) 1251#define BTM_SEC_TRUST_IRMC_SYNC (1 << BTM_SEC_SERVICE_IRMC_SYNC) 1252#define BTM_SEC_TRUST_IRMC_SYNC_CMD (1 << BTM_SEC_SERVICE_IRMC_SYNC_CMD) 1253#define BTM_SEC_TRUST_OBEX (1 << BTM_SEC_SERVICE_OBEX) 1254#define BTM_SEC_TRUST_OBEX_FTP (1 << BTM_SEC_SERVICE_OBEX_FTP) 1255#define BTM_SEC_TRUST_HEADSET (1 << BTM_SEC_SERVICE_HEADSET) 1256#define BTM_SEC_TRUST_CORDLESS (1 << BTM_SEC_SERVICE_CORDLESS) 1257#define BTM_SEC_TRUST_INTERCOM (1 << BTM_SEC_SERVICE_INTERCOM) 1258#define BTM_SEC_TRUST_FAX (1 << BTM_SEC_SERVICE_FAX) 1259#define BTM_SEC_TRUST_HEADSET_AG (1 << BTM_SEC_SERVICE_HEADSET_AG) 1260#define BTM_SEC_TRUST_PNP_INFO (1 << BTM_SEC_SERVICE_PNP_INFO) 1261#define BTM_SEC_TRUST_GEN_NET (1 << BTM_SEC_SERVICE_GEN_NET) 1262#define BTM_SEC_TRUST_GEN_FILE (1 << BTM_SEC_SERVICE_GEN_FILE) 1263#define BTM_SEC_TRUST_GEN_AUDIO (1 << BTM_SEC_SERVICE_GEN_AUDIO) 1264#define BTM_SEC_TRUST_GEN_TEL (1 << BTM_SEC_SERVICE_GEN_TEL) 1265#define BTM_SEC_TRUST_CTP_DATA (1 << BTM_SEC_SERVICE_CTP_DATA) 1266#define BTM_SEC_TRUST_HCRP_CTRL (1 << BTM_SEC_SERVICE_HCRP_CTRL) 1267#define BTM_SEC_TRUST_HCRP_DATA (1 << BTM_SEC_SERVICE_HCRP_DATA) 1268#define BTM_SEC_TRUST_HCRP_NOTIF (1 << BTM_SEC_SERVICE_HCRP_NOTIF) 1269#define BTM_SEC_TRUST_BPP_JOB (1 << BTM_SEC_SERVICE_JOB) 1270#define BTM_SEC_TRUST_BPP_STATUS (1 << BTM_SEC_SERVICE_STATUS) 1271#define BTM_SEC_TRUST_BPP_REF (1 << BTM_SEC_SERVICE_REF) 1272#define BTM_SEC_TRUST_BNEP_PANU (1 << BTM_SEC_SERVICE_BNEP_PANU) 1273#define BTM_SEC_TRUST_BNEP_GN (1 << BTM_SEC_SERVICE_BNEP_GN) 1274#define BTM_SEC_TRUST_BNEP_NAP (1 << BTM_SEC_SERVICE_BNEP_NAP) 1275#define BTM_SEC_TRUST_HFP_HF (1 << BTM_SEC_SERVICE_HF_HANDSFREE) 1276#define BTM_SEC_TRUST_HFP_AG (1 << BTM_SEC_SERVICE_AG_HANDSFREE) 1277#define BTM_SEC_TRUST_TE_PHONE_ACCESS (1 << BTM_SEC_SERVICE_TE_PHONE_ACCESS) 1278#define BTM_SEC_TRUST_ME_PHONE_ACCESS (1 << BTM_SEC_SERVICE_ME_PHONE_ACCESS) 1279 1280/* 0..31 bits of mask[1] (Most Significant Word) */ 1281#define BTM_SEC_TRUST_HIDH_CTRL (1 << (BTM_SEC_SERVICE_HIDH_SEC_CTRL - 32)) 1282#define BTM_SEC_TRUST_HIDH_NOSEC_CTRL (1 << (BTM_SEC_SERVICE_HIDH_NOSEC_CTRL - 32)) 1283#define BTM_SEC_TRUST_HIDH_INTR (1 << (BTM_SEC_SERVICE_HIDH_INTR - 32)) 1284#define BTM_SEC_TRUST_BIP (1 << (BTM_SEC_SERVICE_BIP - 32)) 1285#define BTM_SEC_TRUST_BIP_REF (1 << (BTM_SEC_SERVICE_BIP_REF - 32)) 1286#define BTM_SEC_TRUST_AVDTP (1 << (BTM_SEC_SERVICE_AVDTP - 32)) 1287#define BTM_SEC_TRUST_AVDTP_NOSEC (1 << (BTM_SEC_SERVICE_AVDTP_NOSEC - 32)) 1288#define BTM_SEC_TRUST_AVCTP (1 << (BTM_SEC_SERVICE_AVCTP - 32)) 1289#define BTM_SEC_TRUST_SAP (1 << (BTM_SEC_SERVICE_SAP - 32)) 1290#define BTM_SEC_TRUST_PBAP (1 << (BTM_SEC_SERVICE_PBAP - 32)) 1291#define BTM_SEC_TRUST_RFC_MUX (1 << (BTM_SEC_SERVICE_RFC_MUX - 32)) 1292#define BTM_SEC_TRUST_AVCTP_BROWSE (1 << (BTM_SEC_SERVICE_AVCTP_BROWSE - 32)) 1293#define BTM_SEC_TRUST_MAP (1 << (BTM_SEC_SERVICE_MAP - 32)) 1294#define BTM_SEC_TRUST_MAP_NOTIF (1 << (BTM_SEC_SERVICE_MAP_NOTIF - 32)) 1295#define BTM_SEC_TRUST_MCAP_CTRL (1 << (BTM_SEC_SERVICE_MCAP_CTRL - 32)) 1296#define BTM_SEC_TRUST_MCAP_DATA (1 << (BTM_SEC_SERVICE_MCAP_DATA - 32)) 1297#define BTM_SEC_TRUST_HDP_SNK (1 << (BTM_SEC_SERVICE_HDP_SNK - 32)) 1298#define BTM_SEC_TRUST_HDP_SRC (1 << (BTM_SEC_SERVICE_HDP_SRC - 32)) 1299 1300#define BTM_SEC_TRUST_ALL 0xFFFFFFFF /* for each array element */ 1301 1302/**************************************** 1303** Security Manager Callback Functions 1304*****************************************/ 1305/* Authorize device for service. Parameters are 1306** BD Address of remote 1307** Device Class of remote 1308** BD Name of remote 1309** Service name 1310** Service Id (NULL - unknown service or unused 1311** [BTM_SEC_SERVICE_NAME_LEN set to 0]) 1312** Is originator of the connection 1313** Result of the operation 1314*/ 1315typedef UINT8 (tBTM_AUTHORIZE_CALLBACK) (BD_ADDR bd_addr, DEV_CLASS dev_class, 1316 tBTM_BD_NAME bd_name, UINT8 *service_name, 1317 UINT8 service_id, BOOLEAN is_originator); 1318 1319/* Get PIN for the connection. Parameters are 1320** BD Address of remote 1321** Device Class of remote 1322** BD Name of remote 1323*/ 1324typedef UINT8 (tBTM_PIN_CALLBACK) (BD_ADDR bd_addr, DEV_CLASS dev_class, 1325 tBTM_BD_NAME bd_name); 1326 1327/* New Link Key for the connection. Parameters are 1328** BD Address of remote 1329** Link Key 1330** Key Type: Combination, Local Unit, or Remote Unit 1331*/ 1332typedef UINT8 (tBTM_LINK_KEY_CALLBACK) (BD_ADDR bd_addr, DEV_CLASS dev_class, 1333 tBTM_BD_NAME bd_name, UINT8 *key, 1334 UINT8 key_type); 1335 1336 1337/* Remote Name Resolved. Parameters are 1338** BD Address of remote 1339** BD Name of remote 1340*/ 1341typedef void (tBTM_RMT_NAME_CALLBACK) (BD_ADDR bd_addr, DEV_CLASS dc, 1342 tBTM_BD_NAME bd_name); 1343 1344 1345/* Authentication complete for the connection. Parameters are 1346** BD Address of remote 1347** Device Class of remote 1348** BD Name of remote 1349** 1350*/ 1351typedef UINT8 (tBTM_AUTH_COMPLETE_CALLBACK) (BD_ADDR bd_addr, DEV_CLASS dev_class, 1352 tBTM_BD_NAME bd_name, int result); 1353 1354enum 1355{ 1356 BTM_SP_IO_REQ_EVT, /* received IO_CAPABILITY_REQUEST event */ 1357 BTM_SP_IO_RSP_EVT, /* received IO_CAPABILITY_RESPONSE event */ 1358 BTM_SP_CFM_REQ_EVT, /* received USER_CONFIRMATION_REQUEST event */ 1359 BTM_SP_KEY_NOTIF_EVT, /* received USER_PASSKEY_NOTIFY event */ 1360 BTM_SP_KEY_REQ_EVT, /* received USER_PASSKEY_REQUEST event */ 1361 BTM_SP_KEYPRESS_EVT, /* received KEYPRESS_NOTIFY event */ 1362 BTM_SP_LOC_OOB_EVT, /* received result for READ_LOCAL_OOB_DATA command */ 1363 BTM_SP_RMT_OOB_EVT, /* received REMOTE_OOB_DATA_REQUEST event */ 1364 BTM_SP_COMPLT_EVT, /* received SIMPLE_PAIRING_COMPLETE event */ 1365 BTM_SP_UPGRADE_EVT /* check if the application wants to upgrade the link key */ 1366}; 1367typedef UINT8 tBTM_SP_EVT; 1368 1369#define BTM_IO_CAP_OUT 0 /* DisplayOnly */ 1370#define BTM_IO_CAP_IO 1 /* DisplayYesNo */ 1371#define BTM_IO_CAP_IN 2 /* KeyboardOnly */ 1372#define BTM_IO_CAP_NONE 3 /* NoInputNoOutput */ 1373#if BLE_INCLUDED == TRUE && SMP_INCLUDED == TRUE 1374#define BTM_IO_CAP_KBDISP 4 /* Keyboard display */ 1375#define BTM_IO_CAP_MAX 5 1376#else 1377#define BTM_IO_CAP_MAX 4 1378#endif 1379 1380typedef UINT8 tBTM_IO_CAP; 1381 1382#define BTM_MAX_PASSKEY_VAL (999999) 1383#define BTM_MIN_PASSKEY_VAL (0) 1384 1385#define BTM_AUTH_SP_NO 0 /* MITM Protection Not Required - Single Profile/non-bonding 1386 Numeric comparison with automatic accept allowed */ 1387#define BTM_AUTH_SP_YES 1 /* MITM Protection Required - Single Profile/non-bonding 1388 Use IO Capabilities to determine authentication procedure */ 1389#define BTM_AUTH_AP_NO 2 /* MITM Protection Not Required - All Profiles/dedicated bonding 1390 Numeric comparison with automatic accept allowed */ 1391#define BTM_AUTH_AP_YES 3 /* MITM Protection Required - All Profiles/dedicated bonding 1392 Use IO Capabilities to determine authentication procedure */ 1393#define BTM_AUTH_SPGB_NO 4 /* MITM Protection Not Required - Single Profiles/general bonding 1394 Numeric comparison with automatic accept allowed */ 1395#define BTM_AUTH_SPGB_YES 5 /* MITM Protection Required - Single Profiles/general bonding 1396 Use IO Capabilities to determine authentication procedure */ 1397#define BTM_AUTH_DD_BOND 2 /* this bit is ORed to the BTM_AUTH_SP_* when IO exchange for dedicated bonding */ 1398#define BTM_AUTH_GB_BIT 4 /* the genernal bonding bit */ 1399#define BTM_AUTH_BONDS 6 /* the general/dedicated bonding bits */ 1400#define BTM_AUTH_YN_BIT 1 /* this is the Yes or No bit */ 1401 1402#define BTM_BLE_INITIATOR_KEY_SIZE 15 1403#define BTM_BLE_RESPONDER_KEY_SIZE 15 1404#define BTM_BLE_MAX_KEY_SIZE 16 1405 1406typedef UINT8 tBTM_AUTH_REQ; 1407 1408enum 1409{ 1410 BTM_OOB_NONE, 1411 BTM_OOB_PRESENT 1412#if BTM_OOB_INCLUDED == TRUE 1413 ,BTM_OOB_UNKNOWN 1414#endif 1415}; 1416typedef UINT8 tBTM_OOB_DATA; 1417 1418/* data type for BTM_SP_IO_REQ_EVT */ 1419typedef struct 1420{ 1421 BD_ADDR bd_addr; /* peer address */ 1422 tBTM_IO_CAP io_cap; /* local IO capabilities */ 1423 tBTM_OOB_DATA oob_data; /* OOB data present (locally) for the peer device */ 1424 tBTM_AUTH_REQ auth_req; /* Authentication required (for local device) */ 1425 BOOLEAN is_orig; /* TRUE, if local device initiated the SP process */ 1426} tBTM_SP_IO_REQ; 1427 1428/* data type for BTM_SP_IO_RSP_EVT */ 1429typedef struct 1430{ 1431 BD_ADDR bd_addr; /* peer address */ 1432 tBTM_IO_CAP io_cap; /* peer IO capabilities */ 1433 tBTM_OOB_DATA oob_data; /* OOB data present at peer device for the local device */ 1434 tBTM_AUTH_REQ auth_req; /* Authentication required for peer device */ 1435} tBTM_SP_IO_RSP; 1436 1437/* data type for BTM_SP_CFM_REQ_EVT */ 1438typedef struct 1439{ 1440 BD_ADDR bd_addr; /* peer address */ 1441 DEV_CLASS dev_class; /* peer CoD */ 1442 tBTM_BD_NAME bd_name; /* peer device name */ 1443 UINT32 num_val; /* the numeric value for comparison. If just_works, do not show this number to UI */ 1444 BOOLEAN just_works; /* TRUE, if "Just Works" association model */ 1445 tBTM_AUTH_REQ loc_auth_req; /* Authentication required for local device */ 1446 tBTM_AUTH_REQ rmt_auth_req; /* Authentication required for peer device */ 1447 tBTM_IO_CAP loc_io_caps; /* IO Capabilities of the local device */ 1448 tBTM_IO_CAP rmt_io_caps; /* IO Capabilities of the remot device */ 1449} tBTM_SP_CFM_REQ; 1450 1451/* data type for BTM_SP_KEY_REQ_EVT */ 1452typedef struct 1453{ 1454 BD_ADDR bd_addr; /* peer address */ 1455 DEV_CLASS dev_class; /* peer CoD */ 1456 tBTM_BD_NAME bd_name; /* peer device name */ 1457} tBTM_SP_KEY_REQ; 1458 1459/* data type for BTM_SP_KEY_NOTIF_EVT */ 1460typedef struct 1461{ 1462 BD_ADDR bd_addr; /* peer address */ 1463 DEV_CLASS dev_class; /* peer CoD */ 1464 tBTM_BD_NAME bd_name; /* peer device name */ 1465 UINT32 passkey; /* passkey */ 1466} tBTM_SP_KEY_NOTIF; 1467 1468enum 1469{ 1470 BTM_SP_KEY_STARTED, /* 0 - passkey entry started */ 1471 BTM_SP_KEY_ENTERED, /* 1 - passkey digit entered */ 1472 BTM_SP_KEY_ERASED, /* 2 - passkey digit erased */ 1473 BTM_SP_KEY_CLEARED, /* 3 - passkey cleared */ 1474 BTM_SP_KEY_COMPLT, /* 4 - passkey entry completed */ 1475 BTM_SP_KEY_OUT_OF_RANGE /* 5 - out of range */ 1476}; 1477typedef UINT8 tBTM_SP_KEY_TYPE; 1478 1479/* data type for BTM_SP_KEYPRESS_EVT */ 1480typedef struct 1481{ 1482 BD_ADDR bd_addr; /* peer address */ 1483 tBTM_SP_KEY_TYPE notif_type; 1484} tBTM_SP_KEYPRESS; 1485 1486/* data type for BTM_SP_LOC_OOB_EVT */ 1487typedef struct 1488{ 1489 tBTM_STATUS status; /* */ 1490 BT_OCTET16 c; /* Simple Pairing Hash C */ 1491 BT_OCTET16 r; /* Simple Pairing Randomnizer R */ 1492} tBTM_SP_LOC_OOB; 1493 1494/* data type for BTM_SP_RMT_OOB_EVT */ 1495typedef struct 1496{ 1497 BD_ADDR bd_addr; /* peer address */ 1498 DEV_CLASS dev_class; /* peer CoD */ 1499 tBTM_BD_NAME bd_name; /* peer device name */ 1500} tBTM_SP_RMT_OOB; 1501 1502 1503/* data type for BTM_SP_COMPLT_EVT */ 1504typedef struct 1505{ 1506 BD_ADDR bd_addr; /* peer address */ 1507 DEV_CLASS dev_class; /* peer CoD */ 1508 tBTM_BD_NAME bd_name; /* peer device name */ 1509 tBTM_STATUS status; /* status of the simple pairing process */ 1510} tBTM_SP_COMPLT; 1511 1512/* data type for BTM_SP_UPGRADE_EVT */ 1513typedef struct 1514{ 1515 BD_ADDR bd_addr; /* peer address */ 1516 BOOLEAN upgrade; /* TRUE, to upgrade the link key */ 1517} tBTM_SP_UPGRADE; 1518 1519typedef union 1520{ 1521 tBTM_SP_IO_REQ io_req; /* BTM_SP_IO_REQ_EVT */ 1522 tBTM_SP_IO_RSP io_rsp; /* BTM_SP_IO_RSP_EVT */ 1523 tBTM_SP_CFM_REQ cfm_req; /* BTM_SP_CFM_REQ_EVT */ 1524 tBTM_SP_KEY_NOTIF key_notif; /* BTM_SP_KEY_NOTIF_EVT */ 1525 tBTM_SP_KEY_REQ key_req; /* BTM_SP_KEY_REQ_EVT */ 1526 tBTM_SP_KEYPRESS key_press; /* BTM_SP_KEYPRESS_EVT */ 1527 tBTM_SP_LOC_OOB loc_oob; /* BTM_SP_LOC_OOB_EVT */ 1528 tBTM_SP_RMT_OOB rmt_oob; /* BTM_SP_RMT_OOB_EVT */ 1529 tBTM_SP_COMPLT complt; /* BTM_SP_COMPLT_EVT */ 1530 tBTM_SP_UPGRADE upgrade; /* BTM_SP_UPGRADE_EVT */ 1531} tBTM_SP_EVT_DATA; 1532 1533/* Simple Pairing Events. Called by the stack when Simple Pairing related 1534** events occur. 1535*/ 1536typedef UINT8 (tBTM_SP_CALLBACK) (tBTM_SP_EVT event, tBTM_SP_EVT_DATA *p_data); 1537 1538 1539typedef void (tBTM_MKEY_CALLBACK) (BD_ADDR bd_addr, UINT8 status, UINT8 key_flag) ; 1540 1541/* Encryption enabled/disabled complete: Optionally passed with BTM_SetEncryption. 1542** Parameters are 1543** BD Address of remote 1544** optional data passed in by BTM_SetEncryption 1545** tBTM_STATUS - result of the operation 1546*/ 1547typedef void (tBTM_SEC_CBACK) (BD_ADDR bd_addr, tBT_TRANSPORT trasnport, 1548 void *p_ref_data, tBTM_STATUS result); 1549 1550/* Bond Cancel complete. Parameters are 1551** Result of the cancel operation 1552** 1553*/ 1554typedef void (tBTM_BOND_CANCEL_CMPL_CALLBACK) (tBTM_STATUS result); 1555 1556/* LE related event and data structure 1557*/ 1558#define BTM_LE_IO_REQ_EVT SMP_IO_CAP_REQ_EVT /* received IO_CAPABILITY_REQUEST event */ 1559#define BTM_LE_SEC_REQUEST_EVT SMP_SEC_REQUEST_EVT /* security request event */ 1560#define BTM_LE_KEY_NOTIF_EVT SMP_PASSKEY_NOTIF_EVT /* received USER_PASSKEY_NOTIFY event */ 1561#define BTM_LE_KEY_REQ_EVT SMP_PASSKEY_REQ_EVT /* received USER_PASSKEY_REQUEST event */ 1562#define BTM_LE_OOB_REQ_EVT SMP_OOB_REQ_EVT /* OOB data request event */ 1563#define BTM_LE_NC_REQ_EVT SMP_NC_REQ_EVT /* Numeric Comparison request event */ 1564#define BTM_LE_PR_KEYPR_NOT_EVT SMP_PEER_KEYPR_NOT_EVT /* Peer keypress notification recd event */ 1565/* SC OOB request event (both local and peer OOB data) can be expected in response */ 1566#define BTM_LE_SC_OOB_REQ_EVT SMP_SC_OOB_REQ_EVT 1567/* SC OOB local data set is created (as result of SMP_CrLocScOobData(...)) */ 1568#define BTM_LE_SC_LOC_OOB_EVT SMP_SC_LOC_OOB_DATA_UP_EVT 1569#define BTM_LE_BR_KEYS_REQ_EVT SMP_BR_KEYS_REQ_EVT /* SMP over BR keys request event */ 1570#define BTM_LE_COMPLT_EVT SMP_COMPLT_EVT /* SMP complete event */ 1571#define BTM_LE_LAST_FROM_SMP BTM_LE_BR_KEYS_REQ_EVT 1572#define BTM_LE_KEY_EVT BTM_LE_LAST_FROM_SMP + 1 /* KEY update event */ 1573typedef UINT8 tBTM_LE_EVT; 1574 1575#define BTM_LE_KEY_NONE 0 1576#define BTM_LE_KEY_PENC SMP_SEC_KEY_TYPE_ENC /* encryption information of peer device */ 1577#define BTM_LE_KEY_PID SMP_SEC_KEY_TYPE_ID /* identity key of the peer device */ 1578#define BTM_LE_KEY_PCSRK SMP_SEC_KEY_TYPE_CSRK /* peer SRK */ 1579#define BTM_LE_KEY_PLK SMP_SEC_KEY_TYPE_LK 1580#define BTM_LE_KEY_LLK (SMP_SEC_KEY_TYPE_LK << 4) 1581#define BTM_LE_KEY_LENC (SMP_SEC_KEY_TYPE_ENC << 4) /* master role security information:div */ 1582#define BTM_LE_KEY_LID (SMP_SEC_KEY_TYPE_ID << 4) /* master device ID key */ 1583#define BTM_LE_KEY_LCSRK (SMP_SEC_KEY_TYPE_CSRK << 4) /* local CSRK has been deliver to peer */ 1584typedef UINT8 tBTM_LE_KEY_TYPE; 1585 1586#define BTM_LE_AUTH_REQ_NO_BOND SMP_AUTH_NO_BOND /* 0 */ 1587#define BTM_LE_AUTH_REQ_BOND SMP_AUTH_GEN_BOND /* 1 << 0 */ 1588#define BTM_LE_AUTH_REQ_MITM SMP_AUTH_YN_BIT /* 1 << 2 */ 1589typedef UINT8 tBTM_LE_AUTH_REQ; 1590#define BTM_LE_SC_SUPPORT_BIT SMP_SC_SUPPORT_BIT /* (1 << 3) */ 1591#define BTM_LE_KP_SUPPORT_BIT SMP_KP_SUPPORT_BIT /* (1 << 4) */ 1592 1593#define BTM_LE_AUTH_REQ_SC_ONLY SMP_AUTH_SC_ENC_ONLY /* 1 << 3 */ 1594#define BTM_LE_AUTH_REQ_SC_BOND SMP_AUTH_SC_GB /* 1001 */ 1595#define BTM_LE_AUTH_REQ_SC_MITM SMP_AUTH_SC_MITM_NB /* 1100 */ 1596#define BTM_LE_AUTH_REQ_SC_MITM_BOND SMP_AUTH_SC_MITM_GB /* 1101 */ 1597#define BTM_LE_AUTH_REQ_MASK SMP_AUTH_MASK /* 0x1D */ 1598 1599/* LE security level */ 1600#define BTM_LE_SEC_NONE SMP_SEC_NONE 1601#define BTM_LE_SEC_UNAUTHENTICATE SMP_SEC_UNAUTHENTICATE /* 1 */ 1602#define BTM_LE_SEC_AUTHENTICATED SMP_SEC_AUTHENTICATED /* 4 */ 1603typedef UINT8 tBTM_LE_SEC; 1604 1605 1606typedef struct 1607{ 1608 tBTM_IO_CAP io_cap; /* local IO capabilities */ 1609 UINT8 oob_data; /* OOB data present (locally) for the peer device */ 1610 tBTM_LE_AUTH_REQ auth_req; /* Authentication request (for local device) contain bonding and MITM info */ 1611 UINT8 max_key_size; /* max encryption key size */ 1612 tBTM_LE_KEY_TYPE init_keys; /* keys to be distributed, bit mask */ 1613 tBTM_LE_KEY_TYPE resp_keys; /* keys to be distributed, bit mask */ 1614} tBTM_LE_IO_REQ; 1615 1616#if BLE_INCLUDED == TRUE && SMP_INCLUDED == TRUE 1617/* data type for tBTM_LE_COMPLT */ 1618typedef struct 1619{ 1620 UINT8 reason; 1621 UINT8 sec_level; 1622 BOOLEAN is_pair_cancel; 1623 BOOLEAN smp_over_br; 1624}tBTM_LE_COMPLT; 1625#endif 1626 1627/* BLE encryption keys */ 1628typedef struct 1629{ 1630 BT_OCTET16 ltk; 1631 BT_OCTET8 rand; 1632 UINT16 ediv; 1633 UINT8 sec_level; 1634 UINT8 key_size; 1635}tBTM_LE_PENC_KEYS; 1636 1637/* BLE CSRK keys */ 1638typedef struct 1639{ 1640 UINT32 counter; 1641 BT_OCTET16 csrk; 1642 UINT8 sec_level; 1643}tBTM_LE_PCSRK_KEYS; 1644 1645/* BLE Encryption reproduction keys */ 1646typedef struct 1647{ 1648 BT_OCTET16 ltk; 1649 UINT16 div; 1650 UINT8 key_size; 1651 UINT8 sec_level; 1652}tBTM_LE_LENC_KEYS; 1653 1654/* BLE SRK keys */ 1655typedef struct 1656{ 1657 UINT32 counter; 1658 UINT16 div; 1659 UINT8 sec_level; 1660 BT_OCTET16 csrk; 1661}tBTM_LE_LCSRK_KEYS; 1662 1663typedef struct 1664{ 1665 BT_OCTET16 irk; 1666 tBLE_ADDR_TYPE addr_type; 1667 BD_ADDR static_addr; 1668}tBTM_LE_PID_KEYS; 1669 1670typedef union 1671{ 1672 tBTM_LE_PENC_KEYS penc_key; /* received peer encryption key */ 1673 tBTM_LE_PCSRK_KEYS pcsrk_key; /* received peer device SRK */ 1674 tBTM_LE_PID_KEYS pid_key; /* peer device ID key */ 1675 tBTM_LE_LENC_KEYS lenc_key; /* local encryption reproduction keys LTK = = d1(ER,DIV,0)*/ 1676 tBTM_LE_LCSRK_KEYS lcsrk_key; /* local device CSRK = d1(ER,DIV,1)*/ 1677}tBTM_LE_KEY_VALUE; 1678 1679typedef struct 1680{ 1681 tBTM_LE_KEY_TYPE key_type; 1682 tBTM_LE_KEY_VALUE *p_key_value; 1683}tBTM_LE_KEY; 1684 1685typedef union 1686{ 1687 tBTM_LE_IO_REQ io_req; /* BTM_LE_IO_REQ_EVT */ 1688 UINT32 key_notif; /* BTM_LE_KEY_NOTIF_EVT */ 1689 /* BTM_LE_NC_REQ_EVT */ 1690 /* no callback data for BTM_LE_KEY_REQ_EVT */ 1691 /* and BTM_LE_OOB_REQ_EVT */ 1692#if BLE_INCLUDED == TRUE && SMP_INCLUDED == TRUE 1693 tBTM_LE_COMPLT complt; /* BTM_LE_COMPLT_EVT */ 1694 tSMP_OOB_DATA_TYPE req_oob_type; 1695#endif 1696 tBTM_LE_KEY key; 1697} tBTM_LE_EVT_DATA; 1698 1699/* Simple Pairing Events. Called by the stack when Simple Pairing related 1700** events occur. 1701*/ 1702typedef UINT8 (tBTM_LE_CALLBACK) (tBTM_LE_EVT event, BD_ADDR bda, tBTM_LE_EVT_DATA *p_data); 1703 1704#define BTM_BLE_KEY_TYPE_ID 1 1705#define BTM_BLE_KEY_TYPE_ER 2 1706#define BTM_BLE_KEY_TYPE_COUNTER 3 //tobe obsolete 1707 1708typedef struct 1709{ 1710 BT_OCTET16 ir; 1711 BT_OCTET16 irk; 1712 BT_OCTET16 dhk; 1713 1714}tBTM_BLE_LOCAL_ID_KEYS; 1715 1716typedef union 1717{ 1718 tBTM_BLE_LOCAL_ID_KEYS id_keys; 1719 BT_OCTET16 er; 1720}tBTM_BLE_LOCAL_KEYS; 1721 1722 1723/* New LE identity key for local device. 1724*/ 1725typedef void (tBTM_LE_KEY_CALLBACK) (UINT8 key_type, tBTM_BLE_LOCAL_KEYS *p_key); 1726 1727 1728/*************************** 1729** Security Manager Types 1730****************************/ 1731/* Structure that applications use to register with BTM_SecRegister */ 1732typedef struct 1733{ 1734 tBTM_AUTHORIZE_CALLBACK *p_authorize_callback; 1735 tBTM_PIN_CALLBACK *p_pin_callback; 1736 tBTM_LINK_KEY_CALLBACK *p_link_key_callback; 1737 tBTM_AUTH_COMPLETE_CALLBACK *p_auth_complete_callback; 1738 tBTM_BOND_CANCEL_CMPL_CALLBACK *p_bond_cancel_cmpl_callback; 1739 tBTM_SP_CALLBACK *p_sp_callback; 1740#if BLE_INCLUDED == TRUE 1741#if SMP_INCLUDED == TRUE 1742 tBTM_LE_CALLBACK *p_le_callback; 1743#endif 1744 tBTM_LE_KEY_CALLBACK *p_le_key_callback; 1745#endif 1746} tBTM_APPL_INFO; 1747 1748/* Callback function for when a link supervision timeout event occurs. 1749** This asynchronous event is enabled/disabled by calling BTM_RegForLstoEvt(). 1750*/ 1751typedef void (tBTM_LSTO_CBACK) (BD_ADDR remote_bda, UINT16 timeout); 1752 1753/***************************************************************************** 1754** POWER MANAGEMENT 1755*****************************************************************************/ 1756/**************************** 1757** Power Manager Constants 1758*****************************/ 1759/* BTM Power manager status codes */ 1760enum 1761{ 1762 BTM_PM_STS_ACTIVE = HCI_MODE_ACTIVE, 1763 BTM_PM_STS_HOLD = HCI_MODE_HOLD, 1764 BTM_PM_STS_SNIFF = HCI_MODE_SNIFF, 1765 BTM_PM_STS_PARK = HCI_MODE_PARK, 1766 BTM_PM_STS_SSR, /* report the SSR parameters in HCI_SNIFF_SUB_RATE_EVT */ 1767 BTM_PM_STS_PENDING, /* when waiting for status from controller */ 1768 BTM_PM_STS_ERROR /* when HCI command status returns error */ 1769}; 1770typedef UINT8 tBTM_PM_STATUS; 1771 1772/* BTM Power manager modes */ 1773enum 1774{ 1775 BTM_PM_MD_ACTIVE = BTM_PM_STS_ACTIVE, 1776 BTM_PM_MD_HOLD = BTM_PM_STS_HOLD, 1777 BTM_PM_MD_SNIFF = BTM_PM_STS_SNIFF, 1778 BTM_PM_MD_PARK = BTM_PM_STS_PARK, 1779 BTM_PM_MD_FORCE = 0x10 /* OR this to force ACL link to a certain mode */ 1780}; 1781typedef UINT8 tBTM_PM_MODE; 1782 1783#define BTM_PM_SET_ONLY_ID 0x80 1784 1785/* Operation codes */ 1786#define BTM_PM_REG_SET 1 /* The module wants to set the desired power mode */ 1787#define BTM_PM_REG_NOTIF 2 /* The module wants to receive mode change event */ 1788#define BTM_PM_DEREG 4 /* The module does not want to involve with PM anymore */ 1789 1790/************************ 1791** Power Manager Types 1792*************************/ 1793typedef struct 1794{ 1795 UINT16 max; 1796 UINT16 min; 1797 UINT16 attempt; 1798 UINT16 timeout; 1799 tBTM_PM_MODE mode; 1800} tBTM_PM_PWR_MD; 1801 1802/************************************* 1803** Power Manager Callback Functions 1804**************************************/ 1805typedef void (tBTM_PM_STATUS_CBACK) (BD_ADDR p_bda, tBTM_PM_STATUS status, 1806 UINT16 value, UINT8 hci_status); 1807 1808 1809/************************ 1810** Stored Linkkey Types 1811*************************/ 1812#define BTM_CB_EVT_DELETE_STORED_LINK_KEYS 4 1813 1814typedef struct 1815{ 1816 UINT8 event; 1817 UINT8 status; 1818 UINT16 num_keys; 1819 1820} tBTM_DELETE_STORED_LINK_KEY_COMPLETE; 1821 1822/* MIP evnets, callbacks */ 1823enum 1824{ 1825 BTM_MIP_MODE_CHG_EVT, 1826 BTM_MIP_DISCONNECT_EVT, 1827 BTM_MIP_PKTS_COMPL_EVT, 1828 BTM_MIP_RXDATA_EVT 1829}; 1830typedef UINT8 tBTM_MIP_EVT; 1831 1832typedef struct 1833{ 1834 tBTM_MIP_EVT event; 1835 BD_ADDR bd_addr; 1836 UINT16 mip_id; 1837} tBTM_MIP_MODE_CHANGE; 1838 1839typedef struct 1840{ 1841 tBTM_MIP_EVT event; 1842 UINT16 mip_id; 1843 UINT8 disc_reason; 1844} tBTM_MIP_CONN_TIMEOUT; 1845 1846#define BTM_MIP_MAX_RX_LEN 17 1847 1848typedef struct 1849{ 1850 tBTM_MIP_EVT event; 1851 UINT16 mip_id; 1852 UINT8 rx_len; 1853 UINT8 rx_data[BTM_MIP_MAX_RX_LEN]; 1854} tBTM_MIP_RXDATA; 1855 1856typedef struct 1857{ 1858 tBTM_MIP_EVT event; 1859 BD_ADDR bd_addr; 1860 UINT8 data[11]; /* data[0] shows Vender-specific device type */ 1861} tBTM_MIP_EIR_HANDSHAKE; 1862 1863typedef struct 1864{ 1865 tBTM_MIP_EVT event; 1866 UINT16 num_sent; /* Number of packets completed at the controller */ 1867} tBTM_MIP_PKTS_COMPL; 1868 1869typedef union 1870{ 1871 tBTM_MIP_EVT event; 1872 tBTM_MIP_MODE_CHANGE mod_chg; 1873 tBTM_MIP_CONN_TIMEOUT conn_tmo; 1874 tBTM_MIP_EIR_HANDSHAKE eir; 1875 tBTM_MIP_PKTS_COMPL completed; 1876 tBTM_MIP_RXDATA rxdata; 1877} tBTM_MIP_EVENT_DATA; 1878 1879/* MIP event callback function */ 1880typedef void (tBTM_MIP_EVENTS_CB) (tBTM_MIP_EVT event, tBTM_MIP_EVENT_DATA data); 1881 1882/* MIP Device query callback function */ 1883typedef BOOLEAN (tBTM_MIP_QUERY_CB) (BD_ADDR dev_addr, UINT8 *p_mode, LINK_KEY link_key); 1884 1885#define BTM_CONTRL_ACTIVE 1 /* ACL link on, SCO link ongoing, sniff mode */ 1886#define BTM_CONTRL_SCAN 2 /* Scan state - paging/inquiry/trying to connect*/ 1887#define BTM_CONTRL_IDLE 3 /* Idle state - page scan, LE advt, inquiry scan */ 1888 1889typedef UINT8 tBTM_CONTRL_STATE; 1890 1891/***************************************************************************** 1892** EXTERNAL FUNCTION DECLARATIONS 1893*****************************************************************************/ 1894#ifdef __cplusplus 1895extern "C" { 1896#endif 1897 1898/***************************************************************************** 1899** DEVICE CONTROL and COMMON FUNCTIONS 1900*****************************************************************************/ 1901 1902/******************************************************************************* 1903** 1904** Function BTM_DeviceReset 1905** 1906** Description This function is called to reset the controller.The Callback function 1907** if provided is called when startup of the device has 1908** completed. 1909** 1910** Returns void 1911** 1912*******************************************************************************/ 1913extern void BTM_DeviceReset (tBTM_CMPL_CB *p_cb); 1914 1915 1916/******************************************************************************* 1917** 1918** Function BTM_IsDeviceUp 1919** 1920** Description This function is called to check if the device is up. 1921** 1922** Returns TRUE if device is up, else FALSE 1923** 1924*******************************************************************************/ 1925extern BOOLEAN BTM_IsDeviceUp (void); 1926 1927 1928/******************************************************************************* 1929** 1930** Function BTM_SetLocalDeviceName 1931** 1932** Description This function is called to set the local device name. 1933** 1934** Returns BTM_CMD_STARTED if successful, otherwise an error 1935** 1936*******************************************************************************/ 1937extern tBTM_STATUS BTM_SetLocalDeviceName (char *p_name); 1938 1939/******************************************************************************* 1940** 1941** Function BTM_SetDeviceClass 1942** 1943** Description This function is called to set the local device class 1944** 1945** Returns BTM_SUCCESS if successful, otherwise an error 1946** 1947*******************************************************************************/ 1948extern tBTM_STATUS BTM_SetDeviceClass (DEV_CLASS dev_class); 1949 1950 1951/******************************************************************************* 1952** 1953** Function BTM_ReadLocalDeviceName 1954** 1955** Description This function is called to read the local device name. 1956** 1957** Returns status of the operation 1958** If success, BTM_SUCCESS is returned and p_name points stored 1959** local device name 1960** If BTM doesn't store local device name, BTM_NO_RESOURCES is 1961** is returned and p_name is set to NULL 1962** 1963*******************************************************************************/ 1964extern tBTM_STATUS BTM_ReadLocalDeviceName (char **p_name); 1965 1966/******************************************************************************* 1967** 1968** Function BTM_ReadLocalDeviceNameFromController 1969** 1970** Description Get local device name from controller. Do not use cached 1971** name (used to get chip-id prior to btm reset complete). 1972** 1973** Returns BTM_CMD_STARTED if successful, otherwise an error 1974** 1975*******************************************************************************/ 1976extern tBTM_STATUS BTM_ReadLocalDeviceNameFromController (tBTM_CMPL_CB *p_rln_cmpl_cback); 1977 1978/******************************************************************************* 1979** 1980** Function BTM_ReadDeviceClass 1981** 1982** Description This function is called to read the local device class 1983** 1984** Returns pointer to the device class 1985** 1986*******************************************************************************/ 1987extern UINT8 *BTM_ReadDeviceClass (void); 1988 1989 1990/******************************************************************************* 1991** 1992** Function BTM_ReadLocalFeatures 1993** 1994** Description This function is called to read the local features 1995** 1996** Returns pointer to the local features string 1997** 1998*******************************************************************************/ 1999extern UINT8 *BTM_ReadLocalFeatures (void); 2000 2001/******************************************************************************* 2002** 2003** Function BTM_RegisterForDeviceStatusNotif 2004** 2005** Description This function is called to register for device status 2006** change notifications. 2007** 2008** Returns pointer to previous caller's callback function or NULL if first 2009** registration. 2010** 2011*******************************************************************************/ 2012extern tBTM_DEV_STATUS_CB *BTM_RegisterForDeviceStatusNotif (tBTM_DEV_STATUS_CB *p_cb); 2013 2014 2015/******************************************************************************* 2016** 2017** Function BTM_RegisterForVSEvents 2018** 2019** Description This function is called to register/deregister for vendor 2020** specific HCI events. 2021** 2022** If is_register=TRUE, then the function will be registered; 2023** if is_register=FALSE, then the function will be deregistered. 2024** 2025** Returns BTM_SUCCESS if successful, 2026** BTM_BUSY if maximum number of callbacks have already been 2027** registered. 2028** 2029*******************************************************************************/ 2030extern tBTM_STATUS BTM_RegisterForVSEvents (tBTM_VS_EVT_CB *p_cb, BOOLEAN is_register); 2031 2032 2033/******************************************************************************* 2034** 2035** Function BTM_VendorSpecificCommand 2036** 2037** Description Send a vendor specific HCI command to the controller. 2038** 2039** Returns 2040** BTM_SUCCESS Command sent. Does not expect command complete 2041** event. (command cmpl callback param is NULL) 2042** BTM_CMD_STARTED Command sent. Waiting for command cmpl event. 2043** BTM_BUSY Command not sent. Waiting for cmd cmpl event for 2044** prior command. 2045** 2046*******************************************************************************/ 2047extern tBTM_STATUS BTM_VendorSpecificCommand(UINT16 opcode, 2048 UINT8 param_len, 2049 UINT8 *p_param_buf, 2050 tBTM_VSC_CMPL_CB *p_cb); 2051 2052 2053/******************************************************************************* 2054** 2055** Function BTM_AllocateSCN 2056** 2057** Description Look through the Server Channel Numbers for a free one to be 2058** used with an RFCOMM connection. 2059** 2060** Returns Allocated SCN number or 0 if none. 2061** 2062*******************************************************************************/ 2063extern UINT8 BTM_AllocateSCN(void); 2064 2065// btla-specific ++ 2066/******************************************************************************* 2067** 2068** Function BTM_TryAllocateSCN 2069** 2070** Description Try to allocate a fixed server channel 2071** 2072** Returns Returns TRUE if server channel was available 2073** 2074*******************************************************************************/ 2075extern BOOLEAN BTM_TryAllocateSCN(UINT8 scn); 2076// btla-specific -- 2077 2078 2079/******************************************************************************* 2080** 2081** Function BTM_FreeSCN 2082** 2083** Description Free the specified SCN. 2084** 2085** Returns TRUE if successful, FALSE if SCN is not in use or invalid 2086** 2087*******************************************************************************/ 2088extern BOOLEAN BTM_FreeSCN(UINT8 scn); 2089 2090 2091/******************************************************************************* 2092** 2093** Function BTM_SetTraceLevel 2094** 2095** Description This function sets the trace level for BTM. If called with 2096** a value of 0xFF, it simply returns the current trace level. 2097** 2098** Returns The new or current trace level 2099** 2100*******************************************************************************/ 2101extern UINT8 BTM_SetTraceLevel (UINT8 new_level); 2102 2103 2104/******************************************************************************* 2105** 2106** Function BTM_WritePageTimeout 2107** 2108** Description Send HCI Wite Page Timeout. 2109** 2110** Returns 2111** BTM_SUCCESS Command sent. 2112** BTM_NO_RESOURCES If out of resources to send the command. 2113** 2114*******************************************************************************/ 2115extern tBTM_STATUS BTM_WritePageTimeout(UINT16 timeout); 2116 2117/******************************************************************************* 2118** 2119** Function BTM_WriteVoiceSettings 2120** 2121** Description Send HCI Write Voice Settings command. 2122** See hcidefs.h for settings bitmask values. 2123** 2124** Returns 2125** BTM_SUCCESS Command sent. 2126** BTM_NO_RESOURCES If out of resources to send the command. 2127** 2128** 2129*******************************************************************************/ 2130extern tBTM_STATUS BTM_WriteVoiceSettings(UINT16 settings); 2131 2132/******************************************************************************* 2133** 2134** Function BTM_EnableTestMode 2135** 2136** Description Send HCI the enable device under test command. 2137** 2138** Note: Controller can only be taken out of this mode by 2139** resetting the controller. 2140** 2141** Returns 2142** BTM_SUCCESS Command sent. 2143** BTM_NO_RESOURCES If out of resources to send the command. 2144** 2145** 2146*******************************************************************************/ 2147extern tBTM_STATUS BTM_EnableTestMode(void); 2148 2149 2150/***************************************************************************** 2151** DEVICE DISCOVERY FUNCTIONS - Inquiry, Remote Name, Discovery, Class of Device 2152*****************************************************************************/ 2153 2154/******************************************************************************* 2155** 2156** Function BTM_SetDiscoverability 2157** 2158** Description This function is called to set the device into or out of 2159** discoverable mode. Discoverable mode means inquiry 2160** scans are enabled. If a value of '0' is entered for window or 2161** interval, the default values are used. 2162** 2163** Returns BTM_SUCCESS if successful 2164** BTM_BUSY if a setting of the filter is already in progress 2165** BTM_NO_RESOURCES if couldn't get a memory pool buffer 2166** BTM_ILLEGAL_VALUE if a bad parameter was detected 2167** BTM_WRONG_MODE if the device is not up. 2168** 2169*******************************************************************************/ 2170extern tBTM_STATUS BTM_SetDiscoverability (UINT16 inq_mode, UINT16 window, 2171 UINT16 interval); 2172 2173 2174/******************************************************************************* 2175** 2176** Function BTM_ReadDiscoverability 2177** 2178** Description This function is called to read the current discoverability 2179** mode of the device. 2180** 2181** Output Params: p_window - current inquiry scan duration 2182** p_interval - current inquiry scan interval 2183** 2184** Returns BTM_NON_DISCOVERABLE, BTM_LIMITED_DISCOVERABLE, or 2185** BTM_GENERAL_DISCOVERABLE 2186** 2187*******************************************************************************/ 2188extern UINT16 BTM_ReadDiscoverability (UINT16 *p_window, 2189 UINT16 *p_interval); 2190 2191 2192/******************************************************************************* 2193** 2194** Function BTM_SetPeriodicInquiryMode 2195** 2196** Description This function is called to set the device periodic inquiry mode. 2197** If the duration is zero, the periodic inquiry mode is cancelled. 2198** 2199** Parameters: p_inqparms - pointer to the inquiry information 2200** mode - GENERAL or LIMITED inquiry 2201** duration - length in 1.28 sec intervals (If '0', the inquiry is CANCELLED) 2202** max_resps - maximum amount of devices to search for before ending the inquiry 2203** filter_cond_type - BTM_CLR_INQUIRY_FILTER, BTM_FILTER_COND_DEVICE_CLASS, or 2204** BTM_FILTER_COND_BD_ADDR 2205** filter_cond - value for the filter (based on filter_cond_type) 2206** 2207** max_delay - maximum amount of time between successive inquiries 2208** min_delay - minimum amount of time between successive inquiries 2209** p_results_cb - callback returning pointer to results (tBTM_INQ_RESULTS) 2210** 2211** Returns BTM_CMD_STARTED if successfully started 2212** BTM_ILLEGAL_VALUE if a bad parameter is detected 2213** BTM_NO_RESOURCES if could not allocate a message buffer 2214** BTM_SUCCESS - if cancelling the periodic inquiry 2215** BTM_BUSY - if an inquiry is already active 2216** BTM_WRONG_MODE if the device is not up. 2217** 2218*******************************************************************************/ 2219extern tBTM_STATUS BTM_SetPeriodicInquiryMode (tBTM_INQ_PARMS *p_inqparms, 2220 UINT16 max_delay, UINT16 min_delay, 2221 tBTM_INQ_RESULTS_CB *p_results_cb); 2222 2223 2224/******************************************************************************* 2225** 2226** Function BTM_StartInquiry 2227** 2228** Description This function is called to start an inquiry. 2229** 2230** Parameters: p_inqparms - pointer to the inquiry information 2231** mode - GENERAL or LIMITED inquiry 2232** duration - length in 1.28 sec intervals (If '0', the inquiry is CANCELLED) 2233** max_resps - maximum amount of devices to search for before ending the inquiry 2234** filter_cond_type - BTM_CLR_INQUIRY_FILTER, BTM_FILTER_COND_DEVICE_CLASS, or 2235** BTM_FILTER_COND_BD_ADDR 2236** filter_cond - value for the filter (based on filter_cond_type) 2237** 2238** p_results_cb - Pointer to the callback routine which gets called 2239** upon receipt of an inquiry result. If this field is 2240** NULL, the application is not notified. 2241** 2242** p_cmpl_cb - Pointer to the callback routine which gets called 2243** upon completion. If this field is NULL, the 2244** application is not notified when completed. 2245** Returns tBTM_STATUS 2246** BTM_CMD_STARTED if successfully initiated 2247** BTM_BUSY if already in progress 2248** BTM_ILLEGAL_VALUE if parameter(s) are out of range 2249** BTM_NO_RESOURCES if could not allocate resources to start the command 2250** BTM_WRONG_MODE if the device is not up. 2251** 2252*******************************************************************************/ 2253extern tBTM_STATUS BTM_StartInquiry (tBTM_INQ_PARMS *p_inqparms, 2254 tBTM_INQ_RESULTS_CB *p_results_cb, 2255 tBTM_CMPL_CB *p_cmpl_cb); 2256 2257 2258/******************************************************************************* 2259** 2260** Function BTM_IsInquiryActive 2261** 2262** Description This function returns a bit mask of the current inquiry state 2263** 2264** Returns BTM_INQUIRY_INACTIVE if inactive (0) 2265** BTM_LIMITED_INQUIRY_ACTIVE if a limted inquiry is active 2266** BTM_GENERAL_INQUIRY_ACTIVE if a general inquiry is active 2267** BTM_PERIODIC_INQUIRY_ACTIVE if a periodic inquiry is active 2268** 2269*******************************************************************************/ 2270extern UINT16 BTM_IsInquiryActive (void); 2271 2272 2273/******************************************************************************* 2274** 2275** Function BTM_CancelInquiry 2276** 2277** Description This function cancels an inquiry if active 2278** 2279** Returns BTM_SUCCESS if successful 2280** BTM_NO_RESOURCES if could not allocate a message buffer 2281** BTM_WRONG_MODE if the device is not up. 2282** 2283*******************************************************************************/ 2284extern tBTM_STATUS BTM_CancelInquiry(void); 2285 2286 2287/******************************************************************************* 2288** 2289** Function BTM_CancelPeriodicInquiry 2290** 2291** Description This function cancels a periodic inquiry 2292** 2293** Returns 2294** BTM_NO_RESOURCES if could not allocate a message buffer 2295** BTM_SUCCESS - if cancelling the periodic inquiry 2296** BTM_WRONG_MODE if the device is not up. 2297** 2298*******************************************************************************/ 2299extern tBTM_STATUS BTM_CancelPeriodicInquiry(void); 2300 2301 2302/******************************************************************************* 2303** 2304** Function BTM_SetConnectability 2305** 2306** Description This function is called to set the device into or out of 2307** connectable mode. Discoverable mode means page scans enabled. 2308** 2309** Returns BTM_SUCCESS if successful 2310** BTM_ILLEGAL_VALUE if a bad parameter is detected 2311** BTM_NO_RESOURCES if could not allocate a message buffer 2312** BTM_WRONG_MODE if the device is not up. 2313** 2314*******************************************************************************/ 2315extern tBTM_STATUS BTM_SetConnectability (UINT16 page_mode, UINT16 window, 2316 UINT16 interval); 2317 2318 2319/******************************************************************************* 2320** 2321** Function BTM_ReadConnectability 2322** 2323** Description This function is called to read the current discoverability 2324** mode of the device. 2325** Output Params p_window - current page scan duration 2326** p_interval - current time between page scans 2327** 2328** Returns BTM_NON_CONNECTABLE or BTM_CONNECTABLE 2329** 2330*******************************************************************************/ 2331extern UINT16 BTM_ReadConnectability (UINT16 *p_window, UINT16 *p_interval); 2332 2333 2334/******************************************************************************* 2335** 2336** Function BTM_SetInquiryMode 2337** 2338** Description This function is called to set standard, with RSSI 2339** mode or extended of the inquiry for local device. 2340** 2341** Input Params: BTM_INQ_RESULT_STANDARD, BTM_INQ_RESULT_WITH_RSSI or 2342** BTM_INQ_RESULT_EXTENDED 2343** 2344** Returns BTM_SUCCESS if successful 2345** BTM_NO_RESOURCES if couldn't get a memory pool buffer 2346** BTM_ILLEGAL_VALUE if a bad parameter was detected 2347** BTM_WRONG_MODE if the device is not up. 2348** 2349*******************************************************************************/ 2350extern tBTM_STATUS BTM_SetInquiryMode (UINT8 mode); 2351 2352/******************************************************************************* 2353** 2354** Function BTM_SetInquiryScanType 2355** 2356** Description This function is called to set the iquiry scan-type to 2357** standard or interlaced. 2358** 2359** Input Params: BTM_SCAN_TYPE_STANDARD or BTM_SCAN_TYPE_INTERLACED 2360** 2361** Returns BTM_SUCCESS if successful 2362** BTM_MODE_UNSUPPORTED if not a 1.2 device 2363** BTM_WRONG_MODE if the device is not up. 2364** 2365*******************************************************************************/ 2366extern tBTM_STATUS BTM_SetInquiryScanType (UINT16 scan_type); 2367 2368/******************************************************************************* 2369** 2370** Function BTM_SetPageScanType 2371** 2372** Description This function is called to set the page scan-type to 2373** standard or interlaced. 2374** 2375** Input Params: BTM_SCAN_TYPE_STANDARD or BTM_SCAN_TYPE_INTERLACED 2376** 2377** Returns BTM_SUCCESS if successful 2378** BTM_MODE_UNSUPPORTED if not a 1.2 device 2379** BTM_WRONG_MODE if the device is not up. 2380** 2381*******************************************************************************/ 2382 2383extern tBTM_STATUS BTM_SetPageScanType (UINT16 scan_type); 2384 2385/******************************************************************************* 2386** 2387** Function BTM_ReadRemoteDeviceName 2388** 2389** Description This function initiates a remote device HCI command to the 2390** controller and calls the callback when the process has completed. 2391** 2392** Input Params: remote_bda - device address of name to retrieve 2393** p_cb - callback function called when BTM_CMD_STARTED 2394** is returned. 2395** A pointer to tBTM_REMOTE_DEV_NAME is passed to the 2396** callback. 2397** 2398** Returns 2399** BTM_CMD_STARTED is returned if the request was successfully sent 2400** to HCI. 2401** BTM_BUSY if already in progress 2402** BTM_UNKNOWN_ADDR if device address is bad 2403** BTM_NO_RESOURCES if could not allocate resources to start the command 2404** BTM_WRONG_MODE if the device is not up. 2405** 2406*******************************************************************************/ 2407extern tBTM_STATUS BTM_ReadRemoteDeviceName (BD_ADDR remote_bda, 2408 tBTM_CMPL_CB *p_cb, 2409 tBT_TRANSPORT transport); 2410 2411 2412/******************************************************************************* 2413** 2414** Function BTM_CancelRemoteDeviceName 2415** 2416** Description This function initiates the cancel request for the specified 2417** remote device. 2418** 2419** Input Params: None 2420** 2421** Returns 2422** BTM_CMD_STARTED is returned if the request was successfully sent 2423** to HCI. 2424** BTM_NO_RESOURCES if could not allocate resources to start the command 2425** BTM_WRONG_MODE if there is not an active remote name request. 2426** 2427*******************************************************************************/ 2428extern tBTM_STATUS BTM_CancelRemoteDeviceName (void); 2429 2430/******************************************************************************* 2431** 2432** Function BTM_ReadRemoteVersion 2433** 2434** Description This function is called to read a remote device's version 2435** 2436** Returns BTM_SUCCESS if successful, otherwise an error 2437** 2438*******************************************************************************/ 2439extern tBTM_STATUS BTM_ReadRemoteVersion (BD_ADDR addr, 2440 UINT8 *lmp_version, 2441 UINT16 *manufacturer, 2442 UINT16 *lmp_sub_version); 2443 2444/******************************************************************************* 2445** 2446** Function BTM_ReadRemoteFeatures 2447** 2448** Description This function is called to read a remote device's 2449** supported features mask (features mask located at page 0) 2450** 2451** Note: The size of device features mask page is 2452** BTM_FEATURE_BYTES_PER_PAGE bytes. 2453** 2454** Returns pointer to the remote supported features mask 2455** 2456*******************************************************************************/ 2457extern UINT8 *BTM_ReadRemoteFeatures (BD_ADDR addr); 2458 2459/******************************************************************************* 2460** 2461** Function BTM_ReadRemoteExtendedFeatures 2462** 2463** Description This function is called to read a specific extended features 2464** page of the remote device 2465** 2466** Note1: The size of device features mask page is 2467** BTM_FEATURE_BYTES_PER_PAGE bytes. 2468** Note2: The valid device features mask page number depends on 2469** the remote device capabilities. It is expected to be in the 2470** range [0 - BTM_EXT_FEATURES_PAGE_MAX]. 2471 2472** Returns pointer to the remote extended features mask 2473** or NULL if page_number is not valid 2474** 2475*******************************************************************************/ 2476extern UINT8 *BTM_ReadRemoteExtendedFeatures (BD_ADDR addr, UINT8 page_number); 2477 2478/******************************************************************************* 2479** 2480** Function BTM_ReadNumberRemoteFeaturesPages 2481** 2482** Description This function is called to retrieve the number of feature pages 2483** read from the remote device 2484** 2485** Returns number of features pages read from the remote device 2486** 2487*******************************************************************************/ 2488extern UINT8 BTM_ReadNumberRemoteFeaturesPages (BD_ADDR addr); 2489 2490/******************************************************************************* 2491** 2492** Function BTM_ReadAllRemoteFeatures 2493** 2494** Description This function is called to read all features of the remote device 2495** 2496** Returns pointer to the byte[0] of the page[0] of the remote device 2497** feature mask. 2498** 2499** Note: the function returns the pointer to the array of the size 2500** BTM_FEATURE_BYTES_PER_PAGE * (BTM_EXT_FEATURES_PAGE_MAX + 1). 2501** 2502*******************************************************************************/ 2503extern UINT8 *BTM_ReadAllRemoteFeatures (BD_ADDR addr); 2504 2505/******************************************************************************* 2506** 2507** Function BTM_InqDbRead 2508** 2509** Description This function looks through the inquiry database for a match 2510** based on Bluetooth Device Address. This is the application's 2511** interface to get the inquiry details of a specific BD address. 2512** 2513** Returns pointer to entry, or NULL if not found 2514** 2515*******************************************************************************/ 2516extern tBTM_INQ_INFO *BTM_InqDbRead (BD_ADDR p_bda); 2517 2518 2519/******************************************************************************* 2520** 2521** Function BTM_InqDbFirst 2522** 2523** Description This function looks through the inquiry database for the first 2524** used entry, and returns that. This is used in conjunction with 2525** BTM_InqDbNext by applications as a way to walk through the 2526** inquiry database. 2527** 2528** Returns pointer to first in-use entry, or NULL if DB is empty 2529** 2530*******************************************************************************/ 2531extern tBTM_INQ_INFO *BTM_InqDbFirst (void); 2532 2533 2534/******************************************************************************* 2535** 2536** Function BTM_InqDbNext 2537** 2538** Description This function looks through the inquiry database for the next 2539** used entry, and returns that. If the input parameter is NULL, 2540** the first entry is returned. 2541** 2542** Returns pointer to next in-use entry, or NULL if no more found. 2543** 2544*******************************************************************************/ 2545extern tBTM_INQ_INFO *BTM_InqDbNext (tBTM_INQ_INFO *p_cur); 2546 2547 2548/******************************************************************************* 2549** 2550** Function BTM_ClearInqDb 2551** 2552** Description This function is called to clear out a device or all devices 2553** from the inquiry database. 2554** 2555** Parameter p_bda - (input) BD_ADDR -> Address of device to clear 2556** (NULL clears all entries) 2557** 2558** Returns BTM_BUSY if an inquiry, get remote name, or event filter 2559** is active, otherwise BTM_SUCCESS 2560** 2561*******************************************************************************/ 2562extern tBTM_STATUS BTM_ClearInqDb (BD_ADDR p_bda); 2563 2564/******************************************************************************* 2565** 2566** Function BTM_ReadInquiryRspTxPower 2567** 2568** Description This command will read the inquiry Transmit Power level used 2569** to transmit the FHS and EIR data packets. 2570** This can be used directly in the Tx Power Level EIR data type. 2571** 2572** Returns BTM_SUCCESS if successful 2573** 2574*******************************************************************************/ 2575extern tBTM_STATUS BTM_ReadInquiryRspTxPower (tBTM_CMPL_CB *p_cb); 2576 2577/******************************************************************************* 2578** 2579** Function BTM_StartDiscovery 2580** 2581** Description This function is called by an application (or profile) 2582** when it wants to trigger an service discovery using the 2583** BTM's discovery database. 2584** 2585** Returns tBTM_STATUS 2586** BTM_CMD_STARTED if the discovery was initiated 2587** BTM_BUSY if one is already in progress 2588** BTM_UNKNOWN_ADDR if no addresses are in the INQ DB 2589** BTM_ERR_PROCESSING if err initiating the command 2590** 2591*******************************************************************************/ 2592extern tBTM_STATUS BTM_StartDiscovery (tBTM_CMPL_CB *p_cmpl_cb, 2593 BD_ADDR_PTR p_rem_addr); 2594 2595 2596/******************************************************************************* 2597** 2598** Function BTM_FindAttribute 2599** 2600** Description This function is called by an application (or profile) 2601** when it wants to see if an attribute exists in the BTM 2602** discovery database. 2603** 2604** Returns Pointer to matching record, or NULL 2605** 2606*******************************************************************************/ 2607extern tSDP_DISC_REC *BTM_FindAttribute (UINT16 attr_id, 2608 tSDP_DISC_REC *p_start_rec); 2609 2610 2611/******************************************************************************* 2612** 2613** Function BTM_FindService 2614** 2615** Description This function is called by an application (or profile) 2616** when it wants to see if a service exists in the BTM 2617** discovery database. 2618** 2619** Returns Pointer to matching record, or NULL 2620** 2621*******************************************************************************/ 2622extern tSDP_DISC_REC *BTM_FindService (UINT16 service_uuid, 2623 tSDP_DISC_REC *p_start_rec); 2624 2625 2626/******************************************************************************* 2627** 2628** Function BTM_SetDiscoveryParams 2629** 2630** Description This function is called to set the BTM default discovery parameters. 2631** These UUID and attribute filters are used during the call to 2632** BTM_StartDiscovery. 2633** 2634** Returns void 2635** 2636*******************************************************************************/ 2637extern void BTM_SetDiscoveryParams (UINT16 num_uuid, tSDP_UUID *p_uuid_list, 2638 UINT16 num_attr, UINT16 *p_attr_list); 2639 2640 2641/***************************************************************************** 2642** ACL CHANNEL MANAGEMENT FUNCTIONS 2643*****************************************************************************/ 2644/******************************************************************************* 2645** 2646** Function BTM_SetLinkPolicy 2647** 2648** Description Create and send HCI "Write Policy Set" command 2649** 2650** Returns BTM_CMD_STARTED if successfully initiated, otherwise error 2651** 2652*******************************************************************************/ 2653extern tBTM_STATUS BTM_SetLinkPolicy (BD_ADDR remote_bda, 2654 UINT16 *settings); 2655 2656/******************************************************************************* 2657** 2658** Function BTM_SetDefaultLinkPolicy 2659** 2660** Description Set the default value for HCI "Write Policy Set" command 2661** to use when an ACL link is created. 2662** 2663** Returns void 2664** 2665*******************************************************************************/ 2666extern void BTM_SetDefaultLinkPolicy (UINT16 settings); 2667 2668 2669/******************************************************************************* 2670** 2671** Function BTM_SetDefaultLinkSuperTout 2672** 2673** Description Set the default value for HCI "Write Link Supervision Timeout" 2674** command to use when an ACL link is created. 2675** 2676** Returns void 2677** 2678*******************************************************************************/ 2679extern void BTM_SetDefaultLinkSuperTout (UINT16 timeout); 2680 2681 2682/******************************************************************************* 2683** 2684** Function BTM_SetLinkSuperTout 2685** 2686** Description Create and send HCI "Write Link Supervision Timeout" command 2687** 2688** Returns BTM_CMD_STARTED if successfully initiated, otherwise error 2689** 2690*******************************************************************************/ 2691extern tBTM_STATUS BTM_SetLinkSuperTout (BD_ADDR remote_bda, 2692 UINT16 timeout); 2693/******************************************************************************* 2694** 2695** Function BTM_GetLinkSuperTout 2696** 2697** Description Read the link supervision timeout value of the connection 2698** 2699** Returns status of the operation 2700** 2701*******************************************************************************/ 2702extern tBTM_STATUS BTM_GetLinkSuperTout (BD_ADDR remote_bda, 2703 UINT16 *p_timeout); 2704 2705/******************************************************************************* 2706** 2707** Function BTM_IsAclConnectionUp 2708** 2709** Description This function is called to check if an ACL connection exists 2710** to a specific remote BD Address. 2711** 2712** Returns TRUE if connection is up, else FALSE. 2713** 2714*******************************************************************************/ 2715extern BOOLEAN BTM_IsAclConnectionUp (BD_ADDR remote_bda, tBT_TRANSPORT transport); 2716 2717 2718/******************************************************************************* 2719** 2720** Function BTM_GetRole 2721** 2722** Description This function is called to get the role of the local device 2723** for the ACL connection with the specified remote device 2724** 2725** Returns BTM_SUCCESS if connection exists. 2726** BTM_UNKNOWN_ADDR if no active link with bd addr specified 2727** 2728*******************************************************************************/ 2729extern tBTM_STATUS BTM_GetRole (BD_ADDR remote_bd_addr, UINT8 *p_role); 2730 2731 2732 2733/******************************************************************************* 2734** 2735** Function BTM_SwitchRole 2736** 2737** Description This function is called to switch role between master and 2738** slave. If role is already set it will do nothing. If the 2739** command was initiated, the callback function is called upon 2740** completion. 2741** 2742** Returns BTM_SUCCESS if already in specified role. 2743** BTM_CMD_STARTED if command issued to controller. 2744** BTM_NO_RESOURCES if couldn't allocate memory to issue command 2745** BTM_UNKNOWN_ADDR if no active link with bd addr specified 2746** BTM_MODE_UNSUPPORTED if local device does not support role switching 2747** 2748*******************************************************************************/ 2749extern tBTM_STATUS BTM_SwitchRole (BD_ADDR remote_bd_addr, 2750 UINT8 new_role, 2751 tBTM_CMPL_CB *p_cb); 2752 2753/******************************************************************************* 2754** 2755** Function BTM_ReadRSSI 2756** 2757** Description This function is called to read the link policy settings. 2758** The address of link policy results are returned in the callback. 2759** (tBTM_RSSI_RESULTS) 2760** 2761** Returns BTM_CMD_STARTED if command issued to controller. 2762** BTM_NO_RESOURCES if couldn't allocate memory to issue command 2763** BTM_UNKNOWN_ADDR if no active link with bd addr specified 2764** BTM_BUSY if command is already in progress 2765** 2766*******************************************************************************/ 2767extern tBTM_STATUS BTM_ReadRSSI (BD_ADDR remote_bda, tBTM_CMPL_CB *p_cb); 2768 2769 2770/******************************************************************************* 2771** 2772** Function BTM_ReadTxPower 2773** 2774** Description This function is called to read the current connection 2775** TX power of the connection. The TX power level results 2776** are returned in the callback. 2777** (tBTM_RSSI_RESULTS) 2778** 2779** Returns BTM_CMD_STARTED if command issued to controller. 2780** BTM_NO_RESOURCES if couldn't allocate memory to issue command 2781** BTM_UNKNOWN_ADDR if no active link with bd addr specified 2782** BTM_BUSY if command is already in progress 2783** 2784*******************************************************************************/ 2785extern tBTM_STATUS BTM_ReadTxPower (BD_ADDR remote_bda, 2786 tBT_TRANSPORT transport, tBTM_CMPL_CB *p_cb); 2787 2788/******************************************************************************* 2789** 2790** Function BTM_ReadLinkQuality 2791** 2792** Description This function is called to read the link quality. 2793** The value of the link quality is returned in the callback. 2794** (tBTM_LINK_QUALITY_RESULTS) 2795** 2796** Returns BTM_CMD_STARTED if command issued to controller. 2797** BTM_NO_RESOURCES if couldn't allocate memory to issue command 2798** BTM_UNKNOWN_ADDR if no active link with bd addr specified 2799** BTM_BUSY if command is already in progress 2800** 2801*******************************************************************************/ 2802extern tBTM_STATUS BTM_ReadLinkQuality (BD_ADDR remote_bda, tBTM_CMPL_CB *p_cb); 2803 2804/******************************************************************************* 2805** 2806** Function BTM_RegBusyLevelNotif 2807** 2808** Description This function is called to register a callback to receive 2809** busy level change events. 2810** 2811** Returns BTM_SUCCESS if successfully registered, otherwise error 2812** 2813*******************************************************************************/ 2814extern tBTM_STATUS BTM_RegBusyLevelNotif (tBTM_BL_CHANGE_CB *p_cb, UINT8 *p_level, 2815 tBTM_BL_EVENT_MASK evt_mask); 2816 2817/******************************************************************************* 2818** 2819** Function BTM_AclRegisterForChanges 2820** 2821** Description This function is called to register a callback to receive 2822** ACL database change events, i.e. new connection or removed. 2823** 2824** Returns BTM_SUCCESS if successfully initiated, otherwise error 2825** 2826*******************************************************************************/ 2827extern tBTM_STATUS BTM_AclRegisterForChanges (tBTM_ACL_DB_CHANGE_CB *p_cb); 2828 2829/******************************************************************************* 2830** 2831** Function BTM_GetNumAclLinks 2832** 2833** Description This function is called to count the number of 2834** ACL links that are active. 2835** 2836** Returns UINT16 Number of active ACL links 2837** 2838*******************************************************************************/ 2839extern UINT16 BTM_GetNumAclLinks (void); 2840 2841/******************************************************************************* 2842** 2843** Function BTM_SetQoS 2844** 2845** Description This function is called to setup QoS 2846** 2847** Returns BTM_CMD_STARTED if successfully initiated, otherwise error 2848** 2849*******************************************************************************/ 2850extern tBTM_STATUS BTM_SetQoS(BD_ADDR bd, FLOW_SPEC *p_flow, 2851 tBTM_CMPL_CB *p_cb); 2852 2853 2854/***************************************************************************** 2855** (e)SCO CHANNEL MANAGEMENT FUNCTIONS 2856*****************************************************************************/ 2857/******************************************************************************* 2858** 2859** Function BTM_CreateSco 2860** 2861** Description This function is called to create an SCO connection. If the 2862** "is_orig" flag is TRUE, the connection will be originated, 2863** otherwise BTM will wait for the other side to connect. 2864** 2865** Returns BTM_UNKNOWN_ADDR if the ACL connection is not up 2866** BTM_BUSY if another SCO being set up to 2867** the same BD address 2868** BTM_NO_RESOURCES if the max SCO limit has been reached 2869** BTM_CMD_STARTED if the connection establishment is started. 2870** In this case, "*p_sco_inx" is filled in 2871** with the sco index used for the connection. 2872** 2873*******************************************************************************/ 2874extern tBTM_STATUS BTM_CreateSco (BD_ADDR remote_bda, BOOLEAN is_orig, 2875 UINT16 pkt_types, UINT16 *p_sco_inx, 2876 tBTM_SCO_CB *p_conn_cb, 2877 tBTM_SCO_CB *p_disc_cb); 2878 2879 2880/******************************************************************************* 2881** 2882** Function BTM_RemoveSco 2883** 2884** Description This function is called to remove a specific SCO connection. 2885** 2886** Returns BTM_CMD_STARTED if successfully initiated, otherwise error 2887** 2888*******************************************************************************/ 2889extern tBTM_STATUS BTM_RemoveSco (UINT16 sco_inx); 2890 2891 2892/******************************************************************************* 2893** 2894** Function BTM_SetScoPacketTypes 2895** 2896** Description This function is called to set the packet types used for 2897** a specific SCO connection, 2898** 2899** Parameters pkt_types - One or more of the following 2900** BTM_SCO_PKT_TYPES_MASK_HV1 2901** BTM_SCO_PKT_TYPES_MASK_HV2 2902** BTM_SCO_PKT_TYPES_MASK_HV3 2903** BTM_SCO_PKT_TYPES_MASK_EV3 2904** BTM_SCO_PKT_TYPES_MASK_EV4 2905** BTM_SCO_PKT_TYPES_MASK_EV5 2906** 2907** BTM_SCO_LINK_ALL_MASK - enables all supported types 2908** 2909** Returns BTM_CMD_STARTED if successfully initiated, otherwise error 2910** 2911*******************************************************************************/ 2912extern tBTM_STATUS BTM_SetScoPacketTypes (UINT16 sco_inx, UINT16 pkt_types); 2913 2914 2915/******************************************************************************* 2916** 2917** Function BTM_ReadScoPacketTypes 2918** 2919** Description This function is read the packet types used for a specific 2920** SCO connection. 2921** 2922** Returns One or more of the following (bitmask) 2923** BTM_SCO_PKT_TYPES_MASK_HV1 2924** BTM_SCO_PKT_TYPES_MASK_HV2 2925** BTM_SCO_PKT_TYPES_MASK_HV3 2926** BTM_SCO_PKT_TYPES_MASK_EV3 2927** BTM_SCO_PKT_TYPES_MASK_EV4 2928** BTM_SCO_PKT_TYPES_MASK_EV5 2929** 2930** Returns packet types supported for the connection 2931** 2932*******************************************************************************/ 2933extern UINT16 BTM_ReadScoPacketTypes (UINT16 sco_inx); 2934 2935 2936/******************************************************************************* 2937** 2938** Function BTM_ReadDeviceScoPacketTypes 2939** 2940** Description This function is read the SCO packet types that 2941** the device supports. 2942** 2943** Returns packet types supported by the device. 2944** 2945*******************************************************************************/ 2946extern UINT16 BTM_ReadDeviceScoPacketTypes (void); 2947 2948 2949/******************************************************************************* 2950** 2951** Function BTM_ReadScoHandle 2952** 2953** Description This function is used to read the HCI handle used for a specific 2954** SCO connection, 2955** 2956** Returns handle for the connection, or 0xFFFF if invalid SCO index. 2957** 2958*******************************************************************************/ 2959extern UINT16 BTM_ReadScoHandle (UINT16 sco_inx); 2960 2961 2962/******************************************************************************* 2963** 2964** Function BTM_ReadScoBdAddr 2965** 2966** Description This function is read the remote BD Address for a specific 2967** SCO connection, 2968** 2969** Returns pointer to BD address or NULL if not known 2970** 2971*******************************************************************************/ 2972extern UINT8 *BTM_ReadScoBdAddr (UINT16 sco_inx); 2973 2974 2975/******************************************************************************* 2976** 2977** Function BTM_ReadScoDiscReason 2978** 2979** Description This function is returns the reason why an (e)SCO connection 2980** has been removed. It contains the value until read, or until 2981** another (e)SCO connection has disconnected. 2982** 2983** Returns HCI reason or BTM_INVALID_SCO_DISC_REASON if not set. 2984** 2985*******************************************************************************/ 2986extern UINT16 BTM_ReadScoDiscReason (void); 2987 2988 2989/******************************************************************************* 2990** 2991** Function BTM_SetEScoMode 2992** 2993** Description This function sets up the negotiated parameters for SCO or 2994** eSCO, and sets as the default mode used for calls to 2995** BTM_CreateSco. It can be called only when there are no 2996** active (e)SCO links. 2997** 2998** Returns BTM_SUCCESS if the successful. 2999** BTM_BUSY if there are one or more active (e)SCO links. 3000** 3001*******************************************************************************/ 3002extern tBTM_STATUS BTM_SetEScoMode (tBTM_SCO_TYPE sco_mode, 3003 tBTM_ESCO_PARAMS *p_parms); 3004 3005/******************************************************************************* 3006** 3007** Function BTM_SetWBSCodec 3008** 3009** Description This function sends command to the controller to setup 3010** WBS codec for the upcoming eSCO connection. 3011** 3012** Returns BTM_SUCCESS. 3013** 3014** 3015*******************************************************************************/ 3016extern tBTM_STATUS BTM_SetWBSCodec (tBTM_SCO_CODEC_TYPE codec_type); 3017 3018/******************************************************************************* 3019** 3020** Function BTM_RegForEScoEvts 3021** 3022** Description This function registers a SCO event callback with the 3023** specified instance. It should be used to received 3024** connection indication events and change of link parameter 3025** events. 3026** 3027** Returns BTM_SUCCESS if the successful. 3028** BTM_ILLEGAL_VALUE if there is an illegal sco_inx 3029** 3030*******************************************************************************/ 3031extern tBTM_STATUS BTM_RegForEScoEvts (UINT16 sco_inx, 3032 tBTM_ESCO_CBACK *p_esco_cback); 3033 3034/******************************************************************************* 3035** 3036** Function BTM_ReadEScoLinkParms 3037** 3038** Description This function returns the current eSCO link parameters for 3039** the specified handle. This can be called anytime a connection 3040** is active, but is typically called after receiving the SCO 3041** opened callback. 3042** 3043** Note: If called over a 1.1 controller, only the packet types 3044** field has meaning. 3045** Note: If the upper layer doesn't know the current sco index, 3046** BTM_FIRST_ACTIVE_SCO_INDEX can be used as the first parameter to 3047** find the first active SCO index 3048** 3049** Returns BTM_SUCCESS if returned data is valid connection. 3050** BTM_ILLEGAL_VALUE if no connection for specified sco_inx. 3051** BTM_MODE_UNSUPPORTED if local controller does not support 3052** 1.2 specification. 3053** 3054*******************************************************************************/ 3055extern tBTM_STATUS BTM_ReadEScoLinkParms (UINT16 sco_inx, 3056 tBTM_ESCO_DATA *p_parms); 3057 3058/******************************************************************************* 3059** 3060** Function BTM_ChangeEScoLinkParms 3061** 3062** Description This function requests renegotiation of the parameters on 3063** the current eSCO Link. If any of the changes are accepted 3064** by the controllers, the BTM_ESCO_CHG_EVT event is sent in 3065** the tBTM_ESCO_CBACK function with the current settings of 3066** the link. The callback is registered through the call to 3067** BTM_SetEScoMode. 3068** 3069** 3070** Returns BTM_CMD_STARTED if command is successfully initiated. 3071** BTM_ILLEGAL_VALUE if no connection for specified sco_inx. 3072** BTM_NO_RESOURCES - not enough resources to initiate command. 3073** BTM_MODE_UNSUPPORTED if local controller does not support 3074** 1.2 specification. 3075** 3076*******************************************************************************/ 3077extern tBTM_STATUS BTM_ChangeEScoLinkParms (UINT16 sco_inx, 3078 tBTM_CHG_ESCO_PARAMS *p_parms); 3079 3080/******************************************************************************* 3081** 3082** Function BTM_EScoConnRsp 3083** 3084** Description This function is called upon receipt of an (e)SCO connection 3085** request event (BTM_ESCO_CONN_REQ_EVT) to accept or reject 3086** the request. Parameters used to negotiate eSCO links. 3087** If p_parms is NULL, then values set through BTM_SetEScoMode 3088** are used. 3089** If the link type of the incoming request is SCO, then only 3090** the tx_bw, max_latency, content format, and packet_types are 3091** valid. The hci_status parameter should be 3092** ([0x0] to accept, [0x0d..0x0f] to reject) 3093** 3094** 3095** Returns void 3096** 3097*******************************************************************************/ 3098extern void BTM_EScoConnRsp (UINT16 sco_inx, UINT8 hci_status, 3099 tBTM_ESCO_PARAMS *p_parms); 3100 3101/******************************************************************************* 3102** 3103** Function BTM_GetNumScoLinks 3104** 3105** Description This function returns the number of active SCO links. 3106** 3107** Returns UINT8 3108** 3109*******************************************************************************/ 3110extern UINT8 BTM_GetNumScoLinks (void); 3111 3112/***************************************************************************** 3113** SECURITY MANAGEMENT FUNCTIONS 3114*****************************************************************************/ 3115/******************************************************************************* 3116** 3117** Function BTM_SecRegister 3118** 3119** Description Application manager calls this function to register for 3120** security services. There can be one and only one application 3121** saving link keys. BTM allows only first registration. 3122** 3123** Returns TRUE if registered OK, else FALSE 3124** 3125*******************************************************************************/ 3126extern BOOLEAN BTM_SecRegister (tBTM_APPL_INFO *p_cb_info); 3127 3128 3129/******************************************************************************* 3130** 3131** Function BTM_SecAddRmtNameNotifyCallback 3132** 3133** Description Profiles can register to be notified when name of the 3134** remote device is resolved (up to BTM_SEC_MAX_RMT_NAME_CALLBACKS). 3135** 3136** Returns TRUE if registered OK, else FALSE 3137** 3138*******************************************************************************/ 3139extern BOOLEAN BTM_SecAddRmtNameNotifyCallback (tBTM_RMT_NAME_CALLBACK *p_callback); 3140 3141 3142/******************************************************************************* 3143** 3144** Function BTM_SecDeleteRmtNameNotifyCallback 3145** 3146** Description A profile can deregister notification when a new Link Key 3147** is generated per connection. 3148** 3149** Returns TRUE if OK, else FALSE 3150** 3151*******************************************************************************/ 3152extern BOOLEAN BTM_SecDeleteRmtNameNotifyCallback (tBTM_RMT_NAME_CALLBACK *p_callback); 3153 3154/******************************************************************************* 3155** 3156** Function BTM_GetSecurityFlags 3157** 3158** Description Get security flags for the device 3159** 3160** Returns BOOLEAN TRUE or FALSE is device found 3161** 3162*******************************************************************************/ 3163extern BOOLEAN BTM_GetSecurityFlags (BD_ADDR bd_addr, UINT8 * p_sec_flags); 3164 3165/******************************************************************************* 3166** 3167** Function BTM_GetSecurityFlagsByTransport 3168** 3169** Description Get security flags for the device on a particular transport 3170** 3171** Parameters bd_addr: BD address of remote device 3172** p_sec_flags : Out parameter to be filled with security flags for the connection 3173** transport : Physical transport of the connection (BR/EDR or LE) 3174** 3175** Returns BOOLEAN TRUE or FALSE is device found 3176** 3177*******************************************************************************/ 3178extern BOOLEAN BTM_GetSecurityFlagsByTransport (BD_ADDR bd_addr, 3179 UINT8 * p_sec_flags, tBT_TRANSPORT transport); 3180 3181/******************************************************************************* 3182** 3183** Function BTM_ReadTrustedMask 3184** 3185** Description Get trusted mask for the device 3186** 3187** Returns NULL, if the device record is not found. 3188** otherwise, the trusted mask 3189** 3190*******************************************************************************/ 3191extern UINT32 * BTM_ReadTrustedMask (BD_ADDR bd_addr); 3192 3193/******************************************************************************* 3194** 3195** Function BTM_SetPinType 3196** 3197** Description Set PIN type for the device. 3198** 3199** Returns void 3200** 3201*******************************************************************************/ 3202extern void BTM_SetPinType (UINT8 pin_type, PIN_CODE pin_code, UINT8 pin_code_len); 3203 3204 3205/******************************************************************************* 3206** 3207** Function BTM_SetPairableMode 3208** 3209** Description Enable or disable pairing 3210** 3211** Parameters allow_pairing - (TRUE or FALSE) whether or not the device 3212** allows pairing. 3213** connect_only_paired - (TRUE or FALSE) whether or not to 3214** only allow paired devices to connect. 3215** 3216** Returns void 3217** 3218*******************************************************************************/ 3219extern void BTM_SetPairableMode (BOOLEAN allow_pairing, BOOLEAN connect_only_paired); 3220 3221/******************************************************************************* 3222** 3223** Function BTM_SetSecureConnectionsOnly 3224** 3225** Description Enable or disable default treatment for Mode 4 Level 0 services 3226** 3227** Parameter secure_connections_only_mode - (TRUE or FALSE) 3228** TRUE means that the device should treat Mode 4 Level 0 services as 3229** services of other levels. 3230** FALSE means that the device should provide default treatment for 3231** Mode 4 Level 0 services. 3232** 3233** Returns void 3234** 3235*******************************************************************************/ 3236extern void BTM_SetSecureConnectionsOnly (BOOLEAN secure_connections_only_mode); 3237 3238/******************************************************************************* 3239** 3240** Function BTM_SetSecurityLevel 3241** 3242** Description Register service security level with Security Manager. Each 3243** service must register its requirements regardless of the 3244** security level that is used. This API is called once for originators 3245** nad again for acceptors of connections. 3246** 3247** Returns TRUE if registered OK, else FALSE 3248** 3249*******************************************************************************/ 3250extern BOOLEAN BTM_SetSecurityLevel (BOOLEAN is_originator, char *p_name, 3251 UINT8 service_id, UINT16 sec_level, 3252 UINT16 psm, UINT32 mx_proto_id, 3253 UINT32 mx_chan_id); 3254 3255/******************************************************************************* 3256** 3257** Function BTM_SetOutService 3258** 3259** Description This function is called to set the service for 3260** outgoing connection. 3261** 3262** Returns void 3263** 3264*******************************************************************************/ 3265extern void BTM_SetOutService(BD_ADDR bd_addr, UINT8 service_id, UINT32 mx_chan_id); 3266 3267/******************************************************************************* 3268** 3269** Function BTM_SecClrService 3270** 3271** Description Removes specified service record(s) from the security database. 3272** All service records with the specified name are removed. 3273** Typically used only by devices with limited RAM so that it can 3274** reuse an old security service record. 3275** records (except SDP). 3276** 3277** Returns Number of records that were freed. 3278** 3279*******************************************************************************/ 3280extern UINT8 BTM_SecClrService (UINT8 service_id); 3281 3282/******************************************************************************* 3283** 3284** Function BTM_SecAddDevice 3285** 3286** Description Add/modify device. This function will be normally called 3287** during host startup to restore all required information 3288** stored in the NVRAM. 3289** dev_class, bd_name, link_key, and features are NULL if unknown 3290** 3291** Returns TRUE if added OK, else FALSE 3292** 3293*******************************************************************************/ 3294extern BOOLEAN BTM_SecAddDevice (BD_ADDR bd_addr, DEV_CLASS dev_class, 3295 BD_NAME bd_name, UINT8 *features, 3296 UINT32 trusted_mask[], LINK_KEY link_key, 3297 UINT8 key_type, tBTM_IO_CAP io_cap); 3298 3299 3300/******************************************************************************* 3301** 3302** Function BTM_SecDeleteDevice 3303** 3304** Description Free resources associated with the device. 3305** 3306** Returns TRUE if rmoved OK, FALSE if not found 3307** 3308*******************************************************************************/ 3309extern BOOLEAN BTM_SecDeleteDevice (BD_ADDR bd_addr); 3310 3311 3312/******************************************************************************* 3313** 3314** Function BTM_SecGetDeviceLinkKey 3315** 3316** Description This function is called to obtain link key for the device 3317** it returns BTM_SUCCESS if link key is available, or 3318** BTM_UNKNOWN_ADDR if Security Manager does not know about 3319** the device or device record does not contain link key info 3320** 3321** Returns BTM_SUCCESS if successful, otherwise error code 3322** 3323*******************************************************************************/ 3324extern tBTM_STATUS BTM_SecGetDeviceLinkKey (BD_ADDR bd_addr, 3325 LINK_KEY link_key); 3326 3327 3328/******************************************************************************* 3329** 3330** Function BTM_SecGetDeviceLinkKeyType 3331** 3332** Description This function is called to obtain link key type for the 3333** device. 3334** it returns BTM_SUCCESS if link key is available, or 3335** BTM_UNKNOWN_ADDR if Security Manager does not know about 3336** the device or device record does not contain link key info 3337** 3338** Returns BTM_LKEY_TYPE_IGNORE if link key is unknown, link type 3339** otherwise. 3340** 3341*******************************************************************************/ 3342extern tBTM_LINK_KEY_TYPE BTM_SecGetDeviceLinkKeyType (BD_ADDR bd_addr); 3343 3344 3345/******************************************************************************* 3346** 3347** Function BTM_PINCodeReply 3348** 3349** Description This function is called after Security Manager submitted 3350** PIN code request to the UI. 3351** 3352** Parameters: bd_addr - Address of the device for which PIN was requested 3353** res - result of the operation BTM_SUCCESS if success 3354** pin_len - length in bytes of the PIN Code 3355** p_pin - pointer to array with the PIN Code 3356** trusted_mask - bitwise OR of trusted services (array of UINT32) 3357** 3358** Returns void 3359** 3360*******************************************************************************/ 3361extern void BTM_PINCodeReply (BD_ADDR bd_addr, UINT8 res, UINT8 pin_len, 3362 UINT8 *p_pin, UINT32 trusted_mask[]); 3363 3364 3365/******************************************************************************* 3366** 3367** Function BTM_SecBond 3368** 3369** Description This function is called to perform bonding with peer device. 3370** 3371** Parameters: bd_addr - Address of the device to bond 3372** pin_len - length in bytes of the PIN Code 3373** p_pin - pointer to array with the PIN Code 3374** trusted_mask - bitwise OR of trusted services (array of UINT32) 3375 3376** Returns BTM_CMD_STARTED if successfully initiated, otherwise error 3377** 3378*******************************************************************************/ 3379extern tBTM_STATUS BTM_SecBond (BD_ADDR bd_addr, 3380 UINT8 pin_len, UINT8 *p_pin, 3381 UINT32 trusted_mask[]); 3382 3383/******************************************************************************* 3384** 3385** Function BTM_SecBondByTransport 3386** 3387** Description This function is called to perform bonding by designated transport 3388** 3389** Parameters: bd_addr - Address of the device to bond 3390** pin_len - length in bytes of the PIN Code 3391** p_pin - pointer to array with the PIN Code 3392** trusted_mask - bitwise OR of trusted services (array of UINT32) 3393** transport : Physical transport to use for bonding (BR/EDR or LE) 3394** 3395** Returns BTM_CMD_STARTED if successfully initiated, otherwise error 3396** 3397*******************************************************************************/ 3398extern tBTM_STATUS BTM_SecBondByTransport (BD_ADDR bd_addr, 3399 tBT_TRANSPORT transport, 3400 UINT8 pin_len, UINT8 *p_pin, 3401 UINT32 trusted_mask[]); 3402 3403/******************************************************************************* 3404** 3405** Function BTM_SecBondCancel 3406** 3407** Description This function is called to cancel ongoing bonding process 3408** with peer device. 3409** 3410** Returns BTM_CMD_STARTED if successfully initiated, otherwise error 3411** 3412*******************************************************************************/ 3413extern tBTM_STATUS BTM_SecBondCancel (BD_ADDR bd_addr); 3414 3415/******************************************************************************* 3416** 3417** Function BTM_SetEncryption 3418** 3419** Description This function is called to ensure that connection is 3420** encrypted. Should be called only on an open connection. 3421** Typically only needed for connections that first want to 3422** bring up unencrypted links, then later encrypt them. 3423** 3424** Parameters: bd_addr - Address of the peer device 3425** p_callback - Pointer to callback function called if 3426** this function returns PENDING after required 3427** procedures are completed. Can be set to NULL 3428** if status is not desired. 3429** p_ref_data - pointer to any data the caller wishes to receive 3430** in the callback function upon completion. 3431* can be set to NULL if not used. 3432** 3433** Returns BTM_SUCCESS - already encrypted 3434** BTM_PENDING - command will be returned in the callback 3435** BTM_WRONG_MODE- connection not up. 3436** BTM_BUSY - security procedures are currently active 3437** BTM_MODE_UNSUPPORTED - if security manager not linked in. 3438** 3439*******************************************************************************/ 3440extern tBTM_STATUS BTM_SetEncryption (BD_ADDR bd_addr, tBT_TRANSPORT transport, 3441 tBTM_SEC_CBACK *p_callback, void *p_ref_data); 3442 3443/******************************************************************************* 3444** 3445** Function BTM_ConfirmReqReply 3446** 3447** Description This function is called to confirm the numeric value for 3448** Simple Pairing in response to BTM_SP_CFM_REQ_EVT 3449** 3450** Parameters: res - result of the operation BTM_SUCCESS if success 3451** bd_addr - Address of the peer device 3452** 3453*******************************************************************************/ 3454extern void BTM_ConfirmReqReply(tBTM_STATUS res, BD_ADDR bd_addr); 3455 3456/******************************************************************************* 3457** 3458** Function BTM_PasskeyReqReply 3459** 3460** Description This function is called to provide the passkey for 3461** Simple Pairing in response to BTM_SP_KEY_REQ_EVT 3462** 3463** Parameters: res - result of the operation BTM_SUCCESS if success 3464** bd_addr - Address of the peer device 3465** passkey - numeric value in the range of 0 - 999999(0xF423F). 3466** 3467*******************************************************************************/ 3468extern void BTM_PasskeyReqReply(tBTM_STATUS res, BD_ADDR bd_addr, UINT32 passkey); 3469 3470/******************************************************************************* 3471** 3472** Function BTM_SendKeypressNotif 3473** 3474** Description This function is used during the passkey entry model 3475** by a device with KeyboardOnly IO capabilities 3476** (very likely to be a HID Device). 3477** It is called by a HID Device to inform the remote device when 3478** a key has been entered or erased. 3479** 3480** Parameters: bd_addr - Address of the peer device 3481** type - notification type 3482** 3483*******************************************************************************/ 3484extern void BTM_SendKeypressNotif(BD_ADDR bd_addr, tBTM_SP_KEY_TYPE type); 3485 3486/******************************************************************************* 3487** 3488** Function BTM_IoCapRsp 3489** 3490** Description This function is called in response to BTM_SP_IO_REQ_EVT 3491** When the event data io_req.oob_data is set to BTM_OOB_UNKNOWN 3492** by the tBTM_SP_CALLBACK implementation, this function is 3493** called to provide the actual response 3494** 3495** Parameters: bd_addr - Address of the peer device 3496** io_cap - The IO capability of local device. 3497** oob - BTM_OOB_NONE or BTM_OOB_PRESENT. 3498** auth_req- MITM protection required or not. 3499** 3500*******************************************************************************/ 3501extern void BTM_IoCapRsp(BD_ADDR bd_addr, tBTM_IO_CAP io_cap, 3502 tBTM_OOB_DATA oob, tBTM_AUTH_REQ auth_req); 3503 3504/******************************************************************************* 3505** 3506** Function BTM_ReadLocalOobData 3507** 3508** Description This function is called to read the local OOB data from 3509** LM 3510** 3511*******************************************************************************/ 3512extern tBTM_STATUS BTM_ReadLocalOobData(void); 3513 3514/******************************************************************************* 3515** 3516** Function BTM_RemoteOobDataReply 3517** 3518** Description This function is called to provide the remote OOB data for 3519** Simple Pairing in response to BTM_SP_RMT_OOB_EVT 3520** 3521** Parameters: bd_addr - Address of the peer device 3522** c - simple pairing Hash C. 3523** r - simple pairing Randomizer C. 3524** 3525*******************************************************************************/ 3526extern void BTM_RemoteOobDataReply(tBTM_STATUS res, BD_ADDR bd_addr, 3527 BT_OCTET16 c, BT_OCTET16 r); 3528 3529/******************************************************************************* 3530** 3531** Function BTM_BuildOobData 3532** 3533** Description This function is called to build the OOB data payload to 3534** be sent over OOB (non-Bluetooth) link 3535** 3536** Parameters: p_data - the location for OOB data 3537** max_len - p_data size. 3538** c - simple pairing Hash C. 3539** r - simple pairing Randomizer C. 3540** name_len- 0, local device name would not be included. 3541** otherwise, the local device name is included for 3542** up to this specified length 3543** 3544** Returns Number of bytes in p_data. 3545** 3546*******************************************************************************/ 3547extern UINT16 BTM_BuildOobData(UINT8 *p_data, UINT16 max_len, BT_OCTET16 c, 3548 BT_OCTET16 r, UINT8 name_len); 3549 3550/******************************************************************************* 3551** 3552** Function BTM_BothEndsSupportSecureConnections 3553** 3554** Description This function is called to check if both the local device and the peer device 3555** specified by bd_addr support BR/EDR Secure Connections. 3556** 3557** Parameters: bd_addr - address of the peer 3558** 3559** Returns TRUE if BR/EDR Secure Connections are supported by both local 3560** and the remote device. 3561** else FALSE. 3562** 3563*******************************************************************************/ 3564extern BOOLEAN BTM_BothEndsSupportSecureConnections(BD_ADDR bd_addr); 3565 3566/******************************************************************************* 3567** 3568** Function BTM_PeerSupportsSecureConnections 3569** 3570** Description This function is called to check if the peer supports 3571** BR/EDR Secure Connections. 3572** 3573** Parameters: bd_addr - address of the peer 3574** 3575** Returns TRUE if BR/EDR Secure Connections are supported by the peer, 3576** else FALSE. 3577** 3578*******************************************************************************/ 3579extern BOOLEAN BTM_PeerSupportsSecureConnections(BD_ADDR bd_addr); 3580 3581/******************************************************************************* 3582** 3583** Function BTM_ReadOobData 3584** 3585** Description This function is called to parse the OOB data payload 3586** received over OOB (non-Bluetooth) link 3587** 3588** Parameters: p_data - the location for OOB data 3589** eir_tag - The associated EIR tag to read the data. 3590** *p_len(output) - the length of the data with the given tag. 3591** 3592** Returns the beginning of the data with the given tag. 3593** NULL, if the tag is not found. 3594** 3595*******************************************************************************/ 3596extern UINT8 * BTM_ReadOobData(UINT8 *p_data, UINT8 eir_tag, UINT8 *p_len); 3597 3598/******************************************************************************* 3599** 3600** Function BTM_SecReadDevName 3601** 3602** Description Looks for the device name in the security database for the 3603** specified BD address. 3604** 3605** Returns Pointer to the name or NULL 3606** 3607*******************************************************************************/ 3608extern char *BTM_SecReadDevName (BD_ADDR bd_addr); 3609 3610 3611/***************************************************************************** 3612** POWER MANAGEMENT FUNCTIONS 3613*****************************************************************************/ 3614/******************************************************************************* 3615** 3616** Function BTM_PmRegister 3617** 3618** Description register or deregister with power manager 3619** 3620** Returns BTM_SUCCESS if successful, 3621** BTM_NO_RESOURCES if no room to hold registration 3622** BTM_ILLEGAL_VALUE 3623** 3624*******************************************************************************/ 3625extern tBTM_STATUS BTM_PmRegister (UINT8 mask, UINT8 *p_pm_id, 3626 tBTM_PM_STATUS_CBACK *p_cb); 3627 3628 3629/******************************************************************************* 3630** 3631** Function BTM_SetPowerMode 3632** 3633** Description store the mode in control block or 3634** alter ACL connection behavior. 3635** 3636** Returns BTM_SUCCESS if successful, 3637** BTM_UNKNOWN_ADDR if bd addr is not active or bad 3638** 3639*******************************************************************************/ 3640extern tBTM_STATUS BTM_SetPowerMode (UINT8 pm_id, BD_ADDR remote_bda, 3641 tBTM_PM_PWR_MD *p_mode); 3642 3643 3644/******************************************************************************* 3645** 3646** Function BTM_ReadPowerMode 3647** 3648** Description This returns the current mode for a specific 3649** ACL connection. 3650** 3651** Input Param remote_bda - device address of desired ACL connection 3652** 3653** Output Param p_mode - address where the current mode is copied into. 3654** BTM_ACL_MODE_NORMAL 3655** BTM_ACL_MODE_HOLD 3656** BTM_ACL_MODE_SNIFF 3657** BTM_ACL_MODE_PARK 3658** (valid only if return code is BTM_SUCCESS) 3659** 3660** Returns BTM_SUCCESS if successful, 3661** BTM_UNKNOWN_ADDR if bd addr is not active or bad 3662** 3663*******************************************************************************/ 3664extern tBTM_STATUS BTM_ReadPowerMode (BD_ADDR remote_bda, 3665 tBTM_PM_MODE *p_mode); 3666 3667/******************************************************************************* 3668** 3669** Function BTM_SetSsrParams 3670** 3671** Description This sends the given SSR parameters for the given ACL 3672** connection if it is in ACTIVE mode. 3673** 3674** Input Param remote_bda - device address of desired ACL connection 3675** max_lat - maximum latency (in 0.625ms)(0-0xFFFE) 3676** min_rmt_to - minimum remote timeout 3677** min_loc_to - minimum local timeout 3678** 3679** 3680** Returns BTM_SUCCESS if the HCI command is issued successful, 3681** BTM_UNKNOWN_ADDR if bd addr is not active or bad 3682** BTM_CMD_STORED if the command is stored 3683** 3684*******************************************************************************/ 3685extern tBTM_STATUS BTM_SetSsrParams (BD_ADDR remote_bda, UINT16 max_lat, 3686 UINT16 min_rmt_to, UINT16 min_loc_to); 3687 3688/******************************************************************************* 3689** 3690** Function BTM_GetHCIConnHandle 3691** 3692** Description This function is called to get the handle for an ACL connection 3693** to a specific remote BD Address. 3694** 3695** Returns the handle of the connection, or 0xFFFF if none. 3696** 3697*******************************************************************************/ 3698extern UINT16 BTM_GetHCIConnHandle (BD_ADDR remote_bda, tBT_TRANSPORT transport); 3699 3700/******************************************************************************* 3701** 3702** Function BTM_DeleteStoredLinkKey 3703** 3704** Description This function is called to delete link key for the specified 3705** device addresses from the NVRAM storage attached to the Bluetooth 3706** controller. 3707** 3708** Parameters: bd_addr - Addresses of the devices 3709** p_cb - Call back function to be called to return 3710** the results 3711** 3712*******************************************************************************/ 3713extern tBTM_STATUS BTM_DeleteStoredLinkKey(BD_ADDR bd_addr, tBTM_CMPL_CB *p_cb); 3714 3715/******************************************************************************* 3716** 3717** Function BTM_WriteEIR 3718** 3719** Description This function is called to write EIR data to controller. 3720** 3721** Parameters p_buff - allocated HCI command buffer including extended 3722** inquriry response 3723** 3724** Returns BTM_SUCCESS - if successful 3725** BTM_MODE_UNSUPPORTED - if local device cannot support it 3726** 3727*******************************************************************************/ 3728extern tBTM_STATUS BTM_WriteEIR( BT_HDR * p_buff ); 3729 3730/******************************************************************************* 3731** 3732** Function BTM_CheckEirData 3733** 3734** Description This function is called to get EIR data from significant part. 3735** 3736** Parameters p_eir - pointer of EIR significant part 3737** type - finding EIR data type 3738** p_length - return the length of EIR data 3739** 3740** Returns pointer of EIR data 3741** 3742*******************************************************************************/ 3743extern UINT8 *BTM_CheckEirData( UINT8 *p_eir, UINT8 type, UINT8 *p_length ); 3744 3745/******************************************************************************* 3746** 3747** Function BTM_HasEirService 3748** 3749** Description This function is called to know if UUID in bit map of UUID. 3750** 3751** Parameters p_eir_uuid - bit map of UUID list 3752** uuid16 - UUID 16-bit 3753** 3754** Returns TRUE - if found 3755** FALSE - if not found 3756** 3757*******************************************************************************/ 3758extern BOOLEAN BTM_HasEirService( UINT32 *p_eir_uuid, UINT16 uuid16 ); 3759 3760/******************************************************************************* 3761** 3762** Function BTM_HasInquiryEirService 3763** 3764** Description This function is called to know if UUID in bit map of UUID list. 3765** 3766** Parameters p_results - inquiry results 3767** uuid16 - UUID 16-bit 3768** 3769** Returns BTM_EIR_FOUND - if found 3770** BTM_EIR_NOT_FOUND - if not found and it is complete list 3771** BTM_EIR_UNKNOWN - if not found and it is not complete list 3772** 3773*******************************************************************************/ 3774extern tBTM_EIR_SEARCH_RESULT BTM_HasInquiryEirService( tBTM_INQ_RESULTS *p_results, 3775 UINT16 uuid16 ); 3776 3777/******************************************************************************* 3778** 3779** Function BTM_AddEirService 3780** 3781** Description This function is called to add a service in bit map of UUID list. 3782** 3783** Parameters p_eir_uuid - bit mask of UUID list for EIR 3784** uuid16 - UUID 16-bit 3785** 3786** Returns None 3787** 3788*******************************************************************************/ 3789extern void BTM_AddEirService( UINT32 *p_eir_uuid, UINT16 uuid16 ); 3790 3791/******************************************************************************* 3792** 3793** Function BTM_RemoveEirService 3794** 3795** Description This function is called to remove a service in bit map of UUID list. 3796** 3797** Parameters p_eir_uuid - bit mask of UUID list for EIR 3798** uuid16 - UUID 16-bit 3799** 3800** Returns None 3801** 3802*******************************************************************************/ 3803extern void BTM_RemoveEirService( UINT32 *p_eir_uuid, UINT16 uuid16 ); 3804 3805/******************************************************************************* 3806** 3807** Function BTM_GetEirSupportedServices 3808** 3809** Description This function is called to get UUID list from bit map of UUID list. 3810** 3811** Parameters p_eir_uuid - bit mask of UUID list for EIR 3812** p - reference of current pointer of EIR 3813** max_num_uuid16 - max number of UUID can be written in EIR 3814** num_uuid16 - number of UUID have been written in EIR 3815** 3816** Returns BTM_EIR_MORE_16BITS_UUID_TYPE, if it has more than max 3817** BTM_EIR_COMPLETE_16BITS_UUID_TYPE, otherwise 3818** 3819*******************************************************************************/ 3820extern UINT8 BTM_GetEirSupportedServices( UINT32 *p_eir_uuid, UINT8 **p, 3821 UINT8 max_num_uuid16, UINT8 *p_num_uuid16); 3822 3823/******************************************************************************* 3824** 3825** Function BTM_GetEirUuidList 3826** 3827** Description This function parses EIR and returns UUID list. 3828** 3829** Parameters p_eir - EIR 3830** uuid_size - LEN_UUID_16, LEN_UUID_32, LEN_UUID_128 3831** p_num_uuid - return number of UUID in found list 3832** p_uuid_list - return UUID 16-bit list 3833** max_num_uuid - maximum number of UUID to be returned 3834** 3835** Returns 0 - if not found 3836** BTM_EIR_COMPLETE_16BITS_UUID_TYPE 3837** BTM_EIR_MORE_16BITS_UUID_TYPE 3838** BTM_EIR_COMPLETE_32BITS_UUID_TYPE 3839** BTM_EIR_MORE_32BITS_UUID_TYPE 3840** BTM_EIR_COMPLETE_128BITS_UUID_TYPE 3841** BTM_EIR_MORE_128BITS_UUID_TYPE 3842** 3843*******************************************************************************/ 3844extern UINT8 BTM_GetEirUuidList( UINT8 *p_eir, UINT8 uuid_size, UINT8 *p_num_uuid, 3845 UINT8 *p_uuid_list, UINT8 max_num_uuid); 3846 3847/***************************************************************************** 3848** SCO OVER HCI 3849*****************************************************************************/ 3850/******************************************************************************* 3851** 3852** Function BTM_ConfigScoPath 3853** 3854** Description This function enable/disable SCO over HCI and registers SCO 3855** data callback if SCO over HCI is enabled. 3856** 3857** Parameter path: SCO or HCI 3858** p_sco_data_cb: callback function or SCO data if path is set 3859** to transport. 3860** p_pcm_param: pointer to the PCM interface parameter. If a NULL 3861** pointer is used, PCM parameter maintained in 3862** the control block will be used; otherwise update 3863** control block value. 3864** err_data_rpt: Lisbon feature to enable the erronous data report 3865** or not. 3866** 3867** Returns BTM_SUCCESS if the successful. 3868** BTM_NO_RESOURCES: no rsource to start the command. 3869** BTM_ILLEGAL_VALUE: invalid callback function pointer. 3870** BTM_CMD_STARTED :Command sent. Waiting for command cmpl event. 3871** 3872** 3873*******************************************************************************/ 3874extern tBTM_STATUS BTM_ConfigScoPath (tBTM_SCO_ROUTE_TYPE path, 3875 tBTM_SCO_DATA_CB *p_sco_data_cb, 3876 tBTM_SCO_PCM_PARAM *p_pcm_param, 3877 BOOLEAN err_data_rpt); 3878 3879/******************************************************************************* 3880** 3881** Function BTM_WriteScoData 3882** 3883** Description This function write SCO data to a specified instance. The data 3884** to be written p_buf needs to carry an offset of 3885** HCI_SCO_PREAMBLE_SIZE bytes, and the data length can not 3886** exceed BTM_SCO_DATA_SIZE_MAX bytes, whose default value is set 3887** to 60 and is configurable. Data longer than the maximum bytes 3888** will be truncated. 3889** 3890** Returns BTM_SUCCESS: data write is successful 3891** BTM_ILLEGAL_VALUE: SCO data contains illegal offset value. 3892** BTM_SCO_BAD_LENGTH: SCO data length exceeds the max SCO packet 3893** size. 3894** BTM_NO_RESOURCES: no resources. 3895** BTM_UNKNOWN_ADDR: unknown SCO connection handle, or SCO is not 3896** routed via HCI. 3897** 3898** 3899*******************************************************************************/ 3900extern tBTM_STATUS BTM_WriteScoData (UINT16 sco_inx, BT_HDR *p_buf); 3901 3902/******************************************************************************* 3903** 3904** Function BTM_SetARCMode 3905** 3906** Description Send Audio Routing Control command. 3907** 3908** Returns void 3909** 3910*******************************************************************************/ 3911extern void BTM_SetARCMode (UINT8 iface, UINT8 arc_mode, tBTM_VSC_CMPL_CB *p_arc_cb); 3912 3913 3914/******************************************************************************* 3915** 3916** Function BTM_PCM2Setup_Write 3917** 3918** Description Send PCM2_Setup write command. 3919** 3920** Returns void 3921** 3922*******************************************************************************/ 3923extern void BTM_PCM2Setup_Write (BOOLEAN clk_master, tBTM_VSC_CMPL_CB *p_arc_cb); 3924 3925 3926/******************************************************************************* 3927** 3928** Function BTM_PM_ReadControllerState 3929** 3930** Description This function is called to obtain the controller state 3931** 3932** Returns Controller state (BTM_CONTRL_ACTIVE, BTM_CONTRL_SCAN, and BTM_CONTRL_IDLE) 3933** 3934*******************************************************************************/ 3935extern tBTM_CONTRL_STATE BTM_PM_ReadControllerState(void); 3936 3937#ifdef __cplusplus 3938} 3939#endif 3940 3941#endif /* BTM_API_H */ 3942