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 <para>Example: with the properties based approach, in order to set the tuner
19 to a DVB-C channel at 651 kHz, modulated with 256-QAM, FEC 3/4 and symbol
20 rate of 5.217 Mbauds, those properties should be sent to
21 <link linkend="FE_GET_PROPERTY"><constant>FE_SET_PROPERTY</constant></link> ioctl:</para>
23 <listitem>&DTV-FREQUENCY; = 651000000</listitem>
24 <listitem>&DTV-MODULATION; = QAM_256</listitem>
25 <listitem>&DTV-INVERSION; = INVERSION_AUTO</listitem>
26 <listitem>&DTV-SYMBOL-RATE; = 5217000</listitem>
27 <listitem>&DTV-INNER-FEC; = FEC_3_4</listitem>
28 <listitem>&DTV-TUNE;</listitem>
30 <para>NOTE: This section describes the DVB version 5 extension of the DVB-API,
31 also called "S2API", as this API were added to provide support for DVB-S2. It
32 was designed to be able to replace the old frontend API. Yet, the DISEQC and
33 the capability ioctls weren't implemented yet via the new way.</para>
34 <para>The typical usage for the <constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant>
35 API is to replace the ioctl's were the <link linkend="dvb-frontend-parameters">
36 struct <constant>dvb_frontend_parameters</constant></link> were used.</para>
38 <section id="dtv-stats">
39 <title>DTV stats type</title>
42 __u8 scale; /* enum fecap_scale_params type */
44 __u64 uvalue; /* for counters and relative scales */
45 __s64 svalue; /* for 1/1000 dB measures */
50 <section id="dtv-fe-stats">
51 <title>DTV stats type</title>
53 #define MAX_DTV_STATS 4
57 struct dtv_stats stat[MAX_DTV_STATS];
62 <section id="dtv-property">
63 <title>DTV property type</title>
65 /* Reserved fields should be set to 0 */
72 struct dtv_fe_stats st;
81 } __attribute__ ((packed));
83 /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
84 #define DTV_IOCTL_MAX_MSGS 64
87 <section id="dtv-properties">
88 <title>DTV properties type</title>
90 struct dtv_properties {
92 struct dtv_property *props;
98 <title>Property types</title>
100 On <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY and FE_SET_PROPERTY</link>,
101 the actual action is determined by the dtv_property cmd/data pairs. With one single ioctl, is possible to
102 get/set up to 64 properties. The actual meaning of each property is described on the next sections.
105 <para>The available frontend property types are shown on the next section.</para>
108 <section id="fe_property_parameters">
109 <title>Digital TV property parameters</title>
110 <section id="DTV-UNDEFINED">
111 <title><constant>DTV_UNDEFINED</constant></title>
112 <para>Used internally. A GET/SET operation for it won't change or return anything.</para>
114 <section id="DTV-TUNE">
115 <title><constant>DTV_TUNE</constant></title>
116 <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>
118 <section id="DTV-CLEAR">
119 <title><constant>DTV_CLEAR</constant></title>
120 <para>Reset a cache of data specific to the frontend here. This does not effect hardware.</para>
122 <section id="DTV-FREQUENCY">
123 <title><constant>DTV_FREQUENCY</constant></title>
125 <para>Central frequency of the channel.</para>
128 <para>1)For satellital delivery systems, it is measured in kHz.
129 For the other ones, it is measured in Hz.</para>
130 <para>2)For ISDB-T, the channels are usually transmitted with an offset of 143kHz.
131 E.g. a valid frequency could be 474143 kHz. The stepping is bound to the bandwidth of
132 the channel which is 6MHz.</para>
134 <para>3)As in ISDB-Tsb the channel consists of only one or three segments the
135 frequency step is 429kHz, 3*429 respectively. As for ISDB-T the
136 central frequency of the channel is expected.</para>
138 <section id="DTV-MODULATION">
139 <title><constant>DTV_MODULATION</constant></title>
140 <para>Specifies the frontend modulation type for delivery systems that supports
141 more than one modulation type. The modulation can be one of the types
142 defined by &fe-modulation;.</para>
145 <section id="fe-modulation-t">
146 <title>Modulation property</title>
148 <para>Most of the digital TV standards currently offers more than one possible
149 modulation (sometimes called as "constellation" on some standards). This
150 enum contains the values used by the Kernel. Please notice that not all
151 modulations are supported by a given standard.</para>
153 <table pgwide="1" frame="none" id="fe-modulation">
154 <title>enum fe_modulation</title>
160 <entry>Description</entry>
166 <entry>QPSK modulation</entry>
168 <entry>QAM_16</entry>
169 <entry>16-QAM modulation</entry>
171 <entry>QAM_32</entry>
172 <entry>32-QAM modulation</entry>
174 <entry>QAM_64</entry>
175 <entry>64-QAM modulation</entry>
177 <entry>QAM_128</entry>
178 <entry>128-QAM modulation</entry>
180 <entry>QAM_256</entry>
181 <entry>256-QAM modulation</entry>
183 <entry>QAM_AUTO</entry>
184 <entry>Autodetect QAM modulation</entry>
187 <entry>8-VSB modulation</entry>
189 <entry>VSB_16</entry>
190 <entry>16-VSB modulation</entry>
193 <entry>8-PSK modulation</entry>
195 <entry>APSK_16</entry>
196 <entry>16-APSK modulation</entry>
198 <entry>APSK_32</entry>
199 <entry>32-APSK modulation</entry>
202 <entry>DQPSK modulation</entry>
204 <entry>QAM_4_NR</entry>
205 <entry>4-QAM-NR modulation</entry>
213 <section id="DTV-BANDWIDTH-HZ">
214 <title><constant>DTV_BANDWIDTH_HZ</constant></title>
216 <para>Bandwidth for the channel, in HZ.</para>
218 <para>Possible values:
219 <constant>1712000</constant>,
220 <constant>5000000</constant>,
221 <constant>6000000</constant>,
222 <constant>7000000</constant>,
223 <constant>8000000</constant>,
224 <constant>10000000</constant>.
229 <para>1) For ISDB-T it should be always 6000000Hz (6MHz)</para>
230 <para>2) For ISDB-Tsb it can vary depending on the number of connected segments</para>
231 <para>3) Bandwidth doesn't apply for DVB-C transmissions, as the bandwidth
232 for DVB-C depends on the symbol rate</para>
233 <para>4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from
234 other parameters (DTV_ISDBT_SB_SEGMENT_IDX,
235 DTV_ISDBT_SB_SEGMENT_COUNT).</para>
236 <para>5) DVB-T supports 6, 7 and 8MHz.</para>
237 <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para>
239 <section id="DTV-INVERSION">
240 <title><constant>DTV_INVERSION</constant></title>
242 <para>Specifies if the frontend should do spectral inversion or not.</para>
244 <section id="fe-spectral-inversion-t">
245 <title>enum fe_modulation: Frontend spectral inversion</title>
247 <para>This parameter indicates if spectral inversion should be presumed or not.
248 In the automatic setting (<constant>INVERSION_AUTO</constant>) the hardware
249 will try to figure out the correct setting by itself. If the hardware
250 doesn't support, the DVB core will try to lock at the carrier first with
251 inversion off. If it fails, it will try to enable inversion.
254 <table pgwide="1" frame="none" id="fe-spectral-inversion">
255 <title>enum fe_modulation</title>
261 <entry>Description</entry>
266 <entry>INVERSION_OFF</entry>
267 <entry>Don't do spectral band inversion.</entry>
269 <entry>INVERSION_ON</entry>
270 <entry>Do spectral band inversion.</entry>
272 <entry>INVERSION_AUTO</entry>
273 <entry>Autodetect spectral band inversion.</entry>
281 <section id="DTV-DISEQC-MASTER">
282 <title><constant>DTV_DISEQC_MASTER</constant></title>
283 <para>Currently not implemented.</para>
285 <section id="DTV-SYMBOL-RATE">
286 <title><constant>DTV_SYMBOL_RATE</constant></title>
287 <para>Digital TV symbol rate, in bauds (symbols/second). Used on cable standards.</para>
289 <section id="DTV-INNER-FEC">
290 <title><constant>DTV_INNER_FEC</constant></title>
291 <para>Used cable/satellite transmissions. The acceptable values are:
293 <section id="fe-code-rate-t">
294 <title>enum fe_code_rate: type of the Forward Error Correction.</title>
296 <table pgwide="1" frame="none" id="fe-code-rate">
297 <title>enum fe_code_rate</title>
303 <entry>Description</entry>
308 <entry>TRANSMISSION_MODE_AUTO</entry>
309 <entry>Autodetect transmission mode. The hardware will try to find
310 the correct FFT-size (if capable) to fill in the missing
313 <entry>FEC_NONE</entry>
314 <entry>No Forward Error Correction Code</entry>
316 <entry>FEC_AUTO</entry>
317 <entry>Autodetect Error Correction Code</entry>
319 <entry>FEC_1_2</entry>
320 <entry>Forward Error Correction Code 1/2</entry>
322 <entry>FEC_2_3</entry>
323 <entry>Forward Error Correction Code 2/3</entry>
325 <entry>FEC_3_4</entry>
326 <entry>Forward Error Correction Code 3/4</entry>
328 <entry>FEC_4_5</entry>
329 <entry>Forward Error Correction Code 4/5</entry>
331 <entry>FEC_5_6</entry>
332 <entry>Forward Error Correction Code 5/6</entry>
334 <entry>FEC_6_7</entry>
335 <entry>Forward Error Correction Code 6/7</entry>
337 <entry>FEC_7_8</entry>
338 <entry>Forward Error Correction Code 7/8</entry>
340 <entry>FEC_8_9</entry>
341 <entry>Forward Error Correction Code 8/9</entry>
343 <entry>FEC_9_10</entry>
344 <entry>Forward Error Correction Code 9/10</entry>
346 <entry>FEC_2_5</entry>
347 <entry>Forward Error Correction Code 2/5</entry>
349 <entry>FEC_3_5</entry>
350 <entry>Forward Error Correction Code 3/5</entry>
358 <section id="DTV-VOLTAGE">
359 <title><constant>DTV_VOLTAGE</constant></title>
360 <para>The voltage is usually used with non-DiSEqC capable LNBs to switch
361 the polarzation (horizontal/vertical). When using DiSEqC epuipment this
362 voltage has to be switched consistently to the DiSEqC commands as
363 described in the DiSEqC spec.</para>
365 typedef enum fe_sec_voltage {
371 <section id="DTV-TONE">
372 <title><constant>DTV_TONE</constant></title>
373 <para>Currently not used.</para>
375 <section id="DTV-PILOT">
376 <title><constant>DTV_PILOT</constant></title>
377 <para>Sets DVB-S2 pilot</para>
378 <section id="fe-pilot-t">
379 <title>fe_pilot type</title>
381 typedef enum fe_pilot {
389 <section id="DTV-ROLLOFF">
390 <title><constant>DTV_ROLLOFF</constant></title>
391 <para>Sets DVB-S2 rolloff</para>
393 <section id="fe-rolloff-t">
394 <title>fe_rolloff type</title>
396 typedef enum fe_rolloff {
397 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
405 <section id="DTV-DISEQC-SLAVE-REPLY">
406 <title><constant>DTV_DISEQC_SLAVE_REPLY</constant></title>
407 <para>Currently not implemented.</para>
409 <section id="DTV-FE-CAPABILITY-COUNT">
410 <title><constant>DTV_FE_CAPABILITY_COUNT</constant></title>
411 <para>Currently not implemented.</para>
413 <section id="DTV-FE-CAPABILITY">
414 <title><constant>DTV_FE_CAPABILITY</constant></title>
415 <para>Currently not implemented.</para>
417 <section id="DTV-DELIVERY-SYSTEM">
418 <title><constant>DTV_DELIVERY_SYSTEM</constant></title>
419 <para>Specifies the type of Delivery system</para>
420 <section id="fe-delivery-system-t">
421 <title>fe_delivery_system type</title>
422 <para>Possible values: </para>
425 typedef enum fe_delivery_system {
445 } fe_delivery_system_t;
449 <section id="DTV-ISDBT-PARTIAL-RECEPTION">
450 <title><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></title>
452 <para>If <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '0' this bit-field represents whether
453 the channel is in partial reception mode or not.</para>
455 <para>If '1' <constant>DTV_ISDBT_LAYERA_*</constant> values are assigned to the center segment and
456 <constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant> has to be '1'.</para>
458 <para>If in addition <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'
459 <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> represents whether this ISDB-Tsb channel
460 is consisting of one segment and layer or three segments and two layers.</para>
462 <para>Possible values: 0, 1, -1 (AUTO)</para>
464 <section id="DTV-ISDBT-SOUND-BROADCASTING">
465 <title><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></title>
467 <para>This field represents whether the other DTV_ISDBT_*-parameters are
468 referring to an ISDB-T and an ISDB-Tsb channel. (See also
469 <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>).</para>
471 <para>Possible values: 0, 1, -1 (AUTO)</para>
473 <section id="DTV-ISDBT-SB-SUBCHANNEL-ID">
474 <title><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></title>
476 <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
478 <para>(Note of the author: This might not be the correct description of the
479 <constant>SUBCHANNEL-ID</constant> in all details, but it is my understanding of the technical
480 background needed to program a device)</para>
482 <para>An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a
483 set of connected ISDB-Tsb channels. In this set of channels every
484 channel can be received independently. The number of connected
485 ISDB-Tsb segment can vary, e.g. depending on the frequency spectrum
486 bandwidth available.</para>
488 <para>Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The
489 broadcaster has several possibilities to put those channels in the
490 air: Assuming a normal 13-segment ISDB-T spectrum he can align the 8
491 segments from position 1-8 to 5-13 or anything in between.</para>
493 <para>The underlying layer of segments are subchannels: each segment is
494 consisting of several subchannels with a predefined IDs. A sub-channel
495 is used to help the demodulator to synchronize on the channel.</para>
497 <para>An ISDB-T channel is always centered over all sub-channels. As for
498 the example above, in ISDB-Tsb it is no longer as simple as that.</para>
500 <para><constant>The DTV_ISDBT_SB_SUBCHANNEL_ID</constant> parameter is used to give the
501 sub-channel ID of the segment to be demodulated.</para>
503 <para>Possible values: 0 .. 41, -1 (AUTO)</para>
505 <section id="DTV-ISDBT-SB-SEGMENT-IDX">
506 <title><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></title>
507 <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
508 <para><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant> gives the index of the segment to be
509 demodulated for an ISDB-Tsb channel where several of them are
510 transmitted in the connected manner.</para>
511 <para>Possible values: 0 .. <constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> - 1</para>
512 <para>Note: This value cannot be determined by an automatic channel search.</para>
514 <section id="DTV-ISDBT-SB-SEGMENT-COUNT">
515 <title><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></title>
516 <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
517 <para><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> gives the total count of connected ISDB-Tsb
519 <para>Possible values: 1 .. 13</para>
520 <para>Note: This value cannot be determined by an automatic channel search.</para>
522 <section id="isdb-hierq-layers">
523 <title><constant>DTV-ISDBT-LAYER*</constant> parameters</title>
524 <para>ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
525 ISDB-T hierarchical layers can be decoded simultaneously. For that
526 reason a ISDB-T demodulator has 3 Viterbi and 3 Reed-Solomon decoders.</para>
527 <para>ISDB-T has 3 hierarchical layers which each can use a part of the
528 available segments. The total number of segments over all layers has
529 to 13 in ISDB-T.</para>
530 <para>There are 3 parameter sets, for Layers A, B and C.</para>
531 <section id="DTV-ISDBT-LAYER-ENABLED">
532 <title><constant>DTV_ISDBT_LAYER_ENABLED</constant></title>
533 <para>Hierarchical reception in ISDB-T is achieved by enabling or disabling
534 layers in the decoding process. Setting all bits of
535 <constant>DTV_ISDBT_LAYER_ENABLED</constant> to '1' forces all layers (if applicable) to be
536 demodulated. This is the default.</para>
537 <para>If the channel is in the partial reception mode
538 (<constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> = 1) the central segment can be decoded
539 independently of the other 12 segments. In that mode layer A has to
540 have a <constant>SEGMENT_COUNT</constant> of 1.</para>
541 <para>In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb
542 according to <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>. <constant>SEGMENT_COUNT</constant> must be filled
544 <para>Possible values: 0x1, 0x2, 0x4 (|-able)</para>
545 <para><constant>DTV_ISDBT_LAYER_ENABLED[0:0]</constant> - layer A</para>
546 <para><constant>DTV_ISDBT_LAYER_ENABLED[1:1]</constant> - layer B</para>
547 <para><constant>DTV_ISDBT_LAYER_ENABLED[2:2]</constant> - layer C</para>
548 <para><constant>DTV_ISDBT_LAYER_ENABLED[31:3]</constant> unused</para>
550 <section id="DTV-ISDBT-LAYER-FEC">
551 <title><constant>DTV_ISDBT_LAYER*_FEC</constant></title>
552 <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>
554 <section id="DTV-ISDBT-LAYER-MODULATION">
555 <title><constant>DTV_ISDBT_LAYER*_MODULATION</constant></title>
556 <para>Possible values: <constant>QAM_AUTO</constant>, QP<constant>SK, QAM_16</constant>, <constant>QAM_64</constant>, <constant>DQPSK</constant></para>
557 <para>Note: If layer C is <constant>DQPSK</constant> layer B has to be <constant>DQPSK</constant>. If layer B is <constant>DQPSK</constant>
558 and <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>=0 layer has to be <constant>DQPSK</constant>.</para>
560 <section id="DTV-ISDBT-LAYER-SEGMENT-COUNT">
561 <title><constant>DTV_ISDBT_LAYER*_SEGMENT_COUNT</constant></title>
562 <para>Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)</para>
563 <para>Note: Truth table for <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> and
564 <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> and <constant>LAYER</constant>*_SEGMENT_COUNT</para>
565 <informaltable id="isdbt-layer_seg-cnt-table">
571 <entry>Layer A width</entry>
572 <entry>Layer B width</entry>
573 <entry>Layer C width</entry>
574 <entry>total width</entry>
579 <entry>1 .. 13</entry>
580 <entry>1 .. 13</entry>
581 <entry>1 .. 13</entry>
588 <entry>1 .. 13</entry>
589 <entry>1 .. 13</entry>
612 <section id="DTV-ISDBT-LAYER-TIME-INTERLEAVING">
613 <title><constant>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</constant></title>
614 <para>Valid values: 0, 1, 2, 4, -1 (AUTO)</para>
615 <para>when DTV_ISDBT_SOUND_BROADCASTING is active, value 8 is also valid.</para>
616 <para>Note: The real time interleaving length depends on the mode (fft-size). The values
617 here are referring to what can be found in the TMCC-structure, as shown in the table below.</para>
618 <informaltable id="isdbt-layer-interleaving-table">
619 <tgroup cols="4" align="center">
622 <entry>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</entry>
623 <entry>Mode 1 (2K FFT)</entry>
624 <entry>Mode 2 (4K FFT)</entry>
625 <entry>Mode 3 (8K FFT)</entry>
655 <section id="DTV-ATSCMH-FIC-VER">
656 <title><constant>DTV_ATSCMH_FIC_VER</constant></title>
657 <para>Version number of the FIC (Fast Information Channel) signaling data.</para>
658 <para>FIC is used for relaying information to allow rapid service acquisition by the receiver.</para>
659 <para>Possible values: 0, 1, 2, 3, ..., 30, 31</para>
661 <section id="DTV-ATSCMH-PARADE-ID">
662 <title><constant>DTV_ATSCMH_PARADE_ID</constant></title>
663 <para>Parade identification number</para>
664 <para>A parade is a collection of up to eight MH groups, conveying one or two ensembles.</para>
665 <para>Possible values: 0, 1, 2, 3, ..., 126, 127</para>
667 <section id="DTV-ATSCMH-NOG">
668 <title><constant>DTV_ATSCMH_NOG</constant></title>
669 <para>Number of MH groups per MH subframe for a designated parade.</para>
670 <para>Possible values: 1, 2, 3, 4, 5, 6, 7, 8</para>
672 <section id="DTV-ATSCMH-TNOG">
673 <title><constant>DTV_ATSCMH_TNOG</constant></title>
674 <para>Total number of MH groups including all MH groups belonging to all MH parades in one MH subframe.</para>
675 <para>Possible values: 0, 1, 2, 3, ..., 30, 31</para>
677 <section id="DTV-ATSCMH-SGN">
678 <title><constant>DTV_ATSCMH_SGN</constant></title>
679 <para>Start group number.</para>
680 <para>Possible values: 0, 1, 2, 3, ..., 14, 15</para>
682 <section id="DTV-ATSCMH-PRC">
683 <title><constant>DTV_ATSCMH_PRC</constant></title>
684 <para>Parade repetition cycle.</para>
685 <para>Possible values: 1, 2, 3, 4, 5, 6, 7, 8</para>
687 <section id="DTV-ATSCMH-RS-FRAME-MODE">
688 <title><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></title>
689 <para>RS frame mode.</para>
690 <para>Possible values are:</para>
691 <para id="atscmh-rs-frame-mode">
693 typedef enum atscmh_rs_frame_mode {
694 ATSCMH_RSFRAME_PRI_ONLY = 0,
695 ATSCMH_RSFRAME_PRI_SEC = 1,
696 } atscmh_rs_frame_mode_t;
700 <section id="DTV-ATSCMH-RS-FRAME-ENSEMBLE">
701 <title><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></title>
702 <para>RS frame ensemble.</para>
703 <para>Possible values are:</para>
704 <para id="atscmh-rs-frame-ensemble">
706 typedef enum atscmh_rs_frame_ensemble {
707 ATSCMH_RSFRAME_ENS_PRI = 0,
708 ATSCMH_RSFRAME_ENS_SEC = 1,
709 } atscmh_rs_frame_ensemble_t;
713 <section id="DTV-ATSCMH-RS-CODE-MODE-PRI">
714 <title><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></title>
715 <para>RS code mode (primary).</para>
716 <para>Possible values are:</para>
717 <para id="atscmh-rs-code-mode">
719 typedef enum atscmh_rs_code_mode {
720 ATSCMH_RSCODE_211_187 = 0,
721 ATSCMH_RSCODE_223_187 = 1,
722 ATSCMH_RSCODE_235_187 = 2,
723 } atscmh_rs_code_mode_t;
727 <section id="DTV-ATSCMH-RS-CODE-MODE-SEC">
728 <title><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></title>
729 <para>RS code mode (secondary).</para>
730 <para>Possible values are:</para>
732 typedef enum atscmh_rs_code_mode {
733 ATSCMH_RSCODE_211_187 = 0,
734 ATSCMH_RSCODE_223_187 = 1,
735 ATSCMH_RSCODE_235_187 = 2,
736 } atscmh_rs_code_mode_t;
739 <section id="DTV-ATSCMH-SCCC-BLOCK-MODE">
740 <title><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></title>
741 <para>Series Concatenated Convolutional Code Block Mode.</para>
742 <para>Possible values are:</para>
743 <para id="atscmh-sccc-block-mode">
745 typedef enum atscmh_sccc_block_mode {
746 ATSCMH_SCCC_BLK_SEP = 0,
747 ATSCMH_SCCC_BLK_COMB = 1,
748 } atscmh_sccc_block_mode_t;
752 <section id="DTV-ATSCMH-SCCC-CODE-MODE-A">
753 <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></title>
754 <para>Series Concatenated Convolutional Code Rate.</para>
755 <para>Possible values are:</para>
756 <para id="atscmh-sccc-code-mode">
758 typedef enum atscmh_sccc_code_mode {
759 ATSCMH_SCCC_CODE_HLF = 0,
760 ATSCMH_SCCC_CODE_QTR = 1,
761 } atscmh_sccc_code_mode_t;
765 <section id="DTV-ATSCMH-SCCC-CODE-MODE-B">
766 <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></title>
767 <para>Series Concatenated Convolutional Code Rate.</para>
768 <para>Possible values are:</para>
770 typedef enum atscmh_sccc_code_mode {
771 ATSCMH_SCCC_CODE_HLF = 0,
772 ATSCMH_SCCC_CODE_QTR = 1,
773 } atscmh_sccc_code_mode_t;
776 <section id="DTV-ATSCMH-SCCC-CODE-MODE-C">
777 <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></title>
778 <para>Series Concatenated Convolutional Code Rate.</para>
779 <para>Possible values are:</para>
781 typedef enum atscmh_sccc_code_mode {
782 ATSCMH_SCCC_CODE_HLF = 0,
783 ATSCMH_SCCC_CODE_QTR = 1,
784 } atscmh_sccc_code_mode_t;
787 <section id="DTV-ATSCMH-SCCC-CODE-MODE-D">
788 <title><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></title>
789 <para>Series Concatenated Convolutional Code Rate.</para>
790 <para>Possible values are:</para>
792 typedef enum atscmh_sccc_code_mode {
793 ATSCMH_SCCC_CODE_HLF = 0,
794 ATSCMH_SCCC_CODE_QTR = 1,
795 } atscmh_sccc_code_mode_t;
799 <section id="DTV-API-VERSION">
800 <title><constant>DTV_API_VERSION</constant></title>
801 <para>Returns the major/minor version of the DVB API</para>
803 <section id="DTV-CODE-RATE-HP">
804 <title><constant>DTV_CODE_RATE_HP</constant></title>
805 <para>Used on terrestrial transmissions. The acceptable values are
806 the ones described at &fe-transmit-mode-t;.
809 <section id="DTV-CODE-RATE-LP">
810 <title><constant>DTV_CODE_RATE_LP</constant></title>
811 <para>Used on terrestrial transmissions. The acceptable values are
812 the ones described at &fe-transmit-mode-t;.
817 <section id="DTV-GUARD-INTERVAL">
818 <title><constant>DTV_GUARD_INTERVAL</constant></title>
820 <para>Possible values are:</para>
822 typedef enum fe_guard_interval {
828 GUARD_INTERVAL_1_128,
829 GUARD_INTERVAL_19_128,
830 GUARD_INTERVAL_19_256,
831 GUARD_INTERVAL_PN420,
832 GUARD_INTERVAL_PN595,
833 GUARD_INTERVAL_PN945,
834 } fe_guard_interval_t;
838 <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will
839 try to find the correct guard interval (if capable) and will use TMCC to fill
840 in the missing parameters.</para>
841 <para>2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at present</para>
842 <para>3) DTMB specifies PN420, PN595 and PN945.</para>
844 <section id="DTV-TRANSMISSION-MODE">
845 <title><constant>DTV_TRANSMISSION_MODE</constant></title>
847 <para>Specifies the number of carriers used by the standard.
848 This is used only on OFTM-based standards, e. g.
849 DVB-T/T2, ISDB-T, DTMB</para>
851 <section id="fe-transmit-mode-t">
852 <title>enum fe_transmit_mode: Number of carriers per channel</title>
854 <table pgwide="1" frame="none" id="fe-transmit-mode">
855 <title>enum fe_transmit_mode</title>
861 <entry>Description</entry>
866 <entry>TRANSMISSION_MODE_AUTO</entry>
867 <entry>Autodetect transmission mode. The hardware will try to find
868 the correct FFT-size (if capable) to fill in the missing
871 <entry>TRANSMISSION_MODE_1K</entry>
872 <entry>Transmission mode 1K</entry>
874 <entry>TRANSMISSION_MODE_2K</entry>
875 <entry>Transmission mode 2K</entry>
877 <entry>TRANSMISSION_MODE_8K</entry>
878 <entry>Transmission mode 8K</entry>
880 <entry>TRANSMISSION_MODE_4K</entry>
881 <entry>Transmission mode 4K</entry>
883 <entry>TRANSMISSION_MODE_16K</entry>
884 <entry>Transmission mode 16K</entry>
886 <entry>TRANSMISSION_MODE_32K</entry>
887 <entry>Transmission mode 32K</entry>
889 <entry>TRANSMISSION_MODE_C1</entry>
890 <entry>Single Carrier (C=1) transmission mode (DTMB)</entry>
892 <entry>TRANSMISSION_MODE_C3780</entry>
893 <entry>Multi Carrier (C=3780) transmission mode (DTMB)</entry>
903 <para>1) ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called
904 'mode' in the standard: Mode 1 is 2K, mode 2 is 4K, mode 3 is 8K</para>
906 <para>2) If <constant>DTV_TRANSMISSION_MODE</constant> is set the <constant>TRANSMISSION_MODE_AUTO</constant> the
907 hardware will try to find the correct FFT-size (if capable) and will
908 use TMCC to fill in the missing parameters.</para>
909 <para>3) DVB-T specifies 2K and 8K as valid sizes.</para>
910 <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para>
911 <para>5) DTMB specifies C1 and C3780.</para>
913 <section id="DTV-HIERARCHY">
914 <title><constant>DTV_HIERARCHY</constant></title>
915 <para>Frontend hierarchy</para>
917 typedef enum fe_hierarchy {
926 <section id="DTV-STREAM-ID">
927 <title><constant>DTV_STREAM_ID</constant></title>
928 <para>DVB-S2, DVB-T2 and ISDB-S support the transmission of several
929 streams on a single transport stream.
930 This property enables the DVB driver to handle substream filtering,
931 when supported by the hardware.
932 By default, substream filtering is disabled.
934 For DVB-S2 and DVB-T2, the valid substream id range is from 0 to 255.
936 For ISDB, the valid substream id range is from 1 to 65535.
938 To disable it, you should use the special macro NO_STREAM_ID_FILTER.
940 Note: any value outside the id range also disables filtering.
943 <section id="DTV-DVBT2-PLP-ID-LEGACY">
944 <title><constant>DTV_DVBT2_PLP_ID_LEGACY</constant></title>
945 <para>Obsolete, replaced with DTV_STREAM_ID.</para>
947 <section id="DTV-ENUM-DELSYS">
948 <title><constant>DTV_ENUM_DELSYS</constant></title>
949 <para>A Multi standard frontend needs to advertise the delivery systems provided.
950 Applications need to enumerate the provided delivery systems, before using
951 any other operation with the frontend. Prior to it's introduction,
952 FE_GET_INFO was used to determine a frontend type. A frontend which
953 provides more than a single delivery system, FE_GET_INFO doesn't help much.
954 Applications which intends to use a multistandard frontend must enumerate
955 the delivery systems associated with it, rather than trying to use
956 FE_GET_INFO. In the case of a legacy frontend, the result is just the same
957 as with FE_GET_INFO, but in a more structured format </para>
959 <section id="DTV-INTERLEAVING">
960 <title><constant>DTV_INTERLEAVING</constant></title>
961 <para id="fe-interleaving">Interleaving mode</para>
963 enum fe_interleaving {
971 <section id="DTV-LNA">
972 <title><constant>DTV_LNA</constant></title>
973 <para>Low-noise amplifier.</para>
974 <para>Hardware might offer controllable LNA which can be set manually
975 using that parameter. Usually LNA could be found only from
976 terrestrial devices if at all.</para>
977 <para>Possible values: 0, 1, LNA_AUTO</para>
978 <para>0, LNA off</para>
979 <para>1, LNA on</para>
980 <para>use the special macro LNA_AUTO to set LNA auto</para>
984 <section id="frontend-stat-properties">
985 <title>Frontend statistics indicators</title>
986 <para>The values are returned via <constant>dtv_property.stat</constant>.
987 If the property is supported, <constant>dtv_property.stat.len</constant> is bigger than zero.</para>
988 <para>For most delivery systems, <constant>dtv_property.stat.len</constant>
989 will be 1 if the stats is supported, and the properties will
990 return a single value for each parameter.</para>
991 <para>It should be noticed, however, that new OFDM delivery systems
992 like ISDB can use different modulation types for each group of
993 carriers. On such standards, up to 3 groups of statistics can be
994 provided, and <constant>dtv_property.stat.len</constant> is updated
995 to reflect the "global" metrics, plus one metric per each carrier
996 group (called "layer" on ISDB).</para>
997 <para>So, in order to be consistent with other delivery systems, the first
998 value at <link linkend="dtv-stats"><constant>dtv_property.stat.dtv_stats</constant></link>
999 array refers to the global metric. The other elements of the array
1000 represent each layer, starting from layer A(index 1),
1001 layer B (index 2) and so on.</para>
1002 <para>The number of filled elements are stored at <constant>dtv_property.stat.len</constant>.</para>
1003 <para>Each element of the <constant>dtv_property.stat.dtv_stats</constant> array consists on two elements:</para>
1004 <itemizedlist mark='opencircle'>
1005 <listitem><para><constant>svalue</constant> or <constant>uvalue</constant>, where
1006 <constant>svalue</constant> is for signed values of the measure (dB measures)
1007 and <constant>uvalue</constant> is for unsigned values (counters, relative scale)</para></listitem>
1008 <listitem><para><constant>scale</constant> - Scale for the value. It can be:</para>
1009 <itemizedlist mark='bullet' id="fecap-scale-params">
1010 <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>
1011 <listitem><para><constant>FE_SCALE_DECIBEL</constant> - parameter is a signed value, measured in 1/1000 dB</para></listitem>
1012 <listitem><para><constant>FE_SCALE_RELATIVE</constant> - parameter is a unsigned value, where 0 means 0% and 65535 means 100%.</para></listitem>
1013 <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>
1017 <section id="DTV-STAT-SIGNAL-STRENGTH">
1018 <title><constant>DTV_STAT_SIGNAL_STRENGTH</constant></title>
1019 <para>Indicates the signal strength level at the analog part of the tuner or of the demod.</para>
1020 <para>Possible scales for this metric are:</para>
1021 <itemizedlist mark='bullet'>
1022 <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem>
1023 <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>
1024 <listitem><para><constant>FE_SCALE_RELATIVE</constant> - The frontend provides a 0% to 100% measurement for power (actually, 0 to 65535).</para></listitem>
1027 <section id="DTV-STAT-CNR">
1028 <title><constant>DTV_STAT_CNR</constant></title>
1029 <para>Indicates the Signal to Noise ratio for the main carrier.</para>
1030 <para>Possible scales for this metric are:</para>
1031 <itemizedlist mark='bullet'>
1032 <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem>
1033 <listitem><para><constant>FE_SCALE_DECIBEL</constant> - Signal/Noise ratio is in 0.001 dB units.</para></listitem>
1034 <listitem><para><constant>FE_SCALE_RELATIVE</constant> - The frontend provides a 0% to 100% measurement for Signal/Noise (actually, 0 to 65535).</para></listitem>
1037 <section id="DTV-STAT-PRE-ERROR-BIT-COUNT">
1038 <title><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></title>
1039 <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>
1040 <para>This measure is taken during the same interval as <constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant>.</para>
1041 <para>In order to get the BER (Bit Error Rate) measurement, it should be divided by
1042 <link linkend="DTV-STAT-PRE-TOTAL-BIT-COUNT"><constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant></link>.</para>
1043 <para>This measurement is monotonically increased, as the frontend gets more bit count measurements.
1044 The frontend may reset it when a channel/transponder is tuned.</para>
1045 <para>Possible scales for this metric are:</para>
1046 <itemizedlist mark='bullet'>
1047 <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem>
1048 <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error bits counted before the inner coding.</para></listitem>
1051 <section id="DTV-STAT-PRE-TOTAL-BIT-COUNT">
1052 <title><constant>DTV_STAT_PRE_TOTAL_BIT_COUNT</constant></title>
1053 <para>Measures the amount of bits received before the inner code block, during the same period as
1054 <link linkend="DTV-STAT-PRE-ERROR-BIT-COUNT"><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></link> measurement was taken.</para>
1055 <para>It should be noticed that this measurement can be smaller than the total amount of bits on the transport stream,
1056 as the frontend may need to manually restart the measurement, losing some data between each measurement interval.</para>
1057 <para>This measurement is monotonically increased, as the frontend gets more bit count measurements.
1058 The frontend may reset it when a channel/transponder is tuned.</para>
1059 <para>Possible scales for this metric are:</para>
1060 <itemizedlist mark='bullet'>
1061 <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem>
1062 <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of bits counted while measuring
1063 <link linkend="DTV-STAT-PRE-ERROR-BIT-COUNT"><constant>DTV_STAT_PRE_ERROR_BIT_COUNT</constant></link>.</para></listitem>
1066 <section id="DTV-STAT-POST-ERROR-BIT-COUNT">
1067 <title><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></title>
1068 <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>
1069 <para>This measure is taken during the same interval as <constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant>.</para>
1070 <para>In order to get the BER (Bit Error Rate) measurement, it should be divided by
1071 <link linkend="DTV-STAT-POST-TOTAL-BIT-COUNT"><constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant></link>.</para>
1072 <para>This measurement is monotonically increased, as the frontend gets more bit count measurements.
1073 The frontend may reset it when a channel/transponder is tuned.</para>
1074 <para>Possible scales for this metric are:</para>
1075 <itemizedlist mark='bullet'>
1076 <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem>
1077 <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error bits counted after the inner coding.</para></listitem>
1080 <section id="DTV-STAT-POST-TOTAL-BIT-COUNT">
1081 <title><constant>DTV_STAT_POST_TOTAL_BIT_COUNT</constant></title>
1082 <para>Measures the amount of bits received after the inner coding, during the same period as
1083 <link linkend="DTV-STAT-POST-ERROR-BIT-COUNT"><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></link> measurement was taken.</para>
1084 <para>It should be noticed that this measurement can be smaller than the total amount of bits on the transport stream,
1085 as the frontend may need to manually restart the measurement, losing some data between each measurement interval.</para>
1086 <para>This measurement is monotonically increased, as the frontend gets more bit count measurements.
1087 The frontend may reset it when a channel/transponder is tuned.</para>
1088 <para>Possible scales for this metric are:</para>
1089 <itemizedlist mark='bullet'>
1090 <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem>
1091 <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of bits counted while measuring
1092 <link linkend="DTV-STAT-POST-ERROR-BIT-COUNT"><constant>DTV_STAT_POST_ERROR_BIT_COUNT</constant></link>.</para></listitem>
1095 <section id="DTV-STAT-ERROR-BLOCK-COUNT">
1096 <title><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></title>
1097 <para>Measures the number of block errors after the outer forward error correction coding (after Reed-Solomon or other outer code).</para>
1098 <para>This measurement is monotonically increased, as the frontend gets more bit count measurements.
1099 The frontend may reset it when a channel/transponder is tuned.</para>
1100 <para>Possible scales for this metric are:</para>
1101 <itemizedlist mark='bullet'>
1102 <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem>
1103 <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of error blocks counted after the outer coding.</para></listitem>
1106 <section id="DTV-STAT-TOTAL-BLOCK-COUNT">
1107 <title><constant>DTV-STAT_TOTAL_BLOCK_COUNT</constant></title>
1108 <para>Measures the total number of blocks received during the same period as
1109 <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link> measurement was taken.</para>
1110 <para>It can be used to calculate the PER indicator, by dividing
1111 <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link>
1112 by <link linkend="DTV-STAT-TOTAL-BLOCK-COUNT"><constant>DTV-STAT-TOTAL-BLOCK-COUNT</constant></link>.</para>
1113 <para>Possible scales for this metric are:</para>
1114 <itemizedlist mark='bullet'>
1115 <listitem><para><constant>FE_SCALE_NOT_AVAILABLE</constant> - it failed to measure it, or the measurement was not complete yet.</para></listitem>
1116 <listitem><para><constant>FE_SCALE_COUNTER</constant> - Number of blocks counted while measuring
1117 <link linkend="DTV-STAT-ERROR-BLOCK-COUNT"><constant>DTV_STAT_ERROR_BLOCK_COUNT</constant></link>.</para></listitem>
1122 <section id="frontend-property-terrestrial-systems">
1123 <title>Properties used on terrestrial delivery systems</title>
1124 <section id="dvbt-params">
1125 <title>DVB-T delivery system</title>
1126 <para>The following parameters are valid for DVB-T:</para>
1127 <itemizedlist mark='opencircle'>
1128 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1129 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1130 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1131 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1132 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1133 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
1134 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
1135 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
1136 <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem>
1137 <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem>
1138 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
1139 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
1140 <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem>
1141 <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem>
1143 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1145 <section id="dvbt2-params">
1146 <title>DVB-T2 delivery system</title>
1147 <para>DVB-T2 support is currently in the early stages
1148 of development, so expect that this section maygrow and become
1149 more detailed with time.</para>
1150 <para>The following parameters are valid for DVB-T2:</para>
1151 <itemizedlist mark='opencircle'>
1152 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1153 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1154 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1155 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1156 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1157 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
1158 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
1159 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
1160 <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem>
1161 <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem>
1162 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
1163 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
1164 <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem>
1165 <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem>
1166 <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem>
1168 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1170 <section id="isdbt">
1171 <title>ISDB-T delivery system</title>
1172 <para>This ISDB-T/ISDB-Tsb API extension should reflect all information
1173 needed to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible
1174 that some very sophisticated devices won't need certain parameters to
1176 <para>The information given here should help application writers to know how
1177 to handle ISDB-T and ISDB-Tsb hardware using the Linux DVB-API.</para>
1178 <para>The details given here about ISDB-T and ISDB-Tsb are just enough to
1179 basically show the dependencies between the needed parameter values,
1180 but surely some information is left out. For more detailed information
1181 see the following documents:</para>
1182 <para>ARIB STD-B31 - "Transmission System for Digital Terrestrial
1183 Television Broadcasting" and</para>
1184 <para>ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial
1185 Television Broadcasting".</para>
1186 <para>In order to understand the ISDB specific parameters,
1187 one has to have some knowledge the channel structure in
1188 ISDB-T and ISDB-Tsb. I.e. it has to be known to
1189 the reader that an ISDB-T channel consists of 13 segments,
1190 that it can have up to 3 layer sharing those segments,
1191 and things like that.</para>
1192 <para>The following parameters are valid for ISDB-T:</para>
1193 <itemizedlist mark='opencircle'>
1194 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1195 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1196 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1197 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1198 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1199 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
1200 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
1201 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
1202 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
1203 <listitem><para><link linkend="DTV-ISDBT-LAYER-ENABLED"><constant>DTV_ISDBT_LAYER_ENABLED</constant></link></para></listitem>
1204 <listitem><para><link linkend="DTV-ISDBT-PARTIAL-RECEPTION"><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></link></para></listitem>
1205 <listitem><para><link linkend="DTV-ISDBT-SOUND-BROADCASTING"><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></link></para></listitem>
1206 <listitem><para><link linkend="DTV-ISDBT-SB-SUBCHANNEL-ID"><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></link></para></listitem>
1207 <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-IDX"><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></link></para></listitem>
1208 <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-COUNT"><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></link></para></listitem>
1209 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERA_FEC</constant></link></para></listitem>
1210 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERA_MODULATION</constant></link></para></listitem>
1211 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant></link></para></listitem>
1212 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERA_TIME_INTERLEAVING</constant></link></para></listitem>
1213 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERB_FEC</constant></link></para></listitem>
1214 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERB_MODULATION</constant></link></para></listitem>
1215 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERB_SEGMENT_COUNT</constant></link></para></listitem>
1216 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERB_TIME_INTERLEAVING</constant></link></para></listitem>
1217 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERC_FEC</constant></link></para></listitem>
1218 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERC_MODULATION</constant></link></para></listitem>
1219 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERC_SEGMENT_COUNT</constant></link></para></listitem>
1220 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERC_TIME_INTERLEAVING</constant></link></para></listitem>
1222 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1224 <section id="atsc-params">
1225 <title>ATSC delivery system</title>
1226 <para>The following parameters are valid for ATSC:</para>
1227 <itemizedlist mark='opencircle'>
1228 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1229 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1230 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1231 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1232 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1233 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
1234 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
1236 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1238 <section id="atscmh-params">
1239 <title>ATSC-MH delivery system</title>
1240 <para>The following parameters are valid for ATSC-MH:</para>
1241 <itemizedlist mark='opencircle'>
1242 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1243 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1244 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1245 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1246 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1247 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
1248 <listitem><para><link linkend="DTV-ATSCMH-FIC-VER"><constant>DTV_ATSCMH_FIC_VER</constant></link></para></listitem>
1249 <listitem><para><link linkend="DTV-ATSCMH-PARADE-ID"><constant>DTV_ATSCMH_PARADE_ID</constant></link></para></listitem>
1250 <listitem><para><link linkend="DTV-ATSCMH-NOG"><constant>DTV_ATSCMH_NOG</constant></link></para></listitem>
1251 <listitem><para><link linkend="DTV-ATSCMH-TNOG"><constant>DTV_ATSCMH_TNOG</constant></link></para></listitem>
1252 <listitem><para><link linkend="DTV-ATSCMH-SGN"><constant>DTV_ATSCMH_SGN</constant></link></para></listitem>
1253 <listitem><para><link linkend="DTV-ATSCMH-PRC"><constant>DTV_ATSCMH_PRC</constant></link></para></listitem>
1254 <listitem><para><link linkend="DTV-ATSCMH-RS-FRAME-MODE"><constant>DTV_ATSCMH_RS_FRAME_MODE</constant></link></para></listitem>
1255 <listitem><para><link linkend="DTV-ATSCMH-RS-FRAME-ENSEMBLE"><constant>DTV_ATSCMH_RS_FRAME_ENSEMBLE</constant></link></para></listitem>
1256 <listitem><para><link linkend="DTV-ATSCMH-RS-CODE-MODE-PRI"><constant>DTV_ATSCMH_RS_CODE_MODE_PRI</constant></link></para></listitem>
1257 <listitem><para><link linkend="DTV-ATSCMH-RS-CODE-MODE-SEC"><constant>DTV_ATSCMH_RS_CODE_MODE_SEC</constant></link></para></listitem>
1258 <listitem><para><link linkend="DTV-ATSCMH-SCCC-BLOCK-MODE"><constant>DTV_ATSCMH_SCCC_BLOCK_MODE</constant></link></para></listitem>
1259 <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-A"><constant>DTV_ATSCMH_SCCC_CODE_MODE_A</constant></link></para></listitem>
1260 <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-B"><constant>DTV_ATSCMH_SCCC_CODE_MODE_B</constant></link></para></listitem>
1261 <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-C"><constant>DTV_ATSCMH_SCCC_CODE_MODE_C</constant></link></para></listitem>
1262 <listitem><para><link linkend="DTV-ATSCMH-SCCC-CODE-MODE-D"><constant>DTV_ATSCMH_SCCC_CODE_MODE_D</constant></link></para></listitem>
1264 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1266 <section id="dtmb-params">
1267 <title>DTMB delivery system</title>
1268 <para>The following parameters are valid for DTMB:</para>
1269 <itemizedlist mark='opencircle'>
1270 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1271 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1272 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1273 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1274 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1275 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
1276 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
1277 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
1278 <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem>
1279 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
1280 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
1281 <listitem><para><link linkend="DTV-INTERLEAVING"><constant>DTV_INTERLEAVING</constant></link></para></listitem>
1282 <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem>
1284 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1287 <section id="frontend-property-cable-systems">
1288 <title>Properties used on cable delivery systems</title>
1289 <section id="dvbc-params">
1290 <title>DVB-C delivery system</title>
1291 <para>The DVB-C Annex-A is the widely used cable standard. Transmission uses QAM modulation.</para>
1292 <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>
1293 <para>The following parameters are valid for DVB-C Annex A/C:</para>
1294 <itemizedlist mark='opencircle'>
1295 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1296 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1297 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1298 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1299 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1300 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
1301 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
1302 <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem>
1303 <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem>
1304 <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem>
1306 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1308 <section id="dvbc-annex-b-params">
1309 <title>DVB-C Annex B delivery system</title>
1310 <para>The DVB-C Annex-B is only used on a few Countries like the United States.</para>
1311 <para>The following parameters are valid for DVB-C Annex B:</para>
1312 <itemizedlist mark='opencircle'>
1313 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1314 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1315 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1316 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1317 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1318 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
1319 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
1320 <listitem><para><link linkend="DTV-LNA"><constant>DTV_LNA</constant></link></para></listitem>
1322 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1325 <section id="frontend-property-satellital-systems">
1326 <title>Properties used on satellital delivery systems</title>
1327 <section id="dvbs-params">
1328 <title>DVB-S delivery system</title>
1329 <para>The following parameters are valid for DVB-S:</para>
1330 <itemizedlist mark='opencircle'>
1331 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1332 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1333 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1334 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1335 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1336 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
1337 <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem>
1338 <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem>
1339 <listitem><para><link linkend="DTV-VOLTAGE"><constant>DTV_VOLTAGE</constant></link></para></listitem>
1340 <listitem><para><link linkend="DTV-TONE"><constant>DTV_TONE</constant></link></para></listitem>
1342 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1343 <para>Future implementations might add those two missing parameters:</para>
1344 <itemizedlist mark='opencircle'>
1345 <listitem><para><link linkend="DTV-DISEQC-MASTER"><constant>DTV_DISEQC_MASTER</constant></link></para></listitem>
1346 <listitem><para><link linkend="DTV-DISEQC-SLAVE-REPLY"><constant>DTV_DISEQC_SLAVE_REPLY</constant></link></para></listitem>
1349 <section id="dvbs2-params">
1350 <title>DVB-S2 delivery system</title>
1351 <para>In addition to all parameters valid for DVB-S, DVB-S2 supports the following parameters:</para>
1352 <itemizedlist mark='opencircle'>
1353 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
1354 <listitem><para><link linkend="DTV-PILOT"><constant>DTV_PILOT</constant></link></para></listitem>
1355 <listitem><para><link linkend="DTV-ROLLOFF"><constant>DTV_ROLLOFF</constant></link></para></listitem>
1356 <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem>
1358 <para>In addition, the <link linkend="frontend-stat-properties">DTV QoS statistics</link> are also valid.</para>
1360 <section id="turbo-params">
1361 <title>Turbo code delivery system</title>
1362 <para>In addition to all parameters valid for DVB-S, turbo code supports the following parameters:</para>
1363 <itemizedlist mark='opencircle'>
1364 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
1367 <section id="isdbs-params">
1368 <title>ISDB-S delivery system</title>
1369 <para>The following parameters are valid for ISDB-S:</para>
1370 <itemizedlist mark='opencircle'>
1371 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
1372 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
1373 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
1374 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
1375 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
1376 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
1377 <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem>
1378 <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem>
1379 <listitem><para><link linkend="DTV-VOLTAGE"><constant>DTV_VOLTAGE</constant></link></para></listitem>
1380 <listitem><para><link linkend="DTV-STREAM-ID"><constant>DTV_STREAM_ID</constant></link></para></listitem>