bluetooth: services: ble_nus: change error codes to nrf_error

eivindj-nordic · eivindj-nordic · commit c12373f693bd · 2025-11-03T12:47:21.000+01:00
Change error codes to nrf_errors.

Signed-off-by: Eivind Jølsgard &lt;eivind.jolsgard@nordicsemi.no&gt;
diff --git a/doc/nrf-bm/release_notes/release_notes_changelog.rst b/doc/nrf-bm/release_notes/release_notes_changelog.rst
@@ -81,6 +81,7 @@ Libraries
   * :ref:`lib_ble_service_hrs` service.
   * :ref:`lib_ble_service_lbs` service.
   * :ref:`lib_ble_service_mcumgr` service.
+  * :ref:`lib_ble_service_nus` service.
 
 * :ref:`lib_ble_conn_params` library:
 
diff --git a/include/bm/bluetooth/services/ble_nus.h b/include/bm/bluetooth/services/ble_nus.h
@@ -162,11 +162,11 @@ struct ble_nus {
  *                 later be used to identify this particular service instance.
  * @param[in] nus_init Information needed to initialize the service.
  *
- * @retval 0 On success.
- * @retval -EFAULT If @p nus or @p nus_config is @c NULL.
- * @retval -EINVAL Invalid parameters.
+ * @retval NRF_SUCCESS On success.
+ * @retval NRF_ERROR_NULL If @p nus or @p nus_config is @c NULL.
+ * @retval NRF_ERROR_INVALID_PARAM Invalid parameters.
  */
-int ble_nus_init(struct ble_nus *nus, struct ble_nus_config const *nus_config);
+uint32_t ble_nus_init(struct ble_nus *nus, struct ble_nus_config const *nus_config);
 
 /**
  * @brief Function for handling the Nordic UART Service's BLE events.
@@ -192,17 +192,11 @@ void ble_nus_on_ble_evt(ble_evt_t const *ble_evt, void *context);
  * @param[in,out] length In: Length of the @p data string. Out: Number of bytes sent.
  * @param[in] conn_handle Connection handle of the destination client.
  *
- * @retval 0 On success.
- * @retval -EFAULT If @p nus, @p data or @p length is @c NULL.
- * @retval -EINVAL Invalid parameters.
- * @retval -ENOENT Invalid @p conn_handle.
- * @retval -EIO Failed to send notification.
- * @retval -ENOTCONN Connection handle unknown to the softdevice.
- * @retval -EPIPE Notifications not enabled in the CCCD.
- * @retval -EBADF Not found.
- * @retval -EAGAIN Not enough resources for operation.
+ * @retval NRF_SUCCESS On success.
+ * @return nrf_error on failure.
  */
-int ble_nus_data_send(struct ble_nus *nus, uint8_t *data, uint16_t *length, uint16_t conn_handle);
+uint32_t ble_nus_data_send(struct ble_nus *nus, uint8_t *data, uint16_t *length,
+			   uint16_t conn_handle);
 
 #ifdef __cplusplus
 }
diff --git a/samples/bluetooth/ble_nus/src/main.c b/samples/bluetooth/ble_nus/src/main.c
@@ -71,26 +71,26 @@ static int buf_idx;
 #if defined(CONFIG_NUS_LPUARTE)
 static void lpuarte_rx_handler(char *data, size_t data_len)
 {
-	int err;
+	uint32_t nrf_err;
 	uint16_t len = data_len;
 
 	LOG_INF("Sending data over BLE NUS, len %d", len);
 
 	do {
-		err = ble_nus_data_send(&ble_nus, data, &len, conn_handle);
-		if ((err != 0) &&
-			(err != -EPIPE) &&
-			(err != -EAGAIN) &&
-			(err != -EBADF)) {
-			LOG_ERR("Failed to send NUS data, err %d", err);
+		nrf_err = ble_nus_data_send(&ble_nus, data, &len, conn_handle);
+		if ((nrf_err) &&
+		    (nrf_err != NRF_ERROR_INVALID_STATE) &&
+		    (nrf_err != NRF_ERROR_RESOURCES) &&
+		    (nrf_err != NRF_ERROR_NOT_FOUND)) {
+			LOG_ERR("Failed to send NUS data, nrf_error %#x", nrf_err);
 			return;
 		}
-	} while (err == -EAGAIN);
+	} while (nrf_err == NRF_ERROR_RESOURCES);
 }
 #else
 static void uarte_rx_handler(char *data, size_t data_len)
 {
-	int err;
+	uint32_t nrf_err;
 	uint8_t c;
 	/* receive buffer used in UART ISR callback */
 	static char rx_buf[BLE_NUS_MAX_DATA_LEN];
@@ -114,15 +114,15 @@ static void uarte_rx_handler(char *data, size_t data_len)
 			LOG_INF("Sending data over BLE NUS, len %d", len);
 
 			do {
-				err = ble_nus_data_send(&ble_nus, rx_buf, &len, conn_handle);
-				if ((err != 0) &&
-				    (err != -EPIPE) &&
-				    (err != -EAGAIN) &&
-				    (err != -EBADF)) {
-					LOG_ERR("Failed to send NUS data, err %d", err);
+				nrf_err = ble_nus_data_send(&ble_nus, rx_buf, &len, conn_handle);
+				if ((nrf_err) &&
+				    (nrf_err != NRF_ERROR_INVALID_STATE) &&
+				    (nrf_err != NRF_ERROR_RESOURCES) &&
+				    (nrf_err != NRF_ERROR_NOT_FOUND)) {
+					LOG_ERR("Failed to send NUS data, nrf_error %#x", nrf_err);
 					return;
 				}
-			} while (err == -EAGAIN);
+			} while (nrf_err == NRF_ERROR_RESOURCES);
 
 			if (len == rx_buf_idx) {
 				rx_buf_idx = 0;
@@ -468,9 +468,9 @@ int main(void)
 		goto idle;
 	}
 
-	err = ble_nus_init(&ble_nus, &nus_cfg);
-	if (err) {
-		LOG_ERR("Failed to initialize Nordic uart service, err %d", err);
+	nrf_err = ble_nus_init(&ble_nus, &nus_cfg);
+	if (nrf_err) {
+		LOG_ERR("Failed to initialize Nordic uart service, nrf_error %#x", nrf_err);
 		goto idle;
 	}
 
diff --git a/subsys/bluetooth/services/ble_nus/nus.c b/subsys/bluetooth/services/ble_nus/nus.c
@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
  */
 
+#include <nrf_error.h>
 #include <stdbool.h>
 #include <stdint.h>
 #include <bm/bluetooth/services/ble_nus.h>
@@ -101,7 +102,7 @@ static uint32_t nus_tx_char_add(struct ble_nus *nus, struct ble_nus_config const
  */
 static void on_connect(struct ble_nus *nus, ble_evt_t const *ble_evt)
 {
-	int err;
+	uint32_t nrf_err;
 	const uint16_t conn_handle = ble_evt->evt.gap_evt.conn_handle;
 	struct ble_nus_evt evt = {
 		.type = BLE_NUS_EVT_COMM_STARTED,
@@ -124,8 +125,8 @@ static void on_connect(struct ble_nus *nus, ble_evt_t const *ble_evt)
 	/* Check the hosts CCCD value to inform of readiness to send data using the
 	 * RX characteristic
 	 */
-	err = sd_ble_gatts_value_get(conn_handle, nus->tx_handles.cccd_handle, &gatts_val);
-	if ((err == 0) && (nus->evt_handler != NULL) &&
+	nrf_err = sd_ble_gatts_value_get(conn_handle, nus->tx_handles.cccd_handle, &gatts_val);
+	if ((nrf_err == NRF_SUCCESS) && (nus->evt_handler != NULL) &&
 	    is_notification_enabled(gatts_val.p_value)) {
 		if (ctx != NULL) {
 			ctx->is_notification_enabled = true;
@@ -244,60 +245,59 @@ void ble_nus_on_ble_evt(ble_evt_t const *ble_evt, void *ctx)
 	}
 }
 
-int ble_nus_init(struct ble_nus *nus, struct ble_nus_config const *cfg)
+uint32_t ble_nus_init(struct ble_nus *nus, struct ble_nus_config const *cfg)
 {
-	int err;
+	uint32_t nrf_err;
 	ble_uuid_t ble_uuid;
 	ble_uuid128_t uuid_base = { .uuid128 = BLE_NUS_UUID_BASE };
 
 	if (!nus || !cfg) {
-		return -EFAULT;
+		return NRF_ERROR_NULL;
 	}
 
 	/* Initialize the service structure. */
 	nus->evt_handler = cfg->evt_handler;
 	nus->service_handle = BLE_CONN_HANDLE_INVALID;
 
 	/* Add a custom base UUID. */
-	err = sd_ble_uuid_vs_add(&uuid_base, &nus->uuid_type);
-	if (err) {
-		LOG_ERR("sd_ble_uuid_vs_add failed, nrf_error %#x", err);
-		return -EINVAL;
+	nrf_err = sd_ble_uuid_vs_add(&uuid_base, &nus->uuid_type);
+	if (nrf_err) {
+		LOG_ERR("sd_ble_uuid_vs_add failed, nrf_error %#x", nrf_err);
+		return NRF_ERROR_INVALID_PARAM;
 	}
 
 	ble_uuid.type = nus->uuid_type;
 	ble_uuid.uuid = BLE_UUID_NUS_SERVICE;
 
 	/* Add the service. */
-	err = sd_ble_gatts_service_add(BLE_GATTS_SRVC_TYPE_PRIMARY,
-				       &ble_uuid,
-				       &nus->service_handle);
-	if (err) {
-		LOG_ERR("Failed to add NUS service, nrf_error %#x", err);
-		return -EINVAL;
+	nrf_err = sd_ble_gatts_service_add(BLE_GATTS_SRVC_TYPE_PRIMARY,
+					   &ble_uuid,
+					   &nus->service_handle);
+	if (nrf_err) {
+		LOG_ERR("Failed to add NUS service, nrf_error %#x", nrf_err);
+		return NRF_ERROR_INVALID_PARAM;
 	}
 
 	/* Add NUS RX characteristic. */
-	err = nus_rx_char_add(nus, cfg);
-	if (err) {
-		LOG_ERR("nus_rx_char_add failed, nrf_error %#x", err);
-		return -EINVAL;
+	nrf_err = nus_rx_char_add(nus, cfg);
+	if (nrf_err) {
+		LOG_ERR("nus_rx_char_add failed, nrf_error %#x", nrf_err);
+		return NRF_ERROR_INVALID_PARAM;
 	}
 
 	/* Add NUS TX characteristic. */
-	err = nus_tx_char_add(nus, cfg);
-	if (err) {
-		LOG_ERR("nus_tx_char_add failed, nrf_error %#x", err);
-		return -EINVAL;
+	nrf_err = nus_tx_char_add(nus, cfg);
+	if (nrf_err) {
+		LOG_ERR("nus_tx_char_add failed, nrf_error %#x", nrf_err);
+		return NRF_ERROR_INVALID_PARAM;
 	}
 
 	return 0;
 }
 
-int ble_nus_data_send(struct ble_nus *nus, uint8_t *data,
+uint32_t ble_nus_data_send(struct ble_nus *nus, uint8_t *data,
 			   uint16_t *len, uint16_t conn_handle)
 {
-	int err;
 	ble_gatts_hvx_params_t hvx_params = {
 		.p_data = data,
 		.p_len = len,
@@ -306,45 +306,27 @@ int ble_nus_data_send(struct ble_nus *nus, uint8_t *data,
 	struct ble_nus_client_context *ctx;
 
 	if (!nus || !data || !len) {
-		return -EFAULT;
+		return NRF_ERROR_NULL;
 	}
 
 	if (*len > BLE_NUS_MAX_DATA_LEN) {
-		return -EINVAL;
+		return NRF_ERROR_INVALID_PARAM;
 	}
 
 	if (conn_handle == BLE_CONN_HANDLE_INVALID) {
-		return -ENOENT;
+		return NRF_ERROR_NOT_FOUND;
 	}
 
 	ctx = ble_nus_client_context_get(conn_handle);
 	if (ctx == NULL) {
-		return -ENOENT;
+		return NRF_ERROR_NOT_FOUND;
 	}
 
 	if (!ctx->is_notification_enabled) {
-		return -EINVAL;
+		return NRF_ERROR_INVALID_PARAM;
 	}
 
 	hvx_params.handle = nus->tx_handles.value_handle;
 
-	err =  sd_ble_gatts_hvx(conn_handle, &hvx_params);
-	switch (err) {
-	case NRF_SUCCESS:
-		return 0;
-	case BLE_ERROR_INVALID_CONN_HANDLE:
-		return -ENOTCONN;
-	case NRF_ERROR_INVALID_STATE:
-	case BLE_ERROR_GATTS_SYS_ATTR_MISSING:
-		return -EPIPE;
-	case NRF_ERROR_RESOURCES:
-		return -EAGAIN;
-	case NRF_ERROR_NOT_FOUND:
-		return -EBADF;
-	default:
-		LOG_ERR("Failed to send NUS data, nrf_error %#x", err);
-		return -EIO;
-	}
-
-	return 0;
+	return sd_ble_gatts_hvx(conn_handle, &hvx_params);
 }
diff --git a/tests/subsys/bluetooth/services/ble_nus/src/unity_test.c b/tests/subsys/bluetooth/services/ble_nus/src/unity_test.c
