Merge tag 'mips_5.2_2' of git://git.kernel.org/pub/scm/linux/kernel/git/mips/linux
[sfrench/cifs-2.6.git] / Documentation / media / uapi / v4l / pixfmt-srggb14p.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-SRGGB14P:
11 .. _v4l2-pix-fmt-sbggr14p:
12 .. _v4l2-pix-fmt-sgbrg14p:
13 .. _v4l2-pix-fmt-sgrbg14p:
14
15 *******************************************************************************************************************************
16 V4L2_PIX_FMT_SRGGB14P ('pRCC'), V4L2_PIX_FMT_SGRBG14P ('pgCC'), V4L2_PIX_FMT_SGBRG14P ('pGCC'), V4L2_PIX_FMT_SBGGR14P ('pBCC'),
17 *******************************************************************************************************************************
18
19 *man V4L2_PIX_FMT_SRGGB14P(2)*
20
21 V4L2_PIX_FMT_SGRBG14P
22 V4L2_PIX_FMT_SGBRG14P
23 V4L2_PIX_FMT_SBGGR14P
24 14-bit packed Bayer formats
25
26
27 Description
28 ===========
29
30 These four pixel formats are packed raw sRGB / Bayer formats with 14
31 bits per colour. Every four consecutive samples are packed into seven
32 bytes. Each of the first four bytes contain the eight high order bits
33 of the pixels, and the three following bytes contains the six least
34 significants bits of each pixel, in the same order.
35
36 Each n-pixel row contains n/2 green samples and n/2 blue or red samples,
37 with alternating green-red and green-blue rows. They are conventionally
38 described as GRGR... BGBG..., RGRG... GBGB..., etc. Below is an example
39 of one of these formats:
40
41 **Byte Order.**
42 Each cell is one byte.
43
44 .. raw:: latex
45
46     \footnotesize
47
48 .. tabularcolumns:: |p{1.8cm}|p{1.0cm}|p{1.0cm}|p{1.0cm}|p{1.1cm}|p{3.3cm}|p{3.3cm}|p{3.3cm}|
49
50 .. flat-table::
51     :header-rows:  0
52     :stub-columns: 0
53     :widths:       2 1 1 1 1 3 3 3
54
55
56     -  .. row 1
57
58        -  start + 0
59
60        -  B\ :sub:`00high`
61
62        -  G\ :sub:`01high`
63
64        -  B\ :sub:`02high`
65
66        -  G\ :sub:`03high`
67
68        -  G\ :sub:`01low bits 1--0`\ (bits 7--6)
69
70           B\ :sub:`00low bits 5--0`\ (bits 5--0)
71
72        -  R\ :sub:`02low bits 3--0`\ (bits 7--4)
73
74           G\ :sub:`01low bits 5--2`\ (bits 3--0)
75
76        -  G\ :sub:`03low bits 5--0`\ (bits 7--2)
77
78           R\ :sub:`02low bits 5--4`\ (bits 1--0)
79
80     -  .. row 2
81
82        -  start + 7
83
84        -  G\ :sub:`00high`
85
86        -  R\ :sub:`01high`
87
88        -  G\ :sub:`02high`
89
90        -  R\ :sub:`03high`
91
92        -  R\ :sub:`01low bits 1--0`\ (bits 7--6)
93
94           G\ :sub:`00low bits 5--0`\ (bits 5--0)
95
96        -  G\ :sub:`02low bits 3--0`\ (bits 7--4)
97
98           R\ :sub:`01low bits 5--2`\ (bits 3--0)
99
100        -  R\ :sub:`03low bits 5--0`\ (bits 7--2)
101
102           G\ :sub:`02low bits 5--4`\ (bits 1--0)
103
104     -  .. row 3
105
106        -  start + 14
107
108        -  B\ :sub:`20high`
109
110        -  G\ :sub:`21high`
111
112        -  B\ :sub:`22high`
113
114        -  G\ :sub:`23high`
115
116        -  G\ :sub:`21low bits 1--0`\ (bits 7--6)
117
118           B\ :sub:`20low bits 5--0`\ (bits 5--0)
119
120        -  R\ :sub:`22low bits 3--0`\ (bits 7--4)
121
122           G\ :sub:`21low bits 5--2`\ (bits 3--0)
123
124        -  G\ :sub:`23low bits 5--0`\ (bits 7--2)
125
126           R\ :sub:`22low bits 5--4`\ (bits 1--0)
127
128     -  .. row 4
129
130        -  start + 21
131
132        -  G\ :sub:`30high`
133
134        -  R\ :sub:`31high`
135
136        -  G\ :sub:`32high`
137
138        -  R\ :sub:`33high`
139
140        -  R\ :sub:`31low bits 1--0`\ (bits 7--6)
141           G\ :sub:`30low bits 5--0`\ (bits 5--0)
142
143        -  G\ :sub:`32low bits 3--0`\ (bits 7--4)
144           R\ :sub:`31low bits 5--2`\ (bits 3--0)
145
146        -  R\ :sub:`33low bits 5--0`\ (bits 7--2)
147           G\ :sub:`32low bits 5--4`\ (bits 1--0)
148
149 .. raw:: latex
150
151     \normalsize
152