• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* tuner-xc2028
2  *
3  * Copyright (c) 2007-2008 Mauro Carvalho Chehab (mchehab@infradead.org)
4  *
5  * Copyright (c) 2007 Michel Ludwig (michel.ludwig@gmail.com)
6  *       - frontend interface
7  *
8  * This code is placed under the terms of the GNU General Public License v2
9  */
10 
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"
23 
24 #include <linux/dvb/frontend.h>
25 #include "dvb_frontend.h"
26 
27 /* Max transfer size done by I2C transfer functions */
28 #define MAX_XFER_SIZE  80
29 
30 /* Registers (Write-only) */
31 #define XREG_INIT         0x00
32 #define XREG_RF_FREQ      0x02
33 #define XREG_POWER_DOWN   0x08
34 
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
42 #define XREG_SNR          0x40
43 
44 #define XREG_ADC_ENV      0x0100
45 
46 static int debug;
47 module_param(debug, int, 0644);
48 MODULE_PARM_DESC(debug, "enable verbose debug messages");
49 
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");
55 
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"
63 	"A2\n"
64 	"A2/A\n"
65 	"A2/B\n"
66 	"NICAM\n"
67 	"NICAM/A\n"
68 	"NICAM/B\n");
69 
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");
74 
75 static LIST_HEAD(hybrid_tuner_instance_list);
76 static DEFINE_MUTEX(xc2028_list_mutex);
77 
78 /* struct for storing firmware table */
79 struct firmware_description {
80 	unsigned int  type;
81 	v4l2_std_id   id;
82 	__u16         int_freq;
83 	unsigned char *ptr;
84 	unsigned int  size;
85 };
86 
87 struct firmware_properties {
88 	unsigned int	type;
89 	v4l2_std_id	id;
90 	v4l2_std_id	std_req;
91 	__u16		int_freq;
92 	unsigned int	scode_table;
93 	int 		scode_nr;
94 };
95 
96 enum xc2028_state {
97 	XC2028_NO_FIRMWARE = 0,
98 	XC2028_WAITING_FIRMWARE,
99 	XC2028_ACTIVE,
100 	XC2028_SLEEP,
101 	XC2028_NODEV,
102 };
103 
104 struct xc2028_data {
105 	struct list_head        hybrid_tuner_instance_list;
106 	struct tuner_i2c_props  i2c_props;
107 	__u32			frequency;
108 
109 	enum xc2028_state	state;
110 	const char		*fname;
111 
112 	struct firmware_description *firm;
113 	int			firm_size;
114 	__u16			firm_version;
115 
116 	__u16			hwmodel;
117 	__u16			hwvers;
118 
119 	struct xc2028_ctrl	ctrl;
120 
121 	struct firmware_properties cur_fw;
122 
123 	struct mutex lock;
124 };
125 
126 #define i2c_send(priv, buf, size) ({					\
127 	int _rc;							\
128 	_rc = tuner_i2c_xfer_send(&priv->i2c_props, buf, size);		\
129 	if (size != _rc)						\
130 		tuner_info("i2c output error: rc = %d (should be %d)\n",\
131 			   _rc, (int)size);				\
132 	if (priv->ctrl.msleep)						\
133 		msleep(priv->ctrl.msleep);				\
134 	_rc;								\
135 })
136 
137 #define i2c_send_recv(priv, obuf, osize, ibuf, isize) ({		\
138 	int _rc;							\
139 	_rc = tuner_i2c_xfer_send_recv(&priv->i2c_props, obuf, osize,	\
140 				       ibuf, isize);			\
141 	if (isize != _rc)						\
142 		tuner_err("i2c input error: rc = %d (should be %d)\n",	\
143 			   _rc, (int)isize); 				\
144 	if (priv->ctrl.msleep)						\
145 		msleep(priv->ctrl.msleep);				\
146 	_rc;								\
147 })
148 
149 #define send_seq(priv, data...)	({					\
150 	static u8 _val[] = data;					\
151 	int _rc;							\
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);				\
158 	_rc;								\
159 })
160 
xc2028_get_reg(struct xc2028_data * priv,u16 reg,u16 * val)161 static int xc2028_get_reg(struct xc2028_data *priv, u16 reg, u16 *val)
162 {
163 	unsigned char buf[2];
164 	unsigned char ibuf[2];
165 
166 	tuner_dbg("%s %04x called\n", __func__, reg);
167 
168 	buf[0] = reg >> 8;
169 	buf[1] = (unsigned char) reg;
170 
171 	if (i2c_send_recv(priv, buf, 2, ibuf, 2) != 2)
172 		return -EIO;
173 
174 	*val = (ibuf[1]) | (ibuf[0] << 8);
175 	return 0;
176 }
177 
178 #define dump_firm_type(t) 	dump_firm_type_and_int_freq(t, 0)
dump_firm_type_and_int_freq(unsigned int type,u16 int_freq)179 static void dump_firm_type_and_int_freq(unsigned int type, u16 int_freq)
180 {
181 	if (type & BASE)
182 		printk("BASE ");
183 	if (type & INIT1)
184 		printk("INIT1 ");
185 	if (type & F8MHZ)
186 		printk("F8MHZ ");
187 	if (type & MTS)
188 		printk("MTS ");
189 	if (type & D2620)
190 		printk("D2620 ");
191 	if (type & D2633)
192 		printk("D2633 ");
193 	if (type & DTV6)
194 		printk("DTV6 ");
195 	if (type & QAM)
196 		printk("QAM ");
197 	if (type & DTV7)
198 		printk("DTV7 ");
199 	if (type & DTV78)
200 		printk("DTV78 ");
201 	if (type & DTV8)
202 		printk("DTV8 ");
203 	if (type & FM)
204 		printk("FM ");
205 	if (type & INPUT1)
206 		printk("INPUT1 ");
207 	if (type & LCD)
208 		printk("LCD ");
209 	if (type & NOGD)
210 		printk("NOGD ");
211 	if (type & MONO)
212 		printk("MONO ");
213 	if (type & ATSC)
214 		printk("ATSC ");
215 	if (type & IF)
216 		printk("IF ");
217 	if (type & LG60)
218 		printk("LG60 ");
219 	if (type & ATI638)
220 		printk("ATI638 ");
221 	if (type & OREN538)
222 		printk("OREN538 ");
223 	if (type & OREN36)
224 		printk("OREN36 ");
225 	if (type & TOYOTA388)
226 		printk("TOYOTA388 ");
227 	if (type & TOYOTA794)
228 		printk("TOYOTA794 ");
229 	if (type & DIBCOM52)
230 		printk("DIBCOM52 ");
231 	if (type & ZARLINK456)
232 		printk("ZARLINK456 ");
233 	if (type & CHINA)
234 		printk("CHINA ");
235 	if (type & F6MHZ)
236 		printk("F6MHZ ");
237 	if (type & INPUT2)
238 		printk("INPUT2 ");
239 	if (type & SCODE)
240 		printk("SCODE ");
241 	if (type & HAS_IF)
242 		printk("HAS_IF_%d ", int_freq);
243 }
244 
parse_audio_std_option(void)245 static  v4l2_std_id parse_audio_std_option(void)
246 {
247 	if (strcasecmp(audio_std, "A2") == 0)
248 		return V4L2_STD_A2;
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;
259 
260 	return 0;
261 }
262 
check_device_status(struct xc2028_data * priv)263 static int check_device_status(struct xc2028_data *priv)
264 {
265 	switch (priv->state) {
266 	case XC2028_NO_FIRMWARE:
267 	case XC2028_WAITING_FIRMWARE:
268 		return -EAGAIN;
269 	case XC2028_ACTIVE:
270 		return 1;
271 	case XC2028_SLEEP:
272 		return 0;
273 	case XC2028_NODEV:
274 		return -ENODEV;
275 	}
276 	return 0;
277 }
278 
free_firmware(struct xc2028_data * priv)279 static void free_firmware(struct xc2028_data *priv)
280 {
281 	int i;
282 	tuner_dbg("%s called\n", __func__);
283 
284 	/* free allocated f/w string */
285 	if (priv->fname != firmware_name)
286 		kfree(priv->fname);
287 	priv->fname = NULL;
288 
289 	priv->state = XC2028_NO_FIRMWARE;
290 	memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
291 
292 	if (!priv->firm)
293 		return;
294 
295 	for (i = 0; i < priv->firm_size; i++)
296 		kfree(priv->firm[i].ptr);
297 
298 	kfree(priv->firm);
299 
300 	priv->firm = NULL;
301 	priv->firm_size = 0;
302 }
303 
load_all_firmwares(struct dvb_frontend * fe,const struct firmware * fw)304 static int load_all_firmwares(struct dvb_frontend *fe,
305 			      const struct firmware *fw)
306 {
307 	struct xc2028_data    *priv = fe->tuner_priv;
308 	const unsigned char   *p, *endp;
309 	int                   rc = 0;
310 	int		      n, n_array;
311 	char		      name[33];
312 
313 	tuner_dbg("%s called\n", __func__);
314 
315 	p = fw->data;
316 	endp = p + fw->size;
317 
318 	if (fw->size < sizeof(name) - 1 + 2 + 2) {
319 		tuner_err("Error: firmware file %s has invalid size!\n",
320 			  priv->fname);
321 		goto corrupt;
322 	}
323 
324 	memcpy(name, p, sizeof(name) - 1);
325 	name[sizeof(name) - 1] = 0;
326 	p += sizeof(name) - 1;
327 
328 	priv->firm_version = get_unaligned_le16(p);
329 	p += 2;
330 
331 	n_array = get_unaligned_le16(p);
332 	p += 2;
333 
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);
337 
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");
341 		rc = -ENOMEM;
342 		goto err;
343 	}
344 	priv->firm_size = n_array;
345 
346 	n = -1;
347 	while (p < endp) {
348 		__u32 type, size;
349 		v4l2_std_id id;
350 		__u16 int_freq = 0;
351 
352 		n++;
353 		if (n >= n_array) {
354 			tuner_err("More firmware images in file than "
355 				  "were expected!\n");
356 			goto corrupt;
357 		}
358 
359 		/* Checks if there's enough bytes to read */
360 		if (endp - p < sizeof(type) + sizeof(id) + sizeof(size))
361 			goto header;
362 
363 		type = get_unaligned_le32(p);
364 		p += sizeof(type);
365 
366 		id = get_unaligned_le64(p);
367 		p += sizeof(id);
368 
369 		if (type & HAS_IF) {
370 			int_freq = get_unaligned_le16(p);
371 			p += sizeof(int_freq);
372 			if (endp - p < sizeof(size))
373 				goto header;
374 		}
375 
376 		size = get_unaligned_le32(p);
377 		p += sizeof(size);
378 
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);
386 			goto corrupt;
387 		}
388 
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");
392 			rc = -ENOMEM;
393 			goto err;
394 		}
395 		tuner_dbg("Reading firmware type ");
396 		if (debug) {
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);
400 		}
401 
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;
407 
408 		p += size;
409 	}
410 
411 	if (n + 1 != priv->firm_size) {
412 		tuner_err("Firmware file is incomplete!\n");
413 		goto corrupt;
414 	}
415 
416 	goto done;
417 
418 header:
419 	tuner_err("Firmware header is incomplete!\n");
420 corrupt:
421 	rc = -EINVAL;
422 	tuner_err("Error: firmware file is corrupted!\n");
423 
424 err:
425 	tuner_info("Releasing partially loaded firmware file.\n");
426 	free_firmware(priv);
427 
428 done:
429 	if (rc == 0)
430 		tuner_dbg("Firmware files loaded.\n");
431 	else
432 		priv->state = XC2028_NODEV;
433 
434 	return rc;
435 }
436 
seek_firmware(struct dvb_frontend * fe,unsigned int type,v4l2_std_id * id)437 static int seek_firmware(struct dvb_frontend *fe, unsigned int type,
438 			 v4l2_std_id *id)
439 {
440 	struct xc2028_data *priv = fe->tuner_priv;
441 	int                 i, best_i = -1, best_nr_matches = 0;
442 	unsigned int        type_mask = 0;
443 
444 	tuner_dbg("%s called, want type=", __func__);
445 	if (debug) {
446 		dump_firm_type(type);
447 		printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
448 	}
449 
450 	if (!priv->firm) {
451 		tuner_err("Error! firmware not loaded\n");
452 		return -EINVAL;
453 	}
454 
455 	if (((type & ~SCODE) == 0) && (*id == 0))
456 		*id = V4L2_STD_PAL;
457 
458 	if (type & BASE)
459 		type_mask = BASE_TYPES;
460 	else if (type & SCODE) {
461 		type &= SCODE_TYPES;
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;
467 
468 	type &= type_mask;
469 
470 	if (!(type & SCODE))
471 		type_mask = ~0;
472 
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))
477 			goto found;
478 	}
479 
480 	/* Seek for generic video standard match */
481 	for (i = 0; i < priv->firm_size; i++) {
482 		v4l2_std_id match_mask;
483 		int nr_matches;
484 
485 		if (type != (priv->firm[i].type & type_mask))
486 			continue;
487 
488 		match_mask = *id & priv->firm[i].id;
489 		if (!match_mask)
490 			continue;
491 
492 		if ((*id & match_mask) == *id)
493 			goto found; /* Supports all the requested standards */
494 
495 		nr_matches = hweight64(match_mask);
496 		if (nr_matches > best_nr_matches) {
497 			best_nr_matches = nr_matches;
498 			best_i = i;
499 		}
500 	}
501 
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);
507 		i = best_i;
508 		goto found;
509 	}
510 
511 	/*FIXME: Would make sense to seek for type "hint" match ? */
512 
513 	i = -ENOENT;
514 	goto ret;
515 
516 found:
517 	*id = priv->firm[i].id;
518 
519 ret:
520 	tuner_dbg("%s firmware for type=", (i < 0) ? "Can't find" : "Found");
521 	if (debug) {
522 		dump_firm_type(type);
523 		printk("(%x), id %016llx.\n", type, (unsigned long long)*id);
524 	}
525 	return i;
526 }
527 
do_tuner_callback(struct dvb_frontend * fe,int cmd,int arg)528 static inline int do_tuner_callback(struct dvb_frontend *fe, int cmd, int arg)
529 {
530 	struct xc2028_data *priv = fe->tuner_priv;
531 
532 	/* analog side (tuner-core) uses i2c_adap->algo_data.
533 	 * digital side is not guaranteed to have algo_data defined.
534 	 *
535 	 * digital side will always have fe->dvb defined.
536 	 * analog side (tuner-core) doesn't (yet) define fe->dvb.
537 	 */
538 
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);
543 }
544 
load_firmware(struct dvb_frontend * fe,unsigned int type,v4l2_std_id * id)545 static int load_firmware(struct dvb_frontend *fe, unsigned int type,
546 			 v4l2_std_id *id)
547 {
548 	struct xc2028_data *priv = fe->tuner_priv;
549 	int                pos, rc;
550 	unsigned char      *p, *endp, buf[MAX_XFER_SIZE];
551 
552 	if (priv->ctrl.max_len > sizeof(buf))
553 		priv->ctrl.max_len = sizeof(buf);
554 
555 	tuner_dbg("%s called\n", __func__);
556 
557 	pos = seek_firmware(fe, type, id);
558 	if (pos < 0)
559 		return pos;
560 
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);
565 
566 	p = priv->firm[pos].ptr;
567 	endp = p + priv->firm[pos].size;
568 
569 	while (p < endp) {
570 		__u16 size;
571 
572 		/* Checks if there's enough bytes to read */
573 		if (p + sizeof(size) > endp) {
574 			tuner_err("Firmware chunk size is wrong\n");
575 			return -EINVAL;
576 		}
577 
578 		size = le16_to_cpu(*(__le16 *) p);
579 		p += sizeof(size);
580 
581 		if (size == 0xffff)
582 			return 0;
583 
584 		if (!size) {
585 			/* Special callback command received */
586 			rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
587 			if (rc < 0) {
588 				tuner_err("Error at RESET code %d\n",
589 					   (*p) & 0x7f);
590 				return -EINVAL;
591 			}
592 			continue;
593 		}
594 		if (size >= 0xff00) {
595 			switch (size) {
596 			case 0xff00:
597 				rc = do_tuner_callback(fe, XC2028_RESET_CLK, 0);
598 				if (rc < 0) {
599 					tuner_err("Error at RESET code %d\n",
600 						  (*p) & 0x7f);
601 					return -EINVAL;
602 				}
603 				break;
604 			default:
605 				tuner_info("Invalid RESET code %d\n",
606 					   size & 0x7f);
607 				return -EINVAL;
608 
609 			}
610 			continue;
611 		}
612 
613 		/* Checks for a sleep command */
614 		if (size & 0x8000) {
615 			msleep(size & 0x7fff);
616 			continue;
617 		}
618 
619 		if ((size + p > endp)) {
620 			tuner_err("missing bytes: need %d, have %d\n",
621 				   size, (int)(endp - p));
622 			return -EINVAL;
623 		}
624 
625 		buf[0] = *p;
626 		p++;
627 		size--;
628 
629 		/* Sends message chunks */
630 		while (size > 0) {
631 			int len = (size < priv->ctrl.max_len - 1) ?
632 				   size : priv->ctrl.max_len - 1;
633 
634 			memcpy(buf + 1, p, len);
635 
636 			rc = i2c_send(priv, buf, len + 1);
637 			if (rc < 0) {
638 				tuner_err("%d returned from send\n", rc);
639 				return -EINVAL;
640 			}
641 
642 			p += len;
643 			size -= len;
644 		}
645 
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);
650 			return rc;
651 		}
652 	}
653 	return 0;
654 }
655 
load_scode(struct dvb_frontend * fe,unsigned int type,v4l2_std_id * id,__u16 int_freq,int scode)656 static int load_scode(struct dvb_frontend *fe, unsigned int type,
657 			 v4l2_std_id *id, __u16 int_freq, int scode)
658 {
659 	struct xc2028_data *priv = fe->tuner_priv;
660 	int                pos, rc;
661 	unsigned char	   *p;
662 
663 	tuner_dbg("%s called\n", __func__);
664 
665 	if (!int_freq) {
666 		pos = seek_firmware(fe, type, id);
667 		if (pos < 0)
668 			return pos;
669 	} else {
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))
673 				break;
674 		}
675 		if (pos == priv->firm_size)
676 			return -ENOENT;
677 	}
678 
679 	p = priv->firm[pos].ptr;
680 
681 	if (priv->firm[pos].type & HAS_IF) {
682 		if (priv->firm[pos].size != 12 * 16 || scode >= 16)
683 			return -EINVAL;
684 		p += 12 * scode;
685 	} else {
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)
690 			return -EINVAL;
691 		p += 14 * scode + 2;
692 	}
693 
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);
699 
700 	if (priv->firm_version < 0x0202)
701 		rc = send_seq(priv, {0x20, 0x00, 0x00, 0x00});
702 	else
703 		rc = send_seq(priv, {0xa0, 0x00, 0x00, 0x00});
704 	if (rc < 0)
705 		return -EIO;
706 
707 	rc = i2c_send(priv, p, 12);
708 	if (rc < 0)
709 		return -EIO;
710 
711 	rc = send_seq(priv, {0x00, 0x8c});
712 	if (rc < 0)
713 		return -EIO;
714 
715 	return 0;
716 }
717 
718 static int xc2028_sleep(struct dvb_frontend *fe);
719 
check_firmware(struct dvb_frontend * fe,unsigned int type,v4l2_std_id std,__u16 int_freq)720 static int check_firmware(struct dvb_frontend *fe, unsigned int type,
721 			  v4l2_std_id std, __u16 int_freq)
722 {
723 	struct xc2028_data         *priv = fe->tuner_priv;
724 	struct firmware_properties new_fw;
725 	int			   rc, retry_count = 0;
726 	u16			   version, hwmodel;
727 	v4l2_std_id		   std0;
728 
729 	tuner_dbg("%s called\n", __func__);
730 
731 	rc = check_device_status(priv);
732 	if (rc < 0)
733 		return rc;
734 
735 	if (priv->ctrl.mts && !(type & FM))
736 		type |= MTS;
737 
738 retry:
739 	new_fw.type = type;
740 	new_fw.id = std;
741 	new_fw.std_req = std;
742 	new_fw.scode_table = SCODE | priv->ctrl.scode_table;
743 	new_fw.scode_nr = 0;
744 	new_fw.int_freq = int_freq;
745 
746 	tuner_dbg("checking firmware, user requested type=");
747 	if (debug) {
748 		dump_firm_type(new_fw.type);
749 		printk("(%x), id %016llx, ", new_fw.type,
750 		       (unsigned long long)new_fw.std_req);
751 		if (!int_freq) {
752 			printk("scode_tbl ");
753 			dump_firm_type(priv->ctrl.scode_table);
754 			printk("(%x), ", priv->ctrl.scode_table);
755 		} else
756 			printk("int_freq %d, ", new_fw.int_freq);
757 		printk("scode_nr %d\n", new_fw.scode_nr);
758 	}
759 
760 	/*
761 	 * No need to reload base firmware if it matches and if the tuner
762 	 * is not at sleep mode
763 	 */
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");
768 		goto skip_base;
769 	}
770 
771 	/* Updating BASE - forget about all currently loaded firmware */
772 	memset(&priv->cur_fw, 0, sizeof(priv->cur_fw));
773 
774 	/* Reset is needed before loading firmware */
775 	rc = do_tuner_callback(fe, XC2028_TUNER_RESET, 0);
776 	if (rc < 0)
777 		goto fail;
778 
779 	/* BASE firmwares are all std0 */
780 	std0 = 0;
781 	rc = load_firmware(fe, BASE | new_fw.type, &std0);
782 	if (rc < 0) {
783 		tuner_err("Error %d while loading base firmware\n",
784 			  rc);
785 		goto fail;
786 	}
787 
788 	/* Load INIT1, if needed */
789 	tuner_dbg("Load init1 firmware, if exists\n");
790 
791 	rc = load_firmware(fe, BASE | INIT1 | new_fw.type, &std0);
792 	if (rc == -ENOENT)
793 		rc = load_firmware(fe, (BASE | INIT1 | new_fw.type) & ~F8MHZ,
794 				   &std0);
795 	if (rc < 0 && rc != -ENOENT) {
796 		tuner_err("Error %d while loading init1 firmware\n",
797 			  rc);
798 		goto fail;
799 	}
800 
801 skip_base:
802 	/*
803 	 * No need to reload standard specific firmware if base firmware
804 	 * was not reloaded and requested video standards have not changed.
805 	 */
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;
810 	}
811 
812 	/* Reloading std-specific firmware forces a SCODE update */
813 	priv->cur_fw.scode_table = 0;
814 
815 	rc = load_firmware(fe, new_fw.type, &new_fw.id);
816 	if (rc == -ENOENT)
817 		rc = load_firmware(fe, new_fw.type & ~F8MHZ, &new_fw.id);
818 
819 	if (rc < 0)
820 		goto fail;
821 
822 skip_std_specific:
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");
826 		goto check_device;
827 	}
828 
829 	if (new_fw.type & FM)
830 		goto check_device;
831 
832 	/* Load SCODE firmware, if exists */
833 	tuner_dbg("Trying to load scode %d\n", new_fw.scode_nr);
834 
835 	rc = load_scode(fe, new_fw.type | new_fw.scode_table, &new_fw.id,
836 			new_fw.int_freq, new_fw.scode_nr);
837 
838 check_device:
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");
842 		goto fail;
843 	}
844 
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);
849 
850 
851 	if (priv->ctrl.read_not_reliable)
852 		goto read_not_reliable;
853 
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");
858 			goto fail;
859 		} else {
860 			tuner_err("Returned an incorrect version. However, "
861 				  "read is not reliable enough. Ignoring it.\n");
862 			hwmodel = 3028;
863 		}
864 	}
865 
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 "
873 			  "hung?\n");
874 		goto fail;
875 	}
876 
877 read_not_reliable:
878 	priv->cur_fw = new_fw;
879 
880 	/*
881 	 * By setting BASE in cur_fw.type only after successfully loading all
882 	 * firmwares, we can:
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.
885 	 */
886 	priv->cur_fw.type |= BASE;
887 	priv->state = XC2028_ACTIVE;
888 
889 	return 0;
890 
891 fail:
892 	free_firmware(priv);
893 
894 	if (retry_count < 8) {
895 		msleep(50);
896 		retry_count++;
897 		tuner_dbg("Retrying firmware load\n");
898 		goto retry;
899 	}
900 
901 	/* Firmware didn't load. Put the device to sleep */
902 	xc2028_sleep(fe);
903 
904 	if (rc == -ENOENT)
905 		rc = -EINVAL;
906 	return rc;
907 }
908 
xc2028_signal(struct dvb_frontend * fe,u16 * strength)909 static int xc2028_signal(struct dvb_frontend *fe, u16 *strength)
910 {
911 	struct xc2028_data *priv = fe->tuner_priv;
912 	u16                 frq_lock, signal = 0;
913 	int                 rc, i;
914 
915 	tuner_dbg("%s called\n", __func__);
916 
917 	rc = check_device_status(priv);
918 	if (rc < 0)
919 		return rc;
920 
921 	/* If the device is sleeping, no channel is tuned */
922 	if (!rc) {
923 		*strength = 0;
924 		return 0;
925 	}
926 
927 	mutex_lock(&priv->lock);
928 
929 	/* Sync Lock Indicator */
930 	for (i = 0; i < 3; i++) {
931 		rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
932 		if (rc < 0)
933 			goto ret;
934 
935 		if (frq_lock)
936 			break;
937 		msleep(6);
938 	}
939 
940 	/* Frequency didn't lock */
941 	if (frq_lock == 2)
942 		goto ret;
943 
944 	/* Get SNR of the video signal */
945 	rc = xc2028_get_reg(priv, XREG_SNR, &signal);
946 	if (rc < 0)
947 		goto ret;
948 
949 	/* Signal level is 3 bits only */
950 
951 	signal = ((1 << 12) - 1) | ((signal & 0x07) << 12);
952 
953 ret:
954 	mutex_unlock(&priv->lock);
955 
956 	*strength = signal;
957 
958 	tuner_dbg("signal strength is %d\n", signal);
959 
960 	return rc;
961 }
962 
xc2028_get_afc(struct dvb_frontend * fe,s32 * afc)963 static int xc2028_get_afc(struct dvb_frontend *fe, s32 *afc)
964 {
965 	struct xc2028_data *priv = fe->tuner_priv;
966 	int i, rc;
967 	u16 frq_lock = 0;
968 	s16 afc_reg = 0;
969 
970 	rc = check_device_status(priv);
971 	if (rc < 0)
972 		return rc;
973 
974 	/* If the device is sleeping, no channel is tuned */
975 	if (!rc) {
976 		*afc = 0;
977 		return 0;
978 	}
979 
980 	mutex_lock(&priv->lock);
981 
982 	/* Sync Lock Indicator */
983 	for (i = 0; i < 3; i++) {
984 		rc = xc2028_get_reg(priv, XREG_LOCK, &frq_lock);
985 		if (rc < 0)
986 			goto ret;
987 
988 		if (frq_lock)
989 			break;
990 		msleep(6);
991 	}
992 
993 	/* Frequency didn't lock */
994 	if (frq_lock == 2)
995 		goto ret;
996 
997 	/* Get AFC */
998 	rc = xc2028_get_reg(priv, XREG_FREQ_ERROR, &afc_reg);
999 	if (rc < 0)
1000 		goto ret;
1001 
1002 	*afc = afc_reg * 15625; /* Hz */
1003 
1004 	tuner_dbg("AFC is %d Hz\n", *afc);
1005 
1006 ret:
1007 	mutex_unlock(&priv->lock);
1008 
1009 	return rc;
1010 }
1011 
1012 #define DIV 15625
1013 
generic_set_freq(struct dvb_frontend * fe,u32 freq,enum v4l2_tuner_type new_type,unsigned int type,v4l2_std_id std,u16 int_freq)1014 static int generic_set_freq(struct dvb_frontend *fe, u32 freq /* in HZ */,
1015 			    enum v4l2_tuner_type new_type,
1016 			    unsigned int type,
1017 			    v4l2_std_id std,
1018 			    u16 int_freq)
1019 {
1020 	struct xc2028_data *priv = fe->tuner_priv;
1021 	int		   rc = -EINVAL;
1022 	unsigned char	   buf[4];
1023 	u32		   div, offset = 0;
1024 
1025 	tuner_dbg("%s called\n", __func__);
1026 
1027 	mutex_lock(&priv->lock);
1028 
1029 	tuner_dbg("should set frequency %d kHz\n", freq / 1000);
1030 
1031 	if (check_firmware(fe, type, std, int_freq) < 0)
1032 		goto ret;
1033 
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.
1040 	 */
1041 	switch (new_type) {
1042 	case V4L2_TUNER_ANALOG_TV:
1043 		rc = send_seq(priv, {0x00, 0x00});
1044 
1045 		/* Analog mode requires offset = 0 */
1046 		break;
1047 	case V4L2_TUNER_RADIO:
1048 		/* Radio mode requires offset = 0 */
1049 		break;
1050 	case V4L2_TUNER_DIGITAL_TV:
1051 		/*
1052 		 * Digital modes require an offset to adjust to the
1053 		 * proper frequency. The offset depends on what
1054 		 * firmware version is used.
1055 		 */
1056 
1057 		/*
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
1062 		 */
1063 
1064 		/*
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
1071 		 * firmware.
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
1074 		 * bandwidth.
1075 		 */
1076 
1077 		if (priv->cur_fw.type & DTV6)
1078 			offset = 1750000;
1079 		else	/* DTV7 or DTV8 or DTV78 */
1080 			offset = 2750000;
1081 
1082 		/*
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
1087 		 * newer firmwares
1088 		 */
1089 
1090 		/*
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>
1094 		 */
1095 
1096 #if 0
1097 		/*
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 bellow are welcome
1102 		 */
1103 
1104 		if (priv->firm_version < 0x0302) {
1105 			if (priv->cur_fw.type & DTV7)
1106 				offset += 500000;
1107 		} else {
1108 			if (priv->cur_fw.type & DTV7)
1109 				offset -= 300000;
1110 			else if (type != ATSC) /* DVB @6MHz, DTV 8 and DTV 7/8 */
1111 				offset += 200000;
1112 		}
1113 #endif
1114 		break;
1115 	default:
1116 		tuner_err("Unsupported tuner type %d.\n", new_type);
1117 		break;
1118 	}
1119 
1120 	div = (freq - offset + DIV / 2) / DIV;
1121 
1122 	/* CMD= Set frequency */
1123 	if (priv->firm_version < 0x0202)
1124 		rc = send_seq(priv, {0x00, XREG_RF_FREQ, 0x00, 0x00});
1125 	else
1126 		rc = send_seq(priv, {0x80, XREG_RF_FREQ, 0x00, 0x00});
1127 	if (rc < 0)
1128 		goto ret;
1129 
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.
1133 	 */
1134 	if (priv->ctrl.msleep)
1135 		msleep(priv->ctrl.msleep);
1136 	do_tuner_callback(fe, XC2028_RESET_CLK, 1);
1137 
1138 	msleep(10);
1139 
1140 	buf[0] = 0xff & (div >> 24);
1141 	buf[1] = 0xff & (div >> 16);
1142 	buf[2] = 0xff & (div >> 8);
1143 	buf[3] = 0xff & (div);
1144 
1145 	rc = i2c_send(priv, buf, sizeof(buf));
1146 	if (rc < 0)
1147 		goto ret;
1148 	msleep(100);
1149 
1150 	priv->frequency = freq;
1151 
1152 	tuner_dbg("divisor= %*ph (freq=%d.%03d)\n", 4, buf,
1153 	       freq / 1000000, (freq % 1000000) / 1000);
1154 
1155 	rc = 0;
1156 
1157 ret:
1158 	mutex_unlock(&priv->lock);
1159 
1160 	return rc;
1161 }
1162 
xc2028_set_analog_freq(struct dvb_frontend * fe,struct analog_parameters * p)1163 static int xc2028_set_analog_freq(struct dvb_frontend *fe,
1164 			      struct analog_parameters *p)
1165 {
1166 	struct xc2028_data *priv = fe->tuner_priv;
1167 	unsigned int       type=0;
1168 
1169 	tuner_dbg("%s called\n", __func__);
1170 
1171 	if (p->mode == V4L2_TUNER_RADIO) {
1172 		type |= FM;
1173 		if (priv->ctrl.input1)
1174 			type |= INPUT1;
1175 		return generic_set_freq(fe, (625l * p->frequency) / 10,
1176 				V4L2_TUNER_RADIO, type, 0, 0);
1177 	}
1178 
1179 	/* if std is not defined, choose one */
1180 	if (!p->std)
1181 		p->std = V4L2_STD_MN;
1182 
1183 	/* PAL/M, PAL/N, PAL/Nc and NTSC variants should use 6MHz firmware */
1184 	if (!(p->std & V4L2_STD_MN))
1185 		type |= F8MHZ;
1186 
1187 	/* Add audio hack to std mask */
1188 	p->std |= parse_audio_std_option();
1189 
1190 	return generic_set_freq(fe, 62500l * p->frequency,
1191 				V4L2_TUNER_ANALOG_TV, type, p->std, 0);
1192 }
1193 
xc2028_set_params(struct dvb_frontend * fe)1194 static int xc2028_set_params(struct dvb_frontend *fe)
1195 {
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;
1200 	int rc;
1201 	unsigned int       type = 0;
1202 	u16                demod = 0;
1203 
1204 	tuner_dbg("%s called\n", __func__);
1205 
1206 	rc = check_device_status(priv);
1207 	if (rc < 0)
1208 		return rc;
1209 
1210 	switch (delsys) {
1211 	case SYS_DVBT:
1212 	case SYS_DVBT2:
1213 		/*
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>
1217 		 */
1218 		if (bw <= 6000000)
1219 			type |= QAM;
1220 
1221 		switch (priv->ctrl.type) {
1222 		case XC2028_D2633:
1223 			type |= D2633;
1224 			break;
1225 		case XC2028_D2620:
1226 			type |= D2620;
1227 			break;
1228 		case XC2028_AUTO:
1229 		default:
1230 			/* Zarlink seems to need D2633 */
1231 			if (priv->ctrl.demod == XC3028_FE_ZARLINK456)
1232 				type |= D2633;
1233 			else
1234 				type |= D2620;
1235 		}
1236 		break;
1237 	case SYS_ATSC:
1238 		/* The only ATSC firmware (at least on v2.7) is D2633 */
1239 		type |= ATSC | D2633;
1240 		break;
1241 	/* DVB-S and pure QAM (FE_QAM) are not supported */
1242 	default:
1243 		return -EINVAL;
1244 	}
1245 
1246 	if (bw <= 6000000) {
1247 		type |= DTV6;
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;
1253 		else
1254 			priv->ctrl.uhfbw8 = 0;
1255 		type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV7;
1256 		type |= F8MHZ;
1257 	} else {
1258 		if (c->frequency < 470000000)
1259 			priv->ctrl.vhfbw7 = 0;
1260 		else
1261 			priv->ctrl.uhfbw8 = 1;
1262 		type |= (priv->ctrl.vhfbw7 && priv->ctrl.uhfbw8) ? DTV78 : DTV8;
1263 		type |= F8MHZ;
1264 	}
1265 
1266 	/* All S-code tables need a 200kHz shift */
1267 	if (priv->ctrl.demod) {
1268 		demod = priv->ctrl.demod;
1269 
1270 		/*
1271 		 * Newer firmwares require a 200 kHz offset only for ATSC
1272 		 */
1273 		if (type == ATSC || priv->firm_version < 0x0302)
1274 			demod += 200;
1275 		/*
1276 		 * The DTV7 S-code table needs a 700 kHz shift.
1277 		 *
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.
1281 		 *
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>
1285 		 */
1286 	}
1287 
1288 	return generic_set_freq(fe, c->frequency,
1289 				V4L2_TUNER_DIGITAL_TV, type, 0, demod);
1290 }
1291 
xc2028_sleep(struct dvb_frontend * fe)1292 static int xc2028_sleep(struct dvb_frontend *fe)
1293 {
1294 	struct xc2028_data *priv = fe->tuner_priv;
1295 	int rc;
1296 
1297 	rc = check_device_status(priv);
1298 	if (rc < 0)
1299 		return rc;
1300 
1301 	/* Device is already in sleep mode */
1302 	if (!rc)
1303 		return 0;
1304 
1305 	/* Avoid firmware reload on slow devices or if PM disabled */
1306 	if (no_poweroff || priv->ctrl.disable_power_mgmt)
1307 		return 0;
1308 
1309 	tuner_dbg("Putting xc2028/3028 into poweroff mode.\n");
1310 	if (debug > 1) {
1311 		tuner_dbg("Printing sleep stack trace:\n");
1312 		dump_stack();
1313 	}
1314 
1315 	mutex_lock(&priv->lock);
1316 
1317 	if (priv->firm_version < 0x0202)
1318 		rc = send_seq(priv, {0x00, XREG_POWER_DOWN, 0x00, 0x00});
1319 	else
1320 		rc = send_seq(priv, {0x80, XREG_POWER_DOWN, 0x00, 0x00});
1321 
1322 	if (rc >= 0)
1323 		priv->state = XC2028_SLEEP;
1324 
1325 	mutex_unlock(&priv->lock);
1326 
1327 	return rc;
1328 }
1329 
xc2028_dvb_release(struct dvb_frontend * fe)1330 static int xc2028_dvb_release(struct dvb_frontend *fe)
1331 {
1332 	struct xc2028_data *priv = fe->tuner_priv;
1333 
1334 	tuner_dbg("%s called\n", __func__);
1335 
1336 	mutex_lock(&xc2028_list_mutex);
1337 
1338 	/* only perform final cleanup if this is the last instance */
1339 	if (hybrid_tuner_report_instance_count(priv) == 1)
1340 		free_firmware(priv);
1341 
1342 	if (priv)
1343 		hybrid_tuner_release_state(priv);
1344 
1345 	mutex_unlock(&xc2028_list_mutex);
1346 
1347 	fe->tuner_priv = NULL;
1348 
1349 	return 0;
1350 }
1351 
xc2028_get_frequency(struct dvb_frontend * fe,u32 * frequency)1352 static int xc2028_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1353 {
1354 	struct xc2028_data *priv = fe->tuner_priv;
1355 	int rc;
1356 
1357 	tuner_dbg("%s called\n", __func__);
1358 
1359 	rc = check_device_status(priv);
1360 	if (rc < 0)
1361 		return rc;
1362 
1363 	*frequency = priv->frequency;
1364 
1365 	return 0;
1366 }
1367 
load_firmware_cb(const struct firmware * fw,void * context)1368 static void load_firmware_cb(const struct firmware *fw,
1369 			     void *context)
1370 {
1371 	struct dvb_frontend *fe = context;
1372 	struct xc2028_data *priv = fe->tuner_priv;
1373 	int rc;
1374 
1375 	tuner_dbg("request_firmware_nowait(): %s\n", fw ? "OK" : "error");
1376 	if (!fw) {
1377 		tuner_err("Could not load firmware %s.\n", priv->fname);
1378 		priv->state = XC2028_NODEV;
1379 		return;
1380 	}
1381 
1382 	rc = load_all_firmwares(fe, fw);
1383 
1384 	release_firmware(fw);
1385 
1386 	if (rc < 0)
1387 		return;
1388 	priv->state = XC2028_ACTIVE;
1389 }
1390 
xc2028_set_config(struct dvb_frontend * fe,void * priv_cfg)1391 static int xc2028_set_config(struct dvb_frontend *fe, void *priv_cfg)
1392 {
1393 	struct xc2028_data *priv = fe->tuner_priv;
1394 	struct xc2028_ctrl *p    = priv_cfg;
1395 	int                 rc   = 0;
1396 
1397 	tuner_dbg("%s called\n", __func__);
1398 
1399 	mutex_lock(&priv->lock);
1400 
1401 	/*
1402 	 * Copy the config data.
1403 	 */
1404 	memcpy(&priv->ctrl, p, sizeof(priv->ctrl));
1405 
1406 	/*
1407 	 * If firmware name changed, frees firmware. As free_firmware will
1408 	 * reset the status to NO_FIRMWARE, this forces a new request_firmware
1409 	 */
1410 	if (!firmware_name[0] && p->fname &&
1411 	    priv->fname && strcmp(p->fname, priv->fname))
1412 		free_firmware(priv);
1413 
1414 	if (priv->ctrl.max_len < 9)
1415 		priv->ctrl.max_len = 13;
1416 
1417 	if (priv->state == XC2028_NO_FIRMWARE) {
1418 		if (!firmware_name[0])
1419 			priv->fname = kstrdup(p->fname, GFP_KERNEL);
1420 		else
1421 			priv->fname = firmware_name;
1422 
1423 		if (!priv->fname) {
1424 			rc = -ENOMEM;
1425 			goto unlock;
1426 		}
1427 
1428 		rc = request_firmware_nowait(THIS_MODULE, 1,
1429 					     priv->fname,
1430 					     priv->i2c_props.adap->dev.parent,
1431 					     GFP_KERNEL,
1432 					     fe, load_firmware_cb);
1433 		if (rc < 0) {
1434 			tuner_err("Failed to request firmware %s\n",
1435 				  priv->fname);
1436 			priv->state = XC2028_NODEV;
1437 		} else
1438 			priv->state = XC2028_WAITING_FIRMWARE;
1439 	}
1440 unlock:
1441 	mutex_unlock(&priv->lock);
1442 
1443 	return rc;
1444 }
1445 
1446 static const struct dvb_tuner_ops xc2028_dvb_tuner_ops = {
1447 	.info = {
1448 		 .name = "Xceive XC3028",
1449 		 .frequency_min = 42000000,
1450 		 .frequency_max = 864000000,
1451 		 .frequency_step = 50000,
1452 		 },
1453 
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,
1462 };
1463 
xc2028_attach(struct dvb_frontend * fe,struct xc2028_config * cfg)1464 struct dvb_frontend *xc2028_attach(struct dvb_frontend *fe,
1465 				   struct xc2028_config *cfg)
1466 {
1467 	struct xc2028_data *priv;
1468 	int instance;
1469 
1470 	if (debug)
1471 		printk(KERN_DEBUG "xc2028: Xcv2028/3028 init called!\n");
1472 
1473 	if (NULL == cfg)
1474 		return NULL;
1475 
1476 	if (!fe) {
1477 		printk(KERN_ERR "xc2028: No frontend!\n");
1478 		return NULL;
1479 	}
1480 
1481 	mutex_lock(&xc2028_list_mutex);
1482 
1483 	instance = hybrid_tuner_request_state(struct xc2028_data, priv,
1484 					      hybrid_tuner_instance_list,
1485 					      cfg->i2c_adap, cfg->i2c_addr,
1486 					      "xc2028");
1487 	switch (instance) {
1488 	case 0:
1489 		/* memory allocation failure */
1490 		goto fail;
1491 	case 1:
1492 		/* new tuner instance */
1493 		priv->ctrl.max_len = 13;
1494 
1495 		mutex_init(&priv->lock);
1496 
1497 		fe->tuner_priv = priv;
1498 		break;
1499 	case 2:
1500 		/* existing tuner instance */
1501 		fe->tuner_priv = priv;
1502 		break;
1503 	}
1504 
1505 	memcpy(&fe->ops.tuner_ops, &xc2028_dvb_tuner_ops,
1506 	       sizeof(xc2028_dvb_tuner_ops));
1507 
1508 	tuner_info("type set to %s\n", "XCeive xc2028/xc3028 tuner");
1509 
1510 	if (cfg->ctrl)
1511 		xc2028_set_config(fe, cfg->ctrl);
1512 
1513 	mutex_unlock(&xc2028_list_mutex);
1514 
1515 	return fe;
1516 fail:
1517 	mutex_unlock(&xc2028_list_mutex);
1518 
1519 	xc2028_dvb_release(fe);
1520 	return NULL;
1521 }
1522 
1523 EXPORT_SYMBOL(xc2028_attach);
1524 
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");
1529 MODULE_FIRMWARE(XC2028_DEFAULT_FIRMWARE);
1530 MODULE_FIRMWARE(XC3028L_DEFAULT_FIRMWARE);
1531