kernel/drivers/media/dvb-core/dvb_frontend.h

   1 /*
   2  * dvb_frontend.h
   3  *
   4  * Copyright (C) 2001 convergence integrated media GmbH
   5  * Copyright (C) 2004 convergence GmbH
   6  *
   7  * Written by Ralph Metzler
   8  * Overhauled by Holger Waechtler
   9  * Kernel I2C stuff by Michael Hunold <hunold@convergence.de>
  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
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  25  *
  26  */
  27
  28 #ifndef _DVB_FRONTEND_H_
  29 #define _DVB_FRONTEND_H_
  30
  31 #include <linux/types.h>
  32 #include <linux/sched.h>
  33 #include <linux/ioctl.h>
  34 #include <linux/i2c.h>
  35 #include <linux/module.h>
  36 #include <linux/errno.h>
  37 #include <linux/delay.h>
  38 #include <linux/mutex.h>
  39 #include <linux/slab.h>
  40
  41 #include <linux/dvb/frontend.h>
  42
  43 #include "dvbdev.h"
  44
  45 /*
  46  * Maximum number of Delivery systems per frontend. It
  47  * should be smaller or equal to 32
  48  */
  49 #define MAX_DELSYS      8
  50
  51 /**
  52  * struct dvb_frontend_tune_settings - parameters to adjust frontend tuning
  53  *
  54  * @min_delay_ms:       minimum delay for tuning, in ms
  55  * @step_size:          step size between two consecutive frequencies
  56  * @max_drift:          maximum drift
  57  *
  58  * NOTE: step_size is in Hz, for terrestrial/cable or kHz for satellite
  59  */
  60 struct dvb_frontend_tune_settings {
  61         int min_delay_ms;
  62         int step_size;
  63         int max_drift;
  64 };
  65
  66 struct dvb_frontend;
  67
  68 /**
  69  * struct dvb_tuner_info - Frontend name and min/max ranges/bandwidths
  70  *
  71  * @name:               name of the Frontend
  72  * @frequency_min:      minimal frequency supported
  73  * @frequency_max:      maximum frequency supported
  74  * @frequency_step:     frequency step
  75  * @bandwidth_min:      minimal frontend bandwidth supported
  76  * @bandwidth_max:      maximum frontend bandwidth supported
  77  * @bandwidth_step:     frontend bandwidth step
  78  *
  79  * NOTE: frequency parameters are in Hz, for terrestrial/cable or kHz for
  80  * satellite.
  81  */
  82 struct dvb_tuner_info {
  83         char name[128];
  84
  85         u32 frequency_min;
  86         u32 frequency_max;
  87         u32 frequency_step;
  88
  89         u32 bandwidth_min;
  90         u32 bandwidth_max;
  91         u32 bandwidth_step;
  92 };
  93
  94 /**
  95  * struct analog_parameters - Parameters to tune into an analog/radio channel
  96  *
  97  * @frequency:  Frequency used by analog TV tuner (either in 62.5 kHz step,
  98  *              for TV, or 62.5 Hz for radio)
  99  * @mode:       Tuner mode, as defined on enum v4l2_tuner_type
 100  * @audmode:    Audio mode as defined for the rxsubchans field at videodev2.h,
 101  *              e. g. V4L2_TUNER_MODE_*
 102  * @std:        TV standard bitmap as defined at videodev2.h, e. g. V4L2_STD_*
 103  *
 104  * Hybrid tuners should be supported by both V4L2 and DVB APIs. This
 105  * struct contains the data that are used by the V4L2 side. To avoid
 106  * dependencies from V4L2 headers, all enums here are declared as integers.
 107  */
 108 struct analog_parameters {
 109         unsigned int frequency;
 110         unsigned int mode;
 111         unsigned int audmode;
 112         u64 std;
 113 };
 114
 115 enum tuner_param {
 116         DVBFE_TUNER_FREQUENCY           = (1 <<  0),
 117         DVBFE_TUNER_TUNERSTEP           = (1 <<  1),
 118         DVBFE_TUNER_IFFREQ              = (1 <<  2),
 119         DVBFE_TUNER_BANDWIDTH           = (1 <<  3),
 120         DVBFE_TUNER_REFCLOCK            = (1 <<  4),
 121         DVBFE_TUNER_IQSENSE             = (1 <<  5),
 122         DVBFE_TUNER_DUMMY               = (1 << 31)
 123 };
 124
 125 /**
 126  * enum dvbfe_algo - defines the algorithm used to tune into a channel
 127  *
 128  * @DVBFE_ALGO_HW: Hardware Algorithm -
 129  *      Devices that support this algorithm do everything in hardware
 130  *      and no software support is needed to handle them.
 131  *      Requesting these devices to LOCK is the only thing required,
 132  *      device is supposed to do everything in the hardware.
 133  *
 134  * @DVBFE_ALGO_SW: Software Algorithm -
 135  * These are dumb devices, that require software to do everything
 136  *
 137  * @DVBFE_ALGO_CUSTOM: Customizable Agorithm -
 138  *      Devices having this algorithm can be customized to have specific
 139  *      algorithms in the frontend driver, rather than simply doing a
 140  *      software zig-zag. In this case the zigzag maybe hardware assisted
 141  *      or it maybe completely done in hardware. In all cases, usage of
 142  *      this algorithm, in conjunction with the search and track
 143  *      callbacks, utilizes the driver specific algorithm.
 144  *
 145  * @DVBFE_ALGO_RECOVERY: Recovery Algorithm -
 146  *      These devices have AUTO recovery capabilities from LOCK failure
 147  */
 148 enum dvbfe_algo {
 149         DVBFE_ALGO_HW                   = (1 <<  0),
 150         DVBFE_ALGO_SW                   = (1 <<  1),
 151         DVBFE_ALGO_CUSTOM               = (1 <<  2),
 152         DVBFE_ALGO_RECOVERY             = (1 << 31)
 153 };
 154
 155 struct tuner_state {
 156         u32 frequency;
 157         u32 tunerstep;
 158         u32 ifreq;
 159         u32 bandwidth;
 160         u32 iqsense;
 161         u32 refclock;
 162 };
 163
 164 /**
 165  * enum dvbfe_search - search callback possible return status
 166  *
 167  * @DVBFE_ALGO_SEARCH_SUCCESS:
 168  *      The frontend search algorithm completed and returned successfully
 169  *
 170  * @DVBFE_ALGO_SEARCH_ASLEEP:
 171  *      The frontend search algorithm is sleeping
 172  *
 173  * @DVBFE_ALGO_SEARCH_FAILED:
 174  *      The frontend search for a signal failed
 175  *
 176  * @DVBFE_ALGO_SEARCH_INVALID:
 177  *      The frontend search algorith was probably supplied with invalid
 178  *      parameters and the search is an invalid one
 179  *
 180  * @DVBFE_ALGO_SEARCH_ERROR:
 181  *      The frontend search algorithm failed due to some error
 182  *
 183  * @DVBFE_ALGO_SEARCH_AGAIN:
 184  *      The frontend search algorithm was requested to search again
 185  */
 186 enum dvbfe_search {
 187         DVBFE_ALGO_SEARCH_SUCCESS       = (1 <<  0),
 188         DVBFE_ALGO_SEARCH_ASLEEP        = (1 <<  1),
 189         DVBFE_ALGO_SEARCH_FAILED        = (1 <<  2),
 190         DVBFE_ALGO_SEARCH_INVALID       = (1 <<  3),
 191         DVBFE_ALGO_SEARCH_AGAIN         = (1 <<  4),
 192         DVBFE_ALGO_SEARCH_ERROR         = (1 << 31),
 193 };
 194
 195 /**
 196  * struct dvb_tuner_ops - Tuner information and callbacks
 197  *
 198  * @info:               embedded struct dvb_tuner_info with tuner properties
 199  * @release:            callback function called when frontend is dettached.
 200  *                      drivers should free any allocated memory.
 201  * @init:               callback function used to initialize the tuner device.
 202  * @sleep:              callback function used to put the tuner to sleep.
 203  * @suspend:            callback function used to inform that the Kernel will
 204  *                      suspend.
 205  * @resume:             callback function used to inform that the Kernel is
 206  *                      resuming from suspend.
 207  * @set_params:         callback function used to inform the tuner to tune
 208  *                      into a digital TV channel. The properties to be used
 209  *                      are stored at @dvb_frontend.dtv_property_cache;. The
 210  *                      tuner demod can change the parameters to reflect the
 211  *                      changes needed for the channel to be tuned, and
 212  *                      update statistics.
 213  * @set_analog_params:  callback function used to tune into an analog TV
 214  *                      channel on hybrid tuners. It passes @analog_parameters;
 215  *                      to the driver.
 216  * @calc_regs:          callback function used to pass register data settings
 217  *                      for simple tuners.
 218  * @set_config:         callback function used to send some tuner-specific
 219  *                      parameters.
 220  * @get_frequency:      get the actual tuned frequency
 221  * @get_bandwidth:      get the bandwitdh used by the low pass filters
 222  * @get_if_frequency:   get the Intermediate Frequency, in Hz. For baseband,
 223  *                      should return 0.
 224  * @get_status:         returns the frontend lock status
 225  * @get_rf_strength:    returns the RF signal strengh. Used mostly to support
 226  *                      analog TV and radio. Digital TV should report, instead,
 227  *                      via DVBv5 API (@dvb_frontend.dtv_property_cache;).
 228  * @get_afc:            Used only by analog TV core. Reports the frequency
 229  *                      drift due to AFC.
 230  * @set_frequency:      Set a new frequency. Please notice that using
 231  *                      set_params is preferred.
 232  * @set_bandwidth:      Set a new frequency. Please notice that using
 233  *                      set_params is preferred.
 234  * @set_state:          callback function used on some legacy drivers that
 235  *                      don't implement set_params in order to set properties.
 236  *                      Shouldn't be used on new drivers.
 237  * @get_state:          callback function used to get properties by some
 238  *                      legacy drivers that don't implement set_params.
 239  *                      Shouldn't be used on new drivers.
 240  *
 241  * NOTE: frequencies used on get_frequency and set_frequency are in Hz for
 242  * terrestrial/cable or kHz for satellite.
 243  *
 244  */
 245 struct dvb_tuner_ops {
 246
 247         struct dvb_tuner_info info;
 248
 249         int (*release)(struct dvb_frontend *fe);
 250         int (*init)(struct dvb_frontend *fe);
 251         int (*sleep)(struct dvb_frontend *fe);
 252         int (*suspend)(struct dvb_frontend *fe);
 253         int (*resume)(struct dvb_frontend *fe);
 254
 255         /** This is for simple PLLs - set all parameters in one go. */
 256         int (*set_params)(struct dvb_frontend *fe);
 257         int (*set_analog_params)(struct dvb_frontend *fe, struct analog_parameters *p);
 258
 259         /** This is support for demods like the mt352 - fills out the supplied buffer with what to write. */
 260         int (*calc_regs)(struct dvb_frontend *fe, u8 *buf, int buf_len);
 261
 262         /** This is to allow setting tuner-specific configs */
 263         int (*set_config)(struct dvb_frontend *fe, void *priv_cfg);
 264
 265         int (*get_frequency)(struct dvb_frontend *fe, u32 *frequency);
 266         int (*get_bandwidth)(struct dvb_frontend *fe, u32 *bandwidth);
 267         int (*get_if_frequency)(struct dvb_frontend *fe, u32 *frequency);
 268
 269 #define TUNER_STATUS_LOCKED 1
 270 #define TUNER_STATUS_STEREO 2
 271         int (*get_status)(struct dvb_frontend *fe, u32 *status);
 272         int (*get_rf_strength)(struct dvb_frontend *fe, u16 *strength);
 273         int (*get_afc)(struct dvb_frontend *fe, s32 *afc);
 274
 275         /** These are provided separately from set_params in order to facilitate silicon
 276          * tuners which require sophisticated tuning loops, controlling each parameter separately. */
 277         int (*set_frequency)(struct dvb_frontend *fe, u32 frequency);
 278         int (*set_bandwidth)(struct dvb_frontend *fe, u32 bandwidth);
 279
 280         /*
 281          * These are provided separately from set_params in order to facilitate silicon
 282          * tuners which require sophisticated tuning loops, controlling each parameter separately.
 283          */
 284         int (*set_state)(struct dvb_frontend *fe, enum tuner_param param, struct tuner_state *state);
 285         int (*get_state)(struct dvb_frontend *fe, enum tuner_param param, struct tuner_state *state);
 286 };
 287
 288 /**
 289  * struct analog_demod_info - Information struct for analog TV part of the demod
 290  *
 291  * @name:       Name of the analog TV demodulator
 292  */
 293 struct analog_demod_info {
 294         char *name;
 295 };
 296
 297 /**
 298  * struct analog_demod_ops  - Demodulation information and callbacks for
 299  *                            analog TV and radio
 300  *
 301  * @info:               pointer to struct analog_demod_info
 302  * @set_params:         callback function used to inform the demod to set the
 303  *                      demodulator parameters needed to decode an analog or
 304  *                      radio channel. The properties are passed via
 305  *                      struct @analog_params;.
 306  * @has_signal:         returns 0xffff if has signal, or 0 if it doesn't.
 307  * @get_afc:            Used only by analog TV core. Reports the frequency
 308  *                      drift due to AFC.
 309  * @tuner_status:       callback function that returns tuner status bits, e. g.
 310  *                      TUNER_STATUS_LOCKED and TUNER_STATUS_STEREO.
 311  * @standby:            set the tuner to standby mode.
 312  * @release:            callback function called when frontend is dettached.
 313  *                      drivers should free any allocated memory.
 314  * @i2c_gate_ctrl:      controls the I2C gate. Newer drivers should use I2C
 315  *                      mux support instead.
 316  * @set_config:         callback function used to send some tuner-specific
 317  *                      parameters.
 318  */
 319 struct analog_demod_ops {
 320
 321         struct analog_demod_info info;
 322
 323         void (*set_params)(struct dvb_frontend *fe,
 324                            struct analog_parameters *params);
 325         int  (*has_signal)(struct dvb_frontend *fe, u16 *signal);
 326         int  (*get_afc)(struct dvb_frontend *fe, s32 *afc);
 327         void (*tuner_status)(struct dvb_frontend *fe);
 328         void (*standby)(struct dvb_frontend *fe);
 329         void (*release)(struct dvb_frontend *fe);
 330         int  (*i2c_gate_ctrl)(struct dvb_frontend *fe, int enable);
 331
 332         /** This is to allow setting tuner-specific configuration */
 333         int (*set_config)(struct dvb_frontend *fe, void *priv_cfg);
 334 };
 335
 336 struct dtv_frontend_properties;
 337
 338
 339 /**
 340  * struct dvb_frontend_ops - Demodulation information and callbacks for
 341  *                            ditialt TV
 342  *
 343  * @info:               embedded struct dvb_tuner_info with tuner properties
 344  * @delsys:             Delivery systems supported by the frontend
 345  * @release:            callback function called when frontend is dettached.
 346  *                      drivers should free any allocated memory.
 347  * @release_sec:        callback function requesting that the Satelite Equipment
 348  *                      Control (SEC) driver to release and free any memory
 349  *                      allocated by the driver.
 350  * @init:               callback function used to initialize the tuner device.
 351  * @sleep:              callback function used to put the tuner to sleep.
 352  * @write:              callback function used by some demod legacy drivers to
 353  *                      allow other drivers to write data into their registers.
 354  *                      Should not be used on new drivers.
 355  * @tune:               callback function used by demod drivers that use
 356  *                      @DVBFE_ALGO_HW; to tune into a frequency.
 357  * @get_frontend_algo:  returns the desired hardware algorithm.
 358  * @set_frontend:       callback function used to inform the demod to set the
 359  *                      parameters for demodulating a digital TV channel.
 360  *                      The properties to be used are stored at
 361  *                      @dvb_frontend.dtv_property_cache;. The demod can change
 362  *                      the parameters to reflect the changes needed for the
 363  *                      channel to be decoded, and update statistics.
 364  * @get_tune_settings:  callback function
 365  * @get_frontend:       callback function used to inform the parameters
 366  *                      actuall in use. The properties to be used are stored at
 367  *                      @dvb_frontend.dtv_property_cache; and update
 368  *                      statistics. Please notice that it should not return
 369  *                      an error code if the statistics are not available
 370  *                      because the demog is not locked.
 371  * @read_status:        returns the locking status of the frontend.
 372  * @read_ber:           legacy callback function to return the bit error rate.
 373  *                      Newer drivers should provide such info via DVBv5 API,
 374  *                      e. g. @set_frontend;/@get_frontend;, implementing this
 375  *                      callback only if DVBv3 API compatibility is wanted.
 376  * @read_signal_strength: legacy callback function to return the signal
 377  *                      strength. Newer drivers should provide such info via
 378  *                      DVBv5 API, e. g. @set_frontend;/@get_frontend;,
 379  *                      implementing this callback only if DVBv3 API
 380  *                      compatibility is wanted.
 381  * @read_snr:           legacy callback function to return the Signal/Noise
 382  *                      rate. Newer drivers should provide such info via
 383  *                      DVBv5 API, e. g. @set_frontend;/@get_frontend;,
 384  *                      implementing this callback only if DVBv3 API
 385  *                      compatibility is wanted.
 386  * @read_ucblocks:      legacy callback function to return the Uncorrected Error
 387  *                      Blocks. Newer drivers should provide such info via
 388  *                      DVBv5 API, e. g. @set_frontend;/@get_frontend;,
 389  *                      implementing this callback only if DVBv3 API
 390  *                      compatibility is wanted.
 391  * @diseqc_reset_overload: callback function to implement the
 392  *                      FE_DISEQC_RESET_OVERLOAD ioctl (only Satellite)
 393  * @diseqc_send_master_cmd: callback function to implement the
 394  *                      FE_DISEQC_SEND_MASTER_CMD ioctl (only Satellite).
 395  * @diseqc_recv_slave_reply: callback function to implement the
 396  *                      FE_DISEQC_RECV_SLAVE_REPLY ioctl (only Satellite)
 397  * @diseqc_send_burst:  callback function to implement the
 398  *                      FE_DISEQC_SEND_BURST ioctl (only Satellite).
 399  * @set_tone:           callback function to implement the
 400  *                      FE_SET_TONE ioctl (only Satellite).
 401  * @set_voltage:        callback function to implement the
 402  *                      FE_SET_VOLTAGE ioctl (only Satellite).
 403  * @enable_high_lnb_voltage: callback function to implement the
 404  *                      FE_ENABLE_HIGH_LNB_VOLTAGE ioctl (only Satellite).
 405  * @dishnetwork_send_legacy_command: callback function to implement the
 406  *                      FE_DISHNETWORK_SEND_LEGACY_CMD ioctl (only Satellite).
 407  * @i2c_gate_ctrl:      controls the I2C gate. Newer drivers should use I2C
 408  *                      mux support instead.
 409  * @ts_bus_ctrl:        callback function used to take control of the TS bus.
 410  * @set_lna:            callback function to power on/off/auto the LNA.
 411  * @search:             callback function used on some custom algo search algos.
 412  * @tuner_ops:          pointer to struct dvb_tuner_ops
 413  * @analog_ops:         pointer to struct analog_demod_ops
 414  * @set_property:       callback function to allow the frontend to validade
 415  *                      incoming properties. Should not be used on new drivers.
 416  * @get_property:       callback function to allow the frontend to override
 417  *                      outcoming properties. Should not be used on new drivers.
 418  */
 419 struct dvb_frontend_ops {
 420
 421         struct dvb_frontend_info info;
 422
 423         u8 delsys[MAX_DELSYS];
 424
 425         void (*release)(struct dvb_frontend* fe);
 426         void (*release_sec)(struct dvb_frontend* fe);
 427
 428         int (*init)(struct dvb_frontend* fe);
 429         int (*sleep)(struct dvb_frontend* fe);
 430
 431         int (*write)(struct dvb_frontend* fe, const u8 buf[], int len);
 432
 433         /* if this is set, it overrides the default swzigzag */
 434         int (*tune)(struct dvb_frontend* fe,
 435                     bool re_tune,
 436                     unsigned int mode_flags,
 437                     unsigned int *delay,
 438                     enum fe_status *status);
 439
 440         /* get frontend tuning algorithm from the module */
 441         enum dvbfe_algo (*get_frontend_algo)(struct dvb_frontend *fe);
 442
 443         /* these two are only used for the swzigzag code */
 444         int (*set_frontend)(struct dvb_frontend *fe);
 445         int (*get_tune_settings)(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* settings);
 446
 447         int (*get_frontend)(struct dvb_frontend *fe);
 448
 449         int (*read_status)(struct dvb_frontend *fe, enum fe_status *status);
 450         int (*read_ber)(struct dvb_frontend* fe, u32* ber);
 451         int (*read_signal_strength)(struct dvb_frontend* fe, u16* strength);
 452         int (*read_snr)(struct dvb_frontend* fe, u16* snr);
 453         int (*read_ucblocks)(struct dvb_frontend* fe, u32* ucblocks);
 454
 455         int (*diseqc_reset_overload)(struct dvb_frontend* fe);
 456         int (*diseqc_send_master_cmd)(struct dvb_frontend* fe, struct dvb_diseqc_master_cmd* cmd);
 457         int (*diseqc_recv_slave_reply)(struct dvb_frontend* fe, struct dvb_diseqc_slave_reply* reply);
 458         int (*diseqc_send_burst)(struct dvb_frontend *fe,
 459                                  enum fe_sec_mini_cmd minicmd);
 460         int (*set_tone)(struct dvb_frontend *fe, enum fe_sec_tone_mode tone);
 461         int (*set_voltage)(struct dvb_frontend *fe,
 462                            enum fe_sec_voltage voltage);
 463         int (*enable_high_lnb_voltage)(struct dvb_frontend* fe, long arg);
 464         int (*dishnetwork_send_legacy_command)(struct dvb_frontend* fe, unsigned long cmd);
 465         int (*i2c_gate_ctrl)(struct dvb_frontend* fe, int enable);
 466         int (*ts_bus_ctrl)(struct dvb_frontend* fe, int acquire);
 467         int (*set_lna)(struct dvb_frontend *);
 468
 469         /* These callbacks are for devices that implement their own
 470          * tuning algorithms, rather than a simple swzigzag
 471          */
 472         enum dvbfe_search (*search)(struct dvb_frontend *fe);
 473
 474         struct dvb_tuner_ops tuner_ops;
 475         struct analog_demod_ops analog_ops;
 476
 477         int (*set_property)(struct dvb_frontend* fe, struct dtv_property* tvp);
 478         int (*get_property)(struct dvb_frontend* fe, struct dtv_property* tvp);
 479 };
 480
 481 #ifdef __DVB_CORE__
 482 #define MAX_EVENT 8
 483
 484 /* Used only internally at dvb_frontend.c */
 485 struct dvb_fe_events {
 486         struct dvb_frontend_event events[MAX_EVENT];
 487         int                       eventw;
 488         int                       eventr;
 489         int                       overflow;
 490         wait_queue_head_t         wait_queue;
 491         struct mutex              mtx;
 492 };
 493 #endif
 494
 495 /**
 496  * struct dtv_frontend_properties - contains a list of properties that are
 497  *                                  specific to a digital TV standard.
 498  *
 499  * @frequency:          frequency in Hz for terrestrial/cable or in kHz for
 500  *                      Satellite
 501  * @modulation:         Frontend modulation type
 502  * @voltage:            SEC voltage (only Satellite)
 503  * @sectone:            SEC tone mode (only Satellite)
 504  * @inversion:          Spectral inversion
 505  * @fec_inner:          Forward error correction inner Code Rate
 506  * @transmission_mode:  Transmission Mode
 507  * @bandwidth_hz:       Bandwidth, in Hz. A zero value means that userspace
 508  *                      wants to autodetect.
 509  * @guard_interval:     Guard Interval
 510  * @hierarchy:          Hierarchy
 511  * @symbol_rate:        Symbol Rate
 512  * @code_rate_HP:       high priority stream code rate
 513  * @code_rate_LP:       low priority stream code rate
 514  * @pilot:              Enable/disable/autodetect pilot tones
 515  * @rolloff:            Rolloff factor (alpha)
 516  * @delivery_system:    FE delivery system (e. g. digital TV standard)
 517  * @interleaving:       interleaving
 518  * @isdbt_partial_reception: ISDB-T partial reception (only ISDB standard)
 519  * @isdbt_sb_mode:      ISDB-T Sound Broadcast (SB) mode (only ISDB standard)
 520  * @isdbt_sb_subchannel:        ISDB-T SB subchannel (only ISDB standard)
 521  * @isdbt_sb_segment_idx:       ISDB-T SB segment index (only ISDB standard)
 522  * @isdbt_sb_segment_count:     ISDB-T SB segment count (only ISDB standard)
 523  * @isdbt_layer_enabled:        ISDB Layer enabled (only ISDB standard)
 524  * @layer:              ISDB per-layer data (only ISDB standard)
 525  * @layer.segment_count: Segment Count;
 526  * @layer.fec:          per layer code rate;
 527  * @layer.modulation:   per layer modulation;
 528  * @layer.interleaving:  per layer interleaving.
 529  * @stream_id:          If different than zero, enable substream filtering, if
 530  *                      hardware supports (DVB-S2 and DVB-T2).
 531  * @atscmh_fic_ver:     Version number of the FIC (Fast Information Channel)
 532  *                      signaling data (only ATSC-M/H)
 533  * @atscmh_parade_id:   Parade identification number (only ATSC-M/H)
 534  * @atscmh_nog:         Number of MH groups per MH subframe for a designated
 535  *                      parade (only ATSC-M/H)
 536  * @atscmh_tnog:        Total number of MH groups including all MH groups
 537  *                      belonging to all MH parades in one MH subframe
 538  *                      (only ATSC-M/H)
 539  * @atscmh_sgn:         Start group number (only ATSC-M/H)
 540  * @atscmh_prc:         Parade repetition cycle (only ATSC-M/H)
 541  * @atscmh_rs_frame_mode:       Reed Solomon (RS) frame mode (only ATSC-M/H)
 542  * @atscmh_rs_frame_ensemble:   RS frame ensemble (only ATSC-M/H)
 543  * @atscmh_rs_code_mode_pri:    RS code mode pri (only ATSC-M/H)
 544  * @atscmh_rs_code_mode_sec:    RS code mode sec (only ATSC-M/H)
 545  * @atscmh_sccc_block_mode:     Series Concatenated Convolutional Code (SCCC)
 546  *                              Block Mode (only ATSC-M/H)
 547  * @atscmh_sccc_code_mode_a:    SCCC code mode A (only ATSC-M/H)
 548  * @atscmh_sccc_code_mode_b:    SCCC code mode B (only ATSC-M/H)
 549  * @atscmh_sccc_code_mode_c:    SCCC code mode C (only ATSC-M/H)
 550  * @atscmh_sccc_code_mode_d:    SCCC code mode D (only ATSC-M/H)
 551  * @lna:                Power ON/OFF/AUTO the Linear Now-noise Amplifier (LNA)
 552  * @strength:           DVBv5 API statistics: Signal Strength
 553  * @cnr:                DVBv5 API statistics: Signal to Noise ratio of the
 554  *                      (main) carrier
 555  * @pre_bit_error:      DVBv5 API statistics: pre-Viterbi bit error count
 556  * @pre_bit_count:      DVBv5 API statistics: pre-Viterbi bit count
 557  * @post_bit_error:     DVBv5 API statistics: post-Viterbi bit error count
 558  * @post_bit_count:     DVBv5 API statistics: post-Viterbi bit count
 559  * @block_error:        DVBv5 API statistics: block error count
 560  * @block_count:        DVBv5 API statistics: block count
 561  *
 562  * NOTE: derivated statistics like Uncorrected Error blocks (UCE) are
 563  * calculated on userspace.
 564  *
 565  * Only a subset of the properties are needed for a given delivery system.
 566  * For more info, consult the media_api.html with the documentation of the
 567  * Userspace API.
 568  */
 569 struct dtv_frontend_properties {
 570         u32                     frequency;
 571         enum fe_modulation      modulation;
 572
 573         enum fe_sec_voltage     voltage;
 574         enum fe_sec_tone_mode   sectone;
 575         enum fe_spectral_inversion      inversion;
 576         enum fe_code_rate               fec_inner;
 577         enum fe_transmit_mode   transmission_mode;
 578         u32                     bandwidth_hz;   /* 0 = AUTO */
 579         enum fe_guard_interval  guard_interval;
 580         enum fe_hierarchy               hierarchy;
 581         u32                     symbol_rate;
 582         enum fe_code_rate               code_rate_HP;
 583         enum fe_code_rate               code_rate_LP;
 584
 585         enum fe_pilot           pilot;
 586         enum fe_rolloff         rolloff;
 587
 588         enum fe_delivery_system delivery_system;
 589
 590         enum fe_interleaving    interleaving;
 591
 592         /* ISDB-T specifics */
 593         u8                      isdbt_partial_reception;
 594         u8                      isdbt_sb_mode;
 595         u8                      isdbt_sb_subchannel;
 596         u32                     isdbt_sb_segment_idx;
 597         u32                     isdbt_sb_segment_count;
 598         u8                      isdbt_layer_enabled;
 599         struct {
 600             u8                  segment_count;
 601             enum fe_code_rate   fec;
 602             enum fe_modulation  modulation;
 603             u8                  interleaving;
 604         } layer[3];
 605
 606         /* Multistream specifics */
 607         u32                     stream_id;
 608
 609         /* ATSC-MH specifics */
 610         u8                      atscmh_fic_ver;
 611         u8                      atscmh_parade_id;
 612         u8                      atscmh_nog;
 613         u8                      atscmh_tnog;
 614         u8                      atscmh_sgn;
 615         u8                      atscmh_prc;
 616
 617         u8                      atscmh_rs_frame_mode;
 618         u8                      atscmh_rs_frame_ensemble;
 619         u8                      atscmh_rs_code_mode_pri;
 620         u8                      atscmh_rs_code_mode_sec;
 621         u8                      atscmh_sccc_block_mode;
 622         u8                      atscmh_sccc_code_mode_a;
 623         u8                      atscmh_sccc_code_mode_b;
 624         u8                      atscmh_sccc_code_mode_c;
 625         u8                      atscmh_sccc_code_mode_d;
 626
 627         u32                     lna;
 628
 629         /* statistics data */
 630         struct dtv_fe_stats     strength;
 631         struct dtv_fe_stats     cnr;
 632         struct dtv_fe_stats     pre_bit_error;
 633         struct dtv_fe_stats     pre_bit_count;
 634         struct dtv_fe_stats     post_bit_error;
 635         struct dtv_fe_stats     post_bit_count;
 636         struct dtv_fe_stats     block_error;
 637         struct dtv_fe_stats     block_count;
 638
 639         /* private: */
 640         /* Cache State */
 641         u32                     state;
 642
 643 };
 644
 645 #define DVB_FE_NO_EXIT  0
 646 #define DVB_FE_NORMAL_EXIT      1
 647 #define DVB_FE_DEVICE_REMOVED   2
 648 #define DVB_FE_DEVICE_RESUME    3
 649
 650 /**
 651  * struct dvb_frontend - Frontend structure to be used on drivers.
 652  *
 653  * @ops:                embedded struct dvb_frontend_ops
 654  * @dvb:                pointer to struct dvb_adapter
 655  * @demodulator_priv:   demod private data
 656  * @tuner_priv:         tuner private data
 657  * @frontend_priv:      frontend private data
 658  * @sec_priv:           SEC private data
 659  * @analog_demod_priv:  Analog demod private data
 660  * @dtv_property_cache: embedded struct dtv_frontend_properties
 661  * @callback:           callback function used on some drivers to call
 662  *                      either the tuner or the demodulator.
 663  * @id:                 Frontend ID
 664  * @exit:               Used to inform the DVB core that the frontend
 665  *                      thread should exit (usually, means that the hardware
 666  *                      got disconnected.
 667  */
 668
 669 struct dvb_frontend {
 670         struct dvb_frontend_ops ops;
 671         struct dvb_adapter *dvb;
 672         void *demodulator_priv;
 673         void *tuner_priv;
 674         void *frontend_priv;
 675         void *sec_priv;
 676         void *analog_demod_priv;
 677         struct dtv_frontend_properties dtv_property_cache;
 678 #define DVB_FRONTEND_COMPONENT_TUNER 0
 679 #define DVB_FRONTEND_COMPONENT_DEMOD 1
 680         int (*callback)(void *adapter_priv, int component, int cmd, int arg);
 681         int id;
 682         unsigned int exit;
 683 };
 684
 685 extern int dvb_register_frontend(struct dvb_adapter *dvb,
 686                                  struct dvb_frontend *fe);
 687
 688 extern int dvb_unregister_frontend(struct dvb_frontend *fe);
 689
 690 extern void dvb_frontend_detach(struct dvb_frontend *fe);
 691
 692 extern void dvb_frontend_reinitialise(struct dvb_frontend *fe);
 693 extern int dvb_frontend_suspend(struct dvb_frontend *fe);
 694 extern int dvb_frontend_resume(struct dvb_frontend *fe);
 695
 696 extern void dvb_frontend_sleep_until(ktime_t *waketime, u32 add_usec);
 697
 698 #endif