Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.fe
   3
   4 .. _FE_DISEQC_SEND_BURST:
   5
   6 **************************
   7 ioctl FE_DISEQC_SEND_BURST
   8 **************************
   9
  10 Name
  11 ====
  12
  13 FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
  14
  15 Synopsis
  16 ========
  17
  18 .. c:macro:: FE_DISEQC_SEND_BURST
  19
  20 ``int ioctl(int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd tone)``
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open()`.
  27
  28 ``tone``
  29     An integer enumered value described at :c:type:`fe_sec_mini_cmd`.
  30
  31 Description
  32 ===========
  33
  34 This ioctl is used to set the generation of a 22kHz tone burst for mini
  35 DiSEqC satellite selection for 2x1 switches. This call requires
  36 read/write permissions.
  37
  38 It provides support for what's specified at
  39 `Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__
  40
  41 Return Value
  42 ============
  43
  44 On success 0 is returned.
  45
  46 On error -1 is returned, and the ``errno`` variable is set
  47 appropriately.
  48
  49 Generic error codes are described at the
  50 :ref:`Generic Error Codes <gen-errors>` chapter.