Merge pull request #3114 from hathach/fix-sigma-mouse-multiple-attach

Fix sigma mouse multiple attach

.circleci/config.yml

@@ -20,12 +20,12 @@ jobs:
 
             BUILDSYSTEM_TOOLCHAIN=(
               "cmake arm-clang"
+              "cmake esp-idf"
               "make aarch64-gcc"
               "make arm-gcc"
               "make msp430-gcc"
               "make riscv-gcc"
               "make rx-gcc"
-              "cmake esp-idf"
             )
 
             # only build IAR if not forked PR, since IAR token is not shared

.circleci/config2.yml

@@ -10,17 +10,7 @@ commands:
       - run:
           name: Set toolchain url and key
           command: |
-            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-19.1.1/LLVM-ET-Arm-19.1.1-Linux-x86_64.tar.xz",
-              "arm-gcc": "https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/download/v13.2.1-1.1/xpack-arm-none-eabi-gcc-13.2.1-1.1-linux-x64.tar.gz",
-              "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": "https://github.com/hathach/rx_device/releases/download/0.0.1/gcc-8.3.0.202411-GNURX-ELF.run",
-              "arm-iar": "https://updates.iar.com/FileStore/STANDARD/001/003/322/cxarm-9.60.3.deb"
-            }'
-            toolchain_url=$(echo $TOOLCHAIN_JSON | jq -r '.["<< parameters.toolchain >>"]')
-
+            toolchain_url=$(jq -r '."<< parameters.toolchain >>"' .github/actions/setup_toolchain/toolchain.json)
             # only cache if not a github link
             if [[ $toolchain_url != "https://github.com"* ]]; then
               echo "<< parameters.toolchain >>-$toolchain_url" > toolchain_key
@@ -114,7 +104,7 @@ commands:
           name: Build
           command: |
             if [ << parameters.toolchain >> == esp-idf ]; then
-              docker run --rm -v $PWD:/project -w /project espressif/idf:v5.3.1 python tools/build.py << parameters.family >>
+              docker run --rm -v $PWD:/project -w /project espressif/idf:v5.3.2 python tools/build.py << parameters.family >>
             else
               # Toolchain option default is gcc
               if [ << parameters.toolchain >> == arm-clang ]; then

.github/actions/setup_toolchain/action.yml

@@ -4,9 +4,6 @@ inputs:
   toolchain:
     description: 'Toolchain name'
     required: true
-  toolchain_version:
-    description: 'Toolchain version'
-    required: false
 
 outputs:
   build_option:
@@ -27,23 +24,14 @@ runs:
       uses: ./.github/actions/setup_toolchain/espressif
       with:
         toolchain: ${{ inputs.toolchain }}
-        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-19.1.1/LLVM-ET-Arm-19.1.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": "https://github.com/hathach/rx_device/releases/download/0.0.1/gcc-8.3.0.202411-GNURX-ELF.run"
-        }'
-        TOOLCHAIN_URL=$(echo $TOOLCHAIN_JSON | jq -r '.["${{ inputs.toolchain }}"]')
+        TOOLCHAIN_URL=$(jq -r '."${{ inputs.toolchain }}"' .github/actions/setup_toolchain/toolchain.json)
         echo "toolchain_url=$TOOLCHAIN_URL"
         echo "toolchain_url=$TOOLCHAIN_URL" >> $GITHUB_OUTPUT
       shell: bash
@@ -51,7 +39,6 @@ runs:
     - name: Download Toolchain
       if: >-
         inputs.toolchain != 'arm-gcc' &&
-        inputs.toolchain != 'arm-iar' &&
         inputs.toolchain != 'esp-idf'
       uses: ./.github/actions/setup_toolchain/download
       with:

.github/actions/setup_toolchain/download/action.yml

@@ -23,17 +23,25 @@ runs:
       if: steps.cache-toolchain-download.outputs.cache-hit != 'true'
       run: |
         mkdir -p ~/cache/${{ inputs.toolchain }}
-        wget --progress=dot:giga ${{ inputs.toolchain_url }} -O toolchain.tar.gz
+
         if [[ ${{ inputs.toolchain }} == rx-gcc ]]; then
-          mv toolchain.tar.gz toolchain.run
+          wget --progress=dot:giga ${{ inputs.toolchain_url }} -O toolchain.run
           chmod +x toolchain.run
           ./toolchain.run -p ~/cache/${{ inputs.toolchain }}/gnurx -y
+        elif [[ ${{ inputs.toolchain }} == arm-iar ]]; then
+          wget --progress=dot:giga ${{ inputs.toolchain_url }} -O ~/cache/${{ inputs.toolchain }}/cxarm.deb
         else
+          wget --progress=dot:giga ${{ inputs.toolchain_url }} -O toolchain.tar.gz
           tar -C ~/cache/${{ inputs.toolchain }} -xaf toolchain.tar.gz
         fi
       shell: bash
 
-    - name: Set Toolchain Path
+    - name: Setup Toolchain
       run: |
+        if [[ ${{ inputs.toolchain }} == arm-iar ]]; then
+          sudo apt-get install -y ~/cache/${{ inputs.toolchain }}/cxarm.deb
+          echo >> $GITHUB_PATH "/opt/iar/cxarm/arm/bin"
+        else
           echo >> $GITHUB_PATH `echo ~/cache/${{ inputs.toolchain }}/*/bin`
+        fi
       shell: bash

.github/actions/setup_toolchain/espressif/action.yml

@@ -6,7 +6,8 @@ inputs:
     required: true
   toolchain_version:
     description: 'Toolchain version'
-    required: true
+    required: false
+    default: 'v5.3.2'
 
 runs:
   using: "composite"
@@ -39,3 +40,9 @@ runs:
         du -sh $DOCKER_ESP_IDF
         docker load --input $DOCKER_ESP_IDF
       shell: bash
+
+    - name: Tag Local Image
+      run: |
+        docker tag espressif/idf:${{ inputs.toolchain_version }} espressif/idf:tinyusb
+        docker images
+      shell: bash

.github/actions/setup_toolchain/toolchain.json

@@ -0,0 +1,9 @@
+{
+  "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-19.1.1/LLVM-ET-Arm-19.1.1-Linux-x86_64.tar.xz",
+  "arm-gcc": "https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/download/v13.2.1-1.1/xpack-arm-none-eabi-gcc-13.2.1-1.1-linux-x64.tar.gz",
+  "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": "https://github.com/hathach/rx_device/releases/download/0.0.1/gcc-8.3.0.202411-GNURX-ELF.run",
+  "arm-iar": "https://netstorage.iar.com/FileStore/STANDARD/001/003/583/cxarm-9.60.4.deb"
+}

.github/workflows/build.yml

@@ -8,8 +8,8 @@ on:
       - 'examples/**'
       - 'lib/**'
       - 'hw/**'
-      - 'tools/get_deps.py'
       - 'tools/build.py'
+      - 'tools/get_deps.py'
       - '.github/actions/**'
       - '.github/workflows/build.yml'
       - '.github/workflows/build_util.yml'
@@ -21,8 +21,9 @@ on:
       - 'examples/**'
       - 'lib/**'
       - 'hw/**'
-      - 'tools/get_deps.py'
+      - 'test/hil/**'
       - 'tools/build.py'
+      - 'tools/get_deps.py'
       - '.github/actions/**'
       - '.github/workflows/build.yml'
       - '.github/workflows/build_util.yml'
@@ -31,11 +32,20 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  HIL_JSON: test/hil/tinyusb.json
+
 jobs:
+  # ---------------------------------------
+  #
+  # Build
+  #
+  # ---------------------------------------
   set-matrix:
     runs-on: ubuntu-latest
     outputs:
       json: ${{ steps.set-matrix-json.outputs.matrix }}
+      hil_json: ${{ steps.set-matrix-json.outputs.hil_matrix }}
     steps:
       - name: Checkout TinyUSB
         uses: actions/checkout@v4
@@ -43,9 +53,14 @@ jobs:
       - name: Generate matrix json
         id: set-matrix-json
         run: |
+          # build matrix
           MATRIX_JSON=$(python .github/workflows/ci_set_matrix.py)
           echo "matrix=$MATRIX_JSON"
           echo "matrix=$MATRIX_JSON" >> $GITHUB_OUTPUT
+          # hil matrix
+          HIL_MATRIX_JSON=$(python test/hil/hil_ci_set_matrix.py ${{ env.HIL_JSON }})
+          echo "hil_matrix=$HIL_MATRIX_JSON"
+          echo "hil_matrix=$HIL_MATRIX_JSON" >> $GITHUB_OUTPUT
 
   # ---------------------------------------
   # Build CMake
@@ -85,7 +100,7 @@ jobs:
           - 'msp430-gcc'
           - 'riscv-gcc'
           - 'rx-gcc'
-          - 'esp-idf' # build-system is ignored
+          - 'esp-idf'
     with:
       build-system: 'make'
       toolchain: ${{ matrix.toolchain }}
@@ -110,15 +125,86 @@ jobs:
       one-per-family: true
 
   # ---------------------------------------
-  # Build IAR on HFP self-hosted
+  # Build IAR
+  # Since IAR Token secret is not passed to forked PR, only build non-forked PR with make.
+  # cmake is built by circle-ci. Due to IAR limit capacity, only build oe per family
   # ---------------------------------------
   arm-iar:
-    if: github.repository_owner == 'hathach' && github.event_name == 'push'
+    if: false # disable for now since we got reach capacity limit too often
+    #if: github.event_name == 'push' && github.repository_owner == 'hathach'
     needs: set-matrix
-    runs-on: [self-hosted, Linux, X64, hifiphile]
-    env:
-      BUILD_ARGS: ${{ join(fromJSON(needs.set-matrix.outputs.json)['arm-iar'], ' ') }}
-      # IAR_LMS_BEARER_TOKEN: ${{ secrets.IAR_LMS_BEARER_TOKEN }}
+    uses: ./.github/workflows/build_util.yml
+    secrets: inherit
+    strategy:
+      fail-fast: false
+      matrix:
+        build-system:
+          - 'make'
+    with:
+      build-system: ${{ matrix.build-system }}
+      toolchain: 'arm-iar'
+      build-args: ${{ toJSON(fromJSON(needs.set-matrix.outputs.json)['arm-iar']) }}
+      one-per-family: true
+
+  # ---------------------------------------
+  # Zephyr
+  # ---------------------------------------
+  zephyr:
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout TinyUSB
+        uses: actions/checkout@v4
+
+      - name: Setup Zephyr project
+        uses: zephyrproject-rtos/action-zephyr-setup@v1
+        with:
+          app-path: examples
+          toolchains: arm-zephyr-eabi
+
+      - name: Build
+        run: |
+          west build -b pca10056 -d examples/device/cdc_msc/build examples/device/cdc_msc -- -DRTOS=zephyr
+          west build -b pca10056 -d examples/device/msc_dual_lun/build examples/device/msc_dual_lun -- -DRTOS=zephyr
+
+  # ---------------------------------------
+  #
+  # Hardware in the loop (HIL)
+  # Run on PR only (hil-tinyusb), hil-hfp only run on non-forked PR
+  # ---------------------------------------
+
+  # ---------------------------------------
+  # Build arm-gcc
+  # ---------------------------------------
+  hil-build:
+    if: |
+      github.repository_owner == 'hathach' &&
+      (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch')
+    needs: set-matrix
+    uses: ./.github/workflows/build_util.yml
+    strategy:
+      fail-fast: false
+      matrix:
+        toolchain:
+          - 'arm-gcc'
+          - 'esp-idf'
+    with:
+      build-system: 'cmake'
+      toolchain: ${{ matrix.toolchain }}
+      build-args: ${{ toJSON(fromJSON(needs.set-matrix.outputs.hil_json)[matrix.toolchain]) }}
+      one-per-family: true
+      upload-artifacts: true
+
+  # ---------------------------------------
+  # Hardware in the loop (HIL)
+  # self-hosted on local VM, for attached hardware checkout HIL_JSON
+  # ---------------------------------------
+  hil-tinyusb:
+    if: |
+      github.repository_owner == 'hathach' &&
+      (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch')
+    needs: hil-build
+    runs-on: [self-hosted, X64, hathach, hardware-in-the-loop]
     steps:
       - name: Clean workspace
         run: |
@@ -126,14 +212,61 @@ jobs:
           rm -rf "${{ github.workspace }}"
           mkdir -p "${{ github.workspace }}"
 
+      - name: Checkout TinyUSB
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: test/hil
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: cmake-build
+          merge-multiple: true
+
+      - name: Test on actual hardware
+        run: |
+          ls cmake-build/
+          python3 test/hil/hil_test.py ${{ env.HIL_JSON }}
+
+  # ---------------------------------------
+  # Hardware in the loop (HIL)
+  # self-hosted by HFP, build with IAR toolchain, for attached hardware checkout test/hil/hfp.json
+  # Since IAR Token secret is not passed to forked PR, only build non-forked PR
+  # ---------------------------------------
+  hil-hfp:
+    if: |
+      github.repository_owner == 'hathach' &&
+      github.event.pull_request.head.repo.fork == false &&
+      (github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch')
+    runs-on: [self-hosted, Linux, X64, hifiphile]
+    env:
+      IAR_LMS_BEARER_TOKEN: ${{ secrets.IAR_LMS_BEARER_TOKEN }}
+    steps:
+      - name: Clean workspace
+        run: |
+          echo "Cleaning up previous run"
+          rm -rf "${{ github.workspace }}"3
+          mkdir -p "${{ github.workspace }}"
+
       - name: Toolchain version
-        run: iccarm --version
+        run: |
+          iccarm --version
 
       - name: Checkout TinyUSB
         uses: actions/checkout@v4
 
+      - name: Get build boards
+        run: |
+          MATRIX_JSON=$(python test/hil/hil_ci_set_matrix.py test/hil/hfp.json)
+          BUILD_ARGS=$(echo $MATRIX_JSON | jq -r '.["arm-gcc"] | join(" ")')
+          echo "BUILD_ARGS=$BUILD_ARGS"
+          echo "BUILD_ARGS=$BUILD_ARGS" >> $GITHUB_ENV
+
       - name: Get Dependencies
         run: python3 tools/get_deps.py $BUILD_ARGS
 
       - name: Build
-        run: python3 tools/build.py --one-per-family --toolchain iar $BUILD_ARGS
+        run: python3 tools/build.py --toolchain iar $BUILD_ARGS
+
+      - name: Test on actual hardware (hardware in the loop)
+        run: python3 test/hil/hil_test.py hfp.json

.github/workflows/build_util.yml

@@ -41,7 +41,6 @@ jobs:
         uses: ./.github/actions/setup_toolchain
         with:
           toolchain: ${{ inputs.toolchain }}
-          toolchain_version: 'v5.3.1'
 
       - name: Get Dependencies
         uses: ./.github/actions/get_deps
@@ -59,9 +58,11 @@ jobs:
         shell: bash
 
       - name: Build
+        env:
+          IAR_LMS_BEARER_TOKEN: ${{ secrets.IAR_LMS_BEARER_TOKEN }}
         run: |
           if [ "${{ inputs.toolchain }}" == "esp-idf" ]; then
-            docker run --rm -v $PWD:/project -w /project espressif/idf:v5.3.1 python tools/build.py ${{ matrix.arg }}
+            docker run --rm -v $PWD:/project -w /project espressif/idf:tinyusb python tools/build.py ${{ matrix.arg }}
           else
             python tools/build.py -s ${{ inputs.build-system }} ${{ steps.setup-toolchain.outputs.build_option }} ${{ steps.set-one-per-family.outputs.build_option }} ${{ matrix.arg }}
           fi

.github/workflows/ci_set_matrix.py

@@ -44,9 +44,10 @@ family_list = {
     "stm32l0 stm32l4": ["arm-gcc", "arm-clang", "arm-iar"],
     "stm32u5 stm32wb": ["arm-gcc", "arm-clang", "arm-iar"],
     "xmc4000": ["arm-gcc"],
-    "-bespressif_kaluga_1": ["esp-idf"],
-    "-bespressif_s3_devkitm": ["esp-idf"],
-    "-bespressif_p4_function_ev": ["esp-idf"],
+    "-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/hil_test.yml

@@ -1,126 +0,0 @@
-name: Hardware Test
-
-on:
-  workflow_dispatch:
-  pull_request:
-    branches: [ master ]
-    paths:
-      - 'src/**'
-      - 'examples/**'
-      - 'lib/**'
-      - 'hw/**'
-      - 'test/hil/**'
-      - 'tools/get_deps.py'
-      - '.github/actions/**'
-      - '.github/workflows/hil_test.yml'
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-env:
-  HIL_JSON: test/hil/tinyusb.json
-
-jobs:
-  set-matrix:
-    runs-on: ubuntu-latest
-    outputs:
-      json: ${{ steps.set-matrix-json.outputs.matrix }}
-    steps:
-      - name: Checkout TinyUSB
-        uses: actions/checkout@v4
-
-      - name: Generate matrix json
-        id: set-matrix-json
-        run: |
-          MATRIX_JSON=$(python test/hil/hil_ci_set_matrix.py ${{ env.HIL_JSON }})
-          echo "matrix=$MATRIX_JSON"
-          echo "matrix=$MATRIX_JSON" >> $GITHUB_OUTPUT
-
-  # ---------------------------------------
-  # Build arm-gcc
-  # ---------------------------------------
-  build:
-    if: github.repository_owner == 'hathach'
-    needs: set-matrix
-    uses: ./.github/workflows/build_util.yml
-    strategy:
-      fail-fast: false
-      matrix:
-        toolchain:
-          - 'arm-gcc'
-          - 'esp-idf'
-    with:
-      build-system: 'cmake'
-      toolchain: ${{ matrix.toolchain }}
-      build-args: ${{ toJSON(fromJSON(needs.set-matrix.outputs.json)[matrix.toolchain]) }}
-      one-per-family: true
-      upload-artifacts: true
-
-  # ---------------------------------------
-  # Hardware in the loop (HIL)
-  # self-hosted on local VM, for attached hardware checkout HIL_JSON
-  # ---------------------------------------
-  hil-tinyusb:
-    if: github.repository_owner == 'hathach'
-    needs: build
-    runs-on: [self-hosted, X64, hathach, hardware-in-the-loop]
-    steps:
-      - name: Clean workspace
-        run: |
-          echo "Cleaning up previous run"
-          rm -rf "${{ github.workspace }}"
-          mkdir -p "${{ github.workspace }}"
-
-      - name: Checkout TinyUSB
-        uses: actions/checkout@v4
-        with:
-          sparse-checkout: test/hil
-
-      - name: Download Artifacts
-        uses: actions/download-artifact@v4
-        with:
-          path: cmake-build
-          merge-multiple: true
-
-      - name: Test on actual hardware
-        run: |
-          ls cmake-build/
-          python3 test/hil/hil_test.py ${{ env.HIL_JSON }}
-
-  # ---------------------------------------
-  # Hardware in the loop (HIL)
-  # self-hosted by HFP, build with IAR toolchain, for attached hardware checkout test/hil/hfp.json
-  # ---------------------------------------
-  hil-hfp:
-    if: github.repository_owner == 'hathach'
-    runs-on: [self-hosted, Linux, X64, hifiphile]
-    #env:
-    #  IAR_LMS_BEARER_TOKEN: ${{ secrets.IAR_LMS_BEARER_TOKEN }}
-    steps:
-      - name: Clean workspace
-        run: |
-          echo "Cleaning up previous run"
-          rm -rf "${{ github.workspace }}"
-          mkdir -p "${{ github.workspace }}"
-
-      - name: Toolchain version
-        run: iccarm --version
-
-      - name: Checkout TinyUSB
-        uses: actions/checkout@v4
-
-      - name: Get build boards
-        run: |
-          MATRIX_JSON=$(python test/hil/hil_ci_set_matrix.py test/hil/hfp.json)
-          BUILD_ARGS=$(echo $MATRIX_JSON | jq -r '.["arm-gcc"] | join(" ")')
-          echo "BUILD_ARGS=$BUILD_ARGS"
-          echo "BUILD_ARGS=$BUILD_ARGS" >> $GITHUB_ENV
-
-      - name: Get Dependencies
-        run: python3 tools/get_deps.py $BUILD_ARGS
-
-      - name: Build
-        run: python3 tools/build.py --toolchain iar $BUILD_ARGS
-
-      - name: Test on actual hardware (hardware in the loop)
-        run: python3 test/hil/hil_test.py hfp.json

.gitignore

@@ -15,6 +15,14 @@ latex
 *.jlink
 *.emSession
 *.ninja*
+*.eww
+*.ewp
+*.ewt
+*.ewd
+*.hex
+cmake_install.cmake
+CMakeCache.txt
+settings/
 .settings/
 .vscode/
 .gdb_history
@@ -37,4 +45,10 @@ cmake-build-*
 sdkconfig
 .PVS-Studio
 .vscode/
-build/
+build
+CMakeFiles
+Debug
+RelWithDebInfo
+Release
+BrowseInfo
+.cmake_build

.idea/cmake.xml

@@ -6,12 +6,14 @@
       <configuration PROFILE_NAME="raspberrypi_zero2" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=raspberrypi_zero2 -DLOG=1" />
       <configuration PROFILE_NAME="raspberrypi_cm4" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=raspberrypi_cm4 -DLOG=1" />
       <configuration PROFILE_NAME="raspberry_pi_pico" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=raspberry_pi_pico -DLOG=1" />
-      <configuration PROFILE_NAME="raspberry_pi_pico2" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=raspberry_pi_pico2 -DLOG=1" />
-      <configuration PROFILE_NAME="raspberry_pi_pico2_riscv" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=raspberry_pi_pico2_riscv -DLOG=1" />
       <configuration PROFILE_NAME="raspberry_pi_pico-pio_host" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=raspberry_pi_pico -DLOG=1 -DCFLAGS_CLI=&quot;-DCFG_TUH_RPI_PIO_USB=1&quot;" />
+      <configuration PROFILE_NAME="raspberry_pi_pico2" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=raspberry_pi_pico2 -DLOG=1" />
+      <configuration PROFILE_NAME="raspberry_pi_pico2-pio_host" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=raspberry_pi_pico2 -DLOG=1 -DCFLAGS_CLI=&quot;-DCFG_TUH_RPI_PIO_USB=1&quot;" />
       <configuration PROFILE_NAME="feather_rp2040" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=pico_sdk -DPICO_BOARD=adafruit_feather_rp2040 -DLOG=1" />
       <configuration PROFILE_NAME="feather_rp2040_max3421" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=feather_rp2040_max3421 -DLOG=1" />
       <configuration PROFILE_NAME="metro_rp2040" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=pico_sdk -DPICO_BOARD=adafruit_metro_rp2040 -DLOG=1 -DMAX3421_HOST=1" />
+      <configuration PROFILE_NAME="adafruit_metro_rp2350" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=adafruit_metro_rp2350 -DLOG=1 -DCFLAGS_CLI=&quot;-DCFG_TUH_RPI_PIO_USB=1&quot;" />
+      <configuration PROFILE_NAME="adafruit_fruit_jam" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=adafruit_fruit_jam -DLOG=1 -DCFLAGS_CLI=&quot;-DCFG_TUH_RPI_PIO_USB=1&quot;" />
       <configuration PROFILE_NAME="adafruit_feather_esp32_v2" ENABLED="false" TOOLCHAIN_NAME="ESP-IDF" GENERATION_OPTIONS="-DBOARD=adafruit_feather_esp32_v2 -DMAX3421_HOST=1 -DLOG=1">
         <ADDITIONAL_GENERATION_ENVIRONMENT>
           <envs>
@@ -81,16 +83,19 @@
       <configuration PROFILE_NAME="atsaml21_xpro" ENABLED="false" GENERATION_OPTIONS="-DBOARD=atsaml21_xpro" />
       <configuration PROFILE_NAME="feather_m4_express" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=feather_m4_express -DLOG=1 -DLOGGER=RTT -DMAX3421_HOST=1" />
       <configuration PROFILE_NAME="metro_m4_express" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=metro_m4_express -DLOG=1 -DLOGGER=RTT -DMAX3421_HOST=1" />
+      <configuration PROFILE_NAME="feather_m4_express-zephyr" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=feather_m4_express -DLOG=1 -DMAX3421_HOST=1 -DRTOS=zephyr" />
       <configuration PROFILE_NAME="itsybitsy_m4" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=itsybitsy_m4" />
       <configuration PROFILE_NAME="same54_xplained" ENABLED="false" GENERATION_OPTIONS="-DBOARD=same54_xplained -DLOG=1 -DLOGGER=RTT" />
       <configuration PROFILE_NAME="samg55_xplained" ENABLED="false" GENERATION_OPTIONS="-DBOARD=samg55_xplained" />
       <configuration PROFILE_NAME="feather_nrf52840_express" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=feather_nrf52840_express -DLOG=1 -DLOGGER=RTT -DMAX3421_HOST=1" />
       <configuration PROFILE_NAME="pca10056" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=pca10056 -DLOG=1 -DLOGGER=RTT -DTRACE_ETM=1" />
+      <configuration PROFILE_NAME="pca10056-zephyr" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=pca10056 -DLOG=1 -DTRACE_ETM=1 -DRTOS=zephyr" BUILD_OPTIONS="-v" />
       <configuration PROFILE_NAME="pca10095" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=pca10095 -DLOG=1 -DLOGGER=RTT -DTRACE_ETM=1" />
       <configuration PROFILE_NAME="metro m7 1011 sd" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=metro_m7_1011_sd -DLOG=1 -DLOGGER=RTT -DTRACE_ETM=1" />
       <configuration PROFILE_NAME="metro_m7_1011" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=metro_m7_1011 -DLOG=1 -DLOGGER=RTT" />
       <configuration PROFILE_NAME="rt1010 evk" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=mimxrt1010_evk -DLOG=1 -DLOGGER=RTT" />
-      <configuration PROFILE_NAME="mimxrt1060_evk" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=mimxrt1060_evk -DLOG=1 -DLOGGER=RTT" />
+      <configuration PROFILE_NAME="mimxrt1060_evk" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=mimxrt1060_evk -DLOG=1" />
+      <configuration PROFILE_NAME="mimxrt1064_evk" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=mimxrt1064_evk" />
       <configuration PROFILE_NAME="rt1170 evkb" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=mimxrt1170_evkb -DLOG=1 -DLOGGER=RTT -DTRACE_ETM=1" />
       <configuration PROFILE_NAME="stm32f072disco" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=stm32f072disco -DLOG=0 -DLOGGER=RTT" />
       <configuration PROFILE_NAME="stm32f103_mini_2" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=stm32f103_mini_2 -DLOG=1 -DLOGGGER=RTT" />
@@ -162,7 +167,6 @@
       <configuration PROFILE_NAME="max32650fthr" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=max32650fthr -DLOG=0 -DLOGGER=RTT" />
       <configuration PROFILE_NAME="max32666fthr" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=max32666fthr -DLOG=0 -DLOGGER=RTT" />
       <configuration PROFILE_NAME="max32690evkit" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=max32690evkit -DLOG=1 -DLOGGER=RTT" />
-      <configuration PROFILE_NAME="mimxrt1064_evk" ENABLED="false" CONFIG_NAME="Debug" GENERATION_OPTIONS="-DBOARD=mimxrt1064_evk" />
     </configurations>
   </component>
 </project>

.idea/debugServers/esp32s2.xml

@@ -0,0 +1,14 @@
+<component name="DebugServers">
+  <generic-debug-target name="esp32s2" uniqueID="254eff00-2acf-48fe-b255-1d0c0c9c4a7a">
+    <debugger version="1">
+      <debugger kind="GDB">$USER_HOME$/.espressif/tools/xtensa-esp-elf-gdb/14.2_20240403/xtensa-esp-elf-gdb/bin/xtensa-esp32s2-elf-gdb</debugger>
+      <env />
+    </debugger>
+    <gdbserver exe="$USER_HOME$/.espressif/tools/openocd-esp32/v0.12.0-esp32-20241016/openocd-esp32/bin/openocd" args="-f board/esp32s2-kaluga-1.cfg">
+      <env />
+    </gdbserver>
+    <console port="4444" />
+    <target download-type="NONE" reset-command="monitor reset halt" reset-before="false" />
+    <connection extended-remote="false" remote-string="tcp::3333" warmup-ms="500" />
+  </generic-debug-target>
+</component>

.idea/debugServers/rp2040.xml

@@ -0,0 +1,14 @@
+<component name="DebugServers">
+  <generic-debug-target name="rp2040" uniqueID="006ce655-8571-401e-a94b-6a4f6d519724">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/local/bin/openocd" args="-f interface/cmsis-dap.cfg -f target/rp2040.cfg -c &quot;adapter speed 5000&quot;">
+      <env />
+    </gdbserver>
+    <console enabled="true" port="4444" />
+    <target download-type="UPDATED_ONLY" reset-before="false" />
+    <connection extended-remote="false" remote-string="tcp::3333" warmup-ms="500" />
+  </generic-debug-target>
+</component>

.idea/debugServers/rp2350.xml

@@ -0,0 +1,14 @@
+<component name="DebugServers">
+  <generic-debug-target name="rp2350" uniqueID="939fdf16-9c30-4261-8435-3e8df7fd5800">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/local/bin/openocd" args="-f interface/cmsis-dap.cfg -f target/rp2350.cfg -c &quot;adapter speed 5000&quot;">
+      <env />
+    </gdbserver>
+    <console enabled="true" port="4444" />
+    <target download-type="UPDATED_ONLY" reset-before="false" />
+    <connection extended-remote="false" remote-string="tcp::3333" warmup-ms="500" />
+  </generic-debug-target>
+</component>

.idea/debugServers/rt1060.xml

@@ -0,0 +1,13 @@
+<component name="DebugServers">
+  <jlink-debug-target name="rt1060" uniqueID="851396c6-2030-4694-b86d-21ba9547ddcb">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/bin/JLinkGDBServerCLExe" />
+    <console port="19021" />
+    <target device="MIMXRT1062xxx6A" reset-before="false" />
+    <connection extended-remote="false" port="4444" warmup-ms="500" />
+    <swo />
+  </jlink-debug-target>
+</component>

.idea/debugServers/rt1064.xml

@@ -0,0 +1,13 @@
+<component name="DebugServers">
+  <jlink-debug-target name="rt1064" uniqueID="9602472b-6ce8-4a2d-9636-1c03b5fcd6da">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/bin/JLinkGDBServerCLExe" />
+    <console port="19021" />
+    <target device="MIMXRT1064xxx6A" reset-before="false" />
+    <connection extended-remote="false" port="4444" warmup-ms="500" />
+    <swo />
+  </jlink-debug-target>
+</component>

.idea/debugServers/sam21.xml

@@ -0,0 +1,13 @@
+<component name="DebugServers">
+  <jlink-debug-target name="sam21" uniqueID="b22537b6-0924-4a2b-8721-48a8952239de">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/bin/JLinkGDBServerCLExe" />
+    <console port="19021" />
+    <target device="ATSAMD21G18A" reset-before="false" />
+    <connection extended-remote="false" port="4444" warmup-ms="500" />
+    <swo />
+  </jlink-debug-target>
+</component>

.idea/debugServers/sam51.xml

@@ -0,0 +1,13 @@
+<component name="DebugServers">
+  <jlink-debug-target name="sam51" uniqueID="481ff0d4-6501-4394-8b6b-f7a2ca4c2675">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/bin/JLinkGDBServerCLExe" />
+    <console port="19021" />
+    <target device="ATSAMD51J19A" reset-before="false" />
+    <connection extended-remote="false" port="4444" warmup-ms="500" />
+    <swo />
+  </jlink-debug-target>
+</component>

.idea/debugServers/stm32f769.xml

@@ -0,0 +1,13 @@
+<component name="DebugServers">
+  <jlink-debug-target name="stm32f769" uniqueID="7a47302f-f7e5-434b-b20b-78e95318dd0c">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/bin/JLinkGDBServerCLExe" />
+    <console port="19021" />
+    <target device="STM32F769NI" reset-before="false" frequency="16000" />
+    <connection extended-remote="false" port="4444" warmup-ms="500" />
+    <swo />
+  </jlink-debug-target>
+</component>

.idea/debugServers/stm32h563.xml

@@ -0,0 +1,13 @@
+<component name="DebugServers">
+  <jlink-debug-target name="stm32h563" uniqueID="a3e9293d-113b-48b3-b83d-dd4249984abe">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/bin/JLinkGDBServerCLExe" />
+    <console port="19021" />
+    <target device="STM32H562ZI" reset-before="false" frequency="16000" />
+    <connection extended-remote="false" port="4444" warmup-ms="500" />
+    <swo />
+  </jlink-debug-target>
+</component>

.idea/debugServers/stm32h743.xml

@@ -0,0 +1,13 @@
+<component name="DebugServers">
+  <jlink-debug-target name="stm32h743" uniqueID="6d6a3ed6-f66d-4f6a-9e70-6aafe5c971d0">
+    <debugger version="1">
+      <debugger kind="GDB" isBundled="true" />
+      <env />
+    </debugger>
+    <gdbserver exe="/usr/bin/JLinkGDBServerCLExe" />
+    <console port="19021" />
+    <target device="STM32H743XI" reset-before="false" frequency="16000" />
+    <connection extended-remote="false" port="4444" warmup-ms="500" />
+    <swo />
+  </jlink-debug-target>
+</component>

.idea/vcs.xml

@@ -2,5 +2,6 @@
 <project version="4">
   <component name="VcsDirectoryMappings">
     <mapping directory="$PROJECT_DIR$" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/hw/mcu/raspberry_pi/Pico-PIO-USB" vcs="Git" />
   </component>
 </project>

README.rst

@@ -15,10 +15,7 @@ TinyUSB Project
 .. figure:: docs/assets/logo.svg
    :alt: TinyUSB
 
-TinyUSB is an open-source cross-platform USB Host/Device stack for
-embedded system, designed to be memory-safe with no dynamic allocation
-and thread-safe with all interrupt events are deferred then handled in
-the non-ISR task function. Check out the online `documentation <https://docs.tinyusb.org/>`__ for more details.
+TinyUSB is an open-source cross-platform USB Host/Device stack for embedded system, designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events are deferred then handled in the non-ISR task function. Check out the online `documentation <https://docs.tinyusb.org/>`__ for more details.
 
 .. figure:: docs/assets/stack.svg
    :width: 500px
@@ -32,7 +29,7 @@ the non-ISR task function. Check out the online `documentation <https://docs.tin
     ├── hw
     │   ├── bsp         # Supported boards source files
     │   └── mcu         # Low level mcu core & peripheral drivers
-    ├── lib             # Sources from 3rd party such as freeRTOS, fatfs ...
+    ├── lib             # Sources from 3rd party such as FreeRTOS, FatFs ...
     ├── src             # All sources files for TinyUSB stack itself.
     ├── test            # Tests: unit test, fuzzing, hardware test
     └── tools           # Files used internally
@@ -43,12 +40,12 @@ Getting started
 
 See the `online documentation <https://docs.tinyusb.org>`_ for information about using TinyUSB and how it is implemented.
 
+Check out `Getting Started`_ guide for adding TinyUSB to your project or building the examples. If you are new to TinyUSB, we recommend starting with the ``cdc_msc`` example. There is a handful of `Supported Boards`_ that should work out of the box.
+
 We use `GitHub Discussions <https://github.com/hathach/tinyusb/discussions>`_ as our forum. It is a great place to ask questions and advice from the community or to discuss your TinyUSB-based projects.
 
 For bugs and feature requests, please `raise an issue <https://github.com/hathach/tinyusb/issues>`_ and follow the templates there.
 
-Check out `Getting Started`_ guide for adding TinyUSB to your project or building the examples. If you are new to TinyUSB, we recommend starting with the `cdc_msc` example.
-
 See `Porting`_ guide for adding support for new MCUs and boards.
 
 Device Stack
@@ -69,7 +66,7 @@ Supports multiple device configurations by dynamically changing USB descriptors,
 -  Vendor-specific class support with generic In & Out endpoints. Can be used with MS OS 2.0 compatible descriptor to load winUSB driver without INF file.
 -  `WebUSB <https://github.com/WICG/webusb>`__ with vendor-specific class
 
-If you have a special requirement, `usbd_app_driver_get_cb()` can be used to write your own class driver without modifying the stack. Here is how the RPi team added their reset interface `raspberrypi/pico-sdk#197 <https://github.com/raspberrypi/pico-sdk/pull/197>`_
+If you have a special requirement, ``usbd_app_driver_get_cb()`` can be used to write your own class driver without modifying the stack. Here is how the RPi team added their reset interface `raspberrypi/pico-sdk#197 <https://github.com/raspberrypi/pico-sdk/pull/197>`_
 
 Host Stack
 ==========
@@ -80,10 +77,10 @@ Host Stack
 - Vendor serial over USB: FTDI, CP210x, CH34x
 - 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.
+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.
 
-TypeC PD Stack
-==============
+Power Delivery Stack
+====================
 
 - Power Delivery 3.0 (PD3.0) with USB Type-C support (WIP)
 - Super early stage, only for testing purpose
@@ -102,100 +99,145 @@ TinyUSB is completely thread-safe by pushing all Interrupt Service Request (ISR)
 Supported CPUs
 ==============
 
-Following CPUs are supported, check out `Supported Devices`_ for comprehensive list of driver, features for each CPU.
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Manufacturer | Family                      | Device | Host | Highspeed | Driver                 | Note              |
++==============+=============================+========+======+===========+========================+===================+
+| Allwinner    | F1C100s/F1C200s             | ✔      |      | ✔         | sunxi                  | musb variant      |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Analog       | MAX3421E                    |        | ✔    | ✖         | max3421                | via SPI           |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | MAX32 650, 666, 690,        | ✔      |      | ✔         | musb                   | 1-dir ep          |
+|              | MAX78002                    |        |      |           |                        |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Brigetek     | FT90x                       | ✔      |      | ✔         | ft9xx                  | 1-dir ep          |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Broadcom     | BCM2711, BCM2837            | ✔      |      | ✔         | dwc2                   |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Dialog       | DA1469x                     | ✔      | ✖    | ✖         | da146xx                |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Espressif    | S2, S3                      | ✔      | ✔    | ✖         | dwc2 or esp32sx        |                   |
+|   ESP32      +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | P4                          | ✔      | ✔    | ✔         | dwc2                   |                   |
++--------------+----+------------------------+--------+------+-----------+------------------------+-------------------+
+| GigaDevice   | GD32VF103                   | ✔      |      | ✖         | dwc2                   |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Infineon     | XMC4500                     | ✔      | ✔    | ✖         | dwc2                   |                   |
++--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
+| MicroChip    | SAM | D11, D21, L21, L22    | ✔      |      | ✖         | samd                   |                   |
+|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
+|              |     | D51, E5x              | ✔      |      | ✖         | samd                   |                   |
+|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
+|              |     | G55                   | ✔      |      | ✖         | samg                   | 1-dir ep          |
+|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
+|              |     | E70,S70,V70,V71       | ✔      |      | ✔         | samx7x                 | 1-dir ep          |
+|              +-----+-----------------------+--------+------+-----------+------------------------+-------------------+
+|              | PIC | 24                    | ✔      |      |           | pic                    | ci_fs variant     |
+|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
+|              |     | 32 mm, mk, mx         | ✔      |      |           | pic                    | ci_fs variant     |
+|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
+|              |     | dsPIC33               | ✔      |      |           | pic                    | ci_fs variant     |
+|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
+|              |     | 32mz                  | ✔      |      |           | pic32mz                | musb variant      |
++--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
+| Mind Montion | mm32                        | ✔      |      | ✖         | mm32f327x_otg          | ci_fs variant     |
++--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
+| NordicSemi   | nRF 52833, 52840, 5340      | ✔      | ✖    | ✖         | nrf5x                  | only ep8 is ISO   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Nuvoton      | NUC120                      | ✔      | ✖    | ✖         | nuc120                 |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | NUC121/NUC125               | ✔      | ✖    | ✖         | nuc121                 |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | NUC126                      | ✔      | ✖    | ✖         | nuc121                 |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | NUC505                      | ✔      |      | ✔         | nuc505                 |                   |
++--------------+---------+-------------------+--------+------+-----------+------------------------+-------------------+
+| NXP          | iMXRT   | RT 10xx, 11xx     | ✔      | ✔    | ✔         | ci_hs                  |                   |
+|              +---------+-------------------+--------+------+-----------+------------------------+-------------------+
+|              | Kinetis | KL                | ✔      | ⚠    | ✖         | ci_fs, khci            |                   |
+|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
+|              |         | K32L2             | ✔      |      | ✖         | khci                   | ci_fs variant     |
+|              +---------+-------------------+--------+------+-----------+------------------------+-------------------+
+|              | LPC     | 11u, 13, 15       | ✔      | ✖    | ✖         | lpc_ip3511             |                   |
+|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
+|              |         | 17, 40            | ✔      | ⚠    | ✖         | lpc17_40               |                   |
+|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
+|              |         | 18, 43            | ✔      | ✔    | ✔         | ci_hs                  |                   |
+|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
+|              |         | 51u               | ✔      | ✖    | ✖         | lpc_ip3511             |                   |
+|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
+|              |         | 54, 55            | ✔      |      | ✔         | lpc_ip3511             |                   |
+|              +---------+-------------------+--------+------+-----------+------------------------+-------------------+
+|              | MCX     | N9, A15           | ✔      |      | ✔         | ci_fs, ci_hs           |                   |
++--------------+---------+-------------------+--------+------+-----------+------------------------+-------------------+
+| Raspberry Pi | RP2040, RP2350              | ✔      | ✔    | ✖         | rp2040, pio_usb        |                   |
++--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
+| Renesas      | RX  | 63N, 65N, 72N         | ✔      | ✔    | ✖         | rusb2                  |                   |
+|              +-----+-----------------------+--------+------+-----------+------------------------+-------------------+
+|              | RA  | 4M1, 4M3, 6M1         | ✔      | ✔    | ✖         | rusb2                  |                   |
+|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
+|              |     | 6M5                   | ✔      | ✔    | ✔         | rusb2                  |                   |
++--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
+| Silabs       | EFM32GG12                   | ✔      |      | ✖         | dwc2                   |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| Sony         | CXD56                       | ✔      | ✖    | ✔         | cxd56                  |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| ST STM32     | F0                          | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
+|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
+|              | F1 | 102, 103               | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
+|              |    +------------------------+--------+------+-----------+------------------------+-------------------+
+|              |    | 105, 107               | ✔      | ✔    | ✖         | dwc2                   |                   |
+|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
+|              | F2, F4, F7, H7              | ✔      | ✔    | ✔         | dwc2                   |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | F3                          | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | C0, G0, H5                  | ✔      |      | ✖         | stm32_fsdev            |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | G4                          | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | L0, L1                      | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
+|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
+|              | L4 | 4x2, 4x3               | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
+|              |    +------------------------+--------+------+-----------+------------------------+-------------------+
+|              |    | 4x5, 4x6               | ✔      | ✔    | ✖         | dwc2                   |                   |
+|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
+|              | L4+                         | ✔      | ✔    | ✖         | dwc2                   |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | L5                          | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
+|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
+|              | U5 | 535, 545               | ✔      |      | ✖         | stm32_fsdev            |                   |
+|              |    +------------------------+--------+------+-----------+------------------------+-------------------+
+|              |    | 575, 585               | ✔      | ✔    | ✖         | dwc2                   |                   |
+|              |    +------------------------+--------+------+-----------+------------------------+-------------------+
+|              |    | 59x,5Ax,5Fx,5Gx        | ✔      | ✔    | ✔         | dwc2                   |                   |
+|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
+|              | WBx5                        | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| TI           | MSP430                      | ✔      | ✖    | ✖         | msp430x5xx             |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | MSP432E4                    | ✔      |      | ✖         | musb                   |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | TM4C123                     | ✔      |      | ✖         | musb                   |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| ValentyUSB   | eptri                       | ✔      | ✖    | ✖         | eptri                  |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
+| WCH          | CH32F20x                    | ✔      |      | ✔         | ch32_usbhs             |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | CH32V20x                    | ✔      |      | ✖         | stm32_fsdev/ch32_usbfs |                   |
+|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
+|              | CH32V307                    | ✔      |      | ✔         | ch32_usbfs/hs          |                   |
++--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
 
-+--------------+------------------------------------------------------------+
-| Manufacturer | Family                                                     |
-+==============+============================================================+
-| Allwinner    | F1C100s/F1C200s                                            |
-+--------------+------------------------------------------------------------+
-| Analog       | max32: 650, 666, 690. max78002                             |
-|              |                                                            |
-|              | max3421e (spi host)                                        |
-+--------------+------------------------------------------------------------+
-| Brigetek     | FT90x                                                      |
-+--------------+------------------------------------------------------------+
-| Broadcom     | BCM2711, BCM2837                                           |
-+--------------+------------------------------------------------------------+
-| Dialog       | DA1469x                                                    |
-+--------------+------------------------------------------------------------+
-| Espressif    | ESP32 S2, S3                                               |
-+--------------+------------------------------------------------------------+
-| GigaDevice   | GD32VF103                                                  |
-+--------------+------------------------------------------------------------+
-| Infineon     | XMC4500                                                    |
-+--------------+------------------------------------------------------------+
-|              | SAM:  D11, D21, D51, E5x, G55, L2x, E7x, S7x, V7x          |
-|  MicroChip   |                                                            |
-|              | PIC:  24, 32mm, 32mk, 32mx, 32mz, dsPIC33                  |
-+--------------+------------------------------------------------------------+
-| Mind Montion | mm32                                                       |
-+--------------+------------------------------------------------------------+
-| NordicSemi   | nRF52833, nRF52840, nRF5340                                |
-+--------------+------------------------------------------------------------+
-| Nuvoton      | NUC 120, 121, 125, 126, 505                                |
-+--------------+------------------------------------------------------------+
-| NXP          | iMXRT: RT10xx, RT11xx                                      |
-|              |                                                            |
-|              | Kinetis: KL, K32L2                                         |
-|              |                                                            |
-|              | LPC: 11u, 13, 15, 17, 18, 40, 43, 51u, 54, 55              |
-|              |                                                            |
-|              | MCX: A15, N9                                               |
-+--------------+------------------------------------------------------------+
-| Raspberry Pi | RP2040, RP2350                                             |
-+--------------+-----+------------------------------------------------------+
-| Renesas      | RA: 4M1, 4M3, 6M1, 6M5                                     |
-|              |                                                            |
-|              | RX: 63N, 65N, 72N                                          |
-+--------------+-----+------------------------------------------------------+
-| Silabs       | EFM32GG12                                                  |
-+--------------+------------------------------------------------------------+
-| Sony         | CXD56                                                      |
-+--------------+------------------------------------------------------------+
-| ST STM32     | C0, F0, F1, F2, F3, F4, F7, G0, G4, H5, H7,                |
-|              |                                                            |
-|              | L0, L1, L4, L4+, L5, U5, WB                                |
-+--------------+------------------------------------------------------------+
-| TI           | MSP430, MSP432E4, TM4C123                                  |
-+--------------+------------------------------------------------------------+
-| ValentyUSB   | eptri                                                      |
-+--------------+------------------------------------------------------------+
-| WCH          | CH32F: F20x                                                |
-|              |                                                            |
-|              | CH32V: V20x, V307                                          |
-+--------------+------------------------------------------------------------+
+Table Legend
+------------
 
-License
-=======
+========= =========================
+✔         Supported
+⚠         Partial support
+✖         Not supported by hardware
+\[empty\] Unknown
+========= =========================
 
-All TinyUSB sources in the ``src`` folder are licensed under MIT
-license, the `Full license is here <LICENSE>`__. However, each file can be
-individually licensed especially those in ``lib`` and ``hw/mcu`` folder.
-Please make sure you understand all the license term for files you use
-in your project.
-
-Docs
-====
-
-- Info
-
-  - `Uses`_
-  - `Changelog`_
-  - `Contributors`_
-
-- `Reference`_
-
-  - `Supported Devices`_
-  - `Getting Started`_
-  - `Dependencies`_
-  - `Concurrency`_
-
-- `Contributing`_
-
-  - `Code of Conduct`_
-  - `Structure`_
-  - `Porting`_
 
 .. |Build Status| image:: https://github.com/hathach/tinyusb/actions/workflows/build.yml/badge.svg
    :target: https://github.com/hathach/tinyusb/actions
@@ -209,15 +251,12 @@ Docs
    :target: https://opensource.org/licenses/MIT
 
 
-.. _Uses: docs/info/uses.rst
 .. _Changelog: docs/info/changelog.rst
 .. _Contributors: CONTRIBUTORS.rst
-.. _Reference: docs/reference/index.rst
-.. _Supported Devices: docs/reference/supported.rst
 .. _Getting Started: docs/reference/getting_started.rst
+.. _Supported Boards: docs/reference/boards.rst
 .. _Dependencies: docs/reference/dependencies.rst
 .. _Concurrency: docs/reference/concurrency.rst
 .. _Contributing: docs/contributing/index.rst
 .. _Code of Conduct: CODE_OF_CONDUCT.rst
-.. _Structure: docs/contributing/structure.rst
 .. _Porting: docs/contributing/porting.rst

docs/conf.py

@@ -5,13 +5,16 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import re
+from pathlib import Path
+
 # -- Path setup --------------------------------------------------------------
 
 
 # -- Project information -----------------------------------------------------
 
 project = 'TinyUSB'
-copyright = '2021, Ha Thach'
+copyright = '2024, Ha Thach'
 author = 'Ha Thach'
 
 
@@ -40,3 +43,16 @@ html_theme_options = {
 }
 
 todo_include_todos = True
+
+# pre-process path in README.rst
+def preprocess_readme():
+    """Modify figure paths in README.rst for Sphinx builds."""
+    src = Path(__file__).parent.parent / "README.rst"
+    tgt = Path(__file__).parent.parent / "README_processed.rst"
+    if src.exists():
+        content = src.read_text()
+        content = re.sub(r"docs/", r"", content)
+        content = re.sub(r".rst", r".html", content)
+        tgt.write_text(content)
+
+preprocess_readme()

docs/contributing/code_of_conduct.rst

@@ -1 +0,0 @@
-../../CODE_OF_CONDUCT.rst

docs/contributing/code_of_conduct.rst

@@ -0,0 +1 @@
+.. include:: ../../CODE_OF_CONDUCT.rst

docs/contributing/index.rst

@@ -19,5 +19,4 @@ Index
    :maxdepth: 2
 
    code_of_conduct
-   structure
    porting

docs/contributing/porting.rst

@@ -9,7 +9,7 @@ data transactions on different endpoints. Porting is the process of adding low-l
 the rest of the common stack. Once the low-level is implemented, it is very easy to add USB support
 for the microcontroller to other projects, especially those already using TinyUSB such as CircuitPython.
 
-Below are instructions on how to get the cdc_msc device example running on a new microcontroller. Doing so includes adding the common code necessary for other uses while minimizing other extra code. Whenever you see a phrase or word in <> it should be replaced.
+Below are instructions on how to get the cdc_msc device example running on a new microcontroller. Doing so includes adding the common code necessary for other uses while minimizing other extra code. Whenever you see a phrase or word in ``<>`` it should be replaced.
 
 Register defs
 -------------
@@ -18,25 +18,27 @@ The first step to adding support is including the register definitions and start
 microcontroller in TinyUSB. We write the TinyUSB implementation against these structs instead of higher level functions to keep the code small and to prevent function name collisions in linking of larger projects. For ARM microcontrollers this is the CMSIS definitions. They should be
 placed in the ``hw/mcu/<vendor>/<chip_family>`` directory.
 
-Once this is done, create a directory in ``hw/bsp/<your board name>`` for the specific board you are using to test the code.  (Duplicating an existing board's directory is the best way to get started.) The board should be a readily available development board so that others can also test.
+Once this is done, create a directory in ``hw/bsp/<your board name>`` for the specific board you are using to test the code (duplicating an existing board's directory is the best way to get started). The board should be a readily available development board so that others can also test.
 
 Build
 -----
 
 Now that those directories are in place, we can start our iteration process to get the example building successfully. To build, run from the root of TinyUSB:
 
-``make -C examples/device/cdc_msc BOARD=<board>``
+.. code-block:: bash
 
-Unless, you've read ahead, this will fail miserably. Now, lets get it to fail less by updating the files in the board directory. The code in the board's directory is responsible for setting up the microcontroller's clocks and pins so that USB works. TinyUSB itself only operates on the USB peripheral. The board directory also includes information what files are needed to build the example.
+   make -C examples/device/cdc_msc BOARD=<board>
 
-One of the first things to change is the ``-DCFG_TUSB_MCU`` cflag in the ``board.mk`` file. This is used to tell TinyUSB what platform is being built. So, add an entry to ``src/tusb_option.h`` and update the CFLAG to match.
+Unless you've read ahead, this will fail miserably. Now, lets get it to fail less by updating the files in the board directory. The code in the board's directory is responsible for setting up the microcontroller's clocks and pins so that USB works. TinyUSB itself only operates on the USB peripheral. The board directory also includes information what files are needed to build the example.
 
-Update ``board.mk``\ 's VENDOR and CHIP_FAMILY values when creating the directory for the struct files. Duplicate one of the other sources from ``src/portable`` into ``src/portable/<vendor>/<chip_family>`` and delete all of the implementation internals. We'll cover what everything there does later. For now, get it compiling.
+One of the first things to change is the ``-DCFG_TUSB_MCU`` C flag in the ``board.mk`` file. This is used to tell TinyUSB what platform is being built. So, add an entry to ``src/tusb_option.h`` and update the ``CFLAGS`` to match.
+
+Update ``board.mk``'s VENDOR and CHIP_FAMILY values when creating the directory for the struct files. Duplicate one of the other sources from ``src/portable`` into ``src/portable/<vendor>/<chip_family>`` and delete all of the implementation internals. We'll cover what everything there does later. For now, get it compiling.
 
 Implementation
 --------------
 
-At this point you should get an error due to an implementation issue and hopefully the build is setup for the new MCU. You will still need to modify the ``board.mk`` to include specific CFLAGS, the linker script, linker flags, source files, include directories. All file paths are relative to the top of the TinyUSB repo.
+At this point you should get an error due to an implementation issue and hopefully the build is setup for the new MCU. You will still need to modify the ``board.mk`` to include specific ``CFLAGS``, the linker script, linker flags, source files, include directories. All file paths are relative to the top of the TinyUSB repo.
 
 Board Support (BSP)
 ^^^^^^^^^^^^^^^^^^^
@@ -45,17 +47,17 @@ The board support code is only used for self-contained examples and testing. It
 
 It is located in ``hw/bsp/<board name>/board_<board name>.c``.
 
-board_init
-~~~~~~~~~~
+``board_init()``
+~~~~~~~~~~~~~~~~
 
-``board_init`` is responsible for starting the MCU, setting up the USB clock and USB pins. It is also responsible for initializing LED pins.
+``board_init()`` is responsible for starting the MCU, setting up the USB clock and USB pins. It is also responsible for initializing LED pins.
 
 One useful clock debugging technique is to set up a PWM output at a known value such as 500hz based on the USB clock so that you can verify it is correct with a logic probe or oscilloscope.
 
 Setup your USB in a crystal-less mode when available. That makes the code easier to port across boards.
 
-board_led_write
-~~~~~~~~~~~~~~~
+``board_led_write()``
+~~~~~~~~~~~~~~~~~~~~~
 
 Feel free to skip this until you want to verify your demo code is running. To implement, set the pin corresponding to the led to output a value that lights the LED when ``state`` is true.
 
@@ -64,48 +66,48 @@ OS Abstraction Layer (OSAL)
 
 The OS Abstraction Layer is responsible for providing basic data structures for TinyUSB that may allow for concurrency when used with an RTOS. Without an RTOS it simply handles concurrency issues between the main code and interrupts. The code is almost entirely agnostic of MCU and lives in ``src/osal``.
 
-In RTOS configurations, tud_task()/tuh_task() blocks behind a synchronization structure when the event queue is empty, so that the scheduler may give the CPU to a different task. To take advantage of the library's capability to yield the CPU when there are no actionable USB device events, ensure that the `CFG_TUSB_OS` symbol is defined, e.g `OPT_OS_FREERTOS` enables the FreeRTOS scheduler to schedule other threads than that which calls `tud_task()/tuh_task()`.
+In RTOS configurations, ``tud_task()``/``tuh_task()`` blocks behind a synchronization structure when the event queue is empty, so that the scheduler may give the CPU to a different task. To take advantage of the library's capability to yield the CPU when there are no actionable USB device events, ensure that the ``CFG_TUSB_OS`` symbol is defined, e.g ``OPT_OS_FREERTOS`` enables the FreeRTOS scheduler to schedule other threads than that which calls ``tud_task()``/``tuh_task()``.
 
 Device API
 ^^^^^^^^^^
 
-After the USB device is setup, the USB device code works by processing events on the main thread (by calling ``tud_task``\ ). These events are queued by the USB interrupt handler. So, there are three parts to the device low-level API: device setup, endpoint setup and interrupt processing.
+After the USB device is setup, the USB device code works by processing events on the main thread (by calling ``tud_task()``). These events are queued by the USB interrupt handler. So, there are three parts to the device low-level API: device setup, endpoint setup and interrupt processing.
 
 All of the code for the low-level device API is in ``src/portable/<vendor>/<chip family>/dcd_<chip family>.c``.
 
 Device Setup
 ~~~~~~~~~~~~
 
-dcd_init
-""""""""
+``dcd_init()``
+""""""""""""""
 
 Initializes the USB peripheral for device mode and enables it.
 This function should enable internal D+/D- pull-up for enumeration.
 
-dcd_int_enable / dcd_int_disable
-""""""""""""""""""""""""""""""""
+``dcd_int_enable()`` / ``dcd_int_disable()``
+""""""""""""""""""""""""""""""""""""""""""""
 
 Enables or disables the USB device interrupt(s). May be used to prevent concurrency issues when mutating data structures shared between main code and the interrupt handler.
 
-dcd_int_handler
-"""""""""""""""
+``dcd_int_handler()``
+"""""""""""""""""""""
 
 Processes all the hardware generated events e.g Bus reset, new data packet from host etc ... It will be called by application in the MCU USB interrupt handler.
 
-dcd_set_address
-"""""""""""""""
+``dcd_set_address()``
+"""""""""""""""""""""
 
 Called when the device is given a new bus address.
 
 If your peripheral automatically changes address during enumeration (like the nrf52) you may leave this empty and also no queue an event for the corresponding SETUP packet.
 
-dcd_remote_wakeup
-"""""""""""""""""
+``dcd_remote_wakeup()``
+"""""""""""""""""""""""
 
 Called to remote wake up host when suspended (e.g hid keyboard)
 
-dcd_connect / dcd_disconnect
-""""""""""""""""""""""""""""
+``dcd_connect()`` / ``dcd_disconnect()``
+""""""""""""""""""""""""""""""""""""""""
 
 Connect or disconnect the data-line pull-up resistor. Define only if MCU has an internal pull-up. (BSP may define for MCU without internal pull-up.)
 
@@ -114,8 +116,8 @@ Special events
 
 You must let TinyUSB know when certain events occur so that it can continue its work. There are a few methods you can call to queue events for TinyUSB to process.
 
-dcd_event_bus_signal
-""""""""""""""""""""
+``dcd_event_bus_signal()``
+""""""""""""""""""""""""""
 
 There are a number of events that your peripheral may communicate about the state of the bus. Here is an overview of what they are. Events in **BOLD** must be provided for TinyUSB to work.
 
@@ -125,51 +127,51 @@ There are a number of events that your peripheral may communicate about the stat
 
 Calls to this look like:
 
-.. code-block::
+.. code-block:: c
 
    dcd_event_bus_signal(0, DCD_EVENT_BUS_RESET, true);
 
 
-The first ``0`` is the USB peripheral number. Statically saying 0 is common for single USB device MCUs.
+The first ``0`` is the USB peripheral number. Statically saying ``0`` is common for single USB device MCUs.
 
 The ``true`` indicates the call is from an interrupt handler and will always be the case when porting in this way.
 
-dcd_setup_received
-""""""""""""""""""
+``dcd_setup_received()``
+""""""""""""""""""""""""
 
 SETUP packets are a special type of transaction that can occur at any time on the control endpoint, numbered ``0``. Since they are unique, most peripherals have special handling for them. Their data is always 8 bytes in length as well.
 
 Calls to this look like:
 
-.. code-block::
+.. code-block:: c
 
    dcd_event_setup_received(0, setup, true);
 
 
-As before with ``dcd_event_bus_signal`` the first argument is the USB peripheral number and the third is true to signal its being called from an interrupt handler. The middle argument is byte array of length 8 with the contents of the SETUP packet. It can be stack allocated because it is copied into the queue.
+As before with ``dcd_event_bus_signal()`` the first argument is the USB peripheral number and the third is true to signal its being called from an interrupt handler. The middle argument is byte array of length 8 with the contents of the SETUP packet. It can be stack allocated because it is copied into the queue.
 
 Endpoints
 ~~~~~~~~~
 
 Endpoints are the core of the USB data transfer process. They come in a few forms such as control, isochronous, bulk, and interrupt. We won't cover the details here except with some caveats in open below. In general, data is transferred by setting up a buffer of a given length to be transferred on a given endpoint address and then waiting for an interrupt to signal that the transfer is finished. Further details below.
 
-Endpoints within USB have an address which encodes both the number and direction of an endpoint. TinyUSB provides ``tu_edpt_number`` and ``tu_edpt_dir`` to unpack this data from the address. Here is a snippet that does it.
+Endpoints within USB have an address which encodes both the number and direction of an endpoint. TinyUSB provides ``tu_edpt_number()`` and ``tu_edpt_dir()`` to unpack this data from the address. Here is a snippet that does it.
 
-.. code-block::
+.. code-block:: c
 
    uint8_t epnum = tu_edpt_number(ep_addr);
    uint8_t dir   = tu_edpt_dir(ep_addr);
 
 
-dcd_edpt_open
-"""""""""""""
+``dcd_edpt_open()``
+"""""""""""""""""""
 
 Opening an endpoint is done for all non-control endpoints once the host picks a configuration that the device should use. At this point, the endpoint should be enabled in the peripheral and configured to match the endpoint descriptor. Pay special attention to the direction of the endpoint you can get from the helper methods above. It will likely change what registers you are setting.
 
 Also make sure to enable endpoint specific interrupts.
 
-dcd_edpt_close
-""""""""""""""
+``dcd_edpt_close()``
+""""""""""""""""""""
 
 Close an endpoint. his function is used for implementing alternate settings.
 
@@ -177,10 +179,10 @@ After calling this, the device should not respond to any packets directed toward
 
 Implementation is optional. Must be called from the USB task. Interrupts could be disabled or enabled during the call.
 
-dcd_edpt_xfer
-"""""""""""""
+``dcd_edpt_xfer()``
+"""""""""""""""""""
 
-``dcd_edpt_xfer`` is responsible for configuring the peripheral to send or receive data from the host. "xfer" is short for "transfer". **This is one of the core methods you must implement for TinyUSB to work (one other is the interrupt handler).**  Data from the host is the OUT direction and data to the host is IN. It  is used for all endpoints including the control endpoint 0. Make sure to handle the zero-length packet STATUS packet on endpoint 0 correctly. It may be a special transaction to the peripheral.
+``dcd_edpt_xfer()`` is responsible for configuring the peripheral to send or receive data from the host. "xfer" is short for "transfer". **This is one of the core methods you must implement for TinyUSB to work (one other is the interrupt handler).**  Data from the host is the OUT direction and data to the host is IN. It  is used for all endpoints including the control endpoint 0. Make sure to handle the zero-length packet STATUS packet on endpoint 0 correctly. It may be a special transaction to the peripheral.
 
 Besides that, all other transactions are relatively straight-forward. The endpoint address provides the endpoint
 number and direction which usually determines where to write the buffer info. The buffer and its length are usually
@@ -195,21 +197,21 @@ Others (like the nRF52) may need each USB packet queued individually. To make th
 some state for yourself and queue up an intermediate USB packet from the interrupt handler.
 
 Once the transaction is going, the interrupt handler will notify TinyUSB of transfer completion.
-During transmission, the IN data buffer is guaranteed to remain unchanged in memory until the ``dcd_xfer_complete`` function is called.
+During transmission, the IN data buffer is guaranteed to remain unchanged in memory until the ``dcd_xfer_complete()`` function is called.
 
-The dcd_edpt_xfer function must never add zero-length-packets (ZLP) on its own to a transfer. If a ZLP is required,
-then it must be explicitly sent by the stack calling dcd_edpt_xfer(), by calling dcd_edpt_xfer() a second time with len=0.
+The ``dcd_edpt_xfer()`` function must never add zero-length-packets (ZLP) on its own to a transfer. If a ZLP is required,
+then it must be explicitly sent by the stack calling ``dcd_edpt_xfer()``, by calling ``dcd_edpt_xfer()`` a second time with len=0.
 For control transfers, this is automatically done in ``usbd_control.c``.
 
-At the moment, only a single buffer can be transmitted at once. There is no provision for double-buffering. new dcd_edpt_xfer() will not
-be called again on the same endpoint address until the driver calls dcd_xfer_complete() (except in cases of USB resets).
+At the moment, only a single buffer can be transmitted at once. There is no provision for double-buffering. new ``dcd_edpt_xfer()`` will not
+be called again on the same endpoint address until the driver calls ``dcd_xfer_complete()`` (except in cases of USB resets).
 
-dcd_xfer_complete
-"""""""""""""""""
+``dcd_xfer_complete()``
+"""""""""""""""""""""""
 
-Once a transfer completes you must call dcd_xfer_complete from the USB interrupt handler to let TinyUSB know that a transaction has completed. Here is a sample call:
+Once a transfer completes you must call ``dcd_xfer_complete()`` from the USB interrupt handler to let TinyUSB know that a transaction has completed. Here is a sample call:
 
-.. code-block::
+.. code-block:: c
 
    dcd_event_xfer_complete(0, ep_addr, xfer->actual_len, XFER_RESULT_SUCCESS, true);
 
@@ -219,23 +221,23 @@ The arguments are:
 
 * the USB peripheral number
 * the endpoint address
-* the actual length of the transfer. (OUT transfers may be smaller than the buffer given in ``dcd_edpt_xfer``\ )
+* the actual length of the transfer. (OUT transfers may be smaller than the buffer given in ``dcd_edpt_xfer()``)
 * the result of the transfer. Failure isn't handled yet.
 * ``true`` to note the call is from an interrupt handler.
 
-dcd_edpt_stall / dcd_edpt_clear_stall
-"""""""""""""""""""""""""""""""""""""
+``dcd_edpt_stall()`` / ``dcd_edpt_clear_stall()``
+"""""""""""""""""""""""""""""""""""""""""""""""""
 
-Stalling is one way an endpoint can indicate failure such as when an unsupported command is transmitted. The pair of ``dcd_edpt_stall``\ , ``dcd_edpt_clear_stall`` help manage the stall state of all endpoints.
+Stalling is one way an endpoint can indicate failure such as when an unsupported command is transmitted. The pair of ``dcd_edpt_stall()``, ``dcd_edpt_clear_stall()`` help manage the stall state of all endpoints.
 
 Woohoo!
 -------
 
-At this point you should have everything working! ;-) Of course, you may not write perfect code. Here are some tips and tricks for debugging.
+At this point you should have everything working! 🙂 Of course, you may not write perfect code. Here are some tips and tricks for debugging.
 
 Use `WireShark <https://www.wireshark.org/>`_ or `a Beagle <https://www.totalphase.com/protocols/usb/>`_ to sniff the USB traffic. When things aren't working its likely very early in the USB enumeration process. Figuring out where can help clue in where the issue is. For example:
 
 
 * If the host sends a SETUP packet and its not ACKed then your USB peripheral probably isn't started correctly.
-* If the peripheral is started correctly but it still didn't work, then verify your usb clock is correct. (You did output a PWM based on it right? ;-) )
-* If the SETUP packet is ACKed but nothing is sent back then you interrupt handler isn't queueing the setup packet correctly. (Also, if you are using your own code instead of an example ``tud_task`` may not be called.) If that's OK, the ``dcd_xfer_complete`` may not be setting up the next transaction correctly.
+* If the peripheral is started correctly but it still didn't work, then verify your usb clock is correct. (You did output a PWM based on it right? 🙂)
+* If the SETUP packet is ACKed but nothing is sent back then you interrupt handler isn't queueing the setup packet correctly. (Also, if you are using your own code instead of an example ``tud_task()`` may not be called.) If that's OK, the ``dcd_xfer_complete()`` may not be setting up the next transaction correctly.

docs/contributing/structure.rst

@@ -1,59 +0,0 @@
-*********
-Structure
-*********
-
-Tree
-====
-
-::
-
-  .
-  ├── docs
-  ├── examples
-  ├── hw
-  │   ├── bsp
-  │   └── mcu
-  ├── lib
-  ├── src
-  ├── test
-  └── tools
-
-docs
-----
-
-Documentation
-
-examples
---------
-
-Sample with Makefile build support
-
-hw/bsp
-------
-
-Supported boards source files
-
-hw/mcu
-------
-
-Low level mcu core & peripheral drivers
-
-lib
----
-
-Sources from 3rd party such as freeRTOS, fatfs ...
-
-src
----
-
-All sources files for TinyUSB stack itself.
-
-test
-----
-
-Unit tests for the stack
-
-tools
------
-
-Files used internally

docs/index.rst

@@ -1,12 +1,6 @@
 :hide-toc:
 
-*********
-TinyUSB
-*********
-
-TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems,
-designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events being deferred and then handled in the non-ISR task function.
-
+.. include:: ../README_processed.rst
 
 .. toctree::
    :caption: Index

docs/info/changelog.rst

@@ -15,13 +15,12 @@ General
 
 - Better support dcache, make sure all usb-transferred buffer are cache line aligned and occupy full cache line
 - Build ARM IAR with CircleCI
-- Improve HIL with dual/host_info_to_device_cdc optional for pico/pico2, enable dwc2 dma test
-
+- Improve HIL with `dual/host_info_to_device_cdc`` optional for pico/pico2, enable dwc2 dma test
 
 API Changes
 -----------
 
-- Change signature of ``tusb_init(rhport, tusb_rhport_init_t*)``, tusb_init(void) is now deprecated but still available for backward compatibility
+- Change signature of ``tusb_init(rhport, tusb_rhport_init_t*)``, ``tusb_init(void)`` is now deprecated but still available for backward compatibility
 - Add new ``tusb_int_handler(rhport, in_isr)``
 - Add time-related APIs: ``tusb_time_millis_api()`` and ``tusb_time_delay_ms_api()`` for non-RTOS, required for some ports/configuration
 - New configuration macros:
@@ -31,7 +30,6 @@ API Changes
   - ``CFG_TUD/TUH_DWC2_SLAVE_ENABLE`` enable dwc2 slave mode
   - ``CFG_TUD/TUH_DWC2_DMA_ENABLE`` enable dwc2 dma mode
 
-
 Controller Driver (DCD & HCD)
 -----------------------------
 
@@ -39,17 +37,17 @@ Controller Driver (DCD & HCD)
   - Add DMA support for both device and host controller
   - Add host driver support including: full/high speed, control/bulk/interrupt (CBI) transfer, split CBI i.e FS/LS attached via highspeed hub, hub support
 
-- RP2: implement dcd_edpt_iso_alloc() and dcd_edpt_iso_activate() for isochronous endpoint
+- RP2: implement ``dcd_edpt_iso_alloc()`` and ``dcd_edpt_iso_activate()`` for isochronous endpoint
 - iMXRT1170 support M4 core
 
 Device Stack
 ------------
 
 - Vendor Fix  class reset
-- NCM fix recursions in tud_network_recv_renew()
-- Audio fix align issue of _audiod_fct.alt_setting
+- NCM fix recursions in ``tud_network_recv_renew()``
+- Audio fix align issue of ``_audiod_fct.alt_setting``
 - UVC support format frame based
-- Change dcd_dcache_() return type from void to bool
+- Change ``dcd_dcache_()`` return type from void to bool
 - HID add Usage Table for Physical Input Device Page (0x0F)
 
 Host Stack
@@ -91,20 +89,20 @@ Controller Driver (DCD & HCD)
   - Add support for ch32 usbd e.g ch32v203
   - Add support for STM32G4 and STM32U5 microcontrollers.
   - Fix h5 (32-bit) errata 2.15.1: Buffer description table update completes after CTR interrupt triggers
-  - ISO EP buffer allocation improvements, implement dcd_edpt_close_all()
+  - ISO EP buffer allocation improvements, implement ``dcd_edpt_close_all()``
 
   - Fix ch32v203 race condition and stability issue with
 
     - fix ch32v203 seems to unconditionally accept ZLP on EP0 OUT.
     - fix v203 race condition between rx bufsize and RX_STAT which cause PMAOVR, occurs with WRITE10
-    - correctly handle setup prepare at dcd_edpt0_status_complete(), which fixes the race condition with windows where we could miss setup packet (setup bit set, but count = 0)
+    - correctly handle setup prepare at ``dcd_edpt0_status_complete()``, which fixes the race condition with windows where we could miss setup packet (setup bit set, but count = 0)
 
 - MAX3421E
 
   - Add support for rp2040, esp32 (c3, c6, h2, etc..)
-  - Add hcd_deinit() for max3421
+  - Add ``hcd_deinit()`` for max3421
   - Retry NAK handling next frame to reduce CPU and SPI bus usage
-  - add cpuctl and pinctl to tuh_configure() option for max3421
+  - add ``cpuctl`` and ``pinctl`` to ``tuh_configure()`` option for max3421
   - Implement hcd abort transfer for Max3421
   - Properly Handle NAK Response in MAX3421E driver: correctly switch and skip writing to 2 FIFOs when NAK received. Otherwise, the driver may hang in certain conditions.
 
@@ -116,7 +114,7 @@ Controller Driver (DCD & HCD)
 
 - nRF
 
-  - Fix dcd_edpt_open for iso endpoint
+  - Fix ``dcd_edpt_open()`` for iso endpoint
   - Handle ISOOUT CRC errors
   - Add compile support with old nordic sdk
   - Fix a few race conditions
@@ -143,7 +141,7 @@ Controller Driver (DCD & HCD)
 Device Stack
 ------------
 
-- Add tud_deinit() and class driver deinit() to deinitialize TinyUSB device stack.
+- Add ``tud_deinit()`` and ``class driver deinit()`` to deinitialize TinyUSB device stack.
 - Add support for generic SOF callback.
 - Add set address recovery time 2ms per USB spec.
 
@@ -159,7 +157,7 @@ Device Stack
 
 - CDC
 
-  - Add tud_cdc_configure_fifo() to make RX/TX buffer persistent (not clear when disconnected)
+  - Add ``tud_cdc_configure_fifo()`` to make RX/TX buffer persistent (not clear when disconnected)
   - Add missing capability bit for CDC ACM serial break support
   - Enhanced CDC class with better handling of large data transmissions.
   - Add missing capability bit for CDC ACM serial break support
@@ -177,39 +175,39 @@ Device Stack
 - Net
 
   - Rewrite of NCM device driver to improve throughput
-  - removed obsolete tud_network_link_state_cb()
+  - removed obsolete ``tud_network_link_state_cb()``
 
 - USBTMC Added notification support
 
 - Vendor
 
   - Migrate to new endpoint stream API, support non-buffered TX/RX
-  - Add ZLP for write() when needed
+  - Add ZLP for ``write()`` when needed
 
 - Video
 
   - Enhance UVC descriptors and example
   - Video Added support for USB Video Class (UVC) with MJPEG.
   - Fix multiple interfaces, add an example of 2ch video capture.
-  - Fix race for tud_video_n_streaming check
+  - Fix race for ``tud_video_n_streaming()`` check
 
 Host Stack
 ----------
 
-- Added tuh_deinit() to de-initialize TinyUSB host stack.
+- Added ``tuh_deinit()`` to de-initialize TinyUSB host stack.
 - Added support for new USB mass storage class APIs.
 - Improved error handling and retry mechanisms for unstable devices.
 
 - CDC Serial
 
   - Add support for ch34x
-  - Allow to overwrite CFG_TUH_CDC_FTDI/CP210X/CH32X_VID_PID_LIST
+  - Allow to overwrite ``CFG_TUH_CDC_FTDI/CP210X/CH32X_VID_PID_LIST``
   - Enhanced stability of CDC-ACM devices during enumeration.
 
 - HID
 
-  - Add tuh_hid_receive_abort()
-  - Add tuh_hid_get_report()
+  - Add ``tuh_hid_receive_abort()``
+  - Add ``tuh_hid_get_report()``
 
 - Hub
 
@@ -226,14 +224,14 @@ Host Stack
 - Remove submodules and use python script to manage repo dependencies #1947
 - Add CMake support for most families and boards, move build file from tools/ to examples/build_system
 - Add ETM trace support with JTrace for nrf52840, nrf5340, mcb1857, stm32h743eval, ra6m5
-- [osal] Make it possible to override the osal_task_delay() in osal_none
+- [osal] Make it possible to override the ``osal_task_delay()`` in osal_none
 - Add CDC+UAC2 composite device example
 - Enhance Hardware-in-the-loop (HIL) testing with more boards: rp2040, stm32l412nucleo, stm32f746disco, lpcxpresso43s67
 
 Controller Driver (DCD & HCD)
 -----------------------------
 
-- Add new ISO endpoint API: dcd_edpt_iso_alloc() and dcd_edpt_iso_activate()
+- Add new ISO endpoint API: ``dcd_edpt_iso_alloc()`` and ``dcd_edpt_iso_activate()``
 - Remove legacy driver st/synopsys
 
 - EHCI
@@ -246,10 +244,10 @@ Controller Driver (DCD & HCD)
   - Fix error on EHCI causes xfer error in non-queued qhd which cause memory fault
   - Un-roll recursive hub removal with usbh queue
   - Fix issue when removing queue head
-  - Implement hcd_edpt_abort_xfer()
+  - Implement ``hcd_edpt_abort_xfer()``
   - use standard USB complete interrupt instead of custom chipidea async/period interrupt to be more compatible with other ehci implementation
   - refactor usb complete & error isr processing, merge, update. Fix EHCI QHD reuses QTD on wrong endpoint
-  - Improve bus reset, fix send_setup() not carried out if halted previously
+  - Improve bus reset, fix ``send_setup()`` not carried out if halted previously
   - Fix clear qhd halted bit if not caused by STALL protocol to allow for next transfer
 
 - ChipIdea Highspeed
@@ -275,12 +273,12 @@ Controller Driver (DCD & HCD)
 - rp2040
 
   - [dcd] Make writes to SIE_CTRL aware of concurrent access
-  - [hcd] add hcd_frame_number(), hcd_edpt_abort_xfer() for pio-usb host
+  - [hcd] add ``hcd_frame_number()``, ``hcd_edpt_abort_xfer()`` for pio-usb host
 
 - stm32 fsdev:
 
   - Add STM32L5 support
-  - Implement dcd_edpt_iso_alloc() and dcd_edpt_iso_activate()
+  - Implement ``dcd_edpt_iso_alloc()`` and ``dcd_edpt_iso_activate()``
 
 - OHCI
 
@@ -294,7 +292,7 @@ Controller Driver (DCD & HCD)
 Device Stack
 ------------
 
-- Add optional hooks tud_event_hook_cb()
+- Add optional hooks ``tud_event_hook_cb()``
 - Audio (UAC2)
 
   - Fix feedback EP buffer alignment.
@@ -312,12 +310,12 @@ Device Stack
 
 - MIDI
 
-  - Fix stream_write() always writes system messages to cable 0
+  - Fix ``stream_write()`` always writes system messages to cable 0
   - Fix incorrect NOTE_ON, NOTE_OFF definitions
 
 - USBTMC: Fix tmc488 bit order
 
-- Vendor: fix read()/write() race condition
+- Vendor: fix ``read()``/``write()`` race condition
 
 - Video (UVC)
 
@@ -328,26 +326,26 @@ Host Stack
 
 - USBH
 
-  - Add new APIs: tuh_interface_set(), tuh_task_event_ready(), tuh_edpt_abort_xfer(), tuh_rhport_reset_bus(), tuh_rhport_is_active()
+  - Add new APIs: ``tuh_interface_set()``, ``tuh_task_event_ready()``, ``tuh_edpt_abort_xfer()``, ``tuh_rhport_reset_bus()``, ``tuh_rhport_is_active()``
   - Fix issue when device generate multiple attach/detach/attach when plugging in
   - Prefer application callback over built-in driver on transfer complete event
-  - Correct hcd_edpt_clear_stall() API signature
+  - Correct ``hcd_edpt_clear_stall()`` API signature
   - Separate bus reset delay and contact debouncing delay in enumeration
-  - Support usbh_app_driver_get_cb() for application drivers
+  - Support ``usbh_app_driver_get_cb()`` for application drivers
   - Fix usbh enumeration removal race condition
-  - Add optional hooks tuh_event_hook_cb()
+  - Add optional hooks ``tuh_event_hook_cb()``
 
 - CDC
 
-  - Breaking: change tuh_cdc_itf_get_info() to use tuh_itf_info_t instead of tuh_cdc_info_t
+  - Breaking: change ``tuh_cdc_itf_get_info()`` to use tuh_itf_info_t instead of tuh_cdc_info_t
   - Fix cdc host enumeration issue when device does not support line request
   - Add support for vendor usb2uart serial: ftdi, cp210x, ch9102f
-  - Improve sync control API e.g  tuh_cdc_set_control_line_state(), tuh_cdc_set_line_coding()
+  - Improve sync control API e.g  ``tuh_cdc_set_control_line_state()``, ``tuh_cdc_set_line_coding()``
 
 - HID
 
-  - Add new APIs tuh_hid_send_report(), tuh_hid_itf_get_info(), tuh_hid_receive_ready(), tuh_hid_send_ready(), tuh_hid_set_default_protocol()
-  - Change meaning of CFG_TUH_HID to total number of HID interfaces supported. Previously CFG_TUH_HID is max number of interfaces per device which is rather limited and consume more resources than needed.
+  - Add new APIs ``tuh_hid_send_report()``, ``tuh_hid_itf_get_info()``, ``tuh_hid_receive_ready()``, ``tuh_hid_send_ready()``, ``tuh_hid_set_default_protocol()``
+  - Change meaning of CFG_TUH_HID to total number of HID interfaces supported. Previously ``CFG_TUH_HID`` is max number of interfaces per device which is rather limited and consume more resources than needed.
 
 - HUB
 
@@ -356,7 +354,7 @@ Host Stack
 
 - MSC
 
-  - Fix bug in tuh_msc_ready()
+  - Fix bug in ``tuh_msc_ready()``
   - Fix host msc get maxlun not using aligned section memory
 
 0.15.0
@@ -387,7 +385,7 @@ Controller Driver (DCD & HCD)
 - [rp2040]
 
   - [dcd] Implement workaround for Errata 15. This enable SOF when bulk-in endpoint is in use and reduce its bandwidth to only 80%
-  - [hcd] Fix shared irq slots filling up when hcd_init() is called multiple times
+  - [hcd] Fix shared irq slots filling up when ``hcd_init()`` is called multiple times
   - [hcd] Support host bulk endpoint using hw "interrupt" endpoint. Note speed limit is 64KB/s
 
 - [samd][dcd] Add support for ISO endpoint
@@ -412,12 +410,12 @@ Device Stack
 - [HID]
 
   - Add FIDO descriptor template
-  - change length in tud_hid_report_complete_cb() from uint8 to uint16
+  - change length in ``tud_hid_report_complete_cb()`` from ``uint8_t`` to ``uint16_t``
 
 - [CDC]
 
   - Fix autoflush for FIFO < MPS
-  - Fix tx fifo memory overflown when DTR is not set and tud_cdc_write() is called repeatedly with large enough data
+  - Fix tx fifo memory overflown when DTR is not set and ``tud_cdc_write()`` is called repeatedly with large enough data
 
 - [USBTMC] Fix packet size with highspeed
 
@@ -425,7 +423,7 @@ Host Stack
 ----------
 
 - Retry a few times with transfers in enumeration since device can be unstable when starting up
-- [MSC] Rework host masstorage API. Add new **host/msc_file_explorer** example
+- [MSC] Rework host masstorage API. Add new ``host/msc_file_explorer`` example
 - [CDC]
 
   - Add support for host cdc
@@ -435,22 +433,22 @@ Host Stack
 ======
 
 - Improve compiler support for CCRX and IAR
-- Add timeout to osal_queue_receive()
-- Add tud_task_ext(timeout, in_isr) as generic version of tud_task(). Same as tuh_task_ext(), tuh_task()
-- Enable more warnings -Wnull-dereference -Wuninitialized -Wunused -Wredundant-decls -Wconversion
+- Add timeout to ``osal_queue_receive()``
+- Add ``tud_task_ext(timeout, in_isr)`` as generic version of ``tud_task()``. Same as ``tuh_task_ext()``, ``tuh_task()``
+- Enable more warnings ``-Wnull-dereference -Wuninitialized -Wunused -Wredundant-decls -Wconversion``
 - Add new examples
 
-  - host/bare_api to demonstrate generic (app-level) enumeration and endpoint transfer
-  - dual/host_hid_to_device_cdc to run both device and host stack concurrently, get HID report from host and print out to device CDC. This example only work with multiple-controller MCUs and rp2040 with the help of pio-usb as added controller.
+  - ``host/bare_api`` to demonstrate generic (app-level) enumeration and endpoint transfer
+  - ``dual/host_hid_to_device_cdc`` to run both device and host stack concurrently, get HID report from host and print out to device CDC. This example only work with multiple-controller MCUs and rp2040 with the help of pio-usb as added controller.
 
 Controller Driver (DCD & HCD)
 -----------------------------
 
 - Enhance rhports management to better support dual roles
 
-  - CFG_TUD_ENABLED/CFG_TUH_ENABLED, CFG_TUD_MAX_SPEED/CFG_TUH_MAX_SPEED can be used to replace CFG_TUSB_RHPORT0_MODE/CFG_TUSB_RHPORT1_MODE
-  - tud_init(rphort), tuh_init(rhport) can be used to init stack on specified roothub port (controller) instead of tusb_init(void)
-- Add dcd/hcd port specific defines `TUP_` (stand for tinyusb port-specific)
+  - ``CFG_TUD_ENABLED``/``CFG_TUH_ENABLED``, ``CFG_TUD_MAX_SPEED``/``CFG_TUH_MAX_SPEED`` can be used to replace ``CFG_TUSB_RHPORT0_MODE``/``CFG_TUSB_RHPORT1_MODE``
+  - ``tud_init(rphort)``, ``tuh_init(rhport)`` can be used to init stack on specified roothub port (controller) instead of ``tusb_init(void)``
+- Add dcd/hcd port specific defines ``TUP_`` (stand for tinyusb port-specific)
 - [dwc2]
 
   - Update to support stm32 h72x, h73x with only 1 otg controller
@@ -471,10 +469,10 @@ Device Stack
 
 - [Audio] Add support for feedback endpoint computation
 
-  - New API tud_audio_feedback_params_cb(), tud_audio_feedback_interval_isr().
+  - New API ``tud_audio_feedback_params_cb()``, ``tud_audio_feedback_interval_isr()``.
   - Supported computation method are: frequency with fixed/float or power of 2. Feedback with fifo count is not yet supported.
-  - Fix nitfs (should be 3) in TUD_AUDIO_HEADSET_STEREO_DESCRIPTOR
-  - Fix typo in audiod_rx_done_cb()
+  - Fix nitfs (should be 3) in ``TUD_AUDIO_HEADSET_STEREO_DESCRIPTOR``
+  - Fix typo in ``audiod_rx_done_cb()``
 
 - [DFU] Fix coexistence with other interfaces BTH, RNDIS
 - [MSC] Fix inquiry response additional length field
@@ -483,23 +481,23 @@ Device Stack
 Host Stack
 ----------
 
-- Add new API tuh_configure(rhport, cfg_id, cfg_param) for dynamnic port specific behavior configuration
+- Add new API ``tuh_configure(rhport, cfg_id, cfg_param)`` for dynamnic port specific behavior configuration
 - [HID] Open OUT endpoint if available
 - [Hub] hub clear port and device interrupts
 - [USBH] Major improvement
 
-  - Rework usbh control transfer with complete callback. New API tuh_control_xfer() though still only carry 1 usbh (no queueing) at a time.
-  - Add generic endpoint transfer with tuh_edpt_open(), tuh_edpt_xfer(). Require `CFG_TUH_API_EDPT_XFER=1`
+  - Rework usbh control transfer with complete callback. New API ``tuh_control_xfer()`` though still only carry 1 usbh (no queueing) at a time.
+  - Add generic endpoint transfer with ``tuh_edpt_open()``, ``tuh_edpt_xfer()``. Require ``CFG_TUH_API_EDPT_XFER=1``
   - Support app-level enumeration with new APIs
 
-    - tuh_descriptor_get(), tuh_descriptor_get_device(), tuh_descriptor_get_configuration(), tuh_descriptor_get_hid_report()
-    - tuh_descriptor_get_string(), tuh_descriptor_get_manufacturer_string(), tuh_descriptor_get_product_string(), tuh_descriptor_get_serial_string()
-    - Also add _sync() as sync/blocking version for above APIs
+    - ``tuh_descriptor_get()``, ``tuh_descriptor_get_device()``, ``tuh_descriptor_get_configuration()``, ``tuh_descriptor_get_hid_report()``
+    - ``tuh_descriptor_get_string()``, ``tuh_descriptor_get_manufacturer_string()``, ``tuh_descriptor_get_product_string()``, ``tuh_descriptor_get_serial_string()``
+    - Also add ``_sync()`` as sync/blocking version for above APIs
 
 0.13.0
 ======
 
-- [tu_fifo] Fix locked mutex when full, and return type in peek_n()
+- [tu_fifo] Fix locked mutex when full, and return type in ``peek_n()``
 
 Controller Driver (DCD & HCD)
 -----------------------------
@@ -528,7 +526,7 @@ Device Stack
 ------------
 
 - [Audio] Support disabling feedback format correction (16.16 <-> 10.14 format)
-- [MSC] Add tud_msc_request_sense_cb() callback, change most default sense error to medium not present (0x02, 0x3A, 0x00)
+- [MSC] Add ``tud_msc_request_sense_cb()`` callback, change most default sense error to medium not present (0x02, 0x3A, 0x00)
 - [Video] Fix video_capture example fails enumeration when 8FPS
 
 Host Stack
@@ -539,22 +537,22 @@ No notable changes
 0.12.0
 ======
 
-- add CFG_TUSB_OS_INC_PATH for os include path
+- add ``CFG_TUSB_OS_INC_PATH`` for os include path
 
 Device Controller Driver (DCD)
 ------------------------------
 
 - Getting device stack to pass USB Compliance Verification test (chapter9, HID, MSC). Ports are tested:
   nRF, SAMD 21/51, rp2040, stm32f4, Renesas RX, iMXRT, ESP32-S2/3, Kinetic KL25/32, DA146xx
-- Added dcd_edpt_close_all() for switching configuration
-- [Transdimension] Support dcd_edpt_xfer_fifo() with auto wrap over if fifo buffer is 4K aligned and size is multiple of 4K.
+- Added ``dcd_edpt_close_all()`` for switching configuration
+- [Transdimension] Support ``dcd_edpt_xfer_fifo()`` with auto wrap over if fifo buffer is 4K aligned and size is multiple of 4K.
 - [DA146xx] Improve vbus, reset, suspend, resume detection, and remote wakeup.
 
 Device Stack
 ------------
 
-- Add new network driver Network Control Model (CDC-NCM), update net_lwip_webserver to work with NCM (need re-configure example)
-- Add new USB Video Class UVC 1.5 driver and video_capture example ((work in progress)
+- Add new network driver Network Control Model (CDC-NCM), update ``net_lwip_webserver`` to work with NCM (need re-configure example)
+- Add new USB Video Class UVC 1.5 driver and video_capture example (work in progress)
 - Fix potential buffer overflow for HID, bluetooth drivers
 
 Host Controller Driver (HCD)
@@ -591,13 +589,13 @@ Synopsys
 ^^^^^^^^
 
 - Fix Synopsys set address bug which could cause re-enumeration failed
-- Fix dcd_synopsys driver integer overflow in HS mode (issue #968)
+- Fix ``dcd_synopsys`` driver integer overflow in HS mode (issue #968)
 
 nRF5x
 ^^^^^
 
 - Add nRF5x suspend, resume and remote wakeup
-- Fix nRF5x race condition with TASKS_EP0RCVOUT
+- Fix nRF5x race condition with ``TASKS_EP0RCVOUT``
 
 RP2040
 ^^^^^^
@@ -612,8 +610,8 @@ USBD
 ^^^^
 
 - Better support big endian mcu
-- Add tuh_inited() and tud_inited(), will separate tusb_init/inited() to tud/tuh init/inited
-- Add dcd_attr.h for defining common controller attribute such as max endpoints
+- Add ``tuh_inited()`` and ``tud_inited()``, will separate ``tusb_init/inited()`` to ``tud/tuh_init/inited()``
+- Add ``dcd_attr.h`` for defining common controller attribute such as max endpoints
 
 Bluetooth
 ^^^^^^^^^
@@ -623,8 +621,8 @@ Bluetooth
 DFU
 ^^^
 
-- Enhance DFU implementation to support multiple alternate interface and better support bwPollTimeout
-- Rename CFG_TUD_DFU_MODE to simply CFG_TUD_DFU
+- Enhance DFU implementation to support multiple alternate interface and better support ``bwPollTimeout``
+- Rename ``CFG_TUD_DFU_MODE`` to simply ``CFG_TUD_DFU``
 
 HID
 ^^^
@@ -649,7 +647,7 @@ Vendor
 ^^^^^^
 
 - Fix vendor fifo deadlock in certain case
-- Add tud_vendor_n_read_flush
+- Add ``tud_vendor_n_read_flush()``
 
 Host Controller Driver (HCD)
 ----------------------------
@@ -666,7 +664,7 @@ Host Stack
 - Major update and rework most of host stack, still needs more improvement
 - Lots of improvement and update in parsing configuration and control
 - Rework and major update to HID driver. Will default to enable boot interface if available
-- Separate CFG_TUH_DEVICE_MAX and CFG_TUH_HUB for better management and reduce SRAM usage
+- Separate ``CFG_TUH_DEVICE_MAX`` and ``CFG_TUH_HUB`` for better management and reduce SRAM usage
 
 0.10.1 (2021-06-03)
 ===================
@@ -678,9 +676,9 @@ Host Controller Driver (HCD)
 
 - Fix rp2040 host driver: incorrect PID with low speed device with max packet size of 8 bytes
 - Improve hub driver
-- Remove obsolete hcd_pipe_queue_xfer()/hcd_pipe_xfer()
-- Use hcd_frame_number() instead of micro frame
-- Fix OHCI endpoint address and xferred_bytes in xfer complete event
+- Remove obsolete ``hcd_pipe_queue_xfer()``/``hcd_pipe_xfer()``
+- Use ``hcd_frame_number()`` instead of micro frame
+- Fix OHCI endpoint address and ``xferred_bytes`` in xfer complete event
 
 0.10.0 (2021-05-28)
 ===================
@@ -699,7 +697,7 @@ Device Controller Driver (DCD)
 - Fix build with nRF5340
 - Fix build with lpc15 and lpc54
 - Fix build with lpc177x_8x
-- STM32 Synopsys: greatly improve Isochronous transfer with edpt_xfer_fifo API
+- STM32 Synopsys: greatly improve Isochronous transfer with ``edpt_xfer_fifo()`` API
 - Support LPC55 port1 highspeed
 - Add support for Espressif esp32s3
 - nRF: fix race condition that could cause drop packet of Bulk OUT transfer
@@ -707,14 +705,14 @@ Device Controller Driver (DCD)
 USB Device Driver (USBD)
 ------------------------
 
-- Add new (optional) endpoint ADPI usbd_edpt_xfer_fifo
+- Add new (optional) endpoint ADPI ``usbd_edpt_xfer_fifo()``
 
 Device Class Driver
 -------------------
 
 CDC
 
-- [Breaking] tud_cdc_peek(), tud_vendor_peek() no longer support random offset and dropped position parameter.
+- [Breaking] ``tud_cdc_peek()``, ``tud_vendor_peek()`` no longer support random offset and dropped position parameter.
 
 DFU
 
@@ -726,19 +724,19 @@ HID
 - Add more hid keys constant from 0x6B to 0xA4
 
 - [Breaking] rename API
-  - HID_PROTOCOL_NONE/KEYBOARD/MOUST to HID_ITF_PROTOCOL_NONE/KEYBOARD/MOUSE
-  - tud_hid_boot_mode() to tud_hid_get_protocol()
-  - tud_hid_boot_mode_cb() to tud_hid_set_protocol_cb()
+  - ``HID_PROTOCOL_NONE/KEYBOARD/MOUSE`` to ``HID_ITF_PROTOCOL_NONE/KEYBOARD/MOUSE``
+  - ``tud_hid_boot_mode()`` to ``tud_hid_get_protocol()``
+  - ``tud_hid_boot_mode_cb()`` to ``tud_hid_set_protocol_cb()``
 
 MIDI
 
 - Fix MIDI buffer overflow issue
 
 - [Breaking] rename API
-  - Rename tud_midi_read() to tud_midi_stream_read()
-  - Rename tud_midi_write() to tud_midi_stream_write()
-  - Rename tud_midi_receive() to tud_midi_packet_read()
-  - Rename tud_midi_send() to tud_midi_packet_write()
+  - Rename ``tud_midi_read()`` to ``tud_midi_stream_read()``
+  - Rename ``tud_midi_write()`` to ``tud_midi_stream_write()``
+  - Rename ``tud_midi_receive()`` to ``tud_midi_packet_read()``
+  - Rename ``tud_midi_send()`` to ``tud_midi_packet_write()``
 
 Host Controller Driver (HCD)
 ----------------------------
@@ -785,7 +783,7 @@ NXP Transdimention
 USB Device Driver (USBD)
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-- Fix issue with status zlp (tud_control_status) is returned by class driver with SET/CLEAR_FEATURE for endpoint.
+- Fix issue with status zlp (``tud_control_status()``) is returned by class driver with SET/CLEAR_FEATURE for endpoint.
 - Correct endpoint size check for fullspeed bulk, can be 8, 16, 32, 64
 - Ack SET_INTERFACE even if it is not implemented by class driver.
 
@@ -794,34 +792,34 @@ Device Class Driver
 
 DFU Runtime
 
-- rename dfu_rt to dfu_runtime for easy reading
+- rename ``dfu_rt()`` to ``dfu_runtime()`` for easy reading
 
 CDC
 
-- Add tud_cdc_send_break_cb() to support break request
-- Improve CDC receive, minor behavior changes: when tud_cdc_rx_wanted_cb() is invoked wanted_char may not be the last byte in the fifo
+- Add ``tud_cdc_send_break_cb()`` to support break request
+- Improve CDC receive, minor behavior changes: when ``tud_cdc_rx_wanted_cb()`` is invoked wanted_char may not be the last byte in the fifo
 
 HID
 
 - [Breaking] Add itf argument to hid API to support multiple instances, follow API has signature changes
 
-  - tud_hid_descriptor_report_cb()
-  - tud_hid_get_report_cb()
-  - tud_hid_set_report_cb()
-  - tud_hid_boot_mode_cb()
-  - tud_hid_set_idle_cb()
+  - ``tud_hid_descriptor_report_cb()``
+  - ``tud_hid_get_report_cb()``
+  - ``tud_hid_set_report_cb()``
+  - ``tud_hid_boot_mode_cb()``
+  - ``tud_hid_set_idle_cb()``
 
-- Add report complete callback tud_hid_report_complete_cb() API
+- Add report complete callback ``tud_hid_report_complete_cb()`` API
 - Add DPad/Hat support for HID Gamepad
 
-  - `TUD_HID_REPORT_DESC_GAMEPAD()` now support 16 buttons, 2 joysticks, 1 hat/dpad
-  - Add hid_gamepad_report_t along with `GAMEPAD_BUTTON_` and `GAMEPAD_HAT_` enum
-  - Add Gamepad to hid_composite / hid_composite_freertos example
+  - ``TUD_HID_REPORT_DESC_GAMEPAD()`` now support 16 buttons, 2 joysticks, 1 hat/dpad
+  - Add ``hid_gamepad_report_t`` along with ``GAMEPAD_BUTTON_`` and ``GAMEPAD_HAT_`` enum
+  - Add Gamepad to ``hid_composite`` / ``hid_composite_freertos`` example
 
 MIDI
 
 - Fix dropping MIDI sysex message when fifo is full
-- Fix typo in tud_midi_write24(), make example less ambiguous for cable and channel
+- Fix typo in ``tud_midi_write24()``, make example less ambiguous for cable and channel
 - Fix incorrect endpoint descriptor length, MIDI v1 use Audio v1 which has 9-byte endpoint descriptor (instead of 7)
 
 Host Stack
@@ -830,14 +828,14 @@ Host Stack
 Host Controller Driver (HCD)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- Add rhport to hcd_init()
+- Add rhport to ``hcd_init()``
 - Improve EHCI/OHCI driver abstraction
 
   - Move echi/ohci files to portable/
-  - Rename hcd_lpc18_43 to hcd_transdimension
-  - Sub hcd API with hcd_ehci_init(), hcd_ehci_register_addr()
+  - Rename ``hcd_lpc18_43`` to ``hcd_transdimension``
+  - Sub hcd API with ``hcd_ehci_init()``, ``hcd_ehci_register_addr()``
 
-- Update NXP transdimention hcd_init() to reset controller to host mode
+- Update NXP transdimension ``hcd_init()`` to reset controller to host mode
 
   - Ported hcd to rt10xx
 
@@ -851,20 +849,20 @@ Host Class Driver
 
 MSC
 
-- Rename tuh_msc_scsi_inquiry() to tuh_msc_inquiry()
-- Rename tuh_msc_mounted_cb/tuh_msc_unmounted_cb to tuh_msc_mount_cb/tuh_msc_unmount_cb to match device stack naming
-- Change tuh_msc_is_busy() to tuh_msc_ready()
-- Add read10 and write10 function: tuh_msc_read10(), tuh_msc_write10()
+- Rename ``tuh_msc_scsi_inquiry()`` to ``tuh_msc_inquiry()``
+- Rename ``tuh_msc_mounted_cb()``/``tuh_msc_unmounted_cb()`` to ``tuh_msc_mount_cb()``/``tuh_msc_unmount_cb()`` to match device stack naming
+- Change ``tuh_msc_is_busy()`` to ``tuh_msc_ready()``
+- Add read10 and write10 function: ``tuh_msc_read10()``, ``tuh_msc_write10()``
 - Read_Capacity is invoked as part of enumeration process
-- Add tuh_msc_get_block_count(), tuh_msc_get_block_size()
-- Add CFG_TUH_MSC_MAXLUN (default to 4) to hold lun capacities
+- Add ``tuh_msc_get_block_count()``, ``tuh_msc_get_block_size()``
+- Add ``CFG_TUH_MSC_MAXLUN`` (default to 4) to hold lun capacities
 
 Others
 ------
 
 - Add basic support for rt-thread OS
 - Change zero bitfield length to more explicit padding
-- Build example now fetch required submodules on the fly while running `make` without prio submodule init for mcu drivers
+- Build example now fetch required submodules on the fly while running ``make`` without prior submodule init for mcu drivers
 - Update pico-sdk to v1.1.0
 
 **New Boards**
@@ -882,7 +880,7 @@ Device Controller Driver
 
 - Added new device support for Raspberry Pi RP2040
 - Added new device support for NXP Kinetis KL25ZXX
-- Use dcd_event_bus_reset() with link speed to replace bus_signal
+- Use ``dcd_event_bus_reset()`` with link speed to replace bus_signal
 
 - ESP32-S2:
   - Add bus suspend and wakeup support
@@ -904,8 +902,8 @@ USB Device
 **USBD**
 
 - Rework usbd control transfer to have additional stage parameter for setup, data, status
-- Fix tusb_init() return true instead of TUSB_ERROR_NONE
-- Added new API tud_connected() that return true after device got out of bus reset and received the very first setup packet
+- Fix ``tusb_init()`` return true instead of ``TUSB_ERROR_NONE``
+- Added new API ``tud_connected()`` that return true after device got out of bus reset and received the very first setup packet
 
 **Class Driver**
 
@@ -913,22 +911,22 @@ USB Device
   - Allow to transmit data, even if the host does not support control line states i.e set DTR
 
 - HID
-  - change default CFG_TUD_HID_EP_BUFSIZE from 16 to 64
+  - change default ``CFG_TUD_HID_EP_BUFSIZE`` from 16 to 64
 
 - MIDI
   - Fix midi sysex sending bug
 
 - MSC
   - Invoke only scsi complete callback after status transaction is complete.
-  - Fix scsi_mode_sense6_t padding, which cause IAR compiler internal error.
+  - Fix ``scsi_mode_sense6_t`` padding, which cause IAR compiler internal error.
 
 - USBTMC
   - Change interrupt endpoint example size to 8 instead of 2 for better compatibility with mcu
 
 **Example**
 
-- Support make from windows cmd.exe
-- Add HID Consumer Control (media keys) to hid_composite & hid_composite_freertos examples
+- Support make from windows ``cmd.exe``
+- Add HID Consumer Control (media keys) to ``hid_composite`` & ``hid_composite_freertos`` examples
 
 
 USB Host
@@ -969,28 +967,28 @@ Device Controller Driver
   - Support multiple usb ports with rhport=1 is highspeed on selected MCUs e.g H743, F23. It is possible to have OTG_HS to run on Fullspeed PHY (e.g lacking external PHY)
   - Add ISO transfer, fix odd/even frame
   - Fix FIFO flush during stall
-  - Implement dcd_edpt_close() API
+  - Implement ``dcd_edpt_close()`` API
   - Support F105, F107
 
 - Enhance STM32 fsdev
   - Improve dcd fifo allocation
   - Fix ISTR race condition
   - Support remap USB IRQ on supported MCUs
-  - Implement dcd_edpt_close() API
+  - Implement ``dcd_edpt_close()`` API
 
 - Enhance NUC 505: enhance set configure behavior
 
 - Enhance SAMD
   - Fix race condition with setup packet
-  - Add SAMD11 option `OPT_MCU_SAMD11`
-  - Add SAME5x option `OPT_MCU_SAME5X`
+  - Add SAMD11 option ``OPT_MCU_SAMD11``
+  - Add SAME5x option ``OPT_MCU_SAME5X``
 
 - Fix SAMG control data toggle and stall race condition
 
 - Enhance nRF
-  - Fix hanged when tud_task() is called within critical section (disabled interrupt)
+  - Fix hanged when ``tud_task()`` is called within critical section (disabled interrupt)
   - Fix disconnect bus event not submitted
-  - Implement ISO transfer and dcd_edpt_close()
+  - Implement ISO transfer and ``dcd_edpt_close()``
 
 
 USB Device
@@ -999,26 +997,26 @@ USB Device
 **USBD**
 
 - Add new class driver for **Bluetooth HCI** class driver with example can be found in [mynewt-tinyusb-example](https://github.com/hathach/mynewt-tinyusb-example) since it needs mynewt OS to run with.
-- Fix USBD endpoint usage racing condition with `usbd_edpt_claim()/usbd_edpt_release()`
-- Added `tud_task_event_ready()` and `osal_queue_empty()`. This API is needed to check before enter low power mode with WFI/WFE
-- Rename USB IRQ Handler to `dcd_int_handler()`. Application must define IRQ handler in which it calls this API.
-- Add `dcd_connect()` and `dcd_disconnect()` to enable/disable internal pullup on D+/D- on supported MCUs.
-- Add `usbd_edpt_open()`
-- Remove `dcd_set_config()`
-- Add *OPT_OS_CUMSTOM* as hook for application to overwrite and/or add their own OS implementation
+- Fix USBD endpoint usage racing condition with ``usbd_edpt_claim()``/``usbd_edpt_release()``
+- Added ``tud_task_event_ready()`` and ``osal_queue_empty()``. This API is needed to check before enter low power mode with WFI/WFE
+- Rename USB IRQ Handler to ``dcd_int_handler()``. Application must define IRQ handler in which it calls this API.
+- Add ``dcd_connect()`` and ``dcd_disconnect()`` to enable/disable internal pullup on D+/D- on supported MCUs.
+- Add ``usbd_edpt_open()``
+- Remove ``dcd_set_config()``
+- Add ``OPT_OS_CUMSTOM`` as hook for application to overwrite and/or add their own OS implementation
 - Support SET_INTERFACE, GET_INTERFACE request
-- Add Logging for debug with optional uart/rtt/swo printf retarget or `CFG_TUSB_DEBUG_PRINTF` hook
+- Add Logging for debug with optional uart/rtt/swo printf retarget or ``CFG_TUSB_DEBUG_PRINTF`` hook
 - Add IAR compiler support
-- Support multiple configuration descriptors. `TUD_CONFIG_DESCRIPTOR()` template has extra config_num as 1st argument
-- Improve USB Highspeed support with actual link speed detection with `dcd_event_bus_reset()`
+- Support multiple configuration descriptors. ``TUD_CONFIG_DESCRIPTOR()`` template has extra config_num as 1st argument
+- Improve USB Highspeed support with actual link speed detection with ``dcd_event_bus_reset()``
 
 - Enhance class driver management
-  - `usbd_driver_open()` add max length argument, and return length of interface (0 for not supported). Return value is used for finding appropriate driver
-  - Add application implemented class driver via `usbd_app_driver_get_cb()`
+  - ``usbd_driver_open()`` add max length argument, and return length of interface (0 for not supported). Return value is used for finding appropriate driver
+  - Add application implemented class driver via ``usbd_app_driver_get_cb()``
   - IAD is handled to assign driver id
 
-- Added `tud_descriptor_device_qualifier_cb()` callback
-- Optimize `tu_fifo` bulk write/read transfer
+- Added ``tud_descriptor_device_qualifier_cb()`` callback
+- Optimize ``tu_fifo`` bulk write/read transfer
 - Forward non-std control request to class driver
 - Let application handle Microsoft OS 1.0 Descriptors (the 0xEE index string)
 - Fix OSAL FreeRTOS yield from ISR
@@ -1030,8 +1028,8 @@ USB Device
 
 - CDC:
   - Send zero length packet for end of data when needed
-  - Add `tud_cdc_tx_complete_cb()` callback
-  - Change tud_cdc_n_write_flush() return number of bytes forced to transfer, and flush when writing enough data to fifo
+  - Add ``tud_cdc_tx_complete_cb()`` callback
+  - Change ``tud_cdc_n_write_flush()`` return number of bytes forced to transfer, and flush when writing enough data to fifo
 
 - MIDI:
   - Add packet interface
@@ -1041,10 +1039,10 @@ USB Device
 - DFU Runtime: fix response to SET_INTERFACE and DFU_GETSTATUS request
 
 - Rename some configure macro to make it clear that those are used directly for endpoint transfer
-  - CFG_TUD_HID_BUFSIZE to CFG_TUD_HID_EP_BUFSIZE
-  - CFG_TUD_CDC_EPSIZE to CFG_TUD_CDC_EP_BUFSIZE
-  - CFG_TUD_MSC_BUFSIZE to CFG_TUD_MSC_EP_BUFSIZE
-  - CFG_TUD_MIDI_EPSIZE to CFG_TUD_MIDI_EP_BUFSIZE
+  - ``CFG_TUD_HID_BUFSIZE`` to ``CFG_TUD_HID_EP_BUFSIZE``
+  - ``CFG_TUD_CDC_EPSIZE`` to ``CFG_TUD_CDC_EP_BUFSIZE``
+  - ``CFG_TUD_MSC_BUFSIZE`` to ``CFG_TUD_MSC_EP_BUFSIZE``
+  - ``CFG_TUD_MIDI_EPSIZE`` to ``CFG_TUD_MIDI_EP_BUFSIZE``
 
 - HID:
   - Fix gamepad template descriptor
@@ -1063,15 +1061,15 @@ USB Host
 Examples
 --------
 
-- Add new hid_composite_freertos
-- Add new dynamic_configuration to demonstrate how to switch configuration descriptors
-- Add new hid_multiple_interface
+- Add new ``hid_composite_freertos``
+- Add new ``dynamic_configuration`` to demonstrate how to switch configuration descriptors
+- Add new ``hid_multiple_interface``
 
-- Enhance `net_lwip_webserver` example
+- Enhance ``net_lwip_webserver`` example
   - Add multiple configuration: RNDIS for Windows, CDC-ECM for macOS (Linux will work with both)
-  - Update lwip to STABLE-2_1_2_RELEASE for net_lwip_webserver
+  - Update lwip to STABLE-2_1_2_RELEASE for ``net_lwip_webserver``
 
-- Added new Audio example: audio_test uac2_headsest
+- Added new Audio example: ``audio_test`` ``uac2_headsest``
 
 New Boards
 ----------
@@ -1112,37 +1110,37 @@ Added
 - Added multiple instances support for CDC and MIDI
 - Added a handful of unit test with Ceedling.
 - Added LOG support for debugging with CFG_TUSB_DEBUG
-- Added `tud_descriptor_bos_cb()` for BOS descriptor (required for USB 2.1)
-- Added `dcd_edpt0_status_complete()` as optional API for DCD
+- Added ``tud_descriptor_bos_cb()`` for BOS descriptor (required for USB 2.1)
+- Added ``dcd_edpt0_status_complete()`` as optional API for DCD
 
 **Examples**
 
 Following examples are added:
 
-- board_test
-- cdc_dual_ports
-- dfu_rt
-- hid_composite
-- net_lwip_webserver
-- usbtmc
-- webusb_serial
+- ``board_test``
+- ``cdc_dual_ports``
+- ``dfu_rt``
+- ``hid_composite``
+- ``net_lwip_webserver``
+- ``usbtmc``
+- ``webusb_serial``
 
 Changed
 -------
 
-- Changed `tud_descriptor_string_cb()` to have additional Language ID argument
-- Merged hal_nrf5x.c into dcd_nrf5x.c
-- Merged dcd_samd21.c and dcd_samd51.c into dcd_samd.c
-- Generalized dcd_stm32f4.c to dcd_synopsys.c
-- Changed cdc_msc_hid to cdc_msc (drop hid) due to limited endpoints number of some MCUs
+- Changed ``tud_descriptor_string_cb()`` to have additional Language ID argument
+- Merged ``hal_nrf5x.c`` into ``dcd_nrf5x.c``
+- Merged ``dcd_samd21.c`` and ``dcd_samd51.c`` into ``dcd_samd.c``
+- Generalized ``dcd_stm32f4.c`` to ``dcd_synopsys.c``
+- Changed ``cdc_msc_hid`` to ``cdc_msc`` (drop hid) due to limited endpoints number of some MCUs
 - Improved DCD SAMD stability, fix missing setup packet occasionally
-- Improved usbd/usbd_control with proper handling of zero-length packet (ZLP)
+- Improved ``usbd/usbd_control`` with proper handling of zero-length packet (ZLP)
 - Improved STM32 DCD FSDev
 - Improved STM32 DCD Synopsys
 - Migrated CI from Travis to Github Action
 - Updated nrfx submodule to 2.1.0
 - Fixed mynewt osal queue definition
-- Fixed cdc_msc_freertos example build for all MCUs
+- Fixed ``cdc_msc_freertos`` example build for all MCUs
 
 
 0.5.0 (2019-06)

docs/info/contributors.rst

@@ -1 +0,0 @@
-../../CONTRIBUTORS.rst

docs/info/contributors.rst

@@ -0,0 +1 @@
+.. include:: ../../CONTRIBUTORS.rst

docs/info/index.rst

@@ -8,6 +8,5 @@ Index
 .. toctree::
    :maxdepth: 2
 
-   uses
    changelog
    contributors

docs/info/uses.rst

@@ -1,17 +0,0 @@
-****
-Uses
-****
-
-TinyUSB is currently used by these other projects:
-
--  `Adafruit nRF52 Arduino <https://github.com/adafruit/Adafruit_nRF52_Arduino>`__
--  `Adafruit nRF52 Bootloader <https://github.com/adafruit/Adafruit_nRF52_Bootloader>`__
--  `Adafruit SAMD Arduino <https://github.com/adafruit/ArduinoCore-samd>`__
--  `CircuitPython <https://github.com/adafruit/circuitpython>`__
--  `Espressif IDF <https://github.com/espressif/esp-idf>`__
--  `MicroPython <https://github.com/micropython/micropython>`__
--  `mynewt <https://mynewt.apache.org>`__
--  `openinput <https://github.com/openinput-fw/openinput>`__
--  `Raspberry Pi Pico SDK <https://github.com/raspberrypi/pico-sdk>`__
--  `TinyUF2 Bootloader <https://github.com/adafruit/tinyuf2>`__
--  `TinyUSB Arduino Library <https://github.com/adafruit/Adafruit_TinyUSB_Arduino>`__

docs/reference/boards.rst

@@ -0,0 +1,320 @@
+****************
+Supported Boards
+****************
+
+The board support code is only used for self-contained examples and testing. It is not used when TinyUSB is part of a larger project.
+It is responsible for getting the MCU started and the USB peripheral clocked with minimal of on-board devices
+
+-  One LED : for status
+-  One Button : to get input from user
+-  One UART : optional for device, but required for host examples
+
+Following boards are supported
+
+Analog Devices
+--------------
+
+=============  ================  ========  ===========================================================================================================================  ======
+Board          Name              Family    URL                                                                                                                          Note
+=============  ================  ========  ===========================================================================================================================  ======
+max32650evkit  MAX32650 EVKIT    max32650  https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max32650-evkit.html#eb-overview
+max32650fthr   MAX32650 Feather  max32650  https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max32650fthr.html
+max32651evkit  MAX32651 EVKIT    max32650  https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max32651-evkit.html
+max32666evkit  MAX32666 EVKIT    max32666  https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max32666evkit.html
+max32666fthr   MAX32666 Feather  max32666  https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max32666fthr.html
+apard32690     APARD32690-SL     max32690  https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html
+max32690evkit  MAX32690 EVKIT    max32690  https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max32690evkit.html
+max78002evkit  MAX78002 EVKIT    max78002  https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html
+=============  ================  ========  ===========================================================================================================================  ======
+
+Bridgetek
+---------
+
+=========  =========  ========  =====================================  ======
+Board      Name       Family    URL                                    Note
+=========  =========  ========  =====================================  ======
+mm900evxb  MM900EVxB  brtmm90x  https://brtchip.com/product/mm900ev1b
+=========  =========  ========  =====================================  ======
+
+Espressif
+---------
+
+=========================  ==============================  =========  ========================================================================================================  ======
+Board                      Name                            Family     URL                                                                                                       Note
+=========================  ==============================  =========  ========================================================================================================  ======
+adafruit_feather_esp32_v2  Adafruit Feather ESP32 v2       espressif  https://www.adafruit.com/product/5400
+adafruit_feather_esp32s2   Adafruit Feather ESP32S2        espressif  https://www.adafruit.com/product/5000
+adafruit_feather_esp32s3   Adafruit Feather ESP32S3        espressif  https://www.adafruit.com/product/5323
+adafruit_magtag_29gray     Adafruit MagTag 2.9" Grayscale  espressif  https://www.adafruit.com/product/4800
+adafruit_metro_esp32s2     Adafruit Metro ESP32-S2         espressif  https://www.adafruit.com/product/4775
+espressif_addax_1          Espresif Addax-1                espressif  n/a
+espressif_c3_devkitc       Espresif C3 DevKitC             espressif  https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c3/esp32-c3-devkitc-02/index.html
+espressif_c6_devkitc       Espresif C6 DevKitC             espressif  https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c6/esp32-c6-devkitc-1/index.html
+espressif_kaluga_1         Espresif Kaluga 1               espressif  https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/esp32-s2-kaluga-1/index.html
+espressif_p4_function_ev   Espresif P4 Function EV         espressif  https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32p4/esp32-p4-function-ev-board/index.html
+espressif_s2_devkitc       Espresif S2 DevKitC             espressif  https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/esp32-s2-devkitc-1/index.html
+espressif_s3_devkitc       Espresif S3 DevKitC             espressif  https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s3/esp32-s3-devkitc-1/index.html
+espressif_s3_devkitm       Espresif S3 DevKitM             espressif  https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s3/esp32-s3-devkitm-1/index.html
+espressif_saola_1          Espresif S2 Saola 1             espressif  https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s2/esp32-s2-saola-1/index.html
+=========================  ==============================  =========  ========================================================================================================  ======
+
+GigaDevice
+----------
+
+==================  ==================  =========  =============================  ======
+Board               Name                Family     URL                            Note
+==================  ==================  =========  =============================  ======
+sipeed_longan_nano  Sipeed Longan Nano  gd32vf103  https://longan.sipeed.com/en/
+==================  ==================  =========  =============================  ======
+
+Infineon
+--------
+
+=============  =================  ========  =============================================================================  ======
+Board          Name               Family    URL                                                                            Note
+=============  =================  ========  =============================================================================  ======
+xmc4500_relax  XMC4500 relax kit  xmc4000   https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc45_relax_v1/
+xmc4700_relax  XMC4700 relax kit  xmc4000   https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_v1/
+=============  =================  ========  =============================================================================  ======
+
+Microchip
+---------
+
+=========================  ===================================  ==========  =================================================================================  ======
+Board                      Name                                 Family      URL                                                                                Note
+=========================  ===================================  ==========  =================================================================================  ======
+olimex_emz64               Olimex PIC32-EMZ64                   pic32mz     https://www.olimex.com/Products/PIC/Development/PIC32-EMZ64/open-source-hardware
+olimex_hmz144              Olimex PIC32-HMZ144                  pic32mz     https://www.olimex.com/Products/PIC/Development/PIC32-HMZ144/open-source-hardware
+cynthion_d11               Great Scott Gadgets Cynthion         samd11      https://greatscottgadgets.com/cynthion/
+samd11_xplained            SAMD11 Xplained Pro                  samd11      https://www.microchip.com/en-us/development-tool/ATSAMD11-XPRO
+atsamd21_xpro              SAMD21 Xplained Pro                  samd21      https://www.microchip.com/DevelopmentTools/ProductDetails/ATSAMD21-XPRO
+circuitplayground_express  Adafruit Circuit Playground Express  samd21      https://www.adafruit.com/product/3333
+curiosity_nano             SAMD21 Curiosty Nano                 samd21      https://www.microchip.com/en-us/development-tool/dm320119
+cynthion_d21               Great Scott Gadgets Cynthion         samd21      https://greatscottgadgets.com/cynthion/
+feather_m0_express         Adafruit Feather M0 Express          samd21      https://www.adafruit.com/product/3403
+itsybitsy_m0               Adafruit ItsyBitsy M0                samd21      https://www.adafruit.com/product/3727
+metro_m0_express           Adafruit Metro M0 Express            samd21      https://www.adafruit.com/product/3505
+qtpy                       Adafruit QT Py                       samd21      https://www.adafruit.com/product/4600
+seeeduino_xiao             Seeeduino XIAO                       samd21      https://wiki.seeedstudio.com/Seeeduino-XIAO/
+sparkfun_samd21_mini_usb   SparkFun SAMD21 Mini                 samd21      https://www.sparkfun.com/products/13664
+trinket_m0                 Adafruit Trinket M0                  samd21      https://www.adafruit.com/product/3500
+d5035_01                   D5035-01                             samd5x_e5x  https://github.com/RudolphRiedel/USB_CAN-FD
+feather_m4_express         Adafruit Feather M4 Express          samd5x_e5x  https://www.adafruit.com/product/3857
+itsybitsy_m4               Adafruit ItsyBitsy M4                samd5x_e5x  https://www.adafruit.com/product/3800
+metro_m4_express           Adafruit Metro M4 Express            samd5x_e5x  https://www.adafruit.com/product/3382
+pybadge                    Adafruit PyBadge                     samd5x_e5x  https://www.adafruit.com/product/4200
+pyportal                   Adafruit PyPortal                    samd5x_e5x  https://www.adafruit.com/product/4116
+same54_xplained            SAME54 Xplained Pro                  samd5x_e5x  https://www.microchip.com/DevelopmentTools/ProductDetails/ATSAME54-XPRO
+samg55_xplained            SAMG55 Xplained Pro                  samg        https://www.microchip.com/DevelopmentTools/ProductDetails/ATSAMG55-XPRO
+atsaml21_xpro              SAML21 Xplained Pro                  saml2x      https://www.microchip.com/en-us/development-tool/atsaml21-xpro-b
+saml22_feather             SAML22 Feather                       saml2x      https://github.com/joeycastillo/Feather-Projects/tree/main/SAML22%20Feather
+sensorwatch_m0             SensorWatch                          saml2x      https://github.com/joeycastillo/Sensor-Watch
+=========================  ===================================  ==========  =================================================================================  ======
+
+MindMotion
+----------
+
+=====================  ======================================  ========  ===============================================================================================  ======
+Board                  Name                                    Family    URL                                                                                              Note
+=====================  ======================================  ========  ===============================================================================================  ======
+mm32f327x_mb39         MM32F3273G9P MB-039                     mm32      https://www.mindmotion.com.cn/support/development_tools/evaluation_boards/evboard/mm32f3273g9p/
+mm32f327x_pitaya_lite  DshanMCU Pitaya Lite with MM32F3273G8P  mm32      https://gitee.com/weidongshan/DshanMCU-Pitaya-c
+=====================  ======================================  ========  ===============================================================================================  ======
+
+NXP
+---
+
+==================  =========================================  =============  =========================================================================================================================================================================  ======
+Board               Name                                       Family         URL                                                                                                                                                                        Note
+==================  =========================================  =============  =========================================================================================================================================================================  ======
+metro_m7_1011       Adafruit Metro M7 1011                     imxrt          https://www.adafruit.com/product/5600
+metro_m7_1011_sd    Adafruit Metro M7 1011 SD                  imxrt          https://www.adafruit.com/product/5600
+mimxrt1010_evk      i.MX RT1010 Evaluation Kit                 imxrt          https://www.nxp.com/design/design-center/development-boards-and-designs/i-mx-evaluation-and-development-boards/i-mx-rt1010-evaluation-kit:MIMXRT1010-EVK
+mimxrt1015_evk      i.MX RT1015 Evaluation Kit                 imxrt          https://www.nxp.com/design/design-center/development-boards-and-designs/MIMXRT1015-EVK
+mimxrt1020_evk      i.MX RT1020 Evaluation Kit                 imxrt          https://www.nxp.com/design/design-center/development-boards-and-designs/MIMXRT1020-EVK
+mimxrt1024_evk      i.MX RT1024 Evaluation Kit                 imxrt          https://www.nxp.com/design/design-center/development-boards-and-designs/i-mx-evaluation-and-development-boards/i-mx-rt1024-evaluation-kit:MIMXRT1024-EVK
+mimxrt1050_evkb     i.MX RT1050 Evaluation Kit revB            imxrt          https://www.nxp.com/part/IMXRT1050-EVKB
+mimxrt1060_evk      i.MX RT1060 Evaluation Kit revB            imxrt          https://www.nxp.com/design/design-center/development-boards-and-designs/MIMXRT1060-EVKB
+mimxrt1064_evk      i.MX RT1064 Evaluation Kit                 imxrt          https://www.nxp.com/design/design-center/development-boards-and-designs/MIMXRT1064-EVK
+mimxrt1170_evkb     i.MX RT1070 Evaluation Kit                 imxrt          https://www.nxp.com/design/design-center/development-boards-and-designs/i-mx-evaluation-and-development-boards/i-mx-rt1170-evaluation-kit:MIMXRT1170-EVKB
+teensy_40           Teensy 4.0                                 imxrt          https://www.pjrc.com/store/teensy40.html
+teensy_41           Teensy 4.1                                 imxrt          https://www.pjrc.com/store/teensy41.html
+frdm_k64f           Freedom K64F                               kinetis_k      https://www.nxp.com/design/design-center/development-boards-and-designs/general-purpose-mcus/freedom-development-platform-for-kinetis-k64-k63-and-k24-mcus:FRDM-K64F
+teensy_35           Teensy 3.5                                 kinetis_k      https://www.pjrc.com/store/teensy35.html
+frdm_k32l2a4s       Freedom K32L2A4S                           kinetis_k32l2  https://www.nxp.com/design/design-center/development-boards-and-designs/FRDM-K32L2A4S
+frdm_k32l2b         Freedom K32L2B3                            kinetis_k32l2  https://www.nxp.com/design/design-center/development-boards-and-designs/general-purpose-mcus/nxp-freedom-development-platform-for-k32-l2b-mcus:FRDM-K32L2B3
+kuiic               Kuiic                                      kinetis_k32l2  https://github.com/nxf58843/kuiic
+frdm_kl25z          fomu                                       kinetis_kl     https://www.nxp.com/design/design-center/development-boards-and-designs/general-purpose-mcus/freedom-development-platform-for-kinetis-kl14-kl15-kl24-kl25-mcus:FRDM-KL25Z
+lpcxpresso11u37     LPCXpresso11U37                            lpc11          https://www.nxp.com/design/design-center/development-boards-and-designs/OM13074
+lpcxpresso11u68     LPCXpresso11U68                            lpc11          https://www.nxp.com/design/design-center/development-boards-and-designs/OM13058
+lpcxpresso1347      LPCXpresso1347                             lpc13          https://www.nxp.com/products/no-longer-manufactured/lpcxpresso-board-for-lpc1347:OM13045
+lpcxpresso1549      LPCXpresso1549                             lpc15          https://www.nxp.com/design/design-center/development-boards-and-designs/OM13056
+lpcxpresso1769      LPCXpresso1769                             lpc17          https://www.nxp.com/design/design-center/development-boards-and-designs/OM13000
+mbed1768            mbed 1768                                  lpc17          https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1700-arm-cortex-m3/arm-mbed-lpc1768-board:OM11043
+lpcxpresso18s37     LPCXpresso18s37                            lpc18          https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/lpcxpresso-boards/lpcxpresso18s37-development-board:OM13076
+mcb1800             Keil MCB1800                               lpc18          https://www.keil.com/arm/mcb1800/
+ea4088_quickstart   Embedded Artists LPC4088 QuickStart Board  lpc40          https://www.embeddedartists.com/products/lpc4088-quickstart-board/
+ea4357              Embedded Artists LPC4357 Development Kit   lpc43          https://www.embeddedartists.com/products/lpc4357-developers-kit/
+lpcxpresso43s67     LPCXpresso43S67                            lpc43          https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/lpcxpresso-boards/lpcxpresso43s67-development-board:OM13084
+lpcxpresso51u68     LPCXpresso51u68                            lpc51          https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpcxpresso51u68-for-the-lpc51u68-mcus:OM40005
+lpcxpresso54114     LPCXpresso54114                            lpc54          https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/lpcxpresso-boards/lpcxpresso54114-board:OM13089
+lpcxpresso54608     LPCXpresso54608                            lpc54          https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/lpcxpresso-development-board-for-lpc5460x-mcus:OM13092
+lpcxpresso54628     LPCXpresso54628                            lpc54          https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/lpcxpresso-boards/lpcxpresso54628-development-board:OM13098
+double_m33_express  Double M33 Express                         lpc55          https://www.crowdsupply.com/steiert-solutions/double-m33-express
+lpcxpresso55s28     LPCXpresso55s28                            lpc55          https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/lpcxpresso-boards/lpcxpresso55s28-development-board:LPC55S28-EVK
+lpcxpresso55s69     LPCXpresso55s69                            lpc55          https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/lpcxpresso-boards/lpcxpresso55s69-development-board:LPC55S69-EVK
+mcu_link            MCU Link                                   lpc55          https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/mcu-link-debug-probe:MCU-LINK
+frdm_mcxa153        Freedom MCXA153                            mcx            https://www.nxp.com/design/design-center/development-boards-and-designs/FRDM-MCXA153
+frdm_mcxn947        Freedom MCXN947                            mcx            https://www.nxp.com/design/design-center/development-boards-and-designs/FRDM-MCXN947
+mcxn947brk          MCXN947 Breakout                           mcx            n/a
+==================  =========================================  =============  =========================================================================================================================================================================  ======
+
+Nordic Semiconductor
+--------------------
+
+===========================  =====================================  ========  ==============================================================================  ======
+Board                        Name                                   Family    URL                                                                             Note
+===========================  =====================================  ========  ==============================================================================  ======
+adafruit_clue                Adafruit CLUE                          nrf       https://www.adafruit.com/product/4500
+arduino_nano33_ble           Arduino Nano 33 BLE                    nrf       https://store.arduino.cc/arduino-nano-33-ble
+circuitplayground_bluefruit  Adafruit Circuit Playground Bluefruit  nrf       https://www.adafruit.com/product/4333
+feather_nrf52840_express     Adafruit Feather nRF52840 Express      nrf       https://www.adafruit.com/product/4062
+feather_nrf52840_sense       Adafruit Feather nRF52840 Sense        nrf       https://www.adafruit.com/product/4516
+itsybitsy_nrf52840           Adafruit ItsyBitsy nRF52840 Express    nrf       https://www.adafruit.com/product/4481
+pca10056                     Nordic nRF52840DK                      nrf       https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK
+pca10059                     Nordic nRF52840 Dongle                 nrf       https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-Dongle
+pca10095                     Nordic nRF5340 DK                      nrf       https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF5340-DK
+pca10100                     Nordic nRF52833 DK                     nrf       https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52833-DK
+===========================  =====================================  ========  ==============================================================================  ======
+
+Raspberry Pi
+------------
+
+=================  =================  ==============  ==========================================================  ======
+Board              Name               Family          URL                                                         Note
+=================  =================  ==============  ==========================================================  ======
+raspberrypi_zero   Raspberry Pi Zero  broadcom_32bit  https://www.raspberrypi.org/products/raspberry-pi-zero/
+raspberrypi_cm4    Raspberry CM4      broadcom_64bit  https://www.raspberrypi.org/products/compute-module-4
+raspberrypi_zero2  Raspberry Zero2    broadcom_64bit  https://www.raspberrypi.org/products/raspberry-pi-zero-2-w
+=================  =================  ==============  ==========================================================  ======
+
+Renesas
+-------
+
+==============  ===========================  ========  ================================================================================================================================================================  ======
+Board           Name                         Family    URL                                                                                                                                                               Note
+==============  ===========================  ========  ================================================================================================================================================================  ======
+da14695_dk_usb  DA14695-00HQDEVKT-U          da1469x   https://www.renesas.com/en/products/wireless-connectivity/bluetooth-low-energy/da14695-00hqdevkt-u-smartbond-da14695-bluetooth-low-energy-52-usb-development-kit
+da1469x_dk_pro  DA1469x Development Kit Pro  da1469x   https://lpccs-docs.renesas.com/um-b-090-da1469x_getting_started/DA1469x_The_hardware/DA1469x_The_hardware.html
+portenta_c33    Arduino Portenta C33         ra        https://www.arduino.cc/pro/hardware-product-portenta-c33/
+ra2a1_ek        RA2A1 EK                     ra        https://www.renesas.com/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra2a1-evaluation-kit-ra2a1-mcu-group
+ra4m1_ek        RA4M1 EK                     ra        https://www.renesas.com/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra4m1-evaluation-kit-ra4m1-mcu-group
+ra4m3_ek        RA4M3 EK                     ra        https://www.renesas.com/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra4m3-evaluation-kit-ra4m3-mcu-group
+ra6m1_ek        RA6M1 EK                     ra        https://www.renesas.com/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra6m1-evaluation-kit-ra6m1-mcu-group
+ra6m5_ek        RA6M5 EK                     ra        https://www.renesas.com/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra6m5-evaluation-kit-ra6m5-mcu-group
+ra8m1_ek        RA8M1 EK                     ra        https://www.renesas.com/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra8m1-evaluation-kit-ra8m1-mcu-group
+uno_r4          Arduino UNO R4               ra        https://store-usa.arduino.cc/pages/uno-r4
+==============  ===========================  ========  ================================================================================================================================================================  ======
+
+STMicroelectronics
+------------------
+
+===================  =================================  ========  =================================================================  ======
+Board                Name                               Family    URL                                                                Note
+===================  =================================  ========  =================================================================  ======
+stm32c071nucleo      STM32C071 Nucleo                   stm32c0   https://www.st.com/en/evaluation-tools/nucleo-g071rb.html
+stm32f070rbnucleo    STM32 F070 Nucleo                  stm32f0   https://www.st.com/en/evaluation-tools/nucleo-f070rb.html
+stm32f072disco       STM32 F072 Discovery               stm32f0   https://www.st.com/en/evaluation-tools/32f072bdiscovery.html
+stm32f072eval        STM32 F072 Eval                    stm32f0   https://www.st.com/en/evaluation-tools/stm32072b-eval.html
+stm32f103_bluepill   STM32 F103 Bluepill                stm32f1   https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill
+stm32f103_mini_2     STM32 F103 Mini v2                 stm32f1   https://stm32-base.org/boards/STM32F103RCT6-STM32-Mini-V2.0
+stm32f103ze_iar      IAR STM32 F103ze starter kit       stm32f1   n/a
+stm32f207nucleo      STM32 F207 Nucleo                  stm32f2   https://www.st.com/en/evaluation-tools/nucleo-f207zg.html
+stm32f303disco       STM32 F303 Discovery               stm32f3   https://www.st.com/en/evaluation-tools/stm32f3discovery.html
+feather_stm32f405    Adafruit Feather STM32F405         stm32f4   https://www.adafruit.com/product/4382
+pyboardv11           Pyboard v1.1                       stm32f4   https://www.adafruit.com/product/2390
+stm32f401blackpill   STM32 F401 Blackpill               stm32f4   https://stm32-base.org/boards/STM32F401CCU6-WeAct-Black-Pill-V1.2
+stm32f407blackvet    STM32 F407 Blackvet                stm32f4   https://stm32-base.org/boards/STM32F407VET6-STM32-F4VE-V2.0
+stm32f407disco       STM32 F407 Discovery               stm32f4   https://www.st.com/en/evaluation-tools/stm32f4discovery.html
+stm32f411blackpill   STM32 F411 Blackpill               stm32f4   https://stm32-base.org/boards/STM32F411CEU6-WeAct-Black-Pill-V2.0
+stm32f411disco       STM32 F411 Discovery               stm32f4   https://www.st.com/en/evaluation-tools/32f411ediscovery.html
+stm32f412disco       STM32 F412 Discovery               stm32f4   https://www.st.com/en/evaluation-tools/32f412gdiscovery.html
+stm32f412nucleo      STM32 F412 Nucleo                  stm32f4   https://www.st.com/en/evaluation-tools/nucleo-f412zg.html
+stm32f439nucleo      STM32 F439 Nucleo                  stm32f4   https://www.st.com/en/evaluation-tools/nucleo-f439zi.html
+stlinkv3mini         Stlink-v3 mini                     stm32f7   https://www.st.com/en/development-tools/stlink-v3mini.html
+stm32f723disco       STM32 F723 Discovery               stm32f7   https://www.st.com/en/evaluation-tools/32f723ediscovery.html
+stm32f746disco       STM32 F746 Discovery               stm32f7   https://www.st.com/en/evaluation-tools/32f746gdiscovery.html
+stm32f746nucleo      STM32 F746 Nucleo                  stm32f7   https://www.st.com/en/evaluation-tools/nucleo-f746zg.html
+stm32f767nucleo      STM32 F767 Nucleo                  stm32f7   https://www.st.com/en/evaluation-tools/nucleo-f767zi.html
+stm32f769disco       STM32 F769 Discovery               stm32f7   https://www.st.com/en/evaluation-tools/32f769idiscovery.html
+stm32g0b1nucleo      STM32 G0B1 Nucleo                  stm32g0   https://www.st.com/en/evaluation-tools/nucleo-g0b1re.html
+b_g474e_dpow1        STM32 B-G474E-DPOW1 Discovery kit  stm32g4   https://www.st.com/en/evaluation-tools/b-g474e-dpow1.html
+stm32g474nucleo      STM32 G474 Nucleo                  stm32g4   https://www.st.com/en/evaluation-tools/nucleo-g474re.html
+stm32g491nucleo      STM32 G491 Nucleo                  stm32g4   https://www.st.com/en/evaluation-tools/nucleo-g491re.html
+stm32h503nucleo      STM32 H503 Nucleo                  stm32h5   https://www.st.com/en/evaluation-tools/nucleo-h503rb.html
+stm32h563nucleo      STM32 H563 Nucleo                  stm32h5   https://www.st.com/en/evaluation-tools/nucleo-h563zi.html
+stm32h573i_dk        STM32 H573i Discovery              stm32h5   https://www.st.com/en/evaluation-tools/stm32h573i-dk.html
+daisyseed            Daisy Seed                         stm32h7   https://electro-smith.com/products/daisy-seed
+stm32h723nucleo      STM32 H723 Nucleo                  stm32h7   https://www.st.com/en/evaluation-tools/nucleo-h723zg.html
+stm32h743eval        STM32 H743 Eval                    stm32h7   https://www.st.com/en/evaluation-tools/stm32h743i-eval.html
+stm32h743nucleo      STM32 H743 Nucleo                  stm32h7   https://www.st.com/en/evaluation-tools/nucleo-h743zi.html
+stm32h745disco       STM32 H745 Discovery               stm32h7   https://www.st.com/en/evaluation-tools/stm32h745i-disco.html
+stm32h750_weact      STM32 H750 WeAct                   stm32h7   https://www.adafruit.com/product/5032
+stm32h750bdk         STM32 H750b Discovery Kit          stm32h7   https://www.st.com/en/evaluation-tools/stm32h750b-dk.html
+waveshare_openh743i  Waveshare Open H743i               stm32h7   https://www.waveshare.com/openh743i-c-standard.htm
+stm32l052dap52       STM32 L052 DAP                     stm32l0   n/a
+stm32l0538disco      STM32 L0538 Discovery              stm32l0   https://www.st.com/en/evaluation-tools/32l0538discovery.html
+stm32l412nucleo      STM32 L412 Nucleo                  stm32l4   https://www.st.com/en/evaluation-tools/nucleo-l412kb.html
+stm32l476disco       STM32 L476 Disco                   stm32l4   https://www.st.com/en/evaluation-tools/32l476gdiscovery.html
+stm32l4p5nucleo      STM32 L4P5 Nucleo                  stm32l4   https://www.st.com/en/evaluation-tools/nucleo-l4p5zg.html
+stm32l4r5nucleo      STM32 L4R5 Nucleo                  stm32l4   https://www.st.com/en/evaluation-tools/nucleo-l4r5zi.html
+b_u585i_iot2a        STM32 B-U585i IOT2A Discovery kit  stm32u5   https://www.st.com/en/evaluation-tools/b-u585i-iot02a.html
+stm32u545nucleo      STM32 U545 Nucleo                  stm32u5   https://www.st.com/en/evaluation-tools/nucleo-u545re-q.html
+stm32u575eval        STM32 U575 Eval                    stm32u5   https://www.st.com/en/evaluation-tools/stm32u575i-ev.html
+stm32u575nucleo      STM32 U575 Nucleo                  stm32u5   https://www.st.com/en/evaluation-tools/nucleo-u575zi-q.html
+stm32u5a5nucleo      STM32 U5a5 Nucleo                  stm32u5   https://www.st.com/en/evaluation-tools/nucleo-u5a5zj-q.html
+stm32wb55nucleo      STM32 P-NUCLEO-WB55                stm32wb   https://www.st.com/en/evaluation-tools/p-nucleo-wb55.html
+===================  =================================  ========  =================================================================  ======
+
+Sunxi
+-----
+
+=======  =================  ========  =========================================  ======
+Board    Name               Family    URL                                        Note
+=======  =================  ========  =========================================  ======
+f1c100s  Lctech Pi F1C200s  f1c100s   https://linux-sunxi.org/Lctech_Pi_F1C200s
+=======  =================  ========  =========================================  ======
+
+Texas Instruments
+-----------------
+
+=================  =====================  ========  =========================================  ======
+Board              Name                   Family    URL                                        Note
+=================  =====================  ========  =========================================  ======
+msp_exp430f5529lp  MSP430F5529 LaunchPad  msp430    https://www.ti.com/tool/MSP-EXP430F5529LP
+msp_exp432e401y    MSP432E401Y LaunchPad  msp432e4  https://www.ti.com/tool/MSP-EXP432E401Y
+ek_tm4c123gxl      TM4C123G LaunchPad     tm4c      https://www.ti.com/tool/EK-TM4C123GXL
+=================  =====================  ========  =========================================  ======
+
+Tomu
+----
+
+=======  ======  ========  =========================  ======
+Board    Name    Family    URL                        Note
+=======  ======  ========  =========================  ======
+fomu     fomu    fomu      https://tomu.im/fomu.html
+=======  ======  ========  =========================  ======
+
+WCH
+---
+
+================  ================  ========  =====================================================================  ======
+Board             Name              Family    URL                                                                    Note
+================  ================  ========  =====================================================================  ======
+ch32f205r-r0      CH32F205r-r0      ch32f20x  https://github.com/openwch/ch32f20x
+ch32v103r_r1_1v0  CH32V103R-R1-1v1  ch32v10x  https://github.com/openwch/ch32v103/tree/main/SCHPCB/CH32V103R-R1-1v1
+ch32v203c_r0_1v0  CH32V203C-R0-1v0  ch32v20x  https://github.com/openwch/ch32v20x/tree/main/SCHPCB/CH32V203C-R0
+ch32v203g_r0_1v0  CH32V203G-R0-1v0  ch32v20x  https://github.com/openwch/ch32v20x/tree/main/SCHPCB/CH32V203C-R0
+nanoch32v203      nanoCH32V203      ch32v20x  https://github.com/wuxx/nanoCH32V203
+ch32v307v_r1_1v0  CH32V307V-R1-1v0  ch32v307  https://github.com/openwch/ch32v307/tree/main/SCHPCB/CH32V307V-R1-1v0
+================  ================  ========  =====================================================================  ======

docs/reference/getting_started.rst

@@ -7,17 +7,17 @@ Add TinyUSB to your project
 
 It is relatively simple to incorporate tinyusb to your project
 
-* Copy or ``git submodule`` this repo into your project in a subfolder. Let's say it is *your_project/tinyusb*
-* Add all the .c in the ``tinyusb/src`` folder to your project
-* Add *your_project/tinyusb/src* to your include path. Also make sure your current include path also contains the configuration file tusb_config.h.
-* Make sure all required macros are all defined properly in tusb_config.h (configure file in demo application is sufficient, but you need to add a few more such as ``CFG_TUSB_MCU``, ``CFG_TUSB_OS`` since they are passed by IDE/compiler to maintain a unique configure for all boards).
+* Copy or ``git submodule`` this repo into your project in a subfolder. Let's say it is ``your_project/tinyusb``
+* Add all the ``.c`` in the ``tinyusb/src`` folder to your project
+* Add ``your_project/tinyusb/src`` to your include path. Also make sure your current include path also contains the configuration file ``tusb_config.h``.
+* Make sure all required macros are all defined properly in ``tusb_config.h`` (configure file in demo application is sufficient, but you need to add a few more such as ``CFG_TUSB_MCU``, ``CFG_TUSB_OS`` since they are passed by IDE/compiler to maintain a unique configure for all boards).
 * If you use the device stack, make sure you have created/modified usb descriptors for your own need. Ultimately you need to implement all **tud descriptor** callbacks for the stack to work.
-* Add tusb_init(rhport, role) call to your reset initialization code.
+* Add ``tusb_init(rhport, role)`` call to your reset initialization code.
 * Call ``tusb_int_handler(rhport, in_isr)`` in your USB IRQ Handler
 * Implement all enabled classes's callbacks.
-* If you don't use any RTOSes at all, you need to continuously and/or periodically call tud_task()/tuh_task() function. All of the callbacks and functionality are handled and invoked within the call of that task runner.
+* If you don't use any RTOSes at all, you need to continuously and/or periodically call ``tud_task()``/``tuh_task()`` function. All of the callbacks and functionality are handled and invoked within the call of that task runner.
 
-.. code-block::
+.. code-block:: c
 
    int main(void) {
      tusb_rhport_init_t dev_init = {
@@ -50,9 +50,9 @@ It is relatively simple to incorporate tinyusb to your project
 Examples
 --------
 
-For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API() should be used. Most examples will work on most of `the supported boards <supported.rst>`_. Firstly we need to ``git clone`` if not already
+For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API should be used. Most examples will work on most of `the supported boards <boards.rst>`_. Firstly we need to ``git clone`` if not already
 
-.. code-block::
+.. code-block:: bash
 
    $ git clone https://github.com/hathach/tinyusb tinyusb
    $ cd tinyusb
@@ -62,17 +62,17 @@ Some ports will also require a port-specific SDK (e.g. RP2040) or binary (e.g. S
 Dependencies
 ^^^^^^^^^^^^
 
-The hardware code is located in ``hw/bsp`` folder, and is organized by family/boards. e.g raspberry_pi_pico is located in ``hw/bsp/rp2040/boards/raspberry_pi_pico`` where FAMILY=rp2040 and BOARD=raspberry_pi_pico. Before building, we firstly need to download dependencies such as: MCU low-level peripheral driver and external libraries e.g FreeRTOS (required by some examples). We can do that by either ways:
+The hardware code is located in ``hw/bsp`` folder, and is organized by family/boards. e.g raspberry_pi_pico is located in ``hw/bsp/rp2040/boards/raspberry_pi_pico`` where ``FAMILY=rp2040`` and ``BOARD=raspberry_pi_pico``. Before building, we firstly need to download dependencies such as: MCU low-level peripheral driver and external libraries e.g FreeRTOS (required by some examples). We can do that by either ways:
 
 1. Run ``tools/get_deps.py {FAMILY}`` script to download all dependencies for a family as follow. Note: For TinyUSB developer to download all dependencies, use FAMILY=all.
 
-.. code-block::
+.. code-block:: bash
 
    $ python tools/get_deps.py rp2040
 
 2. Or run the ``get-deps`` target in one of the example folder as follow.
 
-.. code-block::
+.. code-block:: bash
 
    $ cd examples/device/cdc_msc
    $ make BOARD=raspberry_pi_pico get-deps
@@ -84,19 +84,19 @@ Build
 
 To build example, first change directory to an example folder.
 
-.. code-block::
+.. code-block:: bash
 
    $ cd examples/device/cdc_msc
 
 Then compile with ``make BOARD={board_name} all`` , for example
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=raspberry_pi_pico all
 
 Note: some examples especially those that uses Vendor class (e.g webUSB) may requires udev permission on Linux (and/or macOS) to access usb device. It depends on your OS distro, typically copy ``99-tinyusb.rules`` and reload your udev is good to go
 
-.. code-block::
+.. code-block:: bash
 
    $ cp examples/device/99-tinyusb.rules /etc/udev/rules.d/
    $ sudo udevadm control --reload-rules && sudo udevadm trigger
@@ -106,7 +106,7 @@ RootHub Port Selection
 
 If a board has several ports, one port is chosen by default in the individual board.mk file. Use option ``PORT=x`` To choose another port. For example to select the HS port of a STM32F746Disco board, use:
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=stm32f746disco PORT=1 all
 
@@ -115,16 +115,16 @@ Port Speed
 
 A MCU can support multiple operational speed. By default, the example build system will use the fastest supported on the board. Use option ``SPEED=full/high`` e.g To force F723 operate at full instead of default high speed
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=stm32f746disco SPEED=full all
 
 Size Analysis
 ~~~~~~~~~~~~~
 
-First install `linkermap tool <https://github.com/hathach/linkermap>`_ then ``linkermap`` target can be used to analyze code size. You may want to compile with ``NO_LTO=1`` since -flto merges code across .o files and make it difficult to analyze.
+First install `linkermap tool <https://github.com/hathach/linkermap>`_ then ``linkermap`` target can be used to analyze code size. You may want to compile with ``NO_LTO=1`` since ``-flto`` merges code across ``.o`` files and make it difficult to analyze.
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=feather_nrf52840_express NO_LTO=1 all linkermap
 
@@ -133,16 +133,16 @@ Debug
 
 To compile for debugging add ``DEBUG=1``\ , for example
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=feather_nrf52840_express DEBUG=1 all
 
 Log
 ~~~
 
-Should you have an issue running example and/or submitting an bug report. You could enable TinyUSB built-in debug logging with optional ``LOG=``. LOG=1 will only print out error message, LOG=2 print more information with on-going events. LOG=3 or higher is not used yet.
+Should you have an issue running example and/or submitting an bug report. You could enable TinyUSB built-in debug logging with optional ``LOG=``. ``LOG=1`` will only print out error message, ``LOG=2`` print more information with on-going events. ``LOG=3`` or higher is not used yet.
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=feather_nrf52840_express LOG=2 all
 
@@ -164,7 +164,7 @@ By default log message is printed via on-board UART which is slow and take lots
   * Pros: should be compatible with more debugger that support SWO.
   * Software viewer should be provided along with your debugger driver.
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=feather_nrf52840_express LOG=2 LOGGER=rtt all
    $ make BOARD=feather_nrf52840_express LOG=2 LOGGER=swo all
@@ -174,20 +174,20 @@ Flash
 
 ``flash`` target will use the default on-board debugger (jlink/cmsisdap/stlink/dfu) to flash the binary, please install those support software in advance. Some board use bootloader/DFU via serial which is required to pass to make command
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=feather_nrf52840_express flash
    $ make SERIAL=/dev/ttyACM0 BOARD=feather_nrf52840_express flash
 
 Since jlink can be used with most of the boards, there is also ``flash-jlink`` target for your convenience.
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=feather_nrf52840_express flash-jlink
 
 Some board use uf2 bootloader for drag & drop in to mass storage device, uf2 can be generated with ``uf2`` target
 
-.. code-block::
+.. code-block:: bash
 
    $ make BOARD=feather_nrf52840_express all uf2
 
@@ -199,23 +199,23 @@ Use project connection
 
 IAR Project Connection files are provided to import TinyUSB stack into your project.
 
-* A buldable project of your MCU need to be created in advance.
+* A buildable project of your MCU need to be created in advance.
 
 
   * Take example of STM32F0:
 
-    -  You need `stm32l0xx.h`, `startup_stm32f0xx.s`, `system_stm32f0xx.c`.
+    -  You need ``stm32l0xx.h``, ``startup_stm32f0xx.s``, ``system_stm32f0xx.c``.
 
-    - `STM32L0xx_HAL_Driver` is only needed to run examples, TinyUSB stack itself doesn't rely on MCU's SDKs.
+    - ``STM32L0xx_HAL_Driver`` is only needed to run examples, TinyUSB stack itself doesn't rely on MCU's SDKs.
 
-* Open ``Tools -> Configure Custom Argument Variables`` (Switch to `Global` tab if you want to do it for all your projects)
-   Click `New Group ...`, name it to `TUSB`, Click `Add Variable ...`, name it to `TUSB_DIR`, change it's value to the path of your TinyUSB stack,
-   for example `C:\\tinyusb`
+* Open ``Tools -> Configure Custom Argument Variables`` (Switch to ``Global`` tab if you want to do it for all your projects)
+   Click ``New Group ...``, name it to ``TUSB``, Click ``Add Variable ...``, name it to ``TUSB_DIR``, change it's value to the path of your TinyUSB stack,
+   for example ``C:\\tinyusb``
 
 Import stack only
 ~~~~~~~~~~~~~~~~~
 
-1. Open ``Project -> Add project Connection ...``, click `OK`, choose `tinyusb\\tools\\iar_template.ipcf`.
+1. Open ``Project -> Add project Connection ...``, click ``OK``, choose ``tinyusb\\tools\\iar_template.ipcf``.
 
 Run examples
 ~~~~~~~~~~~~
@@ -224,11 +224,11 @@ Run examples
 
    .. code-block::
 
-     cd C:\tinyusb\tools
-     python iar_gen.py
+      > cd C:\tinyusb\tools
+      > python iar_gen.py
 
-2. Open `Project -> Add project Connection ...`, click `OK`, choose `tinyusb\\examples\\(.ipcf of example)`.
-   For example `C:\\tinyusb\\examples\\device\\cdc_msc\\iar_cdc_msc.ipcf`
+2. Open ``Project -> Add project Connection ...``, click ``OK``, choose ``tinyusb\\examples\\(.ipcf of example)``.
+   For example ``C:\\tinyusb\\examples\\device\\cdc_msc\\iar_cdc_msc.ipcf``
 
 Native CMake support (9.50.1+)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -239,5 +239,5 @@ Following these steps:
 
 1. Add IAR compiler binary path to system ``PATH`` environment variable, such as ``C:\Program Files\IAR Systems\Embedded Workbench 9.2\arm\bin``.
 2. Create new project in IAR, in Tool chain dropdown menu, choose CMake for Arm then Import ``CMakeLists.txt`` from chosen example directory.
-3. Set up board option in ``Option - CMake/CMSIS-TOOLBOX - CMake``, for example :code:`-DBOARD=stm32f439nucleo -DTOOLCHAIN=iar`, **Uncheck 'Override tools in env'**.
+3. Set up board option in ``Option - CMake/CMSIS-TOOLBOX - CMake``, for example ``-DBOARD=stm32f439nucleo -DTOOLCHAIN=iar``, **Uncheck 'Override tools in env'**.
 4. (For debug only) Choose correct CPU model in ``Option - General Options - Target``, to profit register and memory view.

docs/reference/index.rst

@@ -1,85 +1,10 @@
-*********
-Reference
-*********
-
-.. figure:: ../assets/stack.svg
-   :width: 1600px
-   :alt: TinyUSB
-
-::
-
-    .
-    ├── docs            # Documentation
-    ├── examples        # Examples with make and cmake build system
-    ├── hw
-    │   ├── bsp         # Supported boards source files
-    │   └── mcu         # Low level mcu core & peripheral drivers
-    ├── lib             # Sources from 3rd party such as freeRTOS, fatfs ...
-    ├── src             # All sources files for TinyUSB stack itself.
-    ├── test            # Tests: unit test, fuzzing, hardware test
-    └── tools           # Files used internally
-
-
-Device Stack
-============
-
-Supports multiple device configurations by dynamically changing USB descriptors, low power functions such like suspend, resume, and remote wakeup. The following device classes are supported:
-
--  Audio Class 2.0 (UAC2)
--  Bluetooth Host Controller Interface (BTH HCI)
--  Communication Device Class (CDC)
--  Device Firmware Update (DFU): DFU mode (WIP) and Runtime
--  Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ...
--  Mass Storage Class (MSC): with multiple LUNs
--  Musical Instrument Digital Interface (MIDI)
--  Network with RNDIS, Ethernet Control Model (ECM), Network Control Model (NCM)
--  Test and Measurement Class (USBTMC)
--  Video class 1.5 (UVC): work in progress
--  Vendor-specific class support with generic In & Out endpoints. Can be used with MS OS 2.0 compatible descriptor to load winUSB driver without INF file.
--  `WebUSB <https://github.com/WICG/webusb>`__ with vendor-specific class
-
-If you have a special requirement, `usbd_app_driver_get_cb()` can be used to write your own class driver without modifying the stack. Here is how the RPi team added their reset interface `raspberrypi/pico-sdk#197 <https://github.com/raspberrypi/pico-sdk/pull/197>`_
-
-Host Stack
-==========
-
-- Human Interface Device (HID): Keyboard, Mouse, Generic
-- Mass Storage Class (MSC)
-- Communication Device Class: CDC-ACM
-- Vendor serial over USB: FTDI, CP210x
-- 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.
-
-TypeC PD Stack
-==============
-
-- Power Delivery 3.0 (PD3.0) with USB Type-C support (WIP)
-- Super early stage, only for testing purpose
-- Only support STM32 G4
-
-OS Abstraction layer
-====================
-
-TinyUSB is completely thread-safe by pushing all Interrupt Service Request (ISR) events into a central queue, then processing them later in the non-ISR context task function. It also uses semaphore/mutex to access shared resources such as Communication Device Class (CDC) FIFO. Therefore the stack needs to use some of the OS's basic APIs. Following OSes are already supported out of the box.
-
-- **No OS**
-- **FreeRTOS**
-- `RT-Thread <https://github.com/RT-Thread/rt-thread>`_: `repo <https://github.com/RT-Thread-packages/tinyusb>`_
-- **Mynewt** Due to the newt package build system, Mynewt examples are better to be on its `own repo <https://github.com/hathach/mynewt-tinyusb-example>`_
-
-License
-=======
-
-All TinyUSB sources in the `src` folder are licensed under MIT license. However, each file can be individually licensed especially those in `lib` and `hw/mcu` folder. Please make sure you understand all the license term for files you use in your project.
-
 Index
 =====
 
 .. toctree::
    :maxdepth: 2
 
-   supported
    getting_started
+   boards
    dependencies
    concurrency

docs/reference/supported.rst

@@ -1,442 +0,0 @@
-*****************
-Supported Devices
-*****************
-
-Supported MCUs
-==============
-
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Manufacturer | Family                      | Device | Host | Highspeed | Driver                 | Note              |
-+==============+=============================+========+======+===========+========================+===================+
-| Allwinner    | F1C100s/F1C200s             | ✔      |      | ✔         | sunxi                  | musb variant      |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Analog       | MAX3421E                    |        | ✔    | ✖         | max3421                | via SPI           |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | MAX32 650, 666, 690,        | ✔      |      | ✔         | musb                   | 1-dir ep          |
-|              | MAX78002                    |        |      |           |                        |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Brigetek     | FT90x                       | ✔      |      | ✔         | ft9xx                  | 1-dir ep          |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Broadcom     | BCM2711, BCM2837            | ✔      |      | ✔         | dwc2                   |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Dialog       | DA1469x                     | ✔      | ✖    | ✖         | da146xx                |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Espressif    | S2, S3                      | ✔      | ✔    | ✖         | dwc2 or esp32sx        |                   |
-|   ESP32      +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | P4                          | ✔      | ✔    | ✔         | dwc2                   |                   |
-+--------------+----+------------------------+--------+------+-----------+------------------------+-------------------+
-| GigaDevice   | GD32VF103                   | ✔      |      | ✖         | dwc2                   |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Infineon     | XMC4500                     | ✔      | ✔    | ✖         | dwc2                   |                   |
-+--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
-| MicroChip    | SAM | D11, D21, L21, L22    | ✔      |      | ✖         | samd                   |                   |
-|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
-|              |     | D51, E5x              | ✔      |      | ✖         | samd                   |                   |
-|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
-|              |     | G55                   | ✔      |      | ✖         | samg                   | 1-dir ep          |
-|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
-|              |     | E70,S70,V70,V71       | ✔      |      | ✔         | samx7x                 | 1-dir ep          |
-|              +-----+-----------------------+--------+------+-----------+------------------------+-------------------+
-|              | PIC | 24                    | ✔      |      |           | pic                    | ci_fs variant     |
-|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
-|              |     | 32 mm, mk, mx         | ✔      |      |           | pic                    | ci_fs variant     |
-|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
-|              |     | dsPIC33               | ✔      |      |           | pic                    | ci_fs variant     |
-|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
-|              |     | 32mz                  | ✔      |      |           | pic32mz                | musb variant      |
-+--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
-| Mind Montion | mm32                        | ✔      |      | ✖         | mm32f327x_otg          | ci_fs variant     |
-+--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
-| NordicSemi   | nRF 52833, 52840, 5340      | ✔      | ✖    | ✖         | nrf5x                  | only ep8 is ISO   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Nuvoton      | NUC120                      | ✔      | ✖    | ✖         | nuc120                 |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | NUC121/NUC125               | ✔      | ✖    | ✖         | nuc121                 |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | NUC126                      | ✔      | ✖    | ✖         | nuc121                 |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | NUC505                      | ✔      |      | ✔         | nuc505                 |                   |
-+--------------+---------+-------------------+--------+------+-----------+------------------------+-------------------+
-| NXP          | iMXRT   | RT 10xx, 11xx     | ✔      | ✔    | ✔         | ci_hs                  |                   |
-|              +---------+-------------------+--------+------+-----------+------------------------+-------------------+
-|              | Kinetis | KL                | ✔      | ⚠    | ✖         | ci_fs, khci            |                   |
-|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
-|              |         | K32L2             | ✔      |      | ✖         | khci                   | ci_fs variant     |
-|              +---------+-------------------+--------+------+-----------+------------------------+-------------------+
-|              | LPC     | 11u, 13, 15       | ✔      | ✖    | ✖         | lpc_ip3511             |                   |
-|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
-|              |         | 17, 40            | ✔      | ⚠    | ✖         | lpc17_40               |                   |
-|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
-|              |         | 18, 43            | ✔      | ✔    | ✔         | ci_hs                  |                   |
-|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
-|              |         | 51u               | ✔      | ✖    | ✖         | lpc_ip3511             |                   |
-|              |         +-------------------+--------+------+-----------+------------------------+-------------------+
-|              |         | 54, 55            | ✔      |      | ✔         | lpc_ip3511             |                   |
-|              +---------+-------------------+--------+------+-----------+------------------------+-------------------+
-|              | MCX     | N9, A15           | ✔      |      | ✔         | ci_fs, ci_hs           |                   |
-+--------------+---------+-------------------+--------+------+-----------+------------------------+-------------------+
-| Raspberry Pi | RP2040, RP2350              | ✔      | ✔    | ✖         | rp2040, pio_usb        |                   |
-+--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
-| Renesas      | RX  | 63N, 65N, 72N         | ✔      | ✔    | ✖         | rusb2                  |                   |
-|              +-----+-----------------------+--------+------+-----------+------------------------+-------------------+
-|              | RA  | 4M1, 4M3, 6M1         | ✔      | ✔    | ✖         | rusb2                  |                   |
-|              |     +-----------------------+--------+------+-----------+------------------------+-------------------+
-|              |     | 6M5                   | ✔      | ✔    | ✔         | rusb2                  |                   |
-+--------------+-----+-----------------------+--------+------+-----------+------------------------+-------------------+
-| Silabs       | EFM32GG12                   | ✔      |      | ✖         | dwc2                   |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| Sony         | CXD56                       | ✔      | ✖    | ✔         | cxd56                  |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| ST STM32     | F0                          | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
-|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
-|              | F1 | 102, 103               | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
-|              |    +------------------------+--------+------+-----------+------------------------+-------------------+
-|              |    | 105, 107               | ✔      | ✔    | ✖         | dwc2                   |                   |
-|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
-|              | F2, F4, F7, H7              | ✔      | ✔    | ✔         | dwc2                   |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | F3                          | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | C0, G0, H5                  | ✔      |      | ✖         | stm32_fsdev            |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | G4                          | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | L0, L1                      | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
-|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
-|              | L4 | 4x2, 4x3               | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
-|              |    +------------------------+--------+------+-----------+------------------------+-------------------+
-|              |    | 4x5, 4x6               | ✔      | ✔    | ✖         | dwc2                   |                   |
-|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
-|              | L4+                         | ✔      | ✔    | ✖         | dwc2                   |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | L5                          | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
-|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
-|              | U5 | 535, 545               | ✔      |      | ✖         | stm32_fsdev            |                   |
-|              |    +------------------------+--------+------+-----------+------------------------+-------------------+
-|              |    | 575, 585               | ✔      | ✔    | ✖         | dwc2                   |                   |
-|              |    +------------------------+--------+------+-----------+------------------------+-------------------+
-|              |    | 59x,5Ax,5Fx,5Gx        | ✔      | ✔    | ✔         | dwc2                   |                   |
-|              +----+------------------------+--------+------+-----------+------------------------+-------------------+
-|              | WBx5                        | ✔      | ✖    | ✖         | stm32_fsdev            |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| TI           | MSP430                      | ✔      | ✖    | ✖         | msp430x5xx             |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | MSP432E4                    | ✔      |      | ✖         | musb                   |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | TM4C123                     | ✔      |      | ✖         | musb                   |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| ValentyUSB   | eptri                       | ✔      | ✖    | ✖         | eptri                  |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-| WCH          | CH32F20x                    | ✔      |      | ✔         | ch32_usbhs             |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | CH32V20x                    | ✔      |      | ✖         | stm32_fsdev/ch32_usbfs |                   |
-|              +-----------------------------+--------+------+-----------+------------------------+-------------------+
-|              | CH32V307                    | ✔      |      | ✔         | ch32_usbfs/hs          |                   |
-+--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
-
-
-Table Legend
-------------
-
-========= =========================
-✔         Supported
-⚠         Partial support
-✖         Not supported by hardware
-\[empty\] Unknown
-========= =========================
-
-Supported Boards
-================
-
-The board support code is only used for self-contained examples and testing. It is not used when TinyUSB is part of a larger project. It is responsible for getting the MCU started and the USB peripheral clocked with minimal of on-board devices
-
--  One LED : for status
--  One Button : to get input from user
--  One UART : optional for device, but required for host examples
-
-The following boards are supported (sorted alphabetically):
-
-Broadcom
---------
-
--  `Raspberry Pi CM4 <https://www.raspberrypi.com/products/compute-module-4>`__
-
-Dialog DA146xx
---------------
-
--  `DA14695 Development Kit – USB <https://www.dialog-semiconductor.com/products/da14695-development-kit-usb>`__
--  `DA1469x Development Kit – Pro <https://www.dialog-semiconductor.com/products/da14695-development-kit-pro>`__
-
-Espressif ESP32-S2
-------------------
-
--  `Adafruit Feather ESP32-S2 <https://www.adafruit.com/product/5000>`__
--  `Adafruit Magtag 2.9" E-Ink WiFi Display <https://www.adafruit.com/product/4800>`__
--  `Adafruit Metro ESP32-S2 <https://www.adafruit.com/product/4775>`__
--  `ESP32-S2-Kaluga-1 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.html>`__
--  `ESP32-S2-Saola-1 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-saola-1-v1.2.html>`__
-
-GigaDevice
-----------
-
--  `Sipeed Longan Nano <https://longan.sipeed.com/en/>`__
-
-Infineon
----------
-
-XMC4000
-^^^^^^^
-
--  `XMC4500 Relax (Lite) Kit <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc45_relax_lite_v1/>`__
-
-MicroChip
----------
-
-SAMD11 & SAMD21
-^^^^^^^^^^^^^^^
-
--  `Adafruit Circuit Playground Express <https://www.adafruit.com/product/3333>`__
--  `Adafruit Feather M0 Express <https://www.adafruit.com/product/3403>`__
--  `Adafruit ItsyBitsy M0 Express <https://www.adafruit.com/product/3727>`__
--  `Adafruit Metro M0 Express <https://www.adafruit.com/product/3505>`__
--  `Great Scott Gadgets Cynthion <https://greatscottgadgets.com/cynthion/>`__
--  `Microchip SAMD11 Xplained Pro <https://www.microchip.com/developmenttools/ProductDetails/atsamd11-xpro>`__
--  `Microchip SAMD21 Xplained Pro <https://www.microchip.com/DevelopmentTools/ProductDetails/ATSAMD21-XPRO>`__
--  `Seeeduino Xiao <https://www.seeedstudio.com/Seeeduino-XIAO-Arduino-Microcontroller-SAMD21-Cortex-M0+-p-4426.html>`__
-
-SAMD51 & SAME54
-^^^^^^^^^^^^^^^
-
--  `Adafruit Feather M4 Express <https://www.adafruit.com/product/3857>`__
--  `Adafruit ItsyBitsy M4 Express <https://www.adafruit.com/product/3800>`__
--  `Adafruit PyBadge <https://www.adafruit.com/product/4200>`__
--  `Adafruit PyPortal <https://www.adafruit.com/product/4116>`__
--  `Adafruit Metro M4 Express <https://www.adafruit.com/product/3382>`__
--  `D5035-01 <https://github.com/RudolphRiedel/USB_CAN-FD>`__
--  `Microchip SAME54 Xplained Pro <https://www.microchip.com/developmenttools/productdetails/atsame54-xpro>`__
-
-SAME7x
-^^^^^^
-
-- `Microchip SAME70 Xplained <https://www.microchip.com/en-us/development-tool/ATSAME70-XPLD>`_
-- `QMTECH ATSAME70N19 <https://www.aliexpress.com/item/1005003173783268.html>`_
-
-SAMG
-^^^^
-
--  `Microchip SAMG55 Xplained Pro <https://www.microchip.com/DevelopmentTools/ProductDetails/PartNO/ATSAMG55-XPRO>`__
-
-SAML2x
-^^^^^^
-
--  `SAML21 Xplaind Pro <https://www.microchip.com/DevelopmentTools/ProductDetails/ATSAML21-XPRO-B>`__
--  `SAML22 Feather <https://github.com/joeycastillo/Feather-Projects/tree/main/SAML22%20Feather>`__
--  `Sensor Watch <https://github.com/joeycastillo/Sensor-Watch>`__
-
-Nordic nRF5x
-------------
-
--  `Adafruit Circuit Playground Bluefruit <https://www.adafruit.com/product/4333>`__
--  `Adafruit CLUE <https://www.adafruit.com/product/4500>`__
--  `Adafruit Feather nRF52840 Express <https://www.adafruit.com/product/4062>`__
--  `Adafruit Feather nRF52840 Sense <https://www.adafruit.com/product/4516>`__
--  `Adafruit ItsyBitsy nRF52840 Express <https://www.adafruit.com/product/4481>`__
--  `Arduino Nano 33 BLE <https://store.arduino.cc/usa/nano-33-ble>`__
--  `Arduino Nano 33 BLE Sense <https://store.arduino.cc/usa/nano-33-ble-sense>`__
--  `Maker Diary nRF52840 MDK Dongle <https://wiki.makerdiary.com/nrf52840-mdk-usb-dongle>`__
--  `Nordic nRF52840 Development Kit (aka pca10056) <https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK>`__
--  `Nordic nRF52840 Dongle (aka pca10059) <https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-Dongle>`__
--  `Nordic nRF52833 Development Kit (aka pca10100) <https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52833-DK>`__
--  `Raytac MDBT50Q-RX Dongle <https://www.raytac.com/product/ins.php?index_id=89>`__
-
-Nuvoton
--------
-
--  NuTiny SDK NUC120
--  `NuTiny NUC121S <https://direct.nuvoton.com/en/nutiny-nuc121s>`__
--  `NuTiny NUC125S <https://direct.nuvoton.com/en/nutiny-nuc125s>`__
--  `NuTiny NUC126V <https://direct.nuvoton.com/en/nutiny-nuc126v>`__
--  `NuTiny SDK NUC505Y <https://direct.nuvoton.com/en/nutiny-nuc505y>`__
-
-NXP
----
-
-iMX RT
-^^^^^^
-
--  `MIMX RT1010 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1010-evaluation-kit:MIMXRT1010-EVK>`__
--  `MIMX RT1015 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1015-evaluation-kit:MIMXRT1015-EVK>`__
--  `MIMX RT1020 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1020-evaluation-kit:MIMXRT1020-EVK>`__
--  `MIMX RT1050 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1050-evaluation-kit:MIMXRT1050-EVK>`__
--  `MIMX RT1060 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/mimxrt1060-evk-i.mx-rt1060-evaluation-kit:MIMXRT1060-EVK>`__
--  `MIMX RT1064 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/mimxrt1064-evk-i.mx-rt1064-evaluation-kit:MIMXRT1064-EVK>`__
--  `Teensy 4.0 Development Board <https://www.pjrc.com/store/teensy40.html>`__
--  `Teensy 4.1 Development Board <https://www.pjrc.com/store/teensy41.html>`__
-
-Kinetis
-^^^^^^^
-
--  `Freedom FRDM-KL25Z <https://www.nxp.com/design/development-boards/freedom-development-boards/mcu-boards/freedom-development-platform-for-kinetis-kl14-kl15-kl24-kl25-mcus:FRDM-KL25Z>`__
--  `Freedom FRDM-K32L2A4S  <https://www.nxp.com/design/development-boards/freedom-development-boards/mcu-boards/nxp-freedom-platform-for-k32-l2a-mcus:FRDM-K32L2A4S>`__
--  `Freedom FRDM-K32L2B3 <https://www.nxp.com/design/development-boards/freedom-development-boards/mcu-boards/nxp-freedom-development-platform-for-k32-l2b-mcus:FRDM-K32L2B3>`__
--  `KUIIC <https://github.com/nxf58843/kuiic>`__
-
-LPC 11-13-15
-^^^^^^^^^^^^
-
--  `LPCXpresso 11u37 <https://www.nxp.com/design/microcontrollers-developer-resources/lpcxpresso-boards/lpcxpresso-board-for-lpc11u37h:OM13074>`__
--  `LPCXpresso 11u68 <https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc11u68:OM13058>`__
--  `LPCXpresso 1347 <https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc1347:OM13045>`__
--  `LPCXpresso 1549 <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1500-cortex-m3/lpcxpresso-board-for-lpc1549:OM13056>`__
-
-LPC 17-40
-^^^^^^^^^
-
--  `ARM mbed LPC1768 <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1700-cortex-m3/arm-mbed-lpc1768-board:OM11043>`__
--  `Embedded Artists LPC4088 Quick Start board <https://www.embeddedartists.com/products/lpc4088-quickstart-board>`__
--  `LPCXpresso 1769 <https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc1769:OM13000>`__
-
-LPC 18-43
-^^^^^^^^^
-
--  `Embedded Artists LPC4357 Developer Kit <http://www.embeddedartists.com/products/kits/lpc4357_kit.php>`__
--  `Keil MCB1800 Evaluation Board <http://www.keil.com/mcb1800>`__
--  `LPCXpresso18S37 Development Board <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc4000-cortex-m4/lpcxpresso18s37-development-board:OM13076>`__
-
-LPC 51
-^^^^^^
-
--  `LPCXpresso 51U68 <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpcxpresso51u68-for-the-lpc51u68-mcus:OM40005>`__
-
-LPC 54
-^^^^^^
-
--  `LPCXpresso 54114 <https://www.nxp.com/design/microcontrollers-developer-resources/lpcxpresso-boards/lpcxpresso54114-board:OM13089>`__
-
-LPC55
-^^^^^
-
--  `Double M33 Express <https://www.crowdsupply.com/steiert-solutions/double-m33-express>`__
--  `LPCXpresso 55s28 EVK <https://www.nxp.com/design/software/development-software/lpcxpresso55s28-development-board:LPC55S28-EVK>`__
--  `LPCXpresso 55s69 EVK <https://www.nxp.com/design/development-boards/lpcxpresso-boards/lpcxpresso55s69-development-board:LPC55S69-EVK>`__
--  `MCU-Link <https://www.nxp.com/design/development-boards/lpcxpresso-boards/mcu-link-debug-probe:MCU-LINK>`__
-
-Renesas
--------
-
-RA
-^^
-
--  `Evaluation Kit for RA4M1 <https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra4m1-evaluation-kit-ra4m1-mcu-group>`__
--  `Evaluation Kit for RA4M3 <https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ek-ra4m3-evaluation-kit-ra4m3-mcu-group>`__
-
-RX
-^^
-
--  `GR-CITRUS <https://www.renesas.com/us/en/products/gadget-renesas/boards/gr-citrus>`__
--  `Renesas RX65N Target Board <https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus/rtk5rx65n0c00000br-target-board-rx65n>`__
-
-Raspberry Pi RP2040
--------------------
-
--  `Adafruit Feather RP2040 <https://www.adafruit.com/product/4884>`__
--  `Adafruit ItsyBitsy RP2040 <https://www.adafruit.com/product/4888>`__
--  `Adafruit QT Py RP2040 <https://www.adafruit.com/product/4900>`__
--  `Raspberry Pi Pico <https://www.raspberrypi.org/products/raspberry-pi-pico/>`__
-
-Silabs
-------
-
--  `EFM32GG12 Thunderboard Kit (SLTB009A) <https://www.silabs.com/development-tools/thunderboard/thunderboard-gg12-kit>`__
-
-Sony
-----
-
--  `Sony Spresense CXD5602 <https://developer.sony.com/develop/spresense>`__
-
-ST STM32
---------
-
-F0
-^^
--  `STM32 F070rb Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f070rb.html>`__
--  `STM32 F072 Evaluation <https://www.st.com/en/evaluation-tools/stm32072b-eval.html>`__
--  `STM32 F072rb Discovery <https://www.st.com/en/evaluation-tools/32f072bdiscovery.html>`__
-
-F1
-^^
--  `STM32 F103c8 Blue Pill <https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill>`__
--  `STM32 F103rc Mini v2.0 <https://stm32-base.org/boards/STM32F103RCT6-STM32-Mini-V2.0>`__
-
-F2
-^^
--  `STM32 F207zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f207zg.html>`__
-
-F3
-^^
--  `STM32 F303vc Discovery <https://www.st.com/en/evaluation-tools/stm32f3discovery.html>`__
-
-F4
-^^
--  `Adafruit Feather STM32F405 <https://www.adafruit.com/product/4382>`__
--  `Micro Python PyBoard v1.1 <https://store.micropython.org/product/PYBv1.1>`__
--  `STM32 F401cc Black Pill <https://stm32-base.org/boards/STM32F401CCU6-WeAct-Black-Pill-V1.2>`__
--  `STM32 F407vg Discovery <https://www.st.com/en/evaluation-tools/stm32f4discovery.html>`__
--  `STM32 F411ce Black Pill <https://www.adafruit.com/product/4877>`__
--  `STM32 F411ve Discovery <https://www.st.com/en/evaluation-tools/32f411ediscovery.html>`__
--  `STM32 F412zg Discovery <https://www.st.com/en/evaluation-tools/32f412gdiscovery.html>`__
--  `STM32 F412zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f412zg.html>`__
--  `STM32 F439zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f439zi.html>`__
-
-F7
-^^
-
--  `STLink-V3 Mini <https://www.st.com/en/development-tools/stlink-v3mini.html>`__
--  `STM32 F723e Discovery <https://www.st.com/en/evaluation-tools/32f723ediscovery.html>`__
--  `STM32 F746zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f746zg.html>`__
--  `STM32 F746g Discovery <https://www.st.com/en/evaluation-tools/32f746gdiscovery.html>`__
--  `STM32 F767zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f767zi.html>`__
--  `STM32 F769i Discovery <https://www.st.com/en/evaluation-tools/32f769idiscovery.html>`__
-
-H7
-^^
--  `STM32 H743zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-h743zi.html>`__
--  `STM32 H743i Evaluation <https://www.st.com/en/evaluation-tools/stm32h743i-eval.html>`__
--  `STM32 H745i Discovery <https://www.st.com/en/evaluation-tools/stm32h745i-disco.html>`__
--  `Waveshare OpenH743I-C <https://www.waveshare.com/openh743i-c-standard.htm>`__
-
-G4
-^^
--  `STM32 G474RE Nucleo <https://www.st.com/en/evaluation-tools/nucleo-g474re.html>`__
-
-L0
-^^
--  `STM32 L035c8 Discovery <https://www.st.com/en/evaluation-tools/32l0538discovery.html>`__
-
-L4
-^^
--  `STM32 L476vg Discovery <https://www.st.com/en/evaluation-tools/32l476gdiscovery.html>`__
--  `STM32 L4P5zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-l4p5zg.html>`__
--  `STM32 L4R5zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-l4r5zi.html>`__
-
-WB
-^^
--  `STM32 WB55 Nucleo <https://www.st.com/en/evaluation-tools/p-nucleo-wb55.html>`__
-
-TI
---
-
--  `MSP430F5529 USB LaunchPad Evaluation Kit <http://www.ti.com/tool/MSP-EXP430F5529LP>`__
--  `MSP-EXP432E401Y LaunchPad Evaluation Kit <https://www.ti.com/tool/MSP-EXP432E401Y>`__
--  `TM4C123GXL LaunchPad Evaluation Kit <https://www.ti.com/tool/EK-TM4C123GXL>`__
-
-Tomu
-----
-
--  `Fomu <https://www.crowdsupply.com/sutajio-kosagi/fomu>`__
-
-WCH
----
-
--  `CH32V307V-R1-1v0 <https://lcsc.com/product-detail/Development-Boards-Kits_WCH-Jiangsu-Qin-Heng-CH32V307V-EVT-R1_C2943980.html>`__
--  `CH32F205R-R0-1v0 <https://github.com/openwch/ch32f20x/blob/main/EVT/PUB/CH32F20x%20Evaluation%20Board%20Reference-EN.pdf>`__

examples/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 #set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 include(${CMAKE_CURRENT_SOURCE_DIR}/../hw/bsp/family_support.cmake)

examples/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../hw/bsp/BoardPresets.json"
+  ]
+}

examples/build_system/cmake/cpu/cortex-m0.cmake

@@ -1,7 +1,7 @@
 if (TOOLCHAIN STREQUAL "gcc")
   set(TOOLCHAIN_COMMON_FLAGS
     -mthumb
-    -mcpu=cortex-m0plus
+    -mcpu=cortex-m0
     -mfloat-abi=soft
     )
   set(FREERTOS_PORT GCC_ARM_CM0 CACHE INTERNAL "")

examples/build_system/cmake/toolchain/arm_gcc.cmake

@@ -1,3 +1,7 @@
+if (RTOS STREQUAL zephyr)
+  return()
+endif ()
+
 if (NOT DEFINED CMAKE_C_COMPILER)
   set(CMAKE_C_COMPILER "arm-none-eabi-gcc")
 endif ()

examples/build_system/cmake/toolchain/common.cmake

@@ -4,6 +4,7 @@ include(CMakePrintHelpers)
 # Common
 # ----------------------------------------------------------------------------
 set(CMAKE_SYSTEM_NAME Generic)
+set(CMAKE_SYSTEM_PROCESSOR ${CMAKE_SYSTEM_CPU})
 set_property(GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS FALSE)
 
 # Look for includes and libraries only in the target system prefix.
@@ -13,8 +14,8 @@ set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)
 set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
 
 # pass TOOLCHAIN_CPU to
-set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES CMAKE_SYSTEM_PROCESSOR)
-include(${CMAKE_CURRENT_LIST_DIR}/../cpu/${CMAKE_SYSTEM_PROCESSOR}.cmake)
+set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES CMAKE_SYSTEM_PROCESSOR CMAKE_SYSTEM_CPU)
+include(${CMAKE_CURRENT_LIST_DIR}/../cpu/${CMAKE_SYSTEM_CPU}.cmake)
 
 # ----------------------------------------------------------------------------
 # Compile flags

examples/build_system/make/cpu/cortex-m4.mk

@@ -12,8 +12,8 @@ else ifeq ($(TOOLCHAIN),clang)
 	  -mfpu=fpv4-sp-d16 \
 
 else ifeq ($(TOOLCHAIN),iar)
-  CFLAGS += --cpu cortex-m4 --fpu VFPv4
-  ASFLAGS += --cpu cortex-m4 --fpu VFPv4
+  CFLAGS += --cpu cortex-m4 --fpu VFPv4-SP
+  ASFLAGS += --cpu cortex-m4 --fpu VFPv4-SP
 
 else
   $(error "TOOLCHAIN is not supported")

examples/build_system/make/make.mk

@@ -6,7 +6,6 @@
 # Toolchain
 # Can be changed via TOOLCHAIN=gcc|iar or CC=arm-none-eabi-gcc|iccarm|clang
 #-------------------------------------------------------------
-
 ifneq (,$(findstring clang,$(CC)))
   TOOLCHAIN = clang
 else ifneq (,$(findstring iccarm,$(CC)))
@@ -65,7 +64,9 @@ BUILD := _build/$(BOARD)
 PROJECT := $(notdir $(CURDIR))
 BIN := $(TOP)/_bin/$(BOARD)/$(notdir $(CURDIR))
 
-#-------------- Select the board to build for. ------------
+#-------------------------------------------------------------
+# Board / Family
+#-------------------------------------------------------------
 
 # Board without family
 ifneq ($(wildcard $(TOP)/hw/bsp/$(BOARD)/board.mk),)
@@ -93,7 +94,9 @@ else
   SRC_C += $(subst $(TOP)/,,$(wildcard $(TOP)/$(FAMILY_PATH)/*.c))
 endif
 
-#-------------- Source files and compiler flags --------------
+#-------------------------------------------------------------
+# Source files and compiler flags
+#-------------------------------------------------------------
 # tinyusb makefile
 include $(TOP)/src/tinyusb.mk
 SRC_C += $(TINYUSB_SRC_C)
@@ -148,7 +151,37 @@ endif
 # toolchain specific
 include ${TOP}/examples/build_system/make/toolchain/arm_$(TOOLCHAIN).mk
 
-# Handy check parameter function
+#---------------------- FreeRTOS -----------------------
+FREERTOS_SRC = lib/FreeRTOS-Kernel
+FREERTOS_PORTABLE_PATH = $(FREERTOS_SRC)/portable/$(if $(findstring iar,$(TOOLCHAIN)),IAR,GCC)
+
+ifeq ($(RTOS),freertos)
+	SRC_C += \
+		$(FREERTOS_SRC)/list.c \
+		$(FREERTOS_SRC)/queue.c \
+		$(FREERTOS_SRC)/tasks.c \
+		$(FREERTOS_SRC)/timers.c \
+		$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.c))
+
+	SRC_S += $(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.s))
+	INC += \
+		$(TOP)/hw/bsp/$(FAMILY)/FreeRTOSConfig \
+		$(TOP)/$(FREERTOS_SRC)/include \
+		$(TOP)/$(FREERTOS_PORTABLE_SRC)
+
+	CFLAGS += -DCFG_TUSB_OS=OPT_OS_FREERTOS
+
+	# Suppress FreeRTOSConfig.h warnings
+	CFLAGS_GCC += -Wno-error=redundant-decls
+
+	# Suppress FreeRTOS source warnings
+	CFLAGS_GCC += -Wno-error=cast-qual
+
+	# FreeRTOS (lto + Os) linker issue
+	LDFLAGS_GCC += -Wl,--undefined=vTaskSwitchContext
+endif
+
+#---------------- Helper ----------------
 check_defined = \
     $(strip $(foreach 1,$1, \
     $(call __check_defined,$1,$(strip $(value 2)))))

examples/device/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../hw/bsp/family_support.cmake)
 

examples/device/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/audio_4_channel_mic/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/audio_4_channel_mic/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/audio_4_channel_mic_freertos/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/audio_4_channel_mic_freertos/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/audio_4_channel_mic_freertos/Makefile

@@ -1,14 +1,9 @@
+RTOS = freertos
 include ../../build_system/make/make.mk
 
-FREERTOS_SRC = lib/FreeRTOS-Kernel
-FREERTOS_PORTABLE_PATH = $(FREERTOS_SRC)/portable/$(if $(findstring iar,$(TOOLCHAIN)),IAR,GCC)
-
 INC += \
 	src \
-	src/FreeRTOSConfig \
 	$(TOP)/hw \
-	$(TOP)/$(FREERTOS_SRC)/include \
-	$(TOP)/$(FREERTOS_PORTABLE_SRC) \
 
 # Example source
 EXAMPLE_SOURCE = \
@@ -17,21 +12,4 @@ EXAMPLE_SOURCE = \
 
 SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
 
-# FreeRTOS source, all files in port folder
-SRC_C += \
-	$(FREERTOS_SRC)/list.c \
-	$(FREERTOS_SRC)/queue.c \
-	$(FREERTOS_SRC)/tasks.c \
-	$(FREERTOS_SRC)/timers.c \
-	$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.c))
-
-SRC_S += \
-	$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.s))
-
-# Suppress FreeRTOS warnings
-CFLAGS += -Wno-error=cast-qual -Wno-error=redundant-decls
-
-# FreeRTOS (lto + Os) linker issue
-LDFLAGS += -Wl,--undefined=vTaskSwitchContext
-
 include ../../build_system/make/rules.mk

examples/device/audio_4_channel_mic_freertos/src/FreeRTOSConfig/FreeRTOSConfig.h

@@ -1,191 +0,0 @@
-/*
- * FreeRTOS Kernel V10.0.0
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software. If you wish to use our Amazon
- * FreeRTOS name, please do so in a fair use way that does not cause confusion.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * http://www.FreeRTOS.org
- * http://aws.amazon.com/freertos
- *
- * 1 tab == 4 spaces!
- */
-
-
-#ifndef FREERTOS_CONFIG_H
-#define FREERTOS_CONFIG_H
-
-/*-----------------------------------------------------------
- * Application specific definitions.
- *
- * These definitions should be adjusted for your particular hardware and
- * application requirements.
- *
- * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
- * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
- *
- * See http://www.freertos.org/a00110.html.
- *----------------------------------------------------------*/
-
-// skip if included from IAR assembler
-#ifndef __IASMARM__
-
-// Include MCU header
-#include "bsp/board_mcu.h"
-
-#if TUSB_MCU_VENDOR_ESPRESSIF
-  #error "ESP32-Sx should use IDF's FreeRTOSConfig.h"
-#endif
-
-// TODO fix later
-#if CFG_TUSB_MCU == OPT_MCU_MM32F327X
-  extern u32 SystemCoreClock;
-#else
-  // FIXME cause redundant-decls warnings
-  extern uint32_t SystemCoreClock;
-#endif
-
-#endif
-
-/* Cortex M23/M33 port configuration. */
-#define configENABLE_MPU								        0
-#define configENABLE_FPU								        1
-#define configENABLE_TRUSTZONE					        0
-#define configMINIMAL_SECURE_STACK_SIZE					( 1024 )
-#define configRUN_FREERTOS_SECURE_ONLY          1
-
-#define configUSE_PREEMPTION                    1
-#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
-#define configCPU_CLOCK_HZ                      SystemCoreClock
-#define configTICK_RATE_HZ                      ( 1000 )
-#define configMAX_PRIORITIES                    ( 5 )
-#define configMINIMAL_STACK_SIZE                ( 128 )
-#define configTOTAL_HEAP_SIZE                   ( configSUPPORT_DYNAMIC_ALLOCATION*4*1024 )
-#define configMAX_TASK_NAME_LEN                 16
-#define configUSE_16_BIT_TICKS                  0
-#define configIDLE_SHOULD_YIELD                 1
-#define configUSE_MUTEXES                       1
-#define configUSE_RECURSIVE_MUTEXES             1
-#define configUSE_COUNTING_SEMAPHORES           1
-#define configQUEUE_REGISTRY_SIZE               4
-#define configUSE_QUEUE_SETS                    0
-#define configUSE_TIME_SLICING                  0
-#define configUSE_NEWLIB_REENTRANT              0
-#define configENABLE_BACKWARD_COMPATIBILITY     1
-#define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP   0
-
-#define configSUPPORT_STATIC_ALLOCATION         1
-#define configSUPPORT_DYNAMIC_ALLOCATION        0
-
-/* Hook function related definitions. */
-#define configUSE_IDLE_HOOK                    0
-#define configUSE_TICK_HOOK                    0
-#define configUSE_MALLOC_FAILED_HOOK           0 // cause nested extern warning
-#define configCHECK_FOR_STACK_OVERFLOW         2
-#define configCHECK_HANDLER_INSTALLATION       0
-
-/* Run time and task stats gathering related definitions. */
-#define configGENERATE_RUN_TIME_STATS          0
-#define configUSE_TRACE_FACILITY               1 // legacy trace
-#define configUSE_STATS_FORMATTING_FUNCTIONS   0
-
-/* Co-routine definitions. */
-#define configUSE_CO_ROUTINES                  0
-#define configMAX_CO_ROUTINE_PRIORITIES        2
-
-/* Software timer related definitions. */
-#define configUSE_TIMERS                       1
-#define configTIMER_TASK_PRIORITY              (configMAX_PRIORITIES-2)
-#define configTIMER_QUEUE_LENGTH               32
-#define configTIMER_TASK_STACK_DEPTH           configMINIMAL_STACK_SIZE
-
-/* Optional functions - most linkers will remove unused functions anyway. */
-#define INCLUDE_vTaskPrioritySet               0
-#define INCLUDE_uxTaskPriorityGet              0
-#define INCLUDE_vTaskDelete                    0
-#define INCLUDE_vTaskSuspend                   1 // required for queue, semaphore, mutex to be blocked indefinitely with portMAX_DELAY
-#define INCLUDE_xResumeFromISR                 0
-#define INCLUDE_vTaskDelayUntil                1
-#define INCLUDE_vTaskDelay                     1
-#define INCLUDE_xTaskGetSchedulerState         0
-#define INCLUDE_xTaskGetCurrentTaskHandle      0
-#define INCLUDE_uxTaskGetStackHighWaterMark    0
-#define INCLUDE_xTaskGetIdleTaskHandle         0
-#define INCLUDE_xTimerGetTimerDaemonTaskHandle 0
-#define INCLUDE_pcTaskGetTaskName              0
-#define INCLUDE_eTaskGetState                  0
-#define INCLUDE_xEventGroupSetBitFromISR       0
-#define INCLUDE_xTimerPendFunctionCall         0
-
-#ifdef __RX__
-/* Renesas RX series */
-#define vSoftwareInterruptISR					        INT_Excep_ICU_SWINT
-#define vTickISR								              INT_Excep_CMT0_CMI0
-#define configPERIPHERAL_CLOCK_HZ				      (configCPU_CLOCK_HZ/2)
-#define configKERNEL_INTERRUPT_PRIORITY			  1
-#define configMAX_SYSCALL_INTERRUPT_PRIORITY	4
-
-#else
-
-/* FreeRTOS hooks to NVIC vectors */
-#define xPortPendSVHandler    PendSV_Handler
-#define xPortSysTickHandler   SysTick_Handler
-#define vPortSVCHandler       SVC_Handler
-
-//--------------------------------------------------------------------+
-// Interrupt nesting behavior configuration.
-//--------------------------------------------------------------------+
-#if defined(__NVIC_PRIO_BITS)
-  // For Cortex-M specific: __NVIC_PRIO_BITS is defined in core_cmx.h
-	#define configPRIO_BITS       __NVIC_PRIO_BITS
-
-#elif defined(__ECLIC_INTCTLBITS)
-  // RISC-V Bumblebee core from nuclei
-  #define configPRIO_BITS       __ECLIC_INTCTLBITS
-
-#elif defined(__IASMARM__)
-  // FIXME: IAR Assembler cannot include mcu header directly to get __NVIC_PRIO_BITS.
-  // Therefore we will hard coded it to minimum value of 2 to get pass ci build.
-  // IAR user must update this to correct value of the target MCU
-  #message "configPRIO_BITS is hard coded to 2 to pass IAR build only. User should update it per MCU"
-  #define configPRIO_BITS       2
-
-#else
-  #error "FreeRTOS configPRIO_BITS to be defined"
-#endif
-
-/* The lowest interrupt priority that can be used in a call to a "set priority" function. */
-#define configLIBRARY_LOWEST_INTERRUPT_PRIORITY			  ((1<<configPRIO_BITS) - 1)
-
-/* The highest interrupt priority that can be used by any interrupt service
-routine that makes calls to interrupt safe FreeRTOS API functions.  DO NOT CALL
-INTERRUPT SAFE FREERTOS API FUNCTIONS FROM ANY INTERRUPT THAT HAS A HIGHER
-PRIORITY THAN THIS! (higher priorities are lower numeric values. */
-#define configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY	2
-
-/* Interrupt priorities used by the kernel port layer itself.  These are generic
-to all Cortex-M ports, and do not rely on any particular library functions. */
-#define configKERNEL_INTERRUPT_PRIORITY 		          ( configLIBRARY_LOWEST_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
-
-/* !!!! configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to zero !!!!
-See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html. */
-#define configMAX_SYSCALL_INTERRUPT_PRIORITY 	        ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
-
-#endif
-
-#endif /* __FREERTOS_CONFIG__H */

examples/device/audio_test/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/audio_test/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/audio_test_freertos/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/audio_test_freertos/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/audio_test_freertos/Makefile

@@ -1,14 +1,9 @@
+RTOS = freertos
 include ../../build_system/make/make.mk
 
-FREERTOS_SRC = lib/FreeRTOS-Kernel
-FREERTOS_PORTABLE_PATH = $(FREERTOS_SRC)/portable/$(if $(findstring iar,$(TOOLCHAIN)),IAR,GCC)
-
 INC += \
 	src \
-	src/FreeRTOSConfig \
 	$(TOP)/hw \
-	$(TOP)/$(FREERTOS_SRC)/include \
-	$(TOP)/$(FREERTOS_PORTABLE_SRC) \
 
 # Example source
 EXAMPLE_SOURCE = \
@@ -17,21 +12,4 @@ EXAMPLE_SOURCE = \
 
 SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
 
-# FreeRTOS source, all files in port folder
-SRC_C += \
-	$(FREERTOS_SRC)/list.c \
-	$(FREERTOS_SRC)/queue.c \
-	$(FREERTOS_SRC)/tasks.c \
-	$(FREERTOS_SRC)/timers.c \
-	$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.c))
-
-SRC_S += \
-	$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.s))
-
-# Suppress FreeRTOS warnings
-CFLAGS += -Wno-error=cast-qual -Wno-error=redundant-decls
-
-# FreeRTOS (lto + Os) linker issue
-LDFLAGS += -Wl,--undefined=vTaskSwitchContext
-
 include ../../build_system/make/rules.mk

examples/device/audio_test_freertos/src/FreeRTOSConfig/FreeRTOSConfig.h

@@ -1,191 +0,0 @@
-/*
- * FreeRTOS Kernel V10.0.0
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software. If you wish to use our Amazon
- * FreeRTOS name, please do so in a fair use way that does not cause confusion.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * http://www.FreeRTOS.org
- * http://aws.amazon.com/freertos
- *
- * 1 tab == 4 spaces!
- */
-
-
-#ifndef FREERTOS_CONFIG_H
-#define FREERTOS_CONFIG_H
-
-/*-----------------------------------------------------------
- * Application specific definitions.
- *
- * These definitions should be adjusted for your particular hardware and
- * application requirements.
- *
- * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
- * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
- *
- * See http://www.freertos.org/a00110.html.
- *----------------------------------------------------------*/
-
-// skip if included from IAR assembler
-#ifndef __IASMARM__
-
-// Include MCU header
-#include "bsp/board_mcu.h"
-
-#if TUSB_MCU_VENDOR_ESPRESSIF
-  #error "ESP32-Sx should use IDF's FreeRTOSConfig.h"
-#endif
-
-// TODO fix later
-#if CFG_TUSB_MCU == OPT_MCU_MM32F327X
-  extern u32 SystemCoreClock;
-#else
-  // FIXME cause redundant-decls warnings
-  extern uint32_t SystemCoreClock;
-#endif
-
-#endif
-
-/* Cortex M23/M33 port configuration. */
-#define configENABLE_MPU								        0
-#define configENABLE_FPU								        1
-#define configENABLE_TRUSTZONE					        0
-#define configMINIMAL_SECURE_STACK_SIZE					( 1024 )
-#define configRUN_FREERTOS_SECURE_ONLY          1
-
-#define configUSE_PREEMPTION                    1
-#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
-#define configCPU_CLOCK_HZ                      SystemCoreClock
-#define configTICK_RATE_HZ                      ( 1000 )
-#define configMAX_PRIORITIES                    ( 5 )
-#define configMINIMAL_STACK_SIZE                ( 128 )
-#define configTOTAL_HEAP_SIZE                   ( configSUPPORT_DYNAMIC_ALLOCATION*4*1024 )
-#define configMAX_TASK_NAME_LEN                 16
-#define configUSE_16_BIT_TICKS                  0
-#define configIDLE_SHOULD_YIELD                 1
-#define configUSE_MUTEXES                       1
-#define configUSE_RECURSIVE_MUTEXES             1
-#define configUSE_COUNTING_SEMAPHORES           1
-#define configQUEUE_REGISTRY_SIZE               4
-#define configUSE_QUEUE_SETS                    0
-#define configUSE_TIME_SLICING                  0
-#define configUSE_NEWLIB_REENTRANT              0
-#define configENABLE_BACKWARD_COMPATIBILITY     1
-#define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP   0
-
-#define configSUPPORT_STATIC_ALLOCATION         1
-#define configSUPPORT_DYNAMIC_ALLOCATION        0
-
-/* Hook function related definitions. */
-#define configUSE_IDLE_HOOK                    0
-#define configUSE_TICK_HOOK                    0
-#define configUSE_MALLOC_FAILED_HOOK           0 // cause nested extern warning
-#define configCHECK_FOR_STACK_OVERFLOW         2
-#define configCHECK_HANDLER_INSTALLATION       0
-
-/* Run time and task stats gathering related definitions. */
-#define configGENERATE_RUN_TIME_STATS          0
-#define configUSE_TRACE_FACILITY               1 // legacy trace
-#define configUSE_STATS_FORMATTING_FUNCTIONS   0
-
-/* Co-routine definitions. */
-#define configUSE_CO_ROUTINES                  0
-#define configMAX_CO_ROUTINE_PRIORITIES        2
-
-/* Software timer related definitions. */
-#define configUSE_TIMERS                       1
-#define configTIMER_TASK_PRIORITY              (configMAX_PRIORITIES-2)
-#define configTIMER_QUEUE_LENGTH               32
-#define configTIMER_TASK_STACK_DEPTH           configMINIMAL_STACK_SIZE
-
-/* Optional functions - most linkers will remove unused functions anyway. */
-#define INCLUDE_vTaskPrioritySet               0
-#define INCLUDE_uxTaskPriorityGet              0
-#define INCLUDE_vTaskDelete                    0
-#define INCLUDE_vTaskSuspend                   1 // required for queue, semaphore, mutex to be blocked indefinitely with portMAX_DELAY
-#define INCLUDE_xResumeFromISR                 0
-#define INCLUDE_vTaskDelayUntil                1
-#define INCLUDE_vTaskDelay                     1
-#define INCLUDE_xTaskGetSchedulerState         0
-#define INCLUDE_xTaskGetCurrentTaskHandle      0
-#define INCLUDE_uxTaskGetStackHighWaterMark    0
-#define INCLUDE_xTaskGetIdleTaskHandle         0
-#define INCLUDE_xTimerGetTimerDaemonTaskHandle 0
-#define INCLUDE_pcTaskGetTaskName              0
-#define INCLUDE_eTaskGetState                  0
-#define INCLUDE_xEventGroupSetBitFromISR       0
-#define INCLUDE_xTimerPendFunctionCall         0
-
-#ifdef __RX__
-/* Renesas RX series */
-#define vSoftwareInterruptISR					        INT_Excep_ICU_SWINT
-#define vTickISR								              INT_Excep_CMT0_CMI0
-#define configPERIPHERAL_CLOCK_HZ				      (configCPU_CLOCK_HZ/2)
-#define configKERNEL_INTERRUPT_PRIORITY			  1
-#define configMAX_SYSCALL_INTERRUPT_PRIORITY	4
-
-#else
-
-/* FreeRTOS hooks to NVIC vectors */
-#define xPortPendSVHandler    PendSV_Handler
-#define xPortSysTickHandler   SysTick_Handler
-#define vPortSVCHandler       SVC_Handler
-
-//--------------------------------------------------------------------+
-// Interrupt nesting behavior configuration.
-//--------------------------------------------------------------------+
-#if defined(__NVIC_PRIO_BITS)
-  // For Cortex-M specific: __NVIC_PRIO_BITS is defined in core_cmx.h
-	#define configPRIO_BITS       __NVIC_PRIO_BITS
-
-#elif defined(__ECLIC_INTCTLBITS)
-  // RISC-V Bumblebee core from nuclei
-  #define configPRIO_BITS       __ECLIC_INTCTLBITS
-
-#elif defined(__IASMARM__)
-  // FIXME: IAR Assembler cannot include mcu header directly to get __NVIC_PRIO_BITS.
-  // Therefore we will hard coded it to minimum value of 2 to get pass ci build.
-  // IAR user must update this to correct value of the target MCU
-  #message "configPRIO_BITS is hard coded to 2 to pass IAR build only. User should update it per MCU"
-  #define configPRIO_BITS       2
-
-#else
-  #error "FreeRTOS configPRIO_BITS to be defined"
-#endif
-
-/* The lowest interrupt priority that can be used in a call to a "set priority" function. */
-#define configLIBRARY_LOWEST_INTERRUPT_PRIORITY			  ((1<<configPRIO_BITS) - 1)
-
-/* The highest interrupt priority that can be used by any interrupt service
-routine that makes calls to interrupt safe FreeRTOS API functions.  DO NOT CALL
-INTERRUPT SAFE FREERTOS API FUNCTIONS FROM ANY INTERRUPT THAT HAS A HIGHER
-PRIORITY THAN THIS! (higher priorities are lower numeric values. */
-#define configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY	2
-
-/* Interrupt priorities used by the kernel port layer itself.  These are generic
-to all Cortex-M ports, and do not rely on any particular library functions. */
-#define configKERNEL_INTERRUPT_PRIORITY 		          ( configLIBRARY_LOWEST_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
-
-/* !!!! configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to zero !!!!
-See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html. */
-#define configMAX_SYSCALL_INTERRUPT_PRIORITY 	        ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
-
-#endif
-
-#endif /* __FREERTOS_CONFIG__H */

examples/device/audio_test_multi_rate/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/audio_test_multi_rate/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/board_test/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 
@@ -15,18 +15,23 @@ if(FAMILY STREQUAL "espressif")
   return()
 endif()
 
-add_executable(${PROJECT})
+if (RTOS STREQUAL zephyr)
+  set(EXE_NAME app)
+else()
+  set(EXE_NAME ${PROJECT})
+  add_executable(${EXE_NAME})
+endif()
 
 # Example source
-target_sources(${PROJECT} PUBLIC
+target_sources(${EXE_NAME} PRIVATE
   ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c
   )
 
 # Example include
-target_include_directories(${PROJECT} PUBLIC
+target_include_directories(${EXE_NAME} PUBLIC
   ${CMAKE_CURRENT_SOURCE_DIR}/src
   )
 
 # Configure compilation flags and libraries for the example without RTOS.
 # See the corresponding function in hw/bsp/FAMILY/family.cmake for details.
-family_configure_device_example(${PROJECT} noos)
+family_configure_device_example(${EXE_NAME} ${RTOS})

examples/device/board_test/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/cdc_dual_ports/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/cdc_dual_ports/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/cdc_msc/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 #set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
@@ -16,20 +16,25 @@ if(FAMILY STREQUAL "espressif")
   return()
 endif()
 
-add_executable(${PROJECT})
+if (RTOS STREQUAL zephyr)
+  set(EXE_NAME app)
+else()
+  set(EXE_NAME ${PROJECT})
+  add_executable(${EXE_NAME})
+endif()
 
 # Example source
-target_sources(${PROJECT} PUBLIC
+target_sources(${EXE_NAME} PRIVATE
   ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c
   ${CMAKE_CURRENT_SOURCE_DIR}/src/msc_disk.c
   ${CMAKE_CURRENT_SOURCE_DIR}/src/usb_descriptors.c
   )
 
 # Example include
-target_include_directories(${PROJECT} PUBLIC
+target_include_directories(${EXE_NAME} PUBLIC
   ${CMAKE_CURRENT_SOURCE_DIR}/src
   )
 
-# Configure compilation flags and libraries for the example... see the corresponding function
-# in hw/bsp/FAMILY/family.cmake for details.
-family_configure_device_example(${PROJECT} noos)
+# Configure compilation flags and libraries for the example without RTOS.
+# See the corresponding function in hw/bsp/FAMILY/family.cmake for details.
+family_configure_device_example(${EXE_NAME} ${RTOS})

examples/device/cdc_msc/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/cdc_msc/prj.conf

@@ -0,0 +1,6 @@
+CONFIG_GPIO=y
+CONFIG_FPU=y
+CONFIG_NO_OPTIMIZATIONS=y
+CONFIG_UART_INTERRUPT_DRIVEN=y
+CONFIG_NRFX_POWER=y
+CONFIG_NRFX_UARTE0=y

examples/device/cdc_msc/src/msc_disk.c

@@ -40,17 +40,15 @@ static bool ejected = false;
 If you find any bugs or get any questions, feel free to file an\r\n\
 issue at github.com/hathach/tinyusb"
 
-enum
-{
-  DISK_BLOCK_NUM  = 16, // 8KB is the smallest size that windows allow to mount
+enum {
+  DISK_BLOCK_NUM = 16,// 8KB is the smallest size that windows allow to mount
   DISK_BLOCK_SIZE = 512
 };
 
 #ifdef CFG_EXAMPLE_MSC_READONLY
 const
 #endif
-uint8_t msc_disk[DISK_BLOCK_NUM][DISK_BLOCK_SIZE] =
-{
+uint8_t msc_disk[DISK_BLOCK_NUM][DISK_BLOCK_SIZE] = {
   //------------- Block0: Boot Sector -------------//
   // byte_per_sector    = DISK_BLOCK_SIZE; fat12_sector_num_16  = DISK_BLOCK_NUM;
   // sector_per_cluster = 1; reserved_sectors = 1;
@@ -59,11 +57,11 @@ uint8_t msc_disk[DISK_BLOCK_NUM][DISK_BLOCK_SIZE] =
   // drive_number       = 0x80; media_type = 0xf8; extended_boot_signature = 0x29;
   // filesystem_type    = "FAT12   "; volume_serial_number = 0x1234; volume_label = "TinyUSB MSC";
   // FAT magic code at offset 510-511
-  {
+{
     0xEB, 0x3C, 0x90, 0x4D, 0x53, 0x44, 0x4F, 0x53, 0x35, 0x2E, 0x30, 0x00, 0x02, 0x01, 0x01, 0x00,
     0x01, 0x10, 0x00, 0x10, 0x00, 0xF8, 0x01, 0x00, 0x01, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00,
-      0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x29, 0x34, 0x12, 0x00, 0x00, 'T' , 'i' , 'n' , 'y' , 'U' ,
-      'S' , 'B' , ' ' , 'M' , 'S' , 'C' , 0x46, 0x41, 0x54, 0x31, 0x32, 0x20, 0x20, 0x20, 0x00, 0x00,
+    0x00, 0x00, 0x00, 0x00, 0x80, 0x00, 0x29, 0x34, 0x12, 0x00, 0x00, 'T', 'i', 'n', 'y', 'U',
+    'S', 'B', ' ', 'M', 'S', 'C', 0x46, 0x41, 0x54, 0x31, 0x32, 0x20, 0x20, 0x20, 0x00, 0x00,
 
     // Zero up to 2 last bytes of FAT magic code
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
@@ -96,23 +94,22 @@ uint8_t msc_disk[DISK_BLOCK_NUM][DISK_BLOCK_SIZE] =
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-      0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x55, 0xAA
-  },
+    0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x55, 0xAA},
 
   //------------- Block1: FAT12 Table -------------//
-  {
-      0xF8, 0xFF, 0xFF, 0xFF, 0x0F // // first 2 entries must be F8FF, third entry is cluster end of readme file
+{
+      0xF8, 0xFF, 0xFF, 0xFF, 0x0F// // first 2 entries must be F8FF, third entry is cluster end of readme file
   },
 
   //------------- Block2: Root Directory -------------//
-  {
+{
     // first entry is volume label
-      'T' , 'i' , 'n' , 'y' , 'U' , 'S' , 'B' , ' ' , 'M' , 'S' , 'C' , 0x08, 0x00, 0x00, 0x00, 0x00,
+    'T', 'i', 'n', 'y', 'U', 'S', 'B', ' ', 'M', 'S', 'C', 0x08, 0x00, 0x00, 0x00, 0x00,
     0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x4F, 0x6D, 0x65, 0x43, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
     // second entry is readme file
-      'R' , 'E' , 'A' , 'D' , 'M' , 'E' , ' ' , ' ' , 'T' , 'X' , 'T' , 0x20, 0x00, 0xC6, 0x52, 0x6D,
+    'R', 'E', 'A', 'D', 'M', 'E', ' ', ' ', 'T', 'X', 'T', 0x20, 0x00, 0xC6, 0x52, 0x6D,
     0x65, 0x43, 0x65, 0x43, 0x00, 0x00, 0x88, 0x6D, 0x65, 0x43, 0x02, 0x00,
-      sizeof(README_CONTENTS)-1, 0x00, 0x00, 0x00 // readme's files size (4 Bytes)
+    sizeof(README_CONTENTS) - 1, 0x00, 0x00, 0x00// readme's files size (4 Bytes)
   },
 
   //------------- Block3: Readme Content -------------//
@@ -121,23 +118,21 @@ uint8_t msc_disk[DISK_BLOCK_NUM][DISK_BLOCK_SIZE] =
 
 // Invoked when received SCSI_CMD_INQUIRY
 // Application fill vendor id, product id and revision with string up to 8, 16, 4 characters respectively
-void tud_msc_inquiry_cb(uint8_t lun, uint8_t vendor_id[8], uint8_t product_id[16], uint8_t product_rev[4])
-{
+void tud_msc_inquiry_cb(uint8_t lun, uint8_t vendor_id[8], uint8_t product_id[16], uint8_t product_rev[4]) {
   (void) lun;
 
   const char vid[] = "TinyUSB";
   const char pid[] = "Mass Storage";
   const char rev[] = "1.0";
 
-  memcpy(vendor_id  , vid, strlen(vid));
-  memcpy(product_id , pid, strlen(pid));
+  memcpy(vendor_id, vid, strlen(vid));
+  memcpy(product_id, pid, strlen(pid));
   memcpy(product_rev, rev, strlen(rev));
 }
 
 // Invoked when received Test Unit Ready command.
 // return true allowing host to read/write this LUN e.g SD card inserted
-bool tud_msc_test_unit_ready_cb(uint8_t lun)
-{
+bool tud_msc_test_unit_ready_cb(uint8_t lun) {
   (void) lun;
 
   // RAM disk is ready until ejected
@@ -152,8 +147,7 @@ bool tud_msc_test_unit_ready_cb(uint8_t lun)
 
 // Invoked when received SCSI_CMD_READ_CAPACITY_10 and SCSI_CMD_READ_FORMAT_CAPACITY to determine the disk size
 // Application update block count and block size
-void tud_msc_capacity_cb(uint8_t lun, uint32_t* block_count, uint16_t* block_size)
-{
+void tud_msc_capacity_cb(uint8_t lun, uint32_t *block_count, uint16_t *block_size) {
   (void) lun;
 
   *block_count = DISK_BLOCK_NUM;
@@ -163,18 +157,14 @@ void tud_msc_capacity_cb(uint8_t lun, uint32_t* block_count, uint16_t* block_siz
 // Invoked when received Start Stop Unit command
 // - Start = 0 : stopped power mode, if load_eject = 1 : unload disk storage
 // - Start = 1 : active mode, if load_eject = 1 : load disk storage
-bool tud_msc_start_stop_cb(uint8_t lun, uint8_t power_condition, bool start, bool load_eject)
-{
+bool tud_msc_start_stop_cb(uint8_t lun, uint8_t power_condition, bool start, bool load_eject) {
   (void) lun;
   (void) power_condition;
 
-  if ( load_eject )
-  {
-    if (start)
-    {
+  if (load_eject) {
+    if (start) {
       // load disk storage
-    }else
-    {
+    } else {
       // unload disk storage
       ejected = true;
     }
@@ -185,45 +175,51 @@ bool tud_msc_start_stop_cb(uint8_t lun, uint8_t power_condition, bool start, boo
 
 // Callback invoked when received READ10 command.
 // Copy disk's data to buffer (up to bufsize) and return number of copied bytes.
-int32_t tud_msc_read10_cb(uint8_t lun, uint32_t lba, uint32_t offset, void* buffer, uint32_t bufsize)
-{
+int32_t tud_msc_read10_cb(uint8_t lun, uint32_t lba, uint32_t offset, void *buffer, uint32_t bufsize) {
   (void) lun;
 
   // out of ramdisk
-  if ( lba >= DISK_BLOCK_NUM ) return -1;
+  if (lba >= DISK_BLOCK_NUM) {
+    return -1;
+  }
 
-  uint8_t const* addr = msc_disk[lba] + offset;
+  // Check for overflow of offset + bufsize
+  if (offset + bufsize > DISK_BLOCK_SIZE) {
+    return -1;
+  }
+
+  uint8_t const *addr = msc_disk[lba] + offset;
   memcpy(buffer, addr, bufsize);
 
   return (int32_t) bufsize;
 }
 
-bool tud_msc_is_writable_cb (uint8_t lun)
-{
+bool tud_msc_is_writable_cb(uint8_t lun) {
   (void) lun;
 
-#ifdef CFG_EXAMPLE_MSC_READONLY
+  #ifdef CFG_EXAMPLE_MSC_READONLY
   return false;
-#else
+  #else
   return true;
-#endif
+  #endif
 }
 
 // Callback invoked when received WRITE10 command.
 // Process data in buffer to disk's storage and return number of written bytes
-int32_t tud_msc_write10_cb(uint8_t lun, uint32_t lba, uint32_t offset, uint8_t* buffer, uint32_t bufsize)
-{
+int32_t tud_msc_write10_cb(uint8_t lun, uint32_t lba, uint32_t offset, uint8_t *buffer, uint32_t bufsize) {
   (void) lun;
 
   // out of ramdisk
-  if ( lba >= DISK_BLOCK_NUM ) return -1;
+  if (lba >= DISK_BLOCK_NUM) return -1;
 
-#ifndef CFG_EXAMPLE_MSC_READONLY
-  uint8_t* addr = msc_disk[lba] + offset;
+  #ifndef CFG_EXAMPLE_MSC_READONLY
+  uint8_t *addr = msc_disk[lba] + offset;
   memcpy(addr, buffer, bufsize);
-#else
-  (void) lba; (void) offset; (void) buffer;
-#endif
+  #else
+  (void) lba;
+  (void) offset;
+  (void) buffer;
+  #endif
 
   return (int32_t) bufsize;
 }
@@ -231,42 +227,18 @@ int32_t tud_msc_write10_cb(uint8_t lun, uint32_t lba, uint32_t offset, uint8_t*
 // Callback invoked when received an SCSI command not in built-in list below
 // - READ_CAPACITY10, READ_FORMAT_CAPACITY, INQUIRY, MODE_SENSE6, REQUEST_SENSE
 // - READ10 and WRITE10 has their own callbacks
-int32_t tud_msc_scsi_cb (uint8_t lun, uint8_t const scsi_cmd[16], void* buffer, uint16_t bufsize)
-{
-  // read10 & write10 has their own callback and MUST not be handled here
+int32_t tud_msc_scsi_cb(uint8_t lun, uint8_t const scsi_cmd[16], void *buffer, uint16_t bufsize) {
+  (void) buffer;
+  (void) bufsize;
 
-  void const* response = NULL;
-  int32_t resplen = 0;
-
-  // most scsi handled is input
-  bool in_xfer = true;
-
-  switch (scsi_cmd[0])
-  {
+  switch (scsi_cmd[0]) {
     default:
       // Set Sense = Invalid Command Operation
       tud_msc_set_sense(lun, SCSI_SENSE_ILLEGAL_REQUEST, 0x20, 0x00);
 
       // negative means error -> tinyusb could stall and/or response with failed status
-      resplen = -1;
-    break;
+      return -1;
   }
-
-  // return resplen must not larger than bufsize
-  if ( resplen > bufsize ) resplen = bufsize;
-
-  if ( response && (resplen > 0) )
-  {
-    if(in_xfer)
-    {
-      memcpy(buffer, response, (size_t) resplen);
-    }else
-    {
-      // SCSI output
-    }
-  }
-
-  return (int32_t) resplen;
 }
 
 #endif

examples/device/cdc_msc_freertos/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/cdc_msc_freertos/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/cdc_msc_freertos/Makefile

@@ -1,14 +1,9 @@
+RTOS = freertos
 include ../../build_system/make/make.mk
 
-FREERTOS_SRC = lib/FreeRTOS-Kernel
-FREERTOS_PORTABLE_PATH = $(FREERTOS_SRC)/portable/$(if $(findstring iar,$(TOOLCHAIN)),IAR,GCC)
-
 INC += \
 	src \
-	src/FreeRTOSConfig \
 	$(TOP)/hw \
-	$(TOP)/$(FREERTOS_SRC)/include \
-	$(TOP)/$(FREERTOS_PORTABLE_SRC) \
 
 # Example source
 EXAMPLE_SOURCE = \
@@ -18,28 +13,4 @@ EXAMPLE_SOURCE = \
 
 SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
 
-# FreeRTOS source, all files in port folder
-SRC_C += \
-	$(FREERTOS_SRC)/list.c \
-	$(FREERTOS_SRC)/queue.c \
-	$(FREERTOS_SRC)/tasks.c \
-	$(FREERTOS_SRC)/timers.c \
-	$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.c))
-
-SRC_S += \
-	$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.s))
-
-# include heap manage if configSUPPORT_DYNAMIC_ALLOCATION = 1
-# SRC_C += $(FREERTOS_SRC)/portable/MemMang/heap_1.c
-# CFLAGS += -Wno-error=sign-compare
-
-# Suppress FreeRTOSConfig.h warnings
-CFLAGS_GCC += -Wno-error=redundant-decls
-
-# Suppress FreeRTOS source warnings
-CFLAGS_GCC += -Wno-error=cast-qual
-
-# FreeRTOS (lto + Os) linker issue
-LDFLAGS_GCC += -Wl,--undefined=vTaskSwitchContext
-
 include ../../build_system/make/rules.mk

examples/device/cdc_msc_freertos/src/FreeRTOSConfig/FreeRTOSConfig.h

@@ -1,191 +0,0 @@
-/*
- * FreeRTOS Kernel V10.0.0
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software. If you wish to use our Amazon
- * FreeRTOS name, please do so in a fair use way that does not cause confusion.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * http://www.FreeRTOS.org
- * http://aws.amazon.com/freertos
- *
- * 1 tab == 4 spaces!
- */
-
-
-#ifndef FREERTOS_CONFIG_H
-#define FREERTOS_CONFIG_H
-
-/*-----------------------------------------------------------
- * Application specific definitions.
- *
- * These definitions should be adjusted for your particular hardware and
- * application requirements.
- *
- * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
- * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
- *
- * See http://www.freertos.org/a00110.html.
- *----------------------------------------------------------*/
-
-// skip if included from IAR assembler
-#ifndef __IASMARM__
-
-// Include MCU header
-#include "bsp/board_mcu.h"
-
-#if TUSB_MCU_VENDOR_ESPRESSIF
-  #error "ESP32-Sx should use IDF's FreeRTOSConfig.h"
-#endif
-
-// TODO fix later
-#if CFG_TUSB_MCU == OPT_MCU_MM32F327X
-  extern u32 SystemCoreClock;
-#else
-  // FIXME cause redundant-decls warnings
-  extern uint32_t SystemCoreClock;
-#endif
-
-#endif
-
-/* Cortex M23/M33 port configuration. */
-#define configENABLE_MPU								        0
-#define configENABLE_FPU								        1
-#define configENABLE_TRUSTZONE					        0
-#define configMINIMAL_SECURE_STACK_SIZE					( 1024 )
-#define configRUN_FREERTOS_SECURE_ONLY          1
-
-#define configUSE_PREEMPTION                    1
-#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
-#define configCPU_CLOCK_HZ                      SystemCoreClock
-#define configTICK_RATE_HZ                      ( 1000 )
-#define configMAX_PRIORITIES                    ( 5 )
-#define configMINIMAL_STACK_SIZE                ( 128 )
-#define configTOTAL_HEAP_SIZE                   ( configSUPPORT_DYNAMIC_ALLOCATION*4*1024 )
-#define configMAX_TASK_NAME_LEN                 16
-#define configUSE_16_BIT_TICKS                  0
-#define configIDLE_SHOULD_YIELD                 1
-#define configUSE_MUTEXES                       1
-#define configUSE_RECURSIVE_MUTEXES             1
-#define configUSE_COUNTING_SEMAPHORES           1
-#define configQUEUE_REGISTRY_SIZE               4
-#define configUSE_QUEUE_SETS                    0
-#define configUSE_TIME_SLICING                  0
-#define configUSE_NEWLIB_REENTRANT              0
-#define configENABLE_BACKWARD_COMPATIBILITY     1
-#define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP   0
-
-#define configSUPPORT_STATIC_ALLOCATION         1
-#define configSUPPORT_DYNAMIC_ALLOCATION        0
-
-/* Hook function related definitions. */
-#define configUSE_IDLE_HOOK                    0
-#define configUSE_TICK_HOOK                    0
-#define configUSE_MALLOC_FAILED_HOOK           0 // cause nested extern warning
-#define configCHECK_FOR_STACK_OVERFLOW         2
-#define configCHECK_HANDLER_INSTALLATION       0
-
-/* Run time and task stats gathering related definitions. */
-#define configGENERATE_RUN_TIME_STATS          0
-#define configUSE_TRACE_FACILITY               1 // legacy trace
-#define configUSE_STATS_FORMATTING_FUNCTIONS   0
-
-/* Co-routine definitions. */
-#define configUSE_CO_ROUTINES                  0
-#define configMAX_CO_ROUTINE_PRIORITIES        2
-
-/* Software timer related definitions. */
-#define configUSE_TIMERS                       1
-#define configTIMER_TASK_PRIORITY              (configMAX_PRIORITIES-2)
-#define configTIMER_QUEUE_LENGTH               32
-#define configTIMER_TASK_STACK_DEPTH           configMINIMAL_STACK_SIZE
-
-/* Optional functions - most linkers will remove unused functions anyway. */
-#define INCLUDE_vTaskPrioritySet               0
-#define INCLUDE_uxTaskPriorityGet              0
-#define INCLUDE_vTaskDelete                    0
-#define INCLUDE_vTaskSuspend                   1 // required for queue, semaphore, mutex to be blocked indefinitely with portMAX_DELAY
-#define INCLUDE_xResumeFromISR                 0
-#define INCLUDE_vTaskDelayUntil                1
-#define INCLUDE_vTaskDelay                     1
-#define INCLUDE_xTaskGetSchedulerState         0
-#define INCLUDE_xTaskGetCurrentTaskHandle      0
-#define INCLUDE_uxTaskGetStackHighWaterMark    0
-#define INCLUDE_xTaskGetIdleTaskHandle         0
-#define INCLUDE_xTimerGetTimerDaemonTaskHandle 0
-#define INCLUDE_pcTaskGetTaskName              0
-#define INCLUDE_eTaskGetState                  0
-#define INCLUDE_xEventGroupSetBitFromISR       0
-#define INCLUDE_xTimerPendFunctionCall         0
-
-#ifdef __RX__
-/* Renesas RX series */
-#define vSoftwareInterruptISR					        INT_Excep_ICU_SWINT
-#define vTickISR								              INT_Excep_CMT0_CMI0
-#define configPERIPHERAL_CLOCK_HZ				      (configCPU_CLOCK_HZ/2)
-#define configKERNEL_INTERRUPT_PRIORITY			  1
-#define configMAX_SYSCALL_INTERRUPT_PRIORITY	4
-
-#else
-
-/* FreeRTOS hooks to NVIC vectors */
-#define xPortPendSVHandler    PendSV_Handler
-#define xPortSysTickHandler   SysTick_Handler
-#define vPortSVCHandler       SVC_Handler
-
-//--------------------------------------------------------------------+
-// Interrupt nesting behavior configuration.
-//--------------------------------------------------------------------+
-#if defined(__NVIC_PRIO_BITS)
-  // For Cortex-M specific: __NVIC_PRIO_BITS is defined in core_cmx.h
-	#define configPRIO_BITS       __NVIC_PRIO_BITS
-
-#elif defined(__ECLIC_INTCTLBITS)
-  // RISC-V Bumblebee core from nuclei
-  #define configPRIO_BITS       __ECLIC_INTCTLBITS
-
-#elif defined(__IASMARM__)
-  // FIXME: IAR Assembler cannot include mcu header directly to get __NVIC_PRIO_BITS.
-  // Therefore we will hard coded it to minimum value of 2 to get pass ci build.
-  // IAR user must update this to correct value of the target MCU
-  #message "configPRIO_BITS is hard coded to 2 to pass IAR build only. User should update it per MCU"
-  #define configPRIO_BITS       2
-
-#else
-  #error "FreeRTOS configPRIO_BITS to be defined"
-#endif
-
-/* The lowest interrupt priority that can be used in a call to a "set priority" function. */
-#define configLIBRARY_LOWEST_INTERRUPT_PRIORITY			  ((1<<configPRIO_BITS) - 1)
-
-/* The highest interrupt priority that can be used by any interrupt service
-routine that makes calls to interrupt safe FreeRTOS API functions.  DO NOT CALL
-INTERRUPT SAFE FREERTOS API FUNCTIONS FROM ANY INTERRUPT THAT HAS A HIGHER
-PRIORITY THAN THIS! (higher priorities are lower numeric values. */
-#define configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY	2
-
-/* Interrupt priorities used by the kernel port layer itself.  These are generic
-to all Cortex-M ports, and do not rely on any particular library functions. */
-#define configKERNEL_INTERRUPT_PRIORITY 		          ( configLIBRARY_LOWEST_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
-
-/* !!!! configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to zero !!!!
-See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html. */
-#define configMAX_SYSCALL_INTERRUPT_PRIORITY 	        ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
-
-#endif
-
-#endif /* __FREERTOS_CONFIG__H */

examples/device/cdc_msc_freertos/src/msc_disk.c

@@ -190,7 +190,14 @@ int32_t tud_msc_read10_cb(uint8_t lun, uint32_t lba, uint32_t offset, void* buff
   (void) lun;
 
   // out of ramdisk
-  if ( lba >= DISK_BLOCK_NUM ) return -1;
+  if ( lba >= DISK_BLOCK_NUM ) {
+    return -1;
+  }
+
+  // Check for overflow of offset + bufsize
+  if ( offset + bufsize > DISK_BLOCK_SIZE ) {
+    return -1;
+  }
 
   uint8_t const* addr = msc_disk[lba] + offset;
   memcpy(buffer, addr, bufsize);

examples/device/cdc_uac2/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/cdc_uac2/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/dfu/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/dfu/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/dfu_runtime/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/dfu_runtime/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/dynamic_configuration/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/dynamic_configuration/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/hid_boot_interface/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/hid_boot_interface/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/hid_composite/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/hid_composite/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/hid_composite/src/main.c

@@ -197,11 +197,43 @@ static void send_hid_report(uint8_t report_id, uint32_t btn)
       }
     }
     break;
-
     default: break;
   }
 }
 
+/* use this to send stylus touch signal through USB. */
+static void send_stylus_touch(uint16_t x, uint16_t y, bool state)
+{
+  // skip if hid is not ready yet
+  if ( !tud_hid_ready() ) return;
+
+  static bool has_stylus_pen = false;
+
+  hid_stylus_report_t report =
+  {
+    .attr = 0,
+    .x = 0,
+    .y = 0
+  };
+
+  report.x = x;
+  report.y = y;
+
+  if (state)
+  {
+    report.attr = STYLUS_ATTR_TIP_SWITCH | STYLUS_ATTR_IN_RANGE;
+    tud_hid_report(REPORT_ID_STYLUS_PEN, &report, sizeof(report));
+
+    has_stylus_pen = true;
+  }else
+  {
+    report.attr = 0;
+    if (has_stylus_pen) tud_hid_report(REPORT_ID_STYLUS_PEN, &report, sizeof(report));
+    has_stylus_pen = false;
+  }
+
+}
+
 // Every 10ms, we will sent 1 report for each HID profile (keyboard, mouse etc ..)
 // tud_hid_report_complete_cb() is used to send the next report after previous one is complete
 void hid_task(void)
@@ -209,6 +241,14 @@ void hid_task(void)
   // Poll every 10ms
   const uint32_t interval_ms = 10;
   static uint32_t start_ms = 0;
+  static uint32_t touch_ms = 0;
+  static bool touch_state = false;
+
+  if (board_millis() - touch_ms < 100) {
+    touch_ms = board_millis();
+    send_stylus_touch(0, 0, touch_state = !touch_state);
+    return;
+  }
 
   if ( board_millis() - start_ms < interval_ms) return; // not enough time
   start_ms += interval_ms;

examples/device/hid_composite/src/usb_descriptors.c

@@ -79,6 +79,7 @@ uint8_t const desc_hid_report[] =
 {
   TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(REPORT_ID_KEYBOARD         )),
   TUD_HID_REPORT_DESC_MOUSE   ( HID_REPORT_ID(REPORT_ID_MOUSE            )),
+  TUD_HID_REPORT_DESC_STYLUS_PEN( HID_REPORT_ID(REPORT_ID_STYLUS_PEN     )),
   TUD_HID_REPORT_DESC_CONSUMER( HID_REPORT_ID(REPORT_ID_CONSUMER_CONTROL )),
   TUD_HID_REPORT_DESC_GAMEPAD ( HID_REPORT_ID(REPORT_ID_GAMEPAD          ))
 };

examples/device/hid_composite/src/usb_descriptors.h

@@ -29,6 +29,7 @@ enum
 {
   REPORT_ID_KEYBOARD = 1,
   REPORT_ID_MOUSE,
+  REPORT_ID_STYLUS_PEN,
   REPORT_ID_CONSUMER_CONTROL,
   REPORT_ID_GAMEPAD,
   REPORT_ID_COUNT

examples/device/hid_composite_freertos/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/hid_composite_freertos/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/hid_composite_freertos/Makefile

@@ -1,16 +1,9 @@
-DEPS_SUBMODULES += lib/FreeRTOS-Kernel
-
+RTOS = freertos
 include ../../build_system/make/make.mk
 
-FREERTOS_SRC = lib/FreeRTOS-Kernel
-FREERTOS_PORTABLE_PATH= $(FREERTOS_SRC)/portable/$(if $(findstring iar,$(TOOLCHAIN)),IAR,GCC)
-
 INC += \
 	src \
-	src/FreeRTOSConfig \
 	$(TOP)/hw \
-	$(TOP)/$(FREERTOS_SRC)/include \
-	$(TOP)/$(FREERTOS_PORTABLE_SRC)
 
 # Example source
 EXAMPLE_SOURCE = \
@@ -19,28 +12,4 @@ EXAMPLE_SOURCE = \
 
 SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
 
-# FreeRTOS source, all files in port folder
-SRC_C += \
-	$(FREERTOS_SRC)/list.c \
-	$(FREERTOS_SRC)/queue.c \
-	$(FREERTOS_SRC)/tasks.c \
-	$(FREERTOS_SRC)/timers.c \
-	$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.c))
-
-SRC_S += \
-	$(subst $(TOP)/,,$(wildcard $(TOP)/$(FREERTOS_PORTABLE_SRC)/*.s))
-
-# include heap manage if configSUPPORT_DYNAMIC_ALLOCATION = 1
-# SRC_C += $(FREERTOS_SRC)/portable/MemMang/heap_1.c
-# CFLAGS += -Wno-error=sign-compare
-
-# Suppress FreeRTOSConfig.h warnings
-CFLAGS_GCC += -Wno-error=redundant-decls
-
-# Suppress FreeRTOS source warnings
-CFLAGS_GCC += -Wno-error=cast-qual
-
-# FreeRTOS (lto + Os) linker issue
-LDFLAGS_GCC += -Wl,--undefined=vTaskSwitchContext
-
 include ../../build_system/make/rules.mk

examples/device/hid_composite_freertos/src/FreeRTOSConfig/FreeRTOSConfig.h

@@ -1,191 +0,0 @@
-/*
- * FreeRTOS Kernel V10.0.0
- * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software. If you wish to use our Amazon
- * FreeRTOS name, please do so in a fair use way that does not cause confusion.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * http://www.FreeRTOS.org
- * http://aws.amazon.com/freertos
- *
- * 1 tab == 4 spaces!
- */
-
-
-#ifndef FREERTOS_CONFIG_H
-#define FREERTOS_CONFIG_H
-
-/*-----------------------------------------------------------
- * Application specific definitions.
- *
- * These definitions should be adjusted for your particular hardware and
- * application requirements.
- *
- * THESE PARAMETERS ARE DESCRIBED WITHIN THE 'CONFIGURATION' SECTION OF THE
- * FreeRTOS API DOCUMENTATION AVAILABLE ON THE FreeRTOS.org WEB SITE.
- *
- * See http://www.freertos.org/a00110.html.
- *----------------------------------------------------------*/
-
-// skip if included from IAR assembler
-#ifndef __IASMARM__
-
-// Include MCU header
-#include "bsp/board_mcu.h"
-
-#if TUSB_MCU_VENDOR_ESPRESSIF
-  #error "ESP32-Sx should use IDF's FreeRTOSConfig.h"
-#endif
-
-// TODO fix later
-#if CFG_TUSB_MCU == OPT_MCU_MM32F327X
-  extern u32 SystemCoreClock;
-#else
-  // FIXME cause redundant-decls warnings
-  extern uint32_t SystemCoreClock;
-#endif
-
-#endif
-
-/* Cortex M23/M33 port configuration. */
-#define configENABLE_MPU								        0
-#define configENABLE_FPU								        1
-#define configENABLE_TRUSTZONE					        0
-#define configMINIMAL_SECURE_STACK_SIZE					( 1024 )
-#define configRUN_FREERTOS_SECURE_ONLY          1
-
-#define configUSE_PREEMPTION                    1
-#define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
-#define configCPU_CLOCK_HZ                      SystemCoreClock
-#define configTICK_RATE_HZ                      ( 1000 )
-#define configMAX_PRIORITIES                    ( 5 )
-#define configMINIMAL_STACK_SIZE                ( 128 )
-#define configTOTAL_HEAP_SIZE                   ( configSUPPORT_DYNAMIC_ALLOCATION*4*1024 )
-#define configMAX_TASK_NAME_LEN                 16
-#define configUSE_16_BIT_TICKS                  0
-#define configIDLE_SHOULD_YIELD                 1
-#define configUSE_MUTEXES                       1
-#define configUSE_RECURSIVE_MUTEXES             1
-#define configUSE_COUNTING_SEMAPHORES           1
-#define configQUEUE_REGISTRY_SIZE               4
-#define configUSE_QUEUE_SETS                    0
-#define configUSE_TIME_SLICING                  0
-#define configUSE_NEWLIB_REENTRANT              0
-#define configENABLE_BACKWARD_COMPATIBILITY     1
-#define configSTACK_ALLOCATION_FROM_SEPARATE_HEAP   0
-
-#define configSUPPORT_STATIC_ALLOCATION         1
-#define configSUPPORT_DYNAMIC_ALLOCATION        0
-
-/* Hook function related definitions. */
-#define configUSE_IDLE_HOOK                    0
-#define configUSE_TICK_HOOK                    0
-#define configUSE_MALLOC_FAILED_HOOK           0 // cause nested extern warning
-#define configCHECK_FOR_STACK_OVERFLOW         2
-#define configCHECK_HANDLER_INSTALLATION       0
-
-/* Run time and task stats gathering related definitions. */
-#define configGENERATE_RUN_TIME_STATS          0
-#define configUSE_TRACE_FACILITY               1 // legacy trace
-#define configUSE_STATS_FORMATTING_FUNCTIONS   0
-
-/* Co-routine definitions. */
-#define configUSE_CO_ROUTINES                  0
-#define configMAX_CO_ROUTINE_PRIORITIES        2
-
-/* Software timer related definitions. */
-#define configUSE_TIMERS                       1
-#define configTIMER_TASK_PRIORITY              (configMAX_PRIORITIES-2)
-#define configTIMER_QUEUE_LENGTH               32
-#define configTIMER_TASK_STACK_DEPTH           configMINIMAL_STACK_SIZE
-
-/* Optional functions - most linkers will remove unused functions anyway. */
-#define INCLUDE_vTaskPrioritySet               0
-#define INCLUDE_uxTaskPriorityGet              0
-#define INCLUDE_vTaskDelete                    0
-#define INCLUDE_vTaskSuspend                   1 // required for queue, semaphore, mutex to be blocked indefinitely with portMAX_DELAY
-#define INCLUDE_xResumeFromISR                 0
-#define INCLUDE_vTaskDelayUntil                1
-#define INCLUDE_vTaskDelay                     1
-#define INCLUDE_xTaskGetSchedulerState         0
-#define INCLUDE_xTaskGetCurrentTaskHandle      0
-#define INCLUDE_uxTaskGetStackHighWaterMark    0
-#define INCLUDE_xTaskGetIdleTaskHandle         0
-#define INCLUDE_xTimerGetTimerDaemonTaskHandle 0
-#define INCLUDE_pcTaskGetTaskName              0
-#define INCLUDE_eTaskGetState                  0
-#define INCLUDE_xEventGroupSetBitFromISR       0
-#define INCLUDE_xTimerPendFunctionCall         0
-
-#ifdef __RX__
-/* Renesas RX series */
-#define vSoftwareInterruptISR					        INT_Excep_ICU_SWINT
-#define vTickISR								              INT_Excep_CMT0_CMI0
-#define configPERIPHERAL_CLOCK_HZ				      (configCPU_CLOCK_HZ/2)
-#define configKERNEL_INTERRUPT_PRIORITY			  1
-#define configMAX_SYSCALL_INTERRUPT_PRIORITY	4
-
-#else
-
-/* FreeRTOS hooks to NVIC vectors */
-#define xPortPendSVHandler    PendSV_Handler
-#define xPortSysTickHandler   SysTick_Handler
-#define vPortSVCHandler       SVC_Handler
-
-//--------------------------------------------------------------------+
-// Interrupt nesting behavior configuration.
-//--------------------------------------------------------------------+
-#if defined(__NVIC_PRIO_BITS)
-  // For Cortex-M specific: __NVIC_PRIO_BITS is defined in core_cmx.h
-	#define configPRIO_BITS       __NVIC_PRIO_BITS
-
-#elif defined(__ECLIC_INTCTLBITS)
-  // RISC-V Bumblebee core from nuclei
-  #define configPRIO_BITS       __ECLIC_INTCTLBITS
-
-#elif defined(__IASMARM__)
-  // FIXME: IAR Assembler cannot include mcu header directly to get __NVIC_PRIO_BITS.
-  // Therefore we will hard coded it to minimum value of 2 to get pass ci build.
-  // IAR user must update this to correct value of the target MCU
-  #message "configPRIO_BITS is hard coded to 2 to pass IAR build only. User should update it per MCU"
-  #define configPRIO_BITS       2
-
-#else
-  #error "FreeRTOS configPRIO_BITS to be defined"
-#endif
-
-/* The lowest interrupt priority that can be used in a call to a "set priority" function. */
-#define configLIBRARY_LOWEST_INTERRUPT_PRIORITY			  ((1<<configPRIO_BITS) - 1)
-
-/* The highest interrupt priority that can be used by any interrupt service
-routine that makes calls to interrupt safe FreeRTOS API functions.  DO NOT CALL
-INTERRUPT SAFE FREERTOS API FUNCTIONS FROM ANY INTERRUPT THAT HAS A HIGHER
-PRIORITY THAN THIS! (higher priorities are lower numeric values. */
-#define configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY	2
-
-/* Interrupt priorities used by the kernel port layer itself.  These are generic
-to all Cortex-M ports, and do not rely on any particular library functions. */
-#define configKERNEL_INTERRUPT_PRIORITY 		          ( configLIBRARY_LOWEST_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
-
-/* !!!! configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to zero !!!!
-See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html. */
-#define configMAX_SYSCALL_INTERRUPT_PRIORITY 	        ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
-
-#endif
-
-#endif /* __FREERTOS_CONFIG__H */

examples/device/hid_generic_inout/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/hid_generic_inout/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/hid_multiple_interface/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
 

examples/device/hid_multiple_interface/CMakePresets.json

@@ -0,0 +1,6 @@
+{
+  "version": 6,
+  "include": [
+    "../../../hw/bsp/BoardPresets.json"
+  ]
+}

examples/device/midi_test/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.17)
+cmake_minimum_required(VERSION 3.20)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)