2 TDA10021 - Single Chip Cable Channel Receiver driver module
3 used on the the Siemens DVB-C cards
5 Copyright (C) 1999 Convergence Integrated Media GmbH <ralph@convergence.de>
6 Copyright (C) 2004 Markus Schulz <msc@antzsystem.de>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <linux/config.h>
25 #include <linux/delay.h>
26 #include <linux/errno.h>
27 #include <linux/init.h>
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/string.h>
31 #include <linux/slab.h>
33 #include "dvb_frontend.h"
37 struct tda10021_state {
38 struct i2c_adapter* i2c;
39 struct dvb_frontend_ops ops;
40 /* configuration settings */
41 const struct tda10021_config* config;
42 struct dvb_frontend frontend;
50 #define dprintk(x...) printk(x)
57 #define XIN 57840000UL
58 #define DISABLE_INVERSION(reg0) do { reg0 |= 0x20; } while (0)
59 #define ENABLE_INVERSION(reg0) do { reg0 &= ~0x20; } while (0)
60 #define HAS_INVERSION(reg0) (!(reg0 & 0x20))
62 #define FIN (XIN >> 4)
64 static int tda10021_inittab_size = 0x40;
65 static u8 tda10021_inittab[0x40]=
67 0x73, 0x6a, 0x23, 0x0a, 0x02, 0x37, 0x77, 0x1a,
68 0x37, 0x6a, 0x17, 0x8a, 0x1e, 0x86, 0x43, 0x40,
69 0xb8, 0x3f, 0xa0, 0x00, 0xcd, 0x01, 0x00, 0xff,
70 0x11, 0x00, 0x7c, 0x31, 0x30, 0x20, 0x00, 0x00,
71 0x02, 0x00, 0x00, 0x7d, 0x00, 0x00, 0x00, 0x00,
72 0x07, 0x00, 0x33, 0x11, 0x0d, 0x95, 0x08, 0x58,
73 0x00, 0x00, 0x80, 0x00, 0x80, 0xff, 0x00, 0x00,
74 0x04, 0x2d, 0x2f, 0xff, 0x00, 0x00, 0x00, 0x00,
77 static int tda10021_writereg (struct tda10021_state* state, u8 reg, u8 data)
79 u8 buf[] = { reg, data };
80 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = 2 };
83 ret = i2c_transfer (state->i2c, &msg, 1);
85 printk("DVB: TDA10021(%d): %s, writereg error "
86 "(reg == 0x%02x, val == 0x%02x, ret == %i)\n",
87 state->frontend.dvb->num, __FUNCTION__, reg, data, ret);
90 return (ret != 1) ? -EREMOTEIO : 0;
93 int tda10021_write_byte(struct dvb_frontend* fe, int reg, int data)
95 struct tda10021_state* state = fe->demodulator_priv;
97 return tda10021_writereg(state, reg, data);
99 EXPORT_SYMBOL(tda10021_write_byte);
101 static u8 tda10021_readreg (struct tda10021_state* state, u8 reg)
105 struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 1 },
106 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 1 } };
109 ret = i2c_transfer (state->i2c, msg, 2);
111 printk("DVB: TDA10021: %s: readreg error (ret == %i)\n",
116 //get access to tuner
117 static int lock_tuner(struct tda10021_state* state)
119 u8 buf[2] = { 0x0f, tda10021_inittab[0x0f] | 0x80 };
120 struct i2c_msg msg = {.addr=state->config->demod_address, .flags=0, .buf=buf, .len=2};
122 if(i2c_transfer(state->i2c, &msg, 1) != 1)
124 printk("tda10021: lock tuner fails\n");
130 //release access from tuner
131 static int unlock_tuner(struct tda10021_state* state)
133 u8 buf[2] = { 0x0f, tda10021_inittab[0x0f] & 0x7f };
134 struct i2c_msg msg_post={.addr=state->config->demod_address, .flags=0, .buf=buf, .len=2};
136 if(i2c_transfer(state->i2c, &msg_post, 1) != 1)
138 printk("tda10021: unlock tuner fails\n");
144 static int tda10021_setup_reg0 (struct tda10021_state* state, u8 reg0,
145 fe_spectral_inversion_t inversion)
147 reg0 |= state->reg0 & 0x63;
149 if (INVERSION_ON == inversion)
150 ENABLE_INVERSION(reg0);
151 else if (INVERSION_OFF == inversion)
152 DISABLE_INVERSION(reg0);
154 tda10021_writereg (state, 0x00, reg0 & 0xfe);
155 tda10021_writereg (state, 0x00, reg0 | 0x01);
161 static int tda10021_set_symbolrate (struct tda10021_state* state, u32 symbolrate)
169 if (symbolrate > XIN/2)
171 if (symbolrate < 500000)
174 if (symbolrate < XIN/16) NDEC = 1;
175 if (symbolrate < XIN/32) NDEC = 2;
176 if (symbolrate < XIN/64) NDEC = 3;
178 if (symbolrate < (u32)(XIN/12.3)) SFIL = 1;
179 if (symbolrate < (u32)(XIN/16)) SFIL = 0;
180 if (symbolrate < (u32)(XIN/24.6)) SFIL = 1;
181 if (symbolrate < (u32)(XIN/32)) SFIL = 0;
182 if (symbolrate < (u32)(XIN/49.2)) SFIL = 1;
183 if (symbolrate < (u32)(XIN/64)) SFIL = 0;
184 if (symbolrate < (u32)(XIN/98.4)) SFIL = 1;
187 ratio = (symbolrate << 4) / FIN;
188 tmp = ((symbolrate << 4) % FIN) << 8;
189 ratio = (ratio << 8) + tmp / FIN;
190 tmp = (tmp % FIN) << 8;
191 ratio = (ratio << 8) + (tmp + FIN/2) / FIN;
194 BDRI = (((XIN << 5) / symbolrate) + 1) / 2;
199 SFIL = (SFIL << 4) | tda10021_inittab[0x0E];
201 NDEC = (NDEC << 6) | tda10021_inittab[0x03];
203 tda10021_writereg (state, 0x03, NDEC);
204 tda10021_writereg (state, 0x0a, BDR&0xff);
205 tda10021_writereg (state, 0x0b, (BDR>> 8)&0xff);
206 tda10021_writereg (state, 0x0c, (BDR>>16)&0x3f);
208 tda10021_writereg (state, 0x0d, BDRI);
209 tda10021_writereg (state, 0x0e, SFIL);
214 static int tda10021_init (struct dvb_frontend *fe)
216 struct tda10021_state* state = fe->demodulator_priv;
219 dprintk("DVB: TDA10021(%d): init chip\n", fe->adapter->num);
221 //tda10021_writereg (fe, 0, 0);
223 for (i=0; i<tda10021_inittab_size; i++)
224 tda10021_writereg (state, i, tda10021_inittab[i]);
226 tda10021_writereg (state, 0x34, state->pwm);
229 //0x2A[3-0] == PDIV -> P multiplaying factor (P=PDIV+1)(default 0)
230 //0x2A[4] == BYPPLL -> Power down mode (default 1)
231 //0x2A[5] == LCK -> PLL Lock Flag
232 //0x2A[6] == POLAXIN -> Polarity of the input reference clock (default 0)
235 tda10021_writereg(state, 0x2a, tda10021_inittab[0x2a] & 0xef);
239 static int tda10021_set_parameters (struct dvb_frontend *fe,
240 struct dvb_frontend_parameters *p)
242 struct tda10021_state* state = fe->demodulator_priv;
244 //table for QAM4-QAM256 ready QAM4 QAM16 QAM32 QAM64 QAM128 QAM256
246 static const u8 reg0x00 [] = { 0x14, 0x00, 0x04, 0x08, 0x0c, 0x10 };
248 static const u8 reg0x01 [] = { 0x78, 0x8c, 0x8c, 0x6a, 0x78, 0x5c };
250 static const u8 reg0x05 [] = { 0x78, 0x87, 0x64, 0x46, 0x36, 0x26 };
252 static const u8 reg0x08 [] = { 0x8c, 0xa2, 0x74, 0x43, 0x34, 0x23 };
254 static const u8 reg0x09 [] = { 0x96, 0x91, 0x96, 0x6a, 0x7e, 0x6b };
256 int qam = p->u.qam.modulation;
258 if (qam < 0 || qam > 5)
261 //printk("tda10021: set frequency to %d qam=%d symrate=%d\n", p->frequency,qam,p->u.qam.symbol_rate);
263 if (fe->ops->tuner_ops.set_params) {
264 fe->ops->tuner_ops.set_params(fe, p);
265 if (fe->ops->i2c_gate_ctrl) fe->ops->i2c_gate_ctrl(fe, 0);
268 tda10021_set_symbolrate (state, p->u.qam.symbol_rate);
269 tda10021_writereg (state, 0x34, state->pwm);
271 tda10021_writereg (state, 0x01, reg0x01[qam]);
272 tda10021_writereg (state, 0x05, reg0x05[qam]);
273 tda10021_writereg (state, 0x08, reg0x08[qam]);
274 tda10021_writereg (state, 0x09, reg0x09[qam]);
276 tda10021_setup_reg0 (state, reg0x00[qam], p->inversion);
281 static int tda10021_read_status(struct dvb_frontend* fe, fe_status_t* status)
283 struct tda10021_state* state = fe->demodulator_priv;
287 //0x11[0] == EQALGO -> Equalizer algorithms state
288 //0x11[1] == CARLOCK -> Carrier locked
289 //0x11[2] == FSYNC -> Frame synchronisation
290 //0x11[3] == FEL -> Front End locked
291 //0x11[6] == NODVB -> DVB Mode Information
292 sync = tda10021_readreg (state, 0x11);
295 *status |= FE_HAS_SIGNAL|FE_HAS_CARRIER;
298 *status |= FE_HAS_SYNC|FE_HAS_VITERBI;
301 *status |= FE_HAS_LOCK;
306 static int tda10021_read_ber(struct dvb_frontend* fe, u32* ber)
308 struct tda10021_state* state = fe->demodulator_priv;
310 u32 _ber = tda10021_readreg(state, 0x14) |
311 (tda10021_readreg(state, 0x15) << 8) |
312 ((tda10021_readreg(state, 0x16) & 0x0f) << 16);
318 static int tda10021_read_signal_strength(struct dvb_frontend* fe, u16* strength)
320 struct tda10021_state* state = fe->demodulator_priv;
322 u8 gain = tda10021_readreg(state, 0x17);
323 *strength = (gain << 8) | gain;
328 static int tda10021_read_snr(struct dvb_frontend* fe, u16* snr)
330 struct tda10021_state* state = fe->demodulator_priv;
332 u8 quality = ~tda10021_readreg(state, 0x18);
333 *snr = (quality << 8) | quality;
338 static int tda10021_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
340 struct tda10021_state* state = fe->demodulator_priv;
342 *ucblocks = tda10021_readreg (state, 0x13) & 0x7f;
343 if (*ucblocks == 0x7f)
344 *ucblocks = 0xffffffff;
346 /* reset uncorrected block counter */
347 tda10021_writereg (state, 0x10, tda10021_inittab[0x10] & 0xdf);
348 tda10021_writereg (state, 0x10, tda10021_inittab[0x10]);
353 static int tda10021_get_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters *p)
355 struct tda10021_state* state = fe->demodulator_priv;
359 sync = tda10021_readreg(state, 0x11);
360 afc = tda10021_readreg(state, 0x19);
362 /* AFC only valid when carrier has been recovered */
363 printk(sync & 2 ? "DVB: TDA10021(%d): AFC (%d) %dHz\n" :
364 "DVB: TDA10021(%d): [AFC (%d) %dHz]\n",
365 state->frontend.dvb->num, afc,
366 -((s32)p->u.qam.symbol_rate * afc) >> 10);
369 p->inversion = HAS_INVERSION(state->reg0) ? INVERSION_ON : INVERSION_OFF;
370 p->u.qam.modulation = ((state->reg0 >> 2) & 7) + QAM_16;
372 p->u.qam.fec_inner = FEC_NONE;
373 p->frequency = ((p->frequency + 31250) / 62500) * 62500;
376 p->frequency -= ((s32)p->u.qam.symbol_rate * afc) >> 10;
381 static int tda10021_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
383 struct tda10021_state* state = fe->demodulator_priv;
393 static int tda10021_sleep(struct dvb_frontend* fe)
395 struct tda10021_state* state = fe->demodulator_priv;
397 tda10021_writereg (state, 0x1b, 0x02); /* pdown ADC */
398 tda10021_writereg (state, 0x00, 0x80); /* standby */
403 static void tda10021_release(struct dvb_frontend* fe)
405 struct tda10021_state* state = fe->demodulator_priv;
409 static struct dvb_frontend_ops tda10021_ops;
411 struct dvb_frontend* tda10021_attach(const struct tda10021_config* config,
412 struct i2c_adapter* i2c,
415 struct tda10021_state* state = NULL;
417 /* allocate memory for the internal state */
418 state = kmalloc(sizeof(struct tda10021_state), GFP_KERNEL);
419 if (state == NULL) goto error;
421 /* setup the state */
422 state->config = config;
424 memcpy(&state->ops, &tda10021_ops, sizeof(struct dvb_frontend_ops));
426 state->reg0 = tda10021_inittab[0];
428 /* check if the demod is there */
429 if ((tda10021_readreg(state, 0x1a) & 0xf0) != 0x70) goto error;
431 /* create dvb_frontend */
432 state->frontend.ops = &state->ops;
433 state->frontend.demodulator_priv = state;
434 return &state->frontend;
441 static struct dvb_frontend_ops tda10021_ops = {
444 .name = "Philips TDA10021 DVB-C",
446 .frequency_stepsize = 62500,
447 .frequency_min = 51000000,
448 .frequency_max = 858000000,
449 .symbol_rate_min = (XIN/2)/64, /* SACLK/64 == (XIN/2)/64 */
450 .symbol_rate_max = (XIN/2)/4, /* SACLK/4 */
452 .frequency_tolerance = ???,
453 .symbol_rate_tolerance = ???, /* ppm */ /* == 8% (spec p. 5) */
455 .caps = 0x400 | //FE_CAN_QAM_4
456 FE_CAN_QAM_16 | FE_CAN_QAM_32 | FE_CAN_QAM_64 |
457 FE_CAN_QAM_128 | FE_CAN_QAM_256 |
461 .release = tda10021_release,
463 .init = tda10021_init,
464 .sleep = tda10021_sleep,
465 .i2c_gate_ctrl = tda10021_i2c_gate_ctrl,
467 .set_frontend = tda10021_set_parameters,
468 .get_frontend = tda10021_get_frontend,
470 .read_status = tda10021_read_status,
471 .read_ber = tda10021_read_ber,
472 .read_signal_strength = tda10021_read_signal_strength,
473 .read_snr = tda10021_read_snr,
474 .read_ucblocks = tda10021_read_ucblocks,
477 module_param(verbose, int, 0644);
478 MODULE_PARM_DESC(verbose, "print AFC offset after tuning for debugging the PWM setting");
480 MODULE_DESCRIPTION("Philips TDA10021 DVB-C demodulator driver");
481 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Markus Schulz");
482 MODULE_LICENSE("GPL");
484 EXPORT_SYMBOL(tda10021_attach);