DB-MIPI-A1 Driver User Guide¶
References¶
Driver version: 2.0.0
Document reference |
UG035 |
Document revision |
B |
Generation date |
23 Oct. 2026 |
Written by |
F. DESCAMPS |
22 Oct. 2026 |
Validated by |
- |
- |
Approved by |
K. TOUTAIN |
23 Oct. 2026 |
Abbreviation table¶
API |
Application Programming Interface |
CSI |
Camera Serial Interface |
I2C |
Inter-Integrated Circuit |
ISP |
Image Signal Processor |
SPI |
Serial Peripheral Interface |
V4L2 |
Video4Linux2 |
Introduction¶
This guide introduces the DB-MIPI-A1 Linux driver and explains how to interact with its custom V4L2 controls from user space.
The driver is intended to be installed from the Debian package provided for the
platform (refer to document UG034 for instructions).
Once installed and enabled, it registers a V4L2 sub-device node and
exposes the MIPI board’s controls for temperature acquisition, test pattern
handling, sensor resolution, sensor clock generator setup, shutter management,
and specific register access of Proxy, Sensor, Sensor ISP.
This document is focused on user-space usage. It gives the operational context needed to understand where the controls live, how they are expected to be used, and which access patterns are important during bring-up and validation.
Driver Context¶
How the Driver Appears in Linux¶
When the package is installed on a Raspberry Pi or on a Jetson Orin Nano
developer kit and the corresponding overlay is enabled, the MIPI board appears
in the Linux media graph as a V4L2 sub-device. User-space control access
therefore happens on a device such as /dev/v4l-subdev0. The receiver can
have sub-device nodes too. The MIPI board’s node is the one whose name in
/sys/class/video4linux/v4l-subdev*/name starts with db-mipi-a1, for
example db-mipi-a1 9-003d.
Note
The custom controls documented here are exposed on the V4L2 sub-device node.
On a Jetson the capture node exposes them too; on a Raspberry Pi, capture
nodes such as /dev/video0 do not.
Media Format and Link Assumptions¶
The driver reports the following media-bus format:
Bus code:
MEDIA_BUS_FMT_RGB888_1X24(with R = LSB, G = MSB and B = 0)Colorspace:
V4L2_COLORSPACE_SRGBFrame width:
1536Frame height: initialized to
480and updated when the sensorYresolution is configuredField:
V4L2_FIELD_NONE
The capture node stores each 24-bit pixel the way the platform’s receiver
stores RGB888: in 3 bytes (V4L2_PIX_FMT_RGB24) on a Raspberry Pi, in 4 bytes
(V4L2_PIX_FMT_RGBA32, the fourth one 0xFF) on a Jetson, whose receiver
offers no other format for this bus code. On both, the 16-bit sensor word is
bytes 0 (LSB) and 1 (MSB) of each pixel.
Getting Started¶
On a Raspberry Pi¶
A typical deployment and validation sequence is:
Install the provided Debian package, which brings in the MIPI board device tree overlay (package
fullscale-mipi-overlays-rpi).Enable the MIPI board device tree overlay.
Reboot.
Confirm that the sub-device node exists.
Inspect the media graph and the list of custom controls.
Issue control requests on the sub-device node.
Refer to the document UG034 for instructions about first steps
Useful commands during validation are:
ls /dev/v4l-subdev* # => Get exact subdevice node file (and confirm that the driver
# has been properly loaded)
v4l2-ctl --device=/dev/v4l-subdev0 --list-ctrls -L # => List available controls
media-ctl -p # => Confirm that the MIPI board's subdevice is linked to the CSI-2 receiver
On a Jetson Orin Nano developer kit¶
The driver builds against NVIDIA’s VI and NVCSI drivers: the
nvidia-l4t-kernel-headers and nvidia-l4t-kernel-oot-headers packages
must be installed. The overlays come with the driver package, from
fullscale-mipi-overlays-jetson: they are installed in /boot and selected
with Jetson-IO, which lists them under the Jetson 22pin CSI Connector header as
FullScale DB-MIPI-A1 on CAM0, FullScale DB-MIPI-A1 on CAM1,
FullScale DB-MIPI-A1 on CAM0 and CAM1 and, with another FullScale MIPI
board on the other connector, for example
FullScale DB-MIPI-A1 on CAM0 and MD-MZ-I313 on CAM1:
sudo /opt/nvidia/jetson-io/config-by-hardware.py -l # => List the headers and their overlays
sudo /opt/nvidia/jetson-io/config-by-hardware.py -n 2="FullScale DB-MIPI-A1 on CAM1" # => 2 is the CSI connector header in that list
sudo reboot
Once the setup is configured through the controls (resolution, clock
generator), the MIPI board streams on /dev/video0. Set the capture format to
the sub-device’s width and the configured height, for example:
v4l2-ctl --device=/dev/video0 --set-fmt-video=width=1536,height=1024,pixelformat=AB24 \
--stream-mmap --stream-count=100
With two MIPI boards, each has its own capture node. A MIPI board’s node is the
one whose name in /sys/class/video4linux/video*/name ends with the MIPI
board’s sub-device name, for example vi-output, db-mipi-a1 9-003d.
Control Model¶
The public API defines several main control styles:
Read-only volatile controls used to fetch live state and measurements
Button controls used to trigger one-shot actions
Integer read or write controls used to read hardware registers values or to set them
64-bit integer controls used for register access, packing the register address with the value
A menu control used to report shutter position
A few practical rules are worth keeping in mind:
V4L2_CID_CUSTOM_S_ADCVTEMP_INITshould be triggered before reading the ADC VTemp controlI2C proxy controls only makes sense if the connected proxy has i2c connection
Sensor ISP controls only makes sense if the connected sensor embeds an ISP
For sensor resolution updates, user should set
XthenYthenapplyStopping the stream makes the MIPI board forget the applied resolution, so the driver writes the last
XandYagain, and applies them, each time streaming startsFor sensor clock generator updates user should set the coefficient, then
apply config, thenoutput enableThe driver stops the sensor when streaming stops, when the clock generator configuration is applied, and when it is unloaded or the system shuts down. It runs the sensor again when the clock output is enabled and when streaming starts. A stopped sensor is what makes the proxy board safe to unplug. The sensor ends the frame in progress first, so each stop waits 110 ms: stopping the stream and
apply configtake that much longerThe MIPI board needs 10 ms after each I2C command, and the proxy boards 20 ms after each command, sent through the MIPI board (SPI) or on I2C, so the driver keeps the I2C bus that long after each transfer: a control takes at least that long, one that makes several transfers, such as the ADC VTemp read, a multiple of it. Another MIPI board behind the same I2C controller, as on the Jetson, waits meanwhile: a proxy board running a command can be a master on the bus
The Proxy i2c, Sensor ISP and Sensor read controls use a two-step access pattern: write the register address first, then read the same control back to obtain the value
Control Reference¶
Sensor temperature
-
V4L2_CID_CUSTOM_G_COLVTEMP_TEMPERATURE¶
Returns the VTemp temperature measurement given by the proxy board in the temperature columns.
Read-only unsigned 16-bit control.
-
V4L2_CID_CUSTOM_G_ADCVTEMP_TEMPERATURE¶
Returns the VTemp temperature measurement given by the MIPI board embedded ADC.
The value returned is a fixed point representation of the VTemp voltage:
VTemp(V) = value_returned / 1000000
Refer to the Proxy board datasheet to convert it to degrees Celsius.
Read-only signed 32-bit control. This readout is meaningful only after the ADC has been initialized; the control is flagged inactive until then.
-
V4L2_CID_CUSTOM_S_ADCVTEMP_INIT¶
Initializes the embedded ADC VTemp.
Button control.
Test Pattern Controls
-
V4L2_CID_CUSTOM_G_TEST_PATTERN_ACTIVATED¶
Returns whether the MIPI board test pattern is currently enabled.
Read-only boolean control.
-
V4L2_CID_CUSTOM_S_TEST_PATTERN_ON¶
Enables the MIPI board test pattern generator.
Button control.
-
V4L2_CID_CUSTOM_S_TEST_PATTERN_OFF¶
Disables the MIPI board test pattern generator.
Button control.
Sensor resolution
These controls inform the MIPI board of the currently connected sensor’s resolution.
-
V4L2_CID_CUSTOM_S_SENSOR_RESOLUTION_X¶
Sets the sensor active X resolution.
Unsigned 16-bit write control.
-
V4L2_CID_CUSTOM_S_SENSOR_RESOLUTION_Y¶
Sets the sensor active Y resolution.
The driver updates the reported media-bus frame height from this value.
Unsigned 16-bit control.
-
V4L2_CID_CUSTOM_S_SENSOR_RESOLUTION_APPLY¶
Applies the sensor resolution previously configured through the X and Y controls.
Stopping the stream makes the MIPI board forget it: the driver writes the last X and Y again, and applies them, each time streaming starts.
Button control.
Sensor Clock
These controls configure the embedded clock generator so that it produces the desired sensor clock.
-
V4L2_CID_CUSTOM_G_SENSOR_CLKGEN_CONFIG_DONE¶
Returns whether the sensor clock generator configuration has been applied.
Read-only boolean control.
-
V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_M_DIV_COEF¶
Sets the sensor clock generator M divider coefficient.
Unsigned 8-bit control.
-
V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_N_DIV_COEF¶
Sets the sensor clock generator N divider coefficient.
Unsigned 16-bit control.
-
V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_OUT_DIV_COEF¶
Sets the sensor clock generator output divider coefficient.
Unsigned 8-bit control.
-
V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_APPLY_CONFIG¶
Applies the sensor clock generator configuration.
Button control. The sensor is stopped first, which takes 110 ms: it does not run while its clock is reprogrammed.
-
V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_OUTPUT_ENABLE¶
Enables the sensor clock generator output.
Button control. The sensor runs again once the output is enabled.
Shutter controls
-
V4L2_CID_CUSTOM_G_SHUTTER_POSITION¶
Returns the current shutter position.
Read-only menu control. The returned value matches one of the
V4L2_SHUTTER_POSITION_*constants below.
-
V4L2_CID_CUSTOM_S_SHUTTER_OPEN¶
Opens the shutter.
Button control.
-
V4L2_CID_CUSTOM_S_SHUTTER_CLOSE¶
Closes the shutter.
Button control.
SPI Proxy arbitrary register write
These controls can be used to write any Proxy register accessible through SPI.
-
V4L2_CID_CUSTOM_S_SPI_PROXY_REGISTER¶
Writes a Proxy register through the SPI bus.
64-bit integer control. Bits [31:16] hold the SPI proxy register address (4 bits, 0x0 to 0xF) and bits [11:0] the value to write. Out-of-range fields are rejected with EINVAL.
I2C Proxy arbitrary register access
These controls can be used to read or write any Proxy register accessible through I2C.
-
V4L2_CID_CUSTOM_G_I2C_PROXY_REGISTER¶
Reads a Proxy register through the I2C bus.
64-bit integer control. User space first writes the register address in bits [31:16], then reads the control back: bits [31:16] hold the address the value was read from and bits [7:0] the register value. The control is flagged inactive until a first address is written to it.
-
V4L2_CID_CUSTOM_S_I2C_PROXY_REGISTER¶
Writes a Proxy register through the I2C bus.
64-bit integer control. Bits [31:16] hold the register address and bits [7:0] the value to write.
Sensor ISP arbitrary register access
These controls can be used to read or write any Sensor ISP register.
-
V4L2_CID_CUSTOM_G_SENSOR_ISP_REGISTER¶
Reads a Sensor ISP register through a two-step access pattern.
64-bit integer control. User space first writes the register address in bits [31:16], then reads the control back: bits [31:16] hold the address the value was read from and bits [15:0] the register value. The control is flagged inactive until a first address is written to it.
-
V4L2_CID_CUSTOM_S_SENSOR_ISP_REGISTER¶
Writes a Sensor ISP register.
64-bit integer control. Bits [31:16] hold the register address and bits [15:0] the value to write.
Sensor arbitrary register access
These controls can be used to read or write any Sensor register.
-
V4L2_CID_CUSTOM_G_SENSOR_REGISTER¶
Reads a sensor register through a two-step access pattern.
64-bit integer control. User space first writes the register address in bits [31:16], then reads the control back: bits [31:16] hold the address the value was read from and bits [7:0] the register value. The control is flagged inactive until a first address is written to it.
-
V4L2_CID_CUSTOM_S_SENSOR_REGISTER¶
Writes a sensor register.
64-bit integer control. Bits [31:16] hold the register address and bits [7:0] the value to write.
Shutter constant values
-
V4L2_SHUTTER_POSITION_CLOSED¶
Shutter position value for a closed shutter.
-
V4L2_SHUTTER_POSITION_OPEN¶
Shutter position value for an open shutter.
-
V4L2_SHUTTER_POSITION_MOVING¶
Shutter position value for a shutter currently moving.
Defines
-
V4L2_CID_CUSTOM_BASE¶
Using v4l2-ctl¶
Control names shown by v4l2-ctl are derived from the driver strings and are
typically normalized with underscores. Always trust the exact names returned by
--list-ctrls -L on your target.
Typical examples are:
# Query current custom controls
v4l2-ctl --device=/dev/v4l-subdev0 --list-ctrls -L
# Read temperatures
v4l2-ctl --device=/dev/v4l-subdev0 --get-ctrl='g_colvtemp_temperature'
v4l2-ctl --device=/dev/v4l-subdev0 --set-ctrl='s_adcvtemp_init=1'
v4l2-ctl --device=/dev/v4l-subdev0 --get-ctrl='g_adcvtemp_temperature'
# Enable or disable the MIPI board test pattern
v4l2-ctl --device=/dev/v4l-subdev0 --set-ctrl='s_test_pattern_on=1'
v4l2-ctl --device=/dev/v4l-subdev0 --set-ctrl='s_test_pattern_off=1'
# Configure and apply sensor resolution
v4l2-ctl --device=/dev/v4l-subdev0 --set-ctrl='s_sensor_resolution_x=1288'
v4l2-ctl --device=/dev/v4l-subdev0 --set-ctrl='s_sensor_resolution_y=1024'
v4l2-ctl --device=/dev/v4l-subdev0 --set-ctrl='s_sensor_resolution_apply=1'
# Read shutter state
v4l2-ctl --device=/dev/v4l-subdev0 --get-ctrl='g_shutter_position'
# Select a Sensor ISP register to read (address in bits [31:16]), then fetch it
v4l2-ctl --device=/dev/v4l-subdev0 --set-ctrl='g_sensor_isp_register=0x00010000'
v4l2-ctl --device=/dev/v4l-subdev0 --get-ctrl='g_sensor_isp_register' # => (address << 16) | value
# Select a sensor register to read (address in bits [31:16]), then fetch it
v4l2-ctl --device=/dev/v4l-subdev0 --set-ctrl='g_sensor_register=0x00000000'
v4l2-ctl --device=/dev/v4l-subdev0 --get-ctrl='g_sensor_register' # => (address << 16) | value
Warning
Register-read and register-write interactions depend on the exact support
level of the v4l2-ctl version available on the target. For robust
production use, a dedicated application based on the V4L2 ioctl API is often
more convenient than shell commands alone.
Using the V4L2 ioctl API¶
The public header provides the control identifiers that should be used by applications.
The example below illustrates a one-shot button command and a Proxy register write.
#include <fcntl.h>
#include <linux/videodev2.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <sys/ioctl.h>
#include <unistd.h>
#include "db-mipi-a1_public.h"
static int trigger_action(int fd, unsigned int id)
{
struct v4l2_control ctrl;
memset(&ctrl, 0, sizeof(ctrl));
ctrl.id = id;
ctrl.value = 1;
return ioctl(fd, VIDIOC_S_CTRL, &ctrl);
}
static int write_proxy_register(int fd, uint16_t reg, uint16_t value)
{
struct v4l2_ext_control ext_ctrl;
struct v4l2_ext_controls ext_ctrls;
memset(&ext_ctrl, 0, sizeof(ext_ctrl));
memset(&ext_ctrls, 0, sizeof(ext_ctrls));
// Register address in bits [31:16], value in bits [11:0]
ext_ctrl.id = V4L2_CID_CUSTOM_S_SPI_PROXY_REGISTER;
ext_ctrl.value64 = ((int64_t)reg << 16) | value;
ext_ctrls.count = 1;
ext_ctrls.controls = &ext_ctrl;
return ioctl(fd, VIDIOC_S_EXT_CTRLS, &ext_ctrls);
}
int main(void)
{
int fd = open("/dev/v4l-subdev0", O_RDWR);
if (fd < 0)
return 1;
// Enable test pattern
if (trigger_action(fd, V4L2_CID_CUSTOM_S_TEST_PATTERN_ON) < 0)
perror("enable test pattern");
// Change GMS register value
// /!\ NOTE : Check your Proxy/Sensor datasheet for correct values
if (write_proxy_register(fd, 0x0005, 0x00D3) < 0)
perror("write Proxy register");
close(fd);
return 0;
}
Note that the db-mipi-a1_public.h file should be placed next to the above
file with the following content:
/*******************************************************************************
* ^ *
* | @ *
* @ _____ @ _ _ ____ _ *
* | | ___| _| | / ___| ___ __ _| | ___ *
* | | |_ | | | | | \___ \ / __/ _` | |/ _ \ *
* @ | | _|| |_| | | |___) | (_| (_| | | __/ *
* | | |_| \__,_|_|_|____/ \___\__,_|_|\___| *
* ----------------------------------------------------> *
* | @ | | | @ *
* | | | | *
* @ | @ *
* @ *
* File: db-mipi-a1_public.h *
* Project: db-mipi-a1-driver *
* Created 21/08/2025 by François Descamps *
* *
* Copyright (c) 2025 - 2026 FullScale SARL. All Rights Reserved. *
* *
* This project is licensed under GNU General Public License v2.0 only. *
* See the LICENSE file for details. *
******************************************************************************/
#ifndef DB_MIPI_A1_PUBLIC_H
# define DB_MIPI_A1_PUBLIC_H
# include <linux/v4l2-controls.h>
// Base placed above the ranges already allocated in v4l2-controls.h to avoid ID collisions
# define V4L2_CID_CUSTOM_BASE (V4L2_CID_USER_BASE + 0x2000)
/**
* @name Sensor temperature
*/
/**
* @brief Returns the VTemp temperature measurement given by the proxy board
* in the temperature columns.
*
* Read-only unsigned 16-bit control.
*/
# define V4L2_CID_CUSTOM_G_COLVTEMP_TEMPERATURE (V4L2_CID_CUSTOM_BASE + 0x0000)
/**
* @brief Returns the VTemp temperature measurement given by the MIPI board
* embedded ADC.
*
* The value returned is a fixed point representation of the VTemp voltage:
*
* VTemp(V) = value_returned / 1000000
*
* Refer to the Proxy board datasheet to convert it to degrees Celsius.
*
* Read-only signed 32-bit control. This readout is meaningful only
* after the ADC has been initialized; the control is flagged inactive
* until then.
*/
# define V4L2_CID_CUSTOM_G_ADCVTEMP_TEMPERATURE (V4L2_CID_CUSTOM_BASE + 0x0100)
/**
* @brief Initializes the embedded ADC VTemp.
*
* Button control.
*/
# define V4L2_CID_CUSTOM_S_ADCVTEMP_INIT (V4L2_CID_CUSTOM_BASE + 0x0101)
/**
* @name Test Pattern Controls
*/
/**
* @brief Returns whether the MIPI board test pattern is currently enabled.
*
* Read-only boolean control.
*/
# define V4L2_CID_CUSTOM_G_TEST_PATTERN_ACTIVATED (V4L2_CID_CUSTOM_BASE + 0x0200)
/**
* @brief Enables the MIPI board test pattern generator.
*
* Button control.
*/
# define V4L2_CID_CUSTOM_S_TEST_PATTERN_ON (V4L2_CID_CUSTOM_BASE + 0x0201)
/**
* @brief Disables the MIPI board test pattern generator.
*
* Button control.
*/
# define V4L2_CID_CUSTOM_S_TEST_PATTERN_OFF (V4L2_CID_CUSTOM_BASE + 0x0202)
/**
* @name Sensor resolution
*
* @brief These controls inform the MIPI board of the
* currently connected sensor's resolution.
*/
/**
* @brief Sets the sensor active X resolution.
*
* Unsigned 16-bit write control.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_RESOLUTION_X (V4L2_CID_CUSTOM_BASE + 0x0300)
/**
* @brief Sets the sensor active Y resolution.
*
* The driver updates the reported media-bus frame height from this value.
*
* Unsigned 16-bit control.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_RESOLUTION_Y (V4L2_CID_CUSTOM_BASE + 0x0301)
/**
* @brief Applies the sensor resolution previously configured through the X and Y
* controls.
*
* Stopping the stream makes the MIPI board forget it: the driver writes the
* last X and Y again, and applies them, each time streaming starts.
*
* Button control.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_RESOLUTION_APPLY (V4L2_CID_CUSTOM_BASE + 0x0302)
/**
* @name Sensor Clock
*
* @brief These controls configure the embedded clock generator
* so that it produces the desired sensor clock.
*/
/**
* @brief Returns whether the sensor clock generator configuration has been applied.
*
* Read-only boolean control.
*/
# define V4L2_CID_CUSTOM_G_SENSOR_CLKGEN_CONFIG_DONE (V4L2_CID_CUSTOM_BASE + 0x0400)
/**
* @brief Sets the sensor clock generator M divider coefficient.
*
* Unsigned 8-bit control.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_M_DIV_COEF (V4L2_CID_CUSTOM_BASE + 0x0401)
/**
* @brief Sets the sensor clock generator N divider coefficient.
*
* Unsigned 16-bit control.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_N_DIV_COEF (V4L2_CID_CUSTOM_BASE + 0x0402)
/**
* @brief Sets the sensor clock generator output divider coefficient.
*
* Unsigned 8-bit control.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_OUT_DIV_COEF (V4L2_CID_CUSTOM_BASE + 0x0403)
/**
* @brief Applies the sensor clock generator configuration.
*
* Button control. The sensor is stopped first, which takes 110 ms: it does
* not run while its clock is reprogrammed.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_APPLY_CONFIG (V4L2_CID_CUSTOM_BASE + 0x0404)
/**
* @brief Enables the sensor clock generator output.
*
* Button control. The sensor runs again once the output is enabled.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_CLKGEN_OUTPUT_ENABLE (V4L2_CID_CUSTOM_BASE + 0x0405)
/**
* @name Shutter controls
*/
/**
* @brief Returns the current shutter position.
*
* Read-only menu control. The returned value matches one of the
* ``V4L2_SHUTTER_POSITION_*`` constants below.
*/
# define V4L2_CID_CUSTOM_G_SHUTTER_POSITION (V4L2_CID_CUSTOM_BASE + 0x0500)
/**
* @brief Opens the shutter.
*
* Button control.
*/
# define V4L2_CID_CUSTOM_S_SHUTTER_OPEN (V4L2_CID_CUSTOM_BASE + 0x0501)
/**
* @brief Closes the shutter.
*
* Button control.
*/
# define V4L2_CID_CUSTOM_S_SHUTTER_CLOSE (V4L2_CID_CUSTOM_BASE + 0x0502)
/**
* @name SPI Proxy arbitrary register write
*
* @brief These controls can be used to write any Proxy register
* accessible through SPI.
*/
/**
* @brief Writes a Proxy register through the SPI bus.
*
* 64-bit integer control. Bits [31:16] hold the SPI proxy register address
* (4 bits, 0x0 to 0xF) and bits [11:0] the value to write. Out-of-range
* fields are rejected with EINVAL.
*/
# define V4L2_CID_CUSTOM_S_SPI_PROXY_REGISTER (V4L2_CID_CUSTOM_BASE + 0x0600)
/**
* @name I2C Proxy arbitrary register access
*
* @brief These controls can be used to read or write any Proxy register
* accessible through I2C.
*/
/**
* @brief Reads a Proxy register through the I2C bus.
*
* 64-bit integer control. User space first writes the register address in
* bits [31:16], then reads the control back: bits [31:16] hold the address
* the value was read from and bits [7:0] the register value.
* The control is flagged inactive until a first address is written to it.
*/
# define V4L2_CID_CUSTOM_G_I2C_PROXY_REGISTER (V4L2_CID_CUSTOM_BASE + 0x0700)
/**
* @brief Writes a Proxy register through the I2C bus.
*
* 64-bit integer control. Bits [31:16] hold the register address and
* bits [7:0] the value to write.
*/
# define V4L2_CID_CUSTOM_S_I2C_PROXY_REGISTER (V4L2_CID_CUSTOM_BASE + 0x0701)
/**
* @name Sensor ISP arbitrary register access
*
* @brief These controls can be used to read or write any Sensor ISP register.
*/
/**
* @brief Reads a Sensor ISP register through a two-step access pattern.
*
* 64-bit integer control. User space first writes the register address in
* bits [31:16], then reads the control back: bits [31:16] hold the address
* the value was read from and bits [15:0] the register value.
* The control is flagged inactive until a first address is written to it.
*/
# define V4L2_CID_CUSTOM_G_SENSOR_ISP_REGISTER (V4L2_CID_CUSTOM_BASE + 0x0800)
/**
* @brief Writes a Sensor ISP register.
*
* 64-bit integer control. Bits [31:16] hold the register address and
* bits [15:0] the value to write.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_ISP_REGISTER (V4L2_CID_CUSTOM_BASE + 0x0801)
/**
* @name Sensor arbitrary register access
*
* @brief These controls can be used to read or write any Sensor register.
*/
/**
* @brief Reads a sensor register through a two-step access pattern.
*
* 64-bit integer control. User space first writes the register address in
* bits [31:16], then reads the control back: bits [31:16] hold the address
* the value was read from and bits [7:0] the register value.
* The control is flagged inactive until a first address is written to it.
*/
# define V4L2_CID_CUSTOM_G_SENSOR_REGISTER (V4L2_CID_CUSTOM_BASE + 0x0900)
/**
* @brief Writes a sensor register.
*
* 64-bit integer control. Bits [31:16] hold the register address and
* bits [7:0] the value to write.
*/
# define V4L2_CID_CUSTOM_S_SENSOR_REGISTER (V4L2_CID_CUSTOM_BASE + 0x0901)
/**
* @name Shutter constant values
*/
/**
* @brief Shutter position value for a closed shutter.
*/
# define V4L2_SHUTTER_POSITION_CLOSED 0
/**
* @brief Shutter position value for an open shutter.
*/
# define V4L2_SHUTTER_POSITION_OPEN 1
/**
* @brief Shutter position value for a shutter currently moving.
*/
# define V4L2_SHUTTER_POSITION_MOVING 2
#endif
Revision history¶
Date |
Author(s) |
Version |
Comments |
|---|---|---|---|
04/2026 |
F. DESCAMPS |
Rev. A |
First document release |
10/2026 |
F. DESCAMPS |
Rev. B |
Driver 2.0.0: Jetson Orin Nano, overlays package, new control IDs, fixed register examples |