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.

Currently the button handler expects kits to have five
buttons - which is true for the Audio DK, but not for the
nRF5340 DK. To have the audio application running on the
nRF5340 DK (and other kits in the future), the handler must
be refactored to not fail compilation when fewer buttons
are present, and reduce the application's overall dependency
on button availability.

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

Author: gWacey

applications/nrf5340_audio/broadcast_sink/main.c

@@ -11,7 +11,7 @@
 
 #include "broadcast_sink.h"
 #include "zbus_common.h"
-#include "nrf5340_dk_init.h"
+#include "audio_nrf5340_dk_init.h"
 #include "led_assignments.h"
 #include "led.h"
 #include "button_assignments.h"
@@ -569,7 +569,7 @@ int main(void)
 
 	LOG_DBG("Main started");
 
-	ret = nrf5340_board_init();
+	ret = audio_nrf5340_dk_init();
 	ERR_CHK(ret);
 
 	ret = fw_info_app_print();

applications/nrf5340_audio/broadcast_source/main.c

@@ -13,7 +13,7 @@
 
 #include "broadcast_source.h"
 #include "zbus_common.h"
-#include "nrf5340_dk_init.h"
+#include "audio_nrf5340_dk_init.h"
 #include "led_assignments.h"
 #include "led.h"
 #include "button_assignments.h"
@@ -559,7 +559,7 @@ int main(void)
 	size_t ext_adv_buf_cnt = 0;
 	size_t per_adv_buf_cnt = 0;
 
-	ret = nrf5340_board_init();
+	ret = audio_nrf5340_dk_init();
 	ERR_CHK(ret);
 
 	ret = fw_info_app_print();

applications/nrf5340_audio/src/modules/button_assignments.h

@@ -16,21 +16,43 @@
 
 #include <zephyr/drivers/gpio.h>
 
-#define BUTTON_NOT_ASSIGNED 0xFF
+#define BUTTON_NOT_ASSIGNED 0xFFFF
 
 /** @brief List of buttons and associated metadata
  */
-enum button_pin_names {
-	BUTTON_VOLUME_DOWN = DT_GPIO_PIN(DT_ALIAS(sw0), gpios),
-	BUTTON_VOLUME_UP = DT_GPIO_PIN(DT_ALIAS(sw1), gpios),
-	BUTTON_PLAY_PAUSE = DT_GPIO_PIN(DT_ALIAS(sw2), gpios),
-#if defined(CONFIG_BOARD_NRF5340_AUDIO_DK_NRF5340_CPUAPP)
-	BUTTON_4 = DT_GPIO_PIN(DT_ALIAS(sw3), gpios),
-	BUTTON_5 = DT_GPIO_PIN(DT_ALIAS(sw4), gpios),
+#if DT_NODE_EXISTS(DT_ALIAS(sw0))
+#define BUTTON_VOLUME_DOWN DT_GPIO_PIN(DT_ALIAS(sw0), gpios)
 #else
-	BUTTON_5 = DT_GPIO_PIN(DT_ALIAS(sw3), gpios),
-	BUTTON_4 = BUTTON_NOT_ASSIGNED,
-#endif /* CONFIG_BOARD_NRF5340_AUDIO_DK_NRF5340_CPUAPP */
-};
+#define BUTTON_VOLUME_DOWN BUTTON_NOT_ASSIGNED
+
+#endif
+
+#if DT_NODE_EXISTS(DT_ALIAS(sw1))
+#define BUTTON_VOLUME_UP DT_GPIO_PIN(DT_ALIAS(sw1), gpios)
+#else
+#define BUTTON_VOLUME_UP BUTTON_NOT_ASSIGNED
+
+#endif
+
+#if DT_NODE_EXISTS(DT_ALIAS(sw2))
+#define BUTTON_PLAY_PAUSE DT_GPIO_PIN(DT_ALIAS(sw2), gpios)
+#else
+#define BUTTON_PLAY_PAUSE BUTTON_NOT_ASSIGNED
+#endif
+
+#if DT_NODE_EXISTS(DT_ALIAS(sw4))
+#define BUTTON_5 DT_GPIO_PIN(DT_ALIAS(sw4), gpios)
+#if DT_NODE_EXISTS(DT_ALIAS(sw3))
+#define BUTTON_4 DT_GPIO_PIN(DT_ALIAS(sw3), gpios)
+#else
+#define BUTTON_4 BUTTON_NOT_ASSIGNED
+#endif
+#elif DT_NODE_EXISTS(DT_ALIAS(sw3))
+#define BUTTON_4 BUTTON_NOT_ASSIGNED
+#define BUTTON_5 DT_GPIO_PIN(DT_ALIAS(sw3), gpios)
+#else
+#define BUTTON_4 BUTTON_NOT_ASSIGNED
+#define BUTTON_5 BUTTON_NOT_ASSIGNED
+#endif
 
 #endif /* _BUTTON_ASSIGNMENTS_H_ */

applications/nrf5340_audio/src/modules/button_handler.c

@@ -25,59 +25,43 @@ LOG_MODULE_REGISTER(button_handler, CONFIG_MODULE_BUTTON_HANDLER_LOG_LEVEL);
 ZBUS_CHAN_DEFINE(button_chan, struct button_msg, NULL, NULL, ZBUS_OBSERVERS_EMPTY,
 		 ZBUS_MSG_INIT(0));
 
-/* How many buttons does the module support. Increase at memory cost */
-#define BUTTONS_MAX 5
-#define BASE_10	    10
+/* Button configuration structure. */
+struct btn_cfg_data {
+	const char *name;
+	const struct gpio_dt_spec gpio;
+	void *user_cfg;
+};
+
+struct btn_unit_cfg {
+	uint32_t num_buttons;
+	struct btn_cfg_data *buttons;
+};
+
+#define BASE_10 10
 
 /* Only allow one button msg at a time, as a mean of debounce */
 K_MSGQ_DEFINE(button_queue, sizeof(struct button_msg), 1, 4);
 
 static bool debounce_is_ongoing;
-static struct gpio_callback btn_callback[BUTTONS_MAX];
-
-/* clang-format off */
-const static struct btn_config btn_cfg[] = {
-	{
-		.btn_name = STRINGIFY(BUTTON_VOLUME_DOWN),
-		.btn_pin = BUTTON_VOLUME_DOWN,
-		.btn_cfg_mask = DT_GPIO_FLAGS(DT_ALIAS(sw0), gpios),
-	},
-	{
-		.btn_name = STRINGIFY(BUTTON_VOLUME_UP),
-		.btn_pin = BUTTON_VOLUME_UP,
-		.btn_cfg_mask = DT_GPIO_FLAGS(DT_ALIAS(sw1), gpios),
-	},
-	{
-		.btn_name = STRINGIFY(BUTTON_PLAY_PAUSE),
-		.btn_pin = BUTTON_PLAY_PAUSE,
-		.btn_cfg_mask = DT_GPIO_FLAGS(DT_ALIAS(sw2), gpios),
-	},
-#if defined(CONFIG_BOARD_NRF5340_AUDIO_DK_NRF5340_CPUAPP)
-	{
-		.btn_name = STRINGIFY(BUTTON_4),
-		.btn_pin = BUTTON_4,
-		.btn_cfg_mask = DT_GPIO_FLAGS(DT_ALIAS(sw3), gpios),
-	},
-	{
-		.btn_name = STRINGIFY(BUTTON_5),
-		.btn_pin = BUTTON_5,
-		.btn_cfg_mask = DT_GPIO_FLAGS(DT_ALIAS(sw4), gpios),
-	}
+
+#if DT_NODE_EXISTS(DT_PATH(buttons))
+#define BUTTON DT_PATH(buttons)
 #else
-	{
-		.btn_name = STRINGIFY(BUTTON_4),
-		.btn_pin = BUTTON_4,
-	},
-	{
-		.btn_name = STRINGIFY(BUTTON_5),
-		.btn_pin = BUTTON_5,
-		.btn_cfg_mask = DT_GPIO_FLAGS(DT_ALIAS(sw3), gpios),
-	}
-#endif /* CONFIG_BOARD_NRF5340_AUDIO_DK_NRF5340_CPUAPP */
-};
-/* clang-format on */
+#pragma error("No buttons node found")
+#endif
+
+#define BUTTON_GPIO(button_node_id)                                                                \
+	{                                                                                          \
+		.name = STRINGIFY(BUTTON_##button_node_id),                                        \
+				  .gpio = GPIO_DT_SPEC_GET(button_node_id, gpios),                 \
+		},
 
-static const struct device *gpio_53_dev;
+static struct btn_cfg_data btn_config_data[] = {DT_FOREACH_CHILD(BUTTON, BUTTON_GPIO)};
+
+static const struct btn_unit_cfg btn_config = {.num_buttons = ARRAY_SIZE(btn_config_data),
+					       .buttons = btn_config_data};
+
+static struct gpio_callback btn_callback[ARRAY_SIZE(btn_config_data)];
 
 /**@brief Simple debouncer for buttons
  *
@@ -95,8 +79,8 @@ K_TIMER_DEFINE(button_debounce_timer, on_button_debounce_timeout, NULL);
  */
 static int pin_to_btn_idx(uint8_t btn_pin, uint32_t *pin_idx)
 {
-	for (uint8_t i = 0; i < ARRAY_SIZE(btn_cfg); i++) {
-		if (btn_pin == btn_cfg[i].btn_pin) {
+	for (uint8_t i = 0; i < btn_config.num_buttons; i++) {
+		if (btn_pin == btn_config.buttons[i].gpio.pin) {
 			*pin_idx = i;
 			return 0;
 		}
@@ -174,7 +158,7 @@ static void button_isr(const struct device *port, struct gpio_callback *cb, uint
 	ERR_CHK(ret);
 
 	LOG_DBG("Pushed button idx: %d pin: %d name: %s", btn_idx, btn_pin,
-		btn_cfg[btn_idx].btn_name);
+		btn_config.buttons[btn_idx].name);
 
 	msg.button_pin = btn_pin;
 	msg.button_action = BUTTON_PRESS;
@@ -191,16 +175,22 @@ static void button_isr(const struct device *port, struct gpio_callback *cb, uint
 int button_pressed(gpio_pin_t button_pin, bool *button_pressed)
 {
 	int ret;
+	uint32_t btn_idx;
 
-	if (!device_is_ready(gpio_53_dev)) {
-		return -ENODEV;
+	if (button_pin == BUTTON_NOT_ASSIGNED || button_pressed == NULL) {
+		return -EINVAL;
 	}
 
-	if (button_pressed == NULL) {
+	ret = pin_to_btn_idx(button_pin, &btn_idx);
+	if (ret) {
+		return -EINVAL;
+	}
+
+	if (!device_is_ready(btn_config.buttons[btn_idx].gpio.port)) {
 		return -EINVAL;
 	}
 
-	ret = gpio_pin_get(gpio_53_dev, button_pin);
+	ret = gpio_pin_get(btn_config.buttons[btn_idx].gpio.port, button_pin);
 	switch (ret) {
 	case 0:
 		*button_pressed = false;
@@ -219,37 +209,34 @@ int button_handler_init(void)
 {
 	int ret;
 
-	if (ARRAY_SIZE(btn_cfg) == 0) {
+	if (btn_config.num_buttons == 0) {
 		LOG_WRN("No buttons assigned");
 		return -EINVAL;
 	}
 
-	gpio_53_dev = DEVICE_DT_GET(DT_NODELABEL(gpio0));
-
-	if (!device_is_ready(gpio_53_dev)) {
-		LOG_ERR("Device driver not ready.");
-		return -ENODEV;
-	}
-
-	for (uint8_t i = 0; i < ARRAY_SIZE(btn_cfg); i++) {
-		if (btn_cfg[i].btn_pin == BUTTON_NOT_ASSIGNED) {
-			continue;
-		}
-
-		ret = gpio_pin_configure(gpio_53_dev, btn_cfg[i].btn_pin,
-					 GPIO_INPUT | btn_cfg[i].btn_cfg_mask);
-		if (ret) {
-			return ret;
+	for (size_t i = 0; i < btn_config.num_buttons; i++) {
+		struct btn_cfg_data *button = &btn_config.buttons[i];
+
+		if (device_is_ready(button->gpio.port)) {
+			ret = gpio_pin_configure(button->gpio.port, button->gpio.pin,
+						 GPIO_INPUT | button->gpio.dt_flags);
+			if (ret) {
+				LOG_ERR("Cannot configure GPIO (ret %d)", ret);
+				return ret;
+			}
+		} else {
+			LOG_ERR("GPIO device not ready");
+			return -ENODEV;
 		}
 
-		gpio_init_callback(&btn_callback[i], button_isr, BIT(btn_cfg[i].btn_pin));
+		gpio_init_callback(&btn_callback[i], button_isr, BIT(button->gpio.pin));
 
-		ret = gpio_add_callback(gpio_53_dev, &btn_callback[i]);
+		ret = gpio_add_callback(button->gpio.port, &btn_callback[i]);
 		if (ret) {
 			return ret;
 		}
 
-		ret = gpio_pin_interrupt_configure(gpio_53_dev, btn_cfg[i].btn_pin,
+		ret = gpio_pin_interrupt_configure(button->gpio.port, button->gpio.pin,
 						   GPIO_INT_EDGE_TO_INACTIVE);
 		if (ret) {
 			return ret;
@@ -265,8 +252,9 @@ static int cmd_print_all_btns(const struct shell *shell, size_t argc, char **arg
 	ARG_UNUSED(argc);
 	ARG_UNUSED(argv);
 
-	for (uint8_t i = 0; i < ARRAY_SIZE(btn_cfg); i++) {
-		shell_print(shell, "Id %d: pin: %d %s", i, btn_cfg[i].btn_pin, btn_cfg[i].btn_name);
+	for (uint8_t i = 0; i < btn_config.num_buttons; i++) {
+		shell_print(shell, "Id %d: pin: %d %s", i, btn_config.buttons[i].gpio.pin,
+			    btn_config.buttons[i].name);
 	}
 
 	return 0;
@@ -291,21 +279,21 @@ static int cmd_push_btn(const struct shell *shell, size_t argc, char **argv)
 
 	btn_idx = strtoul(argv[1], NULL, BASE_10);
 
-	if (btn_idx >= ARRAY_SIZE(btn_cfg)) {
+	if (btn_idx >= ARRAY_SIZE(btn_config_data)) {
 		shell_error(shell, "Selected button ID out of range");
 		return -EINVAL;
 	}
 
-	msg.button_pin = btn_cfg[btn_idx].btn_pin;
+	msg.button_pin = btn_config.buttons[btn_idx].gpio.pin;
 	msg.button_action = BUTTON_PRESS;
 
 	ret = zbus_chan_pub(&button_chan, &msg, K_NO_WAIT);
 	if (ret) {
 		LOG_ERR("Failed to publish button msg, ret: %d", ret);
 	}
 
-	shell_print(shell, "Pushed button idx: %d pin: %d : %s", btn_idx, btn_cfg[btn_idx].btn_pin,
-		    btn_cfg[btn_idx].btn_name);
+	shell_print(shell, "Pushed button idx: %d pin: %d : %s", btn_idx,
+		    btn_config.buttons[btn_idx].gpio.pin, btn_config.buttons[btn_idx].name);
 
 	return 0;
 }

applications/nrf5340_audio/src/modules/button_handler.h

@@ -10,12 +10,6 @@
 #include <stdint.h>
 #include <zephyr/drivers/gpio.h>
 
-struct btn_config {
-	const char *btn_name;
-	uint8_t btn_pin;
-	uint32_t btn_cfg_mask;
-};
-
 /** @brief Initialize button handler, with buttons defined in button_assignments.h.
  *
  * @note This function may only be called once - there is no reinitialize.

applications/nrf5340_audio/src/utils/CMakeLists.txt

@@ -8,8 +8,8 @@ target_sources(app PRIVATE
 			${CMAKE_CURRENT_SOURCE_DIR}/channel_assignment.c
 			${CMAKE_CURRENT_SOURCE_DIR}/error_handler.c
 			${CMAKE_CURRENT_SOURCE_DIR}/uicr.c
-			${CMAKE_CURRENT_SOURCE_DIR}/nrf5340_dk_init.c
+			${CMAKE_CURRENT_SOURCE_DIR}/audio_nrf5340_dk_init.c
 )
 
 target_sources_ifdef(CONFIG_BOARD_NRF5340_AUDIO_DK_NRF5340_CPUAPP app PRIVATE
-		${CMAKE_CURRENT_SOURCE_DIR}/nrf5340_dk_version.c)
+		${CMAKE_CURRENT_SOURCE_DIR}/audio_nrf5340_dk_version.c)

applications/nrf5340_audio/src/utils/Kconfig

@@ -40,12 +40,12 @@ endmenu # FIFO
 #----------------------------------------------------------------------------#
 menu "Log levels"
 
-module = NRF5340_BOARD_INIT
-module-str = nrf534-board-init
+module = AUDIO_NRF5340_DK_INIT
+module-str = audio_nrf534-dk-init
 source "subsys/logging/Kconfig.template.log_config"
 
-module = NRF5340_BOARD_VERSION
-module-str = nrf534-board-version
+module = AUDIO_NRF5340_DK_VERSION
+module-str = audio_nrf534-dk-version
 source "subsys/logging/Kconfig.template.log_config"
 
 module = CHAN_ASSIGNMENT