aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/media/v4l/io.xml6
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-qbuf.xml3
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-querybuf.xml11
3 files changed, 12 insertions, 8 deletions
diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml
index 97f785add841..b5d1cbdc558b 100644
--- a/Documentation/DocBook/media/v4l/io.xml
+++ b/Documentation/DocBook/media/v4l/io.xml
@@ -677,8 +677,10 @@ memory, set by the application. See <xref linkend="userp" /> for details.
677 <entry><structfield>length</structfield></entry> 677 <entry><structfield>length</structfield></entry>
678 <entry></entry> 678 <entry></entry>
679 <entry>Size of the buffer (not the payload) in bytes for the 679 <entry>Size of the buffer (not the payload) in bytes for the
680 single-planar API. For the multi-planar API should contain the 680 single-planar API. For the multi-planar API the application sets
681 number of elements in the <structfield>planes</structfield> array. 681 this to the number of elements in the <structfield>planes</structfield>
682 array. The driver will fill in the actual number of valid elements in
683 that array.
682 </entry> 684 </entry>
683 </row> 685 </row>
684 <row> 686 <row>
diff --git a/Documentation/DocBook/media/v4l/vidioc-qbuf.xml b/Documentation/DocBook/media/v4l/vidioc-qbuf.xml
index 6a821a65a5ae..2d37abefce13 100644
--- a/Documentation/DocBook/media/v4l/vidioc-qbuf.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-qbuf.xml
@@ -121,8 +121,7 @@ remaining fields or returns an error code. The driver may also set
121field. It indicates a non-critical (recoverable) streaming error. In such case 121field. It indicates a non-critical (recoverable) streaming error. In such case
122the application may continue as normal, but should be aware that data in the 122the application may continue as normal, but should be aware that data in the
123dequeued buffer might be corrupted. When using the multi-planar API, the 123dequeued buffer might be corrupted. When using the multi-planar API, the
124planes array does not have to be passed; the <structfield>m.planes</structfield> 124planes array must be passed in as well.</para>
125member must be set to NULL in that case.</para>
126 125
127 <para>By default <constant>VIDIOC_DQBUF</constant> blocks when no 126 <para>By default <constant>VIDIOC_DQBUF</constant> blocks when no
128buffer is in the outgoing queue. When the 127buffer is in the outgoing queue. When the
diff --git a/Documentation/DocBook/media/v4l/vidioc-querybuf.xml b/Documentation/DocBook/media/v4l/vidioc-querybuf.xml
index 6e414d7b6df7..a597155c052d 100644
--- a/Documentation/DocBook/media/v4l/vidioc-querybuf.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-querybuf.xml
@@ -48,8 +48,8 @@
48 <refsect1> 48 <refsect1>
49 <title>Description</title> 49 <title>Description</title>
50 50
51 <para>This ioctl is part of the <link linkend="mmap">memory 51 <para>This ioctl is part of the <link linkend="mmap">streaming
52mapping</link> I/O method. It can be used to query the status of a 52</link> I/O method. It can be used to query the status of a
53buffer at any time after buffers have been allocated with the 53buffer at any time after buffers have been allocated with the
54&VIDIOC-REQBUFS; ioctl.</para> 54&VIDIOC-REQBUFS; ioctl.</para>
55 55
@@ -71,6 +71,7 @@ the structure.</para>
71 71
72 <para>In the <structfield>flags</structfield> field the 72 <para>In the <structfield>flags</structfield> field the
73<constant>V4L2_BUF_FLAG_MAPPED</constant>, 73<constant>V4L2_BUF_FLAG_MAPPED</constant>,
74<constant>V4L2_BUF_FLAG_PREPARED</constant>,
74<constant>V4L2_BUF_FLAG_QUEUED</constant> and 75<constant>V4L2_BUF_FLAG_QUEUED</constant> and
75<constant>V4L2_BUF_FLAG_DONE</constant> flags will be valid. The 76<constant>V4L2_BUF_FLAG_DONE</constant> flags will be valid. The
76<structfield>memory</structfield> field will be set to the current 77<structfield>memory</structfield> field will be set to the current
@@ -79,8 +80,10 @@ contains the offset of the buffer from the start of the device memory,
79the <structfield>length</structfield> field its size. For the multi-planar API, 80the <structfield>length</structfield> field its size. For the multi-planar API,
80fields <structfield>m.mem_offset</structfield> and 81fields <structfield>m.mem_offset</structfield> and
81<structfield>length</structfield> in the <structfield>m.planes</structfield> 82<structfield>length</structfield> in the <structfield>m.planes</structfield>
82array elements will be used instead. The driver may or may not set the remaining 83array elements will be used instead and the <structfield>length</structfield>
83fields and flags, they are meaningless in this context.</para> 84field of &v4l2-buffer; is set to the number of filled-in array elements.
85The driver may or may not set the remaining fields and flags, they are
86meaningless in this context.</para>
84 87
85 <para>The <structname>v4l2_buffer</structname> structure is 88 <para>The <structname>v4l2_buffer</structname> structure is
86 specified in <xref linkend="buffer" />.</para> 89 specified in <xref linkend="buffer" />.</para>