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