Merge branch 'fix/usb_uvc_psram' into 'release/v5.2'

fix(usb/uvc): Add PSRAM private requires

See merge request espressif/esp-idf!30223

examples/peripherals/usb/device/tusb_composite_msc_serialdevice/sdkconfig.defaults

@@ -1,7 +1,6 @@
 # This file was generated using idf.py save-defconfig. It can be edited manually.
 # Espressif IoT Development Framework (ESP-IDF) Project Minimal Configuration
 #
-CONFIG_TINYUSB=y
 CONFIG_TINYUSB_MSC_ENABLED=y
 
 CONFIG_PARTITION_TABLE_CUSTOM=y

examples/peripherals/usb/host/uvc/README.md

@@ -10,14 +10,11 @@ This example demonstrates how to:
 - Capture video from a USB camera using the `libuvc` library.
 - Stream the video over WiFi by hosting a TCP server.
 
-The example enumerates connected camera, negotiates selected resolution together with `FPS` and starts capturing video.
+The example enumerates a connected USB camera, negotiates a selected resolution along with an associated `FPS`, then starts capturing video. The `frame_callback` function is then invoked after receiving each frame. Users can process the received frames according to their needs.
-`frame_callback` function is then invoked after receiving each frame. User can process received frame according to his needs.
 
-Optionally, captured video can be visualized on computer with help of `player.py` script located in this example.
+Optionally, the captured video can be visualized on a PC with help of the `player.py` script provided in this example. After setting the `Example Configuration->Enable streaming` option in menuconfig, the example will create a TCP server upon startup, and waits until `player.py` connects to the server. Once a connection is established, the example streams each received frame to the PC for visualization. The network connection can be configured in menuconfig via `Example Connection Configuration`.
-After setting `Enable streaming` menuconfig option, example will create TCP server upon start, and wait until `player.py` connects to server.
-Once connection is established, example streams each received frame to computer for visualization.
 
-**Notice** that `libuvc` selects highest possible `dwMaxPayloadTransferSize` by default, so example has to manually overwrite this value to 512 bytes (maximum transfer size supported by ESP32-S2/S3).
+**Notice** that `libuvc` selects highest possible `dwMaxPayloadTransferSize` by default. As a result, this example will manually overwrite this value to 512 bytes (the maximum packet size supported by ESP32-S2/S3).
 
 (See the README.md file in the upper level 'examples' directory for more information about examples.)
 
@@ -25,8 +22,11 @@ Once connection is established, example streams each received frame to computer
 
 ### Hardware Required
 
-This example requires any ESP32-S2 or ESP32-S3 with external PSRAM and exposed USB connector attached to USB camera.
+* ESP with USB peripheral and external PSRAM
-*ESP module without external PSRAM will fail to initialize*
+* Exposed USB host connector
+* USB camera
+
+Running this example on an **ESP module without external PSRAM will fail on initialization**. Please select your PSRAM configuration in menuconfig `Component config->ESP PSRAM`. If you manually disable PSRAM, the required framebuffers might not fit into DRAM (especially on ESP32-S2).
 
 ### Configure the project
 
@@ -51,36 +51,31 @@ In the `Example Configuration` menu:
 
 Optional: If you need, change the other options according to your requirements.
 
-Additionally, `player.py` python script makes use of `opencv-python` and `numpy` packages,
+Additionally, the `player.py` python script makes use of the `opencv-python` and `numpy` packages which are not included in the `idf-env` environment by default. Run following command to install those packages:
-not included in `idf-env` environment. Run following commands to install:
+
-* `pip install opencv-python`
+```bash
-* `pip install numpy`
+pip install opencv-python numpy
+```
 
 #### UVC Protocol Mode: Auto
 
-When protocol mode set to Auto, the example tries to make three attempts to negotiatiate
+When the protocol mode is set to Auto, the example will make three attempts to negotiate the protocol with following parameters:
-the protocol with following parameters:
 
-1 Attempt: 640x480, 15 FPS, MJPEG
+1. Attempt: 640x480, 15 FPS, MJPEG
-2 Attempt: 320x240, 30 FPS, MJPEG
+2. Attempt: 320x240, 30 FPS, MJPEG
-3 Attempt: 320x240, first available FPS, MJPEG
+3. Attempt: 320x240, first available FPS, MJPEG
 
-If all three attempts result in an error, the example displays the error message and
+If all three attempts result in an error, the example displays the error message and suggests to try another USB UVC Device.
-suggests to try another USB UVC Device.
 
 #### UVC Protocol Mode: Custom
 
-When protocol mode set to Custom, the example tries to negotiate protocol with
+When the protocol mode set to Custom, the example tries to negotiate the protocol using user provided values for the following parameters: Attempts, Width, Height, FPS, and Frame Coding format. After all attempts result in an error, the example displays the error message and suggests to try another USB UVC device.
-configured parameters: Attempts, Width, Heighs, FPS, Frame Coding format.
-After all attemts result in an error, the example displays the error message and
-suggests to try another USB UVC Device.
-
 
 ### Build and Flash
 
 Build the project and flash it to the board, then run the monitor tool to view the serial output:
 
-Run `idf.py set-target esp32s2` to set target chip.
+Run `idf.py set-target esp32xx` to set target chip.
 
 Run `idf.py -p PORT flash monitor` to build, flash and monitor the project.
 
@@ -90,13 +85,13 @@ See the Getting Started Guide for all the steps to configure and use the ESP-IDF
 
 ## Known limitations
 
-Having only Full Speed USB peripheral and hardware limited MPS (maximum packet size) to 512 bytes, ESP32-S2/S3 is capable of reading about 0.5 MB of data per second. When connected to Full Speed USB host, cameras normally provide resolution no larger than 640x480 pixels.
+Having only a Full Speed USB peripheral and hardware limited MPS (maximum packet size) to 512 bytes, the ESP32-S2/S3 is capable of reading data at approximately 0.5 MB/s. When connected to Full Speed USB host, cameras normally provide resolution no larger than 640x480 pixels. The following two formats are the most commonly supported at Full Speed (both encoded in MJPEG):
-Following two supported formats are the most common (both encoded in MJPEG):
 * 320x240  30 FPS
 * 640x480  15 FPS
 
 ## Tested cameras
 * Logitech C980
+* Logitech C270
 * CANYON CNE-CWC2
 
 ## Example Output

examples/peripherals/usb/host/uvc/main/CMakeLists.txt

@@ -1,3 +1,11 @@
 idf_component_register(SRCS "main.c" "tcp_server.c"
                     INCLUDE_DIRS ""
-                    PRIV_REQUIRES protocol_examples_common nvs_flash usb mdns esp_ringbuf esp_timer esp_wifi driver)
+                    PRIV_REQUIRES
+                        nvs_flash
+                        usb
+                        esp_ringbuf
+                        esp_psram    # Required for CONFIG_SPIRAM
+                        esp_timer
+                        esp_wifi
+                        driver
+                    )

examples/peripherals/usb/host/uvc/main/idf_component.yml

@@ -1,9 +1,7 @@
 ## IDF Component Manager Manifest File
 dependencies:
-  idf: ">=4.4"
+  idf: ">=5.0"
-  usb_host_uvc: "1.0.0"
+  usb_host_uvc: "^1.0.0"
-  mdns:
+  mdns: "^1.2.0"
-    rules:
-      - if: "idf_version >= 5.0"
   protocol_examples_common:
     path: ${IDF_PATH}/examples/common_components/protocol_examples_common

examples/peripherals/usb/host/uvc/sdkconfig.defaults

@@ -4,11 +4,17 @@
 CONFIG_SPIRAM=y
 CONFIG_SPIRAM_MALLOC_RESERVE_INTERNAL=150000
 CONFIG_SPIRAM_TRY_ALLOCATE_WIFI_LWIP=y
+CONFIG_SPIRAM_SPEED_80M=y
+
+#
+# SYSTEM
+#
+CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240=y
 
 #
 # USB
 #
-CONFIG_USB_HOST_CONTROL_TRANSFER_MAX_SIZE=1024
+CONFIG_USB_HOST_CONTROL_TRANSFER_MAX_SIZE=3000
 CONFIG_USB_HOST_HW_BUFFER_BIAS_IN=y
 
 #