# K230 VICAP API Reference ## Overview ### Overview The VICAP subsystem is the subsystem responsible for video image input capture processing in the K230 SOC. By processing the signal output by the sensor in real time, a restored and enhanced digital image is obtained, making it closer to the image seen by the human eye in reality. Mainly including MIPI RxDphy, MIPI CSI, ISP and DW. MIPI is used to receive high-speed differential signals from the sensor and convert them into a DVP interface for ISP processing; ISP is used for image information processing; DW is used for fisheye correction and multi-channel resize output. This document mainly describes the VICAP module application programming interface, which provides application developers with the operation interface and configuration parameters for capturing video image data through the VICAP module. ### Functional Description #### VICAP The VICAP module is an abstract description of the entire image acquisition and processing unit. VICAP hardware consists of four modules: Sensor, VI, ISP, and Dewarp (as shown in Figure 1-1 below). Supports up to 3 sensors to be connected simultaneously. The MCM module inside the ISP implements time division multiplexing management of multiple sensors. The output data of the multiple sensors is written to DDR through the Write interface of the Memory Interface of the MCM, and then read through the Read interface and loaded into the ISP Pipeline for processing. ![Illustration description has been automatically generated](https://kendryte-download.canaan-creative.com/developer/pictures/745a46d8e083d93521d0c5233bdaccdd.png) Figure 1-1 VICAP hardware architecture diagram The VICAP software architecture is shown in Figure 1-2, from top to bottom: application interface layer, media interface layer, system framework layer, driver layer and hardware layer. - Application layer interface: Provides API interface and usage instructions in the form of kd_mapi_vicap_xxx. It further encapsulates the functional interfaces provided by each sub-module of the media interface layer, simplifying the application development process. - Media interface layer: This layer consists of various sub-modules of VICAP, each sub-module provides its own media interface API encapsulation. - Framework layer: Responsible for the control and management of VICAP's entire system software functions and business logic. By integrating the interfaces and functions provided by each sub-module, a complete VICAP system control logic and process is formed. - Driver layer: A collection of kernel driver functions for each hardware module of VICAP. Hardware layer: A collection of specific hardware modules of VICAP, including sensor. ![GUI, Text, Application Description automatically generated](https://kendryte-download.canaan-creative.com/developer/pictures/250b6c36cbd4447bd8c734548fc3b890.png) #### Sensor The Sensor module is one of the data sources for VICAP to capture images, and is responsible for configuring the operating parameters and working mode of the image photosensitive unit. The K230 platform supports multiple interface types of sensors. We take the currently most commonly used MIPI CSI interface Sensor as an example to illustrate. The schematic diagram of the hardware connection between the Sensor and the main control platform is as follows: ![Illustration description has been automatically generated](https://kendryte-download.canaan-creative.com/developer/pictures/e20100e34c268ad615e69966cb28e5a6.png) Figure 1-3 The main control issues a configuration register through the I2C interface to control the working mode of the sensor, and the sensor sends image data to the main control SOC through the MIPI CSI interface. The Sensor module system architecture is shown in Figure 1-4 below: ![GUI, Application, Email Description automatically generated](https://kendryte-download.canaan-creative.com/developer/pictures/camera_sensor_arch.png) Figure 1-4 sensor system architecture diagram From top to bottom: media interface layer, hardware driver layer and hardware layer - Media interface layer: Provides kd_mpi_sensor_xxx interface for external modules to operate and access sensor devices. - Driver layer: This layer mainly includes two parts: sensor_dev and sensor_drv. - sensor_dev: Responsible for the registration of device driver files and provides the implementation process of the file operation interface. By registering the device file node /dev/sensorxx, user space programs can access the kernel driver. - sensor_drv: specific sensor hardware driver, and encapsulates sensor operations into a unified interface. - Hardware layer: sensor module hardware. The current system supports up to three hardware sensors at the same time. ## API Reference ### VICAP This function module provides the following APIs: VICAP API is divided into the following categories by function: #### Device configuration and management - [kd_mpi_vicap_get_sensor_info](#kd_mpi_vicap_get_sensor_info) - Get sensor configuration information - [kd_mpi_vicap_set_dev_attr](#kd_mpi_vicap_set_dev_attr) - Set VICAP device properties - [kd_mpi_vicap_get_dev_attr](#kd_mpi_vicap_get_dev_attr) - Get VICAP device properties - [kd_mpi_vicap_set_chn_attr](#kd_mpi_vicap_set_chn_attr) - Set channel properties - [kd_mpi_vicap_get_chn_attr](#kd_mpi_vicap_get_chn_attr) - Get channel properties - [kd_mpi_vicap_init](#kd_mpi_vicap_init) - Initialize VICAP device - [kd_mpi_vicap_deinit](#kd_mpi_vicap_deinit) - Deinitialize VICAP device #### flow control - [kd_mpi_vicap_start_stream](#kd_mpi_vicap_start_stream) - Start data flow - [kd_mpi_vicap_stop_stream](#kd_mpi_vicap_stop_stream) - Stop data flow - [kd_mpi_vicap_set_vi_drop_frame](#kd_mpi_vicap_set_vi_drop_frame) - Set frame loss #### Image Capture and Dump - [kd_mpi_vicap_dump_frame](#kd_mpi_vicap_dump_frame) - Dump image frame - [kd_mpi_vicap_dump_release](#kd_mpi_vicap_dump_release) - Release Dump Frame - [kd_mpi_vicap_set_dump_reserved](#kd_mpi_vicap_set_dump_reserved) - Set Dump Retention - [kd_mpi_vicap_load_image](#kd_mpi_vicap_load_image) - Load image data (offline mode) - [kd_mpi_vicap_dump_register](#kd_mpi_vicap_dump_register) - Dump register configuration #### sensor control - [kd_mpi_vicap_get_sensor_fd](#kd_mpi_vicap_get_sensor_fd) - Get sensor file descriptor - [kd_mpi_vicap_again_set](#kd_mpi_vicap_again_set) - Set analog gain - [kd_mpi_vicap_again_get](#kd_mpi_vicap_again_get) - Get analog gain - [kd_mpi_vicap_intg_time_set](#kd_mpi_vicap_intg_time_set) - Set integration time (exposure) - [kd_mpi_vicap_set_af_enable](#kd_mpi_vicap_set_af_enable) - Set autofocus enable - [kd_mpi_vicap_tpg_enable](#kd_mpi_vicap_tpg_enable) - Enable test pattern generator #### Clocks and synchronization - [kd_mpi_vicap_set_mclk](#kd_mpi_vicap_set_mclk) - Set master clock - [kd_mpi_vicap_set_slave_enable](#kd_mpi_vicap_set_slave_enable) - Set slave mode enable - [kd_mpi_vicap_set_slave_attr](#kd_mpi_vicap_set_slave_attr) - Set slave mode properties - [kd_mpi_vicap_3d_mode_crtl](#kd_mpi_vicap_3d_mode_crtl) - 3D Mode Control #### kd_mpi_vicap_get_sensor_info Description Obtain sensor configuration information based on the specified sensor configuration type Syntax k_s32 kd_mpi_vicap_get_sensor_info(k_vicap_sensor_type sensor_type, k_vicap_sensor_info \*sensor_info) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------|---------------| | sensor_type | Sensor configuration type | Input | | sensor_info | Sensor configuration information | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes Application developers need to first call this API to obtain sensor configuration information based on the sensor configuration type they want to use, and then call subsequent interfaces based on the configuration information to initialize other VICAP modules. Example None. Related Topics #### kd_mpi_vicap_set_dev_attr Description Set VICAP device properties Syntax k_s32 kd_mpi_vicap_set_dev_attr(k_vicap_dev dev_num, k_vicap_dev_attr dev_attr) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|---------------|---------------| | dev_num | VICAP device number | Input | | dev_attr | VICAP device properties | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None. Example None. Related Topics #### kd_mpi_vicap_get_dev_attr Description Get VICAP device properties Syntax k_s32 kd_mpi_vicap_get_dev_attr(k_vicap_dev dev_num, k_vicap_dev_attr \*dev_attr) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|---------------|---------------| | dev_num | VICAP device number | Input | | dev_attr | VICAP device properties | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None. Example None. Related Topics #### kd_mpi_vicap_set_chn_attr Description Set VICAP device properties Syntax k_s32 kd_mpi_vicap_set_chn_attr(k_vicap_dev dev_num, k_vicap_chn chn_num, k_vicap_chn_attr chn_attr) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-------------------|---------------| | dev_num | VICAP device number | Input | | chn_num | VICAP output channel number | Input | | chn_attr | VICAP output channel properties | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None. Example None. Related Topics #### kd_mpi_vicap_get_chn_attr Description Get VICAP device properties Syntax k_s32 kd_mpi_vicap_get_chn_attr(k_vicap_dev dev_num, k_vicap_chn chn_num, k_vicap_chn_attr \*chn_attr) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-------------------|---------------| | dev_num | VICAP device number | Input | | chn_num | VICAP output channel number | Input | | chn_attr | VICAP output channel properties | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None. Example None. Related Topics #### kd_mpi_vicap_init Description VICAP device initialization Syntax k_s32 kd_mpi_vicap_init(k_vicap_dev dev_num) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-------------|---------------| | dev_num | VICAP device number | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes Before using this interface, you need to call kd_mpi_vicap_set_dev_attr to set the device attributes, and then call kd_mpi_vicap_set_chn_attr to set the output channel attributes. Example None Related Topics #### kd_mpi_vicap_deinit Description VICAP device de-initialization Syntax k_s32 kd_mpi_vicap_deinit(k_vicap_dev dev_num) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-------------|---------------| | dev_num | VICAP device number | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None. Example None. Related Topics #### kd_mpi_vicap_start_stream Description Start the VICAP device output data stream Syntax k_s32 kd_mpi_vicap_start_stream(k_vicap_dev dev_num) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-------------|---------------| | dev_num | VICAP device number | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None. Example None. Related Topics #### kd_mpi_vicap_stop_stream Description Stop VICAP device data stream output Syntax k_s32 kd_mpi_vicap_stop_stream(k_vicap_dev dev_num) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-------------|---------------| | dev_num | VICAP device number | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None Example None. Related Topics #### kd_mpi_vicap_dump_frame Description Dump vicap data according to the specified device and output channel Syntax k_s32 kd_mpi_vicap_dump_frame(k_vicap_dev dev_num, k_vicap_chn chn_num, k_vicap_dump_format foramt, k_video_frame_info \*vf_info, k_u32 milli_sec) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------|---------------| | dev_num | VICAP device number | Input | | chn_num | VICAP output channel number | Input | | foramt | Dump data type | Input | | vf_info | Dump frame information | Output | | milli_sec | timeout | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None. Example None. Related Topics #### kd_mpi_vicap_dump_release Description Release dump data frame Syntax k_s32 kd_mpi_vicap_dump_release(k_vicap_dev dev_num, k_vicap_chn chn_num, const k_video_frame_info \*vf_info) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------|---------------| | dev_num | VICAP device number | Input | | chn_num | VICAP output channel number | Input | | vf_info | Dump frame information | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes None. Example None. Related Topics #### kd_mpi_vicap_set_vi_drop_frame Description Set hardware frame loss Syntax k_s32 kd_mpi_vicap_set_vi_drop_frame(k_vicap_csi_num csi, k_vicap_drop_frame *frame, k_bool enable) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------|---------------| | csi | VICAP device number | Input | | frame | Structure, see below | | | m | Drop n frames every m frames | Input | | n | Drop n frames every m frames | Input | | mode | hdr mode | Input | | enable | Whether to turn on | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a #### kd_mpi_vicap_set_mclk Description Set MCLK frequency Syntax k_s32 kd_mpi_vicap_set_mclk(k_vicap_mclk_id id, k_vicap_mclk_sel sel, k_u8 mclk_div, k_u8 mclk_en) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------|---------------| | id | MCLK ID | Input | | sel | clock source | Input | | mclk_div | Frequency division coefficient | Input | | mclk_en | Whether to turn on | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a #### kd_mpi_vicap_set_dump_reserved Description Set whether to enable fast dump mode Syntax void kd_mpi_vicap_set_dump_reserved(k_vicap_dev dev_num, k_vicap_chn chn_num, k_bool reserved) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------|---------------| | dev_num | VICAP device number | Input | | chn_num | VICAP output channel number | Input | | reserved | Whether to enable fast dump mode | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. #### kd_mpi_vicap_set_slave_enable Description Enable slave mode Syntax k_s32 kd_mpi_vicap_set_slave_enable(k_vicap_slave_id id, k_vicap_slave_enable *enable) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------|---------------| | id | ID of slave mode | Input | | enable | Whether to enable slave mode | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. #### kd_mpi_vicap_set_slave_attr Description Set slave mode parameters Syntax k_s32 kd_mpi_vicap_set_slave_attr(k_vicap_slave_id id, k_vicap_slave_info *info) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------|---------------| | id | ID of slave mode | Input | | info | Parameters of slave mode | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. #### kd_mpi_vicap_3d_mode_crtl Description Set 3d mode enable Syntax k_s32 kd_mpi_vicap_3d_mode_crtl(k_bool enable) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------|---------------| | enable | 3d mode enabled | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a ### Sensor This function module provides the following APIs: - [kd_mpi_sensor_open](#kd_mpi_sensor_open) - [kd_mpi_sensor_close](#kd_mpi_sensor_close) - [kd_mpi_sensor_power_set](#kd_mpi_sensor_power_set) - [kd_mpi_sensor_id_get](#kd_mpi_sensor_id_get) - [kd_mpi_sensor_init](#kd_mpi_sensor_init) - [kd_mpi_sensor_reg_read](#kd_mpi_sensor_reg_read) - [kd_mpi_sensor_reg_write](#kd_mpi_sensor_reg_write) - [kd_mpi_sensor_mode_get](#kd_mpi_sensor_mode_get) - [kd_mpi_sensor_mode_set](#kd_mpi_sensor_mode_set) - [kd_mpi_sensor_stream_enable](#kd_mpi_sensor_stream_enable) - [kd_mpi_sensor_again_set](#kd_mpi_sensor_again_set) - [kd_mpi_sensor_again_get](#kd_mpi_sensor_again_get) - [kd_mpi_sensor_dgain_set](#kd_mpi_sensor_dgain_set) - [kd_mpi_sensor_dgain_get](#kd_mpi_sensor_dgain_get) - [kd_mpi_sensor_intg_time_set](#kd_mpi_sensor_intg_time_set) - [kd_mpi_sensor_intg_time_get](#kd_mpi_sensor_intg_time_get) - [kd_mpi_sensor_otpdata_get](#kd_mpi_sensor_otpdata_get) - [kd_mpi_sensor_otpdata_set](#kd_mpi_sensor_otpdata_set) - [kd_mpi_sensor_get_exposure_time_range](#kd_mpi_sensor_get_exposure_time_range) - [kd_mpi_sensor_get_gain_range](#kd_mpi_sensor_get_gain_range) - [kd_mpi_sensor_get_focus_caps](#kd_mpi_sensor_get_focus_caps) #### kd_mpi_sensor_open Description Open the sensor device according to the sensor device name Syntax k_s32 kd_mpi_sensor_open(const char \*sensor_name) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------|---------------| | sensor_name | Sensor device name | Input | Return Value | **return value** | **describe** | |------------|------------------------| | Positive value | success. Return device descriptor | | negative value | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_close Description Close sensor device Syntax k_s32 kd_mpi_sensor_close (k_s32 fd) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_power_set Description Set sensor power status Syntax k_s32 kd_mpi_sensor_power_set(k_s32 fd, k_bool on) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-----------------------------------------------|---------------| | fd | Sensor device file descriptor | Input | | on | Set the sensor power-on status, K_TRUE: power on, K_FALSE: power off | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_id_get Description Get sensor id Syntax k_s32 kd_mpi_sensor_id_get(k_s32 fd, k_u32 \*sensor_id) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | sensor_id | Obtained sensor id | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_init Description Sensor initialization Syntax k_s32 kd_mpi_sensor_init(k_s32 fd, k_sensor_mode mode) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|---------------------------------------------|---------------| | fd | Sensor device file descriptor | Input | | mode | Initialize the sensor configuration register according to the specified sensor mode | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_reg_read Description Read the contents of the sensor register Syntax k_s32 kd_mpi_sensor_reg_read(k_s32 fd, k_u32 reg_addr, k_u32 \*reg_val) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | reg_addr | Sensor register address | Input | | reg_val | Read register contents | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_reg_write Description Write the contents of sensor register Syntax k_s32 kd_mpi_sensor_reg_write(k_s32 fd, k_u32 reg_addr, k_u32 reg_val) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | reg_addr | Sensor register address | Input | | reg_val | Write the contents of the sensor register | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_mode_get Description Get sensor mode configuration Syntax k_s32 kd_mpi_sensor_mode_get(k_s32 fd, k_sensor_mode \*mode) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-------------------------------|---------------| | fd | Sensor device file descriptor | Input | | mode | Return the obtained sensor mode configuration parameters | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_mode_set Description Set sensor mode configuration Syntax k_s32 kd_mpi_sensor_mode_get(k_s32 fd, k_sensor_mode mode) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|-------------------------|---------------| | fd | Sensor device file descriptor | Input | | mode | Set sensor mode configuration parameters | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_stream_enable Description Set sensor mode configuration Syntax k_s32 kd_mpi_sensor_stream_enable(k_s32 fd, k_s32 enable) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|--------------------------------------------------|---------------| | fd | Sensor device file descriptor | Input | | enable | Set the sensor stream output status, 0: disable output, non-0: enable output | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_again_set Description Set sensor analog gain Syntax k_s32 kd_mpi_sensor_again_set(k_s32 fd, k_sensor_gain gain) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | gain | gain configuration parameters | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_again_get Description Get sensor analog gain Syntax k_s32 kd_mpi_sensor_again_set(k_s32 fd, k_sensor_gain \*gain) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | gain | gain configuration parameters | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_dgain_set Description Set sensor digital gain Syntax k_s32 kd_mpi_sensor_dgain_set(k_s32 fd, k_sensor_gain gain) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | gain | gain configuration parameters | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_dgain_get Description Get sensor digital gain Syntax k_s32 kd_mpi_sensor_dgain_get(k_s32 fd, k_sensor_gain \*gain) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | gain | gain configuration parameters | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_intg_time_set Description Set sensor integration time Syntax k_s32 kd_mpi_sensor_intg_time_set(k_s32 fd, k_sensor_intg_time time) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | time | Integration time configuration parameters | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_intg_time_get Description Get sensor integration time Syntax k_s32 kd_mpi_sensor_intg_time_get(k_s32 fd, k_sensor_intg_time \*time) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | time | Integration time configuration parameters | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_otpdata_get Description Get sensor otp data Syntax k_s32 kd_mpi_sensor_otpdata_get(k_s32 fd, void *ota_data) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | ota_data | otp data | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_otpdata_set Description Set sensor otp data Syntax k_s32 kd_mpi_sensor_otpdata_set(k_s32 fd, void *ota_data) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | ota_data | otp data | Input | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | non-0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes None. Example None. Related Topics #### kd_mpi_sensor_get_exposure_time_range Description Get sensor exposure time range Syntax k_s32 kd_mpi_sensor_get_exposure_time_range(k_s32 fd, k_sensor_exposure_time_range *range) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | range | Exposure range configuration parameters | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | Not 0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes The returned exposure time unit is microseconds (us) Example ```c k_sensor_exposure_time_range range; k_s32 ret = kd_mpi_sensor_get_exposure_time_range(fd, &range); if (ret == 0) { printf("Exposure range: %.0f - %.0f us\n", range.min_intg_time_us, range.max_intg_time_us); } ``` Related Topics #### kd_mpi_sensor_get_gain_range Description Get the sensor gain range (including minimum value, maximum value and step size) Syntax k_s32 kd_mpi_sensor_get_gain_range(k_s32 fd, k_sensor_gain_range *range) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | range | Gain range configuration parameters | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | Not 0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes The returned gain range consists of min_gain, max_gain and step_gain Example ```c k_sensor_gain_range range; k_s32 ret = kd_mpi_sensor_get_gain_range(fd, &range); if (ret == 0) { printf("Gain range: %.2f - %.2f, step: %.6f\n", range.min_gain, range.max_gain, range.step_gain); } ``` Related Topics #### kd_mpi_sensor_get_focus_caps Description Obtain sensor focusing capability information (only supports sensor modules with autofocus function) Syntax k_s32 kd_mpi_sensor_get_focus_caps(k_s32 fd, k_sensor_autofocus_caps *caps) Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------------------|---------------| | fd | Sensor device file descriptor | Input | | caps | Focus capability configuration parameters | Output | Return Value | **return value** | **describe** | |------------|------------------------| | 0 | success. | | Not 0 | Failure, refer to error code definition. | Chip differences None. Requirements - Header File: mpi_sensor_api.h - Library File: libsensor.a Notes Only supports sensor modules with autofocus function Example ```c k_sensor_autofocus_caps caps; k_s32 ret = kd_mpi_sensor_get_focus_caps(fd, &caps); if (ret == 0) { printf("Focus caps available\n"); } ``` Related Topics #### kd_mpi_vicap_get_sensor_fd Description Get the sensor file descriptor associated with the VICAP device Syntax ```c k_s32 kd_mpi_vicap_get_sensor_fd(k_vicap_sensor_attr *sensor_attr) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | sensor_attr | Sensor attribute structure pointer, including device number and returned sensor_fd | Input/Output | Return Value | **return value** | **describe** | |------------|----------| | K_SUCCESS (0) | Success | | K_FAILED (not 0) | Failed, the device number is invalid or the sensor is not turned on | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - You must first initialize the VICAP device and open the sensor before you can obtain fd - sensor_attr->dev_num must be within the valid range (VICAP_DEV_ID_0 to VICAP_DEV_ID_MAX-1) - The returned sensor_fd can be used for subsequent sensor-related operations Example ```c k_vicap_sensor_attr sensor_attr; sensor_attr.dev_num = VICAP_DEV_ID_0; k_s32 ret = kd_mpi_vicap_get_sensor_fd(&sensor_attr); if (ret == K_SUCCESS) { printf("Sensor fd: %d\n", sensor_attr.sensor_fd); // You can use sensor_attr.sensor_fd for sensor operations } ``` Related Topics - [kd_mpi_sensor_open](#kd_mpi_sensor_open) --- #### kd_mpi_vicap_tpg_enable Description Enable or disable the test pattern generator (TPG, Test Pattern Generator) Syntax ```c k_s32 kd_mpi_vicap_tpg_enable(k_bool enable) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | enable | K_TRUE: enable TPG, K_FALSE: disable TPG | Input | Return Value | **return value** | **describe** | |------------|----------| | 0 | Success | | Not 0 | Failure, refer to error code definition | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - TPG is used for debugging and does not rely on real sensor input - When enabled, VICAP will output test patterns instead of real image data Example ```c // Enable test pattern kd_mpi_vicap_tpg_enable(K_TRUE); // Disable test pattern and use real sensor data kd_mpi_vicap_tpg_enable(K_FALSE); ``` Related Topics --- #### kd_mpi_vicap_load_image Description Load user image data into VICAP (for offline mode) Syntax ```c k_s32 kd_mpi_vicap_load_image(k_vicap_dev dev_num, const void *image_data, k_u32 data_len) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | dev_num | VICAP device number | Input | | image_data | Image data pointer | Input | | data_len | Image data length (bytes) | Input | Return Value | **return value** | **describe** | |------------|----------| | 0 | Success | | Not 0 | Failed, the device number is invalid or the parameters are wrong | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - Only available in offline mode (VICAP_WORK_OFFLINE_MODE) - image_data cannot be NULL - Data format needs to match VICAP configuration Example ```c // Load image data to VICAP device 0 const void *image_data = ...; // Image data k_u32 data_len = 1920 * 1080 * 3; // 1080P RGB data size k_s32 ret = kd_mpi_vicap_load_image(VICAP_DEV_ID_0, image_data, data_len); if (ret == 0) { printf("Image loaded successfully\n"); } ``` Related Topics - [kd_mpi_vicap_init](#kd_mpi_vicap_init) --- #### kd_mpi_vicap_dump_register Description Dump VICAP register configuration to file (for debugging) Syntax ```c k_s32 kd_mpi_vicap_dump_register(k_vicap_dev dev_num, const char *file_name) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | dev_num | VICAP device number | Input | | file_name | Output file path | Input | Return Value | **return value** | **describe** | |------------|----------| | 0 | Success | | Not 0 | Failed, file open failed or dump failed | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - The output file contains the register configuration for ISP and Dewarp (if enabled) - For debugging and problem analysis - The file will be overwritten if it already exists Example ```c // Dump register configuration of VICAP device 0 to file k_s32 ret = kd_mpi_vicap_dump_register(VICAP_DEV_ID_0, "/sdcard/vicap_reg_dump.txt"); if (ret == 0) { printf("Register dump saved to /sdcard/vicap_reg_dump.txt\n"); } ``` Related Topics --- #### kd_mpi_vicap_again_set Description Set sensor analog gain (Again) Syntax ```c k_s32 kd_mpi_vicap_again_set(k_vicap_dev dev_num, k_sensor_gain gain) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | dev_num | VICAP device number | Input | | gain | Gain configuration structure | Input | Return Value | **return value** | **describe** | |------------|----------| | 0 | Success | | Not 0 | Failure, refer to error code definition | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - The gain value must be within the sensor support range - It is recommended to call `kd_mpi_sensor_get_gain_range()` first to get the range - Gain structure definition reference [k_sensor_gain](#k_sensor_gain) Example ```c k_sensor_gain gain; gain.gain[0] = 4.0f; // Set channel 0 gain to 4.0 k_s32 ret = kd_mpi_vicap_again_set(VICAP_DEV_ID_0, gain); if (ret == 0) { printf("Gain set successfully\n"); } ``` Related Topics - [kd_mpi_vicap_again_get](#kd_mpi_vicap_again_get) - [kd_mpi_sensor_get_gain_range](#kd_mpi_sensor_get_gain_range) --- #### kd_mpi_vicap_again_get Description Get the current analog gain value of the sensor Syntax ```c k_s32 kd_mpi_vicap_again_get(k_vicap_dev dev_num, k_sensor_gain *gain) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | dev_num | VICAP device number | Input | | gain | Output gain configuration structure pointer | Output | Return Value | **return value** | **describe** | |------------|----------| | 0 | Success | | Not 0 | Failure, refer to error code definition | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - The gain pointer cannot be NULL - The unit of the returned gain value is a multiple (for example, 4.0 means 4 times gain) Example ```c k_sensor_gain gain; k_s32 ret = kd_mpi_vicap_again_get(VICAP_DEV_ID_0, &gain); if (ret == 0) { printf("Current gain: %.2f\n", gain.gain[0]); } ``` Related Topics - [kd_mpi_vicap_again_set](#kd_mpi_vicap_again_set) --- #### kd_mpi_vicap_intg_time_set Description Set sensor integration time (exposure time) Syntax ```c k_s32 kd_mpi_vicap_intg_time_set(k_vicap_dev dev_num, k_sensor_intg_time time) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | dev_num | VICAP device number | Input | | time | Integration time configuration structure (unit: seconds) | Input | Return Value | **return value** | **describe** | |------------|----------| | 0 | Success | | Not 0 | Failure, refer to error code definition | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - The integration time must be within the sensor support range - It is recommended to call `kd_mpi_sensor_get_exposure_time_range()` first to get the range - time structure definition reference [k_sensor_intg_time](#k_sensor_intg_time) Example ```c k_sensor_intg_time time; time.intg_time[0] = 0.01f; // 10ms exposure time k_s32 ret = kd_mpi_vicap_intg_time_set(VICAP_DEV_ID_0, time); if (ret == 0) { printf("Exposure time set to 10ms\n"); } ``` Related Topics - [kd_mpi_sensor_get_exposure_time_range](#kd_mpi_sensor_get_exposure_time_range) --- #### kd_mpi_vicap_set_af_enable Description Set the autofocus function enable status Syntax ```c k_s32 kd_mpi_vicap_set_af_enable(k_vicap_dev dev_num, k_bool enable) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | dev_num | VICAP device number | Input | | enable | K_TRUE: enable autofocus, K_FALSE: disable autofocus | Input | Return Value | **return value** | **describe** | |------------|----------| | 0 | Success | | Not 0 | Failure, refer to error code definition | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - Only supports sensor modules with autofocus function - After disabling, you need to manually call the focus interface. Example ```c // Enable autofocus kd_mpi_vicap_set_af_enable(VICAP_DEV_ID_0, K_TRUE); // Disable autofocus and use manual focus kd_mpi_vicap_set_af_enable(VICAP_DEV_ID_0, K_FALSE); ``` Related Topics - [kd_mpi_vicap_get_af_enable](#kd_mpi_vicap_get_af_enable) --- #### kd_mpi_vicap_get_af_enable Description Get the current enabling status of the autofocus function Syntax ```c k_s32 kd_mpi_vicap_get_af_enable(k_vicap_dev dev_num, k_bool *enable) ``` Parameters | **Parameter name** | **describe** | **Input/Output** | |--------------|----------|---------------| | dev_num | VICAP device number | Input | | enable | Output enable status pointer (K_TRUE: enabled, K_FALSE: disabled) | Output | Return Value | **return value** | **describe** | |------------|----------| | 0 | Success | | Not 0 | Failure, refer to error code definition | Chip differences None. Requirements - Header File: mpi_vicap_api.h - Library File: libvicap.a Notes - enable pointer cannot be NULL - The returned enable status reflects the current working status of the autofocus function. Example ```c k_bool enable; k_s32 ret = kd_mpi_vicap_get_af_enable(VICAP_DEV_ID_0, &enable); if (ret == 0) { if (enable) { printf("Auto-focus is enabled\n"); } else { printf("Auto-focus is disabled\n"); } } ``` Related Topics - [kd_mpi_vicap_set_af_enable](#kd_mpi_vicap_set_af_enable) --- ## data type ### VICAP The relevant data types of this function module are defined as follows: - [k_vicap_sensor_type](#k_vicap_sensor_type) - [k_vicap_dev](#k_vicap_dev) - [k_vicap_chn](#k_vicap_chn) - [k_vicap_csi_num](#k_vicap_csi_num) - [k_vicap_mipi_lanes](#k_vicap_mipi_lanes) - [k_vicap_csi_data_type](#k_vicap_csi_data_type) - [k_vicap_data_source](#k_vicap_data_source) - [k_vicap_vi_dvp_port](#k_vicap_vi_dvp_port) - [k_vicap_vi_flash_mode](#k_vicap_vi_flash_mode) - [k_vicap_img_window](#k_vicap_img_window) - [k_vicap_work_mode](#k_vicap_work_mode) - [k_vicap_sensor_info](#k_vicap_sensor_info) - [k_vicap_dump_format](#k_vicap_dump_format) - [k_vicap_dev_attr](#k_vicap_dev_attr) - [k_vicap_chn_attr](#k_vicap_chn_attr) #### k_vicap_sensor_type [Description] Definition of sensor types currently supported by the system definition ```c typedef enum { OV_OV9732_MIPI_1280X720_30FPS_10BIT_LINEAR = 0, OV_OV9286_MIPI_1280X720_30FPS_10BIT_LINEAR_IR = 1, OV_OV9286_MIPI_1280X720_30FPS_10BIT_LINEAR_SPECKLE = 2, OV_OV9286_MIPI_1280X720_60FPS_10BIT_LINEAR_IR = 3, OV_OV9286_MIPI_1280X720_60FPS_10BIT_LINEAR_SPECKLE = 4, OV_OV9286_MIPI_1280X720_30FPS_10BIT_LINEAR_IR_SPECKLE = 5, OV_OV9286_MIPI_1280X720_60FPS_10BIT_LINEAR_IR_SPECKLE = 6, IMX335_MIPI_2LANE_RAW12_1920X1080_30FPS_LINEAR = 7, IMX335_MIPI_2LANE_RAW12_2592X1944_30FPS_LINEAR = 8, IMX335_MIPI_4LANE_RAW12_2592X1944_30FPS_LINEAR = 9, IMX335_MIPI_2LANE_RAW12_1920X1080_30FPS_MCLK_7425_LINEAR = 10, IMX335_MIPI_2LANE_RAW12_2592X1944_30FPS_MCLK_7425_LINEAR = 11, IMX335_MIPI_4LANE_RAW12_2592X1944_30FPS_MCLK_7425_LINEAR = 12, IMX335_MIPI_4LANE_RAW10_2XDOL = 13, IMX335_MIPI_4LANE_RAW10_3XDOL = 14, SC_SC035HGS_MIPI_1LANE_RAW10_640X480_120FPS_LINEAR = 15, SC_SC035HGS_MIPI_1LANE_RAW10_640X480_60FPS_LINEAR = 16, SC_SC035HGS_MIPI_1LANE_RAW10_640X480_30FPS_LINEAR = 17, OV_OV9286_MIPI_1280X720_30FPS_10BIT_MCLK_25M_LINEAR_SPECKLE = 18, OV_OV9286_MIPI_1280X720_30FPS_10BIT_MCLK_25M_LINEAR_IR = 19, OV_OV9732_MIPI_1280X720_30FPS_10BIT_MCLK_16M_LINEAR = 20, OV_OV5647_MIPI_1920X1080_30FPS_10BIT_LINEAR = 21, OV_OV5647_MIPI_2592x1944_10FPS_10BIT_LINEAR = 22, OV_OV5647_MIPI_640x480_60FPS_10BIT_LINEAR = 23, OV_OV5647_MIPI_CSI0_1920X1080_30FPS_10BIT_LINEAR = 24, SC_SC201CS_MIPI_1LANE_RAW10_1600X1200_30FPS_LINEAR = 25, SC_SC201CS_SLAVE_MODE_MIPI_1LANE_RAW10_1600X1200_30FPS_LINEAR = 26, OV_OV5647_MIPI_CSI1_1920X1080_30FPS_10BIT_LINEAR = 27, OV_OV5647_MIPI_CSI2_1920X1080_30FPS_10BIT_LINEAR = 28, XS9922B_MIPI_CSI0_1280X720_30FPS_YUV422_DOL3 = 29, XS9950_MIPI_CSI0_1280X720_30FPS_YUV422 = 30, XS9950_MIPI_CSI1_1280X720_30FPS_YUV422 = 31, XS9950_MIPI_CSI2_1280X720_30FPS_YUV422 = 32, XS9950_MIPI_CSI0_1920X1080_30FPS_YUV422 = 33, OV_OV9286_MIPI_1280X720_30FPS_10BIT_MCLK_25M_LINEAR_SPECKLE_V2 = 34, OV_OV9286_MIPI_1280X720_30FPS_10BIT_MCLK_25M_LINEAR_IR_V2 = 35, OV_OV9732_MIPI_1280X720_30FPS_10BIT_MCLK_16M_LINEAR_V2 = 36, OV_OV5647_MIPI_CSI0_1920X1080_30FPS_10BIT_LINEAR_V2 = 37, OV_OV5647_MIPI_CSI1_1920X1080_30FPS_10BIT_LINEAR_V2 = 38, OV_OV5647_MIPI_CSI2_1920X1080_30FPS_10BIT_LINEAR_V2 = 39, GC2053_MIPI_CSI0_1920X1080_30FPS_10BIT_LINEAR = 40, SENSOR_TYPE_MAX, } k_vicap_sensor_type; ``` member | **Member name** | **describe** | |----------------------------------------------------|-----------------------------------------| | OV_OV9732_MIPI_1280X720_30FPS_10BIT_LINEAR | OV9732 1lan 10bit 720P30 frame linear output configuration external crystal oscillator 16M connected to csi0 | | OV_OV9286_MIPI_1280X720_30FPS_10BIT_LINEAR_IR | OV9286 2lan 10bit 720P30 frame linear output configuration ir image external crystal oscillator 25M connected to CSI1 | | OV_OV9286_MIPI_1280X720_30FPS_10BIT_LINEAR_SPECKLE | OV9286 2lan 10bit 720P30 frame linear output configuration speckle image external crystal oscillator 25M connected to CSI1 | | OV_OV9286_MIPI_1280X720_60FPS_10BIT_LINEAR_IR | OV9286 2lan 10bit 720P60 frame linear output configuration ir image external crystal oscillator 25M connected to CSI1 | | OV_OV9286_MIPI_1280X720_60FPS_10BIT_LINEAR_SPECKLE | OV9286 2lan 10bit 720P60 frame linear output configuration speckle image external crystal oscillator 25M connected to CSI1 | | IMX335_MIPI_2LANE_RAW12_1920X1080_30FPS_LINEAR | imx335 12bit 2lan 1080P30 frame linear output external crystal oscillator 24M connected to csi0 | | IMX335_MIPI_2LANE_RAW12_2592X1944_30FPS_LINEAR | imx335 12bit 2lan full size 30 frame linear output external crystal oscillator 24M connected to csi0 | | IMX335_MIPI_4LANE_RAW12_2592X1944_30FPS_LINEAR | imx335 12bit 4lan full size 30 frame linear output external crystal oscillator 24M connected to csi0 | | IMX335_MIPI_2LANE_RAW12_1920X1080_30FPS_MCLK_7425_LINEAR | imx335 12bit 2lan 1080P30 frame linear output chip output 74.25M clock connected to csi0 | | IMX335_MIPI_2LANE_RAW12_2592X1944_30FPS_MCLK_7425_LINEAR | imx335 12bit 2lan full size 30 frame linear output chip output 74.25M clock connected to csi0 | | IMX335_MIPI_4LANE_RAW12_2592X1944_30FPS_MCLK_7425_LINEAR | imx335 12bit 4lan full size 30 frame linear output chip output 74.25M clock connected to csi0 | | IMX335_MIPI_4LANE_RAW10_2XDOL | imx335 10bit 4lan full size 15 frames 2dol output external crystal oscillator 24M connected to csi0 | | IMX335_MIPI_4LANE_RAW10_3XDOL | imx335 10bit 4lan full size 15 frames 3dol output external crystal oscillator 24M connected to csi0 | | SC_SC035HGS_MIPI_1LANE_RAW10_640X480_120FPS_LINEAR | sc035 10bit 1lan 640x480 120 frame linear output external crystal oscillator 24M connected to csi2 | | SC_SC035HGS_MIPI_1LANE_RAW10_640X480_60FPS_LINEAR | sc035 10bit 1lan 640x480 60 frame linear output external crystal oscillator 24M connected to csi2 | | SC_SC035HGS_MIPI_1LANE_RAW10_640X480_30FPS_LINEAR | sc035 10bit 1lan 640x480 30 frames linear output external crystal oscillator 24M connected to csi2 | | OV_OV9286_MIPI_1280X720_30FPS_10BIT_MCLK_25M_LINEAR_SPECKLE | OV9286 2lan 10bit 720P30 frame linear output configuration speckle image chip output 25M clock connected to CSI1 | | OV_OV9286_MIPI_1280X720_30FPS_10BIT_MCLK_25M_LINEAR_IR | OV9286 2lan 10bit 720P30 frame linear output configuration ir image chip output 25M clock connected to CSI1 | | OV_OV9732_MIPI_1280X720_30FPS_10BIT_MCLK_16M_LINEAR | OV9732 1lan 10bit 720P30 frame linear output configuration chip output 16M clock connected to csi0 | | OV_OV5647_MIPI_1920X1080_30FPS_10BIT_LINEAR | OV5647 2lan 10bit 1080P30 frame linear output configuration external crystal oscillator 25M connected to CSI2 | | OV_OV5647_MIPI_2592x1944_10FPS_10BIT_LINEAR | OV5647 2lan 10bit full size 10 frame linear output configuration external crystal oscillator 25M connected to CSI2 | | OV_OV5647_MIPI_640x480_60FPS_10BIT_LINEAR | OV5647 2lan 10bit 640x480 60 frame linear output configuration external crystal oscillator 25M connected to CSI2 | | OV_OV5647_MIPI_CSI0_1920X1080_30FPS_10BIT_LINEAR | OV5647 2lan 10bit 1080P30 frame linear output configuration chip output 25M clock connected to csi0 | | SC_SC201CS_MIPI_1LANE_RAW10_1600X1200_30FPS_LINEAR | sc201 1lan 10bit 1600x1200 30 frames linear output crystal oscillator 27M connected to csi1 | | SC_SC201CS_SLAVE_MODE_MIPI_1LANE_RAW10_1600X1200_30FPS_LINEAR | sc201 1lan 10bit slave mode 1600x1200 30 frames linear output crystal oscillator 27M connected to csi1 | | OV_OV5647_MIPI_CSI1_1920X1080_30FPS_10BIT_LINEAR | OV5647 2lan 10bit 1080P30 frame linear output configuration external crystal oscillator 25M external csi1 | | OV_OV5647_MIPI_CSI2_1920X1080_30FPS_10BIT_LINEAR | OV5647 2lan 10bit 1080P30 frame linear output configuration external crystal oscillator 25M external csi2 | | XS9950_MIPI_CSI0_1280X720_30FPS_YUV422 | XS9950 2lan yuv422 720P25 frame linear output analog camera connected to CSI0 | | XS9950_MIPI_CSI1_1280X720_30FPS_YUV422 | XS9950 2lan yuv422 720P25 frame linear output analog camera connected to CSI1 | | OV_OV9286_MIPI_1280X720_30FPS_10BIT_MCLK_25M_LINEAR_SPECKLE_V2 | OV9286 2lan 10bit 720P30 frame linear output configuration speckle image chip output 25M clock connected to CSI1 | | OV_OV9286_MIPI_1280X720_30FPS_10BIT_MCLK_25M_LINEAR_IR_V2 | OV9286 2lan 10bit 720P30 frame linear output configuration ir image chip output 25M clock connected to CSI1 | | OV_OV9732_MIPI_1280X720_30FPS_10BIT_MCLK_16M_LINEAR_V2 | OV9732 1lan 10bit 720P30 frame linear output configuration chip output 16M clock connected to CSI2 | | OV_OV5647_MIPI_CSI0_1920X1080_30FPS_10BIT_LINEAR_V2 | OV5647 2lan 10bit 1080P30 frame linear output configuration external crystal oscillator 25M external csi0 | | OV_OV5647_MIPI_CSI1_1920X1080_30FPS_10BIT_LINEAR_V2 | OV5647 2lan 10bit 1080P30 frame linear output configuration external crystal oscillator 25M external csi1 | | OV_OV5647_MIPI_CSI2_1920X1080_30FPS_10BIT_LINEAR_V2 | OV5647 2lan 10bit 1080P30 frame linear output configuration chip output 25M clock connected to CSI2 | | GC2053_MIPI_CSI0_1920X1080_30FPS_10BIT_LINEAR | GC2053 2lan 10bit 1080P30 frame linear output configuration chip output 16M clock connected to csi0 | Notes 1. This list needs to be maintained by sensor driver developers. Application developers use the sensor type defined here to open the sensor device of the specified type. #### k_vicap_dev [Explanation] vicap device number definition definition ```c typedef enum { VICAP_DEV_ID_0 = 0, VICAP_DEV_ID_1 = 1, VICAP_DEV_ID_2 = 2, VICAP_DEV_ID_MAX, } k_vicap_dev; ``` member | **Member name** | **describe** | |----------------|------------| | VICAP_DEV_ID_0 | VICAP device 0 | | VICAP_DEV_ID_1 | VICAP device 1 | | VICAP_DEV_ID_2 | VICAP device 2 | #### k_vicap_chn [Explanation] vicap output channel number definition definition ```c typedef enum { VICAP_CHN_ID_0 = 0, VICAP_CHN_ID_1 = 1, VICAP_CHN_ID_2 = 2, VICAP_CHN_ID_MAX, } k_vicap_chn; ``` member | **Member name** | **describe** | |----------------|----------------| | VICAP_CHN_ID_0 | VICAP output channel 0 | | VICAP_CHN_ID_1 | VICAP output channel 1 | | VICAP_CHN_ID_2 | VICAP output channel 2 | #### k_vicap_csi_num [Explanation] vicap csi label definition definition ```c typedef enum { VICAP_CSI0 = 1, VICAP_CSI1 = 2, VICAP_CSI2 = 3, } k_vicap_csi_num; ``` member | **Member name** | **describe** | |--------------|----------| | VICAP_CSI0 | CSI0 | | VICAP_CSI1 | CSI1 | | VICAP_CSI2 | CSI2 | Notes The CSI number of the Sensor connection is determined by the physical connection of the hardware. #### k_vicap_mipi_lanes [Explanation] Vicap mipi channel number definition definition ```c typedef enum { VICAP_MIPI_1LANE = 0, VICAP_MIPI_2LANE = 1, VICAP_MIPI_4LANE = 3, } k_vicap_mipi_lanes; ``` member | **Member name** | **describe** | |------------------|----------| | VICAP_MIPI_1LANE | 1 lane | | VICAP_MIPI_2LANE | 2 lane | | VICAP_MIPI_4LANE | 4 lane | Notes The number of mipi channels used for Sensor connection is determined by the physical connection of the hardware. When using 4lane, only two sensors can be connected at most. #### k_vicap_csi_data_type [Explanation] Vicap mipi channel number definition definition ```c typedef enum { VICAP_CSI_DATA_TYPE_RAW8 = 0x2A, VICAP_CSI_DATA_TYPE_RAW10 = 0x2B, VICAP_CSI_DATA_TYPE_RAW12 = 0x2C, VICAP_CSI_DATA_TYPE_RAW14 = 0x2D, } k_vicap_csi_data_type; ``` member | **Member name** | **describe** | |---------------------------|----------| | VICAP_CSI_DATA_TYPE_RAW8 | RAW8 | | VICAP_CSI_DATA_TYPE_RAW10 | RAW10 | | VICAP_CSI_DATA_TYPE_RAW12 | RAW12 | | VICAP_CSI_DATA_TYPE_RAW14 | RAW14 | Notes None #### k_vicap_data_source [Description] vicap data source definition ```c typedef enum { VICAP_SOURCE_CSI0 = 0, /**< vicap acquire data from the csi0*/ VICAP_SOURCE_CSI1 = 1, /**< vicap acquire data from the csi0*/ VICAP_SOURCE_CSI1_FS_TR0 = 2, /**