lib: add ble_radio_notification and sample #351

eivindj-nordic · 2025-09-02T08:54:37Z

Add ble_radio_notification library and sample.

github-actions · 2025-09-02T08:55:46Z

You can find the documentation preview for this PR here.

vegardgu · 2025-09-02T12:19:00Z

CODEOWNERS

@@ -89,6 +90,7 @@
 /tests/lib/bm_zms/                        @nrfconnect/ncs-bm @rghaddab
 /tests/lib/ble_qwr/                       @nrfconnect/ncs-bm
 /tests/lib/ble_racp/                      @nrfconnect/ncs-bm
+tests/lib/ble_radio_notif/                @nrfconnect/ncs-bm


Suggested change

tests/lib/ble_radio_notif/ @nrfconnect/ncs-bm

/tests/lib/ble_radio_notif/ @nrfconnect/ncs-bm

Seems like the other ones start with /

yes, thanks

vegardgu · 2025-09-02T12:20:29Z

doc/nrf-bm/libraries/ble_radio_notification.rst

+Overview
+********
+
+The library allows the user to register a handler to receive the radio notifications and configure the distance in microseconds between the Radio Notification signal and the radio event.


Suggested change

The library allows the user to register a handler to receive the radio notifications and configure the distance in microseconds between the Radio Notification signal and the radio event.

The library allows the user to register a handler to receive the radio notifications and configure the distance in microseconds between the active Radio Notification signal and the radio event.

vegardgu · 2025-09-02T12:27:28Z

doc/nrf-bm/libraries/ble_radio_notification.rst

+The library is enabled and configured entirely using the Kconfig system.
+Set the :kconfig:option:`CONFIG_BLE_RADIO_NOTIFICATION` Kconfig option to enable the library.
+
+The library uses the ``SWI02`` IRQ. Use the :kconfig:option:`CONFIG_BLE_RADIO_NOTIFICATION_IRQ_PRIO` Kconfig option to set the IRQ priority.


I'm not sure this is the correct place to mention it, but some priority levels shall not be used.
This used to be documented in the SDS: https://docs.nordicsemi.com/bundle/sds_s140/page/SDS/s1xx/processor_avail_interrupt_latency/exception_mgmt_sd.html

Thanks, I think it can be documented in the Kconfig option at least.

vegardgu · 2025-09-02T12:29:18Z

lib/ble_radio_notification/Kconfig

+
+if BLE_RADIO_NOTIFICATION
+
+config BLE_RADIO_NOTIFICATION_IRQ_PRIO


Perhaps add a range that disallows 0?

Added a help text that level 0 and 4 is reserved by the SoftDevice.

vegardgu · 2025-09-02T12:33:04Z

lib/ble_radio_notification/ble_radio_notification.c

+	NVIC_ClearPendingIRQ(RADIO_NOTIFICATION_IRQn);
+	NVIC_EnableIRQ(RADIO_NOTIFICATION_IRQn);
+
+	return sd_radio_notification_cfg_set(NRF_RADIO_NOTIFICATION_TYPE_INT_ON_BOTH, distance);


This is a bit limiting. The library will only support generating both active and inactive notifications.
There are several use cases that would only need only active or inactive notification.

I think it would be better to allow the user to configure this with a config, that can select the different options for softdevice:

sdk-nrf-bm/components/softdevice/s115/s115_API/include/nrf_soc.h

Lines 187 to 189 in 97734f1

NRF_RADIO_NOTIFICATION_TYPE_INT_ON_ACTIVE, /**< Using interrupt for notification when the radio will be enabled. */

NRF_RADIO_NOTIFICATION_TYPE_INT_ON_INACTIVE, /**< Using interrupt for notification when the radio has been disabled. */

NRF_RADIO_NOTIFICATION_TYPE_INT_ON_BOTH, /**< Using interrupt for notification both when the radio will be enabled and disabled. */

It is a bit limiting indeed. This module mimics the behavior from nRF5 SDK. I can look into adding a Kconfig option for this, keeping the current behavior as the default.

If it is the same behavior as nRF5 SDK, it may be good as is. There is always the opportunity to use the SD interface directly if someone wants only active or inactive notifications.

Added Kconfig choice.

vegardgu · 2025-09-02T12:35:29Z

samples/bluetooth/ble_radio_notification/README.rst

+Building and running
+********************
+
+This sample can be found under :file:`samples/bluetooth/ble_hrs/` in the |BMshort| folder structure.


Suggested change

This sample can be found under :file:`samples/bluetooth/ble_hrs/` in the |BMshort| folder structure.

This sample can be found under :file:`samples/bluetooth/ble_radio_notification/` in the |BMshort| folder structure.

vegardgu · 2025-09-02T12:36:31Z

samples/bluetooth/ble_radio_notification/README.rst

+
+.. include:: /includes/softdevice_flash.txt
+
+.. _ble_hrs_sample_testing:


Suggested change

.. _ble_hrs_sample_testing:

.. _ble_radio_notification_sample_testing:

vegardgu · 2025-09-02T12:38:47Z

samples/bluetooth/ble_radio_notification/prj.conf

+CONFIG_NRF_SDH=y
+
+CONFIG_BLE_ADV=y
+CONFIG_BLE_ADV_NAME="nRF_BM_HRS"


Suggested change

CONFIG_BLE_ADV_NAME="nRF_BM_HRS"

CONFIG_BLE_ADV_NAME="nRF_BM_RADIO_NOTIFICATION"

Or an abbreviation

vegardgu · 2025-09-02T12:42:22Z

samples/bluetooth/ble_radio_notification/prj.conf

+CONFIG_BLE_ADV_NAME="nRF_BM_HRS"
+CONFIG_BLE_ADV_EXTENDED_ADVERTISING=n
+CONFIG_BLE_ADV_DIRECTED_ADVERTISING=n
+


Perhaps:

Suggested change

CONFIG_BLE_ADV_FAST_ADVERTISING_INTERVAL=400

CONFIG_BLE_ADV_SLOW_ADVERTISING_INTERVAL=1600

So it blinks at 4Hz, then 1 Hz. The default blinks a bit fast.

vegardgu · 2025-09-02T12:52:03Z

include/ble_radio_notification.h

+/**
+ * @brief Function for initializing the Radio Notification module.
+ *
+ * @param[in]  distance       The time from an Active event until the radio is activated.


The distance is from the active event until the SoftDevice does the preparation for the radio event.
The time between the preparation and the actual radio activity will vary depending on the role that is scheduled.

It is documented like this in the softdevice

sdk-nrf-bm/components/softdevice/s115/s115_API/include/nrf_soc.h

Lines 607 to 608 in 97734f1

* @param[in] distance_us Distance between the ACTIVE notification signal and start of radio event

* preparation by SoftDevice in microseconds.

Add ble_radio_notification library and sample. Signed-off-by: Eivind Jølsgard <[email protected]>

eivindj-nordic added this to the v0.9.0 milestone Sep 2, 2025

eivindj-nordic requested a review from vegardgu September 2, 2025 08:54

eivindj-nordic self-assigned this Sep 2, 2025

eivindj-nordic requested review from a team as code owners September 2, 2025 08:54

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 Sep 2, 2025

eivindj-nordic force-pushed the radio_notif branch from 74df57c to 2f5eb93 Compare September 2, 2025 08:55

eivindj-nordic force-pushed the radio_notif branch from 2f5eb93 to e110194 Compare September 2, 2025 08:59

eivindj-nordic requested a review from a team as a code owner September 2, 2025 08:59

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

eivindj-nordic force-pushed the radio_notif branch from e110194 to afdbe0a Compare September 2, 2025 10:08

vegardgu reviewed Sep 2, 2025

View reviewed changes

eivindj-nordic force-pushed the radio_notif branch 3 times, most recently from e5a75ba to 8c2a381 Compare September 2, 2025 14:08

lib: add ble_radio_notification and sample

974e8c4

Add ble_radio_notification library and sample. Signed-off-by: Eivind Jølsgard <[email protected]>

eivindj-nordic force-pushed the radio_notif branch from 8c2a381 to 974e8c4 Compare September 2, 2025 14:22

	tests/lib/ble_radio_notif/ @nrfconnect/ncs-bm
	/tests/lib/ble_radio_notif/ @nrfconnect/ncs-bm

	The library allows the user to register a handler to receive the radio notifications and configure the distance in microseconds between the Radio Notification signal and the radio event.
	The library allows the user to register a handler to receive the radio notifications and configure the distance in microseconds between the active Radio Notification signal and the radio event.


		if BLE_RADIO_NOTIFICATION

		config BLE_RADIO_NOTIFICATION_IRQ_PRIO

	NRF_RADIO_NOTIFICATION_TYPE_INT_ON_ACTIVE, /*< Using interrupt for notification when the radio will be enabled. /
	NRF_RADIO_NOTIFICATION_TYPE_INT_ON_INACTIVE, /*< Using interrupt for notification when the radio has been disabled. /
	NRF_RADIO_NOTIFICATION_TYPE_INT_ON_BOTH, /*< Using interrupt for notification both when the radio will be enabled and disabled. /

	This sample can be found under :file:`samples/bluetooth/ble_hrs/` in the \|BMshort\| folder structure.
	This sample can be found under :file:`samples/bluetooth/ble_radio_notification/` in the \|BMshort\| folder structure.


		.. include:: /includes/softdevice_flash.txt

		.. _ble_hrs_sample_testing:

	.. _ble_hrs_sample_testing:
	.. _ble_radio_notification_sample_testing:

	CONFIG_BLE_ADV_NAME="nRF_BM_HRS"
	CONFIG_BLE_ADV_NAME="nRF_BM_RADIO_NOTIFICATION"


	CONFIG_BLE_ADV_FAST_ADVERTISING_INTERVAL=400
	CONFIG_BLE_ADV_SLOW_ADVERTISING_INTERVAL=1600

	* @param[in] distance_us Distance between the ACTIVE notification signal and start of radio event
	* preparation by SoftDevice in microseconds.

lib: add ble_radio_notification and sample #351

Are you sure you want to change the base?

lib: add ble_radio_notification and sample #351

Uh oh!

Conversation

eivindj-nordic commented Sep 2, 2025

Uh oh!

github-actions bot commented Sep 2, 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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!