openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

[media] DocBook: improve documentation for hierarchy 

Format it as a table and links it with the legacy API xml.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab 2015-05-28 22:06:56 -03:00
parent 903142e53c
commit 9df4fc5b8f
4 changed files with 42 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
Documentation/DocBook/media/dvb/dvbproperty.xml
View File

@ -951,15 +951,43 @@ typedef enum atscmh_sccc_code_mode {
<section id="DTV-HIERARCHY">
<title><constant>DTV_HIERARCHY</constant></title>
<para>Frontend hierarchy</para>
<programlisting>
typedef enum fe_hierarchy {
HIERARCHY_NONE,
HIERARCHY_1,
HIERARCHY_2,
HIERARCHY_4,
HIERARCHY_AUTO
} fe_hierarchy_t;
</programlisting>
<section id="fe-hierarchy-t">
<title>Frontend hierarchy</title>
<table pgwide="1" frame="none" id="fe-hierarchy">
<title>enum fe_hierarchy</title>
<tgroup cols="2">
&cs-def;
<thead>
<row>
<entry>ID</entry>
<entry>Description</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry>HIERARCHY_NONE</entry>
<entry>No hierarchy</entry>
</row><row>
<entry>HIERARCHY_AUTO</entry>
<entry>Autodetect hierarchy (if supported)</entry>
</row><row>
<entry>HIERARCHY_1</entry>
<entry>Hierarchy 1</entry>
</row><row>
<entry>HIERARCHY_2</entry>
<entry>Hierarchy 2</entry>
</row><row>
<entry>HIERARCHY_4</entry>
<entry>Hierarchy 4</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</section>
<section id="DTV-STREAM-ID">
<title><constant>DTV_STREAM_ID</constant></title>

18
Documentation/DocBook/media/dvb/frontend.xml
View File

@ -56,24 +56,6 @@ specification is available at
&sub-dvbproperty;
<section>
<title>More OFDM parameters</title>
<section id="fe-hierarchy-t">
<title>frontend hierarchy</title>
<programlisting>
typedef enum fe_hierarchy {
HIERARCHY_NONE,
HIERARCHY_1,
HIERARCHY_2,
HIERARCHY_4,
HIERARCHY_AUTO
} fe_hierarchy_t;
</programlisting>
</section>
</section>
<section id="frontend_fcalls">
<title>Frontend Function Calls</title>

2
Documentation/DocBook/media/dvb/frontend_legacy_api.xml
View File

@ -183,7 +183,7 @@ struct dvb_vsb_parameters {
&fe-modulation-t; constellation; /&#x22C6; modulation type (see above) &#x22C6;/
&fe-transmit-mode-t; transmission_mode;
&fe-guard-interval-t; guard_interval;
fe_hierarchy_t hierarchy_information;
&fe-hierarchy-t; hierarchy_information;
};
</programlisting>
</section>

6
include/uapi/linux/dvb/frontend.h
View File

@ -244,13 +244,15 @@ enum fe_guard_interval {
typedef enum fe_guard_interval fe_guard_interval_t;
typedef enum fe_hierarchy {
enum fe_hierarchy {
HIERARCHY_NONE,
HIERARCHY_1,
HIERARCHY_2,
HIERARCHY_4,
HIERARCHY_AUTO
} fe_hierarchy_t;
};
typedef enum fe_hierarchy fe_hierarchy_t;
enum fe_interleaving {
INTERLEAVING_NONE,