Documentation/media/uapi/dvb/fe-set-voltage.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_SET_VOLTAGE:
   4
   5 ********************
   6 ioctl FE_SET_VOLTAGE
   7 ********************
   8
   9 Name
  10 ====
  11
  12 FE_SET_VOLTAGE - Allow setting the DC level sent to the antenna subsystem.
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, enum fe_sec_voltage *voltage )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <frontend_f_open>`.
  26
  27 ``request``
  28     FE_SET_VOLTAGE
  29
  30 ``voltage``
  31     pointer to enum :ref:`fe_sec_voltage <fe-sec-voltage>`
  32
  33     Valid values are described at enum
  34     :ref:`fe_sec_voltage <fe-sec-voltage>`.
  35
  36
  37 Description
  38 ===========
  39
  40 This ioctl allows to set the DC voltage level sent through the antenna
  41 cable to 13V, 18V or off.
  42
  43 Usually, a satellite antenna subsystems require that the digital TV
  44 device to send a DC voltage to feed power to the LNBf. Depending on the
  45 LNBf type, the polarization or the intermediate frequency (IF) of the
  46 LNBf can controlled by the voltage level. Other devices (for example,
  47 the ones that implement DISEqC and multipoint LNBf's don't need to
  48 control the voltage level, provided that either 13V or 18V is sent to
  49 power up the LNBf.
  50
  51 .. attention:: if more than one device is connected to the same antenna,
  52    setting a voltage level may interfere on other devices, as they may lose
  53    the capability of setting polarization or IF. So, on those cases, setting
  54    the voltage to SEC_VOLTAGE_OFF while the device is not is used is
  55    recommended.
  56
  57
  58 Return Value
  59 ============
  60
  61 On success 0 is returned, on error -1 and the ``errno`` variable is set
  62 appropriately. The generic error codes are described at the
  63 :ref:`Generic Error Codes <gen-errors>` chapter.