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 file contains the GATT client utility function.
23 ******************************************************************************/
25 #define LOG_TAG "bt_bta_gattc"
27 #include "bt_target.h"
29 #if defined(BTA_GATT_INCLUDED) && (BTA_GATT_INCLUDED == TRUE)
33 #include "bta_gattc_int.h"
35 #include "btcore/include/bdaddr.h"
36 #include "btif/include/btif_util.h"
37 #include "bt_common.h"
41 /*****************************************************************************
43 *****************************************************************************/
45 static const UINT8 base_uuid[LEN_UUID_128] = {0xFB, 0x34, 0x9B, 0x5F, 0x80, 0x00, 0x00, 0x80,
46 0x00, 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
48 static const BD_ADDR dummy_bda = {0,0,0,0,0,0};
50 /*******************************************************************************
52 ** Function bta_gatt_convert_uuid16_to_uuid128
54 ** Description Convert a 16 bits UUID to be an standard 128 bits one.
56 ** Returns TRUE if two uuid match; FALSE otherwise.
58 *******************************************************************************/
59 void bta_gatt_convert_uuid16_to_uuid128(UINT8 uuid_128[LEN_UUID_128], UINT16 uuid_16)
61 UINT8 *p = &uuid_128[LEN_UUID_128 - 4];
63 memcpy (uuid_128, base_uuid, LEN_UUID_128);
65 UINT16_TO_STREAM(p, uuid_16);
67 /*******************************************************************************
69 ** Function bta_gattc_uuid_compare
71 ** Description Compare two UUID to see if they are the same.
73 ** Returns TRUE if two uuid match; FALSE otherwise.
75 *******************************************************************************/
76 BOOLEAN bta_gattc_uuid_compare (const tBT_UUID *p_src, const tBT_UUID *p_tar, BOOLEAN is_precise)
78 UINT8 su[LEN_UUID_128], tu[LEN_UUID_128];
81 /* any of the UUID is unspecified */
82 if (p_src == 0 || p_tar == 0)
90 /* If both are 16-bit, we can do a simple compare */
91 if (p_src->len == 2 && p_tar->len == 2)
93 return p_src->uu.uuid16 == p_tar->uu.uuid16;
96 /* One or both of the UUIDs is 128-bit */
97 if (p_src->len == LEN_UUID_16)
99 /* convert a 16 bits UUID to 128 bits value */
100 bta_gatt_convert_uuid16_to_uuid128(su, p_src->uu.uuid16);
104 ps = p_src->uu.uuid128;
106 if (p_tar->len == LEN_UUID_16)
108 /* convert a 16 bits UUID to 128 bits value */
109 bta_gatt_convert_uuid16_to_uuid128(tu, p_tar->uu.uuid16);
113 pt = p_tar->uu.uuid128;
115 return(memcmp(ps, pt, LEN_UUID_128) == 0);
118 /*******************************************************************************
120 ** Function bta_gattc_cl_get_regcb
122 ** Description get registration control block by client interface.
124 ** Returns pointer to the regcb
126 *******************************************************************************/
127 tBTA_GATTC_RCB * bta_gattc_cl_get_regcb(UINT8 client_if)
130 tBTA_GATTC_RCB *p_clrcb = &bta_gattc_cb.cl_rcb[0];
132 for (i = 0; i < BTA_GATTC_CL_MAX; i ++, p_clrcb ++)
134 if (p_clrcb->in_use &&
135 p_clrcb->client_if == client_if)
140 /*******************************************************************************
142 ** Function bta_gattc_num_reg_app
144 ** Description find the number of registered application.
146 ** Returns pointer to the regcb
148 *******************************************************************************/
149 UINT8 bta_gattc_num_reg_app(void)
153 for (i = 0; i < BTA_GATTC_CL_MAX; i ++)
155 if (bta_gattc_cb.cl_rcb[i].in_use)
160 /*******************************************************************************
162 ** Function bta_gattc_find_clcb_by_cif
164 ** Description get clcb by client interface and remote bd adddress
166 ** Returns pointer to the clcb
168 *******************************************************************************/
169 tBTA_GATTC_CLCB * bta_gattc_find_clcb_by_cif (UINT8 client_if, BD_ADDR remote_bda,
170 tBTA_TRANSPORT transport)
172 tBTA_GATTC_CLCB *p_clcb = &bta_gattc_cb.clcb[0];
175 for (i = 0; i < BTA_GATTC_CLCB_MAX; i ++, p_clcb ++)
177 if (p_clcb->in_use &&
178 p_clcb->p_rcb->client_if == client_if &&
179 p_clcb->transport == transport &&
180 bdcmp(p_clcb->bda, remote_bda) == 0)
185 /*******************************************************************************
187 ** Function bta_gattc_find_clcb_by_conn_id
189 ** Description get clcb by connection ID
191 ** Returns pointer to the clcb
193 *******************************************************************************/
194 tBTA_GATTC_CLCB * bta_gattc_find_clcb_by_conn_id (UINT16 conn_id)
196 tBTA_GATTC_CLCB *p_clcb = &bta_gattc_cb.clcb[0];
199 for (i = 0; i < BTA_GATTC_CLCB_MAX; i ++, p_clcb ++)
201 if (p_clcb->in_use &&
202 p_clcb->bta_conn_id == conn_id)
208 /*******************************************************************************
210 ** Function bta_gattc_clcb_alloc
212 ** Description allocate CLCB
214 ** Returns pointer to the clcb
216 *******************************************************************************/
217 tBTA_GATTC_CLCB * bta_gattc_clcb_alloc(tBTA_GATTC_IF client_if, BD_ADDR remote_bda,
218 tBTA_TRANSPORT transport)
221 tBTA_GATTC_CLCB *p_clcb = NULL;
223 for (i_clcb = 0; i_clcb < BTA_GATTC_CLCB_MAX; i_clcb++)
225 if (!bta_gattc_cb.clcb[i_clcb].in_use)
227 #if BTA_GATT_DEBUG == TRUE
228 APPL_TRACE_DEBUG("bta_gattc_clcb_alloc: found clcb[%d] available",i_clcb);
230 p_clcb = &bta_gattc_cb.clcb[i_clcb];
231 p_clcb->in_use = TRUE;
232 p_clcb->status = BTA_GATT_OK;
233 p_clcb->transport = transport;
234 bdcpy(p_clcb->bda, remote_bda);
236 p_clcb->p_rcb = bta_gattc_cl_get_regcb(client_if);
238 if ((p_clcb->p_srcb = bta_gattc_find_srcb(remote_bda)) == NULL)
239 p_clcb->p_srcb = bta_gattc_srcb_alloc(remote_bda);
241 if (p_clcb->p_rcb != NULL && p_clcb->p_srcb != NULL)
243 p_clcb->p_srcb->num_clcb ++;
244 p_clcb->p_rcb->num_clcb ++;
248 /* release this clcb if clcb or srcb allocation failed */
249 p_clcb->in_use = FALSE;
257 /*******************************************************************************
259 ** Function bta_gattc_find_alloc_clcb
261 ** Description find or allocate CLCB if not found.
263 ** Returns pointer to the clcb
265 *******************************************************************************/
266 tBTA_GATTC_CLCB *bta_gattc_find_alloc_clcb(tBTA_GATTC_IF client_if, BD_ADDR remote_bda,
267 tBTA_TRANSPORT transport)
269 tBTA_GATTC_CLCB *p_clcb ;
271 if ((p_clcb = bta_gattc_find_clcb_by_cif(client_if, remote_bda, transport)) == NULL)
273 p_clcb = bta_gattc_clcb_alloc(client_if, remote_bda, transport);
278 /*******************************************************************************
280 ** Function bta_gattc_clcb_dealloc
282 ** Description Deallocte a clcb
284 ** Returns pointer to the clcb
286 *******************************************************************************/
287 void bta_gattc_clcb_dealloc(tBTA_GATTC_CLCB *p_clcb)
289 tBTA_GATTC_SERV *p_srcb = NULL;
293 p_srcb = p_clcb->p_srcb;
294 if (p_srcb->num_clcb)
297 if (p_clcb->p_rcb->num_clcb)
298 p_clcb->p_rcb->num_clcb --;
300 /* if the srcb is no longer needed, reset the state */
301 if ( p_srcb->num_clcb == 0)
303 p_srcb->connected = FALSE;
304 p_srcb->state = BTA_GATTC_SERV_IDLE;
308 osi_free_and_reset((void **)&p_clcb->p_q_cmd);
309 memset(p_clcb, 0, sizeof(tBTA_GATTC_CLCB));
311 APPL_TRACE_ERROR("bta_gattc_clcb_dealloc p_clcb=NULL");
315 /*******************************************************************************
317 ** Function bta_gattc_find_srcb
319 ** Description find server cache by remote bd address currently in use
321 ** Returns pointer to the server cache.
323 *******************************************************************************/
324 tBTA_GATTC_SERV * bta_gattc_find_srcb(BD_ADDR bda)
326 tBTA_GATTC_SERV *p_srcb = &bta_gattc_cb.known_server[0];
329 for (i = 0; i < BTA_GATTC_KNOWN_SR_MAX; i ++, p_srcb ++)
331 if (p_srcb->in_use && bdcmp(p_srcb->server_bda, bda) == 0)
337 /*******************************************************************************
339 ** Function bta_gattc_find_srvr_cache
341 ** Description find server cache by remote bd address
343 ** Returns pointer to the server cache.
345 *******************************************************************************/
346 tBTA_GATTC_SERV * bta_gattc_find_srvr_cache(BD_ADDR bda)
348 tBTA_GATTC_SERV *p_srcb = &bta_gattc_cb.known_server[0];
351 for (i = 0; i < BTA_GATTC_KNOWN_SR_MAX; i ++, p_srcb ++)
353 if (bdcmp(p_srcb->server_bda, bda) == 0)
358 /*******************************************************************************
360 ** Function bta_gattc_find_scb_by_cid
362 ** Description find server control block by connection ID
364 ** Returns pointer to the server cache.
366 *******************************************************************************/
367 tBTA_GATTC_SERV * bta_gattc_find_scb_by_cid (UINT16 conn_id)
369 tBTA_GATTC_CLCB *p_clcb = bta_gattc_find_clcb_by_conn_id(conn_id);
372 return p_clcb->p_srcb;
376 /*******************************************************************************
378 ** Function bta_gattc_srcb_alloc
380 ** Description allocate server cache control block
382 ** Returns pointer to the server cache.
384 *******************************************************************************/
385 tBTA_GATTC_SERV * bta_gattc_srcb_alloc(BD_ADDR bda)
387 tBTA_GATTC_SERV *p_tcb = &bta_gattc_cb.known_server[0],
389 BOOLEAN found = FALSE;
392 for (i = 0; i < BTA_GATTC_KNOWN_SR_MAX; i ++, p_tcb ++)
399 else if (!p_tcb->connected)
405 /* if not found, try to recycle one known device */
406 if (!found && !p_recycle)
408 else if (!found && p_recycle)
413 if (p_tcb->p_srvc_cache != NULL)
414 list_free(p_tcb->p_srvc_cache);
416 osi_free_and_reset((void **)&p_tcb->p_srvc_list);
417 memset(p_tcb, 0 , sizeof(tBTA_GATTC_SERV));
419 p_tcb->in_use = TRUE;
420 bdcpy(p_tcb->server_bda, bda);
424 /*******************************************************************************
426 ** Function bta_gattc_enqueue
428 ** Description enqueue a client request in clcb.
430 ** Returns success or failure.
432 *******************************************************************************/
433 BOOLEAN bta_gattc_enqueue(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data)
436 if (p_clcb->p_q_cmd == NULL)
438 p_clcb->p_q_cmd = p_data;
442 APPL_TRACE_ERROR ("%s: already has a pending command!!", __func__);
443 /* skip the callback now. ----- need to send callback ? */
447 /*******************************************************************************
449 ** Function bta_gattc_check_notif_registry
451 ** Description check if the service notificaition has been registered.
455 *******************************************************************************/
456 BOOLEAN bta_gattc_check_notif_registry(tBTA_GATTC_RCB *p_clreg, tBTA_GATTC_SERV *p_srcb,
457 tBTA_GATTC_NOTIFY *p_notify)
461 for (i = 0 ; i < BTA_GATTC_NOTIF_REG_MAX; i ++)
463 if (p_clreg->notif_reg[i].in_use &&
464 bdcmp(p_clreg->notif_reg[i].remote_bda, p_srcb->server_bda) == 0 &&
465 p_clreg->notif_reg[i].handle == p_notify->handle)
467 APPL_TRACE_DEBUG("Notification registered!");
474 /*******************************************************************************
476 ** Function bta_gattc_clear_notif_registration
478 ** Description Clear up the notification registration information by BD_ADDR.
479 ** Where handle is between start_handle and end_handle, and
480 ** start_handle and end_handle are boundaries of service
481 ** containing characteristic.
485 *******************************************************************************/
486 void bta_gattc_clear_notif_registration(tBTA_GATTC_SERV *p_srcb, UINT16 conn_id,
487 UINT16 start_handle, UINT16 end_handle)
490 tBTA_GATTC_IF gatt_if;
491 tBTA_GATTC_RCB *p_clrcb ;
493 tGATT_TRANSPORT transport;
496 if (GATT_GetConnectionInfor(conn_id, &gatt_if, remote_bda, &transport)) {
497 if ((p_clrcb = bta_gattc_cl_get_regcb(gatt_if)) != NULL) {
498 for (i = 0 ; i < BTA_GATTC_NOTIF_REG_MAX; i ++) {
499 if (p_clrcb->notif_reg[i].in_use &&
500 !bdcmp(p_clrcb->notif_reg[i].remote_bda, remote_bda))
502 /* It's enough to get service or characteristic handle, as
503 * clear boundaries are always around service.
505 handle = p_clrcb->notif_reg[i].handle;
506 if (handle >= start_handle && handle <= end_handle)
507 memset(&p_clrcb->notif_reg[i], 0, sizeof(tBTA_GATTC_NOTIF_REG));
511 APPL_TRACE_ERROR("can not clear indication/notif registration for unknown app");
516 /*******************************************************************************
518 ** Function bta_gattc_mark_bg_conn
520 ** Description mark background connection status when a bg connection is initiated
523 ** Returns TRUE if success; FALSE otherwise.
525 *******************************************************************************/
526 BOOLEAN bta_gattc_mark_bg_conn (tBTA_GATTC_IF client_if, BD_ADDR_PTR remote_bda_ptr,
527 BOOLEAN add, BOOLEAN is_listen)
529 tBTA_GATTC_BG_TCK *p_bg_tck = &bta_gattc_cb.bg_track[0];
531 tBTA_GATTC_CIF_MASK *p_cif_mask;
533 for (i = 0; i < BTA_GATTC_KNOWN_SR_MAX; i ++, p_bg_tck ++)
535 if (p_bg_tck->in_use &&
536 ((remote_bda_ptr != NULL && bdcmp(p_bg_tck->remote_bda, remote_bda_ptr) == 0) ||
537 (remote_bda_ptr == NULL && bdcmp(p_bg_tck->remote_bda, dummy_bda) == 0)))
539 p_cif_mask = is_listen ? &p_bg_tck->cif_adv_mask : &p_bg_tck->cif_mask;
542 /* mask on the cif bit */
543 *p_cif_mask |= (1 <<(client_if - 1));
547 *p_cif_mask &= (~(1 <<(client_if - 1)));
551 /* no BG connection for this device, make it available */
552 if (p_bg_tck->cif_mask == 0 && p_bg_tck->cif_adv_mask == 0)
554 memset(p_bg_tck, 0, sizeof(tBTA_GATTC_BG_TCK));
564 APPL_TRACE_ERROR("%s unable to find the bg connection mask for: %s", __func__,
565 bdaddr_to_string((bt_bdaddr_t *)remote_bda_ptr, bdstr, sizeof(bdstr)));
569 else /* adding a new device mask */
571 for (i = 0, p_bg_tck = &bta_gattc_cb.bg_track[0];
572 i < BTA_GATTC_KNOWN_SR_MAX; i ++, p_bg_tck ++)
574 if (!p_bg_tck->in_use)
576 p_bg_tck->in_use = TRUE;
578 bdcpy(p_bg_tck->remote_bda, remote_bda_ptr);
580 bdcpy(p_bg_tck->remote_bda, dummy_bda);
582 p_cif_mask = is_listen ? &p_bg_tck->cif_adv_mask : &p_bg_tck->cif_mask;
584 *p_cif_mask = (1 <<(client_if - 1));
588 APPL_TRACE_ERROR("no available space to mark the bg connection status");
592 /*******************************************************************************
594 ** Function bta_gattc_check_bg_conn
596 ** Description check if this is a background connection background connection.
598 ** Returns TRUE if success; FALSE otherwise.
600 *******************************************************************************/
601 BOOLEAN bta_gattc_check_bg_conn (tBTA_GATTC_IF client_if, BD_ADDR remote_bda, UINT8 role)
603 tBTA_GATTC_BG_TCK *p_bg_tck = &bta_gattc_cb.bg_track[0];
605 BOOLEAN is_bg_conn = FALSE;
607 for (i = 0; i < BTA_GATTC_KNOWN_SR_MAX && !is_bg_conn; i ++, p_bg_tck ++)
609 if (p_bg_tck->in_use &&
610 (bdcmp(p_bg_tck->remote_bda, remote_bda) == 0 ||
611 bdcmp(p_bg_tck->remote_bda, dummy_bda) == 0))
613 if (((p_bg_tck->cif_mask &(1 <<(client_if - 1))) != 0) &&
614 role == HCI_ROLE_MASTER)
617 if (((p_bg_tck->cif_adv_mask &(1 <<(client_if - 1))) != 0) &&
618 role == HCI_ROLE_SLAVE)
624 /*******************************************************************************
626 ** Function bta_gattc_send_open_cback
628 ** Description send open callback
632 *******************************************************************************/
633 void bta_gattc_send_open_cback( tBTA_GATTC_RCB *p_clreg, tBTA_GATT_STATUS status,
634 BD_ADDR remote_bda, UINT16 conn_id,
635 tBTA_TRANSPORT transport, UINT16 mtu)
639 if (p_clreg->p_cback)
641 memset(&cb_data, 0, sizeof(tBTA_GATTC));
643 cb_data.open.status = status;
644 cb_data.open.client_if = p_clreg->client_if;
645 cb_data.open.conn_id = conn_id;
646 cb_data.open.mtu = mtu;
647 cb_data.open.transport = transport;
648 bdcpy(cb_data.open.remote_bda, remote_bda);
650 (*p_clreg->p_cback)(BTA_GATTC_OPEN_EVT, &cb_data);
653 /*******************************************************************************
655 ** Function bta_gattc_conn_alloc
657 ** Description allocate connection tracking spot
659 ** Returns pointer to the clcb
661 *******************************************************************************/
662 tBTA_GATTC_CONN * bta_gattc_conn_alloc(BD_ADDR remote_bda)
665 tBTA_GATTC_CONN *p_conn = &bta_gattc_cb.conn_track[0];
667 for (i_conn = 0; i_conn < BTA_GATTC_CONN_MAX; i_conn++, p_conn ++)
671 #if BTA_GATT_DEBUG == TRUE
672 APPL_TRACE_DEBUG("bta_gattc_conn_alloc: found conn_track[%d] available",i_conn);
674 p_conn->in_use = TRUE;
675 bdcpy(p_conn->remote_bda, remote_bda);
682 /*******************************************************************************
684 ** Function bta_gattc_conn_find
686 ** Description allocate connection tracking spot
688 ** Returns pointer to the clcb
690 *******************************************************************************/
691 tBTA_GATTC_CONN * bta_gattc_conn_find(BD_ADDR remote_bda)
694 tBTA_GATTC_CONN *p_conn = &bta_gattc_cb.conn_track[0];
696 for (i_conn = 0; i_conn < BTA_GATTC_CONN_MAX; i_conn++, p_conn ++)
698 if (p_conn->in_use && bdcmp(remote_bda, p_conn->remote_bda) == 0)
700 #if BTA_GATT_DEBUG == TRUE
701 APPL_TRACE_DEBUG("bta_gattc_conn_find: found conn_track[%d] matched",i_conn);
709 /*******************************************************************************
711 ** Function bta_gattc_conn_find_alloc
713 ** Description find or allocate connection tracking spot
715 ** Returns pointer to the clcb
717 *******************************************************************************/
718 tBTA_GATTC_CONN * bta_gattc_conn_find_alloc(BD_ADDR remote_bda)
720 tBTA_GATTC_CONN *p_conn = bta_gattc_conn_find (remote_bda);
724 p_conn = bta_gattc_conn_alloc(remote_bda);
729 /*******************************************************************************
731 ** Function bta_gattc_conn_dealloc
733 ** Description de-allocate connection tracking spot
735 ** Returns pointer to the clcb
737 *******************************************************************************/
738 BOOLEAN bta_gattc_conn_dealloc(BD_ADDR remote_bda)
740 tBTA_GATTC_CONN *p_conn = bta_gattc_conn_find (remote_bda);
744 p_conn->in_use = FALSE;
745 memset(p_conn->remote_bda, 0, BD_ADDR_LEN);
751 /*******************************************************************************
753 ** Function bta_gattc_find_int_conn_clcb
755 ** Description try to locate a clcb when an internal connecion event arrives.
757 ** Returns pointer to the clcb
759 *******************************************************************************/
760 tBTA_GATTC_CLCB * bta_gattc_find_int_conn_clcb(tBTA_GATTC_DATA *p_msg)
762 tBTA_GATTC_CLCB *p_clcb = NULL;
764 if (p_msg->int_conn.role == HCI_ROLE_SLAVE)
765 bta_gattc_conn_find_alloc(p_msg->int_conn.remote_bda);
767 /* try to locate a logic channel */
768 if ((p_clcb = bta_gattc_find_clcb_by_cif(p_msg->int_conn.client_if,
769 p_msg->int_conn.remote_bda,
770 p_msg->int_conn.transport)) == NULL)
772 /* for a background connection or listening connection */
773 if (/*p_msg->int_conn.role == HCI_ROLE_SLAVE || */
774 bta_gattc_check_bg_conn(p_msg->int_conn.client_if,
775 p_msg->int_conn.remote_bda,
776 p_msg->int_conn.role))
778 /* allocate a new channel */
779 p_clcb = bta_gattc_clcb_alloc(p_msg->int_conn.client_if,
780 p_msg->int_conn.remote_bda,
781 p_msg->int_conn.transport);
787 /*******************************************************************************
789 ** Function bta_gattc_find_int_disconn_clcb
791 ** Description try to locate a clcb when an internal disconnect callback arrives.
793 ** Returns pointer to the clcb
795 *******************************************************************************/
796 tBTA_GATTC_CLCB * bta_gattc_find_int_disconn_clcb(tBTA_GATTC_DATA *p_msg)
798 tBTA_GATTC_CLCB *p_clcb = NULL;
800 bta_gattc_conn_dealloc(p_msg->int_conn.remote_bda);
801 if ((p_clcb = bta_gattc_find_clcb_by_conn_id(p_msg->int_conn.hdr.layer_specific)) == NULL)
803 /* connection attempt failed, send connection callback event */
804 p_clcb = bta_gattc_find_clcb_by_cif(p_msg->int_conn.client_if,
805 p_msg->int_conn.remote_bda,
806 p_msg->int_conn.transport);
810 APPL_TRACE_DEBUG(" disconnection ID: [%d] not used by BTA",
811 p_msg->int_conn.hdr.layer_specific);
816 #endif /* BTA_GATT_INCLUDED */