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