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