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 /* configuration settings */
40 const struct tda10021_config* config;
41 struct dvb_frontend frontend;
49 #define dprintk(x...) printk(x)
56 #define XIN 57840000UL
57 #define DISABLE_INVERSION(reg0) do { reg0 |= 0x20; } while (0)
58 #define ENABLE_INVERSION(reg0) do { reg0 &= ~0x20; } while (0)
59 #define HAS_INVERSION(reg0) (!(reg0 & 0x20))
61 #define FIN (XIN >> 4)
63 static int tda10021_inittab_size = 0x40;
64 static u8 tda10021_inittab[0x40]=
66 0x73, 0x6a, 0x23, 0x0a, 0x02, 0x37, 0x77, 0x1a,
67 0x37, 0x6a, 0x17, 0x8a, 0x1e, 0x86, 0x43, 0x40,
68 0xb8, 0x3f, 0xa0, 0x00, 0xcd, 0x01, 0x00, 0xff,
69 0x11, 0x00, 0x7c, 0x31, 0x30, 0x20, 0x00, 0x00,
70 0x02, 0x00, 0x00, 0x7d, 0x00, 0x00, 0x00, 0x00,
71 0x07, 0x00, 0x33, 0x11, 0x0d, 0x95, 0x08, 0x58,
72 0x00, 0x00, 0x80, 0x00, 0x80, 0xff, 0x00, 0x00,
73 0x04, 0x2d, 0x2f, 0xff, 0x00, 0x00, 0x00, 0x00,
76 static int tda10021_writereg (struct tda10021_state* state, u8 reg, u8 data)
78 u8 buf[] = { reg, data };
79 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = 2 };
82 ret = i2c_transfer (state->i2c, &msg, 1);
84 printk("DVB: TDA10021(%d): %s, writereg error "
85 "(reg == 0x%02x, val == 0x%02x, ret == %i)\n",
86 state->frontend.dvb->num, __FUNCTION__, reg, data, ret);
89 return (ret != 1) ? -EREMOTEIO : 0;
92 int tda10021_write_byte(struct dvb_frontend* fe, int reg, int data)
94 struct tda10021_state* state = fe->demodulator_priv;
96 return tda10021_writereg(state, reg, data);
98 EXPORT_SYMBOL(tda10021_write_byte);
100 static u8 tda10021_readreg (struct tda10021_state* state, u8 reg)
104 struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 1 },
105 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 1 } };
108 ret = i2c_transfer (state->i2c, msg, 2);
110 printk("DVB: TDA10021: %s: readreg error (ret == %i)\n",
115 //get access to tuner
116 static int lock_tuner(struct tda10021_state* state)
118 u8 buf[2] = { 0x0f, tda10021_inittab[0x0f] | 0x80 };
119 struct i2c_msg msg = {.addr=state->config->demod_address, .flags=0, .buf=buf, .len=2};
121 if(i2c_transfer(state->i2c, &msg, 1) != 1)
123 printk("tda10021: lock tuner fails\n");
129 //release access from tuner
130 static int unlock_tuner(struct tda10021_state* state)
132 u8 buf[2] = { 0x0f, tda10021_inittab[0x0f] & 0x7f };
133 struct i2c_msg msg_post={.addr=state->config->demod_address, .flags=0, .buf=buf, .len=2};
135 if(i2c_transfer(state->i2c, &msg_post, 1) != 1)
137 printk("tda10021: unlock tuner fails\n");
143 static int tda10021_setup_reg0 (struct tda10021_state* state, u8 reg0,
144 fe_spectral_inversion_t inversion)
146 reg0 |= state->reg0 & 0x63;
148 if (INVERSION_ON == inversion)
149 ENABLE_INVERSION(reg0);
150 else if (INVERSION_OFF == inversion)
151 DISABLE_INVERSION(reg0);
153 tda10021_writereg (state, 0x00, reg0 & 0xfe);
154 tda10021_writereg (state, 0x00, reg0 | 0x01);
160 static int tda10021_set_symbolrate (struct tda10021_state* state, u32 symbolrate)
168 if (symbolrate > XIN/2)
170 if (symbolrate < 500000)
173 if (symbolrate < XIN/16) NDEC = 1;
174 if (symbolrate < XIN/32) NDEC = 2;
175 if (symbolrate < XIN/64) NDEC = 3;
177 if (symbolrate < (u32)(XIN/12.3)) SFIL = 1;
178 if (symbolrate < (u32)(XIN/16)) SFIL = 0;
179 if (symbolrate < (u32)(XIN/24.6)) SFIL = 1;
180 if (symbolrate < (u32)(XIN/32)) SFIL = 0;
181 if (symbolrate < (u32)(XIN/49.2)) SFIL = 1;
182 if (symbolrate < (u32)(XIN/64)) SFIL = 0;
183 if (symbolrate < (u32)(XIN/98.4)) SFIL = 1;
186 ratio = (symbolrate << 4) / FIN;
187 tmp = ((symbolrate << 4) % FIN) << 8;
188 ratio = (ratio << 8) + tmp / FIN;
189 tmp = (tmp % FIN) << 8;
190 ratio = (ratio << 8) + (tmp + FIN/2) / FIN;
193 BDRI = (((XIN << 5) / symbolrate) + 1) / 2;
198 SFIL = (SFIL << 4) | tda10021_inittab[0x0E];
200 NDEC = (NDEC << 6) | tda10021_inittab[0x03];
202 tda10021_writereg (state, 0x03, NDEC);
203 tda10021_writereg (state, 0x0a, BDR&0xff);
204 tda10021_writereg (state, 0x0b, (BDR>> 8)&0xff);
205 tda10021_writereg (state, 0x0c, (BDR>>16)&0x3f);
207 tda10021_writereg (state, 0x0d, BDRI);
208 tda10021_writereg (state, 0x0e, SFIL);
213 static int tda10021_init (struct dvb_frontend *fe)
215 struct tda10021_state* state = fe->demodulator_priv;
218 dprintk("DVB: TDA10021(%d): init chip\n", fe->adapter->num);
220 //tda10021_writereg (fe, 0, 0);
222 for (i=0; i<tda10021_inittab_size; i++)
223 tda10021_writereg (state, i, tda10021_inittab[i]);
225 tda10021_writereg (state, 0x34, state->pwm);
228 //0x2A[3-0] == PDIV -> P multiplaying factor (P=PDIV+1)(default 0)
229 //0x2A[4] == BYPPLL -> Power down mode (default 1)
230 //0x2A[5] == LCK -> PLL Lock Flag
231 //0x2A[6] == POLAXIN -> Polarity of the input reference clock (default 0)
234 tda10021_writereg(state, 0x2a, tda10021_inittab[0x2a] & 0xef);
238 static int tda10021_set_parameters (struct dvb_frontend *fe,
239 struct dvb_frontend_parameters *p)
241 struct tda10021_state* state = fe->demodulator_priv;
243 //table for QAM4-QAM256 ready QAM4 QAM16 QAM32 QAM64 QAM128 QAM256
245 static const u8 reg0x00 [] = { 0x14, 0x00, 0x04, 0x08, 0x0c, 0x10 };
247 static const u8 reg0x01 [] = { 0x78, 0x8c, 0x8c, 0x6a, 0x78, 0x5c };
249 static const u8 reg0x05 [] = { 0x78, 0x87, 0x64, 0x46, 0x36, 0x26 };
251 static const u8 reg0x08 [] = { 0x8c, 0xa2, 0x74, 0x43, 0x34, 0x23 };
253 static const u8 reg0x09 [] = { 0x96, 0x91, 0x96, 0x6a, 0x7e, 0x6b };
255 int qam = p->u.qam.modulation;
257 if (qam < 0 || qam > 5)
260 //printk("tda10021: set frequency to %d qam=%d symrate=%d\n", p->frequency,qam,p->u.qam.symbol_rate);
262 if (fe->ops.tuner_ops.set_params) {
263 fe->ops.tuner_ops.set_params(fe, p);
264 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
267 tda10021_set_symbolrate (state, p->u.qam.symbol_rate);
268 tda10021_writereg (state, 0x34, state->pwm);
270 tda10021_writereg (state, 0x01, reg0x01[qam]);
271 tda10021_writereg (state, 0x05, reg0x05[qam]);
272 tda10021_writereg (state, 0x08, reg0x08[qam]);
273 tda10021_writereg (state, 0x09, reg0x09[qam]);
275 tda10021_setup_reg0 (state, reg0x00[qam], p->inversion);
280 static int tda10021_read_status(struct dvb_frontend* fe, fe_status_t* status)
282 struct tda10021_state* state = fe->demodulator_priv;
286 //0x11[0] == EQALGO -> Equalizer algorithms state
287 //0x11[1] == CARLOCK -> Carrier locked
288 //0x11[2] == FSYNC -> Frame synchronisation
289 //0x11[3] == FEL -> Front End locked
290 //0x11[6] == NODVB -> DVB Mode Information
291 sync = tda10021_readreg (state, 0x11);
294 *status |= FE_HAS_SIGNAL|FE_HAS_CARRIER;
297 *status |= FE_HAS_SYNC|FE_HAS_VITERBI;
300 *status |= FE_HAS_LOCK;
305 static int tda10021_read_ber(struct dvb_frontend* fe, u32* ber)
307 struct tda10021_state* state = fe->demodulator_priv;
309 u32 _ber = tda10021_readreg(state, 0x14) |
310 (tda10021_readreg(state, 0x15) << 8) |
311 ((tda10021_readreg(state, 0x16) & 0x0f) << 16);
317 static int tda10021_read_signal_strength(struct dvb_frontend* fe, u16* strength)
319 struct tda10021_state* state = fe->demodulator_priv;
321 u8 gain = tda10021_readreg(state, 0x17);
322 *strength = (gain << 8) | gain;
327 static int tda10021_read_snr(struct dvb_frontend* fe, u16* snr)
329 struct tda10021_state* state = fe->demodulator_priv;
331 u8 quality = ~tda10021_readreg(state, 0x18);
332 *snr = (quality << 8) | quality;
337 static int tda10021_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
339 struct tda10021_state* state = fe->demodulator_priv;
341 *ucblocks = tda10021_readreg (state, 0x13) & 0x7f;
342 if (*ucblocks == 0x7f)
343 *ucblocks = 0xffffffff;
345 /* reset uncorrected block counter */
346 tda10021_writereg (state, 0x10, tda10021_inittab[0x10] & 0xdf);
347 tda10021_writereg (state, 0x10, tda10021_inittab[0x10]);
352 static int tda10021_get_frontend(struct dvb_frontend* fe, struct dvb_frontend_parameters *p)
354 struct tda10021_state* state = fe->demodulator_priv;
358 sync = tda10021_readreg(state, 0x11);
359 afc = tda10021_readreg(state, 0x19);
361 /* AFC only valid when carrier has been recovered */
362 printk(sync & 2 ? "DVB: TDA10021(%d): AFC (%d) %dHz\n" :
363 "DVB: TDA10021(%d): [AFC (%d) %dHz]\n",
364 state->frontend.dvb->num, afc,
365 -((s32)p->u.qam.symbol_rate * afc) >> 10);
368 p->inversion = HAS_INVERSION(state->reg0) ? INVERSION_ON : INVERSION_OFF;
369 p->u.qam.modulation = ((state->reg0 >> 2) & 7) + QAM_16;
371 p->u.qam.fec_inner = FEC_NONE;
372 p->frequency = ((p->frequency + 31250) / 62500) * 62500;
375 p->frequency -= ((s32)p->u.qam.symbol_rate * afc) >> 10;
380 static int tda10021_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
382 struct tda10021_state* state = fe->demodulator_priv;
392 static int tda10021_sleep(struct dvb_frontend* fe)
394 struct tda10021_state* state = fe->demodulator_priv;
396 tda10021_writereg (state, 0x1b, 0x02); /* pdown ADC */
397 tda10021_writereg (state, 0x00, 0x80); /* standby */
402 static void tda10021_release(struct dvb_frontend* fe)
404 struct tda10021_state* state = fe->demodulator_priv;
408 static struct dvb_frontend_ops tda10021_ops;
410 struct dvb_frontend* tda10021_attach(const struct tda10021_config* config,
411 struct i2c_adapter* i2c,
414 struct tda10021_state* state = NULL;
416 /* allocate memory for the internal state */
417 state = kmalloc(sizeof(struct tda10021_state), GFP_KERNEL);
418 if (state == NULL) goto error;
420 /* setup the state */
421 state->config = config;
424 state->reg0 = tda10021_inittab[0];
426 /* check if the demod is there */
427 if ((tda10021_readreg(state, 0x1a) & 0xf0) != 0x70) goto error;
429 /* create dvb_frontend */
430 memcpy(&state->frontend.ops, &tda10021_ops, sizeof(struct dvb_frontend_ops));
431 state->frontend.demodulator_priv = state;
432 return &state->frontend;
439 static struct dvb_frontend_ops tda10021_ops = {
442 .name = "Philips TDA10021 DVB-C",
444 .frequency_stepsize = 62500,
445 .frequency_min = 51000000,
446 .frequency_max = 858000000,
447 .symbol_rate_min = (XIN/2)/64, /* SACLK/64 == (XIN/2)/64 */
448 .symbol_rate_max = (XIN/2)/4, /* SACLK/4 */
450 .frequency_tolerance = ???,
451 .symbol_rate_tolerance = ???, /* ppm */ /* == 8% (spec p. 5) */
453 .caps = 0x400 | //FE_CAN_QAM_4
454 FE_CAN_QAM_16 | FE_CAN_QAM_32 | FE_CAN_QAM_64 |
455 FE_CAN_QAM_128 | FE_CAN_QAM_256 |
459 .release = tda10021_release,
461 .init = tda10021_init,
462 .sleep = tda10021_sleep,
463 .i2c_gate_ctrl = tda10021_i2c_gate_ctrl,
465 .set_frontend = tda10021_set_parameters,
466 .get_frontend = tda10021_get_frontend,
468 .read_status = tda10021_read_status,
469 .read_ber = tda10021_read_ber,
470 .read_signal_strength = tda10021_read_signal_strength,
471 .read_snr = tda10021_read_snr,
472 .read_ucblocks = tda10021_read_ucblocks,
475 module_param(verbose, int, 0644);
476 MODULE_PARM_DESC(verbose, "print AFC offset after tuning for debugging the PWM setting");
478 MODULE_DESCRIPTION("Philips TDA10021 DVB-C demodulator driver");
479 MODULE_AUTHOR("Ralph Metzler, Holger Waechtler, Markus Schulz");
480 MODULE_LICENSE("GPL");
482 EXPORT_SYMBOL(tda10021_attach);