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