vo dung / Mbed 2 deprecated ibeacon

project for nrf51822 qfab

Dependencies:   eddystone_URL mbed

Fork of eddystone_URL by vo dung

nRF51822/nordic/nrf-sdk/s110/ble_gatt.h@5:267bdacf5508, 2017-11-23 (annotated)

Committer:
tridung141196
Date:
Thu Nov 23 15:38:48 2017 +0000
Revision:
5:267bdacf5508
Parent:
0:76dfa9657d9d 
ibeacon

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jksoft 0:76dfa9657d9d 1 /* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
jksoft 0:76dfa9657d9d 2 *
jksoft 0:76dfa9657d9d 3 * The information contained herein is confidential property of Nordic Semiconductor. The use,
jksoft 0:76dfa9657d9d 4 * copying, transfer or disclosure of such information is prohibited except by express written
jksoft 0:76dfa9657d9d 5 * agreement with Nordic Semiconductor.
jksoft 0:76dfa9657d9d 6 *
jksoft 0:76dfa9657d9d 7 */
jksoft 0:76dfa9657d9d 8 /**
jksoft 0:76dfa9657d9d 9 @addtogroup BLE_GATT Generic Attribute Profile (GATT) Common
jksoft 0:76dfa9657d9d 10 @{
jksoft 0:76dfa9657d9d 11 @brief Common definitions and prototypes for the GATT interfaces.
jksoft 0:76dfa9657d9d 12 */
jksoft 0:76dfa9657d9d 13
jksoft 0:76dfa9657d9d 14 #ifndef BLE_GATT_H__
jksoft 0:76dfa9657d9d 15 #define BLE_GATT_H__
jksoft 0:76dfa9657d9d 16
jksoft 0:76dfa9657d9d 17 #include "ble_types.h"
jksoft 0:76dfa9657d9d 18 #include "ble_ranges.h"
jksoft 0:76dfa9657d9d 19
jksoft 0:76dfa9657d9d 20
jksoft 0:76dfa9657d9d 21 /** @addtogroup BLE_GATT_DEFINES Defines
jksoft 0:76dfa9657d9d 22 * @{ */
jksoft 0:76dfa9657d9d 23
jksoft 0:76dfa9657d9d 24 /** @brief Default MTU size. */
jksoft 0:76dfa9657d9d 25 #define GATT_MTU_SIZE_DEFAULT 23
jksoft 0:76dfa9657d9d 26
jksoft 0:76dfa9657d9d 27 /** @brief Only the default MTU size of 23 is currently supported. */
jksoft 0:76dfa9657d9d 28 #define GATT_RX_MTU 23
jksoft 0:76dfa9657d9d 29
jksoft 0:76dfa9657d9d 30
jksoft 0:76dfa9657d9d 31 /**@brief Invalid Attribute Handle. */
jksoft 0:76dfa9657d9d 32 #define BLE_GATT_HANDLE_INVALID 0x0000
jksoft 0:76dfa9657d9d 33
jksoft 0:76dfa9657d9d 34 /** @defgroup BLE_GATT_TIMEOUT_SOURCES GATT Timeout sources
jksoft 0:76dfa9657d9d 35 * @{ */
jksoft 0:76dfa9657d9d 36 #define BLE_GATT_TIMEOUT_SRC_PROTOCOL 0x00 /**< ATT Protocol timeout. */
jksoft 0:76dfa9657d9d 37 /** @} */
jksoft 0:76dfa9657d9d 38
jksoft 0:76dfa9657d9d 39 /** @defgroup BLE_GATT_WRITE_OPS GATT Write operations
jksoft 0:76dfa9657d9d 40 * @{ */
jksoft 0:76dfa9657d9d 41 #define BLE_GATT_OP_INVALID 0x00 /**< Invalid Operation. */
jksoft 0:76dfa9657d9d 42 #define BLE_GATT_OP_WRITE_REQ 0x01 /**< Write Request. */
jksoft 0:76dfa9657d9d 43 #define BLE_GATT_OP_WRITE_CMD 0x02 /**< Write Command. */
jksoft 0:76dfa9657d9d 44 #define BLE_GATT_OP_SIGN_WRITE_CMD 0x03 /**< Signed Write Command. */
jksoft 0:76dfa9657d9d 45 #define BLE_GATT_OP_PREP_WRITE_REQ 0x04 /**< Prepare Write Request. */
jksoft 0:76dfa9657d9d 46 #define BLE_GATT_OP_EXEC_WRITE_REQ 0x05 /**< Execute Write Request. */
jksoft 0:76dfa9657d9d 47 /** @} */
jksoft 0:76dfa9657d9d 48
jksoft 0:76dfa9657d9d 49 /** @defgroup BLE_GATT_EXEC_WRITE_FLAGS GATT Execute Write flags
jksoft 0:76dfa9657d9d 50 * @{ */
jksoft 0:76dfa9657d9d 51 #define BLE_GATT_EXEC_WRITE_FLAG_PREPARED_CANCEL 0x00
jksoft 0:76dfa9657d9d 52 #define BLE_GATT_EXEC_WRITE_FLAG_PREPARED_WRITE 0x01
jksoft 0:76dfa9657d9d 53 /** @} */
jksoft 0:76dfa9657d9d 54
jksoft 0:76dfa9657d9d 55 /** @defgroup BLE_GATT_HVX_TYPES GATT Handle Value operations
jksoft 0:76dfa9657d9d 56 * @{ */
jksoft 0:76dfa9657d9d 57 #define BLE_GATT_HVX_INVALID 0x00 /**< Invalid Operation. */
jksoft 0:76dfa9657d9d 58 #define BLE_GATT_HVX_NOTIFICATION 0x01 /**< Handle Value Notification. */
jksoft 0:76dfa9657d9d 59 #define BLE_GATT_HVX_INDICATION 0x02 /**< Handle Value Indication. */
jksoft 0:76dfa9657d9d 60 /** @} */
jksoft 0:76dfa9657d9d 61
jksoft 0:76dfa9657d9d 62 /** @defgroup BLE_GATT_STATUS_CODES GATT Status Codes
jksoft 0:76dfa9657d9d 63 * @{ */
jksoft 0:76dfa9657d9d 64 #define BLE_GATT_STATUS_SUCCESS 0x0000 /**< Success. */
jksoft 0:76dfa9657d9d 65 #define BLE_GATT_STATUS_UNKNOWN 0x0001 /**< Unknown or not applicable status. */
jksoft 0:76dfa9657d9d 66 #define BLE_GATT_STATUS_ATTERR_INVALID 0x0100 /**< ATT Error: Invalid Error Code. */
jksoft 0:76dfa9657d9d 67 #define BLE_GATT_STATUS_ATTERR_INVALID_HANDLE 0x0101 /**< ATT Error: Invalid Attribute Handle. */
jksoft 0:76dfa9657d9d 68 #define BLE_GATT_STATUS_ATTERR_READ_NOT_PERMITTED 0x0102 /**< ATT Error: Read not permitted. */
jksoft 0:76dfa9657d9d 69 #define BLE_GATT_STATUS_ATTERR_WRITE_NOT_PERMITTED 0x0103 /**< ATT Error: Write not permitted. */
jksoft 0:76dfa9657d9d 70 #define BLE_GATT_STATUS_ATTERR_INVALID_PDU 0x0104 /**< ATT Error: Used in ATT as Invalid PDU. */
jksoft 0:76dfa9657d9d 71 #define BLE_GATT_STATUS_ATTERR_INSUF_AUTHENTICATION 0x0105 /**< ATT Error: Authenticated link required. */
jksoft 0:76dfa9657d9d 72 #define BLE_GATT_STATUS_ATTERR_REQUEST_NOT_SUPPORTED 0x0106 /**< ATT Error: Used in ATT as Request Not Supported. */
jksoft 0:76dfa9657d9d 73 #define BLE_GATT_STATUS_ATTERR_INVALID_OFFSET 0x0107 /**< ATT Error: Offset specified was past the end of the attribute. */
jksoft 0:76dfa9657d9d 74 #define BLE_GATT_STATUS_ATTERR_INSUF_AUTHORIZATION 0x0108 /**< ATT Error: Used in ATT as Insufficient Authorisation. */
jksoft 0:76dfa9657d9d 75 #define BLE_GATT_STATUS_ATTERR_PREPARE_QUEUE_FULL 0x0109 /**< ATT Error: Used in ATT as Prepare Queue Full. */
jksoft 0:76dfa9657d9d 76 #define BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_FOUND 0x010A /**< ATT Error: Used in ATT as Attribute not found. */
jksoft 0:76dfa9657d9d 77 #define BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_LONG 0x010B /**< ATT Error: Attribute cannot be read or written using read/write blob requests. */
jksoft 0:76dfa9657d9d 78 #define BLE_GATT_STATUS_ATTERR_INSUF_ENC_KEY_SIZE 0x010C /**< ATT Error: Encryption key size used is insufficient. */
jksoft 0:76dfa9657d9d 79 #define BLE_GATT_STATUS_ATTERR_INVALID_ATT_VAL_LENGTH 0x010D /**< ATT Error: Invalid value size. */
jksoft 0:76dfa9657d9d 80 #define BLE_GATT_STATUS_ATTERR_UNLIKELY_ERROR 0x010E /**< ATT Error: Very unlikely error. */
jksoft 0:76dfa9657d9d 81 #define BLE_GATT_STATUS_ATTERR_INSUF_ENCRYPTION 0x010F /**< ATT Error: Encrypted link required. */
jksoft 0:76dfa9657d9d 82 #define BLE_GATT_STATUS_ATTERR_UNSUPPORTED_GROUP_TYPE 0x0110 /**< ATT Error: Attribute type is not a supported grouping attribute. */
jksoft 0:76dfa9657d9d 83 #define BLE_GATT_STATUS_ATTERR_INSUF_RESOURCES 0x0111 /**< ATT Error: Encrypted link required. */
jksoft 0:76dfa9657d9d 84 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE1_BEGIN 0x0112 /**< ATT Error: Reserved for Future Use range #1 begin. */
jksoft 0:76dfa9657d9d 85 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE1_END 0x017F /**< ATT Error: Reserved for Future Use range #1 end. */
jksoft 0:76dfa9657d9d 86 #define BLE_GATT_STATUS_ATTERR_APP_BEGIN 0x0180 /**< ATT Error: Application range begin. */
jksoft 0:76dfa9657d9d 87 #define BLE_GATT_STATUS_ATTERR_APP_END 0x019F /**< ATT Error: Application range end. */
jksoft 0:76dfa9657d9d 88 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE2_BEGIN 0x01A0 /**< ATT Error: Reserved for Future Use range #2 begin. */
jksoft 0:76dfa9657d9d 89 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE2_END 0x01DF /**< ATT Error: Reserved for Future Use range #2 end. */
jksoft 0:76dfa9657d9d 90 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE3_BEGIN 0x01E0 /**< ATT Error: Reserved for Future Use range #3 begin. */
jksoft 0:76dfa9657d9d 91 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE3_END 0x01FC /**< ATT Error: Reserved for Future Use range #3 end. */
jksoft 0:76dfa9657d9d 92 #define BLE_GATT_STATUS_ATTERR_CPS_CCCD_CONFIG_ERROR 0x01FD /**< ATT Common Profile and Service Error: Client Characteristic Configuration Descriptor improperly configured. */
jksoft 0:76dfa9657d9d 93 #define BLE_GATT_STATUS_ATTERR_CPS_PROC_ALR_IN_PROG 0x01FE /**< ATT Common Profile and Service Error: Procedure Already in Progress. */
jksoft 0:76dfa9657d9d 94 #define BLE_GATT_STATUS_ATTERR_CPS_OUT_OF_RANGE 0x01FF /**< ATT Common Profile and Service Error: Out Of Range. */
jksoft 0:76dfa9657d9d 95 /** @} */
jksoft 0:76dfa9657d9d 96
jksoft 0:76dfa9657d9d 97
jksoft 0:76dfa9657d9d 98 /** @defgroup BLE_GATT_CPF_FORMATS Characteristic Presentation Formats
jksoft 0:76dfa9657d9d 99 * @note Found at http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
jksoft 0:76dfa9657d9d 100 * @{ */
jksoft 0:76dfa9657d9d 101 #define BLE_GATT_CPF_FORMAT_RFU 0x00 /**< Reserved For Future Use. */
jksoft 0:76dfa9657d9d 102 #define BLE_GATT_CPF_FORMAT_BOOLEAN 0x01 /**< Boolean. */
jksoft 0:76dfa9657d9d 103 #define BLE_GATT_CPF_FORMAT_2BIT 0x02 /**< Unsigned 2-bit integer. */
jksoft 0:76dfa9657d9d 104 #define BLE_GATT_CPF_FORMAT_NIBBLE 0x03 /**< Unsigned 4-bit integer. */
jksoft 0:76dfa9657d9d 105 #define BLE_GATT_CPF_FORMAT_UINT8 0x04 /**< Unsigned 8-bit integer. */
jksoft 0:76dfa9657d9d 106 #define BLE_GATT_CPF_FORMAT_UINT12 0x05 /**< Unsigned 12-bit integer. */
jksoft 0:76dfa9657d9d 107 #define BLE_GATT_CPF_FORMAT_UINT16 0x06 /**< Unsigned 16-bit integer. */
jksoft 0:76dfa9657d9d 108 #define BLE_GATT_CPF_FORMAT_UINT24 0x07 /**< Unsigned 24-bit integer. */
jksoft 0:76dfa9657d9d 109 #define BLE_GATT_CPF_FORMAT_UINT32 0x08 /**< Unsigned 32-bit integer. */
jksoft 0:76dfa9657d9d 110 #define BLE_GATT_CPF_FORMAT_UINT48 0x09 /**< Unsigned 48-bit integer. */
jksoft 0:76dfa9657d9d 111 #define BLE_GATT_CPF_FORMAT_UINT64 0x0A /**< Unsigned 64-bit integer. */
jksoft 0:76dfa9657d9d 112 #define BLE_GATT_CPF_FORMAT_UINT128 0x0B /**< Unsigned 128-bit integer. */
jksoft 0:76dfa9657d9d 113 #define BLE_GATT_CPF_FORMAT_SINT8 0x0C /**< Signed 2-bit integer. */
jksoft 0:76dfa9657d9d 114 #define BLE_GATT_CPF_FORMAT_SINT12 0x0D /**< Signed 12-bit integer. */
jksoft 0:76dfa9657d9d 115 #define BLE_GATT_CPF_FORMAT_SINT16 0x0E /**< Signed 16-bit integer. */
jksoft 0:76dfa9657d9d 116 #define BLE_GATT_CPF_FORMAT_SINT24 0x0F /**< Signed 24-bit integer. */
jksoft 0:76dfa9657d9d 117 #define BLE_GATT_CPF_FORMAT_SINT32 0x10 /**< Signed 32-bit integer. */
jksoft 0:76dfa9657d9d 118 #define BLE_GATT_CPF_FORMAT_SINT48 0x11 /**< Signed 48-bit integer. */
jksoft 0:76dfa9657d9d 119 #define BLE_GATT_CPF_FORMAT_SINT64 0x12 /**< Signed 64-bit integer. */
jksoft 0:76dfa9657d9d 120 #define BLE_GATT_CPF_FORMAT_SINT128 0x13 /**< Signed 128-bit integer. */
jksoft 0:76dfa9657d9d 121 #define BLE_GATT_CPF_FORMAT_FLOAT32 0x14 /**< IEEE-754 32-bit floating point. */
jksoft 0:76dfa9657d9d 122 #define BLE_GATT_CPF_FORMAT_FLOAT64 0x15 /**< IEEE-754 64-bit floating point. */
jksoft 0:76dfa9657d9d 123 #define BLE_GATT_CPF_FORMAT_SFLOAT 0x16 /**< IEEE-11073 16-bit SFLOAT. */
jksoft 0:76dfa9657d9d 124 #define BLE_GATT_CPF_FORMAT_FLOAT 0x17 /**< IEEE-11073 32-bit FLOAT. */
jksoft 0:76dfa9657d9d 125 #define BLE_GATT_CPF_FORMAT_DUINT16 0x18 /**< IEEE-20601 format. */
jksoft 0:76dfa9657d9d 126 #define BLE_GATT_CPF_FORMAT_UTF8S 0x19 /**< UTF-8 string. */
jksoft 0:76dfa9657d9d 127 #define BLE_GATT_CPF_FORMAT_UTF16S 0x1A /**< UTF-16 string. */
jksoft 0:76dfa9657d9d 128 #define BLE_GATT_CPF_FORMAT_STRUCT 0x1B /**< Opaque Structure. */
jksoft 0:76dfa9657d9d 129 /** @} */
jksoft 0:76dfa9657d9d 130
jksoft 0:76dfa9657d9d 131 /** @defgroup BLE_GATT_CPF_NAMESPACES GATT Bluetooth Namespaces
jksoft 0:76dfa9657d9d 132 * @{
jksoft 0:76dfa9657d9d 133 */
jksoft 0:76dfa9657d9d 134 #define BLE_GATT_CPF_NAMESPACE_BTSIG 0x01
jksoft 0:76dfa9657d9d 135 #define BLE_GATT_CPF_NAMESPACE_DESCRIPTION_UNKNOWN 0x0000
jksoft 0:76dfa9657d9d 136 /** @} */
jksoft 0:76dfa9657d9d 137
jksoft 0:76dfa9657d9d 138 /** @} */
jksoft 0:76dfa9657d9d 139
jksoft 0:76dfa9657d9d 140 /** @addtogroup BLE_GATT_STRUCTURES Structures
jksoft 0:76dfa9657d9d 141 * @{ */
jksoft 0:76dfa9657d9d 142
jksoft 0:76dfa9657d9d 143 /**@brief GATT Characteristic Properties. */
jksoft 0:76dfa9657d9d 144 typedef struct
jksoft 0:76dfa9657d9d 145 {
jksoft 0:76dfa9657d9d 146 /* Standard properties */
jksoft 0:76dfa9657d9d 147 uint8_t broadcast :1; /**< Broadcasting of value permitted. */
jksoft 0:76dfa9657d9d 148 uint8_t read :1; /**< Reading value permitted. */
jksoft 0:76dfa9657d9d 149 uint8_t write_wo_resp :1; /**< Writing value with Write Command permitted. */
jksoft 0:76dfa9657d9d 150 uint8_t write :1; /**< Writing value with Write Request permitted. */
jksoft 0:76dfa9657d9d 151 uint8_t notify :1; /**< Notications of value permitted. */
jksoft 0:76dfa9657d9d 152 uint8_t indicate :1; /**< Indications of value permitted. */
jksoft 0:76dfa9657d9d 153 uint8_t auth_signed_wr :1; /**< Writing value with Signed Write Command permitted. */
jksoft 0:76dfa9657d9d 154 } ble_gatt_char_props_t;
jksoft 0:76dfa9657d9d 155
jksoft 0:76dfa9657d9d 156 /**@brief GATT Characteristic Extended Properties. */
jksoft 0:76dfa9657d9d 157 typedef struct
jksoft 0:76dfa9657d9d 158 {
jksoft 0:76dfa9657d9d 159 /* Extended properties */
jksoft 0:76dfa9657d9d 160 uint8_t reliable_wr :1; /**< Writing value with Queued Write Request permitted. */
jksoft 0:76dfa9657d9d 161 uint8_t wr_aux :1; /**< Writing the Characteristic User Description permitted. */
jksoft 0:76dfa9657d9d 162 } ble_gatt_char_ext_props_t;
jksoft 0:76dfa9657d9d 163
jksoft 0:76dfa9657d9d 164 #endif // BLE_GATT_H__
jksoft 0:76dfa9657d9d 165
jksoft 0:76dfa9657d9d 166 /** @} */
jksoft 0:76dfa9657d9d 167
jksoft 0:76dfa9657d9d 168 /**
jksoft 0:76dfa9657d9d 169 @}
jksoft 0:76dfa9657d9d 170 @}
jksoft 0:76dfa9657d9d 171 */