Add superisor.set_usb_descriptor_overrides() function

Author: s-ol

locale/circuitpython.pot

@@ -4341,6 +4341,10 @@ msgstr ""
 msgid "string not supported; use bytes or bytearray"
 msgstr ""
 
+#: shared-bindings/supervisor/__init__.c
+msgid "string too long"
+msgstr ""
+
 #: extmod/moductypes.c
 msgid "struct: can't index"
 msgstr ""
@@ -4591,6 +4595,10 @@ msgstr ""
 msgid "value_count must be > 0"
 msgstr ""
 
+#: shared-bindings/supervisor/__init__.c
+msgid "vid or pid out of range"
+msgstr ""
+
 #: ports/espressif/common-hal/watchdog/WatchDogTimer.c
 msgid "watchdog not initialized"
 msgstr ""

shared-bindings/supervisor/__init__.c

@@ -38,6 +38,7 @@
 #include "supervisor/shared/traceback.h"
 #include "supervisor/shared/translate.h"
 #include "supervisor/shared/workflow.h"
+#include "supervisor/shared/usb/usb_desc.h"
 
 #include "shared-bindings/microcontroller/__init__.h"
 #include "shared-bindings/supervisor/__init__.h"
@@ -311,6 +312,63 @@ STATIC mp_obj_t supervisor_reset_terminal(mp_obj_t x_pixels, mp_obj_t y_pixels)
 }
 MP_DEFINE_CONST_FUN_OBJ_2(supervisor_reset_terminal_obj, supervisor_reset_terminal);
 
+//| def set_usb_descriptor_overrides(manufacturer: Optional[str] = None, product: Optional[str] = None, vid: Optional[int] = None, pid: Optional[int] = None) -> None:
+//|     """Override constants in the USB Device Descriptor.
+//|
+//|     Any omitted arguments will be left at their current or default values.
+//|     This method must be called in boot.py to have any effect."""
+//|     ...
+//|
+STATIC mp_obj_t supervisor_set_usb_descriptor_overrides(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_manufacturer, MP_ARG_OBJ, {.u_rom_obj = mp_const_none} },
+        { MP_QSTR_product, MP_ARG_OBJ, {.u_rom_obj = mp_const_none} },
+        { MP_QSTR_vid, MP_ARG_INT, {.u_int = -1} },
+        { MP_QSTR_pid, MP_ARG_INT, {.u_int = -1} },
+    };
+    struct {
+        mp_arg_val_t manufacturer;
+        mp_arg_val_t product;
+        mp_arg_val_t vid;
+        mp_arg_val_t pid;
+    } args;
+    mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, (mp_arg_val_t *)&args);
+
+    if (!mp_obj_is_str_or_bytes(args.manufacturer.u_obj) && args.manufacturer.u_obj != mp_const_none) {
+        mp_raise_TypeError(translate("argument has wrong type"));
+    }
+    if (!mp_obj_is_str_or_bytes(args.product.u_obj) && args.product.u_obj != mp_const_none) {
+        mp_raise_TypeError(translate("argument has wrong type"));
+    }
+
+    const char *manufacturer = NULL;
+    const char *product = NULL;
+
+    size_t len;
+    if (args.manufacturer.u_obj != mp_const_none) {
+        manufacturer = mp_obj_str_get_data(args.manufacturer.u_obj, &len);
+        if (len > 126) {
+          mp_raise_ValueError(translate("string too long"));
+        }
+    }
+    if (args.product.u_obj != mp_const_none) {
+        product = mp_obj_str_get_data(args.product.u_obj, &len);
+        if (len > 126) {
+          mp_raise_ValueError(translate("string too long"));
+        }
+    }
+    if (args.vid.u_int < -1 || args.vid.u_int >= (1 << 16)) {
+        mp_raise_ValueError(translate("vid or pid out of range"));
+    }
+    if (args.pid.u_int < -1 || args.pid.u_int >= (1 << 16)) {
+        mp_raise_ValueError(translate("vid or pid out of range"));
+    }
+
+    usb_set_descriptor_overrides(manufacturer, product, args.vid.u_int, args.pid.u_int);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(supervisor_set_usb_descriptor_overrides_obj, 0, supervisor_set_usb_descriptor_overrides);
+
 STATIC const mp_rom_map_elem_t supervisor_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_supervisor) },
     { MP_ROM_QSTR(MP_QSTR_enable_autoreload),  MP_ROM_PTR(&supervisor_enable_autoreload_obj) },
@@ -325,6 +383,7 @@ STATIC const mp_rom_map_elem_t supervisor_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_get_previous_traceback),  MP_ROM_PTR(&supervisor_get_previous_traceback_obj) },
     { MP_ROM_QSTR(MP_QSTR_disable_ble_workflow),  MP_ROM_PTR(&supervisor_disable_ble_workflow_obj) },
     { MP_ROM_QSTR(MP_QSTR_reset_terminal),  MP_ROM_PTR(&supervisor_reset_terminal_obj) },
+    { MP_ROM_QSTR(MP_QSTR_set_usb_descriptor_overrides),  MP_ROM_PTR(&supervisor_set_usb_descriptor_overrides_obj) },
 };
 
 STATIC MP_DEFINE_CONST_DICT(supervisor_module_globals, supervisor_module_globals_table);

supervisor/shared/usb/usb_desc.c

@@ -31,6 +31,7 @@
 #include "supervisor/memory.h"
 #include "supervisor/shared/safe_mode.h"
 #include "supervisor/usb.h"
+#include "supervisor/shared/usb/usb_desc.h"
 
 #if CIRCUITPY_USB_CDC
 #include "shared-bindings/usb_cdc/__init__.h"
@@ -68,8 +69,10 @@ static supervisor_allocation *device_descriptor_allocation;
 static supervisor_allocation *configuration_descriptor_allocation;
 static supervisor_allocation *string_descriptors_allocation;
 
-static const char manufacturer_name[] = USB_MANUFACTURER;
-static const char product_name[] = USB_PRODUCT;
+static char manufacturer_name[127] = USB_MANUFACTURER;
+static char product_name[127] = USB_PRODUCT;
+static uint16_t vid = USB_VID;
+static uint16_t pid = USB_PID;
 
 // Serial number string is UID length * 2 (2 nibbles per byte) + 1 byte for null termination.
 static char serial_number_hex_string[COMMON_HAL_MCU_PROCESSOR_UID_LENGTH * 2 + 1];
@@ -113,7 +116,7 @@ static const uint8_t configuration_descriptor_template[] = {
     0x32,        // 8 bMaxPower 100mA
 };
 
-static void usb_build_device_descriptor(uint16_t vid, uint16_t pid) {
+static void usb_build_device_descriptor() {
     device_descriptor_allocation =
         allocate_memory(align32_size(sizeof(device_descriptor_template)),
             /*high_address*/ false, /*movable*/ false);
@@ -336,11 +339,29 @@ void usb_build_descriptors(void) {
     current_interface_string = 1;
     collected_interface_strings_length = 0;
 
-    usb_build_device_descriptor(USB_VID, USB_PID);
+    usb_build_device_descriptor();
     usb_build_configuration_descriptor();
     usb_build_interface_string_table();
 }
 
+void usb_set_descriptor_overrides(const char *new_manufacturer, const char *new_product, mp_int_t new_vid, mp_int_t new_pid) {
+    if (new_manufacturer != NULL && strlen(new_manufacturer) < sizeof(manufacturer_name)) {
+        memcpy(manufacturer_name, new_manufacturer, strlen(new_manufacturer)+1);
+    }
+
+    if (new_product != NULL && strlen(new_product) < sizeof(product_name)) {
+        memcpy(product_name, new_product, strlen(new_product)+1);
+    }
+
+    if (new_vid >= 0) {
+      vid = new_vid;
+    }
+
+    if (new_pid >= 0) {
+      pid = new_pid;
+    }
+}
+
 // Invoked when GET DEVICE DESCRIPTOR is received.
 // Application return pointer to descriptor
 uint8_t const *tud_descriptor_device_cb(void) {

supervisor/shared/usb/usb_desc.h

@@ -0,0 +1,34 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Scott Shawcroft for Adafruit Industries
+ *
+ * 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.
+ */
+
+#ifndef MICROPY_INCLUDED_SUPERVISOR_USB_DESC_H
+#define MICROPY_INCLUDED_SUPERVISOR_USB_DESC_H
+
+#include "py/obj.h"
+
+void usb_set_descriptor_overrides(const char *new_manufacturer, const char *new_product, mp_int_t new_vid, mp_int_t new_pid);
+
+#endif // MICROPY_INCLUDED_SUPERVISOR_USB_DESC_H