leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[media] DocBook: improve documentation for guard interval

Browse Source 
Format it as a table and add more details, in special for
DTMB guard intervals.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Mauro Carvalho Chehab
2015-05-28 22:01:41 -03:00
parent 2d457b8a90
commit 903142e53c
4 changed files with 57 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -818,21 +818,59 @@ typedef enum atscmh_sccc_code_mode {
<title><constant>DTV_GUARD_INTERVAL</constant></title> <title><constant>DTV_GUARD_INTERVAL</constant></title>
<para>Possible values are:</para> <para>Possible values are:</para>
<programlisting>
typedef enum fe_guard_interval { <section id="fe-guard-interval-t">
GUARD_INTERVAL_1_32, <title>Modulation guard interval</title>
GUARD_INTERVAL_1_16,
GUARD_INTERVAL_1_8, <table pgwide="1" frame="none" id="fe-guard-interval">
GUARD_INTERVAL_1_4, <title>enum fe_guard_interval</title>
GUARD_INTERVAL_AUTO, <tgroup cols="2">
GUARD_INTERVAL_1_128, &cs-def;
GUARD_INTERVAL_19_128, <thead>
GUARD_INTERVAL_19_256, <row>
GUARD_INTERVAL_PN420, <entry>ID</entry>
GUARD_INTERVAL_PN595, <entry>Description</entry>
GUARD_INTERVAL_PN945, </row>
} fe_guard_interval_t; </thead>
</programlisting> <tbody valign="top">
<row>
<entry>GUARD_INTERVAL_AUTO</entry>
<entry>Autodetect the guard interval</entry>
</row><row>
<entry>GUARD_INTERVAL_1_128</entry>
<entry>Guard interval 1/128</entry>
</row><row>
<entry>GUARD_INTERVAL_1_32</entry>
<entry>Guard interval 1/32</entry>
</row><row>
<entry>GUARD_INTERVAL_1_16</entry>
<entry>Guard interval 1/16</entry>
</row><row>
<entry>GUARD_INTERVAL_1_8</entry>
<entry>Guard interval 1/8</entry>
</row><row>
<entry>GUARD_INTERVAL_1_4</entry>
<entry>Guard interval 1/4</entry>
</row><row>
<entry>GUARD_INTERVAL_19_128</entry>
<entry>Guard interval 19/128</entry>
</row><row>
<entry>GUARD_INTERVAL_19_256</entry>
<entry>Guard interval 19/256</entry>
</row><row>
<entry>GUARD_INTERVAL_PN420</entry>
<entry>PN length 420 (1/4)</entry>
</row><row>
<entry>GUARD_INTERVAL_PN595</entry>
<entry>PN length 595 (1/6)</entry>
</row><row>
<entry>GUARD_INTERVAL_PN945</entry>
<entry>PN length 945 (1/9)</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<para>Notes:</para> <para>Notes:</para>
<para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will

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

@@ -59,22 +59,6 @@ specification is available at
<section> <section>
<title>More OFDM parameters</title> <title>More OFDM parameters</title>
<section id="fe-guard-interval-t">
<title>frontend guard inverval</title>
<programlisting>
typedef enum fe_guard_interval {
GUARD_INTERVAL_1_32,
GUARD_INTERVAL_1_16,
GUARD_INTERVAL_1_8,
GUARD_INTERVAL_1_4,
GUARD_INTERVAL_AUTO,
GUARD_INTERVAL_1_128,
GUARD_INTERVAL_19_128,
GUARD_INTERVAL_19_256,
} fe_guard_interval_t;
</programlisting>
</section>
<section id="fe-hierarchy-t"> <section id="fe-hierarchy-t">
<title>frontend hierarchy</title> <title>frontend hierarchy</title>
<programlisting> <programlisting>

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

@@ -182,7 +182,7 @@ struct dvb_vsb_parameters {
&fe-code-rate-t; code_rate_LP; /&#x22C6; low priority stream code rate &#x22C6;/ &fe-code-rate-t; code_rate_LP; /&#x22C6; low priority stream code rate &#x22C6;/
&fe-modulation-t; constellation; /&#x22C6; modulation type (see above) &#x22C6;/ &fe-modulation-t; constellation; /&#x22C6; modulation type (see above) &#x22C6;/
&fe-transmit-mode-t; transmission_mode; &fe-transmit-mode-t; transmission_mode;
fe_guard_interval_t guard_interval; &fe-guard-interval-t; guard_interval;
fe_hierarchy_t hierarchy_information; fe_hierarchy_t hierarchy_information;
}; };
</programlisting> </programlisting>

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

@@ -228,7 +228,7 @@ enum fe_bandwidth {
typedef enum fe_bandwidth fe_bandwidth_t; typedef enum fe_bandwidth fe_bandwidth_t;
#endif #endif
typedef enum fe_guard_interval { enum fe_guard_interval {
GUARD_INTERVAL_1_32, GUARD_INTERVAL_1_32,
GUARD_INTERVAL_1_16, GUARD_INTERVAL_1_16,
GUARD_INTERVAL_1_8, GUARD_INTERVAL_1_8,
@@ -240,8 +240,9 @@ typedef enum fe_guard_interval {
GUARD_INTERVAL_PN420, GUARD_INTERVAL_PN420,
GUARD_INTERVAL_PN595, GUARD_INTERVAL_PN595,
GUARD_INTERVAL_PN945, GUARD_INTERVAL_PN945,
} fe_guard_interval_t; };
typedef enum fe_guard_interval fe_guard_interval_t;
typedef enum fe_hierarchy { typedef enum fe_hierarchy {
HIERARCHY_NONE, HIERARCHY_NONE,