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