Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 <linux/types.h>
30
31typedef enum fe_type {
32 FE_QPSK,
33 FE_QAM,
34 FE_OFDM,
35 FE_ATSC
36} fe_type_t;
37
38
39typedef enum fe_caps {
40 FE_IS_STUPID = 0,
41 FE_CAN_INVERSION_AUTO = 0x1,
42 FE_CAN_FEC_1_2 = 0x2,
43 FE_CAN_FEC_2_3 = 0x4,
44 FE_CAN_FEC_3_4 = 0x8,
45 FE_CAN_FEC_4_5 = 0x10,
46 FE_CAN_FEC_5_6 = 0x20,
47 FE_CAN_FEC_6_7 = 0x40,
48 FE_CAN_FEC_7_8 = 0x80,
49 FE_CAN_FEC_8_9 = 0x100,
50 FE_CAN_FEC_AUTO = 0x200,
51 FE_CAN_QPSK = 0x400,
52 FE_CAN_QAM_16 = 0x800,
53 FE_CAN_QAM_32 = 0x1000,
54 FE_CAN_QAM_64 = 0x2000,
55 FE_CAN_QAM_128 = 0x4000,
56 FE_CAN_QAM_256 = 0x8000,
57 FE_CAN_QAM_AUTO = 0x10000,
58 FE_CAN_TRANSMISSION_MODE_AUTO = 0x20000,
59 FE_CAN_BANDWIDTH_AUTO = 0x40000,
60 FE_CAN_GUARD_INTERVAL_AUTO = 0x80000,
61 FE_CAN_HIERARCHY_AUTO = 0x100000,
62 FE_CAN_8VSB = 0x200000,
63 FE_CAN_16VSB = 0x400000,
64 FE_HAS_EXTENDED_CAPS = 0x800000, /* We need more bitspace for newer APIs, indicate this. */
65 FE_CAN_2G_MODULATION = 0x10000000, /* frontend supports "2nd generation modulation" (DVB-S2) */
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
72struct 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 */
91struct 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
97struct 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
104typedef enum fe_sec_voltage {
105 SEC_VOLTAGE_13,
106 SEC_VOLTAGE_18,
107 SEC_VOLTAGE_OFF
108} fe_sec_voltage_t;
109
110
111typedef enum fe_sec_tone_mode {
112 SEC_TONE_ON,
113 SEC_TONE_OFF
114} fe_sec_tone_mode_t;
115
116
117typedef enum fe_sec_mini_cmd {
118 SEC_MINI_A,
119 SEC_MINI_B
120} fe_sec_mini_cmd_t;
121
122
123typedef 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
134typedef enum fe_spectral_inversion {
135 INVERSION_OFF,
136 INVERSION_ON,
137 INVERSION_AUTO
138} fe_spectral_inversion_t;
139
140
141typedef 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,
151 FEC_AUTO,
152 FEC_3_5,
153 FEC_9_10,
154} fe_code_rate_t;
155
156
157typedef 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,
166 VSB_16,
167 PSK_8,
168 APSK_16,
169 APSK_32,
170 DQPSK,
171} fe_modulation_t;
172
173typedef enum fe_transmit_mode {
174 TRANSMISSION_MODE_2K,
175 TRANSMISSION_MODE_8K,
176 TRANSMISSION_MODE_AUTO,
177 TRANSMISSION_MODE_4K
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
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
272/* ISDB-T and ISDB-Tsb */
273#define DTV_ISDBT_PARTIAL_RECEPTION 18
274#define DTV_ISDBT_SOUND_BROADCASTING 19
275
276#define DTV_ISDBT_SB_SUBCHANNEL_ID 20
277#define DTV_ISDBT_SB_SEGMENT_IDX 21
278#define DTV_ISDBT_SB_SEGMENT_COUNT 22
279
280#define DTV_ISDBT_LAYERA_FEC 23
281#define DTV_ISDBT_LAYERA_MODULATION 24
282#define DTV_ISDBT_LAYERA_SEGMENT_COUNT 25
283#define DTV_ISDBT_LAYERA_TIME_INTERLEAVING 26
284
285#define DTV_ISDBT_LAYERB_FEC 27
286#define DTV_ISDBT_LAYERB_MODULATION 28
287#define DTV_ISDBT_LAYERB_SEGMENT_COUNT 29
288#define DTV_ISDBT_LAYERB_TIME_INTERLEAVING 30
289
290#define DTV_ISDBT_LAYERC_FEC 31
291#define DTV_ISDBT_LAYERC_MODULATION 32
292#define DTV_ISDBT_LAYERC_SEGMENT_COUNT 33
293#define DTV_ISDBT_LAYERC_TIME_INTERLEAVING 34
294
295#define DTV_API_VERSION 35
296
297#define DTV_CODE_RATE_HP 36
298#define DTV_CODE_RATE_LP 37
299#define DTV_GUARD_INTERVAL 38
300#define DTV_TRANSMISSION_MODE 39
301#define DTV_HIERARCHY 40
302
303#define DTV_ISDBT_LAYER_ENABLED 41
304
305#define DTV_ISDBS_TS_ID 42
306
307#define DTV_MAX_COMMAND DTV_ISDBS_TS_ID
308
309typedef enum fe_pilot {
310 PILOT_ON,
311 PILOT_OFF,
312 PILOT_AUTO,
313} fe_pilot_t;
314
315typedef enum fe_rolloff {
316 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
317 ROLLOFF_20,
318 ROLLOFF_25,
319 ROLLOFF_AUTO,
320} fe_rolloff_t;
321
322typedef enum fe_delivery_system {
323 SYS_UNDEFINED,
324 SYS_DVBC_ANNEX_AC,
325 SYS_DVBC_ANNEX_B,
326 SYS_DVBT,
327 SYS_DSS,
328 SYS_DVBS,
329 SYS_DVBS2,
330 SYS_DVBH,
331 SYS_ISDBT,
332 SYS_ISDBS,
333 SYS_ISDBC,
334 SYS_ATSC,
335 SYS_ATSCMH,
336 SYS_DMBTH,
337 SYS_CMMB,
338 SYS_DAB,
339} fe_delivery_system_t;
340
341struct dtv_cmds_h {
342 char *name; /* A display name for debugging purposes */
343
344 __u32 cmd; /* A unique ID */
345
346 /* Flags */
347 __u32 set:1; /* Either a set or get property */
348 __u32 buffer:1; /* Does this property use the buffer? */
349 __u32 reserved:30; /* Align */
350};
351
352struct dtv_property {
353 __u32 cmd;
354 __u32 reserved[3];
355 union {
356 __u32 data;
357 struct {
358 __u8 data[32];
359 __u32 len;
360 __u32 reserved1[3];
361 void *reserved2;
362 } buffer;
363 } u;
364 int result;
365} __attribute__ ((packed));
366
367/* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
368#define DTV_IOCTL_MAX_MSGS 64
369
370struct dtv_properties {
371 __u32 num;
372 struct dtv_property *props;
373};
374
375#define FE_SET_PROPERTY _IOW('o', 82, struct dtv_properties)
376#define FE_GET_PROPERTY _IOR('o', 83, struct dtv_properties)
377
378
379/**
380 * When set, this flag will disable any zigzagging or other "normal" tuning
381 * behaviour. Additionally, there will be no automatic monitoring of the lock
382 * status, and hence no frontend events will be generated. If a frontend device
383 * is closed, this flag will be automatically turned off when the device is
384 * reopened read-write.
385 */
386#define FE_TUNE_MODE_ONESHOT 0x01
387
388
389#define FE_GET_INFO _IOR('o', 61, struct dvb_frontend_info)
390
391#define FE_DISEQC_RESET_OVERLOAD _IO('o', 62)
392#define FE_DISEQC_SEND_MASTER_CMD _IOW('o', 63, struct dvb_diseqc_master_cmd)
393#define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply)
394#define FE_DISEQC_SEND_BURST _IO('o', 65) /* fe_sec_mini_cmd_t */
395
396#define FE_SET_TONE _IO('o', 66) /* fe_sec_tone_mode_t */
397#define FE_SET_VOLTAGE _IO('o', 67) /* fe_sec_voltage_t */
398#define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68) /* int */
399
400#define FE_READ_STATUS _IOR('o', 69, fe_status_t)
401#define FE_READ_BER _IOR('o', 70, __u32)
402#define FE_READ_SIGNAL_STRENGTH _IOR('o', 71, __u16)
403#define FE_READ_SNR _IOR('o', 72, __u16)
404#define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32)
405
406#define FE_SET_FRONTEND _IOW('o', 76, struct dvb_frontend_parameters)
407#define FE_GET_FRONTEND _IOR('o', 77, struct dvb_frontend_parameters)
408#define FE_SET_FRONTEND_TUNE_MODE _IO('o', 81) /* unsigned int */
409#define FE_GET_EVENT _IOR('o', 78, struct dvb_frontend_event)
410
411#define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */
412
413#endif /*_DVBFRONTEND_H_*/