drivers/media/dvb/frontends/tda8083.c

   1 /*
   2     Driver for Philips TDA8083 based QPSK Demodulator
   3
   4     Copyright (C) 2001 Convergence Integrated Media GmbH
   5
   6     written by Ralph Metzler <ralph@convergence.de>
   7
   8     adoption to the new DVB frontend API and diagnostic ioctl's
   9     by Holger Waechtler <holger@convergence.de>
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (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     You should have received a copy of the GNU General Public License
  22     along with this program; if not, write to the Free Software
  23     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24
  25 */
  26
  27 #include <linux/init.h>
  28 #include <linux/kernel.h>
  29 #include <linux/module.h>
  30 #include <linux/moduleparam.h>
  31 #include <linux/string.h>
  32 #include <linux/slab.h>
  33 #include <linux/jiffies.h>
  34 #include "dvb_frontend.h"
  35 #include "tda8083.h"
  36
  37
  38 struct tda8083_state {
  39         struct i2c_adapter* i2c;
  40         /* configuration settings */
  41         const struct tda8083_config* config;
  42         struct dvb_frontend frontend;
  43 };
  44
  45 static int debug;
  46 #define dprintk(args...) \
  47         do { \
  48                 if (debug) printk(KERN_DEBUG "tda8083: " args); \
  49         } while (0)
  50
  51
  52 static u8 tda8083_init_tab [] = {
  53         0x04, 0x00, 0x4a, 0x79, 0x04, 0x00, 0xff, 0xea,
  54         0x48, 0x42, 0x79, 0x60, 0x70, 0x52, 0x9a, 0x10,
  55         0x0e, 0x10, 0xf2, 0xa7, 0x93, 0x0b, 0x05, 0xc8,
  56         0x9d, 0x00, 0x42, 0x80, 0x00, 0x60, 0x40, 0x00,
  57         0x00, 0x75, 0x00, 0xe0, 0x00, 0x00, 0x00, 0x00,
  58         0x00, 0x00, 0x00, 0x00
  59 };
  60
  61
  62 static int tda8083_writereg (struct tda8083_state* state, u8 reg, u8 data)
  63 {
  64         int ret;
  65         u8 buf [] = { reg, data };
  66         struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = 2 };
  67
  68         ret = i2c_transfer(state->i2c, &msg, 1);
  69
  70         if (ret != 1)
  71                 dprintk ("%s: writereg error (reg %02x, ret == %i)\n",
  72                         __FUNCTION__, reg, ret);
  73
  74         return (ret != 1) ? -1 : 0;
  75 }
  76
  77 static int tda8083_readregs (struct tda8083_state* state, u8 reg1, u8 *b, u8 len)
  78 {
  79         int ret;
  80         struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = &reg1, .len = 1 },
  81                            { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b, .len = len } };
  82
  83         ret = i2c_transfer(state->i2c, msg, 2);
  84
  85         if (ret != 2)
  86                 dprintk ("%s: readreg error (reg %02x, ret == %i)\n",
  87                         __FUNCTION__, reg1, ret);
  88
  89         return ret == 2 ? 0 : -1;
  90 }
  91
  92 static inline u8 tda8083_readreg (struct tda8083_state* state, u8 reg)
  93 {
  94         u8 val;
  95
  96         tda8083_readregs (state, reg, &val, 1);
  97
  98         return val;
  99 }
 100
 101 static int tda8083_set_inversion (struct tda8083_state* state, fe_spectral_inversion_t inversion)
 102 {
 103         /*  XXX FIXME: implement other modes than FEC_AUTO */
 104         if (inversion == INVERSION_AUTO)
 105                 return 0;
 106
 107         return -EINVAL;
 108 }
 109
 110 static int tda8083_set_fec (struct tda8083_state* state, fe_code_rate_t fec)
 111 {
 112         if (fec == FEC_AUTO)
 113                 return tda8083_writereg (state, 0x07, 0xff);
 114
 115         if (fec >= FEC_1_2 && fec <= FEC_8_9)
 116                 return tda8083_writereg (state, 0x07, 1 << (FEC_8_9 - fec));
 117
 118         return -EINVAL;
 119 }
 120
 121 static fe_code_rate_t tda8083_get_fec (struct tda8083_state* state)
 122 {
 123         u8 index;
 124         static fe_code_rate_t fec_tab [] = { FEC_8_9, FEC_1_2, FEC_2_3, FEC_3_4,
 125                                        FEC_4_5, FEC_5_6, FEC_6_7, FEC_7_8 };
 126
 127         index = tda8083_readreg(state, 0x0e) & 0x07;
 128
 129         return fec_tab [index];
 130 }
 131
 132 static int tda8083_set_symbolrate (struct tda8083_state* state, u32 srate)
 133 {
 134         u32 ratio;
 135         u32 tmp;
 136         u8 filter;
 137
 138         if (srate > 32000000)
 139                 srate = 32000000;
 140         if (srate < 500000)
 141                 srate = 500000;
 142
 143         filter = 0;
 144         if (srate < 24000000)
 145                 filter = 2;
 146         if (srate < 16000000)
 147                 filter = 3;
 148
 149         tmp = 31250 << 16;
 150         ratio = tmp / srate;
 151
 152         tmp = (tmp % srate) << 8;
 153         ratio = (ratio << 8) + tmp / srate;
 154
 155         tmp = (tmp % srate) << 8;
 156         ratio = (ratio << 8) + tmp / srate;
 157
 158         dprintk("tda8083: ratio == %08x\n", (unsigned int) ratio);
 159
 160         tda8083_writereg (state, 0x05, filter);
 161         tda8083_writereg (state, 0x02, (ratio >> 16) & 0xff);
 162         tda8083_writereg (state, 0x03, (ratio >>  8) & 0xff);
 163         tda8083_writereg (state, 0x04, (ratio      ) & 0xff);
 164
 165         tda8083_writereg (state, 0x00, 0x3c);
 166         tda8083_writereg (state, 0x00, 0x04);
 167
 168         return 1;
 169 }
 170
 171 static void tda8083_wait_diseqc_fifo (struct tda8083_state* state, int timeout)
 172 {
 173         unsigned long start = jiffies;
 174
 175         while (jiffies - start < timeout &&
 176                !(tda8083_readreg(state, 0x02) & 0x80))
 177         {
 178                 msleep(50);
 179         };
 180 }
 181
 182 static int tda8083_set_tone (struct tda8083_state* state, fe_sec_tone_mode_t tone)
 183 {
 184         tda8083_writereg (state, 0x26, 0xf1);
 185
 186         switch (tone) {
 187         case SEC_TONE_OFF:
 188                 return tda8083_writereg (state, 0x29, 0x00);
 189         case SEC_TONE_ON:
 190                 return tda8083_writereg (state, 0x29, 0x80);
 191         default:
 192                 return -EINVAL;
 193         };
 194 }
 195
 196 static int tda8083_set_voltage (struct tda8083_state* state, fe_sec_voltage_t voltage)
 197 {
 198         switch (voltage) {
 199         case SEC_VOLTAGE_13:
 200                 return tda8083_writereg (state, 0x20, 0x00);
 201         case SEC_VOLTAGE_18:
 202                 return tda8083_writereg (state, 0x20, 0x11);
 203         default:
 204                 return -EINVAL;
 205         };
 206 }
 207
 208 static int tda8083_send_diseqc_burst (struct tda8083_state* state, fe_sec_mini_cmd_t burst)
 209 {
 210         switch (burst) {
 211         case SEC_MINI_A:
 212                 tda8083_writereg (state, 0x29, (5 << 2));  /* send burst A */
 213                 break;
 214         case SEC_MINI_B:
 215                 tda8083_writereg (state, 0x29, (7 << 2));  /* send B */
 216                 break;
 217         default:
 218                 return -EINVAL;
 219         };
 220
 221         tda8083_wait_diseqc_fifo (state, 100);
 222
 223         return 0;
 224 }
 225
 226 static int tda8083_send_diseqc_msg (struct dvb_frontend* fe,
 227                                     struct dvb_diseqc_master_cmd *m)
 228 {
 229         struct tda8083_state* state = fe->demodulator_priv;
 230         int i;
 231
 232         tda8083_writereg (state, 0x29, (m->msg_len - 3) | (1 << 2)); /* enable */
 233
 234         for (i=0; i<m->msg_len; i++)
 235                 tda8083_writereg (state, 0x23 + i, m->msg[i]);
 236
 237         tda8083_writereg (state, 0x29, (m->msg_len - 3) | (3 << 2)); /* send!! */
 238
 239         tda8083_wait_diseqc_fifo (state, 100);
 240
 241         return 0;
 242 }
 243
 244 static int tda8083_read_status(struct dvb_frontend* fe, fe_status_t* status)
 245 {
 246         struct tda8083_state* state = fe->demodulator_priv;
 247
 248         u8 signal = ~tda8083_readreg (state, 0x01);
 249         u8 sync = tda8083_readreg (state, 0x02);
 250
 251         *status = 0;
 252
 253         if (signal > 10)
 254                 *status |= FE_HAS_SIGNAL;
 255
 256         if (sync & 0x01)
 257                 *status |= FE_HAS_CARRIER;
 258
 259         if (sync & 0x02)
 260                 *status |= FE_HAS_VITERBI;
 261
 262         if (sync & 0x10)
 263                 *status |= FE_HAS_SYNC;
 264
 265         if (sync & 0x20) /* frontend can not lock */
 266                 *status |= FE_TIMEDOUT;
 267
 268         if ((sync & 0x1f) == 0x1f)
 269                 *status |= FE_HAS_LOCK;
 270
 271         return 0;
 272 }
 273
 274 static int tda8083_read_ber(struct dvb_frontend* fe, u32* ber)
 275 {
 276         struct tda8083_state* state = fe->demodulator_priv;
 277         int ret;
 278         u8 buf[3];
 279
 280         if ((ret = tda8083_readregs(state, 0x0b, buf, sizeof(buf))))
 281                 return ret;
 282
 283         *ber = ((buf[0] & 0x1f) << 16) | (buf[1] << 8) | buf[2];
 284
 285         return 0;
 286 }
 287
 288 static int tda8083_read_signal_strength(struct dvb_frontend* fe, u16* strength)
 289 {
 290         struct tda8083_state* state = fe->demodulator_priv;
 291
 292         u8 signal = ~tda8083_readreg (state, 0x01);
 293         *strength = (signal << 8) | signal;
 294
 295         return 0;
 296 }
 297
 298 static int tda8083_read_snr(struct dvb_frontend* fe, u16* snr)
 299 {
 300         struct tda8083_state* state = fe->demodulator_priv;
 301
 302         u8 _snr = tda8083_readreg (state, 0x08);
 303         *snr = (_snr << 8) | _snr;
 304
 305         return 0;
 306 }
 307
 308 static int tda8083_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
 309 {
 310         struct tda8083_state* state = fe->demodulator_priv;
 311
 312         *ucblocks = tda8083_readreg(state, 0x0f);
 313         if (*ucblocks == 0xff)
 314                 *ucblocks = 0xffffffff;
 315
 316         return 0;
 317 }
 318
 319 static int tda8083_set_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters *p)
 320 {
 321         struct tda8083_state* state = fe->demodulator_priv;
 322
 323         if (fe->ops.tuner_ops.set_params) {
 324                 fe->ops.tuner_ops.set_params(fe, p);
 325                 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
 326         }
 327
 328         tda8083_set_inversion (state, p->inversion);
 329         tda8083_set_fec (state, p->u.qpsk.fec_inner);
 330         tda8083_set_symbolrate (state, p->u.qpsk.symbol_rate);
 331
 332         tda8083_writereg (state, 0x00, 0x3c);
 333         tda8083_writereg (state, 0x00, 0x04);
 334
 335         return 0;
 336 }
 337
 338 static int tda8083_get_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters *p)
 339 {
 340         struct tda8083_state* state = fe->demodulator_priv;
 341
 342         /*  FIXME: get symbolrate & frequency offset...*/
 343         /*p->frequency = ???;*/
 344         p->inversion = (tda8083_readreg (state, 0x0e) & 0x80) ?
 345                         INVERSION_ON : INVERSION_OFF;
 346         p->u.qpsk.fec_inner = tda8083_get_fec (state);
 347         /*p->u.qpsk.symbol_rate = tda8083_get_symbolrate (state);*/
 348
 349         return 0;
 350 }
 351
 352 static int tda8083_sleep(struct dvb_frontend* fe)
 353 {
 354         struct tda8083_state* state = fe->demodulator_priv;
 355
 356         tda8083_writereg (state, 0x00, 0x02);
 357         return 0;
 358 }
 359
 360 static int tda8083_init(struct dvb_frontend* fe)
 361 {
 362         struct tda8083_state* state = fe->demodulator_priv;
 363         int i;
 364
 365         for (i=0; i<44; i++)
 366                 tda8083_writereg (state, i, tda8083_init_tab[i]);
 367
 368         tda8083_writereg (state, 0x00, 0x3c);
 369         tda8083_writereg (state, 0x00, 0x04);
 370
 371         return 0;
 372 }
 373
 374 static int tda8083_diseqc_send_burst(struct dvb_frontend* fe, fe_sec_mini_cmd_t burst)
 375 {
 376         struct tda8083_state* state = fe->demodulator_priv;
 377
 378         tda8083_send_diseqc_burst (state, burst);
 379         tda8083_writereg (state, 0x00, 0x3c);
 380         tda8083_writereg (state, 0x00, 0x04);
 381
 382         return 0;
 383 }
 384
 385 static int tda8083_diseqc_set_tone(struct dvb_frontend* fe, fe_sec_tone_mode_t tone)
 386 {
 387         struct tda8083_state* state = fe->demodulator_priv;
 388
 389         tda8083_set_tone (state, tone);
 390         tda8083_writereg (state, 0x00, 0x3c);
 391         tda8083_writereg (state, 0x00, 0x04);
 392
 393         return 0;
 394 }
 395
 396 static int tda8083_diseqc_set_voltage(struct dvb_frontend* fe, fe_sec_voltage_t voltage)
 397 {
 398         struct tda8083_state* state = fe->demodulator_priv;
 399
 400         tda8083_set_voltage (state, voltage);
 401         tda8083_writereg (state, 0x00, 0x3c);
 402         tda8083_writereg (state, 0x00, 0x04);
 403
 404         return 0;
 405 }
 406
 407 static void tda8083_release(struct dvb_frontend* fe)
 408 {
 409         struct tda8083_state* state = fe->demodulator_priv;
 410         kfree(state);
 411 }
 412
 413 static struct dvb_frontend_ops tda8083_ops;
 414
 415 struct dvb_frontend* tda8083_attach(const struct tda8083_config* config,
 416                                     struct i2c_adapter* i2c)
 417 {
 418         struct tda8083_state* state = NULL;
 419
 420         /* allocate memory for the internal state */
 421         state = kmalloc(sizeof(struct tda8083_state), GFP_KERNEL);
 422         if (state == NULL) goto error;
 423
 424         /* setup the state */
 425         state->config = config;
 426         state->i2c = i2c;
 427
 428         /* check if the demod is there */
 429         if ((tda8083_readreg(state, 0x00)) != 0x05) goto error;
 430
 431         /* create dvb_frontend */
 432         memcpy(&state->frontend.ops, &tda8083_ops, sizeof(struct dvb_frontend_ops));
 433         state->frontend.demodulator_priv = state;
 434         return &state->frontend;
 435
 436 error:
 437         kfree(state);
 438         return NULL;
 439 }
 440
 441 static struct dvb_frontend_ops tda8083_ops = {
 442
 443         .info = {
 444                 .name                   = "Philips TDA8083 DVB-S",
 445                 .type                   = FE_QPSK,
 446                 .frequency_min          = 950000,     /* FIXME: guessed! */
 447                 .frequency_max          = 1400000,    /* FIXME: guessed! */
 448                 .frequency_stepsize     = 125,   /* kHz for QPSK frontends */
 449         /*      .frequency_tolerance    = ???,*/
 450                 .symbol_rate_min        = 1000000,   /* FIXME: guessed! */
 451                 .symbol_rate_max        = 45000000,  /* FIXME: guessed! */
 452         /*      .symbol_rate_tolerance  = ???,*/
 453                 .caps = FE_CAN_INVERSION_AUTO |
 454                         FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
 455                         FE_CAN_FEC_4_5 | FE_CAN_FEC_5_6 | FE_CAN_FEC_6_7 |
 456                         FE_CAN_FEC_7_8 | FE_CAN_FEC_8_9 | FE_CAN_FEC_AUTO |
 457                         FE_CAN_QPSK | FE_CAN_MUTE_TS
 458         },
 459
 460         .release = tda8083_release,
 461
 462         .init = tda8083_init,
 463         .sleep = tda8083_sleep,
 464
 465         .set_frontend = tda8083_set_frontend,
 466         .get_frontend = tda8083_get_frontend,
 467
 468         .read_status = tda8083_read_status,
 469         .read_signal_strength = tda8083_read_signal_strength,
 470         .read_snr = tda8083_read_snr,
 471         .read_ber = tda8083_read_ber,
 472         .read_ucblocks = tda8083_read_ucblocks,
 473
 474         .diseqc_send_master_cmd = tda8083_send_diseqc_msg,
 475         .diseqc_send_burst = tda8083_diseqc_send_burst,
 476         .set_tone = tda8083_diseqc_set_tone,
 477         .set_voltage = tda8083_diseqc_set_voltage,
 478 };
 479
 480 module_param(debug, int, 0644);
 481 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
 482
 483 MODULE_DESCRIPTION("Philips TDA8083 DVB-S Demodulator");
 484 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler");
 485 MODULE_LICENSE("GPL");
 486
 487 EXPORT_SYMBOL(tda8083_attach);