2 Driver for STV0297 demodulator
4 Copyright (C) 2004 Andrew de Quincey <adq_dvb@lidskialf.net>
5 Copyright (C) 2003-2004 Dennis Noermann <dennis.noermann@noernet.de>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
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.
22 #include <linux/init.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/string.h>
26 #include <linux/delay.h>
27 #include <linux/jiffies.h>
28 #include <linux/slab.h>
30 #include "dvb_frontend.h"
33 struct stv0297_state {
34 struct i2c_adapter *i2c;
35 struct dvb_frontend_ops ops;
36 const struct stv0297_config *config;
37 struct dvb_frontend frontend;
39 unsigned long base_freq;
43 #define dprintk(x...) printk(x)
48 #define STV0297_CLOCK_KHZ 28900
51 static int stv0297_writereg(struct stv0297_state *state, u8 reg, u8 data)
54 u8 buf[] = { reg, data };
55 struct i2c_msg msg = {.addr = state->config->demod_address,.flags = 0,.buf = buf,.len = 2 };
57 ret = i2c_transfer(state->i2c, &msg, 1);
60 dprintk("%s: writereg error (reg == 0x%02x, val == 0x%02x, "
61 "ret == %i)\n", __FUNCTION__, reg, data, ret);
63 return (ret != 1) ? -1 : 0;
66 static int stv0297_readreg(struct stv0297_state *state, u8 reg)
71 struct i2c_msg msg[] = { {.addr = state->config->demod_address,.flags = 0,.buf = b0,.len =
73 {.addr = state->config->demod_address,.flags = I2C_M_RD,.buf = b1,.len = 1}
76 // this device needs a STOP between the register and data
77 if ((ret = i2c_transfer(state->i2c, &msg[0], 1)) != 1) {
78 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __FUNCTION__, reg, ret);
81 if ((ret = i2c_transfer(state->i2c, &msg[1], 1)) != 1) {
82 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __FUNCTION__, reg, ret);
89 static int stv0297_writereg_mask(struct stv0297_state *state, u8 reg, u8 mask, u8 data)
93 val = stv0297_readreg(state, reg);
96 stv0297_writereg(state, reg, val);
101 static int stv0297_readregs(struct stv0297_state *state, u8 reg1, u8 * b, u8 len)
104 struct i2c_msg msg[] = { {.addr = state->config->demod_address,.flags = 0,.buf =
106 {.addr = state->config->demod_address,.flags = I2C_M_RD,.buf = b,.len = len}
109 // this device needs a STOP between the register and data
110 if ((ret = i2c_transfer(state->i2c, &msg[0], 1)) != 1) {
111 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __FUNCTION__, reg1, ret);
114 if ((ret = i2c_transfer(state->i2c, &msg[1], 1)) != 1) {
115 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __FUNCTION__, reg1, ret);
122 static u32 stv0297_get_symbolrate(struct stv0297_state *state)
126 tmp = stv0297_readreg(state, 0x55);
127 tmp |= stv0297_readreg(state, 0x56) << 8;
128 tmp |= stv0297_readreg(state, 0x57) << 16;
129 tmp |= stv0297_readreg(state, 0x58) << 24;
131 tmp *= STV0297_CLOCK_KHZ;
137 static void stv0297_set_symbolrate(struct stv0297_state *state, u32 srate)
141 tmp = 131072L * srate; /* 131072 = 2^17 */
142 tmp = tmp / (STV0297_CLOCK_KHZ / 4); /* 1/4 = 2^-2 */
143 tmp = tmp * 8192L; /* 8192 = 2^13 */
145 stv0297_writereg(state, 0x55, (unsigned char) (tmp & 0xFF));
146 stv0297_writereg(state, 0x56, (unsigned char) (tmp >> 8));
147 stv0297_writereg(state, 0x57, (unsigned char) (tmp >> 16));
148 stv0297_writereg(state, 0x58, (unsigned char) (tmp >> 24));
151 static void stv0297_set_sweeprate(struct stv0297_state *state, short fshift, long symrate)
155 tmp = (long) fshift *262144L; /* 262144 = 2*18 */
157 tmp *= 1024; /* 1024 = 2*10 */
167 stv0297_writereg(state, 0x60, tmp & 0xFF);
168 stv0297_writereg_mask(state, 0x69, 0xF0, (tmp >> 4) & 0xf0);
171 static void stv0297_set_carrieroffset(struct stv0297_state *state, long offset)
175 /* symrate is hardcoded to 10000 */
176 tmp = offset * 26844L; /* (2**28)/10000 */
181 stv0297_writereg(state, 0x66, (unsigned char) (tmp & 0xFF));
182 stv0297_writereg(state, 0x67, (unsigned char) (tmp >> 8));
183 stv0297_writereg(state, 0x68, (unsigned char) (tmp >> 16));
184 stv0297_writereg_mask(state, 0x69, 0x0F, (tmp >> 24) & 0x0f);
188 static long stv0297_get_carrieroffset(struct stv0297_state *state)
192 stv0297_writereg(state, 0x6B, 0x00);
194 tmp = stv0297_readreg(state, 0x66);
195 tmp |= (stv0297_readreg(state, 0x67) << 8);
196 tmp |= (stv0297_readreg(state, 0x68) << 16);
197 tmp |= (stv0297_readreg(state, 0x69) & 0x0F) << 24;
199 tmp *= stv0297_get_symbolrate(state);
206 static void stv0297_set_initialdemodfreq(struct stv0297_state *state, long freq)
211 freq -= STV0297_CLOCK_KHZ;
213 tmp = (STV0297_CLOCK_KHZ * 1000) / (1 << 16);
214 tmp = (freq * 1000) / tmp;
218 stv0297_writereg_mask(state, 0x25, 0x80, 0x80);
219 stv0297_writereg(state, 0x21, tmp >> 8);
220 stv0297_writereg(state, 0x20, tmp);
223 static int stv0297_set_qam(struct stv0297_state *state, fe_modulation_t modulation)
227 switch (modulation) {
252 stv0297_writereg_mask(state, 0x00, 0x70, val << 4);
257 static int stv0297_set_inversion(struct stv0297_state *state, fe_spectral_inversion_t inversion)
274 stv0297_writereg_mask(state, 0x83, 0x08, val << 3);
279 int stv0297_enable_plli2c(struct dvb_frontend *fe)
281 struct stv0297_state *state = fe->demodulator_priv;
283 stv0297_writereg(state, 0x87, 0x78);
284 stv0297_writereg(state, 0x86, 0xc8);
289 static int stv0297_init(struct dvb_frontend *fe)
291 struct stv0297_state *state = fe->demodulator_priv;
294 /* load init table */
295 for (i=0; !(state->config->inittab[i] == 0xff && state->config->inittab[i+1] == 0xff); i+=2)
296 stv0297_writereg(state, state->config->inittab[i], state->config->inittab[i+1]);
299 if (state->config->pll_init)
300 state->config->pll_init(fe);
305 static int stv0297_sleep(struct dvb_frontend *fe)
307 struct stv0297_state *state = fe->demodulator_priv;
309 stv0297_writereg_mask(state, 0x80, 1, 1);
314 static int stv0297_read_status(struct dvb_frontend *fe, fe_status_t * status)
316 struct stv0297_state *state = fe->demodulator_priv;
318 u8 sync = stv0297_readreg(state, 0xDF);
323 FE_HAS_SYNC | FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_LOCK;
327 static int stv0297_read_ber(struct dvb_frontend *fe, u32 * ber)
329 struct stv0297_state *state = fe->demodulator_priv;
332 stv0297_writereg(state, 0xA0, 0x80); // Start Counting bit errors for 4096 Bytes
333 mdelay(25); // Hopefully got 4096 Bytes
334 stv0297_readregs(state, 0xA0, BER, 3);
336 *ber = (BER[2] << 8 | BER[1]) / (8 * 4096);
342 static int stv0297_read_signal_strength(struct dvb_frontend *fe, u16 * strength)
344 struct stv0297_state *state = fe->demodulator_priv;
347 stv0297_readregs(state, 0x41, STRENGTH, 2);
348 *strength = (STRENGTH[1] & 0x03) << 8 | STRENGTH[0];
353 static int stv0297_read_snr(struct dvb_frontend *fe, u16 * snr)
355 struct stv0297_state *state = fe->demodulator_priv;
358 stv0297_readregs(state, 0x07, SNR, 2);
359 *snr = SNR[1] << 8 | SNR[0];
364 static int stv0297_read_ucblocks(struct dvb_frontend *fe, u32 * ucblocks)
366 struct stv0297_state *state = fe->demodulator_priv;
368 *ucblocks = (stv0297_readreg(state, 0xD5) << 8)
369 | stv0297_readreg(state, 0xD4);
374 static int stv0297_set_frontend(struct dvb_frontend *fe, struct dvb_frontend_parameters *p)
376 struct stv0297_state *state = fe->demodulator_priv;
383 unsigned long starttime;
384 unsigned long timeout;
385 fe_spectral_inversion_t inversion;
387 switch (p->u.qam.modulation) {
409 // determine inversion dependant parameters
410 inversion = p->inversion;
411 if (state->config->invert)
412 inversion = (inversion == INVERSION_ON) ? INVERSION_OFF : INVERSION_ON;
413 carrieroffset = -330;
419 sweeprate = -sweeprate;
420 carrieroffset = -carrieroffset;
428 state->config->pll_set(fe, p);
430 /* clear software interrupts */
431 stv0297_writereg(state, 0x82, 0x0);
433 /* set initial demodulation frequency */
434 stv0297_set_initialdemodfreq(state, 7250);
437 stv0297_writereg_mask(state, 0x43, 0x10, 0x00);
438 stv0297_writereg(state, 0x41, 0x00);
439 stv0297_writereg_mask(state, 0x42, 0x03, 0x01);
440 stv0297_writereg_mask(state, 0x36, 0x60, 0x00);
441 stv0297_writereg_mask(state, 0x36, 0x18, 0x00);
442 stv0297_writereg_mask(state, 0x71, 0x80, 0x80);
443 stv0297_writereg(state, 0x72, 0x00);
444 stv0297_writereg(state, 0x73, 0x00);
445 stv0297_writereg_mask(state, 0x74, 0x0F, 0x00);
446 stv0297_writereg_mask(state, 0x43, 0x08, 0x00);
447 stv0297_writereg_mask(state, 0x71, 0x80, 0x00);
450 stv0297_writereg_mask(state, 0x5a, 0x20, 0x20);
451 stv0297_writereg_mask(state, 0x5b, 0x02, 0x02);
452 stv0297_writereg_mask(state, 0x5b, 0x02, 0x00);
453 stv0297_writereg_mask(state, 0x5b, 0x01, 0x00);
454 stv0297_writereg_mask(state, 0x5a, 0x40, 0x40);
456 /* disable frequency sweep */
457 stv0297_writereg_mask(state, 0x6a, 0x01, 0x00);
459 /* reset deinterleaver */
460 stv0297_writereg_mask(state, 0x81, 0x01, 0x01);
461 stv0297_writereg_mask(state, 0x81, 0x01, 0x00);
464 stv0297_writereg_mask(state, 0x83, 0x20, 0x20);
465 stv0297_writereg_mask(state, 0x83, 0x20, 0x00);
467 /* reset equaliser */
468 u_threshold = stv0297_readreg(state, 0x00) & 0xf;
469 initial_u = stv0297_readreg(state, 0x01) >> 4;
470 blind_u = stv0297_readreg(state, 0x01) & 0xf;
471 stv0297_writereg_mask(state, 0x84, 0x01, 0x01);
472 stv0297_writereg_mask(state, 0x84, 0x01, 0x00);
473 stv0297_writereg_mask(state, 0x00, 0x0f, u_threshold);
474 stv0297_writereg_mask(state, 0x01, 0xf0, initial_u << 4);
475 stv0297_writereg_mask(state, 0x01, 0x0f, blind_u);
477 /* data comes from internal A/D */
478 stv0297_writereg_mask(state, 0x87, 0x80, 0x00);
480 /* clear phase registers */
481 stv0297_writereg(state, 0x63, 0x00);
482 stv0297_writereg(state, 0x64, 0x00);
483 stv0297_writereg(state, 0x65, 0x00);
484 stv0297_writereg(state, 0x66, 0x00);
485 stv0297_writereg(state, 0x67, 0x00);
486 stv0297_writereg(state, 0x68, 0x00);
487 stv0297_writereg_mask(state, 0x69, 0x0f, 0x00);
490 stv0297_set_qam(state, p->u.qam.modulation);
491 stv0297_set_symbolrate(state, p->u.qam.symbol_rate / 1000);
492 stv0297_set_sweeprate(state, sweeprate, p->u.qam.symbol_rate / 1000);
493 stv0297_set_carrieroffset(state, carrieroffset);
494 stv0297_set_inversion(state, inversion);
497 /* Disable corner detection for higher QAMs */
498 if (p->u.qam.modulation == QAM_128 ||
499 p->u.qam.modulation == QAM_256)
500 stv0297_writereg_mask(state, 0x88, 0x08, 0x00);
502 stv0297_writereg_mask(state, 0x88, 0x08, 0x08);
504 stv0297_writereg_mask(state, 0x5a, 0x20, 0x00);
505 stv0297_writereg_mask(state, 0x6a, 0x01, 0x01);
506 stv0297_writereg_mask(state, 0x43, 0x40, 0x40);
507 stv0297_writereg_mask(state, 0x5b, 0x30, 0x00);
508 stv0297_writereg_mask(state, 0x03, 0x0c, 0x0c);
509 stv0297_writereg_mask(state, 0x03, 0x03, 0x03);
510 stv0297_writereg_mask(state, 0x43, 0x10, 0x10);
512 /* wait for WGAGC lock */
514 timeout = jiffies + msecs_to_jiffies(2000);
515 while (time_before(jiffies, timeout)) {
517 if (stv0297_readreg(state, 0x43) & 0x08)
520 if (time_after(jiffies, timeout)) {
525 /* wait for equaliser partial convergence */
526 timeout = jiffies + msecs_to_jiffies(500);
527 while (time_before(jiffies, timeout)) {
530 if (stv0297_readreg(state, 0x82) & 0x04) {
534 if (time_after(jiffies, timeout)) {
538 /* wait for equaliser full convergence */
539 timeout = jiffies + msecs_to_jiffies(delay);
540 while (time_before(jiffies, timeout)) {
543 if (stv0297_readreg(state, 0x82) & 0x08) {
547 if (time_after(jiffies, timeout)) {
552 stv0297_writereg_mask(state, 0x6a, 1, 0);
553 stv0297_writereg_mask(state, 0x88, 8, 0);
555 /* wait for main lock */
556 timeout = jiffies + msecs_to_jiffies(20);
557 while (time_before(jiffies, timeout)) {
560 if (stv0297_readreg(state, 0xDF) & 0x80) {
564 if (time_after(jiffies, timeout)) {
569 /* is it still locked after that delay? */
570 if (!(stv0297_readreg(state, 0xDF) & 0x80)) {
575 stv0297_writereg_mask(state, 0x5a, 0x40, 0x00);
576 state->base_freq = p->frequency;
580 stv0297_writereg_mask(state, 0x6a, 0x01, 0x00);
584 static int stv0297_get_frontend(struct dvb_frontend *fe, struct dvb_frontend_parameters *p)
586 struct stv0297_state *state = fe->demodulator_priv;
589 reg_00 = stv0297_readreg(state, 0x00);
590 reg_83 = stv0297_readreg(state, 0x83);
592 p->frequency = state->base_freq;
593 p->inversion = (reg_83 & 0x08) ? INVERSION_ON : INVERSION_OFF;
594 if (state->config->invert)
595 p->inversion = (p->inversion == INVERSION_ON) ? INVERSION_OFF : INVERSION_ON;
596 p->u.qam.symbol_rate = stv0297_get_symbolrate(state) * 1000;
597 p->u.qam.fec_inner = FEC_NONE;
599 switch ((reg_00 >> 4) & 0x7) {
601 p->u.qam.modulation = QAM_16;
604 p->u.qam.modulation = QAM_32;
607 p->u.qam.modulation = QAM_128;
610 p->u.qam.modulation = QAM_256;
613 p->u.qam.modulation = QAM_64;
620 static void stv0297_release(struct dvb_frontend *fe)
622 struct stv0297_state *state = fe->demodulator_priv;
626 static struct dvb_frontend_ops stv0297_ops;
628 struct dvb_frontend *stv0297_attach(const struct stv0297_config *config,
629 struct i2c_adapter *i2c)
631 struct stv0297_state *state = NULL;
633 /* allocate memory for the internal state */
634 state = kmalloc(sizeof(struct stv0297_state), GFP_KERNEL);
638 /* setup the state */
639 state->config = config;
641 memcpy(&state->ops, &stv0297_ops, sizeof(struct dvb_frontend_ops));
642 state->base_freq = 0;
644 /* check if the demod is there */
645 if ((stv0297_readreg(state, 0x80) & 0x70) != 0x20)
648 /* create dvb_frontend */
649 state->frontend.ops = &state->ops;
650 state->frontend.demodulator_priv = state;
651 return &state->frontend;
658 static struct dvb_frontend_ops stv0297_ops = {
661 .name = "ST STV0297 DVB-C",
663 .frequency_min = 64000000,
664 .frequency_max = 1300000000,
665 .frequency_stepsize = 62500,
666 .symbol_rate_min = 870000,
667 .symbol_rate_max = 11700000,
668 .caps = FE_CAN_QAM_16 | FE_CAN_QAM_32 | FE_CAN_QAM_64 |
669 FE_CAN_QAM_128 | FE_CAN_QAM_256 | FE_CAN_FEC_AUTO},
671 .release = stv0297_release,
673 .init = stv0297_init,
674 .sleep = stv0297_sleep,
676 .set_frontend = stv0297_set_frontend,
677 .get_frontend = stv0297_get_frontend,
679 .read_status = stv0297_read_status,
680 .read_ber = stv0297_read_ber,
681 .read_signal_strength = stv0297_read_signal_strength,
682 .read_snr = stv0297_read_snr,
683 .read_ucblocks = stv0297_read_ucblocks,
686 MODULE_DESCRIPTION("ST STV0297 DVB-C Demodulator driver");
687 MODULE_AUTHOR("Dennis Noermann and Andrew de Quincey");
688 MODULE_LICENSE("GPL");
690 EXPORT_SYMBOL(stv0297_attach);
691 EXPORT_SYMBOL(stv0297_enable_plli2c);