Changes

Jump to navigation Jump to search
Created page with "查看中文 ===Overview=== The MV series and RAW series cameras are cameras designed for AI applications in the industrial field. They use t..."
[[MV Camera on Radxa Boards/zh|查看中文]]

===Overview===
The MV series and RAW series cameras are cameras designed for AI applications in the industrial field. They use the MIPI CSI-2 interface and are particularly suitable for use with embedded computing platforms. They have rich data formats and triggering features, extremely low latency, high bandwidth, and reliable stability.

This article takes Radxa's ZERO 3W board as an example to introduce how to connect MV and RAW series cameras to the RK3566/3K3568 system.

We provide drivers for the Linux operating system (using Radxa OS Debainas an example).
====Camera Module List====
{| class="wikitable"
!Series
!Model
!Status
|-
|MV series
|MV-MIPI-IMX178M
|Done
|-
|MV series
|MV-MIPI-SC130M
|Done
|-
|MV series
|MV-MIPI-IMX296M
|Done
|-
|MV series
|MV-MIPI-IMX287M
|Done
|-
|MV series
|MV-MIPI-IMX265M
|Done
|-
|MV series
|MV-MIPI-IMX264M
|Done
|-
|RAW series
|RAW-MIPI-SC132M
|Done
|-
|RAW series
|RAW-MIPI-IMX462M
|Done
|-
|RAW series
|RAW-MIPI-AR0234M
|Done
|}
===Hardware Setup===
====Connection of MV series camera and Radxa ZERO 3W====
The MV series cameras require the ADP-MV1 adapter board in order to connect to the Radxa ZERO 3W board.

The ADP-MV1 and Zero 3W are connected to each other using a 15 to 22P FFC cable, taking care that the silver contacts are facing outwards.
{| class="wikitable"
!TOP
!BOTTOM
|-
|[[File:Radxa Zero 3W connect to MV camera.jpg|link=https://wiki.veye.cc/index.php/File:Radxa%20Zero%203W%20connect%20to%20MV%20camera.jpg|alt=|center|thumb|600x600px|Radxa Zero 3W connect to MV camera]]
|[[File:Radxa Zero 3W connect to MV camera 2.jpg|link=https://wiki.veye.cc/index.php/File:Radxa%20Zero%203W%20connect%20to%20MV%20camera%202.jpg|alt=|center|thumb|600x600px|Radxa Zero 3W connect to MV camera 2]]
|}
=====Connection of RAW-MIPI-SC132M and ADP-MV2=====
The two are connected to each other using a 15 to 22P FFC cable, taking care that the silver contacts are facing outwards.
{| class="wikitable"
!TOP
!BOTTOM
|-
|[[File:Radxa Zero 3W connect to RAW-MIPI-SC132M.jpg|link=https://wiki.veye.cc/index.php/File:Radxa%20Zero%203W%20connect%20to%20RAW-MIPI-SC132M.jpg|alt=|center|thumb|600x600px|Radxa Zero 3W connect to RAW-MIPI-SC132M]]
|[[File:Radxa Zero 3W connect to RAW-MIPI-SC132M 2.jpg|link=https://wiki.veye.cc/index.php/File:Radxa%20Zero%203W%20connect%20to%20RAW-MIPI-SC132M%202.jpg|alt=|center|thumb|600x600px|Radxa Zero 3W connect to RAW-MIPI-SC132M 2]]
|}
====Connection of other RAW series camera and Radxa ZERO 3W====
The two are connected using 0.5 mm pitch*pin FFC cable with opposite-side contacts. The cable must be inserted with the silver contacts facing outside.
{| class="wikitable"
!TOP
!BOTTOM
|-
|[[File:Radxa Zero 3W connect to RAW series camera.jpg|link=https://wiki.veye.cc/index.php/File:Radxa%20Zero%203W%20connect%20to%20RAW%20series%20camera.jpg|alt=|center|thumb|600x600px|Radxa Zero 3W connect to RAW series camera]]
|[[File:Radxa Zero 3W connect to RAW series camera 2.jpg|link=https://wiki.veye.cc/index.php/File:Radxa%20Zero%203W%20connect%20to%20RAW%20series%20camera%202.jpg|alt=ADP-MV2 to RAW series camera No.2|center|thumb|600x600px|Radxa Zero 3W connect to RAW series camera 2]]
|}
===Introduction to github repositories===
https://github.com/veyeimaging/rk35xx_radxa

includes:

*driver source code
*i2c toolkits
*application demo

In addition, a compiled linux kernel installation package and Android image is provided in the [https://github.com/veyeimaging/rk356x_radxa/releases releases].
===Upgrade Radxa Ubuntu system===
For the ROC-RK3566-PC and ROC-RK3588S-PC, we have provided an image of the release system.

Download the latest Ubuntu imge from [https://github.com/veyeimaging/rk35xx_firefly/releases/ https://github.com/veyeimaging/rk35xx_Radxa/releases/] .

Refer to the Radxa documentation [https://wiki.t-firefly.com/en/ROC-RK3588S-PC/upgrade_bootmode.html ROC-RK3588S-PC] [https://wiki.t-firefly.com/en/ROC-RK3566-PC/03-upgrade_firmware.html ROC-RK3566-PC]to burn in a standard system.
===Check system status===
====Whether the camera is correctly recognized====
After system update, reboot the main board.

Execute the following command on the main board to check if the camera is properly connected.

<code>dmesg | grep mvcam</code>

You can see the camera model and the camera version number probed.

A prompt as below indicates that the MV-MIPI-IMX296M camera is detected on the i2c-7 bus.

<code>mvcam 7-003b: camera is:MV-MIPI-IMX296M</code>

<code>mvcam 7-003b: firmware version: 0x1290133</code>

On the ROC-RK3588S-PC, the camera is mounted on i2c-7, with an i2c address of 0x3b.

On the ROC-RK3566-PC, the camera is mounted on i2c-4.

*Check the video0 device node:

<code>ls /dev/video0</code>

You should see:

<code>video0</code>

After successfully identifying the camera, the camera will be recognized as /dev/video0.
====Using media-ctl to view topology====
Using the media-ctl command can clearly display the current topography structure.

<code>media-ctl -p -d /dev/media0</code>
=====Link relationship=====
mv camera->rockchip-csi2-dphy0->rockchip-mipi-csi2->stream_cif_mipi_id0 - - ->DDR(/dev/video0)

The application can obtain images through the /dev/video0 node.
=====mv camera entity information=====
Taking the MV-MIPI-IMX296M as an example:

<code>- entity 63: m00_b_mvcam 7-003b (1 pad, 1 link)</code>

<code>             type V4L2 subdev subtype Sensor flags 0</code>

<code>             device node name /dev/v4l-subdev2</code>

<code>        pad0: Source</code>

<code>                [fmt:Y8_1X8/1456x1088@100/6000 field:none]</code>

<code>                -> "rockchip-csi2-dphy0":0 [ENABLED]</code>

You can see that:

*The complete name of this entity is: <code>m00_b_mvcam 7-003b</code>.(It is <code>m00_b_mvcam 4-003b</code>on ROC-RK3566-PC.)
*It is a V4L2 subdev (Sub-Device) Sensor.
*Its corresponding node is <code>/dev/v4l-subdev2</code>, which can be opened and configured by applications (such as <code>v4l2-ctl</code>).
*Its output format is <code>[fmt:Y8_1X8/1456x1088@100/6000 field:none]</code>, where <code>Y8_1X8</code> is a shorthand for a mbus-code, which will be listed in the next section of this article.
*The current resolution is <code>1456x1088</code>.
*The current frame interval is <code>100/6000</code>, which means the frame rate is 60.
*The data format output by the camera can be modified using the media-ctl command.

=====mbus-code list=====
MV series and RAW series cameras have different data format capabilities, which can be found in the data manual for each camera model.
{| class="wikitable"
!Format on datasheet
!mbus-code for media-ctl
!FourCC pixelformat for v4l2-ctl
|-
|RAW8
|Y8_1X8
|GREY
|-
|RAW10
|Y10_1X10
|'Y10 '
|-
|RAW12
|Y12_1X12
|'Y12 '
|-
|UYVY
|UYVY8_2X8
|UYVY
|}
===Raw data format===
The VICAP module of RK3588 supports two data saving formats, Compact and Noncompact RAW. You can modify the mode using the RKCIF_CMD_SET_CSI_MEMORY_MODE ioctl command of RKCIF. By default, the output is in Compact RAW format.[[File:Compact raw and noncompact raw of rk3588 vicap.png|center|thumb|800x800px|Compact raw and noncompact raw of rk3588 VICAP|link=http://wiki.veye.cc/index.php/File:Compact_raw_and_noncompact_raw_of_rk3588_vicap.png]]
====Noncompact RAW====
For pixel data with 10-bit depth or 12-bit depth, two bytes are always used to store one pixel. This storage method is convenient for software processing, but it has the disadvantage of occupying a large amount of space.

Depending on whether the effective data is stored in the high bits or low bits, it can be further divided into two types: high align and low align.
=====Noncompact RAW(high align)=====
Data is saved to the high bits, and the unused low bits are filled with 0. This is one of the data formats supported by RK VICAP.
=====Noncompact RAW(low align)=====
In Noncompact RAW (low align) format, data is saved to the low bits, and the unused high bits are filled with 0. The V4L2 standard 'Y10' (10-bit Greyscale) and 'Y12' (12-bit Greyscale) formats are both stored in this way.

The pixel_layer_convert conversion tool mentioned later in the article also converts Compact RAW to this storage format for easy display using image players.
====Compact RAW====
As shown above,there is no bit padding between pixels in this storage format.
====Line stride====
To facilitate fast operations on images, the system usually provides row-aligned buffer sizes for each line of data. RK3588 uses 256-byte alignment for this purpose.

line_stride = ALIGN_UP(image_width*bits_per_pixel/8,256)

For example, when the image width is 1456:

8bit depth,line_stride=1536

10bit depth,preferred_stride=2048

12bit depth,preferred_stride=2304
====Format convert tool====
We have written a small tool: [https://github.com/veyeimaging/pixel_layer_convert pixel_layer_convert], which can easily convert Compact images to Noncompact (low align) images.

For example, the following command can convert a Compact RAW10 image with a width of 1456 to Noncompact RAW10 format:

<code>./pixel_layer_convert -I R10C -i y10-1456x1088_0001.raw -o y10-1456x1088_0001_new.raw -w 1456</code>
====Raw data image player====
We recommend using [https://www.offminor.de/ vooya] as the player, which supports GREY, and unpacked image formats.

Also, y8 file can be used with this player: [https://yuv-player-deluxe.software.informer.com/2.6/ YUV Displayer Deluxe].
===Application examples===
====Configuring  global variables====
Based on the board model, configure the I2C_BUS global variable as follows:

*ROC-RK3588S-PC

<code>export I2C_BUS=7</code>

*ROC-RK3566-PC

<code>export I2C_BUS=4</code>

For the convenience of later descriptions, global variables are configured here according to the sensor size.

*MV-MIPI-IMX178M

<code>export WIDTH=3088</code>

<code>export HEIGHT=2064</code>

<code>export FPS=22</code>

*MV-MIPI-SC130M

<code>export WIDTH=1280</code>

<code>export HEIGHT=1024</code>

<code>export FPS=108</code>

*MV-MIPI-IMX296M

<code>export WIDTH=1456</code>

<code>export HEIGHT=1088</code>

<code>export FPS=60</code>

*MV-MIPI-IMX287M

<code>export WIDTH=704</code>

<code>export HEIGHT=544</code>

<code>export FPS=319</code>

*MV-MIPI-IMX265M

<code>export WIDTH=2048</code>

<code>export HEIGHT=1544</code>

<code>export FPS=45</code>

*MV-MIPI-IMX264M

<code>export WIDTH=2432</code>

<code>export HEIGHT=2056</code>

<code>export FPS=28</code>

*RAW-MIPI-SC132M

<code>export WIDTH=1024</code>

<code>export HEIGHT=1280</code>

<code>export FPS=120</code>

*RAW-MIPI-IMX462M

<code>export WIDTH=1920</code>

<code>export HEIGHT=1088</code>

<code>export FPS=60</code>

*RAW-MIPI-AR0234M

<code>export WIDTH=1920</code>

<code>export HEIGHT=1200</code>

<code>export FPS=60</code>
====Configure parameters using v4l2-ctl====
<code>$ v4l2-ctl -d /dev/v4l-subdev2 -L</code>

<code>User Controls</code>

<code>                   trigger_mode 0x00981901 (int)    : min=0 max=2 step=1 default=0 value=0 flags=volatile, execute-on-write</code>

<code>                    trigger_src 0x00981902 (int)    : min=0 max=1 step=1 default=1 value=1 flags=volatile, execute-on-write</code>

<code>                    soft_trgone 0x00981903 (button) : flags=write-only, execute-on-write</code>

<code>                     frame_rate 0x00981904 (int)    : min=1 max=60 step=1 default=60 value=60 flags=volatile, execute-on-write</code>

<code>                          roi_x 0x00981905 (int)    : min=0 max=1376 step=8 default=0 value=0</code>

<code>                          roi_y 0x00981906 (int)    : min=0 max=1024 step=4 default=0 value=0</code>

Parameters can be set and get using the following methods.

<code>v4l2-ctl --set-ctrl [ctrl_type]=[val]</code>

<code>v4l2-ctl --get-ctrl [ctrl_type]</code>

All the above functions can be implemented using [[Mv mipi i2c.sh user guide|mv_mipi_i2c.sh]].

Note that the above parameters cannot be modified during the capture process.

The following is an explanation of each parameter:
=====Trigger Mode=====
<code>v4l2-ctl --set-ctrl <small>trigger_mode=[0-2]</small></code>

0:Video streaming mode

1:Normal trigger mode.

2:High-speed continuous trigger mode.
=====Trigger Source=====
<code>v4l2-ctl --set-ctrl <small>trigger_src=[0-1]</small></code>

0: Software trigger mode.

1: Hardware trigger mode.
=====Software trigger command=====
<code>v4l2-ctl --set-ctrl <small>soft_trgone=1</small></code>
=====Set frame rate=====
<code>v4l2-ctl --set-ctrl frame_rate=[1-max]</code>

The maximum frame rate is automatically updated as the resolution changed.
=====Set the starting position of the ROI=====
<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl roi_x=0</code>

<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl roi_y=0</code>

After setting the ROI starting position, you need to complete the full ROI configuration using the <code>media-ctl</code> command.

Note that setting the ROI may affect the maximum frame rate, and the ROI parameters need to meet the requirements specified in the camera manual.
====Set image format using media-ctl====
use the following command to configure the camera's data format, resolution, and frame rate using <code>media-ctl</code>:

<code>media-ctl -d /dev/media0 --set-v4l2 '"m00_b_mvcam '"$I2C_BUS"'-003b":0[fmt:Y8_1X8/'"$WIDTH"'x'"$HEIGHT"'@1/'"$FPS"']'</code>

Among them: <code>"m00_b_mvcam '"$I2C_BUS"'-003b"</code> refers to the complete name of the camera entity, <code>Y8_1X8</code> is the mbus-code, <code>'"$WIDTH"'x'"$HEIGHT"'</code> indicates the resolution, <code>1/'"$FPS"'</code> indicates the resolution frame rate.

The width and height here cooperate with the roi_x and roi_y of the v4l2-ctl command to form the ROI parameter.

For example, for MV-MIPI-IMX296M, the command after variable replacement would be:

<code>media-ctl -d /dev/media0 --set-v4l2 '"m00_b_mvcam 7-003b":0[fmt:Y8_1X8/1456x1088@1/60 field:none]'</code>

You can not only configure the data format, resolution, and frame rate in one command, but also modify them separately as needed.
====Video Streaming mode====
=====Set data format, resolution, frame rate=====
<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl roi_x=0</code>

<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl roi_y=0</code>

<code>media-ctl -d /dev/media0 --set-v4l2 '"m00_b_mvcam '"$I2C_BUS"'-003b":0[fmt:Y8_1X8/'"$WIDTH"'x'"$HEIGHT"'@1/'"$FPS"']'</code>
=====Frame rate statistics=====
In streaming mode, the following commands can be used for frame rate statistics:

<code>v4l2-ctl --set-fmt-video=width=$WIDTH,height=$HEIGHT,pixelformat=GREY --stream-mmap --stream-count=-1 --stream-to=/dev/null</code>

Or:

<code>./yavta -c1000 --skip 0 -f Y8 -s ${WIDTH}x${HEIGHT} /dev/video0</code>
=====Save image to file=====

*raw8

<code>v4l2-ctl -d /dev/video0 --set-fmt-video=width=$WIDTH,height=$HEIGHT,pixelformat=GREY --stream-mmap --stream-count=1 --stream-to=y8-${WIDTH}x${HEIGHT}.raw</code>

*raw10

<code>v4l2-ctl -d /dev/video0 --set-fmt-video=width=$WIDTH,height=$HEIGHT,pixelformat='Y10 ' --stream-mmap --stream-count=1 --stream-to=y10-${WIDTH}x${HEIGHT}.raw</code>

*raw12

<code>v4l2-ctl -d /dev/video0 --set-fmt-video=$WIDTH,height=$HEIGHT,pixelformat='Y12 ' --stream-mmap --stream-count=1 --stream-to=y12-${WIDTH}x${HEIGHT}.raw</code>

Please refer to the description in the previous section for the image format.
=====Example of yavta=====
======Install yavta======
<code>git clone <nowiki>git://git.ideasonboard.org/yavta.git</nowiki></code>

<code>cd yavta;make</code>
======Save image to file======
After setting data format, resolution, frame rate,run:

<code>./yavta -c1 -Fy8-${WIDTH}x${HEIGHT}.raw --skip 0 -f Y8 -s ${WIDTH}x${HEIGHT} /dev/video0</code>
=====Example of import image to OpenCV=====
<code>sudo apt install python3-opencv</code>

See the [https://github.com/veyeimaging/rk356x_firefly/tree/main/linux/samples samples] directory on github for details.

<code>python ./v4l2dev_2_opencv_show_grey.py --width 1456 --height 1088 --fps 60 --i2c 7</code>
=====Example of gstreamer application=====
To facilitate installation and debugging, the MV series cameras provide UYVY mode, which supports a maximum width of 2880 and can be previewed in real time using the following command.

Note that the RAW series does not support the UYVY format.

Note: To increase the maximum frame rate and bandwidth, some modules no longer support the UYVY format. Please use the "fmtcap" command in the script to read the registers to confirm the specific configuration.

We provide several gstreamer routines that implement the preview function. See the [https://github.com/veyeimaging/rk356x_firefly/tree/main/linux/samples samples] directory on github for details.
====Trigger mode====
=====Set data format, resolution, frame rate=====
<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl roi_x=0</code>

<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl roi_y=0</code>

<code>media-ctl -d /dev/media0 --set-v4l2 '"m00_b_mvcam '"$I2C_BUS"'-003b":0[fmt:Y8_1X8/'"$WIDTH"'x'"$HEIGHT"'@1/'"$FPS"']'</code>
=====Software trigger mode=====
======Set mode======
<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl <small>trigger_mode=1</small></code>

<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl <small>trigger_src=0</small></code>
======Start acquisition======
<code>v4l2-ctl -d /dev/video0 --set-fmt-video=width=$WIDTH,height=$HEIGHT,pixelformat=GREY --stream-mmap --stream-count=1 --stream-to=y8-${WIDTH}x${HEIGHT}.raw</code>
======Perform soft trigger operation======
In other shell terminals, you can execute the following command multiple times for multiple triggers.

<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl <small>soft_trgone=1</small></code>
=====Hardware trigger mode=====
======Set mode======
<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl <small>trigger_mode=1</small></code>

<code>v4l2-ctl -d /dev/v4l-subdev2 --set-ctrl <small>trigger_src=1</small></code>

The [[Mv mipi i2c.sh user guide|mv_mipi_i2c.sh]] script can be used to set rich trigger parameters.
======Start acquisition======
<code>v4l2-ctl -d /dev/video0 --set-fmt-video=width=$WIDTH,height=$HEIGHT,pixelformat=GREY --stream-mmap --stream-count=1 --stream-to=y8-${WIDTH}x${HEIGHT}.raw</code>
======Perform hardware trigger operation======
Connect the appropriate trigger signal to the trigger pin of the camera and trigger it.
===i2c script for parameter configuration===
We provide shell scripts to configure the parameters.

[[mv_mipi_i2c.sh user guide]]
===Question Feedback===
We are committed to providing richer possibilities for image applications on embedded platforms. Therefore, our software for embedded platforms is based on the principle of open source.

If you have any questions or suggestions about our existing software, please feel free to submit them to the [http://forum.veye.cc/ forum] or email our technical staff at xumm#csoneplus.com.
===References===

*ROC-RK3566-PC Manual

[https://wiki.t-firefly.com/en/ROC-RK3566-PC/ https://wiki.t-Radxa.com/en/ROC-RK3566-PC/]

*ROC-RK3588S-PC Manual

[https://wiki.t-firefly.com/en/ROC-RK3588S-PC/ https://wiki.t-Radxa.com/en/ROC-RK3588S-PC/]

*Radxa Linux User Guide

[https://wiki.t-firefly.com/en/Firefly-Linux-Guide/index.html https://wiki.t-Radxa.com/en/Radxa-Linux-Guide/index.html]
===Document History===

*2024-04-17

Support RK3566.

*2024-03-10

Add pictures and descriptions of hardware connections for the new version of ADP-MV2.

*2023-08-30

Add support for RAW-MIPI-IMX462M and RAW-MIPI-AR0234M.

*2023-07-31

Support V-by-One on ubuntu system.

*2023-04-12

Release 1st version.

Navigation menu