lib: bluetooth: ble_adv: change error codes to nrf_error by eivindj-nordic · Pull Request #436 · nrfconnect/sdk-nrf-bm

eivindj-nordic · 2025-10-22T07:14:03Z

Change error codes to nrf_errors.

This is the first PR for updating the error codes for BLE libraries. Starting with the ble_adv library.
Moving forward all non-BLE libraries and components will return errnos, while BLE related code as BLE services, libraries and the SoftDevice will return nrf_errors.

github-actions · 2025-10-22T07:15:37Z

You can find the documentation preview for this PR here.

marenges · 2025-10-22T08:02:55Z


-	if (err) {
-		LOG_ERR("Failed to initialize advertising, err %d", err);
+	if (nrf_err != NRF_SUCCESS) {


Do we need to be this explicit? I think it's easier to read if (nrf_err)

I think we should for good practice, as we don't have full control over the nrf_error values (although in practice it is very unlikely that NRF_SUCCESS will change). It also makes a clear distinction between errnos and nrf_errors.

I think we can safely stick to the simpler:

if (nrf_err) { }

lemrey · 2025-10-22T08:26:35Z


-	if (err) {
-		LOG_ERR("Failed to initialize advertising, err %d", err);
+	if (nrf_err != NRF_SUCCESS) {


I think we can safely stick to the simpler:

if (nrf_err) { }

lemrey · 2025-10-22T08:27:34Z

Why are you changing this file?

Should not be part of it...

lemrey · 2025-10-22T08:28:37Z

 	/* Check parameter consistency */
 	if (ble_adv_data->srv_list.service == NULL) {
-		return -EFAULT;
+		return NRF_ERROR_INVALID_PARAM;


Use NRF_ERROR_NULL

lemrey · 2025-10-22T08:28:54Z

 		if (service_data->len > 0) {
 			if (service_data->data == NULL) {
-				return -EINVAL;
+				return NRF_ERROR_INVALID_PARAM;


Use NRF_ERROR_NULL when a check against NULL fails

I am think we should stick to what is returned in the nRF5 SDK here, and other similar places. If changed to NRF_ERROR_NULL, the retval description for NRF_ERROR_NULL would also need to change for function ble_adv_data_encode().

OK. Not a big deal, _INVALID_PARAM also works fine considering that all these pointers are optional, and in this case data could be NULL, if len wasn't also 0. An argument can be made that the error is len being non-zero, instead of data being NULL :)

lemrey · 2025-10-22T08:33:35Z

 {
 #if CONFIG_BLE_ADV_FAST_ADVERTISING
-	int err;
+	uint32_t err;


We should decide whether we want to store nrf_error values into nrf_err or whether it can be called generically err where there is only one error.

Yes, I was thinking about that as well. For now I've only updated in the samples where it collides.

lemrey · 2025-10-24T11:25:19Z

-			err = ble_adv_start(ble_adv, BLE_ADV_MODE_DIRECTED_HIGH_DUTY);
-			if (err) {
+			nrf_err = ble_adv_start(ble_adv, BLE_ADV_MODE_DIRECTED_HIGH_DUTY);
+			if (nrf_err != NRF_SUCCESS) {


I don't think we should be checking explictly against NRF_SUCCESS, it creates lots of noise for nothing.

Missed this here, will update.

anhmolt · 2025-10-27T11:26:06Z

 		if (service_data->len > 0) {
 			if (service_data->data == NULL) {
-				return -EINVAL;
+				return NRF_ERROR_INVALID_PARAM;


I am think we should stick to what is returned in the nRF5 SDK here, and other similar places. If changed to NRF_ERROR_NULL, the retval description for NRF_ERROR_NULL would also need to change for function ble_adv_data_encode().

anhmolt

Fix the comments and I'm happy with this.

eivindj-nordic · 2025-10-29T08:46:15Z

Fix the comments and I'm happy with this.

Happily addressed.

eivindj-nordic · 2025-10-29T08:46:58Z

@nrfconnect/ncs-eris @nrfconnect/ncs-bm-doc Please review.

lemrey

Looks good, a small nit.

lemrey · 2025-10-29T11:56:01Z

 		if (service_data->len > 0) {
 			if (service_data->data == NULL) {
-				return -EINVAL;
+				return NRF_ERROR_INVALID_PARAM;


OK. Not a big deal, _INVALID_PARAM also works fine considering that all these pointers are optional, and in this case data could be NULL, if len wasn't also 0. An argument can be made that the error is len being non-zero, instead of data being NULL :)

b-gent · 2025-10-29T15:06:05Z


+* Updated the following libraries to return ``nrf_errors`` instead of ``errnos``:
+
+  * BLE Advertising library.


Suggested change

* BLE Advertising library.

* :ref:`lib_ble_adv`.

Change error codes to nrf_errors. Signed-off-by: Eivind Jølsgard <eivind.jolsgard@nordicsemi.no>

eivindj-nordic self-assigned this Oct 22, 2025

eivindj-nordic requested review from a team as code owners October 22, 2025 07:14

github-actions Bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Oct 22, 2025

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch 3 times, most recently from c94cb69 to 6fc813d Compare October 22, 2025 07:22

eivindj-nordic mentioned this pull request Oct 22, 2025

treewide: bluetooth: change error codes to nrf_error #437

Merged

marenges reviewed Oct 22, 2025

View reviewed changes

Comment thread applications/firmware_loader/ble_mcumgr/src/main.c Outdated

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from 6fc813d to c2fa6b6 Compare October 22, 2025 08:01

marenges reviewed Oct 22, 2025

View reviewed changes

lemrey reviewed Oct 22, 2025

View reviewed changes

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch 4 times, most recently from 031b124 to 89653ba Compare October 22, 2025 13:03

anhmolt reviewed Oct 23, 2025

View reviewed changes

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from 89653ba to ff36289 Compare October 24, 2025 07:15

eivindj-nordic added this to the v1.0.0 milestone Oct 24, 2025

lemrey reviewed Oct 24, 2025

View reviewed changes

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from ff36289 to 9c3c4e3 Compare October 24, 2025 11:29

eivindj-nordic requested review from anhmolt, lemrey and marenges October 27, 2025 06:42

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from 9c3c4e3 to d1c16d2 Compare October 27, 2025 11:10

anhmolt reviewed Oct 27, 2025

View reviewed changes

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from d1c16d2 to 315ed52 Compare October 27, 2025 11:40

anhmolt approved these changes Oct 28, 2025

View reviewed changes

Comment thread include/bm/bluetooth/ble_adv.h Outdated

Comment thread include/bm/bluetooth/ble_adv.h Outdated

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from 315ed52 to aacb251 Compare October 29, 2025 08:45

lemrey approved these changes Oct 29, 2025

View reviewed changes

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from aacb251 to f3bbe57 Compare October 29, 2025 12:10

b-gent reviewed Oct 29, 2025

View reviewed changes

b-gent approved these changes Oct 29, 2025

View reviewed changes

anhmolt reviewed Oct 29, 2025

View reviewed changes

Comment thread include/bm/bluetooth/ble_adv.h Outdated

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from f3bbe57 to d7640af Compare October 30, 2025 07:47

lib: bluetooth: ble_adv: change error codes to nrf_error

77a3ff2

Change error codes to nrf_errors. Signed-off-by: Eivind Jølsgard <eivind.jolsgard@nordicsemi.no>

eivindj-nordic force-pushed the error_code_alignment_ble_adv branch from d7640af to 77a3ff2 Compare October 30, 2025 07:49

nvlsianpu approved these changes Oct 30, 2025

View reviewed changes

marenges approved these changes Oct 30, 2025

View reviewed changes

eivindj-nordic merged commit e2641ff into nrfconnect:main Oct 30, 2025
10 checks passed

eivindj-nordic deleted the error_code_alignment_ble_adv branch October 30, 2025 08:32


		* Updated the following libraries to return ``nrf_errors`` instead of ``errnos``:

		* BLE Advertising library.

Conversation

eivindj-nordic commented Oct 22, 2025

Uh oh!

github-actions Bot commented Oct 22, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eivindj-nordic Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anhmolt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

eivindj-nordic commented Oct 29, 2025

Uh oh!

eivindj-nordic commented Oct 29, 2025

Uh oh!

lemrey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

eivindj-nordic Oct 22, 2025 •

edited

Loading