Linux 4.16.11
[linux/fpc-iii.git] / drivers / media / dvb-frontends / zl10353.c
blobc9901f45deb70c5fbb9fed10b12c52c7535a49ef
1 /*
2 * Driver for Zarlink DVB-T ZL10353 demodulator
4 * Copyright (C) 2006, 2007 Christopher Pascoe <c.pascoe@itee.uq.edu.au>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/delay.h>
22 #include <linux/string.h>
23 #include <linux/slab.h>
24 #include <asm/div64.h>
26 #include <media/dvb_frontend.h>
27 #include "zl10353_priv.h"
28 #include "zl10353.h"
30 struct zl10353_state {
31 struct i2c_adapter *i2c;
32 struct dvb_frontend frontend;
34 struct zl10353_config config;
36 u32 bandwidth;
37 u32 ucblocks;
38 u32 frequency;
41 static int debug;
42 #define dprintk(args...) \
43 do { \
44 if (debug) printk(KERN_DEBUG "zl10353: " args); \
45 } while (0)
47 static int debug_regs;
49 static int zl10353_single_write(struct dvb_frontend *fe, u8 reg, u8 val)
51 struct zl10353_state *state = fe->demodulator_priv;
52 u8 buf[2] = { reg, val };
53 struct i2c_msg msg = { .addr = state->config.demod_address, .flags = 0,
54 .buf = buf, .len = 2 };
55 int err = i2c_transfer(state->i2c, &msg, 1);
56 if (err != 1) {
57 printk("zl10353: write to reg %x failed (err = %d)!\n", reg, err);
58 return err;
60 return 0;
63 static int zl10353_write(struct dvb_frontend *fe, const u8 ibuf[], int ilen)
65 int err, i;
66 for (i = 0; i < ilen - 1; i++)
67 if ((err = zl10353_single_write(fe, ibuf[0] + i, ibuf[i + 1])))
68 return err;
70 return 0;
73 static int zl10353_read_register(struct zl10353_state *state, u8 reg)
75 int ret;
76 u8 b0[1] = { reg };
77 u8 b1[1] = { 0 };
78 struct i2c_msg msg[2] = { { .addr = state->config.demod_address,
79 .flags = 0,
80 .buf = b0, .len = 1 },
81 { .addr = state->config.demod_address,
82 .flags = I2C_M_RD,
83 .buf = b1, .len = 1 } };
85 ret = i2c_transfer(state->i2c, msg, 2);
87 if (ret != 2) {
88 printk("%s: readreg error (reg=%d, ret==%i)\n",
89 __func__, reg, ret);
90 return ret;
93 return b1[0];
96 static void zl10353_dump_regs(struct dvb_frontend *fe)
98 struct zl10353_state *state = fe->demodulator_priv;
99 int ret;
100 u8 reg;
102 /* Dump all registers. */
103 for (reg = 0; ; reg++) {
104 if (reg % 16 == 0) {
105 if (reg)
106 printk(KERN_CONT "\n");
107 printk(KERN_DEBUG "%02x:", reg);
109 ret = zl10353_read_register(state, reg);
110 if (ret >= 0)
111 printk(KERN_CONT " %02x", (u8)ret);
112 else
113 printk(KERN_CONT " --");
114 if (reg == 0xff)
115 break;
117 printk(KERN_CONT "\n");
120 static void zl10353_calc_nominal_rate(struct dvb_frontend *fe,
121 u32 bandwidth,
122 u16 *nominal_rate)
124 struct zl10353_state *state = fe->demodulator_priv;
125 u32 adc_clock = 450560; /* 45.056 MHz */
126 u64 value;
127 u8 bw = bandwidth / 1000000;
129 if (state->config.adc_clock)
130 adc_clock = state->config.adc_clock;
132 value = (u64)10 * (1 << 23) / 7 * 125;
133 value = (bw * value) + adc_clock / 2;
134 *nominal_rate = div_u64(value, adc_clock);
136 dprintk("%s: bw %d, adc_clock %d => 0x%x\n",
137 __func__, bw, adc_clock, *nominal_rate);
140 static void zl10353_calc_input_freq(struct dvb_frontend *fe,
141 u16 *input_freq)
143 struct zl10353_state *state = fe->demodulator_priv;
144 u32 adc_clock = 450560; /* 45.056 MHz */
145 int if2 = 361667; /* 36.1667 MHz */
146 int ife;
147 u64 value;
149 if (state->config.adc_clock)
150 adc_clock = state->config.adc_clock;
151 if (state->config.if2)
152 if2 = state->config.if2;
154 if (adc_clock >= if2 * 2)
155 ife = if2;
156 else {
157 ife = adc_clock - (if2 % adc_clock);
158 if (ife > adc_clock / 2)
159 ife = adc_clock - ife;
161 value = div_u64((u64)65536 * ife + adc_clock / 2, adc_clock);
162 *input_freq = -value;
164 dprintk("%s: if2 %d, ife %d, adc_clock %d => %d / 0x%x\n",
165 __func__, if2, ife, adc_clock, -(int)value, *input_freq);
168 static int zl10353_sleep(struct dvb_frontend *fe)
170 static u8 zl10353_softdown[] = { 0x50, 0x0C, 0x44 };
172 zl10353_write(fe, zl10353_softdown, sizeof(zl10353_softdown));
173 return 0;
176 static int zl10353_set_parameters(struct dvb_frontend *fe)
178 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
179 struct zl10353_state *state = fe->demodulator_priv;
180 u16 nominal_rate, input_freq;
181 u8 pllbuf[6] = { 0x67 }, acq_ctl = 0;
182 u16 tps = 0;
184 state->frequency = c->frequency;
186 zl10353_single_write(fe, RESET, 0x80);
187 udelay(200);
188 zl10353_single_write(fe, 0xEA, 0x01);
189 udelay(200);
190 zl10353_single_write(fe, 0xEA, 0x00);
192 zl10353_single_write(fe, AGC_TARGET, 0x28);
194 if (c->transmission_mode != TRANSMISSION_MODE_AUTO)
195 acq_ctl |= (1 << 0);
196 if (c->guard_interval != GUARD_INTERVAL_AUTO)
197 acq_ctl |= (1 << 1);
198 zl10353_single_write(fe, ACQ_CTL, acq_ctl);
200 switch (c->bandwidth_hz) {
201 case 6000000:
202 /* These are extrapolated from the 7 and 8MHz values */
203 zl10353_single_write(fe, MCLK_RATIO, 0x97);
204 zl10353_single_write(fe, 0x64, 0x34);
205 zl10353_single_write(fe, 0xcc, 0xdd);
206 break;
207 case 7000000:
208 zl10353_single_write(fe, MCLK_RATIO, 0x86);
209 zl10353_single_write(fe, 0x64, 0x35);
210 zl10353_single_write(fe, 0xcc, 0x73);
211 break;
212 default:
213 c->bandwidth_hz = 8000000;
214 /* fall through */
215 case 8000000:
216 zl10353_single_write(fe, MCLK_RATIO, 0x75);
217 zl10353_single_write(fe, 0x64, 0x36);
218 zl10353_single_write(fe, 0xcc, 0x73);
221 zl10353_calc_nominal_rate(fe, c->bandwidth_hz, &nominal_rate);
222 zl10353_single_write(fe, TRL_NOMINAL_RATE_1, msb(nominal_rate));
223 zl10353_single_write(fe, TRL_NOMINAL_RATE_0, lsb(nominal_rate));
224 state->bandwidth = c->bandwidth_hz;
226 zl10353_calc_input_freq(fe, &input_freq);
227 zl10353_single_write(fe, INPUT_FREQ_1, msb(input_freq));
228 zl10353_single_write(fe, INPUT_FREQ_0, lsb(input_freq));
230 /* Hint at TPS settings */
231 switch (c->code_rate_HP) {
232 case FEC_2_3:
233 tps |= (1 << 7);
234 break;
235 case FEC_3_4:
236 tps |= (2 << 7);
237 break;
238 case FEC_5_6:
239 tps |= (3 << 7);
240 break;
241 case FEC_7_8:
242 tps |= (4 << 7);
243 break;
244 case FEC_1_2:
245 case FEC_AUTO:
246 break;
247 default:
248 return -EINVAL;
251 switch (c->code_rate_LP) {
252 case FEC_2_3:
253 tps |= (1 << 4);
254 break;
255 case FEC_3_4:
256 tps |= (2 << 4);
257 break;
258 case FEC_5_6:
259 tps |= (3 << 4);
260 break;
261 case FEC_7_8:
262 tps |= (4 << 4);
263 break;
264 case FEC_1_2:
265 case FEC_AUTO:
266 break;
267 case FEC_NONE:
268 if (c->hierarchy == HIERARCHY_AUTO ||
269 c->hierarchy == HIERARCHY_NONE)
270 break;
271 /* fall through */
272 default:
273 return -EINVAL;
276 switch (c->modulation) {
277 case QPSK:
278 break;
279 case QAM_AUTO:
280 case QAM_16:
281 tps |= (1 << 13);
282 break;
283 case QAM_64:
284 tps |= (2 << 13);
285 break;
286 default:
287 return -EINVAL;
290 switch (c->transmission_mode) {
291 case TRANSMISSION_MODE_2K:
292 case TRANSMISSION_MODE_AUTO:
293 break;
294 case TRANSMISSION_MODE_8K:
295 tps |= (1 << 0);
296 break;
297 default:
298 return -EINVAL;
301 switch (c->guard_interval) {
302 case GUARD_INTERVAL_1_32:
303 case GUARD_INTERVAL_AUTO:
304 break;
305 case GUARD_INTERVAL_1_16:
306 tps |= (1 << 2);
307 break;
308 case GUARD_INTERVAL_1_8:
309 tps |= (2 << 2);
310 break;
311 case GUARD_INTERVAL_1_4:
312 tps |= (3 << 2);
313 break;
314 default:
315 return -EINVAL;
318 switch (c->hierarchy) {
319 case HIERARCHY_AUTO:
320 case HIERARCHY_NONE:
321 break;
322 case HIERARCHY_1:
323 tps |= (1 << 10);
324 break;
325 case HIERARCHY_2:
326 tps |= (2 << 10);
327 break;
328 case HIERARCHY_4:
329 tps |= (3 << 10);
330 break;
331 default:
332 return -EINVAL;
335 zl10353_single_write(fe, TPS_GIVEN_1, msb(tps));
336 zl10353_single_write(fe, TPS_GIVEN_0, lsb(tps));
338 if (fe->ops.i2c_gate_ctrl)
339 fe->ops.i2c_gate_ctrl(fe, 0);
342 * If there is no tuner attached to the secondary I2C bus, we call
343 * set_params to program a potential tuner attached somewhere else.
344 * Otherwise, we update the PLL registers via calc_regs.
346 if (state->config.no_tuner) {
347 if (fe->ops.tuner_ops.set_params) {
348 fe->ops.tuner_ops.set_params(fe);
349 if (fe->ops.i2c_gate_ctrl)
350 fe->ops.i2c_gate_ctrl(fe, 0);
352 } else if (fe->ops.tuner_ops.calc_regs) {
353 fe->ops.tuner_ops.calc_regs(fe, pllbuf + 1, 5);
354 pllbuf[1] <<= 1;
355 zl10353_write(fe, pllbuf, sizeof(pllbuf));
358 zl10353_single_write(fe, 0x5F, 0x13);
360 /* If no attached tuner or invalid PLL registers, just start the FSM. */
361 if (state->config.no_tuner || fe->ops.tuner_ops.calc_regs == NULL)
362 zl10353_single_write(fe, FSM_GO, 0x01);
363 else
364 zl10353_single_write(fe, TUNER_GO, 0x01);
366 return 0;
369 static int zl10353_get_parameters(struct dvb_frontend *fe,
370 struct dtv_frontend_properties *c)
372 struct zl10353_state *state = fe->demodulator_priv;
373 int s6, s9;
374 u16 tps;
375 static const u8 tps_fec_to_api[8] = {
376 FEC_1_2,
377 FEC_2_3,
378 FEC_3_4,
379 FEC_5_6,
380 FEC_7_8,
381 FEC_AUTO,
382 FEC_AUTO,
383 FEC_AUTO
386 s6 = zl10353_read_register(state, STATUS_6);
387 s9 = zl10353_read_register(state, STATUS_9);
388 if (s6 < 0 || s9 < 0)
389 return -EREMOTEIO;
390 if ((s6 & (1 << 5)) == 0 || (s9 & (1 << 4)) == 0)
391 return -EINVAL; /* no FE or TPS lock */
393 tps = zl10353_read_register(state, TPS_RECEIVED_1) << 8 |
394 zl10353_read_register(state, TPS_RECEIVED_0);
396 c->code_rate_HP = tps_fec_to_api[(tps >> 7) & 7];
397 c->code_rate_LP = tps_fec_to_api[(tps >> 4) & 7];
399 switch ((tps >> 13) & 3) {
400 case 0:
401 c->modulation = QPSK;
402 break;
403 case 1:
404 c->modulation = QAM_16;
405 break;
406 case 2:
407 c->modulation = QAM_64;
408 break;
409 default:
410 c->modulation = QAM_AUTO;
411 break;
414 c->transmission_mode = (tps & 0x01) ? TRANSMISSION_MODE_8K :
415 TRANSMISSION_MODE_2K;
417 switch ((tps >> 2) & 3) {
418 case 0:
419 c->guard_interval = GUARD_INTERVAL_1_32;
420 break;
421 case 1:
422 c->guard_interval = GUARD_INTERVAL_1_16;
423 break;
424 case 2:
425 c->guard_interval = GUARD_INTERVAL_1_8;
426 break;
427 case 3:
428 c->guard_interval = GUARD_INTERVAL_1_4;
429 break;
430 default:
431 c->guard_interval = GUARD_INTERVAL_AUTO;
432 break;
435 switch ((tps >> 10) & 7) {
436 case 0:
437 c->hierarchy = HIERARCHY_NONE;
438 break;
439 case 1:
440 c->hierarchy = HIERARCHY_1;
441 break;
442 case 2:
443 c->hierarchy = HIERARCHY_2;
444 break;
445 case 3:
446 c->hierarchy = HIERARCHY_4;
447 break;
448 default:
449 c->hierarchy = HIERARCHY_AUTO;
450 break;
453 c->frequency = state->frequency;
454 c->bandwidth_hz = state->bandwidth;
455 c->inversion = INVERSION_AUTO;
457 return 0;
460 static int zl10353_read_status(struct dvb_frontend *fe, enum fe_status *status)
462 struct zl10353_state *state = fe->demodulator_priv;
463 int s6, s7, s8;
465 if ((s6 = zl10353_read_register(state, STATUS_6)) < 0)
466 return -EREMOTEIO;
467 if ((s7 = zl10353_read_register(state, STATUS_7)) < 0)
468 return -EREMOTEIO;
469 if ((s8 = zl10353_read_register(state, STATUS_8)) < 0)
470 return -EREMOTEIO;
472 *status = 0;
473 if (s6 & (1 << 2))
474 *status |= FE_HAS_CARRIER;
475 if (s6 & (1 << 1))
476 *status |= FE_HAS_VITERBI;
477 if (s6 & (1 << 5))
478 *status |= FE_HAS_LOCK;
479 if (s7 & (1 << 4))
480 *status |= FE_HAS_SYNC;
481 if (s8 & (1 << 6))
482 *status |= FE_HAS_SIGNAL;
484 if ((*status & (FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_SYNC)) !=
485 (FE_HAS_CARRIER | FE_HAS_VITERBI | FE_HAS_SYNC))
486 *status &= ~FE_HAS_LOCK;
488 return 0;
491 static int zl10353_read_ber(struct dvb_frontend *fe, u32 *ber)
493 struct zl10353_state *state = fe->demodulator_priv;
495 *ber = zl10353_read_register(state, RS_ERR_CNT_2) << 16 |
496 zl10353_read_register(state, RS_ERR_CNT_1) << 8 |
497 zl10353_read_register(state, RS_ERR_CNT_0);
499 return 0;
502 static int zl10353_read_signal_strength(struct dvb_frontend *fe, u16 *strength)
504 struct zl10353_state *state = fe->demodulator_priv;
506 u16 signal = zl10353_read_register(state, AGC_GAIN_1) << 10 |
507 zl10353_read_register(state, AGC_GAIN_0) << 2 | 3;
509 *strength = ~signal;
511 return 0;
514 static int zl10353_read_snr(struct dvb_frontend *fe, u16 *snr)
516 struct zl10353_state *state = fe->demodulator_priv;
517 u8 _snr;
519 if (debug_regs)
520 zl10353_dump_regs(fe);
522 _snr = zl10353_read_register(state, SNR);
523 *snr = 10 * _snr / 8;
525 return 0;
528 static int zl10353_read_ucblocks(struct dvb_frontend *fe, u32 *ucblocks)
530 struct zl10353_state *state = fe->demodulator_priv;
531 u32 ubl = 0;
533 ubl = zl10353_read_register(state, RS_UBC_1) << 8 |
534 zl10353_read_register(state, RS_UBC_0);
536 state->ucblocks += ubl;
537 *ucblocks = state->ucblocks;
539 return 0;
542 static int zl10353_get_tune_settings(struct dvb_frontend *fe,
543 struct dvb_frontend_tune_settings
544 *fe_tune_settings)
546 fe_tune_settings->min_delay_ms = 1000;
547 fe_tune_settings->step_size = 0;
548 fe_tune_settings->max_drift = 0;
550 return 0;
553 static int zl10353_init(struct dvb_frontend *fe)
555 struct zl10353_state *state = fe->demodulator_priv;
556 u8 zl10353_reset_attach[6] = { 0x50, 0x03, 0x64, 0x46, 0x15, 0x0F };
558 if (debug_regs)
559 zl10353_dump_regs(fe);
560 if (state->config.parallel_ts)
561 zl10353_reset_attach[2] &= ~0x20;
562 if (state->config.clock_ctl_1)
563 zl10353_reset_attach[3] = state->config.clock_ctl_1;
564 if (state->config.pll_0)
565 zl10353_reset_attach[4] = state->config.pll_0;
567 /* Do a "hard" reset if not already done */
568 if (zl10353_read_register(state, 0x50) != zl10353_reset_attach[1] ||
569 zl10353_read_register(state, 0x51) != zl10353_reset_attach[2]) {
570 zl10353_write(fe, zl10353_reset_attach,
571 sizeof(zl10353_reset_attach));
572 if (debug_regs)
573 zl10353_dump_regs(fe);
576 return 0;
579 static int zl10353_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
581 struct zl10353_state *state = fe->demodulator_priv;
582 u8 val = 0x0a;
584 if (state->config.disable_i2c_gate_ctrl) {
585 /* No tuner attached to the internal I2C bus */
586 /* If set enable I2C bridge, the main I2C bus stopped hardly */
587 return 0;
590 if (enable)
591 val |= 0x10;
593 return zl10353_single_write(fe, 0x62, val);
596 static void zl10353_release(struct dvb_frontend *fe)
598 struct zl10353_state *state = fe->demodulator_priv;
599 kfree(state);
602 static const struct dvb_frontend_ops zl10353_ops;
604 struct dvb_frontend *zl10353_attach(const struct zl10353_config *config,
605 struct i2c_adapter *i2c)
607 struct zl10353_state *state = NULL;
608 int id;
610 /* allocate memory for the internal state */
611 state = kzalloc(sizeof(struct zl10353_state), GFP_KERNEL);
612 if (state == NULL)
613 goto error;
615 /* setup the state */
616 state->i2c = i2c;
617 memcpy(&state->config, config, sizeof(struct zl10353_config));
619 /* check if the demod is there */
620 id = zl10353_read_register(state, CHIP_ID);
621 if ((id != ID_ZL10353) && (id != ID_CE6230) && (id != ID_CE6231))
622 goto error;
624 /* create dvb_frontend */
625 memcpy(&state->frontend.ops, &zl10353_ops, sizeof(struct dvb_frontend_ops));
626 state->frontend.demodulator_priv = state;
628 return &state->frontend;
629 error:
630 kfree(state);
631 return NULL;
634 static const struct dvb_frontend_ops zl10353_ops = {
635 .delsys = { SYS_DVBT },
636 .info = {
637 .name = "Zarlink ZL10353 DVB-T",
638 .frequency_min = 174000000,
639 .frequency_max = 862000000,
640 .frequency_stepsize = 166667,
641 .frequency_tolerance = 0,
642 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 |
643 FE_CAN_FEC_3_4 | FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
644 FE_CAN_FEC_AUTO |
645 FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 | FE_CAN_QAM_AUTO |
646 FE_CAN_TRANSMISSION_MODE_AUTO | FE_CAN_GUARD_INTERVAL_AUTO |
647 FE_CAN_HIERARCHY_AUTO | FE_CAN_RECOVER |
648 FE_CAN_MUTE_TS
651 .release = zl10353_release,
653 .init = zl10353_init,
654 .sleep = zl10353_sleep,
655 .i2c_gate_ctrl = zl10353_i2c_gate_ctrl,
656 .write = zl10353_write,
658 .set_frontend = zl10353_set_parameters,
659 .get_frontend = zl10353_get_parameters,
660 .get_tune_settings = zl10353_get_tune_settings,
662 .read_status = zl10353_read_status,
663 .read_ber = zl10353_read_ber,
664 .read_signal_strength = zl10353_read_signal_strength,
665 .read_snr = zl10353_read_snr,
666 .read_ucblocks = zl10353_read_ucblocks,
669 module_param(debug, int, 0644);
670 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
672 module_param(debug_regs, int, 0644);
673 MODULE_PARM_DESC(debug_regs, "Turn on/off frontend register dumps (default:off).");
675 MODULE_DESCRIPTION("Zarlink ZL10353 DVB-T demodulator driver");
676 MODULE_AUTHOR("Chris Pascoe");
677 MODULE_LICENSE("GPL");
679 EXPORT_SYMBOL(zl10353_attach);