/****************************************************************************** * * 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 public interface file for BTA GATT. * ******************************************************************************/ #ifndef BTA_GATT_API_H #define BTA_GATT_API_H #include "bta_api.h" #include "gatt_api.h" #ifndef BTA_GATT_INCLUDED #define BTA_GATT_INCLUDED FALSE #endif #if ((BLE_INCLUDED == FALSE) && (BTA_GATT_INCLUDED == TRUE)) #undef BTA_GATT_INCLUDED #define BTA_GATT_INCLUDED FALSE #endif #ifndef BTA_GATT_DEBUG #define BTA_GATT_DEBUG FALSE #endif /***************************************************************************** ** Constants and data types *****************************************************************************/ /************************** ** Common Definitions ***************************/ /* GATT ID */ typedef struct { tBT_UUID uuid; /* uuid of the attribute */ UINT8 inst_id; /* instance ID */ } tBTA_GATT_ID; /* Success code and error codes */ #define BTA_GATT_OK GATT_SUCCESS #define BTA_GATT_INVALID_HANDLE GATT_INVALID_HANDLE /* 0x0001 */ #define BTA_GATT_READ_NOT_PERMIT GATT_READ_NOT_PERMIT /* 0x0002 */ #define BTA_GATT_WRITE_NOT_PERMIT GATT_WRITE_NOT_PERMIT /* 0x0003 */ #define BTA_GATT_INVALID_PDU GATT_INVALID_PDU /* 0x0004 */ #define BTA_GATT_INSUF_AUTHENTICATION GATT_INSUF_AUTHENTICATION /* 0x0005 */ #define BTA_GATT_REQ_NOT_SUPPORTED GATT_REQ_NOT_SUPPORTED /* 0x0006 */ #define BTA_GATT_INVALID_OFFSET GATT_INVALID_OFFSET /* 0x0007 */ #define BTA_GATT_INSUF_AUTHORIZATION GATT_INSUF_AUTHORIZATION /* 0x0008 */ #define BTA_GATT_PREPARE_Q_FULL GATT_PREPARE_Q_FULL /* 0x0009 */ #define BTA_GATT_NOT_FOUND GATT_NOT_FOUND /* 0x000a */ #define BTA_GATT_NOT_LONG GATT_NOT_LONG /* 0x000b */ #define BTA_GATT_INSUF_KEY_SIZE GATT_INSUF_KEY_SIZE /* 0x000c */ #define BTA_GATT_INVALID_ATTR_LEN GATT_INVALID_ATTR_LEN /* 0x000d */ #define BTA_GATT_ERR_UNLIKELY GATT_ERR_UNLIKELY /* 0x000e */ #define BTA_GATT_INSUF_ENCRYPTION GATT_INSUF_ENCRYPTION /* 0x000f */ #define BTA_GATT_UNSUPPORT_GRP_TYPE GATT_UNSUPPORT_GRP_TYPE /* 0x0010 */ #define BTA_GATT_INSUF_RESOURCE GATT_INSUF_RESOURCE /* 0x0011 */ #define BTA_GATT_ILLEGAL_PARAMETER GATT_ILLEGAL_PARAMETER /* 0x0087 */ #define BTA_GATT_NO_RESOURCES GATT_NO_RESOURCES /* 0x0080 */ #define BTA_GATT_INTERNAL_ERROR GATT_INTERNAL_ERROR /* 0x0081 */ #define BTA_GATT_WRONG_STATE GATT_WRONG_STATE /* 0x0082 */ #define BTA_GATT_DB_FULL GATT_DB_FULL /* 0x0083 */ #define BTA_GATT_BUSY GATT_BUSY /* 0x0084 */ #define BTA_GATT_ERROR GATT_ERROR /* 0x0085 */ #define BTA_GATT_CMD_STARTED GATT_CMD_STARTED /* 0x0086 */ #define BTA_GATT_PENDING GATT_PENDING /* 0x0088 */ #define BTA_GATT_AUTH_FAIL GATT_AUTH_FAIL /* 0x0089 */ #define BTA_GATT_MORE GATT_MORE /* 0x008a */ #define BTA_GATT_INVALID_CFG GATT_INVALID_CFG /* 0x008b */ #define BTA_GATT_DUP_REG 0x008c #define BTA_GATT_ALREADY_OPEN 0x008d /* 0x008d */ typedef UINT8 tBTA_GATT_STATUS; #define BTA_GATT_INVALID_CONN_ID GATT_INVALID_CONN_ID /* Client callback function events */ #define BTA_GATTC_REG_EVT 0 /* GATT client is registered. */ #define BTA_GATTC_DEREG_EVT 1 /* GATT client deregistered event */ #define BTA_GATTC_OPEN_EVT 2 /* GATTC open request status event */ #define BTA_GATTC_READ_CHAR_EVT 3 /* GATT read characteristic event */ #define BTA_GATTC_WRITE_CHAR_EVT 4 /* GATT write characteristic or char descriptor event */ #define BTA_GATTC_CLOSE_EVT 5 /* GATTC close request status event */ #define BTA_GATTC_SEARCH_CMPL_EVT 6 /* GATT discovery complete event */ #define BTA_GATTC_SEARCH_RES_EVT 7 /* GATT discovery result event */ #define BTA_GATTC_READ_DESCR_EVT 8 /* GATT read characterisitc descriptor event */ #define BTA_GATTC_WRITE_DESCR_EVT 9 /* GATT write characteristic descriptor event */ #define BTA_GATTC_NOTIF_EVT 10 /* GATT attribute notification event */ #define BTA_GATTC_PREP_WRITE_EVT 11 /* GATT prepare write event */ #define BTA_GATTC_EXEC_EVT 12 /* execute write complete event */ #define BTA_GATTC_ACL_EVT 13 /* ACL up event */ #define BTA_GATTC_CANCEL_OPEN_EVT 14 /* cancel open event */ #define BTA_GATTC_SRVC_CHG_EVT 15 /* service change event */ typedef UINT8 tBTA_GATTC_EVT; typedef tGATT_IF tBTA_GATTC_IF; typedef struct { UINT16 unit; /* as UUIUD defined by SIG */ UINT16 descr; /* as UUID as defined by SIG */ tGATT_FORMAT format; INT8 exp; UINT8 name_spc; /* The name space of the description */ }tBTA_GATT_CHAR_PRES; #define BTA_GATT_CLT_CONFIG_NONE GATT_CLT_CONFIG_NONE /* 0x0000 */ #define BTA_GATT_CLT_CONFIG_NOTIFICATION GATT_CLT_CONFIG_NOTIFICATION /* 0x0001 */ #define BTA_GATT_CLT_CONFIG_INDICATION GATT_CLT_CONFIG_INDICATION /* 0x0002 */ typedef UINT16 tBTA_GATT_CLT_CHAR_CONFIG; /* characteristic descriptor: server configuration value */ #define BTA_GATT_SVR_CONFIG_NONE GATT_SVR_CONFIG_NONE /* 0x0000 */ #define BTA_GATT_SVR_CONFIG_BROADCAST GATT_SVR_CONFIG_BROADCAST /* 0x0001 */ typedef UINT16 tBTA_GATT_SVR_CHAR_CONFIG; /* Characteristic Aggregate Format attribute value */ #define BTA_GATT_AGGR_HANDLE_NUM_MAX 10 typedef struct { UINT8 num_handle; UINT16 handle_list[BTA_GATT_AGGR_HANDLE_NUM_MAX]; } tBTA_GATT_CHAR_AGGRE; typedef tGATT_VALID_RANGE tBTA_GATT_VALID_RANGE; typedef struct { UINT16 len; UINT8 *p_value; }tBTA_GATT_UNFMT; #define BTA_GATT_MAX_ATTR_LEN GATT_MAX_ATTR_LEN #define BTA_GATTC_TYPE_WRITE GATT_WRITE #define BTA_GATTC_TYPE_WRITE_NO_RSP GATT_WRITE_NO_RSP typedef UINT8 tBTA_GATTC_WRITE_TYPE; #define BTA_GATT_CONN_UNKNOWN 0 #define BTA_GATT_CONN_NO_RESOURCES GATT_CONN_NO_RESOURCES /* connection fail for l2cap resource failure */ #define BTA_GATT_CONN_TIMEOUT GATT_CONN_TIMEOUT /* 0x08 connection timeout */ #define BTA_GATT_CONN_TERMINATE_PEER_USER GATT_CONN_TERMINATE_PEER_USER /* 0x13 connection terminate by peer user */ #define BTA_GATT_CONN_TERMINATE_LOCAL_HOST GATT_CONN_TERMINATE_LOCAL_HOST/* 0x16 connectionterminated by local host */ #define BTA_GATT_CONN_FAIL_ESTABLISH GATT_CONN_FAIL_ESTABLISH /* 0x03E connection fail to establish */ #define BTA_GATT_CONN_LMP_TIMEOUT GATT_CONN_LMP_TIMEOUT /* 0x22 connection fail for LMP response tout */ #define BTA_GATT_CONN_CANCEL GATT_CONN_CANCEL /* 0x0100 L2CAP connection cancelled */ #define BTA_GATT_CONN_NONE 0x0101 /* 0x0101 no connection to cancel */ typedef UINT16 tBTA_GATT_REASON; typedef struct { tBTA_GATT_ID id; BOOLEAN is_primary; }tBTA_GATT_SRVC_ID; typedef struct { tBTA_GATT_SRVC_ID srvc_id; tBTA_GATT_ID char_id; }tBTA_GATTC_CHAR_ID; typedef struct { tBTA_GATTC_CHAR_ID char_id; tBT_UUID descr_type; }tBTA_GATTC_CHAR_DESCR_ID; typedef struct { tBTA_GATT_SRVC_ID srvc_id; tBTA_GATT_SRVC_ID incl_svc_id; }tBTA_GATTC_INCL_SVC_ID; #define BTA_GATT_TYPE_CHAR 0 #define BTA_GATT_TYPE_CHAR_DESCR 1 typedef UINT8 tBTA_GATT_ID_TYPE; typedef struct { tBTA_GATT_ID_TYPE id_type; union { tBTA_GATTC_CHAR_ID char_id; tBTA_GATTC_CHAR_DESCR_ID char_descr_id; } id_value; }tBTA_GATTC_ATTR_ID; #define BTA_GATTC_MULTI_MAX GATT_MAX_READ_MULTI_HANDLES typedef struct { UINT8 num_attr; tBTA_GATTC_ATTR_ID id_list[BTA_GATTC_MULTI_MAX]; }tBTA_GATTC_MULTI; #define BTA_GATT_AUTH_REQ_NONE GATT_AUTH_REQ_NONE #define BTA_GATT_AUTH_REQ_NO_MITM GATT_AUTH_REQ_NO_MITM /* unauthenticated encryption */ #define BTA_GATT_AUTH_REQ_MITM GATT_AUTH_REQ_MITM /* authenticated encryption */ #define BTA_GATT_AUTH_REQ_SIGNED_NO_MITM GATT_AUTH_REQ_SIGNED_NO_MITM #define BTA_GATT_AUTH_REQ_SIGNED_MITM GATT_AUTH_REQ_SIGNED_MITM typedef tGATT_AUTH_REQ tBTA_GATT_AUTH_REQ; enum { BTA_GATTC_ATTR_TYPE_INCL_SRVC, BTA_GATTC_ATTR_TYPE_CHAR, BTA_GATTC_ATTR_TYPE_CHAR_DESCR, BTA_GATTC_ATTR_TYPE_SRVC }; typedef UINT8 tBTA_GATTC_ATTR_TYPE; typedef struct { tBT_UUID uuid; UINT16 s_handle; UINT16 e_handle; /* used for service only */ UINT8 attr_type; UINT8 id; UINT8 prop; /* used when attribute type is characteristic */ BOOLEAN is_primary; /* used when attribute type is service */ }tBTA_GATTC_NV_ATTR; /* callback data structure */ typedef struct { tBTA_GATT_STATUS status; tBTA_GATTC_IF client_if; // btla-specific ++ tBT_UUID app_uuid; // btla-specific -- }tBTA_GATTC_REG; typedef struct { UINT8 num_pres_fmt; /* number of presentation format aggregated*/ tBTA_GATTC_CHAR_DESCR_ID pre_format[BTA_GATTC_MULTI_MAX]; }tBTA_GATT_CHAR_AGGRE_VALUE; typedef union { tBTA_GATT_CHAR_AGGRE_VALUE aggre_value; tBTA_GATT_UNFMT unformat; }tBTA_GATT_READ_VAL; typedef struct { UINT16 conn_id; tBTA_GATT_STATUS status; tBTA_GATT_SRVC_ID srvc_id; tBTA_GATT_ID char_id; tBT_UUID descr_type; tBTA_GATT_READ_VAL *p_value; }tBTA_GATTC_READ; typedef struct { UINT16 conn_id; tBTA_GATT_STATUS status; tBTA_GATT_SRVC_ID srvc_id; tBTA_GATT_ID char_id; tBT_UUID descr_type; }tBTA_GATTC_WRITE; typedef struct { UINT16 conn_id; tBTA_GATT_STATUS status; }tBTA_GATTC_EXEC_CMPL; typedef struct { UINT16 conn_id; tBTA_GATT_STATUS status; }tBTA_GATTC_SEARCH_CMPL; typedef struct { UINT16 conn_id; tBTA_GATT_SRVC_ID service_uuid; }tBTA_GATTC_SRVC_RES; typedef struct { tBTA_GATT_STATUS status; UINT16 conn_id; tBTA_GATTC_IF client_if; BD_ADDR remote_bda; }tBTA_GATTC_OPEN; typedef struct { tBTA_GATT_STATUS status; UINT16 conn_id; tBTA_GATTC_IF client_if; BD_ADDR remote_bda; tBTA_GATT_REASON reason; /* disconnect reason code, not useful when connect event is reported */ }tBTA_GATTC_CLOSE; typedef struct { UINT16 conn_id; BD_ADDR bda; tBTA_GATTC_CHAR_ID char_id; tBT_UUID descr_type; UINT16 len; UINT8 value[BTA_GATT_MAX_ATTR_LEN]; BOOLEAN is_notify; }tBTA_GATTC_NOTIFY; // btla-specific ++ typedef struct { tBTA_GATT_STATUS status; tBTA_GATTC_IF client_if; UINT16 conn_id; BD_ADDR remote_bda; }tBTA_GATTC_OPEN_CLOSE; // btla-specific -- typedef union { tBTA_GATT_STATUS status; tBTA_GATTC_SEARCH_CMPL search_cmpl; /* discovery complete */ tBTA_GATTC_SRVC_RES srvc_res; /* discovery result */ tBTA_GATTC_REG reg_oper; /* registration data */ tBTA_GATTC_OPEN open; tBTA_GATTC_CLOSE close; tBTA_GATTC_READ read; /* read attribute/descriptor data */ tBTA_GATTC_WRITE write; /* write complete data */ tBTA_GATTC_EXEC_CMPL exec_cmpl; /* execute complete */ tBTA_GATTC_NOTIFY notify; /* notification/indication event data */ BD_ADDR remote_bda; /* service change event */ } tBTA_GATTC; /* Client callback function */ typedef void (tBTA_GATTC_CBACK)(tBTA_GATTC_EVT event, tBTA_GATTC *p_data); /* GATT Server Data Structure */ /* Server callback function events */ #define BTA_GATTS_REG_EVT 0 #define BTA_GATTS_READ_EVT GATTS_REQ_TYPE_READ /* 1 */ #define BTA_GATTS_WRITE_EVT GATTS_REQ_TYPE_WRITE /* 2 */ #define BTA_GATTS_EXEC_WRITE_EVT GATTS_REQ_TYPE_WRITE_EXEC /* 3 */ #define BTA_GATTS_MTU_EVT GATTS_REQ_TYPE_MTU /* 4 */ #define BTA_GATTS_CONF_EVT GATTS_REQ_TYPE_CONF /* 5 */ #define BTA_GATTS_DEREG_EVT 6 #define BTA_GATTS_CREATE_EVT 7 #define BTA_GATTS_ADD_INCL_SRVC_EVT 8 #define BTA_GATTS_ADD_CHAR_EVT 9 #define BTA_GATTS_ADD_CHAR_DESCR_EVT 10 #define BTA_GATTS_DELELTE_EVT 11 #define BTA_GATTS_START_EVT 12 #define BTA_GATTS_STOP_EVT 13 #define BTA_GATTS_CONNECT_EVT 14 #define BTA_GATTS_DISCONNECT_EVT 15 #define BTA_GATTS_OPEN_EVT 16 #define BTA_GATTS_CANCEL_OPEN_EVT 17 #define BTA_GATTS_CLOSE_EVT 18 typedef UINT8 tBTA_GATTS_EVT; typedef tGATT_IF tBTA_GATTS_IF; /* Attribute permissions */ #define BTA_GATT_PERM_READ GATT_PERM_READ /* bit 0 - 0x0001 */ #define BTA_GATT_PERM_READ_ENCRYPTED GATT_PERM_READ_ENCRYPTED /* bit 1 - 0x0002 */ #define BTA_GATT_PERM_READ_ENC_MITM GATT_PERM_READ_ENC_MITM /* bit 2 - 0x0004 */ #define BTA_GATT_PERM_WRITE GATT_PERM_WRITE /* bit 4 - 0x0010 */ #define BTA_GATT_PERM_WRITE_ENCRYPTED GATT_PERM_WRITE_ENCRYPTED /* bit 5 - 0x0020 */ #define BTA_GATT_PERM_WRITE_ENC_MITM GATT_PERM_WRITE_ENC_MITM /* bit 6 - 0x0040 */ #define BTA_GATT_PERM_WRITE_SIGNED GATT_PERM_WRITE_SIGNED /* bit 7 - 0x0080 */ #define BTA_GATT_PERM_WRITE_SIGNED_MITM GATT_PERM_WRITE_SIGNED_MITM /* bit 8 - 0x0100 */ typedef UINT16 tBTA_GATT_PERM; #define BTA_GATTS_INVALID_APP 0xff #define BTA_GATTS_INVALID_IF 0 /* definition of characteristic properties */ #define BTA_GATT_CHAR_PROP_BIT_BROADCAST GATT_CHAR_PROP_BIT_BROADCAST /* 0x01 */ #define BTA_GATT_CHAR_PROP_BIT_READ GATT_CHAR_PROP_BIT_READ /* 0x02 */ #define BTA_GATT_CHAR_PROP_BIT_WRITE_NR GATT_CHAR_PROP_BIT_WRITE_NR /* 0x04 */ #define BTA_GATT_CHAR_PROP_BIT_WRITE GATT_CHAR_PROP_BIT_WRITE /* 0x08 */ #define BTA_GATT_CHAR_PROP_BIT_NOTIFY GATT_CHAR_PROP_BIT_NOTIFY /* 0x10 */ #define BTA_GATT_CHAR_PROP_BIT_INDICATE GATT_CHAR_PROP_BIT_INDICATE /* 0x20 */ #define BTA_GATT_CHAR_PROP_BIT_AUTH GATT_CHAR_PROP_BIT_AUTH /* 0x40 */ #define BTA_GATT_CHAR_PROP_BIT_EXT_PROP GATT_CHAR_PROP_BIT_EXT_PROP /* 0x80 */ typedef UINT8 tBTA_GATT_CHAR_PROP; #ifndef BTA_GATTC_CHAR_DESCR_MAX #define BTA_GATTC_CHAR_DESCR_MAX 7 #endif /*********************** NV callback Data Definitions ********************** */ typedef struct { tBT_UUID app_uuid128; tBT_UUID svc_uuid; UINT16 svc_inst; UINT16 s_handle; UINT16 e_handle; BOOLEAN is_primary; /* primary service or secondary */ } tBTA_GATTS_HNDL_RANGE; #define BTA_GATTS_SRV_CHG_CMD_ADD_CLIENT GATTS_SRV_CHG_CMD_ADD_CLIENT #define BTA_GATTS_SRV_CHG_CMD_UPDATE_CLIENT GATTS_SRV_CHG_CMD_UPDATE_CLIENT #define BTA_GATTS_SRV_CHG_CMD_REMOVE_CLIENT GATTS_SRV_CHG_CMD_REMOVE_CLIENT #define BTA_GATTS_SRV_CHG_CMD_READ_NUM_CLENTS GATTS_SRV_CHG_CMD_READ_NUM_CLENTS #define BTA_GATTS_SRV_CHG_CMD_READ_CLENT GATTS_SRV_CHG_CMD_READ_CLENT typedef tGATTS_SRV_CHG_CMD tBTA_GATTS_SRV_CHG_CMD; typedef tGATTS_SRV_CHG tBTA_GATTS_SRV_CHG; typedef tGATTS_SRV_CHG_REQ tBTA_GATTS_SRV_CHG_REQ; typedef tGATTS_SRV_CHG_RSP tBTA_GATTS_SRV_CHG_RSP; enum { BTA_GATT_TRANSPORT_LE, BTA_GATT_TRANSPORT_BR_EDR, BTA_GATT_TRANSPORT_LE_BR_EDR }; typedef UINT8 tBTA_GATT_TRANSPORT; /* attribute value */ typedef tGATT_VALUE tBTA_GATT_VALUE; /* attribute response data */ typedef tGATTS_RSP tBTA_GATTS_RSP; /* attribute request data from the client */ #define BTA_GATT_PREP_WRITE_CANCEL 0x00 #define BTA_GATT_PREP_WRITE_EXEC 0x01 typedef tGATT_EXEC_FLAG tBTA_GATT_EXEC_FLAG; /* read request always based on UUID */ typedef tGATT_READ_REQ tTA_GBATT_READ_REQ; /* write request data */ typedef tGATT_WRITE_REQ tBTA_GATT_WRITE_REQ; /* callback data for server access request from client */ typedef tGATTS_DATA tBTA_GATTS_REQ_DATA; typedef struct { BD_ADDR remote_bda; UINT32 trans_id; UINT16 conn_id; tBTA_GATTS_REQ_DATA *p_data; }tBTA_GATTS_REQ; typedef struct { tBTA_GATTS_IF server_if; tBTA_GATT_STATUS status; // btla-specific ++ tBT_UUID uuid; // btla-specific -- }tBTA_GATTS_REG_OPER; typedef struct { tBTA_GATTS_IF server_if; UINT16 service_id; // btla-specific ++ UINT16 svc_instance; BOOLEAN is_primary; tBTA_GATT_STATUS status; tBT_UUID uuid; // btla-specific -- }tBTA_GATTS_CREATE; typedef struct { tBTA_GATTS_IF server_if; UINT16 service_id; UINT16 attr_id; tBTA_GATT_STATUS status; // btla-specific ++ tBT_UUID char_uuid; // btla-specific -- }tBTA_GATTS_ADD_RESULT; typedef struct { tBTA_GATTS_IF server_if; UINT16 service_id; tBTA_GATT_STATUS status; }tBTA_GATTS_SRVC_OPER; typedef struct { tBTA_GATTS_IF server_if; BD_ADDR remote_bda; UINT16 conn_id; tBTA_GATT_REASON reason; /* report disconnect reason */ }tBTA_GATTS_CONN; /* GATTS callback data */ typedef union { tBTA_GATTS_REG_OPER reg_oper; tBTA_GATTS_CREATE create; tBTA_GATTS_SRVC_OPER srvc_oper; tBTA_GATT_STATUS status; /* BTA_GATTS_CONF_EVT */ tBTA_GATTS_ADD_RESULT add_result; /* add included service: BTA_GATTS_ADD_INCL_SRVC_EVT add char : BTA_GATTS_ADD_CHAR_EVT add char descriptor: BTA_GATTS_ADD_CHAR_DESCR_EVT */ tBTA_GATTS_REQ req_data; tBTA_GATTS_CONN conn; /* BTA_GATTS_CONN_EVT */ }tBTA_GATTS; /* Server callback function */ typedef void (tBTA_GATTS_CBACK)(tBTA_GATTS_EVT event, tBTA_GATTS *p_data); /***************************************************************************** ** External Function Declarations *****************************************************************************/ #ifdef __cplusplus extern "C" { #endif /************************** ** Client Functions ***************************/ /******************************************************************************* ** ** Function BTA_GATTC_AppRegister ** ** Description This function is called to register application callbacks ** with BTA GATTC module. ** ** Parameters p_app_uuid - applicaiton UUID ** p_client_cb - pointer to the application callback function. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_AppRegister(tBT_UUID *p_app_uuid, tBTA_GATTC_CBACK *p_client_cb); /******************************************************************************* ** ** Function BTA_GATTC_AppDeregister ** ** Description This function is called to deregister an application ** from BTA GATTC module. ** ** Parameters client_if - client interface identifier. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_AppDeregister (tBTA_GATTC_IF client_if); /******************************************************************************* ** ** Function BTA_GATTC_Open ** ** Description Open a direct connection or add a background auto connection ** bd address ** ** Parameters client_if: server interface. ** remote_bda: remote device BD address. ** is_direct: direct connection or background auto connection ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTC_Open(tBTA_GATTC_IF client_if, BD_ADDR remote_bda, BOOLEAN is_direct); /******************************************************************************* ** ** Function BTA_GATTC_CancelOpen ** ** Description Open a direct connection or add a background auto connection ** bd address ** ** Parameters client_if: server interface. ** remote_bda: remote device BD address. ** is_direct: direct connection or background auto connection ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTC_CancelOpen(tBTA_GATTC_IF client_if, BD_ADDR remote_bda, BOOLEAN is_direct); /******************************************************************************* ** ** Function BTA_GATTC_Close ** ** Description Close a connection to a GATT server. ** ** Parameters conn_id: connectino ID to be closed. ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTC_Close(UINT16 conn_id); /******************************************************************************* ** ** Function BTA_GATTC_ServiceSearchRequest ** ** Description This function is called to request a GATT service discovery ** on a GATT server. This function report service search result ** by a callback event, and followed by a service search complete ** event. ** ** Parameters conn_id: connection ID. ** p_srvc_uuid: a UUID of the service application is interested in. ** If Null, discover for all services. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_ServiceSearchRequest(UINT16 conn_id, tBT_UUID *p_srvc_uuid); /******************************************************************************* ** ** Function BTA_GATTC_GetFirstChar ** ** Description This function is called to find the first charatceristic of the ** service on the given server. ** ** Parameters conn_id: connection ID which identify the server. ** p_srvc_id: the service ID of which the characteristic is belonged to. ** p_char_uuid_cond: Characteristic UUID, if NULL find the first available ** characteristic. ** p_char_result: output parameter which will store the GATT ** characteristic ID. ** p_property: output parameter to carry the characteristic property. ** ** Returns returns status. ** *******************************************************************************/ BTA_API extern tBTA_GATT_STATUS BTA_GATTC_GetFirstChar (UINT16 conn_id, tBTA_GATT_SRVC_ID *p_srvc_id, tBT_UUID *p_char_uuid_cond, tBTA_GATTC_CHAR_ID *p_char_result, tBTA_GATT_CHAR_PROP *p_property); /******************************************************************************* ** ** Function BTA_GATTC_GetNextChar ** ** Description This function is called to find the next charatceristic of the ** service on the given server. ** ** Parameters conn_id: connection ID which identify the server. ** p_start_char_id: start the characteristic search from the next record ** after the one identified by char_id. ** p_char_uuid_cond: Characteristic UUID, if NULL find the first available ** characteristic. ** p_char_result: output parameter which will store the GATT ** characteristic ID. ** p_property: output parameter, characteristic property. ** ** Returns returns status. ** *******************************************************************************/ BTA_API extern tBTA_GATT_STATUS BTA_GATTC_GetNextChar (UINT16 conn_id, tBTA_GATTC_CHAR_ID *p_start_char_id, tBT_UUID *p_char_uuid_cond, tBTA_GATTC_CHAR_ID *p_char_result, tBTA_GATT_CHAR_PROP *p_property); /******************************************************************************* ** ** Function BTA_GATTC_GetFirstCharDescr ** ** Description This function is called to find the first charatceristic descriptor of the ** charatceristic on the given server. ** ** Parameters conn_id: connection ID which identify the server. ** p_char_id: the characteristic ID of which the descriptor is belonged to. ** p_descr_uuid_cond: Characteristic Descr UUID, if NULL find the first available ** characteristic. ** p_descr_result: output parameter which will store the GATT ** characteristic descriptor ID. ** ** Returns returns status. ** *******************************************************************************/ BTA_API extern tBTA_GATT_STATUS BTA_GATTC_GetFirstCharDescr (UINT16 conn_id, tBTA_GATTC_CHAR_ID *p_char_id, tBT_UUID *p_descr_uuid_cond, tBTA_GATTC_CHAR_DESCR_ID *p_descr_result); /******************************************************************************* ** ** Function BTA_GATTC_GetNextCharDescr ** ** Description This function is called to find the next charatceristic of the ** service on the given server. ** ** Parameters conn_id: connection ID which identify the server. ** p_start_descr_id: start the characteristic search from the next record ** after the one identified by p_start_descr_id. ** p_descr_uuid_cond: Characteristic descriptor UUID, if NULL find ** the first available characteristic descriptor. ** p_descr_result: output parameter which will store the GATT ** characteristic descriptor ID. ** ** Returns returns status. ** *******************************************************************************/ BTA_API extern tBTA_GATT_STATUS BTA_GATTC_GetNextCharDescr (UINT16 conn_id, tBTA_GATTC_CHAR_DESCR_ID *p_start_descr_id, tBT_UUID *p_descr_uuid_cond, tBTA_GATTC_CHAR_DESCR_ID *p_descr_result); /******************************************************************************* ** ** Function BTA_GATTC_GetFirstIncludedService ** ** Description This function is called to find the first included service of the ** service on the given server. ** ** Parameters conn_id: connection ID which identify the server. ** p_srvc_id: the service ID of which the included service is belonged to. ** p_uuid_cond: include service UUID, if NULL find the first available ** included service. ** p_result: output parameter which will store the GATT ID ** of the included service found. ** ** Returns returns status. ** *******************************************************************************/ BTA_API extern tBTA_GATT_STATUS BTA_GATTC_GetFirstIncludedService(UINT16 conn_id, tBTA_GATT_SRVC_ID *p_srvc_id, tBT_UUID *p_uuid_cond, tBTA_GATTC_INCL_SVC_ID *p_result); /******************************************************************************* ** ** Function BTA_GATTC_GetNextIncludedService ** ** Description This function is called to find the next included service of the ** service on the given server. ** ** Parameters conn_id: connection ID which identify the server. ** p_start_id: start the search from the next record ** after the one identified by p_start_id. ** p_uuid_cond: Included service UUID, if NULL find the first available ** included service. ** p_result: output parameter which will store the GATT ID ** of the included service found. ** ** Returns returns status. ** *******************************************************************************/ BTA_API extern tBTA_GATT_STATUS BTA_GATTC_GetNextIncludedService(UINT16 conn_id, tBTA_GATTC_INCL_SVC_ID *p_start_id, tBT_UUID *p_uuid_cond, tBTA_GATTC_INCL_SVC_ID *p_result); /******************************************************************************* ** ** Function BTA_GATTC_ReadCharacteristic ** ** Description This function is called to read a service's characteristics of ** the given characteritisc ID. ** ** Parameters conn_id - connectino ID. ** p_char_id - characteritic ID to read. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_ReadCharacteristic (UINT16 conn_id, tBTA_GATTC_CHAR_ID *p_char_id, tBTA_GATT_AUTH_REQ auth_req); /******************************************************************************* ** ** Function BTA_GATTC_ReadCharDescr ** ** Description This function is called to read a characteristics descriptor. ** ** Parameters conn_id - connection ID. ** p_char_descr_id - characteritic descriptor ID to read. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_ReadCharDescr (UINT16 conn_id, tBTA_GATTC_CHAR_DESCR_ID *p_char_descr_id, tBTA_GATT_AUTH_REQ auth_req); /******************************************************************************* ** ** Function BTA_GATTC_WriteCharValue ** ** Description This function is called to write characteristic value. ** ** Parameters conn_id - connection ID. ** p_char_id - characteristic ID to write. ** write_type - type of write. ** len: length of the data to be written. ** p_value - the value to be written. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_WriteCharValue (UINT16 conn_id, tBTA_GATTC_CHAR_ID *p_char_id, tBTA_GATTC_WRITE_TYPE write_type, UINT16 len, UINT8 *p_value, tBTA_GATT_AUTH_REQ auth_req); /******************************************************************************* ** ** Function BTA_GATTC_WriteCharDescr ** ** Description This function is called to write characteristic descriptor value. ** ** Parameters conn_id - connection ID ** p_char_descr_id - characteristic descriptor ID to write. ** write_type - type of write. ** p_value - the value to be written. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_WriteCharDescr (UINT16 conn_id, tBTA_GATTC_CHAR_DESCR_ID *p_char_descr_id, tBTA_GATTC_WRITE_TYPE write_type, tBTA_GATT_UNFMT *p_data, tBTA_GATT_AUTH_REQ auth_req); /******************************************************************************* ** ** Function BTA_GATTC_SendIndConfirm ** ** Description This function is called to send handle value confirmation. ** ** Parameters conn_id - connection ID. ** p_char_id - characteristic ID to confrim. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_SendIndConfirm (UINT16 conn_id, tBTA_GATTC_CHAR_ID *p_char_id); /******************************************************************************* ** ** Function BTA_GATTC_RegisterForNotifications ** ** Description This function is called to register for notification of a service. ** ** Parameters client_if - client interface. ** remote_bda - target GATT server. ** p_char_id - pointer to GATT characteristic ID. ** ** Returns OK if registration succeed, otherwise failed. ** *******************************************************************************/ BTA_API extern tBTA_GATT_STATUS BTA_GATTC_RegisterForNotifications (tBTA_GATTC_IF client_if, BD_ADDR remote_bda, tBTA_GATTC_CHAR_ID *p_char_id); /******************************************************************************* ** ** Function BTA_GATTC_DeregisterForNotifications ** ** Description This function is called to de-register for notification of a servbice. ** ** Parameters client_if - client interface. ** remote_bda - target GATT server. ** p_char_id - pointer to a GATT characteristic ID. ** ** Returns OK if deregistration succeed, otherwise failed. ** *******************************************************************************/ BTA_API extern tBTA_GATT_STATUS BTA_GATTC_DeregisterForNotifications (tBTA_GATTC_IF client_if, BD_ADDR remote_bda, tBTA_GATTC_CHAR_ID *p_char_id); /******************************************************************************* ** ** Function BTA_GATTC_PrepareWrite ** ** Description This function is called to prepare write a characteristic value. ** ** Parameters conn_id - connection ID. ** p_char_id - GATT characteritic ID of the service. ** offset - offset of the write value. ** len: length of the data to be written. ** p_value - the value to be written. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_PrepareWrite (UINT16 conn_id, tBTA_GATTC_CHAR_ID *p_char_id, UINT16 offset, UINT16 len, UINT8 *p_value, tBTA_GATT_AUTH_REQ auth_req); /******************************************************************************* ** ** Function BTA_GATTC_ExecuteWrite ** ** Description This function is called to execute write a prepare write sequence. ** ** Parameters conn_id - connection ID. ** is_execute - execute or cancel. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_ExecuteWrite (UINT16 conn_id, BOOLEAN is_execute); /******************************************************************************* ** ** Function BTA_GATTC_ReadMultiple ** ** Description This function is called to read multiple characteristic or ** characteristic descriptors. ** ** Parameters conn_id - connectino ID. ** p_read_multi - read multiple parameters. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTC_ReadMultiple(UINT16 conn_id, tBTA_GATTC_MULTI *p_read_multi, tBTA_GATT_AUTH_REQ auth_req); /******************************************************************************* ** BTA GATT Server API ********************************************************************************/ /******************************************************************************* ** ** Function BTA_GATTS_AppRegister ** ** Description This function is called to register application callbacks ** with BTA GATTS module. ** ** Parameters p_app_uuid - applicaiton UUID ** p_cback - pointer to the application callback function. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTS_AppRegister(tBT_UUID *p_app_uuid, tBTA_GATTS_CBACK *p_cback); /******************************************************************************* ** ** Function BTA_GATTS_AppDeregister ** ** Description De-register with BTA GATT Server. ** ** Parameters server_if: server interface ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTS_AppDeregister(tBTA_GATTS_IF server_if); /******************************************************************************* ** ** Function BTA_GATTS_CreateService ** ** Description Create a service. When service creation is done, a callback ** event BTA_GATTS_CREATE_SRVC_EVT is called to report status ** and service ID to the profile. The service ID obtained in ** the callback function needs to be used when adding included ** service and characteristics/descriptors into the service. ** ** Parameters server_if: server interface. ** p_service_uuid: service UUID. ** inst: instance ID number of this service. ** num_handle: numble of handle requessted for this service. ** is_primary: is this service a primary one or not. ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTS_CreateService(tBTA_GATTS_IF server_if, tBT_UUID *p_service_uuid, UINT8 inst, UINT16 num_handle, BOOLEAN is_primary); /******************************************************************************* ** ** Function BTA_GATTS_AddIncludeService ** ** Description This function is called to add an included service. After included ** service is included, a callback event BTA_GATTS_ADD_INCL_SRVC_EVT ** is reported the included service ID. ** ** Parameters service_id: service ID to which this included service is to ** be added. ** included_service_id: the service ID to be included. ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTS_AddIncludeService(UINT16 service_id, UINT16 included_service_id); /******************************************************************************* ** ** Function BTA_GATTS_AddCharacteristic ** ** Description This function is called to add a characteristic into a service. ** ** Parameters service_id: service ID to which this included service is to ** be added. ** p_char_uuid : Characteristic UUID. ** perm : Characteristic value declaration attribute permission. ** property : Characteristic Properties ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTS_AddCharacteristic (UINT16 service_id, tBT_UUID *p_char_uuid, tBTA_GATT_PERM perm, tBTA_GATT_CHAR_PROP property); /******************************************************************************* ** ** Function BTA_GATTS_AddCharDescriptor ** ** Description This function is called to add characteristic descriptor. When ** it's done, a callback event BTA_GATTS_ADD_DESCR_EVT is called ** to report the status and an ID number for this descriptor. ** ** Parameters service_id: service ID to which this charatceristic descriptor is to ** be added. ** perm: descriptor access permission. ** p_descr_uuid: descriptor UUID. ** p_descr_params: descriptor value if it's read only descriptor. ** ** Returns returns status. ** *******************************************************************************/ BTA_API extern void BTA_GATTS_AddCharDescriptor (UINT16 service_id, tBTA_GATT_PERM perm, tBT_UUID * p_descr_uuid); /******************************************************************************* ** ** Function BTA_GATTS_DeleteService ** ** Description This function is called to delete a service. When this is done, ** a callback event BTA_GATTS_DELETE_EVT is report with the status. ** ** Parameters service_id: service_id to be deleted. ** ** Returns returns none. ** *******************************************************************************/ BTA_API extern void BTA_GATTS_DeleteService(UINT16 service_id); /******************************************************************************* ** ** Function BTA_GATTS_StartService ** ** Description This function is called to start a service. ** ** Parameters service_id: the service ID to be started. ** sup_transport: supported trasnport. ** ** Returns None. ** *******************************************************************************/ BTA_API extern void BTA_GATTS_StartService(UINT16 service_id, tBTA_GATT_TRANSPORT sup_transport); /******************************************************************************* ** ** Function BTA_GATTS_StopService ** ** Description This function is called to stop a service. ** ** Parameters service_id - service to be topped. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTS_StopService(UINT16 service_id); /******************************************************************************* ** ** Function BTA_GATTS_HandleValueIndication ** ** Description This function is called to read a characteristics descriptor. ** ** Parameters conn_id - connection identifier. ** attr_id - attribute ID to indicate. ** data_len - indicate data length. ** p_data: data to indicate. ** need_confirm - if this indication expects a confirmation or not. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTS_HandleValueIndication (UINT16 conn_id, UINT16 attr_id, UINT16 data_len, UINT8 *p_data, BOOLEAN need_confirm); /******************************************************************************* ** ** Function BTA_GATTS_SendRsp ** ** Description This function is called to send a response to a request. ** ** Parameters conn_id - connection identifier. ** trans_id - transaction ID. ** status - response status ** p_msg - response data. ** ** Returns None ** *******************************************************************************/ BTA_API extern void BTA_GATTS_SendRsp (UINT16 conn_id, UINT32 trans_id, tBTA_GATT_STATUS status, tBTA_GATTS_RSP *p_msg); /******************************************************************************* ** ** Function BTA_GATTS_Open ** ** Description Open a direct open connection or add a background auto connection ** bd address ** ** Parameters server_if: server interface. ** remote_bda: remote device BD address. ** is_direct: direct connection or background auto connection ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTS_Open(tBTA_GATTS_IF server_if, BD_ADDR remote_bda, BOOLEAN is_direct); /******************************************************************************* ** ** Function BTA_GATTS_CancelOpen ** ** Description Cancel a direct open connection or remove a background auto connection ** bd address ** ** Parameters server_if: server interface. ** remote_bda: remote device BD address. ** is_direct: direct connection or background auto connection ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTS_CancelOpen(tBTA_GATTS_IF server_if, BD_ADDR remote_bda, BOOLEAN is_direct); /******************************************************************************* ** ** Function BTA_GATTS_Close ** ** Description Close a connection a remote device. ** ** Parameters conn_id: connectino ID to be closed. ** ** Returns void ** *******************************************************************************/ BTA_API extern void BTA_GATTS_Close(UINT16 conn_id); #ifdef __cplusplus } #endif #endif /* BTA_GATT_API_H */