diff options
author | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-05-28 20:52:52 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@osg.samsung.com> | 2015-05-30 11:04:05 -0300 |
commit | 0577a2f6d84a08da96c908a885db16b4d3532dc4 (patch) | |
tree | 2ddfea86a841468af857ae3c9ef6e8405043a5df /Documentation/DocBook | |
parent | 58e11cc3c1f7d7e9fa70ba6c3d363456151fcffd (diff) | |
download | linux-0577a2f6d84a08da96c908a885db16b4d3532dc4.tar.gz linux-0577a2f6d84a08da96c908a885db16b4d3532dc4.tar.bz2 linux-0577a2f6d84a08da96c908a885db16b4d3532dc4.zip |
[media] DocBook: improve documentation for OFDM transmission mode
Format it as a table and add more details, in special, for
the DTMB modes.
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/media/dvb/dvbproperty.xml | 69 | ||||
-rw-r--r-- | Documentation/DocBook/media/dvb/frontend.xml | 15 | ||||
-rw-r--r-- | Documentation/DocBook/media/dvb/frontend_legacy_api.xml | 2 |
3 files changed, 55 insertions, 31 deletions
diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml index 41085537acfc..06a12f1c57c5 100644 --- a/Documentation/DocBook/media/dvb/dvbproperty.xml +++ b/Documentation/DocBook/media/dvb/dvbproperty.xml @@ -827,22 +827,61 @@ typedef enum fe_guard_interval { <section id="DTV-TRANSMISSION-MODE"> <title><constant>DTV_TRANSMISSION_MODE</constant></title> - <para>Specifies the number of carriers used by the standard</para> + <para>Specifies the number of carriers used by the standard. + This is used only on OFTM-based standards, e. g. + DVB-T/T2, ISDB-T, DTMB</para> + +<section id="fe-transmit-mode-t"> +<title>enum fe_transmit_mode: Number of carriers per channel</title> + +<table pgwide="1" frame="none" id="fe-transmit-mode"> + <title>enum fe_transmit_mode</title> + <tgroup cols="2"> + &cs-def; + <thead> + <row> + <entry>ID</entry> + <entry>Description</entry> + </row> + </thead> + <tbody valign="top"> + <row> + <entry>TRANSMISSION_MODE_AUTO</entry> + <entry>Autodetect transmission mode. The hardware will try to find + the correct FFT-size (if capable) to fill in the missing + parameters.</entry> + </row><row> + <entry>TRANSMISSION_MODE_1K</entry> + <entry>Transmission mode 1K</entry> + </row><row> + <entry>TRANSMISSION_MODE_2K</entry> + <entry>Transmission mode 2K</entry> + </row><row> + <entry>TRANSMISSION_MODE_8K</entry> + <entry>Transmission mode 8K</entry> + </row><row> + <entry>TRANSMISSION_MODE_4K</entry> + <entry>Transmission mode 4K</entry> + </row><row> + <entry>TRANSMISSION_MODE_16K</entry> + <entry>Transmission mode 16K</entry> + </row><row> + <entry>TRANSMISSION_MODE_32K</entry> + <entry>Transmission mode 32K</entry> + </row><row> + <entry>TRANSMISSION_MODE_C1</entry> + <entry>Single Carrier (C=1) transmission mode (DTMB)</entry> + </row><row> + <entry>TRANSMISSION_MODE_C3780</entry> + <entry>Multi Carrier (C=3780) transmission mode (DTMB)</entry> + </row><row> + </row> + </tbody> + </tgroup> +</table> +</section> + - <para>Possible values are:</para> -<programlisting> -typedef enum fe_transmit_mode { - TRANSMISSION_MODE_2K, - TRANSMISSION_MODE_8K, - TRANSMISSION_MODE_AUTO, - TRANSMISSION_MODE_4K, - TRANSMISSION_MODE_1K, - TRANSMISSION_MODE_16K, - TRANSMISSION_MODE_32K, - TRANSMISSION_MODE_C1, - TRANSMISSION_MODE_C3780, -} fe_transmit_mode_t; -</programlisting> <para>Notes:</para> <para>1) ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called 'mode' in the standard: Mode 1 is 2K, mode 2 is 4K, mode 3 is 8K</para> diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index 77dd88ceeedd..3b6a169ac8f3 100644 --- a/Documentation/DocBook/media/dvb/frontend.xml +++ b/Documentation/DocBook/media/dvb/frontend.xml @@ -87,21 +87,6 @@ detection. <section> <title>More OFDM parameters</title> -<section id="fe-transmit-mode-t"> -<title>Number of carriers per channel</title> -<programlisting> -typedef enum fe_transmit_mode { - TRANSMISSION_MODE_2K, - TRANSMISSION_MODE_8K, - TRANSMISSION_MODE_AUTO, - TRANSMISSION_MODE_4K, - TRANSMISSION_MODE_1K, - TRANSMISSION_MODE_16K, - TRANSMISSION_MODE_32K, - } fe_transmit_mode_t; -</programlisting> -</section> - <section id="fe-bandwidth-t"> <title>frontend bandwidth</title> <programlisting> diff --git a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml index fe1117e91f51..fa0c6649abfd 100644 --- a/Documentation/DocBook/media/dvb/frontend_legacy_api.xml +++ b/Documentation/DocBook/media/dvb/frontend_legacy_api.xml @@ -139,7 +139,7 @@ struct dvb_vsb_parameters { fe_code_rate_t code_rate_HP; /⋆ high priority stream code rate ⋆/ 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-transmit-mode-t; transmission_mode; fe_guard_interval_t guard_interval; fe_hierarchy_t hierarchy_information; }; |