Lancaster University fork of the Nordic nrf51-SDK repository, which actually lives on github: https://github.com/lancaster-university/nrf51-sdk
ble.h
00001 /* 00002 * Copyright (c) Nordic Semiconductor ASA 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without modification, 00006 * are permitted provided that the following conditions are met: 00007 * 00008 * 1. Redistributions of source code must retain the above copyright notice, this 00009 * list of conditions and the following disclaimer. 00010 * 00011 * 2. Redistributions in binary form must reproduce the above copyright notice, this 00012 * list of conditions and the following disclaimer in the documentation and/or 00013 * other materials provided with the distribution. 00014 * 00015 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other 00016 * contributors to this software may be used to endorse or promote products 00017 * derived from this software without specific prior written permission. 00018 * 00019 * 00020 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 00021 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 00022 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00023 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR 00024 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 00025 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 00026 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 00027 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 00028 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00029 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00030 * 00031 */ 00032 00033 /** 00034 @addtogroup BLE_COMMON BLE SoftDevice Common 00035 @{ 00036 @defgroup ble_api Events, type definitions and API calls 00037 @{ 00038 00039 @brief Module independent events, type definitions and API calls for the BLE SoftDevice. 00040 00041 */ 00042 00043 #ifndef BLE_H__ 00044 #define BLE_H__ 00045 00046 #include "ble_ranges.h" 00047 #include "ble_types.h" 00048 #include "ble_gap.h" 00049 #include "ble_l2cap.h" 00050 #include "ble_gatt.h" 00051 #include "ble_gattc.h" 00052 #include "ble_gatts.h" 00053 00054 /** @addtogroup BLE_COMMON_ENUMERATIONS Enumerations 00055 * @{ */ 00056 00057 /** 00058 * @brief Common API SVC numbers. 00059 */ 00060 enum BLE_COMMON_SVCS 00061 { 00062 SD_BLE_ENABLE = BLE_SVC_BASE, /**< Enable and initialize the BLE stack */ 00063 SD_BLE_EVT_GET, /**< Get an event from the pending events queue. */ 00064 SD_BLE_TX_BUFFER_COUNT_GET, /**< Get the total number of available application transmission buffers from the BLE stack. */ 00065 SD_BLE_UUID_VS_ADD, /**< Add a Vendor Specific UUID. */ 00066 SD_BLE_UUID_DECODE, /**< Decode UUID bytes. */ 00067 SD_BLE_UUID_ENCODE, /**< Encode UUID bytes. */ 00068 SD_BLE_VERSION_GET, /**< Get the local version information (company id, Link Layer Version, Link Layer Subversion). */ 00069 SD_BLE_USER_MEM_REPLY, /**< User Memory Reply. */ 00070 SD_BLE_OPT_SET, /**< Set a BLE option. */ 00071 SD_BLE_OPT_GET, /**< Get a BLE option. */ 00072 }; 00073 00074 /** 00075 * @brief BLE Module Independent Event IDs. 00076 */ 00077 enum BLE_COMMON_EVTS 00078 { 00079 BLE_EVT_TX_COMPLETE = BLE_EVT_BASE, /**< Transmission Complete. @ref ble_evt_tx_complete_t */ 00080 BLE_EVT_USER_MEM_REQUEST, /**< User Memory request. @ref ble_evt_user_mem_request_t */ 00081 BLE_EVT_USER_MEM_RELEASE /**< User Memory release. @ref ble_evt_user_mem_release_t */ 00082 }; 00083 00084 /**@brief Common Option IDs. 00085 * IDs that uniquely identify a common option. 00086 */ 00087 enum BLE_COMMON_OPTS 00088 { 00089 BLE_COMMON_OPT_RADIO_CPU_MUTEX = BLE_OPT_BASE /**< Radio CPU mutex option. @ref ble_common_opt_radio_cpu_mutex_t */ 00090 }; 00091 /** @} */ 00092 00093 /** @addtogroup BLE_COMMON_DEFINES Defines 00094 * @{ */ 00095 00096 /** @brief Required pointer alignment for BLE Events. 00097 */ 00098 #define BLE_EVTS_PTR_ALIGNMENT 4 00099 00100 /** @defgroup BLE_USER_MEM_TYPES User Memory Types 00101 * @{ */ 00102 #define BLE_USER_MEM_TYPE_INVALID 0x00 /**< Invalid User Memory Types. */ 00103 #define BLE_USER_MEM_TYPE_GATTS_QUEUED_WRITES 0x01 /**< User Memory for GATTS queued writes. */ 00104 /** @} */ 00105 00106 /** @brief Maximum number of Vendor Specific UUIDs. 00107 */ 00108 #define BLE_UUID_VS_MAX_COUNT 10 00109 00110 /** @} */ 00111 00112 /** @addtogroup BLE_COMMON_STRUCTURES Structures 00113 * @{ */ 00114 00115 /**@brief User Memory Block. */ 00116 typedef struct 00117 { 00118 uint8_t *p_mem; /**< Pointer to the start of the user memory block. */ 00119 uint16_t len; /**< Length in bytes of the user memory block. */ 00120 } ble_user_mem_block_t; 00121 00122 /** 00123 * @brief Event structure for @ref BLE_EVT_TX_COMPLETE. 00124 */ 00125 typedef struct 00126 { 00127 uint8_t count; /**< Number of packets transmitted. */ 00128 } ble_evt_tx_complete_t; 00129 00130 /**@brief Event structure for @ref BLE_EVT_USER_MEM_REQUEST. */ 00131 typedef struct 00132 { 00133 uint8_t type; /**< User memory type, see @ref BLE_USER_MEM_TYPES. */ 00134 } ble_evt_user_mem_request_t; 00135 00136 /**@brief Event structure for @ref BLE_EVT_USER_MEM_RELEASE. */ 00137 typedef struct 00138 { 00139 uint8_t type; /**< User memory type, see @ref BLE_USER_MEM_TYPES. */ 00140 ble_user_mem_block_t mem_block; /**< User memory block */ 00141 } ble_evt_user_mem_release_t; 00142 00143 00144 /**@brief Event structure for events not associated with a specific function module. */ 00145 typedef struct 00146 { 00147 uint16_t conn_handle; /**< Connection Handle on which this event occurred. */ 00148 union 00149 { 00150 ble_evt_tx_complete_t tx_complete; /**< Transmission Complete. */ 00151 ble_evt_user_mem_request_t user_mem_request; /**< User Memory Request Event Parameters. */ 00152 ble_evt_user_mem_release_t user_mem_release; /**< User Memory Release Event Parameters. */ 00153 } params; 00154 } ble_common_evt_t; 00155 00156 /**@brief BLE Event header. */ 00157 typedef struct 00158 { 00159 uint16_t evt_id; /**< Value from a BLE_<module>_EVT series. */ 00160 uint16_t evt_len; /**< Length in octets excluding this header. */ 00161 } ble_evt_hdr_t; 00162 00163 /**@brief Common BLE Event type, wrapping the module specific event reports. */ 00164 typedef struct 00165 { 00166 ble_evt_hdr_t header; /**< Event header. */ 00167 union 00168 { 00169 ble_common_evt_t common_evt; /**< Common Event, evt_id in BLE_EVT_* series. */ 00170 ble_gap_evt_t gap_evt; /**< GAP originated event, evt_id in BLE_GAP_EVT_* series. */ 00171 ble_l2cap_evt_t l2cap_evt; /**< L2CAP originated event, evt_id in BLE_L2CAP_EVT* series. */ 00172 ble_gattc_evt_t gattc_evt; /**< GATT client originated event, evt_id in BLE_GATTC_EVT* series. */ 00173 ble_gatts_evt_t gatts_evt; /**< GATT server originated event, evt_id in BLE_GATTS_EVT* series. */ 00174 } evt; 00175 } ble_evt_t; 00176 00177 00178 /** 00179 * @brief Version Information. 00180 */ 00181 typedef struct 00182 { 00183 uint8_t version_number; /**< Link Layer Version number for BT 4.1 spec is 7 (https://www.bluetooth.org/en-us/specification/assigned-numbers/link-layer). */ 00184 uint16_t company_id; /**< Company ID, Nordic Semiconductor's company ID is 89 (0x0059) (https://www.bluetooth.org/apps/content/Default.aspx?doc_id=49708). */ 00185 uint16_t subversion_number; /**< Link Layer Sub Version number, corresponds to the SoftDevice Config ID or Firmware ID (FWID). */ 00186 } ble_version_t; 00187 00188 /**@brief Mutual exclusion of radio activity and CPU execution. 00189 * 00190 * This option configures the application's access to the CPU when the radio is active. The 00191 * application can configure itself to be blocked from using the CPU while the radio is 00192 * active. By default, the application will be able to share CPU time with the SoftDevice 00193 * during radio activity. This parameter structure is used together with @ref sd_ble_opt_set 00194 * to configure the @ref BLE_COMMON_OPT_RADIO_CPU_MUTEX option. 00195 * 00196 * @note Note that the application should use this option to configure the SoftDevice to block the 00197 * CPU during radio activity (i.e enable mutual exclusion) when running the SoftDevice on 00198 * hardware affected by PAN #44 "CCM may exceed real time requirements"and PAN #45 "AAR may 00199 * exceed real time requirements". 00200 * 00201 * @note Note that when acting as a scanner, the mutex is only enabled for radio TX activity. 00202 * 00203 * @note @ref sd_ble_opt_get is not supported for this option. 00204 * 00205 */ 00206 typedef struct 00207 { 00208 uint8_t enable : 1; /**< Enable mutual exclusion of radio activity and the CPU execution. */ 00209 } ble_common_opt_radio_cpu_mutex_t; 00210 00211 /**@brief Option structure for common options. */ 00212 typedef union 00213 { 00214 ble_common_opt_radio_cpu_mutex_t radio_cpu_mutex; /**< Parameters for the option for the mutual exclusion of radio activity and CPU execution. */ 00215 } ble_common_opt_t; 00216 00217 /**@brief Common BLE Option type, wrapping the module specific options. */ 00218 typedef union 00219 { 00220 ble_common_opt_t common_opt; /**< Common option, opt_id in BLE_COMMON_OPT_* series. */ 00221 ble_gap_opt_t gap_opt; /**< GAP option, opt_id in BLE_GAP_OPT_* series. */ 00222 } ble_opt_t; 00223 00224 /** 00225 * @brief BLE GATTS init options 00226 */ 00227 typedef struct 00228 { 00229 ble_gatts_enable_params_t gatts_enable_params; /**< GATTS init options @ref ble_gatts_enable_params_t. */ 00230 } ble_enable_params_t; 00231 00232 /** @} */ 00233 00234 /** @addtogroup BLE_COMMON_FUNCTIONS Functions 00235 * @{ */ 00236 00237 /**@brief Enable the BLE stack 00238 * 00239 * @param[in] p_ble_enable_params Pointer to ble_enable_params_t 00240 * 00241 * @details This call initializes the BLE stack, no other BLE related function can be called before this one. 00242 * 00243 * @return @ref NRF_SUCCESS BLE the BLE stack has been initialized successfully 00244 * @retval @ref NRF_ERROR_INVALID_STATE the BLE stack had already been initialized and cannot be reinitialized. 00245 * @return @ref NRF_ERROR_INVALID_ADDR Invalid or not sufficiently aligned pointer supplied. 00246 * @return @ref NRF_ERROR_INVALID_LENGTH The specified Attribute Table size is either too small or not a multiple of 4. 00247 * The minimum acceptable size is defined by @ref BLE_GATTS_ATTR_TAB_SIZE_MIN. 00248 * @return @ref NRF_ERROR_NO_MEM The Attribute Table size is too large. Decrease size in @ref ble_gatts_enable_params_t. 00249 */ 00250 SVCALL(SD_BLE_ENABLE, uint32_t, sd_ble_enable(ble_enable_params_t * p_ble_enable_params)); 00251 00252 /**@brief Get an event from the pending events queue. 00253 * 00254 * @param[out] p_dest Pointer to buffer to be filled in with an event, or NULL to retrieve the event length. This buffer <b>must be 4-byte aligned in memory</b>. 00255 * @param[in, out] p_len Pointer the length of the buffer, on return it is filled with the event length. 00256 * 00257 * @details This call allows the application to pull a BLE event from the BLE stack. The application is signalled that an event is 00258 * available from the BLE stack by the triggering of the SD_EVT_IRQn interrupt. 00259 * The application is free to choose whether to call this function from thread mode (main context) or directly from the Interrupt Service Routine 00260 * that maps to SD_EVT_IRQn. In any case however, and because the BLE stack runs at a higher priority than the application, this function should be called 00261 * in a loop (until @ref NRF_ERROR_NOT_FOUND is returned) every time SD_EVT_IRQn is raised to ensure that all available events are pulled from the BLE stack. 00262 * Failure to do so could potentially leave events in the internal queue without the application being aware of this fact. 00263 * Sizing the p_dest buffer is equally important, since the application needs to provide all the memory necessary for the event to be copied into 00264 * application memory. If the buffer provided is not large enough to fit the entire contents of the event, @ref NRF_ERROR_DATA_SIZE will be returned 00265 * and the application can then call again with a larger buffer size. 00266 * Please note that because of the variable length nature of some events, sizeof(ble_evt_t) will not always be large enough to fit certain events, 00267 * and so it is the application's responsibility to provide an amount of memory large enough so that the relevant event is copied in full. 00268 * The application may "peek" the event length by providing p_dest as a NULL pointer and inspecting the value of *p_len upon return. 00269 * 00270 * @note The pointer supplied must be aligned to the extend defined by @ref BLE_EVTS_PTR_ALIGNMENT 00271 * 00272 * @retval ::NRF_SUCCESS Event pulled and stored into the supplied buffer. 00273 * @retval ::NRF_ERROR_INVALID_ADDR Invalid or not sufficiently aligned pointer supplied. 00274 * @retval ::NRF_ERROR_NOT_FOUND No events ready to be pulled. 00275 * @retval ::NRF_ERROR_DATA_SIZE Event ready but could not fit into the supplied buffer. 00276 */ 00277 SVCALL(SD_BLE_EVT_GET, uint32_t, sd_ble_evt_get(uint8_t *p_dest, uint16_t *p_len)); 00278 00279 00280 /**@brief Get the total number of available application transmission buffers per link in the BLE stack. 00281 * 00282 * @details This call allows the application to obtain the total number of 00283 * transmission buffers available per link for application data. Please note that 00284 * this does not give the number of free buffers, but rather the total amount of them. 00285 * The application has two options to handle its own application transmission buffers: 00286 * - Use a simple arithmetic calculation: at boot time the application should use this function 00287 * to find out the total amount of buffers available to it and store it in a variable. 00288 * Every time a packet that consumes an application buffer is sent using any of the 00289 * exposed functions in this BLE API, the application should decrement that variable. 00290 * Conversely, whenever a @ref BLE_EVT_TX_COMPLETE event is received by the application 00291 * it should retrieve the count field in such event and add that number to the same 00292 * variable storing the number of available packets. 00293 * This mechanism allows the application to be aware at any time of the number of 00294 * application packets available in the BLE stack's internal buffers, and therefore 00295 * it can know with certainty whether it is possible to send more data or it has to 00296 * wait for a @ref BLE_EVT_TX_COMPLETE event before it proceeds. 00297 * - Choose to simply not keep track of available buffers at all, and instead handle the 00298 * @ref BLE_ERROR_NO_TX_BUFFERS error by queueing the packet to be transmitted and 00299 * try again as soon as a @ref BLE_EVT_TX_COMPLETE event arrives. 00300 * 00301 * The API functions that <b>may</b> consume an application buffer depending on 00302 * the parameters supplied to them can be found below: 00303 * 00304 * - @ref sd_ble_gattc_write (write without response only) 00305 * - @ref sd_ble_gatts_hvx (notifications only) 00306 * - @ref sd_ble_l2cap_tx (all packets) 00307 * 00308 * @param[out] p_count Pointer to a uint8_t which will contain the number of application transmission buffers upon 00309 * successful return. 00310 * 00311 * @retval ::NRF_SUCCESS Number of application transmission buffers retrieved successfully. 00312 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00313 */ 00314 SVCALL(SD_BLE_TX_BUFFER_COUNT_GET, uint32_t, sd_ble_tx_buffer_count_get(uint8_t *p_count)); 00315 00316 00317 /**@brief Add a Vendor Specific UUID. 00318 * 00319 * @details This call enables the application to add a vendor specific UUID to the BLE stack's table, 00320 * for later use all other modules and APIs. This then allows the application to use the shorter, 00321 * 24-bit @ref ble_uuid_t format when dealing with both 16-bit and 128-bit UUIDs without having to 00322 * check for lengths and having split code paths. The way that this is accomplished is by extending the 00323 * grouping mechanism that the Bluetooth SIG standard base UUID uses for all other 128-bit UUIDs. The 00324 * type field in the @ref ble_uuid_t structure is an index (relative to @ref BLE_UUID_TYPE_VENDOR_BEGIN) 00325 * to the table populated by multiple calls to this function, and the uuid field in the same structure 00326 * contains the 2 bytes at indices 12 and 13. The number of possible 128-bit UUIDs available to the 00327 * application is therefore the number of Vendor Specific UUIDs added with the help of this function times 65536, 00328 * although restricted to modifying bytes 12 and 13 for each of the entries in the supplied array. 00329 * 00330 * @note Bytes 12 and 13 of the provided UUID will not be used internally, since those are always replaced by 00331 * the 16-bit uuid field in @ref ble_uuid_t. 00332 * 00333 * 00334 * @param[in] p_vs_uuid Pointer to a 16-octet (128-bit) little endian Vendor Specific UUID disregarding 00335 * bytes 12 and 13. 00336 * @param[out] p_uuid_type Pointer to a uint8_t where the type field in @ref ble_uuid_t corresponding to this UUID will be stored. 00337 * 00338 * @retval ::NRF_SUCCESS Successfully added the Vendor Specific UUID. 00339 * @retval ::NRF_ERROR_INVALID_ADDR If p_vs_uuid or p_uuid_type is NULL or invalid. 00340 * @retval ::NRF_ERROR_NO_MEM If there are no more free slots for VS UUIDs. 00341 * @retval ::NRF_ERROR_FORBIDDEN If p_vs_uuid has already been added to the VS UUID table. 00342 */ 00343 SVCALL(SD_BLE_UUID_VS_ADD, uint32_t, sd_ble_uuid_vs_add(ble_uuid128_t const *p_vs_uuid, uint8_t *p_uuid_type)); 00344 00345 00346 /** @brief Decode little endian raw UUID bytes (16-bit or 128-bit) into a 24 bit @ref ble_uuid_t structure. 00347 * 00348 * @details The raw UUID bytes excluding bytes 12 and 13 (i.e. bytes 0-11 and 14-15) of p_uuid_le are compared 00349 * to the corresponding ones in each entry of the table of vendor specific UUIDs populated with @ref sd_ble_uuid_vs_add 00350 * to look for a match. If there is such a match, bytes 12 and 13 are returned as p_uuid->uuid and the index 00351 * relative to @ref BLE_UUID_TYPE_VENDOR_BEGIN as p_uuid->type. 00352 * 00353 * @note If the UUID length supplied is 2, then the type set by this call will always be @ref BLE_UUID_TYPE_BLE. 00354 * 00355 * @param[in] uuid_le_len Length in bytes of the buffer pointed to by p_uuid_le (must be 2 or 16 bytes). 00356 * @param[in] p_uuid_le Pointer pointing to little endian raw UUID bytes. 00357 * @param[out] p_uuid Pointer to a @ref ble_uuid_t structure to be filled in. 00358 * 00359 * @retval ::NRF_SUCCESS Successfully decoded into the @ref ble_uuid_t structure. 00360 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00361 * @retval ::NRF_ERROR_INVALID_LENGTH Invalid UUID length. 00362 * @retval ::NRF_ERROR_NOT_FOUND For a 128-bit UUID, no match in the populated table of UUIDs. 00363 */ 00364 SVCALL(SD_BLE_UUID_DECODE, uint32_t, sd_ble_uuid_decode(uint8_t uuid_le_len, uint8_t const *p_uuid_le, ble_uuid_t *p_uuid)); 00365 00366 00367 /** @brief Encode a @ref ble_uuid_t structure into little endian raw UUID bytes (16-bit or 128-bit). 00368 * 00369 * @note The pointer to the destination buffer p_uuid_le may be NULL, in which case only the validity and size of p_uuid is computed. 00370 * 00371 * @param[in] p_uuid Pointer to a @ref ble_uuid_t structure that will be encoded into bytes. 00372 * @param[out] p_uuid_le_len Pointer to a uint8_t that will be filled with the encoded length (2 or 16 bytes). 00373 * @param[out] p_uuid_le Pointer to a buffer where the little endian raw UUID bytes (2 or 16) will be stored. 00374 * 00375 * @retval ::NRF_SUCCESS Successfully encoded into the buffer. 00376 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00377 * @retval ::NRF_ERROR_INVALID_PARAM Invalid UUID type. 00378 */ 00379 SVCALL(SD_BLE_UUID_ENCODE, uint32_t, sd_ble_uuid_encode(ble_uuid_t const *p_uuid, uint8_t *p_uuid_le_len, uint8_t *p_uuid_le)); 00380 00381 00382 /**@brief Get Version Information. 00383 * 00384 * @details This call allows the application to get the BLE stack version information. 00385 * 00386 * @param[out] p_version Pointer to a ble_version_t structure to be filled in. 00387 * 00388 * @retval ::NRF_SUCCESS Version information stored successfully. 00389 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00390 * @retval ::NRF_ERROR_BUSY The BLE stack is busy (typically doing a locally-initiated disconnection procedure). 00391 */ 00392 SVCALL(SD_BLE_VERSION_GET, uint32_t, sd_ble_version_get(ble_version_t *p_version)); 00393 00394 00395 /**@brief Provide a user memory block. 00396 * 00397 * @note This call can only be used as a response to a @ref BLE_EVT_USER_MEM_REQUEST event issued to the application. 00398 * 00399 * @param[in] conn_handle Connection handle. 00400 * @param[in,out] p_block Pointer to a user memory block structure. 00401 * 00402 * @retval ::NRF_SUCCESS Successfully queued a response to the peer. 00403 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle. 00404 * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection state or no execute write request pending. 00405 * @retval ::NRF_ERROR_BUSY The BLE stack is busy. Retry at later time. 00406 */ 00407 SVCALL(SD_BLE_USER_MEM_REPLY, uint32_t, sd_ble_user_mem_reply(uint16_t conn_handle, ble_user_mem_block_t const *p_block)); 00408 00409 /**@brief Set a BLE option. 00410 * 00411 * @details This call allows the application to set the value of an option. 00412 * 00413 * @param[in] opt_id Option ID. 00414 * @param[in] p_opt Pointer to a ble_opt_t structure containing the option value. 00415 * 00416 * @retval ::NRF_SUCCESS Option set successfully. 00417 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00418 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle. 00419 * @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, check parameter limits and constraints. 00420 * @retval ::NRF_ERROR_INVALID_STATE Unable to set the parameter at this time. 00421 * @retval ::NRF_ERROR_BUSY The BLE stack is busy or the previous procedure has not completed. 00422 */ 00423 SVCALL(SD_BLE_OPT_SET, uint32_t, sd_ble_opt_set(uint32_t opt_id, ble_opt_t const *p_opt)); 00424 00425 00426 /**@brief Get a BLE option. 00427 * 00428 * @details This call allows the application to retrieve the value of an option. 00429 * 00430 * @param[in] opt_id Option ID. 00431 * @param[out] p_opt Pointer to a ble_opt_t structure to be filled in. 00432 * 00433 * @retval ::NRF_SUCCESS Option retrieved successfully. 00434 * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied. 00435 * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle. 00436 * @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, check parameter limits and constraints. 00437 * @retval ::NRF_ERROR_INVALID_STATE Unable to retrieve the parameter at this time. 00438 * @retval ::NRF_ERROR_BUSY The BLE stack is busy or the previous procedure has not completed. 00439 * @retval ::NRF_ERROR_NOT_SUPPORTED This option is not supported. 00440 * 00441 */ 00442 SVCALL(SD_BLE_OPT_GET, uint32_t, sd_ble_opt_get(uint32_t opt_id, ble_opt_t *p_opt)); 00443 00444 /** @} */ 00445 00446 #endif /* BLE_H__ */ 00447 00448 /** 00449 @} 00450 @} 00451 */
Generated on Tue Jul 12 2022 15:07:13 by 1.7.2