Merge branch 'v4l_for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...

[firefly-linux-kernel-4.4.55.git] / Documentation / DocBook / media / v4l / vidioc-s-hw-freq-seek.xml

diff --git a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
index 407dfceb71f0c29fcc8cfd7d2a29cabc2e305ba1..f4db44d0d95a8c0b065bf99dccae34b63c70a6af 100644 (file)
--- a/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-s-hw-freq-seek.xml
@@ -58,6 +58,9 @@ To do this applications initialize the <structfield>tuner</structfield>,
 call the <constant>VIDIOC_S_HW_FREQ_SEEK</constant> ioctl with a pointer
 to this structure.</para>
 
+    <para>If an error is returned, then the original frequency will
+    be restored.</para>
+
     <para>This ioctl is supported if the <constant>V4L2_CAP_HW_FREQ_SEEK</constant> capability is set.</para>
 
     <table pgwide="1" frame="none" id="v4l2-hw-freq-seek">
@@ -87,7 +90,10 @@ field and the &v4l2-tuner; <structfield>index</structfield> field.</entry>
          <row>
            <entry>__u32</entry>
            <entry><structfield>wrap_around</structfield></entry>
-           <entry>If non-zero, wrap around when at the end of the frequency range, else stop seeking.</entry>
+           <entry>If non-zero, wrap around when at the end of the frequency range, else stop seeking.
+           The &v4l2-tuner; <structfield>capability</structfield> field will tell you what the
+           hardware supports.
+           </entry>
          </row>
          <row>
            <entry>__u32</entry>
@@ -118,9 +124,15 @@ wrong.</para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term><errorcode>EAGAIN</errorcode></term>
+       <term><errorcode>ENODATA</errorcode></term>
+       <listitem>
+         <para>The hardware seek found no channels.</para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><errorcode>EBUSY</errorcode></term>
        <listitem>
-         <para>The ioctl timed-out. Try again.</para>
+         <para>Another hardware seek is already in progress.</para>
        </listitem>
       </varlistentry>
     </variablelist>