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