blob: a36d802fae0cba276bc4dc98d5a6d7ac91a6bf3a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Jaswinder Singh Rajputde189f02009-01-30 19:56:41 +053029#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Mauro Carvalho Chehabfe557e42015-06-07 14:31:13 -030031enum fe_type {
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 FE_QPSK,
33 FE_QAM,
34 FE_OFDM,
35 FE_ATSC
Mauro Carvalho Chehabfe557e42015-06-07 14:31:13 -030036};
37
38typedef enum fe_type fe_type_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40
Mauro Carvalho Chehab97f411d2015-05-26 07:34:21 -030041enum fe_caps {
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 FE_IS_STUPID = 0,
43 FE_CAN_INVERSION_AUTO = 0x1,
44 FE_CAN_FEC_1_2 = 0x2,
45 FE_CAN_FEC_2_3 = 0x4,
46 FE_CAN_FEC_3_4 = 0x8,
47 FE_CAN_FEC_4_5 = 0x10,
48 FE_CAN_FEC_5_6 = 0x20,
49 FE_CAN_FEC_6_7 = 0x40,
50 FE_CAN_FEC_7_8 = 0x80,
51 FE_CAN_FEC_8_9 = 0x100,
52 FE_CAN_FEC_AUTO = 0x200,
53 FE_CAN_QPSK = 0x400,
54 FE_CAN_QAM_16 = 0x800,
55 FE_CAN_QAM_32 = 0x1000,
56 FE_CAN_QAM_64 = 0x2000,
57 FE_CAN_QAM_128 = 0x4000,
58 FE_CAN_QAM_256 = 0x8000,
59 FE_CAN_QAM_AUTO = 0x10000,
60 FE_CAN_TRANSMISSION_MODE_AUTO = 0x20000,
61 FE_CAN_BANDWIDTH_AUTO = 0x40000,
62 FE_CAN_GUARD_INTERVAL_AUTO = 0x80000,
63 FE_CAN_HIERARCHY_AUTO = 0x100000,
64 FE_CAN_8VSB = 0x200000,
65 FE_CAN_16VSB = 0x400000,
Mauro Carvalho Chehabe4cda3e2008-12-31 14:26:57 -030066 FE_HAS_EXTENDED_CAPS = 0x800000, /* We need more bitspace for newer APIs, indicate this. */
Evgeny Plehov287cefd2012-09-13 10:13:30 -030067 FE_CAN_MULTISTREAM = 0x4000000, /* frontend supports multistream filtering */
Klaus Schmidingerf6a20eb2010-07-01 01:37:34 -030068 FE_CAN_TURBO_FEC = 0x8000000, /* frontend supports "turbo fec modulation" */
Mauro Carvalho Chehabe4cda3e2008-12-31 14:26:57 -030069 FE_CAN_2G_MODULATION = 0x10000000, /* frontend supports "2nd generation modulation" (DVB-S2) */
70 FE_NEEDS_BENDING = 0x20000000, /* not supported anymore, don't use (frontend requires frequency bending) */
71 FE_CAN_RECOVER = 0x40000000, /* frontend can recover from a cable unplug automatically */
72 FE_CAN_MUTE_TS = 0x80000000 /* frontend can stop spurious TS data output */
Mauro Carvalho Chehab97f411d2015-05-26 07:34:21 -030073};
74
75typedef enum fe_caps fe_caps_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77
78struct dvb_frontend_info {
79 char name[128];
Mauro Carvalho Chehabcd7d4942012-01-01 16:11:17 -030080 fe_type_t type; /* DEPRECATED. Use DTV_ENUM_DELSYS instead */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 __u32 frequency_min;
82 __u32 frequency_max;
83 __u32 frequency_stepsize;
84 __u32 frequency_tolerance;
85 __u32 symbol_rate_min;
86 __u32 symbol_rate_max;
87 __u32 symbol_rate_tolerance; /* ppm */
88 __u32 notifier_delay; /* DEPRECATED */
89 fe_caps_t caps;
90};
91
92
93/**
94 * Check out the DiSEqC bus spec available on http://www.eutelsat.org/ for
95 * the meaning of this struct...
96 */
97struct dvb_diseqc_master_cmd {
98 __u8 msg [6]; /* { framing, address, command, data [3] } */
99 __u8 msg_len; /* valid values are 3...6 */
100};
101
102
103struct dvb_diseqc_slave_reply {
104 __u8 msg [4]; /* { framing, data [3] } */
105 __u8 msg_len; /* valid values are 0...4, 0 means no msg */
106 int timeout; /* return from ioctl after timeout ms with */
107}; /* errorcode when no message was received */
108
109
Mauro Carvalho Chehabd6b6d342015-05-26 19:33:58 -0300110enum fe_sec_voltage {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 SEC_VOLTAGE_13,
112 SEC_VOLTAGE_18,
113 SEC_VOLTAGE_OFF
Mauro Carvalho Chehabd6b6d342015-05-26 19:33:58 -0300114};
115
116typedef enum fe_sec_voltage fe_sec_voltage_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118
Mauro Carvalho Chehab6dc59e72015-05-27 07:15:50 -0300119enum fe_sec_tone_mode {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 SEC_TONE_ON,
121 SEC_TONE_OFF
Mauro Carvalho Chehab6dc59e72015-05-27 07:15:50 -0300122};
123
124typedef enum fe_sec_tone_mode fe_sec_tone_mode_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126
Mauro Carvalho Chehab81959d92015-05-27 22:20:14 -0300127enum fe_sec_mini_cmd {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 SEC_MINI_A,
129 SEC_MINI_B
Mauro Carvalho Chehab81959d92015-05-27 22:20:14 -0300130};
131
132typedef enum fe_sec_mini_cmd fe_sec_mini_cmd_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134
Mauro Carvalho Chehab0d27bbf2012-08-13 17:03:12 -0300135/**
136 * enum fe_status - enumerates the possible frontend status
137 * @FE_HAS_SIGNAL: found something above the noise level
138 * @FE_HAS_CARRIER: found a DVB signal
139 * @FE_HAS_VITERBI: FEC is stable
140 * @FE_HAS_SYNC: found sync bytes
141 * @FE_HAS_LOCK: everything's working
142 * @FE_TIMEDOUT: no lock within the last ~2 seconds
143 * @FE_REINIT: frontend was reinitialized, application is recommended
144 * to reset DiSEqC, tone and parameters
145 */
146
Mauro Carvalho Chehab97f411d2015-05-26 07:34:21 -0300147enum fe_status {
Mauro Carvalho Chehab0d27bbf2012-08-13 17:03:12 -0300148 FE_HAS_SIGNAL = 0x01,
149 FE_HAS_CARRIER = 0x02,
150 FE_HAS_VITERBI = 0x04,
151 FE_HAS_SYNC = 0x08,
152 FE_HAS_LOCK = 0x10,
153 FE_TIMEDOUT = 0x20,
154 FE_REINIT = 0x40,
Mauro Carvalho Chehab97f411d2015-05-26 07:34:21 -0300155};
156
157typedef enum fe_status fe_status_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
Mauro Carvalho Chehab58e11cc2015-05-28 20:00:43 -0300159enum fe_spectral_inversion {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 INVERSION_OFF,
161 INVERSION_ON,
162 INVERSION_AUTO
Mauro Carvalho Chehab58e11cc2015-05-28 20:00:43 -0300163};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Mauro Carvalho Chehab58e11cc2015-05-28 20:00:43 -0300165typedef enum fe_spectral_inversion fe_spectral_inversion_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Mauro Carvalho Chehab2d457b82015-05-28 21:38:44 -0300167enum fe_code_rate {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 FEC_NONE = 0,
169 FEC_1_2,
170 FEC_2_3,
171 FEC_3_4,
172 FEC_4_5,
173 FEC_5_6,
174 FEC_6_7,
175 FEC_7_8,
176 FEC_8_9,
Steven Toth6b73eea2008-09-04 01:12:25 -0300177 FEC_AUTO,
178 FEC_3_5,
179 FEC_9_10,
Antti Palosaari224b6642012-08-12 22:33:21 -0300180 FEC_2_5,
Mauro Carvalho Chehab2d457b82015-05-28 21:38:44 -0300181};
182
183typedef enum fe_code_rate fe_code_rate_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185
Mauro Carvalho Chehab997eb9032015-05-28 17:21:05 -0300186enum fe_modulation {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 QPSK,
188 QAM_16,
189 QAM_32,
190 QAM_64,
191 QAM_128,
192 QAM_256,
193 QAM_AUTO,
194 VSB_8,
Steven Toth6b73eea2008-09-04 01:12:25 -0300195 VSB_16,
Steven Toth0a6393a2008-10-06 21:06:48 -0300196 PSK_8,
197 APSK_16,
Manu Abraham97854822008-10-14 19:48:07 -0300198 APSK_32,
Steven Toth6b73eea2008-09-04 01:12:25 -0300199 DQPSK,
Antti Palosaari224b6642012-08-12 22:33:21 -0300200 QAM_4_NR,
Mauro Carvalho Chehab997eb9032015-05-28 17:21:05 -0300201};
202
203typedef enum fe_modulation fe_modulation_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Mauro Carvalho Chehab0577a2f2015-05-28 20:52:52 -0300205enum fe_transmit_mode {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 TRANSMISSION_MODE_2K,
207 TRANSMISSION_MODE_8K,
Patrick Boettcherb6e760f2009-08-03 14:39:15 -0300208 TRANSMISSION_MODE_AUTO,
Andreas Oberritter94d56ff2011-05-12 18:11:06 -0300209 TRANSMISSION_MODE_4K,
210 TRANSMISSION_MODE_1K,
211 TRANSMISSION_MODE_16K,
212 TRANSMISSION_MODE_32K,
Antti Palosaari224b6642012-08-12 22:33:21 -0300213 TRANSMISSION_MODE_C1,
214 TRANSMISSION_MODE_C3780,
Mauro Carvalho Chehab0577a2f2015-05-28 20:52:52 -0300215};
216
217typedef enum fe_transmit_mode fe_transmit_mode_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Mauro Carvalho Chehab8de85942011-12-26 20:22:50 -0300219#if defined(__DVB_CORE__) || !defined (__KERNEL__)
Mauro Carvalho Chehabb174fb72015-05-28 20:57:53 -0300220enum fe_bandwidth {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 BANDWIDTH_8_MHZ,
222 BANDWIDTH_7_MHZ,
223 BANDWIDTH_6_MHZ,
Andreas Oberritter94d56ff2011-05-12 18:11:06 -0300224 BANDWIDTH_AUTO,
225 BANDWIDTH_5_MHZ,
226 BANDWIDTH_10_MHZ,
227 BANDWIDTH_1_712_MHZ,
Mauro Carvalho Chehabb174fb72015-05-28 20:57:53 -0300228};
229
230typedef enum fe_bandwidth fe_bandwidth_t;
Mauro Carvalho Chehab8de85942011-12-26 20:22:50 -0300231#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Mauro Carvalho Chehab903142e2015-05-28 22:01:41 -0300233enum fe_guard_interval {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 GUARD_INTERVAL_1_32,
235 GUARD_INTERVAL_1_16,
236 GUARD_INTERVAL_1_8,
237 GUARD_INTERVAL_1_4,
Andreas Oberritter94d56ff2011-05-12 18:11:06 -0300238 GUARD_INTERVAL_AUTO,
239 GUARD_INTERVAL_1_128,
240 GUARD_INTERVAL_19_128,
241 GUARD_INTERVAL_19_256,
Antti Palosaari224b6642012-08-12 22:33:21 -0300242 GUARD_INTERVAL_PN420,
243 GUARD_INTERVAL_PN595,
244 GUARD_INTERVAL_PN945,
Mauro Carvalho Chehab903142e2015-05-28 22:01:41 -0300245};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Mauro Carvalho Chehab903142e2015-05-28 22:01:41 -0300247typedef enum fe_guard_interval fe_guard_interval_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Mauro Carvalho Chehab9df4fc52015-05-28 22:06:56 -0300249enum fe_hierarchy {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 HIERARCHY_NONE,
251 HIERARCHY_1,
252 HIERARCHY_2,
253 HIERARCHY_4,
254 HIERARCHY_AUTO
Mauro Carvalho Chehab9df4fc52015-05-28 22:06:56 -0300255};
256
257typedef enum fe_hierarchy fe_hierarchy_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Antti Palosaari224b6642012-08-12 22:33:21 -0300259enum fe_interleaving {
260 INTERLEAVING_NONE,
Antti Palosaari8746add2012-08-12 22:33:22 -0300261 INTERLEAVING_AUTO,
Antti Palosaari224b6642012-08-12 22:33:21 -0300262 INTERLEAVING_240,
263 INTERLEAVING_720,
264};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Mauro Carvalho Chehab8de85942011-12-26 20:22:50 -0300266#if defined(__DVB_CORE__) || !defined (__KERNEL__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267struct dvb_qpsk_parameters {
268 __u32 symbol_rate; /* symbol rate in Symbols per second */
269 fe_code_rate_t fec_inner; /* forward error correction (see above) */
270};
271
272struct dvb_qam_parameters {
273 __u32 symbol_rate; /* symbol rate in Symbols per second */
274 fe_code_rate_t fec_inner; /* forward error correction (see above) */
275 fe_modulation_t modulation; /* modulation type (see above) */
276};
277
278struct dvb_vsb_parameters {
279 fe_modulation_t modulation; /* modulation type (see above) */
280};
281
282struct dvb_ofdm_parameters {
283 fe_bandwidth_t bandwidth;
284 fe_code_rate_t code_rate_HP; /* high priority stream code rate */
285 fe_code_rate_t code_rate_LP; /* low priority stream code rate */
286 fe_modulation_t constellation; /* modulation type (see above) */
287 fe_transmit_mode_t transmission_mode;
288 fe_guard_interval_t guard_interval;
289 fe_hierarchy_t hierarchy_information;
290};
291
292
293struct dvb_frontend_parameters {
294 __u32 frequency; /* (absolute) frequency in Hz for QAM/OFDM/ATSC */
295 /* intermediate frequency in kHz for QPSK */
296 fe_spectral_inversion_t inversion;
297 union {
298 struct dvb_qpsk_parameters qpsk;
299 struct dvb_qam_parameters qam;
300 struct dvb_ofdm_parameters ofdm;
301 struct dvb_vsb_parameters vsb;
302 } u;
303};
304
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305struct dvb_frontend_event {
306 fe_status_t status;
307 struct dvb_frontend_parameters parameters;
308};
Mauro Carvalho Chehab8de85942011-12-26 20:22:50 -0300309#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
Steven Toth459702b2008-09-26 00:04:52 -0300311/* S2API Commands */
312#define DTV_UNDEFINED 0
313#define DTV_TUNE 1
314#define DTV_CLEAR 2
315#define DTV_FREQUENCY 3
316#define DTV_MODULATION 4
317#define DTV_BANDWIDTH_HZ 5
318#define DTV_INVERSION 6
319#define DTV_DISEQC_MASTER 7
320#define DTV_SYMBOL_RATE 8
321#define DTV_INNER_FEC 9
322#define DTV_VOLTAGE 10
323#define DTV_TONE 11
324#define DTV_PILOT 12
325#define DTV_ROLLOFF 13
326#define DTV_DISEQC_SLAVE_REPLY 14
Steven Toth6b73eea2008-09-04 01:12:25 -0300327
Steven Toth459702b2008-09-26 00:04:52 -0300328/* Basic enumeration set for querying unlimited capabilities */
329#define DTV_FE_CAPABILITY_COUNT 15
330#define DTV_FE_CAPABILITY 16
331#define DTV_DELIVERY_SYSTEM 17
Steven Toth75b7f942008-09-13 16:56:34 -0300332
Patrick Boettcherb6e760f2009-08-03 14:39:15 -0300333/* ISDB-T and ISDB-Tsb */
334#define DTV_ISDBT_PARTIAL_RECEPTION 18
335#define DTV_ISDBT_SOUND_BROADCASTING 19
Steven Toth6b73eea2008-09-04 01:12:25 -0300336
Patrick Boettcherb6e760f2009-08-03 14:39:15 -0300337#define DTV_ISDBT_SB_SUBCHANNEL_ID 20
338#define DTV_ISDBT_SB_SEGMENT_IDX 21
339#define DTV_ISDBT_SB_SEGMENT_COUNT 22
340
341#define DTV_ISDBT_LAYERA_FEC 23
342#define DTV_ISDBT_LAYERA_MODULATION 24
343#define DTV_ISDBT_LAYERA_SEGMENT_COUNT 25
344#define DTV_ISDBT_LAYERA_TIME_INTERLEAVING 26
345
346#define DTV_ISDBT_LAYERB_FEC 27
347#define DTV_ISDBT_LAYERB_MODULATION 28
348#define DTV_ISDBT_LAYERB_SEGMENT_COUNT 29
349#define DTV_ISDBT_LAYERB_TIME_INTERLEAVING 30
350
351#define DTV_ISDBT_LAYERC_FEC 31
352#define DTV_ISDBT_LAYERC_MODULATION 32
353#define DTV_ISDBT_LAYERC_SEGMENT_COUNT 33
354#define DTV_ISDBT_LAYERC_TIME_INTERLEAVING 34
355
356#define DTV_API_VERSION 35
357
358#define DTV_CODE_RATE_HP 36
359#define DTV_CODE_RATE_LP 37
360#define DTV_GUARD_INTERVAL 38
361#define DTV_TRANSMISSION_MODE 39
362#define DTV_HIERARCHY 40
363
364#define DTV_ISDBT_LAYER_ENABLED 41
365
Evgeny Plehov287cefd2012-09-13 10:13:30 -0300366#define DTV_STREAM_ID 42
367#define DTV_ISDBS_TS_ID_LEGACY DTV_STREAM_ID
368#define DTV_DVBT2_PLP_ID_LEGACY 43
Andreas Oberritter94d56ff2011-05-12 18:11:06 -0300369
Manu Abrahamba2780c2011-11-13 18:47:44 -0300370#define DTV_ENUM_DELSYS 44
371
Michael Krufkyca689482012-01-29 15:44:58 -0300372/* ATSC-MH */
373#define DTV_ATSCMH_FIC_VER 45
374#define DTV_ATSCMH_PARADE_ID 46
375#define DTV_ATSCMH_NOG 47
376#define DTV_ATSCMH_TNOG 48
377#define DTV_ATSCMH_SGN 49
378#define DTV_ATSCMH_PRC 50
379#define DTV_ATSCMH_RS_FRAME_MODE 51
380#define DTV_ATSCMH_RS_FRAME_ENSEMBLE 52
381#define DTV_ATSCMH_RS_CODE_MODE_PRI 53
382#define DTV_ATSCMH_RS_CODE_MODE_SEC 54
383#define DTV_ATSCMH_SCCC_BLOCK_MODE 55
384#define DTV_ATSCMH_SCCC_CODE_MODE_A 56
385#define DTV_ATSCMH_SCCC_CODE_MODE_B 57
386#define DTV_ATSCMH_SCCC_CODE_MODE_C 58
387#define DTV_ATSCMH_SCCC_CODE_MODE_D 59
Michael Krufkyca689482012-01-29 15:44:58 -0300388
Antti Palosaari224b6642012-08-12 22:33:21 -0300389#define DTV_INTERLEAVING 60
Antti Palosaari8a2697a2012-07-11 21:54:50 -0300390#define DTV_LNA 61
Antti Palosaari224b6642012-08-12 22:33:21 -0300391
Mauro Carvalho Chehab95697932013-01-06 12:22:06 -0300392/* Quality parameters */
393#define DTV_STAT_SIGNAL_STRENGTH 62
394#define DTV_STAT_CNR 63
395#define DTV_STAT_PRE_ERROR_BIT_COUNT 64
396#define DTV_STAT_PRE_TOTAL_BIT_COUNT 65
397#define DTV_STAT_POST_ERROR_BIT_COUNT 66
398#define DTV_STAT_POST_TOTAL_BIT_COUNT 67
399#define DTV_STAT_ERROR_BLOCK_COUNT 68
400#define DTV_STAT_TOTAL_BLOCK_COUNT 69
401
402#define DTV_MAX_COMMAND DTV_STAT_TOTAL_BLOCK_COUNT
Steven Toth82d76692008-10-06 20:44:04 -0300403
Mauro Carvalho Chehab448bac12015-06-07 11:18:16 -0300404enum fe_pilot {
Steven Toth6b73eea2008-09-04 01:12:25 -0300405 PILOT_ON,
406 PILOT_OFF,
407 PILOT_AUTO,
Mauro Carvalho Chehab448bac12015-06-07 11:18:16 -0300408};
409
410typedef enum fe_pilot fe_pilot_t;
Steven Toth6b73eea2008-09-04 01:12:25 -0300411
Mauro Carvalho Chehabb35f6ba2015-06-07 11:59:27 -0300412enum fe_rolloff {
Darron Broada52f68c2008-10-07 17:30:45 -0300413 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
Steven Toth6b73eea2008-09-04 01:12:25 -0300414 ROLLOFF_20,
415 ROLLOFF_25,
Steven Toth6b73eea2008-09-04 01:12:25 -0300416 ROLLOFF_AUTO,
Mauro Carvalho Chehabb35f6ba2015-06-07 11:59:27 -0300417};
418
419typedef enum fe_rolloff fe_rolloff_t;
Steven Toth6b73eea2008-09-04 01:12:25 -0300420
Mauro Carvalho Chehabd21ddba2015-06-07 14:21:09 -0300421enum fe_delivery_system {
Steven Toth6b73eea2008-09-04 01:12:25 -0300422 SYS_UNDEFINED,
Manu Abrahambf3b8402011-12-17 20:36:55 -0300423 SYS_DVBC_ANNEX_A,
Steven Toth6b73eea2008-09-04 01:12:25 -0300424 SYS_DVBC_ANNEX_B,
425 SYS_DVBT,
Manu Abraham5ba4ecc2008-10-14 19:50:03 -0300426 SYS_DSS,
Steven Toth6b73eea2008-09-04 01:12:25 -0300427 SYS_DVBS,
428 SYS_DVBS2,
429 SYS_DVBH,
430 SYS_ISDBT,
431 SYS_ISDBS,
432 SYS_ISDBC,
433 SYS_ATSC,
434 SYS_ATSCMH,
Antti Palosaari224b6642012-08-12 22:33:21 -0300435 SYS_DTMB,
Steven Toth6b73eea2008-09-04 01:12:25 -0300436 SYS_CMMB,
437 SYS_DAB,
Andreas Oberritter94d56ff2011-05-12 18:11:06 -0300438 SYS_DVBT2,
Andreas Oberritter83dc3142011-08-08 11:54:35 -0300439 SYS_TURBO,
Manu Abrahambf3b8402011-12-17 20:36:55 -0300440 SYS_DVBC_ANNEX_C,
Mauro Carvalho Chehabd21ddba2015-06-07 14:21:09 -0300441};
442
443typedef enum fe_delivery_system fe_delivery_system_t;
Steven Toth6b73eea2008-09-04 01:12:25 -0300444
Antti Palosaari224b6642012-08-12 22:33:21 -0300445/* backward compatibility */
Manu Abrahambf3b8402011-12-17 20:36:55 -0300446#define SYS_DVBC_ANNEX_AC SYS_DVBC_ANNEX_A
Antti Palosaari224b6642012-08-12 22:33:21 -0300447#define SYS_DMBTH SYS_DTMB /* DMB-TH is legacy name, use DTMB instead */
Manu Abrahambf3b8402011-12-17 20:36:55 -0300448
Michael Krufkyca689482012-01-29 15:44:58 -0300449/* ATSC-MH */
450
451enum atscmh_sccc_block_mode {
452 ATSCMH_SCCC_BLK_SEP = 0,
453 ATSCMH_SCCC_BLK_COMB = 1,
454 ATSCMH_SCCC_BLK_RES = 2,
455};
456
457enum atscmh_sccc_code_mode {
458 ATSCMH_SCCC_CODE_HLF = 0,
459 ATSCMH_SCCC_CODE_QTR = 1,
460 ATSCMH_SCCC_CODE_RES = 2,
461};
462
463enum atscmh_rs_frame_ensemble {
464 ATSCMH_RSFRAME_ENS_PRI = 0,
465 ATSCMH_RSFRAME_ENS_SEC = 1,
466};
467
468enum atscmh_rs_frame_mode {
469 ATSCMH_RSFRAME_PRI_ONLY = 0,
470 ATSCMH_RSFRAME_PRI_SEC = 1,
471 ATSCMH_RSFRAME_RES = 2,
472};
473
474enum atscmh_rs_code_mode {
475 ATSCMH_RSCODE_211_187 = 0,
476 ATSCMH_RSCODE_223_187 = 1,
477 ATSCMH_RSCODE_235_187 = 2,
478 ATSCMH_RSCODE_RES = 3,
479};
480
Evgeny Plehov287cefd2012-09-13 10:13:30 -0300481#define NO_STREAM_ID_FILTER (~0U)
Antti Palosaari8a2697a2012-07-11 21:54:50 -0300482#define LNA_AUTO (~0U)
Manu Abrahambf3b8402011-12-17 20:36:55 -0300483
Steven Toth56f06802008-09-11 10:19:27 -0300484struct dtv_cmds_h {
Steven Toth6b73eea2008-09-04 01:12:25 -0300485 char *name; /* A display name for debugging purposes */
486
487 __u32 cmd; /* A unique ID */
488
489 /* Flags */
490 __u32 set:1; /* Either a set or get property */
491 __u32 buffer:1; /* Does this property use the buffer? */
492 __u32 reserved:30; /* Align */
493};
494
Mauro Carvalho Chehab95697932013-01-06 12:22:06 -0300495/**
496 * Scale types for the quality parameters.
497 * @FE_SCALE_NOT_AVAILABLE: That QoS measure is not available. That
498 * could indicate a temporary or a permanent
499 * condition.
David Howells4c12ada2015-04-09 16:36:49 -0300500 * @FE_SCALE_DECIBEL: The scale is measured in 0.001 dB steps, typically
Mauro Carvalho Chehab95697932013-01-06 12:22:06 -0300501 * used on signal measures.
502 * @FE_SCALE_RELATIVE: The scale is a relative percentual measure,
503 * ranging from 0 (0%) to 0xffff (100%).
504 * @FE_SCALE_COUNTER: The scale counts the occurrence of an event, like
505 * bit error, block error, lapsed time.
506 */
507enum fecap_scale_params {
508 FE_SCALE_NOT_AVAILABLE = 0,
509 FE_SCALE_DECIBEL,
510 FE_SCALE_RELATIVE,
511 FE_SCALE_COUNTER
512};
513
514/**
515 * struct dtv_stats - Used for reading a DTV status property
516 *
517 * @value: value of the measure. Should range from 0 to 0xffff;
518 * @scale: Filled with enum fecap_scale_params - the scale
519 * in usage for that parameter
520 *
521 * For most delivery systems, this will return a single value for each
522 * parameter.
523 * It should be noticed, however, that new OFDM delivery systems like
524 * ISDB can use different modulation types for each group of carriers.
525 * On such standards, up to 8 groups of statistics can be provided, one
526 * for each carrier group (called "layer" on ISDB).
527 * In order to be consistent with other delivery systems, the first
528 * value refers to the entire set of carriers ("global").
529 * dtv_status:scale should use the value FE_SCALE_NOT_AVAILABLE when
530 * the value for the entire group of carriers or from one specific layer
531 * is not provided by the hardware.
532 * st.len should be filled with the latest filled status + 1.
533 *
534 * In other words, for ISDB, those values should be filled like:
535 * u.st.stat.svalue[0] = global statistics;
536 * u.st.stat.scale[0] = FE_SCALE_DECIBELS;
537 * u.st.stat.value[1] = layer A statistics;
538 * u.st.stat.scale[1] = FE_SCALE_NOT_AVAILABLE (if not available);
539 * u.st.stat.svalue[2] = layer B statistics;
540 * u.st.stat.scale[2] = FE_SCALE_DECIBELS;
541 * u.st.stat.svalue[3] = layer C statistics;
542 * u.st.stat.scale[3] = FE_SCALE_DECIBELS;
543 * u.st.len = 4;
544 */
545struct dtv_stats {
546 __u8 scale; /* enum fecap_scale_params type */
547 union {
548 __u64 uvalue; /* for counters and relative scales */
David Howells4c12ada2015-04-09 16:36:49 -0300549 __s64 svalue; /* for 0.001 dB measures */
Mauro Carvalho Chehab95697932013-01-06 12:22:06 -0300550 };
551} __attribute__ ((packed));
552
553
554#define MAX_DTV_STATS 4
555
556struct dtv_fe_stats {
557 __u8 len;
558 struct dtv_stats stat[MAX_DTV_STATS];
559} __attribute__ ((packed));
560
Steven Tothe7fee0f32008-09-11 10:23:01 -0300561struct dtv_property {
Steven Toth6b73eea2008-09-04 01:12:25 -0300562 __u32 cmd;
Steven Tothe7fee0f32008-09-11 10:23:01 -0300563 __u32 reserved[3];
Steven Toth6b73eea2008-09-04 01:12:25 -0300564 union {
565 __u32 data;
Mauro Carvalho Chehab95697932013-01-06 12:22:06 -0300566 struct dtv_fe_stats st;
Steven Toth6b73eea2008-09-04 01:12:25 -0300567 struct {
568 __u8 data[32];
569 __u32 len;
Steven Tothe7fee0f32008-09-11 10:23:01 -0300570 __u32 reserved1[3];
571 void *reserved2;
Steven Toth6b73eea2008-09-04 01:12:25 -0300572 } buffer;
573 } u;
Steven Tothd48cb402008-09-26 00:16:25 -0300574 int result;
Steven Tothe7fee0f32008-09-11 10:23:01 -0300575} __attribute__ ((packed));
Steven Toth6b73eea2008-09-04 01:12:25 -0300576
Brandon Philipscc7d7052008-10-06 21:31:48 -0300577/* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
578#define DTV_IOCTL_MAX_MSGS 64
579
Steven Tothe7fee0f32008-09-11 10:23:01 -0300580struct dtv_properties {
581 __u32 num;
582 struct dtv_property *props;
583};
Steven Toth6b73eea2008-09-04 01:12:25 -0300584
Steven Tothe7fee0f32008-09-11 10:23:01 -0300585#define FE_SET_PROPERTY _IOW('o', 82, struct dtv_properties)
586#define FE_GET_PROPERTY _IOR('o', 83, struct dtv_properties)
Steven Toth6b73eea2008-09-04 01:12:25 -0300587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Andrew de Quincey36cb5572006-01-09 15:25:07 -0200589/**
590 * When set, this flag will disable any zigzagging or other "normal" tuning
591 * behaviour. Additionally, there will be no automatic monitoring of the lock
592 * status, and hence no frontend events will be generated. If a frontend device
593 * is closed, this flag will be automatically turned off when the device is
594 * reopened read-write.
595 */
596#define FE_TUNE_MODE_ONESHOT 0x01
597
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
599#define FE_GET_INFO _IOR('o', 61, struct dvb_frontend_info)
600
601#define FE_DISEQC_RESET_OVERLOAD _IO('o', 62)
602#define FE_DISEQC_SEND_MASTER_CMD _IOW('o', 63, struct dvb_diseqc_master_cmd)
603#define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply)
604#define FE_DISEQC_SEND_BURST _IO('o', 65) /* fe_sec_mini_cmd_t */
605
606#define FE_SET_TONE _IO('o', 66) /* fe_sec_tone_mode_t */
607#define FE_SET_VOLTAGE _IO('o', 67) /* fe_sec_voltage_t */
608#define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68) /* int */
609
610#define FE_READ_STATUS _IOR('o', 69, fe_status_t)
611#define FE_READ_BER _IOR('o', 70, __u32)
612#define FE_READ_SIGNAL_STRENGTH _IOR('o', 71, __u16)
613#define FE_READ_SNR _IOR('o', 72, __u16)
614#define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32)
615
616#define FE_SET_FRONTEND _IOW('o', 76, struct dvb_frontend_parameters)
617#define FE_GET_FRONTEND _IOR('o', 77, struct dvb_frontend_parameters)
Andrew de Quincey36cb5572006-01-09 15:25:07 -0200618#define FE_SET_FRONTEND_TUNE_MODE _IO('o', 81) /* unsigned int */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619#define FE_GET_EVENT _IOR('o', 78, struct dvb_frontend_event)
620
621#define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */
622
623#endif /*_DVBFRONTEND_H_*/