blob: 950bdfb4504b4bfaed22063e9cd137dcc33a9a9e [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.
Hans Verkuil510f0a02012-08-09 06:41:43 -030069Please 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>
Mauro Carvalho Chehab0d27bbf2012-08-13 17:03:12 -0300210typedef enum fe_status {
211 FE_HAS_SIGNAL = 0x01,
212 FE_HAS_CARRIER = 0x02,
213 FE_HAS_VITERBI = 0x04,
214 FE_HAS_SYNC = 0x08,
215 FE_HAS_LOCK = 0x10,
216 FE_TIMEDOUT = 0x20,
217 FE_REINIT = 0x40,
218} fe_status_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300219</programlisting>
Mauro Carvalho Chehab0d27bbf2012-08-13 17:03:12 -0300220<para>to indicate the current state and/or state changes of the frontend hardware:
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300221</para>
222
Mauro Carvalho Chehab0d27bbf2012-08-13 17:03:12 -0300223<informaltable><tgroup cols="2"><tbody>
224<row>
225<entry align="char">FE_HAS_SIGNAL</entry>
226<entry align="char">The frontend has found something above the noise level</entry>
227</row><row>
228<entry align="char">FE_HAS_CARRIER</entry>
229<entry align="char">The frontend has found a DVB signal</entry>
230</row><row>
231<entry align="char">FE_HAS_VITERBI</entry>
232<entry align="char">The frontend FEC code is stable</entry>
233</row><row>
234<entry align="char">FE_HAS_SYNC</entry>
235<entry align="char">Syncronization bytes was found</entry>
236</row><row>
237<entry align="char">FE_HAS_LOCK</entry>
238<entry align="char">The DVB were locked and everything is working</entry>
239</row><row>
240<entry align="char">FE_TIMEDOUT</entry>
241<entry align="char">no lock within the last about 2 seconds</entry>
242</row><row>
243<entry align="char">FE_REINIT</entry>
244<entry align="char">The frontend was reinitialized, application is
245recommended to reset DiSEqC, tone and parameters</entry>
246</row>
247</tbody></tgroup></informaltable>
248
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300249</section>
250
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300251<section id="dvb-frontend-parameters">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300252<title>frontend parameters</title>
253<para>The kind of parameters passed to the frontend device for tuning depend on
Mauro Carvalho Chehabdf2692a2011-06-07 20:43:25 -0300254the kind of hardware you are using.</para>
255<para>The struct <constant>dvb_frontend_parameters</constant> uses an
256union with specific per-system parameters. However, as newer delivery systems
257required more data, the structure size weren't enough to fit, and just
258extending its size would break the existing applications. So, those parameters
259were replaced by the usage of <link linkend="FE_GET_SET_PROPERTY">
260<constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> ioctl's. The
261new API is flexible enough to add new parameters to existing delivery systems,
262and to add newer delivery systems.</para>
263<para>So, newer applications should use <link linkend="FE_GET_SET_PROPERTY">
264<constant>FE_GET_PROPERTY/FE_SET_PROPERTY</constant></link> instead, in
265order to be able to support the newer System Delivery like DVB-S2, DVB-T2,
266DVB-C2, ISDB, etc.</para>
Hans Verkuil071408b2012-08-14 06:10:01 -0300267<para>All kinds of parameters are combined as an union in the FrontendParameters structure:
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300268<programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300269struct dvb_frontend_parameters {
270 uint32_t frequency; /&#x22C6; (absolute) frequency in Hz for QAM/OFDM &#x22C6;/
271 /&#x22C6; intermediate frequency in kHz for QPSK &#x22C6;/
272 fe_spectral_inversion_t inversion;
273 union {
274 struct dvb_qpsk_parameters qpsk;
275 struct dvb_qam_parameters qam;
276 struct dvb_ofdm_parameters ofdm;
277 struct dvb_vsb_parameters vsb;
278 } u;
279};
Hans Verkuil071408b2012-08-14 06:10:01 -0300280</programlisting></para>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300281<para>In the case of QPSK frontends the <constant>frequency</constant> field specifies the intermediate
282frequency, i.e. the offset which is effectively added to the local oscillator frequency (LOF) of
283the LNB. The intermediate frequency has to be specified in units of kHz. For QAM and
284OFDM frontends the <constant>frequency</constant> specifies the absolute frequency and is given in Hz.
285</para>
Hans Verkuil071408b2012-08-14 06:10:01 -0300286
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300287<section id="dvb-qpsk-parameters">
288<title>QPSK parameters</title>
289<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 -0300290<programlisting>
291 struct dvb_qpsk_parameters {
292 uint32_t symbol_rate; /&#x22C6; symbol rate in Symbols per second &#x22C6;/
293 fe_code_rate_t fec_inner; /&#x22C6; forward error correction (see above) &#x22C6;/
294 };
295</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300296</section>
297<section id="dvb-qam-parameters">
298<title>QAM parameters</title>
299<para>for cable QAM frontend you use the <constant>dvb_qam_parameters</constant> structure:</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300300<programlisting>
301 struct dvb_qam_parameters {
302 uint32_t symbol_rate; /&#x22C6; symbol rate in Symbols per second &#x22C6;/
303 fe_code_rate_t fec_inner; /&#x22C6; forward error correction (see above) &#x22C6;/
304 fe_modulation_t modulation; /&#x22C6; modulation type (see above) &#x22C6;/
305 };
306</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300307</section>
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300308<section id="dvb-vsb-parameters">
309<title>VSB parameters</title>
Mauro Carvalho Chehab76f9a692011-06-07 22:08:13 -0300310<para>ATSC frontends are supported by the <constant>dvb_vsb_parameters</constant> structure:</para>
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300311<programlisting>
312struct dvb_vsb_parameters {
313 fe_modulation_t modulation; /&#x22C6; modulation type (see above) &#x22C6;/
314};
315</programlisting>
316</section>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300317<section id="dvb-ofdm-parameters">
318<title>OFDM parameters</title>
319<para>DVB-T frontends are supported by the <constant>dvb_ofdm_parameters</constant> structure:</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300320<programlisting>
321 struct dvb_ofdm_parameters {
322 fe_bandwidth_t bandwidth;
323 fe_code_rate_t code_rate_HP; /&#x22C6; high priority stream code rate &#x22C6;/
324 fe_code_rate_t code_rate_LP; /&#x22C6; low priority stream code rate &#x22C6;/
325 fe_modulation_t constellation; /&#x22C6; modulation type (see above) &#x22C6;/
326 fe_transmit_mode_t transmission_mode;
327 fe_guard_interval_t guard_interval;
328 fe_hierarchy_t hierarchy_information;
329 };
330</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300331</section>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300332<section id="fe-spectral-inversion-t">
333<title>frontend spectral inversion</title>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300334<para>The Inversion field can take one of these values:
335</para>
336<programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300337typedef enum fe_spectral_inversion {
338 INVERSION_OFF,
339 INVERSION_ON,
340 INVERSION_AUTO
341} fe_spectral_inversion_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300342</programlisting>
343<para>It indicates if spectral inversion should be presumed or not. In the automatic setting
344(<constant>INVERSION_AUTO</constant>) the hardware will try to figure out the correct setting by
345itself.
346</para>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300347</section>
348<section id="fe-code-rate-t">
349<title>frontend code rate</title>
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300350<para>The possible values for the <constant>fec_inner</constant> field used on
Hans Verkuil071408b2012-08-14 06:10:01 -0300351<link linkend="dvb-qpsk-parameters"><constant>struct dvb_qpsk_parameters</constant></link> and
352<link linkend="dvb-qam-parameters"><constant>struct dvb_qam_parameters</constant></link> are:
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300353</para>
354<programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300355typedef enum fe_code_rate {
356 FEC_NONE = 0,
357 FEC_1_2,
358 FEC_2_3,
359 FEC_3_4,
360 FEC_4_5,
361 FEC_5_6,
362 FEC_6_7,
363 FEC_7_8,
364 FEC_8_9,
365 FEC_AUTO,
366 FEC_3_5,
367 FEC_9_10,
368} fe_code_rate_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300369</programlisting>
370<para>which correspond to error correction rates of 1/2, 2/3, etc., no error correction or auto
371detection.
372</para>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300373</section>
374<section id="fe-modulation-t">
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300375<title>frontend modulation type for QAM, OFDM and VSB</title>
376<para>For cable and terrestrial frontends, e. g. for
Hans Verkuil071408b2012-08-14 06:10:01 -0300377<link linkend="dvb-qam-parameters"><constant>struct dvb_qpsk_parameters</constant></link>,
378<link linkend="dvb-ofdm-parameters"><constant>struct dvb_qam_parameters</constant></link> and
379<link linkend="dvb-vsb-parameters"><constant>struct dvb_qam_parameters</constant></link>,
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300380it needs to specify the quadrature modulation mode which can be one of the following:
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300381</para>
382<programlisting>
383 typedef enum fe_modulation {
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300384 QPSK,
385 QAM_16,
386 QAM_32,
387 QAM_64,
388 QAM_128,
389 QAM_256,
390 QAM_AUTO,
391 VSB_8,
392 VSB_16,
393 PSK_8,
394 APSK_16,
395 APSK_32,
396 DQPSK,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300397 } fe_modulation_t;
398</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300399</section>
Hans Verkuil071408b2012-08-14 06:10:01 -0300400<section>
401<title>More OFDM parameters</title>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300402<section id="fe-transmit-mode-t">
Mauro Carvalho Chehab0be153e2011-06-07 18:15:19 -0300403<title>Number of carriers per channel</title>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300404<programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300405typedef enum fe_transmit_mode {
406 TRANSMISSION_MODE_2K,
407 TRANSMISSION_MODE_8K,
408 TRANSMISSION_MODE_AUTO,
409 TRANSMISSION_MODE_4K,
410 TRANSMISSION_MODE_1K,
411 TRANSMISSION_MODE_16K,
412 TRANSMISSION_MODE_32K,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300413 } fe_transmit_mode_t;
414</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300415</section>
416<section id="fe-bandwidth-t">
417<title>frontend bandwidth</title>
418<programlisting>
419typedef enum fe_bandwidth {
420 BANDWIDTH_8_MHZ,
421 BANDWIDTH_7_MHZ,
422 BANDWIDTH_6_MHZ,
423 BANDWIDTH_AUTO,
424 BANDWIDTH_5_MHZ,
425 BANDWIDTH_10_MHZ,
426 BANDWIDTH_1_712_MHZ,
427} fe_bandwidth_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300428</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300429</section>
430<section id="fe-guard-interval-t">
431<title>frontend guard inverval</title>
432<programlisting>
433typedef enum fe_guard_interval {
434 GUARD_INTERVAL_1_32,
435 GUARD_INTERVAL_1_16,
436 GUARD_INTERVAL_1_8,
437 GUARD_INTERVAL_1_4,
438 GUARD_INTERVAL_AUTO,
439 GUARD_INTERVAL_1_128,
440 GUARD_INTERVAL_19_128,
441 GUARD_INTERVAL_19_256,
442} fe_guard_interval_t;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300443</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300444</section>
445<section id="fe-hierarchy-t">
446<title>frontend hierarchy</title>
447<programlisting>
448typedef enum fe_hierarchy {
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300449 HIERARCHY_NONE,
450 HIERARCHY_1,
451 HIERARCHY_2,
452 HIERARCHY_4,
453 HIERARCHY_AUTO
454 } fe_hierarchy_t;
455</programlisting>
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300456</section>
Hans Verkuil071408b2012-08-14 06:10:01 -0300457</section>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300458
459</section>
460
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300461<section id="dvb-frontend-event">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300462<title>frontend events</title>
463 <programlisting>
464 struct dvb_frontend_event {
465 fe_status_t status;
466 struct dvb_frontend_parameters parameters;
467 };
468</programlisting>
469 </section>
470</section>
471
472
473<section id="frontend_fcalls">
474<title>Frontend Function Calls</title>
475
476<section id="frontend_f_open">
477<title>open()</title>
478<para>DESCRIPTION</para>
479<informaltable><tgroup cols="1"><tbody><row>
480<entry align="char">
481<para>This system call opens a named frontend device (/dev/dvb/adapter0/frontend0)
482 for subsequent use. Usually the first thing to do after a successful open is to
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300483 find out the frontend type with <link linkend="FE_GET_INFO">FE_GET_INFO</link>.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300484<para>The device can be opened in read-only mode, which only allows monitoring of
485 device status and statistics, or read/write mode, which allows any kind of use
486 (e.g. performing tuning operations.)
487</para>
488<para>In a system with multiple front-ends, it is usually the case that multiple devices
489 cannot be open in read/write mode simultaneously. As long as a front-end
490 device is opened in read/write mode, other open() calls in read/write mode will
491 either fail or block, depending on whether non-blocking or blocking mode was
492 specified. A front-end device opened in blocking mode can later be put into
493 non-blocking mode (and vice versa) using the F_SETFL command of the fcntl
494 system call. This is a standard system call, documented in the Linux manual
495 page for fcntl. When an open() call has succeeded, the device will be ready
496 for use in the specified mode. This implies that the corresponding hardware is
497 powered up, and that other front-ends may have been powered down to make
498 that possible.</para>
499</entry>
500 </row></tbody></tgroup></informaltable>
501
502<para>SYNOPSIS</para>
503<informaltable><tgroup cols="1"><tbody><row><entry
504 align="char">
505<para>int open(const char &#x22C6;deviceName, int flags);</para>
506</entry>
507 </row></tbody></tgroup></informaltable>
508<para>PARAMETERS
509</para>
510<informaltable><tgroup cols="2"><tbody><row><entry
511 align="char">
512<para>const char
513 *deviceName</para>
514</entry><entry
515 align="char">
516<para>Name of specific video device.</para>
517</entry>
518 </row><row><entry
519 align="char">
520<para>int flags</para>
521</entry><entry
522 align="char">
523<para>A bit-wise OR of the following flags:</para>
524</entry>
525 </row><row><entry
526 align="char">
527</entry><entry
528 align="char">
529<para>O_RDONLY read-only access</para>
530</entry>
531 </row><row><entry
532 align="char">
533</entry><entry
534 align="char">
535<para>O_RDWR read/write access</para>
536</entry>
537 </row><row><entry
538 align="char">
539</entry><entry
540 align="char">
541<para>O_NONBLOCK open in non-blocking mode</para>
542</entry>
543 </row><row><entry
544 align="char">
545</entry><entry
546 align="char">
547<para>(blocking mode is the default)</para>
548</entry>
549 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300550<para>RETURN VALUE</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300551<informaltable><tgroup cols="2"><tbody><row><entry
552 align="char">
553<para>ENODEV</para>
554</entry><entry
555 align="char">
556<para>Device driver not loaded/available.</para>
557</entry>
558 </row><row><entry
559 align="char">
560<para>EINTERNAL</para>
561</entry><entry
562 align="char">
563<para>Internal error.</para>
564</entry>
565 </row><row><entry
566 align="char">
567<para>EBUSY</para>
568</entry><entry
569 align="char">
570<para>Device or resource busy.</para>
571</entry>
572 </row><row><entry
573 align="char">
574<para>EINVAL</para>
575</entry><entry
576 align="char">
577<para>Invalid argument.</para>
578</entry>
579 </row></tbody></tgroup></informaltable>
580</section>
581
582<section id="frontend_f_close">
583<title>close()</title>
584<para>DESCRIPTION
585</para>
586<informaltable><tgroup cols="1"><tbody><row><entry
587 align="char">
588<para>This system call closes a previously opened front-end device. After closing
589 a front-end device, its corresponding hardware might be powered down
590 automatically.</para>
591</entry>
592 </row></tbody></tgroup></informaltable>
593<para>SYNOPSIS
594</para>
595<informaltable><tgroup cols="1"><tbody><row><entry
596 align="char">
597<para>int close(int fd);</para>
598</entry>
599 </row></tbody></tgroup></informaltable>
600<para>PARAMETERS
601</para>
602<informaltable><tgroup cols="2"><tbody><row><entry
603 align="char">
604<para>int fd</para>
605</entry><entry
606 align="char">
607<para>File descriptor returned by a previous call to open().</para>
608</entry>
609 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300610<para>RETURN VALUE</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300611<informaltable><tgroup cols="2"><tbody><row><entry
612 align="char">
613<para>EBADF</para>
614</entry><entry
615 align="char">
616<para>fd is not a valid open file descriptor.</para>
617</entry>
618 </row></tbody></tgroup></informaltable>
619</section>
620
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300621<section id="FE_READ_STATUS">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300622<title>FE_READ_STATUS</title>
623<para>DESCRIPTION
624</para>
625<informaltable><tgroup cols="1"><tbody><row><entry
626 align="char">
627<para>This ioctl call returns status information about the front-end. This call only
628 requires read-only access to the device.</para>
629</entry>
630 </row></tbody></tgroup></informaltable>
631<para>SYNOPSIS
632</para>
633<informaltable><tgroup cols="1"><tbody><row><entry
634 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300635<para>int ioctl(int fd, int request = <link linkend="FE_READ_STATUS">FE_READ_STATUS</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300636 fe_status_t &#x22C6;status);</para>
637</entry>
638 </row></tbody></tgroup></informaltable>
639<para>PARAMETERS
640</para>
641
642<informaltable><tgroup cols="2"><tbody><row><entry
643 align="char">
644<para>int fd</para>
645</entry><entry
646 align="char">
647<para>File descriptor returned by a previous call to open().</para>
648</entry>
649 </row><row><entry
650 align="char">
651<para>int request</para>
652</entry><entry
653 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300654<para>Equals <link linkend="FE_READ_STATUS">FE_READ_STATUS</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300655</entry>
656 </row><row><entry
657 align="char">
658<para>struct fe_status_t
659 *status</para>
660</entry><entry
661 align="char">
662<para>Points to the location where the front-end status word is
663 to be stored.</para>
664</entry>
665 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300666<para>RETURN VALUE</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300667<informaltable><tgroup cols="2"><tbody><row><entry
668 align="char">
669<para>EBADF</para>
670</entry><entry
671 align="char">
672<para>fd is not a valid open file descriptor.</para>
673</entry>
674 </row><row><entry
675 align="char">
676<para>EFAULT</para>
677</entry><entry
678 align="char">
679<para>status points to invalid address.</para>
680</entry>
681 </row></tbody></tgroup></informaltable>
682</section>
683
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300684<section id="FE_READ_BER">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300685<title>FE_READ_BER</title>
686<para>DESCRIPTION
687</para>
688<informaltable><tgroup cols="1"><tbody><row><entry
689 align="char">
690<para>This ioctl call returns the bit error rate for the signal currently
691 received/demodulated by the front-end. For this command, read-only access to
692 the device is sufficient.</para>
693</entry>
694 </row></tbody></tgroup></informaltable>
695<para>SYNOPSIS
696</para>
697<informaltable><tgroup cols="1"><tbody><row><entry
698 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300699<para>int ioctl(int fd, int request = <link linkend="FE_READ_BER">FE_READ_BER</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300700 uint32_t &#x22C6;ber);</para>
701</entry>
702 </row></tbody></tgroup></informaltable>
703<para>PARAMETERS
704</para>
705<informaltable><tgroup cols="2"><tbody><row><entry
706 align="char">
707<para>int fd</para>
708</entry><entry
709 align="char">
710<para>File descriptor returned by a previous call to open().</para>
711</entry>
712 </row><row><entry
713 align="char">
714<para>int request</para>
715</entry><entry
716 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300717<para>Equals <link linkend="FE_READ_BER">FE_READ_BER</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300718</entry>
719 </row><row><entry
720 align="char">
721<para>uint32_t *ber</para>
722</entry><entry
723 align="char">
724<para>The bit error rate is stored into *ber.</para>
725</entry>
726 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300727
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300728&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300729</section>
730
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300731<section id="FE_READ_SNR">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300732<title>FE_READ_SNR</title>
733
734<para>DESCRIPTION
735</para>
736<informaltable><tgroup cols="1"><tbody><row><entry
737 align="char">
738<para>This ioctl call returns the signal-to-noise ratio for the signal currently received
739 by the front-end. For this command, read-only access to the device is sufficient.</para>
740</entry>
741 </row></tbody></tgroup></informaltable>
742<para>SYNOPSIS
743</para>
744<informaltable><tgroup cols="1"><tbody><row><entry
745 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300746<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 -0300747 &#x22C6;snr);</para>
748</entry>
749 </row></tbody></tgroup></informaltable>
750<para>PARAMETERS
751</para>
752<informaltable><tgroup cols="2"><tbody><row><entry
753 align="char">
754<para>int fd</para>
755</entry><entry
756 align="char">
757<para>File descriptor returned by a previous call to open().</para>
758</entry>
759 </row><row><entry
760 align="char">
761<para>int request</para>
762</entry><entry
763 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300764<para>Equals <link linkend="FE_READ_SNR">FE_READ_SNR</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300765</entry>
766 </row><row><entry
767 align="char">
768<para>int16_t *snr</para>
769</entry><entry
770 align="char">
771<para>The signal-to-noise ratio is stored into *snr.</para>
772</entry>
773 </row></tbody></tgroup></informaltable>
774
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300775&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300776</section>
777
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300778<section id="FE_READ_SIGNAL_STRENGTH">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300779<title>FE_READ_SIGNAL_STRENGTH</title>
780<para>DESCRIPTION
781</para>
782<informaltable><tgroup cols="1"><tbody><row><entry
783 align="char">
784<para>This ioctl call returns the signal strength value for the signal currently received
785 by the front-end. For this command, read-only access to the device is sufficient.</para>
786</entry>
787 </row></tbody></tgroup></informaltable>
788<para>SYNOPSIS
789</para>
790<informaltable><tgroup cols="1"><tbody><row><entry
791 align="char">
792<para>int ioctl( int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300793 <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link>, int16_t &#x22C6;strength);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300794</entry>
795 </row></tbody></tgroup></informaltable>
796
797<para>PARAMETERS
798</para>
799<informaltable><tgroup cols="2"><tbody><row><entry
800 align="char">
801<para>int fd</para>
802</entry><entry
803 align="char">
804<para>File descriptor returned by a previous call to open().</para>
805</entry>
806 </row><row><entry
807 align="char">
808<para>int request</para>
809</entry><entry
810 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300811<para>Equals <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link> for this
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300812 command.</para>
813</entry>
814 </row><row><entry
815 align="char">
816<para>int16_t *strength</para>
817</entry><entry
818 align="char">
819<para>The signal strength value is stored into *strength.</para>
820</entry>
821 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300822
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300823&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300824</section>
825
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300826<section id="FE_READ_UNCORRECTED_BLOCKS">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300827<title>FE_READ_UNCORRECTED_BLOCKS</title>
828<para>DESCRIPTION
829</para>
830<informaltable><tgroup cols="1"><tbody><row><entry
831 align="char">
832<para>This ioctl call returns the number of uncorrected blocks detected by the device
833 driver during its lifetime. For meaningful measurements, the increment in block
834 count during a specific time interval should be calculated. For this command,
835 read-only access to the device is sufficient.</para>
836</entry>
837 </row><row><entry
838 align="char">
839<para>Note that the counter will wrap to zero after its maximum count has been
840 reached.</para>
841</entry>
842 </row></tbody></tgroup></informaltable>
843<para>SYNOPSIS
844</para>
845<informaltable><tgroup cols="1"><tbody><row><entry
846 align="char">
847<para>int ioctl( int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300848 <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link>, uint32_t &#x22C6;ublocks);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300849</entry>
850 </row></tbody></tgroup></informaltable>
851<para>PARAMETERS
852</para>
853<informaltable><tgroup cols="2"><tbody><row><entry
854 align="char">
855<para>int fd</para>
856</entry><entry
857 align="char">
858<para>File descriptor returned by a previous call to open().</para>
859</entry>
860 </row><row><entry
861 align="char">
862<para>int request</para>
863</entry><entry
864 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300865<para>Equals <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link> for this
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300866 command.</para>
867</entry>
868 </row><row><entry
869 align="char">
870<para>uint32_t *ublocks</para>
871</entry><entry
872 align="char">
873<para>The total number of uncorrected blocks seen by the driver
874 so far.</para>
875</entry>
876 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300877
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300878&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300879</section>
880
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300881<section id="FE_SET_FRONTEND">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300882<title>FE_SET_FRONTEND</title>
883<para>DESCRIPTION
884</para>
885<informaltable><tgroup cols="1"><tbody><row><entry
886 align="char">
887<para>This ioctl call starts a tuning operation using specified parameters. The result
888 of this call will be successful if the parameters were valid and the tuning could
889 be initiated. The result of the tuning operation in itself, however, will arrive
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300890 asynchronously as an event (see documentation for <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> and
891 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 -0300892 the previous one was completed, the previous operation will be aborted in favor
893 of the new one. This command requires read/write access to the device.</para>
894</entry>
895 </row></tbody></tgroup></informaltable>
896
897<para>SYNOPSIS
898</para>
899<informaltable><tgroup cols="1"><tbody><row><entry
900 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300901<para>int ioctl(int fd, int request = <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300902 struct dvb_frontend_parameters &#x22C6;p);</para>
903</entry>
904 </row></tbody></tgroup></informaltable>
905<para>PARAMETERS
906</para>
907<informaltable><tgroup cols="2"><tbody><row><entry
908 align="char">
909<para>int fd</para>
910</entry><entry
911 align="char">
912<para>File descriptor returned by a previous call to open().</para>
913</entry>
914 </row><row><entry
915 align="char">
916<para>int request</para>
917</entry><entry
918 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300919<para>Equals <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300920</entry>
921 </row><row><entry
922 align="char">
923<para>struct
924 dvb_frontend_parameters
925 *p</para>
926</entry><entry
927 align="char">
928<para>Points to parameters for tuning operation.</para>
929</entry>
930 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab66b30b52011-07-06 13:42:08 -0300931
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300932&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300933<informaltable><tgroup cols="2"><tbody><row><entry
934 align="char">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300935<para>EINVAL</para>
936</entry><entry
937 align="char">
938<para>Maximum supported symbol rate reached.</para>
939</entry>
940</row></tbody></tgroup></informaltable>
941</section>
942
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300943<section id="FE_GET_FRONTEND">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300944<title>FE_GET_FRONTEND</title>
945<para>DESCRIPTION
946</para>
947<informaltable><tgroup cols="1"><tbody><row><entry
948 align="char">
949<para>This ioctl call queries the currently effective frontend parameters. For this
950 command, read-only access to the device is sufficient.</para>
951</entry>
952 </row></tbody></tgroup></informaltable>
953
954<para>SYNOPSIS
955</para>
956<informaltable><tgroup cols="1"><tbody><row><entry
957 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300958<para>int ioctl(int fd, int request = <link linkend="FE_GET_FRONTEND">FE_GET_FRONTEND</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300959 struct dvb_frontend_parameters &#x22C6;p);</para>
960</entry>
961 </row></tbody></tgroup></informaltable>
962
963<para>PARAMETERS
964</para>
965<informaltable><tgroup cols="2"><tbody><row><entry
966 align="char">
967<para>int fd</para>
968</entry><entry
969 align="char">
970<para>File descriptor returned by a previous call to open().</para>
971</entry>
972 </row><row><entry
973 align="char">
974<para>int request</para>
975</entry><entry
976 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -0300977<para>Equals <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300978</entry>
979 </row><row><entry
980 align="char">
981<para>struct
982 dvb_frontend_parameters
983 *p</para>
984</entry><entry
985 align="char">
986<para>Points to parameters for tuning operation.</para>
987</entry>
988 </row></tbody></tgroup></informaltable>
989
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -0300990&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300991<informaltable><tgroup cols="2"><tbody><row><entry
992 align="char">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300993<para>EINVAL</para>
994</entry><entry
995 align="char">
996<para>Maximum supported symbol rate reached.</para>
997</entry>
998 </row></tbody></tgroup></informaltable>
999
1000</section>
1001
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001002<section id="FE_GET_EVENT">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001003<title>FE_GET_EVENT</title>
1004<para>DESCRIPTION
1005</para>
1006<informaltable><tgroup cols="1"><tbody><row><entry
1007 align="char">
1008<para>This ioctl call returns a frontend event if available. If an event is not
1009 available, the behavior depends on whether the device is in blocking or
1010 non-blocking mode. In the latter case, the call fails immediately with errno
1011 set to EWOULDBLOCK. In the former case, the call blocks until an event
1012 becomes available.</para>
1013</entry>
1014 </row><row><entry
1015 align="char">
1016<para>The standard Linux poll() and/or select() system calls can be used with the
1017 device file descriptor to watch for new events. For select(), the file descriptor
1018 should be included in the exceptfds argument, and for poll(), POLLPRI should
1019 be specified as the wake-up condition. Since the event queue allocated is
1020 rather small (room for 8 events), the queue must be serviced regularly to avoid
1021 overflow. If an overflow happens, the oldest event is discarded from the queue,
1022 and an error (EOVERFLOW) occurs the next time the queue is read. After
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001023 reporting the error condition in this fashion, subsequent
1024 <link linkend="FE_GET_EVENT">FE_GET_EVENT</link>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001025 calls will return events from the queue as usual.</para>
1026</entry>
1027 </row><row><entry
1028 align="char">
1029<para>For the sake of implementation simplicity, this command requires read/write
1030 access to the device.</para>
1031</entry>
1032 </row></tbody></tgroup></informaltable>
1033
1034<para>SYNOPSIS
1035</para>
1036<informaltable><tgroup cols="1"><tbody><row><entry
1037 align="char">
1038<para>int ioctl(int fd, int request = QPSK_GET_EVENT,
1039 struct dvb_frontend_event &#x22C6;ev);</para>
1040</entry>
1041 </row></tbody></tgroup></informaltable>
1042
1043<para>PARAMETERS
1044</para>
1045<informaltable><tgroup cols="2"><tbody><row><entry
1046 align="char">
1047<para>int fd</para>
1048</entry><entry
1049 align="char">
1050<para>File descriptor returned by a previous call to open().</para>
1051</entry>
1052 </row><row><entry
1053 align="char">
1054<para>int request</para>
1055</entry><entry
1056 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001057<para>Equals <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001058</entry>
1059 </row><row><entry
1060 align="char">
1061<para>struct
1062 dvb_frontend_event
1063 *ev</para>
1064</entry><entry
1065 align="char">
1066<para>Points to the location where the event,</para>
1067</entry>
1068 </row><row><entry
1069 align="char">
1070</entry><entry
1071 align="char">
1072<para>if any, is to be stored.</para>
1073</entry>
1074 </row></tbody></tgroup></informaltable>
1075
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001076&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001077<informaltable><tgroup cols="2"><tbody><row><entry
1078 align="char">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001079<para>EWOULDBLOCK</para>
1080</entry><entry
1081 align="char">
1082<para>There is no event pending, and the device is in
1083 non-blocking mode.</para>
1084</entry>
1085 </row><row><entry
1086 align="char">
1087<para>EOVERFLOW</para>
1088</entry><entry
1089 align="char">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001090<para>Overflow in event queue - one or more events were lost.</para>
1091</entry>
1092</row></tbody></tgroup></informaltable>
1093</section>
1094
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001095<section id="FE_GET_INFO">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001096<title>FE_GET_INFO</title>
1097<para>DESCRIPTION
1098</para>
1099<informaltable><tgroup cols="1"><tbody><row><entry
1100 align="char">
1101<para>This ioctl call returns information about the front-end. This call only requires
1102 read-only access to the device.</para>
1103</entry>
1104 </row></tbody></tgroup></informaltable>
1105<para>SYNOPSIS
1106</para>
1107
1108<informaltable><tgroup cols="1"><tbody><row><entry
1109 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001110<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 -03001111 dvb_frontend_info &#x22C6;info);</para>
1112</entry>
1113 </row></tbody></tgroup></informaltable>
1114<para>PARAMETERS
1115</para>
1116
1117<informaltable><tgroup cols="2"><tbody><row><entry
1118 align="char">
1119<para>int fd</para>
1120</entry><entry
1121 align="char">
1122<para>File descriptor returned by a previous call to open().</para>
1123</entry>
1124 </row><row><entry
1125 align="char">
1126<para>int request</para>
1127</entry><entry
1128 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001129<para>Equals <link linkend="FE_GET_INFO">FE_GET_INFO</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001130</entry>
1131 </row><row><entry
1132 align="char">
1133<para>struct
1134 dvb_frontend_info
1135 *info</para>
1136</entry><entry
1137 align="char">
1138<para>Points to the location where the front-end information is
1139 to be stored.</para>
1140</entry>
1141 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001142&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001143</section>
1144
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001145<section id="FE_DISEQC_RESET_OVERLOAD">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001146<title>FE_DISEQC_RESET_OVERLOAD</title>
1147<para>DESCRIPTION
1148</para>
1149<informaltable><tgroup cols="1"><tbody><row><entry
1150 align="char">
1151<para>If the bus has been automatically powered off due to power overload, this ioctl
1152 call restores the power to the bus. The call requires read/write access to the
1153 device. This call has no effect if the device is manually powered off. Not all
1154 DVB adapters support this ioctl.</para>
1155</entry>
1156 </row></tbody></tgroup></informaltable>
1157
1158<para>SYNOPSIS
1159</para>
1160<informaltable><tgroup cols="1"><tbody><row><entry
1161 align="char">
1162<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001163 <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001164</entry>
1165 </row></tbody></tgroup></informaltable>
1166<para>PARAMETERS
1167</para>
1168<informaltable><tgroup cols="2"><tbody><row><entry
1169 align="char">
1170<para>int fd</para>
1171</entry><entry
1172 align="char">
1173<para>File descriptor returned by a previous call to open().</para>
1174</entry>
1175 </row><row><entry
1176 align="char">
1177<para>int request</para>
1178</entry><entry
1179 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001180<para>Equals <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> for this
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001181 command.</para>
1182</entry>
1183 </row></tbody></tgroup></informaltable>
1184
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001185&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001186</section>
1187
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001188<section id="FE_DISEQC_SEND_MASTER_CMD">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001189<title>FE_DISEQC_SEND_MASTER_CMD</title>
1190<para>DESCRIPTION
1191</para>
1192<informaltable><tgroup cols="1"><tbody><row><entry
1193 align="char">
1194<para>This ioctl call is used to send a a DiSEqC command.</para>
1195</entry>
1196 </row></tbody></tgroup></informaltable>
1197<para>SYNOPSIS
1198</para>
1199<informaltable><tgroup cols="1"><tbody><row><entry
1200 align="char">
1201<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001202 <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link>, struct
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001203 dvb_diseqc_master_cmd &#x22C6;cmd);</para>
1204</entry>
1205 </row></tbody></tgroup></informaltable>
1206
1207<para>PARAMETERS
1208</para>
1209<informaltable><tgroup cols="2"><tbody><row><entry
1210 align="char">
1211<para>int fd</para>
1212</entry><entry
1213 align="char">
1214<para>File descriptor returned by a previous call to open().</para>
1215</entry>
1216 </row><row><entry
1217 align="char">
1218<para>int request</para>
1219</entry><entry
1220 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001221<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 -03001222 command.</para>
1223</entry>
1224 </row><row><entry
1225 align="char">
1226<para>struct
1227 dvb_diseqc_master_cmd
1228 *cmd</para>
1229</entry><entry
1230 align="char">
1231<para>Pointer to the command to be transmitted.</para>
1232</entry>
1233 </row></tbody></tgroup></informaltable>
1234
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001235&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001236</section>
1237
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001238<section id="FE_DISEQC_RECV_SLAVE_REPLY">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001239<title>FE_DISEQC_RECV_SLAVE_REPLY</title>
1240<para>DESCRIPTION
1241</para>
1242<informaltable><tgroup cols="1"><tbody><row><entry
1243 align="char">
1244<para>This ioctl call is used to receive reply to a DiSEqC 2.0 command.</para>
1245</entry>
1246 </row></tbody></tgroup></informaltable>
1247
1248<para>SYNOPSIS
1249</para>
1250<informaltable><tgroup cols="1"><tbody><row><entry
1251 align="char">
1252<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001253 <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link>, struct
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001254 dvb_diseqc_slave_reply &#x22C6;reply);</para>
1255</entry>
1256 </row></tbody></tgroup></informaltable>
1257
1258<para>PARAMETERS
1259</para>
1260<informaltable><tgroup cols="2"><tbody><row><entry
1261 align="char">
1262<para>int fd</para>
1263</entry><entry
1264 align="char">
1265<para>File descriptor returned by a previous call to open().</para>
1266</entry>
1267 </row><row><entry
1268 align="char">
1269<para>int request</para>
1270</entry><entry
1271 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001272<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 -03001273 command.</para>
1274</entry>
1275 </row><row><entry
1276 align="char">
1277<para>struct
1278 dvb_diseqc_slave_reply
1279 *reply</para>
1280</entry><entry
1281 align="char">
1282<para>Pointer to the command to be received.</para>
1283</entry>
1284 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001285&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001286</section>
1287
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001288<section id="FE_DISEQC_SEND_BURST">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001289<title>FE_DISEQC_SEND_BURST</title>
1290<para>DESCRIPTION
1291</para>
1292<informaltable><tgroup cols="1"><tbody><row><entry
1293 align="char">
1294<para>This ioctl call is used to send a 22KHz tone burst.</para>
1295</entry>
1296 </row></tbody></tgroup></informaltable>
1297
1298<para>SYNOPSIS
1299</para>
1300<informaltable><tgroup cols="1"><tbody><row><entry
1301 align="char">
1302<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001303 <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 -03001304</entry>
1305 </row></tbody></tgroup></informaltable>
1306
1307<para>PARAMETERS
1308</para>
1309<informaltable><tgroup cols="2"><tbody><row><entry
1310 align="char">
1311<para>int fd</para>
1312</entry><entry
1313 align="char">
1314<para>File descriptor returned by a previous call to open().</para>
1315</entry>
1316 </row><row><entry
1317 align="char">
1318<para>int request</para>
1319</entry><entry
1320 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001321<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 -03001322</entry>
1323 </row><row><entry
1324 align="char">
1325<para>fe_sec_mini_cmd_t
1326 burst</para>
1327</entry><entry
1328 align="char">
1329<para>burst A or B.</para>
1330</entry>
1331 </row></tbody></tgroup></informaltable>
1332
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001333&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001334</section>
1335
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001336<section id="FE_SET_TONE">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001337<title>FE_SET_TONE</title>
1338<para>DESCRIPTION
1339</para>
1340<informaltable><tgroup cols="1"><tbody><row><entry
1341 align="char">
1342<para>This call is used to set the generation of the continuous 22kHz tone. This call
1343 requires read/write permissions.</para>
1344</entry>
1345 </row></tbody></tgroup></informaltable>
1346<para>SYNOPSIS
1347</para>
1348<informaltable><tgroup cols="1"><tbody><row><entry
1349 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001350<para>int ioctl(int fd, int request = <link linkend="FE_SET_TONE">FE_SET_TONE</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001351 fe_sec_tone_mode_t tone);</para>
1352</entry>
1353 </row></tbody></tgroup></informaltable>
1354<para>PARAMETERS
1355</para>
1356<informaltable><tgroup cols="2"><tbody><row><entry
1357 align="char">
1358<para>int fd</para>
1359</entry><entry
1360 align="char">
1361<para>File descriptor returned by a previous call to open().</para>
1362</entry>
1363 </row><row><entry
1364 align="char">
1365<para>int request</para>
1366</entry><entry
1367 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001368<para>Equals <link linkend="FE_SET_TONE">FE_SET_TONE</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001369</entry>
1370 </row><row><entry
1371 align="char">
1372<para>fe_sec_tone_mode_t
1373 tone</para>
1374</entry><entry
1375 align="char">
1376<para>The requested tone generation mode (on/off).</para>
1377</entry>
1378 </row></tbody></tgroup></informaltable>
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001379&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001380</section>
1381
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001382<section id="FE_SET_VOLTAGE">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001383<title>FE_SET_VOLTAGE</title>
1384<para>DESCRIPTION
1385</para>
1386<informaltable><tgroup cols="1"><tbody><row><entry
1387 align="char">
1388<para>This call is used to set the bus voltage. This call requires read/write
1389 permissions.</para>
1390</entry>
1391 </row></tbody></tgroup></informaltable>
1392<para>SYNOPSIS
1393</para>
1394<informaltable><tgroup cols="1"><tbody><row><entry
1395 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001396<para>int ioctl(int fd, int request = <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link>,
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001397 fe_sec_voltage_t voltage);</para>
1398</entry>
1399 </row></tbody></tgroup></informaltable>
1400
1401<para>PARAMETERS
1402</para>
1403<informaltable><tgroup cols="2"><tbody><row><entry
1404 align="char">
1405<para>int fd</para>
1406</entry><entry
1407 align="char">
1408<para>File descriptor returned by a previous call to open().</para>
1409</entry>
1410 </row><row><entry
1411 align="char">
1412<para>int request</para>
1413</entry><entry
1414 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001415<para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001416</entry>
1417 </row><row><entry
1418 align="char">
1419<para>fe_sec_voltage_t
1420 voltage</para>
1421</entry><entry
1422 align="char">
1423<para>The requested bus voltage.</para>
1424</entry>
1425 </row></tbody></tgroup></informaltable>
1426
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001427&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001428</section>
1429
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001430<section id="FE_ENABLE_HIGH_LNB_VOLTAGE">
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001431<title>FE_ENABLE_HIGH_LNB_VOLTAGE</title>
1432<para>DESCRIPTION
1433</para>
1434<informaltable><tgroup cols="1"><tbody><row><entry
1435 align="char">
1436<para>If high != 0 enables slightly higher voltages instead of 13/18V (to compensate
1437 for long cables). This call requires read/write permissions. Not all DVB
1438 adapters support this ioctl.</para>
1439</entry>
1440 </row></tbody></tgroup></informaltable>
1441
1442<para>SYNOPSIS
1443</para>
1444<informaltable><tgroup cols="1"><tbody><row><entry
1445 align="char">
1446<para>int ioctl(int fd, int request =
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001447 <link linkend="FE_ENABLE_HIGH_LNB_VOLTAGE">FE_ENABLE_HIGH_LNB_VOLTAGE</link>, int high);</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001448</entry>
1449 </row></tbody></tgroup></informaltable>
1450
1451<para>PARAMETERS
1452</para>
1453<informaltable><tgroup cols="2"><tbody><row><entry
1454 align="char">
1455<para>int fd</para>
1456</entry><entry
1457 align="char">
1458<para>File descriptor returned by a previous call to open().</para>
1459</entry>
1460 </row><row><entry
1461 align="char">
1462<para>int request</para>
1463</entry><entry
1464 align="char">
Mauro Carvalho Chehab6dea3832009-10-24 19:10:46 -03001465<para>Equals <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> for this command.</para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001466</entry>
1467 </row><row><entry
1468 align="char">
1469<para>int high</para>
1470</entry><entry
1471 align="char">
1472<para>The requested bus voltage.</para>
1473</entry>
1474 </row></tbody></tgroup></informaltable>
1475
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001476&return-value-dvb;
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001477</section>
Mauro Carvalho Chehabf0964a72009-10-24 19:55:24 -03001478
1479<section id="FE_SET_FRONTEND_TUNE_MODE">
1480<title>FE_SET_FRONTEND_TUNE_MODE</title>
1481<para>DESCRIPTION</para>
1482<informaltable><tgroup cols="1"><tbody><row>
1483<entry align="char">
1484<para>Allow setting tuner mode flags to the frontend.</para>
1485</entry>
1486</row></tbody></tgroup></informaltable>
1487
1488<para>SYNOPSIS</para>
1489<informaltable><tgroup cols="1"><tbody><row>
1490<entry align="char">
1491<para>int ioctl(int fd, int request =
1492<link linkend="FE_SET_FRONTEND_TUNE_MODE">FE_SET_FRONTEND_TUNE_MODE</link>, unsigned int flags);</para>
1493</entry>
1494</row></tbody></tgroup></informaltable>
1495
1496<para>PARAMETERS</para>
1497<informaltable><tgroup cols="2"><tbody><row>
1498<entry align="char">
1499 <para>unsigned int flags</para>
1500</entry>
1501<entry align="char">
1502<para>
1503FE_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.
1504</para>
1505</entry>
1506 </row></tbody></tgroup></informaltable>
1507
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001508&return-value-dvb;
Mauro Carvalho Chehab603c0d802009-10-24 20:19:20 -03001509</section>
1510
1511<section id="FE_DISHNETWORK_SEND_LEGACY_CMD">
1512 <title>FE_DISHNETWORK_SEND_LEGACY_CMD</title>
1513<para>DESCRIPTION</para>
1514<informaltable><tgroup cols="1"><tbody><row>
1515<entry align="char">
1516<para>WARNING: This is a very obscure legacy command, used only at stv0299 driver. Should not be used on newer drivers.</para>
1517<para>It provides a non-standard method for selecting Diseqc voltage on the frontend, for Dish Network legacy switches.</para>
1518<para>As support for this ioctl were added in 2004, this means that such dishes were already legacy in 2004.</para>
1519</entry>
1520</row></tbody></tgroup></informaltable>
1521
1522<para>SYNOPSIS</para>
1523<informaltable><tgroup cols="1"><tbody><row>
1524<entry align="char">
1525<para>int ioctl(int fd, int request =
1526 <link linkend="FE_DISHNETWORK_SEND_LEGACY_CMD">FE_DISHNETWORK_SEND_LEGACY_CMD</link>, unsigned long cmd);</para>
1527</entry>
1528</row></tbody></tgroup></informaltable>
1529
1530<para>PARAMETERS</para>
1531<informaltable><tgroup cols="2"><tbody><row>
1532<entry align="char">
1533 <para>unsigned long cmd</para>
1534</entry>
1535<entry align="char">
1536<para>
1537sends the specified raw cmd to the dish via DISEqC.
1538</para>
1539</entry>
1540 </row></tbody></tgroup></informaltable>
1541
Mauro Carvalho Chehab3de530f2011-07-05 12:36:01 -03001542&return-value-dvb;
Mauro Carvalho Chehabb8321042009-10-24 21:01:22 -03001543</section>
Mauro Carvalho Chehabf0964a72009-10-24 19:55:24 -03001544
1545</section>
Mauro Carvalho Chehab603c0d802009-10-24 20:19:20 -03001546
Mauro Carvalho Chehabb8321042009-10-24 21:01:22 -03001547&sub-dvbproperty;