2 Driver for ST STV0299 demodulator
4 Copyright (C) 2001-2002 Convergence Integrated Media GmbH
5 <ralph@convergence.de>,
6 <holger@convergence.de>,
12 Copyright (C) 2002 by Peter Schildmann <peter.schildmann@web.de>
17 Copyright (C) 2002 Felix Domke <tmbinc@elitedvb.net>
18 & Andreas Oberritter <obi@linuxtv.org>
21 Support for Samsung TBMU24112IMB used on Technisat SkyStar2 rev. 2.6B
23 Copyright (C) 2003 Vadim Catana <skystar@moldova.cc>:
25 Support for Philips SU1278 on Technotrend hardware
27 Copyright (C) 2004 Andrew de Quincey <adq_dvb@lidskialf.net>
29 This program is free software; you can redistribute it and/or modify
30 it under the terms of the GNU General Public License as published by
31 the Free Software Foundation; either version 2 of the License, or
32 (at your option) any later version.
34 This program is distributed in the hope that it will be useful,
35 but WITHOUT ANY WARRANTY; without even the implied warranty of
36 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 GNU General Public License for more details.
39 You should have received a copy of the GNU General Public License
40 along with this program; if not, write to the Free Software
41 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
45 #include <linux/init.h>
46 #include <linux/kernel.h>
47 #include <linux/module.h>
48 #include <linux/moduleparam.h>
49 #include <linux/string.h>
50 #include <linux/slab.h>
51 #include <asm/div64.h>
53 #include "dvb_frontend.h"
56 struct stv0299_state {
57 struct i2c_adapter* i2c;
58 struct dvb_frontend_ops ops;
59 const struct stv0299_config* config;
60 struct dvb_frontend frontend;
65 fe_code_rate_t fec_inner;
70 #define STATUS_UCBLOCKS 1
73 static int debug_legacy_dish_switch;
74 #define dprintk(args...) \
76 if (debug) printk(KERN_DEBUG "stv0299: " args); \
80 static int stv0299_writeregI (struct stv0299_state* state, u8 reg, u8 data)
83 u8 buf [] = { reg, data };
84 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = 2 };
86 ret = i2c_transfer (state->i2c, &msg, 1);
89 dprintk("%s: writereg error (reg == 0x%02x, val == 0x%02x, "
90 "ret == %i)\n", __FUNCTION__, reg, data, ret);
92 return (ret != 1) ? -EREMOTEIO : 0;
95 int stv0299_writereg (struct dvb_frontend* fe, u8 reg, u8 data)
97 struct stv0299_state* state = fe->demodulator_priv;
99 return stv0299_writeregI(state, reg, data);
102 static u8 stv0299_readreg (struct stv0299_state* state, u8 reg)
107 struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 1 },
108 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 1 } };
110 ret = i2c_transfer (state->i2c, msg, 2);
113 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n",
114 __FUNCTION__, reg, ret);
119 static int stv0299_readregs (struct stv0299_state* state, u8 reg1, u8 *b, u8 len)
122 struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = ®1, .len = 1 },
123 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b, .len = len } };
125 ret = i2c_transfer (state->i2c, msg, 2);
128 dprintk("%s: readreg error (ret == %i)\n", __FUNCTION__, ret);
130 return ret == 2 ? 0 : ret;
133 static int stv0299_set_FEC (struct stv0299_state* state, fe_code_rate_t fec)
135 dprintk ("%s\n", __FUNCTION__);
140 return stv0299_writeregI (state, 0x31, 0x1f);
144 return stv0299_writeregI (state, 0x31, 0x01);
148 return stv0299_writeregI (state, 0x31, 0x02);
152 return stv0299_writeregI (state, 0x31, 0x04);
156 return stv0299_writeregI (state, 0x31, 0x08);
160 return stv0299_writeregI (state, 0x31, 0x10);
169 static fe_code_rate_t stv0299_get_fec (struct stv0299_state* state)
171 static fe_code_rate_t fec_tab [] = { FEC_2_3, FEC_3_4, FEC_5_6,
175 dprintk ("%s\n", __FUNCTION__);
177 index = stv0299_readreg (state, 0x1b);
183 return fec_tab [index];
186 static int stv0299_wait_diseqc_fifo (struct stv0299_state* state, int timeout)
188 unsigned long start = jiffies;
190 dprintk ("%s\n", __FUNCTION__);
192 while (stv0299_readreg(state, 0x0a) & 1) {
193 if (jiffies - start > timeout) {
194 dprintk ("%s: timeout!!\n", __FUNCTION__);
203 static int stv0299_wait_diseqc_idle (struct stv0299_state* state, int timeout)
205 unsigned long start = jiffies;
207 dprintk ("%s\n", __FUNCTION__);
209 while ((stv0299_readreg(state, 0x0a) & 3) != 2 ) {
210 if (jiffies - start > timeout) {
211 dprintk ("%s: timeout!!\n", __FUNCTION__);
220 static int stv0299_set_symbolrate (struct dvb_frontend* fe, u32 srate)
222 struct stv0299_state* state = fe->demodulator_priv;
226 // check rate is within limits
227 if ((srate < 1000000) || (srate > 45000000)) return -EINVAL;
229 // calculate value to program
231 big += (state->config->mclk-1); // round correctly
232 do_div(big, state->config->mclk);
235 return state->config->set_symbol_rate(fe, srate, ratio);
238 static int stv0299_get_symbolrate (struct stv0299_state* state)
240 u32 Mclk = state->config->mclk / 4096L;
246 dprintk ("%s\n", __FUNCTION__);
248 stv0299_readregs (state, 0x1f, sfr, 3);
249 stv0299_readregs (state, 0x1a, &rtf, 1);
251 srate = (sfr[0] << 8) | sfr[1];
254 srate += (sfr[2] >> 4) * Mclk / 256;
255 offset = (s32) rtf * (srate / 4096L);
258 dprintk ("%s : srate = %i\n", __FUNCTION__, srate);
259 dprintk ("%s : ofset = %i\n", __FUNCTION__, offset);
270 static int stv0299_send_diseqc_msg (struct dvb_frontend* fe,
271 struct dvb_diseqc_master_cmd *m)
273 struct stv0299_state* state = fe->demodulator_priv;
277 dprintk ("%s\n", __FUNCTION__);
279 if (stv0299_wait_diseqc_idle (state, 100) < 0)
282 val = stv0299_readreg (state, 0x08);
284 if (stv0299_writeregI (state, 0x08, (val & ~0x7) | 0x6)) /* DiSEqC mode */
287 for (i=0; i<m->msg_len; i++) {
288 if (stv0299_wait_diseqc_fifo (state, 100) < 0)
291 if (stv0299_writeregI (state, 0x09, m->msg[i]))
295 if (stv0299_wait_diseqc_idle (state, 100) < 0)
301 static int stv0299_send_diseqc_burst (struct dvb_frontend* fe, fe_sec_mini_cmd_t burst)
303 struct stv0299_state* state = fe->demodulator_priv;
306 dprintk ("%s\n", __FUNCTION__);
308 if (stv0299_wait_diseqc_idle (state, 100) < 0)
311 val = stv0299_readreg (state, 0x08);
313 if (stv0299_writeregI (state, 0x08, (val & ~0x7) | 0x2)) /* burst mode */
316 if (stv0299_writeregI (state, 0x09, burst == SEC_MINI_A ? 0x00 : 0xff))
319 if (stv0299_wait_diseqc_idle (state, 100) < 0)
322 if (stv0299_writeregI (state, 0x08, val))
328 static int stv0299_set_tone (struct dvb_frontend* fe, fe_sec_tone_mode_t tone)
330 struct stv0299_state* state = fe->demodulator_priv;
333 if (stv0299_wait_diseqc_idle (state, 100) < 0)
336 val = stv0299_readreg (state, 0x08);
340 return stv0299_writeregI (state, 0x08, val | 0x3);
343 return stv0299_writeregI (state, 0x08, (val & ~0x3) | 0x02);
350 static int stv0299_set_voltage (struct dvb_frontend* fe, fe_sec_voltage_t voltage)
352 struct stv0299_state* state = fe->demodulator_priv;
356 dprintk("%s: %s\n", __FUNCTION__,
357 voltage == SEC_VOLTAGE_13 ? "SEC_VOLTAGE_13" :
358 voltage == SEC_VOLTAGE_18 ? "SEC_VOLTAGE_18" : "??");
360 reg0x08 = stv0299_readreg (state, 0x08);
361 reg0x0c = stv0299_readreg (state, 0x0c);
364 * H/V switching over OP0, OP1 and OP2 are LNB power enable bits
368 if (voltage == SEC_VOLTAGE_OFF) {
369 stv0299_writeregI (state, 0x0c, 0x00); /* LNB power off! */
370 return stv0299_writeregI (state, 0x08, 0x00); /* LNB power off! */
373 stv0299_writeregI (state, 0x08, (reg0x08 & 0x3f) | (state->config->lock_output << 6));
377 if (state->config->volt13_op0_op1 == STV0299_VOLT13_OP0) reg0x0c |= 0x10;
378 else reg0x0c |= 0x40;
380 return stv0299_writeregI(state, 0x0c, reg0x0c);
383 return stv0299_writeregI(state, 0x0c, reg0x0c | 0x50);
389 static inline s32 stv0299_calc_usec_delay (struct timeval lasttime, struct timeval curtime)
391 return ((curtime.tv_usec < lasttime.tv_usec) ?
392 1000000 - lasttime.tv_usec + curtime.tv_usec :
393 curtime.tv_usec - lasttime.tv_usec);
396 static void stv0299_sleep_until (struct timeval *waketime, u32 add_usec)
398 struct timeval lasttime;
401 waketime->tv_usec += add_usec;
402 if (waketime->tv_usec >= 1000000) {
403 waketime->tv_usec -= 1000000;
407 do_gettimeofday (&lasttime);
408 delta = stv0299_calc_usec_delay (lasttime, *waketime);
410 msleep ((delta - 1500) / 1000);
411 do_gettimeofday (&lasttime);
412 newdelta = stv0299_calc_usec_delay (lasttime, *waketime);
413 delta = (newdelta > delta) ? 0 : newdelta;
419 static int stv0299_send_legacy_dish_cmd (struct dvb_frontend* fe, u32 cmd)
421 struct stv0299_state* state = fe->demodulator_priv;
427 struct timeval nexttime;
428 struct timeval tv[10];
430 reg0x08 = stv0299_readreg (state, 0x08);
431 reg0x0c = stv0299_readreg (state, 0x0c);
433 stv0299_writeregI (state, 0x08, (reg0x08 & 0x3f) | (state->config->lock_output << 6));
434 if (state->config->volt13_op0_op1 == STV0299_VOLT13_OP0)
438 if (debug_legacy_dish_switch)
439 printk ("%s switch command: 0x%04x\n",__FUNCTION__, cmd);
441 do_gettimeofday (&nexttime);
442 if (debug_legacy_dish_switch)
443 memcpy (&tv[0], &nexttime, sizeof (struct timeval));
444 stv0299_writeregI (state, 0x0c, reg0x0c | 0x50); /* set LNB to 18V */
446 stv0299_sleep_until (&nexttime, 32000);
448 for (i=0; i<9; i++) {
449 if (debug_legacy_dish_switch)
450 do_gettimeofday (&tv[i+1]);
451 if((cmd & 0x01) != last) {
452 /* set voltage to (last ? 13V : 18V) */
453 stv0299_writeregI (state, 0x0c, reg0x0c | (last ? lv_mask : 0x50));
454 last = (last) ? 0 : 1;
460 stv0299_sleep_until (&nexttime, 8000);
462 if (debug_legacy_dish_switch) {
463 printk ("%s(%d): switch delay (should be 32k followed by all 8k\n",
464 __FUNCTION__, fe->dvb->num);
465 for (i=1; i < 10; i++)
466 printk ("%d: %d\n", i, stv0299_calc_usec_delay (tv[i-1] , tv[i]));
472 static int stv0299_init (struct dvb_frontend* fe)
474 struct stv0299_state* state = fe->demodulator_priv;
477 dprintk("stv0299: init chip\n");
479 for (i=0; !(state->config->inittab[i] == 0xff && state->config->inittab[i+1] == 0xff); i+=2)
480 stv0299_writeregI(state, state->config->inittab[i], state->config->inittab[i+1]);
482 if (state->config->pll_init) {
483 stv0299_writeregI(state, 0x05, 0xb5); /* enable i2c repeater on stv0299 */
484 state->config->pll_init(fe);
485 stv0299_writeregI(state, 0x05, 0x35); /* disable i2c repeater on stv0299 */
491 static int stv0299_read_status(struct dvb_frontend* fe, fe_status_t* status)
493 struct stv0299_state* state = fe->demodulator_priv;
495 u8 signal = 0xff - stv0299_readreg (state, 0x18);
496 u8 sync = stv0299_readreg (state, 0x1b);
498 dprintk ("%s : FE_READ_STATUS : VSTATUS: 0x%02x\n", __FUNCTION__, sync);
502 *status |= FE_HAS_SIGNAL;
505 *status |= FE_HAS_CARRIER;
508 *status |= FE_HAS_VITERBI;
511 *status |= FE_HAS_SYNC;
513 if ((sync & 0x98) == 0x98)
514 *status |= FE_HAS_LOCK;
519 static int stv0299_read_ber(struct dvb_frontend* fe, u32* ber)
521 struct stv0299_state* state = fe->demodulator_priv;
523 if (state->errmode != STATUS_BER) return 0;
524 *ber = (stv0299_readreg (state, 0x1d) << 8) | stv0299_readreg (state, 0x1e);
529 static int stv0299_read_signal_strength(struct dvb_frontend* fe, u16* strength)
531 struct stv0299_state* state = fe->demodulator_priv;
533 s32 signal = 0xffff - ((stv0299_readreg (state, 0x18) << 8)
534 | stv0299_readreg (state, 0x19));
536 dprintk ("%s : FE_READ_SIGNAL_STRENGTH : AGC2I: 0x%02x%02x, signal=0x%04x\n", __FUNCTION__,
537 stv0299_readreg (state, 0x18),
538 stv0299_readreg (state, 0x19), (int) signal);
540 signal = signal * 5 / 4;
541 *strength = (signal > 0xffff) ? 0xffff : (signal < 0) ? 0 : signal;
546 static int stv0299_read_snr(struct dvb_frontend* fe, u16* snr)
548 struct stv0299_state* state = fe->demodulator_priv;
550 s32 xsnr = 0xffff - ((stv0299_readreg (state, 0x24) << 8)
551 | stv0299_readreg (state, 0x25));
552 xsnr = 3 * (xsnr - 0xa100);
553 *snr = (xsnr > 0xffff) ? 0xffff : (xsnr < 0) ? 0 : xsnr;
558 static int stv0299_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
560 struct stv0299_state* state = fe->demodulator_priv;
562 if (state->errmode != STATUS_UCBLOCKS) *ucblocks = 0;
563 else *ucblocks = (stv0299_readreg (state, 0x1d) << 8) | stv0299_readreg (state, 0x1e);
568 static int stv0299_set_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters * p)
570 struct stv0299_state* state = fe->demodulator_priv;
573 dprintk ("%s : FE_SET_FRONTEND\n", __FUNCTION__);
576 if (p->inversion == INVERSION_OFF) invval = 0;
577 else if (p->inversion == INVERSION_ON) invval = 1;
579 printk("stv0299 does not support auto-inversion\n");
582 if (state->config->invert) invval = (~invval) & 1;
583 stv0299_writeregI(state, 0x0c, (stv0299_readreg(state, 0x0c) & 0xfe) | invval);
585 if (state->config->enhanced_tuning) {
586 /* check if we should do a finetune */
587 int frequency_delta = p->frequency - state->tuner_frequency;
588 int minmax = p->u.qpsk.symbol_rate / 2000;
589 if (minmax < 5000) minmax = 5000;
591 if ((frequency_delta > -minmax) && (frequency_delta < minmax) && (frequency_delta != 0) &&
592 (state->fec_inner == p->u.qpsk.fec_inner) &&
593 (state->symbol_rate == p->u.qpsk.symbol_rate)) {
594 int Drot_freq = (frequency_delta << 16) / (state->config->mclk / 1000);
596 // zap the derotator registers first
597 stv0299_writeregI(state, 0x22, 0x00);
598 stv0299_writeregI(state, 0x23, 0x00);
600 // now set them as we want
601 stv0299_writeregI(state, 0x22, Drot_freq >> 8);
602 stv0299_writeregI(state, 0x23, Drot_freq);
604 /* A "normal" tune is requested */
605 stv0299_writeregI(state, 0x05, 0xb5); /* enable i2c repeater on stv0299 */
606 state->config->pll_set(fe, p);
607 stv0299_writeregI(state, 0x05, 0x35); /* disable i2c repeater on stv0299 */
609 stv0299_writeregI(state, 0x32, 0x80);
610 stv0299_writeregI(state, 0x22, 0x00);
611 stv0299_writeregI(state, 0x23, 0x00);
612 stv0299_writeregI(state, 0x32, 0x19);
613 stv0299_set_symbolrate (fe, p->u.qpsk.symbol_rate);
614 stv0299_set_FEC (state, p->u.qpsk.fec_inner);
617 stv0299_writeregI(state, 0x05, 0xb5); /* enable i2c repeater on stv0299 */
618 state->config->pll_set(fe, p);
619 stv0299_writeregI(state, 0x05, 0x35); /* disable i2c repeater on stv0299 */
621 stv0299_set_FEC (state, p->u.qpsk.fec_inner);
622 stv0299_set_symbolrate (fe, p->u.qpsk.symbol_rate);
623 stv0299_writeregI(state, 0x22, 0x00);
624 stv0299_writeregI(state, 0x23, 0x00);
625 stv0299_readreg (state, 0x23);
626 stv0299_writeregI(state, 0x12, 0xb9);
629 state->tuner_frequency = p->frequency;
630 state->fec_inner = p->u.qpsk.fec_inner;
631 state->symbol_rate = p->u.qpsk.symbol_rate;
636 static int stv0299_get_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters * p)
638 struct stv0299_state* state = fe->demodulator_priv;
642 derot_freq = (s32)(s16) ((stv0299_readreg (state, 0x22) << 8)
643 | stv0299_readreg (state, 0x23));
645 derot_freq *= (state->config->mclk >> 16);
649 p->frequency += derot_freq;
651 invval = stv0299_readreg (state, 0x0c) & 1;
652 if (state->config->invert) invval = (~invval) & 1;
653 p->inversion = invval ? INVERSION_ON : INVERSION_OFF;
655 p->u.qpsk.fec_inner = stv0299_get_fec (state);
656 p->u.qpsk.symbol_rate = stv0299_get_symbolrate (state);
661 static int stv0299_sleep(struct dvb_frontend* fe)
663 struct stv0299_state* state = fe->demodulator_priv;
665 stv0299_writeregI(state, 0x02, 0x80);
666 state->initialised = 0;
671 static int stv0299_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
673 struct stv0299_state* state = fe->demodulator_priv;
675 fesettings->min_delay_ms = state->config->min_delay_ms;
676 if (fesettings->parameters.u.qpsk.symbol_rate < 10000000) {
677 fesettings->step_size = fesettings->parameters.u.qpsk.symbol_rate / 32000;
678 fesettings->max_drift = 5000;
680 fesettings->step_size = fesettings->parameters.u.qpsk.symbol_rate / 16000;
681 fesettings->max_drift = fesettings->parameters.u.qpsk.symbol_rate / 2000;
686 static void stv0299_release(struct dvb_frontend* fe)
688 struct stv0299_state* state = fe->demodulator_priv;
692 static struct dvb_frontend_ops stv0299_ops;
694 struct dvb_frontend* stv0299_attach(const struct stv0299_config* config,
695 struct i2c_adapter* i2c)
697 struct stv0299_state* state = NULL;
700 /* allocate memory for the internal state */
701 state = kmalloc(sizeof(struct stv0299_state), GFP_KERNEL);
702 if (state == NULL) goto error;
704 /* setup the state */
705 state->config = config;
707 memcpy(&state->ops, &stv0299_ops, sizeof(struct dvb_frontend_ops));
708 state->initialised = 0;
709 state->tuner_frequency = 0;
710 state->symbol_rate = 0;
711 state->fec_inner = 0;
712 state->errmode = STATUS_BER;
714 /* check if the demod is there */
715 stv0299_writeregI(state, 0x02, 0x34); /* standby off */
717 id = stv0299_readreg(state, 0x00);
719 /* register 0x00 contains 0xa1 for STV0299 and STV0299B */
720 /* register 0x00 might contain 0x80 when returning from standby */
721 if (id != 0xa1 && id != 0x80) goto error;
723 /* create dvb_frontend */
724 state->frontend.ops = &state->ops;
725 state->frontend.demodulator_priv = state;
726 return &state->frontend;
733 static struct dvb_frontend_ops stv0299_ops = {
736 .name = "ST STV0299 DVB-S",
738 .frequency_min = 950000,
739 .frequency_max = 2150000,
740 .frequency_stepsize = 125, /* kHz for QPSK frontends */
741 .frequency_tolerance = 0,
742 .symbol_rate_min = 1000000,
743 .symbol_rate_max = 45000000,
744 .symbol_rate_tolerance = 500, /* ppm */
745 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
746 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
751 .release = stv0299_release,
753 .init = stv0299_init,
754 .sleep = stv0299_sleep,
756 .set_frontend = stv0299_set_frontend,
757 .get_frontend = stv0299_get_frontend,
758 .get_tune_settings = stv0299_get_tune_settings,
760 .read_status = stv0299_read_status,
761 .read_ber = stv0299_read_ber,
762 .read_signal_strength = stv0299_read_signal_strength,
763 .read_snr = stv0299_read_snr,
764 .read_ucblocks = stv0299_read_ucblocks,
766 .diseqc_send_master_cmd = stv0299_send_diseqc_msg,
767 .diseqc_send_burst = stv0299_send_diseqc_burst,
768 .set_tone = stv0299_set_tone,
769 .set_voltage = stv0299_set_voltage,
770 .dishnetwork_send_legacy_command = stv0299_send_legacy_dish_cmd,
773 module_param(debug_legacy_dish_switch, int, 0444);
774 MODULE_PARM_DESC(debug_legacy_dish_switch, "Enable timing analysis for Dish Network legacy switches");
776 module_param(debug, int, 0644);
777 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
779 MODULE_DESCRIPTION("ST STV0299 DVB Demodulator driver");
780 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Peter Schildmann, Felix Domke, "
781 "Andreas Oberritter, Andrew de Quincey, Kenneth Aafløy");
782 MODULE_LICENSE("GPL");
784 EXPORT_SYMBOL(stv0299_writereg);
785 EXPORT_SYMBOL(stv0299_attach);