summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorAntti Palosaari <crope@iki.fi>2014-01-30 23:44:59 -0300
committerMauro Carvalho Chehab <m.chehab@samsung.com>2014-05-30 12:04:00 -0300
commite1175292170f1ecdc88fa6c43d2b4bbac439a8c7 (patch)
treeeb4769a62f98629e10fdf7682b4bd9fea15c5bd9 /Documentation
parent53c7714f0ad832aca19da04da578ed0b3dbe2eee (diff)
downloadlinux-3.10-e1175292170f1ecdc88fa6c43d2b4bbac439a8c7.tar.gz
linux-3.10-e1175292170f1ecdc88fa6c43d2b4bbac439a8c7.tar.bz2
linux-3.10-e1175292170f1ecdc88fa6c43d2b4bbac439a8c7.zip
upstream: [media] DocBook: V4L: add V4L2_SDR_FMT_CU8 - 'CU08'
Document V4L2_SDR_FMT_CU8 SDR format. It is complex unsigned 8-bit IQ sample. Used by software defined radio devices. Cc: Hans Verkuil <hverkuil@xs4all.nl> Signed-off-by: Antti Palosaari <crope@iki.fi> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/media/v4l/pixfmt-sdr-cu08.xml44
-rw-r--r--Documentation/DocBook/media/v4l/pixfmt.xml2
2 files changed, 46 insertions, 0 deletions
diff --git a/Documentation/DocBook/media/v4l/pixfmt-sdr-cu08.xml b/Documentation/DocBook/media/v4l/pixfmt-sdr-cu08.xml
new file mode 100644
index 00000000000..2d80104c178
--- /dev/null
+++ b/Documentation/DocBook/media/v4l/pixfmt-sdr-cu08.xml
@@ -0,0 +1,44 @@
+<refentry id="V4L2-SDR-FMT-CU08">
+ <refmeta>
+ <refentrytitle>V4L2_SDR_FMT_CU8 ('CU08')</refentrytitle>
+ &manvol;
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <constant>V4L2_SDR_FMT_CU8</constant>
+ </refname>
+ <refpurpose>Complex unsigned 8-bit IQ sample</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <para>
+This format contains sequence of complex number samples. Each complex number
+consist two parts, called In-phase and Quadrature (IQ). Both I and Q are
+represented as a 8 bit unsigned number. I value comes first and Q value after
+that.
+ </para>
+ <example>
+ <title><constant>V4L2_SDR_FMT_CU8</constant> 1 sample</title>
+ <formalpara>
+ <title>Byte Order.</title>
+ <para>Each cell is one byte.
+ <informaltable frame="none">
+ <tgroup cols="2" align="center">
+ <colspec align="left" colwidth="2*" />
+ <tbody valign="top">
+ <row>
+ <entry>start&nbsp;+&nbsp;0:</entry>
+ <entry>I'<subscript>0</subscript></entry>
+ </row>
+ <row>
+ <entry>start&nbsp;+&nbsp;1:</entry>
+ <entry>Q'<subscript>0</subscript></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </formalpara>
+ </example>
+ </refsect1>
+</refentry>
diff --git a/Documentation/DocBook/media/v4l/pixfmt.xml b/Documentation/DocBook/media/v4l/pixfmt.xml
index 2f371dd3b1b..acd7f431f4b 100644
--- a/Documentation/DocBook/media/v4l/pixfmt.xml
+++ b/Documentation/DocBook/media/v4l/pixfmt.xml
@@ -826,6 +826,8 @@ extended control <constant>V4L2_CID_MPEG_STREAM_TYPE</constant>, see
<para>These formats are used for <link linkend="sdr">SDR Capture</link>
interface only.</para>
+ &sub-sdr-cu08;
+
</section>
<section id="pixfmt-reserved">