Merge branch 'feature/add_spi_video_device' into 'master'

feat(esp_video): Add SPI video device for SPI interface camera

Closes AEG-2457 and AEG-2482

See merge request espressif/esp-video-components!288

Author: wujiangang

esp_cam_sensor/include/esp_cam_ctlr_spi.h

@@ -71,12 +71,13 @@ esp_err_t esp_cam_new_spi_ctlr(const esp_cam_ctlr_spi_config_t *config, esp_cam_
  * @param src_len Source buffer length
  * @param dst Destination buffer pointer
  * @param dst_len Destination buffer length
+ * @param decoded_size Decoded size pointer
  *
  * @return
  *      - ESP_OK on success
  *      - Others if failed
  */
-esp_err_t esp_cam_spi_decode_frame(esp_cam_ctlr_handle_t handle, uint8_t *src, uint32_t src_len, uint8_t *dst, uint32_t dst_len);
+esp_err_t esp_cam_spi_decode_frame(esp_cam_ctlr_handle_t handle, uint8_t *src, uint32_t src_len, uint8_t *dst, uint32_t dst_len, uint32_t *decoded_size);
 
 #ifdef __cplusplus
 }

esp_cam_sensor/src/driver_cam/esp_cam_ctlr_spi_cam.c

@@ -105,6 +105,15 @@ static void SPI_CAM_ISR_ATTR spi_cam_post_trans_cb(spi_slave_transaction_t *spi_
 {
     esp_cam_ctlr_spi_cam_t *ctlr = (esp_cam_ctlr_spi_cam_t *)spi_trans->user;
 
+    /**
+     * Due to SPI slave does not support stop function,
+     * we need to check if the controller is started,
+     * if not started, we need to return immediately.
+     */
+    if (ctlr->fsm != ESP_CAM_CTLR_SPI_CAM_FSM_STARTED) {
+        return;
+    }
+
     if ((spi_trans->rx_buffer != ctlr->frame_buffer) || ctlr->bk_buffer_exposed) {
         if (!ctlr->auto_decode_dis) {
             spi_cam_msg_t msg;
@@ -206,12 +215,13 @@ static esp_err_t spi_cam_deinit_intf(esp_cam_ctlr_spi_cam_t *ctlr)
  * @param ctlr ESP CAM controller handle
  * @param src Source buffer pointer
  * @param dst Destination buffer pointer
+ * @param decoded_size Decoded size pointer
  *
  * @return
  *      - ESP_OK on success
  *      - Others if failed
  */
-static esp_err_t spi_cam_decode(esp_cam_ctlr_spi_cam_t *ctlr, uint8_t *src, uint8_t *dst)
+static esp_err_t spi_cam_decode(esp_cam_ctlr_spi_cam_t *ctlr, uint8_t *src, uint8_t *dst, uint32_t *decoded_size)
 {
     bool decode_check_dis = ctlr->decode_check_dis;
 
@@ -236,6 +246,8 @@ static esp_err_t spi_cam_decode(esp_cam_ctlr_spi_cam_t *ctlr, uint8_t *src, uint
         dst += line_data_size;
     }
 
+    *decoded_size = ctlr->bf_size_in_bytes;
+
     return ESP_OK;
 }
 
@@ -257,20 +269,21 @@ static void spi_cam_task(void *arg)
                 esp_err_t ret;
                 uint8_t *decoded_buffer;
                 uint8_t *rx_buffer = msg.recved_frame.buffer;
+                uint32_t decoded_size;
 
                 if (rx_buffer == ctlr->frame_buffer) {
-                    ret = spi_cam_decode(ctlr, rx_buffer, ctlr->backup_buffer);
+                    ret = spi_cam_decode(ctlr, rx_buffer, ctlr->backup_buffer, &decoded_size);
                     decoded_buffer = ctlr->backup_buffer;
                 } else {
-                    ret = spi_cam_decode(ctlr, rx_buffer, rx_buffer);
+                    ret = spi_cam_decode(ctlr, rx_buffer, rx_buffer, &decoded_size);
                     decoded_buffer = rx_buffer;
                 }
 
                 if (ret == ESP_OK) {
                     esp_cam_ctlr_trans_t trans = {0};
 
                     trans.buffer = decoded_buffer;
-                    trans.buflen = ctlr->bf_size_in_bytes;
+                    trans.buflen = decoded_size;
                     trans.received_size = trans.buflen;
                     if (ctlr->cbs.on_trans_finished) {
                         ctlr->cbs.on_trans_finished(&(ctlr->base), &trans, ctlr->cbs_user_data);
@@ -368,17 +381,15 @@ static esp_err_t spi_cam_start(esp_cam_ctlr_handle_t handle)
  */
 static esp_err_t spi_cam_stop(esp_cam_ctlr_handle_t handle)
 {
-    esp_err_t ret;
     esp_cam_ctlr_spi_cam_t *ctlr = (esp_cam_ctlr_spi_cam_t *)handle;
     ESP_RETURN_ON_FALSE(ctlr, ESP_ERR_INVALID_ARG, TAG, "invalid argument: handle is null");
     ESP_RETURN_ON_FALSE(ctlr->fsm == ESP_CAM_CTLR_SPI_CAM_FSM_STARTED, ESP_ERR_INVALID_STATE, TAG, "processor isn't in started state");
 
-    ret = esp_cam_spi_slave_disable(ctlr->spi_port);
-    if (ret == ESP_OK) {
-        ctlr->fsm = ESP_CAM_CTLR_SPI_CAM_FSM_ENABLED;
-    }
+    /* SPI slave does not support stop function */
 
-    return ret;
+    ctlr->fsm = ESP_CAM_CTLR_SPI_CAM_FSM_ENABLED;
+
+    return ESP_OK;
 }
 
 /**
@@ -615,18 +626,19 @@ esp_err_t esp_cam_new_spi_ctlr(const esp_cam_ctlr_spi_config_t *config, esp_cam_
  * @param src_len Source buffer length
  * @param dst Destination buffer pointer
  * @param dst_len Destination buffer length
+ * @param decoded_size Decoded size pointer
  *
  * @return
  *      - ESP_OK on success
  *      - Others if failed
  */
-esp_err_t esp_cam_spi_decode_frame(esp_cam_ctlr_handle_t handle, uint8_t *src, uint32_t src_len, uint8_t *dst, uint32_t dst_len)
+esp_err_t esp_cam_spi_decode_frame(esp_cam_ctlr_handle_t handle, uint8_t *src, uint32_t src_len, uint8_t *dst, uint32_t dst_len, uint32_t *decoded_size)
 {
     esp_cam_ctlr_spi_cam_t *ctlr = (esp_cam_ctlr_spi_cam_t *)handle;
     ESP_RETURN_ON_FALSE(ctlr, ESP_ERR_INVALID_ARG, TAG, "invalid argument: handle is null");
     ESP_RETURN_ON_FALSE(ctlr->auto_decode_dis, ESP_ERR_INVALID_STATE, TAG, "auto decode is enabled");
     ESP_RETURN_ON_FALSE(src && dst, ESP_ERR_INVALID_ARG, TAG, "invalid argument: src or dst is null");
     ESP_RETURN_ON_FALSE(src_len == ctlr->fb_size_in_bytes && dst_len >= ctlr->bf_size_in_bytes, ESP_ERR_INVALID_ARG, TAG, "invalid argument: src_len or dst_len is invalid");
 
-    return spi_cam_decode(ctlr, src, dst);
+    return spi_cam_decode(ctlr, src, dst, decoded_size);
 }

esp_cam_sensor/src/driver_spi/spi_slave.c

@@ -93,6 +93,9 @@ typedef struct {
 #ifdef CONFIG_PM_ENABLE
     esp_pm_lock_handle_t pm_lock;
 #endif
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0)
+    uint64_t gpio_reserve;
+#endif
 } spi_slave_t;
 
 static spi_slave_t *spihost[SOC_SPI_PERIPH_NUM];
@@ -230,7 +233,7 @@ esp_err_t esp_cam_spi_slave_initialize(spi_host_device_t host, const spi_bus_con
 
     err = spicommon_bus_initialize_io(host, bus_config, SPICOMMON_BUSFLAG_SLAVE | bus_config->flags, &spihost[host]->flags
 #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0)
-                                      , NULL
+                                      , &spihost[host]->gpio_reserve
 #endif
                                      );
     if (err != ESP_OK) {
@@ -240,7 +243,7 @@ esp_err_t esp_cam_spi_slave_initialize(spi_host_device_t host, const spi_bus_con
     if (slave_config->spics_io_num >= 0) {
         spicommon_cs_initialize(host, slave_config->spics_io_num, 0, !bus_is_iomux(spihost[host])
 #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0)
-                                , NULL
+                                , &spihost[host]->gpio_reserve
 #endif
                                );
         // check and save where cs line really route through
@@ -362,7 +365,7 @@ esp_err_t esp_cam_spi_slave_free(spi_host_device_t host)
     }
     spicommon_bus_free_io_cfg(&spihost[host]->bus_config
 #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0)
-                              , NULL
+                              , &spihost[host]->gpio_reserve
 #endif
                              );
     esp_intr_free(spihost[host]->intr);

esp_video/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Unreleased
+
+- Add SPI video device and board-level configuration
+- Fix open function crashes after failing to initialize the video device
+
 ## 1.0.0
 
 - Add statistics region configuration to ISP pipeline controller

esp_video/CMakeLists.txt

@@ -30,6 +30,10 @@ if(CONFIG_ESP_VIDEO_ENABLE_DVP_VIDEO_DEVICE)
     list(APPEND srcs "src/device/esp_video_dvp_device.c")
 endif()
 
+if(CONFIG_ESP_VIDEO_ENABLE_SPI_VIDEO_DEVICE)
+    list(APPEND srcs "src/device/esp_video_spi_device.c")
+endif()
+
 if(CONFIG_ESP_VIDEO_ENABLE_H264_VIDEO_DEVICE)
     list(APPEND srcs "src/device/esp_video_h264_device.c")
 endif()

esp_video/Kconfig

@@ -56,6 +56,14 @@ menu "Espressif Video Configuration"
         help
             Select this option, enable DVP based video device.
 
+    menuconfig ESP_VIDEO_ENABLE_SPI_VIDEO_DEVICE
+        bool "Enable SPI based Video Device"
+        depends on SOC_GPSPI_SUPPORTED
+        select ESP_VIDEO_ENABLE_DATA_PREPROCESSING
+        default n
+        help
+            Select this option, enable SPI based video device.
+
     menuconfig ESP_VIDEO_ENABLE_HW_H264_VIDEO_DEVICE
         bool "Enable Hardware H.264 based Video Device"
         depends on IDF_TARGET_ESP32P4

esp_video/examples/capture_stream/main/capture_stream_main.c

@@ -229,7 +229,14 @@ static esp_err_t camera_capture_stream(void)
                 goto exit_0;
             }
 
-            frame_size += buf.bytesused;
+            /**
+             * If no error, the flags has V4L2_BUF_FLAG_DONE. If error, the flags has V4L2_BUF_FLAG_ERROR.
+             * We need to skip these frames, but we also need queue the buffer.
+             */
+            if (buf.flags & V4L2_BUF_FLAG_DONE) {
+                frame_size += buf.bytesused;
+                frame_count++;
+            }
 
 #if CONFIG_EXAMPLE_VIDEO_BUFFER_TYPE_USER
             buf.m.userptr = (unsigned long)buffer[buf.index];
@@ -240,8 +247,6 @@ static esp_err_t camera_capture_stream(void)
                 ret = ESP_FAIL;
                 goto exit_0;
             }
-
-            frame_count++;
         }
 
         if (ioctl(fd, VIDIOC_STREAMOFF, &type) != 0) {

esp_video/examples/capture_stream/sdkconfig.ci.spi_video_device

@@ -0,0 +1,7 @@
+CONFIG_ESP_VIDEO_ENABLE_SPI_VIDEO_DEVICE=y
+
+CONFIG_IDF_EXPERIMENTAL_FEATURES=y
+
+CONFIG_SPIRAM=y
+
+CONFIG_SPIRAM_SPEED_200M=y

esp_video/examples/common_components/example_video_common/Kconfig.projbuild

@@ -34,6 +34,10 @@ menu "Example Video Initialization Configuration"
         config EXAMPLE_ENABLE_DVP_CAM_SENSOR
             bool "DVP"
             depends on ESP_VIDEO_ENABLE_DVP_VIDEO_DEVICE
+
+        config EXAMPLE_ENABLE_SPI_CAM_SENSOR
+            bool "SPI"
+            depends on ESP_VIDEO_ENABLE_SPI_VIDEO_DEVICE
     endchoice
 
     if EXAMPLE_ENABLE_MIPI_CSI_CAM_SENSOR
@@ -90,6 +94,45 @@ menu "Example Video Initialization Configuration"
             default 20000000    
     endif
 
+    if EXAMPLE_ENABLE_SPI_CAM_SENSOR
+        config EXAMPLE_SPI_SCCB_I2C_PORT
+            int "SPI SCCB I2C Port Number"
+            default 1
+            range 0 1
+
+        config EXAMPLE_SPI_SCCB_I2C_FREQ
+            int "SPI SCCB I2C Frequency"
+            default 100000
+            range 100000 400000
+            help
+                Increasing this value can reduce the initialization time of the camera sensor.
+                Please refer to the relevant instructions for the camera sensor to adjust the value.
+    
+        config EXAMPLE_SPI_CAM_SPI_PORT
+            int "SPI Camera Sensor SPI Port Number"
+            default 2
+
+        choice EXAMPLE_SPI_CAM_XCLK_RESOURCE
+            prompt "SPI Camera Sensor Clock Resource"
+            default EXAMPLE_SPI_CAM_XCLK_USE_LEDC if CAMERA_XCLK_USE_LEDC
+            default EXAMPLE_SPI_CAM_XCLK_USE_CLOCK_ROUTER if CAMERA_XCLK_USE_ESP_CLOCK_ROUTER
+            help
+                Select SPI camera sensor clock resource.
+
+            config EXAMPLE_SPI_CAM_XCLK_USE_LEDC
+                bool "LEDC"
+                depends on CAMERA_XCLK_USE_LEDC
+            
+            config EXAMPLE_SPI_CAM_XCLK_USE_CLOCK_ROUTER
+                bool "Clock Router"
+                depends on CAMERA_XCLK_USE_ESP_CLOCK_ROUTER
+        endchoice
+
+        config EXAMPLE_SPI_CAM_XCLK_FREQ
+            int "SPI XCLK Frequency"
+            default 24000000
+    endif
+
     if EXAMPLE_SELECT_CUSTOMIZED_DEV_BOARD
         if EXAMPLE_ENABLE_MIPI_CSI_CAM_SENSOR
             config EXAMPLE_MIPI_CSI_SCCB_I2C_SCL_PIN
@@ -232,6 +275,48 @@ menu "Example Video Initialization Configuration"
                 range 0 56
                 default 47
         endif
+
+        if EXAMPLE_ENABLE_SPI_CAM_SENSOR
+            config EXAMPLE_SPI_SCCB_I2C_SCL_PIN
+                int "SPI SCCB I2C SCL Pin"
+                default 8
+                range -1 56
+
+            config EXAMPLE_SPI_SCCB_I2C_SDA_PIN
+                int "SPI SCCB I2C SDA Pin"
+                default 7
+                range -1 56
+
+            config EXAMPLE_SPI_CAM_SENSOR_RESET_PIN
+                int "SPI Camera Sensor Reset Pin"
+                default -1
+                range -1 56
+
+            config EXAMPLE_SPI_CAM_SENSOR_PWDN_PIN
+                int "SPI Camera Sensor Power Down Pin"
+                default -1
+                range -1 56
+
+            config EXAMPLE_SPI_CAM_XCLK_PIN
+                int "Output XCLK Pin for SPI Sensor"
+                range 0 56
+                default 20
+
+            config EXAMPLE_SPI_CAM_CS_PIN
+                int "SPI Camera Sensor CS Pin"
+                default 37
+                range 0 56
+            
+            config EXAMPLE_SPI_CAM_SCLK_PIN
+                int "SPI Camera Sensor SCLK Pin"
+                default 4
+                range 0 56
+
+            config EXAMPLE_SPI_CAM_DATA0_IO_PIN
+                int "SPI Camera Sensor Data0 I/O Pin"
+                default 21
+                range 0 56
+        endif
     endif
 
     config EXAMPLE_SCCB_I2C_INIT_BY_APP