Documentation/media/uapi/dvb/fe-diseqc-send-burst.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _FE_DISEQC_SEND_BURST:
  11
  12 **************************
  13 ioctl FE_DISEQC_SEND_BURST
  14 **************************
  15
  16 Name
  17 ====
  18
  19 FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
  20
  21
  22 Synopsis
  23 ========
  24
  25 .. c:function:: int ioctl( int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd tone )
  26     :name: FE_DISEQC_SEND_BURST
  27
  28
  29 Arguments
  30 =========
  31
  32 ``fd``
  33     File descriptor returned by :ref:`open() <frontend_f_open>`.
  34
  35 ``tone``
  36     An integer enumered value described at :c:type:`fe_sec_mini_cmd`.
  37
  38
  39 Description
  40 ===========
  41
  42 This ioctl is used to set the generation of a 22kHz tone burst for mini
  43 DiSEqC satellite selection for 2x1 switches. This call requires
  44 read/write permissions.
  45
  46 It provides support for what's specified at
  47 `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>`__
  48
  49
  50 Return Value
  51 ============
  52
  53 On success 0 is returned.
  54
  55 On error -1 is returned, and the ``errno`` variable is set
  56 appropriately.
  57
  58 Generic error codes are described at the
  59 :ref:`Generic Error Codes <gen-errors>` chapter.