diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-06-07 17:15:19 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-07-27 16:52:44 -0400 |
commit | 0be153efb18141162bcaa8ea3de6b94d2d92397e (patch) | |
tree | 89b7e0c18b3d8c3ee293099295eaf1a1e93cba6d /Documentation/DocBook/media/dvb/frontend.xml | |
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/DocBook/media/dvb/frontend.xml')
-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 a925b4507cef..b1f01239d4da 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 | |||
262 | }; | 262 | }; |
263 | </programlisting> | 263 | </programlisting> |
264 | </section> | 264 | </section> |
265 | <section id="dvb-vsb-parameters"> | ||
266 | <title>VSB parameters</title> | ||
267 | <para>DVB-T frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para> | ||
268 | <programlisting> | ||
269 | struct dvb_vsb_parameters { | ||
270 | fe_modulation_t modulation; /⋆ modulation type (see above) ⋆/ | ||
271 | }; | ||
272 | </programlisting> | ||
273 | </section> | ||
265 | <section id="dvb-ofdm-parameters"> | 274 | <section id="dvb-ofdm-parameters"> |
266 | <title>OFDM parameters</title> | 275 | <title>OFDM parameters</title> |
267 | <para>DVB-T frontends are supported by the <constant>dvb_ofdm_parameters</constant> structure:</para> | 276 | <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 | |||
277 | }; | 286 | }; |
278 | </programlisting> | 287 | </programlisting> |
279 | </section> | 288 | </section> |
280 | <section id="dvb-vsb-parameters"> | ||
281 | <title>VSB parameters</title> | ||
282 | <para>DVB-T frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para> | ||
283 | <programlisting> | ||
284 | struct dvb_vsb_parameters { | ||
285 | fe_modulation_t modulation; /⋆ modulation type (see above) ⋆/ | ||
286 | }; | ||
287 | </programlisting> | ||
288 | </section> | ||
289 | <section id="fe-spectral-inversion-t"> | 289 | <section id="fe-spectral-inversion-t"> |
290 | <title>frontend spectral inversion</title> | 290 | <title>frontend spectral inversion</title> |
291 | <para>The Inversion field can take one of these values: | 291 | <para>The Inversion field can take one of these values: |
@@ -304,7 +304,9 @@ itself. | |||
304 | </section> | 304 | </section> |
305 | <section id="fe-code-rate-t"> | 305 | <section id="fe-code-rate-t"> |
306 | <title>frontend code rate</title> | 306 | <title>frontend code rate</title> |
307 | <para>The possible values for the <constant>FEC_inner</constant> field are | 307 | <para>The possible values for the <constant>fec_inner</constant> field used on |
308 | <link refend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and | ||
309 | <link refend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are: | ||
308 | </para> | 310 | </para> |
309 | <programlisting> | 311 | <programlisting> |
310 | typedef enum fe_code_rate { | 312 | typedef enum fe_code_rate { |
@@ -327,9 +329,12 @@ detection. | |||
327 | </para> | 329 | </para> |
328 | </section> | 330 | </section> |
329 | <section id="fe-modulation-t"> | 331 | <section id="fe-modulation-t"> |
330 | <title>frontend modulation type for QAM and OFDM</title> | 332 | <title>frontend modulation type for QAM, OFDM and VSB</title> |
331 | <para>For cable and terrestrial frontends (QAM and OFDM) one also has to specify the quadrature | 333 | <para>For cable and terrestrial frontends, e. g. for |
332 | modulation mode which can be one of the following: | 334 | <link refend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>, |
335 | <link refend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and | ||
336 | <link refend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>, | ||
337 | it needs to specify the quadrature modulation mode which can be one of the following: | ||
333 | </para> | 338 | </para> |
334 | <programlisting> | 339 | <programlisting> |
335 | typedef enum fe_modulation { | 340 | typedef enum fe_modulation { |
@@ -352,7 +357,7 @@ modulation mode which can be one of the following: | |||
352 | <para>Finally, there are several more parameters for OFDM: | 357 | <para>Finally, there are several more parameters for OFDM: |
353 | </para> | 358 | </para> |
354 | <section id="fe-transmit-mode-t"> | 359 | <section id="fe-transmit-mode-t"> |
355 | <title>Number of carriers per channel, on OFTM modulation</title> | 360 | <title>Number of carriers per channel</title> |
356 | <programlisting> | 361 | <programlisting> |
357 | typedef enum fe_transmit_mode { | 362 | typedef enum fe_transmit_mode { |
358 | TRANSMISSION_MODE_2K, | 363 | TRANSMISSION_MODE_2K, |