bt-oal/hardware/bt_gatt_server.h

   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_SERVER_H
  19 #define ANDROID_INCLUDE_BT_GATT_SERVER_H
  20
  21 #include <stdint.h>
  22
  23 #include "bt_gatt_types.h"
  24
  25 __BEGIN_DECLS
  26
  27 /** GATT value type used in response to remote read requests */
  28 typedef struct {
  29         uint8_t           value[BTGATT_MAX_ATTR_LEN];
  30         uint16_t          handle;
  31         uint16_t          offset;
  32         uint16_t          len;
  33         uint8_t           auth_req;
  34 } btgatt_value_t;
  35
  36 /** GATT remote read request response type */
  37 typedef union {
  38         btgatt_value_t attr_value;
  39         uint16_t            handle;
  40 } btgatt_response_t;
  41
  42 typedef struct {
  43         uint8_t  server_if;
  44         bool     set_scan_rsp;
  45         bool     include_name;
  46         bool     include_txpower;
  47         uint16_t  appearance;
  48         char*    manufacturer_data;
  49         uint16_t manufacturer_data_len;
  50         char*    service_data;
  51         uint16_t service_data_len;
  52         char*    service_uuid;
  53         uint16_t service_uuid_len;
  54         char*    solicit_uuid;
  55         uint16_t solicit_uuid_len;
  56         uint16_t  min_interval;
  57         uint16_t  max_interval;
  58         uint8_t  adv_type;
  59         uint8_t  chnl_map;
  60         uint8_t  tx_power;
  61         uint8_t  timeout_s;
  62 } btgatt_adv_param_setup_t;
  63
  64
  65 /** BT-GATT Server callback structure. */
  66
  67 /** Callback invoked in response to register_server */
  68 typedef void (*register_server_callback)(int status, int server_if,
  69                 bt_uuid_t *app_uuid);
  70
  71 /** Callback indicating that a remote device has connected or been disconnected */
  72 typedef void (*connection_callback)(int conn_id, int server_if, int connected,
  73                 bt_bdaddr_t *bda);
  74
  75 /** Callback invoked in response to create_service */
  76 typedef void (*service_added_callback)(int status, int server_if,
  77                 btgatt_srvc_id_t *srvc_id, int srvc_handle);
  78
  79 /** Callback indicating that an included service has been added to a service */
  80 typedef void (*included_service_added_callback)(int status, int server_if,
  81                 int srvc_handle, int incl_srvc_handle);
  82
  83 /** Callback invoked when a characteristic has been added to a service */
  84 typedef void (*characteristic_added_callback)(int status, int server_if,
  85                 bt_uuid_t *uuid, int srvc_handle, int char_handle);
  86
  87 /** Callback invoked when a descriptor has been added to a characteristic */
  88 typedef void (*descriptor_added_callback)(int status, int server_if,
  89                 bt_uuid_t *uuid, int srvc_handle, int descr_handle);
  90
  91 /** Callback invoked in response to start_service */
  92 typedef void (*service_started_callback)(int status, int server_if,
  93                 int srvc_handle);
  94
  95 /** Callback invoked in response to stop_service */
  96 typedef void (*service_stopped_callback)(int status, int server_if,
  97                 int srvc_handle);
  98
  99 /** Callback triggered when a service has been deleted */
 100 typedef void (*service_deleted_callback)(int status, int server_if,
 101                 int srvc_handle);
 102
 103 /**
 104  * Callback invoked when indication confirmation
 105  */
 106 typedef void (*indication_confirmation_callback) (int conn_id, int trans_id, int attr_handle, bt_bdaddr_t *bda);
 107
 108 #ifdef TIZEN_BT_HAL
 109 /**
 110  * Callback invoked when indication confirmation
 111  */
 112 typedef void (*notification_enabled_callback) (int conn_id, int trans_id, int attr_handle, bool notify, bt_bdaddr_t *bda);
 113 #endif
 114
 115 /**
 116  * Callback invoked when a remote device has requested to read a characteristic
 117  * or descriptor. The application must respond by calling send_response
 118  */
 119 typedef void (*request_read_callback)(int conn_id, int trans_id, bt_bdaddr_t *bda,
 120                 int attr_handle, int offset, bool is_long);
 121
 122 /**
 123  * Callback invoked when a remote device has requested to write to a
 124  * characteristic or descriptor.
 125  */
 126 typedef void (*request_write_callback)(int conn_id, int trans_id, bt_bdaddr_t *bda,
 127                 int attr_handle, int offset, int length,
 128                 bool need_rsp, bool is_prep, uint8_t* value);
 129
 130 /**
 131  * Callback invoked when a remote device has requested to acqiore write to a
 132  * characteristic .
 133  */
 134 typedef void (*request_acquire_write_callback)(int mtu, int conn_id, int trans_id,
 135                                                                         int attr_handle, bt_bdaddr_t *bda);
 136
 137 /** Callback invoked when a previously prepared write is to be executed */
 138 typedef void (*request_exec_write_callback)(int conn_id, int trans_id,
 139                 bt_bdaddr_t *bda, int exec_write);
 140
 141
 142
 143 /**
 144  * Callback triggered in response to send_response if the remote device
 145  * sends a confirmation.
 146  */
 147 typedef void (*response_confirmation_callback)(int status, int handle);
 148
 149 /**
 150  * Callback indicationg the status of a listen() operation
 151  */
 152 typedef void (*listen_callback)(int status, int server_if);
 153
 154 /** Callback invoked when multi-adv enable operation has completed */
 155 typedef void (*multi_adv_enable_callback)(int server_if, int status);
 156
 157 /** Callback invoked when multi-adv param update operation has completed */
 158 typedef void (*multi_adv_update_callback)(int server_if, int status);
 159
 160 /** Callback invoked when multi-adv instance data set operation has completed */
 161 typedef void (*multi_adv_data_callback)(int server_if, int status);
 162
 163 /** Callback invoked when multi-adv disable operation has completed */
 164 typedef void (*multi_adv_disable_callback)(int server_if, int status);
 165
 166 /** Callback invoked when the MTU for a given connection changes */
 167 typedef void (*mtu_changed_callback)(int conn_id, int mtu);
 168
 169 typedef struct {
 170         register_server_callback        register_server_cb;
 171         connection_callback             connection_cb;
 172         service_added_callback          service_added_cb;
 173         included_service_added_callback included_service_added_cb;
 174         characteristic_added_callback   characteristic_added_cb;
 175         descriptor_added_callback       descriptor_added_cb;
 176         service_started_callback        service_started_cb;
 177         service_stopped_callback        service_stopped_cb;
 178         service_deleted_callback        service_deleted_cb;
 179         indication_confirmation_callback indication_confirmation_cb;
 180         request_read_callback           request_read_cb;
 181         request_write_callback          request_write_cb;
 182         request_exec_write_callback     request_exec_write_cb;
 183         response_confirmation_callback  response_confirmation_cb;
 184         listen_callback                 listen_cb;
 185         multi_adv_enable_callback       multi_adv_enable_cb;
 186         multi_adv_update_callback       multi_adv_update_cb;
 187         multi_adv_data_callback         multi_adv_data_cb;
 188         multi_adv_disable_callback      multi_adv_disable_cb;
 189         mtu_changed_callback            mtu_changed_cb;
 190 #ifdef TIZEN_BT_HAL
 191         notification_enabled_callback   notif_enabled_cb;
 192 #endif
 193         request_acquire_write_callback    request_acquire_write_cb;
 194 } btgatt_server_callbacks_t;
 195
 196 /** Represents the standard BT-GATT server interface. */
 197 typedef struct {
 198         /** Registers a GATT server application with the stack */
 199         bt_status_t (*register_server)(bt_uuid_t *uuid);
 200
 201         /** Unregister a server application from the stack */
 202         bt_status_t (*unregister_server)(int server_if);
 203
 204         /** Create a connection to a remote peripheral */
 205         bt_status_t (*connect)(int server_if, const bt_bdaddr_t *bd_addr, bool is_direct);
 206
 207         /** Disconnect an established connection or cancel a pending one */
 208         bt_status_t (*disconnect)(int server_if, const bt_bdaddr_t *bd_addr,
 209                         int conn_id);
 210
 211         /** Create a new service */
 212         bt_status_t (*add_service)(int server_if, btgatt_srvc_id_t *srvc_id, int num_handles);
 213
 214         /** Assign an included service to it's parent service */
 215         bt_status_t (*add_included_service)(int server_if, int service_handle, int included_handle);
 216
 217         /** Add a characteristic to a service */
 218         bt_status_t (*add_characteristic)(int server_if,
 219                         int service_handle, bt_uuid_t *uuid,
 220                         int properties, int permissions);
 221
 222         /** Add a descriptor to a given service */
 223         bt_status_t (*add_descriptor)(int server_if, int service_handle,
 224                         bt_uuid_t *uuid, int permissions);
 225
 226         /** Starts a local service */
 227         bt_status_t (*start_service)(int server_if, int service_handle,
 228                         int transport);
 229
 230         /** Stops a local service */
 231         bt_status_t (*stop_service)(int server_if, int service_handle);
 232
 233         /** Delete a local service */
 234         bt_status_t (*delete_service)(int server_if, int service_handle);
 235
 236         /** Send value indication to a remote device */
 237         bt_status_t (*send_indication)(int server_if, int attribute_handle,
 238                         int conn_id, int len, int confirm,
 239                         char* p_value);
 240
 241         /** Send a response to a read/write operation */
 242         bt_status_t (*send_response)(int conn_id, int trans_id,
 243                         int status, btgatt_response_t *response);
 244
 245         /** Update GATT server attribute value */
 246         bt_status_t (*update_att_value)(int server_if, int attribute_handle,
 247                         int value_length, char* att_value);
 248
 249         /** Start or stop advertisements to listen for incoming connections */
 250         bt_status_t (*listen)(int server_if, bool start);
 251
 252         /** Set the advertising data or scan response data */
 253         bt_status_t (*set_adv_data)(int server_if, bool set_scan_rsp, bool include_name,
 254                         bool include_txpower, int min_interval, int max_interval, int appearance,
 255                         uint16_t manufacturer_len, char* manufacturer_data,
 256                         uint16_t service_data_len, char* service_data,
 257                         uint16_t service_uuid_len, char* service_uuid);
 258
 259         /* Setup the parameters as per spec, user manual specified values and enable multi ADV */
 260         bt_status_t (*multi_adv_enable)(int server_if);
 261
 262         /* Update the parameters as per spec, user manual specified values and restart multi ADV */
 263         bt_status_t (*multi_adv_update)(int server_if, int min_interval, int max_interval, int adv_type,
 264                         int chnl_map, int tx_power, int timeout_s);
 265
 266         /* Setup the data for the specified instance */
 267         bt_status_t (*multi_adv_set_inst_data)(btgatt_adv_param_setup_t adv_param_setup);
 268
 269         /* Disable the multi adv instance */
 270         bt_status_t (*multi_adv_disable)(int server_if);
 271
 272         /* Get current att mtu size of active connection */
 273         bt_status_t (*get_att_mtu)(int conn_id, int *mtu_size);
 274
 275         /** Send a response to a acquire write/notify  operation */
 276         bt_status_t (*send_response_acquire)(int conn_id, int trans_id,
 277                         int status, int fd, int mtu, void *);
 278 } btgatt_server_interface_t;
 279
 280 __END_DECLS
 281
 282 #endif /* ANDROID_INCLUDE_BT_GATT_SERVER_H */