These changes are the raw update to linux-4.4.6-rt14. Kernel sources

[kvmfornfv.git] / kernel / Documentation / DocBook / media / v4l / io.xml

diff --git a/kernel/Documentation/DocBook/media/v4l/io.xml b/kernel/Documentation/DocBook/media/v4l/io.xml
index 1c17f80..da65403 100644 (file)
--- a/kernel/Documentation/DocBook/media/v4l/io.xml
+++ b/kernel/Documentation/DocBook/media/v4l/io.xml
@@ -841,15 +841,15 @@ is the file descriptor associated with a DMABUF buffer.</entry>
            <entry>__u32</entry>
            <entry><structfield>reserved2</structfield></entry>
            <entry></entry>
-           <entry>A place holder for future extensions. Applications
-should set this to 0.</entry>
+           <entry>A place holder for future extensions. Drivers and applications
+must set this to 0.</entry>
          </row>
          <row>
            <entry>__u32</entry>
            <entry><structfield>reserved</structfield></entry>
            <entry></entry>
-           <entry>A place holder for future extensions. Applications
-should set this to 0.</entry>
+           <entry>A place holder for future extensions. Drivers and applications
+must set this to 0.</entry>
          </row>
        </tbody>
       </tgroup>
@@ -930,8 +930,8 @@ should set this to 0.</entry>
            <entry>__u32</entry>
            <entry><structfield>reserved[11]</structfield></entry>
            <entry></entry>
-           <entry>Reserved for future use. Should be zeroed by an
-           application.</entry>
+           <entry>Reserved for future use. Should be zeroed by drivers and
+           applications.</entry>
          </row>
        </tbody>
       </tgroup>
@@ -1006,8 +1006,14 @@ should set this to 0.</entry>
          <row>
            <entry><constant>V4L2_BUF_TYPE_SDR_CAPTURE</constant></entry>
            <entry>11</entry>
-           <entry>Buffer for Software Defined Radio (SDR), see <xref
-               linkend="sdr" />.</entry>
+           <entry>Buffer for Software Defined Radio (SDR) capture stream, see
+               <xref linkend="sdr" />.</entry>
+         </row>
+         <row>
+           <entry><constant>V4L2_BUF_TYPE_SDR_OUTPUT</constant></entry>
+           <entry>12</entry>
+           <entry>Buffer for Software Defined Radio (SDR) output stream, see
+               <xref linkend="sdr" />.</entry>
          </row>
        </tbody>
       </tgroup>
@@ -1127,6 +1133,18 @@ passed on to a DMA-capable hardware unit for further processing or output.
 Typically applications shall use this flag for output buffers if the data
 in this buffer has not been created by the CPU but by some DMA-capable unit,
 in which case caches have not been used.</entry>
+         </row>
+         <row>
+           <entry><constant>V4L2_BUF_FLAG_LAST</constant></entry>
+           <entry>0x00100000</entry>
+           <entry>Last buffer produced by the hardware. mem2mem codec drivers
+set this flag on the capture queue for the last buffer when the
+<link linkend="vidioc-querybuf">VIDIOC_QUERYBUF</link> or
+<link linkend="vidioc-qbuf">VIDIOC_DQBUF</link> ioctl is called. Due to hardware
+limitations, the last buffer may be empty. In this case the driver will set the
+<structfield>bytesused</structfield> field to 0, regardless of the format. Any
+Any subsequent call to the <link linkend="vidioc-qbuf">VIDIOC_DQBUF</link> ioctl
+will not block anymore, but return an &EPIPE;.</entry>
          </row>
          <row>
            <entry><constant>V4L2_BUF_FLAG_TIMESTAMP_MASK</constant></entry>
@@ -1155,7 +1173,7 @@ in which case caches have not been used.</entry>
            <entry>The buffer timestamp has been taken from the
            <constant>CLOCK_MONOTONIC</constant> clock. To access the
            same clock outside V4L2, use
-           <function>clock_gettime(2)</function> .</entry>
+           <function>clock_gettime(2)</function>.</entry>
          </row>
          <row>
            <entry><constant>V4L2_BUF_FLAG_TIMESTAMP_COPY</constant></entry>