2 Montage Technology TS2020 - Silicon Tuner driver
3 Copyright (C) 2009-2012 Konstantin Dimitrov <kosio.dimitrov@gmail.com>
5 Copyright (C) 2009-2012 TurboSight.com
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include "dvb_frontend.h"
24 #include <linux/regmap.h>
25 #include <linux/math64.h>
27 #define TS2020_XTAL_FREQ 27000 /* in kHz */
28 #define FREQ_OFFSET_LOW_SYM_RATE 3000
31 struct i2c_client
*client
;
32 struct mutex regmap_mutex
;
33 struct regmap_config regmap_config
;
34 struct regmap
*regmap
;
35 struct dvb_frontend
*fe
;
36 struct delayed_work stat_work
;
37 int (*get_agc_pwm
)(struct dvb_frontend
*fe
, u8
*_agc_pwm
);
39 struct i2c_adapter
*i2c
;
45 u32 frequency_div
; /* LO output divider switch frequency */
46 u32 frequency_khz
; /* actual used LO frequency */
47 #define TS2020_M88TS2020 0
48 #define TS2020_M88TS2022 1
52 struct ts2020_reg_val
{
57 static void ts2020_stat_work(struct work_struct
*work
);
59 static void ts2020_release(struct dvb_frontend
*fe
)
61 struct ts2020_priv
*priv
= fe
->tuner_priv
;
62 struct i2c_client
*client
= priv
->client
;
64 dev_dbg(&client
->dev
, "\n");
66 i2c_unregister_device(client
);
69 static int ts2020_sleep(struct dvb_frontend
*fe
)
71 struct ts2020_priv
*priv
= fe
->tuner_priv
;
75 if (priv
->tuner
== TS2020_M88TS2020
)
76 u8tmp
= 0x0a; /* XXX: probably wrong */
80 ret
= regmap_write(priv
->regmap
, u8tmp
, 0x00);
84 /* stop statistics polling */
86 cancel_delayed_work_sync(&priv
->stat_work
);
90 static int ts2020_init(struct dvb_frontend
*fe
)
92 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
93 struct ts2020_priv
*priv
= fe
->tuner_priv
;
97 if (priv
->tuner
== TS2020_M88TS2020
) {
98 regmap_write(priv
->regmap
, 0x42, 0x73);
99 regmap_write(priv
->regmap
, 0x05, priv
->clk_out_div
);
100 regmap_write(priv
->regmap
, 0x20, 0x27);
101 regmap_write(priv
->regmap
, 0x07, 0x02);
102 regmap_write(priv
->regmap
, 0x11, 0xff);
103 regmap_write(priv
->regmap
, 0x60, 0xf9);
104 regmap_write(priv
->regmap
, 0x08, 0x01);
105 regmap_write(priv
->regmap
, 0x00, 0x41);
107 static const struct ts2020_reg_val reg_vals
[] = {
121 regmap_write(priv
->regmap
, 0x00, 0x01);
122 regmap_write(priv
->regmap
, 0x00, 0x03);
124 switch (priv
->clk_out
) {
125 case TS2020_CLK_OUT_DISABLED
:
128 case TS2020_CLK_OUT_ENABLED
:
130 regmap_write(priv
->regmap
, 0x05, priv
->clk_out_div
);
132 case TS2020_CLK_OUT_ENABLED_XTALOUT
:
140 regmap_write(priv
->regmap
, 0x42, u8tmp
);
142 if (priv
->loop_through
)
147 regmap_write(priv
->regmap
, 0x62, u8tmp
);
149 for (i
= 0; i
< ARRAY_SIZE(reg_vals
); i
++)
150 regmap_write(priv
->regmap
, reg_vals
[i
].reg
,
154 /* Initialise v5 stats here */
156 c
->strength
.stat
[0].scale
= FE_SCALE_DECIBEL
;
157 c
->strength
.stat
[0].uvalue
= 0;
159 /* Start statistics polling by invoking the work function */
160 ts2020_stat_work(&priv
->stat_work
.work
);
164 static int ts2020_tuner_gate_ctrl(struct dvb_frontend
*fe
, u8 offset
)
166 struct ts2020_priv
*priv
= fe
->tuner_priv
;
168 ret
= regmap_write(priv
->regmap
, 0x51, 0x1f - offset
);
169 ret
|= regmap_write(priv
->regmap
, 0x51, 0x1f);
170 ret
|= regmap_write(priv
->regmap
, 0x50, offset
);
171 ret
|= regmap_write(priv
->regmap
, 0x50, 0x00);
176 static int ts2020_set_tuner_rf(struct dvb_frontend
*fe
)
178 struct ts2020_priv
*dev
= fe
->tuner_priv
;
182 ret
= regmap_read(dev
->regmap
, 0x3d, &utmp
);
186 else if (utmp
== 0x16)
191 regmap_write(dev
->regmap
, 0x60, utmp
);
192 ret
= ts2020_tuner_gate_ctrl(fe
, 0x08);
197 static int ts2020_set_params(struct dvb_frontend
*fe
)
199 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
200 struct ts2020_priv
*priv
= fe
->tuner_priv
;
204 u16 u16tmp
, value
, lpf_coeff
;
205 u8 buf
[3], reg10
, lpf_mxdiv
, mlpf_max
, mlpf_min
, nlpf
;
206 unsigned int f_ref_khz
, f_vco_khz
, div_ref
, div_out
, pll_n
;
207 unsigned int frequency_khz
= c
->frequency
;
210 * Integer-N PLL synthesizer
211 * kHz is used for all calculations to keep calculations within 32-bit
213 f_ref_khz
= TS2020_XTAL_FREQ
;
214 div_ref
= DIV_ROUND_CLOSEST(f_ref_khz
, 2000);
216 /* select LO output divider */
217 if (frequency_khz
< priv
->frequency_div
) {
225 f_vco_khz
= frequency_khz
* div_out
;
226 pll_n
= f_vco_khz
* div_ref
/ f_ref_khz
;
228 priv
->frequency_khz
= pll_n
* f_ref_khz
/ div_ref
/ div_out
;
230 pr_debug("frequency=%u offset=%d f_vco_khz=%u pll_n=%u div_ref=%u div_out=%u\n",
231 priv
->frequency_khz
, priv
->frequency_khz
- c
->frequency
,
232 f_vco_khz
, pll_n
, div_ref
, div_out
);
234 if (priv
->tuner
== TS2020_M88TS2020
) {
237 ret
= regmap_write(priv
->regmap
, 0x10, reg10
);
241 ret
= regmap_write(priv
->regmap
, 0x10, reg10
);
242 ret
|= regmap_write(priv
->regmap
, 0x11, 0x40);
245 u16tmp
= pll_n
- 1024;
246 buf
[0] = (u16tmp
>> 8) & 0xff;
247 buf
[1] = (u16tmp
>> 0) & 0xff;
248 buf
[2] = div_ref
- 8;
250 ret
|= regmap_write(priv
->regmap
, 0x01, buf
[0]);
251 ret
|= regmap_write(priv
->regmap
, 0x02, buf
[1]);
252 ret
|= regmap_write(priv
->regmap
, 0x03, buf
[2]);
254 ret
|= ts2020_tuner_gate_ctrl(fe
, 0x10);
258 ret
|= ts2020_tuner_gate_ctrl(fe
, 0x08);
261 if (priv
->tuner
== TS2020_M88TS2020
)
262 ret
|= ts2020_set_tuner_rf(fe
);
264 gdiv28
= (TS2020_XTAL_FREQ
/ 1000 * 1694 + 500) / 1000;
265 ret
|= regmap_write(priv
->regmap
, 0x04, gdiv28
& 0xff);
266 ret
|= ts2020_tuner_gate_ctrl(fe
, 0x04);
270 if (priv
->tuner
== TS2020_M88TS2022
) {
271 ret
= regmap_write(priv
->regmap
, 0x25, 0x00);
272 ret
|= regmap_write(priv
->regmap
, 0x27, 0x70);
273 ret
|= regmap_write(priv
->regmap
, 0x41, 0x09);
274 ret
|= regmap_write(priv
->regmap
, 0x08, 0x0b);
279 regmap_read(priv
->regmap
, 0x26, &utmp
);
282 f3db
= (c
->bandwidth_hz
/ 1000 / 2) + 2000;
283 f3db
+= FREQ_OFFSET_LOW_SYM_RATE
; /* FIXME: ~always too wide filter */
284 f3db
= clamp(f3db
, 7000U, 40000U);
286 gdiv28
= gdiv28
* 207 / (value
* 2 + 151);
287 mlpf_max
= gdiv28
* 135 / 100;
288 mlpf_min
= gdiv28
* 78 / 100;
292 nlpf
= (f3db
* gdiv28
* 2 / lpf_coeff
/
293 (TS2020_XTAL_FREQ
/ 1000) + 1) / 2;
299 lpf_mxdiv
= (nlpf
* (TS2020_XTAL_FREQ
/ 1000)
300 * lpf_coeff
* 2 / f3db
+ 1) / 2;
302 if (lpf_mxdiv
< mlpf_min
) {
304 lpf_mxdiv
= (nlpf
* (TS2020_XTAL_FREQ
/ 1000)
305 * lpf_coeff
* 2 / f3db
+ 1) / 2;
308 if (lpf_mxdiv
> mlpf_max
)
309 lpf_mxdiv
= mlpf_max
;
311 ret
= regmap_write(priv
->regmap
, 0x04, lpf_mxdiv
);
312 ret
|= regmap_write(priv
->regmap
, 0x06, nlpf
);
314 ret
|= ts2020_tuner_gate_ctrl(fe
, 0x04);
316 ret
|= ts2020_tuner_gate_ctrl(fe
, 0x01);
320 return (ret
< 0) ? -EINVAL
: 0;
323 static int ts2020_get_frequency(struct dvb_frontend
*fe
, u32
*frequency
)
325 struct ts2020_priv
*priv
= fe
->tuner_priv
;
327 *frequency
= priv
->frequency_khz
;
331 static int ts2020_get_if_frequency(struct dvb_frontend
*fe
, u32
*frequency
)
333 *frequency
= 0; /* Zero-IF */
338 * Get the tuner gain.
339 * @fe: The front end for which we're determining the gain
340 * @v_agc: The voltage of the AGC from the demodulator (0-2600mV)
341 * @_gain: Where to store the gain (in 0.001dB units)
343 * Returns 0 or a negative error code.
345 static int ts2020_read_tuner_gain(struct dvb_frontend
*fe
, unsigned v_agc
,
348 struct ts2020_priv
*priv
= fe
->tuner_priv
;
349 unsigned long gain1
, gain2
, gain3
;
353 /* Read the RF gain */
354 ret
= regmap_read(priv
->regmap
, 0x3d, &utmp
);
359 /* Read the baseband gain */
360 ret
= regmap_read(priv
->regmap
, 0x21, &utmp
);
365 switch (priv
->tuner
) {
366 case TS2020_M88TS2020
:
367 gain1
= clamp_t(long, gain1
, 0, 15);
368 gain2
= clamp_t(long, gain2
, 0, 13);
369 v_agc
= clamp_t(long, v_agc
, 400, 1100);
371 *_gain
= -(gain1
* 2330 +
373 v_agc
* 24 / 10 * 10 +
375 /* gain in range -19600 to -116850 in units of 0.001dB */
378 case TS2020_M88TS2022
:
379 ret
= regmap_read(priv
->regmap
, 0x66, &utmp
);
382 gain3
= (utmp
>> 3) & 0x07;
384 gain1
= clamp_t(long, gain1
, 0, 15);
385 gain2
= clamp_t(long, gain2
, 2, 16);
386 gain3
= clamp_t(long, gain3
, 0, 6);
387 v_agc
= clamp_t(long, v_agc
, 600, 1600);
389 *_gain
= -(gain1
* 2650 +
392 v_agc
* 176 / 100 * 10 -
394 /* gain in range -47320 to -158950 in units of 0.001dB */
402 * Get the AGC information from the demodulator and use that to calculate the
405 static int ts2020_get_tuner_gain(struct dvb_frontend
*fe
, __s64
*_gain
)
407 struct ts2020_priv
*priv
= fe
->tuner_priv
;
411 /* Read the AGC PWM rate from the demodulator */
412 if (priv
->get_agc_pwm
) {
413 ret
= priv
->get_agc_pwm(fe
, &agc_pwm
);
417 switch (priv
->tuner
) {
418 case TS2020_M88TS2020
:
419 v_agc
= (int)agc_pwm
* 20 - 1166;
421 case TS2020_M88TS2022
:
422 v_agc
= (int)agc_pwm
* 16 - 670;
430 return ts2020_read_tuner_gain(fe
, v_agc
, _gain
);
434 * Gather statistics on a regular basis
436 static void ts2020_stat_work(struct work_struct
*work
)
438 struct ts2020_priv
*priv
= container_of(work
, struct ts2020_priv
,
440 struct i2c_client
*client
= priv
->client
;
441 struct dtv_frontend_properties
*c
= &priv
->fe
->dtv_property_cache
;
444 dev_dbg(&client
->dev
, "\n");
446 ret
= ts2020_get_tuner_gain(priv
->fe
, &c
->strength
.stat
[0].svalue
);
450 c
->strength
.stat
[0].scale
= FE_SCALE_DECIBEL
;
452 if (!priv
->dont_poll
)
453 schedule_delayed_work(&priv
->stat_work
, msecs_to_jiffies(2000));
456 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
460 * Read TS2020 signal strength in v3 format.
462 static int ts2020_read_signal_strength(struct dvb_frontend
*fe
,
463 u16
*_signal_strength
)
465 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
466 struct ts2020_priv
*priv
= fe
->tuner_priv
;
471 ts2020_stat_work(&priv
->stat_work
.work
);
473 if (c
->strength
.stat
[0].scale
== FE_SCALE_NOT_AVAILABLE
) {
474 *_signal_strength
= 0;
478 gain
= c
->strength
.stat
[0].svalue
;
480 /* Calculate the signal strength based on the total gain of the tuner */
482 /* 0%: no signal or weak signal */
484 else if (gain
< -65000)
485 /* 0% - 60%: weak signal */
486 strength
= 0 + div64_s64((85000 + gain
) * 3, 1000);
487 else if (gain
< -45000)
488 /* 60% - 90%: normal signal */
489 strength
= 60 + div64_s64((65000 + gain
) * 3, 2000);
491 /* 90% - 99%: strong signal */
492 strength
= 90 + div64_s64((45000 + gain
), 5000);
494 *_signal_strength
= strength
* 65535 / 100;
498 static const struct dvb_tuner_ops ts2020_tuner_ops
= {
501 .frequency_min
= 950000,
502 .frequency_max
= 2150000
505 .release
= ts2020_release
,
506 .sleep
= ts2020_sleep
,
507 .set_params
= ts2020_set_params
,
508 .get_frequency
= ts2020_get_frequency
,
509 .get_if_frequency
= ts2020_get_if_frequency
,
510 .get_rf_strength
= ts2020_read_signal_strength
,
513 struct dvb_frontend
*ts2020_attach(struct dvb_frontend
*fe
,
514 const struct ts2020_config
*config
,
515 struct i2c_adapter
*i2c
)
517 struct i2c_client
*client
;
518 struct i2c_board_info board_info
;
520 /* This is only used by ts2020_probe() so can be on the stack */
521 struct ts2020_config pdata
;
523 memcpy(&pdata
, config
, sizeof(pdata
));
525 pdata
.attach_in_use
= true;
527 memset(&board_info
, 0, sizeof(board_info
));
528 strlcpy(board_info
.type
, "ts2020", I2C_NAME_SIZE
);
529 board_info
.addr
= config
->tuner_address
;
530 board_info
.platform_data
= &pdata
;
531 client
= i2c_new_device(i2c
, &board_info
);
532 if (!client
|| !client
->dev
.driver
)
537 EXPORT_SYMBOL(ts2020_attach
);
540 * We implement own regmap locking due to legacy DVB attach which uses frontend
541 * gate control callback to control I2C bus access. We can open / close gate and
542 * serialize whole open / I2C-operation / close sequence at the same.
544 static void ts2020_regmap_lock(void *__dev
)
546 struct ts2020_priv
*dev
= __dev
;
548 mutex_lock(&dev
->regmap_mutex
);
549 if (dev
->fe
->ops
.i2c_gate_ctrl
)
550 dev
->fe
->ops
.i2c_gate_ctrl(dev
->fe
, 1);
553 static void ts2020_regmap_unlock(void *__dev
)
555 struct ts2020_priv
*dev
= __dev
;
557 if (dev
->fe
->ops
.i2c_gate_ctrl
)
558 dev
->fe
->ops
.i2c_gate_ctrl(dev
->fe
, 0);
559 mutex_unlock(&dev
->regmap_mutex
);
562 static int ts2020_probe(struct i2c_client
*client
,
563 const struct i2c_device_id
*id
)
565 struct ts2020_config
*pdata
= client
->dev
.platform_data
;
566 struct dvb_frontend
*fe
= pdata
->fe
;
567 struct ts2020_priv
*dev
;
573 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
580 mutex_init(&dev
->regmap_mutex
);
581 dev
->regmap_config
.reg_bits
= 8,
582 dev
->regmap_config
.val_bits
= 8,
583 dev
->regmap_config
.lock
= ts2020_regmap_lock
,
584 dev
->regmap_config
.unlock
= ts2020_regmap_unlock
,
585 dev
->regmap_config
.lock_arg
= dev
,
586 dev
->regmap
= regmap_init_i2c(client
, &dev
->regmap_config
);
587 if (IS_ERR(dev
->regmap
)) {
588 ret
= PTR_ERR(dev
->regmap
);
592 dev
->i2c
= client
->adapter
;
593 dev
->i2c_address
= client
->addr
;
594 dev
->loop_through
= pdata
->loop_through
;
595 dev
->clk_out
= pdata
->clk_out
;
596 dev
->clk_out_div
= pdata
->clk_out_div
;
597 dev
->dont_poll
= pdata
->dont_poll
;
598 dev
->frequency_div
= pdata
->frequency_div
;
600 dev
->get_agc_pwm
= pdata
->get_agc_pwm
;
601 fe
->tuner_priv
= dev
;
602 dev
->client
= client
;
603 INIT_DELAYED_WORK(&dev
->stat_work
, ts2020_stat_work
);
605 /* check if the tuner is there */
606 ret
= regmap_read(dev
->regmap
, 0x00, &utmp
);
608 goto err_regmap_exit
;
610 if ((utmp
& 0x03) == 0x00) {
611 ret
= regmap_write(dev
->regmap
, 0x00, 0x01);
613 goto err_regmap_exit
;
615 usleep_range(2000, 50000);
618 ret
= regmap_write(dev
->regmap
, 0x00, 0x03);
620 goto err_regmap_exit
;
622 usleep_range(2000, 50000);
624 ret
= regmap_read(dev
->regmap
, 0x00, &utmp
);
626 goto err_regmap_exit
;
628 dev_dbg(&client
->dev
, "chip_id=%02x\n", utmp
);
634 dev
->tuner
= TS2020_M88TS2020
;
636 if (!dev
->frequency_div
)
637 dev
->frequency_div
= 1060000;
641 dev
->tuner
= TS2020_M88TS2022
;
643 if (!dev
->frequency_div
)
644 dev
->frequency_div
= 1103000;
648 goto err_regmap_exit
;
651 if (dev
->tuner
== TS2020_M88TS2022
) {
652 switch (dev
->clk_out
) {
653 case TS2020_CLK_OUT_DISABLED
:
656 case TS2020_CLK_OUT_ENABLED
:
658 ret
= regmap_write(dev
->regmap
, 0x05, dev
->clk_out_div
);
660 goto err_regmap_exit
;
662 case TS2020_CLK_OUT_ENABLED_XTALOUT
:
667 goto err_regmap_exit
;
670 ret
= regmap_write(dev
->regmap
, 0x42, u8tmp
);
672 goto err_regmap_exit
;
674 if (dev
->loop_through
)
679 ret
= regmap_write(dev
->regmap
, 0x62, u8tmp
);
681 goto err_regmap_exit
;
685 ret
= regmap_write(dev
->regmap
, 0x00, 0x00);
687 goto err_regmap_exit
;
689 dev_info(&client
->dev
,
690 "Montage Technology %s successfully identified\n", chip_str
);
692 memcpy(&fe
->ops
.tuner_ops
, &ts2020_tuner_ops
,
693 sizeof(struct dvb_tuner_ops
));
694 if (!pdata
->attach_in_use
)
695 fe
->ops
.tuner_ops
.release
= NULL
;
697 i2c_set_clientdata(client
, dev
);
700 regmap_exit(dev
->regmap
);
704 dev_dbg(&client
->dev
, "failed=%d\n", ret
);
708 static int ts2020_remove(struct i2c_client
*client
)
710 struct ts2020_priv
*dev
= i2c_get_clientdata(client
);
712 dev_dbg(&client
->dev
, "\n");
714 /* stop statistics polling */
716 cancel_delayed_work_sync(&dev
->stat_work
);
718 regmap_exit(dev
->regmap
);
723 static const struct i2c_device_id ts2020_id_table
[] = {
728 MODULE_DEVICE_TABLE(i2c
, ts2020_id_table
);
730 static struct i2c_driver ts2020_driver
= {
734 .probe
= ts2020_probe
,
735 .remove
= ts2020_remove
,
736 .id_table
= ts2020_id_table
,
739 module_i2c_driver(ts2020_driver
);
741 MODULE_AUTHOR("Konstantin Dimitrov <kosio.dimitrov@gmail.com>");
742 MODULE_DESCRIPTION("Montage Technology TS2020 - Silicon tuner driver module");
743 MODULE_LICENSE("GPL");