samples: usb: make console-next sample default

jfischer-no · cfriedt · commit a466cd80260d · 2025-08-06T11:57:39.000-04:00
Move legacy console sample to legacy directory and make console-next
sample default.

Signed-off-by: Johann Fischer &lt;johann.fischer@nordicsemi.no&gt;
diff --git a/doc/releases/release-notes-4.1.rst b/doc/releases/release-notes-4.1.rst
@@ -957,7 +957,7 @@ New Samples
 * :zephyr:code-sample:`tmc50xx`
 * :zephyr:code-sample:`uart`
 * :zephyr:code-sample:`usb-midi2-device`
-* :zephyr:code-sample:`usbd-cdc-acm-console`
+* :zephyr:code-sample:`usb-cdc-acm-console`
 * :zephyr:code-sample:`webusb`
 
 Other notable changes
diff --git a/samples/subsys/usb/console-next/README.rst b/samples/subsys/usb/console-next/README.rst
diff --git a/samples/subsys/usb/console-next/prj.conf b/samples/subsys/usb/console-next/prj.conf
diff --git a/samples/subsys/usb/console-next/sample.yaml b/samples/subsys/usb/console-next/sample.yaml
diff --git a/samples/subsys/usb/console/CMakeLists.txt b/samples/subsys/usb/console/CMakeLists.txt
@@ -4,6 +4,5 @@ cmake_minimum_required(VERSION 3.20.0)
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
 project(console)
 
-include(${ZEPHYR_BASE}/samples/subsys/usb/common/common.cmake)
 FILE(GLOB app_sources src/*.c)
 target_sources(app PRIVATE ${app_sources})
diff --git a/samples/subsys/usb/console/README.rst b/samples/subsys/usb/console/README.rst
@@ -1,19 +1,19 @@
 .. zephyr:code-sample:: usb-cdc-acm-console
    :name: Console over USB CDC ACM
-   :relevant-api: _usb_device_core_api usbd_api
+   :relevant-api: usbd_api uart_interface
 
    Output "Hello World!" to the console over USB CDC ACM.
 
 Overview
 ********
 
-A simple Hello World sample, with console output coming via CDC ACM UART.
-Primarily intended to show the required config options.
+This example application shows how to use the CDC ACM UART provided by the new
+experimental USB device stack as a serial backend for the console.
 
 Requirements
 ************
 
-This project requires a USB device controller driver.
+This project requires an experimental USB device driver (UDC API).
 
 Building and Running
 ********************
@@ -28,18 +28,12 @@ for the reel_board board:
    :compact:
 
 Plug the board into a host device, for sample, a PC running Linux OS.
-The board will be detected as a CDC_ACM serial device. To see the console output
-from the sample, use a command similar to :command:`minicom -D /dev/ttyACM0`.
+The board will be detected as a CDC ACM serial device. To see the console output
+from the sample, use a command similar to :command:`minicom -D /dev/ttyACM1`.
 
 .. code-block:: console
 
    Hello World! arm
    Hello World! arm
    Hello World! arm
    Hello World! arm
-
-Troubleshooting
-===============
-
-You may need to stop :program:`modemmanager` via :command:`sudo stop modemmanager`, if it is
-trying to access the device in the background.
diff --git a/samples/subsys/usb/console/prj.conf b/samples/subsys/usb/console/prj.conf
@@ -1,9 +1,10 @@
-CONFIG_USB_DEVICE_STACK=y
-CONFIG_USB_DEVICE_PRODUCT="Zephyr USB console sample"
-CONFIG_USB_DEVICE_PID=0x0004
-CONFIG_USB_DEVICE_INITIALIZE_AT_BOOT=n
-
 CONFIG_SERIAL=y
 CONFIG_CONSOLE=y
 CONFIG_UART_CONSOLE=y
+CONFIG_STDOUT_CONSOLE=y
 CONFIG_UART_LINE_CTRL=y
+
+CONFIG_USB_DEVICE_STACK_NEXT=y
+CONFIG_CDC_ACM_SERIAL_INITIALIZE_AT_BOOT=y
+CONFIG_CDC_ACM_SERIAL_PID=0x0004
+CONFIG_CDC_ACM_SERIAL_PRODUCT_STRING="USBD console sample"
diff --git a/samples/subsys/usb/console/sample.yaml b/samples/subsys/usb/console/sample.yaml
@@ -1,10 +1,17 @@
 sample:
-  name: Console over USB
+  name: Console over CDC ACM serial
 tests:
-  sample.usb.console:
+  sample.usbd.console:
     depends_on:
-      - usb_device
+      - usbd
     tags: usb
+    integration_platforms:
+      - nrf52840dk/nrf52840
+      - frdm_k64f
+      - stm32f723e_disco
+      - nucleo_f413zh
+      - mimxrt685_evk/mimxrt685s/cm33
+      - mimxrt1060_evk/mimxrt1062/qspi
     harness: console
     harness_config:
       fixture: fixture_usb_cdc
diff --git a/samples/subsys/usb/console/src/main.c b/samples/subsys/usb/console/src/main.c
@@ -6,7 +6,6 @@
 
 #include <zephyr/kernel.h>
 #include <zephyr/sys/printk.h>
-#include <zephyr/usb/usb_device.h>
 #include <zephyr/drivers/uart.h>
 
 BUILD_ASSERT(DT_NODE_HAS_COMPAT(DT_CHOSEN(zephyr_console), zephyr_cdc_acm_uart),
@@ -17,10 +16,6 @@ int main(void)
 	const struct device *const dev = DEVICE_DT_GET(DT_CHOSEN(zephyr_console));
 	uint32_t dtr = 0;
 
-	if (usb_enable(NULL)) {
-		return 0;
-	}
-
 	/* Poll if the DTR flag was set */
 	while (!dtr) {
 		uart_line_ctrl_get(dev, UART_LINE_CTRL_DTR, &dtr);
diff --git a/samples/subsys/usb/legacy/console/CMakeLists.txt b/samples/subsys/usb/legacy/console/CMakeLists.txt
@@ -2,7 +2,7 @@
 
 cmake_minimum_required(VERSION 3.20.0)
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
-project(console-next)
+project(console)
 
 FILE(GLOB app_sources src/*.c)
 target_sources(app PRIVATE ${app_sources})
diff --git a/samples/subsys/usb/legacy/console/README.rst b/samples/subsys/usb/legacy/console/README.rst
@@ -0,0 +1,45 @@
+.. zephyr:code-sample:: legacy-usb-cdc-acm-console
+   :name: Legacy console over USB CDC ACM
+   :relevant-api: _usb_device_core_api
+
+   Output "Hello World!" to the console over USB CDC ACM.
+
+Overview
+********
+
+A simple Hello World sample, with console output coming via CDC ACM UART.
+Primarily intended to show the required config options.
+
+Requirements
+************
+
+This project requires a USB device controller driver.
+
+Building and Running
+********************
+
+This sample can be built for multiple boards, in this example we will build it
+for the reel_board board:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/subsys/usb/legacy/console
+   :board: reel_board
+   :goals: flash
+   :compact:
+
+Plug the board into a host device, for sample, a PC running Linux OS.
+The board will be detected as a CDC_ACM serial device. To see the console output
+from the sample, use a command similar to :command:`minicom -D /dev/ttyACM0`.
+
+.. code-block:: console
+
+   Hello World! arm
+   Hello World! arm
+   Hello World! arm
+   Hello World! arm
+
+Troubleshooting
+===============
+
+You may need to stop :program:`modemmanager` via :command:`sudo stop modemmanager`, if it is
+trying to access the device in the background.
diff --git a/samples/subsys/usb/legacy/console/app.overlay b/samples/subsys/usb/legacy/console/app.overlay
diff --git a/samples/subsys/usb/legacy/console/prj.conf b/samples/subsys/usb/legacy/console/prj.conf
@@ -0,0 +1,9 @@
+CONFIG_USB_DEVICE_STACK=y
+CONFIG_USB_DEVICE_PRODUCT="Zephyr USB console sample"
+CONFIG_USB_DEVICE_PID=0x0004
+CONFIG_USB_DEVICE_INITIALIZE_AT_BOOT=n
+
+CONFIG_SERIAL=y
+CONFIG_CONSOLE=y
+CONFIG_UART_CONSOLE=y
+CONFIG_UART_LINE_CTRL=y
diff --git a/samples/subsys/usb/legacy/console/sample.yaml b/samples/subsys/usb/legacy/console/sample.yaml
@@ -0,0 +1,8 @@
+sample:
+  name: Console over USB
+tests:
+  sample.usb.legacy.console:
+    depends_on:
+      - usb_device
+    tags: usb
+    build_only: true
diff --git a/samples/subsys/usb/legacy/console/src/main.c b/samples/subsys/usb/legacy/console/src/main.c
@@ -6,6 +6,7 @@
 
 #include <zephyr/kernel.h>
 #include <zephyr/sys/printk.h>
+#include <zephyr/usb/usb_device.h>
 #include <zephyr/drivers/uart.h>
 
 BUILD_ASSERT(DT_NODE_HAS_COMPAT(DT_CHOSEN(zephyr_console), zephyr_cdc_acm_uart),
@@ -16,6 +17,10 @@ int main(void)
 	const struct device *const dev = DEVICE_DT_GET(DT_CHOSEN(zephyr_console));
 	uint32_t dtr = 0;
 
+	if (usb_enable(NULL)) {
+		return 0;
+	}
+
 	/* Poll if the DTR flag was set */
 	while (!dtr) {
 		uart_line_ctrl_get(dev, UART_LINE_CTRL_DTR, &dtr);
