1<refentry id="FE_SET_TONE">
2  <refmeta>
3    <refentrytitle>ioctl FE_SET_TONE</refentrytitle>
4    &manvol;
5  </refmeta>
6
7  <refnamediv>
8    <refname>FE_SET_TONE</refname>
9    <refpurpose>Sets/resets the generation of the continuous 22kHz tone.</refpurpose>
10  </refnamediv>
11
12  <refsynopsisdiv>
13    <funcsynopsis>
14      <funcprototype>
15	<funcdef>int <function>ioctl</function></funcdef>
16	<paramdef>int <parameter>fd</parameter></paramdef>
17	<paramdef>int <parameter>request</parameter></paramdef>
18	<paramdef>enum fe_sec_tone_mode *<parameter>tone</parameter></paramdef>
19      </funcprototype>
20    </funcsynopsis>
21  </refsynopsisdiv>
22
23  <refsect1>
24    <title>Arguments</title>
25        <variablelist>
26      <varlistentry>
27	<term><parameter>fd</parameter></term>
28	<listitem>
29	  <para>&fe_fd;</para>
30	</listitem>
31      </varlistentry>
32      <varlistentry>
33	<term><parameter>request</parameter></term>
34	<listitem>
35	  <para>FE_SET_TONE</para>
36	</listitem>
37      </varlistentry>
38      <varlistentry>
39	<term><parameter>tone</parameter></term>
40	<listitem>
41	  <para>pointer to &fe-sec-tone-mode;</para>
42	</listitem>
43      </varlistentry>
44    </variablelist>
45  </refsect1>
46
47  <refsect1>
48    <title>Description</title>
49
50<para>This ioctl is used to set the generation of the continuous 22kHz tone.
51    This call requires read/write permissions.</para>
52<para>Usually, satellite antenna subsystems require that the digital TV
53    device to send a 22kHz tone in order to select between high/low band on
54    some dual-band LNBf. It is also used to send signals to DiSEqC equipment,
55    but this is done using the DiSEqC ioctls.</para>
56<para>NOTE: if more than one device is connected to the same antenna,
57    setting a tone may interfere on other devices, as they may lose
58    the capability of selecting the band. So, it is recommended that
59    applications would change to SEC_TONE_OFF when the device is not used.</para>
60
61&return-value-dvb;
62</refsect1>
63
64<refsect1 id="fe-sec-tone-mode-t">
65<title>enum fe_sec_tone_mode</title>
66
67<table pgwide="1" frame="none" id="fe-sec-tone-mode">
68    <title>enum fe_sec_tone_mode</title>
69    <tgroup cols="2">
70	&cs-def;
71	<thead>
72	<row>
73	    <entry>ID</entry>
74	    <entry>Description</entry>
75	</row>
76	</thead>
77	<tbody valign="top">
78	<row>
79	    <entry align="char" id="SEC-TONE-ON"><constant>SEC_TONE_ON</constant></entry>
80	    <entry align="char">Sends a 22kHz tone burst to the antenna</entry>
81	</row><row>
82	    <entry align="char" id="SEC-TONE-OFF"><constant>SEC_TONE_OFF</constant></entry>
83	    <entry align="char">Don't send a 22kHz tone to the antenna
84		(except if the FE_DISEQC_* ioctls are called)</entry>
85	</row>
86        </tbody>
87    </tgroup>
88</table>
89</refsect1>
90
91</refentry>
92