xref: /linux/Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst (revision 3d0fe49454652117522f60bfbefb978ba0e5300b)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. c:namespace:: DTV.fe
3
4.. _FE_DISEQC_SEND_BURST:
5
6**************************
7ioctl FE_DISEQC_SEND_BURST
8**************************
9
10Name
11====
12
13FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
14
15Synopsis
16========
17
18.. c:macro:: FE_DISEQC_SEND_BURST
19
20``int ioctl(int fd, FE_DISEQC_SEND_BURST, enum fe_sec_mini_cmd tone)``
21
22Arguments
23=========
24
25``fd``
26    File descriptor returned by :c:func:`open()`.
27
28``tone``
29    An integer enumered value described at :c:type:`fe_sec_mini_cmd`.
30
31Description
32===========
33
34This ioctl is used to set the generation of a 22kHz tone burst for mini
35DiSEqC satellite selection for 2x1 switches. This call requires
36read/write permissions.
37
38It provides support for what's specified at
39`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>`__
40
41Return Value
42============
43
44On success 0 is returned.
45
46On error -1 is returned, and the ``errno`` variable is set
47appropriately.
48
49Generic error codes are described at the
50:ref:`Generic Error Codes <gen-errors>` chapter.
51