V4L/DVB (7021): Move all board specific configuration to em28xx-cards.c
[linux-2.6] / drivers / media / video / tuner-xc2028.c
1 /* tuner-xc2028
2  *
3  * Copyright (c) 2007 Mauro Carvalho Chehab (mchehab@infradead.org)
4  *
5  * Copyright (c) 2007 Michel Ludwig (michel.ludwig@gmail.com)
6  *       - frontend interface
7  *
8  * This code is placed under the terms of the GNU General Public License v2
9  */
10
11 #include <linux/i2c.h>
12 #include <asm/div64.h>
13 #include <linux/firmware.h>
14 #include <linux/videodev2.h>
15 #include <linux/delay.h>
16 #include <media/tuner.h>
17 #include <linux/mutex.h>
18 #include "tuner-i2c.h"
19 #include "tuner-xc2028.h"
20 #include "tuner-xc2028-types.h"
21
22 #include <linux/dvb/frontend.h>
23 #include "dvb_frontend.h"
24
25
26 #define PREFIX "xc2028"
27
28 static int debug;
29 module_param(debug, int, 0644);
30 MODULE_PARM_DESC(debug, "enable verbose debug messages");
31
32 static char audio_std[8];
33 module_param_string(audio_std, audio_std, sizeof(audio_std), 0);
34 MODULE_PARM_DESC(audio_std,
35         "Audio standard. XC3028 audio decoder explicitly "
36         "needs to know what audio\n"
37         "standard is needed for some video standards with audio A2 or NICAM.\n"
38         "The valid values are:\n"
39         "A2\n"
40         "A2/A\n"
41         "A2/B\n"
42         "NICAM\n"
43         "NICAM/A\n"
44         "NICAM/B\n");
45
46 static LIST_HEAD(xc2028_list);
47 static DEFINE_MUTEX(xc2028_list_mutex);
48
49 /* struct for storing firmware table */
50 struct firmware_description {
51         unsigned int  type;
52         v4l2_std_id   id;
53         __u16         int_freq;
54         unsigned char *ptr;
55         unsigned int  size;
56 };
57
58 struct firmware_properties {
59         unsigned int    type;
60         v4l2_std_id     id;
61         v4l2_std_id     std_req;
62         __u16           int_freq;
63         unsigned int    scode_table;
64         int             scode_nr;
65 };
66
67 struct xc2028_data {
68         struct list_head        xc2028_list;
69         struct tuner_i2c_props  i2c_props;
70         int                     (*tuner_callback) (void *dev,
71                                                    int command, int arg);
72         void                    *video_dev;
73         int                     count;
74         __u32                   frequency;
75
76         struct firmware_description *firm;
77         int                     firm_size;
78         __u16                   firm_version;
79
80         __u16                   hwmodel;
81         __u16                   hwvers;
82
83         struct xc2028_ctrl      ctrl;
84
85         struct firmware_properties cur_fw;
86
87         struct mutex lock;
88 };
89
90 #define i2c_send(priv, buf, size) ({                                    \
91         int _rc;                                                        \
92         _rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size);         \
93         if (size != _rc)                                                \
94                 tuner_info("i2c output error: rc = %d (should be %d)\n",\
95                            _rc, (int)size);                             \
96         _rc;                                                            \
97 })
98
99 #define i2c_rcv(priv, buf, size) ({                                     \
100         int _rc;                                                        \
101         _rc = tuner_i2c_xfer_recv(&priv->i2c_props, buf, size);         \
102         if (size != _rc)                                                \
103                 tuner_err("i2c input error: rc = %d (should be %d)\n",  \
104                            _rc, (int)size);                             \
105         _rc;                                                            \
106 })
107
108 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({                \
109         int _rc;                                                        \
110         _rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize,   \
111                                        ibuf, isize);                    \
112         if (isize != _rc)                                               \
113                 tuner_err("i2c input error: rc = %d (should be %d)\n",  \
114                            _rc, (int)isize);                            \
115         _rc;                                                            \
116 })
117
118 #define send_seq(priv, data...) ({                                      \
119         static u8 _val[] = data;                                        \
120         int _rc;                                                        \
121         if (sizeof(_val) !=                                             \
122                         (_rc = tuner_i2c_xfer_send(&priv->i2c_props,    \
123                                                 _val, sizeof(_val)))) { \
124                 tuner_err("Error on line %d: %d\n", __LINE__, _rc);     \
125         } else                                                          \
126                 msleep(10);                                             \
127         _rc;                                                            \
128 })
129
130 static unsigned int xc2028_get_reg(struct xc2028_data *priv, u16 reg, u16 *val)
131 {
132         unsigned char buf[2];
133         unsigned char ibuf[2];
134
135         tuner_dbg("%s %04x called\n", __FUNCTION__, reg);
136
137         buf[0] = reg >> 8;
138         buf[1] = (unsigned char) reg;
139
140         if (i2c_send_recv(priv, buf, 2, ibuf, 2) != 2)
141                 return -EIO;
142
143         *val = (ibuf[1]) | (ibuf[0] << 8);
144         return 0;
145 }
146
147 #define dump_firm_type(t)       dump_firm_type_and_int_freq(t, 0)
148 void dump_firm_type_and_int_freq(unsigned int type, u16 int_freq)
149 {
150          if (type & BASE)
151                 printk("BASE ");
152          if (type & INIT1)
153                 printk("INIT1 ");
154          if (type & F8MHZ)
155                 printk("F8MHZ ");
156          if (type & MTS)
157                 printk("MTS ");
158          if (type & D2620)
159                 printk("D2620 ");
160          if (type & D2633)
161                 printk("D2633 ");
162          if (type & DTV6)
163                 printk("DTV6 ");
164          if (type & QAM)
165                 printk("QAM ");
166          if (type & DTV7)
167                 printk("DTV7 ");
168          if (type & DTV78)
169                 printk("DTV78 ");
170          if (type & DTV8)
171                 printk("DTV8 ");
172          if (type & FM)
173                 printk("FM ");
174          if (type & INPUT1)
175                 printk("INPUT1 ");
176          if (type & LCD)
177                 printk("LCD ");
178          if (type & NOGD)
179                 printk("NOGD ");
180          if (type & MONO)
181                 printk("MONO ");
182          if (type & ATSC)
183                 printk("ATSC ");
184          if (type & IF)
185                 printk("IF ");
186          if (type & LG60)
187                 printk("LG60 ");
188          if (type & ATI638)
189                 printk("ATI638 ");
190          if (type & OREN538)
191                 printk("OREN538 ");
192          if (type & OREN36)
193                 printk("OREN36 ");
194          if (type & TOYOTA388)
195                 printk("TOYOTA388 ");
196          if (type & TOYOTA794)
197                 printk("TOYOTA794 ");
198          if (type & DIBCOM52)
199                 printk("DIBCOM52 ");
200          if (type & ZARLINK456)
201                 printk("ZARLINK456 ");
202          if (type & CHINA)
203                 printk("CHINA ");
204          if (type & F6MHZ)
205                 printk("F6MHZ ");
206          if (type & INPUT2)
207                 printk("INPUT2 ");
208          if (type & SCODE)
209                 printk("SCODE ");
210          if (type & HAS_IF)
211                 printk("HAS_IF_%d ", int_freq);
212 }
213
214 static  v4l2_std_id parse_audio_std_option(void)
215 {
216         if (strcasecmp(audio_std, "A2") == 0)
217                 return V4L2_STD_A2;
218         if (strcasecmp(audio_std, "A2/A") == 0)
219                 return V4L2_STD_A2_A;
220         if (strcasecmp(audio_std, "A2/B") == 0)
221                 return V4L2_STD_A2_B;
222         if (strcasecmp(audio_std, "NICAM") == 0)
223                 return V4L2_STD_NICAM;
224         if (strcasecmp(audio_std, "NICAM/A") == 0)
225                 return V4L2_STD_NICAM_A;
226         if (strcasecmp(audio_std, "NICAM/B") == 0)
227                 return V4L2_STD_NICAM_B;
228
229         return 0;
230 }
231
232 static void free_firmware(struct xc2028_data *priv)
233 {
234         int i;
235
236         if (!priv->firm)
237                 return;
238
239         for (i = 0; i < priv->firm_size; i++)
240                 kfree(priv->firm[i].ptr);
241
242         kfree(priv->firm);
243
244         priv->firm = NULL;
245         priv->firm_size = 0;
246
247         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
248 }
249
250 static int load_all_firmwares(struct dvb_frontend *fe)
251 {
252         struct xc2028_data    *priv = fe->tuner_priv;
253         const struct firmware *fw   = NULL;
254         unsigned char         *p, *endp;
255         int                   rc = 0;
256         int                   n, n_array;
257         char                  name[33];
258
259         tuner_dbg("%s called\n", __FUNCTION__);
260
261         tuner_dbg("Reading firmware %s\n", priv->ctrl.fname);
262         rc = request_firmware(&fw, priv->ctrl.fname,
263                               &priv->i2c_props.adap->dev);
264         if (rc < 0) {
265                 if (rc == -ENOENT)
266                         tuner_err("Error: firmware %s not found.\n",
267                                    priv->ctrl.fname);
268                 else
269                         tuner_err("Error %d while requesting firmware %s \n",
270                                    rc, priv->ctrl.fname);
271
272                 return rc;
273         }
274         p = fw->data;
275         endp = p + fw->size;
276
277         if (fw->size < sizeof(name) - 1 + 2 + 2) {
278                 tuner_err("Error: firmware file %s has invalid size!\n",
279                           priv->ctrl.fname);
280                 goto corrupt;
281         }
282
283         memcpy(name, p, sizeof(name) - 1);
284         name[sizeof(name) - 1] = 0;
285         p += sizeof(name) - 1;
286
287         priv->firm_version = le16_to_cpu(*(__u16 *) p);
288         p += 2;
289
290         n_array = le16_to_cpu(*(__u16 *) p);
291         p += 2;
292
293         tuner_info("Loading %d firmware images from %s, type: %s, ver %d.%d\n",
294                    n_array, priv->ctrl.fname, name,
295                    priv->firm_version >> 8, priv->firm_version & 0xff);
296
297         priv->firm = kzalloc(sizeof(*priv->firm) * n_array, GFP_KERNEL);
298         if (priv->firm == NULL) {
299                 tuner_err("Not enough memory to load firmware file.\n");
300                 rc = -ENOMEM;
301                 goto err;
302         }
303         priv->firm_size = n_array;
304
305         n = -1;
306         while (p < endp) {
307                 __u32 type, size;
308                 v4l2_std_id id;
309                 __u16 int_freq = 0;
310
311                 n++;
312                 if (n >= n_array) {
313                         tuner_err("More firmware images in file than "
314                                   "were expected!\n");
315                         goto corrupt;
316                 }
317
318                 /* Checks if there's enough bytes to read */
319                 if (p + sizeof(type) + sizeof(id) + sizeof(size) > endp) {
320                         tuner_err("Firmware header is incomplete!\n");
321                         goto corrupt;
322                 }
323
324                 type = le32_to_cpu(*(__u32 *) p);
325                 p += sizeof(type);
326
327                 id = le64_to_cpu(*(v4l2_std_id *) p);
328                 p += sizeof(id);
329
330                 if (type & HAS_IF) {
331                         int_freq = le16_to_cpu(*(__u16 *) p);
332                         p += sizeof(int_freq);
333                 }
334
335                 size = le32_to_cpu(*(__u32 *) p);
336                 p += sizeof(size);
337
338                 if ((!size) || (size + p > endp)) {
339                         tuner_err("Firmware type ");
340                         dump_firm_type(type);
341                         printk("(%x), id %llx is corrupted "
342                                "(size=%d, expected %d)\n",
343                                type, (unsigned long long)id,
344                                (unsigned)(endp - p), size);
345                         goto corrupt;
346                 }
347
348                 priv->firm[n].ptr = kzalloc(size, GFP_KERNEL);
349                 if (priv->firm[n].ptr == NULL) {
350                         tuner_err("Not enough memory to load firmware file.\n");
351                         rc = -ENOMEM;
352                         goto err;
353                 }
354                 tuner_dbg("Reading firmware type ");
355                 if (debug) {
356                         dump_firm_type_and_int_freq(type, int_freq);
357                         printk("(%x), id %llx, size=%d.\n",
358                                type, (unsigned long long)id, size);
359                 }
360
361                 memcpy(priv->firm[n].ptr, p, size);
362                 priv->firm[n].type = type;
363                 priv->firm[n].id   = id;
364                 priv->firm[n].size = size;
365                 priv->firm[n].int_freq = int_freq;
366
367                 p += size;
368         }
369
370         if (n + 1 != priv->firm_size) {
371                 tuner_err("Firmware file is incomplete!\n");
372                 goto corrupt;
373         }
374
375         goto done;
376
377 corrupt:
378         rc = -EINVAL;
379         tuner_err("Error: firmware file is corrupted!\n");
380
381 err:
382         tuner_info("Releasing partially loaded firmware file.\n");
383         free_firmware(priv);
384
385 done:
386         release_firmware(fw);
387         if (rc == 0)
388                 tuner_dbg("Firmware files loaded.\n");
389
390         return rc;
391 }
392
393 static int seek_firmware(struct dvb_frontend *fe, unsigned int type,
394                          v4l2_std_id *id)
395 {
396         struct xc2028_data *priv = fe->tuner_priv;
397         int                 i, best_i = -1, best_nr_matches = 0;
398         unsigned int        ign_firm_type_mask = 0;
399
400         tuner_dbg("%s called, want type=", __FUNCTION__);
401         if (debug) {
402                 dump_firm_type(type);
403                 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
404         }
405
406         if (!priv->firm) {
407                 tuner_err("Error! firmware not loaded\n");
408                 return -EINVAL;
409         }
410
411         if (((type & ~SCODE) == 0) && (*id == 0))
412                 *id = V4L2_STD_PAL;
413
414         if (type & BASE)
415                 type &= BASE_TYPES;
416         else if (type & SCODE) {
417                 type &= SCODE_TYPES;
418                 ign_firm_type_mask = HAS_IF;
419         } else if (type & DTV_TYPES)
420                 type &= DTV_TYPES;
421         else if (type & STD_SPECIFIC_TYPES)
422                 type &= STD_SPECIFIC_TYPES;
423
424         /* Seek for exact match */
425         for (i = 0; i < priv->firm_size; i++) {
426                 if ((type == (priv->firm[i].type & ~ign_firm_type_mask)) &&
427                     (*id == priv->firm[i].id))
428                         goto found;
429         }
430
431         /* Seek for generic video standard match */
432         for (i = 0; i < priv->firm_size; i++) {
433                 v4l2_std_id match_mask;
434                 int nr_matches;
435
436                 if (type != (priv->firm[i].type & ~ign_firm_type_mask))
437                         continue;
438
439                 match_mask = *id & priv->firm[i].id;
440                 if (!match_mask)
441                         continue;
442
443                 if ((*id & match_mask) == *id)
444                         goto found; /* Supports all the requested standards */
445
446                 nr_matches = hweight64(match_mask);
447                 if (nr_matches > best_nr_matches) {
448                         best_nr_matches = nr_matches;
449                         best_i = i;
450                 }
451         }
452
453         if (best_nr_matches > 0) {
454                 tuner_dbg("Selecting best matching firmware (%d bits) for "
455                           "type=", best_nr_matches);
456                 dump_firm_type(type);
457                 printk("(%x), id %016llx:\n", type, (unsigned long long)*id);
458                 i = best_i;
459                 goto found;
460         }
461
462         /*FIXME: Would make sense to seek for type "hint" match ? */
463
464         i = -ENOENT;
465         goto ret;
466
467 found:
468         *id = priv->firm[i].id;
469
470 ret:
471         tuner_dbg("%s firmware for type=", (i < 0) ? "Can't find" : "Found");
472         if (debug) {
473                 dump_firm_type(type);
474                 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
475         }
476         return i;
477 }
478
479 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
480                          v4l2_std_id *id)
481 {
482         struct xc2028_data *priv = fe->tuner_priv;
483         int                pos, rc;
484         unsigned char      *p, *endp, buf[priv->ctrl.max_len];
485
486         tuner_dbg("%s called\n", __FUNCTION__);
487
488         pos = seek_firmware(fe, type, id);
489         if (pos < 0)
490                 return pos;
491
492         tuner_info("Loading firmware for type=");
493         dump_firm_type(priv->firm[pos].type);
494         printk("(%x), id %016llx.\n", priv->firm[pos].type,
495                (unsigned long long)*id);
496
497         p = priv->firm[pos].ptr;
498         endp = p + priv->firm[pos].size;
499
500         while (p < endp) {
501                 __u16 size;
502
503                 /* Checks if there's enough bytes to read */
504                 if (p + sizeof(size) > endp) {
505                         tuner_err("Firmware chunk size is wrong\n");
506                         return -EINVAL;
507                 }
508
509                 size = le16_to_cpu(*(__u16 *) p);
510                 p += sizeof(size);
511
512                 if (size == 0xffff)
513                         return 0;
514
515                 if (!size) {
516                         /* Special callback command received */
517                         rc = priv->tuner_callback(priv->video_dev,
518                                                   XC2028_TUNER_RESET, 0);
519                         if (rc < 0) {
520                                 tuner_err("Error at RESET code %d\n",
521                                            (*p) & 0x7f);
522                                 return -EINVAL;
523                         }
524                         continue;
525                 }
526                 if (size >= 0xff00) {
527                         switch (size) {
528                         case 0xff00:
529                                 rc = priv->tuner_callback(priv->video_dev,
530                                                         XC2028_RESET_CLK, 0);
531                                 if (rc < 0) {
532                                         tuner_err("Error at RESET code %d\n",
533                                                   (*p) & 0x7f);
534                                         return -EINVAL;
535                                 }
536                                 break;
537                         default:
538                                 tuner_info("Invalid RESET code %d\n",
539                                            size & 0x7f);
540                                 return -EINVAL;
541
542                         }
543                         continue;
544                 }
545
546                 /* Checks for a sleep command */
547                 if (size & 0x8000) {
548                         msleep(size & 0x7fff);
549                         continue;
550                 }
551
552                 if ((size + p > endp)) {
553                         tuner_err("missing bytes: need %d, have %d\n",
554                                    size, (int)(endp - p));
555                         return -EINVAL;
556                 }
557
558                 buf[0] = *p;
559                 p++;
560                 size--;
561
562                 /* Sends message chunks */
563                 while (size > 0) {
564                         int len = (size < priv->ctrl.max_len - 1) ?
565                                    size : priv->ctrl.max_len - 1;
566
567                         memcpy(buf + 1, p, len);
568
569                         rc = i2c_send(priv, buf, len + 1);
570                         if (rc < 0) {
571                                 tuner_err("%d returned from send\n", rc);
572                                 return -EINVAL;
573                         }
574
575                         p += len;
576                         size -= len;
577                 }
578         }
579         return 0;
580 }
581
582 static int load_scode(struct dvb_frontend *fe, unsigned int type,
583                          v4l2_std_id *id, __u16 int_freq, int scode)
584 {
585         struct xc2028_data *priv = fe->tuner_priv;
586         int                pos, rc;
587         unsigned char      *p;
588
589         tuner_dbg("%s called\n", __FUNCTION__);
590
591         if (!int_freq) {
592                 pos = seek_firmware(fe, type, id);
593                 if (pos < 0)
594                         return pos;
595         } else {
596                 for (pos = 0; pos < priv->firm_size; pos++) {
597                         if ((priv->firm[pos].int_freq == int_freq) &&
598                             (priv->firm[pos].type & HAS_IF))
599                                 break;
600                 }
601                 if (pos == priv->firm_size)
602                         return -ENOENT;
603         }
604
605         p = priv->firm[pos].ptr;
606
607         if (priv->firm[pos].type & HAS_IF) {
608                 if (priv->firm[pos].size != 12 * 16 || scode >= 16)
609                         return -EINVAL;
610                 p += 12 * scode;
611         } else {
612                 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
613                  * has a 2-byte size header in the firmware format. */
614                 if (priv->firm[pos].size != 14 * 16 || scode >= 16 ||
615                     le16_to_cpu(*(__u16 *)(p + 14 * scode)) != 12)
616                         return -EINVAL;
617                 p += 14 * scode + 2;
618         }
619
620         tuner_info("Loading SCODE for type=");
621         dump_firm_type_and_int_freq(priv->firm[pos].type,
622                                     priv->firm[pos].int_freq);
623         printk("(%x), id %016llx.\n", priv->firm[pos].type,
624                (unsigned long long)*id);
625
626         if (priv->firm_version < 0x0202)
627                 rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
628         else
629                 rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
630         if (rc < 0)
631                 return -EIO;
632
633         rc = i2c_send(priv, p, 12);
634         if (rc < 0)
635                 return -EIO;
636
637         rc = send_seq(priv, {0x00, 0x8c});
638         if (rc < 0)
639                 return -EIO;
640
641         return 0;
642 }
643
644 static int check_firmware(struct dvb_frontend *fe, unsigned int type,
645                           v4l2_std_id std, __u16 int_freq)
646 {
647         struct xc2028_data         *priv = fe->tuner_priv;
648         struct firmware_properties new_fw;
649         int                        rc = 0, is_retry = 0;
650         u16                        version, hwmodel;
651         v4l2_std_id                std0;
652
653         tuner_dbg("%s called\n", __FUNCTION__);
654
655         if (!priv->firm) {
656                 if (!priv->ctrl.fname) {
657                         tuner_info("xc2028/3028 firmware name not set!\n");
658                         return -EINVAL;
659                 }
660
661                 rc = load_all_firmwares(fe);
662                 if (rc < 0)
663                         return rc;
664         }
665
666         if (priv->ctrl.mts && !(type & FM))
667                 type |= MTS;
668
669 retry:
670         new_fw.type = type;
671         new_fw.id = std;
672         new_fw.std_req = std;
673         new_fw.scode_table = SCODE | priv->ctrl.scode_table;
674         new_fw.scode_nr = 0;
675         new_fw.int_freq = int_freq;
676
677         tuner_dbg("checking firmware, user requested type=");
678         if (debug) {
679                 dump_firm_type(new_fw.type);
680                 printk("(%x), id %016llx, ", new_fw.type,
681                        (unsigned long long)new_fw.std_req);
682                 if (!int_freq) {
683                         printk("scode_tbl ");
684                         dump_firm_type(priv->ctrl.scode_table);
685                         printk("(%x), ", priv->ctrl.scode_table);
686                 } else
687                         printk("int_freq %d, ", new_fw.int_freq);
688                 printk("scode_nr %d\n", new_fw.scode_nr);
689         }
690
691         /* No need to reload base firmware if it matches */
692         if (((BASE | new_fw.type) & BASE_TYPES) ==
693             (priv->cur_fw.type & BASE_TYPES)) {
694                 tuner_dbg("BASE firmware not changed.\n");
695                 goto skip_base;
696         }
697
698         /* Updating BASE - forget about all currently loaded firmware */
699         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
700
701         /* Reset is needed before loading firmware */
702         rc = priv->tuner_callback(priv->video_dev,
703                                   XC2028_TUNER_RESET, 0);
704         if (rc < 0)
705                 goto fail;
706
707         /* BASE firmwares are all std0 */
708         std0 = 0;
709         rc = load_firmware(fe, BASE | new_fw.type, &std0);
710         if (rc < 0) {
711                 tuner_err("Error %d while loading base firmware\n",
712                           rc);
713                 goto fail;
714         }
715
716         /* Load INIT1, if needed */
717         tuner_dbg("Load init1 firmware, if exists\n");
718
719         rc = load_firmware(fe, BASE | INIT1 | new_fw.type, &std0);
720         if (rc == -ENOENT)
721                 rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
722                                    &std0);
723         if (rc < 0 && rc != -ENOENT) {
724                 tuner_err("Error %d while loading init1 firmware\n",
725                           rc);
726                 goto fail;
727         }
728
729 skip_base:
730         /*
731          * No need to reload standard specific firmware if base firmware
732          * was not reloaded and requested video standards have not changed.
733          */
734         if (priv->cur_fw.type == (BASE | new_fw.type) &&
735             priv->cur_fw.std_req == std) {
736                 tuner_dbg("Std-specific firmware already loaded.\n");
737                 goto skip_std_specific;
738         }
739
740         /* Reloading std-specific firmware forces a SCODE update */
741         priv->cur_fw.scode_table = 0;
742
743         rc = load_firmware(fe, new_fw.type, &new_fw.id);
744         if (rc == -ENOENT)
745                 rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
746
747         if (rc < 0)
748                 goto fail;
749
750 skip_std_specific:
751         if (priv->cur_fw.scode_table == new_fw.scode_table &&
752             priv->cur_fw.scode_nr == new_fw.scode_nr) {
753                 tuner_dbg("SCODE firmware already loaded.\n");
754                 goto check_device;
755         }
756
757         /* Load SCODE firmware, if exists */
758         tuner_dbg("Trying to load scode %d\n", new_fw.scode_nr);
759
760         rc = load_scode(fe, new_fw.type | new_fw.scode_table, &new_fw.id,
761                         new_fw.int_freq, new_fw.scode_nr);
762
763 check_device:
764         if (xc2028_get_reg(priv, 0x0004, &version) < 0 ||
765             xc2028_get_reg(priv, 0x0008, &hwmodel) < 0) {
766                 tuner_err("Unable to read tuner registers.\n");
767                 goto fail;
768         }
769
770         tuner_info("Device is Xceive %d version %d.%d, "
771                    "firmware version %d.%d\n",
772                    hwmodel, (version & 0xf000) >> 12, (version & 0xf00) >> 8,
773                    (version & 0xf0) >> 4, version & 0xf);
774
775         /* Check firmware version against what we downloaded. */
776         if (priv->firm_version != ((version & 0xf0) << 4 | (version & 0x0f))) {
777                 tuner_err("Incorrect readback of firmware version.\n");
778                 goto fail;
779         }
780
781         /* Check that the tuner hardware model remains consistent over time. */
782         if (priv->hwmodel == 0 && (hwmodel == 2028 || hwmodel == 3028)) {
783                 priv->hwmodel = hwmodel;
784                 priv->hwvers  = version & 0xff00;
785         } else if (priv->hwmodel == 0 || priv->hwmodel != hwmodel ||
786                    priv->hwvers != (version & 0xff00)) {
787                 tuner_err("Read invalid device hardware information - tuner "
788                           "hung?\n");
789                 goto fail;
790         }
791
792         memcpy(&priv->cur_fw, &new_fw, sizeof(priv->cur_fw));
793
794         /*
795          * By setting BASE in cur_fw.type only after successfully loading all
796          * firmwares, we can:
797          * 1. Identify that BASE firmware with type=0 has been loaded;
798          * 2. Tell whether BASE firmware was just changed the next time through.
799          */
800         priv->cur_fw.type |= BASE;
801
802         return 0;
803
804 fail:
805         memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
806         if (!is_retry) {
807                 msleep(50);
808                 is_retry = 1;
809                 tuner_dbg("Retrying firmware load\n");
810                 goto retry;
811         }
812
813         if (rc == -ENOENT)
814                 rc = -EINVAL;
815         return rc;
816 }
817
818 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
819 {
820         struct xc2028_data *priv = fe->tuner_priv;
821         u16                 frq_lock, signal = 0;
822         int                 rc;
823
824         tuner_dbg("%s called\n", __FUNCTION__);
825
826         mutex_lock(&priv->lock);
827
828         /* Sync Lock Indicator */
829         rc = xc2028_get_reg(priv, 0x0002, &frq_lock);
830         if (rc < 0 || frq_lock == 0)
831                 goto ret;
832
833         /* Frequency is locked. Return signal quality */
834
835         /* Get SNR of the video signal */
836         rc = xc2028_get_reg(priv, 0x0040, &signal);
837         if (rc < 0)
838                 signal = -frq_lock;
839
840 ret:
841         mutex_unlock(&priv->lock);
842
843         *strength = signal;
844
845         return rc;
846 }
847
848 #define DIV 15625
849
850 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
851                             enum tuner_mode new_mode,
852                             unsigned int type,
853                             v4l2_std_id std,
854                             u16 int_freq)
855 {
856         struct xc2028_data *priv = fe->tuner_priv;
857         int                rc = -EINVAL;
858         unsigned char      buf[4];
859         u32                div, offset = 0;
860
861         tuner_dbg("%s called\n", __FUNCTION__);
862
863         mutex_lock(&priv->lock);
864
865         tuner_dbg("should set frequency %d kHz\n", freq / 1000);
866
867         if (check_firmware(fe, type, std, int_freq) < 0)
868                 goto ret;
869
870         /* On some cases xc2028 can disable video output, if
871          * very weak signals are received. By sending a soft
872          * reset, this is re-enabled. So, it is better to always
873          * send a soft reset before changing channels, to be sure
874          * that xc2028 will be in a safe state.
875          * Maybe this might also be needed for DTV.
876          */
877         if (new_mode == T_ANALOG_TV) {
878                 rc = send_seq(priv, {0x00, 0x00});
879         } else if (priv->cur_fw.type & ATSC) {
880                 offset = 1750000;
881         } else {
882                 offset = 2750000;
883                 /*
884                  * We must adjust the offset by 500kHz in two cases in order
885                  * to correctly center the IF output:
886                  * 1) When the ZARLINK456 or DIBCOM52 tables were explicitly
887                  *    selected and a 7MHz channel is tuned;
888                  * 2) When tuning a VHF channel with DTV78 firmware.
889                  */
890                 if (((priv->cur_fw.type & DTV7) &&
891                      (priv->cur_fw.scode_table & (ZARLINK456 | DIBCOM52))) ||
892                     ((priv->cur_fw.type & DTV78) && freq < 470000000))
893                         offset -= 500000;
894         }
895
896         div = (freq - offset + DIV / 2) / DIV;
897
898         /* CMD= Set frequency */
899         if (priv->firm_version < 0x0202)
900                 rc = send_seq(priv, {0x00, 0x02, 0x00, 0x00});
901         else
902                 rc = send_seq(priv, {0x80, 0x02, 0x00, 0x00});
903         if (rc < 0)
904                 goto ret;
905
906         rc = priv->tuner_callback(priv->video_dev, XC2028_RESET_CLK, 1);
907         if (rc < 0)
908                 goto ret;
909
910         msleep(10);
911
912         buf[0] = 0xff & (div >> 24);
913         buf[1] = 0xff & (div >> 16);
914         buf[2] = 0xff & (div >> 8);
915         buf[3] = 0xff & (div);
916
917         rc = i2c_send(priv, buf, sizeof(buf));
918         if (rc < 0)
919                 goto ret;
920         msleep(100);
921
922         priv->frequency = freq;
923
924         tuner_dbg("divisor= %02x %02x %02x %02x (freq=%d.%03d)\n",
925                buf[0], buf[1], buf[2], buf[3],
926                freq / 1000000, (freq % 1000000) / 1000);
927
928         rc = 0;
929
930 ret:
931         mutex_unlock(&priv->lock);
932
933         return rc;
934 }
935
936 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
937                               struct analog_parameters *p)
938 {
939         struct xc2028_data *priv = fe->tuner_priv;
940         unsigned int       type=0;
941
942         tuner_dbg("%s called\n", __FUNCTION__);
943
944         if (p->mode == V4L2_TUNER_RADIO) {
945                 type |= FM;
946                 if (priv->ctrl.input1)
947                         type |= INPUT1;
948                 return generic_set_freq(fe, (625l * p->frequency) / 10,
949                                 T_ANALOG_TV, type, 0, 0);
950         }
951
952         /* if std is not defined, choose one */
953         if (!p->std)
954                 p->std = V4L2_STD_MN;
955
956         /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
957         if (!(p->std & V4L2_STD_MN))
958                 type |= F8MHZ;
959
960         /* Add audio hack to std mask */
961         p->std |= parse_audio_std_option();
962
963         return generic_set_freq(fe, 62500l * p->frequency,
964                                 T_ANALOG_TV, type, p->std, 0);
965 }
966
967 static int xc2028_set_params(struct dvb_frontend *fe,
968                              struct dvb_frontend_parameters *p)
969 {
970         struct xc2028_data *priv = fe->tuner_priv;
971         unsigned int       type=0;
972         fe_bandwidth_t     bw = BANDWIDTH_8_MHZ;
973         u16                demod = 0;
974
975         tuner_dbg("%s called\n", __FUNCTION__);
976
977         if (priv->ctrl.d2633)
978                 type |= D2633;
979         else
980                 type |= D2620;
981
982         switch(fe->ops.info.type) {
983         case FE_OFDM:
984                 bw = p->u.ofdm.bandwidth;
985                 break;
986         case FE_QAM:
987                 tuner_info("WARN: There are some reports that "
988                            "QAM 6 MHz doesn't work.\n"
989                            "If this works for you, please report by "
990                            "e-mail to: v4l-dvb-maintainer@linuxtv.org\n");
991                 bw = BANDWIDTH_6_MHZ;
992                 type |= QAM;
993                 break;
994         case FE_ATSC:
995                 bw = BANDWIDTH_6_MHZ;
996                 /* The only ATSC firmware (at least on v2.7) is D2633,
997                    so overrides ctrl->d2633 */
998                 type |= ATSC| D2633;
999                 type &= ~D2620;
1000                 break;
1001         /* DVB-S is not supported */
1002         default:
1003                 return -EINVAL;
1004         }
1005
1006         switch (bw) {
1007         case BANDWIDTH_8_MHZ:
1008                 if (p->frequency < 470000000)
1009                         priv->ctrl.vhfbw7 = 0;
1010                 else
1011                         priv->ctrl.uhfbw8 = 1;
1012                 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV8;
1013                 type |= F8MHZ;
1014                 break;
1015         case BANDWIDTH_7_MHZ:
1016                 if (p->frequency < 470000000)
1017                         priv->ctrl.vhfbw7 = 1;
1018                 else
1019                         priv->ctrl.uhfbw8 = 0;
1020                 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV7;
1021                 type |= F8MHZ;
1022                 break;
1023         case BANDWIDTH_6_MHZ:
1024                 type |= DTV6;
1025                 priv->ctrl.vhfbw7 = 0;
1026                 priv->ctrl.uhfbw8 = 0;
1027                 break;
1028         default:
1029                 tuner_err("error: bandwidth not supported.\n");
1030         };
1031
1032         /* All S-code tables need a 200kHz shift */
1033         if (priv->ctrl.demod)
1034                 demod = priv->ctrl.demod + 200;
1035
1036         return generic_set_freq(fe, p->frequency,
1037                                 T_DIGITAL_TV, type, 0, demod);
1038 }
1039
1040 static int xc2028_sleep(struct dvb_frontend *fe)
1041 {
1042         struct xc2028_data *priv = fe->tuner_priv;
1043         int rc = 0;
1044
1045         tuner_dbg("%s called\n", __FUNCTION__);
1046
1047         mutex_lock(&priv->lock);
1048
1049         if (priv->firm_version < 0x0202)
1050                 rc = send_seq(priv, {0x00, 0x08, 0x00, 0x00});
1051         else
1052                 rc = send_seq(priv, {0x80, 0x08, 0x00, 0x00});
1053
1054         priv->cur_fw.type = 0;  /* need firmware reload */
1055
1056         mutex_unlock(&priv->lock);
1057
1058         return rc;
1059 }
1060
1061
1062 static int xc2028_dvb_release(struct dvb_frontend *fe)
1063 {
1064         struct xc2028_data *priv = fe->tuner_priv;
1065
1066         tuner_dbg("%s called\n", __FUNCTION__);
1067
1068         mutex_lock(&xc2028_list_mutex);
1069
1070         priv->count--;
1071
1072         if (!priv->count) {
1073                 list_del(&priv->xc2028_list);
1074
1075                 kfree(priv->ctrl.fname);
1076
1077                 free_firmware(priv);
1078                 kfree(priv);
1079                 fe->tuner_priv = NULL;
1080         }
1081
1082         mutex_unlock(&xc2028_list_mutex);
1083
1084         return 0;
1085 }
1086
1087 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1088 {
1089         struct xc2028_data *priv = fe->tuner_priv;
1090
1091         tuner_dbg("%s called\n", __FUNCTION__);
1092
1093         *frequency = priv->frequency;
1094
1095         return 0;
1096 }
1097
1098 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1099 {
1100         struct xc2028_data *priv = fe->tuner_priv;
1101         struct xc2028_ctrl *p    = priv_cfg;
1102         int                 rc   = 0;
1103
1104         tuner_dbg("%s called\n", __FUNCTION__);
1105
1106         mutex_lock(&priv->lock);
1107
1108         kfree(priv->ctrl.fname);
1109         free_firmware(priv);
1110
1111         memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1112         priv->ctrl.fname = NULL;
1113
1114         if (p->fname) {
1115                 priv->ctrl.fname = kstrdup(p->fname, GFP_KERNEL);
1116                 if (priv->ctrl.fname == NULL)
1117                         rc = -ENOMEM;
1118         }
1119
1120         if (priv->ctrl.max_len < 9)
1121                 priv->ctrl.max_len = 13;
1122
1123         mutex_unlock(&priv->lock);
1124
1125         return rc;
1126 }
1127
1128 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1129         .info = {
1130                  .name = "Xceive XC3028",
1131                  .frequency_min = 42000000,
1132                  .frequency_max = 864000000,
1133                  .frequency_step = 50000,
1134                  },
1135
1136         .set_config        = xc2028_set_config,
1137         .set_analog_params = xc2028_set_analog_freq,
1138         .release           = xc2028_dvb_release,
1139         .get_frequency     = xc2028_get_frequency,
1140         .get_rf_strength   = xc2028_signal,
1141         .set_params        = xc2028_set_params,
1142         .sleep             = xc2028_sleep,
1143
1144 };
1145
1146 struct dvb_frontend *xc2028_attach(struct dvb_frontend *fe,
1147                                    struct xc2028_config *cfg)
1148 {
1149         struct xc2028_data *priv;
1150         void               *video_dev;
1151
1152         if (debug)
1153                 printk(KERN_DEBUG PREFIX ": Xcv2028/3028 init called!\n");
1154
1155         if (NULL == cfg || NULL == cfg->video_dev)
1156                 return NULL;
1157
1158         if (!fe) {
1159                 printk(KERN_ERR PREFIX ": No frontend!\n");
1160                 return NULL;
1161         }
1162
1163         video_dev = cfg->video_dev;
1164
1165         mutex_lock(&xc2028_list_mutex);
1166
1167         list_for_each_entry(priv, &xc2028_list, xc2028_list) {
1168                 if (priv->video_dev == cfg->video_dev) {
1169                         video_dev = NULL;
1170                         break;
1171                 }
1172         }
1173
1174         if (video_dev) {
1175                 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1176                 if (priv == NULL) {
1177                         mutex_unlock(&xc2028_list_mutex);
1178                         return NULL;
1179                 }
1180
1181                 priv->i2c_props.addr = cfg->i2c_addr;
1182                 priv->i2c_props.adap = cfg->i2c_adap;
1183                 priv->video_dev = video_dev;
1184                 priv->tuner_callback = cfg->callback;
1185                 priv->ctrl.max_len = 13;
1186
1187                 mutex_init(&priv->lock);
1188
1189                 list_add_tail(&priv->xc2028_list, &xc2028_list);
1190         }
1191
1192         fe->tuner_priv = priv;
1193         priv->count++;
1194
1195         memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1196                sizeof(xc2028_dvb_tuner_ops));
1197
1198         tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1199
1200         if (cfg->ctrl)
1201                 xc2028_set_config(fe, cfg->ctrl);
1202
1203         mutex_unlock(&xc2028_list_mutex);
1204
1205         return fe;
1206 }
1207
1208 EXPORT_SYMBOL(xc2028_attach);
1209
1210 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1211 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1212 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
1213 MODULE_LICENSE("GPL");