Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-btrfs-devel.git] / Documentation / DocBook / media / v4l / pixfmt-srggb10.xml
blob7b274092e60c2a421e3b3a30322d5fef28e18130
1     <refentry>
2       <refmeta>
3         <refentrytitle>V4L2_PIX_FMT_SRGGB10 ('RG10'),
4          V4L2_PIX_FMT_SGRBG10 ('BA10'),
5          V4L2_PIX_FMT_SGBRG10 ('GB10'),
6          V4L2_PIX_FMT_SBGGR10 ('BG10'),
7          </refentrytitle>
8         &manvol;
9       </refmeta>
10       <refnamediv>
11         <refname id="V4L2-PIX-FMT-SRGGB10"><constant>V4L2_PIX_FMT_SRGGB10</constant></refname>
12         <refname id="V4L2-PIX-FMT-SGRBG10"><constant>V4L2_PIX_FMT_SGRBG10</constant></refname>
13         <refname id="V4L2-PIX-FMT-SGBRG10"><constant>V4L2_PIX_FMT_SGBRG10</constant></refname>
14         <refname id="V4L2-PIX-FMT-SBGGR10"><constant>V4L2_PIX_FMT_SBGGR10</constant></refname>
15         <refpurpose>10-bit Bayer formats expanded to 16 bits</refpurpose>
16       </refnamediv>
17       <refsect1>
18         <title>Description</title>
20         <para>The following four pixel formats are raw sRGB / Bayer formats with
21 10 bits per colour. Each colour component is stored in a 16-bit word, with 6
22 unused high bits filled with zeros. Each n-pixel row contains n/2 green samples
23 and n/2 blue or red samples, with alternating red and blue rows. Bytes are
24 stored in memory in little endian order. They are conventionally described
25 as GRGR... BGBG..., RGRG... GBGB..., etc. Below is an example of one of these
26 formats</para>
28     <example>
29       <title><constant>V4L2_PIX_FMT_SBGGR10</constant> 4 &times; 4
30 pixel image</title>
32       <formalpara>
33         <title>Byte Order.</title>
34         <para>Each cell is one byte, high 6 bits in high bytes are 0.
35           <informaltable frame="none">
36             <tgroup cols="5" align="center">
37               <colspec align="left" colwidth="2*" />
38               <tbody valign="top">
39                 <row>
40                   <entry>start&nbsp;+&nbsp;0:</entry>
41                   <entry>B<subscript>00low</subscript></entry>
42                   <entry>B<subscript>00high</subscript></entry>
43                   <entry>G<subscript>01low</subscript></entry>
44                   <entry>G<subscript>01high</subscript></entry>
45                   <entry>B<subscript>02low</subscript></entry>
46                   <entry>B<subscript>02high</subscript></entry>
47                   <entry>G<subscript>03low</subscript></entry>
48                   <entry>G<subscript>03high</subscript></entry>
49                 </row>
50                 <row>
51                   <entry>start&nbsp;+&nbsp;8:</entry>
52                   <entry>G<subscript>10low</subscript></entry>
53                   <entry>G<subscript>10high</subscript></entry>
54                   <entry>R<subscript>11low</subscript></entry>
55                   <entry>R<subscript>11high</subscript></entry>
56                   <entry>G<subscript>12low</subscript></entry>
57                   <entry>G<subscript>12high</subscript></entry>
58                   <entry>R<subscript>13low</subscript></entry>
59                   <entry>R<subscript>13high</subscript></entry>
60                 </row>
61                 <row>
62                   <entry>start&nbsp;+&nbsp;16:</entry>
63                   <entry>B<subscript>20low</subscript></entry>
64                   <entry>B<subscript>20high</subscript></entry>
65                   <entry>G<subscript>21low</subscript></entry>
66                   <entry>G<subscript>21high</subscript></entry>
67                   <entry>B<subscript>22low</subscript></entry>
68                   <entry>B<subscript>22high</subscript></entry>
69                   <entry>G<subscript>23low</subscript></entry>
70                   <entry>G<subscript>23high</subscript></entry>
71                 </row>
72                 <row>
73                   <entry>start&nbsp;+&nbsp;24:</entry>
74                   <entry>G<subscript>30low</subscript></entry>
75                   <entry>G<subscript>30high</subscript></entry>
76                   <entry>R<subscript>31low</subscript></entry>
77                   <entry>R<subscript>31high</subscript></entry>
78                   <entry>G<subscript>32low</subscript></entry>
79                   <entry>G<subscript>32high</subscript></entry>
80                   <entry>R<subscript>33low</subscript></entry>
81                   <entry>R<subscript>33high</subscript></entry>
82                 </row>
83               </tbody>
84             </tgroup>
85           </informaltable>
86         </para>
87       </formalpara>
88     </example>
89   </refsect1>
90 </refentry>