How to setup a VC MIPI MODULE on a Raspberry PI Compute IO Board 4

1.1   Hardware Pre-Check: Install Raspbian

First step is to install Raspberry Pi OS from

https://www.raspberrypi.com/software/operating-systems/

The driver is compatible with kernel versions 5.4, 5.10, 5.15, 6.1 and 6.6 (32-bit and 64-bit), so download the appropriate Raspberry Pi OS version. Raspberry Pi OS Buster Lite is sufficient, and this guide expects this version to be installed not only for the framebuffer output handling.

For more installation instructions see the Raspberry Pi OS Installation Manual; the procedure depends on the platform type where the OS is going to be installed.

(Original site may look different) Install Raspberry Pi OS by following the instructions provided there

The display shows a login prompt after successful installation. If this is not the case, you have to check your Raspberry Pi OS installation. The most relevant information to succeed can be found at the Raspberry Pi OS website or on the web.

Raspberry Pi OS showing login screen (user is usually pi with password raspberry)

1.2   Connect the MIPI module

The ends of the MIPI module connector cable is marked with the hardware to connect to. Open the socket connectors first by raising their lid, insert the cable and press their lid back when mounted correctly. You should then not be able to pull the cable out.

Open the MIPI module socket, put in the cable, close the MIPI module socket

Harmfully angled (left) and good (right) cable fixation

The socket type is also not protected against wrong orientation, so compare your setup to the figures below before switching the power on.

Watch the orientation of the cable (left: bad, right: good)

Connect the MIPI sensor to the socket named CAM1.

Connect the cable to the CAM1 socket and watch out for the cable orientation

The I²C bus named VC is used for sensor communication and is internally connected to the CAM1 socket's I²C bus pins.

A second sensor can be connected to the socket named CAM0. Its corresponding I²C pins at the J8 GPIO connector are ID_SD and ID_SC. We will use the second I²C bus i2c_arm to connect to the second sensor. Its data lane is at pin GPIO2 while its clock signal resides at pin GPIO3 of the J8 GPIO connector.

Therefore connect the J8 GPIO connector's

• pin named GPIO2 with the pin named ID_SD as well as the
• pin named GPIO3 with the pin named ID_SC.

Moreover two jumpers have to be fitted on the J6 connector.

Connections on CM4IO GPIO header

Cable and jumper connections on J8 and J6 headers

disable_touchscreen=1

Reconnect the other peripherials to the Raspberry Pi.

Connection setup

You should have the login prompt back after switching the system on.

Raspbian showing login screen (user is usually pi with password raspberry)

1.3   Optional: Trigger input

If the MIPI sensor supports it, you can trigger it externally for an image capture. To do so, you can use the VC Repeater Board: https://www.vision-components.com/fileadmin/external/documentation/hardware/VC_MIPI_Repeater_Board/index.html

2.1   Get the driver and demo code

You can download the driver and demo code from the following links.

• Driver: vc-mipi-driver-bcm2835-dkms_0.2.8_all.zip
• Demo code: vcmipidemo_0.7.0.zip

2.2   Install necessary Raspberry Pi OS packages

Before beginning with the installation, do the following steps first. This requires your Raspberry PI to already have an internet connection; otherwise you have to install the packages mentioned manually, search the web for the procedure needed.

1. Update the raspberrypi-kernel package and your system by calling:

   sudo  apt-get update   &&   sudo  apt-get upgrade
   

2. Reboot.

3. Install the raspberrypi-kernel-headers and device-tree-compiler package by using the following command:

   sudo  apt-get install  raspberrypi-kernel-headers  device-tree-compiler
   

4. Test if the version of the running kernel matches the version of the kernel headers, the following command should show the directory for compiling the sensor module kernel module driver:

   ls "/usr/src/linux-headers-$(uname -r)"
   

5. Install the dkms package with:

   sudo apt-get install dkms
   

2.3   Driver Installation

sudo apt-get purge vc-mipi-driver-bcm2835-dkms
sudo rm -rf /boot/firmware/config_vc*
sudo rm -rf /boot/firmware/overlays/vc-mipi*

sudo apt-get install ntpdate
ntpdate ip_address_of_ntp_server

sudo date -s "2024-07-24 09:41:00"

sudo hwclock -w

1. Copy the driver debian package (vc-mipi-driver-bcm2835-dkms_x.x.x_all.deb) to the /tmp folder on the Raspberry Pi.

2. Install the driver package by calling (replace x.x.x by the current version number):

   sudo dpkg -i /tmp/vc-mipi-driver-bcm2835-dkms_x.x.x_all.deb
   

3. Edit the file /boot/config_vc-mipi-driver-bcm2835.txt (for example with nano with the command: sudo nano /boot/config_vc-mipi-driver-bcm2835.txt).

   • choose the correct platform by uncommenting the corresponding line
   • choose the correct overlay according to your MIPI module and platform by uncommenting the corresponding line (for the IMX565, IMX566, IMX567, IMX568 please activate the overlay for the IMX568.)
   • choose the desired sensor mode (see chapter Sensor modes below for mode description)
   • change the IO configuration if necessary (see chapter IO configuration below for IO description)
   • activate the self-triggered mode (see chapter Self-triggered mode below)

   All these settings can be done for cam0 and cam1 in case you are using a Raspberry Pi CMIO or a VC CMIO.

   

   Part 2:

   

   Example of configuration file for the OV9281 MIPI module on a Raspberry Pi 3B+ in sensor mode 0.

4. Reboot.

2.4   First Image Acquisition Test

A sensor device should be listed as Video input at the following command output (from the Video4Linux-Control):

v4l2-ctl --all

The following command dumps sensor data:

v4l2-ctl --stream-mmap --stream-count=-1 -d /dev/video0 --stream-to=/dev/null

It will output subsequent lines ending with a frames-per-second information (in the example named [number]) until pressing CTRL-C:

<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< [number] fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< [number] fps
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< [number] fps
<<<<<<<<<<<<<<<<<<<<<<<^C

2.5   Running the Demo

The demo itself is a program named vcmipidemo and its source code is mainly in the file vcmipidemo.c. However more programs are provided, namely the vcimgnetsrv, a network image server, and its counterpart vcimgnetclient.py. The vcimgnetsrv is started as background service, and the vcmipidemo connects to it. Then you can use the vcimgnetclient.py on your PC to view live captured images.

But for the first run it is better to just run the vcmipidemo and check if it shows the ascii representation. This works without any network cable attached. You can then output the captured image to the framebuffer of the display by using the -f command line switch.

./vcmipidemo

./vcmipidemo -f

./vcimgnetsrv &
./vcmipidemo

./vcmipidemo -?

2.6   Switching Sensor Configuration

2.6.1   Sensor modes

The sensor driver provides different modes which support several features. They can be switched by changing values of sensor driver parameters.

To list available parameters of the sensor driver kernel module, you can use the following command:

dmesg

You can also check the table below (Sensor modes description) for a complete list of available sensor modes.

Example of the dmesg command for an OV9281 MIPI module, showing the available sensor modes.

To set the desired mode, edit the file /boot/config_vc-mipi-driver-bcm2835.txt (for example with nano with the command: sudo nano /boot/config_vc-mipi-driver-bcm2835.txt). Change the sensor mode by modifing dtparam:

dtparam=cam0_sensor_mode_1

The number after the underscore is the sensor mode. For mode 0 the correct setting would be dtparam=cam0_sensor_mode_0.

Example of setting the sensor mode to 1 for cam0.

2.6.3   IO configuration

Some sensors can be triggered externally and also provide a flash output. These two features can be switched using the cam0_io_config parameter.

Example of setting the IO configuration to 8 for cam0.

This parameter corresponds to the value written to register 3 on the MIPI module. A value of 0x08 activates the trigger input. A value of 0x09 activates the trigger input and the flash output.

After modifying the sensor mode or the IO configuration, save the changes and reboot.

2.6.4   Self-triggered mode

On some modules the streaming mode does not allow a flash output signal. In this case it is necessary to activate the so-called self-triggered mode (from the user point of view it behaves like the streaming mode). This is done by choosing one of the external trigger modes and additionally overriding the value of the register 0x0108 of the mipi controller.

Register 0x108 configuration: set to 4 for self-triggered mode.

A detailed documentation of the mipi controller registers is available on request.

3.1   Q/A

Problem:

Running make fails with an error:

⋮

make[1]: *** /lib/modules/4.14.79-v7+/build: No such file or directory. Stop.

⋮

Solution:

The system needs the build tools of the kernel to build the sensor driver (which itself is a kernel module). They can be obtained by installing the RaspberryPi Kernel Headers package named raspberrypi-kernel-headers, see https://www.raspberrypi.org/documentation/linux/kernel/headers.md

Problem:

The sensor module driver cannot be started, it shows an error:

⋮

[ 4.773298] imx296 0-0060: Error -5 setting default controls

[ 4.773346] imx296: probe of 0-0060 failed with error -5

⋮

Solution:

Be sure no other device is connected to the I²C bus 0! For example, the touch screen controller of the Raspberry PI display may not be connected.

Check the orientation of the cable at the sensor side as well as at the cpu side. Also check if the cable and the sockets are orthogonal.

3.2   Driver Knowledge

The following tasks have to be done to do an image acquisition with the camera sensor:

• Information about the new sensor hardware and its connector must be provided to the kernel by adding it to the so-called kernel device tree as overlay.
• This device tree overlay must be applied to the kernel device tree.
• For the driver to communicate with the sensor the I²C bus must be set up to connect between the CPU and the MIPI socket.
• The driver itself must be installed as kernel modules.
• Contiguous memory must be reserved for the captured image.

The driver is separated into parts exclusive for the platform, e.g. the Raspi3BPlus as well as generic parts.

The main configuration file for the driver is named:

config_vc-mipi-driver-bcm2835.txt

It should include the platform specific configuration, here the file:

config_vc-mipi-driver-bcm2835-raspi3Bplus.txt

and also refer to the sensor overlays (see the following) you would like to use. Overlays can be found relative to the configuration file at the ./overlays/ directory.

3.2.1   Providing device tree overlays

The so-called kernel device tree overlay contains information about the socket and periphery where the mipi module is connected to.

Here are the steps to compile a device tree overlay by yourself:

We assume to compile an example overlay file named

example123-overlay.dts

1. Install the device-tree-compiler package via:

   sudo  apt-get install  device-tree-compiler
   

2. Compile the dtbo kernel device tree overlay binary representation by using the following command:

   dtc -@ -I dts -O dtb -o example123.dtbo example123-overlay.dts

3. Copy the binary to

   /boot/overlays/example123.dtbo

3.2.1.1   Telling the RTOS to use the device tree overlay

Raspbian Boot overview

Before starting the linux kernel, the Raspberry Pi first boots a real-time operating system (RTOS) on the GPU. This RTOS looks into the file /boot/config.txt. It loads a default Kernel device tree and patches it by overlaying the device tree parts listed by the dtoverlay entries at the file /boot/config.txt. To add new information to the device tree this config-file (or a therein included file) needs the following entry:

dtoverlay=example123

The device tree will then be modified by the overlay at

/boot/overlays/example123.dtbo

before the linux kernel is run.

To check the behaviour of the RTOS one can look at the output by the following command:

sudo vcdbg log msg

Example

After reboot the applied overlays can be shown by executing the following command:

sudo vcdbg log msg  2>&1 | grep '^[0-9\.]\+: Loaded overlay'

Here is a sample output:

002143.555: Loaded overlay 'example123'

A deeper insight into the device tree overlays and parameters can be found at https://www.raspberrypi.org/documentation/configuration/device-tree.md

3.2.2   Set up the I²C bus for driver-sensor communication

For the RaspberryPi 3B+ there is only one socket available, so there is no need to change the CSI port information at a device tree overlay provided.

Trigger input is hardwired to pin 133, trigger output to pin 134, unuseable/unaccessible.

Note

On this Raspberry PI model the pins used for trigger input and output are hard-wired to some GPIO, so external triggering is not possible (no access).

Warning

Hardware will be damaged and warranty lost if you use pins as outputs where the sensor has its own flash output, so double-check before you (if you are able to) access the trigger gpio pins! Don't activate sensor flash or sync output (e.g via the dtparam cam*_io_config) if the wires are connected to an output, for example at a RaspberryPi3B+!

The sensor driver needs to communicate via the I²C Bus named VC. To be able to access it, assigning it to the CPU is mandatory.

Raspbian I²C connection: Influence of the parameter dtparam=i2c_vc=on

The I²C bus is assigned by the RTOS. So the file /boot/config_vc-mipi-driver-bcm2835-raspi3Bplus.txt has an entry:

dtparam=i2c_vc=on

It changes the physical I²C bus VC accessor from the default, the GPU, to the CPU. The referred overlay vc-mipi-bcm2835-raspi3Bplus-i2c0 makes it accessible for linux over GPIO pins.

Note

Some hardware like the touch display demands exclusiveness over the I²C Bus VC or their drivers assume the I²C Bus VC is connected to the RTOS. Since the sensor driver must communicate with the sensor module connected to the MIPI socket, neither the exclusiveness nor the RTOS connectedness is given. So the I²C bus VC cannot be used for other purposes when the sensor is attached.

Example

After reboot the dtparam line can be shown by executing the following command:

sudo vcdbg log msg  2>&1 | grep '^[0-9\.]\+: dtparam:'

Here is a sample output:

002077.358: dtparam: audio=on
002096.467: dtparam: i2c_vc=on

size = <0x4000000>; /* 64MiB */

dmesg | grep '^[^]]*\] Memory:'

[    0.000000] Memory: 817108K/970752K available (7168K kernel code, 576K rwdata, 2076K rodata, 1024K init, 698K bss, 22572K reserved, 131072K cma-reserved)