]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/dvb/frontend.h
V4L/DVB (10164): Add missing S2 caps flag to S2API
[mirror_ubuntu-bionic-kernel.git] / include / linux / dvb / frontend.h
CommitLineData
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
32typedef enum fe_type {
33 FE_QPSK,
34 FE_QAM,
35 FE_OFDM,
36 FE_ATSC
37} fe_type_t;
38
39
40typedef 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.
cb889a2f 66 FE_CAN_2G_MODULATION = 0x10000000, // frontend supports "2nd generation modulation" (DVB-S2)
1da177e4
LT
67 FE_NEEDS_BENDING = 0x20000000, // not supported anymore, don't use (frontend requires frequency bending)
68 FE_CAN_RECOVER = 0x40000000, // frontend can recover from a cable unplug automatically
69 FE_CAN_MUTE_TS = 0x80000000 // frontend can stop spurious TS data output
70} fe_caps_t;
71
72
73struct dvb_frontend_info {
74 char name[128];
75 fe_type_t type;
76 __u32 frequency_min;
77 __u32 frequency_max;
78 __u32 frequency_stepsize;
79 __u32 frequency_tolerance;
80 __u32 symbol_rate_min;
81 __u32 symbol_rate_max;
82 __u32 symbol_rate_tolerance; /* ppm */
83 __u32 notifier_delay; /* DEPRECATED */
84 fe_caps_t caps;
85};
86
87
88/**
89 * Check out the DiSEqC bus spec available on http://www.eutelsat.org/ for
90 * the meaning of this struct...
91 */
92struct dvb_diseqc_master_cmd {
93 __u8 msg [6]; /* { framing, address, command, data [3] } */
94 __u8 msg_len; /* valid values are 3...6 */
95};
96
97
98struct dvb_diseqc_slave_reply {
99 __u8 msg [4]; /* { framing, data [3] } */
100 __u8 msg_len; /* valid values are 0...4, 0 means no msg */
101 int timeout; /* return from ioctl after timeout ms with */
102}; /* errorcode when no message was received */
103
104
105typedef enum fe_sec_voltage {
106 SEC_VOLTAGE_13,
107 SEC_VOLTAGE_18,
108 SEC_VOLTAGE_OFF
109} fe_sec_voltage_t;
110
111
112typedef enum fe_sec_tone_mode {
113 SEC_TONE_ON,
114 SEC_TONE_OFF
115} fe_sec_tone_mode_t;
116
117
118typedef enum fe_sec_mini_cmd {
119 SEC_MINI_A,
120 SEC_MINI_B
121} fe_sec_mini_cmd_t;
122
123
124typedef enum fe_status {
125 FE_HAS_SIGNAL = 0x01, /* found something above the noise level */
126 FE_HAS_CARRIER = 0x02, /* found a DVB signal */
127 FE_HAS_VITERBI = 0x04, /* FEC is stable */
128 FE_HAS_SYNC = 0x08, /* found sync bytes */
129 FE_HAS_LOCK = 0x10, /* everything's working... */
130 FE_TIMEDOUT = 0x20, /* no lock within the last ~2 seconds */
131 FE_REINIT = 0x40 /* frontend was reinitialized, */
132} fe_status_t; /* application is recommended to reset */
133 /* DiSEqC, tone and parameters */
134
135typedef enum fe_spectral_inversion {
136 INVERSION_OFF,
137 INVERSION_ON,
138 INVERSION_AUTO
139} fe_spectral_inversion_t;
140
141
142typedef enum fe_code_rate {
143 FEC_NONE = 0,
144 FEC_1_2,
145 FEC_2_3,
146 FEC_3_4,
147 FEC_4_5,
148 FEC_5_6,
149 FEC_6_7,
150 FEC_7_8,
151 FEC_8_9,
6b73eeaf
ST
152 FEC_AUTO,
153 FEC_3_5,
154 FEC_9_10,
1da177e4
LT
155} fe_code_rate_t;
156
157
158typedef enum fe_modulation {
159 QPSK,
160 QAM_16,
161 QAM_32,
162 QAM_64,
163 QAM_128,
164 QAM_256,
165 QAM_AUTO,
166 VSB_8,
6b73eeaf 167 VSB_16,
0a6393ae
ST
168 PSK_8,
169 APSK_16,
97854829 170 APSK_32,
6b73eeaf 171 DQPSK,
1da177e4
LT
172} fe_modulation_t;
173
174typedef enum fe_transmit_mode {
175 TRANSMISSION_MODE_2K,
176 TRANSMISSION_MODE_8K,
177 TRANSMISSION_MODE_AUTO
178} fe_transmit_mode_t;
179
180typedef enum fe_bandwidth {
181 BANDWIDTH_8_MHZ,
182 BANDWIDTH_7_MHZ,
183 BANDWIDTH_6_MHZ,
184 BANDWIDTH_AUTO
185} fe_bandwidth_t;
186
187
188typedef enum fe_guard_interval {
189 GUARD_INTERVAL_1_32,
190 GUARD_INTERVAL_1_16,
191 GUARD_INTERVAL_1_8,
192 GUARD_INTERVAL_1_4,
193 GUARD_INTERVAL_AUTO
194} fe_guard_interval_t;
195
196
197typedef enum fe_hierarchy {
198 HIERARCHY_NONE,
199 HIERARCHY_1,
200 HIERARCHY_2,
201 HIERARCHY_4,
202 HIERARCHY_AUTO
203} fe_hierarchy_t;
204
205
206struct dvb_qpsk_parameters {
207 __u32 symbol_rate; /* symbol rate in Symbols per second */
208 fe_code_rate_t fec_inner; /* forward error correction (see above) */
209};
210
211struct dvb_qam_parameters {
212 __u32 symbol_rate; /* symbol rate in Symbols per second */
213 fe_code_rate_t fec_inner; /* forward error correction (see above) */
214 fe_modulation_t modulation; /* modulation type (see above) */
215};
216
217struct dvb_vsb_parameters {
218 fe_modulation_t modulation; /* modulation type (see above) */
219};
220
221struct dvb_ofdm_parameters {
222 fe_bandwidth_t bandwidth;
223 fe_code_rate_t code_rate_HP; /* high priority stream code rate */
224 fe_code_rate_t code_rate_LP; /* low priority stream code rate */
225 fe_modulation_t constellation; /* modulation type (see above) */
226 fe_transmit_mode_t transmission_mode;
227 fe_guard_interval_t guard_interval;
228 fe_hierarchy_t hierarchy_information;
229};
230
231
232struct dvb_frontend_parameters {
233 __u32 frequency; /* (absolute) frequency in Hz for QAM/OFDM/ATSC */
234 /* intermediate frequency in kHz for QPSK */
235 fe_spectral_inversion_t inversion;
236 union {
237 struct dvb_qpsk_parameters qpsk;
238 struct dvb_qam_parameters qam;
239 struct dvb_ofdm_parameters ofdm;
240 struct dvb_vsb_parameters vsb;
241 } u;
242};
243
244
245struct dvb_frontend_event {
246 fe_status_t status;
247 struct dvb_frontend_parameters parameters;
248};
249
459702bf
ST
250/* S2API Commands */
251#define DTV_UNDEFINED 0
252#define DTV_TUNE 1
253#define DTV_CLEAR 2
254#define DTV_FREQUENCY 3
255#define DTV_MODULATION 4
256#define DTV_BANDWIDTH_HZ 5
257#define DTV_INVERSION 6
258#define DTV_DISEQC_MASTER 7
259#define DTV_SYMBOL_RATE 8
260#define DTV_INNER_FEC 9
261#define DTV_VOLTAGE 10
262#define DTV_TONE 11
263#define DTV_PILOT 12
264#define DTV_ROLLOFF 13
265#define DTV_DISEQC_SLAVE_REPLY 14
266
267/* Basic enumeration set for querying unlimited capabilities */
268#define DTV_FE_CAPABILITY_COUNT 15
269#define DTV_FE_CAPABILITY 16
270#define DTV_DELIVERY_SYSTEM 17
271
eacf8d8d 272#define DTV_API_VERSION 35
a4de91be
ST
273#define DTV_API_VERSION 35
274#define DTV_CODE_RATE_HP 36
275#define DTV_CODE_RATE_LP 37
b87625f0
ST
276#define DTV_GUARD_INTERVAL 38
277#define DTV_TRANSMISSION_MODE 39
ef526f42 278#define DTV_HIERARCHY 40
6b73eeaf 279
ef526f42 280#define DTV_MAX_COMMAND DTV_HIERARCHY
82d7669d 281
6b73eeaf
ST
282typedef enum fe_pilot {
283 PILOT_ON,
284 PILOT_OFF,
285 PILOT_AUTO,
286} fe_pilot_t;
287
288typedef enum fe_rolloff {
a52f68c6 289 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
6b73eeaf
ST
290 ROLLOFF_20,
291 ROLLOFF_25,
6b73eeaf
ST
292 ROLLOFF_AUTO,
293} fe_rolloff_t;
294
295typedef enum fe_delivery_system {
296 SYS_UNDEFINED,
297 SYS_DVBC_ANNEX_AC,
298 SYS_DVBC_ANNEX_B,
299 SYS_DVBT,
5ba4ecc8 300 SYS_DSS,
6b73eeaf
ST
301 SYS_DVBS,
302 SYS_DVBS2,
303 SYS_DVBH,
304 SYS_ISDBT,
305 SYS_ISDBS,
306 SYS_ISDBC,
307 SYS_ATSC,
308 SYS_ATSCMH,
309 SYS_DMBTH,
310 SYS_CMMB,
311 SYS_DAB,
312} fe_delivery_system_t;
313
56f0680a 314struct dtv_cmds_h {
6b73eeaf
ST
315 char *name; /* A display name for debugging purposes */
316
317 __u32 cmd; /* A unique ID */
318
319 /* Flags */
320 __u32 set:1; /* Either a set or get property */
321 __u32 buffer:1; /* Does this property use the buffer? */
322 __u32 reserved:30; /* Align */
323};
324
e7fee0f3 325struct dtv_property {
6b73eeaf 326 __u32 cmd;
e7fee0f3 327 __u32 reserved[3];
6b73eeaf
ST
328 union {
329 __u32 data;
330 struct {
331 __u8 data[32];
332 __u32 len;
e7fee0f3
ST
333 __u32 reserved1[3];
334 void *reserved2;
6b73eeaf
ST
335 } buffer;
336 } u;
d48cb402 337 int result;
e7fee0f3 338} __attribute__ ((packed));
6b73eeaf 339
cc7d705e
BP
340/* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
341#define DTV_IOCTL_MAX_MSGS 64
342
e7fee0f3
ST
343struct dtv_properties {
344 __u32 num;
345 struct dtv_property *props;
346};
347
e7fee0f3
ST
348#define FE_SET_PROPERTY _IOW('o', 82, struct dtv_properties)
349#define FE_GET_PROPERTY _IOR('o', 83, struct dtv_properties)
6b73eeaf 350
1da177e4 351
36cb557a
AQ
352/**
353 * When set, this flag will disable any zigzagging or other "normal" tuning
354 * behaviour. Additionally, there will be no automatic monitoring of the lock
355 * status, and hence no frontend events will be generated. If a frontend device
356 * is closed, this flag will be automatically turned off when the device is
357 * reopened read-write.
358 */
359#define FE_TUNE_MODE_ONESHOT 0x01
360
1da177e4
LT
361
362#define FE_GET_INFO _IOR('o', 61, struct dvb_frontend_info)
363
364#define FE_DISEQC_RESET_OVERLOAD _IO('o', 62)
365#define FE_DISEQC_SEND_MASTER_CMD _IOW('o', 63, struct dvb_diseqc_master_cmd)
366#define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply)
367#define FE_DISEQC_SEND_BURST _IO('o', 65) /* fe_sec_mini_cmd_t */
368
369#define FE_SET_TONE _IO('o', 66) /* fe_sec_tone_mode_t */
370#define FE_SET_VOLTAGE _IO('o', 67) /* fe_sec_voltage_t */
371#define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68) /* int */
372
373#define FE_READ_STATUS _IOR('o', 69, fe_status_t)
374#define FE_READ_BER _IOR('o', 70, __u32)
375#define FE_READ_SIGNAL_STRENGTH _IOR('o', 71, __u16)
376#define FE_READ_SNR _IOR('o', 72, __u16)
377#define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32)
378
379#define FE_SET_FRONTEND _IOW('o', 76, struct dvb_frontend_parameters)
380#define FE_GET_FRONTEND _IOR('o', 77, struct dvb_frontend_parameters)
36cb557a 381#define FE_SET_FRONTEND_TUNE_MODE _IO('o', 81) /* unsigned int */
1da177e4
LT
382#define FE_GET_EVENT _IOR('o', 78, struct dvb_frontend_event)
383
384#define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */
385
386#endif /*_DVBFRONTEND_H_*/