This is a delivery of the Topaz2m driver for IMX8M Mini
- Additional test patterns.
- Trigger mode control.
- Image offset control.
- Fix to SIMR mode not being disabled.
This driver version adds the following features:
- Modifies the minimum value of the exposure control to 5
- Modifies the default ROI 1 height value to 1080
| Feature | Value |
|---|---|
| Platform | Verdin imx8m mini |
| Sensor | TOPAZ2M |
| Max Image Size | 1920x1080 |
| Frame Rate @Max Image Size | 65FPS @RAW10 100FPS @RAW8 |
| Colorspace format | Monochrome |
| Pixel Depth | 8-10 bit |
| Interface | CSI-2 MIPI x2 Lanes |
| Yocto Release | Dunfell |
| Kernel version | 5.4.193 |
| Yocto environment version | 0.6.0 |
| Driver version | 0.6 |
Important Notice: A fast way to start the Development Kit with a new installation is to use a Pre-built image. This image is available on the product page: core-image-teledyne-verdin-imx8mm-*.tar You can download this image and go directly to the part “Flash the board”.
A custom Yocto environment with a custom meta-layer was prepared. This meta-layer called meta-teledyne already has a patch to include the Topaz2m sensor driver.
- Note: Yocto is a powerful tool for building custom images, however, it consumes a lot of resources of the host computer when building the image, so it is recommended to use linux natively instead of using virtual machines. In addition, the build process can take several hours.
If you already had a Yocto environment from a previous delivery, you can follow the next procedure to avoid setting up a new environment:
- Move to your previous teledyne-yocto directory and replace all files in that directory with the files in the new provided environment.
- Execute steps 1 and 2 from the Setup the Yocto environment subsection. These will set the required TELEDYNE_DEVDIR and YOCTO_DIR environment variables. Make sure to use the same paths that you used for your previous build.
- Go to the Pre-build configurations subsection and continue from there.
- Download the attached teledyne-yocto.tar file.
- Move into the path where the file is placed and extract its contents:
tar -xvf teledyne-yocto.tar
- Move into the project directory and set an environment variable for this path:
cd teledyne-yocto
TELEDYNE_DEVDIR=${PWD}
- Define a directory path to hold your Yocto build:
YOCTO_DIR=<path-to-yocto-dir>
for example:
YOCTO_DIR=~/yocto-dir
- Run the setup script:
cd ${TELEDYNE_DEVDIR}
./scripts/setup-repo.sh $YOCTO_DIR
You can modify the default Yocto downloads path, used during the building process. The default path for this is ${YOCTO_DIR}/build/downloads.
In order to avoid re-downloads in future builds it is possible to change this directory by replacing the default path with one of your preference, that can be used as a common downloads directory for multiple Yocto projects. For this, modify the DL_DIR variable provided in the ${YOCTO_DIR}/meta-teledyne/conf/local.conf.sample file.
By default, the driver is configured as built-in, so it will be compiled as a part of the kernel. Configuring the driver as a module allows to do easier updates, just by replacing the module file, without having to replace the kernel or flashing the board.
To configure the kernel as a module:
- Open the file
${TELEDYNE_DEVDIR}/meta-teledyne/recipes-kernel/linux/linux-toradex/topaz2m.cfgwith any text editor of your preference. This file has the following contents:
CONFIG_VIDEO_TELEDYNE_TOPAZ2M=y
The previous line of code enables the driver as built-in. To enable the driver as a module, modify this line so it looks like the following:
CONFIG_VIDEO_TELEDYNE_TOPAZ2M=m
By modifying this file, the driver will be then compiled as a module.
- Initialize the Yocto environment:
cd ${YOCTO_DIR}
export TEMPLATECONF=${PWD}/meta-teledyne/conf
source poky/oe-init-build-env
- Build the custom image:
bitbake core-image-teledyne
If it fails : rerun the command
Note that the Verdin Development Board require SD card and Dahlia Carrier Board require microSD card.
If you are using a pre-built image, go to the step 2. If you have built your own Yocto Image for the IMX8 module:
- Go to the directory were the Yocto image is placed:
# for Verdin iMX8M Mini
${YOCTO_DIR}/build/deploy/images/verdin-imx8mm
There you should see a .tar a file similar to the following:
core-image-teledyne-verdin-imx8mm-20220823195236-Tezi_5.7.0-devel-202208231
95236+build.0.tar
- Note: The file name may change depending on the build date.
- Get an SD card in fat32 format. You can use gparted to format it.
- Copy the Yocto image *.tar file into the SD card and extract it.
- Plug in the SD Card on the port:
- X34 SD Card port for Verdin Development Board
- X7 microSD Card port for Dahlia Carrier Board To flash the board you need to use the Toradex easy installer.
If you are using the module for the first time, you probably won't need to load the Installer since it will come pre-installed and you'll just need to power on the board to use it
- Download the installer for your module from the Toradex Easy Installer Latest Releases
- Note: The following version is recommended as it was previously tested:
- Verdin iMX8M Mini (2022-03-30 | 5.6.0+build.9 | 47.07 MB)
- Extract the downloaded file:
unzip Verdin-iMX8MM_ToradexEasyInstaller_5.6.0+build.9.zip
- Prepare the board:
-
Connect the board to your PC using a USB-C to USB-A cable on the port:
- X34 USB OTG port for Verdin Development Board
- X3 USB OTG port for Dahlia Carrier Board
-
Avoid using USB Hubs to connect the board to your PC as recommended by Toradex.
-
Put the board in recovery mode by pressing the Recovery button and while holding it, press the On/Off button, then release ON/OFF button and keep Recovery button during 10sec.
-
Check the device is well detected with lsusb command: “NXP Semiconductors” device may be displayed.
- Go to the extracted directory and run the script:
cd Verdin-iMX8MM_ToradexEasyInstaller_5.6.0+build.9
./recovery-linux.sh
When the script finishes it will display the message "Successfully downloaded Toradex Easy Installer."
- Once the Toradex Easy Installer is loaded, choose one of the following options to interact with it:
Once the Toradex Easy Installer is loaded, choose one of the following options to interact with it
If you have a DSI to HDMI adapter on your board:
- Connect a display with an HDMI cable to the DSI to HDMI adapter.
- Connect an USB mouse and keyboard to the board, using connector X53 (Verdin Development board) or X4 (Dahlia Carrier Board)..
If you can't use a display, you can access the user interface remotely. For this:
-
Connect the board to your PC using a USB-C to USB-A cable on the same port used to load the Toradex Easy Installer:
- X34 USB OTG port for Verdin Development Board
- X3 USB OTG port for Dahlia Carrier Board
-
The module provides USB connection with the default IP address
192.168.11.1.
- Install a VNC client on your PC. For this example, xtightvncviewer will be used:
sudo apt install -y xtightvncviewer
- Run the VNC client with the provided IP:
vncviewer 192.168.11.1
A window showing the Toradex Easy Installer menu will open. You can use your PC's mouse to interact with this menu.
On the Toradex Easy Installer window, the image that you copied to the SD card should appear. Click it and install it. Once the image is installed, you can reboot or power off the board.
- Note: If you are using a VNC client during the installation, choosing the Power off or Restart options might cause the VNC client window to freeze. You can just close the client window.
- To test the installation, power on the board. You will be prompted for the login information:
verdin-imx8mm login:
Type the word root and press Enter
If you built a new version of the driver using bitbake, you can replace the old module with the new one by following the next steps.
- Note: To update the driver module, the board had to be previously flashed with the driver configured as a module, otherwise there won't be a module file to replace.
- Verify that the current driver is installed as a module on the IMX8 board:
find / -iname "teledyne-topaz2m.ko"
The previous command will search for the driver module. If the module exists, you should see an output similar to the following:
root@verdin-imx8mm:~# find / -iname "teledyne-topaz2m.ko"
/lib/modules/5.4.193-5.7.0-devel+git.5a24da287b86/kernel/drivers/media/i2c/teledyne-topaz2m.ko
If no file is found, then you will have to flash the complete image before trying to update the driver as a module.
- Go to the directory where the built module is:
cd ${YOCTO_DIR}/build/tmp/work/verdin_imx8mm-tdx-linux/linux-toradex/5.4.193+gitAUTOINC+5a24da287b-r0/build/drivers/media/i2c
You will find the driver module named teledyne-topaz2m.ko on this directory.
- Copy the previous file into the board, replacing the file found on step 1. You can do this via SSH, for example:
scp teledyne-topaz2m.ko root@<board-ip>:/lib/modules/5.4.193-5.7.0-devel+git.5a24da287b86/kernel/drivers/media/i2c/
You have to replace <board-ip> with the IP address of your board on the previous command. You can find this value by running the command ifconfig on the board while having an Ethernet cable plugged in.
- Reboot the IMX8 board, the new driver module will be loaded.
The yocto image does not include a package manager like apt to install debian packages. Instead of this, packages must be previously included in the image recipe, then the image has to be compiled and flashed. You will find the custom Yocto image recipe (.bb file) at the path:
${TELEDYNE_DEVDIR}/meta-teledyne/recipes-images/images/core-image-teledyne.bb
In the previous file, the variable IMAGE_INSTALL will contain the main packages that will be included.
To add a package to the recipe file, the easiest way is to add them to the list of packages in the IMAGE_INSTALL variable. For example, if you want to add the packages package1 and package2:
IMAGE_INSTALL += " \
${CONMANPKGS} \
${GRAPHICAL} \
${GSTREAMER} \
i2c-tools \
v4l-utils \
xauth \
package1 \
package2 \
"
However, a more recommended practice when you want to modify a recipe, is to create a .bbappend file:
- Create a file at the same location as the
core-image-teledyne.bbfile, with the same name, but using the .bbappend extension instead of .bb. Your directory should look like the following:
ls ${TELEDYNE_DEVDIR}/meta-teledyne/recipes-images/images/
core-image-teledyne.bb core-image-teledyne.bbappend
- In the new
core-image-teledyne.bbappendfile, add the variable IMAGE_INSTALL_append, and assign to this variable the list of packages that you want to add. For example, if you want to add the packages package1 and package2, your file should look like the following:
IMAGE_INSTALL_append = " \
package1 \
package2 \
"
For a package to be available to install, its recipe has to be included in one of the current meta directories of the Yocto environment. Also, you need to use a specific name for this package, otherwise its recipe will not be found.
If you want to know which name to use, or want to check if a package is available:
- Go to the Yocto directory and initialize the Yocto environment:
cd ${YOCTO_DIR}
source poky/oe-init-build-env
- Run the following command, replacing
<package-name>with the name of your package or a part of the name.
bitbake-layers show-recipes "*<package-name>*"
For example, if you want to search for a nano related package, run:
bitbake-layers show-recipes "*nano*"
You will get the following output:
=== Matching recipes: ===
nano:
meta-oe 4.9.3
nanopb:
meta-oe 0.4.0 (skipped: Recipe is blacklisted: Needs forward porting to use python3)
Here, you can see that there are two packages that match your search, nano and nanopb, its versions and the meta-layers in which their recipes are, in this case, both recipes are included in meta-oe.
Once you power on the board, you can connect an HDMI display using the DSI to HDMI adapter. Once you do, you will see the main green screen of the GUI.
To open a new terminal, click the terminal icon at the top left corner of the screen.
- Note: If required, you can run the command
loginto login into the root user (no password).
You can have up to 7 independent login sessions. To change between virtual terminals press the keys CTRL + ALT + F<n>, where n can be a number from 1 to 7. By default, the board will use the virtual terminal #2.
Whenever you switch to a new virtual terminal, you will be asked to login and won't have a GUI. To run a GUI on that virtual terminal, run the following command:
weston-launch
In case of absence of DSI to HDMI adapter, you can use an USB-C cable to connect your PC to the board using debug connector: - X66 USB DEBUG port for Verdin Development Board - X18 USB DEBUG port for Dahlia Carrier Board Once you plug in the board to your PC, run the following:
dmesg | grep tty
If you get any error when running this command, please use sudo to run it again:
sudo dmesg | grep tty
You should see that four new devices are now detected, similar to the following output:
[ 3753.366986] usb 3-4.2: FTDI USB Serial Device converter now attached to ttyUSB0
[ 3753.367126] usb 3-4.2: FTDI USB Serial Device converter now attached to ttyUSB1
[ 3753.367250] usb 3-4.2: FTDI USB Serial Device converter now attached to ttyUSB2
[ 3753.367419] usb 3-4.2: FTDI USB Serial Device converter now attached to ttyUSB3
The numeration might change if you already had some device, for example let's say that ttyUSB0 already existed, then your numeration should go from 1 to 4.
The last device, in this example ttyUSB3, is the one that you have to connect to, using any app that you prefer for serial debugging for example minicom, but you can use another one like putty.
To use minicom, first install it on your PC:
sudo apt install minicom
Then run the following command (assuming is /dev/ttyUSB3):
sudo minicom -D /dev/ttyUSB3
This should show the following:
Welcome to minicom 2.7.1
OPTIONS: I18n
Compiled on Dec 23 2019, 02:06:26.
Port /dev/ttyUSB3, 10:08:49
Press CTRL-A Z for help on special keys
Once you are here, just press Enter on your keyboard, and you will see the login screen from the
board. Just log in normally with the login information from above and you should be able to use the
board from that terminal.
In that terminal you could use the command ifconfig to check what is the board IP address and then
connect from your PC using ssh -X root@<IPaddress>, for example:
ssh -X root@192.168.0.4
- Verify the driver was loaded correctly:
dmesg | grep topaz2m
You should get an output similar to the following:
root@verdin-imx8mm:~# dmesg | grep topaz2m
[ 80.434668] topaz2m 2-0010: TOPAZ2M sensor found
[ 80.439330] mxc_mipi-csi 32e30000.mipi_csi: Registered sensor subdevice: topaz2m 2-0010
- Check the kernel version and build time:
uname -a
The output should state the kernel version, the date and time the image was compiled:
root@verdin-imx8mm:~# uname -a
Linux verdin-imx8mm 5.4.193-5.7.0-devel+git.5a24da287b86 #1 SMP PREEMPT Wed Aug 24 17:37:44 UTC 2022 aarch64 GNU/Linux
On the IMX8M mini platform, controls can be modified before or after starting the capture. The values assigned to the controls will be kept even after the capture is stopped and will be used in the next capture.
- Note: Modifying the following controls values once the capture starts is not recommended, since they affect the capture resolution:
- ROI width
- ROI 1 height
- ROI 1 horizontal sub sampling
- ROI 1 vertical sub sampling
- ROI 2 height
- ROI 2 horizontal sub sampling
- ROI 2 vertical sub sampling
- Display controls and values:
v4l2-ctl -l
The output should be similar to:
User Controls
frame_rate 0x0098092b (int) : min=5 max=988 step=1 default=100 value=100
roi_offset_col 0x0098092c (int) : min=0 max=1920 step=1 default=0 value=0
roi_select 0x0098092d (int) : min=1 max=2 step=1 default=1 value=1
roi_width 0x0098092e (int) : min=64 max=1920 step=2 default=1920 value=1920
roi_1_analog_gain 0x0098092f (menu) : min=0 max=15 default=0 value=0
roi_1_digital_gain 0x00980930 (int) : min=1 max=4096 step=1 default=256 value=256
roi_1_exposure 0x00980931 (int) : min=5 max=500000 step=1 default=9180 value=9180
roi_1_height 0x00980932 (int) : min=32 max=1080 step=2 default=1080 value=1080
roi_1_horizontal_flip 0x00980933 (bool) : default=0 value=0
roi_1_vertical_flip 0x00980934 (bool) : default=0 value=0
roi_1_offset_row 0x00980935 (int) : min=0 max=1080 step=1 default=0 value=0
roi_1_horizontal_sub_sampling 0x00980936 (menu) : min=0 max=5 default=0 value=0
roi_1_vertical_sub_sampling 0x00980937 (menu) : min=0 max=5 default=0 value=0
roi_2_analog_gain 0x00980938 (menu) : min=0 max=15 default=0 value=0
roi_2_digital_gain 0x00980939 (int) : min=1 max=4096 step=1 default=256 value=256
roi_2_exposure 0x0098093a (int) : min=5 max=500000 step=1 default=9180 value=9180
roi_2_height 0x0098093b (int) : min=0 max=1080 step=2 default=0 value=0
roi_2_horizontal_flip 0x0098093c (bool) : default=0 value=0
roi_2_vertical_flip 0x0098093d (bool) : default=0 value=0
roi_2_offset_row 0x0098093e (int) : min=0 max=1080 step=1 default=0 value=0
roi_2_horizontal_sub_sampling 0x0098093f (menu) : min=0 max=5 default=0 value=0
roi_2_vertical_sub_sampling 0x00980940 (menu) : min=0 max=5 default=0 value=0
test_pattern 0x00980941 (menu) : min=0 max=13 default=0 value=0
idle_enable 0x00980942 (int) : min=0 max=1 step=1 default=0 value=0
trigger_mode 0x00980943 (menu) : min=0 max=2 default=0 value=0
image_offset 0x00980944 (int) : min=-256 max=255 step=1 default=0 value=0
- Display controls and menus:
v4l2-ctl -L
The output should be similar to:
User Controls
frame_rate 0x0098092b (int) : min=5 max=988 step=1 default=100 value=100
roi_offset_col 0x0098092c (int) : min=0 max=1920 step=1 default=0 value=0
roi_select 0x0098092d (int) : min=1 max=2 step=1 default=1 value=1
roi_width 0x0098092e (int) : min=64 max=1920 step=2 default=1920 value=1920
roi_1_analog_gain 0x0098092f (menu) : min=0 max=15 default=0 value=0
0: 1.00 (0.00 dB)
1: 1.20 (1.58 dB)
2: 1.45 (3.23 dB)
3: 1.71 (4.66 dB)
4: 2.00 (6.02 dB)
5: 2.40 (7.60 dB)
6: 3.00 (9.54 dB)
7: 3.43 (10.71 dB)
8: 4.00 (12.04 dB)
9: 4.80 (13.62 dB)
10: 6.00 (15.56 dB)
11: 6.86 (16.73 dB)
12: 8.00 (18.06 dB)
13: 9.60 (19.65 dB)
14: 12.00 (21.58 dB)
15: 16.00 (24.08 dB)
roi_1_digital_gain 0x00980930 (int) : min=1 max=4096 step=1 default=256 value=256
roi_1_exposure 0x00980931 (int) : min=5 max=500000 step=1 default=9180 value=9180
roi_1_height 0x00980932 (int) : min=32 max=1080 step=2 default=1080 value=1080
roi_1_horizontal_flip 0x00980933 (bool) : default=0 value=0
roi_1_vertical_flip 0x00980934 (bool) : default=0 value=0
roi_1_offset_row 0x00980935 (int) : min=0 max=1080 step=1 default=0 value=0
roi_1_horizontal_sub_sampling 0x00980936 (menu) : min=0 max=5 default=0 value=0
0: No sub sampling
1: Sub sampling 2
2: Sub sampling 4
3: Sub sampling 8
4: Sub sampling 16
5: Sub sampling 32
roi_1_vertical_sub_sampling 0x00980937 (menu) : min=0 max=5 default=0 value=0
0: No sub sampling
1: Sub sampling 2
2: Sub sampling 4
3: Sub sampling 8
4: Sub sampling 16
5: Sub sampling 32
roi_2_analog_gain 0x00980938 (menu) : min=0 max=15 default=0 value=0
0: 1.00 (0.00 dB)
1: 1.20 (1.58 dB)
2: 1.45 (3.23 dB)
3: 1.71 (4.66 dB)
4: 2.00 (6.02 dB)
5: 2.40 (7.60 dB)
6: 3.00 (9.54 dB)
7: 3.43 (10.71 dB)
8: 4.00 (12.04 dB)
9: 4.80 (13.62 dB)
10: 6.00 (15.56 dB)
11: 6.86 (16.73 dB)
12: 8.00 (18.06 dB)
13: 9.60 (19.65 dB)
14: 12.00 (21.58 dB)
15: 16.00 (24.08 dB)
roi_2_digital_gain 0x00980939 (int) : min=1 max=4096 step=1 default=256 value=256
roi_2_exposure 0x0098093a (int) : min=5 max=500000 step=1 default=9180 value=9180
roi_2_height 0x0098093b (int) : min=0 max=1080 step=2 default=0 value=0
roi_2_horizontal_flip 0x0098093c (bool) : default=0 value=0
roi_2_vertical_flip 0x0098093d (bool) : default=0 value=0
roi_2_offset_row 0x0098093e (int) : min=0 max=1080 step=1 default=0 value=0
roi_2_horizontal_sub_sampling 0x0098093f (menu) : min=0 max=5 default=0 value=0
0: No sub sampling
1: Sub sampling 2
2: Sub sampling 4
3: Sub sampling 8
4: Sub sampling 16
5: Sub sampling 32
roi_2_vertical_sub_sampling 0x00980940 (menu) : min=0 max=5 default=0 value=0
0: No sub sampling
1: Sub sampling 2
2: Sub sampling 4
3: Sub sampling 8
4: Sub sampling 16
5: Sub sampling 32
test_pattern 0x00980941 (menu) : min=0 max=13 default=0 value=0
0: Disabled
1: Front pattern - Diagonal
2: Rear pattern: Diagonal - Fixed
3: Column increment - Fixed
4: Line increment - Fixed
5: Diagonal - Moving
6: Column increment - Moving
7: Line increment - Moving
8: Uniform 0
9: Uniform 20
10: Uniform 127
11: Uniform 255
12: Uniform 511
13: Uniform 1023
idle_enable 0x00980942 (int) : min=0 max=1 step=1 default=0 value=0
trigger_mode 0x00980943 (menu) : min=0 max=2 default=0 value=0
0: Internal self-trigger
1: External Frame Trigger
2: External ITC Trigger
image_offset 0x00980944 (int) : min=-256 max=255 step=1 default=0 value=0
v4l2-ctl -d /dev/video0 -c roi_1_analog_gain=<value>
v4l2-ctl -d /dev/video0 -c roi_2_analog_gain=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_analog_gain=10
v4l2-ctl -d /dev/video0 -c roi_2_analog_gain=10
v4l2-ctl -d /dev/video0 -c roi_1_digital_gain=<value>
v4l2-ctl -d /dev/video0 -c roi_2_digital_gain=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_digital_gain=2000
v4l2-ctl -d /dev/video0 -c roi_2_digital_gain=2000
v4l2-ctl -d /dev/video0 -c roi_1_exposure=<value>
v4l2-ctl -d /dev/video0 -c roi_2_exposure=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_exposure=15000
v4l2-ctl -d /dev/video0 -c roi_2_exposure=15000
v4l2-ctl -d /dev/video0 -c frame_rate=<value>
Example:
v4l2-ctl -d /dev/video0 -c frame_rate=60
- Note: The maximum frame rate value changes depending on the resolution. Check the Driver controls section for more details on maximum values.
v4l2-ctl -d /dev/video0 -c roi_1_horizontal_flip=<value>
v4l2-ctl -d /dev/video0 -c roi_2_horizontal_flip=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_horizontal_flip=1
v4l2-ctl -d /dev/video0 -c roi_2_horizontal_flip=1
v4l2-ctl -d /dev/video0 -c roi_1_vertical_flip=<value>
v4l2-ctl -d /dev/video0 -c roi_2_vertical_flip=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_vertical_flip=1
v4l2-ctl -d /dev/video0 -c roi_2_vertical_flip=1
v4l2-ctl -d /dev/video0 -c roi_width=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_width=400
v4l2-ctl -d /dev/video0 -c roi_1_height=<value>
v4l2-ctl -d /dev/video0 -c roi_2_height=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_height=200
v4l2-ctl -d /dev/video0 -c roi_2_height=200
v4l2-ctl -d /dev/video0 -c roi_offset_col=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_offset_col=450
v4l2-ctl -d /dev/video0 -c roi_1_offset_row=<value>
v4l2-ctl -d /dev/video0 -c roi_2_offset_row=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_offset_row=425
v4l2-ctl -d /dev/video0 -c roi_2_offset_row=425
v4l2-ctl -d /dev/video0 -c roi_1_horizontal_sub_sampling=<value>
v4l2-ctl -d /dev/video0 -c roi_2_horizontal_sub_sampling=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_horizontal_sub_sampling=1
v4l2-ctl -d /dev/video0 -c roi_2_horizontal_sub_sampling=1
- Note: The capture width will change if a horizontal sub sampling ratio is applied. Use the command
v4l2-ctl -d /dev/video0 --list-formats-extto check for the image size when changing the control value.
v4l2-ctl -d /dev/video0 -c roi_1_vertical_sub_sampling=<value>
v4l2-ctl -d /dev/video0 -c roi_2_vertical_sub_sampling=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_1_vertical_sub_sampling=1
v4l2-ctl -d /dev/video0 -c roi_2_vertical_sub_sampling=1
- Note: The capture height will change if a vertical sub sampling ratio is applied. Use the command
v4l2-ctl -d /dev/video0 --list-formats-extto check for the image size when changing the control value.
v4l2-ctl -d /dev/video0 -c test_pattern=<value>
Example:
v4l2-ctl -d /dev/video0 -c test_pattern=2
v4l2-ctl -d /dev/video0 -c roi_select=<value>
Example:
v4l2-ctl -d /dev/video0 -c roi_select=2
v4l2-ctl -d /dev/video0 -c idle_enable=<value>
Example:
v4l2-ctl -d /dev/video0 -c idle_enable=0
v4l2-ctl -d /dev/video0 -c image_offset=<value>
Example:
v4l2-ctl -d /dev/video0 -c image_offset=100
Command to list the formats:
v4l2-ctl -d /dev/video0 --list-formats-ext
Expected output:
root@verdin-imx8mm:~# v4l2-ctl -d /dev/video0 --list-formats-ext
ioctl: VIDIOC_ENUM_FMT
Type: Video Capture
[0]: 'GREY' (8-bit Greyscale)
Size: Discrete 1920x1080 # ROI 1 resolution
Size: Discrete 1920x0 # ROI 2 resolution
Size: Discrete 1920x1080 # SIMR resolution
[1]: 'Y10 ' (10-bit Greyscale)
Size: Discrete 1920x1080 # ROI 1 resolution
Size: Discrete 1920x0 # ROI 2 resolution
Size: Discrete 1920x1080 # SIMR resolution
Some considerations for the user before starting the capture are listed below:
- The IMX8M Mini platform has the following resolution limitation:
- When using an RAW8 format the IMAGE WIDTH should be a multiple of 8 pixels.
- When using a RAW1010 format the IMAGE_WIDTH should be a multiple of 4 pixels. You can check for this information at section 13.4.4.14 CSI Image Parameter Register of the i.MX 8M Mini Applications Processor Reference Manual Rev. 3.
- The supported resolutions will change if a sub sampling ratio is applied or ROI control values are modified. It is recommended to check for the current supported resolutions with the command
v4l2-ctl -d /dev/video0 --list-formats-extbefore capturing.
To stream from ROI 1 or ROI 2:
- Select the ROI to capture from using the
roi_selectcontrol. - Run the capture command using the current supported resolution of the selected ROI.
To stream from SIMR:
- Run the capture command using the current supported SIMR resolution, no controls need to be set.
For example, if an ROI 1 of 1920x500 is set, and an ROI 2 of 1920x200 is set, the suported resolutions will change to:
ioctl: VIDIOC_ENUM_FMT
Type: Video Capture
[0]: 'GREY' (8-bit Greyscale)
Size: Discrete 1920x500
Size: Discrete 1920x200
Size: Discrete 1920x700
[1]: 'Y10 ' (10-bit Greyscale)
Size: Discrete 1920x500
Size: Discrete 1920x200
Size: Discrete 1920x700
- In the previous example, to capture from ROI 1, the capture resolution should be 1920x500. To enable SIMR, the capture resolution should be 1920x700.
Set the resolution:
v4l2-ctl -d /dev/video0 -c roi_width=1920,roi_1_height=800
Capture command:
v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=800,pixelformat='Y10 ' --stream-mmap
Expected output:
root@verdin-imx8mm:~# v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=800,pixelformat='Y10 ' --stream-mmap
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 80.04 fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 80.04 fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 80.04 fps
Set the resolution:
v4l2-ctl -d /dev/video0 -c roi_width=1920,roi_1_height=1080
Capture command:
v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=1080,pixelformat='Y10 ' --stream-mmap
Expected output:
root@verdin-imx8mm:~# v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=1080,pixelformat='Y10 ' --stream-mmap
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 65.02 fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 65.02 fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 65.02 fps
Set the resolution:
v4l2-ctl -d /dev/video0 -c roi_width=1920,roi_1_height=800
Capture command:
v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=800,pixelformat='GREY' --stream-mmap
Expected output:
root@verdin-imx8mm:~# v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=800,pixelformat='GREY' --stream-mmap
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 130.00 fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 130.00 fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 130.00 fps
Set the resolution:
v4l2-ctl -d /dev/video0 -c roi_width=1920,roi_1_height=1080
Capture command:
v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=1080,pixelformat='GREY' --stream-mmap
Expected output:
root@verdin-imx8mm:~# v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=1080,pixelformat='GREY' --stream-mmap
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 100.04 fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 100.04 fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 100.04 fps
To capture a single frame, set the desired resolution and pixel format, for example, for 1920x800 RAW10:
v4l2-ctl -d /dev/video0 -c roi_width=1920,roi_1_height=800 --set-fmt-video=width=1920,height=800,pixelformat='Y10 '
Then run the capture command:
v4l2-ctl -d /dev/video0 --stream-mmap --stream-count=1 --stream-to=test_frame_1920x800_raw10.raw
Notes:
- You can choose any number of frames by setting the
--stream-countvariable and the name of the output file by setting the--stream-tovariable. - These captured frames can be visualized with rawpixels or vooya in your host PC. Please consider the following settings to be able to view them correctly.
- width: 1920
- height: 800
- Predefined format: Grayscale 8bit
- Pixel format: Grayscale
- bpp1: 16
- width: 1920
- height: 1080
- Predefined format: Grayscale 8bit
- Pixel format: Grayscale
- bpp1: 16
- width: 1920
- height: 800
- Predefined format: Grayscale 8bit
- Pixel format: Grayscale
- bpp1: 8
- width: 1920
- height: 1080
- Predefined format: Grayscale 8bit
- Pixel format: Grayscale
- bpp1: 8
- width: 1920
- height: 800
- Frames/Second: 80
- Color Space: Single Channel
- Data Container: Single Integer
- Bit Depth (Value): 10bit
- width: 1920
- height: 1080
- Frames/Second: 65
- Color Space: Single Channel
- Data Container: Single Integer
- Bit Depth (Value): 10bit
- width: 1920
- height: 800
- Frames/Second: 130
- Color Space: Single Channel
- Data Container: Single Integer
- Bit Depth (Value): 8bit
- width: 1920
- height: 1080
- Frames/Second: 100
- Color Space: Single Channel
- Data Container: Single Integer
- Bit Depth (Value): 8bit
- Note: Y10 is not supported by v4l2src. For this reason, the following pipeline is for testing the RAW8 configuration.
- Before executing the pipeline, set the ROI size and the format.
v4l2-ctl -d /dev/video0 -c roi_width=1920,roi_1_height=800
v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=800,pixelformat='GREY'
- Run the capture pipeline:
gst-launch-1.0 v4l2src ! "video/x-raw,width=1920,height=800,format=GRAY8" ! queue ! videoconvert ! queue ! ximagesink sync=false
- Before executing the pipeline, set the ROI size and the format.
v4l2-ctl -d /dev/video0 -c roi_width=1920,roi_1_height=1080
v4l2-ctl -d /dev/video0 --set-fmt-video=width=1920,height=1080,pixelformat='GREY'
- Run the capture pipeline:
gst-launch-1.0 v4l2src ! "video/x-raw,width=1920,height=1080,format=GRAY8" ! queue ! videoconvert ! queue ! ximagesink sync=false
For reading and writing the sensor registers, the sensor has to be capturing video using v4l2-ctl or GStreamer. Since the addresses to be read are 8 bits and need to give back a value of 16 bits, the i2ctransfer command can be used to read these addresses as follows:
i2ctransfer -f -y [BUS NUMBER] w[BYTES]@[ADDRESS] [REGISTER] r[BYTES]
For example, to read the register 0x7F (chip ID) of the 0x10 address in i2c 2 bus, it is needed to write 1 byte (0x7F) to the 0x10 address and read 2 bytes (r[BYTES]) from this register. So, the full command is:
i2ctransfer -f -y 2 w1@0x10 0x7F r2
The register gives back:
root@verdin-imx8mm:~# i2ctransfer -f -y 2 w1@0x10 0x7F r2
0x80 0x36
For reading, and also writing, I2C bus address registers the sensor has to be capturing video using v4l2-ctl or GStreamer.
i2ctransfer -f -y [BUS NUMBER] w[BYTES]@[ADDRESS] [REGISTER] [MSB VALUE TO WRITE] [MSB VALUE TO READ]
For example, to write to the register 0x0B (Integration Time) of the 0x10 address in i2c 2 bus, it is needed to write 3 bytes (w[BYTES]) to the register 0x0B of the 0x10 address. 1 byte is for the register to be written (0x0B) and the other 2 bytes are the value to be written in this register. So, the full command for this example is:
For example:
i2ctransfer -f -y 2 w3@0x10 0x0b 0x30 0x00
If the register 0x0B is read:
root@verdin-imx8mm:~# i2ctransfer -f -y 2 w1@0x10 0x0b r2
0x30 0x00