V4L/DVB (6853): xc2028: check HAS_IF flag against table
[deliverable/linux.git] / 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
399 tuner_dbg("%s called, want type=", __FUNCTION__);
400 if (debug) {
401 dump_firm_type(type);
402 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
403 }
404
405 if (!priv->firm) {
406 tuner_err("Error! firmware not loaded\n");
407 return -EINVAL;
408 }
409
410 if (((type & ~SCODE) == 0) && (*id == 0))
411 *id = V4L2_STD_PAL;
412
413 if (type & BASE)
414 type &= BASE_TYPES;
415 else if (type & SCODE)
416 type &= SCODE_TYPES;
417 else if (type & DTV_TYPES)
418 type &= DTV_TYPES;
419 else if (type & STD_SPECIFIC_TYPES)
420 type &= STD_SPECIFIC_TYPES;
421
422 /* Seek for exact match */
423 for (i = 0; i < priv->firm_size; i++) {
424 if ((type == priv->firm[i].type) && (*id == priv->firm[i].id))
425 goto found;
426 }
427
428 /* Seek for generic video standard match */
429 for (i = 0; i < priv->firm_size; i++) {
430 v4l2_std_id match_mask;
431 int nr_matches;
432
433 if (type != priv->firm[i].type)
434 continue;
435
436 match_mask = *id & priv->firm[i].id;
437 if (!match_mask)
438 continue;
439
440 if ((*id & match_mask) == *id)
441 goto found; /* Supports all the requested standards */
442
443 nr_matches = hweight64(match_mask);
444 if (nr_matches > best_nr_matches) {
445 best_nr_matches = nr_matches;
446 best_i = i;
447 }
448 }
449
450 if (best_nr_matches > 0) {
451 tuner_dbg("Selecting best matching firmware (%d bits) for "
452 "type=", best_nr_matches);
453 dump_firm_type(type);
454 printk("(%x), id %016llx:\n", type, (unsigned long long)*id);
455 i = best_i;
456 goto found;
457 }
458
459 /*FIXME: Would make sense to seek for type "hint" match ? */
460
461 i = -ENOENT;
462 goto ret;
463
464 found:
465 *id = priv->firm[i].id;
466
467 ret:
468 tuner_dbg("%s firmware for type=", (i < 0) ? "Can't find" : "Found");
469 if (debug) {
470 dump_firm_type(type);
471 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
472 }
473 return i;
474 }
475
476 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
477 v4l2_std_id *id)
478 {
479 struct xc2028_data *priv = fe->tuner_priv;
480 int pos, rc;
481 unsigned char *p, *endp, buf[priv->ctrl.max_len];
482
483 tuner_dbg("%s called\n", __FUNCTION__);
484
485 pos = seek_firmware(fe, type, id);
486 if (pos < 0)
487 return pos;
488
489 tuner_info("Loading firmware for type=");
490 dump_firm_type(priv->firm[pos].type);
491 printk("(%x), id %016llx.\n", priv->firm[pos].type,
492 (unsigned long long)*id);
493
494 p = priv->firm[pos].ptr;
495 endp = p + priv->firm[pos].size;
496
497 while (p < endp) {
498 __u16 size;
499
500 /* Checks if there's enough bytes to read */
501 if (p + sizeof(size) > endp) {
502 tuner_err("Firmware chunk size is wrong\n");
503 return -EINVAL;
504 }
505
506 size = le16_to_cpu(*(__u16 *) p);
507 p += sizeof(size);
508
509 if (size == 0xffff)
510 return 0;
511
512 if (!size) {
513 /* Special callback command received */
514 rc = priv->tuner_callback(priv->video_dev,
515 XC2028_TUNER_RESET, 0);
516 if (rc < 0) {
517 tuner_err("Error at RESET code %d\n",
518 (*p) & 0x7f);
519 return -EINVAL;
520 }
521 continue;
522 }
523 if (size >= 0xff00) {
524 switch (size) {
525 case 0xff00:
526 rc = priv->tuner_callback(priv->video_dev,
527 XC2028_RESET_CLK, 0);
528 if (rc < 0) {
529 tuner_err("Error at RESET code %d\n",
530 (*p) & 0x7f);
531 return -EINVAL;
532 }
533 break;
534 default:
535 tuner_info("Invalid RESET code %d\n",
536 size & 0x7f);
537 return -EINVAL;
538
539 }
540 continue;
541 }
542
543 /* Checks for a sleep command */
544 if (size & 0x8000) {
545 msleep(size & 0x7fff);
546 continue;
547 }
548
549 if ((size + p > endp)) {
550 tuner_err("missing bytes: need %d, have %d\n",
551 size, (int)(endp - p));
552 return -EINVAL;
553 }
554
555 buf[0] = *p;
556 p++;
557 size--;
558
559 /* Sends message chunks */
560 while (size > 0) {
561 int len = (size < priv->ctrl.max_len - 1) ?
562 size : priv->ctrl.max_len - 1;
563
564 memcpy(buf + 1, p, len);
565
566 rc = i2c_send(priv, buf, len + 1);
567 if (rc < 0) {
568 tuner_err("%d returned from send\n", rc);
569 return -EINVAL;
570 }
571
572 p += len;
573 size -= len;
574 }
575 }
576 return 0;
577 }
578
579 static int load_scode(struct dvb_frontend *fe, unsigned int type,
580 v4l2_std_id *id, __u16 int_freq, int scode)
581 {
582 struct xc2028_data *priv = fe->tuner_priv;
583 int pos, rc;
584 unsigned char *p;
585
586 tuner_dbg("%s called\n", __FUNCTION__);
587
588 if (!int_freq) {
589 pos = seek_firmware(fe, type, id);
590 if (pos < 0)
591 return pos;
592 } else {
593 for (pos = 0; pos < priv->firm_size; pos++) {
594 if ((priv->firm[pos].int_freq == int_freq) &&
595 (priv->firm[pos].type & HAS_IF))
596 break;
597 }
598 if (pos == priv->firm_size)
599 return -ENOENT;
600 }
601
602 p = priv->firm[pos].ptr;
603
604 if (priv->firm[pos].type & HAS_IF) {
605 if (priv->firm[pos].size != 12 * 16 || scode >= 16)
606 return -EINVAL;
607 p += 12 * scode;
608 } else {
609 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
610 * has a 2-byte size header in the firmware format. */
611 if (priv->firm[pos].size != 14 * 16 || scode >= 16 ||
612 le16_to_cpu(*(__u16 *)(p + 14 * scode)) != 12)
613 return -EINVAL;
614 p += 14 * scode + 2;
615 }
616
617 tuner_info("Loading SCODE for type=");
618 dump_firm_type_and_int_freq(priv->firm[pos].type,
619 priv->firm[pos].int_freq);
620 printk("(%x), id %016llx.\n", priv->firm[pos].type,
621 (unsigned long long)*id);
622
623 if (priv->firm_version < 0x0202)
624 rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
625 else
626 rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
627 if (rc < 0)
628 return -EIO;
629
630 rc = i2c_send(priv, p, 12);
631 if (rc < 0)
632 return -EIO;
633
634 rc = send_seq(priv, {0x00, 0x8c});
635 if (rc < 0)
636 return -EIO;
637
638 return 0;
639 }
640
641 static int check_firmware(struct dvb_frontend *fe, unsigned int type,
642 v4l2_std_id std, __u16 int_freq)
643 {
644 struct xc2028_data *priv = fe->tuner_priv;
645 struct firmware_properties new_fw;
646 int rc = 0, is_retry = 0;
647 u16 version, hwmodel;
648 v4l2_std_id std0;
649
650 tuner_dbg("%s called\n", __FUNCTION__);
651
652 if (!priv->firm) {
653 if (!priv->ctrl.fname) {
654 tuner_info("xc2028/3028 firmware name not set!\n");
655 return -EINVAL;
656 }
657
658 rc = load_all_firmwares(fe);
659 if (rc < 0)
660 return rc;
661 }
662
663 if (priv->ctrl.mts)
664 type |= MTS;
665
666 retry:
667 new_fw.type = type;
668 new_fw.id = std;
669 new_fw.std_req = std;
670 new_fw.scode_table = SCODE | priv->ctrl.scode_table;
671 new_fw.scode_nr = 0;
672 new_fw.int_freq = int_freq;
673
674 tuner_dbg("checking firmware, user requested type=");
675 if (debug) {
676 dump_firm_type(new_fw.type);
677 printk("(%x), id %016llx, ", new_fw.type,
678 (unsigned long long)new_fw.std_req);
679 if (!int_freq) {
680 printk("scode_tbl ");
681 dump_firm_type(priv->ctrl.scode_table);
682 printk("(%x), ", priv->ctrl.scode_table);
683 } else
684 printk("int_freq %d, ", new_fw.int_freq);
685 printk("scode_nr %d\n", new_fw.scode_nr);
686 }
687
688 /* No need to reload base firmware if it matches */
689 if (((BASE | new_fw.type) & BASE_TYPES) ==
690 (priv->cur_fw.type & BASE_TYPES)) {
691 tuner_dbg("BASE firmware not changed.\n");
692 goto skip_base;
693 }
694
695 /* Updating BASE - forget about all currently loaded firmware */
696 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
697
698 /* Reset is needed before loading firmware */
699 rc = priv->tuner_callback(priv->video_dev,
700 XC2028_TUNER_RESET, 0);
701 if (rc < 0)
702 goto fail;
703
704 /* BASE firmwares are all std0 */
705 std0 = 0;
706 rc = load_firmware(fe, BASE | new_fw.type, &std0);
707 if (rc < 0) {
708 tuner_err("Error %d while loading base firmware\n",
709 rc);
710 goto fail;
711 }
712
713 /* Load INIT1, if needed */
714 tuner_dbg("Load init1 firmware, if exists\n");
715
716 rc = load_firmware(fe, BASE | INIT1 | new_fw.type, &std0);
717 if (rc == -ENOENT)
718 rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
719 &std0);
720 if (rc < 0 && rc != -ENOENT) {
721 tuner_err("Error %d while loading init1 firmware\n",
722 rc);
723 goto fail;
724 }
725
726 skip_base:
727 /*
728 * No need to reload standard specific firmware if base firmware
729 * was not reloaded and requested video standards have not changed.
730 */
731 if (priv->cur_fw.type == (BASE | new_fw.type) &&
732 priv->cur_fw.std_req == std) {
733 tuner_dbg("Std-specific firmware already loaded.\n");
734 goto skip_std_specific;
735 }
736
737 /* Reloading std-specific firmware forces a SCODE update */
738 priv->cur_fw.scode_table = 0;
739
740 rc = load_firmware(fe, new_fw.type, &new_fw.id);
741 if (rc == -ENOENT)
742 rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
743
744 if (rc < 0)
745 goto fail;
746
747 skip_std_specific:
748 if (priv->cur_fw.scode_table == new_fw.scode_table &&
749 priv->cur_fw.scode_nr == new_fw.scode_nr) {
750 tuner_dbg("SCODE firmware already loaded.\n");
751 goto check_device;
752 }
753
754 /* Load SCODE firmware, if exists */
755 tuner_dbg("Trying to load scode %d\n", new_fw.scode_nr);
756
757 rc = load_scode(fe, new_fw.type | new_fw.scode_table, &new_fw.id,
758 new_fw.int_freq, new_fw.scode_nr);
759
760 check_device:
761 if (xc2028_get_reg(priv, 0x0004, &version) < 0 ||
762 xc2028_get_reg(priv, 0x0008, &hwmodel) < 0) {
763 tuner_err("Unable to read tuner registers.\n");
764 goto fail;
765 }
766
767 tuner_info("Device is Xceive %d version %d.%d, "
768 "firmware version %d.%d\n",
769 hwmodel, (version & 0xf000) >> 12, (version & 0xf00) >> 8,
770 (version & 0xf0) >> 4, version & 0xf);
771
772 /* Check firmware version against what we downloaded. */
773 if (priv->firm_version != ((version & 0xf0) << 4 | (version & 0x0f))) {
774 tuner_err("Incorrect readback of firmware version.\n");
775 goto fail;
776 }
777
778 /* Check that the tuner hardware model remains consistent over time. */
779 if (priv->hwmodel == 0 && (hwmodel == 2028 || hwmodel == 3028)) {
780 priv->hwmodel = hwmodel;
781 priv->hwvers = version & 0xff00;
782 } else if (priv->hwmodel == 0 || priv->hwmodel != hwmodel ||
783 priv->hwvers != (version & 0xff00)) {
784 tuner_err("Read invalid device hardware information - tuner "
785 "hung?\n");
786 goto fail;
787 }
788
789 memcpy(&priv->cur_fw, &new_fw, sizeof(priv->cur_fw));
790
791 /*
792 * By setting BASE in cur_fw.type only after successfully loading all
793 * firmwares, we can:
794 * 1. Identify that BASE firmware with type=0 has been loaded;
795 * 2. Tell whether BASE firmware was just changed the next time through.
796 */
797 priv->cur_fw.type |= BASE;
798
799 return 0;
800
801 fail:
802 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
803 if (!is_retry) {
804 msleep(50);
805 is_retry = 1;
806 tuner_dbg("Retrying firmware load\n");
807 goto retry;
808 }
809
810 if (rc == -ENOENT)
811 rc = -EINVAL;
812 return rc;
813 }
814
815 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
816 {
817 struct xc2028_data *priv = fe->tuner_priv;
818 u16 frq_lock, signal = 0;
819 int rc;
820
821 tuner_dbg("%s called\n", __FUNCTION__);
822
823 mutex_lock(&priv->lock);
824
825 /* Sync Lock Indicator */
826 rc = xc2028_get_reg(priv, 0x0002, &frq_lock);
827 if (rc < 0 || frq_lock == 0)
828 goto ret;
829
830 /* Frequency is locked. Return signal quality */
831
832 /* Get SNR of the video signal */
833 rc = xc2028_get_reg(priv, 0x0040, &signal);
834 if (rc < 0)
835 signal = -frq_lock;
836
837 ret:
838 mutex_unlock(&priv->lock);
839
840 *strength = signal;
841
842 return rc;
843 }
844
845 #define DIV 15625
846
847 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
848 enum tuner_mode new_mode,
849 unsigned int type,
850 v4l2_std_id std,
851 u16 int_freq)
852 {
853 struct xc2028_data *priv = fe->tuner_priv;
854 int rc = -EINVAL;
855 unsigned char buf[4];
856 u32 div, offset = 0;
857
858 tuner_dbg("%s called\n", __FUNCTION__);
859
860 mutex_lock(&priv->lock);
861
862 tuner_dbg("should set frequency %d kHz\n", freq / 1000);
863
864 if (check_firmware(fe, type, std, int_freq) < 0)
865 goto ret;
866
867 /* On some cases xc2028 can disable video output, if
868 * very weak signals are received. By sending a soft
869 * reset, this is re-enabled. So, it is better to always
870 * send a soft reset before changing channels, to be sure
871 * that xc2028 will be in a safe state.
872 * Maybe this might also be needed for DTV.
873 */
874 if (new_mode == T_ANALOG_TV) {
875 rc = send_seq(priv, {0x00, 0x00});
876 } else {
877 offset = 2750000;
878 if (priv->cur_fw.type & DTV7)
879 offset -= 500000;
880 }
881
882 div = (freq - offset + DIV / 2) / DIV;
883
884 /* CMD= Set frequency */
885 if (priv->firm_version < 0x0202)
886 rc = send_seq(priv, {0x00, 0x02, 0x00, 0x00});
887 else
888 rc = send_seq(priv, {0x80, 0x02, 0x00, 0x00});
889 if (rc < 0)
890 goto ret;
891
892 rc = priv->tuner_callback(priv->video_dev, XC2028_RESET_CLK, 1);
893 if (rc < 0)
894 goto ret;
895
896 msleep(10);
897
898 buf[0] = 0xff & (div >> 24);
899 buf[1] = 0xff & (div >> 16);
900 buf[2] = 0xff & (div >> 8);
901 buf[3] = 0xff & (div);
902
903 rc = i2c_send(priv, buf, sizeof(buf));
904 if (rc < 0)
905 goto ret;
906 msleep(100);
907
908 priv->frequency = freq;
909
910 tuner_dbg("divisor= %02x %02x %02x %02x (freq=%d.%03d)\n",
911 buf[0], buf[1], buf[2], buf[3],
912 freq / 1000000, (freq % 1000000) / 1000);
913
914 rc = 0;
915
916 ret:
917 mutex_unlock(&priv->lock);
918
919 return rc;
920 }
921
922 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
923 struct analog_parameters *p)
924 {
925 struct xc2028_data *priv = fe->tuner_priv;
926 unsigned int type=0;
927
928 tuner_dbg("%s called\n", __FUNCTION__);
929
930 if (p->mode == V4L2_TUNER_RADIO) {
931 type |= FM;
932 if (priv->ctrl.input1)
933 type |= INPUT1;
934 return generic_set_freq(fe, (625l * p->frequency) / 10,
935 T_ANALOG_TV, type, 0, 0);
936 }
937
938 /* if std is not defined, choose one */
939 if (!p->std)
940 p->std = V4L2_STD_MN;
941
942 /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
943 if (!(p->std & V4L2_STD_MN))
944 type |= F8MHZ;
945
946 /* Add audio hack to std mask */
947 p->std |= parse_audio_std_option();
948
949 return generic_set_freq(fe, 62500l * p->frequency,
950 T_ANALOG_TV, type, p->std, 0);
951 }
952
953 static int xc2028_set_params(struct dvb_frontend *fe,
954 struct dvb_frontend_parameters *p)
955 {
956 struct xc2028_data *priv = fe->tuner_priv;
957 unsigned int type=0;
958 fe_bandwidth_t bw = BANDWIDTH_8_MHZ;
959 u16 demod = 0;
960
961 tuner_dbg("%s called\n", __FUNCTION__);
962
963 if (priv->ctrl.d2633)
964 type |= D2633;
965 else
966 type |= D2620;
967
968 switch(fe->ops.info.type) {
969 case FE_OFDM:
970 bw = p->u.ofdm.bandwidth;
971 break;
972 case FE_QAM:
973 tuner_info("WARN: There are some reports that "
974 "QAM 6 MHz doesn't work.\n"
975 "If this works for you, please report by "
976 "e-mail to: v4l-dvb-maintainer@linuxtv.org\n");
977 bw = BANDWIDTH_6_MHZ;
978 type |= QAM;
979 break;
980 case FE_ATSC:
981 bw = BANDWIDTH_6_MHZ;
982 /* The only ATSC firmware (at least on v2.7) is D2633,
983 so overrides ctrl->d2633 */
984 type |= ATSC| D2633;
985 type &= ~D2620;
986 break;
987 /* DVB-S is not supported */
988 default:
989 return -EINVAL;
990 }
991
992 /* FIXME:
993 There are two Scodes that will never be selected:
994 DTV78 ZARLINK456, DTV78 DIBCOM52
995 When it should opt for DTV78 instead of DTV7 or DTV8?
996 */
997 switch (bw) {
998 case BANDWIDTH_8_MHZ:
999 type |= DTV8 | F8MHZ;
1000 break;
1001 case BANDWIDTH_7_MHZ:
1002 type |= DTV7 | F8MHZ;
1003 break;
1004 case BANDWIDTH_6_MHZ:
1005 type |= DTV6 ;
1006 break;
1007 default:
1008 tuner_err("error: bandwidth not supported.\n");
1009 };
1010
1011 /* All S-code tables need a 200kHz shift */
1012 if (priv->ctrl.demod)
1013 demod = priv->ctrl.demod + 200;
1014
1015 return generic_set_freq(fe, p->frequency,
1016 T_DIGITAL_TV, type, 0, demod);
1017 }
1018
1019 static int xc2028_sleep(struct dvb_frontend *fe)
1020 {
1021 struct xc2028_data *priv = fe->tuner_priv;
1022 int rc = 0;
1023
1024 tuner_dbg("%s called\n", __FUNCTION__);
1025
1026 mutex_lock(&priv->lock);
1027
1028 if (priv->firm_version < 0x0202)
1029 rc = send_seq(priv, {0x00, 0x08, 0x00, 0x00});
1030 else
1031 rc = send_seq(priv, {0x80, 0x08, 0x00, 0x00});
1032
1033 priv->cur_fw.type = 0; /* need firmware reload */
1034
1035 mutex_unlock(&priv->lock);
1036
1037 return rc;
1038 }
1039
1040
1041 static int xc2028_dvb_release(struct dvb_frontend *fe)
1042 {
1043 struct xc2028_data *priv = fe->tuner_priv;
1044
1045 tuner_dbg("%s called\n", __FUNCTION__);
1046
1047 mutex_lock(&xc2028_list_mutex);
1048
1049 priv->count--;
1050
1051 if (!priv->count) {
1052 list_del(&priv->xc2028_list);
1053
1054 kfree(priv->ctrl.fname);
1055
1056 free_firmware(priv);
1057 kfree(priv);
1058 fe->tuner_priv = NULL;
1059 }
1060
1061 mutex_unlock(&xc2028_list_mutex);
1062
1063 return 0;
1064 }
1065
1066 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1067 {
1068 struct xc2028_data *priv = fe->tuner_priv;
1069
1070 tuner_dbg("%s called\n", __FUNCTION__);
1071
1072 *frequency = priv->frequency;
1073
1074 return 0;
1075 }
1076
1077 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1078 {
1079 struct xc2028_data *priv = fe->tuner_priv;
1080 struct xc2028_ctrl *p = priv_cfg;
1081 int rc = 0;
1082
1083 tuner_dbg("%s called\n", __FUNCTION__);
1084
1085 mutex_lock(&priv->lock);
1086
1087 kfree(priv->ctrl.fname);
1088 free_firmware(priv);
1089
1090 memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1091 priv->ctrl.fname = NULL;
1092
1093 if (p->fname) {
1094 priv->ctrl.fname = kstrdup(p->fname, GFP_KERNEL);
1095 if (priv->ctrl.fname == NULL)
1096 rc = -ENOMEM;
1097 }
1098
1099 if (priv->ctrl.max_len < 9)
1100 priv->ctrl.max_len = 13;
1101
1102 mutex_unlock(&priv->lock);
1103
1104 return rc;
1105 }
1106
1107 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1108 .info = {
1109 .name = "Xceive XC3028",
1110 .frequency_min = 42000000,
1111 .frequency_max = 864000000,
1112 .frequency_step = 50000,
1113 },
1114
1115 .set_config = xc2028_set_config,
1116 .set_analog_params = xc2028_set_analog_freq,
1117 .release = xc2028_dvb_release,
1118 .get_frequency = xc2028_get_frequency,
1119 .get_rf_strength = xc2028_signal,
1120 .set_params = xc2028_set_params,
1121 .sleep = xc2028_sleep,
1122
1123 };
1124
1125 void *xc2028_attach(struct dvb_frontend *fe, struct xc2028_config *cfg)
1126 {
1127 struct xc2028_data *priv;
1128 void *video_dev;
1129
1130 if (debug)
1131 printk(KERN_DEBUG PREFIX ": Xcv2028/3028 init called!\n");
1132
1133 if (NULL == cfg || NULL == cfg->video_dev)
1134 return NULL;
1135
1136 if (!fe) {
1137 printk(KERN_ERR PREFIX ": No frontend!\n");
1138 return NULL;
1139 }
1140
1141 video_dev = cfg->video_dev;
1142
1143 mutex_lock(&xc2028_list_mutex);
1144
1145 list_for_each_entry(priv, &xc2028_list, xc2028_list) {
1146 if (priv->video_dev == cfg->video_dev) {
1147 video_dev = NULL;
1148 break;
1149 }
1150 }
1151
1152 if (video_dev) {
1153 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1154 if (priv == NULL) {
1155 mutex_unlock(&xc2028_list_mutex);
1156 return NULL;
1157 }
1158
1159 priv->i2c_props.addr = cfg->i2c_addr;
1160 priv->i2c_props.adap = cfg->i2c_adap;
1161 priv->video_dev = video_dev;
1162 priv->tuner_callback = cfg->callback;
1163 priv->ctrl.max_len = 13;
1164
1165 mutex_init(&priv->lock);
1166
1167 list_add_tail(&priv->xc2028_list, &xc2028_list);
1168 }
1169
1170 fe->tuner_priv = priv;
1171 priv->count++;
1172
1173 memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1174 sizeof(xc2028_dvb_tuner_ops));
1175
1176 tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1177
1178 if (cfg->ctrl)
1179 xc2028_set_config(fe, cfg->ctrl);
1180
1181 mutex_unlock(&xc2028_list_mutex);
1182
1183 return fe;
1184 }
1185
1186 EXPORT_SYMBOL(xc2028_attach);
1187
1188 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1189 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1190 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
1191 MODULE_LICENSE("GPL");
This page took 0.0591 seconds and 6 git commands to generate.