mfd: wm8350-i2c: Make sure the i2c regmap functions are compiled
[linux/fpc-iii.git] / drivers / media / tuners / tuner-xc2028.c
blob9771cd83c06e2a0d0c49666a36402734a1f493ff
1 /* tuner-xc2028
3 * Copyright (c) 2007-2008 Mauro Carvalho Chehab (mchehab@infradead.org)
5 * Copyright (c) 2007 Michel Ludwig (michel.ludwig@gmail.com)
6 * - frontend interface
8 * This code is placed under the terms of the GNU General Public License v2
9 */
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 <linux/slab.h>
19 #include <asm/unaligned.h>
20 #include "tuner-i2c.h"
21 #include "tuner-xc2028.h"
22 #include "tuner-xc2028-types.h"
24 #include <linux/dvb/frontend.h>
25 #include "dvb_frontend.h"
27 /* Max transfer size done by I2C transfer functions */
28 #define MAX_XFER_SIZE 80
30 /* Registers (Write-only) */
31 #define XREG_INIT 0x00
32 #define XREG_RF_FREQ 0x02
33 #define XREG_POWER_DOWN 0x08
35 /* Registers (Read-only) */
36 #define XREG_FREQ_ERROR 0x01
37 #define XREG_LOCK 0x02
38 #define XREG_VERSION 0x04
39 #define XREG_PRODUCT_ID 0x08
40 #define XREG_HSYNC_FREQ 0x10
41 #define XREG_FRAME_LINES 0x20
42 #define XREG_SNR 0x40
44 #define XREG_ADC_ENV 0x0100
46 static int debug;
47 module_param(debug, int, 0644);
48 MODULE_PARM_DESC(debug, "enable verbose debug messages");
50 static int no_poweroff;
51 module_param(no_poweroff, int, 0644);
52 MODULE_PARM_DESC(no_poweroff, "0 (default) powers device off when not used.\n"
53 "1 keep device energized and with tuner ready all the times.\n"
54 " Faster, but consumes more power and keeps the device hotter\n");
56 static char audio_std[8];
57 module_param_string(audio_std, audio_std, sizeof(audio_std), 0);
58 MODULE_PARM_DESC(audio_std,
59 "Audio standard. XC3028 audio decoder explicitly "
60 "needs to know what audio\n"
61 "standard is needed for some video standards with audio A2 or NICAM.\n"
62 "The valid values are:\n"
63 "A2\n"
64 "A2/A\n"
65 "A2/B\n"
66 "NICAM\n"
67 "NICAM/A\n"
68 "NICAM/B\n");
70 static char firmware_name[30];
71 module_param_string(firmware_name, firmware_name, sizeof(firmware_name), 0);
72 MODULE_PARM_DESC(firmware_name, "Firmware file name. Allows overriding the "
73 "default firmware name\n");
75 static LIST_HEAD(hybrid_tuner_instance_list);
76 static DEFINE_MUTEX(xc2028_list_mutex);
78 /* struct for storing firmware table */
79 struct firmware_description {
80 unsigned int type;
81 v4l2_std_id id;
82 __u16 int_freq;
83 unsigned char *ptr;
84 unsigned int size;
87 struct firmware_properties {
88 unsigned int type;
89 v4l2_std_id id;
90 v4l2_std_id std_req;
91 __u16 int_freq;
92 unsigned int scode_table;
93 int scode_nr;
96 enum xc2028_state {
97 XC2028_NO_FIRMWARE = 0,
98 XC2028_WAITING_FIRMWARE,
99 XC2028_ACTIVE,
100 XC2028_SLEEP,
101 XC2028_NODEV,
104 struct xc2028_data {
105 struct list_head hybrid_tuner_instance_list;
106 struct tuner_i2c_props i2c_props;
107 __u32 frequency;
109 enum xc2028_state state;
110 const char *fname;
112 struct firmware_description *firm;
113 int firm_size;
114 __u16 firm_version;
116 __u16 hwmodel;
117 __u16 hwvers;
119 struct xc2028_ctrl ctrl;
121 struct firmware_properties cur_fw;
123 struct mutex lock;
126 #define i2c_send(priv, buf, size) ({ \
127 int _rc; \
128 _rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size); \
129 if (size != _rc) \
130 tuner_info("i2c output error: rc = %d (should be %d)\n",\
131 _rc, (int)size); \
132 if (priv->ctrl.msleep) \
133 msleep(priv->ctrl.msleep); \
134 _rc; \
137 #define i2c_rcv(priv, buf, size) ({ \
138 int _rc; \
139 _rc = tuner_i2c_xfer_recv(&priv->i2c_props, buf, size); \
140 if (size != _rc) \
141 tuner_err("i2c input error: rc = %d (should be %d)\n", \
142 _rc, (int)size); \
143 _rc; \
146 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({ \
147 int _rc; \
148 _rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize, \
149 ibuf, isize); \
150 if (isize != _rc) \
151 tuner_err("i2c input error: rc = %d (should be %d)\n", \
152 _rc, (int)isize); \
153 if (priv->ctrl.msleep) \
154 msleep(priv->ctrl.msleep); \
155 _rc; \
158 #define send_seq(priv, data...) ({ \
159 static u8 _val[] = data; \
160 int _rc; \
161 if (sizeof(_val) != \
162 (_rc = tuner_i2c_xfer_send(&priv->i2c_props, \
163 _val, sizeof(_val)))) { \
164 tuner_err("Error on line %d: %d\n", __LINE__, _rc); \
165 } else if (priv->ctrl.msleep) \
166 msleep(priv->ctrl.msleep); \
167 _rc; \
170 static int xc2028_get_reg(struct xc2028_data *priv, u16 reg, u16 *val)
172 unsigned char buf[2];
173 unsigned char ibuf[2];
175 tuner_dbg("%s %04x called\n", __func__, reg);
177 buf[0] = reg >> 8;
178 buf[1] = (unsigned char) reg;
180 if (i2c_send_recv(priv, buf, 2, ibuf, 2) != 2)
181 return -EIO;
183 *val = (ibuf[1]) | (ibuf[0] << 8);
184 return 0;
187 #define dump_firm_type(t) dump_firm_type_and_int_freq(t, 0)
188 static void dump_firm_type_and_int_freq(unsigned int type, u16 int_freq)
190 if (type & BASE)
191 printk("BASE ");
192 if (type & INIT1)
193 printk("INIT1 ");
194 if (type & F8MHZ)
195 printk("F8MHZ ");
196 if (type & MTS)
197 printk("MTS ");
198 if (type & D2620)
199 printk("D2620 ");
200 if (type & D2633)
201 printk("D2633 ");
202 if (type & DTV6)
203 printk("DTV6 ");
204 if (type & QAM)
205 printk("QAM ");
206 if (type & DTV7)
207 printk("DTV7 ");
208 if (type & DTV78)
209 printk("DTV78 ");
210 if (type & DTV8)
211 printk("DTV8 ");
212 if (type & FM)
213 printk("FM ");
214 if (type & INPUT1)
215 printk("INPUT1 ");
216 if (type & LCD)
217 printk("LCD ");
218 if (type & NOGD)
219 printk("NOGD ");
220 if (type & MONO)
221 printk("MONO ");
222 if (type & ATSC)
223 printk("ATSC ");
224 if (type & IF)
225 printk("IF ");
226 if (type & LG60)
227 printk("LG60 ");
228 if (type & ATI638)
229 printk("ATI638 ");
230 if (type & OREN538)
231 printk("OREN538 ");
232 if (type & OREN36)
233 printk("OREN36 ");
234 if (type & TOYOTA388)
235 printk("TOYOTA388 ");
236 if (type & TOYOTA794)
237 printk("TOYOTA794 ");
238 if (type & DIBCOM52)
239 printk("DIBCOM52 ");
240 if (type & ZARLINK456)
241 printk("ZARLINK456 ");
242 if (type & CHINA)
243 printk("CHINA ");
244 if (type & F6MHZ)
245 printk("F6MHZ ");
246 if (type & INPUT2)
247 printk("INPUT2 ");
248 if (type & SCODE)
249 printk("SCODE ");
250 if (type & HAS_IF)
251 printk("HAS_IF_%d ", int_freq);
254 static v4l2_std_id parse_audio_std_option(void)
256 if (strcasecmp(audio_std, "A2") == 0)
257 return V4L2_STD_A2;
258 if (strcasecmp(audio_std, "A2/A") == 0)
259 return V4L2_STD_A2_A;
260 if (strcasecmp(audio_std, "A2/B") == 0)
261 return V4L2_STD_A2_B;
262 if (strcasecmp(audio_std, "NICAM") == 0)
263 return V4L2_STD_NICAM;
264 if (strcasecmp(audio_std, "NICAM/A") == 0)
265 return V4L2_STD_NICAM_A;
266 if (strcasecmp(audio_std, "NICAM/B") == 0)
267 return V4L2_STD_NICAM_B;
269 return 0;
272 static int check_device_status(struct xc2028_data *priv)
274 switch (priv->state) {
275 case XC2028_NO_FIRMWARE:
276 case XC2028_WAITING_FIRMWARE:
277 return -EAGAIN;
278 case XC2028_ACTIVE:
279 case XC2028_SLEEP:
280 return 0;
281 case XC2028_NODEV:
282 return -ENODEV;
284 return 0;
287 static void free_firmware(struct xc2028_data *priv)
289 int i;
290 tuner_dbg("%s called\n", __func__);
292 if (!priv->firm)
293 return;
295 for (i = 0; i < priv->firm_size; i++)
296 kfree(priv->firm[i].ptr);
298 kfree(priv->firm);
300 priv->firm = NULL;
301 priv->firm_size = 0;
302 priv->state = XC2028_NO_FIRMWARE;
304 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
307 static int load_all_firmwares(struct dvb_frontend *fe,
308 const struct firmware *fw)
310 struct xc2028_data *priv = fe->tuner_priv;
311 const unsigned char *p, *endp;
312 int rc = 0;
313 int n, n_array;
314 char name[33];
316 tuner_dbg("%s called\n", __func__);
318 p = fw->data;
319 endp = p + fw->size;
321 if (fw->size < sizeof(name) - 1 + 2 + 2) {
322 tuner_err("Error: firmware file %s has invalid size!\n",
323 priv->fname);
324 goto corrupt;
327 memcpy(name, p, sizeof(name) - 1);
328 name[sizeof(name) - 1] = 0;
329 p += sizeof(name) - 1;
331 priv->firm_version = get_unaligned_le16(p);
332 p += 2;
334 n_array = get_unaligned_le16(p);
335 p += 2;
337 tuner_info("Loading %d firmware images from %s, type: %s, ver %d.%d\n",
338 n_array, priv->fname, name,
339 priv->firm_version >> 8, priv->firm_version & 0xff);
341 priv->firm = kcalloc(n_array, sizeof(*priv->firm), GFP_KERNEL);
342 if (priv->firm == NULL) {
343 tuner_err("Not enough memory to load firmware file.\n");
344 rc = -ENOMEM;
345 goto err;
347 priv->firm_size = n_array;
349 n = -1;
350 while (p < endp) {
351 __u32 type, size;
352 v4l2_std_id id;
353 __u16 int_freq = 0;
355 n++;
356 if (n >= n_array) {
357 tuner_err("More firmware images in file than "
358 "were expected!\n");
359 goto corrupt;
362 /* Checks if there's enough bytes to read */
363 if (endp - p < sizeof(type) + sizeof(id) + sizeof(size))
364 goto header;
366 type = get_unaligned_le32(p);
367 p += sizeof(type);
369 id = get_unaligned_le64(p);
370 p += sizeof(id);
372 if (type & HAS_IF) {
373 int_freq = get_unaligned_le16(p);
374 p += sizeof(int_freq);
375 if (endp - p < sizeof(size))
376 goto header;
379 size = get_unaligned_le32(p);
380 p += sizeof(size);
382 if (!size || size > endp - p) {
383 tuner_err("Firmware type ");
384 dump_firm_type(type);
385 printk("(%x), id %llx is corrupted "
386 "(size=%d, expected %d)\n",
387 type, (unsigned long long)id,
388 (unsigned)(endp - p), size);
389 goto corrupt;
392 priv->firm[n].ptr = kzalloc(size, GFP_KERNEL);
393 if (priv->firm[n].ptr == NULL) {
394 tuner_err("Not enough memory to load firmware file.\n");
395 rc = -ENOMEM;
396 goto err;
398 tuner_dbg("Reading firmware type ");
399 if (debug) {
400 dump_firm_type_and_int_freq(type, int_freq);
401 printk("(%x), id %llx, size=%d.\n",
402 type, (unsigned long long)id, size);
405 memcpy(priv->firm[n].ptr, p, size);
406 priv->firm[n].type = type;
407 priv->firm[n].id = id;
408 priv->firm[n].size = size;
409 priv->firm[n].int_freq = int_freq;
411 p += size;
414 if (n + 1 != priv->firm_size) {
415 tuner_err("Firmware file is incomplete!\n");
416 goto corrupt;
419 goto done;
421 header:
422 tuner_err("Firmware header is incomplete!\n");
423 corrupt:
424 rc = -EINVAL;
425 tuner_err("Error: firmware file is corrupted!\n");
427 err:
428 tuner_info("Releasing partially loaded firmware file.\n");
429 free_firmware(priv);
431 done:
432 if (rc == 0)
433 tuner_dbg("Firmware files loaded.\n");
434 else
435 priv->state = XC2028_NODEV;
437 return rc;
440 static int seek_firmware(struct dvb_frontend *fe, unsigned int type,
441 v4l2_std_id *id)
443 struct xc2028_data *priv = fe->tuner_priv;
444 int i, best_i = -1, best_nr_matches = 0;
445 unsigned int type_mask = 0;
447 tuner_dbg("%s called, want type=", __func__);
448 if (debug) {
449 dump_firm_type(type);
450 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
453 if (!priv->firm) {
454 tuner_err("Error! firmware not loaded\n");
455 return -EINVAL;
458 if (((type & ~SCODE) == 0) && (*id == 0))
459 *id = V4L2_STD_PAL;
461 if (type & BASE)
462 type_mask = BASE_TYPES;
463 else if (type & SCODE) {
464 type &= SCODE_TYPES;
465 type_mask = SCODE_TYPES & ~HAS_IF;
466 } else if (type & DTV_TYPES)
467 type_mask = DTV_TYPES;
468 else if (type & STD_SPECIFIC_TYPES)
469 type_mask = STD_SPECIFIC_TYPES;
471 type &= type_mask;
473 if (!(type & SCODE))
474 type_mask = ~0;
476 /* Seek for exact match */
477 for (i = 0; i < priv->firm_size; i++) {
478 if ((type == (priv->firm[i].type & type_mask)) &&
479 (*id == priv->firm[i].id))
480 goto found;
483 /* Seek for generic video standard match */
484 for (i = 0; i < priv->firm_size; i++) {
485 v4l2_std_id match_mask;
486 int nr_matches;
488 if (type != (priv->firm[i].type & type_mask))
489 continue;
491 match_mask = *id & priv->firm[i].id;
492 if (!match_mask)
493 continue;
495 if ((*id & match_mask) == *id)
496 goto found; /* Supports all the requested standards */
498 nr_matches = hweight64(match_mask);
499 if (nr_matches > best_nr_matches) {
500 best_nr_matches = nr_matches;
501 best_i = i;
505 if (best_nr_matches > 0) {
506 tuner_dbg("Selecting best matching firmware (%d bits) for "
507 "type=", best_nr_matches);
508 dump_firm_type(type);
509 printk("(%x), id %016llx:\n", type, (unsigned long long)*id);
510 i = best_i;
511 goto found;
514 /*FIXME: Would make sense to seek for type "hint" match ? */
516 i = -ENOENT;
517 goto ret;
519 found:
520 *id = priv->firm[i].id;
522 ret:
523 tuner_dbg("%s firmware for type=", (i < 0) ? "Can't find" : "Found");
524 if (debug) {
525 dump_firm_type(type);
526 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
528 return i;
531 static inline int do_tuner_callback(struct dvb_frontend *fe, int cmd, int arg)
533 struct xc2028_data *priv = fe->tuner_priv;
535 /* analog side (tuner-core) uses i2c_adap->algo_data.
536 * digital side is not guaranteed to have algo_data defined.
538 * digital side will always have fe->dvb defined.
539 * analog side (tuner-core) doesn't (yet) define fe->dvb.
542 return (!fe->callback) ? -EINVAL :
543 fe->callback(((fe->dvb) && (fe->dvb->priv)) ?
544 fe->dvb->priv : priv->i2c_props.adap->algo_data,
545 DVB_FRONTEND_COMPONENT_TUNER, cmd, arg);
548 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
549 v4l2_std_id *id)
551 struct xc2028_data *priv = fe->tuner_priv;
552 int pos, rc;
553 unsigned char *p, *endp, buf[MAX_XFER_SIZE];
555 if (priv->ctrl.max_len > sizeof(buf))
556 priv->ctrl.max_len = sizeof(buf);
558 tuner_dbg("%s called\n", __func__);
560 pos = seek_firmware(fe, type, id);
561 if (pos < 0)
562 return pos;
564 tuner_info("Loading firmware for type=");
565 dump_firm_type(priv->firm[pos].type);
566 printk("(%x), id %016llx.\n", priv->firm[pos].type,
567 (unsigned long long)*id);
569 p = priv->firm[pos].ptr;
570 endp = p + priv->firm[pos].size;
572 while (p < endp) {
573 __u16 size;
575 /* Checks if there's enough bytes to read */
576 if (p + sizeof(size) > endp) {
577 tuner_err("Firmware chunk size is wrong\n");
578 return -EINVAL;
581 size = le16_to_cpu(*(__u16 *) p);
582 p += sizeof(size);
584 if (size == 0xffff)
585 return 0;
587 if (!size) {
588 /* Special callback command received */
589 rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
590 if (rc < 0) {
591 tuner_err("Error at RESET code %d\n",
592 (*p) & 0x7f);
593 return -EINVAL;
595 continue;
597 if (size >= 0xff00) {
598 switch (size) {
599 case 0xff00:
600 rc = do_tuner_callback(fe, XC2028_RESET_CLK, 0);
601 if (rc < 0) {
602 tuner_err("Error at RESET code %d\n",
603 (*p) & 0x7f);
604 return -EINVAL;
606 break;
607 default:
608 tuner_info("Invalid RESET code %d\n",
609 size & 0x7f);
610 return -EINVAL;
613 continue;
616 /* Checks for a sleep command */
617 if (size & 0x8000) {
618 msleep(size & 0x7fff);
619 continue;
622 if ((size + p > endp)) {
623 tuner_err("missing bytes: need %d, have %d\n",
624 size, (int)(endp - p));
625 return -EINVAL;
628 buf[0] = *p;
629 p++;
630 size--;
632 /* Sends message chunks */
633 while (size > 0) {
634 int len = (size < priv->ctrl.max_len - 1) ?
635 size : priv->ctrl.max_len - 1;
637 memcpy(buf + 1, p, len);
639 rc = i2c_send(priv, buf, len + 1);
640 if (rc < 0) {
641 tuner_err("%d returned from send\n", rc);
642 return -EINVAL;
645 p += len;
646 size -= len;
649 /* silently fail if the frontend doesn't support I2C flush */
650 rc = do_tuner_callback(fe, XC2028_I2C_FLUSH, 0);
651 if ((rc < 0) && (rc != -EINVAL)) {
652 tuner_err("error executing flush: %d\n", rc);
653 return rc;
656 return 0;
659 static int load_scode(struct dvb_frontend *fe, unsigned int type,
660 v4l2_std_id *id, __u16 int_freq, int scode)
662 struct xc2028_data *priv = fe->tuner_priv;
663 int pos, rc;
664 unsigned char *p;
666 tuner_dbg("%s called\n", __func__);
668 if (!int_freq) {
669 pos = seek_firmware(fe, type, id);
670 if (pos < 0)
671 return pos;
672 } else {
673 for (pos = 0; pos < priv->firm_size; pos++) {
674 if ((priv->firm[pos].int_freq == int_freq) &&
675 (priv->firm[pos].type & HAS_IF))
676 break;
678 if (pos == priv->firm_size)
679 return -ENOENT;
682 p = priv->firm[pos].ptr;
684 if (priv->firm[pos].type & HAS_IF) {
685 if (priv->firm[pos].size != 12 * 16 || scode >= 16)
686 return -EINVAL;
687 p += 12 * scode;
688 } else {
689 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
690 * has a 2-byte size header in the firmware format. */
691 if (priv->firm[pos].size != 14 * 16 || scode >= 16 ||
692 le16_to_cpu(*(__u16 *)(p + 14 * scode)) != 12)
693 return -EINVAL;
694 p += 14 * scode + 2;
697 tuner_info("Loading SCODE for type=");
698 dump_firm_type_and_int_freq(priv->firm[pos].type,
699 priv->firm[pos].int_freq);
700 printk("(%x), id %016llx.\n", priv->firm[pos].type,
701 (unsigned long long)*id);
703 if (priv->firm_version < 0x0202)
704 rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
705 else
706 rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
707 if (rc < 0)
708 return -EIO;
710 rc = i2c_send(priv, p, 12);
711 if (rc < 0)
712 return -EIO;
714 rc = send_seq(priv, {0x00, 0x8c});
715 if (rc < 0)
716 return -EIO;
718 return 0;
721 static int check_firmware(struct dvb_frontend *fe, unsigned int type,
722 v4l2_std_id std, __u16 int_freq)
724 struct xc2028_data *priv = fe->tuner_priv;
725 struct firmware_properties new_fw;
726 int rc, retry_count = 0;
727 u16 version, hwmodel;
728 v4l2_std_id std0;
730 tuner_dbg("%s called\n", __func__);
732 rc = check_device_status(priv);
733 if (rc < 0)
734 return rc;
736 if (priv->ctrl.mts && !(type & FM))
737 type |= MTS;
739 retry:
740 new_fw.type = type;
741 new_fw.id = std;
742 new_fw.std_req = std;
743 new_fw.scode_table = SCODE | priv->ctrl.scode_table;
744 new_fw.scode_nr = 0;
745 new_fw.int_freq = int_freq;
747 tuner_dbg("checking firmware, user requested type=");
748 if (debug) {
749 dump_firm_type(new_fw.type);
750 printk("(%x), id %016llx, ", new_fw.type,
751 (unsigned long long)new_fw.std_req);
752 if (!int_freq) {
753 printk("scode_tbl ");
754 dump_firm_type(priv->ctrl.scode_table);
755 printk("(%x), ", priv->ctrl.scode_table);
756 } else
757 printk("int_freq %d, ", new_fw.int_freq);
758 printk("scode_nr %d\n", new_fw.scode_nr);
762 * No need to reload base firmware if it matches and if the tuner
763 * is not at sleep mode
765 if ((priv->state == XC2028_ACTIVE) &&
766 (((BASE | new_fw.type) & BASE_TYPES) ==
767 (priv->cur_fw.type & BASE_TYPES))) {
768 tuner_dbg("BASE firmware not changed.\n");
769 goto skip_base;
772 /* Updating BASE - forget about all currently loaded firmware */
773 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
775 /* Reset is needed before loading firmware */
776 rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
777 if (rc < 0)
778 goto fail;
780 /* BASE firmwares are all std0 */
781 std0 = 0;
782 rc = load_firmware(fe, BASE | new_fw.type, &std0);
783 if (rc < 0) {
784 tuner_err("Error %d while loading base firmware\n",
785 rc);
786 goto fail;
789 /* Load INIT1, if needed */
790 tuner_dbg("Load init1 firmware, if exists\n");
792 rc = load_firmware(fe, BASE | INIT1 | new_fw.type, &std0);
793 if (rc == -ENOENT)
794 rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
795 &std0);
796 if (rc < 0 && rc != -ENOENT) {
797 tuner_err("Error %d while loading init1 firmware\n",
798 rc);
799 goto fail;
802 skip_base:
804 * No need to reload standard specific firmware if base firmware
805 * was not reloaded and requested video standards have not changed.
807 if (priv->cur_fw.type == (BASE | new_fw.type) &&
808 priv->cur_fw.std_req == std) {
809 tuner_dbg("Std-specific firmware already loaded.\n");
810 goto skip_std_specific;
813 /* Reloading std-specific firmware forces a SCODE update */
814 priv->cur_fw.scode_table = 0;
816 rc = load_firmware(fe, new_fw.type, &new_fw.id);
817 if (rc == -ENOENT)
818 rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
820 if (rc < 0)
821 goto fail;
823 skip_std_specific:
824 if (priv->cur_fw.scode_table == new_fw.scode_table &&
825 priv->cur_fw.scode_nr == new_fw.scode_nr) {
826 tuner_dbg("SCODE firmware already loaded.\n");
827 goto check_device;
830 if (new_fw.type & FM)
831 goto check_device;
833 /* Load SCODE firmware, if exists */
834 tuner_dbg("Trying to load scode %d\n", new_fw.scode_nr);
836 rc = load_scode(fe, new_fw.type | new_fw.scode_table, &new_fw.id,
837 new_fw.int_freq, new_fw.scode_nr);
839 check_device:
840 if (xc2028_get_reg(priv, 0x0004, &version) < 0 ||
841 xc2028_get_reg(priv, 0x0008, &hwmodel) < 0) {
842 tuner_err("Unable to read tuner registers.\n");
843 goto fail;
846 tuner_dbg("Device is Xceive %d version %d.%d, "
847 "firmware version %d.%d\n",
848 hwmodel, (version & 0xf000) >> 12, (version & 0xf00) >> 8,
849 (version & 0xf0) >> 4, version & 0xf);
852 if (priv->ctrl.read_not_reliable)
853 goto read_not_reliable;
855 /* Check firmware version against what we downloaded. */
856 if (priv->firm_version != ((version & 0xf0) << 4 | (version & 0x0f))) {
857 if (!priv->ctrl.read_not_reliable) {
858 tuner_err("Incorrect readback of firmware version.\n");
859 goto fail;
860 } else {
861 tuner_err("Returned an incorrect version. However, "
862 "read is not reliable enough. Ignoring it.\n");
863 hwmodel = 3028;
867 /* Check that the tuner hardware model remains consistent over time. */
868 if (priv->hwmodel == 0 && (hwmodel == 2028 || hwmodel == 3028)) {
869 priv->hwmodel = hwmodel;
870 priv->hwvers = version & 0xff00;
871 } else if (priv->hwmodel == 0 || priv->hwmodel != hwmodel ||
872 priv->hwvers != (version & 0xff00)) {
873 tuner_err("Read invalid device hardware information - tuner "
874 "hung?\n");
875 goto fail;
878 read_not_reliable:
879 priv->cur_fw = new_fw;
882 * By setting BASE in cur_fw.type only after successfully loading all
883 * firmwares, we can:
884 * 1. Identify that BASE firmware with type=0 has been loaded;
885 * 2. Tell whether BASE firmware was just changed the next time through.
887 priv->cur_fw.type |= BASE;
888 priv->state = XC2028_ACTIVE;
890 return 0;
892 fail:
893 priv->state = XC2028_SLEEP;
895 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
896 if (retry_count < 8) {
897 msleep(50);
898 retry_count++;
899 tuner_dbg("Retrying firmware load\n");
900 goto retry;
903 if (rc == -ENOENT)
904 rc = -EINVAL;
905 return rc;
908 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
910 struct xc2028_data *priv = fe->tuner_priv;
911 u16 frq_lock, signal = 0;
912 int rc, i;
914 tuner_dbg("%s called\n", __func__);
916 rc = check_device_status(priv);
917 if (rc < 0)
918 return rc;
920 mutex_lock(&priv->lock);
922 /* Sync Lock Indicator */
923 for (i = 0; i < 3; i++) {
924 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
925 if (rc < 0)
926 goto ret;
928 if (frq_lock)
929 break;
930 msleep(6);
933 /* Frequency didn't lock */
934 if (frq_lock == 2)
935 goto ret;
937 /* Get SNR of the video signal */
938 rc = xc2028_get_reg(priv, XREG_SNR, &signal);
939 if (rc < 0)
940 goto ret;
942 /* Signal level is 3 bits only */
944 signal = ((1 << 12) - 1) | ((signal & 0x07) << 12);
946 ret:
947 mutex_unlock(&priv->lock);
949 *strength = signal;
951 tuner_dbg("signal strength is %d\n", signal);
953 return rc;
956 static int xc2028_get_afc(struct dvb_frontend *fe, s32 *afc)
958 struct xc2028_data *priv = fe->tuner_priv;
959 int i, rc;
960 u16 frq_lock = 0;
961 s16 afc_reg = 0;
963 rc = check_device_status(priv);
964 if (rc < 0)
965 return rc;
967 mutex_lock(&priv->lock);
969 /* Sync Lock Indicator */
970 for (i = 0; i < 3; i++) {
971 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
972 if (rc < 0)
973 goto ret;
975 if (frq_lock)
976 break;
977 msleep(6);
980 /* Frequency didn't lock */
981 if (frq_lock == 2)
982 goto ret;
984 /* Get AFC */
985 rc = xc2028_get_reg(priv, XREG_FREQ_ERROR, &afc_reg);
986 if (rc < 0)
987 goto ret;
989 *afc = afc_reg * 15625; /* Hz */
991 tuner_dbg("AFC is %d Hz\n", *afc);
993 ret:
994 mutex_unlock(&priv->lock);
996 return rc;
999 #define DIV 15625
1001 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
1002 enum v4l2_tuner_type new_type,
1003 unsigned int type,
1004 v4l2_std_id std,
1005 u16 int_freq)
1007 struct xc2028_data *priv = fe->tuner_priv;
1008 int rc = -EINVAL;
1009 unsigned char buf[4];
1010 u32 div, offset = 0;
1012 tuner_dbg("%s called\n", __func__);
1014 mutex_lock(&priv->lock);
1016 tuner_dbg("should set frequency %d kHz\n", freq / 1000);
1018 if (check_firmware(fe, type, std, int_freq) < 0)
1019 goto ret;
1021 /* On some cases xc2028 can disable video output, if
1022 * very weak signals are received. By sending a soft
1023 * reset, this is re-enabled. So, it is better to always
1024 * send a soft reset before changing channels, to be sure
1025 * that xc2028 will be in a safe state.
1026 * Maybe this might also be needed for DTV.
1028 switch (new_type) {
1029 case V4L2_TUNER_ANALOG_TV:
1030 rc = send_seq(priv, {0x00, 0x00});
1032 /* Analog mode requires offset = 0 */
1033 break;
1034 case V4L2_TUNER_RADIO:
1035 /* Radio mode requires offset = 0 */
1036 break;
1037 case V4L2_TUNER_DIGITAL_TV:
1039 * Digital modes require an offset to adjust to the
1040 * proper frequency. The offset depends on what
1041 * firmware version is used.
1045 * Adjust to the center frequency. This is calculated by the
1046 * formula: offset = 1.25MHz - BW/2
1047 * For DTV 7/8, the firmware uses BW = 8000, so it needs a
1048 * further adjustment to get the frequency center on VHF
1052 * The firmware DTV78 used to work fine in UHF band (8 MHz
1053 * bandwidth) but not at all in VHF band (7 MHz bandwidth).
1054 * The real problem was connected to the formula used to
1055 * calculate the center frequency offset in VHF band.
1056 * In fact, removing the 500KHz adjustment fixed the problem.
1057 * This is coherent to what was implemented for the DTV7
1058 * firmware.
1059 * In the end, now the center frequency is the same for all 3
1060 * firmwares (DTV7, DTV8, DTV78) and doesn't depend on channel
1061 * bandwidth.
1064 if (priv->cur_fw.type & DTV6)
1065 offset = 1750000;
1066 else /* DTV7 or DTV8 or DTV78 */
1067 offset = 2750000;
1070 * xc3028 additional "magic"
1071 * Depending on the firmware version, it needs some adjustments
1072 * to properly centralize the frequency. This seems to be
1073 * needed to compensate the SCODE table adjustments made by
1074 * newer firmwares
1078 * The proper adjustment would be to do it at s-code table.
1079 * However, this didn't work, as reported by
1080 * Robert Lowery <rglowery@exemail.com.au>
1083 #if 0
1085 * Still need tests for XC3028L (firmware 3.2 or upper)
1086 * So, for now, let's just comment the per-firmware
1087 * version of this change. Reports with xc3028l working
1088 * with and without the lines bellow are welcome
1091 if (priv->firm_version < 0x0302) {
1092 if (priv->cur_fw.type & DTV7)
1093 offset += 500000;
1094 } else {
1095 if (priv->cur_fw.type & DTV7)
1096 offset -= 300000;
1097 else if (type != ATSC) /* DVB @6MHz, DTV 8 and DTV 7/8 */
1098 offset += 200000;
1100 #endif
1103 div = (freq - offset + DIV / 2) / DIV;
1105 /* CMD= Set frequency */
1106 if (priv->firm_version < 0x0202)
1107 rc = send_seq(priv, {0x00, XREG_RF_FREQ, 0x00, 0x00});
1108 else
1109 rc = send_seq(priv, {0x80, XREG_RF_FREQ, 0x00, 0x00});
1110 if (rc < 0)
1111 goto ret;
1113 /* Return code shouldn't be checked.
1114 The reset CLK is needed only with tm6000.
1115 Driver should work fine even if this fails.
1117 if (priv->ctrl.msleep)
1118 msleep(priv->ctrl.msleep);
1119 do_tuner_callback(fe, XC2028_RESET_CLK, 1);
1121 msleep(10);
1123 buf[0] = 0xff & (div >> 24);
1124 buf[1] = 0xff & (div >> 16);
1125 buf[2] = 0xff & (div >> 8);
1126 buf[3] = 0xff & (div);
1128 rc = i2c_send(priv, buf, sizeof(buf));
1129 if (rc < 0)
1130 goto ret;
1131 msleep(100);
1133 priv->frequency = freq;
1135 tuner_dbg("divisor= %*ph (freq=%d.%03d)\n", 4, buf,
1136 freq / 1000000, (freq % 1000000) / 1000);
1138 rc = 0;
1140 ret:
1141 mutex_unlock(&priv->lock);
1143 return rc;
1146 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
1147 struct analog_parameters *p)
1149 struct xc2028_data *priv = fe->tuner_priv;
1150 unsigned int type=0;
1152 tuner_dbg("%s called\n", __func__);
1154 if (p->mode == V4L2_TUNER_RADIO) {
1155 type |= FM;
1156 if (priv->ctrl.input1)
1157 type |= INPUT1;
1158 return generic_set_freq(fe, (625l * p->frequency) / 10,
1159 V4L2_TUNER_RADIO, type, 0, 0);
1162 /* if std is not defined, choose one */
1163 if (!p->std)
1164 p->std = V4L2_STD_MN;
1166 /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
1167 if (!(p->std & V4L2_STD_MN))
1168 type |= F8MHZ;
1170 /* Add audio hack to std mask */
1171 p->std |= parse_audio_std_option();
1173 return generic_set_freq(fe, 62500l * p->frequency,
1174 V4L2_TUNER_ANALOG_TV, type, p->std, 0);
1177 static int xc2028_set_params(struct dvb_frontend *fe)
1179 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
1180 u32 delsys = c->delivery_system;
1181 u32 bw = c->bandwidth_hz;
1182 struct xc2028_data *priv = fe->tuner_priv;
1183 int rc;
1184 unsigned int type = 0;
1185 u16 demod = 0;
1187 tuner_dbg("%s called\n", __func__);
1189 rc = check_device_status(priv);
1190 if (rc < 0)
1191 return rc;
1193 switch (delsys) {
1194 case SYS_DVBT:
1195 case SYS_DVBT2:
1197 * The only countries with 6MHz seem to be Taiwan/Uruguay.
1198 * Both seem to require QAM firmware for OFDM decoding
1199 * Tested in Taiwan by Terry Wu <terrywu2009@gmail.com>
1201 if (bw <= 6000000)
1202 type |= QAM;
1204 switch (priv->ctrl.type) {
1205 case XC2028_D2633:
1206 type |= D2633;
1207 break;
1208 case XC2028_D2620:
1209 type |= D2620;
1210 break;
1211 case XC2028_AUTO:
1212 default:
1213 /* Zarlink seems to need D2633 */
1214 if (priv->ctrl.demod == XC3028_FE_ZARLINK456)
1215 type |= D2633;
1216 else
1217 type |= D2620;
1219 break;
1220 case SYS_ATSC:
1221 /* The only ATSC firmware (at least on v2.7) is D2633 */
1222 type |= ATSC | D2633;
1223 break;
1224 /* DVB-S and pure QAM (FE_QAM) are not supported */
1225 default:
1226 return -EINVAL;
1229 if (bw <= 6000000) {
1230 type |= DTV6;
1231 priv->ctrl.vhfbw7 = 0;
1232 priv->ctrl.uhfbw8 = 0;
1233 } else if (bw <= 7000000) {
1234 if (c->frequency < 470000000)
1235 priv->ctrl.vhfbw7 = 1;
1236 else
1237 priv->ctrl.uhfbw8 = 0;
1238 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV7;
1239 type |= F8MHZ;
1240 } else {
1241 if (c->frequency < 470000000)
1242 priv->ctrl.vhfbw7 = 0;
1243 else
1244 priv->ctrl.uhfbw8 = 1;
1245 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV8;
1246 type |= F8MHZ;
1249 /* All S-code tables need a 200kHz shift */
1250 if (priv->ctrl.demod) {
1251 demod = priv->ctrl.demod;
1254 * Newer firmwares require a 200 kHz offset only for ATSC
1256 if (type == ATSC || priv->firm_version < 0x0302)
1257 demod += 200;
1259 * The DTV7 S-code table needs a 700 kHz shift.
1261 * DTV7 is only used in Australia. Germany or Italy may also
1262 * use this firmware after initialization, but a tune to a UHF
1263 * channel should then cause DTV78 to be used.
1265 * Unfortunately, on real-field tests, the s-code offset
1266 * didn't work as expected, as reported by
1267 * Robert Lowery <rglowery@exemail.com.au>
1271 return generic_set_freq(fe, c->frequency,
1272 V4L2_TUNER_DIGITAL_TV, type, 0, demod);
1275 static int xc2028_sleep(struct dvb_frontend *fe)
1277 struct xc2028_data *priv = fe->tuner_priv;
1278 int rc;
1280 rc = check_device_status(priv);
1281 if (rc < 0)
1282 return rc;
1284 /* Avoid firmware reload on slow devices or if PM disabled */
1285 if (no_poweroff || priv->ctrl.disable_power_mgmt)
1286 return 0;
1288 tuner_dbg("Putting xc2028/3028 into poweroff mode.\n");
1289 if (debug > 1) {
1290 tuner_dbg("Printing sleep stack trace:\n");
1291 dump_stack();
1294 mutex_lock(&priv->lock);
1296 if (priv->firm_version < 0x0202)
1297 rc = send_seq(priv, {0x00, XREG_POWER_DOWN, 0x00, 0x00});
1298 else
1299 rc = send_seq(priv, {0x80, XREG_POWER_DOWN, 0x00, 0x00});
1301 priv->state = XC2028_SLEEP;
1303 mutex_unlock(&priv->lock);
1305 return rc;
1308 static int xc2028_dvb_release(struct dvb_frontend *fe)
1310 struct xc2028_data *priv = fe->tuner_priv;
1312 tuner_dbg("%s called\n", __func__);
1314 mutex_lock(&xc2028_list_mutex);
1316 /* only perform final cleanup if this is the last instance */
1317 if (hybrid_tuner_report_instance_count(priv) == 1) {
1318 free_firmware(priv);
1319 kfree(priv->ctrl.fname);
1320 priv->ctrl.fname = NULL;
1323 if (priv)
1324 hybrid_tuner_release_state(priv);
1326 mutex_unlock(&xc2028_list_mutex);
1328 fe->tuner_priv = NULL;
1330 return 0;
1333 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1335 struct xc2028_data *priv = fe->tuner_priv;
1336 int rc;
1338 tuner_dbg("%s called\n", __func__);
1340 rc = check_device_status(priv);
1341 if (rc < 0)
1342 return rc;
1344 *frequency = priv->frequency;
1346 return 0;
1349 static void load_firmware_cb(const struct firmware *fw,
1350 void *context)
1352 struct dvb_frontend *fe = context;
1353 struct xc2028_data *priv = fe->tuner_priv;
1354 int rc;
1356 tuner_dbg("request_firmware_nowait(): %s\n", fw ? "OK" : "error");
1357 if (!fw) {
1358 tuner_err("Could not load firmware %s.\n", priv->fname);
1359 priv->state = XC2028_NODEV;
1360 return;
1363 rc = load_all_firmwares(fe, fw);
1365 release_firmware(fw);
1367 if (rc < 0)
1368 return;
1369 priv->state = XC2028_SLEEP;
1372 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1374 struct xc2028_data *priv = fe->tuner_priv;
1375 struct xc2028_ctrl *p = priv_cfg;
1376 int rc = 0;
1378 tuner_dbg("%s called\n", __func__);
1380 mutex_lock(&priv->lock);
1383 * Copy the config data.
1384 * For the firmware name, keep a local copy of the string,
1385 * in order to avoid troubles during device release.
1387 kfree(priv->ctrl.fname);
1388 memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1389 if (p->fname) {
1390 priv->ctrl.fname = kstrdup(p->fname, GFP_KERNEL);
1391 if (priv->ctrl.fname == NULL)
1392 rc = -ENOMEM;
1396 * If firmware name changed, frees firmware. As free_firmware will
1397 * reset the status to NO_FIRMWARE, this forces a new request_firmware
1399 if (!firmware_name[0] && p->fname &&
1400 priv->fname && strcmp(p->fname, priv->fname))
1401 free_firmware(priv);
1403 if (priv->ctrl.max_len < 9)
1404 priv->ctrl.max_len = 13;
1406 if (priv->state == XC2028_NO_FIRMWARE) {
1407 if (!firmware_name[0])
1408 priv->fname = priv->ctrl.fname;
1409 else
1410 priv->fname = firmware_name;
1412 rc = request_firmware_nowait(THIS_MODULE, 1,
1413 priv->fname,
1414 priv->i2c_props.adap->dev.parent,
1415 GFP_KERNEL,
1416 fe, load_firmware_cb);
1417 if (rc < 0) {
1418 tuner_err("Failed to request firmware %s\n",
1419 priv->fname);
1420 priv->state = XC2028_NODEV;
1421 } else
1422 priv->state = XC2028_WAITING_FIRMWARE;
1424 mutex_unlock(&priv->lock);
1426 return rc;
1429 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1430 .info = {
1431 .name = "Xceive XC3028",
1432 .frequency_min = 42000000,
1433 .frequency_max = 864000000,
1434 .frequency_step = 50000,
1437 .set_config = xc2028_set_config,
1438 .set_analog_params = xc2028_set_analog_freq,
1439 .release = xc2028_dvb_release,
1440 .get_frequency = xc2028_get_frequency,
1441 .get_rf_strength = xc2028_signal,
1442 .get_afc = xc2028_get_afc,
1443 .set_params = xc2028_set_params,
1444 .sleep = xc2028_sleep,
1447 struct dvb_frontend *xc2028_attach(struct dvb_frontend *fe,
1448 struct xc2028_config *cfg)
1450 struct xc2028_data *priv;
1451 int instance;
1453 if (debug)
1454 printk(KERN_DEBUG "xc2028: Xcv2028/3028 init called!\n");
1456 if (NULL == cfg)
1457 return NULL;
1459 if (!fe) {
1460 printk(KERN_ERR "xc2028: No frontend!\n");
1461 return NULL;
1464 mutex_lock(&xc2028_list_mutex);
1466 instance = hybrid_tuner_request_state(struct xc2028_data, priv,
1467 hybrid_tuner_instance_list,
1468 cfg->i2c_adap, cfg->i2c_addr,
1469 "xc2028");
1470 switch (instance) {
1471 case 0:
1472 /* memory allocation failure */
1473 goto fail;
1474 break;
1475 case 1:
1476 /* new tuner instance */
1477 priv->ctrl.max_len = 13;
1479 mutex_init(&priv->lock);
1481 fe->tuner_priv = priv;
1482 break;
1483 case 2:
1484 /* existing tuner instance */
1485 fe->tuner_priv = priv;
1486 break;
1489 memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1490 sizeof(xc2028_dvb_tuner_ops));
1492 tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1494 if (cfg->ctrl)
1495 xc2028_set_config(fe, cfg->ctrl);
1497 mutex_unlock(&xc2028_list_mutex);
1499 return fe;
1500 fail:
1501 mutex_unlock(&xc2028_list_mutex);
1503 xc2028_dvb_release(fe);
1504 return NULL;
1507 EXPORT_SYMBOL(xc2028_attach);
1509 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1510 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1511 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
1512 MODULE_LICENSE("GPL");
1513 MODULE_FIRMWARE(XC2028_DEFAULT_FIRMWARE);
1514 MODULE_FIRMWARE(XC3028L_DEFAULT_FIRMWARE);