1 /******************************************************************************
3 * Copyright (C) 2003-2012 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.
17 ******************************************************************************/
19 /******************************************************************************
21 * This is the private file for the file transfer client (FTC).
23 ******************************************************************************/
24 #ifndef BTA_GATTC_INT_H
25 #define BTA_GATTC_INT_H
27 #include "bt_target.h"
29 #include "osi/include/fixed_queue.h"
31 #include "bta_gatt_api.h"
33 #include "bt_common.h"
35 /*****************************************************************************
36 ** Constants and data types
37 *****************************************************************************/
40 BTA_GATTC_API_OPEN_EVT = BTA_SYS_EVT_START(BTA_ID_GATTC),
41 BTA_GATTC_INT_OPEN_FAIL_EVT,
42 BTA_GATTC_API_CANCEL_OPEN_EVT,
43 BTA_GATTC_INT_CANCEL_OPEN_OK_EVT,
45 BTA_GATTC_API_READ_EVT,
46 BTA_GATTC_API_WRITE_EVT,
47 BTA_GATTC_API_EXEC_EVT,
48 BTA_GATTC_API_CFG_MTU_EVT,
50 BTA_GATTC_API_CLOSE_EVT,
52 BTA_GATTC_API_SEARCH_EVT,
53 BTA_GATTC_API_CONFIRM_EVT,
54 BTA_GATTC_API_READ_MULTI_EVT,
55 BTA_GATTC_API_REFRESH_EVT,
57 BTA_GATTC_INT_CONN_EVT,
58 BTA_GATTC_INT_DISCOVER_EVT,
59 BTA_GATTC_DISCOVER_CMPL_EVT,
60 BTA_GATTC_OP_CMPL_EVT,
61 BTA_GATTC_INT_DISCONN_EVT,
63 BTA_GATTC_INT_START_IF_EVT,
64 BTA_GATTC_API_REG_EVT,
65 BTA_GATTC_API_DEREG_EVT,
66 BTA_GATTC_API_LISTEN_EVT,
67 BTA_GATTC_API_BROADCAST_EVT,
68 BTA_GATTC_API_DISABLE_EVT,
69 BTA_GATTC_ENC_CMPL_EVT
71 typedef UINT16 tBTA_GATTC_INT_EVT;
73 #define BTA_GATTC_SERVICE_CHANGED_LEN 4
75 /* max client application GATTC can support */
76 #ifndef BTA_GATTC_CL_MAX
77 #define BTA_GATTC_CL_MAX 32
80 /* max known devices GATTC can support */
81 #ifndef BTA_GATTC_KNOWN_SR_MAX
82 #ifndef MAX_ACL_CONNECTIONS
83 #define BTA_GATTC_KNOWN_SR_MAX 10
85 #define BTA_GATTC_KNOWN_SR_MAX MAX_ACL_CONNECTIONS
89 #define BTA_GATTC_CONN_MAX GATT_MAX_PHY_CHANNEL
91 #ifndef BTA_GATTC_CLCB_MAX
92 #define BTA_GATTC_CLCB_MAX GATT_CL_MAX_LCB
95 #define BTA_GATTC_WRITE_PREPARE GATT_WRITE_PREPARE
98 /* internal strucutre for GATTC register API */
103 tBTA_GATTC_CBACK *p_cback;
109 tBTA_GATTC_IF client_if;
110 }tBTA_GATTC_INT_START_IF;
112 typedef tBTA_GATTC_INT_START_IF tBTA_GATTC_API_DEREG;
113 typedef tBTA_GATTC_INT_START_IF tBTA_GATTC_INT_DEREG;
119 tBTA_GATTC_IF client_if;
121 tBTA_TRANSPORT transport;
122 } tBTA_GATTC_API_OPEN;
124 typedef tBTA_GATTC_API_OPEN tBTA_GATTC_API_CANCEL_OPEN;
129 tBTA_GATT_AUTH_REQ auth_req;
131 tBTA_GATTC_EVT cmpl_evt;
132 } tBTA_GATTC_API_READ;
137 tBTA_GATT_AUTH_REQ auth_req;
139 tBTA_GATTC_EVT cmpl_evt;
140 tBTA_GATTC_WRITE_TYPE write_type;
144 }tBTA_GATTC_API_WRITE;
150 }tBTA_GATTC_API_EXEC;
156 } tBTA_GATTC_API_CONFIRM;
158 typedef tGATT_CL_COMPLETE tBTA_GATTC_CMPL;
165 tBTA_GATTC_CMPL *p_cmpl;
171 tBT_UUID *p_srvc_uuid;
172 }tBTA_GATTC_API_SEARCH;
177 tBTA_GATT_AUTH_REQ auth_req;
179 UINT16 handles[GATT_MAX_READ_MULTI_HANDLES];
180 }tBTA_GATTC_API_READ_MULTI;
185 BD_ADDR_PTR remote_bda;
186 tBTA_GATTC_IF client_if;
188 } tBTA_GATTC_API_LISTEN;
195 }tBTA_GATTC_API_CFG_MTU;
201 tBTA_GATTC_IF client_if;
203 tBT_TRANSPORT transport;
204 tGATT_DISCONN_REASON reason;
205 }tBTA_GATTC_INT_CONN;
211 tBTA_GATTC_IF client_if;
212 }tBTA_GATTC_ENC_CMPL;
217 tBTA_GATTC_API_REG api_reg;
218 tBTA_GATTC_API_DEREG api_dereg;
219 tBTA_GATTC_API_OPEN api_conn;
220 tBTA_GATTC_API_CANCEL_OPEN api_cancel_conn;
221 tBTA_GATTC_API_READ api_read;
222 tBTA_GATTC_API_SEARCH api_search;
223 tBTA_GATTC_API_WRITE api_write;
224 tBTA_GATTC_API_CONFIRM api_confirm;
225 tBTA_GATTC_API_EXEC api_exec;
226 tBTA_GATTC_API_READ_MULTI api_read_multi;
227 tBTA_GATTC_API_CFG_MTU api_mtu;
228 tBTA_GATTC_OP_CMPL op_cmpl;
229 tBTA_GATTC_INT_CONN int_conn;
230 tBTA_GATTC_ENC_CMPL enc_cmpl;
232 tBTA_GATTC_INT_START_IF int_start_if;
233 tBTA_GATTC_INT_DEREG int_dereg;
234 /* if peripheral role is supported */
235 tBTA_GATTC_API_LISTEN api_listen;
240 /* GATT server cache on the client */
247 // this field is set only for characteristic
248 UINT16 char_decl_handle;
250 tBTA_GATT_CHAR_PROP property;
251 }tBTA_GATTC_ATTR_REC;
254 #define BTA_GATTC_MAX_CACHE_CHAR 40
255 #define BTA_GATTC_ATTR_LIST_SIZE (BTA_GATTC_MAX_CACHE_CHAR * sizeof(tBTA_GATTC_ATTR_REC))
257 #ifndef BTA_GATTC_CACHE_SRVR_SIZE
258 #define BTA_GATTC_CACHE_SRVR_SIZE 600
263 BTA_GATTC_IDLE_ST = 0, /* Idle */
264 BTA_GATTC_W4_CONN_ST, /* Wait for connection - (optional) */
265 BTA_GATTC_CONN_ST, /* connected state */
266 BTA_GATTC_DISCOVER_ST /* discover is in progress */
268 typedef UINT8 tBTA_GATTC_STATE;
276 #define BTA_GATTC_SERV_IDLE 0
277 #define BTA_GATTC_SERV_LOAD 1
278 #define BTA_GATTC_SERV_SAVE 2
279 #define BTA_GATTC_SERV_DISC 3
280 #define BTA_GATTC_SERV_DISC_ACT 4
284 list_t *p_srvc_cache; /* list of tBTA_GATTC_SERVICE */
285 UINT8 update_count; /* indication received */
286 UINT8 num_clcb; /* number of associated CLCB */
289 tBTA_GATTC_ATTR_REC *p_srvc_list;
292 UINT8 next_avail_idx;
296 UINT8 srvc_hdl_chg; /* service handle change indication pending */
297 UINT16 attr_index; /* cahce NV saving/loading attribute index */
302 #ifndef BTA_GATTC_NOTIF_REG_MAX
303 #ifndef MAX_ACL_CONNECTIONS
304 #define BTA_GATTC_NOTIF_REG_MAX 15
306 #define BTA_GATTC_NOTIF_REG_MAX MAX_ACL_CONNECTIONS*3
315 }tBTA_GATTC_NOTIF_REG;
319 tBTA_GATTC_CBACK *p_cback;
321 tBTA_GATTC_IF client_if; /* client interface with BTE stack for this application */
322 UINT8 num_clcb; /* number of associated CLCB */
323 BOOLEAN dereg_pending;
325 tBTA_GATTC_NOTIF_REG notif_reg[BTA_GATTC_NOTIF_REG_MAX];
328 /* client channel is a mapping between a BTA client(cl_id) and a remote BD address */
331 UINT16 bta_conn_id; /* client channel ID, unique for clcb */
333 tBTA_TRANSPORT transport; /* channel transport */
334 tBTA_GATTC_RCB *p_rcb; /* pointer to the registration CB */
335 tBTA_GATTC_SERV *p_srcb; /* server cache CB */
336 tBTA_GATTC_DATA *p_q_cmd; /* command in queue waiting for execution */
338 #define BTA_GATTC_NO_SCHEDULE 0
339 #define BTA_GATTC_DISC_WAITING 0x01
340 #define BTA_GATTC_REQ_WAITING 0x10
342 UINT8 auto_update; /* auto update is waiting */
345 tBTA_GATTC_STATE state;
346 tBTA_GATT_STATUS status;
350 /* back ground connection tracking information */
351 #if GATT_MAX_APPS <= 8
352 typedef UINT8 tBTA_GATTC_CIF_MASK ;
353 #elif GATT_MAX_APPS <= 16
354 typedef UINT16 tBTA_GATTC_CIF_MASK;
355 #elif GATT_MAX_APPS <= 32
356 typedef UINT32 tBTA_GATTC_CIF_MASK;
363 tBTA_GATTC_CIF_MASK cif_mask;
364 tBTA_GATTC_CIF_MASK cif_adv_mask;
376 BTA_GATTC_STATE_DISABLED,
377 BTA_GATTC_STATE_ENABLING,
378 BTA_GATTC_STATE_ENABLED,
379 BTA_GATTC_STATE_DISABLING
386 tBTA_GATTC_CONN conn_track[BTA_GATTC_CONN_MAX];
387 tBTA_GATTC_BG_TCK bg_track[BTA_GATTC_KNOWN_SR_MAX];
388 tBTA_GATTC_RCB cl_rcb[BTA_GATTC_CL_MAX];
390 tBTA_GATTC_CLCB clcb[BTA_GATTC_CLCB_MAX];
391 tBTA_GATTC_SERV known_server[BTA_GATTC_KNOWN_SR_MAX];
394 /*****************************************************************************
396 *****************************************************************************/
398 /* GATTC control block */
399 #if BTA_DYNAMIC_MEMORY == FALSE
400 extern tBTA_GATTC_CB bta_gattc_cb;
402 extern tBTA_GATTC_CB *bta_gattc_cb_ptr;
403 #define bta_gattc_cb (*bta_gattc_cb_ptr)
406 /*****************************************************************************
407 ** Function prototypes
408 *****************************************************************************/
409 extern BOOLEAN bta_gattc_hdl_event(BT_HDR *p_msg);
410 extern BOOLEAN bta_gattc_sm_execute(tBTA_GATTC_CLCB *p_clcb, UINT16 event, tBTA_GATTC_DATA *p_data);
412 /* function processed outside SM */
413 extern void bta_gattc_disable(tBTA_GATTC_CB *p_cb);
414 extern void bta_gattc_register(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA *p_data);
415 extern void bta_gattc_start_if(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA *p_data);
416 extern void bta_gattc_process_api_open (tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA * p_msg);
417 extern void bta_gattc_process_api_open_cancel (tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA * p_msg);
418 extern void bta_gattc_deregister(tBTA_GATTC_CB *p_cb, tBTA_GATTC_RCB *p_clreg);
419 extern void bta_gattc_process_enc_cmpl(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA *p_msg);
421 /* function within state machine */
422 extern void bta_gattc_open(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
423 extern void bta_gattc_open_fail(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
424 extern void bta_gattc_open_error(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
426 extern void bta_gattc_cancel_open(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
427 extern void bta_gattc_cancel_open_ok(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
428 extern void bta_gattc_cancel_open_error(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
430 extern void bta_gattc_conn(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
432 extern void bta_gattc_close(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
433 extern void bta_gattc_close_fail(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
434 extern void bta_gattc_disc_close(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
436 extern void bta_gattc_start_discover(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
437 extern void bta_gattc_disc_cmpl(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
438 extern void bta_gattc_read(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
439 extern void bta_gattc_write(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
440 extern void bta_gattc_op_cmpl(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
441 extern void bta_gattc_q_cmd(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
442 extern void bta_gattc_search(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
443 extern void bta_gattc_fail(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
444 extern void bta_gattc_confirm(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
445 extern void bta_gattc_execute(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
446 extern void bta_gattc_read_multi(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
447 extern void bta_gattc_ci_open(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
448 extern void bta_gattc_ci_close(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
449 extern void bta_gattc_ignore_op_cmpl(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
450 extern void bta_gattc_restart_discover(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA * p_msg);
451 extern void bta_gattc_init_bk_conn(tBTA_GATTC_API_OPEN *p_data, tBTA_GATTC_RCB *p_clreg);
452 extern void bta_gattc_cancel_bk_conn(tBTA_GATTC_API_CANCEL_OPEN *p_data);
453 extern void bta_gattc_send_open_cback( tBTA_GATTC_RCB *p_clreg, tBTA_GATT_STATUS status,
454 BD_ADDR remote_bda, UINT16 conn_id, tBTA_TRANSPORT transport, UINT16 mtu);
455 extern void bta_gattc_process_api_refresh(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA * p_msg);
456 extern void bta_gattc_cfg_mtu(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
457 #if BLE_INCLUDED == TRUE
458 extern void bta_gattc_listen(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA * p_msg);
459 extern void bta_gattc_broadcast(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA * p_msg);
461 /* utility functions */
462 extern tBTA_GATTC_CLCB * bta_gattc_find_clcb_by_cif (UINT8 client_if, BD_ADDR remote_bda, tBTA_TRANSPORT transport);
463 extern tBTA_GATTC_CLCB * bta_gattc_find_clcb_by_conn_id (UINT16 conn_id);
464 extern tBTA_GATTC_CLCB * bta_gattc_clcb_alloc(tBTA_GATTC_IF client_if, BD_ADDR remote_bda, tBTA_TRANSPORT transport);
465 extern void bta_gattc_clcb_dealloc(tBTA_GATTC_CLCB *p_clcb);
466 extern tBTA_GATTC_CLCB * bta_gattc_find_alloc_clcb(tBTA_GATTC_IF client_if, BD_ADDR remote_bda, tBTA_TRANSPORT transport);
467 extern tBTA_GATTC_RCB * bta_gattc_cl_get_regcb(UINT8 client_if);
468 extern tBTA_GATTC_SERV * bta_gattc_find_srcb(BD_ADDR bda);
469 extern tBTA_GATTC_SERV * bta_gattc_srcb_alloc(BD_ADDR bda);
470 extern tBTA_GATTC_SERV * bta_gattc_find_scb_by_cid (UINT16 conn_id);
471 extern tBTA_GATTC_CLCB * bta_gattc_find_int_conn_clcb(tBTA_GATTC_DATA *p_msg);
472 extern tBTA_GATTC_CLCB * bta_gattc_find_int_disconn_clcb(tBTA_GATTC_DATA *p_msg);
474 extern BOOLEAN bta_gattc_enqueue(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data);
476 extern BOOLEAN bta_gattc_uuid_compare (const tBT_UUID *p_src, const tBT_UUID *p_tar, BOOLEAN is_precise);
477 extern BOOLEAN bta_gattc_check_notif_registry(tBTA_GATTC_RCB *p_clreg, tBTA_GATTC_SERV *p_srcb, tBTA_GATTC_NOTIFY *p_notify);
478 extern BOOLEAN bta_gattc_mark_bg_conn (tBTA_GATTC_IF client_if, BD_ADDR_PTR remote_bda, BOOLEAN add, BOOLEAN is_listen);
479 extern BOOLEAN bta_gattc_check_bg_conn (tBTA_GATTC_IF client_if, BD_ADDR remote_bda, UINT8 role);
480 extern UINT8 bta_gattc_num_reg_app(void);
481 extern void bta_gattc_clear_notif_registration(tBTA_GATTC_SERV *p_srcb, UINT16 conn_id, UINT16 start_handle, UINT16 end_handle);
482 extern tBTA_GATTC_SERV * bta_gattc_find_srvr_cache(BD_ADDR bda);
484 /* discovery functions */
485 extern void bta_gattc_disc_res_cback (UINT16 conn_id, tGATT_DISC_TYPE disc_type, tGATT_DISC_RES *p_data);
486 extern void bta_gattc_disc_cmpl_cback (UINT16 conn_id, tGATT_DISC_TYPE disc_type, tGATT_STATUS status);
487 extern tBTA_GATT_STATUS bta_gattc_discover_procedure(UINT16 conn_id, tBTA_GATTC_SERV *p_server_cb, UINT8 disc_type);
488 extern tBTA_GATT_STATUS bta_gattc_discover_pri_service(UINT16 conn_id, tBTA_GATTC_SERV *p_server_cb, UINT8 disc_type);
489 extern void bta_gattc_search_service(tBTA_GATTC_CLCB *p_clcb, tBT_UUID *p_uuid);
490 extern const list_t* bta_gattc_get_services(UINT16 conn_id);
491 extern const tBTA_GATTC_SERVICE* bta_gattc_get_service_for_handle(UINT16 conn_id, UINT16 handle);
492 tBTA_GATTC_CHARACTERISTIC* bta_gattc_get_characteristic_srcb(tBTA_GATTC_SERV *p_srcb, UINT16 handle);
493 extern tBTA_GATTC_CHARACTERISTIC* bta_gattc_get_characteristic(UINT16 conn_id, UINT16 handle);
494 extern tBTA_GATTC_DESCRIPTOR* bta_gattc_get_descriptor(UINT16 conn_id, UINT16 handle);
495 extern void bta_gattc_get_gatt_db(UINT16 conn_id, UINT16 start_handle, UINT16 end_handle, btgatt_db_element_t **db, int *count);
496 extern tBTA_GATT_STATUS bta_gattc_init_cache(tBTA_GATTC_SERV *p_srvc_cb);
497 extern void bta_gattc_rebuild_cache(tBTA_GATTC_SERV *p_srcv, UINT16 num_attr, tBTA_GATTC_NV_ATTR *attr);
498 extern void bta_gattc_cache_save(tBTA_GATTC_SERV *p_srvc_cb, UINT16 conn_id);
499 extern void bta_gattc_reset_discover_st(tBTA_GATTC_SERV *p_srcb, tBTA_GATT_STATUS status);
501 extern tBTA_GATTC_CONN * bta_gattc_conn_alloc(BD_ADDR remote_bda);
502 extern tBTA_GATTC_CONN * bta_gattc_conn_find(BD_ADDR remote_bda);
503 extern tBTA_GATTC_CONN * bta_gattc_conn_find_alloc(BD_ADDR remote_bda);
504 extern BOOLEAN bta_gattc_conn_dealloc(BD_ADDR remote_bda);
506 extern bool bta_gattc_cache_load(tBTA_GATTC_CLCB *p_clcb);
507 extern void bta_gattc_cache_reset(BD_ADDR server_bda);
509 #endif /* BTA_GATTC_INT_H */