1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3    tda18271-fe.c - driver for the Philips / NXP TDA18271 silicon tuner
4
5    Copyright (C) 2007, 2008 Michael Krufky <mkrufky@linuxtv.org>
6
7*/
8
9#include "tda18271-priv.h"
10#include "tda8290.h"
11
12#include <linux/delay.h>
13#include <linux/videodev2.h>
14
15int tda18271_debug;
16module_param_named(debug, tda18271_debug, int, 0644);
17MODULE_PARM_DESC(debug, "set debug level (info=1, map=2, reg=4, adv=8, cal=16 (or-able))");
18
19static int tda18271_cal_on_startup = -1;
20module_param_named(cal, tda18271_cal_on_startup, int, 0644);
21MODULE_PARM_DESC(cal, "perform RF tracking filter calibration on startup");
22
23static DEFINE_MUTEX(tda18271_list_mutex);
24static LIST_HEAD(hybrid_tuner_instance_list);
25
26/*---------------------------------------------------------------------*/
27
28static int tda18271_toggle_output(struct dvb_frontend *fe, int standby)
29{
30	struct tda18271_priv *priv = fe->tuner_priv;
31
32	int ret = tda18271_set_standby_mode(fe, standby ? 1 : 0,
33			priv->output_opt & TDA18271_OUTPUT_LT_OFF ? 1 : 0,
34			priv->output_opt & TDA18271_OUTPUT_XT_OFF ? 1 : 0);
35
36	if (tda_fail(ret))
37		goto fail;
38
39	tda_dbg("%s mode: xtal oscillator %s, slave tuner loop through %s\n",
40		standby ? "standby" : "active",
41		priv->output_opt & TDA18271_OUTPUT_XT_OFF ? "off" : "on",
42		priv->output_opt & TDA18271_OUTPUT_LT_OFF ? "off" : "on");
43fail:
44	return ret;
45}
46
47/*---------------------------------------------------------------------*/
48
49static inline int charge_pump_source(struct dvb_frontend *fe, int force)
50{
51	struct tda18271_priv *priv = fe->tuner_priv;
52	return tda18271_charge_pump_source(fe,
53					   (priv->role == TDA18271_SLAVE) ?
54					   TDA18271_CAL_PLL :
55					   TDA18271_MAIN_PLL, force);
56}
57
58static inline void tda18271_set_if_notch(struct dvb_frontend *fe)
59{
60	struct tda18271_priv *priv = fe->tuner_priv;
61	unsigned char *regs = priv->tda18271_regs;
62
63	switch (priv->mode) {
64	case TDA18271_ANALOG:
65		regs[R_MPD]  &= ~0x80; /* IF notch = 0 */
66		break;
67	case TDA18271_DIGITAL:
68		regs[R_MPD]  |= 0x80; /* IF notch = 1 */
69		break;
70	}
71}
72
73static int tda18271_channel_configuration(struct dvb_frontend *fe,
74					  struct tda18271_std_map_item *map,
75					  u32 freq, u32 bw)
76{
77	struct tda18271_priv *priv = fe->tuner_priv;
78	unsigned char *regs = priv->tda18271_regs;
79	int ret;
80	u32 N;
81
82	/* update TV broadcast parameters */
83
84	/* set standard */
85	regs[R_EP3]  &= ~0x1f; /* clear std bits */
86	regs[R_EP3]  |= (map->agc_mode << 3) | map->std;
87
88	if (priv->id == TDA18271HDC2) {
89		/* set rfagc to high speed mode */
90		regs[R_EP3] &= ~0x04;
91	}
92
93	/* set cal mode to normal */
94	regs[R_EP4]  &= ~0x03;
95
96	/* update IF output level */
97	regs[R_EP4]  &= ~0x1c; /* clear if level bits */
98	regs[R_EP4]  |= (map->if_lvl << 2);
99
100	/* update FM_RFn */
101	regs[R_EP4]  &= ~0x80;
102	regs[R_EP4]  |= map->fm_rfn << 7;
103
104	/* update rf top / if top */
105	regs[R_EB22]  = 0x00;
106	regs[R_EB22] |= map->rfagc_top;
107	ret = tda18271_write_regs(fe, R_EB22, 1);
108	if (tda_fail(ret))
109		goto fail;
110
111	/* --------------------------------------------------------------- */
112
113	/* disable Power Level Indicator */
114	regs[R_EP1]  |= 0x40;
115
116	/* make sure thermometer is off */
117	regs[R_TM]   &= ~0x10;
118
119	/* frequency dependent parameters */
120
121	tda18271_calc_ir_measure(fe, &freq);
122
123	tda18271_calc_bp_filter(fe, &freq);
124
125	tda18271_calc_rf_band(fe, &freq);
126
127	tda18271_calc_gain_taper(fe, &freq);
128
129	/* --------------------------------------------------------------- */
130
131	/* dual tuner and agc1 extra configuration */
132
133	switch (priv->role) {
134	case TDA18271_MASTER:
135		regs[R_EB1]  |= 0x04; /* main vco */
136		break;
137	case TDA18271_SLAVE:
138		regs[R_EB1]  &= ~0x04; /* cal vco */
139		break;
140	}
141
142	/* agc1 always active */
143	regs[R_EB1]  &= ~0x02;
144
145	/* agc1 has priority on agc2 */
146	regs[R_EB1]  &= ~0x01;
147
148	ret = tda18271_write_regs(fe, R_EB1, 1);
149	if (tda_fail(ret))
150		goto fail;
151
152	/* --------------------------------------------------------------- */
153
154	N = map->if_freq * 1000 + freq;
155
156	switch (priv->role) {
157	case TDA18271_MASTER:
158		tda18271_calc_main_pll(fe, N);
159		tda18271_set_if_notch(fe);
160		tda18271_write_regs(fe, R_MPD, 4);
161		break;
162	case TDA18271_SLAVE:
163		tda18271_calc_cal_pll(fe, N);
164		tda18271_write_regs(fe, R_CPD, 4);
165
166		regs[R_MPD] = regs[R_CPD] & 0x7f;
167		tda18271_set_if_notch(fe);
168		tda18271_write_regs(fe, R_MPD, 1);
169		break;
170	}
171
172	ret = tda18271_write_regs(fe, R_TM, 7);
173	if (tda_fail(ret))
174		goto fail;
175
176	/* force charge pump source */
177	charge_pump_source(fe, 1);
178
179	msleep(1);
180
181	/* return pll to normal operation */
182	charge_pump_source(fe, 0);
183
184	msleep(20);
185
186	if (priv->id == TDA18271HDC2) {
187		/* set rfagc to normal speed mode */
188		if (map->fm_rfn)
189			regs[R_EP3] &= ~0x04;
190		else
191			regs[R_EP3] |= 0x04;
192		ret = tda18271_write_regs(fe, R_EP3, 1);
193	}
194fail:
195	return ret;
196}
197
198static int tda18271_read_thermometer(struct dvb_frontend *fe)
199{
200	struct tda18271_priv *priv = fe->tuner_priv;
201	unsigned char *regs = priv->tda18271_regs;
202	int tm;
203
204	/* switch thermometer on */
205	regs[R_TM]   |= 0x10;
206	tda18271_write_regs(fe, R_TM, 1);
207
208	/* read thermometer info */
209	tda18271_read_regs(fe);
210
211	if ((((regs[R_TM] & 0x0f) == 0x00) && ((regs[R_TM] & 0x20) == 0x20)) ||
212	    (((regs[R_TM] & 0x0f) == 0x08) && ((regs[R_TM] & 0x20) == 0x00))) {
213
214		if ((regs[R_TM] & 0x20) == 0x20)
215			regs[R_TM] &= ~0x20;
216		else
217			regs[R_TM] |= 0x20;
218
219		tda18271_write_regs(fe, R_TM, 1);
220
221		msleep(10); /* temperature sensing */
222
223		/* read thermometer info */
224		tda18271_read_regs(fe);
225	}
226
227	tm = tda18271_lookup_thermometer(fe);
228
229	/* switch thermometer off */
230	regs[R_TM]   &= ~0x10;
231	tda18271_write_regs(fe, R_TM, 1);
232
233	/* set CAL mode to normal */
234	regs[R_EP4]  &= ~0x03;
235	tda18271_write_regs(fe, R_EP4, 1);
236
237	return tm;
238}
239
240/* ------------------------------------------------------------------ */
241
242static int tda18271c2_rf_tracking_filters_correction(struct dvb_frontend *fe,
243						     u32 freq)
244{
245	struct tda18271_priv *priv = fe->tuner_priv;
246	struct tda18271_rf_tracking_filter_cal *map = priv->rf_cal_state;
247	unsigned char *regs = priv->tda18271_regs;
248	int i, ret;
249	u8 tm_current, dc_over_dt, rf_tab;
250	s32 rfcal_comp, approx;
251
252	/* power up */
253	ret = tda18271_set_standby_mode(fe, 0, 0, 0);
254	if (tda_fail(ret))
255		goto fail;
256
257	/* read die current temperature */
258	tm_current = tda18271_read_thermometer(fe);
259
260	/* frequency dependent parameters */
261
262	tda18271_calc_rf_cal(fe, &freq);
263	rf_tab = regs[R_EB14];
264
265	i = tda18271_lookup_rf_band(fe, &freq, NULL);
266	if (tda_fail(i))
267		return i;
268
269	if ((0 == map[i].rf3) || (freq / 1000 < map[i].rf2)) {
270		approx = map[i].rf_a1 * (s32)(freq / 1000 - map[i].rf1) +
271			map[i].rf_b1 + rf_tab;
272	} else {
273		approx = map[i].rf_a2 * (s32)(freq / 1000 - map[i].rf2) +
274			map[i].rf_b2 + rf_tab;
275	}
276
277	if (approx < 0)
278		approx = 0;
279	if (approx > 255)
280		approx = 255;
281
282	tda18271_lookup_map(fe, RF_CAL_DC_OVER_DT, &freq, &dc_over_dt);
283
284	/* calculate temperature compensation */
285	rfcal_comp = dc_over_dt * (s32)(tm_current - priv->tm_rfcal) / 1000;
286
287	regs[R_EB14] = (unsigned char)(approx + rfcal_comp);
288	ret = tda18271_write_regs(fe, R_EB14, 1);
289fail:
290	return ret;
291}
292
293static int tda18271_por(struct dvb_frontend *fe)
294{
295	struct tda18271_priv *priv = fe->tuner_priv;
296	unsigned char *regs = priv->tda18271_regs;
297	int ret;
298
299	/* power up detector 1 */
300	regs[R_EB12] &= ~0x20;
301	ret = tda18271_write_regs(fe, R_EB12, 1);
302	if (tda_fail(ret))
303		goto fail;
304
305	regs[R_EB18] &= ~0x80; /* turn agc1 loop on */
306	regs[R_EB18] &= ~0x03; /* set agc1_gain to  6 dB */
307	ret = tda18271_write_regs(fe, R_EB18, 1);
308	if (tda_fail(ret))
309		goto fail;
310
311	regs[R_EB21] |= 0x03; /* set agc2_gain to -6 dB */
312
313	/* POR mode */
314	ret = tda18271_set_standby_mode(fe, 1, 0, 0);
315	if (tda_fail(ret))
316		goto fail;
317
318	/* disable 1.5 MHz low pass filter */
319	regs[R_EB23] &= ~0x04; /* forcelp_fc2_en = 0 */
320	regs[R_EB23] &= ~0x02; /* XXX: lp_fc[2] = 0 */
321	ret = tda18271_write_regs(fe, R_EB21, 3);
322fail:
323	return ret;
324}
325
326static int tda18271_calibrate_rf(struct dvb_frontend *fe, u32 freq)
327{
328	struct tda18271_priv *priv = fe->tuner_priv;
329	unsigned char *regs = priv->tda18271_regs;
330	u32 N;
331
332	/* set CAL mode to normal */
333	regs[R_EP4]  &= ~0x03;
334	tda18271_write_regs(fe, R_EP4, 1);
335
336	/* switch off agc1 */
337	regs[R_EP3]  |= 0x40; /* sm_lt = 1 */
338
339	regs[R_EB18] |= 0x03; /* set agc1_gain to 15 dB */
340	tda18271_write_regs(fe, R_EB18, 1);
341
342	/* frequency dependent parameters */
343
344	tda18271_calc_bp_filter(fe, &freq);
345	tda18271_calc_gain_taper(fe, &freq);
346	tda18271_calc_rf_band(fe, &freq);
347	tda18271_calc_km(fe, &freq);
348
349	tda18271_write_regs(fe, R_EP1, 3);
350	tda18271_write_regs(fe, R_EB13, 1);
351
352	/* main pll charge pump source */
353	tda18271_charge_pump_source(fe, TDA18271_MAIN_PLL, 1);
354
355	/* cal pll charge pump source */
356	tda18271_charge_pump_source(fe, TDA18271_CAL_PLL, 1);
357
358	/* force dcdc converter to 0 V */
359	regs[R_EB14] = 0x00;
360	tda18271_write_regs(fe, R_EB14, 1);
361
362	/* disable plls lock */
363	regs[R_EB20] &= ~0x20;
364	tda18271_write_regs(fe, R_EB20, 1);
365
366	/* set CAL mode to RF tracking filter calibration */
367	regs[R_EP4]  |= 0x03;
368	tda18271_write_regs(fe, R_EP4, 2);
369
370	/* --------------------------------------------------------------- */
371
372	/* set the internal calibration signal */
373	N = freq;
374
375	tda18271_calc_cal_pll(fe, N);
376	tda18271_write_regs(fe, R_CPD, 4);
377
378	/* downconvert internal calibration */
379	N += 1000000;
380
381	tda18271_calc_main_pll(fe, N);
382	tda18271_write_regs(fe, R_MPD, 4);
383
384	msleep(5);
385
386	tda18271_write_regs(fe, R_EP2, 1);
387	tda18271_write_regs(fe, R_EP1, 1);
388	tda18271_write_regs(fe, R_EP2, 1);
389	tda18271_write_regs(fe, R_EP1, 1);
390
391	/* --------------------------------------------------------------- */
392
393	/* normal operation for the main pll */
394	tda18271_charge_pump_source(fe, TDA18271_MAIN_PLL, 0);
395
396	/* normal operation for the cal pll  */
397	tda18271_charge_pump_source(fe, TDA18271_CAL_PLL, 0);
398
399	msleep(10); /* plls locking */
400
401	/* launch the rf tracking filters calibration */
402	regs[R_EB20]  |= 0x20;
403	tda18271_write_regs(fe, R_EB20, 1);
404
405	msleep(60); /* calibration */
406
407	/* --------------------------------------------------------------- */
408
409	/* set CAL mode to normal */
410	regs[R_EP4]  &= ~0x03;
411
412	/* switch on agc1 */
413	regs[R_EP3]  &= ~0x40; /* sm_lt = 0 */
414
415	regs[R_EB18] &= ~0x03; /* set agc1_gain to  6 dB */
416	tda18271_write_regs(fe, R_EB18, 1);
417
418	tda18271_write_regs(fe, R_EP3, 2);
419
420	/* synchronization */
421	tda18271_write_regs(fe, R_EP1, 1);
422
423	/* get calibration result */
424	tda18271_read_extended(fe);
425
426	return regs[R_EB14];
427}
428
429static int tda18271_powerscan(struct dvb_frontend *fe,
430			      u32 *freq_in, u32 *freq_out)
431{
432	struct tda18271_priv *priv = fe->tuner_priv;
433	unsigned char *regs = priv->tda18271_regs;
434	int sgn, bcal, count, wait, ret;
435	u8 cid_target;
436	u16 count_limit;
437	u32 freq;
438
439	freq = *freq_in;
440
441	tda18271_calc_rf_band(fe, &freq);
442	tda18271_calc_rf_cal(fe, &freq);
443	tda18271_calc_gain_taper(fe, &freq);
444	tda18271_lookup_cid_target(fe, &freq, &cid_target, &count_limit);
445
446	tda18271_write_regs(fe, R_EP2, 1);
447	tda18271_write_regs(fe, R_EB14, 1);
448
449	/* downconvert frequency */
450	freq += 1000000;
451
452	tda18271_calc_main_pll(fe, freq);
453	tda18271_write_regs(fe, R_MPD, 4);
454
455	msleep(5); /* pll locking */
456
457	/* detection mode */
458	regs[R_EP4]  &= ~0x03;
459	regs[R_EP4]  |= 0x01;
460	tda18271_write_regs(fe, R_EP4, 1);
461
462	/* launch power detection measurement */
463	tda18271_write_regs(fe, R_EP2, 1);
464
465	/* read power detection info, stored in EB10 */
466	ret = tda18271_read_extended(fe);
467	if (tda_fail(ret))
468		return ret;
469
470	/* algorithm initialization */
471	sgn = 1;
472	*freq_out = *freq_in;
473	bcal = 0;
474	count = 0;
475	wait = false;
476
477	while ((regs[R_EB10] & 0x3f) < cid_target) {
478		/* downconvert updated freq to 1 MHz */
479		freq = *freq_in + (sgn * count) + 1000000;
480
481		tda18271_calc_main_pll(fe, freq);
482		tda18271_write_regs(fe, R_MPD, 4);
483
484		if (wait) {
485			msleep(5); /* pll locking */
486			wait = false;
487		} else
488			udelay(100); /* pll locking */
489
490		/* launch power detection measurement */
491		tda18271_write_regs(fe, R_EP2, 1);
492
493		/* read power detection info, stored in EB10 */
494		ret = tda18271_read_extended(fe);
495		if (tda_fail(ret))
496			return ret;
497
498		count += 200;
499
500		if (count <= count_limit)
501			continue;
502
503		if (sgn <= 0)
504			break;
505
506		sgn = -1 * sgn;
507		count = 200;
508		wait = true;
509	}
510
511	if ((regs[R_EB10] & 0x3f) >= cid_target) {
512		bcal = 1;
513		*freq_out = freq - 1000000;
514	} else
515		bcal = 0;
516
517	tda_cal("bcal = %d, freq_in = %d, freq_out = %d (freq = %d)\n",
518		bcal, *freq_in, *freq_out, freq);
519
520	return bcal;
521}
522
523static int tda18271_powerscan_init(struct dvb_frontend *fe)
524{
525	struct tda18271_priv *priv = fe->tuner_priv;
526	unsigned char *regs = priv->tda18271_regs;
527	int ret;
528
529	/* set standard to digital */
530	regs[R_EP3]  &= ~0x1f; /* clear std bits */
531	regs[R_EP3]  |= 0x12;
532
533	/* set cal mode to normal */
534	regs[R_EP4]  &= ~0x03;
535
536	/* update IF output level */
537	regs[R_EP4]  &= ~0x1c; /* clear if level bits */
538
539	ret = tda18271_write_regs(fe, R_EP3, 2);
540	if (tda_fail(ret))
541		goto fail;
542
543	regs[R_EB18] &= ~0x03; /* set agc1_gain to   6 dB */
544	ret = tda18271_write_regs(fe, R_EB18, 1);
545	if (tda_fail(ret))
546		goto fail;
547
548	regs[R_EB21] &= ~0x03; /* set agc2_gain to -15 dB */
549
550	/* 1.5 MHz low pass filter */
551	regs[R_EB23] |= 0x04; /* forcelp_fc2_en = 1 */
552	regs[R_EB23] |= 0x02; /* lp_fc[2] = 1 */
553
554	ret = tda18271_write_regs(fe, R_EB21, 3);
555fail:
556	return ret;
557}
558
559static int tda18271_rf_tracking_filters_init(struct dvb_frontend *fe, u32 freq)
560{
561	struct tda18271_priv *priv = fe->tuner_priv;
562	struct tda18271_rf_tracking_filter_cal *map = priv->rf_cal_state;
563	unsigned char *regs = priv->tda18271_regs;
564	int bcal, rf, i;
565	s32 divisor, dividend;
566#define RF1 0
567#define RF2 1
568#define RF3 2
569	u32 rf_default[3];
570	u32 rf_freq[3];
571	s32 prog_cal[3];
572	s32 prog_tab[3];
573
574	i = tda18271_lookup_rf_band(fe, &freq, NULL);
575
576	if (tda_fail(i))
577		return i;
578
579	rf_default[RF1] = 1000 * map[i].rf1_def;
580	rf_default[RF2] = 1000 * map[i].rf2_def;
581	rf_default[RF3] = 1000 * map[i].rf3_def;
582
583	for (rf = RF1; rf <= RF3; rf++) {
584		if (0 == rf_default[rf])
585			return 0;
586		tda_cal("freq = %d, rf = %d\n", freq, rf);
587
588		/* look for optimized calibration frequency */
589		bcal = tda18271_powerscan(fe, &rf_default[rf], &rf_freq[rf]);
590		if (tda_fail(bcal))
591			return bcal;
592
593		tda18271_calc_rf_cal(fe, &rf_freq[rf]);
594		prog_tab[rf] = (s32)regs[R_EB14];
595
596		if (1 == bcal)
597			prog_cal[rf] =
598				(s32)tda18271_calibrate_rf(fe, rf_freq[rf]);
599		else
600			prog_cal[rf] = prog_tab[rf];
601
602		switch (rf) {
603		case RF1:
604			map[i].rf_a1 = 0;
605			map[i].rf_b1 = (prog_cal[RF1] - prog_tab[RF1]);
606			map[i].rf1   = rf_freq[RF1] / 1000;
607			break;
608		case RF2:
609			dividend = (prog_cal[RF2] - prog_tab[RF2] -
610				    prog_cal[RF1] + prog_tab[RF1]);
611			divisor = (s32)(rf_freq[RF2] - rf_freq[RF1]) / 1000;
612			map[i].rf_a1 = (dividend / divisor);
613			map[i].rf2   = rf_freq[RF2] / 1000;
614			break;
615		case RF3:
616			dividend = (prog_cal[RF3] - prog_tab[RF3] -
617				    prog_cal[RF2] + prog_tab[RF2]);
618			divisor = (s32)(rf_freq[RF3] - rf_freq[RF2]) / 1000;
619			map[i].rf_a2 = (dividend / divisor);
620			map[i].rf_b2 = (prog_cal[RF2] - prog_tab[RF2]);
621			map[i].rf3   = rf_freq[RF3] / 1000;
622			break;
623		default:
624			BUG();
625		}
626	}
627
628	return 0;
629}
630
631static int tda18271_calc_rf_filter_curve(struct dvb_frontend *fe)
632{
633	struct tda18271_priv *priv = fe->tuner_priv;
634	unsigned int i;
635	int ret;
636
637	tda_info("performing RF tracking filter calibration\n");
638
639	/* wait for die temperature stabilization */
640	msleep(200);
641
642	ret = tda18271_powerscan_init(fe);
643	if (tda_fail(ret))
644		goto fail;
645
646	/* rf band calibration */
647	for (i = 0; priv->rf_cal_state[i].rfmax != 0; i++) {
648		ret =
649		tda18271_rf_tracking_filters_init(fe, 1000 *
650						  priv->rf_cal_state[i].rfmax);
651		if (tda_fail(ret))
652			goto fail;
653	}
654
655	priv->tm_rfcal = tda18271_read_thermometer(fe);
656fail:
657	return ret;
658}
659
660/* ------------------------------------------------------------------ */
661
662static int tda18271c2_rf_cal_init(struct dvb_frontend *fe)
663{
664	struct tda18271_priv *priv = fe->tuner_priv;
665	unsigned char *regs = priv->tda18271_regs;
666	int ret;
667
668	/* test RF_CAL_OK to see if we need init */
669	if ((regs[R_EP1] & 0x10) == 0)
670		priv->cal_initialized = false;
671
672	if (priv->cal_initialized)
673		return 0;
674
675	ret = tda18271_calc_rf_filter_curve(fe);
676	if (tda_fail(ret))
677		goto fail;
678
679	ret = tda18271_por(fe);
680	if (tda_fail(ret))
681		goto fail;
682
683	tda_info("RF tracking filter calibration complete\n");
684
685	priv->cal_initialized = true;
686	goto end;
687fail:
688	tda_info("RF tracking filter calibration failed!\n");
689end:
690	return ret;
691}
692
693static int tda18271c1_rf_tracking_filter_calibration(struct dvb_frontend *fe,
694						     u32 freq, u32 bw)
695{
696	struct tda18271_priv *priv = fe->tuner_priv;
697	unsigned char *regs = priv->tda18271_regs;
698	int ret;
699	u32 N = 0;
700
701	/* calculate bp filter */
702	tda18271_calc_bp_filter(fe, &freq);
703	tda18271_write_regs(fe, R_EP1, 1);
704
705	regs[R_EB4]  &= 0x07;
706	regs[R_EB4]  |= 0x60;
707	tda18271_write_regs(fe, R_EB4, 1);
708
709	regs[R_EB7]   = 0x60;
710	tda18271_write_regs(fe, R_EB7, 1);
711
712	regs[R_EB14]  = 0x00;
713	tda18271_write_regs(fe, R_EB14, 1);
714
715	regs[R_EB20]  = 0xcc;
716	tda18271_write_regs(fe, R_EB20, 1);
717
718	/* set cal mode to RF tracking filter calibration */
719	regs[R_EP4]  |= 0x03;
720
721	/* calculate cal pll */
722
723	switch (priv->mode) {
724	case TDA18271_ANALOG:
725		N = freq - 1250000;
726		break;
727	case TDA18271_DIGITAL:
728		N = freq + bw / 2;
729		break;
730	}
731
732	tda18271_calc_cal_pll(fe, N);
733
734	/* calculate main pll */
735
736	switch (priv->mode) {
737	case TDA18271_ANALOG:
738		N = freq - 250000;
739		break;
740	case TDA18271_DIGITAL:
741		N = freq + bw / 2 + 1000000;
742		break;
743	}
744
745	tda18271_calc_main_pll(fe, N);
746
747	ret = tda18271_write_regs(fe, R_EP3, 11);
748	if (tda_fail(ret))
749		return ret;
750
751	msleep(5); /* RF tracking filter calibration initialization */
752
753	/* search for K,M,CO for RF calibration */
754	tda18271_calc_km(fe, &freq);
755	tda18271_write_regs(fe, R_EB13, 1);
756
757	/* search for rf band */
758	tda18271_calc_rf_band(fe, &freq);
759
760	/* search for gain taper */
761	tda18271_calc_gain_taper(fe, &freq);
762
763	tda18271_write_regs(fe, R_EP2, 1);
764	tda18271_write_regs(fe, R_EP1, 1);
765	tda18271_write_regs(fe, R_EP2, 1);
766	tda18271_write_regs(fe, R_EP1, 1);
767
768	regs[R_EB4]  &= 0x07;
769	regs[R_EB4]  |= 0x40;
770	tda18271_write_regs(fe, R_EB4, 1);
771
772	regs[R_EB7]   = 0x40;
773	tda18271_write_regs(fe, R_EB7, 1);
774	msleep(10); /* pll locking */
775
776	regs[R_EB20]  = 0xec;
777	tda18271_write_regs(fe, R_EB20, 1);
778	msleep(60); /* RF tracking filter calibration completion */
779
780	regs[R_EP4]  &= ~0x03; /* set cal mode to normal */
781	tda18271_write_regs(fe, R_EP4, 1);
782
783	tda18271_write_regs(fe, R_EP1, 1);
784
785	/* RF tracking filter correction for VHF_Low band */
786	if (0 == tda18271_calc_rf_cal(fe, &freq))
787		tda18271_write_regs(fe, R_EB14, 1);
788
789	return 0;
790}
791
792/* ------------------------------------------------------------------ */
793
794static int tda18271_ir_cal_init(struct dvb_frontend *fe)
795{
796	struct tda18271_priv *priv = fe->tuner_priv;
797	unsigned char *regs = priv->tda18271_regs;
798	int ret;
799
800	ret = tda18271_read_regs(fe);
801	if (tda_fail(ret))
802		goto fail;
803
804	/* test IR_CAL_OK to see if we need init */
805	if ((regs[R_EP1] & 0x08) == 0)
806		ret = tda18271_init_regs(fe);
807fail:
808	return ret;
809}
810
811static int tda18271_init(struct dvb_frontend *fe)
812{
813	struct tda18271_priv *priv = fe->tuner_priv;
814	int ret;
815
816	mutex_lock(&priv->lock);
817
818	/* full power up */
819	ret = tda18271_set_standby_mode(fe, 0, 0, 0);
820	if (tda_fail(ret))
821		goto fail;
822
823	/* initialization */
824	ret = tda18271_ir_cal_init(fe);
825	if (tda_fail(ret))
826		goto fail;
827
828	if (priv->id == TDA18271HDC2)
829		tda18271c2_rf_cal_init(fe);
830fail:
831	mutex_unlock(&priv->lock);
832
833	return ret;
834}
835
836static int tda18271_sleep(struct dvb_frontend *fe)
837{
838	struct tda18271_priv *priv = fe->tuner_priv;
839	int ret;
840
841	mutex_lock(&priv->lock);
842
843	/* enter standby mode, with required output features enabled */
844	ret = tda18271_toggle_output(fe, 1);
845
846	mutex_unlock(&priv->lock);
847
848	return ret;
849}
850
851/* ------------------------------------------------------------------ */
852
853static int tda18271_agc(struct dvb_frontend *fe)
854{
855	struct tda18271_priv *priv = fe->tuner_priv;
856	int ret = 0;
857
858	switch (priv->config) {
859	case TDA8290_LNA_OFF:
860		/* no external agc configuration required */
861		if (tda18271_debug & DBG_ADV)
862			tda_dbg("no agc configuration provided\n");
863		break;
864	case TDA8290_LNA_ON_BRIDGE:
865		/* switch with GPIO of saa713x */
866		tda_dbg("invoking callback\n");
867		if (fe->callback)
868			ret = fe->callback(priv->i2c_props.adap->algo_data,
869					   DVB_FRONTEND_COMPONENT_TUNER,
870					   TDA18271_CALLBACK_CMD_AGC_ENABLE,
871					   priv->mode);
872		break;
873	case TDA8290_LNA_GP0_HIGH_ON:
874	case TDA8290_LNA_GP0_HIGH_OFF:
875	default:
876		/* n/a - currently not supported */
877		tda_err("unsupported configuration: %d\n", priv->config);
878		ret = -EINVAL;
879		break;
880	}
881	return ret;
882}
883
884static int tda18271_tune(struct dvb_frontend *fe,
885			 struct tda18271_std_map_item *map, u32 freq, u32 bw)
886{
887	struct tda18271_priv *priv = fe->tuner_priv;
888	int ret;
889
890	tda_dbg("freq = %d, ifc = %d, bw = %d, agc_mode = %d, std = %d\n",
891		freq, map->if_freq, bw, map->agc_mode, map->std);
892
893	ret = tda18271_agc(fe);
894	if (tda_fail(ret))
895		tda_warn("failed to configure agc\n");
896
897	ret = tda18271_init(fe);
898	if (tda_fail(ret))
899		goto fail;
900
901	mutex_lock(&priv->lock);
902
903	switch (priv->id) {
904	case TDA18271HDC1:
905		tda18271c1_rf_tracking_filter_calibration(fe, freq, bw);
906		break;
907	case TDA18271HDC2:
908		tda18271c2_rf_tracking_filters_correction(fe, freq);
909		break;
910	}
911	ret = tda18271_channel_configuration(fe, map, freq, bw);
912
913	mutex_unlock(&priv->lock);
914fail:
915	return ret;
916}
917
918/* ------------------------------------------------------------------ */
919
920static int tda18271_set_params(struct dvb_frontend *fe)
921{
922	struct dtv_frontend_properties *c = &fe->dtv_property_cache;
923	u32 delsys = c->delivery_system;
924	u32 bw = c->bandwidth_hz;
925	u32 freq = c->frequency;
926	struct tda18271_priv *priv = fe->tuner_priv;
927	struct tda18271_std_map *std_map = &priv->std;
928	struct tda18271_std_map_item *map;
929	int ret;
930
931	priv->mode = TDA18271_DIGITAL;
932
933	switch (delsys) {
934	case SYS_ATSC:
935		map = &std_map->atsc_6;
936		bw = 6000000;
937		break;
938	case SYS_ISDBT:
939	case SYS_DVBT:
940	case SYS_DVBT2:
941		if (bw <= 6000000) {
942			map = &std_map->dvbt_6;
943		} else if (bw <= 7000000) {
944			map = &std_map->dvbt_7;
945		} else {
946			map = &std_map->dvbt_8;
947		}
948		break;
949	case SYS_DVBC_ANNEX_B:
950		bw = 6000000;
951		fallthrough;
952	case SYS_DVBC_ANNEX_A:
953	case SYS_DVBC_ANNEX_C:
954		if (bw <= 6000000) {
955			map = &std_map->qam_6;
956		} else if (bw <= 7000000) {
957			map = &std_map->qam_7;
958		} else {
959			map = &std_map->qam_8;
960		}
961		break;
962	default:
963		tda_warn("modulation type not supported!\n");
964		return -EINVAL;
965	}
966
967	/* When tuning digital, the analog demod must be tri-stated */
968	if (fe->ops.analog_ops.standby)
969		fe->ops.analog_ops.standby(fe);
970
971	ret = tda18271_tune(fe, map, freq, bw);
972
973	if (tda_fail(ret))
974		goto fail;
975
976	priv->if_freq   = map->if_freq;
977	priv->frequency = freq;
978	priv->bandwidth = bw;
979fail:
980	return ret;
981}
982
983static int tda18271_set_analog_params(struct dvb_frontend *fe,
984				      struct analog_parameters *params)
985{
986	struct tda18271_priv *priv = fe->tuner_priv;
987	struct tda18271_std_map *std_map = &priv->std;
988	struct tda18271_std_map_item *map;
989	char *mode;
990	int ret;
991	u32 freq = params->frequency * 125 *
992		((params->mode == V4L2_TUNER_RADIO) ? 1 : 1000) / 2;
993
994	priv->mode = TDA18271_ANALOG;
995
996	if (params->mode == V4L2_TUNER_RADIO) {
997		map = &std_map->fm_radio;
998		mode = "fm";
999	} else if (params->std & V4L2_STD_MN) {
1000		map = &std_map->atv_mn;
1001		mode = "MN";
1002	} else if (params->std & V4L2_STD_B) {
1003		map = &std_map->atv_b;
1004		mode = "B";
1005	} else if (params->std & V4L2_STD_GH) {
1006		map = &std_map->atv_gh;
1007		mode = "GH";
1008	} else if (params->std & V4L2_STD_PAL_I) {
1009		map = &std_map->atv_i;
1010		mode = "I";
1011	} else if (params->std & V4L2_STD_DK) {
1012		map = &std_map->atv_dk;
1013		mode = "DK";
1014	} else if (params->std & V4L2_STD_SECAM_L) {
1015		map = &std_map->atv_l;
1016		mode = "L";
1017	} else if (params->std & V4L2_STD_SECAM_LC) {
1018		map = &std_map->atv_lc;
1019		mode = "L'";
1020	} else {
1021		map = &std_map->atv_i;
1022		mode = "xx";
1023	}
1024
1025	tda_dbg("setting tda18271 to system %s\n", mode);
1026
1027	ret = tda18271_tune(fe, map, freq, 0);
1028
1029	if (tda_fail(ret))
1030		goto fail;
1031
1032	priv->if_freq   = map->if_freq;
1033	priv->frequency = freq;
1034	priv->bandwidth = 0;
1035fail:
1036	return ret;
1037}
1038
1039static void tda18271_release(struct dvb_frontend *fe)
1040{
1041	struct tda18271_priv *priv = fe->tuner_priv;
1042
1043	mutex_lock(&tda18271_list_mutex);
1044
1045	if (priv)
1046		hybrid_tuner_release_state(priv);
1047
1048	mutex_unlock(&tda18271_list_mutex);
1049
1050	fe->tuner_priv = NULL;
1051}
1052
1053static int tda18271_get_frequency(struct dvb_frontend *fe, u32 *frequency)
1054{
1055	struct tda18271_priv *priv = fe->tuner_priv;
1056	*frequency = priv->frequency;
1057	return 0;
1058}
1059
1060static int tda18271_get_bandwidth(struct dvb_frontend *fe, u32 *bandwidth)
1061{
1062	struct tda18271_priv *priv = fe->tuner_priv;
1063	*bandwidth = priv->bandwidth;
1064	return 0;
1065}
1066
1067static int tda18271_get_if_frequency(struct dvb_frontend *fe, u32 *frequency)
1068{
1069	struct tda18271_priv *priv = fe->tuner_priv;
1070	*frequency = (u32)priv->if_freq * 1000;
1071	return 0;
1072}
1073
1074/* ------------------------------------------------------------------ */
1075
1076#define tda18271_update_std(std_cfg, name) do {				\
1077	if (map->std_cfg.if_freq +					\
1078		map->std_cfg.agc_mode + map->std_cfg.std +		\
1079		map->std_cfg.if_lvl + map->std_cfg.rfagc_top > 0) {	\
1080		tda_dbg("Using custom std config for %s\n", name);	\
1081		memcpy(&std->std_cfg, &map->std_cfg,			\
1082			sizeof(struct tda18271_std_map_item));		\
1083	} } while (0)
1084
1085#define tda18271_dump_std_item(std_cfg, name) do {			\
1086	tda_dbg("(%s) if_freq = %d, agc_mode = %d, std = %d, "		\
1087		"if_lvl = %d, rfagc_top = 0x%02x\n",			\
1088		name, std->std_cfg.if_freq,				\
1089		std->std_cfg.agc_mode, std->std_cfg.std,		\
1090		std->std_cfg.if_lvl, std->std_cfg.rfagc_top);		\
1091	} while (0)
1092
1093static int tda18271_dump_std_map(struct dvb_frontend *fe)
1094{
1095	struct tda18271_priv *priv = fe->tuner_priv;
1096	struct tda18271_std_map *std = &priv->std;
1097
1098	tda_dbg("========== STANDARD MAP SETTINGS ==========\n");
1099	tda18271_dump_std_item(fm_radio, "  fm  ");
1100	tda18271_dump_std_item(atv_b,  "atv b ");
1101	tda18271_dump_std_item(atv_dk, "atv dk");
1102	tda18271_dump_std_item(atv_gh, "atv gh");
1103	tda18271_dump_std_item(atv_i,  "atv i ");
1104	tda18271_dump_std_item(atv_l,  "atv l ");
1105	tda18271_dump_std_item(atv_lc, "atv l'");
1106	tda18271_dump_std_item(atv_mn, "atv mn");
1107	tda18271_dump_std_item(atsc_6, "atsc 6");
1108	tda18271_dump_std_item(dvbt_6, "dvbt 6");
1109	tda18271_dump_std_item(dvbt_7, "dvbt 7");
1110	tda18271_dump_std_item(dvbt_8, "dvbt 8");
1111	tda18271_dump_std_item(qam_6,  "qam 6 ");
1112	tda18271_dump_std_item(qam_7,  "qam 7 ");
1113	tda18271_dump_std_item(qam_8,  "qam 8 ");
1114
1115	return 0;
1116}
1117
1118static int tda18271_update_std_map(struct dvb_frontend *fe,
1119				   struct tda18271_std_map *map)
1120{
1121	struct tda18271_priv *priv = fe->tuner_priv;
1122	struct tda18271_std_map *std = &priv->std;
1123
1124	if (!map)
1125		return -EINVAL;
1126
1127	tda18271_update_std(fm_radio, "fm");
1128	tda18271_update_std(atv_b,  "atv b");
1129	tda18271_update_std(atv_dk, "atv dk");
1130	tda18271_update_std(atv_gh, "atv gh");
1131	tda18271_update_std(atv_i,  "atv i");
1132	tda18271_update_std(atv_l,  "atv l");
1133	tda18271_update_std(atv_lc, "atv l'");
1134	tda18271_update_std(atv_mn, "atv mn");
1135	tda18271_update_std(atsc_6, "atsc 6");
1136	tda18271_update_std(dvbt_6, "dvbt 6");
1137	tda18271_update_std(dvbt_7, "dvbt 7");
1138	tda18271_update_std(dvbt_8, "dvbt 8");
1139	tda18271_update_std(qam_6,  "qam 6");
1140	tda18271_update_std(qam_7,  "qam 7");
1141	tda18271_update_std(qam_8,  "qam 8");
1142
1143	return 0;
1144}
1145
1146static int tda18271_get_id(struct dvb_frontend *fe)
1147{
1148	struct tda18271_priv *priv = fe->tuner_priv;
1149	unsigned char *regs = priv->tda18271_regs;
1150	char *name;
1151	int ret;
1152
1153	mutex_lock(&priv->lock);
1154	ret = tda18271_read_regs(fe);
1155	mutex_unlock(&priv->lock);
1156
1157	if (ret) {
1158		tda_info("Error reading device ID @ %d-%04x, bailing out.\n",
1159			 i2c_adapter_id(priv->i2c_props.adap),
1160			 priv->i2c_props.addr);
1161		return -EIO;
1162	}
1163
1164	switch (regs[R_ID] & 0x7f) {
1165	case 3:
1166		name = "TDA18271HD/C1";
1167		priv->id = TDA18271HDC1;
1168		break;
1169	case 4:
1170		name = "TDA18271HD/C2";
1171		priv->id = TDA18271HDC2;
1172		break;
1173	default:
1174		tda_info("Unknown device (%i) detected @ %d-%04x, device not supported.\n",
1175			 regs[R_ID], i2c_adapter_id(priv->i2c_props.adap),
1176			 priv->i2c_props.addr);
1177		return -EINVAL;
1178	}
1179
1180	tda_info("%s detected @ %d-%04x\n", name,
1181		 i2c_adapter_id(priv->i2c_props.adap), priv->i2c_props.addr);
1182
1183	return 0;
1184}
1185
1186static int tda18271_setup_configuration(struct dvb_frontend *fe,
1187					struct tda18271_config *cfg)
1188{
1189	struct tda18271_priv *priv = fe->tuner_priv;
1190
1191	priv->gate = (cfg) ? cfg->gate : TDA18271_GATE_AUTO;
1192	priv->role = (cfg) ? cfg->role : TDA18271_MASTER;
1193	priv->config = (cfg) ? cfg->config : 0;
1194	priv->small_i2c = (cfg) ?
1195		cfg->small_i2c : TDA18271_39_BYTE_CHUNK_INIT;
1196	priv->output_opt = (cfg) ?
1197		cfg->output_opt : TDA18271_OUTPUT_LT_XT_ON;
1198
1199	return 0;
1200}
1201
1202static inline int tda18271_need_cal_on_startup(struct tda18271_config *cfg)
1203{
1204	/* tda18271_cal_on_startup == -1 when cal module option is unset */
1205	return ((tda18271_cal_on_startup == -1) ?
1206		/* honor configuration setting */
1207		((cfg) && (cfg->rf_cal_on_startup)) :
1208		/* module option overrides configuration setting */
1209		(tda18271_cal_on_startup)) ? 1 : 0;
1210}
1211
1212static int tda18271_set_config(struct dvb_frontend *fe, void *priv_cfg)
1213{
1214	struct tda18271_config *cfg = (struct tda18271_config *) priv_cfg;
1215
1216	tda18271_setup_configuration(fe, cfg);
1217
1218	if (tda18271_need_cal_on_startup(cfg))
1219		tda18271_init(fe);
1220
1221	/* override default std map with values in config struct */
1222	if ((cfg) && (cfg->std_map))
1223		tda18271_update_std_map(fe, cfg->std_map);
1224
1225	return 0;
1226}
1227
1228static const struct dvb_tuner_ops tda18271_tuner_ops = {
1229	.info = {
1230		.name = "NXP TDA18271HD",
1231		.frequency_min_hz  =  45 * MHz,
1232		.frequency_max_hz  = 864 * MHz,
1233		.frequency_step_hz = 62500
1234	},
1235	.init              = tda18271_init,
1236	.sleep             = tda18271_sleep,
1237	.set_params        = tda18271_set_params,
1238	.set_analog_params = tda18271_set_analog_params,
1239	.release           = tda18271_release,
1240	.set_config        = tda18271_set_config,
1241	.get_frequency     = tda18271_get_frequency,
1242	.get_bandwidth     = tda18271_get_bandwidth,
1243	.get_if_frequency  = tda18271_get_if_frequency,
1244};
1245
1246struct dvb_frontend *tda18271_attach(struct dvb_frontend *fe, u8 addr,
1247				     struct i2c_adapter *i2c,
1248				     struct tda18271_config *cfg)
1249{
1250	struct tda18271_priv *priv = NULL;
1251	int instance, ret;
1252
1253	mutex_lock(&tda18271_list_mutex);
1254
1255	instance = hybrid_tuner_request_state(struct tda18271_priv, priv,
1256					      hybrid_tuner_instance_list,
1257					      i2c, addr, "tda18271");
1258	switch (instance) {
1259	case 0:
1260		goto fail;
1261	case 1:
1262		/* new tuner instance */
1263		fe->tuner_priv = priv;
1264
1265		tda18271_setup_configuration(fe, cfg);
1266
1267		priv->cal_initialized = false;
1268		mutex_init(&priv->lock);
1269
1270		ret = tda18271_get_id(fe);
1271		if (tda_fail(ret))
1272			goto fail;
1273
1274		ret = tda18271_assign_map_layout(fe);
1275		if (tda_fail(ret))
1276			goto fail;
1277
1278		/* if delay_cal is set, delay IR & RF calibration until init()
1279		 * module option 'cal' overrides this delay */
1280		if ((cfg->delay_cal) && (!tda18271_need_cal_on_startup(cfg)))
1281			break;
1282
1283		mutex_lock(&priv->lock);
1284		tda18271_init_regs(fe);
1285
1286		if ((tda18271_need_cal_on_startup(cfg)) &&
1287		    (priv->id == TDA18271HDC2))
1288			tda18271c2_rf_cal_init(fe);
1289
1290		/* enter standby mode, with required output features enabled */
1291		ret = tda18271_toggle_output(fe, 1);
1292		tda_fail(ret);
1293
1294		mutex_unlock(&priv->lock);
1295		break;
1296	default:
1297		/* existing tuner instance */
1298		fe->tuner_priv = priv;
1299
1300		/* allow dvb driver to override configuration settings */
1301		if (cfg) {
1302			if (cfg->gate != TDA18271_GATE_ANALOG)
1303				priv->gate = cfg->gate;
1304			if (cfg->role)
1305				priv->role = cfg->role;
1306			if (cfg->config)
1307				priv->config = cfg->config;
1308			if (cfg->small_i2c)
1309				priv->small_i2c = cfg->small_i2c;
1310			if (cfg->output_opt)
1311				priv->output_opt = cfg->output_opt;
1312			if (cfg->std_map)
1313				tda18271_update_std_map(fe, cfg->std_map);
1314		}
1315		if (tda18271_need_cal_on_startup(cfg))
1316			tda18271_init(fe);
1317		break;
1318	}
1319
1320	/* override default std map with values in config struct */
1321	if ((cfg) && (cfg->std_map))
1322		tda18271_update_std_map(fe, cfg->std_map);
1323
1324	mutex_unlock(&tda18271_list_mutex);
1325
1326	memcpy(&fe->ops.tuner_ops, &tda18271_tuner_ops,
1327	       sizeof(struct dvb_tuner_ops));
1328
1329	if (tda18271_debug & (DBG_MAP | DBG_ADV))
1330		tda18271_dump_std_map(fe);
1331
1332	return fe;
1333fail:
1334	mutex_unlock(&tda18271_list_mutex);
1335
1336	tda18271_release(fe);
1337	return NULL;
1338}
1339EXPORT_SYMBOL_GPL(tda18271_attach);
1340MODULE_DESCRIPTION("NXP TDA18271HD analog / digital tuner driver");
1341MODULE_AUTHOR("Michael Krufky <mkrufky@linuxtv.org>");
1342MODULE_LICENSE("GPL");
1343MODULE_VERSION("0.4");
1344