[media] docs-rst: Convert DVB 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
cf8076c3
MCC
18.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd *tone )
19 :name: FE_DISEQC_SEND_BURST
5377d91f 20
586027ce 21
15e7d615 22Arguments
5377d91f
MH
23=========
24
25``fd``
26 File descriptor returned by :ref:`open() <frontend_f_open>`.
27
5377d91f
MH
28``tone``
29 pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>`
30
31
15e7d615 32Description
5377d91f
MH
33===========
34
35This ioctl is used to set the generation of a 22kHz tone burst for mini
36DiSEqC satellite selection for 2x1 switches. This call requires
37read/write permissions.
38
39It 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
5377d91f
MH
42.. _fe-sec-mini-cmd-t:
43
44enum fe_sec_mini_cmd
45====================
46
5377d91f
MH
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
6aeb3f67 62 - .. _SEC-MINI-A:
5377d91f 63
0579e6e3 64 ``SEC_MINI_A``
5377d91f
MH
65
66 - Sends a mini-DiSEqC 22kHz '0' Tone Burst to select satellite-A
67
68 - .. row 3
69
6aeb3f67 70 - .. _SEC-MINI-B:
5377d91f 71
0579e6e3 72 ``SEC_MINI_B``
5377d91f
MH
73
74 - Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
fc833980 75
15e7d615
MCC
76
77Return Value
fc833980
MCC
78============
79
80On success 0 is returned, on error -1 and the ``errno`` variable is set
81appropriately. The generic error codes are described at the
82:ref:`Generic Error Codes <gen-errors>` chapter.
This page took 0.046789 seconds and 5 git commands to generate.