History

[media] DocBook: Better document enum fe_modulation

Instead of using programlisting, use a table, as this provides a better view of the structure.

Mauro Carvalho Chehab committed 11 years ago

Commit 997eb901 parent 2c2bc8f3 files · +76 −47Browse files

Unified · Split

3 files
  1. Documentation/DocBook/media/dvb/dvbproperty.xml +72 −19
  2. Documentation/DocBook/media/dvb/frontend.xml +0 −26
  3. include/uapi/linux/dvb/frontend.h +4 −2
Documentation/DocBook/media/dvb/dvbproperty.xml+72−19
@@ -137,25 +137,78 @@ get/set up to 64 properties. The actual meaning of each property is described on · 136 unmodified lines
137 </section>137 </section>
138 <section id="DTV-MODULATION">138 <section id="DTV-MODULATION">
139 <title><constant>DTV_MODULATION</constant></title>139 <title><constant>DTV_MODULATION</constant></title>
140<para>Specifies the frontend modulation type for cable and satellite types. The modulation can be one of the types bellow:</para>140<para>Specifies the frontend modulation type for delivery systems that supports
141<programlisting>141 more than one modulation type. The modulation can be one of the types
142 typedef enum fe_modulation {142 defined by &fe-modulation;.</para>
143 QPSK,143
144 QAM_16,144
145 QAM_32,145<section id="fe-modulation-t">
146 QAM_64,146<title>Modulation property</title>
147 QAM_128,147
148 QAM_256,148<para>Most of the digital TV standards currently offers more than one possible
149 QAM_AUTO,149 modulation (sometimes called as "constellation" on some standards). This
150 VSB_8,150 enum contains the values used by the Kernel. Please notice that not all
151 VSB_16,151 modulations are supported by a given standard.</para>
152 PSK_8,152
153 APSK_16,153<table pgwide="1" frame="none" id="fe-modulation">
154 APSK_32,154 <title>enum fe_modulation</title>
155 DQPSK,155 <tgroup cols="2">
156 QAM_4_NR,156 &cs-def;
157 } fe_modulation_t;157 <thead>
158</programlisting>158 <row>
159 <entry>ID</entry>
160 <entry>Description</entry>
161 </row>
162 </thead>
163 <tbody valign="top">
164 <row>
165 <entry>QPSK</entry>
166 <entry>QPSK modulation</entry>
167 </row><row>
168 <entry>QAM_16</entry>
169 <entry>16-QAM modulation</entry>
170 </row><row>
171 <entry>QAM_32</entry>
172 <entry>32-QAM modulation</entry>
173 </row><row>
174 <entry>QAM_64</entry>
175 <entry>64-QAM modulation</entry>
176 </row><row>
177 <entry>QAM_128</entry>
178 <entry>128-QAM modulation</entry>
179 </row><row>
180 <entry>QAM_256</entry>
181 <entry>256-QAM modulation</entry>
182 </row><row>
183 <entry>QAM_AUTO</entry>
184 <entry>Autodetect QAM modulation</entry>
185 </row><row>
186 <entry>VSB_8</entry>
187 <entry>8-VSB modulation</entry>
188 </row><row>
189 <entry>VSB_16</entry>
190 <entry>16-VSB modulation</entry>
191 </row><row>
192 <entry>PSK_8</entry>
193 <entry>8-PSK modulation</entry>
194 </row><row>
195 <entry>APSK_16</entry>
196 <entry>16-APSK modulation</entry>
197 </row><row>
198 <entry>APSK_32</entry>
199 <entry>32-APSK modulation</entry>
200 </row><row>
201 <entry>DQPSK</entry>
202 <entry>DQPSK modulation</entry>
203 </row><row>
204 <entry>QAM_4_NR</entry>
205 <entry>4-QAM-NR modulation</entry>
206 </row>
207 </tbody>
208 </tgroup>
209</table>
210</section>
211
159 </section>212 </section>
160 <section id="DTV-BANDWIDTH-HZ">213 <section id="DTV-BANDWIDTH-HZ">
161 <title><constant>DTV_BANDWIDTH_HZ</constant></title>214 <title><constant>DTV_BANDWIDTH_HZ</constant></title>
Documentation/DocBook/media/dvb/frontend.xml+0−26
@@ -100,32 +100,6 @@ detection. · 99 unmodified lines
100</para>100</para>
101</section>101</section>
102 102
103<section id="fe-modulation-t">
104<title>frontend modulation type for QAM, OFDM and VSB</title>
105<para>For cable and terrestrial frontends, e. g. for
106<link linkend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>,
107<link linkend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and
108<link linkend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>,
109it needs to specify the quadrature modulation mode which can be one of the following:
110</para>
111<programlisting>
112 typedef enum fe_modulation {
113 QPSK,
114 QAM_16,
115 QAM_32,
116 QAM_64,
117 QAM_128,
118 QAM_256,
119 QAM_AUTO,
120 VSB_8,
121 VSB_16,
122 PSK_8,
123 APSK_16,
124 APSK_32,
125 DQPSK,
126 } fe_modulation_t;
127</programlisting>
128</section>
129 103
130<section>104<section>
131<title>More OFDM parameters</title>105<title>More OFDM parameters</title>
include/uapi/linux/dvb/frontend.h+4−2
@@ -178,7 +178,7 @@ typedef enum fe_code_rate { · 177 unmodified lines
178} fe_code_rate_t;178} fe_code_rate_t;
179 179
180 180
181typedef enum fe_modulation {181enum fe_modulation {
182 QPSK,182 QPSK,
183 QAM_16,183 QAM_16,
184 QAM_32,184 QAM_32,
@@ -193,7 +193,9 @@ typedef enum fe_modulation { · 8 unmodified lines
193 APSK_32,193 APSK_32,
194 DQPSK,194 DQPSK,
195 QAM_4_NR,195 QAM_4_NR,
196} fe_modulation_t;196};
197
198typedef enum fe_modulation fe_modulation_t;
197 199
198typedef enum fe_transmit_mode {200typedef enum fe_transmit_mode {
199 TRANSMISSION_MODE_2K,201 TRANSMISSION_MODE_2K,