diff options
| author | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-05-29 03:01:41 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-05-30 16:10:05 +0200 |
| commit | 903142e53c648ee61c00f5c3b420b16bc6336ad7 (patch) | |
| tree | 615e3bc16869f4acac868d73d04c158b581d43d8 /Documentation/DocBook | |
| parent | [media] DocBook: improve documentation for FEC fields (diff) | |
| download | linux-903142e53c648ee61c00f5c3b420b16bc6336ad7.tar.xz linux-903142e53c648ee61c00f5c3b420b16bc6336ad7.zip | |
[media] DocBook: improve documentation for guard interval
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>
Diffstat (limited to 'Documentation/DocBook')
| -rw-r--r-- | Documentation/DocBook/media/dvb/dvbproperty.xml | 68 | ||||
| -rw-r--r-- | Documentation/DocBook/media/dvb/frontend.xml | 16 | ||||
| -rw-r--r-- | Documentation/DocBook/media/dvb/frontend_legacy_api.xml | 2 |
3 files changed, 54 insertions, 32 deletions
diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml index b96a91a1494d..5f30a28a15b0 100644 --- a/Documentation/DocBook/media/dvb/dvbproperty.xml +++ b/Documentation/DocBook/media/dvb/dvbproperty.xml @@ -818,21 +818,59 @@ typedef enum atscmh_sccc_code_mode { <title><constant>DTV_GUARD_INTERVAL</constant></title> <para>Possible values are:</para> -<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, - GUARD_INTERVAL_PN420, - GUARD_INTERVAL_PN595, - GUARD_INTERVAL_PN945, -} fe_guard_interval_t; -</programlisting> + +<section id="fe-guard-interval-t"> +<title>Modulation guard interval</title> + +<table pgwide="1" frame="none" id="fe-guard-interval"> + <title>enum fe_guard_interval</title> + <tgroup cols="2"> + &cs-def; + <thead> + <row> + <entry>ID</entry> + <entry>Description</entry> + </row> + </thead> + <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>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index 563800eb1216..a005c4b472f5 100644 --- a/Documentation/DocBook/media/dvb/frontend.xml +++ b/Documentation/DocBook/media/dvb/frontend.xml @@ -59,22 +59,6 @@ specification is available at <section> <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"> <title>frontend hierarchy</title> <programlisting> diff --git a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml index c1dfbd8096bd..d20f1fd75fa9 100644 --- a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml +++ b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml @@ -182,7 +182,7 @@ struct dvb_vsb_parameters { &fe-code-rate-t; code_rate_LP; /⋆ low priority stream code rate ⋆/ &fe-modulation-t; constellation; /⋆ modulation type (see above) ⋆/ &fe-transmit-mode-t; transmission_mode; - fe_guard_interval_t guard_interval; + &fe-guard-interval-t; guard_interval; fe_hierarchy_t hierarchy_information; }; </programlisting> |