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