include/linux/dvb/frontend.h

   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;                        /* DEPRECATED. Use DTV_ENUM_DELSYS instead */
  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         FEC_2_5,
 156 } fe_code_rate_t;
 157
 158
 159 typedef 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         QAM_4_NR,
 174 } fe_modulation_t;
 175
 176 typedef enum fe_transmit_mode {
 177         TRANSMISSION_MODE_2K,
 178         TRANSMISSION_MODE_8K,
 179         TRANSMISSION_MODE_AUTO,
 180         TRANSMISSION_MODE_4K,
 181         TRANSMISSION_MODE_1K,
 182         TRANSMISSION_MODE_16K,
 183         TRANSMISSION_MODE_32K,
 184         TRANSMISSION_MODE_C1,
 185         TRANSMISSION_MODE_C3780,
 186 } fe_transmit_mode_t;
 187
 188 #if defined(__DVB_CORE__) || !defined (__KERNEL__)
 189 typedef enum fe_bandwidth {
 190         BANDWIDTH_8_MHZ,
 191         BANDWIDTH_7_MHZ,
 192         BANDWIDTH_6_MHZ,
 193         BANDWIDTH_AUTO,
 194         BANDWIDTH_5_MHZ,
 195         BANDWIDTH_10_MHZ,
 196         BANDWIDTH_1_712_MHZ,
 197 } fe_bandwidth_t;
 198 #endif
 199
 200 typedef enum fe_guard_interval {
 201         GUARD_INTERVAL_1_32,
 202         GUARD_INTERVAL_1_16,
 203         GUARD_INTERVAL_1_8,
 204         GUARD_INTERVAL_1_4,
 205         GUARD_INTERVAL_AUTO,
 206         GUARD_INTERVAL_1_128,
 207         GUARD_INTERVAL_19_128,
 208         GUARD_INTERVAL_19_256,
 209         GUARD_INTERVAL_PN420,
 210         GUARD_INTERVAL_PN595,
 211         GUARD_INTERVAL_PN945,
 212 } fe_guard_interval_t;
 213
 214
 215 typedef enum fe_hierarchy {
 216         HIERARCHY_NONE,
 217         HIERARCHY_1,
 218         HIERARCHY_2,
 219         HIERARCHY_4,
 220         HIERARCHY_AUTO
 221 } fe_hierarchy_t;
 222
 223 enum fe_interleaving {
 224         INTERLEAVING_NONE,
 225         INTERLEAVING_AUTO,
 226         INTERLEAVING_240,
 227         INTERLEAVING_720,
 228 };
 229
 230 #if defined(__DVB_CORE__) || !defined (__KERNEL__)
 231 struct dvb_qpsk_parameters {
 232         __u32           symbol_rate;  /* symbol rate in Symbols per second */
 233         fe_code_rate_t  fec_inner;    /* forward error correction (see above) */
 234 };
 235
 236 struct dvb_qam_parameters {
 237         __u32           symbol_rate; /* symbol rate in Symbols per second */
 238         fe_code_rate_t  fec_inner;   /* forward error correction (see above) */
 239         fe_modulation_t modulation;  /* modulation type (see above) */
 240 };
 241
 242 struct dvb_vsb_parameters {
 243         fe_modulation_t modulation;  /* modulation type (see above) */
 244 };
 245
 246 struct dvb_ofdm_parameters {
 247         fe_bandwidth_t      bandwidth;
 248         fe_code_rate_t      code_rate_HP;  /* high priority stream code rate */
 249         fe_code_rate_t      code_rate_LP;  /* low priority stream code rate */
 250         fe_modulation_t     constellation; /* modulation type (see above) */
 251         fe_transmit_mode_t  transmission_mode;
 252         fe_guard_interval_t guard_interval;
 253         fe_hierarchy_t      hierarchy_information;
 254 };
 255
 256
 257 struct dvb_frontend_parameters {
 258         __u32 frequency;     /* (absolute) frequency in Hz for QAM/OFDM/ATSC */
 259                              /* intermediate frequency in kHz for QPSK */
 260         fe_spectral_inversion_t inversion;
 261         union {
 262                 struct dvb_qpsk_parameters qpsk;
 263                 struct dvb_qam_parameters  qam;
 264                 struct dvb_ofdm_parameters ofdm;
 265                 struct dvb_vsb_parameters vsb;
 266         } u;
 267 };
 268
 269 struct dvb_frontend_event {
 270         fe_status_t status;
 271         struct dvb_frontend_parameters parameters;
 272 };
 273 #endif
 274
 275 /* S2API Commands */
 276 #define DTV_UNDEFINED           0
 277 #define DTV_TUNE                1
 278 #define DTV_CLEAR               2
 279 #define DTV_FREQUENCY           3
 280 #define DTV_MODULATION          4
 281 #define DTV_BANDWIDTH_HZ        5
 282 #define DTV_INVERSION           6
 283 #define DTV_DISEQC_MASTER       7
 284 #define DTV_SYMBOL_RATE         8
 285 #define DTV_INNER_FEC           9
 286 #define DTV_VOLTAGE             10
 287 #define DTV_TONE                11
 288 #define DTV_PILOT               12
 289 #define DTV_ROLLOFF             13
 290 #define DTV_DISEQC_SLAVE_REPLY  14
 291
 292 /* Basic enumeration set for querying unlimited capabilities */
 293 #define DTV_FE_CAPABILITY_COUNT 15
 294 #define DTV_FE_CAPABILITY       16
 295 #define DTV_DELIVERY_SYSTEM     17
 296
 297 /* ISDB-T and ISDB-Tsb */
 298 #define DTV_ISDBT_PARTIAL_RECEPTION     18
 299 #define DTV_ISDBT_SOUND_BROADCASTING    19
 300
 301 #define DTV_ISDBT_SB_SUBCHANNEL_ID      20
 302 #define DTV_ISDBT_SB_SEGMENT_IDX        21
 303 #define DTV_ISDBT_SB_SEGMENT_COUNT      22
 304
 305 #define DTV_ISDBT_LAYERA_FEC                    23
 306 #define DTV_ISDBT_LAYERA_MODULATION             24
 307 #define DTV_ISDBT_LAYERA_SEGMENT_COUNT          25
 308 #define DTV_ISDBT_LAYERA_TIME_INTERLEAVING      26
 309
 310 #define DTV_ISDBT_LAYERB_FEC                    27
 311 #define DTV_ISDBT_LAYERB_MODULATION             28
 312 #define DTV_ISDBT_LAYERB_SEGMENT_COUNT          29
 313 #define DTV_ISDBT_LAYERB_TIME_INTERLEAVING      30
 314
 315 #define DTV_ISDBT_LAYERC_FEC                    31
 316 #define DTV_ISDBT_LAYERC_MODULATION             32
 317 #define DTV_ISDBT_LAYERC_SEGMENT_COUNT          33
 318 #define DTV_ISDBT_LAYERC_TIME_INTERLEAVING      34
 319
 320 #define DTV_API_VERSION         35
 321
 322 #define DTV_CODE_RATE_HP        36
 323 #define DTV_CODE_RATE_LP        37
 324 #define DTV_GUARD_INTERVAL      38
 325 #define DTV_TRANSMISSION_MODE   39
 326 #define DTV_HIERARCHY           40
 327
 328 #define DTV_ISDBT_LAYER_ENABLED 41
 329
 330 #define DTV_ISDBS_TS_ID         42
 331
 332 #define DTV_DVBT2_PLP_ID        43
 333
 334 #define DTV_ENUM_DELSYS         44
 335
 336 /* ATSC-MH */
 337 #define DTV_ATSCMH_FIC_VER              45
 338 #define DTV_ATSCMH_PARADE_ID            46
 339 #define DTV_ATSCMH_NOG                  47
 340 #define DTV_ATSCMH_TNOG                 48
 341 #define DTV_ATSCMH_SGN                  49
 342 #define DTV_ATSCMH_PRC                  50
 343 #define DTV_ATSCMH_RS_FRAME_MODE        51
 344 #define DTV_ATSCMH_RS_FRAME_ENSEMBLE    52
 345 #define DTV_ATSCMH_RS_CODE_MODE_PRI     53
 346 #define DTV_ATSCMH_RS_CODE_MODE_SEC     54
 347 #define DTV_ATSCMH_SCCC_BLOCK_MODE      55
 348 #define DTV_ATSCMH_SCCC_CODE_MODE_A     56
 349 #define DTV_ATSCMH_SCCC_CODE_MODE_B     57
 350 #define DTV_ATSCMH_SCCC_CODE_MODE_C     58
 351 #define DTV_ATSCMH_SCCC_CODE_MODE_D     59
 352
 353 #define DTV_INTERLEAVING                        60
 354
 355 #define DTV_MAX_COMMAND                         DTV_INTERLEAVING
 356
 357 typedef enum fe_pilot {
 358         PILOT_ON,
 359         PILOT_OFF,
 360         PILOT_AUTO,
 361 } fe_pilot_t;
 362
 363 typedef enum fe_rolloff {
 364         ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
 365         ROLLOFF_20,
 366         ROLLOFF_25,
 367         ROLLOFF_AUTO,
 368 } fe_rolloff_t;
 369
 370 typedef enum fe_delivery_system {
 371         SYS_UNDEFINED,
 372         SYS_DVBC_ANNEX_A,
 373         SYS_DVBC_ANNEX_B,
 374         SYS_DVBT,
 375         SYS_DSS,
 376         SYS_DVBS,
 377         SYS_DVBS2,
 378         SYS_DVBH,
 379         SYS_ISDBT,
 380         SYS_ISDBS,
 381         SYS_ISDBC,
 382         SYS_ATSC,
 383         SYS_ATSCMH,
 384         SYS_DTMB,
 385         SYS_CMMB,
 386         SYS_DAB,
 387         SYS_DVBT2,
 388         SYS_TURBO,
 389         SYS_DVBC_ANNEX_C,
 390 } fe_delivery_system_t;
 391
 392 /* backward compatibility */
 393 #define SYS_DVBC_ANNEX_AC       SYS_DVBC_ANNEX_A
 394 #define SYS_DMBTH SYS_DTMB /* DMB-TH is legacy name, use DTMB instead */
 395
 396 /* ATSC-MH */
 397
 398 enum atscmh_sccc_block_mode {
 399         ATSCMH_SCCC_BLK_SEP      = 0,
 400         ATSCMH_SCCC_BLK_COMB     = 1,
 401         ATSCMH_SCCC_BLK_RES      = 2,
 402 };
 403
 404 enum atscmh_sccc_code_mode {
 405         ATSCMH_SCCC_CODE_HLF     = 0,
 406         ATSCMH_SCCC_CODE_QTR     = 1,
 407         ATSCMH_SCCC_CODE_RES     = 2,
 408 };
 409
 410 enum atscmh_rs_frame_ensemble {
 411         ATSCMH_RSFRAME_ENS_PRI   = 0,
 412         ATSCMH_RSFRAME_ENS_SEC   = 1,
 413 };
 414
 415 enum atscmh_rs_frame_mode {
 416         ATSCMH_RSFRAME_PRI_ONLY  = 0,
 417         ATSCMH_RSFRAME_PRI_SEC   = 1,
 418         ATSCMH_RSFRAME_RES       = 2,
 419 };
 420
 421 enum atscmh_rs_code_mode {
 422         ATSCMH_RSCODE_211_187    = 0,
 423         ATSCMH_RSCODE_223_187    = 1,
 424         ATSCMH_RSCODE_235_187    = 2,
 425         ATSCMH_RSCODE_RES        = 3,
 426 };
 427
 428
 429 struct dtv_cmds_h {
 430         char    *name;          /* A display name for debugging purposes */
 431
 432         __u32   cmd;            /* A unique ID */
 433
 434         /* Flags */
 435         __u32   set:1;          /* Either a set or get property */
 436         __u32   buffer:1;       /* Does this property use the buffer? */
 437         __u32   reserved:30;    /* Align */
 438 };
 439
 440 struct dtv_property {
 441         __u32 cmd;
 442         __u32 reserved[3];
 443         union {
 444                 __u32 data;
 445                 struct {
 446                         __u8 data[32];
 447                         __u32 len;
 448                         __u32 reserved1[3];
 449                         void *reserved2;
 450                 } buffer;
 451         } u;
 452         int result;
 453 } __attribute__ ((packed));
 454
 455 /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
 456 #define DTV_IOCTL_MAX_MSGS 64
 457
 458 struct dtv_properties {
 459         __u32 num;
 460         struct dtv_property *props;
 461 };
 462
 463 #define FE_SET_PROPERTY            _IOW('o', 82, struct dtv_properties)
 464 #define FE_GET_PROPERTY            _IOR('o', 83, struct dtv_properties)
 465
 466
 467 /**
 468  * When set, this flag will disable any zigzagging or other "normal" tuning
 469  * behaviour. Additionally, there will be no automatic monitoring of the lock
 470  * status, and hence no frontend events will be generated. If a frontend device
 471  * is closed, this flag will be automatically turned off when the device is
 472  * reopened read-write.
 473  */
 474 #define FE_TUNE_MODE_ONESHOT 0x01
 475
 476
 477 #define FE_GET_INFO                _IOR('o', 61, struct dvb_frontend_info)
 478
 479 #define FE_DISEQC_RESET_OVERLOAD   _IO('o', 62)
 480 #define FE_DISEQC_SEND_MASTER_CMD  _IOW('o', 63, struct dvb_diseqc_master_cmd)
 481 #define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply)
 482 #define FE_DISEQC_SEND_BURST       _IO('o', 65)  /* fe_sec_mini_cmd_t */
 483
 484 #define FE_SET_TONE                _IO('o', 66)  /* fe_sec_tone_mode_t */
 485 #define FE_SET_VOLTAGE             _IO('o', 67)  /* fe_sec_voltage_t */
 486 #define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68)  /* int */
 487
 488 #define FE_READ_STATUS             _IOR('o', 69, fe_status_t)
 489 #define FE_READ_BER                _IOR('o', 70, __u32)
 490 #define FE_READ_SIGNAL_STRENGTH    _IOR('o', 71, __u16)
 491 #define FE_READ_SNR                _IOR('o', 72, __u16)
 492 #define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32)
 493
 494 #define FE_SET_FRONTEND            _IOW('o', 76, struct dvb_frontend_parameters)
 495 #define FE_GET_FRONTEND            _IOR('o', 77, struct dvb_frontend_parameters)
 496 #define FE_SET_FRONTEND_TUNE_MODE  _IO('o', 81) /* unsigned int */
 497 #define FE_GET_EVENT               _IOR('o', 78, struct dvb_frontend_event)
 498
 499 #define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */
 500
 501 #endif /*_DVBFRONTEND_H_*/