mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-21 19:53:59 +08:00
6dc59e7a19
Use the proper format for FE_SET_TONE documentation and improve the documentation. Keep the enum fe_sec_tone_mode description together with the ioctl, as both are used together. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
89 lines
2.5 KiB
XML
89 lines
2.5 KiB
XML
<refentry id="FE_SET_TONE">
|
|
<refmeta>
|
|
<refentrytitle>ioctl FE_SET_TONE</refentrytitle>
|
|
&manvol;
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>FE_SET_TONE</refname>
|
|
<refpurpose>Sets/resets the generation of the continuous 22kHz tone.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>int <function>ioctl</function></funcdef>
|
|
<paramdef>int <parameter>fd</parameter></paramdef>
|
|
<paramdef>int <parameter>request</parameter></paramdef>
|
|
<paramdef>&fe-sec-tone-mode; *<parameter>tone</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Arguments</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>fd</parameter></term>
|
|
<listitem>
|
|
<para>&fe_fd;</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>request</parameter></term>
|
|
<listitem>
|
|
<para>FE_SET_TONE</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pointer to &fe-sec-tone-mode;</parameter></term>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
|
|
<para>This ioctl is used to set the generation of the continuous 22kHz tone.
|
|
This call requires read/write permissions.</para>
|
|
<para>Usually, satellital antenna subsystems require that the digital TV
|
|
device to send a 22kHz tone in order to select between high/low band on
|
|
some dual-band LNBf. It is also used to send signals to DiSEqC equipment,
|
|
but this is done using the DiSEqC ioctls.</para>
|
|
<para>NOTE: if more than one device is connected to the same antenna,
|
|
setting a tone may interfere on other devices, as they may lose
|
|
the capability of selecting the band. So, it is recommended that
|
|
applications would change to SEC_TONE_OFF when the device is not used.</para>
|
|
|
|
&return-value-dvb;
|
|
</refsect1>
|
|
|
|
<section id="fe-sec-tone-mode-t">
|
|
<title>enum fe_sec_voltage</title>
|
|
|
|
<table pgwide="1" frame="none" id="fe-sec-tone-mode">
|
|
<title>enum fe_sec_tone_mode</title>
|
|
<tgroup cols="2">
|
|
&cs-def;
|
|
<thead>
|
|
<row>
|
|
<entry>ID</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody valign="top">
|
|
<row>
|
|
<entry align="char">SEC_TONE_ON</entry>
|
|
<entry align="char">Sends a 22kHz tone burst to the antenna</entry>
|
|
</row><row>
|
|
<entry align="char">SEC_TONE_OFF</entry>
|
|
<entry align="char">Don't send a 22kHz tone to the antenna
|
|
(except if the FE_DISEQC_* ioctls are called)</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</section>
|
|
|
|
</refentry>
|