Merge pull request #3023 from ennebi/mtp

Add support for MTP device class

Author: hathach

.github/workflows/build.yml

@@ -199,25 +199,28 @@ jobs:
     runs-on: [self-hosted, X64, hathach, hardware-in-the-loop]
     steps:
       - name: Clean workspace
-        if: github.run_attempt == '1'
         run: |
           echo "Cleaning up for the first run"
           rm -rf "${{ github.workspace }}"
           mkdir -p "${{ github.workspace }}"
 
       - name: Checkout TinyUSB
-        if: github.run_attempt == '1'
         uses: actions/checkout@v4
-        with:
-          sparse-checkout: test/hil
 
       - name: Download Artifacts
-        if: github.run_attempt == '1'
         uses: actions/download-artifact@v4
         with:
           path: cmake-build
           merge-multiple: true
 
+      - name: Cache skip list
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.HIL_JSON }}.skip
+          key: hil-skip-${{ github.run_id }}-${{ github.run_attempt }}
+          restore-keys: |
+            hil-skip-${{ github.run_id }}-
+
       - name: Test on actual hardware
         run: |
           ls cmake-build/

README.rst

@@ -60,6 +60,7 @@ Supports multiple device configurations by dynamically changing USB descriptors,
 -  Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ...
 -  Mass Storage Class (MSC): with multiple LUNs
 -  Musical Instrument Digital Interface (MIDI)
+-  Media Transfer Protocol (MTP/PTP)
 -  Network with RNDIS, Ethernet Control Model (ECM), Network Control Model (NCM)
 -  Test and Measurement Class (USBTMC)
 -  Video class 1.5 (UVC): work in progress

docs/reference/getting_started.rst

@@ -178,7 +178,7 @@ By default log message is printed via on-board UART which is slow and take lots
   * Pros: work with most if not all MCUs
   * Software viewer is JLink RTT Viewer/Client/Logger which is bundled with JLink driver package.
 
-* ``LOGGER=swo``\ : Use dedicated SWO pin of ARM Cortex SWD debug header.
+* ``LOGGER=swo`` : Use dedicated SWO pin of ARM Cortex SWD debug header.
 
   * Cons: only work with ARM Cortex MCUs minus M0
   * Pros: should be compatible with more debugger that support SWO.

examples/device/CMakeLists.txt

@@ -26,6 +26,7 @@ family_add_subdirectory(hid_generic_inout)
 family_add_subdirectory(hid_multiple_interface)
 family_add_subdirectory(midi_test)
 family_add_subdirectory(msc_dual_lun)
+family_add_subdirectory(mtp)
 family_add_subdirectory(net_lwip_webserver)
 family_add_subdirectory(uac2_headset)
 family_add_subdirectory(uac2_speaker_fb)

examples/device/cdc_msc/src/usb_descriptors.c

@@ -184,7 +184,7 @@ uint8_t const *tud_descriptor_other_speed_configuration_cb(uint8_t index) {
   (void) index; // for multiple configurations
 
   // if link speed is high return fullspeed config, and vice versa
-  // Note: the descriptor type is OHER_SPEED_CONFIG instead of CONFIG
+  // Note: the descriptor type is OTHER_SPEED_CONFIG instead of CONFIG
   memcpy(desc_other_speed_config,
          (tud_speed_get() == TUSB_SPEED_HIGH) ? desc_fs_configuration : desc_hs_configuration,
          CONFIG_TOTAL_LEN);

examples/device/cdc_msc_freertos/src/usb_descriptors.c

@@ -186,7 +186,7 @@ uint8_t const* tud_descriptor_other_speed_configuration_cb(uint8_t index) {
   (void) index; // for multiple configurations
 
   // if link speed is high return fullspeed config, and vice versa
-  // Note: the descriptor type is OHER_SPEED_CONFIG instead of CONFIG
+  // Note: the descriptor type is OTHER_SPEED_CONFIG instead of CONFIG
   memcpy(desc_other_speed_config,
          (tud_speed_get() == TUSB_SPEED_HIGH) ? desc_fs_configuration : desc_hs_configuration,
          CONFIG_TOTAL_LEN);

examples/device/cdc_uac2/src/usb_descriptors.c

@@ -176,7 +176,7 @@ uint8_t const *tud_descriptor_other_speed_configuration_cb(uint8_t index) {
   (void) index; // for multiple configurations
 
   // if link speed is high return fullspeed config, and vice versa
-  // Note: the descriptor type is OHER_SPEED_CONFIG instead of CONFIG
+  // Note: the descriptor type is OTHER_SPEED_CONFIG instead of CONFIG
   memcpy(desc_other_speed_config,
          (tud_speed_get() == TUSB_SPEED_HIGH) ? desc_fs_configuration : desc_hs_configuration,
          CONFIG_TOTAL_LEN);

examples/device/hid_composite/src/usb_descriptors.c

@@ -154,7 +154,7 @@ uint8_t const* tud_descriptor_other_speed_configuration_cb(uint8_t index)
 {
   (void) index; // for multiple configurations
 
-  // other speed config is basically configuration with type = OHER_SPEED_CONFIG
+  // other speed config is basically configuration with type = OTHER_SPEED_CONFIG
   memcpy(desc_other_speed_config, desc_configuration, CONFIG_TOTAL_LEN);
   desc_other_speed_config[1] = TUSB_DESC_OTHER_SPEED_CONFIG;
 

examples/device/hid_composite_freertos/src/usb_descriptors.c

@@ -153,7 +153,7 @@ uint8_t const* tud_descriptor_other_speed_configuration_cb(uint8_t index)
 {
   (void) index; // for multiple configurations
 
-  // other speed config is basically configuration with type = OHER_SPEED_CONFIG
+  // other speed config is basically configuration with type = OTHER_SPEED_CONFIG
   memcpy(desc_other_speed_config, desc_configuration, CONFIG_TOTAL_LEN);
   desc_other_speed_config[1] = TUSB_DESC_OTHER_SPEED_CONFIG;
 

examples/device/mtp/CMakeLists.txt

@@ -0,0 +1,39 @@
+cmake_minimum_required(VERSION 3.20)
+
+include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake)
+
+# gets PROJECT name for the example (e.g. <BOARD>-<DIR_NAME>)
+family_get_project_name(PROJECT ${CMAKE_CURRENT_LIST_DIR})
+
+project(${PROJECT} C CXX ASM)
+
+# Checks this example is valid for the family and initializes the project
+family_initialize_project(${PROJECT} ${CMAKE_CURRENT_LIST_DIR})
+
+# Espressif has its own cmake build system
+if(FAMILY STREQUAL "espressif")
+  return()
+endif()
+
+if (RTOS STREQUAL zephyr)
+  set(EXE_NAME app)
+else()
+  set(EXE_NAME ${PROJECT})
+  add_executable(${EXE_NAME})
+endif()
+
+# Example source
+target_sources(${EXE_NAME} PRIVATE
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/mtp_fs_example.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/usb_descriptors.c
+  )
+
+# Example include
+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(${EXE_NAME} ${RTOS})