123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271 |
- /**
- * Copyright (c) 2013 - 2020, Nordic Semiconductor ASA
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice, this
- * list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form, except as embedded into a Nordic
- * Semiconductor ASA integrated circuit in a product or a software update for
- * such product, must reproduce the above copyright notice, this list of
- * conditions and the following disclaimer in the documentation and/or other
- * materials provided with the distribution.
- *
- * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
- * contributors may be used to endorse or promote products derived from this
- * software without specific prior written permission.
- *
- * 4. This software, with or without modification, must only be used with a
- * Nordic Semiconductor ASA integrated circuit.
- *
- * 5. Any software provided in binary form under this license must not be reverse
- * engineered, decompiled, modified and/or disassembled.
- *
- * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
- * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
- * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
- /**@file
- *
- * @defgroup ble_db_discovery Database Discovery
- * @{
- * @ingroup ble_sdk_lib
- *
- * @brief Database discovery module.
- *
- * @details This module contains the APIs and types exposed by the DB Discovery module. These APIs
- * and types can be used by the application to perform discovery of a service and its
- * characteristics at the peer server. This module can also be used to discover the
- * desired services in multiple remote devices.
- *
- * @warning The maximum number of characteristics per service that can be discovered by this module
- * is determined by the number of characteristics in the service structure defined in
- * db_disc_config.h. If the peer has more than the supported number of characteristics, then
- * the first found will be discovered and any further characteristics will be ignored. Only the
- * following descriptors will be searched for at the peer: Client Characteristic Configuration,
- * Characteristic Extended Properties, Characteristic User Description, and Report Reference.
- *
- * @note Presently only one instance of a Primary Service can be discovered by this module. If
- * there are multiple instances of the service at the peer, only the first instance
- * of it at the peer is fetched and returned to the application.
- *
- * @note The application must propagate BLE stack events to this module by calling
- * ble_db_discovery_on_ble_evt().
- *
- */
- #ifndef BLE_DB_DISCOVERY_H__
- #define BLE_DB_DISCOVERY_H__
- #include <stdint.h>
- #include <stdbool.h>
- #include "nrf_error.h"
- #include "ble.h"
- #include "ble_gattc.h"
- #include "ble_gatt_db.h"
- #include "nrf_ble_gq.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- #if !(defined(__LINT__))
- /**@brief Macro for defining a ble_db_discovery instance.
- *
- * @param _name Name of the instance.
- * @hideinitializer
- */
- #define BLE_DB_DISCOVERY_DEF(_name) \
- static ble_db_discovery_t _name = {.discovery_in_progress = 0, \
- .conn_handle = BLE_CONN_HANDLE_INVALID}; \
- NRF_SDH_BLE_OBSERVER(_name ## _obs, \
- BLE_DB_DISC_BLE_OBSERVER_PRIO, \
- ble_db_discovery_on_ble_evt, &_name)
- /** @brief Macro for defining multiple ble_db_discovery instances.
- *
- * @param _name Name of the array of instances.
- * @param _cnt Number of instances to define.
- */
- #define BLE_DB_DISCOVERY_ARRAY_DEF(_name, _cnt) \
- static ble_db_discovery_t _name[_cnt] = {MACRO_REPEAT(_cnt, DB_INIT)}; \
- \
- NRF_SDH_BLE_OBSERVERS(_name ## _obs, \
- BLE_DB_DISC_BLE_OBSERVER_PRIO, \
- ble_db_discovery_on_ble_evt, &_name, _cnt)
- #if !(defined(DOXYGEN))
- #define DB_INIT() \
- { \
- .discovery_in_progress = 0, \
- .conn_handle = BLE_CONN_HANDLE_INVALID, \
- },
- #endif
- #else // __LINT__
- /* Swallow semicolons */
- /*lint -save -esym(528, *) -esym(529, *) : Symbol not referenced. */
- #define BLE_DB_DISCOVERY_ARRAY_DEF(A, B) static ble_db_discovery_t A[B]
- #define BLE_DB_DISCOVERY_DEF(A) static ble_db_discovery_t A
- /*lint -restore */
- #endif //!(defined(__LINT__))
- #define BLE_DB_DISCOVERY_MAX_SRV 6 /**< Maximum number of services supported by this module. This also indicates the maximum number of users allowed to be registered to this module (one user per service). */
- /**@brief DB Discovery event type. */
- typedef enum
- {
- BLE_DB_DISCOVERY_COMPLETE, /**< Event indicating that the discovery of one service is complete. */
- BLE_DB_DISCOVERY_ERROR, /**< Event indicating that an internal error has occurred in the DB Discovery module. This could typically be because of the SoftDevice API returning an error code during the DB discover.*/
- BLE_DB_DISCOVERY_SRV_NOT_FOUND, /**< Event indicating that the service was not found at the peer.*/
- BLE_DB_DISCOVERY_AVAILABLE /**< Event indicating that the DB discovery instance is available.*/
- } ble_db_discovery_evt_type_t;
- /**@brief Structure containing the event from the DB discovery module to the application. */
- typedef struct
- {
- ble_db_discovery_evt_type_t evt_type; /**< Type of event. */
- uint16_t conn_handle; /**< Handle of the connection for which this event has occurred. */
- union
- {
- ble_gatt_db_srv_t discovered_db; /**< Structure containing the information about the GATT Database at the server. This will be filled when the event type is @ref BLE_DB_DISCOVERY_COMPLETE. The UUID field of this will be filled when the event type is @ref BLE_DB_DISCOVERY_SRV_NOT_FOUND. */
- void const * p_db_instance; /**< Pointer to DB discovery instance @ref ble_db_discovery_t, indicating availability to the new discovery process. This will be filled when the event type is @ref BLE_DB_DISCOVERY_AVAILABLE. */
- uint32_t err_code; /**< nRF Error code indicating the type of error which occurred in the DB Discovery module. This will be filled when the event type is @ref BLE_DB_DISCOVERY_ERROR. */
- } params;
- } ble_db_discovery_evt_t;
- /**@brief DB Discovery event handler type. */
- typedef void (* ble_db_discovery_evt_handler_t)(ble_db_discovery_evt_t * p_evt);
- /**@brief Structure containing the pending event. */
- typedef struct
- {
- ble_db_discovery_evt_t evt; /**< Pending event. */
- ble_db_discovery_evt_handler_t evt_handler; /**< Event handler which should be called to raise this event. */
- } ble_db_discovery_user_evt_t;
- /**@brief Structure for holding the information related to the GATT database at the server.
- *
- * @details This module identifies a remote database. Use one instance of this structure per
- * connection.
- *
- * @warning This structure must be zero-initialized.
- */
- typedef struct
- {
- ble_gatt_db_srv_t services[BLE_DB_DISCOVERY_MAX_SRV]; /**< Information related to the current service being discovered. This is intended for internal use during service discovery.*/
- uint8_t srv_count; /**< Number of services at the peer's GATT database.*/
- uint8_t curr_char_ind; /**< Index of the current characteristic being discovered. This is intended for internal use during service discovery.*/
- uint8_t curr_srv_ind; /**< Index of the current service being discovered. This is intended for internal use during service discovery.*/
- uint8_t discoveries_count; /**< Number of service discoveries made, both successful and unsuccessful. */
- bool discovery_in_progress; /**< Variable to indicate whether there is a service discovery in progress. */
- uint16_t conn_handle; /**< Connection handle on which the discovery is started. */
- uint32_t pending_usr_evt_index; /**< The index to the pending user event array, pointing to the last added pending user event. */
- ble_db_discovery_user_evt_t pending_usr_evts[BLE_DB_DISCOVERY_MAX_SRV]; /**< Whenever a discovery related event is to be raised to a user module, it is stored in this array first. When all expected services have been discovered, all pending events are sent to the corresponding user modules. */
- } ble_db_discovery_t;
- /**@brief DB discovery module initialization struct. */
- typedef struct
- {
- ble_db_discovery_evt_handler_t evt_handler; /**< Event handler to be called by the DB Discovery module. */
- nrf_ble_gq_t * p_gatt_queue; /**< Pointer to BLE GATT Queue instance. */
- } ble_db_discovery_init_t;
- /**@brief Function for initializing the DB Discovery module.
- *
- * @param[in] p_db_init Pointer to DB discovery initialization structure.
- *
- * @retval NRF_SUCCESS On successful initialization.
- * @retval NRF_ERROR_NULL If the initialization structure was NULL or
- * the structure content is empty.
- */
- uint32_t ble_db_discovery_init(ble_db_discovery_init_t * p_db_init);
- /**@brief Function for closing the DB Discovery module.
- *
- * @details This function will clear up any internal variables and states maintained by the
- * module. To re-use the module after calling this function, the function @ref
- * ble_db_discovery_init must be called again. When using more than one DB Discovery
- * instance, this function should be called for each instance.
- *
- * @param[out] p_db_discovery Pointer to the DB discovery structure.
- *
- * @retval NRF_SUCCESS Operation success.
- */
- uint32_t ble_db_discovery_close(ble_db_discovery_t * const p_db_discovery);
- /**@brief Function for registering with the DB Discovery module.
- *
- * @details The application can use this function to inform which service it is interested in
- * discovering at the server.
- *
- * @param[in] p_uuid Pointer to the UUID of the service to be discovered at the server.
- *
- * @note The total number of services that can be discovered by this module is @ref
- * BLE_DB_DISCOVERY_MAX_SRV. This effectively means that the maximum number of
- * registrations possible is equal to the @ref BLE_DB_DISCOVERY_MAX_SRV.
- *
- * @retval NRF_SUCCESS Operation success.
- * @retval NRF_ERROR_NULL When a NULL pointer is passed as input.
- * @retval NRF_ERROR_INVALID_STATE If this function is called without calling the
- * @ref ble_db_discovery_init.
- * @retval NRF_ERROR_NO_MEM The maximum number of registrations allowed by this module
- * has been reached.
- */
- uint32_t ble_db_discovery_evt_register(const ble_uuid_t * const p_uuid);
- /**@brief Function for starting the discovery of the GATT database at the server.
- *
- * @param[out] p_db_discovery Pointer to the DB Discovery structure.
- * @param[in] conn_handle The handle of the connection for which the discovery should be
- * started.
- *
- * @retval NRF_SUCCESS Operation success.
- * @retval NRF_ERROR_NULL When a NULL pointer is passed as input.
- * @retval NRF_ERROR_INVALID_STATE If this function is called without calling the
- * @ref ble_db_discovery_init, or without calling
- * @ref ble_db_discovery_evt_register.
- * @retval NRF_ERROR_BUSY If a discovery is already in progress using
- * @p p_db_discovery. Use a different @ref ble_db_discovery_t
- * structure, or wait for a DB Discovery event before retrying.
- * @return This API propagates the error code returned by functions:
- * @ref nrf_ble_gq_conn_handle_register and @ref nrf_ble_gq_item_add.
- */
- uint32_t ble_db_discovery_start(ble_db_discovery_t * p_db_discovery,
- uint16_t conn_handle);
- /**@brief Function for handling the Application's BLE Stack events.
- *
- * @param[in] p_ble_evt Pointer to the BLE event received.
- * @param[in,out] p_context Pointer to the DB Discovery structure.
- */
- void ble_db_discovery_on_ble_evt(ble_evt_t const * p_ble_evt,
- void * p_context);
- #ifdef __cplusplus
- }
- #endif
- #endif // BLE_DB_DISCOVERY_H__
- /** @} */
|