Allow swapping LSFS USB on ESP32-P4 to USB OTG

tannewt · tannewt · commit 46408592cd64 · 2025-12-03T16:11:22.000-08:00
This allows full USB device on the M5Stack Tab5. Improves micropython#10666
diff --git a/lib/tinyusb b/lib/tinyusb
@@ -1 +1 @@
-Subproject commit c1bf19ed6cf1eaa791f221c1bc5ce4b3d069f76d
+Subproject commit 3af1bec1a9161ee8dec29487831f7ac7ade9e189
diff --git a/ports/analog/boards/apard32690/mpconfigboard.mk b/ports/analog/boards/apard32690/mpconfigboard.mk
@@ -19,7 +19,6 @@ USB_VID=0x0456
 USB_PID=0x003C
 USB_MANUFACTURER="Analog Devices, Inc."
 USB_PRODUCT="MAX32690 APARD"
-USB_HIGHSPEED=1
 
 # NOTE: MAX32 devices do not support IN/OUT pairs on the same EP
 USB_NUM_ENDPOINT_PAIRS=12
diff --git a/ports/analog/boards/max32690evkit/mpconfigboard.mk b/ports/analog/boards/max32690evkit/mpconfigboard.mk
@@ -19,7 +19,6 @@ USB_VID=0x0456
 USB_PID=0x003D
 USB_MANUFACTURER="Analog Devices, Inc."
 USB_PRODUCT="MAX32690 EvKit"
-USB_HIGHSPEED=1
 
 # NOTE: MAX32 devices do not support IN/OUT pairs on the same EP
 USB_NUM_ENDPOINT_PAIRS=12
diff --git a/ports/analog/mpconfigport.h b/ports/analog/mpconfigport.h
@@ -12,6 +12,8 @@
 // 24KiB stack
 #define CIRCUITPY_DEFAULT_STACK_SIZE            0x6000
 
+#define CIRCUITPY_USB_DEVICE_HIGH_SPEED (1)
+
 // Also includes mpconfigboard.h
 #include "py/circuitpy_mpconfig.h"
 
diff --git a/ports/broadcom/mpconfigport.h b/ports/broadcom/mpconfigport.h
@@ -26,6 +26,8 @@
 #define MICROPY_FATFS_EXFAT    (1)
 #define MICROPY_FATFS_MKFS_FAT32  (1)
 
+#define CIRCUITPY_USB_DEVICE_HIGH_SPEED (1)
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 
 // This also includes mpconfigboard.h.
diff --git a/ports/broadcom/mpconfigport.mk b/ports/broadcom/mpconfigport.mk
@@ -22,7 +22,6 @@ CIRCUITPY_VIDEOCORE = 1
 INTERNAL_FLASH_FILESYSTEM = 1
 
 USB_NUM_ENDPOINT_PAIRS = 8
-USB_HIGHSPEED = 1
 
 CIRCUITPY_BUILD_EXTENSIONS ?= disk.img.zip,kernel8.img
 
diff --git a/ports/cxd56/mpconfigport.h b/ports/cxd56/mpconfigport.h
@@ -23,6 +23,8 @@
 #define USB_MSC_EP_NUM_OUT (5)
 #define USB_MSC_EP_NUM_IN (4)
 
+#define CIRCUITPY_USB_DEVICE_HIGH_SPEED (1)
+
 #include "py/circuitpy_mpconfig.h"
 
 #define MICROPY_BYTES_PER_GC_BLOCK              (32)
diff --git a/ports/cxd56/mpconfigport.mk b/ports/cxd56/mpconfigport.mk
@@ -1,5 +1,3 @@
-USB_HIGHSPEED = 1
-
 # Number of USB endpoint pairs.
 USB_NUM_ENDPOINT_PAIRS = 6
 
diff --git a/ports/espressif/boards/m5stack_tab5/mpconfigboard.h b/ports/espressif/boards/m5stack_tab5/mpconfigboard.h
@@ -25,4 +25,5 @@
 #define DEFAULT_SPI_BUS_MISO        (&pin_GPIO19)
 
 // Use the second USB device (numbered 0 and 1)
-#define CIRCUITPY_USB_DEVICE_INSTANCE 1
+#define CIRCUITPY_USB_DEVICE_INSTANCE 0
+#define CIRCUITPY_ESP32P4_SWAP_LSFS (1)
diff --git a/ports/espressif/common-hal/microcontroller/Pin.c b/ports/espressif/common-hal/microcontroller/Pin.c
@@ -211,11 +211,26 @@ static const uint64_t pin_mask_reset_forbidden =
     GPIO_SEL_32 |
     GPIO_SEL_33 |
     GPIO_SEL_34 |
+    // USB is on the FS OTG
+    #if CIRCUITPY_USB_DEVICE_INSTANCE == 0
+    #if CIRCUITPY_ESP32P4_SWAP_LSFS == 1
+    // We leave 24 and 25 alone in addition to 26 and 27 when swapped. It doesn't work otherwise. (Not sure why.)
+    GPIO_SEL_24 |         // USB D-
+    GPIO_SEL_25 |         // USB D+
+    #endif
+    GPIO_SEL_26 |         // USB D-
+    GPIO_SEL_27 |         // USB D+
+    #endif
     #if CIRCUITPY_ESP_USB_SERIAL_JTAG || (defined(CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG) && CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG)
     // Never ever reset serial/JTAG communication pins.
+    #if CIRCUITPY_ESP32P4_SWAP_LSFS == 1
+    GPIO_SEL_26 |         // USB D-
+    GPIO_SEL_27 |         // USB D+
+    #else
     GPIO_SEL_24 |         // USB D-
     GPIO_SEL_25 |         // USB D+
     #endif
+    #endif
     #if defined(CONFIG_ESP_CONSOLE_UART_DEFAULT) && CONFIG_ESP_CONSOLE_UART_DEFAULT && CONFIG_ESP_CONSOLE_UART_NUM == 0
     // Never reset debug UART/console pins.
     GPIO_SEL_37 |
diff --git a/ports/espressif/mpconfigport.h b/ports/espressif/mpconfigport.h
@@ -68,3 +68,15 @@ extern portMUX_TYPE background_task_mutex;
 #ifndef CIRCUITPY_WIFI_DEFAULT_TX_POWER
 #define CIRCUITPY_WIFI_DEFAULT_TX_POWER (20)
 #endif
+
+#ifndef CIRCUITPY_USB_DEVICE_HIGH_SPEED
+#if defined(CONFIG_IDF_TARGET_ESP32P4) && CIRCUITPY_USB_DEVICE_INSTANCE == 1
+#define CIRCUITPY_USB_DEVICE_HIGH_SPEED (1)
+#else
+#define CIRCUITPY_USB_DEVICE_HIGH_SPEED (0)
+#endif
+#endif
+
+#ifndef CIRCUITPY_ESP32P4_SWAP_LSFS
+#define CIRCUITPY_ESP32P4_SWAP_LSFS (0)
+#endif
diff --git a/ports/espressif/mpconfigport.mk b/ports/espressif/mpconfigport.mk
@@ -290,7 +290,6 @@ CIRCUITPY_TOUCHIO_USE_NATIVE = 0
 # Second stage bootloader doesn't work when the factory partition is empty due to
 # UF2 missing.
 UF2_BOOTLOADER = 0
-USB_HIGHSPEED = 1
 CIRCUITPY_USB_HID = 0
 CIRCUITPY_USB_MIDI = 0
 CIRCUITPY_TUSB_MEM_ALIGN = 64
diff --git a/ports/espressif/supervisor/usb.c b/ports/espressif/supervisor/usb.c
@@ -2,6 +2,7 @@
 //
 // SPDX-FileCopyrightText: Copyright (c) 2018 hathach for Adafruit Industries
 // SPDX-FileCopyrightText: Copyright (c) 2019 Lucian Copeland for Adafruit Industries
+// SPDX-FileContributor: 2025 Nicolai Electronics
 //
 // SPDX-License-Identifier: MIT
 
@@ -12,6 +13,7 @@
 #include "shared/readline/readline.h"
 
 #include "hal/gpio_ll.h"
+#include "hal/usb_serial_jtag_ll.h"
 
 #include "esp_err.h"
 #include "esp_private/usb_phy.h"
@@ -37,7 +39,7 @@
 StackType_t usb_device_stack[USBD_STACK_SIZE];
 StaticTask_t usb_device_taskdef;
 
-static usb_phy_handle_t phy_hdl;
+static usb_phy_handle_t device_phy_hdl;
 
 // USB Device Driver task
 // This top level thread process all usb events and invoke callbacks
@@ -62,13 +64,64 @@ void init_usb_hardware(void) {
     usb_phy_config_t phy_conf = {
         .controller = USB_PHY_CTRL_OTG,
         .target = USB_PHY_TARGET_INT,
+        .otg_mode = USB_OTG_MODE_DEVICE,
+        #if defined(CONFIG_IDF_TARGET_ESP32P4) && CIRCUITPY_USB_DEVICE_INSTANCE == 0
+            .otg_speed = USB_PHY_SPEED_FULL,
+        #else
+        // https://github.com/hathach/tinyusb/issues/2943#issuecomment-2601888322
+        // Set speed to undefined (auto-detect) to avoid timing/race issue with S3 with host such as macOS
+            .otg_speed = USB_PHY_SPEED_UNDEFINED,
+        #endif
+    };
+    usb_new_phy(&phy_conf, &device_phy_hdl);
+
+    #if CIRCUITPY_ESP32P4_SWAP_LSFS == 1
+    #ifndef CONFIG_IDF_TARGET_ESP32P4
+    #error "LSFS swap is only supported on ESP32P4"
+    #endif
+    // Switch the USB PHY
+    const usb_serial_jtag_pull_override_vals_t override_disable_usb = {
+        .dm_pd = true, .dm_pu = false, .dp_pd = true, .dp_pu = false};
+    const usb_serial_jtag_pull_override_vals_t override_enable_usb = {
+        .dm_pd = false, .dm_pu = false, .dp_pd = false, .dp_pu = true};
+
+    // Drop off the bus by removing the pull-up on USB DP
+    usb_serial_jtag_ll_phy_enable_pull_override(&override_disable_usb);
 
+    // Select USB mode by swapping and un-swapping the two PHYs
+    vTaskDelay(pdMS_TO_TICKS(500));  // Wait for disconnect before switching to device
+    usb_serial_jtag_ll_phy_select(1);
+
+    // Put the device back onto the bus by re-enabling the pull-up on USB DP
+    usb_serial_jtag_ll_phy_enable_pull_override(&override_enable_usb);
+    usb_serial_jtag_ll_phy_disable_pull_override();
+    #endif
+
+    // Pin the USB task to the same core as CircuitPython. This way we leave
+    // the other core for networking.
+    (void)xTaskCreateStaticPinnedToCore(usb_device_task,
+        "usbd",
+        USBD_STACK_SIZE,
+        NULL,
+        5,
+        usb_device_stack,
+        &usb_device_taskdef,
+        xPortGetCoreID());
+    #endif
+    // Configure USB PHY
+    usb_phy_config_t phy_conf = {
+        .controller = USB_PHY_CTRL_OTG,
+        .target = USB_PHY_TARGET_INT,
         .otg_mode = USB_OTG_MODE_DEVICE,
+        #if defined(CONFIG_IDF_TARGET_ESP32P4) && CIRCUITPY_USB_DEVICE_INSTANCE == 0
+            .otg_speed = USB_PHY_SPEED_FULL,
+        #else
         // https://github.com/hathach/tinyusb/issues/2943#issuecomment-2601888322
         // Set speed to undefined (auto-detect) to avoid timing/race issue with S3 with host such as macOS
-        .otg_speed = USB_PHY_SPEED_UNDEFINED,
+            .otg_speed = USB_PHY_SPEED_UNDEFINED,
+        #endif
     };
-    usb_new_phy(&phy_conf, &phy_hdl);
+    usb_new_phy(&phy_conf, &device_phy_hdl);
 
     // Pin the USB task to the same core as CircuitPython. This way we leave
     // the other core for networking.
diff --git a/ports/mimxrt10xx/mpconfigport.h b/ports/mimxrt10xx/mpconfigport.h
@@ -25,6 +25,8 @@ extern uint8_t _ld_default_stack_size;
 // are aligned to cache lines.
 #define MICROPY_BYTES_PER_GC_BLOCK              (32)
 
+#define CIRCUITPY_USB_DEVICE_HIGH_SPEED (1)
+
 #include "py/circuitpy_mpconfig.h"
 
 // TODO:
diff --git a/ports/mimxrt10xx/mpconfigport.mk b/ports/mimxrt10xx/mpconfigport.mk
@@ -2,8 +2,6 @@ LD_FILE = $(FLASH).ld $(CHIP_FAMILY).ld imxrt10xx.ld
 
 INTERNAL_LIBM = 1
 
-USB_HIGHSPEED = 1
-
 # Number of USB endpoint pairs.
 USB_NUM_ENDPOINT_PAIRS = 8
 # Align buffers on the cache boundary so we don't inadvertently load them early.
diff --git a/py/circuitpy_mpconfig.h b/py/circuitpy_mpconfig.h
@@ -539,10 +539,18 @@ void background_callback_run_all(void);
 #define CIRCUITPY_USB_DEVICE_INSTANCE 0
 #endif
 
+#ifndef CIRCUITPY_USB_DEVICE_HIGH_SPEED
+#define CIRCUITPY_USB_DEVICE_HIGH_SPEED 0
+#endif
+
 #ifndef CIRCUITPY_USB_HOST_INSTANCE
 #define CIRCUITPY_USB_HOST_INSTANCE -1
 #endif
 
+#ifndef CIRCUITPY_USB_HOST_HIGH_SPEED
+#define CIRCUITPY_USB_HOST_HIGH_SPEED 0
+#endif
+
 // If the port requires certain USB endpoint numbers, define these in mpconfigport.h.
 
 #ifndef USB_CDC_EP_NUM_NOTIFICATION
diff --git a/shared-module/usb_cdc/__init__.c b/shared-module/usb_cdc/__init__.c
@@ -105,7 +105,7 @@ static const uint8_t usb_cdc_descriptor_template[] = {
     0xFF,        // 54 bEndpointAddress (OUT/H2D) [SET AT RUNTIME]
 #define CDC_DATA_OUT_ENDPOINT_INDEX 54
     0x02,        // 55 bmAttributes (Bulk)
-    #if USB_HIGHSPEED
+    #if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
     0x00, 0x02,  // 56,57  wMaxPacketSize 512
     #else
     0x40, 0x00,  // 56,57  wMaxPacketSize 64
@@ -118,7 +118,7 @@ static const uint8_t usb_cdc_descriptor_template[] = {
     0xFF,        // 61 bEndpointAddress (IN/D2H) [SET AT RUNTIME: 0x80 | number]
 #define CDC_DATA_IN_ENDPOINT_INDEX 61
     0x02,        // 62 bmAttributes (Bulk)
-    #if USB_HIGHSPEED
+    #if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
     0x00, 0x02,  // 63,64 wMaxPacketSize 512
     #else
     0x40, 0x00,  // 63,64 wMaxPacketSize 64
@@ -326,7 +326,7 @@ static const uint8_t usb_vendor_descriptor_template[] = {
     0xFF,        // 11 bEndpointAddress (IN/D2H) [SET AT RUNTIME: number]
 #define VENDOR_OUT_ENDPOINT_INDEX 11
     0x02,        // 12 bmAttributes (Bulk)
-    #if USB_HIGHSPEED
+    #if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
     0x00, 0x02,  // 13,14  wMaxPacketSize 512
     #else
     0x40, 0x00,  // 13,14  wMaxPacketSize 64
diff --git a/shared-module/usb_midi/__init__.c b/shared-module/usb_midi/__init__.c
@@ -106,7 +106,7 @@ static const uint8_t usb_midi_descriptor_template[] = {
     0xFF,        // 66 bEndpointAddress (OUT/H2D) [SET AT RUNTIME]
 #define MIDI_STREAMING_OUT_ENDPOINT_INDEX (66)
     0x02,        // 67 bmAttributes (Bulk)
-    #if USB_HIGHSPEED
+    #if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
     0x00, 0x02,  // 68,69 wMaxPacketSize (512)
     #else
     0x40, 0x00,  // 68,69 wMaxPacketSize (64)
@@ -126,7 +126,7 @@ static const uint8_t usb_midi_descriptor_template[] = {
     0xFF,        // 78 bEndpointAddress (IN/D2H) [SET AT RUNTIME: 0x80 | number]
 #define MIDI_STREAMING_IN_ENDPOINT_INDEX (78)
     0x02,        // 79 bmAttributes (Bulk)
-    #if USB_HIGHSPEED
+    #if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
     0x00, 0x02,  // 80, 81 wMaxPacketSize (512)
     #else
     0x40, 0x00,  // 80, 81 wMaxPacketSize (64)
diff --git a/supervisor/shared/usb/tusb_config.h b/supervisor/shared/usb/tusb_config.h
@@ -79,18 +79,16 @@ extern "C" {
 
 #if CIRCUITPY_USB_DEVICE
 
-#if CIRCUITPY_USB_DEVICE_INSTANCE == 0
-#if USB_HIGHSPEED
-#define CFG_TUSB_RHPORT0_MODE       (OPT_MODE_DEVICE | OPT_MODE_HIGH_SPEED)
+#if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
+#define _DEVICE_SPEED OPT_MODE_HIGH_SPEED
 #else
-#define CFG_TUSB_RHPORT0_MODE       (OPT_MODE_DEVICE)
+#define _DEVICE_SPEED 0
 #endif
+
+#if CIRCUITPY_USB_DEVICE_INSTANCE == 0
+#define CFG_TUSB_RHPORT0_MODE       (OPT_MODE_DEVICE | _DEVICE_SPEED)
 #elif CIRCUITPY_USB_DEVICE_INSTANCE == 1
-#if USB_HIGHSPEED
-#define CFG_TUSB_RHPORT1_MODE       (OPT_MODE_DEVICE | OPT_MODE_HIGH_SPEED)
-#else
-#define CFG_TUSB_RHPORT1_MODE       (OPT_MODE_DEVICE)
-#endif
+#define CFG_TUSB_RHPORT1_MODE       (OPT_MODE_DEVICE | _DEVICE_SPEED)
 #endif
 
 // Use DMA with the USB peripheral.
@@ -157,18 +155,16 @@ extern "C" {
 #define CFG_TUH_RPI_PIO_USB 1
 #endif
 
-#if CIRCUITPY_USB_HOST_INSTANCE == 0
-#if USB_HIGHSPEED
-#define CFG_TUSB_RHPORT0_MODE       (OPT_MODE_HOST | OPT_MODE_HIGH_SPEED)
+#if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
+#define _HOST_SPEED OPT_MODE_HIGH_SPEED
 #else
-#define CFG_TUSB_RHPORT0_MODE       (OPT_MODE_HOST)
+#define _HOST_SPEED 0
 #endif
+
+#if CIRCUITPY_USB_HOST_INSTANCE == 0
+#define CFG_TUSB_RHPORT0_MODE       (OPT_MODE_HOST | _HOST_SPEED)
 #elif CIRCUITPY_USB_HOST_INSTANCE == 1
-#if USB_HIGHSPEED
-#define CFG_TUSB_RHPORT1_MODE       (OPT_MODE_HOST | OPT_MODE_HIGH_SPEED)
-#else
-#define CFG_TUSB_RHPORT1_MODE       (OPT_MODE_HOST)
-#endif
+#define CFG_TUSB_RHPORT1_MODE       (OPT_MODE_HOST | _HOST_SPEED)
 #endif
 
 // Size of buffer to hold descriptors and other data used for enumeration
diff --git a/supervisor/shared/usb/usb_msc_flash.c b/supervisor/shared/usb/usb_msc_flash.c
@@ -72,7 +72,7 @@ static const uint8_t usb_msc_descriptor_template[] = {
     0xFF,        // 11 bEndpointAddress (IN/D2H) [SET AT RUNTIME: 0x80 | number]
 #define MSC_IN_ENDPOINT_INDEX (11)
     0x02,        // 12 bmAttributes (Bulk)
-    #if USB_HIGHSPEED
+    #if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
     0x00, 0x02,  // 13,14 wMaxPacketSize 512
     #else
     0x40, 0x00,  // 13,14 wMaxPacketSize 64
@@ -85,7 +85,7 @@ static const uint8_t usb_msc_descriptor_template[] = {
     0xFF,        // 18 bEndpointAddress (OUT/H2D) [SET AT RUNTIME]
 #define MSC_OUT_ENDPOINT_INDEX (18)
     0x02,        // 19 bmAttributes (Bulk)
-    #if USB_HIGHSPEED
+    #if CIRCUITPY_USB_DEVICE_HIGH_SPEED == 1
     0x00, 0x02,  // 20,21 wMaxPacketSize 512
     #else
     0x40, 0x00,  // 20,21 wMaxPacketSize 64
diff --git a/supervisor/supervisor.mk b/supervisor/supervisor.mk
@@ -259,9 +259,6 @@ ifeq ($(CIRCUITPY_USB_CDC),1)
 CFLAGS += -DCFG_TUD_CDC=2
 endif
 
-USB_HIGHSPEED ?= 0
-CFLAGS += -DUSB_HIGHSPEED=$(USB_HIGHSPEED)
-
 $(BUILD)/supervisor/shared/translate/translate.o: $(HEADER_BUILD)/qstrdefs.generated.h $(HEADER_BUILD)/compressed_translations.generated.h
 
 CIRCUITPY_DISPLAY_FONT ?= "../../tools/fonts/ter-u12n.bdf"

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-USB_HIGHSPEED = 1`
`2`		`-`
`3`	`1`	`# Number of USB endpoint pairs.`
`4`	`2`	`USB_NUM_ENDPOINT_PAIRS = 6`
`5`	`3`