aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook/media/dvb/frontend.xml
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/DocBook/media/dvb/frontend.xml')
-rw-r--r--Documentation/DocBook/media/dvb/frontend.xml1515
1 files changed, 1515 insertions, 0 deletions
diff --git a/Documentation/DocBook/media/dvb/frontend.xml b/Documentation/DocBook/media/dvb/frontend.xml
new file mode 100644
index 000000000000..61407eaba020
--- /dev/null
+++ b/Documentation/DocBook/media/dvb/frontend.xml
@@ -0,0 +1,1515 @@
1<title>DVB Frontend API</title>
2
3<para>The DVB frontend device controls the tuner and DVB demodulator
4hardware. It can be accessed through <emphasis
5role="tt">/dev/dvb/adapter0/frontend0</emphasis>. Data types and and
6ioctl definitions can be accessed by including <emphasis
7role="tt">linux/dvb/frontend.h</emphasis> in your application.</para>
8
9<para>DVB frontends come in three varieties: DVB-S (satellite), DVB-C
10(cable) and DVB-T (terrestrial). Transmission via the internet (DVB-IP)
11is not yet handled by this API but a future extension is possible. For
12DVB-S the frontend device also supports satellite equipment control
13(SEC) via DiSEqC and V-SEC protocols. The DiSEqC (digital SEC)
14specification is available from
15<ulink url="http://www.eutelsat.com/satellites/4_5_5.html">Eutelsat</ulink>.</para>
16
17<para>Note that the DVB API may also be used for MPEG decoder-only PCI
18cards, in which case there exists no frontend device.</para>
19
20<section id="frontend_types">
21<title>Frontend Data Types</title>
22
23<section id="fe-type-t">
24<title>Frontend type</title>
25
26<para>For historical reasons, frontend types are named by the type of modulation used in
27transmission. The fontend types are given by fe_type_t type, defined as:</para>
28
29<table pgwide="1" frame="none" id="fe-type">
30<title>Frontend types</title>
31<tgroup cols="3">
32 &cs-def;
33 <thead>
34 <row>
35 <entry>fe_type</entry>
36 <entry>Description</entry>
37 <entry><link linkend="DTV-DELIVERY-SYSTEM">DTV_DELIVERY_SYSTEM</link> equivalent type</entry>
38 </row>
39 </thead>
40 <tbody valign="top">
41 <row>
42 <entry id="FE_QPSK"><constant>FE_QPSK</constant></entry>
43 <entry>For DVB-S standard</entry>
44 <entry><constant>SYS_DVBS</constant></entry>
45 </row>
46 <row>
47 <entry id="FE_QAM"><constant>FE_QAM</constant></entry>
48 <entry>For DVB-C annex A/C standard</entry>
49 <entry><constant>SYS_DVBC_ANNEX_AC</constant></entry>
50 </row>
51 <row>
52 <entry id="FE_OFDM"><constant>FE_OFDM</constant></entry>
53 <entry>For DVB-T standard</entry>
54 <entry><constant>SYS_DVBT</constant></entry>
55 </row>
56 <row>
57 <entry id="FE_ATSC"><constant>FE_ATSC</constant></entry>
58 <entry>For ATSC standard (terrestrial) or for DVB-C Annex B (cable) used in US.</entry>
59 <entry><constant>SYS_ATSC</constant> (terrestrial) or <constant>SYS_DVBC_ANNEX_B</constant> (cable)</entry>
60 </row>
61</tbody></tgroup></table>
62
63<para>Newer formats like DVB-S2, ISDB-T, ISDB-S and DVB-T2 are not described at the above, as they're
64supported via the new <link linkend="FE_GET_SET_PROPERTY">FE_GET_PROPERTY/FE_GET_SET_PROPERTY</link> ioctl's, using the <link linkend="DTV-DELIVERY-SYSTEM">DTV_DELIVERY_SYSTEM</link> parameter.
65</para>
66</section>
67
68<section id="fe-caps-t">
69<title>frontend capabilities</title>
70
71<para>Capabilities describe what a frontend can do. Some capabilities can only be supported for
72a specific frontend type.</para>
73<programlisting>
74 typedef enum fe_caps {
75 FE_IS_STUPID = 0,
76 FE_CAN_INVERSION_AUTO = 0x1,
77 FE_CAN_FEC_1_2 = 0x2,
78 FE_CAN_FEC_2_3 = 0x4,
79 FE_CAN_FEC_3_4 = 0x8,
80 FE_CAN_FEC_4_5 = 0x10,
81 FE_CAN_FEC_5_6 = 0x20,
82 FE_CAN_FEC_6_7 = 0x40,
83 FE_CAN_FEC_7_8 = 0x80,
84 FE_CAN_FEC_8_9 = 0x100,
85 FE_CAN_FEC_AUTO = 0x200,
86 FE_CAN_QPSK = 0x400,
87 FE_CAN_QAM_16 = 0x800,
88 FE_CAN_QAM_32 = 0x1000,
89 FE_CAN_QAM_64 = 0x2000,
90 FE_CAN_QAM_128 = 0x4000,
91 FE_CAN_QAM_256 = 0x8000,
92 FE_CAN_QAM_AUTO = 0x10000,
93 FE_CAN_TRANSMISSION_MODE_AUTO = 0x20000,
94 FE_CAN_BANDWIDTH_AUTO = 0x40000,
95 FE_CAN_GUARD_INTERVAL_AUTO = 0x80000,
96 FE_CAN_HIERARCHY_AUTO = 0x100000,
97 FE_CAN_8VSB = 0x200000,
98 FE_CAN_16VSB = 0x400000,
99 FE_HAS_EXTENDED_CAPS = 0x800000,
100 FE_CAN_TURBO_FEC = 0x8000000,
101 FE_CAN_2G_MODULATION = 0x10000000,
102 FE_NEEDS_BENDING = 0x20000000,
103 FE_CAN_RECOVER = 0x40000000,
104 FE_CAN_MUTE_TS = 0x80000000
105 } fe_caps_t;
106</programlisting>
107</section>
108
109<section id="dvb-frontend-info">
110<title>frontend information</title>
111
112<para>Information about the frontend ca be queried with
113 <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
114
115<programlisting>
116 struct dvb_frontend_info {
117 char name[128];
118 fe_type_t type;
119 uint32_t frequency_min;
120 uint32_t frequency_max;
121 uint32_t frequency_stepsize;
122 uint32_t frequency_tolerance;
123 uint32_t symbol_rate_min;
124 uint32_t symbol_rate_max;
125 uint32_t symbol_rate_tolerance; /&#x22C6; ppm &#x22C6;/
126 uint32_t notifier_delay; /&#x22C6; ms &#x22C6;/
127 fe_caps_t caps;
128 };
129</programlisting>
130</section>
131
132<section id="dvb-diseqc-master-cmd">
133<title>diseqc master command</title>
134
135<para>A message sent from the frontend to DiSEqC capable equipment.</para>
136<programlisting>
137 struct dvb_diseqc_master_cmd {
138 uint8_t msg [6]; /&#x22C6; { framing, address, command, data[3] } &#x22C6;/
139 uint8_t msg_len; /&#x22C6; valid values are 3...6 &#x22C6;/
140 };
141</programlisting>
142</section>
143<section role="subsection" id="dvb-diseqc-slave-reply">
144<title>diseqc slave reply</title>
145
146<para>A reply to the frontend from DiSEqC 2.0 capable equipment.</para>
147<programlisting>
148 struct dvb_diseqc_slave_reply {
149 uint8_t msg [4]; /&#x22C6; { framing, data [3] } &#x22C6;/
150 uint8_t msg_len; /&#x22C6; valid values are 0...4, 0 means no msg &#x22C6;/
151 int timeout; /&#x22C6; return from ioctl after timeout ms with &#x22C6;/
152 }; /&#x22C6; errorcode when no message was received &#x22C6;/
153</programlisting>
154</section>
155
156<section id="fe-sec-voltage-t">
157<title>diseqc slave reply</title>
158<para>The voltage is usually used with non-DiSEqC capable LNBs to switch the polarzation
159(horizontal/vertical). When using DiSEqC epuipment this voltage has to be switched
160consistently to the DiSEqC commands as described in the DiSEqC spec.</para>
161<programlisting>
162 typedef enum fe_sec_voltage {
163 SEC_VOLTAGE_13,
164 SEC_VOLTAGE_18
165 } fe_sec_voltage_t;
166</programlisting>
167</section>
168
169<section id="fe-sec-tone-mode-t">
170<title>SEC continuous tone</title>
171
172<para>The continuous 22KHz tone is usually used with non-DiSEqC capable LNBs to switch the
173high/low band of a dual-band LNB. When using DiSEqC epuipment this voltage has to
174be switched consistently to the DiSEqC commands as described in the DiSEqC
175spec.</para>
176<programlisting>
177 typedef enum fe_sec_tone_mode {
178 SEC_TONE_ON,
179 SEC_TONE_OFF
180 } fe_sec_tone_mode_t;
181</programlisting>
182</section>
183
184<section id="fe-sec-mini-cmd-t">
185<title>SEC tone burst</title>
186
187<para>The 22KHz tone burst is usually used with non-DiSEqC capable switches to select
188between two connected LNBs/satellites. When using DiSEqC epuipment this voltage has to
189be switched consistently to the DiSEqC commands as described in the DiSEqC
190spec.</para>
191<programlisting>
192 typedef enum fe_sec_mini_cmd {
193 SEC_MINI_A,
194 SEC_MINI_B
195 } fe_sec_mini_cmd_t;
196</programlisting>
197
198<para></para>
199</section>
200
201<section id="fe-status-t">
202<title>frontend status</title>
203<para>Several functions of the frontend device use the fe_status data type defined
204by</para>
205<programlisting>
206 typedef enum fe_status {
207 FE_HAS_SIGNAL = 0x01, /&#x22C6; found something above the noise level &#x22C6;/
208 FE_HAS_CARRIER = 0x02, /&#x22C6; found a DVB signal &#x22C6;/
209 FE_HAS_VITERBI = 0x04, /&#x22C6; FEC is stable &#x22C6;/
210 FE_HAS_SYNC = 0x08, /&#x22C6; found sync bytes &#x22C6;/
211 FE_HAS_LOCK = 0x10, /&#x22C6; everything's working... &#x22C6;/
212 FE_TIMEDOUT = 0x20, /&#x22C6; no lock within the last ~2 seconds &#x22C6;/
213 FE_REINIT = 0x40 /&#x22C6; frontend was reinitialized, &#x22C6;/
214 } fe_status_t; /&#x22C6; application is recommned to reset &#x22C6;/
215</programlisting>
216<para>to indicate the current state and/or state changes of the frontend hardware.
217</para>
218
219</section>
220
221<section id="dvb-frontend-parameters">
222<title>frontend parameters</title>
223<para>The kind of parameters passed to the frontend device for tuning depend on
224the kind of hardware you are using.</para>
225<para>The struct <constant>dvb_frontend_parameters</constant> uses an
226union with specific per-system parameters. However, as newer delivery systems
227required more data, the structure size weren't enough to fit, and just
228extending its size would break the existing applications. So, those parameters
229were replaced by the usage of <link linkend="FE_GET_SET_PROPERTY">
230<constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> ioctl's. The
231new API is flexible enough to add new parameters to existing delivery systems,
232and to add newer delivery systems.</para>
233<para>So, newer applications should use <link linkend="FE_GET_SET_PROPERTY">
234<constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> instead, in
235order to be able to support the newer System Delivery like DVB-S2, DVB-T2,
236DVB-C2, ISDB, etc.</para>
237<para>All kinds of parameters are combined as an union in the FrontendParameters structure:</para>
238<programlisting>
239struct dvb_frontend_parameters {
240 uint32_t frequency; /&#x22C6; (absolute) frequency in Hz for QAM/OFDM &#x22C6;/
241 /&#x22C6; intermediate frequency in kHz for QPSK &#x22C6;/
242 fe_spectral_inversion_t inversion;
243 union {
244 struct dvb_qpsk_parameters qpsk;
245 struct dvb_qam_parameters qam;
246 struct dvb_ofdm_parameters ofdm;
247 struct dvb_vsb_parameters vsb;
248 } u;
249};
250</programlisting>
251<para>In the case of QPSK frontends the <constant>frequency</constant> field specifies the intermediate
252frequency, i.e. the offset which is effectively added to the local oscillator frequency (LOF) of
253the LNB. The intermediate frequency has to be specified in units of kHz. For QAM and
254OFDM frontends the <constant>frequency</constant> specifies the absolute frequency and is given in Hz.
255</para>
256<section id="dvb-qpsk-parameters">
257<title>QPSK parameters</title>
258<para>For satellite QPSK frontends you have to use the <constant>dvb_qpsk_parameters</constant> structure:</para>
259<programlisting>
260 struct dvb_qpsk_parameters {
261 uint32_t symbol_rate; /&#x22C6; symbol rate in Symbols per second &#x22C6;/
262 fe_code_rate_t fec_inner; /&#x22C6; forward error correction (see above) &#x22C6;/
263 };
264</programlisting>
265</section>
266<section id="dvb-qam-parameters">
267<title>QAM parameters</title>
268<para>for cable QAM frontend you use the <constant>dvb_qam_parameters</constant> structure:</para>
269<programlisting>
270 struct dvb_qam_parameters {
271 uint32_t symbol_rate; /&#x22C6; symbol rate in Symbols per second &#x22C6;/
272 fe_code_rate_t fec_inner; /&#x22C6; forward error correction (see above) &#x22C6;/
273 fe_modulation_t modulation; /&#x22C6; modulation type (see above) &#x22C6;/
274 };
275</programlisting>
276</section>
277<section id="dvb-vsb-parameters">
278<title>VSB parameters</title>
279<para>ATSC frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para>
280<programlisting>
281struct dvb_vsb_parameters {
282 fe_modulation_t modulation; /&#x22C6; modulation type (see above) &#x22C6;/
283};
284</programlisting>
285</section>
286<section id="dvb-ofdm-parameters">
287<title>OFDM parameters</title>
288<para>DVB-T frontends are supported by the <constant>dvb_ofdm_parameters</constant> structure:</para>
289<programlisting>
290 struct dvb_ofdm_parameters {
291 fe_bandwidth_t bandwidth;
292 fe_code_rate_t code_rate_HP; /&#x22C6; high priority stream code rate &#x22C6;/
293 fe_code_rate_t code_rate_LP; /&#x22C6; low priority stream code rate &#x22C6;/
294 fe_modulation_t constellation; /&#x22C6; modulation type (see above) &#x22C6;/
295 fe_transmit_mode_t transmission_mode;
296 fe_guard_interval_t guard_interval;
297 fe_hierarchy_t hierarchy_information;
298 };
299</programlisting>
300</section>
301<section id="fe-spectral-inversion-t">
302<title>frontend spectral inversion</title>
303<para>The Inversion field can take one of these values:
304</para>
305<programlisting>
306typedef enum fe_spectral_inversion {
307 INVERSION_OFF,
308 INVERSION_ON,
309 INVERSION_AUTO
310} fe_spectral_inversion_t;
311</programlisting>
312<para>It indicates if spectral inversion should be presumed or not. In the automatic setting
313(<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by
314itself.
315</para>
316</section>
317<section id="fe-code-rate-t">
318<title>frontend code rate</title>
319<para>The possible values for the <constant>fec_inner</constant> field used on
320<link refend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and
321<link refend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are:
322</para>
323<programlisting>
324typedef enum fe_code_rate {
325 FEC_NONE = 0,
326 FEC_1_2,
327 FEC_2_3,
328 FEC_3_4,
329 FEC_4_5,
330 FEC_5_6,
331 FEC_6_7,
332 FEC_7_8,
333 FEC_8_9,
334 FEC_AUTO,
335 FEC_3_5,
336 FEC_9_10,
337} fe_code_rate_t;
338</programlisting>
339<para>which correspond to error correction rates of 1/2, 2/3, etc., no error correction or auto
340detection.
341</para>
342</section>
343<section id="fe-modulation-t">
344<title>frontend modulation type for QAM, OFDM and VSB</title>
345<para>For cable and terrestrial frontends, e. g. for
346<link refend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>,
347<link refend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and
348<link refend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>,
349it needs to specify the quadrature modulation mode which can be one of the following:
350</para>
351<programlisting>
352 typedef enum fe_modulation {
353 QPSK,
354 QAM_16,
355 QAM_32,
356 QAM_64,
357 QAM_128,
358 QAM_256,
359 QAM_AUTO,
360 VSB_8,
361 VSB_16,
362 PSK_8,
363 APSK_16,
364 APSK_32,
365 DQPSK,
366 } fe_modulation_t;
367</programlisting>
368</section>
369<para>Finally, there are several more parameters for OFDM:
370</para>
371<section id="fe-transmit-mode-t">
372<title>Number of carriers per channel</title>
373<programlisting>
374typedef enum fe_transmit_mode {
375 TRANSMISSION_MODE_2K,
376 TRANSMISSION_MODE_8K,
377 TRANSMISSION_MODE_AUTO,
378 TRANSMISSION_MODE_4K,
379 TRANSMISSION_MODE_1K,
380 TRANSMISSION_MODE_16K,
381 TRANSMISSION_MODE_32K,
382 } fe_transmit_mode_t;
383</programlisting>
384</section>
385<section id="fe-bandwidth-t">
386<title>frontend bandwidth</title>
387<programlisting>
388typedef enum fe_bandwidth {
389 BANDWIDTH_8_MHZ,
390 BANDWIDTH_7_MHZ,
391 BANDWIDTH_6_MHZ,
392 BANDWIDTH_AUTO,
393 BANDWIDTH_5_MHZ,
394 BANDWIDTH_10_MHZ,
395 BANDWIDTH_1_712_MHZ,
396} fe_bandwidth_t;
397</programlisting>
398</section>
399<section id="fe-guard-interval-t">
400<title>frontend guard inverval</title>
401<programlisting>
402typedef enum fe_guard_interval {
403 GUARD_INTERVAL_1_32,
404 GUARD_INTERVAL_1_16,
405 GUARD_INTERVAL_1_8,
406 GUARD_INTERVAL_1_4,
407 GUARD_INTERVAL_AUTO,
408 GUARD_INTERVAL_1_128,
409 GUARD_INTERVAL_19_128,
410 GUARD_INTERVAL_19_256,
411} fe_guard_interval_t;
412</programlisting>
413</section>
414<section id="fe-hierarchy-t">
415<title>frontend hierarchy</title>
416<programlisting>
417typedef enum fe_hierarchy {
418 HIERARCHY_NONE,
419 HIERARCHY_1,
420 HIERARCHY_2,
421 HIERARCHY_4,
422 HIERARCHY_AUTO
423 } fe_hierarchy_t;
424</programlisting>
425</section>
426
427</section>
428
429<section id="dvb-frontend-event">
430<title>frontend events</title>
431 <programlisting>
432 struct dvb_frontend_event {
433 fe_status_t status;
434 struct dvb_frontend_parameters parameters;
435 };
436</programlisting>
437 </section>
438</section>
439
440
441<section id="frontend_fcalls">
442<title>Frontend Function Calls</title>
443
444<section id="frontend_f_open">
445<title>open()</title>
446<para>DESCRIPTION</para>
447<informaltable><tgroup cols="1"><tbody><row>
448<entry align="char">
449<para>This system call opens a named frontend device (/dev/dvb/adapter0/frontend0)
450 for subsequent use. Usually the first thing to do after a successful open is to
451 find out the frontend type with <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
452<para>The device can be opened in read-only mode, which only allows monitoring of
453 device status and statistics, or read/write mode, which allows any kind of use
454 (e.g. performing tuning operations.)
455</para>
456<para>In a system with multiple front-ends, it is usually the case that multiple devices
457 cannot be open in read/write mode simultaneously. As long as a front-end
458 device is opened in read/write mode, other open() calls in read/write mode will
459 either fail or block, depending on whether non-blocking or blocking mode was
460 specified. A front-end device opened in blocking mode can later be put into
461 non-blocking mode (and vice versa) using the F_SETFL command of the fcntl
462 system call. This is a standard system call, documented in the Linux manual
463 page for fcntl. When an open() call has succeeded, the device will be ready
464 for use in the specified mode. This implies that the corresponding hardware is
465 powered up, and that other front-ends may have been powered down to make
466 that possible.</para>
467</entry>
468 </row></tbody></tgroup></informaltable>
469
470<para>SYNOPSIS</para>
471<informaltable><tgroup cols="1"><tbody><row><entry
472 align="char">
473<para>int open(const char &#x22C6;deviceName, int flags);</para>
474</entry>
475 </row></tbody></tgroup></informaltable>
476<para>PARAMETERS
477</para>
478<informaltable><tgroup cols="2"><tbody><row><entry
479 align="char">
480<para>const char
481 *deviceName</para>
482</entry><entry
483 align="char">
484<para>Name of specific video device.</para>
485</entry>
486 </row><row><entry
487 align="char">
488<para>int flags</para>
489</entry><entry
490 align="char">
491<para>A bit-wise OR of the following flags:</para>
492</entry>
493 </row><row><entry
494 align="char">
495</entry><entry
496 align="char">
497<para>O_RDONLY read-only access</para>
498</entry>
499 </row><row><entry
500 align="char">
501</entry><entry
502 align="char">
503<para>O_RDWR read/write access</para>
504</entry>
505 </row><row><entry
506 align="char">
507</entry><entry
508 align="char">
509<para>O_NONBLOCK open in non-blocking mode</para>
510</entry>
511 </row><row><entry
512 align="char">
513</entry><entry
514 align="char">
515<para>(blocking mode is the default)</para>
516</entry>
517 </row></tbody></tgroup></informaltable>
518<para>RETURN VALUE</para>
519<informaltable><tgroup cols="2"><tbody><row><entry
520 align="char">
521<para>ENODEV</para>
522</entry><entry
523 align="char">
524<para>Device driver not loaded/available.</para>
525</entry>
526 </row><row><entry
527 align="char">
528<para>EINTERNAL</para>
529</entry><entry
530 align="char">
531<para>Internal error.</para>
532</entry>
533 </row><row><entry
534 align="char">
535<para>EBUSY</para>
536</entry><entry
537 align="char">
538<para>Device or resource busy.</para>
539</entry>
540 </row><row><entry
541 align="char">
542<para>EINVAL</para>
543</entry><entry
544 align="char">
545<para>Invalid argument.</para>
546</entry>
547 </row></tbody></tgroup></informaltable>
548</section>
549
550<section id="frontend_f_close">
551<title>close()</title>
552<para>DESCRIPTION
553</para>
554<informaltable><tgroup cols="1"><tbody><row><entry
555 align="char">
556<para>This system call closes a previously opened front-end device. After closing
557 a front-end device, its corresponding hardware might be powered down
558 automatically.</para>
559</entry>
560 </row></tbody></tgroup></informaltable>
561<para>SYNOPSIS
562</para>
563<informaltable><tgroup cols="1"><tbody><row><entry
564 align="char">
565<para>int close(int fd);</para>
566</entry>
567 </row></tbody></tgroup></informaltable>
568<para>PARAMETERS
569</para>
570<informaltable><tgroup cols="2"><tbody><row><entry
571 align="char">
572<para>int fd</para>
573</entry><entry
574 align="char">
575<para>File descriptor returned by a previous call to open().</para>
576</entry>
577 </row></tbody></tgroup></informaltable>
578<para>RETURN VALUE</para>
579<informaltable><tgroup cols="2"><tbody><row><entry
580 align="char">
581<para>EBADF</para>
582</entry><entry
583 align="char">
584<para>fd is not a valid open file descriptor.</para>
585</entry>
586 </row></tbody></tgroup></informaltable>
587</section>
588
589<section id="FE_READ_STATUS">
590<title>FE_READ_STATUS</title>
591<para>DESCRIPTION
592</para>
593<informaltable><tgroup cols="1"><tbody><row><entry
594 align="char">
595<para>This ioctl call returns status information about the front-end. This call only
596 requires read-only access to the device.</para>
597</entry>
598 </row></tbody></tgroup></informaltable>
599<para>SYNOPSIS
600</para>
601<informaltable><tgroup cols="1"><tbody><row><entry
602 align="char">
603<para>int ioctl(int fd, int request = <link linkend="FE_READ_STATUS">FE_READ_STATUS</link>,
604 fe_status_t &#x22C6;status);</para>
605</entry>
606 </row></tbody></tgroup></informaltable>
607<para>PARAMETERS
608</para>
609
610<informaltable><tgroup cols="2"><tbody><row><entry
611 align="char">
612<para>int fd</para>
613</entry><entry
614 align="char">
615<para>File descriptor returned by a previous call to open().</para>
616</entry>
617 </row><row><entry
618 align="char">
619<para>int request</para>
620</entry><entry
621 align="char">
622<para>Equals <link linkend="FE_READ_STATUS">FE_READ_STATUS</link> for this command.</para>
623</entry>
624 </row><row><entry
625 align="char">
626<para>struct fe_status_t
627 *status</para>
628</entry><entry
629 align="char">
630<para>Points to the location where the front-end status word is
631 to be stored.</para>
632</entry>
633 </row></tbody></tgroup></informaltable>
634<para>RETURN VALUE</para>
635<informaltable><tgroup cols="2"><tbody><row><entry
636 align="char">
637<para>EBADF</para>
638</entry><entry
639 align="char">
640<para>fd is not a valid open file descriptor.</para>
641</entry>
642 </row><row><entry
643 align="char">
644<para>EFAULT</para>
645</entry><entry
646 align="char">
647<para>status points to invalid address.</para>
648</entry>
649 </row></tbody></tgroup></informaltable>
650</section>
651
652<section id="FE_READ_BER">
653<title>FE_READ_BER</title>
654<para>DESCRIPTION
655</para>
656<informaltable><tgroup cols="1"><tbody><row><entry
657 align="char">
658<para>This ioctl call returns the bit error rate for the signal currently
659 received/demodulated by the front-end. For this command, read-only access to
660 the device is sufficient.</para>
661</entry>
662 </row></tbody></tgroup></informaltable>
663<para>SYNOPSIS
664</para>
665<informaltable><tgroup cols="1"><tbody><row><entry
666 align="char">
667<para>int ioctl(int fd, int request = <link linkend="FE_READ_BER">FE_READ_BER</link>,
668 uint32_t &#x22C6;ber);</para>
669</entry>
670 </row></tbody></tgroup></informaltable>
671<para>PARAMETERS
672</para>
673<informaltable><tgroup cols="2"><tbody><row><entry
674 align="char">
675<para>int fd</para>
676</entry><entry
677 align="char">
678<para>File descriptor returned by a previous call to open().</para>
679</entry>
680 </row><row><entry
681 align="char">
682<para>int request</para>
683</entry><entry
684 align="char">
685<para>Equals <link linkend="FE_READ_BER">FE_READ_BER</link> for this command.</para>
686</entry>
687 </row><row><entry
688 align="char">
689<para>uint32_t *ber</para>
690</entry><entry
691 align="char">
692<para>The bit error rate is stored into *ber.</para>
693</entry>
694 </row></tbody></tgroup></informaltable>
695
696&return-value-dvb;
697</section>
698
699<section id="FE_READ_SNR">
700<title>FE_READ_SNR</title>
701
702<para>DESCRIPTION
703</para>
704<informaltable><tgroup cols="1"><tbody><row><entry
705 align="char">
706<para>This ioctl call returns the signal-to-noise ratio for the signal currently received
707 by the front-end. For this command, read-only access to the device is sufficient.</para>
708</entry>
709 </row></tbody></tgroup></informaltable>
710<para>SYNOPSIS
711</para>
712<informaltable><tgroup cols="1"><tbody><row><entry
713 align="char">
714<para>int ioctl(int fd, int request = <link linkend="FE_READ_SNR">FE_READ_SNR</link>, int16_t
715 &#x22C6;snr);</para>
716</entry>
717 </row></tbody></tgroup></informaltable>
718<para>PARAMETERS
719</para>
720<informaltable><tgroup cols="2"><tbody><row><entry
721 align="char">
722<para>int fd</para>
723</entry><entry
724 align="char">
725<para>File descriptor returned by a previous call to open().</para>
726</entry>
727 </row><row><entry
728 align="char">
729<para>int request</para>
730</entry><entry
731 align="char">
732<para>Equals <link linkend="FE_READ_SNR">FE_READ_SNR</link> for this command.</para>
733</entry>
734 </row><row><entry
735 align="char">
736<para>int16_t *snr</para>
737</entry><entry
738 align="char">
739<para>The signal-to-noise ratio is stored into *snr.</para>
740</entry>
741 </row></tbody></tgroup></informaltable>
742
743&return-value-dvb;
744</section>
745
746<section id="FE_READ_SIGNAL_STRENGTH">
747<title>FE_READ_SIGNAL_STRENGTH</title>
748<para>DESCRIPTION
749</para>
750<informaltable><tgroup cols="1"><tbody><row><entry
751 align="char">
752<para>This ioctl call returns the signal strength value for the signal currently received
753 by the front-end. For this command, read-only access to the device is sufficient.</para>
754</entry>
755 </row></tbody></tgroup></informaltable>
756<para>SYNOPSIS
757</para>
758<informaltable><tgroup cols="1"><tbody><row><entry
759 align="char">
760<para>int ioctl( int fd, int request =
761 <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link>, int16_t &#x22C6;strength);</para>
762</entry>
763 </row></tbody></tgroup></informaltable>
764
765<para>PARAMETERS
766</para>
767<informaltable><tgroup cols="2"><tbody><row><entry
768 align="char">
769<para>int fd</para>
770</entry><entry
771 align="char">
772<para>File descriptor returned by a previous call to open().</para>
773</entry>
774 </row><row><entry
775 align="char">
776<para>int request</para>
777</entry><entry
778 align="char">
779<para>Equals <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link> for this
780 command.</para>
781</entry>
782 </row><row><entry
783 align="char">
784<para>int16_t *strength</para>
785</entry><entry
786 align="char">
787<para>The signal strength value is stored into *strength.</para>
788</entry>
789 </row></tbody></tgroup></informaltable>
790
791&return-value-dvb;
792</section>
793
794<section id="FE_READ_UNCORRECTED_BLOCKS">
795<title>FE_READ_UNCORRECTED_BLOCKS</title>
796<para>DESCRIPTION
797</para>
798<informaltable><tgroup cols="1"><tbody><row><entry
799 align="char">
800<para>This ioctl call returns the number of uncorrected blocks detected by the device
801 driver during its lifetime. For meaningful measurements, the increment in block
802 count during a specific time interval should be calculated. For this command,
803 read-only access to the device is sufficient.</para>
804</entry>
805 </row><row><entry
806 align="char">
807<para>Note that the counter will wrap to zero after its maximum count has been
808 reached.</para>
809</entry>
810 </row></tbody></tgroup></informaltable>
811<para>SYNOPSIS
812</para>
813<informaltable><tgroup cols="1"><tbody><row><entry
814 align="char">
815<para>int ioctl( int fd, int request =
816 <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link>, uint32_t &#x22C6;ublocks);</para>
817</entry>
818 </row></tbody></tgroup></informaltable>
819<para>PARAMETERS
820</para>
821<informaltable><tgroup cols="2"><tbody><row><entry
822 align="char">
823<para>int fd</para>
824</entry><entry
825 align="char">
826<para>File descriptor returned by a previous call to open().</para>
827</entry>
828 </row><row><entry
829 align="char">
830<para>int request</para>
831</entry><entry
832 align="char">
833<para>Equals <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link> for this
834 command.</para>
835</entry>
836 </row><row><entry
837 align="char">
838<para>uint32_t *ublocks</para>
839</entry><entry
840 align="char">
841<para>The total number of uncorrected blocks seen by the driver
842 so far.</para>
843</entry>
844 </row></tbody></tgroup></informaltable>
845
846&return-value-dvb;
847</section>
848
849<section id="FE_SET_FRONTEND">
850<title>FE_SET_FRONTEND</title>
851<para>DESCRIPTION
852</para>
853<informaltable><tgroup cols="1"><tbody><row><entry
854 align="char">
855<para>This ioctl call starts a tuning operation using specified parameters. The result
856 of this call will be successful if the parameters were valid and the tuning could
857 be initiated. The result of the tuning operation in itself, however, will arrive
858 asynchronously as an event (see documentation for <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> and
859 FrontendEvent.) If a new <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> operation is initiated before
860 the previous one was completed, the previous operation will be aborted in favor
861 of the new one. This command requires read/write access to the device.</para>
862</entry>
863 </row></tbody></tgroup></informaltable>
864
865<para>SYNOPSIS
866</para>
867<informaltable><tgroup cols="1"><tbody><row><entry
868 align="char">
869<para>int ioctl(int fd, int request = <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link>,
870 struct dvb_frontend_parameters &#x22C6;p);</para>
871</entry>
872 </row></tbody></tgroup></informaltable>
873<para>PARAMETERS
874</para>
875<informaltable><tgroup cols="2"><tbody><row><entry
876 align="char">
877<para>int fd</para>
878</entry><entry
879 align="char">
880<para>File descriptor returned by a previous call to open().</para>
881</entry>
882 </row><row><entry
883 align="char">
884<para>int request</para>
885</entry><entry
886 align="char">
887<para>Equals <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> for this command.</para>
888</entry>
889 </row><row><entry
890 align="char">
891<para>struct
892 dvb_frontend_parameters
893 *p</para>
894</entry><entry
895 align="char">
896<para>Points to parameters for tuning operation.</para>
897</entry>
898 </row></tbody></tgroup></informaltable>
899
900&return-value-dvb;
901<informaltable><tgroup cols="2"><tbody><row><entry
902 align="char">
903<para>EINVAL</para>
904</entry><entry
905 align="char">
906<para>Maximum supported symbol rate reached.</para>
907</entry>
908</row></tbody></tgroup></informaltable>
909</section>
910
911<section id="FE_GET_FRONTEND">
912<title>FE_GET_FRONTEND</title>
913<para>DESCRIPTION
914</para>
915<informaltable><tgroup cols="1"><tbody><row><entry
916 align="char">
917<para>This ioctl call queries the currently effective frontend parameters. For this
918 command, read-only access to the device is sufficient.</para>
919</entry>
920 </row></tbody></tgroup></informaltable>
921
922<para>SYNOPSIS
923</para>
924<informaltable><tgroup cols="1"><tbody><row><entry
925 align="char">
926<para>int ioctl(int fd, int request = <link linkend="FE_GET_FRONTEND">FE_GET_FRONTEND</link>,
927 struct dvb_frontend_parameters &#x22C6;p);</para>
928</entry>
929 </row></tbody></tgroup></informaltable>
930
931<para>PARAMETERS
932</para>
933<informaltable><tgroup cols="2"><tbody><row><entry
934 align="char">
935<para>int fd</para>
936</entry><entry
937 align="char">
938<para>File descriptor returned by a previous call to open().</para>
939</entry>
940 </row><row><entry
941 align="char">
942<para>int request</para>
943</entry><entry
944 align="char">
945<para>Equals <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> for this command.</para>
946</entry>
947 </row><row><entry
948 align="char">
949<para>struct
950 dvb_frontend_parameters
951 *p</para>
952</entry><entry
953 align="char">
954<para>Points to parameters for tuning operation.</para>
955</entry>
956 </row></tbody></tgroup></informaltable>
957
958&return-value-dvb;
959<informaltable><tgroup cols="2"><tbody><row><entry
960 align="char">
961<para>EINVAL</para>
962</entry><entry
963 align="char">
964<para>Maximum supported symbol rate reached.</para>
965</entry>
966 </row></tbody></tgroup></informaltable>
967
968</section>
969
970<section id="FE_GET_EVENT">
971<title>FE_GET_EVENT</title>
972<para>DESCRIPTION
973</para>
974<informaltable><tgroup cols="1"><tbody><row><entry
975 align="char">
976<para>This ioctl call returns a frontend event if available. If an event is not
977 available, the behavior depends on whether the device is in blocking or
978 non-blocking mode. In the latter case, the call fails immediately with errno
979 set to EWOULDBLOCK. In the former case, the call blocks until an event
980 becomes available.</para>
981</entry>
982 </row><row><entry
983 align="char">
984<para>The standard Linux poll() and/or select() system calls can be used with the
985 device file descriptor to watch for new events. For select(), the file descriptor
986 should be included in the exceptfds argument, and for poll(), POLLPRI should
987 be specified as the wake-up condition. Since the event queue allocated is
988 rather small (room for 8 events), the queue must be serviced regularly to avoid
989 overflow. If an overflow happens, the oldest event is discarded from the queue,
990 and an error (EOVERFLOW) occurs the next time the queue is read. After
991 reporting the error condition in this fashion, subsequent
992 <link linkend="FE_GET_EVENT">FE_GET_EVENT</link>
993 calls will return events from the queue as usual.</para>
994</entry>
995 </row><row><entry
996 align="char">
997<para>For the sake of implementation simplicity, this command requires read/write
998 access to the device.</para>
999</entry>
1000 </row></tbody></tgroup></informaltable>
1001
1002<para>SYNOPSIS
1003</para>
1004<informaltable><tgroup cols="1"><tbody><row><entry
1005 align="char">
1006<para>int ioctl(int fd, int request = QPSK_GET_EVENT,
1007 struct dvb_frontend_event &#x22C6;ev);</para>
1008</entry>
1009 </row></tbody></tgroup></informaltable>
1010
1011<para>PARAMETERS
1012</para>
1013<informaltable><tgroup cols="2"><tbody><row><entry
1014 align="char">
1015<para>int fd</para>
1016</entry><entry
1017 align="char">
1018<para>File descriptor returned by a previous call to open().</para>
1019</entry>
1020 </row><row><entry
1021 align="char">
1022<para>int request</para>
1023</entry><entry
1024 align="char">
1025<para>Equals <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> for this command.</para>
1026</entry>
1027 </row><row><entry
1028 align="char">
1029<para>struct
1030 dvb_frontend_event
1031 *ev</para>
1032</entry><entry
1033 align="char">
1034<para>Points to the location where the event,</para>
1035</entry>
1036 </row><row><entry
1037 align="char">
1038</entry><entry
1039 align="char">
1040<para>if any, is to be stored.</para>
1041</entry>
1042 </row></tbody></tgroup></informaltable>
1043
1044&return-value-dvb;
1045<informaltable><tgroup cols="2"><tbody><row><entry
1046 align="char">
1047<para>EWOULDBLOCK</para>
1048</entry><entry
1049 align="char">
1050<para>There is no event pending, and the device is in
1051 non-blocking mode.</para>
1052</entry>
1053 </row><row><entry
1054 align="char">
1055<para>EOVERFLOW</para>
1056</entry><entry
1057 align="char">
1058<para>Overflow in event queue - one or more events were lost.</para>
1059</entry>
1060</row></tbody></tgroup></informaltable>
1061</section>
1062
1063<section id="FE_GET_INFO">
1064<title>FE_GET_INFO</title>
1065<para>DESCRIPTION
1066</para>
1067<informaltable><tgroup cols="1"><tbody><row><entry
1068 align="char">
1069<para>This ioctl call returns information about the front-end. This call only requires
1070 read-only access to the device.</para>
1071</entry>
1072 </row></tbody></tgroup></informaltable>
1073<para>SYNOPSIS
1074</para>
1075
1076<informaltable><tgroup cols="1"><tbody><row><entry
1077 align="char">
1078<para> int ioctl(int fd, int request = <link linkend="FE_GET_INFO">FE_GET_INFO</link>, struct
1079 dvb_frontend_info &#x22C6;info);</para>
1080</entry>
1081 </row></tbody></tgroup></informaltable>
1082<para>PARAMETERS
1083</para>
1084
1085<informaltable><tgroup cols="2"><tbody><row><entry
1086 align="char">
1087<para>int fd</para>
1088</entry><entry
1089 align="char">
1090<para>File descriptor returned by a previous call to open().</para>
1091</entry>
1092 </row><row><entry
1093 align="char">
1094<para>int request</para>
1095</entry><entry
1096 align="char">
1097<para>Equals <link linkend="FE_GET_INFO">FE_GET_INFO</link> for this command.</para>
1098</entry>
1099 </row><row><entry
1100 align="char">
1101<para>struct
1102 dvb_frontend_info
1103 *info</para>
1104</entry><entry
1105 align="char">
1106<para>Points to the location where the front-end information is
1107 to be stored.</para>
1108</entry>
1109 </row></tbody></tgroup></informaltable>
1110&return-value-dvb;
1111</section>
1112
1113<section id="FE_DISEQC_RESET_OVERLOAD">
1114<title>FE_DISEQC_RESET_OVERLOAD</title>
1115<para>DESCRIPTION
1116</para>
1117<informaltable><tgroup cols="1"><tbody><row><entry
1118 align="char">
1119<para>If the bus has been automatically powered off due to power overload, this ioctl
1120 call restores the power to the bus. The call requires read/write access to the
1121 device. This call has no effect if the device is manually powered off. Not all
1122 DVB adapters support this ioctl.</para>
1123</entry>
1124 </row></tbody></tgroup></informaltable>
1125
1126<para>SYNOPSIS
1127</para>
1128<informaltable><tgroup cols="1"><tbody><row><entry
1129 align="char">
1130<para>int ioctl(int fd, int request =
1131 <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>);</para>
1132</entry>
1133 </row></tbody></tgroup></informaltable>
1134<para>PARAMETERS
1135</para>
1136<informaltable><tgroup cols="2"><tbody><row><entry
1137 align="char">
1138<para>int fd</para>
1139</entry><entry
1140 align="char">
1141<para>File descriptor returned by a previous call to open().</para>
1142</entry>
1143 </row><row><entry
1144 align="char">
1145<para>int request</para>
1146</entry><entry
1147 align="char">
1148<para>Equals <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> for this
1149 command.</para>
1150</entry>
1151 </row></tbody></tgroup></informaltable>
1152
1153&return-value-dvb;
1154</section>
1155
1156<section id="FE_DISEQC_SEND_MASTER_CMD">
1157<title>FE_DISEQC_SEND_MASTER_CMD</title>
1158<para>DESCRIPTION
1159</para>
1160<informaltable><tgroup cols="1"><tbody><row><entry
1161 align="char">
1162<para>This ioctl call is used to send a a DiSEqC command.</para>
1163</entry>
1164 </row></tbody></tgroup></informaltable>
1165<para>SYNOPSIS
1166</para>
1167<informaltable><tgroup cols="1"><tbody><row><entry
1168 align="char">
1169<para>int ioctl(int fd, int request =
1170 <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link>, struct
1171 dvb_diseqc_master_cmd &#x22C6;cmd);</para>
1172</entry>
1173 </row></tbody></tgroup></informaltable>
1174
1175<para>PARAMETERS
1176</para>
1177<informaltable><tgroup cols="2"><tbody><row><entry
1178 align="char">
1179<para>int fd</para>
1180</entry><entry
1181 align="char">
1182<para>File descriptor returned by a previous call to open().</para>
1183</entry>
1184 </row><row><entry
1185 align="char">
1186<para>int request</para>
1187</entry><entry
1188 align="char">
1189<para>Equals <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link> for this
1190 command.</para>
1191</entry>
1192 </row><row><entry
1193 align="char">
1194<para>struct
1195 dvb_diseqc_master_cmd
1196 *cmd</para>
1197</entry><entry
1198 align="char">
1199<para>Pointer to the command to be transmitted.</para>
1200</entry>
1201 </row></tbody></tgroup></informaltable>
1202
1203&return-value-dvb;
1204</section>
1205
1206<section id="FE_DISEQC_RECV_SLAVE_REPLY">
1207<title>FE_DISEQC_RECV_SLAVE_REPLY</title>
1208<para>DESCRIPTION
1209</para>
1210<informaltable><tgroup cols="1"><tbody><row><entry
1211 align="char">
1212<para>This ioctl call is used to receive reply to a DiSEqC 2.0 command.</para>
1213</entry>
1214 </row></tbody></tgroup></informaltable>
1215
1216<para>SYNOPSIS
1217</para>
1218<informaltable><tgroup cols="1"><tbody><row><entry
1219 align="char">
1220<para>int ioctl(int fd, int request =
1221 <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link>, struct
1222 dvb_diseqc_slave_reply &#x22C6;reply);</para>
1223</entry>
1224 </row></tbody></tgroup></informaltable>
1225
1226<para>PARAMETERS
1227</para>
1228<informaltable><tgroup cols="2"><tbody><row><entry
1229 align="char">
1230<para>int fd</para>
1231</entry><entry
1232 align="char">
1233<para>File descriptor returned by a previous call to open().</para>
1234</entry>
1235 </row><row><entry
1236 align="char">
1237<para>int request</para>
1238</entry><entry
1239 align="char">
1240<para>Equals <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link> for this
1241 command.</para>
1242</entry>
1243 </row><row><entry
1244 align="char">
1245<para>struct
1246 dvb_diseqc_slave_reply
1247 *reply</para>
1248</entry><entry
1249 align="char">
1250<para>Pointer to the command to be received.</para>
1251</entry>
1252 </row></tbody></tgroup></informaltable>
1253&return-value-dvb;
1254</section>
1255
1256<section id="FE_DISEQC_SEND_BURST">
1257<title>FE_DISEQC_SEND_BURST</title>
1258<para>DESCRIPTION
1259</para>
1260<informaltable><tgroup cols="1"><tbody><row><entry
1261 align="char">
1262<para>This ioctl call is used to send a 22KHz tone burst.</para>
1263</entry>
1264 </row></tbody></tgroup></informaltable>
1265
1266<para>SYNOPSIS
1267</para>
1268<informaltable><tgroup cols="1"><tbody><row><entry
1269 align="char">
1270<para>int ioctl(int fd, int request =
1271 <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link>, fe_sec_mini_cmd_t burst);</para>
1272</entry>
1273 </row></tbody></tgroup></informaltable>
1274
1275<para>PARAMETERS
1276</para>
1277<informaltable><tgroup cols="2"><tbody><row><entry
1278 align="char">
1279<para>int fd</para>
1280</entry><entry
1281 align="char">
1282<para>File descriptor returned by a previous call to open().</para>
1283</entry>
1284 </row><row><entry
1285 align="char">
1286<para>int request</para>
1287</entry><entry
1288 align="char">
1289<para>Equals <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link> for this command.</para>
1290</entry>
1291 </row><row><entry
1292 align="char">
1293<para>fe_sec_mini_cmd_t
1294 burst</para>
1295</entry><entry
1296 align="char">
1297<para>burst A or B.</para>
1298</entry>
1299 </row></tbody></tgroup></informaltable>
1300
1301&return-value-dvb;
1302</section>
1303
1304<section id="FE_SET_TONE">
1305<title>FE_SET_TONE</title>
1306<para>DESCRIPTION
1307</para>
1308<informaltable><tgroup cols="1"><tbody><row><entry
1309 align="char">
1310<para>This call is used to set the generation of the continuous 22kHz tone. This call
1311 requires read/write permissions.</para>
1312</entry>
1313 </row></tbody></tgroup></informaltable>
1314<para>SYNOPSIS
1315</para>
1316<informaltable><tgroup cols="1"><tbody><row><entry
1317 align="char">
1318<para>int ioctl(int fd, int request = <link linkend="FE_SET_TONE">FE_SET_TONE</link>,
1319 fe_sec_tone_mode_t tone);</para>
1320</entry>
1321 </row></tbody></tgroup></informaltable>
1322<para>PARAMETERS
1323</para>
1324<informaltable><tgroup cols="2"><tbody><row><entry
1325 align="char">
1326<para>int fd</para>
1327</entry><entry
1328 align="char">
1329<para>File descriptor returned by a previous call to open().</para>
1330</entry>
1331 </row><row><entry
1332 align="char">
1333<para>int request</para>
1334</entry><entry
1335 align="char">
1336<para>Equals <link linkend="FE_SET_TONE">FE_SET_TONE</link> for this command.</para>
1337</entry>
1338 </row><row><entry
1339 align="char">
1340<para>fe_sec_tone_mode_t
1341 tone</para>
1342</entry><entry
1343 align="char">
1344<para>The requested tone generation mode (on/off).</para>
1345</entry>
1346 </row></tbody></tgroup></informaltable>
1347&return-value-dvb;
1348</section>
1349
1350<section id="FE_SET_VOLTAGE">
1351<title>FE_SET_VOLTAGE</title>
1352<para>DESCRIPTION
1353</para>
1354<informaltable><tgroup cols="1"><tbody><row><entry
1355 align="char">
1356<para>This call is used to set the bus voltage. This call requires read/write
1357 permissions.</para>
1358</entry>
1359 </row></tbody></tgroup></informaltable>
1360<para>SYNOPSIS
1361</para>
1362<informaltable><tgroup cols="1"><tbody><row><entry
1363 align="char">
1364<para>int ioctl(int fd, int request = <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link>,
1365 fe_sec_voltage_t voltage);</para>
1366</entry>
1367 </row></tbody></tgroup></informaltable>
1368
1369<para>PARAMETERS
1370</para>
1371<informaltable><tgroup cols="2"><tbody><row><entry
1372 align="char">
1373<para>int fd</para>
1374</entry><entry
1375 align="char">
1376<para>File descriptor returned by a previous call to open().</para>
1377</entry>
1378 </row><row><entry
1379 align="char">
1380<para>int request</para>
1381</entry><entry
1382 align="char">
1383<para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
1384</entry>
1385 </row><row><entry
1386 align="char">
1387<para>fe_sec_voltage_t
1388 voltage</para>
1389</entry><entry
1390 align="char">
1391<para>The requested bus voltage.</para>
1392</entry>
1393 </row></tbody></tgroup></informaltable>
1394
1395&return-value-dvb;
1396</section>
1397
1398<section id="FE_ENABLE_HIGH_LNB_VOLTAGE">
1399<title>FE_ENABLE_HIGH_LNB_VOLTAGE</title>
1400<para>DESCRIPTION
1401</para>
1402<informaltable><tgroup cols="1"><tbody><row><entry
1403 align="char">
1404<para>If high != 0 enables slightly higher voltages instead of 13/18V (to compensate
1405 for long cables). This call requires read/write permissions. Not all DVB
1406 adapters support this ioctl.</para>
1407</entry>
1408 </row></tbody></tgroup></informaltable>
1409
1410<para>SYNOPSIS
1411</para>
1412<informaltable><tgroup cols="1"><tbody><row><entry
1413 align="char">
1414<para>int ioctl(int fd, int request =
1415 <link linkend="FE_ENABLE_HIGH_LNB_VOLTAGE">FE_ENABLE_HIGH_LNB_VOLTAGE</link>, int high);</para>
1416</entry>
1417 </row></tbody></tgroup></informaltable>
1418
1419<para>PARAMETERS
1420</para>
1421<informaltable><tgroup cols="2"><tbody><row><entry
1422 align="char">
1423<para>int fd</para>
1424</entry><entry
1425 align="char">
1426<para>File descriptor returned by a previous call to open().</para>
1427</entry>
1428 </row><row><entry
1429 align="char">
1430<para>int request</para>
1431</entry><entry
1432 align="char">
1433<para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
1434</entry>
1435 </row><row><entry
1436 align="char">
1437<para>int high</para>
1438</entry><entry
1439 align="char">
1440<para>The requested bus voltage.</para>
1441</entry>
1442 </row></tbody></tgroup></informaltable>
1443
1444&return-value-dvb;
1445</section>
1446
1447<section id="FE_SET_FRONTEND_TUNE_MODE">
1448<title>FE_SET_FRONTEND_TUNE_MODE</title>
1449<para>DESCRIPTION</para>
1450<informaltable><tgroup cols="1"><tbody><row>
1451<entry align="char">
1452<para>Allow setting tuner mode flags to the frontend.</para>
1453</entry>
1454</row></tbody></tgroup></informaltable>
1455
1456<para>SYNOPSIS</para>
1457<informaltable><tgroup cols="1"><tbody><row>
1458<entry align="char">
1459<para>int ioctl(int fd, int request =
1460<link linkend="FE_SET_FRONTEND_TUNE_MODE">FE_SET_FRONTEND_TUNE_MODE</link>, unsigned int flags);</para>
1461</entry>
1462</row></tbody></tgroup></informaltable>
1463
1464<para>PARAMETERS</para>
1465<informaltable><tgroup cols="2"><tbody><row>
1466<entry align="char">
1467 <para>unsigned int flags</para>
1468</entry>
1469<entry align="char">
1470<para>
1471FE_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.
1472</para>
1473</entry>
1474 </row></tbody></tgroup></informaltable>
1475
1476&return-value-dvb;
1477</section>
1478
1479<section id="FE_DISHNETWORK_SEND_LEGACY_CMD">
1480 <title>FE_DISHNETWORK_SEND_LEGACY_CMD</title>
1481<para>DESCRIPTION</para>
1482<informaltable><tgroup cols="1"><tbody><row>
1483<entry align="char">
1484<para>WARNING: This is a very obscure legacy command, used only at stv0299 driver. Should not be used on newer drivers.</para>
1485<para>It provides a non-standard method for selecting Diseqc voltage on the frontend, for Dish Network legacy switches.</para>
1486<para>As support for this ioctl were added in 2004, this means that such dishes were already legacy in 2004.</para>
1487</entry>
1488</row></tbody></tgroup></informaltable>
1489
1490<para>SYNOPSIS</para>
1491<informaltable><tgroup cols="1"><tbody><row>
1492<entry align="char">
1493<para>int ioctl(int fd, int request =
1494 <link linkend="FE_DISHNETWORK_SEND_LEGACY_CMD">FE_DISHNETWORK_SEND_LEGACY_CMD</link>, unsigned long cmd);</para>
1495</entry>
1496</row></tbody></tgroup></informaltable>
1497
1498<para>PARAMETERS</para>
1499<informaltable><tgroup cols="2"><tbody><row>
1500<entry align="char">
1501 <para>unsigned long cmd</para>
1502</entry>
1503<entry align="char">
1504<para>
1505sends the specified raw cmd to the dish via DISEqC.
1506</para>
1507</entry>
1508 </row></tbody></tgroup></informaltable>
1509
1510&return-value-dvb;
1511</section>
1512
1513</section>
1514
1515&sub-dvbproperty;
generated by cgit v1.2.2 (git 2.25.0) at 2024-11-29 12:45:53 -0500