samples: usb: use common sample USBD initialization

Use the common USBD sample initialization helper where new USB device support has already been added. Signed-off-by: Johann Fischer <[email protected]>
zephyrproject-rtos · Dec 13, 2023 · 9566419 · 9566419
1 parent b00a998
commit 9566419
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 153 deletions.
diff --git a/samples/subsys/usb/cdc_acm/CMakeLists.txt b/samples/subsys/usb/cdc_acm/CMakeLists.txt
@@ -4,5 +4,6 @@ cmake_minimum_required(VERSION 3.20.0)
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
 project(cdc_acm)
 
+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/cdc_acm/Kconfig b/samples/subsys/usb/cdc_acm/Kconfig
@@ -0,0 +1,9 @@
+# Copyright (c) 2023 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+# Source common USB sample options used to initialize new experimental USB
+# device stack. The scope of these options is limited to USB samples in project
+# tree, you cannot use them in your own application.
+source "samples/subsys/usb/common/Kconfig.sample_usbd"
+
+source "Kconfig.zephyr"
diff --git a/samples/subsys/usb/cdc_acm/src/main.c b/samples/subsys/usb/cdc_acm/src/main.c
@@ -12,6 +12,8 @@
  * to the serial port.
  */
 
+#include <sample_usbd.h>
+
 #include <stdio.h>
 #include <string.h>
 #include <zephyr/device.h>
@@ -32,66 +34,19 @@ struct ring_buf ringbuf;
 static bool rx_throttled;
 
 #if defined(CONFIG_USB_DEVICE_STACK_NEXT)
-USBD_CONFIGURATION_DEFINE(config_1,
-			  USB_SCD_SELF_POWERED,
-			  200);
-
-USBD_DESC_LANG_DEFINE(sample_lang);
-USBD_DESC_MANUFACTURER_DEFINE(sample_mfr, "ZEPHYR");
-USBD_DESC_PRODUCT_DEFINE(sample_product, "Zephyr USBD CDC ACM");
-USBD_DESC_SERIAL_NUMBER_DEFINE(sample_sn, "0123456789ABCDEF");
-
-USBD_DEVICE_DEFINE(sample_usbd,
-		   DEVICE_DT_GET(DT_NODELABEL(zephyr_udc0)),
-		   0x2fe3, 0x0001);
+static struct usbd_contex *sample_usbd;
 
 static int enable_usb_device_next(void)
 {
 	int err;
 
-	err = usbd_add_descriptor(&sample_usbd, &sample_lang);
-	if (err) {
-		LOG_ERR("Failed to initialize language descriptor (%d)", err);
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_mfr);
-	if (err) {
-		LOG_ERR("Failed to initialize manufacturer descriptor (%d)", err);
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_product);
-	if (err) {
-		LOG_ERR("Failed to initialize product descriptor (%d)", err);
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_sn);
-	if (err) {
-		LOG_ERR("Failed to initialize SN descriptor (%d)", err);
-		return err;
-	}
-
-	err = usbd_add_configuration(&sample_usbd, &config_1);
-	if (err) {
-		LOG_ERR("Failed to add configuration (%d)", err);
-		return err;
-	}
-
-	err = usbd_register_class(&sample_usbd, "cdc_acm_0", 1);
-	if (err) {
-		LOG_ERR("Failed to register CDC ACM class (%d)", err);
-		return err;
-	}
-
-	err = usbd_init(&sample_usbd);
-	if (err) {
-		LOG_ERR("Failed to initialize device support");
-		return err;
+	sample_usbd = sample_usbd_init_device();
+	if (sample_usbd == NULL) {
+		LOG_ERR("Failed to initialize USB device");
+		return -ENODEV;
 	}
 
-	err = usbd_enable(&sample_usbd);
+	err = usbd_enable(sample_usbd);
 	if (err) {
 		LOG_ERR("Failed to enable device support");
 		return err;

diff --git a/samples/subsys/usb/cdc_acm/usbd_next_prj.conf b/samples/subsys/usb/cdc_acm/usbd_next_prj.conf
@@ -8,3 +8,6 @@ CONFIG_USBD_CDC_ACM_CLASS=y
 CONFIG_LOG=y
 CONFIG_USBD_LOG_LEVEL_WRN=y
 CONFIG_UDC_DRIVER_LOG_LEVEL_WRN=y
+
+CONFIG_SAMPLE_USBD_PID=0x0001
+CONFIG_SAMPLE_USBD_PRODUCT="USBD CDC ACM sample"
diff --git a/samples/subsys/usb/console/CMakeLists.txt b/samples/subsys/usb/console/CMakeLists.txt
@@ -4,5 +4,6 @@ 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/Kconfig b/samples/subsys/usb/console/Kconfig
@@ -0,0 +1,9 @@
+# Copyright (c) 2023 Nordic Semiconductor ASA
+# SPDX-License-Identifier: Apache-2.0
+
+# Source common USB sample options used to initialize new experimental USB
+# device stack. The scope of these options is limited to USB samples in project
+# tree, you cannot use them in your own application.
+source "samples/subsys/usb/common/Kconfig.sample_usbd"
+
+source "Kconfig.zephyr"
diff --git a/samples/subsys/usb/console/src/main.c b/samples/subsys/usb/console/src/main.c
@@ -4,6 +4,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include <sample_usbd.h>
+
 #include <zephyr/kernel.h>
 #include <zephyr/sys/printk.h>
 #include <zephyr/usb/usb_device.h>
@@ -14,59 +16,18 @@ BUILD_ASSERT(DT_NODE_HAS_COMPAT(DT_CHOSEN(zephyr_console), zephyr_cdc_acm_uart),
 	     "Console device is not ACM CDC UART device");
 
 #if defined(CONFIG_USB_DEVICE_STACK_NEXT)
-USBD_CONFIGURATION_DEFINE(config_1,
-			  USB_SCD_SELF_POWERED,
-			  200);
-
-USBD_DESC_LANG_DEFINE(sample_lang);
-USBD_DESC_MANUFACTURER_DEFINE(sample_mfr, "ZEPHYR");
-USBD_DESC_PRODUCT_DEFINE(sample_product, "Zephyr USBD ACM console");
-USBD_DESC_SERIAL_NUMBER_DEFINE(sample_sn, "0123456789ABCDEF");
-
-USBD_DEVICE_DEFINE(sample_usbd,
-		   DEVICE_DT_GET(DT_NODELABEL(zephyr_udc0)),
-		   0x2fe3, 0x0001);
+static struct usbd_contex *sample_usbd;
 
 static int enable_usb_device_next(void)
 {
 	int err;
 
-	err = usbd_add_descriptor(&sample_usbd, &sample_lang);
-	if (err) {
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_mfr);
-	if (err) {
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_product);
-	if (err) {
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_sn);
-	if (err) {
-		return err;
-	}
-
-	err = usbd_add_configuration(&sample_usbd, &config_1);
-	if (err) {
-		return err;
-	}
-
-	err = usbd_register_class(&sample_usbd, "cdc_acm_0", 1);
-	if (err) {
-		return err;
-	}
-
-	err = usbd_init(&sample_usbd);
-	if (err) {
-		return err;
+	sample_usbd = sample_usbd_init_device();
+	if (sample_usbd == NULL) {
+		return -ENODEV;
 	}
 
-	err = usbd_enable(&sample_usbd);
+	err = usbd_enable(sample_usbd);
 	if (err) {
 		return err;
 	}

diff --git a/samples/subsys/usb/console/usbd_next_prj.conf b/samples/subsys/usb/console/usbd_next_prj.conf
@@ -8,3 +8,6 @@ CONFIG_USBD_CDC_ACM_CLASS=y
 CONFIG_LOG=y
 CONFIG_USBD_LOG_LEVEL_WRN=y
 CONFIG_UDC_DRIVER_LOG_LEVEL_WRN=y
+
+CONFIG_SAMPLE_USBD_PID=0x0004
+CONFIG_SAMPLE_USBD_PRODUCT="USBD console sample"
diff --git a/samples/subsys/usb/mass/CMakeLists.txt b/samples/subsys/usb/mass/CMakeLists.txt
@@ -10,6 +10,7 @@ if((NOT CONFIG_DISK_DRIVER_FLASH) AND
 	message( FATAL_ERROR "No disk access settings detected." )
 endif()
 
+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/mass/Kconfig b/samples/subsys/usb/mass/Kconfig
@@ -1,6 +1,8 @@
 # Copyright (c) 2019-2020 Nordic Semiconductor ASA
 # SPDX-License-Identifier: Apache-2.0
 
+menu "MSC sample options"
+
 config APP_WIPE_STORAGE
 	bool "Option to clear the flash area before mounting"
 	help
@@ -65,4 +67,11 @@ endif # NORDIC_QSPI_NOR
 
 endif # DISK_DRIVER_FLASH
 
+endmenu
+
+# Source common USB sample options used to initialize new experimental USB
+# device stack. The scope of these options is limited to USB samples in project
+# tree, you cannot use them in your own application.
+source "samples/subsys/usb/common/Kconfig.sample_usbd"
+
 source "Kconfig.zephyr"
diff --git a/samples/subsys/usb/mass/src/main.c b/samples/subsys/usb/mass/src/main.c
@@ -5,6 +5,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include <sample_usbd.h>
+
 #include <zephyr/kernel.h>
 #include <zephyr/logging/log.h>
 #include <zephyr/usb/usb_device.h>
@@ -34,19 +36,7 @@ FS_LITTLEFS_DECLARE_DEFAULT_CONFIG(storage);
 static struct fs_mount_t fs_mnt;
 
 #if defined(CONFIG_USB_DEVICE_STACK_NEXT)
-USBD_CONFIGURATION_DEFINE(config_1,
-			  USB_SCD_SELF_POWERED,
-			  200);
-
-USBD_DESC_LANG_DEFINE(sample_lang);
-USBD_DESC_MANUFACTURER_DEFINE(sample_mfr, "ZEPHYR");
-USBD_DESC_PRODUCT_DEFINE(sample_product, "Zephyr USBD MSC");
-USBD_DESC_SERIAL_NUMBER_DEFINE(sample_sn, "0123456789ABCDEF");
-
-
-USBD_DEVICE_DEFINE(sample_usbd,
-		   DEVICE_DT_GET(DT_NODELABEL(zephyr_udc0)),
-		   0x2fe3, 0x0008);
+static struct usbd_contex *sample_usbd;
 
 #if CONFIG_DISK_DRIVER_RAM
 USBD_DEFINE_MSC_LUN(RAM, "Zephyr", "RAMDisk", "0.00");
@@ -64,49 +54,13 @@ static int enable_usb_device_next(void)
 {
 	int err;
 
-	err = usbd_add_descriptor(&sample_usbd, &sample_lang);
-	if (err) {
-		LOG_ERR("Failed to initialize language descriptor (%d)", err);
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_mfr);
-	if (err) {
-		LOG_ERR("Failed to initialize manufacturer descriptor (%d)", err);
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_product);
-	if (err) {
-		LOG_ERR("Failed to initialize product descriptor (%d)", err);
-		return err;
-	}
-
-	err = usbd_add_descriptor(&sample_usbd, &sample_sn);
-	if (err) {
-		LOG_ERR("Failed to initialize SN descriptor (%d)", err);
-		return err;
-	}
-
-	err = usbd_add_configuration(&sample_usbd, &config_1);
-	if (err) {
-		LOG_ERR("Failed to add configuration (%d)", err);
-		return err;
-	}
-
-	err = usbd_register_class(&sample_usbd, "msc_0", 1);
-	if (err) {
-		LOG_ERR("Failed to register MSC class (%d)", err);
-		return err;
-	}
-
-	err = usbd_init(&sample_usbd);
-	if (err) {
-		LOG_ERR("Failed to initialize device support");
-		return err;
+	sample_usbd = sample_usbd_init_device();
+	if (sample_usbd == NULL) {
+		LOG_ERR("Failed to initialize USB device");
+		return -ENODEV;
 	}
 
-	err = usbd_enable(&sample_usbd);
+	err = usbd_enable(sample_usbd);
 	if (err) {
 		LOG_ERR("Failed to enable device support");
 		return err;

diff --git a/samples/subsys/usb/mass/usbd_next_prj.conf b/samples/subsys/usb/mass/usbd_next_prj.conf
@@ -10,4 +10,6 @@ CONFIG_LOG=y
 CONFIG_USBD_LOG_LEVEL_WRN=y
 CONFIG_UDC_DRIVER_LOG_LEVEL_WRN=y
 
+CONFIG_SAMPLE_USBD_PID=0x0008
+CONFIG_SAMPLE_USBD_PRODUCT="USBD MSC sample"
 CONFIG_MAIN_STACK_SIZE=1536