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