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 .. cpp:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <frontend_f_open>`.
  26
  27 ``request``
  28     FE_DISEQC_SEND_BURST
  29
  30 ``tone``
  31     pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>`
  32
  33
  34 Description
  35 ===========
  36
  37 This ioctl is used to set the generation of a 22kHz tone burst for mini
  38 DiSEqC satellite selection for 2x1 switches. This call requires
  39 read/write permissions.
  40
  41 It provides support for what's specified at
  42 `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>`__
  43
  44 .. _fe-sec-mini-cmd-t:
  45
  46 enum fe_sec_mini_cmd
  47 ====================
  48
  49 .. _fe-sec-mini-cmd:
  50
  51 .. flat-table:: enum fe_sec_mini_cmd
  52     :header-rows:  1
  53     :stub-columns: 0
  54
  55
  56     -  .. row 1
  57
  58        -  ID
  59
  60        -  Description
  61
  62     -  .. row 2
  63
  64        -  .. _SEC-MINI-A:
  65
  66           ``SEC_MINI_A``
  67
  68        -  Sends a mini-DiSEqC 22kHz '0' Tone Burst to select satellite-A
  69
  70     -  .. row 3
  71
  72        -  .. _SEC-MINI-B:
  73
  74           ``SEC_MINI_B``
  75
  76        -  Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
  77
  78
  79 Return Value
  80 ============
  81
  82 On success 0 is returned, on error -1 and the ``errno`` variable is set
  83 appropriately. The generic error codes are described at the
  84 :ref:`Generic Error Codes <gen-errors>` chapter.