vo dung / Mbed 2 deprecated ibeacon

project for nrf51822 qfab

Dependencies:   eddystone_URL mbed

Fork of eddystone_URL by vo dung

nRF51822/nordic/nrf-sdk/s110/ble.h@0:76dfa9657d9d, 2014-11-12 (annotated)

Committer:
jksoft
Date:
Wed Nov 12 02:40:34 2014 +0000
Revision:
0:76dfa9657d9d
????????

Who changed what in which revision?

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