Merge branch 'feature/update_kconfig' into 'master'

Update kconfig

Closes AEG-2480

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

Author: wujiangang

esp_cam_sensor/CHANGELOG.md

@@ -1,7 +1,8 @@
 ## Unreleased
 
 - Added support for BF3901 SPI camera sensor driver.
-- Added camera SPI interface driver
+- Added camera SPI interface driver.
+- Enhanced the clarity and readability of prompt and help descriptions in Kconfig files.
 
 ## 1.1.0
 

esp_cam_sensor/Kconfig

@@ -1,88 +1,128 @@
 menu "Espressif Camera Sensors Configurations"
     menu "Camera Sensor Configuration"
-        rsource "sensors/bf3901/Kconfig.bf3901"
-        rsource "sensors/bf3925/Kconfig.bf3925"
-        rsource "sensors/bf3a03/Kconfig.bf3a03"
-        rsource "sensors/gc0308/Kconfig.gc0308"
-        rsource "sensors/gc2145/Kconfig.gc2145"
-        rsource "sensors/ov2640/Kconfig.ov2640"
-        rsource "sensors/ov2710/Kconfig.ov2710"
-        rsource "sensors/ov5640/Kconfig.ov5640"
-        rsource "sensors/ov5645/Kconfig.ov5645"
-        rsource "sensors/ov5647/Kconfig.ov5647"
-        rsource "sensors/sc030iot/Kconfig.sc030iot"
-        rsource "sensors/sc035hgs/Kconfig.sc035hgs"
-        rsource "sensors/sc101iot/Kconfig.sc101iot"
-        rsource "sensors/sc202cs/Kconfig.sc202cs"
-        rsource "sensors/sc2336/Kconfig.sc2336"
+        menu "Select and Set Camera Sensor"
+            rsource "sensors/bf3901/Kconfig.bf3901"
+            rsource "sensors/bf3925/Kconfig.bf3925"
+            rsource "sensors/bf3a03/Kconfig.bf3a03"
+            rsource "sensors/gc0308/Kconfig.gc0308"
+            rsource "sensors/gc2145/Kconfig.gc2145"
+            rsource "sensors/ov2640/Kconfig.ov2640"
+            rsource "sensors/ov2710/Kconfig.ov2710"
+            rsource "sensors/ov5640/Kconfig.ov5640"
+            rsource "sensors/ov5645/Kconfig.ov5645"
+            rsource "sensors/ov5647/Kconfig.ov5647"
+            rsource "sensors/sc030iot/Kconfig.sc030iot"
+            rsource "sensors/sc035hgs/Kconfig.sc035hgs"
+            rsource "sensors/sc101iot/Kconfig.sc101iot"
+            rsource "sensors/sc202cs/Kconfig.sc202cs"
+            rsource "sensors/sc2336/Kconfig.sc2336"
+        endmenu
 
         config CAMERA_SENSOR_SWAP_PIXEL_BYTE_ORDER
-            bool "Swap Pixel Byte Order"
+            bool "Enable pixel byte order swapping"
             default y if IDF_TARGET_ESP32P4
             default n if IDF_TARGET_ESP32S3
             depends on CAMERA_OV2640 || CAMERA_BF3901
             help
-                If enabled, the pixel byte order will be swapped, for example:
+                Enable pixel byte order swapping to match display or processing requirements.
 
-                    Original RGB565 byte order:
-                    0x00 0x01 0x02 0x03 0x04 0x05
-                     B  G  R   B  G  R   B  G  R
+                This feature exchanges the byte order of pixel data, which is useful when interfacing
+                with different display controllers or image processing pipelines that expect specific
+                byte ordering.
 
-                    Swapped RGB565 byte order:
-                    0x00 0x01 0x02 0x03 0x04 0x05
-                     R  G  B   R  G  B   R  G  B
+                Supported transformations:
 
-                    Original YUYV byte order:
-                    0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07
-                     Y    U    Y    V    Y    U    Y    V
+                RGB565 format:
+                  Original: [R₁G₁B₁][R₂G₂B₂] → Swapped: [B₁G₁R₁][B₂G₂R₂]
+                  Byte sequence: 0xRG 0xBR 0xGB → 0xBG 0xRB 0xGR
 
-                    Swapped YUYV byte order:
-                    0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07
-                     U    Y    V    Y    U    Y    V    Y
+                YUYV format:
+                  Original: [Y₁U₁Y₂V₁] → Swapped: [U₁Y₁V₁Y₂]
+                  Byte sequence: Y U Y V → U Y V Y
 
-                Please note that this option is only valid for OV2640 and BF3901.
+                Platform compatibility:
+                - ESP32-P4: Default enabled
+                - ESP32-S3: Default disabled
 
-                If you want to swap the pixel byte order of other sensors,
-                please use ESP_VIDEO_ENABLE_SWAP_BYTE. Only ESP32-P4 is supported;
-                other platforms are not supported.
+                Note: This option only applies to OV2640 and BF3901 sensors.
+                For other sensors, use ESP_VIDEO_ENABLE_SWAP_BYTE (ESP32-P4 only).
     endmenu
-    
-    menu "Camera XCLK generator Configuration"
+
+    menu "Camera XCLK Generator Configuration"
         config CAMERA_XCLK_USE_LEDC
-            bool "XCLK generated by LEDC"
+            bool "Generate XCLK using LEDC"
             default n if IDF_TARGET_ESP32P4
             default y
             help
-                If enabled, XCLK can be generated from LEDC.
-        
+                Use the LED Control (LEDC) peripheral to generate the external clock (XCLK) signal
+                for camera sensors.
+
+                The LEDC peripheral provides a flexible PWM-based clock generation method that is
+                compatible with most ESP32 variants. It offers good frequency accuracy and is
+                suitable for most camera sensor applications.
+
         config CAMERA_XCLK_USE_ESP_CLOCK_ROUTER
-            bool "XCLK generated by ESP clock router"
+            bool "Generate XCLK using ESP clock router"
             depends on IDF_TARGET_ESP32P4
             default y
             help
-                If enabled, XCLK can be generated from SoC's supported root clocks. Please refer to SoC's supported root clocks at:
-                `https://docs.espressif.com/projects/esp-idf/en/latest/esp32p4/api-reference/peripherals/clk_tree.html`
+                Use the ESP32-P4's dedicated clock router to generate the external clock (XCLK)
+                signal for camera sensors.
+
+                The clock router provides high-precision clock generation directly from the SoC's
+                root clock sources, offering superior frequency stability and accuracy compared
+                to LEDC-based generation.
+
+                For detailed clock tree information, refer to:
+                https://docs.espressif.com/projects/esp-idf/en/latest/esp32p4/api-reference/peripherals/clk_tree.html
+
+                Recommended for: High-performance camera applications requiring precise timing.
     endmenu
 
-    menu "Camera Motor Configuration"
+    menu "Camera Motor Control Configuration"
         rsource "motors/dw9714/Kconfig.dw9714"
 
         config CAMERA_MOTOR_DEVICE_USED
-            bool 
+            bool
             default n
             help
-                This option indicates whether any camera motor driver is enabled in the configuration.
-                It is automatically set when any of the motor drivers are enabled.
+                Internal configuration flag indicating whether any camera motor driver is enabled.
+
+                This flag is automatically set when any motor driver (such as autofocus motors,
+                zoom motors, or iris control motors) is enabled in the configuration. It is used
+                internally by the build system to include necessary motor control libraries and
+                initialization code.
+
+                Do not modify this setting manually - it is managed automatically based on
+                your motor driver selections.
 
     endmenu
 
-    menu "Camera Controller SPI Configuration"
+    menu "Camera SPI Controller Configuration"
         config CAM_CTLR_SPI_ISR_CACHE_SAFE
-            bool "Camera Controller SPI ISR Cache-Safe"
+            bool "Enable cache-safe SPI interrupt handling"
             default y
             select SPI_SLAVE_ISR_IN_IRAM
             help
-                Ensure the camera controller SPI ISR is Cache-Safe. When enabled, the ISR handler
-                will be available when the cache is disabled.
+                Ensure camera controller SPI interrupt service routine (ISR) remains accessible
+                when cache is disabled.
+
+                When enabled, the SPI ISR code is placed in internal RAM (IRAM), allowing it to
+                execute even when external flash cache is temporarily disabled during operations
+                like flash writes, OTA updates, or power management transitions.
+
+                Benefits:
+                - Prevents SPI communication interruptions during cache-disabled periods
+                - Ensures reliable camera data transfer during system operations
+                - Reduces latency in time-critical camera control scenarios
+
+                Trade-offs:
+                - Uses additional IRAM memory
+                - Slightly increases firmware size
+
+                Recommended: Enable for production applications requiring reliable camera operation
+                during all system states.
+
+                Note: This automatically enables SPI_SLAVE_ISR_IN_IRAM for the SPI peripheral.
     endmenu
-endmenu
+endmenu

esp_cam_sensor/motors/dw9714/Kconfig.dw9714

@@ -3,34 +3,51 @@ menuconfig CAM_MOTOR_DW9714
     default n
     select CAMERA_MOTOR_DEVICE_USED
     help
-        Enabling this option will add the support for DW9714 camera motor.
+        Enable support for the DW9714 Voice Coil Motor (VCM) autofocus actuator.
 
 if CAM_MOTOR_DW9714
     config CAM_MOTOR_DW9714_AUTO_DETECT
         bool "Auto detect DW9714"
         default y
         help
-            When enabled, it provides the ability in application layer to automatically
-            detect camera motors one by one.
+            When enabled, the DW9714 motor will be automatically detected and
+            initialized during system startup without requiring manual detection
+            calls in your application.
+
+            The auto-detection process uses I2C communication to identify and
+            configure the motor with the default settings.
 
     choice CAM_MOTOR_DW9714_DEFAULT_FMT
         prompt "Default format select"
         default CAM_MOTOR_DW9714_DLC_MCLK02_SRC17
         help
-            We define a "format" structure in the software to store the initialization information of the motor device.
-            Here, the default format is selected for loading when the motor is detected.
-    
+            A "format" structure stores the motor device initialization parameters.
+            This setting selects which default format to load when the motor is detected.
+
         config CAM_MOTOR_DW9714_LSC_MCLK01_SRC03
-            bool "LSC mode with mclk01 src03"
+            bool "LSC(Linear Step Control) mode with mclk01 src03"
+            help
+                Linear Step Control mode with moderate clock and source settings.
+
+                Configuration: MCLK=01, SRC=03
         config CAM_MOTOR_DW9714_DLC_MCLK02_SRC17
-            bool "DLC mode with mclk02 src17"
+            bool "DLC(Direct Linear Control) mode with mclk02 src17"
+            help
+                Direct Linear Control mode with higher clock and source settings.
+
+                Configuration: MCLK=02, SRC=17
     endchoice # CAM_MOTOR_DW9714_DEFAULT_FMT
 
     config DW9714_FORMAT_INDEX_DEFAULT
         int
         default 0 if CAM_MOTOR_DW9714_LSC_MCLK01_SRC03
         default 1 if CAM_MOTOR_DW9714_DLC_MCLK02_SRC17
         help
-            Set the configuration loaded by default.
-            More information can be obtained by calling the query_support_formats().
+            Internal format index for the selected default motor configuration.
+
+            This value corresponds to the control mode index used internally
+            by the driver to configure the motor with the selected default mode.
+
+            For additional format options and runtime configuration changes,
+            use the query_support_formats() API function.
 endif

esp_cam_sensor/sensors/bf3901/Kconfig.bf3901

@@ -2,37 +2,46 @@ menuconfig CAMERA_BF3901
     bool "BF3901"
     default n
     help
-        Enabling this option will add the support for BF3901.
+        Enable support for the BF3901 CMOS image sensor.
 
 if CAMERA_BF3901
     menu "Auto detect BF3901"
         config CAMERA_BF3901_AUTO_DETECT_SPI_INTERFACE_SENSOR
             bool "Detect for SPI interface sensor"
-            default n
+            default y
             help
-                When enabled, you don't need to call bf3901_detect manaually, BF3901 will
-                be automatically detected and connected to the SPI interface when the
-                application starts.
+                When enabled, the BF3901 sensor will be automatically detected
+                and initialized on the SPI interface at startup without requiring
+                manual detection call(bf3901_detect) in your application.
     endmenu
 
     choice CAMERA_BF3901_SPI_DEFAULT_FMT
-        prompt "Default format select"
+        prompt "Select default output format for SPI interface"
         default CAMERA_BF3901_SPI_YUV422_240X320_10FPS
         help
-            Select the default format to load when the sensor is detected.
-            When the sensor is in stream off state, the format can be changed.
-    
+            This option allows you to select the default video format for the BF3901 sensor
+            when it is initialized on the SPI interface. The selected format will be used
+            when the sensor is detected and initialized, and can be changed later when the
+            sensor is in stream off state.
+
         config CAMERA_BF3901_SPI_RGB565_240X320_10FPS
-            bool "RGB565 240x320 10fps, SPI 1bit 24M input"
+            bool "RGB565 240x320 10fps, SPI 1-bit, 24M input"
+            help
+                RGB565 color format at 240x320 resolution with 10fps framerate.
+                Requires 1-bit SPI interface with 24MHz input clock.
+
         config CAMERA_BF3901_SPI_YUV422_240X320_10FPS
-            bool "YUV422 240x320 10fps, SPI 1bit 24M input"
+            bool "YUV422 240x320 10fps, SPI 1-bit, 24M input"
+            help
+                YUV422 color format at 240x320 resolution with 10fps framerate.
+                Requires 1-bit SPI interface with 24MHz input clock.
     endchoice # CAMERA_BF3901_SPI_DEFAULT_FMT
 
     config CAMERA_BF3901_SPI_IF_FORMAT_INDEX_DEFAULT
         int
         default 0 if CAMERA_BF3901_SPI_RGB565_240X320_10FPS
         default 1 if CAMERA_BF3901_SPI_YUV422_240X320_10FPS
         help
-            Set the configuration loaded by default for the SPI interface.
-            More information can be obtained by calling the query_support_formats().
+            Sets the default configuration for the SPI interface.
+            Use query_support_formats() API to get more format options.
 endif

esp_cam_sensor/sensors/bf3925/Kconfig.bf3925

@@ -3,34 +3,39 @@ menuconfig CAMERA_BF3925
     default n
     depends on SOC_LCDCAM_CAM_SUPPORTED
     help
-        Enabling this option will add the support for BF3925.
+        Enable support for the BF3925 CMOS image sensor.
 
 if CAMERA_BF3925
     menu "Auto detect BF3925"
         config CAMERA_BF3925_AUTO_DETECT_DVP_INTERFACE_SENSOR
             bool "Detect for DVP interface sensor"
             default y
             help
-                When enabled, you don't need to call bf3925_detect manaually, BF3925 will
-                be automatically detected and connected to the DVP interface when the
-                application starts.
+                When enabled, the BF3925 sensor will be automatically detected
+                and initialized on the DVP interface at startup without requiring
+                manual detection call(bf3925_detect) in your application.
     endmenu
 
     choice CAMERA_BF3925_DVP_DEFAULT_FMT
-        prompt "Default format select"
+        prompt "Select default output format for DVP interface"
         default CAMERA_BF3925_DVP_YUV422_1600X1200_9FPS
         help
-            Select the default format to load when the sensor is detected.
-            When the sensor is in stream off state, the format can be changed.
-    
+            This option allows you to select the default video format for the BF3925 sensor
+            when it is initialized on the DVP interface. The selected format will be used
+            when the sensor is detected and initialized, and can be changed later when the
+            sensor is in stream off state.
+
         config CAMERA_BF3925_DVP_YUV422_1600X1200_9FPS
-            bool "YUV422 1600x1200 9fps, DVP 8bit 20M input"
+            bool "YUV422 1600x1200 9fps, DVP 8-bit, 20M input"
+            help
+                YUV422 color format at 1600x1200 resolution (UXGA) with 9fps framerate.
+                Requires 8-bit DVP interface and 20MHz input clock.
     endchoice # CAMERA_BF3925_DVP_DEFAULT_FMT
 
-    config CAMERA_BF3925_DVP_IF_FORMAT_INDEX_DAFAULT
+    config CAMERA_BF3925_DVP_IF_FORMAT_INDEX_DEFAULT
         int
         default 0 if CAMERA_BF3925_DVP_YUV422_1600X1200_9FPS
         help
-            Set the configuration loaded by default for the DVP interface.
-            More information can be obtained by calling the query_support_formats().
+            Sets the default configuration for the DVP interface.
+            Use query_support_formats() API to get more format options.
 endif

esp_cam_sensor/sensors/bf3925/bf3925.c

@@ -493,7 +493,7 @@ static esp_err_t bf3925_set_format(esp_cam_sensor_device_t *dev, const esp_cam_s
     /* Depending on the interface type, an available configuration is automatically loaded.
     You can set the output format of the sensor without using query_format().*/
     if (format == NULL) {
-        format = &bf3925_format_info[CONFIG_CAMERA_BF3925_DVP_IF_FORMAT_INDEX_DAFAULT];
+        format = &bf3925_format_info[CONFIG_CAMERA_BF3925_DVP_IF_FORMAT_INDEX_DEFAULT];
     }
     /*Todo, IDF I2C driver to be fixed*/
     // bf3925_write(dev->sccb_handle, BF3925_REG_PAGE_SELECT, 0x01); // select reg page
@@ -672,7 +672,7 @@ esp_cam_sensor_device_t *bf3925_detect(esp_cam_sensor_config_t *config)
     dev->pwdn_pin = config->pwdn_pin;
     dev->sensor_port = config->sensor_port;
     dev->ops = &bf3925_ops;
-    dev->cur_format = &bf3925_format_info[CONFIG_CAMERA_BF3925_DVP_IF_FORMAT_INDEX_DAFAULT];
+    dev->cur_format = &bf3925_format_info[CONFIG_CAMERA_BF3925_DVP_IF_FORMAT_INDEX_DEFAULT];
 
     // Configure sensor power, clock, and SCCB port
     if (bf3925_power_on(dev) != ESP_OK) {