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 /** Reports result of a GATT read operation */
136 typedef void (*read_characteristic_callback)(int conn_id, int status,
137 btgatt_read_params_t *p_data);
139 /** GATT write characteristic operation callback */
140 typedef void (*write_characteristic_callback)(int conn_id, int status,
141 btgatt_write_params_t *p_data);
143 /** GATT execute prepared write callback */
144 typedef void (*execute_write_callback)(int conn_id, int status);
146 /** Callback invoked in response to read_descriptor */
147 typedef void (*read_descriptor_callback)(int conn_id, int status,
148 btgatt_read_params_t *p_data);
150 /** Callback invoked in response to write_descriptor */
151 typedef void (*write_descriptor_callback)(int conn_id, int status,
152 btgatt_write_params_t *p_data);
154 /** Callback triggered in response to read_remote_rssi */
155 typedef void (*read_remote_rssi_callback)(int client_if, bt_bdaddr_t* bda,
156 int rssi, int status);
158 /** Callback invoked when the MTU for a given connection changes */
159 typedef void (*configure_mtu_callback)(int conn_id, int status, int mtu);
161 /** Callback invoked when a scan filter configuration command has completed */
162 typedef void (*scan_filter_cfg_callback)(int action, int client_if, int status, int filt_type,
165 /** Callback invoked when scan param has been added, cleared, or deleted */
166 typedef void (*scan_filter_param_callback)(int action, int client_if, int status,
169 /** Callback invoked when a scan filter configuration command has completed */
170 typedef void (*scan_filter_status_callback)(int enable, int client_if, int status);
173 * Callback notifying an application that a remote device connection is currently congested
174 * and cannot receive any more data. An application should avoid sending more data until
175 * a further callback is received indicating the congestion status has been cleared.
177 typedef void (*congestion_callback)(int conn_id, bool congested);
178 /** Callback invoked when batchscan storage config operation has completed */
179 typedef void (*batchscan_cfg_storage_callback)(int client_if, int status);
181 /** Callback invoked when batchscan enable / disable operation has completed */
182 typedef void (*batchscan_enable_disable_callback)(int action, int client_if, int status);
184 /** Callback invoked when batchscan reports are obtained */
185 typedef void (*batchscan_reports_callback)(int client_if, int status, int report_format,
186 int num_records, int data_len, uint8_t* rep_data);
188 /** Callback invoked when batchscan storage threshold limit is crossed */
189 typedef void (*batchscan_threshold_callback)(int client_if);
191 /** Track ADV VSE callback invoked when tracked device is found or lost */
192 typedef void (*track_adv_event_callback)(int client_if, int filt_index, int addr_type,
193 bt_bdaddr_t* bda, int adv_state);
195 register_client_callback register_client_cb;
196 scan_result_callback scan_result_cb;
197 connect_callback open_cb;
198 disconnect_callback close_cb;
199 search_complete_callback search_complete_cb;
200 search_result_callback search_result_cb;
201 get_characteristic_callback get_characteristic_cb;
202 get_descriptor_callback get_descriptor_cb;
203 get_included_service_callback get_included_service_cb;
204 register_for_notification_callback register_for_notification_cb;
205 notify_callback notify_cb;
206 read_characteristic_callback read_characteristic_cb;
207 write_characteristic_callback write_characteristic_cb;
208 read_descriptor_callback read_descriptor_cb;
209 write_descriptor_callback write_descriptor_cb;
210 execute_write_callback execute_write_cb;
211 read_remote_rssi_callback read_remote_rssi_cb;
212 configure_mtu_callback configure_mtu_cb;
213 scan_filter_cfg_callback scan_filter_cfg_cb;
214 scan_filter_param_callback scan_filter_param_cb;
215 scan_filter_status_callback scan_filter_status_cb;
216 congestion_callback congestion_cb;
217 batchscan_cfg_storage_callback batchscan_cfg_storage_cb;
218 batchscan_enable_disable_callback batchscan_enb_disable_cb;
219 batchscan_reports_callback batchscan_reports_cb;
220 batchscan_threshold_callback batchscan_threshold_cb;
221 track_adv_event_callback track_adv_event_cb;
222 } btgatt_client_callbacks_t;
224 /** Represents the standard BT-GATT client interface. */
227 /** Registers a GATT client application with the stack */
228 bt_status_t (*register_client)(bt_uuid_t *uuid);
230 /** Unregister a client application from the stack */
231 bt_status_t (*unregister_client)(int client_if);
233 /** Start or stop LE device scanning */
234 bt_status_t (*scan)(int client_if, bool start);
236 /** Create a connection to a remote LE or dual-mode device */
237 bt_status_t (*connect)(int client_if, const bt_bdaddr_t *bd_addr,
240 /** Disconnect a remote device or cancel a pending connection */
241 bt_status_t (*disconnect)(int client_if, const bt_bdaddr_t *bd_addr,
244 /** Clear the attribute cache for a given device */
245 bt_status_t (*refresh)(int client_if, const bt_bdaddr_t *bd_addr);
248 * Enumerate all GATT services on a connected device.
249 * Optionally, the results can be filtered for a given UUID.
251 bt_status_t (*search_service)(int conn_id, bt_uuid_t *filter_uuid);
254 * Enumerate included services for a given service.
255 * Set start_incl_srvc_id to NULL to get the first included service.
257 bt_status_t (*get_included_service)(int conn_id, btgatt_srvc_id_t *srvc_id,
258 btgatt_srvc_id_t *start_incl_srvc_id);
261 * Enumerate characteristics for a given service.
262 * Set start_char_id to NULL to get the first characteristic.
264 bt_status_t (*get_characteristic)(int conn_id,
265 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *start_char_id);
268 * Enumerate descriptors for a given characteristic.
269 * Set start_descr_id to NULL to get the first descriptor.
271 bt_status_t (*get_descriptor)(int conn_id,
272 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
273 btgatt_gatt_id_t *start_descr_id);
275 /** Read a characteristic on a remote device */
276 bt_status_t (*read_characteristic)(int conn_id,
277 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
280 /** Write a remote characteristic */
281 bt_status_t (*write_characteristic)(int conn_id,
282 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
283 int write_type, int len, int auth_req,
286 /** acquire fd for writing remote characterstics */
287 bt_status_t (*acquire_write)(int conn_id,
288 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
289 int auth_req, int *fd , int *mtu);
291 /** acquire fd for notifying remote characterstics */
292 bt_status_t (*acquire_notify)(int conn_id,
293 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
296 /** Read the descriptor for a given characteristic */
297 bt_status_t (*read_descriptor)(int conn_id,
298 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
299 btgatt_gatt_id_t *descr_id, int auth_req);
301 /** Write a remote descriptor for a given characteristic */
302 bt_status_t (*write_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 write_type, int len,
305 int auth_req, char* p_value);
307 /** Execute a prepared write operation */
308 bt_status_t (*execute_write)(int conn_id, int execute);
311 * Register to receive notifications or indications for a given
314 bt_status_t (*register_for_notification)(int client_if,
315 const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id,
316 btgatt_gatt_id_t *char_id);
318 /** Deregister a previous request for notifications/indications */
319 bt_status_t (*deregister_for_notification)(int client_if,
320 const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id,
321 btgatt_gatt_id_t *char_id);
323 /** Request RSSI for a given remote device */
324 bt_status_t (*read_remote_rssi)(int client_if, const bt_bdaddr_t *bd_addr);
326 /** OTA firmware download */
327 bt_status_t (*ota_fw_update)(int client_if, int conn_id, const bt_bdaddr_t *bd_addr, char* path);
329 /** Determine the type of the remote device (LE, BR/EDR, Dual-mode) */
330 int (*get_device_type)(const bt_bdaddr_t *bd_addr);
332 /** Request a connection parameter update */
333 bt_status_t (*conn_parameter_update)(bt_bdaddr_t *bd, int min_int, int max_int, int latency, int timeout);
335 /** Test mode interface */
336 bt_status_t (*test_command)(int command, btgatt_test_params_t* params);
338 /** MTU Exchange request from client */
339 bt_status_t (*configure_mtu)(int conn_id, int mtu);
341 /** Setup scan filter params */
342 bt_status_t (*scan_filter_param_setup)(int client_if, int action, int filt_index, int feat_seln,
343 int list_logic_type, int filt_logic_type, int rssi_high_thres,
344 int rssi_low_thres, int dely_mode, int found_timeout,
345 int lost_timeout, int found_timeout_cnt);
348 /** Configure a scan filter condition */
349 bt_status_t (*scan_filter_add_remove)(int client_if, int action, int filt_type,
350 int filt_index, int company_id,
351 int company_id_mask, const bt_uuid_t *p_uuid,
352 const bt_uuid_t *p_uuid_mask, const bt_bdaddr_t *bd_addr,
353 char addr_type, int data_len, char* p_data, int mask_len,
356 /** Clear all scan filter conditions for specific filter index*/
357 bt_status_t (*scan_filter_clear)(int client_if, int filt_index);
359 /** Enable / disable scan filter feature*/
360 bt_status_t (*scan_filter_enable)(int client_if, bool enable);
362 /** Sets the LE scan interval and window in units of N*0.625 msec */
364 bt_status_t (*set_scan_parameters)(int scan_type, int scan_interval, int scan_window);
366 bt_status_t (*set_scan_parameters)(int scan_interval, int scan_window);
369 /* Configure the batchscan storage */
370 bt_status_t (*batchscan_cfg_storage)(int client_if, int batch_scan_full_max,
371 int batch_scan_trunc_max, int batch_scan_notify_threshold);
373 /* Enable batchscan */
374 bt_status_t (*batchscan_enb_batch_scan)(int client_if, int scan_mode,
375 int scan_interval, int scan_window, int addr_type, int discard_rule);
377 /* Disable batchscan */
378 bt_status_t (*batchscan_dis_batch_scan)(int client_if);
380 /* Read out batchscan reports */
381 bt_status_t (*batchscan_read_reports)(int client_if, int scan_mode);
383 } btgatt_client_interface_t;
387 #endif /* ANDROID_INCLUDE_BT_GATT_CLIENT_H */