]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * frontend.h | |
3 | * | |
4 | * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de> | |
5 | * Ralph Metzler <ralph@convergence.de> | |
6 | * Holger Waechtler <holger@convergence.de> | |
7 | * Andre Draszik <ad@convergence.de> | |
8 | * for convergence integrated media GmbH | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or | |
11 | * modify it under the terms of the GNU Lesser General Public License | |
12 | * as published by the Free Software Foundation; either version 2.1 | |
13 | * of the License, or (at your option) any later version. | |
14 | * | |
15 | * This program is distributed in the hope that it will be useful, | |
16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | * GNU General Public License for more details. | |
19 | * | |
20 | * You should have received a copy of the GNU Lesser General Public License | |
21 | * along with this program; if not, write to the Free Software | |
22 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
23 | * | |
24 | */ | |
25 | ||
26 | #ifndef _DVBFRONTEND_H_ | |
27 | #define _DVBFRONTEND_H_ | |
28 | ||
29 | #include <asm/types.h> | |
30 | ||
31 | ||
32 | typedef enum fe_type { | |
33 | FE_QPSK, | |
34 | FE_QAM, | |
35 | FE_OFDM, | |
36 | FE_ATSC | |
37 | } fe_type_t; | |
38 | ||
39 | ||
40 | typedef enum fe_caps { | |
41 | FE_IS_STUPID = 0, | |
42 | FE_CAN_INVERSION_AUTO = 0x1, | |
43 | FE_CAN_FEC_1_2 = 0x2, | |
44 | FE_CAN_FEC_2_3 = 0x4, | |
45 | FE_CAN_FEC_3_4 = 0x8, | |
46 | FE_CAN_FEC_4_5 = 0x10, | |
47 | FE_CAN_FEC_5_6 = 0x20, | |
48 | FE_CAN_FEC_6_7 = 0x40, | |
49 | FE_CAN_FEC_7_8 = 0x80, | |
50 | FE_CAN_FEC_8_9 = 0x100, | |
51 | FE_CAN_FEC_AUTO = 0x200, | |
52 | FE_CAN_QPSK = 0x400, | |
53 | FE_CAN_QAM_16 = 0x800, | |
54 | FE_CAN_QAM_32 = 0x1000, | |
55 | FE_CAN_QAM_64 = 0x2000, | |
56 | FE_CAN_QAM_128 = 0x4000, | |
57 | FE_CAN_QAM_256 = 0x8000, | |
58 | FE_CAN_QAM_AUTO = 0x10000, | |
59 | FE_CAN_TRANSMISSION_MODE_AUTO = 0x20000, | |
60 | FE_CAN_BANDWIDTH_AUTO = 0x40000, | |
61 | FE_CAN_GUARD_INTERVAL_AUTO = 0x80000, | |
62 | FE_CAN_HIERARCHY_AUTO = 0x100000, | |
63 | FE_CAN_8VSB = 0x200000, | |
64 | FE_CAN_16VSB = 0x400000, | |
6b73eeaf | 65 | FE_HAS_EXTENDED_CAPS = 0x800000, // We need more bitspace for newer APIs, indicate this. |
1da177e4 LT |
66 | FE_NEEDS_BENDING = 0x20000000, // not supported anymore, don't use (frontend requires frequency bending) |
67 | FE_CAN_RECOVER = 0x40000000, // frontend can recover from a cable unplug automatically | |
68 | FE_CAN_MUTE_TS = 0x80000000 // frontend can stop spurious TS data output | |
69 | } fe_caps_t; | |
70 | ||
71 | ||
72 | struct dvb_frontend_info { | |
73 | char name[128]; | |
74 | fe_type_t type; | |
75 | __u32 frequency_min; | |
76 | __u32 frequency_max; | |
77 | __u32 frequency_stepsize; | |
78 | __u32 frequency_tolerance; | |
79 | __u32 symbol_rate_min; | |
80 | __u32 symbol_rate_max; | |
81 | __u32 symbol_rate_tolerance; /* ppm */ | |
82 | __u32 notifier_delay; /* DEPRECATED */ | |
83 | fe_caps_t caps; | |
84 | }; | |
85 | ||
86 | ||
87 | /** | |
88 | * Check out the DiSEqC bus spec available on http://www.eutelsat.org/ for | |
89 | * the meaning of this struct... | |
90 | */ | |
91 | struct dvb_diseqc_master_cmd { | |
92 | __u8 msg [6]; /* { framing, address, command, data [3] } */ | |
93 | __u8 msg_len; /* valid values are 3...6 */ | |
94 | }; | |
95 | ||
96 | ||
97 | struct dvb_diseqc_slave_reply { | |
98 | __u8 msg [4]; /* { framing, data [3] } */ | |
99 | __u8 msg_len; /* valid values are 0...4, 0 means no msg */ | |
100 | int timeout; /* return from ioctl after timeout ms with */ | |
101 | }; /* errorcode when no message was received */ | |
102 | ||
103 | ||
104 | typedef enum fe_sec_voltage { | |
105 | SEC_VOLTAGE_13, | |
106 | SEC_VOLTAGE_18, | |
107 | SEC_VOLTAGE_OFF | |
108 | } fe_sec_voltage_t; | |
109 | ||
110 | ||
111 | typedef enum fe_sec_tone_mode { | |
112 | SEC_TONE_ON, | |
113 | SEC_TONE_OFF | |
114 | } fe_sec_tone_mode_t; | |
115 | ||
116 | ||
117 | typedef enum fe_sec_mini_cmd { | |
118 | SEC_MINI_A, | |
119 | SEC_MINI_B | |
120 | } fe_sec_mini_cmd_t; | |
121 | ||
122 | ||
123 | typedef enum fe_status { | |
124 | FE_HAS_SIGNAL = 0x01, /* found something above the noise level */ | |
125 | FE_HAS_CARRIER = 0x02, /* found a DVB signal */ | |
126 | FE_HAS_VITERBI = 0x04, /* FEC is stable */ | |
127 | FE_HAS_SYNC = 0x08, /* found sync bytes */ | |
128 | FE_HAS_LOCK = 0x10, /* everything's working... */ | |
129 | FE_TIMEDOUT = 0x20, /* no lock within the last ~2 seconds */ | |
130 | FE_REINIT = 0x40 /* frontend was reinitialized, */ | |
131 | } fe_status_t; /* application is recommended to reset */ | |
132 | /* DiSEqC, tone and parameters */ | |
133 | ||
134 | typedef enum fe_spectral_inversion { | |
135 | INVERSION_OFF, | |
136 | INVERSION_ON, | |
137 | INVERSION_AUTO | |
138 | } fe_spectral_inversion_t; | |
139 | ||
140 | ||
141 | typedef enum fe_code_rate { | |
142 | FEC_NONE = 0, | |
143 | FEC_1_2, | |
144 | FEC_2_3, | |
145 | FEC_3_4, | |
146 | FEC_4_5, | |
147 | FEC_5_6, | |
148 | FEC_6_7, | |
149 | FEC_7_8, | |
150 | FEC_8_9, | |
6b73eeaf ST |
151 | FEC_AUTO, |
152 | FEC_3_5, | |
153 | FEC_9_10, | |
1da177e4 LT |
154 | } fe_code_rate_t; |
155 | ||
156 | ||
157 | typedef enum fe_modulation { | |
158 | QPSK, | |
159 | QAM_16, | |
160 | QAM_32, | |
161 | QAM_64, | |
162 | QAM_128, | |
163 | QAM_256, | |
164 | QAM_AUTO, | |
165 | VSB_8, | |
6b73eeaf | 166 | VSB_16, |
0a6393ae ST |
167 | PSK_8, |
168 | APSK_16, | |
6b73eeaf | 169 | DQPSK, |
1da177e4 LT |
170 | } fe_modulation_t; |
171 | ||
172 | typedef enum fe_transmit_mode { | |
173 | TRANSMISSION_MODE_2K, | |
174 | TRANSMISSION_MODE_8K, | |
175 | TRANSMISSION_MODE_AUTO | |
176 | } fe_transmit_mode_t; | |
177 | ||
178 | typedef enum fe_bandwidth { | |
179 | BANDWIDTH_8_MHZ, | |
180 | BANDWIDTH_7_MHZ, | |
181 | BANDWIDTH_6_MHZ, | |
182 | BANDWIDTH_AUTO | |
183 | } fe_bandwidth_t; | |
184 | ||
185 | ||
186 | typedef enum fe_guard_interval { | |
187 | GUARD_INTERVAL_1_32, | |
188 | GUARD_INTERVAL_1_16, | |
189 | GUARD_INTERVAL_1_8, | |
190 | GUARD_INTERVAL_1_4, | |
191 | GUARD_INTERVAL_AUTO | |
192 | } fe_guard_interval_t; | |
193 | ||
194 | ||
195 | typedef enum fe_hierarchy { | |
196 | HIERARCHY_NONE, | |
197 | HIERARCHY_1, | |
198 | HIERARCHY_2, | |
199 | HIERARCHY_4, | |
200 | HIERARCHY_AUTO | |
201 | } fe_hierarchy_t; | |
202 | ||
203 | ||
204 | struct dvb_qpsk_parameters { | |
205 | __u32 symbol_rate; /* symbol rate in Symbols per second */ | |
206 | fe_code_rate_t fec_inner; /* forward error correction (see above) */ | |
207 | }; | |
208 | ||
209 | struct dvb_qam_parameters { | |
210 | __u32 symbol_rate; /* symbol rate in Symbols per second */ | |
211 | fe_code_rate_t fec_inner; /* forward error correction (see above) */ | |
212 | fe_modulation_t modulation; /* modulation type (see above) */ | |
213 | }; | |
214 | ||
215 | struct dvb_vsb_parameters { | |
216 | fe_modulation_t modulation; /* modulation type (see above) */ | |
217 | }; | |
218 | ||
219 | struct dvb_ofdm_parameters { | |
220 | fe_bandwidth_t bandwidth; | |
221 | fe_code_rate_t code_rate_HP; /* high priority stream code rate */ | |
222 | fe_code_rate_t code_rate_LP; /* low priority stream code rate */ | |
223 | fe_modulation_t constellation; /* modulation type (see above) */ | |
224 | fe_transmit_mode_t transmission_mode; | |
225 | fe_guard_interval_t guard_interval; | |
226 | fe_hierarchy_t hierarchy_information; | |
227 | }; | |
228 | ||
229 | ||
230 | struct dvb_frontend_parameters { | |
231 | __u32 frequency; /* (absolute) frequency in Hz for QAM/OFDM/ATSC */ | |
232 | /* intermediate frequency in kHz for QPSK */ | |
233 | fe_spectral_inversion_t inversion; | |
234 | union { | |
235 | struct dvb_qpsk_parameters qpsk; | |
236 | struct dvb_qam_parameters qam; | |
237 | struct dvb_ofdm_parameters ofdm; | |
238 | struct dvb_vsb_parameters vsb; | |
239 | } u; | |
240 | }; | |
241 | ||
242 | ||
243 | struct dvb_frontend_event { | |
244 | fe_status_t status; | |
245 | struct dvb_frontend_parameters parameters; | |
246 | }; | |
247 | ||
459702bf ST |
248 | /* S2API Commands */ |
249 | #define DTV_UNDEFINED 0 | |
250 | #define DTV_TUNE 1 | |
251 | #define DTV_CLEAR 2 | |
252 | #define DTV_FREQUENCY 3 | |
253 | #define DTV_MODULATION 4 | |
254 | #define DTV_BANDWIDTH_HZ 5 | |
255 | #define DTV_INVERSION 6 | |
256 | #define DTV_DISEQC_MASTER 7 | |
257 | #define DTV_SYMBOL_RATE 8 | |
258 | #define DTV_INNER_FEC 9 | |
259 | #define DTV_VOLTAGE 10 | |
260 | #define DTV_TONE 11 | |
261 | #define DTV_PILOT 12 | |
262 | #define DTV_ROLLOFF 13 | |
263 | #define DTV_DISEQC_SLAVE_REPLY 14 | |
264 | ||
265 | /* Basic enumeration set for querying unlimited capabilities */ | |
266 | #define DTV_FE_CAPABILITY_COUNT 15 | |
267 | #define DTV_FE_CAPABILITY 16 | |
268 | #define DTV_DELIVERY_SYSTEM 17 | |
269 | ||
eacf8d8d | 270 | #define DTV_API_VERSION 35 |
a4de91be ST |
271 | #define DTV_API_VERSION 35 |
272 | #define DTV_CODE_RATE_HP 36 | |
273 | #define DTV_CODE_RATE_LP 37 | |
b87625f0 ST |
274 | #define DTV_GUARD_INTERVAL 38 |
275 | #define DTV_TRANSMISSION_MODE 39 | |
ef526f42 | 276 | #define DTV_HIERARCHY 40 |
6b73eeaf | 277 | |
ef526f42 | 278 | #define DTV_MAX_COMMAND DTV_HIERARCHY |
82d7669d | 279 | |
6b73eeaf ST |
280 | typedef enum fe_pilot { |
281 | PILOT_ON, | |
282 | PILOT_OFF, | |
283 | PILOT_AUTO, | |
284 | } fe_pilot_t; | |
285 | ||
286 | typedef enum fe_rolloff { | |
a52f68c6 | 287 | ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */ |
6b73eeaf ST |
288 | ROLLOFF_20, |
289 | ROLLOFF_25, | |
6b73eeaf ST |
290 | ROLLOFF_AUTO, |
291 | } fe_rolloff_t; | |
292 | ||
293 | typedef enum fe_delivery_system { | |
294 | SYS_UNDEFINED, | |
295 | SYS_DVBC_ANNEX_AC, | |
296 | SYS_DVBC_ANNEX_B, | |
297 | SYS_DVBT, | |
298 | SYS_DVBS, | |
299 | SYS_DVBS2, | |
300 | SYS_DVBH, | |
301 | SYS_ISDBT, | |
302 | SYS_ISDBS, | |
303 | SYS_ISDBC, | |
304 | SYS_ATSC, | |
305 | SYS_ATSCMH, | |
306 | SYS_DMBTH, | |
307 | SYS_CMMB, | |
308 | SYS_DAB, | |
309 | } fe_delivery_system_t; | |
310 | ||
56f0680a | 311 | struct dtv_cmds_h { |
6b73eeaf ST |
312 | char *name; /* A display name for debugging purposes */ |
313 | ||
314 | __u32 cmd; /* A unique ID */ | |
315 | ||
316 | /* Flags */ | |
317 | __u32 set:1; /* Either a set or get property */ | |
318 | __u32 buffer:1; /* Does this property use the buffer? */ | |
319 | __u32 reserved:30; /* Align */ | |
320 | }; | |
321 | ||
e7fee0f3 | 322 | struct dtv_property { |
6b73eeaf | 323 | __u32 cmd; |
e7fee0f3 | 324 | __u32 reserved[3]; |
6b73eeaf ST |
325 | union { |
326 | __u32 data; | |
327 | struct { | |
328 | __u8 data[32]; | |
329 | __u32 len; | |
e7fee0f3 ST |
330 | __u32 reserved1[3]; |
331 | void *reserved2; | |
6b73eeaf ST |
332 | } buffer; |
333 | } u; | |
d48cb402 | 334 | int result; |
e7fee0f3 | 335 | } __attribute__ ((packed)); |
6b73eeaf | 336 | |
cc7d705e BP |
337 | /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */ |
338 | #define DTV_IOCTL_MAX_MSGS 64 | |
339 | ||
e7fee0f3 ST |
340 | struct dtv_properties { |
341 | __u32 num; | |
342 | struct dtv_property *props; | |
343 | }; | |
344 | ||
e7fee0f3 ST |
345 | #define FE_SET_PROPERTY _IOW('o', 82, struct dtv_properties) |
346 | #define FE_GET_PROPERTY _IOR('o', 83, struct dtv_properties) | |
6b73eeaf | 347 | |
1da177e4 | 348 | |
36cb557a AQ |
349 | /** |
350 | * When set, this flag will disable any zigzagging or other "normal" tuning | |
351 | * behaviour. Additionally, there will be no automatic monitoring of the lock | |
352 | * status, and hence no frontend events will be generated. If a frontend device | |
353 | * is closed, this flag will be automatically turned off when the device is | |
354 | * reopened read-write. | |
355 | */ | |
356 | #define FE_TUNE_MODE_ONESHOT 0x01 | |
357 | ||
1da177e4 LT |
358 | |
359 | #define FE_GET_INFO _IOR('o', 61, struct dvb_frontend_info) | |
360 | ||
361 | #define FE_DISEQC_RESET_OVERLOAD _IO('o', 62) | |
362 | #define FE_DISEQC_SEND_MASTER_CMD _IOW('o', 63, struct dvb_diseqc_master_cmd) | |
363 | #define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply) | |
364 | #define FE_DISEQC_SEND_BURST _IO('o', 65) /* fe_sec_mini_cmd_t */ | |
365 | ||
366 | #define FE_SET_TONE _IO('o', 66) /* fe_sec_tone_mode_t */ | |
367 | #define FE_SET_VOLTAGE _IO('o', 67) /* fe_sec_voltage_t */ | |
368 | #define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68) /* int */ | |
369 | ||
370 | #define FE_READ_STATUS _IOR('o', 69, fe_status_t) | |
371 | #define FE_READ_BER _IOR('o', 70, __u32) | |
372 | #define FE_READ_SIGNAL_STRENGTH _IOR('o', 71, __u16) | |
373 | #define FE_READ_SNR _IOR('o', 72, __u16) | |
374 | #define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32) | |
375 | ||
376 | #define FE_SET_FRONTEND _IOW('o', 76, struct dvb_frontend_parameters) | |
377 | #define FE_GET_FRONTEND _IOR('o', 77, struct dvb_frontend_parameters) | |
36cb557a | 378 | #define FE_SET_FRONTEND_TUNE_MODE _IO('o', 81) /* unsigned int */ |
1da177e4 LT |
379 | #define FE_GET_EVENT _IOR('o', 78, struct dvb_frontend_event) |
380 | ||
381 | #define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */ | |
382 | ||
383 | #endif /*_DVBFRONTEND_H_*/ |