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, int rssi, uint8_t* adv_data);
94 /** GATT open callback invoked in response to open */
95 typedef void (*connect_callback)(int conn_id, int status, int client_if, bt_bdaddr_t* bda);
97 /** Callback invoked in response to close */
98 typedef void (*disconnect_callback)(int conn_id, int status,
99 int client_if, bt_bdaddr_t* bda);
102 * Invoked in response to search_service when the GATT service search
103 * has been completed.
105 typedef void (*search_complete_callback)(int conn_id, int status);
107 /** Reports GATT services on a remote device */
108 typedef void (*search_result_callback)(int conn_id, btgatt_srvc_id_t *srvc_id);
110 /** GATT characteristic enumeration result callback */
111 typedef void (*get_characteristic_callback)(int conn_id, int status,
112 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
115 /** GATT descriptor enumeration result callback */
116 typedef void (*get_descriptor_callback)(int conn_id, int status,
117 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
118 btgatt_gatt_id_t *descr_id);
120 /** GATT included service enumeration result callback */
121 typedef void (*get_included_service_callback)(int conn_id, int status,
122 btgatt_srvc_id_t *srvc_id, btgatt_srvc_id_t *incl_srvc_id);
124 /** Callback invoked in response to [de]register_for_notification */
125 typedef void (*register_for_notification_callback)(int conn_id,
126 int registered, int status, btgatt_srvc_id_t *srvc_id,
127 btgatt_gatt_id_t *char_id);
130 * Remote device notification callback, invoked when a remote device sends
131 * a notification or indication that a client has registered for.
133 typedef void (*notify_callback)(int conn_id, btgatt_notify_params_t *p_data);
135 /** Registers service changed callback operation */
136 typedef void (*service_changed_callback)(bt_bdaddr_t *bd_addr, int change_type, uint8_t *uuid, int conn_id);
138 /** Reports result of a GATT read operation */
139 typedef void (*read_characteristic_callback)(int conn_id, int status,
140 btgatt_read_params_t *p_data);
142 /** GATT write characteristic operation callback */
143 typedef void (*write_characteristic_callback)(int conn_id, int status,
144 btgatt_write_params_t *p_data);
146 /** GATT execute prepared write callback */
147 typedef void (*execute_write_callback)(int conn_id, int status);
149 /** Callback invoked in response to read_descriptor */
150 typedef void (*read_descriptor_callback)(int conn_id, int status,
151 btgatt_read_params_t *p_data);
153 /** Callback invoked in response to write_descriptor */
154 typedef void (*write_descriptor_callback)(int conn_id, int status,
155 btgatt_write_params_t *p_data);
157 /** Callback triggered in response to read_remote_rssi */
158 typedef void (*read_remote_rssi_callback)(int client_if, bt_bdaddr_t* bda,
159 int rssi, int status);
161 /** Callback invoked when the MTU for a given connection changes */
162 typedef void (*configure_mtu_callback)(int conn_id, int status, int mtu);
164 /** Callback invoked when a scan filter configuration command has completed */
165 typedef void (*scan_filter_cfg_callback)(int action, int client_if, int status, int filt_type,
168 /** Callback invoked when scan param has been added, cleared, or deleted */
169 typedef void (*scan_filter_param_callback)(int action, int client_if, int status,
172 /** Callback invoked when a scan filter configuration command has completed */
173 typedef void (*scan_filter_status_callback)(int enable, int client_if, int status);
176 * Callback notifying an application that a remote device connection is currently congested
177 * and cannot receive any more data. An application should avoid sending more data until
178 * a further callback is received indicating the congestion status has been cleared.
180 typedef void (*congestion_callback)(int conn_id, bool congested);
181 /** Callback invoked when batchscan storage config operation has completed */
182 typedef void (*batchscan_cfg_storage_callback)(int client_if, int status);
184 /** Callback invoked when batchscan enable / disable operation has completed */
185 typedef void (*batchscan_enable_disable_callback)(int action, int client_if, int status);
187 /** Callback invoked when batchscan reports are obtained */
188 typedef void (*batchscan_reports_callback)(int client_if, int status, int report_format,
189 int num_records, int data_len, uint8_t* rep_data);
191 /** Callback invoked when batchscan storage threshold limit is crossed */
192 typedef void (*batchscan_threshold_callback)(int client_if);
194 /** Track ADV VSE callback invoked when tracked device is found or lost */
195 typedef void (*track_adv_event_callback)(int client_if, int filt_index, int addr_type,
196 bt_bdaddr_t* bda, int adv_state);
198 register_client_callback register_client_cb;
199 scan_result_callback scan_result_cb;
200 connect_callback open_cb;
201 disconnect_callback close_cb;
202 search_complete_callback search_complete_cb;
203 search_result_callback search_result_cb;
204 get_characteristic_callback get_characteristic_cb;
205 get_descriptor_callback get_descriptor_cb;
206 get_included_service_callback get_included_service_cb;
207 register_for_notification_callback register_for_notification_cb;
208 notify_callback notify_cb;
209 service_changed_callback service_changed_cb;
210 read_characteristic_callback read_characteristic_cb;
211 write_characteristic_callback write_characteristic_cb;
212 read_descriptor_callback read_descriptor_cb;
213 write_descriptor_callback write_descriptor_cb;
214 execute_write_callback execute_write_cb;
215 read_remote_rssi_callback read_remote_rssi_cb;
216 configure_mtu_callback configure_mtu_cb;
217 scan_filter_cfg_callback scan_filter_cfg_cb;
218 scan_filter_param_callback scan_filter_param_cb;
219 scan_filter_status_callback scan_filter_status_cb;
220 congestion_callback congestion_cb;
221 batchscan_cfg_storage_callback batchscan_cfg_storage_cb;
222 batchscan_enable_disable_callback batchscan_enb_disable_cb;
223 batchscan_reports_callback batchscan_reports_cb;
224 batchscan_threshold_callback batchscan_threshold_cb;
225 track_adv_event_callback track_adv_event_cb;
226 } btgatt_client_callbacks_t;
228 /** Represents the standard BT-GATT client interface. */
231 /** Registers a GATT client application with the stack */
232 bt_status_t (*register_client)(bt_uuid_t *uuid);
234 /** Unregister a client application from the stack */
235 bt_status_t (*unregister_client)(int client_if);
237 /** Start or stop LE device scanning */
238 bt_status_t (*scan)(int client_if, bool start);
240 /** Create a connection to a remote LE or dual-mode device */
241 bt_status_t (*connect)(int client_if, const bt_bdaddr_t *bd_addr,
244 /** Disconnect a remote device or cancel a pending connection */
245 bt_status_t (*disconnect)(int client_if, const bt_bdaddr_t *bd_addr,
248 /** Clear the attribute cache for a given device */
249 bt_status_t (*refresh)(int client_if, const bt_bdaddr_t *bd_addr);
252 * Enumerate all GATT services on a connected device.
253 * Optionally, the results can be filtered for a given UUID.
255 bt_status_t (*search_service)(int conn_id, bt_uuid_t *filter_uuid);
258 * Enumerate included services for a given service.
259 * Set start_incl_srvc_id to NULL to get the first included service.
261 bt_status_t (*get_included_service)(int conn_id, btgatt_srvc_id_t *srvc_id,
262 btgatt_srvc_id_t *start_incl_srvc_id);
265 * Enumerate characteristics for a given service.
266 * Set start_char_id to NULL to get the first characteristic.
268 bt_status_t (*get_characteristic)(int conn_id,
269 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *start_char_id);
272 * Enumerate descriptors for a given characteristic.
273 * Set start_descr_id to NULL to get the first descriptor.
275 bt_status_t (*get_descriptor)(int conn_id,
276 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
277 btgatt_gatt_id_t *start_descr_id);
279 /** Read a characteristic on a remote device */
280 bt_status_t (*read_characteristic)(int conn_id,
281 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
284 /** Write a remote characteristic */
285 bt_status_t (*write_characteristic)(int conn_id,
286 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
287 int write_type, int len, int auth_req,
290 /** acquire fd for writing remote characterstics */
291 bt_status_t (*acquire_write)(int conn_id,
292 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
293 int auth_req, int *fd , int *mtu);
295 /** acquire fd for notifying remote characterstics */
296 bt_status_t (*acquire_notify)(int conn_id,
297 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
300 /** Read the descriptor for a given characteristic */
301 bt_status_t (*read_descriptor)(int conn_id,
302 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
303 btgatt_gatt_id_t *descr_id, int auth_req);
305 /** Write a remote descriptor for a given characteristic */
306 bt_status_t (*write_descriptor)(int conn_id,
307 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
308 btgatt_gatt_id_t *descr_id, int write_type, int len,
309 int auth_req, char* p_value);
311 /** Execute a prepared write operation */
312 bt_status_t (*execute_write)(int conn_id, int execute);
315 * Register to receive notifications or indications for a given
318 bt_status_t (*register_for_notification)(int client_if,
319 const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id,
320 btgatt_gatt_id_t *char_id);
322 /** Deregister a previous request for notifications/indications */
323 bt_status_t (*deregister_for_notification)(int client_if,
324 const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id,
325 btgatt_gatt_id_t *char_id);
327 /** Request RSSI for a given remote device */
328 bt_status_t (*read_remote_rssi)(int client_if, const bt_bdaddr_t *bd_addr);
330 /** OTA firmware download */
331 bt_status_t (*ota_fw_update)(int client_if, int conn_id, const bt_bdaddr_t *bd_addr, char* path);
333 /** Determine the type of the remote device (LE, BR/EDR, Dual-mode) */
334 int (*get_device_type)(const bt_bdaddr_t *bd_addr);
336 /** Request a connection parameter update */
337 bt_status_t (*conn_parameter_update)(bt_bdaddr_t *bd, int min_int, int max_int, int latency, int timeout);
339 /** Test mode interface */
340 bt_status_t (*test_command)(int command, btgatt_test_params_t* params);
342 /** MTU Exchange request from client */
343 bt_status_t (*configure_mtu)(int conn_id, int mtu);
345 /** Setup scan filter params */
346 bt_status_t (*scan_filter_param_setup)(int client_if, int action, int filt_index, int feat_seln,
347 int list_logic_type, int filt_logic_type, int rssi_high_thres,
348 int rssi_low_thres, int dely_mode, int found_timeout,
349 int lost_timeout, int found_timeout_cnt);
352 /** Configure a scan filter condition */
353 bt_status_t (*scan_filter_add_remove)(int client_if, int action, int filt_type,
354 int filt_index, int company_id,
355 int company_id_mask, const bt_uuid_t *p_uuid,
356 const bt_uuid_t *p_uuid_mask, const bt_bdaddr_t *bd_addr,
357 char addr_type, int data_len, char* p_data, int mask_len,
360 /** Clear all scan filter conditions for specific filter index*/
361 bt_status_t (*scan_filter_clear)(int client_if, int filt_index);
363 /** Enable / disable scan filter feature*/
364 bt_status_t (*scan_filter_enable)(int client_if, bool enable);
366 /** Sets the LE scan interval and window in units of N*0.625 msec */
368 bt_status_t (*set_scan_parameters)(int scan_type, int scan_interval, int scan_window);
370 bt_status_t (*set_scan_parameters)(int scan_interval, int scan_window);
373 /* Configure the batchscan storage */
374 bt_status_t (*batchscan_cfg_storage)(int client_if, int batch_scan_full_max,
375 int batch_scan_trunc_max, int batch_scan_notify_threshold);
377 /* Enable batchscan */
378 bt_status_t (*batchscan_enb_batch_scan)(int client_if, int scan_mode,
379 int scan_interval, int scan_window, int addr_type, int discard_rule);
381 /* Disable batchscan */
382 bt_status_t (*batchscan_dis_batch_scan)(int client_if);
384 /* Read out batchscan reports */
385 bt_status_t (*batchscan_read_reports)(int client_if, int scan_mode);
387 /** Adds a connection info in list */
388 bt_status_t (*add_connection_info)(const bt_bdaddr_t *bd_addr, int conn_id, int server_inst_id);
389 } btgatt_client_interface_t;
393 #endif /* ANDROID_INCLUDE_BT_GATT_CLIENT_H */