err.no Git - linux-2.6/blob - drivers/media/dvb/frontends/zl10353.c

   1 /*
   2  * Driver for Zarlink DVB-T ZL10353 demodulator
   3  *
   4  * Copyright (C) 2006, 2007 Christopher Pascoe <c.pascoe@itee.uq.edu.au>
   5  *
   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.
  10  *
  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  *
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 #include <linux/kernel.h>
  23 #include <linux/module.h>
  24 #include <linux/init.h>
  25 #include <linux/delay.h>
  26 #include <linux/string.h>
  27 #include <linux/slab.h>
  28 #include <asm/div64.h>
  29
  30 #include "dvb_frontend.h"
  31 #include "zl10353_priv.h"
  32 #include "zl10353.h"
  33
  34 struct zl10353_state {
  35         struct i2c_adapter *i2c;
  36         struct dvb_frontend frontend;
  37
  38         struct zl10353_config config;
  39 };
  40
  41 static int debug;
  42 #define dprintk(args...) \
  43         do { \
  44                 if (debug) printk(KERN_DEBUG "zl10353: " args); \
  45         } while (0)
  46
  47 static int debug_regs = 0;
  48
  49 static int zl10353_single_write(struct dvb_frontend *fe, u8 reg, u8 val)
  50 {
  51         struct zl10353_state *state = fe->demodulator_priv;
  52         u8 buf[2] = { reg, val };
  53         struct i2c_msg msg = { .addr = state->config.demod_address, .flags = 0,
  54                                .buf = buf, .len = 2 };
  55         int err = i2c_transfer(state->i2c, &msg, 1);
  56         if (err != 1) {
  57                 printk("zl10353: write to reg %x failed (err = %d)!\n", reg, err);
  58                 return err;
  59         }
  60         return 0;
  61 }
  62
  63 static int zl10353_write(struct dvb_frontend *fe, u8 *ibuf, int ilen)
  64 {
  65         int err, i;
  66         for (i = 0; i < ilen - 1; i++)
  67                 if ((err = zl10353_single_write(fe, ibuf[0] + i, ibuf[i + 1])))
  68                         return err;
  69
  70         return 0;
  71 }
  72
  73 static int zl10353_read_register(struct zl10353_state *state, u8 reg)
  74 {
  75         int ret;
  76         u8 b0[1] = { reg };
  77         u8 b1[1] = { 0 };
  78         struct i2c_msg msg[2] = { { .addr = state->config.demod_address,
  79                                     .flags = 0,
  80                                     .buf = b0, .len = 1 },
  81                                   { .addr = state->config.demod_address,
  82                                     .flags = I2C_M_RD,
  83                                     .buf = b1, .len = 1 } };
  84
  85         ret = i2c_transfer(state->i2c, msg, 2);
  86
  87         if (ret != 2) {
  88                 printk("%s: readreg error (reg=%d, ret==%i)\n",
  89                        __FUNCTION__, reg, ret);
  90                 return ret;
  91         }
  92
  93         return b1[0];
  94 }
  95
  96 static void zl10353_dump_regs(struct dvb_frontend *fe)
  97 {
  98         struct zl10353_state *state = fe->demodulator_priv;
  99         char buf[52], buf2[4];
 100         int ret;
 101         u8 reg;
 102
 103         /* Dump all registers. */
 104         for (reg = 0; ; reg++) {
 105                 if (reg % 16 == 0) {
 106                         if (reg)
 107                                 printk(KERN_DEBUG "%s\n", buf);
 108                         sprintf(buf, "%02x: ", reg);
 109                 }
 110                 ret = zl10353_read_register(state, reg);
 111                 if (ret >= 0)
 112                         sprintf(buf2, "%02x ", (u8)ret);
 113                 else
 114                         strcpy(buf2, "-- ");
 115                 strcat(buf, buf2);
 116                 if (reg == 0xff)
 117                         break;
 118         }
 119         printk(KERN_DEBUG "%s\n", buf);
 120 }
 121
 122 static void zl10353_calc_nominal_rate(struct dvb_frontend *fe,
 123                                       enum fe_bandwidth bandwidth,
 124                                       u16 *nominal_rate)
 125 {
 126         u32 adc_clock = 45056; /* 45.056 MHz */
 127         u8 bw;
 128         struct zl10353_state *state = fe->demodulator_priv;
 129
 130         if (state->config.adc_clock)
 131                 adc_clock = state->config.adc_clock;
 132
 133         switch (bandwidth) {
 134         case BANDWIDTH_6_MHZ:
 135                 bw = 6;
 136                 break;
 137         case BANDWIDTH_7_MHZ:
 138                 bw = 7;
 139                 break;
 140         case BANDWIDTH_8_MHZ:
 141         default:
 142                 bw = 8;
 143                 break;
 144         }
 145
 146         *nominal_rate = (bw * (1 << 23) / 7 * 125 + adc_clock / 2) / adc_clock;
 147
 148         dprintk("%s: bw %d, adc_clock %d => 0x%x\n",
 149                 __FUNCTION__, bw, adc_clock, *nominal_rate);
 150 }
 151
 152 static void zl10353_calc_input_freq(struct dvb_frontend *fe,
 153                                     u16 *input_freq)
 154 {
 155         struct zl10353_state *state = fe->demodulator_priv;
 156         u32 adc_clock = 45056;  /* 45.056 MHz */
 157         int if2 = 36167;        /* 36.167 MHz */
 158         int ife;
 159         u64 value;
 160
 161         if (state->config.adc_clock)
 162                 adc_clock = state->config.adc_clock;
 163         if (state->config.if2)
 164                 if2 = state->config.if2;
 165
 166         if (adc_clock >= if2 * 2)
 167                 ife = if2;
 168         else {
 169                 ife = adc_clock - (if2 % adc_clock);
 170                 if (ife > adc_clock / 2)
 171                         ife = adc_clock - ife;
 172         }
 173         value = 65536ULL * ife + adc_clock / 2;
 174         do_div(value, adc_clock);
 175         *input_freq = -value;
 176
 177         dprintk("%s: if2 %d, ife %d, adc_clock %d => %d / 0x%x\n",
 178                 __FUNCTION__, if2, ife, adc_clock, -(int)value, *input_freq);
 179 }
 180
 181 static int zl10353_sleep(struct dvb_frontend *fe)
 182 {
 183         static u8 zl10353_softdown[] = { 0x50, 0x0C, 0x44 };
 184
 185         zl10353_write(fe, zl10353_softdown, sizeof(zl10353_softdown));
 186         return 0;
 187 }
 188
 189 static int zl10353_set_parameters(struct dvb_frontend *fe,
 190                                   struct dvb_frontend_parameters *param)
 191 {
 192         struct zl10353_state *state = fe->demodulator_priv;
 193         u16 nominal_rate, input_freq;
 194         u8 pllbuf[6] = { 0x67 };
 195
 196         /* These settings set "auto-everything" and start the FSM. */
 197         zl10353_single_write(fe, 0x55, 0x80);
 198         udelay(200);
 199         zl10353_single_write(fe, 0xEA, 0x01);
 200         udelay(200);
 201         zl10353_single_write(fe, 0xEA, 0x00);
 202
 203         zl10353_single_write(fe, 0x56, 0x28);
 204         zl10353_single_write(fe, 0x89, 0x20);
 205         zl10353_single_write(fe, 0x5E, 0x00);
 206
 207         zl10353_calc_nominal_rate(fe, param->u.ofdm.bandwidth, &nominal_rate);
 208         zl10353_single_write(fe, TRL_NOMINAL_RATE_1, msb(nominal_rate));
 209         zl10353_single_write(fe, TRL_NOMINAL_RATE_0, lsb(nominal_rate));
 210
 211         zl10353_calc_input_freq(fe, &input_freq);
 212         zl10353_single_write(fe, INPUT_FREQ_1, msb(input_freq));
 213         zl10353_single_write(fe, INPUT_FREQ_0, lsb(input_freq));
 214
 215         if (fe->ops.i2c_gate_ctrl)
 216                 fe->ops.i2c_gate_ctrl(fe, 0);
 217
 218         /*
 219          * If there is no tuner attached to the secondary I2C bus, we call
 220          * set_params to program a potential tuner attached somewhere else.
 221          * Otherwise, we update the PLL registers via calc_regs.
 222          */
 223         if (state->config.no_tuner) {
 224                 if (fe->ops.tuner_ops.set_params) {
 225                         fe->ops.tuner_ops.set_params(fe, param);
 226                         if (fe->ops.i2c_gate_ctrl)
 227                                 fe->ops.i2c_gate_ctrl(fe, 0);
 228                 }
 229         } else if (fe->ops.tuner_ops.calc_regs) {
 230                 fe->ops.tuner_ops.calc_regs(fe, param, pllbuf + 1, 5);
 231                 pllbuf[1] <<= 1;
 232                 zl10353_write(fe, pllbuf, sizeof(pllbuf));
 233         }
 234
 235         zl10353_single_write(fe, 0x5F, 0x13);
 236
 237         /* If no attached tuner or invalid PLL registers, just start the FSM. */
 238         if (state->config.no_tuner || fe->ops.tuner_ops.calc_regs == NULL)
 239                 zl10353_single_write(fe, FSM_GO, 0x01);
 240         else
 241                 zl10353_single_write(fe, TUNER_GO, 0x01);
 242
 243         udelay(250);
 244         zl10353_single_write(fe, 0xE4, 0x00);
 245         zl10353_single_write(fe, 0xE5, 0x2A);
 246         zl10353_single_write(fe, 0xE9, 0x02);
 247         zl10353_single_write(fe, 0xE7, 0x40);
 248         zl10353_single_write(fe, 0xE8, 0x10);
 249
 250         return 0;
 251 }
 252
 253 static int zl10353_read_status(struct dvb_frontend *fe, fe_status_t *status)
 254 {
 255         struct zl10353_state *state = fe->demodulator_priv;
 256         int s6, s7, s8;
 257
 258         if ((s6 = zl10353_read_register(state, STATUS_6)) < 0)
 259                 return -EREMOTEIO;
 260         if ((s7 = zl10353_read_register(state, STATUS_7)) < 0)
 261                 return -EREMOTEIO;
 262         if ((s8 = zl10353_read_register(state, STATUS_8)) < 0)
 263                 return -EREMOTEIO;
 264
 265         *status = 0;
 266         if (s6 & (1 << 2))
 267                 *status |= FE_HAS_CARRIER;
 268         if (s6 & (1 << 1))
 269                 *status |= FE_HAS_VITERBI;
 270         if (s6 & (1 << 5))
 271                 *status |= FE_HAS_LOCK;
 272         if (s7 & (1 << 4))
 273                 *status |= FE_HAS_SYNC;
 274         if (s8 & (1 << 6))
 275                 *status |= FE_HAS_SIGNAL;
 276
 277         if ((*status & (FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_SYNC)) !=
 278             (FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_SYNC))
 279                 *status &= ~FE_HAS_LOCK;
 280
 281         return 0;
 282 }
 283
 284 static int zl10353_read_ber(struct dvb_frontend *fe, u32 *ber)
 285 {
 286         struct zl10353_state *state = fe->demodulator_priv;
 287
 288         *ber = zl10353_read_register(state, RS_ERR_CNT_2) << 16 |
 289                zl10353_read_register(state, RS_ERR_CNT_1) << 8 |
 290                zl10353_read_register(state, RS_ERR_CNT_0);
 291
 292         return 0;
 293 }
 294
 295 static int zl10353_read_signal_strength(struct dvb_frontend *fe, u16 *strength)
 296 {
 297         struct zl10353_state *state = fe->demodulator_priv;
 298
 299         u16 signal = zl10353_read_register(state, AGC_GAIN_1) << 10 |
 300                      zl10353_read_register(state, AGC_GAIN_0) << 2 | 3;
 301
 302         *strength = ~signal;
 303
 304         return 0;
 305 }
 306
 307 static int zl10353_read_snr(struct dvb_frontend *fe, u16 *snr)
 308 {
 309         struct zl10353_state *state = fe->demodulator_priv;
 310         u8 _snr;
 311
 312         if (debug_regs)
 313                 zl10353_dump_regs(fe);
 314
 315         _snr = zl10353_read_register(state, SNR);
 316         *snr = (_snr << 8) | _snr;
 317
 318         return 0;
 319 }
 320
 321 static int zl10353_read_ucblocks(struct dvb_frontend *fe, u32 *ucblocks)
 322 {
 323         struct zl10353_state *state = fe->demodulator_priv;
 324
 325         *ucblocks = zl10353_read_register(state, RS_UBC_1) << 8 |
 326                     zl10353_read_register(state, RS_UBC_0);
 327
 328         return 0;
 329 }
 330
 331 static int zl10353_get_tune_settings(struct dvb_frontend *fe,
 332                                      struct dvb_frontend_tune_settings
 333                                          *fe_tune_settings)
 334 {
 335         fe_tune_settings->min_delay_ms = 1000;
 336         fe_tune_settings->step_size = 0;
 337         fe_tune_settings->max_drift = 0;
 338
 339         return 0;
 340 }
 341
 342 static int zl10353_init(struct dvb_frontend *fe)
 343 {
 344         struct zl10353_state *state = fe->demodulator_priv;
 345         u8 zl10353_reset_attach[6] = { 0x50, 0x03, 0x64, 0x46, 0x15, 0x0F };
 346         int rc = 0;
 347
 348         if (debug_regs)
 349                 zl10353_dump_regs(fe);
 350         if (state->config.parallel_ts)
 351                 zl10353_reset_attach[2] &= ~0x20;
 352
 353         /* Do a "hard" reset if not already done */
 354         if (zl10353_read_register(state, 0x50) != zl10353_reset_attach[1] ||
 355             zl10353_read_register(state, 0x51) != zl10353_reset_attach[2]) {
 356                 rc = zl10353_write(fe, zl10353_reset_attach,
 357                                    sizeof(zl10353_reset_attach));
 358                 if (debug_regs)
 359                         zl10353_dump_regs(fe);
 360         }
 361
 362         return 0;
 363 }
 364
 365 static int zl10353_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
 366 {
 367         u8 val = 0x0a;
 368
 369         if (enable)
 370                 val |= 0x10;
 371
 372         return zl10353_single_write(fe, 0x62, val);
 373 }
 374
 375 static void zl10353_release(struct dvb_frontend *fe)
 376 {
 377         struct zl10353_state *state = fe->demodulator_priv;
 378         kfree(state);
 379 }
 380
 381 static struct dvb_frontend_ops zl10353_ops;
 382
 383 struct dvb_frontend *zl10353_attach(const struct zl10353_config *config,
 384                                     struct i2c_adapter *i2c)
 385 {
 386         struct zl10353_state *state = NULL;
 387
 388         /* allocate memory for the internal state */
 389         state = kzalloc(sizeof(struct zl10353_state), GFP_KERNEL);
 390         if (state == NULL)
 391                 goto error;
 392
 393         /* setup the state */
 394         state->i2c = i2c;
 395         memcpy(&state->config, config, sizeof(struct zl10353_config));
 396
 397         /* check if the demod is there */
 398         if (zl10353_read_register(state, CHIP_ID) != ID_ZL10353)
 399                 goto error;
 400
 401         /* create dvb_frontend */
 402         memcpy(&state->frontend.ops, &zl10353_ops, sizeof(struct dvb_frontend_ops));
 403         state->frontend.demodulator_priv = state;
 404
 405         return &state->frontend;
 406 error:
 407         kfree(state);
 408         return NULL;
 409 }
 410
 411 static struct dvb_frontend_ops zl10353_ops = {
 412
 413         .info = {
 414                 .name                   = "Zarlink ZL10353 DVB-T",
 415                 .type                   = FE_OFDM,
 416                 .frequency_min          = 174000000,
 417                 .frequency_max          = 862000000,
 418                 .frequency_stepsize     = 166667,
 419                 .frequency_tolerance    = 0,
 420                 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 |
 421                         FE_CAN_FEC_3_4 | FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
 422                         FE_CAN_FEC_AUTO |
 423                         FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 | FE_CAN_QAM_AUTO |
 424                         FE_CAN_TRANSMISSION_MODE_AUTO | FE_CAN_GUARD_INTERVAL_AUTO |
 425                         FE_CAN_HIERARCHY_AUTO | FE_CAN_RECOVER |
 426                         FE_CAN_MUTE_TS
 427         },
 428
 429         .release = zl10353_release,
 430
 431         .init = zl10353_init,
 432         .sleep = zl10353_sleep,
 433         .i2c_gate_ctrl = zl10353_i2c_gate_ctrl,
 434         .write = zl10353_write,
 435
 436         .set_frontend = zl10353_set_parameters,
 437         .get_tune_settings = zl10353_get_tune_settings,
 438
 439         .read_status = zl10353_read_status,
 440         .read_ber = zl10353_read_ber,
 441         .read_signal_strength = zl10353_read_signal_strength,
 442         .read_snr = zl10353_read_snr,
 443         .read_ucblocks = zl10353_read_ucblocks,
 444 };
 445
 446 module_param(debug, int, 0644);
 447 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
 448
 449 module_param(debug_regs, int, 0644);
 450 MODULE_PARM_DESC(debug_regs, "Turn on/off frontend register dumps (default:off).");
 451
 452 MODULE_DESCRIPTION("Zarlink ZL10353 DVB-T demodulator driver");
 453 MODULE_AUTHOR("Chris Pascoe");
 454 MODULE_LICENSE("GPL");
 455
 456 EXPORT_SYMBOL(zl10353_attach);