277 lines
8.1 KiB
C
277 lines
8.1 KiB
C
|
/**
|
||
|
|
*****************************************************************************************
|
||
|
|
* Copyright(c) 2019, Realtek Semiconductor Corporation. All rights reserved.
|
||
|
|
*****************************************************************************************
|
||
|
|
* @file gatts_client.h
|
||
|
|
* @brief Head file for using GATT service client.
|
||
|
|
* @details GATT service client data structs and external functions declaration.
|
||
|
|
* @author
|
||
|
|
* @date 2019-05-27
|
||
|
|
* @version v0.1
|
||
|
|
* *************************************************************************************
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* Define to prevent recursive inclusion */
|
||
|
|
#ifndef _GATTS_CLIENT_H_
|
||
|
|
#define _GATTS_CLIENT_H_
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif /* __cplusplus */
|
||
|
|
|
||
|
|
/* Add Includes here */
|
||
|
|
#include <profile_client.h>
|
||
|
|
|
||
|
|
/** @defgroup GATTS_Client GATT Service Client
|
||
|
|
* @brief GATT service client
|
||
|
|
* @details
|
||
|
|
Application shall register gatts client when initialization through @ref gatts_add_client function.
|
||
|
|
|
||
|
|
Application can start discovery GATT service through @ref gatts_start_discovery function.
|
||
|
|
|
||
|
|
* \code{.c}
|
||
|
|
T_APP_RESULT app_client_callback(T_CLIENT_ID client_id, uint8_t conn_id, void *p_data)
|
||
|
|
{
|
||
|
|
if (client_id == gatts_client_id)
|
||
|
|
{
|
||
|
|
T_GATTS_CLIENT_CB_DATA *p_gatts_cb_data = (T_GATTS_CLIENT_CB_DATA *)p_data;
|
||
|
|
switch (p_gatts_cb_data->cb_type)
|
||
|
|
{
|
||
|
|
case GATTS_CLIENT_CB_TYPE_DISC_STATE:
|
||
|
|
switch (p_gatts_cb_data->cb_content.disc_state)
|
||
|
|
{
|
||
|
|
case DISC_GATTS_DONE:
|
||
|
|
......
|
||
|
|
}
|
||
|
|
}
|
||
|
|
* \endcode
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** @defgroup GATTS_Client_Exported_Macros GATTS Client Exported Macros
|
||
|
|
* @brief
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
/** @brief Define links number. range: 0-4 */
|
||
|
|
#define GATTS_MAX_LINKS 4
|
||
|
|
|
||
|
|
/** @brief GATT service UUID */
|
||
|
|
#define GATT_UUID_GATT 0x1801
|
||
|
|
/** End of GATTS_Client_Exported_Macros * @} */
|
||
|
|
|
||
|
|
/** @defgroup GATTS_Client_Exported_Types GATTS Client Exported Types
|
||
|
|
* @brief
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
/** @brief GATTS client handle type */
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
HDL_GATTS_SRV_START, //!< start handle of gap service
|
||
|
|
HDL_GATTS_SRV_END, //!< end handle of gap service
|
||
|
|
HDL_GATTS_SERVICE_CHANGED, //!< service changed handle
|
||
|
|
HDL_GATTS_SERVICE_CHANGED_CCCD, //!< service changed CCCD handle
|
||
|
|
HDL_GATTS_CACHE_LEN, //!< handle cache length
|
||
|
|
} T_GATTS_CLIENT_HANDLE_TYPE;
|
||
|
|
|
||
|
|
/** @brief GATTS client discovery state */
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
DISC_GATTS_IDLE,
|
||
|
|
DISC_GATTS_START,
|
||
|
|
DISC_GATTS_DONE,
|
||
|
|
DISC_GATTS_FAILED,
|
||
|
|
} T_GATTS_DISC_STATE;
|
||
|
|
|
||
|
|
/** @brief Client Supported Features value */
|
||
|
|
typedef struct
|
||
|
|
{
|
||
|
|
uint16_t value_size;
|
||
|
|
uint8_t *p_value;
|
||
|
|
} T_CLIENT_SUPPORTED_FEATURES;
|
||
|
|
|
||
|
|
/** @brief GATTS client read content */
|
||
|
|
typedef union
|
||
|
|
{
|
||
|
|
T_CLIENT_SUPPORTED_FEATURES client_supported_features;
|
||
|
|
uint8_t database_hash[GATTS_DATABASE_HASH_LEN];
|
||
|
|
} T_GATTS_READ_DATA;
|
||
|
|
|
||
|
|
/** @brief GATTS client write type*/
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
GATTS_WRITE_SERVICE_CHANGED_IND_ENABLE,
|
||
|
|
GATTS_WRITE_SERVICE_CHANGED_IND_DISABLE,
|
||
|
|
GATTS_WRITE_CLIENT_SUPPORTED_FEATURES,
|
||
|
|
} T_GATTS_WRTIE_TYPE;
|
||
|
|
|
||
|
|
/** @brief GATTS client write result*/
|
||
|
|
typedef struct
|
||
|
|
{
|
||
|
|
T_GATTS_WRTIE_TYPE type;
|
||
|
|
uint16_t cause;
|
||
|
|
} T_GATTS_WRITE_RESULT;
|
||
|
|
|
||
|
|
/** @brief GATTS client notif/ind receive type*/
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
GATTS_SERVICE_CHANGED_INDICATE,
|
||
|
|
} T_GATTS_NOTIF_IND_TYPE;
|
||
|
|
|
||
|
|
/** @brief GATTS client notif/ind receive data */
|
||
|
|
typedef struct
|
||
|
|
{
|
||
|
|
uint16_t value_size;
|
||
|
|
uint8_t *p_value;
|
||
|
|
} T_GATTS_NOTIF_IND_VALUE;
|
||
|
|
|
||
|
|
/** @brief GATTS client notif/ind receive content*/
|
||
|
|
typedef struct
|
||
|
|
{
|
||
|
|
T_GATTS_NOTIF_IND_TYPE type;
|
||
|
|
T_GATTS_NOTIF_IND_VALUE data;
|
||
|
|
} T_GATTS_NOTIF_IND_DATA;
|
||
|
|
|
||
|
|
/** @brief GATTS client callback type */
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
GATTS_CLIENT_CB_TYPE_DISC_STATE, //!< Discovery procedure state, done or pending.
|
||
|
|
GATTS_CLIENT_CB_TYPE_WRITE_RESULT, //!< Write request result, success or fail.
|
||
|
|
GATTS_CLIENT_CB_TYPE_NOTIF_IND_RESULT, //!< Notification or indication data received from server.
|
||
|
|
GATTS_CLIENT_CB_TYPE_INVALID, //!< Invalid callback type, no practical usage.
|
||
|
|
} T_GATTS_CLIENT_CB_TYPE;
|
||
|
|
|
||
|
|
/** @brief GATTS client callback content */
|
||
|
|
typedef union
|
||
|
|
{
|
||
|
|
T_GATTS_DISC_STATE disc_state;
|
||
|
|
T_GATTS_WRITE_RESULT write_result;
|
||
|
|
T_GATTS_NOTIF_IND_DATA notif_ind_data;
|
||
|
|
} T_GATTS_CLIENT_CB_CONTENT;
|
||
|
|
|
||
|
|
/** @brief GATTS client callback data */
|
||
|
|
typedef struct
|
||
|
|
{
|
||
|
|
T_GATTS_CLIENT_CB_TYPE cb_type;
|
||
|
|
T_GATTS_CLIENT_CB_CONTENT cb_content;
|
||
|
|
} T_GATTS_CLIENT_CB_DATA;
|
||
|
|
|
||
|
|
/** End of GATTS_Client_Exported_Types * @} */
|
||
|
|
|
||
|
|
/** @defgroup GATTS_Client_Exported_Functions GATTS Client Exported Functions
|
||
|
|
* @brief
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* @brief Add gatts service client to application.
|
||
|
|
* @param[in] app_cb pointer of app callback function to handle specific client module data.
|
||
|
|
* @param[in] link_num initialize link num.
|
||
|
|
* @return Client ID of the specific client module.
|
||
|
|
* @retval 0xff failed.
|
||
|
|
* @retval other success.
|
||
|
|
*
|
||
|
|
* <b>Example usage</b>
|
||
|
|
* \code{.c}
|
||
|
|
void app_le_profile_init(void)
|
||
|
|
{
|
||
|
|
client_init(1);
|
||
|
|
gatts_client_id = gatts_add_client(app_client_callback, APP_MAX_LINKS);
|
||
|
|
}
|
||
|
|
* \endcode
|
||
|
|
*/
|
||
|
|
T_CLIENT_ID gatts_add_client(P_FUN_GENERAL_APP_CB app_cb, uint8_t link_num);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Used by application, to start the discovery procedure of GATT service.
|
||
|
|
* @param[in] conn_id connection ID.
|
||
|
|
* @retval true send request to upper stack success.
|
||
|
|
* @retval false send request to upper stack failed.
|
||
|
|
*
|
||
|
|
* <b>Example usage</b>
|
||
|
|
* \code{.c}
|
||
|
|
static T_USER_CMD_PARSE_RESULT cmd_gattsdis(T_USER_CMD_PARSED_VALUE *p_parse_value)
|
||
|
|
{
|
||
|
|
uint8_t conn_id = p_parse_value->dw_param[0];
|
||
|
|
bool ret = gatts_start_discovery(conn_id);
|
||
|
|
......
|
||
|
|
}
|
||
|
|
* \endcode
|
||
|
|
*/
|
||
|
|
bool gatts_start_discovery(uint8_t conn_id);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Used by application, to set the indication flag of service changed characteristic.
|
||
|
|
* @param[in] conn_id connection ID.
|
||
|
|
* @param[in] ind value to enable or disable indication.
|
||
|
|
* @retval true send request to upper stack success.
|
||
|
|
* @retval false send request to upper stack failed.
|
||
|
|
*
|
||
|
|
* <b>Example usage</b>
|
||
|
|
* \code{.c}
|
||
|
|
static T_USER_CMD_PARSE_RESULT cmd_srvchgcccd(T_USER_CMD_PARSED_VALUE *p_parse_value)
|
||
|
|
{
|
||
|
|
uint8_t conn_id = p_parse_value->dw_param[0];
|
||
|
|
bool ind = p_parse_value->dw_param[1];
|
||
|
|
bool ret;
|
||
|
|
ret = gatts_client_set_service_changed_ind(conn_id, ind);
|
||
|
|
......
|
||
|
|
}
|
||
|
|
* \endcode
|
||
|
|
*/
|
||
|
|
bool gatts_client_set_service_changed_ind(uint8_t conn_id, bool ind);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Used by application, to get handle cache.
|
||
|
|
* @param[in] conn_id connection ID.
|
||
|
|
* @param[in,out] p_hdl_cache pointer of the handle cache table
|
||
|
|
* @param[in] len the length of handle cache table
|
||
|
|
* @retval true success.
|
||
|
|
* @retval false failed.
|
||
|
|
*
|
||
|
|
* <b>Example usage</b>
|
||
|
|
* \code{.c}
|
||
|
|
static T_USER_CMD_PARSE_RESULT cmd_gattshdl(T_USER_CMD_PARSED_VALUE *p_parse_value)
|
||
|
|
{
|
||
|
|
uint8_t conn_id = p_parse_value->dw_param[0];
|
||
|
|
uint16_t hdl_cache[HDL_GATTS_CACHE_LEN];
|
||
|
|
uint8_t hdl_idx;
|
||
|
|
bool ret = gatts_get_hdl_cache(conn_id, hdl_cache, sizeof(uint16_t) * HDL_GATTS_CACHE_LEN);
|
||
|
|
......
|
||
|
|
}
|
||
|
|
* \endcode
|
||
|
|
*/
|
||
|
|
bool gatts_get_hdl_cache(uint8_t conn_id, uint16_t *p_hdl_cache, uint8_t len);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Used by application, to set handle cache.
|
||
|
|
* @param[in] conn_id connection ID.
|
||
|
|
* @param[in] p_hdl_cache pointer of the handle cache table
|
||
|
|
* @param[in] len the length of handle cache table
|
||
|
|
* @retval true success.
|
||
|
|
* @retval false failed.
|
||
|
|
*
|
||
|
|
* <b>Example usage</b>
|
||
|
|
* \code{.c}
|
||
|
|
void app_discov_services(uint8_t conn_id, bool start)
|
||
|
|
{
|
||
|
|
......
|
||
|
|
if (app_srvs_table.srv_found_flags & APP_DISCOV_GATTS_FLAG)
|
||
|
|
{
|
||
|
|
gatts_set_hdl_cache(conn_id, app_srvs_table.gatts_hdl_cache, sizeof(uint16_t) * HDL_GATTS_CACHE_LEN);
|
||
|
|
}
|
||
|
|
......
|
||
|
|
}
|
||
|
|
* \endcode
|
||
|
|
*/
|
||
|
|
bool gatts_set_hdl_cache(uint8_t conn_id, uint16_t *p_hdl_cache, uint8_t len);
|
||
|
|
|
||
|
|
/** @} End of GATTS_Client_Exported_Functions */
|
||
|
|
|
||
|
|
/** @} End of GATTS_Client */
|
||
|
|
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif /* __cplusplus */
|
||
|
|
|
||
|
|
#endif /* _GATTS_CLIENT_H_ */
|