ble.h

00001 /* Copyright (c) 2011 Nordic Semiconductor. All Rights Reserved.
00002  *
00003  * The information contained herein is confidential property of Nordic Semiconductor. The use,
00004  * copying, transfer or disclosure of such information is prohibited except by express written
00005  * agreement with Nordic Semiconductor.
00006  *
00007  */
00008 /**
00009   @addtogroup BLE_COMMON BLE SoftDevice Common
00010   @{
00011   @defgroup ble_api Events, type definitions and API calls
00012   @{
00013 
00014   @brief Module independent events, type definitions and API calls for the S110 SoftDevice.
00015 
00016  */
00017 
00018 #ifndef BLE_H__
00019 #define BLE_H__
00020 
00021 #include "ble_ranges.h"
00022 #include "ble_types.h"
00023 #include "ble_gap.h"
00024 #include "ble_l2cap.h"
00025 #include "ble_gatt.h"
00026 #include "ble_gattc.h"
00027 #include "ble_gatts.h"
00028 
00029 /** @addtogroup BLE_COMMON_ENUMERATIONS Enumerations
00030  * @{ */
00031 
00032 /**
00033  * @brief Common API SVC numbers.
00034  */
00035 enum BLE_COMMON_SVCS
00036 {
00037   SD_BLE_ENABLE = BLE_SVC_BASE,         /**< Enable and initialize the BLE stack */
00038   SD_BLE_EVT_GET,                       /**< Get an event from the pending events queue. */
00039   SD_BLE_TX_BUFFER_COUNT_GET,           /**< Get the total number of available application transmission buffers from the stack. */
00040   SD_BLE_UUID_VS_ADD,                   /**< Add a Vendor Specific UUID. */
00041   SD_BLE_UUID_DECODE,                   /**< Decode UUID bytes. */
00042   SD_BLE_UUID_ENCODE,                   /**< Encode UUID bytes. */
00043   SD_BLE_VERSION_GET,                   /**< Get the local version information (company id, Link Layer Version, Link Layer Subversion). */
00044   SD_BLE_USER_MEM_REPLY,                /**< User Memory Reply. */
00045   SD_BLE_OPT_SET,                       /**< Set a BLE option. */
00046   SD_BLE_OPT_GET,                       /**< Get a BLE option. */
00047 };
00048 
00049 /** @} */
00050 
00051 /** @addtogroup BLE_COMMON_DEFINES Defines
00052  * @{ */
00053 
00054 /** @brief  Required pointer alignment for BLE Events.
00055 */
00056 #define BLE_EVTS_PTR_ALIGNMENT    4
00057 
00058 /** @defgroup BLE_USER_MEM_TYPES User Memory Types
00059  * @{ */
00060 #define BLE_USER_MEM_TYPE_INVALID               0x00  /**< Invalid User Memory Types. */
00061 #define BLE_USER_MEM_TYPE_GATTS_QUEUED_WRITES   0x01  /**< User Memory for GATTS queued writes. */
00062 /** @} */
00063 
00064 /** @brief  Maximum number of Vendor Specific UUIDs.
00065 */
00066 #define BLE_UUID_VS_MAX_COUNT     10
00067 
00068 /** @} */
00069 
00070 /** @addtogroup BLE_COMMON_STRUCTURES Structures
00071  * @{ */
00072 
00073 /**
00074  * @brief BLE Module Independent Event IDs.
00075  */
00076 enum BLE_COMMON_EVTS
00077 {
00078   BLE_EVT_TX_COMPLETE  = BLE_EVT_BASE,  /**< Transmission Complete. */
00079   BLE_EVT_USER_MEM_REQUEST,             /**< User Memory request. */
00080   BLE_EVT_USER_MEM_RELEASE              /**< User Memory release. */
00081 };
00082 
00083 /**@brief User Memory Block. */
00084 typedef struct
00085 {
00086   uint8_t*          p_mem;      /**< Pointer to the start of the user memory block. */
00087   uint16_t          len;        /**< Length in bytes of the user memory block. */
00088 } ble_user_mem_block_t;
00089 
00090 /**
00091  * @brief TX complete event.
00092  */
00093 typedef struct
00094 {
00095   uint8_t count;                        /**< Number of packets transmitted. */
00096 } ble_evt_tx_complete_t;
00097 
00098 /**@brief Event structure for BLE_EVT_USER_MEM_REQUEST. */
00099 typedef struct
00100 {
00101   uint8_t                     type;     /**< User memory type, see @ref BLE_USER_MEM_TYPES. */
00102 } ble_evt_user_mem_request_t;
00103 
00104 /**@brief Event structure for BLE_EVT_USER_MEM_RELEASE. */
00105 typedef struct
00106 {
00107   uint8_t                     type;       /**< User memory type, see @ref BLE_USER_MEM_TYPES. */
00108   ble_user_mem_block_t        mem_block;  /**< User memory block */
00109 } ble_evt_user_mem_release_t;
00110 
00111 
00112 /**@brief Event structure for events not associated with a specific function module. */
00113 typedef struct
00114 {
00115   uint16_t conn_handle;                 /**< Connection Handle on which this event occured. */
00116   union
00117   {
00118     ble_evt_tx_complete_t           tx_complete;        /**< Transmission Complete. */
00119     ble_evt_user_mem_request_t      user_mem_request;   /**< User Memory Request Event Parameters. */
00120     ble_evt_user_mem_release_t      user_mem_release;   /**< User Memory Release Event Parameters. */
00121   } params;
00122 } ble_common_evt_t;
00123 
00124 /**@brief BLE Event header. */
00125 typedef struct
00126 {
00127   uint16_t evt_id;                      /**< Value from a BLE_<module>_EVT series. */
00128   uint16_t evt_len;                     /**< Length in octets excluding this header. */
00129 } ble_evt_hdr_t;
00130 
00131 /**@brief Common BLE Event type, wrapping the module specific event reports. */
00132 typedef struct
00133 {
00134   ble_evt_hdr_t header;                 /**< Event header. */
00135   union
00136   {
00137     ble_common_evt_t  common_evt;         /**< Common Event, evt_id in BLE_EVT_* series. */
00138     ble_gap_evt_t     gap_evt;            /**< GAP originated event, evt_id in BLE_GAP_EVT_* series. */
00139     ble_l2cap_evt_t   l2cap_evt;          /**< L2CAP originated event, evt_id in BLE_L2CAP_EVT* series. */
00140     ble_gattc_evt_t   gattc_evt;          /**< GATT client originated event, evt_id in BLE_GATTC_EVT* series. */
00141     ble_gatts_evt_t   gatts_evt;          /**< GATT server originated event, evt_id in BLE_GATTS_EVT* series. */
00142   } evt;
00143 } ble_evt_t;
00144 
00145 
00146 /**
00147  * @brief Version Information.
00148  */
00149 typedef struct
00150 {
00151   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). */
00152   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). */
00153   uint16_t  subversion_number;          /**< Link Layer Sub Version number, corresponds to the SoftDevice Config ID or Firmware ID (FWID). */
00154 } ble_version_t;
00155 
00156 /**@brief Common BLE Option type, wrapping the module specific options. */
00157 typedef union
00158 {
00159   ble_gap_opt_t     gap;            /**< GAP option, opt_id in BLE_GAP_OPT_* series. */
00160 } ble_opt_t;
00161 
00162 /**
00163  * @brief BLE GATTS init options
00164  */
00165 typedef struct
00166 {
00167   ble_gatts_enable_params_t  gatts_enable_params; /**< GATTS init options @ref ble_gatts_enable_params_t. */
00168 } ble_enable_params_t;
00169 
00170 /** @} */
00171 
00172 /** @addtogroup BLE_COMMON_FUNCTIONS Functions
00173  * @{ */
00174 
00175 /**@brief Enable the bluetooth stack
00176  *
00177  * @param[in] p_ble_enable_params Pointer to ble_enable_params_t
00178  *
00179  * @details This call initializes the bluetooth stack, no other BLE related call can be called before this one has been executed.
00180  *
00181  * @return @ref NRF_SUCCESS BLE stack has been initialized successfully
00182  * @return @ref NRF_ERROR_INVALID_ADDR Invalid or not sufficiently aligned pointer supplied.
00183  */
00184 SVCALL(SD_BLE_ENABLE, uint32_t, sd_ble_enable(ble_enable_params_t * p_ble_enable_params));
00185 
00186 /**@brief Get an event from the pending events queue.
00187  *
00188  * @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>.
00189  * @param[in, out] p_len Pointer the length of the buffer, on return it is filled with the event length.
00190  *
00191  * @details This call allows the application to pull a BLE event from the BLE stack. The application is signalled that an event is
00192  * available from the BLE Stack by the triggering of the SD_EVT_IRQn interrupt (mapped to IRQ 22).
00193  * The application is free to choose whether to call this function from thread mode (main context) or directly from the Interrupt Service Routine
00194  * 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
00195  * 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.
00196  * Failure to do so could potentially leave events in the internal queue without the application being aware of this fact.
00197  * 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
00198  * 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
00199  * and the application can then call again with a larger buffer size.
00200  * 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,
00201  * 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.
00202  * The application may "peek" the event length by providing p_dest as a NULL pointer and inspecting the value of *p_len upon return.
00203  *
00204  * @note The pointer supplied must be aligned to the extend defined by @ref BLE_EVTS_PTR_ALIGNMENT
00205  *
00206  * @return @ref NRF_SUCCESS Event pulled and stored into the supplied buffer.
00207  * @return @ref NRF_ERROR_INVALID_ADDR Invalid or not sufficiently aligned pointer supplied.
00208  * @return @ref NRF_ERROR_NOT_FOUND No events ready to be pulled.
00209  * @return @ref NRF_ERROR_DATA_SIZE Event ready but could not fit into the supplied buffer.
00210  */
00211 SVCALL(SD_BLE_EVT_GET, uint32_t, sd_ble_evt_get(uint8_t* p_dest, uint16_t *p_len));
00212 
00213 
00214 /**@brief Get the total number of available application transmission buffers in the BLE stack.
00215  *
00216  * @details This call allows the application to obtain the total number of
00217  *          transmission buffers available for application data. Please note that
00218  *          this does not give the number of free buffers, but rather the total amount of them.
00219  *          The application has two options to handle its own application transmission buffers:
00220  *          - Use a simple arithmetic calculation: at boot time the application should use this function
00221  *          to find out the total amount of buffers available to it and store it in a variable.
00222  *          Every time a packet that consumes an application buffer is sent using any of the
00223  *          exposed functions in this BLE API, the application should decrement that variable.
00224  *          Conversely, whenever a @ref BLE_EVT_TX_COMPLETE event is received by the application
00225  *          it should retrieve the count field in such event and add that number to the same
00226  *          variable storing the number of available packets.
00227  *          This mechanism allows the application to be aware at any time of the number of
00228  *          application packets available in the BLE stack's internal buffers, and therefore
00229  *          it can know with certainty whether it is possible to send more data or it has to
00230  *          wait for a @ref BLE_EVT_TX_COMPLETE event before it proceeds.
00231  *          - Choose to simply not keep track of available buffers at all, and instead handle the
00232  *          @ref BLE_ERROR_NO_TX_BUFFERS error by queueing the packet to be transmitted and
00233  *          try again as soon as a @ref BLE_EVT_TX_COMPLETE event arrives.
00234  *
00235  *          The API functions that <b>may</b> consume an application buffer depending on
00236  *          the parameters supplied to them can be found below:
00237  *
00238  *          - @ref sd_ble_gattc_write (write witout response only)
00239  *          - @ref sd_ble_gatts_hvx (notifications only)
00240  *          - @ref sd_ble_l2cap_tx (all packets)
00241  *
00242  * @param[out] p_count Pointer to a uint8_t which will contain the number of application transmission buffers upon
00243  *                     successful return.
00244  *
00245  * @return @ref NRF_SUCCESS Number of application transmission buffers retrieved successfully.
00246  * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
00247  */
00248 SVCALL(SD_BLE_TX_BUFFER_COUNT_GET, uint32_t, sd_ble_tx_buffer_count_get(uint8_t* p_count));
00249 
00250 
00251 /**@brief Add a Vendor Specific UUID.
00252  *
00253  * @details This call enables the application to add a vendor specific UUID to the BLE stack's table,
00254  *          for later use all other modules and APIs. This then allows the application to use the shorter,
00255  *          24-bit @ref ble_uuid_t format when dealing with both 16-bit and 128-bit UUIDs without having to
00256  *          check for lengths and having split code paths. The way that this is accomplished is by extending the
00257  *          grouping mechanism that the Bluetooth SIG standard base UUID uses for all other 128-bit UUIDs. The
00258  *          type field in the @ref ble_uuid_t structure is an index (relative to @ref BLE_UUID_TYPE_VENDOR_BEGIN)
00259  *          to the table populated by multiple calls to this function, and the uuid field in the same structure
00260  *          contains the 2 bytes at indices 12 and 13. The number of possible 128-bit UUIDs available to the
00261  *          application is therefore the number of Vendor Specific UUIDs added with the help of this function times 65536,
00262  *          although restricted to modifying bytes 12 and 13 for each of the entries in the supplied array.
00263  *
00264  * @note Bytes 12 and 13 of the provided UUID will not be used internally, since those are always replaced by
00265  * the 16-bit uuid field in @ref ble_uuid_t.
00266  *
00267  *
00268  * @param[in]  p_vs_uuid    Pointer to a 16-octet (128-bit) little endian Vendor Specific UUID disregarding
00269  *                          bytes 12 and 13.
00270  * @param[out] p_uuid_type  Pointer where the type field in @ref ble_uuid_t corresponding to this UUID will be stored.
00271  *
00272  * @return @ref NRF_SUCCESS Successfully added the Vendor Specific UUID.
00273  * @return @ref NRF_ERROR_INVALID_ADDR If p_vs_uuid or p_uuid_type is NULL or invalid.
00274  * @return @ref NRF_ERROR_NO_MEM If there are no more free slots for VS UUIDs.
00275  * @return @ref NRF_ERROR_FORBIDDEN If p_vs_uuid has already been added to the VS UUID table.
00276  */
00277 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));
00278 
00279 
00280 /** @brief Decode little endian raw UUID bytes (16-bit or 128-bit) into a 24 bit @ref ble_uuid_t structure.
00281  *
00282  * @details The raw UUID bytes excluding bytes 12 and 13 (i.e. bytes 0-11 and 14-15) of p_uuid_le are compared
00283  * to the corresponding ones in each entry of the table of vendor specific UUIDs pouplated with @ref sd_ble_uuid_vs_add
00284  * to look for a match. If there is such a match, bytes 12 and 13 are returned as p_uuid->uuid and the index
00285  * relative to @ref BLE_UUID_TYPE_VENDOR_BEGIN as p_uuid->type.
00286  *
00287  * @note If the UUID length supplied is 2, then the type set by this call will always be @ref BLE_UUID_TYPE_BLE.
00288  *
00289  * @param[in]      uuid_le_len Length in bytes of the buffer pointed to by p_uuid_le (must be 2 or 16 bytes).
00290  * @param[in]      p_uuid_le   Pointer pointing to little endian raw UUID bytes.
00291  * @param[in,out]  p_uuid      Pointer to a @ref ble_uuid_t structure to be filled in.
00292  *
00293  * @return @ref NRF_SUCCESS Successfully decoded into the @ref ble_uuid_t structure.
00294  * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
00295  * @return @ref NRF_ERROR_INVALID_LENGTH Invalid UUID length.
00296  * @return @ref NRF_ERROR_NOT_FOUND For a 128-bit UUID, no match in the populated table of UUIDs.
00297  */
00298 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));
00299 
00300 
00301 /** @brief Encode a @ref ble_uuid_t structure into little endian raw UUID bytes (16-bit or 128-bit).
00302  *
00303  * @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.
00304  *
00305  * @param[in]      p_uuid        Pointer to a @ref ble_uuid_t structure that will be encoded into bytes.
00306  * @param[out]     p_uuid_le_len Pointer to a uint8_t that will be filled with the encoded length (2 or 16 bytes).
00307  * @param[out]     p_uuid_le     Pointer to a buffer where the little endian raw UUID bytes (2 or 16) will be stored.
00308  *
00309  * @return @ref NRF_SUCCESS Successfully encoded into the buffer.
00310  * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
00311  * @return @ref NRF_ERROR_INVALID_PARAM Invalid UUID type.
00312  */
00313 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));
00314 
00315 
00316 /**@brief Get Version Information.
00317  *
00318  * @details This call allows the application to get the BLE stack version information.
00319  *
00320  * @param[in] p_version Pointer to ble_version_t structure to be filled in.
00321  *
00322  * @return @ref NRF_SUCCESS  Version information stored successfully.
00323  * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
00324  * @return @ref NRF_ERROR_BUSY The stack is busy (typically doing a locally-initiated disconnection procedure).
00325  */
00326 SVCALL(SD_BLE_VERSION_GET, uint32_t, sd_ble_version_get(ble_version_t * p_version));
00327 
00328 
00329 /**@brief Provide a user memory block.
00330  *
00331  * @note This call can only be used as a response to a @ref BLE_EVT_USER_MEM_REQUEST event issued to the application.
00332  *
00333  * @param[in] conn_handle                 Connection handle.
00334  * @param[in] p_block                     Pointer to a user memory block structure.
00335  *
00336  * @return @ref NRF_SUCCESS               Successfully queued a response to the peer.
00337  * @return @ref BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
00338  * @return @ref NRF_ERROR_INVALID_STATE   No execute write request pending.
00339  */
00340 SVCALL(SD_BLE_USER_MEM_REPLY, uint32_t, sd_ble_user_mem_reply(uint16_t conn_handle, ble_user_mem_block_t *p_block));
00341 
00342 
00343 /**@brief Set a BLE option.
00344  *
00345  * @details This call allows the application to set the value of an option.
00346  *
00347  * @param[in] opt_id Option ID.
00348  * @param[in] p_opt Pointer to a ble_opt_t structure containing the option value.
00349  *
00350  * @retval ::NRF_SUCCESS  Option set successfully.
00351  * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
00352  * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
00353  * @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, check parameter limits and constraints.
00354  * @retval ::NRF_ERROR_INVALID_STATE Unable to set the parameter at this time.
00355  * @retval ::NRF_ERROR_BUSY The stack is busy or the previous procedure has not completed.
00356  */
00357 SVCALL(SD_BLE_OPT_SET, uint32_t, sd_ble_opt_set(uint32_t opt_id, ble_opt_t const *p_opt));
00358 
00359 
00360 /**@brief Get a BLE option.
00361  *
00362  * @details This call allows the application to retrieve the value of an option.
00363  *
00364  * @param[in] opt_id Option ID.
00365  * @param[out] p_opt Pointer to a ble_opt_t structure to be filled in.
00366  *
00367  * @retval ::NRF_SUCCESS  Option retrieved successfully.
00368  * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
00369  * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
00370  * @retval ::NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, check parameter limits and constraints.
00371  * @retval ::NRF_ERROR_INVALID_STATE Unable to retrieve the parameter at this time.
00372  * @retval ::NRF_ERROR_BUSY The stack is busy or the previous procedure has not completed.
00373  * @retval ::NRF_ERROR_NOT_SUPPORTED This option is not supported.
00374  *
00375  */
00376 SVCALL(SD_BLE_OPT_GET, uint32_t, sd_ble_opt_get(uint32_t opt_id, ble_opt_t *p_opt));
00377 
00378 /** @} */
00379 
00380 #endif /* BLE_H__ */
00381 
00382 /**
00383   @}
00384   @}
00385 */