Intel MIPI CSI Camera Reference Driver

This repository contains reference drivers and configurations for Intel MIPI CSI cameras, supporting various sensor modules and Image Processing Units (IPUs).

Supported Sensors

Sensor Name	Sensor Type	Vendor	Kernel Version	IPU Version
AR0233	GMSL	Sensing	K6.12	IPU6EPMTL
AR0820	GMSL	Sensing	K6.12	IPU6EPMTL
ISX031	MIPI CSI-2	D3 Embedded	K6.12	IPU6EPMTL
ISX031	GMSL	D3 Embedded	K6.12	IPU6EPMTL
ISX031	GMSL	Sensing	K6.12	IPU6EPMTL
ISX031	GMSL	Leopard Imaging	K6.12	IPU6EPMTL
AR0234	MIPI CSI-2	D3 Embedded	K6.12	IPU6EPMTL

Note: IPU6EPMTL represents MTL and ARL platforms

Directory Structure

• drivers/: Host Linux kernel drivers for supported sensors
• config/: Host Middleware Configuration files, BIOS setting and sample commands for supported sensors
• doc/: Documentation on Kernel Driver dependency on ipu6-drivers repository
• patch/: Host Dependent Kernel patches to enable specific sensors
• include/: Header files for driver compilation

Getting Started with Reference Camera

1. Install Intel BKC image:

   • Go to rdc.intel.com
     • Download IPU Master Collateral (Document #817101)
   • In Document #817101
     • Go to Linux Getting Started Guide (GSG) Documentation section
     • Search for your platform under Platform column
     • Click on Getting Started Guide link under BSP column
   • Download Platform Getting Started Guide (GSG) based on your platform (e.g., MTL, ARL)
   • In Platform GSG
     • Go to Getting Started with Ubuntu* with Kernel Overlay section
     • Follow steps to install Intel Kernel Overlay and Userspace packages

2. Clone this repository and checkout to your desired release tag

export $HOME=$(pwd)
cd $HOME
git clone https://github.com/intel/Intel-MIPI-CSI-Camera-Reference-Driver.git
cd Intel-MIPI-CSI-Camera-Reference-Driver
git checkout <release-tag>

3. Clone ipu repositories and checkout to below commits

cd $HOME
git clone -b iotg_ipu6 https://github.com/intel/ipu6-camera-bins.git
cd ipu6-camera-bins
git checkout 0b102acf2d95f86ec85f0299e0dc779af5fdfb81

cd $HOME
git clone -b iotg_ipu6 https://github.com/intel/ipu6-camera-hal.git
cd ipu6-camera-hal
git checkout a647a0a0c660c1e43b00ae9e06c0a74428120f3a

cd $HOME
git clone -b icmaerasrc_slim_api https://github.com/intel/icamerasrc.git
cd icamerasrc
git checkout 4fb31db76b618aae72184c59314b839dedb42689

cd $HOME
git clone -b iotg_ipu6 https://github.com/intel/ipu6-drivers.git
cd ipu6-drivers
git checkout 71e2e426f3e16f8bc42bf2f88a21fa95eeca5923

4. Deploy and build IPU userspace components

# ipu6-camera-bins: Deploy files using below steps:
# Runtime Files
mkdir -p /lib/firmware/intel/ipu
sudo cp -r $HOME/ipu6-camera-bins/lib/lib* /usr/lib/
sudo cp -r $HOME/ipu6-camera-bins/lib/firmware/intel/ipu/*.bin /lib/firmware/intel/ipu

# Development files
mkdir -p /usr/include /usr/lib/pkgconfig
sudo cp -r $HOME/ipu6-camera-bins/include/* /usr/include/
sudo cp -r $HOME/ipu6-camera-bins/lib/pkgconfig/* /usr/lib/pkgconfig/

for lib in $HOME/ipu6-camera-bins/lib/lib*.so.*; do \
  lib=${lib##*/}; \
  sudo ln -s $lib /usr/lib/${lib%.*}; \
done

# ipu6-camera-hal and icamerasrc: Build using below steps:
# Make sure ipu6-camera-hal & icamerasrc are both in same directory, i.e. $HOME.
cd $HOME
cp $HOME/ipu6-camera-hal/build.sh .
# To build IPU6EPMTL with DMA (recommended)
./build.sh -d --board ipu_mtl

# To build IPU6EPMTL without DMA
./build.sh --board ipu_mtl

# Install built libraries to Target
sudo cp -r $HOME/out/<target>/install/etc/* /etc/
sudo cp -r $HOME/out/<target>/install/usr/include/* /usr/include/
sudo cp -r $HOME/out/<target>/install/usr/lib/* /usr/lib/

5. (optional) Setup media-ctl to Version 1.30 for debugging

# Install dependencies
sudo apt-get install debhelper doxygen gcc git graphviz libasound2-dev libjpeg-dev libqt5opengl5-dev libudev-dev libx11-dev meson pkg-config qtbase5-dev udev libsdl2-dev libbpf-dev llvm clang libjson-c-dev

# Build and install v4l-utils 1.30
git clone https://github.com/gjasny/v4l-utils.git -b stable-1.30
cd v4l-utils
meson build/
sudo ninja -C build/ install

6. (If needed) Refer to doc/\<sensor\>/kernelspace.md, if there are dependency patches to enable the sensor, apply the patch to ipu6-drivers.

cd $HOME/ipu6-drivers
git am $HOME/Intel-MIPI-CSI-Camera-Reference-Driver/.../XXX.patch

7. Dkms build ipu6-drivers

cd $HOME/ipu6-drivers
sudo dkms add .
sudo dkms build -m ipu6-drivers -v 0.0.0
sudo dkms install -m ipu6-drivers -v 0.0.0

8. Dkms build this repository

cd $HOME/Intel-MIPI-CSI-Camera-Reference-Driver
sudo dkms add .
sudo dkms build -m ipu-camera-sensor -v 0.1
sudo dkms install -m ipu-camera-sensor -v 0.1

9. Power off Board. Connect Sensor Hardware. Power On Board and Sensor.

10. Boot into BIOS menu. Configure BIOS option according to config/<sensor>/userspace-<interface>.md,

    • Follow Section BIOS Configuration Table
      • <IPU VERSION> Camera Option and/or
      • <IPU VERSION> Control Logic

    For example, for ISX031 GMSL on K6.12 IPU6EPMTL platform:

    • Follow config/isx031/userspace-gmsl.md
      • Follow BIOS Configuration Table >> IPU6EPMTL Camera Option

11. Boot into OS. Check if sensor is enumerated correctly in media-ctl

    • If sensor is not listed, re-check hardware connection and BIOS configuration
    • If issue persists, refer to Intel IPU Team for support.

media-ctl -p | grep -ie <sensor>

12. Setup XML file according to config/<sensor>/userspace-<interface>.md,

    • Follow Section Camera XML File Setup
      • <IPU VERSION> Configuration

    For example, for ISX031 GMSL on K6.12 IPU6EPMTL platform:

    • Follow config/isx031/userspace-gmsl.md
      • Follow Camera XML File Setup >> IPU6EPMTL Configuration section

13. Export below environment variables or add to shell profile (e.g., ~/.bashrc )

export DISPLAY=:0; xhost +
export GST_PLUGIN_PATH=/usr/lib/gstreamer-1.0
export LIBVA_DRIVER_NAME=iHD
export GST_GL_API=gles2
export GST_GL_PLATFORM=egl
export LIBVA_DRIVERS_PATH=/usr/lib/x86_64-linux-gnu/dri
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib64/pkgconfig:/usr/lib/pkgconfig
export LD_LIBRARY_PATH=/usr/local/lib/pkgconfig:/usr/local/lib:/usr/lib64:/usr/lib:/usr/lib/x86_64-linux-gnu
export logSink=terminal
rm -rf ~/.cache/gstreamer-1.0

14. Run Gstreamer command according to config/<sensor>/userspace-<interface>.md,

    • Follow Section Sample Userspace Command
      • Copy and run command based on your use case.

    For example, for 1x ISX031 GMSL on K6.12 IPU6EPMTL platform:

    • Follow config/isx031/userspace-gmsl.md
      • Follow Sample Userspace Command >> Number of Stream (Single Stream / Multi Stream) Selection >> command for x1 stream

15. Enjoy your camera stream!

Documentation

Detailed documentation for each sensor can be found in the doc/ directory, organized by sensor model.

Contributing

Please read CONTRIBUTING.md for guidelines on contributing to this project.

Security

For security concerns, please see SECURITY.md.

Code of Conduct

This project follows our Code of Conduct.