Merge branch 'linus' into pci-for-jesse
[linux-2.6] / drivers / media / dvb / frontends / au8522.c
1 /*
2     Auvitek AU8522 QAM/8VSB demodulator driver
3
4     Copyright (C) 2008 Steven Toth <stoth@hauppauge.com>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20 */
21
22 #include <linux/kernel.h>
23 #include <linux/init.h>
24 #include <linux/module.h>
25 #include <linux/string.h>
26 #include <linux/slab.h>
27 #include <linux/delay.h>
28 #include "dvb_frontend.h"
29 #include "dvb-pll.h"
30 #include "au8522.h"
31
32 struct au8522_state {
33
34         struct i2c_adapter *i2c;
35
36         /* configuration settings */
37         const struct au8522_config *config;
38
39         struct dvb_frontend frontend;
40
41         u32 current_frequency;
42         fe_modulation_t current_modulation;
43
44 };
45
46 static int debug;
47
48 #define dprintk(arg...) do {            \
49         if (debug)                      \
50                  printk(arg);           \
51         } while (0)
52
53 /* 16 bit registers, 8 bit values */
54 static int au8522_writereg(struct au8522_state *state, u16 reg, u8 data)
55 {
56         int ret;
57         u8 buf [] = { reg >> 8, reg & 0xff, data };
58
59         struct i2c_msg msg = { .addr = state->config->demod_address,
60                                .flags = 0, .buf = buf, .len = 3 };
61
62         ret = i2c_transfer(state->i2c, &msg, 1);
63
64         if (ret != 1)
65                 printk("%s: writereg error (reg == 0x%02x, val == 0x%04x, "
66                        "ret == %i)\n", __func__, reg, data, ret);
67
68         return (ret != 1) ? -1 : 0;
69 }
70
71 static u8 au8522_readreg(struct au8522_state *state, u16 reg)
72 {
73         int ret;
74         u8 b0 [] = { reg >> 8, reg & 0xff };
75         u8 b1 [] = { 0 };
76
77         struct i2c_msg msg [] = {
78                 { .addr = state->config->demod_address, .flags = 0,
79                   .buf = b0, .len = 2 },
80                 { .addr = state->config->demod_address, .flags = I2C_M_RD,
81                   .buf = b1, .len = 1 } };
82
83         ret = i2c_transfer(state->i2c, msg, 2);
84
85         if (ret != 2)
86                 printk(KERN_ERR "%s: readreg error (ret == %i)\n",
87                        __func__, ret);
88         return b1[0];
89 }
90
91 static int au8522_i2c_gate_ctrl(struct dvb_frontend *fe, int enable)
92 {
93         struct au8522_state *state = fe->demodulator_priv;
94
95         dprintk("%s(%d)\n", __func__, enable);
96
97         if (enable)
98                 return au8522_writereg(state, 0x106, 1);
99         else
100                 return au8522_writereg(state, 0x106, 0);
101 }
102
103 struct mse2snr_tab {
104         u16 val;
105         u16 data;
106 };
107
108 /* VSB SNR lookup table */
109 static struct mse2snr_tab vsb_mse2snr_tab[] = {
110         {   0, 270 },
111         {   2, 250 },
112         {   3, 240 },
113         {   5, 230 },
114         {   7, 220 },
115         {   9, 210 },
116         {  12, 200 },
117         {  13, 195 },
118         {  15, 190 },
119         {  17, 185 },
120         {  19, 180 },
121         {  21, 175 },
122         {  24, 170 },
123         {  27, 165 },
124         {  31, 160 },
125         {  32, 158 },
126         {  33, 156 },
127         {  36, 152 },
128         {  37, 150 },
129         {  39, 148 },
130         {  40, 146 },
131         {  41, 144 },
132         {  43, 142 },
133         {  44, 140 },
134         {  48, 135 },
135         {  50, 130 },
136         {  43, 142 },
137         {  53, 125 },
138         {  56, 120 },
139         { 256, 115 },
140 };
141
142 /* QAM64 SNR lookup table */
143 static struct mse2snr_tab qam64_mse2snr_tab[] = {
144         {  15,   0 },
145         {  16, 290 },
146         {  17, 288 },
147         {  18, 286 },
148         {  19, 284 },
149         {  20, 282 },
150         {  21, 281 },
151         {  22, 279 },
152         {  23, 277 },
153         {  24, 275 },
154         {  25, 273 },
155         {  26, 271 },
156         {  27, 269 },
157         {  28, 268 },
158         {  29, 266 },
159         {  30, 264 },
160         {  31, 262 },
161         {  32, 260 },
162         {  33, 259 },
163         {  34, 258 },
164         {  35, 256 },
165         {  36, 255 },
166         {  37, 254 },
167         {  38, 252 },
168         {  39, 251 },
169         {  40, 250 },
170         {  41, 249 },
171         {  42, 248 },
172         {  43, 246 },
173         {  44, 245 },
174         {  45, 244 },
175         {  46, 242 },
176         {  47, 241 },
177         {  48, 240 },
178         {  50, 239 },
179         {  51, 238 },
180         {  53, 237 },
181         {  54, 236 },
182         {  56, 235 },
183         {  57, 234 },
184         {  59, 233 },
185         {  60, 232 },
186         {  62, 231 },
187         {  63, 230 },
188         {  65, 229 },
189         {  67, 228 },
190         {  68, 227 },
191         {  70, 226 },
192         {  71, 225 },
193         {  73, 224 },
194         {  74, 223 },
195         {  76, 222 },
196         {  78, 221 },
197         {  80, 220 },
198         {  82, 219 },
199         {  85, 218 },
200         {  88, 217 },
201         {  90, 216 },
202         {  92, 215 },
203         {  93, 214 },
204         {  94, 212 },
205         {  95, 211 },
206         {  97, 210 },
207         {  99, 209 },
208         { 101, 208 },
209         { 102, 207 },
210         { 104, 206 },
211         { 107, 205 },
212         { 111, 204 },
213         { 114, 203 },
214         { 118, 202 },
215         { 122, 201 },
216         { 125, 200 },
217         { 128, 199 },
218         { 130, 198 },
219         { 132, 197 },
220         { 256, 190 },
221 };
222
223 /* QAM256 SNR lookup table */
224 static struct mse2snr_tab qam256_mse2snr_tab[] = {
225         {  16,   0 },
226         {  17, 400 },
227         {  18, 398 },
228         {  19, 396 },
229         {  20, 394 },
230         {  21, 392 },
231         {  22, 390 },
232         {  23, 388 },
233         {  24, 386 },
234         {  25, 384 },
235         {  26, 382 },
236         {  27, 380 },
237         {  28, 379 },
238         {  29, 378 },
239         {  30, 377 },
240         {  31, 376 },
241         {  32, 375 },
242         {  33, 374 },
243         {  34, 373 },
244         {  35, 372 },
245         {  36, 371 },
246         {  37, 370 },
247         {  38, 362 },
248         {  39, 354 },
249         {  40, 346 },
250         {  41, 338 },
251         {  42, 330 },
252         {  43, 328 },
253         {  44, 326 },
254         {  45, 324 },
255         {  46, 322 },
256         {  47, 320 },
257         {  48, 319 },
258         {  49, 318 },
259         {  50, 317 },
260         {  51, 316 },
261         {  52, 315 },
262         {  53, 314 },
263         {  54, 313 },
264         {  55, 312 },
265         {  56, 311 },
266         {  57, 310 },
267         {  58, 308 },
268         {  59, 306 },
269         {  60, 304 },
270         {  61, 302 },
271         {  62, 300 },
272         {  63, 298 },
273         {  65, 295 },
274         {  68, 294 },
275         {  70, 293 },
276         {  73, 292 },
277         {  76, 291 },
278         {  78, 290 },
279         {  79, 289 },
280         {  81, 288 },
281         {  82, 287 },
282         {  83, 286 },
283         {  84, 285 },
284         {  85, 284 },
285         {  86, 283 },
286         {  88, 282 },
287         {  89, 281 },
288         { 256, 280 },
289 };
290
291 static int au8522_mse2snr_lookup(struct mse2snr_tab *tab, int sz, int mse,
292                                  u16 *snr)
293 {
294         int i, ret = -EINVAL;
295         dprintk("%s()\n", __func__);
296
297         for (i = 0; i < sz; i++) {
298                 if (mse < tab[i].val) {
299                         *snr = tab[i].data;
300                         ret = 0;
301                         break;
302                 }
303         }
304         dprintk("%s() snr=%d\n", __func__, *snr);
305         return ret;
306 }
307
308 /* VSB Modulation table */
309 static struct {
310         u16 reg;
311         u16 data;
312 } VSB_mod_tab[] = {
313         { 0x8090, 0x84 },
314         { 0x4092, 0x11 },
315         { 0x2005, 0x00 },
316         { 0x8091, 0x80 },
317         { 0x80a3, 0x0c },
318         { 0x80a4, 0xe8 },
319         { 0x8081, 0xc4 },
320         { 0x80a5, 0x40 },
321         { 0x80a7, 0x40 },
322         { 0x80a6, 0x67 },
323         { 0x8262, 0x20 },
324         { 0x821c, 0x30 },
325         { 0x80d8, 0x1a },
326         { 0x8227, 0xa0 },
327         { 0x8121, 0xff },
328         { 0x80a8, 0xf0 },
329         { 0x80a9, 0x05 },
330         { 0x80aa, 0x77 },
331         { 0x80ab, 0xf0 },
332         { 0x80ac, 0x05 },
333         { 0x80ad, 0x77 },
334         { 0x80ae, 0x41 },
335         { 0x80af, 0x66 },
336         { 0x821b, 0xcc },
337         { 0x821d, 0x80 },
338         { 0x80b5, 0xfb },
339         { 0x80b6, 0x8e },
340         { 0x80b7, 0x39 },
341         { 0x80a4, 0xe8 },
342         { 0x8231, 0x13 },
343 };
344
345 /* QAM Modulation table */
346 static struct {
347         u16 reg;
348         u16 data;
349 } QAM_mod_tab[] = {
350         { 0x80a3, 0x09 },
351         { 0x80a4, 0x00 },
352         { 0x8081, 0xc4 },
353         { 0x80a5, 0x40 },
354         { 0x80b5, 0xfb },
355         { 0x80b6, 0x8e },
356         { 0x80b7, 0x39 },
357         { 0x80aa, 0x77 },
358         { 0x80ad, 0x77 },
359         { 0x80a6, 0x67 },
360         { 0x8262, 0x20 },
361         { 0x821c, 0x30 },
362         { 0x80b8, 0x3e },
363         { 0x80b9, 0xf0 },
364         { 0x80ba, 0x01 },
365         { 0x80bb, 0x18 },
366         { 0x80bc, 0x50 },
367         { 0x80bd, 0x00 },
368         { 0x80be, 0xea },
369         { 0x80bf, 0xef },
370         { 0x80c0, 0xfc },
371         { 0x80c1, 0xbd },
372         { 0x80c2, 0x1f },
373         { 0x80c3, 0xfc },
374         { 0x80c4, 0xdd },
375         { 0x80c5, 0xaf },
376         { 0x80c6, 0x00 },
377         { 0x80c7, 0x38 },
378         { 0x80c8, 0x30 },
379         { 0x80c9, 0x05 },
380         { 0x80ca, 0x4a },
381         { 0x80cb, 0xd0 },
382         { 0x80cc, 0x01 },
383         { 0x80cd, 0xd9 },
384         { 0x80ce, 0x6f },
385         { 0x80cf, 0xf9 },
386         { 0x80d0, 0x70 },
387         { 0x80d1, 0xdf },
388         { 0x80d2, 0xf7 },
389         { 0x80d3, 0xc2 },
390         { 0x80d4, 0xdf },
391         { 0x80d5, 0x02 },
392         { 0x80d6, 0x9a },
393         { 0x80d7, 0xd0 },
394         { 0x8250, 0x0d },
395         { 0x8251, 0xcd },
396         { 0x8252, 0xe0 },
397         { 0x8253, 0x05 },
398         { 0x8254, 0xa7 },
399         { 0x8255, 0xff },
400         { 0x8256, 0xed },
401         { 0x8257, 0x5b },
402         { 0x8258, 0xae },
403         { 0x8259, 0xe6 },
404         { 0x825a, 0x3d },
405         { 0x825b, 0x0f },
406         { 0x825c, 0x0d },
407         { 0x825d, 0xea },
408         { 0x825e, 0xf2 },
409         { 0x825f, 0x51 },
410         { 0x8260, 0xf5 },
411         { 0x8261, 0x06 },
412         { 0x821a, 0x00 },
413         { 0x8546, 0x40 },
414         { 0x8210, 0x26 },
415         { 0x8211, 0xf6 },
416         { 0x8212, 0x84 },
417         { 0x8213, 0x02 },
418         { 0x8502, 0x01 },
419         { 0x8121, 0x04 },
420         { 0x8122, 0x04 },
421         { 0x852e, 0x10 },
422         { 0x80a4, 0xca },
423         { 0x80a7, 0x40 },
424         { 0x8526, 0x01 },
425 };
426
427 static int au8522_enable_modulation(struct dvb_frontend *fe,
428                                     fe_modulation_t m)
429 {
430         struct au8522_state *state = fe->demodulator_priv;
431         int i;
432
433         dprintk("%s(0x%08x)\n", __func__, m);
434
435         switch (m) {
436         case VSB_8:
437                 dprintk("%s() VSB_8\n", __func__);
438                 for (i = 0; i < ARRAY_SIZE(VSB_mod_tab); i++)
439                         au8522_writereg(state,
440                                 VSB_mod_tab[i].reg,
441                                 VSB_mod_tab[i].data);
442                 break;
443         case QAM_64:
444         case QAM_256:
445                 dprintk("%s() QAM 64/256\n", __func__);
446                 for (i = 0; i < ARRAY_SIZE(QAM_mod_tab); i++)
447                         au8522_writereg(state,
448                                 QAM_mod_tab[i].reg,
449                                 QAM_mod_tab[i].data);
450                 break;
451         default:
452                 dprintk("%s() Invalid modulation\n", __func__);
453                 return -EINVAL;
454         }
455
456         state->current_modulation = m;
457
458         return 0;
459 }
460
461 /* Talk to the demod, set the FEC, GUARD, QAM settings etc */
462 static int au8522_set_frontend(struct dvb_frontend *fe,
463                                struct dvb_frontend_parameters *p)
464 {
465         struct au8522_state *state = fe->demodulator_priv;
466         int ret = -EINVAL;
467
468         dprintk("%s(frequency=%d)\n", __func__, p->frequency);
469
470         if ((state->current_frequency == p->frequency) &&
471             (state->current_modulation == p->u.vsb.modulation))
472                 return 0;
473
474         au8522_enable_modulation(fe, p->u.vsb.modulation);
475
476         /* Allow the demod to settle */
477         msleep(100);
478
479         if (fe->ops.tuner_ops.set_params) {
480                 if (fe->ops.i2c_gate_ctrl)
481                         fe->ops.i2c_gate_ctrl(fe, 1);
482                 ret = fe->ops.tuner_ops.set_params(fe, p);
483                 if (fe->ops.i2c_gate_ctrl)
484                         fe->ops.i2c_gate_ctrl(fe, 0);
485         }
486
487         if (ret < 0)
488                 return ret;
489
490         state->current_frequency = p->frequency;
491
492         return 0;
493 }
494
495 /* Reset the demod hardware and reset all of the configuration registers
496    to a default state. */
497 static int au8522_init(struct dvb_frontend *fe)
498 {
499         struct au8522_state *state = fe->demodulator_priv;
500         dprintk("%s()\n", __func__);
501
502         au8522_writereg(state, 0xa4, 1 << 5);
503
504         au8522_i2c_gate_ctrl(fe, 1);
505
506         return 0;
507 }
508
509 static int au8522_sleep(struct dvb_frontend *fe)
510 {
511         struct au8522_state *state = fe->demodulator_priv;
512         dprintk("%s()\n", __func__);
513
514         state->current_frequency = 0;
515
516         return 0;
517 }
518
519 static int au8522_read_status(struct dvb_frontend *fe, fe_status_t *status)
520 {
521         struct au8522_state *state = fe->demodulator_priv;
522         u8 reg;
523         u32 tuner_status = 0;
524
525         *status = 0;
526
527         if (state->current_modulation == VSB_8) {
528                 dprintk("%s() Checking VSB_8\n", __func__);
529                 reg = au8522_readreg(state, 0x4088);
530                 if ((reg & 0x03) == 0x03)
531                         *status |= FE_HAS_LOCK | FE_HAS_SYNC | FE_HAS_VITERBI;
532         } else {
533                 dprintk("%s() Checking QAM\n", __func__);
534                 reg = au8522_readreg(state, 0x4541);
535                 if (reg & 0x80)
536                         *status |= FE_HAS_VITERBI;
537                 if (reg & 0x20)
538                         *status |= FE_HAS_LOCK | FE_HAS_SYNC;
539         }
540
541         switch (state->config->status_mode) {
542         case AU8522_DEMODLOCKING:
543                 dprintk("%s() DEMODLOCKING\n", __func__);
544                 if (*status & FE_HAS_VITERBI)
545                         *status |= FE_HAS_CARRIER | FE_HAS_SIGNAL;
546                 break;
547         case AU8522_TUNERLOCKING:
548                 /* Get the tuner status */
549                 dprintk("%s() TUNERLOCKING\n", __func__);
550                 if (fe->ops.tuner_ops.get_status) {
551                         if (fe->ops.i2c_gate_ctrl)
552                                 fe->ops.i2c_gate_ctrl(fe, 1);
553
554                         fe->ops.tuner_ops.get_status(fe, &tuner_status);
555
556                         if (fe->ops.i2c_gate_ctrl)
557                                 fe->ops.i2c_gate_ctrl(fe, 0);
558                 }
559                 if (tuner_status)
560                         *status |= FE_HAS_CARRIER | FE_HAS_SIGNAL;
561                 break;
562         }
563
564         dprintk("%s() status 0x%08x\n", __func__, *status);
565
566         return 0;
567 }
568
569 static int au8522_read_snr(struct dvb_frontend *fe, u16 *snr)
570 {
571         struct au8522_state *state = fe->demodulator_priv;
572         int ret = -EINVAL;
573
574         dprintk("%s()\n", __func__);
575
576         if (state->current_modulation == QAM_256)
577                 ret = au8522_mse2snr_lookup(qam256_mse2snr_tab,
578                                             ARRAY_SIZE(qam256_mse2snr_tab),
579                                             au8522_readreg(state, 0x4522),
580                                             snr);
581         else if (state->current_modulation == QAM_64)
582                 ret = au8522_mse2snr_lookup(qam64_mse2snr_tab,
583                                             ARRAY_SIZE(qam64_mse2snr_tab),
584                                             au8522_readreg(state, 0x4522),
585                                             snr);
586         else /* VSB_8 */
587                 ret = au8522_mse2snr_lookup(vsb_mse2snr_tab,
588                                             ARRAY_SIZE(vsb_mse2snr_tab),
589                                             au8522_readreg(state, 0x4311),
590                                             snr);
591
592         return ret;
593 }
594
595 static int au8522_read_signal_strength(struct dvb_frontend *fe,
596                                        u16 *signal_strength)
597 {
598         return au8522_read_snr(fe, signal_strength);
599 }
600
601 static int au8522_read_ucblocks(struct dvb_frontend *fe, u32 *ucblocks)
602 {
603         struct au8522_state *state = fe->demodulator_priv;
604
605         if (state->current_modulation == VSB_8)
606                 *ucblocks = au8522_readreg(state, 0x4087);
607         else
608                 *ucblocks = au8522_readreg(state, 0x4543);
609
610         return 0;
611 }
612
613 static int au8522_read_ber(struct dvb_frontend *fe, u32 *ber)
614 {
615         return au8522_read_ucblocks(fe, ber);
616 }
617
618 static int au8522_get_frontend(struct dvb_frontend *fe,
619                                 struct dvb_frontend_parameters *p)
620 {
621         struct au8522_state *state = fe->demodulator_priv;
622
623         p->frequency = state->current_frequency;
624         p->u.vsb.modulation = state->current_modulation;
625
626         return 0;
627 }
628
629 static int au8522_get_tune_settings(struct dvb_frontend *fe,
630                                     struct dvb_frontend_tune_settings *tune)
631 {
632         tune->min_delay_ms = 1000;
633         return 0;
634 }
635
636 static void au8522_release(struct dvb_frontend *fe)
637 {
638         struct au8522_state *state = fe->demodulator_priv;
639         kfree(state);
640 }
641
642 static struct dvb_frontend_ops au8522_ops;
643
644 struct dvb_frontend *au8522_attach(const struct au8522_config *config,
645                                    struct i2c_adapter *i2c)
646 {
647         struct au8522_state *state = NULL;
648
649         /* allocate memory for the internal state */
650         state = kmalloc(sizeof(struct au8522_state), GFP_KERNEL);
651         if (state == NULL)
652                 goto error;
653
654         /* setup the state */
655         state->config = config;
656         state->i2c = i2c;
657         /* create dvb_frontend */
658         memcpy(&state->frontend.ops, &au8522_ops,
659                sizeof(struct dvb_frontend_ops));
660         state->frontend.demodulator_priv = state;
661
662         if (au8522_init(&state->frontend) != 0) {
663                 printk(KERN_ERR "%s: Failed to initialize correctly\n",
664                         __func__);
665                 goto error;
666         }
667
668         /* Note: Leaving the I2C gate open here. */
669         au8522_i2c_gate_ctrl(&state->frontend, 1);
670
671         return &state->frontend;
672
673 error:
674         kfree(state);
675         return NULL;
676 }
677 EXPORT_SYMBOL(au8522_attach);
678
679 static struct dvb_frontend_ops au8522_ops = {
680
681         .info = {
682                 .name                   = "Auvitek AU8522 QAM/8VSB Frontend",
683                 .type                   = FE_ATSC,
684                 .frequency_min          = 54000000,
685                 .frequency_max          = 858000000,
686                 .frequency_stepsize     = 62500,
687                 .caps = FE_CAN_QAM_64 | FE_CAN_QAM_256 | FE_CAN_8VSB
688         },
689
690         .init                 = au8522_init,
691         .sleep                = au8522_sleep,
692         .i2c_gate_ctrl        = au8522_i2c_gate_ctrl,
693         .set_frontend         = au8522_set_frontend,
694         .get_frontend         = au8522_get_frontend,
695         .get_tune_settings    = au8522_get_tune_settings,
696         .read_status          = au8522_read_status,
697         .read_ber             = au8522_read_ber,
698         .read_signal_strength = au8522_read_signal_strength,
699         .read_snr             = au8522_read_snr,
700         .read_ucblocks        = au8522_read_ucblocks,
701         .release              = au8522_release,
702 };
703
704 module_param(debug, int, 0644);
705 MODULE_PARM_DESC(debug, "Enable verbose debug messages");
706
707 MODULE_DESCRIPTION("Auvitek AU8522 QAM-B/ATSC Demodulator driver");
708 MODULE_AUTHOR("Steven Toth");
709 MODULE_LICENSE("GPL");