2 * Copyright (C) 2013 The Android Open Source Project
3 * Copyright (C) 2009-2014 Broadcom Corporation
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #ifndef ANDROID_INCLUDE_BT_GATT_CLIENT_H
20 #define ANDROID_INCLUDE_BT_GATT_CLIENT_H
23 #include "bt_gatt_types.h"
28 #define BT_GATTC_LE_SCAN_TYPE_PASSIVE 0x00
29 #define BT_GATTC_LE_SCAN_TYPE_ACTIVE 0x01
32 /** Buffer type for unformatted reads/writes */
34 uint8_t value[BTGATT_MAX_ATTR_LEN];
36 } btgatt_unformatted_value_t;
38 /** Parameters for GATT read operations */
40 btgatt_srvc_id_t srvc_id;
41 btgatt_gatt_id_t char_id;
42 btgatt_gatt_id_t descr_id;
43 btgatt_unformatted_value_t value;
46 } btgatt_read_params_t;
48 /** Parameters for GATT write operations */
50 btgatt_srvc_id_t srvc_id;
51 btgatt_gatt_id_t char_id;
52 btgatt_gatt_id_t descr_id;
54 } btgatt_write_params_t;
56 /** Attribute change notification parameters */
58 btgatt_srvc_id_t srvc_id;
59 btgatt_gatt_id_t char_id;
62 } btgatt_acquire_params_t;
65 /** Attribute change notification parameters */
67 uint8_t value[BTGATT_MAX_ATTR_LEN];
69 btgatt_srvc_id_t srvc_id;
70 btgatt_gatt_id_t char_id;
73 } btgatt_notify_params_t;
83 } btgatt_test_params_t;
85 /** BT-GATT Client callback structure. */
87 /** Callback invoked in response to register_client */
88 typedef void (*register_client_callback)(int status, int client_if,
91 /** Callback for scan results */
92 typedef void (*scan_result_callback)(bt_bdaddr_t* bda, uint8_t addr_type, int rssi,
93 uint8_t* adv_data, int adv_dat_len, uint8_t *scan_rsp_data, int scan_rsp_data_len);
95 /** GATT open callback invoked in response to open */
96 typedef void (*connect_callback)(int conn_id, int status, int client_if, bt_bdaddr_t* bda);
98 /** Callback invoked in response to close */
99 typedef void (*disconnect_callback)(int conn_id, int status,
100 int client_if, bt_bdaddr_t* bda);
103 * Invoked in response to search_service when the GATT service search
104 * has been completed.
106 typedef void (*search_complete_callback)(int conn_id, int status);
108 /** Reports GATT services on a remote device */
109 typedef void (*search_result_callback)(int conn_id, btgatt_srvc_id_t *srvc_id);
111 /** GATT characteristic enumeration result callback */
112 typedef void (*get_characteristic_callback)(int conn_id, int status,
113 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
116 /** GATT descriptor enumeration result callback */
117 typedef void (*get_descriptor_callback)(int conn_id, int status,
118 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
119 btgatt_gatt_id_t *descr_id);
121 /** GATT included service enumeration result callback */
122 typedef void (*get_included_service_callback)(int conn_id, int status,
123 btgatt_srvc_id_t *srvc_id, btgatt_srvc_id_t *incl_srvc_id);
125 /** Callback invoked in response to [de]register_for_notification */
126 typedef void (*register_for_notification_callback)(int conn_id,
127 int registered, int status, btgatt_srvc_id_t *srvc_id,
128 btgatt_gatt_id_t *char_id);
131 * Remote device notification callback, invoked when a remote device sends
132 * a notification or indication that a client has registered for.
134 typedef void (*notify_callback)(int conn_id, btgatt_notify_params_t *p_data);
136 /** Registers service changed callback operation */
137 typedef void (*service_changed_callback)(bt_bdaddr_t *bd_addr, int change_type, uint8_t *uuid, int conn_id, int inst_id);
139 /** Reports result of a GATT read operation */
140 typedef void (*read_characteristic_callback)(int conn_id, int status,
141 btgatt_read_params_t *p_data);
143 /** GATT write characteristic operation callback */
144 typedef void (*write_characteristic_callback)(int conn_id, int status,
145 btgatt_write_params_t *p_data);
147 /** GATT execute prepared write callback */
148 typedef void (*execute_write_callback)(int conn_id, int status);
150 /** Callback invoked in response to read_descriptor */
151 typedef void (*read_descriptor_callback)(int conn_id, int status,
152 btgatt_read_params_t *p_data);
154 /** Callback invoked in response to write_descriptor */
155 typedef void (*write_descriptor_callback)(int conn_id, int status,
156 btgatt_write_params_t *p_data);
158 /** Callback triggered in response to read_remote_rssi */
159 typedef void (*read_remote_rssi_callback)(int client_if, bt_bdaddr_t* bda,
160 int rssi, int status);
162 /** Callback invoked when the MTU for a given connection changes */
163 typedef void (*configure_mtu_callback)(int conn_id, int status, int mtu);
165 /** Callback invoked when a scan filter configuration command has completed */
166 typedef void (*scan_filter_cfg_callback)(int action, int client_if, int status, int filt_type,
169 /** Callback invoked when scan param has been added, cleared, or deleted */
170 typedef void (*scan_filter_param_callback)(int action, int client_if, int status,
173 /** Callback invoked when a scan filter configuration command has completed */
174 typedef void (*scan_filter_status_callback)(int enable, int client_if, int status);
177 * Callback notifying an application that a remote device connection is currently congested
178 * and cannot receive any more data. An application should avoid sending more data until
179 * a further callback is received indicating the congestion status has been cleared.
181 typedef void (*congestion_callback)(int conn_id, bool congested);
182 /** Callback invoked when batchscan storage config operation has completed */
183 typedef void (*batchscan_cfg_storage_callback)(int client_if, int status);
185 /** Callback invoked when batchscan enable / disable operation has completed */
186 typedef void (*batchscan_enable_disable_callback)(int action, int client_if, int status);
188 /** Callback invoked when batchscan reports are obtained */
189 typedef void (*batchscan_reports_callback)(int client_if, int status, int report_format,
190 int num_records, int data_len, uint8_t* rep_data);
192 /** Callback invoked when batchscan storage threshold limit is crossed */
193 typedef void (*batchscan_threshold_callback)(int client_if);
195 /** Track ADV VSE callback invoked when tracked device is found or lost */
196 typedef void (*track_adv_event_callback)(int client_if, int filt_index, int addr_type,
197 bt_bdaddr_t* bda, int adv_state);
199 register_client_callback register_client_cb;
200 scan_result_callback scan_result_cb;
201 connect_callback open_cb;
202 disconnect_callback close_cb;
203 search_complete_callback search_complete_cb;
204 search_result_callback search_result_cb;
205 get_characteristic_callback get_characteristic_cb;
206 get_descriptor_callback get_descriptor_cb;
207 get_included_service_callback get_included_service_cb;
208 register_for_notification_callback register_for_notification_cb;
209 notify_callback notify_cb;
210 service_changed_callback service_changed_cb;
211 read_characteristic_callback read_characteristic_cb;
212 write_characteristic_callback write_characteristic_cb;
213 read_descriptor_callback read_descriptor_cb;
214 write_descriptor_callback write_descriptor_cb;
215 execute_write_callback execute_write_cb;
216 read_remote_rssi_callback read_remote_rssi_cb;
217 configure_mtu_callback configure_mtu_cb;
218 scan_filter_cfg_callback scan_filter_cfg_cb;
219 scan_filter_param_callback scan_filter_param_cb;
220 scan_filter_status_callback scan_filter_status_cb;
221 congestion_callback congestion_cb;
222 batchscan_cfg_storage_callback batchscan_cfg_storage_cb;
223 batchscan_enable_disable_callback batchscan_enb_disable_cb;
224 batchscan_reports_callback batchscan_reports_cb;
225 batchscan_threshold_callback batchscan_threshold_cb;
226 track_adv_event_callback track_adv_event_cb;
227 } btgatt_client_callbacks_t;
229 /** Represents the standard BT-GATT client interface. */
232 /** Registers a GATT client application with the stack */
233 bt_status_t (*register_client)(bt_uuid_t *uuid);
235 /** Unregister a client application from the stack */
236 bt_status_t (*unregister_client)(int client_if);
238 /** Start or stop LE device scanning */
239 bt_status_t (*scan)(int client_if, bool start);
241 /** Create a connection to a remote LE or dual-mode device */
242 bt_status_t (*connect)(int client_if, const bt_bdaddr_t *bd_addr,
245 /** Disconnect a remote device or cancel a pending connection */
246 bt_status_t (*disconnect)(int client_if, const bt_bdaddr_t *bd_addr,
249 /** Clear the attribute cache for a given device */
250 bt_status_t (*refresh)(int client_if, const bt_bdaddr_t *bd_addr);
253 * Enumerate all GATT services on a connected device.
254 * Optionally, the results can be filtered for a given UUID.
256 bt_status_t (*search_service)(int conn_id, bt_uuid_t *filter_uuid);
259 * Enumerate included services for a given service.
260 * Set start_incl_srvc_id to NULL to get the first included service.
262 bt_status_t (*get_included_service)(int conn_id, btgatt_srvc_id_t *srvc_id,
263 btgatt_srvc_id_t *start_incl_srvc_id);
266 * Enumerate characteristics for a given service.
267 * Set start_char_id to NULL to get the first characteristic.
269 bt_status_t (*get_characteristic)(int conn_id,
270 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *start_char_id);
273 * Enumerate descriptors for a given characteristic.
274 * Set start_descr_id to NULL to get the first descriptor.
276 bt_status_t (*get_descriptor)(int conn_id,
277 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
278 btgatt_gatt_id_t *start_descr_id);
280 /** Read a characteristic on a remote device */
281 bt_status_t (*read_characteristic)(int conn_id,
282 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
285 /** Write a remote characteristic */
286 bt_status_t (*write_characteristic)(int conn_id,
287 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
288 int write_type, int len, int auth_req,
291 /** acquire fd for writing remote characterstics */
292 bt_status_t (*acquire_write)(int conn_id,
293 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
294 int auth_req, int *fd , int *mtu);
296 /** acquire fd for notifying remote characterstics */
297 bt_status_t (*acquire_notify)(int conn_id,
298 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
301 /** Read the descriptor for a given characteristic */
302 bt_status_t (*read_descriptor)(int conn_id,
303 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
304 btgatt_gatt_id_t *descr_id, int auth_req);
306 /** Write a remote descriptor for a given characteristic */
307 bt_status_t (*write_descriptor)(int conn_id,
308 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
309 btgatt_gatt_id_t *descr_id, int write_type, int len,
310 int auth_req, char* p_value);
312 /** Execute a prepared write operation */
313 bt_status_t (*execute_write)(int conn_id, int execute);
316 * Register to receive notifications or indications for a given
319 bt_status_t (*register_for_notification)(int conn_id,
320 const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id,
321 btgatt_gatt_id_t *char_id);
323 /** Deregister a previous request for notifications/indications */
324 bt_status_t (*deregister_for_notification)(int conn_id,
325 const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id,
326 btgatt_gatt_id_t *char_id);
328 /** Request RSSI for a given remote device */
329 bt_status_t (*read_remote_rssi)(int client_if, const bt_bdaddr_t *bd_addr);
331 /** OTA firmware download */
332 bt_status_t (*ota_fw_update)(int client_if, int conn_id, const bt_bdaddr_t *bd_addr, char* path);
334 /** Determine the type of the remote device (LE, BR/EDR, Dual-mode) */
335 int (*get_device_type)(const bt_bdaddr_t *bd_addr);
337 /** Request a connection parameter update */
338 bt_status_t (*conn_parameter_update)(bt_bdaddr_t *bd, int min_int, int max_int, int latency, int timeout);
340 /** Test mode interface */
341 bt_status_t (*test_command)(int command, btgatt_test_params_t* params);
343 /** MTU Exchange request from client */
344 bt_status_t (*configure_mtu)(int conn_id, int mtu);
346 /** Setup scan filter params */
347 bt_status_t (*scan_filter_param_setup)(int client_if, int action, int filt_index, int feat_seln,
348 int list_logic_type, int filt_logic_type, int rssi_high_thres,
349 int rssi_low_thres, int dely_mode, int found_timeout,
350 int lost_timeout, int found_timeout_cnt);
353 /** Configure a scan filter condition */
354 bt_status_t (*scan_filter_add_remove)(int client_if, int action, int filt_type,
355 int filt_index, int company_id,
356 int company_id_mask, const bt_uuid_t *p_uuid,
357 const bt_uuid_t *p_uuid_mask, const bt_bdaddr_t *bd_addr,
358 char addr_type, int data_len, char* p_data, int mask_len,
361 /** Clear all scan filter conditions for specific filter index*/
362 bt_status_t (*scan_filter_clear)(int client_if, int filt_index);
364 /** Enable / disable scan filter feature*/
365 bt_status_t (*scan_filter_enable)(int client_if, bool enable);
367 /** Sets the LE scan interval and window in units of N*0.625 msec */
369 bt_status_t (*set_scan_parameters)(int scan_type, int scan_interval, int scan_window);
371 bt_status_t (*set_scan_parameters)(int scan_interval, int scan_window);
374 /* Configure the batchscan storage */
375 bt_status_t (*batchscan_cfg_storage)(int client_if, int batch_scan_full_max,
376 int batch_scan_trunc_max, int batch_scan_notify_threshold);
378 /* Enable batchscan */
379 bt_status_t (*batchscan_enb_batch_scan)(int client_if, int scan_mode,
380 int scan_interval, int scan_window, int addr_type, int discard_rule);
382 /* Disable batchscan */
383 bt_status_t (*batchscan_dis_batch_scan)(int client_if);
385 /* Read out batchscan reports */
386 bt_status_t (*batchscan_read_reports)(int client_if, int scan_mode);
388 /** Adds a connection info in list */
389 bt_status_t (*add_connection_info)(const bt_bdaddr_t *bd_addr, int conn_id, int server_inst_id);
391 /** Get data batching available packets */
392 bt_status_t (*get_data_batching_available_packets)(unsigned int *available_packets);
394 /** Enable data batching */
395 bt_status_t (*enable_data_batching)(const bt_bdaddr_t *bd_addr, int packet_threshold, int timeout);
397 /** Disable data batching */
398 bt_status_t (*disable_data_batching)(const bt_bdaddr_t *bd_addr);
399 } btgatt_client_interface_t;
403 #endif /* ANDROID_INCLUDE_BT_GATT_CLIENT_H */