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