diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-06-07 15:58:00 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-07-27 16:52:41 -0400 |
commit | 95e61e01888d207b2ffd1ef709466c5144534121 (patch) | |
tree | 5a4341b459459df7cb50ce0a242d14f7558a943b /Documentation | |
parent | d5dc2dee5030564ef3228d3a2647d4c25c84fedf (diff) |
[media] DocBook/frontend.xml: Link DVB S2API parameters
Associate the frontend.h DVB S2API parmeters to the corresponding
documentation at the spec.
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/DocBook/media/Makefile | 2 | ||||
-rw-r--r-- | Documentation/DocBook/media/dvb/dvbproperty.xml | 34 |
2 files changed, 19 insertions, 17 deletions
diff --git a/Documentation/DocBook/media/Makefile b/Documentation/DocBook/media/Makefile index 34afc545ddeb..30360709ace8 100644 --- a/Documentation/DocBook/media/Makefile +++ b/Documentation/DocBook/media/Makefile | |||
@@ -124,7 +124,9 @@ DVB_DOCUMENTED = \ | |||
124 | -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \ | 124 | -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \ |
125 | -e "s,\(struct\s\+\)\([a-z0-9_]\+\)\(\s\+{\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ | 125 | -e "s,\(struct\s\+\)\([a-z0-9_]\+\)\(\s\+{\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ |
126 | -e "s,\(}\s\+\)\([a-z0-9_]\+_t\+\),\1\<link linkend=\"\2\">\2\<\/link\>,g" \ | 126 | -e "s,\(}\s\+\)\([a-z0-9_]\+_t\+\),\1\<link linkend=\"\2\">\2\<\/link\>,g" \ |
127 | -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ | ||
127 | -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \ | 128 | -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \ |
129 | -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \ | ||
128 | # -e "s,\(\s\+\)\(FE_[A-Z0-9_]\+\)\([\s\=\,]*\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ | 130 | # -e "s,\(\s\+\)\(FE_[A-Z0-9_]\+\)\([\s\=\,]*\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ |
129 | 131 | ||
130 | # | 132 | # |
diff --git a/Documentation/DocBook/media/dvb/dvbproperty.xml b/Documentation/DocBook/media/dvb/dvbproperty.xml index b5365f61d69b..3a1ecb2ba632 100644 --- a/Documentation/DocBook/media/dvb/dvbproperty.xml +++ b/Documentation/DocBook/media/dvb/dvbproperty.xml | |||
@@ -199,7 +199,7 @@ get/set up to 64 properties. The actual meaning of each property is described on | |||
199 | 199 | ||
200 | <section id="fe_property_common"> | 200 | <section id="fe_property_common"> |
201 | <title>Parameters that are common to all Digital TV standards</title> | 201 | <title>Parameters that are common to all Digital TV standards</title> |
202 | <section id="DTV_FREQUENCY"> | 202 | <section id="DTV-FREQUENCY"> |
203 | <title><constant>DTV_FREQUENCY</constant></title> | 203 | <title><constant>DTV_FREQUENCY</constant></title> |
204 | 204 | ||
205 | <para>Central frequency of the channel, in HZ.</para> | 205 | <para>Central frequency of the channel, in HZ.</para> |
@@ -214,7 +214,7 @@ get/set up to 64 properties. The actual meaning of each property is described on | |||
214 | central frequency of the channel is expected.</para> | 214 | central frequency of the channel is expected.</para> |
215 | </section> | 215 | </section> |
216 | 216 | ||
217 | <section id="DTV_BANDWIDTH_HZ"> | 217 | <section id="DTV-BANDWIDTH-HZ"> |
218 | <title><constant>DTV_BANDWIDTH_HZ</constant></title> | 218 | <title><constant>DTV_BANDWIDTH_HZ</constant></title> |
219 | 219 | ||
220 | <para>Bandwidth for the channel, in HZ.</para> | 220 | <para>Bandwidth for the channel, in HZ.</para> |
@@ -241,7 +241,7 @@ get/set up to 64 properties. The actual meaning of each property is described on | |||
241 | <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para> | 241 | <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para> |
242 | </section> | 242 | </section> |
243 | 243 | ||
244 | <section id="DTV_DELIVERY_SYSTEM"> | 244 | <section id="DTV-DELIVERY-SYSTEM"> |
245 | <title><constant>DTV_DELIVERY_SYSTEM</constant></title> | 245 | <title><constant>DTV_DELIVERY_SYSTEM</constant></title> |
246 | 246 | ||
247 | <para>Specifies the type of Delivery system</para> | 247 | <para>Specifies the type of Delivery system</para> |
@@ -271,7 +271,7 @@ typedef enum fe_delivery_system { | |||
271 | 271 | ||
272 | </section> | 272 | </section> |
273 | 273 | ||
274 | <section id="DTV_TRANSMISSION_MODE"> | 274 | <section id="DTV-TRANSMISSION-MODE"> |
275 | <title><constant>DTV_TRANSMISSION_MODE</constant></title> | 275 | <title><constant>DTV_TRANSMISSION_MODE</constant></title> |
276 | 276 | ||
277 | <para>Specifies the number of carriers used by the standard</para> | 277 | <para>Specifies the number of carriers used by the standard</para> |
@@ -300,7 +300,7 @@ typedef enum fe_transmit_mode { | |||
300 | <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para> | 300 | <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para> |
301 | </section> | 301 | </section> |
302 | 302 | ||
303 | <section id="DTV_GUARD_INTERVAL"> | 303 | <section id="DTV-GUARD-INTERVAL"> |
304 | <title><constant>DTV_GUARD_INTERVAL</constant></title> | 304 | <title><constant>DTV_GUARD_INTERVAL</constant></title> |
305 | 305 | ||
306 | <para>Possible values are:</para> | 306 | <para>Possible values are:</para> |
@@ -359,10 +359,10 @@ typedef enum fe_guard_interval { | |||
359 | <section id="isdbt-new-parms"> | 359 | <section id="isdbt-new-parms"> |
360 | <title>ISDB-T only parameters</title> | 360 | <title>ISDB-T only parameters</title> |
361 | 361 | ||
362 | <section id="isdbt-part-rec"> | 362 | <section id="DTV-ISDBT-PARTIAL-RECEPTION"> |
363 | <title><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></title> | 363 | <title><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></title> |
364 | 364 | ||
365 | <para><constant>If DTV_ISDBT_SOUND_BROADCASTING</constant> is '0' this bit-field represents whether | 365 | <para>If <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '0' this bit-field represents whether |
366 | the channel is in partial reception mode or not.</para> | 366 | the channel is in partial reception mode or not.</para> |
367 | 367 | ||
368 | <para>If '1' <constant>DTV_ISDBT_LAYERA_*</constant> values are assigned to the center segment and | 368 | <para>If '1' <constant>DTV_ISDBT_LAYERA_*</constant> values are assigned to the center segment and |
@@ -375,7 +375,7 @@ typedef enum fe_guard_interval { | |||
375 | <para>Possible values: 0, 1, -1 (AUTO)</para> | 375 | <para>Possible values: 0, 1, -1 (AUTO)</para> |
376 | </section> | 376 | </section> |
377 | 377 | ||
378 | <section id="isdbt-sound-bcast"> | 378 | <section id="DTV-ISDBT-SOUND-BROADCASTING"> |
379 | <title><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></title> | 379 | <title><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></title> |
380 | 380 | ||
381 | <para>This field represents whether the other DTV_ISDBT_*-parameters are | 381 | <para>This field represents whether the other DTV_ISDBT_*-parameters are |
@@ -385,7 +385,7 @@ typedef enum fe_guard_interval { | |||
385 | <para>Possible values: 0, 1, -1 (AUTO)</para> | 385 | <para>Possible values: 0, 1, -1 (AUTO)</para> |
386 | </section> | 386 | </section> |
387 | 387 | ||
388 | <section id="isdbt-sb-ch-id"> | 388 | <section id="DTV-ISDBT-SB-SUBCHANNEL-ID"> |
389 | <title><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></title> | 389 | <title><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></title> |
390 | 390 | ||
391 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> | 391 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> |
@@ -418,7 +418,7 @@ typedef enum fe_guard_interval { | |||
418 | <para>Possible values: 0 .. 41, -1 (AUTO)</para> | 418 | <para>Possible values: 0 .. 41, -1 (AUTO)</para> |
419 | </section> | 419 | </section> |
420 | 420 | ||
421 | <section id="isdbt-sb-seg-idx"> | 421 | <section id="DTV-ISDBT-SB-SEGMENT-IDX"> |
422 | 422 | ||
423 | <title><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></title> | 423 | <title><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></title> |
424 | 424 | ||
@@ -433,7 +433,7 @@ typedef enum fe_guard_interval { | |||
433 | <para>Note: This value cannot be determined by an automatic channel search.</para> | 433 | <para>Note: This value cannot be determined by an automatic channel search.</para> |
434 | </section> | 434 | </section> |
435 | 435 | ||
436 | <section id="isdbt-sb-seg-cnt"> | 436 | <section id="DTV-ISDBT-SB-SEGMENT-COUNT"> |
437 | <title><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></title> | 437 | <title><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></title> |
438 | 438 | ||
439 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> | 439 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> |
@@ -457,7 +457,7 @@ typedef enum fe_guard_interval { | |||
457 | available segments. The total number of segments over all layers has | 457 | available segments. The total number of segments over all layers has |
458 | to 13 in ISDB-T.</para> | 458 | to 13 in ISDB-T.</para> |
459 | 459 | ||
460 | <section id="isdbt-layer-ena"> | 460 | <section id="DTV-ISDBT-LAYER-ENABLED"> |
461 | <title><constant>DTV_ISDBT_LAYER_ENABLED</constant></title> | 461 | <title><constant>DTV_ISDBT_LAYER_ENABLED</constant></title> |
462 | 462 | ||
463 | <para>Hierarchical reception in ISDB-T is achieved by enabling or disabling | 463 | <para>Hierarchical reception in ISDB-T is achieved by enabling or disabling |
@@ -482,13 +482,13 @@ typedef enum fe_guard_interval { | |||
482 | <para><constant>DTV_ISDBT_LAYER_ENABLED[31:3]</constant> unused</para> | 482 | <para><constant>DTV_ISDBT_LAYER_ENABLED[31:3]</constant> unused</para> |
483 | </section> | 483 | </section> |
484 | 484 | ||
485 | <section id="isdbt-layer-fec"> | 485 | <section id="DTV-ISDBT-LAYER-FEC"> |
486 | <title><constant>DTV_ISDBT_LAYER*_FEC</constant></title> | 486 | <title><constant>DTV_ISDBT_LAYER*_FEC</constant></title> |
487 | 487 | ||
488 | <para>Possible values: <constant>FEC_AUTO</constant>, <constant>FEC_1_2</constant>, <constant>FEC_2_3</constant>, <constant>FEC_3_4</constant>, <constant>FEC_5_6</constant>, <constant>FEC_7_8</constant></para> | 488 | <para>Possible values: <constant>FEC_AUTO</constant>, <constant>FEC_1_2</constant>, <constant>FEC_2_3</constant>, <constant>FEC_3_4</constant>, <constant>FEC_5_6</constant>, <constant>FEC_7_8</constant></para> |
489 | </section> | 489 | </section> |
490 | 490 | ||
491 | <section id="isdbt-layer-mod"> | 491 | <section id="DTV-ISDBT-LAYER-MODULATION"> |
492 | <title><constant>DTV_ISDBT_LAYER*_MODULATION</constant></title> | 492 | <title><constant>DTV_ISDBT_LAYER*_MODULATION</constant></title> |
493 | 493 | ||
494 | <para>Possible values: <constant>QAM_AUTO</constant>, QP<constant>SK, QAM_16</constant>, <constant>QAM_64</constant>, <constant>DQPSK</constant></para> | 494 | <para>Possible values: <constant>QAM_AUTO</constant>, QP<constant>SK, QAM_16</constant>, <constant>QAM_64</constant>, <constant>DQPSK</constant></para> |
@@ -497,7 +497,7 @@ typedef enum fe_guard_interval { | |||
497 | and <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>=0 layer has to be <constant>DQPSK</constant>.</para> | 497 | and <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>=0 layer has to be <constant>DQPSK</constant>.</para> |
498 | </section> | 498 | </section> |
499 | 499 | ||
500 | <section id="isdbt-layer-seg-cnt"> | 500 | <section id="DTV-ISDBT-LAYER-SEGMENT-COUNT"> |
501 | <title><constant>DTV_ISDBT_LAYER*_SEGMENT_COUNT</constant></title> | 501 | <title><constant>DTV_ISDBT_LAYER*_SEGMENT_COUNT</constant></title> |
502 | 502 | ||
503 | <para>Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)</para> | 503 | <para>Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)</para> |
@@ -560,7 +560,7 @@ typedef enum fe_guard_interval { | |||
560 | 560 | ||
561 | </section> | 561 | </section> |
562 | 562 | ||
563 | <section id="isdbt_layer_t_interl"> | 563 | <section id="DTV-ISDBT-LAYER-TIME-INTERLEAVING"> |
564 | <title><constant>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</constant></title> | 564 | <title><constant>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</constant></title> |
565 | 565 | ||
566 | <para>Possible values: 0, 1, 2, 3, -1 (AUTO)</para> | 566 | <para>Possible values: 0, 1, 2, 3, -1 (AUTO)</para> |
@@ -578,7 +578,7 @@ typedef enum fe_guard_interval { | |||
578 | support is currently in the early stages development so expect this section to grow | 578 | support is currently in the early stages development so expect this section to grow |
579 | and become more detailed with time.</para> | 579 | and become more detailed with time.</para> |
580 | 580 | ||
581 | <section id="dvbt2-plp-id"> | 581 | <section id="DTV-DVBT2-PLP-ID"> |
582 | <title><constant>DTV_DVBT2_PLP_ID</constant></title> | 582 | <title><constant>DTV_DVBT2_PLP_ID</constant></title> |
583 | 583 | ||
584 | <para>DVB-T2 supports Physical Layer Pipes (PLP) to allow transmission of | 584 | <para>DVB-T2 supports Physical Layer Pipes (PLP) to allow transmission of |