[media] DocBook: add SDR specific info to G_TUNER / S_TUNER
authorAntti Palosaari <crope@iki.fi>
Sat, 10 Oct 2015 16:51:08 +0000 (13:51 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Tue, 20 Oct 2015 17:56:04 +0000 (15:56 -0200)
Add SDR specific notes to G_TUNER / S_TUNER documentation.
Add V4L2_TUNER_SDR and V4L2_TUNER_RF to supported tuner types to
table.

Signed-off-by: Antti Palosaari <crope@iki.fi>
[hans.verkuil@cisco.com: add quotes in "The term 'tuner'"]
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Documentation/DocBook/media/v4l/vidioc-g-tuner.xml

index b0d865933da69247aaf85a569d1de4cc1a28acf4..459b7e561f3c1e1ed32dd556a936eb5c04849f20 100644 (file)
@@ -80,6 +80,12 @@ if the requested mode is invalid or unsupported. Since this is a
 <!-- FIXME -->write-only ioctl, it does not return the actually
 selected audio mode.</para>
 
+    <para><link linkend="sdr">SDR</link> specific tuner types are
+<constant>V4L2_TUNER_SDR</constant> and <constant>V4L2_TUNER_RF</constant>.
+For SDR devices <structfield>audmode</structfield> field must be
+initialized to zero.
+The term 'tuner' means SDR receiver in this context.</para>
+
     <para>To change the radio frequency the &VIDIOC-S-FREQUENCY; ioctl
 is available.</para>
 
@@ -261,6 +267,16 @@ applications must set the array to zero.</entry>
            <entry>2</entry>
            <entry></entry>
          </row>
+         <row>
+           <entry><constant>V4L2_TUNER_SDR</constant></entry>
+           <entry>4</entry>
+           <entry></entry>
+         </row>
+         <row>
+           <entry><constant>V4L2_TUNER_RF</constant></entry>
+           <entry>5</entry>
+           <entry></entry>
+         </row>
        </tbody>
       </tgroup>
     </table>