2 * Linux-DVB Driver for DiBcom's DiB0070 base-band RF Tuner.
4 * Copyright (C) 2005-9 DiBcom (http://www.dibcom.fr/)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * 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 * This code is more or less generated from another driver, please
23 * excuse some codingstyle oddities.
27 #include <linux/kernel.h>
28 #include <linux/i2c.h>
30 #include "dvb_frontend.h"
33 #include "dibx000_common.h"
36 module_param(debug, int, 0644);
37 MODULE_PARM_DESC(debug, "turn on debugging (default: 0)");
39 #define dprintk(args...) do { \
41 printk(KERN_DEBUG "DiB0070: "); \
47 #define DIB0070_P1D 0x00
48 #define DIB0070_P1F 0x01
49 #define DIB0070_P1G 0x03
50 #define DIB0070S_P1A 0x02
52 enum frontend_tune_state {
65 #define FE_CALLBACK_TIME_NEVER 0xffffffff
67 struct dib0070_state {
68 struct i2c_adapter *i2c;
69 struct dvb_frontend *fe;
70 const struct dib0070_config *cfg;
74 enum frontend_tune_state tune_state;
77 /* for the captrim binary search */
85 const struct dib0070_tuning *current_tune_table_index;
86 const struct dib0070_lna_match *lna_match;
89 u16 wbd_offset_3_3[2];
92 static uint16_t dib0070_read_reg(struct dib0070_state *state, u8 reg)
95 struct i2c_msg msg[2] = {
96 {.addr = state->cfg->i2c_address,.flags = 0,.buf = ®,.len = 1},
97 {.addr = state->cfg->i2c_address,.flags = I2C_M_RD,.buf = b,.len = 2},
99 if (i2c_transfer(state->i2c, msg, 2) != 2) {
100 printk(KERN_WARNING "DiB0070 I2C read failed\n");
103 return (b[0] << 8) | b[1];
106 static int dib0070_write_reg(struct dib0070_state *state, u8 reg, u16 val)
108 u8 b[3] = { reg, val >> 8, val & 0xff };
109 struct i2c_msg msg = {.addr = state->cfg->i2c_address,.flags = 0,.buf = b,.len = 3 };
110 if (i2c_transfer(state->i2c, &msg, 1) != 1) {
111 printk(KERN_WARNING "DiB0070 I2C write failed\n");
117 #define HARD_RESET(state) do { \
118 state->cfg->sleep(state->fe, 0); \
119 if (state->cfg->reset) { \
120 state->cfg->reset(state->fe,1); msleep(10); \
121 state->cfg->reset(state->fe,0); msleep(10); \
125 static int dib0070_set_bandwidth(struct dvb_frontend *fe, struct dvb_frontend_parameters *ch)
127 struct dib0070_state *state = fe->tuner_priv;
128 u16 tmp = dib0070_read_reg(state, 0x02) & 0x3fff;
130 if (state->fe->dtv_property_cache.bandwidth_hz / 1000 > 7000)
132 else if (state->fe->dtv_property_cache.bandwidth_hz / 1000 > 6000)
134 else if (state->fe->dtv_property_cache.bandwidth_hz / 1000 > 5000)
139 dib0070_write_reg(state, 0x02, tmp);
141 /* sharpen the BB filter in ISDB-T to have higher immunity to adjacent channels */
142 if (state->fe->dtv_property_cache.delivery_system == SYS_ISDBT) {
143 u16 value = dib0070_read_reg(state, 0x17);
145 dib0070_write_reg(state, 0x17, value & 0xfffc);
146 tmp = dib0070_read_reg(state, 0x01) & 0x01ff;
147 dib0070_write_reg(state, 0x01, tmp | (60 << 9));
149 dib0070_write_reg(state, 0x17, value);
154 static int dib0070_captrim(struct dib0070_state *state, enum frontend_tune_state *tune_state)
160 if (*tune_state == CT_TUNER_STEP_0) {
162 dib0070_write_reg(state, 0x0f, 0xed10);
163 dib0070_write_reg(state, 0x17, 0x0034);
165 dib0070_write_reg(state, 0x18, 0x0032);
166 state->step = state->captrim = state->fcaptrim = 64;
167 state->adc_diff = 3000;
170 *tune_state = CT_TUNER_STEP_1;
171 } else if (*tune_state == CT_TUNER_STEP_1) {
173 dib0070_write_reg(state, 0x14, state->lo4 | state->captrim);
176 *tune_state = CT_TUNER_STEP_2;
177 } else if (*tune_state == CT_TUNER_STEP_2) {
179 adc = dib0070_read_reg(state, 0x19);
181 dprintk("CAPTRIM=%hd; ADC = %hd (ADC) & %dmV", state->captrim, adc, (u32) adc * (u32) 1800 / (u32) 1024);
191 if (adc < state->adc_diff) {
192 dprintk("CAPTRIM=%hd is closer to target (%hd/%hd)", state->captrim, adc, state->adc_diff);
193 state->adc_diff = adc;
194 state->fcaptrim = state->captrim;
197 state->captrim += (step_sign * state->step);
199 if (state->step >= 1)
200 *tune_state = CT_TUNER_STEP_1;
202 *tune_state = CT_TUNER_STEP_3;
204 } else if (*tune_state == CT_TUNER_STEP_3) {
205 dib0070_write_reg(state, 0x14, state->lo4 | state->fcaptrim);
206 dib0070_write_reg(state, 0x18, 0x07ff);
207 *tune_state = CT_TUNER_STEP_4;
213 static int dib0070_set_ctrl_lo5(struct dvb_frontend *fe, u8 vco_bias_trim, u8 hf_div_trim, u8 cp_current, u8 third_order_filt)
215 struct dib0070_state *state = fe->tuner_priv;
216 u16 lo5 = (third_order_filt << 14) | (0 << 13) | (1 << 12) | (3 << 9) | (cp_current << 6) | (hf_div_trim << 3) | (vco_bias_trim << 0);
217 dprintk("CTRL_LO5: 0x%x", lo5);
218 return dib0070_write_reg(state, 0x15, lo5);
221 void dib0070_ctrl_agc_filter(struct dvb_frontend *fe, u8 open)
223 struct dib0070_state *state = fe->tuner_priv;
226 dib0070_write_reg(state, 0x1b, 0xff00);
227 dib0070_write_reg(state, 0x1a, 0x0000);
229 dib0070_write_reg(state, 0x1b, 0x4112);
230 if (state->cfg->vga_filter != 0) {
231 dib0070_write_reg(state, 0x1a, state->cfg->vga_filter);
232 dprintk("vga filter register is set to %x", state->cfg->vga_filter);
234 dib0070_write_reg(state, 0x1a, 0x0009);
238 EXPORT_SYMBOL(dib0070_ctrl_agc_filter);
239 struct dib0070_tuning {
240 u32 max_freq; /* for every frequency less than or equal to that field: this information is correct */
250 struct dib0070_lna_match {
251 u32 max_freq; /* for every frequency less than or equal to that field: this information is correct */
255 static const struct dib0070_tuning dib0070s_tuning_table[] = {
256 {570000, 2, 1, 3, 6, 6, 2, 0x4000 | 0x0800}, /* UHF */
257 {700000, 2, 0, 2, 4, 2, 2, 0x4000 | 0x0800},
258 {863999, 2, 1, 2, 4, 2, 2, 0x4000 | 0x0800},
259 {1500000, 0, 1, 1, 2, 2, 4, 0x2000 | 0x0400}, /* LBAND */
260 {1600000, 0, 1, 1, 2, 2, 4, 0x2000 | 0x0400},
261 {2000000, 0, 1, 1, 2, 2, 4, 0x2000 | 0x0400},
262 {0xffffffff, 0, 0, 8, 1, 2, 1, 0x8000 | 0x1000}, /* SBAND */
265 static const struct dib0070_tuning dib0070_tuning_table[] = {
266 {115000, 1, 0, 7, 24, 2, 1, 0x8000 | 0x1000}, /* FM below 92MHz cannot be tuned */
267 {179500, 1, 0, 3, 16, 2, 1, 0x8000 | 0x1000}, /* VHF */
268 {189999, 1, 1, 3, 16, 2, 1, 0x8000 | 0x1000},
269 {250000, 1, 0, 6, 12, 2, 1, 0x8000 | 0x1000},
270 {569999, 2, 1, 5, 6, 2, 2, 0x4000 | 0x0800}, /* UHF */
271 {699999, 2, 0, 1, 4, 2, 2, 0x4000 | 0x0800},
272 {863999, 2, 1, 1, 4, 2, 2, 0x4000 | 0x0800},
273 {0xffffffff, 0, 1, 0, 2, 2, 4, 0x2000 | 0x0400}, /* LBAND or everything higher than UHF */
276 static const struct dib0070_lna_match dib0070_lna_flip_chip[] = {
277 {180000, 0}, /* VHF */
281 {550000, 0}, /* UHF */
285 {1500000, 0}, /* LBAND or everything higher than UHF */
291 static const struct dib0070_lna_match dib0070_lna[] = {
292 {180000, 0}, /* VHF */
296 {550000, 2}, /* UHF */
301 {1500000, 0}, /* LBAND or everything higher than UHF */
307 #define LPF 100 // define for the loop filter 100kHz by default 16-07-06
308 static int dib0070_tune_digital(struct dvb_frontend *fe, struct dvb_frontend_parameters *ch)
310 struct dib0070_state *state = fe->tuner_priv;
312 const struct dib0070_tuning *tune;
313 const struct dib0070_lna_match *lna_match;
315 enum frontend_tune_state *tune_state = &state->tune_state;
316 int ret = 10; /* 1ms is the default delay most of the time */
318 u8 band = (u8) BAND_OF_FREQUENCY(fe->dtv_property_cache.frequency / 1000);
319 u32 freq = fe->dtv_property_cache.frequency / 1000 + (band == BAND_VHF ? state->cfg->freq_offset_khz_vhf : state->cfg->freq_offset_khz_uhf);
321 #ifdef CONFIG_SYS_ISDBT
322 if (state->fe->dtv_property_cache.delivery_system == SYS_ISDBT && state->fe->dtv_property_cache.isdbt_sb_mode == 1)
323 if (((state->fe->dtv_property_cache.isdbt_sb_segment_count % 2)
324 && (state->fe->dtv_property_cache.isdbt_sb_segment_idx == ((state->fe->dtv_property_cache.isdbt_sb_segment_count / 2) + 1)))
325 || (((state->fe->dtv_property_cache.isdbt_sb_segment_count % 2) == 0)
326 && (state->fe->dtv_property_cache.isdbt_sb_segment_idx == (state->fe->dtv_property_cache.isdbt_sb_segment_count / 2)))
327 || (((state->fe->dtv_property_cache.isdbt_sb_segment_count % 2) == 0)
328 && (state->fe->dtv_property_cache.isdbt_sb_segment_idx == ((state->fe->dtv_property_cache.isdbt_sb_segment_count / 2) + 1))))
331 if (state->current_rf != freq) {
333 switch (state->revision) {
335 tune = dib0070s_tuning_table;
336 lna_match = dib0070_lna;
339 tune = dib0070_tuning_table;
340 if (state->cfg->flip_chip)
341 lna_match = dib0070_lna_flip_chip;
343 lna_match = dib0070_lna;
346 while (freq > tune->max_freq) /* find the right one */
348 while (freq > lna_match->max_freq) /* find the right one */
351 state->current_tune_table_index = tune;
352 state->lna_match = lna_match;
355 if (*tune_state == CT_TUNER_START) {
356 dprintk("Tuning for Band: %hd (%d kHz)", band, freq);
357 if (state->current_rf != freq) {
359 u32 FBDiv, Rest, FREF, VCOF_kHz;
362 state->current_rf = freq;
363 state->lo4 = (state->current_tune_table_index->vco_band << 11) | (state->current_tune_table_index->hfdiv << 7);
365 dib0070_write_reg(state, 0x17, 0x30);
367 VCOF_kHz = state->current_tune_table_index->vco_multi * freq * 2;
371 REFDIV = (u8) ((state->cfg->clock_khz + 9999) / 10000);
374 REFDIV = (u8) ((state->cfg->clock_khz) / 1000);
377 REFDIV = (u8) (state->cfg->clock_khz / 10000);
380 FREF = state->cfg->clock_khz / REFDIV;
382 switch (state->revision) {
384 FBDiv = (VCOF_kHz / state->current_tune_table_index->presc / FREF);
385 Rest = (VCOF_kHz / state->current_tune_table_index->presc) - FBDiv * FREF;
391 FBDiv = (freq / (FREF / 2));
392 Rest = 2 * freq - FBDiv * FREF;
398 else if (Rest < 2 * LPF)
400 else if (Rest > (FREF - LPF)) {
403 } else if (Rest > (FREF - 2 * LPF))
404 Rest = FREF - 2 * LPF;
405 Rest = (Rest * 6528) / (FREF / 10);
409 state->lo4 |= (1 << 14) | (1 << 12);
413 dib0070_write_reg(state, 0x11, (u16) FBDiv);
414 dib0070_write_reg(state, 0x12, (Den << 8) | REFDIV);
415 dib0070_write_reg(state, 0x13, (u16) Rest);
417 if (state->revision == DIB0070S_P1A) {
419 if (band == BAND_SBAND) {
420 dib0070_set_ctrl_lo5(fe, 2, 4, 3, 0);
421 dib0070_write_reg(state, 0x1d, 0xFFFF);
423 dib0070_set_ctrl_lo5(fe, 5, 4, 3, 1);
426 dib0070_write_reg(state, 0x20,
427 0x0040 | 0x0020 | 0x0010 | 0x0008 | 0x0002 | 0x0001 | state->current_tune_table_index->tuner_enable);
429 dprintk("REFDIV: %hd, FREF: %d", REFDIV, FREF);
430 dprintk("FBDIV: %d, Rest: %d", FBDiv, Rest);
431 dprintk("Num: %hd, Den: %hd, SD: %hd", (u16) Rest, Den, (state->lo4 >> 12) & 0x1);
432 dprintk("HFDIV code: %hd", state->current_tune_table_index->hfdiv);
433 dprintk("VCO = %hd", state->current_tune_table_index->vco_band);
434 dprintk("VCOF: ((%hd*%d) << 1))", state->current_tune_table_index->vco_multi, freq);
436 *tune_state = CT_TUNER_STEP_0;
437 } else { /* we are already tuned to this frequency - the configuration is correct */
438 ret = 50; /* wakeup time */
439 *tune_state = CT_TUNER_STEP_5;
441 } else if ((*tune_state > CT_TUNER_START) && (*tune_state < CT_TUNER_STEP_4)) {
443 ret = dib0070_captrim(state, tune_state);
445 } else if (*tune_state == CT_TUNER_STEP_4) {
446 const struct dib0070_wbd_gain_cfg *tmp = state->cfg->wbd_gain;
448 while (freq / 1000 > tmp->freq) /* find the right one */
450 dib0070_write_reg(state, 0x0f,
451 (0 << 15) | (1 << 14) | (3 << 12) | (tmp->wbd_gain_val << 9) | (0 << 8) | (1 << 7) | (state->
452 current_tune_table_index->
454 state->wbd_gain_current = tmp->wbd_gain_val;
456 dib0070_write_reg(state, 0x0f,
457 (0 << 15) | (1 << 14) | (3 << 12) | (6 << 9) | (0 << 8) | (1 << 7) | (state->current_tune_table_index->
459 state->wbd_gain_current = 6;
462 dib0070_write_reg(state, 0x06, 0x3fff);
463 dib0070_write_reg(state, 0x07,
464 (state->current_tune_table_index->switch_trim << 11) | (7 << 8) | (state->lna_match->lna_band << 3) | (3 << 0));
465 dib0070_write_reg(state, 0x08, (state->lna_match->lna_band << 10) | (3 << 7) | (127));
466 dib0070_write_reg(state, 0x0d, 0x0d80);
468 dib0070_write_reg(state, 0x18, 0x07ff);
469 dib0070_write_reg(state, 0x17, 0x0033);
471 *tune_state = CT_TUNER_STEP_5;
472 } else if (*tune_state == CT_TUNER_STEP_5) {
473 dib0070_set_bandwidth(fe, ch);
474 *tune_state = CT_TUNER_STOP;
476 ret = FE_CALLBACK_TIME_NEVER; /* tuner finished, time to call again infinite */
481 static int dib0070_tune(struct dvb_frontend *fe, struct dvb_frontend_parameters *p)
483 struct dib0070_state *state = fe->tuner_priv;
486 state->tune_state = CT_TUNER_START;
489 ret = dib0070_tune_digital(fe, p);
490 if (ret != FE_CALLBACK_TIME_NEVER)
494 } while (state->tune_state != CT_TUNER_STOP);
499 static int dib0070_wakeup(struct dvb_frontend *fe)
501 struct dib0070_state *state = fe->tuner_priv;
502 if (state->cfg->sleep)
503 state->cfg->sleep(fe, 0);
507 static int dib0070_sleep(struct dvb_frontend *fe)
509 struct dib0070_state *state = fe->tuner_priv;
510 if (state->cfg->sleep)
511 state->cfg->sleep(fe, 1);
515 static const u16 dib0070_p1f_defaults[] = {
547 0x4000 | 0x0800 | 0x0040 | 0x0020 | 0x0010 | 0x0008 | 0x0002 | 0x0001,
552 static u16 dib0070_read_wbd_offset(struct dib0070_state *state, u8 gain)
554 u16 tuner_en = dib0070_read_reg(state, 0x20);
557 dib0070_write_reg(state, 0x18, 0x07ff);
558 dib0070_write_reg(state, 0x20, 0x0800 | 0x4000 | 0x0040 | 0x0020 | 0x0010 | 0x0008 | 0x0002 | 0x0001);
559 dib0070_write_reg(state, 0x0f, (1 << 14) | (2 << 12) | (gain << 9) | (1 << 8) | (1 << 7) | (0 << 0));
561 offset = dib0070_read_reg(state, 0x19);
562 dib0070_write_reg(state, 0x20, tuner_en);
566 static void dib0070_wbd_offset_calibration(struct dib0070_state *state)
569 for (gain = 6; gain < 8; gain++) {
570 state->wbd_offset_3_3[gain - 6] = ((dib0070_read_wbd_offset(state, gain) * 8 * 18 / 33 + 1) / 2);
571 dprintk("Gain: %d, WBDOffset (3.3V) = %hd", gain, state->wbd_offset_3_3[gain - 6]);
575 u16 dib0070_wbd_offset(struct dvb_frontend *fe)
577 struct dib0070_state *state = fe->tuner_priv;
578 const struct dib0070_wbd_gain_cfg *tmp = state->cfg->wbd_gain;
579 u32 freq = fe->dtv_property_cache.frequency / 1000;
582 while (freq / 1000 > tmp->freq) /* find the right one */
584 state->wbd_gain_current = tmp->wbd_gain_val;
586 state->wbd_gain_current = 6;
588 return state->wbd_offset_3_3[state->wbd_gain_current - 6];
591 EXPORT_SYMBOL(dib0070_wbd_offset);
593 #define pgm_read_word(w) (*w)
594 static int dib0070_reset(struct dvb_frontend *fe)
596 struct dib0070_state *state = fe->tuner_priv;
601 #ifndef FORCE_SBAND_TUNER
602 if ((dib0070_read_reg(state, 0x22) >> 9) & 0x1)
603 state->revision = (dib0070_read_reg(state, 0x1f) >> 8) & 0xff;
606 #warning forcing SBAND
608 state->revision = DIB0070S_P1A;
611 dprintk("Revision: %x", state->revision);
613 if (state->revision == DIB0070_P1D) {
614 dprintk("Error: this driver is not to be used meant for P1D or earlier");
618 n = (u16 *) dib0070_p1f_defaults;
619 l = pgm_read_word(n++);
621 r = pgm_read_word(n++);
623 dib0070_write_reg(state, (u8) r, pgm_read_word(n++));
626 l = pgm_read_word(n++);
629 if (state->cfg->force_crystal_mode != 0)
630 r = state->cfg->force_crystal_mode;
631 else if (state->cfg->clock_khz >= 24000)
636 r |= state->cfg->osc_buffer_state << 3;
638 dib0070_write_reg(state, 0x10, r);
639 dib0070_write_reg(state, 0x1f, (1 << 8) | ((state->cfg->clock_pad_drive & 0xf) << 5));
641 if (state->cfg->invert_iq) {
642 r = dib0070_read_reg(state, 0x02) & 0xffdf;
643 dib0070_write_reg(state, 0x02, r | (1 << 5));
646 if (state->revision == DIB0070S_P1A)
647 dib0070_set_ctrl_lo5(fe, 2, 4, 3, 0);
649 dib0070_set_ctrl_lo5(fe, 5, 4, state->cfg->charge_pump, state->cfg->enable_third_order_filter);
651 dib0070_write_reg(state, 0x01, (54 << 9) | 0xc8);
653 dib0070_wbd_offset_calibration(state);
658 static int dib0070_release(struct dvb_frontend *fe)
660 kfree(fe->tuner_priv);
661 fe->tuner_priv = NULL;
665 static const struct dvb_tuner_ops dib0070_ops = {
667 .name = "DiBcom DiB0070",
668 .frequency_min = 45000000,
669 .frequency_max = 860000000,
670 .frequency_step = 1000,
672 .release = dib0070_release,
674 .init = dib0070_wakeup,
675 .sleep = dib0070_sleep,
676 .set_params = dib0070_tune,
678 // .get_frequency = dib0070_get_frequency,
679 // .get_bandwidth = dib0070_get_bandwidth
682 struct dvb_frontend *dib0070_attach(struct dvb_frontend *fe, struct i2c_adapter *i2c, struct dib0070_config *cfg)
684 struct dib0070_state *state = kzalloc(sizeof(struct dib0070_state), GFP_KERNEL);
691 fe->tuner_priv = state;
693 if (dib0070_reset(fe) != 0)
696 printk(KERN_INFO "DiB0070: successfully identified\n");
697 memcpy(&fe->ops.tuner_ops, &dib0070_ops, sizeof(struct dvb_tuner_ops));
699 fe->tuner_priv = state;
704 fe->tuner_priv = NULL;
708 EXPORT_SYMBOL(dib0070_attach);
710 MODULE_AUTHOR("Patrick Boettcher <pboettcher@dibcom.fr>");
711 MODULE_DESCRIPTION("Driver for the DiBcom 0070 base-band RF Tuner");
712 MODULE_LICENSE("GPL");