2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-21 19:53:59 +08:00

[media] DocBook: document DVB-S2 pilot in a table

Putting it into a table allows to comment each possible
values, with makes more clear what field means.

Also, it allows to do cross-references with the frontend.h.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab 2015-06-07 11:18:16 -03:00
parent 8092cd7fc6
commit 448bac1031
2 changed files with 28 additions and 9 deletions

View File

@ -417,13 +417,30 @@ get/set up to 64 properties. The actual meaning of each property is described on
<para>Sets DVB-S2 pilot</para>
<section id="fe-pilot-t">
<title>fe_pilot type</title>
<programlisting>
typedef enum fe_pilot {
PILOT_ON,
PILOT_OFF,
PILOT_AUTO,
} fe_pilot_t;
</programlisting>
<table pgwide="1" frame="none" id="fe-pilot">
<title>enum fe_pilot</title>
<tgroup cols="2">
&cs-def;
<thead>
<row>
<entry>ID</entry>
<entry>Description</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry align="char" id="PILOT-ON"><constant>PILOT_ON</constant></entry>
<entry align="char">Pilot tones enabled</entry>
</row><row>
<entry align="char" id="PILOT-OFF"><constant>PILOT_OFF</constant></entry>
<entry align="char">Pilot tones disabled</entry>
</row><row>
<entry align="char" id="PILOT-AUTO"><constant>PILOT_AUTO</constant></entry>
<entry align="char">Autodetect pilot tones</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</section>
<section id="DTV-ROLLOFF">

View File

@ -399,11 +399,13 @@ struct dvb_frontend_event {
#define DTV_MAX_COMMAND DTV_STAT_TOTAL_BLOCK_COUNT
typedef enum fe_pilot {
enum fe_pilot {
PILOT_ON,
PILOT_OFF,
PILOT_AUTO,
} fe_pilot_t;
};
typedef enum fe_pilot fe_pilot_t;
typedef enum fe_rolloff {
ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */