Documentation/userspace-api/media/dvb/fe-set-voltage.rst

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