/****************************************************************************** * * Copyright (C) 2003-2012 Broadcom Corporation * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * ******************************************************************************/ /****************************************************************************** * * This is the private file for the file transfer client (FTC). * ******************************************************************************/ #ifndef BTA_GATTC_INT_H #define BTA_GATTC_INT_H #include "bt_target.h" #include "bta_sys.h" #include "bta_gatt_api.h" #include "bta_gattc_ci.h" #include "bta_gattc_co.h" #include "gki.h" /***************************************************************************** ** Constants and data types *****************************************************************************/ enum { BTA_GATTC_API_OPEN_EVT = BTA_SYS_EVT_START(BTA_ID_GATTC), BTA_GATTC_INT_OPEN_FAIL_EVT, BTA_GATTC_API_CANCEL_OPEN_EVT, BTA_GATTC_INT_CANCEL_OPEN_OK_EVT, BTA_GATTC_API_READ_EVT, BTA_GATTC_API_WRITE_EVT, BTA_GATTC_API_EXEC_EVT, BTA_GATTC_API_CLOSE_EVT, BTA_GATTC_API_SEARCH_EVT, BTA_GATTC_API_CONFIRM_EVT, BTA_GATTC_API_READ_MULTI_EVT, BTA_GATTC_INT_CONN_EVT, BTA_GATTC_INT_DISCOVER_EVT, BTA_GATTC_DISCOVER_CMPL_EVT, BTA_GATTC_OP_CMPL_EVT, BTA_GATTC_INT_DISCONN_EVT, /* for cache loading/saving */ BTA_GATTC_START_CACHE_EVT, BTA_GATTC_CI_CACHE_OPEN_EVT, BTA_GATTC_CI_CACHE_LOAD_EVT, BTA_GATTC_CI_CACHE_SAVE_EVT, BTA_GATTC_INT_START_IF_EVT, BTA_GATTC_API_REG_EVT, BTA_GATTC_API_DEREG_EVT, BTA_GATTC_INT_DEREG_EVT }; typedef UINT16 tBTA_GATTC_INT_EVT; /* max client application GATTC can support */ #ifndef BTA_GATTC_CL_MAX #define BTA_GATTC_CL_MAX 4 #endif /* max known devices GATTC can support */ #ifndef BTA_GATTC_KNOWN_SR_MAX #define BTA_GATTC_KNOWN_SR_MAX 4 #endif #ifndef BTA_GATTC_CLCB_MAX #define BTA_GATTC_CLCB_MAX GATT_CL_MAX_LCB #endif #define BTA_GATTC_WRITE_PREPARE GATT_WRITE_PREPARE /* internal strucutre for GATTC register API */ typedef struct { BT_HDR hdr; tBT_UUID app_uuid; tBTA_GATTC_CBACK *p_cback; }tBTA_GATTC_API_REG; typedef struct { BT_HDR hdr; tBTA_GATTC_IF client_if; }tBTA_GATTC_INT_START_IF; typedef tBTA_GATTC_INT_START_IF tBTA_GATTC_API_DEREG; typedef tBTA_GATTC_INT_START_IF tBTA_GATTC_INT_DEREG; typedef struct { BT_HDR hdr; BD_ADDR remote_bda; tBTA_GATTC_IF client_if; BOOLEAN is_direct; } tBTA_GATTC_API_OPEN; typedef tBTA_GATTC_API_OPEN tBTA_GATTC_API_CANCEL_OPEN; typedef struct { BT_HDR hdr; tBTA_GATT_AUTH_REQ auth_req; tBTA_GATT_SRVC_ID srvc_id; tBTA_GATT_ID char_id; tBT_UUID descr_type; } tBTA_GATTC_API_READ; typedef struct { BT_HDR hdr; tBTA_GATT_AUTH_REQ auth_req; tBTA_GATT_SRVC_ID srvc_id; tBTA_GATT_ID char_id; tBT_UUID descr_type; tBTA_GATTC_WRITE_TYPE write_type; UINT16 offset; UINT16 len; UINT8 *p_value; }tBTA_GATTC_API_WRITE; typedef struct { BT_HDR hdr; BOOLEAN is_execute; }tBTA_GATTC_API_EXEC; typedef struct { BT_HDR hdr; tBTA_GATT_SRVC_ID srvc_id; tBTA_GATT_ID char_id; } tBTA_GATTC_API_CONFIRM; typedef tGATT_CL_COMPLETE tBTA_GATTC_CMPL; typedef struct { BT_HDR hdr; UINT8 op_code; tGATT_STATUS status; tBTA_GATTC_CMPL *p_cmpl; }tBTA_GATTC_OP_CMPL; typedef struct { BT_HDR hdr; tBT_UUID srvc_uuid; }tBTA_GATTC_API_SEARCH; typedef struct { BT_HDR hdr; tBTA_GATT_AUTH_REQ auth_req; UINT8 num_attr; tBTA_GATTC_ATTR_ID *p_id_list; }tBTA_GATTC_API_READ_MULTI; typedef union { BT_HDR hdr; tBTA_GATTC_API_REG api_reg; tBTA_GATTC_API_DEREG api_dereg; tBTA_GATTC_API_OPEN api_conn; tBTA_GATTC_API_CANCEL_OPEN api_cancel_conn; tBTA_GATTC_API_READ api_read; tBTA_GATTC_API_SEARCH api_search; tBTA_GATTC_API_WRITE api_write; tBTA_GATTC_API_CONFIRM api_confirm; tBTA_GATTC_API_EXEC api_exec; tBTA_GATTC_API_READ_MULTI api_read_multi; tBTA_GATTC_OP_CMPL op_cmpl; tBTA_GATTC_CI_EVT ci_open; tBTA_GATTC_CI_EVT ci_save; tBTA_GATTC_CI_LOAD ci_load; tBTA_GATTC_INT_START_IF int_start_if; tBTA_GATTC_INT_DEREG int_dereg; } tBTA_GATTC_DATA; /* GATT server cache on the client */ typedef union { UINT8 uuid128[LEN_UUID_128]; UINT16 uuid16; }tBTA_GATTC_UUID; typedef struct gattc_attr_cache { tBTA_GATTC_UUID *p_uuid; struct gattc_attr_cache *p_next; UINT16 uuid_len; UINT16 attr_handle; UINT8 inst_id; tBTA_GATT_CHAR_PROP property; /* if characteristic, it is char property; if included service, flag primary, if descriptor, not used */ tBTA_GATTC_ATTR_TYPE attr_type; // btla-specific ++ } __attribute__((packed)) tBTA_GATTC_CACHE_ATTR; // btla-specific -- typedef struct gattc_svc_cache { tBTA_GATT_SRVC_ID service_uuid; tBTA_GATTC_CACHE_ATTR *p_attr; tBTA_GATTC_CACHE_ATTR *p_last_attr; UINT16 s_handle; UINT16 e_handle; struct gattc_svc_cache *p_next; // btla-specific ++ } __attribute__((packed)) tBTA_GATTC_CACHE; // btla-specific -- typedef struct { tBT_UUID uuid; UINT16 s_handle; UINT16 e_handle; BOOLEAN is_primary; UINT8 srvc_inst_id; tBTA_GATT_CHAR_PROP property; }tBTA_GATTC_ATTR_REC; #define BTA_GATTC_MAX_CACHE_CHAR 40 #define BTA_GATTC_ATTR_LIST_SIZE (BTA_GATTC_MAX_CACHE_CHAR * sizeof(tBTA_GATTC_ATTR_REC)) #ifndef BTA_GATTC_CACHE_SRVR_SIZE #define BTA_GATTC_CACHE_SRVR_SIZE 600 #endif enum { BTA_GATTC_IDLE_ST = 0, /* Idle */ BTA_GATTC_W4_CONN_ST, /* Wait for connection - (optional) */ BTA_GATTC_CONN_ST, /* connected state */ BTA_GATTC_DISCOVER_ST /* discover is in progress */ }; typedef UINT8 tBTA_GATTC_STATE; typedef struct { BOOLEAN in_use; BD_ADDR server_bda; BOOLEAN connected; #define BTA_GATTC_SERV_IDLE 0 #define BTA_GATTC_SERV_LOAD 1 #define BTA_GATTC_SERV_SAVE 2 UINT8 state; tBTA_GATTC_CACHE *p_srvc_cache; tBTA_GATTC_CACHE *p_cur_srvc; BUFFER_Q cache_buffer; /* buffer queue used for storing the cache data */ UINT8 *p_free; /* starting point to next available byte */ UINT16 free_byte; /* number of available bytes in server cache buffer */ UINT8 update_count; /* indication received */ UINT8 num_clcb; /* number of associated CLCB */ tBTA_GATTC_ATTR_REC *p_srvc_list; UINT8 cur_srvc_idx; UINT8 cur_char_idx; UINT8 next_avail_idx; UINT8 total_srvc; UINT8 total_char; UINT8 srvc_hdl_chg; /* service handle change indication pending */ UINT16 attr_index; /* cahce NV saving/loading attribute index */ } tBTA_GATTC_SERV; #ifndef BTA_GATTC_NOTIF_REG_MAX #define BTA_GATTC_NOTIF_REG_MAX 4 #endif typedef struct { BOOLEAN in_use; BD_ADDR remote_bda; tBTA_GATTC_CHAR_ID char_id; }tBTA_GATTC_NOTIF_REG; typedef struct { tBTA_GATTC_CBACK *p_cback; BOOLEAN in_use; tBTA_GATTC_IF client_if; /* client interface with BTE stack for this application */ UINT8 num_clcb; /* number of associated CLCB */ BOOLEAN dereg_pending; tBT_UUID app_uuid; tBTA_GATTC_NOTIF_REG notif_reg[BTA_GATTC_NOTIF_REG_MAX]; }tBTA_GATTC_RCB; /* client channel is a mapping between a BTA client(cl_id) and a remote BD address */ typedef struct { UINT16 bta_conn_id; /* client channel ID, unique for clcb */ BD_ADDR bda; tBTA_GATTC_RCB *p_rcb; /* pointer to the registration CB */ tBTA_GATTC_SERV *p_srcb; /* server cache CB */ tBTA_GATTC_DATA *p_q_cmd; /* command in queue waiting for execution */ #define BTA_GATTC_NO_SCHEDULE 0 #define BTA_GATTC_DISC_WAITING 0x01 #define BTA_GATTC_REQ_WAITING 0x10 UINT8 auto_update; /* auto update is waiting */ BOOLEAN in_use; tBTA_GATTC_STATE state; tBTA_GATT_STATUS status; UINT16 reason; } tBTA_GATTC_CLCB; /* back ground connection tracking information */ #if GATT_MAX_APPS <= 8 typedef UINT8 tBTA_GATTC_CIF_MASK ; #elif GATT_MAX_APPS <= 16 typedef UINT16 tBTA_GATTC_CIF_MASK; #elif GATT_MAX_APPS <= 32 typedef UINT32 tBTA_GATTC_CIF_MASK; #endif typedef struct { BOOLEAN in_use; BD_ADDR remote_bda; tBTA_GATTC_CIF_MASK cif_mask; }tBTA_GATTC_BG_TCK; typedef struct { tBTA_GATTC_BG_TCK bg_track[BTA_GATTC_KNOWN_SR_MAX]; tBTA_GATTC_RCB cl_rcb[BTA_GATTC_CL_MAX]; tBTA_GATTC_CLCB clcb[BTA_GATTC_CLCB_MAX]; tBTA_GATTC_SERV known_server[BTA_GATTC_KNOWN_SR_MAX]; tSDP_DISCOVERY_DB *p_sdp_db; UINT16 sdp_conn_id; }tBTA_GATTC_CB; /***************************************************************************** ** Global data *****************************************************************************/ /* GATTC control block */ #if BTA_DYNAMIC_MEMORY == FALSE extern tBTA_GATTC_CB bta_gattc_cb; #else extern tBTA_GATTC_CB *bta_gattc_cb_ptr; #define bta_gattc_cb (*bta_gattc_cb_ptr) #endif /***************************************************************************** ** Function prototypes *****************************************************************************/ extern BOOLEAN bta_gattc_hdl_event(BT_HDR *p_msg); extern void bta_gattc_sm_execute(tBTA_GATTC_CLCB *p_clcb, UINT16 event, tBTA_GATTC_DATA *p_data); /* function processed outside SM */ extern void bta_gattc_register(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_start_if(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_process_api_open (tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA * p_msg); extern void bta_gattc_process_api_open_cancel (tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA * p_msg); extern void bta_gattc_deregister(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_int_deregister(tBTA_GATTC_CB *p_cb, tBTA_GATTC_DATA *p_data); /* function within state machine */ extern void bta_gattc_open(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_open_fail(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_open_error(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_cancel_open(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_cancel_open_ok(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_cancel_open_error(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_conn(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_close(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_close_fail(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_start_discover(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_disc_cmpl(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_read(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_write(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_op_cmpl(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_q_cmd(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_search(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_fail(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_confirm(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_execute(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_read_multi(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_ci_open(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_ci_load(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_ci_close(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_ci_save(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_cache_open(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_ignore_op_cmpl(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern void bta_gattc_init_bk_conn(tBTA_GATTC_API_OPEN *p_data, tBTA_GATTC_RCB *p_clreg); extern void bta_gattc_cancel_bk_conn(tBTA_GATTC_API_CANCEL_OPEN *p_data); extern void bta_gattc_send_open_cback( tBTA_GATTC_RCB *p_clreg, tBTA_GATT_STATUS status, BD_ADDR remote_bda, UINT16 conn_id); /* utility functions */ extern tBTA_GATTC_CLCB * bta_gattc_find_clcb_by_cif (UINT8 client_if, BD_ADDR remote_bda); //todo extern tBTA_GATTC_CLCB * bta_gattc_find_clcb_by_conn_id (UINT16 conn_id); extern tBTA_GATTC_CLCB * bta_gattc_clcb_alloc(tBTA_GATTC_IF client_if, BD_ADDR remote_bda); extern void bta_gattc_clcb_dealloc(tBTA_GATTC_CLCB *p_clcb); extern tBTA_GATTC_CLCB * bta_gattc_find_alloc_clcb(tBTA_GATTC_IF client_if, BD_ADDR remote_bda); extern tBTA_GATTC_RCB * bta_gattc_cl_get_regcb(UINT8 client_if); extern tBTA_GATTC_SERV * bta_gattc_find_srcb(BD_ADDR bda); extern tBTA_GATTC_SERV * bta_gattc_srcb_alloc(BD_ADDR bda); extern tBTA_GATTC_SERV * bta_gattc_find_scb_by_cid (UINT16 conn_id); extern BOOLEAN bta_gattc_enqueue(tBTA_GATTC_CLCB *p_clcb, tBTA_GATTC_DATA *p_data); extern UINT16 bta_gattc_id2handle(tBTA_GATTC_SERV *p_srcb, tBTA_GATT_SRVC_ID *p_service_id, tBTA_GATT_ID *p_char_id, tBT_UUID descr_uuid); extern BOOLEAN bta_gattc_handle2id(tBTA_GATTC_SERV *p_srcb, UINT16 handle, tBTA_GATT_SRVC_ID *service_id, tBTA_GATT_ID *char_id, tBT_UUID *p_type); extern BOOLEAN bta_gattc_uuid_compare (tBT_UUID src, tBT_UUID tar, BOOLEAN is_precise); extern void bta_gattc_pack_attr_uuid(tBTA_GATTC_CACHE_ATTR *p_attr, tBT_UUID *p_uuid); extern BOOLEAN bta_gattc_check_notif_registry(tBTA_GATTC_RCB *p_clreg, tBTA_GATTC_SERV *p_srcb, tBTA_GATTC_NOTIFY *p_notify); extern tBTA_GATT_STATUS bta_gattc_pack_read_cb_data(tBTA_GATTC_SERV *p_srcb, tBT_UUID descr_uuid, tGATT_VALUE *p_attr, tBTA_GATT_READ_VAL *p_value); extern BOOLEAN bta_gattc_mark_bg_conn (tBTA_GATTC_IF client_if, BD_ADDR remote_bda, BOOLEAN add); extern BOOLEAN bta_gattc_check_bg_conn (tBTA_GATTC_IF client_if, BD_ADDR remote_bda); extern UINT8 bta_gattc_num_reg_app(void); extern void bta_gattc_clear_notif_registration(UINT16 conn_id); /* discovery functions */ extern void bta_gattc_disc_res_cback (UINT16 conn_id, tGATT_DISC_TYPE disc_type, tGATT_DISC_RES *p_data); extern void bta_gattc_disc_cmpl_cback (UINT16 conn_id, tGATT_DISC_TYPE disc_type, tGATT_STATUS status); extern tBTA_GATT_STATUS bta_gattc_discover_procedure(UINT16 conn_id, tBTA_GATTC_SERV *p_server_cb, UINT8 disc_type); extern tBTA_GATT_STATUS bta_gattc_discover_pri_service(UINT16 conn_id, tBTA_GATTC_SERV *p_server_cb, UINT8 disc_type); extern void bta_gattc_search_service(tBTA_GATTC_CLCB *p_clcb, tBT_UUID uuid); extern tBTA_GATT_STATUS bta_gattc_query_cache(UINT16 conn_id, UINT8 query_type, tBTA_GATT_SRVC_ID *p_srvc_id, tBTA_GATT_ID *p_start_rec,tBT_UUID *p_uuid_cond, tBTA_GATT_ID *p_output, void *p_property); extern tBTA_GATT_STATUS bta_gattc_init_cache(tBTA_GATTC_SERV *p_srvc_cb); extern void bta_gattc_rebuild_cache(tBTA_GATTC_SERV *p_srcv, UINT16 num_attr, tBTA_GATTC_NV_ATTR *p_attr, UINT16 attr_index); extern BOOLEAN bta_gattc_cache_save(tBTA_GATTC_SERV *p_srvc_cb, UINT16 conn_id); #endif /* BTA_GATTC_INT_H */