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
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.
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.
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.
26 #ifndef _DVBFRONTEND_H_
27 #define _DVBFRONTEND_H_
29 #include <linux/types.h>
40 FE_CAN_INVERSION_AUTO = 0x1,
44 FE_CAN_FEC_4_5 = 0x10,
45 FE_CAN_FEC_5_6 = 0x20,
46 FE_CAN_FEC_6_7 = 0x40,
47 FE_CAN_FEC_7_8 = 0x80,
48 FE_CAN_FEC_8_9 = 0x100,
49 FE_CAN_FEC_AUTO = 0x200,
51 FE_CAN_QAM_16 = 0x800,
52 FE_CAN_QAM_32 = 0x1000,
53 FE_CAN_QAM_64 = 0x2000,
54 FE_CAN_QAM_128 = 0x4000,
55 FE_CAN_QAM_256 = 0x8000,
56 FE_CAN_QAM_AUTO = 0x10000,
57 FE_CAN_TRANSMISSION_MODE_AUTO = 0x20000,
58 FE_CAN_BANDWIDTH_AUTO = 0x40000,
59 FE_CAN_GUARD_INTERVAL_AUTO = 0x80000,
60 FE_CAN_HIERARCHY_AUTO = 0x100000,
61 FE_CAN_8VSB = 0x200000,
62 FE_CAN_16VSB = 0x400000,
63 FE_HAS_EXTENDED_CAPS = 0x800000, /* We need more bitspace for newer APIs, indicate this. */
64 FE_CAN_MULTISTREAM = 0x4000000, /* frontend supports multistream filtering */
65 FE_CAN_TURBO_FEC = 0x8000000, /* frontend supports "turbo fec modulation" */
66 FE_CAN_2G_MODULATION = 0x10000000, /* frontend supports "2nd generation modulation" (DVB-S2) */
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 */
72 struct dvb_frontend_info {
74 enum fe_type type; /* DEPRECATED. Use DTV_ENUM_DELSYS instead */
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 */
88 * Check out the DiSEqC bus spec available on http://www.eutelsat.org/ for
89 * the meaning of this struct...
91 struct dvb_diseqc_master_cmd {
92 __u8 msg [6]; /* { framing, address, command, data [3] } */
93 __u8 msg_len; /* valid values are 3...6 */
96 struct dvb_diseqc_slave_reply {
97 __u8 msg [4]; /* { framing, data [3] } */
98 __u8 msg_len; /* valid values are 0...4, 0 means no msg */
99 int timeout; /* return from ioctl after timeout ms with */
100 }; /* errorcode when no message was received */
102 enum fe_sec_voltage {
108 enum fe_sec_tone_mode {
113 enum fe_sec_mini_cmd {
119 * enum fe_status - enumerates the possible frontend status
120 * @FE_HAS_SIGNAL: found something above the noise level
121 * @FE_HAS_CARRIER: found a DVB signal
122 * @FE_HAS_VITERBI: FEC is stable
123 * @FE_HAS_SYNC: found sync bytes
124 * @FE_HAS_LOCK: everything's working
125 * @FE_TIMEDOUT: no lock within the last ~2 seconds
126 * @FE_REINIT: frontend was reinitialized, application is recommended
127 * to reset DiSEqC, tone and parameters
131 FE_HAS_SIGNAL = 0x01,
132 FE_HAS_CARRIER = 0x02,
133 FE_HAS_VITERBI = 0x04,
140 enum fe_spectral_inversion {
179 enum fe_transmit_mode {
180 TRANSMISSION_MODE_2K,
181 TRANSMISSION_MODE_8K,
182 TRANSMISSION_MODE_AUTO,
183 TRANSMISSION_MODE_4K,
184 TRANSMISSION_MODE_1K,
185 TRANSMISSION_MODE_16K,
186 TRANSMISSION_MODE_32K,
187 TRANSMISSION_MODE_C1,
188 TRANSMISSION_MODE_C3780,
191 enum fe_guard_interval {
197 GUARD_INTERVAL_1_128,
198 GUARD_INTERVAL_19_128,
199 GUARD_INTERVAL_19_256,
200 GUARD_INTERVAL_PN420,
201 GUARD_INTERVAL_PN595,
202 GUARD_INTERVAL_PN945,
213 enum fe_interleaving {
221 #define DTV_UNDEFINED 0
224 #define DTV_FREQUENCY 3
225 #define DTV_MODULATION 4
226 #define DTV_BANDWIDTH_HZ 5
227 #define DTV_INVERSION 6
228 #define DTV_DISEQC_MASTER 7
229 #define DTV_SYMBOL_RATE 8
230 #define DTV_INNER_FEC 9
231 #define DTV_VOLTAGE 10
234 #define DTV_ROLLOFF 13
235 #define DTV_DISEQC_SLAVE_REPLY 14
237 /* Basic enumeration set for querying unlimited capabilities */
238 #define DTV_FE_CAPABILITY_COUNT 15
239 #define DTV_FE_CAPABILITY 16
240 #define DTV_DELIVERY_SYSTEM 17
242 /* ISDB-T and ISDB-Tsb */
243 #define DTV_ISDBT_PARTIAL_RECEPTION 18
244 #define DTV_ISDBT_SOUND_BROADCASTING 19
246 #define DTV_ISDBT_SB_SUBCHANNEL_ID 20
247 #define DTV_ISDBT_SB_SEGMENT_IDX 21
248 #define DTV_ISDBT_SB_SEGMENT_COUNT 22
250 #define DTV_ISDBT_LAYERA_FEC 23
251 #define DTV_ISDBT_LAYERA_MODULATION 24
252 #define DTV_ISDBT_LAYERA_SEGMENT_COUNT 25
253 #define DTV_ISDBT_LAYERA_TIME_INTERLEAVING 26
255 #define DTV_ISDBT_LAYERB_FEC 27
256 #define DTV_ISDBT_LAYERB_MODULATION 28
257 #define DTV_ISDBT_LAYERB_SEGMENT_COUNT 29
258 #define DTV_ISDBT_LAYERB_TIME_INTERLEAVING 30
260 #define DTV_ISDBT_LAYERC_FEC 31
261 #define DTV_ISDBT_LAYERC_MODULATION 32
262 #define DTV_ISDBT_LAYERC_SEGMENT_COUNT 33
263 #define DTV_ISDBT_LAYERC_TIME_INTERLEAVING 34
265 #define DTV_API_VERSION 35
267 #define DTV_CODE_RATE_HP 36
268 #define DTV_CODE_RATE_LP 37
269 #define DTV_GUARD_INTERVAL 38
270 #define DTV_TRANSMISSION_MODE 39
271 #define DTV_HIERARCHY 40
273 #define DTV_ISDBT_LAYER_ENABLED 41
275 #define DTV_STREAM_ID 42
276 #define DTV_ISDBS_TS_ID_LEGACY DTV_STREAM_ID
277 #define DTV_DVBT2_PLP_ID_LEGACY 43
279 #define DTV_ENUM_DELSYS 44
282 #define DTV_ATSCMH_FIC_VER 45
283 #define DTV_ATSCMH_PARADE_ID 46
284 #define DTV_ATSCMH_NOG 47
285 #define DTV_ATSCMH_TNOG 48
286 #define DTV_ATSCMH_SGN 49
287 #define DTV_ATSCMH_PRC 50
288 #define DTV_ATSCMH_RS_FRAME_MODE 51
289 #define DTV_ATSCMH_RS_FRAME_ENSEMBLE 52
290 #define DTV_ATSCMH_RS_CODE_MODE_PRI 53
291 #define DTV_ATSCMH_RS_CODE_MODE_SEC 54
292 #define DTV_ATSCMH_SCCC_BLOCK_MODE 55
293 #define DTV_ATSCMH_SCCC_CODE_MODE_A 56
294 #define DTV_ATSCMH_SCCC_CODE_MODE_B 57
295 #define DTV_ATSCMH_SCCC_CODE_MODE_C 58
296 #define DTV_ATSCMH_SCCC_CODE_MODE_D 59
298 #define DTV_INTERLEAVING 60
301 /* Quality parameters */
302 #define DTV_STAT_SIGNAL_STRENGTH 62
303 #define DTV_STAT_CNR 63
304 #define DTV_STAT_PRE_ERROR_BIT_COUNT 64
305 #define DTV_STAT_PRE_TOTAL_BIT_COUNT 65
306 #define DTV_STAT_POST_ERROR_BIT_COUNT 66
307 #define DTV_STAT_POST_TOTAL_BIT_COUNT 67
308 #define DTV_STAT_ERROR_BLOCK_COUNT 68
309 #define DTV_STAT_TOTAL_BLOCK_COUNT 69
311 #define DTV_MAX_COMMAND DTV_STAT_TOTAL_BLOCK_COUNT
320 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
326 enum fe_delivery_system {
348 /* backward compatibility */
349 #define SYS_DVBC_ANNEX_AC SYS_DVBC_ANNEX_A
350 #define SYS_DMBTH SYS_DTMB /* DMB-TH is legacy name, use DTMB instead */
354 enum atscmh_sccc_block_mode {
355 ATSCMH_SCCC_BLK_SEP = 0,
356 ATSCMH_SCCC_BLK_COMB = 1,
357 ATSCMH_SCCC_BLK_RES = 2,
360 enum atscmh_sccc_code_mode {
361 ATSCMH_SCCC_CODE_HLF = 0,
362 ATSCMH_SCCC_CODE_QTR = 1,
363 ATSCMH_SCCC_CODE_RES = 2,
366 enum atscmh_rs_frame_ensemble {
367 ATSCMH_RSFRAME_ENS_PRI = 0,
368 ATSCMH_RSFRAME_ENS_SEC = 1,
371 enum atscmh_rs_frame_mode {
372 ATSCMH_RSFRAME_PRI_ONLY = 0,
373 ATSCMH_RSFRAME_PRI_SEC = 1,
374 ATSCMH_RSFRAME_RES = 2,
377 enum atscmh_rs_code_mode {
378 ATSCMH_RSCODE_211_187 = 0,
379 ATSCMH_RSCODE_223_187 = 1,
380 ATSCMH_RSCODE_235_187 = 2,
381 ATSCMH_RSCODE_RES = 3,
384 #define NO_STREAM_ID_FILTER (~0U)
385 #define LNA_AUTO (~0U)
388 char *name; /* A display name for debugging purposes */
390 __u32 cmd; /* A unique ID */
393 __u32 set:1; /* Either a set or get property */
394 __u32 buffer:1; /* Does this property use the buffer? */
395 __u32 reserved:30; /* Align */
399 * Scale types for the quality parameters.
400 * @FE_SCALE_NOT_AVAILABLE: That QoS measure is not available. That
401 * could indicate a temporary or a permanent
403 * @FE_SCALE_DECIBEL: The scale is measured in 0.001 dB steps, typically
404 * used on signal measures.
405 * @FE_SCALE_RELATIVE: The scale is a relative percentual measure,
406 * ranging from 0 (0%) to 0xffff (100%).
407 * @FE_SCALE_COUNTER: The scale counts the occurrence of an event, like
408 * bit error, block error, lapsed time.
410 enum fecap_scale_params {
411 FE_SCALE_NOT_AVAILABLE = 0,
418 * struct dtv_stats - Used for reading a DTV status property
420 * @value: value of the measure. Should range from 0 to 0xffff;
421 * @scale: Filled with enum fecap_scale_params - the scale
422 * in usage for that parameter
424 * For most delivery systems, this will return a single value for each
426 * It should be noticed, however, that new OFDM delivery systems like
427 * ISDB can use different modulation types for each group of carriers.
428 * On such standards, up to 8 groups of statistics can be provided, one
429 * for each carrier group (called "layer" on ISDB).
430 * In order to be consistent with other delivery systems, the first
431 * value refers to the entire set of carriers ("global").
432 * dtv_status:scale should use the value FE_SCALE_NOT_AVAILABLE when
433 * the value for the entire group of carriers or from one specific layer
434 * is not provided by the hardware.
435 * st.len should be filled with the latest filled status + 1.
437 * In other words, for ISDB, those values should be filled like:
438 * u.st.stat.svalue[0] = global statistics;
439 * u.st.stat.scale[0] = FE_SCALE_DECIBEL;
440 * u.st.stat.value[1] = layer A statistics;
441 * u.st.stat.scale[1] = FE_SCALE_NOT_AVAILABLE (if not available);
442 * u.st.stat.svalue[2] = layer B statistics;
443 * u.st.stat.scale[2] = FE_SCALE_DECIBEL;
444 * u.st.stat.svalue[3] = layer C statistics;
445 * u.st.stat.scale[3] = FE_SCALE_DECIBEL;
449 __u8 scale; /* enum fecap_scale_params type */
451 __u64 uvalue; /* for counters and relative scales */
452 __s64 svalue; /* for 0.001 dB measures */
454 } __attribute__ ((packed));
457 #define MAX_DTV_STATS 4
459 struct dtv_fe_stats {
461 struct dtv_stats stat[MAX_DTV_STATS];
462 } __attribute__ ((packed));
464 struct dtv_property {
469 struct dtv_fe_stats st;
478 } __attribute__ ((packed));
480 /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
481 #define DTV_IOCTL_MAX_MSGS 64
483 struct dtv_properties {
485 struct dtv_property *props;
488 #if defined(__DVB_CORE__) || !defined (__KERNEL__)
491 * DEPRECATED: The DVBv3 ioctls, structs and enums should not be used on
492 * newer programs, as it doesn't support the second generation of digital
493 * TV standards, nor supports newer delivery systems.
506 /* This is needed for legacy userspace support */
507 typedef enum fe_sec_voltage fe_sec_voltage_t;
508 typedef enum fe_caps fe_caps_t;
509 typedef enum fe_type fe_type_t;
510 typedef enum fe_sec_tone_mode fe_sec_tone_mode_t;
511 typedef enum fe_sec_mini_cmd fe_sec_mini_cmd_t;
512 typedef enum fe_status fe_status_t;
513 typedef enum fe_spectral_inversion fe_spectral_inversion_t;
514 typedef enum fe_code_rate fe_code_rate_t;
515 typedef enum fe_modulation fe_modulation_t;
516 typedef enum fe_transmit_mode fe_transmit_mode_t;
517 typedef enum fe_bandwidth fe_bandwidth_t;
518 typedef enum fe_guard_interval fe_guard_interval_t;
519 typedef enum fe_hierarchy fe_hierarchy_t;
520 typedef enum fe_pilot fe_pilot_t;
521 typedef enum fe_rolloff fe_rolloff_t;
522 typedef enum fe_delivery_system fe_delivery_system_t;
524 struct dvb_qpsk_parameters {
525 __u32 symbol_rate; /* symbol rate in Symbols per second */
526 fe_code_rate_t fec_inner; /* forward error correction (see above) */
529 struct dvb_qam_parameters {
530 __u32 symbol_rate; /* symbol rate in Symbols per second */
531 fe_code_rate_t fec_inner; /* forward error correction (see above) */
532 fe_modulation_t modulation; /* modulation type (see above) */
535 struct dvb_vsb_parameters {
536 fe_modulation_t modulation; /* modulation type (see above) */
539 struct dvb_ofdm_parameters {
540 fe_bandwidth_t bandwidth;
541 fe_code_rate_t code_rate_HP; /* high priority stream code rate */
542 fe_code_rate_t code_rate_LP; /* low priority stream code rate */
543 fe_modulation_t constellation; /* modulation type (see above) */
544 fe_transmit_mode_t transmission_mode;
545 fe_guard_interval_t guard_interval;
546 fe_hierarchy_t hierarchy_information;
549 struct dvb_frontend_parameters {
550 __u32 frequency; /* (absolute) frequency in Hz for DVB-C/DVB-T/ATSC */
551 /* intermediate frequency in kHz for DVB-S */
552 fe_spectral_inversion_t inversion;
554 struct dvb_qpsk_parameters qpsk; /* DVB-S */
555 struct dvb_qam_parameters qam; /* DVB-C */
556 struct dvb_ofdm_parameters ofdm; /* DVB-T */
557 struct dvb_vsb_parameters vsb; /* ATSC */
561 struct dvb_frontend_event {
563 struct dvb_frontend_parameters parameters;
567 #define FE_SET_PROPERTY _IOW('o', 82, struct dtv_properties)
568 #define FE_GET_PROPERTY _IOR('o', 83, struct dtv_properties)
571 * When set, this flag will disable any zigzagging or other "normal" tuning
572 * behaviour. Additionally, there will be no automatic monitoring of the lock
573 * status, and hence no frontend events will be generated. If a frontend device
574 * is closed, this flag will be automatically turned off when the device is
575 * reopened read-write.
577 #define FE_TUNE_MODE_ONESHOT 0x01
579 #define FE_GET_INFO _IOR('o', 61, struct dvb_frontend_info)
581 #define FE_DISEQC_RESET_OVERLOAD _IO('o', 62)
582 #define FE_DISEQC_SEND_MASTER_CMD _IOW('o', 63, struct dvb_diseqc_master_cmd)
583 #define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply)
584 #define FE_DISEQC_SEND_BURST _IO('o', 65) /* fe_sec_mini_cmd_t */
586 #define FE_SET_TONE _IO('o', 66) /* fe_sec_tone_mode_t */
587 #define FE_SET_VOLTAGE _IO('o', 67) /* fe_sec_voltage_t */
588 #define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68) /* int */
590 #define FE_READ_STATUS _IOR('o', 69, fe_status_t)
591 #define FE_READ_BER _IOR('o', 70, __u32)
592 #define FE_READ_SIGNAL_STRENGTH _IOR('o', 71, __u16)
593 #define FE_READ_SNR _IOR('o', 72, __u16)
594 #define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32)
596 #define FE_SET_FRONTEND _IOW('o', 76, struct dvb_frontend_parameters)
597 #define FE_GET_FRONTEND _IOR('o', 77, struct dvb_frontend_parameters)
598 #define FE_SET_FRONTEND_TUNE_MODE _IO('o', 81) /* unsigned int */
599 #define FE_GET_EVENT _IOR('o', 78, struct dvb_frontend_event)
601 #define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */
603 #endif /*_DVBFRONTEND_H_*/