Documentation/media/uapi/v4l/ext-ctrls-image-source.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _image-source-controls:
  11
  12 ******************************
  13 Image Source Control Reference
  14 ******************************
  15
  16 The Image Source control class is intended for low-level control of
  17 image source devices such as image sensors. The devices feature an
  18 analogue to digital converter and a bus transmitter to transmit the
  19 image data out of the device.
  20
  21
  22 .. _image-source-control-id:
  23
  24 Image Source Control IDs
  25 ========================
  26
  27 ``V4L2_CID_IMAGE_SOURCE_CLASS (class)``
  28     The IMAGE_SOURCE class descriptor.
  29
  30 ``V4L2_CID_VBLANK (integer)``
  31     Vertical blanking. The idle period after every frame during which no
  32     image data is produced. The unit of vertical blanking is a line.
  33     Every line has length of the image width plus horizontal blanking at
  34     the pixel rate defined by ``V4L2_CID_PIXEL_RATE`` control in the
  35     same sub-device.
  36
  37 ``V4L2_CID_HBLANK (integer)``
  38     Horizontal blanking. The idle period after every line of image data
  39     during which no image data is produced. The unit of horizontal
  40     blanking is pixels.
  41
  42 ``V4L2_CID_ANALOGUE_GAIN (integer)``
  43     Analogue gain is gain affecting all colour components in the pixel
  44     matrix. The gain operation is performed in the analogue domain
  45     before A/D conversion.
  46
  47 ``V4L2_CID_TEST_PATTERN_RED (integer)``
  48     Test pattern red colour component.
  49
  50 ``V4L2_CID_TEST_PATTERN_GREENR (integer)``
  51     Test pattern green (next to red) colour component.
  52
  53 ``V4L2_CID_TEST_PATTERN_BLUE (integer)``
  54     Test pattern blue colour component.
  55
  56 ``V4L2_CID_TEST_PATTERN_GREENB (integer)``
  57     Test pattern green (next to blue) colour component.