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 "
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"
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 {
87 struct firmware_properties {
92 unsigned int scode_table;
97 XC2028_NO_FIRMWARE = 0,
98 XC2028_WAITING_FIRMWARE,
105 struct list_head hybrid_tuner_instance_list;
106 struct tuner_i2c_props i2c_props;
109 enum xc2028_state state;
112 struct firmware_description *firm;
119 struct xc2028_ctrl ctrl;
121 struct firmware_properties cur_fw;
126 #define i2c_send(priv, buf, size) ({ \
128 _rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size); \
130 tuner_info("i2c output error: rc = %d (should be %d)\n",\
132 if (priv->ctrl.msleep) \
133 msleep(priv->ctrl.msleep); \
137 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({ \
139 _rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize, \
142 tuner_err("i2c input error: rc = %d (should be %d)\n", \
144 if (priv->ctrl.msleep) \
145 msleep(priv->ctrl.msleep); \
149 #define send_seq(priv, data...) ({ \
150 static u8 _val[] = data; \
152 if (sizeof(_val) != \
153 (_rc = tuner_i2c_xfer_send(&priv->i2c_props, \
154 _val, sizeof(_val)))) { \
155 tuner_err("Error on line %d: %d\n", __LINE__, _rc); \
156 } else if (priv->ctrl.msleep) \
157 msleep(priv->ctrl.msleep); \
161 static int xc2028_get_reg(struct xc2028_data *priv, u16 reg, u16 *val)
163 unsigned char buf[2];
164 unsigned char ibuf[2];
166 tuner_dbg("%s %04x called\n", __func__, reg);
169 buf[1] = (unsigned char) reg;
171 if (i2c_send_recv(priv, buf, 2, ibuf, 2) != 2)
174 *val = (ibuf[1]) | (ibuf[0] << 8);
178 #define dump_firm_type(t) dump_firm_type_and_int_freq(t, 0)
179 static void dump_firm_type_and_int_freq(unsigned int type, u16 int_freq)
225 if (type & TOYOTA388)
226 printk("TOYOTA388 ");
227 if (type & TOYOTA794)
228 printk("TOYOTA794 ");
231 if (type & ZARLINK456)
232 printk("ZARLINK456 ");
242 printk("HAS_IF_%d ", int_freq);
245 static v4l2_std_id parse_audio_std_option(void)
247 if (strcasecmp(audio_std, "A2") == 0)
249 if (strcasecmp(audio_std, "A2/A") == 0)
250 return V4L2_STD_A2_A;
251 if (strcasecmp(audio_std, "A2/B") == 0)
252 return V4L2_STD_A2_B;
253 if (strcasecmp(audio_std, "NICAM") == 0)
254 return V4L2_STD_NICAM;
255 if (strcasecmp(audio_std, "NICAM/A") == 0)
256 return V4L2_STD_NICAM_A;
257 if (strcasecmp(audio_std, "NICAM/B") == 0)
258 return V4L2_STD_NICAM_B;
263 static int check_device_status(struct xc2028_data *priv)
265 switch (priv->state) {
266 case XC2028_NO_FIRMWARE:
267 case XC2028_WAITING_FIRMWARE:
279 static void free_firmware(struct xc2028_data *priv)
282 tuner_dbg("%s called\n", __func__);
284 /* free allocated f/w string */
285 if (priv->fname != firmware_name)
289 priv->state = XC2028_NO_FIRMWARE;
290 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
295 for (i = 0; i < priv->firm_size; i++)
296 kfree(priv->firm[i].ptr);
304 static int load_all_firmwares(struct dvb_frontend *fe,
305 const struct firmware *fw)
307 struct xc2028_data *priv = fe->tuner_priv;
308 const unsigned char *p, *endp;
313 tuner_dbg("%s called\n", __func__);
318 if (fw->size < sizeof(name) - 1 + 2 + 2) {
319 tuner_err("Error: firmware file %s has invalid size!\n",
324 memcpy(name, p, sizeof(name) - 1);
325 name[sizeof(name) - 1] = 0;
326 p += sizeof(name) - 1;
328 priv->firm_version = get_unaligned_le16(p);
331 n_array = get_unaligned_le16(p);
334 tuner_info("Loading %d firmware images from %s, type: %s, ver %d.%d\n",
335 n_array, priv->fname, name,
336 priv->firm_version >> 8, priv->firm_version & 0xff);
338 priv->firm = kcalloc(n_array, sizeof(*priv->firm), GFP_KERNEL);
339 if (priv->firm == NULL) {
340 tuner_err("Not enough memory to load firmware file.\n");
344 priv->firm_size = n_array;
354 tuner_err("More firmware images in file than "
359 /* Checks if there's enough bytes to read */
360 if (endp - p < sizeof(type) + sizeof(id) + sizeof(size))
363 type = get_unaligned_le32(p);
366 id = get_unaligned_le64(p);
370 int_freq = get_unaligned_le16(p);
371 p += sizeof(int_freq);
372 if (endp - p < sizeof(size))
376 size = get_unaligned_le32(p);
379 if (!size || size > endp - p) {
380 tuner_err("Firmware type ");
381 dump_firm_type(type);
382 printk("(%x), id %llx is corrupted "
383 "(size=%d, expected %d)\n",
384 type, (unsigned long long)id,
385 (unsigned)(endp - p), size);
389 priv->firm[n].ptr = kzalloc(size, GFP_KERNEL);
390 if (priv->firm[n].ptr == NULL) {
391 tuner_err("Not enough memory to load firmware file.\n");
395 tuner_dbg("Reading firmware type ");
397 dump_firm_type_and_int_freq(type, int_freq);
398 printk("(%x), id %llx, size=%d.\n",
399 type, (unsigned long long)id, size);
402 memcpy(priv->firm[n].ptr, p, size);
403 priv->firm[n].type = type;
404 priv->firm[n].id = id;
405 priv->firm[n].size = size;
406 priv->firm[n].int_freq = int_freq;
411 if (n + 1 != priv->firm_size) {
412 tuner_err("Firmware file is incomplete!\n");
419 tuner_err("Firmware header is incomplete!\n");
422 tuner_err("Error: firmware file is corrupted!\n");
425 tuner_info("Releasing partially loaded firmware file.\n");
430 tuner_dbg("Firmware files loaded.\n");
432 priv->state = XC2028_NODEV;
437 static int seek_firmware(struct dvb_frontend *fe, unsigned int type,
440 struct xc2028_data *priv = fe->tuner_priv;
441 int i, best_i = -1, best_nr_matches = 0;
442 unsigned int type_mask = 0;
444 tuner_dbg("%s called, want type=", __func__);
446 dump_firm_type(type);
447 printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
451 tuner_err("Error! firmware not loaded\n");
455 if (((type & ~SCODE) == 0) && (*id == 0))
459 type_mask = BASE_TYPES;
460 else if (type & SCODE) {
462 type_mask = SCODE_TYPES & ~HAS_IF;
463 } else if (type & DTV_TYPES)
464 type_mask = DTV_TYPES;
465 else if (type & STD_SPECIFIC_TYPES)
466 type_mask = STD_SPECIFIC_TYPES;
473 /* Seek for exact match */
474 for (i = 0; i < priv->firm_size; i++) {
475 if ((type == (priv->firm[i].type & type_mask)) &&
476 (*id == priv->firm[i].id))
480 /* Seek for generic video standard match */
481 for (i = 0; i < priv->firm_size; i++) {
482 v4l2_std_id match_mask;
485 if (type != (priv->firm[i].type & type_mask))
488 match_mask = *id & priv->firm[i].id;
492 if ((*id & match_mask) == *id)
493 goto found; /* Supports all the requested standards */
495 nr_matches = hweight64(match_mask);
496 if (nr_matches > best_nr_matches) {
497 best_nr_matches = nr_matches;
502 if (best_nr_matches > 0) {
503 tuner_dbg("Selecting best matching firmware (%d bits) for "
504 "type=", best_nr_matches);
505 dump_firm_type(type);
506 printk("(%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("(%x), id %016llx.\n", type, (unsigned long long)*id);
528 static inline int do_tuner_callback(struct dvb_frontend *fe, int cmd, int arg)
530 struct xc2028_data *priv = fe->tuner_priv;
532 /* analog side (tuner-core) uses i2c_adap->algo_data.
533 * digital side is not guaranteed to have algo_data defined.
535 * digital side will always have fe->dvb defined.
536 * analog side (tuner-core) doesn't (yet) define fe->dvb.
539 return (!fe->callback) ? -EINVAL :
540 fe->callback(((fe->dvb) && (fe->dvb->priv)) ?
541 fe->dvb->priv : priv->i2c_props.adap->algo_data,
542 DVB_FRONTEND_COMPONENT_TUNER, cmd, arg);
545 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
548 struct xc2028_data *priv = fe->tuner_priv;
550 unsigned char *p, *endp, buf[MAX_XFER_SIZE];
552 if (priv->ctrl.max_len > sizeof(buf))
553 priv->ctrl.max_len = sizeof(buf);
555 tuner_dbg("%s called\n", __func__);
557 pos = seek_firmware(fe, type, id);
561 tuner_info("Loading firmware for type=");
562 dump_firm_type(priv->firm[pos].type);
563 printk("(%x), id %016llx.\n", priv->firm[pos].type,
564 (unsigned long long)*id);
566 p = priv->firm[pos].ptr;
567 endp = p + priv->firm[pos].size;
572 /* Checks if there's enough bytes to read */
573 if (p + sizeof(size) > endp) {
574 tuner_err("Firmware chunk size is wrong\n");
578 size = le16_to_cpu(*(__le16 *) p);
585 /* Special callback command received */
586 rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
588 tuner_err("Error at RESET code %d\n",
594 if (size >= 0xff00) {
597 rc = do_tuner_callback(fe, XC2028_RESET_CLK, 0);
599 tuner_err("Error at RESET code %d\n",
605 tuner_info("Invalid RESET code %d\n",
613 /* Checks for a sleep command */
615 msleep(size & 0x7fff);
619 if ((size + p > endp)) {
620 tuner_err("missing bytes: need %d, have %d\n",
621 size, (int)(endp - p));
629 /* Sends message chunks */
631 int len = (size < priv->ctrl.max_len - 1) ?
632 size : priv->ctrl.max_len - 1;
634 memcpy(buf + 1, p, len);
636 rc = i2c_send(priv, buf, len + 1);
638 tuner_err("%d returned from send\n", rc);
646 /* silently fail if the frontend doesn't support I2C flush */
647 rc = do_tuner_callback(fe, XC2028_I2C_FLUSH, 0);
648 if ((rc < 0) && (rc != -EINVAL)) {
649 tuner_err("error executing flush: %d\n", rc);
656 static int load_scode(struct dvb_frontend *fe, unsigned int type,
657 v4l2_std_id *id, __u16 int_freq, int scode)
659 struct xc2028_data *priv = fe->tuner_priv;
663 tuner_dbg("%s called\n", __func__);
666 pos = seek_firmware(fe, type, id);
670 for (pos = 0; pos < priv->firm_size; pos++) {
671 if ((priv->firm[pos].int_freq == int_freq) &&
672 (priv->firm[pos].type & HAS_IF))
675 if (pos == priv->firm_size)
679 p = priv->firm[pos].ptr;
681 if (priv->firm[pos].type & HAS_IF) {
682 if (priv->firm[pos].size != 12 * 16 || scode >= 16)
686 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
687 * has a 2-byte size header in the firmware format. */
688 if (priv->firm[pos].size != 14 * 16 || scode >= 16 ||
689 le16_to_cpu(*(__le16 *)(p + 14 * scode)) != 12)
694 tuner_info("Loading SCODE for type=");
695 dump_firm_type_and_int_freq(priv->firm[pos].type,
696 priv->firm[pos].int_freq);
697 printk("(%x), id %016llx.\n", priv->firm[pos].type,
698 (unsigned long long)*id);
700 if (priv->firm_version < 0x0202)
701 rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
703 rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
707 rc = i2c_send(priv, p, 12);
711 rc = send_seq(priv, {0x00, 0x8c});
718 static int xc2028_sleep(struct dvb_frontend *fe);
720 static int check_firmware(struct dvb_frontend *fe, unsigned int type,
721 v4l2_std_id std, __u16 int_freq)
723 struct xc2028_data *priv = fe->tuner_priv;
724 struct firmware_properties new_fw;
725 int rc, retry_count = 0;
726 u16 version, hwmodel;
729 tuner_dbg("%s called\n", __func__);
731 rc = check_device_status(priv);
735 if (priv->ctrl.mts && !(type & FM))
741 new_fw.std_req = std;
742 new_fw.scode_table = SCODE | priv->ctrl.scode_table;
744 new_fw.int_freq = int_freq;
746 tuner_dbg("checking firmware, user requested type=");
748 dump_firm_type(new_fw.type);
749 printk("(%x), id %016llx, ", new_fw.type,
750 (unsigned long long)new_fw.std_req);
752 printk("scode_tbl ");
753 dump_firm_type(priv->ctrl.scode_table);
754 printk("(%x), ", priv->ctrl.scode_table);
756 printk("int_freq %d, ", new_fw.int_freq);
757 printk("scode_nr %d\n", new_fw.scode_nr);
761 * No need to reload base firmware if it matches and if the tuner
762 * is not at sleep mode
764 if ((priv->state == XC2028_ACTIVE) &&
765 (((BASE | new_fw.type) & BASE_TYPES) ==
766 (priv->cur_fw.type & BASE_TYPES))) {
767 tuner_dbg("BASE firmware not changed.\n");
771 /* Updating BASE - forget about all currently loaded firmware */
772 memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
774 /* Reset is needed before loading firmware */
775 rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
779 /* BASE firmwares are all std0 */
781 rc = load_firmware(fe, BASE | new_fw.type, &std0);
783 tuner_err("Error %d while loading base firmware\n",
788 /* Load INIT1, if needed */
789 tuner_dbg("Load init1 firmware, if exists\n");
791 rc = load_firmware(fe, BASE | INIT1 | new_fw.type, &std0);
793 rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
795 if (rc < 0 && rc != -ENOENT) {
796 tuner_err("Error %d while loading init1 firmware\n",
803 * No need to reload standard specific firmware if base firmware
804 * was not reloaded and requested video standards have not changed.
806 if (priv->cur_fw.type == (BASE | new_fw.type) &&
807 priv->cur_fw.std_req == std) {
808 tuner_dbg("Std-specific firmware already loaded.\n");
809 goto skip_std_specific;
812 /* Reloading std-specific firmware forces a SCODE update */
813 priv->cur_fw.scode_table = 0;
815 rc = load_firmware(fe, new_fw.type, &new_fw.id);
817 rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
823 if (priv->cur_fw.scode_table == new_fw.scode_table &&
824 priv->cur_fw.scode_nr == new_fw.scode_nr) {
825 tuner_dbg("SCODE firmware already loaded.\n");
829 if (new_fw.type & FM)
832 /* Load SCODE firmware, if exists */
833 tuner_dbg("Trying to load scode %d\n", new_fw.scode_nr);
835 rc = load_scode(fe, new_fw.type | new_fw.scode_table, &new_fw.id,
836 new_fw.int_freq, new_fw.scode_nr);
839 if (xc2028_get_reg(priv, 0x0004, &version) < 0 ||
840 xc2028_get_reg(priv, 0x0008, &hwmodel) < 0) {
841 tuner_err("Unable to read tuner registers.\n");
845 tuner_dbg("Device is Xceive %d version %d.%d, "
846 "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, "
861 "read is not reliable enough. Ignoring it.\n");
866 /* Check that the tuner hardware model remains consistent over time. */
867 if (priv->hwmodel == 0 && (hwmodel == 2028 || hwmodel == 3028)) {
868 priv->hwmodel = hwmodel;
869 priv->hwvers = version & 0xff00;
870 } else if (priv->hwmodel == 0 || priv->hwmodel != hwmodel ||
871 priv->hwvers != (version & 0xff00)) {
872 tuner_err("Read invalid device hardware information - tuner "
878 priv->cur_fw = new_fw;
881 * By setting BASE in cur_fw.type only after successfully loading all
883 * 1. Identify that BASE firmware with type=0 has been loaded;
884 * 2. Tell whether BASE firmware was just changed the next time through.
886 priv->cur_fw.type |= BASE;
887 priv->state = XC2028_ACTIVE;
894 if (retry_count < 8) {
897 tuner_dbg("Retrying firmware load\n");
901 /* Firmware didn't load. Put the device to sleep */
909 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
911 struct xc2028_data *priv = fe->tuner_priv;
912 u16 frq_lock, signal = 0;
915 tuner_dbg("%s called\n", __func__);
917 rc = check_device_status(priv);
921 /* If the device is sleeping, no channel is tuned */
927 mutex_lock(&priv->lock);
929 /* Sync Lock Indicator */
930 for (i = 0; i < 3; i++) {
931 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
940 /* Frequency didn't lock */
944 /* Get SNR of the video signal */
945 rc = xc2028_get_reg(priv, XREG_SNR, &signal);
949 /* Signal level is 3 bits only */
951 signal = ((1 << 12) - 1) | ((signal & 0x07) << 12);
954 mutex_unlock(&priv->lock);
958 tuner_dbg("signal strength is %d\n", signal);
963 static int xc2028_get_afc(struct dvb_frontend *fe, s32 *afc)
965 struct xc2028_data *priv = fe->tuner_priv;
970 rc = check_device_status(priv);
974 /* If the device is sleeping, no channel is tuned */
980 mutex_lock(&priv->lock);
982 /* Sync Lock Indicator */
983 for (i = 0; i < 3; i++) {
984 rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
993 /* Frequency didn't lock */
998 rc = xc2028_get_reg(priv, XREG_FREQ_ERROR, &afc_reg);
1002 *afc = afc_reg * 15625; /* Hz */
1004 tuner_dbg("AFC is %d Hz\n", *afc);
1007 mutex_unlock(&priv->lock);
1014 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
1015 enum v4l2_tuner_type new_type,
1020 struct xc2028_data *priv = fe->tuner_priv;
1022 unsigned char buf[4];
1023 u32 div, offset = 0;
1025 tuner_dbg("%s called\n", __func__);
1027 mutex_lock(&priv->lock);
1029 tuner_dbg("should set frequency %d kHz\n", freq / 1000);
1031 if (check_firmware(fe, type, std, int_freq) < 0)
1034 /* On some cases xc2028 can disable video output, if
1035 * very weak signals are received. By sending a soft
1036 * reset, this is re-enabled. So, it is better to always
1037 * send a soft reset before changing channels, to be sure
1038 * that xc2028 will be in a safe state.
1039 * Maybe this might also be needed for DTV.
1042 case V4L2_TUNER_ANALOG_TV:
1043 rc = send_seq(priv, {0x00, 0x00});
1045 /* Analog mode requires offset = 0 */
1047 case V4L2_TUNER_RADIO:
1048 /* Radio mode requires offset = 0 */
1050 case V4L2_TUNER_DIGITAL_TV:
1052 * Digital modes require an offset to adjust to the
1053 * proper frequency. The offset depends on what
1054 * firmware version is used.
1058 * Adjust to the center frequency. This is calculated by the
1059 * formula: offset = 1.25MHz - BW/2
1060 * For DTV 7/8, the firmware uses BW = 8000, so it needs a
1061 * further adjustment to get the frequency center on VHF
1065 * The firmware DTV78 used to work fine in UHF band (8 MHz
1066 * bandwidth) but not at all in VHF band (7 MHz bandwidth).
1067 * The real problem was connected to the formula used to
1068 * calculate the center frequency offset in VHF band.
1069 * In fact, removing the 500KHz adjustment fixed the problem.
1070 * This is coherent to what was implemented for the DTV7
1072 * In the end, now the center frequency is the same for all 3
1073 * firmwares (DTV7, DTV8, DTV78) and doesn't depend on channel
1077 if (priv->cur_fw.type & DTV6)
1079 else /* DTV7 or DTV8 or DTV78 */
1083 * xc3028 additional "magic"
1084 * Depending on the firmware version, it needs some adjustments
1085 * to properly centralize the frequency. This seems to be
1086 * needed to compensate the SCODE table adjustments made by
1091 * The proper adjustment would be to do it at s-code table.
1092 * However, this didn't work, as reported by
1093 * Robert Lowery <rglowery@exemail.com.au>
1098 * Still need tests for XC3028L (firmware 3.2 or upper)
1099 * So, for now, let's just comment the per-firmware
1100 * version of this change. Reports with xc3028l working
1101 * with and without the lines below are welcome
1104 if (priv->firm_version < 0x0302) {
1105 if (priv->cur_fw.type & DTV7)
1108 if (priv->cur_fw.type & DTV7)
1110 else if (type != ATSC) /* DVB @6MHz, DTV 8 and DTV 7/8 */
1116 tuner_err("Unsupported tuner type %d.\n", new_type);
1120 div = (freq - offset + DIV / 2) / DIV;
1122 /* CMD= Set frequency */
1123 if (priv->firm_version < 0x0202)
1124 rc = send_seq(priv, {0x00, XREG_RF_FREQ, 0x00, 0x00});
1126 rc = send_seq(priv, {0x80, XREG_RF_FREQ, 0x00, 0x00});
1130 /* Return code shouldn't be checked.
1131 The reset CLK is needed only with tm6000.
1132 Driver should work fine even if this fails.
1134 if (priv->ctrl.msleep)
1135 msleep(priv->ctrl.msleep);
1136 do_tuner_callback(fe, XC2028_RESET_CLK, 1);
1140 buf[0] = 0xff & (div >> 24);
1141 buf[1] = 0xff & (div >> 16);
1142 buf[2] = 0xff & (div >> 8);
1143 buf[3] = 0xff & (div);
1145 rc = i2c_send(priv, buf, sizeof(buf));
1150 priv->frequency = freq;
1152 tuner_dbg("divisor= %*ph (freq=%d.%03d)\n", 4, buf,
1153 freq / 1000000, (freq % 1000000) / 1000);
1158 mutex_unlock(&priv->lock);
1163 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
1164 struct analog_parameters *p)
1166 struct xc2028_data *priv = fe->tuner_priv;
1167 unsigned int type=0;
1169 tuner_dbg("%s called\n", __func__);
1171 if (p->mode == V4L2_TUNER_RADIO) {
1173 if (priv->ctrl.input1)
1175 return generic_set_freq(fe, (625l * p->frequency) / 10,
1176 V4L2_TUNER_RADIO, type, 0, 0);
1179 /* if std is not defined, choose one */
1181 p->std = V4L2_STD_MN;
1183 /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
1184 if (!(p->std & V4L2_STD_MN))
1187 /* Add audio hack to std mask */
1188 p->std |= parse_audio_std_option();
1190 return generic_set_freq(fe, 62500l * p->frequency,
1191 V4L2_TUNER_ANALOG_TV, type, p->std, 0);
1194 static int xc2028_set_params(struct dvb_frontend *fe)
1196 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
1197 u32 delsys = c->delivery_system;
1198 u32 bw = c->bandwidth_hz;
1199 struct xc2028_data *priv = fe->tuner_priv;
1201 unsigned int type = 0;
1204 tuner_dbg("%s called\n", __func__);
1206 rc = check_device_status(priv);
1214 * The only countries with 6MHz seem to be Taiwan/Uruguay.
1215 * Both seem to require QAM firmware for OFDM decoding
1216 * Tested in Taiwan by Terry Wu <terrywu2009@gmail.com>
1221 switch (priv->ctrl.type) {
1230 /* Zarlink seems to need D2633 */
1231 if (priv->ctrl.demod == XC3028_FE_ZARLINK456)
1238 /* The only ATSC firmware (at least on v2.7) is D2633 */
1239 type |= ATSC | D2633;
1241 /* DVB-S and pure QAM (FE_QAM) are not supported */
1246 if (bw <= 6000000) {
1248 priv->ctrl.vhfbw7 = 0;
1249 priv->ctrl.uhfbw8 = 0;
1250 } else if (bw <= 7000000) {
1251 if (c->frequency < 470000000)
1252 priv->ctrl.vhfbw7 = 1;
1254 priv->ctrl.uhfbw8 = 0;
1255 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV7;
1258 if (c->frequency < 470000000)
1259 priv->ctrl.vhfbw7 = 0;
1261 priv->ctrl.uhfbw8 = 1;
1262 type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV8;
1266 /* All S-code tables need a 200kHz shift */
1267 if (priv->ctrl.demod) {
1268 demod = priv->ctrl.demod;
1271 * Newer firmwares require a 200 kHz offset only for ATSC
1273 if (type == ATSC || priv->firm_version < 0x0302)
1276 * The DTV7 S-code table needs a 700 kHz shift.
1278 * DTV7 is only used in Australia. Germany or Italy may also
1279 * use this firmware after initialization, but a tune to a UHF
1280 * channel should then cause DTV78 to be used.
1282 * Unfortunately, on real-field tests, the s-code offset
1283 * didn't work as expected, as reported by
1284 * Robert Lowery <rglowery@exemail.com.au>
1288 return generic_set_freq(fe, c->frequency,
1289 V4L2_TUNER_DIGITAL_TV, type, 0, demod);
1292 static int xc2028_sleep(struct dvb_frontend *fe)
1294 struct xc2028_data *priv = fe->tuner_priv;
1297 rc = check_device_status(priv);
1301 /* Device is already in sleep mode */
1305 /* Avoid firmware reload on slow devices or if PM disabled */
1306 if (no_poweroff || priv->ctrl.disable_power_mgmt)
1309 tuner_dbg("Putting xc2028/3028 into poweroff mode.\n");
1311 tuner_dbg("Printing sleep stack trace:\n");
1315 mutex_lock(&priv->lock);
1317 if (priv->firm_version < 0x0202)
1318 rc = send_seq(priv, {0x00, XREG_POWER_DOWN, 0x00, 0x00});
1320 rc = send_seq(priv, {0x80, XREG_POWER_DOWN, 0x00, 0x00});
1323 priv->state = XC2028_SLEEP;
1325 mutex_unlock(&priv->lock);
1330 static int xc2028_dvb_release(struct dvb_frontend *fe)
1332 struct xc2028_data *priv = fe->tuner_priv;
1334 tuner_dbg("%s called\n", __func__);
1336 mutex_lock(&xc2028_list_mutex);
1338 /* only perform final cleanup if this is the last instance */
1339 if (hybrid_tuner_report_instance_count(priv) == 1)
1340 free_firmware(priv);
1343 hybrid_tuner_release_state(priv);
1345 mutex_unlock(&xc2028_list_mutex);
1347 fe->tuner_priv = NULL;
1352 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1354 struct xc2028_data *priv = fe->tuner_priv;
1357 tuner_dbg("%s called\n", __func__);
1359 rc = check_device_status(priv);
1363 *frequency = priv->frequency;
1368 static void load_firmware_cb(const struct firmware *fw,
1371 struct dvb_frontend *fe = context;
1372 struct xc2028_data *priv = fe->tuner_priv;
1375 tuner_dbg("reject_firmware_nowait(): %s\n", fw ? "OK" : "error");
1377 tuner_err("Could not load firmware %s.\n", priv->fname);
1378 priv->state = XC2028_NODEV;
1382 rc = load_all_firmwares(fe, fw);
1384 release_firmware(fw);
1388 priv->state = XC2028_ACTIVE;
1391 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1393 struct xc2028_data *priv = fe->tuner_priv;
1394 struct xc2028_ctrl *p = priv_cfg;
1397 tuner_dbg("%s called\n", __func__);
1399 mutex_lock(&priv->lock);
1402 * Copy the config data.
1404 memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1407 * If firmware name changed, frees firmware. As free_firmware will
1408 * reset the status to NO_FIRMWARE, this forces a new reject_firmware
1410 if (!firmware_name[0] && p->fname &&
1411 priv->fname && strcmp(p->fname, priv->fname))
1412 free_firmware(priv);
1414 if (priv->ctrl.max_len < 9)
1415 priv->ctrl.max_len = 13;
1417 if (priv->state == XC2028_NO_FIRMWARE) {
1418 if (!firmware_name[0])
1419 priv->fname = kstrdup(p->fname, GFP_KERNEL);
1421 priv->fname = firmware_name;
1428 rc = reject_firmware_nowait(THIS_MODULE, 1,
1430 priv->i2c_props.adap->dev.parent,
1432 fe, load_firmware_cb);
1434 tuner_err("Failed to request firmware %s\n",
1436 priv->state = XC2028_NODEV;
1438 priv->state = XC2028_WAITING_FIRMWARE;
1441 mutex_unlock(&priv->lock);
1446 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1448 .name = "Xceive XC3028",
1449 .frequency_min = 42000000,
1450 .frequency_max = 864000000,
1451 .frequency_step = 50000,
1454 .set_config = xc2028_set_config,
1455 .set_analog_params = xc2028_set_analog_freq,
1456 .release = xc2028_dvb_release,
1457 .get_frequency = xc2028_get_frequency,
1458 .get_rf_strength = xc2028_signal,
1459 .get_afc = xc2028_get_afc,
1460 .set_params = xc2028_set_params,
1461 .sleep = xc2028_sleep,
1464 struct dvb_frontend *xc2028_attach(struct dvb_frontend *fe,
1465 struct xc2028_config *cfg)
1467 struct xc2028_data *priv;
1471 printk(KERN_DEBUG "xc2028: Xcv2028/3028 init called!\n");
1477 printk(KERN_ERR "xc2028: No frontend!\n");
1481 mutex_lock(&xc2028_list_mutex);
1483 instance = hybrid_tuner_request_state(struct xc2028_data, priv,
1484 hybrid_tuner_instance_list,
1485 cfg->i2c_adap, cfg->i2c_addr,
1489 /* memory allocation failure */
1492 /* new tuner instance */
1493 priv->ctrl.max_len = 13;
1495 mutex_init(&priv->lock);
1497 fe->tuner_priv = priv;
1500 /* existing tuner instance */
1501 fe->tuner_priv = priv;
1505 memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1506 sizeof(xc2028_dvb_tuner_ops));
1508 tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1511 xc2028_set_config(fe, cfg->ctrl);
1513 mutex_unlock(&xc2028_list_mutex);
1517 mutex_unlock(&xc2028_list_mutex);
1519 xc2028_dvb_release(fe);
1523 EXPORT_SYMBOL(xc2028_attach);
1525 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1526 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1527 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@infradead.org>");
1528 MODULE_LICENSE("GPL");