lib: Align event handlers

* Add error events to the ble_adv library event handler.
  The error handler is removed.
* Add error events to the nrf_ble_qwr library event handler.
  The error handler is removed.
* Rename nrf_ble_qwr to ble_qwr to align with other libraries.
* Align lbs event handler with other services and libraries.
* Align nus event handler with other services and libraries.
* Align lite_buttons with other libraries and services.
* event_handler -> evt_handler

Signed-off-by: Eivind Jølsgard <[email protected]>

Author: eivindj-nordic

include/ble_adv.h

@@ -82,9 +82,13 @@ enum ble_adv_mode {
 };
 
 /**
- * @brief Advertising events.
+ * @brief Advertising event types.
  */
-enum ble_adv_evt {
+enum ble_adv_evt_type {
+	/**
+	 * @brief Error.
+	 */
+	BLE_ADV_EVT_ERROR,
 	/**
 	 * @brief Idle; no connectable advertising is ongoing.
 	 */
@@ -131,15 +135,25 @@ enum ble_adv_evt {
 	BLE_ADV_EVT_PEER_ADDR_REQUEST
 };
 
-/**
- * @brief BLE advertising event handler.
- */
-typedef void (*ble_adv_evt_handler_t)(enum ble_adv_evt adv_evt);
+/** @brief Advertising event. */
+struct ble_adv_evt {
+	/** @brief Advertising event type. */
+	enum ble_adv_evt_type evt_type;
+	union {
+		/** @ref BLE_ADV_EVT_ERROR event data. */
+		struct {
+			int reason;
+		} error;
+	};
+};
+
+/** Forward definition of ble_adv struct */
+struct ble_adv;
 
 /**
- * @brief BLE advertising error handler type.
+ * @brief BLE advertising event handler.
  */
-typedef void (*ble_adv_error_handler_t)(int error);
+typedef void (*ble_adv_evt_handler_t)(struct ble_adv *adv, const struct ble_adv_evt *adv_evt);
 
 /**
  * @brief BLE advertising instance.
@@ -169,10 +183,6 @@ struct ble_adv {
 	 * @brief Instance event handler.
 	 */
 	ble_adv_evt_handler_t evt_handler;
-	/**
-	 * @brief Instance error handler.
-	 */
-	ble_adv_error_handler_t error_handler;
 	/**
 	 * @brief GAP advertising parameters.
 	 */
@@ -233,10 +243,6 @@ struct ble_adv_config {
 	  * @brief  Event handler.
 	  */
 	ble_adv_evt_handler_t evt_handler;
-	/**
-	 * @brief Error handler.
-	 */
-	ble_adv_error_handler_t error_handler;
 	/**
 	 * @brief Connection configuration tag.
 	 */

include/ble_conn_params.h

@@ -83,7 +83,7 @@ typedef void (*ble_conn_params_evt_handler_t)(const struct ble_conn_params_evt *
  * @returns 0 On success.
  * @returns -EFAULT If @p handler is @c NULL.
  */
-int ble_conn_params_event_handler_set(ble_conn_params_evt_handler_t handler);
+int ble_conn_params_evt_handler_set(ble_conn_params_evt_handler_t handler);
 
 /**
  * @brief Override GAP connection parameters for given peer.

include/nrf_ble_qwr.h renamed to include/ble_qwr.h

@@ -6,7 +6,7 @@
 
 /** @file
  *
- * @defgroup nrf_ble_qwr Queued Writes module
+ * @defgroup ble_qwr Queued Writes module
  * @{
  * @ingroup ble_sdk_lib
  * @brief Module for handling Queued Write operations.
@@ -15,7 +15,7 @@
  * commands. It also manages memory requests related to these operations.
  *
  * @note The application must propagate BLE stack events to this module by calling
- *       @ref nrf_ble_qwr_on_ble_evt().
+ *       @ref ble_qwr_on_ble_evt().
  */
 
 #ifndef NRF_BLE_QUEUED_WRITES_H__
@@ -31,94 +31,103 @@ extern "C" {
 #include <ble_gatts.h>
 
 /**
- * @brief Macro for defining a nrf_ble_qwr instance.
+ * @brief Macro for defining a ble_qwr instance.
  *
  * @param _name Name of the instance.
  * @hideinitializer
  */
-#define NRF_BLE_QWR_DEF(_name)                                                                     \
-	static struct nrf_ble_qwr _name;                                                           \
+#define BLE_QWR_DEF(_name)                                                                         \
+	static struct ble_qwr _name;                                                               \
 	NRF_SDH_BLE_OBSERVER(_name ## _obs,                                                        \
-			     nrf_ble_qwr_on_ble_evt,                                               \
+			     ble_qwr_on_ble_evt,                                                   \
 			     &_name,                                                               \
-			     CONFIG_NRF_BLE_QWR_BLE_OBSERVER_PRIO)
+			     CONFIG_BLE_QWR_BLE_OBSERVER_PRIO)
 
 /* Error code used by the module to reject prepare write requests on non-registered attributes. */
-#define NRF_BLE_QWR_REJ_REQUEST_ERR_CODE BLE_GATT_STATUS_ATTERR_APP_BEGIN + 0
+#define BLE_QWR_REJ_REQUEST_ERR_CODE BLE_GATT_STATUS_ATTERR_APP_BEGIN + 0
 
 /** @brief Queued Writes module event types. */
-enum nrf_ble_qwr_evt_type {
+enum ble_qwr_evt_type {
+	/** Error event */
+	BLE_QWR_EVT_ERROR,
 	/** Event that indicates that an execute write command was received for a registered handle
 	 * and that the received data was actually written and is now ready.
 	 */
-	NRF_BLE_QWR_EVT_EXECUTE_WRITE,
+	BLE_QWR_EVT_EXECUTE_WRITE,
 	/** Event that indicates that an execute write command was received for a registered handle
 	 * and that the write request must now be accepted or rejected.
 	 */
-	NRF_BLE_QWR_EVT_AUTH_REQUEST,
+	BLE_QWR_EVT_AUTH_REQUEST,
 };
 
 /** @brief Queued Writes module events. */
-struct nrf_ble_qwr_evt {
+struct ble_qwr_evt {
 	/** Type of the event. */
-	enum nrf_ble_qwr_evt_type evt_type;
-	/** Handle of the attribute to which the event relates. */
-	uint16_t attr_handle;
+	enum ble_qwr_evt_type evt_type;
+	union {
+		/** @ref BLE_QWR_EVT_ERROR event data. */
+		struct {
+			int reason;
+		} error;
+		/** @ref BLE_QWR_EVT_EXECUTE_WRITE event data. */
+		struct {
+			/** Handle of the attribute to which the event relates. */
+			uint16_t attr_handle;
+		} exec_write;
+		/** @ref BLE_QWR_EVT_AUTH_REQUEST event data. */
+		struct {
+			/** Handle of the attribute to which the event relates. */
+			uint16_t attr_handle;
+		} auth_req;
+	};
 };
 
-/* Forward declaration of the struct nrf_ble_qwr. */
-struct nrf_ble_qwr;
+/* Forward declaration of the struct ble_qwr. */
+struct ble_qwr;
 
 /**
  * @brief Queued Writes module event handler type.
  *
- * If the provided event is of type @ref NRF_BLE_QWR_EVT_AUTH_REQUEST,
+ * If the provided event is of type @ref BLE_QWR_EVT_AUTH_REQUEST,
  * this function must accept or reject the execute write request by returning
  * one of the @ref BLE_GATT_STATUS_CODES.
  */
-typedef uint16_t (*nrf_ble_qwr_evt_handler_t)(struct nrf_ble_qwr *qwr, struct nrf_ble_qwr_evt *evt);
-
-/**
- * @brief Type definition for error handler function that will be called in case of an error.
- */
-typedef void (*nrf_ble_qwr_error_handler_t)(int err);
+typedef uint16_t (*ble_qwr_evt_handler_t)(struct ble_qwr *qwr, const struct ble_qwr_evt *evt);
 
 /**
  * @brief Queued Writes structure.
  * @details This structure contains status information for the Queued Writes module.
  */
-struct nrf_ble_qwr {
+struct ble_qwr {
 	/** Flag that indicates whether the module has been initialized. */
 	uint32_t initialized;
+	/** Event handler function that is called for events concerning the handles of all
+	 *  registered attributes.
+	 */
+	ble_qwr_evt_handler_t evt_handler;
 	/** Connection handle. */
 	uint16_t conn_handle;
-	/** Error handler. */
-	nrf_ble_qwr_error_handler_t error_handler;
 	/** Flag that indicates whether a mem_reply is pending
 	 *  (because a previous attempt returned busy).
 	 */
 	bool is_user_mem_reply_pending;
-#if (CONFIG_NRF_BLE_QWR_MAX_ATTR > 0)
+#if (CONFIG_BLE_QWR_MAX_ATTR > 0)
 	/** List of handles for registered attributes, for which the module accepts and handles
 	 *  prepare write operations.
 	 */
-	uint16_t attr_handles[CONFIG_NRF_BLE_QWR_MAX_ATTR];
+	uint16_t attr_handles[CONFIG_BLE_QWR_MAX_ATTR];
 	/** Number of registered attributes. */
 	uint8_t nb_registered_attr;
 	/** List of attribute handles that have been written to during the current prepare write or
 	 *  execute write operation.
 	 */
-	uint16_t written_attr_handles[CONFIG_NRF_BLE_QWR_MAX_ATTR];
+	uint16_t written_attr_handles[CONFIG_BLE_QWR_MAX_ATTR];
 	/** Number of attributes that have been written to during the current prepare write or
 	 *  execute write operation.
 	 */
 	uint8_t nb_written_handles;
 	/** Memory buffer that is provided to the SoftDevice on an ON_USER_MEM_REQUEST event. */
 	ble_user_mem_block_t mem_buffer;
-	/** Event handler function that is called for events concerning the handles of all
-	 *  registered attributes.
-	 */
-	nrf_ble_qwr_evt_handler_t callback;
 #endif
 };
 
@@ -127,16 +136,14 @@ struct nrf_ble_qwr {
  *
  * @details This structure contains all information needed to initialize the Queued Writes module.
  */
-struct nrf_ble_qwr_init {
-	/** Error handler. */
-	nrf_ble_qwr_error_handler_t error_handler;
-#if (CONFIG_NRF_BLE_QWR_MAX_ATTR > 0)
-	/** Memory buffer that is provided to the SoftDevice on an ON_USER_MEM_REQUEST event. */
-	ble_user_mem_block_t mem_buffer;
+struct ble_qwr_config {
 	/** Event handler function that is called for events concerning the handles of all
 	 *  registered attributes.
 	 */
-	nrf_ble_qwr_evt_handler_t callback;
+	ble_qwr_evt_handler_t evt_handler;
+#if (CONFIG_BLE_QWR_MAX_ATTR > 0)
+	/** Memory buffer that is provided to the SoftDevice on an ON_USER_MEM_REQUEST event. */
+	ble_user_mem_block_t mem_buffer;
 #endif
 };
 
@@ -156,7 +163,7 @@ struct nrf_ble_qwr_init {
  * @retval -EFAULT If @p qwr or @p qwr_init is @c NULL.
  * @retval -EPERM If the given @p qwr instance has already been initialized.
  */
-int nrf_ble_qwr_init(struct nrf_ble_qwr *qwr, struct nrf_ble_qwr_init const *qwr_init);
+int ble_qwr_init(struct ble_qwr *qwr, struct ble_qwr_config const *qwr_config);
 
 
 /**
@@ -173,7 +180,7 @@ int nrf_ble_qwr_init(struct nrf_ble_qwr *qwr, struct nrf_ble_qwr_init const *qwr
  * @retval -EFAULT If @p qwr is @c NULL.
  * @retval -EPERM If the given @p qwr instance has not been initialized.
  */
-int nrf_ble_qwr_conn_handle_assign(struct nrf_ble_qwr *qwr, uint16_t conn_handle);
+int ble_qwr_conn_handle_assign(struct ble_qwr *qwr, uint16_t conn_handle);
 
 /**
  * @brief Function for handling BLE stack events.
@@ -183,9 +190,9 @@ int nrf_ble_qwr_conn_handle_assign(struct nrf_ble_qwr *qwr, uint16_t conn_handle
  * @param[in] ble_evt Event received from the BLE stack.
  * @param[in] context Queued Writes structure.
  */
-void nrf_ble_qwr_on_ble_evt(ble_evt_t const *ble_evt, void *context);
+void ble_qwr_on_ble_evt(ble_evt_t const *ble_evt, void *context);
 
-#if (CONFIG_NRF_BLE_QWR_MAX_ATTR > 0)
+#if (CONFIG_BLE_QWR_MAX_ATTR > 0)
 /**
  * @brief Function for registering an attribute with the Queued Writes module.
  *
@@ -200,13 +207,13 @@ void nrf_ble_qwr_on_ble_evt(ble_evt_t const *ble_evt, void *context);
  * @retval -EFAULT If @p qwr is @c NULL.
  * @retval -EPERM If the given @p qwr instance has not been initialized.
  */
-int nrf_ble_qwr_attr_register(struct nrf_ble_qwr *qwr, uint16_t attr_handle);
+int ble_qwr_attr_register(struct ble_qwr *qwr, uint16_t attr_handle);
 
 
 /**
  * @brief Function for retrieving the received data for a given attribute.
  *
- * @details Call this function after receiving an @ref NRF_BLE_QWR_EVT_AUTH_REQUEST
+ * @details Call this function after receiving an @ref BLE_QWR_EVT_AUTH_REQUEST
  * event to retrieve a linear copy of the data that was received for the given attribute.
  *
  * @param[in] qwr Queued Writes structure.
@@ -219,9 +226,9 @@ int nrf_ble_qwr_attr_register(struct nrf_ble_qwr *qwr, uint16_t attr_handle);
  * @retval -EFAULT If @p qwr, @p mem or @p len is @c NULL.
  * @retval -EPERM If the given @p qwr instance has not been initialized.
  */
-int nrf_ble_qwr_value_get(
-	struct nrf_ble_qwr *qwr, uint16_t attr_handle, uint8_t *mem, uint16_t *len);
-#endif /* (CONFIG_NRF_BLE_QWR_MAX_ATTR > 0) */
+int ble_qwr_value_get(
+	struct ble_qwr *qwr, uint16_t attr_handle, uint8_t *mem, uint16_t *len);
+#endif /* (CONFIG_BLE_QWR_MAX_ATTR > 0) */
 
 #ifdef __cplusplus
 }

include/bluetooth/services/ble_lbs.h

@@ -41,16 +41,33 @@ struct ble_lbs;
 	extern void ble_lbs_on_ble_evt(const ble_evt_t *ble_evt, void *lbs_instance);              \
 	NRF_SDH_BLE_OBSERVER(_name ## _obs, ble_lbs_on_ble_evt, &_name, BLE_LBS_BLE_OBSERVER_PRIO)
 
-typedef void (*ble_lbs_led_write_handler_t)(uint16_t conn_handle, struct ble_lbs *lbs,
-					    uint8_t value);
+enum ble_lbs_evt_type {
+	BLE_LBS_EVT_LED_WRITE,
+};
+
+struct ble_lbs_evt {
+	enum ble_lbs_evt_type evt_type;
+	union {
+		/** @ref BLE_LBS_EVT_LED_WRITE event data. */
+		struct {
+			/** Connection handle */
+			uint16_t conn_handle;
+			/** Value to write */
+			uint8_t value;
+		} led_write;
+	};
+};
+
+/** @brief LED button Service event handler */
+typedef void (*lbs_evt_handler_t)(struct ble_lbs *lbs, const struct ble_lbs_evt *lbs_evt);
 
 /**
  * @brief LED Button Service init structure. This structure contains all options and data needed
  *        for initialization of the service.
  */
 struct ble_lbs_config {
 	/** @brief Event handler to be called when the LED Characteristic is written. */
-	ble_lbs_led_write_handler_t led_write_handler;
+	lbs_evt_handler_t evt_handler;
 };
 
 /**
@@ -66,7 +83,7 @@ struct ble_lbs {
 	/** @brief UUID type for the LED Button Service. */
 	uint8_t uuid_type;
 	/** @brief Event handler to be called when the LED Characteristic is written. */
-	ble_lbs_led_write_handler_t led_write_handler;
+	lbs_evt_handler_t evt_handler;
 };
 
 /**

include/bluetooth/services/ble_nus.h

@@ -112,7 +112,7 @@ struct ble_nus_evt {
 };
 
 /** @brief Nordic UART Service event handler type. */
-typedef void (*ble_nus_data_handler_t) (struct ble_nus_evt *evt);
+typedef void (*ble_nus_evt_handler_t) (const struct ble_nus_evt *evt);
 
 /*
  * @brief Nordic UART Service initialization structure.
@@ -123,7 +123,7 @@ typedef void (*ble_nus_data_handler_t) (struct ble_nus_evt *evt);
  */
 struct ble_nus_config {
 	/** Event handler to be called for handling received data. */
-	ble_nus_data_handler_t data_handler;
+	ble_nus_evt_handler_t evt_handler;
 };
 
 /**
@@ -143,7 +143,7 @@ struct ble_nus {
 	/** Link context with handles of all current connections and its context. */
 	struct ble_nus_ctx *const ctx;
 	/** Event handler to be called for handling received data. */
-	ble_nus_data_handler_t data_handler;
+	ble_nus_evt_handler_t evt_handler;
 };
 
 /**