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 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 int stv0299_send_legacy_dish_cmd (struct dvb_frontend* fe, unsigned long cmd)
391 struct stv0299_state* state = fe->demodulator_priv;
397 struct timeval nexttime;
398 struct timeval tv[10];
400 reg0x08 = stv0299_readreg (state, 0x08);
401 reg0x0c = stv0299_readreg (state, 0x0c);
403 stv0299_writeregI (state, 0x08, (reg0x08 & 0x3f) | (state->config->lock_output << 6));
404 if (state->config->volt13_op0_op1 == STV0299_VOLT13_OP0)
408 if (debug_legacy_dish_switch)
409 printk ("%s switch command: 0x%04lx\n",__FUNCTION__, cmd);
411 do_gettimeofday (&nexttime);
412 if (debug_legacy_dish_switch)
413 memcpy (&tv[0], &nexttime, sizeof (struct timeval));
414 stv0299_writeregI (state, 0x0c, reg0x0c | 0x50); /* set LNB to 18V */
416 dvb_frontend_sleep_until(&nexttime, 32000);
418 for (i=0; i<9; i++) {
419 if (debug_legacy_dish_switch)
420 do_gettimeofday (&tv[i+1]);
421 if((cmd & 0x01) != last) {
422 /* set voltage to (last ? 13V : 18V) */
423 stv0299_writeregI (state, 0x0c, reg0x0c | (last ? lv_mask : 0x50));
424 last = (last) ? 0 : 1;
430 dvb_frontend_sleep_until(&nexttime, 8000);
432 if (debug_legacy_dish_switch) {
433 printk ("%s(%d): switch delay (should be 32k followed by all 8k\n",
434 __FUNCTION__, fe->dvb->num);
435 for (i = 1; i < 10; i++)
436 printk ("%d: %d\n", i, timeval_usec_diff(tv[i-1] , tv[i]));
442 static int stv0299_init (struct dvb_frontend* fe)
444 struct stv0299_state* state = fe->demodulator_priv;
447 dprintk("stv0299: init chip\n");
449 for (i=0; !(state->config->inittab[i] == 0xff && state->config->inittab[i+1] == 0xff); i+=2)
450 stv0299_writeregI(state, state->config->inittab[i], state->config->inittab[i+1]);
455 static int stv0299_read_status(struct dvb_frontend* fe, fe_status_t* status)
457 struct stv0299_state* state = fe->demodulator_priv;
459 u8 signal = 0xff - stv0299_readreg (state, 0x18);
460 u8 sync = stv0299_readreg (state, 0x1b);
462 dprintk ("%s : FE_READ_STATUS : VSTATUS: 0x%02x\n", __FUNCTION__, sync);
466 *status |= FE_HAS_SIGNAL;
469 *status |= FE_HAS_CARRIER;
472 *status |= FE_HAS_VITERBI;
475 *status |= FE_HAS_SYNC;
477 if ((sync & 0x98) == 0x98)
478 *status |= FE_HAS_LOCK;
483 static int stv0299_read_ber(struct dvb_frontend* fe, u32* ber)
485 struct stv0299_state* state = fe->demodulator_priv;
487 if (state->errmode != STATUS_BER) return 0;
488 *ber = (stv0299_readreg (state, 0x1d) << 8) | stv0299_readreg (state, 0x1e);
493 static int stv0299_read_signal_strength(struct dvb_frontend* fe, u16* strength)
495 struct stv0299_state* state = fe->demodulator_priv;
497 s32 signal = 0xffff - ((stv0299_readreg (state, 0x18) << 8)
498 | stv0299_readreg (state, 0x19));
500 dprintk ("%s : FE_READ_SIGNAL_STRENGTH : AGC2I: 0x%02x%02x, signal=0x%04x\n", __FUNCTION__,
501 stv0299_readreg (state, 0x18),
502 stv0299_readreg (state, 0x19), (int) signal);
504 signal = signal * 5 / 4;
505 *strength = (signal > 0xffff) ? 0xffff : (signal < 0) ? 0 : signal;
510 static int stv0299_read_snr(struct dvb_frontend* fe, u16* snr)
512 struct stv0299_state* state = fe->demodulator_priv;
514 s32 xsnr = 0xffff - ((stv0299_readreg (state, 0x24) << 8)
515 | stv0299_readreg (state, 0x25));
516 xsnr = 3 * (xsnr - 0xa100);
517 *snr = (xsnr > 0xffff) ? 0xffff : (xsnr < 0) ? 0 : xsnr;
522 static int stv0299_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
524 struct stv0299_state* state = fe->demodulator_priv;
526 if (state->errmode != STATUS_UCBLOCKS) *ucblocks = 0;
527 else *ucblocks = (stv0299_readreg (state, 0x1d) << 8) | stv0299_readreg (state, 0x1e);
532 static int stv0299_set_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters * p)
534 struct stv0299_state* state = fe->demodulator_priv;
537 dprintk ("%s : FE_SET_FRONTEND\n", __FUNCTION__);
540 if (p->inversion == INVERSION_OFF) invval = 0;
541 else if (p->inversion == INVERSION_ON) invval = 1;
543 printk("stv0299 does not support auto-inversion\n");
546 if (state->config->invert) invval = (~invval) & 1;
547 stv0299_writeregI(state, 0x0c, (stv0299_readreg(state, 0x0c) & 0xfe) | invval);
549 if (fe->ops.tuner_ops.set_params) {
550 fe->ops.tuner_ops.set_params(fe, p);
551 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
554 stv0299_set_FEC (state, p->u.qpsk.fec_inner);
555 stv0299_set_symbolrate (fe, p->u.qpsk.symbol_rate);
556 stv0299_writeregI(state, 0x22, 0x00);
557 stv0299_writeregI(state, 0x23, 0x00);
559 state->tuner_frequency = p->frequency;
560 state->fec_inner = p->u.qpsk.fec_inner;
561 state->symbol_rate = p->u.qpsk.symbol_rate;
566 static int stv0299_get_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters * p)
568 struct stv0299_state* state = fe->demodulator_priv;
572 derot_freq = (s32)(s16) ((stv0299_readreg (state, 0x22) << 8)
573 | stv0299_readreg (state, 0x23));
575 derot_freq *= (state->config->mclk >> 16);
579 p->frequency += derot_freq;
581 invval = stv0299_readreg (state, 0x0c) & 1;
582 if (state->config->invert) invval = (~invval) & 1;
583 p->inversion = invval ? INVERSION_ON : INVERSION_OFF;
585 p->u.qpsk.fec_inner = stv0299_get_fec (state);
586 p->u.qpsk.symbol_rate = stv0299_get_symbolrate (state);
591 static int stv0299_sleep(struct dvb_frontend* fe)
593 struct stv0299_state* state = fe->demodulator_priv;
595 stv0299_writeregI(state, 0x02, 0x80);
596 state->initialised = 0;
601 static int stv0299_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
603 struct stv0299_state* state = fe->demodulator_priv;
606 stv0299_writeregI(state, 0x05, 0xb5);
608 stv0299_writeregI(state, 0x05, 0x35);
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 state->initialised = 0;
651 state->tuner_frequency = 0;
652 state->symbol_rate = 0;
653 state->fec_inner = 0;
654 state->errmode = STATUS_BER;
656 /* check if the demod is there */
657 stv0299_writeregI(state, 0x02, 0x34); /* standby off */
659 id = stv0299_readreg(state, 0x00);
661 /* register 0x00 contains 0xa1 for STV0299 and STV0299B */
662 /* register 0x00 might contain 0x80 when returning from standby */
663 if (id != 0xa1 && id != 0x80) goto error;
665 /* create dvb_frontend */
666 memcpy(&state->frontend.ops, &stv0299_ops, sizeof(struct dvb_frontend_ops));
667 state->frontend.demodulator_priv = state;
668 return &state->frontend;
675 static struct dvb_frontend_ops stv0299_ops = {
678 .name = "ST STV0299 DVB-S",
680 .frequency_min = 950000,
681 .frequency_max = 2150000,
682 .frequency_stepsize = 125, /* kHz for QPSK frontends */
683 .frequency_tolerance = 0,
684 .symbol_rate_min = 1000000,
685 .symbol_rate_max = 45000000,
686 .symbol_rate_tolerance = 500, /* ppm */
687 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
688 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
693 .release = stv0299_release,
695 .init = stv0299_init,
696 .sleep = stv0299_sleep,
697 .i2c_gate_ctrl = stv0299_i2c_gate_ctrl,
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 Aafly");
725 MODULE_LICENSE("GPL");
727 EXPORT_SYMBOL(stv0299_writereg);
728 EXPORT_SYMBOL(stv0299_attach);