drivers/media/dvb/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
  40 #include <linux/dvb/frontend.h>
  41
  42 #include "dvbdev.h"
  43
  44 struct dvb_frontend_tune_settings {
  45         int min_delay_ms;
  46         int step_size;
  47         int max_drift;
  48         struct dvb_frontend_parameters parameters;
  49 };
  50
  51 struct dvb_frontend;
  52
  53 struct dvb_tuner_info {
  54         char name[128];
  55
  56         u32 frequency_min;
  57         u32 frequency_max;
  58         u32 frequency_step;
  59
  60         u32 bandwidth_min;
  61         u32 bandwidth_max;
  62         u32 bandwidth_step;
  63 };
  64
  65 struct analog_parameters {
  66         unsigned int frequency;
  67         unsigned int mode;
  68         unsigned int audmode;
  69         u64 std;
  70 };
  71
  72 struct dvb_tuner_ops {
  73
  74         struct dvb_tuner_info info;
  75
  76         int (*release)(struct dvb_frontend *fe);
  77         int (*init)(struct dvb_frontend *fe);
  78         int (*sleep)(struct dvb_frontend *fe);
  79
  80         /** This is for simple PLLs - set all parameters in one go. */
  81         int (*set_params)(struct dvb_frontend *fe, struct dvb_frontend_parameters *p);
  82         int (*set_analog_params)(struct dvb_frontend *fe, struct analog_parameters *p);
  83
  84         /** This is support for demods like the mt352 - fills out the supplied buffer with what to write. */
  85         int (*calc_regs)(struct dvb_frontend *fe, struct dvb_frontend_parameters *p, u8 *buf, int buf_len);
  86
  87         /** This is to allow setting tuner-specific configs */
  88         int (*set_config)(struct dvb_frontend *fe, void *priv_cfg);
  89
  90         int (*get_frequency)(struct dvb_frontend *fe, u32 *frequency);
  91         int (*get_bandwidth)(struct dvb_frontend *fe, u32 *bandwidth);
  92
  93 #define TUNER_STATUS_LOCKED 1
  94 #define TUNER_STATUS_STEREO 2
  95         int (*get_status)(struct dvb_frontend *fe, u32 *status);
  96         int (*get_rf_strength)(struct dvb_frontend *fe, u16 *strength);
  97
  98         /** These are provided seperately from set_params in order to facilitate silicon
  99          * tuners which require sophisticated tuning loops, controlling each parameter seperately. */
 100         int (*set_frequency)(struct dvb_frontend *fe, u32 frequency);
 101         int (*set_bandwidth)(struct dvb_frontend *fe, u32 bandwidth);
 102 };
 103
 104 struct analog_demod_info {
 105         char *name;
 106 };
 107
 108 struct analog_demod_ops {
 109
 110         struct analog_demod_info info;
 111
 112         void (*set_params)(struct dvb_frontend *fe,
 113                            struct analog_parameters *params);
 114         int  (*has_signal)(struct dvb_frontend *fe);
 115         int  (*is_stereo)(struct dvb_frontend *fe);
 116         int  (*get_afc)(struct dvb_frontend *fe);
 117         void (*tuner_status)(struct dvb_frontend *fe);
 118         void (*standby)(struct dvb_frontend *fe);
 119         void (*release)(struct dvb_frontend *fe);
 120         int  (*i2c_gate_ctrl)(struct dvb_frontend *fe, int enable);
 121
 122         /** This is to allow setting tuner-specific configuration */
 123         int (*set_config)(struct dvb_frontend *fe, void *priv_cfg);
 124 };
 125
 126 struct dvb_frontend_ops {
 127
 128         struct dvb_frontend_info info;
 129
 130         void (*release)(struct dvb_frontend* fe);
 131         void (*release_sec)(struct dvb_frontend* fe);
 132
 133         int (*init)(struct dvb_frontend* fe);
 134         int (*sleep)(struct dvb_frontend* fe);
 135
 136         int (*write)(struct dvb_frontend* fe, u8* buf, int len);
 137
 138         /* if this is set, it overrides the default swzigzag */
 139         int (*tune)(struct dvb_frontend* fe,
 140                     struct dvb_frontend_parameters* params,
 141                     unsigned int mode_flags,
 142                     unsigned int *delay,
 143                     fe_status_t *status);
 144         /* get frontend tuning algorithm from the module */
 145         int (*get_frontend_algo)(struct dvb_frontend *fe);
 146
 147         /* these two are only used for the swzigzag code */
 148         int (*set_frontend)(struct dvb_frontend* fe, struct dvb_frontend_parameters* params);
 149         int (*get_tune_settings)(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* settings);
 150
 151         int (*get_frontend)(struct dvb_frontend* fe, struct dvb_frontend_parameters* params);
 152
 153         int (*read_status)(struct dvb_frontend* fe, fe_status_t* status);
 154         int (*read_ber)(struct dvb_frontend* fe, u32* ber);
 155         int (*read_signal_strength)(struct dvb_frontend* fe, u16* strength);
 156         int (*read_snr)(struct dvb_frontend* fe, u16* snr);
 157         int (*read_ucblocks)(struct dvb_frontend* fe, u32* ucblocks);
 158
 159         int (*diseqc_reset_overload)(struct dvb_frontend* fe);
 160         int (*diseqc_send_master_cmd)(struct dvb_frontend* fe, struct dvb_diseqc_master_cmd* cmd);
 161         int (*diseqc_recv_slave_reply)(struct dvb_frontend* fe, struct dvb_diseqc_slave_reply* reply);
 162         int (*diseqc_send_burst)(struct dvb_frontend* fe, fe_sec_mini_cmd_t minicmd);
 163         int (*set_tone)(struct dvb_frontend* fe, fe_sec_tone_mode_t tone);
 164         int (*set_voltage)(struct dvb_frontend* fe, fe_sec_voltage_t voltage);
 165         int (*enable_high_lnb_voltage)(struct dvb_frontend* fe, long arg);
 166         int (*dishnetwork_send_legacy_command)(struct dvb_frontend* fe, unsigned long cmd);
 167         int (*i2c_gate_ctrl)(struct dvb_frontend* fe, int enable);
 168         int (*ts_bus_ctrl)(struct dvb_frontend* fe, int acquire);
 169
 170         struct dvb_tuner_ops tuner_ops;
 171         struct analog_demod_ops analog_ops;
 172 };
 173
 174 #define MAX_EVENT 8
 175
 176 struct dvb_fe_events {
 177         struct dvb_frontend_event events[MAX_EVENT];
 178         int                       eventw;
 179         int                       eventr;
 180         int                       overflow;
 181         wait_queue_head_t         wait_queue;
 182         struct mutex              mtx;
 183 };
 184
 185 struct dvb_frontend {
 186         struct dvb_frontend_ops ops;
 187         struct dvb_adapter *dvb;
 188         void *demodulator_priv;
 189         void *tuner_priv;
 190         void *frontend_priv;
 191         void *sec_priv;
 192         void *analog_demod_priv;
 193 };
 194
 195 extern int dvb_register_frontend(struct dvb_adapter *dvb,
 196                                  struct dvb_frontend *fe);
 197
 198 extern int dvb_unregister_frontend(struct dvb_frontend *fe);
 199
 200 extern void dvb_frontend_detach(struct dvb_frontend *fe);
 201
 202 extern void dvb_frontend_reinitialise(struct dvb_frontend *fe);
 203
 204 extern void dvb_frontend_sleep_until(struct timeval *waketime, u32 add_usec);
 205 extern s32 timeval_usec_diff(struct timeval lasttime, struct timeval curtime);
 206
 207 #endif