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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _FE_DISEQC_SEND_BURST:
   4
   5 **************************
   6 ioctl FE_DISEQC_SEND_BURST
   7 **************************
   8
   9 Name
  10 ====
  11
  12 FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. c:function:: int ioctl( int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd tone )
  19     :name: FE_DISEQC_SEND_BURST
  20
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :ref:`open() <frontend_f_open>`.
  27
  28 ``tone``
  29     An integer enumered value described at :c:type:`fe_sec_mini_cmd`.
  30
  31
  32 Description
  33 ===========
  34
  35 This ioctl is used to set the generation of a 22kHz tone burst for mini
  36 DiSEqC satellite selection for 2x1 switches. This call requires
  37 read/write permissions.
  38
  39 It provides support for what's specified at
  40 `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>`__
  41
  42
  43 Return Value
  44 ============
  45
  46 On success 0 is returned.
  47
  48 On error -1 is returned, and the ``errno`` variable is set
  49 appropriately.
  50
  51 Generic error codes are described at the
  52 :ref:`Generic Error Codes <gen-errors>` chapter.