lib: add ble_radio_notification and sample

Add ble_radio_notification library and sample.

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

Author: eivindj-nordic

CODEOWNERS

@@ -49,6 +49,7 @@
 /lib/ble_gq/                              @nrfconnect/ncs-bm
 /lib/ble_qwr/                             @nrfconnect/ncs-bm
 /lib/ble_racp/                            @nrfconnect/ncs-bm
+/lib/ble_radio_notification/              @nrfconnect/ncs-bm
 /lib/bm_buttons/                          @nrfconnect/ncs-bm
 /lib/bm_storage/                          @nrfconnect/ncs-bm
 /lib/bm_timer/                            @nrfconnect/ncs-bm
@@ -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
 /tests/lib/ble_adv/                       @nrfconnect/ncs-bm-test
 /tests/lib/bm_storage/                    @nrfconnect/ncs-bm
 

doc/nrf-bm/api/api.rst

@@ -42,6 +42,12 @@ Advertising and Scan Response Data Encoder
 .. doxygengroup:: ble_sdk_lib_advdata
    :inner:
 
+Bluetooth LE Radio Notification library
+=======================================
+
+.. doxygengroup:: ble_radio_notification
+   :inner:
+
 Bare Metal Zephyr Memory Storage (ZMS)
 ======================================
 

doc/nrf-bm/libraries/ble_radio_notification.rst

@@ -0,0 +1,52 @@
+.. _lib_ble_radio_notification:
+
+Bluetooth: Radio Notification
+#############################
+
+.. contents::
+   :local:
+   :depth: 2
+
+The Bluetooth Low Energy® Radio Notification library allows the user to subscribe to the Radio Notification signal to receive notification prior to and after radio events.
+
+Overview
+********
+
+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.
+
+Configuration
+*************
+
+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.
+
+Initialization
+==============
+
+The library is initialized by calling the :c:func:`ble_radio_notification_init` function.
+
+Usage
+*****
+
+Initialize the library by calling the :c:func:`ble_radio_notification_init` function, specifying the event handler to receive the Radio Notification signal.
+You can specify the distance in microseconds between the Radio Notification signal and the start of the radio event.
+This event has ``active_state`` set to ``true``.
+A new Radio Notification signal will be raised when the radio event completes with ``active_state`` set to ``false``.
+
+Dependencies
+************
+
+This library uses the following |BMshort| libraries:
+
+* SoftDevice - :kconfig:option:`CONFIG_SOFTDEVICE`
+* SoftDevice handler - :kconfig:option:`CONFIG_NRF_SDH`
+
+API documentation
+*****************
+
+| Header file: :file:`include/ble_radio_notification.h`
+| Source files: :file:`lib/ble_radio_notification/`
+
+   .. doxygengroup:: ble_radio_notification

doc/nrf-bm/release_notes/release_notes_changelog.rst

@@ -52,15 +52,15 @@ No changes since the latest nRF Connect SDK Bare Metal release.
 Libraries
 =========
 
-No changes since the latest nRF Connect SDK Bare Metal release.
+Added the :ref:`lib_ble_radio_notification` library.
 
 Samples
 =======
 
 Bluetooth samples
 -----------------
 
-No changes since the latest nRF Connect SDK Bare Metal release.
+Added the :ref:`ble_radio_ntf_sample` sample.
 
 Peripheral samples
 ------------------

include/ble_radio_notification.h

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2018-2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+/** @file
+ *
+ * @defgroup ble_radio_notification Radio Notification Event Handler
+ *
+ * @brief Module for propagating Radio Notification events to the application.
+ */
+
+#ifndef BLE_RADIO_NOTIFICATION_H__
+#define BLE_RADIO_NOTIFICATION_H__
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <nrf_soc.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/** @brief Application radio notification event handler type. */
+typedef void (*ble_radio_notification_evt_handler_t)(bool radio_active);
+
+/**
+ * @brief Function for initializing the Radio Notification module.
+ *
+ * @param[in]  distance    Distance between the ACTIVE notification signal and start of radio event.
+ * @param[in]  evt_handler Handler to be executed when a radio notification event has been received.
+ *
+ * @return NRF_SUCCESS on successful initialization, otherwise an error code.
+ */
+uint32_t ble_radio_notification_init(uint32_t distance,
+				     ble_radio_notification_evt_handler_t evt_handler);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* BLE_RADIO_NOTIFICATION_H__ */
+
+/** @} */

lib/CMakeLists.txt

@@ -8,6 +8,7 @@ add_subdirectory_ifdef(CONFIG_BLE_ADV ble_adv)
 add_subdirectory_ifdef(CONFIG_BLE_CONN_PARAMS ble_conn_params)
 add_subdirectory_ifdef(CONFIG_BLE_GATT_QUEUE ble_gq)
 add_subdirectory_ifdef(CONFIG_BLE_RACP ble_racp)
+add_subdirectory_ifdef(CONFIG_BLE_RADIO_NOTIFICATION ble_radio_notification)
 add_subdirectory_ifdef(CONFIG_EVENT_SCHEDULER event_scheduler)
 add_subdirectory_ifdef(CONFIG_BM_BUTTONS bm_buttons)
 add_subdirectory_ifdef(CONFIG_BM_STORAGE bm_storage)

lib/Kconfig

@@ -9,6 +9,7 @@ rsource "ble_adv/Kconfig"
 rsource "ble_conn_params/Kconfig"
 rsource "ble_gq/Kconfig"
 rsource "ble_racp/Kconfig"
+rsource "ble_radio_notification/Kconfig"
 rsource "event_scheduler/Kconfig"
 rsource "bm_buttons/Kconfig"
 rsource "bm_storage/Kconfig"

lib/ble_radio_notification/CMakeLists.txt

@@ -0,0 +1,7 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+zephyr_library()
+zephyr_library_sources(ble_radio_notification.c)

lib/ble_radio_notification/Kconfig

@@ -0,0 +1,38 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+menuconfig BLE_RADIO_NOTIFICATION
+	bool "BLE Radio Notification"
+
+if BLE_RADIO_NOTIFICATION
+
+choice BLE_RADIO_NOTIFICATION_TYPE
+	prompt "Radio notification type"
+	default BLE_RADIO_NOTIFICATION_ON_BOTH
+
+config BLE_RADIO_NOTIFICATION_ON_ACTIVE
+	bool "on active"
+
+config BLE_RADIO_NOTIFICATION_ON_INACTIVE
+	bool "on inactive"
+
+config BLE_RADIO_NOTIFICATION_ON_BOTH
+	bool "on both active and inactive"
+
+endchoice # BLE_RADIO_NOTIFICATION_TYPE
+
+config BLE_RADIO_NOTIFICATION_IRQ_PRIO
+	int "Radio Notification IRQ priority"
+	default 3
+	help
+	   IRQ Priority level 0 and 4 are reserved by the SoftDevice.
+
+
+module=BLE_RADIO_NTF
+module-dep=LOG
+module-str=BLE Radio Notification
+source "$(ZEPHYR_BASE)/subsys/logging/Kconfig.template.log_config"
+
+endif # BLE_RADIO_NOTIFICATION

lib/ble_radio_notification/ble_radio_notification.c

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2018-2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include <errno.h>
+#include <stdlib.h>
+
+#include <ble_radio_notification.h>
+#include <zephyr/logging/log.h>
+
+#if CONFIG_UNITY
+#include <cmsis.h>
+#define STATIC
+#else
+#define STATIC static
+#endif
+
+LOG_MODULE_REGISTER(ble_radio_ntf, CONFIG_BLE_RADIO_NTF_LOG_LEVEL);
+
+/* Current radio state. */
+#if CONFIG_BLE_RADIO_NOTIFICATION_ON_ACTIVE
+static bool radio_active = true;
+#else
+static bool radio_active;
+#endif
+/* Application event handler for handling Radio Notification events. */
+static ble_radio_notification_evt_handler_t evt_handler;
+
+STATIC void radio_notification_isr(const void *arg)
+{
+	ARG_UNUSED(arg);
+
+#if defined CONFIG_BLE_RADIO_NOTIFICATION_ON_BOTH
+	radio_active = !radio_active;
+#endif
+
+	if (evt_handler != NULL) {
+		evt_handler(radio_active);
+	}
+}
+
+uint32_t ble_radio_notification_init(uint32_t distance,
+				     ble_radio_notification_evt_handler_t _evt_handler)
+{
+	uint8_t type = NRF_RADIO_NOTIFICATION_TYPE_INT_ON_BOTH;
+
+#if defined(CONFIG_BLE_RADIO_NOTIFICATION_ON_ACTIVE)
+	type = NRF_RADIO_NOTIFICATION_TYPE_INT_ON_ACTIVE;
+#elif defined(CONFIG_BLE_RADIO_NOTIFICATION_ON_INACTIVE)
+	type = NRF_RADIO_NOTIFICATION_TYPE_INT_ON_INACTIVE;
+#endif
+
+	evt_handler = _evt_handler;
+
+	/* Initialize Radio Notification software interrupt */
+	IRQ_DIRECT_CONNECT(RADIO_NOTIFICATION_IRQn, CONFIG_BLE_RADIO_NOTIFICATION_IRQ_PRIO,
+			   radio_notification_isr, 0);
+
+	NVIC_ClearPendingIRQ(RADIO_NOTIFICATION_IRQn);
+	NVIC_EnableIRQ(RADIO_NOTIFICATION_IRQn);
+
+	return sd_radio_notification_cfg_set(type, distance);
+}