vserver 1.9.3
[linux-2.6.git] / drivers / media / dvb / frontends / sp887x.c
1 /*
2    Driver for the Microtune 7202D Frontend
3 */
4
5 /*
6    This driver needs a copy of the Avermedia firmware. The version tested
7    is part of the Avermedia DVB-T 1.3.26.3 Application. If the software is
8    installed in Windows the file will be in the /Program Files/AVerTV DVB-T/
9    directory and is called sc_main.mc. Alternatively it can "extracted" from
10    the install cab files. Copy this file to '/usr/lib/hotplug/firmware/sc_main.mc'.
11    With this version of the file the first 10 bytes are discarded and the
12    next 0x4000 loaded. This may change in future versions.
13  */
14
15 #include <linux/kernel.h>
16 #include <linux/vmalloc.h>
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/string.h>
20 #include <linux/slab.h>
21 #include <linux/fs.h>
22 #include <linux/unistd.h>
23 #include <linux/fcntl.h>
24 #include <linux/errno.h>
25 #include <linux/i2c.h>
26 #include <linux/syscalls.h>
27
28 #include "dvb_frontend.h"
29 #include "dvb_functions.h"
30
31 #ifndef DVB_SP887X_FIRMWARE_FILE
32 #define DVB_SP887X_FIRMWARE_FILE "/usr/lib/hotplug/firmware/sc_main.mc"
33 #endif
34
35 static char *sp887x_firmware = DVB_SP887X_FIRMWARE_FILE;
36
37 #if 0
38 #define dprintk(x...) printk(x)
39 #else
40 #define dprintk(x...)
41 #endif
42
43 #if 0
44 #define LOG(dir,addr,buf,len)                                   \
45         do {                                                    \
46                 int i;                                          \
47                 printk("%s (%02x):", dir, addr & 0xff);         \
48                 for (i=0; i<len; i++)                           \
49                         printk(" 0x%02x,", buf[i] & 0xff);      \
50                 printk("\n");                                   \
51         } while (0)
52 #else
53 #define LOG(dir,addr,buf,len)
54 #endif
55
56
57 static
58 struct dvb_frontend_info sp887x_info = {
59         .name = "Microtune MT7202DTF",
60         .type = FE_OFDM,
61         .frequency_min =  50500000,
62         .frequency_max = 858000000,
63         .frequency_stepsize = 166666,
64         .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
65                 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
66                 FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 |
67                 FE_CAN_RECOVER
68 };
69
70 static
71 int i2c_writebytes (struct dvb_frontend *fe, u8 addr, u8 *buf, u8 len)
72 {
73         struct dvb_i2c_bus *i2c = fe->i2c;
74         struct i2c_msg msg = { .addr = addr, .flags = 0, .buf = buf, .len = len };
75         int err;
76
77         LOG("i2c_writebytes", msg.addr, msg.buf, msg.len);
78
79         if ((err = i2c->xfer (i2c, &msg, 1)) != 1) {
80                 printk ("%s: i2c write error (addr %02x, err == %i)\n",
81                         __FUNCTION__, addr, err);
82                 return -EREMOTEIO;
83         }
84
85         return 0;
86 }
87
88
89
90 static
91 int sp887x_writereg (struct dvb_frontend *fe, u16 reg, u16 data)
92 {
93         struct dvb_i2c_bus *i2c = fe->i2c;
94         u8 b0 [] = { reg >> 8 , reg & 0xff, data >> 8, data & 0xff };
95         struct i2c_msg msg = { .addr = 0x70, .flags = 0, .buf = b0, .len = 4 };
96         int ret;
97
98         LOG("sp887x_writereg", msg.addr, msg.buf, msg.len);
99
100         if ((ret = i2c->xfer(i2c, &msg, 1)) != 1) {
101                 /**
102                  *  in case of soft reset we ignore ACK errors...
103                  */
104                 if (!(reg == 0xf1a && data == 0x000 && 
105                         (ret == -EREMOTEIO || ret == -EFAULT)))
106                 {
107                         printk("%s: writereg error "
108                                "(reg %03x, data %03x, ret == %i)\n",
109                                __FUNCTION__, reg & 0xffff, data & 0xffff, ret);
110                         return ret;
111                 }
112         }
113
114         return 0;
115 }
116
117
118 static
119 u16 sp887x_readreg (struct dvb_frontend *fe, u16 reg)
120 {
121         struct dvb_i2c_bus *i2c = fe->i2c;
122         u8 b0 [] = { reg >> 8 , reg & 0xff };
123         u8 b1 [2];
124         int ret;
125         struct i2c_msg msg[] = {{ .addr = 0x70, .flags = 0, .buf = b0, .len = 2 },
126                          { .addr = 0x70, .flags = I2C_M_RD, .buf = b1, .len = 2 }};
127
128         LOG("sp887x_readreg (w)", msg[0].addr, msg[0].buf, msg[0].len);
129         LOG("sp887x_readreg (r)", msg[1].addr, msg[1].buf, msg[1].len);
130
131         if ((ret = i2c->xfer(i2c, msg, 2)) != 2)
132                 printk("%s: readreg error (ret == %i)\n", __FUNCTION__, ret);
133
134         return (((b1[0] << 8) | b1[1]) & 0xfff);
135 }
136
137
138 static
139 void sp887x_microcontroller_stop (struct dvb_frontend *fe)
140 {
141         dprintk("%s\n", __FUNCTION__);
142         sp887x_writereg(fe, 0xf08, 0x000);
143         sp887x_writereg(fe, 0xf09, 0x000);              
144
145         /* microcontroller STOP */
146         sp887x_writereg(fe, 0xf00, 0x000);
147 }
148
149
150 static
151 void sp887x_microcontroller_start (struct dvb_frontend *fe)
152 {
153         dprintk("%s\n", __FUNCTION__);
154         sp887x_writereg(fe, 0xf08, 0x000);
155         sp887x_writereg(fe, 0xf09, 0x000);              
156
157         /* microcontroller START */
158         sp887x_writereg(fe, 0xf00, 0x001);
159 }
160
161
162 static
163 void sp887x_setup_agc (struct dvb_frontend *fe)
164 {
165         /* setup AGC parameters */
166         dprintk("%s\n", __FUNCTION__);
167         sp887x_writereg(fe, 0x33c, 0x054);
168         sp887x_writereg(fe, 0x33b, 0x04c);
169         sp887x_writereg(fe, 0x328, 0x000);
170         sp887x_writereg(fe, 0x327, 0x005);
171         sp887x_writereg(fe, 0x326, 0x001);
172         sp887x_writereg(fe, 0x325, 0x001);
173         sp887x_writereg(fe, 0x324, 0x001);
174         sp887x_writereg(fe, 0x318, 0x050);
175         sp887x_writereg(fe, 0x317, 0x3fe);
176         sp887x_writereg(fe, 0x316, 0x001);
177         sp887x_writereg(fe, 0x313, 0x005);
178         sp887x_writereg(fe, 0x312, 0x002);
179         sp887x_writereg(fe, 0x306, 0x000);
180         sp887x_writereg(fe, 0x303, 0x000);
181 }
182
183
184 #define BLOCKSIZE 30
185
186 /**
187  *  load firmware and setup MPEG interface...
188  */
189 static
190 int sp887x_initial_setup (struct dvb_frontend *fe)
191 {
192         u8 buf [BLOCKSIZE+2];
193         unsigned char *firmware = NULL;
194         int i;
195         int fd;
196         int filesize;
197         int fw_size;
198         mm_segment_t fs;
199
200         dprintk("%s\n", __FUNCTION__);
201
202         /* soft reset */
203         sp887x_writereg(fe, 0xf1a, 0x000);
204
205         sp887x_microcontroller_stop (fe);
206
207         fs = get_fs();
208
209         // Load the firmware
210         set_fs(get_ds());
211         fd = sys_open(sp887x_firmware, 0, 0);
212         if (fd < 0) {
213                 printk(KERN_WARNING "%s: Unable to open firmware %s\n", __FUNCTION__,
214                        sp887x_firmware);
215                 return -EIO;
216         }
217         filesize = sys_lseek(fd, 0L, 2);
218         if (filesize <= 0) {
219                 printk(KERN_WARNING "%s: Firmware %s is empty\n", __FUNCTION__,
220                        sp887x_firmware);
221                 sys_close(fd);
222                 return -EIO;
223         }
224
225         fw_size = 0x4000;
226
227         // allocate buffer for it
228         firmware = vmalloc(fw_size);
229         if (firmware == NULL) {
230                 printk(KERN_WARNING "%s: Out of memory loading firmware\n",
231                        __FUNCTION__);
232                 sys_close(fd);
233                 return -EIO;
234         }
235
236         // read it!
237         // read the first 16384 bytes from the file
238         // ignore the first 10 bytes
239         sys_lseek(fd, 10, 0);
240         if (sys_read(fd, firmware, fw_size) != fw_size) {
241                 printk(KERN_WARNING "%s: Failed to read firmware\n", __FUNCTION__);
242                 vfree(firmware);
243                 sys_close(fd);
244                 return -EIO;
245         }
246         sys_close(fd);
247         set_fs(fs);
248
249         printk ("%s: firmware upload... ", __FUNCTION__);
250
251         /* setup write pointer to -1 (end of memory) */
252         /* bit 0x8000 in address is set to enable 13bit mode */
253         sp887x_writereg(fe, 0x8f08, 0x1fff);
254
255         /* dummy write (wrap around to start of memory) */
256         sp887x_writereg(fe, 0x8f0a, 0x0000);
257
258         for (i=0; i<fw_size; i+=BLOCKSIZE) {
259                 int c = BLOCKSIZE;
260                 int err;
261
262                 if (i+c > fw_size)
263                         c = fw_size - i;
264
265                 /* bit 0x8000 in address is set to enable 13bit mode */
266                 /* bit 0x4000 enables multibyte read/write transfers */
267                 /* write register is 0xf0a */
268                 buf[0] = 0xcf;
269                 buf[1] = 0x0a;
270
271                 memcpy(&buf[2], firmware + i, c);
272
273                 if ((err = i2c_writebytes (fe, 0x70, buf, c+2)) < 0) {
274                         printk ("failed.\n");
275                         printk ("%s: i2c error (err == %i)\n", __FUNCTION__, err);
276                         vfree(firmware);
277                         return err;
278                 }
279         }
280
281         vfree(firmware);
282
283         /* don't write RS bytes between packets */
284         sp887x_writereg(fe, 0xc13, 0x001);
285
286         /* suppress clock if (!data_valid) */
287         sp887x_writereg(fe, 0xc14, 0x000);
288
289         /* setup MPEG interface... */
290         sp887x_writereg(fe, 0xc1a, 0x872);
291         sp887x_writereg(fe, 0xc1b, 0x001);
292         sp887x_writereg(fe, 0xc1c, 0x000); /* parallel mode (serial mode == 1) */
293         sp887x_writereg(fe, 0xc1a, 0x871);
294
295         /* ADC mode, 2 for MT8872, 3 for SP8870/SP8871 */
296         sp887x_writereg(fe, 0x301, 0x002);
297
298         sp887x_setup_agc(fe);
299
300         /* bit 0x010: enable data valid signal */
301         sp887x_writereg(fe, 0xd00, 0x010);
302         sp887x_writereg(fe, 0x0d1, 0x000);
303
304         printk ("done.\n");
305         return 0;
306 };
307
308
309 /**
310  *  returns the actual tuned center frequency which can be used
311  *  to initialise the AFC registers
312  */
313 static
314 int tsa5060_setup_pll (struct dvb_frontend *fe, int freq)
315 {
316         u8 cfg, cpump, band_select;
317         u8 buf [4];
318         u32 div;
319
320         div = (36000000 + freq + 83333) / 166666;
321         cfg = 0x88;
322
323         cpump = freq < 175000000 ? 2 : freq < 390000000 ? 1 :
324                 freq < 470000000 ? 2 : freq < 750000000 ? 2 : 3;
325
326         band_select = freq < 175000000 ? 0x0e : freq < 470000000 ? 0x05 : 0x03;
327
328         buf [0] = (div >> 8) & 0x7f;
329         buf [1] = div & 0xff;
330         buf [2] = ((div >> 10) & 0x60) | cfg;
331         buf [3] = cpump | band_select;
332
333         /* open i2c gate for PLL message transmission... */
334         sp887x_writereg(fe, 0x206, 0x001);
335         i2c_writebytes(fe, 0x60, buf, 4);
336         sp887x_writereg(fe, 0x206, 0x000);
337
338         return (div * 166666 - 36000000);
339 }
340
341
342
343 static
344 int configure_reg0xc05 (struct dvb_frontend_parameters *p, u16 *reg0xc05)
345 {
346         int known_parameters = 1;
347         
348         *reg0xc05 = 0x000;
349
350         switch (p->u.ofdm.constellation) {
351         case QPSK:
352                 break;
353         case QAM_16:
354                 *reg0xc05 |= (1 << 10);
355                 break;
356         case QAM_64:
357                 *reg0xc05 |= (2 << 10);
358                 break;
359         case QAM_AUTO:
360                 known_parameters = 0;
361                 break;
362         default:
363                 return -EINVAL;
364         };
365
366         switch (p->u.ofdm.hierarchy_information) {
367         case HIERARCHY_NONE:
368                 break;
369         case HIERARCHY_1:
370                 *reg0xc05 |= (1 << 7);
371                 break;
372         case HIERARCHY_2:
373                 *reg0xc05 |= (2 << 7);
374                 break;
375         case HIERARCHY_4:
376                 *reg0xc05 |= (3 << 7);
377                 break;
378         case HIERARCHY_AUTO:
379                 known_parameters = 0;
380                 break;
381         default:
382                 return -EINVAL;
383         };
384
385         switch (p->u.ofdm.code_rate_HP) {
386         case FEC_1_2:
387                 break;
388         case FEC_2_3:
389                 *reg0xc05 |= (1 << 3);
390                 break;
391         case FEC_3_4:
392                 *reg0xc05 |= (2 << 3);
393                 break;
394         case FEC_5_6:
395                 *reg0xc05 |= (3 << 3);
396                 break;
397         case FEC_7_8:
398                 *reg0xc05 |= (4 << 3);
399                 break;
400         case FEC_AUTO:
401                 known_parameters = 0;
402                 break;
403         default:
404                 return -EINVAL;
405         };
406
407         if (known_parameters)
408                 *reg0xc05 |= (2 << 1);  /* use specified parameters */
409         else
410                 *reg0xc05 |= (1 << 1);  /* enable autoprobing */
411
412         return 0;
413 }
414
415
416 /**
417  *  estimates division of two 24bit numbers,
418  *  derived from the ves1820/stv0299 driver code
419  */
420 static
421 void divide (int n, int d, int *quotient_i, int *quotient_f)
422 {
423         unsigned int q, r;
424
425         r = (n % d) << 8;
426         q = (r / d);
427
428         if (quotient_i)
429                 *quotient_i = q;
430
431         if (quotient_f) {
432                 r = (r % d) << 8;
433                 q = (q << 8) | (r / d);
434                 r = (r % d) << 8;
435                 *quotient_f = (q << 8) | (r / d);
436         }
437 }
438
439
440 static
441 void sp887x_correct_offsets (struct dvb_frontend *fe,
442                              struct dvb_frontend_parameters *p,
443                              int actual_freq)
444 {
445         static const u32 srate_correction [] = { 1879617, 4544878, 8098561 };
446         int bw_index = p->u.ofdm.bandwidth - BANDWIDTH_8_MHZ;
447         int freq_offset = actual_freq - p->frequency;
448         int sysclock = 61003; //[kHz]
449         int ifreq = 36000000;
450         int freq;
451         int frequency_shift;
452
453         if (p->inversion == INVERSION_ON)
454                 freq = ifreq - freq_offset;
455         else
456                 freq = ifreq + freq_offset;
457
458         divide(freq / 333, sysclock, NULL, &frequency_shift);
459
460         if (p->inversion == INVERSION_ON)
461                 frequency_shift = -frequency_shift;
462
463         /* sample rate correction */
464         sp887x_writereg(fe, 0x319, srate_correction[bw_index] >> 12);
465         sp887x_writereg(fe, 0x31a, srate_correction[bw_index] & 0xfff);
466
467         /* carrier offset correction */
468         sp887x_writereg(fe, 0x309, frequency_shift >> 12);
469         sp887x_writereg(fe, 0x30a, frequency_shift & 0xfff);
470 }
471
472
473 static
474 int sp887x_setup_frontend_parameters (struct dvb_frontend *fe,
475                                       struct dvb_frontend_parameters *p)
476 {
477         int actual_freq, err;
478         u16 val, reg0xc05;
479
480         if (p->u.ofdm.bandwidth != BANDWIDTH_8_MHZ &&
481             p->u.ofdm.bandwidth != BANDWIDTH_7_MHZ &&
482             p->u.ofdm.bandwidth != BANDWIDTH_6_MHZ)
483                 return -EINVAL;
484         
485         if ((err = configure_reg0xc05(p, &reg0xc05)))
486                 return err;
487
488         sp887x_microcontroller_stop(fe);
489
490         actual_freq = tsa5060_setup_pll(fe, p->frequency);
491
492         /* read status reg in order to clear pending irqs */
493         sp887x_readreg(fe, 0x200);
494
495         sp887x_correct_offsets(fe, p, actual_freq);
496
497         /* filter for 6/7/8 Mhz channel */
498         if (p->u.ofdm.bandwidth == BANDWIDTH_6_MHZ)
499                 val = 2;
500         else if (p->u.ofdm.bandwidth == BANDWIDTH_7_MHZ)
501                 val = 1;
502         else
503                 val = 0;
504
505         sp887x_writereg(fe, 0x311, val);
506
507         /* scan order: 2k first = 0, 8k first = 1 */
508         if (p->u.ofdm.transmission_mode == TRANSMISSION_MODE_2K)
509                 sp887x_writereg(fe, 0x338, 0x000);
510         else
511                 sp887x_writereg(fe, 0x338, 0x001);
512
513         sp887x_writereg(fe, 0xc05, reg0xc05);
514
515         if (p->u.ofdm.bandwidth == BANDWIDTH_6_MHZ)
516                 val = 2 << 3;
517         else if (p->u.ofdm.bandwidth == BANDWIDTH_7_MHZ)
518                 val = 3 << 3;
519         else
520                 val = 0 << 3;
521
522         /* enable OFDM and SAW bits as lock indicators in sync register 0xf17,
523          * optimize algorithm for given bandwidth...
524          */
525         sp887x_writereg(fe, 0xf14, 0x160 | val);
526         sp887x_writereg(fe, 0xf15, 0x000);
527
528         sp887x_microcontroller_start(fe);
529         return 0;
530 }
531
532
533 static
534 int sp887x_ioctl (struct dvb_frontend *fe, unsigned int cmd, void *arg)
535 {
536         switch (cmd) {
537         case FE_GET_INFO:
538                 memcpy (arg, &sp887x_info, sizeof(struct dvb_frontend_info));
539                 break;
540
541         case FE_READ_STATUS:
542         {
543                 u16 snr12 = sp887x_readreg(fe, 0xf16);
544                 u16 sync0x200 = sp887x_readreg(fe, 0x200);
545                 u16 sync0xf17 = sp887x_readreg(fe, 0xf17);
546                 fe_status_t *status = arg;
547
548                 *status = 0;
549
550                 if (snr12 > 0x00f)
551                         *status |= FE_HAS_SIGNAL;
552
553                 //if (sync0x200 & 0x004)
554                 //      *status |= FE_HAS_SYNC | FE_HAS_CARRIER;
555
556                 //if (sync0x200 & 0x008)
557                 //      *status |= FE_HAS_VITERBI;
558
559                 if ((sync0xf17 & 0x00f) == 0x002) {
560                         *status |= FE_HAS_LOCK;
561                         *status |= FE_HAS_VITERBI | FE_HAS_SYNC | FE_HAS_CARRIER;
562                 }
563
564                 if (sync0x200 & 0x001) {        /* tuner adjustment requested...*/
565                         int steps = (sync0x200 >> 4) & 0x00f;
566                         if (steps & 0x008)
567                                 steps = -steps;
568                         dprintk("sp887x: implement tuner adjustment (%+i steps)!!\n",
569                                steps);
570                 }
571
572                 break;
573
574         }
575
576         case FE_READ_BER:
577         {
578                 u32* ber = arg;
579                 *ber = (sp887x_readreg(fe, 0xc08) & 0x3f) |
580                        (sp887x_readreg(fe, 0xc07) << 6);
581                 sp887x_writereg(fe, 0xc08, 0x000);
582                 sp887x_writereg(fe, 0xc07, 0x000);
583                 if (*ber >= 0x3fff0)
584                         *ber = ~0;
585                 break;
586
587         }
588
589         case FE_READ_SIGNAL_STRENGTH:           // FIXME: correct registers ?
590         {
591                 u16 snr12 = sp887x_readreg(fe, 0xf16);
592                 u32 signal = 3 * (snr12 << 4);
593                 *((u16*) arg) = (signal < 0xffff) ? signal : 0xffff;
594                 break;
595         }
596
597         case FE_READ_SNR:
598         {
599                 u16 snr12 = sp887x_readreg(fe, 0xf16);
600                 *(u16*) arg = (snr12 << 4) | (snr12 >> 8);
601                 break;
602         }
603
604         case FE_READ_UNCORRECTED_BLOCKS:
605         {
606                 u32 *ublocks = (u32 *) arg;
607                 *ublocks = sp887x_readreg(fe, 0xc0c);
608                 if (*ublocks == 0xfff)
609                         *ublocks = ~0;
610                 break;
611         }
612
613         case FE_SET_FRONTEND:
614                 return sp887x_setup_frontend_parameters(fe, arg);
615
616         case FE_GET_FRONTEND:  // FIXME: read known values back from Hardware...
617                 break;
618
619         case FE_SLEEP:
620                 /* tristate TS output and disable interface pins */
621                 sp887x_writereg(fe, 0xc18, 0x000);
622                 break;
623
624         case FE_INIT:
625                 if (fe->data == NULL) {   /* first time initialisation... */
626                         fe->data = (void*) ~0;
627                         sp887x_initial_setup (fe);
628                 }
629                 /* enable TS output and interface pins */
630                 sp887x_writereg(fe, 0xc18, 0x00d);
631                 break;
632
633         case FE_GET_TUNE_SETTINGS:
634         {
635                 struct dvb_frontend_tune_settings* fesettings = (struct dvb_frontend_tune_settings*) arg;
636                 fesettings->min_delay_ms = 50;
637                 fesettings->step_size = 0;
638                 fesettings->max_drift = 0;
639                 return 0;
640         }           
641
642         default:
643                 return -EOPNOTSUPP;
644         };
645
646         return 0;
647 }
648
649
650
651 static
652 int sp887x_attach (struct dvb_i2c_bus *i2c, void **data)
653 {
654         struct i2c_msg msg = {.addr = 0x70, .flags = 0, .buf = NULL, .len = 0 };
655
656         dprintk ("%s\n", __FUNCTION__);
657
658         if (i2c->xfer (i2c, &msg, 1) != 1)
659                 return -ENODEV;
660
661         return dvb_register_frontend (sp887x_ioctl, i2c, NULL, &sp887x_info);
662 }
663
664
665 static
666 void sp887x_detach (struct dvb_i2c_bus *i2c, void *data)
667 {
668         dprintk ("%s\n", __FUNCTION__);
669         dvb_unregister_frontend (sp887x_ioctl, i2c);
670 }
671
672
673 static
674 int __init init_sp887x (void)
675 {
676         dprintk ("%s\n", __FUNCTION__);
677         return dvb_register_i2c_device (NULL, sp887x_attach, sp887x_detach);
678 }
679
680
681 static
682 void __exit exit_sp887x (void)
683 {
684         dprintk ("%s\n", __FUNCTION__);
685         dvb_unregister_i2c_device (sp887x_attach);
686 }
687
688
689 module_init(init_sp887x);
690 module_exit(exit_sp887x);
691
692
693 MODULE_DESCRIPTION("sp887x DVB-T demodulator driver");
694 MODULE_LICENSE("GPL");
695
696