Linux 4.16.11
[linux/fpc-iii.git] / drivers / media / tuners / tuner-xc2028.c
blobfca85e08ebd7f35ea14e51bc02bdaffbb49e9da1
1 // SPDX-License-Identifier: GPL-2.0
2 // tuner-xc2028
3 //
4 // Copyright (c) 2007-2008 Mauro Carvalho Chehab (mchehab@infradead.org)
5 //
6 // Copyright (c) 2007 Michel Ludwig (michel.ludwig@gmail.com)
7 // - frontend interface
9 #include <linux/i2c.h>
10 #include <asm/div64.h>
11 #include <linux/firmware.h>
12 #include <linux/videodev2.h>
13 #include <linux/delay.h>
14 #include <media/tuner.h>
15 #include <linux/mutex.h>
16 #include <linux/slab.h>
17 #include <asm/unaligned.h>
18 #include "tuner-i2c.h"
19 #include "tuner-xc2028.h"
20 #include "tuner-xc2028-types.h"
22 #include <linux/dvb/frontend.h>
23 #include <media/dvb_frontend.h>
25 /* Max transfer size done by I2C transfer functions */
26 #define MAX_XFER_SIZE 80
28 /* Registers (Write-only) */
29 #define XREG_INIT 0x00
30 #define XREG_RF_FREQ 0x02
31 #define XREG_POWER_DOWN 0x08
33 /* Registers (Read-only) */
34 #define XREG_FREQ_ERROR 0x01
35 #define XREG_LOCK 0x02
36 #define XREG_VERSION 0x04
37 #define XREG_PRODUCT_ID 0x08
38 #define XREG_HSYNC_FREQ 0x10
39 #define XREG_FRAME_LINES 0x20
40 #define XREG_SNR 0x40
42 #define XREG_ADC_ENV 0x0100
44 static int debug;
45 module_param(debug, int, 0644);
46 MODULE_PARM_DESC(debug, "enable verbose debug messages");
48 static int no_poweroff;
49 module_param(no_poweroff, int, 0644);
50 MODULE_PARM_DESC(no_poweroff, "0 (default) powers device off when not used.\n"
51 "1 keep device energized and with tuner ready all the times.\n"
52 " Faster, but consumes more power and keeps the device hotter\n");
54 static char audio_std[8];
55 module_param_string(audio_std, audio_std, sizeof(audio_std), 0);
56 MODULE_PARM_DESC(audio_std,
57 "Audio standard. XC3028 audio decoder explicitly needs to know what audio\n"
58 "standard is needed for some video standards with audio A2 or NICAM.\n"
59 "The valid values are:\n"
60 "A2\n"
61 "A2/A\n"
62 "A2/B\n"
63 "NICAM\n"
64 "NICAM/A\n"
65 "NICAM/B\n");
67 static char firmware_name[30];
68 module_param_string(firmware_name, firmware_name, sizeof(firmware_name), 0);
69 MODULE_PARM_DESC(firmware_name,
70 "Firmware file name. Allows overriding the default firmware name\n");
72 static LIST_HEAD(hybrid_tuner_instance_list);
73 static DEFINE_MUTEX(xc2028_list_mutex);
75 /* struct for storing firmware table */
76 struct firmware_description {
77 unsigned int type;
78 v4l2_std_id id;
79 __u16 int_freq;
80 unsigned char *ptr;
81 unsigned int size;
84 struct firmware_properties {
85 unsigned int type;
86 v4l2_std_id id;
87 v4l2_std_id std_req;
88 __u16 int_freq;
89 unsigned int scode_table;
90 int scode_nr;
93 enum xc2028_state {
94 XC2028_NO_FIRMWARE = 0,
95 XC2028_WAITING_FIRMWARE,
96 XC2028_ACTIVE,
97 XC2028_SLEEP,
98 XC2028_NODEV,
101 struct xc2028_data {
102 struct list_head hybrid_tuner_instance_list;
103 struct tuner_i2c_props i2c_props;
104 __u32 frequency;
106 enum xc2028_state state;
107 const char *fname;
109 struct firmware_description *firm;
110 int firm_size;
111 __u16 firm_version;
113 __u16 hwmodel;
114 __u16 hwvers;
116 struct xc2028_ctrl ctrl;
118 struct firmware_properties cur_fw;
120 struct mutex lock;
123 #define i2c_send(priv, buf, size) ({ \
124 int _rc; \
125 _rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size); \
126 if (size != _rc) \
127 tuner_info("i2c output error: rc = %d (should be %d)\n",\
128 _rc, (int)size); \
129 if (priv->ctrl.msleep) \
130 msleep(priv->ctrl.msleep); \
131 _rc; \
134 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({ \
135 int _rc; \
136 _rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize, \
137 ibuf, isize); \
138 if (isize != _rc) \
139 tuner_err("i2c input error: rc = %d (should be %d)\n", \
140 _rc, (int)isize); \
141 if (priv->ctrl.msleep) \
142 msleep(priv->ctrl.msleep); \
143 _rc; \
146 #define send_seq(priv, data...) ({ \
147 static u8 _val[] = data; \
148 int _rc; \
149 if (sizeof(_val) != \
150 (_rc = tuner_i2c_xfer_send(&priv->i2c_props, \
151 _val, sizeof(_val)))) { \
152 tuner_err("Error on line %d: %d\n", __LINE__, _rc); \
153 } else if (priv->ctrl.msleep) \
154 msleep(priv->ctrl.msleep); \
155 _rc; \
158 static int xc2028_get_reg(struct xc2028_data *priv, u16 reg, u16 *val)
160 unsigned char buf[2];
161 unsigned char ibuf[2];
163 tuner_dbg("%s %04x called\n", __func__, reg);
165 buf[0] = reg >> 8;
166 buf[1] = (unsigned char) reg;
168 if (i2c_send_recv(priv, buf, 2, ibuf, 2) != 2)
169 return -EIO;
171 *val = (ibuf[1]) | (ibuf[0] << 8);
172 return 0;
175 #define dump_firm_type(t) dump_firm_type_and_int_freq(t, 0)
176 static void dump_firm_type_and_int_freq(unsigned int type, u16 int_freq)
178 if (type & BASE)
179 printk(KERN_CONT "BASE ");
180 if (type & INIT1)
181 printk(KERN_CONT "INIT1 ");
182 if (type & F8MHZ)
183 printk(KERN_CONT "F8MHZ ");
184 if (type & MTS)
185 printk(KERN_CONT "MTS ");
186 if (type & D2620)
187 printk(KERN_CONT "D2620 ");
188 if (type & D2633)
189 printk(KERN_CONT "D2633 ");
190 if (type & DTV6)
191 printk(KERN_CONT "DTV6 ");
192 if (type & QAM)
193 printk(KERN_CONT "QAM ");
194 if (type & DTV7)
195 printk(KERN_CONT "DTV7 ");
196 if (type & DTV78)
197 printk(KERN_CONT "DTV78 ");
198 if (type & DTV8)
199 printk(KERN_CONT "DTV8 ");
200 if (type & FM)
201 printk(KERN_CONT "FM ");
202 if (type & INPUT1)
203 printk(KERN_CONT "INPUT1 ");
204 if (type & LCD)
205 printk(KERN_CONT "LCD ");
206 if (type & NOGD)
207 printk(KERN_CONT "NOGD ");
208 if (type & MONO)
209 printk(KERN_CONT "MONO ");
210 if (type & ATSC)
211 printk(KERN_CONT "ATSC ");
212 if (type & IF)
213 printk(KERN_CONT "IF ");
214 if (type & LG60)
215 printk(KERN_CONT "LG60 ");
216 if (type & ATI638)
217 printk(KERN_CONT "ATI638 ");
218 if (type & OREN538)
219 printk(KERN_CONT "OREN538 ");
220 if (type & OREN36)
221 printk(KERN_CONT "OREN36 ");
222 if (type & TOYOTA388)
223 printk(KERN_CONT "TOYOTA388 ");
224 if (type & TOYOTA794)
225 printk(KERN_CONT "TOYOTA794 ");
226 if (type & DIBCOM52)
227 printk(KERN_CONT "DIBCOM52 ");
228 if (type & ZARLINK456)
229 printk(KERN_CONT "ZARLINK456 ");
230 if (type & CHINA)
231 printk(KERN_CONT "CHINA ");
232 if (type & F6MHZ)
233 printk(KERN_CONT "F6MHZ ");
234 if (type & INPUT2)
235 printk(KERN_CONT "INPUT2 ");
236 if (type & SCODE)
237 printk(KERN_CONT "SCODE ");
238 if (type & HAS_IF)
239 printk(KERN_CONT "HAS_IF_%d ", int_freq);
242 static v4l2_std_id parse_audio_std_option(void)
244 if (strcasecmp(audio_std, "A2") == 0)
245 return V4L2_STD_A2;
246 if (strcasecmp(audio_std, "A2/A") == 0)
247 return V4L2_STD_A2_A;
248 if (strcasecmp(audio_std, "A2/B") == 0)
249 return V4L2_STD_A2_B;
250 if (strcasecmp(audio_std, "NICAM") == 0)
251 return V4L2_STD_NICAM;
252 if (strcasecmp(audio_std, "NICAM/A") == 0)
253 return V4L2_STD_NICAM_A;
254 if (strcasecmp(audio_std, "NICAM/B") == 0)
255 return V4L2_STD_NICAM_B;
257 return 0;
260 static int check_device_status(struct xc2028_data *priv)
262 switch (priv->state) {
263 case XC2028_NO_FIRMWARE:
264 case XC2028_WAITING_FIRMWARE:
265 return -EAGAIN;
266 case XC2028_ACTIVE:
267 return 1;
268 case XC2028_SLEEP:
269 return 0;
270 case XC2028_NODEV:
271 return -ENODEV;
273 return 0;
276 static void free_firmware(struct xc2028_data *priv)
278 int i;
279 tuner_dbg("%s called\n", __func__);
281 /* free allocated f/w string */
282 if (priv->fname != firmware_name)
283 kfree(priv->fname);
284 priv->fname = NULL;
286 priv->state = XC2028_NO_FIRMWARE;
287 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
289 if (!priv->firm)
290 return;
292 for (i = 0; i < priv->firm_size; i++)
293 kfree(priv->firm[i].ptr);
295 kfree(priv->firm);
297 priv->firm = NULL;
298 priv->firm_size = 0;
301 static int load_all_firmwares(struct dvb_frontend *fe,
302 const struct firmware *fw)
304 struct xc2028_data *priv = fe->tuner_priv;
305 const unsigned char *p, *endp;
306 int rc = 0;
307 int n, n_array;
308 char name[33];
310 tuner_dbg("%s called\n", __func__);
312 p = fw->data;
313 endp = p + fw->size;
315 if (fw->size < sizeof(name) - 1 + 2 + 2) {
316 tuner_err("Error: firmware file %s has invalid size!\n",
317 priv->fname);
318 goto corrupt;
321 memcpy(name, p, sizeof(name) - 1);
322 name[sizeof(name) - 1] = 0;
323 p += sizeof(name) - 1;
325 priv->firm_version = get_unaligned_le16(p);
326 p += 2;
328 n_array = get_unaligned_le16(p);
329 p += 2;
331 tuner_info("Loading %d firmware images from %s, type: %s, ver %d.%d\n",
332 n_array, priv->fname, name,
333 priv->firm_version >> 8, priv->firm_version & 0xff);
335 priv->firm = kcalloc(n_array, sizeof(*priv->firm), GFP_KERNEL);
336 if (priv->firm == NULL) {
337 tuner_err("Not enough memory to load firmware file.\n");
338 rc = -ENOMEM;
339 goto err;
341 priv->firm_size = n_array;
343 n = -1;
344 while (p < endp) {
345 __u32 type, size;
346 v4l2_std_id id;
347 __u16 int_freq = 0;
349 n++;
350 if (n >= n_array) {
351 tuner_err("More firmware images in file than were expected!\n");
352 goto corrupt;
355 /* Checks if there's enough bytes to read */
356 if (endp - p < sizeof(type) + sizeof(id) + sizeof(size))
357 goto header;
359 type = get_unaligned_le32(p);
360 p += sizeof(type);
362 id = get_unaligned_le64(p);
363 p += sizeof(id);
365 if (type & HAS_IF) {
366 int_freq = get_unaligned_le16(p);
367 p += sizeof(int_freq);
368 if (endp - p < sizeof(size))
369 goto header;
372 size = get_unaligned_le32(p);
373 p += sizeof(size);
375 if (!size || size > endp - p) {
376 tuner_err("Firmware type ");
377 dump_firm_type(type);
378 printk(KERN_CONT
379 "(%x), id %llx is corrupted (size=%d, expected %d)\n",
380 type, (unsigned long long)id,
381 (unsigned)(endp - p), size);
382 goto corrupt;
385 priv->firm[n].ptr = kzalloc(size, GFP_KERNEL);
386 if (priv->firm[n].ptr == NULL) {
387 tuner_err("Not enough memory to load firmware file.\n");
388 rc = -ENOMEM;
389 goto err;
391 tuner_dbg("Reading firmware type ");
392 if (debug) {
393 dump_firm_type_and_int_freq(type, int_freq);
394 printk(KERN_CONT "(%x), id %llx, size=%d.\n",
395 type, (unsigned long long)id, size);
398 memcpy(priv->firm[n].ptr, p, size);
399 priv->firm[n].type = type;
400 priv->firm[n].id = id;
401 priv->firm[n].size = size;
402 priv->firm[n].int_freq = int_freq;
404 p += size;
407 if (n + 1 != priv->firm_size) {
408 tuner_err("Firmware file is incomplete!\n");
409 goto corrupt;
412 goto done;
414 header:
415 tuner_err("Firmware header is incomplete!\n");
416 corrupt:
417 rc = -EINVAL;
418 tuner_err("Error: firmware file is corrupted!\n");
420 err:
421 tuner_info("Releasing partially loaded firmware file.\n");
422 free_firmware(priv);
424 done:
425 if (rc == 0)
426 tuner_dbg("Firmware files loaded.\n");
427 else
428 priv->state = XC2028_NODEV;
430 return rc;
433 static int seek_firmware(struct dvb_frontend *fe, unsigned int type,
434 v4l2_std_id *id)
436 struct xc2028_data *priv = fe->tuner_priv;
437 int i, best_i = -1, best_nr_matches = 0;
438 unsigned int type_mask = 0;
440 tuner_dbg("%s called, want type=", __func__);
441 if (debug) {
442 dump_firm_type(type);
443 printk(KERN_CONT "(%x), id %016llx.\n",
444 type, (unsigned long long)*id);
447 if (!priv->firm) {
448 tuner_err("Error! firmware not loaded\n");
449 return -EINVAL;
452 if (((type & ~SCODE) == 0) && (*id == 0))
453 *id = V4L2_STD_PAL;
455 if (type & BASE)
456 type_mask = BASE_TYPES;
457 else if (type & SCODE) {
458 type &= SCODE_TYPES;
459 type_mask = SCODE_TYPES & ~HAS_IF;
460 } else if (type & DTV_TYPES)
461 type_mask = DTV_TYPES;
462 else if (type & STD_SPECIFIC_TYPES)
463 type_mask = STD_SPECIFIC_TYPES;
465 type &= type_mask;
467 if (!(type & SCODE))
468 type_mask = ~0;
470 /* Seek for exact match */
471 for (i = 0; i < priv->firm_size; i++) {
472 if ((type == (priv->firm[i].type & type_mask)) &&
473 (*id == priv->firm[i].id))
474 goto found;
477 /* Seek for generic video standard match */
478 for (i = 0; i < priv->firm_size; i++) {
479 v4l2_std_id match_mask;
480 int nr_matches;
482 if (type != (priv->firm[i].type & type_mask))
483 continue;
485 match_mask = *id & priv->firm[i].id;
486 if (!match_mask)
487 continue;
489 if ((*id & match_mask) == *id)
490 goto found; /* Supports all the requested standards */
492 nr_matches = hweight64(match_mask);
493 if (nr_matches > best_nr_matches) {
494 best_nr_matches = nr_matches;
495 best_i = i;
499 if (best_nr_matches > 0) {
500 tuner_dbg("Selecting best matching firmware (%d bits) for type=",
501 best_nr_matches);
502 dump_firm_type(type);
503 printk(KERN_CONT
504 "(%x), id %016llx:\n", type, (unsigned long long)*id);
505 i = best_i;
506 goto found;
509 /*FIXME: Would make sense to seek for type "hint" match ? */
511 i = -ENOENT;
512 goto ret;
514 found:
515 *id = priv->firm[i].id;
517 ret:
518 tuner_dbg("%s firmware for type=", (i < 0) ? "Can't find" : "Found");
519 if (debug) {
520 dump_firm_type(type);
521 printk(KERN_CONT "(%x), id %016llx.\n",
522 type, (unsigned long long)*id);
524 return i;
527 static inline int do_tuner_callback(struct dvb_frontend *fe, int cmd, int arg)
529 struct xc2028_data *priv = fe->tuner_priv;
531 /* analog side (tuner-core) uses i2c_adap->algo_data.
532 * digital side is not guaranteed to have algo_data defined.
534 * digital side will always have fe->dvb defined.
535 * analog side (tuner-core) doesn't (yet) define fe->dvb.
538 return (!fe->callback) ? -EINVAL :
539 fe->callback(((fe->dvb) && (fe->dvb->priv)) ?
540 fe->dvb->priv : priv->i2c_props.adap->algo_data,
541 DVB_FRONTEND_COMPONENT_TUNER, cmd, arg);
544 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
545 v4l2_std_id *id)
547 struct xc2028_data *priv = fe->tuner_priv;
548 int pos, rc;
549 unsigned char *p, *endp, buf[MAX_XFER_SIZE];
551 if (priv->ctrl.max_len > sizeof(buf))
552 priv->ctrl.max_len = sizeof(buf);
554 tuner_dbg("%s called\n", __func__);
556 pos = seek_firmware(fe, type, id);
557 if (pos < 0)
558 return pos;
560 tuner_info("Loading firmware for type=");
561 dump_firm_type(priv->firm[pos].type);
562 printk(KERN_CONT "(%x), id %016llx.\n",
563 priv->firm[pos].type, (unsigned long long)*id);
565 p = priv->firm[pos].ptr;
566 endp = p + priv->firm[pos].size;
568 while (p < endp) {
569 __u16 size;
571 /* Checks if there's enough bytes to read */
572 if (p + sizeof(size) > endp) {
573 tuner_err("Firmware chunk size is wrong\n");
574 return -EINVAL;
577 size = le16_to_cpu(*(__le16 *) p);
578 p += sizeof(size);
580 if (size == 0xffff)
581 return 0;
583 if (!size) {
584 /* Special callback command received */
585 rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
586 if (rc < 0) {
587 tuner_err("Error at RESET code %d\n",
588 (*p) & 0x7f);
589 return -EINVAL;
591 continue;
593 if (size >= 0xff00) {
594 switch (size) {
595 case 0xff00:
596 rc = do_tuner_callback(fe, XC2028_RESET_CLK, 0);
597 if (rc < 0) {
598 tuner_err("Error at RESET code %d\n",
599 (*p) & 0x7f);
600 return -EINVAL;
602 break;
603 default:
604 tuner_info("Invalid RESET code %d\n",
605 size & 0x7f);
606 return -EINVAL;
609 continue;
612 /* Checks for a sleep command */
613 if (size & 0x8000) {
614 msleep(size & 0x7fff);
615 continue;
618 if ((size + p > endp)) {
619 tuner_err("missing bytes: need %d, have %d\n",
620 size, (int)(endp - p));
621 return -EINVAL;
624 buf[0] = *p;
625 p++;
626 size--;
628 /* Sends message chunks */
629 while (size > 0) {
630 int len = (size < priv->ctrl.max_len - 1) ?
631 size : priv->ctrl.max_len - 1;
633 memcpy(buf + 1, p, len);
635 rc = i2c_send(priv, buf, len + 1);
636 if (rc < 0) {
637 tuner_err("%d returned from send\n", rc);
638 return -EINVAL;
641 p += len;
642 size -= len;
645 /* silently fail if the frontend doesn't support I2C flush */
646 rc = do_tuner_callback(fe, XC2028_I2C_FLUSH, 0);
647 if ((rc < 0) && (rc != -EINVAL)) {
648 tuner_err("error executing flush: %d\n", rc);
649 return rc;
652 return 0;
655 static int load_scode(struct dvb_frontend *fe, unsigned int type,
656 v4l2_std_id *id, __u16 int_freq, int scode)
658 struct xc2028_data *priv = fe->tuner_priv;
659 int pos, rc;
660 unsigned char *p;
662 tuner_dbg("%s called\n", __func__);
664 if (!int_freq) {
665 pos = seek_firmware(fe, type, id);
666 if (pos < 0)
667 return pos;
668 } else {
669 for (pos = 0; pos < priv->firm_size; pos++) {
670 if ((priv->firm[pos].int_freq == int_freq) &&
671 (priv->firm[pos].type & HAS_IF))
672 break;
674 if (pos == priv->firm_size)
675 return -ENOENT;
678 p = priv->firm[pos].ptr;
680 if (priv->firm[pos].type & HAS_IF) {
681 if (priv->firm[pos].size != 12 * 16 || scode >= 16)
682 return -EINVAL;
683 p += 12 * scode;
684 } else {
685 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
686 * has a 2-byte size header in the firmware format. */
687 if (priv->firm[pos].size != 14 * 16 || scode >= 16 ||
688 le16_to_cpu(*(__le16 *)(p + 14 * scode)) != 12)
689 return -EINVAL;
690 p += 14 * scode + 2;
693 tuner_info("Loading SCODE for type=");
694 dump_firm_type_and_int_freq(priv->firm[pos].type,
695 priv->firm[pos].int_freq);
696 printk(KERN_CONT "(%x), id %016llx.\n", priv->firm[pos].type,
697 (unsigned long long)*id);
699 if (priv->firm_version < 0x0202)
700 rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
701 else
702 rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
703 if (rc < 0)
704 return -EIO;
706 rc = i2c_send(priv, p, 12);
707 if (rc < 0)
708 return -EIO;
710 rc = send_seq(priv, {0x00, 0x8c});
711 if (rc < 0)
712 return -EIO;
714 return 0;
717 static int xc2028_sleep(struct dvb_frontend *fe);
719 static int check_firmware(struct dvb_frontend *fe, unsigned int type,
720 v4l2_std_id std, __u16 int_freq)
722 struct xc2028_data *priv = fe->tuner_priv;
723 struct firmware_properties new_fw;
724 int rc, retry_count = 0;
725 u16 version, hwmodel;
726 v4l2_std_id std0;
728 tuner_dbg("%s called\n", __func__);
730 rc = check_device_status(priv);
731 if (rc < 0)
732 return rc;
734 if (priv->ctrl.mts && !(type & FM))
735 type |= MTS;
737 retry:
738 new_fw.type = type;
739 new_fw.id = std;
740 new_fw.std_req = std;
741 new_fw.scode_table = SCODE | priv->ctrl.scode_table;
742 new_fw.scode_nr = 0;
743 new_fw.int_freq = int_freq;
745 tuner_dbg("checking firmware, user requested type=");
746 if (debug) {
747 dump_firm_type(new_fw.type);
748 printk(KERN_CONT "(%x), id %016llx, ", new_fw.type,
749 (unsigned long long)new_fw.std_req);
750 if (!int_freq) {
751 printk(KERN_CONT "scode_tbl ");
752 dump_firm_type(priv->ctrl.scode_table);
753 printk(KERN_CONT "(%x), ", priv->ctrl.scode_table);
754 } else
755 printk(KERN_CONT "int_freq %d, ", new_fw.int_freq);
756 printk(KERN_CONT "scode_nr %d\n", new_fw.scode_nr);
760 * No need to reload base firmware if it matches and if the tuner
761 * is not at sleep mode
763 if ((priv->state == XC2028_ACTIVE) &&
764 (((BASE | new_fw.type) & BASE_TYPES) ==
765 (priv->cur_fw.type & BASE_TYPES))) {
766 tuner_dbg("BASE firmware not changed.\n");
767 goto skip_base;
770 /* Updating BASE - forget about all currently loaded firmware */
771 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
773 /* Reset is needed before loading firmware */
774 rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
775 if (rc < 0)
776 goto fail;
778 /* BASE firmwares are all std0 */
779 std0 = 0;
780 rc = load_firmware(fe, BASE | new_fw.type, &std0);
781 if (rc < 0) {
782 tuner_err("Error %d while loading base firmware\n",
783 rc);
784 goto fail;
787 /* Load INIT1, if needed */
788 tuner_dbg("Load init1 firmware, if exists\n");
790 rc = load_firmware(fe, BASE | INIT1 | new_fw.type, &std0);
791 if (rc == -ENOENT)
792 rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
793 &std0);
794 if (rc < 0 && rc != -ENOENT) {
795 tuner_err("Error %d while loading init1 firmware\n",
796 rc);
797 goto fail;
800 skip_base:
802 * No need to reload standard specific firmware if base firmware
803 * was not reloaded and requested video standards have not changed.
805 if (priv->cur_fw.type == (BASE | new_fw.type) &&
806 priv->cur_fw.std_req == std) {
807 tuner_dbg("Std-specific firmware already loaded.\n");
808 goto skip_std_specific;
811 /* Reloading std-specific firmware forces a SCODE update */
812 priv->cur_fw.scode_table = 0;
814 rc = load_firmware(fe, new_fw.type, &new_fw.id);
815 if (rc == -ENOENT)
816 rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
818 if (rc < 0)
819 goto fail;
821 skip_std_specific:
822 if (priv->cur_fw.scode_table == new_fw.scode_table &&
823 priv->cur_fw.scode_nr == new_fw.scode_nr) {
824 tuner_dbg("SCODE firmware already loaded.\n");
825 goto check_device;
828 if (new_fw.type & FM)
829 goto check_device;
831 /* Load SCODE firmware, if exists */
832 tuner_dbg("Trying to load scode %d\n", new_fw.scode_nr);
834 rc = load_scode(fe, new_fw.type | new_fw.scode_table, &new_fw.id,
835 new_fw.int_freq, new_fw.scode_nr);
837 check_device:
838 if (xc2028_get_reg(priv, 0x0004, &version) < 0 ||
839 xc2028_get_reg(priv, 0x0008, &hwmodel) < 0) {
840 tuner_err("Unable to read tuner registers.\n");
841 goto fail;
844 tuner_dbg("Device is Xceive %d version %d.%d, firmware version %d.%d\n",
845 hwmodel, (version & 0xf000) >> 12, (version & 0xf00) >> 8,
846 (version & 0xf0) >> 4, version & 0xf);
849 if (priv->ctrl.read_not_reliable)
850 goto read_not_reliable;
852 /* Check firmware version against what we downloaded. */
853 if (priv->firm_version != ((version & 0xf0) << 4 | (version & 0x0f))) {
854 if (!priv->ctrl.read_not_reliable) {
855 tuner_err("Incorrect readback of firmware version.\n");
856 goto fail;
857 } else {
858 tuner_err("Returned an incorrect version. However, read is not reliable enough. Ignoring it.\n");
859 hwmodel = 3028;
863 /* Check that the tuner hardware model remains consistent over time. */
864 if (priv->hwmodel == 0 && (hwmodel == 2028 || hwmodel == 3028)) {
865 priv->hwmodel = hwmodel;
866 priv->hwvers = version & 0xff00;
867 } else if (priv->hwmodel == 0 || priv->hwmodel != hwmodel ||
868 priv->hwvers != (version & 0xff00)) {
869 tuner_err("Read invalid device hardware information - tuner hung?\n");
870 goto fail;
873 read_not_reliable:
874 priv->cur_fw = new_fw;
877 * By setting BASE in cur_fw.type only after successfully loading all
878 * firmwares, we can:
879 * 1. Identify that BASE firmware with type=0 has been loaded;
880 * 2. Tell whether BASE firmware was just changed the next time through.
882 priv->cur_fw.type |= BASE;
883 priv->state = XC2028_ACTIVE;
885 return 0;
887 fail:
888 free_firmware(priv);
890 if (retry_count < 8) {
891 msleep(50);
892 retry_count++;
893 tuner_dbg("Retrying firmware load\n");
894 goto retry;
897 /* Firmware didn't load. Put the device to sleep */
898 xc2028_sleep(fe);
900 if (rc == -ENOENT)
901 rc = -EINVAL;
902 return rc;
905 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
907 struct xc2028_data *priv = fe->tuner_priv;
908 u16 frq_lock, signal = 0;
909 int rc, i;
911 tuner_dbg("%s called\n", __func__);
913 rc = check_device_status(priv);
914 if (rc < 0)
915 return rc;
917 /* If the device is sleeping, no channel is tuned */
918 if (!rc) {
919 *strength = 0;
920 return 0;
923 mutex_lock(&priv->lock);
925 /* Sync Lock Indicator */
926 for (i = 0; i < 3; i++) {
927 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
928 if (rc < 0)
929 goto ret;
931 if (frq_lock)
932 break;
933 msleep(6);
936 /* Frequency didn't lock */
937 if (frq_lock == 2)
938 goto ret;
940 /* Get SNR of the video signal */
941 rc = xc2028_get_reg(priv, XREG_SNR, &signal);
942 if (rc < 0)
943 goto ret;
945 /* Signal level is 3 bits only */
947 signal = ((1 << 12) - 1) | ((signal & 0x07) << 12);
949 ret:
950 mutex_unlock(&priv->lock);
952 *strength = signal;
954 tuner_dbg("signal strength is %d\n", signal);
956 return rc;
959 static int xc2028_get_afc(struct dvb_frontend *fe, s32 *afc)
961 struct xc2028_data *priv = fe->tuner_priv;
962 int i, rc;
963 u16 frq_lock = 0;
964 s16 afc_reg = 0;
966 rc = check_device_status(priv);
967 if (rc < 0)
968 return rc;
970 /* If the device is sleeping, no channel is tuned */
971 if (!rc) {
972 *afc = 0;
973 return 0;
976 mutex_lock(&priv->lock);
978 /* Sync Lock Indicator */
979 for (i = 0; i < 3; i++) {
980 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
981 if (rc < 0)
982 goto ret;
984 if (frq_lock)
985 break;
986 msleep(6);
989 /* Frequency didn't lock */
990 if (frq_lock == 2)
991 goto ret;
993 /* Get AFC */
994 rc = xc2028_get_reg(priv, XREG_FREQ_ERROR, &afc_reg);
995 if (rc < 0)
996 goto ret;
998 *afc = afc_reg * 15625; /* Hz */
1000 tuner_dbg("AFC is %d Hz\n", *afc);
1002 ret:
1003 mutex_unlock(&priv->lock);
1005 return rc;
1008 #define DIV 15625
1010 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
1011 enum v4l2_tuner_type new_type,
1012 unsigned int type,
1013 v4l2_std_id std,
1014 u16 int_freq)
1016 struct xc2028_data *priv = fe->tuner_priv;
1017 int rc = -EINVAL;
1018 unsigned char buf[4];
1019 u32 div, offset = 0;
1021 tuner_dbg("%s called\n", __func__);
1023 mutex_lock(&priv->lock);
1025 tuner_dbg("should set frequency %d kHz\n", freq / 1000);
1027 if (check_firmware(fe, type, std, int_freq) < 0)
1028 goto ret;
1030 /* On some cases xc2028 can disable video output, if
1031 * very weak signals are received. By sending a soft
1032 * reset, this is re-enabled. So, it is better to always
1033 * send a soft reset before changing channels, to be sure
1034 * that xc2028 will be in a safe state.
1035 * Maybe this might also be needed for DTV.
1037 switch (new_type) {
1038 case V4L2_TUNER_ANALOG_TV:
1039 rc = send_seq(priv, {0x00, 0x00});
1041 /* Analog mode requires offset = 0 */
1042 break;
1043 case V4L2_TUNER_RADIO:
1044 /* Radio mode requires offset = 0 */
1045 break;
1046 case V4L2_TUNER_DIGITAL_TV:
1048 * Digital modes require an offset to adjust to the
1049 * proper frequency. The offset depends on what
1050 * firmware version is used.
1054 * Adjust to the center frequency. This is calculated by the
1055 * formula: offset = 1.25MHz - BW/2
1056 * For DTV 7/8, the firmware uses BW = 8000, so it needs a
1057 * further adjustment to get the frequency center on VHF
1061 * The firmware DTV78 used to work fine in UHF band (8 MHz
1062 * bandwidth) but not at all in VHF band (7 MHz bandwidth).
1063 * The real problem was connected to the formula used to
1064 * calculate the center frequency offset in VHF band.
1065 * In fact, removing the 500KHz adjustment fixed the problem.
1066 * This is coherent to what was implemented for the DTV7
1067 * firmware.
1068 * In the end, now the center frequency is the same for all 3
1069 * firmwares (DTV7, DTV8, DTV78) and doesn't depend on channel
1070 * bandwidth.
1073 if (priv->cur_fw.type & DTV6)
1074 offset = 1750000;
1075 else /* DTV7 or DTV8 or DTV78 */
1076 offset = 2750000;
1079 * xc3028 additional "magic"
1080 * Depending on the firmware version, it needs some adjustments
1081 * to properly centralize the frequency. This seems to be
1082 * needed to compensate the SCODE table adjustments made by
1083 * newer firmwares
1087 * The proper adjustment would be to do it at s-code table.
1088 * However, this didn't work, as reported by
1089 * Robert Lowery <rglowery@exemail.com.au>
1092 #if 0
1094 * Still need tests for XC3028L (firmware 3.2 or upper)
1095 * So, for now, let's just comment the per-firmware
1096 * version of this change. Reports with xc3028l working
1097 * with and without the lines below are welcome
1100 if (priv->firm_version < 0x0302) {
1101 if (priv->cur_fw.type & DTV7)
1102 offset += 500000;
1103 } else {
1104 if (priv->cur_fw.type & DTV7)
1105 offset -= 300000;
1106 else if (type != ATSC) /* DVB @6MHz, DTV 8 and DTV 7/8 */
1107 offset += 200000;
1109 #endif
1110 break;
1111 default:
1112 tuner_err("Unsupported tuner type %d.\n", new_type);
1113 break;
1116 div = (freq - offset + DIV / 2) / DIV;
1118 /* CMD= Set frequency */
1119 if (priv->firm_version < 0x0202)
1120 rc = send_seq(priv, {0x00, XREG_RF_FREQ, 0x00, 0x00});
1121 else
1122 rc = send_seq(priv, {0x80, XREG_RF_FREQ, 0x00, 0x00});
1123 if (rc < 0)
1124 goto ret;
1126 /* Return code shouldn't be checked.
1127 The reset CLK is needed only with tm6000.
1128 Driver should work fine even if this fails.
1130 if (priv->ctrl.msleep)
1131 msleep(priv->ctrl.msleep);
1132 do_tuner_callback(fe, XC2028_RESET_CLK, 1);
1134 msleep(10);
1136 buf[0] = 0xff & (div >> 24);
1137 buf[1] = 0xff & (div >> 16);
1138 buf[2] = 0xff & (div >> 8);
1139 buf[3] = 0xff & (div);
1141 rc = i2c_send(priv, buf, sizeof(buf));
1142 if (rc < 0)
1143 goto ret;
1144 msleep(100);
1146 priv->frequency = freq;
1148 tuner_dbg("divisor= %*ph (freq=%d.%03d)\n", 4, buf,
1149 freq / 1000000, (freq % 1000000) / 1000);
1151 rc = 0;
1153 ret:
1154 mutex_unlock(&priv->lock);
1156 return rc;
1159 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
1160 struct analog_parameters *p)
1162 struct xc2028_data *priv = fe->tuner_priv;
1163 unsigned int type=0;
1165 tuner_dbg("%s called\n", __func__);
1167 if (p->mode == V4L2_TUNER_RADIO) {
1168 type |= FM;
1169 if (priv->ctrl.input1)
1170 type |= INPUT1;
1171 return generic_set_freq(fe, (625l * p->frequency) / 10,
1172 V4L2_TUNER_RADIO, type, 0, 0);
1175 /* if std is not defined, choose one */
1176 if (!p->std)
1177 p->std = V4L2_STD_MN;
1179 /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
1180 if (!(p->std & V4L2_STD_MN))
1181 type |= F8MHZ;
1183 /* Add audio hack to std mask */
1184 p->std |= parse_audio_std_option();
1186 return generic_set_freq(fe, 62500l * p->frequency,
1187 V4L2_TUNER_ANALOG_TV, type, p->std, 0);
1190 static int xc2028_set_params(struct dvb_frontend *fe)
1192 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
1193 u32 delsys = c->delivery_system;
1194 u32 bw = c->bandwidth_hz;
1195 struct xc2028_data *priv = fe->tuner_priv;
1196 int rc;
1197 unsigned int type = 0;
1198 u16 demod = 0;
1200 tuner_dbg("%s called\n", __func__);
1202 rc = check_device_status(priv);
1203 if (rc < 0)
1204 return rc;
1206 switch (delsys) {
1207 case SYS_DVBT:
1208 case SYS_DVBT2:
1210 * The only countries with 6MHz seem to be Taiwan/Uruguay.
1211 * Both seem to require QAM firmware for OFDM decoding
1212 * Tested in Taiwan by Terry Wu <terrywu2009@gmail.com>
1214 if (bw <= 6000000)
1215 type |= QAM;
1217 switch (priv->ctrl.type) {
1218 case XC2028_D2633:
1219 type |= D2633;
1220 break;
1221 case XC2028_D2620:
1222 type |= D2620;
1223 break;
1224 case XC2028_AUTO:
1225 default:
1226 /* Zarlink seems to need D2633 */
1227 if (priv->ctrl.demod == XC3028_FE_ZARLINK456)
1228 type |= D2633;
1229 else
1230 type |= D2620;
1232 break;
1233 case SYS_ATSC:
1234 /* The only ATSC firmware (at least on v2.7) is D2633 */
1235 type |= ATSC | D2633;
1236 break;
1237 /* DVB-S and pure QAM (FE_QAM) are not supported */
1238 default:
1239 return -EINVAL;
1242 if (bw <= 6000000) {
1243 type |= DTV6;
1244 priv->ctrl.vhfbw7 = 0;
1245 priv->ctrl.uhfbw8 = 0;
1246 } else if (bw <= 7000000) {
1247 if (c->frequency < 470000000)
1248 priv->ctrl.vhfbw7 = 1;
1249 else
1250 priv->ctrl.uhfbw8 = 0;
1251 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV7;
1252 type |= F8MHZ;
1253 } else {
1254 if (c->frequency < 470000000)
1255 priv->ctrl.vhfbw7 = 0;
1256 else
1257 priv->ctrl.uhfbw8 = 1;
1258 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV8;
1259 type |= F8MHZ;
1262 /* All S-code tables need a 200kHz shift */
1263 if (priv->ctrl.demod) {
1264 demod = priv->ctrl.demod;
1267 * Newer firmwares require a 200 kHz offset only for ATSC
1269 if (type == ATSC || priv->firm_version < 0x0302)
1270 demod += 200;
1272 * The DTV7 S-code table needs a 700 kHz shift.
1274 * DTV7 is only used in Australia. Germany or Italy may also
1275 * use this firmware after initialization, but a tune to a UHF
1276 * channel should then cause DTV78 to be used.
1278 * Unfortunately, on real-field tests, the s-code offset
1279 * didn't work as expected, as reported by
1280 * Robert Lowery <rglowery@exemail.com.au>
1284 return generic_set_freq(fe, c->frequency,
1285 V4L2_TUNER_DIGITAL_TV, type, 0, demod);
1288 static int xc2028_sleep(struct dvb_frontend *fe)
1290 struct xc2028_data *priv = fe->tuner_priv;
1291 int rc;
1293 rc = check_device_status(priv);
1294 if (rc < 0)
1295 return rc;
1297 /* Device is already in sleep mode */
1298 if (!rc)
1299 return 0;
1301 /* Avoid firmware reload on slow devices or if PM disabled */
1302 if (no_poweroff || priv->ctrl.disable_power_mgmt)
1303 return 0;
1305 tuner_dbg("Putting xc2028/3028 into poweroff mode.\n");
1306 if (debug > 1) {
1307 tuner_dbg("Printing sleep stack trace:\n");
1308 dump_stack();
1311 mutex_lock(&priv->lock);
1313 if (priv->firm_version < 0x0202)
1314 rc = send_seq(priv, {0x00, XREG_POWER_DOWN, 0x00, 0x00});
1315 else
1316 rc = send_seq(priv, {0x80, XREG_POWER_DOWN, 0x00, 0x00});
1318 if (rc >= 0)
1319 priv->state = XC2028_SLEEP;
1321 mutex_unlock(&priv->lock);
1323 return rc;
1326 static void xc2028_dvb_release(struct dvb_frontend *fe)
1328 struct xc2028_data *priv = fe->tuner_priv;
1330 tuner_dbg("%s called\n", __func__);
1332 mutex_lock(&xc2028_list_mutex);
1334 /* only perform final cleanup if this is the last instance */
1335 if (hybrid_tuner_report_instance_count(priv) == 1)
1336 free_firmware(priv);
1338 if (priv)
1339 hybrid_tuner_release_state(priv);
1341 mutex_unlock(&xc2028_list_mutex);
1343 fe->tuner_priv = NULL;
1346 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1348 struct xc2028_data *priv = fe->tuner_priv;
1349 int rc;
1351 tuner_dbg("%s called\n", __func__);
1353 rc = check_device_status(priv);
1354 if (rc < 0)
1355 return rc;
1357 *frequency = priv->frequency;
1359 return 0;
1362 static void load_firmware_cb(const struct firmware *fw,
1363 void *context)
1365 struct dvb_frontend *fe = context;
1366 struct xc2028_data *priv = fe->tuner_priv;
1367 int rc;
1369 tuner_dbg("request_firmware_nowait(): %s\n", fw ? "OK" : "error");
1370 if (!fw) {
1371 tuner_err("Could not load firmware %s.\n", priv->fname);
1372 priv->state = XC2028_NODEV;
1373 return;
1376 rc = load_all_firmwares(fe, fw);
1378 release_firmware(fw);
1380 if (rc < 0)
1381 return;
1382 priv->state = XC2028_ACTIVE;
1385 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1387 struct xc2028_data *priv = fe->tuner_priv;
1388 struct xc2028_ctrl *p = priv_cfg;
1389 int rc = 0;
1391 tuner_dbg("%s called\n", __func__);
1393 mutex_lock(&priv->lock);
1396 * Copy the config data.
1398 memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1401 * If firmware name changed, frees firmware. As free_firmware will
1402 * reset the status to NO_FIRMWARE, this forces a new request_firmware
1404 if (!firmware_name[0] && p->fname &&
1405 priv->fname && strcmp(p->fname, priv->fname))
1406 free_firmware(priv);
1408 if (priv->ctrl.max_len < 9)
1409 priv->ctrl.max_len = 13;
1411 if (priv->state == XC2028_NO_FIRMWARE) {
1412 if (!firmware_name[0])
1413 priv->fname = kstrdup(p->fname, GFP_KERNEL);
1414 else
1415 priv->fname = firmware_name;
1417 if (!priv->fname) {
1418 rc = -ENOMEM;
1419 goto unlock;
1422 rc = request_firmware_nowait(THIS_MODULE, 1,
1423 priv->fname,
1424 priv->i2c_props.adap->dev.parent,
1425 GFP_KERNEL,
1426 fe, load_firmware_cb);
1427 if (rc < 0) {
1428 tuner_err("Failed to request firmware %s\n",
1429 priv->fname);
1430 priv->state = XC2028_NODEV;
1431 } else
1432 priv->state = XC2028_WAITING_FIRMWARE;
1434 unlock:
1435 mutex_unlock(&priv->lock);
1437 return rc;
1440 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1441 .info = {
1442 .name = "Xceive XC3028",
1443 .frequency_min = 42000000,
1444 .frequency_max = 864000000,
1445 .frequency_step = 50000,
1448 .set_config = xc2028_set_config,
1449 .set_analog_params = xc2028_set_analog_freq,
1450 .release = xc2028_dvb_release,
1451 .get_frequency = xc2028_get_frequency,
1452 .get_rf_strength = xc2028_signal,
1453 .get_afc = xc2028_get_afc,
1454 .set_params = xc2028_set_params,
1455 .sleep = xc2028_sleep,
1458 struct dvb_frontend *xc2028_attach(struct dvb_frontend *fe,
1459 struct xc2028_config *cfg)
1461 struct xc2028_data *priv;
1462 int instance;
1464 if (debug)
1465 printk(KERN_DEBUG "xc2028: Xcv2028/3028 init called!\n");
1467 if (NULL == cfg)
1468 return NULL;
1470 if (!fe) {
1471 printk(KERN_ERR "xc2028: No frontend!\n");
1472 return NULL;
1475 mutex_lock(&xc2028_list_mutex);
1477 instance = hybrid_tuner_request_state(struct xc2028_data, priv,
1478 hybrid_tuner_instance_list,
1479 cfg->i2c_adap, cfg->i2c_addr,
1480 "xc2028");
1481 switch (instance) {
1482 case 0:
1483 /* memory allocation failure */
1484 goto fail;
1485 case 1:
1486 /* new tuner instance */
1487 priv->ctrl.max_len = 13;
1489 mutex_init(&priv->lock);
1491 fe->tuner_priv = priv;
1492 break;
1493 case 2:
1494 /* existing tuner instance */
1495 fe->tuner_priv = priv;
1496 break;
1499 memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1500 sizeof(xc2028_dvb_tuner_ops));
1502 tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1504 if (cfg->ctrl)
1505 xc2028_set_config(fe, cfg->ctrl);
1507 mutex_unlock(&xc2028_list_mutex);
1509 return fe;
1510 fail:
1511 mutex_unlock(&xc2028_list_mutex);
1513 xc2028_dvb_release(fe);
1514 return NULL;
1517 EXPORT_SYMBOL(xc2028_attach);
1519 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1520 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1521 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
1522 MODULE_LICENSE("GPL v2");
1523 MODULE_FIRMWARE(XC2028_DEFAULT_FIRMWARE);
1524 MODULE_FIRMWARE(XC3028L_DEFAULT_FIRMWARE);