iOSのBLEコントローラアプリ「RCBController」と接続し、コントローラの操作を取得するサンプルプログラムです。 mbed HRM1017で動作を確認しています。
Dependencies: BLE_API_Native_IRC BLE_API mbed
ble_gatts.h
00001 /* Copyright (c) 2011 Nordic Semiconductor. All Rights Reserved. 00002 * 00003 * The information contained herein is confidential property of Nordic Semiconductor. The use, 00004 * copying, transfer or disclosure of such information is prohibited except by express written 00005 * agreement with Nordic Semiconductor. 00006 * 00007 */ 00008 /** 00009 @addtogroup BLE_GATTS Generic Attribute Profile (GATT) Server 00010 @{ 00011 @brief Definitions and prototypes for the GATTS interface. 00012 */ 00013 00014 #ifndef BLE_GATTS_H__ 00015 #define BLE_GATTS_H__ 00016 00017 #include "ble_types.h" 00018 #include "ble_ranges.h" 00019 #include "ble_l2cap.h" 00020 #include "ble_gap.h" 00021 #include "ble_gatt.h" 00022 #include "nrf_svc.h" 00023 00024 /** @addtogroup BLE_GATTS_ENUMERATIONS Enumerations 00025 * @{ */ 00026 00027 /** 00028 * @brief GATTS API SVC numbers. 00029 */ 00030 enum BLE_GATTS_SVCS 00031 { 00032 SD_BLE_GATTS_SERVICE_ADD = BLE_GATTS_SVC_BASE, /**< Add a service. */ 00033 SD_BLE_GATTS_INCLUDE_ADD, /**< Add an included service. */ 00034 SD_BLE_GATTS_CHARACTERISTIC_ADD, /**< Add a characteristic. */ 00035 SD_BLE_GATTS_DESCRIPTOR_ADD, /**< Add a generic attribute. */ 00036 SD_BLE_GATTS_VALUE_SET, /**< Set an attribute value. */ 00037 SD_BLE_GATTS_VALUE_GET, /**< Get an attribute value. */ 00038 SD_BLE_GATTS_HVX, /**< Handle Value Notification or Indication. */ 00039 SD_BLE_GATTS_SERVICE_CHANGED, /**< Perform a Service Changed Indication to one or more peers. */ 00040 SD_BLE_GATTS_RW_AUTHORIZE_REPLY, /**< Reply to an authorization request for a read or write operation on one or more attributes. */ 00041 SD_BLE_GATTS_SYS_ATTR_SET, /**< Set the persistent system attributes for a connection. */ 00042 SD_BLE_GATTS_SYS_ATTR_GET, /**< Get updated persistent system attributes after terminating a connection. */ 00043 }; 00044 00045 /** @} */ 00046 00047 /** @addtogroup BLE_GATTS_DEFINES Defines 00048 * @{ */ 00049 00050 /** @brief Only the default MTU size of 23 is currently supported. */ 00051 #define GATT_RX_MTU 23 00052 00053 /** @defgroup BLE_ERRORS_GATTS SVC return values specific to GATTS 00054 * @{ */ 00055 #define BLE_ERROR_GATTS_INVALID_ATTR_TYPE (NRF_GATTS_ERR_BASE + 0x000) /**< Invalid attribute type. */ 00056 #define BLE_ERROR_GATTS_SYS_ATTR_MISSING (NRF_GATTS_ERR_BASE + 0x001) /**< System Attributes missing. */ 00057 /** @} */ 00058 00059 /** @defgroup BLE_GATTS_ATTR_LENS_MAX Maximum attribute lengths 00060 * @{ */ 00061 #define BLE_GATTS_FIX_ATTR_LEN_MAX (510) /**< Maximum length for fixed length Attribute Values. */ 00062 #define BLE_GATTS_VAR_ATTR_LEN_MAX (512) /**< Maximum length for variable length Attribute Values. */ 00063 /** @} */ 00064 00065 /** @defgroup BLE_GATTS_SRVC_TYPES GATT Server Service Types 00066 * @{ */ 00067 #define BLE_GATTS_SRVC_TYPE_INVALID 0x00 /**< Invalid Service Type. */ 00068 #define BLE_GATTS_SRVC_TYPE_PRIMARY 0x01 /**< Primary Service. */ 00069 #define BLE_GATTS_SRVC_TYPE_SECONDARY 0x02 /**< Secondary Type. */ 00070 /** @} */ 00071 00072 00073 /** @defgroup BLE_GATTS_ATTR_TYPES GATT Server Attribute Types 00074 * @{ */ 00075 #define BLE_GATTS_ATTR_TYPE_INVALID 0x00 /**< Invalid Attribute Type. */ 00076 #define BLE_GATTS_ATTR_TYPE_PRIM_SRVC_DECL 0x01 /**< Primary Service Declaration. */ 00077 #define BLE_GATTS_ATTR_TYPE_SEC_SRVC_DECL 0x02 /**< Secondary Service Declaration. */ 00078 #define BLE_GATTS_ATTR_TYPE_INC_DECL 0x03 /**< Include Declaration. */ 00079 #define BLE_GATTS_ATTR_TYPE_CHAR_DECL 0x04 /**< Characteristic Declaration. */ 00080 #define BLE_GATTS_ATTR_TYPE_CHAR_VAL 0x05 /**< Characteristic Value. */ 00081 #define BLE_GATTS_ATTR_TYPE_DESC 0x06 /**< Descriptor. */ 00082 #define BLE_GATTS_ATTR_TYPE_OTHER 0x07 /**< Other, non-GATT specific type. */ 00083 /** @} */ 00084 00085 00086 /** @defgroup BLE_GATTS_OPS GATT Server Operations 00087 * @{ */ 00088 #define BLE_GATTS_OP_INVALID 0x00 /**< Invalid Operation. */ 00089 #define BLE_GATTS_OP_WRITE_REQ 0x01 /**< Write Request. */ 00090 #define BLE_GATTS_OP_WRITE_CMD 0x02 /**< Write Command. */ 00091 #define BLE_GATTS_OP_SIGN_WRITE_CMD 0x03 /**< Signed Write Command. */ 00092 #define BLE_GATTS_OP_PREP_WRITE_REQ 0x04 /**< Prepare Write Request. */ 00093 #define BLE_GATTS_OP_EXEC_WRITE_REQ_CANCEL 0x05 /**< Execute Write Request: Cancel all prepared writes. */ 00094 #define BLE_GATTS_OP_EXEC_WRITE_REQ_NOW 0x06 /**< Execute Write Request: Immediately execute all prepared writes. */ 00095 /** @} */ 00096 00097 /** @defgroup BLE_GATTS_VLOCS GATT Value Locations 00098 * @{ */ 00099 #define BLE_GATTS_VLOC_INVALID 0x00 /**< Invalid Location. */ 00100 #define BLE_GATTS_VLOC_STACK 0x01 /**< Attribute Value is located in stack memory, no user memory is required. */ 00101 #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 00102 will read and write directly to the memory using the pointer provided in the APIs. There are no alignment requirements for the buffer. */ 00103 /** @} */ 00104 00105 /** @defgroup BLE_GATTS_AUTHORIZE_TYPES GATT Server Authorization Types 00106 * @{ */ 00107 #define BLE_GATTS_AUTHORIZE_TYPE_INVALID 0x00 /**< Invalid Type. */ 00108 #define BLE_GATTS_AUTHORIZE_TYPE_READ 0x01 /**< Authorize a Read Operation. */ 00109 #define BLE_GATTS_AUTHORIZE_TYPE_WRITE 0x02 /**< Authorize a Write Request Operation. */ 00110 /** @} */ 00111 00112 00113 /** @} */ 00114 00115 /** @addtogroup BLE_GATTS_STRUCTURES Structures 00116 * @{ */ 00117 00118 /** 00119 * @brief BLE GATTS init options 00120 */ 00121 typedef struct 00122 { 00123 uint8_t service_changed:1; /**< Include the Service Changed characteristic in the local attributes. */ 00124 } ble_gatts_enable_params_t; 00125 00126 /**@brief Attribute metadata. */ 00127 typedef struct 00128 { 00129 ble_gap_conn_sec_mode_t read_perm; /**< Read permissions. */ 00130 ble_gap_conn_sec_mode_t write_perm; /**< Write permissions. */ 00131 uint8_t vlen :1; /**< Variable length attribute. */ 00132 uint8_t vloc :2; /**< Value location, see @ref BLE_GATTS_VLOCS.*/ 00133 uint8_t rd_auth :1; /**< Read Authorization and value will be requested from the application on every read operation. */ 00134 uint8_t wr_auth :1; /**< Write Authorization will be requested from the application on every Write Request operation (but not Write Command). */ 00135 } ble_gatts_attr_md_t; 00136 00137 00138 /**@brief GATT Attribute. */ 00139 typedef struct 00140 { 00141 ble_uuid_t* p_uuid; /**< Pointer to the attribute UUID. */ 00142 ble_gatts_attr_md_t* p_attr_md; /**< Pointer to the attribute metadata structure. */ 00143 uint16_t init_len; /**< Initial attribute value length in bytes. */ 00144 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. */ 00145 uint16_t max_len; /**< Maximum attribute value length in bytes, see @ref BLE_GATTS_ATTR_LENS_MAX for maximum values. */ 00146 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 00147 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. 00148 The stack may access that memory directly without the application's knowledge. */ 00149 } ble_gatts_attr_t; 00150 00151 00152 /**@brief GATT Attribute Context. */ 00153 typedef struct 00154 { 00155 ble_uuid_t srvc_uuid; /**< Service UUID. */ 00156 ble_uuid_t char_uuid; /**< Characteristic UUID if applicable (BLE_UUID_TYPE_UNKNOWN if N/A). */ 00157 ble_uuid_t desc_uuid; /**< Descriptor UUID if applicable (BLE_UUID_TYPE_UNKNOWN if N/A). */ 00158 uint16_t srvc_handle; /**< Service Handle. */ 00159 uint16_t value_handle; /**< Characteristic Handle if applicable (BLE_GATT_HANDLE_INVALID if N/A). */ 00160 uint8_t type; /**< Attribute Type, see @ref BLE_GATTS_ATTR_TYPES. */ 00161 } ble_gatts_attr_context_t; 00162 00163 00164 /**@brief GATT Characteristic Presentation Format. */ 00165 typedef struct 00166 { 00167 uint8_t format; /**< Format of the value, see @ref BLE_GATT_CPF_FORMATS. */ 00168 int8_t exponent; /**< Exponent for integer data types. */ 00169 uint16_t unit; /**< UUID from Bluetooth Assigned Numbers. */ 00170 uint8_t name_space; /**< Namespace from Bluetooth Assigned Numbers, see @ref BLE_GATT_CPF_NAMESPACES. */ 00171 uint16_t desc; /**< Namespace description from Bluetooth Assigned Numbers, see @ref BLE_GATT_CPF_NAMESPACES. */ 00172 } ble_gatts_char_pf_t; 00173 00174 00175 /**@brief GATT Characteristic metadata. */ 00176 typedef struct 00177 { 00178 ble_gatt_char_props_t char_props; /**< Characteristic Properties. */ 00179 ble_gatt_char_ext_props_t char_ext_props; /**< Characteristic Extended Properties. */ 00180 uint8_t* p_char_user_desc; /**< Pointer to a UTF-8, NULL if the descriptor is not required. */ 00181 uint16_t char_user_desc_max_size; /**< The maximum size in bytes of the user description descriptor. */ 00182 uint16_t char_user_desc_size; /**< The size of the user description, must be smaller or equal to char_user_desc_max_size. */ 00183 ble_gatts_char_pf_t* p_char_pf; /**< Pointer to a presentation format structure or NULL if the descriptor is not required. */ 00184 ble_gatts_attr_md_t* p_user_desc_md; /**< Attribute metadata for the User Description descriptor, or NULL for default values. */ 00185 ble_gatts_attr_md_t* p_cccd_md; /**< Attribute metadata for the Client Characteristic Configuration Descriptor, or NULL for default values. */ 00186 ble_gatts_attr_md_t* p_sccd_md; /**< Attribute metadata for the Server Characteristic Configuration Descriptor, or NULL for default values. */ 00187 } ble_gatts_char_md_t; 00188 00189 00190 /**@brief GATT Characteristic Definition Handles. */ 00191 typedef struct 00192 { 00193 uint16_t value_handle; /**< Handle to the characteristic value. */ 00194 uint16_t user_desc_handle; /**< Handle to the User Description descriptor, or BLE_GATT_HANDLE_INVALID if not present. */ 00195 uint16_t cccd_handle; /**< Handle to the Client Characteristic Configuration Descriptor, or BLE_GATT_HANDLE_INVALID if not present. */ 00196 uint16_t sccd_handle; /**< Handle to the Server Characteristic Configuration Descriptor, or BLE_GATT_HANDLE_INVALID if not present. */ 00197 } ble_gatts_char_handles_t; 00198 00199 00200 /**@brief GATT HVx parameters. */ 00201 typedef struct 00202 { 00203 uint16_t handle; /**< Characteristic Value Handle. */ 00204 uint8_t type; /**< Indication or Notification, see @ref BLE_GATT_HVX_TYPES. */ 00205 uint16_t offset; /**< Offset within the attribute value. */ 00206 uint16_t* p_len; /**< Length in bytes to be written, length in bytes written after successful return. */ 00207 uint8_t* p_data; /**< Actual data content, use NULL to use the current attribute value. */ 00208 } ble_gatts_hvx_params_t; 00209 00210 /**@brief GATT Read Authorization parameters. */ 00211 typedef struct 00212 { 00213 uint16_t gatt_status; /**< GATT status code for the operation, see @ref BLE_GATT_STATUS_CODES. */ 00214 uint8_t update : 1; /**< If set, data supplied in p_data will be used in the ATT response. */ 00215 uint16_t offset; /**< Offset of the attribute value being updated. */ 00216 uint16_t len; /**< Length in bytes of the value in p_data pointer, see @ref BLE_GATTS_ATTR_LENS_MAX. */ 00217 uint8_t* p_data; /**< Pointer to new value used to update the attribute value. */ 00218 } ble_gatts_read_authorize_params_t; 00219 00220 /**@brief GATT Write Authorisation parameters. */ 00221 typedef struct 00222 { 00223 uint16_t gatt_status; /**< GATT status code for the operation, see @ref BLE_GATT_STATUS_CODES. */ 00224 } ble_gatts_write_authorize_params_t; 00225 00226 /**@brief GATT Read or Write Authorize Reply parameters. */ 00227 typedef struct 00228 { 00229 uint8_t type; /**< Type of authorize operation, see @ref BLE_GATTS_AUTHORIZE_TYPES. */ 00230 union { 00231 ble_gatts_read_authorize_params_t read; /**< Read authorization parameters. */ 00232 ble_gatts_write_authorize_params_t write; /**< Write authorization parameters. */ 00233 } params; 00234 } ble_gatts_rw_authorize_reply_params_t; 00235 00236 00237 /** 00238 * @brief GATT Server Event IDs. 00239 */ 00240 enum BLE_GATTS_EVTS 00241 { 00242 BLE_GATTS_EVT_WRITE = BLE_GATTS_EVT_BASE, /**< Write operation performed. */ 00243 BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST, /**< Read/Write Authorization request. */ 00244 BLE_GATTS_EVT_SYS_ATTR_MISSING, /**< A persistent system attribute access is pending, awaiting a sd_ble_gatts_sys_attr_set(). */ 00245 BLE_GATTS_EVT_HVC, /**< Handle Value Confirmation. */ 00246 BLE_GATTS_EVT_SC_CONFIRM, /**< Service Changed Confirmation. */ 00247 BLE_GATTS_EVT_TIMEOUT /**< Timeout. */ 00248 }; 00249 00250 00251 /**@brief Event structure for BLE_GATTS_EVT_WRITE. */ 00252 typedef struct 00253 { 00254 uint16_t handle; /**< Attribute Handle. */ 00255 uint8_t op; /**< Type of write operation, see @ref BLE_GATTS_OPS. */ 00256 ble_gatts_attr_context_t context; /**< Attribute Context. */ 00257 uint16_t offset; /**< Offset for the write operation. */ 00258 uint16_t len; /**< Length of the incoming data. */ 00259 uint8_t data[1]; /**< Incoming data, variable length. */ 00260 } ble_gatts_evt_write_t; 00261 00262 /**@brief Event structure for authorize read request. */ 00263 typedef struct 00264 { 00265 uint16_t handle; /**< Attribute Handle. */ 00266 ble_gatts_attr_context_t context; /**< Attribute Context. */ 00267 uint16_t offset; /**< Offset for the read operation. */ 00268 } ble_gatts_evt_read_t; 00269 00270 /**@brief Event structure for BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST. */ 00271 typedef struct 00272 { 00273 uint8_t type; /**< Type of authorize operation, see @ref BLE_GATTS_AUTHORIZE_TYPES. */ 00274 union { 00275 ble_gatts_evt_read_t read; /**< Attribute Read Parameters. */ 00276 ble_gatts_evt_write_t write; /**< Attribute Write Parameters. */ 00277 } request; 00278 } ble_gatts_evt_rw_authorize_request_t; 00279 00280 /**@brief Event structure for BLE_GATTS_EVT_SYS_ATTR_MISSING. */ 00281 typedef struct 00282 { 00283 uint8_t hint; 00284 } ble_gatts_evt_sys_attr_missing_t; 00285 00286 00287 /**@brief Event structure for BLE_GATTS_EVT_HVC. */ 00288 typedef struct 00289 { 00290 uint16_t handle; /**< Attribute Handle. */ 00291 } ble_gatts_evt_hvc_t; 00292 00293 /**@brief Event structure for BLE_GATTS_EVT_TIMEOUT. */ 00294 typedef struct 00295 { 00296 uint8_t src; /**< Timeout source, see @ref BLE_GATT_TIMEOUT_SOURCES. */ 00297 } ble_gatts_evt_timeout_t; 00298 00299 00300 /**@brief GATT Server event callback event structure. */ 00301 typedef struct 00302 { 00303 uint16_t conn_handle; /**< Connection Handle on which event occurred. */ 00304 union 00305 { 00306 ble_gatts_evt_write_t write; /**< Write Event Parameters. */ 00307 ble_gatts_evt_rw_authorize_request_t authorize_request; /**< Read or Write Authorize Request Parameters. */ 00308 ble_gatts_evt_sys_attr_missing_t sys_attr_missing; /**< System attributes missing. */ 00309 ble_gatts_evt_hvc_t hvc; /**< Handle Value Confirmation Event Parameters. */ 00310 ble_gatts_evt_timeout_t timeout; /**< Timeout Event. */ 00311 } params; 00312 } ble_gatts_evt_t; 00313 00314 /** @} */ 00315 00316 /** @addtogroup BLE_GATTS_FUNCTIONS Functions 00317 * @{ */ 00318 00319 /**@brief Add a service declaration to the local server ATT table. 00320 * 00321 * @param[in] type Toggles between primary and secondary services, see @ref BLE_GATTS_SRVC_TYPES. 00322 * @param[in] p_uuid Pointer to service UUID. 00323 * @param[out] p_handle Pointer to a 16-bit word where the assigned handle will be stored. 00324 * 00325 * @note Secondary Services are only relevant in the context of the entity that references them, it is therefore forbidden to 00326 * add a secondary service declaration that is not referenced by another service later in the ATT table. 00327 * 00328 * @return @ref NRF_SUCCESS Successfully added a service declaration. 00329 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00330 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, Vendor Specific UUIDs need to be present in the table. 00331 * @return @ref NRF_ERROR_FORBIDDEN Forbidden value supplied, certain UUIDs are reserved for the stack. 00332 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation. 00333 */ 00334 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)); 00335 00336 00337 /**@brief Add an include declaration to the local server ATT table. 00338 * 00339 * @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). 00340 * 00341 * @note The included service must already be present in the ATT table prior to this call. 00342 * 00343 * @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. 00344 * @param[in] inc_srvc_handle Handle of the included service. 00345 * @param[out] p_include_handle Pointer to a 16-bit word where the assigned handle will be stored. 00346 * 00347 * @return @ref NRF_SUCCESS Successfully added an include declaration. 00348 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00349 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, handle values need to match previously added services. 00350 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation. 00351 * @return @ref NRF_ERROR_FORBIDDEN Forbidden value supplied, self inclusions are not allowed. 00352 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation. 00353 * @return @ref NRF_ERROR_NOT_FOUND Attribute not found. 00354 */ 00355 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)); 00356 00357 00358 /**@brief Add a characteristic declaration, a characteristic value declaration and optional characteristic descriptor declarations to the local server ATT table. 00359 * 00360 * @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). 00361 * 00362 * @note Several restrictions apply to the parameters, such as matching permissions between the user description descriptor and the writeable auxiliaries bits, 00363 * readable (no security) and writeable (selectable) CCCDs and SCCDs and valid presentation format values. 00364 * 00365 * @note If no metadata is provided for the optional descriptors, their permissions will be derived from the characteristic permissions. 00366 * 00367 * @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. 00368 * @param[in] p_char_md Characteristic metadata. 00369 * @param[in] p_attr_char_value Pointer to the attribute structure corresponding to the characteristic value. 00370 * @param[out] p_handles Pointer to the structure where the assigned handles will be stored. 00371 * 00372 * @return @ref NRF_SUCCESS Successfully added a characteristic. 00373 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00374 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, service handle, Vendor Specific UUIDs, lengths, and permissions need to adhere to the constraints. 00375 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation, a service context is required. 00376 * @return @ref NRF_ERROR_FORBIDDEN Forbidden value supplied, certain UUIDs are reserved for the stack. 00377 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation. 00378 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, attribute lengths are restricted by @ref BLE_GATTS_ATTR_LENS_MAX. 00379 */ 00380 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)); 00381 00382 00383 /**@brief Add a descriptor to the local server ATT table. 00384 * 00385 * @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). 00386 * 00387 * @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. 00388 * @param[in] p_attr Pointer to the attribute structure. 00389 * @param[out] p_handle Pointer to a 16-bit word where the assigned handle will be stored. 00390 * 00391 * @return @ref NRF_SUCCESS Successfully added a descriptor. 00392 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00393 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, characteristic handle, Vendor Specific UUIDs, lengths, and permissions need to adhere to the constraints. 00394 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation, a characteristic context is required. 00395 * @return @ref NRF_ERROR_FORBIDDEN Forbidden value supplied, certain UUIDs are reserved for the stack. 00396 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation. 00397 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, attribute lengths are restricted by @ref BLE_GATTS_ATTR_LENS_MAX. 00398 */ 00399 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)); 00400 00401 /**@brief Set the value of a given attribute. 00402 * 00403 * @param[in] handle Attribute handle. 00404 * @param[in] offset Offset in bytes to write from. 00405 * @param[in,out] p_len Length in bytes to be written, length in bytes written after successful return. 00406 * @param[in] p_value Pointer to a buffer (at least len bytes long) containing the desired attribute value. If value is stored in user memory, only the attribute length is updated when p_value == NULL. 00407 * 00408 * @return @ref NRF_SUCCESS Successfully set the value of the attribute. 00409 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00410 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied. 00411 * @return @ref NRF_ERROR_NOT_FOUND Attribute not found. 00412 * @return @ref NRF_ERROR_FORBIDDEN Forbidden handle supplied, certain attributes are not modifiable by the application. 00413 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, attribute lengths are restricted by @ref BLE_GATTS_ATTR_LENS_MAX. 00414 */ 00415 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)); 00416 00417 /**@brief Get the value of a given attribute. 00418 * 00419 * @param[in] handle Attribute handle. 00420 * @param[in] offset Offset in bytes to read from. 00421 * @param[in,out] p_len Length in bytes to be read, total length of attribute value (in bytes, starting from offset) after successful return. 00422 * @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. 00423 * 00424 * @note If the attribute value is longer than the size of the supplied buffer, 00425 * p_len will return the total attribute value length (excluding offset), 00426 * and not the number of bytes actually returned in p_data. 00427 * The application may use this information to allocate a suitable buffer size. 00428 * 00429 * @return @ref NRF_SUCCESS Successfully retrieved the value of the attribute. 00430 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00431 * @return @ref NRF_ERROR_NOT_FOUND Attribute not found. 00432 */ 00433 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)); 00434 00435 /**@brief Notify or Indicate an attribute value. 00436 * 00437 * @details This function checks for the relevant Client Characteristic Configuration descriptor value to verify that the relevant operation 00438 * (notification or indication) has been enabled by the client. It is also able to update the attribute value before issuing the PDU, so that 00439 * the application can atomically perform a value update and a server initiated transaction with a single API call. 00440 * 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 00441 * the peer. 00442 * 00443 * @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. 00444 * When receiveing the error codes @ref NRF_ERROR_INVALID_STATE, @ref NRF_ERROR_BUSY, @ref BLE_ERROR_GATTS_SYS_ATTR_MISSING and 00445 * @ref BLE_ERROR_NO_TX_BUFFERS the ATT table has been updated. 00446 * The caller can check whether the value has been updated by looking at the contents of *(p_hvx_params->p_len). 00447 * 00448 * @note It is important to note that a notification will <b>consume an application buffer</b>, and will therefore 00449 * generate a @ref BLE_EVT_TX_COMPLETE event when the packet has been transmitted. An indication on the other hand will use the 00450 * standard server internal buffer and thus will only generate a @ref BLE_GATTS_EVT_HVC event as soon as the confirmation 00451 * has been received from the peer. Please see the documentation of @ref sd_ble_tx_buffer_count_get for more details. 00452 * 00453 * @param[in] conn_handle Connection handle. 00454 * @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 00455 * the contents pointed by it before sending the notification or indication. 00456 * 00457 * @return @ref NRF_SUCCESS Successfully queued a notification or indication for transmission, and optionally updated the attribute value. 00458 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle. 00459 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00460 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied. 00461 * @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. 00462 * @return @ref BLE_ERROR_GATTS_INVALID_ATTR_TYPE Invalid attribute type(s) supplied, only characteristic values may be notified and indicated. 00463 * @return @ref NRF_ERROR_NOT_FOUND Attribute not found. 00464 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied. 00465 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation, notifications or indications must be enabled in the CCCD. 00466 * @return @ref NRF_ERROR_BUSY Procedure already in progress. 00467 * @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. 00468 * @return @ref BLE_ERROR_NO_TX_BUFFERS There are no available buffers to send the data, applies only to notifications. 00469 */ 00470 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)); 00471 00472 /**@brief Indicate the Service Changed attribute value. 00473 * 00474 * @details This call will send a Handle Value Indication to one or more peers connected to inform them that the attribute 00475 * table layout has changed. As soon as the peer has confirmed the indication, a @ref BLE_GATTS_EVT_SC_CONFIRM event will 00476 * be issued. 00477 * 00478 * @note Some of the restrictions and limitations that apply to @ref sd_ble_gatts_hvx also apply here. 00479 * 00480 * @param[in] conn_handle Connection handle. 00481 * @param[in] start_handle Start of affected attribute handle range. 00482 * @param[in] end_handle End of affected attribute handle range. 00483 * 00484 * @return @ref NRF_SUCCESS Successfully queued the Service Changed indication for transmission. 00485 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle. 00486 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied. 00487 * @return @ref BLE_ERROR_INVALID_ATTR_HANDLE Invalid attribute handle(s) supplied, handles must be in the range populated by the application. 00488 * @return @ref NRF_ERROR_INVALID_STATE Invalid state to perform operation, notifications or indications must be enabled in the CCCD. 00489 * @return @ref NRF_ERROR_BUSY Procedure already in progress. 00490 * @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. 00491 */ 00492 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)); 00493 00494 /**@brief Respond to a Read/Write authorization request. 00495 * 00496 * @note This call should only be used as a response to a @ref BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST event issued to the application. 00497 * 00498 * @param[in] conn_handle Connection handle. 00499 * @param[in] p_rw_authorize_reply_params Pointer to a structure with the attribute provided by the application. 00500 * 00501 * @return @ref NRF_SUCCESS Successfully queued a response to the peer, and in the case of a write operation, ATT table updated. 00502 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle. 00503 * @return @ref NRF_ERROR_INVALID_STATE No authorization request pending. 00504 * @return @ref NRF_ERROR_INVALID_PARAM Authorization op invalid, 00505 * or for Read Authorization reply: requested handles not replied with, 00506 * or for Write Authorization reply: handle supplied does not match requested handle. 00507 */ 00508 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)); 00509 00510 00511 /**@brief Update persistent system attribute information. 00512 * 00513 * @details Supply to the stack information about persistent system attributes. 00514 * This call is legal in the connected state only, and is usually 00515 * made immediately after a connection is established and the bond identified. 00516 * usually as a response to a BLE_GATTS_EVT_SYS_ATTR_MISSING. 00517 * 00518 * p_sysattrs may point directly to the application's stored copy of the struct. 00519 * If the pointer is NULL, the system attribute info is initialized, assuming that 00520 * the application does not have any previously saved data for this bond. 00521 * 00522 * @note The state of persistent system attributes is reset upon connection and then remembered for its duration. 00523 * 00524 * @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. 00525 * 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 00526 * reset the SoftDevice to return to a known state. 00527 * 00528 * @param[in] conn_handle Connection handle. 00529 * @param[in] p_sys_attr_data Pointer to a saved copy of system attributes supplied to the stack, or NULL. 00530 * @param[in] len Size of data pointed by p_sys_attr_data, in octets. 00531 * 00532 * @return @ref NRF_SUCCESS Successfully set the system attribute information. 00533 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle. 00534 * @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. 00535 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation. 00536 */ 00537 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)); 00538 00539 00540 /**@brief Retrieve persistent system attribute information from the stack. 00541 * 00542 * @details This call is used to retrieve information about values to be stored perisistently by the application 00543 * after a connection has been terminated. When a new connection is made to the same bond, the values 00544 * should be restored using @ref sd_ble_gatts_sys_attr_set. 00545 * The data should be read before any new advertising is started, or any new connection established. The connection handle for 00546 * the previous now defunct connection will remain valid until a new one is created to allow this API call to refer to it. 00547 * 00548 * @param[in] conn_handle Connection handle of the recently terminated connection. 00549 * @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 00550 * obtain the length of the data 00551 * @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. 00552 * 00553 * @return @ref NRF_SUCCESS Successfully retrieved the system attribute information. 00554 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle. 00555 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00556 * @return @ref NRF_ERROR_DATA_SIZE The system attribute information did not fit into the provided buffer. 00557 */ 00558 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)); 00559 00560 /** @} */ 00561 00562 #endif // BLE_GATTS_H__ 00563 00564 /** 00565 @} 00566 */
Generated on Tue Jul 12 2022 15:22:21 by 1.7.2