applications: nrf5340_audio: LED module for kits with other LED setup

The LED module is currently written in a way
that’s highly dependent on all of the LEDs present
on the audio DK, which prevents the application from
running on the nRF5340 DK. The module must be refactored
so that it can still show the state of the application with
a different selection of LEDs.

Signed-off-by: Graham Wacey <graham.wacey@nordicsemi.no>

Author: gWacey

applications/nrf5340_audio/boards/nrf5340_audio_dk_nrf5340_cpuapp.overlay

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include <dt-bindings/led/led.h>
+
+/ {
+	audioleds: audioleds {
+		compatible = "gpio-leds";
+		status = "okay";
+
+		led_device_type: led_device_type {
+			gpios = <&gpio0 7 GPIO_ACTIVE_HIGH>,
+					<&gpio0 25 GPIO_ACTIVE_HIGH>,
+					<&gpio0 26 GPIO_ACTIVE_HIGH>;
+			label = "RGB LED 0";
+		};
+
+		rgb2: rgb-2 {
+			gpios = <&gpio0 28 GPIO_ACTIVE_HIGH>,
+					<&gpio0 29 GPIO_ACTIVE_HIGH>,
+					<&gpio0 30 GPIO_ACTIVE_HIGH>;
+			label = "RGB LED 1";
+		};
+
+		led_conn_status: led_conn_status {
+			gpios = <&gpio0 31 GPIO_ACTIVE_HIGH>;
+			label = "Blue LED 0";
+		};
+
+		led_sync_status: led_sync_status {
+			gpios = <&gpio1 0 GPIO_ACTIVE_HIGH>;
+			label = "Green LED 0";
+		};
+
+		led_app_status: led_app_status {
+			gpios = <&gpio1 1 GPIO_ACTIVE_HIGH>;
+			label = "Green LED 1";
+		};
+	};
+};

applications/nrf5340_audio/boards/nrf5340_audio_dk_nrf5340_cpuapp_fota.overlay

@@ -1,3 +1,5 @@
+#include "nrf5340_audio_dk_nrf5340_cpuapp.overlay"
+
 / {
 	chosen {
 		nordic,pm-ext-flash = &mx25r64;
@@ -9,7 +11,9 @@
 };
 
 &spi4 {
-	cs-gpios = <&gpio1 10 GPIO_ACTIVE_LOW>, <&gpio0 11 GPIO_ACTIVE_LOW>, <&gpio0 17 GPIO_ACTIVE_LOW>;
+	cs-gpios = <&gpio1 10 GPIO_ACTIVE_LOW>,
+		<&gpio0 11 GPIO_ACTIVE_LOW>,
+		<&gpio0 17 GPIO_ACTIVE_LOW>;
 	status = "okay";
 	mx25r64: mx25r6435f@0 {
 
@@ -34,6 +38,6 @@
 
 &gpio_fwd {
 	uart {
-		gpios = < &gpio1 0x9 0x0 >, < &gpio1 0x8 0x0 >, < &gpio1 0xb 0x0 >;
+		gpios = <&gpio1 0x9 0x0>, <&gpio1 0x8 0x0>, <&gpio1 0xb 0x0>;
 	};
 };

applications/nrf5340_audio/boards/nrf5340dk_nrf5340_cpuapp.overlay

@@ -4,6 +4,28 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
  */
 
+/ {
+	audioleds: audioleds {
+		compatible = "gpio-leds";
+		status = "okay";
+
+		led_conn_status: led_conn_status {
+			gpios = <&gpio0 28 GPIO_ACTIVE_LOW>;
+			label = "Green LED 0";
+		};
+
+		led_sync_status: led_sync_status {
+			gpios = <&gpio0 29 GPIO_ACTIVE_LOW>;
+			label = "Green LED 1";
+		};
+
+		led_app_status: led_app_status {
+			gpios = <&gpio0 30 GPIO_ACTIVE_LOW>;
+			label = "Green LED 2";
+		};
+	};
+};
+
 &usbd {
 	hs_0: hs_0 {
 		compatible = "usb-audio-hs";
@@ -16,3 +38,38 @@
 		hp-channel-r;
 	};
 };
+
+&pinctrl {
+	i2s0_default: i2s0_default {
+		group1 {
+			psels = <NRF_PSEL(I2S_MCK, 0, 12)>;
+			nordic,drive-mode = <NRF_DRIVE_H0H1>;
+		};
+
+		group2 {
+			psels = <NRF_PSEL(I2S_SCK_M, 0, 14)>,
+			<NRF_PSEL(I2S_LRCK_M, 0, 16)>,
+			<NRF_PSEL(I2S_SDOUT, 0, 13)>,
+			<NRF_PSEL(I2S_SDIN, 0, 15)>;
+		};
+	};
+
+	i2s0_sleep: i2s0_sleep {
+		group1 {
+			psels = <NRF_PSEL(I2S_MCK, 0, 12)>,
+			<NRF_PSEL(I2S_SCK_M, 0, 14)>,
+			<NRF_PSEL(I2S_LRCK_M, 0, 16)>,
+			<NRF_PSEL(I2S_SDOUT, 0, 13)>,
+			<NRF_PSEL(I2S_SDIN, 0, 15)>;
+			low-power-enable;
+		};
+	};
+};
+
+&i2s0 {
+	compatible = "nordic,nrf-i2s";
+	status = "okay";
+	pinctrl-0 = <&i2s0_default>;
+	pinctrl-1 = <&i2s0_sleep>;
+	pinctrl-names = "default", "sleep";
+};

applications/nrf5340_audio/broadcast_sink/main.c

@@ -11,7 +11,8 @@
 
 #include "broadcast_sink.h"
 #include "zbus_common.h"
-#include "nrf5340_audio_dk.h"
+#include "nrf5340_dk_init.h"
+#include "led_assignments.h"
 #include "led.h"
 #include "button_assignments.h"
 #include "macros_common.h"
@@ -208,7 +209,7 @@ static void le_audio_msg_sub_thread(void)
 
 			audio_system_start();
 			stream_state_set(STATE_STREAMING);
-			ret = led_blink(LED_APP_1_BLUE);
+			ret = led_blink(LED_AUDIO_CONN_STATUS);
 			ERR_CHK(ret);
 
 			break;
@@ -223,7 +224,7 @@ static void le_audio_msg_sub_thread(void)
 
 			stream_state_set(STATE_PAUSED);
 			audio_system_stop();
-			ret = led_on(LED_APP_1_BLUE);
+			ret = led_on(LED_AUDIO_CONN_STATUS);
 			ERR_CHK(ret);
 
 			break;
@@ -265,7 +266,7 @@ static void le_audio_msg_sub_thread(void)
 			if (strm_state == STATE_STREAMING) {
 				stream_state_set(STATE_PAUSED);
 				audio_system_stop();
-				ret = led_on(LED_APP_1_BLUE);
+				ret = led_on(LED_AUDIO_CONN_STATUS);
 				ERR_CHK(ret);
 			}
 
@@ -471,10 +472,12 @@ static int zbus_link_producers_observers(void)
 		return ret;
 	}
 
-	ret = zbus_chan_add_obs(&volume_chan, &volume_evt_sub, ZBUS_ADD_OBS_TIMEOUT_MS);
-	if (ret) {
-		LOG_ERR("Failed to add add volume sub");
-		return ret;
+	if (IS_ENABLED(CONFIG_BOARD_NRF5340_AUDIO_DK_NRF5340_CPUAPP)) {
+		ret = zbus_chan_add_obs(&volume_chan, &volume_evt_sub, ZBUS_ADD_OBS_TIMEOUT_MS);
+		if (ret) {
+			LOG_ERR("Failed to add add volume sub");
+			return ret;
+		}
 	}
 
 	ret = zbus_chan_add_obs(&bt_mgmt_chan, &bt_mgmt_evt_sub, ZBUS_ADD_OBS_TIMEOUT_MS);
@@ -566,7 +569,7 @@ int main(void)
 
 	LOG_DBG("Main started");
 
-	ret = nrf5340_audio_dk_init();
+	ret = nrf5340_board_init();
 	ERR_CHK(ret);
 
 	ret = fw_info_app_print();

applications/nrf5340_audio/broadcast_source/main.c

@@ -13,7 +13,8 @@
 
 #include "broadcast_source.h"
 #include "zbus_common.h"
-#include "nrf5340_audio_dk.h"
+#include "nrf5340_dk_init.h"
+#include "led_assignments.h"
 #include "led.h"
 #include "button_assignments.h"
 #include "macros_common.h"
@@ -206,7 +207,7 @@ static void le_audio_msg_sub_thread(void)
 
 			audio_system_start();
 			stream_state_set(STATE_STREAMING);
-			ret = led_blink(LED_APP_1_BLUE);
+			ret = led_blink(LED_AUDIO_CONN_STATUS);
 			ERR_CHK(ret);
 
 			break;
@@ -223,7 +224,7 @@ static void le_audio_msg_sub_thread(void)
 
 			stream_state_set(STATE_PAUSED);
 			audio_system_stop();
-			ret = led_on(LED_APP_1_BLUE);
+			ret = led_on(LED_AUDIO_CONN_STATUS);
 			ERR_CHK(ret);
 
 			break;
@@ -558,7 +559,7 @@ int main(void)
 	size_t ext_adv_buf_cnt = 0;
 	size_t per_adv_buf_cnt = 0;
 
-	ret = nrf5340_audio_dk_init();
+	ret = nrf5340_board_init();
 	ERR_CHK(ret);
 
 	ret = fw_info_app_print();

applications/nrf5340_audio/doc/building.rst

@@ -259,6 +259,13 @@ Complete the following steps to build the application:
       * For headset device: ``-DCONFIG_AUDIO_DEV=1``
       * For gateway device: ``-DCONFIG_AUDIO_DEV=2``
 
+   #. Choose the configuration file for the device selected by using one of the following options:
+
+      * For unicast headset: ``-DEXTRA_CONF_FILE=".\unicast_server\overlay-unicast_server.conf"``
+      * For unicast gateway: ``-DEXTRA_CONF_FILE=".\unicast_client\overlay-unicast_client.conf"``
+      * For broadcast headset: ``-DEXTRA_CONF_FILE=".\broadcast_sink\overlay-broadcast_sink.conf"``
+      * For broadcast gateway: ``-DEXTRA_CONF_FILE=".\broadcast_source\overlay-broadcast_source.conf"``
+
    #. Choose the application version (:ref:`nrf53_audio_app_building_config_files`) by using one of the following options:
 
       * For the debug version: No build flag needed.
@@ -269,9 +276,9 @@ Complete the following steps to build the application:
 
    .. code-block:: console
 
-      west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -DFILE_SUFFIX=release
+      west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -DEXTRA_CONF_FILE=".\unicast_server\overlay-unicast_server.conf" -DFILE_SUFFIX=release
 
-   This command creates the build files for headset device directly in the :file:`build` directory.
+   This command creates the build files for a unicast headset device directly in the :file:`build` directory.
    What this means is that you cannot create build files for all devices you want to program, because the subsequent commands will overwrite the files in the :file:`build` directory.
 
    To work around this standard west behavior, you can add the ``-d`` parameter to the ``west`` command to specify a custom build folder for each device.

applications/nrf5340_audio/doc/requirements.rst

@@ -9,17 +9,15 @@ nRF5340 Audio application requirements
 
 The nRF5340 Audio applications are designed to be used only with the following hardware:
 
-.. table-from-rows:: /includes/sample_board_rows.txt
-   :header: heading
-   :rows: nrf5340_audio_dk_nrf5340
+.. table-from-sample-yaml::
 
 .. note::
    The applications supports PCA10121 revisions 1.0.0 or above.
    The applications are also compatible with the following pre-launch revisions:
 
    * Revisions 0.8.0 and above.
 
-You need at least two nRF5340 Audio development kits (one with the gateway firmware and one with headset firmware) to test each of the applications.
+You need at least two nRF5340 development kits (one with the gateway firmware and one with headset firmware) to test each of the applications.
 For CIS with TWS in mind, three kits are required.
 
 If you want to test with other hardware (for example, a mobile phone or PC), it is highly recommended to test with Audio DKs on both the gateway and headset side first to verify basic functionality before moving on to testing with other vendors.