feature(dcd_dwc2) : Added cache synchronization on esp32p4 while DMA is used

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,86 +1,50 @@
-name: Bug Report
-description: Report a problem with TinyUSB
-labels: 'Bug 🐞'
+name: Bug report
+description: Report build and runtime bugs
+labels: ["Type: Bug"]
 body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this bug report!
-        It's okay to leave some blank if it doesn't apply to your problem.
-
-  - type: dropdown
+  - type: checkboxes
+    id: checklist
     attributes:
-      label: Operating System
+      label: Answers checklist.
+      description: Before submitting a new issue, please follow the checklist and try to find the answer.
       options:
-              - Linux
-              - MacOS
-              - RaspberryPi OS
-              - Windows 7
-              - Windows 10
-              - Windows 11
-              - Others
-    validations:
-      required: true
-
+        - label: I have read the component documentation [ESP-IDF Components](https://components.espressif.com) and the issue is not addressed there.
+          required: true
+        - label: I am using target and esp-idf version as defined in component's idf_component.yml
+          required: true
+        - label: I have searched the upstream [issue tracker](https://github.com/hathach/tinyusb/issues?q=is%3Aissue) for a similar issue and not found any related issue.
+          required: true
+        - label: I have searched the Espressif esp-usb component [issue tracker](https://github.com/espressif/esp-usb/issues?q=is%3Aissue) for a similar issue and not found any related issue.
+          required: true
   - type: input
+    id: idf_version
     attributes:
-      label: Board
-      placeholder: e.g Feather nRF52840 Express
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Firmware
-      placeholder: |
-        e.g examples/device/cdc_msc. If it is custom firmware, it is preferably compiled like one in example folder and reviewable for people to comment on. The easiest way is
-        - Fork this repo, checkout a new branch
-        - Add your-own-example based on stock one
-        - Push and post it here.
+      label: ESP-IDF version.
+      description: Which ESP-IDF version does this issue occur on? Run `git describe --tags` in your esp-idf folder to find it.
+      placeholder: ex. v5.0-rc1
     validations:
       required: true
-
-  - type: textarea
-    attributes:
-      label: What happened ?
-      placeholder: A clear and concise description of what the bug is.
-    validations:
-      required: true
-
-  - type: textarea
+  - type: input
+    id: devkit
     attributes:
-      label: How to reproduce ?
-      placeholder: |
-        Exact steps in chronological order, details should be specific e.g if you use a command/script to test with, please post it as well.
-        1. Go to '...'
-        2. Click on '....'
-        3. See error
+      label: Development Kit.
+      description: Which Development Kit does this issue occur on?
+      placeholder: ex. ESP32-Wrover-Kit v2 | Custom Board
     validations:
       required: true
-
-  - type: textarea
+  - type: input
+    id: component_version
     attributes:
-      label: Debug Log as txt file (LOG/CFG_TUSB_DEBUG=2)
-      placeholder: |
-        Attach your debug log txt file here, where the issue occurred, best with comments to explain the actual events.
-
-        Note1: Please DO NOT paste your lengthy log contents here since it hurts the readability.
-        Note2: To enable logging, add `LOG=2` to to the make command if building with stock examples or set `CFG_TUSB_DEBUG=2` in your tusb_config.h.
-        More information can be found at [example's readme](https://github.com/hathach/tinyusb/blob/master/docs/getting_started.md)
+      label: Used Component version.
+      description: Which Component version does this issue occur on? Check `dependencies.lock` file in your project root to find it.
+      placeholder: ex. v1.2.0-rc0
     validations:
       required: true
-
   - type: textarea
+    id: more-info
     attributes:
-      label: Screenshots
-      description: If applicable, add screenshots to help explain your problem.
+      label: More Information.
+      description: Any other information from investigating this?
+      placeholder: ex. I tried on Windows 10 PC and the issue couldn't be reproduced there.
     validations:
       required: false
-
-  - type: checkboxes
-    attributes:
-      label: I have checked existing issues, dicussion and documentation
-      description: You agree to check all the resources above before opening a new issue.
-      options:
-        - label: I confirm I have checked existing issues, dicussion and documentation.
-          required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+## Requirements
+_Provide a requirements for requesting changes_
+
+## Limitations
+_Describe limitations if there are any_
+
+## Breaking change
+_No breaking changes_
+
+## Checklist
+
+- [ ] Pull Request name has appropriate format (for example: "fix(dcd_dwc2): Resolved address selection when several phy are present")
+- [ ] _Optional:_ README.md updated
+- [ ] CI passed
+
+## Related issues
+_No related issues_

.github/ci/override_managed_component.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python
+#
+# SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: Apache-2.0
+
+import sys
+import argparse
+from pathlib import Path
+from glob import glob
+from idf_component_tools.manifest import ManifestManager
+
+
+def override_with_local_component(component, local_path, app):
+    app_path = Path(app)
+
+    absolute_local_path = Path(local_path).absolute()
+    if not absolute_local_path.exists():
+        print('[Error] {} path does not exist'.format(local_path))
+        raise Exception
+    if not app_path.exists():
+        print('[Error] {} path does not exist'.format(app_path))
+        raise Exception
+
+    print('[Info] Processing app {}'.format(app))
+    manager = ManifestManager(app_path / 'main', 'app')
+    if '/' not in component:
+        # Prepend with default namespace
+        component_with_namespace = 'espressif/' + component
+
+    try:
+        manager.manifest_tree['dependencies'][component_with_namespace] = {
+            'version': '*',
+            'override_path': str(absolute_local_path)
+            }
+    except KeyError:
+        print('[Error] {} app does not depend on {}'.format(app, component_with_namespace))
+        raise KeyError
+
+    manager.dump()
+
+
+def override_with_local_component_all(component, local_path, apps):
+    # Process wildcard, e.g. "app_prefix_*"
+    apps_with_glob = list()
+    for app in apps:
+        apps_with_glob += glob(app)
+
+    # Go through all collected apps
+    for app in apps_with_glob:
+        try:
+            override_with_local_component(component, local_path, app)
+        except:
+            print("[Error] Could not process app {}".format(app))
+            return -1
+    return 0
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('component', help='Existing component that the app depends on')
+    parser.add_argument('local_path', help='Path to component that will be used instead of the managed version')
+    parser.add_argument('apps', nargs='*', help='List of apps to process')
+    args = parser.parse_args()
+    sys.exit(override_with_local_component_all(args.component, args.local_path, args.apps))

.github/workflows/build_idf_examples.yml

@@ -0,0 +1,28 @@
+name: Build ESP-IDF USB examples
+
+on:
+  schedule:
+    - cron: '0 0 * * SAT' # Saturday midnight
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        idf_ver: ["release-v5.0", "release-v5.1", "release-v5.2", "release-v5.3", "release-v5.4", "latest"]
+    runs-on: ubuntu-20.04
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: 'true'
+      - name: Build ESP-IDF USB Device examples
+        shell: bash
+        run: |
+          . ${IDF_PATH}/export.sh
+          pip install idf-component-manager==1.5.2 idf-build-apps --upgrade
+          python .github/ci/override_managed_component.py tinyusb . ${IDF_PATH}/examples/peripherals/usb/device/tusb_*
+          cd ${IDF_PATH}
+          idf-build-apps find --path examples/peripherals/usb/device/ --recursive --target all --manifest-file examples/peripherals/.build-test-rules.yml
+          idf-build-apps build --path examples/peripherals/usb/device/ --recursive --target all --manifest-file examples/peripherals/.build-test-rules.yml

.github/workflows/upload_component.yml

@@ -0,0 +1,25 @@
+name: Push TinyUSB to Espressif Component Service
+
+# If the commit is tagged, it will be uploaded. Other scenario silently fail.
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  upload_components:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Remove unneeded files
+        shell: bash
+        run: rm -rf docs tools lib/embedded-cli lib/fatfs lib/SEGGER_RTT
+
+      - name: Upload components to component service
+        uses: espressif/upload-components-ci-action@v1
+        with:
+          name: "tinyusb"
+          version: ${{ github.ref_name }}
+          namespace: "espressif"
+          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

CMakeLists.txt

@@ -0,0 +1,76 @@
+idf_build_get_property(target IDF_TARGET)
+
+if(${target} STREQUAL "esp32s3")
+    set(tusb_mcu "OPT_MCU_ESP32S3")
+    set(tusb_family "esp32sx")
+elseif(${target} STREQUAL "esp32s2")
+    set(tusb_mcu "OPT_MCU_ESP32S2")
+    set(tusb_family "esp32sx")
+elseif(${target} STREQUAL "esp32p4")
+    set(tusb_mcu "OPT_MCU_ESP32P4")
+    set(tusb_family "esp32px")
+endif()
+
+set(compile_options
+    "-DCFG_TUSB_MCU=${tusb_mcu}"
+    )
+
+idf_component_get_property(freertos_include freertos ORIG_INCLUDE_PATH)
+
+set(includes_private
+    "src/"
+    "src/device"
+    "lib/networking" # For RNDIS definitions
+    )
+
+set(includes_public
+    "src/"
+    # The FreeRTOS API include convention in tinyusb is different from esp-idf
+    "${freertos_include}"
+    )
+
+set(srcs
+    "src/class/cdc/cdc_device.c"
+    "src/class/hid/hid_device.c"
+    "src/class/midi/midi_device.c"
+    "src/class/msc/msc_device.c"
+    "src/class/vendor/vendor_device.c"
+    "src/class/audio/audio_device.c"
+    "src/class/video/video_device.c"
+    "src/class/bth/bth_device.c"
+    # NET class
+    "src/class/net/ecm_rndis_device.c"
+    "lib/networking/rndis_reports.c"
+    "src/class/net/ncm_device.c"
+    # DFU
+    "src/class/dfu/dfu_device.c"
+    "src/class/dfu/dfu_rt_device.c"
+    # Common, device-mode related
+    "src/portable/synopsys/dwc2/dcd_dwc2.c"
+    "src/portable/synopsys/dwc2/dwc2_common.c"
+    "src/common/tusb_fifo.c"
+    "src/device/usbd_control.c"
+    "src/device/usbd.c"
+    "src/tusb.c"
+    )
+
+set(requirements_private
+    esp_netif   # required by rndis_reports.c: #include "netif/ethernet.h"
+    )
+
+if(${target} STREQUAL "esp32p4")
+    list(APPEND requirements_private
+                esp_mm # required by dcd_dwc2.c: #include "esp_cache.h"
+        )
+endif()
+
+idf_component_register(SRCS ${srcs}
+                       INCLUDE_DIRS ${includes_public}
+                       PRIV_INCLUDE_DIRS ${includes_private}
+                       PRIV_REQUIRES  ${requirements_private}
+                       )
+
+target_compile_options(${COMPONENT_LIB} PUBLIC ${compile_options})
+
+# when no builtin class driver is enabled, an uint8_t data compared with `BUILTIN_DRIVER_COUNT` will always be false
+set_source_files_properties("src/device/usbd.c" PROPERTIES COMPILE_FLAGS "-Wno-type-limits")