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     pointer to enum :ref:`fe_sec_mini_cmd <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 .. _fe-sec-mini-cmd-t:
  43
  44 enum fe_sec_mini_cmd
  45 ====================
  46
  47 .. _fe-sec-mini-cmd:
  48
  49 .. flat-table:: enum fe_sec_mini_cmd
  50     :header-rows:  1
  51     :stub-columns: 0
  52
  53
  54     -  .. row 1
  55
  56        -  ID
  57
  58        -  Description
  59
  60     -  .. row 2
  61
  62        -  .. _SEC-MINI-A:
  63
  64           ``SEC_MINI_A``
  65
  66        -  Sends a mini-DiSEqC 22kHz '0' Tone Burst to select satellite-A
  67
  68     -  .. row 3
  69
  70        -  .. _SEC-MINI-B:
  71
  72           ``SEC_MINI_B``
  73
  74        -  Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
  75
  76
  77 Return Value
  78 ============
  79
  80 On success 0 is returned, on error -1 and the ``errno`` variable is set
  81 appropriately. The generic error codes are described at the
  82 :ref:`Generic Error Codes <gen-errors>` chapter.