@@ -85,12 +85,14 @@ a result of the configuration of a number of camera sensor implementation
specific parameters. Luckily, these parameters tend to be the same for more or
less all modern raw camera sensors.
-The frame interval is calculated using the following equation::
+The frame interval is calculated using one of the following equations::
frame interval = (analogue crop width + horizontal blanking) *
(analogue crop height + vertical blanking) / pixel rate
-The formula is bus independent and is applicable for raw timing parameters on
+ frame interval = horizontal total size * vertical total size / pixel rate
+
+The formulas are bus independent and are applicable for raw timing parameters on
large variety of devices beyond camera sensors. Devices that have no analogue
crop, use the full source image size, i.e. pixel array size.
@@ -100,6 +102,11 @@ is pixels and the unit of the ``V4L2_CID_VBLANK`` is lines. The pixel rate in
the sensor's **pixel array** is specified by ``V4L2_CID_PIXEL_RATE`` in the same
sub-device. The unit of that control is pixels per second.
+Additionally, the horizontal and vertical total sizes are specified by
+``V4L2_CID_HTOTAL`` and ``V4L2_CID_VTOTAL``, respectively. The unit of the
+``V4L2_CID_HTOTAL`` control is pixels and the unit of the ``V4L2_CID_VTOTAL`` is
+lines, analogous to the blanking.
+
Register list based drivers need to implement read-only sub-device nodes for the
purpose. Devices that are not register list based need these to configure the
device's internal processing pipeline.
@@ -59,6 +59,22 @@ Image Source Control IDs
non-sensitive.
This control is required for automatic calibration of sensors/cameras.
+``V4L2_CID_VTOTAL (integer)``
+ Number of total lines per frame, including data and idle lines (blanking).
+ The unit of the vertical total size is a line. Every line has length of the
+ image width plus horizontal blanking at the pixel rate defined by
+ ``V4L2_CID_PIXEL_RATE`` control in the same sub-device.
+
+``V4L2_CID_HTOTAL (integer)``
+ Number of total pixels per line, including data and idle pixels (blanking).
+ The unit of the horizontal total size is pixels. The default value of this
+ control is set to a value which allows a constant total size for every
+ supported mode of the sensor. The control can be used to indicate the driver
+ if a high frame rate (value < default) or a high exposure (value > default)
+ should be achieved. With value = default, a constant frame size across the
+ different modes is targeted. Note that the actual frame rate depends on the
+ ``V4L2_CID_PIXEL_RATE`` control, which might vary between mode switches.
+
.. c:type:: v4l2_area
.. flat-table:: struct v4l2_area
@@ -1112,6 +1112,8 @@ const char *v4l2_ctrl_get_name(u32 id)
case V4L2_CID_TEST_PATTERN_BLUE: return "Blue Pixel Value";
case V4L2_CID_TEST_PATTERN_GREENB: return "Green (Blue) Pixel Value";
case V4L2_CID_NOTIFY_GAINS: return "Notify Gains";
+ case V4L2_CID_VTOTAL: return "Vertical Total Size";
+ case V4L2_CID_HTOTAL: return "Horizontal Total Size";
/* Image processing controls */
/* Keep the order of the 'case's the same as in v4l2-controls.h! */
@@ -1117,6 +1117,8 @@ enum v4l2_jpeg_chroma_subsampling {
#define V4L2_CID_TEST_PATTERN_GREENB (V4L2_CID_IMAGE_SOURCE_CLASS_BASE + 7)
#define V4L2_CID_UNIT_CELL_SIZE (V4L2_CID_IMAGE_SOURCE_CLASS_BASE + 8)
#define V4L2_CID_NOTIFY_GAINS (V4L2_CID_IMAGE_SOURCE_CLASS_BASE + 9)
+#define V4L2_CID_VTOTAL (V4L2_CID_IMAGE_SOURCE_CLASS_BASE + 10)
+#define V4L2_CID_HTOTAL (V4L2_CID_IMAGE_SOURCE_CLASS_BASE + 11)
/* Image processing controls */