From 95e61e01888d207b2ffd1ef709466c5144534121 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 7 Jun 2011 16:58:00 -0300 Subject: [PATCH] [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 --- Documentation/DocBook/media/Makefile | 2 ++ .../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 = \ -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \ -e "s,\(struct\s\+\)\([a-z0-9_]\+\)\(\s\+{\),\1\\2\<\/link\>\3,g" \ -e "s,\(}\s\+\)\([a-z0-9_]\+_t\+\),\1\\2\<\/link\>,g" \ + -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\\2\<\/link\>\3,g" \ -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \ + -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \ # -e "s,\(\s\+\)\(FE_[A-Z0-9_]\+\)\([\s\=\,]*\),\1\\2\<\/link\>\3,g" \ # 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
Parameters that are common to all Digital TV standards -
+
<constant>DTV_FREQUENCY</constant> Central frequency of the channel, in HZ. @@ -214,7 +214,7 @@ get/set up to 64 properties. The actual meaning of each property is described on central frequency of the channel is expected.
-
+
<constant>DTV_BANDWIDTH_HZ</constant> Bandwidth for the channel, in HZ. @@ -241,7 +241,7 @@ get/set up to 64 properties. The actual meaning of each property is described on 6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.
-
+
<constant>DTV_DELIVERY_SYSTEM</constant> Specifies the type of Delivery system @@ -271,7 +271,7 @@ typedef enum fe_delivery_system {
-
+
<constant>DTV_TRANSMISSION_MODE</constant> Specifies the number of carriers used by the standard @@ -300,7 +300,7 @@ typedef enum fe_transmit_mode { 4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.
-
+
<constant>DTV_GUARD_INTERVAL</constant> Possible values are: @@ -359,10 +359,10 @@ typedef enum fe_guard_interval {
ISDB-T only parameters -
+
<constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> - If DTV_ISDBT_SOUND_BROADCASTING is '0' this bit-field represents whether + If DTV_ISDBT_SOUND_BROADCASTING is '0' this bit-field represents whether the channel is in partial reception mode or not. If '1' DTV_ISDBT_LAYERA_* values are assigned to the center segment and @@ -375,7 +375,7 @@ typedef enum fe_guard_interval { Possible values: 0, 1, -1 (AUTO)
-
+
<constant>DTV_ISDBT_SOUND_BROADCASTING</constant> This field represents whether the other DTV_ISDBT_*-parameters are @@ -385,7 +385,7 @@ typedef enum fe_guard_interval { Possible values: 0, 1, -1 (AUTO)
-
+
<constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant> This field only applies if DTV_ISDBT_SOUND_BROADCASTING is '1'. @@ -418,7 +418,7 @@ typedef enum fe_guard_interval { Possible values: 0 .. 41, -1 (AUTO)
-
+
<constant>DTV_ISDBT_SB_SEGMENT_IDX</constant> @@ -433,7 +433,7 @@ typedef enum fe_guard_interval { Note: This value cannot be determined by an automatic channel search.
-
+
<constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> This field only applies if DTV_ISDBT_SOUND_BROADCASTING is '1'. @@ -457,7 +457,7 @@ typedef enum fe_guard_interval { available segments. The total number of segments over all layers has to 13 in ISDB-T. -
+
<constant>DTV_ISDBT_LAYER_ENABLED</constant> Hierarchical reception in ISDB-T is achieved by enabling or disabling @@ -482,13 +482,13 @@ typedef enum fe_guard_interval { DTV_ISDBT_LAYER_ENABLED[31:3] unused
-
+
<constant>DTV_ISDBT_LAYER*_FEC</constant> Possible values: FEC_AUTO, FEC_1_2, FEC_2_3, FEC_3_4, FEC_5_6, FEC_7_8
-
+
<constant>DTV_ISDBT_LAYER*_MODULATION</constant> Possible values: QAM_AUTO, QPSK, QAM_16, QAM_64, DQPSK @@ -497,7 +497,7 @@ typedef enum fe_guard_interval { and DTV_ISDBT_PARTIAL_RECEPTION=0 layer has to be DQPSK.
-
+
<constant>DTV_ISDBT_LAYER*_SEGMENT_COUNT</constant> Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO) @@ -560,7 +560,7 @@ typedef enum fe_guard_interval {
-
+
<constant>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</constant> Possible values: 0, 1, 2, 3, -1 (AUTO) @@ -578,7 +578,7 @@ typedef enum fe_guard_interval { support is currently in the early stages development so expect this section to grow and become more detailed with time. -
+
<constant>DTV_DVBT2_PLP_ID</constant> DVB-T2 supports Physical Layer Pipes (PLP) to allow transmission of -- 2.39.5