George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/TARGET_NRF51822/ble_gatts.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:dd0fea342ad2 1 /* Copyright (c) 2011 Nordic Semiconductor. All Rights Reserved.
gkroussos 0:dd0fea342ad2 2 *
gkroussos 0:dd0fea342ad2 3 * The information contained herein is confidential property of Nordic Semiconductor. The use,
gkroussos 0:dd0fea342ad2 4 * copying, transfer or disclosure of such information is prohibited except by express written
gkroussos 0:dd0fea342ad2 5 * agreement with Nordic Semiconductor.
gkroussos 0:dd0fea342ad2 6 *
gkroussos 0:dd0fea342ad2 7 */
gkroussos 0:dd0fea342ad2 8 /**
gkroussos 0:dd0fea342ad2 9 @addtogroup BLE_GATTS Generic Attribute Profile (GATT) Server
gkroussos 0:dd0fea342ad2 10 @{
gkroussos 0:dd0fea342ad2 11 @brief Definitions and prototypes for the GATTS interface.
gkroussos 0:dd0fea342ad2 12 */
gkroussos 0:dd0fea342ad2 13
gkroussos 0:dd0fea342ad2 14 #ifndef BLE_GATTS_H__
gkroussos 0:dd0fea342ad2 15 #define BLE_GATTS_H__
gkroussos 0:dd0fea342ad2 16
gkroussos 0:dd0fea342ad2 17 #include "ble_types.h"
gkroussos 0:dd0fea342ad2 18 #include "ble_ranges.h"
gkroussos 0:dd0fea342ad2 19 #include "ble_l2cap.h"
gkroussos 0:dd0fea342ad2 20 #include "ble_gap.h"
gkroussos 0:dd0fea342ad2 21 #include "ble_gatt.h"
gkroussos 0:dd0fea342ad2 22 #include "nrf_svc.h"
gkroussos 0:dd0fea342ad2 23
gkroussos 0:dd0fea342ad2 24
gkroussos 0:dd0fea342ad2 25 /**
gkroussos 0:dd0fea342ad2 26 * @brief GATTS API SVC numbers.
gkroussos 0:dd0fea342ad2 27 */
gkroussos 0:dd0fea342ad2 28 enum BLE_GATTS_SVCS
gkroussos 0:dd0fea342ad2 29 {
gkroussos 0:dd0fea342ad2 30 SD_BLE_GATTS_SERVICE_ADD = BLE_GATTS_SVC_BASE, /**< Add a service. */
gkroussos 0:dd0fea342ad2 31 SD_BLE_GATTS_INCLUDE_ADD, /**< Add an included service. */
gkroussos 0:dd0fea342ad2 32 SD_BLE_GATTS_CHARACTERISTIC_ADD, /**< Add a characteristic. */
gkroussos 0:dd0fea342ad2 33 SD_BLE_GATTS_DESCRIPTOR_ADD, /**< Add a generic attribute. */
gkroussos 0:dd0fea342ad2 34 SD_BLE_GATTS_VALUE_SET, /**< Set an attribute value. */
gkroussos 0:dd0fea342ad2 35 SD_BLE_GATTS_VALUE_GET, /**< Get an attribute value. */
gkroussos 0:dd0fea342ad2 36 SD_BLE_GATTS_HVX, /**< Handle Value Notification or Indication. */
gkroussos 0:dd0fea342ad2 37 SD_BLE_GATTS_SERVICE_CHANGED, /**< Perform a Service Changed Indication to one or more peers. */
gkroussos 0:dd0fea342ad2 38 SD_BLE_GATTS_RW_AUTHORIZE_REPLY, /**< Reply to an authorization request for a read or write operation on one or more attributes. */
gkroussos 0:dd0fea342ad2 39 SD_BLE_GATTS_SYS_ATTR_SET, /**< Set the persistent system attributes for a connection. */
gkroussos 0:dd0fea342ad2 40 SD_BLE_GATTS_SYS_ATTR_GET, /**< Get updated persistent system attributes after terminating a connection. */
gkroussos 0:dd0fea342ad2 41 };
gkroussos 0:dd0fea342ad2 42
gkroussos 0:dd0fea342ad2 43
gkroussos 0:dd0fea342ad2 44 /** @addtogroup BLE_GATTS_DEFINES Defines
gkroussos 0:dd0fea342ad2 45 * @{ */
gkroussos 0:dd0fea342ad2 46
gkroussos 0:dd0fea342ad2 47 /** @brief Only the default MTU size of 23 is currently supported. */
gkroussos 0:dd0fea342ad2 48 #define GATT_RX_MTU 23
gkroussos 0:dd0fea342ad2 49
gkroussos 0:dd0fea342ad2 50 /** @defgroup BLE_ERRORS_GATTS SVC return values specific to GATTS
gkroussos 0:dd0fea342ad2 51 * @{ */
gkroussos 0:dd0fea342ad2 52 #define BLE_ERROR_GATTS_INVALID_ATTR_TYPE (NRF_GATTS_ERR_BASE + 0x000) /**< Invalid attribute type. */
gkroussos 0:dd0fea342ad2 53 #define BLE_ERROR_GATTS_SYS_ATTR_MISSING (NRF_GATTS_ERR_BASE + 0x001) /**< System Attributes missing. */
gkroussos 0:dd0fea342ad2 54 /** @} */
gkroussos 0:dd0fea342ad2 55
gkroussos 0:dd0fea342ad2 56 /** @defgroup BLE_GATTS_ATTR_LENS_MAX Maximum attribute lengths
gkroussos 0:dd0fea342ad2 57 * @{ */
gkroussos 0:dd0fea342ad2 58 #define BLE_GATTS_FIX_ATTR_LEN_MAX (510) /**< Maximum length for fixed length Attribute Values. */
gkroussos 0:dd0fea342ad2 59 #define BLE_GATTS_VAR_ATTR_LEN_MAX (512) /**< Maximum length for variable length Attribute Values. */
gkroussos 0:dd0fea342ad2 60 /** @} */
gkroussos 0:dd0fea342ad2 61
gkroussos 0:dd0fea342ad2 62 /** @defgroup BLE_GATTS_SRVC_TYPES GATT Server Service Types
gkroussos 0:dd0fea342ad2 63 * @{ */
gkroussos 0:dd0fea342ad2 64 #define BLE_GATTS_SRVC_TYPE_INVALID 0x00 /**< Invalid Service Type. */
gkroussos 0:dd0fea342ad2 65 #define BLE_GATTS_SRVC_TYPE_PRIMARY 0x01 /**< Primary Service. */
gkroussos 0:dd0fea342ad2 66 #define BLE_GATTS_SRVC_TYPE_SECONDARY 0x02 /**< Secondary Type. */
gkroussos 0:dd0fea342ad2 67 /** @} */
gkroussos 0:dd0fea342ad2 68
gkroussos 0:dd0fea342ad2 69
gkroussos 0:dd0fea342ad2 70 /** @defgroup BLE_GATTS_ATTR_TYPES GATT Server Attribute Types
gkroussos 0:dd0fea342ad2 71 * @{ */
gkroussos 0:dd0fea342ad2 72 #define BLE_GATTS_ATTR_TYPE_INVALID 0x00 /**< Invalid Attribute Type. */
gkroussos 0:dd0fea342ad2 73 #define BLE_GATTS_ATTR_TYPE_PRIM_SRVC_DECL 0x01 /**< Primary Service Declaration. */
gkroussos 0:dd0fea342ad2 74 #define BLE_GATTS_ATTR_TYPE_SEC_SRVC_DECL 0x02 /**< Secondary Service Declaration. */
gkroussos 0:dd0fea342ad2 75 #define BLE_GATTS_ATTR_TYPE_INC_DECL 0x03 /**< Include Declaration. */
gkroussos 0:dd0fea342ad2 76 #define BLE_GATTS_ATTR_TYPE_CHAR_DECL 0x04 /**< Characteristic Declaration. */
gkroussos 0:dd0fea342ad2 77 #define BLE_GATTS_ATTR_TYPE_CHAR_VAL 0x05 /**< Characteristic Value. */
gkroussos 0:dd0fea342ad2 78 #define BLE_GATTS_ATTR_TYPE_DESC 0x06 /**< Descriptor. */
gkroussos 0:dd0fea342ad2 79 #define BLE_GATTS_ATTR_TYPE_OTHER 0x07 /**< Other, non-GATT specific type. */
gkroussos 0:dd0fea342ad2 80 /** @} */
gkroussos 0:dd0fea342ad2 81
gkroussos 0:dd0fea342ad2 82
gkroussos 0:dd0fea342ad2 83 /** @defgroup BLE_GATTS_OPS GATT Server Operations
gkroussos 0:dd0fea342ad2 84 * @{ */
gkroussos 0:dd0fea342ad2 85 #define BLE_GATTS_OP_INVALID 0x00 /**< Invalid Operation. */
gkroussos 0:dd0fea342ad2 86 #define BLE_GATTS_OP_WRITE_REQ 0x01 /**< Write Request. */
gkroussos 0:dd0fea342ad2 87 #define BLE_GATTS_OP_WRITE_CMD 0x02 /**< Write Command. */
gkroussos 0:dd0fea342ad2 88 #define BLE_GATTS_OP_SIGN_WRITE_CMD 0x03 /**< Signed Write Command. */
gkroussos 0:dd0fea342ad2 89 #define BLE_GATTS_OP_PREP_WRITE_REQ 0x04 /**< Prepare Write Request. */
gkroussos 0:dd0fea342ad2 90 #define BLE_GATTS_OP_EXEC_WRITE_REQ_CANCEL 0x05 /**< Execute Write Request: Cancel all prepared writes. */
gkroussos 0:dd0fea342ad2 91 #define BLE_GATTS_OP_EXEC_WRITE_REQ_NOW 0x06 /**< Execute Write Request: Immediately execute all prepared writes. */
gkroussos 0:dd0fea342ad2 92 /** @} */
gkroussos 0:dd0fea342ad2 93
gkroussos 0:dd0fea342ad2 94 /** @defgroup BLE_GATTS_VLOCS GATT Value Locations
gkroussos 0:dd0fea342ad2 95 * @{ */
gkroussos 0:dd0fea342ad2 96 #define BLE_GATTS_VLOC_INVALID 0x00 /**< Invalid Location. */
gkroussos 0:dd0fea342ad2 97 #define BLE_GATTS_VLOC_STACK 0x01 /**< Attribute Value is located in stack memory, no user memory is required. */
gkroussos 0:dd0fea342ad2 98 #define BLE_GATTS_VLOC_USER 0x02 /**< Attribute Value is located in user memory. This requires the user to maintain a valid buffer through the lifetime of the attribute, since the stack
gkroussos 0:dd0fea342ad2 99 will read and write directly to the memory using the pointer provided in the APIs. There are no alignment requirements for the buffer. */
gkroussos 0:dd0fea342ad2 100 /** @} */
gkroussos 0:dd0fea342ad2 101
gkroussos 0:dd0fea342ad2 102 /** @defgroup BLE_GATTS_AUTHORIZE_TYPES GATT Server Authorization Types
gkroussos 0:dd0fea342ad2 103 * @{ */
gkroussos 0:dd0fea342ad2 104 #define BLE_GATTS_AUTHORIZE_TYPE_INVALID 0x00 /**< Invalid Type. */
gkroussos 0:dd0fea342ad2 105 #define BLE_GATTS_AUTHORIZE_TYPE_READ 0x01 /**< Authorize a Read Operation. */
gkroussos 0:dd0fea342ad2 106 #define BLE_GATTS_AUTHORIZE_TYPE_WRITE 0x02 /**< Authorize a Write Request Operation. */
gkroussos 0:dd0fea342ad2 107 /** @} */
gkroussos 0:dd0fea342ad2 108
gkroussos 0:dd0fea342ad2 109
gkroussos 0:dd0fea342ad2 110 /** @} */
gkroussos 0:dd0fea342ad2 111
gkroussos 0:dd0fea342ad2 112 /**@brief Attribute metadata. */
gkroussos 0:dd0fea342ad2 113 typedef struct
gkroussos 0:dd0fea342ad2 114 {
gkroussos 0:dd0fea342ad2 115 ble_gap_conn_sec_mode_t read_perm; /**< Read permissions. */
gkroussos 0:dd0fea342ad2 116 ble_gap_conn_sec_mode_t write_perm; /**< Write permissions. */
gkroussos 0:dd0fea342ad2 117 uint8_t vlen :1; /**< Variable length attribute. */
gkroussos 0:dd0fea342ad2 118 uint8_t vloc :2; /**< Value location, see @ref BLE_GATTS_VLOCS.*/
gkroussos 0:dd0fea342ad2 119 uint8_t rd_auth :1; /**< Read Authorization and value will be requested from the application on every read operation. */
gkroussos 0:dd0fea342ad2 120 uint8_t wr_auth :1; /**< Write Authorization will be requested from the application on every Write Request operation (but not Write Command). */
gkroussos 0:dd0fea342ad2 121 } ble_gatts_attr_md_t;
gkroussos 0:dd0fea342ad2 122
gkroussos 0:dd0fea342ad2 123
gkroussos 0:dd0fea342ad2 124 /**@brief GATT Attribute. */
gkroussos 0:dd0fea342ad2 125 typedef struct
gkroussos 0:dd0fea342ad2 126 {
gkroussos 0:dd0fea342ad2 127 ble_uuid_t* p_uuid; /**< Pointer to the attribute UUID. */
gkroussos 0:dd0fea342ad2 128 ble_gatts_attr_md_t* p_attr_md; /**< Pointer to the attribute metadata structure. */
gkroussos 0:dd0fea342ad2 129 uint16_t init_len; /**< Initial attribute value length in bytes. */
gkroussos 0:dd0fea342ad2 130 uint16_t init_offs; /**< Initial attribute value offset in bytes. If different from zero, the first init_offs bytes of the attribute value will be left uninitialized. */
gkroussos 0:dd0fea342ad2 131 uint16_t max_len; /**< Maximum attribute value length in bytes, see @ref BLE_GATTS_ATTR_LENS_MAX for maximum values. */
gkroussos 0:dd0fea342ad2 132 uint8_t* p_value; /**< Pointer to the attribute data. Please note that if the @ref BLE_GATTS_VLOC_USER value location is selected in the attribute metadata, this will have to point to a buffer
gkroussos 0:dd0fea342ad2 133 that remains valid through the lifetime of the attribute. This excludes usage of automatic variables that may go out of scope or any other temporary location.
gkroussos 0:dd0fea342ad2 134 The stack may access that memory directly without the application's knowledge. */
gkroussos 0:dd0fea342ad2 135 } ble_gatts_attr_t;
gkroussos 0:dd0fea342ad2 136
gkroussos 0:dd0fea342ad2 137
gkroussos 0:dd0fea342ad2 138 /**@brief GATT Attribute Context. */
gkroussos 0:dd0fea342ad2 139 typedef struct
gkroussos 0:dd0fea342ad2 140 {
gkroussos 0:dd0fea342ad2 141 ble_uuid_t srvc_uuid; /**< Service UUID. */
gkroussos 0:dd0fea342ad2 142 ble_uuid_t char_uuid; /**< Characteristic UUID if applicable (BLE_UUID_TYPE_UNKNOWN if N/A). */
gkroussos 0:dd0fea342ad2 143 ble_uuid_t desc_uuid; /**< Descriptor UUID if applicable (BLE_UUID_TYPE_UNKNOWN if N/A). */
gkroussos 0:dd0fea342ad2 144 uint16_t srvc_handle; /**< Service Handle. */
gkroussos 0:dd0fea342ad2 145 uint16_t value_handle; /**< Characteristic Handle if applicable (BLE_GATT_HANDLE_INVALID if N/A). */
gkroussos 0:dd0fea342ad2 146 uint8_t type; /**< Attribute Type, see @ref BLE_GATTS_ATTR_TYPES. */
gkroussos 0:dd0fea342ad2 147 } ble_gatts_attr_context_t;
gkroussos 0:dd0fea342ad2 148
gkroussos 0:dd0fea342ad2 149
gkroussos 0:dd0fea342ad2 150 /**@brief GATT Characteristic Presentation Format. */
gkroussos 0:dd0fea342ad2 151 typedef struct
gkroussos 0:dd0fea342ad2 152 {
gkroussos 0:dd0fea342ad2 153 uint8_t format; /**< Format of the value, see @ref BLE_GATT_CPF_FORMATS. */
gkroussos 0:dd0fea342ad2 154 int8_t exponent; /**< Exponent for integer data types. */
gkroussos 0:dd0fea342ad2 155 uint16_t unit; /**< UUID from Bluetooth Assigned Numbers. */
gkroussos 0:dd0fea342ad2 156 uint8_t name_space; /**< Namespace from Bluetooth Assigned Numbers, see @ref BLE_GATT_CPF_NAMESPACES. */
gkroussos 0:dd0fea342ad2 157 uint16_t desc; /**< Namespace description from Bluetooth Assigned Numbers, see @ref BLE_GATT_CPF_NAMESPACES. */
gkroussos 0:dd0fea342ad2 158 } ble_gatts_char_pf_t;
gkroussos 0:dd0fea342ad2 159
gkroussos 0:dd0fea342ad2 160
gkroussos 0:dd0fea342ad2 161 /**@brief GATT Characteristic metadata. */
gkroussos 0:dd0fea342ad2 162 typedef struct
gkroussos 0:dd0fea342ad2 163 {
gkroussos 0:dd0fea342ad2 164 ble_gatt_char_props_t char_props; /**< Characteristic Properties. */
gkroussos 0:dd0fea342ad2 165 ble_gatt_char_ext_props_t char_ext_props; /**< Characteristic Extended Properties. */
gkroussos 0:dd0fea342ad2 166 uint8_t* p_char_user_desc; /**< Pointer to a UTF-8, NULL if the descriptor is not required. */
gkroussos 0:dd0fea342ad2 167 uint16_t char_user_desc_max_size; /**< The maximum size in bytes of the user description descriptor. */
gkroussos 0:dd0fea342ad2 168 uint16_t char_user_desc_size; /**< The size of the user description, must be smaller or equal to char_user_desc_max_size. */
gkroussos 0:dd0fea342ad2 169 ble_gatts_char_pf_t* p_char_pf; /**< Pointer to a presentation format structure or NULL if the descriptor is not required. */
gkroussos 0:dd0fea342ad2 170 ble_gatts_attr_md_t* p_user_desc_md; /**< Attribute metadata for the User Description descriptor, or NULL for default values. */
gkroussos 0:dd0fea342ad2 171 ble_gatts_attr_md_t* p_cccd_md; /**< Attribute metadata for the Client Characteristic Configuration Descriptor, or NULL for default values. */
gkroussos 0:dd0fea342ad2 172 ble_gatts_attr_md_t* p_sccd_md; /**< Attribute metadata for the Server Characteristic Configuration Descriptor, or NULL for default values. */
gkroussos 0:dd0fea342ad2 173 } ble_gatts_char_md_t;
gkroussos 0:dd0fea342ad2 174
gkroussos 0:dd0fea342ad2 175
gkroussos 0:dd0fea342ad2 176 /**@brief GATT Characteristic Definition Handles. */
gkroussos 0:dd0fea342ad2 177 typedef struct
gkroussos 0:dd0fea342ad2 178 {
gkroussos 0:dd0fea342ad2 179 uint16_t value_handle; /**< Handle to the characteristic value. */
gkroussos 0:dd0fea342ad2 180 uint16_t user_desc_handle; /**< Handle to the User Description descriptor, or BLE_GATT_HANDLE_INVALID if not present. */
gkroussos 0:dd0fea342ad2 181 uint16_t cccd_handle; /**< Handle to the Client Characteristic Configuration Descriptor, or BLE_GATT_HANDLE_INVALID if not present. */
gkroussos 0:dd0fea342ad2 182 uint16_t sccd_handle; /**< Handle to the Server Characteristic Configuration Descriptor, or BLE_GATT_HANDLE_INVALID if not present. */
gkroussos 0:dd0fea342ad2 183 } ble_gatts_char_handles_t;
gkroussos 0:dd0fea342ad2 184
gkroussos 0:dd0fea342ad2 185
gkroussos 0:dd0fea342ad2 186 /**@brief GATT HVx parameters. */
gkroussos 0:dd0fea342ad2 187 typedef struct
gkroussos 0:dd0fea342ad2 188 {
gkroussos 0:dd0fea342ad2 189 uint16_t handle; /**< Characteristic Value Handle. */
gkroussos 0:dd0fea342ad2 190 uint8_t type; /**< Indication or Notification, see @ref BLE_GATT_HVX_TYPES. */
gkroussos 0:dd0fea342ad2 191 uint16_t offset; /**< Offset within the attribute value. */
gkroussos 0:dd0fea342ad2 192 uint16_t* p_len; /**< Length in bytes to be written, length in bytes written after successful return. */
gkroussos 0:dd0fea342ad2 193 uint8_t* p_data; /**< Actual data content, use NULL to use the current attribute value. */
gkroussos 0:dd0fea342ad2 194 } ble_gatts_hvx_params_t;
gkroussos 0:dd0fea342ad2 195
gkroussos 0:dd0fea342ad2 196 /**@brief GATT Read Authorization parameters. */
gkroussos 0:dd0fea342ad2 197 typedef struct
gkroussos 0:dd0fea342ad2 198 {
gkroussos 0:dd0fea342ad2 199 uint16_t gatt_status; /**< GATT status code for the operation, see @ref BLE_GATT_STATUS_CODES. */
gkroussos 0:dd0fea342ad2 200 uint8_t update : 1; /**< If set, data supplied in p_data will be used in the ATT response. */
gkroussos 0:dd0fea342ad2 201 uint16_t offset; /**< Offset of the attribute value being updated. */
gkroussos 0:dd0fea342ad2 202 uint16_t len; /**< Length in bytes of the value in p_data pointer, see @ref BLE_GATTS_ATTR_LENS_MAX. */
gkroussos 0:dd0fea342ad2 203 uint8_t* p_data; /**< Pointer to new value used to update the attribute value. */
gkroussos 0:dd0fea342ad2 204 } ble_gatts_read_authorize_params_t;
gkroussos 0:dd0fea342ad2 205
gkroussos 0:dd0fea342ad2 206 /**@brief GATT Write Authorisation parameters. */
gkroussos 0:dd0fea342ad2 207 typedef struct
gkroussos 0:dd0fea342ad2 208 {
gkroussos 0:dd0fea342ad2 209 uint16_t gatt_status; /**< GATT status code for the operation, see @ref BLE_GATT_STATUS_CODES. */
gkroussos 0:dd0fea342ad2 210 } ble_gatts_write_authorize_params_t;
gkroussos 0:dd0fea342ad2 211
gkroussos 0:dd0fea342ad2 212 /**@brief GATT Read or Write Authorize Reply parameters. */
gkroussos 0:dd0fea342ad2 213 typedef struct
gkroussos 0:dd0fea342ad2 214 {
gkroussos 0:dd0fea342ad2 215 uint8_t type; /**< Type of authorize operation, see @ref BLE_GATTS_AUTHORIZE_TYPES. */
gkroussos 0:dd0fea342ad2 216 union {
gkroussos 0:dd0fea342ad2 217 ble_gatts_read_authorize_params_t read; /**< Read authorization parameters. */
gkroussos 0:dd0fea342ad2 218 ble_gatts_write_authorize_params_t write; /**< Write authorization parameters. */
gkroussos 0:dd0fea342ad2 219 } params;
gkroussos 0:dd0fea342ad2 220 } ble_gatts_rw_authorize_reply_params_t;
gkroussos 0:dd0fea342ad2 221
gkroussos 0:dd0fea342ad2 222
gkroussos 0:dd0fea342ad2 223 /**
gkroussos 0:dd0fea342ad2 224 * @brief GATT Server Event IDs.
gkroussos 0:dd0fea342ad2 225 */
gkroussos 0:dd0fea342ad2 226 enum BLE_GATTS_EVTS
gkroussos 0:dd0fea342ad2 227 {
gkroussos 0:dd0fea342ad2 228 BLE_GATTS_EVT_WRITE = BLE_GATTS_EVT_BASE, /**< Write operation performed. */
gkroussos 0:dd0fea342ad2 229 BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST, /**< Read/Write Authorization request. */
gkroussos 0:dd0fea342ad2 230 BLE_GATTS_EVT_SYS_ATTR_MISSING, /**< A persistent system attribute access is pending, awaiting a sd_ble_gatts_sys_attr_set(). */
gkroussos 0:dd0fea342ad2 231 BLE_GATTS_EVT_HVC, /**< Handle Value Confirmation. */
gkroussos 0:dd0fea342ad2 232 BLE_GATTS_EVT_SC_CONFIRM, /**< Service Changed Confirmation. */
gkroussos 0:dd0fea342ad2 233 BLE_GATTS_EVT_TIMEOUT /**< Timeout. */
gkroussos 0:dd0fea342ad2 234 };
gkroussos 0:dd0fea342ad2 235
gkroussos 0:dd0fea342ad2 236
gkroussos 0:dd0fea342ad2 237 /**@brief Event structure for BLE_GATTS_EVT_WRITE. */
gkroussos 0:dd0fea342ad2 238 typedef struct
gkroussos 0:dd0fea342ad2 239 {
gkroussos 0:dd0fea342ad2 240 uint16_t handle; /**< Attribute Handle. */
gkroussos 0:dd0fea342ad2 241 uint8_t op; /**< Type of write operation, see @ref BLE_GATTS_OPS. */
gkroussos 0:dd0fea342ad2 242 ble_gatts_attr_context_t context; /**< Attribute Context. */
gkroussos 0:dd0fea342ad2 243 uint16_t offset; /**< Offset for the write operation. */
gkroussos 0:dd0fea342ad2 244 uint16_t len; /**< Length of the incoming data. */
gkroussos 0:dd0fea342ad2 245 uint8_t data[1]; /**< Incoming data, variable length. */
gkroussos 0:dd0fea342ad2 246 } ble_gatts_evt_write_t;
gkroussos 0:dd0fea342ad2 247
gkroussos 0:dd0fea342ad2 248 /**@brief Event structure for authorize read request. */
gkroussos 0:dd0fea342ad2 249 typedef struct
gkroussos 0:dd0fea342ad2 250 {
gkroussos 0:dd0fea342ad2 251 uint16_t handle; /**< Attribute Handle. */
gkroussos 0:dd0fea342ad2 252 ble_gatts_attr_context_t context; /**< Attribute Context. */
gkroussos 0:dd0fea342ad2 253 uint16_t offset; /**< Offset for the read operation. */
gkroussos 0:dd0fea342ad2 254 } ble_gatts_evt_read_t;
gkroussos 0:dd0fea342ad2 255
gkroussos 0:dd0fea342ad2 256 /**@brief Event structure for BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST. */
gkroussos 0:dd0fea342ad2 257 typedef struct
gkroussos 0:dd0fea342ad2 258 {
gkroussos 0:dd0fea342ad2 259 uint8_t type; /**< Type of authorize operation, see @ref BLE_GATTS_AUTHORIZE_TYPES. */
gkroussos 0:dd0fea342ad2 260 union {
gkroussos 0:dd0fea342ad2 261 ble_gatts_evt_read_t read; /**< Attribute Read Parameters. */
gkroussos 0:dd0fea342ad2 262 ble_gatts_evt_write_t write; /**< Attribute Write Parameters. */
gkroussos 0:dd0fea342ad2 263 } request;
gkroussos 0:dd0fea342ad2 264 } ble_gatts_evt_rw_authorize_request_t;
gkroussos 0:dd0fea342ad2 265
gkroussos 0:dd0fea342ad2 266 /**@brief Event structure for BLE_GATTS_EVT_SYS_ATTR_MISSING. */
gkroussos 0:dd0fea342ad2 267 typedef struct
gkroussos 0:dd0fea342ad2 268 {
gkroussos 0:dd0fea342ad2 269 uint8_t hint;
gkroussos 0:dd0fea342ad2 270 } ble_gatts_evt_sys_attr_missing_t;
gkroussos 0:dd0fea342ad2 271
gkroussos 0:dd0fea342ad2 272
gkroussos 0:dd0fea342ad2 273 /**@brief Event structure for BLE_GATTS_EVT_HVC. */
gkroussos 0:dd0fea342ad2 274 typedef struct
gkroussos 0:dd0fea342ad2 275 {
gkroussos 0:dd0fea342ad2 276 uint16_t handle; /**< Attribute Handle. */
gkroussos 0:dd0fea342ad2 277 } ble_gatts_evt_hvc_t;
gkroussos 0:dd0fea342ad2 278
gkroussos 0:dd0fea342ad2 279 /**@brief Event structure for BLE_GATTS_EVT_TIMEOUT. */
gkroussos 0:dd0fea342ad2 280 typedef struct
gkroussos 0:dd0fea342ad2 281 {
gkroussos 0:dd0fea342ad2 282 uint8_t src; /**< Timeout source, see @ref BLE_GATT_TIMEOUT_SOURCES. */
gkroussos 0:dd0fea342ad2 283 } ble_gatts_evt_timeout_t;
gkroussos 0:dd0fea342ad2 284
gkroussos 0:dd0fea342ad2 285
gkroussos 0:dd0fea342ad2 286 /**@brief GATT Server event callback event structure. */
gkroussos 0:dd0fea342ad2 287 typedef struct
gkroussos 0:dd0fea342ad2 288 {
gkroussos 0:dd0fea342ad2 289 uint16_t conn_handle; /**< Connection Handle on which event occurred. */
gkroussos 0:dd0fea342ad2 290 union
gkroussos 0:dd0fea342ad2 291 {
gkroussos 0:dd0fea342ad2 292 ble_gatts_evt_write_t write; /**< Write Event Parameters. */
gkroussos 0:dd0fea342ad2 293 ble_gatts_evt_rw_authorize_request_t authorize_request; /**< Read or Write Authorize Request Parameters. */
gkroussos 0:dd0fea342ad2 294 ble_gatts_evt_sys_attr_missing_t sys_attr_missing; /**< System attributes missing. */
gkroussos 0:dd0fea342ad2 295 ble_gatts_evt_hvc_t hvc; /**< Handle Value Confirmation Event Parameters. */
gkroussos 0:dd0fea342ad2 296 ble_gatts_evt_timeout_t timeout; /**< Timeout Event. */
gkroussos 0:dd0fea342ad2 297 } params;
gkroussos 0:dd0fea342ad2 298 } ble_gatts_evt_t;
gkroussos 0:dd0fea342ad2 299
gkroussos 0:dd0fea342ad2 300
gkroussos 0:dd0fea342ad2 301 /**@brief Add a service declaration to the local server ATT table.
gkroussos 0:dd0fea342ad2 302 *
gkroussos 0:dd0fea342ad2 303 * @param[in] type Toggles between primary and secondary services, see @ref BLE_GATTS_SRVC_TYPES.
gkroussos 0:dd0fea342ad2 304 * @param[in] p_uuid Pointer to service UUID.
gkroussos 0:dd0fea342ad2 305 * @param[out] p_handle Pointer to a 16-bit word where the assigned handle will be stored.
gkroussos 0:dd0fea342ad2 306 *
gkroussos 0:dd0fea342ad2 307 * @note Secondary Services are only relevant in the context of the entity that references them, it is therefore forbidden to
gkroussos 0:dd0fea342ad2 308 * add a secondary service declaration that is not referenced by another service later in the ATT table.
gkroussos 0:dd0fea342ad2 309 *
gkroussos 0:dd0fea342ad2 310 * @return @ref NRF_SUCCESS Successfully added a service declaration.
gkroussos 0:dd0fea342ad2 311 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
gkroussos 0:dd0fea342ad2 312 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, Vendor Specific UUIDs need to be present in the table.
gkroussos 0:dd0fea342ad2 313 * @return @ref NRF_ERROR_FORBIDDEN Forbidden value supplied, certain UUIDs are reserved for the stack.
gkroussos 0:dd0fea342ad2 314 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation.
gkroussos 0:dd0fea342ad2 315 */
gkroussos 0:dd0fea342ad2 316 SVCALL(SD_BLE_GATTS_SERVICE_ADD, uint32_t, sd_ble_gatts_service_add(uint8_t type, ble_uuid_t const*const p_uuid, uint16_t *const p_handle));
gkroussos 0:dd0fea342ad2 317
gkroussos 0:dd0fea342ad2 318
gkroussos 0:dd0fea342ad2 319 /**@brief Add an include declaration to the local server ATT table.
gkroussos 0:dd0fea342ad2 320 *
gkroussos 0:dd0fea342ad2 321 * @note It is currently only possible to add an include declaration to the last added service (i.e. only sequential addition is supported at this time).
gkroussos 0:dd0fea342ad2 322 *
gkroussos 0:dd0fea342ad2 323 * @note The included service must already be present in the ATT table prior to this call.
gkroussos 0:dd0fea342ad2 324 *
gkroussos 0:dd0fea342ad2 325 * @param[in] service_handle Handle of the service where the included service is to be placed, if BLE_GATT_HANDLE_INVALID is used, it will be placed sequentially.
gkroussos 0:dd0fea342ad2 326 * @param[in] inc_srvc_handle Handle of the included service.
gkroussos 0:dd0fea342ad2 327 * @param[out] p_include_handle Pointer to a 16-bit word where the assigned handle will be stored.
gkroussos 0:dd0fea342ad2 328 *
gkroussos 0:dd0fea342ad2 329 * @return @ref NRF_SUCCESS Successfully added an include declaration.
gkroussos 0:dd0fea342ad2 330 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
gkroussos 0:dd0fea342ad2 331 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, handle values need to match previously added services.
gkroussos 0:dd0fea342ad2 332 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation.
gkroussos 0:dd0fea342ad2 333 * @return @ref NRF_ERROR_FORBIDDEN Forbidden value supplied, self inclusions are not allowed.
gkroussos 0:dd0fea342ad2 334 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation.
gkroussos 0:dd0fea342ad2 335 * @return @ref NRF_ERROR_NOT_FOUND Attribute not found.
gkroussos 0:dd0fea342ad2 336 */
gkroussos 0:dd0fea342ad2 337 SVCALL(SD_BLE_GATTS_INCLUDE_ADD, uint32_t, sd_ble_gatts_include_add(uint16_t service_handle, uint16_t inc_srvc_handle, uint16_t *const p_include_handle));
gkroussos 0:dd0fea342ad2 338
gkroussos 0:dd0fea342ad2 339
gkroussos 0:dd0fea342ad2 340 /**@brief Add a characteristic declaration, a characteristic value declaration and optional characteristic descriptor declarations to the local server ATT table.
gkroussos 0:dd0fea342ad2 341 *
gkroussos 0:dd0fea342ad2 342 * @note It is currently only possible to add a characteristic to the last added service (i.e. only sequential addition is supported at this time).
gkroussos 0:dd0fea342ad2 343 *
gkroussos 0:dd0fea342ad2 344 * @note Several restrictions apply to the parameters, such as matching permissions between the user description descriptor and the writeable auxiliaries bits,
gkroussos 0:dd0fea342ad2 345 * readable (no security) and writeable (selectable) CCCDs and SCCDs and valid presentation format values.
gkroussos 0:dd0fea342ad2 346 *
gkroussos 0:dd0fea342ad2 347 * @note If no metadata is provided for the optional descriptors, their permissions will be derived from the characteristic permissions.
gkroussos 0:dd0fea342ad2 348 *
gkroussos 0:dd0fea342ad2 349 * @param[in] service_handle Handle of the service where the characteristic is to be placed, if BLE_GATT_HANDLE_INVALID is used, it will be placed sequentially.
gkroussos 0:dd0fea342ad2 350 * @param[in] p_char_md Characteristic metadata.
gkroussos 0:dd0fea342ad2 351 * @param[in] p_attr_char_value Pointer to the attribute structure corresponding to the characteristic value.
gkroussos 0:dd0fea342ad2 352 * @param[out] p_handles Pointer to the structure where the assigned handles will be stored.
gkroussos 0:dd0fea342ad2 353 *
gkroussos 0:dd0fea342ad2 354 * @return @ref NRF_SUCCESS Successfully added a characteristic.
gkroussos 0:dd0fea342ad2 355 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
gkroussos 0:dd0fea342ad2 356 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, service handle, Vendor Specific UUIDs, lengths, and permissions need to adhere to the constraints.
gkroussos 0:dd0fea342ad2 357 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation, a service context is required.
gkroussos 0:dd0fea342ad2 358 * @return @ref NRF_ERROR_FORBIDDEN Forbidden value supplied, certain UUIDs are reserved for the stack.
gkroussos 0:dd0fea342ad2 359 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation.
gkroussos 0:dd0fea342ad2 360 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, attribute lengths are restricted by @ref BLE_GATTS_ATTR_LENS_MAX.
gkroussos 0:dd0fea342ad2 361 */
gkroussos 0:dd0fea342ad2 362 SVCALL(SD_BLE_GATTS_CHARACTERISTIC_ADD, uint32_t, sd_ble_gatts_characteristic_add(uint16_t service_handle, ble_gatts_char_md_t const*const p_char_md, ble_gatts_attr_t const*const p_attr_char_value, ble_gatts_char_handles_t *const p_handles));
gkroussos 0:dd0fea342ad2 363
gkroussos 0:dd0fea342ad2 364
gkroussos 0:dd0fea342ad2 365 /**@brief Add a descriptor to the local server ATT table.
gkroussos 0:dd0fea342ad2 366 *
gkroussos 0:dd0fea342ad2 367 * @note It is currently only possible to add a descriptor to the last added characteristic (i.e. only sequential addition is supported at this time).
gkroussos 0:dd0fea342ad2 368 *
gkroussos 0:dd0fea342ad2 369 * @param[in] char_handle Handle of the characteristic where the descriptor is to be placed, if BLE_GATT_HANDLE_INVALID is used, it will be placed sequentially.
gkroussos 0:dd0fea342ad2 370 * @param[in] p_attr Pointer to the attribute structure.
gkroussos 0:dd0fea342ad2 371 * @param[out] p_handle Pointer to a 16-bit word where the assigned handle will be stored.
gkroussos 0:dd0fea342ad2 372 *
gkroussos 0:dd0fea342ad2 373 * @return @ref NRF_SUCCESS Successfully added a descriptor.
gkroussos 0:dd0fea342ad2 374 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
gkroussos 0:dd0fea342ad2 375 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, characteristic handle, Vendor Specific UUIDs, lengths, and permissions need to adhere to the constraints.
gkroussos 0:dd0fea342ad2 376 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation, a characteristic context is required.
gkroussos 0:dd0fea342ad2 377 * @return @ref NRF_ERROR_FORBIDDEN Forbidden value supplied, certain UUIDs are reserved for the stack.
gkroussos 0:dd0fea342ad2 378 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation.
gkroussos 0:dd0fea342ad2 379 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, attribute lengths are restricted by @ref BLE_GATTS_ATTR_LENS_MAX.
gkroussos 0:dd0fea342ad2 380 */
gkroussos 0:dd0fea342ad2 381 SVCALL(SD_BLE_GATTS_DESCRIPTOR_ADD, uint32_t, sd_ble_gatts_descriptor_add(uint16_t char_handle, ble_gatts_attr_t const * const p_attr, uint16_t* const p_handle));
gkroussos 0:dd0fea342ad2 382
gkroussos 0:dd0fea342ad2 383 /**@brief Set the value of a given attribute.
gkroussos 0:dd0fea342ad2 384 *
gkroussos 0:dd0fea342ad2 385 * @param[in] handle Attribute handle.
gkroussos 0:dd0fea342ad2 386 * @param[in] offset Offset in bytes to write from.
gkroussos 0:dd0fea342ad2 387 * @param[in,out] p_len Length in bytes to be written, length in bytes written after successful return.
gkroussos 0:dd0fea342ad2 388 * @param[in] p_value Pointer to a buffer (at least len bytes long) containing the desired attribute value.
gkroussos 0:dd0fea342ad2 389 *
gkroussos 0:dd0fea342ad2 390 * @return @ref NRF_SUCCESS Successfully set the value of the attribute.
gkroussos 0:dd0fea342ad2 391 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
gkroussos 0:dd0fea342ad2 392 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied.
gkroussos 0:dd0fea342ad2 393 * @return @ref NRF_ERROR_NOT_FOUND Attribute not found.
gkroussos 0:dd0fea342ad2 394 * @return @ref NRF_ERROR_FORBIDDEN Forbidden handle supplied, certain attributes are not modifiable by the application.
gkroussos 0:dd0fea342ad2 395 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, attribute lengths are restricted by @ref BLE_GATTS_ATTR_LENS_MAX.
gkroussos 0:dd0fea342ad2 396 */
gkroussos 0:dd0fea342ad2 397 SVCALL(SD_BLE_GATTS_VALUE_SET, uint32_t, sd_ble_gatts_value_set(uint16_t handle, uint16_t offset, uint16_t* const p_len, uint8_t const * const p_value));
gkroussos 0:dd0fea342ad2 398
gkroussos 0:dd0fea342ad2 399 /**@brief Get the value of a given attribute.
gkroussos 0:dd0fea342ad2 400 *
gkroussos 0:dd0fea342ad2 401 * @param[in] handle Attribute handle.
gkroussos 0:dd0fea342ad2 402 * @param[in] offset Offset in bytes to read from.
gkroussos 0:dd0fea342ad2 403 * @param[in,out] p_len Length in bytes to be read, total length of attribute value (in bytes, starting from offset) after successful return.
gkroussos 0:dd0fea342ad2 404 * @param[in,out] p_data Pointer to a buffer (at least len bytes long) where to store the attribute value. Set to NULL to obtain the complete length of attribute value.
gkroussos 0:dd0fea342ad2 405 *
gkroussos 0:dd0fea342ad2 406 * @note If the attribute value is longer than the size of the supplied buffer,
gkroussos 0:dd0fea342ad2 407 * p_len will return the total attribute value length (excluding offset),
gkroussos 0:dd0fea342ad2 408 * and not the number of bytes actually returned in p_data.
gkroussos 0:dd0fea342ad2 409 * The application may use this information to allocate a suitable buffer size.
gkroussos 0:dd0fea342ad2 410 *
gkroussos 0:dd0fea342ad2 411 * @return @ref NRF_SUCCESS Successfully retrieved the value of the attribute.
gkroussos 0:dd0fea342ad2 412 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
gkroussos 0:dd0fea342ad2 413 * @return @ref NRF_ERROR_NOT_FOUND Attribute not found.
gkroussos 0:dd0fea342ad2 414 */
gkroussos 0:dd0fea342ad2 415 SVCALL(SD_BLE_GATTS_VALUE_GET, uint32_t, sd_ble_gatts_value_get(uint16_t handle, uint16_t offset, uint16_t *const p_len, uint8_t* const p_data));
gkroussos 0:dd0fea342ad2 416
gkroussos 0:dd0fea342ad2 417 /**@brief Notify or Indicate an attribute value.
gkroussos 0:dd0fea342ad2 418 *
gkroussos 0:dd0fea342ad2 419 * @details This function checks for the relevant Client Characteristic Configuration descriptor value to verify that the relevant operation
gkroussos 0:dd0fea342ad2 420 * (notification or indication) has been enabled by the client. It is also able to update the attribute value before issuing the PDU, so that
gkroussos 0:dd0fea342ad2 421 * the application can atomically perform a value update and a server initiated transaction with a single API call.
gkroussos 0:dd0fea342ad2 422 * If the application chooses to indicate an attribute value, a @ref BLE_GATTS_EVT_HVC will be sent up as soon as the confirmation arrives from
gkroussos 0:dd0fea342ad2 423 * the peer.
gkroussos 0:dd0fea342ad2 424 *
gkroussos 0:dd0fea342ad2 425 * @note The local attribute value may be updated even if an outgoing packet is not sent to the peer due to an error during execution.
gkroussos 0:dd0fea342ad2 426 * When receiveing the error codes @ref NRF_ERROR_INVALID_STATE, @ref NRF_ERROR_BUSY, @ref BLE_ERROR_GATTS_SYS_ATTR_MISSING and
gkroussos 0:dd0fea342ad2 427 * @ref BLE_ERROR_NO_TX_BUFFERS the ATT table has been updated.
gkroussos 0:dd0fea342ad2 428 * The caller can check whether the value has been updated by looking at the contents of *(p_hvx_params->p_len).
gkroussos 0:dd0fea342ad2 429 *
gkroussos 0:dd0fea342ad2 430 * @note It is important to note that a notification will <b>consume an application buffer</b>, and will therefore
gkroussos 0:dd0fea342ad2 431 * generate a @ref BLE_EVT_TX_COMPLETE event when the packet has been transmitted. An indication on the other hand will use the
gkroussos 0:dd0fea342ad2 432 * standard server internal buffer and thus will only generate a @ref BLE_GATTS_EVT_HVC event as soon as the confirmation
gkroussos 0:dd0fea342ad2 433 * has been received from the peer. Please see the documentation of @ref sd_ble_tx_buffer_count_get for more details.
gkroussos 0:dd0fea342ad2 434 *
gkroussos 0:dd0fea342ad2 435 * @param[in] conn_handle Connection handle.
gkroussos 0:dd0fea342ad2 436 * @param[in] p_hvx_params Pointer to an HVx parameters structure. If the p_data member contains a non-NULL pointer the attribute value will be updated with
gkroussos 0:dd0fea342ad2 437 * the contents pointed by it before sending the notification or indication.
gkroussos 0:dd0fea342ad2 438 *
gkroussos 0:dd0fea342ad2 439 * @return @ref NRF_SUCCESS Successfully queued a notification or indication for transmission, and optionally updated the attribute value.
gkroussos 0:dd0fea342ad2 440 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
gkroussos 0:dd0fea342ad2 441 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
gkroussos 0:dd0fea342ad2 442 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied.
gkroussos 0:dd0fea342ad2 443 * @return @ref BLE_ERROR_INVALID_ATTR_HANDLE Invalid attribute handle(s) supplied. Only attributes added directly by the application are available to notify and indicate.
gkroussos 0:dd0fea342ad2 444 * @return @ref BLE_ERROR_GATTS_INVALID_ATTR_TYPE Invalid attribute type(s) supplied, only characteristic values may be notified and indicated.
gkroussos 0:dd0fea342ad2 445 * @return @ref NRF_ERROR_NOT_FOUND Attribute not found.
gkroussos 0:dd0fea342ad2 446 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied.
gkroussos 0:dd0fea342ad2 447 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation, notifications or indications must be enabled in the CCCD.
gkroussos 0:dd0fea342ad2 448 * @return @ref NRF_ERROR_BUSY Procedure already in progress.
gkroussos 0:dd0fea342ad2 449 * @return @ref BLE_ERROR_GATTS_SYS_ATTR_MISSING System attributes missing, use @ref sd_ble_gatts_sys_attr_set to set them to a known value.
gkroussos 0:dd0fea342ad2 450 * @return @ref BLE_ERROR_NO_TX_BUFFERS There are no available buffers to send the data, applies only to notifications.
gkroussos 0:dd0fea342ad2 451 */
gkroussos 0:dd0fea342ad2 452 SVCALL(SD_BLE_GATTS_HVX, uint32_t, sd_ble_gatts_hvx(uint16_t conn_handle, ble_gatts_hvx_params_t const*const p_hvx_params));
gkroussos 0:dd0fea342ad2 453
gkroussos 0:dd0fea342ad2 454 /**@brief Indicate the Service Changed attribute value.
gkroussos 0:dd0fea342ad2 455 *
gkroussos 0:dd0fea342ad2 456 * @details This call will send a Handle Value Indication to one or more peers connected to inform them that the attribute
gkroussos 0:dd0fea342ad2 457 * table layout has changed. As soon as the peer has confirmed the indication, a @ref BLE_GATTS_EVT_SC_CONFIRM event will
gkroussos 0:dd0fea342ad2 458 * be issued.
gkroussos 0:dd0fea342ad2 459 *
gkroussos 0:dd0fea342ad2 460 * @note Some of the restrictions and limitations that apply to @ref sd_ble_gatts_hvx also apply here.
gkroussos 0:dd0fea342ad2 461 *
gkroussos 0:dd0fea342ad2 462 * @param[in] conn_handle Connection handle.
gkroussos 0:dd0fea342ad2 463 * @param[in] start_handle Start of affected attribute handle range.
gkroussos 0:dd0fea342ad2 464 * @param[in] end_handle End of affected attribute handle range.
gkroussos 0:dd0fea342ad2 465 *
gkroussos 0:dd0fea342ad2 466 * @return @ref NRF_SUCCESS Successfully queued the Service Changed indication for transmission.
gkroussos 0:dd0fea342ad2 467 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
gkroussos 0:dd0fea342ad2 468 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied.
gkroussos 0:dd0fea342ad2 469 * @return @ref BLE_ERROR_INVALID_ATTR_HANDLE Invalid attribute handle(s) supplied, handles must be in the range populated by the application.
gkroussos 0:dd0fea342ad2 470 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation, notifications or indications must be enabled in the CCCD.
gkroussos 0:dd0fea342ad2 471 * @return @ref NRF_ERROR_BUSY Procedure already in progress.
gkroussos 0:dd0fea342ad2 472 * @return @ref BLE_ERROR_GATTS_SYS_ATTR_MISSING System attributes missing, use @ref sd_ble_gatts_sys_attr_set to set them to a known value.
gkroussos 0:dd0fea342ad2 473 */
gkroussos 0:dd0fea342ad2 474 SVCALL(SD_BLE_GATTS_SERVICE_CHANGED, uint32_t, sd_ble_gatts_service_changed(uint16_t conn_handle, uint16_t start_handle, uint16_t end_handle));
gkroussos 0:dd0fea342ad2 475
gkroussos 0:dd0fea342ad2 476 /**@brief Respond to a Read/Write authorization request.
gkroussos 0:dd0fea342ad2 477 *
gkroussos 0:dd0fea342ad2 478 * @note This call should only be used as a response to a @ref BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST event issued to the application.
gkroussos 0:dd0fea342ad2 479 *
gkroussos 0:dd0fea342ad2 480 * @param[in] conn_handle Connection handle.
gkroussos 0:dd0fea342ad2 481 * @param[in] p_rw_authorize_reply_params Pointer to a structure with the attribute provided by the application.
gkroussos 0:dd0fea342ad2 482 *
gkroussos 0:dd0fea342ad2 483 * @return @ref NRF_SUCCESS Successfully queued a response to the peer, and in the case of a write operation, ATT table updated.
gkroussos 0:dd0fea342ad2 484 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
gkroussos 0:dd0fea342ad2 485 * @return @ref NRF_ERROR_INVALID_STATE No authorization request pending.
gkroussos 0:dd0fea342ad2 486 * @return @ref NRF_ERROR_INVALID_PARAM Authorization op invalid,
gkroussos 0:dd0fea342ad2 487 * or for Read Authorization reply: requested handles not replied with,
gkroussos 0:dd0fea342ad2 488 * or for Write Authorization reply: handle supplied does not match requested handle.
gkroussos 0:dd0fea342ad2 489 */
gkroussos 0:dd0fea342ad2 490 SVCALL(SD_BLE_GATTS_RW_AUTHORIZE_REPLY, uint32_t, sd_ble_gatts_rw_authorize_reply(uint16_t conn_handle, ble_gatts_rw_authorize_reply_params_t const*const p_rw_authorize_reply_params));
gkroussos 0:dd0fea342ad2 491
gkroussos 0:dd0fea342ad2 492
gkroussos 0:dd0fea342ad2 493 /**@brief Update persistent system attribute information.
gkroussos 0:dd0fea342ad2 494 *
gkroussos 0:dd0fea342ad2 495 * @details Supply to the stack information about persistent system attributes.
gkroussos 0:dd0fea342ad2 496 * This call is legal in the connected state only, and is usually
gkroussos 0:dd0fea342ad2 497 * made immediately after a connection is established and the bond identified.
gkroussos 0:dd0fea342ad2 498 * usually as a response to a BLE_GATTS_EVT_SYS_ATTR_MISSING.
gkroussos 0:dd0fea342ad2 499 *
gkroussos 0:dd0fea342ad2 500 * p_sysattrs may point directly to the application's stored copy of the struct.
gkroussos 0:dd0fea342ad2 501 * If the pointer is NULL, the system attribute info is initialized, assuming that
gkroussos 0:dd0fea342ad2 502 * the application does not have any previously saved data for this bond.
gkroussos 0:dd0fea342ad2 503 *
gkroussos 0:dd0fea342ad2 504 * @note The state of persistent system attributes is reset upon connection and then remembered for its duration.
gkroussos 0:dd0fea342ad2 505 *
gkroussos 0:dd0fea342ad2 506 * @note If this call returns with an error code different from @ref NRF_SUCCESS, the storage of persistent system attributes may have been completed only partially.
gkroussos 0:dd0fea342ad2 507 * This means that the state of the attribute table is undefined, and the application should either provide a new set of attributes using this same call or
gkroussos 0:dd0fea342ad2 508 * reset the SoftDevice to return to a known state.
gkroussos 0:dd0fea342ad2 509 *
gkroussos 0:dd0fea342ad2 510 * @param[in] conn_handle Connection handle.
gkroussos 0:dd0fea342ad2 511 * @param[in] p_sys_attr_data Pointer to a saved copy of system attributes supplied to the stack, or NULL.
gkroussos 0:dd0fea342ad2 512 * @param[in] len Size of data pointed by p_sys_attr_data, in octets.
gkroussos 0:dd0fea342ad2 513 *
gkroussos 0:dd0fea342ad2 514 * @return @ref NRF_SUCCESS Successfully set the system attribute information.
gkroussos 0:dd0fea342ad2 515 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
gkroussos 0:dd0fea342ad2 516 * @return @ref NRF_ERROR_INVALID_DATA Invalid data supplied, the data should be exactly the same as retrieved with @ref sd_ble_gatts_sys_attr_get.
gkroussos 0:dd0fea342ad2 517 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation.
gkroussos 0:dd0fea342ad2 518 */
gkroussos 0:dd0fea342ad2 519 SVCALL(SD_BLE_GATTS_SYS_ATTR_SET, uint32_t, sd_ble_gatts_sys_attr_set(uint16_t conn_handle, uint8_t const*const p_sys_attr_data, uint16_t len));
gkroussos 0:dd0fea342ad2 520
gkroussos 0:dd0fea342ad2 521
gkroussos 0:dd0fea342ad2 522 /**@brief Retrieve persistent system attribute information from the stack.
gkroussos 0:dd0fea342ad2 523 *
gkroussos 0:dd0fea342ad2 524 * @details This call is used to retrieve information about values to be stored perisistently by the application
gkroussos 0:dd0fea342ad2 525 * after a connection has been terminated. When a new connection is made to the same bond, the values
gkroussos 0:dd0fea342ad2 526 * should be restored using @ref sd_ble_gatts_sys_attr_set.
gkroussos 0:dd0fea342ad2 527 * The data should be read before any new advertising is started, or any new connection established. The connection handle for
gkroussos 0:dd0fea342ad2 528 * the previous now defunct connection will remain valid until a new one is created to allow this API call to refer to it.
gkroussos 0:dd0fea342ad2 529 *
gkroussos 0:dd0fea342ad2 530 * @param[in] conn_handle Connection handle of the recently terminated connection.
gkroussos 0:dd0fea342ad2 531 * @param[in] p_sys_attr_data Pointer to a buffer where updated information about system attributes will be filled in. NULL can be provided to
gkroussos 0:dd0fea342ad2 532 * obtain the length of the data
gkroussos 0:dd0fea342ad2 533 * @param[in,out] p_len Size of application buffer if p_sys_attr_data is not NULL. Unconditially updated to actual length of system attribute data.
gkroussos 0:dd0fea342ad2 534 *
gkroussos 0:dd0fea342ad2 535 * @return @ref NRF_SUCCESS Successfully retrieved the system attribute information.
gkroussos 0:dd0fea342ad2 536 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
gkroussos 0:dd0fea342ad2 537 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
gkroussos 0:dd0fea342ad2 538 * @return @ref NRF_ERROR_DATA_SIZE The system attribute information did not fit into the provided buffer.
gkroussos 0:dd0fea342ad2 539 */
gkroussos 0:dd0fea342ad2 540 SVCALL(SD_BLE_GATTS_SYS_ATTR_GET, uint32_t, sd_ble_gatts_sys_attr_get(uint16_t conn_handle, uint8_t * const p_sys_attr_data, uint16_t* const p_len));
gkroussos 0:dd0fea342ad2 541
gkroussos 0:dd0fea342ad2 542
gkroussos 0:dd0fea342ad2 543 #endif // BLE_GATTS_H__
gkroussos 0:dd0fea342ad2 544
gkroussos 0:dd0fea342ad2 545 /**
gkroussos 0:dd0fea342ad2 546 @}
gkroussos 0:dd0fea342ad2 547 */