tjh.dev
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_RECV_SLAVE_REPLY
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>
+79
-63
+78
Documentation/DocBook/media/dvb/fe-diseqc-recv-slave-reply.xml
+78
Documentation/DocBook/media/dvb/fe-diseqc-recv-slave-reply.xml
···
1
+
<refentry id="FE_DISEQC_RECV_SLAVE_REPLY">
2
+
<refmeta>
3
+
<refentrytitle>ioctl FE_DISEQC_RECV_SLAVE_REPLY</refentrytitle>
4
+
&manvol;
5
+
</refmeta>
6
+
7
+
<refnamediv>
8
+
<refname>FE_DISEQC_RECV_SLAVE_REPLY</refname>
9
+
<refpurpose>Receives reply from a DiSEqC 2.0 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-slave-reply; *<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_RECV_SLAVE_REPLY</para>
36
+
</listitem>
37
+
</varlistentry>
38
+
<varlistentry>
39
+
<term><parameter>argp</parameter></term>
40
+
<listitem>
41
+
<para>pointer to &dvb-diseqc-slave-reply;</para>
42
+
</listitem>
43
+
</varlistentry>
44
+
</variablelist>
45
+
</refsect1>
46
+
47
+
<refsect1>
48
+
<title>Description</title>
49
+
50
+
<para>Receives reply from a DiSEqC 2.0 command.</para>
51
+
&return-value-dvb;
52
+
53
+
<table pgwide="1" frame="none" id="dvb-diseqc-slave-reply">
54
+
<title>struct <structname>dvb_diseqc_slave_reply</structname></title>
55
+
<tgroup cols="3">
56
+
&cs-str;
57
+
<tbody valign="top">
58
+
<row>
59
+
<entry>uint8_t</entry>
60
+
<entry>msg[4]</entry>
61
+
<entry>DiSEqC message (framing, 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 0 to 4,
66
+
where 0 means no msg</entry>
67
+
</row><row>
68
+
<entry>int</entry>
69
+
<entry>timeout</entry>
70
+
<entry>Return from ioctl after timeout ms with errorcode when no
71
+
message was received</entry>
72
+
</row>
73
+
</tbody>
74
+
</tgroup>
75
+
</table>
76
+
77
+
</refsect1>
78
+
</refentry>
+1
-63
Documentation/DocBook/media/dvb/frontend.xml
+1
-63
Documentation/DocBook/media/dvb/frontend.xml
···
62
62
</programlisting>
63
63
</section>
64
64
65
-
<section role="subsection" id="dvb-diseqc-slave-reply">
66
-
<title>diseqc slave reply</title>
67
-
68
-
<para>A reply to the frontend from DiSEqC 2.0 capable equipment.</para>
69
-
<programlisting>
70
-
struct dvb_diseqc_slave_reply {
71
-
uint8_t msg [4]; /⋆ { framing, data [3] } ⋆/
72
-
uint8_t msg_len; /⋆ valid values are 0...4, 0 means no msg ⋆/
73
-
int timeout; /⋆ return from ioctl after timeout ms with ⋆/
74
-
}; /⋆ errorcode when no message was received ⋆/
75
-
</programlisting>
76
-
</section>
77
-
78
65
<section id="fe-spectral-inversion-t">
79
66
<title>frontend spectral inversion</title>
80
67
<para>The Inversion field can take one of these values:
···
439
452
&return-value-dvb;
440
453
</section>
441
454
442
-
<section id="FE_DISEQC_RECV_SLAVE_REPLY">
443
-
<title>FE_DISEQC_RECV_SLAVE_REPLY</title>
444
-
<para>DESCRIPTION
445
-
</para>
446
-
<informaltable><tgroup cols="1"><tbody><row><entry
447
-
align="char">
448
-
<para>This ioctl call is used to receive reply to a DiSEqC 2.0 command.</para>
449
-
</entry>
450
-
</row></tbody></tgroup></informaltable>
451
-
452
-
<para>SYNOPSIS
453
-
</para>
454
-
<informaltable><tgroup cols="1"><tbody><row><entry
455
-
align="char">
456
-
<para>int ioctl(int fd, int request =
457
-
<link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link>, struct
458
-
dvb_diseqc_slave_reply ⋆reply);</para>
459
-
</entry>
460
-
</row></tbody></tgroup></informaltable>
461
-
462
-
<para>PARAMETERS
463
-
</para>
464
-
<informaltable><tgroup cols="2"><tbody><row><entry
465
-
align="char">
466
-
<para>int fd</para>
467
-
</entry><entry
468
-
align="char">
469
-
<para>File descriptor returned by a previous call to open().</para>
470
-
</entry>
471
-
</row><row><entry
472
-
align="char">
473
-
<para>int request</para>
474
-
</entry><entry
475
-
align="char">
476
-
<para>Equals <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link> for this
477
-
command.</para>
478
-
</entry>
479
-
</row><row><entry
480
-
align="char">
481
-
<para>struct
482
-
dvb_diseqc_slave_reply
483
-
*reply</para>
484
-
</entry><entry
485
-
align="char">
486
-
<para>Pointer to the command to be received.</para>
487
-
</entry>
488
-
</row></tbody></tgroup></informaltable>
489
-
&return-value-dvb;
490
-
</section>
491
-
455
+
&sub-fe-diseqc-recv-slave-reply;
492
456
&sub-fe-diseqc-send-burst;
493
457
&sub-fe-set-tone;
494
458
&sub-fe-set-voltage;