[media] docs-rst: Convert V4L2 uAPI to use C function references
[deliverable/linux.git] / Documentation / media / uapi / dvb / fe-diseqc-send-burst.rst
CommitLineData
5377d91f
MH
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _FE_DISEQC_SEND_BURST:
4
5**************************
6ioctl FE_DISEQC_SEND_BURST
7**************************
8
15e7d615 9Name
586027ce 10====
5377d91f 11
586027ce 12FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
5377d91f 13
15e7d615
MCC
14
15Synopsis
5377d91f
MH
16========
17
1b81f010 18.. c:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
5377d91f 19
586027ce 20
15e7d615 21Arguments
5377d91f
MH
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
15e7d615 34Description
5377d91f
MH
35===========
36
37This ioctl is used to set the generation of a 22kHz tone burst for mini
38DiSEqC satellite selection for 2x1 switches. This call requires
39read/write permissions.
40
41It 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
5377d91f
MH
44.. _fe-sec-mini-cmd-t:
45
46enum fe_sec_mini_cmd
47====================
48
5377d91f
MH
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
6aeb3f67 64 - .. _SEC-MINI-A:
5377d91f 65
0579e6e3 66 ``SEC_MINI_A``
5377d91f
MH
67
68 - Sends a mini-DiSEqC 22kHz '0' Tone Burst to select satellite-A
69
70 - .. row 3
71
6aeb3f67 72 - .. _SEC-MINI-B:
5377d91f 73
0579e6e3 74 ``SEC_MINI_B``
5377d91f
MH
75
76 - Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
fc833980 77
15e7d615
MCC
78
79Return Value
fc833980
MCC
80============
81
82On success 0 is returned, on error -1 and the ``errno`` variable is set
83appropriately. The generic error codes are described at the
84:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.153926 seconds and 5 git commands to generate.