2     VES1820  - Single Chip Cable Channel Receiver driver module
 
   4     Copyright (C) 1999 Convergence Integrated Media GmbH <ralph@convergence.de>
 
   6     This program is free software; you can redistribute it and/or modify
 
   7     it under the terms of the GNU General Public License as published by
 
   8     the Free Software Foundation; either version 2 of the License, or
 
   9     (at your option) any later version.
 
  11     This program is distributed in the hope that it will be useful,
 
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
  14     GNU General Public License for more details.
 
  16     You should have received a copy of the GNU General Public License
 
  17     along with this program; if not, write to the Free Software
 
  18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
  21 #include <linux/delay.h>
 
  22 #include <linux/errno.h>
 
  23 #include <linux/init.h>
 
  24 #include <linux/kernel.h>
 
  25 #include <linux/module.h>
 
  26 #include <linux/string.h>
 
  27 #include <linux/slab.h>
 
  28 #include <asm/div64.h>
 
  30 #include "dvb_frontend.h"
 
  35 struct ves1820_state {
 
  36         struct i2c_adapter* i2c;
 
  37         /* configuration settings */
 
  38         const struct ves1820_config* config;
 
  39         struct dvb_frontend frontend;
 
  41         /* private demodulator data */
 
  49 static u8 ves1820_inittab[] = {
 
  50         0x69, 0x6A, 0x93, 0x1A, 0x12, 0x46, 0x26, 0x1A,
 
  51         0x43, 0x6A, 0xAA, 0xAA, 0x1E, 0x85, 0x43, 0x20,
 
  52         0xE0, 0x00, 0xA1, 0x00, 0x00, 0x00, 0x00, 0x00,
 
  53         0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
 
  54         0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 
  55         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 
  56         0x00, 0x00, 0x00, 0x00, 0x40
 
  59 static int ves1820_writereg(struct ves1820_state *state, u8 reg, u8 data)
 
  61         u8 buf[] = { 0x00, reg, data };
 
  62         struct i2c_msg msg = {.addr = state->config->demod_address,.flags = 0,.buf = buf,.len = 3 };
 
  65         ret = i2c_transfer(state->i2c, &msg, 1);
 
  68                 printk("ves1820: %s(): writereg error (reg == 0x%02x, "
 
  69                         "val == 0x%02x, ret == %i)\n", __FUNCTION__, reg, data, ret);
 
  71         return (ret != 1) ? -EREMOTEIO : 0;
 
  74 static u8 ves1820_readreg(struct ves1820_state *state, u8 reg)
 
  76         u8 b0[] = { 0x00, reg };
 
  78         struct i2c_msg msg[] = {
 
  79                 {.addr = state->config->demod_address,.flags = 0,.buf = b0,.len = 2},
 
  80                 {.addr = state->config->demod_address,.flags = I2C_M_RD,.buf = b1,.len = 1}
 
  84         ret = i2c_transfer(state->i2c, msg, 2);
 
  87                 printk("ves1820: %s(): readreg error (reg == 0x%02x, "
 
  88                 "ret == %i)\n", __FUNCTION__, reg, ret);
 
  93 static int ves1820_setup_reg0(struct ves1820_state *state, u8 reg0, fe_spectral_inversion_t inversion)
 
  95         reg0 |= state->reg0 & 0x62;
 
  97         if (INVERSION_ON == inversion) {
 
  98                 if (!state->config->invert) reg0 |= 0x20;
 
 100         } else if (INVERSION_OFF == inversion) {
 
 101                 if (!state->config->invert) reg0 &= ~0x20;
 
 105         ves1820_writereg(state, 0x00, reg0 & 0xfe);
 
 106         ves1820_writereg(state, 0x00, reg0 | 0x01);
 
 113 static int ves1820_set_symbolrate(struct ves1820_state *state, u32 symbolrate)
 
 125         if (symbolrate > state->config->xin / 2)
 
 126                 symbolrate = state->config->xin / 2;
 
 128         if (symbolrate < 500000)
 
 131         if (symbolrate < state->config->xin / 16)
 
 133         if (symbolrate < state->config->xin / 32)
 
 135         if (symbolrate < state->config->xin / 64)
 
 139         fpxin = state->config->xin * 10;
 
 140         fptmp = fpxin; do_div(fptmp, 123);
 
 141         if (symbolrate < fptmp)
 
 143         fptmp = fpxin; do_div(fptmp, 160);
 
 144         if (symbolrate < fptmp)
 
 146         fptmp = fpxin; do_div(fptmp, 246);
 
 147         if (symbolrate < fptmp)
 
 149         fptmp = fpxin; do_div(fptmp, 320);
 
 150         if (symbolrate < fptmp)
 
 152         fptmp = fpxin; do_div(fptmp, 492);
 
 153         if (symbolrate < fptmp)
 
 155         fptmp = fpxin; do_div(fptmp, 640);
 
 156         if (symbolrate < fptmp)
 
 158         fptmp = fpxin; do_div(fptmp, 984);
 
 159         if (symbolrate < fptmp)
 
 162         fin = state->config->xin >> 4;
 
 164         ratio = (symbolrate << 4) / fin;
 
 165         tmp = ((symbolrate << 4) % fin) << 8;
 
 166         ratio = (ratio << 8) + tmp / fin;
 
 167         tmp = (tmp % fin) << 8;
 
 168         ratio = (ratio << 8) + (tmp + fin / 2) / fin;
 
 171         BDRI = (((state->config->xin << 5) / symbolrate) + 1) / 2;
 
 176         SFIL = (SFIL << 4) | ves1820_inittab[0x0E];
 
 178         NDEC = (NDEC << 6) | ves1820_inittab[0x03];
 
 180         ves1820_writereg(state, 0x03, NDEC);
 
 181         ves1820_writereg(state, 0x0a, BDR & 0xff);
 
 182         ves1820_writereg(state, 0x0b, (BDR >> 8) & 0xff);
 
 183         ves1820_writereg(state, 0x0c, (BDR >> 16) & 0x3f);
 
 185         ves1820_writereg(state, 0x0d, BDRI);
 
 186         ves1820_writereg(state, 0x0e, SFIL);
 
 191 static int ves1820_init(struct dvb_frontend* fe)
 
 193         struct ves1820_state* state = fe->demodulator_priv;
 
 196         ves1820_writereg(state, 0, 0);
 
 198         for (i = 0; i < sizeof(ves1820_inittab); i++)
 
 199                 ves1820_writereg(state, i, ves1820_inittab[i]);
 
 200         if (state->config->selagc)
 
 201                 ves1820_writereg(state, 2, ves1820_inittab[2] | 0x08);
 
 203         ves1820_writereg(state, 0x34, state->pwm);
 
 208 static int ves1820_set_parameters(struct dvb_frontend* fe, struct dvb_frontend_parameters *p)
 
 210         struct ves1820_state* state = fe->demodulator_priv;
 
 211         static const u8 reg0x00[] = { 0x00, 0x04, 0x08, 0x0c, 0x10 };
 
 212         static const u8 reg0x01[] = { 140, 140, 106, 100, 92 };
 
 213         static const u8 reg0x05[] = { 135, 100, 70, 54, 38 };
 
 214         static const u8 reg0x08[] = { 162, 116, 67, 52, 35 };
 
 215         static const u8 reg0x09[] = { 145, 150, 106, 126, 107 };
 
 216         int real_qam = p->u.qam.modulation - QAM_16;
 
 218         if (real_qam < 0 || real_qam > 4)
 
 221         if (fe->ops.tuner_ops.set_params) {
 
 222                 fe->ops.tuner_ops.set_params(fe, p);
 
 223                 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
 
 226         ves1820_set_symbolrate(state, p->u.qam.symbol_rate);
 
 227         ves1820_writereg(state, 0x34, state->pwm);
 
 229         ves1820_writereg(state, 0x01, reg0x01[real_qam]);
 
 230         ves1820_writereg(state, 0x05, reg0x05[real_qam]);
 
 231         ves1820_writereg(state, 0x08, reg0x08[real_qam]);
 
 232         ves1820_writereg(state, 0x09, reg0x09[real_qam]);
 
 234         ves1820_setup_reg0(state, reg0x00[real_qam], p->inversion);
 
 235         ves1820_writereg(state, 2, ves1820_inittab[2] | (state->config->selagc ? 0x08 : 0));
 
 239 static int ves1820_read_status(struct dvb_frontend* fe, fe_status_t* status)
 
 241         struct ves1820_state* state = fe->demodulator_priv;
 
 245         sync = ves1820_readreg(state, 0x11);
 
 248                 *status |= FE_HAS_SIGNAL;
 
 251                 *status |= FE_HAS_CARRIER;
 
 253         if (sync & 2)   /* XXX FIXME! */
 
 254                 *status |= FE_HAS_VITERBI;
 
 257                 *status |= FE_HAS_SYNC;
 
 260                 *status |= FE_HAS_LOCK;
 
 265 static int ves1820_read_ber(struct dvb_frontend* fe, u32* ber)
 
 267         struct ves1820_state* state = fe->demodulator_priv;
 
 269         u32 _ber = ves1820_readreg(state, 0x14) |
 
 270                         (ves1820_readreg(state, 0x15) << 8) |
 
 271                         ((ves1820_readreg(state, 0x16) & 0x0f) << 16);
 
 277 static int ves1820_read_signal_strength(struct dvb_frontend* fe, u16* strength)
 
 279         struct ves1820_state* state = fe->demodulator_priv;
 
 281         u8 gain = ves1820_readreg(state, 0x17);
 
 282         *strength = (gain << 8) | gain;
 
 287 static int ves1820_read_snr(struct dvb_frontend* fe, u16* snr)
 
 289         struct ves1820_state* state = fe->demodulator_priv;
 
 291         u8 quality = ~ves1820_readreg(state, 0x18);
 
 292         *snr = (quality << 8) | quality;
 
 297 static int ves1820_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
 
 299         struct ves1820_state* state = fe->demodulator_priv;
 
 301         *ucblocks = ves1820_readreg(state, 0x13) & 0x7f;
 
 302         if (*ucblocks == 0x7f)
 
 303                 *ucblocks = 0xffffffff;
 
 305         /* reset uncorrected block counter */
 
 306         ves1820_writereg(state, 0x10, ves1820_inittab[0x10] & 0xdf);
 
 307         ves1820_writereg(state, 0x10, ves1820_inittab[0x10]);
 
 312 static int ves1820_get_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters *p)
 
 314         struct ves1820_state* state = fe->demodulator_priv;
 
 318         sync = ves1820_readreg(state, 0x11);
 
 319         afc = ves1820_readreg(state, 0x19);
 
 321                 /* AFC only valid when carrier has been recovered */
 
 322                 printk(sync & 2 ? "ves1820: AFC (%d) %dHz\n" :
 
 323                         "ves1820: [AFC (%d) %dHz]\n", afc, -((s32) p->u.qam.symbol_rate * afc) >> 10);
 
 326         if (!state->config->invert) {
 
 327                 p->inversion = (state->reg0 & 0x20) ? INVERSION_ON : INVERSION_OFF;
 
 329                 p->inversion = (!(state->reg0 & 0x20)) ? INVERSION_ON : INVERSION_OFF;
 
 332         p->u.qam.modulation = ((state->reg0 >> 2) & 7) + QAM_16;
 
 334         p->u.qam.fec_inner = FEC_NONE;
 
 336         p->frequency = ((p->frequency + 31250) / 62500) * 62500;
 
 338                 p->frequency -= ((s32) p->u.qam.symbol_rate * afc) >> 10;
 
 343 static int ves1820_sleep(struct dvb_frontend* fe)
 
 345         struct ves1820_state* state = fe->demodulator_priv;
 
 347         ves1820_writereg(state, 0x1b, 0x02);    /* pdown ADC */
 
 348         ves1820_writereg(state, 0x00, 0x80);    /* standby */
 
 353 static int ves1820_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
 
 356         fesettings->min_delay_ms = 200;
 
 357         fesettings->step_size = 0;
 
 358         fesettings->max_drift = 0;
 
 362 static void ves1820_release(struct dvb_frontend* fe)
 
 364         struct ves1820_state* state = fe->demodulator_priv;
 
 368 static struct dvb_frontend_ops ves1820_ops;
 
 370 struct dvb_frontend* ves1820_attach(const struct ves1820_config* config,
 
 371                                     struct i2c_adapter* i2c,
 
 374         struct ves1820_state* state = NULL;
 
 376         /* allocate memory for the internal state */
 
 377         state = kmalloc(sizeof(struct ves1820_state), GFP_KERNEL);
 
 381         /* setup the state */
 
 382         state->reg0 = ves1820_inittab[0];
 
 383         state->config = config;
 
 387         /* check if the demod is there */
 
 388         if ((ves1820_readreg(state, 0x1a) & 0xf0) != 0x70)
 
 392                 printk("ves1820: pwm=0x%02x\n", state->pwm);
 
 394         /* create dvb_frontend */
 
 395         memcpy(&state->frontend.ops, &ves1820_ops, sizeof(struct dvb_frontend_ops));
 
 396         state->frontend.ops.info.symbol_rate_min = (state->config->xin / 2) / 64;      /* SACLK/64 == (XIN/2)/64 */
 
 397         state->frontend.ops.info.symbol_rate_max = (state->config->xin / 2) / 4;       /* SACLK/4 */
 
 398         state->frontend.demodulator_priv = state;
 
 400         return &state->frontend;
 
 407 static struct dvb_frontend_ops ves1820_ops = {
 
 410                 .name = "VLSI VES1820 DVB-C",
 
 412                 .frequency_stepsize = 62500,
 
 413                 .frequency_min = 47000000,
 
 414                 .frequency_max = 862000000,
 
 415                 .caps = FE_CAN_QAM_16 |
 
 423         .release = ves1820_release,
 
 425         .init = ves1820_init,
 
 426         .sleep = ves1820_sleep,
 
 428         .set_frontend = ves1820_set_parameters,
 
 429         .get_frontend = ves1820_get_frontend,
 
 430         .get_tune_settings = ves1820_get_tune_settings,
 
 432         .read_status = ves1820_read_status,
 
 433         .read_ber = ves1820_read_ber,
 
 434         .read_signal_strength = ves1820_read_signal_strength,
 
 435         .read_snr = ves1820_read_snr,
 
 436         .read_ucblocks = ves1820_read_ucblocks,
 
 439 module_param(verbose, int, 0644);
 
 440 MODULE_PARM_DESC(verbose, "print AFC offset after tuning for debugging the PWM setting");
 
 442 MODULE_DESCRIPTION("VLSI VES1820 DVB-C Demodulator driver");
 
 443 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler");
 
 444 MODULE_LICENSE("GPL");
 
 446 EXPORT_SYMBOL(ves1820_attach);