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/string.h>
49 #include <linux/slab.h>
50 #include <linux/jiffies.h>
51 #include <asm/div64.h>
53 #include "dvb_frontend.h"
56 struct stv0299_state
{
57 struct i2c_adapter
* i2c
;
58 const struct stv0299_config
* config
;
59 struct dvb_frontend frontend
;
64 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", __func__
, reg
, data
, ret
);
93 return (ret
!= 1) ? -EREMOTEIO
: 0;
96 static int stv0299_write(struct dvb_frontend
* fe
, const u8 buf
[], int len
)
98 struct stv0299_state
* state
= fe
->demodulator_priv
;
103 return stv0299_writeregI(state
, buf
[0], buf
[1]);
106 static u8
stv0299_readreg (struct stv0299_state
* state
, u8 reg
)
111 struct i2c_msg msg
[] = { { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= b0
, .len
= 1 },
112 { .addr
= state
->config
->demod_address
, .flags
= I2C_M_RD
, .buf
= b1
, .len
= 1 } };
114 ret
= i2c_transfer (state
->i2c
, msg
, 2);
117 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n",
123 static int stv0299_readregs (struct stv0299_state
* state
, u8 reg1
, u8
*b
, u8 len
)
126 struct i2c_msg msg
[] = { { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= ®1
, .len
= 1 },
127 { .addr
= state
->config
->demod_address
, .flags
= I2C_M_RD
, .buf
= b
, .len
= len
} };
129 ret
= i2c_transfer (state
->i2c
, msg
, 2);
132 dprintk("%s: readreg error (ret == %i)\n", __func__
, ret
);
134 return ret
== 2 ? 0 : ret
;
137 static int stv0299_set_FEC (struct stv0299_state
* state
, fe_code_rate_t fec
)
139 dprintk ("%s\n", __func__
);
144 return stv0299_writeregI (state
, 0x31, 0x1f);
148 return stv0299_writeregI (state
, 0x31, 0x01);
152 return stv0299_writeregI (state
, 0x31, 0x02);
156 return stv0299_writeregI (state
, 0x31, 0x04);
160 return stv0299_writeregI (state
, 0x31, 0x08);
164 return stv0299_writeregI (state
, 0x31, 0x10);
173 static fe_code_rate_t
stv0299_get_fec (struct stv0299_state
* state
)
175 static fe_code_rate_t fec_tab
[] = { FEC_2_3
, FEC_3_4
, FEC_5_6
,
179 dprintk ("%s\n", __func__
);
181 index
= stv0299_readreg (state
, 0x1b);
187 return fec_tab
[index
];
190 static int stv0299_wait_diseqc_fifo (struct stv0299_state
* state
, int timeout
)
192 unsigned long start
= jiffies
;
194 dprintk ("%s\n", __func__
);
196 while (stv0299_readreg(state
, 0x0a) & 1) {
197 if (jiffies
- start
> timeout
) {
198 dprintk ("%s: timeout!!\n", __func__
);
207 static int stv0299_wait_diseqc_idle (struct stv0299_state
* state
, int timeout
)
209 unsigned long start
= jiffies
;
211 dprintk ("%s\n", __func__
);
213 while ((stv0299_readreg(state
, 0x0a) & 3) != 2 ) {
214 if (jiffies
- start
> timeout
) {
215 dprintk ("%s: timeout!!\n", __func__
);
224 static int stv0299_set_symbolrate (struct dvb_frontend
* fe
, u32 srate
)
226 struct stv0299_state
* state
= fe
->demodulator_priv
;
230 // check rate is within limits
231 if ((srate
< 1000000) || (srate
> 45000000)) return -EINVAL
;
233 // calculate value to program
235 big
+= (state
->config
->mclk
-1); // round correctly
236 do_div(big
, state
->config
->mclk
);
239 return state
->config
->set_symbol_rate(fe
, srate
, ratio
);
242 static int stv0299_get_symbolrate (struct stv0299_state
* state
)
244 u32 Mclk
= state
->config
->mclk
/ 4096L;
250 dprintk ("%s\n", __func__
);
252 stv0299_readregs (state
, 0x1f, sfr
, 3);
253 stv0299_readregs (state
, 0x1a, (u8
*)&rtf
, 1);
255 srate
= (sfr
[0] << 8) | sfr
[1];
258 srate
+= (sfr
[2] >> 4) * Mclk
/ 256;
259 offset
= (s32
) rtf
* (srate
/ 4096L);
262 dprintk ("%s : srate = %i\n", __func__
, srate
);
263 dprintk ("%s : ofset = %i\n", __func__
, offset
);
274 static int stv0299_send_diseqc_msg (struct dvb_frontend
* fe
,
275 struct dvb_diseqc_master_cmd
*m
)
277 struct stv0299_state
* state
= fe
->demodulator_priv
;
281 dprintk ("%s\n", __func__
);
283 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
286 val
= stv0299_readreg (state
, 0x08);
288 if (stv0299_writeregI (state
, 0x08, (val
& ~0x7) | 0x6)) /* DiSEqC mode */
291 for (i
=0; i
<m
->msg_len
; i
++) {
292 if (stv0299_wait_diseqc_fifo (state
, 100) < 0)
295 if (stv0299_writeregI (state
, 0x09, m
->msg
[i
]))
299 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
305 static int stv0299_send_diseqc_burst (struct dvb_frontend
* fe
, fe_sec_mini_cmd_t burst
)
307 struct stv0299_state
* state
= fe
->demodulator_priv
;
310 dprintk ("%s\n", __func__
);
312 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
315 val
= stv0299_readreg (state
, 0x08);
317 if (stv0299_writeregI (state
, 0x08, (val
& ~0x7) | 0x2)) /* burst mode */
320 if (stv0299_writeregI (state
, 0x09, burst
== SEC_MINI_A
? 0x00 : 0xff))
323 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
326 if (stv0299_writeregI (state
, 0x08, val
))
332 static int stv0299_set_tone (struct dvb_frontend
* fe
, fe_sec_tone_mode_t tone
)
334 struct stv0299_state
* state
= fe
->demodulator_priv
;
337 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
340 val
= stv0299_readreg (state
, 0x08);
344 return stv0299_writeregI (state
, 0x08, val
| 0x3);
347 return stv0299_writeregI (state
, 0x08, (val
& ~0x3) | 0x02);
354 static int stv0299_set_voltage (struct dvb_frontend
* fe
, fe_sec_voltage_t voltage
)
356 struct stv0299_state
* state
= fe
->demodulator_priv
;
360 dprintk("%s: %s\n", __func__
,
361 voltage
== SEC_VOLTAGE_13
? "SEC_VOLTAGE_13" :
362 voltage
== SEC_VOLTAGE_18
? "SEC_VOLTAGE_18" : "??");
364 reg0x08
= stv0299_readreg (state
, 0x08);
365 reg0x0c
= stv0299_readreg (state
, 0x0c);
368 * H/V switching over OP0, OP1 and OP2 are LNB power enable bits
371 reg0x08
= (reg0x08
& 0x3f) | (state
->config
->lock_output
<< 6);
375 if (state
->config
->volt13_op0_op1
== STV0299_VOLT13_OP0
)
376 reg0x0c
|= 0x10; /* OP1 off, OP0 on */
378 reg0x0c
|= 0x40; /* OP1 on, OP0 off */
381 reg0x0c
|= 0x50; /* OP1 on, OP0 on */
383 case SEC_VOLTAGE_OFF
:
392 if (state
->config
->op0_off
)
395 stv0299_writeregI(state
, 0x08, reg0x08
);
396 return stv0299_writeregI(state
, 0x0c, reg0x0c
);
399 static int stv0299_send_legacy_dish_cmd (struct dvb_frontend
* fe
, unsigned long cmd
)
401 struct stv0299_state
* state
= fe
->demodulator_priv
;
407 struct timeval nexttime
;
408 struct timeval tv
[10];
410 reg0x08
= stv0299_readreg (state
, 0x08);
411 reg0x0c
= stv0299_readreg (state
, 0x0c);
413 stv0299_writeregI (state
, 0x08, (reg0x08
& 0x3f) | (state
->config
->lock_output
<< 6));
414 if (state
->config
->volt13_op0_op1
== STV0299_VOLT13_OP0
)
418 if (debug_legacy_dish_switch
)
419 printk ("%s switch command: 0x%04lx\n",__func__
, cmd
);
421 do_gettimeofday (&nexttime
);
422 if (debug_legacy_dish_switch
)
423 memcpy (&tv
[0], &nexttime
, sizeof (struct timeval
));
424 stv0299_writeregI (state
, 0x0c, reg0x0c
| 0x50); /* set LNB to 18V */
426 dvb_frontend_sleep_until(&nexttime
, 32000);
428 for (i
=0; i
<9; i
++) {
429 if (debug_legacy_dish_switch
)
430 do_gettimeofday (&tv
[i
+1]);
431 if((cmd
& 0x01) != last
) {
432 /* set voltage to (last ? 13V : 18V) */
433 stv0299_writeregI (state
, 0x0c, reg0x0c
| (last
? lv_mask
: 0x50));
434 last
= (last
) ? 0 : 1;
440 dvb_frontend_sleep_until(&nexttime
, 8000);
442 if (debug_legacy_dish_switch
) {
443 printk ("%s(%d): switch delay (should be 32k followed by all 8k\n",
444 __func__
, fe
->dvb
->num
);
445 for (i
= 1; i
< 10; i
++)
446 printk ("%d: %d\n", i
, timeval_usec_diff(tv
[i
-1] , tv
[i
]));
452 static int stv0299_init (struct dvb_frontend
* fe
)
454 struct stv0299_state
* state
= fe
->demodulator_priv
;
459 dprintk("stv0299: init chip\n");
461 stv0299_writeregI(state
, 0x02, 0x30 | state
->mcr_reg
);
464 for (i
= 0; ; i
+= 2) {
465 reg
= state
->config
->inittab
[i
];
466 val
= state
->config
->inittab
[i
+1];
467 if (reg
== 0xff && val
== 0xff)
469 if (reg
== 0x0c && state
->config
->op0_off
)
472 state
->mcr_reg
= val
& 0xf;
473 stv0299_writeregI(state
, reg
, val
);
479 static int stv0299_read_status(struct dvb_frontend
* fe
, fe_status_t
* status
)
481 struct stv0299_state
* state
= fe
->demodulator_priv
;
483 u8 signal
= 0xff - stv0299_readreg (state
, 0x18);
484 u8 sync
= stv0299_readreg (state
, 0x1b);
486 dprintk ("%s : FE_READ_STATUS : VSTATUS: 0x%02x\n", __func__
, sync
);
490 *status
|= FE_HAS_SIGNAL
;
493 *status
|= FE_HAS_CARRIER
;
496 *status
|= FE_HAS_VITERBI
;
499 *status
|= FE_HAS_SYNC
;
501 if ((sync
& 0x98) == 0x98)
502 *status
|= FE_HAS_LOCK
;
507 static int stv0299_read_ber(struct dvb_frontend
* fe
, u32
* ber
)
509 struct stv0299_state
* state
= fe
->demodulator_priv
;
511 if (state
->errmode
!= STATUS_BER
)
514 *ber
= stv0299_readreg(state
, 0x1e) | (stv0299_readreg(state
, 0x1d) << 8);
519 static int stv0299_read_signal_strength(struct dvb_frontend
* fe
, u16
* strength
)
521 struct stv0299_state
* state
= fe
->demodulator_priv
;
523 s32 signal
= 0xffff - ((stv0299_readreg (state
, 0x18) << 8)
524 | stv0299_readreg (state
, 0x19));
526 dprintk ("%s : FE_READ_SIGNAL_STRENGTH : AGC2I: 0x%02x%02x, signal=0x%04x\n", __func__
,
527 stv0299_readreg (state
, 0x18),
528 stv0299_readreg (state
, 0x19), (int) signal
);
530 signal
= signal
* 5 / 4;
531 *strength
= (signal
> 0xffff) ? 0xffff : (signal
< 0) ? 0 : signal
;
536 static int stv0299_read_snr(struct dvb_frontend
* fe
, u16
* snr
)
538 struct stv0299_state
* state
= fe
->demodulator_priv
;
540 s32 xsnr
= 0xffff - ((stv0299_readreg (state
, 0x24) << 8)
541 | stv0299_readreg (state
, 0x25));
542 xsnr
= 3 * (xsnr
- 0xa100);
543 *snr
= (xsnr
> 0xffff) ? 0xffff : (xsnr
< 0) ? 0 : xsnr
;
548 static int stv0299_read_ucblocks(struct dvb_frontend
* fe
, u32
* ucblocks
)
550 struct stv0299_state
* state
= fe
->demodulator_priv
;
552 if (state
->errmode
!= STATUS_UCBLOCKS
)
555 state
->ucblocks
+= stv0299_readreg(state
, 0x1e);
556 state
->ucblocks
+= (stv0299_readreg(state
, 0x1d) << 8);
557 *ucblocks
= state
->ucblocks
;
562 static int stv0299_set_frontend(struct dvb_frontend
* fe
, struct dvb_frontend_parameters
* p
)
564 struct stv0299_state
* state
= fe
->demodulator_priv
;
567 dprintk ("%s : FE_SET_FRONTEND\n", __func__
);
568 if (state
->config
->set_ts_params
)
569 state
->config
->set_ts_params(fe
, 0);
572 if (p
->inversion
== INVERSION_OFF
) invval
= 0;
573 else if (p
->inversion
== INVERSION_ON
) invval
= 1;
575 printk("stv0299 does not support auto-inversion\n");
578 if (state
->config
->invert
) invval
= (~invval
) & 1;
579 stv0299_writeregI(state
, 0x0c, (stv0299_readreg(state
, 0x0c) & 0xfe) | invval
);
581 if (fe
->ops
.tuner_ops
.set_params
) {
582 fe
->ops
.tuner_ops
.set_params(fe
, p
);
583 if (fe
->ops
.i2c_gate_ctrl
) fe
->ops
.i2c_gate_ctrl(fe
, 0);
586 stv0299_set_FEC (state
, p
->u
.qpsk
.fec_inner
);
587 stv0299_set_symbolrate (fe
, p
->u
.qpsk
.symbol_rate
);
588 stv0299_writeregI(state
, 0x22, 0x00);
589 stv0299_writeregI(state
, 0x23, 0x00);
591 state
->tuner_frequency
= p
->frequency
;
592 state
->fec_inner
= p
->u
.qpsk
.fec_inner
;
593 state
->symbol_rate
= p
->u
.qpsk
.symbol_rate
;
598 static int stv0299_get_frontend(struct dvb_frontend
* fe
, struct dvb_frontend_parameters
* p
)
600 struct stv0299_state
* state
= fe
->demodulator_priv
;
604 derot_freq
= (s32
)(s16
) ((stv0299_readreg (state
, 0x22) << 8)
605 | stv0299_readreg (state
, 0x23));
607 derot_freq
*= (state
->config
->mclk
>> 16);
611 p
->frequency
+= derot_freq
;
613 invval
= stv0299_readreg (state
, 0x0c) & 1;
614 if (state
->config
->invert
) invval
= (~invval
) & 1;
615 p
->inversion
= invval
? INVERSION_ON
: INVERSION_OFF
;
617 p
->u
.qpsk
.fec_inner
= stv0299_get_fec (state
);
618 p
->u
.qpsk
.symbol_rate
= stv0299_get_symbolrate (state
);
623 static int stv0299_sleep(struct dvb_frontend
* fe
)
625 struct stv0299_state
* state
= fe
->demodulator_priv
;
627 stv0299_writeregI(state
, 0x02, 0xb0 | state
->mcr_reg
);
628 state
->initialised
= 0;
633 static int stv0299_i2c_gate_ctrl(struct dvb_frontend
* fe
, int enable
)
635 struct stv0299_state
* state
= fe
->demodulator_priv
;
638 stv0299_writeregI(state
, 0x05, 0xb5);
640 stv0299_writeregI(state
, 0x05, 0x35);
646 static int stv0299_get_tune_settings(struct dvb_frontend
* fe
, struct dvb_frontend_tune_settings
* fesettings
)
648 struct stv0299_state
* state
= fe
->demodulator_priv
;
650 fesettings
->min_delay_ms
= state
->config
->min_delay_ms
;
651 if (fesettings
->parameters
.u
.qpsk
.symbol_rate
< 10000000) {
652 fesettings
->step_size
= fesettings
->parameters
.u
.qpsk
.symbol_rate
/ 32000;
653 fesettings
->max_drift
= 5000;
655 fesettings
->step_size
= fesettings
->parameters
.u
.qpsk
.symbol_rate
/ 16000;
656 fesettings
->max_drift
= fesettings
->parameters
.u
.qpsk
.symbol_rate
/ 2000;
661 static void stv0299_release(struct dvb_frontend
* fe
)
663 struct stv0299_state
* state
= fe
->demodulator_priv
;
667 static struct dvb_frontend_ops stv0299_ops
;
669 struct dvb_frontend
* stv0299_attach(const struct stv0299_config
* config
,
670 struct i2c_adapter
* i2c
)
672 struct stv0299_state
* state
= NULL
;
675 /* allocate memory for the internal state */
676 state
= kzalloc(sizeof(struct stv0299_state
), GFP_KERNEL
);
677 if (state
== NULL
) goto error
;
679 /* setup the state */
680 state
->config
= config
;
682 state
->initialised
= 0;
683 state
->tuner_frequency
= 0;
684 state
->symbol_rate
= 0;
685 state
->fec_inner
= 0;
686 state
->errmode
= STATUS_BER
;
688 /* check if the demod is there */
689 stv0299_writeregI(state
, 0x02, 0x30); /* standby off */
691 id
= stv0299_readreg(state
, 0x00);
693 /* register 0x00 contains 0xa1 for STV0299 and STV0299B */
694 /* register 0x00 might contain 0x80 when returning from standby */
695 if (id
!= 0xa1 && id
!= 0x80) goto error
;
697 /* create dvb_frontend */
698 memcpy(&state
->frontend
.ops
, &stv0299_ops
, sizeof(struct dvb_frontend_ops
));
699 state
->frontend
.demodulator_priv
= state
;
700 return &state
->frontend
;
707 static struct dvb_frontend_ops stv0299_ops
= {
710 .name
= "ST STV0299 DVB-S",
712 .frequency_min
= 950000,
713 .frequency_max
= 2150000,
714 .frequency_stepsize
= 125, /* kHz for QPSK frontends */
715 .frequency_tolerance
= 0,
716 .symbol_rate_min
= 1000000,
717 .symbol_rate_max
= 45000000,
718 .symbol_rate_tolerance
= 500, /* ppm */
719 .caps
= FE_CAN_FEC_1_2
| FE_CAN_FEC_2_3
| FE_CAN_FEC_3_4
|
720 FE_CAN_FEC_5_6
| FE_CAN_FEC_7_8
|
725 .release
= stv0299_release
,
727 .init
= stv0299_init
,
728 .sleep
= stv0299_sleep
,
729 .write
= stv0299_write
,
730 .i2c_gate_ctrl
= stv0299_i2c_gate_ctrl
,
732 .set_frontend
= stv0299_set_frontend
,
733 .get_frontend
= stv0299_get_frontend
,
734 .get_tune_settings
= stv0299_get_tune_settings
,
736 .read_status
= stv0299_read_status
,
737 .read_ber
= stv0299_read_ber
,
738 .read_signal_strength
= stv0299_read_signal_strength
,
739 .read_snr
= stv0299_read_snr
,
740 .read_ucblocks
= stv0299_read_ucblocks
,
742 .diseqc_send_master_cmd
= stv0299_send_diseqc_msg
,
743 .diseqc_send_burst
= stv0299_send_diseqc_burst
,
744 .set_tone
= stv0299_set_tone
,
745 .set_voltage
= stv0299_set_voltage
,
746 .dishnetwork_send_legacy_command
= stv0299_send_legacy_dish_cmd
,
749 module_param(debug_legacy_dish_switch
, int, 0444);
750 MODULE_PARM_DESC(debug_legacy_dish_switch
, "Enable timing analysis for Dish Network legacy switches");
752 module_param(debug
, int, 0644);
753 MODULE_PARM_DESC(debug
, "Turn on/off frontend debugging (default:off).");
755 MODULE_DESCRIPTION("ST STV0299 DVB Demodulator driver");
756 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Peter Schildmann, Felix Domke, "
757 "Andreas Oberritter, Andrew de Quincey, Kenneth Aafly");
758 MODULE_LICENSE("GPL");
760 EXPORT_SYMBOL(stv0299_attach
);