1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
8 .. c:type:: v4l2_mbus_framefmt
10 .. tabularcolumns:: |p{2.0cm}|p{4.0cm}|p{11.3cm}|
12 .. cssclass:: longtable
14 .. flat-table:: struct v4l2_mbus_framefmt
21 - Image width in pixels.
24 - Image height in pixels. If ``field`` is one of ``V4L2_FIELD_TOP``,
25 ``V4L2_FIELD_BOTTOM`` or ``V4L2_FIELD_ALTERNATE`` then height
26 refers to the number of lines in the field, otherwise it refers to
27 the number of lines in the frame (which is twice the field height
28 for interlaced formats).
31 - Format code, from enum
32 :ref:`v4l2_mbus_pixelcode <v4l2-mbus-pixelcode>`.
35 - Field order, from enum :c:type:`v4l2_field`. See
36 :ref:`field-order` for details.
39 - Image colorspace, from enum :c:type:`v4l2_colorspace`.
40 Must be set by the driver for subdevices. If the application sets the
41 flag ``V4L2_MBUS_FRAMEFMT_SET_CSC`` then the application can set this
42 field on the source pad to request a specific colorspace for the media
43 bus data. If the driver cannot handle the requested conversion, it will
44 return another supported colorspace. The driver indicates that colorspace
45 conversion is supported by setting the flag
46 V4L2_SUBDEV_MBUS_CODE_CSC_COLORSPACE in the corresponding struct
47 :c:type:`v4l2_subdev_mbus_code_enum` during enumeration.
48 See :ref:`v4l2-subdev-mbus-code-flags`.
53 - Y'CbCr encoding, from enum :c:type:`v4l2_ycbcr_encoding`.
54 This information supplements the ``colorspace`` and must be set by
55 the driver for subdevices, see :ref:`colorspaces`. If the application
56 sets the flag ``V4L2_MBUS_FRAMEFMT_SET_CSC`` then the application can set
57 this field on a source pad to request a specific Y'CbCr encoding
58 for the media bus data. If the driver cannot handle the requested
59 conversion, it will return another supported encoding.
60 This field is ignored for HSV media bus formats. The driver indicates
61 that ycbcr_enc conversion is supported by setting the flag
62 V4L2_SUBDEV_MBUS_CODE_CSC_YCBCR_ENC in the corresponding struct
63 :c:type:`v4l2_subdev_mbus_code_enum` during enumeration.
64 See :ref:`v4l2-subdev-mbus-code-flags`.
67 - HSV encoding, from enum :c:type:`v4l2_hsv_encoding`.
68 This information supplements the ``colorspace`` and must be set by
69 the driver for subdevices, see :ref:`colorspaces`. If the application
70 sets the flag ``V4L2_MBUS_FRAMEFMT_SET_CSC`` then the application can set
71 this field on a source pad to request a specific HSV encoding
72 for the media bus data. If the driver cannot handle the requested
73 conversion, it will return another supported encoding.
74 This field is ignored for Y'CbCr media bus formats. The driver indicates
75 that hsv_enc conversion is supported by setting the flag
76 V4L2_SUBDEV_MBUS_CODE_CSC_HSV_ENC in the corresponding struct
77 :c:type:`v4l2_subdev_mbus_code_enum` during enumeration.
78 See :ref:`v4l2-subdev-mbus-code-flags`
83 - Quantization range, from enum :c:type:`v4l2_quantization`.
84 This information supplements the ``colorspace`` and must be set by
85 the driver for subdevices, see :ref:`colorspaces`. If the application
86 sets the flag ``V4L2_MBUS_FRAMEFMT_SET_CSC`` then the application can set
87 this field on a source pad to request a specific quantization
88 for the media bus data. If the driver cannot handle the requested
89 conversion, it will return another supported quantization.
90 The driver indicates that quantization conversion is supported by
91 setting the flag V4L2_SUBDEV_MBUS_CODE_CSC_QUANTIZATION in the
92 corresponding struct :c:type:`v4l2_subdev_mbus_code_enum`
93 during enumeration. See :ref:`v4l2-subdev-mbus-code-flags`.
97 - Transfer function, from enum :c:type:`v4l2_xfer_func`.
98 This information supplements the ``colorspace`` and must be set by
99 the driver for subdevices, see :ref:`colorspaces`. If the application
100 sets the flag ``V4L2_MBUS_FRAMEFMT_SET_CSC`` then the application can set
101 this field on a source pad to request a specific transfer
102 function for the media bus data. If the driver cannot handle the requested
103 conversion, it will return another supported transfer function.
104 The driver indicates that the transfer function conversion is supported by
105 setting the flag V4L2_SUBDEV_MBUS_CODE_CSC_XFER_FUNC in the
106 corresponding struct :c:type:`v4l2_subdev_mbus_code_enum`
107 during enumeration. See :ref:`v4l2-subdev-mbus-code-flags`.
110 - flags See: :ref:v4l2-mbus-framefmt-flags
113 - Reserved for future extensions. Applications and drivers must set
116 .. _v4l2-mbus-framefmt-flags:
118 .. tabularcolumns:: |p{6.5cm}|p{1.6cm}|p{9.2cm}|
120 .. flat-table:: v4l2_mbus_framefmt Flags
125 * .. _`mbus-framefmt-set-csc`:
127 - ``V4L2_MBUS_FRAMEFMT_SET_CSC``
129 - Set by the application. It is only used for source pads and is
130 ignored for sink pads. If set, then request the subdevice to do
131 colorspace conversion from the received colorspace to the requested
132 colorspace values. If the colorimetry field (``colorspace``, ``xfer_func``,
133 ``ycbcr_enc``, ``hsv_enc`` or ``quantization``) is set to ``*_DEFAULT``,
134 then that colorimetry setting will remain unchanged from what was received.
135 So in order to change the quantization, only the ``quantization`` field shall
136 be set to non default value (``V4L2_QUANTIZATION_FULL_RANGE`` or
137 ``V4L2_QUANTIZATION_LIM_RANGE``) and all other colorimetry fields shall
138 be set to ``*_DEFAULT``.
140 To check which conversions are supported by the hardware for the current
141 media bus frame format, see :ref:`v4l2-subdev-mbus-code-flags`.
144 .. _v4l2-mbus-pixelcode:
146 Media Bus Pixel Codes
147 ---------------------
149 The media bus pixel codes describe image formats as flowing over
150 physical buses (both between separate physical components and inside
151 SoC devices). This should not be confused with the V4L2 pixel formats
152 that describe, using four character codes, image formats as stored in
155 While there is a relationship between image formats on buses and image
156 formats in memory (a raw Bayer image won't be magically converted to
157 JPEG just by storing it to memory), there is no one-to-one
158 correspondence between them.
160 The media bus pixel codes document parallel formats. Should the pixel data be
161 transported over a serial bus, the media bus pixel code that describes a
162 parallel format that transfers a sample on a single clock cycle is used. For
163 instance, both MEDIA_BUS_FMT_BGR888_1X24 and MEDIA_BUS_FMT_BGR888_3X8 are used
164 on parallel busses for transferring an 8 bits per sample BGR data, whereas on
165 serial busses the data in this format is only referred to using
166 MEDIA_BUS_FMT_BGR888_1X24. This is because there is effectively only a single
167 way to transport that format on the serial busses.
172 Those formats transfer pixel data as red, green and blue components. The
173 format code is made of the following information.
175 - The red, green and blue components order code, as encoded in a pixel
176 sample. Possible values are RGB and BGR.
178 - The number of bits per component, for each component. The values can
179 be different for all components. Common values are 555 and 565.
181 - The number of bus samples per pixel. Pixels that are wider than the
182 bus width must be transferred in multiple samples. Common values are
187 - For formats where the total number of bits per pixel is smaller than
188 the number of bus samples per pixel times the bus width, a padding
189 value stating if the bytes are padded in their most high order bits
190 (PADHI) or low order bits (PADLO). A "C" prefix is used for
191 component-wise padding in the most high order bits (CPADHI) or low
192 order bits (CPADLO) of each separate component.
194 - For formats where the number of bus samples per pixel is larger than
195 1, an endianness value stating if the pixel is transferred MSB first
196 (BE) or LSB first (LE).
198 For instance, a format where pixels are encoded as 5-bits red, 5-bits
199 green and 5-bit blue values padded on the high bit, transferred as 2
200 8-bit samples per pixel with the most significant bits (padding, red and
201 half of the green value) transferred first will be named
202 ``MEDIA_BUS_FMT_RGB555_2X8_PADHI_BE``.
204 The following tables list existing packed RGB formats.
206 .. HACK: ideally, we would be using adjustbox here. However, Sphinx
207 .. is a very bad behaviored guy: if the table has more than 30 cols,
208 .. it switches to long table, and there's no way to override it.
211 .. tabularcolumns:: |p{5.0cm}|p{0.7cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
213 .. _v4l2-mbus-pixelcode-rgb:
219 \setlength{\tabcolsep}{2pt}
221 .. flat-table:: RGB formats
224 :widths: 36 7 3 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2
229 - :cspan:`31` Data organization
265 * .. _MEDIA-BUS-FMT-RGB444-1X12:
267 - MEDIA_BUS_FMT_RGB444_1X12
302 * .. _MEDIA-BUS-FMT-RGB444-2X8-PADHI-BE:
304 - MEDIA_BUS_FMT_RGB444_2X8_PADHI_BE
374 * .. _MEDIA-BUS-FMT-RGB444-2X8-PADHI-LE:
376 - MEDIA_BUS_FMT_RGB444_2X8_PADHI_LE
446 * .. _MEDIA-BUS-FMT-RGB555-2X8-PADHI-BE:
448 - MEDIA_BUS_FMT_RGB555_2X8_PADHI_BE
518 * .. _MEDIA-BUS-FMT-RGB555-2X8-PADHI-LE:
520 - MEDIA_BUS_FMT_RGB555_2X8_PADHI_LE
590 * .. _MEDIA-BUS-FMT-RGB565-1X16:
592 - MEDIA_BUS_FMT_RGB565_1X16
627 * .. _MEDIA_BUS_FMT_RGB565_1X24_CPADHI:
629 - MEDIA_BUS_FMT_RGB565_1X24_CPADHI
664 * .. _MEDIA-BUS-FMT-BGR565-2X8-BE:
666 - MEDIA_BUS_FMT_BGR565_2X8_BE
736 * .. _MEDIA-BUS-FMT-BGR565-2X8-LE:
738 - MEDIA_BUS_FMT_BGR565_2X8_LE
808 * .. _MEDIA-BUS-FMT-RGB565-2X8-BE:
810 - MEDIA_BUS_FMT_RGB565_2X8_BE
880 * .. _MEDIA-BUS-FMT-RGB565-2X8-LE:
882 - MEDIA_BUS_FMT_RGB565_2X8_LE
952 * .. _MEDIA-BUS-FMT-BGR666-1X18:
954 - MEDIA_BUS_FMT_RGB666_1X18
989 * .. _MEDIA-BUS-FMT-RGB666-1X18:
991 - MEDIA_BUS_FMT_RGB666_1X18
1026 * .. _MEDIA-BUS-FMT-RBG888-1X24:
1028 - MEDIA_BUS_FMT_RBG888_1X24
1063 * .. _MEDIA-BUS-FMT-BGR666-1X24_CPADHI:
1065 - MEDIA_BUS_FMT_BGR666_1X24_CPADHI
1100 * .. _MEDIA-BUS-FMT-RGB666-1X24_CPADHI:
1102 - MEDIA_BUS_FMT_RGB666_1X24_CPADHI
1137 * .. _MEDIA-BUS-FMT-BGR888-1X24:
1139 - MEDIA_BUS_FMT_BGR888_1X24
1174 * .. _MEDIA-BUS-FMT-BGR888-3X8:
1176 - MEDIA_BUS_FMT_BGR888_3X8
1281 * .. _MEDIA-BUS-FMT-GBR888-1X24:
1283 - MEDIA_BUS_FMT_GBR888_1X24
1318 * .. _MEDIA-BUS-FMT-RGB888-1X24:
1320 - MEDIA_BUS_FMT_RGB888_1X24
1355 * .. _MEDIA-BUS-FMT-RGB888-2X12-BE:
1357 - MEDIA_BUS_FMT_RGB888_2X12_BE
1427 * .. _MEDIA-BUS-FMT-RGB888-2X12-LE:
1429 - MEDIA_BUS_FMT_RGB888_2X12_LE
1499 * .. _MEDIA-BUS-FMT-RGB888-3X8:
1501 - MEDIA_BUS_FMT_RGB888_3X8
1606 * .. _MEDIA-BUS-FMT-ARGB888-1X32:
1608 - MEDIA_BUS_FMT_ARGB888_1X32
1643 * .. _MEDIA-BUS-FMT-RGB888-1X32-PADHI:
1645 - MEDIA_BUS_FMT_RGB888_1X32_PADHI
1680 * .. _MEDIA-BUS-FMT-RGB101010-1X30:
1682 - MEDIA_BUS_FMT_RGB101010_1X30
1723 The following table list existing packed 36bit wide RGB formats.
1725 .. tabularcolumns:: |p{4.0cm}|p{0.7cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
1727 .. _v4l2-mbus-pixelcode-rgb-36:
1733 \setlength{\tabcolsep}{2pt}
1735 .. flat-table:: 36bit RGB formats
1738 :widths: 36 7 3 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2
1743 - :cspan:`35` Data organization
1783 * .. _MEDIA-BUS-FMT-RGB121212-1X36:
1785 - MEDIA_BUS_FMT_RGB121212_1X36
1830 The following table list existing packed 48bit wide RGB formats.
1832 .. tabularcolumns:: |p{4.0cm}|p{0.7cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
1834 .. _v4l2-mbus-pixelcode-rgb-48:
1840 \setlength{\tabcolsep}{2pt}
1842 .. flat-table:: 48bit RGB formats
1845 :widths: 36 7 3 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2
1850 - :cspan:`31` Data organization
1921 * .. _MEDIA-BUS-FMT-RGB161616-1X48:
1923 - MEDIA_BUS_FMT_RGB161616_1X48
1998 On LVDS buses, usually each sample is transferred serialized in seven
1999 time slots per pixel clock, on three (18-bit) or four (24-bit)
2000 differential data pairs at the same time. The remaining bits are used
2001 for control signals as defined by SPWG/PSWG/VESA or JEIDA standards. The
2002 24-bit RGB format serialized in seven time slots on four lanes using
2003 JEIDA defined bit mapping will be named
2004 ``MEDIA_BUS_FMT_RGB888_1X7X4_JEIDA``, for example.
2010 .. _v4l2-mbus-pixelcode-rgb-lvds:
2012 .. flat-table:: LVDS RGB formats
2020 - :cspan:`3` Data organization
2029 * .. _MEDIA-BUS-FMT-RGB666-1X7X3-SPWG:
2031 - MEDIA_BUS_FMT_RGB666_1X7X3_SPWG
2087 * .. _MEDIA-BUS-FMT-RGB888-1X7X4-SPWG:
2089 - MEDIA_BUS_FMT_RGB888_1X7X4_SPWG
2145 * .. _MEDIA-BUS-FMT-RGB888-1X7X4-JEIDA:
2147 - MEDIA_BUS_FMT_RGB888_1X7X4_JEIDA
2212 Those formats transfer pixel data as red, green and blue components. The
2213 format code is made of the following information.
2215 - The red, green and blue components order code, as encoded in a pixel
2216 sample. The possible values are shown in :ref:`bayer-patterns`.
2218 - The number of bits per pixel component. All components are
2219 transferred on the same number of bits. Common values are 8, 10 and
2222 - The compression (optional). If the pixel components are ALAW- or
2223 DPCM-compressed, a mention of the compression scheme and the number
2224 of bits per compressed pixel component.
2226 - The number of bus samples per pixel. Pixels that are wider than the
2227 bus width must be transferred in multiple samples. Common values are
2232 - For formats where the total number of bits per pixel is smaller than
2233 the number of bus samples per pixel times the bus width, a padding
2234 value stating if the bytes are padded in their most high order bits
2235 (PADHI) or low order bits (PADLO).
2237 - For formats where the number of bus samples per pixel is larger than
2238 1, an endianness value stating if the pixel is transferred MSB first
2239 (BE) or LSB first (LE).
2241 For instance, a format with uncompressed 10-bit Bayer components
2242 arranged in a red, green, green, blue pattern transferred as 2 8-bit
2243 samples per pixel with the least significant bits transferred first will
2244 be named ``MEDIA_BUS_FMT_SRGGB10_2X8_PADHI_LE``.
2249 .. kernel-figure:: bayer.svg
2253 **Figure 4.8 Bayer Patterns**
2255 The following table lists existing packed Bayer formats. The data
2256 organization is given as an example for the first pixel only.
2259 .. HACK: ideally, we would be using adjustbox here. However, Sphinx
2260 .. is a very bad behaviored guy: if the table has more than 30 cols,
2261 .. it switches to long table, and there's no way to override it.
2268 \setlength{\tabcolsep}{2pt}
2270 .. tabularcolumns:: |p{6.0cm}|p{0.7cm}|p{0.3cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
2272 .. _v4l2-mbus-pixelcode-bayer:
2274 .. cssclass: longtable
2276 .. flat-table:: Bayer Formats
2283 - :cspan:`15` Data organization
2303 * .. _MEDIA-BUS-FMT-SBGGR8-1X8:
2305 - MEDIA_BUS_FMT_SBGGR8_1X8
2324 * .. _MEDIA-BUS-FMT-SGBRG8-1X8:
2326 - MEDIA_BUS_FMT_SGBRG8_1X8
2345 * .. _MEDIA-BUS-FMT-SGRBG8-1X8:
2347 - MEDIA_BUS_FMT_SGRBG8_1X8
2366 * .. _MEDIA-BUS-FMT-SRGGB8-1X8:
2368 - MEDIA_BUS_FMT_SRGGB8_1X8
2387 * .. _MEDIA-BUS-FMT-SBGGR10-ALAW8-1X8:
2389 - MEDIA_BUS_FMT_SBGGR10_ALAW8_1X8
2408 * .. _MEDIA-BUS-FMT-SGBRG10-ALAW8-1X8:
2410 - MEDIA_BUS_FMT_SGBRG10_ALAW8_1X8
2429 * .. _MEDIA-BUS-FMT-SGRBG10-ALAW8-1X8:
2431 - MEDIA_BUS_FMT_SGRBG10_ALAW8_1X8
2450 * .. _MEDIA-BUS-FMT-SRGGB10-ALAW8-1X8:
2452 - MEDIA_BUS_FMT_SRGGB10_ALAW8_1X8
2471 * .. _MEDIA-BUS-FMT-SBGGR10-DPCM8-1X8:
2473 - MEDIA_BUS_FMT_SBGGR10_DPCM8_1X8
2492 * .. _MEDIA-BUS-FMT-SGBRG10-DPCM8-1X8:
2494 - MEDIA_BUS_FMT_SGBRG10_DPCM8_1X8
2513 * .. _MEDIA-BUS-FMT-SGRBG10-DPCM8-1X8:
2515 - MEDIA_BUS_FMT_SGRBG10_DPCM8_1X8
2534 * .. _MEDIA-BUS-FMT-SRGGB10-DPCM8-1X8:
2536 - MEDIA_BUS_FMT_SRGGB10_DPCM8_1X8
2555 * .. _MEDIA-BUS-FMT-SBGGR10-2X8-PADHI-BE:
2557 - MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_BE
2595 * .. _MEDIA-BUS-FMT-SBGGR10-2X8-PADHI-LE:
2597 - MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_LE
2635 * .. _MEDIA-BUS-FMT-SBGGR10-2X8-PADLO-BE:
2637 - MEDIA_BUS_FMT_SBGGR10_2X8_PADLO_BE
2675 * .. _MEDIA-BUS-FMT-SBGGR10-2X8-PADLO-LE:
2677 - MEDIA_BUS_FMT_SBGGR10_2X8_PADLO_LE
2715 * .. _MEDIA-BUS-FMT-SBGGR10-1X10:
2717 - MEDIA_BUS_FMT_SBGGR10_1X10
2736 * .. _MEDIA-BUS-FMT-SGBRG10-1X10:
2738 - MEDIA_BUS_FMT_SGBRG10_1X10
2757 * .. _MEDIA-BUS-FMT-SGRBG10-1X10:
2759 - MEDIA_BUS_FMT_SGRBG10_1X10
2778 * .. _MEDIA-BUS-FMT-SRGGB10-1X10:
2780 - MEDIA_BUS_FMT_SRGGB10_1X10
2799 * .. _MEDIA-BUS-FMT-SBGGR12-1X12:
2801 - MEDIA_BUS_FMT_SBGGR12_1X12
2820 * .. _MEDIA-BUS-FMT-SGBRG12-1X12:
2822 - MEDIA_BUS_FMT_SGBRG12_1X12
2841 * .. _MEDIA-BUS-FMT-SGRBG12-1X12:
2843 - MEDIA_BUS_FMT_SGRBG12_1X12
2862 * .. _MEDIA-BUS-FMT-SRGGB12-1X12:
2864 - MEDIA_BUS_FMT_SRGGB12_1X12
2883 * .. _MEDIA-BUS-FMT-SBGGR14-1X14:
2885 - MEDIA_BUS_FMT_SBGGR14_1X14
2904 * .. _MEDIA-BUS-FMT-SGBRG14-1X14:
2906 - MEDIA_BUS_FMT_SGBRG14_1X14
2925 * .. _MEDIA-BUS-FMT-SGRBG14-1X14:
2927 - MEDIA_BUS_FMT_SGRBG14_1X14
2946 * .. _MEDIA-BUS-FMT-SRGGB14-1X14:
2948 - MEDIA_BUS_FMT_SRGGB14_1X14
2967 * .. _MEDIA-BUS-FMT-SBGGR16-1X16:
2969 - MEDIA_BUS_FMT_SBGGR16_1X16
2988 * .. _MEDIA-BUS-FMT-SGBRG16-1X16:
2990 - MEDIA_BUS_FMT_SGBRG16_1X16
3009 * .. _MEDIA-BUS-FMT-SGRBG16-1X16:
3011 - MEDIA_BUS_FMT_SGRBG16_1X16
3030 * .. _MEDIA-BUS-FMT-SRGGB16-1X16:
3032 - MEDIA_BUS_FMT_SRGGB16_1X16
3060 Those data formats transfer pixel data as (possibly downsampled) Y, U
3061 and V components. Some formats include dummy bits in some of their
3062 samples and are collectively referred to as "YDYC" (Y-Dummy-Y-Chroma)
3063 formats. One cannot rely on the values of these dummy bits as those are
3066 The format code is made of the following information.
3068 - The Y, U and V components order code, as transferred on the bus.
3069 Possible values are YUYV, UYVY, YVYU and VYUY for formats with no
3070 dummy bit, and YDYUYDYV, YDYVYDYU, YUYDYVYD and YVYDYUYD for YDYC
3073 - The number of bits per pixel component. All components are
3074 transferred on the same number of bits. Common values are 8, 10 and
3077 - The number of bus samples per pixel. Pixels that are wider than the
3078 bus width must be transferred in multiple samples. Common values are
3079 0.5 (encoded as 0_5; in this case two pixels are transferred per bus
3080 sample), 1, 1.5 (encoded as 1_5) and 2.
3082 - The bus width. When the bus width is larger than the number of bits
3083 per pixel component, several components are packed in a single bus
3084 sample. The components are ordered as specified by the order code,
3085 with components on the left of the code transferred in the high order
3086 bits. Common values are 8 and 16.
3088 For instance, a format where pixels are encoded as 8-bit YUV values
3089 downsampled to 4:2:2 and transferred as 2 8-bit bus samples per pixel in
3090 the U, Y, V, Y order will be named ``MEDIA_BUS_FMT_UYVY8_2X8``.
3092 :ref:`v4l2-mbus-pixelcode-yuv8` lists existing packed YUV formats and
3093 describes the organization of each pixel data in each sample. When a
3094 format pattern is split across multiple samples each of the samples in
3095 the pattern is described.
3097 The role of each bit transferred over the bus is identified by one of
3098 the following codes.
3100 - y\ :sub:`x` for luma component bit number x
3102 - u\ :sub:`x` for blue chroma component bit number x
3104 - v\ :sub:`x` for red chroma component bit number x
3106 - a\ :sub:`x` for alpha component bit number x
3108 - for non-available bits (for positions higher than the bus width)
3112 .. HACK: ideally, we would be using adjustbox here. However, this
3113 .. will never work for this table, as, even with tiny font, it is
3114 .. to big for a single page. So, we need to manually adjust the
3121 \setlength{\tabcolsep}{2pt}
3123 .. tabularcolumns:: |p{5.0cm}|p{0.7cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
3125 .. _v4l2-mbus-pixelcode-yuv8:
3127 .. flat-table:: YUV Formats
3130 :widths: 36 7 3 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2
3135 - :cspan:`31` Data organization
3171 * .. _MEDIA-BUS-FMT-Y8-1X8:
3173 - MEDIA_BUS_FMT_Y8_1X8
3208 * .. _MEDIA-BUS-FMT-UV8-1X8:
3210 - MEDIA_BUS_FMT_UV8_1X8
3280 * .. _MEDIA-BUS-FMT-UYVY8-1_5X8:
3282 - MEDIA_BUS_FMT_UYVY8_1_5X8
3492 * .. _MEDIA-BUS-FMT-VYUY8-1_5X8:
3494 - MEDIA_BUS_FMT_VYUY8_1_5X8
3704 * .. _MEDIA-BUS-FMT-YUYV8-1_5X8:
3706 - MEDIA_BUS_FMT_YUYV8_1_5X8
3916 * .. _MEDIA-BUS-FMT-YVYU8-1_5X8:
3918 - MEDIA_BUS_FMT_YVYU8_1_5X8
4128 * .. _MEDIA-BUS-FMT-UYVY8-2X8:
4130 - MEDIA_BUS_FMT_UYVY8_2X8
4270 * .. _MEDIA-BUS-FMT-VYUY8-2X8:
4272 - MEDIA_BUS_FMT_VYUY8_2X8
4412 * .. _MEDIA-BUS-FMT-YUYV8-2X8:
4414 - MEDIA_BUS_FMT_YUYV8_2X8
4554 * .. _MEDIA-BUS-FMT-YVYU8-2X8:
4556 - MEDIA_BUS_FMT_YVYU8_2X8
4696 * .. _MEDIA-BUS-FMT-Y10-1X10:
4698 - MEDIA_BUS_FMT_Y10_1X10
4733 * .. _MEDIA-BUS-FMT-Y10-2X8-PADHI_LE:
4735 - MEDIA_BUS_FMT_Y10_2X8_PADHI_LE
4805 * .. _MEDIA-BUS-FMT-UYVY10-2X10:
4807 - MEDIA_BUS_FMT_UYVY10_2X10
4947 * .. _MEDIA-BUS-FMT-VYUY10-2X10:
4949 - MEDIA_BUS_FMT_VYUY10_2X10
5089 * .. _MEDIA-BUS-FMT-YUYV10-2X10:
5091 - MEDIA_BUS_FMT_YUYV10_2X10
5231 * .. _MEDIA-BUS-FMT-YVYU10-2X10:
5233 - MEDIA_BUS_FMT_YVYU10_2X10
5373 * .. _MEDIA-BUS-FMT-Y12-1X12:
5375 - MEDIA_BUS_FMT_Y12_1X12
5410 * .. _MEDIA-BUS-FMT-UYVY12-2X12:
5412 - MEDIA_BUS_FMT_UYVY12_2X12
5552 * .. _MEDIA-BUS-FMT-VYUY12-2X12:
5554 - MEDIA_BUS_FMT_VYUY12_2X12
5694 * .. _MEDIA-BUS-FMT-YUYV12-2X12:
5696 - MEDIA_BUS_FMT_YUYV12_2X12
5836 * .. _MEDIA-BUS-FMT-YVYU12-2X12:
5838 - MEDIA_BUS_FMT_YVYU12_2X12
5978 * .. _MEDIA-BUS-FMT-Y14-1X14:
5980 - MEDIA_BUS_FMT_Y14_1X14
6015 * .. _MEDIA-BUS-FMT-UYVY8-1X16:
6017 - MEDIA_BUS_FMT_UYVY8_1X16
6087 * .. _MEDIA-BUS-FMT-VYUY8-1X16:
6089 - MEDIA_BUS_FMT_VYUY8_1X16
6159 * .. _MEDIA-BUS-FMT-YUYV8-1X16:
6161 - MEDIA_BUS_FMT_YUYV8_1X16
6231 * .. _MEDIA-BUS-FMT-YVYU8-1X16:
6233 - MEDIA_BUS_FMT_YVYU8_1X16
6303 * .. _MEDIA-BUS-FMT-YDYUYDYV8-1X16:
6305 - MEDIA_BUS_FMT_YDYUYDYV8_1X16
6445 * .. _MEDIA-BUS-FMT-UYVY10-1X20:
6447 - MEDIA_BUS_FMT_UYVY10_1X20
6517 * .. _MEDIA-BUS-FMT-VYUY10-1X20:
6519 - MEDIA_BUS_FMT_VYUY10_1X20
6589 * .. _MEDIA-BUS-FMT-YUYV10-1X20:
6591 - MEDIA_BUS_FMT_YUYV10_1X20
6661 * .. _MEDIA-BUS-FMT-YVYU10-1X20:
6663 - MEDIA_BUS_FMT_YVYU10_1X20
6733 * .. _MEDIA-BUS-FMT-VUY8-1X24:
6735 - MEDIA_BUS_FMT_VUY8_1X24
6770 * .. _MEDIA-BUS-FMT-YUV8-1X24:
6772 - MEDIA_BUS_FMT_YUV8_1X24
6807 * .. _MEDIA-BUS-FMT-UYYVYY8-0-5X24:
6809 - MEDIA_BUS_FMT_UYYVYY8_0_5X24
6879 * .. _MEDIA-BUS-FMT-UYVY12-1X24:
6881 - MEDIA_BUS_FMT_UYVY12_1X24
6951 * .. _MEDIA-BUS-FMT-VYUY12-1X24:
6953 - MEDIA_BUS_FMT_VYUY12_1X24
7023 * .. _MEDIA-BUS-FMT-YUYV12-1X24:
7025 - MEDIA_BUS_FMT_YUYV12_1X24
7095 * .. _MEDIA-BUS-FMT-YVYU12-1X24:
7097 - MEDIA_BUS_FMT_YVYU12_1X24
7167 * .. _MEDIA-BUS-FMT-YUV10-1X30:
7169 - MEDIA_BUS_FMT_YUV10_1X30
7204 * .. _MEDIA-BUS-FMT-UYYVYY10-0-5X30:
7206 - MEDIA_BUS_FMT_UYYVYY10_0_5X30
7276 * .. _MEDIA-BUS-FMT-AYUV8-1X32:
7278 - MEDIA_BUS_FMT_AYUV8_1X32
7320 The following table list existing packed 36bit wide YUV formats.
7326 \setlength{\tabcolsep}{2pt}
7328 .. tabularcolumns:: |p{4.1cm}|p{0.7cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
7330 .. _v4l2-mbus-pixelcode-yuv8-36bit:
7332 .. flat-table:: 36bit YUV Formats
7335 :widths: 36 7 3 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2
7340 - :cspan:`35` Data organization
7380 * .. _MEDIA-BUS-FMT-UYYVYY12-0-5X36:
7382 - MEDIA_BUS_FMT_UYYVYY12_0_5X36
7460 * .. _MEDIA-BUS-FMT-YUV12-1X36:
7462 - MEDIA_BUS_FMT_YUV12_1X36
7508 The following table list existing packed 48bit wide YUV formats.
7514 \setlength{\tabcolsep}{2pt}
7516 .. tabularcolumns:: |p{5.6cm}|p{0.7cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
7518 .. _v4l2-mbus-pixelcode-yuv8-48bit:
7520 .. flat-table:: 48bit YUV Formats
7523 :widths: 36 7 3 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2
7528 - :cspan:`31` Data organization
7599 * .. _MEDIA-BUS-FMT-YUV16-1X48:
7601 - MEDIA_BUS_FMT_YUV16_1X48
7671 * .. _MEDIA-BUS-FMT-UYYVYY16-0-5X48:
7673 - MEDIA_BUS_FMT_UYYVYY16_0_5X48
7822 Those formats transfer pixel data as RGB values in a
7823 cylindrical-coordinate system using Hue-Saturation-Value or
7824 Hue-Saturation-Lightness components. The format code is made of the
7825 following information.
7827 - The hue, saturation, value or lightness and optional alpha components
7828 order code, as encoded in a pixel sample. The only currently
7829 supported value is AHSV.
7831 - The number of bits per component, for each component. The values can
7832 be different for all components. The only currently supported value
7835 - The number of bus samples per pixel. Pixels that are wider than the
7836 bus width must be transferred in multiple samples. The only currently
7837 supported value is 1.
7841 - For formats where the total number of bits per pixel is smaller than
7842 the number of bus samples per pixel times the bus width, a padding
7843 value stating if the bytes are padded in their most high order bits
7844 (PADHI) or low order bits (PADLO).
7846 - For formats where the number of bus samples per pixel is larger than
7847 1, an endianness value stating if the pixel is transferred MSB first
7848 (BE) or LSB first (LE).
7850 The following table lists existing HSV/HSL formats.
7857 \setlength{\tabcolsep}{2pt}
7859 .. tabularcolumns:: |p{3.9cm}|p{0.73cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|p{0.22cm}|
7861 .. _v4l2-mbus-pixelcode-hsv:
7863 .. flat-table:: HSV/HSL formats
7866 :widths: 28 7 3 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2
7871 - :cspan:`31` Data organization
7907 * .. _MEDIA-BUS-FMT-AHSV8888-1X32:
7909 - MEDIA_BUS_FMT_AHSV8888_1X32
7950 JPEG Compressed Formats
7951 ^^^^^^^^^^^^^^^^^^^^^^^
7953 Those data formats consist of an ordered sequence of 8-bit bytes
7954 obtained from JPEG compression process. Additionally to the ``_JPEG``
7955 postfix the format code is made of the following information.
7957 - The number of bus samples per entropy encoded byte.
7961 For instance, for a JPEG baseline process and an 8-bit bus width the
7962 format will be named ``MEDIA_BUS_FMT_JPEG_1X8``.
7964 The following table lists existing JPEG compressed formats.
7967 .. _v4l2-mbus-pixelcode-jpeg:
7969 .. tabularcolumns:: |p{6.0cm}|p{1.4cm}|p{9.9cm}|
7971 .. flat-table:: JPEG Formats
7978 * .. _MEDIA-BUS-FMT-JPEG-1X8:
7980 - MEDIA_BUS_FMT_JPEG_1X8
7982 - Besides of its usage for the parallel bus this format is
7983 recommended for transmission of JPEG data over MIPI CSI bus using
7984 the User Defined 8-bit Data types.
7988 .. _v4l2-mbus-vendor-spec-fmts:
7990 Vendor and Device Specific Formats
7991 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7993 This section lists complex data formats that are either vendor or device
7996 The following table lists the existing vendor and device specific
8000 .. _v4l2-mbus-pixelcode-vendor-specific:
8002 .. tabularcolumns:: |p{8.0cm}|p{1.4cm}|p{7.9cm}|
8004 .. flat-table:: Vendor and device specific formats
8011 * .. _MEDIA-BUS-FMT-S5C-UYVY-JPEG-1X8:
8013 - MEDIA_BUS_FMT_S5C_UYVY_JPEG_1X8
8015 - Interleaved raw UYVY and JPEG image format with embedded meta-data
8016 used by Samsung S3C73MX camera sensors.
8018 .. _v4l2-mbus-metadata-fmts:
8023 This section lists all metadata formats.
8025 The following table lists the existing metadata formats.
8027 .. tabularcolumns:: |p{8.0cm}|p{1.4cm}|p{7.9cm}|
8029 .. flat-table:: Metadata formats
8036 * .. _MEDIA-BUS-FMT-METADATA-FIXED:
8038 - MEDIA_BUS_FMT_METADATA_FIXED
8040 - This format should be used when the same driver handles
8041 both sides of the link and the bus format is a fixed
8042 metadata format that is not configurable from userspace.
8043 Width and height will be set to 0 for this format.
8046 .. _v4l2-mbus-sensor-data:
8048 Sensor Ancillary Metadata Formats
8049 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8051 This section lists ancillary data generated by a camera sensor and
8052 transmitted over a stream on the camera bus.
8054 The following table lists the existing sensor ancillary metadata formats:
8057 .. _v4l2-mbus-pixelcode-sensor-metadata:
8059 .. tabularcolumns:: |p{8.0cm}|p{1.4cm}|p{7.7cm}|
8061 .. flat-table:: Sensor ancillary metadata formats
8068 * .. _MEDIA_BUS_FMT_SENSOR_DATA:
8070 - MEDIA_BUS_FMT_SENSOR_DATA
8072 - Sensor vendor specific ancillary metadata. Some vendors follow a generic
8073 CSI-2/SMIA embedded data format as described in the `CSI-2 specification.
8074 <https://mipi.org/specifications/csi-2>`_
projects / platform / kernel / linux-rpi.git / blob