samples: usb: move the legacy code out of the HID mouse sample

Move the legacy code from the HID mouse sample to a separate sample in
the legacy directory.

Signed-off-by: Johann Fischer <[email protected]>

Author: jfischer-no

samples/subsys/usb/hid-mouse/README.rst

@@ -1,6 +1,6 @@
 .. zephyr:code-sample:: usb-hid-mouse
    :name: USB HID mouse
-   :relevant-api: _usb_device_core_api usb_hid_device_api input_interface
+   :relevant-api: usbd_api usbd_hid_device input_interface
 
    Implement a basic HID mouse device.
 

samples/subsys/usb/hid-mouse/usbd_next.overlay renamed to samples/subsys/usb/hid-mouse/app.overlay

@@ -1,13 +1,11 @@
-CONFIG_USB_DEVICE_STACK=y
-CONFIG_USB_DEVICE_HID=y
-CONFIG_USB_DEVICE_PRODUCT="Zephyr HID mouse sample"
-CONFIG_USB_DEVICE_PID=0x0007
-CONFIG_USB_DEVICE_INITIALIZE_AT_BOOT=n
+CONFIG_USB_DEVICE_STACK_NEXT=y
+CONFIG_USBD_HID_SUPPORT=y
 
 CONFIG_LOG=y
-CONFIG_USB_DRIVER_LOG_LEVEL_ERR=y
-CONFIG_USB_DEVICE_LOG_LEVEL_ERR=y
+CONFIG_USBD_LOG_LEVEL_WRN=y
+CONFIG_USBD_HID_LOG_LEVEL_WRN=y
+CONFIG_UDC_DRIVER_LOG_LEVEL_WRN=y
+CONFIG_SAMPLE_USBD_PID=0x0007
 
 CONFIG_GPIO=y
 CONFIG_INPUT=y
-CONFIG_INPUT_MODE_SYNCHRONOUS=y

samples/subsys/usb/hid-mouse/prj.conf

@@ -6,12 +6,6 @@ common:
   depends_on:
     - gpio
 tests:
-  sample.usb.hid-mouse:
-    depends_on:
-      - usb_device
-    platform_exclude:
-      - frdm_mcxn947/mcxn947/cpu0
-    tags: usb
   sample.usb_device_next.hid-mouse:
     depends_on:
       - usbd
@@ -23,7 +17,4 @@ tests:
       - nucleo_f413zh
       - mimxrt1060_evk/mimxrt1062/qspi
       - max32690evkit/max32690/m4
-    extra_args:
-      - CONF_FILE="usbd_next_prj.conf"
-      - EXTRA_DTC_OVERLAY_FILE="usbd_next.overlay"
     tags: usb

samples/subsys/usb/hid-mouse/sample.yaml

@@ -15,16 +15,14 @@
 #include <zephyr/input/input.h>
 #include <zephyr/sys/util.h>
 
-#include <zephyr/usb/usb_device.h>
 #include <zephyr/usb/usbd.h>
-#include <zephyr/usb/class/usb_hid.h>
+#include <zephyr/usb/class/usbd_hid.h>
 
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(main, LOG_LEVEL_INF);
 
 static const struct gpio_dt_spec led0 = GPIO_DT_SPEC_GET(DT_ALIAS(led0), gpios);
 static const uint8_t hid_report_desc[] = HID_MOUSE_REPORT_DESC(2);
-static enum usb_dc_status_code usb_status;
 
 #define MOUSE_BTN_LEFT		0
 #define MOUSE_BTN_RIGHT		1
@@ -38,22 +36,7 @@ enum mouse_report_idx {
 };
 
 K_MSGQ_DEFINE(mouse_msgq, MOUSE_REPORT_COUNT, 2, 1);
-static K_SEM_DEFINE(ep_write_sem, 0, 1);
-
-static inline void status_cb(enum usb_dc_status_code status, const uint8_t *param)
-{
-	usb_status = status;
-}
-
-static ALWAYS_INLINE void rwup_if_suspended(void)
-{
-	if (IS_ENABLED(CONFIG_USB_DEVICE_REMOTE_WAKEUP)) {
-		if (usb_status == USB_DC_SUSPEND) {
-			usb_wakeup_request();
-			return;
-		}
-	}
-}
+static bool mouse_ready;
 
 static void input_cb(struct input_event *evt, void *user_data)
 {
@@ -63,11 +46,9 @@ static void input_cb(struct input_event *evt, void *user_data)
 
 	switch (evt->code) {
 	case INPUT_KEY_0:
-		rwup_if_suspended();
 		WRITE_BIT(tmp[MOUSE_BTN_REPORT_IDX], MOUSE_BTN_LEFT, evt->value);
 		break;
 	case INPUT_KEY_1:
-		rwup_if_suspended();
 		WRITE_BIT(tmp[MOUSE_BTN_REPORT_IDX], MOUSE_BTN_RIGHT, evt->value);
 		break;
 	case INPUT_KEY_2:
@@ -99,42 +80,30 @@ static void input_cb(struct input_event *evt, void *user_data)
 
 INPUT_CALLBACK_DEFINE(NULL, input_cb, NULL);
 
-#if defined(CONFIG_USB_DEVICE_STACK_NEXT)
-static int enable_usb_device_next(void)
+static void mouse_iface_ready(const struct device *dev, const bool ready)
 {
-	struct usbd_context *sample_usbd;
-	int err;
-
-	sample_usbd = sample_usbd_init_device(NULL);
-	if (sample_usbd == NULL) {
-		LOG_ERR("Failed to initialize USB device");
-		return -ENODEV;
-	}
-
-	err = usbd_enable(sample_usbd);
-	if (err) {
-		LOG_ERR("Failed to enable device support");
-		return err;
-	}
-
-	LOG_DBG("USB device support enabled");
-
-	return 0;
+	LOG_INF("HID device %s interface is %s",
+		dev->name, ready ? "ready" : "not ready");
+	mouse_ready = ready;
 }
-#endif /* defined(CONFIG_USB_DEVICE_STACK_NEXT) */
 
-static void int_in_ready_cb(const struct device *dev)
+static int mouse_get_report(const struct device *dev,
+			 const uint8_t type, const uint8_t id, const uint16_t len,
+			 uint8_t *const buf)
 {
-	ARG_UNUSED(dev);
-	k_sem_give(&ep_write_sem);
+	LOG_WRN("Get Report not implemented, Type %u ID %u", type, id);
+
+	return 0;
 }
 
-static const struct hid_ops ops = {
-	.int_in_ready = int_in_ready_cb,
+struct hid_device_ops mouse_ops = {
+	.iface_ready = mouse_iface_ready,
+	.get_report = mouse_get_report,
 };
 
 int main(void)
 {
+	struct usbd_context *sample_usbd;
 	const struct device *hid_dev;
 	int ret;
 
@@ -143,51 +112,58 @@ int main(void)
 		return 0;
 	}
 
-#if defined(CONFIG_USB_DEVICE_STACK_NEXT)
-	hid_dev = DEVICE_DT_GET_ONE(zephyr_hid_device);
-#else
-	hid_dev = device_get_binding("HID_0");
-#endif
-	if (hid_dev == NULL) {
-		LOG_ERR("Cannot get USB HID Device");
-		return 0;
-	}
-
 	ret = gpio_pin_configure_dt(&led0, GPIO_OUTPUT);
-	if (ret < 0) {
+	if (ret != 0) {
 		LOG_ERR("Failed to configure the LED pin, error: %d", ret);
 		return 0;
 	}
 
-	usb_hid_register_device(hid_dev,
-				hid_report_desc, sizeof(hid_report_desc),
-				&ops);
+	hid_dev = DEVICE_DT_GET_ONE(zephyr_hid_device);
+	if (!device_is_ready(hid_dev)) {
+		LOG_ERR("HID Device is not ready");
+		return -EIO;
+	}
 
-	usb_hid_init(hid_dev);
+	ret = hid_device_register(hid_dev,
+				  hid_report_desc, sizeof(hid_report_desc),
+				  &mouse_ops);
+	if (ret != 0) {
+		LOG_ERR("Failed to register HID Device, %d", ret);
+		return ret;
+	}
 
-#if defined(CONFIG_USB_DEVICE_STACK_NEXT)
-	ret = enable_usb_device_next();
-#else
-	ret = usb_enable(status_cb);
-#endif
+	sample_usbd = sample_usbd_init_device(NULL);
+	if (sample_usbd == NULL) {
+		LOG_ERR("Failed to initialize USB device");
+		return -ENODEV;
+	}
+
+	ret = usbd_enable(sample_usbd);
 	if (ret != 0) {
-		LOG_ERR("Failed to enable USB");
-		return 0;
+		LOG_ERR("Failed to enable device support");
+		return ret;
 	}
 
+	LOG_DBG("USB device support enabled");
+
 	while (true) {
 		UDC_STATIC_BUF_DEFINE(report, MOUSE_REPORT_COUNT);
 
 		k_msgq_get(&mouse_msgq, &report, K_FOREVER);
 
-		ret = hid_int_ep_write(hid_dev, report, MOUSE_REPORT_COUNT, NULL);
+		if (!mouse_ready) {
+			LOG_INF("USB HID device is not ready");
+			continue;
+		}
+
+		ret = hid_device_submit_report(hid_dev, MOUSE_REPORT_COUNT, report);
 		if (ret) {
-			LOG_ERR("HID write error, %d", ret);
+			LOG_ERR("HID submit report error, %d", ret);
 		} else {
-			k_sem_take(&ep_write_sem, K_FOREVER);
 			/* Toggle LED on sent report */
 			(void)gpio_pin_toggle(led0.port, led0.pin);
 		}
 	}
+
 	return 0;
 }

samples/subsys/usb/hid-mouse/src/main.c

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(hid-mouse)
+
+include(${ZEPHYR_BASE}/samples/subsys/usb/common/common.cmake)
+FILE(GLOB app_sources src/*.c)
+target_sources(app PRIVATE ${app_sources})

samples/subsys/usb/hid-mouse/usbd_next_prj.conf

@@ -0,0 +1,114 @@
+.. zephyr:code-sample:: legacy-usb-hid-mouse
+   :name: Legacy USB HID mouse
+   :relevant-api: _usb_device_core_api usb_hid_device_api input_interface
+
+   Implement a basic HID mouse device.
+
+Overview
+********
+
+This sample app demonstrates use of a USB Human Interface Device (HID) driver
+by the Zephyr project. This very simple driver enumerates a board with a button
+into a mouse that has a left mouse button and optionally (depending on
+the number of buttons on the board) a right mouse button, X-axis movement,
+and Y-axis movement.
+If the USB peripheral driver supports remote wakeup feature, wakeup request
+will be performed on every button click if the bus is in suspended state.
+This sample can be found under :zephyr_file:`samples/subsys/usb/legacy/hid-mouse` in the
+Zephyr project tree.
+
+.. note::
+   This samples demonstrate deprecated :ref:`usb_device_stack`.
+
+Requirements
+************
+
+This project requires an USB device driver and uses the :ref:`input` API.
+There must be a :dtcompatible:`gpio-keys` group of buttons or keys defined at
+the board level that can generate input events, otherwise the example will build
+but not work as expected.
+
+The key mapping in the sample is as follows:
+
+- ``INPUT_KEY_0``: left button
+- ``INPUT_KEY_1``: right button
+- ``INPUT_KEY_2``: move the mouse along the x-axis
+- ``INPUT_KEY_3``: move the mouse along the y-axis
+
+An LED must also be configured via the ``led0`` devicetree alias. You may also
+see this error if you try to build this sample for an unsupported board:
+
+.. code-block:: none
+
+   Unsupported board: led0 devicetree alias is not defined
+
+Building and Running
+********************
+
+This sample can be built for multiple boards, in this example we will build it
+for the nucleo_f070rb board:
+
+.. zephyr-app-commands::
+   :zephyr-app: samples/subsys/usb/legacy/hid-mouse
+   :board: nucleo_f070rb
+   :goals: build
+   :compact:
+
+After you have built and flashed the sample app image to your board, plug the
+board into a host device, for example, a PC running Linux.
+The board will be detected as shown by the Linux dmesg command:
+
+.. code-block:: console
+
+    dmesg | tail -10
+    usb 2-2: new full-speed USB device number 2 using at91_ohci
+    usb 2-2: New USB device found, idVendor=2fe3, idProduct=0007, bcdDevice= 2.03
+    usb 2-2: New USB device strings: Mfr=1, Product=2, SerialNumber=3
+    usb 2-2: Product: Zephyr HID mouse sample
+    usb 2-2: Manufacturer: ZEPHYR
+    usb 2-2: SerialNumber: 86FE679A598AC47A
+    input: ZEPHYR Zephyr HID mouse sample as /devices/soc0/ahb/600000.ohci/usb2/2-2/2-2:1.0/0003:2FE3:0100.0001/input/input0
+    hid-generic 0003:2FE3:0100.0001: input: USB HID v1.10 Mouse [ZEPHYR Zephyr HID mouse sample] on usb-at91-2/input0
+
+You can also monitor mouse events by using the standard Linux ``evtest`` command
+(see the `Ubuntu evtest man page`_ for more information about this tool):
+
+.. _Ubuntu evtest man page:
+   http://manpages.ubuntu.com/manpages/trusty/man1/evtest.1.html
+
+.. code-block:: console
+
+    sudo evtest /dev/input/event0
+    Input driver version is 1.0.1
+    Input device ID: bus 0x3 vendor 0x2fe3 product 0x7 version 0x110
+    Input device name: "ZEPHYR Zephyr HID mouse sample"
+    Supported events:
+      Event type 0 (EV_SYN)
+      Event type 1 (EV_KEY)
+        Event code 272 (BTN_LEFT)
+        Event code 273 (BTN_RIGHT)
+        Event code 274 (BTN_MIDDLE)
+      Event type 2 (EV_REL)
+        Event code 0 (REL_X)
+        Event code 1 (REL_Y)
+        Event code 8 (REL_WHEEL)
+      Event type 4 (EV_MSC)
+        Event code 4 (MSC_SCAN)
+    Properties:
+    Testing ... (interrupt to exit)
+
+When you press the button on your board, it will act as if the left
+mouse button was pressed, and this information will be displayed
+by ``evtest``:
+
+.. code-block:: console
+
+    Event: time 1167609663.618515, type 4 (EV_MSC), code 4 (MSC_SCAN), value 90001
+    Event: time 1167609663.618515, type 1 (EV_KEY), code 272 (BTN_LEFT), value 1
+    Event: time 1167609663.618515, -------------- SYN_REPORT ------------
+    Event: time 1167609663.730510, type 4 (EV_MSC), code 4 (MSC_SCAN), value 90001
+    Event: time 1167609663.730510, type 1 (EV_KEY), code 272 (BTN_LEFT), value 0
+    Event: time 1167609663.730510, -------------- SYN_REPORT ------------
+
+If your board has more than one button, they will act as right mouse button,
+X-axis movement, and Y-axis movement.

samples/subsys/usb/legacy/hid-mouse/CMakeLists.txt

@@ -0,0 +1,13 @@
+CONFIG_USB_DEVICE_STACK=y
+CONFIG_USB_DEVICE_HID=y
+CONFIG_USB_DEVICE_PRODUCT="Zephyr HID mouse sample"
+CONFIG_USB_DEVICE_PID=0x0007
+CONFIG_USB_DEVICE_INITIALIZE_AT_BOOT=n
+
+CONFIG_LOG=y
+CONFIG_USB_DRIVER_LOG_LEVEL_ERR=y
+CONFIG_USB_DEVICE_LOG_LEVEL_ERR=y
+
+CONFIG_GPIO=y
+CONFIG_INPUT=y
+CONFIG_INPUT_MODE_SYNCHRONOUS=y