1 // SPDX-License-Identifier: GPL-2.0-or-later
3 Driver for ST STV0299 demodulator
5 Copyright (C) 2001-2002 Convergence Integrated Media GmbH
6 <ralph@convergence.de>,
7 <holger@convergence.de>,
13 Copyright (C) 2002 by Peter Schildmann <peter.schildmann@web.de>
18 Copyright (C) 2002 Felix Domke <tmbinc@elitedvb.net>
19 & Andreas Oberritter <obi@linuxtv.org>
22 Support for Samsung TBMU24112IMB used on Technisat SkyStar2 rev. 2.6B
24 Copyright (C) 2003 Vadim Catana <skystar@moldova.cc>:
26 Support for Philips SU1278 on Technotrend hardware
28 Copyright (C) 2004 Andrew de Quincey <adq_dvb@lidskialf.net>
33 #include <linux/init.h>
34 #include <linux/kernel.h>
35 #include <linux/ktime.h>
36 #include <linux/module.h>
37 #include <linux/string.h>
38 #include <linux/slab.h>
39 #include <linux/jiffies.h>
40 #include <asm/div64.h>
42 #include <media/dvb_frontend.h>
45 struct stv0299_state
{
46 struct i2c_adapter
* i2c
;
47 const struct stv0299_config
* config
;
48 struct dvb_frontend frontend
;
53 enum fe_code_rate fec_inner
;
60 #define STATUS_UCBLOCKS 1
63 static int debug_legacy_dish_switch
;
64 #define dprintk(args...) \
66 if (debug) printk(KERN_DEBUG "stv0299: " args); \
70 static int stv0299_writeregI (struct stv0299_state
* state
, u8 reg
, u8 data
)
73 u8 buf
[] = { reg
, data
};
74 struct i2c_msg msg
= { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= buf
, .len
= 2 };
76 ret
= i2c_transfer (state
->i2c
, &msg
, 1);
79 dprintk("%s: writereg error (reg == 0x%02x, val == 0x%02x, ret == %i)\n",
80 __func__
, reg
, data
, ret
);
82 return (ret
!= 1) ? -EREMOTEIO
: 0;
85 static int stv0299_write(struct dvb_frontend
* fe
, const u8 buf
[], int len
)
87 struct stv0299_state
* state
= fe
->demodulator_priv
;
92 return stv0299_writeregI(state
, buf
[0], buf
[1]);
95 static u8
stv0299_readreg (struct stv0299_state
* state
, u8 reg
)
100 struct i2c_msg msg
[] = { { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= b0
, .len
= 1 },
101 { .addr
= state
->config
->demod_address
, .flags
= I2C_M_RD
, .buf
= b1
, .len
= 1 } };
103 ret
= i2c_transfer (state
->i2c
, msg
, 2);
106 dprintk("%s: readreg error (reg == 0x%02x, ret == %i)\n",
112 static int stv0299_readregs (struct stv0299_state
* state
, u8 reg1
, u8
*b
, u8 len
)
115 struct i2c_msg msg
[] = { { .addr
= state
->config
->demod_address
, .flags
= 0, .buf
= ®1
, .len
= 1 },
116 { .addr
= state
->config
->demod_address
, .flags
= I2C_M_RD
, .buf
= b
, .len
= len
} };
118 ret
= i2c_transfer (state
->i2c
, msg
, 2);
121 dprintk("%s: readreg error (ret == %i)\n", __func__
, ret
);
123 return ret
== 2 ? 0 : ret
;
126 static int stv0299_set_FEC(struct stv0299_state
*state
, enum fe_code_rate fec
)
128 dprintk ("%s\n", __func__
);
133 return stv0299_writeregI (state
, 0x31, 0x1f);
137 return stv0299_writeregI (state
, 0x31, 0x01);
141 return stv0299_writeregI (state
, 0x31, 0x02);
145 return stv0299_writeregI (state
, 0x31, 0x04);
149 return stv0299_writeregI (state
, 0x31, 0x08);
153 return stv0299_writeregI (state
, 0x31, 0x10);
162 static enum fe_code_rate
stv0299_get_fec(struct stv0299_state
*state
)
164 static const enum fe_code_rate fec_tab
[] = {
165 FEC_2_3
, FEC_3_4
, FEC_5_6
, FEC_7_8
, FEC_1_2
169 dprintk ("%s\n", __func__
);
171 index
= stv0299_readreg (state
, 0x1b);
177 return fec_tab
[index
];
180 static int stv0299_wait_diseqc_fifo (struct stv0299_state
* state
, int timeout
)
182 unsigned long start
= jiffies
;
184 dprintk ("%s\n", __func__
);
186 while (stv0299_readreg(state
, 0x0a) & 1) {
187 if (time_is_before_jiffies(start
+ timeout
)) {
188 dprintk ("%s: timeout!!\n", __func__
);
197 static int stv0299_wait_diseqc_idle (struct stv0299_state
* state
, int timeout
)
199 unsigned long start
= jiffies
;
201 dprintk ("%s\n", __func__
);
203 while ((stv0299_readreg(state
, 0x0a) & 3) != 2 ) {
204 if (time_is_before_jiffies(start
+ timeout
)) {
205 dprintk ("%s: timeout!!\n", __func__
);
214 static int stv0299_set_symbolrate (struct dvb_frontend
* fe
, u32 srate
)
216 struct stv0299_state
* state
= fe
->demodulator_priv
;
220 // check rate is within limits
221 if ((srate
< 1000000) || (srate
> 45000000)) return -EINVAL
;
223 // calculate value to program
225 big
+= (state
->config
->mclk
-1); // round correctly
226 do_div(big
, state
->config
->mclk
);
229 return state
->config
->set_symbol_rate(fe
, srate
, ratio
);
232 static int stv0299_get_symbolrate (struct stv0299_state
* state
)
234 u32 Mclk
= state
->config
->mclk
/ 4096L;
240 dprintk ("%s\n", __func__
);
242 stv0299_readregs (state
, 0x1f, sfr
, 3);
243 stv0299_readregs (state
, 0x1a, (u8
*)&rtf
, 1);
245 srate
= (sfr
[0] << 8) | sfr
[1];
248 srate
+= (sfr
[2] >> 4) * Mclk
/ 256;
249 offset
= (s32
) rtf
* (srate
/ 4096L);
252 dprintk ("%s : srate = %i\n", __func__
, srate
);
253 dprintk ("%s : ofset = %i\n", __func__
, offset
);
264 static int stv0299_send_diseqc_msg (struct dvb_frontend
* fe
,
265 struct dvb_diseqc_master_cmd
*m
)
267 struct stv0299_state
* state
= fe
->demodulator_priv
;
271 dprintk ("%s\n", __func__
);
273 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
276 val
= stv0299_readreg (state
, 0x08);
278 if (stv0299_writeregI (state
, 0x08, (val
& ~0x7) | 0x6)) /* DiSEqC mode */
281 for (i
=0; i
<m
->msg_len
; i
++) {
282 if (stv0299_wait_diseqc_fifo (state
, 100) < 0)
285 if (stv0299_writeregI (state
, 0x09, m
->msg
[i
]))
289 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
295 static int stv0299_send_diseqc_burst(struct dvb_frontend
*fe
,
296 enum fe_sec_mini_cmd burst
)
298 struct stv0299_state
* state
= fe
->demodulator_priv
;
301 dprintk ("%s\n", __func__
);
303 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
306 val
= stv0299_readreg (state
, 0x08);
308 if (stv0299_writeregI (state
, 0x08, (val
& ~0x7) | 0x2)) /* burst mode */
311 if (stv0299_writeregI (state
, 0x09, burst
== SEC_MINI_A
? 0x00 : 0xff))
314 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
317 if (stv0299_writeregI (state
, 0x08, val
))
323 static int stv0299_set_tone(struct dvb_frontend
*fe
,
324 enum fe_sec_tone_mode tone
)
326 struct stv0299_state
* state
= fe
->demodulator_priv
;
329 if (stv0299_wait_diseqc_idle (state
, 100) < 0)
332 val
= stv0299_readreg (state
, 0x08);
336 return stv0299_writeregI (state
, 0x08, val
| 0x3);
339 return stv0299_writeregI (state
, 0x08, (val
& ~0x3) | 0x02);
346 static int stv0299_set_voltage(struct dvb_frontend
*fe
,
347 enum fe_sec_voltage voltage
)
349 struct stv0299_state
* state
= fe
->demodulator_priv
;
353 dprintk("%s: %s\n", __func__
,
354 voltage
== SEC_VOLTAGE_13
? "SEC_VOLTAGE_13" :
355 voltage
== SEC_VOLTAGE_18
? "SEC_VOLTAGE_18" : "??");
357 reg0x08
= stv0299_readreg (state
, 0x08);
358 reg0x0c
= stv0299_readreg (state
, 0x0c);
361 * H/V switching over OP0, OP1 and OP2 are LNB power enable bits
364 reg0x08
= (reg0x08
& 0x3f) | (state
->config
->lock_output
<< 6);
368 if (state
->config
->volt13_op0_op1
== STV0299_VOLT13_OP0
)
369 reg0x0c
|= 0x10; /* OP1 off, OP0 on */
371 reg0x0c
|= 0x40; /* OP1 on, OP0 off */
374 reg0x0c
|= 0x50; /* OP1 on, OP0 on */
376 case SEC_VOLTAGE_OFF
:
385 if (state
->config
->op0_off
)
388 stv0299_writeregI(state
, 0x08, reg0x08
);
389 return stv0299_writeregI(state
, 0x0c, reg0x0c
);
392 static int stv0299_send_legacy_dish_cmd (struct dvb_frontend
* fe
, unsigned long cmd
)
394 struct stv0299_state
* state
= fe
->demodulator_priv
;
403 reg0x08
= stv0299_readreg (state
, 0x08);
404 reg0x0c
= stv0299_readreg (state
, 0x0c);
406 stv0299_writeregI (state
, 0x08, (reg0x08
& 0x3f) | (state
->config
->lock_output
<< 6));
407 if (state
->config
->volt13_op0_op1
== STV0299_VOLT13_OP0
)
411 if (debug_legacy_dish_switch
)
412 printk ("%s switch command: 0x%04lx\n",__func__
, cmd
);
414 nexttime
= ktime_get_boottime();
415 if (debug_legacy_dish_switch
)
417 stv0299_writeregI (state
, 0x0c, reg0x0c
| 0x50); /* set LNB to 18V */
419 dvb_frontend_sleep_until(&nexttime
, 32000);
421 for (i
=0; i
<9; i
++) {
422 if (debug_legacy_dish_switch
)
423 tv
[i
+1] = ktime_get_boottime();
424 if((cmd
& 0x01) != last
) {
425 /* set voltage to (last ? 13V : 18V) */
426 stv0299_writeregI (state
, 0x0c, reg0x0c
| (last
? lv_mask
: 0x50));
427 last
= (last
) ? 0 : 1;
433 dvb_frontend_sleep_until(&nexttime
, 8000);
435 if (debug_legacy_dish_switch
) {
436 printk ("%s(%d): switch delay (should be 32k followed by all 8k\n",
437 __func__
, fe
->dvb
->num
);
438 for (i
= 1; i
< 10; i
++)
439 printk("%d: %d\n", i
,
440 (int) ktime_us_delta(tv
[i
], tv
[i
-1]));
446 static int stv0299_init (struct dvb_frontend
* fe
)
448 struct stv0299_state
* state
= fe
->demodulator_priv
;
453 dprintk("stv0299: init chip\n");
455 stv0299_writeregI(state
, 0x02, 0x30 | state
->mcr_reg
);
458 for (i
= 0; ; i
+= 2) {
459 reg
= state
->config
->inittab
[i
];
460 val
= state
->config
->inittab
[i
+1];
461 if (reg
== 0xff && val
== 0xff)
463 if (reg
== 0x0c && state
->config
->op0_off
)
466 state
->mcr_reg
= val
& 0xf;
467 stv0299_writeregI(state
, reg
, val
);
473 static int stv0299_read_status(struct dvb_frontend
*fe
,
474 enum fe_status
*status
)
476 struct stv0299_state
* state
= fe
->demodulator_priv
;
478 u8 signal
= 0xff - stv0299_readreg (state
, 0x18);
479 u8 sync
= stv0299_readreg (state
, 0x1b);
481 dprintk ("%s : FE_READ_STATUS : VSTATUS: 0x%02x\n", __func__
, sync
);
485 *status
|= FE_HAS_SIGNAL
;
488 *status
|= FE_HAS_CARRIER
;
491 *status
|= FE_HAS_VITERBI
;
494 *status
|= FE_HAS_SYNC
;
496 if ((sync
& 0x98) == 0x98)
497 *status
|= FE_HAS_LOCK
;
502 static int stv0299_read_ber(struct dvb_frontend
* fe
, u32
* ber
)
504 struct stv0299_state
* state
= fe
->demodulator_priv
;
506 if (state
->errmode
!= STATUS_BER
)
509 *ber
= stv0299_readreg(state
, 0x1e) | (stv0299_readreg(state
, 0x1d) << 8);
514 static int stv0299_read_signal_strength(struct dvb_frontend
* fe
, u16
* strength
)
516 struct stv0299_state
* state
= fe
->demodulator_priv
;
518 s32 signal
= 0xffff - ((stv0299_readreg (state
, 0x18) << 8)
519 | stv0299_readreg (state
, 0x19));
521 dprintk ("%s : FE_READ_SIGNAL_STRENGTH : AGC2I: 0x%02x%02x, signal=0x%04x\n", __func__
,
522 stv0299_readreg (state
, 0x18),
523 stv0299_readreg (state
, 0x19), (int) signal
);
525 signal
= signal
* 5 / 4;
526 *strength
= (signal
> 0xffff) ? 0xffff : (signal
< 0) ? 0 : signal
;
531 static int stv0299_read_snr(struct dvb_frontend
* fe
, u16
* snr
)
533 struct stv0299_state
* state
= fe
->demodulator_priv
;
535 s32 xsnr
= 0xffff - ((stv0299_readreg (state
, 0x24) << 8)
536 | stv0299_readreg (state
, 0x25));
537 xsnr
= 3 * (xsnr
- 0xa100);
538 *snr
= (xsnr
> 0xffff) ? 0xffff : (xsnr
< 0) ? 0 : xsnr
;
543 static int stv0299_read_ucblocks(struct dvb_frontend
* fe
, u32
* ucblocks
)
545 struct stv0299_state
* state
= fe
->demodulator_priv
;
547 if (state
->errmode
!= STATUS_UCBLOCKS
)
550 state
->ucblocks
+= stv0299_readreg(state
, 0x1e);
551 state
->ucblocks
+= (stv0299_readreg(state
, 0x1d) << 8);
552 *ucblocks
= state
->ucblocks
;
557 static int stv0299_set_frontend(struct dvb_frontend
*fe
)
559 struct dtv_frontend_properties
*p
= &fe
->dtv_property_cache
;
560 struct stv0299_state
* state
= fe
->demodulator_priv
;
563 dprintk ("%s : FE_SET_FRONTEND\n", __func__
);
564 if (state
->config
->set_ts_params
)
565 state
->config
->set_ts_params(fe
, 0);
568 if (p
->inversion
== INVERSION_OFF
) invval
= 0;
569 else if (p
->inversion
== INVERSION_ON
) invval
= 1;
571 printk("stv0299 does not support auto-inversion\n");
574 if (state
->config
->invert
) invval
= (~invval
) & 1;
575 stv0299_writeregI(state
, 0x0c, (stv0299_readreg(state
, 0x0c) & 0xfe) | invval
);
577 if (fe
->ops
.tuner_ops
.set_params
) {
578 fe
->ops
.tuner_ops
.set_params(fe
);
579 if (fe
->ops
.i2c_gate_ctrl
) fe
->ops
.i2c_gate_ctrl(fe
, 0);
582 stv0299_set_FEC(state
, p
->fec_inner
);
583 stv0299_set_symbolrate(fe
, p
->symbol_rate
);
584 stv0299_writeregI(state
, 0x22, 0x00);
585 stv0299_writeregI(state
, 0x23, 0x00);
587 state
->tuner_frequency
= p
->frequency
;
588 state
->fec_inner
= p
->fec_inner
;
589 state
->symbol_rate
= p
->symbol_rate
;
594 static int stv0299_get_frontend(struct dvb_frontend
*fe
,
595 struct dtv_frontend_properties
*p
)
597 struct stv0299_state
* state
= fe
->demodulator_priv
;
601 derot_freq
= (s32
)(s16
) ((stv0299_readreg (state
, 0x22) << 8)
602 | stv0299_readreg (state
, 0x23));
604 derot_freq
*= (state
->config
->mclk
>> 16);
608 p
->frequency
+= derot_freq
;
610 invval
= stv0299_readreg (state
, 0x0c) & 1;
611 if (state
->config
->invert
) invval
= (~invval
) & 1;
612 p
->inversion
= invval
? INVERSION_ON
: INVERSION_OFF
;
614 p
->fec_inner
= stv0299_get_fec(state
);
615 p
->symbol_rate
= stv0299_get_symbolrate(state
);
620 static int stv0299_sleep(struct dvb_frontend
* fe
)
622 struct stv0299_state
* state
= fe
->demodulator_priv
;
624 stv0299_writeregI(state
, 0x02, 0xb0 | state
->mcr_reg
);
625 state
->initialised
= 0;
630 static int stv0299_i2c_gate_ctrl(struct dvb_frontend
* fe
, int enable
)
632 struct stv0299_state
* state
= fe
->demodulator_priv
;
635 stv0299_writeregI(state
, 0x05, 0xb5);
637 stv0299_writeregI(state
, 0x05, 0x35);
643 static int stv0299_get_tune_settings(struct dvb_frontend
* fe
, struct dvb_frontend_tune_settings
* fesettings
)
645 struct stv0299_state
* state
= fe
->demodulator_priv
;
646 struct dtv_frontend_properties
*p
= &fe
->dtv_property_cache
;
648 fesettings
->min_delay_ms
= state
->config
->min_delay_ms
;
649 if (p
->symbol_rate
< 10000000) {
650 fesettings
->step_size
= p
->symbol_rate
/ 32000;
651 fesettings
->max_drift
= 5000;
653 fesettings
->step_size
= p
->symbol_rate
/ 16000;
654 fesettings
->max_drift
= p
->symbol_rate
/ 2000;
659 static void stv0299_release(struct dvb_frontend
* fe
)
661 struct stv0299_state
* state
= fe
->demodulator_priv
;
665 static const struct dvb_frontend_ops stv0299_ops
;
667 struct dvb_frontend
* stv0299_attach(const struct stv0299_config
* config
,
668 struct i2c_adapter
* i2c
)
670 struct stv0299_state
* state
= NULL
;
673 /* allocate memory for the internal state */
674 state
= kzalloc(sizeof(struct stv0299_state
), GFP_KERNEL
);
675 if (state
== NULL
) goto error
;
677 /* setup the state */
678 state
->config
= config
;
680 state
->initialised
= 0;
681 state
->tuner_frequency
= 0;
682 state
->symbol_rate
= 0;
683 state
->fec_inner
= 0;
684 state
->errmode
= STATUS_BER
;
686 /* check if the demod is there */
687 stv0299_writeregI(state
, 0x02, 0x30); /* standby off */
689 id
= stv0299_readreg(state
, 0x00);
691 /* register 0x00 contains 0xa1 for STV0299 and STV0299B */
692 /* register 0x00 might contain 0x80 when returning from standby */
693 if (id
!= 0xa1 && id
!= 0x80) goto error
;
695 /* create dvb_frontend */
696 memcpy(&state
->frontend
.ops
, &stv0299_ops
, sizeof(struct dvb_frontend_ops
));
697 state
->frontend
.demodulator_priv
= state
;
698 return &state
->frontend
;
705 static const struct dvb_frontend_ops stv0299_ops
= {
706 .delsys
= { SYS_DVBS
},
708 .name
= "ST STV0299 DVB-S",
709 .frequency_min_hz
= 950 * MHz
,
710 .frequency_max_hz
= 2150 * MHz
,
711 .frequency_stepsize_hz
= 125 * kHz
,
712 .symbol_rate_min
= 1000000,
713 .symbol_rate_max
= 45000000,
714 .symbol_rate_tolerance
= 500, /* ppm */
715 .caps
= FE_CAN_FEC_1_2
| FE_CAN_FEC_2_3
| FE_CAN_FEC_3_4
|
716 FE_CAN_FEC_5_6
| FE_CAN_FEC_7_8
|
721 .release
= stv0299_release
,
723 .init
= stv0299_init
,
724 .sleep
= stv0299_sleep
,
725 .write
= stv0299_write
,
726 .i2c_gate_ctrl
= stv0299_i2c_gate_ctrl
,
728 .set_frontend
= stv0299_set_frontend
,
729 .get_frontend
= stv0299_get_frontend
,
730 .get_tune_settings
= stv0299_get_tune_settings
,
732 .read_status
= stv0299_read_status
,
733 .read_ber
= stv0299_read_ber
,
734 .read_signal_strength
= stv0299_read_signal_strength
,
735 .read_snr
= stv0299_read_snr
,
736 .read_ucblocks
= stv0299_read_ucblocks
,
738 .diseqc_send_master_cmd
= stv0299_send_diseqc_msg
,
739 .diseqc_send_burst
= stv0299_send_diseqc_burst
,
740 .set_tone
= stv0299_set_tone
,
741 .set_voltage
= stv0299_set_voltage
,
742 .dishnetwork_send_legacy_command
= stv0299_send_legacy_dish_cmd
,
745 module_param(debug_legacy_dish_switch
, int, 0444);
746 MODULE_PARM_DESC(debug_legacy_dish_switch
, "Enable timing analysis for Dish Network legacy switches");
748 module_param(debug
, int, 0644);
749 MODULE_PARM_DESC(debug
, "Turn on/off frontend debugging (default:off).");
751 MODULE_DESCRIPTION("ST STV0299 DVB Demodulator driver");
752 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Peter Schildmann, Felix Domke, Andreas Oberritter, Andrew de Quincey, Kenneth Aafly");
753 MODULE_LICENSE("GPL");
755 EXPORT_SYMBOL_GPL(stv0299_attach
);