mgmt: mcumgr: transport: Move BM UART code out into transport file

nordicjm · eivindj-nordic · commit e268ed1fb318 · 2025-10-07T08:13:55.000+02:00
Allows including the BM UART transport in other applications and
updates the UART MCUmgr sample to use this transport library

Signed-off-by: Jamie McCrae &lt;jamie.mccrae@nordicsemi.no&gt;
diff --git a/samples/mcumgr/uart_mcumgr/CMakeLists.txt b/samples/mcumgr/uart_mcumgr/CMakeLists.txt
@@ -10,13 +10,5 @@ find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
 project(uart_mcumgr)
 
 zephyr_include_directories(include)
-zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/util/include)
-zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/grp/img_mgmt/include)
 zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/include)
-target_sources(app PRIVATE
-  src/uart_mcumgr.c
-  src/smp_uart.c
-  ${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/src/serial_util.c
-)
-zephyr_linker_sources(SECTIONS mcumgr_handler.ld)
-zephyr_link_libraries(MCUBOOT_BOOTUTIL)
+target_sources(app PRIVATE src/main.c)
diff --git a/samples/mcumgr/uart_mcumgr/Kconfig b/samples/mcumgr/uart_mcumgr/Kconfig
@@ -6,39 +6,7 @@
 
 menu "UART MCUmgr sample"
 
-config UART_MCUMGR_RX_BUF_SIZE
-	int "Size of receive buffer for mcumgr fragments received over UART, in bytes"
-	default 128
-	help
-	  Specifies the size of the mcumgr UART receive buffer, in bytes. This
-	  value must be large enough to accommodate any line sent by an mcumgr
-	  client.
-
-config UART_MCUMGR_RX_BUF_COUNT
-	int "Number of receive buffers for mcumgr fragments received over UART"
-	default 8
-	help
-	  Specifies the number of the mcumgr UART receive buffers.  Receive
-	  buffers hold received mcumgr fragments prior to reassembly.  This
-	  setting's value must satisfy the following relation:
-	  UART_MCUMGR_RX_BUF_COUNT * UART_MCUMGR_RX_BUF_SIZE >=
-	  MCUMGR_TRANSPORT_UART_MTU
-
-config UARTE_HWFC
-	bool "UARTE HWFC"
-	help
-	  Enable hardware flow control on the UARTE peripheral used by the application.
-
-config UARTE_PARITY
-	bool "UARTE parity"
-	help
-	  Enable parity on the UARTE peripheral used by the application.
-
-config UARTE_IRQ_PRIO
-	int "UARTE IRQ priority"
-	default 3
-
-module=UART_MCUMGR_SAMPLE
+module=APP_UART_MCUMGR_SAMPLE
 module-str=UART MCUmgr Sample
 source "$(ZEPHYR_BASE)/subsys/logging/Kconfig.template.log_config"
 
diff --git a/samples/mcumgr/uart_mcumgr/prj.conf b/samples/mcumgr/uart_mcumgr/prj.conf
@@ -20,6 +20,7 @@ CONFIG_CRC=y
 CONFIG_REBOOT=y
 CONFIG_NCS_BM_MCUMGR=y
 CONFIG_MCUMGR_TRANSPORT_REASSEMBLY=y
+CONFIG_MCUMGR_TRANSPORT_BM_UART=y
 CONFIG_MCUMGR_MGMT_NOTIFICATION_HOOKS=y
 CONFIG_MCUMGR_GRP_IMG=y
 CONFIG_MCUMGR_GRP_IMG_SLOT_INFO=y
diff --git a/samples/mcumgr/uart_mcumgr/src/main.c b/samples/mcumgr/uart_mcumgr/src/main.c
@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include <string.h>
+#include <zephyr/kernel.h>
+#include <zephyr/drivers/uart.h>
+#include <zephyr/mgmt/mcumgr/transport/serial.h>
+#include <zephyr/drivers/console/uart_mcumgr.h>
+#include <zephyr/mgmt/mcumgr/mgmt/mgmt.h>
+#include <zephyr/mgmt/mcumgr/mgmt/callbacks.h>
+#include <zephyr/sys/reboot.h>
+#include <zephyr/logging/log.h>
+#include <nrfx_uarte.h>
+#include <smp_uart.h>
+#include <board-config.h>
+
+LOG_MODULE_REGISTER(app_uart_mcumgr, CONFIG_APP_UART_MCUMGR_SAMPLE_LOG_LEVEL);
+
+static bool should_reboot;
+
+static enum mgmt_cb_return os_mgmt_reboot_hook(uint32_t event, enum mgmt_cb_return prev_status,
+					       int32_t *rc, uint16_t *group, bool *abort_more,
+					       void *data, size_t data_size);
+
+static struct mgmt_callback os_mgmt_reboot_callback = {
+	.callback = os_mgmt_reboot_hook,
+	.event_id = MGMT_EVT_OP_OS_MGMT_RESET,
+};
+
+static enum mgmt_cb_return os_mgmt_reboot_hook(uint32_t event, enum mgmt_cb_return prev_status,
+					       int32_t *rc, uint16_t *group, bool *abort_more,
+					       void *data, size_t data_size)
+{
+	if (event == MGMT_EVT_OP_OS_MGMT_RESET) {
+		should_reboot = true;
+		*rc = MGMT_ERR_EOK;
+
+		return MGMT_CB_ERROR_RC;
+	}
+
+	return MGMT_CB_OK;
+}
+
+int main(void)
+{
+	LOG_INF("UART MCUmgr sample started");
+
+	mgmt_callback_register(&os_mgmt_reboot_callback);
+
+	while (should_reboot == false) {
+		/* Wait for an event. */
+		__WFE();
+
+		/* Clear Event Register */
+		__SEV();
+		__WFE();
+
+		smp_uart_process_rx_queue();
+	}
+
+	sys_reboot(SYS_REBOOT_WARM);
+}
diff --git a/scripts/ci/license_allow_list.yaml b/scripts/ci/license_allow_list.yaml
@@ -54,8 +54,8 @@ Apache-2.0: |
   ^nrf-bm/subsys/mgmt/mcumgr/transport/src/smp.c
   ^nrf-bm/subsys/mgmt/mcumgr/util/CMakeLists.txt
   ^nrf-bm/sysbuild/Kconfig.bm
-  ^nrf-bm/samples/mcumgr/uart_mcumgr/src/smp_uart.c
-  ^nrf-bm/samples/mcumgr/uart_mcumgr/src/uart_mcumgr.c
+  ^nrf-bm/subsys/mgmt/mcumgr/transport/src/bm_uart_mcumgr.c
+  ^nrf-bm/subsys/mgmt/mcumgr/transport/src/smp_uart.c
   ^nrf-bm/lib/bm_zms/
   ^nrf-bm/include/bm_zms.h
   ^nrf-bm/tests/lib/bm_zms/
diff --git a/subsys/bluetooth/services/ble_mcumgr/CMakeLists.txt b/subsys/bluetooth/services/ble_mcumgr/CMakeLists.txt
@@ -8,5 +8,5 @@ zephyr_sources(mcumgr.c)
 zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/util/include)
 zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/grp/img_mgmt/include)
 zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/include)
-zephyr_linker_sources(SECTIONS mcumgr_handler.ld)
+zephyr_linker_sources(SECTIONS ${ZEPHYR_NRF_BM_MODULE_DIR}/subsys/mgmt/mcumgr/transport/mcumgr_handler.ld)
 zephyr_link_libraries(MCUBOOT_BOOTUTIL)
diff --git a/subsys/bluetooth/services/ble_mcumgr/mcumgr_handler.ld b/subsys/bluetooth/services/ble_mcumgr/mcumgr_handler.ld
diff --git a/subsys/mgmt/mcumgr/transport/CMakeLists.txt b/subsys/mgmt/mcumgr/transport/CMakeLists.txt
@@ -1,6 +1,6 @@
 #
 # Copyright (c) 2018-2021 mcumgr authors
-# Copyright (c) 2022 Nordic Semiconductor ASA
+# Copyright (c) 2022-2025 Nordic Semiconductor ASA
 #
 # SPDX-License-Identifier: Apache-2.0
 #
@@ -14,8 +14,12 @@ zephyr_library_sources_ifdef(CONFIG_MCUMGR_TRANSPORT_REASSEMBLY
   ${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/src/smp_reassembly.c
 )
 
-#if(CONFIG_MCUMGR_TRANSPORT_SHELL OR CONFIG_MCUMGR_TRANSPORT_UART)
-#  zephyr_library_sources(src/serial_util.c)
-#endif()
+zephyr_library_sources_ifdef(CONFIG_MCUMGR_TRANSPORT_BM_UART
+  src/smp_uart.c
+  src/bm_uart_mcumgr.c
+  ${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/src/serial_util.c
+)
 
-zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/include)
+zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/include include)
+zephyr_library_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/util/include)
+zephyr_linker_sources(SECTIONS mcumgr_handler.ld)
diff --git a/subsys/mgmt/mcumgr/transport/Kconfig b/subsys/mgmt/mcumgr/transport/Kconfig
@@ -37,3 +37,5 @@ config MCUMGR_TRANSPORT_NETBUF_SIZE
 module = MCUMGR_TRANSPORT
 module-str = mcumgr_transport
 source "subsys/logging/Kconfig.template.log_config"
+
+rsource "Kconfig.bm_uart"
diff --git a/subsys/mgmt/mcumgr/transport/Kconfig.bm_uart b/subsys/mgmt/mcumgr/transport/Kconfig.bm_uart
@@ -0,0 +1,57 @@
+# Copyright Nordic Semiconductor ASA 2025. All rights reserved.
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+# The Kconfig file is dedicated to the BM UART transport of MCUmgr
+# subsystem and provides Kconfig options to control aspects of
+# the transport.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_TRANSPORT_BM_UART_
+
+menuconfig MCUMGR_TRANSPORT_BM_UART
+	bool "Bare Metal UART MCUmgr SMP transport"
+	depends on BASE64
+	depends on CRC
+	help
+	  Enables handling of SMP commands received over UART.
+
+if MCUMGR_TRANSPORT_BM_UART
+
+config MCUMGR_TRANSPORT_BM_UART_UARTE_HWFC
+	bool "UARTE HWFC"
+	help
+	  Enable hardware flow control on the UARTE peripheral used by the application.
+
+config MCUMGR_TRANSPORT_BM_UART_UARTE_PARITY
+	bool "UARTE parity"
+	help
+	  Enable parity on the UARTE peripheral used by the application.
+
+config MCUMGR_TRANSPORT_BM_UART_UARTE_IRQ_PRIO
+	int "UARTE IRQ priority"
+	default 3
+
+config MCUMGR_TRANSPORT_BM_UART_RX_BUF_SIZE
+	int "Size of receive buffer for mcumgr fragments received over UART, in bytes"
+	default 128
+	help
+	  Specifies the size of the mcumgr UART receive buffer, in bytes. This
+	  value must be large enough to accommodate any line sent by an mcumgr
+	  client.
+
+# Duplicate Zephyr symbol without console dependency to allow usage of Zephyr header file
+config UART_MCUMGR_RX_BUF_SIZE
+	int
+	default MCUMGR_TRANSPORT_BM_UART_RX_BUF_SIZE
+
+config MCUMGR_TRANSPORT_BM_UART_RX_BUF_COUNT
+	int "Number of receive buffers for mcumgr fragments received over UART"
+	default 8
+	help
+	  Specifies the number of the mcumgr UART receive buffers.  Receive
+	  buffers hold received mcumgr fragments prior to reassembly.  This
+	  setting's value must satisfy the following relation:
+	  UART_MCUMGR_RX_BUF_COUNT * UART_MCUMGR_RX_BUF_SIZE >=
+	  MCUMGR_TRANSPORT_UART_MTU
+
+endif # MCUMGR_TRANSPORT_BM_UART
diff --git a/subsys/mgmt/mcumgr/transport/include/smp_uart.h b/subsys/mgmt/mcumgr/transport/include/smp_uart.h
diff --git a/subsys/mgmt/mcumgr/transport/mcumgr_handler.ld b/subsys/mgmt/mcumgr/transport/mcumgr_handler.ld
diff --git a/subsys/mgmt/mcumgr/transport/src/bm_uart_mcumgr.c b/subsys/mgmt/mcumgr/transport/src/bm_uart_mcumgr.c
@@ -12,25 +12,14 @@
 #include <zephyr/drivers/console/uart_mcumgr.h>
 #include <zephyr/mgmt/mcumgr/mgmt/mgmt.h>
 #include <zephyr/mgmt/mcumgr/mgmt/callbacks.h>
-#include <zephyr/sys/reboot.h>
 #include <zephyr/logging/log.h>
+#include <zephyr/init.h>
 #include <nrfx_uarte.h>
-#include <smp_uart.h>
 #include <board-config.h>
 
-LOG_MODULE_REGISTER(uart_mcumgr, CONFIG_UART_MCUMGR_SAMPLE_LOG_LEVEL);
+LOG_MODULE_REGISTER(uart_mcumgr, CONFIG_MCUMGR_TRANSPORT_LOG_LEVEL);
 
-static char uarte_rx_buf[CONFIG_UART_MCUMGR_RX_BUF_SIZE];
-static bool should_reboot;
-
-static enum mgmt_cb_return os_mgmt_reboot_hook(uint32_t event, enum mgmt_cb_return prev_status,
-					       int32_t *rc, uint16_t *group, bool *abort_more,
-					       void *data, size_t data_size);
-
-static struct mgmt_callback os_mgmt_reboot_callback = {
-	.callback = os_mgmt_reboot_hook,
-	.event_id = MGMT_EVT_OP_OS_MGMT_RESET,
-};
+static char uarte_rx_buf[CONFIG_MCUMGR_TRANSPORT_BM_UART_RX_BUF_SIZE];
 
 /** MCUmgr UARTE instance */
 static const nrfx_uarte_t uarte_inst = NRFX_UARTE_INSTANCE(BOARD_APP_UARTE_INST);
@@ -49,7 +38,7 @@ static bool uart_mcumgr_ignoring;
 
 /** Contains buffers to hold incoming request fragments. */
 K_MEM_SLAB_DEFINE(uart_mcumgr_slab, sizeof(struct uart_mcumgr_rx_buf),
-		  CONFIG_UART_MCUMGR_RX_BUF_COUNT, 1);
+		  CONFIG_MCUMGR_TRANSPORT_BM_UART_RX_BUF_COUNT, 1);
 
 static struct uart_mcumgr_rx_buf *uart_mcumgr_alloc_rx_buf(void)
 {
@@ -210,29 +199,29 @@ void uart_mcumgr_register(uart_mcumgr_recv_fn *cb)
 /**
  * @brief Initialize UARTE driver.
  */
-static int uarte_init(void)
+static int bm_uarte_init(void)
 {
 	int err;
 
 	nrfx_uarte_config_t uarte_config = NRFX_UARTE_DEFAULT_CONFIG(BOARD_APP_UARTE_PIN_TX,
 								     BOARD_APP_UARTE_PIN_RX);
 
-#if defined(CONFIG_UARTE_HWFC)
+#if defined(CONFIG_MCUMGR_TRANSPORT_BM_UART_UARTE_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
 
-#if defined(CONFIG_UARTE_PARITY)
+#if defined(CONFIG_MCUMGR_TRANSPORT_BM_UART_UARTE_PARITY)
 	uarte_config.parity = NRF_UARTE_PARITY_INCLUDED;
 #endif
 
-	uarte_config.interrupt_priority = CONFIG_UARTE_IRQ_PRIO;
+	uarte_config.interrupt_priority = CONFIG_MCUMGR_TRANSPORT_BM_UART_UARTE_IRQ_PRIO;
 
 	/** We need to connect the IRQ ourselves. */
 	IRQ_CONNECT(NRFX_IRQ_NUMBER_GET(NRF_UARTE_INST_GET(BOARD_APP_UARTE_INST)),
-		    CONFIG_UARTE_IRQ_PRIO, NRFX_UARTE_INST_HANDLER_GET(BOARD_APP_UARTE_INST),
-		    0, 0);
+		    CONFIG_MCUMGR_TRANSPORT_BM_UART_UARTE_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)));
 
@@ -251,55 +240,13 @@ static int uarte_init(void)
 		(GPIO_PIN_CNF_PULL_Pullup << GPIO_PIN_CNF_PULL_Pos);
 #endif
 
-	return 0;
-}
-
-static enum mgmt_cb_return os_mgmt_reboot_hook(uint32_t event, enum mgmt_cb_return prev_status,
-					       int32_t *rc, uint16_t *group, bool *abort_more,
-					       void *data, size_t data_size)
-{
-	if (event == MGMT_EVT_OP_OS_MGMT_RESET) {
-		should_reboot = true;
-		*rc = MGMT_ERR_EOK;
-
-		return MGMT_CB_ERROR_RC;
-
-	}
-
-	return MGMT_CB_OK;
-}
-
-int main(void)
-{
-	int err;
-
-	LOG_INF("UART MCUmgr sample started");
-
-	mgmt_callback_register(&os_mgmt_reboot_callback);
-
-	err = uarte_init();
-
-	if (err) {
-		LOG_ERR("Failed to enable UARTE, err %d", err);
-		return -1;
-	}
-
 	err = nrfx_uarte_rx(&uarte_inst, uarte_rx_buf, 1);
 
 	if (err != NRFX_SUCCESS) {
 		LOG_ERR("UART RX failed, nrfx err %d", err);
 	}
 
-	while (should_reboot == false) {
-		/* Wait for an event. */
-		__WFE();
-
-		/* Clear Event Register */
-		__SEV();
-		__WFE();
-
-		smp_uart_process_rx_queue();
-	}
-
-	sys_reboot(SYS_REBOOT_WARM);
+	return err;
 }
+
+SYS_INIT(bm_uarte_init, APPLICATION, 0);
diff --git a/subsys/mgmt/mcumgr/transport/src/smp_uart.c b/subsys/mgmt/mcumgr/transport/src/smp_uart.c
@@ -74,7 +74,7 @@ static void smp_uart_rx_frag(struct uart_mcumgr_rx_buf *rx_buf)
 
 static uint16_t smp_uart_get_mtu(const struct net_buf *nb)
 {
-	return CONFIG_UART_MCUMGR_RX_BUF_SIZE;
+	return CONFIG_MCUMGR_TRANSPORT_BM_UART_RX_BUF_SIZE;
 }
 
 static int smp_uart_tx_pkt(struct net_buf *nb)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`#`
`2`	`2`	`# Copyright (c) 2018-2021 mcumgr authors`
`3`		`-# Copyright (c) 2022 Nordic Semiconductor ASA`
	`3`	`+# Copyright (c) 2022-2025 Nordic Semiconductor ASA`
`4`	`4`	`#`
`5`	`5`	`# SPDX-License-Identifier: Apache-2.0`
`6`	`6`	`#`
`@@ -14,8 +14,12 @@ zephyr_library_sources_ifdef(CONFIG_MCUMGR_TRANSPORT_REASSEMBLY`
`14`	`14`	`${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/src/smp_reassembly.c`
`15`	`15`	`)`
`16`	`16`
`17`		`-#if(CONFIG_MCUMGR_TRANSPORT_SHELL OR CONFIG_MCUMGR_TRANSPORT_UART)`
`18`		`-# zephyr_library_sources(src/serial_util.c)`
`19`		`-#endif()`
	`17`	`+zephyr_library_sources_ifdef(CONFIG_MCUMGR_TRANSPORT_BM_UART`
	`18`	`+ src/smp_uart.c`
	`19`	`+ src/bm_uart_mcumgr.c`
	`20`	`+ ${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/src/serial_util.c`
	`21`	`+)`
`20`	`22`
`21`		`-zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/include)`
	`23`	`+zephyr_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/transport/include include)`
	`24`	`+zephyr_library_include_directories(${ZEPHYR_BASE}/subsys/mgmt/mcumgr/util/include)`
	`25`	`+zephyr_linker_sources(SECTIONS mcumgr_handler.ld)`