1 /* 2 * Copyright (C) 2012 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef ANDROID_INCLUDE_BLUETOOTH_H 18 #define ANDROID_INCLUDE_BLUETOOTH_H 19 20 #include <stdbool.h> 21 #include <stdint.h> 22 #include <sys/cdefs.h> 23 #include <sys/types.h> 24 25 #include <bluetooth/uuid.h> 26 #include <raw_address.h> 27 28 __BEGIN_DECLS 29 30 #define BLUETOOTH_INTERFACE_STRING "bluetoothInterface" 31 32 /** Bluetooth profile interface IDs */ 33 34 #define BT_PROFILE_HANDSFREE_ID "handsfree" 35 #define BT_PROFILE_HANDSFREE_CLIENT_ID "handsfree_client" 36 #define BT_PROFILE_ADVANCED_AUDIO_ID "a2dp" 37 #define BT_PROFILE_ADVANCED_AUDIO_SINK_ID "a2dp_sink" 38 #define BT_PROFILE_HEALTH_ID "health" 39 #define BT_PROFILE_SOCKETS_ID "socket" 40 #define BT_PROFILE_HIDHOST_ID "hidhost" 41 #define BT_PROFILE_HIDDEV_ID "hiddev" 42 #define BT_PROFILE_PAN_ID "pan" 43 #define BT_PROFILE_MAP_CLIENT_ID "map_client" 44 #define BT_PROFILE_SDP_CLIENT_ID "sdp" 45 #define BT_PROFILE_GATT_ID "gatt" 46 #define BT_PROFILE_AV_RC_ID "avrcp" 47 #define BT_PROFILE_AV_RC_CTRL_ID "avrcp_ctrl" 48 49 /** Bluetooth test interface IDs */ 50 #define BT_TEST_INTERFACE_MCAP_ID "mcap_test" 51 52 /** Bluetooth Device Name */ 53 typedef struct { 54 uint8_t name[249]; 55 } __attribute__((packed))bt_bdname_t; 56 57 /** Bluetooth Adapter Visibility Modes*/ 58 typedef enum { 59 BT_SCAN_MODE_NONE, 60 BT_SCAN_MODE_CONNECTABLE, 61 BT_SCAN_MODE_CONNECTABLE_DISCOVERABLE 62 } bt_scan_mode_t; 63 64 /** Bluetooth Adapter State */ 65 typedef enum { 66 BT_STATE_OFF, 67 BT_STATE_ON 68 } bt_state_t; 69 70 /** Bluetooth Error Status */ 71 /** We need to build on this */ 72 73 typedef enum { 74 BT_STATUS_SUCCESS, 75 BT_STATUS_FAIL, 76 BT_STATUS_NOT_READY, 77 BT_STATUS_NOMEM, 78 BT_STATUS_BUSY, 79 BT_STATUS_DONE, /* request already completed */ 80 BT_STATUS_UNSUPPORTED, 81 BT_STATUS_PARM_INVALID, 82 BT_STATUS_UNHANDLED, 83 BT_STATUS_AUTH_FAILURE, 84 BT_STATUS_RMT_DEV_DOWN, 85 BT_STATUS_AUTH_REJECTED, 86 BT_STATUS_JNI_ENVIRONMENT_ERROR, 87 BT_STATUS_JNI_THREAD_ATTACH_ERROR, 88 BT_STATUS_WAKELOCK_ERROR 89 } bt_status_t; 90 91 /** Bluetooth PinKey Code */ 92 typedef struct { 93 uint8_t pin[16]; 94 } __attribute__((packed))bt_pin_code_t; 95 96 typedef struct { 97 uint8_t status; 98 uint8_t ctrl_state; /* stack reported state */ 99 uint64_t tx_time; /* in ms */ 100 uint64_t rx_time; /* in ms */ 101 uint64_t idle_time; /* in ms */ 102 uint64_t energy_used; /* a product of mA, V and ms */ 103 } __attribute__((packed))bt_activity_energy_info; 104 105 typedef struct { 106 int32_t app_uid; 107 uint64_t tx_bytes; 108 uint64_t rx_bytes; 109 } __attribute__((packed))bt_uid_traffic_t; 110 111 /** Bluetooth Adapter Discovery state */ 112 typedef enum { 113 BT_DISCOVERY_STOPPED, 114 BT_DISCOVERY_STARTED 115 } bt_discovery_state_t; 116 117 /** Bluetooth ACL connection state */ 118 typedef enum { 119 BT_ACL_STATE_CONNECTED, 120 BT_ACL_STATE_DISCONNECTED 121 } bt_acl_state_t; 122 123 /** Bluetooth SDP service record */ 124 typedef struct 125 { 126 bluetooth::Uuid uuid; 127 uint16_t channel; 128 char name[256]; // what's the maximum length 129 } bt_service_record_t; 130 131 132 /** Bluetooth Remote Version info */ 133 typedef struct 134 { 135 int version; 136 int sub_ver; 137 int manufacturer; 138 } bt_remote_version_t; 139 140 typedef struct 141 { 142 uint16_t version_supported; 143 uint8_t local_privacy_enabled; 144 uint8_t max_adv_instance; 145 uint8_t rpa_offload_supported; 146 uint8_t max_irk_list_size; 147 uint8_t max_adv_filter_supported; 148 uint8_t activity_energy_info_supported; 149 uint16_t scan_result_storage_size; 150 uint16_t total_trackable_advertisers; 151 bool extended_scan_support; 152 bool debug_logging_supported; 153 bool le_2m_phy_supported; 154 bool le_coded_phy_supported; 155 bool le_extended_advertising_supported; 156 bool le_periodic_advertising_supported; 157 uint16_t le_maximum_advertising_data_length; 158 }bt_local_le_features_t; 159 160 /* Bluetooth Adapter and Remote Device property types */ 161 typedef enum { 162 /* Properties common to both adapter and remote device */ 163 /** 164 * Description - Bluetooth Device Name 165 * Access mode - Adapter name can be GET/SET. Remote device can be GET 166 * Data type - bt_bdname_t 167 */ 168 BT_PROPERTY_BDNAME = 0x1, 169 /** 170 * Description - Bluetooth Device Address 171 * Access mode - Only GET. 172 * Data type - RawAddress 173 */ 174 BT_PROPERTY_BDADDR, 175 /** 176 * Description - Bluetooth Service 128-bit UUIDs 177 * Access mode - Only GET. 178 * Data type - Array of bluetooth::Uuid (Array size inferred from property 179 * length). 180 */ 181 BT_PROPERTY_UUIDS, 182 /** 183 * Description - Bluetooth Class of Device as found in Assigned Numbers 184 * Access mode - Only GET. 185 * Data type - uint32_t. 186 */ 187 BT_PROPERTY_CLASS_OF_DEVICE, 188 /** 189 * Description - Device Type - BREDR, BLE or DUAL Mode 190 * Access mode - Only GET. 191 * Data type - bt_device_type_t 192 */ 193 BT_PROPERTY_TYPE_OF_DEVICE, 194 /** 195 * Description - Bluetooth Service Record 196 * Access mode - Only GET. 197 * Data type - bt_service_record_t 198 */ 199 BT_PROPERTY_SERVICE_RECORD, 200 201 /* Properties unique to adapter */ 202 /** 203 * Description - Bluetooth Adapter scan mode 204 * Access mode - GET and SET 205 * Data type - bt_scan_mode_t. 206 */ 207 BT_PROPERTY_ADAPTER_SCAN_MODE, 208 /** 209 * Description - List of bonded devices 210 * Access mode - Only GET. 211 * Data type - Array of RawAddress of the bonded remote devices 212 * (Array size inferred from property length). 213 */ 214 BT_PROPERTY_ADAPTER_BONDED_DEVICES, 215 /** 216 * Description - Bluetooth Adapter Discovery timeout (in seconds) 217 * Access mode - GET and SET 218 * Data type - uint32_t 219 */ 220 BT_PROPERTY_ADAPTER_DISCOVERY_TIMEOUT, 221 222 /* Properties unique to remote device */ 223 /** 224 * Description - User defined friendly name of the remote device 225 * Access mode - GET and SET 226 * Data type - bt_bdname_t. 227 */ 228 BT_PROPERTY_REMOTE_FRIENDLY_NAME, 229 /** 230 * Description - RSSI value of the inquired remote device 231 * Access mode - Only GET. 232 * Data type - int32_t. 233 */ 234 BT_PROPERTY_REMOTE_RSSI, 235 /** 236 * Description - Remote version info 237 * Access mode - SET/GET. 238 * Data type - bt_remote_version_t. 239 */ 240 241 BT_PROPERTY_REMOTE_VERSION_INFO, 242 243 /** 244 * Description - Local LE features 245 * Access mode - GET. 246 * Data type - bt_local_le_features_t. 247 */ 248 BT_PROPERTY_LOCAL_LE_FEATURES, 249 250 BT_PROPERTY_REMOTE_DEVICE_TIMESTAMP = 0xFF, 251 } bt_property_type_t; 252 253 /** Bluetooth Adapter Property data structure */ 254 typedef struct 255 { 256 bt_property_type_t type; 257 int len; 258 void *val; 259 } bt_property_t; 260 261 /** Represents the actual Out of Band data itself */ 262 typedef struct { 263 // Both 264 bool is_valid = false; /* Default to invalid data; force caller to verify */ 265 uint8_t address[7]; /* Bluetooth Device Address (6) plus Address Type (1) */ 266 uint8_t c[16]; /* Simple Pairing Hash C-192/256 (Classic or LE) */ 267 uint8_t r[16]; /* Simple Pairing Randomizer R-192/256 (Classic or LE) */ 268 uint8_t device_name[256]; /* Name of the device */ 269 270 // Classic 271 uint8_t oob_data_length[2]; /* Classic only data Length. Value includes this 272 in length */ 273 uint8_t class_of_device[2]; /* Class of Device (Classic or LE) */ 274 275 // LE 276 uint8_t le_device_role; /* Supported and preferred role of device */ 277 uint8_t sm_tk[16]; /* Security Manager TK Value (LE Only) */ 278 uint8_t le_flags; /* LE Flags for discoverability and features */ 279 uint8_t le_appearance[2]; /* For the appearance of the device */ 280 } bt_oob_data_t; 281 282 283 /** Bluetooth Device Type */ 284 typedef enum { 285 BT_DEVICE_DEVTYPE_BREDR = 0x1, 286 BT_DEVICE_DEVTYPE_BLE, 287 BT_DEVICE_DEVTYPE_DUAL 288 } bt_device_type_t; 289 /** Bluetooth Bond state */ 290 typedef enum { 291 BT_BOND_STATE_NONE, 292 BT_BOND_STATE_BONDING, 293 BT_BOND_STATE_BONDED 294 } bt_bond_state_t; 295 296 /** Bluetooth SSP Bonding Variant */ 297 typedef enum { 298 BT_SSP_VARIANT_PASSKEY_CONFIRMATION, 299 BT_SSP_VARIANT_PASSKEY_ENTRY, 300 BT_SSP_VARIANT_CONSENT, 301 BT_SSP_VARIANT_PASSKEY_NOTIFICATION 302 } bt_ssp_variant_t; 303 304 #define BT_MAX_NUM_UUIDS 32 305 306 /** Bluetooth Interface callbacks */ 307 308 /** Bluetooth Enable/Disable Callback. */ 309 typedef void (*adapter_state_changed_callback)(bt_state_t state); 310 311 /** GET/SET Adapter Properties callback */ 312 /* TODO: For the GET/SET property APIs/callbacks, we may need a session 313 * identifier to associate the call with the callback. This would be needed 314 * whenever more than one simultaneous instance of the same adapter_type 315 * is get/set. 316 * 317 * If this is going to be handled in the Java framework, then we do not need 318 * to manage sessions here. 319 */ 320 typedef void (*adapter_properties_callback)(bt_status_t status, 321 int num_properties, 322 bt_property_t *properties); 323 324 /** GET/SET Remote Device Properties callback */ 325 /** TODO: For remote device properties, do not see a need to get/set 326 * multiple properties - num_properties shall be 1 327 */ 328 typedef void (*remote_device_properties_callback)(bt_status_t status, 329 RawAddress *bd_addr, 330 int num_properties, 331 bt_property_t *properties); 332 333 /** New device discovered callback */ 334 /** If EIR data is not present, then BD_NAME and RSSI shall be NULL and -1 335 * respectively */ 336 typedef void (*device_found_callback)(int num_properties, 337 bt_property_t *properties); 338 339 /** Discovery state changed callback */ 340 typedef void (*discovery_state_changed_callback)(bt_discovery_state_t state); 341 342 /** Bluetooth Legacy PinKey Request callback */ 343 typedef void (*pin_request_callback)(RawAddress *remote_bd_addr, 344 bt_bdname_t *bd_name, uint32_t cod, bool min_16_digit); 345 346 /** Bluetooth SSP Request callback - Just Works & Numeric Comparison*/ 347 /** pass_key - Shall be 0 for BT_SSP_PAIRING_VARIANT_CONSENT & 348 * BT_SSP_PAIRING_PASSKEY_ENTRY */ 349 /* TODO: Passkey request callback shall not be needed for devices with display 350 * capability. We still need support this in the stack for completeness */ 351 typedef void (*ssp_request_callback)(RawAddress *remote_bd_addr, 352 bt_bdname_t *bd_name, 353 uint32_t cod, 354 bt_ssp_variant_t pairing_variant, 355 uint32_t pass_key); 356 357 /** Bluetooth Bond state changed callback */ 358 /* Invoked in response to create_bond, cancel_bond or remove_bond */ 359 typedef void (*bond_state_changed_callback)(bt_status_t status, 360 RawAddress *remote_bd_addr, 361 bt_bond_state_t state); 362 363 /** Bluetooth ACL connection state changed callback */ 364 typedef void (*acl_state_changed_callback)(bt_status_t status, RawAddress *remote_bd_addr, 365 bt_acl_state_t state); 366 367 typedef enum { 368 ASSOCIATE_JVM, 369 DISASSOCIATE_JVM 370 } bt_cb_thread_evt; 371 372 /** Thread Associate/Disassociate JVM Callback */ 373 /* Callback that is invoked by the callback thread to allow upper layer to attach/detach to/from 374 * the JVM */ 375 typedef void (*callback_thread_event)(bt_cb_thread_evt evt); 376 377 /** Bluetooth Test Mode Callback */ 378 /* Receive any HCI event from controller. Must be in DUT Mode for this callback to be received */ 379 typedef void (*dut_mode_recv_callback)(uint16_t opcode, uint8_t *buf, uint8_t len); 380 381 /* LE Test mode callbacks 382 * This callback shall be invoked whenever the le_tx_test, le_rx_test or le_test_end is invoked 383 * The num_packets is valid only for le_test_end command */ 384 typedef void (*le_test_mode_callback)(bt_status_t status, uint16_t num_packets); 385 386 /** Callback invoked when energy details are obtained */ 387 /* Ctrl_state-Current controller state-Active-1,scan-2,or idle-3 state as defined by HCI spec. 388 * If the ctrl_state value is 0, it means the API call failed 389 * Time values-In milliseconds as returned by the controller 390 * Energy used-Value as returned by the controller 391 * Status-Provides the status of the read_energy_info API call 392 * uid_data provides an array of bt_uid_traffic_t, where the array is terminated by an element with 393 * app_uid set to -1. 394 */ 395 typedef void (*energy_info_callback)(bt_activity_energy_info *energy_info, 396 bt_uid_traffic_t *uid_data); 397 398 /** TODO: Add callbacks for Link Up/Down and other generic 399 * notifications/callbacks */ 400 401 /** Bluetooth DM callback structure. */ 402 typedef struct { 403 /** set to sizeof(bt_callbacks_t) */ 404 size_t size; 405 adapter_state_changed_callback adapter_state_changed_cb; 406 adapter_properties_callback adapter_properties_cb; 407 remote_device_properties_callback remote_device_properties_cb; 408 device_found_callback device_found_cb; 409 discovery_state_changed_callback discovery_state_changed_cb; 410 pin_request_callback pin_request_cb; 411 ssp_request_callback ssp_request_cb; 412 bond_state_changed_callback bond_state_changed_cb; 413 acl_state_changed_callback acl_state_changed_cb; 414 callback_thread_event thread_evt_cb; 415 dut_mode_recv_callback dut_mode_recv_cb; 416 le_test_mode_callback le_test_mode_cb; 417 energy_info_callback energy_info_cb; 418 } bt_callbacks_t; 419 420 typedef void (*alarm_cb)(void *data); 421 typedef bool (*set_wake_alarm_callout)(uint64_t delay_millis, bool should_wake, alarm_cb cb, void *data); 422 typedef int (*acquire_wake_lock_callout)(const char *lock_name); 423 typedef int (*release_wake_lock_callout)(const char *lock_name); 424 425 /** The set of functions required by bluedroid to set wake alarms and 426 * grab wake locks. This struct is passed into the stack through the 427 * |set_os_callouts| function on |bt_interface_t|. 428 */ 429 typedef struct { 430 /* set to sizeof(bt_os_callouts_t) */ 431 size_t size; 432 433 set_wake_alarm_callout set_wake_alarm; 434 acquire_wake_lock_callout acquire_wake_lock; 435 release_wake_lock_callout release_wake_lock; 436 } bt_os_callouts_t; 437 438 /** NOTE: By default, no profiles are initialized at the time of init/enable. 439 * Whenever the application invokes the 'init' API of a profile, then one of 440 * the following shall occur: 441 * 442 * 1.) If Bluetooth is not enabled, then the Bluetooth core shall mark the 443 * profile as enabled. Subsequently, when the application invokes the 444 * Bluetooth 'enable', as part of the enable sequence the profile that were 445 * marked shall be enabled by calling appropriate stack APIs. The 446 * 'adapter_properties_cb' shall return the list of UUIDs of the 447 * enabled profiles. 448 * 449 * 2.) If Bluetooth is enabled, then the Bluetooth core shall invoke the stack 450 * profile API to initialize the profile and trigger a 451 * 'adapter_properties_cb' with the current list of UUIDs including the 452 * newly added profile's UUID. 453 * 454 * The reverse shall occur whenever the profile 'cleanup' APIs are invoked 455 */ 456 457 /** Represents the standard Bluetooth DM interface. */ 458 typedef struct { 459 /** set to sizeof(bt_interface_t) */ 460 size_t size; 461 /** 462 * Opens the interface and provides the callback routines 463 * to the implemenation of this interface. 464 * The |is_atv| flag indicates whether the local device is an Android TV 465 */ 466 int (*init)(bt_callbacks_t* callbacks, bool is_atv); 467 468 /** Enable Bluetooth. */ 469 int (*enable)(bool guest_mode); 470 471 /** Disable Bluetooth. */ 472 int (*disable)(void); 473 474 /** Closes the interface. */ 475 void (*cleanup)(void); 476 477 /** Get all Bluetooth Adapter properties at init */ 478 int (*get_adapter_properties)(void); 479 480 /** Get Bluetooth Adapter property of 'type' */ 481 int (*get_adapter_property)(bt_property_type_t type); 482 483 /** Set Bluetooth Adapter property of 'type' */ 484 /* Based on the type, val shall be one of 485 * RawAddress or bt_bdname_t or bt_scanmode_t etc 486 */ 487 int (*set_adapter_property)(const bt_property_t *property); 488 489 /** Get all Remote Device properties */ 490 int (*get_remote_device_properties)(RawAddress *remote_addr); 491 492 /** Get Remote Device property of 'type' */ 493 int (*get_remote_device_property)(RawAddress *remote_addr, 494 bt_property_type_t type); 495 496 /** Set Remote Device property of 'type' */ 497 int (*set_remote_device_property)(RawAddress *remote_addr, 498 const bt_property_t *property); 499 500 /** Get Remote Device's service record for the given UUID */ 501 int (*get_remote_service_record)(const RawAddress& remote_addr, 502 const bluetooth::Uuid& uuid); 503 504 /** Start SDP to get remote services */ 505 int (*get_remote_services)(RawAddress *remote_addr); 506 507 /** Start Discovery */ 508 int (*start_discovery)(void); 509 510 /** Cancel Discovery */ 511 int (*cancel_discovery)(void); 512 513 /** Create Bluetooth Bonding */ 514 int (*create_bond)(const RawAddress *bd_addr, int transport); 515 516 /** Create Bluetooth Bond using out of band data */ 517 int (*create_bond_out_of_band)(const RawAddress *bd_addr, int transport, 518 const bt_oob_data_t *p192_data, 519 const bt_oob_data_t *p256_data); 520 521 /** Remove Bond */ 522 int (*remove_bond)(const RawAddress *bd_addr); 523 524 /** Cancel Bond */ 525 int (*cancel_bond)(const RawAddress *bd_addr); 526 527 /** 528 * Get the connection status for a given remote device. 529 * return value of 0 means the device is not connected, 530 * non-zero return status indicates an active connection. 531 */ 532 int (*get_connection_state)(const RawAddress *bd_addr); 533 534 /** BT Legacy PinKey Reply */ 535 /** If accept==FALSE, then pin_len and pin_code shall be 0x0 */ 536 int (*pin_reply)(const RawAddress *bd_addr, uint8_t accept, 537 uint8_t pin_len, bt_pin_code_t *pin_code); 538 539 /** BT SSP Reply - Just Works, Numeric Comparison and Passkey 540 * passkey shall be zero for BT_SSP_VARIANT_PASSKEY_COMPARISON & 541 * BT_SSP_VARIANT_CONSENT 542 * For BT_SSP_VARIANT_PASSKEY_ENTRY, if accept==FALSE, then passkey 543 * shall be zero */ 544 int (*ssp_reply)(const RawAddress *bd_addr, bt_ssp_variant_t variant, 545 uint8_t accept, uint32_t passkey); 546 547 /** Get Bluetooth profile interface */ 548 const void* (*get_profile_interface) (const char *profile_id); 549 550 /** Bluetooth Test Mode APIs - Bluetooth must be enabled for these APIs */ 551 /* Configure DUT Mode - Use this mode to enter/exit DUT mode */ 552 int (*dut_mode_configure)(uint8_t enable); 553 554 /* Send any test HCI (vendor-specific) command to the controller. Must be in DUT Mode */ 555 int (*dut_mode_send)(uint16_t opcode, uint8_t *buf, uint8_t len); 556 /** BLE Test Mode APIs */ 557 /* opcode MUST be one of: LE_Receiver_Test, LE_Transmitter_Test, LE_Test_End */ 558 int (*le_test_mode)(uint16_t opcode, uint8_t *buf, uint8_t len); 559 560 /** Sets the OS call-out functions that bluedroid needs for alarms and wake locks. 561 * This should be called immediately after a successful |init|. 562 */ 563 int (*set_os_callouts)(bt_os_callouts_t *callouts); 564 565 /** Read Energy info details - return value indicates BT_STATUS_SUCCESS or BT_STATUS_NOT_READY 566 * Success indicates that the VSC command was sent to controller 567 */ 568 int (*read_energy_info)(); 569 570 /** 571 * Native support for dumpsys function 572 * Function is synchronous and |fd| is owned by caller. 573 * |arguments| are arguments which may affect the output, encoded as 574 * UTF-8 strings. 575 */ 576 void (*dump)(int fd, const char **arguments); 577 578 /** 579 * Clear /data/misc/bt_config.conf and erase all stored connections 580 */ 581 int (*config_clear)(void); 582 583 /** 584 * Clear (reset) the dynamic portion of the device interoperability database. 585 */ 586 void (*interop_database_clear)(void); 587 588 /** 589 * Add a new device interoperability workaround for a remote device whose 590 * first |len| bytes of the its device address match |addr|. 591 * NOTE: |feature| has to match an item defined in interop_feature_t (interop.h). 592 */ 593 void (*interop_database_add)(uint16_t feature, const RawAddress *addr, size_t len); 594 } bt_interface_t; 595 596 __END_DECLS 597 598 #endif /* ANDROID_INCLUDE_BLUETOOTH_H */ 599