Ken Todotani / nRF51822

Nordic stack and drivers for the mbed BLE API

Dependents:   BLE_Health_Thermometer2

Fork of nRF51822 by Nordic Semiconductor

nordic/nrf-sdk/s110/ble.h@14:5ca08f962e4f, 2014-05-29 (annotated)

Committer:
Rohit Grover
Date:
Thu May 29 09:51:36 2014 +0100
Revision:
14:5ca08f962e4f
Parent:
0:eff01767de02
Child:
37:c29c330d942c
use accessors for GattCharacteristic

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:eff01767de02 1 /* Copyright (c) 2011 Nordic Semiconductor. All Rights Reserved.
bogdanm 0:eff01767de02 2 *
bogdanm 0:eff01767de02 3 * The information contained herein is confidential property of Nordic Semiconductor. The use,
bogdanm 0:eff01767de02 4 * copying, transfer or disclosure of such information is prohibited except by express written
bogdanm 0:eff01767de02 5 * agreement with Nordic Semiconductor.
bogdanm 0:eff01767de02 6 *
bogdanm 0:eff01767de02 7 */
bogdanm 0:eff01767de02 8 /**
bogdanm 0:eff01767de02 9 @addtogroup BLE_COMMON BLE SoftDevice Common
bogdanm 0:eff01767de02 10 @{
bogdanm 0:eff01767de02 11 @defgroup ble_api Events, type definitions and API calls
bogdanm 0:eff01767de02 12 @{
bogdanm 0:eff01767de02 13
bogdanm 0:eff01767de02 14 @brief Module independent events, type definitions and API calls for the S110 SoftDevice.
bogdanm 0:eff01767de02 15
bogdanm 0:eff01767de02 16 */
bogdanm 0:eff01767de02 17
bogdanm 0:eff01767de02 18 #ifndef BLE_H__
bogdanm 0:eff01767de02 19 #define BLE_H__
bogdanm 0:eff01767de02 20
bogdanm 0:eff01767de02 21 #include "nordic_global.h"
bogdanm 0:eff01767de02 22 #include "ble_ranges.h"
bogdanm 0:eff01767de02 23 #include "ble_types.h"
bogdanm 0:eff01767de02 24 #include "ble_gap.h"
bogdanm 0:eff01767de02 25 #include "ble_l2cap.h"
bogdanm 0:eff01767de02 26 #include "ble_gatt.h"
bogdanm 0:eff01767de02 27 #include "ble_gattc.h"
bogdanm 0:eff01767de02 28 #include "ble_gatts.h"
bogdanm 0:eff01767de02 29
bogdanm 0:eff01767de02 30 /**
bogdanm 0:eff01767de02 31 * @brief Common API SVC numbers.
bogdanm 0:eff01767de02 32 */
bogdanm 0:eff01767de02 33 enum BLE_COMMON_SVCS
bogdanm 0:eff01767de02 34 {
bogdanm 0:eff01767de02 35 SD_BLE_EVT_GET = BLE_SVC_BASE, /**< Get an event from the pending events queue. */
bogdanm 0:eff01767de02 36 SD_BLE_TX_BUFFER_COUNT_GET, /**< Get the total number of available application transmission buffers from the stack. */
bogdanm 0:eff01767de02 37 SD_BLE_UUID_VS_ADD, /**< Add a Vendor Specific UUID. */
bogdanm 0:eff01767de02 38 SD_BLE_UUID_DECODE, /**< Decode UUID bytes. */
bogdanm 0:eff01767de02 39 SD_BLE_UUID_ENCODE, /**< Encode UUID bytes. */
bogdanm 0:eff01767de02 40 SD_BLE_VERSION_GET, /**< Get the local version information (company id, LMP Version, LMP Subversion). */
bogdanm 0:eff01767de02 41 SD_BLE_USER_MEM_REPLY, /**< User Memory Reply. */
bogdanm 0:eff01767de02 42 };
bogdanm 0:eff01767de02 43
bogdanm 0:eff01767de02 44 /** @brief Required pointer alignment for BLE Events.
bogdanm 0:eff01767de02 45 */
bogdanm 0:eff01767de02 46 #define BLE_EVTS_PTR_ALIGNMENT 4
bogdanm 0:eff01767de02 47
bogdanm 0:eff01767de02 48 /** @defgroup BLE_USER_MEM_TYPES User Memory Types
bogdanm 0:eff01767de02 49 * @{ */
bogdanm 0:eff01767de02 50 #define BLE_USER_MEM_TYPE_INVALID 0x00 /**< Invalid User Memory Types. */
bogdanm 0:eff01767de02 51 #define BLE_USER_MEM_TYPE_GATTS_QUEUED_WRITES 0x01 /**< User Memory for GATTS queued writes. */
bogdanm 0:eff01767de02 52 /** @} */
bogdanm 0:eff01767de02 53
bogdanm 0:eff01767de02 54 /** @brief Maximum number of Vendor Specific UUIDs.
bogdanm 0:eff01767de02 55 */
bogdanm 0:eff01767de02 56 #define BLE_UUID_VS_MAX_COUNT 10
bogdanm 0:eff01767de02 57
bogdanm 0:eff01767de02 58 /**
bogdanm 0:eff01767de02 59 * @brief BLE Module Independent Event IDs.
bogdanm 0:eff01767de02 60 */
bogdanm 0:eff01767de02 61 enum BLE_COMMON_EVTS
bogdanm 0:eff01767de02 62 {
bogdanm 0:eff01767de02 63 BLE_EVT_TX_COMPLETE = BLE_EVT_BASE, /**< Transmission Complete. */
bogdanm 0:eff01767de02 64 BLE_EVT_USER_MEM_REQUEST, /**< User Memory request. */
bogdanm 0:eff01767de02 65 BLE_EVT_USER_MEM_RELEASE /**< User Memory release. */
bogdanm 0:eff01767de02 66 };
bogdanm 0:eff01767de02 67
bogdanm 0:eff01767de02 68 /**@brief User Memory Block. */
bogdanm 0:eff01767de02 69 typedef struct
bogdanm 0:eff01767de02 70 {
bogdanm 0:eff01767de02 71 uint8_t* p_mem; /**< Pointer to the start of the user memory block. */
bogdanm 0:eff01767de02 72 uint16_t len; /**< Length in bytes of the user memory block. */
bogdanm 0:eff01767de02 73 } ble_user_mem_block_t;
bogdanm 0:eff01767de02 74
bogdanm 0:eff01767de02 75 /**
bogdanm 0:eff01767de02 76 * @brief TX complete event.
bogdanm 0:eff01767de02 77 */
bogdanm 0:eff01767de02 78 typedef struct
bogdanm 0:eff01767de02 79 {
bogdanm 0:eff01767de02 80 uint8_t count; /**< Number of packets transmitted. */
bogdanm 0:eff01767de02 81 } ble_evt_tx_complete_t;
bogdanm 0:eff01767de02 82
bogdanm 0:eff01767de02 83 /**@brief Event structure for BLE_EVT_USER_MEM_REQUEST. */
bogdanm 0:eff01767de02 84 typedef struct
bogdanm 0:eff01767de02 85 {
bogdanm 0:eff01767de02 86 uint8_t type; /**< User memory type, see @ref BLE_USER_MEM_TYPES. */
bogdanm 0:eff01767de02 87 } ble_evt_user_mem_request_t;
bogdanm 0:eff01767de02 88
bogdanm 0:eff01767de02 89 /**@brief Event structure for BLE_EVT_USER_MEM_RELEASE. */
bogdanm 0:eff01767de02 90 typedef struct
bogdanm 0:eff01767de02 91 {
bogdanm 0:eff01767de02 92 uint8_t type; /**< User memory type, see @ref BLE_USER_MEM_TYPES. */
bogdanm 0:eff01767de02 93 ble_user_mem_block_t mem_block; /**< User memory block */
bogdanm 0:eff01767de02 94 } ble_evt_user_mem_release_t;
bogdanm 0:eff01767de02 95
bogdanm 0:eff01767de02 96
bogdanm 0:eff01767de02 97 /**@brief Event structure for events not associated with a specific function module. */
bogdanm 0:eff01767de02 98 typedef struct
bogdanm 0:eff01767de02 99 {
bogdanm 0:eff01767de02 100 uint16_t conn_handle; /**< Connection Handle on which this event occured. */
bogdanm 0:eff01767de02 101 union
bogdanm 0:eff01767de02 102 {
bogdanm 0:eff01767de02 103 ble_evt_tx_complete_t tx_complete; /**< Transmission Complete. */
bogdanm 0:eff01767de02 104 ble_evt_user_mem_request_t user_mem_request; /**< User Memory Request Event Parameters. */
bogdanm 0:eff01767de02 105 ble_evt_user_mem_release_t user_mem_release; /**< User Memory Release Event Parameters. */
bogdanm 0:eff01767de02 106 } params;
bogdanm 0:eff01767de02 107 } ble_common_evt_t;
bogdanm 0:eff01767de02 108
bogdanm 0:eff01767de02 109 /**@brief BLE Event header. */
bogdanm 0:eff01767de02 110 typedef struct
bogdanm 0:eff01767de02 111 {
bogdanm 0:eff01767de02 112 uint16_t evt_id; /**< Value from a BLE_<module>_EVT series. */
bogdanm 0:eff01767de02 113 uint16_t evt_len; /**< Length in octets excluding this header. */
bogdanm 0:eff01767de02 114 } ble_evt_hdr_t;
bogdanm 0:eff01767de02 115
bogdanm 0:eff01767de02 116 /**@brief Common BLE Event type, wrapping the module specific event reports. */
bogdanm 0:eff01767de02 117 typedef struct
bogdanm 0:eff01767de02 118 {
bogdanm 0:eff01767de02 119 ble_evt_hdr_t header; /**< Event header. */
bogdanm 0:eff01767de02 120 union
bogdanm 0:eff01767de02 121 {
bogdanm 0:eff01767de02 122 ble_common_evt_t common_evt; /**< Common Event, evt_id in BLE_EVT_* series. */
bogdanm 0:eff01767de02 123 ble_gap_evt_t gap_evt; /**< GAP originated event, evt_id in BLE_GAP_EVT_* series. */
bogdanm 0:eff01767de02 124 ble_l2cap_evt_t l2cap_evt; /**< L2CAP originated event, evt_id in BLE_L2CAP_EVT* series. */
bogdanm 0:eff01767de02 125 ble_gattc_evt_t gattc_evt; /**< GATT client originated event, evt_id in BLE_GATTC_EVT* series. */
bogdanm 0:eff01767de02 126 ble_gatts_evt_t gatts_evt; /**< GATT server originated event, evt_id in BLE_GATTS_EVT* series. */
bogdanm 0:eff01767de02 127 } evt;
bogdanm 0:eff01767de02 128 } ble_evt_t;
bogdanm 0:eff01767de02 129
bogdanm 0:eff01767de02 130
bogdanm 0:eff01767de02 131 /**
bogdanm 0:eff01767de02 132 * @brief Version Information.
bogdanm 0:eff01767de02 133 */
bogdanm 0:eff01767de02 134 typedef struct
bogdanm 0:eff01767de02 135 {
bogdanm 0:eff01767de02 136 uint8_t version_number; /**< LMP Version number for BT 4.0 spec is 6 (https://www.bluetooth.org/technical/assignednumbers/link_layer.htm). */
bogdanm 0:eff01767de02 137 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). */
bogdanm 0:eff01767de02 138 uint16_t subversion_number; /**< LMP Sub Version number corresponds to the SoftDevice Config ID. */
bogdanm 0:eff01767de02 139 } ble_version_t;
bogdanm 0:eff01767de02 140
bogdanm 0:eff01767de02 141
bogdanm 0:eff01767de02 142 /**@brief Get an event from the pending events queue.
bogdanm 0:eff01767de02 143 *
bogdanm 0:eff01767de02 144 * @param[in] 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>.
bogdanm 0:eff01767de02 145 * @param[in, out] p_len Pointer the length of the buffer, on return it is filled with the event length.
bogdanm 0:eff01767de02 146 *
bogdanm 0:eff01767de02 147 * @details This call allows the application to pull a BLE event from the BLE stack. The application is signalled that an event is
bogdanm 0:eff01767de02 148 * available from the BLE Stack by the triggering of the SD_EVT_IRQn interrupt (mapped to IRQ 22).
bogdanm 0:eff01767de02 149 * The application is free to choose whether to call this function from thread mode (main context) or directly from the Interrupt Service Routine
bogdanm 0:eff01767de02 150 * 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
bogdanm 0:eff01767de02 151 * 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 stack.
bogdanm 0:eff01767de02 152 * Failure to do so could potentially leave events in the internal queue without the application being aware of this fact.
bogdanm 0:eff01767de02 153 * 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
bogdanm 0:eff01767de02 154 * 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
bogdanm 0:eff01767de02 155 * and the application can then call again with a larger buffer size.
bogdanm 0:eff01767de02 156 * 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,
bogdanm 0:eff01767de02 157 * and so it is the application's responsability to provide an amount of memory large enough so that the relevant event is copied in full.
bogdanm 0:eff01767de02 158 * The application may "peek" the event length by providing p_dest as a NULL pointer and inspecting the value of *p_len upon return.
bogdanm 0:eff01767de02 159 *
bogdanm 0:eff01767de02 160 * @note The pointer supplied must be aligned to the extend defined by @ref BLE_EVTS_PTR_ALIGNMENT
bogdanm 0:eff01767de02 161 *
bogdanm 0:eff01767de02 162 * @return @ref NRF_SUCCESS Event pulled and stored into the supplied buffer.
bogdanm 0:eff01767de02 163 * @return @ref NRF_ERROR_INVALID_ADDR Invalid or not sufficiently aligned pointer supplied.
bogdanm 0:eff01767de02 164 * @return @ref NRF_ERROR_NOT_FOUND No events ready to be pulled.
bogdanm 0:eff01767de02 165 * @return @ref NRF_ERROR_DATA_SIZE Event ready but could not fit into the supplied buffer.
bogdanm 0:eff01767de02 166 */
bogdanm 0:eff01767de02 167 SVCALL(SD_BLE_EVT_GET, uint32_t, sd_ble_evt_get(uint8_t* p_dest, uint16_t *p_len));
bogdanm 0:eff01767de02 168
bogdanm 0:eff01767de02 169
bogdanm 0:eff01767de02 170 /**@brief Get the total number of available application transmission buffers in the BLE stack.
bogdanm 0:eff01767de02 171 *
bogdanm 0:eff01767de02 172 * @details This call allows the application to obtain the total number of
bogdanm 0:eff01767de02 173 * transmission buffers available for application data. Please note that
bogdanm 0:eff01767de02 174 * this does not give the number of free buffers, but rather the total amount of them.
bogdanm 0:eff01767de02 175 * The application has two options to handle its own application transmission buffers:
bogdanm 0:eff01767de02 176 * - Use a simple arithmetic calculation: at boot time the application should use this function
bogdanm 0:eff01767de02 177 * to find out the total amount of buffers available to it and store it in a variable.
bogdanm 0:eff01767de02 178 * Every time a packet that consumes an application buffer is sent using any of the
bogdanm 0:eff01767de02 179 * exposed functions in this BLE API, the application should decrement that variable.
bogdanm 0:eff01767de02 180 * Conversely, whenever a @ref BLE_EVT_TX_COMPLETE event is received by the application
bogdanm 0:eff01767de02 181 * it should retrieve the count field in such event and add that number to the same
bogdanm 0:eff01767de02 182 * variable storing the number of available packets.
bogdanm 0:eff01767de02 183 * This mechanism allows the application to be aware at any time of the number of
bogdanm 0:eff01767de02 184 * application packets available in the BLE stack's internal buffers, and therefore
bogdanm 0:eff01767de02 185 * it can know with certainty whether it is possible to send more data or it has to
bogdanm 0:eff01767de02 186 * wait for a @ref BLE_EVT_TX_COMPLETE event before it proceeds.
bogdanm 0:eff01767de02 187 * - Choose to simply not keep track of available buffers at all, and instead handle the
bogdanm 0:eff01767de02 188 * @ref BLE_ERROR_NO_TX_BUFFERS error by queueing the packet to be transmitted and
bogdanm 0:eff01767de02 189 * try again as soon as a @ref BLE_EVT_TX_COMPLETE event arrives.
bogdanm 0:eff01767de02 190 *
bogdanm 0:eff01767de02 191 * The API functions that <b>may</b> consume an application buffer depending on
bogdanm 0:eff01767de02 192 * the parameters supplied to them can be found below:
bogdanm 0:eff01767de02 193 *
bogdanm 0:eff01767de02 194 * - @ref sd_ble_gattc_write (write witout response only)
bogdanm 0:eff01767de02 195 * - @ref sd_ble_gatts_hvx (notifications only)
bogdanm 0:eff01767de02 196 * - @ref sd_ble_l2cap_tx (all packets)
bogdanm 0:eff01767de02 197 *
bogdanm 0:eff01767de02 198 * @param[out] p_count Pointer to a uint8_t which will contain the number of application transmission buffers upon
bogdanm 0:eff01767de02 199 * successful return.
bogdanm 0:eff01767de02 200 *
bogdanm 0:eff01767de02 201 * @return @ref NRF_SUCCESS Number of application transmission buffers retrieved successfully.
bogdanm 0:eff01767de02 202 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
bogdanm 0:eff01767de02 203 */
bogdanm 0:eff01767de02 204 SVCALL(SD_BLE_TX_BUFFER_COUNT_GET, uint32_t, sd_ble_tx_buffer_count_get(uint8_t* p_count));
bogdanm 0:eff01767de02 205
bogdanm 0:eff01767de02 206
bogdanm 0:eff01767de02 207 /**@brief Add a Vendor Specific UUID.
bogdanm 0:eff01767de02 208 *
bogdanm 0:eff01767de02 209 * @details This call enables the application to add a vendor specific UUID to the BLE stack's table,
bogdanm 0:eff01767de02 210 * for later use all other modules and APIs. This then allows the application to use the shorter,
bogdanm 0:eff01767de02 211 * 24-bit @ref ble_uuid_t format when dealing with both 16-bit and 128-bit UUIDs without having to
bogdanm 0:eff01767de02 212 * check for lengths and having split code paths. The way that this is accomplished is by extending the
bogdanm 0:eff01767de02 213 * grouping mechanism that the Bluetooth SIG standard base UUID uses for all other 128-bit UUIDs. The
bogdanm 0:eff01767de02 214 * type field in the @ref ble_uuid_t structure is an index (relative to @ref BLE_UUID_TYPE_VENDOR_BEGIN)
bogdanm 0:eff01767de02 215 * to the table populated by multiple calls to this function, and the uuid field in the same structure
bogdanm 0:eff01767de02 216 * contains the 2 bytes at indices 12 and 13. The number of possible 128-bit UUIDs available to the
bogdanm 0:eff01767de02 217 * application is therefore the number of Vendor Specific UUIDs added with the help of this function times 65536,
bogdanm 0:eff01767de02 218 * although restricted to modifying bytes 12 and 13 for each of the entries in the supplied array.
bogdanm 0:eff01767de02 219 *
bogdanm 0:eff01767de02 220 * @note Bytes 12 and 13 of the provided UUID will not be used internally, since those are always replaced by
bogdanm 0:eff01767de02 221 * the 16-bit uuid field in @ref ble_uuid_t.
bogdanm 0:eff01767de02 222 *
bogdanm 0:eff01767de02 223 *
bogdanm 0:eff01767de02 224 * @param[in] p_vs_uuid Pointer to a 16-octet (128-bit) little endian Vendor Specific UUID disregarding
bogdanm 0:eff01767de02 225 * bytes 12 and 13.
bogdanm 0:eff01767de02 226 * @param[out] p_uuid_type Pointer where the type field in @ref ble_uuid_t corresponding to this UUID will be stored.
bogdanm 0:eff01767de02 227 *
bogdanm 0:eff01767de02 228 * @return @ref NRF_SUCCESS Successfully added the Vendor Specific UUID.
bogdanm 0:eff01767de02 229 * @return @ref NRF_ERROR_INVALID_ADDR If p_vs_uuid or p_uuid_type is NULL or invalid.
bogdanm 0:eff01767de02 230 * @return @ref NRF_ERROR_NO_MEM If there are no more free slots for VS UUIDs.
bogdanm 0:eff01767de02 231 * @return @ref NRF_ERROR_FORBIDDEN If p_vs_uuid has already been added to the VS UUID table.
bogdanm 0:eff01767de02 232 */
bogdanm 0:eff01767de02 233 SVCALL(SD_BLE_UUID_VS_ADD, uint32_t, sd_ble_uuid_vs_add(ble_uuid128_t const * const p_vs_uuid, uint8_t * const p_uuid_type));
bogdanm 0:eff01767de02 234
bogdanm 0:eff01767de02 235
bogdanm 0:eff01767de02 236 /** @brief Decode little endian raw UUID bytes (16-bit or 128-bit) into a 24 bit @ref ble_uuid_t structure.
bogdanm 0:eff01767de02 237 *
bogdanm 0:eff01767de02 238 * @details The raw UUID bytes excluding bytes 12 and 13 (i.e. bytes 0-11 and 14-15) of p_uuid_le are compared
bogdanm 0:eff01767de02 239 * to the corresponding ones in each entry of the table of vendor specific UUIDs pouplated with @ref sd_ble_uuid_vs_add
bogdanm 0:eff01767de02 240 * to look for a match. If there is such a match, bytes 12 and 13 are returned as p_uuid->uuid and the index
bogdanm 0:eff01767de02 241 * relative to @ref BLE_UUID_TYPE_VENDOR_BEGIN as p_uuid->type.
bogdanm 0:eff01767de02 242 *
bogdanm 0:eff01767de02 243 * @note If the UUID length supplied is 2, then the type set by this call will always be @ref BLE_UUID_TYPE_BLE.
bogdanm 0:eff01767de02 244 *
bogdanm 0:eff01767de02 245 * @param[in] uuid_le_len Length in bytes of the buffer pointed to by p_uuid_le (must be 2 or 16 bytes).
bogdanm 0:eff01767de02 246 * @param[in] p_uuid_le Pointer pointing to little endian raw UUID bytes.
bogdanm 0:eff01767de02 247 * @param[in,out] p_uuid Pointer to a @ref ble_uuid_t structure to be filled in.
bogdanm 0:eff01767de02 248 *
bogdanm 0:eff01767de02 249 * @return @ref NRF_SUCCESS Successfully decoded into the @ref ble_uuid_t structure.
bogdanm 0:eff01767de02 250 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
bogdanm 0:eff01767de02 251 * @return @ref NRF_ERROR_INVALID_LENGTH Invalid UUID length.
bogdanm 0:eff01767de02 252 * @return @ref NRF_ERROR_NOT_FOUND For a 128-bit UUID, no match in the populated table of UUIDs.
bogdanm 0:eff01767de02 253 */
bogdanm 0:eff01767de02 254 SVCALL(SD_BLE_UUID_DECODE, uint32_t, sd_ble_uuid_decode(uint8_t uuid_le_len, uint8_t const * const p_uuid_le, ble_uuid_t * const p_uuid));
bogdanm 0:eff01767de02 255
bogdanm 0:eff01767de02 256
bogdanm 0:eff01767de02 257 /** @brief Encode a @ref ble_uuid_t structure into little endian raw UUID bytes (16-bit or 128-bit).
bogdanm 0:eff01767de02 258 *
bogdanm 0:eff01767de02 259 * @note The pointer to the destination buffer p_uuid_le may be NULL, in which case only the validitiy and size of p_uuid is computed.
bogdanm 0:eff01767de02 260 *
bogdanm 0:eff01767de02 261 * @param[in] p_uuid Pointer to a @ref ble_uuid_t structure that will be encoded into bytes.
bogdanm 0:eff01767de02 262 * @param[out] p_uuid_le_len Pointer to a uint8_t that will be filled with the encoded length (2 or 16 bytes).
bogdanm 0:eff01767de02 263 * @param[out] p_uuid_le Pointer to a buffer where the little endian raw UUID bytes (2 or 16) will be stored.
bogdanm 0:eff01767de02 264 *
bogdanm 0:eff01767de02 265 * @return @ref NRF_SUCCESS Successfully encoded into the buffer.
bogdanm 0:eff01767de02 266 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
bogdanm 0:eff01767de02 267 * @return @ref NRF_ERROR_INVALID_PARAM Invalid UUID type.
bogdanm 0:eff01767de02 268 */
bogdanm 0:eff01767de02 269 SVCALL(SD_BLE_UUID_ENCODE, uint32_t, sd_ble_uuid_encode(ble_uuid_t const * const p_uuid, uint8_t * const p_uuid_le_len, uint8_t * const p_uuid_le));
bogdanm 0:eff01767de02 270
bogdanm 0:eff01767de02 271
bogdanm 0:eff01767de02 272 /**@brief Get Version Information.
bogdanm 0:eff01767de02 273 *
bogdanm 0:eff01767de02 274 * @details This call allows the application to get the BLE stack version information.
bogdanm 0:eff01767de02 275 *
bogdanm 0:eff01767de02 276 * @param[in] p_version Pointer to ble_version_t structure to be filled in.
bogdanm 0:eff01767de02 277 *
bogdanm 0:eff01767de02 278 * @return @ref NRF_SUCCESS Version information stored successfully.
bogdanm 0:eff01767de02 279 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
bogdanm 0:eff01767de02 280 * @return @ref NRF_ERROR_BUSY The stack is busy (typically doing a locally-initiated disconnection procedure).
bogdanm 0:eff01767de02 281 */
bogdanm 0:eff01767de02 282 SVCALL(SD_BLE_VERSION_GET, uint32_t, sd_ble_version_get(ble_version_t * p_version));
bogdanm 0:eff01767de02 283
bogdanm 0:eff01767de02 284
bogdanm 0:eff01767de02 285 /**@brief Provide a user memory block.
bogdanm 0:eff01767de02 286 *
bogdanm 0:eff01767de02 287 * @note This call can only be used as a response to a @ref BLE_EVT_USER_MEM_REQUEST event issued to the application.
bogdanm 0:eff01767de02 288 *
bogdanm 0:eff01767de02 289 * @param[in] conn_handle Connection handle.
bogdanm 0:eff01767de02 290 * @param[in] p_block Pointer to a user memory block structure.
bogdanm 0:eff01767de02 291 *
bogdanm 0:eff01767de02 292 * @return @ref NRF_SUCCESS Successfully queued a response to the peer.
bogdanm 0:eff01767de02 293 * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
bogdanm 0:eff01767de02 294 * @return @ref NRF_ERROR_INVALID_STATE No execute write request pending.
bogdanm 0:eff01767de02 295 */
bogdanm 0:eff01767de02 296 SVCALL(SD_BLE_USER_MEM_REPLY, uint32_t, sd_ble_user_mem_reply(uint16_t conn_handle, ble_user_mem_block_t *p_block));
bogdanm 0:eff01767de02 297
bogdanm 0:eff01767de02 298 #endif /* BLE_H__ */
bogdanm 0:eff01767de02 299
bogdanm 0:eff01767de02 300 /**
bogdanm 0:eff01767de02 301 @}
bogdanm 0:eff01767de02 302 @}
bogdanm 0:eff01767de02 303 */