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

[media] DocBook: better document FE_DISEQC_SEND_BURST ioctl

Use the proper format for FE_DISEQC_SEND_BURST documentation
and improve the documentation.

Keep the enum fe_sec_mini_cmd description together with
the ioctl, as both are used together.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

+91 -68
+86
Documentation/DocBook/media/dvb/fe-diseqc-send-burst.xml
··· 1 + <refentry id="FE_DISEQC_SEND_BURST"> 2 + <refmeta> 3 + <refentrytitle>ioctl FE_DISEQC_SEND_BURST</refentrytitle> 4 + &manvol; 5 + </refmeta> 6 + 7 + <refnamediv> 8 + <refname>FE_DISEQC_SEND_BURST</refname> 9 + <refpurpose>Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.</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-mini-cmd; *<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_DISEQC_SEND_BURST</para> 36 + </listitem> 37 + </varlistentry> 38 + <varlistentry> 39 + <term><parameter>pointer to &fe-sec-mini-cmd;</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 a 22kHz tone burst for mini 48 + DiSEqC satellite 49 + selection for 2x1 switches. 50 + This call requires read/write permissions.</para> 51 + <para>It provides support for what's specified at 52 + <ulink url="http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf">Digital Satellite Equipment Control 53 + (DiSEqC) - Simple "ToneBurst" Detection Circuit specification.</ulink> 54 + </para> 55 + &return-value-dvb; 56 + </refsect1> 57 + 58 + <section id="fe-sec-mini-cmd-t"> 59 + <title>enum fe_sec_mini_cmd</title> 60 + 61 + <table pgwide="1" frame="none" id="fe-sec-mini-cmd"> 62 + <title>enum fe_sec_tone_mode</title> 63 + <tgroup cols="2"> 64 + &cs-def; 65 + <thead> 66 + <row> 67 + <entry>ID</entry> 68 + <entry>Description</entry> 69 + </row> 70 + </thead> 71 + <tbody valign="top"> 72 + <row> 73 + <entry align="char">SEC_MINI_A</entry> 74 + <entry align="char">Sends a mini-DiSEqC 22kHz '0' Tone Burst to 75 + select satellite-A</entry> 76 + </row><row> 77 + <entry align="char">SEC_MINI_B</entry> 78 + <entry align="char">Sends a mini-DiSEqC 22kHz '1' Data Burst to 79 + select satellite-B</entry> 80 + </row> 81 + </tbody> 82 + </tgroup> 83 + </table> 84 + </section> 85 + 86 + </refentry>
+1 -66
Documentation/DocBook/media/dvb/frontend.xml
··· 75 75 </programlisting> 76 76 </section> 77 77 78 - <section id="fe-sec-mini-cmd-t"> 79 - <title>SEC tone burst</title> 80 - 81 - <para>The 22KHz tone burst is usually used with non-DiSEqC capable switches to select 82 - between two connected LNBs/satellites. 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_mini_cmd { 87 - SEC_MINI_A, 88 - SEC_MINI_B 89 - } fe_sec_mini_cmd_t; 90 - </programlisting> 91 - 92 - <para></para> 93 - </section> 94 - 95 78 <section id="fe-spectral-inversion-t"> 96 79 <title>frontend spectral inversion</title> 97 80 <para>The Inversion field can take one of these values: ··· 502 519 &return-value-dvb; 503 520 </section> 504 521 505 - <section id="FE_DISEQC_SEND_BURST"> 506 - <title>FE_DISEQC_SEND_BURST</title> 507 - <para>DESCRIPTION 508 - </para> 509 - <informaltable><tgroup cols="1"><tbody><row><entry 510 - align="char"> 511 - <para>This ioctl call is used to send a 22KHz tone burst.</para> 512 - </entry> 513 - </row></tbody></tgroup></informaltable> 514 - 515 - <para>SYNOPSIS 516 - </para> 517 - <informaltable><tgroup cols="1"><tbody><row><entry 518 - align="char"> 519 - <para>int ioctl(int fd, int request = 520 - <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link>, fe_sec_mini_cmd_t burst);</para> 521 - </entry> 522 - </row></tbody></tgroup></informaltable> 523 - 524 - <para>PARAMETERS 525 - </para> 526 - <informaltable><tgroup cols="2"><tbody><row><entry 527 - align="char"> 528 - <para>int fd</para> 529 - </entry><entry 530 - align="char"> 531 - <para>File descriptor returned by a previous call to open().</para> 532 - </entry> 533 - </row><row><entry 534 - align="char"> 535 - <para>int request</para> 536 - </entry><entry 537 - align="char"> 538 - <para>Equals <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link> for this command.</para> 539 - </entry> 540 - </row><row><entry 541 - align="char"> 542 - <para>fe_sec_mini_cmd_t 543 - burst</para> 544 - </entry><entry 545 - align="char"> 546 - <para>burst A or B.</para> 547 - </entry> 548 - </row></tbody></tgroup></informaltable> 549 - 550 - &return-value-dvb; 551 - </section> 552 - 553 - 522 + &sub-fe-diseqc-send-burst; 554 523 &sub-fe-set-tone; 555 524 &sub-fe-set-voltage; 556 525 &sub-fe-enable-high-lnb-voltage;
+4 -2
include/uapi/linux/dvb/frontend.h
··· 122 122 typedef enum fe_sec_tone_mode fe_sec_tone_mode_t; 123 123 124 124 125 - typedef enum fe_sec_mini_cmd { 125 + enum fe_sec_mini_cmd { 126 126 SEC_MINI_A, 127 127 SEC_MINI_B 128 - } fe_sec_mini_cmd_t; 128 + }; 129 + 130 + typedef enum fe_sec_mini_cmd fe_sec_mini_cmd_t; 129 131 130 132 131 133 /**