Merge branch 'master' into fix/ledc-attach-duty-check

Author: P-R-O-C-H-Y

.github/scripts/on-push.sh

@@ -60,7 +60,7 @@ elif [ "$CHUNK_INDEX" -eq "$CHUNKS_CNT" ]; then
     BUILD_PIO=1
 fi
 
-if [ "$BUILD_LOG" -le 0 ]; then
+if [ -z "$BUILD_LOG" ] || [ "$BUILD_LOG" -le 0 ]; then
     BUILD_LOG=0
 fi
 

.github/scripts/sketch_utils.sh

@@ -78,10 +78,10 @@ function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [ex
 
             # Default FQBN options if none were passed in the command line.
 
-            esp32_opts="PSRAM=enabled,PartitionScheme=huge_app"
+            esp32_opts="FlashMode=dio,PSRAM=enabled,PartitionScheme=huge_app"
             esp32s2_opts="PSRAM=enabled,PartitionScheme=huge_app"
             esp32s3_opts="PSRAM=opi,USBMode=default,PartitionScheme=huge_app"
-            esp32c3_opts="PartitionScheme=huge_app"
+            esp32c3_opts="FlashMode=dio,PartitionScheme=huge_app"
             esp32c6_opts="PartitionScheme=huge_app"
             esp32h2_opts="PartitionScheme=huge_app"
 

.github/scripts/tests_run.sh

@@ -8,7 +8,7 @@ function run_test() {
     local sketchdir=$(dirname $sketch)
     local sketchname=$(basename $sketchdir)
 
-    if [[ -f "$sketchdir/.skip.$platform" ]]; then
+    if [[ -f "$sketchdir/.skip.$platform" ]] || [[ -f "$sketchdir/.skip.$target" ]] || [[ -f "$sketchdir/.skip.$platform.$target" ]]; then
       echo "Skipping $sketchname test for $target, platform: $platform"
       skipfile="$sketchdir/.test_skipped"
       touch $skipfile
@@ -45,11 +45,24 @@ function run_test() {
             if [[ -f "$sketchdir/scenario.yaml" ]]; then
                 extra_args+=" --wokwi-scenario $sketchdir/scenario.yaml"
             fi
+        elif [ $platform == "qemu" ]; then
+            PATH=$HOME/qemu/bin:$PATH
+            extra_args="--embedded-services qemu --qemu-image-path $build_dir/$sketchname.ino.merged.bin"
+
+            if [ $target == "esp32" ] || [ $target == "esp32s3" ]; then
+                extra_args+=" --qemu-prog-path qemu-system-xtensa --qemu-cli-args=\"-machine $target -m 4M -nographic\""
+            elif [ $target == "esp32c3" ]; then
+                extra_args+=" --qemu-prog-path qemu-system-riscv32 --qemu-cli-args=\"-machine $target -icount 3 -nographic\""
+            else
+                echo "Unsupported QEMU target: $target"
+                exit 1
+            fi
         else
             extra_args="--embedded-services esp,arduino"
         fi
 
-        pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file $extra_args
+        echo "pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file $extra_args"
+        bash -c "pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file $extra_args"
         result=$?
         if [ $result -ne 0 ]; then
             return $result
@@ -71,6 +84,13 @@ while [ ! -z "$1" ]; do
     -c )
         chunk_run=1
         ;;
+    -q )
+        if [ ! -d $QEMU_PATH ]; then
+            echo "QEMU path $QEMU_PATH does not exist"
+            exit 1
+        fi
+        platform="qemu"
+        ;;
     -w )
         shift
         wokwi_timeout=$1
@@ -113,7 +133,9 @@ while [ ! -z "$1" ]; do
     shift
 done
 
-source ${SCRIPTS_DIR}/install-arduino-ide.sh
+if [ ! $platform == "qemu" ]; then
+    source ${SCRIPTS_DIR}/install-arduino-ide.sh
+fi
 
 # If sketch is provided and test type is not, test type is inferred from the sketch path
 if [[ $test_type == "all" ]] || [[ -z $test_type ]]; then

.github/workflows/hil.yml

@@ -86,6 +86,83 @@ jobs:
             ~/.arduino/tests/**/build*.tmp/*.elf
             ~/.arduino/tests/**/build*.tmp/*.json
 
+  qemu-test:
+    needs: [gen_chunks, build]
+    name: ${{matrix.chip}}-QEMU_Test#${{matrix.chunks}}
+    if: ${{ false }}
+    strategy:
+      fail-fast: false
+      matrix:
+        chip: ['esp32', 'esp32c3'] # Currently only ESP32 and ESP32-C3 are supported by QEMU
+        chunks: ${{fromJson(needs.gen_chunks.outputs.chunks)}}
+    runs-on: ubuntu-latest
+    env:
+      QEMU_INSTALL_PATH: "$HOME"
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Get QEMU version
+        uses: pozetroninc/[email protected]
+        id: get-qemu-version
+        with:
+          token: ${{secrets.GITHUB_TOKEN}}
+          owner: espressif
+          repo: qemu
+          excludes: prerelease, draft
+
+      - name: Cache tools
+        id: cache-linux
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/qemu
+            ~/.cache/pip
+          key: qemu-${{ steps.get-qemu-version.outputs.release }}-${{ hashFiles('.github/workflows/hil.yml') }}
+
+      - name: Install dependencies
+        run: |
+          pip install -U pip
+          pip install -r tests/requirements.txt --extra-index-url https://dl.espressif.com/pypi
+          sudo apt update && sudo apt install libpixman-1-0 libnuma1 libglib2.0-0 libslirp0 libsdl2-2.0-0
+
+      - name: Download QEMU
+        if: steps.cache-linux.outputs.cache-hit != 'true'
+        run: |
+          cd ${{ env.QEMU_INSTALL_PATH }}
+          underscore_release=$(echo ${{ steps.get-qemu-version.outputs.release }} | sed 's/\-/_/g')
+          curl -L https://github.com/espressif/qemu/releases/download/${{ steps.get-qemu-version.outputs.release }}/qemu-riscv32-softmmu-${underscore_release}-x86_64-linux-gnu.tar.xz > qemu-riscv32.tar.xz
+          curl -L https://github.com/espressif/qemu/releases/download/${{ steps.get-qemu-version.outputs.release }}/qemu-xtensa-softmmu-${underscore_release}-x86_64-linux-gnu.tar.xz > qemu-xtensa.tar.xz
+          tar -xf qemu-riscv32.tar.xz
+          tar -xf qemu-xtensa.tar.xz
+          rm qemu-*
+          echo "QEMU_PATH=${{ env.QEMU_INSTALL_PATH }}/qemu" >> $GITHUB_ENV
+
+      - name: Download ${{matrix.chip}}-${{matrix.chunks}} artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{matrix.chip}}-${{matrix.chunks}}.artifacts
+          path: ~/
+
+      - name: Run Tests
+        run: QEMU_PATH="${{env.QEMU_PATH}}" bash .github/scripts/tests_run.sh -c -t ${{matrix.chip}} -i ${{matrix.chunks}} -m ${{env.MAX_CHUNKS}} -q
+
+      - name: Check if tests were skipped
+        id: check-test-skipped
+        run: |
+          if [ $(find "tests" -name ".test_skipped") ]; then
+            echo "skipped=true" >> $GITHUB_OUTPUT
+          else
+            echo "skipped=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Upload test result artifacts
+        uses: actions/upload-artifact@v4
+        if: ${{ always() && steps.check-test-skipped.outputs.skipped == 'false' }}
+        with:
+          name: qemu_results-${{matrix.chip}}-${{matrix.chunks}}
+          path: tests/*/*.xml
+
   wokwi-test:
     needs: [gen_chunks, build]
     if: github.event_name == 'schedule'
@@ -105,7 +182,7 @@ jobs:
         with:
           name: ${{matrix.chip}}-${{matrix.chunks}}.artifacts
           path: ~/
-      
+
       - name: Install Wokwi CLI
         run: curl -L https://wokwi.com/ci/install.sh | sh
 
@@ -193,16 +270,10 @@ jobs:
 
   event_file:
     name: "Event File"
-    if: |
-      contains(github.event.pull_request.labels.*.name, 'hil_test') ||
-      contains(github.event.pull_request.labels.*.name, 'perf_test') ||
-      github.event_name == 'schedule'
-    needs: hardware-test
     runs-on: ubuntu-latest
     steps:
        - name: Upload
          uses: actions/upload-artifact@v4
          with:
-           name: Event File
+           name: event_file
            path: ${{github.event_path}}
-

.github/workflows/publish.yml

@@ -33,6 +33,6 @@ jobs:
         uses: EnricoMi/publish-unit-test-result-action@v1
         with:
           commit: ${{ github.event.workflow_run.head_sha }}
-          event_file: artifacts/Event File/event.json
+          event_file: artifacts/event_file/event.json
           event_name: ${{ github.event.workflow_run.event }}
           files: "artifacts/**/*.xml"

.github/workflows/wokwi.yml

@@ -15,17 +15,37 @@ env:
   WOKWI_CLI_TOKEN: ${{ secrets.WOKWI_CLI_TOKEN }}
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-concurrency:
-  group: wokwi-${{github.event.pull_request.number || github.ref}}
-  cancel-in-progress: true
-
 jobs:
+  get_event_file:
+    name: Get event file
+    runs-on: ubuntu-latest
+    outputs:
+      ref: ${{ steps.get-ref.outputs.ref }}
+    steps:
+      - name: Download event file
+        uses: actions/download-artifact@v4
+        with:
+          run-id: ${{github.event.workflow_run.id}}
+          github-token: ${{env.GITHUB_TOKEN}}
+          name: event_file
+
+      - name: Get ref
+        id: get-ref
+        run: |
+          PR_NUMBER=$(jq -r '.number' event.json)
+          echo "PR_NUMBER = $PR_NUMBER"
+          echo "ref=$PR_NUMBER" >> $GITHUB_OUTPUT
+
   gen_chunks:
     if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
     name: Generate Chunks matrix
     runs-on: ubuntu-latest
+    needs: get_event_file
     outputs:
       chunks: ${{ steps.gen-chunks.outputs.chunks }}
+    concurrency:
+      group: wokwi-${{ needs.get_event_file.outputs.ref || github.ref }}
+      cancel-in-progress: true
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
@@ -47,8 +67,11 @@ jobs:
           echo "chunks=${CHUNKS}" >>$GITHUB_OUTPUT
 
   wokwi-test:
-    needs: [gen_chunks]
+    needs: [get_event_file, gen_chunks]
     name: ${{matrix.chip}}-Wokwi_Test#${{matrix.chunks}}
+    concurrency:
+      group: wokwi-${{ needs.get_event_file.outputs.ref || github.ref }}-${{matrix.chip}}-${{matrix.chunks}}
+      cancel-in-progress: true
     strategy:
       fail-fast: false
       matrix:
@@ -101,7 +124,10 @@ jobs:
   report-result:
     name: Report wokwi test result
     runs-on: ubuntu-latest
-    needs: wokwi-test
+    needs: [get_event_file, wokwi-test]
+    concurrency:
+      group: wokwi-${{ needs.get_event_file.outputs.ref || github.ref }}
+      cancel-in-progress: true
     if: always() && github.event.workflow_run.event == 'pull_request'
     steps:
       - name: Report result
@@ -127,4 +153,4 @@ jobs:
               target_url: 'https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}'
             })).data;
             core.info(`${name} is ${state}`);
-  
+

.gitignore

@@ -50,3 +50,7 @@ libraries/Insights/examples/*/*.ino.zip
 !.vale/styles/Vocab/
 .vale/styles/Vocab/*
 !.vale/styles/Vocab/Espressif/
+
+# Ignore Lib Builder Docker run scripts
+/run.sh
+/run.ps1

CMakeLists.txt

@@ -288,7 +288,7 @@ set(includedirs variants/${CONFIG_ARDUINO_VARIANT}/ cores/esp32/ ${ARDUINO_LIBRA
 set(srcs ${CORE_SRCS} ${ARDUINO_LIBRARIES_SRCS})
 set(priv_includes cores/esp32/libb64)
 set(requires spi_flash esp_partition mbedtls wifi_provisioning wpa_supplicant esp_adc esp_eth http_parser)
-set(priv_requires fatfs nvs_flash app_update spiffs bootloader_support bt esp_hid ${ARDUINO_LIBRARIES_REQUIRES})
+set(priv_requires fatfs nvs_flash app_update spiffs bootloader_support bt esp_hid usb ${ARDUINO_LIBRARIES_REQUIRES})
 
 idf_component_register(INCLUDE_DIRS ${includedirs} PRIV_INCLUDE_DIRS ${priv_includes} SRCS ${srcs} REQUIRES ${requires} PRIV_REQUIRES ${priv_requires})
 

README.md

@@ -60,6 +60,10 @@ Here are the ESP32 series supported by the Arduino-ESP32 project:
 | ESP32-C6 |     No     |       Yes       | [ESP32-C6](https://www.espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf) |
 | ESP32-H2 |     No     |       Yes       | [ESP32-H2](https://www.espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf) |
 
+> [!NOTE]
+> ESP32-C2 is also supported by Arduino-ESP32 but requires rebuilding the static libraries. This is not trivial and requires a good understanding of the ESP-IDF
+> build system. For more information, see the [Lib Builder documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/lib_builder.html).
+
 For more details visit the [supported chips](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html#supported-soc-s) documentation page.
 
 ### Decoding exceptions

cores/esp32/USBMSC.cpp

@@ -33,6 +33,7 @@ extern "C" uint16_t tusb_msc_load_descriptor(uint8_t *dst, uint8_t *itf) {
 
 typedef struct {
   bool media_present;
+  bool is_writable;
   uint8_t vendor_id[8];
   uint8_t product_id[16];
   uint8_t product_rev[4];
@@ -179,11 +180,17 @@ int32_t tud_msc_scsi_cb(uint8_t lun, uint8_t const scsi_cmd[16], void *buffer, u
   return resplen;
 }
 
+bool tud_msc_is_writable_cb(uint8_t lun) {
+  log_v("[%u]: %u", lun, msc_luns[lun].is_writable);
+  return msc_luns[lun].is_writable;  // RAM disk is always ready
+}
+
 USBMSC::USBMSC() {
   if (MSC_ACTIVE_LUN < MSC_MAX_LUN) {
     _lun = MSC_ACTIVE_LUN;
     MSC_ACTIVE_LUN++;
     msc_luns[_lun].media_present = false;
+    msc_luns[_lun].is_writable = true;
     msc_luns[_lun].vendor_id[0] = 0;
     msc_luns[_lun].product_id[0] = 0;
     msc_luns[_lun].product_rev[0] = 0;
@@ -213,6 +220,7 @@ bool USBMSC::begin(uint32_t block_count, uint16_t block_size) {
 
 void USBMSC::end() {
   msc_luns[_lun].media_present = false;
+  msc_luns[_lun].is_writable = false;
   msc_luns[_lun].vendor_id[0] = 0;
   msc_luns[_lun].product_id[0] = 0;
   msc_luns[_lun].product_rev[0] = 0;
@@ -247,6 +255,10 @@ void USBMSC::onWrite(msc_write_cb cb) {
   msc_luns[_lun].write = cb;
 }
 
+void USBMSC::isWritable(bool is_writable) {
+  msc_luns[_lun].is_writable = is_writable;
+}
+
 void USBMSC::mediaPresent(bool media_present) {
   msc_luns[_lun].media_present = media_present;
 }

cores/esp32/USBMSC.h

@@ -44,6 +44,7 @@ class USBMSC {
   void productID(const char *pid);        //max 16 chars
   void productRevision(const char *ver);  //max 4 chars
   void mediaPresent(bool media_present);
+  void isWritable(bool is_writable);
   void onStartStop(msc_start_stop_cb cb);
   void onRead(msc_read_cb cb);
   void onWrite(msc_write_cb cb);