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