2 * Copyright (C) 2012 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef ANDROID_INCLUDE_BLUETOOTH_H
18 #define ANDROID_INCLUDE_BLUETOOTH_H
22 #include <sys/cdefs.h>
23 #include <sys/types.h>
25 #include <hardware/hardware.h>
30 * The Bluetooth Hardware Module ID
33 #define BT_HARDWARE_MODULE_ID "bluetooth"
34 #define BT_STACK_MODULE_ID "bluetooth"
35 #define BT_STACK_TEST_MODULE_ID "bluetooth_test"
38 /* Bluetooth profile interface IDs */
40 #define BT_PROFILE_HANDSFREE_ID "handsfree"
41 #define BT_PROFILE_HANDSFREE_CLIENT_ID "handsfree_client"
42 #define BT_PROFILE_ADVANCED_AUDIO_ID "a2dp"
43 #define BT_PROFILE_ADVANCED_AUDIO_SINK_ID "a2dp_sink"
44 #define BT_PROFILE_HEALTH_ID "health"
45 #define BT_PROFILE_SOCKETS_ID "socket"
46 #define BT_PROFILE_HIDHOST_ID "hidhost"
47 #define BT_PROFILE_HIDDEVICE_ID "hiddevice"
48 #define BT_PROFILE_PAN_ID "pan"
49 #define BT_PROFILE_MAP_CLIENT_ID "map_client"
51 #define BT_PROFILE_GATT_ID "gatt"
52 #define BT_PROFILE_AV_RC_ID "avrcp"
53 #define BT_PROFILE_AV_RC_CTRL_ID "avrcp_ctrl"
54 #define BT_MANUFACTURER_DATA_LENGTH_MAX 31 /**< This specifies the Maximum manufacturer data Length>*/
56 /** Bluetooth Address */
59 } __attribute__((packed))bt_bdaddr_t;
61 /** Bluetooth Device Name */
64 } __attribute__((packed))bt_bdname_t;
66 /** Bluetooth Adapter Visibility Modes*/
69 BT_SCAN_MODE_CONNECTABLE,
70 BT_SCAN_MODE_CONNECTABLE_DISCOVERABLE
73 /** Bluetooth Adapter State */
79 /** Bluetooth Error Status */
80 /** We need to build on this */
88 BT_STATUS_DONE, /* request already completed */
89 BT_STATUS_UNSUPPORTED,
90 BT_STATUS_PARM_INVALID,
92 BT_STATUS_AUTH_FAILURE,
93 BT_STATUS_RMT_DEV_DOWN,
95 BT_STATUS_CONN_TOUT /* disconnection due to supervision timeout */
97 BT_STATUS_CONN_TOUT, /* disconnection due to supervision timeout */
98 BT_STATUS_AUTH_REJECTED,
99 BT_STATUS_CONN_TERM_LOCAL_HOST,
100 BT_STATUS_CONN_TERM_RMT_HOST
105 BT_SCAN_FILTER_FEATURE_DEVICE_ADDRESS = 0x01, /**< device address */
106 BT_SCAN_FILTER_FEATURE_SERVICE_DATA_CHANGED = 0x02, /**< service data changed */
107 BT_SCAN_FILTER_FEATURE_SERVICE_UUID = 0x04, /**< service uuid */
108 BT_SCAN_FILTER_FEATURE_SERVICE_SOLICITATION_UUID = 0x08, /**< service solicitation uuid */
109 BT_SCAN_FILTER_FEATURE_DEVICE_NAME = 0x10, /**< device name */
110 BT_SCAN_FILTER_FEATURE_MANUFACTURER_DATA = 0x20, /**< manufacturer data */
111 BT_SCAN_FILTER_FEATURE_SERVICE_DATA = 0x40, /**< service data */
112 } bt_scan_filter_feature_t;
115 /** Bluetooth PinKey Code */
118 } __attribute__((packed))bt_pin_code_t;
121 int data_len; /**< manafacturer specific data length */
122 char data[BT_MANUFACTURER_DATA_LENGTH_MAX];
123 } bt_manufacturer_data_t;
127 uint8_t ctrl_state; /* stack reported state */
128 uint64_t tx_time; /* in ms */
129 uint64_t rx_time; /* in ms */
130 uint64_t idle_time; /* in ms */
131 uint64_t energy_used; /* a product of mA, V and ms */
132 } __attribute__((packed))bt_activity_energy_info;
134 /** Bluetooth Adapter Discovery state */
136 BT_DISCOVERY_STOPPED,
138 } bt_discovery_state_t;
140 /** Bluetooth ACL connection state */
142 BT_ACL_STATE_CONNECTED,
143 BT_ACL_STATE_DISCONNECTED
146 /** Remote Device Trusted state */
149 BT_DEVICE_NOT_TRUSTED
150 } bt_device_trust_state_t;
152 /** Bluetooth 128-bit UUID */
157 /** Bluetooth SDP service record */
161 char name[256]; // what's the maximum length
162 } bt_service_record_t;
165 /** Bluetooth Remote Version info */
170 } bt_remote_version_t;
174 uint16_t version_supported;
175 uint8_t local_privacy_enabled;
176 uint8_t max_adv_instance;
177 uint8_t rpa_offload_supported;
178 uint8_t max_irk_list_size;
179 uint8_t max_adv_filter_supported;
180 uint8_t activity_energy_info_supported;
181 uint16_t scan_result_storage_size;
182 uint16_t total_trackable_advertisers;
183 bool extended_scan_support;
184 bool debug_logging_supported;
185 bool le_2m_phy_supported;
186 bool le_coded_phy_supported;
187 bool le_extended_advertising_supported;
188 bool le_periodic_advertising_supported;
189 uint16_t le_maximum_advertising_data_length;
190 } bt_local_le_features_t;
194 uint8_t local_privacy_enabled;
195 uint8_t max_adv_instance;
196 uint8_t rpa_offload_supported;
197 uint8_t max_irk_list_size;
198 uint8_t max_adv_filter_supported;
199 uint8_t scan_result_storage_size_lobyte;
200 uint8_t scan_result_storage_size_hibyte;
201 uint8_t activity_energy_info_supported;
202 } bt_local_le_features_t;*/
204 /* Bluetooth Adapter and Remote Device property types */
206 /* Properties common to both adapter and remote device */
208 * Description - Bluetooth Device Name
209 * Access mode - Adapter name can be GET/SET. Remote device can be GET
210 * Data type - bt_bdname_t
212 BT_PROPERTY_BDNAME = 0x1,
214 * Description - Bluetooth Device Address
215 * Access mode - Only GET.
216 * Data type - bt_bdaddr_t
220 * Description - Bluetooth Service 128-bit UUIDs
221 * Access mode - Only GET.
222 * Data type - Array of bt_uuid_t (Array size inferred from property length).
226 * Description - Bluetooth Class of Device as found in Assigned Numbers
227 * Access mode - Only GET.
228 * Data type - uint32_t.
230 BT_PROPERTY_CLASS_OF_DEVICE,
232 * Description - Device Type - BREDR, BLE or DUAL Mode
233 * Access mode - Only GET.
234 * Data type - bt_device_type_t
236 BT_PROPERTY_TYPE_OF_DEVICE,
238 * Description - Bluetooth Service Record
239 * Access mode - Only GET.
240 * Data type - bt_service_record_t
242 BT_PROPERTY_SERVICE_RECORD,
244 /* Properties unique to adapter */
246 * Description - Bluetooth Adapter scan mode
247 * Access mode - GET and SET
248 * Data type - bt_scan_mode_t.
250 BT_PROPERTY_ADAPTER_SCAN_MODE,
252 * Description - List of bonded devices
253 * Access mode - Only GET.
254 * Data type - Array of bt_bdaddr_t of the bonded remote devices
255 * (Array size inferred from property length).
257 BT_PROPERTY_ADAPTER_BONDED_DEVICES,
259 * Description - Bluetooth Adapter Discovery timeout (in seconds)
260 * Access mode - GET and SET
261 * Data type - uint32_t
263 BT_PROPERTY_ADAPTER_DISCOVERY_TIMEOUT,
265 /* Properties unique to remote device */
267 * Description - User defined friendly name of the remote device
268 * Access mode - GET and SET
269 * Data type - bt_bdname_t.
271 BT_PROPERTY_REMOTE_FRIENDLY_NAME,
273 * Description - RSSI value of the inquired remote device
274 * Access mode - Only GET.
275 * Data type - int32_t.
277 BT_PROPERTY_REMOTE_RSSI,
279 * Description - Remote version info
280 * Access mode - SET/GET.
281 * Data type - bt_remote_version_t.
284 BT_PROPERTY_REMOTE_VERSION_INFO,
286 /* Tizen Specific Adapter and Remote Device properties */
288 * Description - Remote Device paired Info
290 * Data type - uint8_t.
292 BT_PROPERTY_REMOTE_PAIRED,
295 * Description - Remote Device connected Info
297 * Data type - unsigned int.
299 BT_PROPERTY_REMOTE_CONNECTED,
302 * Description - Remote Device Trusted info
304 * Data type - uint8_t.
306 BT_PROPERTY_REMOTE_TRUST,
309 * Description - Adapter Pairable info
310 * Access mode - GET\SET.
311 * Data type - uint8_t
313 BT_PROPERTY_PAIRABLE,
316 * Description - Adapter pairable Timeout value
318 * Data type - uint32_t
320 BT_PROPERTY_PAIRABLE_TIMEOUT,
323 * Description - Adapter version
325 * Data type - Array of character string
330 * Description - Adapter IPSP initialized state info
332 * Data type - uint8_t
334 BT_PROPERTY_IPSP_INITIALIZED,
337 * Description - Adapter Modalias info
339 * Data type - Array of character string
341 BT_PROPERTY_MODALIAS,
344 * Description - BLE Device manufacturer data length
346 * Data type - uint32_t
348 BT_PROPERTY_REMOTE_DEVICE_MANUFACTURER_DATA_LEN,
351 * Description - BLE Device manufacturer data
353 * Data type - Array of character string
355 BT_PROPERTY_REMOTE_DEVICE_MANUFACTURER_DATA,
358 * Description - Remote BLE advertising data
359 * Access mode - Only received during device found callback.
360 * Data type - Array of uint8_t of remote BLE adv data.
361 * (Array size inferred from property length).
363 BT_PROPERTY_REMOTE_BLE_ADV_DATA,
366 * Description - Local LE features
368 * Data type - bt_local_le_features_t.
370 BT_PROPERTY_LOCAL_LE_FEATURES,
373 * Description - Remote device friendly name set?
375 * Data type - uint8_t
377 BT_PROPERTY_REMOTE_IS_ALIAS_SET,
380 * Description - Bluetooth Adapter LE Discovery started
382 BT_PROPERTY_ADAPTER_LE_DISCOVERY_STARTED,
385 * Description - Bluetooth Adapter LE Discovery stopped
387 BT_PROPERTY_ADAPTER_LE_DISCOVERY_STOPPED,
390 * Description - A2DP role of media endpoint
391 * Access mode - Only GET.
392 * Data type - uint32_t.
394 BT_PROPERTY_A2DP_ROLE = 0x1c,
396 BT_PROPERTY_REMOTE_DEVICE_TIMESTAMP = 0xFF,
397 } bt_property_type_t;
399 /** Bluetooth Adapter Property data structure */
401 bt_property_type_t type;
407 /** Bluetooth Device Type */
409 BT_DEVICE_DEVTYPE_BREDR = 0x1,
410 BT_DEVICE_DEVTYPE_BLE,
411 BT_DEVICE_DEVTYPE_DUAL
413 /** Bluetooth Bond state */
416 BT_BOND_STATE_BONDING,
420 /** Bluetooth SSP Bonding Variant */
422 BT_SSP_VARIANT_PASSKEY_CONFIRMATION,
423 BT_SSP_VARIANT_PASSKEY_ENTRY,
424 BT_SSP_VARIANT_CONSENT,
425 BT_SSP_VARIANT_PASSKEY_NOTIFICATION
428 /** Bluetooth Profile Service IDs */
430 BT_RES_SERVICE_ID, /* Reserved */
431 BT_SPP_SERVICE_ID, /* Serial port profile. */
432 BT_DUN_SERVICE_ID, /* Dial-up networking profile. */
433 BT_A2DP_SRC_SERVICE_ID, /* A2DP Source profile. */
434 BT_LAP_SERVICE_ID, /* LAN access profile. */
435 BT_HSP_SERVICE_ID, /* Headset profile. */
436 BT_HFP_SERVICE_ID, /* Hands-free profile. */
437 BT_OPP_SERVICE_ID, /* Object push */
438 BT_FTP_SERVICE_ID, /* File transfer */
439 BT_AVRCP_CT_SERVICE_ID, /* AVRC Controller Terminal */
440 BT_ICP_SERVICE_ID, /* Intercom Terminal */
441 BT_SYNC_SERVICE_ID, /* Synchronization */
442 BT_BPP_SERVICE_ID, /* Basic printing profile */
443 BT_BIP_SERVICE_ID, /* Basic Imaging profile */
444 BT_PANU_SERVICE_ID, /* PAN User */
445 BT_NAP_SERVICE_ID, /* PAN Network access point */
446 BT_GN_SERVICE_ID, /* PAN Group Ad-hoc networks */
447 BT_SAP_SERVICE_ID, /* SIM Access profile */
448 BT_A2DP_SERVICE_ID, /* A2DP Sink */
449 BT_AVRCP_SERVICE_ID, /* A/V remote control */
450 BT_HID_SERVICE_ID, /* HID */
451 BT_VDP_SERVICE_ID, /* Video distribution */
452 BT_PBAP_SERVICE_ID, /* PhoneBook Access Server*/
453 BT_HSP_HS_SERVICE_ID, /* HFP HS role */
454 BT_HFP_HS_SERVICE_ID, /* HSP HS role */
455 BT_MAP_SERVICE_ID, /* Message Access Profile */
456 BT_MN_SERVICE_ID, /* Message Notification Service */
457 BT_HDP_SERVICE_ID, /* Health Device Profile */
458 BT_PCE_SERVICE_ID, /* PhoneBook Access Client*/
460 BT_IOTIVITY_SERVICE_ID, /* Custom IOTIVITY UUID */
464 #define BT_MAX_NUM_UUIDS 32
467 #define BT_OSP_SERVER_OBEX 0x00
468 #define BT_OSP_SERVER_RFCOMM 0x01
469 #define BT_OSP_SERVER_MAX 0xFF
471 /* Tizen BT discovery Types */
473 BT_DISC_ROLE_BREDR = 0x01,
476 } bt_disc_role_type_t;
479 * This is Bluetooth device address type
482 BLUETOOTH_HAL_DEVICE_PUBLIC_ADDRESS = 0x00,
483 BLUETOOTH_HAL_DEVICE_RANDOM_ADDRESS
484 } bt_dev_addr_type_t;
486 /** Bluetooth Trusted Profiles */
488 BT_TRUSTED_PROFILE_PBAP = 1,
489 BT_TRUSTED_PROFILE_MAP,
490 BT_TRUSTED_PROFILE_SAP,
491 BT_TRUSTED_PROFILE_HFP_HF,
492 BT_TRUSTED_PROFILE_A2DP,
493 BT_TRUSTED_PROFILE_ALL = 0xFFFFFFFF,
494 } bt_trusted_profile_t;
496 /** Bluetooth Bonding Authentication Notifications */
498 BT_PASSKEY_CONFIRMATION = 1,
502 } bt_gap_auth_variant_t;
506 /** Bluetooth Interface callbacks */
508 /** Bluetooth Enable/Disable Callback. */
509 typedef void (*adapter_state_changed_callback)(bt_state_t state);
512 /** BLE Enable/Disable Callback. */
513 typedef void (*le_state_changed_callback)(bt_state_t state);
516 /** GET/SET Adapter Properties callback */
517 /* TODO: For the GET/SET property APIs/callbacks, we may need a session
518 * identifier to associate the call with the callback. This would be needed
519 * whenever more than one simultaneous instance of the same adapter_type
522 * If this is going to be handled in the Java framework, then we do not need
523 * to manage sessions here.
525 typedef void (*adapter_properties_callback)(bt_status_t status,
527 bt_property_t *properties);
529 /** GET/SET Remote Device Properties callback */
530 /** TODO: For remote device properties, do not see a need to get/set
531 * multiple properties - num_properties shall be 1
533 typedef void (*remote_device_properties_callback)(bt_status_t status,
534 bt_bdaddr_t *bd_addr,
536 bt_property_t *properties);
538 /** New device discovered callback */
539 /** If EIR data is not present, then BD_NAME and RSSI shall be NULL and -1
541 typedef void (*device_found_callback)(int num_properties,
542 bt_property_t *properties);
544 /** Discovery state changed callback */
545 typedef void (*discovery_state_changed_callback)(bt_discovery_state_t state);
547 /** Bluetooth Legacy PinKey Request callback */
548 typedef void (*pin_request_callback)(bt_bdaddr_t *remote_bd_addr,
549 bt_bdname_t *bd_name, uint32_t cod);
551 /** Bluetooth SSP Request callback - Just Works & Numeric Comparison*/
552 /** pass_key - Shall be 0 for BT_SSP_PAIRING_VARIANT_CONSENT &
553 * BT_SSP_PAIRING_PASSKEY_ENTRY */
554 /* TODO: Passkey request callback shall not be needed for devices with display
555 * capability. We still need support this in the stack for completeness */
556 typedef void (*ssp_request_callback)(bt_bdaddr_t *remote_bd_addr,
557 bt_bdname_t *bd_name,
559 bt_ssp_variant_t pairing_variant,
562 /** Bluetooth Bond state changed callback */
563 /* Invoked in response to create_bond, cancel_bond or remove_bond */
564 typedef void (*bond_state_changed_callback)(bt_status_t status,
565 bt_bdaddr_t *remote_bd_addr,
566 bt_bond_state_t state);
568 /** Bluetooth ACL connection state changed callback */
569 typedef void (*acl_state_changed_callback)(bt_status_t status, bt_bdaddr_t *remote_bd_addr,
570 bt_acl_state_t state);
577 /** Thread Associate/Disassociate JVM Callback */
578 /* Callback that is invoked by the callback thread to allow upper layer to attach/detach to/from
580 typedef void (*callback_thread_event)(bt_cb_thread_evt evt);
582 /** Bluetooth Test Mode Callback */
583 /* Receive any HCI event from controller. Must be in DUT Mode for this callback to be received */
584 typedef void (*dut_mode_recv_callback)(uint16_t opcode, uint8_t *buf, uint8_t len);
586 /* LE Test mode callbacks
587 * This callback shall be invoked whenever the le_tx_test, le_rx_test or le_test_end is invoked
588 * The num_packets is valid only for le_test_end command */
589 typedef void (*le_test_mode_callback)(bt_status_t status, uint16_t num_packets);
591 /** Callback invoked when energy details are obtained */
592 /* Ctrl_state-Current controller state-Active-1,scan-2,or idle-3 state as defined by HCI spec.
593 * If the ctrl_state value is 0, it means the API call failed
594 * Time values-In milliseconds as returned by the controller
595 * Energy used-Value as returned by the controller
596 * Status-Provides the status of the read_energy_info API call */
597 typedef void (*energy_info_callback)(bt_activity_energy_info *energy_info);
599 /* Service level Authorization request callback */
600 typedef void (*authorize_request_callback) (bt_bdaddr_t *remote_bd_addr, bt_service_id_t service_d);
603 /* Service level Authorization request callback */
604 typedef void (*sock_authorize_request_callback) (bt_bdaddr_t *remote_bd_addr, bt_uuid_t *uuid, uint8_t *name, uint8_t *path, uint32_t fd);
606 /** Bluetooth ACL connection state */
608 BT_LE_CONN_STATE_CONNECTED,
609 BT_LE_CONN_STATE_DISCONNECTED
610 } bt_le_conn_state_t;
612 /** Bluetooth ACL connection state changed callback */
613 typedef void (*le_conn_state_changed_callback)(bt_status_t status, bt_bdaddr_t *remote_bd_addr,
614 bt_le_conn_state_t state);
616 /** Remote device trusted profiles changed callback */
617 typedef void (*device_trusted_profiles_changed_callback)(bt_bdaddr_t *bd_addr, uint32_t trust_val);
619 /** Remote device RSSI monitoring state changed callback */
620 typedef void (*rssi_monitor_state_changed_callback)(bt_bdaddr_t *bd_addr, int32_t link_type, uint8_t state);
622 /** Remote device RSSI alert callback */
623 typedef void (*rssi_alert_callback)(bt_bdaddr_t *bd_addr, int32_t link_type, int32_t alert_type, int32_t rssi);
625 /** Remote device Raw RSSI received callback */
626 typedef void (*raw_rssi_received_callback)(bt_bdaddr_t *bd_addr, int32_t link_type, int32_t rssi);
628 /** DBFW plus info received callback */
629 typedef void (*dbfw_plus_info_received_callback)(unsigned char *data, uint32_t length, uint8_t event_code);
632 /** TODO: Add callbacks for Link Up/Down and other generic
633 * notifications/callbacks */
635 /** Remote Device Trust state changed callback */
636 typedef void (*device_trust_state_changed_callback)(bt_bdaddr_t *remote_bd_addr,
637 bt_device_trust_state_t trust);
639 /** Bluetooth DM callback structure. */
641 /** set to sizeof(bt_callbacks_t) */
643 adapter_state_changed_callback adapter_state_changed_cb;
644 adapter_properties_callback adapter_properties_cb;
645 remote_device_properties_callback remote_device_properties_cb;
646 device_found_callback device_found_cb;
647 discovery_state_changed_callback discovery_state_changed_cb;
648 pin_request_callback pin_request_cb;
649 ssp_request_callback ssp_request_cb;
650 bond_state_changed_callback bond_state_changed_cb;
651 acl_state_changed_callback acl_state_changed_cb;
652 callback_thread_event thread_evt_cb;
653 dut_mode_recv_callback dut_mode_recv_cb;
654 le_test_mode_callback le_test_mode_cb;
655 energy_info_callback energy_info_cb;
656 authorize_request_callback authorize_request_cb;
657 device_trust_state_changed_callback device_trust_state_changed_cb;
659 sock_authorize_request_callback socket_authorize_request_cb;
660 le_state_changed_callback le_state_changed_cb;
661 le_conn_state_changed_callback le_conn_state_changed_cb;
662 device_trusted_profiles_changed_callback device_trusted_profiles_changed_cb;
663 rssi_monitor_state_changed_callback rssi_monitor_state_changed_cb;
664 rssi_alert_callback rssi_alert_cb;
665 raw_rssi_received_callback raw_rssi_received_cb;
666 dbfw_plus_info_received_callback dbfw_plus_info_received_cb;
670 typedef void (*alarm_cb)(void *data);
671 typedef bool (*set_wake_alarm_callout)(uint64_t delay_millis, bool should_wake, alarm_cb cb, void *data);
672 typedef int (*acquire_wake_lock_callout)(const char *lock_name);
673 typedef int (*release_wake_lock_callout)(const char *lock_name);
675 /** The set of functions required by bluedroid to set wake alarms and
676 * grab wake locks. This struct is passed into the stack through the
677 * |set_os_callouts| function on |bt_interface_t|.
680 /* set to sizeof(bt_os_callouts_t) */
683 set_wake_alarm_callout set_wake_alarm;
684 acquire_wake_lock_callout acquire_wake_lock;
685 release_wake_lock_callout release_wake_lock;
688 /** NOTE: By default, no profiles are initialized at the time of init/enable.
689 * Whenever the application invokes the 'init' API of a profile, then one of
690 * the following shall occur:
692 * 1.) If Bluetooth is not enabled, then the Bluetooth core shall mark the
693 * profile as enabled. Subsequently, when the application invokes the
694 * Bluetooth 'enable', as part of the enable sequence the profile that were
695 * marked shall be enabled by calling appropriate stack APIs. The
696 * 'adapter_properties_cb' shall return the list of UUIDs of the
699 * 2.) If Bluetooth is enabled, then the Bluetooth core shall invoke the stack
700 * profile API to initialize the profile and trigger a
701 * 'adapter_properties_cb' with the current list of UUIDs including the
702 * newly added profile's UUID.
704 * The reverse shall occur whenever the profile 'cleanup' APIs are invoked
707 /** Represents the standard Bluetooth DM interface. */
709 /** set to sizeof(bt_interface_t) */
712 * Opens the interface and provides the callback routines
713 * to the implemenation of this interface.
715 int (*init)(bt_callbacks_t*callbacks);
717 /** Enable Bluetooth. */
720 /** Disable Bluetooth. */
721 int (*disable)(void);
724 /** Recovers Adapter. */
725 int (*recover)(void);
729 /** Reset Bluetooth. */
734 /** Enable LE Bluetooth. */
735 int (*le_enable)(void);
737 /** Disable LE Bluetooth. */
738 int (*le_disable)(void);
740 int (*le_init)(void);
742 void (*le_deinit)(void);
744 int (*is_advertising) (void);
747 /** Closes the interface. */
748 void (*cleanup)(void);
751 /** Get Bluetooth Adapter Powered status */
752 int (*get_adapter_powered_status)(uint8_t *status);
755 /** Get all Bluetooth Adapter properties at init */
756 int (*get_adapter_properties)(void);
758 /** Get Bluetooth Adapter property of 'type' */
759 int (*get_adapter_property)(bt_property_type_t type);
761 /** Set Bluetooth Adapter property of 'type' */
762 /* Based on the type, val shall be one of
763 * bt_bdaddr_t or bt_bdname_t or bt_scanmode_t etc
765 int (*set_adapter_property)(const bt_property_t *property);
767 /** Get all Remote Device properties */
768 int (*get_remote_device_properties)(bt_bdaddr_t *remote_addr);
770 /** Get Remote Device property of 'type' */
771 int (*get_remote_device_property)(bt_bdaddr_t *remote_addr,
772 bt_property_type_t type);
774 /** Set Remote Device property of 'type' */
775 int (*set_remote_device_property)(bt_bdaddr_t *remote_addr,
776 const bt_property_t *property);
778 /** Get Remote Device's service record for the given UUID */
779 int (*get_remote_service_record)(bt_bdaddr_t *remote_addr,
782 /** Start SDP to get remote services */
783 int (*get_remote_services)(bt_bdaddr_t *remote_addr);
785 /** Start Discovery */
786 int (*start_discovery)(void);
789 int (*start_custom_discovery)(bt_disc_role_type_t disc_type);
792 /** Cancel Discovery */
793 int (*cancel_discovery)(void);
795 /** Create Bluetooth Bonding */
796 int (*create_bond)(const bt_bdaddr_t *bd_addr, int transport);
799 int (*remove_bond)(const bt_bdaddr_t *bd_addr);
802 int (*cancel_bond)(const bt_bdaddr_t *bd_addr);
805 * Get the connection status for a given remote device.
806 * return value of 0 means the device is not connected,
807 * non-zero return status indicates an active connection.
809 int (*get_connection_state)(const bt_bdaddr_t *bd_addr);
811 /** BT Legacy PinKey Reply */
812 /** If accept==FALSE, then pin_len and pin_code shall be 0x0 */
813 int (*pin_reply)(const bt_bdaddr_t *bd_addr, uint8_t accept,
814 uint8_t pin_len, bt_pin_code_t *pin_code);
816 /** BT SSP Reply - Just Works, Numeric Comparison and Passkey
817 * passkey shall be zero for BT_SSP_VARIANT_PASSKEY_COMPARISON &
818 * BT_SSP_VARIANT_CONSENT
819 * For BT_SSP_VARIANT_PASSKEY_ENTRY, if accept==FALSE, then passkey
821 int (*ssp_reply)(const bt_bdaddr_t *bd_addr, bt_ssp_variant_t variant,
822 uint8_t accept, uint32_t passkey);
824 /** Get Bluetooth profile interface */
825 const void* (*get_profile_interface) (const char *profile_id);
827 /** Bluetooth Test Mode APIs - Bluetooth must be enabled for these APIs */
828 /* Configure DUT Mode - Use this mode to enter/exit DUT mode */
829 int (*dut_mode_configure)(uint8_t enable);
831 /* Send any test HCI (vendor-specific) command to the controller. Must be in DUT Mode */
832 int (*dut_mode_send)(uint16_t opcode, uint8_t *buf, uint8_t len);
833 /** BLE Test Mode APIs */
834 /* opcode MUST be one of: LE_Receiver_Test, LE_Transmitter_Test, LE_Test_End */
835 int (*le_test_mode)(uint16_t opcode, uint8_t *buf, uint8_t len);
837 /* enable or disable bluetooth HCI snoop log */
838 int (*config_hci_snoop_log)(uint8_t enable);
840 /** Sets the OS call-out functions that bluedroid needs for alarms and wake locks.
841 * This should be called immediately after a successful |init|.
843 int (*set_os_callouts)(bt_os_callouts_t *callouts);
845 /** Read Energy info details - return value indicates BT_STATUS_SUCCESS or BT_STATUS_NOT_READY
846 * Success indicates that the VSC command was sent to controller
848 int (*read_energy_info)();
850 /* Tizen Specific: Send service level Authorization response */
851 int (*authorize_response)(const bt_bdaddr_t *bd_addr, bt_service_id_t service_id,
852 uint8_t authorize, uint8_t save_settings);
854 /** Set auto authorization for peer device. Should be a paired device */
855 int (*set_authorization)(bt_bdaddr_t *bd_addr, uint8_t auth);
858 * get the service connection status for a given remote device.
859 * return value of 0 means the device is not connected,
860 * non-zero return status indicates an active connection.
862 int (*get_service_connection_state)(const bt_bdaddr_t *bd_addr, bt_service_id_t rem_svc_id);
865 * Register osp server in gap agent.
867 int (*register_agent_osp_server)(uint32_t type, char *uuid, char *path, int fd);
870 * Unregister osp server in gap agent.
872 int (*unregister_agent_osp_server)(uint32_t type, char *uuid);
875 * Set profile as trusted for remote device
877 int (*set_trusted_profile)(bt_bdaddr_t *bd_addr, bt_trusted_profile_t profile, uint8_t trust);
880 * Get profile trusted status for remote device
882 int (*get_trusted_profile)(bt_bdaddr_t *bd_addr, bt_trusted_profile_t profile, uint32_t *trusted);
885 * Gets the identity address of the remote device
887 int (*get_device_ida)(bt_bdaddr_t *bd_addr, bt_bdaddr_t *id_addr);
890 * Get raw RSSI strength of remote device for connected link type
891 * conn_link_type: (0 = BR/EDR link, 1 = LE link, 0xFF = Any (Default))
893 int (*get_connected_link_rssi_strength)(bt_bdaddr_t *bd_addr, uint32_t conn_link_type);
896 * Enable RSSI monitoring of remote device for connected link type
897 * conn_link_type: (0 = BR/EDR link, 1 = LE link, 0xFF = Any (Default))
898 * Threshold : (low_threshold, in_range_threshold, high_threshold)
900 int (*enable_rssi_monitoring)(bt_bdaddr_t *bd_addr, uint32_t conn_link_type,
901 int low_threshold, int in_range_threshold, int high_threshold);
903 * Enable/Disable GAP authentication notification to application
904 * enable == 0/1 -> Enable/Disable notification sending
905 * type == value from bt_gap_auth_variant_t
907 int (*enable_gap_auth_notifications)(uint32_t type, uint8_t enable);
909 int (*set_le_static_random_address)(uint8_t enable);
912 * Sets is_activating variable in HAL to TRUE. It is required for the
913 * adapter switched on event to propagate to upper layers from HAL.
915 int (*set_hal_adapter_request_state)(int enable);
918 * Sets is_activating variable in HAL to TRUE. It is required for the
919 * le adapter switched on event to propagate to upper layers from HAL.
921 int (*set_hal_le_request_state)(int enable);
924 * adds/removes the remote device address to/from the white list
926 int (*adapter_le_set_white_list)(bt_bdaddr_t *device_address, bt_dev_addr_type_t address_type, bool is_add);
929 * Sets the privacy functionality of the adapter
931 int (*adapter_le_set_privacy)(uint8_t set_privacy);
934 * disconnect the device
936 int (*device_disconnect)(const bt_bdaddr_t *bd_addr);
939 * sets the specified manufacturer data of the adapter
941 int (*adapter_le_set_manufacturer_data)(bt_manufacturer_data_t *m_data);
945 /** TODO: Need to add APIs for Service Discovery, Service authorization and
946 * connection management. Also need to add APIs for configuring
947 * properties of remote bonded devices such as name, UUID etc. */
950 struct hw_device_t common;
951 const bt_interface_t* (*get_bluetooth_interface)();
952 } bluetooth_device_t;
954 typedef bluetooth_device_t bluetooth_module_t;
957 #endif /* ANDROID_INCLUDE_BLUETOOTH_H */