Microbug / nRF51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/softdevice/s110/headers/ble_gatt.h@103:138bdc859cc9, 2015-04-15 (annotated)

Committer:
rgrover1
Date:
Wed Apr 15 08:59:11 2015 +0100
Revision:
103:138bdc859cc9
Child:
112:737b08b3b995
Synchronized with git rev fa183c40

Author: Rohit Grover

updating to v7.1 of the Nordic SDK.

Re-organized file layout to match that from the SDK.

Who changed what in which revision?

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