samples: bluetooth: ble_nus: add LPUARTE support

Add support for LPUARTE to NUS sample.

Co-authored-by: Andreas Moltumyr <[email protected]>
Signed-off-by: Eivind Jølsgard <[email protected]>

Author: eivindj-nordic

samples/bluetooth/ble_nus/Kconfig

@@ -6,19 +6,28 @@
 
 menu "BLE NUS sample"
 
-config BLE_UART_IRQ_PRIO
+config NUS_UART_IRQ_PRIO
 	int "BLE UART IRQ priority"
 	default 3
 
-config CONFIG_BLE_UART_PARITY
+config NUS_UART_PARITY
 	bool "BLE UART use parity"
 
-config BLE_UART_HWFC
-	bool "BLE UART use HWFC"
+config NUS_LPUARTE
+	bool "NUS Low Power UARTE"
+
+if NUS_LPUARTE
 
-if BLE_UART_HWFC
+config GPIOTE_IRQ_PRIO
+	int "GPIOTE IRQ priority"
+	default 3
 
-endif #BLE_UART_HWFC
+endif #BLE_LPUART
+
+config NUS_UART_HWFC
+	bool "BLE UART use HWFC"
+	depends on !NUS_LPUARTE
+	default y
 
 endmenu # "BLE NUS sample"
 

samples/bluetooth/ble_nus/README.rst

@@ -60,12 +60,24 @@ This sample can be found under :file:`samples/bluetooth/ble_nus/` in the |BMshor
 
 .. include:: /includes/program_sample.txt
 
+Building and running with LPUARTE
+*********************************
+
+The **overlay-lpuarte.conf** file configures the sample to use the :ref:`lpuarte` driver for the NUS Service.
+This is useful to reduce power consumption.
+The overlay must be added to the build configuration is VS Code or as an extra argument to west: ``-DEXTRA_CONF_FILE="overlay-lpuarte.conf"``.
+
+To test the NUS sample with the :ref:`lpuarte` driver in loopback mode, connect pin ``P1.08`` (REQ) with ``P1.09`` (RDY) and ``P1.10`` (RX) with ``P1.11`` (TX) on the nRF54L15DK as given in the ``board-config.h``.
+It is also possible to test between two devices running NUS with LPUART by connecting the above mentioned pins and ``GND`` between the devices.
+Make sure the ``REQ`` pin on one bord is connected to the ``RDY`` on the other board, and vice versa.
+
 Testing
 =======
 
 1. Compile and program the application.
 #. Connect the device to the computer to access UART 0 and UART 1.
    If you use a development kit, UART 0 and 1 are forwarded as COM ports (Windows) or ttyACM devices (Linux) after you connect the development kit over USB.
+   One instance is used for logging (if enabled), the other for the NUS service.
 #. Connect to the kit with a terminal emulator (for example, the `Serial Terminal app`_) to both UARTs.
 #. Reset the kit.
 #. Observe that the device is advertising under the default name ``nRF_BM_NUS``.

samples/bluetooth/ble_nus/overlay-lpuarte.conf

@@ -0,0 +1,8 @@
+# This file enables Low Power UARTE (LPUARTE) driver for the NUS UART instance.
+CONFIG_BM_SW_LPUARTE=y
+CONFIG_BM_TIMER=y
+
+CONFIG_NUS_LPUARTE=y
+
+# Set number of event handlers used by the LPUART driver
+CONFIG_NRFX_GPIOTE_NUM_OF_EVT_HANDLERS=2

samples/bluetooth/ble_nus/prj.conf

@@ -14,7 +14,6 @@ CONFIG_BLE_CONN_PARAMS=y
 
 # Nordic UART service
 CONFIG_BLE_NUS=y
-CONFIG_BLE_UART_HWFC=y
 
 # NUS depends on the Queued Writes module
 CONFIG_BLE_QWR=y

samples/bluetooth/ble_nus/sample.yaml

@@ -4,17 +4,29 @@ tests:
   sample.ble_nus:
     build_only: true
     integration_platforms:
+      - bm_nrf54l15dk/nrf54l05/cpuapp/s115_softdevice/mcuboot
+      - bm_nrf54l15dk/nrf54l10/cpuapp/s115_softdevice
+      - bm_nrf54l15dk/nrf54l15/cpuapp/s115_softdevice
+    platform_allow:
       - bm_nrf54l15dk/nrf54l05/cpuapp/s115_softdevice
       - bm_nrf54l15dk/nrf54l10/cpuapp/s115_softdevice
       - bm_nrf54l15dk/nrf54l15/cpuapp/s115_softdevice
       - bm_nrf54l15dk/nrf54l05/cpuapp/s115_softdevice/mcuboot
       - bm_nrf54l15dk/nrf54l10/cpuapp/s115_softdevice/mcuboot
       - bm_nrf54l15dk/nrf54l15/cpuapp/s115_softdevice/mcuboot
+    tags: ci_build
+  sample.ble_nus.lpuarte:
+    build_only: true
+    integration_platforms:
+      - bm_nrf54l15dk/nrf54l05/cpuapp/s115_softdevice/mcuboot
+      - bm_nrf54l15dk/nrf54l10/cpuapp/s115_softdevice
+      - bm_nrf54l15dk/nrf54l15/cpuapp/s115_softdevice
     platform_allow:
       - bm_nrf54l15dk/nrf54l05/cpuapp/s115_softdevice
       - bm_nrf54l15dk/nrf54l10/cpuapp/s115_softdevice
       - bm_nrf54l15dk/nrf54l15/cpuapp/s115_softdevice
       - bm_nrf54l15dk/nrf54l05/cpuapp/s115_softdevice/mcuboot
       - bm_nrf54l15dk/nrf54l10/cpuapp/s115_softdevice/mcuboot
       - bm_nrf54l15dk/nrf54l15/cpuapp/s115_softdevice/mcuboot
+    extra_args: EXTRA_CONF_FILE="overlay-lpuarte.conf"
     tags: ci_build

samples/bluetooth/ble_nus/src/main.c

@@ -19,6 +19,10 @@
 #include <zephyr/logging/log_ctrl.h>
 #include <zephyr/sys/util.h>
 
+#if defined(CONFIG_NUS_LPUARTE)
+#include <bm_lpuarte.h>
+#endif
+
 #include <board-config.h>
 
 LOG_MODULE_REGISTER(app, CONFIG_BLE_NUS_SAMPLE_LOG_LEVEL);
@@ -30,16 +34,32 @@ BLE_QWR_DEF(ble_qwr); /* BLE QWR instance */
 /** Handle of the current connection. */
 static uint16_t conn_handle = BLE_CONN_HANDLE_INVALID;
 
-/** NUS UARTE instance */
-static const nrfx_uarte_t uarte_inst = NRF_UARTE_INST_GET(BOARD_APP_UARTE_INST);
+/** NUS UARTE instance and board config */
+#if defined(CONFIG_NUS_LPUARTE)
+#define NUS_UARTE_INST BOARD_APP_LPUARTE_INST
+#define NUS_UARTE_PIN_TX BOARD_APP_LPUARTE_PIN_TX
+#define NUS_UARTE_PIN_RX BOARD_APP_LPUARTE_PIN_RX
+#define NUS_UARTE_PIN_RDY BOARD_APP_LPUARTE_PIN_RDY
+#define NUS_UARTE_PIN_REQ BOARD_APP_LPUARTE_PIN_REQ
+
+struct bm_lpuarte lpu;
+#else
+#define NUS_UARTE_INST BOARD_APP_UARTE_INST
+#define NUS_UARTE_PIN_TX BOARD_APP_UARTE_PIN_TX
+#define NUS_UARTE_PIN_RX BOARD_APP_UARTE_PIN_RX
+#define NUS_UARTE_PIN_CTS BOARD_APP_UARTE_PIN_CTS
+#define NUS_UARTE_PIN_RTS BOARD_APP_UARTE_PIN_RTS
+
+static const nrfx_uarte_t nus_uarte_inst = NRFX_UARTE_INSTANCE(NUS_UARTE_INST);
+#endif /* CONFIG_NUS_LPUARTE */
 
 /* Maximum length of data (in bytes) that can be transmitted to the peer by the
  * Nordic UART service module.
  */
 static volatile uint16_t ble_nus_max_data_len = BLE_NUS_MAX_DATA_LEN_CALC(BLE_GATT_ATT_MTU_DEFAULT);
 
 /* Receive buffer used in UART ISR callback */
-static uint8_t uarte_rx_buf[4];
+static uint8_t uarte_rx_buf[IS_ENABLED(CONFIG_NUS_LPUARTE) ? 128 : 2];
 static int buf_idx;
 
 /**
@@ -48,6 +68,26 @@ static int buf_idx;
  * @param[in] data Data received.
  * @param[in] data_len Size of data.
  */
+#if defined(CONFIG_NUS_LPUARTE)
+static void lpuarte_rx_handler(char *data, size_t data_len)
+{
+	int 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);
+			return;
+		}
+	} while (err == -EAGAIN);
+}
+#else
 static void uarte_rx_handler(char *data, size_t data_len)
 {
 	int err;
@@ -96,6 +136,7 @@ static void uarte_rx_handler(char *data, size_t data_len)
 		}
 	}
 }
+#endif
 
 /**
  * @brief UARTE event handler
@@ -107,18 +148,28 @@ static void uarte_evt_handler(nrfx_uarte_event_t const *event, void *ctx)
 {
 	switch (event->type) {
 	case NRFX_UARTE_EVT_RX_DONE:
-		LOG_DBG("Received data from UART: %c", event->data.rx.p_buffer[0]);
+		LOG_DBG("Received data from UART: %.*s (%d)",
+			event->data.rx.length, event->data.rx.p_buffer, event->data.rx.length);
 		if (event->data.rx.length > 0) {
+#if defined(CONFIG_NUS_LPUARTE)
+			lpuarte_rx_handler(event->data.rx.p_buffer, event->data.rx.length);
+#else
 			uarte_rx_handler(event->data.rx.p_buffer, event->data.rx.length);
+#endif
 		}
 
-		nrfx_uarte_rx_enable(&uarte_inst, 0);
+#if !defined(CONFIG_NUS_LPUARTE)
+		nrfx_uarte_rx_enable(&nus_uarte_inst, 0);
+#endif
 		break;
 	case NRFX_UARTE_EVT_RX_BUF_REQUEST:
-		nrfx_uarte_rx_buffer_set(&uarte_inst, &uarte_rx_buf[buf_idx], 1);
+#if defined(CONFIG_NUS_LPUARTE)
+		bm_lpuarte_rx_buffer_set(&lpu, &uarte_rx_buf[buf_idx * 64], 64);
+#else
+		nrfx_uarte_rx_buffer_set(&nus_uarte_inst, &uarte_rx_buf[buf_idx], 1);
+#endif
 
-		buf_idx++;
-		buf_idx = (buf_idx < sizeof(uarte_rx_buf)) ? buf_idx : 0;
+		buf_idx = buf_idx ? 0 : 1;
 		break;
 	case NRFX_UARTE_EVT_ERROR:
 		LOG_ERR("uarte error %#x", event->data.error.error_mask);
@@ -264,20 +315,36 @@ uint16_t ble_qwr_evt_handler(struct ble_qwr *qwr, const struct ble_qwr_evt *qwr_
 static void ble_nus_evt_handler(const struct ble_nus_evt *evt)
 {
 	const char newline = '\n';
+	uint32_t err;
 
 	if (evt->type != BLE_NUS_EVT_RX_DATA) {
 		return;
 	}
 
 	/* Handle incoming data */
-	LOG_DBG("Received data from BLE NUS: %s", evt->params.rx_data.data);
+	LOG_DBG("Received data from BLE NUS: %.*s (%d)",
+		evt->params.rx_data.length, evt->params.rx_data.data, evt->params.rx_data.length);
 
-	for (uint32_t i = 0; i < evt->params.rx_data.length; i++) {
-		nrfx_uarte_tx(&uarte_inst, &evt->params.rx_data.data[i], 1, NRFX_UARTE_TX_BLOCKING);
+#if defined(CONFIG_NUS_LPUARTE)
+	err = bm_lpuarte_tx(&lpu, evt->params.rx_data.data, evt->params.rx_data.length, 3000);
+	if (err != NRFX_SUCCESS) {
+		LOG_ERR("bm_lpuarte_tx failed, nrfx_err %#x", err);
 	}
+#else
+		err = nrfx_uarte_tx(&nus_uarte_inst, evt->params.rx_data.data,
+				    evt->params.rx_data.length, NRFX_UARTE_TX_BLOCKING);
+		if (err != NRFX_SUCCESS) {
+			LOG_ERR("nrfx_uarte_tx failed, nrfx_err %#x", err);
+		}
+#endif
+
 
 	if (evt->params.rx_data.data[evt->params.rx_data.length - 1] == '\r') {
-		nrfx_uarte_tx(&uarte_inst, &newline, 1, NRFX_UARTE_TX_BLOCKING);
+#if defined(CONFIG_NUS_LPUARTE)
+		bm_lpuarte_tx(&lpu, &newline, 1, 3000);
+#else
+		nrfx_uarte_tx(&nus_uarte_inst, &newline, 1, NRFX_UARTE_TX_BLOCKING);
+#endif
 	}
 }
 
@@ -287,33 +354,62 @@ static void ble_nus_evt_handler(const struct ble_nus_evt *evt)
 static int uarte_init(void)
 {
 	int err;
+	nrfx_uarte_config_t *uarte_cfg;
+#if defined(CONFIG_NUS_LPUARTE)
+	struct bm_lpuarte_config lpu_cfg = {
+		.uarte_inst = NRFX_UARTE_INSTANCE(NUS_UARTE_INST),
+		.uarte_cfg = NRFX_UARTE_DEFAULT_CONFIG(NUS_UARTE_PIN_TX,
+						       NUS_UARTE_PIN_RX),
+		.req_pin = BOARD_APP_LPUARTE_PIN_REQ,
+		.rdy_pin = BOARD_APP_LPUARTE_PIN_RDY,
+	};
 
-	nrfx_uarte_config_t uarte_config = NRFX_UARTE_DEFAULT_CONFIG(BOARD_APP_UARTE_PIN_TX,
-								     BOARD_APP_UARTE_PIN_RX);
+	uarte_cfg = &lpu_cfg.uarte_cfg;
+#else
+	nrfx_uarte_config_t uarte_config = NRFX_UARTE_DEFAULT_CONFIG(NUS_UARTE_PIN_TX,
+								     NUS_UARTE_PIN_RX);
 
-#if defined(CONFIG_BLE_UART_HWFC)
-	uarte_config.config.hwfc = NRF_UARTE_HWFC_ENABLED;
-	uarte_config.cts_pin = BOARD_APP_UARTE_PIN_CTS;
-	uarte_config.rts_pin = BOARD_APP_UARTE_PIN_RTS;
-#endif
+	uarte_cfg = &uarte_config;
 
-#if defined(CONFIG_BLE_UART_PARITY)
-	uarte_config.parity = NRF_UARTE_PARITY_INCLUDED;
+#if defined(CONFIG_NUS_UART_HWFC)
+	uarte_cfg->config.hwfc = NRF_UARTE_HWFC_ENABLED;
+	uarte_cfg->cts_pin = NUS_UARTE_PIN_CTS;
+	uarte_cfg->rts_pin = NUS_UARTE_PIN_RTS;
+#endif /* CONFIG_NUS_UART_HWFC */
+#endif /* CONFIG_NUS_LPUARTE */
+
+#if defined(CONFIG_NUS_UART_PARITY)
+	uarte_cfg->parity = NRF_UARTE_PARITY_INCLUDED;
 #endif
 
-	uarte_config.interrupt_priority = CONFIG_BLE_UART_IRQ_PRIO;
+	uarte_cfg->interrupt_priority = CONFIG_NUS_UART_IRQ_PRIO;
 
 	/** We need to connect the IRQ ourselves. */
-	IRQ_CONNECT(NRFX_IRQ_NUMBER_GET(NRF_UARTE_INST_GET(BOARD_APP_UARTE_INST)), CONFIG_BLE_UART_IRQ_PRIO,
-		    NRFX_UARTE_INST_HANDLER_GET(BOARD_APP_UARTE_INST), 0, 0);
 
-	irq_enable(NRFX_IRQ_NUMBER_GET(NRF_UARTE_INST_GET(BOARD_APP_UARTE_INST)));
+	IRQ_CONNECT(NRFX_IRQ_NUMBER_GET(NRF_UARTE_INST_GET(NUS_UARTE_INST)),
+		    CONFIG_NUS_UART_IRQ_PRIO, NRFX_UARTE_INST_HANDLER_GET(NUS_UARTE_INST), 0, 0);
+
+	irq_enable(NRFX_IRQ_NUMBER_GET(NRF_UARTE_INST_GET(NUS_UARTE_INST)));
 
-	err = nrfx_uarte_init(&uarte_inst, &uarte_config, uarte_evt_handler);
+#if defined(CONFIG_NUS_LPUARTE)
+	IRQ_CONNECT(NRFX_IRQ_NUMBER_GET(NRF_GPIOTE_INST_GET(20)) + NRF_GPIOTE_IRQ_GROUP,
+		    CONFIG_GPIOTE_IRQ_PRIO, NRFX_GPIOTE_INST_HANDLER_GET(20), 0, 0);
+
+	IRQ_CONNECT(NRFX_IRQ_NUMBER_GET(NRF_GPIOTE_INST_GET(30)) + NRF_GPIOTE_IRQ_GROUP,
+		    CONFIG_GPIOTE_IRQ_PRIO, NRFX_GPIOTE_INST_HANDLER_GET(30), 0, 0);
+
+	err = bm_lpuarte_init(&lpu, &lpu_cfg, uarte_evt_handler);
 	if (err != NRFX_SUCCESS) {
 		LOG_ERR("Failed to initialize UART, nrfx err %d", err);
 		return err;
 	}
+#else
+	err = nrfx_uarte_init(&nus_uarte_inst, &uarte_config, uarte_evt_handler);
+	if (err != NRFX_SUCCESS) {
+		LOG_ERR("Failed to initialize UART, nrfx err %d", err);
+		return err;
+	}
+#endif /* CONFIG_NUS_LPUARTE */
 
 	return 0;
 }
@@ -395,18 +491,25 @@ int main(void)
 		goto idle;
 	}
 
+#if defined(CONFIG_NUS_LPUARTE)
+	err = bm_lpuarte_rx_enable(&lpu);
+	if (err != NRFX_SUCCESS) {
+		LOG_ERR("UART RX failed, nrfx err %d", err);
+	}
+#else
 	const uint8_t out[] = "UART started.\r\n";
 
-	err = nrfx_uarte_tx(&uarte_inst, out, sizeof(out), NRFX_UARTE_TX_BLOCKING);
+	err = nrfx_uarte_tx(&nus_uarte_inst, out, sizeof(out), NRFX_UARTE_TX_BLOCKING);
 	if (err != NRFX_SUCCESS) {
 		LOG_ERR("UARTE TX failed, nrfx err %d", err);
-		goto idle;
+		return -1;
 	}
 
-	err = nrfx_uarte_rx_enable(&uarte_inst, 0);
+	err = nrfx_uarte_rx_enable(&nus_uarte_inst, 0);
 	if (err != NRFX_SUCCESS) {
 		LOG_ERR("UART RX failed, nrfx err %d", err);
 	}
+#endif
 
 	err = ble_adv_start(&ble_adv, BLE_ADV_MODE_FAST);
 	if (err) {
@@ -415,9 +518,6 @@ int main(void)
 	}
 
 	LOG_INF("Advertising as %s", CONFIG_BLE_ADV_NAME);
-#if defined(CONFIG_SOC_SERIES_NRF54LX)
-	LOG_INF("The NUS service is handled at a separate uart instance");
-#endif
 
 idle:
 	while (true) {