tests: add tinyUSB CDC and MSC device test application

Makefile.features

@@ -29,4 +29,4 @@ FEATURES_CONFLICT += periph_gpio_irq:periph_gpio_ll_irq
 FEATURES_CONFLICT_MSG += "Only one GPIO IRQ implementation can be used"
 
 FEATURES_CONFLICT += periph_usbdev:tinyusb
-FEATURES_CONFLICT_MSG += "Package tinyUSB is not yet compatible with periph/usdev"
+FEATURES_CONFLICT_MSG += "Package tinyUSB is not yet compatible with periph/usbdev"

pkg/tinyusb/Kconfig

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 HAW Hamburg
+# Copyright (c) 2022 Gunar Schorcht
 #
 # This file is subject to the terms and conditions of the GNU Lesser
 # General Public License v2.1. See the file LICENSE in the top level

pkg/tinyusb/Makefile.dep

@@ -1,10 +1,10 @@
 # Package tinyUSB has its own USB device driver. Therefore, it cannot be used
 # together with periph/usbdev for now.
 ifneq (,$(filter periph_usbdev,$(USEMODULE)))
-  $(error "Package tinyUSB is not yet compatible with periph/usdev")
+  $(error "Package tinyUSB is not yet compatible with periph/usbdev")
 endif
 
-# tinyUSB muteces use priority inheritance
+# tinyUSB mutexes use priority inheritance
 # USEMODULE += core_mutex_priority_inheritance
 
 # tinyUSB modules always needed

pkg/tinyusb/contrib/include/tinyusb.h

@@ -32,12 +32,12 @@
 #endif
 
 #ifndef TINYUSB_TUD_RHPORT
-/** tinyUSB RHPort number used for device, default value is 0 */
+/** tinyUSB RHPort number used for the device stack, default value is 0 */
 #define TINYUSB_TUD_RHPORT              0
 #endif
 
 #ifndef TINYUSB_TUH_RHPORT
-/** tinyUSB RHPort number used for host, defaults value is 0 */
+/** tinyUSB RHPort number used for the host stack, defaults value is 0 */
 #define TINYUSB_TUH_RHPORT              0
 #endif
 

tests/pkg_tinyusb_cdc_msc/Makefile

@@ -0,0 +1,13 @@
+include ../Makefile.tests_common
+
+USB_VID ?= $(USB_VID_TESTING)
+USB_PID ?= $(USB_PID_TESTING)
+
+USEPKG += tinyusb
+USEMODULE += tinyusb_class_cdc
+USEMODULE += tinyusb_class_msc
+USEMODULE += tinyusb_device
+
+include $(RIOTBASE)/Makefile.include
+
+INCLUDES += -I$(APPDIR)

tests/pkg_tinyusb_cdc_msc/README.md

@@ -0,0 +1,43 @@
+# TinyUSB package test application
+
+## Overview
+
+This application uses the tinyUSB device stack to emulate a mass storage
+device (MSC) with a communication interface (CDC).
+
+**Please note:** RIOT doesn't own any USB vendor and product ID. The test
+application therefore uses `USB_VID_TESTING=0x1209` as manufacturer ID and
+`USB_PID_TESTING=0x7d01` as product ID. Do not use these IDs outside of
+test environments! They MUST NOT be used on any device that is redistributed,
+sold or manufactured, as they are not unique!
+
+To compile this application with your own vendor and product ID, set the
+variables `USB_VID` and `USB_PID` in the makefile or at the command line,
+for example
+
+```
+USB_VID=1234 USB_PID=5678 BOARD=... make -C tests/pkg_tinyusb_cdc_msc
+```
+
+## Usage
+
+Once the application is flashed, the device should be mounted when it is
+connected to a host. That is,
+
+- the mass storage interface is mounted as volume `TinyUSB MSC` in the
+  operating system and
+- the communication interface is mounted as a serial device, for example
+  as `/dev/ttyACM0` on Linux.
+
+It should then be possible
+
+1. to read from and write to the mass storage with the usual file operations
+   of the operating system
+2. to connect to the serial interface of the device with a terminal program, e.g.
+   ```
+   python -m serial.tools.miniterm /dev/ttyACM0 115200
+   ```
+   and get the entered characters sent back.
+
+The test application uses LED0, if present, to indicate the status of the
+device by blinking at different frequencies.

tests/pkg_tinyusb_cdc_msc/app.config.test

@@ -0,0 +1,5 @@
+CONFIG_PACKAGE_TINYUSB=y
+CONFIG_MODULE_TINYUSB_CLASS_CDC=y
+CONFIG_MODULE_TINYUSB_CLASS_MSC=y
+CONFIG_MODULE_TINYUSB_COMMON=y
+CONFIG_MODULE_TINYUSB_DEVICE=y

tests/pkg_tinyusb_cdc_msc/main.c

@@ -0,0 +1,195 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach (tinyusb.org)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+
+#include "board.h"
+#include "log.h"
+#include "ztimer.h"
+
+#include "tusb.h"
+#include "tinyusb.h"
+
+/*
+ * --------------------------------------------------------------------
+ * MACRO CONSTANT TYPEDEF PROTYPES
+ * --------------------------------------------------------------------
+ */
+
+/*
+ * Blink pattern
+ * - 250 ms  : device not mounted
+ * - 1000 ms : device mounted
+ * - 2500 ms : device is suspended
+ */
+enum {
+  BLINK_NOT_MOUNTED = 250,
+  BLINK_MOUNTED = 1000,
+  BLINK_SUSPENDED = 2500,
+};
+
+static uint32_t blink_interval_ms = BLINK_NOT_MOUNTED;
+
+/*
+ * --------------------------------------------------------------------
+ * BLINKING TASK
+ * --------------------------------------------------------------------
+ */
+char led_thread_stack[THREAD_STACKSIZE_MAIN];
+
+void *led_thread_impl(void *arg)
+{
+    (void)arg;
+
+    while (1) {
+        ztimer_sleep(ZTIMER_MSEC, blink_interval_ms);
+#ifdef LED0_TOGGLE
+        LED0_TOGGLE;
+#else
+        printf("Blinking with %"PRIu32" msec!\n", blink_interval_ms);
+#endif
+    }
+}
+
+void cdc_task(void);
+
+/* ------------- MAIN ------------- */
+
+int main(void)
+{
+    ztimer_sleep(ZTIMER_MSEC, 200);
+
+    thread_create(led_thread_stack, sizeof(led_thread_stack),
+                  THREAD_PRIORITY_MAIN + 1,
+                  THREAD_CREATE_WOUT_YIELD | THREAD_CREATE_STACKTEST,
+                  led_thread_impl, NULL, "led");
+
+    /* initialize the tinyUSB stack including used peripherals and
+     * start the tinyUSB thread */
+    tinyusb_setup();
+
+    while (1) {
+        ztimer_sleep(ZTIMER_MSEC, 10);
+        cdc_task();
+    }
+
+    return 0;
+}
+
+/*
+ * --------------------------------------------------------------------
+ * Device callbacks to be implemented
+ * --------------------------------------------------------------------
+ */
+
+/*
+ * Invoked when device is mounted
+ */
+void tud_mount_cb(void)
+{
+    printf("tinyUSB %s\n", __func__);
+    blink_interval_ms = BLINK_MOUNTED;
+}
+
+/*
+ * Invoked when device is unmounted
+ */
+void tud_umount_cb(void)
+{
+    printf("tinyUSB %s\n", __func__);
+    blink_interval_ms = BLINK_NOT_MOUNTED;
+}
+
+/*
+ * Invoked when usb bus is suspended
+ * remote_wakeup_en : if host allow us  to perform remote wakeup
+ * Within 7ms, device must draw an average of current less than 2.5 mA from bus
+ */
+void tud_suspend_cb(bool remote_wakeup_en)
+{
+    (void) remote_wakeup_en;
+    printf("tinyUSB %s\n", __func__);
+    blink_interval_ms = BLINK_SUSPENDED;
+}
+
+/*
+ * Invoked when usb bus is resumed
+ */
+void tud_resume_cb(void)
+{
+    printf("tinyUSB %s\n", __func__);
+    blink_interval_ms = BLINK_MOUNTED;
+}
+
+/*
+ * --------------------------------------------------------------------+
+ * USB CDC
+ * --------------------------------------------------------------------+
+ */
+void cdc_task(void)
+{
+    /*
+     * connected() check for DTR bit
+     * Most but not all terminal client set this when making connection
+     */
+    if ( tud_cdc_connected() ) {
+        /* connected and there are data available */
+        if ( tud_cdc_available() )
+        {
+           /* read data */
+           char buf[64];
+           uint32_t count = tud_cdc_read(buf, sizeof(buf));
+           (void) count;
+
+           /*
+            * Echo back
+            * Note: Skip echo by commenting out write() and write_flush()
+            * for throughput test e.g
+            *    $ dd if=/dev/zero of=/dev/ttyACM0 count=10000
+            */
+          tud_cdc_write(buf, count);
+          tud_cdc_write_flush();
+        }
+    }
+}
+
+/*
+ * Invoked when cdc when line state changed e.g connected/disconnected
+ */
+void tud_cdc_line_state_cb(uint8_t itf, bool dtr, bool rts)
+{
+    (void) itf;
+    (void) rts;
+
+    /* TODO set some indicator */
+    if ( dtr ) {
+        /* Terminal connected */
+    }
+    else {
+        /* Terminal disconnected */
+    }
+}