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_MASTER_CMD

Use the new format for the ioctl documentation and put the
struct dvb_diseqc_slave_reply together with the ioctl.

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

+73 -62
+72
Documentation/DocBook/media/dvb/fe-diseqc-send-master-cmd.xml
··· 1 + <refentry id="FE_DISEQC_SEND_MASTER_CMD"> 2 + <refmeta> 3 + <refentrytitle>ioctl FE_DISEQC_SEND_MASTER_CMD</refentrytitle> 4 + &manvol; 5 + </refmeta> 6 + 7 + <refnamediv> 8 + <refname>FE_DISEQC_SEND_MASTER_CMD</refname> 9 + <refpurpose>Sends a DiSEqC command</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>&dvb-diseqc-master-cmd; *<parameter>argp</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_MASTER_CMD</para> 36 + </listitem> 37 + </varlistentry> 38 + <varlistentry> 39 + <term><parameter>argp</parameter></term> 40 + <listitem> 41 + <para>pointer to &dvb-diseqc-master-cmd;</para> 42 + </listitem> 43 + </varlistentry> 44 + </variablelist> 45 + </refsect1> 46 + 47 + <refsect1> 48 + <title>Description</title> 49 + 50 + <para>Sends a DiSEqC command to the antenna subsystem.</para> 51 + &return-value-dvb; 52 + 53 + <table pgwide="1" frame="none" id="dvb-diseqc-master-cmd"> 54 + <title>struct <structname>dvb_diseqc_master_cmd</structname></title> 55 + <tgroup cols="3"> 56 + &cs-str; 57 + <tbody valign="top"> 58 + <row> 59 + <entry>uint8_t</entry> 60 + <entry>msg[6]</entry> 61 + <entry>DiSEqC message (framing, address, command, data[3])</entry> 62 + </row><row> 63 + <entry>uint8_t</entry> 64 + <entry>msg_len</entry> 65 + <entry>Length of the DiSEqC message. Valid values are 3 to 6</entry> 66 + </row> 67 + </tbody> 68 + </tgroup> 69 + </table> 70 + 71 + </refsect1> 72 + </refentry>
+1 -62
Documentation/DocBook/media/dvb/frontend.xml
··· 50 50 51 51 &sub-dvbproperty; 52 52 53 - <section id="dvb-diseqc-master-cmd"> 54 - <title>diseqc master command</title> 55 - 56 - <para>A message sent from the frontend to DiSEqC capable equipment.</para> 57 - <programlisting> 58 - struct dvb_diseqc_master_cmd { 59 - uint8_t msg [6]; /&#x22C6; { framing, address, command, data[3] } &#x22C6;/ 60 - uint8_t msg_len; /&#x22C6; valid values are 3...6 &#x22C6;/ 61 - }; 62 - </programlisting> 63 - </section> 64 - 65 53 <section id="fe-spectral-inversion-t"> 66 54 <title>frontend spectral inversion</title> 67 55 <para>The Inversion field can take one of these values: ··· 377 389 &return-value-dvb; 378 390 </section> 379 391 380 - <section id="FE_DISEQC_SEND_MASTER_CMD"> 381 - <title>FE_DISEQC_SEND_MASTER_CMD</title> 382 - <para>DESCRIPTION 383 - </para> 384 - <informaltable><tgroup cols="1"><tbody><row><entry 385 - align="char"> 386 - <para>This ioctl call is used to send a a DiSEqC command.</para> 387 - </entry> 388 - </row></tbody></tgroup></informaltable> 389 - <para>SYNOPSIS 390 - </para> 391 - <informaltable><tgroup cols="1"><tbody><row><entry 392 - align="char"> 393 - <para>int ioctl(int fd, int request = 394 - <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link>, struct 395 - dvb_diseqc_master_cmd &#x22C6;cmd);</para> 396 - </entry> 397 - </row></tbody></tgroup></informaltable> 398 - 399 - <para>PARAMETERS 400 - </para> 401 - <informaltable><tgroup cols="2"><tbody><row><entry 402 - align="char"> 403 - <para>int fd</para> 404 - </entry><entry 405 - align="char"> 406 - <para>File descriptor returned by a previous call to open().</para> 407 - </entry> 408 - </row><row><entry 409 - align="char"> 410 - <para>int request</para> 411 - </entry><entry 412 - align="char"> 413 - <para>Equals <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link> for this 414 - command.</para> 415 - </entry> 416 - </row><row><entry 417 - align="char"> 418 - <para>struct 419 - dvb_diseqc_master_cmd 420 - *cmd</para> 421 - </entry><entry 422 - align="char"> 423 - <para>Pointer to the command to be transmitted.</para> 424 - </entry> 425 - </row></tbody></tgroup></informaltable> 426 - 427 - &return-value-dvb; 428 - </section> 429 - 392 + &sub-fe-diseqc-send-master-cmd; 430 393 &sub-fe-diseqc-recv-slave-reply; 431 394 &sub-fe-diseqc-send-burst; 432 395 &sub-fe-set-tone;