drivers/media/dvb/frontends/zl10353.c

   1 /*
   2  * Driver for Zarlink DVB-T ZL10353 demodulator
   3  *
   4  * Copyright (C) 2006 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/moduleparam.h>
  25 #include <linux/init.h>
  26 #include <linux/delay.h>
  27 #include <linux/string.h>
  28 #include <linux/slab.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_regs = 0;
  42
  43 static int zl10353_single_write(struct dvb_frontend *fe, u8 reg, u8 val)
  44 {
  45         struct zl10353_state *state = fe->demodulator_priv;
  46         u8 buf[2] = { reg, val };
  47         struct i2c_msg msg = { .addr = state->config.demod_address, .flags = 0,
  48                                .buf = buf, .len = 2 };
  49         int err = i2c_transfer(state->i2c, &msg, 1);
  50         if (err != 1) {
  51                 printk("zl10353: write to reg %x failed (err = %d)!\n", reg, err);
  52                 return err;
  53         }
  54         return 0;
  55 }
  56
  57 int zl10353_write(struct dvb_frontend *fe, u8 *ibuf, int ilen)
  58 {
  59         int err, i;
  60         for (i = 0; i < ilen - 1; i++)
  61                 if ((err = zl10353_single_write(fe, ibuf[0] + i, ibuf[i + 1])))
  62                         return err;
  63
  64         return 0;
  65 }
  66
  67 static int zl10353_read_register(struct zl10353_state *state, u8 reg)
  68 {
  69         int ret;
  70         u8 b0[1] = { reg };
  71         u8 b1[1] = { 0 };
  72         struct i2c_msg msg[2] = { { .addr = state->config.demod_address,
  73                                     .flags = 0,
  74                                     .buf = b0, .len = 1 },
  75                                   { .addr = state->config.demod_address,
  76                                     .flags = I2C_M_RD,
  77                                     .buf = b1, .len = 1 } };
  78
  79         ret = i2c_transfer(state->i2c, msg, 2);
  80
  81         if (ret != 2) {
  82                 printk("%s: readreg error (reg=%d, ret==%i)\n",
  83                        __FUNCTION__, reg, ret);
  84                 return ret;
  85         }
  86
  87         return b1[0];
  88 }
  89
  90 static void zl10353_dump_regs(struct dvb_frontend *fe)
  91 {
  92         struct zl10353_state *state = fe->demodulator_priv;
  93         char buf[52], buf2[4];
  94         int ret;
  95         u8 reg;
  96
  97         /* Dump all registers. */
  98         for (reg = 0; ; reg++) {
  99                 if (reg % 16 == 0) {
 100                         if (reg)
 101                                 printk(KERN_DEBUG "%s\n", buf);
 102                         sprintf(buf, "%02x: ", reg);
 103                 }
 104                 ret = zl10353_read_register(state, reg);
 105                 if (ret >= 0)
 106                         sprintf(buf2, "%02x ", (u8)ret);
 107                 else
 108                         strcpy(buf2, "-- ");
 109                 strcat(buf, buf2);
 110                 if (reg == 0xff)
 111                         break;
 112         }
 113         printk(KERN_DEBUG "%s\n", buf);
 114 }
 115
 116 static int zl10353_sleep(struct dvb_frontend *fe)
 117 {
 118         static u8 zl10353_softdown[] = { 0x50, 0x0C, 0x44 };
 119
 120         zl10353_write(fe, zl10353_softdown, sizeof(zl10353_softdown));
 121         return 0;
 122 }
 123
 124 static int zl10353_set_parameters(struct dvb_frontend *fe,
 125                                   struct dvb_frontend_parameters *param)
 126 {
 127         struct zl10353_state *state = fe->demodulator_priv;
 128
 129         u8 pllbuf[6] = { 0x67 };
 130
 131         /* These settings set "auto-everything" and start the FSM. */
 132         zl10353_single_write(fe, 0x55, 0x80);
 133         udelay(200);
 134         zl10353_single_write(fe, 0xEA, 0x01);
 135         udelay(200);
 136         zl10353_single_write(fe, 0xEA, 0x00);
 137
 138         zl10353_single_write(fe, 0x56, 0x28);
 139         zl10353_single_write(fe, 0x89, 0x20);
 140         zl10353_single_write(fe, 0x5E, 0x00);
 141         zl10353_single_write(fe, 0x65, 0x5A);
 142         zl10353_single_write(fe, 0x66, 0xE9);
 143         zl10353_single_write(fe, 0x62, 0x0A);
 144
 145         // if there is no attached secondary tuner, we call set_params to program
 146         // a potential tuner attached somewhere else
 147         if (state->config.no_tuner) {
 148                 if (fe->ops.tuner_ops.set_params) {
 149                         fe->ops.tuner_ops.set_params(fe, param);
 150                         if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
 151                 }
 152         }
 153
 154         // if pllbuf is defined, retrieve the settings
 155         if (fe->ops.tuner_ops.calc_regs) {
 156                 fe->ops.tuner_ops.calc_regs(fe, param, pllbuf+1, 5);
 157                 pllbuf[1] <<= 1;
 158         } else {
 159                 // fake pllbuf settings
 160                 pllbuf[1] = 0x61 << 1;
 161                 pllbuf[2] = 0;
 162                 pllbuf[3] = 0;
 163                 pllbuf[3] = 0;
 164                 pllbuf[4] = 0;
 165         }
 166
 167         // there is no call to _just_ start decoding, so we send the pllbuf anyway
 168         // even if there isn't a PLL attached to the secondary bus
 169         zl10353_write(fe, pllbuf, sizeof(pllbuf));
 170
 171         zl10353_single_write(fe, 0x70, 0x01);
 172         udelay(250);
 173         zl10353_single_write(fe, 0xE4, 0x00);
 174         zl10353_single_write(fe, 0xE5, 0x2A);
 175         zl10353_single_write(fe, 0xE9, 0x02);
 176         zl10353_single_write(fe, 0xE7, 0x40);
 177         zl10353_single_write(fe, 0xE8, 0x10);
 178
 179         return 0;
 180 }
 181
 182 static int zl10353_read_status(struct dvb_frontend *fe, fe_status_t *status)
 183 {
 184         struct zl10353_state *state = fe->demodulator_priv;
 185         int s6, s7, s8;
 186
 187         if ((s6 = zl10353_read_register(state, STATUS_6)) < 0)
 188                 return -EREMOTEIO;
 189         if ((s7 = zl10353_read_register(state, STATUS_7)) < 0)
 190                 return -EREMOTEIO;
 191         if ((s8 = zl10353_read_register(state, STATUS_8)) < 0)
 192                 return -EREMOTEIO;
 193
 194         *status = 0;
 195         if (s6 & (1 << 2))
 196                 *status |= FE_HAS_CARRIER;
 197         if (s6 & (1 << 1))
 198                 *status |= FE_HAS_VITERBI;
 199         if (s6 & (1 << 5))
 200                 *status |= FE_HAS_LOCK;
 201         if (s7 & (1 << 4))
 202                 *status |= FE_HAS_SYNC;
 203         if (s8 & (1 << 6))
 204                 *status |= FE_HAS_SIGNAL;
 205
 206         if ((*status & (FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_SYNC)) !=
 207             (FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_SYNC))
 208                 *status &= ~FE_HAS_LOCK;
 209
 210         return 0;
 211 }
 212
 213 static int zl10353_read_snr(struct dvb_frontend *fe, u16 *snr)
 214 {
 215         struct zl10353_state *state = fe->demodulator_priv;
 216         u8 _snr;
 217
 218         if (debug_regs)
 219                 zl10353_dump_regs(fe);
 220
 221         _snr = zl10353_read_register(state, SNR);
 222         *snr = (_snr << 8) | _snr;
 223
 224         return 0;
 225 }
 226
 227 static int zl10353_get_tune_settings(struct dvb_frontend *fe,
 228                                      struct dvb_frontend_tune_settings
 229                                          *fe_tune_settings)
 230 {
 231         fe_tune_settings->min_delay_ms = 1000;
 232         fe_tune_settings->step_size = 0;
 233         fe_tune_settings->max_drift = 0;
 234
 235         return 0;
 236 }
 237
 238 static int zl10353_init(struct dvb_frontend *fe)
 239 {
 240         struct zl10353_state *state = fe->demodulator_priv;
 241         u8 zl10353_reset_attach[6] = { 0x50, 0x03, 0x64, 0x46, 0x15, 0x0F };
 242         int rc = 0;
 243
 244         if (debug_regs)
 245                 zl10353_dump_regs(fe);
 246
 247         /* Do a "hard" reset if not already done */
 248         if (zl10353_read_register(state, 0x50) != 0x03) {
 249                 rc = zl10353_write(fe, zl10353_reset_attach,
 250                                    sizeof(zl10353_reset_attach));
 251                 if (debug_regs)
 252                         zl10353_dump_regs(fe);
 253         }
 254
 255         return 0;
 256 }
 257
 258 static void zl10353_release(struct dvb_frontend *fe)
 259 {
 260         struct zl10353_state *state = fe->demodulator_priv;
 261
 262         kfree(state);
 263 }
 264
 265 static struct dvb_frontend_ops zl10353_ops;
 266
 267 struct dvb_frontend *zl10353_attach(const struct zl10353_config *config,
 268                                     struct i2c_adapter *i2c)
 269 {
 270         struct zl10353_state *state = NULL;
 271
 272         /* allocate memory for the internal state */
 273         state = kzalloc(sizeof(struct zl10353_state), GFP_KERNEL);
 274         if (state == NULL)
 275                 goto error;
 276
 277         /* setup the state */
 278         state->i2c = i2c;
 279         memcpy(&state->config, config, sizeof(struct zl10353_config));
 280
 281         /* check if the demod is there */
 282         if (zl10353_read_register(state, CHIP_ID) != ID_ZL10353)
 283                 goto error;
 284
 285         /* create dvb_frontend */
 286         memcpy(&state->frontend.ops, &zl10353_ops, sizeof(struct dvb_frontend_ops));
 287         state->frontend.demodulator_priv = state;
 288
 289         return &state->frontend;
 290 error:
 291         kfree(state);
 292         return NULL;
 293 }
 294
 295 static struct dvb_frontend_ops zl10353_ops = {
 296
 297         .info = {
 298                 .name                   = "Zarlink ZL10353 DVB-T",
 299                 .type                   = FE_OFDM,
 300                 .frequency_min          = 174000000,
 301                 .frequency_max          = 862000000,
 302                 .frequency_stepsize     = 166667,
 303                 .frequency_tolerance    = 0,
 304                 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 |
 305                         FE_CAN_FEC_3_4 | FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
 306                         FE_CAN_FEC_AUTO |
 307                         FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 | FE_CAN_QAM_AUTO |
 308                         FE_CAN_TRANSMISSION_MODE_AUTO | FE_CAN_GUARD_INTERVAL_AUTO |
 309                         FE_CAN_HIERARCHY_AUTO | FE_CAN_RECOVER |
 310                         FE_CAN_MUTE_TS
 311         },
 312
 313         .release = zl10353_release,
 314
 315         .init = zl10353_init,
 316         .sleep = zl10353_sleep,
 317
 318         .set_frontend = zl10353_set_parameters,
 319         .get_tune_settings = zl10353_get_tune_settings,
 320
 321         .read_status = zl10353_read_status,
 322         .read_snr = zl10353_read_snr,
 323 };
 324
 325 module_param(debug_regs, int, 0644);
 326 MODULE_PARM_DESC(debug_regs, "Turn on/off frontend register dumps (default:off).");
 327
 328 MODULE_DESCRIPTION("Zarlink ZL10353 DVB-T demodulator driver");
 329 MODULE_AUTHOR("Chris Pascoe");
 330 MODULE_LICENSE("GPL");
 331
 332 EXPORT_SYMBOL(zl10353_attach);
 333 EXPORT_SYMBOL(zl10353_write);