Merge pull request #4689 from dhalbert/dynamic-usb-descriptors

Dynamic USB descriptors

Author: dhalbert

.github/workflows/build.yml

@@ -245,7 +245,6 @@ jobs:
         - "feather_mimxrt1011"
         - "feather_mimxrt1062"
         - "feather_nrf52840_express"
-        - "feather_radiofruit_zigbee"
         - "feather_stm32f405_express"
         - "fluff_m0"
         - "gemma_m0"

WEBUSB_README.md

@@ -62,33 +62,4 @@ The tinyusb examples already include a "WebUSB serial" example.
 Basically, this feature was ported into CircuitPython by pulling code snippets out of the
 tinyusb example, and putting them where they best belonged in the CircuitPython codebase.
 
-There was one complication:
-
-tinyusb uses C preprocessor macros to define things like USB descriptors.
-
-CircuitPython uses a Python program (tools/gen_usb_descriptor.py) to create USB descriptors (etc.)
-using "helper objects" from another repo (adafruit_usb_descriptor). This means some of the example
-code had to be adapted to the new programing model, and gen_usb_descriptor gained new command-line
-options to control the generated code.
-
-The generated files go into the "build" directory, look for autogen_usb_descriptor.c and
-genhdr/autogen_usb_descriptor.h.
-
-
-Also worth pointing out - the re-use of the CDC connect/disconnect mechanism is not actually part
-of the WebUSB standard, it's more of "common idiom". We make use of it here because we need to know
-when we should be paying attention to the WebUSB serial interface, and when we should ignore it..
-
-## Possible future work areas
-
-The current code uses the existing Python infrastructure to create the Interface descriptor, but
-simply outputs the code snippets from the original tinyusb demo code to create the WEBUSB_URL,
-BOS, and MS_OS_20 descriptors. I suppose additional work could be done to add these to the
-adafruit_usb_descriptor project, and then gen_usb_descriptor.py could be modified to make use
-of them.
-
-Program gen_usb_descriptor.py creates objects for most interface types, regardless of whether or
-not they are actually enabled. This increases the size of a generated string table. I made the
-new vendor-interface-related code not do this (because some of the ARM platforms would no longer
-build), but I did not go back and do this for the other interface types (CDC, MIDI, HID, etc.)
-Some FLASH savings are probably possible if this is done.
+### TODO: This needs to be reworked for dynamic USB descriptors.

docs/shared_bindings_matrix.py

@@ -155,7 +155,8 @@ def get_settings_from_makefile(port_dir, board_name):
 
     settings = {}
     for line in contents.stdout.split('\n'):
-        m = re.match(r'^([A-Z][A-Z0-9_]*) = (.*)$', line)
+        # Handle both = and := definitions.
+        m = re.match(r'^([A-Z][A-Z0-9_]*) :?= (.*)$', line)
         if m:
             settings[m.group(1)] = m.group(2)
 

frozen/Adafruit_CircuitPython_HID

@@ -87,6 +87,10 @@ msgstr ""
 msgid "%q list must be a list"
 msgstr ""
 
+#: shared-bindings/usb_hid/Device.c
+msgid "%q must be 1-255"
+msgstr ""
+
 #: shared-bindings/memorymonitor/AllocationAlarm.c
 msgid "%q must be >= 0"
 msgstr ""
@@ -99,6 +103,10 @@ msgstr ""
 msgid "%q must be >= 1"
 msgstr ""
 
+#: shared-bindings/usb_hid/Device.c
+msgid "%q must be None or 1-255"
+msgstr ""
+
 #: shared-module/vectorio/Polygon.c
 msgid "%q must be a tuple of length 2"
 msgstr ""
@@ -604,6 +612,11 @@ msgstr ""
 msgid "Can't set CCCD on local Characteristic"
 msgstr ""
 
+#: shared-bindings/storage/__init__.c shared-bindings/usb_cdc/__init__.c
+#: shared-bindings/usb_hid/__init__.c shared-bindings/usb_midi/__init__.c
+msgid "Cannot change USB devices now"
+msgstr ""
+
 #: shared-bindings/_bleio/Adapter.c
 msgid "Cannot create a new Adapter; use _bleio.adapter;"
 msgstr ""
@@ -646,7 +659,7 @@ msgid "Cannot record to a file"
 msgstr ""
 
 #: shared-module/storage/__init__.c
-msgid "Cannot remount '/' when USB is active."
+msgid "Cannot remount '/' when visible via USB."
 msgstr ""
 
 #: ports/atmel-samd/common-hal/microcontroller/__init__.c
@@ -1576,6 +1589,11 @@ msgstr ""
 msgid "No long integer support"
 msgstr ""
 
+#: shared-module/usb_hid/__init__.c
+#, c-format
+msgid "No more than %d HID devices allowed"
+msgstr ""
+
 #: shared-bindings/wifi/Radio.c
 msgid "No network with that ssid"
 msgstr ""
@@ -2184,6 +2202,14 @@ msgstr ""
 msgid "USB Error"
 msgstr ""
 
+#: supervisor/shared/safe_mode.c
+msgid "USB devices need more endpoints than are available."
+msgstr ""
+
+#: supervisor/shared/safe_mode.c
+msgid "USB devices specify too many interface names."
+msgstr ""
+
 #: shared-bindings/_bleio/UUID.c
 msgid "UUID integer value must be 0-0xffff"
 msgstr ""
@@ -3497,6 +3523,10 @@ msgstr ""
 msgid "no such attribute"
 msgstr ""
 
+#: shared-bindings/usb_hid/__init__.c
+msgid "non-Device in %q"
+msgstr ""
+
 #: ports/nrf/common-hal/_bleio/Connection.c
 msgid "non-UUID found in service_uuids_whitelist"
 msgstr ""

frozen/Adafruit_CircuitPython_SimpleMath

@@ -95,8 +95,8 @@
 #include "shared-module/network/__init__.h"
 #endif
 
-#if CIRCUITPY_USB_CDC
-#include "shared-module/usb_cdc/__init__.h"
+#if CIRCUITPY_USB_HID
+#include "shared-module/usb_hid/__init__.h"
 #endif
 
 #if CIRCUITPY_WIFI
@@ -299,6 +299,10 @@ STATIC bool run_code_py(safe_mode_t safe_mode) {
         supervisor_allocation* heap = allocate_remaining_memory();
         start_mp(heap);
 
+        #if CIRCUITPY_USB
+        usb_setup_with_vm();
+        #endif
+
         found_main = maybe_run_list(supported_filenames, &result);
         #if CIRCUITPY_FULL_BUILD
         if (!found_main){
@@ -500,11 +504,15 @@ STATIC void __attribute__ ((noinline)) run_boot_py(safe_mode_t safe_mode) {
         }
         #endif
 
-        // TODO(tannewt): Allocate temporary space to hold custom usb descriptors.
         filesystem_flush();
         supervisor_allocation* heap = allocate_remaining_memory();
         start_mp(heap);
 
+        #if CIRCUITPY_USB
+        // Set up default USB values after boot.py VM starts but before running boot.py.
+        usb_set_defaults();
+        #endif
+
         // TODO(tannewt): Re-add support for flashing boot error output.
         bool found_boot = maybe_run_list(boot_py_filenames, NULL);
         (void) found_boot;
@@ -517,7 +525,27 @@ STATIC void __attribute__ ((noinline)) run_boot_py(safe_mode_t safe_mode) {
         boot_output_file = NULL;
         #endif
 
+
+        #if CIRCUITPY_USB
+
+        // Some data needs to be carried over from the USB settings in boot.py
+        // to the next VM, while the heap is still available.
+        // Its size can vary, so save it temporarily on the stack,
+        // and then when the heap goes away, copy it in into a
+        // storage_allocation.
+
+        size_t size = usb_boot_py_data_size();
+        uint8_t usb_boot_py_data[size];
+        usb_get_boot_py_data(usb_boot_py_data, size);
+        #endif
+
         cleanup_after_vm(heap);
+
+        #if CIRCUITPY_USB
+        // Now give back the data we saved from the heap going away.
+        usb_return_boot_py_data(usb_boot_py_data, size);
+        #endif
+
     }
 }
 
@@ -527,6 +555,11 @@ STATIC int run_repl(void) {
     filesystem_flush();
     supervisor_allocation* heap = allocate_remaining_memory();
     start_mp(heap);
+
+    #if CIRCUITPY_USB
+    usb_setup_with_vm();
+    #endif
+
     autoreload_suspend();
     new_status_color(REPL_RUNNING);
     if (pyexec_mode_kind == PYEXEC_MODE_RAW_REPL) {
@@ -586,7 +619,14 @@ int __attribute__((used)) main(void) {
 
     run_boot_py(safe_mode);
 
-    // Start serial and HID after giving boot.py a chance to tweak behavior.
+    // Start USB after giving boot.py a chance to tweak behavior.
+    #if CIRCUITPY_USB
+    // Setup USB connection after heap is available.
+    // It needs the heap to build descriptors.
+    usb_init();
+    #endif
+
+    // Set up any other serial connection.
     serial_init();
 
     #if CIRCUITPY_BLEIO
@@ -640,6 +680,10 @@ void gc_collect(void) {
     common_hal_bleio_gc_collect();
     #endif
 
+    #if CIRCUITPY_USB_HID
+    usb_hid_gc_collect();
+    #endif
+
     #if CIRCUITPY_WIFI
     common_hal_wifi_gc_collect();
     #endif