lib: bluetooth: ble_gq: align event handler

Align event handler for ble_gq with other libraries.

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

Author: eivindj-nordic

doc/nrf-bm/release_notes/release_notes_changelog.rst

@@ -115,6 +115,11 @@ Libraries
 
   * Added the error event to align event handling with other services.
 
+* BLE Gatt Queue library:
+
+  * Updated the event handling to align with other libraries.
+    The :c:struct:`ble_gq_req` now takes an :c:type:`ble_gq_evt_handler_t` event handler and the :c:member:`ble_gq_req.evt_handler_ctx` context.
+
 Samples
 =======
 

include/bm/bluetooth/ble_gq.h

@@ -129,24 +129,40 @@ enum ble_gq_req_type {
 };
 
 /**
- * @brief Error handler type.
+ * @brief Advertising event types.
  */
-typedef void (*ble_gq_req_error_cb_t)(uint16_t conn_handle, uint32_t nrf_error, void *context);
-
-/**
- * @brief Structure used to handle SoftDevice error.
- */
-struct ble_gq_req_error_handler {
-	/**
-	 * @brief Error handler to be called in case of an error from SoftDevice.
-	 */
-	ble_gq_req_error_cb_t cb;
+enum ble_gq_evt_type {
 	/**
-	 * @brief Parameter passed to the error handler;
+	 * @brief Error.
 	 */
-	void *ctx;
+	BLE_GQ_EVT_ERROR,
+};
+
+/** @brief Gatt Queue event. */
+struct ble_gq_evt {
+	/** @brief Advertising event type. */
+	enum ble_gq_evt_type evt_type;
+	union {
+		/** @ref BLE_GQ_EVT_ERROR event data. */
+		struct {
+			/** Connection handle. */
+			uint16_t conn_handle;
+			/** Event result code. */
+			uint32_t reason;
+			/** User provided context. */
+			void *ctx;
+		} error;
+	};
 };
 
+/* Forward declaration */
+struct ble_gq_req;
+
+/**
+ * @brief Event handler type.
+ */
+typedef void (*ble_gq_evt_handler_t)(const struct ble_gq_req *req, struct ble_gq_evt *evt);
+
 /**
  * @brief Structure to hold a BLE GATT request.
  */
@@ -168,7 +184,11 @@ struct ble_gq_req {
 	/**
 	 * @brief Error handler structure.
 	 */
-	struct ble_gq_req_error_handler error_handler;
+	ble_gq_evt_handler_t evt_handler;
+	/**
+	 * @brief Context passed to the event handler.
+	 */
+	void *evt_handler_ctx;
 	/**
 	 * @brief Request type specific parameters.
 	 */

include/bm/bluetooth/services/ble_cgms.h

@@ -464,7 +464,7 @@ struct ble_cgms {
 	/** Pointer to BLE GATT Queue instance. */
 	const struct ble_gq  *gatt_queue;
 	/** Error handler to be called in case of an error from SoftDevice. */
-	ble_gq_req_error_cb_t gatt_err_handler;
+	ble_gq_evt_handler_t ble_gq_evt_handler;
 	/** Handle of the CGM Service (as provided by the BLE stack). */
 	uint16_t service_handle;
 	/** GATTS characteristic handles for the different characteristics in the service. */

lib/bluetooth/ble_gq/gatt_queue.c

@@ -106,14 +106,21 @@ static const req_data_store_t req_data_store[BLE_GQ_REQ_NUM] = {
 static void request_error_handle(const struct ble_gq_req *req, uint16_t conn_handle,
 				 uint32_t nrf_err)
 {
+	struct ble_gq_evt evt = {
+		.evt_type = BLE_GQ_EVT_ERROR,
+		.error.conn_handle = conn_handle,
+		.error.ctx = req->evt_handler_ctx,
+		.error.reason = nrf_err,
+	};
+
 	if (nrf_err == NRF_SUCCESS) {
 		LOG_DBG("SD GATT procedure (%d) succeeded on connection handle: %d.", req->type,
 			conn_handle);
 	} else {
 		LOG_DBG("SD GATT procedure (%d) failed on connection handle %d with nrf_error %#x",
 			req->type, conn_handle, nrf_err);
-		if (req->error_handler.cb != NULL) {
-			req->error_handler.cb(conn_handle, nrf_err, req->error_handler.ctx);
+		if (req->evt_handler != NULL) {
+			req->evt_handler(req, &evt);
 		}
 	}
 }

subsys/bluetooth/services/ble_cgms/cgms.c

@@ -7,6 +7,7 @@
 #include <nrf_error.h>
 #include <stdint.h>
 
+#include <bm/bluetooth/ble_gq.h>
 #include <bm/bluetooth/ble_racp.h>
 #include <bm/bluetooth/services/ble_date_time.h>
 #include <bm/bluetooth/services/ble_cgms.h>
@@ -23,16 +24,16 @@
 LOG_MODULE_REGISTER(ble_cgms, CONFIG_BLE_CGMS_LOG_LEVEL);
 
 /* GATT errors and nrf_ble_gq errors event handler. */
-static void gatt_error_handler(uint16_t conn_handle, uint32_t nrf_error, void *ctx)
+static void ble_gq_evt_handler(const struct ble_gq_req *req, struct ble_gq_evt *gq_evt)
 {
 	struct ble_cgms_evt evt = {
 		.evt_type = BLE_CGMS_EVT_ERROR,
-		.error.reason = nrf_error,
+		.error.reason = gq_evt->error.reason,
 	};
-	struct ble_cgms *cgms = (struct ble_cgms *)ctx;
+	struct ble_cgms *cgms = (struct ble_cgms *)gq_evt->error.ctx;
 
-	if (nrf_error != NRF_ERROR_INVALID_STATE) {
-		LOG_ERR("GATT error, nrf_error %d", nrf_err);
+	if (gq_evt->error.reason != NRF_ERROR_INVALID_STATE) {
+		LOG_ERR("GATT error, nrf_error %d", gq_evt->error.reason);
 		if (cgms->evt_handler) {
 			cgms->evt_handler(cgms, &evt);
 		}
@@ -205,7 +206,7 @@ uint32_t ble_cgms_init(struct ble_cgms *cgms, const struct ble_cgms_config *cgms
 	cgms->is_session_started = false;
 	cgms->nb_run_session = 0;
 	cgms->conn_handle = BLE_CONN_HANDLE_INVALID;
-	cgms->gatt_err_handler = gatt_error_handler;
+	cgms->ble_gq_evt_handler = ble_gq_evt_handler;
 
 	memcpy(cgms->calibration_val[0].value, init_calib_val, BLE_CGMS_MAX_CALIB_LEN);
 

subsys/bluetooth/services/ble_cgms/cgms_racp.c

@@ -82,8 +82,8 @@ static void racp_send(struct ble_cgms *cgms, struct ble_racp_value *racp_val)
 
 	struct ble_gq_req cgms_req = {
 		.type = BLE_GQ_REQ_GATTS_HVX,
-		.error_handler.cb = cgms->gatt_err_handler,
-		.error_handler.ctx = cgms,
+		.evt_handler = cgms->ble_gq_evt_handler,
+		.evt_handler_ctx = cgms,
 		.gatts_hvx.type = BLE_GATT_HVX_INDICATION,
 		.gatts_hvx.handle = cgms->char_handles.racp.value_handle,
 		.gatts_hvx.offset = 0,

subsys/bluetooth/services/ble_cgms/cgms_socp.c

@@ -356,8 +356,8 @@ static void socp_send(struct ble_cgms *cgms)
 
 	struct ble_gq_req cgms_req = {
 		.type = BLE_GQ_REQ_GATTS_HVX,
-		.error_handler.cb = cgms->gatt_err_handler,
-		.error_handler.ctx = cgms,
+		.evt_handler = cgms->ble_gq_evt_handler,
+		.evt_handler_ctx = cgms,
 		.gatts_hvx.type = BLE_GATT_HVX_INDICATION,
 		.gatts_hvx.handle = cgms->char_handles.socp.value_handle,
 		.gatts_hvx.offset = 0,