Commit | Line | Data |
---|---|---|
e4aa18d3 MCC |
1 | <section id="frontend-properties"> |
2 | <title>DVB Frontend properties</title> | |
3 | <para>Tuning into a Digital TV physical channel and starting decoding it | |
bf45caf2 | 4 | requires changing a set of parameters, in order to control the |
e4aa18d3 | 5 | tuner, the demodulator, the Linear Low-noise Amplifier (LNA) and to set the |
6fc1cb2e | 6 | antenna subsystem via Satellite Equipment Control (SEC), on satellite |
e4aa18d3 | 7 | systems. The actual parameters are specific to each particular digital |
bf45caf2 MCC |
8 | TV standards, and may change as the digital TV specs evolves.</para> |
9 | <para>In the past, the strategy used was to have a union with the parameters | |
e4aa18d3 MCC |
10 | needed to tune for DVB-S, DVB-C, DVB-T and ATSC delivery systems grouped |
11 | there. The problem is that, as the second generation standards appeared, | |
12 | those structs were not big enough to contain the additional parameters. | |
13 | Also, the union didn't have any space left to be expanded without breaking | |
14 | userspace. So, the decision was to deprecate the legacy union/struct based | |
15 | approach, in favor of a properties set approach.</para> | |
ac99edd2 MCC |
16 | |
17 | <para>NOTE: on Linux DVB API version 3, setting a frontend were done via | |
18 | <link linkend="dvb-frontend-parameters">struct <constant>dvb_frontend_parameters</constant></link>. | |
19 | This got replaced on version 5 (also called "S2API", as this API were | |
20 | added originally_enabled to provide support for DVB-S2), because the old | |
21 | API has a very limited support to new standards and new hardware. This | |
22 | section describes the new and recommended way to set the frontend, with | |
23 | suppports all digital TV delivery systems.</para> | |
e3dae862 | 24 | |
e4aa18d3 MCC |
25 | <para>Example: with the properties based approach, in order to set the tuner |
26 | to a DVB-C channel at 651 kHz, modulated with 256-QAM, FEC 3/4 and symbol | |
27 | rate of 5.217 Mbauds, those properties should be sent to | |
28 | <link linkend="FE_GET_PROPERTY"><constant>FE_SET_PROPERTY</constant></link> ioctl:</para> | |
29 | <itemizedlist> | |
595d041a HV |
30 | <listitem><para>&DTV-DELIVERY-SYSTEM; = SYS_DVBC_ANNEX_A</para></listitem> |
31 | <listitem><para>&DTV-FREQUENCY; = 651000000</para></listitem> | |
32 | <listitem><para>&DTV-MODULATION; = QAM_256</para></listitem> | |
33 | <listitem><para>&DTV-INVERSION; = INVERSION_AUTO</para></listitem> | |
34 | <listitem><para>&DTV-SYMBOL-RATE; = 5217000</para></listitem> | |
35 | <listitem><para>&DTV-INNER-FEC; = FEC_3_4</para></listitem> | |
36 | <listitem><para>&DTV-TUNE;</para></listitem> | |
e4aa18d3 | 37 | </itemizedlist> |
e3dae862 MCC |
38 | |
39 | <para>The code that would do the above is:</para> | |
40 | <programlisting> | |
41 | #include <stdio.h> | |
42 | #include <fcntl.h> | |
43 | #include <sys/ioctl.h> | |
44 | #include <linux/dvb/frontend.h> | |
45 | ||
46 | static struct dtv_property props[] = { | |
47 | { .cmd = DTV_DELIVERY_SYSTEM, .u.data = SYS_DVBC_ANNEX_A }, | |
48 | { .cmd = DTV_FREQUENCY, .u.data = 651000000 }, | |
49 | { .cmd = DTV_MODULATION, .u.data = QAM_256 }, | |
50 | { .cmd = DTV_INVERSION, .u.data = INVERSION_AUTO }, | |
51 | { .cmd = DTV_SYMBOL_RATE, .u.data = 5217000 }, | |
52 | { .cmd = DTV_INNER_FEC, .u.data = FEC_3_4 }, | |
53 | { .cmd = DTV_TUNE } | |
54 | }; | |
55 | ||
56 | static struct dtv_properties dtv_prop = { | |
57 | .num = 6, .props = props | |
58 | }; | |
59 | ||
60 | int main(void) | |
61 | { | |
62 | int fd = open("/dev/dvb/adapter0/frontend0", O_RDWR); | |
63 | ||
64 | if (!fd) { | |
65 | perror ("open"); | |
66 | return -1; | |
67 | } | |
68 | if (ioctl(fd, FE_SET_PROPERTY, &dtv_prop) == -1) { | |
69 | perror("ioctl"); | |
70 | return -1; | |
71 | } | |
72 | printf("Frontend set\n"); | |
73 | return 0; | |
74 | } | |
75 | </programlisting> | |
ac99edd2 MCC |
76 | |
77 | <para>NOTE: While it is possible to directly call the Kernel code like the | |
78 | above example, it is strongly recommended to use | |
991ce92f | 79 | <ulink url="https://linuxtv.org/docs/libdvbv5/index.html">libdvbv5</ulink>, |
ac99edd2 MCC |
80 | as it provides abstraction to work with the supported digital TV standards |
81 | and provides methods for usual operations like program scanning and to | |
82 | read/write channel descriptor files.</para> | |
ffec8bce | 83 | |
9569793a | 84 | <section id="dtv-stats"> |
38fbb986 | 85 | <title>struct <structname>dtv_stats</structname></title> |
9569793a MCC |
86 | <programlisting> |
87 | struct dtv_stats { | |
88 | __u8 scale; /* enum fecap_scale_params type */ | |
89 | union { | |
90 | __u64 uvalue; /* for counters and relative scales */ | |
91 | __s64 svalue; /* for 1/1000 dB measures */ | |
92 | }; | |
93 | } __packed; | |
94 | </programlisting> | |
95 | </section> | |
96 | <section id="dtv-fe-stats"> | |
38fbb986 | 97 | <title>struct <structname>dtv_fe_stats</structname></title> |
9569793a MCC |
98 | <programlisting> |
99 | #define MAX_DTV_STATS 4 | |
100 | ||
101 | struct dtv_fe_stats { | |
102 | __u8 len; | |
38fbb986 | 103 | &dtv-stats; stat[MAX_DTV_STATS]; |
9569793a MCC |
104 | } __packed; |
105 | </programlisting> | |
106 | </section> | |
107 | ||
3272c3ec | 108 | <section id="dtv-property"> |
38fbb986 | 109 | <title>struct <structname>dtv_property</structname></title> |
0ed08b49 MCC |
110 | <programlisting> |
111 | /* Reserved fields should be set to 0 */ | |
9569793a | 112 | |
0ed08b49 MCC |
113 | struct dtv_property { |
114 | __u32 cmd; | |
9569793a | 115 | __u32 reserved[3]; |
0ed08b49 MCC |
116 | union { |
117 | __u32 data; | |
38fbb986 | 118 | &dtv-fe-stats; st; |
0ed08b49 MCC |
119 | struct { |
120 | __u8 data[32]; | |
121 | __u32 len; | |
122 | __u32 reserved1[3]; | |
123 | void *reserved2; | |
124 | } buffer; | |
125 | } u; | |
126 | int result; | |
127 | } __attribute__ ((packed)); | |
128 | ||
129 | /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */ | |
130 | #define DTV_IOCTL_MAX_MSGS 64 | |
3272c3ec MCC |
131 | </programlisting> |
132 | </section> | |
133 | <section id="dtv-properties"> | |
38fbb986 | 134 | <title>struct <structname>dtv_properties</structname></title> |
3272c3ec | 135 | <programlisting> |
0ed08b49 MCC |
136 | struct dtv_properties { |
137 | __u32 num; | |
38fbb986 | 138 | &dtv-property; *props; |
0ed08b49 MCC |
139 | }; |
140 | </programlisting> | |
3272c3ec | 141 | </section> |
0ed08b49 | 142 | |
5f1e1586 HV |
143 | <section> |
144 | <title>Property types</title> | |
0ed08b49 | 145 | <para> |
277dfcb4 | 146 | On <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY and FE_SET_PROPERTY</link>, |
0ed08b49 MCC |
147 | the actual action is determined by the dtv_property cmd/data pairs. With one single ioctl, is possible to |
148 | get/set up to 64 properties. The actual meaning of each property is described on the next sections. | |
149 | </para> | |
150 | ||
994e262e | 151 | <para>The available frontend property types are shown on the next section.</para> |
5f1e1586 | 152 | </section> |
0ed08b49 | 153 | |
17d8bb06 MCC |
154 | <section id="fe_property_parameters"> |
155 | <title>Digital TV property parameters</title> | |
04a92077 MCC |
156 | <section id="DTV-UNDEFINED"> |
157 | <title><constant>DTV_UNDEFINED</constant></title> | |
158 | <para>Used internally. A GET/SET operation for it won't change or return anything.</para> | |
159 | </section> | |
160 | <section id="DTV-TUNE"> | |
161 | <title><constant>DTV_TUNE</constant></title> | |
162 | <para>Interpret the cache of data, build either a traditional frontend tunerequest so we can pass validation in the <constant>FE_SET_FRONTEND</constant> ioctl.</para> | |
163 | </section> | |
164 | <section id="DTV-CLEAR"> | |
165 | <title><constant>DTV_CLEAR</constant></title> | |
166 | <para>Reset a cache of data specific to the frontend here. This does not effect hardware.</para> | |
167 | </section> | |
17d8bb06 MCC |
168 | <section id="DTV-FREQUENCY"> |
169 | <title><constant>DTV_FREQUENCY</constant></title> | |
170 | ||
a34e2a78 | 171 | <para>Central frequency of the channel.</para> |
17d8bb06 MCC |
172 | |
173 | <para>Notes:</para> | |
6fc1cb2e | 174 | <para>1)For satellite delivery systems, it is measured in kHz. |
a34e2a78 MCC |
175 | For the other ones, it is measured in Hz.</para> |
176 | <para>2)For ISDB-T, the channels are usually transmitted with an offset of 143kHz. | |
c4d28cc7 | 177 | E.g. a valid frequency could be 474143 kHz. The stepping is bound to the bandwidth of |
17d8bb06 MCC |
178 | the channel which is 6MHz.</para> |
179 | ||
a34e2a78 | 180 | <para>3)As in ISDB-Tsb the channel consists of only one or three segments the |
17d8bb06 MCC |
181 | frequency step is 429kHz, 3*429 respectively. As for ISDB-T the |
182 | central frequency of the channel is expected.</para> | |
183 | </section> | |
04a92077 MCC |
184 | <section id="DTV-MODULATION"> |
185 | <title><constant>DTV_MODULATION</constant></title> | |
997eb903 MCC |
186 | <para>Specifies the frontend modulation type for delivery systems that supports |
187 | more than one modulation type. The modulation can be one of the types | |
188 | defined by &fe-modulation;.</para> | |
189 | ||
190 | ||
191 | <section id="fe-modulation-t"> | |
192 | <title>Modulation property</title> | |
193 | ||
194 | <para>Most of the digital TV standards currently offers more than one possible | |
195 | modulation (sometimes called as "constellation" on some standards). This | |
7832a915 | 196 | enum contains the values used by the Kernel. Please note that not all |
997eb903 MCC |
197 | modulations are supported by a given standard.</para> |
198 | ||
199 | <table pgwide="1" frame="none" id="fe-modulation"> | |
200 | <title>enum fe_modulation</title> | |
201 | <tgroup cols="2"> | |
202 | &cs-def; | |
203 | <thead> | |
204 | <row> | |
205 | <entry>ID</entry> | |
206 | <entry>Description</entry> | |
207 | </row> | |
208 | </thead> | |
209 | <tbody valign="top"> | |
210 | <row> | |
00c91dfd | 211 | <entry id="QPSK"><constant>QPSK</constant></entry> |
997eb903 MCC |
212 | <entry>QPSK modulation</entry> |
213 | </row><row> | |
00c91dfd | 214 | <entry id="QAM-16"><constant>QAM_16</constant></entry> |
997eb903 MCC |
215 | <entry>16-QAM modulation</entry> |
216 | </row><row> | |
00c91dfd | 217 | <entry id="QAM-32"><constant>QAM_32</constant></entry> |
997eb903 MCC |
218 | <entry>32-QAM modulation</entry> |
219 | </row><row> | |
00c91dfd | 220 | <entry id="QAM-64"><constant>QAM_64</constant></entry> |
997eb903 MCC |
221 | <entry>64-QAM modulation</entry> |
222 | </row><row> | |
00c91dfd | 223 | <entry id="QAM-128"><constant>QAM_128</constant></entry> |
997eb903 MCC |
224 | <entry>128-QAM modulation</entry> |
225 | </row><row> | |
00c91dfd | 226 | <entry id="QAM-256"><constant>QAM_256</constant></entry> |
997eb903 MCC |
227 | <entry>256-QAM modulation</entry> |
228 | </row><row> | |
00c91dfd | 229 | <entry id="QAM-AUTO"><constant>QAM_AUTO</constant></entry> |
997eb903 MCC |
230 | <entry>Autodetect QAM modulation</entry> |
231 | </row><row> | |
00c91dfd | 232 | <entry id="VSB-8"><constant>VSB_8</constant></entry> |
997eb903 MCC |
233 | <entry>8-VSB modulation</entry> |
234 | </row><row> | |
00c91dfd | 235 | <entry id="VSB-16"><constant>VSB_16</constant></entry> |
997eb903 MCC |
236 | <entry>16-VSB modulation</entry> |
237 | </row><row> | |
00c91dfd | 238 | <entry id="PSK-8"><constant>PSK_8</constant></entry> |
997eb903 MCC |
239 | <entry>8-PSK modulation</entry> |
240 | </row><row> | |
00c91dfd | 241 | <entry id="APSK-16"><constant>APSK_16</constant></entry> |
997eb903 MCC |
242 | <entry>16-APSK modulation</entry> |
243 | </row><row> | |
00c91dfd | 244 | <entry id="APSK-32"><constant>APSK_32</constant></entry> |
997eb903 MCC |
245 | <entry>32-APSK modulation</entry> |
246 | </row><row> | |
00c91dfd | 247 | <entry id="DQPSK"><constant>DQPSK</constant></entry> |
997eb903 MCC |
248 | <entry>DQPSK modulation</entry> |
249 | </row><row> | |
00c91dfd | 250 | <entry id="QAM-4-NR"><constant>QAM_4_NR</constant></entry> |
997eb903 MCC |
251 | <entry>4-QAM-NR modulation</entry> |
252 | </row> | |
253 | </tbody> | |
254 | </tgroup> | |
255 | </table> | |
256 | </section> | |
257 | ||
04a92077 | 258 | </section> |
17d8bb06 MCC |
259 | <section id="DTV-BANDWIDTH-HZ"> |
260 | <title><constant>DTV_BANDWIDTH_HZ</constant></title> | |
261 | ||
262 | <para>Bandwidth for the channel, in HZ.</para> | |
263 | ||
264 | <para>Possible values: | |
265 | <constant>1712000</constant>, | |
266 | <constant>5000000</constant>, | |
267 | <constant>6000000</constant>, | |
268 | <constant>7000000</constant>, | |
269 | <constant>8000000</constant>, | |
270 | <constant>10000000</constant>. | |
271 | </para> | |
272 | ||
273 | <para>Notes:</para> | |
274 | ||
275 | <para>1) For ISDB-T it should be always 6000000Hz (6MHz)</para> | |
276 | <para>2) For ISDB-Tsb it can vary depending on the number of connected segments</para> | |
277 | <para>3) Bandwidth doesn't apply for DVB-C transmissions, as the bandwidth | |
278 | for DVB-C depends on the symbol rate</para> | |
279 | <para>4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from | |
280 | other parameters (DTV_ISDBT_SB_SEGMENT_IDX, | |
281 | DTV_ISDBT_SB_SEGMENT_COUNT).</para> | |
282 | <para>5) DVB-T supports 6, 7 and 8MHz.</para> | |
283 | <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para> | |
284 | </section> | |
04a92077 MCC |
285 | <section id="DTV-INVERSION"> |
286 | <title><constant>DTV_INVERSION</constant></title> | |
58e11cc3 MCC |
287 | |
288 | <para>Specifies if the frontend should do spectral inversion or not.</para> | |
289 | ||
290 | <section id="fe-spectral-inversion-t"> | |
291 | <title>enum fe_modulation: Frontend spectral inversion</title> | |
292 | ||
293 | <para>This parameter indicates if spectral inversion should be presumed or not. | |
294 | In the automatic setting (<constant>INVERSION_AUTO</constant>) the hardware | |
295 | will try to figure out the correct setting by itself. If the hardware | |
296 | doesn't support, the DVB core will try to lock at the carrier first with | |
297 | inversion off. If it fails, it will try to enable inversion. | |
298 | </para> | |
299 | ||
300 | <table pgwide="1" frame="none" id="fe-spectral-inversion"> | |
301 | <title>enum fe_modulation</title> | |
302 | <tgroup cols="2"> | |
303 | &cs-def; | |
304 | <thead> | |
305 | <row> | |
306 | <entry>ID</entry> | |
307 | <entry>Description</entry> | |
308 | </row> | |
309 | </thead> | |
310 | <tbody valign="top"> | |
311 | <row> | |
00c91dfd | 312 | <entry id="INVERSION-OFF"><constant>INVERSION_OFF</constant></entry> |
58e11cc3 MCC |
313 | <entry>Don't do spectral band inversion.</entry> |
314 | </row><row> | |
00c91dfd | 315 | <entry id="INVERSION-ON"><constant>INVERSION_ON</constant></entry> |
58e11cc3 MCC |
316 | <entry>Do spectral band inversion.</entry> |
317 | </row><row> | |
00c91dfd | 318 | <entry id="INVERSION-AUTO"><constant>INVERSION_AUTO</constant></entry> |
58e11cc3 MCC |
319 | <entry>Autodetect spectral band inversion.</entry> |
320 | </row> | |
321 | </tbody> | |
322 | </tgroup> | |
323 | </table> | |
324 | </section> | |
325 | ||
04a92077 MCC |
326 | </section> |
327 | <section id="DTV-DISEQC-MASTER"> | |
328 | <title><constant>DTV_DISEQC_MASTER</constant></title> | |
329 | <para>Currently not implemented.</para> | |
330 | </section> | |
331 | <section id="DTV-SYMBOL-RATE"> | |
332 | <title><constant>DTV_SYMBOL_RATE</constant></title> | |
333 | <para>Digital TV symbol rate, in bauds (symbols/second). Used on cable standards.</para> | |
334 | </section> | |
335 | <section id="DTV-INNER-FEC"> | |
336 | <title><constant>DTV_INNER_FEC</constant></title> | |
337 | <para>Used cable/satellite transmissions. The acceptable values are: | |
338 | </para> | |
2d457b8a MCC |
339 | <section id="fe-code-rate-t"> |
340 | <title>enum fe_code_rate: type of the Forward Error Correction.</title> | |
341 | ||
342 | <table pgwide="1" frame="none" id="fe-code-rate"> | |
343 | <title>enum fe_code_rate</title> | |
344 | <tgroup cols="2"> | |
345 | &cs-def; | |
346 | <thead> | |
347 | <row> | |
348 | <entry>ID</entry> | |
349 | <entry>Description</entry> | |
350 | </row> | |
351 | </thead> | |
352 | <tbody valign="top"> | |
353 | <row> | |
00c91dfd | 354 | <entry id="FEC-NONE"><constant>FEC_NONE</constant></entry> |
2d457b8a MCC |
355 | <entry>No Forward Error Correction Code</entry> |
356 | </row><row> | |
00c91dfd | 357 | <entry id="FEC-AUTO"><constant>FEC_AUTO</constant></entry> |
2d457b8a MCC |
358 | <entry>Autodetect Error Correction Code</entry> |
359 | </row><row> | |
00c91dfd | 360 | <entry id="FEC-1-2"><constant>FEC_1_2</constant></entry> |
2d457b8a MCC |
361 | <entry>Forward Error Correction Code 1/2</entry> |
362 | </row><row> | |
00c91dfd | 363 | <entry id="FEC-2-3"><constant>FEC_2_3</constant></entry> |
2d457b8a MCC |
364 | <entry>Forward Error Correction Code 2/3</entry> |
365 | </row><row> | |
00c91dfd | 366 | <entry id="FEC-3-4"><constant>FEC_3_4</constant></entry> |
2d457b8a MCC |
367 | <entry>Forward Error Correction Code 3/4</entry> |
368 | </row><row> | |
00c91dfd | 369 | <entry id="FEC-4-5"><constant>FEC_4_5</constant></entry> |
2d457b8a MCC |
370 | <entry>Forward Error Correction Code 4/5</entry> |
371 | </row><row> | |
00c91dfd | 372 | <entry id="FEC-5-6"><constant>FEC_5_6</constant></entry> |
2d457b8a MCC |
373 | <entry>Forward Error Correction Code 5/6</entry> |
374 | </row><row> | |
00c91dfd | 375 | <entry id="FEC-6-7"><constant>FEC_6_7</constant></entry> |
2d457b8a MCC |
376 | <entry>Forward Error Correction Code 6/7</entry> |
377 | </row><row> | |
00c91dfd | 378 | <entry id="FEC-7-8"><constant>FEC_7_8</constant></entry> |
2d457b8a MCC |
379 | <entry>Forward Error Correction Code 7/8</entry> |
380 | </row><row> | |
00c91dfd | 381 | <entry id="FEC-8-9"><constant>FEC_8_9</constant></entry> |
2d457b8a MCC |
382 | <entry>Forward Error Correction Code 8/9</entry> |
383 | </row><row> | |
00c91dfd | 384 | <entry id="FEC-9-10"><constant>FEC_9_10</constant></entry> |
2d457b8a MCC |
385 | <entry>Forward Error Correction Code 9/10</entry> |
386 | </row><row> | |
00c91dfd | 387 | <entry id="FEC-2-5"><constant>FEC_2_5</constant></entry> |
2d457b8a MCC |
388 | <entry>Forward Error Correction Code 2/5</entry> |
389 | </row><row> | |
00c91dfd | 390 | <entry id="FEC-3-5"><constant>FEC_3_5</constant></entry> |
2d457b8a | 391 | <entry>Forward Error Correction Code 3/5</entry> |
2d457b8a MCC |
392 | </row> |
393 | </tbody> | |
394 | </tgroup> | |
395 | </table> | |
396 | </section> | |
04a92077 MCC |
397 | </section> |
398 | <section id="DTV-VOLTAGE"> | |
399 | <title><constant>DTV_VOLTAGE</constant></title> | |
400 | <para>The voltage is usually used with non-DiSEqC capable LNBs to switch | |
401 | the polarzation (horizontal/vertical). When using DiSEqC epuipment this | |
402 | voltage has to be switched consistently to the DiSEqC commands as | |
403 | described in the DiSEqC spec.</para> | |
ff50574c MCC |
404 | |
405 | <table pgwide="1" frame="none" id="fe-sec-voltage"> | |
406 | <title id="fe-sec-voltage-t">enum fe_sec_voltage</title> | |
407 | <tgroup cols="2"> | |
408 | &cs-def; | |
409 | <thead> | |
410 | <row> | |
411 | <entry>ID</entry> | |
412 | <entry>Description</entry> | |
413 | </row> | |
414 | </thead> | |
415 | <tbody valign="top"> | |
416 | <row> | |
417 | <entry align="char" id="SEC-VOLTAGE-13"><constant>SEC_VOLTAGE_13</constant></entry> | |
418 | <entry align="char">Set DC voltage level to 13V</entry> | |
419 | </row><row> | |
420 | <entry align="char" id="SEC-VOLTAGE-18"><constant>SEC_VOLTAGE_18</constant></entry> | |
421 | <entry align="char">Set DC voltage level to 18V</entry> | |
422 | </row><row> | |
423 | <entry align="char" id="SEC-VOLTAGE-OFF"><constant>SEC_VOLTAGE_OFF</constant></entry> | |
424 | <entry align="char">Don't send any voltage to the antenna</entry> | |
425 | </row> | |
426 | </tbody> | |
427 | </tgroup> | |
428 | </table> | |
04a92077 MCC |
429 | </section> |
430 | <section id="DTV-TONE"> | |
431 | <title><constant>DTV_TONE</constant></title> | |
432 | <para>Currently not used.</para> | |
433 | </section> | |
434 | <section id="DTV-PILOT"> | |
435 | <title><constant>DTV_PILOT</constant></title> | |
436 | <para>Sets DVB-S2 pilot</para> | |
437 | <section id="fe-pilot-t"> | |
438 | <title>fe_pilot type</title> | |
448bac10 MCC |
439 | <table pgwide="1" frame="none" id="fe-pilot"> |
440 | <title>enum fe_pilot</title> | |
441 | <tgroup cols="2"> | |
442 | &cs-def; | |
443 | <thead> | |
444 | <row> | |
445 | <entry>ID</entry> | |
446 | <entry>Description</entry> | |
447 | </row> | |
448 | </thead> | |
449 | <tbody valign="top"> | |
450 | <row> | |
451 | <entry align="char" id="PILOT-ON"><constant>PILOT_ON</constant></entry> | |
452 | <entry align="char">Pilot tones enabled</entry> | |
453 | </row><row> | |
454 | <entry align="char" id="PILOT-OFF"><constant>PILOT_OFF</constant></entry> | |
455 | <entry align="char">Pilot tones disabled</entry> | |
456 | </row><row> | |
457 | <entry align="char" id="PILOT-AUTO"><constant>PILOT_AUTO</constant></entry> | |
458 | <entry align="char">Autodetect pilot tones</entry> | |
459 | </row> | |
460 | </tbody> | |
461 | </tgroup> | |
462 | </table> | |
04a92077 MCC |
463 | </section> |
464 | </section> | |
465 | <section id="DTV-ROLLOFF"> | |
466 | <title><constant>DTV_ROLLOFF</constant></title> | |
467 | <para>Sets DVB-S2 rolloff</para> | |
468 | ||
469 | <section id="fe-rolloff-t"> | |
470 | <title>fe_rolloff type</title> | |
b35f6ba9 MCC |
471 | <table pgwide="1" frame="none" id="fe-rolloff"> |
472 | <title>enum fe_rolloff</title> | |
473 | <tgroup cols="2"> | |
474 | &cs-def; | |
475 | <thead> | |
476 | <row> | |
477 | <entry>ID</entry> | |
478 | <entry>Description</entry> | |
479 | </row> | |
480 | </thead> | |
481 | <tbody valign="top"> | |
482 | <row> | |
483 | <entry align="char" id="ROLLOFF-35"><constant>ROLLOFF_35</constant></entry> | |
484 | <entry align="char">Roloff factor: α=35%</entry> | |
485 | </row><row> | |
486 | <entry align="char" id="ROLLOFF-20"><constant>ROLLOFF_20</constant></entry> | |
487 | <entry align="char">Roloff factor: α=20%</entry> | |
488 | </row><row> | |
489 | <entry align="char" id="ROLLOFF-25"><constant>ROLLOFF_25</constant></entry> | |
490 | <entry align="char">Roloff factor: α=25%</entry> | |
491 | </row><row> | |
492 | <entry align="char" id="ROLLOFF-AUTO"><constant>ROLLOFF_AUTO</constant></entry> | |
493 | <entry align="char">Auto-detect the roloff factor.</entry> | |
494 | </row> | |
495 | </tbody> | |
496 | </tgroup> | |
497 | </table> | |
04a92077 MCC |
498 | </section> |
499 | </section> | |
500 | <section id="DTV-DISEQC-SLAVE-REPLY"> | |
501 | <title><constant>DTV_DISEQC_SLAVE_REPLY</constant></title> | |
502 | <para>Currently not implemented.</para> | |
503 | </section> | |
504 | <section id="DTV-FE-CAPABILITY-COUNT"> | |
505 | <title><constant>DTV_FE_CAPABILITY_COUNT</constant></title> | |
506 | <para>Currently not implemented.</para> | |
507 | </section> | |
508 | <section id="DTV-FE-CAPABILITY"> | |
509 | <title><constant>DTV_FE_CAPABILITY</constant></title> | |
510 | <para>Currently not implemented.</para> | |
511 | </section> | |
17d8bb06 MCC |
512 | <section id="DTV-DELIVERY-SYSTEM"> |
513 | <title><constant>DTV_DELIVERY_SYSTEM</constant></title> | |
514 | <para>Specifies the type of Delivery system</para> | |
515 | <section id="fe-delivery-system-t"> | |
516 | <title>fe_delivery_system type</title> | |
517 | <para>Possible values: </para> | |
669a4ba4 | 518 | |
d21ddba8 MCC |
519 | <table pgwide="1" frame="none" id="fe-delivery-system"> |
520 | <title>enum fe_delivery_system</title> | |
521 | <tgroup cols="2"> | |
522 | &cs-def; | |
523 | <thead> | |
524 | <row> | |
525 | <entry>ID</entry> | |
526 | <entry>Description</entry> | |
527 | </row> | |
528 | </thead> | |
529 | <tbody valign="top"> | |
530 | <row> | |
531 | <entry id="SYS-UNDEFINED"><constant>SYS_UNDEFINED</constant></entry> | |
532 | <entry>Undefined standard. Generally, indicates an error</entry> | |
533 | </row><row> | |
534 | <entry id="SYS-DVBC-ANNEX-A"><constant>SYS_DVBC_ANNEX_A</constant></entry> | |
535 | <entry>Cable TV: DVB-C following ITU-T J.83 Annex A spec</entry> | |
536 | </row><row> | |
537 | <entry id="SYS-DVBC-ANNEX-B"><constant>SYS_DVBC_ANNEX_B</constant></entry> | |
538 | <entry>Cable TV: DVB-C following ITU-T J.83 Annex B spec (ClearQAM)</entry> | |
539 | </row><row> | |
540 | <entry id="SYS-DVBC-ANNEX-C"><constant>SYS_DVBC_ANNEX_C</constant></entry> | |
541 | <entry>Cable TV: DVB-C following ITU-T J.83 Annex C spec</entry> | |
542 | </row><row> | |
543 | <entry id="SYS-ISDBC"><constant>SYS_ISDBC</constant></entry> | |
544 | <entry>Cable TV: ISDB-C (no drivers yet)</entry> | |
545 | </row><row> | |
546 | <entry id="SYS-DVBT"><constant>SYS_DVBT</constant></entry> | |
547 | <entry>Terrestral TV: DVB-T</entry> | |
548 | </row><row> | |
549 | <entry id="SYS-DVBT2"><constant>SYS_DVBT2</constant></entry> | |
550 | <entry>Terrestral TV: DVB-T2</entry> | |
551 | </row><row> | |
552 | <entry id="SYS-ISDBT"><constant>SYS_ISDBT</constant></entry> | |
553 | <entry>Terrestral TV: ISDB-T</entry> | |
554 | </row><row> | |
555 | <entry id="SYS-ATSC"><constant>SYS_ATSC</constant></entry> | |
556 | <entry>Terrestral TV: ATSC</entry> | |
557 | </row><row> | |
558 | <entry id="SYS-ATSCMH"><constant>SYS_ATSCMH</constant></entry> | |
559 | <entry>Terrestral TV (mobile): ATSC-M/H</entry> | |
560 | </row><row> | |
561 | <entry id="SYS-DTMB"><constant>SYS_DTMB</constant></entry> | |
562 | <entry>Terrestrial TV: DTMB</entry> | |
563 | </row><row> | |
564 | <entry id="SYS-DVBS"><constant>SYS_DVBS</constant></entry> | |
565 | <entry>Satellite TV: DVB-S</entry> | |
566 | </row><row> | |
567 | <entry id="SYS-DVBS2"><constant>SYS_DVBS2</constant></entry> | |
568 | <entry>Satellite TV: DVB-S2</entry> | |
569 | </row><row> | |
570 | <entry id="SYS-TURBO"><constant>SYS_TURBO</constant></entry> | |
571 | <entry>Satellite TV: DVB-S Turbo</entry> | |
572 | </row><row> | |
573 | <entry id="SYS-ISDBS"><constant>SYS_ISDBS</constant></entry> | |
574 | <entry>Satellite TV: ISDB-S</entry> | |
575 | </row><row> | |
576 | <entry id="SYS-DAB"><constant>SYS_DAB</constant></entry> | |
577 | <entry>Digital audio: DAB (not fully supported)</entry> | |
578 | </row><row> | |
579 | <entry id="SYS-DSS"><constant>SYS_DSS</constant></entry> | |
580 | <entry>Satellite TV:"DSS (not fully supported)</entry> | |
581 | </row><row> | |
582 | <entry id="SYS-CMMB"><constant>SYS_CMMB</constant></entry> | |
583 | <entry>Terrestral TV (mobile):CMMB (not fully supported)</entry> | |
584 | </row><row> | |
585 | <entry id="SYS-DVBH"><constant>SYS_DVBH</constant></entry> | |
586 | <entry>Terrestral TV (mobile): DVB-H (standard deprecated)</entry> | |
587 | </row> | |
588 | </tbody> | |
589 | </tgroup> | |
590 | </table> | |
591 | ||
592 | ||
593 | </section> | |
17d8bb06 MCC |
594 | </section> |
595 | <section id="DTV-ISDBT-PARTIAL-RECEPTION"> | |
596 | <title><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></title> | |
597 | ||
598 | <para>If <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '0' this bit-field represents whether | |
599 | the channel is in partial reception mode or not.</para> | |
600 | ||
601 | <para>If '1' <constant>DTV_ISDBT_LAYERA_*</constant> values are assigned to the center segment and | |
602 | <constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant> has to be '1'.</para> | |
603 | ||
604 | <para>If in addition <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1' | |
605 | <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> represents whether this ISDB-Tsb channel | |
606 | is consisting of one segment and layer or three segments and two layers.</para> | |
607 | ||
608 | <para>Possible values: 0, 1, -1 (AUTO)</para> | |
609 | </section> | |
610 | <section id="DTV-ISDBT-SOUND-BROADCASTING"> | |
611 | <title><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></title> | |
612 | ||
613 | <para>This field represents whether the other DTV_ISDBT_*-parameters are | |
614 | referring to an ISDB-T and an ISDB-Tsb channel. (See also | |
615 | <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>).</para> | |
616 | ||
617 | <para>Possible values: 0, 1, -1 (AUTO)</para> | |
618 | </section> | |
619 | <section id="DTV-ISDBT-SB-SUBCHANNEL-ID"> | |
620 | <title><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></title> | |
621 | ||
622 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> | |
623 | ||
624 | <para>(Note of the author: This might not be the correct description of the | |
625 | <constant>SUBCHANNEL-ID</constant> in all details, but it is my understanding of the technical | |
626 | background needed to program a device)</para> | |
627 | ||
628 | <para>An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a | |
629 | set of connected ISDB-Tsb channels. In this set of channels every | |
630 | channel can be received independently. The number of connected | |
631 | ISDB-Tsb segment can vary, e.g. depending on the frequency spectrum | |
632 | bandwidth available.</para> | |
633 | ||
634 | <para>Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The | |
635 | broadcaster has several possibilities to put those channels in the | |
636 | air: Assuming a normal 13-segment ISDB-T spectrum he can align the 8 | |
637 | segments from position 1-8 to 5-13 or anything in between.</para> | |
638 | ||
639 | <para>The underlying layer of segments are subchannels: each segment is | |
640 | consisting of several subchannels with a predefined IDs. A sub-channel | |
641 | is used to help the demodulator to synchronize on the channel.</para> | |
642 | ||
643 | <para>An ISDB-T channel is always centered over all sub-channels. As for | |
644 | the example above, in ISDB-Tsb it is no longer as simple as that.</para> | |
645 | ||
646 | <para><constant>The DTV_ISDBT_SB_SUBCHANNEL_ID</constant> parameter is used to give the | |
647 | sub-channel ID of the segment to be demodulated.</para> | |
648 | ||
649 | <para>Possible values: 0 .. 41, -1 (AUTO)</para> | |
650 | </section> | |
651 | <section id="DTV-ISDBT-SB-SEGMENT-IDX"> | |
652 | <title><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></title> | |
653 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> | |
654 | <para><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant> gives the index of the segment to be | |
655 | demodulated for an ISDB-Tsb channel where several of them are | |
656 | transmitted in the connected manner.</para> | |
657 | <para>Possible values: 0 .. <constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> - 1</para> | |
658 | <para>Note: This value cannot be determined by an automatic channel search.</para> | |
659 | </section> | |
660 | <section id="DTV-ISDBT-SB-SEGMENT-COUNT"> | |
661 | <title><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></title> | |
662 | <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para> | |
663 | <para><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> gives the total count of connected ISDB-Tsb | |
664 | channels.</para> | |
665 | <para>Possible values: 1 .. 13</para> | |
666 | <para>Note: This value cannot be determined by an automatic channel search.</para> | |
667 | </section> | |
668 | <section id="isdb-hierq-layers"> | |
446c18fc | 669 | <title><constant>DTV-ISDBT-LAYER*</constant> parameters</title> |
17d8bb06 MCC |
670 | <para>ISDB-T channels can be coded hierarchically. As opposed to DVB-T in |
671 | ISDB-T hierarchical layers can be decoded simultaneously. For that | |
9569793a | 672 | reason a ISDB-T demodulator has 3 Viterbi and 3 Reed-Solomon decoders.</para> |
17d8bb06 MCC |
673 | <para>ISDB-T has 3 hierarchical layers which each can use a part of the |
674 | available segments. The total number of segments over all layers has | |
675 | to 13 in ISDB-T.</para> | |
446c18fc | 676 | <para>There are 3 parameter sets, for Layers A, B and C.</para> |
17d8bb06 MCC |
677 | <section id="DTV-ISDBT-LAYER-ENABLED"> |
678 | <title><constant>DTV_ISDBT_LAYER_ENABLED</constant></title> | |
679 | <para>Hierarchical reception in ISDB-T is achieved by enabling or disabling | |
680 | layers in the decoding process. Setting all bits of | |
681 | <constant>DTV_ISDBT_LAYER_ENABLED</constant> to '1' forces all layers (if applicable) to be | |
682 | demodulated. This is the default.</para> | |
683 | <para>If the channel is in the partial reception mode | |
684 | (<constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> = 1) the central segment can be decoded | |
685 | independently of the other 12 segments. In that mode layer A has to | |
686 | have a <constant>SEGMENT_COUNT</constant> of 1.</para> | |
687 | <para>In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb | |
688 | according to <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>. <constant>SEGMENT_COUNT</constant> must be filled | |
689 | accordingly.</para> | |
690 | <para>Possible values: 0x1, 0x2, 0x4 (|-able)</para> | |
691 | <para><constant>DTV_ISDBT_LAYER_ENABLED[0:0]</constant> - layer A</para> | |
692 | <para><constant>DTV_ISDBT_LAYER_ENABLED[1:1]</constant> - layer B</para> | |
693 | <para><constant>DTV_ISDBT_LAYER_ENABLED[2:2]</constant> - layer C</para> | |
694 | <para><constant>DTV_ISDBT_LAYER_ENABLED[31:3]</constant> unused</para> | |
695 | </section> | |
696 | <section id="DTV-ISDBT-LAYER-FEC"> | |
697 | <title><constant>DTV_ISDBT_LAYER*_FEC</constant></title> | |
698 | <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> | |
699 | </section> | |
700 | <section id="DTV-ISDBT-LAYER-MODULATION"> | |
701 | <title><constant>DTV_ISDBT_LAYER*_MODULATION</constant></title> | |
702 | <para>Possible values: <constant>QAM_AUTO</constant>, QP<constant>SK, QAM_16</constant>, <constant>QAM_64</constant>, <constant>DQPSK</constant></para> | |
703 | <para>Note: If layer C is <constant>DQPSK</constant> layer B has to be <constant>DQPSK</constant>. If layer B is <constant>DQPSK</constant> | |
704 | and <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>=0 layer has to be <constant>DQPSK</constant>.</para> | |
705 | </section> | |
706 | <section id="DTV-ISDBT-LAYER-SEGMENT-COUNT"> | |
707 | <title><constant>DTV_ISDBT_LAYER*_SEGMENT_COUNT</constant></title> | |
708 | <para>Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)</para> | |
709 | <para>Note: Truth table for <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> and | |
710 | <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> and <constant>LAYER</constant>*_SEGMENT_COUNT</para> | |
711 | <informaltable id="isdbt-layer_seg-cnt-table"> | |
712 | <tgroup cols="6"> | |
713 | <tbody> | |
714 | <row> | |
715 | <entry>PR</entry> | |
716 | <entry>SB</entry> | |
717 | <entry>Layer A width</entry> | |
718 | <entry>Layer B width</entry> | |
719 | <entry>Layer C width</entry> | |
720 | <entry>total width</entry> | |
721 | </row> | |
722 | <row> | |
723 | <entry>0</entry> | |
724 | <entry>0</entry> | |
725 | <entry>1 .. 13</entry> | |
726 | <entry>1 .. 13</entry> | |
727 | <entry>1 .. 13</entry> | |
728 | <entry>13</entry> | |
729 | </row> | |
730 | <row> | |
731 | <entry>1</entry> | |
732 | <entry>0</entry> | |
733 | <entry>1</entry> | |
734 | <entry>1 .. 13</entry> | |
735 | <entry>1 .. 13</entry> | |
736 | <entry>13</entry> | |
737 | </row> | |
738 | <row> | |
739 | <entry>0</entry> | |
740 | <entry>1</entry> | |
741 | <entry>1</entry> | |
742 | <entry>0</entry> | |
743 | <entry>0</entry> | |
744 | <entry>1</entry> | |
745 | </row> | |
746 | <row> | |
747 | <entry>1</entry> | |
748 | <entry>1</entry> | |
749 | <entry>1</entry> | |
750 | <entry>2</entry> | |
751 | <entry>0</entry> | |
752 | <entry>13</entry> | |
753 | </row> | |
754 | </tbody> | |
755 | </tgroup> | |
756 | </informaltable> | |
757 | </section> | |
758 | <section id="DTV-ISDBT-LAYER-TIME-INTERLEAVING"> | |
759 | <title><constant>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</constant></title> | |
18b258d6 MCC |
760 | <para>Valid values: 0, 1, 2, 4, -1 (AUTO)</para> |
761 | <para>when DTV_ISDBT_SOUND_BROADCASTING is active, value 8 is also valid.</para> | |
762 | <para>Note: The real time interleaving length depends on the mode (fft-size). The values | |
763 | here are referring to what can be found in the TMCC-structure, as shown in the table below.</para> | |
764 | <informaltable id="isdbt-layer-interleaving-table"> | |
765 | <tgroup cols="4" align="center"> | |
766 | <tbody> | |
767 | <row> | |
768 | <entry>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</entry> | |
769 | <entry>Mode 1 (2K FFT)</entry> | |
770 | <entry>Mode 2 (4K FFT)</entry> | |
771 | <entry>Mode 3 (8K FFT)</entry> | |
772 | </row> | |
773 | <row> | |
774 | <entry>0</entry> | |
775 | <entry>0</entry> | |
776 | <entry>0</entry> | |
777 | <entry>0</entry> | |
778 | </row> | |
779 | <row> | |
780 | <entry>1</entry> | |
781 | <entry>4</entry> | |
782 | <entry>2</entry> | |
783 | <entry>1</entry> | |
784 | </row> | |
785 | <row> | |
786 | <entry>2</entry> | |
787 | <entry>8</entry> | |
788 | <entry>4</entry> | |
789 | <entry>2</entry> | |
790 | </row> | |
791 | <row> | |
792 | <entry>4</entry> | |
793 | <entry>16</entry> | |
794 | <entry>8</entry> | |
795 | <entry>4</entry> | |
796 | </row> | |
797 | </tbody> | |
798 | </tgroup> | |
799 | </informaltable> | |
17d8bb06 | 800 | </section> |
edaa136d MK |
801 | <section id="DTV-ATSCMH-FIC-VER"> |
802 | <title><constant>DTV_ATSCMH_FIC_VER</constant></title> | |
803 | <para>Version number of the FIC (Fast Information Channel) signaling data.</para> | |
804 | <para>FIC is used for relaying information to allow rapid service acquisition by the receiver.</para> | |
805 | <para>Possible values: 0, 1, 2, 3, ..., 30, 31</para> | |
806 | </section> | |
807 | <section id="DTV-ATSCMH-PARADE-ID"> | |
808 | <title><constant>DTV_ATSCMH_PARADE_ID</constant></title> | |
809 | <para>Parade identification number</para> | |
810 | <para>A parade is a collection of up to eight MH groups, conveying one or two ensembles.</para> | |
811 | <para>Possible values: 0, 1, 2, 3, ..., 126, 127</para> | |
812 | </section> | |
813 | <section id="DTV-ATSCMH-NOG"> | |
814 | <title><constant>DTV_ATSCMH_NOG</constant></title> | |
815 | <para>Number of MH groups per MH subframe for a designated parade.</para> | |
816 | <para>Possible values: 1, 2, 3, 4, 5, 6, 7, 8</para> | |
817 | </section> | |
818 | <section id="DTV-ATSCMH-TNOG"> | |
819 | <title><constant>DTV_ATSCMH_TNOG</constant></title> | |
820 | <para>Total number of MH groups including all MH groups belonging to all MH parades in one MH subframe.</para> | |
821 | <para>Possible values: 0, 1, 2, 3, ..., 30, 31</para> | |
822 | </section> | |
823 | <section id="DTV-ATSCMH-SGN"> | |
824 | <title><constant>DTV_ATSCMH_SGN</constant></title> | |
825 | <para>Start group number.</para> | |
826 | <para>Possible values: 0, 1, 2, 3, ..., 14, 15</para> | |
827 | </section> | |
828 | <section id="DTV-ATSCMH-PRC"> | |
829 | <title><constant>DTV_ATSCMH_PRC</constant></title> | |
830 | <para>Parade repetition cycle.</para> | |
831 | <para>Possible values: 1, 2, 3, 4, 5, 6, 7, 8</para> | |
832 | </section> | |
833 | <section id="DTV-ATSCMH-RS-FRAME-MODE"> | |
834 | <title><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></title> | |
b69d5f26 | 835 | <para>Reed Solomon (RS) frame mode.</para> |
edaa136d | 836 | <para>Possible values are:</para> |
b69d5f26 MCC |
837 | <table pgwide="1" frame="none" id="atscmh-rs-frame-mode"> |
838 | <title>enum atscmh_rs_frame_mode</title> | |
839 | <tgroup cols="2"> | |
840 | &cs-def; | |
841 | <thead> | |
842 | <row> | |
843 | <entry>ID</entry> | |
844 | <entry>Description</entry> | |
845 | </row> | |
846 | </thead> | |
847 | <tbody valign="top"> | |
848 | <row> | |
849 | <entry id="ATSCMH-RSFRAME-PRI-ONLY"><constant>ATSCMH_RSFRAME_PRI_ONLY</constant></entry> | |
8092cd7f MCC |
850 | <entry>Single Frame: There is only a primary RS Frame for all |
851 | Group Regions.</entry> | |
b69d5f26 MCC |
852 | </row><row> |
853 | <entry id="ATSCMH-RSFRAME-PRI-SEC"><constant>ATSCMH_RSFRAME_PRI_SEC</constant></entry> | |
8092cd7f MCC |
854 | <entry>Dual Frame: There are two separate RS Frames: Primary RS |
855 | Frame for Group Region A and B and Secondary RS Frame for Group | |
856 | Region C and D.</entry> | |
b69d5f26 MCC |
857 | </row> |
858 | </tbody> | |
859 | </tgroup> | |
860 | </table> | |
edaa136d MK |
861 | </section> |
862 | <section id="DTV-ATSCMH-RS-FRAME-ENSEMBLE"> | |
863 | <title><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></title> | |
8092cd7f | 864 | <para>Reed Solomon(RS) frame ensemble.</para> |
edaa136d | 865 | <para>Possible values are:</para> |
b69d5f26 MCC |
866 | <table pgwide="1" frame="none" id="atscmh-rs-frame-ensemble"> |
867 | <title>enum atscmh_rs_frame_ensemble</title> | |
868 | <tgroup cols="2"> | |
869 | &cs-def; | |
870 | <thead> | |
871 | <row> | |
872 | <entry>ID</entry> | |
873 | <entry>Description</entry> | |
874 | </row> | |
875 | </thead> | |
876 | <tbody valign="top"> | |
877 | <row> | |
878 | <entry id="ATSCMH-RSFRAME-ENS-PRI"><constant>ATSCMH_RSFRAME_ENS_PRI</constant></entry> | |
8092cd7f | 879 | <entry>Primary Ensemble.</entry> |
b69d5f26 MCC |
880 | </row><row> |
881 | <entry id="ATSCMH-RSFRAME-ENS-SEC"><constant>AATSCMH_RSFRAME_PRI_SEC</constant></entry> | |
8092cd7f | 882 | <entry>Secondary Ensemble.</entry> |
b69d5f26 MCC |
883 | </row><row> |
884 | <entry id="ATSCMH-RSFRAME-RES"><constant>AATSCMH_RSFRAME_RES</constant></entry> | |
8092cd7f | 885 | <entry>Reserved. Shouldn't be used.</entry> |
b69d5f26 MCC |
886 | </row> |
887 | </tbody> | |
888 | </tgroup> | |
889 | </table> | |
edaa136d MK |
890 | </section> |
891 | <section id="DTV-ATSCMH-RS-CODE-MODE-PRI"> | |
892 | <title><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></title> | |
8092cd7f | 893 | <para>Reed Solomon (RS) code mode (primary).</para> |
edaa136d | 894 | <para>Possible values are:</para> |
b69d5f26 MCC |
895 | <table pgwide="1" frame="none" id="atscmh-rs-code-mode"> |
896 | <title>enum atscmh_rs_code_mode</title> | |
897 | <tgroup cols="2"> | |
898 | &cs-def; | |
899 | <thead> | |
900 | <row> | |
901 | <entry>ID</entry> | |
902 | <entry>Description</entry> | |
903 | </row> | |
904 | </thead> | |
905 | <tbody valign="top"> | |
906 | <row> | |
907 | <entry id="ATSCMH-RSCODE-211-187"><constant>ATSCMH_RSCODE_211_187</constant></entry> | |
8092cd7f | 908 | <entry>Reed Solomon code (211,187).</entry> |
b69d5f26 MCC |
909 | </row><row> |
910 | <entry id="ATSCMH-RSCODE-223-187"><constant>ATSCMH_RSCODE_223_187</constant></entry> | |
8092cd7f | 911 | <entry>Reed Solomon code (223,187).</entry> |
b69d5f26 MCC |
912 | </row><row> |
913 | <entry id="ATSCMH-RSCODE-235-187"><constant>ATSCMH_RSCODE_235_187</constant></entry> | |
8092cd7f | 914 | <entry>Reed Solomon code (235,187).</entry> |
b69d5f26 MCC |
915 | </row><row> |
916 | <entry id="ATSCMH-RSCODE-RES"><constant>ATSCMH_RSCODE_RES</constant></entry> | |
8092cd7f | 917 | <entry>Reserved. Shouldn't be used.</entry> |
b69d5f26 MCC |
918 | </row> |
919 | </tbody> | |
920 | </tgroup> | |
921 | </table> | |
edaa136d MK |
922 | </section> |
923 | <section id="DTV-ATSCMH-RS-CODE-MODE-SEC"> | |
924 | <title><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></title> | |
8092cd7f | 925 | <para>Reed Solomon (RS) code mode (secondary).</para> |
b69d5f26 MCC |
926 | <para>Possible values are the same as documented on |
927 | &atscmh-rs-code-mode;:</para> | |
edaa136d MK |
928 | </section> |
929 | <section id="DTV-ATSCMH-SCCC-BLOCK-MODE"> | |
930 | <title><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></title> | |
931 | <para>Series Concatenated Convolutional Code Block Mode.</para> | |
932 | <para>Possible values are:</para> | |
b69d5f26 MCC |
933 | <table pgwide="1" frame="none" id="atscmh-sccc-block-mode"> |
934 | <title>enum atscmh_scc_block_mode</title> | |
935 | <tgroup cols="2"> | |
936 | &cs-def; | |
937 | <thead> | |
938 | <row> | |
939 | <entry>ID</entry> | |
940 | <entry>Description</entry> | |
941 | </row> | |
942 | </thead> | |
943 | <tbody valign="top"> | |
944 | <row> | |
945 | <entry id="ATSCMH-SCCC-BLK-SEP"><constant>ATSCMH_SCCC_BLK_SEP</constant></entry> | |
8092cd7f MCC |
946 | <entry>Separate SCCC: the SCCC outer code mode shall be set independently |
947 | for each Group Region (A, B, C, D)</entry> | |
b69d5f26 MCC |
948 | </row><row> |
949 | <entry id="ATSCMH-SCCC-BLK-COMB"><constant>ATSCMH_SCCC_BLK_COMB</constant></entry> | |
8092cd7f MCC |
950 | <entry>Combined SCCC: all four Regions shall have the same SCCC outer |
951 | code mode.</entry> | |
b69d5f26 MCC |
952 | </row><row> |
953 | <entry id="ATSCMH-SCCC-BLK-RES"><constant>ATSCMH_SCCC_BLK_RES</constant></entry> | |
8092cd7f | 954 | <entry>Reserved. Shouldn't be used.</entry> |
b69d5f26 MCC |
955 | </row> |
956 | </tbody> | |
957 | </tgroup> | |
958 | </table> | |
edaa136d MK |
959 | </section> |
960 | <section id="DTV-ATSCMH-SCCC-CODE-MODE-A"> | |
961 | <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></title> | |
962 | <para>Series Concatenated Convolutional Code Rate.</para> | |
963 | <para>Possible values are:</para> | |
b69d5f26 MCC |
964 | <table pgwide="1" frame="none" id="atscmh-sccc-code-mode"> |
965 | <title>enum atscmh_sccc_code_mode</title> | |
966 | <tgroup cols="2"> | |
967 | &cs-def; | |
968 | <thead> | |
969 | <row> | |
970 | <entry>ID</entry> | |
971 | <entry>Description</entry> | |
972 | </row> | |
973 | </thead> | |
974 | <tbody valign="top"> | |
975 | <row> | |
976 | <entry id="ATSCMH-SCCC-CODE-HLF"><constant>ATSCMH_SCCC_CODE_HLF</constant></entry> | |
8092cd7f | 977 | <entry>The outer code rate of a SCCC Block is 1/2 rate.</entry> |
b69d5f26 MCC |
978 | </row><row> |
979 | <entry id="ATSCMH-SCCC-CODE-QTR"><constant>ATSCMH_SCCC_CODE_QTR</constant></entry> | |
8092cd7f | 980 | <entry>The outer code rate of a SCCC Block is 1/4 rate.</entry> |
b69d5f26 MCC |
981 | </row><row> |
982 | <entry id="ATSCMH-SCCC-CODE-RES"><constant>ATSCMH_SCCC_CODE_RES</constant></entry> | |
983 | <entry>to be documented.</entry> | |
984 | </row> | |
985 | </tbody> | |
986 | </tgroup> | |
987 | </table> | |
edaa136d MK |
988 | </section> |
989 | <section id="DTV-ATSCMH-SCCC-CODE-MODE-B"> | |
990 | <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></title> | |
991 | <para>Series Concatenated Convolutional Code Rate.</para> | |
b69d5f26 MCC |
992 | <para>Possible values are the same as documented on |
993 | &atscmh-sccc-code-mode;.</para> | |
edaa136d MK |
994 | </section> |
995 | <section id="DTV-ATSCMH-SCCC-CODE-MODE-C"> | |
996 | <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></title> | |
997 | <para>Series Concatenated Convolutional Code Rate.</para> | |
b69d5f26 MCC |
998 | <para>Possible values are the same as documented on |
999 | &atscmh-sccc-code-mode;.</para> | |
edaa136d MK |
1000 | </section> |
1001 | <section id="DTV-ATSCMH-SCCC-CODE-MODE-D"> | |
1002 | <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></title> | |
1003 | <para>Series Concatenated Convolutional Code Rate.</para> | |
b69d5f26 MCC |
1004 | <para>Possible values are the same as documented on |
1005 | &atscmh-sccc-code-mode;.</para> | |
edaa136d | 1006 | </section> |
17d8bb06 | 1007 | </section> |
04a92077 MCC |
1008 | <section id="DTV-API-VERSION"> |
1009 | <title><constant>DTV_API_VERSION</constant></title> | |
1010 | <para>Returns the major/minor version of the DVB API</para> | |
1011 | </section> | |
1012 | <section id="DTV-CODE-RATE-HP"> | |
1013 | <title><constant>DTV_CODE_RATE_HP</constant></title> | |
2d457b8a MCC |
1014 | <para>Used on terrestrial transmissions. The acceptable values are |
1015 | the ones described at &fe-transmit-mode-t;. | |
04a92077 | 1016 | </para> |
04a92077 MCC |
1017 | </section> |
1018 | <section id="DTV-CODE-RATE-LP"> | |
1019 | <title><constant>DTV_CODE_RATE_LP</constant></title> | |
2d457b8a MCC |
1020 | <para>Used on terrestrial transmissions. The acceptable values are |
1021 | the ones described at &fe-transmit-mode-t;. | |
04a92077 | 1022 | </para> |
2d457b8a | 1023 | |
04a92077 | 1024 | </section> |
2d457b8a | 1025 | |
17d8bb06 MCC |
1026 | <section id="DTV-GUARD-INTERVAL"> |
1027 | <title><constant>DTV_GUARD_INTERVAL</constant></title> | |
0ed08b49 | 1028 | |
17d8bb06 | 1029 | <para>Possible values are:</para> |
903142e5 MCC |
1030 | |
1031 | <section id="fe-guard-interval-t"> | |
1032 | <title>Modulation guard interval</title> | |
1033 | ||
1034 | <table pgwide="1" frame="none" id="fe-guard-interval"> | |
1035 | <title>enum fe_guard_interval</title> | |
1036 | <tgroup cols="2"> | |
1037 | &cs-def; | |
1038 | <thead> | |
1039 | <row> | |
1040 | <entry>ID</entry> | |
1041 | <entry>Description</entry> | |
1042 | </row> | |
1043 | </thead> | |
1044 | <tbody valign="top"> | |
1045 | <row> | |
00c91dfd | 1046 | <entry id="GUARD-INTERVAL-AUTO"><constant>GUARD_INTERVAL_AUTO</constant></entry> |
903142e5 MCC |
1047 | <entry>Autodetect the guard interval</entry> |
1048 | </row><row> | |
00c91dfd | 1049 | <entry id="GUARD-INTERVAL-1-128"><constant>GUARD_INTERVAL_1_128</constant></entry> |
903142e5 MCC |
1050 | <entry>Guard interval 1/128</entry> |
1051 | </row><row> | |
00c91dfd | 1052 | <entry id="GUARD-INTERVAL-1-32"><constant>GUARD_INTERVAL_1_32</constant></entry> |
903142e5 MCC |
1053 | <entry>Guard interval 1/32</entry> |
1054 | </row><row> | |
00c91dfd | 1055 | <entry id="GUARD-INTERVAL-1-16"><constant>GUARD_INTERVAL_1_16</constant></entry> |
903142e5 MCC |
1056 | <entry>Guard interval 1/16</entry> |
1057 | </row><row> | |
00c91dfd | 1058 | <entry id="GUARD-INTERVAL-1-8"><constant>GUARD_INTERVAL_1_8</constant></entry> |
903142e5 MCC |
1059 | <entry>Guard interval 1/8</entry> |
1060 | </row><row> | |
00c91dfd | 1061 | <entry id="GUARD-INTERVAL-1-4"><constant>GUARD_INTERVAL_1_4</constant></entry> |
903142e5 MCC |
1062 | <entry>Guard interval 1/4</entry> |
1063 | </row><row> | |
00c91dfd | 1064 | <entry id="GUARD-INTERVAL-19-128"><constant>GUARD_INTERVAL_19_128</constant></entry> |
903142e5 MCC |
1065 | <entry>Guard interval 19/128</entry> |
1066 | </row><row> | |
00c91dfd | 1067 | <entry id="GUARD-INTERVAL-19-256"><constant>GUARD_INTERVAL_19_256</constant></entry> |
903142e5 MCC |
1068 | <entry>Guard interval 19/256</entry> |
1069 | </row><row> | |
00c91dfd | 1070 | <entry id="GUARD-INTERVAL-PN420"><constant>GUARD_INTERVAL_PN420</constant></entry> |
903142e5 MCC |
1071 | <entry>PN length 420 (1/4)</entry> |
1072 | </row><row> | |
00c91dfd | 1073 | <entry id="GUARD-INTERVAL-PN595"><constant>GUARD_INTERVAL_PN595</constant></entry> |
903142e5 MCC |
1074 | <entry>PN length 595 (1/6)</entry> |
1075 | </row><row> | |
00c91dfd | 1076 | <entry id="GUARD-INTERVAL-PN945"><constant>GUARD_INTERVAL_PN945</constant></entry> |
903142e5 MCC |
1077 | <entry>PN length 945 (1/9)</entry> |
1078 | </row> | |
1079 | </tbody> | |
1080 | </tgroup> | |
1081 | </table> | |
0ed08b49 | 1082 | |
17d8bb06 MCC |
1083 | <para>Notes:</para> |
1084 | <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will | |
1085 | try to find the correct guard interval (if capable) and will use TMCC to fill | |
1086 | in the missing parameters.</para> | |
1087 | <para>2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at present</para> | |
224b6642 | 1088 | <para>3) DTMB specifies PN420, PN595 and PN945.</para> |
595d041a | 1089 | </section> |
0ed08b49 | 1090 | </section> |
95e61e01 | 1091 | <section id="DTV-TRANSMISSION-MODE"> |
0ed08b49 MCC |
1092 | <title><constant>DTV_TRANSMISSION_MODE</constant></title> |
1093 | ||
0577a2f6 MCC |
1094 | <para>Specifies the number of carriers used by the standard. |
1095 | This is used only on OFTM-based standards, e. g. | |
1096 | DVB-T/T2, ISDB-T, DTMB</para> | |
1097 | ||
1098 | <section id="fe-transmit-mode-t"> | |
1099 | <title>enum fe_transmit_mode: Number of carriers per channel</title> | |
1100 | ||
1101 | <table pgwide="1" frame="none" id="fe-transmit-mode"> | |
1102 | <title>enum fe_transmit_mode</title> | |
1103 | <tgroup cols="2"> | |
1104 | &cs-def; | |
1105 | <thead> | |
1106 | <row> | |
1107 | <entry>ID</entry> | |
1108 | <entry>Description</entry> | |
1109 | </row> | |
1110 | </thead> | |
1111 | <tbody valign="top"> | |
1112 | <row> | |
00c91dfd | 1113 | <entry id="TRANSMISSION-MODE-AUTO"><constant>TRANSMISSION_MODE_AUTO</constant></entry> |
0577a2f6 MCC |
1114 | <entry>Autodetect transmission mode. The hardware will try to find |
1115 | the correct FFT-size (if capable) to fill in the missing | |
1116 | parameters.</entry> | |
1117 | </row><row> | |
00c91dfd | 1118 | <entry id="TRANSMISSION-MODE-1K"><constant>TRANSMISSION_MODE_1K</constant></entry> |
0577a2f6 MCC |
1119 | <entry>Transmission mode 1K</entry> |
1120 | </row><row> | |
00c91dfd | 1121 | <entry id="TRANSMISSION-MODE-2K"><constant>TRANSMISSION_MODE_2K</constant></entry> |
0577a2f6 MCC |
1122 | <entry>Transmission mode 2K</entry> |
1123 | </row><row> | |
00c91dfd | 1124 | <entry id="TRANSMISSION-MODE-8K"><constant>TRANSMISSION_MODE_8K</constant></entry> |
0577a2f6 MCC |
1125 | <entry>Transmission mode 8K</entry> |
1126 | </row><row> | |
00c91dfd | 1127 | <entry id="TRANSMISSION-MODE-4K"><constant>TRANSMISSION_MODE_4K</constant></entry> |
0577a2f6 MCC |
1128 | <entry>Transmission mode 4K</entry> |
1129 | </row><row> | |
00c91dfd | 1130 | <entry id="TRANSMISSION-MODE-16K"><constant>TRANSMISSION_MODE_16K</constant></entry> |
0577a2f6 MCC |
1131 | <entry>Transmission mode 16K</entry> |
1132 | </row><row> | |
00c91dfd | 1133 | <entry id="TRANSMISSION-MODE-32K"><constant>TRANSMISSION_MODE_32K</constant></entry> |
0577a2f6 MCC |
1134 | <entry>Transmission mode 32K</entry> |
1135 | </row><row> | |
00c91dfd | 1136 | <entry id="TRANSMISSION-MODE-C1"><constant>TRANSMISSION_MODE_C1</constant></entry> |
0577a2f6 MCC |
1137 | <entry>Single Carrier (C=1) transmission mode (DTMB)</entry> |
1138 | </row><row> | |
00c91dfd | 1139 | <entry id="TRANSMISSION-MODE-C3780"><constant>TRANSMISSION_MODE_C3780</constant></entry> |
0577a2f6 | 1140 | <entry>Multi Carrier (C=3780) transmission mode (DTMB)</entry> |
0577a2f6 MCC |
1141 | </row> |
1142 | </tbody> | |
1143 | </tgroup> | |
1144 | </table> | |
0577a2f6 | 1145 | |
0ed08b49 | 1146 | |
0ed08b49 MCC |
1147 | <para>Notes:</para> |
1148 | <para>1) ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called | |
1149 | 'mode' in the standard: Mode 1 is 2K, mode 2 is 4K, mode 3 is 8K</para> | |
1150 | ||
1151 | <para>2) If <constant>DTV_TRANSMISSION_MODE</constant> is set the <constant>TRANSMISSION_MODE_AUTO</constant> the | |
1152 | hardware will try to find the correct FFT-size (if capable) and will | |
1153 | use TMCC to fill in the missing parameters.</para> | |
cf75f9ba SK |
1154 | <para>3) DVB-T specifies 2K and 8K as valid sizes.</para> |
1155 | <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para> | |
224b6642 | 1156 | <para>5) DTMB specifies C1 and C3780.</para> |
595d041a | 1157 | </section> |
0ed08b49 | 1158 | </section> |
17d8bb06 MCC |
1159 | <section id="DTV-HIERARCHY"> |
1160 | <title><constant>DTV_HIERARCHY</constant></title> | |
1161 | <para>Frontend hierarchy</para> | |
9df4fc5b MCC |
1162 | |
1163 | ||
1164 | <section id="fe-hierarchy-t"> | |
1165 | <title>Frontend hierarchy</title> | |
1166 | ||
1167 | <table pgwide="1" frame="none" id="fe-hierarchy"> | |
1168 | <title>enum fe_hierarchy</title> | |
1169 | <tgroup cols="2"> | |
1170 | &cs-def; | |
1171 | <thead> | |
1172 | <row> | |
1173 | <entry>ID</entry> | |
1174 | <entry>Description</entry> | |
1175 | </row> | |
1176 | </thead> | |
1177 | <tbody valign="top"> | |
1178 | <row> | |
00c91dfd | 1179 | <entry id="HIERARCHY-NONE"><constant>HIERARCHY_NONE</constant></entry> |
9df4fc5b MCC |
1180 | <entry>No hierarchy</entry> |
1181 | </row><row> | |
00c91dfd | 1182 | <entry id="HIERARCHY-AUTO"><constant>HIERARCHY_AUTO</constant></entry> |
9df4fc5b MCC |
1183 | <entry>Autodetect hierarchy (if supported)</entry> |
1184 | </row><row> | |
00c91dfd | 1185 | <entry id="HIERARCHY-1"><constant>HIERARCHY_1</constant></entry> |
9df4fc5b MCC |
1186 | <entry>Hierarchy 1</entry> |
1187 | </row><row> | |
00c91dfd | 1188 | <entry id="HIERARCHY-2"><constant>HIERARCHY_2</constant></entry> |
9df4fc5b MCC |
1189 | <entry>Hierarchy 2</entry> |
1190 | </row><row> | |
00c91dfd | 1191 | <entry id="HIERARCHY-4"><constant>HIERARCHY_4</constant></entry> |
9df4fc5b MCC |
1192 | <entry>Hierarchy 4</entry> |
1193 | </row> | |
1194 | </tbody> | |
1195 | </tgroup> | |
1196 | </table> | |
1197 | </section> | |
1198 | ||
0ed08b49 | 1199 | </section> |
81800159 EP |
1200 | <section id="DTV-STREAM-ID"> |
1201 | <title><constant>DTV_STREAM_ID</constant></title> | |
1202 | <para>DVB-S2, DVB-T2 and ISDB-S support the transmission of several | |
1203 | streams on a single transport stream. | |
1204 | This property enables the DVB driver to handle substream filtering, | |
1205 | when supported by the hardware. | |
1206 | By default, substream filtering is disabled. | |
1207 | </para><para> | |
1208 | For DVB-S2 and DVB-T2, the valid substream id range is from 0 to 255. | |
1209 | </para><para> | |
1210 | For ISDB, the valid substream id range is from 1 to 65535. | |
1211 | </para><para> | |
1212 | To disable it, you should use the special macro NO_STREAM_ID_FILTER. | |
1213 | </para><para> | |
1214 | Note: any value outside the id range also disables filtering. | |
1215 | </para> | |
453d63c6 | 1216 | </section> |
81800159 EP |
1217 | <section id="DTV-DVBT2-PLP-ID-LEGACY"> |
1218 | <title><constant>DTV_DVBT2_PLP_ID_LEGACY</constant></title> | |
1219 | <para>Obsolete, replaced with DTV_STREAM_ID.</para> | |
17d8bb06 | 1220 | </section> |
510f0a0f | 1221 | <section id="DTV-ENUM-DELSYS"> |
6c7ef547 MA |
1222 | <title><constant>DTV_ENUM_DELSYS</constant></title> |
1223 | <para>A Multi standard frontend needs to advertise the delivery systems provided. | |
1224 | Applications need to enumerate the provided delivery systems, before using | |
1225 | any other operation with the frontend. Prior to it's introduction, | |
1226 | FE_GET_INFO was used to determine a frontend type. A frontend which | |
1227 | provides more than a single delivery system, FE_GET_INFO doesn't help much. | |
1228 | Applications which intends to use a multistandard frontend must enumerate | |
1229 | the delivery systems associated with it, rather than trying to use | |
1230 | FE_GET_INFO. In the case of a legacy frontend, the result is just the same | |
1231 | as with FE_GET_INFO, but in a more structured format </para> | |
1232 | </section> | |
224b6642 AP |
1233 | <section id="DTV-INTERLEAVING"> |
1234 | <title><constant>DTV_INTERLEAVING</constant></title> | |
3d6d2137 MCC |
1235 | |
1236 | <para>Time interleaving to be used. Currently, used only on DTMB.</para> | |
1237 | ||
1238 | <table pgwide="1" frame="none" id="fe-interleaving"> | |
1239 | <title>enum fe_interleaving</title> | |
1240 | <tgroup cols="2"> | |
1241 | &cs-def; | |
1242 | <thead> | |
1243 | <row> | |
1244 | <entry>ID</entry> | |
1245 | <entry>Description</entry> | |
1246 | </row> | |
1247 | </thead> | |
1248 | <tbody valign="top"> | |
1249 | <row> | |
1250 | <entry id="INTERLEAVING-NONE"><constant>INTERLEAVING_NONE</constant></entry> | |
1251 | <entry>No interleaving.</entry> | |
1252 | </row><row> | |
1253 | <entry id="INTERLEAVING-AUTO"><constant>INTERLEAVING_AUTO</constant></entry> | |
1254 | <entry>Auto-detect interleaving.</entry> | |
1255 | </row><row> | |
1256 | <entry id="INTERLEAVING-240"><constant>INTERLEAVING_240</constant></entry> | |
1257 | <entry>Interleaving of 240 symbols.</entry> | |
1258 | </row><row> | |
1259 | <entry id="INTERLEAVING-720"><constant>INTERLEAVING_720</constant></entry> | |
1260 | <entry>Interleaving of 720 symbols.</entry> | |
1261 | </row> | |
1262 | </tbody> | |
1263 | </tgroup> | |
1264 | </table> | |
1265 | ||
224b6642 | 1266 | </section> |
ee47e2f9 AP |
1267 | <section id="DTV-LNA"> |
1268 | <title><constant>DTV_LNA</constant></title> | |
1269 | <para>Low-noise amplifier.</para> | |
1270 | <para>Hardware might offer controllable LNA which can be set manually | |
1271 | using that parameter. Usually LNA could be found only from | |
1272 | terrestrial devices if at all.</para> | |
1273 | <para>Possible values: 0, 1, LNA_AUTO</para> | |
1274 | <para>0, LNA off</para> | |
1275 | <para>1, LNA on</para> | |
1276 | <para>use the special macro LNA_AUTO to set LNA auto</para> | |
1277 | </section> | |
994e262e | 1278 | </section> |
9569793a MCC |
1279 | |
1280 | <section id="frontend-stat-properties"> | |
1281 | <title>Frontend statistics indicators</title> | |
1282 | <para>The values are returned via <constant>dtv_property.stat</constant>. | |
1283 | If the property is supported, <constant>dtv_property.stat.len</constant> is bigger than zero.</para> | |
1284 | <para>For most delivery systems, <constant>dtv_property.stat.len</constant> | |
1285 | will be 1 if the stats is supported, and the properties will | |
1286 | return a single value for each parameter.</para> | |
7832a915 | 1287 | <para>It should be noted, however, that new OFDM delivery systems |
9569793a MCC |
1288 | like ISDB can use different modulation types for each group of |
1289 | carriers. On such standards, up to 3 groups of statistics can be | |
1290 | provided, and <constant>dtv_property.stat.len</constant> is updated | |
1291 | to reflect the "global" metrics, plus one metric per each carrier | |
1292 | group (called "layer" on ISDB).</para> | |
1293 | <para>So, in order to be consistent with other delivery systems, the first | |
1294 | value at <link linkend="dtv-stats"><constant>dtv_property.stat.dtv_stats</constant></link> | |
1295 | array refers to the global metric. The other elements of the array | |
1296 | represent each layer, starting from layer A(index 1), | |
1297 | layer B (index 2) and so on.</para> | |
1298 | <para>The number of filled elements are stored at <constant>dtv_property.stat.len</constant>.</para> | |
1299 | <para>Each element of the <constant>dtv_property.stat.dtv_stats</constant> array consists on two elements:</para> | |
1300 | <itemizedlist mark='opencircle'> | |
1301 | <listitem><para><constant>svalue</constant> or <constant>uvalue</constant>, where | |
1302 | <constant>svalue</constant> is for signed values of the measure (dB measures) | |
1303 | and <constant>uvalue</constant> is for unsigned values (counters, relative scale)</para></listitem> | |
1304 | <listitem><para><constant>scale</constant> - Scale for the value. It can be:</para> | |
820eac0e | 1305 | <itemizedlist mark='bullet' id="fecap-scale-params"> |
00c91dfd MCC |
1306 | <listitem id="FE-SCALE-NOT-AVAILABLE"><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - The parameter is supported by the frontend, but it was not possible to collect it (could be a transitory or permanent condition)</para></listitem> |
1307 | <listitem id="FE-SCALE-DECIBEL"><para><constant>FE_SCALE_DECIBEL</constant> - parameter is a signed value, measured in 1/1000 dB</para></listitem> | |
1308 | <listitem id="FE-SCALE-RELATIVE"><para><constant>FE_SCALE_RELATIVE</constant> - parameter is a unsigned value, where 0 means 0% and 65535 means 100%.</para></listitem> | |
1309 | <listitem id="FE-SCALE-COUNTER"><para><constant>FE_SCALE_COUNTER</constant> - parameter is a unsigned value that counts the occurrence of an event, like bit error, block error, or lapsed time.</para></listitem> | |
9569793a | 1310 | </itemizedlist> |
9569793a MCC |
1311 | </listitem> |
1312 | </itemizedlist> | |
1313 | <section id="DTV-STAT-SIGNAL-STRENGTH"> | |
1314 | <title><constant>DTV_STAT_SIGNAL_STRENGTH</constant></title> | |
1315 | <para>Indicates the signal strength level at the analog part of the tuner or of the demod.</para> | |
1316 | <para>Possible scales for this metric are:</para> | |
1317 | <itemizedlist mark='bullet'> | |
820eac0e | 1318 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
4c12adad | 1319 | <listitem><para><constant>FE_SCALE_DECIBEL</constant> - signal strength is in 0.001 dBm units, power measured in miliwatts. This value is generally negative.</para></listitem> |
820eac0e | 1320 | <listitem><para><constant>FE_SCALE_RELATIVE</constant> - The frontend provides a 0% to 100% measurement for power (actually, 0 to 65535).</para></listitem> |
9569793a MCC |
1321 | </itemizedlist> |
1322 | </section> | |
1323 | <section id="DTV-STAT-CNR"> | |
1324 | <title><constant>DTV_STAT_CNR</constant></title> | |
1325 | <para>Indicates the Signal to Noise ratio for the main carrier.</para> | |
1326 | <para>Possible scales for this metric are:</para> | |
1327 | <itemizedlist mark='bullet'> | |
820eac0e | 1328 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
4c12adad | 1329 | <listitem><para><constant>FE_SCALE_DECIBEL</constant> - Signal/Noise ratio is in 0.001 dB units.</para></listitem> |
820eac0e | 1330 | <listitem><para><constant>FE_SCALE_RELATIVE</constant> - The frontend provides a 0% to 100% measurement for Signal/Noise (actually, 0 to 65535).</para></listitem> |
9569793a MCC |
1331 | </itemizedlist> |
1332 | </section> | |
1333 | <section id="DTV-STAT-PRE-ERROR-BIT-COUNT"> | |
1334 | <title><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></title> | |
1335 | <para>Measures the number of bit errors before the forward error correction (FEC) on the inner coding block (before Viterbi, LDPC or other inner code).</para> | |
1336 | <para>This measure is taken during the same interval as <constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant>.</para> | |
1337 | <para>In order to get the BER (Bit Error Rate) measurement, it should be divided by | |
1338 | <link linkend="DTV-STAT-PRE-TOTAL-BIT-COUNT"><constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant></link>.</para> | |
1339 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. | |
1340 | The frontend may reset it when a channel/transponder is tuned.</para> | |
1341 | <para>Possible scales for this metric are:</para> | |
1342 | <itemizedlist mark='bullet'> | |
820eac0e HV |
1343 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
1344 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error bits counted before the inner coding.</para></listitem> | |
9569793a MCC |
1345 | </itemizedlist> |
1346 | </section> | |
1347 | <section id="DTV-STAT-PRE-TOTAL-BIT-COUNT"> | |
1348 | <title><constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant></title> | |
1349 | <para>Measures the amount of bits received before the inner code block, during the same period as | |
1350 | <link linkend="DTV-STAT-PRE-ERROR-BIT-COUNT"><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></link> measurement was taken.</para> | |
7832a915 | 1351 | <para>It should be noted that this measurement can be smaller than the total amount of bits on the transport stream, |
842059aa | 1352 | as the frontend may need to manually restart the measurement, losing some data between each measurement interval.</para> |
9569793a MCC |
1353 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. |
1354 | The frontend may reset it when a channel/transponder is tuned.</para> | |
1355 | <para>Possible scales for this metric are:</para> | |
1356 | <itemizedlist mark='bullet'> | |
820eac0e HV |
1357 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
1358 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of bits counted while measuring | |
1359 | <link linkend="DTV-STAT-PRE-ERROR-BIT-COUNT"><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></link>.</para></listitem> | |
9569793a MCC |
1360 | </itemizedlist> |
1361 | </section> | |
1362 | <section id="DTV-STAT-POST-ERROR-BIT-COUNT"> | |
1363 | <title><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></title> | |
1364 | <para>Measures the number of bit errors after the forward error correction (FEC) done by inner code block (after Viterbi, LDPC or other inner code).</para> | |
1365 | <para>This measure is taken during the same interval as <constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant>.</para> | |
1366 | <para>In order to get the BER (Bit Error Rate) measurement, it should be divided by | |
1367 | <link linkend="DTV-STAT-POST-TOTAL-BIT-COUNT"><constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant></link>.</para> | |
1368 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. | |
1369 | The frontend may reset it when a channel/transponder is tuned.</para> | |
1370 | <para>Possible scales for this metric are:</para> | |
1371 | <itemizedlist mark='bullet'> | |
820eac0e HV |
1372 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
1373 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error bits counted after the inner coding.</para></listitem> | |
9569793a MCC |
1374 | </itemizedlist> |
1375 | </section> | |
1376 | <section id="DTV-STAT-POST-TOTAL-BIT-COUNT"> | |
1377 | <title><constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant></title> | |
1378 | <para>Measures the amount of bits received after the inner coding, during the same period as | |
1379 | <link linkend="DTV-STAT-POST-ERROR-BIT-COUNT"><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></link> measurement was taken.</para> | |
7832a915 | 1380 | <para>It should be noted that this measurement can be smaller than the total amount of bits on the transport stream, |
842059aa | 1381 | as the frontend may need to manually restart the measurement, losing some data between each measurement interval.</para> |
9569793a MCC |
1382 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. |
1383 | The frontend may reset it when a channel/transponder is tuned.</para> | |
1384 | <para>Possible scales for this metric are:</para> | |
1385 | <itemizedlist mark='bullet'> | |
820eac0e HV |
1386 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
1387 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of bits counted while measuring | |
1388 | <link linkend="DTV-STAT-POST-ERROR-BIT-COUNT"><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></link>.</para></listitem> | |
9569793a MCC |
1389 | </itemizedlist> |
1390 | </section> | |
1391 | <section id="DTV-STAT-ERROR-BLOCK-COUNT"> | |
1392 | <title><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></title> | |
1393 | <para>Measures the number of block errors after the outer forward error correction coding (after Reed-Solomon or other outer code).</para> | |
1394 | <para>This measurement is monotonically increased, as the frontend gets more bit count measurements. | |
1395 | The frontend may reset it when a channel/transponder is tuned.</para> | |
1396 | <para>Possible scales for this metric are:</para> | |
1397 | <itemizedlist mark='bullet'> | |
820eac0e HV |
1398 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
1399 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error blocks counted after the outer coding.</para></listitem> | |
9569793a MCC |
1400 | </itemizedlist> |
1401 | </section> | |
1402 | <section id="DTV-STAT-TOTAL-BLOCK-COUNT"> | |
1403 | <title><constant>DTV-STAT_TOTAL_BLOCK_COUNT</constant></title> | |
1404 | <para>Measures the total number of blocks received during the same period as | |
1405 | <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link> measurement was taken.</para> | |
1406 | <para>It can be used to calculate the PER indicator, by dividing | |
1407 | <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link> | |
1408 | by <link linkend="DTV-STAT-TOTAL-BLOCK-COUNT"><constant>DTV-STAT-TOTAL-BLOCK-COUNT</constant></link>.</para> | |
1409 | <para>Possible scales for this metric are:</para> | |
1410 | <itemizedlist mark='bullet'> | |
820eac0e HV |
1411 | <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem> |
1412 | <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of blocks counted while measuring | |
1413 | <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link>.</para></listitem> | |
9569793a MCC |
1414 | </itemizedlist> |
1415 | </section> | |
1416 | </section> | |
1417 | ||
994e262e MCC |
1418 | <section id="frontend-property-terrestrial-systems"> |
1419 | <title>Properties used on terrestrial delivery systems</title> | |
1420 | <section id="dvbt-params"> | |
1421 | <title>DVB-T delivery system</title> | |
1422 | <para>The following parameters are valid for DVB-T:</para> | |
1423 | <itemizedlist mark='opencircle'> | |
1424 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
e7da0ae3 | 1425 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
994e262e MCC |
1426 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
1427 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1428 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1429 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> | |
1430 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> | |
1431 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> | |
1432 | <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem> | |
1433 | <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem> | |
1434 | <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem> | |
1435 | <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem> | |
1436 | <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem> | |
ee47e2f9 | 1437 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
994e262e | 1438 | </itemizedlist> |
9569793a | 1439 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
994e262e MCC |
1440 | </section> |
1441 | <section id="dvbt2-params"> | |
1442 | <title>DVB-T2 delivery system</title> | |
ff74b8ee MCC |
1443 | <para>DVB-T2 support is currently in the early stages |
1444 | of development, so expect that this section maygrow and become | |
994e262e MCC |
1445 | more detailed with time.</para> |
1446 | <para>The following parameters are valid for DVB-T2:</para> | |
1447 | <itemizedlist mark='opencircle'> | |
1448 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
e7da0ae3 | 1449 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
994e262e MCC |
1450 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
1451 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1452 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1453 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> | |
1454 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> | |
1455 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> | |
1456 | <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem> | |
1457 | <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem> | |
1458 | <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem> | |
1459 | <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem> | |
1460 | <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem> | |
81800159 | 1461 | <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem> |
ee47e2f9 | 1462 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
994e262e | 1463 | </itemizedlist> |
9569793a | 1464 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
994e262e | 1465 | </section> |
17d8bb06 | 1466 | <section id="isdbt"> |
994e262e | 1467 | <title>ISDB-T delivery system</title> |
17d8bb06 MCC |
1468 | <para>This ISDB-T/ISDB-Tsb API extension should reflect all information |
1469 | needed to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible | |
1470 | that some very sophisticated devices won't need certain parameters to | |
1471 | tune.</para> | |
1472 | <para>The information given here should help application writers to know how | |
1473 | to handle ISDB-T and ISDB-Tsb hardware using the Linux DVB-API.</para> | |
1474 | <para>The details given here about ISDB-T and ISDB-Tsb are just enough to | |
1475 | basically show the dependencies between the needed parameter values, | |
1476 | but surely some information is left out. For more detailed information | |
1477 | see the following documents:</para> | |
1478 | <para>ARIB STD-B31 - "Transmission System for Digital Terrestrial | |
1479 | Television Broadcasting" and</para> | |
1480 | <para>ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial | |
1481 | Television Broadcasting".</para> | |
994e262e MCC |
1482 | <para>In order to understand the ISDB specific parameters, |
1483 | one has to have some knowledge the channel structure in | |
1484 | ISDB-T and ISDB-Tsb. I.e. it has to be known to | |
1485 | the reader that an ISDB-T channel consists of 13 segments, | |
1486 | that it can have up to 3 layer sharing those segments, | |
1487 | and things like that.</para> | |
1488 | <para>The following parameters are valid for ISDB-T:</para> | |
1489 | <itemizedlist mark='opencircle'> | |
1490 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
e7da0ae3 | 1491 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> |
994e262e MCC |
1492 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> |
1493 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1494 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
994e262e MCC |
1495 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> |
1496 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> | |
994e262e MCC |
1497 | <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem> |
1498 | <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem> | |
994e262e MCC |
1499 | <listitem><para><link linkend="DTV-ISDBT-LAYER-ENABLED"><constant>DTV_ISDBT_LAYER_ENABLED</constant></link></para></listitem> |
1500 | <listitem><para><link linkend="DTV-ISDBT-PARTIAL-RECEPTION"><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></link></para></listitem> | |
1501 | <listitem><para><link linkend="DTV-ISDBT-SOUND-BROADCASTING"><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></link></para></listitem> | |
1502 | <listitem><para><link linkend="DTV-ISDBT-SB-SUBCHANNEL-ID"><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></link></para></listitem> | |
1503 | <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-IDX"><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></link></para></listitem> | |
1504 | <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-COUNT"><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></link></para></listitem> | |
1505 | <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERA_FEC</constant></link></para></listitem> | |
1506 | <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERA_MODULATION</constant></link></para></listitem> | |
1507 | <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant></link></para></listitem> | |
1508 | <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERA_TIME_INTERLEAVING</constant></link></para></listitem> | |
1509 | <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERB_FEC</constant></link></para></listitem> | |
1510 | <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERB_MODULATION</constant></link></para></listitem> | |
1511 | <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERB_SEGMENT_COUNT</constant></link></para></listitem> | |
1512 | <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERB_TIME_INTERLEAVING</constant></link></para></listitem> | |
1513 | <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERC_FEC</constant></link></para></listitem> | |
1514 | <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERC_MODULATION</constant></link></para></listitem> | |
1515 | <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERC_SEGMENT_COUNT</constant></link></para></listitem> | |
1516 | <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERC_TIME_INTERLEAVING</constant></link></para></listitem> | |
1517 | </itemizedlist> | |
9569793a | 1518 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
cf75f9ba | 1519 | </section> |
76f9a69a MCC |
1520 | <section id="atsc-params"> |
1521 | <title>ATSC delivery system</title> | |
1522 | <para>The following parameters are valid for ATSC:</para> | |
1523 | <itemizedlist mark='opencircle'> | |
1524 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
1525 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> | |
1526 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> | |
1527 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1528 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1529 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> | |
1530 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> | |
1531 | </itemizedlist> | |
9569793a | 1532 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
76f9a69a | 1533 | </section> |
edaa136d MK |
1534 | <section id="atscmh-params"> |
1535 | <title>ATSC-MH delivery system</title> | |
1536 | <para>The following parameters are valid for ATSC-MH:</para> | |
1537 | <itemizedlist mark='opencircle'> | |
1538 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
1539 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> | |
1540 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> | |
1541 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1542 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1543 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> | |
1544 | <listitem><para><link linkend="DTV-ATSCMH-FIC-VER"><constant>DTV_ATSCMH_FIC_VER</constant></link></para></listitem> | |
1545 | <listitem><para><link linkend="DTV-ATSCMH-PARADE-ID"><constant>DTV_ATSCMH_PARADE_ID</constant></link></para></listitem> | |
1546 | <listitem><para><link linkend="DTV-ATSCMH-NOG"><constant>DTV_ATSCMH_NOG</constant></link></para></listitem> | |
1547 | <listitem><para><link linkend="DTV-ATSCMH-TNOG"><constant>DTV_ATSCMH_TNOG</constant></link></para></listitem> | |
1548 | <listitem><para><link linkend="DTV-ATSCMH-SGN"><constant>DTV_ATSCMH_SGN</constant></link></para></listitem> | |
1549 | <listitem><para><link linkend="DTV-ATSCMH-PRC"><constant>DTV_ATSCMH_PRC</constant></link></para></listitem> | |
1550 | <listitem><para><link linkend="DTV-ATSCMH-RS-FRAME-MODE"><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></link></para></listitem> | |
1551 | <listitem><para><link linkend="DTV-ATSCMH-RS-FRAME-ENSEMBLE"><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></link></para></listitem> | |
510f0a0f HV |
1552 | <listitem><para><link linkend="DTV-ATSCMH-RS-CODE-MODE-PRI"><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></link></para></listitem> |
1553 | <listitem><para><link linkend="DTV-ATSCMH-RS-CODE-MODE-SEC"><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></link></para></listitem> | |
edaa136d | 1554 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-BLOCK-MODE"><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></link></para></listitem> |
510f0a0f HV |
1555 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-A"><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></link></para></listitem> |
1556 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-B"><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></link></para></listitem> | |
1557 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-C"><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></link></para></listitem> | |
1558 | <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-D"><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></link></para></listitem> | |
edaa136d | 1559 | </itemizedlist> |
9569793a | 1560 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
edaa136d | 1561 | </section> |
224b6642 AP |
1562 | <section id="dtmb-params"> |
1563 | <title>DTMB delivery system</title> | |
1564 | <para>The following parameters are valid for DTMB:</para> | |
1565 | <itemizedlist mark='opencircle'> | |
1566 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
1567 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> | |
1568 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> | |
1569 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1570 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1571 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> | |
1572 | <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem> | |
1573 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> | |
1574 | <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem> | |
1575 | <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem> | |
1576 | <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem> | |
1577 | <listitem><para><link linkend="DTV-INTERLEAVING"><constant>DTV_INTERLEAVING</constant></link></para></listitem> | |
ee47e2f9 | 1578 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
224b6642 | 1579 | </itemizedlist> |
9569793a | 1580 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
224b6642 | 1581 | </section> |
cf75f9ba | 1582 | </section> |
994e262e | 1583 | <section id="frontend-property-cable-systems"> |
ff74b8ee | 1584 | <title>Properties used on cable delivery systems</title> |
e7da0ae3 MCC |
1585 | <section id="dvbc-params"> |
1586 | <title>DVB-C delivery system</title> | |
669a4ba4 MCC |
1587 | <para>The DVB-C Annex-A is the widely used cable standard. Transmission uses QAM modulation.</para> |
1588 | <para>The DVB-C Annex-C is optimized for 6MHz, and is used in Japan. It supports a subset of the Annex A modulation types, and a roll-off of 0.13, instead of 0.15</para> | |
e7da0ae3 MCC |
1589 | <para>The following parameters are valid for DVB-C Annex A/C:</para> |
1590 | <itemizedlist mark='opencircle'> | |
1591 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
1592 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> | |
1593 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> | |
1594 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1595 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1596 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> | |
1597 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> | |
1598 | <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem> | |
1599 | <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem> | |
ee47e2f9 | 1600 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
e7da0ae3 | 1601 | </itemizedlist> |
9569793a | 1602 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
e7da0ae3 MCC |
1603 | </section> |
1604 | <section id="dvbc-annex-b-params"> | |
1605 | <title>DVB-C Annex B delivery system</title> | |
1606 | <para>The DVB-C Annex-B is only used on a few Countries like the United States.</para> | |
1607 | <para>The following parameters are valid for DVB-C Annex B:</para> | |
1608 | <itemizedlist mark='opencircle'> | |
1609 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
1610 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> | |
1611 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> | |
1612 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1613 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1614 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> | |
1615 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> | |
ee47e2f9 | 1616 | <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem> |
e7da0ae3 | 1617 | </itemizedlist> |
9569793a | 1618 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
e7da0ae3 | 1619 | </section> |
994e262e | 1620 | </section> |
6fc1cb2e HV |
1621 | <section id="frontend-property-satellite-systems"> |
1622 | <title>Properties used on satellite delivery systems</title> | |
ff74b8ee MCC |
1623 | <section id="dvbs-params"> |
1624 | <title>DVB-S delivery system</title> | |
1625 | <para>The following parameters are valid for DVB-S:</para> | |
1626 | <itemizedlist mark='opencircle'> | |
1627 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
1628 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> | |
1629 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> | |
1630 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1631 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1632 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> | |
1633 | <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem> | |
1634 | <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem> | |
7fc9da2a AO |
1635 | <listitem><para><link linkend="DTV-VOLTAGE"><constant>DTV_VOLTAGE</constant></link></para></listitem> |
1636 | <listitem><para><link linkend="DTV-TONE"><constant>DTV_TONE</constant></link></para></listitem> | |
ff74b8ee | 1637 | </itemizedlist> |
9569793a | 1638 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
ff74b8ee MCC |
1639 | <para>Future implementations might add those two missing parameters:</para> |
1640 | <itemizedlist mark='opencircle'> | |
1641 | <listitem><para><link linkend="DTV-DISEQC-MASTER"><constant>DTV_DISEQC_MASTER</constant></link></para></listitem> | |
1642 | <listitem><para><link linkend="DTV-DISEQC-SLAVE-REPLY"><constant>DTV_DISEQC_SLAVE_REPLY</constant></link></para></listitem> | |
1643 | </itemizedlist> | |
1644 | </section> | |
1645 | <section id="dvbs2-params"> | |
1646 | <title>DVB-S2 delivery system</title> | |
7fc9da2a | 1647 | <para>In addition to all parameters valid for DVB-S, DVB-S2 supports the following parameters:</para> |
ff74b8ee | 1648 | <itemizedlist mark='opencircle'> |
7fc9da2a | 1649 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
ff74b8ee MCC |
1650 | <listitem><para><link linkend="DTV-PILOT"><constant>DTV_PILOT</constant></link></para></listitem> |
1651 | <listitem><para><link linkend="DTV-ROLLOFF"><constant>DTV_ROLLOFF</constant></link></para></listitem> | |
81800159 | 1652 | <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem> |
ff74b8ee | 1653 | </itemizedlist> |
9569793a | 1654 | <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para> |
7fc9da2a AO |
1655 | </section> |
1656 | <section id="turbo-params"> | |
1657 | <title>Turbo code delivery system</title> | |
1658 | <para>In addition to all parameters valid for DVB-S, turbo code supports the following parameters:</para> | |
ff74b8ee | 1659 | <itemizedlist mark='opencircle'> |
7fc9da2a | 1660 | <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem> |
ff74b8ee MCC |
1661 | </itemizedlist> |
1662 | </section> | |
1663 | <section id="isdbs-params"> | |
1664 | <title>ISDB-S delivery system</title> | |
1665 | <para>The following parameters are valid for ISDB-S:</para> | |
1666 | <itemizedlist mark='opencircle'> | |
1667 | <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem> | |
1668 | <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem> | |
1669 | <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem> | |
1670 | <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem> | |
1671 | <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem> | |
1672 | <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem> | |
1673 | <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem> | |
1674 | <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem> | |
1675 | <listitem><para><link linkend="DTV-VOLTAGE"><constant>DTV_VOLTAGE</constant></link></para></listitem> | |
81800159 | 1676 | <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem> |
ff74b8ee MCC |
1677 | </itemizedlist> |
1678 | </section> | |
994e262e | 1679 | </section> |
131db3a1 | 1680 | </section> |