diff options
Diffstat (limited to 'inc/bluetooth/profile/client/ancs_client.h')
| -rw-r--r-- | inc/bluetooth/profile/client/ancs_client.h | 300 |
1 files changed, 300 insertions, 0 deletions
diff --git a/inc/bluetooth/profile/client/ancs_client.h b/inc/bluetooth/profile/client/ancs_client.h new file mode 100644 index 0000000..164edb9 --- /dev/null +++ b/inc/bluetooth/profile/client/ancs_client.h @@ -0,0 +1,300 @@ +/** +***************************************************************************************** +* Copyright(c) 2016, Realtek Semiconductor Corporation. All rights reserved. +***************************************************************************************** + * @file ancs_client.h + * @brief Head file for using ANCS Client. + * @details + * @author jane + * @date 2016-02-18 + * @version v1.0 + * ************************************************************************************* + */ + +/* Define to prevent recursive inclusion */ +#ifndef _ANCS_CLIENT_H_ +#define _ANCS_CLIENT_H_ + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/* Add Includes here */ +#include <profile_client.h> +#include <stdint.h> +#include <stdbool.h> + + +/** @defgroup ANCS_CLIENT ANCS Client +* @brief ANCS client +* @{ +*/ + +/*============================================================================* + * Macros + *============================================================================*/ +/** @addtogroup ANCS_CLIENT_Exported_Macros ANCS Client Exported Macros + * @brief + * @{ + */ + +/** @brief Define links number. range: 0-4 */ +#define ANCS_MAX_LINKS 4 + + +/** End of ANCS_CLIENT_Exported_Macros +* @} +*/ + + +/*============================================================================* + * Types + *============================================================================*/ +/** @defgroup ANCS_CLIENT_Exported_Types ANCS Client Exported Types + * @brief + * @{ + */ + +/** @brief ANCS client handle type*/ +typedef enum +{ + HDL_ANCS_SRV_START, //!< start handle of ANCS + HDL_ANCS_SRV_END, //!< end handle of ANCS + HDL_ANCS_CONTROL_POINT, //!< control point characteristic value handle + HDL_ANCS_NOTIFICATION_SOURCE, //!< notification source characteristic value handle + HDL_ANCS_NOTIFICATION_SOURCE_CCCD, //!< notification source characteristic CCCD handle + HDL_ANCS_DATA_SOURCE, //!< data source characteristic value handle + HDL_ANCS_DATA_SOURCE_CCCD, //!< data source characteristic CCCD handle + HDL_ANCS_CACHE_LEN //!< handle cache length +} T_ANCS_HANDLE_TYPE; + +/** @brief ANCS client control command id*/ +typedef enum +{ + CP_CMD_ID_GET_NOTIFICATION_ATTR = 0, + CP_CMD_ID_GET_APP_ATTR = 1, + CP_CMD_ID_PERFORM_NOTIFICATION_ACTION = 2, + CP_CMD_ID_RESERVED = 255 +} T_ANCS_CP_CMD_ID; + +/** @brief ANCS client discovery state*/ +typedef enum +{ + DISC_ANCS_IDLE, + DISC_ANCS_START, + DISC_ANCS_DONE, + DISC_ANCS_FAILED +} T_ANCS_DISC_STATE; + +/** @brief ANCS client data type*/ +typedef enum +{ + ANCS_FROM_DATA_SOURCE, + ANCS_FROM_NOTIFICATION_SOURCE, +} T_ANCS_DATA_TYPE; + +/** @brief ANCS client notification data struct*/ +typedef struct +{ + T_ANCS_DATA_TYPE type; + uint16_t value_size; + uint8_t *p_value; +} T_ANCS_NOTIFY_DATA; + +/** @brief ANCS client write type*/ +typedef enum +{ + ANCS_WRITE_NOTIFICATION_SOURCE_NOTIFY_ENABLE, + ANCS_WRITE_NOTIFICATION_SOURCE_NOTIFY_DISABLE, + ANCS_WRITE_DATA_SOURCE_NOTIFY_ENABLE, + ANCS_WRITE_DATA_SOURCE_NOTIFY_DISABLE, + ANCS_WRITE_CONTROL_POINT, +} T_ANCS_WRITE_TYPE; + +/** @brief ANCS client write result*/ +typedef struct +{ + T_ANCS_WRITE_TYPE type; + uint16_t cause; +} T_ANCS_WRITE_RESULT; + +/** @brief ANCS client callback type*/ +typedef enum +{ + ANCS_CLIENT_CB_TYPE_DISC_STATE, //!< Discovery procedure state, done or pending. + ANCS_CLIENT_CB_TYPE_WRITE_RESULT, //!< Write request result, success or fail. + ANCS_CLIENT_CB_TYPE_NOTIF_IND_RESULT, //!< Notification or indication data received from server. + ANCS_CLIENT_CB_TYPE_DISCONNECT_INFO, + ANCS_CLIENT_CB_TYPE_INVALID //!< Invalid callback type, no practical usage. +} T_ANCS_CB_TYPE; + +/** @brief ANCS client callback content*/ +typedef union +{ + T_ANCS_DISC_STATE disc_state; + T_ANCS_NOTIFY_DATA notify_data; + T_ANCS_WRITE_RESULT write_result; +} T_ANCS_CB_CONTENT; + +/** @brief ANCS client callback data*/ +typedef struct +{ + T_ANCS_CB_TYPE cb_type; + T_ANCS_CB_CONTENT cb_content; +} T_ANCS_CB_DATA; +/** End of ANCS_CLIENT_Exported_Types +* @} +*/ + + +/*============================================================================* + * Functions + *============================================================================*/ +/** @defgroup ANCS_CLIENT_Exported_Functions ANCS Client Exported Functions + * @brief + * @{ + */ + +/** + * @brief Add ancs client. + * + * @param[in] app_cb Callbackto notify client read/write/notify/indicate events. + * @param[in] link_num Initialize link number + * @return Client ID of the specific client module. + * @retval 0xff failed. + * @retval other success. + * + * <b>Example usage</b> + * \code{.c} + void ancs_init(uint8_t link_num) + { + ancs_client = ancs_add_client(ancs_client_cb, link_num); + } + * \endcode + */ +T_CLIENT_ID ancs_add_client(P_FUN_GENERAL_APP_CB app_cb, uint8_t link_num); + + +/** + * @brief Used by application, to start the discovery procedure of ANCS. + * @param[in] conn_id connection ID. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool ancs_start_discovery(uint8_t conn_id); + +/** + * @brief Used by application, to get 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} + static T_USER_CMD_PARSE_RESULT cmd_ancshdl(T_USER_CMD_PARSED_VALUE *p_parse_value) + { + uint8_t conn_id = p_parse_value->dw_param[0]; + uint16_t hdl_cache[HDL_ANCS_CACHE_LEN]; + bool ret = ancs_get_hdl_cache(conn_id, hdl_cache, + sizeof(uint16_t) * HDL_ANCS_CACHE_LEN); + ...... + } + * \endcode + */ +bool ancs_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_ANCS_FLAG) + { + ancs_set_hdl_cache(conn_id, app_srvs_table.ancs_hdl_cache, sizeof(uint16_t) * HDL_ANCS_CACHE_LEN); + } + ...... + } + * \endcode + */ +bool ancs_set_hdl_cache(uint8_t conn_id, uint16_t *p_hdl_cache, uint8_t len); + +/** + * @brief Used by application, to set the notification flag of notification source. + * @param[in] conn_id connection ID. + * @param[in] notify value to enable or disable notify. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool ancs_set_notification_source_notify(uint8_t conn_id, bool notify); + +/** + * @brief Used by application, to set the notification flag of data source. + * @param[in] conn_id connection ID. + * @param[in] notify value to enable or disable notify. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool ancs_set_data_source_notify(uint8_t conn_id, bool notify); + +/** + * @brief Used by application, to get the notification attribute. + * @param[in] conn_id connection ID. + * @param[in] notification_uid value to enable or disable notify. + * @param[in] p_attribute_ids Pointer to attribute ids. + * @param[in] attribute_ids_len Length of attribute ids. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool ancs_get_notification_attr(uint8_t conn_id, uint32_t notification_uid, + uint8_t *p_attribute_ids, uint8_t attribute_ids_len); +/** + * @brief Used by application, to get the app attribute. + * @param[in] conn_id connection ID. + * @param[in] p_app_identifier value to enable or disable notify. + * @param[in] p_attribute_ids Pointer to attribute ids. + * @param[in] attribute_ids_len Length of attribute ids. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool ancs_get_app_attr(uint8_t conn_id, char *p_app_identifier, uint8_t *p_attribute_ids, + uint8_t attribute_ids_len); + +/** + * @brief Used by application, to perfome the notication action. + * @param[in] conn_id Connection ID. + * @param[in] notification_uid Notification UUID. + * @param[in] action_id Action id. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool ancs_perform_notification_action(uint8_t conn_id, uint32_t notification_uid, + uint8_t action_id); + +/** + * @brief Get the handle for gatt characteristic + * @param[in] conn_id Connection ID. + * @param[in] handle_type Pre-defined Handle Type. + * @retval the handle value of a GATT characteristic. + */ +uint16_t ancs_search_handle(uint8_t conn_id, T_ANCS_HANDLE_TYPE handle_type); + +/** @} End of ANCS_CLIENT_Exported_Functions */ + +/** @} End of ANCS_CLIENT */ + + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* _ANCS_CLIENT_H_ */ |