Documentation/DocBook/dvb/frontend.h.xml

   1 <programlisting>
   2 /*
   3  * frontend.h
   4  *
   5  * Copyright (C) 2000 Marcus Metzler &lt;marcus@convergence.de&gt;
   6  *                  Ralph  Metzler &lt;ralph@convergence.de&gt;
   7  *                  Holger Waechtler &lt;holger@convergence.de&gt;
   8  *                  Andre Draszik &lt;ad@convergence.de&gt;
   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 &lt;linux/types.h&gt;
  31
  32 typedef enum fe_type {
  33         FE_QPSK,
  34         FE_QAM,
  35         FE_OFDM,
  36         FE_ATSC
  37 } fe_type_t;
  38
  39
  40 typedef 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
  74 struct 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  */
  93 struct 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
  99 struct 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
 106 typedef enum fe_sec_voltage {
 107         SEC_VOLTAGE_13,
 108         SEC_VOLTAGE_18,
 109         SEC_VOLTAGE_OFF
 110 } fe_sec_voltage_t;
 111
 112
 113 typedef enum fe_sec_tone_mode {
 114         SEC_TONE_ON,
 115         SEC_TONE_OFF
 116 } fe_sec_tone_mode_t;
 117
 118
 119 typedef enum fe_sec_mini_cmd {
 120         SEC_MINI_A,
 121         SEC_MINI_B
 122 } fe_sec_mini_cmd_t;
 123
 124
 125 typedef 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
 136 typedef enum fe_spectral_inversion {
 137         INVERSION_OFF,
 138         INVERSION_ON,
 139         INVERSION_AUTO
 140 } fe_spectral_inversion_t;
 141
 142
 143 typedef 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
 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 } fe_modulation_t;
 174
 175 typedef enum fe_transmit_mode {
 176         TRANSMISSION_MODE_2K,
 177         TRANSMISSION_MODE_8K,
 178         TRANSMISSION_MODE_AUTO,
 179         TRANSMISSION_MODE_4K,
 180         TRANSMISSION_MODE_1K,
 181         TRANSMISSION_MODE_16K,
 182         TRANSMISSION_MODE_32K,
 183 } fe_transmit_mode_t;
 184
 185 typedef enum fe_bandwidth {
 186         BANDWIDTH_8_MHZ,
 187         BANDWIDTH_7_MHZ,
 188         BANDWIDTH_6_MHZ,
 189         BANDWIDTH_AUTO,
 190         BANDWIDTH_5_MHZ,
 191         BANDWIDTH_10_MHZ,
 192         BANDWIDTH_1_712_MHZ,
 193 } fe_bandwidth_t;
 194
 195
 196 typedef enum fe_guard_interval {
 197         GUARD_INTERVAL_1_32,
 198         GUARD_INTERVAL_1_16,
 199         GUARD_INTERVAL_1_8,
 200         GUARD_INTERVAL_1_4,
 201         GUARD_INTERVAL_AUTO,
 202         GUARD_INTERVAL_1_128,
 203         GUARD_INTERVAL_19_128,
 204         GUARD_INTERVAL_19_256,
 205 } fe_guard_interval_t;
 206
 207
 208 typedef enum fe_hierarchy {
 209         HIERARCHY_NONE,
 210         HIERARCHY_1,
 211         HIERARCHY_2,
 212         HIERARCHY_4,
 213         HIERARCHY_AUTO
 214 } fe_hierarchy_t;
 215
 216
 217 struct dvb_qpsk_parameters {
 218         __u32           symbol_rate;  /* symbol rate in Symbols per second */
 219         fe_code_rate_t  fec_inner;    /* forward error correction (see above) */
 220 };
 221
 222 struct dvb_qam_parameters {
 223         __u32           symbol_rate; /* symbol rate in Symbols per second */
 224         fe_code_rate_t  fec_inner;   /* forward error correction (see above) */
 225         fe_modulation_t modulation;  /* modulation type (see above) */
 226 };
 227
 228 struct dvb_vsb_parameters {
 229         fe_modulation_t modulation;  /* modulation type (see above) */
 230 };
 231
 232 struct dvb_ofdm_parameters {
 233         fe_bandwidth_t      bandwidth;
 234         fe_code_rate_t      code_rate_HP;  /* high priority stream code rate */
 235         fe_code_rate_t      code_rate_LP;  /* low priority stream code rate */
 236         fe_modulation_t     constellation; /* modulation type (see above) */
 237         fe_transmit_mode_t  transmission_mode;
 238         fe_guard_interval_t guard_interval;
 239         fe_hierarchy_t      hierarchy_information;
 240 };
 241
 242
 243 struct dvb_frontend_parameters {
 244         __u32 frequency;     /* (absolute) frequency in Hz for QAM/OFDM/ATSC */
 245                              /* intermediate frequency in kHz for QPSK */
 246         fe_spectral_inversion_t inversion;
 247         union {
 248                 struct dvb_qpsk_parameters qpsk;
 249                 struct dvb_qam_parameters  qam;
 250                 struct dvb_ofdm_parameters ofdm;
 251                 struct dvb_vsb_parameters vsb;
 252         } u;
 253 };
 254
 255
 256 struct dvb_frontend_event {
 257         fe_status_t status;
 258         struct dvb_frontend_parameters parameters;
 259 };
 260
 261 /* S2API Commands */
 262 #define DTV_UNDEFINED           0
 263 #define DTV_TUNE                1
 264 #define DTV_CLEAR               2
 265 #define DTV_FREQUENCY           3
 266 #define DTV_MODULATION          4
 267 #define DTV_BANDWIDTH_HZ        5
 268 #define DTV_INVERSION           6
 269 #define DTV_DISEQC_MASTER       7
 270 #define DTV_SYMBOL_RATE         8
 271 #define DTV_INNER_FEC           9
 272 #define DTV_VOLTAGE             10
 273 #define DTV_TONE                11
 274 #define DTV_PILOT               12
 275 #define DTV_ROLLOFF             13
 276 #define DTV_DISEQC_SLAVE_REPLY  14
 277
 278 /* Basic enumeration set for querying unlimited capabilities */
 279 #define DTV_FE_CAPABILITY_COUNT 15
 280 #define DTV_FE_CAPABILITY       16
 281 #define DTV_DELIVERY_SYSTEM     17
 282
 283 /* ISDB-T and ISDB-Tsb */
 284 #define DTV_ISDBT_PARTIAL_RECEPTION     18
 285 #define DTV_ISDBT_SOUND_BROADCASTING    19
 286
 287 #define DTV_ISDBT_SB_SUBCHANNEL_ID      20
 288 #define DTV_ISDBT_SB_SEGMENT_IDX        21
 289 #define DTV_ISDBT_SB_SEGMENT_COUNT      22
 290
 291 #define DTV_ISDBT_LAYERA_FEC                    23
 292 #define DTV_ISDBT_LAYERA_MODULATION             24
 293 #define DTV_ISDBT_LAYERA_SEGMENT_COUNT          25
 294 #define DTV_ISDBT_LAYERA_TIME_INTERLEAVING      26
 295
 296 #define DTV_ISDBT_LAYERB_FEC                    27
 297 #define DTV_ISDBT_LAYERB_MODULATION             28
 298 #define DTV_ISDBT_LAYERB_SEGMENT_COUNT          29
 299 #define DTV_ISDBT_LAYERB_TIME_INTERLEAVING      30
 300
 301 #define DTV_ISDBT_LAYERC_FEC                    31
 302 #define DTV_ISDBT_LAYERC_MODULATION             32
 303 #define DTV_ISDBT_LAYERC_SEGMENT_COUNT          33
 304 #define DTV_ISDBT_LAYERC_TIME_INTERLEAVING      34
 305
 306 #define DTV_API_VERSION         35
 307
 308 #define DTV_CODE_RATE_HP        36
 309 #define DTV_CODE_RATE_LP        37
 310 #define DTV_GUARD_INTERVAL      38
 311 #define DTV_TRANSMISSION_MODE   39
 312 #define DTV_HIERARCHY           40
 313
 314 #define DTV_ISDBT_LAYER_ENABLED 41
 315
 316 #define DTV_ISDBS_TS_ID         42
 317
 318 #define DTV_DVBT2_PLP_ID        43
 319
 320 #define DTV_MAX_COMMAND                         DTV_DVBT2_PLP_ID
 321
 322 typedef enum fe_pilot {
 323         PILOT_ON,
 324         PILOT_OFF,
 325         PILOT_AUTO,
 326 } fe_pilot_t;
 327
 328 typedef enum fe_rolloff {
 329         ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
 330         ROLLOFF_20,
 331         ROLLOFF_25,
 332         ROLLOFF_AUTO,
 333 } fe_rolloff_t;
 334
 335 typedef enum fe_delivery_system {
 336         SYS_UNDEFINED,
 337         SYS_DVBC_ANNEX_AC,
 338         SYS_DVBC_ANNEX_B,
 339         SYS_DVBT,
 340         SYS_DSS,
 341         SYS_DVBS,
 342         SYS_DVBS2,
 343         SYS_DVBH,
 344         SYS_ISDBT,
 345         SYS_ISDBS,
 346         SYS_ISDBC,
 347         SYS_ATSC,
 348         SYS_ATSCMH,
 349         SYS_DMBTH,
 350         SYS_CMMB,
 351         SYS_DAB,
 352         SYS_DVBT2,
 353 } fe_delivery_system_t;
 354
 355 struct dtv_cmds_h {
 356         char    *name;          /* A display name for debugging purposes */
 357
 358         __u32   cmd;            /* A unique ID */
 359
 360         /* Flags */
 361         __u32   set:1;          /* Either a set or get property */
 362         __u32   buffer:1;       /* Does this property use the buffer? */
 363         __u32   reserved:30;    /* Align */
 364 };
 365
 366 struct dtv_property {
 367         __u32 cmd;
 368         __u32 reserved[3];
 369         union {
 370                 __u32 data;
 371                 struct {
 372                         __u8 data[32];
 373                         __u32 len;
 374                         __u32 reserved1[3];
 375                         void *reserved2;
 376                 } buffer;
 377         } u;
 378         int result;
 379 } __attribute__ ((packed));
 380
 381 /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
 382 #define DTV_IOCTL_MAX_MSGS 64
 383
 384 struct dtv_properties {
 385         __u32 num;
 386         struct dtv_property *props;
 387 };
 388
 389 #define <link linkend="FE_GET_PROPERTY">FE_SET_PROPERTY</link>            _IOW('o', 82, struct dtv_properties)
 390 #define <link linkend="FE_GET_PROPERTY">FE_GET_PROPERTY</link>            _IOR('o', 83, struct dtv_properties)
 391
 392
 393 /**
 394  * When set, this flag will disable any zigzagging or other "normal" tuning
 395  * behaviour. Additionally, there will be no automatic monitoring of the lock
 396  * status, and hence no frontend events will be generated. If a frontend device
 397  * is closed, this flag will be automatically turned off when the device is
 398  * reopened read-write.
 399  */
 400 #define FE_TUNE_MODE_ONESHOT 0x01
 401
 402
 403 #define <link linkend="FE_GET_INFO">FE_GET_INFO</link>                _IOR('o', 61, struct dvb_frontend_info)
 404
 405 #define <link linkend="FE_DISEQC_RESET_OVERLOAD">FE_DISEQC_RESET_OVERLOAD</link>   _IO('o', 62)
 406 #define <link linkend="FE_DISEQC_SEND_MASTER_CMD">FE_DISEQC_SEND_MASTER_CMD</link>  _IOW('o', 63, struct dvb_diseqc_master_cmd)
 407 #define <link linkend="FE_DISEQC_RECV_SLAVE_REPLY">FE_DISEQC_RECV_SLAVE_REPLY</link> _IOR('o', 64, struct dvb_diseqc_slave_reply)
 408 #define <link linkend="FE_DISEQC_SEND_BURST">FE_DISEQC_SEND_BURST</link>       _IO('o', 65)  /* fe_sec_mini_cmd_t */
 409
 410 #define <link linkend="FE_SET_TONE">FE_SET_TONE</link>                _IO('o', 66)  /* fe_sec_tone_mode_t */
 411 #define <link linkend="FE_SET_VOLTAGE">FE_SET_VOLTAGE</link>             _IO('o', 67)  /* fe_sec_voltage_t */
 412 #define <link linkend="FE_ENABLE_HIGH_LNB_VOLTAGE">FE_ENABLE_HIGH_LNB_VOLTAGE</link> _IO('o', 68)  /* int */
 413
 414 #define <link linkend="FE_READ_STATUS">FE_READ_STATUS</link>             _IOR('o', 69, fe_status_t)
 415 #define <link linkend="FE_READ_BER">FE_READ_BER</link>                _IOR('o', 70, __u32)
 416 #define <link linkend="FE_READ_SIGNAL_STRENGTH">FE_READ_SIGNAL_STRENGTH</link>    _IOR('o', 71, __u16)
 417 #define <link linkend="FE_READ_SNR">FE_READ_SNR</link>                _IOR('o', 72, __u16)
 418 #define <link linkend="FE_READ_UNCORRECTED_BLOCKS">FE_READ_UNCORRECTED_BLOCKS</link> _IOR('o', 73, __u32)
 419
 420 #define <link linkend="FE_SET_FRONTEND">FE_SET_FRONTEND</link>            _IOW('o', 76, struct dvb_frontend_parameters)
 421 #define <link linkend="FE_GET_FRONTEND">FE_GET_FRONTEND</link>            _IOR('o', 77, struct dvb_frontend_parameters)
 422 #define <link linkend="FE_SET_FRONTEND_TUNE_MODE">FE_SET_FRONTEND_TUNE_MODE</link>  _IO('o', 81) /* unsigned int */
 423 #define <link linkend="FE_GET_EVENT">FE_GET_EVENT</link>               _IOR('o', 78, struct dvb_frontend_event)
 424
 425 #define <link linkend="FE_DISHNETWORK_SEND_LEGACY_CMD">FE_DISHNETWORK_SEND_LEGACY_CMD</link> _IO('o', 80) /* unsigned int */
 426
 427 #endif /*_DVBFRONTEND_H_*/
 428 </programlisting>