David Kester / 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.

Dependents:   GonioTrainer

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/softdevice/s110/headers/ble_gatt.h@112:737b08b3b995, 2015-04-30 (annotated)

Committer:
rgrover1
Date:
Thu Apr 30 08:34:37 2015 +0100
Revision:
112:737b08b3b995
Parent:
103:138bdc859cc9 
Synchronized with git rev 4ae92f89

Author: Rohit Grover

porting to v8.0 of the SDK

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 112:737b08b3b995 1 /*
rgrover1 112:737b08b3b995 2 * Copyright (c) Nordic Semiconductor ASA
rgrover1 112:737b08b3b995 3 * All rights reserved.
rgrover1 112:737b08b3b995 4 *
rgrover1 112:737b08b3b995 5 * Redistribution and use in source and binary forms, with or without modification,
rgrover1 112:737b08b3b995 6 * are permitted provided that the following conditions are met:
rgrover1 112:737b08b3b995 7 *
rgrover1 112:737b08b3b995 8 * 1. Redistributions of source code must retain the above copyright notice, this
rgrover1 112:737b08b3b995 9 * list of conditions and the following disclaimer.
rgrover1 112:737b08b3b995 10 *
rgrover1 112:737b08b3b995 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
rgrover1 112:737b08b3b995 12 * list of conditions and the following disclaimer in the documentation and/or
rgrover1 112:737b08b3b995 13 * other materials provided with the distribution.
rgrover1 112:737b08b3b995 14 *
rgrover1 112:737b08b3b995 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
rgrover1 112:737b08b3b995 16 * contributors to this software may be used to endorse or promote products
rgrover1 112:737b08b3b995 17 * derived from this software without specific prior written permission.
rgrover1 112:737b08b3b995 18 *
rgrover1 112:737b08b3b995 19 * 4. This software must only be used in a processor manufactured by Nordic
rgrover1 112:737b08b3b995 20 * Semiconductor ASA, or in a processor manufactured by a third party that
rgrover1 112:737b08b3b995 21 * is used in combination with a processor manufactured by Nordic Semiconductor.
rgrover1 112:737b08b3b995 22 *
rgrover1 112:737b08b3b995 23 *
rgrover1 112:737b08b3b995 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
rgrover1 112:737b08b3b995 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
rgrover1 112:737b08b3b995 26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
rgrover1 112:737b08b3b995 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
rgrover1 112:737b08b3b995 28 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
rgrover1 112:737b08b3b995 29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
rgrover1 112:737b08b3b995 30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
rgrover1 112:737b08b3b995 31 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
rgrover1 112:737b08b3b995 32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
rgrover1 112:737b08b3b995 33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
rgrover1 112:737b08b3b995 34 *
rgrover1 103:138bdc859cc9 35 */
rgrover1 112:737b08b3b995 36
rgrover1 112:737b08b3b995 37 /**
rgrover1 103:138bdc859cc9 38 @addtogroup BLE_GATT Generic Attribute Profile (GATT) Common
rgrover1 103:138bdc859cc9 39 @{
rgrover1 103:138bdc859cc9 40 @brief Common definitions and prototypes for the GATT interfaces.
rgrover1 103:138bdc859cc9 41 */
rgrover1 103:138bdc859cc9 42
rgrover1 103:138bdc859cc9 43 #ifndef BLE_GATT_H__
rgrover1 103:138bdc859cc9 44 #define BLE_GATT_H__
rgrover1 103:138bdc859cc9 45
rgrover1 103:138bdc859cc9 46 #include "ble_types.h"
rgrover1 103:138bdc859cc9 47 #include "ble_ranges.h"
rgrover1 103:138bdc859cc9 48
rgrover1 103:138bdc859cc9 49
rgrover1 103:138bdc859cc9 50 /** @addtogroup BLE_GATT_DEFINES Defines
rgrover1 103:138bdc859cc9 51 * @{ */
rgrover1 103:138bdc859cc9 52
rgrover1 103:138bdc859cc9 53 /** @brief Default MTU size. */
rgrover1 103:138bdc859cc9 54 #define GATT_MTU_SIZE_DEFAULT 23
rgrover1 103:138bdc859cc9 55
rgrover1 103:138bdc859cc9 56 /** @brief Only the default MTU size of 23 is currently supported. */
rgrover1 103:138bdc859cc9 57 #define GATT_RX_MTU 23
rgrover1 103:138bdc859cc9 58
rgrover1 103:138bdc859cc9 59
rgrover1 103:138bdc859cc9 60 /**@brief Invalid Attribute Handle. */
rgrover1 103:138bdc859cc9 61 #define BLE_GATT_HANDLE_INVALID 0x0000
rgrover1 103:138bdc859cc9 62
rgrover1 103:138bdc859cc9 63 /** @defgroup BLE_GATT_TIMEOUT_SOURCES GATT Timeout sources
rgrover1 103:138bdc859cc9 64 * @{ */
rgrover1 103:138bdc859cc9 65 #define BLE_GATT_TIMEOUT_SRC_PROTOCOL 0x00 /**< ATT Protocol timeout. */
rgrover1 103:138bdc859cc9 66 /** @} */
rgrover1 103:138bdc859cc9 67
rgrover1 103:138bdc859cc9 68 /** @defgroup BLE_GATT_WRITE_OPS GATT Write operations
rgrover1 103:138bdc859cc9 69 * @{ */
rgrover1 103:138bdc859cc9 70 #define BLE_GATT_OP_INVALID 0x00 /**< Invalid Operation. */
rgrover1 103:138bdc859cc9 71 #define BLE_GATT_OP_WRITE_REQ 0x01 /**< Write Request. */
rgrover1 103:138bdc859cc9 72 #define BLE_GATT_OP_WRITE_CMD 0x02 /**< Write Command. */
rgrover1 103:138bdc859cc9 73 #define BLE_GATT_OP_SIGN_WRITE_CMD 0x03 /**< Signed Write Command. */
rgrover1 103:138bdc859cc9 74 #define BLE_GATT_OP_PREP_WRITE_REQ 0x04 /**< Prepare Write Request. */
rgrover1 103:138bdc859cc9 75 #define BLE_GATT_OP_EXEC_WRITE_REQ 0x05 /**< Execute Write Request. */
rgrover1 103:138bdc859cc9 76 /** @} */
rgrover1 103:138bdc859cc9 77
rgrover1 103:138bdc859cc9 78 /** @defgroup BLE_GATT_EXEC_WRITE_FLAGS GATT Execute Write flags
rgrover1 103:138bdc859cc9 79 * @{ */
rgrover1 103:138bdc859cc9 80 #define BLE_GATT_EXEC_WRITE_FLAG_PREPARED_CANCEL 0x00
rgrover1 103:138bdc859cc9 81 #define BLE_GATT_EXEC_WRITE_FLAG_PREPARED_WRITE 0x01
rgrover1 103:138bdc859cc9 82 /** @} */
rgrover1 103:138bdc859cc9 83
rgrover1 103:138bdc859cc9 84 /** @defgroup BLE_GATT_HVX_TYPES GATT Handle Value operations
rgrover1 103:138bdc859cc9 85 * @{ */
rgrover1 103:138bdc859cc9 86 #define BLE_GATT_HVX_INVALID 0x00 /**< Invalid Operation. */
rgrover1 103:138bdc859cc9 87 #define BLE_GATT_HVX_NOTIFICATION 0x01 /**< Handle Value Notification. */
rgrover1 103:138bdc859cc9 88 #define BLE_GATT_HVX_INDICATION 0x02 /**< Handle Value Indication. */
rgrover1 103:138bdc859cc9 89 /** @} */
rgrover1 103:138bdc859cc9 90
rgrover1 103:138bdc859cc9 91 /** @defgroup BLE_GATT_STATUS_CODES GATT Status Codes
rgrover1 103:138bdc859cc9 92 * @{ */
rgrover1 103:138bdc859cc9 93 #define BLE_GATT_STATUS_SUCCESS 0x0000 /**< Success. */
rgrover1 103:138bdc859cc9 94 #define BLE_GATT_STATUS_UNKNOWN 0x0001 /**< Unknown or not applicable status. */
rgrover1 103:138bdc859cc9 95 #define BLE_GATT_STATUS_ATTERR_INVALID 0x0100 /**< ATT Error: Invalid Error Code. */
rgrover1 103:138bdc859cc9 96 #define BLE_GATT_STATUS_ATTERR_INVALID_HANDLE 0x0101 /**< ATT Error: Invalid Attribute Handle. */
rgrover1 103:138bdc859cc9 97 #define BLE_GATT_STATUS_ATTERR_READ_NOT_PERMITTED 0x0102 /**< ATT Error: Read not permitted. */
rgrover1 103:138bdc859cc9 98 #define BLE_GATT_STATUS_ATTERR_WRITE_NOT_PERMITTED 0x0103 /**< ATT Error: Write not permitted. */
rgrover1 103:138bdc859cc9 99 #define BLE_GATT_STATUS_ATTERR_INVALID_PDU 0x0104 /**< ATT Error: Used in ATT as Invalid PDU. */
rgrover1 103:138bdc859cc9 100 #define BLE_GATT_STATUS_ATTERR_INSUF_AUTHENTICATION 0x0105 /**< ATT Error: Authenticated link required. */
rgrover1 103:138bdc859cc9 101 #define BLE_GATT_STATUS_ATTERR_REQUEST_NOT_SUPPORTED 0x0106 /**< ATT Error: Used in ATT as Request Not Supported. */
rgrover1 103:138bdc859cc9 102 #define BLE_GATT_STATUS_ATTERR_INVALID_OFFSET 0x0107 /**< ATT Error: Offset specified was past the end of the attribute. */
rgrover1 103:138bdc859cc9 103 #define BLE_GATT_STATUS_ATTERR_INSUF_AUTHORIZATION 0x0108 /**< ATT Error: Used in ATT as Insufficient Authorisation. */
rgrover1 103:138bdc859cc9 104 #define BLE_GATT_STATUS_ATTERR_PREPARE_QUEUE_FULL 0x0109 /**< ATT Error: Used in ATT as Prepare Queue Full. */
rgrover1 103:138bdc859cc9 105 #define BLE_GATT_STATUS_ATTERR_ATTRIBUTE_NOT_FOUND 0x010A /**< ATT Error: Used in ATT as Attribute not found. */
rgrover1 103:138bdc859cc9 106 #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 107 #define BLE_GATT_STATUS_ATTERR_INSUF_ENC_KEY_SIZE 0x010C /**< ATT Error: Encryption key size used is insufficient. */
rgrover1 103:138bdc859cc9 108 #define BLE_GATT_STATUS_ATTERR_INVALID_ATT_VAL_LENGTH 0x010D /**< ATT Error: Invalid value size. */
rgrover1 103:138bdc859cc9 109 #define BLE_GATT_STATUS_ATTERR_UNLIKELY_ERROR 0x010E /**< ATT Error: Very unlikely error. */
rgrover1 103:138bdc859cc9 110 #define BLE_GATT_STATUS_ATTERR_INSUF_ENCRYPTION 0x010F /**< ATT Error: Encrypted link required. */
rgrover1 103:138bdc859cc9 111 #define BLE_GATT_STATUS_ATTERR_UNSUPPORTED_GROUP_TYPE 0x0110 /**< ATT Error: Attribute type is not a supported grouping attribute. */
rgrover1 103:138bdc859cc9 112 #define BLE_GATT_STATUS_ATTERR_INSUF_RESOURCES 0x0111 /**< ATT Error: Encrypted link required. */
rgrover1 103:138bdc859cc9 113 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE1_BEGIN 0x0112 /**< ATT Error: Reserved for Future Use range #1 begin. */
rgrover1 103:138bdc859cc9 114 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE1_END 0x017F /**< ATT Error: Reserved for Future Use range #1 end. */
rgrover1 103:138bdc859cc9 115 #define BLE_GATT_STATUS_ATTERR_APP_BEGIN 0x0180 /**< ATT Error: Application range begin. */
rgrover1 103:138bdc859cc9 116 #define BLE_GATT_STATUS_ATTERR_APP_END 0x019F /**< ATT Error: Application range end. */
rgrover1 103:138bdc859cc9 117 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE2_BEGIN 0x01A0 /**< ATT Error: Reserved for Future Use range #2 begin. */
rgrover1 103:138bdc859cc9 118 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE2_END 0x01DF /**< ATT Error: Reserved for Future Use range #2 end. */
rgrover1 103:138bdc859cc9 119 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE3_BEGIN 0x01E0 /**< ATT Error: Reserved for Future Use range #3 begin. */
rgrover1 103:138bdc859cc9 120 #define BLE_GATT_STATUS_ATTERR_RFU_RANGE3_END 0x01FC /**< ATT Error: Reserved for Future Use range #3 end. */
rgrover1 103:138bdc859cc9 121 #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 122 #define BLE_GATT_STATUS_ATTERR_CPS_PROC_ALR_IN_PROG 0x01FE /**< ATT Common Profile and Service Error: Procedure Already in Progress. */
rgrover1 103:138bdc859cc9 123 #define BLE_GATT_STATUS_ATTERR_CPS_OUT_OF_RANGE 0x01FF /**< ATT Common Profile and Service Error: Out Of Range. */
rgrover1 103:138bdc859cc9 124 /** @} */
rgrover1 103:138bdc859cc9 125
rgrover1 103:138bdc859cc9 126
rgrover1 103:138bdc859cc9 127 /** @defgroup BLE_GATT_CPF_FORMATS Characteristic Presentation Formats
rgrover1 103:138bdc859cc9 128 * @note Found at http://developer.bluetooth.org/gatt/descriptors/Pages/DescriptorViewer.aspx?u=org.bluetooth.descriptor.gatt.characteristic_presentation_format.xml
rgrover1 103:138bdc859cc9 129 * @{ */
rgrover1 103:138bdc859cc9 130 #define BLE_GATT_CPF_FORMAT_RFU 0x00 /**< Reserved For Future Use. */
rgrover1 103:138bdc859cc9 131 #define BLE_GATT_CPF_FORMAT_BOOLEAN 0x01 /**< Boolean. */
rgrover1 103:138bdc859cc9 132 #define BLE_GATT_CPF_FORMAT_2BIT 0x02 /**< Unsigned 2-bit integer. */
rgrover1 103:138bdc859cc9 133 #define BLE_GATT_CPF_FORMAT_NIBBLE 0x03 /**< Unsigned 4-bit integer. */
rgrover1 103:138bdc859cc9 134 #define BLE_GATT_CPF_FORMAT_UINT8 0x04 /**< Unsigned 8-bit integer. */
rgrover1 103:138bdc859cc9 135 #define BLE_GATT_CPF_FORMAT_UINT12 0x05 /**< Unsigned 12-bit integer. */
rgrover1 103:138bdc859cc9 136 #define BLE_GATT_CPF_FORMAT_UINT16 0x06 /**< Unsigned 16-bit integer. */
rgrover1 103:138bdc859cc9 137 #define BLE_GATT_CPF_FORMAT_UINT24 0x07 /**< Unsigned 24-bit integer. */
rgrover1 103:138bdc859cc9 138 #define BLE_GATT_CPF_FORMAT_UINT32 0x08 /**< Unsigned 32-bit integer. */
rgrover1 103:138bdc859cc9 139 #define BLE_GATT_CPF_FORMAT_UINT48 0x09 /**< Unsigned 48-bit integer. */
rgrover1 103:138bdc859cc9 140 #define BLE_GATT_CPF_FORMAT_UINT64 0x0A /**< Unsigned 64-bit integer. */
rgrover1 103:138bdc859cc9 141 #define BLE_GATT_CPF_FORMAT_UINT128 0x0B /**< Unsigned 128-bit integer. */
rgrover1 103:138bdc859cc9 142 #define BLE_GATT_CPF_FORMAT_SINT8 0x0C /**< Signed 2-bit integer. */
rgrover1 103:138bdc859cc9 143 #define BLE_GATT_CPF_FORMAT_SINT12 0x0D /**< Signed 12-bit integer. */
rgrover1 103:138bdc859cc9 144 #define BLE_GATT_CPF_FORMAT_SINT16 0x0E /**< Signed 16-bit integer. */
rgrover1 103:138bdc859cc9 145 #define BLE_GATT_CPF_FORMAT_SINT24 0x0F /**< Signed 24-bit integer. */
rgrover1 103:138bdc859cc9 146 #define BLE_GATT_CPF_FORMAT_SINT32 0x10 /**< Signed 32-bit integer. */
rgrover1 103:138bdc859cc9 147 #define BLE_GATT_CPF_FORMAT_SINT48 0x11 /**< Signed 48-bit integer. */
rgrover1 103:138bdc859cc9 148 #define BLE_GATT_CPF_FORMAT_SINT64 0x12 /**< Signed 64-bit integer. */
rgrover1 103:138bdc859cc9 149 #define BLE_GATT_CPF_FORMAT_SINT128 0x13 /**< Signed 128-bit integer. */
rgrover1 103:138bdc859cc9 150 #define BLE_GATT_CPF_FORMAT_FLOAT32 0x14 /**< IEEE-754 32-bit floating point. */
rgrover1 103:138bdc859cc9 151 #define BLE_GATT_CPF_FORMAT_FLOAT64 0x15 /**< IEEE-754 64-bit floating point. */
rgrover1 103:138bdc859cc9 152 #define BLE_GATT_CPF_FORMAT_SFLOAT 0x16 /**< IEEE-11073 16-bit SFLOAT. */
rgrover1 103:138bdc859cc9 153 #define BLE_GATT_CPF_FORMAT_FLOAT 0x17 /**< IEEE-11073 32-bit FLOAT. */
rgrover1 103:138bdc859cc9 154 #define BLE_GATT_CPF_FORMAT_DUINT16 0x18 /**< IEEE-20601 format. */
rgrover1 103:138bdc859cc9 155 #define BLE_GATT_CPF_FORMAT_UTF8S 0x19 /**< UTF-8 string. */
rgrover1 103:138bdc859cc9 156 #define BLE_GATT_CPF_FORMAT_UTF16S 0x1A /**< UTF-16 string. */
rgrover1 103:138bdc859cc9 157 #define BLE_GATT_CPF_FORMAT_STRUCT 0x1B /**< Opaque Structure. */
rgrover1 103:138bdc859cc9 158 /** @} */
rgrover1 103:138bdc859cc9 159
rgrover1 103:138bdc859cc9 160 /** @defgroup BLE_GATT_CPF_NAMESPACES GATT Bluetooth Namespaces
rgrover1 103:138bdc859cc9 161 * @{
rgrover1 103:138bdc859cc9 162 */
rgrover1 112:737b08b3b995 163 #define BLE_GATT_CPF_NAMESPACE_BTSIG 0x01 /**< Bluetooth SIG defined Namespace. */
rgrover1 112:737b08b3b995 164 #define BLE_GATT_CPF_NAMESPACE_DESCRIPTION_UNKNOWN 0x0000 /**< Namespace Description Unknown. */
rgrover1 103:138bdc859cc9 165 /** @} */
rgrover1 103:138bdc859cc9 166
rgrover1 103:138bdc859cc9 167 /** @} */
rgrover1 103:138bdc859cc9 168
rgrover1 103:138bdc859cc9 169 /** @addtogroup BLE_GATT_STRUCTURES Structures
rgrover1 103:138bdc859cc9 170 * @{ */
rgrover1 103:138bdc859cc9 171
rgrover1 103:138bdc859cc9 172 /**@brief GATT Characteristic Properties. */
rgrover1 103:138bdc859cc9 173 typedef struct
rgrover1 103:138bdc859cc9 174 {
rgrover1 103:138bdc859cc9 175 /* Standard properties */
rgrover1 112:737b08b3b995 176 uint8_t broadcast :1; /**< Broadcasting of the value permitted. */
rgrover1 112:737b08b3b995 177 uint8_t read :1; /**< Reading the value permitted. */
rgrover1 112:737b08b3b995 178 uint8_t write_wo_resp :1; /**< Writing the value with Write Command permitted. */
rgrover1 112:737b08b3b995 179 uint8_t write :1; /**< Writing the value with Write Request permitted. */
rgrover1 112:737b08b3b995 180 uint8_t notify :1; /**< Notications of the value permitted. */
rgrover1 112:737b08b3b995 181 uint8_t indicate :1; /**< Indications of the value permitted. */
rgrover1 112:737b08b3b995 182 uint8_t auth_signed_wr :1; /**< Writing the value with Signed Write Command permitted. */
rgrover1 103:138bdc859cc9 183 } ble_gatt_char_props_t;
rgrover1 103:138bdc859cc9 184
rgrover1 103:138bdc859cc9 185 /**@brief GATT Characteristic Extended Properties. */
rgrover1 103:138bdc859cc9 186 typedef struct
rgrover1 103:138bdc859cc9 187 {
rgrover1 103:138bdc859cc9 188 /* Extended properties */
rgrover1 112:737b08b3b995 189 uint8_t reliable_wr :1; /**< Writing the value with Queued Write operations permitted. */
rgrover1 112:737b08b3b995 190 uint8_t wr_aux :1; /**< Writing the Characteristic User Description descriptor permitted. */
rgrover1 103:138bdc859cc9 191 } ble_gatt_char_ext_props_t;
rgrover1 103:138bdc859cc9 192
rgrover1 103:138bdc859cc9 193 #endif // BLE_GATT_H__
rgrover1 103:138bdc859cc9 194
rgrover1 103:138bdc859cc9 195 /** @} */
rgrover1 103:138bdc859cc9 196
rgrover1 103:138bdc859cc9 197 /**
rgrover1 103:138bdc859cc9 198 @}
rgrover1 103:138bdc859cc9 199 @}
rgrover1 103:138bdc859cc9 200 */