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 <asm/types.h>
  30
  31
  32 typedef enum fe_type {
  33         FE_QPSK,
  34         FE_QAM,
  35         FE_OFDM
  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_NEEDS_BENDING              = 0x20000000, // frontend requires frequency bending
  63         FE_CAN_RECOVER                = 0x40000000, // frontend can recover from a cable unplug automatically
  64         FE_CAN_MUTE_TS                = 0x80000000  // frontend can stop spurious TS data output
  65 } fe_caps_t;
  66
  67
  68 struct dvb_frontend_info {
  69         char       name[128];
  70         fe_type_t  type;
  71         __u32      frequency_min;
  72         __u32      frequency_max;
  73         __u32      frequency_stepsize;
  74         __u32      frequency_tolerance;
  75         __u32      symbol_rate_min;
  76         __u32      symbol_rate_max;
  77         __u32      symbol_rate_tolerance;     /* ppm */
  78         __u32      notifier_delay;            /* ms */
  79         fe_caps_t  caps;
  80 };
  81
  82
  83 /**
  84  *  Check out the DiSEqC bus spec available on http://www.eutelsat.org/ for
  85  *  the meaning of this struct...
  86  */
  87 struct dvb_diseqc_master_cmd {
  88         __u8 msg [6];        /*  { framing, address, command, data [3] } */
  89         __u8 msg_len;        /*  valid values are 3...6  */
  90 };
  91
  92
  93 struct dvb_diseqc_slave_reply {
  94         __u8 msg [4];        /*  { framing, data [3] } */
  95         __u8 msg_len;        /*  valid values are 0...4, 0 means no msg  */
  96         int     timeout;        /*  return from ioctl after timeout ms with */
  97 };                              /*  errorcode when no message was received  */
  98
  99
 100 typedef enum fe_sec_voltage {
 101         SEC_VOLTAGE_13,
 102         SEC_VOLTAGE_18,
 103         SEC_VOLTAGE_OFF
 104 } fe_sec_voltage_t;
 105
 106
 107 typedef enum fe_sec_tone_mode {
 108         SEC_TONE_ON,
 109         SEC_TONE_OFF
 110 } fe_sec_tone_mode_t;
 111
 112
 113 typedef enum fe_sec_mini_cmd {
 114         SEC_MINI_A,
 115         SEC_MINI_B
 116 } fe_sec_mini_cmd_t;
 117
 118
 119 typedef enum fe_status {
 120         FE_HAS_SIGNAL     = 0x01,   /*  found something above the noise level */
 121         FE_HAS_CARRIER    = 0x02,   /*  found a DVB signal  */
 122         FE_HAS_VITERBI    = 0x04,   /*  FEC is stable  */
 123         FE_HAS_SYNC       = 0x08,   /*  found sync bytes  */
 124         FE_HAS_LOCK       = 0x10,   /*  everything's working... */
 125         FE_TIMEDOUT       = 0x20,   /*  no lock within the last ~2 seconds */
 126         FE_REINIT         = 0x40    /*  frontend was reinitialized,  */
 127 } fe_status_t;                      /*  application is recommended to reset */
 128                                     /*  DiSEqC, tone and parameters */
 129
 130 typedef enum fe_spectral_inversion {
 131         INVERSION_OFF,
 132         INVERSION_ON,
 133         INVERSION_AUTO
 134 } fe_spectral_inversion_t;
 135
 136
 137 typedef enum fe_code_rate {
 138         FEC_NONE = 0,
 139         FEC_1_2,
 140         FEC_2_3,
 141         FEC_3_4,
 142         FEC_4_5,
 143         FEC_5_6,
 144         FEC_6_7,
 145         FEC_7_8,
 146         FEC_8_9,
 147         FEC_AUTO
 148 } fe_code_rate_t;
 149
 150
 151 typedef enum fe_modulation {
 152         QPSK,
 153         QAM_16,
 154         QAM_32,
 155         QAM_64,
 156         QAM_128,
 157         QAM_256,
 158         QAM_AUTO
 159 } fe_modulation_t;
 160
 161
 162 typedef enum fe_transmit_mode {
 163         TRANSMISSION_MODE_2K,
 164         TRANSMISSION_MODE_8K,
 165         TRANSMISSION_MODE_AUTO
 166 } fe_transmit_mode_t;
 167
 168 typedef enum fe_bandwidth {
 169         BANDWIDTH_8_MHZ,
 170         BANDWIDTH_7_MHZ,
 171         BANDWIDTH_6_MHZ,
 172         BANDWIDTH_AUTO
 173 } fe_bandwidth_t;
 174
 175
 176 typedef enum fe_guard_interval {
 177         GUARD_INTERVAL_1_32,
 178         GUARD_INTERVAL_1_16,
 179         GUARD_INTERVAL_1_8,
 180         GUARD_INTERVAL_1_4,
 181         GUARD_INTERVAL_AUTO
 182 } fe_guard_interval_t;
 183
 184
 185 typedef enum fe_hierarchy {
 186         HIERARCHY_NONE,
 187         HIERARCHY_1,
 188         HIERARCHY_2,
 189         HIERARCHY_4,
 190         HIERARCHY_AUTO
 191 } fe_hierarchy_t;
 192
 193
 194 struct dvb_qpsk_parameters {
 195         __u32           symbol_rate;  /* symbol rate in Symbols per second */
 196         fe_code_rate_t  fec_inner;    /* forward error correction (see above) */
 197 };
 198
 199
 200 struct dvb_qam_parameters {
 201         __u32            symbol_rate; /* symbol rate in Symbols per second */
 202         fe_code_rate_t   fec_inner;   /* forward error correction (see above) */
 203         fe_modulation_t  modulation;  /* modulation type (see above) */
 204 };
 205
 206
 207 struct dvb_ofdm_parameters {
 208         fe_bandwidth_t      bandwidth;
 209         fe_code_rate_t      code_rate_HP;  /* high priority stream code rate */
 210         fe_code_rate_t      code_rate_LP;  /* low priority stream code rate */
 211         fe_modulation_t     constellation; /* modulation type (see above) */
 212         fe_transmit_mode_t  transmission_mode;
 213         fe_guard_interval_t guard_interval;
 214         fe_hierarchy_t      hierarchy_information;
 215 };
 216
 217
 218 struct dvb_frontend_parameters {
 219         __u32 frequency;     /* (absolute) frequency in Hz for QAM/OFDM */
 220                                   /* intermediate frequency in kHz for QPSK */
 221         fe_spectral_inversion_t inversion;
 222         union {
 223                 struct dvb_qpsk_parameters qpsk;
 224                 struct dvb_qam_parameters  qam;
 225                 struct dvb_ofdm_parameters ofdm;
 226         } u;
 227 };
 228
 229
 230 struct dvb_frontend_event {
 231         fe_status_t status;
 232         struct dvb_frontend_parameters parameters;
 233 };
 234
 235
 236
 237 #define FE_GET_INFO                _IOR('o', 61, struct dvb_frontend_info)
 238
 239 #define FE_DISEQC_RESET_OVERLOAD   _IO('o', 62)
 240 #define FE_DISEQC_SEND_MASTER_CMD  _IOW('o', 63, struct dvb_diseqc_master_cmd)
 241 #define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply)
 242 #define FE_DISEQC_SEND_BURST       _IO('o', 65)  /* fe_sec_mini_cmd_t */
 243
 244 #define FE_SET_TONE                _IO('o', 66)  /* fe_sec_tone_mode_t */
 245 #define FE_SET_VOLTAGE             _IO('o', 67)  /* fe_sec_voltage_t */
 246 #define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68)  /* int */
 247
 248 #define FE_READ_STATUS             _IOR('o', 69, fe_status_t)
 249 #define FE_READ_BER                _IOR('o', 70, __u32)
 250 #define FE_READ_SIGNAL_STRENGTH    _IOR('o', 71, __u16)
 251 #define FE_READ_SNR                _IOR('o', 72, __u16)
 252 #define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32)
 253
 254 #define FE_SET_FRONTEND            _IOW('o', 76, struct dvb_frontend_parameters)
 255 #define FE_GET_FRONTEND            _IOR('o', 77, struct dvb_frontend_parameters)
 256 #define FE_GET_EVENT               _IOR('o', 78, struct dvb_frontend_event)
 257
 258
 259 #endif /*_DVBFRONTEND_H_*/
 260