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