diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-06-07 18:15:19 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-07-27 17:52:44 -0300 |
commit | 0be153efb18141162bcaa8ea3de6b94d2d92397e (patch) | |
tree | 89b7e0c18b3d8c3ee293099295eaf1a1e93cba6d /Documentation | |
parent | 6cb77a85aaf317e0b6e513f70eca6ebe34f9cdf0 (diff) |
[media] DocBook/frontend.xml: Better describe the frontend parameters
Update the DVB parameter structs to reflect VSB modulation and
improve a few descriptions.
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/DocBook/media/dvb/frontend.xml | 33 |
1 files changed, 19 insertions, 14 deletions
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml index a925b4507ce..b1f01239d4d 100644 --- a/Documentation/DocBook/media/dvb/frontend.xml +++ b/Documentation/DocBook/media/dvb/frontend.xml @@ -262,6 +262,15 @@ OFDM frontends the <constant>frequency</constant> specifies the absolute frequen }; </programlisting> </section> +<section id="dvb-vsb-parameters"> +<title>VSB parameters</title> +<para>DVB-T frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para> +<programlisting> +struct dvb_vsb_parameters { + fe_modulation_t modulation; /⋆ modulation type (see above) ⋆/ +}; +</programlisting> +</section> <section id="dvb-ofdm-parameters"> <title>OFDM parameters</title> <para>DVB-T frontends are supported by the <constant>dvb_ofdm_parameters</constant> structure:</para> @@ -277,15 +286,6 @@ OFDM frontends the <constant>frequency</constant> specifies the absolute frequen }; </programlisting> </section> -<section id="dvb-vsb-parameters"> -<title>VSB parameters</title> -<para>DVB-T frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para> -<programlisting> -struct dvb_vsb_parameters { - fe_modulation_t modulation; /⋆ modulation type (see above) ⋆/ -}; -</programlisting> -</section> <section id="fe-spectral-inversion-t"> <title>frontend spectral inversion</title> <para>The Inversion field can take one of these values: @@ -304,7 +304,9 @@ itself. </section> <section id="fe-code-rate-t"> <title>frontend code rate</title> -<para>The possible values for the <constant>FEC_inner</constant> field are +<para>The possible values for the <constant>fec_inner</constant> field used on +<link refend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and +<link refend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are: </para> <programlisting> typedef enum fe_code_rate { @@ -327,9 +329,12 @@ detection. </para> </section> <section id="fe-modulation-t"> -<title>frontend modulation type for QAM and OFDM</title> -<para>For cable and terrestrial frontends (QAM and OFDM) one also has to specify the quadrature -modulation mode which can be one of the following: +<title>frontend modulation type for QAM, OFDM and VSB</title> +<para>For cable and terrestrial frontends, e. g. for +<link refend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>, +<link refend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and +<link refend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>, +it needs to specify the quadrature modulation mode which can be one of the following: </para> <programlisting> typedef enum fe_modulation { @@ -352,7 +357,7 @@ modulation mode which can be one of the following: <para>Finally, there are several more parameters for OFDM: </para> <section id="fe-transmit-mode-t"> -<title>Number of carriers per channel, on OFTM modulation</title> +<title>Number of carriers per channel</title> <programlisting> typedef enum fe_transmit_mode { TRANSMISSION_MODE_2K, |