sdh: simplifications and improvements by lemrey · Pull Request #388 · nrfconnect/sdk-nrf-bm

lemrey · 2025-09-23T12:38:59Z

Introduce observer priority levels, e.g. HIGHEST, HIGH, USER, USER_LOW, LOWEST
~~Remove NRF_SDH_BLE (no longer configurable)~~
Remove nrf_sdh_app_ram_start_get(), unused and not useful
Remove nrf_sdh_is_enabled() in favor of native SoftDevice function
Merge request observers with state observers
Remove nrf_sdh_request_continue() and add nrf_sdh_observer_ready().
Improve functions for stringifying events and export them
Split random seed request handling to a dedicated file
Put some Kconfigs behind menus

github-actions · 2025-09-23T12:40:21Z

You can find the documentation preview for this PR here.

nordicjm · 2025-10-02T10:56:55Z

+
+/* Helper macros to check for equality */
+
+#define _NRF_SDH_OBSERVER_PRIO_HIGHEST_HIGHEST 1


don't use underscores for first character

Alright, will rename

nordicjm · 2025-10-02T10:57:47Z

+ * If :option:`CONFIG_NRF_SDH_STR_TABLES` is enabled, returns the event name.
+ * Otherwise, returns the supplied integer as a string.
+ *
+ * @param evt A NRF_SOC_SVCS enumeration value.


@ before symbols links to it

@nordicjm Can you please provide some context on this suggestion? Thanks.

nordicjm · 2025-10-02T10:59:19Z

 	};

-	if (sdh_enabled) {
+	(void) sd_softdevice_is_enabled(&sd_is_enabled);


Suggested change

(void) sd_softdevice_is_enabled(&sd_is_enabled);

(void)sd_softdevice_is_enabled(&sd_is_enabled);

fix in whole PR

lemrey · 2025-10-03T12:54:52Z

Added changlog entries

eivindj-nordic · 2025-10-03T12:57:43Z

+SoftDevice handler
+##################
+
+The SoftDevice handler is a library that handles SoftDevice initialization tasks, and pulls and dispatches the SoftDevice events to registered components.


Would be good with more skin on the bone, though I guess that can be added later as well.

MirkoCovizzi · 2025-10-03T13:21:05Z

-No changes since the latest nRF Connect SDK Bare Metal release.
+* Removed:
+
+  * The ``NRF_SDH_BLE`` Kconfig option.


I think it should be like this:

Suggested change

* The ``NRF_SDH_BLE`` Kconfig option.

* The ``CONFIG_NRF_SDH_BLE`` Kconfig option.

I ended up dropping this commit

MirkoCovizzi · 2025-10-03T13:42:31Z

 LOG_MODULE_DECLARE(nrf_sdh, CONFIG_NRF_SDH_LOG_LEVEL);

-const char *gap_evt_tostr(int evt)
+const char *ble_evt_tostr(int evt)


Suggested change

const char *ble_evt_tostr(int evt)

const char *ble_evt_to_str(int evt)

echo on above, to_str is english, tostr is not a word

This is corrected in b1bf672, though would be good to have it changed here as well.

eivindj-nordic · 2025-10-21T12:11:15Z

@lemrey Please rebase :)

b-gent

Approving for the changelog items but we will need more rst documentation before the release.

lemrey · 2025-11-06T09:58:36Z

@nordicjm could you please have a look again?

MirkoCovizzi · 2025-11-11T11:55:34Z

+ * A SoftDevice observer has a defined priority, which determines the order with
+ * which the observer receives relevant events compared to other observers.
+ *
+ * Five priority levels are defined: highest, high, user, user low, lowest.


Nit:

Suggested change

* Five priority levels are defined: highest, high, user, user low, lowest.

* Five priority levels are defined: highest, high, user, user low, and lowest.

Add a placeholder entry for sdh to be able to reference it in the changelog. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

It is more correct to use an SoC observer to do this, rather than doing it directly in nrf_sdh_soc (the stack observer). Make the feature optional, and leave it enabled by default. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Introduce an allowed set of priorities for observers, with validity checks. These are: HIGHEST, HIGH, USER, USER_LOW, LOWEST. These could be extended ala SYS_INIT to include a priority within a level, but it seemed a bit overkill for now. Each library or piece of code in the SDK shall have an hardcoded priority, because just changing the priority of one component would break the others. In general, a component's observer must have a lower priority than the observers in its dependencies. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Add GATTS and GATTC event strings to the table. Renamed gap_evt_tostr() to ble_evt_tostr() to reflect that it now can print all BLE events. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Add a Kconfig menu for clock configuration, to make the menu nicer. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Add a Kconfig menu for BLE configuration, to make the menu nicer. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Rework the functions in nrf_sdh_ble and nrf_sdh_soc that mapped BLE and SOC events to their stringified version to make them public and align their names. Instead of printing "unknown" if the event is not known, default to printing its numerical value in hexadecimal. That is also the default behavior if CONFIG_NRF_SDH_STR_TABLES is unset, and the table is not compiled. This is better than toggling the availability of the whole function, because we avoid conditional compilation around it. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Update the assert message at the end of the polling loops to print which kind of event we failed to pull, e.g. SoC or BLE. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

There is no reason for this API to be in this library. It could be added to a dedicated library later to avoid having to rely on DT macros to retrieve this information. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

There was a distinction between observers that could stop the SoftDevice state changes, and those that didn't. The former were called "request observers" and the latter "state observers". Since both observers are interested in the SoftDevice state, this commit merges the two, keeping only "state observers", for the purpose of simplifying things a bit. Now, state observers can return non-zero to these events: - NRF_SDH_STATE_EVT_ENABLE_PREPARE and - NRF_SDH_STATE_EVT_DISABLE_PREPARE to halt the state change. The return value from the observer is ignored for other events. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

These can return -EBUSY, which was missing. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

This patch moves the state observers into RAM and adds a new field `is_busy` that is used to maintain their busy state when a request to change the SoftDevice state is made. That is used to avoid sending the _PREPARE event multiple times to the same observer. The new function nrf_sdh_observer_ready() inspects the state of all observers and dispatches the events only to non-ready observers, differently from nrf_sdh_request_continue() which sent the events to all observers unconditionally instead. When the last observer makes itself ready, the SoftDevice state change takes place (from within nrf_sdh_observer_ready()). Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Use the native SoftDevice function sd_softdevice_is_enabled() instead. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Only check if the SoftDevice handler is suspended, not if the SoftDevice is enabled. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Rename an internal variable. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

Remove these, and force users to put a semicolon themselves. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

CLAassistant · 2025-11-14T14:08:52Z

All committers have signed the CLA.

lemrey · 2025-11-17T10:25:57Z

@nrfconnect/ncs-bm-test @nrfconnect/ncs-eris please have a look.

lemrey · 2025-12-10T08:11:58Z

Added documentation to #515

lemrey requested review from a team as code owners September 23, 2025 12:38

lemrey requested a review from a team September 23, 2025 12:39

github-actions Bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Sep 23, 2025

lemrey force-pushed the sdh branch 4 times, most recently from b6616a3 to 9cf07f8 Compare September 24, 2025 07:06

lemrey requested a review from a team as a code owner September 24, 2025 07:06

lemrey force-pushed the sdh branch 3 times, most recently from 5fd1e4e to 749680f Compare September 24, 2025 09:53

anhmolt reviewed Oct 1, 2025

View reviewed changes

nordicjm requested changes Oct 2, 2025

View reviewed changes

lemrey force-pushed the sdh branch 3 times, most recently from 5032ba2 to 381bff5 Compare October 3, 2025 12:54

lemrey requested a review from a team as a code owner October 3, 2025 12:54

github-actions Bot added the doc-required PR must not be merged without tech writer approval. label Oct 3, 2025

eivindj-nordic reviewed Oct 3, 2025

View reviewed changes

MirkoCovizzi reviewed Oct 3, 2025

View reviewed changes

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

b-gent approved these changes Oct 29, 2025

View reviewed changes

b-gent added the doc-postponed PR requires documentation updates, tech writer review happens later. label Oct 29, 2025

lemrey force-pushed the sdh branch from 381bff5 to 79e7931 Compare November 5, 2025 09:25

lemrey requested a review from a team as a code owner November 5, 2025 09:25

lemrey force-pushed the sdh branch from 79e7931 to 4689244 Compare November 5, 2025 09:55

anhmolt approved these changes Nov 10, 2025

View reviewed changes

nordicjm approved these changes Nov 11, 2025

View reviewed changes

MirkoCovizzi approved these changes Nov 11, 2025

View reviewed changes

lemrey added 16 commits November 14, 2025 15:01

doc: add an entry for sdh

9eadf54

Add a placeholder entry for sdh to be able to reference it in the changelog. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: ble: add GATTS and GATTC event strings to the table

0505301

Add GATTS and GATTC event strings to the table. Renamed gap_evt_tostr() to ble_evt_tostr() to reflect that it now can print all BLE events. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: add a menu for clock configuration

8cf8ae9

Add a Kconfig menu for clock configuration, to make the menu nicer. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: add a menu for BLE configuration

2dc78b4

Add a Kconfig menu for BLE configuration, to make the menu nicer. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: update the assert message in the polling loop

1bfd55b

Update the assert message at the end of the polling loops to print which kind of event we failed to pull, e.g. SoC or BLE. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: remove nrf_sdh_ble_app_ram_start_get()

6c82668

There is no reason for this API to be in this library. It could be added to a dedicated library later to avoid having to rely on DT macros to retrieve this information. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: update the doxygen for _enable_request() and _disable_request()

c66dbac

These can return -EBUSY, which was missing. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: remove nrf_sdh_is_enabled()

834b86e

Use the native SoftDevice function sd_softdevice_is_enabled() instead. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: let nrf_sdh_is_suspended() only check for sdh state

aaa4da7

Only check if the SoftDevice handler is suspended, not if the SoftDevice is enabled. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: rename variable

9539338

Rename an internal variable. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

sdh: remove semicolons at the end of observer macros

96f5f71

Remove these, and force users to put a semicolon themselves. Signed-off-by: Emanuele Di Santo <emdi@nordicsemi.no>

lemrey force-pushed the sdh branch from ce8ccb0 to 96f5f71 Compare November 14, 2025 14:08

github-actions Bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Nov 14, 2025

nvlsianpu approved these changes Nov 17, 2025

View reviewed changes

lemrey merged commit 48e721c into nrfconnect:main Nov 17, 2025
12 checks passed

lemrey mentioned this pull request Nov 18, 2025

tests: lib: bluetooth: add ble_conn_params unit tests #480

Merged

lemrey removed the doc-postponed PR requires documentation updates, tech writer review happens later. label Dec 10, 2025

lemrey mentioned this pull request Dec 12, 2025

softdevice_handler: correct return type of sdh_state_evt_observer_notify #578

Merged


		/* Helper macros to check for equality */

		#define _NRF_SDH_OBSERVER_PRIO_HIGHEST_HIGHEST 1

	(void) sd_softdevice_is_enabled(&sd_is_enabled);
	(void)sd_softdevice_is_enabled(&sd_is_enabled);

	* The ``NRF_SDH_BLE`` Kconfig option.
	* The ``CONFIG_NRF_SDH_BLE`` Kconfig option.

	const char *ble_evt_tostr(int evt)
	const char *ble_evt_to_str(int evt)

	* Five priority levels are defined: highest, high, user, user low, lowest.
	* Five priority levels are defined: highest, high, user, user low, and lowest.

Conversation

lemrey commented Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 23, 2025

Uh oh!

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!

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!

lemrey commented Oct 3, 2025

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!

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!

eivindj-nordic commented Oct 21, 2025

Uh oh!

b-gent left a comment

Choose a reason for hiding this comment

Uh oh!

lemrey commented Nov 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CLAassistant commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lemrey commented Nov 17, 2025

Uh oh!

Uh oh!

lemrey commented Dec 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

lemrey commented Sep 23, 2025 •

edited

Loading

CLAassistant commented Nov 14, 2025 •

edited

Loading