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 <linux/jiffies.h>
52 #include <asm/div64.h>
54 #include "dvb_frontend.h"
57 struct stv0299_state {
58 struct i2c_adapter* i2c;
59 struct dvb_frontend_ops ops;
60 const struct stv0299_config* config;
61 struct dvb_frontend frontend;
66 fe_code_rate_t fec_inner;
71 #define STATUS_UCBLOCKS 1
74 static int debug_legacy_dish_switch;
75 #define dprintk(args...) \
77 if (debug) printk(KERN_DEBUG "stv0299: " args); \
81 static int stv0299_writeregI (struct stv0299_state* state, u8 reg, u8 data)
84 u8 buf [] = { reg, data };
85 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = 2 };
87 ret = i2c_transfer (state->i2c, &msg, 1);
90 dprintk("%s: writereg error (reg == 0x%02x, val == 0x%02x, "
91 "ret == %i)\n", __FUNCTION__, reg, data, ret);
93 return (ret != 1) ? -EREMOTEIO : 0;
96 int stv0299_writereg (struct dvb_frontend* fe, u8 reg, u8 data)
98 struct stv0299_state* state = fe->demodulator_priv;
100 return stv0299_writeregI(state, reg, data);
103 static u8 stv0299_readreg (struct stv0299_state* state, u8 reg)
108 struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 1 },
109 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 1 } };
111 ret = i2c_transfer (state->i2c, msg, 2);
114 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n",
115 __FUNCTION__, reg, ret);
120 static int stv0299_readregs (struct stv0299_state* state, u8 reg1, u8 *b, u8 len)
123 struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = ®1, .len = 1 },
124 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b, .len = len } };
126 ret = i2c_transfer (state->i2c, msg, 2);
129 dprintk("%s: readreg error (ret == %i)\n", __FUNCTION__, ret);
131 return ret == 2 ? 0 : ret;
134 int stv0299_enable_plli2c (struct dvb_frontend* fe)
136 struct stv0299_state* state = fe->demodulator_priv;
138 return stv0299_writeregI(state, 0x05, 0xb5); /* enable i2c repeater on stv0299 */
141 static int stv0299_set_FEC (struct stv0299_state* state, fe_code_rate_t fec)
143 dprintk ("%s\n", __FUNCTION__);
148 return stv0299_writeregI (state, 0x31, 0x1f);
152 return stv0299_writeregI (state, 0x31, 0x01);
156 return stv0299_writeregI (state, 0x31, 0x02);
160 return stv0299_writeregI (state, 0x31, 0x04);
164 return stv0299_writeregI (state, 0x31, 0x08);
168 return stv0299_writeregI (state, 0x31, 0x10);
177 static fe_code_rate_t stv0299_get_fec (struct stv0299_state* state)
179 static fe_code_rate_t fec_tab [] = { FEC_2_3, FEC_3_4, FEC_5_6,
183 dprintk ("%s\n", __FUNCTION__);
185 index = stv0299_readreg (state, 0x1b);
191 return fec_tab [index];
194 static int stv0299_wait_diseqc_fifo (struct stv0299_state* state, int timeout)
196 unsigned long start = jiffies;
198 dprintk ("%s\n", __FUNCTION__);
200 while (stv0299_readreg(state, 0x0a) & 1) {
201 if (jiffies - start > timeout) {
202 dprintk ("%s: timeout!!\n", __FUNCTION__);
211 static int stv0299_wait_diseqc_idle (struct stv0299_state* state, int timeout)
213 unsigned long start = jiffies;
215 dprintk ("%s\n", __FUNCTION__);
217 while ((stv0299_readreg(state, 0x0a) & 3) != 2 ) {
218 if (jiffies - start > timeout) {
219 dprintk ("%s: timeout!!\n", __FUNCTION__);
228 static int stv0299_set_symbolrate (struct dvb_frontend* fe, u32 srate)
230 struct stv0299_state* state = fe->demodulator_priv;
234 // check rate is within limits
235 if ((srate < 1000000) || (srate > 45000000)) return -EINVAL;
237 // calculate value to program
239 big += (state->config->mclk-1); // round correctly
240 do_div(big, state->config->mclk);
243 return state->config->set_symbol_rate(fe, srate, ratio);
246 static int stv0299_get_symbolrate (struct stv0299_state* state)
248 u32 Mclk = state->config->mclk / 4096L;
254 dprintk ("%s\n", __FUNCTION__);
256 stv0299_readregs (state, 0x1f, sfr, 3);
257 stv0299_readregs (state, 0x1a, &rtf, 1);
259 srate = (sfr[0] << 8) | sfr[1];
262 srate += (sfr[2] >> 4) * Mclk / 256;
263 offset = (s32) rtf * (srate / 4096L);
266 dprintk ("%s : srate = %i\n", __FUNCTION__, srate);
267 dprintk ("%s : ofset = %i\n", __FUNCTION__, offset);
278 static int stv0299_send_diseqc_msg (struct dvb_frontend* fe,
279 struct dvb_diseqc_master_cmd *m)
281 struct stv0299_state* state = fe->demodulator_priv;
285 dprintk ("%s\n", __FUNCTION__);
287 if (stv0299_wait_diseqc_idle (state, 100) < 0)
290 val = stv0299_readreg (state, 0x08);
292 if (stv0299_writeregI (state, 0x08, (val & ~0x7) | 0x6)) /* DiSEqC mode */
295 for (i=0; i<m->msg_len; i++) {
296 if (stv0299_wait_diseqc_fifo (state, 100) < 0)
299 if (stv0299_writeregI (state, 0x09, m->msg[i]))
303 if (stv0299_wait_diseqc_idle (state, 100) < 0)
309 static int stv0299_send_diseqc_burst (struct dvb_frontend* fe, fe_sec_mini_cmd_t burst)
311 struct stv0299_state* state = fe->demodulator_priv;
314 dprintk ("%s\n", __FUNCTION__);
316 if (stv0299_wait_diseqc_idle (state, 100) < 0)
319 val = stv0299_readreg (state, 0x08);
321 if (stv0299_writeregI (state, 0x08, (val & ~0x7) | 0x2)) /* burst mode */
324 if (stv0299_writeregI (state, 0x09, burst == SEC_MINI_A ? 0x00 : 0xff))
327 if (stv0299_wait_diseqc_idle (state, 100) < 0)
330 if (stv0299_writeregI (state, 0x08, val))
336 static int stv0299_set_tone (struct dvb_frontend* fe, fe_sec_tone_mode_t tone)
338 struct stv0299_state* state = fe->demodulator_priv;
341 if (stv0299_wait_diseqc_idle (state, 100) < 0)
344 val = stv0299_readreg (state, 0x08);
348 return stv0299_writeregI (state, 0x08, val | 0x3);
351 return stv0299_writeregI (state, 0x08, (val & ~0x3) | 0x02);
358 static int stv0299_set_voltage (struct dvb_frontend* fe, fe_sec_voltage_t voltage)
360 struct stv0299_state* state = fe->demodulator_priv;
364 dprintk("%s: %s\n", __FUNCTION__,
365 voltage == SEC_VOLTAGE_13 ? "SEC_VOLTAGE_13" :
366 voltage == SEC_VOLTAGE_18 ? "SEC_VOLTAGE_18" : "??");
368 reg0x08 = stv0299_readreg (state, 0x08);
369 reg0x0c = stv0299_readreg (state, 0x0c);
372 * H/V switching over OP0, OP1 and OP2 are LNB power enable bits
376 if (voltage == SEC_VOLTAGE_OFF) {
377 stv0299_writeregI (state, 0x0c, 0x00); /* LNB power off! */
378 return stv0299_writeregI (state, 0x08, 0x00); /* LNB power off! */
381 stv0299_writeregI (state, 0x08, (reg0x08 & 0x3f) | (state->config->lock_output << 6));
385 if (state->config->volt13_op0_op1 == STV0299_VOLT13_OP0) reg0x0c |= 0x10;
386 else reg0x0c |= 0x40;
388 return stv0299_writeregI(state, 0x0c, reg0x0c);
391 return stv0299_writeregI(state, 0x0c, reg0x0c | 0x50);
397 static int stv0299_send_legacy_dish_cmd (struct dvb_frontend* fe, unsigned long cmd)
399 struct stv0299_state* state = fe->demodulator_priv;
405 struct timeval nexttime;
406 struct timeval tv[10];
408 reg0x08 = stv0299_readreg (state, 0x08);
409 reg0x0c = stv0299_readreg (state, 0x0c);
411 stv0299_writeregI (state, 0x08, (reg0x08 & 0x3f) | (state->config->lock_output << 6));
412 if (state->config->volt13_op0_op1 == STV0299_VOLT13_OP0)
416 if (debug_legacy_dish_switch)
417 printk ("%s switch command: 0x%04lx\n",__FUNCTION__, cmd);
419 do_gettimeofday (&nexttime);
420 if (debug_legacy_dish_switch)
421 memcpy (&tv[0], &nexttime, sizeof (struct timeval));
422 stv0299_writeregI (state, 0x0c, reg0x0c | 0x50); /* set LNB to 18V */
424 dvb_frontend_sleep_until(&nexttime, 32000);
426 for (i=0; i<9; i++) {
427 if (debug_legacy_dish_switch)
428 do_gettimeofday (&tv[i+1]);
429 if((cmd & 0x01) != last) {
430 /* set voltage to (last ? 13V : 18V) */
431 stv0299_writeregI (state, 0x0c, reg0x0c | (last ? lv_mask : 0x50));
432 last = (last) ? 0 : 1;
438 dvb_frontend_sleep_until(&nexttime, 8000);
440 if (debug_legacy_dish_switch) {
441 printk ("%s(%d): switch delay (should be 32k followed by all 8k\n",
442 __FUNCTION__, fe->dvb->num);
443 for (i = 1; i < 10; i++)
444 printk ("%d: %d\n", i, timeval_usec_diff(tv[i-1] , tv[i]));
450 static int stv0299_init (struct dvb_frontend* fe)
452 struct stv0299_state* state = fe->demodulator_priv;
455 dprintk("stv0299: init chip\n");
457 for (i=0; !(state->config->inittab[i] == 0xff && state->config->inittab[i+1] == 0xff); i+=2)
458 stv0299_writeregI(state, state->config->inittab[i], state->config->inittab[i+1]);
460 if (state->config->pll_init) {
461 stv0299_writeregI(state, 0x05, 0xb5); /* enable i2c repeater on stv0299 */
462 state->config->pll_init(fe, state->i2c);
463 stv0299_writeregI(state, 0x05, 0x35); /* disable i2c repeater on stv0299 */
469 static int stv0299_read_status(struct dvb_frontend* fe, fe_status_t* status)
471 struct stv0299_state* state = fe->demodulator_priv;
473 u8 signal = 0xff - stv0299_readreg (state, 0x18);
474 u8 sync = stv0299_readreg (state, 0x1b);
476 dprintk ("%s : FE_READ_STATUS : VSTATUS: 0x%02x\n", __FUNCTION__, sync);
480 *status |= FE_HAS_SIGNAL;
483 *status |= FE_HAS_CARRIER;
486 *status |= FE_HAS_VITERBI;
489 *status |= FE_HAS_SYNC;
491 if ((sync & 0x98) == 0x98)
492 *status |= FE_HAS_LOCK;
497 static int stv0299_read_ber(struct dvb_frontend* fe, u32* ber)
499 struct stv0299_state* state = fe->demodulator_priv;
501 if (state->errmode != STATUS_BER) return 0;
502 *ber = (stv0299_readreg (state, 0x1d) << 8) | stv0299_readreg (state, 0x1e);
507 static int stv0299_read_signal_strength(struct dvb_frontend* fe, u16* strength)
509 struct stv0299_state* state = fe->demodulator_priv;
511 s32 signal = 0xffff - ((stv0299_readreg (state, 0x18) << 8)
512 | stv0299_readreg (state, 0x19));
514 dprintk ("%s : FE_READ_SIGNAL_STRENGTH : AGC2I: 0x%02x%02x, signal=0x%04x\n", __FUNCTION__,
515 stv0299_readreg (state, 0x18),
516 stv0299_readreg (state, 0x19), (int) signal);
518 signal = signal * 5 / 4;
519 *strength = (signal > 0xffff) ? 0xffff : (signal < 0) ? 0 : signal;
524 static int stv0299_read_snr(struct dvb_frontend* fe, u16* snr)
526 struct stv0299_state* state = fe->demodulator_priv;
528 s32 xsnr = 0xffff - ((stv0299_readreg (state, 0x24) << 8)
529 | stv0299_readreg (state, 0x25));
530 xsnr = 3 * (xsnr - 0xa100);
531 *snr = (xsnr > 0xffff) ? 0xffff : (xsnr < 0) ? 0 : xsnr;
536 static int stv0299_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
538 struct stv0299_state* state = fe->demodulator_priv;
540 if (state->errmode != STATUS_UCBLOCKS) *ucblocks = 0;
541 else *ucblocks = (stv0299_readreg (state, 0x1d) << 8) | stv0299_readreg (state, 0x1e);
546 static int stv0299_set_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters * p)
548 struct stv0299_state* state = fe->demodulator_priv;
551 dprintk ("%s : FE_SET_FRONTEND\n", __FUNCTION__);
554 if (p->inversion == INVERSION_OFF) invval = 0;
555 else if (p->inversion == INVERSION_ON) invval = 1;
557 printk("stv0299 does not support auto-inversion\n");
560 if (state->config->invert) invval = (~invval) & 1;
561 stv0299_writeregI(state, 0x0c, (stv0299_readreg(state, 0x0c) & 0xfe) | invval);
563 stv0299_writeregI(state, 0x05, 0xb5); /* enable i2c repeater on stv0299 */
564 state->config->pll_set(fe, state->i2c, p);
565 stv0299_writeregI(state, 0x05, 0x35); /* disable i2c repeater on stv0299 */
567 stv0299_set_FEC (state, p->u.qpsk.fec_inner);
568 stv0299_set_symbolrate (fe, p->u.qpsk.symbol_rate);
569 stv0299_writeregI(state, 0x22, 0x00);
570 stv0299_writeregI(state, 0x23, 0x00);
572 state->tuner_frequency = p->frequency;
573 state->fec_inner = p->u.qpsk.fec_inner;
574 state->symbol_rate = p->u.qpsk.symbol_rate;
579 static int stv0299_get_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters * p)
581 struct stv0299_state* state = fe->demodulator_priv;
585 derot_freq = (s32)(s16) ((stv0299_readreg (state, 0x22) << 8)
586 | stv0299_readreg (state, 0x23));
588 derot_freq *= (state->config->mclk >> 16);
592 p->frequency += derot_freq;
594 invval = stv0299_readreg (state, 0x0c) & 1;
595 if (state->config->invert) invval = (~invval) & 1;
596 p->inversion = invval ? INVERSION_ON : INVERSION_OFF;
598 p->u.qpsk.fec_inner = stv0299_get_fec (state);
599 p->u.qpsk.symbol_rate = stv0299_get_symbolrate (state);
604 static int stv0299_sleep(struct dvb_frontend* fe)
606 struct stv0299_state* state = fe->demodulator_priv;
608 stv0299_writeregI(state, 0x02, 0x80);
609 state->initialised = 0;
614 static int stv0299_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
616 struct stv0299_state* state = fe->demodulator_priv;
618 fesettings->min_delay_ms = state->config->min_delay_ms;
619 if (fesettings->parameters.u.qpsk.symbol_rate < 10000000) {
620 fesettings->step_size = fesettings->parameters.u.qpsk.symbol_rate / 32000;
621 fesettings->max_drift = 5000;
623 fesettings->step_size = fesettings->parameters.u.qpsk.symbol_rate / 16000;
624 fesettings->max_drift = fesettings->parameters.u.qpsk.symbol_rate / 2000;
629 static void stv0299_release(struct dvb_frontend* fe)
631 struct stv0299_state* state = fe->demodulator_priv;
635 static struct dvb_frontend_ops stv0299_ops;
637 struct dvb_frontend* stv0299_attach(const struct stv0299_config* config,
638 struct i2c_adapter* i2c)
640 struct stv0299_state* state = NULL;
643 /* allocate memory for the internal state */
644 state = kmalloc(sizeof(struct stv0299_state), GFP_KERNEL);
645 if (state == NULL) goto error;
647 /* setup the state */
648 state->config = config;
650 memcpy(&state->ops, &stv0299_ops, sizeof(struct dvb_frontend_ops));
651 state->initialised = 0;
652 state->tuner_frequency = 0;
653 state->symbol_rate = 0;
654 state->fec_inner = 0;
655 state->errmode = STATUS_BER;
657 /* check if the demod is there */
658 stv0299_writeregI(state, 0x02, 0x34); /* standby off */
660 id = stv0299_readreg(state, 0x00);
662 /* register 0x00 contains 0xa1 for STV0299 and STV0299B */
663 /* register 0x00 might contain 0x80 when returning from standby */
664 if (id != 0xa1 && id != 0x80) goto error;
666 /* create dvb_frontend */
667 state->frontend.ops = &state->ops;
668 state->frontend.demodulator_priv = state;
669 return &state->frontend;
676 static struct dvb_frontend_ops stv0299_ops = {
679 .name = "ST STV0299 DVB-S",
681 .frequency_min = 950000,
682 .frequency_max = 2150000,
683 .frequency_stepsize = 125, /* kHz for QPSK frontends */
684 .frequency_tolerance = 0,
685 .symbol_rate_min = 1000000,
686 .symbol_rate_max = 45000000,
687 .symbol_rate_tolerance = 500, /* ppm */
688 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
689 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
694 .release = stv0299_release,
696 .init = stv0299_init,
697 .sleep = stv0299_sleep,
699 .set_frontend = stv0299_set_frontend,
700 .get_frontend = stv0299_get_frontend,
701 .get_tune_settings = stv0299_get_tune_settings,
703 .read_status = stv0299_read_status,
704 .read_ber = stv0299_read_ber,
705 .read_signal_strength = stv0299_read_signal_strength,
706 .read_snr = stv0299_read_snr,
707 .read_ucblocks = stv0299_read_ucblocks,
709 .diseqc_send_master_cmd = stv0299_send_diseqc_msg,
710 .diseqc_send_burst = stv0299_send_diseqc_burst,
711 .set_tone = stv0299_set_tone,
712 .set_voltage = stv0299_set_voltage,
713 .dishnetwork_send_legacy_command = stv0299_send_legacy_dish_cmd,
716 module_param(debug_legacy_dish_switch, int, 0444);
717 MODULE_PARM_DESC(debug_legacy_dish_switch, "Enable timing analysis for Dish Network legacy switches");
719 module_param(debug, int, 0644);
720 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
722 MODULE_DESCRIPTION("ST STV0299 DVB Demodulator driver");
723 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Peter Schildmann, Felix Domke, "
724 "Andreas Oberritter, Andrew de Quincey, Kenneth Aafløy");
725 MODULE_LICENSE("GPL");
727 EXPORT_SYMBOL(stv0299_enable_plli2c);
728 EXPORT_SYMBOL(stv0299_writereg);
729 EXPORT_SYMBOL(stv0299_attach);