Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[media] DocBook: better document FE_SET_TONE ioctl

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>

+93 -62
+88
Documentation/DocBook/media/dvb/fe-set-tone.xml
··· 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>&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>pointer to &fe-sec-tone-mode;</parameter></term> 40 + </varlistentry> 41 + </variablelist> 42 + </refsect1> 43 + 44 + <refsect1> 45 + <title>Description</title> 46 + 47 + <para>This ioctl is used to set the generation of the continuous 22kHz tone. 48 + This call requires read/write permissions.</para> 49 + <para>Usually, satellital antenna subsystems require that the digital TV 50 + device to send a 22kHz tone in order to select between high/low band on 51 + some dual-band LNBf. It is also used to send signals to DiSEqC equipment, 52 + but this is done using the DiSEqC ioctls.</para> 53 + <para>NOTE: if more than one device is connected to the same antenna, 54 + setting a tone may interfere on other devices, as they may lose 55 + the capability of selecting the band. So, it is recommended that 56 + applications would change to SEC_TONE_OFF when the device is not used.</para> 57 + 58 + &return-value-dvb; 59 + </refsect1> 60 + 61 + <section id="fe-sec-tone-mode-t"> 62 + <title>enum fe_sec_voltage</title> 63 + 64 + <table pgwide="1" frame="none" id="fe-sec-tone-mode"> 65 + <title>enum fe_sec_tone_mode</title> 66 + <tgroup cols="2"> 67 + &cs-def; 68 + <thead> 69 + <row> 70 + <entry>ID</entry> 71 + <entry>Description</entry> 72 + </row> 73 + </thead> 74 + <tbody valign="top"> 75 + <row> 76 + <entry align="char">SEC_TONE_ON</entry> 77 + <entry align="char">Sends a 22kHz tone burst to the antenna</entry> 78 + </row><row> 79 + <entry align="char">SEC_TONE_OFF</entry> 80 + <entry align="char">Don't send a 22kHz tone to the antenna 81 + (except if the FE_DISEQC_* ioctls are called)</entry> 82 + </row> 83 + </tbody> 84 + </tgroup> 85 + </table> 86 + </section> 87 + 88 + </refentry>
+1 -60
Documentation/DocBook/media/dvb/frontend.xml
··· 75 75 </programlisting> 76 76 </section> 77 77 78 - <section id="fe-sec-tone-mode-t"> 79 - <title>SEC continuous tone</title> 80 - 81 - <para>The continuous 22KHz tone is usually used with non-DiSEqC capable LNBs to switch the 82 - high/low band of a dual-band LNB. When using DiSEqC epuipment this voltage has to 83 - be switched consistently to the DiSEqC commands as described in the DiSEqC 84 - spec.</para> 85 - <programlisting> 86 - typedef enum fe_sec_tone_mode { 87 - SEC_TONE_ON, 88 - SEC_TONE_OFF 89 - } fe_sec_tone_mode_t; 90 - </programlisting> 91 - </section> 92 - 93 78 <section id="fe-sec-mini-cmd-t"> 94 79 <title>SEC tone burst</title> 95 80 ··· 567 582 &return-value-dvb; 568 583 </section> 569 584 570 - <section id="FE_SET_TONE"> 571 - <title>FE_SET_TONE</title> 572 - <para>DESCRIPTION 573 - </para> 574 - <informaltable><tgroup cols="1"><tbody><row><entry 575 - align="char"> 576 - <para>This call is used to set the generation of the continuous 22kHz tone. This call 577 - requires read/write permissions.</para> 578 - </entry> 579 - </row></tbody></tgroup></informaltable> 580 - <para>SYNOPSIS 581 - </para> 582 - <informaltable><tgroup cols="1"><tbody><row><entry 583 - align="char"> 584 - <para>int ioctl(int fd, int request = <link linkend="FE_SET_TONE">FE_SET_TONE</link>, 585 - fe_sec_tone_mode_t tone);</para> 586 - </entry> 587 - </row></tbody></tgroup></informaltable> 588 - <para>PARAMETERS 589 - </para> 590 - <informaltable><tgroup cols="2"><tbody><row><entry 591 - align="char"> 592 - <para>int fd</para> 593 - </entry><entry 594 - align="char"> 595 - <para>File descriptor returned by a previous call to open().</para> 596 - </entry> 597 - </row><row><entry 598 - align="char"> 599 - <para>int request</para> 600 - </entry><entry 601 - align="char"> 602 - <para>Equals <link linkend="FE_SET_TONE">FE_SET_TONE</link> for this command.</para> 603 - </entry> 604 - </row><row><entry 605 - align="char"> 606 - <para>fe_sec_tone_mode_t 607 - tone</para> 608 - </entry><entry 609 - align="char"> 610 - <para>The requested tone generation mode (on/off).</para> 611 - </entry> 612 - </row></tbody></tgroup></informaltable> 613 - &return-value-dvb; 614 - </section> 615 585 586 + &sub-fe-set-tone; 616 587 &sub-fe-set-voltage; 617 588 &sub-fe-enable-high-lnb-voltage; 618 589 &sub-fe-set-frontend-tune-mode;
+4 -2
include/uapi/linux/dvb/frontend.h
··· 114 114 typedef enum fe_sec_voltage fe_sec_voltage_t; 115 115 116 116 117 - typedef enum fe_sec_tone_mode { 117 + enum fe_sec_tone_mode { 118 118 SEC_TONE_ON, 119 119 SEC_TONE_OFF 120 - } fe_sec_tone_mode_t; 120 + }; 121 + 122 + typedef enum fe_sec_tone_mode fe_sec_tone_mode_t; 121 123 122 124 123 125 typedef enum fe_sec_mini_cmd {