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 const struct stv0297_config *config;
36 struct dvb_frontend frontend;
38 unsigned long last_ber;
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, ret == %i)\n",
61 __func__, 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 = 1},
72 {.addr = state->config->demod_address,.flags = I2C_M_RD,.buf = b1,.len = 1}
75 // this device needs a STOP between the register and data
76 if (state->config->stop_during_read) {
77 if ((ret = i2c_transfer(state->i2c, &msg[0], 1)) != 1) {
78 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __func__, reg, ret);
81 if ((ret = i2c_transfer(state->i2c, &msg[1], 1)) != 1) {
82 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __func__, reg, ret);
86 if ((ret = i2c_transfer(state->i2c, msg, 2)) != 2) {
87 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __func__, reg, ret);
95 static int stv0297_writereg_mask(struct stv0297_state *state, u8 reg, u8 mask, u8 data)
99 val = stv0297_readreg(state, reg);
101 val |= (data & mask);
102 stv0297_writereg(state, reg, val);
107 static int stv0297_readregs(struct stv0297_state *state, u8 reg1, u8 * b, u8 len)
110 struct i2c_msg msg[] = { {.addr = state->config->demod_address,.flags = 0,.buf =
112 {.addr = state->config->demod_address,.flags = I2C_M_RD,.buf = b,.len = len}
115 // this device needs a STOP between the register and data
116 if (state->config->stop_during_read) {
117 if ((ret = i2c_transfer(state->i2c, &msg[0], 1)) != 1) {
118 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __func__, reg1, ret);
121 if ((ret = i2c_transfer(state->i2c, &msg[1], 1)) != 1) {
122 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __func__, reg1, ret);
126 if ((ret = i2c_transfer(state->i2c, msg, 2)) != 2) {
127 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n", __func__, reg1, ret);
135 static u32 stv0297_get_symbolrate(struct stv0297_state *state)
139 tmp = (u64)(stv0297_readreg(state, 0x55)
140 | (stv0297_readreg(state, 0x56) << 8)
141 | (stv0297_readreg(state, 0x57) << 16)
142 | (stv0297_readreg(state, 0x58) << 24));
144 tmp *= STV0297_CLOCK_KHZ;
150 static void stv0297_set_symbolrate(struct stv0297_state *state, u32 srate)
154 tmp = 131072L * srate; /* 131072 = 2^17 */
155 tmp = tmp / (STV0297_CLOCK_KHZ / 4); /* 1/4 = 2^-2 */
156 tmp = tmp * 8192L; /* 8192 = 2^13 */
158 stv0297_writereg(state, 0x55, (unsigned char) (tmp & 0xFF));
159 stv0297_writereg(state, 0x56, (unsigned char) (tmp >> 8));
160 stv0297_writereg(state, 0x57, (unsigned char) (tmp >> 16));
161 stv0297_writereg(state, 0x58, (unsigned char) (tmp >> 24));
164 static void stv0297_set_sweeprate(struct stv0297_state *state, short fshift, long symrate)
168 tmp = (long) fshift *262144L; /* 262144 = 2*18 */
170 tmp *= 1024; /* 1024 = 2*10 */
180 stv0297_writereg(state, 0x60, tmp & 0xFF);
181 stv0297_writereg_mask(state, 0x69, 0xF0, (tmp >> 4) & 0xf0);
184 static void stv0297_set_carrieroffset(struct stv0297_state *state, long offset)
188 /* symrate is hardcoded to 10000 */
189 tmp = offset * 26844L; /* (2**28)/10000 */
194 stv0297_writereg(state, 0x66, (unsigned char) (tmp & 0xFF));
195 stv0297_writereg(state, 0x67, (unsigned char) (tmp >> 8));
196 stv0297_writereg(state, 0x68, (unsigned char) (tmp >> 16));
197 stv0297_writereg_mask(state, 0x69, 0x0F, (tmp >> 24) & 0x0f);
201 static long stv0297_get_carrieroffset(struct stv0297_state *state)
205 stv0297_writereg(state, 0x6B, 0x00);
207 tmp = stv0297_readreg(state, 0x66);
208 tmp |= (stv0297_readreg(state, 0x67) << 8);
209 tmp |= (stv0297_readreg(state, 0x68) << 16);
210 tmp |= (stv0297_readreg(state, 0x69) & 0x0F) << 24;
212 tmp *= stv0297_get_symbolrate(state);
219 static void stv0297_set_initialdemodfreq(struct stv0297_state *state, long freq)
224 freq -= STV0297_CLOCK_KHZ;
226 tmp = (STV0297_CLOCK_KHZ * 1000) / (1 << 16);
227 tmp = (freq * 1000) / tmp;
231 stv0297_writereg_mask(state, 0x25, 0x80, 0x80);
232 stv0297_writereg(state, 0x21, tmp >> 8);
233 stv0297_writereg(state, 0x20, tmp);
236 static int stv0297_set_qam(struct stv0297_state *state,
237 enum fe_modulation modulation)
241 switch (modulation) {
266 stv0297_writereg_mask(state, 0x00, 0x70, val << 4);
271 static int stv0297_set_inversion(struct stv0297_state *state,
272 enum fe_spectral_inversion inversion)
289 stv0297_writereg_mask(state, 0x83, 0x08, val << 3);
294 static int stv0297_i2c_gate_ctrl(struct dvb_frontend *fe, int enable)
296 struct stv0297_state *state = fe->demodulator_priv;
299 stv0297_writereg(state, 0x87, 0x78);
300 stv0297_writereg(state, 0x86, 0xc8);
306 static int stv0297_init(struct dvb_frontend *fe)
308 struct stv0297_state *state = fe->demodulator_priv;
311 /* load init table */
312 for (i=0; !(state->config->inittab[i] == 0xff && state->config->inittab[i+1] == 0xff); i+=2)
313 stv0297_writereg(state, state->config->inittab[i], state->config->inittab[i+1]);
321 static int stv0297_sleep(struct dvb_frontend *fe)
323 struct stv0297_state *state = fe->demodulator_priv;
325 stv0297_writereg_mask(state, 0x80, 1, 1);
330 static int stv0297_read_status(struct dvb_frontend *fe,
331 enum fe_status *status)
333 struct stv0297_state *state = fe->demodulator_priv;
335 u8 sync = stv0297_readreg(state, 0xDF);
340 FE_HAS_SYNC | FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_LOCK;
344 static int stv0297_read_ber(struct dvb_frontend *fe, u32 * ber)
346 struct stv0297_state *state = fe->demodulator_priv;
349 stv0297_readregs(state, 0xA0, BER, 3);
350 if (!(BER[0] & 0x80)) {
351 state->last_ber = BER[2] << 8 | BER[1];
352 stv0297_writereg_mask(state, 0xA0, 0x80, 0x80);
355 *ber = state->last_ber;
361 static int stv0297_read_signal_strength(struct dvb_frontend *fe, u16 * strength)
363 struct stv0297_state *state = fe->demodulator_priv;
367 stv0297_readregs(state, 0x41, STRENGTH, 3);
368 tmp = (STRENGTH[1] & 0x03) << 8 | STRENGTH[0];
369 if (STRENGTH[2] & 0x20) {
380 *strength = (tmp << 7) | (tmp >> 2);
384 static int stv0297_read_snr(struct dvb_frontend *fe, u16 * snr)
386 struct stv0297_state *state = fe->demodulator_priv;
389 stv0297_readregs(state, 0x07, SNR, 2);
390 *snr = SNR[1] << 8 | SNR[0];
395 static int stv0297_read_ucblocks(struct dvb_frontend *fe, u32 * ucblocks)
397 struct stv0297_state *state = fe->demodulator_priv;
399 stv0297_writereg_mask(state, 0xDF, 0x03, 0x03); /* freeze the counters */
401 *ucblocks = (stv0297_readreg(state, 0xD5) << 8)
402 | stv0297_readreg(state, 0xD4);
404 stv0297_writereg_mask(state, 0xDF, 0x03, 0x02); /* clear the counters */
405 stv0297_writereg_mask(state, 0xDF, 0x03, 0x01); /* re-enable the counters */
410 static int stv0297_set_frontend(struct dvb_frontend *fe)
412 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
413 struct stv0297_state *state = fe->demodulator_priv;
420 unsigned long timeout;
421 enum fe_spectral_inversion inversion;
423 switch (p->modulation) {
441 // determine inversion dependent parameters
442 inversion = p->inversion;
443 if (state->config->invert)
444 inversion = (inversion == INVERSION_ON) ? INVERSION_OFF : INVERSION_ON;
445 carrieroffset = -330;
451 sweeprate = -sweeprate;
452 carrieroffset = -carrieroffset;
460 if (fe->ops.tuner_ops.set_params) {
461 fe->ops.tuner_ops.set_params(fe);
462 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
465 /* clear software interrupts */
466 stv0297_writereg(state, 0x82, 0x0);
468 /* set initial demodulation frequency */
469 stv0297_set_initialdemodfreq(state, 7250);
472 stv0297_writereg_mask(state, 0x43, 0x10, 0x00);
473 stv0297_writereg(state, 0x41, 0x00);
474 stv0297_writereg_mask(state, 0x42, 0x03, 0x01);
475 stv0297_writereg_mask(state, 0x36, 0x60, 0x00);
476 stv0297_writereg_mask(state, 0x36, 0x18, 0x00);
477 stv0297_writereg_mask(state, 0x71, 0x80, 0x80);
478 stv0297_writereg(state, 0x72, 0x00);
479 stv0297_writereg(state, 0x73, 0x00);
480 stv0297_writereg_mask(state, 0x74, 0x0F, 0x00);
481 stv0297_writereg_mask(state, 0x43, 0x08, 0x00);
482 stv0297_writereg_mask(state, 0x71, 0x80, 0x00);
485 stv0297_writereg_mask(state, 0x5a, 0x20, 0x20);
486 stv0297_writereg_mask(state, 0x5b, 0x02, 0x02);
487 stv0297_writereg_mask(state, 0x5b, 0x02, 0x00);
488 stv0297_writereg_mask(state, 0x5b, 0x01, 0x00);
489 stv0297_writereg_mask(state, 0x5a, 0x40, 0x40);
491 /* disable frequency sweep */
492 stv0297_writereg_mask(state, 0x6a, 0x01, 0x00);
494 /* reset deinterleaver */
495 stv0297_writereg_mask(state, 0x81, 0x01, 0x01);
496 stv0297_writereg_mask(state, 0x81, 0x01, 0x00);
499 stv0297_writereg_mask(state, 0x83, 0x20, 0x20);
500 stv0297_writereg_mask(state, 0x83, 0x20, 0x00);
502 /* reset equaliser */
503 u_threshold = stv0297_readreg(state, 0x00) & 0xf;
504 initial_u = stv0297_readreg(state, 0x01) >> 4;
505 blind_u = stv0297_readreg(state, 0x01) & 0xf;
506 stv0297_writereg_mask(state, 0x84, 0x01, 0x01);
507 stv0297_writereg_mask(state, 0x84, 0x01, 0x00);
508 stv0297_writereg_mask(state, 0x00, 0x0f, u_threshold);
509 stv0297_writereg_mask(state, 0x01, 0xf0, initial_u << 4);
510 stv0297_writereg_mask(state, 0x01, 0x0f, blind_u);
512 /* data comes from internal A/D */
513 stv0297_writereg_mask(state, 0x87, 0x80, 0x00);
515 /* clear phase registers */
516 stv0297_writereg(state, 0x63, 0x00);
517 stv0297_writereg(state, 0x64, 0x00);
518 stv0297_writereg(state, 0x65, 0x00);
519 stv0297_writereg(state, 0x66, 0x00);
520 stv0297_writereg(state, 0x67, 0x00);
521 stv0297_writereg(state, 0x68, 0x00);
522 stv0297_writereg_mask(state, 0x69, 0x0f, 0x00);
525 stv0297_set_qam(state, p->modulation);
526 stv0297_set_symbolrate(state, p->symbol_rate / 1000);
527 stv0297_set_sweeprate(state, sweeprate, p->symbol_rate / 1000);
528 stv0297_set_carrieroffset(state, carrieroffset);
529 stv0297_set_inversion(state, inversion);
532 /* Disable corner detection for higher QAMs */
533 if (p->modulation == QAM_128 ||
534 p->modulation == QAM_256)
535 stv0297_writereg_mask(state, 0x88, 0x08, 0x00);
537 stv0297_writereg_mask(state, 0x88, 0x08, 0x08);
539 stv0297_writereg_mask(state, 0x5a, 0x20, 0x00);
540 stv0297_writereg_mask(state, 0x6a, 0x01, 0x01);
541 stv0297_writereg_mask(state, 0x43, 0x40, 0x40);
542 stv0297_writereg_mask(state, 0x5b, 0x30, 0x00);
543 stv0297_writereg_mask(state, 0x03, 0x0c, 0x0c);
544 stv0297_writereg_mask(state, 0x03, 0x03, 0x03);
545 stv0297_writereg_mask(state, 0x43, 0x10, 0x10);
547 /* wait for WGAGC lock */
548 timeout = jiffies + msecs_to_jiffies(2000);
549 while (time_before(jiffies, timeout)) {
551 if (stv0297_readreg(state, 0x43) & 0x08)
554 if (time_after(jiffies, timeout)) {
559 /* wait for equaliser partial convergence */
560 timeout = jiffies + msecs_to_jiffies(500);
561 while (time_before(jiffies, timeout)) {
564 if (stv0297_readreg(state, 0x82) & 0x04) {
568 if (time_after(jiffies, timeout)) {
572 /* wait for equaliser full convergence */
573 timeout = jiffies + msecs_to_jiffies(delay);
574 while (time_before(jiffies, timeout)) {
577 if (stv0297_readreg(state, 0x82) & 0x08) {
581 if (time_after(jiffies, timeout)) {
586 stv0297_writereg_mask(state, 0x6a, 1, 0);
587 stv0297_writereg_mask(state, 0x88, 8, 0);
589 /* wait for main lock */
590 timeout = jiffies + msecs_to_jiffies(20);
591 while (time_before(jiffies, timeout)) {
594 if (stv0297_readreg(state, 0xDF) & 0x80) {
598 if (time_after(jiffies, timeout)) {
603 /* is it still locked after that delay? */
604 if (!(stv0297_readreg(state, 0xDF) & 0x80)) {
609 stv0297_writereg_mask(state, 0x5a, 0x40, 0x00);
610 state->base_freq = p->frequency;
614 stv0297_writereg_mask(state, 0x6a, 0x01, 0x00);
618 static int stv0297_get_frontend(struct dvb_frontend *fe,
619 struct dtv_frontend_properties *p)
621 struct stv0297_state *state = fe->demodulator_priv;
624 reg_00 = stv0297_readreg(state, 0x00);
625 reg_83 = stv0297_readreg(state, 0x83);
627 p->frequency = state->base_freq;
628 p->inversion = (reg_83 & 0x08) ? INVERSION_ON : INVERSION_OFF;
629 if (state->config->invert)
630 p->inversion = (p->inversion == INVERSION_ON) ? INVERSION_OFF : INVERSION_ON;
631 p->symbol_rate = stv0297_get_symbolrate(state) * 1000;
632 p->fec_inner = FEC_NONE;
634 switch ((reg_00 >> 4) & 0x7) {
636 p->modulation = QAM_16;
639 p->modulation = QAM_32;
642 p->modulation = QAM_128;
645 p->modulation = QAM_256;
648 p->modulation = QAM_64;
655 static void stv0297_release(struct dvb_frontend *fe)
657 struct stv0297_state *state = fe->demodulator_priv;
661 static const struct dvb_frontend_ops stv0297_ops;
663 struct dvb_frontend *stv0297_attach(const struct stv0297_config *config,
664 struct i2c_adapter *i2c)
666 struct stv0297_state *state = NULL;
668 /* allocate memory for the internal state */
669 state = kzalloc(sizeof(struct stv0297_state), GFP_KERNEL);
673 /* setup the state */
674 state->config = config;
677 state->base_freq = 0;
679 /* check if the demod is there */
680 if ((stv0297_readreg(state, 0x80) & 0x70) != 0x20)
683 /* create dvb_frontend */
684 memcpy(&state->frontend.ops, &stv0297_ops, sizeof(struct dvb_frontend_ops));
685 state->frontend.demodulator_priv = state;
686 return &state->frontend;
693 static const struct dvb_frontend_ops stv0297_ops = {
694 .delsys = { SYS_DVBC_ANNEX_A },
696 .name = "ST STV0297 DVB-C",
697 .frequency_min = 47000000,
698 .frequency_max = 862000000,
699 .frequency_stepsize = 62500,
700 .symbol_rate_min = 870000,
701 .symbol_rate_max = 11700000,
702 .caps = FE_CAN_QAM_16 | FE_CAN_QAM_32 | FE_CAN_QAM_64 |
703 FE_CAN_QAM_128 | FE_CAN_QAM_256 | FE_CAN_FEC_AUTO},
705 .release = stv0297_release,
707 .init = stv0297_init,
708 .sleep = stv0297_sleep,
709 .i2c_gate_ctrl = stv0297_i2c_gate_ctrl,
711 .set_frontend = stv0297_set_frontend,
712 .get_frontend = stv0297_get_frontend,
714 .read_status = stv0297_read_status,
715 .read_ber = stv0297_read_ber,
716 .read_signal_strength = stv0297_read_signal_strength,
717 .read_snr = stv0297_read_snr,
718 .read_ucblocks = stv0297_read_ucblocks,
721 MODULE_DESCRIPTION("ST STV0297 DVB-C Demodulator driver");
722 MODULE_AUTHOR("Dennis Noermann and Andrew de Quincey");
723 MODULE_LICENSE("GPL");
725 EXPORT_SYMBOL(stv0297_attach);