blob: aeaed59d0f1f5d3d9baeff4af53eb803a7b50355 [file] [log] [blame]
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001<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)
Mauro Carvalho Chehab62b122a2009-09-15 21:03:45 -030014specification is available from
15<ulink url="http://www.eutelsat.com/satellites/4_5_5.html">Eutelsat</ulink>.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030016
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
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030023<section id="fe-type-t">
24<title>Frontend type</title>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030025
Mauro Carvalho Chehab0969ec12011-06-07 17:02:37 -030026<para>For historical reasons, frontend types are named by the type of modulation used in
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030027transmission. The fontend types are given by fe_type_t type, defined as:</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030028
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030029<table pgwide="1" frame="none" id="fe-type">
30<title>Frontend types</title>
Mauro Carvalho Chehab0969ec12011-06-07 17:02:37 -030031<tgroup cols="3">
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030032 &cs-def;
33 <thead>
34 <row>
35 <entry>fe_type</entry>
36 <entry>Description</entry>
Mauro Carvalho Chehab0969ec12011-06-07 17:02:37 -030037 <entry><link linkend="DTV-DELIVERY-SYSTEM">DTV_DELIVERY_SYSTEM</link> equivalent type</entry>
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030038 </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>
Mauro Carvalho Chehab0969ec12011-06-07 17:02:37 -030044 <entry><constant>SYS_DVBS</constant></entry>
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030045 </row>
46 <row>
47 <entry id="FE_QAM"><constant>FE_QAM</constant></entry>
Mauro Carvalho Chehab669a4ba2011-12-17 20:36:56 -030048 <entry>For DVB-C annex A standard</entry>
49 <entry><constant>SYS_DVBC_ANNEX_A</constant></entry>
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030050 </row>
51 <row>
52 <entry id="FE_OFDM"><constant>FE_OFDM</constant></entry>
Mauro Carvalho Chehab0969ec12011-06-07 17:02:37 -030053 <entry>For DVB-T standard</entry>
54 <entry><constant>SYS_DVBT</constant></entry>
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030055 </row>
56 <row>
57 <entry id="FE_ATSC"><constant>FE_ATSC</constant></entry>
Mauro Carvalho Chehab0969ec12011-06-07 17:02:37 -030058 <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>
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030060 </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
Mauro Carvalho Chehab0969ec12011-06-07 17:02:37 -030064supported 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.
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -030065</para>
Mauro Carvalho Chehabcd7d4942012-01-01 16:11:17 -030066
67<para>The usage of this field is deprecated, as it doesn't report all supported standards, and
68will provide an incomplete information for frontends that support multiple delivery systems.
69Please use <link linkend="DTV_ENUM_DELSYS">DTV_ENUM_DELSYS</link> instead.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030070</section>
71
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -030072<section id="fe-caps-t">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030073<title>frontend capabilities</title>
74
75<para>Capabilities describe what a frontend can do. Some capabilities can only be supported for
76a specific frontend type.</para>
77<programlisting>
78 typedef enum fe_caps {
79 FE_IS_STUPID = 0,
80 FE_CAN_INVERSION_AUTO = 0x1,
81 FE_CAN_FEC_1_2 = 0x2,
82 FE_CAN_FEC_2_3 = 0x4,
83 FE_CAN_FEC_3_4 = 0x8,
84 FE_CAN_FEC_4_5 = 0x10,
85 FE_CAN_FEC_5_6 = 0x20,
86 FE_CAN_FEC_6_7 = 0x40,
87 FE_CAN_FEC_7_8 = 0x80,
88 FE_CAN_FEC_8_9 = 0x100,
89 FE_CAN_FEC_AUTO = 0x200,
90 FE_CAN_QPSK = 0x400,
91 FE_CAN_QAM_16 = 0x800,
92 FE_CAN_QAM_32 = 0x1000,
93 FE_CAN_QAM_64 = 0x2000,
94 FE_CAN_QAM_128 = 0x4000,
95 FE_CAN_QAM_256 = 0x8000,
96 FE_CAN_QAM_AUTO = 0x10000,
97 FE_CAN_TRANSMISSION_MODE_AUTO = 0x20000,
98 FE_CAN_BANDWIDTH_AUTO = 0x40000,
99 FE_CAN_GUARD_INTERVAL_AUTO = 0x80000,
100 FE_CAN_HIERARCHY_AUTO = 0x100000,
Mauro Carvalho Chehab8d3557e2010-07-03 17:39:17 -0300101 FE_CAN_8VSB = 0x200000,
102 FE_CAN_16VSB = 0x400000,
103 FE_HAS_EXTENDED_CAPS = 0x800000,
104 FE_CAN_TURBO_FEC = 0x8000000,
105 FE_CAN_2G_MODULATION = 0x10000000,
106 FE_NEEDS_BENDING = 0x20000000,
107 FE_CAN_RECOVER = 0x40000000,
108 FE_CAN_MUTE_TS = 0x80000000
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300109 } fe_caps_t;
110</programlisting>
111</section>
112
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300113<section id="dvb-frontend-info">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300114<title>frontend information</title>
115
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300116<para>Information about the frontend ca be queried with
117 <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300118
119<programlisting>
120 struct dvb_frontend_info {
121 char name[128];
122 fe_type_t type;
123 uint32_t frequency_min;
124 uint32_t frequency_max;
125 uint32_t frequency_stepsize;
126 uint32_t frequency_tolerance;
127 uint32_t symbol_rate_min;
128 uint32_t symbol_rate_max;
129 uint32_t symbol_rate_tolerance; /&#x22C6; ppm &#x22C6;/
130 uint32_t notifier_delay; /&#x22C6; ms &#x22C6;/
131 fe_caps_t caps;
132 };
133</programlisting>
134</section>
135
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300136<section id="dvb-diseqc-master-cmd">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300137<title>diseqc master command</title>
138
139<para>A message sent from the frontend to DiSEqC capable equipment.</para>
140<programlisting>
141 struct dvb_diseqc_master_cmd {
142 uint8_t msg [6]; /&#x22C6; { framing, address, command, data[3] } &#x22C6;/
143 uint8_t msg_len; /&#x22C6; valid values are 3...6 &#x22C6;/
144 };
145</programlisting>
146</section>
Mauro Carvalho Chehab3272c3e2011-06-07 21:40:22 -0300147<section role="subsection" id="dvb-diseqc-slave-reply">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300148<title>diseqc slave reply</title>
149
150<para>A reply to the frontend from DiSEqC 2.0 capable equipment.</para>
151<programlisting>
152 struct dvb_diseqc_slave_reply {
153 uint8_t msg [4]; /&#x22C6; { framing, data [3] } &#x22C6;/
154 uint8_t msg_len; /&#x22C6; valid values are 0...4, 0 means no msg &#x22C6;/
155 int timeout; /&#x22C6; return from ioctl after timeout ms with &#x22C6;/
156 }; /&#x22C6; errorcode when no message was received &#x22C6;/
157</programlisting>
158</section>
159
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300160<section id="fe-sec-voltage-t">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300161<title>diseqc slave reply</title>
162<para>The voltage is usually used with non-DiSEqC capable LNBs to switch the polarzation
163(horizontal/vertical). When using DiSEqC epuipment this voltage has to be switched
164consistently to the DiSEqC commands as described in the DiSEqC spec.</para>
165<programlisting>
166 typedef enum fe_sec_voltage {
167 SEC_VOLTAGE_13,
168 SEC_VOLTAGE_18
169 } fe_sec_voltage_t;
170</programlisting>
171</section>
172
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300173<section id="fe-sec-tone-mode-t">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300174<title>SEC continuous tone</title>
175
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300176<para>The continuous 22KHz tone is usually used with non-DiSEqC capable LNBs to switch the
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300177high/low band of a dual-band LNB. When using DiSEqC epuipment this voltage has to
178be switched consistently to the DiSEqC commands as described in the DiSEqC
179spec.</para>
180<programlisting>
181 typedef enum fe_sec_tone_mode {
182 SEC_TONE_ON,
183 SEC_TONE_OFF
184 } fe_sec_tone_mode_t;
185</programlisting>
186</section>
187
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300188<section id="fe-sec-mini-cmd-t">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300189<title>SEC tone burst</title>
190
191<para>The 22KHz tone burst is usually used with non-DiSEqC capable switches to select
192between two connected LNBs/satellites. When using DiSEqC epuipment this voltage has to
193be switched consistently to the DiSEqC commands as described in the DiSEqC
194spec.</para>
195<programlisting>
196 typedef enum fe_sec_mini_cmd {
197 SEC_MINI_A,
198 SEC_MINI_B
199 } fe_sec_mini_cmd_t;
200</programlisting>
201
202<para></para>
203</section>
204
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300205<section id="fe-status-t">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300206<title>frontend status</title>
207<para>Several functions of the frontend device use the fe_status data type defined
208by</para>
209<programlisting>
210 typedef enum fe_status {
211 FE_HAS_SIGNAL = 0x01, /&#x22C6; found something above the noise level &#x22C6;/
212 FE_HAS_CARRIER = 0x02, /&#x22C6; found a DVB signal &#x22C6;/
213 FE_HAS_VITERBI = 0x04, /&#x22C6; FEC is stable &#x22C6;/
214 FE_HAS_SYNC = 0x08, /&#x22C6; found sync bytes &#x22C6;/
215 FE_HAS_LOCK = 0x10, /&#x22C6; everything's working... &#x22C6;/
216 FE_TIMEDOUT = 0x20, /&#x22C6; no lock within the last ~2 seconds &#x22C6;/
217 FE_REINIT = 0x40 /&#x22C6; frontend was reinitialized, &#x22C6;/
218 } fe_status_t; /&#x22C6; application is recommned to reset &#x22C6;/
219</programlisting>
220<para>to indicate the current state and/or state changes of the frontend hardware.
221</para>
222
223</section>
224
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300225<section id="dvb-frontend-parameters">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300226<title>frontend parameters</title>
227<para>The kind of parameters passed to the frontend device for tuning depend on
Mauro Carvalho Chehabdf2692a2011-06-07 20:43:25 -0300228the kind of hardware you are using.</para>
229<para>The struct <constant>dvb_frontend_parameters</constant> uses an
230union with specific per-system parameters. However, as newer delivery systems
231required more data, the structure size weren't enough to fit, and just
232extending its size would break the existing applications. So, those parameters
233were replaced by the usage of <link linkend="FE_GET_SET_PROPERTY">
234<constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> ioctl's. The
235new API is flexible enough to add new parameters to existing delivery systems,
236and to add newer delivery systems.</para>
237<para>So, newer applications should use <link linkend="FE_GET_SET_PROPERTY">
238<constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> instead, in
239order to be able to support the newer System Delivery like DVB-S2, DVB-T2,
240DVB-C2, ISDB, etc.</para>
241<para>All kinds of parameters are combined as an union in the FrontendParameters structure:</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300242<programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300243struct dvb_frontend_parameters {
244 uint32_t frequency; /&#x22C6; (absolute) frequency in Hz for QAM/OFDM &#x22C6;/
245 /&#x22C6; intermediate frequency in kHz for QPSK &#x22C6;/
246 fe_spectral_inversion_t inversion;
247 union {
248 struct dvb_qpsk_parameters qpsk;
249 struct dvb_qam_parameters qam;
250 struct dvb_ofdm_parameters ofdm;
251 struct dvb_vsb_parameters vsb;
252 } u;
253};
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300254</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300255<para>In the case of QPSK frontends the <constant>frequency</constant> field specifies the intermediate
256frequency, i.e. the offset which is effectively added to the local oscillator frequency (LOF) of
257the LNB. The intermediate frequency has to be specified in units of kHz. For QAM and
258OFDM frontends the <constant>frequency</constant> specifies the absolute frequency and is given in Hz.
259</para>
260<section id="dvb-qpsk-parameters">
261<title>QPSK parameters</title>
262<para>For satellite QPSK frontends you have to use the <constant>dvb_qpsk_parameters</constant> structure:</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300263<programlisting>
264 struct dvb_qpsk_parameters {
265 uint32_t symbol_rate; /&#x22C6; symbol rate in Symbols per second &#x22C6;/
266 fe_code_rate_t fec_inner; /&#x22C6; forward error correction (see above) &#x22C6;/
267 };
268</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300269</section>
270<section id="dvb-qam-parameters">
271<title>QAM parameters</title>
272<para>for cable QAM frontend you use the <constant>dvb_qam_parameters</constant> structure:</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300273<programlisting>
274 struct dvb_qam_parameters {
275 uint32_t symbol_rate; /&#x22C6; symbol rate in Symbols per second &#x22C6;/
276 fe_code_rate_t fec_inner; /&#x22C6; forward error correction (see above) &#x22C6;/
277 fe_modulation_t modulation; /&#x22C6; modulation type (see above) &#x22C6;/
278 };
279</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300280</section>
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300281<section id="dvb-vsb-parameters">
282<title>VSB parameters</title>
Mauro Carvalho Chehab76f9a692011-06-07 22:08:13 -0300283<para>ATSC frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para>
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300284<programlisting>
285struct dvb_vsb_parameters {
286 fe_modulation_t modulation; /&#x22C6; modulation type (see above) &#x22C6;/
287};
288</programlisting>
289</section>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300290<section id="dvb-ofdm-parameters">
291<title>OFDM parameters</title>
292<para>DVB-T frontends are supported by the <constant>dvb_ofdm_parameters</constant> structure:</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300293<programlisting>
294 struct dvb_ofdm_parameters {
295 fe_bandwidth_t bandwidth;
296 fe_code_rate_t code_rate_HP; /&#x22C6; high priority stream code rate &#x22C6;/
297 fe_code_rate_t code_rate_LP; /&#x22C6; low priority stream code rate &#x22C6;/
298 fe_modulation_t constellation; /&#x22C6; modulation type (see above) &#x22C6;/
299 fe_transmit_mode_t transmission_mode;
300 fe_guard_interval_t guard_interval;
301 fe_hierarchy_t hierarchy_information;
302 };
303</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300304</section>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300305<section id="fe-spectral-inversion-t">
306<title>frontend spectral inversion</title>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300307<para>The Inversion field can take one of these values:
308</para>
309<programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300310typedef enum fe_spectral_inversion {
311 INVERSION_OFF,
312 INVERSION_ON,
313 INVERSION_AUTO
314} fe_spectral_inversion_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300315</programlisting>
316<para>It indicates if spectral inversion should be presumed or not. In the automatic setting
317(<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by
318itself.
319</para>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300320</section>
321<section id="fe-code-rate-t">
322<title>frontend code rate</title>
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300323<para>The possible values for the <constant>fec_inner</constant> field used on
324<link refend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and
325<link refend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are:
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300326</para>
327<programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300328typedef enum fe_code_rate {
329 FEC_NONE = 0,
330 FEC_1_2,
331 FEC_2_3,
332 FEC_3_4,
333 FEC_4_5,
334 FEC_5_6,
335 FEC_6_7,
336 FEC_7_8,
337 FEC_8_9,
338 FEC_AUTO,
339 FEC_3_5,
340 FEC_9_10,
341} fe_code_rate_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300342</programlisting>
343<para>which correspond to error correction rates of 1/2, 2/3, etc., no error correction or auto
344detection.
345</para>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300346</section>
347<section id="fe-modulation-t">
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300348<title>frontend modulation type for QAM, OFDM and VSB</title>
349<para>For cable and terrestrial frontends, e. g. for
350<link refend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>,
351<link refend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and
352<link refend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>,
353it needs to specify the quadrature modulation mode which can be one of the following:
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300354</para>
355<programlisting>
356 typedef enum fe_modulation {
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300357 QPSK,
358 QAM_16,
359 QAM_32,
360 QAM_64,
361 QAM_128,
362 QAM_256,
363 QAM_AUTO,
364 VSB_8,
365 VSB_16,
366 PSK_8,
367 APSK_16,
368 APSK_32,
369 DQPSK,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300370 } fe_modulation_t;
371</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300372</section>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300373<para>Finally, there are several more parameters for OFDM:
374</para>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300375<section id="fe-transmit-mode-t">
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300376<title>Number of carriers per channel</title>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300377<programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300378typedef enum fe_transmit_mode {
379 TRANSMISSION_MODE_2K,
380 TRANSMISSION_MODE_8K,
381 TRANSMISSION_MODE_AUTO,
382 TRANSMISSION_MODE_4K,
383 TRANSMISSION_MODE_1K,
384 TRANSMISSION_MODE_16K,
385 TRANSMISSION_MODE_32K,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300386 } fe_transmit_mode_t;
387</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300388</section>
389<section id="fe-bandwidth-t">
390<title>frontend bandwidth</title>
391<programlisting>
392typedef enum fe_bandwidth {
393 BANDWIDTH_8_MHZ,
394 BANDWIDTH_7_MHZ,
395 BANDWIDTH_6_MHZ,
396 BANDWIDTH_AUTO,
397 BANDWIDTH_5_MHZ,
398 BANDWIDTH_10_MHZ,
399 BANDWIDTH_1_712_MHZ,
400} fe_bandwidth_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300401</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300402</section>
403<section id="fe-guard-interval-t">
404<title>frontend guard inverval</title>
405<programlisting>
406typedef enum fe_guard_interval {
407 GUARD_INTERVAL_1_32,
408 GUARD_INTERVAL_1_16,
409 GUARD_INTERVAL_1_8,
410 GUARD_INTERVAL_1_4,
411 GUARD_INTERVAL_AUTO,
412 GUARD_INTERVAL_1_128,
413 GUARD_INTERVAL_19_128,
414 GUARD_INTERVAL_19_256,
415} fe_guard_interval_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300416</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300417</section>
418<section id="fe-hierarchy-t">
419<title>frontend hierarchy</title>
420<programlisting>
421typedef enum fe_hierarchy {
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300422 HIERARCHY_NONE,
423 HIERARCHY_1,
424 HIERARCHY_2,
425 HIERARCHY_4,
426 HIERARCHY_AUTO
427 } fe_hierarchy_t;
428</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300429</section>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300430
431</section>
432
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300433<section id="dvb-frontend-event">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300434<title>frontend events</title>
435 <programlisting>
436 struct dvb_frontend_event {
437 fe_status_t status;
438 struct dvb_frontend_parameters parameters;
439 };
440</programlisting>
441 </section>
442</section>
443
444
445<section id="frontend_fcalls">
446<title>Frontend Function Calls</title>
447
448<section id="frontend_f_open">
449<title>open()</title>
450<para>DESCRIPTION</para>
451<informaltable><tgroup cols="1"><tbody><row>
452<entry align="char">
453<para>This system call opens a named frontend device (/dev/dvb/adapter0/frontend0)
454 for subsequent use. Usually the first thing to do after a successful open is to
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300455 find out the frontend type with <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300456<para>The device can be opened in read-only mode, which only allows monitoring of
457 device status and statistics, or read/write mode, which allows any kind of use
458 (e.g. performing tuning operations.)
459</para>
460<para>In a system with multiple front-ends, it is usually the case that multiple devices
461 cannot be open in read/write mode simultaneously. As long as a front-end
462 device is opened in read/write mode, other open() calls in read/write mode will
463 either fail or block, depending on whether non-blocking or blocking mode was
464 specified. A front-end device opened in blocking mode can later be put into
465 non-blocking mode (and vice versa) using the F_SETFL command of the fcntl
466 system call. This is a standard system call, documented in the Linux manual
467 page for fcntl. When an open() call has succeeded, the device will be ready
468 for use in the specified mode. This implies that the corresponding hardware is
469 powered up, and that other front-ends may have been powered down to make
470 that possible.</para>
471</entry>
472 </row></tbody></tgroup></informaltable>
473
474<para>SYNOPSIS</para>
475<informaltable><tgroup cols="1"><tbody><row><entry
476 align="char">
477<para>int open(const char &#x22C6;deviceName, int flags);</para>
478</entry>
479 </row></tbody></tgroup></informaltable>
480<para>PARAMETERS
481</para>
482<informaltable><tgroup cols="2"><tbody><row><entry
483 align="char">
484<para>const char
485 *deviceName</para>
486</entry><entry
487 align="char">
488<para>Name of specific video device.</para>
489</entry>
490 </row><row><entry
491 align="char">
492<para>int flags</para>
493</entry><entry
494 align="char">
495<para>A bit-wise OR of the following flags:</para>
496</entry>
497 </row><row><entry
498 align="char">
499</entry><entry
500 align="char">
501<para>O_RDONLY read-only access</para>
502</entry>
503 </row><row><entry
504 align="char">
505</entry><entry
506 align="char">
507<para>O_RDWR read/write access</para>
508</entry>
509 </row><row><entry
510 align="char">
511</entry><entry
512 align="char">
513<para>O_NONBLOCK open in non-blocking mode</para>
514</entry>
515 </row><row><entry
516 align="char">
517</entry><entry
518 align="char">
519<para>(blocking mode is the default)</para>
520</entry>
521 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300522<para>RETURN VALUE</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300523<informaltable><tgroup cols="2"><tbody><row><entry
524 align="char">
525<para>ENODEV</para>
526</entry><entry
527 align="char">
528<para>Device driver not loaded/available.</para>
529</entry>
530 </row><row><entry
531 align="char">
532<para>EINTERNAL</para>
533</entry><entry
534 align="char">
535<para>Internal error.</para>
536</entry>
537 </row><row><entry
538 align="char">
539<para>EBUSY</para>
540</entry><entry
541 align="char">
542<para>Device or resource busy.</para>
543</entry>
544 </row><row><entry
545 align="char">
546<para>EINVAL</para>
547</entry><entry
548 align="char">
549<para>Invalid argument.</para>
550</entry>
551 </row></tbody></tgroup></informaltable>
552</section>
553
554<section id="frontend_f_close">
555<title>close()</title>
556<para>DESCRIPTION
557</para>
558<informaltable><tgroup cols="1"><tbody><row><entry
559 align="char">
560<para>This system call closes a previously opened front-end device. After closing
561 a front-end device, its corresponding hardware might be powered down
562 automatically.</para>
563</entry>
564 </row></tbody></tgroup></informaltable>
565<para>SYNOPSIS
566</para>
567<informaltable><tgroup cols="1"><tbody><row><entry
568 align="char">
569<para>int close(int fd);</para>
570</entry>
571 </row></tbody></tgroup></informaltable>
572<para>PARAMETERS
573</para>
574<informaltable><tgroup cols="2"><tbody><row><entry
575 align="char">
576<para>int fd</para>
577</entry><entry
578 align="char">
579<para>File descriptor returned by a previous call to open().</para>
580</entry>
581 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300582<para>RETURN VALUE</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300583<informaltable><tgroup cols="2"><tbody><row><entry
584 align="char">
585<para>EBADF</para>
586</entry><entry
587 align="char">
588<para>fd is not a valid open file descriptor.</para>
589</entry>
590 </row></tbody></tgroup></informaltable>
591</section>
592
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300593<section id="FE_READ_STATUS">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300594<title>FE_READ_STATUS</title>
595<para>DESCRIPTION
596</para>
597<informaltable><tgroup cols="1"><tbody><row><entry
598 align="char">
599<para>This ioctl call returns status information about the front-end. This call only
600 requires read-only access to the device.</para>
601</entry>
602 </row></tbody></tgroup></informaltable>
603<para>SYNOPSIS
604</para>
605<informaltable><tgroup cols="1"><tbody><row><entry
606 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300607<para>int ioctl(int fd, int request = <link linkend="FE_READ_STATUS">FE_READ_STATUS</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300608 fe_status_t &#x22C6;status);</para>
609</entry>
610 </row></tbody></tgroup></informaltable>
611<para>PARAMETERS
612</para>
613
614<informaltable><tgroup cols="2"><tbody><row><entry
615 align="char">
616<para>int fd</para>
617</entry><entry
618 align="char">
619<para>File descriptor returned by a previous call to open().</para>
620</entry>
621 </row><row><entry
622 align="char">
623<para>int request</para>
624</entry><entry
625 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300626<para>Equals <link linkend="FE_READ_STATUS">FE_READ_STATUS</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300627</entry>
628 </row><row><entry
629 align="char">
630<para>struct fe_status_t
631 *status</para>
632</entry><entry
633 align="char">
634<para>Points to the location where the front-end status word is
635 to be stored.</para>
636</entry>
637 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300638<para>RETURN VALUE</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300639<informaltable><tgroup cols="2"><tbody><row><entry
640 align="char">
641<para>EBADF</para>
642</entry><entry
643 align="char">
644<para>fd is not a valid open file descriptor.</para>
645</entry>
646 </row><row><entry
647 align="char">
648<para>EFAULT</para>
649</entry><entry
650 align="char">
651<para>status points to invalid address.</para>
652</entry>
653 </row></tbody></tgroup></informaltable>
654</section>
655
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300656<section id="FE_READ_BER">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300657<title>FE_READ_BER</title>
658<para>DESCRIPTION
659</para>
660<informaltable><tgroup cols="1"><tbody><row><entry
661 align="char">
662<para>This ioctl call returns the bit error rate for the signal currently
663 received/demodulated by the front-end. For this command, read-only access to
664 the device is sufficient.</para>
665</entry>
666 </row></tbody></tgroup></informaltable>
667<para>SYNOPSIS
668</para>
669<informaltable><tgroup cols="1"><tbody><row><entry
670 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300671<para>int ioctl(int fd, int request = <link linkend="FE_READ_BER">FE_READ_BER</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300672 uint32_t &#x22C6;ber);</para>
673</entry>
674 </row></tbody></tgroup></informaltable>
675<para>PARAMETERS
676</para>
677<informaltable><tgroup cols="2"><tbody><row><entry
678 align="char">
679<para>int fd</para>
680</entry><entry
681 align="char">
682<para>File descriptor returned by a previous call to open().</para>
683</entry>
684 </row><row><entry
685 align="char">
686<para>int request</para>
687</entry><entry
688 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300689<para>Equals <link linkend="FE_READ_BER">FE_READ_BER</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300690</entry>
691 </row><row><entry
692 align="char">
693<para>uint32_t *ber</para>
694</entry><entry
695 align="char">
696<para>The bit error rate is stored into *ber.</para>
697</entry>
698 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300699
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300700&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300701</section>
702
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300703<section id="FE_READ_SNR">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300704<title>FE_READ_SNR</title>
705
706<para>DESCRIPTION
707</para>
708<informaltable><tgroup cols="1"><tbody><row><entry
709 align="char">
710<para>This ioctl call returns the signal-to-noise ratio for the signal currently received
711 by the front-end. For this command, read-only access to the device is sufficient.</para>
712</entry>
713 </row></tbody></tgroup></informaltable>
714<para>SYNOPSIS
715</para>
716<informaltable><tgroup cols="1"><tbody><row><entry
717 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300718<para>int ioctl(int fd, int request = <link linkend="FE_READ_SNR">FE_READ_SNR</link>, int16_t
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300719 &#x22C6;snr);</para>
720</entry>
721 </row></tbody></tgroup></informaltable>
722<para>PARAMETERS
723</para>
724<informaltable><tgroup cols="2"><tbody><row><entry
725 align="char">
726<para>int fd</para>
727</entry><entry
728 align="char">
729<para>File descriptor returned by a previous call to open().</para>
730</entry>
731 </row><row><entry
732 align="char">
733<para>int request</para>
734</entry><entry
735 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300736<para>Equals <link linkend="FE_READ_SNR">FE_READ_SNR</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300737</entry>
738 </row><row><entry
739 align="char">
740<para>int16_t *snr</para>
741</entry><entry
742 align="char">
743<para>The signal-to-noise ratio is stored into *snr.</para>
744</entry>
745 </row></tbody></tgroup></informaltable>
746
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300747&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300748</section>
749
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300750<section id="FE_READ_SIGNAL_STRENGTH">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300751<title>FE_READ_SIGNAL_STRENGTH</title>
752<para>DESCRIPTION
753</para>
754<informaltable><tgroup cols="1"><tbody><row><entry
755 align="char">
756<para>This ioctl call returns the signal strength value for the signal currently received
757 by the front-end. For this command, read-only access to the device is sufficient.</para>
758</entry>
759 </row></tbody></tgroup></informaltable>
760<para>SYNOPSIS
761</para>
762<informaltable><tgroup cols="1"><tbody><row><entry
763 align="char">
764<para>int ioctl( int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300765 <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link>, int16_t &#x22C6;strength);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300766</entry>
767 </row></tbody></tgroup></informaltable>
768
769<para>PARAMETERS
770</para>
771<informaltable><tgroup cols="2"><tbody><row><entry
772 align="char">
773<para>int fd</para>
774</entry><entry
775 align="char">
776<para>File descriptor returned by a previous call to open().</para>
777</entry>
778 </row><row><entry
779 align="char">
780<para>int request</para>
781</entry><entry
782 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300783<para>Equals <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link> for this
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300784 command.</para>
785</entry>
786 </row><row><entry
787 align="char">
788<para>int16_t *strength</para>
789</entry><entry
790 align="char">
791<para>The signal strength value is stored into *strength.</para>
792</entry>
793 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300794
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300795&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300796</section>
797
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300798<section id="FE_READ_UNCORRECTED_BLOCKS">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300799<title>FE_READ_UNCORRECTED_BLOCKS</title>
800<para>DESCRIPTION
801</para>
802<informaltable><tgroup cols="1"><tbody><row><entry
803 align="char">
804<para>This ioctl call returns the number of uncorrected blocks detected by the device
805 driver during its lifetime. For meaningful measurements, the increment in block
806 count during a specific time interval should be calculated. For this command,
807 read-only access to the device is sufficient.</para>
808</entry>
809 </row><row><entry
810 align="char">
811<para>Note that the counter will wrap to zero after its maximum count has been
812 reached.</para>
813</entry>
814 </row></tbody></tgroup></informaltable>
815<para>SYNOPSIS
816</para>
817<informaltable><tgroup cols="1"><tbody><row><entry
818 align="char">
819<para>int ioctl( int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300820 <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link>, uint32_t &#x22C6;ublocks);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300821</entry>
822 </row></tbody></tgroup></informaltable>
823<para>PARAMETERS
824</para>
825<informaltable><tgroup cols="2"><tbody><row><entry
826 align="char">
827<para>int fd</para>
828</entry><entry
829 align="char">
830<para>File descriptor returned by a previous call to open().</para>
831</entry>
832 </row><row><entry
833 align="char">
834<para>int request</para>
835</entry><entry
836 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300837<para>Equals <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link> for this
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300838 command.</para>
839</entry>
840 </row><row><entry
841 align="char">
842<para>uint32_t *ublocks</para>
843</entry><entry
844 align="char">
845<para>The total number of uncorrected blocks seen by the driver
846 so far.</para>
847</entry>
848 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300849
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300850&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300851</section>
852
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300853<section id="FE_SET_FRONTEND">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300854<title>FE_SET_FRONTEND</title>
855<para>DESCRIPTION
856</para>
857<informaltable><tgroup cols="1"><tbody><row><entry
858 align="char">
859<para>This ioctl call starts a tuning operation using specified parameters. The result
860 of this call will be successful if the parameters were valid and the tuning could
861 be initiated. The result of the tuning operation in itself, however, will arrive
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300862 asynchronously as an event (see documentation for <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> and
863 FrontendEvent.) If a new <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> operation is initiated before
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300864 the previous one was completed, the previous operation will be aborted in favor
865 of the new one. This command requires read/write access to the device.</para>
866</entry>
867 </row></tbody></tgroup></informaltable>
868
869<para>SYNOPSIS
870</para>
871<informaltable><tgroup cols="1"><tbody><row><entry
872 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300873<para>int ioctl(int fd, int request = <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300874 struct dvb_frontend_parameters &#x22C6;p);</para>
875</entry>
876 </row></tbody></tgroup></informaltable>
877<para>PARAMETERS
878</para>
879<informaltable><tgroup cols="2"><tbody><row><entry
880 align="char">
881<para>int fd</para>
882</entry><entry
883 align="char">
884<para>File descriptor returned by a previous call to open().</para>
885</entry>
886 </row><row><entry
887 align="char">
888<para>int request</para>
889</entry><entry
890 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300891<para>Equals <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300892</entry>
893 </row><row><entry
894 align="char">
895<para>struct
896 dvb_frontend_parameters
897 *p</para>
898</entry><entry
899 align="char">
900<para>Points to parameters for tuning operation.</para>
901</entry>
902 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300903
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300904&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300905<informaltable><tgroup cols="2"><tbody><row><entry
906 align="char">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300907<para>EINVAL</para>
908</entry><entry
909 align="char">
910<para>Maximum supported symbol rate reached.</para>
911</entry>
912</row></tbody></tgroup></informaltable>
913</section>
914
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300915<section id="FE_GET_FRONTEND">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300916<title>FE_GET_FRONTEND</title>
917<para>DESCRIPTION
918</para>
919<informaltable><tgroup cols="1"><tbody><row><entry
920 align="char">
921<para>This ioctl call queries the currently effective frontend parameters. For this
922 command, read-only access to the device is sufficient.</para>
923</entry>
924 </row></tbody></tgroup></informaltable>
925
926<para>SYNOPSIS
927</para>
928<informaltable><tgroup cols="1"><tbody><row><entry
929 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300930<para>int ioctl(int fd, int request = <link linkend="FE_GET_FRONTEND">FE_GET_FRONTEND</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300931 struct dvb_frontend_parameters &#x22C6;p);</para>
932</entry>
933 </row></tbody></tgroup></informaltable>
934
935<para>PARAMETERS
936</para>
937<informaltable><tgroup cols="2"><tbody><row><entry
938 align="char">
939<para>int fd</para>
940</entry><entry
941 align="char">
942<para>File descriptor returned by a previous call to open().</para>
943</entry>
944 </row><row><entry
945 align="char">
946<para>int request</para>
947</entry><entry
948 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300949<para>Equals <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300950</entry>
951 </row><row><entry
952 align="char">
953<para>struct
954 dvb_frontend_parameters
955 *p</para>
956</entry><entry
957 align="char">
958<para>Points to parameters for tuning operation.</para>
959</entry>
960 </row></tbody></tgroup></informaltable>
961
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300962&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300963<informaltable><tgroup cols="2"><tbody><row><entry
964 align="char">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300965<para>EINVAL</para>
966</entry><entry
967 align="char">
968<para>Maximum supported symbol rate reached.</para>
969</entry>
970 </row></tbody></tgroup></informaltable>
971
972</section>
973
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300974<section id="FE_GET_EVENT">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300975<title>FE_GET_EVENT</title>
976<para>DESCRIPTION
977</para>
978<informaltable><tgroup cols="1"><tbody><row><entry
979 align="char">
980<para>This ioctl call returns a frontend event if available. If an event is not
981 available, the behavior depends on whether the device is in blocking or
982 non-blocking mode. In the latter case, the call fails immediately with errno
983 set to EWOULDBLOCK. In the former case, the call blocks until an event
984 becomes available.</para>
985</entry>
986 </row><row><entry
987 align="char">
988<para>The standard Linux poll() and/or select() system calls can be used with the
989 device file descriptor to watch for new events. For select(), the file descriptor
990 should be included in the exceptfds argument, and for poll(), POLLPRI should
991 be specified as the wake-up condition. Since the event queue allocated is
992 rather small (room for 8 events), the queue must be serviced regularly to avoid
993 overflow. If an overflow happens, the oldest event is discarded from the queue,
994 and an error (EOVERFLOW) occurs the next time the queue is read. After
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300995 reporting the error condition in this fashion, subsequent
996 <link linkend="FE_GET_EVENT">FE_GET_EVENT</link>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300997 calls will return events from the queue as usual.</para>
998</entry>
999 </row><row><entry
1000 align="char">
1001<para>For the sake of implementation simplicity, this command requires read/write
1002 access to the device.</para>
1003</entry>
1004 </row></tbody></tgroup></informaltable>
1005
1006<para>SYNOPSIS
1007</para>
1008<informaltable><tgroup cols="1"><tbody><row><entry
1009 align="char">
1010<para>int ioctl(int fd, int request = QPSK_GET_EVENT,
1011 struct dvb_frontend_event &#x22C6;ev);</para>
1012</entry>
1013 </row></tbody></tgroup></informaltable>
1014
1015<para>PARAMETERS
1016</para>
1017<informaltable><tgroup cols="2"><tbody><row><entry
1018 align="char">
1019<para>int fd</para>
1020</entry><entry
1021 align="char">
1022<para>File descriptor returned by a previous call to open().</para>
1023</entry>
1024 </row><row><entry
1025 align="char">
1026<para>int request</para>
1027</entry><entry
1028 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001029<para>Equals <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001030</entry>
1031 </row><row><entry
1032 align="char">
1033<para>struct
1034 dvb_frontend_event
1035 *ev</para>
1036</entry><entry
1037 align="char">
1038<para>Points to the location where the event,</para>
1039</entry>
1040 </row><row><entry
1041 align="char">
1042</entry><entry
1043 align="char">
1044<para>if any, is to be stored.</para>
1045</entry>
1046 </row></tbody></tgroup></informaltable>
1047
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001048&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001049<informaltable><tgroup cols="2"><tbody><row><entry
1050 align="char">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001051<para>EWOULDBLOCK</para>
1052</entry><entry
1053 align="char">
1054<para>There is no event pending, and the device is in
1055 non-blocking mode.</para>
1056</entry>
1057 </row><row><entry
1058 align="char">
1059<para>EOVERFLOW</para>
1060</entry><entry
1061 align="char">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001062<para>Overflow in event queue - one or more events were lost.</para>
1063</entry>
1064</row></tbody></tgroup></informaltable>
1065</section>
1066
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001067<section id="FE_GET_INFO">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001068<title>FE_GET_INFO</title>
1069<para>DESCRIPTION
1070</para>
1071<informaltable><tgroup cols="1"><tbody><row><entry
1072 align="char">
1073<para>This ioctl call returns information about the front-end. This call only requires
1074 read-only access to the device.</para>
1075</entry>
1076 </row></tbody></tgroup></informaltable>
1077<para>SYNOPSIS
1078</para>
1079
1080<informaltable><tgroup cols="1"><tbody><row><entry
1081 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001082<para> int ioctl(int fd, int request = <link linkend="FE_GET_INFO">FE_GET_INFO</link>, struct
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001083 dvb_frontend_info &#x22C6;info);</para>
1084</entry>
1085 </row></tbody></tgroup></informaltable>
1086<para>PARAMETERS
1087</para>
1088
1089<informaltable><tgroup cols="2"><tbody><row><entry
1090 align="char">
1091<para>int fd</para>
1092</entry><entry
1093 align="char">
1094<para>File descriptor returned by a previous call to open().</para>
1095</entry>
1096 </row><row><entry
1097 align="char">
1098<para>int request</para>
1099</entry><entry
1100 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001101<para>Equals <link linkend="FE_GET_INFO">FE_GET_INFO</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001102</entry>
1103 </row><row><entry
1104 align="char">
1105<para>struct
1106 dvb_frontend_info
1107 *info</para>
1108</entry><entry
1109 align="char">
1110<para>Points to the location where the front-end information is
1111 to be stored.</para>
1112</entry>
1113 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001114&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001115</section>
1116
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001117<section id="FE_DISEQC_RESET_OVERLOAD">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001118<title>FE_DISEQC_RESET_OVERLOAD</title>
1119<para>DESCRIPTION
1120</para>
1121<informaltable><tgroup cols="1"><tbody><row><entry
1122 align="char">
1123<para>If the bus has been automatically powered off due to power overload, this ioctl
1124 call restores the power to the bus. The call requires read/write access to the
1125 device. This call has no effect if the device is manually powered off. Not all
1126 DVB adapters support this ioctl.</para>
1127</entry>
1128 </row></tbody></tgroup></informaltable>
1129
1130<para>SYNOPSIS
1131</para>
1132<informaltable><tgroup cols="1"><tbody><row><entry
1133 align="char">
1134<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001135 <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001136</entry>
1137 </row></tbody></tgroup></informaltable>
1138<para>PARAMETERS
1139</para>
1140<informaltable><tgroup cols="2"><tbody><row><entry
1141 align="char">
1142<para>int fd</para>
1143</entry><entry
1144 align="char">
1145<para>File descriptor returned by a previous call to open().</para>
1146</entry>
1147 </row><row><entry
1148 align="char">
1149<para>int request</para>
1150</entry><entry
1151 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001152<para>Equals <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> for this
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001153 command.</para>
1154</entry>
1155 </row></tbody></tgroup></informaltable>
1156
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001157&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001158</section>
1159
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001160<section id="FE_DISEQC_SEND_MASTER_CMD">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001161<title>FE_DISEQC_SEND_MASTER_CMD</title>
1162<para>DESCRIPTION
1163</para>
1164<informaltable><tgroup cols="1"><tbody><row><entry
1165 align="char">
1166<para>This ioctl call is used to send a a DiSEqC command.</para>
1167</entry>
1168 </row></tbody></tgroup></informaltable>
1169<para>SYNOPSIS
1170</para>
1171<informaltable><tgroup cols="1"><tbody><row><entry
1172 align="char">
1173<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001174 <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link>, struct
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001175 dvb_diseqc_master_cmd &#x22C6;cmd);</para>
1176</entry>
1177 </row></tbody></tgroup></informaltable>
1178
1179<para>PARAMETERS
1180</para>
1181<informaltable><tgroup cols="2"><tbody><row><entry
1182 align="char">
1183<para>int fd</para>
1184</entry><entry
1185 align="char">
1186<para>File descriptor returned by a previous call to open().</para>
1187</entry>
1188 </row><row><entry
1189 align="char">
1190<para>int request</para>
1191</entry><entry
1192 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001193<para>Equals <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link> for this
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001194 command.</para>
1195</entry>
1196 </row><row><entry
1197 align="char">
1198<para>struct
1199 dvb_diseqc_master_cmd
1200 *cmd</para>
1201</entry><entry
1202 align="char">
1203<para>Pointer to the command to be transmitted.</para>
1204</entry>
1205 </row></tbody></tgroup></informaltable>
1206
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001207&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001208</section>
1209
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001210<section id="FE_DISEQC_RECV_SLAVE_REPLY">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001211<title>FE_DISEQC_RECV_SLAVE_REPLY</title>
1212<para>DESCRIPTION
1213</para>
1214<informaltable><tgroup cols="1"><tbody><row><entry
1215 align="char">
1216<para>This ioctl call is used to receive reply to a DiSEqC 2.0 command.</para>
1217</entry>
1218 </row></tbody></tgroup></informaltable>
1219
1220<para>SYNOPSIS
1221</para>
1222<informaltable><tgroup cols="1"><tbody><row><entry
1223 align="char">
1224<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001225 <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link>, struct
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001226 dvb_diseqc_slave_reply &#x22C6;reply);</para>
1227</entry>
1228 </row></tbody></tgroup></informaltable>
1229
1230<para>PARAMETERS
1231</para>
1232<informaltable><tgroup cols="2"><tbody><row><entry
1233 align="char">
1234<para>int fd</para>
1235</entry><entry
1236 align="char">
1237<para>File descriptor returned by a previous call to open().</para>
1238</entry>
1239 </row><row><entry
1240 align="char">
1241<para>int request</para>
1242</entry><entry
1243 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001244<para>Equals <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link> for this
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001245 command.</para>
1246</entry>
1247 </row><row><entry
1248 align="char">
1249<para>struct
1250 dvb_diseqc_slave_reply
1251 *reply</para>
1252</entry><entry
1253 align="char">
1254<para>Pointer to the command to be received.</para>
1255</entry>
1256 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001257&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001258</section>
1259
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001260<section id="FE_DISEQC_SEND_BURST">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001261<title>FE_DISEQC_SEND_BURST</title>
1262<para>DESCRIPTION
1263</para>
1264<informaltable><tgroup cols="1"><tbody><row><entry
1265 align="char">
1266<para>This ioctl call is used to send a 22KHz tone burst.</para>
1267</entry>
1268 </row></tbody></tgroup></informaltable>
1269
1270<para>SYNOPSIS
1271</para>
1272<informaltable><tgroup cols="1"><tbody><row><entry
1273 align="char">
1274<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001275 <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link>, fe_sec_mini_cmd_t burst);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001276</entry>
1277 </row></tbody></tgroup></informaltable>
1278
1279<para>PARAMETERS
1280</para>
1281<informaltable><tgroup cols="2"><tbody><row><entry
1282 align="char">
1283<para>int fd</para>
1284</entry><entry
1285 align="char">
1286<para>File descriptor returned by a previous call to open().</para>
1287</entry>
1288 </row><row><entry
1289 align="char">
1290<para>int request</para>
1291</entry><entry
1292 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001293<para>Equals <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001294</entry>
1295 </row><row><entry
1296 align="char">
1297<para>fe_sec_mini_cmd_t
1298 burst</para>
1299</entry><entry
1300 align="char">
1301<para>burst A or B.</para>
1302</entry>
1303 </row></tbody></tgroup></informaltable>
1304
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001305&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001306</section>
1307
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001308<section id="FE_SET_TONE">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001309<title>FE_SET_TONE</title>
1310<para>DESCRIPTION
1311</para>
1312<informaltable><tgroup cols="1"><tbody><row><entry
1313 align="char">
1314<para>This call is used to set the generation of the continuous 22kHz tone. This call
1315 requires read/write permissions.</para>
1316</entry>
1317 </row></tbody></tgroup></informaltable>
1318<para>SYNOPSIS
1319</para>
1320<informaltable><tgroup cols="1"><tbody><row><entry
1321 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001322<para>int ioctl(int fd, int request = <link linkend="FE_SET_TONE">FE_SET_TONE</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001323 fe_sec_tone_mode_t tone);</para>
1324</entry>
1325 </row></tbody></tgroup></informaltable>
1326<para>PARAMETERS
1327</para>
1328<informaltable><tgroup cols="2"><tbody><row><entry
1329 align="char">
1330<para>int fd</para>
1331</entry><entry
1332 align="char">
1333<para>File descriptor returned by a previous call to open().</para>
1334</entry>
1335 </row><row><entry
1336 align="char">
1337<para>int request</para>
1338</entry><entry
1339 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001340<para>Equals <link linkend="FE_SET_TONE">FE_SET_TONE</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001341</entry>
1342 </row><row><entry
1343 align="char">
1344<para>fe_sec_tone_mode_t
1345 tone</para>
1346</entry><entry
1347 align="char">
1348<para>The requested tone generation mode (on/off).</para>
1349</entry>
1350 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001351&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001352</section>
1353
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001354<section id="FE_SET_VOLTAGE">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001355<title>FE_SET_VOLTAGE</title>
1356<para>DESCRIPTION
1357</para>
1358<informaltable><tgroup cols="1"><tbody><row><entry
1359 align="char">
1360<para>This call is used to set the bus voltage. This call requires read/write
1361 permissions.</para>
1362</entry>
1363 </row></tbody></tgroup></informaltable>
1364<para>SYNOPSIS
1365</para>
1366<informaltable><tgroup cols="1"><tbody><row><entry
1367 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001368<para>int ioctl(int fd, int request = <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001369 fe_sec_voltage_t voltage);</para>
1370</entry>
1371 </row></tbody></tgroup></informaltable>
1372
1373<para>PARAMETERS
1374</para>
1375<informaltable><tgroup cols="2"><tbody><row><entry
1376 align="char">
1377<para>int fd</para>
1378</entry><entry
1379 align="char">
1380<para>File descriptor returned by a previous call to open().</para>
1381</entry>
1382 </row><row><entry
1383 align="char">
1384<para>int request</para>
1385</entry><entry
1386 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001387<para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001388</entry>
1389 </row><row><entry
1390 align="char">
1391<para>fe_sec_voltage_t
1392 voltage</para>
1393</entry><entry
1394 align="char">
1395<para>The requested bus voltage.</para>
1396</entry>
1397 </row></tbody></tgroup></informaltable>
1398
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001399&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001400</section>
1401
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001402<section id="FE_ENABLE_HIGH_LNB_VOLTAGE">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001403<title>FE_ENABLE_HIGH_LNB_VOLTAGE</title>
1404<para>DESCRIPTION
1405</para>
1406<informaltable><tgroup cols="1"><tbody><row><entry
1407 align="char">
1408<para>If high != 0 enables slightly higher voltages instead of 13/18V (to compensate
1409 for long cables). This call requires read/write permissions. Not all DVB
1410 adapters support this ioctl.</para>
1411</entry>
1412 </row></tbody></tgroup></informaltable>
1413
1414<para>SYNOPSIS
1415</para>
1416<informaltable><tgroup cols="1"><tbody><row><entry
1417 align="char">
1418<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001419 <link linkend="FE_ENABLE_HIGH_LNB_VOLTAGE">FE_ENABLE_HIGH_LNB_VOLTAGE</link>, int high);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001420</entry>
1421 </row></tbody></tgroup></informaltable>
1422
1423<para>PARAMETERS
1424</para>
1425<informaltable><tgroup cols="2"><tbody><row><entry
1426 align="char">
1427<para>int fd</para>
1428</entry><entry
1429 align="char">
1430<para>File descriptor returned by a previous call to open().</para>
1431</entry>
1432 </row><row><entry
1433 align="char">
1434<para>int request</para>
1435</entry><entry
1436 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001437<para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001438</entry>
1439 </row><row><entry
1440 align="char">
1441<para>int high</para>
1442</entry><entry
1443 align="char">
1444<para>The requested bus voltage.</para>
1445</entry>
1446 </row></tbody></tgroup></informaltable>
1447
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001448&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001449</section>
Mauro Carvalho Chehabf0964a72009-10-24 19:55:24 -03001450
1451<section id="FE_SET_FRONTEND_TUNE_MODE">
1452<title>FE_SET_FRONTEND_TUNE_MODE</title>
1453<para>DESCRIPTION</para>
1454<informaltable><tgroup cols="1"><tbody><row>
1455<entry align="char">
1456<para>Allow setting tuner mode flags to the frontend.</para>
1457</entry>
1458</row></tbody></tgroup></informaltable>
1459
1460<para>SYNOPSIS</para>
1461<informaltable><tgroup cols="1"><tbody><row>
1462<entry align="char">
1463<para>int ioctl(int fd, int request =
1464<link linkend="FE_SET_FRONTEND_TUNE_MODE">FE_SET_FRONTEND_TUNE_MODE</link>, unsigned int flags);</para>
1465</entry>
1466</row></tbody></tgroup></informaltable>
1467
1468<para>PARAMETERS</para>
1469<informaltable><tgroup cols="2"><tbody><row>
1470<entry align="char">
1471 <para>unsigned int flags</para>
1472</entry>
1473<entry align="char">
1474<para>
1475FE_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.
1476</para>
1477</entry>
1478 </row></tbody></tgroup></informaltable>
1479
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001480&return-value-dvb;
Mauro Carvalho Chehab603c0d802009-10-24 20:19:20 -03001481</section>
1482
1483<section id="FE_DISHNETWORK_SEND_LEGACY_CMD">
1484 <title>FE_DISHNETWORK_SEND_LEGACY_CMD</title>
1485<para>DESCRIPTION</para>
1486<informaltable><tgroup cols="1"><tbody><row>
1487<entry align="char">
1488<para>WARNING: This is a very obscure legacy command, used only at stv0299 driver. Should not be used on newer drivers.</para>
1489<para>It provides a non-standard method for selecting Diseqc voltage on the frontend, for Dish Network legacy switches.</para>
1490<para>As support for this ioctl were added in 2004, this means that such dishes were already legacy in 2004.</para>
1491</entry>
1492</row></tbody></tgroup></informaltable>
1493
1494<para>SYNOPSIS</para>
1495<informaltable><tgroup cols="1"><tbody><row>
1496<entry align="char">
1497<para>int ioctl(int fd, int request =
1498 <link linkend="FE_DISHNETWORK_SEND_LEGACY_CMD">FE_DISHNETWORK_SEND_LEGACY_CMD</link>, unsigned long cmd);</para>
1499</entry>
1500</row></tbody></tgroup></informaltable>
1501
1502<para>PARAMETERS</para>
1503<informaltable><tgroup cols="2"><tbody><row>
1504<entry align="char">
1505 <para>unsigned long cmd</para>
1506</entry>
1507<entry align="char">
1508<para>
1509sends the specified raw cmd to the dish via DISEqC.
1510</para>
1511</entry>
1512 </row></tbody></tgroup></informaltable>
1513
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001514&return-value-dvb;
Mauro Carvalho Chehabb8321042009-10-24 21:01:22 -03001515</section>
Mauro Carvalho Chehabf0964a72009-10-24 19:55:24 -03001516
1517</section>
Mauro Carvalho Chehab603c0d802009-10-24 20:19:20 -03001518
Mauro Carvalho Chehabb8321042009-10-24 21:01:22 -03001519&sub-dvbproperty;