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
= kmemdup(p
, 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 priv
->firm
[n
].type
= type
;
398 priv
->firm
[n
].id
= id
;
399 priv
->firm
[n
].size
= size
;
400 priv
->firm
[n
].int_freq
= int_freq
;
405 if (n
+ 1 != priv
->firm_size
) {
406 tuner_err("Firmware file is incomplete!\n");
413 tuner_err("Firmware header is incomplete!\n");
416 tuner_err("Error: firmware file is corrupted!\n");
419 tuner_info("Releasing partially loaded firmware file.\n");
424 tuner_dbg("Firmware files loaded.\n");
426 priv
->state
= XC2028_NODEV
;
431 static int seek_firmware(struct dvb_frontend
*fe
, unsigned int type
,
434 struct xc2028_data
*priv
= fe
->tuner_priv
;
435 int i
, best_i
= -1, best_nr_matches
= 0;
436 unsigned int type_mask
= 0;
438 tuner_dbg("%s called, want type=", __func__
);
440 dump_firm_type(type
);
441 printk(KERN_CONT
"(%x), id %016llx.\n",
442 type
, (unsigned long long)*id
);
446 tuner_err("Error! firmware not loaded\n");
450 if (((type
& ~SCODE
) == 0) && (*id
== 0))
454 type_mask
= BASE_TYPES
;
455 else if (type
& SCODE
) {
457 type_mask
= SCODE_TYPES
& ~HAS_IF
;
458 } else if (type
& DTV_TYPES
)
459 type_mask
= DTV_TYPES
;
460 else if (type
& STD_SPECIFIC_TYPES
)
461 type_mask
= STD_SPECIFIC_TYPES
;
468 /* Seek for exact match */
469 for (i
= 0; i
< priv
->firm_size
; i
++) {
470 if ((type
== (priv
->firm
[i
].type
& type_mask
)) &&
471 (*id
== priv
->firm
[i
].id
))
475 /* Seek for generic video standard match */
476 for (i
= 0; i
< priv
->firm_size
; i
++) {
477 v4l2_std_id match_mask
;
480 if (type
!= (priv
->firm
[i
].type
& type_mask
))
483 match_mask
= *id
& priv
->firm
[i
].id
;
487 if ((*id
& match_mask
) == *id
)
488 goto found
; /* Supports all the requested standards */
490 nr_matches
= hweight64(match_mask
);
491 if (nr_matches
> best_nr_matches
) {
492 best_nr_matches
= nr_matches
;
497 if (best_nr_matches
> 0) {
498 tuner_dbg("Selecting best matching firmware (%d bits) for type=",
500 dump_firm_type(type
);
502 "(%x), id %016llx:\n", type
, (unsigned long long)*id
);
507 /*FIXME: Would make sense to seek for type "hint" match ? */
513 *id
= priv
->firm
[i
].id
;
516 tuner_dbg("%s firmware for type=", (i
< 0) ? "Can't find" : "Found");
518 dump_firm_type(type
);
519 printk(KERN_CONT
"(%x), id %016llx.\n",
520 type
, (unsigned long long)*id
);
525 static inline int do_tuner_callback(struct dvb_frontend
*fe
, int cmd
, int arg
)
527 struct xc2028_data
*priv
= fe
->tuner_priv
;
529 /* analog side (tuner-core) uses i2c_adap->algo_data.
530 * digital side is not guaranteed to have algo_data defined.
532 * digital side will always have fe->dvb defined.
533 * analog side (tuner-core) doesn't (yet) define fe->dvb.
536 return (!fe
->callback
) ? -EINVAL
:
537 fe
->callback(((fe
->dvb
) && (fe
->dvb
->priv
)) ?
538 fe
->dvb
->priv
: priv
->i2c_props
.adap
->algo_data
,
539 DVB_FRONTEND_COMPONENT_TUNER
, cmd
, arg
);
542 static int load_firmware(struct dvb_frontend
*fe
, unsigned int type
,
545 struct xc2028_data
*priv
= fe
->tuner_priv
;
547 unsigned char *p
, *endp
, buf
[MAX_XFER_SIZE
];
549 if (priv
->ctrl
.max_len
> sizeof(buf
))
550 priv
->ctrl
.max_len
= sizeof(buf
);
552 tuner_dbg("%s called\n", __func__
);
554 pos
= seek_firmware(fe
, type
, id
);
558 tuner_info("Loading firmware for type=");
559 dump_firm_type(priv
->firm
[pos
].type
);
560 printk(KERN_CONT
"(%x), id %016llx.\n",
561 priv
->firm
[pos
].type
, (unsigned long long)*id
);
563 p
= priv
->firm
[pos
].ptr
;
564 endp
= p
+ priv
->firm
[pos
].size
;
569 /* Checks if there's enough bytes to read */
570 if (p
+ sizeof(size
) > endp
) {
571 tuner_err("Firmware chunk size is wrong\n");
575 size
= le16_to_cpu(*(__le16
*) p
);
582 /* Special callback command received */
583 rc
= do_tuner_callback(fe
, XC2028_TUNER_RESET
, 0);
585 tuner_err("Error at RESET code %d\n",
591 if (size
>= 0xff00) {
594 rc
= do_tuner_callback(fe
, XC2028_RESET_CLK
, 0);
596 tuner_err("Error at RESET code %d\n",
602 tuner_info("Invalid RESET code %d\n",
610 /* Checks for a sleep command */
612 msleep(size
& 0x7fff);
616 if ((size
+ p
> endp
)) {
617 tuner_err("missing bytes: need %d, have %zd\n",
626 /* Sends message chunks */
628 int len
= (size
< priv
->ctrl
.max_len
- 1) ?
629 size
: priv
->ctrl
.max_len
- 1;
631 memcpy(buf
+ 1, p
, len
);
633 rc
= i2c_send(priv
, buf
, len
+ 1);
635 tuner_err("%d returned from send\n", rc
);
643 /* silently fail if the frontend doesn't support I2C flush */
644 rc
= do_tuner_callback(fe
, XC2028_I2C_FLUSH
, 0);
645 if ((rc
< 0) && (rc
!= -EINVAL
)) {
646 tuner_err("error executing flush: %d\n", rc
);
653 static int load_scode(struct dvb_frontend
*fe
, unsigned int type
,
654 v4l2_std_id
*id
, __u16 int_freq
, int scode
)
656 struct xc2028_data
*priv
= fe
->tuner_priv
;
660 tuner_dbg("%s called\n", __func__
);
663 pos
= seek_firmware(fe
, type
, id
);
667 for (pos
= 0; pos
< priv
->firm_size
; pos
++) {
668 if ((priv
->firm
[pos
].int_freq
== int_freq
) &&
669 (priv
->firm
[pos
].type
& HAS_IF
))
672 if (pos
== priv
->firm_size
)
676 p
= priv
->firm
[pos
].ptr
;
678 if (priv
->firm
[pos
].type
& HAS_IF
) {
679 if (priv
->firm
[pos
].size
!= 12 * 16 || scode
>= 16)
683 /* 16 SCODE entries per file; each SCODE entry is 12 bytes and
684 * has a 2-byte size header in the firmware format. */
685 if (priv
->firm
[pos
].size
!= 14 * 16 || scode
>= 16 ||
686 le16_to_cpu(*(__le16
*)(p
+ 14 * scode
)) != 12)
691 tuner_info("Loading SCODE for type=");
692 dump_firm_type_and_int_freq(priv
->firm
[pos
].type
,
693 priv
->firm
[pos
].int_freq
);
694 printk(KERN_CONT
"(%x), id %016llx.\n", priv
->firm
[pos
].type
,
695 (unsigned long long)*id
);
697 if (priv
->firm_version
< 0x0202)
698 rc
= send_seq(priv
, {0x20, 0x00, 0x00, 0x00});
700 rc
= send_seq(priv
, {0xa0, 0x00, 0x00, 0x00});
704 rc
= i2c_send(priv
, p
, 12);
708 rc
= send_seq(priv
, {0x00, 0x8c});
715 static int xc2028_sleep(struct dvb_frontend
*fe
);
717 static int check_firmware(struct dvb_frontend
*fe
, unsigned int type
,
718 v4l2_std_id std
, __u16 int_freq
)
720 struct xc2028_data
*priv
= fe
->tuner_priv
;
721 struct firmware_properties new_fw
;
722 int rc
, retry_count
= 0;
723 u16 version
, hwmodel
;
726 tuner_dbg("%s called\n", __func__
);
728 rc
= check_device_status(priv
);
732 if (priv
->ctrl
.mts
&& !(type
& FM
))
738 new_fw
.std_req
= std
;
739 new_fw
.scode_table
= SCODE
| priv
->ctrl
.scode_table
;
741 new_fw
.int_freq
= int_freq
;
743 tuner_dbg("checking firmware, user requested type=");
745 dump_firm_type(new_fw
.type
);
746 printk(KERN_CONT
"(%x), id %016llx, ", new_fw
.type
,
747 (unsigned long long)new_fw
.std_req
);
749 printk(KERN_CONT
"scode_tbl ");
750 dump_firm_type(priv
->ctrl
.scode_table
);
751 printk(KERN_CONT
"(%x), ", priv
->ctrl
.scode_table
);
753 printk(KERN_CONT
"int_freq %d, ", new_fw
.int_freq
);
754 printk(KERN_CONT
"scode_nr %d\n", new_fw
.scode_nr
);
758 * No need to reload base firmware if it matches and if the tuner
759 * is not at sleep mode
761 if ((priv
->state
== XC2028_ACTIVE
) &&
762 (((BASE
| new_fw
.type
) & BASE_TYPES
) ==
763 (priv
->cur_fw
.type
& BASE_TYPES
))) {
764 tuner_dbg("BASE firmware not changed.\n");
768 /* Updating BASE - forget about all currently loaded firmware */
769 memset(&priv
->cur_fw
, 0, sizeof(priv
->cur_fw
));
771 /* Reset is needed before loading firmware */
772 rc
= do_tuner_callback(fe
, XC2028_TUNER_RESET
, 0);
776 /* BASE firmwares are all std0 */
778 rc
= load_firmware(fe
, BASE
| new_fw
.type
, &std0
);
780 tuner_err("Error %d while loading base firmware\n",
785 /* Load INIT1, if needed */
786 tuner_dbg("Load init1 firmware, if exists\n");
788 rc
= load_firmware(fe
, BASE
| INIT1
| new_fw
.type
, &std0
);
790 rc
= load_firmware(fe
, (BASE
| INIT1
| new_fw
.type
) & ~F8MHZ
,
792 if (rc
< 0 && rc
!= -ENOENT
) {
793 tuner_err("Error %d while loading init1 firmware\n",
800 * No need to reload standard specific firmware if base firmware
801 * was not reloaded and requested video standards have not changed.
803 if (priv
->cur_fw
.type
== (BASE
| new_fw
.type
) &&
804 priv
->cur_fw
.std_req
== std
) {
805 tuner_dbg("Std-specific firmware already loaded.\n");
806 goto skip_std_specific
;
809 /* Reloading std-specific firmware forces a SCODE update */
810 priv
->cur_fw
.scode_table
= 0;
812 rc
= load_firmware(fe
, new_fw
.type
, &new_fw
.id
);
814 rc
= load_firmware(fe
, new_fw
.type
& ~F8MHZ
, &new_fw
.id
);
820 if (priv
->cur_fw
.scode_table
== new_fw
.scode_table
&&
821 priv
->cur_fw
.scode_nr
== new_fw
.scode_nr
) {
822 tuner_dbg("SCODE firmware already loaded.\n");
826 if (new_fw
.type
& FM
)
829 /* Load SCODE firmware, if exists */
830 tuner_dbg("Trying to load scode %d\n", new_fw
.scode_nr
);
832 rc
= load_scode(fe
, new_fw
.type
| new_fw
.scode_table
, &new_fw
.id
,
833 new_fw
.int_freq
, new_fw
.scode_nr
);
836 if (xc2028_get_reg(priv
, 0x0004, &version
) < 0 ||
837 xc2028_get_reg(priv
, 0x0008, &hwmodel
) < 0) {
838 tuner_err("Unable to read tuner registers.\n");
842 tuner_dbg("Device is Xceive %d version %d.%d, firmware version %d.%d\n",
843 hwmodel
, (version
& 0xf000) >> 12, (version
& 0xf00) >> 8,
844 (version
& 0xf0) >> 4, version
& 0xf);
847 if (priv
->ctrl
.read_not_reliable
)
848 goto read_not_reliable
;
850 /* Check firmware version against what we downloaded. */
851 if (priv
->firm_version
!= ((version
& 0xf0) << 4 | (version
& 0x0f))) {
852 if (!priv
->ctrl
.read_not_reliable
) {
853 tuner_err("Incorrect readback of firmware version.\n");
856 tuner_err("Returned an incorrect version. However, read is not reliable enough. Ignoring it.\n");
861 /* Check that the tuner hardware model remains consistent over time. */
862 if (priv
->hwmodel
== 0 && (hwmodel
== 2028 || hwmodel
== 3028)) {
863 priv
->hwmodel
= hwmodel
;
864 priv
->hwvers
= version
& 0xff00;
865 } else if (priv
->hwmodel
== 0 || priv
->hwmodel
!= hwmodel
||
866 priv
->hwvers
!= (version
& 0xff00)) {
867 tuner_err("Read invalid device hardware information - tuner hung?\n");
872 priv
->cur_fw
= new_fw
;
875 * By setting BASE in cur_fw.type only after successfully loading all
877 * 1. Identify that BASE firmware with type=0 has been loaded;
878 * 2. Tell whether BASE firmware was just changed the next time through.
880 priv
->cur_fw
.type
|= BASE
;
881 priv
->state
= XC2028_ACTIVE
;
888 if (retry_count
< 8) {
891 tuner_dbg("Retrying firmware load\n");
895 /* Firmware didn't load. Put the device to sleep */
903 static int xc2028_signal(struct dvb_frontend
*fe
, u16
*strength
)
905 struct xc2028_data
*priv
= fe
->tuner_priv
;
906 u16 frq_lock
, signal
= 0;
909 tuner_dbg("%s called\n", __func__
);
911 rc
= check_device_status(priv
);
915 /* If the device is sleeping, no channel is tuned */
921 mutex_lock(&priv
->lock
);
923 /* Sync Lock Indicator */
924 for (i
= 0; i
< 3; i
++) {
925 rc
= xc2028_get_reg(priv
, XREG_LOCK
, &frq_lock
);
934 /* Frequency didn't lock */
938 /* Get SNR of the video signal */
939 rc
= xc2028_get_reg(priv
, XREG_SNR
, &signal
);
943 /* Signal level is 3 bits only */
945 signal
= ((1 << 12) - 1) | ((signal
& 0x07) << 12);
948 mutex_unlock(&priv
->lock
);
952 tuner_dbg("signal strength is %d\n", signal
);
957 static int xc2028_get_afc(struct dvb_frontend
*fe
, s32
*afc
)
959 struct xc2028_data
*priv
= fe
->tuner_priv
;
964 rc
= check_device_status(priv
);
968 /* If the device is sleeping, no channel is tuned */
974 mutex_lock(&priv
->lock
);
976 /* Sync Lock Indicator */
977 for (i
= 0; i
< 3; i
++) {
978 rc
= xc2028_get_reg(priv
, XREG_LOCK
, &frq_lock
);
987 /* Frequency didn't lock */
992 rc
= xc2028_get_reg(priv
, XREG_FREQ_ERROR
, &afc_reg
);
996 *afc
= afc_reg
* 15625; /* Hz */
998 tuner_dbg("AFC is %d Hz\n", *afc
);
1001 mutex_unlock(&priv
->lock
);
1008 static int generic_set_freq(struct dvb_frontend
*fe
, u32 freq
/* in HZ */,
1009 enum v4l2_tuner_type new_type
,
1014 struct xc2028_data
*priv
= fe
->tuner_priv
;
1016 unsigned char buf
[4];
1017 u32 div
, offset
= 0;
1019 tuner_dbg("%s called\n", __func__
);
1021 mutex_lock(&priv
->lock
);
1023 tuner_dbg("should set frequency %d kHz\n", freq
/ 1000);
1025 if (check_firmware(fe
, type
, std
, int_freq
) < 0)
1028 /* On some cases xc2028 can disable video output, if
1029 * very weak signals are received. By sending a soft
1030 * reset, this is re-enabled. So, it is better to always
1031 * send a soft reset before changing channels, to be sure
1032 * that xc2028 will be in a safe state.
1033 * Maybe this might also be needed for DTV.
1036 case V4L2_TUNER_ANALOG_TV
:
1037 rc
= send_seq(priv
, {0x00, 0x00});
1039 /* Analog mode requires offset = 0 */
1041 case V4L2_TUNER_RADIO
:
1042 /* Radio mode requires offset = 0 */
1044 case V4L2_TUNER_DIGITAL_TV
:
1046 * Digital modes require an offset to adjust to the
1047 * proper frequency. The offset depends on what
1048 * firmware version is used.
1052 * Adjust to the center frequency. This is calculated by the
1053 * formula: offset = 1.25MHz - BW/2
1054 * For DTV 7/8, the firmware uses BW = 8000, so it needs a
1055 * further adjustment to get the frequency center on VHF
1059 * The firmware DTV78 used to work fine in UHF band (8 MHz
1060 * bandwidth) but not at all in VHF band (7 MHz bandwidth).
1061 * The real problem was connected to the formula used to
1062 * calculate the center frequency offset in VHF band.
1063 * In fact, removing the 500KHz adjustment fixed the problem.
1064 * This is coherent to what was implemented for the DTV7
1066 * In the end, now the center frequency is the same for all 3
1067 * firmwares (DTV7, DTV8, DTV78) and doesn't depend on channel
1071 if (priv
->cur_fw
.type
& DTV6
)
1073 else /* DTV7 or DTV8 or DTV78 */
1077 * xc3028 additional "magic"
1078 * Depending on the firmware version, it needs some adjustments
1079 * to properly centralize the frequency. This seems to be
1080 * needed to compensate the SCODE table adjustments made by
1085 * The proper adjustment would be to do it at s-code table.
1086 * However, this didn't work, as reported by
1087 * Robert Lowery <rglowery@exemail.com.au>
1092 * Still need tests for XC3028L (firmware 3.2 or upper)
1093 * So, for now, let's just comment the per-firmware
1094 * version of this change. Reports with xc3028l working
1095 * with and without the lines below are welcome
1098 if (priv
->firm_version
< 0x0302) {
1099 if (priv
->cur_fw
.type
& DTV7
)
1102 if (priv
->cur_fw
.type
& DTV7
)
1104 else if (type
!= ATSC
) /* DVB @6MHz, DTV 8 and DTV 7/8 */
1110 tuner_err("Unsupported tuner type %d.\n", new_type
);
1114 div
= (freq
- offset
+ DIV
/ 2) / DIV
;
1116 /* CMD= Set frequency */
1117 if (priv
->firm_version
< 0x0202)
1118 rc
= send_seq(priv
, {0x00, XREG_RF_FREQ
, 0x00, 0x00});
1120 rc
= send_seq(priv
, {0x80, XREG_RF_FREQ
, 0x00, 0x00});
1124 /* Return code shouldn't be checked.
1125 The reset CLK is needed only with tm6000.
1126 Driver should work fine even if this fails.
1128 if (priv
->ctrl
.msleep
)
1129 msleep(priv
->ctrl
.msleep
);
1130 do_tuner_callback(fe
, XC2028_RESET_CLK
, 1);
1134 buf
[0] = 0xff & (div
>> 24);
1135 buf
[1] = 0xff & (div
>> 16);
1136 buf
[2] = 0xff & (div
>> 8);
1137 buf
[3] = 0xff & (div
);
1139 rc
= i2c_send(priv
, buf
, sizeof(buf
));
1144 priv
->frequency
= freq
;
1146 tuner_dbg("divisor= %*ph (freq=%d.%03d)\n", 4, buf
,
1147 freq
/ 1000000, (freq
% 1000000) / 1000);
1152 mutex_unlock(&priv
->lock
);
1157 static int xc2028_set_analog_freq(struct dvb_frontend
*fe
,
1158 struct analog_parameters
*p
)
1160 struct xc2028_data
*priv
= fe
->tuner_priv
;
1161 unsigned int type
=0;
1163 tuner_dbg("%s called\n", __func__
);
1165 if (p
->mode
== V4L2_TUNER_RADIO
) {
1167 if (priv
->ctrl
.input1
)
1169 return generic_set_freq(fe
, (625l * p
->frequency
) / 10,
1170 V4L2_TUNER_RADIO
, type
, 0, 0);
1173 /* if std is not defined, choose one */
1175 p
->std
= V4L2_STD_MN
;
1177 /* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
1178 if (!(p
->std
& V4L2_STD_MN
))
1181 /* Add audio hack to std mask */
1182 p
->std
|= parse_audio_std_option();
1184 return generic_set_freq(fe
, 62500l * p
->frequency
,
1185 V4L2_TUNER_ANALOG_TV
, type
, p
->std
, 0);
1188 static int xc2028_set_params(struct dvb_frontend
*fe
)
1190 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
1191 u32 delsys
= c
->delivery_system
;
1192 u32 bw
= c
->bandwidth_hz
;
1193 struct xc2028_data
*priv
= fe
->tuner_priv
;
1195 unsigned int type
= 0;
1198 tuner_dbg("%s called\n", __func__
);
1200 rc
= check_device_status(priv
);
1208 * The only countries with 6MHz seem to be Taiwan/Uruguay.
1209 * Both seem to require QAM firmware for OFDM decoding
1210 * Tested in Taiwan by Terry Wu <terrywu2009@gmail.com>
1215 switch (priv
->ctrl
.type
) {
1224 /* Zarlink seems to need D2633 */
1225 if (priv
->ctrl
.demod
== XC3028_FE_ZARLINK456
)
1232 /* The only ATSC firmware (at least on v2.7) is D2633 */
1233 type
|= ATSC
| D2633
;
1235 /* DVB-S and pure QAM (FE_QAM) are not supported */
1240 if (bw
<= 6000000) {
1242 priv
->ctrl
.vhfbw7
= 0;
1243 priv
->ctrl
.uhfbw8
= 0;
1244 } else if (bw
<= 7000000) {
1245 if (c
->frequency
< 470000000)
1246 priv
->ctrl
.vhfbw7
= 1;
1248 priv
->ctrl
.uhfbw8
= 0;
1249 type
|= (priv
->ctrl
.vhfbw7
&& priv
->ctrl
.uhfbw8
) ? DTV78
: DTV7
;
1252 if (c
->frequency
< 470000000)
1253 priv
->ctrl
.vhfbw7
= 0;
1255 priv
->ctrl
.uhfbw8
= 1;
1256 type
|= (priv
->ctrl
.vhfbw7
&& priv
->ctrl
.uhfbw8
) ? DTV78
: DTV8
;
1260 /* All S-code tables need a 200kHz shift */
1261 if (priv
->ctrl
.demod
) {
1262 demod
= priv
->ctrl
.demod
;
1265 * Newer firmwares require a 200 kHz offset only for ATSC
1267 if (type
== ATSC
|| priv
->firm_version
< 0x0302)
1270 * The DTV7 S-code table needs a 700 kHz shift.
1272 * DTV7 is only used in Australia. Germany or Italy may also
1273 * use this firmware after initialization, but a tune to a UHF
1274 * channel should then cause DTV78 to be used.
1276 * Unfortunately, on real-field tests, the s-code offset
1277 * didn't work as expected, as reported by
1278 * Robert Lowery <rglowery@exemail.com.au>
1282 return generic_set_freq(fe
, c
->frequency
,
1283 V4L2_TUNER_DIGITAL_TV
, type
, 0, demod
);
1286 static int xc2028_sleep(struct dvb_frontend
*fe
)
1288 struct xc2028_data
*priv
= fe
->tuner_priv
;
1291 rc
= check_device_status(priv
);
1295 /* Device is already in sleep mode */
1299 /* Avoid firmware reload on slow devices or if PM disabled */
1300 if (no_poweroff
|| priv
->ctrl
.disable_power_mgmt
)
1303 tuner_dbg("Putting xc2028/3028 into poweroff mode.\n");
1305 tuner_dbg("Printing sleep stack trace:\n");
1309 mutex_lock(&priv
->lock
);
1311 if (priv
->firm_version
< 0x0202)
1312 rc
= send_seq(priv
, {0x00, XREG_POWER_DOWN
, 0x00, 0x00});
1314 rc
= send_seq(priv
, {0x80, XREG_POWER_DOWN
, 0x00, 0x00});
1317 priv
->state
= XC2028_SLEEP
;
1319 mutex_unlock(&priv
->lock
);
1324 static void xc2028_dvb_release(struct dvb_frontend
*fe
)
1326 struct xc2028_data
*priv
= fe
->tuner_priv
;
1328 tuner_dbg("%s called\n", __func__
);
1330 mutex_lock(&xc2028_list_mutex
);
1332 /* only perform final cleanup if this is the last instance */
1333 if (hybrid_tuner_report_instance_count(priv
) == 1)
1334 free_firmware(priv
);
1337 hybrid_tuner_release_state(priv
);
1339 mutex_unlock(&xc2028_list_mutex
);
1341 fe
->tuner_priv
= NULL
;
1344 static int xc2028_get_frequency(struct dvb_frontend
*fe
, u32
*frequency
)
1346 struct xc2028_data
*priv
= fe
->tuner_priv
;
1349 tuner_dbg("%s called\n", __func__
);
1351 rc
= check_device_status(priv
);
1355 *frequency
= priv
->frequency
;
1360 static void load_firmware_cb(const struct firmware
*fw
,
1363 struct dvb_frontend
*fe
= context
;
1364 struct xc2028_data
*priv
= fe
->tuner_priv
;
1367 tuner_dbg("request_firmware_nowait(): %s\n", fw
? "OK" : "error");
1369 tuner_err("Could not load firmware %s.\n", priv
->fname
);
1370 priv
->state
= XC2028_NODEV
;
1374 rc
= load_all_firmwares(fe
, fw
);
1376 release_firmware(fw
);
1380 priv
->state
= XC2028_ACTIVE
;
1383 static int xc2028_set_config(struct dvb_frontend
*fe
, void *priv_cfg
)
1385 struct xc2028_data
*priv
= fe
->tuner_priv
;
1386 struct xc2028_ctrl
*p
= priv_cfg
;
1389 tuner_dbg("%s called\n", __func__
);
1391 mutex_lock(&priv
->lock
);
1394 * Copy the config data.
1396 memcpy(&priv
->ctrl
, p
, sizeof(priv
->ctrl
));
1399 * If firmware name changed, frees firmware. As free_firmware will
1400 * reset the status to NO_FIRMWARE, this forces a new request_firmware
1402 if (!firmware_name
[0] && p
->fname
&&
1403 priv
->fname
&& strcmp(p
->fname
, priv
->fname
))
1404 free_firmware(priv
);
1406 if (priv
->ctrl
.max_len
< 9)
1407 priv
->ctrl
.max_len
= 13;
1409 if (priv
->state
== XC2028_NO_FIRMWARE
) {
1410 if (!firmware_name
[0])
1411 priv
->fname
= kstrdup(p
->fname
, GFP_KERNEL
);
1413 priv
->fname
= firmware_name
;
1420 rc
= request_firmware_nowait(THIS_MODULE
, 1,
1422 priv
->i2c_props
.adap
->dev
.parent
,
1424 fe
, load_firmware_cb
);
1426 tuner_err("Failed to request firmware %s\n",
1428 priv
->state
= XC2028_NODEV
;
1430 priv
->state
= XC2028_WAITING_FIRMWARE
;
1433 mutex_unlock(&priv
->lock
);
1438 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops
= {
1440 .name
= "Xceive XC3028",
1441 .frequency_min_hz
= 42 * MHz
,
1442 .frequency_max_hz
= 864 * MHz
,
1443 .frequency_step_hz
= 50 * kHz
,
1446 .set_config
= xc2028_set_config
,
1447 .set_analog_params
= xc2028_set_analog_freq
,
1448 .release
= xc2028_dvb_release
,
1449 .get_frequency
= xc2028_get_frequency
,
1450 .get_rf_strength
= xc2028_signal
,
1451 .get_afc
= xc2028_get_afc
,
1452 .set_params
= xc2028_set_params
,
1453 .sleep
= xc2028_sleep
,
1456 struct dvb_frontend
*xc2028_attach(struct dvb_frontend
*fe
,
1457 struct xc2028_config
*cfg
)
1459 struct xc2028_data
*priv
;
1463 printk(KERN_DEBUG
"xc2028: Xcv2028/3028 init called!\n");
1469 printk(KERN_ERR
"xc2028: No frontend!\n");
1473 mutex_lock(&xc2028_list_mutex
);
1475 instance
= hybrid_tuner_request_state(struct xc2028_data
, priv
,
1476 hybrid_tuner_instance_list
,
1477 cfg
->i2c_adap
, cfg
->i2c_addr
,
1481 /* memory allocation failure */
1484 /* new tuner instance */
1485 priv
->ctrl
.max_len
= 13;
1487 mutex_init(&priv
->lock
);
1489 fe
->tuner_priv
= priv
;
1492 /* existing tuner instance */
1493 fe
->tuner_priv
= priv
;
1497 memcpy(&fe
->ops
.tuner_ops
, &xc2028_dvb_tuner_ops
,
1498 sizeof(xc2028_dvb_tuner_ops
));
1500 tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1503 xc2028_set_config(fe
, cfg
->ctrl
);
1505 mutex_unlock(&xc2028_list_mutex
);
1509 mutex_unlock(&xc2028_list_mutex
);
1511 xc2028_dvb_release(fe
);
1515 EXPORT_SYMBOL(xc2028_attach
);
1517 MODULE_DESCRIPTION("Xceive xc2028/xc3028 tuner driver");
1518 MODULE_AUTHOR("Michel Ludwig <michel.ludwig@gmail.com>");
1519 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@kernel.org>");
1520 MODULE_LICENSE("GPL v2");
1521 MODULE_FIRMWARE(XC2028_DEFAULT_FIRMWARE
);
1522 MODULE_FIRMWARE(XC3028L_DEFAULT_FIRMWARE
);