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 <[email protected]>
  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  * DOC: Digital TV Frontend
  47  *
  48  * The Digital TV Frontend kABI defines a driver-internal interface for
  49  * registering low-level, hardware specific driver to a hardware independent
  50  * frontend layer. It is only of interest for Digital TV device driver writers.
  51  * The header file for this API is named dvb_frontend.h and located in
  52  * drivers/media/dvb-core.
  53  *
  54  * Before using the Digital TV frontend core, the bridge driver should attach
  55  * the frontend demod, tuner and SEC devices and call dvb_register_frontend(),
  56  * in order to register the new frontend at the subsystem. At device
  57  * detach/removal, the bridge driver should call dvb_unregister_frontend() to
  58  * remove the frontend from the core and then dvb_frontend_detach() to free the
  59  * memory allocated by the frontend drivers.
  60  *
  61  * The drivers should also call dvb_frontend_suspend() as part of their
  62  * handler for the &device_driver.suspend(), and dvb_frontend_resume() as
  63  * part of their handler for &device_driver.resume().
  64  *
  65  * A few other optional functions are provided to handle some special cases.
  66  */
  67
  68 /*
  69  * Maximum number of Delivery systems per frontend. It
  70  * should be smaller or equal to 32
  71  */
  72 #define MAX_DELSYS      8
  73
  74 /**
  75  * struct dvb_frontend_tune_settings - parameters to adjust frontend tuning
  76  *
  77  * @min_delay_ms:       minimum delay for tuning, in ms
  78  * @step_size:          step size between two consecutive frequencies
  79  * @max_drift:          maximum drift
  80  *
  81  * NOTE: step_size is in Hz, for terrestrial/cable or kHz for satellite
  82  */
  83 struct dvb_frontend_tune_settings {
  84         int min_delay_ms;
  85         int step_size;
  86         int max_drift;
  87 };
  88
  89 struct dvb_frontend;
  90
  91 /**
  92  * struct dvb_tuner_info - Frontend name and min/max ranges/bandwidths
  93  *
  94  * @name:               name of the Frontend
  95  * @frequency_min:      minimal frequency supported
  96  * @frequency_max:      maximum frequency supported
  97  * @frequency_step:     frequency step
  98  * @bandwidth_min:      minimal frontend bandwidth supported
  99  * @bandwidth_max:      maximum frontend bandwidth supported
 100  * @bandwidth_step:     frontend bandwidth step
 101  *
 102  * NOTE: frequency parameters are in Hz, for terrestrial/cable or kHz for
 103  * satellite.
 104  */
 105 struct dvb_tuner_info {
 106         char name[128];
 107
 108         u32 frequency_min;
 109         u32 frequency_max;
 110         u32 frequency_step;
 111
 112         u32 bandwidth_min;
 113         u32 bandwidth_max;
 114         u32 bandwidth_step;
 115 };
 116
 117 /**
 118  * struct analog_parameters - Parameters to tune into an analog/radio channel
 119  *
 120  * @frequency:  Frequency used by analog TV tuner (either in 62.5 kHz step,
 121  *              for TV, or 62.5 Hz for radio)
 122  * @mode:       Tuner mode, as defined on enum v4l2_tuner_type
 123  * @audmode:    Audio mode as defined for the rxsubchans field at videodev2.h,
 124  *              e. g. V4L2_TUNER_MODE_*
 125  * @std:        TV standard bitmap as defined at videodev2.h, e. g. V4L2_STD_*
 126  *
 127  * Hybrid tuners should be supported by both V4L2 and DVB APIs. This
 128  * struct contains the data that are used by the V4L2 side. To avoid
 129  * dependencies from V4L2 headers, all enums here are declared as integers.
 130  */
 131 struct analog_parameters {
 132         unsigned int frequency;
 133         unsigned int mode;
 134         unsigned int audmode;
 135         u64 std;
 136 };
 137
 138 /**
 139  * enum dvbfe_algo - defines the algorithm used to tune into a channel
 140  *
 141  * @DVBFE_ALGO_HW: Hardware Algorithm -
 142  *      Devices that support this algorithm do everything in hardware
 143  *      and no software support is needed to handle them.
 144  *      Requesting these devices to LOCK is the only thing required,
 145  *      device is supposed to do everything in the hardware.
 146  *
 147  * @DVBFE_ALGO_SW: Software Algorithm -
 148  * These are dumb devices, that require software to do everything
 149  *
 150  * @DVBFE_ALGO_CUSTOM: Customizable Agorithm -
 151  *      Devices having this algorithm can be customized to have specific
 152  *      algorithms in the frontend driver, rather than simply doing a
 153  *      software zig-zag. In this case the zigzag maybe hardware assisted
 154  *      or it maybe completely done in hardware. In all cases, usage of
 155  *      this algorithm, in conjunction with the search and track
 156  *      callbacks, utilizes the driver specific algorithm.
 157  *
 158  * @DVBFE_ALGO_RECOVERY: Recovery Algorithm -
 159  *      These devices have AUTO recovery capabilities from LOCK failure
 160  */
 161 enum dvbfe_algo {
 162         DVBFE_ALGO_HW                   = (1 <<  0),
 163         DVBFE_ALGO_SW                   = (1 <<  1),
 164         DVBFE_ALGO_CUSTOM               = (1 <<  2),
 165         DVBFE_ALGO_RECOVERY             = (1 << 31)
 166 };
 167
 168 /**
 169  * enum dvbfe_search - search callback possible return status
 170  *
 171  * @DVBFE_ALGO_SEARCH_SUCCESS:
 172  *      The frontend search algorithm completed and returned successfully
 173  *
 174  * @DVBFE_ALGO_SEARCH_ASLEEP:
 175  *      The frontend search algorithm is sleeping
 176  *
 177  * @DVBFE_ALGO_SEARCH_FAILED:
 178  *      The frontend search for a signal failed
 179  *
 180  * @DVBFE_ALGO_SEARCH_INVALID:
 181  *      The frontend search algorith was probably supplied with invalid
 182  *      parameters and the search is an invalid one
 183  *
 184  * @DVBFE_ALGO_SEARCH_ERROR:
 185  *      The frontend search algorithm failed due to some error
 186  *
 187  * @DVBFE_ALGO_SEARCH_AGAIN:
 188  *      The frontend search algorithm was requested to search again
 189  */
 190 enum dvbfe_search {
 191         DVBFE_ALGO_SEARCH_SUCCESS       = (1 <<  0),
 192         DVBFE_ALGO_SEARCH_ASLEEP        = (1 <<  1),
 193         DVBFE_ALGO_SEARCH_FAILED        = (1 <<  2),
 194         DVBFE_ALGO_SEARCH_INVALID       = (1 <<  3),
 195         DVBFE_ALGO_SEARCH_AGAIN         = (1 <<  4),
 196         DVBFE_ALGO_SEARCH_ERROR         = (1 << 31),
 197 };
 198
 199 /**
 200  * struct dvb_tuner_ops - Tuner information and callbacks
 201  *
 202  * @info:               embedded struct dvb_tuner_info with tuner properties
 203  * @release:            callback function called when frontend is dettached.
 204  *                      drivers should free any allocated memory.
 205  * @init:               callback function used to initialize the tuner device.
 206  * @sleep:              callback function used to put the tuner to sleep.
 207  * @suspend:            callback function used to inform that the Kernel will
 208  *                      suspend.
 209  * @resume:             callback function used to inform that the Kernel is
 210  *                      resuming from suspend.
 211  * @set_params:         callback function used to inform the tuner to tune
 212  *                      into a digital TV channel. The properties to be used
 213  *                      are stored at @dvb_frontend.dtv_property_cache;. The
 214  *                      tuner demod can change the parameters to reflect the
 215  *                      changes needed for the channel to be tuned, and
 216  *                      update statistics. This is the recommended way to set
 217  *                      the tuner parameters and should be used on newer
 218  *                      drivers.
 219  * @set_analog_params:  callback function used to tune into an analog TV
 220  *                      channel on hybrid tuners. It passes @analog_parameters;
 221  *                      to the driver.
 222  * @set_config:         callback function used to send some tuner-specific
 223  *                      parameters.
 224  * @get_frequency:      get the actual tuned frequency
 225  * @get_bandwidth:      get the bandwitdh used by the low pass filters
 226  * @get_if_frequency:   get the Intermediate Frequency, in Hz. For baseband,
 227  *                      should return 0.
 228  * @get_status:         returns the frontend lock status
 229  * @get_rf_strength:    returns the RF signal strengh. Used mostly to support
 230  *                      analog TV and radio. Digital TV should report, instead,
 231  *                      via DVBv5 API (@dvb_frontend.dtv_property_cache;).
 232  * @get_afc:            Used only by analog TV core. Reports the frequency
 233  *                      drift due to AFC.
 234  * @calc_regs:          callback function used to pass register data settings
 235  *                      for simple tuners.  Shouldn't be used on newer drivers.
 236  * @set_frequency:      Set a new frequency. Shouldn't be used on newer drivers.
 237  * @set_bandwidth:      Set a new frequency. Shouldn't be used on newer drivers.
 238  *
 239  * NOTE: frequencies used on get_frequency and set_frequency are in Hz for
 240  * terrestrial/cable or kHz for satellite.
 241  *
 242  */
 243 struct dvb_tuner_ops {
 244
 245         struct dvb_tuner_info info;
 246
 247         int (*release)(struct dvb_frontend *fe);
 248         int (*init)(struct dvb_frontend *fe);
 249         int (*sleep)(struct dvb_frontend *fe);
 250         int (*suspend)(struct dvb_frontend *fe);
 251         int (*resume)(struct dvb_frontend *fe);
 252
 253         /* This is the recomended way to set the tuner */
 254         int (*set_params)(struct dvb_frontend *fe);
 255         int (*set_analog_params)(struct dvb_frontend *fe, struct analog_parameters *p);
 256
 257         int (*set_config)(struct dvb_frontend *fe, void *priv_cfg);
 258
 259         int (*get_frequency)(struct dvb_frontend *fe, u32 *frequency);
 260         int (*get_bandwidth)(struct dvb_frontend *fe, u32 *bandwidth);
 261         int (*get_if_frequency)(struct dvb_frontend *fe, u32 *frequency);
 262
 263 #define TUNER_STATUS_LOCKED 1
 264 #define TUNER_STATUS_STEREO 2
 265         int (*get_status)(struct dvb_frontend *fe, u32 *status);
 266         int (*get_rf_strength)(struct dvb_frontend *fe, u16 *strength);
 267         int (*get_afc)(struct dvb_frontend *fe, s32 *afc);
 268
 269         /*
 270          * This is support for demods like the mt352 - fills out the supplied
 271          * buffer with what to write.
 272          *
 273          * Don't use on newer drivers.
 274          */
 275         int (*calc_regs)(struct dvb_frontend *fe, u8 *buf, int buf_len);
 276
 277         /*
 278          * These are provided separately from set_params in order to
 279          * facilitate silicon tuners which require sophisticated tuning loops,
 280          * controlling each parameter separately.
 281          *
 282          * Don't use on newer drivers.
 283          */
 284         int (*set_frequency)(struct dvb_frontend *fe, u32 frequency);
 285         int (*set_bandwidth)(struct dvb_frontend *fe, u32 bandwidth);
 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  *                      Drivers should not use this, except when the DVB
 408  *                      core emulation fails to provide proper support (e.g.
 409  *                      if set_voltage() takes more than 8ms to work), and
 410  *                      when backward compatibility with this legacy API is
 411  *                      required.
 412  * @i2c_gate_ctrl:      controls the I2C gate. Newer drivers should use I2C
 413  *                      mux support instead.
 414  * @ts_bus_ctrl:        callback function used to take control of the TS bus.
 415  * @set_lna:            callback function to power on/off/auto the LNA.
 416  * @search:             callback function used on some custom algo search algos.
 417  * @tuner_ops:          pointer to struct dvb_tuner_ops
 418  * @analog_ops:         pointer to struct analog_demod_ops
 419  * @set_property:       callback function to allow the frontend to validade
 420  *                      incoming properties. Should not be used on new drivers.
 421  * @get_property:       callback function to allow the frontend to override
 422  *                      outcoming properties. Should not be used on new drivers.
 423  */
 424 struct dvb_frontend_ops {
 425
 426         struct dvb_frontend_info info;
 427
 428         u8 delsys[MAX_DELSYS];
 429
 430         void (*release)(struct dvb_frontend* fe);
 431         void (*release_sec)(struct dvb_frontend* fe);
 432
 433         int (*init)(struct dvb_frontend* fe);
 434         int (*sleep)(struct dvb_frontend* fe);
 435
 436         int (*write)(struct dvb_frontend* fe, const u8 buf[], int len);
 437
 438         /* if this is set, it overrides the default swzigzag */
 439         int (*tune)(struct dvb_frontend* fe,
 440                     bool re_tune,
 441                     unsigned int mode_flags,
 442                     unsigned int *delay,
 443                     enum fe_status *status);
 444
 445         /* get frontend tuning algorithm from the module */
 446         enum dvbfe_algo (*get_frontend_algo)(struct dvb_frontend *fe);
 447
 448         /* these two are only used for the swzigzag code */
 449         int (*set_frontend)(struct dvb_frontend *fe);
 450         int (*get_tune_settings)(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* settings);
 451
 452         int (*get_frontend)(struct dvb_frontend *fe,
 453                             struct dtv_frontend_properties *props);
 454
 455         int (*read_status)(struct dvb_frontend *fe, enum fe_status *status);
 456         int (*read_ber)(struct dvb_frontend* fe, u32* ber);
 457         int (*read_signal_strength)(struct dvb_frontend* fe, u16* strength);
 458         int (*read_snr)(struct dvb_frontend* fe, u16* snr);
 459         int (*read_ucblocks)(struct dvb_frontend* fe, u32* ucblocks);
 460
 461         int (*diseqc_reset_overload)(struct dvb_frontend* fe);
 462         int (*diseqc_send_master_cmd)(struct dvb_frontend* fe, struct dvb_diseqc_master_cmd* cmd);
 463         int (*diseqc_recv_slave_reply)(struct dvb_frontend* fe, struct dvb_diseqc_slave_reply* reply);
 464         int (*diseqc_send_burst)(struct dvb_frontend *fe,
 465                                  enum fe_sec_mini_cmd minicmd);
 466         int (*set_tone)(struct dvb_frontend *fe, enum fe_sec_tone_mode tone);
 467         int (*set_voltage)(struct dvb_frontend *fe,
 468                            enum fe_sec_voltage voltage);
 469         int (*enable_high_lnb_voltage)(struct dvb_frontend* fe, long arg);
 470         int (*dishnetwork_send_legacy_command)(struct dvb_frontend* fe, unsigned long cmd);
 471         int (*i2c_gate_ctrl)(struct dvb_frontend* fe, int enable);
 472         int (*ts_bus_ctrl)(struct dvb_frontend* fe, int acquire);
 473         int (*set_lna)(struct dvb_frontend *);
 474
 475         /*
 476          * These callbacks are for devices that implement their own
 477          * tuning algorithms, rather than a simple swzigzag
 478          */
 479         enum dvbfe_search (*search)(struct dvb_frontend *fe);
 480
 481         struct dvb_tuner_ops tuner_ops;
 482         struct analog_demod_ops analog_ops;
 483
 484         int (*set_property)(struct dvb_frontend* fe, struct dtv_property* tvp);
 485         int (*get_property)(struct dvb_frontend* fe, struct dtv_property* tvp);
 486 };
 487
 488 #ifdef __DVB_CORE__
 489 #define MAX_EVENT 8
 490
 491 /* Used only internally at dvb_frontend.c */
 492 struct dvb_fe_events {
 493         struct dvb_frontend_event events[MAX_EVENT];
 494         int                       eventw;
 495         int                       eventr;
 496         int                       overflow;
 497         wait_queue_head_t         wait_queue;
 498         struct mutex              mtx;
 499 };
 500 #endif
 501
 502 /**
 503  * struct dtv_frontend_properties - contains a list of properties that are
 504  *                                  specific to a digital TV standard.
 505  *
 506  * @frequency:          frequency in Hz for terrestrial/cable or in kHz for
 507  *                      Satellite
 508  * @modulation:         Frontend modulation type
 509  * @voltage:            SEC voltage (only Satellite)
 510  * @sectone:            SEC tone mode (only Satellite)
 511  * @inversion:          Spectral inversion
 512  * @fec_inner:          Forward error correction inner Code Rate
 513  * @transmission_mode:  Transmission Mode
 514  * @bandwidth_hz:       Bandwidth, in Hz. A zero value means that userspace
 515  *                      wants to autodetect.
 516  * @guard_interval:     Guard Interval
 517  * @hierarchy:          Hierarchy
 518  * @symbol_rate:        Symbol Rate
 519  * @code_rate_HP:       high priority stream code rate
 520  * @code_rate_LP:       low priority stream code rate
 521  * @pilot:              Enable/disable/autodetect pilot tones
 522  * @rolloff:            Rolloff factor (alpha)
 523  * @delivery_system:    FE delivery system (e. g. digital TV standard)
 524  * @interleaving:       interleaving
 525  * @isdbt_partial_reception: ISDB-T partial reception (only ISDB standard)
 526  * @isdbt_sb_mode:      ISDB-T Sound Broadcast (SB) mode (only ISDB standard)
 527  * @isdbt_sb_subchannel:        ISDB-T SB subchannel (only ISDB standard)
 528  * @isdbt_sb_segment_idx:       ISDB-T SB segment index (only ISDB standard)
 529  * @isdbt_sb_segment_count:     ISDB-T SB segment count (only ISDB standard)
 530  * @isdbt_layer_enabled:        ISDB Layer enabled (only ISDB standard)
 531  * @layer:              ISDB per-layer data (only ISDB standard)
 532  * @layer.segment_count: Segment Count;
 533  * @layer.fec:          per layer code rate;
 534  * @layer.modulation:   per layer modulation;
 535  * @layer.interleaving:  per layer interleaving.
 536  * @stream_id:          If different than zero, enable substream filtering, if
 537  *                      hardware supports (DVB-S2 and DVB-T2).
 538  * @atscmh_fic_ver:     Version number of the FIC (Fast Information Channel)
 539  *                      signaling data (only ATSC-M/H)
 540  * @atscmh_parade_id:   Parade identification number (only ATSC-M/H)
 541  * @atscmh_nog:         Number of MH groups per MH subframe for a designated
 542  *                      parade (only ATSC-M/H)
 543  * @atscmh_tnog:        Total number of MH groups including all MH groups
 544  *                      belonging to all MH parades in one MH subframe
 545  *                      (only ATSC-M/H)
 546  * @atscmh_sgn:         Start group number (only ATSC-M/H)
 547  * @atscmh_prc:         Parade repetition cycle (only ATSC-M/H)
 548  * @atscmh_rs_frame_mode:       Reed Solomon (RS) frame mode (only ATSC-M/H)
 549  * @atscmh_rs_frame_ensemble:   RS frame ensemble (only ATSC-M/H)
 550  * @atscmh_rs_code_mode_pri:    RS code mode pri (only ATSC-M/H)
 551  * @atscmh_rs_code_mode_sec:    RS code mode sec (only ATSC-M/H)
 552  * @atscmh_sccc_block_mode:     Series Concatenated Convolutional Code (SCCC)
 553  *                              Block Mode (only ATSC-M/H)
 554  * @atscmh_sccc_code_mode_a:    SCCC code mode A (only ATSC-M/H)
 555  * @atscmh_sccc_code_mode_b:    SCCC code mode B (only ATSC-M/H)
 556  * @atscmh_sccc_code_mode_c:    SCCC code mode C (only ATSC-M/H)
 557  * @atscmh_sccc_code_mode_d:    SCCC code mode D (only ATSC-M/H)
 558  * @lna:                Power ON/OFF/AUTO the Linear Now-noise Amplifier (LNA)
 559  * @strength:           DVBv5 API statistics: Signal Strength
 560  * @cnr:                DVBv5 API statistics: Signal to Noise ratio of the
 561  *                      (main) carrier
 562  * @pre_bit_error:      DVBv5 API statistics: pre-Viterbi bit error count
 563  * @pre_bit_count:      DVBv5 API statistics: pre-Viterbi bit count
 564  * @post_bit_error:     DVBv5 API statistics: post-Viterbi bit error count
 565  * @post_bit_count:     DVBv5 API statistics: post-Viterbi bit count
 566  * @block_error:        DVBv5 API statistics: block error count
 567  * @block_count:        DVBv5 API statistics: block count
 568  *
 569  * NOTE: derivated statistics like Uncorrected Error blocks (UCE) are
 570  * calculated on userspace.
 571  *
 572  * Only a subset of the properties are needed for a given delivery system.
 573  * For more info, consult the media_api.html with the documentation of the
 574  * Userspace API.
 575  */
 576 struct dtv_frontend_properties {
 577         u32                     frequency;
 578         enum fe_modulation      modulation;
 579
 580         enum fe_sec_voltage     voltage;
 581         enum fe_sec_tone_mode   sectone;
 582         enum fe_spectral_inversion      inversion;
 583         enum fe_code_rate               fec_inner;
 584         enum fe_transmit_mode   transmission_mode;
 585         u32                     bandwidth_hz;   /* 0 = AUTO */
 586         enum fe_guard_interval  guard_interval;
 587         enum fe_hierarchy               hierarchy;
 588         u32                     symbol_rate;
 589         enum fe_code_rate               code_rate_HP;
 590         enum fe_code_rate               code_rate_LP;
 591
 592         enum fe_pilot           pilot;
 593         enum fe_rolloff         rolloff;
 594
 595         enum fe_delivery_system delivery_system;
 596
 597         enum fe_interleaving    interleaving;
 598
 599         /* ISDB-T specifics */
 600         u8                      isdbt_partial_reception;
 601         u8                      isdbt_sb_mode;
 602         u8                      isdbt_sb_subchannel;
 603         u32                     isdbt_sb_segment_idx;
 604         u32                     isdbt_sb_segment_count;
 605         u8                      isdbt_layer_enabled;
 606         struct {
 607             u8                  segment_count;
 608             enum fe_code_rate   fec;
 609             enum fe_modulation  modulation;
 610             u8                  interleaving;
 611         } layer[3];
 612
 613         /* Multistream specifics */
 614         u32                     stream_id;
 615
 616         /* ATSC-MH specifics */
 617         u8                      atscmh_fic_ver;
 618         u8                      atscmh_parade_id;
 619         u8                      atscmh_nog;
 620         u8                      atscmh_tnog;
 621         u8                      atscmh_sgn;
 622         u8                      atscmh_prc;
 623
 624         u8                      atscmh_rs_frame_mode;
 625         u8                      atscmh_rs_frame_ensemble;
 626         u8                      atscmh_rs_code_mode_pri;
 627         u8                      atscmh_rs_code_mode_sec;
 628         u8                      atscmh_sccc_block_mode;
 629         u8                      atscmh_sccc_code_mode_a;
 630         u8                      atscmh_sccc_code_mode_b;
 631         u8                      atscmh_sccc_code_mode_c;
 632         u8                      atscmh_sccc_code_mode_d;
 633
 634         u32                     lna;
 635
 636         /* statistics data */
 637         struct dtv_fe_stats     strength;
 638         struct dtv_fe_stats     cnr;
 639         struct dtv_fe_stats     pre_bit_error;
 640         struct dtv_fe_stats     pre_bit_count;
 641         struct dtv_fe_stats     post_bit_error;
 642         struct dtv_fe_stats     post_bit_count;
 643         struct dtv_fe_stats     block_error;
 644         struct dtv_fe_stats     block_count;
 645
 646         /* private: */
 647         /* Cache State */
 648         u32                     state;
 649
 650 };
 651
 652 #define DVB_FE_NO_EXIT  0
 653 #define DVB_FE_NORMAL_EXIT      1
 654 #define DVB_FE_DEVICE_REMOVED   2
 655 #define DVB_FE_DEVICE_RESUME    3
 656
 657 /**
 658  * struct dvb_frontend - Frontend structure to be used on drivers.
 659  *
 660  * @ops:                embedded struct dvb_frontend_ops
 661  * @dvb:                pointer to struct dvb_adapter
 662  * @demodulator_priv:   demod private data
 663  * @tuner_priv:         tuner private data
 664  * @frontend_priv:      frontend private data
 665  * @sec_priv:           SEC private data
 666  * @analog_demod_priv:  Analog demod private data
 667  * @dtv_property_cache: embedded struct dtv_frontend_properties
 668  * @callback:           callback function used on some drivers to call
 669  *                      either the tuner or the demodulator.
 670  * @id:                 Frontend ID
 671  * @exit:               Used to inform the DVB core that the frontend
 672  *                      thread should exit (usually, means that the hardware
 673  *                      got disconnected.
 674  */
 675
 676 struct dvb_frontend {
 677         struct dvb_frontend_ops ops;
 678         struct dvb_adapter *dvb;
 679         void *demodulator_priv;
 680         void *tuner_priv;
 681         void *frontend_priv;
 682         void *sec_priv;
 683         void *analog_demod_priv;
 684         struct dtv_frontend_properties dtv_property_cache;
 685 #define DVB_FRONTEND_COMPONENT_TUNER 0
 686 #define DVB_FRONTEND_COMPONENT_DEMOD 1
 687         int (*callback)(void *adapter_priv, int component, int cmd, int arg);
 688         int id;
 689         unsigned int exit;
 690 };
 691
 692 /**
 693  * dvb_register_frontend() - Registers a DVB frontend at the adapter
 694  *
 695  * @dvb: pointer to the dvb adapter
 696  * @fe: pointer to the frontend struct
 697  *
 698  * Allocate and initialize the private data needed by the frontend core to
 699  * manage the frontend and calls dvb_register_device() to register a new
 700  * frontend. It also cleans the property cache that stores the frontend
 701  * parameters and selects the first available delivery system.
 702  */
 703 int dvb_register_frontend(struct dvb_adapter *dvb,
 704                                  struct dvb_frontend *fe);
 705
 706 /**
 707  * dvb_unregister_frontend() - Unregisters a DVB frontend
 708  *
 709  * @fe: pointer to the frontend struct
 710  *
 711  * Stops the frontend kthread, calls dvb_unregister_device() and frees the
 712  * private frontend data allocated by dvb_register_frontend().
 713  *
 714  * NOTE: This function doesn't frees the memory allocated by the demod,
 715  * by the SEC driver and by the tuner. In order to free it, an explicit call to
 716  * dvb_frontend_detach() is needed, after calling this function.
 717  */
 718 int dvb_unregister_frontend(struct dvb_frontend *fe);
 719
 720 /**
 721  * dvb_frontend_detach() - Detaches and frees frontend specific data
 722  *
 723  * @fe: pointer to the frontend struct
 724  *
 725  * This function should be called after dvb_unregister_frontend(). It
 726  * calls the SEC, tuner and demod release functions:
 727  * &dvb_frontend_ops.release_sec, &dvb_frontend_ops.tuner_ops.release,
 728  * &dvb_frontend_ops.analog_ops.release and &dvb_frontend_ops.release.
 729  *
 730  * If the driver is compiled with CONFIG_MEDIA_ATTACH, it also decreases
 731  * the module reference count, needed to allow userspace to remove the
 732  * previously used DVB frontend modules.
 733  */
 734 void dvb_frontend_detach(struct dvb_frontend *fe);
 735
 736 /**
 737  * dvb_frontend_suspend() - Suspends a Digital TV frontend
 738  *
 739  * @fe: pointer to the frontend struct
 740  *
 741  * This function prepares a Digital TV frontend to suspend.
 742  *
 743  * In order to prepare the tuner to suspend, if
 744  * &dvb_frontend_ops.tuner_ops.suspend() is available, it calls it. Otherwise,
 745  * it will call &dvb_frontend_ops.tuner_ops.sleep(), if available.
 746  *
 747  * It will also call &dvb_frontend_ops.sleep() to put the demod to suspend.
 748  *
 749  * The drivers should also call dvb_frontend_suspend() as part of their
 750  * handler for the &device_driver.suspend().
 751  */
 752 int dvb_frontend_suspend(struct dvb_frontend *fe);
 753
 754 /**
 755  * dvb_frontend_resume() - Resumes a Digital TV frontend
 756  *
 757  * @fe: pointer to the frontend struct
 758  *
 759  * This function resumes the usual operation of the tuner after resume.
 760  *
 761  * In order to resume the frontend, it calls the demod &dvb_frontend_ops.init().
 762  *
 763  * If &dvb_frontend_ops.tuner_ops.resume() is available, It, it calls it.
 764  * Otherwise,t will call &dvb_frontend_ops.tuner_ops.init(), if available.
 765  *
 766  * Once tuner and demods are resumed, it will enforce that the SEC voltage and
 767  * tone are restored to their previous values and wake up the frontend's
 768  * kthread in order to retune the frontend.
 769  *
 770  * The drivers should also call dvb_frontend_resume() as part of their
 771  * handler for the &device_driver.resume().
 772  */
 773 int dvb_frontend_resume(struct dvb_frontend *fe);
 774
 775 /**
 776  * dvb_frontend_reinitialise() - forces a reinitialisation at the frontend
 777  *
 778  * @fe: pointer to the frontend struct
 779  *
 780  * Calls &dvb_frontend_ops.init() and &dvb_frontend_ops.tuner_ops.init(),
 781  * and resets SEC tone and voltage (for Satellite systems).
 782  *
 783  * NOTE: Currently, this function is used only by one driver (budget-av).
 784  * It seems to be due to address some special issue with that specific
 785  * frontend.
 786  */
 787 void dvb_frontend_reinitialise(struct dvb_frontend *fe);
 788
 789 /**
 790  * dvb_frontend_sleep_until() - Sleep for the amount of time given by
 791  *                      add_usec parameter
 792  *
 793  * @waketime: pointer to a struct ktime_t
 794  * @add_usec: time to sleep, in microseconds
 795  *
 796  * This function is used to measure the time required for the
 797  * %FE_DISHNETWORK_SEND_LEGACY_CMD ioctl to work. It needs to be as precise
 798  * as possible, as it affects the detection of the dish tone command at the
 799  * satellite subsystem.
 800  *
 801  * Its used internally by the DVB frontend core, in order to emulate
 802  * %FE_DISHNETWORK_SEND_LEGACY_CMD using the &dvb_frontend_ops.set_voltage()
 803  * callback.
 804  *
 805  * NOTE: it should not be used at the drivers, as the emulation for the
 806  * legacy callback is provided by the Kernel. The only situation where this
 807  * should be at the drivers is when there are some bugs at the hardware that
 808  * would prevent the core emulation to work. On such cases, the driver would
 809  * be writing a &dvb_frontend_ops.dishnetwork_send_legacy_command() and
 810  * calling this function directly.
 811  */
 812 void dvb_frontend_sleep_until(ktime_t *waketime, u32 add_usec);
 813
 814 #endif