bt_gatt_client.h revision 9ef3c72ef3e90a93ed641e757310c2a389d32834 
1/*
2 * Copyright (C) 2013 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
18#ifndef ANDROID_INCLUDE_BT_GATT_CLIENT_H
19#define ANDROID_INCLUDE_BT_GATT_CLIENT_H
20
21#include <stdint.h>
22#include "bt_gatt_types.h"
23
24__BEGIN_DECLS
25
26/**
27 * Buffer sizes for maximum attribute length and maximum read/write
28 * operation buffer size.
29 */
30#define BTGATT_MAX_ATTR_LEN 600
31
32/** Buffer type for unformatted reads/writes */
33typedef struct
34{
35    uint8_t             value[BTGATT_MAX_ATTR_LEN];
36    uint16_t            len;
37} btgatt_unformatted_value_t;
38
39/** Parameters for GATT read operations */
40typedef struct
41{
42    btgatt_srvc_id_t    srvc_id;
43    btgatt_gatt_id_t    char_id;
44    btgatt_gatt_id_t    descr_id;
45    btgatt_unformatted_value_t value;
46    uint16_t            value_type;
47    uint8_t             status;
48} btgatt_read_params_t;
49
50/** Parameters for GATT write operations */
51typedef struct
52{
53    btgatt_srvc_id_t    srvc_id;
54    btgatt_gatt_id_t    char_id;
55    btgatt_gatt_id_t    descr_id;
56    uint8_t             status;
57} btgatt_write_params_t;
58
59/** Attribute change notification parameters */
60typedef struct
61{
62    uint8_t             value[BTGATT_MAX_ATTR_LEN];
63    bt_bdaddr_t         bda;
64    btgatt_srvc_id_t    srvc_id;
65    btgatt_gatt_id_t    char_id;
66    uint16_t            len;
67    uint8_t             is_notify;
68} btgatt_notify_params_t;
69
70typedef struct
71{
72    bt_bdaddr_t        *bda1;
73    bt_uuid_t          *uuid1;
74    uint16_t            u1;
75    uint16_t            u2;
76    uint16_t            u3;
77    uint16_t            u4;
78    uint16_t            u5;
79} btgatt_test_params_t;
80
81/** BT-GATT Client callback structure. */
82
83/** Callback invoked in response to register_client */
84typedef void (*register_client_callback)(int status, int client_if,
85                bt_uuid_t *app_uuid);
86
87/** Callback for scan results */
88typedef void (*scan_result_callback)(bt_bdaddr_t* bda, int rssi, uint8_t* adv_data);
89
90/** GATT open callback invoked in response to open */
91typedef void (*connect_callback)(int conn_id, int status, int client_if, bt_bdaddr_t* bda);
92
93/** Callback invoked in response to close */
94typedef void (*disconnect_callback)(int conn_id, int status,
95                int client_if, bt_bdaddr_t* bda);
96
97/**
98 * Invoked in response to search_service when the GATT service search
99 * has been completed.
100 */
101typedef void (*search_complete_callback)(int conn_id, int status);
102
103/** Reports GATT services on a remote device */
104typedef void (*search_result_callback)( int conn_id, btgatt_srvc_id_t *srvc_id);
105
106/** GATT characteristic enumeration result callback */
107typedef void (*get_characteristic_callback)(int conn_id, int status,
108                btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
109                int char_prop);
110
111/** GATT descriptor enumeration result callback */
112typedef void (*get_descriptor_callback)(int conn_id, int status,
113                btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
114                btgatt_gatt_id_t *descr_id);
115
116/** GATT included service enumeration result callback */
117typedef void (*get_included_service_callback)(int conn_id, int status,
118                btgatt_srvc_id_t *srvc_id, btgatt_srvc_id_t *incl_srvc_id);
119
120/** Callback invoked in response to [de]register_for_notification */
121typedef void (*register_for_notification_callback)(int conn_id,
122                int registered, int status, btgatt_srvc_id_t *srvc_id,
123                btgatt_gatt_id_t *char_id);
124
125/**
126 * Remote device notification callback, invoked when a remote device sends
127 * a notification or indication that a client has registered for.
128 */
129typedef void (*notify_callback)(int conn_id, btgatt_notify_params_t *p_data);
130
131/** Reports result of a GATT read operation */
132typedef void (*read_characteristic_callback)(int conn_id, int status,
133                btgatt_read_params_t *p_data);
134
135/** GATT write characteristic operation callback */
136typedef void (*write_characteristic_callback)(int conn_id, int status,
137                btgatt_write_params_t *p_data);
138
139/** GATT execute prepared write callback */
140typedef void (*execute_write_callback)(int conn_id, int status);
141
142/** Callback invoked in response to read_descriptor */
143typedef void (*read_descriptor_callback)(int conn_id, int status,
144                btgatt_read_params_t *p_data);
145
146/** Callback invoked in response to write_descriptor */
147typedef void (*write_descriptor_callback)(int conn_id, int status,
148                btgatt_write_params_t *p_data);
149
150/** Callback triggered in response to read_remote_rssi */
151typedef void (*read_remote_rssi_callback)(int client_if, bt_bdaddr_t* bda,
152                                          int rssi, int status);
153
154/**
155 * Callback indicationg the status of a listen() operation
156 */
157typedef void (*listen_callback)(int status, int server_if);
158
159/** Callback invoked when the MTU for a given connection changes */
160typedef void (*configure_mtu_callback)(int conn_id, int status, int mtu);
161
162/** Callback invoked when a scan filter configuration command has completed */
163typedef void (*scan_filter_callback)(int action, int status);
164
165/** Callback invoked when multi-adv enable operation has completed */
166typedef void (*multi_adv_enable_callback)(int client_if, int status);
167
168/** Callback invoked when multi-adv param update operation has completed */
169typedef void (*multi_adv_update_callback)(int client_if, int status);
170
171/** Callback invoked when multi-adv instance data set operation has completed */
172typedef void (*multi_adv_data_callback)(int client_if, int status);
173
174/** Callback invoked when multi-adv disable operation has completed */
175typedef void (*multi_adv_disable_callback)(int client_if, int status);
176
177/**
178 * Callback notifying an application that a remote device connection is currently congested
179 * and cannot receive any more data. An application should avoid sending more data until
180 * a further callback is received indicating the congestion status has been cleared.
181 */
182typedef void (*congestion_callback)(int conn_id, bool congested);
183
184typedef struct {
185    register_client_callback            register_client_cb;
186    scan_result_callback                scan_result_cb;
187    connect_callback                    open_cb;
188    disconnect_callback                 close_cb;
189    search_complete_callback            search_complete_cb;
190    search_result_callback              search_result_cb;
191    get_characteristic_callback         get_characteristic_cb;
192    get_descriptor_callback             get_descriptor_cb;
193    get_included_service_callback       get_included_service_cb;
194    register_for_notification_callback  register_for_notification_cb;
195    notify_callback                     notify_cb;
196    read_characteristic_callback        read_characteristic_cb;
197    write_characteristic_callback       write_characteristic_cb;
198    read_descriptor_callback            read_descriptor_cb;
199    write_descriptor_callback           write_descriptor_cb;
200    execute_write_callback              execute_write_cb;
201    read_remote_rssi_callback           read_remote_rssi_cb;
202    listen_callback                     listen_cb;
203    configure_mtu_callback              configure_mtu_cb;
204    scan_filter_callback                scan_filter_cb;
205    multi_adv_enable_callback           multi_adv_enable_cb;
206    multi_adv_update_callback           multi_adv_update_cb;
207    multi_adv_data_callback             multi_adv_data_cb;
208    multi_adv_disable_callback          multi_adv_disable_cb;
209    congestion_callback                 congestion_cb;
210} btgatt_client_callbacks_t;
211
212/** Represents the standard BT-GATT client interface. */
213
214typedef struct {
215    /** Registers a GATT client application with the stack */
216    bt_status_t (*register_client)( bt_uuid_t *uuid );
217
218    /** Unregister a client application from the stack */
219    bt_status_t (*unregister_client)(int client_if );
220
221    /** Start or stop LE device scanning */
222    bt_status_t (*scan)( bool start );
223
224    /** Create a connection to a remote LE or dual-mode device */
225    bt_status_t (*connect)( int client_if, const bt_bdaddr_t *bd_addr,
226                         bool is_direct, int transport );
227
228    /** Disconnect a remote device or cancel a pending connection */
229    bt_status_t (*disconnect)( int client_if, const bt_bdaddr_t *bd_addr,
230                    int conn_id);
231
232    /** Start or stop advertisements to listen for incoming connections */
233    bt_status_t (*listen)(int client_if, bool start);
234
235    /** Clear the attribute cache for a given device */
236    bt_status_t (*refresh)( int client_if, const bt_bdaddr_t *bd_addr );
237
238    /**
239     * Enumerate all GATT services on a connected device.
240     * Optionally, the results can be filtered for a given UUID.
241     */
242    bt_status_t (*search_service)(int conn_id, bt_uuid_t *filter_uuid );
243
244    /**
245     * Enumerate included services for a given service.
246     * Set start_incl_srvc_id to NULL to get the first included service.
247     */
248    bt_status_t (*get_included_service)( int conn_id, btgatt_srvc_id_t *srvc_id,
249                                         btgatt_srvc_id_t *start_incl_srvc_id);
250
251    /**
252     * Enumerate characteristics for a given service.
253     * Set start_char_id to NULL to get the first characteristic.
254     */
255    bt_status_t (*get_characteristic)( int conn_id,
256                    btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *start_char_id);
257
258    /**
259     * Enumerate descriptors for a given characteristic.
260     * Set start_descr_id to NULL to get the first descriptor.
261     */
262    bt_status_t (*get_descriptor)( int conn_id,
263                    btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
264                    btgatt_gatt_id_t *start_descr_id);
265
266    /** Read a characteristic on a remote device */
267    bt_status_t (*read_characteristic)( int conn_id,
268                    btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
269                    int auth_req );
270
271    /** Write a remote characteristic */
272    bt_status_t (*write_characteristic)(int conn_id,
273                    btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
274                    int write_type, int len, int auth_req,
275                    char* p_value);
276
277    /** Read the descriptor for a given characteristic */
278    bt_status_t (*read_descriptor)(int conn_id,
279                    btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
280                    btgatt_gatt_id_t *descr_id, int auth_req);
281
282    /** Write a remote descriptor for a given characteristic */
283    bt_status_t (*write_descriptor)( int conn_id,
284                    btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
285                    btgatt_gatt_id_t *descr_id, int write_type, int len,
286                    int auth_req, char* p_value);
287
288    /** Execute a prepared write operation */
289    bt_status_t (*execute_write)(int conn_id, int execute);
290
291    /**
292     * Register to receive notifications or indications for a given
293     * characteristic
294     */
295    bt_status_t (*register_for_notification)( int client_if,
296                    const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id,
297                    btgatt_gatt_id_t *char_id);
298
299    /** Deregister a previous request for notifications/indications */
300    bt_status_t (*deregister_for_notification)( int client_if,
301                    const bt_bdaddr_t *bd_addr, btgatt_srvc_id_t *srvc_id,
302                    btgatt_gatt_id_t *char_id);
303
304    /** Request RSSI for a given remote device */
305    bt_status_t (*read_remote_rssi)( int client_if, const bt_bdaddr_t *bd_addr);
306
307    /** Enable or disable scan filtering */
308    bt_status_t (*scan_filter_enable)( int enable );
309
310    /** Configure a scan filter condition  */
311    bt_status_t (*scan_filter_add)(int type, int company_id, int company_mask,
312                                   int len, const bt_uuid_t *p_uuid, const bt_uuid_t *p_uuid_mask,
313                                   const bt_bdaddr_t *bd_addr, char addr_type, const char* p_value);
314
315    /** Clear all scan filter conditions */
316    bt_status_t (*scan_filter_clear)();
317
318    /** Determine the type of the remote device (LE, BR/EDR, Dual-mode) */
319    int (*get_device_type)( const bt_bdaddr_t *bd_addr );
320
321    /** Set the advertising data or scan response data */
322    bt_status_t (*set_adv_data)(int client_if, bool set_scan_rsp, bool include_name,
323                    bool include_txpower, int min_interval, int max_interval, int appearance,
324                    uint16_t manufacturer_len, char* manufacturer_data,
325                    uint16_t service_data_len, char* service_data,
326                    uint16_t service_uuid_len, char* service_uuid);
327
328    /** Configure the MTU for a given connection */
329    bt_status_t (*configure_mtu)(int conn_id, int mtu);
330
331    /** Sets the LE scan interval and window in units of N*0.625 msec */
332    bt_status_t (*set_scan_parameters)(int scan_interval, int scan_window);
333
334    /* Setup the parameters as per spec, user manual specified values and enable multi ADV */
335    bt_status_t (*multi_adv_enable)(int client_if, int min_interval,int max_interval,int adv_type,
336                 int chnl_map, int tx_power);
337
338    /* Update the parameters as per spec, user manual specified values and restart multi ADV */
339    bt_status_t (*multi_adv_update)(int client_if, int min_interval,int max_interval,int adv_type,
340                 int chnl_map, int tx_power);
341
342    /* Setup the data for the specified instance */
343    bt_status_t (*multi_adv_set_inst_data)(int client_if, bool set_scan_rsp, bool include_name,
344                    bool include_txpower, int appearance, uint16_t manufacturer_len,
345                    char* manufacturer_data, uint16_t service_data_len, char* service_data,
346                    uint16_t service_uuid_len, char* service_uuid);
347
348    /* Disable the multi adv instance */
349    bt_status_t (*multi_adv_disable)(int client_if);
350
351    /** Test mode interface */
352    bt_status_t (*test_command)( int command, btgatt_test_params_t* params);
353
354} btgatt_client_interface_t;
355
356__END_DECLS
357
358#endif /* ANDROID_INCLUDE_BT_GATT_CLIENT_H */
359