media: Add a pixel format for MIPI packed 12bit luma only.
[platform/kernel/linux-rpi.git] / Documentation / userspace-api / media / v4l / pixfmt-y12p.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 .. _V4L2-PIX-FMT-Y12P:
11
12 ******************************
13 V4L2_PIX_FMT_Y12P ('Y12P')
14 ******************************
15
16 Grey-scale image as a MIPI RAW12 packed array
17
18
19 Description
20 ===========
21
22 This is a packed grey-scale image format with a depth of 12 bits per
23 pixel. Two consecutive pixels are packed into 3 bytes. The first 2 bytes
24 contain the 8 high order bits of the pixels, and the 3rd byte contains the 4
25 least significants bits of each pixel, in the same order.
26
27 **Byte Order.**
28 Each cell is one byte.
29
30 .. tabularcolumns:: |p{2.2cm}|p{1.2cm}|p{1.2cm}|p{3.1cm}|
31
32
33 .. flat-table::
34     :header-rows:  0
35     :stub-columns: 0
36     :widths:       2 1 1 1
37
38
39     -  -  start + 0:
40        -  Y'\ :sub:`00high`
41        -  Y'\ :sub:`01high`
42        -  Y'\ :sub:`01low`\ (bits 7--4)
43
44           Y'\ :sub:`00low`\ (bits 3--0)
45