Junichi Katsu / nRF51822

テスト用

Fork of nRF51822 by Nordic Semiconductor

nordic/nrf-sdk/s110/ble.h@69:936d81c963fe, 2014-09-26 (annotated)

Committer:
Rohit Grover
Date:
Fri Sep 26 14:46:19 2014 +0100
Revision:
69:936d81c963fe
Parent:
56:a1071b629aa3 
Release 0.2.1

=============



Features

~~~~~~~~



- Turn on the service-changed characteristic by default.



Bugfixes

~~~~~~~~



- Raised the maximum number of supported characteristics/descriptors to 24

  (was 10 previously). We're beginning to find services like Device-

  Information with several characteristics populated.



Compatibility

~~~~~~~~~~~~~



Works with 0.2.0 of BLE_API.

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