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
;
69 #define STATUS_UCBLOCKS 1
72 static int debug_legacy_dish_switch
;
73 #define dprintk(args...) \
75 if (debug) printk(KERN_DEBUG "stv0299: " args); \
79 static int stv0299_writeregI (struct stv0299_state
* state
, u8 reg
, u8 data
)
82 u8 buf
[] = { reg
, data
};
83 struct i2c_msg msg
= { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= buf
, .len
= 2 };
85 ret
= i2c_transfer (state
->i2c
, &msg
, 1);
88 dprintk("%s: writereg error (reg == 0x%02x, val == 0x%02x, "
89 "ret == %i)\n", __FUNCTION__
, reg
, data
, ret
);
91 return (ret
!= 1) ? -EREMOTEIO
: 0;
94 static int stv0299_write(struct dvb_frontend
* fe
, u8
*buf
, int len
)
96 struct stv0299_state
* state
= fe
->demodulator_priv
;
101 return stv0299_writeregI(state
, buf
[0], buf
[1]);
104 static u8
stv0299_readreg (struct stv0299_state
* state
, u8 reg
)
109 struct i2c_msg msg
[] = { { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= b0
, .len
= 1 },
110 { .addr
= state
->config
->demod_address
, .flags
= I2C_M_RD
, .buf
= b1
, .len
= 1 } };
112 ret
= i2c_transfer (state
->i2c
, msg
, 2);
115 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n",
116 __FUNCTION__
, reg
, ret
);
121 static int stv0299_readregs (struct stv0299_state
* state
, u8 reg1
, u8
*b
, u8 len
)
124 struct i2c_msg msg
[] = { { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= ®1
, .len
= 1 },
125 { .addr
= state
->config
->demod_address
, .flags
= I2C_M_RD
, .buf
= b
, .len
= len
} };
127 ret
= i2c_transfer (state
->i2c
, msg
, 2);
130 dprintk("%s: readreg error (ret == %i)\n", __FUNCTION__
, ret
);
132 return ret
== 2 ? 0 : ret
;
135 static int stv0299_set_FEC (struct stv0299_state
* state
, fe_code_rate_t fec
)
137 dprintk ("%s\n", __FUNCTION__
);
142 return stv0299_writeregI (state
, 0x31, 0x1f);
146 return stv0299_writeregI (state
, 0x31, 0x01);
150 return stv0299_writeregI (state
, 0x31, 0x02);
154 return stv0299_writeregI (state
, 0x31, 0x04);
158 return stv0299_writeregI (state
, 0x31, 0x08);
162 return stv0299_writeregI (state
, 0x31, 0x10);
171 static fe_code_rate_t
stv0299_get_fec (struct stv0299_state
* state
)
173 static fe_code_rate_t fec_tab
[] = { FEC_2_3
, FEC_3_4
, FEC_5_6
,
177 dprintk ("%s\n", __FUNCTION__
);
179 index
= stv0299_readreg (state
, 0x1b);
185 return fec_tab
[index
];
188 static int stv0299_wait_diseqc_fifo (struct stv0299_state
* state
, int timeout
)
190 unsigned long start
= jiffies
;
192 dprintk ("%s\n", __FUNCTION__
);
194 while (stv0299_readreg(state
, 0x0a) & 1) {
195 if (jiffies
- start
> timeout
) {
196 dprintk ("%s: timeout!!\n", __FUNCTION__
);
205 static int stv0299_wait_diseqc_idle (struct stv0299_state
* state
, int timeout
)
207 unsigned long start
= jiffies
;
209 dprintk ("%s\n", __FUNCTION__
);
211 while ((stv0299_readreg(state
, 0x0a) & 3) != 2 ) {
212 if (jiffies
- start
> timeout
) {
213 dprintk ("%s: timeout!!\n", __FUNCTION__
);
222 static int stv0299_set_symbolrate (struct dvb_frontend
* fe
, u32 srate
)
224 struct stv0299_state
* state
= fe
->demodulator_priv
;
228 // check rate is within limits
229 if ((srate
< 1000000) || (srate
> 45000000)) return -EINVAL
;
231 // calculate value to program
233 big
+= (state
->config
->mclk
-1); // round correctly
234 do_div(big
, state
->config
->mclk
);
237 return state
->config
->set_symbol_rate(fe
, srate
, ratio
);
240 static int stv0299_get_symbolrate (struct stv0299_state
* state
)
242 u32 Mclk
= state
->config
->mclk
/ 4096L;
248 dprintk ("%s\n", __FUNCTION__
);
250 stv0299_readregs (state
, 0x1f, sfr
, 3);
251 stv0299_readregs (state
, 0x1a, (u8
*)&rtf
, 1);
253 srate
= (sfr
[0] << 8) | sfr
[1];
256 srate
+= (sfr
[2] >> 4) * Mclk
/ 256;
257 offset
= (s32
) rtf
* (srate
/ 4096L);
260 dprintk ("%s : srate = %i\n", __FUNCTION__
, srate
);
261 dprintk ("%s : ofset = %i\n", __FUNCTION__
, offset
);
272 static int stv0299_send_diseqc_msg (struct dvb_frontend
* fe
,
273 struct dvb_diseqc_master_cmd
*m
)
275 struct stv0299_state
* state
= fe
->demodulator_priv
;
279 dprintk ("%s\n", __FUNCTION__
);
281 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
284 val
= stv0299_readreg (state
, 0x08);
286 if (stv0299_writeregI (state
, 0x08, (val
& ~0x7) | 0x6)) /* DiSEqC mode */
289 for (i
=0; i
<m
->msg_len
; i
++) {
290 if (stv0299_wait_diseqc_fifo (state
, 100) < 0)
293 if (stv0299_writeregI (state
, 0x09, m
->msg
[i
]))
297 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
303 static int stv0299_send_diseqc_burst (struct dvb_frontend
* fe
, fe_sec_mini_cmd_t burst
)
305 struct stv0299_state
* state
= fe
->demodulator_priv
;
308 dprintk ("%s\n", __FUNCTION__
);
310 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
313 val
= stv0299_readreg (state
, 0x08);
315 if (stv0299_writeregI (state
, 0x08, (val
& ~0x7) | 0x2)) /* burst mode */
318 if (stv0299_writeregI (state
, 0x09, burst
== SEC_MINI_A
? 0x00 : 0xff))
321 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
324 if (stv0299_writeregI (state
, 0x08, val
))
330 static int stv0299_set_tone (struct dvb_frontend
* fe
, fe_sec_tone_mode_t tone
)
332 struct stv0299_state
* state
= fe
->demodulator_priv
;
335 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
338 val
= stv0299_readreg (state
, 0x08);
342 return stv0299_writeregI (state
, 0x08, val
| 0x3);
345 return stv0299_writeregI (state
, 0x08, (val
& ~0x3) | 0x02);
352 static int stv0299_set_voltage (struct dvb_frontend
* fe
, fe_sec_voltage_t voltage
)
354 struct stv0299_state
* state
= fe
->demodulator_priv
;
358 dprintk("%s: %s\n", __FUNCTION__
,
359 voltage
== SEC_VOLTAGE_13
? "SEC_VOLTAGE_13" :
360 voltage
== SEC_VOLTAGE_18
? "SEC_VOLTAGE_18" : "??");
362 reg0x08
= stv0299_readreg (state
, 0x08);
363 reg0x0c
= stv0299_readreg (state
, 0x0c);
366 * H/V switching over OP0, OP1 and OP2 are LNB power enable bits
370 if (voltage
== SEC_VOLTAGE_OFF
) {
371 stv0299_writeregI (state
, 0x0c, 0x00); /* LNB power off! */
372 return stv0299_writeregI (state
, 0x08, 0x00); /* LNB power off! */
375 stv0299_writeregI (state
, 0x08, (reg0x08
& 0x3f) | (state
->config
->lock_output
<< 6));
379 if (state
->config
->volt13_op0_op1
== STV0299_VOLT13_OP0
) reg0x0c
|= 0x10;
380 else reg0x0c
|= 0x40;
382 return stv0299_writeregI(state
, 0x0c, reg0x0c
);
385 return stv0299_writeregI(state
, 0x0c, reg0x0c
| 0x50);
391 static int stv0299_send_legacy_dish_cmd (struct dvb_frontend
* fe
, unsigned long cmd
)
393 struct stv0299_state
* state
= fe
->demodulator_priv
;
399 struct timeval nexttime
;
400 struct timeval tv
[10];
402 reg0x08
= stv0299_readreg (state
, 0x08);
403 reg0x0c
= stv0299_readreg (state
, 0x0c);
405 stv0299_writeregI (state
, 0x08, (reg0x08
& 0x3f) | (state
->config
->lock_output
<< 6));
406 if (state
->config
->volt13_op0_op1
== STV0299_VOLT13_OP0
)
410 if (debug_legacy_dish_switch
)
411 printk ("%s switch command: 0x%04lx\n",__FUNCTION__
, cmd
);
413 do_gettimeofday (&nexttime
);
414 if (debug_legacy_dish_switch
)
415 memcpy (&tv
[0], &nexttime
, sizeof (struct timeval
));
416 stv0299_writeregI (state
, 0x0c, reg0x0c
| 0x50); /* set LNB to 18V */
418 dvb_frontend_sleep_until(&nexttime
, 32000);
420 for (i
=0; i
<9; i
++) {
421 if (debug_legacy_dish_switch
)
422 do_gettimeofday (&tv
[i
+1]);
423 if((cmd
& 0x01) != last
) {
424 /* set voltage to (last ? 13V : 18V) */
425 stv0299_writeregI (state
, 0x0c, reg0x0c
| (last
? lv_mask
: 0x50));
426 last
= (last
) ? 0 : 1;
432 dvb_frontend_sleep_until(&nexttime
, 8000);
434 if (debug_legacy_dish_switch
) {
435 printk ("%s(%d): switch delay (should be 32k followed by all 8k\n",
436 __FUNCTION__
, fe
->dvb
->num
);
437 for (i
= 1; i
< 10; i
++)
438 printk ("%d: %d\n", i
, timeval_usec_diff(tv
[i
-1] , tv
[i
]));
444 static int stv0299_init (struct dvb_frontend
* fe
)
446 struct stv0299_state
* state
= fe
->demodulator_priv
;
449 dprintk("stv0299: init chip\n");
451 for (i
=0; !(state
->config
->inittab
[i
] == 0xff && state
->config
->inittab
[i
+1] == 0xff); i
+=2)
452 stv0299_writeregI(state
, state
->config
->inittab
[i
], state
->config
->inittab
[i
+1]);
457 static int stv0299_read_status(struct dvb_frontend
* fe
, fe_status_t
* status
)
459 struct stv0299_state
* state
= fe
->demodulator_priv
;
461 u8 signal
= 0xff - stv0299_readreg (state
, 0x18);
462 u8 sync
= stv0299_readreg (state
, 0x1b);
464 dprintk ("%s : FE_READ_STATUS : VSTATUS: 0x%02x\n", __FUNCTION__
, sync
);
468 *status
|= FE_HAS_SIGNAL
;
471 *status
|= FE_HAS_CARRIER
;
474 *status
|= FE_HAS_VITERBI
;
477 *status
|= FE_HAS_SYNC
;
479 if ((sync
& 0x98) == 0x98)
480 *status
|= FE_HAS_LOCK
;
485 static int stv0299_read_ber(struct dvb_frontend
* fe
, u32
* ber
)
487 struct stv0299_state
* state
= fe
->demodulator_priv
;
489 if (state
->errmode
!= STATUS_BER
) return 0;
490 *ber
= (stv0299_readreg (state
, 0x1d) << 8) | stv0299_readreg (state
, 0x1e);
495 static int stv0299_read_signal_strength(struct dvb_frontend
* fe
, u16
* strength
)
497 struct stv0299_state
* state
= fe
->demodulator_priv
;
499 s32 signal
= 0xffff - ((stv0299_readreg (state
, 0x18) << 8)
500 | stv0299_readreg (state
, 0x19));
502 dprintk ("%s : FE_READ_SIGNAL_STRENGTH : AGC2I: 0x%02x%02x, signal=0x%04x\n", __FUNCTION__
,
503 stv0299_readreg (state
, 0x18),
504 stv0299_readreg (state
, 0x19), (int) signal
);
506 signal
= signal
* 5 / 4;
507 *strength
= (signal
> 0xffff) ? 0xffff : (signal
< 0) ? 0 : signal
;
512 static int stv0299_read_snr(struct dvb_frontend
* fe
, u16
* snr
)
514 struct stv0299_state
* state
= fe
->demodulator_priv
;
516 s32 xsnr
= 0xffff - ((stv0299_readreg (state
, 0x24) << 8)
517 | stv0299_readreg (state
, 0x25));
518 xsnr
= 3 * (xsnr
- 0xa100);
519 *snr
= (xsnr
> 0xffff) ? 0xffff : (xsnr
< 0) ? 0 : xsnr
;
524 static int stv0299_read_ucblocks(struct dvb_frontend
* fe
, u32
* ucblocks
)
526 struct stv0299_state
* state
= fe
->demodulator_priv
;
528 if (state
->errmode
!= STATUS_UCBLOCKS
) *ucblocks
= 0;
529 else *ucblocks
= (stv0299_readreg (state
, 0x1d) << 8) | stv0299_readreg (state
, 0x1e);
534 static int stv0299_set_frontend(struct dvb_frontend
* fe
, struct dvb_frontend_parameters
* p
)
536 struct stv0299_state
* state
= fe
->demodulator_priv
;
539 dprintk ("%s : FE_SET_FRONTEND\n", __FUNCTION__
);
542 if (p
->inversion
== INVERSION_OFF
) invval
= 0;
543 else if (p
->inversion
== INVERSION_ON
) invval
= 1;
545 printk("stv0299 does not support auto-inversion\n");
548 if (state
->config
->invert
) invval
= (~invval
) & 1;
549 stv0299_writeregI(state
, 0x0c, (stv0299_readreg(state
, 0x0c) & 0xfe) | invval
);
551 if (fe
->ops
.tuner_ops
.set_params
) {
552 fe
->ops
.tuner_ops
.set_params(fe
, p
);
553 if (fe
->ops
.i2c_gate_ctrl
) fe
->ops
.i2c_gate_ctrl(fe
, 0);
556 stv0299_set_FEC (state
, p
->u
.qpsk
.fec_inner
);
557 stv0299_set_symbolrate (fe
, p
->u
.qpsk
.symbol_rate
);
558 stv0299_writeregI(state
, 0x22, 0x00);
559 stv0299_writeregI(state
, 0x23, 0x00);
561 state
->tuner_frequency
= p
->frequency
;
562 state
->fec_inner
= p
->u
.qpsk
.fec_inner
;
563 state
->symbol_rate
= p
->u
.qpsk
.symbol_rate
;
568 static int stv0299_get_frontend(struct dvb_frontend
* fe
, struct dvb_frontend_parameters
* p
)
570 struct stv0299_state
* state
= fe
->demodulator_priv
;
574 derot_freq
= (s32
)(s16
) ((stv0299_readreg (state
, 0x22) << 8)
575 | stv0299_readreg (state
, 0x23));
577 derot_freq
*= (state
->config
->mclk
>> 16);
581 p
->frequency
+= derot_freq
;
583 invval
= stv0299_readreg (state
, 0x0c) & 1;
584 if (state
->config
->invert
) invval
= (~invval
) & 1;
585 p
->inversion
= invval
? INVERSION_ON
: INVERSION_OFF
;
587 p
->u
.qpsk
.fec_inner
= stv0299_get_fec (state
);
588 p
->u
.qpsk
.symbol_rate
= stv0299_get_symbolrate (state
);
593 static int stv0299_sleep(struct dvb_frontend
* fe
)
595 struct stv0299_state
* state
= fe
->demodulator_priv
;
597 stv0299_writeregI(state
, 0x02, 0x80);
598 state
->initialised
= 0;
603 static int stv0299_i2c_gate_ctrl(struct dvb_frontend
* fe
, int enable
)
605 struct stv0299_state
* state
= fe
->demodulator_priv
;
608 stv0299_writeregI(state
, 0x05, 0xb5);
610 stv0299_writeregI(state
, 0x05, 0x35);
616 static int stv0299_get_tune_settings(struct dvb_frontend
* fe
, struct dvb_frontend_tune_settings
* fesettings
)
618 struct stv0299_state
* state
= fe
->demodulator_priv
;
620 fesettings
->min_delay_ms
= state
->config
->min_delay_ms
;
621 if (fesettings
->parameters
.u
.qpsk
.symbol_rate
< 10000000) {
622 fesettings
->step_size
= fesettings
->parameters
.u
.qpsk
.symbol_rate
/ 32000;
623 fesettings
->max_drift
= 5000;
625 fesettings
->step_size
= fesettings
->parameters
.u
.qpsk
.symbol_rate
/ 16000;
626 fesettings
->max_drift
= fesettings
->parameters
.u
.qpsk
.symbol_rate
/ 2000;
631 static void stv0299_release(struct dvb_frontend
* fe
)
633 struct stv0299_state
* state
= fe
->demodulator_priv
;
637 static struct dvb_frontend_ops stv0299_ops
;
639 struct dvb_frontend
* stv0299_attach(const struct stv0299_config
* config
,
640 struct i2c_adapter
* i2c
)
642 struct stv0299_state
* state
= NULL
;
645 /* allocate memory for the internal state */
646 state
= kmalloc(sizeof(struct stv0299_state
), GFP_KERNEL
);
647 if (state
== NULL
) goto error
;
649 /* setup the state */
650 state
->config
= config
;
652 state
->initialised
= 0;
653 state
->tuner_frequency
= 0;
654 state
->symbol_rate
= 0;
655 state
->fec_inner
= 0;
656 state
->errmode
= STATUS_BER
;
658 /* check if the demod is there */
659 stv0299_writeregI(state
, 0x02, 0x34); /* standby off */
661 id
= stv0299_readreg(state
, 0x00);
663 /* register 0x00 contains 0xa1 for STV0299 and STV0299B */
664 /* register 0x00 might contain 0x80 when returning from standby */
665 if (id
!= 0xa1 && id
!= 0x80) goto error
;
667 /* create dvb_frontend */
668 memcpy(&state
->frontend
.ops
, &stv0299_ops
, sizeof(struct dvb_frontend_ops
));
669 state
->frontend
.demodulator_priv
= state
;
670 return &state
->frontend
;
677 static struct dvb_frontend_ops stv0299_ops
= {
680 .name
= "ST STV0299 DVB-S",
682 .frequency_min
= 950000,
683 .frequency_max
= 2150000,
684 .frequency_stepsize
= 125, /* kHz for QPSK frontends */
685 .frequency_tolerance
= 0,
686 .symbol_rate_min
= 1000000,
687 .symbol_rate_max
= 45000000,
688 .symbol_rate_tolerance
= 500, /* ppm */
689 .caps
= FE_CAN_FEC_1_2
| FE_CAN_FEC_2_3
| FE_CAN_FEC_3_4
|
690 FE_CAN_FEC_5_6
| FE_CAN_FEC_7_8
|
695 .release
= stv0299_release
,
697 .init
= stv0299_init
,
698 .sleep
= stv0299_sleep
,
699 .write
= stv0299_write
,
700 .i2c_gate_ctrl
= stv0299_i2c_gate_ctrl
,
702 .set_frontend
= stv0299_set_frontend
,
703 .get_frontend
= stv0299_get_frontend
,
704 .get_tune_settings
= stv0299_get_tune_settings
,
706 .read_status
= stv0299_read_status
,
707 .read_ber
= stv0299_read_ber
,
708 .read_signal_strength
= stv0299_read_signal_strength
,
709 .read_snr
= stv0299_read_snr
,
710 .read_ucblocks
= stv0299_read_ucblocks
,
712 .diseqc_send_master_cmd
= stv0299_send_diseqc_msg
,
713 .diseqc_send_burst
= stv0299_send_diseqc_burst
,
714 .set_tone
= stv0299_set_tone
,
715 .set_voltage
= stv0299_set_voltage
,
716 .dishnetwork_send_legacy_command
= stv0299_send_legacy_dish_cmd
,
719 module_param(debug_legacy_dish_switch
, int, 0444);
720 MODULE_PARM_DESC(debug_legacy_dish_switch
, "Enable timing analysis for Dish Network legacy switches");
722 module_param(debug
, int, 0644);
723 MODULE_PARM_DESC(debug
, "Turn on/off frontend debugging (default:off).");
725 MODULE_DESCRIPTION("ST STV0299 DVB Demodulator driver");
726 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Peter Schildmann, Felix Domke, "
727 "Andreas Oberritter, Andrew de Quincey, Kenneth Aafly");
728 MODULE_LICENSE("GPL");
730 EXPORT_SYMBOL(stv0299_attach
);