diff options
author | 2016-07-27 06:32:31 -0300 | |
---|---|---|
committer | 2016-07-28 20:08:19 -0300 | |
commit | 43f71d93a0cb342f0c918fba3f6abb7661e40ad2 (patch) | |
tree | a1dc7288bc480e7027ca1827ca4876472fa12e40 /Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml | |
parent | Merge tag 'media/v4.8-4' of git://git.kernel.org/pub/scm/linux/kernel/git/mch... (diff) | |
download | linux-43f71d93a0cb342f0c918fba3f6abb7661e40ad2.tar.gz linux-43f71d93a0cb342f0c918fba3f6abb7661e40ad2.tar.bz2 linux-43f71d93a0cb342f0c918fba3f6abb7661e40ad2.zip |
doc-rst: Remove the media docbook
Now that all media documentation was converted to Sphinx, we
should get rid of the old DocBook one, as we don't want people
to submit patches against the old stuff.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml')
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml | 118 |
1 files changed, 0 insertions, 118 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml b/Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml deleted file mode 100644 index c67256ada87a..000000000000 --- a/Documentation/DocBook/media/v4l/vidioc-subdev-enum-mbus-code.xml +++ /dev/null @@ -1,118 +0,0 @@ -<refentry id="vidioc-subdev-enum-mbus-code"> - <refmeta> - <refentrytitle>ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE</refentrytitle> - &manvol; - </refmeta> - - <refnamediv> - <refname>VIDIOC_SUBDEV_ENUM_MBUS_CODE</refname> - <refpurpose>Enumerate media bus formats</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <funcsynopsis> - <funcprototype> - <funcdef>int <function>ioctl</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - <paramdef>int <parameter>request</parameter></paramdef> - <paramdef>struct v4l2_subdev_mbus_code_enum * - <parameter>argp</parameter></paramdef> - </funcprototype> - </funcsynopsis> - </refsynopsisdiv> - - <refsect1> - <title>Arguments</title> - - <variablelist> - <varlistentry> - <term><parameter>fd</parameter></term> - <listitem> - <para>&fd;</para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>request</parameter></term> - <listitem> - <para>VIDIOC_SUBDEV_ENUM_MBUS_CODE</para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>argp</parameter></term> - <listitem> - <para></para> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1> - <title>Description</title> - - <para>To enumerate media bus formats available at a given sub-device pad - applications initialize the <structfield>pad</structfield>, <structfield>which</structfield> - and <structfield>index</structfield> fields of &v4l2-subdev-mbus-code-enum; and - call the <constant>VIDIOC_SUBDEV_ENUM_MBUS_CODE</constant> ioctl with a - pointer to this structure. Drivers fill the rest of the structure or return - an &EINVAL; if either the <structfield>pad</structfield> or - <structfield>index</structfield> are invalid. All media bus formats are - enumerable by beginning at index zero and incrementing by one until - <errorcode>EINVAL</errorcode> is returned.</para> - - <para>Available media bus formats may depend on the current 'try' formats - at other pads of the sub-device, as well as on the current active links. See - &VIDIOC-SUBDEV-G-FMT; for more information about the try formats.</para> - - <table pgwide="1" frame="none" id="v4l2-subdev-mbus-code-enum"> - <title>struct <structname>v4l2_subdev_mbus_code_enum</structname></title> - <tgroup cols="3"> - &cs-str; - <tbody valign="top"> - <row> - <entry>__u32</entry> - <entry><structfield>pad</structfield></entry> - <entry>Pad number as reported by the media controller API.</entry> - </row> - <row> - <entry>__u32</entry> - <entry><structfield>index</structfield></entry> - <entry>Number of the format in the enumeration, set by the - application.</entry> - </row> - <row> - <entry>__u32</entry> - <entry><structfield>code</structfield></entry> - <entry>The media bus format code, as defined in - <xref linkend="v4l2-mbus-format" />.</entry> - </row> - <row> - <entry>__u32</entry> - <entry><structfield>which</structfield></entry> - <entry>Media bus format codes to be enumerated, from &v4l2-subdev-format-whence;.</entry> - </row> - <row> - <entry>__u32</entry> - <entry><structfield>reserved</structfield>[8]</entry> - <entry>Reserved for future extensions. Applications and drivers must - set the array to zero.</entry> - </row> - </tbody> - </tgroup> - </table> - </refsect1> - - <refsect1> - &return-value; - - <variablelist> - <varlistentry> - <term><errorcode>EINVAL</errorcode></term> - <listitem> - <para>The &v4l2-subdev-mbus-code-enum; <structfield>pad</structfield> - references a non-existing pad, or the <structfield>index</structfield> - field is out of bounds.</para> - </listitem> - </varlistentry> - </variablelist> - </refsect1> -</refentry> |