2 * Driver for Maxim MAX2165 silicon tuner
4 * Copyright (c) 2009 David T. L. Wong <davidtlwong@gmail.com>
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.
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
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 <linux/module.h>
23 #include <linux/moduleparam.h>
24 #include <linux/videodev2.h>
25 #include <linux/delay.h>
26 #include <linux/dvb/frontend.h>
27 #include <linux/i2c.h>
28 #include <linux/slab.h>
30 #include "dvb_frontend.h"
33 #include "max2165_priv.h"
34 #include "tuner-i2c.h"
36 #define dprintk(args...) \
39 printk(KERN_DEBUG "max2165: " args); \
43 module_param(debug, int, 0644);
44 MODULE_PARM_DESC(debug, "Turn on/off debugging (default:off).");
46 static int max2165_write_reg(struct max2165_priv *priv, u8 reg, u8 data)
49 u8 buf[] = { reg, data };
50 struct i2c_msg msg = { .flags = 0, .buf = buf, .len = 2 };
52 msg.addr = priv->config->i2c_address;
55 printk(KERN_DEBUG "%s: reg=0x%02X, data=0x%02X\n",
58 ret = i2c_transfer(priv->i2c, &msg, 1);
61 dprintk(KERN_DEBUG "%s: error reg=0x%x, data=0x%x, ret=%i\n",
62 __func__, reg, data, ret);
64 return (ret != 1) ? -EIO : 0;
67 static int max2165_read_reg(struct max2165_priv *priv, u8 reg, u8 *p_data)
70 u8 dev_addr = priv->config->i2c_address;
74 struct i2c_msg msg[] = {
75 { .addr = dev_addr, .flags = 0, .buf = b0, .len = 1 },
76 { .addr = dev_addr, .flags = I2C_M_RD, .buf = b1, .len = 1 },
79 ret = i2c_transfer(priv->i2c, msg, 2);
81 dprintk(KERN_DEBUG "%s: error reg=0x%x, ret=%i\n",
88 printk(KERN_DEBUG "%s: reg=0x%02X, data=0x%02X\n",
89 __func__, reg, b1[0]);
93 static int max2165_mask_write_reg(struct max2165_priv *priv, u8 reg,
100 ret = max2165_read_reg(priv, reg, &v);
105 ret = max2165_write_reg(priv, reg, v);
110 static int max2165_read_rom_table(struct max2165_priv *priv)
115 for (i = 0; i < 3; i++) {
116 max2165_write_reg(priv, REG_ROM_TABLE_ADDR, i + 1);
117 max2165_read_reg(priv, REG_ROM_TABLE_DATA, &dat[i]);
120 priv->tf_ntch_low_cfg = dat[0] >> 4;
121 priv->tf_ntch_hi_cfg = dat[0] & 0x0F;
122 priv->tf_balun_low_ref = dat[1] & 0x0F;
123 priv->tf_balun_hi_ref = dat[1] >> 4;
124 priv->bb_filter_7mhz_cfg = dat[2] & 0x0F;
125 priv->bb_filter_8mhz_cfg = dat[2] >> 4;
127 dprintk("tf_ntch_low_cfg = 0x%X\n", priv->tf_ntch_low_cfg);
128 dprintk("tf_ntch_hi_cfg = 0x%X\n", priv->tf_ntch_hi_cfg);
129 dprintk("tf_balun_low_ref = 0x%X\n", priv->tf_balun_low_ref);
130 dprintk("tf_balun_hi_ref = 0x%X\n", priv->tf_balun_hi_ref);
131 dprintk("bb_filter_7mhz_cfg = 0x%X\n", priv->bb_filter_7mhz_cfg);
132 dprintk("bb_filter_8mhz_cfg = 0x%X\n", priv->bb_filter_8mhz_cfg);
137 static int max2165_set_osc(struct max2165_priv *priv, u8 osc /*MHz*/)
147 max2165_mask_write_reg(priv, REG_PLL_CFG, 0x07, v);
152 static int max2165_set_bandwidth(struct max2165_priv *priv, u32 bw)
156 if (bw == BANDWIDTH_8_MHZ)
157 val = priv->bb_filter_8mhz_cfg;
159 val = priv->bb_filter_7mhz_cfg;
161 max2165_mask_write_reg(priv, REG_BASEBAND_CTRL, 0xF0, val << 4);
166 int fixpt_div32(u32 dividend, u32 divisor, u32 *quotient, u32 *fraction)
175 q = dividend / divisor;
176 remainder = dividend - q * divisor;
178 for (i = 0; i < 31; i++) {
180 if (remainder >= divisor) {
182 remainder -= divisor;
193 static int max2165_set_rf(struct max2165_priv *priv, u32 freq)
198 u32 quotient, fraction;
200 /* Set PLL divider according to RF frequency */
201 fixpt_div32(freq / 1000, priv->config->osc_clk * 1000,
202 "ient, &fraction);
204 /* 20-bit fraction */
207 max2165_write_reg(priv, REG_NDIV_INT, quotient);
208 max2165_mask_write_reg(priv, REG_NDIV_FRAC2, 0x0F, fraction >> 16);
209 max2165_write_reg(priv, REG_NDIV_FRAC1, fraction >> 8);
210 max2165_write_reg(priv, REG_NDIV_FRAC0, fraction);
213 tf_ntch = (freq < 725000000) ?
214 priv->tf_ntch_low_cfg : priv->tf_ntch_hi_cfg;
216 /* Tracking filter balun */
217 t = priv->tf_balun_low_ref;
218 t += (priv->tf_balun_hi_ref - priv->tf_balun_low_ref)
219 * (freq / 1000 - 470000) / (780000 - 470000);
222 dprintk("tf = %X\n", tf);
225 max2165_write_reg(priv, REG_TRACK_FILTER, tf);
230 static void max2165_debug_status(struct max2165_priv *priv)
233 u8 auto_vco_success, auto_vco_active;
235 u8 dc_offset_low, dc_offset_hi;
236 u8 signal_lv_over_threshold;
237 u8 vco, vco_sub_band, adc;
239 max2165_read_reg(priv, REG_STATUS, &status);
240 max2165_read_reg(priv, REG_AUTOTUNE, &autotune);
242 auto_vco_success = (status >> 6) & 0x01;
243 auto_vco_active = (status >> 5) & 0x01;
244 pll_locked = (status >> 4) & 0x01;
245 dc_offset_low = (status >> 3) & 0x01;
246 dc_offset_hi = (status >> 2) & 0x01;
247 signal_lv_over_threshold = status & 0x01;
250 vco_sub_band = (autotune >> 3) & 0x7;
251 adc = autotune & 0x7;
253 dprintk("auto VCO active: %d, auto VCO success: %d\n",
254 auto_vco_active, auto_vco_success);
255 dprintk("PLL locked: %d\n", pll_locked);
256 dprintk("DC offset low: %d, DC offset high: %d\n",
257 dc_offset_low, dc_offset_hi);
258 dprintk("Signal lvl over threshold: %d\n", signal_lv_over_threshold);
259 dprintk("VCO: %d, VCO Sub-band: %d, ADC: %d\n", vco, vco_sub_band, adc);
262 static int max2165_set_params(struct dvb_frontend *fe,
263 struct dvb_frontend_parameters *params)
265 struct max2165_priv *priv = fe->tuner_priv;
268 dprintk("%s() frequency=%d (Hz)\n", __func__, params->frequency);
269 if (fe->ops.info.type == FE_ATSC) {
271 } else if (fe->ops.info.type == FE_OFDM) {
272 dprintk("%s() OFDM\n", __func__);
273 switch (params->u.ofdm.bandwidth) {
274 case BANDWIDTH_6_MHZ:
276 case BANDWIDTH_7_MHZ:
277 case BANDWIDTH_8_MHZ:
278 priv->frequency = params->frequency;
279 priv->bandwidth = params->u.ofdm.bandwidth;
282 printk(KERN_ERR "MAX2165 bandwidth not set!\n");
286 printk(KERN_ERR "MAX2165 modulation type not supported!\n");
290 dprintk("%s() frequency=%d\n", __func__, priv->frequency);
292 if (fe->ops.i2c_gate_ctrl)
293 fe->ops.i2c_gate_ctrl(fe, 1);
294 max2165_set_bandwidth(priv, priv->bandwidth);
295 ret = max2165_set_rf(priv, priv->frequency);
297 max2165_debug_status(priv);
298 if (fe->ops.i2c_gate_ctrl)
299 fe->ops.i2c_gate_ctrl(fe, 0);
307 static int max2165_get_frequency(struct dvb_frontend *fe, u32 *freq)
309 struct max2165_priv *priv = fe->tuner_priv;
310 dprintk("%s()\n", __func__);
311 *freq = priv->frequency;
315 static int max2165_get_bandwidth(struct dvb_frontend *fe, u32 *bw)
317 struct max2165_priv *priv = fe->tuner_priv;
318 dprintk("%s()\n", __func__);
320 *bw = priv->bandwidth;
324 static int max2165_get_status(struct dvb_frontend *fe, u32 *status)
326 struct max2165_priv *priv = fe->tuner_priv;
329 dprintk("%s()\n", __func__);
331 if (fe->ops.i2c_gate_ctrl)
332 fe->ops.i2c_gate_ctrl(fe, 1);
334 max2165_debug_status(priv);
335 *status = lock_status;
337 if (fe->ops.i2c_gate_ctrl)
338 fe->ops.i2c_gate_ctrl(fe, 0);
343 static int max2165_sleep(struct dvb_frontend *fe)
345 dprintk("%s()\n", __func__);
349 static int max2165_init(struct dvb_frontend *fe)
351 struct max2165_priv *priv = fe->tuner_priv;
352 dprintk("%s()\n", __func__);
354 if (fe->ops.i2c_gate_ctrl)
355 fe->ops.i2c_gate_ctrl(fe, 1);
357 /* Setup initial values */
358 /* Fractional Mode on */
359 max2165_write_reg(priv, REG_NDIV_FRAC2, 0x18);
361 max2165_write_reg(priv, REG_LNA, 0x01);
362 max2165_write_reg(priv, REG_PLL_CFG, 0x7A);
363 max2165_write_reg(priv, REG_TEST, 0x08);
364 max2165_write_reg(priv, REG_SHUTDOWN, 0x40);
365 max2165_write_reg(priv, REG_VCO_CTRL, 0x84);
366 max2165_write_reg(priv, REG_BASEBAND_CTRL, 0xC3);
367 max2165_write_reg(priv, REG_DC_OFFSET_CTRL, 0x75);
368 max2165_write_reg(priv, REG_DC_OFFSET_DAC, 0x00);
369 max2165_write_reg(priv, REG_ROM_TABLE_ADDR, 0x00);
371 max2165_set_osc(priv, priv->config->osc_clk);
373 max2165_read_rom_table(priv);
375 max2165_set_bandwidth(priv, BANDWIDTH_8_MHZ);
377 if (fe->ops.i2c_gate_ctrl)
378 fe->ops.i2c_gate_ctrl(fe, 0);
383 static int max2165_release(struct dvb_frontend *fe)
385 struct max2165_priv *priv = fe->tuner_priv;
386 dprintk("%s()\n", __func__);
389 fe->tuner_priv = NULL;
394 static const struct dvb_tuner_ops max2165_tuner_ops = {
396 .name = "Maxim MAX2165",
397 .frequency_min = 470000000,
398 .frequency_max = 780000000,
399 .frequency_step = 50000,
402 .release = max2165_release,
403 .init = max2165_init,
404 .sleep = max2165_sleep,
406 .set_params = max2165_set_params,
407 .set_analog_params = NULL,
408 .get_frequency = max2165_get_frequency,
409 .get_bandwidth = max2165_get_bandwidth,
410 .get_status = max2165_get_status
413 struct dvb_frontend *max2165_attach(struct dvb_frontend *fe,
414 struct i2c_adapter *i2c,
415 struct max2165_config *cfg)
417 struct max2165_priv *priv = NULL;
419 dprintk("%s(%d-%04x)\n", __func__,
420 i2c ? i2c_adapter_id(i2c) : -1,
421 cfg ? cfg->i2c_address : -1);
423 priv = kzalloc(sizeof(struct max2165_priv), GFP_KERNEL);
427 memcpy(&fe->ops.tuner_ops, &max2165_tuner_ops,
428 sizeof(struct dvb_tuner_ops));
432 fe->tuner_priv = priv;
435 max2165_debug_status(priv);
439 EXPORT_SYMBOL(max2165_attach);
441 MODULE_AUTHOR("David T. L. Wong <davidtlwong@gmail.com>");
442 MODULE_DESCRIPTION("Maxim MAX2165 silicon tuner driver");
443 MODULE_LICENSE("GPL");