blob: 43228523535db8e32a3dd50cf1957fd8d629ccf1 [file] [log] [blame]
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -08001/*
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>
Jakub Pawlowski620fd712016-05-27 16:36:24 -070022#include <vector>
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -080023#include "bt_gatt_types.h"
Satya Callojia8b49d32015-02-10 09:20:07 -080024#include "bt_common_types.h"
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -080025
26__BEGIN_DECLS
27
28/**
29 * Buffer sizes for maximum attribute length and maximum read/write
30 * operation buffer size.
31 */
32#define BTGATT_MAX_ATTR_LEN 600
33
34/** Buffer type for unformatted reads/writes */
35typedef struct
36{
37 uint8_t value[BTGATT_MAX_ATTR_LEN];
38 uint16_t len;
39} btgatt_unformatted_value_t;
40
41/** Parameters for GATT read operations */
42typedef struct
43{
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -070044 uint16_t handle;
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -080045 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;
Andre Eisenbach02223d12013-07-09 00:02:48 -070054 btgatt_gatt_id_t char_id;
55 btgatt_gatt_id_t descr_id;
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -080056 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;
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -070064 uint16_t handle;
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -080065 uint16_t len;
66 uint8_t is_notify;
67} btgatt_notify_params_t;
68
69typedef struct
70{
Satya Callojia8b49d32015-02-10 09:20:07 -080071 uint8_t client_if;
72 uint8_t action;
73 uint8_t filt_index;
74 uint16_t feat_seln;
75 uint16_t list_logic_type;
76 uint8_t filt_logic_type;
77 uint8_t rssi_high_thres;
78 uint8_t rssi_low_thres;
79 uint8_t dely_mode;
80 uint16_t found_timeout;
81 uint16_t lost_timeout;
82 uint8_t found_timeout_cnt;
83 uint16_t num_of_tracking_entries;
84} btgatt_filt_param_setup_t;
85
86typedef struct
87{
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -080088 bt_bdaddr_t *bda1;
89 bt_uuid_t *uuid1;
90 uint16_t u1;
91 uint16_t u2;
92 uint16_t u3;
93 uint16_t u4;
94 uint16_t u5;
95} btgatt_test_params_t;
96
Satya Calloji51225022015-03-31 13:58:21 -070097/* BT GATT client error codes */
98typedef enum
99{
100 BT_GATTC_COMMAND_SUCCESS = 0, /* 0 Command succeeded */
101 BT_GATTC_COMMAND_STARTED, /* 1 Command started OK. */
102 BT_GATTC_COMMAND_BUSY, /* 2 Device busy with another command */
103 BT_GATTC_COMMAND_STORED, /* 3 request is stored in control block */
104 BT_GATTC_NO_RESOURCES, /* 4 No resources to issue command */
105 BT_GATTC_MODE_UNSUPPORTED, /* 5 Request for 1 or more unsupported modes */
106 BT_GATTC_ILLEGAL_VALUE, /* 6 Illegal command /parameter value */
107 BT_GATTC_INCORRECT_STATE, /* 7 Device in wrong state for request */
108 BT_GATTC_UNKNOWN_ADDR, /* 8 Unknown remote BD address */
109 BT_GATTC_DEVICE_TIMEOUT, /* 9 Device timeout */
110 BT_GATTC_INVALID_CONTROLLER_OUTPUT,/* 10 An incorrect value was received from HCI */
111 BT_GATTC_SECURITY_ERROR, /* 11 Authorization or security failure or not authorized */
112 BT_GATTC_DELAYED_ENCRYPTION_CHECK, /*12 Delayed encryption check */
113 BT_GATTC_ERR_PROCESSING /* 12 Generic error */
114} btgattc_error_t;
115
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800116/** BT-GATT Client callback structure. */
117
118/** Callback invoked in response to register_client */
119typedef void (*register_client_callback)(int status, int client_if,
120 bt_uuid_t *app_uuid);
121
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800122/** GATT open callback invoked in response to open */
123typedef void (*connect_callback)(int conn_id, int status, int client_if, bt_bdaddr_t* bda);
124
125/** Callback invoked in response to close */
126typedef void (*disconnect_callback)(int conn_id, int status,
127 int client_if, bt_bdaddr_t* bda);
128
129/**
130 * Invoked in response to search_service when the GATT service search
131 * has been completed.
132 */
133typedef void (*search_complete_callback)(int conn_id, int status);
134
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800135/** Callback invoked in response to [de]register_for_notification */
136typedef void (*register_for_notification_callback)(int conn_id,
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700137 int registered, int status, uint16_t handle);
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800138
139/**
140 * Remote device notification callback, invoked when a remote device sends
141 * a notification or indication that a client has registered for.
142 */
143typedef void (*notify_callback)(int conn_id, btgatt_notify_params_t *p_data);
144
145/** Reports result of a GATT read operation */
146typedef void (*read_characteristic_callback)(int conn_id, int status,
147 btgatt_read_params_t *p_data);
148
149/** GATT write characteristic operation callback */
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700150typedef void (*write_characteristic_callback)(int conn_id, int status, uint16_t handle);
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800151
152/** GATT execute prepared write callback */
153typedef void (*execute_write_callback)(int conn_id, int status);
154
155/** Callback invoked in response to read_descriptor */
156typedef void (*read_descriptor_callback)(int conn_id, int status,
157 btgatt_read_params_t *p_data);
158
159/** Callback invoked in response to write_descriptor */
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700160typedef void (*write_descriptor_callback)(int conn_id, int status, uint16_t handle);
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800161
162/** Callback triggered in response to read_remote_rssi */
163typedef void (*read_remote_rssi_callback)(int client_if, bt_bdaddr_t* bda,
164 int rssi, int status);
165
Andre Eisenbach8a4b61a2014-03-25 06:30:05 -0700166/** Callback invoked when the MTU for a given connection changes */
167typedef void (*configure_mtu_callback)(int conn_id, int status, int mtu);
168
Andre Eisenbach709f2392013-12-16 16:16:54 -0800169
Andre Eisenbach9ef3c722014-03-28 14:53:33 -0700170/**
171 * Callback notifying an application that a remote device connection is currently congested
172 * and cannot receive any more data. An application should avoid sending more data until
173 * a further callback is received indicating the congestion status has been cleared.
174 */
175typedef void (*congestion_callback)(int conn_id, bool congested);
Satya Calloji51225022015-03-31 13:58:21 -0700176
Jakub Pawlowskif2e13522016-01-21 23:40:51 -0800177/** GATT get database callback */
178typedef void (*get_gatt_db_callback)(int conn_id, btgatt_db_element_t *db, int count);
179
Jakub Pawlowski83e598f2016-02-10 15:31:14 -0800180/** GATT services between start_handle and end_handle were removed */
181typedef void (*services_removed_callback)(int conn_id, uint16_t start_handle, uint16_t end_handle);
182
183/** GATT services were added */
184typedef void (*services_added_callback)(int conn_id, btgatt_db_element_t *added, int added_count);
185
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800186typedef struct {
187 register_client_callback register_client_cb;
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800188 connect_callback open_cb;
189 disconnect_callback close_cb;
190 search_complete_callback search_complete_cb;
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800191 register_for_notification_callback register_for_notification_cb;
192 notify_callback notify_cb;
193 read_characteristic_callback read_characteristic_cb;
194 write_characteristic_callback write_characteristic_cb;
195 read_descriptor_callback read_descriptor_cb;
196 write_descriptor_callback write_descriptor_cb;
197 execute_write_callback execute_write_cb;
198 read_remote_rssi_callback read_remote_rssi_cb;
Andre Eisenbach8a4b61a2014-03-25 06:30:05 -0700199 configure_mtu_callback configure_mtu_cb;
Andre Eisenbach9ef3c722014-03-28 14:53:33 -0700200 congestion_callback congestion_cb;
Jakub Pawlowskif2e13522016-01-21 23:40:51 -0800201 get_gatt_db_callback get_gatt_db_cb;
Jakub Pawlowski83e598f2016-02-10 15:31:14 -0800202 services_removed_callback services_removed_cb;
203 services_added_callback services_added_cb;
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800204} btgatt_client_callbacks_t;
205
206/** Represents the standard BT-GATT client interface. */
207
208typedef struct {
209 /** Registers a GATT client application with the stack */
210 bt_status_t (*register_client)( bt_uuid_t *uuid );
211
212 /** Unregister a client application from the stack */
213 bt_status_t (*unregister_client)(int client_if );
214
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800215 /** Create a connection to a remote LE or dual-mode device */
216 bt_status_t (*connect)( int client_if, const bt_bdaddr_t *bd_addr,
Ganesh Ganapathi Battaf9f4d102014-04-18 10:02:49 -0700217 bool is_direct, int transport );
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800218
219 /** Disconnect a remote device or cancel a pending connection */
220 bt_status_t (*disconnect)( int client_if, const bt_bdaddr_t *bd_addr,
221 int conn_id);
222
223 /** Clear the attribute cache for a given device */
224 bt_status_t (*refresh)( int client_if, const bt_bdaddr_t *bd_addr );
225
226 /**
227 * Enumerate all GATT services on a connected device.
228 * Optionally, the results can be filtered for a given UUID.
229 */
230 bt_status_t (*search_service)(int conn_id, bt_uuid_t *filter_uuid );
231
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800232 /** Read a characteristic on a remote device */
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700233 bt_status_t (*read_characteristic)( int conn_id, uint16_t handle,
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800234 int auth_req );
235
236 /** Write a remote characteristic */
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700237 bt_status_t (*write_characteristic)(int conn_id, uint16_t handle,
Jakub Pawlowski620fd712016-05-27 16:36:24 -0700238 int write_type, int auth_req,
Pavlin Radoslavov44d57d42016-12-09 17:55:30 -0800239 std::vector<uint8_t> value);
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800240
241 /** Read the descriptor for a given characteristic */
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700242 bt_status_t (*read_descriptor)(int conn_id, uint16_t handle, int auth_req);
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800243
244 /** Write a remote descriptor for a given characteristic */
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700245 bt_status_t (*write_descriptor)( int conn_id, uint16_t handle,
Pavlin Radoslavov44d57d42016-12-09 17:55:30 -0800246 int auth_req, std::vector<uint8_t> value);
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800247
248 /** Execute a prepared write operation */
249 bt_status_t (*execute_write)(int conn_id, int execute);
250
251 /**
252 * Register to receive notifications or indications for a given
253 * characteristic
254 */
255 bt_status_t (*register_for_notification)( int client_if,
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700256 const bt_bdaddr_t *bd_addr, uint16_t handle);
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800257
258 /** Deregister a previous request for notifications/indications */
259 bt_status_t (*deregister_for_notification)( int client_if,
Jakub Pawlowski1d02bde2016-03-17 15:57:03 -0700260 const bt_bdaddr_t *bd_addr, uint16_t handle);
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800261
262 /** Request RSSI for a given remote device */
263 bt_status_t (*read_remote_rssi)( int client_if, const bt_bdaddr_t *bd_addr);
264
265 /** Determine the type of the remote device (LE, BR/EDR, Dual-mode) */
266 int (*get_device_type)( const bt_bdaddr_t *bd_addr );
267
Andre Eisenbach8a4b61a2014-03-25 06:30:05 -0700268 /** Configure the MTU for a given connection */
269 bt_status_t (*configure_mtu)(int conn_id, int mtu);
270
Andre Eisenbachda4eaca2014-07-16 22:58:36 -0700271 /** Request a connection parameter update */
272 bt_status_t (*conn_parameter_update)(const bt_bdaddr_t *bd_addr, int min_interval,
273 int max_interval, int latency, int timeout);
274
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800275 /** Test mode interface */
276 bt_status_t (*test_command)( int command, btgatt_test_params_t* params);
Ganesh Ganapathi Battaf9f4d102014-04-18 10:02:49 -0700277
Jakub Pawlowskif2e13522016-01-21 23:40:51 -0800278 /** Get gatt db content */
279 bt_status_t (*get_gatt_db)( int conn_id);
280
Ganesh Ganapathi Battafefb3342013-02-05 15:23:45 -0800281} btgatt_client_interface_t;
282
283__END_DECLS
284
285#endif /* ANDROID_INCLUDE_BT_GATT_CLIENT_H */