1<programlisting> 2/* 3 * frontend.h 4 * 5 * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de> 6 * Ralph Metzler <ralph@convergence.de> 7 * Holger Waechtler <holger@convergence.de> 8 * Andre Draszik <ad@convergence.de> 9 * for convergence integrated media GmbH 10 * 11 * This program is free software; you can redistribute it and/or 12 * modify it under the terms of the GNU Lesser General Public License 13 * as published by the Free Software Foundation; either version 2.1 14 * of the License, or (at your option) any later version. 15 * 16 * This program is distributed in the hope that it will be useful, 17 * but WITHOUT ANY WARRANTY; without even the implied warranty of 18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 * GNU General Public License for more details. 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * along with this program; if not, write to the Free Software 23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 24 * 25 */ 26 27#ifndef _DVBFRONTEND_H_ 28#define _DVBFRONTEND_H_ 29 30#include <linux/types.h> 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, 65 FE_HAS_EXTENDED_CAPS = 0x800000, /* We need more bitspace for newer APIs, indicate this. */ 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 */ 71} fe_caps_t; 72 73 74struct dvb_frontend_info { 75 char name[128]; 76 fe_type_t type; 77 __u32 frequency_min; 78 __u32 frequency_max; 79 __u32 frequency_stepsize; 80 __u32 frequency_tolerance; 81 __u32 symbol_rate_min; 82 __u32 symbol_rate_max; 83 __u32 symbol_rate_tolerance; /* ppm */ 84 __u32 notifier_delay; /* DEPRECATED */ 85 fe_caps_t caps; 86}; 87 88 89/** 90 * Check out the DiSEqC bus spec available on http://www.eutelsat.org/ for 91 * the meaning of this struct... 92 */ 93struct dvb_diseqc_master_cmd { 94 __u8 msg [6]; /* { framing, address, command, data [3] } */ 95 __u8 msg_len; /* valid values are 3...6 */ 96}; 97 98 99struct dvb_diseqc_slave_reply { 100 __u8 msg [4]; /* { framing, data [3] } */ 101 __u8 msg_len; /* valid values are 0...4, 0 means no msg */ 102 int timeout; /* return from ioctl after timeout ms with */ 103}; /* errorcode when no message was received */ 104 105 106typedef enum fe_sec_voltage { 107 SEC_VOLTAGE_13, 108 SEC_VOLTAGE_18, 109 SEC_VOLTAGE_OFF 110} fe_sec_voltage_t; 111 112 113typedef enum fe_sec_tone_mode { 114 SEC_TONE_ON, 115 SEC_TONE_OFF 116} fe_sec_tone_mode_t; 117 118 119typedef enum fe_sec_mini_cmd { 120 SEC_MINI_A, 121 SEC_MINI_B 122} fe_sec_mini_cmd_t; 123 124 125typedef enum fe_status { 126 FE_HAS_SIGNAL = 0x01, /* found something above the noise level */ 127 FE_HAS_CARRIER = 0x02, /* found a DVB signal */ 128 FE_HAS_VITERBI = 0x04, /* FEC is stable */ 129 FE_HAS_SYNC = 0x08, /* found sync bytes */ 130 FE_HAS_LOCK = 0x10, /* everything's working... */ 131 FE_TIMEDOUT = 0x20, /* no lock within the last ~2 seconds */ 132 FE_REINIT = 0x40 /* frontend was reinitialized, */ 133} fe_status_t; /* application is recommended to reset */ 134 /* DiSEqC, tone and parameters */ 135 136typedef enum fe_spectral_inversion { 137 INVERSION_OFF, 138 INVERSION_ON, 139 INVERSION_AUTO 140} fe_spectral_inversion_t; 141 142 143typedef enum fe_code_rate { 144 FEC_NONE = 0, 145 FEC_1_2, 146 FEC_2_3, 147 FEC_3_4, 148 FEC_4_5, 149 FEC_5_6, 150 FEC_6_7, 151 FEC_7_8, 152 FEC_8_9, 153 FEC_AUTO, 154 FEC_3_5, 155 FEC_9_10, 156} fe_code_rate_t; 157 158 159typedef enum fe_modulation { 160 QPSK, 161 QAM_16, 162 QAM_32, 163 QAM_64, 164 QAM_128, 165 QAM_256, 166 QAM_AUTO, 167 VSB_8, 168 VSB_16, 169 PSK_8, 170 APSK_16, 171 APSK_32, 172 DQPSK, 173} fe_modulation_t; 174 175typedef enum fe_transmit_mode { 176 TRANSMISSION_MODE_2K, 177 TRANSMISSION_MODE_8K, 178 TRANSMISSION_MODE_AUTO, 179 TRANSMISSION_MODE_4K 180} fe_transmit_mode_t; 181 182typedef enum fe_bandwidth { 183 BANDWIDTH_8_MHZ, 184 BANDWIDTH_7_MHZ, 185 BANDWIDTH_6_MHZ, 186 BANDWIDTH_AUTO 187} fe_bandwidth_t; 188 189 190typedef enum fe_guard_interval { 191 GUARD_INTERVAL_1_32, 192 GUARD_INTERVAL_1_16, 193 GUARD_INTERVAL_1_8, 194 GUARD_INTERVAL_1_4, 195 GUARD_INTERVAL_AUTO 196} fe_guard_interval_t; 197 198 199typedef enum fe_hierarchy { 200 HIERARCHY_NONE, 201 HIERARCHY_1, 202 HIERARCHY_2, 203 HIERARCHY_4, 204 HIERARCHY_AUTO 205} fe_hierarchy_t; 206 207 208struct dvb_qpsk_parameters { 209 __u32 symbol_rate; /* symbol rate in Symbols per second */ 210 fe_code_rate_t fec_inner; /* forward error correction (see above) */ 211}; 212 213struct dvb_qam_parameters { 214 __u32 symbol_rate; /* symbol rate in Symbols per second */ 215 fe_code_rate_t fec_inner; /* forward error correction (see above) */ 216 fe_modulation_t modulation; /* modulation type (see above) */ 217}; 218 219struct dvb_vsb_parameters { 220 fe_modulation_t modulation; /* modulation type (see above) */ 221}; 222 223struct dvb_ofdm_parameters { 224 fe_bandwidth_t bandwidth; 225 fe_code_rate_t code_rate_HP; /* high priority stream code rate */ 226 fe_code_rate_t code_rate_LP; /* low priority stream code rate */ 227 fe_modulation_t constellation; /* modulation type (see above) */ 228 fe_transmit_mode_t transmission_mode; 229 fe_guard_interval_t guard_interval; 230 fe_hierarchy_t hierarchy_information; 231}; 232 233 234struct dvb_frontend_parameters { 235 __u32 frequency; /* (absolute) frequency in Hz for QAM/OFDM/ATSC */ 236 /* intermediate frequency in kHz for QPSK */ 237 fe_spectral_inversion_t inversion; 238 union { 239 struct dvb_qpsk_parameters qpsk; 240 struct dvb_qam_parameters qam; 241 struct dvb_ofdm_parameters ofdm; 242 struct dvb_vsb_parameters vsb; 243 } u; 244}; 245 246 247struct dvb_frontend_event { 248 fe_status_t status; 249 struct dvb_frontend_parameters parameters; 250}; 251 252/* S2API Commands */ 253#define DTV_UNDEFINED 0 254#define DTV_TUNE 1 255#define DTV_CLEAR 2 256#define DTV_FREQUENCY 3 257#define DTV_MODULATION 4 258#define DTV_BANDWIDTH_HZ 5 259#define DTV_INVERSION 6 260#define DTV_DISEQC_MASTER 7 261#define DTV_SYMBOL_RATE 8 262#define DTV_INNER_FEC 9 263#define DTV_VOLTAGE 10 264#define DTV_TONE 11 265#define DTV_PILOT 12 266#define DTV_ROLLOFF 13 267#define DTV_DISEQC_SLAVE_REPLY 14 268 269/* Basic enumeration set for querying unlimited capabilities */ 270#define DTV_FE_CAPABILITY_COUNT 15 271#define DTV_FE_CAPABILITY 16 272#define DTV_DELIVERY_SYSTEM 17 273 274/* ISDB-T and ISDB-Tsb */ 275#define DTV_ISDBT_PARTIAL_RECEPTION 18 276#define DTV_ISDBT_SOUND_BROADCASTING 19 277 278#define DTV_ISDBT_SB_SUBCHANNEL_ID 20 279#define DTV_ISDBT_SB_SEGMENT_IDX 21 280#define DTV_ISDBT_SB_SEGMENT_COUNT 22 281 282#define DTV_ISDBT_LAYERA_FEC 23 283#define DTV_ISDBT_LAYERA_MODULATION 24 284#define DTV_ISDBT_LAYERA_SEGMENT_COUNT 25 285#define DTV_ISDBT_LAYERA_TIME_INTERLEAVING 26 286 287#define DTV_ISDBT_LAYERB_FEC 27 288#define DTV_ISDBT_LAYERB_MODULATION 28 289#define DTV_ISDBT_LAYERB_SEGMENT_COUNT 29 290#define DTV_ISDBT_LAYERB_TIME_INTERLEAVING 30 291 292#define DTV_ISDBT_LAYERC_FEC 31 293#define DTV_ISDBT_LAYERC_MODULATION 32 294#define DTV_ISDBT_LAYERC_SEGMENT_COUNT 33 295#define DTV_ISDBT_LAYERC_TIME_INTERLEAVING 34 296 297#define DTV_API_VERSION 35 298 299#define DTV_CODE_RATE_HP 36 300#define DTV_CODE_RATE_LP 37 301#define DTV_GUARD_INTERVAL 38 302#define DTV_TRANSMISSION_MODE 39 303#define DTV_HIERARCHY 40 304 305#define DTV_ISDBT_LAYER_ENABLED 41 306 307#define DTV_ISDBS_TS_ID 42 308 309#define DTV_MAX_COMMAND DTV_ISDBS_TS_ID 310 311typedef enum fe_pilot { 312 PILOT_ON, 313 PILOT_OFF, 314 PILOT_AUTO, 315} fe_pilot_t; 316 317typedef enum fe_rolloff { 318 ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */ 319 ROLLOFF_20, 320 ROLLOFF_25, 321 ROLLOFF_AUTO, 322} fe_rolloff_t; 323 324typedef enum fe_delivery_system { 325 SYS_UNDEFINED, 326 SYS_DVBC_ANNEX_AC, 327 SYS_DVBC_ANNEX_B, 328 SYS_DVBT, 329 SYS_DSS, 330 SYS_DVBS, 331 SYS_DVBS2, 332 SYS_DVBH, 333 SYS_ISDBT, 334 SYS_ISDBS, 335 SYS_ISDBC, 336 SYS_ATSC, 337 SYS_ATSCMH, 338 SYS_DMBTH, 339 SYS_CMMB, 340 SYS_DAB, 341} fe_delivery_system_t; 342 343struct dtv_cmds_h { 344 char *name; /* A display name for debugging purposes */ 345 346 __u32 cmd; /* A unique ID */ 347 348 /* Flags */ 349 __u32 set:1; /* Either a set or get property */ 350 __u32 buffer:1; /* Does this property use the buffer? */ 351 __u32 reserved:30; /* Align */ 352}; 353 354struct dtv_property { 355 __u32 cmd; 356 __u32 reserved[3]; 357 union { 358 __u32 data; 359 struct { 360 __u8 data[32]; 361 __u32 len; 362 __u32 reserved1[3]; 363 void *reserved2; 364 } buffer; 365 } u; 366 int result; 367} __attribute__ ((packed)); 368 369/* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */ 370#define DTV_IOCTL_MAX_MSGS 64 371 372struct dtv_properties { 373 __u32 num; 374 struct dtv_property *props; 375}; 376 377#define <link linkend="FE_GET_PROPERTY">FE_SET_PROPERTY</link> _IOW('o', 82, struct dtv_properties) 378#define <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link> _IOR('o', 83, struct dtv_properties) 379 380 381/** 382 * When set, this flag will disable any zigzagging or other "normal" tuning 383 * behaviour. Additionally, there will be no automatic monitoring of the lock 384 * status, and hence no frontend events will be generated. If a frontend device 385 * is closed, this flag will be automatically turned off when the device is 386 * reopened read-write. 387 */ 388#define FE_TUNE_MODE_ONESHOT 0x01 389 390 391#define <link linkend="FE_GET_INFO">FE_GET_INFO</link> _IOR('o', 61, struct dvb_frontend_info) 392 393#define <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link> _IO('o', 62) 394#define <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link> _IOW('o', 63, struct dvb_diseqc_master_cmd) 395#define <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link> _IOR('o', 64, struct dvb_diseqc_slave_reply) 396#define <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link> _IO('o', 65) /* fe_sec_mini_cmd_t */ 397 398#define <link linkend="FE_SET_TONE">FE_SET_TONE</link> _IO('o', 66) /* fe_sec_tone_mode_t */ 399#define <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link> _IO('o', 67) /* fe_sec_voltage_t */ 400#define <link linkend="FE_ENABLE_HIGH_LNB_VOLTAGE">FE_ENABLE_HIGH_LNB_VOLTAGE</link> _IO('o', 68) /* int */ 401 402#define <link linkend="FE_READ_STATUS">FE_READ_STATUS</link> _IOR('o', 69, fe_status_t) 403#define <link linkend="FE_READ_BER">FE_READ_BER</link> _IOR('o', 70, __u32) 404#define <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link> _IOR('o', 71, __u16) 405#define <link linkend="FE_READ_SNR">FE_READ_SNR</link> _IOR('o', 72, __u16) 406#define <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link> _IOR('o', 73, __u32) 407 408#define <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link> _IOW('o', 76, struct dvb_frontend_parameters) 409#define <link linkend="FE_GET_FRONTEND">FE_GET_FRONTEND</link> _IOR('o', 77, struct dvb_frontend_parameters) 410#define <link linkend="FE_SET_FRONTEND_TUNE_MODE">FE_SET_FRONTEND_TUNE_MODE</link> _IO('o', 81) /* unsigned int */ 411#define <link linkend="FE_GET_EVENT">FE_GET_EVENT</link> _IOR('o', 78, struct dvb_frontend_event) 412 413#define <link linkend="FE_DISHNETWORK_SEND_LEGACY_CMD">FE_DISHNETWORK_SEND_LEGACY_CMD</link> _IO('o', 80) /* unsigned int */ 414 415#endif /*_DVBFRONTEND_H_*/ 416</programlisting> 417