diff options
Diffstat (limited to 'inc/bluetooth/profile/client/lls_client.h')
| -rw-r--r-- | inc/bluetooth/profile/client/lls_client.h | 279 |
1 files changed, 279 insertions, 0 deletions
diff --git a/inc/bluetooth/profile/client/lls_client.h b/inc/bluetooth/profile/client/lls_client.h new file mode 100644 index 0000000..2602706 --- /dev/null +++ b/inc/bluetooth/profile/client/lls_client.h @@ -0,0 +1,279 @@ +/** +***************************************************************************************** +* Copyright(c) 2016, Realtek Semiconductor Corporation. All rights reserved. +***************************************************************************************** + * @file lls_client.h + * @brief Head file for using LLS Client. + * @details lls data structs and external functions declaration. + * @author ken + * @date 2017-12-05 + * @version v0.1 + * ************************************************************************************* + */ + +/* Define to prevent recursive inclusion */ +#ifndef _LLS_CLIENT_H_ +#define _LLS_CLIENT_H_ + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/* Add Includes here */ +#include <profile_client.h> + + +/** @defgroup LLS_Client lls service client + * @brief lls service client + * @details + lls Profile is a customized BLE-based Profile. Lls ble service please refer to @ref LLS_Service . + * @{ + */ +/*============================================================================* + * Macros + *============================================================================*/ +/** @defgroup LLS_Client_Exported_Macros LLS Client Exported Macros + * @brief + * @{ + */ +/** @defgroup LLS UUIDs + * @brief Lls BLE Profile UUID definitions + * @{ + */ +#define GATT_UUID_LINK_LOSS_SERVICE 0x1803 +#define GATT_UUID_CHAR_ALERT_LEVEL 0x2A06 +/** @} End of LLS_UUIDs */ + +/** @brief Define links number. range: 0-4 */ +#define LLS_MAX_LINKS 2 +/** End of LLS_Client_Exported_Macros + * @} + */ + + +/*============================================================================* + * Types + *============================================================================*/ +/** @defgroup LLS_Exported_Types LLS Client Exported Types + * @brief + * @{ + */ + +/** @brief LLS client handle type*/ +typedef enum +{ + HDL_LLS_SRV_START, //!< start handle of lls service + HDL_LLS_SRV_END, //!< end handle of lls service + HDL_LLS_PARA, //!< LLS parameter read/write characteristic value handle + HDL_LLS_CACHE_LEN //!< handle cache length +} T_LLS_HANDLE_TYPE; + +/** @brief LLS client discovery state*/ +typedef enum +{ + DISC_LLS_IDLE, + DISC_LLS_START, + DISC_LLS_DONE, + DISC_LLS_FAILED +} T_LLS_DISC_STATE; + +/** @brief lls client read type*/ +typedef enum +{ + LLS_READ_PARA, +} T_LLS_READ_TYPE; + +/** @brief LLS client read value*/ +typedef struct +{ + uint16_t value_size; + uint8_t *p_value; +} T_LLS_READ_VALUE; + +/** @brief LLS client read data*/ +typedef union +{ + T_LLS_READ_VALUE v1_read; +// bool v3_notify_cccd; +// bool v4_indicate_cccd; +} T_LLS_READ_DATA; + +/** @brief LLS client read result*/ +typedef struct +{ + T_LLS_READ_TYPE type; + T_LLS_READ_DATA data; + uint16_t cause; +} T_LLS_READ_RESULT; + + +/** @brief LLS client write type*/ +typedef enum +{ + LLS_WRITE_PARA, +} T_LLS_WRITE_TYPE; + +/** @brief LLS client write result*/ +typedef struct +{ + T_LLS_WRITE_TYPE type; + uint16_t cause; +} T_LLS_WRITE_RESULT; + +/** @brief LLS client notif/ind receive type*/ +//typedef enum +//{ +// LLS_KEY_NOTIFY, +//} T_LLS_NOTIF_IND_TYPE; + +///** @brief LLS client notif/ind receive data*/ +//typedef struct +//{ +// uint16_t value_size; +// uint8_t *p_value; +//} T_LLS_NOTIF_IND_VALUE; + +/** @brief LLS client notif/ind receive content*/ +//typedef struct +//{ +// T_LLS_NOTIF_IND_TYPE type; +// T_LLS_NOTIF_IND_VALUE data; +//} T_LLS_NOTIF_IND_DATA; + +/** @brief LLS client callback type*/ +typedef enum +{ + LLS_CLIENT_CB_TYPE_DISC_STATE, //!< Discovery procedure state, done or pending. + LLS_CLIENT_CB_TYPE_READ_RESULT, //!< Read request's result data, responsed from server. + LLS_CLIENT_CB_TYPE_WRITE_RESULT, //!< Write request result, success or fail. + //LLS_CLIENT_CB_TYPE_NOTIF_IND_RESULT, //!< Notification or indication data received from server. + LLS_CLIENT_CB_TYPE_INVALID //!< Invalid callback type, no practical usage. +} T_LLS_CLIENT_CB_TYPE; + +/** @brief LLS client callback content*/ +typedef union +{ + T_LLS_DISC_STATE disc_state; + T_LLS_READ_RESULT read_result; + T_LLS_WRITE_RESULT write_result; + //T_LLS_NOTIF_IND_DATA notif_ind_data; +} T_LLS_CLIENT_CB_CONTENT; + +/** @brief LLS client callback data*/ +typedef struct +{ + T_LLS_CLIENT_CB_TYPE cb_type; + T_LLS_CLIENT_CB_CONTENT cb_content; +} T_LLS_CLIENT_CB_DATA; + +/** End of LLS_Client_Exported_Types * @} */ + +/** @defgroup LLS_Client_Exported_Functions LLS Client Exported Functions + * @{ + */ + +/** + * @brief Add lls 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); + lls_client_id = lls_add_client(app_client_callback, APP_MAX_LINKS); + } + * \endcode + */ +T_CLIENT_ID lls_add_client(P_FUN_GENERAL_APP_CB app_cb, uint8_t link_num); + +/** + * @brief Used by application, to start the discovery procedure of lls server. + * @param[in] conn_id connection ID. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool lls_client_start_discovery(uint8_t conn_id); + +/** + * @brief Used by application, to read data from server by using handles. + * @param[in] conn_id connection ID. + * @param[in] read_type one of characteristic that has the readable property. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool lls_client_read_by_handle(uint8_t conn_id, T_LLS_READ_TYPE read_type); + +/** + * @brief Used by application, to read data from server by using UUIDs. + * @param[in] conn_id connection ID. + * @param[in] read_type one of characteristic that has the readable property. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool lls_client_read_by_uuid(uint8_t conn_id, T_LLS_READ_TYPE read_type); + +/** + * @brief Used by application, to write data of write Characteristic. + * @param[in] conn_id connection ID. + * @param[in] length write data length + * @param[in] p_value point the value to write + * @param[in] type write type. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +bool lls_client_write_char(uint8_t conn_id, uint16_t length, uint8_t *p_value, + T_GATT_WRITE_TYPE type); + +/** + * @brief Used by application, to enable or disable the notification of peer server's V3 Notify Characteristic. + * @param[in] conn_id connection ID. + * @param[in] notify 0--disable the notification, 1--enable the notification. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +//bool lls_client_set_v3_notify(uint8_t conn_id, bool notify); + +/** + * @brief Used by application, to enable or disable the indication of peer server's V4 Indicate Characteristic. + * @param[in] conn_id connection ID. + * @param[in] ind 0--disable the indication, 1--enable the indication. + * @retval true send request to upper stack success. + * @retval false send request to upper stack failed. + */ +//bool lls_client_set_v4_ind(uint8_t conn_id, bool ind); + +/** + * @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. + */ +bool lls_client_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. + */ +bool lls_client_set_hdl_cache(uint8_t conn_id, uint16_t *p_hdl_cache, uint8_t len); + +/** @} End of LLS_Client_Exported_Functions */ + +/** @} End of LLS_Client */ + + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* _LLS_CLIENT_H_ */ |