| blob | c7a4ca51785980264b37b19b3b63987a3871fe33 |
1 <section id="FE_GET_SET_PROPERTY">
2 <title><constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></title>
3 <para>This section describes the DVB version 5 extention of the DVB-API, also
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>
10 <section id="dtv-property">
11 <title>DTV property type</title>
12 <programlisting>
13 /* Reserved fields should be set to 0 */
14 struct dtv_property {
15 __u32 cmd;
16 union {
17 __u32 data;
18 struct {
19 __u8 data[32];
20 __u32 len;
21 __u32 reserved1[3];
22 void *reserved2;
23 } buffer;
24 } u;
25 int result;
26 } __attribute__ ((packed));
28 /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
29 #define DTV_IOCTL_MAX_MSGS 64
30 </programlisting>
31 </section>
32 <section id="dtv-properties">
33 <title>DTV properties type</title>
34 <programlisting>
35 struct dtv_properties {
36 __u32 num;
37 struct dtv_property *props;
38 };
39 </programlisting>
40 </section>
42 <section id="FE_GET_PROPERTY">
43 <title>FE_GET_PROPERTY</title>
44 <para>DESCRIPTION
45 </para>
46 <informaltable><tgroup cols="1"><tbody><row><entry
47 align="char">
48 <para>This ioctl call returns one or more frontend properties. This call only
49 requires read-only access to the device.</para>
50 </entry>
51 </row></tbody></tgroup></informaltable>
52 <para>SYNOPSIS
53 </para>
54 <informaltable><tgroup cols="1"><tbody><row><entry
55 align="char">
56 <para>int ioctl(int fd, int request = <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>,
57 dtv_properties ⋆props);</para>
58 </entry>
59 </row></tbody></tgroup></informaltable>
60 <para>PARAMETERS
61 </para>
62 <informaltable><tgroup cols="2"><tbody><row><entry align="char">
63 <para>int fd</para>
64 </entry><entry
65 align="char">
66 <para>File descriptor returned by a previous call to open().</para>
67 </entry>
68 </row><row><entry
69 align="char">
70 <para>int num</para>
71 </entry><entry
72 align="char">
73 <para>Equals <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link> for this command.</para>
74 </entry>
75 </row><row><entry
76 align="char">
77 <para>struct dtv_property *props</para>
78 </entry><entry
79 align="char">
80 <para>Points to the location where the front-end property commands are stored.</para>
81 </entry>
82 </row></tbody></tgroup></informaltable>
83 &return-value-dvb;
84 <informaltable><tgroup cols="2"><tbody><row>
85 <entry align="char"><para>EOPNOTSUPP</para></entry>
86 <entry align="char"><para>Property type not supported.</para></entry>
87 </row></tbody></tgroup></informaltable>
88 </section>
90 <section id="FE_SET_PROPERTY">
91 <title>FE_SET_PROPERTY</title>
92 <para>DESCRIPTION
93 </para>
94 <informaltable><tgroup cols="1"><tbody><row><entry
95 align="char">
96 <para>This ioctl call sets one or more frontend properties. This call only
97 requires read-only access to the device.</para>
98 </entry>
99 </row></tbody></tgroup></informaltable>
100 <para>SYNOPSIS
101 </para>
102 <informaltable><tgroup cols="1"><tbody><row><entry
103 align="char">
104 <para>int ioctl(int fd, int request = <link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link>,
105 dtv_properties ⋆props);</para>
106 </entry>
107 </row></tbody></tgroup></informaltable>
108 <para>PARAMETERS
109 </para>
110 <informaltable><tgroup cols="2"><tbody><row><entry align="char">
111 <para>int fd</para>
112 </entry><entry
113 align="char">
114 <para>File descriptor returned by a previous call to open().</para>
115 </entry>
116 </row><row><entry
117 align="char">
118 <para>int num</para>
119 </entry><entry
120 align="char">
121 <para>Equals <link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link> for this command.</para>
122 </entry>
123 </row><row><entry
124 align="char">
125 <para>struct dtv_property *props</para>
126 </entry><entry
127 align="char">
128 <para>Points to the location where the front-end property commands are stored.</para>
129 </entry>
130 </row></tbody></tgroup></informaltable>
131 &return-value-dvb;
132 <informaltable><tgroup cols="2"><tbody><row>
133 <entry align="char"><para>EOPNOTSUPP</para></entry>
134 <entry align="char"><para>Property type not supported.</para></entry>
135 </row></tbody></tgroup></informaltable>
136 </section>
138 <section>
139 <title>Property types</title>
140 <para>
141 On <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>/<link linkend="FE_SET_PROPERTY">FE_SET_PROPERTY</link>,
142 the actual action is determined by the dtv_property cmd/data pairs. With one single ioctl, is possible to
143 get/set up to 64 properties. The actual meaning of each property is described on the next sections.
144 </para>
146 <para>The available frontend property types are shown on the next section.</para>
147 </section>
149 <section id="fe_property_parameters">
150 <title>Digital TV property parameters</title>
151 <section id="DTV-UNDEFINED">
152 <title><constant>DTV_UNDEFINED</constant></title>
153 <para>Used internally. A GET/SET operation for it won't change or return anything.</para>
154 </section>
155 <section id="DTV-TUNE">
156 <title><constant>DTV_TUNE</constant></title>
157 <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>
158 </section>
159 <section id="DTV-CLEAR">
160 <title><constant>DTV_CLEAR</constant></title>
161 <para>Reset a cache of data specific to the frontend here. This does not effect hardware.</para>
162 </section>
163 <section id="DTV-FREQUENCY">
164 <title><constant>DTV_FREQUENCY</constant></title>
166 <para>Central frequency of the channel.</para>
168 <para>Notes:</para>
169 <para>1)For satellital delivery systems, it is measured in kHz.
170 For the other ones, it is measured in Hz.</para>
171 <para>2)For ISDB-T, the channels are usually transmitted with an offset of 143kHz.
172 E.g. a valid frequncy could be 474143 kHz. The stepping is bound to the bandwidth of
173 the channel which is 6MHz.</para>
175 <para>3)As in ISDB-Tsb the channel consists of only one or three segments the
176 frequency step is 429kHz, 3*429 respectively. As for ISDB-T the
177 central frequency of the channel is expected.</para>
178 </section>
179 <section id="DTV-MODULATION">
180 <title><constant>DTV_MODULATION</constant></title>
181 <para>Specifies the frontend modulation type for cable and satellite types. The modulation can be one of the types bellow:</para>
182 <programlisting>
183 typedef enum fe_modulation {
184 QPSK,
185 QAM_16,
186 QAM_32,
187 QAM_64,
188 QAM_128,
189 QAM_256,
190 QAM_AUTO,
191 VSB_8,
192 VSB_16,
193 PSK_8,
194 APSK_16,
195 APSK_32,
196 DQPSK,
197 } fe_modulation_t;
198 </programlisting>
199 </section>
200 <section id="DTV-BANDWIDTH-HZ">
201 <title><constant>DTV_BANDWIDTH_HZ</constant></title>
203 <para>Bandwidth for the channel, in HZ.</para>
205 <para>Possible values:
206 <constant>1712000</constant>,
207 <constant>5000000</constant>,
208 <constant>6000000</constant>,
209 <constant>7000000</constant>,
210 <constant>8000000</constant>,
211 <constant>10000000</constant>.
212 </para>
214 <para>Notes:</para>
216 <para>1) For ISDB-T it should be always 6000000Hz (6MHz)</para>
217 <para>2) For ISDB-Tsb it can vary depending on the number of connected segments</para>
218 <para>3) Bandwidth doesn't apply for DVB-C transmissions, as the bandwidth
219 for DVB-C depends on the symbol rate</para>
220 <para>4) Bandwidth in ISDB-T is fixed (6MHz) or can be easily derived from
221 other parameters (DTV_ISDBT_SB_SEGMENT_IDX,
222 DTV_ISDBT_SB_SEGMENT_COUNT).</para>
223 <para>5) DVB-T supports 6, 7 and 8MHz.</para>
224 <para>6) In addition, DVB-T2 supports 1.172, 5 and 10MHz.</para>
225 </section>
226 <section id="DTV-INVERSION">
227 <title><constant>DTV_INVERSION</constant></title>
228 <para>The Inversion field can take one of these values:
229 </para>
230 <programlisting>
231 typedef enum fe_spectral_inversion {
232 INVERSION_OFF,
233 INVERSION_ON,
234 INVERSION_AUTO
235 } fe_spectral_inversion_t;
236 </programlisting>
237 <para>It indicates if spectral inversion should be presumed or not. In the automatic setting
238 (<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by
239 itself.
240 </para>
241 </section>
242 <section id="DTV-DISEQC-MASTER">
243 <title><constant>DTV_DISEQC_MASTER</constant></title>
244 <para>Currently not implemented.</para>
245 </section>
246 <section id="DTV-SYMBOL-RATE">
247 <title><constant>DTV_SYMBOL_RATE</constant></title>
248 <para>Digital TV symbol rate, in bauds (symbols/second). Used on cable standards.</para>
249 </section>
250 <section id="DTV-INNER-FEC">
251 <title><constant>DTV_INNER_FEC</constant></title>
252 <para>Used cable/satellite transmissions. The acceptable values are:
253 </para>
254 <programlisting>
255 typedef enum fe_code_rate {
256 FEC_NONE = 0,
257 FEC_1_2,
258 FEC_2_3,
259 FEC_3_4,
260 FEC_4_5,
261 FEC_5_6,
262 FEC_6_7,
263 FEC_7_8,
264 FEC_8_9,
265 FEC_AUTO,
266 FEC_3_5,
267 FEC_9_10,
268 } fe_code_rate_t;
269 </programlisting>
270 <para>which correspond to error correction rates of 1/2, 2/3, etc.,
271 no error correction or auto detection.</para>
272 </section>
273 <section id="DTV-VOLTAGE">
274 <title><constant>DTV_VOLTAGE</constant></title>
275 <para>The voltage is usually used with non-DiSEqC capable LNBs to switch
276 the polarzation (horizontal/vertical). When using DiSEqC epuipment this
277 voltage has to be switched consistently to the DiSEqC commands as
278 described in the DiSEqC spec.</para>
279 <programlisting>
280 typedef enum fe_sec_voltage {
281 SEC_VOLTAGE_13,
282 SEC_VOLTAGE_18
283 } fe_sec_voltage_t;
284 </programlisting>
285 </section>
286 <section id="DTV-TONE">
287 <title><constant>DTV_TONE</constant></title>
288 <para>Currently not used.</para>
289 </section>
290 <section id="DTV-PILOT">
291 <title><constant>DTV_PILOT</constant></title>
292 <para>Sets DVB-S2 pilot</para>
293 <section id="fe-pilot-t">
294 <title>fe_pilot type</title>
295 <programlisting>
296 typedef enum fe_pilot {
297 PILOT_ON,
298 PILOT_OFF,
299 PILOT_AUTO,
300 } fe_pilot_t;
301 </programlisting>
302 </section>
303 </section>
304 <section id="DTV-ROLLOFF">
305 <title><constant>DTV_ROLLOFF</constant></title>
306 <para>Sets DVB-S2 rolloff</para>
308 <section id="fe-rolloff-t">
309 <title>fe_rolloff type</title>
310 <programlisting>
311 typedef enum fe_rolloff {
312 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
313 ROLLOFF_20,
314 ROLLOFF_25,
315 ROLLOFF_AUTO,
316 } fe_rolloff_t;
317 </programlisting>
318 </section>
319 </section>
320 <section id="DTV-DISEQC-SLAVE-REPLY">
321 <title><constant>DTV_DISEQC_SLAVE_REPLY</constant></title>
322 <para>Currently not implemented.</para>
323 </section>
324 <section id="DTV-FE-CAPABILITY-COUNT">
325 <title><constant>DTV_FE_CAPABILITY_COUNT</constant></title>
326 <para>Currently not implemented.</para>
327 </section>
328 <section id="DTV-FE-CAPABILITY">
329 <title><constant>DTV_FE_CAPABILITY</constant></title>
330 <para>Currently not implemented.</para>
331 </section>
332 <section id="DTV-DELIVERY-SYSTEM">
333 <title><constant>DTV_DELIVERY_SYSTEM</constant></title>
334 <para>Specifies the type of Delivery system</para>
335 <section id="fe-delivery-system-t">
336 <title>fe_delivery_system type</title>
337 <para>Possible values: </para>
338 <programlisting>
340 typedef enum fe_delivery_system {
341 SYS_UNDEFINED,
342 SYS_DVBC_ANNEX_A,
343 SYS_DVBC_ANNEX_B,
344 SYS_DVBT,
345 SYS_DSS,
346 SYS_DVBS,
347 SYS_DVBS2,
348 SYS_DVBH,
349 SYS_ISDBT,
350 SYS_ISDBS,
351 SYS_ISDBC,
352 SYS_ATSC,
353 SYS_ATSCMH,
354 SYS_DMBTH,
355 SYS_CMMB,
356 SYS_DAB,
357 SYS_DVBT2,
358 SYS_TURBO,
359 SYS_DVBC_ANNEX_C,
360 } fe_delivery_system_t;
361 </programlisting>
362 </section>
363 </section>
364 <section id="DTV-ISDBT-PARTIAL-RECEPTION">
365 <title><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></title>
367 <para>If <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '0' this bit-field represents whether
368 the channel is in partial reception mode or not.</para>
370 <para>If '1' <constant>DTV_ISDBT_LAYERA_*</constant> values are assigned to the center segment and
371 <constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant> has to be '1'.</para>
373 <para>If in addition <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'
374 <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> represents whether this ISDB-Tsb channel
375 is consisting of one segment and layer or three segments and two layers.</para>
377 <para>Possible values: 0, 1, -1 (AUTO)</para>
378 </section>
379 <section id="DTV-ISDBT-SOUND-BROADCASTING">
380 <title><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></title>
382 <para>This field represents whether the other DTV_ISDBT_*-parameters are
383 referring to an ISDB-T and an ISDB-Tsb channel. (See also
384 <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>).</para>
386 <para>Possible values: 0, 1, -1 (AUTO)</para>
387 </section>
388 <section id="DTV-ISDBT-SB-SUBCHANNEL-ID">
389 <title><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></title>
391 <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
393 <para>(Note of the author: This might not be the correct description of the
394 <constant>SUBCHANNEL-ID</constant> in all details, but it is my understanding of the technical
395 background needed to program a device)</para>
397 <para>An ISDB-Tsb channel (1 or 3 segments) can be broadcasted alone or in a
398 set of connected ISDB-Tsb channels. In this set of channels every
399 channel can be received independently. The number of connected
400 ISDB-Tsb segment can vary, e.g. depending on the frequency spectrum
401 bandwidth available.</para>
403 <para>Example: Assume 8 ISDB-Tsb connected segments are broadcasted. The
404 broadcaster has several possibilities to put those channels in the
405 air: Assuming a normal 13-segment ISDB-T spectrum he can align the 8
406 segments from position 1-8 to 5-13 or anything in between.</para>
408 <para>The underlying layer of segments are subchannels: each segment is
409 consisting of several subchannels with a predefined IDs. A sub-channel
410 is used to help the demodulator to synchronize on the channel.</para>
412 <para>An ISDB-T channel is always centered over all sub-channels. As for
413 the example above, in ISDB-Tsb it is no longer as simple as that.</para>
415 <para><constant>The DTV_ISDBT_SB_SUBCHANNEL_ID</constant> parameter is used to give the
416 sub-channel ID of the segment to be demodulated.</para>
418 <para>Possible values: 0 .. 41, -1 (AUTO)</para>
419 </section>
420 <section id="DTV-ISDBT-SB-SEGMENT-IDX">
421 <title><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></title>
422 <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
423 <para><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant> gives the index of the segment to be
424 demodulated for an ISDB-Tsb channel where several of them are
425 transmitted in the connected manner.</para>
426 <para>Possible values: 0 .. <constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> - 1</para>
427 <para>Note: This value cannot be determined by an automatic channel search.</para>
428 </section>
429 <section id="DTV-ISDBT-SB-SEGMENT-COUNT">
430 <title><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></title>
431 <para>This field only applies if <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> is '1'.</para>
432 <para><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant> gives the total count of connected ISDB-Tsb
433 channels.</para>
434 <para>Possible values: 1 .. 13</para>
435 <para>Note: This value cannot be determined by an automatic channel search.</para>
436 </section>
437 <section id="isdb-hierq-layers">
438 <title><constant>DTV-ISDBT-LAYER*</constant> parameters</title>
439 <para>ISDB-T channels can be coded hierarchically. As opposed to DVB-T in
440 ISDB-T hierarchical layers can be decoded simultaneously. For that
441 reason a ISDB-T demodulator has 3 viterbi and 3 reed-solomon-decoders.</para>
442 <para>ISDB-T has 3 hierarchical layers which each can use a part of the
443 available segments. The total number of segments over all layers has
444 to 13 in ISDB-T.</para>
445 <para>There are 3 parameter sets, for Layers A, B and C.</para>
446 <section id="DTV-ISDBT-LAYER-ENABLED">
447 <title><constant>DTV_ISDBT_LAYER_ENABLED</constant></title>
448 <para>Hierarchical reception in ISDB-T is achieved by enabling or disabling
449 layers in the decoding process. Setting all bits of
450 <constant>DTV_ISDBT_LAYER_ENABLED</constant> to '1' forces all layers (if applicable) to be
451 demodulated. This is the default.</para>
452 <para>If the channel is in the partial reception mode
453 (<constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> = 1) the central segment can be decoded
454 independently of the other 12 segments. In that mode layer A has to
455 have a <constant>SEGMENT_COUNT</constant> of 1.</para>
456 <para>In ISDB-Tsb only layer A is used, it can be 1 or 3 in ISDB-Tsb
457 according to <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>. <constant>SEGMENT_COUNT</constant> must be filled
458 accordingly.</para>
459 <para>Possible values: 0x1, 0x2, 0x4 (|-able)</para>
460 <para><constant>DTV_ISDBT_LAYER_ENABLED[0:0]</constant> - layer A</para>
461 <para><constant>DTV_ISDBT_LAYER_ENABLED[1:1]</constant> - layer B</para>
462 <para><constant>DTV_ISDBT_LAYER_ENABLED[2:2]</constant> - layer C</para>
463 <para><constant>DTV_ISDBT_LAYER_ENABLED[31:3]</constant> unused</para>
464 </section>
465 <section id="DTV-ISDBT-LAYER-FEC">
466 <title><constant>DTV_ISDBT_LAYER*_FEC</constant></title>
467 <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>
468 </section>
469 <section id="DTV-ISDBT-LAYER-MODULATION">
470 <title><constant>DTV_ISDBT_LAYER*_MODULATION</constant></title>
471 <para>Possible values: <constant>QAM_AUTO</constant>, QP<constant>SK, QAM_16</constant>, <constant>QAM_64</constant>, <constant>DQPSK</constant></para>
472 <para>Note: If layer C is <constant>DQPSK</constant> layer B has to be <constant>DQPSK</constant>. If layer B is <constant>DQPSK</constant>
473 and <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant>=0 layer has to be <constant>DQPSK</constant>.</para>
474 </section>
475 <section id="DTV-ISDBT-LAYER-SEGMENT-COUNT">
476 <title><constant>DTV_ISDBT_LAYER*_SEGMENT_COUNT</constant></title>
477 <para>Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, -1 (AUTO)</para>
478 <para>Note: Truth table for <constant>DTV_ISDBT_SOUND_BROADCASTING</constant> and
479 <constant>DTV_ISDBT_PARTIAL_RECEPTION</constant> and <constant>LAYER</constant>*_SEGMENT_COUNT</para>
480 <informaltable id="isdbt-layer_seg-cnt-table">
481 <tgroup cols="6">
482 <tbody>
483 <row>
484 <entry>PR</entry>
485 <entry>SB</entry>
486 <entry>Layer A width</entry>
487 <entry>Layer B width</entry>
488 <entry>Layer C width</entry>
489 <entry>total width</entry>
490 </row>
491 <row>
492 <entry>0</entry>
493 <entry>0</entry>
494 <entry>1 .. 13</entry>
495 <entry>1 .. 13</entry>
496 <entry>1 .. 13</entry>
497 <entry>13</entry>
498 </row>
499 <row>
500 <entry>1</entry>
501 <entry>0</entry>
502 <entry>1</entry>
503 <entry>1 .. 13</entry>
504 <entry>1 .. 13</entry>
505 <entry>13</entry>
506 </row>
507 <row>
508 <entry>0</entry>
509 <entry>1</entry>
510 <entry>1</entry>
511 <entry>0</entry>
512 <entry>0</entry>
513 <entry>1</entry>
514 </row>
515 <row>
516 <entry>1</entry>
517 <entry>1</entry>
518 <entry>1</entry>
519 <entry>2</entry>
520 <entry>0</entry>
521 <entry>13</entry>
522 </row>
523 </tbody>
524 </tgroup>
525 </informaltable>
526 </section>
527 <section id="DTV-ISDBT-LAYER-TIME-INTERLEAVING">
528 <title><constant>DTV_ISDBT_LAYER*_TIME_INTERLEAVING</constant></title>
529 <para>Possible values: 0, 1, 2, 3, -1 (AUTO)</para>
530 <para>Note: The real inter-leaver depth-names depend on the mode (fft-size); the values
531 here are referring to what can be found in the TMCC-structure -
532 independent of the mode.</para>
533 </section>
534 </section>
535 <section id="DTV-API-VERSION">
536 <title><constant>DTV_API_VERSION</constant></title>
537 <para>Returns the major/minor version of the DVB API</para>
538 </section>
539 <section id="DTV-CODE-RATE-HP">
540 <title><constant>DTV_CODE_RATE_HP</constant></title>
541 <para>Used on terrestrial transmissions. The acceptable values are:
542 </para>
543 <programlisting>
544 typedef enum fe_code_rate {
545 FEC_NONE = 0,
546 FEC_1_2,
547 FEC_2_3,
548 FEC_3_4,
549 FEC_4_5,
550 FEC_5_6,
551 FEC_6_7,
552 FEC_7_8,
553 FEC_8_9,
554 FEC_AUTO,
555 FEC_3_5,
556 FEC_9_10,
557 } fe_code_rate_t;
558 </programlisting>
559 </section>
560 <section id="DTV-CODE-RATE-LP">
561 <title><constant>DTV_CODE_RATE_LP</constant></title>
562 <para>Used on terrestrial transmissions. The acceptable values are:
563 </para>
564 <programlisting>
565 typedef enum fe_code_rate {
566 FEC_NONE = 0,
567 FEC_1_2,
568 FEC_2_3,
569 FEC_3_4,
570 FEC_4_5,
571 FEC_5_6,
572 FEC_6_7,
573 FEC_7_8,
574 FEC_8_9,
575 FEC_AUTO,
576 FEC_3_5,
577 FEC_9_10,
578 } fe_code_rate_t;
579 </programlisting>
580 </section>
581 <section id="DTV-GUARD-INTERVAL">
582 <title><constant>DTV_GUARD_INTERVAL</constant></title>
584 <para>Possible values are:</para>
585 <programlisting>
586 typedef enum fe_guard_interval {
587 GUARD_INTERVAL_1_32,
588 GUARD_INTERVAL_1_16,
589 GUARD_INTERVAL_1_8,
590 GUARD_INTERVAL_1_4,
591 GUARD_INTERVAL_AUTO,
592 GUARD_INTERVAL_1_128,
593 GUARD_INTERVAL_19_128,
594 GUARD_INTERVAL_19_256,
595 } fe_guard_interval_t;
596 </programlisting>
598 <para>Notes:</para>
599 <para>1) If <constant>DTV_GUARD_INTERVAL</constant> is set the <constant>GUARD_INTERVAL_AUTO</constant> the hardware will
600 try to find the correct guard interval (if capable) and will use TMCC to fill
601 in the missing parameters.</para>
602 <para>2) Intervals 1/128, 19/128 and 19/256 are used only for DVB-T2 at present</para>
603 </section>
604 <section id="DTV-TRANSMISSION-MODE">
605 <title><constant>DTV_TRANSMISSION_MODE</constant></title>
607 <para>Specifies the number of carriers used by the standard</para>
609 <para>Possible values are:</para>
610 <programlisting>
611 typedef enum fe_transmit_mode {
612 TRANSMISSION_MODE_2K,
613 TRANSMISSION_MODE_8K,
614 TRANSMISSION_MODE_AUTO,
615 TRANSMISSION_MODE_4K,
616 TRANSMISSION_MODE_1K,
617 TRANSMISSION_MODE_16K,
618 TRANSMISSION_MODE_32K,
619 } fe_transmit_mode_t;
620 </programlisting>
621 <para>Notes:</para>
622 <para>1) ISDB-T supports three carrier/symbol-size: 8K, 4K, 2K. It is called
623 'mode' in the standard: Mode 1 is 2K, mode 2 is 4K, mode 3 is 8K</para>
625 <para>2) If <constant>DTV_TRANSMISSION_MODE</constant> is set the <constant>TRANSMISSION_MODE_AUTO</constant> the
626 hardware will try to find the correct FFT-size (if capable) and will
627 use TMCC to fill in the missing parameters.</para>
628 <para>3) DVB-T specifies 2K and 8K as valid sizes.</para>
629 <para>4) DVB-T2 specifies 1K, 2K, 4K, 8K, 16K and 32K.</para>
630 </section>
631 <section id="DTV-HIERARCHY">
632 <title><constant>DTV_HIERARCHY</constant></title>
633 <para>Frontend hierarchy</para>
634 <programlisting>
635 typedef enum fe_hierarchy {
636 HIERARCHY_NONE,
637 HIERARCHY_1,
638 HIERARCHY_2,
639 HIERARCHY_4,
640 HIERARCHY_AUTO
641 } fe_hierarchy_t;
642 </programlisting>
643 </section>
644 <section id="DTV-ISDBS-TS-ID">
645 <title><constant>DTV_ISDBS_TS_ID</constant></title>
646 <para>Currently unused.</para>
647 </section>
648 <section id="DTV-DVBT2-PLP-ID">
649 <title><constant>DTV_DVBT2_PLP_ID</constant></title>
650 <para>DVB-T2 supports Physical Layer Pipes (PLP) to allow transmission of
651 many data types via a single multiplex. The API will soon support this
652 at which point this section will be expanded.</para>
653 </section>
654 <section id="DTV_ENUM_DELSYS">
655 <title><constant>DTV_ENUM_DELSYS</constant></title>
656 <para>A Multi standard frontend needs to advertise the delivery systems provided.
657 Applications need to enumerate the provided delivery systems, before using
658 any other operation with the frontend. Prior to it's introduction,
659 FE_GET_INFO was used to determine a frontend type. A frontend which
660 provides more than a single delivery system, FE_GET_INFO doesn't help much.
661 Applications which intends to use a multistandard frontend must enumerate
662 the delivery systems associated with it, rather than trying to use
663 FE_GET_INFO. In the case of a legacy frontend, the result is just the same
664 as with FE_GET_INFO, but in a more structured format </para>
665 </section>
666 </section>
667 <section id="frontend-property-terrestrial-systems">
668 <title>Properties used on terrestrial delivery systems</title>
669 <section id="dvbt-params">
670 <title>DVB-T delivery system</title>
671 <para>The following parameters are valid for DVB-T:</para>
672 <itemizedlist mark='opencircle'>
673 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
674 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
675 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
676 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
677 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
678 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
679 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
680 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
681 <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem>
682 <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem>
683 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
684 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
685 <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem>
686 </itemizedlist>
687 </section>
688 <section id="dvbt2-params">
689 <title>DVB-T2 delivery system</title>
690 <para>DVB-T2 support is currently in the early stages
691 of development, so expect that this section maygrow and become
692 more detailed with time.</para>
693 <para>The following parameters are valid for DVB-T2:</para>
694 <itemizedlist mark='opencircle'>
695 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
696 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
697 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
698 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
699 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
700 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
701 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
702 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
703 <listitem><para><link linkend="DTV-CODE-RATE-HP"><constant>DTV_CODE_RATE_HP</constant></link></para></listitem>
704 <listitem><para><link linkend="DTV-CODE-RATE-LP"><constant>DTV_CODE_RATE_LP</constant></link></para></listitem>
705 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
706 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
707 <listitem><para><link linkend="DTV-HIERARCHY"><constant>DTV_HIERARCHY</constant></link></para></listitem>
708 <listitem><para><link linkend="DTV-DVBT2-PLP-ID"><constant>DTV_DVBT2_PLP_ID</constant></link></para></listitem>
709 </itemizedlist>
710 </section>
711 <section id="isdbt">
712 <title>ISDB-T delivery system</title>
713 <para>This ISDB-T/ISDB-Tsb API extension should reflect all information
714 needed to tune any ISDB-T/ISDB-Tsb hardware. Of course it is possible
715 that some very sophisticated devices won't need certain parameters to
716 tune.</para>
717 <para>The information given here should help application writers to know how
718 to handle ISDB-T and ISDB-Tsb hardware using the Linux DVB-API.</para>
719 <para>The details given here about ISDB-T and ISDB-Tsb are just enough to
720 basically show the dependencies between the needed parameter values,
721 but surely some information is left out. For more detailed information
722 see the following documents:</para>
723 <para>ARIB STD-B31 - "Transmission System for Digital Terrestrial
724 Television Broadcasting" and</para>
725 <para>ARIB TR-B14 - "Operational Guidelines for Digital Terrestrial
726 Television Broadcasting".</para>
727 <para>In order to understand the ISDB specific parameters,
728 one has to have some knowledge the channel structure in
729 ISDB-T and ISDB-Tsb. I.e. it has to be known to
730 the reader that an ISDB-T channel consists of 13 segments,
731 that it can have up to 3 layer sharing those segments,
732 and things like that.</para>
733 <para>The following parameters are valid for ISDB-T:</para>
734 <itemizedlist mark='opencircle'>
735 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
736 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
737 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
738 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
739 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
740 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
741 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
742 <listitem><para><link linkend="DTV-GUARD-INTERVAL"><constant>DTV_GUARD_INTERVAL</constant></link></para></listitem>
743 <listitem><para><link linkend="DTV-TRANSMISSION-MODE"><constant>DTV_TRANSMISSION_MODE</constant></link></para></listitem>
744 <listitem><para><link linkend="DTV-ISDBT-LAYER-ENABLED"><constant>DTV_ISDBT_LAYER_ENABLED</constant></link></para></listitem>
745 <listitem><para><link linkend="DTV-ISDBT-PARTIAL-RECEPTION"><constant>DTV_ISDBT_PARTIAL_RECEPTION</constant></link></para></listitem>
746 <listitem><para><link linkend="DTV-ISDBT-SOUND-BROADCASTING"><constant>DTV_ISDBT_SOUND_BROADCASTING</constant></link></para></listitem>
747 <listitem><para><link linkend="DTV-ISDBT-SB-SUBCHANNEL-ID"><constant>DTV_ISDBT_SB_SUBCHANNEL_ID</constant></link></para></listitem>
748 <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-IDX"><constant>DTV_ISDBT_SB_SEGMENT_IDX</constant></link></para></listitem>
749 <listitem><para><link linkend="DTV-ISDBT-SB-SEGMENT-COUNT"><constant>DTV_ISDBT_SB_SEGMENT_COUNT</constant></link></para></listitem>
750 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERA_FEC</constant></link></para></listitem>
751 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERA_MODULATION</constant></link></para></listitem>
752 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERA_SEGMENT_COUNT</constant></link></para></listitem>
753 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERA_TIME_INTERLEAVING</constant></link></para></listitem>
754 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERB_FEC</constant></link></para></listitem>
755 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERB_MODULATION</constant></link></para></listitem>
756 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERB_SEGMENT_COUNT</constant></link></para></listitem>
757 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERB_TIME_INTERLEAVING</constant></link></para></listitem>
758 <listitem><para><link linkend="DTV-ISDBT-LAYER-FEC"><constant>DTV_ISDBT_LAYERC_FEC</constant></link></para></listitem>
759 <listitem><para><link linkend="DTV-ISDBT-LAYER-MODULATION"><constant>DTV_ISDBT_LAYERC_MODULATION</constant></link></para></listitem>
760 <listitem><para><link linkend="DTV-ISDBT-LAYER-SEGMENT-COUNT"><constant>DTV_ISDBT_LAYERC_SEGMENT_COUNT</constant></link></para></listitem>
761 <listitem><para><link linkend="DTV-ISDBT-LAYER-TIME-INTERLEAVING"><constant>DTV_ISDBT_LAYERC_TIME_INTERLEAVING</constant></link></para></listitem>
762 </itemizedlist>
763 </section>
764 <section id="atsc-params">
765 <title>ATSC delivery system</title>
766 <para>The following parameters are valid for ATSC:</para>
767 <itemizedlist mark='opencircle'>
768 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
769 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
770 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
771 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
772 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
773 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
774 <listitem><para><link linkend="DTV-BANDWIDTH-HZ"><constant>DTV_BANDWIDTH_HZ</constant></link></para></listitem>
775 </itemizedlist>
776 </section>
777 </section>
778 <section id="frontend-property-cable-systems">
779 <title>Properties used on cable delivery systems</title>
780 <section id="dvbc-params">
781 <title>DVB-C delivery system</title>
782 <para>The DVB-C Annex-A is the widely used cable standard. Transmission uses QAM modulation.</para>
783 <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>
784 <para>The following parameters are valid for DVB-C Annex A/C:</para>
785 <itemizedlist mark='opencircle'>
786 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
787 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
788 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
789 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
790 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
791 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
792 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
793 <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem>
794 <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem>
795 </itemizedlist>
796 </section>
797 <section id="dvbc-annex-b-params">
798 <title>DVB-C Annex B delivery system</title>
799 <para>The DVB-C Annex-B is only used on a few Countries like the United States.</para>
800 <para>The following parameters are valid for DVB-C Annex B:</para>
801 <itemizedlist mark='opencircle'>
802 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
803 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
804 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
805 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
806 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
807 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
808 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
809 </itemizedlist>
810 </section>
811 </section>
812 <section id="frontend-property-satellital-systems">
813 <title>Properties used on satellital delivery systems</title>
814 <section id="dvbs-params">
815 <title>DVB-S delivery system</title>
816 <para>The following parameters are valid for DVB-S:</para>
817 <itemizedlist mark='opencircle'>
818 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
819 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
820 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
821 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
822 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
823 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
824 <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem>
825 <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem>
826 <listitem><para><link linkend="DTV-VOLTAGE"><constant>DTV_VOLTAGE</constant></link></para></listitem>
827 <listitem><para><link linkend="DTV-TONE"><constant>DTV_TONE</constant></link></para></listitem>
828 </itemizedlist>
829 <para>Future implementations might add those two missing parameters:</para>
830 <itemizedlist mark='opencircle'>
831 <listitem><para><link linkend="DTV-DISEQC-MASTER"><constant>DTV_DISEQC_MASTER</constant></link></para></listitem>
832 <listitem><para><link linkend="DTV-DISEQC-SLAVE-REPLY"><constant>DTV_DISEQC_SLAVE_REPLY</constant></link></para></listitem>
833 </itemizedlist>
834 </section>
835 <section id="dvbs2-params">
836 <title>DVB-S2 delivery system</title>
837 <para>In addition to all parameters valid for DVB-S, DVB-S2 supports the following parameters:</para>
838 <itemizedlist mark='opencircle'>
839 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
840 <listitem><para><link linkend="DTV-PILOT"><constant>DTV_PILOT</constant></link></para></listitem>
841 <listitem><para><link linkend="DTV-ROLLOFF"><constant>DTV_ROLLOFF</constant></link></para></listitem>
842 </itemizedlist>
843 </section>
844 <section id="turbo-params">
845 <title>Turbo code delivery system</title>
846 <para>In addition to all parameters valid for DVB-S, turbo code supports the following parameters:</para>
847 <itemizedlist mark='opencircle'>
848 <listitem><para><link linkend="DTV-MODULATION"><constant>DTV_MODULATION</constant></link></para></listitem>
849 </itemizedlist>
850 </section>
851 <section id="isdbs-params">
852 <title>ISDB-S delivery system</title>
853 <para>The following parameters are valid for ISDB-S:</para>
854 <itemizedlist mark='opencircle'>
855 <listitem><para><link linkend="DTV-API-VERSION"><constant>DTV_API_VERSION</constant></link></para></listitem>
856 <listitem><para><link linkend="DTV-DELIVERY-SYSTEM"><constant>DTV_DELIVERY_SYSTEM</constant></link></para></listitem>
857 <listitem><para><link linkend="DTV-TUNE"><constant>DTV_TUNE</constant></link></para></listitem>
858 <listitem><para><link linkend="DTV-CLEAR"><constant>DTV_CLEAR</constant></link></para></listitem>
859 <listitem><para><link linkend="DTV-FREQUENCY"><constant>DTV_FREQUENCY</constant></link></para></listitem>
860 <listitem><para><link linkend="DTV-INVERSION"><constant>DTV_INVERSION</constant></link></para></listitem>
861 <listitem><para><link linkend="DTV-SYMBOL-RATE"><constant>DTV_SYMBOL_RATE</constant></link></para></listitem>
862 <listitem><para><link linkend="DTV-INNER-FEC"><constant>DTV_INNER_FEC</constant></link></para></listitem>
863 <listitem><para><link linkend="DTV-VOLTAGE"><constant>DTV_VOLTAGE</constant></link></para></listitem>
864 <listitem><para><link linkend="DTV-ISDBS-TS-ID"><constant>DTV_ISDBS_TS_ID</constant></link></para></listitem>
865 </itemizedlist>
866 </section>
867 </section>
868 </section>