Merge remote-tracking branch 'origin/master' into msc_stall

Author: hathach

.github/pull_request_template.md

@@ -7,6 +7,7 @@ on:
   pull_request:
   release:
     types: [ published ]
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
@@ -15,9 +16,9 @@ env:
   HIL_JSON: test/hil/tinyusb.json
 
 jobs:
-  # Check if code paths changed (skip builds if doc-only)
+  # Check if the code changes and we need to run ci build
+  # Cannot use paths filter in the on-event since we want this workflow to run even when there are no code changes, to register the commit chain
   check-paths:
-    if: github.event_name == 'pull_request' || github.event_name == 'push'
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -46,13 +47,8 @@ jobs:
               - '.github/workflows/ci_set_matrix.py'
 
   set-matrix:
-    needs: [check-paths]
-    if: |
-      always() && (
-        github.event_name == 'release' ||
-        github.event_name == 'workflow_dispatch' ||
-        needs.check-paths.outputs.code_changed == 'true'
-      )
+    needs: [ check-paths ]
+    if: needs.check-paths.outputs.code_changed == 'true'
     runs-on: ubuntu-latest
     outputs:
       json: ${{ steps.set-matrix-json.outputs.matrix }}
@@ -197,7 +193,7 @@ jobs:
   # Build Make/CMake on Windows/MacOS
   # ---------------------------------------
   build-os:
-    needs: [check-paths]
+    needs: [ check-paths ]
     if: needs.check-paths.outputs.code_changed == 'true'
     uses: ./.github/workflows/build_util.yml
     strategy:
@@ -215,8 +211,9 @@ jobs:
   # Zephyr
   # ---------------------------------------
   zephyr:
-    needs: [check-paths]
-    if: needs.check-paths.outputs.code_changed == 'true'
+    needs: [ check-paths ]
+    # skip zephyr build due to failed build, fix later
+    if: false && needs.check-paths.outputs.code_changed == 'true'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout TinyUSB
@@ -238,10 +235,8 @@ jobs:
   # Run on PR only (hil-tinyusb), hil-hfp only run on non-forked PR
   # ---------------------------------------
   hil-build:
-    needs: [check-paths, set-matrix]
-    if: |
-      github.repository_owner == 'hathach' &&
-      (github.event_name == 'workflow_dispatch' || needs.check-paths.outputs.code_changed == 'true')
+    needs: set-matrix
+    if: github.repository_owner == 'hathach'
     uses: ./.github/workflows/build_util.yml
     strategy:
       fail-fast: false
@@ -260,10 +255,7 @@ jobs:
   # self-hosted on local VM, for attached hardware checkout HIL_JSON
   # ---------------------------------------
   hil-tinyusb:
-    needs: [check-paths, hil-build]
-    if: |
-      github.repository_owner == 'hathach' &&
-      (github.event_name == 'release' || github.event_name == 'workflow_dispatch' || needs.check-paths.outputs.code_changed == 'true')
+    needs: hil-build
     runs-on: [ self-hosted, X64, hathach, hardware-in-the-loop ]
     steps:
       - name: Get Skip Boards from previous run
@@ -303,11 +295,10 @@ jobs:
   # Since IAR Token secret is not passed to forked PR, only build non-forked PR
   # ---------------------------------------
   hil-hfp:
-    needs: [check-paths]
+    needs: [ check-paths ]
     if: |
       github.repository_owner == 'hathach' &&
-      github.event.pull_request.head.repo.fork == false &&
-      (github.event_name == 'release' || github.event_name == 'workflow_dispatch' || needs.check-paths.outputs.code_changed == 'true')
+      !(github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == true)
     runs-on: [ self-hosted, Linux, X64, hifiphile ]
     env:
       IAR_LMS_BEARER_TOKEN: ${{ secrets.IAR_LMS_BEARER_TOKEN }}
@@ -364,11 +355,9 @@ jobs:
     secrets: inherit
 
   membrowse-comment:
-    needs: [check-paths, membrowse]
-    if: >
-      always() &&
-      github.event_name == 'pull_request' &&
-      needs.check-paths.outputs.code_changed == 'true'
+    needs: membrowse
+    # skip membrowse comment since it is too verbal
+    if: false && github.event_name == 'pull_request'
     runs-on: ubuntu-latest
     permissions:
       contents: read

.github/workflows/build.yml

@@ -15,8 +15,8 @@
 
 # family: [supported toolchain]
 family_list = {
-    "at32f45x at32f402_405 at32f403a_407 at32f413 at32f415 at32f423 at32f425 at32f435_437 broadcom_32bit da1469x": [
-        "arm-gcc"],
+    "at32f45x at32f402_405 at32f403a_407 at32f413 at32f415 at32f423 at32f425 at32f435_437": ["arm-gcc"],
+    "broadcom_32bit da1469x": ["arm-gcc"],
     "broadcom_64bit": ["aarch64-gcc"],
     "ch32v10x ch32v20x ch32v30x fomu gd32vf103 hpmicro": ["riscv-gcc"],
     "imxrt": ["arm-gcc", "arm-clang"],
@@ -38,9 +38,9 @@
     "stm32h7": ["arm-gcc", "arm-clang", "arm-iar"],
     "stm32h7rs stm32l0 stm32l4": ["arm-gcc", "arm-clang", "arm-iar"],
     "stm32n6": ["arm-gcc"],
-    "stm32u0 stm32wb stm32wba": ["arm-gcc", "arm-clang", "arm-iar"],
-    "stm32u5": ["arm-gcc", "arm-clang", "arm-iar"],
-    "-bespressif_s2_devkitc": ["esp-idf"],
+    "stm32u0 stm32u5": ["arm-gcc", "arm-clang", "arm-iar"],
+    "stm32wb stm32wba": ["arm-gcc", "arm-clang", "arm-iar"],
+    # "-bespressif_s2_devkitc": ["esp-idf"],
     # S3, P4 will be built by hil test
     # "-bespressif_s3_devkitm": ["esp-idf"],
     # "-bespressif_p4_function_ev": ["esp-idf"],

.github/workflows/ci_set_matrix.py

@@ -101,10 +101,11 @@ If you have a special requirement, ``usbd_app_driver_get_cb()`` can be used to w
 Host Stack
 ----------
 
-- Human Interface Device (HID): Keyboard, Mouse, Generic
-- Mass Storage Class (MSC)
 - Communication Device Class: CDC-ACM
 - Vendor serial over USB: FTDI, CP210x, CH34x, PL2303
+- Human Interface Device (HID): Keyboard, Mouse, Generic
+- Mass Storage Class (MSC)
+- Musical Instrument Digital Interface (MIDI)
 - Hub with multiple-level support
 
 Similar to the Device Stack, if you have a special requirement, ``usbh_app_driver_get_cb()`` can be used to write your own class driver without modifying the stack.

.idea/cmake.xml

@@ -34,7 +34,10 @@ Get the Code
    $ python tools/get_deps.py -b stm32h743eval  # or python tools/get_deps.py stm32h7
 
 .. note::
-   For rp2040 `pico-sdk <https://github.com/raspberrypi/pico-sdk>`_ or `esp-idf <https://github.com/espressif/esp-idf>`_ for Espressif targets are required; install them per vendor instructions.
+   Some MCU families require additional SDKs, please follow their instructions to install and set it up
+
+   * **rp2040**: Requires `pico-sdk <https://github.com/raspberrypi/pico-sdk>`_
+   * **Espressif (esp32)**: Requires `esp-idf <https://github.com/espressif/esp-idf>`_. Only a few examples support the ESP-IDF build system. Look for ones with `src/CMakeLists.txt` that contain `idf_component_register()`, such as `cdc_msc_freertos`.
 
 Simple Device Example
 ---------------------

README.rst

@@ -104,6 +104,8 @@
 #define CFG_TUD_CDC_TX_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
 
 // CDC Endpoint transfer buffer size, more is faster
+// Leave it as default size (512 for HS, 64 for FS) unless your host application
+// is able to send ZLP (Zero Length Packet) to terminate transfer !
 #define CFG_TUD_CDC_EP_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
 
 #ifdef __cplusplus

docs/getting_started.rst

@@ -104,6 +104,8 @@
 #define CFG_TUD_CDC_TX_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
 
 // CDC Endpoint transfer buffer size, more is faster
+// Leave it as default size (512 for HS, 64 for FS) unless your host application
+// is able to send ZLP (Zero Length Packet) to terminate transfer !
 #define CFG_TUD_CDC_EP_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
 
 // MSC Buffer size of Device Mass storage

examples/device/cdc_dual_ports/src/tusb_config.h

@@ -111,6 +111,8 @@
 #define CFG_TUD_CDC_TX_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
 
 // CDC Endpoint transfer buffer size, more is faster
+// Leave it as default size (512 for HS, 64 for FS) unless your host application
+// is able to send ZLP (Zero Length Packet) to terminate transfer !
 #define CFG_TUD_CDC_EP_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
 
 // MSC Buffer size of Device Mass storage

examples/device/cdc_msc/src/tusb_config.h

@@ -160,6 +160,8 @@ extern "C" {
 #define CFG_TUD_CDC_TX_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
 
 // CDC Endpoint transfer buffer size, more is faster
+// Leave it as default size (512 for HS, 64 for FS) unless your host application
+// is able to send ZLP (Zero Length Packet) to terminate transfer !
 #define CFG_TUD_CDC_EP_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
 
 #ifdef __cplusplus