2 TDA10023 - DVB-C decoder
3 (as used in Philips CU1216-3 NIM and the Reelbox DVB-C tuner card)
5 Copyright (C) 2005 Georg Acher, BayCom GmbH (acher at baycom dot de)
6 Copyright (c) 2006 Hartmut Birr (e9hack at gmail dot com)
8 Remotely based on tda10021.c
13 This program is free software; you can redistribute it and/or modify
14 it under the terms of the GNU General Public License as published by
15 the Free Software Foundation; either version 2 of the License, or
16 (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #include <linux/delay.h>
29 #include <linux/errno.h>
30 #include <linux/init.h>
31 #include <linux/kernel.h>
32 #include <linux/module.h>
33 #include <linux/string.h>
34 #include <linux/slab.h>
36 #include <asm/div64.h>
38 #include "dvb_frontend.h"
41 #define REG0_INIT_VAL 0x23
43 struct tda10023_state {
44 struct i2c_adapter* i2c;
45 /* configuration settings */
46 const struct tda10023_config *config;
47 struct dvb_frontend frontend;
64 static u8 tda10023_readreg (struct tda10023_state* state, u8 reg)
68 struct i2c_msg msg [] = { { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 1 },
69 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 1 } };
72 ret = i2c_transfer (state->i2c, msg, 2);
74 int num = state->frontend.dvb ? state->frontend.dvb->num : -1;
75 printk(KERN_ERR "DVB: TDA10023(%d): %s: readreg error "
76 "(reg == 0x%02x, ret == %i)\n",
77 num, __func__, reg, ret);
82 static int tda10023_writereg (struct tda10023_state* state, u8 reg, u8 data)
84 u8 buf[] = { reg, data };
85 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = 2 };
88 ret = i2c_transfer (state->i2c, &msg, 1);
90 int num = state->frontend.dvb ? state->frontend.dvb->num : -1;
91 printk(KERN_ERR "DVB: TDA10023(%d): %s, writereg error "
92 "(reg == 0x%02x, val == 0x%02x, ret == %i)\n",
93 num, __func__, reg, data, ret);
95 return (ret != 1) ? -EREMOTEIO : 0;
99 static int tda10023_writebit (struct tda10023_state* state, u8 reg, u8 mask,u8 data)
102 return tda10023_writereg(state, reg, data);
105 val=tda10023_readreg(state,reg);
108 return tda10023_writereg(state, reg, val);
112 static void tda10023_writetab(struct tda10023_state* state, u8* tab)
126 tda10023_writebit(state,r,m,v);
130 //get access to tuner
131 static int lock_tuner(struct tda10023_state* state)
133 u8 buf[2] = { 0x0f, 0xc0 };
134 struct i2c_msg msg = {.addr=state->config->demod_address, .flags=0, .buf=buf, .len=2};
136 if(i2c_transfer(state->i2c, &msg, 1) != 1)
138 printk("tda10023: lock tuner fails\n");
144 //release access from tuner
145 static int unlock_tuner(struct tda10023_state* state)
147 u8 buf[2] = { 0x0f, 0x40 };
148 struct i2c_msg msg_post={.addr=state->config->demod_address, .flags=0, .buf=buf, .len=2};
150 if(i2c_transfer(state->i2c, &msg_post, 1) != 1)
152 printk("tda10023: unlock tuner fails\n");
158 static int tda10023_setup_reg0 (struct tda10023_state* state, u8 reg0)
160 reg0 |= state->reg0 & 0x63;
162 tda10023_writereg (state, 0x00, reg0 & 0xfe);
163 tda10023_writereg (state, 0x00, reg0 | 0x01);
169 static int tda10023_set_symbolrate (struct tda10023_state* state, u32 sr)
176 /* avoid floating point operations multiplying syscloc and divider
178 u32 sysclk_x_10 = state->sysclk * 10;
180 if (sr < (u32)(sysclk_x_10/984)) {
183 } else if (sr < (u32)(sysclk_x_10/640)) {
186 } else if (sr < (u32)(sysclk_x_10/492)) {
189 } else if (sr < (u32)(sysclk_x_10/320)) {
192 } else if (sr < (u32)(sysclk_x_10/246)) {
195 } else if (sr < (u32)(sysclk_x_10/160)) {
198 } else if (sr < (u32)(sysclk_x_10/123)) {
203 BDRI = (state->sysclk)*16;
216 do_div(BDRX, state->sysclk); /* BDRX/=SYSCLK; */
220 dprintk("Symbolrate %i, BDR %i BDRI %i, NDEC %i\n",
221 sr, BDR, BDRI, NDEC);
222 tda10023_writebit (state, 0x03, 0xc0, NDEC<<6);
223 tda10023_writereg (state, 0x0a, BDR&255);
224 tda10023_writereg (state, 0x0b, (BDR>>8)&255);
225 tda10023_writereg (state, 0x0c, (BDR>>16)&31);
226 tda10023_writereg (state, 0x0d, BDRI);
227 tda10023_writereg (state, 0x3d, (SFIL<<7));
231 static int tda10023_init (struct dvb_frontend *fe)
233 struct tda10023_state* state = fe->demodulator_priv;
234 u8 tda10023_inittab[] = {
236 /* 000 */ 0x2a, 0xff, 0x02, /* PLL3, Bypass, Power Down */
237 /* 003 */ 0xff, 0x64, 0x00, /* Sleep 100ms */
238 /* 006 */ 0x2a, 0xff, 0x03, /* PLL3, Bypass, Power Down */
239 /* 009 */ 0xff, 0x64, 0x00, /* Sleep 100ms */
241 /* 012 */ 0x28, 0xff, (state->pll_m-1),
243 /* 015 */ 0x29, 0xff, ((state->pll_p-1)<<6)|(state->pll_n-1),
244 /* GPR FSAMPLING=1 */
245 /* 018 */ 0x00, 0xff, REG0_INIT_VAL,
246 /* 021 */ 0x2a, 0xff, 0x08, /* PLL3 PSACLK=1 */
247 /* 024 */ 0xff, 0x64, 0x00, /* Sleep 100ms */
248 /* 027 */ 0x1f, 0xff, 0x00, /* RESET */
249 /* 030 */ 0xff, 0x64, 0x00, /* Sleep 100ms */
250 /* 033 */ 0xe6, 0x0c, 0x04, /* RSCFG_IND */
251 /* 036 */ 0x10, 0xc0, 0x80, /* DECDVBCFG1 PBER=1 */
253 /* 039 */ 0x0e, 0xff, 0x82, /* GAIN1 */
254 /* 042 */ 0x03, 0x08, 0x08, /* CLKCONF DYN=1 */
255 /* 045 */ 0x2e, 0xbf, 0x30, /* AGCCONF2 TRIAGC=0,POSAGC=ENAGCIF=1
256 PPWMTUN=0 PPWMIF=0 */
257 /* 048 */ 0x01, 0xff, 0x30, /* AGCREF */
258 /* 051 */ 0x1e, 0x84, 0x84, /* CONTROL SACLK_ON=1 */
259 /* 054 */ 0x1b, 0xff, 0xc8, /* ADC TWOS=1 */
260 /* 057 */ 0x3b, 0xff, 0xff, /* IFMAX */
261 /* 060 */ 0x3c, 0xff, 0x00, /* IFMIN */
262 /* 063 */ 0x34, 0xff, 0x00, /* PWMREF */
263 /* 066 */ 0x35, 0xff, 0xff, /* TUNMAX */
264 /* 069 */ 0x36, 0xff, 0x00, /* TUNMIN */
265 /* 072 */ 0x06, 0xff, 0x7f, /* EQCONF1 POSI=7 ENADAPT=ENEQUAL=DFE=1 */
266 /* 075 */ 0x1c, 0x30, 0x30, /* EQCONF2 STEPALGO=SGNALGO=1 */
267 /* 078 */ 0x37, 0xff, 0xf6, /* DELTAF_LSB */
268 /* 081 */ 0x38, 0xff, 0xff, /* DELTAF_MSB */
269 /* 084 */ 0x02, 0xff, 0x93, /* AGCCONF1 IFS=1 KAGCIF=2 KAGCTUN=3 */
270 /* 087 */ 0x2d, 0xff, 0xf6, /* SWEEP SWPOS=1 SWDYN=7 SWSTEP=1 SWLEN=2 */
271 /* 090 */ 0x04, 0x10, 0x00, /* SWRAMP=1 */
272 /* 093 */ 0x12, 0xff, TDA10023_OUTPUT_MODE_PARALLEL_B, /*
273 INTP1 POCLKP=1 FEL=1 MFS=0 */
274 /* 096 */ 0x2b, 0x01, 0xa1, /* INTS1 */
275 /* 099 */ 0x20, 0xff, 0x04, /* INTP2 SWAPP=? MSBFIRSTP=? INTPSEL=? */
276 /* 102 */ 0x2c, 0xff, 0x0d, /* INTP/S TRIP=0 TRIS=0 */
277 /* 105 */ 0xc4, 0xff, 0x00,
278 /* 108 */ 0xc3, 0x30, 0x00,
279 /* 111 */ 0xb5, 0xff, 0x19, /* ERAGC_THD */
280 /* 114 */ 0x00, 0x03, 0x01, /* GPR, CLBS soft reset */
281 /* 117 */ 0x00, 0x03, 0x03, /* GPR, CLBS soft reset */
282 /* 120 */ 0xff, 0x64, 0x00, /* Sleep 100ms */
283 /* 123 */ 0xff, 0xff, 0xff
285 dprintk("DVB: TDA10023(%d): init chip\n", fe->dvb->num);
287 /* override default values if set in config */
288 if (state->config->deltaf) {
289 tda10023_inittab[80] = (state->config->deltaf & 0xff);
290 tda10023_inittab[83] = (state->config->deltaf >> 8);
293 if (state->config->output_mode)
294 tda10023_inittab[95] = state->config->output_mode;
296 tda10023_writetab(state, tda10023_inittab);
302 u8 qam, lockthr, mseth, aref, agcrefnyq, eragnyq_thd;
305 static int tda10023_set_parameters(struct dvb_frontend *fe)
307 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
308 u32 delsys = c->delivery_system;
309 unsigned qam = c->modulation;
311 struct tda10023_state* state = fe->demodulator_priv;
312 static const struct qam_params qam_params[] = {
313 /* Modulation QAM LOCKTHR MSETH AREF AGCREFNYQ ERAGCNYQ_THD */
314 [QPSK] = { (5<<2), 0x78, 0x8c, 0x96, 0x78, 0x4c },
315 [QAM_16] = { (0<<2), 0x87, 0xa2, 0x91, 0x8c, 0x57 },
316 [QAM_32] = { (1<<2), 0x64, 0x74, 0x96, 0x8c, 0x57 },
317 [QAM_64] = { (2<<2), 0x46, 0x43, 0x6a, 0x6a, 0x44 },
318 [QAM_128] = { (3<<2), 0x36, 0x34, 0x7e, 0x78, 0x4c },
319 [QAM_256] = { (4<<2), 0x26, 0x23, 0x6c, 0x5c, 0x3c },
323 case SYS_DVBC_ANNEX_A:
326 case SYS_DVBC_ANNEX_C:
334 * gcc optimizes the code below the same way as it would code:
335 * "if (qam > 5) return -EINVAL;"
336 * Yet, the code is clearer, as it shows what QAM standards are
337 * supported by the driver, and avoids the usage of magic numbers on
352 if (fe->ops.tuner_ops.set_params) {
353 fe->ops.tuner_ops.set_params(fe);
354 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
357 tda10023_set_symbolrate(state, c->symbol_rate);
358 tda10023_writereg(state, 0x05, qam_params[qam].lockthr);
359 tda10023_writereg(state, 0x08, qam_params[qam].mseth);
360 tda10023_writereg(state, 0x09, qam_params[qam].aref);
361 tda10023_writereg(state, 0xb4, qam_params[qam].agcrefnyq);
362 tda10023_writereg(state, 0xb6, qam_params[qam].eragnyq_thd);
364 tda10023_writereg(state, 0x04, (c->inversion ? 0x12 : 0x32));
365 tda10023_writebit(state, 0x04, 0x60, (c->inversion ? 0 : 0x20));
367 tda10023_writebit(state, 0x04, 0x40, 0x40);
370 tda10023_writebit(state, 0x3d, 0xfc, 0x03);
372 tda10023_writebit(state, 0x3d, 0xfc, 0x02);
374 tda10023_setup_reg0(state, qam_params[qam].qam);
379 static int tda10023_read_status(struct dvb_frontend *fe,
380 enum fe_status *status)
382 struct tda10023_state* state = fe->demodulator_priv;
387 //0x11[1] == CARLOCK -> Carrier locked
388 //0x11[2] == FSYNC -> Frame synchronisation
389 //0x11[3] == FEL -> Front End locked
390 //0x11[6] == NODVB -> DVB Mode Information
391 sync = tda10023_readreg (state, 0x11);
394 *status |= FE_HAS_SIGNAL|FE_HAS_CARRIER;
397 *status |= FE_HAS_SYNC|FE_HAS_VITERBI;
400 *status |= FE_HAS_LOCK;
405 static int tda10023_read_ber(struct dvb_frontend* fe, u32* ber)
407 struct tda10023_state* state = fe->demodulator_priv;
409 a=tda10023_readreg(state, 0x14);
410 b=tda10023_readreg(state, 0x15);
411 c=tda10023_readreg(state, 0x16)&0xf;
412 tda10023_writebit (state, 0x10, 0xc0, 0x00);
414 *ber = a | (b<<8)| (c<<16);
418 static int tda10023_read_signal_strength(struct dvb_frontend* fe, u16* strength)
420 struct tda10023_state* state = fe->demodulator_priv;
421 u8 ifgain=tda10023_readreg(state, 0x2f);
423 u16 gain = ((255-tda10023_readreg(state, 0x17))) + (255-ifgain)/16;
424 // Max raw value is about 0xb0 -> Normalize to >0xf0 after 0x90
426 gain=gain+2*(gain-0x90);
430 *strength = (gain<<8)|gain;
434 static int tda10023_read_snr(struct dvb_frontend* fe, u16* snr)
436 struct tda10023_state* state = fe->demodulator_priv;
438 u8 quality = ~tda10023_readreg(state, 0x18);
439 *snr = (quality << 8) | quality;
443 static int tda10023_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
445 struct tda10023_state* state = fe->demodulator_priv;
447 a= tda10023_readreg (state, 0x74);
448 b= tda10023_readreg (state, 0x75);
449 c= tda10023_readreg (state, 0x76);
450 d= tda10023_readreg (state, 0x77);
451 *ucblocks = a | (b<<8)|(c<<16)|(d<<24);
453 tda10023_writebit (state, 0x10, 0x20,0x00);
454 tda10023_writebit (state, 0x10, 0x20,0x20);
455 tda10023_writebit (state, 0x13, 0x01, 0x00);
460 static int tda10023_get_frontend(struct dvb_frontend *fe,
461 struct dtv_frontend_properties *p)
463 struct tda10023_state* state = fe->demodulator_priv;
467 sync = tda10023_readreg(state, 0x11);
468 afc = tda10023_readreg(state, 0x19);
469 inv = tda10023_readreg(state, 0x04);
472 /* AFC only valid when carrier has been recovered */
473 printk(sync & 2 ? "DVB: TDA10023(%d): AFC (%d) %dHz\n" :
474 "DVB: TDA10023(%d): [AFC (%d) %dHz]\n",
475 state->frontend.dvb->num, afc,
476 -((s32)p->symbol_rate * afc) >> 10);
479 p->inversion = (inv&0x20?0:1);
480 p->modulation = ((state->reg0 >> 2) & 7) + QAM_16;
482 p->fec_inner = FEC_NONE;
483 p->frequency = ((p->frequency + 31250) / 62500) * 62500;
486 p->frequency -= ((s32)p->symbol_rate * afc) >> 10;
491 static int tda10023_sleep(struct dvb_frontend* fe)
493 struct tda10023_state* state = fe->demodulator_priv;
495 tda10023_writereg (state, 0x1b, 0x02); /* pdown ADC */
496 tda10023_writereg (state, 0x00, 0x80); /* standby */
501 static int tda10023_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
503 struct tda10023_state* state = fe->demodulator_priv;
513 static void tda10023_release(struct dvb_frontend* fe)
515 struct tda10023_state* state = fe->demodulator_priv;
519 static struct dvb_frontend_ops tda10023_ops;
521 struct dvb_frontend *tda10023_attach(const struct tda10023_config *config,
522 struct i2c_adapter *i2c,
525 struct tda10023_state* state = NULL;
527 /* allocate memory for the internal state */
528 state = kzalloc(sizeof(struct tda10023_state), GFP_KERNEL);
529 if (state == NULL) goto error;
531 /* setup the state */
532 state->config = config;
535 /* wakeup if in standby */
536 tda10023_writereg (state, 0x00, 0x33);
537 /* check if the demod is there */
538 if ((tda10023_readreg(state, 0x1a) & 0xf0) != 0x70) goto error;
540 /* create dvb_frontend */
541 memcpy(&state->frontend.ops, &tda10023_ops, sizeof(struct dvb_frontend_ops));
543 state->reg0 = REG0_INIT_VAL;
544 if (state->config->xtal) {
545 state->xtal = state->config->xtal;
546 state->pll_m = state->config->pll_m;
547 state->pll_p = state->config->pll_p;
548 state->pll_n = state->config->pll_n;
550 /* set default values if not defined in config */
551 state->xtal = 28920000;
558 state->sysclk = (state->xtal * state->pll_m / \
559 (state->pll_n * state->pll_p));
561 state->frontend.ops.info.symbol_rate_min = (state->sysclk/2)/64;
562 state->frontend.ops.info.symbol_rate_max = (state->sysclk/2)/4;
564 dprintk("DVB: TDA10023 %s: xtal:%d pll_m:%d pll_p:%d pll_n:%d\n",
565 __func__, state->xtal, state->pll_m, state->pll_p,
568 state->frontend.demodulator_priv = state;
569 return &state->frontend;
576 static struct dvb_frontend_ops tda10023_ops = {
577 .delsys = { SYS_DVBC_ANNEX_A, SYS_DVBC_ANNEX_C },
579 .name = "Philips TDA10023 DVB-C",
580 .frequency_stepsize = 62500,
581 .frequency_min = 47000000,
582 .frequency_max = 862000000,
583 .symbol_rate_min = 0, /* set in tda10023_attach */
584 .symbol_rate_max = 0, /* set in tda10023_attach */
585 .caps = 0x400 | //FE_CAN_QAM_4
586 FE_CAN_QAM_16 | FE_CAN_QAM_32 | FE_CAN_QAM_64 |
587 FE_CAN_QAM_128 | FE_CAN_QAM_256 |
591 .release = tda10023_release,
593 .init = tda10023_init,
594 .sleep = tda10023_sleep,
595 .i2c_gate_ctrl = tda10023_i2c_gate_ctrl,
597 .set_frontend = tda10023_set_parameters,
598 .get_frontend = tda10023_get_frontend,
599 .read_status = tda10023_read_status,
600 .read_ber = tda10023_read_ber,
601 .read_signal_strength = tda10023_read_signal_strength,
602 .read_snr = tda10023_read_snr,
603 .read_ucblocks = tda10023_read_ucblocks,
607 MODULE_DESCRIPTION("Philips TDA10023 DVB-C demodulator driver");
608 MODULE_AUTHOR("Georg Acher, Hartmut Birr");
609 MODULE_LICENSE("GPL");
611 EXPORT_SYMBOL(tda10023_attach);