drivers/media/dvb/frontends/tda10021.c

   1 /*
   2     TDA10021  - Single Chip Cable Channel Receiver driver module
   3                used on the the Siemens DVB-C cards
   4
   5     Copyright (C) 1999 Convergence Integrated Media GmbH <ralph@convergence.de>
   6     Copyright (C) 2004 Markus Schulz <msc@antzsystem.de>
   7                    Support for TDA10021
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17     GNU General Public License for more details.
  18
  19     You should have received a copy of the GNU General Public License
  20     along with this program; if not, write to the Free Software
  21     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #include <linux/delay.h>
  25 #include <linux/errno.h>
  26 #include <linux/init.h>
  27 #include <linux/kernel.h>
  28 #include <linux/module.h>
  29 #include <linux/string.h>
  30 #include <linux/slab.h>
  31
  32 #include "dvb_frontend.h"
  33 #include "tda10021.h"
  34
  35
  36 struct tda10021_state {
  37         struct i2c_adapter* i2c;
  38         /* configuration settings */
  39         const struct tda10021_config* config;
  40         struct dvb_frontend frontend;
  41
  42         u8 pwm;
  43         u8 reg0;
  44 };
  45
  46
  47 #if 0
  48 #define dprintk(x...) printk(x)
  49 #else
  50 #define dprintk(x...)
  51 #endif
  52
  53 static int verbose;
  54
  55 #define XIN 57840000UL
  56 #define DISABLE_INVERSION(reg0)         do { reg0 |= 0x20; } while (0)
  57 #define ENABLE_INVERSION(reg0)          do { reg0 &= ~0x20; } while (0)
  58 #define HAS_INVERSION(reg0)             (!(reg0 & 0x20))
  59
  60 #define FIN (XIN >> 4)
  61
  62 static int tda10021_inittab_size = 0x40;
  63 static u8 tda10021_inittab[0x40]=
  64 {
  65         0x73, 0x6a, 0x23, 0x0a, 0x02, 0x37, 0x77, 0x1a,
  66         0x37, 0x6a, 0x17, 0x8a, 0x1e, 0x86, 0x43, 0x40,
  67         0xb8, 0x3f, 0xa0, 0x00, 0xcd, 0x01, 0x00, 0xff,
  68         0x11, 0x00, 0x7c, 0x31, 0x30, 0x20, 0x00, 0x00,
  69         0x02, 0x00, 0x00, 0x7d, 0x00, 0x00, 0x00, 0x00,
  70         0x07, 0x00, 0x33, 0x11, 0x0d, 0x95, 0x08, 0x58,
  71         0x00, 0x00, 0x80, 0x00, 0x80, 0xff, 0x00, 0x00,
  72         0x04, 0x2d, 0x2f, 0xff, 0x00, 0x00, 0x00, 0x00,
  73 };
  74
  75 static int _tda10021_writereg (struct tda10021_state* state, u8 reg, u8 data)
  76 {
  77         u8 buf[] = { reg, data };
  78         struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = 2 };
  79         int ret;
  80
  81         ret = i2c_transfer (state->i2c, &msg, 1);
  82         if (ret != 1)
  83                 printk("DVB: TDA10021(%d): %s, writereg error "
  84                         "(reg == 0x%02x, val == 0x%02x, ret == %i)\n",
  85                         state->frontend.dvb->num, __FUNCTION__, reg, data, ret);
  86
  87         msleep(10);
  88         return (ret != 1) ? -EREMOTEIO : 0;
  89 }
  90
  91 static u8 tda10021_readreg (struct tda10021_state* state, u8 reg)
  92 {
  93         u8 b0 [] = { reg };
  94         u8 b1 [] = { 0 };
  95         struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 1 },
  96                                   { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 1 } };
  97         int ret;
  98
  99         ret = i2c_transfer (state->i2c, msg, 2);
 100         if (ret != 2)
 101                 printk("DVB: TDA10021: %s: readreg error (ret == %i)\n",
 102                                 __FUNCTION__, ret);
 103         return b1[0];
 104 }
 105
 106 //get access to tuner
 107 static int lock_tuner(struct tda10021_state* state)
 108 {
 109         u8 buf[2] = { 0x0f, tda10021_inittab[0x0f] | 0x80 };
 110         struct i2c_msg msg = {.addr=state->config->demod_address, .flags=0, .buf=buf, .len=2};
 111
 112         if(i2c_transfer(state->i2c, &msg, 1) != 1)
 113         {
 114                 printk("tda10021: lock tuner fails\n");
 115                 return -EREMOTEIO;
 116         }
 117         return 0;
 118 }
 119
 120 //release access from tuner
 121 static int unlock_tuner(struct tda10021_state* state)
 122 {
 123         u8 buf[2] = { 0x0f, tda10021_inittab[0x0f] & 0x7f };
 124         struct i2c_msg msg_post={.addr=state->config->demod_address, .flags=0, .buf=buf, .len=2};
 125
 126         if(i2c_transfer(state->i2c, &msg_post, 1) != 1)
 127         {
 128                 printk("tda10021: unlock tuner fails\n");
 129                 return -EREMOTEIO;
 130         }
 131         return 0;
 132 }
 133
 134 static int tda10021_setup_reg0 (struct tda10021_state* state, u8 reg0,
 135                                 fe_spectral_inversion_t inversion)
 136 {
 137         reg0 |= state->reg0 & 0x63;
 138
 139         if (INVERSION_ON == inversion)
 140                 ENABLE_INVERSION(reg0);
 141         else if (INVERSION_OFF == inversion)
 142                 DISABLE_INVERSION(reg0);
 143
 144         _tda10021_writereg (state, 0x00, reg0 & 0xfe);
 145         _tda10021_writereg (state, 0x00, reg0 | 0x01);
 146
 147         state->reg0 = reg0;
 148         return 0;
 149 }
 150
 151 static int tda10021_set_symbolrate (struct tda10021_state* state, u32 symbolrate)
 152 {
 153         s32 BDR;
 154         s32 BDRI;
 155         s16 SFIL=0;
 156         u16 NDEC = 0;
 157         u32 tmp, ratio;
 158
 159         if (symbolrate > XIN/2)
 160                 symbolrate = XIN/2;
 161         if (symbolrate < 500000)
 162                 symbolrate = 500000;
 163
 164         if (symbolrate < XIN/16) NDEC = 1;
 165         if (symbolrate < XIN/32) NDEC = 2;
 166         if (symbolrate < XIN/64) NDEC = 3;
 167
 168         if (symbolrate < (u32)(XIN/12.3)) SFIL = 1;
 169         if (symbolrate < (u32)(XIN/16))  SFIL = 0;
 170         if (symbolrate < (u32)(XIN/24.6)) SFIL = 1;
 171         if (symbolrate < (u32)(XIN/32))  SFIL = 0;
 172         if (symbolrate < (u32)(XIN/49.2)) SFIL = 1;
 173         if (symbolrate < (u32)(XIN/64))  SFIL = 0;
 174         if (symbolrate < (u32)(XIN/98.4)) SFIL = 1;
 175
 176         symbolrate <<= NDEC;
 177         ratio = (symbolrate << 4) / FIN;
 178         tmp =  ((symbolrate << 4) % FIN) << 8;
 179         ratio = (ratio << 8) + tmp / FIN;
 180         tmp = (tmp % FIN) << 8;
 181         ratio = (ratio << 8) + (tmp + FIN/2) / FIN;
 182
 183         BDR = ratio;
 184         BDRI = (((XIN << 5) / symbolrate) + 1) / 2;
 185
 186         if (BDRI > 0xFF)
 187                 BDRI = 0xFF;
 188
 189         SFIL = (SFIL << 4) | tda10021_inittab[0x0E];
 190
 191         NDEC = (NDEC << 6) | tda10021_inittab[0x03];
 192
 193         _tda10021_writereg (state, 0x03, NDEC);
 194         _tda10021_writereg (state, 0x0a, BDR&0xff);
 195         _tda10021_writereg (state, 0x0b, (BDR>> 8)&0xff);
 196         _tda10021_writereg (state, 0x0c, (BDR>>16)&0x3f);
 197
 198         _tda10021_writereg (state, 0x0d, BDRI);
 199         _tda10021_writereg (state, 0x0e, SFIL);
 200
 201         return 0;
 202 }
 203
 204 int tda10021_write(struct dvb_frontend* fe, u8 *buf, int len)
 205 {
 206         struct tda10021_state* state = fe->demodulator_priv;
 207
 208         if (len != 2)
 209                 return -EINVAL;
 210
 211         return _tda10021_writereg(state, buf[0], buf[1]);
 212 }
 213
 214 static int tda10021_init (struct dvb_frontend *fe)
 215 {
 216         struct tda10021_state* state = fe->demodulator_priv;
 217         int i;
 218
 219         dprintk("DVB: TDA10021(%d): init chip\n", fe->adapter->num);
 220
 221         //_tda10021_writereg (fe, 0, 0);
 222
 223         for (i=0; i<tda10021_inittab_size; i++)
 224                 _tda10021_writereg (state, i, tda10021_inittab[i]);
 225
 226         _tda10021_writereg (state, 0x34, state->pwm);
 227
 228         //Comment by markus
 229         //0x2A[3-0] == PDIV -> P multiplaying factor (P=PDIV+1)(default 0)
 230         //0x2A[4] == BYPPLL -> Power down mode (default 1)
 231         //0x2A[5] == LCK -> PLL Lock Flag
 232         //0x2A[6] == POLAXIN -> Polarity of the input reference clock (default 0)
 233
 234         //Activate PLL
 235         _tda10021_writereg(state, 0x2a, tda10021_inittab[0x2a] & 0xef);
 236         return 0;
 237 }
 238
 239 static int tda10021_set_parameters (struct dvb_frontend *fe,
 240                             struct dvb_frontend_parameters *p)
 241 {
 242         struct tda10021_state* state = fe->demodulator_priv;
 243
 244         //table for QAM4-QAM256 ready  QAM4  QAM16 QAM32 QAM64 QAM128 QAM256
 245         //CONF
 246         static const u8 reg0x00 [] = { 0x14, 0x00, 0x04, 0x08, 0x0c,  0x10 };
 247         //AGCREF value
 248         static const u8 reg0x01 [] = { 0x78, 0x8c, 0x8c, 0x6a, 0x78,  0x5c };
 249         //LTHR value
 250         static const u8 reg0x05 [] = { 0x78, 0x87, 0x64, 0x46, 0x36,  0x26 };
 251         //MSETH
 252         static const u8 reg0x08 [] = { 0x8c, 0xa2, 0x74, 0x43, 0x34,  0x23 };
 253         //AREF
 254         static const u8 reg0x09 [] = { 0x96, 0x91, 0x96, 0x6a, 0x7e,  0x6b };
 255
 256         int qam = p->u.qam.modulation;
 257
 258         if (qam < 0 || qam > 5)
 259                 return -EINVAL;
 260
 261         //printk("tda10021: set frequency to %d qam=%d symrate=%d\n", p->frequency,qam,p->u.qam.symbol_rate);
 262
 263         if (fe->ops.tuner_ops.set_params) {
 264                 fe->ops.tuner_ops.set_params(fe, p);
 265                 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
 266         }
 267
 268         tda10021_set_symbolrate (state, p->u.qam.symbol_rate);
 269         _tda10021_writereg (state, 0x34, state->pwm);
 270
 271         _tda10021_writereg (state, 0x01, reg0x01[qam]);
 272         _tda10021_writereg (state, 0x05, reg0x05[qam]);
 273         _tda10021_writereg (state, 0x08, reg0x08[qam]);
 274         _tda10021_writereg (state, 0x09, reg0x09[qam]);
 275
 276         tda10021_setup_reg0 (state, reg0x00[qam], p->inversion);
 277
 278         return 0;
 279 }
 280
 281 static int tda10021_read_status(struct dvb_frontend* fe, fe_status_t* status)
 282 {
 283         struct tda10021_state* state = fe->demodulator_priv;
 284         int sync;
 285
 286         *status = 0;
 287         //0x11[0] == EQALGO -> Equalizer algorithms state
 288         //0x11[1] == CARLOCK -> Carrier locked
 289         //0x11[2] == FSYNC -> Frame synchronisation
 290         //0x11[3] == FEL -> Front End locked
 291         //0x11[6] == NODVB -> DVB Mode Information
 292         sync = tda10021_readreg (state, 0x11);
 293
 294         if (sync & 2)
 295                 *status |= FE_HAS_SIGNAL|FE_HAS_CARRIER;
 296
 297         if (sync & 4)
 298                 *status |= FE_HAS_SYNC|FE_HAS_VITERBI;
 299
 300         if (sync & 8)
 301                 *status |= FE_HAS_LOCK;
 302
 303         return 0;
 304 }
 305
 306 static int tda10021_read_ber(struct dvb_frontend* fe, u32* ber)
 307 {
 308         struct tda10021_state* state = fe->demodulator_priv;
 309
 310         u32 _ber = tda10021_readreg(state, 0x14) |
 311                 (tda10021_readreg(state, 0x15) << 8) |
 312                 ((tda10021_readreg(state, 0x16) & 0x0f) << 16);
 313         *ber = 10 * _ber;
 314
 315         return 0;
 316 }
 317
 318 static int tda10021_read_signal_strength(struct dvb_frontend* fe, u16* strength)
 319 {
 320         struct tda10021_state* state = fe->demodulator_priv;
 321
 322         u8 gain = tda10021_readreg(state, 0x17);
 323         *strength = (gain << 8) | gain;
 324
 325         return 0;
 326 }
 327
 328 static int tda10021_read_snr(struct dvb_frontend* fe, u16* snr)
 329 {
 330         struct tda10021_state* state = fe->demodulator_priv;
 331
 332         u8 quality = ~tda10021_readreg(state, 0x18);
 333         *snr = (quality << 8) | quality;
 334
 335         return 0;
 336 }
 337
 338 static int tda10021_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
 339 {
 340         struct tda10021_state* state = fe->demodulator_priv;
 341
 342         *ucblocks = tda10021_readreg (state, 0x13) & 0x7f;
 343         if (*ucblocks == 0x7f)
 344                 *ucblocks = 0xffffffff;
 345
 346         /* reset uncorrected block counter */
 347         _tda10021_writereg (state, 0x10, tda10021_inittab[0x10] & 0xdf);
 348         _tda10021_writereg (state, 0x10, tda10021_inittab[0x10]);
 349
 350         return 0;
 351 }
 352
 353 static int tda10021_get_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters *p)
 354 {
 355         struct tda10021_state* state = fe->demodulator_priv;
 356         int sync;
 357         s8 afc = 0;
 358
 359         sync = tda10021_readreg(state, 0x11);
 360         afc = tda10021_readreg(state, 0x19);
 361         if (verbose) {
 362                 /* AFC only valid when carrier has been recovered */
 363                 printk(sync & 2 ? "DVB: TDA10021(%d): AFC (%d) %dHz\n" :
 364                                   "DVB: TDA10021(%d): [AFC (%d) %dHz]\n",
 365                         state->frontend.dvb->num, afc,
 366                        -((s32)p->u.qam.symbol_rate * afc) >> 10);
 367         }
 368
 369         p->inversion = HAS_INVERSION(state->reg0) ? INVERSION_ON : INVERSION_OFF;
 370         p->u.qam.modulation = ((state->reg0 >> 2) & 7) + QAM_16;
 371
 372         p->u.qam.fec_inner = FEC_NONE;
 373         p->frequency = ((p->frequency + 31250) / 62500) * 62500;
 374
 375         if (sync & 2)
 376                 p->frequency -= ((s32)p->u.qam.symbol_rate * afc) >> 10;
 377
 378         return 0;
 379 }
 380
 381 static int tda10021_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
 382 {
 383         struct tda10021_state* state = fe->demodulator_priv;
 384
 385         if (enable) {
 386                 lock_tuner(state);
 387         } else {
 388                 unlock_tuner(state);
 389         }
 390         return 0;
 391 }
 392
 393 static int tda10021_sleep(struct dvb_frontend* fe)
 394 {
 395         struct tda10021_state* state = fe->demodulator_priv;
 396
 397         _tda10021_writereg (state, 0x1b, 0x02);  /* pdown ADC */
 398         _tda10021_writereg (state, 0x00, 0x80);  /* standby */
 399
 400         return 0;
 401 }
 402
 403 static void tda10021_release(struct dvb_frontend* fe)
 404 {
 405         struct tda10021_state* state = fe->demodulator_priv;
 406         kfree(state);
 407 }
 408
 409 static struct dvb_frontend_ops tda10021_ops;
 410
 411 struct dvb_frontend* tda10021_attach(const struct tda10021_config* config,
 412                                      struct i2c_adapter* i2c,
 413                                      u8 pwm)
 414 {
 415         struct tda10021_state* state = NULL;
 416
 417         /* allocate memory for the internal state */
 418         state = kmalloc(sizeof(struct tda10021_state), GFP_KERNEL);
 419         if (state == NULL) goto error;
 420
 421         /* setup the state */
 422         state->config = config;
 423         state->i2c = i2c;
 424         state->pwm = pwm;
 425         state->reg0 = tda10021_inittab[0];
 426
 427         /* check if the demod is there */
 428         if ((tda10021_readreg(state, 0x1a) & 0xf0) != 0x70) goto error;
 429
 430         /* create dvb_frontend */
 431         memcpy(&state->frontend.ops, &tda10021_ops, sizeof(struct dvb_frontend_ops));
 432         state->frontend.demodulator_priv = state;
 433         return &state->frontend;
 434
 435 error:
 436         kfree(state);
 437         return NULL;
 438 }
 439
 440 static struct dvb_frontend_ops tda10021_ops = {
 441
 442         .info = {
 443                 .name = "Philips TDA10021 DVB-C",
 444                 .type = FE_QAM,
 445                 .frequency_stepsize = 62500,
 446                 .frequency_min = 51000000,
 447                 .frequency_max = 858000000,
 448                 .symbol_rate_min = (XIN/2)/64,     /* SACLK/64 == (XIN/2)/64 */
 449                 .symbol_rate_max = (XIN/2)/4,      /* SACLK/4 */
 450 #if 0
 451                 .frequency_tolerance = ???,
 452                 .symbol_rate_tolerance = ???,  /* ppm */  /* == 8% (spec p. 5) */
 453         #endif
 454                 .caps = 0x400 | //FE_CAN_QAM_4
 455                         FE_CAN_QAM_16 | FE_CAN_QAM_32 | FE_CAN_QAM_64 |
 456                         FE_CAN_QAM_128 | FE_CAN_QAM_256 |
 457                         FE_CAN_FEC_AUTO
 458         },
 459
 460         .release = tda10021_release,
 461
 462         .init = tda10021_init,
 463         .sleep = tda10021_sleep,
 464         .write = tda10021_write,
 465         .i2c_gate_ctrl = tda10021_i2c_gate_ctrl,
 466
 467         .set_frontend = tda10021_set_parameters,
 468         .get_frontend = tda10021_get_frontend,
 469
 470         .read_status = tda10021_read_status,
 471         .read_ber = tda10021_read_ber,
 472         .read_signal_strength = tda10021_read_signal_strength,
 473         .read_snr = tda10021_read_snr,
 474         .read_ucblocks = tda10021_read_ucblocks,
 475 };
 476
 477 module_param(verbose, int, 0644);
 478 MODULE_PARM_DESC(verbose, "print AFC offset after tuning for debugging the PWM setting");
 479
 480 MODULE_DESCRIPTION("Philips TDA10021 DVB-C demodulator driver");
 481 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Markus Schulz");
 482 MODULE_LICENSE("GPL");
 483
 484 EXPORT_SYMBOL(tda10021_attach);