blob: aa0f0e576d62558fc96a24344ac5c11e024a04c5 [file] [log] [blame]
Patrick Boettcher4de27302006-04-17 13:22:15 -03001/*
2 * Driver for Microtune MT2060 "Single chip dual conversion broadband tuner"
3 *
4 * Copyright (c) 2006 Olivier DANET <odanet@caramail.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 *
15 * GNU General Public License for more details.
16 *
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.=
20 */
21
Patrick Boettcher4de27302006-04-17 13:22:15 -030022/* In that file, frequencies are expressed in kiloHertz to avoid 32 bits overflows */
23
24#include <linux/module.h>
25#include <linux/moduleparam.h>
26#include <linux/delay.h>
27#include <linux/dvb/frontend.h>
Olivier DANET46f73f92006-08-08 15:48:10 -030028#include <linux/i2c.h>
29
30#include "dvb_frontend.h"
31
Patrick Boettcher4de27302006-04-17 13:22:15 -030032#include "mt2060.h"
33#include "mt2060_priv.h"
34
Patrick Boettcherb7571f82006-08-08 15:48:10 -030035static int debug;
Patrick Boettcher4de27302006-04-17 13:22:15 -030036module_param(debug, int, 0644);
37MODULE_PARM_DESC(debug, "Turn on/off debugging (default:off).");
38
Olivier DANET46f73f92006-08-08 15:48:10 -030039#define dprintk(args...) do { if (debug) {printk(KERN_DEBUG "MT2060: " args); printk("\n"); }} while (0)
Patrick Boettcher4de27302006-04-17 13:22:15 -030040
41// Reads a single register
Olivier DANET46f73f92006-08-08 15:48:10 -030042static int mt2060_readreg(struct mt2060_priv *priv, u8 reg, u8 *val)
Patrick Boettcher4de27302006-04-17 13:22:15 -030043{
44 struct i2c_msg msg[2] = {
Olivier DANET46f73f92006-08-08 15:48:10 -030045 { .addr = priv->cfg->i2c_address, .flags = 0, .buf = &reg, .len = 1 },
46 { .addr = priv->cfg->i2c_address, .flags = I2C_M_RD, .buf = val, .len = 1 },
Patrick Boettcher4de27302006-04-17 13:22:15 -030047 };
48
Olivier DANET46f73f92006-08-08 15:48:10 -030049 if (i2c_transfer(priv->i2c, msg, 2) != 2) {
Patrick Boettcher4de27302006-04-17 13:22:15 -030050 printk(KERN_WARNING "mt2060 I2C read failed\n");
51 return -EREMOTEIO;
52 }
53 return 0;
54}
55
56// Writes a single register
Olivier DANET46f73f92006-08-08 15:48:10 -030057static int mt2060_writereg(struct mt2060_priv *priv, u8 reg, u8 val)
Patrick Boettcher4de27302006-04-17 13:22:15 -030058{
Olivier DANET46f73f92006-08-08 15:48:10 -030059 u8 buf[2] = { reg, val };
Patrick Boettcher4de27302006-04-17 13:22:15 -030060 struct i2c_msg msg = {
Olivier DANET46f73f92006-08-08 15:48:10 -030061 .addr = priv->cfg->i2c_address, .flags = 0, .buf = buf, .len = 2
Patrick Boettcher4de27302006-04-17 13:22:15 -030062 };
Patrick Boettcher4de27302006-04-17 13:22:15 -030063
Olivier DANET46f73f92006-08-08 15:48:10 -030064 if (i2c_transfer(priv->i2c, &msg, 1) != 1) {
Patrick Boettcher4de27302006-04-17 13:22:15 -030065 printk(KERN_WARNING "mt2060 I2C write failed\n");
66 return -EREMOTEIO;
67 }
68 return 0;
69}
70
71// Writes a set of consecutive registers
Olivier DANET46f73f92006-08-08 15:48:10 -030072static int mt2060_writeregs(struct mt2060_priv *priv,u8 *buf, u8 len)
Patrick Boettcher4de27302006-04-17 13:22:15 -030073{
74 struct i2c_msg msg = {
Olivier DANET46f73f92006-08-08 15:48:10 -030075 .addr = priv->cfg->i2c_address, .flags = 0, .buf = buf, .len = len
Patrick Boettcher4de27302006-04-17 13:22:15 -030076 };
Olivier DANET46f73f92006-08-08 15:48:10 -030077 if (i2c_transfer(priv->i2c, &msg, 1) != 1) {
Patrick Boettcher4de27302006-04-17 13:22:15 -030078 printk(KERN_WARNING "mt2060 I2C write failed (len=%i)\n",(int)len);
79 return -EREMOTEIO;
80 }
81 return 0;
82}
83
84// Initialisation sequences
85// LNABAND=3, NUM1=0x3C, DIV1=0x74, NUM2=0x1080, DIV2=0x49
86static u8 mt2060_config1[] = {
87 REG_LO1C1,
88 0x3F, 0x74, 0x00, 0x08, 0x93
89};
90
91// FMCG=2, GP2=0, GP1=0
92static u8 mt2060_config2[] = {
93 REG_MISC_CTRL,
94 0x20, 0x1E, 0x30, 0xff, 0x80, 0xff, 0x00, 0x2c, 0x42
95};
96
97// VGAG=3, V1CSE=1
Patrick Boettcher4de27302006-04-17 13:22:15 -030098
99#ifdef MT2060_SPURCHECK
100/* The function below calculates the frequency offset between the output frequency if2
101 and the closer cross modulation subcarrier between lo1 and lo2 up to the tenth harmonic */
102static int mt2060_spurcalc(u32 lo1,u32 lo2,u32 if2)
103{
104 int I,J;
105 int dia,diamin,diff;
106 diamin=1000000;
107 for (I = 1; I < 10; I++) {
108 J = ((2*I*lo1)/lo2+1)/2;
109 diff = I*(int)lo1-J*(int)lo2;
110 if (diff < 0) diff=-diff;
111 dia = (diff-(int)if2);
112 if (dia < 0) dia=-dia;
113 if (diamin > dia) diamin=dia;
114 }
115 return diamin;
116}
117
118#define BANDWIDTH 4000 // kHz
119
120/* Calculates the frequency offset to add to avoid spurs. Returns 0 if no offset is needed */
121static int mt2060_spurcheck(u32 lo1,u32 lo2,u32 if2)
122{
123 u32 Spur,Sp1,Sp2;
124 int I,J;
125 I=0;
126 J=1000;
127
128 Spur=mt2060_spurcalc(lo1,lo2,if2);
129 if (Spur < BANDWIDTH) {
130 /* Potential spurs detected */
131 dprintk("Spurs before : f_lo1: %d f_lo2: %d (kHz)",
132 (int)lo1,(int)lo2);
133 I=1000;
134 Sp1 = mt2060_spurcalc(lo1+I,lo2+I,if2);
135 Sp2 = mt2060_spurcalc(lo1-I,lo2-I,if2);
136
137 if (Sp1 < Sp2) {
138 J=-J; I=-I; Spur=Sp2;
139 } else
140 Spur=Sp1;
141
142 while (Spur < BANDWIDTH) {
143 I += J;
144 Spur = mt2060_spurcalc(lo1+I,lo2+I,if2);
145 }
146 dprintk("Spurs after : f_lo1: %d f_lo2: %d (kHz)",
147 (int)(lo1+I),(int)(lo2+I));
148 }
149 return I;
150}
151#endif
152
153#define IF2 36150 // IF2 frequency = 36.150 MHz
154#define FREF 16000 // Quartz oscillator 16 MHz
155
Olivier DANET46f73f92006-08-08 15:48:10 -0300156static int mt2060_set_params(struct dvb_frontend *fe, struct dvb_frontend_parameters *params)
Patrick Boettcher4de27302006-04-17 13:22:15 -0300157{
Olivier DANET46f73f92006-08-08 15:48:10 -0300158 struct mt2060_priv *priv;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300159 int ret=0;
160 int i=0;
161 u32 freq;
162 u8 lnaband;
163 u32 f_lo1,f_lo2;
164 u32 div1,num1,div2,num2;
165 u8 b[8];
166 u32 if1;
167
Olivier DANET46f73f92006-08-08 15:48:10 -0300168 priv = fe->tuner_priv;
169
170 if1 = priv->if1_freq;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300171 b[0] = REG_LO1B1;
172 b[1] = 0xFF;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300173
Olivier DANET46f73f92006-08-08 15:48:10 -0300174 mt2060_writeregs(priv,b,2);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300175
Olivier DANET46f73f92006-08-08 15:48:10 -0300176 freq = params->frequency / 1000; // Hz -> kHz
177 priv->bandwidth = (fe->ops.info.type == FE_OFDM) ? params->u.ofdm.bandwidth : 0;
178
179 f_lo1 = freq + if1 * 1000;
180 f_lo1 = (f_lo1 / 250) * 250;
181 f_lo2 = f_lo1 - freq - IF2;
182 // From the Comtech datasheet, the step used is 50kHz. The tuner chip could be more precise
183 f_lo2 = ((f_lo2 + 25) / 50) * 50;
184 priv->frequency = (f_lo1 - f_lo2 - IF2) * 1000,
Patrick Boettcher4de27302006-04-17 13:22:15 -0300185
186#ifdef MT2060_SPURCHECK
187 // LO-related spurs detection and correction
188 num1 = mt2060_spurcheck(f_lo1,f_lo2,IF2);
189 f_lo1 += num1;
190 f_lo2 += num1;
191#endif
192 //Frequency LO1 = 16MHz * (DIV1 + NUM1/64 )
Olivier DANET46f73f92006-08-08 15:48:10 -0300193 num1 = f_lo1 / (FREF / 64);
194 div1 = num1 / 64;
195 num1 &= 0x3f;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300196
197 // Frequency LO2 = 16MHz * (DIV2 + NUM2/8192 )
Olivier DANET46f73f92006-08-08 15:48:10 -0300198 num2 = f_lo2 * 64 / (FREF / 128);
199 div2 = num2 / 8192;
200 num2 &= 0x1fff;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300201
202 if (freq <= 95000) lnaband = 0xB0; else
203 if (freq <= 180000) lnaband = 0xA0; else
204 if (freq <= 260000) lnaband = 0x90; else
205 if (freq <= 335000) lnaband = 0x80; else
206 if (freq <= 425000) lnaband = 0x70; else
207 if (freq <= 480000) lnaband = 0x60; else
208 if (freq <= 570000) lnaband = 0x50; else
209 if (freq <= 645000) lnaband = 0x40; else
210 if (freq <= 730000) lnaband = 0x30; else
211 if (freq <= 810000) lnaband = 0x20; else lnaband = 0x10;
212
213 b[0] = REG_LO1C1;
214 b[1] = lnaband | ((num1 >>2) & 0x0F);
215 b[2] = div1;
216 b[3] = (num2 & 0x0F) | ((num1 & 3) << 4);
217 b[4] = num2 >> 4;
218 b[5] = ((num2 >>12) & 1) | (div2 << 1);
219
220 dprintk("IF1: %dMHz",(int)if1);
Olivier DANET46f73f92006-08-08 15:48:10 -0300221 dprintk("PLL freq=%dkHz f_lo1=%dkHz f_lo2=%dkHz",(int)freq,(int)f_lo1,(int)f_lo2);
222 dprintk("PLL div1=%d num1=%d div2=%d num2=%d",(int)div1,(int)num1,(int)div2,(int)num2);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300223 dprintk("PLL [1..5]: %2x %2x %2x %2x %2x",(int)b[1],(int)b[2],(int)b[3],(int)b[4],(int)b[5]);
224
Olivier DANET46f73f92006-08-08 15:48:10 -0300225 mt2060_writeregs(priv,b,6);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300226
227 //Waits for pll lock or timeout
Olivier DANET46f73f92006-08-08 15:48:10 -0300228 i = 0;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300229 do {
Olivier DANET46f73f92006-08-08 15:48:10 -0300230 mt2060_readreg(priv,REG_LO_STATUS,b);
231 if ((b[0] & 0x88)==0x88)
232 break;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300233 msleep(4);
234 i++;
235 } while (i<10);
236
237 return ret;
238}
Patrick Boettcher4de27302006-04-17 13:22:15 -0300239
Olivier DANET46f73f92006-08-08 15:48:10 -0300240static void mt2060_calibrate(struct mt2060_priv *priv)
Patrick Boettcher4de27302006-04-17 13:22:15 -0300241{
242 u8 b = 0;
243 int i = 0;
244
Olivier DANET46f73f92006-08-08 15:48:10 -0300245 if (mt2060_writeregs(priv,mt2060_config1,sizeof(mt2060_config1)))
Patrick Boettcher4de27302006-04-17 13:22:15 -0300246 return;
Olivier DANET46f73f92006-08-08 15:48:10 -0300247 if (mt2060_writeregs(priv,mt2060_config2,sizeof(mt2060_config2)))
Patrick Boettcher4de27302006-04-17 13:22:15 -0300248 return;
249
250 do {
251 b |= (1 << 6); // FM1SS;
Olivier DANET46f73f92006-08-08 15:48:10 -0300252 mt2060_writereg(priv, REG_LO2C1,b);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300253 msleep(20);
254
255 if (i == 0) {
256 b |= (1 << 7); // FM1CA;
Olivier DANET46f73f92006-08-08 15:48:10 -0300257 mt2060_writereg(priv, REG_LO2C1,b);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300258 b &= ~(1 << 7); // FM1CA;
259 msleep(20);
260 }
261
262 b &= ~(1 << 6); // FM1SS
Olivier DANET46f73f92006-08-08 15:48:10 -0300263 mt2060_writereg(priv, REG_LO2C1,b);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300264
265 msleep(20);
266 i++;
267 } while (i < 9);
268
269 i = 0;
Olivier DANET46f73f92006-08-08 15:48:10 -0300270 while (i++ < 10 && mt2060_readreg(priv, REG_MISC_STAT, &b) == 0 && (b & (1 << 6)) == 0)
Patrick Boettcher4de27302006-04-17 13:22:15 -0300271 msleep(20);
272
273 if (i < 10) {
Olivier DANET46f73f92006-08-08 15:48:10 -0300274 mt2060_readreg(priv, REG_FM_FREQ, &priv->fmfreq); // now find out, what is fmreq used for :)
275 dprintk("calibration was successful: %d", (int)priv->fmfreq);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300276 } else
277 dprintk("FMCAL timed out");
278}
279
Olivier DANET46f73f92006-08-08 15:48:10 -0300280static int mt2060_calc_regs(struct dvb_frontend *fe, struct dvb_frontend_parameters *params, u8 *buf, int buf_len)
Patrick Boettcher4de27302006-04-17 13:22:15 -0300281{
Olivier DANET46f73f92006-08-08 15:48:10 -0300282 return -ENODEV;
283}
284
285static int mt2060_get_frequency(struct dvb_frontend *fe, u32 *frequency)
286{
287 struct mt2060_priv *priv = fe->tuner_priv;
288 *frequency = priv->frequency;
289 return 0;
290}
291
292static int mt2060_get_bandwidth(struct dvb_frontend *fe, u32 *bandwidth)
293{
294 struct mt2060_priv *priv = fe->tuner_priv;
295 *bandwidth = priv->bandwidth;
296 return 0;
297}
298
299static int mt2060_sleep(struct dvb_frontend *fe)
300{
301 struct mt2060_priv *priv = fe->tuner_priv;
302 return mt2060_writereg(priv, REG_VGAG,0x30);
303}
304
305static int mt2060_release(struct dvb_frontend *fe)
306{
307 kfree(fe->tuner_priv);
308 fe->tuner_priv = NULL;
309 return 0;
310}
311
312static const struct dvb_tuner_ops mt2060_tuner_ops = {
313 .info = {
314 .name = "Microtune MT2060",
315 .frequency_min = 48000000,
316 .frequency_max = 860000000,
317 .frequency_step = 50000,
318 },
319
320 .release = mt2060_release,
321
322 .sleep = mt2060_sleep,
323
324 .set_params = mt2060_set_params,
325 .calc_regs = mt2060_calc_regs,
326 .get_frequency = mt2060_get_frequency,
327 .get_bandwidth = mt2060_get_bandwidth
328};
329
330/* This functions tries to identify a MT2060 tuner by reading the PART/REV register. This is hasty. */
331int mt2060_attach(struct dvb_frontend *fe, struct i2c_adapter *i2c, struct mt2060_config *cfg, u16 if1)
332{
333 struct mt2060_priv *priv = NULL;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300334 u8 id = 0;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300335
Olivier DANET46f73f92006-08-08 15:48:10 -0300336 priv = kzalloc(sizeof(struct mt2060_priv), GFP_KERNEL);
337 if (priv == NULL)
338 return -ENOMEM;
Patrick Boettcher4de27302006-04-17 13:22:15 -0300339
Olivier DANET46f73f92006-08-08 15:48:10 -0300340 priv->cfg = cfg;
341 priv->i2c = i2c;
342 priv->if1_freq = if1;
343
344 if (mt2060_readreg(priv,REG_PART_REV,&id) != 0) {
345 kfree(priv);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300346 return -ENODEV;
Olivier DANET46f73f92006-08-08 15:48:10 -0300347 }
Patrick Boettcher4de27302006-04-17 13:22:15 -0300348
Olivier DANET46f73f92006-08-08 15:48:10 -0300349 if (id != PART_REV) {
350 kfree(priv);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300351 return -ENODEV;
Olivier DANET46f73f92006-08-08 15:48:10 -0300352 }
Patrick Boettcherb7571f82006-08-08 15:48:10 -0300353 printk(KERN_INFO "MT2060: successfully identified (IF1 = %d)\n", if1);
Olivier DANET46f73f92006-08-08 15:48:10 -0300354 memcpy(&fe->ops.tuner_ops, &mt2060_tuner_ops, sizeof(struct dvb_tuner_ops));
Patrick Boettcher4de27302006-04-17 13:22:15 -0300355
Olivier DANET46f73f92006-08-08 15:48:10 -0300356 fe->tuner_priv = priv;
357
358 mt2060_calibrate(priv);
Patrick Boettcher4de27302006-04-17 13:22:15 -0300359
360 return 0;
361}
362EXPORT_SYMBOL(mt2060_attach);
363
364MODULE_AUTHOR("Olivier DANET");
365MODULE_DESCRIPTION("Microtune MT2060 silicon tuner driver");
366MODULE_LICENSE("GPL");