Merge pull request adafruit#406 from adafruit/prevent-s3-jtag-enumerate

hathach · web-flow · commit 819a49b0939a · 2024-09-04T21:11:28.000+07:00
prevent S3 enumerated as USB JTAG while waiting for 2nd reset
diff --git a/.github/actions/setup_toolchain/action.yml b/.github/actions/setup_toolchain/action.yml
@@ -4,8 +4,8 @@ inputs:
   toolchain:
     description: 'Toolchain name'
     required: true
-  toolchain_url:
-    description: 'Toolchain URL or version'
+  toolchain_version:
+    description: 'Toolchain version'
     required: false
 
 outputs:
@@ -28,7 +28,26 @@ runs:
       uses: ./.github/actions/setup_toolchain/espressif
       with:
         toolchain: ${{ inputs.toolchain }}
-        toolchain_url: ${{ inputs.toolchain_url }}
+        toolchain_version: ${{ inputs.toolchain_version }}
+
+    - name: Get Toolchain URL
+      if: >-
+        inputs.toolchain != 'arm-gcc' &&
+        inputs.toolchain != 'arm-iar' &&
+        inputs.toolchain != 'esp-idf'
+      id: set-toolchain-url
+      run: |
+        TOOLCHAIN_JSON='{
+          "aarch64-gcc": "https://developer.arm.com/-/media/Files/downloads/gnu-a/10.3-2021.07/binrel/gcc-arm-10.3-2021.07-x86_64-aarch64-none-elf.tar.xz",
+          "arm-clang": "https://github.com/ARM-software/LLVM-embedded-toolchain-for-Arm/releases/download/release-17.0.1/LLVMEmbeddedToolchainForArm-17.0.1-Linux-x86_64.tar.xz",
+          "msp430-gcc": "http://software-dl.ti.com/msp430/msp430_public_sw/mcu/msp430/MSPGCC/9_2_0_0/export/msp430-gcc-9.2.0.50_linux64.tar.bz2",
+          "riscv-gcc": "https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/download/v13.2.0-2/xpack-riscv-none-elf-gcc-13.2.0-2-linux-x64.tar.gz",
+          "rx-gcc": "http://gcc-renesas.com/downloads/get.php?f=rx/8.3.0.202004-gnurx/gcc-8.3.0.202004-GNURX-ELF.run"
+        }'
+        TOOLCHAIN_URL=$(echo $TOOLCHAIN_JSON | jq -r '.["${{ inputs.toolchain }}"]')
+        echo "toolchain_url=$TOOLCHAIN_URL"
+        echo "toolchain_url=$TOOLCHAIN_URL" >> $GITHUB_OUTPUT
+      shell: bash
 
     - name: Download Toolchain
       if: >-
@@ -38,4 +57,4 @@ runs:
       uses: ./.github/actions/setup_toolchain/download
       with:
         toolchain: ${{ inputs.toolchain }}
-        toolchain_url: ${{ inputs.toolchain_url }}
+        toolchain_url: ${{ steps.set-toolchain-url.outputs.toolchain_url }}
diff --git a/.github/actions/setup_toolchain/espressif/action.yml b/.github/actions/setup_toolchain/espressif/action.yml
@@ -4,8 +4,8 @@ inputs:
   toolchain:
     description: 'Toolchain name'
     required: true
-  toolchain_url:
-    description: 'Toolchain URL or version'
+  toolchain_version:
+    description: 'Toolchain version'
     required: true
 
 runs:
@@ -22,14 +22,14 @@ runs:
       id: cache-toolchain-espressif
       with:
         path: ${{ env.DOCKER_ESP_IDF }}
-        key: ${{ inputs.toolchain }}-${{ inputs.toolchain_url }}
+        key: ${{ inputs.toolchain }}-${{ inputs.toolchain_version }}
 
     - name: Pull and Save Docker Image
       if: steps.cache-toolchain-espressif.outputs.cache-hit != 'true'
       run: |
-        docker pull espressif/idf:${{ inputs.toolchain_url }}
+        docker pull espressif/idf:${{ inputs.toolchain_version }}
         mkdir -p $(dirname $DOCKER_ESP_IDF)
-        docker save -o $DOCKER_ESP_IDF espressif/idf:${{ inputs.toolchain_url }}
+        docker save -o $DOCKER_ESP_IDF espressif/idf:${{ inputs.toolchain_version }}
         du -sh $DOCKER_ESP_IDF
       shell: bash
 
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -86,7 +86,7 @@ jobs:
       boards: ${{ toJSON(fromJSON(needs.set-matrix.outputs.json)['espressif'].board) }}
       build-system: 'make'
       toolchain: 'esp-idf'
-      toolchain_url: 'v5.1.1'
+      toolchain_version: 'v5.1.4'
 
   # ---------------------------------------
   # Build RISC-V
@@ -106,7 +106,6 @@ jobs:
       boards: ${{ toJSON(fromJSON(needs.set-matrix.outputs.json)[matrix.port].board) }}
       build-system: 'make'
       toolchain: 'riscv-gcc'
-      toolchain_url: 'https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/download/v13.2.0-2/xpack-riscv-none-elf-gcc-13.2.0-2-linux-x64.tar.gz'
 
   # ---------------------------------------
   # Unit testing with ghostfat
diff --git a/.github/workflows/build_ghostfat.yml b/.github/workflows/build_ghostfat.yml
@@ -45,7 +45,7 @@ jobs:
         working-directory: ports/test_ghostfat/_build/${{ matrix.board }}
 
       - name: Save newly generated self-test images as CI artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: ghostfat_selftest_images
+          name: ghostfat_${{ matrix.board }}_image
           path: ./ports/test_ghostfat/_build/${{ matrix.board }}/ghostfat_${{ matrix.board }}.img.gz.gz
diff --git a/.github/workflows/build_util.yml b/.github/workflows/build_util.yml
@@ -16,7 +16,7 @@ on:
       toolchain:
         required: true
         type: string
-      toolchain_url:
+      toolchain_version:
         required: false
         type: string
 
@@ -41,7 +41,7 @@ jobs:
         uses: ./.github/actions/setup_toolchain
         with:
           toolchain: ${{ inputs.toolchain }}
-          toolchain_url: ${{ inputs.toolchain_url }}
+          toolchain_version: ${{ inputs.toolchain_version }}
 
       - name: Get Dependencies
         run: |
@@ -58,7 +58,7 @@ jobs:
 
       - name: Build using ESP-IDF docker
         if: inputs.toolchain == 'esp-idf'
-        run: docker run --rm -v $PWD:/project -w /project espressif/idf:${{ inputs.toolchain_url }} /bin/bash -c "git config --global --add safe.directory /project && make -C ports/espressif/ BOARD=${{ matrix.board }} all self-update copy-artifact"
+        run: docker run --rm -v $PWD:/project -w /project espressif/idf:${{ inputs.toolchain_version }} /bin/bash -c "git config --global --add safe.directory /project && make -C ports/espressif/ BOARD=${{ matrix.board }} all self-update copy-artifact"
 
       - uses: actions/upload-artifact@v4
         with:
diff --git a/ports/espressif/CMakeLists.txt b/ports/espressif/CMakeLists.txt
@@ -39,8 +39,8 @@ add_custom_command(TARGET app POST_BUILD
 # Post build: update arduino-esp32 bootloader for debug purpose
 # -------------------------------------------------------------
 if (0)
-  #set(ARDUINO_VARIANT_DIR /home/hathach/code/arduino-esp32/variants/${BOARD})
-  set(ARDUINO_VARIANT_DIR /home/hathach/code/arduino-esp32/variants/adafruit_feather_esp32s3)
+  set(ARDUINO_VARIANT_DIR $ENV{HOME}/code/arduino-esp32/variants/${BOARD})
+  #set(ARDUINO_VARIANT_DIR $ENV{HOME}/code/arduino-esp32/variants/adafruit_feather_esp32s3_nopsram)
 
   add_custom_command(TARGET bootloader POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/bootloader/bootloader.bin ${ARDUINO_VARIANT_DIR}/bootloader-tinyuf2.bin
@@ -49,17 +49,4 @@ if (0)
   add_custom_command(TARGET app POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/tinyuf2.bin ${ARDUINO_VARIANT_DIR}/tinyuf2.bin
     )
-
-  file(STRINGS ${CMAKE_CURRENT_LIST_DIR}/boards/${BOARD}/sdkconfig SDKCONFIG_CONTENTS)
-  foreach (line ${SDKCONFIG_CONTENTS})
-    if (line MATCHES "CONFIG_PARTITION_TABLE_CUSTOM_FILENAME=\"(.*).csv\"")
-      set(PARTITION_TABLE_CSV ${CMAKE_MATCH_1})
-      cmake_print_variables(PARTITION_TABLE_CSV)
-      break()
-    endif ()
-  endforeach ()
-
-  add_custom_command(TARGET app POST_BUILD
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_LIST_DIR}/${PARTITION_TABLE_CSV}.csv ${ARDUINO_VARIANT_DIR}/${PARTITION_TABLE_CSV}-tinyuf2.csv
-    )
 endif ()
diff --git a/ports/espressif/README.md b/ports/espressif/README.md
@@ -2,7 +2,7 @@
 
 The project is composed of customizing the 2nd stage bootloader from IDF and UF2 factory application as 3rd stage bootloader.
 
-**Note**: IDF is actively developed and change very often, TinyUF2 is developed and tested with IDF v5.1.1. Should you have a problem please try to change your IDF version.
+**Note**: IDF is actively developed and change very often, TinyUF2 is developed and tested with IDF v5.1.4. Should you have a problem please try to change your IDF version.
 
 Following boards are supported:
 
diff --git a/ports/espressif/boards/boards.c b/ports/espressif/boards/boards.c
@@ -345,7 +345,7 @@ void board_timer_stop(void) {
 
 #if CONFIG_IDF_TARGET_ESP32S3
 #include "hal/usb_serial_jtag_ll.h"
-#include "hal/usb_phy_ll.h"
+#include "hal/usb_fsls_phy_ll.h"
 
 static void hw_cdc_reset_handler(void *arg) {
   portBASE_TYPE xTaskWoken = 0;
@@ -389,7 +389,7 @@ static void usb_switch_to_cdc_jtag(void) {
   gpio_set_level((gpio_num_t)USBPHY_DP_NUM, 0);
 
   // Initialize CDC+JTAG ISR to listen for BUS_RESET
-  usb_phy_ll_int_jtag_enable(&USB_SERIAL_JTAG);
+  usb_fsls_phy_ll_int_jtag_enable(&USB_SERIAL_JTAG);
   usb_serial_jtag_ll_disable_intr_mask(USB_SERIAL_JTAG_LL_INTR_MASK);
   usb_serial_jtag_ll_clr_intsts_mask(USB_SERIAL_JTAG_LL_INTR_MASK);
   usb_serial_jtag_ll_ena_intr_mask(USB_SERIAL_JTAG_INTR_BUS_RESET);
@@ -446,6 +446,8 @@ void tud_cdc_line_state_cb(uint8_t instance, bool dtr, bool rts) {
       // copied from Arduino's usb_persist_restart()
       esp_register_shutdown_handler(usb_persist_shutdown_handler);
 #if CONFIG_IDF_TARGET_ESP32S3
+      // Switch to JTAG since S3 bootrom has issue with uploading with USB OTG
+      // https://github.com/espressif/arduino-esp32/issues/6762#issuecomment-1128621518
       usb_switch_to_cdc_jtag();
 #endif
       esp_restart();
diff --git a/ports/espressif/components/bootloader/subproject/main/bootloader_start.c b/ports/espressif/components/bootloader/subproject/main/bootloader_start.c
@@ -185,7 +185,7 @@ static int selected_boot_partition(const bootloader_state_t *bs) {
         }
 #endif // CONFIG_BOOTLOADER_APP_TEST
 
-        // UF2: check if Application want to load uf2 "bootloader" with reset reason hint.
+        // TinyUF2: check if Application want to load uf2 "bootloader" with reset reason hint.
         if ( boot_index != FACTORY_INDEX ) {
           // Application request to enter UF2 with Software Reset with reason hint
           if ( reset_reason == RESET_REASON_CORE_SW ||  reset_reason == RESET_REASON_CPU0_SW ) {
@@ -199,10 +199,10 @@ static int selected_boot_partition(const bootloader_state_t *bs) {
           }
         }
 
-        // UF2: check if GPIO0 is pressed and/or 1-bit RC on specific GPIO detect double reset
+        // TinyUF2: when reset by EN/nRST pin: check if GPIO0 is pressed and/or 1-bit RC on specific GPIO detect double reset
         // during this time. If yes then to load uf2 "bootloader".
-        if ( boot_index != FACTORY_INDEX ) {
-#ifdef PIN_DOUBLE_RESET_RC
+        if (boot_index != FACTORY_INDEX && reset_reason == RESET_REASON_CHIP_POWER_ON) {
+          #ifdef PIN_DOUBLE_RESET_RC
           // Double reset detect if board implements 1-bit memory with RC components
           esp_rom_gpio_pad_select_gpio(PIN_DOUBLE_RESET_RC);
           PIN_INPUT_ENABLE(GPIO_PIN_MUX_REG[PIN_DOUBLE_RESET_RC]);
@@ -215,11 +215,18 @@ static int selected_boot_partition(const bootloader_state_t *bs) {
             // Set to high to charge the RC, indicating we are in reset
             gpio_ll_output_enable(&GPIO, PIN_DOUBLE_RESET_RC);
             gpio_ll_set_level(&GPIO, PIN_DOUBLE_RESET_RC, 1);
-#else
-          {
-#endif
-            // turn led on if there is actually waiting
+          }
+          #endif
+
+          if (boot_index != FACTORY_INDEX) {
             if (UF2_DETECTION_DELAY_MS > 0){
+              #if CONFIG_IDF_TARGET_ESP32S3
+              // S3 startup with USB JTAG, while delaying here, USB JTAG will be enumerated which can cause confusion when
+              // switching to OTG in application. Switch to OTG PHY here to avoid this.
+              SET_PERI_REG_MASK(RTC_CNTL_USB_CONF_REG,
+                                RTC_CNTL_SW_HW_USB_PHY_SEL | RTC_CNTL_SW_USB_PHY_SEL | RTC_CNTL_USB_PAD_ENABLE);
+              #endif
+
               board_led_on();
             }
 
@@ -232,14 +239,19 @@ static int selected_boot_partition(const bootloader_state_t *bs) {
             do {
               if ( gpio_ll_get_level(&GPIO, PIN_BUTTON_UF2) == 0 ) {
                 ESP_LOGI(TAG, "Detect GPIO %d active to enter UF2 bootloader", PIN_BUTTON_UF2);
-
-                // Simply return factory index without erasing any other partition
                 boot_index = FACTORY_INDEX;
                 break;
               }
             } while (UF2_DETECTION_DELAY_MS > (esp_log_early_timestamp() - tm_start) );
 
-            board_led_off();
+            if (UF2_DETECTION_DELAY_MS > 0){
+              #if CONFIG_IDF_TARGET_ESP32S3
+              CLEAR_PERI_REG_MASK(RTC_CNTL_USB_CONF_REG,
+                                  RTC_CNTL_SW_HW_USB_PHY_SEL | RTC_CNTL_SW_USB_PHY_SEL | RTC_CNTL_USB_PAD_ENABLE);
+              #endif
+
+              board_led_off();
+            }
           }
 
 #if PIN_DOUBLE_RESET_RC
