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