Glimworm Beacons / 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

source/nordic-sdk/components/softdevice/s130/include/ble_gatt.h@372:758e9a3a346a, 2015-07-06 (annotated)

Committer:
rgrover1
Date:
Mon Jul 06 10:21:00 2015 +0100
Revision:
372:758e9a3a346a
Parent:
nordic-sdk/components/softdevice/s130/include/ble_gatt.h@371:8f7d2137727a 
Synchronized with git rev 488e2462

Author: James Crosby

restructure to yotta module, with a few tweaks to get things building

Who changed what in which revision?

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