[media] DocBook: move DVB properties to happen earlier at the document
[cascardo/linux.git] / Documentation / DocBook / media / dvb / frontend.xml
1 <title>DVB Frontend API</title>
2
3 <para>The DVB frontend API was designed to support three types of delivery systems:</para>
4 <itemizedlist>
5     <listitem>Terrestrial systems: DVB-T, DVB-T2, ATSC, ATSC M/H, ISDB-T, DVB-H, DTMB, CMMB</listitem>
6     <listitem>Cable systems: DVB-C Annex A/C, ClearQAM (DVB-C Annex B), ISDB-C</listitem>
7     <listitem>Satellital systems: DVB-S, DVB-S2, DVB Turbo, ISDB-S, DSS</listitem>
8 </itemizedlist>
9 <para>The DVB frontend controls several sub-devices including:</para>
10 <itemizedlist>
11     <listitem>Tuner</listitem>,
12     <listitem>Digital TV demodulator</listitem>
13     <listitem>Low noise amplifier (LNA)</listitem>
14     <listitem>Satellite Equipment Control (SEC) hardware (only for Satellite).</listitem>
15 </itemizedlist>
16 <para>The frontend can be accessed through
17     <emphasis role="bold">/dev/dvb/adapter?/frontend?</emphasis>. Data types and
18     ioctl definitions can be accessed by including
19     <emphasis role="bold">linux/dvb/frontend.h</emphasis> in your application.
20 </para>
21
22 <para>NOTE: Transmission via the internet (DVB-IP)
23     is not yet handled by this API but a future extension is possible.</para>
24 <para>On Satellital systems, the API support for the Satellite Equipment Control
25     (SEC) allows to power control and to send/receive signals to control the
26     antenna subsystem, selecting the polarization and choosing the Intermediate
27     Frequency IF) of the Low Noise Block Converter Feed Horn (LNBf). It
28     supports the DiSEqC and V-SEC protocols. The DiSEqC (digital SEC)
29 specification is available at
30 <ulink url="http://www.eutelsat.com/satellites/4_5_5.html">Eutelsat</ulink>.</para>
31
32
33 <section id="query-dvb-frontend-info">
34 <title>Querying frontend information</title>
35
36 <para>Information about the frontend can be queried with
37         <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
38 </section>
39
40 &sub-frontend_get_info;
41
42 <section id="dvb-fe-read-status">
43 <title>Querying frontend status</title>
44
45 <para>Information about the frontend tuner locking status can be queried with
46         <link linkend="FE_READ_STATUS">FE_READ_STATUS</link>.</para>
47 </section>
48
49 &sub-frontend_read_status;
50
51 &sub-dvbproperty;
52
53 <section id="dvb-diseqc-master-cmd">
54 <title>diseqc master command</title>
55
56 <para>A message sent from the frontend to DiSEqC capable equipment.</para>
57 <programlisting>
58         struct dvb_diseqc_master_cmd {
59         uint8_t msg [6]; /&#x22C6;  { framing, address, command, data[3] } &#x22C6;/
60         uint8_t msg_len; /&#x22C6;  valid values are 3...6  &#x22C6;/
61         };
62 </programlisting>
63 </section>
64
65 <section role="subsection" id="dvb-diseqc-slave-reply">
66 <title>diseqc slave reply</title>
67
68 <para>A reply to the frontend from DiSEqC 2.0 capable equipment.</para>
69 <programlisting>
70         struct dvb_diseqc_slave_reply {
71         uint8_t msg [4]; /&#x22C6;  { framing, data [3] } &#x22C6;/
72         uint8_t msg_len; /&#x22C6;  valid values are 0...4, 0 means no msg  &#x22C6;/
73         int     timeout; /&#x22C6;  return from ioctl after timeout ms with &#x22C6;/
74         };                       /&#x22C6;  errorcode when no message was received  &#x22C6;/
75 </programlisting>
76 </section>
77
78 <section id="fe-sec-voltage-t">
79 <title>diseqc slave reply</title>
80 <para>The voltage is usually used with non-DiSEqC capable LNBs to switch the polarzation
81 (horizontal/vertical). When using DiSEqC epuipment this voltage has to be switched
82 consistently to the DiSEqC commands as described in the DiSEqC spec.</para>
83 <programlisting>
84         typedef enum fe_sec_voltage {
85         SEC_VOLTAGE_13,
86         SEC_VOLTAGE_18
87         } fe_sec_voltage_t;
88 </programlisting>
89 </section>
90
91 <section id="fe-sec-tone-mode-t">
92 <title>SEC continuous tone</title>
93
94 <para>The continuous 22KHz tone is usually used with non-DiSEqC capable LNBs to switch the
95 high/low band of a dual-band LNB. When using DiSEqC epuipment this voltage has to
96 be switched consistently to the DiSEqC commands as described in the DiSEqC
97 spec.</para>
98 <programlisting>
99         typedef enum fe_sec_tone_mode {
100         SEC_TONE_ON,
101         SEC_TONE_OFF
102         } fe_sec_tone_mode_t;
103 </programlisting>
104 </section>
105
106 <section id="fe-sec-mini-cmd-t">
107 <title>SEC tone burst</title>
108
109 <para>The 22KHz tone burst is usually used with non-DiSEqC capable switches to select
110 between two connected LNBs/satellites. When using DiSEqC epuipment this voltage has to
111 be switched consistently to the DiSEqC commands as described in the DiSEqC
112 spec.</para>
113 <programlisting>
114         typedef enum fe_sec_mini_cmd {
115         SEC_MINI_A,
116         SEC_MINI_B
117         } fe_sec_mini_cmd_t;
118 </programlisting>
119
120 <para></para>
121 </section>
122
123 <section id="fe-spectral-inversion-t">
124 <title>frontend spectral inversion</title>
125 <para>The Inversion field can take one of these values:
126 </para>
127 <programlisting>
128 typedef enum fe_spectral_inversion {
129         INVERSION_OFF,
130         INVERSION_ON,
131         INVERSION_AUTO
132 } fe_spectral_inversion_t;
133 </programlisting>
134 <para>It indicates if spectral inversion should be presumed or not. In the automatic setting
135 (<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by
136 itself.
137 </para>
138 </section>
139
140 <section id="fe-code-rate-t">
141 <title>frontend code rate</title>
142 <para>The possible values for the <constant>fec_inner</constant> field used on
143 <link linkend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and
144 <link linkend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are:
145 </para>
146 <programlisting>
147 typedef enum fe_code_rate {
148         FEC_NONE = 0,
149         FEC_1_2,
150         FEC_2_3,
151         FEC_3_4,
152         FEC_4_5,
153         FEC_5_6,
154         FEC_6_7,
155         FEC_7_8,
156         FEC_8_9,
157         FEC_AUTO,
158         FEC_3_5,
159         FEC_9_10,
160 } fe_code_rate_t;
161 </programlisting>
162 <para>which correspond to error correction rates of 1/2, 2/3, etc., no error correction or auto
163 detection.
164 </para>
165 </section>
166
167 <section id="fe-modulation-t">
168 <title>frontend modulation type for QAM, OFDM and VSB</title>
169 <para>For cable and terrestrial frontends, e. g. for
170 <link linkend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>,
171 <link linkend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and
172 <link linkend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>,
173 it needs to specify the quadrature modulation mode which can be one of the following:
174 </para>
175 <programlisting>
176  typedef enum fe_modulation {
177         QPSK,
178         QAM_16,
179         QAM_32,
180         QAM_64,
181         QAM_128,
182         QAM_256,
183         QAM_AUTO,
184         VSB_8,
185         VSB_16,
186         PSK_8,
187         APSK_16,
188         APSK_32,
189         DQPSK,
190  } fe_modulation_t;
191 </programlisting>
192 </section>
193
194 <section>
195 <title>More OFDM parameters</title>
196
197 <section id="fe-transmit-mode-t">
198 <title>Number of carriers per channel</title>
199 <programlisting>
200 typedef enum fe_transmit_mode {
201         TRANSMISSION_MODE_2K,
202         TRANSMISSION_MODE_8K,
203         TRANSMISSION_MODE_AUTO,
204         TRANSMISSION_MODE_4K,
205         TRANSMISSION_MODE_1K,
206         TRANSMISSION_MODE_16K,
207         TRANSMISSION_MODE_32K,
208  } fe_transmit_mode_t;
209 </programlisting>
210 </section>
211
212 <section id="fe-bandwidth-t">
213 <title>frontend bandwidth</title>
214 <programlisting>
215 typedef enum fe_bandwidth {
216         BANDWIDTH_8_MHZ,
217         BANDWIDTH_7_MHZ,
218         BANDWIDTH_6_MHZ,
219         BANDWIDTH_AUTO,
220         BANDWIDTH_5_MHZ,
221         BANDWIDTH_10_MHZ,
222         BANDWIDTH_1_712_MHZ,
223 } fe_bandwidth_t;
224 </programlisting>
225 </section>
226
227 <section id="fe-guard-interval-t">
228 <title>frontend guard inverval</title>
229 <programlisting>
230 typedef enum fe_guard_interval {
231         GUARD_INTERVAL_1_32,
232         GUARD_INTERVAL_1_16,
233         GUARD_INTERVAL_1_8,
234         GUARD_INTERVAL_1_4,
235         GUARD_INTERVAL_AUTO,
236         GUARD_INTERVAL_1_128,
237         GUARD_INTERVAL_19_128,
238         GUARD_INTERVAL_19_256,
239 } fe_guard_interval_t;
240 </programlisting>
241 </section>
242
243 <section id="fe-hierarchy-t">
244 <title>frontend hierarchy</title>
245 <programlisting>
246 typedef enum fe_hierarchy {
247          HIERARCHY_NONE,
248          HIERARCHY_1,
249          HIERARCHY_2,
250          HIERARCHY_4,
251          HIERARCHY_AUTO
252  } fe_hierarchy_t;
253 </programlisting>
254 </section>
255
256 </section>
257
258 <section id="frontend_fcalls">
259 <title>Frontend Function Calls</title>
260
261 <section id="frontend_f_open">
262 <title>open()</title>
263 <para>DESCRIPTION</para>
264 <informaltable><tgroup cols="1"><tbody><row>
265 <entry align="char">
266 <para>This system call opens a named frontend device (/dev/dvb/adapter0/frontend0)
267  for subsequent use. Usually the first thing to do after a successful open is to
268  find out the frontend type with <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
269 <para>The device can be opened in read-only mode, which only allows monitoring of
270  device status and statistics, or read/write mode, which allows any kind of use
271  (e.g. performing tuning operations.)
272 </para>
273 <para>In a system with multiple front-ends, it is usually the case that multiple devices
274  cannot be open in read/write mode simultaneously. As long as a front-end
275  device is opened in read/write mode, other open() calls in read/write mode will
276  either fail or block, depending on whether non-blocking or blocking mode was
277  specified. A front-end device opened in blocking mode can later be put into
278  non-blocking mode (and vice versa) using the F_SETFL command of the fcntl
279  system call. This is a standard system call, documented in the Linux manual
280  page for fcntl. When an open() call has succeeded, the device will be ready
281  for use in the specified mode. This implies that the corresponding hardware is
282  powered up, and that other front-ends may have been powered down to make
283  that possible.</para>
284 </entry>
285  </row></tbody></tgroup></informaltable>
286
287 <para>SYNOPSIS</para>
288 <informaltable><tgroup cols="1"><tbody><row><entry
289  align="char">
290 <para>int open(const char &#x22C6;deviceName, int flags);</para>
291 </entry>
292  </row></tbody></tgroup></informaltable>
293 <para>PARAMETERS
294 </para>
295 <informaltable><tgroup cols="2"><tbody><row><entry
296  align="char">
297 <para>const char
298  *deviceName</para>
299 </entry><entry
300  align="char">
301 <para>Name of specific video device.</para>
302 </entry>
303  </row><row><entry
304  align="char">
305 <para>int flags</para>
306 </entry><entry
307  align="char">
308 <para>A bit-wise OR of the following flags:</para>
309 </entry>
310  </row><row><entry
311  align="char">
312 </entry><entry
313  align="char">
314 <para>O_RDONLY read-only access</para>
315 </entry>
316  </row><row><entry
317  align="char">
318 </entry><entry
319  align="char">
320 <para>O_RDWR read/write access</para>
321 </entry>
322  </row><row><entry
323  align="char">
324 </entry><entry
325  align="char">
326 <para>O_NONBLOCK open in non-blocking mode</para>
327 </entry>
328  </row><row><entry
329  align="char">
330 </entry><entry
331  align="char">
332 <para>(blocking mode is the default)</para>
333 </entry>
334  </row></tbody></tgroup></informaltable>
335 <para>RETURN VALUE</para>
336 <informaltable><tgroup cols="2"><tbody><row><entry
337  align="char">
338 <para>ENODEV</para>
339 </entry><entry
340  align="char">
341 <para>Device driver not loaded/available.</para>
342 </entry>
343  </row><row><entry
344  align="char">
345 <para>EINTERNAL</para>
346 </entry><entry
347  align="char">
348 <para>Internal error.</para>
349 </entry>
350  </row><row><entry
351  align="char">
352 <para>EBUSY</para>
353 </entry><entry
354  align="char">
355 <para>Device or resource busy.</para>
356 </entry>
357  </row><row><entry
358  align="char">
359 <para>EINVAL</para>
360 </entry><entry
361  align="char">
362 <para>Invalid argument.</para>
363 </entry>
364  </row></tbody></tgroup></informaltable>
365 </section>
366
367 <section id="frontend_f_close">
368 <title>close()</title>
369 <para>DESCRIPTION
370 </para>
371 <informaltable><tgroup cols="1"><tbody><row><entry
372  align="char">
373 <para>This system call closes a previously opened front-end device. After closing
374  a front-end device, its corresponding hardware might be powered down
375  automatically.</para>
376 </entry>
377  </row></tbody></tgroup></informaltable>
378 <para>SYNOPSIS
379 </para>
380 <informaltable><tgroup cols="1"><tbody><row><entry
381  align="char">
382 <para>int close(int fd);</para>
383 </entry>
384  </row></tbody></tgroup></informaltable>
385 <para>PARAMETERS
386 </para>
387 <informaltable><tgroup cols="2"><tbody><row><entry
388  align="char">
389 <para>int fd</para>
390 </entry><entry
391  align="char">
392 <para>File descriptor returned by a previous call to open().</para>
393 </entry>
394  </row></tbody></tgroup></informaltable>
395 <para>RETURN VALUE</para>
396 <informaltable><tgroup cols="2"><tbody><row><entry
397  align="char">
398 <para>EBADF</para>
399 </entry><entry
400  align="char">
401 <para>fd is not a valid open file descriptor.</para>
402 </entry>
403  </row></tbody></tgroup></informaltable>
404 </section>
405
406
407 <section id="FE_DISEQC_RESET_OVERLOAD">
408 <title>FE_DISEQC_RESET_OVERLOAD</title>
409 <para>DESCRIPTION
410 </para>
411 <informaltable><tgroup cols="1"><tbody><row><entry
412  align="char">
413 <para>If the bus has been automatically powered off due to power overload, this ioctl
414  call restores the power to the bus. The call requires read/write access to the
415  device. This call has no effect if the device is manually powered off. Not all
416  DVB adapters support this ioctl.</para>
417 </entry>
418  </row></tbody></tgroup></informaltable>
419
420 <para>SYNOPSIS
421 </para>
422 <informaltable><tgroup cols="1"><tbody><row><entry
423  align="char">
424 <para>int ioctl(int fd, int request =
425  <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>);</para>
426 </entry>
427  </row></tbody></tgroup></informaltable>
428 <para>PARAMETERS
429 </para>
430 <informaltable><tgroup cols="2"><tbody><row><entry
431  align="char">
432 <para>int fd</para>
433 </entry><entry
434  align="char">
435 <para>File descriptor returned by a previous call to open().</para>
436 </entry>
437  </row><row><entry
438  align="char">
439 <para>int request</para>
440 </entry><entry
441  align="char">
442 <para>Equals <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> for this
443  command.</para>
444 </entry>
445  </row></tbody></tgroup></informaltable>
446
447 &return-value-dvb;
448 </section>
449
450 <section id="FE_DISEQC_SEND_MASTER_CMD">
451 <title>FE_DISEQC_SEND_MASTER_CMD</title>
452 <para>DESCRIPTION
453 </para>
454 <informaltable><tgroup cols="1"><tbody><row><entry
455  align="char">
456 <para>This ioctl call is used to send a a DiSEqC command.</para>
457 </entry>
458  </row></tbody></tgroup></informaltable>
459 <para>SYNOPSIS
460 </para>
461 <informaltable><tgroup cols="1"><tbody><row><entry
462  align="char">
463 <para>int ioctl(int fd, int request =
464  <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link>, struct
465  dvb_diseqc_master_cmd &#x22C6;cmd);</para>
466 </entry>
467  </row></tbody></tgroup></informaltable>
468
469 <para>PARAMETERS
470 </para>
471 <informaltable><tgroup cols="2"><tbody><row><entry
472  align="char">
473 <para>int fd</para>
474 </entry><entry
475  align="char">
476 <para>File descriptor returned by a previous call to open().</para>
477 </entry>
478  </row><row><entry
479  align="char">
480 <para>int request</para>
481 </entry><entry
482  align="char">
483 <para>Equals <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link> for this
484  command.</para>
485 </entry>
486  </row><row><entry
487  align="char">
488 <para>struct
489  dvb_diseqc_master_cmd
490  *cmd</para>
491 </entry><entry
492  align="char">
493 <para>Pointer to the command to be transmitted.</para>
494 </entry>
495  </row></tbody></tgroup></informaltable>
496
497 &return-value-dvb;
498 </section>
499
500 <section id="FE_DISEQC_RECV_SLAVE_REPLY">
501 <title>FE_DISEQC_RECV_SLAVE_REPLY</title>
502 <para>DESCRIPTION
503 </para>
504 <informaltable><tgroup cols="1"><tbody><row><entry
505  align="char">
506 <para>This ioctl call is used to receive reply to a DiSEqC 2.0 command.</para>
507 </entry>
508  </row></tbody></tgroup></informaltable>
509
510 <para>SYNOPSIS
511 </para>
512 <informaltable><tgroup cols="1"><tbody><row><entry
513  align="char">
514 <para>int ioctl(int fd, int request =
515  <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link>, struct
516  dvb_diseqc_slave_reply &#x22C6;reply);</para>
517 </entry>
518  </row></tbody></tgroup></informaltable>
519
520 <para>PARAMETERS
521 </para>
522 <informaltable><tgroup cols="2"><tbody><row><entry
523  align="char">
524 <para>int fd</para>
525 </entry><entry
526  align="char">
527 <para>File descriptor returned by a previous call to open().</para>
528 </entry>
529  </row><row><entry
530  align="char">
531 <para>int request</para>
532 </entry><entry
533  align="char">
534 <para>Equals <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link> for this
535  command.</para>
536 </entry>
537  </row><row><entry
538  align="char">
539 <para>struct
540  dvb_diseqc_slave_reply
541  *reply</para>
542 </entry><entry
543  align="char">
544 <para>Pointer to the command to be received.</para>
545 </entry>
546  </row></tbody></tgroup></informaltable>
547 &return-value-dvb;
548 </section>
549
550 <section id="FE_DISEQC_SEND_BURST">
551 <title>FE_DISEQC_SEND_BURST</title>
552 <para>DESCRIPTION
553 </para>
554 <informaltable><tgroup cols="1"><tbody><row><entry
555  align="char">
556 <para>This ioctl call is used to send a 22KHz tone burst.</para>
557 </entry>
558  </row></tbody></tgroup></informaltable>
559
560 <para>SYNOPSIS
561 </para>
562 <informaltable><tgroup cols="1"><tbody><row><entry
563  align="char">
564 <para>int ioctl(int fd, int request =
565  <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link>, fe_sec_mini_cmd_t burst);</para>
566 </entry>
567  </row></tbody></tgroup></informaltable>
568
569 <para>PARAMETERS
570 </para>
571 <informaltable><tgroup cols="2"><tbody><row><entry
572  align="char">
573 <para>int fd</para>
574 </entry><entry
575  align="char">
576 <para>File descriptor returned by a previous call to open().</para>
577 </entry>
578  </row><row><entry
579  align="char">
580 <para>int request</para>
581 </entry><entry
582  align="char">
583 <para>Equals <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link> for this command.</para>
584 </entry>
585  </row><row><entry
586  align="char">
587 <para>fe_sec_mini_cmd_t
588  burst</para>
589 </entry><entry
590  align="char">
591 <para>burst A or B.</para>
592 </entry>
593  </row></tbody></tgroup></informaltable>
594
595 &return-value-dvb;
596 </section>
597
598 <section id="FE_SET_TONE">
599 <title>FE_SET_TONE</title>
600 <para>DESCRIPTION
601 </para>
602 <informaltable><tgroup cols="1"><tbody><row><entry
603  align="char">
604 <para>This call is used to set the generation of the continuous 22kHz tone. This call
605  requires read/write permissions.</para>
606 </entry>
607  </row></tbody></tgroup></informaltable>
608 <para>SYNOPSIS
609 </para>
610 <informaltable><tgroup cols="1"><tbody><row><entry
611  align="char">
612 <para>int ioctl(int fd, int request = <link linkend="FE_SET_TONE">FE_SET_TONE</link>,
613  fe_sec_tone_mode_t tone);</para>
614 </entry>
615  </row></tbody></tgroup></informaltable>
616 <para>PARAMETERS
617 </para>
618 <informaltable><tgroup cols="2"><tbody><row><entry
619  align="char">
620 <para>int fd</para>
621 </entry><entry
622  align="char">
623 <para>File descriptor returned by a previous call to open().</para>
624 </entry>
625  </row><row><entry
626  align="char">
627 <para>int request</para>
628 </entry><entry
629  align="char">
630 <para>Equals <link linkend="FE_SET_TONE">FE_SET_TONE</link> for this command.</para>
631 </entry>
632  </row><row><entry
633  align="char">
634 <para>fe_sec_tone_mode_t
635  tone</para>
636 </entry><entry
637  align="char">
638 <para>The requested tone generation mode (on/off).</para>
639 </entry>
640  </row></tbody></tgroup></informaltable>
641 &return-value-dvb;
642 </section>
643
644 <section id="FE_SET_VOLTAGE">
645 <title>FE_SET_VOLTAGE</title>
646 <para>DESCRIPTION
647 </para>
648 <informaltable><tgroup cols="1"><tbody><row><entry
649  align="char">
650 <para>This call is used to set the bus voltage. This call requires read/write
651  permissions.</para>
652 </entry>
653  </row></tbody></tgroup></informaltable>
654 <para>SYNOPSIS
655 </para>
656 <informaltable><tgroup cols="1"><tbody><row><entry
657  align="char">
658 <para>int ioctl(int fd, int request = <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link>,
659  fe_sec_voltage_t voltage);</para>
660 </entry>
661  </row></tbody></tgroup></informaltable>
662
663 <para>PARAMETERS
664 </para>
665 <informaltable><tgroup cols="2"><tbody><row><entry
666  align="char">
667 <para>int fd</para>
668 </entry><entry
669  align="char">
670 <para>File descriptor returned by a previous call to open().</para>
671 </entry>
672  </row><row><entry
673  align="char">
674 <para>int request</para>
675 </entry><entry
676  align="char">
677 <para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
678 </entry>
679  </row><row><entry
680  align="char">
681 <para>fe_sec_voltage_t
682  voltage</para>
683 </entry><entry
684  align="char">
685 <para>The requested bus voltage.</para>
686 </entry>
687  </row></tbody></tgroup></informaltable>
688
689 &return-value-dvb;
690 </section>
691
692 <section id="FE_ENABLE_HIGH_LNB_VOLTAGE">
693 <title>FE_ENABLE_HIGH_LNB_VOLTAGE</title>
694 <para>DESCRIPTION
695 </para>
696 <informaltable><tgroup cols="1"><tbody><row><entry
697  align="char">
698 <para>If high != 0 enables slightly higher voltages instead of 13/18V (to compensate
699  for long cables). This call requires read/write permissions. Not all DVB
700  adapters support this ioctl.</para>
701 </entry>
702  </row></tbody></tgroup></informaltable>
703
704 <para>SYNOPSIS
705 </para>
706 <informaltable><tgroup cols="1"><tbody><row><entry
707  align="char">
708 <para>int ioctl(int fd, int request =
709  <link linkend="FE_ENABLE_HIGH_LNB_VOLTAGE">FE_ENABLE_HIGH_LNB_VOLTAGE</link>, int high);</para>
710 </entry>
711  </row></tbody></tgroup></informaltable>
712
713 <para>PARAMETERS
714 </para>
715 <informaltable><tgroup cols="2"><tbody><row><entry
716  align="char">
717 <para>int fd</para>
718 </entry><entry
719  align="char">
720 <para>File descriptor returned by a previous call to open().</para>
721 </entry>
722  </row><row><entry
723  align="char">
724 <para>int request</para>
725 </entry><entry
726  align="char">
727 <para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
728 </entry>
729  </row><row><entry
730  align="char">
731 <para>int high</para>
732 </entry><entry
733  align="char">
734 <para>The requested bus voltage.</para>
735 </entry>
736  </row></tbody></tgroup></informaltable>
737
738 &return-value-dvb;
739 </section>
740
741 <section id="FE_SET_FRONTEND_TUNE_MODE">
742 <title>FE_SET_FRONTEND_TUNE_MODE</title>
743 <para>DESCRIPTION</para>
744 <informaltable><tgroup cols="1"><tbody><row>
745 <entry align="char">
746 <para>Allow setting tuner mode flags to the frontend.</para>
747 </entry>
748 </row></tbody></tgroup></informaltable>
749
750 <para>SYNOPSIS</para>
751 <informaltable><tgroup cols="1"><tbody><row>
752 <entry align="char">
753 <para>int ioctl(int fd, int request =
754 <link linkend="FE_SET_FRONTEND_TUNE_MODE">FE_SET_FRONTEND_TUNE_MODE</link>, unsigned int flags);</para>
755 </entry>
756 </row></tbody></tgroup></informaltable>
757
758 <para>PARAMETERS</para>
759 <informaltable><tgroup cols="2"><tbody><row>
760 <entry align="char">
761         <para>unsigned int flags</para>
762 </entry>
763 <entry align="char">
764 <para>
765 FE_TUNE_MODE_ONESHOT When set, this flag will disable any zigzagging or other "normal" tuning behaviour. Additionally, there will be no automatic monitoring of the lock status, and hence no frontend events will be generated. If a frontend device is closed, this flag will be automatically turned off when the device is reopened read-write.
766 </para>
767 </entry>
768  </row></tbody></tgroup></informaltable>
769
770 &return-value-dvb;
771 </section>
772
773 </section>
774
775 <section id="frontend_legacy_dvbv3_api">
776 <title>DVB Frontend legacy API (a. k. a. DVBv3)</title>
777 <para>The usage of this API is deprecated, as it doesn't support all digital
778     TV standards, doesn't provide good statistics measurements and provides
779     incomplete information. This is kept only to support legacy applications.</para>
780
781 &sub-frontend_legacy_api;
782 </section>