xf_ble_gatt_common.h

浏览该文件的文档.

 
#ifndef __XF_BLE_GATT_COMMON_H__
#define __XF_BLE_GATT_COMMON_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_utils.h"
 
#include "xf_ble_types.h"
#include "xf_ble_gap_types.h"
 
#if XF_BLE_IS_ENABLE || defined(__DOXYGEN__)
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef enum {
    XF_BLE_GATT_ATTR_PERMISSION_READ = 0x01,                
    XF_BLE_GATT_ATTR_PERMISSION_WRITE = 0x02,               
    XF_BLE_GATT_ATTR_PERMISSION_ENCRYPTION_NEED = 0x04,     
    XF_BLE_GATT_ATTR_PERMISSION_AUTHENTICATION_NEED = 0x08, 
    XF_BLE_GATT_ATTR_PERMISSION_AUTHORIZATION_NEED = 0x10,  
    XF_BLE_GATT_ATTR_PERMISSION_MITM_NEED = 0x20,           
} xf_ble_gatt_attr_permission_t;
 
typedef enum {
    XF_BLE_GATT_CHARA_PROPERTY_BROADCAST    = 0x01,     
    XF_BLE_GATT_CHARA_PROPERTY_READ         = 0x02,     
    XF_BLE_GATT_CHARA_PROPERTY_WRITE_NO_RSP = 0x04,     
    XF_BLE_GATT_CHARA_PROPERTY_WRITE        = 0x08,     
    XF_BLE_GATT_CHARA_PROPERTY_NOTIFY       = 0x10,     
    XF_BLE_GATT_CHARA_PROPERTY_INDICATE     = 0x20,     
    XF_BLE_GATT_CHARA_PROPERTY_SIGNED_WRITE = 0x40,     
    /* 以下为 特征的拓展特性类型  */
    XF_BLE_GATT_CHARA_PROPERTY_EXT_RELIABLE_WRITE   = 0x0080,
    XF_BLE_GATT_CHARA_PROPERTY_EXT_AUX_WRITE        = 0x0100,
    XF_BLE_GATT_CHARA_PROPERTY_EXT_READ_ENC         = 0x0200,
    XF_BLE_GATT_CHARA_PROPERTY_EXT_READ_AUTHEN      = 0x0400,
    XF_BLE_GATT_CHARA_PROPERTY_EXT_READ_AUTHOR      = 0x0800,
    XF_BLE_GATT_CHARA_PROPERTY_EXT_WRITE_ENC        = 0x1000,
    XF_BLE_GATT_CHARA_PROPERTY_EXT_WRITE_AUTHEN     = 0x2000,
    XF_BLE_GATT_CHARA_PROPERTY_EXT_WRITE_AUTHOR     = 0x4000,
} xf_ble_gatt_chara_property_t;
 
typedef enum {
    XF_BLE_GATT_CHARA_DESC_TYPE_CHARA_EXT_PROPERTIES,       
    XF_BLE_GATT_CHARA_DESC_TYPE_CHARA_USER_DESC,            
    XF_BLE_GATT_CHARA_DESC_TYPE_CLIENT_CHARA_CFG,           
    XF_BLE_GATT_CHARA_DESC_TYPE_SERVER_CHARA_CFG,           
    XF_BLE_GATT_CHARA_DESC_TYPE_CHARA_PRESENTATION_FORMAT,  
    XF_BLE_GATT_CHARA_DESC_TYPE_CHARA_AGGREGATE_FORMAT,     
} xf_ble_gatt_chara_desc_type_t;
 
typedef enum {
    XF_BLE_GATT_SERVICE_TYPE_PRIMARY,           
    XF_BLE_GATT_SERVICE_TYPE_SECONDARY,         
} xf_ble_gatt_service_type_t;
 
typedef enum {
    XF_BLE_GATT_ERR_SUCCESS                             = 0x00, 
    XF_BLE_GATT_ERR_INVALID_HANDLE                      = 0x01, 
    XF_BLE_GATT_ERR_READ_NOT_PERMITTED                  = 0x02, 
    XF_BLE_GATT_ERR_WRITE_NOT_PERMITTED                 = 0x03, 
    XF_BLE_GATT_ERR_INVALID_PDU                         = 0x04, 
    XF_BLE_GATT_ERR_INSUFFICIENT_AUTHENTICATION         = 0x05, 
    XF_BLE_GATT_ERR_REQUEST_NOT_SUPPORTED               = 0x06, 
    XF_BLE_GATT_ERR_INVALID_OFFSET                      = 0x07, 
    XF_BLE_GATT_ERR_INSUFFICIENT_AUTHORIZATION          = 0x08, 
    XF_BLE_GATT_ERR_PREPARE_QUEUE_FULL                  = 0x09, 
    XF_BLE_GATT_ERR_ATTRIBUTE_NOT_FOUND                 = 0x0A, 
    XF_BLE_GATT_ERR_ATTRIBUTE_NOT_LONG                  = 0x0B, 
    XF_BLE_GATT_ERR_INSUFFICIENT_ENCRYPTION_KEY_SIZE    = 0x0C, 
    XF_BLE_GATT_ERR_INVALID_ATTRIBUTE_VALUE_LENGTH      = 0x0D, 
    XF_BLE_GATT_ERR_UNLIKELY_ERROR                      = 0x0E, 
    XF_BLE_GATT_ERR_INSUFFICIENT_ENCRYPTION             = 0x0F, 
    XF_BLE_GATT_ERR_UNSUPPORTED_GROUP_TYPE              = 0x10, 
    XF_BLE_GATT_ERR_INSUFFICIENT_RESOURCES              = 0x11, 
    XF_BLE_GATT_ERR_DATABASE_OUT_OF_SYNC                = 0x12, 
    XF_BLE_GATT_ERR_VALUE_NOT_ALLOWED                   = 0x13, 
    /* 0x80 – 0x9F ：由更高层规范定义的应用程序错误代码。 */
    XF_BLE_GATT_ERR_APP_ERROR_START                     = 0x80,
    XF_BLE_GATT_ERR_APP_ERROR_END                       = 0x9F,
 
    /* 0xE0 – 0xFF ：通用配置文件和服务错误代码 */
    XF_BLE_GATT_ERR_COMMON_PROFILE_AND_SERVICE_START    = 0xE0,
    XF_BLE_GATT_ERR_COMMON_PROFILE_AND_SERVICE_END      = 0xFF,
} xf_ble_gatt_err_t;
 
/* ==================== [Global Prototypes] ================================= */
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* XF_BLE_IS_ENABLE */
 
#endif /* __XF_BLE_GATT_COMMON_H__ */