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/ktime.h>
48 #include <linux/module.h>
49 #include <linux/string.h>
50 #include <linux/slab.h>
51 #include <linux/jiffies.h>
52 #include <asm/div64.h>
54 #include <media/dvb_frontend.h>
57 struct stv0299_state
{
58 struct i2c_adapter
* i2c
;
59 const struct stv0299_config
* config
;
60 struct dvb_frontend frontend
;
65 enum fe_code_rate fec_inner
;
72 #define STATUS_UCBLOCKS 1
75 static int debug_legacy_dish_switch
;
76 #define dprintk(args...) \
78 if (debug) printk(KERN_DEBUG "stv0299: " args); \
82 static int stv0299_writeregI (struct stv0299_state
* state
, u8 reg
, u8 data
)
85 u8 buf
[] = { reg
, data
};
86 struct i2c_msg msg
= { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= buf
, .len
= 2 };
88 ret
= i2c_transfer (state
->i2c
, &msg
, 1);
91 dprintk("%s: writereg error (reg == 0x%02x, val == 0x%02x, ret == %i)\n",
92 __func__
, reg
, data
, ret
);
94 return (ret
!= 1) ? -EREMOTEIO
: 0;
97 static int stv0299_write(struct dvb_frontend
* fe
, const u8 buf
[], int len
)
99 struct stv0299_state
* state
= fe
->demodulator_priv
;
104 return stv0299_writeregI(state
, buf
[0], buf
[1]);
107 static u8
stv0299_readreg (struct stv0299_state
* state
, u8 reg
)
112 struct i2c_msg msg
[] = { { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= b0
, .len
= 1 },
113 { .addr
= state
->config
->demod_address
, .flags
= I2C_M_RD
, .buf
= b1
, .len
= 1 } };
115 ret
= i2c_transfer (state
->i2c
, msg
, 2);
118 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n",
124 static int stv0299_readregs (struct stv0299_state
* state
, u8 reg1
, u8
*b
, u8 len
)
127 struct i2c_msg msg
[] = { { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= ®1
, .len
= 1 },
128 { .addr
= state
->config
->demod_address
, .flags
= I2C_M_RD
, .buf
= b
, .len
= len
} };
130 ret
= i2c_transfer (state
->i2c
, msg
, 2);
133 dprintk("%s: readreg error (ret == %i)\n", __func__
, ret
);
135 return ret
== 2 ? 0 : ret
;
138 static int stv0299_set_FEC(struct stv0299_state
*state
, enum fe_code_rate fec
)
140 dprintk ("%s\n", __func__
);
145 return stv0299_writeregI (state
, 0x31, 0x1f);
149 return stv0299_writeregI (state
, 0x31, 0x01);
153 return stv0299_writeregI (state
, 0x31, 0x02);
157 return stv0299_writeregI (state
, 0x31, 0x04);
161 return stv0299_writeregI (state
, 0x31, 0x08);
165 return stv0299_writeregI (state
, 0x31, 0x10);
174 static enum fe_code_rate
stv0299_get_fec(struct stv0299_state
*state
)
176 static enum fe_code_rate fec_tab
[] = { FEC_2_3
, FEC_3_4
, FEC_5_6
,
180 dprintk ("%s\n", __func__
);
182 index
= stv0299_readreg (state
, 0x1b);
188 return fec_tab
[index
];
191 static int stv0299_wait_diseqc_fifo (struct stv0299_state
* state
, int timeout
)
193 unsigned long start
= jiffies
;
195 dprintk ("%s\n", __func__
);
197 while (stv0299_readreg(state
, 0x0a) & 1) {
198 if (jiffies
- start
> timeout
) {
199 dprintk ("%s: timeout!!\n", __func__
);
208 static int stv0299_wait_diseqc_idle (struct stv0299_state
* state
, int timeout
)
210 unsigned long start
= jiffies
;
212 dprintk ("%s\n", __func__
);
214 while ((stv0299_readreg(state
, 0x0a) & 3) != 2 ) {
215 if (jiffies
- start
> timeout
) {
216 dprintk ("%s: timeout!!\n", __func__
);
225 static int stv0299_set_symbolrate (struct dvb_frontend
* fe
, u32 srate
)
227 struct stv0299_state
* state
= fe
->demodulator_priv
;
231 // check rate is within limits
232 if ((srate
< 1000000) || (srate
> 45000000)) return -EINVAL
;
234 // calculate value to program
236 big
+= (state
->config
->mclk
-1); // round correctly
237 do_div(big
, state
->config
->mclk
);
240 return state
->config
->set_symbol_rate(fe
, srate
, ratio
);
243 static int stv0299_get_symbolrate (struct stv0299_state
* state
)
245 u32 Mclk
= state
->config
->mclk
/ 4096L;
251 dprintk ("%s\n", __func__
);
253 stv0299_readregs (state
, 0x1f, sfr
, 3);
254 stv0299_readregs (state
, 0x1a, (u8
*)&rtf
, 1);
256 srate
= (sfr
[0] << 8) | sfr
[1];
259 srate
+= (sfr
[2] >> 4) * Mclk
/ 256;
260 offset
= (s32
) rtf
* (srate
/ 4096L);
263 dprintk ("%s : srate = %i\n", __func__
, srate
);
264 dprintk ("%s : ofset = %i\n", __func__
, offset
);
275 static int stv0299_send_diseqc_msg (struct dvb_frontend
* fe
,
276 struct dvb_diseqc_master_cmd
*m
)
278 struct stv0299_state
* state
= fe
->demodulator_priv
;
282 dprintk ("%s\n", __func__
);
284 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
287 val
= stv0299_readreg (state
, 0x08);
289 if (stv0299_writeregI (state
, 0x08, (val
& ~0x7) | 0x6)) /* DiSEqC mode */
292 for (i
=0; i
<m
->msg_len
; i
++) {
293 if (stv0299_wait_diseqc_fifo (state
, 100) < 0)
296 if (stv0299_writeregI (state
, 0x09, m
->msg
[i
]))
300 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
306 static int stv0299_send_diseqc_burst(struct dvb_frontend
*fe
,
307 enum fe_sec_mini_cmd burst
)
309 struct stv0299_state
* state
= fe
->demodulator_priv
;
312 dprintk ("%s\n", __func__
);
314 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
317 val
= stv0299_readreg (state
, 0x08);
319 if (stv0299_writeregI (state
, 0x08, (val
& ~0x7) | 0x2)) /* burst mode */
322 if (stv0299_writeregI (state
, 0x09, burst
== SEC_MINI_A
? 0x00 : 0xff))
325 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
328 if (stv0299_writeregI (state
, 0x08, val
))
334 static int stv0299_set_tone(struct dvb_frontend
*fe
,
335 enum fe_sec_tone_mode tone
)
337 struct stv0299_state
* state
= fe
->demodulator_priv
;
340 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
343 val
= stv0299_readreg (state
, 0x08);
347 return stv0299_writeregI (state
, 0x08, val
| 0x3);
350 return stv0299_writeregI (state
, 0x08, (val
& ~0x3) | 0x02);
357 static int stv0299_set_voltage(struct dvb_frontend
*fe
,
358 enum fe_sec_voltage voltage
)
360 struct stv0299_state
* state
= fe
->demodulator_priv
;
364 dprintk("%s: %s\n", __func__
,
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
375 reg0x08
= (reg0x08
& 0x3f) | (state
->config
->lock_output
<< 6);
379 if (state
->config
->volt13_op0_op1
== STV0299_VOLT13_OP0
)
380 reg0x0c
|= 0x10; /* OP1 off, OP0 on */
382 reg0x0c
|= 0x40; /* OP1 on, OP0 off */
385 reg0x0c
|= 0x50; /* OP1 on, OP0 on */
387 case SEC_VOLTAGE_OFF
:
396 if (state
->config
->op0_off
)
399 stv0299_writeregI(state
, 0x08, reg0x08
);
400 return stv0299_writeregI(state
, 0x0c, reg0x0c
);
403 static int stv0299_send_legacy_dish_cmd (struct dvb_frontend
* fe
, unsigned long cmd
)
405 struct stv0299_state
* state
= fe
->demodulator_priv
;
414 reg0x08
= stv0299_readreg (state
, 0x08);
415 reg0x0c
= stv0299_readreg (state
, 0x0c);
417 stv0299_writeregI (state
, 0x08, (reg0x08
& 0x3f) | (state
->config
->lock_output
<< 6));
418 if (state
->config
->volt13_op0_op1
== STV0299_VOLT13_OP0
)
422 if (debug_legacy_dish_switch
)
423 printk ("%s switch command: 0x%04lx\n",__func__
, cmd
);
425 nexttime
= ktime_get_boottime();
426 if (debug_legacy_dish_switch
)
428 stv0299_writeregI (state
, 0x0c, reg0x0c
| 0x50); /* set LNB to 18V */
430 dvb_frontend_sleep_until(&nexttime
, 32000);
432 for (i
=0; i
<9; i
++) {
433 if (debug_legacy_dish_switch
)
434 tv
[i
+1] = ktime_get_boottime();
435 if((cmd
& 0x01) != last
) {
436 /* set voltage to (last ? 13V : 18V) */
437 stv0299_writeregI (state
, 0x0c, reg0x0c
| (last
? lv_mask
: 0x50));
438 last
= (last
) ? 0 : 1;
444 dvb_frontend_sleep_until(&nexttime
, 8000);
446 if (debug_legacy_dish_switch
) {
447 printk ("%s(%d): switch delay (should be 32k followed by all 8k\n",
448 __func__
, fe
->dvb
->num
);
449 for (i
= 1; i
< 10; i
++)
450 printk("%d: %d\n", i
,
451 (int) ktime_us_delta(tv
[i
], tv
[i
-1]));
457 static int stv0299_init (struct dvb_frontend
* fe
)
459 struct stv0299_state
* state
= fe
->demodulator_priv
;
464 dprintk("stv0299: init chip\n");
466 stv0299_writeregI(state
, 0x02, 0x30 | state
->mcr_reg
);
469 for (i
= 0; ; i
+= 2) {
470 reg
= state
->config
->inittab
[i
];
471 val
= state
->config
->inittab
[i
+1];
472 if (reg
== 0xff && val
== 0xff)
474 if (reg
== 0x0c && state
->config
->op0_off
)
477 state
->mcr_reg
= val
& 0xf;
478 stv0299_writeregI(state
, reg
, val
);
484 static int stv0299_read_status(struct dvb_frontend
*fe
,
485 enum fe_status
*status
)
487 struct stv0299_state
* state
= fe
->demodulator_priv
;
489 u8 signal
= 0xff - stv0299_readreg (state
, 0x18);
490 u8 sync
= stv0299_readreg (state
, 0x1b);
492 dprintk ("%s : FE_READ_STATUS : VSTATUS: 0x%02x\n", __func__
, sync
);
496 *status
|= FE_HAS_SIGNAL
;
499 *status
|= FE_HAS_CARRIER
;
502 *status
|= FE_HAS_VITERBI
;
505 *status
|= FE_HAS_SYNC
;
507 if ((sync
& 0x98) == 0x98)
508 *status
|= FE_HAS_LOCK
;
513 static int stv0299_read_ber(struct dvb_frontend
* fe
, u32
* ber
)
515 struct stv0299_state
* state
= fe
->demodulator_priv
;
517 if (state
->errmode
!= STATUS_BER
)
520 *ber
= stv0299_readreg(state
, 0x1e) | (stv0299_readreg(state
, 0x1d) << 8);
525 static int stv0299_read_signal_strength(struct dvb_frontend
* fe
, u16
* strength
)
527 struct stv0299_state
* state
= fe
->demodulator_priv
;
529 s32 signal
= 0xffff - ((stv0299_readreg (state
, 0x18) << 8)
530 | stv0299_readreg (state
, 0x19));
532 dprintk ("%s : FE_READ_SIGNAL_STRENGTH : AGC2I: 0x%02x%02x, signal=0x%04x\n", __func__
,
533 stv0299_readreg (state
, 0x18),
534 stv0299_readreg (state
, 0x19), (int) signal
);
536 signal
= signal
* 5 / 4;
537 *strength
= (signal
> 0xffff) ? 0xffff : (signal
< 0) ? 0 : signal
;
542 static int stv0299_read_snr(struct dvb_frontend
* fe
, u16
* snr
)
544 struct stv0299_state
* state
= fe
->demodulator_priv
;
546 s32 xsnr
= 0xffff - ((stv0299_readreg (state
, 0x24) << 8)
547 | stv0299_readreg (state
, 0x25));
548 xsnr
= 3 * (xsnr
- 0xa100);
549 *snr
= (xsnr
> 0xffff) ? 0xffff : (xsnr
< 0) ? 0 : xsnr
;
554 static int stv0299_read_ucblocks(struct dvb_frontend
* fe
, u32
* ucblocks
)
556 struct stv0299_state
* state
= fe
->demodulator_priv
;
558 if (state
->errmode
!= STATUS_UCBLOCKS
)
561 state
->ucblocks
+= stv0299_readreg(state
, 0x1e);
562 state
->ucblocks
+= (stv0299_readreg(state
, 0x1d) << 8);
563 *ucblocks
= state
->ucblocks
;
568 static int stv0299_set_frontend(struct dvb_frontend
*fe
)
570 struct dtv_frontend_properties
*p
= &fe
->dtv_property_cache
;
571 struct stv0299_state
* state
= fe
->demodulator_priv
;
574 dprintk ("%s : FE_SET_FRONTEND\n", __func__
);
575 if (state
->config
->set_ts_params
)
576 state
->config
->set_ts_params(fe
, 0);
579 if (p
->inversion
== INVERSION_OFF
) invval
= 0;
580 else if (p
->inversion
== INVERSION_ON
) invval
= 1;
582 printk("stv0299 does not support auto-inversion\n");
585 if (state
->config
->invert
) invval
= (~invval
) & 1;
586 stv0299_writeregI(state
, 0x0c, (stv0299_readreg(state
, 0x0c) & 0xfe) | invval
);
588 if (fe
->ops
.tuner_ops
.set_params
) {
589 fe
->ops
.tuner_ops
.set_params(fe
);
590 if (fe
->ops
.i2c_gate_ctrl
) fe
->ops
.i2c_gate_ctrl(fe
, 0);
593 stv0299_set_FEC(state
, p
->fec_inner
);
594 stv0299_set_symbolrate(fe
, p
->symbol_rate
);
595 stv0299_writeregI(state
, 0x22, 0x00);
596 stv0299_writeregI(state
, 0x23, 0x00);
598 state
->tuner_frequency
= p
->frequency
;
599 state
->fec_inner
= p
->fec_inner
;
600 state
->symbol_rate
= p
->symbol_rate
;
605 static int stv0299_get_frontend(struct dvb_frontend
*fe
,
606 struct dtv_frontend_properties
*p
)
608 struct stv0299_state
* state
= fe
->demodulator_priv
;
612 derot_freq
= (s32
)(s16
) ((stv0299_readreg (state
, 0x22) << 8)
613 | stv0299_readreg (state
, 0x23));
615 derot_freq
*= (state
->config
->mclk
>> 16);
619 p
->frequency
+= derot_freq
;
621 invval
= stv0299_readreg (state
, 0x0c) & 1;
622 if (state
->config
->invert
) invval
= (~invval
) & 1;
623 p
->inversion
= invval
? INVERSION_ON
: INVERSION_OFF
;
625 p
->fec_inner
= stv0299_get_fec(state
);
626 p
->symbol_rate
= stv0299_get_symbolrate(state
);
631 static int stv0299_sleep(struct dvb_frontend
* fe
)
633 struct stv0299_state
* state
= fe
->demodulator_priv
;
635 stv0299_writeregI(state
, 0x02, 0xb0 | state
->mcr_reg
);
636 state
->initialised
= 0;
641 static int stv0299_i2c_gate_ctrl(struct dvb_frontend
* fe
, int enable
)
643 struct stv0299_state
* state
= fe
->demodulator_priv
;
646 stv0299_writeregI(state
, 0x05, 0xb5);
648 stv0299_writeregI(state
, 0x05, 0x35);
654 static int stv0299_get_tune_settings(struct dvb_frontend
* fe
, struct dvb_frontend_tune_settings
* fesettings
)
656 struct stv0299_state
* state
= fe
->demodulator_priv
;
657 struct dtv_frontend_properties
*p
= &fe
->dtv_property_cache
;
659 fesettings
->min_delay_ms
= state
->config
->min_delay_ms
;
660 if (p
->symbol_rate
< 10000000) {
661 fesettings
->step_size
= p
->symbol_rate
/ 32000;
662 fesettings
->max_drift
= 5000;
664 fesettings
->step_size
= p
->symbol_rate
/ 16000;
665 fesettings
->max_drift
= p
->symbol_rate
/ 2000;
670 static void stv0299_release(struct dvb_frontend
* fe
)
672 struct stv0299_state
* state
= fe
->demodulator_priv
;
676 static const struct dvb_frontend_ops stv0299_ops
;
678 struct dvb_frontend
* stv0299_attach(const struct stv0299_config
* config
,
679 struct i2c_adapter
* i2c
)
681 struct stv0299_state
* state
= NULL
;
684 /* allocate memory for the internal state */
685 state
= kzalloc(sizeof(struct stv0299_state
), GFP_KERNEL
);
686 if (state
== NULL
) goto error
;
688 /* setup the state */
689 state
->config
= config
;
691 state
->initialised
= 0;
692 state
->tuner_frequency
= 0;
693 state
->symbol_rate
= 0;
694 state
->fec_inner
= 0;
695 state
->errmode
= STATUS_BER
;
697 /* check if the demod is there */
698 stv0299_writeregI(state
, 0x02, 0x30); /* standby off */
700 id
= stv0299_readreg(state
, 0x00);
702 /* register 0x00 contains 0xa1 for STV0299 and STV0299B */
703 /* register 0x00 might contain 0x80 when returning from standby */
704 if (id
!= 0xa1 && id
!= 0x80) goto error
;
706 /* create dvb_frontend */
707 memcpy(&state
->frontend
.ops
, &stv0299_ops
, sizeof(struct dvb_frontend_ops
));
708 state
->frontend
.demodulator_priv
= state
;
709 return &state
->frontend
;
716 static const struct dvb_frontend_ops stv0299_ops
= {
717 .delsys
= { SYS_DVBS
},
719 .name
= "ST STV0299 DVB-S",
720 .frequency_min
= 950000,
721 .frequency_max
= 2150000,
722 .frequency_stepsize
= 125, /* kHz for QPSK frontends */
723 .frequency_tolerance
= 0,
724 .symbol_rate_min
= 1000000,
725 .symbol_rate_max
= 45000000,
726 .symbol_rate_tolerance
= 500, /* ppm */
727 .caps
= FE_CAN_FEC_1_2
| FE_CAN_FEC_2_3
| FE_CAN_FEC_3_4
|
728 FE_CAN_FEC_5_6
| FE_CAN_FEC_7_8
|
733 .release
= stv0299_release
,
735 .init
= stv0299_init
,
736 .sleep
= stv0299_sleep
,
737 .write
= stv0299_write
,
738 .i2c_gate_ctrl
= stv0299_i2c_gate_ctrl
,
740 .set_frontend
= stv0299_set_frontend
,
741 .get_frontend
= stv0299_get_frontend
,
742 .get_tune_settings
= stv0299_get_tune_settings
,
744 .read_status
= stv0299_read_status
,
745 .read_ber
= stv0299_read_ber
,
746 .read_signal_strength
= stv0299_read_signal_strength
,
747 .read_snr
= stv0299_read_snr
,
748 .read_ucblocks
= stv0299_read_ucblocks
,
750 .diseqc_send_master_cmd
= stv0299_send_diseqc_msg
,
751 .diseqc_send_burst
= stv0299_send_diseqc_burst
,
752 .set_tone
= stv0299_set_tone
,
753 .set_voltage
= stv0299_set_voltage
,
754 .dishnetwork_send_legacy_command
= stv0299_send_legacy_dish_cmd
,
757 module_param(debug_legacy_dish_switch
, int, 0444);
758 MODULE_PARM_DESC(debug_legacy_dish_switch
, "Enable timing analysis for Dish Network legacy switches");
760 module_param(debug
, int, 0644);
761 MODULE_PARM_DESC(debug
, "Turn on/off frontend debugging (default:off).");
763 MODULE_DESCRIPTION("ST STV0299 DVB Demodulator driver");
764 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Peter Schildmann, Felix Domke, Andreas Oberritter, Andrew de Quincey, Kenneth Aafly");
765 MODULE_LICENSE("GPL");
767 EXPORT_SYMBOL(stv0299_attach
);