Avoid beyond bounds copy while caching ACL
[zen-stable.git] / drivers / media / dvb / frontends / tda10023.c
blobca1e0d54b69afcf343221120f7cb6636962a10d6
1 /*
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
9 Copyright (C) 1999 Convergence Integrated Media GmbH <ralph@convergence.de>
10 Copyright (C) 2004 Markus Schulz <msc@antzsystem.de>
11 Support for TDA10021
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"
39 #include "tda1002x.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;
49 u8 pwm;
50 u8 reg0;
52 /* clock settings */
53 u32 xtal;
54 u8 pll_m;
55 u8 pll_p;
56 u8 pll_n;
57 u32 sysclk;
60 #define dprintk(x...)
62 static int verbose;
64 static u8 tda10023_readreg (struct tda10023_state* state, u8 reg)
66 u8 b0 [] = { reg };
67 u8 b1 [] = { 0 };
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 } };
70 int ret;
72 ret = i2c_transfer (state->i2c, msg, 2);
73 if (ret != 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);
79 return b1[0];
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 };
86 int ret;
88 ret = i2c_transfer (state->i2c, &msg, 1);
89 if (ret != 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)
101 if (mask==0xff)
102 return tda10023_writereg(state, reg, data);
103 else {
104 u8 val;
105 val=tda10023_readreg(state,reg);
106 val&=~mask;
107 val|=(data&mask);
108 return tda10023_writereg(state, reg, val);
112 static void tda10023_writetab(struct tda10023_state* state, u8* tab)
114 u8 r,m,v;
115 while (1) {
116 r=*tab++;
117 m=*tab++;
118 v=*tab++;
119 if (r==0xff) {
120 if (m==0xff)
121 break;
122 else
123 msleep(m);
125 else
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");
139 return -EREMOTEIO;
141 return 0;
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");
153 return -EREMOTEIO;
155 return 0;
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);
165 state->reg0 = reg0;
166 return 0;
169 static int tda10023_set_symbolrate (struct tda10023_state* state, u32 sr)
171 s32 BDR;
172 s32 BDRI;
173 s16 SFIL=0;
174 u16 NDEC = 0;
176 /* avoid floating point operations multiplying syscloc and divider
177 by 10 */
178 u32 sysclk_x_10 = state->sysclk * 10;
180 if (sr < (u32)(sysclk_x_10/984)) {
181 NDEC=3;
182 SFIL=1;
183 } else if (sr < (u32)(sysclk_x_10/640)) {
184 NDEC=3;
185 SFIL=0;
186 } else if (sr < (u32)(sysclk_x_10/492)) {
187 NDEC=2;
188 SFIL=1;
189 } else if (sr < (u32)(sysclk_x_10/320)) {
190 NDEC=2;
191 SFIL=0;
192 } else if (sr < (u32)(sysclk_x_10/246)) {
193 NDEC=1;
194 SFIL=1;
195 } else if (sr < (u32)(sysclk_x_10/160)) {
196 NDEC=1;
197 SFIL=0;
198 } else if (sr < (u32)(sysclk_x_10/123)) {
199 NDEC=0;
200 SFIL=1;
203 BDRI = (state->sysclk)*16;
204 BDRI>>=NDEC;
205 BDRI +=sr/2;
206 BDRI /=sr;
208 if (BDRI>255)
209 BDRI=255;
212 u64 BDRX;
214 BDRX=1<<(24+NDEC);
215 BDRX*=sr;
216 do_div(BDRX, state->sysclk); /* BDRX/=SYSCLK; */
218 BDR=(s32)BDRX;
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));
228 return 0;
231 static int tda10023_init (struct dvb_frontend *fe)
233 struct tda10023_state* state = fe->demodulator_priv;
234 u8 tda10023_inittab[] = {
235 /* reg mask val */
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 */
240 /* PLL1 */
241 /* 012 */ 0x28, 0xff, (state->pll_m-1),
242 /* PLL2 */
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);
298 return 0;
301 struct qam_params {
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;
310 bool is_annex_c;
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 },
322 switch (delsys) {
323 case SYS_DVBC_ANNEX_A:
324 is_annex_c = false;
325 break;
326 case SYS_DVBC_ANNEX_C:
327 is_annex_c = true;
328 break;
329 default:
330 return -EINVAL;
334 * gcc optimizes the code bellow 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
338 * it.
340 switch (qam) {
341 case QPSK:
342 case QAM_16:
343 case QAM_32:
344 case QAM_64:
345 case QAM_128:
346 case QAM_256:
347 break;
348 default:
349 return -EINVAL;
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);
363 #if 0
364 tda10023_writereg(state, 0x04, (c->inversion ? 0x12 : 0x32));
365 tda10023_writebit(state, 0x04, 0x60, (c->inversion ? 0 : 0x20));
366 #endif
367 tda10023_writebit(state, 0x04, 0x40, 0x40);
369 if (is_annex_c)
370 tda10023_writebit(state, 0x3d, 0xfc, 0x03);
371 else
372 tda10023_writebit(state, 0x3d, 0xfc, 0x02);
374 tda10023_setup_reg0(state, qam_params[qam].qam);
376 return 0;
379 static int tda10023_read_status(struct dvb_frontend* fe, fe_status_t* status)
381 struct tda10023_state* state = fe->demodulator_priv;
382 int sync;
384 *status = 0;
386 //0x11[1] == CARLOCK -> Carrier locked
387 //0x11[2] == FSYNC -> Frame synchronisation
388 //0x11[3] == FEL -> Front End locked
389 //0x11[6] == NODVB -> DVB Mode Information
390 sync = tda10023_readreg (state, 0x11);
392 if (sync & 2)
393 *status |= FE_HAS_SIGNAL|FE_HAS_CARRIER;
395 if (sync & 4)
396 *status |= FE_HAS_SYNC|FE_HAS_VITERBI;
398 if (sync & 8)
399 *status |= FE_HAS_LOCK;
401 return 0;
404 static int tda10023_read_ber(struct dvb_frontend* fe, u32* ber)
406 struct tda10023_state* state = fe->demodulator_priv;
407 u8 a,b,c;
408 a=tda10023_readreg(state, 0x14);
409 b=tda10023_readreg(state, 0x15);
410 c=tda10023_readreg(state, 0x16)&0xf;
411 tda10023_writebit (state, 0x10, 0xc0, 0x00);
413 *ber = a | (b<<8)| (c<<16);
414 return 0;
417 static int tda10023_read_signal_strength(struct dvb_frontend* fe, u16* strength)
419 struct tda10023_state* state = fe->demodulator_priv;
420 u8 ifgain=tda10023_readreg(state, 0x2f);
422 u16 gain = ((255-tda10023_readreg(state, 0x17))) + (255-ifgain)/16;
423 // Max raw value is about 0xb0 -> Normalize to >0xf0 after 0x90
424 if (gain>0x90)
425 gain=gain+2*(gain-0x90);
426 if (gain>255)
427 gain=255;
429 *strength = (gain<<8)|gain;
430 return 0;
433 static int tda10023_read_snr(struct dvb_frontend* fe, u16* snr)
435 struct tda10023_state* state = fe->demodulator_priv;
437 u8 quality = ~tda10023_readreg(state, 0x18);
438 *snr = (quality << 8) | quality;
439 return 0;
442 static int tda10023_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
444 struct tda10023_state* state = fe->demodulator_priv;
445 u8 a,b,c,d;
446 a= tda10023_readreg (state, 0x74);
447 b= tda10023_readreg (state, 0x75);
448 c= tda10023_readreg (state, 0x76);
449 d= tda10023_readreg (state, 0x77);
450 *ucblocks = a | (b<<8)|(c<<16)|(d<<24);
452 tda10023_writebit (state, 0x10, 0x20,0x00);
453 tda10023_writebit (state, 0x10, 0x20,0x20);
454 tda10023_writebit (state, 0x13, 0x01, 0x00);
456 return 0;
459 static int tda10023_get_frontend(struct dvb_frontend *fe)
461 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
462 struct tda10023_state* state = fe->demodulator_priv;
463 int sync,inv;
464 s8 afc = 0;
466 sync = tda10023_readreg(state, 0x11);
467 afc = tda10023_readreg(state, 0x19);
468 inv = tda10023_readreg(state, 0x04);
470 if (verbose) {
471 /* AFC only valid when carrier has been recovered */
472 printk(sync & 2 ? "DVB: TDA10023(%d): AFC (%d) %dHz\n" :
473 "DVB: TDA10023(%d): [AFC (%d) %dHz]\n",
474 state->frontend.dvb->num, afc,
475 -((s32)p->symbol_rate * afc) >> 10);
478 p->inversion = (inv&0x20?0:1);
479 p->modulation = ((state->reg0 >> 2) & 7) + QAM_16;
481 p->fec_inner = FEC_NONE;
482 p->frequency = ((p->frequency + 31250) / 62500) * 62500;
484 if (sync & 2)
485 p->frequency -= ((s32)p->symbol_rate * afc) >> 10;
487 return 0;
490 static int tda10023_sleep(struct dvb_frontend* fe)
492 struct tda10023_state* state = fe->demodulator_priv;
494 tda10023_writereg (state, 0x1b, 0x02); /* pdown ADC */
495 tda10023_writereg (state, 0x00, 0x80); /* standby */
497 return 0;
500 static int tda10023_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
502 struct tda10023_state* state = fe->demodulator_priv;
504 if (enable) {
505 lock_tuner(state);
506 } else {
507 unlock_tuner(state);
509 return 0;
512 static void tda10023_release(struct dvb_frontend* fe)
514 struct tda10023_state* state = fe->demodulator_priv;
515 kfree(state);
518 static struct dvb_frontend_ops tda10023_ops;
520 struct dvb_frontend *tda10023_attach(const struct tda10023_config *config,
521 struct i2c_adapter *i2c,
522 u8 pwm)
524 struct tda10023_state* state = NULL;
526 /* allocate memory for the internal state */
527 state = kzalloc(sizeof(struct tda10023_state), GFP_KERNEL);
528 if (state == NULL) goto error;
530 /* setup the state */
531 state->config = config;
532 state->i2c = i2c;
534 /* wakeup if in standby */
535 tda10023_writereg (state, 0x00, 0x33);
536 /* check if the demod is there */
537 if ((tda10023_readreg(state, 0x1a) & 0xf0) != 0x70) goto error;
539 /* create dvb_frontend */
540 memcpy(&state->frontend.ops, &tda10023_ops, sizeof(struct dvb_frontend_ops));
541 state->pwm = pwm;
542 state->reg0 = REG0_INIT_VAL;
543 if (state->config->xtal) {
544 state->xtal = state->config->xtal;
545 state->pll_m = state->config->pll_m;
546 state->pll_p = state->config->pll_p;
547 state->pll_n = state->config->pll_n;
548 } else {
549 /* set default values if not defined in config */
550 state->xtal = 28920000;
551 state->pll_m = 8;
552 state->pll_p = 4;
553 state->pll_n = 1;
556 /* calc sysclk */
557 state->sysclk = (state->xtal * state->pll_m / \
558 (state->pll_n * state->pll_p));
560 state->frontend.ops.info.symbol_rate_min = (state->sysclk/2)/64;
561 state->frontend.ops.info.symbol_rate_max = (state->sysclk/2)/4;
563 dprintk("DVB: TDA10023 %s: xtal:%d pll_m:%d pll_p:%d pll_n:%d\n",
564 __func__, state->xtal, state->pll_m, state->pll_p,
565 state->pll_n);
567 state->frontend.demodulator_priv = state;
568 return &state->frontend;
570 error:
571 kfree(state);
572 return NULL;
575 static struct dvb_frontend_ops tda10023_ops = {
576 .delsys = { SYS_DVBC_ANNEX_A, SYS_DVBC_ANNEX_C },
577 .info = {
578 .name = "Philips TDA10023 DVB-C",
579 .frequency_stepsize = 62500,
580 .frequency_min = 47000000,
581 .frequency_max = 862000000,
582 .symbol_rate_min = 0, /* set in tda10023_attach */
583 .symbol_rate_max = 0, /* set in tda10023_attach */
584 .caps = 0x400 | //FE_CAN_QAM_4
585 FE_CAN_QAM_16 | FE_CAN_QAM_32 | FE_CAN_QAM_64 |
586 FE_CAN_QAM_128 | FE_CAN_QAM_256 |
587 FE_CAN_FEC_AUTO
590 .release = tda10023_release,
592 .init = tda10023_init,
593 .sleep = tda10023_sleep,
594 .i2c_gate_ctrl = tda10023_i2c_gate_ctrl,
596 .set_frontend = tda10023_set_parameters,
597 .get_frontend = tda10023_get_frontend,
598 .read_status = tda10023_read_status,
599 .read_ber = tda10023_read_ber,
600 .read_signal_strength = tda10023_read_signal_strength,
601 .read_snr = tda10023_read_snr,
602 .read_ucblocks = tda10023_read_ucblocks,
606 MODULE_DESCRIPTION("Philips TDA10023 DVB-C demodulator driver");
607 MODULE_AUTHOR("Georg Acher, Hartmut Birr");
608 MODULE_LICENSE("GPL");
610 EXPORT_SYMBOL(tda10023_attach);