aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorSakari Ailus <sakari.ailus@iki.fi>2012-05-02 08:40:03 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2012-07-05 17:00:32 -0400
commit2b719d7baf490e24ce7d817c6337b7c87fda84c1 (patch)
tree72059aea0fc81e45fdc0eb9b7c41e81a5ad31c36 /Documentation/DocBook
parent5cf73ce15f704876378733794864336fbec6c97e (diff)
[media] v4l: drop v4l2_buffer.input and V4L2_BUF_FLAG_INPUT
Remove input field in struct v4l2_buffer and flag V4L2_BUF_FLAG_INPUT which tells the former is valid. The flag is used by no driver currently. Also change the documentation accordingly. Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi> Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/v4l/compat.xml12
-rw-r--r--Documentation/DocBook/media/v4l/io.xml19
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-qbuf.xml9
3 files changed, 20 insertions, 20 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml
index ea42ef82494..a8b37493040 100644
--- a/Documentation/DocBook/media/v4l/compat.xml
+++ b/Documentation/DocBook/media/v4l/compat.xml
@@ -2458,6 +2458,18 @@ details.</para>
2458 </orderedlist> 2458 </orderedlist>
2459 </section> 2459 </section>
2460 2460
2461 <section>
2462 <title>V4L2 in Linux 3.5</title>
2463 <orderedlist>
2464 <listitem>
2465 <para>Replaced <structfield>input</structfield> in
2466 <structname>v4l2_buffer</structname> by
2467 <structfield>reserved2</structfield> and removed
2468 <constant>V4L2_BUF_FLAG_INPUT</constant>.</para>
2469 </listitem>
2470 </orderedlist>
2471 </section>
2472
2461 <section id="other"> 2473 <section id="other">
2462 <title>Relation of V4L2 to other Linux multimedia APIs</title> 2474 <title>Relation of V4L2 to other Linux multimedia APIs</title>
2463 2475
diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml
index fd6aca2922b..1885cc0755c 100644
--- a/Documentation/DocBook/media/v4l/io.xml
+++ b/Documentation/DocBook/media/v4l/io.xml
@@ -683,14 +683,12 @@ memory, set by the application. See <xref linkend="userp" /> for details.
683 </row> 683 </row>
684 <row> 684 <row>
685 <entry>__u32</entry> 685 <entry>__u32</entry>
686 <entry><structfield>input</structfield></entry> 686 <entry><structfield>reserved2</structfield></entry>
687 <entry></entry> 687 <entry></entry>
688 <entry>Some video capture drivers support rapid and 688 <entry>A place holder for future extensions and custom
689synchronous video input changes, a function useful for example in 689(driver defined) buffer types
690video surveillance applications. For this purpose applications set the 690<constant>V4L2_BUF_TYPE_PRIVATE</constant> and higher. Applications
691<constant>V4L2_BUF_FLAG_INPUT</constant> flag, and this field to the 691should set this to 0.</entry>
692number of a video input as in &v4l2-input; field
693<structfield>index</structfield>.</entry>
694 </row> 692 </row>
695 <row> 693 <row>
696 <entry>__u32</entry> 694 <entry>__u32</entry>
@@ -923,13 +921,6 @@ Drivers set or clear this flag when the <constant>VIDIOC_DQBUF</constant>
923ioctl is called.</entry> 921ioctl is called.</entry>
924 </row> 922 </row>
925 <row> 923 <row>
926 <entry><constant>V4L2_BUF_FLAG_INPUT</constant></entry>
927 <entry>0x0200</entry>
928 <entry>The <structfield>input</structfield> field is valid.
929Applications set or clear this flag before calling the
930<constant>VIDIOC_QBUF</constant> ioctl.</entry>
931 </row>
932 <row>
933 <entry><constant>V4L2_BUF_FLAG_PREPARED</constant></entry> 924 <entry><constant>V4L2_BUF_FLAG_PREPARED</constant></entry>
934 <entry>0x0400</entry> 925 <entry>0x0400</entry>
935 <entry>The buffer has been prepared for I/O and can be queued by the 926 <entry>The buffer has been prepared for I/O and can be queued by the
diff --git a/Documentation/DocBook/media/v4l/vidioc-qbuf.xml b/Documentation/DocBook/media/v4l/vidioc-qbuf.xml
index 9caa49af580..77ff5be0809 100644
--- a/Documentation/DocBook/media/v4l/vidioc-qbuf.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-qbuf.xml
@@ -71,12 +71,9 @@ initialize the <structfield>bytesused</structfield>,
71<structfield>field</structfield> and 71<structfield>field</structfield> and
72<structfield>timestamp</structfield> fields, see <xref 72<structfield>timestamp</structfield> fields, see <xref
73linkend="buffer" /> for details. 73linkend="buffer" /> for details.
74Applications must also set <structfield>flags</structfield> to 0. If a driver 74Applications must also set <structfield>flags</structfield> to 0.
75supports capturing from specific video inputs and you want to specify a video 75The <structfield>reserved2</structfield> and
76input, then <structfield>flags</structfield> should be set to 76<structfield>reserved</structfield> fields must be set to 0. When using
77<constant>V4L2_BUF_FLAG_INPUT</constant> and the field
78<structfield>input</structfield> must be initialized to the desired input.
79The <structfield>reserved</structfield> field must be set to 0. When using
80the <link linkend="planar-apis">multi-planar API</link>, the 77the <link linkend="planar-apis">multi-planar API</link>, the
81<structfield>m.planes</structfield> field must contain a userspace pointer 78<structfield>m.planes</structfield> field must contain a userspace pointer
82to a filled-in array of &v4l2-plane; and the <structfield>length</structfield> 79to a filled-in array of &v4l2-plane; and the <structfield>length</structfield>