Documentation/DocBook/media/dvb/fe-set-frontend-tune-mode.xml

   1 <refentry id="FE_SET_FRONTEND_TUNE_MODE">
   2   <refmeta>
   3     <refentrytitle>ioctl FE_SET_FRONTEND_TUNE_MODE</refentrytitle>
   4     &manvol;
   5   </refmeta>
   6
   7   <refnamediv>
   8     <refname>FE_SET_FRONTEND_TUNE_MODE</refname>
   9     <refpurpose>Allow setting tuner mode flags to the frontend.</refpurpose>
  10   </refnamediv>
  11
  12   <refsynopsisdiv>
  13     <funcsynopsis>
  14       <funcprototype>
  15         <funcdef>int <function>ioctl</function></funcdef>
  16         <paramdef>int <parameter>fd</parameter></paramdef>
  17         <paramdef>int <parameter>request</parameter></paramdef>
  18         <paramdef>unsigned int <parameter>flags</parameter></paramdef>
  19       </funcprototype>
  20     </funcsynopsis>
  21   </refsynopsisdiv>
  22
  23   <refsect1>
  24     <title>Arguments</title>
  25         <variablelist>
  26       <varlistentry>
  27         <term><parameter>fd</parameter></term>
  28         <listitem>
  29           <para>&fe_fd;</para>
  30         </listitem>
  31       </varlistentry>
  32       <varlistentry>
  33         <term><parameter>request</parameter></term>
  34         <listitem>
  35           <para>FE_SET_FRONTEND_TUNE_MODE</para>
  36         </listitem>
  37       </varlistentry>
  38       <varlistentry>
  39         <term><parameter>flags</parameter></term>
  40         <listitem>
  41             <para>Valid flags:</para>
  42             <itemizedlist>
  43                 <listitem><para>0 - normal tune mode</para></listitem>
  44                 <listitem><para>FE_TUNE_MODE_ONESHOT - When set, this flag will
  45                     disable any zigzagging or other "normal" tuning behaviour.
  46                     Additionally, there will be no automatic monitoring of the
  47                     lock status, and hence no frontend events will be
  48                     generated. If a frontend device is closed, this flag will
  49                     be automatically turned off when the device is reopened
  50                     read-write.</para></listitem>
  51             </itemizedlist>
  52         </listitem>
  53       </varlistentry>
  54     </variablelist>
  55   </refsect1>
  56
  57   <refsect1>
  58     <title>Description</title>
  59
  60     <para>Allow setting tuner mode flags to the frontend, between 0 (normal)
  61         or FE_TUNE_MODE_ONESHOT mode</para>
  62 &return-value-dvb;
  63 </refsect1>
  64 </refentry>