3 * Copyright (c) 2007-2008 Mauro Carvalho Chehab (mchehab@infradead.org)
5 * Copyright (c) 2007 Michel Ludwig (michel.ludwig@gmail.com)
8 * This code is placed under the terms of the GNU General Public License v2
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
44 #define XREG_ADC_ENV 0x0100
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 needs to know what audio\n"
60 "standard is needed for some video standards with audio A2 or NICAM.\n"
61 "The valid values are:\n"
69 static char firmware_name[30];
70 module_param_string(firmware_name, firmware_name, sizeof(firmware_name), 0);
71 MODULE_PARM_DESC(firmware_name,
72 "Firmware file name. Allows overriding the default firmware name\n");
74 static LIST_HEAD(hybrid_tuner_instance_list);
75 static DEFINE_MUTEX(xc2028_list_mutex);
77 /* struct for storing firmware table */
78 struct firmware_description {
86 struct firmware_properties {
91 unsigned int scode_table;
96 XC2028_NO_FIRMWARE = 0,
97 XC2028_WAITING_FIRMWARE,
104 struct list_head hybrid_tuner_instance_list;
105 struct tuner_i2c_props i2c_props;
108 enum xc2028_state state;
111 struct firmware_description *firm;
118 struct xc2028_ctrl ctrl;
120 struct firmware_properties cur_fw;
125 #define i2c_send(priv, buf, size) ({ \
127 _rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size); \
129 tuner_info("i2c output error: rc = %d (should be %d)\n",\
131 if (priv->ctrl.msleep) \
132 msleep(priv->ctrl.msleep); \
136 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({ \
138 _rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize, \
141 tuner_err("i2c input error: rc = %d (should be %d)\n", \
143 if (priv->ctrl.msleep) \
144 msleep(priv->ctrl.msleep); \
148 #define send_seq(priv, data...) ({ \
149 static u8 _val[] = data; \
151 if (sizeof(_val) != \
152 (_rc = tuner_i2c_xfer_send(&priv->i2c_props, \
153 _val, sizeof(_val)))) { \
154 tuner_err("Error on line %d: %d\n", __LINE__, _rc); \
155 } else if (priv->ctrl.msleep) \
156 msleep(priv->ctrl.msleep); \
160 static int xc2028_get_reg(struct xc2028_data *priv, u16 reg, u16 *val)
162 unsigned char buf[2];
163 unsigned char ibuf[2];
165 tuner_dbg("%s %04x called\n", __func__, reg);
168 buf[1] = (unsigned char) reg;
170 if (i2c_send_recv(priv, buf, 2, ibuf, 2) != 2)
173 *val = (ibuf[1]) | (ibuf[0] << 8);
177 #define dump_firm_type(t) dump_firm_type_and_int_freq(t, 0)
178 static void dump_firm_type_and_int_freq(unsigned int type, u16 int_freq)
181 printk(KERN_CONT "BASE ");
183 printk(KERN_CONT "INIT1 ");
185 printk(KERN_CONT "F8MHZ ");
187 printk(KERN_CONT "MTS ");
189 printk(KERN_CONT "D2620 ");
191 printk(KERN_CONT "D2633 ");
193 printk(KERN_CONT "DTV6 ");
195 printk(KERN_CONT "QAM ");
197 printk(KERN_CONT "DTV7 ");
199 printk(KERN_CONT "DTV78 ");
201 printk(KERN_CONT "DTV8 ");
203 printk(KERN_CONT "FM ");
205 printk(KERN_CONT "INPUT1 ");
207 printk(KERN_CONT "LCD ");
209 printk(KERN_CONT "NOGD ");
211 printk(KERN_CONT "MONO ");
213 printk(KERN_CONT "ATSC ");
215 printk(KERN_CONT "IF ");
217 printk(KERN_CONT "LG60 ");
219 printk(KERN_CONT "ATI638 ");
221 printk(KERN_CONT "OREN538 ");
223 printk(KERN_CONT "OREN36 ");
224 if (type & TOYOTA388)
225 printk(KERN_CONT "TOYOTA388 ");
226 if (type & TOYOTA794)
227 printk(KERN_CONT "TOYOTA794 ");
229 printk(KERN_CONT "DIBCOM52 ");
230 if (type & ZARLINK456)
231 printk(KERN_CONT "ZARLINK456 ");
233 printk(KERN_CONT "CHINA ");
235 printk(KERN_CONT "F6MHZ ");
237 printk(KERN_CONT "INPUT2 ");
239 printk(KERN_CONT "SCODE ");
241 printk(KERN_CONT "HAS_IF_%d ", int_freq);
244 static v4l2_std_id parse_audio_std_option(void)
246 if (strcasecmp(audio_std, "A2") == 0)
248 if (strcasecmp(audio_std, "A2/A") == 0)
249 return V4L2_STD_A2_A;
250 if (strcasecmp(audio_std, "A2/B") == 0)
251 return V4L2_STD_A2_B;
252 if (strcasecmp(audio_std, "NICAM") == 0)
253 return V4L2_STD_NICAM;
254 if (strcasecmp(audio_std, "NICAM/A") == 0)
255 return V4L2_STD_NICAM_A;
256 if (strcasecmp(audio_std, "NICAM/B") == 0)
257 return V4L2_STD_NICAM_B;
262 static int check_device_status(struct xc2028_data *priv)
264 switch (priv->state) {
265 case XC2028_NO_FIRMWARE:
266 case XC2028_WAITING_FIRMWARE:
278 static void free_firmware(struct xc2028_data *priv)
281 tuner_dbg("%s called\n", __func__);
283 /* free allocated f/w string */
284 if (priv->fname != firmware_name)
288 priv->state = XC2028_NO_FIRMWARE;
289 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
294 for (i = 0; i < priv->firm_size; i++)
295 kfree(priv->firm[i].ptr);
303 static int load_all_firmwares(struct dvb_frontend *fe,
304 const struct firmware *fw)
306 struct xc2028_data *priv = fe->tuner_priv;
307 const unsigned char *p, *endp;
312 tuner_dbg("%s called\n", __func__);
317 if (fw->size < sizeof(name) - 1 + 2 + 2) {
318 tuner_err("Error: firmware file %s has invalid size!\n",
323 memcpy(name, p, sizeof(name) - 1);
324 name[sizeof(name) - 1] = 0;
325 p += sizeof(name) - 1;
327 priv->firm_version = get_unaligned_le16(p);
330 n_array = get_unaligned_le16(p);
333 tuner_info("Loading %d firmware images from %s, type: %s, ver %d.%d\n",
334 n_array, priv->fname, name,
335 priv->firm_version >> 8, priv->firm_version & 0xff);
337 priv->firm = kcalloc(n_array, sizeof(*priv->firm), GFP_KERNEL);
338 if (priv->firm == NULL) {
339 tuner_err("Not enough memory to load firmware file.\n");
343 priv->firm_size = n_array;
353 tuner_err("More firmware images in file than were expected!\n");
357 /* Checks if there's enough bytes to read */
358 if (endp - p < sizeof(type) + sizeof(id) + sizeof(size))
361 type = get_unaligned_le32(p);
364 id = get_unaligned_le64(p);
368 int_freq = get_unaligned_le16(p);
369 p += sizeof(int_freq);
370 if (endp - p < sizeof(size))
374 size = get_unaligned_le32(p);
377 if (!size || size > endp - p) {
378 tuner_err("Firmware type ");
379 dump_firm_type(type);
381 "(%x), id %llx is corrupted (size=%d, expected %d)\n",
382 type, (unsigned long long)id,
383 (unsigned)(endp - p), size);
387 priv->firm[n].ptr = kzalloc(size, GFP_KERNEL);
388 if (priv->firm[n].ptr == NULL) {
389 tuner_err("Not enough memory to load firmware file.\n");
393 tuner_dbg("Reading firmware type ");
395 dump_firm_type_and_int_freq(type, int_freq);
396 printk(KERN_CONT "(%x), id %llx, size=%d.\n",
397 type, (unsigned long long)id, size);
400 memcpy(priv->firm[n].ptr, p, size);
401 priv->firm[n].type = type;
402 priv->firm[n].id = id;
403 priv->firm[n].size = size;
404 priv->firm[n].int_freq = int_freq;
409 if (n + 1 != priv->firm_size) {
410 tuner_err("Firmware file is incomplete!\n");
417 tuner_err("Firmware header is incomplete!\n");
420 tuner_err("Error: firmware file is corrupted!\n");
423 tuner_info("Releasing partially loaded firmware file.\n");
428 tuner_dbg("Firmware files loaded.\n");
430 priv->state = XC2028_NODEV;
435 static int seek_firmware(struct dvb_frontend *fe, unsigned int type,
438 struct xc2028_data *priv = fe->tuner_priv;
439 int i, best_i = -1, best_nr_matches = 0;
440 unsigned int type_mask = 0;
442 tuner_dbg("%s called, want type=", __func__);
444 dump_firm_type(type);
445 printk(KERN_CONT "(%x), id %016llx.\n",
446 type, (unsigned long long)*id);
450 tuner_err("Error! firmware not loaded\n");
454 if (((type & ~SCODE) == 0) && (*id == 0))
458 type_mask = BASE_TYPES;
459 else if (type & SCODE) {
461 type_mask = SCODE_TYPES & ~HAS_IF;
462 } else if (type & DTV_TYPES)
463 type_mask = DTV_TYPES;
464 else if (type & STD_SPECIFIC_TYPES)
465 type_mask = STD_SPECIFIC_TYPES;
472 /* Seek for exact match */
473 for (i = 0; i < priv->firm_size; i++) {
474 if ((type == (priv->firm[i].type & type_mask)) &&
475 (*id == priv->firm[i].id))
479 /* Seek for generic video standard match */
480 for (i = 0; i < priv->firm_size; i++) {
481 v4l2_std_id match_mask;
484 if (type != (priv->firm[i].type & type_mask))
487 match_mask = *id & priv->firm[i].id;
491 if ((*id & match_mask) == *id)
492 goto found; /* Supports all the requested standards */
494 nr_matches = hweight64(match_mask);
495 if (nr_matches > best_nr_matches) {
496 best_nr_matches = nr_matches;
501 if (best_nr_matches > 0) {
502 tuner_dbg("Selecting best matching firmware (%d bits) for type=",
504 dump_firm_type(type);
506 "(%x), id %016llx:\n", type, (unsigned long long)*id);
511 /*FIXME: Would make sense to seek for type "hint" match ? */
517 *id = priv->firm[i].id;
520 tuner_dbg("%s firmware for type=", (i < 0) ? "Can't find" : "Found");
522 dump_firm_type(type);
523 printk(KERN_CONT "(%x), id %016llx.\n",
524 type, (unsigned long long)*id);
529 static inline int do_tuner_callback(struct dvb_frontend *fe, int cmd, int arg)
531 struct xc2028_data *priv = fe->tuner_priv;
533 /* analog side (tuner-core) uses i2c_adap->algo_data.
534 * digital side is not guaranteed to have algo_data defined.
536 * digital side will always have fe->dvb defined.
537 * analog side (tuner-core) doesn't (yet) define fe->dvb.
540 return (!fe->callback) ? -EINVAL :
541 fe->callback(((fe->dvb) && (fe->dvb->priv)) ?
542 fe->dvb->priv : priv->i2c_props.adap->algo_data,
543 DVB_FRONTEND_COMPONENT_TUNER, cmd, arg);
546 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
549 struct xc2028_data *priv = fe->tuner_priv;
551 unsigned char *p, *endp, buf[MAX_XFER_SIZE];
553 if (priv->ctrl.max_len > sizeof(buf))
554 priv->ctrl.max_len = sizeof(buf);
556 tuner_dbg("%s called\n", __func__);
558 pos = seek_firmware(fe, type, id);
562 tuner_info("Loading firmware for type=");
563 dump_firm_type(priv->firm[pos].type);
564 printk(KERN_CONT "(%x), id %016llx.\n",
565 priv->firm[pos].type, (unsigned long long)*id);
567 p = priv->firm[pos].ptr;
568 endp = p + priv->firm[pos].size;
573 /* Checks if there's enough bytes to read */
574 if (p + sizeof(size) > endp) {
575 tuner_err("Firmware chunk size is wrong\n");
579 size = le16_to_cpu(*(__le16 *) p);
586 /* Special callback command received */
587 rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
589 tuner_err("Error at RESET code %d\n",
595 if (size >= 0xff00) {
598 rc = do_tuner_callback(fe, XC2028_RESET_CLK, 0);
600 tuner_err("Error at RESET code %d\n",
606 tuner_info("Invalid RESET code %d\n",
614 /* Checks for a sleep command */
616 msleep(size & 0x7fff);
620 if ((size + p > endp)) {
621 tuner_err("missing bytes: need %d, have %d\n",
622 size, (int)(endp - p));
630 /* Sends message chunks */
632 int len = (size < priv->ctrl.max_len - 1) ?
633 size : priv->ctrl.max_len - 1;
635 memcpy(buf + 1, p, len);
637 rc = i2c_send(priv, buf, len + 1);
639 tuner_err("%d returned from send\n", rc);
647 /* silently fail if the frontend doesn't support I2C flush */
648 rc = do_tuner_callback(fe, XC2028_I2C_FLUSH, 0);
649 if ((rc < 0) && (rc != -EINVAL)) {
650 tuner_err("error executing flush: %d\n", rc);
657 static int load_scode(struct dvb_frontend *fe, unsigned int type,
658 v4l2_std_id *id, __u16 int_freq, int scode)
660 struct xc2028_data *priv = fe->tuner_priv;
664 tuner_dbg("%s called\n", __func__);
667 pos = seek_firmware(fe, type, id);
671 for (pos = 0; pos < priv->firm_size; pos++) {
672 if ((priv->firm[pos].int_freq == int_freq) &&
673 (priv->firm[pos].type & HAS_IF))
676 if (pos == priv->firm_size)
680 p = priv->firm[pos].ptr;
682 if (priv->firm[pos].type & HAS_IF) {
683 if (priv->firm[pos].size != 12 * 16 || scode >= 16)
687 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
688 * has a 2-byte size header in the firmware format. */
689 if (priv->firm[pos].size != 14 * 16 || scode >= 16 ||
690 le16_to_cpu(*(__le16 *)(p + 14 * scode)) != 12)
695 tuner_info("Loading SCODE for type=");
696 dump_firm_type_and_int_freq(priv->firm[pos].type,
697 priv->firm[pos].int_freq);
698 printk(KERN_CONT "(%x), id %016llx.\n", priv->firm[pos].type,
699 (unsigned long long)*id);
701 if (priv->firm_version < 0x0202)
702 rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
704 rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
708 rc = i2c_send(priv, p, 12);
712 rc = send_seq(priv, {0x00, 0x8c});
719 static int xc2028_sleep(struct dvb_frontend *fe);
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;
730 tuner_dbg("%s called\n", __func__);
732 rc = check_device_status(priv);
736 if (priv->ctrl.mts && !(type & FM))
742 new_fw.std_req = std;
743 new_fw.scode_table = SCODE | priv->ctrl.scode_table;
745 new_fw.int_freq = int_freq;
747 tuner_dbg("checking firmware, user requested type=");
749 dump_firm_type(new_fw.type);
750 printk(KERN_CONT "(%x), id %016llx, ", new_fw.type,
751 (unsigned long long)new_fw.std_req);
753 printk(KERN_CONT "scode_tbl ");
754 dump_firm_type(priv->ctrl.scode_table);
755 printk(KERN_CONT "(%x), ", priv->ctrl.scode_table);
757 printk(KERN_CONT "int_freq %d, ", new_fw.int_freq);
758 printk(KERN_CONT "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");
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);
780 /* BASE firmwares are all std0 */
782 rc = load_firmware(fe, BASE | new_fw.type, &std0);
784 tuner_err("Error %d while loading base firmware\n",
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);
794 rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
796 if (rc < 0 && rc != -ENOENT) {
797 tuner_err("Error %d while loading init1 firmware\n",
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);
818 rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
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");
830 if (new_fw.type & FM)
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);
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");
846 tuner_dbg("Device is Xceive %d version %d.%d, firmware version %d.%d\n",
847 hwmodel, (version & 0xf000) >> 12, (version & 0xf00) >> 8,
848 (version & 0xf0) >> 4, version & 0xf);
851 if (priv->ctrl.read_not_reliable)
852 goto read_not_reliable;
854 /* Check firmware version against what we downloaded. */
855 if (priv->firm_version != ((version & 0xf0) << 4 | (version & 0x0f))) {
856 if (!priv->ctrl.read_not_reliable) {
857 tuner_err("Incorrect readback of firmware version.\n");
860 tuner_err("Returned an incorrect version. However, read is not reliable enough. Ignoring it.\n");
865 /* Check that the tuner hardware model remains consistent over time. */
866 if (priv->hwmodel == 0 && (hwmodel == 2028 || hwmodel == 3028)) {
867 priv->hwmodel = hwmodel;
868 priv->hwvers = version & 0xff00;
869 } else if (priv->hwmodel == 0 || priv->hwmodel != hwmodel ||
870 priv->hwvers != (version & 0xff00)) {
871 tuner_err("Read invalid device hardware information - tuner hung?\n");
876 priv->cur_fw = new_fw;
879 * By setting BASE in cur_fw.type only after successfully loading all
881 * 1. Identify that BASE firmware with type=0 has been loaded;
882 * 2. Tell whether BASE firmware was just changed the next time through.
884 priv->cur_fw.type |= BASE;
885 priv->state = XC2028_ACTIVE;
892 if (retry_count < 8) {
895 tuner_dbg("Retrying firmware load\n");
899 /* Firmware didn't load. Put the device to sleep */
907 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
909 struct xc2028_data *priv = fe->tuner_priv;
910 u16 frq_lock, signal = 0;
913 tuner_dbg("%s called\n", __func__);
915 rc = check_device_status(priv);
919 /* If the device is sleeping, no channel is tuned */
925 mutex_lock(&priv->lock);
927 /* Sync Lock Indicator */
928 for (i = 0; i < 3; i++) {
929 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
938 /* Frequency didn't lock */
942 /* Get SNR of the video signal */
943 rc = xc2028_get_reg(priv, XREG_SNR, &signal);
947 /* Signal level is 3 bits only */
949 signal = ((1 << 12) - 1) | ((signal & 0x07) << 12);
952 mutex_unlock(&priv->lock);
956 tuner_dbg("signal strength is %d\n", signal);
961 static int xc2028_get_afc(struct dvb_frontend *fe, s32 *afc)
963 struct xc2028_data *priv = fe->tuner_priv;
968 rc = check_device_status(priv);
972 /* If the device is sleeping, no channel is tuned */
978 mutex_lock(&priv->lock);
980 /* Sync Lock Indicator */
981 for (i = 0; i < 3; i++) {
982 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
991 /* Frequency didn't lock */
996 rc = xc2028_get_reg(priv, XREG_FREQ_ERROR, &afc_reg);
1000 *afc = afc_reg * 15625; /* Hz */
1002 tuner_dbg("AFC is %d Hz\n", *afc);
1005 mutex_unlock(&priv->lock);
1012 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
1013 enum v4l2_tuner_type new_type,
1018 struct xc2028_data *priv = fe->tuner_priv;
1020 unsigned char buf[4];
1021 u32 div, offset = 0;
1023 tuner_dbg("%s called\n", __func__);
1025 mutex_lock(&priv->lock);
1027 tuner_dbg("should set frequency %d kHz\n", freq / 1000);
1029 if (check_firmware(fe, type, std, int_freq) < 0)
1032 /* On some cases xc2028 can disable video output, if
1033 * very weak signals are received. By sending a soft
1034 * reset, this is re-enabled. So, it is better to always
1035 * send a soft reset before changing channels, to be sure
1036 * that xc2028 will be in a safe state.
1037 * Maybe this might also be needed for DTV.
1040 case V4L2_TUNER_ANALOG_TV:
1041 rc = send_seq(priv, {0x00, 0x00});
1043 /* Analog mode requires offset = 0 */
1045 case V4L2_TUNER_RADIO:
1046 /* Radio mode requires offset = 0 */
1048 case V4L2_TUNER_DIGITAL_TV:
1050 * Digital modes require an offset to adjust to the
1051 * proper frequency. The offset depends on what
1052 * firmware version is used.
1056 * Adjust to the center frequency. This is calculated by the
1057 * formula: offset = 1.25MHz - BW/2
1058 * For DTV 7/8, the firmware uses BW = 8000, so it needs a
1059 * further adjustment to get the frequency center on VHF
1063 * The firmware DTV78 used to work fine in UHF band (8 MHz
1064 * bandwidth) but not at all in VHF band (7 MHz bandwidth).
1065 * The real problem was connected to the formula used to
1066 * calculate the center frequency offset in VHF band.
1067 * In fact, removing the 500KHz adjustment fixed the problem.
1068 * This is coherent to what was implemented for the DTV7
1070 * In the end, now the center frequency is the same for all 3
1071 * firmwares (DTV7, DTV8, DTV78) and doesn't depend on channel
1075 if (priv->cur_fw.type & DTV6)
1077 else /* DTV7 or DTV8 or DTV78 */
1081 * xc3028 additional "magic"
1082 * Depending on the firmware version, it needs some adjustments
1083 * to properly centralize the frequency. This seems to be
1084 * needed to compensate the SCODE table adjustments made by
1089 * The proper adjustment would be to do it at s-code table.
1090 * However, this didn't work, as reported by
1091 * Robert Lowery <rglowery@exemail.com.au>
1096 * Still need tests for XC3028L (firmware 3.2 or upper)
1097 * So, for now, let's just comment the per-firmware
1098 * version of this change. Reports with xc3028l working
1099 * with and without the lines below are welcome
1102 if (priv->firm_version < 0x0302) {
1103 if (priv->cur_fw.type & DTV7)
1106 if (priv->cur_fw.type & DTV7)
1108 else if (type != ATSC) /* DVB @6MHz, DTV 8 and DTV 7/8 */
1114 tuner_err("Unsupported tuner type %d.\n", new_type);
1118 div = (freq - offset + DIV / 2) / DIV;
1120 /* CMD= Set frequency */
1121 if (priv->firm_version < 0x0202)
1122 rc = send_seq(priv, {0x00, XREG_RF_FREQ, 0x00, 0x00});
1124 rc = send_seq(priv, {0x80, XREG_RF_FREQ, 0x00, 0x00});
1128 /* Return code shouldn't be checked.
1129 The reset CLK is needed only with tm6000.
1130 Driver should work fine even if this fails.
1132 if (priv->ctrl.msleep)
1133 msleep(priv->ctrl.msleep);
1134 do_tuner_callback(fe, XC2028_RESET_CLK, 1);
1138 buf[0] = 0xff & (div >> 24);
1139 buf[1] = 0xff & (div >> 16);
1140 buf[2] = 0xff & (div >> 8);
1141 buf[3] = 0xff & (div);
1143 rc = i2c_send(priv, buf, sizeof(buf));
1148 priv->frequency = freq;
1150 tuner_dbg("divisor= %*ph (freq=%d.%03d)\n", 4, buf,
1151 freq / 1000000, (freq % 1000000) / 1000);
1156 mutex_unlock(&priv->lock);
1161 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
1162 struct analog_parameters *p)
1164 struct xc2028_data *priv = fe->tuner_priv;
1165 unsigned int type=0;
1167 tuner_dbg("%s called\n", __func__);
1169 if (p->mode == V4L2_TUNER_RADIO) {
1171 if (priv->ctrl.input1)
1173 return generic_set_freq(fe, (625l * p->frequency) / 10,
1174 V4L2_TUNER_RADIO, type, 0, 0);
1177 /* if std is not defined, choose one */
1179 p->std = V4L2_STD_MN;
1181 /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
1182 if (!(p->std & V4L2_STD_MN))
1185 /* Add audio hack to std mask */
1186 p->std |= parse_audio_std_option();
1188 return generic_set_freq(fe, 62500l * p->frequency,
1189 V4L2_TUNER_ANALOG_TV, type, p->std, 0);
1192 static int xc2028_set_params(struct dvb_frontend *fe)
1194 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
1195 u32 delsys = c->delivery_system;
1196 u32 bw = c->bandwidth_hz;
1197 struct xc2028_data *priv = fe->tuner_priv;
1199 unsigned int type = 0;
1202 tuner_dbg("%s called\n", __func__);
1204 rc = check_device_status(priv);
1212 * The only countries with 6MHz seem to be Taiwan/Uruguay.
1213 * Both seem to require QAM firmware for OFDM decoding
1214 * Tested in Taiwan by Terry Wu <terrywu2009@gmail.com>
1219 switch (priv->ctrl.type) {
1228 /* Zarlink seems to need D2633 */
1229 if (priv->ctrl.demod == XC3028_FE_ZARLINK456)
1236 /* The only ATSC firmware (at least on v2.7) is D2633 */
1237 type |= ATSC | D2633;
1239 /* DVB-S and pure QAM (FE_QAM) are not supported */
1244 if (bw <= 6000000) {
1246 priv->ctrl.vhfbw7 = 0;
1247 priv->ctrl.uhfbw8 = 0;
1248 } else if (bw <= 7000000) {
1249 if (c->frequency < 470000000)
1250 priv->ctrl.vhfbw7 = 1;
1252 priv->ctrl.uhfbw8 = 0;
1253 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV7;
1256 if (c->frequency < 470000000)
1257 priv->ctrl.vhfbw7 = 0;
1259 priv->ctrl.uhfbw8 = 1;
1260 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV8;
1264 /* All S-code tables need a 200kHz shift */
1265 if (priv->ctrl.demod) {
1266 demod = priv->ctrl.demod;
1269 * Newer firmwares require a 200 kHz offset only for ATSC
1271 if (type == ATSC || priv->firm_version < 0x0302)
1274 * The DTV7 S-code table needs a 700 kHz shift.
1276 * DTV7 is only used in Australia. Germany or Italy may also
1277 * use this firmware after initialization, but a tune to a UHF
1278 * channel should then cause DTV78 to be used.
1280 * Unfortunately, on real-field tests, the s-code offset
1281 * didn't work as expected, as reported by
1282 * Robert Lowery <rglowery@exemail.com.au>
1286 return generic_set_freq(fe, c->frequency,
1287 V4L2_TUNER_DIGITAL_TV, type, 0, demod);
1290 static int xc2028_sleep(struct dvb_frontend *fe)
1292 struct xc2028_data *priv = fe->tuner_priv;
1295 rc = check_device_status(priv);
1299 /* Device is already in sleep mode */
1303 /* Avoid firmware reload on slow devices or if PM disabled */
1304 if (no_poweroff || priv->ctrl.disable_power_mgmt)
1307 tuner_dbg("Putting xc2028/3028 into poweroff mode.\n");
1309 tuner_dbg("Printing sleep stack trace:\n");
1313 mutex_lock(&priv->lock);
1315 if (priv->firm_version < 0x0202)
1316 rc = send_seq(priv, {0x00, XREG_POWER_DOWN, 0x00, 0x00});
1318 rc = send_seq(priv, {0x80, XREG_POWER_DOWN, 0x00, 0x00});
1321 priv->state = XC2028_SLEEP;
1323 mutex_unlock(&priv->lock);
1328 static void xc2028_dvb_release(struct dvb_frontend *fe)
1330 struct xc2028_data *priv = fe->tuner_priv;
1332 tuner_dbg("%s called\n", __func__);
1334 mutex_lock(&xc2028_list_mutex);
1336 /* only perform final cleanup if this is the last instance */
1337 if (hybrid_tuner_report_instance_count(priv) == 1)
1338 free_firmware(priv);
1341 hybrid_tuner_release_state(priv);
1343 mutex_unlock(&xc2028_list_mutex);
1345 fe->tuner_priv = NULL;
1348 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1350 struct xc2028_data *priv = fe->tuner_priv;
1353 tuner_dbg("%s called\n", __func__);
1355 rc = check_device_status(priv);
1359 *frequency = priv->frequency;
1364 static void load_firmware_cb(const struct firmware *fw,
1367 struct dvb_frontend *fe = context;
1368 struct xc2028_data *priv = fe->tuner_priv;
1371 tuner_dbg("reject_firmware_nowait(): %s\n", fw ? "OK" : "error");
1373 tuner_err("Could not load firmware %s.\n", priv->fname);
1374 priv->state = XC2028_NODEV;
1378 rc = load_all_firmwares(fe, fw);
1380 release_firmware(fw);
1384 priv->state = XC2028_ACTIVE;
1387 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1389 struct xc2028_data *priv = fe->tuner_priv;
1390 struct xc2028_ctrl *p = priv_cfg;
1393 tuner_dbg("%s called\n", __func__);
1395 mutex_lock(&priv->lock);
1398 * Copy the config data.
1400 memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1403 * If firmware name changed, frees firmware. As free_firmware will
1404 * reset the status to NO_FIRMWARE, this forces a new reject_firmware
1406 if (!firmware_name[0] && p->fname &&
1407 priv->fname && strcmp(p->fname, priv->fname))
1408 free_firmware(priv);
1410 if (priv->ctrl.max_len < 9)
1411 priv->ctrl.max_len = 13;
1413 if (priv->state == XC2028_NO_FIRMWARE) {
1414 if (!firmware_name[0])
1415 priv->fname = kstrdup(p->fname, GFP_KERNEL);
1417 priv->fname = firmware_name;
1424 rc = reject_firmware_nowait(THIS_MODULE, 1,
1426 priv->i2c_props.adap->dev.parent,
1428 fe, load_firmware_cb);
1430 tuner_err("Failed to request firmware %s\n",
1432 priv->state = XC2028_NODEV;
1434 priv->state = XC2028_WAITING_FIRMWARE;
1437 mutex_unlock(&priv->lock);
1442 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1444 .name = "Xceive XC3028",
1445 .frequency_min = 42000000,
1446 .frequency_max = 864000000,
1447 .frequency_step = 50000,
1450 .set_config = xc2028_set_config,
1451 .set_analog_params = xc2028_set_analog_freq,
1452 .release = xc2028_dvb_release,
1453 .get_frequency = xc2028_get_frequency,
1454 .get_rf_strength = xc2028_signal,
1455 .get_afc = xc2028_get_afc,
1456 .set_params = xc2028_set_params,
1457 .sleep = xc2028_sleep,
1460 struct dvb_frontend *xc2028_attach(struct dvb_frontend *fe,
1461 struct xc2028_config *cfg)
1463 struct xc2028_data *priv;
1467 printk(KERN_DEBUG "xc2028: Xcv2028/3028 init called!\n");
1473 printk(KERN_ERR "xc2028: No frontend!\n");
1477 mutex_lock(&xc2028_list_mutex);
1479 instance = hybrid_tuner_request_state(struct xc2028_data, priv,
1480 hybrid_tuner_instance_list,
1481 cfg->i2c_adap, cfg->i2c_addr,
1485 /* memory allocation failure */
1488 /* new tuner instance */
1489 priv->ctrl.max_len = 13;
1491 mutex_init(&priv->lock);
1493 fe->tuner_priv = priv;
1496 /* existing tuner instance */
1497 fe->tuner_priv = priv;
1501 memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1502 sizeof(xc2028_dvb_tuner_ops));
1504 tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1507 xc2028_set_config(fe, cfg->ctrl);
1509 mutex_unlock(&xc2028_list_mutex);
1513 mutex_unlock(&xc2028_list_mutex);
1515 xc2028_dvb_release(fe);
1519 EXPORT_SYMBOL(xc2028_attach);
1521 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1522 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1523 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
1524 MODULE_LICENSE("GPL");