1 // SPDX-License-Identifier: GPL-2.0
4 // Copyright (c) 2007-2008 Mauro Carvalho Chehab <mchehab@kernel.org>
6 // Copyright (c) 2007 Michel Ludwig (michel.ludwig@gmail.com)
7 // - frontend interface
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
42 #define XREG_ADC_ENV 0x0100
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"
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
{
84 struct firmware_properties
{
89 unsigned int scode_table
;
94 XC2028_NO_FIRMWARE
= 0,
95 XC2028_WAITING_FIRMWARE
,
102 struct list_head hybrid_tuner_instance_list
;
103 struct tuner_i2c_props i2c_props
;
106 enum xc2028_state state
;
109 struct firmware_description
*firm
;
116 struct xc2028_ctrl ctrl
;
118 struct firmware_properties cur_fw
;
123 #define i2c_send(priv, buf, size) ({ \
125 _rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size); \
127 tuner_info("i2c output error: rc = %d (should be %d)\n",\
129 if (priv->ctrl.msleep) \
130 msleep(priv->ctrl.msleep); \
134 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({ \
136 _rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize, \
139 tuner_err("i2c input error: rc = %d (should be %d)\n", \
141 if (priv->ctrl.msleep) \
142 msleep(priv->ctrl.msleep); \
146 #define send_seq(priv, data...) ({ \
147 static u8 _val[] = data; \
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); \
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
);
166 buf
[1] = (unsigned char) reg
;
168 if (i2c_send_recv(priv
, buf
, 2, ibuf
, 2) != 2)
171 *val
= (ibuf
[1]) | (ibuf
[0] << 8);
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
)
179 printk(KERN_CONT
"BASE ");
181 printk(KERN_CONT
"INIT1 ");
183 printk(KERN_CONT
"F8MHZ ");
185 printk(KERN_CONT
"MTS ");
187 printk(KERN_CONT
"D2620 ");
189 printk(KERN_CONT
"D2633 ");
191 printk(KERN_CONT
"DTV6 ");
193 printk(KERN_CONT
"QAM ");
195 printk(KERN_CONT
"DTV7 ");
197 printk(KERN_CONT
"DTV78 ");
199 printk(KERN_CONT
"DTV8 ");
201 printk(KERN_CONT
"FM ");
203 printk(KERN_CONT
"INPUT1 ");
205 printk(KERN_CONT
"LCD ");
207 printk(KERN_CONT
"NOGD ");
209 printk(KERN_CONT
"MONO ");
211 printk(KERN_CONT
"ATSC ");
213 printk(KERN_CONT
"IF ");
215 printk(KERN_CONT
"LG60 ");
217 printk(KERN_CONT
"ATI638 ");
219 printk(KERN_CONT
"OREN538 ");
221 printk(KERN_CONT
"OREN36 ");
222 if (type
& TOYOTA388
)
223 printk(KERN_CONT
"TOYOTA388 ");
224 if (type
& TOYOTA794
)
225 printk(KERN_CONT
"TOYOTA794 ");
227 printk(KERN_CONT
"DIBCOM52 ");
228 if (type
& ZARLINK456
)
229 printk(KERN_CONT
"ZARLINK456 ");
231 printk(KERN_CONT
"CHINA ");
233 printk(KERN_CONT
"F6MHZ ");
235 printk(KERN_CONT
"INPUT2 ");
237 printk(KERN_CONT
"SCODE ");
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)
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
;
260 static int check_device_status(struct xc2028_data
*priv
)
262 switch (priv
->state
) {
263 case XC2028_NO_FIRMWARE
:
264 case XC2028_WAITING_FIRMWARE
:
276 static void free_firmware(struct xc2028_data
*priv
)
279 tuner_dbg("%s called\n", __func__
);
281 /* free allocated f/w string */
282 if (priv
->fname
!= firmware_name
)
286 priv
->state
= XC2028_NO_FIRMWARE
;
287 memset(&priv
->cur_fw
, 0, sizeof(priv
->cur_fw
));
292 for (i
= 0; i
< priv
->firm_size
; i
++)
293 kfree(priv
->firm
[i
].ptr
);
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
;
310 tuner_dbg("%s called\n", __func__
);
315 if (fw
->size
< sizeof(name
) - 1 + 2 + 2) {
316 tuner_err("Error: firmware file %s has invalid size!\n",
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
);
328 n_array
= get_unaligned_le16(p
);
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");
341 priv
->firm_size
= n_array
;
351 tuner_err("More firmware images in file than were expected!\n");
355 /* Checks if there's enough bytes to read */
356 if (endp
- p
< sizeof(type
) + sizeof(id
) + sizeof(size
))
359 type
= get_unaligned_le32(p
);
362 id
= get_unaligned_le64(p
);
366 int_freq
= get_unaligned_le16(p
);
367 p
+= sizeof(int_freq
);
368 if (endp
- p
< sizeof(size
))
372 size
= get_unaligned_le32(p
);
375 if (!size
|| size
> endp
- p
) {
376 tuner_err("Firmware type ");
377 dump_firm_type(type
);
379 "(%x), id %llx is corrupted (size=%zd, expected %d)\n",
380 type
, (unsigned long long)id
, (endp
- p
), size
);
384 priv
->firm
[n
].ptr
= kzalloc(size
, GFP_KERNEL
);
385 if (priv
->firm
[n
].ptr
== NULL
) {
386 tuner_err("Not enough memory to load firmware file.\n");
390 tuner_dbg("Reading firmware type ");
392 dump_firm_type_and_int_freq(type
, int_freq
);
393 printk(KERN_CONT
"(%x), id %llx, size=%d.\n",
394 type
, (unsigned long long)id
, size
);
397 memcpy(priv
->firm
[n
].ptr
, p
, size
);
398 priv
->firm
[n
].type
= type
;
399 priv
->firm
[n
].id
= id
;
400 priv
->firm
[n
].size
= size
;
401 priv
->firm
[n
].int_freq
= int_freq
;
406 if (n
+ 1 != priv
->firm_size
) {
407 tuner_err("Firmware file is incomplete!\n");
414 tuner_err("Firmware header is incomplete!\n");
417 tuner_err("Error: firmware file is corrupted!\n");
420 tuner_info("Releasing partially loaded firmware file.\n");
425 tuner_dbg("Firmware files loaded.\n");
427 priv
->state
= XC2028_NODEV
;
432 static int seek_firmware(struct dvb_frontend
*fe
, unsigned int type
,
435 struct xc2028_data
*priv
= fe
->tuner_priv
;
436 int i
, best_i
= -1, best_nr_matches
= 0;
437 unsigned int type_mask
= 0;
439 tuner_dbg("%s called, want type=", __func__
);
441 dump_firm_type(type
);
442 printk(KERN_CONT
"(%x), id %016llx.\n",
443 type
, (unsigned long long)*id
);
447 tuner_err("Error! firmware not loaded\n");
451 if (((type
& ~SCODE
) == 0) && (*id
== 0))
455 type_mask
= BASE_TYPES
;
456 else if (type
& SCODE
) {
458 type_mask
= SCODE_TYPES
& ~HAS_IF
;
459 } else if (type
& DTV_TYPES
)
460 type_mask
= DTV_TYPES
;
461 else if (type
& STD_SPECIFIC_TYPES
)
462 type_mask
= STD_SPECIFIC_TYPES
;
469 /* Seek for exact match */
470 for (i
= 0; i
< priv
->firm_size
; i
++) {
471 if ((type
== (priv
->firm
[i
].type
& type_mask
)) &&
472 (*id
== priv
->firm
[i
].id
))
476 /* Seek for generic video standard match */
477 for (i
= 0; i
< priv
->firm_size
; i
++) {
478 v4l2_std_id match_mask
;
481 if (type
!= (priv
->firm
[i
].type
& type_mask
))
484 match_mask
= *id
& priv
->firm
[i
].id
;
488 if ((*id
& match_mask
) == *id
)
489 goto found
; /* Supports all the requested standards */
491 nr_matches
= hweight64(match_mask
);
492 if (nr_matches
> best_nr_matches
) {
493 best_nr_matches
= nr_matches
;
498 if (best_nr_matches
> 0) {
499 tuner_dbg("Selecting best matching firmware (%d bits) for type=",
501 dump_firm_type(type
);
503 "(%x), id %016llx:\n", type
, (unsigned long long)*id
);
508 /*FIXME: Would make sense to seek for type "hint" match ? */
514 *id
= priv
->firm
[i
].id
;
517 tuner_dbg("%s firmware for type=", (i
< 0) ? "Can't find" : "Found");
519 dump_firm_type(type
);
520 printk(KERN_CONT
"(%x), id %016llx.\n",
521 type
, (unsigned long long)*id
);
526 static inline int do_tuner_callback(struct dvb_frontend
*fe
, int cmd
, int arg
)
528 struct xc2028_data
*priv
= fe
->tuner_priv
;
530 /* analog side (tuner-core) uses i2c_adap->algo_data.
531 * digital side is not guaranteed to have algo_data defined.
533 * digital side will always have fe->dvb defined.
534 * analog side (tuner-core) doesn't (yet) define fe->dvb.
537 return (!fe
->callback
) ? -EINVAL
:
538 fe
->callback(((fe
->dvb
) && (fe
->dvb
->priv
)) ?
539 fe
->dvb
->priv
: priv
->i2c_props
.adap
->algo_data
,
540 DVB_FRONTEND_COMPONENT_TUNER
, cmd
, arg
);
543 static int load_firmware(struct dvb_frontend
*fe
, unsigned int type
,
546 struct xc2028_data
*priv
= fe
->tuner_priv
;
548 unsigned char *p
, *endp
, buf
[MAX_XFER_SIZE
];
550 if (priv
->ctrl
.max_len
> sizeof(buf
))
551 priv
->ctrl
.max_len
= sizeof(buf
);
553 tuner_dbg("%s called\n", __func__
);
555 pos
= seek_firmware(fe
, type
, id
);
559 tuner_info("Loading firmware for type=");
560 dump_firm_type(priv
->firm
[pos
].type
);
561 printk(KERN_CONT
"(%x), id %016llx.\n",
562 priv
->firm
[pos
].type
, (unsigned long long)*id
);
564 p
= priv
->firm
[pos
].ptr
;
565 endp
= p
+ priv
->firm
[pos
].size
;
570 /* Checks if there's enough bytes to read */
571 if (p
+ sizeof(size
) > endp
) {
572 tuner_err("Firmware chunk size is wrong\n");
576 size
= le16_to_cpu(*(__le16
*) p
);
583 /* Special callback command received */
584 rc
= do_tuner_callback(fe
, XC2028_TUNER_RESET
, 0);
586 tuner_err("Error at RESET code %d\n",
592 if (size
>= 0xff00) {
595 rc
= do_tuner_callback(fe
, XC2028_RESET_CLK
, 0);
597 tuner_err("Error at RESET code %d\n",
603 tuner_info("Invalid RESET code %d\n",
611 /* Checks for a sleep command */
613 msleep(size
& 0x7fff);
617 if ((size
+ p
> endp
)) {
618 tuner_err("missing bytes: need %d, have %zd\n",
627 /* Sends message chunks */
629 int len
= (size
< priv
->ctrl
.max_len
- 1) ?
630 size
: priv
->ctrl
.max_len
- 1;
632 memcpy(buf
+ 1, p
, len
);
634 rc
= i2c_send(priv
, buf
, len
+ 1);
636 tuner_err("%d returned from send\n", rc
);
644 /* silently fail if the frontend doesn't support I2C flush */
645 rc
= do_tuner_callback(fe
, XC2028_I2C_FLUSH
, 0);
646 if ((rc
< 0) && (rc
!= -EINVAL
)) {
647 tuner_err("error executing flush: %d\n", rc
);
654 static int load_scode(struct dvb_frontend
*fe
, unsigned int type
,
655 v4l2_std_id
*id
, __u16 int_freq
, int scode
)
657 struct xc2028_data
*priv
= fe
->tuner_priv
;
661 tuner_dbg("%s called\n", __func__
);
664 pos
= seek_firmware(fe
, type
, id
);
668 for (pos
= 0; pos
< priv
->firm_size
; pos
++) {
669 if ((priv
->firm
[pos
].int_freq
== int_freq
) &&
670 (priv
->firm
[pos
].type
& HAS_IF
))
673 if (pos
== priv
->firm_size
)
677 p
= priv
->firm
[pos
].ptr
;
679 if (priv
->firm
[pos
].type
& HAS_IF
) {
680 if (priv
->firm
[pos
].size
!= 12 * 16 || scode
>= 16)
684 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
685 * has a 2-byte size header in the firmware format. */
686 if (priv
->firm
[pos
].size
!= 14 * 16 || scode
>= 16 ||
687 le16_to_cpu(*(__le16
*)(p
+ 14 * scode
)) != 12)
692 tuner_info("Loading SCODE for type=");
693 dump_firm_type_and_int_freq(priv
->firm
[pos
].type
,
694 priv
->firm
[pos
].int_freq
);
695 printk(KERN_CONT
"(%x), id %016llx.\n", priv
->firm
[pos
].type
,
696 (unsigned long long)*id
);
698 if (priv
->firm_version
< 0x0202)
699 rc
= send_seq(priv
, {0x20, 0x00, 0x00, 0x00});
701 rc
= send_seq(priv
, {0xa0, 0x00, 0x00, 0x00});
705 rc
= i2c_send(priv
, p
, 12);
709 rc
= send_seq(priv
, {0x00, 0x8c});
716 static int xc2028_sleep(struct dvb_frontend
*fe
);
718 static int check_firmware(struct dvb_frontend
*fe
, unsigned int type
,
719 v4l2_std_id std
, __u16 int_freq
)
721 struct xc2028_data
*priv
= fe
->tuner_priv
;
722 struct firmware_properties new_fw
;
723 int rc
, retry_count
= 0;
724 u16 version
, hwmodel
;
727 tuner_dbg("%s called\n", __func__
);
729 rc
= check_device_status(priv
);
733 if (priv
->ctrl
.mts
&& !(type
& FM
))
739 new_fw
.std_req
= std
;
740 new_fw
.scode_table
= SCODE
| priv
->ctrl
.scode_table
;
742 new_fw
.int_freq
= int_freq
;
744 tuner_dbg("checking firmware, user requested type=");
746 dump_firm_type(new_fw
.type
);
747 printk(KERN_CONT
"(%x), id %016llx, ", new_fw
.type
,
748 (unsigned long long)new_fw
.std_req
);
750 printk(KERN_CONT
"scode_tbl ");
751 dump_firm_type(priv
->ctrl
.scode_table
);
752 printk(KERN_CONT
"(%x), ", priv
->ctrl
.scode_table
);
754 printk(KERN_CONT
"int_freq %d, ", new_fw
.int_freq
);
755 printk(KERN_CONT
"scode_nr %d\n", new_fw
.scode_nr
);
759 * No need to reload base firmware if it matches and if the tuner
760 * is not at sleep mode
762 if ((priv
->state
== XC2028_ACTIVE
) &&
763 (((BASE
| new_fw
.type
) & BASE_TYPES
) ==
764 (priv
->cur_fw
.type
& BASE_TYPES
))) {
765 tuner_dbg("BASE firmware not changed.\n");
769 /* Updating BASE - forget about all currently loaded firmware */
770 memset(&priv
->cur_fw
, 0, sizeof(priv
->cur_fw
));
772 /* Reset is needed before loading firmware */
773 rc
= do_tuner_callback(fe
, XC2028_TUNER_RESET
, 0);
777 /* BASE firmwares are all std0 */
779 rc
= load_firmware(fe
, BASE
| new_fw
.type
, &std0
);
781 tuner_err("Error %d while loading base firmware\n",
786 /* Load INIT1, if needed */
787 tuner_dbg("Load init1 firmware, if exists\n");
789 rc
= load_firmware(fe
, BASE
| INIT1
| new_fw
.type
, &std0
);
791 rc
= load_firmware(fe
, (BASE
| INIT1
| new_fw
.type
) & ~F8MHZ
,
793 if (rc
< 0 && rc
!= -ENOENT
) {
794 tuner_err("Error %d while loading init1 firmware\n",
801 * No need to reload standard specific firmware if base firmware
802 * was not reloaded and requested video standards have not changed.
804 if (priv
->cur_fw
.type
== (BASE
| new_fw
.type
) &&
805 priv
->cur_fw
.std_req
== std
) {
806 tuner_dbg("Std-specific firmware already loaded.\n");
807 goto skip_std_specific
;
810 /* Reloading std-specific firmware forces a SCODE update */
811 priv
->cur_fw
.scode_table
= 0;
813 rc
= load_firmware(fe
, new_fw
.type
, &new_fw
.id
);
815 rc
= load_firmware(fe
, new_fw
.type
& ~F8MHZ
, &new_fw
.id
);
821 if (priv
->cur_fw
.scode_table
== new_fw
.scode_table
&&
822 priv
->cur_fw
.scode_nr
== new_fw
.scode_nr
) {
823 tuner_dbg("SCODE firmware already loaded.\n");
827 if (new_fw
.type
& FM
)
830 /* Load SCODE firmware, if exists */
831 tuner_dbg("Trying to load scode %d\n", new_fw
.scode_nr
);
833 rc
= load_scode(fe
, new_fw
.type
| new_fw
.scode_table
, &new_fw
.id
,
834 new_fw
.int_freq
, new_fw
.scode_nr
);
837 if (xc2028_get_reg(priv
, 0x0004, &version
) < 0 ||
838 xc2028_get_reg(priv
, 0x0008, &hwmodel
) < 0) {
839 tuner_err("Unable to read tuner registers.\n");
843 tuner_dbg("Device is Xceive %d version %d.%d, firmware version %d.%d\n",
844 hwmodel
, (version
& 0xf000) >> 12, (version
& 0xf00) >> 8,
845 (version
& 0xf0) >> 4, version
& 0xf);
848 if (priv
->ctrl
.read_not_reliable
)
849 goto read_not_reliable
;
851 /* Check firmware version against what we downloaded. */
852 if (priv
->firm_version
!= ((version
& 0xf0) << 4 | (version
& 0x0f))) {
853 if (!priv
->ctrl
.read_not_reliable
) {
854 tuner_err("Incorrect readback of firmware version.\n");
857 tuner_err("Returned an incorrect version. However, read is not reliable enough. Ignoring it.\n");
862 /* Check that the tuner hardware model remains consistent over time. */
863 if (priv
->hwmodel
== 0 && (hwmodel
== 2028 || hwmodel
== 3028)) {
864 priv
->hwmodel
= hwmodel
;
865 priv
->hwvers
= version
& 0xff00;
866 } else if (priv
->hwmodel
== 0 || priv
->hwmodel
!= hwmodel
||
867 priv
->hwvers
!= (version
& 0xff00)) {
868 tuner_err("Read invalid device hardware information - tuner hung?\n");
873 priv
->cur_fw
= new_fw
;
876 * By setting BASE in cur_fw.type only after successfully loading all
878 * 1. Identify that BASE firmware with type=0 has been loaded;
879 * 2. Tell whether BASE firmware was just changed the next time through.
881 priv
->cur_fw
.type
|= BASE
;
882 priv
->state
= XC2028_ACTIVE
;
889 if (retry_count
< 8) {
892 tuner_dbg("Retrying firmware load\n");
896 /* Firmware didn't load. Put the device to sleep */
904 static int xc2028_signal(struct dvb_frontend
*fe
, u16
*strength
)
906 struct xc2028_data
*priv
= fe
->tuner_priv
;
907 u16 frq_lock
, signal
= 0;
910 tuner_dbg("%s called\n", __func__
);
912 rc
= check_device_status(priv
);
916 /* If the device is sleeping, no channel is tuned */
922 mutex_lock(&priv
->lock
);
924 /* Sync Lock Indicator */
925 for (i
= 0; i
< 3; i
++) {
926 rc
= xc2028_get_reg(priv
, XREG_LOCK
, &frq_lock
);
935 /* Frequency didn't lock */
939 /* Get SNR of the video signal */
940 rc
= xc2028_get_reg(priv
, XREG_SNR
, &signal
);
944 /* Signal level is 3 bits only */
946 signal
= ((1 << 12) - 1) | ((signal
& 0x07) << 12);
949 mutex_unlock(&priv
->lock
);
953 tuner_dbg("signal strength is %d\n", signal
);
958 static int xc2028_get_afc(struct dvb_frontend
*fe
, s32
*afc
)
960 struct xc2028_data
*priv
= fe
->tuner_priv
;
965 rc
= check_device_status(priv
);
969 /* If the device is sleeping, no channel is tuned */
975 mutex_lock(&priv
->lock
);
977 /* Sync Lock Indicator */
978 for (i
= 0; i
< 3; i
++) {
979 rc
= xc2028_get_reg(priv
, XREG_LOCK
, &frq_lock
);
988 /* Frequency didn't lock */
993 rc
= xc2028_get_reg(priv
, XREG_FREQ_ERROR
, &afc_reg
);
997 *afc
= afc_reg
* 15625; /* Hz */
999 tuner_dbg("AFC is %d Hz\n", *afc
);
1002 mutex_unlock(&priv
->lock
);
1009 static int generic_set_freq(struct dvb_frontend
*fe
, u32 freq
/* in HZ */,
1010 enum v4l2_tuner_type new_type
,
1015 struct xc2028_data
*priv
= fe
->tuner_priv
;
1017 unsigned char buf
[4];
1018 u32 div
, offset
= 0;
1020 tuner_dbg("%s called\n", __func__
);
1022 mutex_lock(&priv
->lock
);
1024 tuner_dbg("should set frequency %d kHz\n", freq
/ 1000);
1026 if (check_firmware(fe
, type
, std
, int_freq
) < 0)
1029 /* On some cases xc2028 can disable video output, if
1030 * very weak signals are received. By sending a soft
1031 * reset, this is re-enabled. So, it is better to always
1032 * send a soft reset before changing channels, to be sure
1033 * that xc2028 will be in a safe state.
1034 * Maybe this might also be needed for DTV.
1037 case V4L2_TUNER_ANALOG_TV
:
1038 rc
= send_seq(priv
, {0x00, 0x00});
1040 /* Analog mode requires offset = 0 */
1042 case V4L2_TUNER_RADIO
:
1043 /* Radio mode requires offset = 0 */
1045 case V4L2_TUNER_DIGITAL_TV
:
1047 * Digital modes require an offset to adjust to the
1048 * proper frequency. The offset depends on what
1049 * firmware version is used.
1053 * Adjust to the center frequency. This is calculated by the
1054 * formula: offset = 1.25MHz - BW/2
1055 * For DTV 7/8, the firmware uses BW = 8000, so it needs a
1056 * further adjustment to get the frequency center on VHF
1060 * The firmware DTV78 used to work fine in UHF band (8 MHz
1061 * bandwidth) but not at all in VHF band (7 MHz bandwidth).
1062 * The real problem was connected to the formula used to
1063 * calculate the center frequency offset in VHF band.
1064 * In fact, removing the 500KHz adjustment fixed the problem.
1065 * This is coherent to what was implemented for the DTV7
1067 * In the end, now the center frequency is the same for all 3
1068 * firmwares (DTV7, DTV8, DTV78) and doesn't depend on channel
1072 if (priv
->cur_fw
.type
& DTV6
)
1074 else /* DTV7 or DTV8 or DTV78 */
1078 * xc3028 additional "magic"
1079 * Depending on the firmware version, it needs some adjustments
1080 * to properly centralize the frequency. This seems to be
1081 * needed to compensate the SCODE table adjustments made by
1086 * The proper adjustment would be to do it at s-code table.
1087 * However, this didn't work, as reported by
1088 * Robert Lowery <rglowery@exemail.com.au>
1093 * Still need tests for XC3028L (firmware 3.2 or upper)
1094 * So, for now, let's just comment the per-firmware
1095 * version of this change. Reports with xc3028l working
1096 * with and without the lines below are welcome
1099 if (priv
->firm_version
< 0x0302) {
1100 if (priv
->cur_fw
.type
& DTV7
)
1103 if (priv
->cur_fw
.type
& DTV7
)
1105 else if (type
!= ATSC
) /* DVB @6MHz, DTV 8 and DTV 7/8 */
1111 tuner_err("Unsupported tuner type %d.\n", new_type
);
1115 div
= (freq
- offset
+ DIV
/ 2) / DIV
;
1117 /* CMD= Set frequency */
1118 if (priv
->firm_version
< 0x0202)
1119 rc
= send_seq(priv
, {0x00, XREG_RF_FREQ
, 0x00, 0x00});
1121 rc
= send_seq(priv
, {0x80, XREG_RF_FREQ
, 0x00, 0x00});
1125 /* Return code shouldn't be checked.
1126 The reset CLK is needed only with tm6000.
1127 Driver should work fine even if this fails.
1129 if (priv
->ctrl
.msleep
)
1130 msleep(priv
->ctrl
.msleep
);
1131 do_tuner_callback(fe
, XC2028_RESET_CLK
, 1);
1135 buf
[0] = 0xff & (div
>> 24);
1136 buf
[1] = 0xff & (div
>> 16);
1137 buf
[2] = 0xff & (div
>> 8);
1138 buf
[3] = 0xff & (div
);
1140 rc
= i2c_send(priv
, buf
, sizeof(buf
));
1145 priv
->frequency
= freq
;
1147 tuner_dbg("divisor= %*ph (freq=%d.%03d)\n", 4, buf
,
1148 freq
/ 1000000, (freq
% 1000000) / 1000);
1153 mutex_unlock(&priv
->lock
);
1158 static int xc2028_set_analog_freq(struct dvb_frontend
*fe
,
1159 struct analog_parameters
*p
)
1161 struct xc2028_data
*priv
= fe
->tuner_priv
;
1162 unsigned int type
=0;
1164 tuner_dbg("%s called\n", __func__
);
1166 if (p
->mode
== V4L2_TUNER_RADIO
) {
1168 if (priv
->ctrl
.input1
)
1170 return generic_set_freq(fe
, (625l * p
->frequency
) / 10,
1171 V4L2_TUNER_RADIO
, type
, 0, 0);
1174 /* if std is not defined, choose one */
1176 p
->std
= V4L2_STD_MN
;
1178 /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
1179 if (!(p
->std
& V4L2_STD_MN
))
1182 /* Add audio hack to std mask */
1183 p
->std
|= parse_audio_std_option();
1185 return generic_set_freq(fe
, 62500l * p
->frequency
,
1186 V4L2_TUNER_ANALOG_TV
, type
, p
->std
, 0);
1189 static int xc2028_set_params(struct dvb_frontend
*fe
)
1191 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
1192 u32 delsys
= c
->delivery_system
;
1193 u32 bw
= c
->bandwidth_hz
;
1194 struct xc2028_data
*priv
= fe
->tuner_priv
;
1196 unsigned int type
= 0;
1199 tuner_dbg("%s called\n", __func__
);
1201 rc
= check_device_status(priv
);
1209 * The only countries with 6MHz seem to be Taiwan/Uruguay.
1210 * Both seem to require QAM firmware for OFDM decoding
1211 * Tested in Taiwan by Terry Wu <terrywu2009@gmail.com>
1216 switch (priv
->ctrl
.type
) {
1225 /* Zarlink seems to need D2633 */
1226 if (priv
->ctrl
.demod
== XC3028_FE_ZARLINK456
)
1233 /* The only ATSC firmware (at least on v2.7) is D2633 */
1234 type
|= ATSC
| D2633
;
1236 /* DVB-S and pure QAM (FE_QAM) are not supported */
1241 if (bw
<= 6000000) {
1243 priv
->ctrl
.vhfbw7
= 0;
1244 priv
->ctrl
.uhfbw8
= 0;
1245 } else if (bw
<= 7000000) {
1246 if (c
->frequency
< 470000000)
1247 priv
->ctrl
.vhfbw7
= 1;
1249 priv
->ctrl
.uhfbw8
= 0;
1250 type
|= (priv
->ctrl
.vhfbw7
&& priv
->ctrl
.uhfbw8
) ? DTV78
: DTV7
;
1253 if (c
->frequency
< 470000000)
1254 priv
->ctrl
.vhfbw7
= 0;
1256 priv
->ctrl
.uhfbw8
= 1;
1257 type
|= (priv
->ctrl
.vhfbw7
&& priv
->ctrl
.uhfbw8
) ? DTV78
: DTV8
;
1261 /* All S-code tables need a 200kHz shift */
1262 if (priv
->ctrl
.demod
) {
1263 demod
= priv
->ctrl
.demod
;
1266 * Newer firmwares require a 200 kHz offset only for ATSC
1268 if (type
== ATSC
|| priv
->firm_version
< 0x0302)
1271 * The DTV7 S-code table needs a 700 kHz shift.
1273 * DTV7 is only used in Australia. Germany or Italy may also
1274 * use this firmware after initialization, but a tune to a UHF
1275 * channel should then cause DTV78 to be used.
1277 * Unfortunately, on real-field tests, the s-code offset
1278 * didn't work as expected, as reported by
1279 * Robert Lowery <rglowery@exemail.com.au>
1283 return generic_set_freq(fe
, c
->frequency
,
1284 V4L2_TUNER_DIGITAL_TV
, type
, 0, demod
);
1287 static int xc2028_sleep(struct dvb_frontend
*fe
)
1289 struct xc2028_data
*priv
= fe
->tuner_priv
;
1292 rc
= check_device_status(priv
);
1296 /* Device is already in sleep mode */
1300 /* Avoid firmware reload on slow devices or if PM disabled */
1301 if (no_poweroff
|| priv
->ctrl
.disable_power_mgmt
)
1304 tuner_dbg("Putting xc2028/3028 into poweroff mode.\n");
1306 tuner_dbg("Printing sleep stack trace:\n");
1310 mutex_lock(&priv
->lock
);
1312 if (priv
->firm_version
< 0x0202)
1313 rc
= send_seq(priv
, {0x00, XREG_POWER_DOWN
, 0x00, 0x00});
1315 rc
= send_seq(priv
, {0x80, XREG_POWER_DOWN
, 0x00, 0x00});
1318 priv
->state
= XC2028_SLEEP
;
1320 mutex_unlock(&priv
->lock
);
1325 static void xc2028_dvb_release(struct dvb_frontend
*fe
)
1327 struct xc2028_data
*priv
= fe
->tuner_priv
;
1329 tuner_dbg("%s called\n", __func__
);
1331 mutex_lock(&xc2028_list_mutex
);
1333 /* only perform final cleanup if this is the last instance */
1334 if (hybrid_tuner_report_instance_count(priv
) == 1)
1335 free_firmware(priv
);
1338 hybrid_tuner_release_state(priv
);
1340 mutex_unlock(&xc2028_list_mutex
);
1342 fe
->tuner_priv
= NULL
;
1345 static int xc2028_get_frequency(struct dvb_frontend
*fe
, u32
*frequency
)
1347 struct xc2028_data
*priv
= fe
->tuner_priv
;
1350 tuner_dbg("%s called\n", __func__
);
1352 rc
= check_device_status(priv
);
1356 *frequency
= priv
->frequency
;
1361 static void load_firmware_cb(const struct firmware
*fw
,
1364 struct dvb_frontend
*fe
= context
;
1365 struct xc2028_data
*priv
= fe
->tuner_priv
;
1368 tuner_dbg("request_firmware_nowait(): %s\n", fw
? "OK" : "error");
1370 tuner_err("Could not load firmware %s.\n", priv
->fname
);
1371 priv
->state
= XC2028_NODEV
;
1375 rc
= load_all_firmwares(fe
, fw
);
1377 release_firmware(fw
);
1381 priv
->state
= XC2028_ACTIVE
;
1384 static int xc2028_set_config(struct dvb_frontend
*fe
, void *priv_cfg
)
1386 struct xc2028_data
*priv
= fe
->tuner_priv
;
1387 struct xc2028_ctrl
*p
= priv_cfg
;
1390 tuner_dbg("%s called\n", __func__
);
1392 mutex_lock(&priv
->lock
);
1395 * Copy the config data.
1397 memcpy(&priv
->ctrl
, p
, sizeof(priv
->ctrl
));
1400 * If firmware name changed, frees firmware. As free_firmware will
1401 * reset the status to NO_FIRMWARE, this forces a new request_firmware
1403 if (!firmware_name
[0] && p
->fname
&&
1404 priv
->fname
&& strcmp(p
->fname
, priv
->fname
))
1405 free_firmware(priv
);
1407 if (priv
->ctrl
.max_len
< 9)
1408 priv
->ctrl
.max_len
= 13;
1410 if (priv
->state
== XC2028_NO_FIRMWARE
) {
1411 if (!firmware_name
[0])
1412 priv
->fname
= kstrdup(p
->fname
, GFP_KERNEL
);
1414 priv
->fname
= firmware_name
;
1421 rc
= request_firmware_nowait(THIS_MODULE
, 1,
1423 priv
->i2c_props
.adap
->dev
.parent
,
1425 fe
, load_firmware_cb
);
1427 tuner_err("Failed to request firmware %s\n",
1429 priv
->state
= XC2028_NODEV
;
1431 priv
->state
= XC2028_WAITING_FIRMWARE
;
1434 mutex_unlock(&priv
->lock
);
1439 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops
= {
1441 .name
= "Xceive XC3028",
1442 .frequency_min_hz
= 42 * MHz
,
1443 .frequency_max_hz
= 864 * MHz
,
1444 .frequency_step_hz
= 50 * kHz
,
1447 .set_config
= xc2028_set_config
,
1448 .set_analog_params
= xc2028_set_analog_freq
,
1449 .release
= xc2028_dvb_release
,
1450 .get_frequency
= xc2028_get_frequency
,
1451 .get_rf_strength
= xc2028_signal
,
1452 .get_afc
= xc2028_get_afc
,
1453 .set_params
= xc2028_set_params
,
1454 .sleep
= xc2028_sleep
,
1457 struct dvb_frontend
*xc2028_attach(struct dvb_frontend
*fe
,
1458 struct xc2028_config
*cfg
)
1460 struct xc2028_data
*priv
;
1464 printk(KERN_DEBUG
"xc2028: Xcv2028/3028 init called!\n");
1470 printk(KERN_ERR
"xc2028: No frontend!\n");
1474 mutex_lock(&xc2028_list_mutex
);
1476 instance
= hybrid_tuner_request_state(struct xc2028_data
, priv
,
1477 hybrid_tuner_instance_list
,
1478 cfg
->i2c_adap
, cfg
->i2c_addr
,
1482 /* memory allocation failure */
1485 /* new tuner instance */
1486 priv
->ctrl
.max_len
= 13;
1488 mutex_init(&priv
->lock
);
1490 fe
->tuner_priv
= priv
;
1493 /* existing tuner instance */
1494 fe
->tuner_priv
= priv
;
1498 memcpy(&fe
->ops
.tuner_ops
, &xc2028_dvb_tuner_ops
,
1499 sizeof(xc2028_dvb_tuner_ops
));
1501 tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1504 xc2028_set_config(fe
, cfg
->ctrl
);
1506 mutex_unlock(&xc2028_list_mutex
);
1510 mutex_unlock(&xc2028_list_mutex
);
1512 xc2028_dvb_release(fe
);
1516 EXPORT_SYMBOL(xc2028_attach
);
1518 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1519 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1520 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@kernel.org>");
1521 MODULE_LICENSE("GPL v2");
1522 MODULE_FIRMWARE(XC2028_DEFAULT_FIRMWARE
);
1523 MODULE_FIRMWARE(XC3028L_DEFAULT_FIRMWARE
);