Documentation/DocBook/media/dvb/fe-set-voltage.xml

   1 <refentry id="FE_SET_VOLTAGE">
   2   <refmeta>
   3     <refentrytitle>ioctl FE_SET_VOLTAGE</refentrytitle>
   4     &manvol;
   5   </refmeta>
   6
   7   <refnamediv>
   8     <refname>FE_SET_VOLTAGE</refname>
   9     <refpurpose>Allow setting the DC level sent to the antenna subsystem.</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>&fe-sec-voltage; *<parameter>voltage</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_VOLTAGE</para>
  36         </listitem>
  37       </varlistentry>
  38       <varlistentry>
  39         <term><parameter>pointer to &fe-sec-voltage;</parameter></term>
  40       </varlistentry>
  41     </variablelist>
  42   </refsect1>
  43
  44   <refsect1>
  45     <title>Description</title>
  46
  47 <para>This ioctl allows to set the DC voltage level sent through the antenna
  48     cable to 13V, 18V or off.</para>
  49 <para>Usually, a satellital antenna subsystems require that the digital TV
  50     device to send a DC voltage to feed power to the LNBf. Depending on the
  51     LNBf type, the polarization or the intermediate frequency (IF) of the LNBf
  52     can controlled by the voltage level. Other devices (for example, the ones
  53     that implement DISEqC and multipoint LNBf's don't need to control the
  54     voltage level, provided that either 13V or 18V is sent to power up the
  55     LNBf.</para>
  56 <para>NOTE: if more than one device is connected to the same antenna,
  57     setting a voltage level may interfere on other devices, as they may lose
  58     the capability of setting polarization or IF. So, on those
  59     cases, setting the voltage to SEC_VOLTAGE_OFF while the device is not is
  60     used is recommended.</para>
  61
  62 &return-value-dvb;
  63 </refsect1>
  64
  65 <section id="fe-sec-voltage-t">
  66 <title>enum fe_sec_voltage</title>
  67
  68 <table pgwide="1" frame="none" id="fe-sec-voltage">
  69     <title>enum fe_status</title>
  70     <tgroup cols="2">
  71         &cs-def;
  72         <thead>
  73         <row>
  74             <entry>ID</entry>
  75             <entry>Description</entry>
  76         </row>
  77         </thead>
  78         <tbody valign="top">
  79         <row>
  80             <entry align="char">SEC_VOLTAGE_13</entry>
  81             <entry align="char">Set DC voltage level to 13V</entry>
  82         </row><row>
  83             <entry align="char">SEC_VOLTAGE_18</entry>
  84             <entry align="char">Set DC voltage level to 18V</entry>
  85         </row><row>
  86             <entry align="char">SEC_VOLTAGE_OFF</entry>
  87             <entry align="char">Don't send any voltage to the antenna</entry>
  88         </row>
  89         </tbody>
  90     </tgroup>
  91 </table>
  92 </section>
  93
  94 </refentry>