diff options
| author | Antti Palosaari <crope@iki.fi> | 2014-07-11 16:04:42 -0400 |
|---|---|---|
| committer | Mauro Carvalho Chehab <m.chehab@samsung.com> | 2014-07-21 19:28:02 -0400 |
| commit | 565092c6cde439f2cd377673e75ea91facd1ec88 (patch) | |
| tree | f8681fb7bd100bd9ce62c5cb40fab9ebf6bb6b08 /Documentation/DocBook | |
| parent | 5c5be570043f864b8373ed26fd68698fe352a0ef (diff) | |
[media] DocBook: V4L: add V4L2_SDR_FMT_CS14LE - 'CS14'
V4L2_SDR_FMT_CS14LE is complex signed 14-bit sample format, used
for software defined radio devices.
[m.chehab@samsung.com: remove V4L2_FL_USE_FH_PRIO setting to avoid
compilation breakage, as this flag doesn't exist anymore]
Signed-off-by: Antti Palosaari <crope@iki.fi>
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
Diffstat (limited to 'Documentation/DocBook')
| -rw-r--r-- | Documentation/DocBook/media/v4l/pixfmt-sdr-cs14le.xml | 47 | ||||
| -rw-r--r-- | Documentation/DocBook/media/v4l/pixfmt.xml | 1 |
2 files changed, 48 insertions, 0 deletions
diff --git a/Documentation/DocBook/media/v4l/pixfmt-sdr-cs14le.xml b/Documentation/DocBook/media/v4l/pixfmt-sdr-cs14le.xml new file mode 100644 index 000000000000..e4b494ce1369 --- /dev/null +++ b/Documentation/DocBook/media/v4l/pixfmt-sdr-cs14le.xml | |||
| @@ -0,0 +1,47 @@ | |||
| 1 | <refentry id="V4L2-SDR-FMT-CS14LE"> | ||
| 2 | <refmeta> | ||
| 3 | <refentrytitle>V4L2_SDR_FMT_CS14LE ('CS14')</refentrytitle> | ||
| 4 | &manvol; | ||
| 5 | </refmeta> | ||
| 6 | <refnamediv> | ||
| 7 | <refname> | ||
| 8 | <constant>V4L2_SDR_FMT_CS14LE</constant> | ||
| 9 | </refname> | ||
| 10 | <refpurpose>Complex signed 14-bit little endian IQ sample</refpurpose> | ||
| 11 | </refnamediv> | ||
| 12 | <refsect1> | ||
| 13 | <title>Description</title> | ||
| 14 | <para> | ||
| 15 | This format contains sequence of complex number samples. Each complex number | ||
| 16 | consist two parts, called In-phase and Quadrature (IQ). Both I and Q are | ||
| 17 | represented as a 14 bit signed little endian number. I value comes first | ||
| 18 | and Q value after that. 14 bit value is stored in 16 bit space with unused | ||
| 19 | high bits padded with 0. | ||
| 20 | </para> | ||
| 21 | <example> | ||
| 22 | <title><constant>V4L2_SDR_FMT_CS14LE</constant> 1 sample</title> | ||
| 23 | <formalpara> | ||
| 24 | <title>Byte Order.</title> | ||
| 25 | <para>Each cell is one byte. | ||
| 26 | <informaltable frame="none"> | ||
| 27 | <tgroup cols="3" align="center"> | ||
| 28 | <colspec align="left" colwidth="2*" /> | ||
| 29 | <tbody valign="top"> | ||
| 30 | <row> | ||
| 31 | <entry>start + 0:</entry> | ||
| 32 | <entry>I'<subscript>0[7:0]</subscript></entry> | ||
| 33 | <entry>I'<subscript>0[13:8]</subscript></entry> | ||
| 34 | </row> | ||
| 35 | <row> | ||
| 36 | <entry>start + 2:</entry> | ||
| 37 | <entry>Q'<subscript>0[7:0]</subscript></entry> | ||
| 38 | <entry>Q'<subscript>0[13:8]</subscript></entry> | ||
| 39 | </row> | ||
| 40 | </tbody> | ||
| 41 | </tgroup> | ||
| 42 | </informaltable> | ||
| 43 | </para> | ||
| 44 | </formalpara> | ||
| 45 | </example> | ||
| 46 | </refsect1> | ||
| 47 | </refentry> | ||
diff --git a/Documentation/DocBook/media/v4l/pixfmt.xml b/Documentation/DocBook/media/v4l/pixfmt.xml index 0cd0c7abde6f..df5b23d46552 100644 --- a/Documentation/DocBook/media/v4l/pixfmt.xml +++ b/Documentation/DocBook/media/v4l/pixfmt.xml | |||
| @@ -860,6 +860,7 @@ interface only.</para> | |||
| 860 | &sub-sdr-cu08; | 860 | &sub-sdr-cu08; |
| 861 | &sub-sdr-cu16le; | 861 | &sub-sdr-cu16le; |
| 862 | &sub-sdr-cs08; | 862 | &sub-sdr-cs08; |
| 863 | &sub-sdr-cs14le; | ||
| 863 | &sub-sdr-ru12le; | 864 | &sub-sdr-ru12le; |
| 864 | 865 | ||
| 865 | </section> | 866 | </section> |
