hardware/bt_gatt_client.h

   1 /*
   2  * Copyright (C) 2013 The Android Open Source Project
   3  * Copyright (C) 2009-2014 Broadcom Corporation
   4  *
   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
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18
  19 #ifndef ANDROID_INCLUDE_BT_GATT_CLIENT_H
  20 #define ANDROID_INCLUDE_BT_GATT_CLIENT_H
  21
  22 #include <stdint.h>
  23 #include "bt_gatt_types.h"
  24
  25 __BEGIN_DECLS
  26
  27 #ifdef TIZEN_BT_HAL
  28 #define BT_GATTC_LE_SCAN_TYPE_PASSIVE   0x00
  29 #define BT_GATTC_LE_SCAN_TYPE_ACTIVE    0x01
  30 #endif
  31
  32 /** Buffer type for unformatted reads/writes */
  33 typedef struct {
  34         uint8_t             value[BTGATT_MAX_ATTR_LEN];
  35         uint16_t            len;
  36 } btgatt_unformatted_value_t;
  37
  38 /** Parameters for GATT read operations */
  39 typedef struct {
  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;
  44         uint16_t            value_type;
  45         uint8_t             status;
  46 } btgatt_read_params_t;
  47
  48 /** Parameters for GATT write operations */
  49 typedef struct {
  50         btgatt_srvc_id_t    srvc_id;
  51         btgatt_gatt_id_t    char_id;
  52         btgatt_gatt_id_t    descr_id;
  53         uint8_t             status;
  54 } btgatt_write_params_t;
  55
  56 /** Attribute change notification parameters */
  57 typedef struct {
  58         uint8_t             value[BTGATT_MAX_ATTR_LEN];
  59         bt_bdaddr_t         bda;
  60         btgatt_srvc_id_t    srvc_id;
  61         btgatt_gatt_id_t    char_id;
  62         uint16_t            len;
  63         uint8_t             is_notify;
  64 } btgatt_notify_params_t;
  65
  66 typedef struct {
  67         bt_bdaddr_t        *bda1;
  68         bt_uuid_t          *uuid1;
  69         uint16_t            u1;
  70         uint16_t            u2;
  71         uint16_t            u3;
  72         uint16_t            u4;
  73         uint16_t            u5;
  74 } btgatt_test_params_t;
  75
  76 /** BT-GATT Client callback structure. */
  77
  78 /** Callback invoked in response to register_client */
  79 typedef void (*register_client_callback)(int status, int client_if,
  80                 bt_uuid_t *app_uuid);
  81
  82 /** Callback for scan results */
  83 typedef void (*scan_result_callback)(bt_bdaddr_t* bda, int rssi, uint8_t* adv_data);
  84
  85 /** GATT open callback invoked in response to open */
  86 typedef void (*connect_callback)(int conn_id, int status, int client_if, bt_bdaddr_t* bda);
  87
  88 /** Callback invoked in response to close */
  89 typedef void (*disconnect_callback)(int conn_id, int status,
  90                 int client_if, bt_bdaddr_t* bda);
  91
  92 /**
  93  * Invoked in response to search_service when the GATT service search
  94  * has been completed.
  95  */
  96 typedef void (*search_complete_callback)(int conn_id, int status);
  97
  98 /** Reports GATT services on a remote device */
  99 typedef void (*search_result_callback)(int conn_id, btgatt_srvc_id_t *srvc_id);
 100
 101 /** GATT characteristic enumeration result callback */
 102 typedef void (*get_characteristic_callback)(int conn_id, int status,
 103                 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
 104                 int char_prop);
 105
 106 /** GATT descriptor enumeration result callback */
 107 typedef void (*get_descriptor_callback)(int conn_id, int status,
 108                 btgatt_srvc_id_t *srvc_id, btgatt_gatt_id_t *char_id,
 109                 btgatt_gatt_id_t *descr_id);
 110
 111 /** GATT included service enumeration result callback */
 112 typedef void (*get_included_service_callback)(int conn_id, int status,
 113                 btgatt_srvc_id_t *srvc_id, btgatt_srvc_id_t *incl_srvc_id);
 114
 115 /** Callback invoked in response to [de]register_for_notification */
 116 typedef void (*register_for_notification_callback)(int conn_id,
 117                 int registered, int status, btgatt_srvc_id_t *srvc_id,
 118                 btgatt_gatt_id_t *char_id);
 119
 120 /**
 121  * Remote device notification callback, invoked when a remote device sends
 122  * a notification or indication that a client has registered for.
 123  */
 124 typedef void (*notify_callback)(int conn_id, btgatt_notify_params_t *p_data);
 125
 126 /** Reports result of a GATT read operation */
 127 typedef void (*read_characteristic_callback)(int conn_id, int status,
 128                 btgatt_read_params_t *p_data);
 129
 130 /** GATT write characteristic operation callback */
 131 typedef void (*write_characteristic_callback)(int conn_id, int status,
 132                 btgatt_write_params_t *p_data);
 133
 134 /** GATT execute prepared write callback */
 135 typedef void (*execute_write_callback)(int conn_id, int status);
 136
 137 /** Callback invoked in response to read_descriptor */
 138 typedef void (*read_descriptor_callback)(int conn_id, int status,
 139                 btgatt_read_params_t *p_data);
 140
 141 /** Callback invoked in response to write_descriptor */
 142 typedef void (*write_descriptor_callback)(int conn_id, int status,
 143                 btgatt_write_params_t *p_data);
 144
 145 /** Callback triggered in response to read_remote_rssi */
 146 typedef void (*read_remote_rssi_callback)(int client_if, bt_bdaddr_t* bda,
 147                 int rssi, int status);
 148
 149 /** Callback invoked when the MTU for a given connection changes */
 150 typedef void (*configure_mtu_callback)(int conn_id, int status, int mtu);
 151
 152 /** Callback invoked when a scan filter configuration command has completed */
 153 typedef void (*scan_filter_cfg_callback)(int action, int client_if, int status, int filt_type,
 154                 int avbl_space);
 155
 156 /** Callback invoked when scan param has been added, cleared, or deleted */
 157 typedef void (*scan_filter_param_callback)(int action, int client_if, int status,
 158                 int avbl_space);
 159
 160 /** Callback invoked when a scan filter configuration command has completed */
 161 typedef void (*scan_filter_status_callback)(int enable, int client_if, int status);
 162
 163 /**
 164  * Callback notifying an application that a remote device connection is currently congested
 165  * and cannot receive any more data. An application should avoid sending more data until
 166  * a further callback is received indicating the congestion status has been cleared.
 167  */
 168 typedef void (*congestion_callback)(int conn_id, bool congested);
 169 /** Callback invoked when batchscan storage config operation has completed */
 170 typedef void (*batchscan_cfg_storage_callback)(int client_if, int status);
 171
 172 /** Callback invoked when batchscan enable / disable operation has completed */
 173 typedef void (*batchscan_enable_disable_callback)(int action, int client_if, int status);
 174
 175 /** Callback invoked when batchscan reports are obtained */
 176 typedef void (*batchscan_reports_callback)(int client_if, int status, int report_format,
 177                 int num_records, int data_len, uint8_t* rep_data);
 178
 179 /** Callback invoked when batchscan storage threshold limit is crossed */
 180 typedef void (*batchscan_threshold_callback)(int client_if);
 181
 182 /** Track ADV VSE callback invoked when tracked device is found or lost */
 183 typedef void (*track_adv_event_callback)(int client_if, int filt_index, int addr_type,
 184                 bt_bdaddr_t* bda, int adv_state);
 185 typedef struct {
 186         register_client_callback            register_client_cb;
 187         scan_result_callback                scan_result_cb;
 188         connect_callback                    open_cb;
 189         disconnect_callback                 close_cb;
 190         search_complete_callback            search_complete_cb;
 191         search_result_callback              search_result_cb;
 192         get_characteristic_callback         get_characteristic_cb;
 193         get_descriptor_callback             get_descriptor_cb;
 194         get_included_service_callback       get_included_service_cb;
 195         register_for_notification_callback  register_for_notification_cb;
 196         notify_callback                     notify_cb;
 197         read_characteristic_callback        read_characteristic_cb;
 198         write_characteristic_callback       write_characteristic_cb;
 199         read_descriptor_callback            read_descriptor_cb;
 200         write_descriptor_callback           write_descriptor_cb;
 201         execute_write_callback              execute_write_cb;
 202         read_remote_rssi_callback           read_remote_rssi_cb;
 203         configure_mtu_callback              configure_mtu_cb;
 204         scan_filter_cfg_callback            scan_filter_cfg_cb;
 205         scan_filter_param_callback          scan_filter_param_cb;
 206         scan_filter_status_callback         scan_filter_status_cb;
 207         congestion_callback                 congestion_cb;
 208         batchscan_cfg_storage_callback      batchscan_cfg_storage_cb;
 209         batchscan_enable_disable_callback   batchscan_enb_disable_cb;
 210         batchscan_reports_callback          batchscan_reports_cb;
 211         batchscan_threshold_callback        batchscan_threshold_cb;
 212         track_adv_event_callback            track_adv_event_cb;
 213 } btgatt_client_callbacks_t;
 214
 215 /** Represents the standard BT-GATT client interface. */
 216
 217 typedef struct {
 218         /** Registers a GATT client application with the stack */
 219         bt_status_t (*register_client)(bt_uuid_t *uuid);
 220
 221         /** Unregister a client application from the stack */
 222         bt_status_t (*unregister_client)(int client_if);
 223
 224         /** Start or stop LE device scanning */
 225         bt_status_t (*scan)(int client_if, bool start);
 226
 227         /** Create a connection to a remote LE or dual-mode device */
 228         bt_status_t (*connect)(int client_if, const bt_bdaddr_t *bd_addr,
 229                         bool is_direct);
 230
 231         /** Disconnect a remote device or cancel a pending connection */
 232         bt_status_t (*disconnect)(int client_if, const bt_bdaddr_t *bd_addr,
 233                         int conn_id);
 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         /** OTA firmware download */
 308         bt_status_t (*ota_fw_update)(int client_if, int conn_id, const bt_bdaddr_t *bd_addr, char* path);
 309
 310         /** Determine the type of the remote device (LE, BR/EDR, Dual-mode) */
 311         int (*get_device_type)(const bt_bdaddr_t *bd_addr);
 312
 313         /** Request a connection parameter update */
 314         bt_status_t (*conn_parameter_update)(bt_bdaddr_t *bd, int min_int, int max_int, int latency, int timeout);
 315
 316         /** Test mode interface */
 317         bt_status_t (*test_command)(int command, btgatt_test_params_t* params);
 318
 319         /** MTU Exchange request from client */
 320         bt_status_t (*configure_mtu)(int conn_id, int mtu);
 321
 322         /** Setup scan filter params */
 323         bt_status_t (*scan_filter_param_setup)(int client_if, int action, int filt_index, int feat_seln,
 324                         int list_logic_type, int filt_logic_type, int rssi_high_thres,
 325                         int rssi_low_thres, int dely_mode, int found_timeout,
 326                         int lost_timeout, int found_timeout_cnt);
 327
 328
 329         /** Configure a scan filter condition  */
 330         bt_status_t (*scan_filter_add_remove)(int client_if, int action, int filt_type,
 331                         int filt_index, int company_id,
 332                         int company_id_mask, const bt_uuid_t *p_uuid,
 333                         const bt_uuid_t *p_uuid_mask, const bt_bdaddr_t *bd_addr,
 334                         char addr_type, int data_len, char* p_data, int mask_len,
 335                         char* p_mask);
 336
 337         /** Clear all scan filter conditions for specific filter index*/
 338         bt_status_t (*scan_filter_clear)(int client_if, int filt_index);
 339
 340         /** Enable / disable scan filter feature*/
 341         bt_status_t (*scan_filter_enable)(int client_if, bool enable);
 342
 343         /** Sets the LE scan interval and window in units of N*0.625 msec */
 344 #ifdef TIZEN_BT_HAL
 345         bt_status_t (*set_scan_parameters)(int scan_type, int scan_interval, int scan_window);
 346 #else
 347         bt_status_t (*set_scan_parameters)(int scan_interval, int scan_window);
 348 #endif
 349
 350         /* Configure the batchscan storage */
 351         bt_status_t (*batchscan_cfg_storage)(int client_if, int batch_scan_full_max,
 352                         int batch_scan_trunc_max, int batch_scan_notify_threshold);
 353
 354         /* Enable batchscan */
 355         bt_status_t (*batchscan_enb_batch_scan)(int client_if, int scan_mode,
 356                         int scan_interval, int scan_window, int addr_type, int discard_rule);
 357
 358         /* Disable batchscan */
 359         bt_status_t (*batchscan_dis_batch_scan)(int client_if);
 360
 361         /* Read out batchscan reports */
 362         bt_status_t (*batchscan_read_reports)(int client_if, int scan_mode);
 363
 364 } btgatt_client_interface_t;
 365
 366 __END_DECLS
 367
 368 #endif /* ANDROID_INCLUDE_BT_GATT_CLIENT_H */