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>
31 typedef enum fe_type {
41 FE_CAN_INVERSION_AUTO = 0x1,
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,
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_MULTISTREAM = 0x4000000, /* frontend supports multistream filtering */
66 FE_CAN_TURBO_FEC = 0x8000000, /* frontend supports "turbo fec modulation" */
67 FE_CAN_2G_MODULATION = 0x10000000, /* frontend supports "2nd generation modulation" (DVB-S2) */
68 FE_NEEDS_BENDING = 0x20000000, /* not supported anymore, don't use (frontend requires frequency bending) */
69 FE_CAN_RECOVER = 0x40000000, /* frontend can recover from a cable unplug automatically */
70 FE_CAN_MUTE_TS = 0x80000000 /* frontend can stop spurious TS data output */
73 typedef enum fe_caps fe_caps_t;
76 struct dvb_frontend_info {
78 fe_type_t type; /* DEPRECATED. Use DTV_ENUM_DELSYS instead */
81 __u32 frequency_stepsize;
82 __u32 frequency_tolerance;
83 __u32 symbol_rate_min;
84 __u32 symbol_rate_max;
85 __u32 symbol_rate_tolerance; /* ppm */
86 __u32 notifier_delay; /* DEPRECATED */
92 * Check out the DiSEqC bus spec available on http://www.eutelsat.org/ for
93 * the meaning of this struct...
95 struct dvb_diseqc_master_cmd {
96 __u8 msg [6]; /* { framing, address, command, data [3] } */
97 __u8 msg_len; /* valid values are 3...6 */
101 struct dvb_diseqc_slave_reply {
102 __u8 msg [4]; /* { framing, data [3] } */
103 __u8 msg_len; /* valid values are 0...4, 0 means no msg */
104 int timeout; /* return from ioctl after timeout ms with */
105 }; /* errorcode when no message was received */
108 enum fe_sec_voltage {
114 typedef enum fe_sec_voltage fe_sec_voltage_t;
117 enum fe_sec_tone_mode {
122 typedef enum fe_sec_tone_mode fe_sec_tone_mode_t;
125 enum fe_sec_mini_cmd {
130 typedef enum fe_sec_mini_cmd fe_sec_mini_cmd_t;
134 * enum fe_status - enumerates the possible frontend status
135 * @FE_HAS_SIGNAL: found something above the noise level
136 * @FE_HAS_CARRIER: found a DVB signal
137 * @FE_HAS_VITERBI: FEC is stable
138 * @FE_HAS_SYNC: found sync bytes
139 * @FE_HAS_LOCK: everything's working
140 * @FE_TIMEDOUT: no lock within the last ~2 seconds
141 * @FE_REINIT: frontend was reinitialized, application is recommended
142 * to reset DiSEqC, tone and parameters
146 FE_HAS_SIGNAL = 0x01,
147 FE_HAS_CARRIER = 0x02,
148 FE_HAS_VITERBI = 0x04,
155 typedef enum fe_status fe_status_t;
157 enum fe_spectral_inversion {
163 typedef enum fe_spectral_inversion fe_spectral_inversion_t;
181 typedef enum fe_code_rate fe_code_rate_t;
201 typedef enum fe_modulation fe_modulation_t;
203 enum fe_transmit_mode {
204 TRANSMISSION_MODE_2K,
205 TRANSMISSION_MODE_8K,
206 TRANSMISSION_MODE_AUTO,
207 TRANSMISSION_MODE_4K,
208 TRANSMISSION_MODE_1K,
209 TRANSMISSION_MODE_16K,
210 TRANSMISSION_MODE_32K,
211 TRANSMISSION_MODE_C1,
212 TRANSMISSION_MODE_C3780,
215 typedef enum fe_transmit_mode fe_transmit_mode_t;
217 #if defined(__DVB_CORE__) || !defined (__KERNEL__)
228 typedef enum fe_bandwidth fe_bandwidth_t;
231 enum fe_guard_interval {
237 GUARD_INTERVAL_1_128,
238 GUARD_INTERVAL_19_128,
239 GUARD_INTERVAL_19_256,
240 GUARD_INTERVAL_PN420,
241 GUARD_INTERVAL_PN595,
242 GUARD_INTERVAL_PN945,
245 typedef enum fe_guard_interval fe_guard_interval_t;
255 typedef enum fe_hierarchy fe_hierarchy_t;
257 enum fe_interleaving {
264 #if defined(__DVB_CORE__) || !defined (__KERNEL__)
265 struct dvb_qpsk_parameters {
266 __u32 symbol_rate; /* symbol rate in Symbols per second */
267 fe_code_rate_t fec_inner; /* forward error correction (see above) */
270 struct dvb_qam_parameters {
271 __u32 symbol_rate; /* symbol rate in Symbols per second */
272 fe_code_rate_t fec_inner; /* forward error correction (see above) */
273 fe_modulation_t modulation; /* modulation type (see above) */
276 struct dvb_vsb_parameters {
277 fe_modulation_t modulation; /* modulation type (see above) */
280 struct dvb_ofdm_parameters {
281 fe_bandwidth_t bandwidth;
282 fe_code_rate_t code_rate_HP; /* high priority stream code rate */
283 fe_code_rate_t code_rate_LP; /* low priority stream code rate */
284 fe_modulation_t constellation; /* modulation type (see above) */
285 fe_transmit_mode_t transmission_mode;
286 fe_guard_interval_t guard_interval;
287 fe_hierarchy_t hierarchy_information;
291 struct dvb_frontend_parameters {
292 __u32 frequency; /* (absolute) frequency in Hz for QAM/OFDM/ATSC */
293 /* intermediate frequency in kHz for QPSK */
294 fe_spectral_inversion_t inversion;
296 struct dvb_qpsk_parameters qpsk;
297 struct dvb_qam_parameters qam;
298 struct dvb_ofdm_parameters ofdm;
299 struct dvb_vsb_parameters vsb;
303 struct dvb_frontend_event {
305 struct dvb_frontend_parameters parameters;
310 #define DTV_UNDEFINED 0
313 #define DTV_FREQUENCY 3
314 #define DTV_MODULATION 4
315 #define DTV_BANDWIDTH_HZ 5
316 #define DTV_INVERSION 6
317 #define DTV_DISEQC_MASTER 7
318 #define DTV_SYMBOL_RATE 8
319 #define DTV_INNER_FEC 9
320 #define DTV_VOLTAGE 10
323 #define DTV_ROLLOFF 13
324 #define DTV_DISEQC_SLAVE_REPLY 14
326 /* Basic enumeration set for querying unlimited capabilities */
327 #define DTV_FE_CAPABILITY_COUNT 15
328 #define DTV_FE_CAPABILITY 16
329 #define DTV_DELIVERY_SYSTEM 17
331 /* ISDB-T and ISDB-Tsb */
332 #define DTV_ISDBT_PARTIAL_RECEPTION 18
333 #define DTV_ISDBT_SOUND_BROADCASTING 19
335 #define DTV_ISDBT_SB_SUBCHANNEL_ID 20
336 #define DTV_ISDBT_SB_SEGMENT_IDX 21
337 #define DTV_ISDBT_SB_SEGMENT_COUNT 22
339 #define DTV_ISDBT_LAYERA_FEC 23
340 #define DTV_ISDBT_LAYERA_MODULATION 24
341 #define DTV_ISDBT_LAYERA_SEGMENT_COUNT 25
342 #define DTV_ISDBT_LAYERA_TIME_INTERLEAVING 26
344 #define DTV_ISDBT_LAYERB_FEC 27
345 #define DTV_ISDBT_LAYERB_MODULATION 28
346 #define DTV_ISDBT_LAYERB_SEGMENT_COUNT 29
347 #define DTV_ISDBT_LAYERB_TIME_INTERLEAVING 30
349 #define DTV_ISDBT_LAYERC_FEC 31
350 #define DTV_ISDBT_LAYERC_MODULATION 32
351 #define DTV_ISDBT_LAYERC_SEGMENT_COUNT 33
352 #define DTV_ISDBT_LAYERC_TIME_INTERLEAVING 34
354 #define DTV_API_VERSION 35
356 #define DTV_CODE_RATE_HP 36
357 #define DTV_CODE_RATE_LP 37
358 #define DTV_GUARD_INTERVAL 38
359 #define DTV_TRANSMISSION_MODE 39
360 #define DTV_HIERARCHY 40
362 #define DTV_ISDBT_LAYER_ENABLED 41
364 #define DTV_STREAM_ID 42
365 #define DTV_ISDBS_TS_ID_LEGACY DTV_STREAM_ID
366 #define DTV_DVBT2_PLP_ID_LEGACY 43
368 #define DTV_ENUM_DELSYS 44
371 #define DTV_ATSCMH_FIC_VER 45
372 #define DTV_ATSCMH_PARADE_ID 46
373 #define DTV_ATSCMH_NOG 47
374 #define DTV_ATSCMH_TNOG 48
375 #define DTV_ATSCMH_SGN 49
376 #define DTV_ATSCMH_PRC 50
377 #define DTV_ATSCMH_RS_FRAME_MODE 51
378 #define DTV_ATSCMH_RS_FRAME_ENSEMBLE 52
379 #define DTV_ATSCMH_RS_CODE_MODE_PRI 53
380 #define DTV_ATSCMH_RS_CODE_MODE_SEC 54
381 #define DTV_ATSCMH_SCCC_BLOCK_MODE 55
382 #define DTV_ATSCMH_SCCC_CODE_MODE_A 56
383 #define DTV_ATSCMH_SCCC_CODE_MODE_B 57
384 #define DTV_ATSCMH_SCCC_CODE_MODE_C 58
385 #define DTV_ATSCMH_SCCC_CODE_MODE_D 59
387 #define DTV_INTERLEAVING 60
390 /* Quality parameters */
391 #define DTV_STAT_SIGNAL_STRENGTH 62
392 #define DTV_STAT_CNR 63
393 #define DTV_STAT_PRE_ERROR_BIT_COUNT 64
394 #define DTV_STAT_PRE_TOTAL_BIT_COUNT 65
395 #define DTV_STAT_POST_ERROR_BIT_COUNT 66
396 #define DTV_STAT_POST_TOTAL_BIT_COUNT 67
397 #define DTV_STAT_ERROR_BLOCK_COUNT 68
398 #define DTV_STAT_TOTAL_BLOCK_COUNT 69
400 #define DTV_MAX_COMMAND DTV_STAT_TOTAL_BLOCK_COUNT
408 typedef enum fe_pilot fe_pilot_t;
410 typedef enum fe_rolloff {
411 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
417 typedef enum fe_delivery_system {
437 } fe_delivery_system_t;
439 /* backward compatibility */
440 #define SYS_DVBC_ANNEX_AC SYS_DVBC_ANNEX_A
441 #define SYS_DMBTH SYS_DTMB /* DMB-TH is legacy name, use DTMB instead */
445 enum atscmh_sccc_block_mode {
446 ATSCMH_SCCC_BLK_SEP = 0,
447 ATSCMH_SCCC_BLK_COMB = 1,
448 ATSCMH_SCCC_BLK_RES = 2,
451 enum atscmh_sccc_code_mode {
452 ATSCMH_SCCC_CODE_HLF = 0,
453 ATSCMH_SCCC_CODE_QTR = 1,
454 ATSCMH_SCCC_CODE_RES = 2,
457 enum atscmh_rs_frame_ensemble {
458 ATSCMH_RSFRAME_ENS_PRI = 0,
459 ATSCMH_RSFRAME_ENS_SEC = 1,
462 enum atscmh_rs_frame_mode {
463 ATSCMH_RSFRAME_PRI_ONLY = 0,
464 ATSCMH_RSFRAME_PRI_SEC = 1,
465 ATSCMH_RSFRAME_RES = 2,
468 enum atscmh_rs_code_mode {
469 ATSCMH_RSCODE_211_187 = 0,
470 ATSCMH_RSCODE_223_187 = 1,
471 ATSCMH_RSCODE_235_187 = 2,
472 ATSCMH_RSCODE_RES = 3,
475 #define NO_STREAM_ID_FILTER (~0U)
476 #define LNA_AUTO (~0U)
479 char *name; /* A display name for debugging purposes */
481 __u32 cmd; /* A unique ID */
484 __u32 set:1; /* Either a set or get property */
485 __u32 buffer:1; /* Does this property use the buffer? */
486 __u32 reserved:30; /* Align */
490 * Scale types for the quality parameters.
491 * @FE_SCALE_NOT_AVAILABLE: That QoS measure is not available. That
492 * could indicate a temporary or a permanent
494 * @FE_SCALE_DECIBEL: The scale is measured in 0.001 dB steps, typically
495 * used on signal measures.
496 * @FE_SCALE_RELATIVE: The scale is a relative percentual measure,
497 * ranging from 0 (0%) to 0xffff (100%).
498 * @FE_SCALE_COUNTER: The scale counts the occurrence of an event, like
499 * bit error, block error, lapsed time.
501 enum fecap_scale_params {
502 FE_SCALE_NOT_AVAILABLE = 0,
509 * struct dtv_stats - Used for reading a DTV status property
511 * @value: value of the measure. Should range from 0 to 0xffff;
512 * @scale: Filled with enum fecap_scale_params - the scale
513 * in usage for that parameter
515 * For most delivery systems, this will return a single value for each
517 * It should be noticed, however, that new OFDM delivery systems like
518 * ISDB can use different modulation types for each group of carriers.
519 * On such standards, up to 8 groups of statistics can be provided, one
520 * for each carrier group (called "layer" on ISDB).
521 * In order to be consistent with other delivery systems, the first
522 * value refers to the entire set of carriers ("global").
523 * dtv_status:scale should use the value FE_SCALE_NOT_AVAILABLE when
524 * the value for the entire group of carriers or from one specific layer
525 * is not provided by the hardware.
526 * st.len should be filled with the latest filled status + 1.
528 * In other words, for ISDB, those values should be filled like:
529 * u.st.stat.svalue[0] = global statistics;
530 * u.st.stat.scale[0] = FE_SCALE_DECIBELS;
531 * u.st.stat.value[1] = layer A statistics;
532 * u.st.stat.scale[1] = FE_SCALE_NOT_AVAILABLE (if not available);
533 * u.st.stat.svalue[2] = layer B statistics;
534 * u.st.stat.scale[2] = FE_SCALE_DECIBELS;
535 * u.st.stat.svalue[3] = layer C statistics;
536 * u.st.stat.scale[3] = FE_SCALE_DECIBELS;
540 __u8 scale; /* enum fecap_scale_params type */
542 __u64 uvalue; /* for counters and relative scales */
543 __s64 svalue; /* for 0.001 dB measures */
545 } __attribute__ ((packed));
548 #define MAX_DTV_STATS 4
550 struct dtv_fe_stats {
552 struct dtv_stats stat[MAX_DTV_STATS];
553 } __attribute__ ((packed));
555 struct dtv_property {
560 struct dtv_fe_stats st;
569 } __attribute__ ((packed));
571 /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
572 #define DTV_IOCTL_MAX_MSGS 64
574 struct dtv_properties {
576 struct dtv_property *props;
579 #define FE_SET_PROPERTY _IOW('o', 82, struct dtv_properties)
580 #define FE_GET_PROPERTY _IOR('o', 83, struct dtv_properties)
584 * When set, this flag will disable any zigzagging or other "normal" tuning
585 * behaviour. Additionally, there will be no automatic monitoring of the lock
586 * status, and hence no frontend events will be generated. If a frontend device
587 * is closed, this flag will be automatically turned off when the device is
588 * reopened read-write.
590 #define FE_TUNE_MODE_ONESHOT 0x01
593 #define FE_GET_INFO _IOR('o', 61, struct dvb_frontend_info)
595 #define FE_DISEQC_RESET_OVERLOAD _IO('o', 62)
596 #define FE_DISEQC_SEND_MASTER_CMD _IOW('o', 63, struct dvb_diseqc_master_cmd)
597 #define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply)
598 #define FE_DISEQC_SEND_BURST _IO('o', 65) /* fe_sec_mini_cmd_t */
600 #define FE_SET_TONE _IO('o', 66) /* fe_sec_tone_mode_t */
601 #define FE_SET_VOLTAGE _IO('o', 67) /* fe_sec_voltage_t */
602 #define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68) /* int */
604 #define FE_READ_STATUS _IOR('o', 69, fe_status_t)
605 #define FE_READ_BER _IOR('o', 70, __u32)
606 #define FE_READ_SIGNAL_STRENGTH _IOR('o', 71, __u16)
607 #define FE_READ_SNR _IOR('o', 72, __u16)
608 #define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32)
610 #define FE_SET_FRONTEND _IOW('o', 76, struct dvb_frontend_parameters)
611 #define FE_GET_FRONTEND _IOR('o', 77, struct dvb_frontend_parameters)
612 #define FE_SET_FRONTEND_TUNE_MODE _IO('o', 81) /* unsigned int */
613 #define FE_GET_EVENT _IOR('o', 78, struct dvb_frontend_event)
615 #define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */
617 #endif /*_DVBFRONTEND_H_*/