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.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/delay.h>
26 #include <linux/string.h>
27 #include <linux/slab.h>
28 #include <asm/div64.h>
30 #include "dvb_frontend.h"
31 #include "zl10353_priv.h"
34 struct zl10353_state
{
35 struct i2c_adapter
*i2c
;
36 struct dvb_frontend frontend
;
38 struct zl10353_config config
;
40 enum fe_bandwidth bandwidth
;
46 #define dprintk(args...) \
48 if (debug) printk(KERN_DEBUG "zl10353: " args); \
51 static int debug_regs
;
53 static int zl10353_single_write(struct dvb_frontend
*fe
, u8 reg
, u8 val
)
55 struct zl10353_state
*state
= fe
->demodulator_priv
;
56 u8 buf
[2] = { reg
, val
};
57 struct i2c_msg msg
= { .addr
= state
->config
.demod_address
, .flags
= 0,
58 .buf
= buf
, .len
= 2 };
59 int err
= i2c_transfer(state
->i2c
, &msg
, 1);
61 printk("zl10353: write to reg %x failed (err = %d)!\n", reg
, err
);
67 static int zl10353_write(struct dvb_frontend
*fe
, u8
*ibuf
, int ilen
)
70 for (i
= 0; i
< ilen
- 1; i
++)
71 if ((err
= zl10353_single_write(fe
, ibuf
[0] + i
, ibuf
[i
+ 1])))
77 static int zl10353_read_register(struct zl10353_state
*state
, u8 reg
)
82 struct i2c_msg msg
[2] = { { .addr
= state
->config
.demod_address
,
84 .buf
= b0
, .len
= 1 },
85 { .addr
= state
->config
.demod_address
,
87 .buf
= b1
, .len
= 1 } };
89 ret
= i2c_transfer(state
->i2c
, msg
, 2);
92 printk("%s: readreg error (reg=%d, ret==%i)\n",
100 static void zl10353_dump_regs(struct dvb_frontend
*fe
)
102 struct zl10353_state
*state
= fe
->demodulator_priv
;
106 /* Dump all registers. */
107 for (reg
= 0; ; reg
++) {
110 printk(KERN_CONT
"\n");
111 printk(KERN_DEBUG
"%02x:", reg
);
113 ret
= zl10353_read_register(state
, reg
);
115 printk(KERN_CONT
" %02x", (u8
)ret
);
117 printk(KERN_CONT
" --");
121 printk(KERN_CONT
"\n");
124 static void zl10353_calc_nominal_rate(struct dvb_frontend
*fe
,
125 enum fe_bandwidth bandwidth
,
128 struct zl10353_state
*state
= fe
->demodulator_priv
;
129 u32 adc_clock
= 450560; /* 45.056 MHz */
133 if (state
->config
.adc_clock
)
134 adc_clock
= state
->config
.adc_clock
;
137 case BANDWIDTH_6_MHZ
:
140 case BANDWIDTH_7_MHZ
:
143 case BANDWIDTH_8_MHZ
:
149 value
= (u64
)10 * (1 << 23) / 7 * 125;
150 value
= (bw
* value
) + adc_clock
/ 2;
151 do_div(value
, adc_clock
);
152 *nominal_rate
= value
;
154 dprintk("%s: bw %d, adc_clock %d => 0x%x\n",
155 __func__
, bw
, adc_clock
, *nominal_rate
);
158 static void zl10353_calc_input_freq(struct dvb_frontend
*fe
,
161 struct zl10353_state
*state
= fe
->demodulator_priv
;
162 u32 adc_clock
= 450560; /* 45.056 MHz */
163 int if2
= 361667; /* 36.1667 MHz */
167 if (state
->config
.adc_clock
)
168 adc_clock
= state
->config
.adc_clock
;
169 if (state
->config
.if2
)
170 if2
= state
->config
.if2
;
172 if (adc_clock
>= if2
* 2)
175 ife
= adc_clock
- (if2
% adc_clock
);
176 if (ife
> adc_clock
/ 2)
177 ife
= adc_clock
- ife
;
179 value
= (u64
)65536 * ife
+ adc_clock
/ 2;
180 do_div(value
, adc_clock
);
181 *input_freq
= -value
;
183 dprintk("%s: if2 %d, ife %d, adc_clock %d => %d / 0x%x\n",
184 __func__
, if2
, ife
, adc_clock
, -(int)value
, *input_freq
);
187 static int zl10353_sleep(struct dvb_frontend
*fe
)
189 static u8 zl10353_softdown
[] = { 0x50, 0x0C, 0x44 };
191 zl10353_write(fe
, zl10353_softdown
, sizeof(zl10353_softdown
));
195 static int zl10353_set_parameters(struct dvb_frontend
*fe
,
196 struct dvb_frontend_parameters
*param
)
198 struct zl10353_state
*state
= fe
->demodulator_priv
;
199 u16 nominal_rate
, input_freq
;
200 u8 pllbuf
[6] = { 0x67 }, acq_ctl
= 0;
202 struct dvb_ofdm_parameters
*op
= ¶m
->u
.ofdm
;
204 state
->frequency
= param
->frequency
;
206 zl10353_single_write(fe
, RESET
, 0x80);
208 zl10353_single_write(fe
, 0xEA, 0x01);
210 zl10353_single_write(fe
, 0xEA, 0x00);
212 zl10353_single_write(fe
, AGC_TARGET
, 0x28);
214 if (op
->transmission_mode
!= TRANSMISSION_MODE_AUTO
)
216 if (op
->guard_interval
!= GUARD_INTERVAL_AUTO
)
218 zl10353_single_write(fe
, ACQ_CTL
, acq_ctl
);
220 switch (op
->bandwidth
) {
221 case BANDWIDTH_6_MHZ
:
222 /* These are extrapolated from the 7 and 8MHz values */
223 zl10353_single_write(fe
, MCLK_RATIO
, 0x97);
224 zl10353_single_write(fe
, 0x64, 0x34);
225 zl10353_single_write(fe
, 0xcc, 0xdd);
227 case BANDWIDTH_7_MHZ
:
228 zl10353_single_write(fe
, MCLK_RATIO
, 0x86);
229 zl10353_single_write(fe
, 0x64, 0x35);
230 zl10353_single_write(fe
, 0xcc, 0x73);
232 case BANDWIDTH_8_MHZ
:
234 zl10353_single_write(fe
, MCLK_RATIO
, 0x75);
235 zl10353_single_write(fe
, 0x64, 0x36);
236 zl10353_single_write(fe
, 0xcc, 0x73);
239 zl10353_calc_nominal_rate(fe
, op
->bandwidth
, &nominal_rate
);
240 zl10353_single_write(fe
, TRL_NOMINAL_RATE_1
, msb(nominal_rate
));
241 zl10353_single_write(fe
, TRL_NOMINAL_RATE_0
, lsb(nominal_rate
));
242 state
->bandwidth
= op
->bandwidth
;
244 zl10353_calc_input_freq(fe
, &input_freq
);
245 zl10353_single_write(fe
, INPUT_FREQ_1
, msb(input_freq
));
246 zl10353_single_write(fe
, INPUT_FREQ_0
, lsb(input_freq
));
248 /* Hint at TPS settings */
249 switch (op
->code_rate_HP
) {
269 switch (op
->code_rate_LP
) {
286 if (op
->hierarchy_information
== HIERARCHY_AUTO
||
287 op
->hierarchy_information
== HIERARCHY_NONE
)
293 switch (op
->constellation
) {
307 switch (op
->transmission_mode
) {
308 case TRANSMISSION_MODE_2K
:
309 case TRANSMISSION_MODE_AUTO
:
311 case TRANSMISSION_MODE_8K
:
318 switch (op
->guard_interval
) {
319 case GUARD_INTERVAL_1_32
:
320 case GUARD_INTERVAL_AUTO
:
322 case GUARD_INTERVAL_1_16
:
325 case GUARD_INTERVAL_1_8
:
328 case GUARD_INTERVAL_1_4
:
335 switch (op
->hierarchy_information
) {
352 zl10353_single_write(fe
, TPS_GIVEN_1
, msb(tps
));
353 zl10353_single_write(fe
, TPS_GIVEN_0
, lsb(tps
));
355 if (fe
->ops
.i2c_gate_ctrl
)
356 fe
->ops
.i2c_gate_ctrl(fe
, 0);
359 * If there is no tuner attached to the secondary I2C bus, we call
360 * set_params to program a potential tuner attached somewhere else.
361 * Otherwise, we update the PLL registers via calc_regs.
363 if (state
->config
.no_tuner
) {
364 if (fe
->ops
.tuner_ops
.set_params
) {
365 fe
->ops
.tuner_ops
.set_params(fe
, param
);
366 if (fe
->ops
.i2c_gate_ctrl
)
367 fe
->ops
.i2c_gate_ctrl(fe
, 0);
369 } else if (fe
->ops
.tuner_ops
.calc_regs
) {
370 fe
->ops
.tuner_ops
.calc_regs(fe
, param
, pllbuf
+ 1, 5);
372 zl10353_write(fe
, pllbuf
, sizeof(pllbuf
));
375 zl10353_single_write(fe
, 0x5F, 0x13);
377 /* If no attached tuner or invalid PLL registers, just start the FSM. */
378 if (state
->config
.no_tuner
|| fe
->ops
.tuner_ops
.calc_regs
== NULL
)
379 zl10353_single_write(fe
, FSM_GO
, 0x01);
381 zl10353_single_write(fe
, TUNER_GO
, 0x01);
386 static int zl10353_get_parameters(struct dvb_frontend
*fe
,
387 struct dvb_frontend_parameters
*param
)
389 struct zl10353_state
*state
= fe
->demodulator_priv
;
390 struct dvb_ofdm_parameters
*op
= ¶m
->u
.ofdm
;
393 static const u8 tps_fec_to_api
[8] = {
404 s6
= zl10353_read_register(state
, STATUS_6
);
405 s9
= zl10353_read_register(state
, STATUS_9
);
406 if (s6
< 0 || s9
< 0)
408 if ((s6
& (1 << 5)) == 0 || (s9
& (1 << 4)) == 0)
409 return -EINVAL
; /* no FE or TPS lock */
411 tps
= zl10353_read_register(state
, TPS_RECEIVED_1
) << 8 |
412 zl10353_read_register(state
, TPS_RECEIVED_0
);
414 op
->code_rate_HP
= tps_fec_to_api
[(tps
>> 7) & 7];
415 op
->code_rate_LP
= tps_fec_to_api
[(tps
>> 4) & 7];
417 switch ((tps
>> 13) & 3) {
419 op
->constellation
= QPSK
;
422 op
->constellation
= QAM_16
;
425 op
->constellation
= QAM_64
;
428 op
->constellation
= QAM_AUTO
;
432 op
->transmission_mode
= (tps
& 0x01) ? TRANSMISSION_MODE_8K
:
433 TRANSMISSION_MODE_2K
;
435 switch ((tps
>> 2) & 3) {
437 op
->guard_interval
= GUARD_INTERVAL_1_32
;
440 op
->guard_interval
= GUARD_INTERVAL_1_16
;
443 op
->guard_interval
= GUARD_INTERVAL_1_8
;
446 op
->guard_interval
= GUARD_INTERVAL_1_4
;
449 op
->guard_interval
= GUARD_INTERVAL_AUTO
;
453 switch ((tps
>> 10) & 7) {
455 op
->hierarchy_information
= HIERARCHY_NONE
;
458 op
->hierarchy_information
= HIERARCHY_1
;
461 op
->hierarchy_information
= HIERARCHY_2
;
464 op
->hierarchy_information
= HIERARCHY_4
;
467 op
->hierarchy_information
= HIERARCHY_AUTO
;
471 param
->frequency
= state
->frequency
;
472 op
->bandwidth
= state
->bandwidth
;
473 param
->inversion
= INVERSION_AUTO
;
478 static int zl10353_read_status(struct dvb_frontend
*fe
, fe_status_t
*status
)
480 struct zl10353_state
*state
= fe
->demodulator_priv
;
483 if ((s6
= zl10353_read_register(state
, STATUS_6
)) < 0)
485 if ((s7
= zl10353_read_register(state
, STATUS_7
)) < 0)
487 if ((s8
= zl10353_read_register(state
, STATUS_8
)) < 0)
492 *status
|= FE_HAS_CARRIER
;
494 *status
|= FE_HAS_VITERBI
;
496 *status
|= FE_HAS_LOCK
;
498 *status
|= FE_HAS_SYNC
;
500 *status
|= FE_HAS_SIGNAL
;
502 if ((*status
& (FE_HAS_CARRIER
| FE_HAS_VITERBI
| FE_HAS_SYNC
)) !=
503 (FE_HAS_CARRIER
| FE_HAS_VITERBI
| FE_HAS_SYNC
))
504 *status
&= ~FE_HAS_LOCK
;
509 static int zl10353_read_ber(struct dvb_frontend
*fe
, u32
*ber
)
511 struct zl10353_state
*state
= fe
->demodulator_priv
;
513 *ber
= zl10353_read_register(state
, RS_ERR_CNT_2
) << 16 |
514 zl10353_read_register(state
, RS_ERR_CNT_1
) << 8 |
515 zl10353_read_register(state
, RS_ERR_CNT_0
);
520 static int zl10353_read_signal_strength(struct dvb_frontend
*fe
, u16
*strength
)
522 struct zl10353_state
*state
= fe
->demodulator_priv
;
524 u16 signal
= zl10353_read_register(state
, AGC_GAIN_1
) << 10 |
525 zl10353_read_register(state
, AGC_GAIN_0
) << 2 | 3;
532 static int zl10353_read_snr(struct dvb_frontend
*fe
, u16
*snr
)
534 struct zl10353_state
*state
= fe
->demodulator_priv
;
538 zl10353_dump_regs(fe
);
540 _snr
= zl10353_read_register(state
, SNR
);
541 *snr
= (_snr
<< 8) | _snr
;
546 static int zl10353_read_ucblocks(struct dvb_frontend
*fe
, u32
*ucblocks
)
548 struct zl10353_state
*state
= fe
->demodulator_priv
;
551 ubl
= zl10353_read_register(state
, RS_UBC_1
) << 8 |
552 zl10353_read_register(state
, RS_UBC_0
);
554 state
->ucblocks
+= ubl
;
555 *ucblocks
= state
->ucblocks
;
560 static int zl10353_get_tune_settings(struct dvb_frontend
*fe
,
561 struct dvb_frontend_tune_settings
564 fe_tune_settings
->min_delay_ms
= 1000;
565 fe_tune_settings
->step_size
= 0;
566 fe_tune_settings
->max_drift
= 0;
571 static int zl10353_init(struct dvb_frontend
*fe
)
573 struct zl10353_state
*state
= fe
->demodulator_priv
;
574 u8 zl10353_reset_attach
[6] = { 0x50, 0x03, 0x64, 0x46, 0x15, 0x0F };
578 zl10353_dump_regs(fe
);
579 if (state
->config
.parallel_ts
)
580 zl10353_reset_attach
[2] &= ~0x20;
581 if (state
->config
.clock_ctl_1
)
582 zl10353_reset_attach
[3] = state
->config
.clock_ctl_1
;
583 if (state
->config
.pll_0
)
584 zl10353_reset_attach
[4] = state
->config
.pll_0
;
586 /* Do a "hard" reset if not already done */
587 if (zl10353_read_register(state
, 0x50) != zl10353_reset_attach
[1] ||
588 zl10353_read_register(state
, 0x51) != zl10353_reset_attach
[2]) {
589 rc
= zl10353_write(fe
, zl10353_reset_attach
,
590 sizeof(zl10353_reset_attach
));
592 zl10353_dump_regs(fe
);
598 static int zl10353_i2c_gate_ctrl(struct dvb_frontend
* fe
, int enable
)
600 struct zl10353_state
*state
= fe
->demodulator_priv
;
603 if (state
->config
.disable_i2c_gate_ctrl
) {
604 /* No tuner attached to the internal I2C bus */
605 /* If set enable I2C bridge, the main I2C bus stopped hardly */
612 return zl10353_single_write(fe
, 0x62, val
);
615 static void zl10353_release(struct dvb_frontend
*fe
)
617 struct zl10353_state
*state
= fe
->demodulator_priv
;
621 static struct dvb_frontend_ops zl10353_ops
;
623 struct dvb_frontend
*zl10353_attach(const struct zl10353_config
*config
,
624 struct i2c_adapter
*i2c
)
626 struct zl10353_state
*state
= NULL
;
629 /* allocate memory for the internal state */
630 state
= kzalloc(sizeof(struct zl10353_state
), GFP_KERNEL
);
634 /* setup the state */
636 memcpy(&state
->config
, config
, sizeof(struct zl10353_config
));
638 /* check if the demod is there */
639 id
= zl10353_read_register(state
, CHIP_ID
);
640 if ((id
!= ID_ZL10353
) && (id
!= ID_CE6230
) && (id
!= ID_CE6231
))
643 /* create dvb_frontend */
644 memcpy(&state
->frontend
.ops
, &zl10353_ops
, sizeof(struct dvb_frontend_ops
));
645 state
->frontend
.demodulator_priv
= state
;
647 return &state
->frontend
;
653 static struct dvb_frontend_ops zl10353_ops
= {
656 .name
= "Zarlink ZL10353 DVB-T",
658 .frequency_min
= 174000000,
659 .frequency_max
= 862000000,
660 .frequency_stepsize
= 166667,
661 .frequency_tolerance
= 0,
662 .caps
= FE_CAN_FEC_1_2
| FE_CAN_FEC_2_3
|
663 FE_CAN_FEC_3_4
| FE_CAN_FEC_5_6
| FE_CAN_FEC_7_8
|
665 FE_CAN_QPSK
| FE_CAN_QAM_16
| FE_CAN_QAM_64
| FE_CAN_QAM_AUTO
|
666 FE_CAN_TRANSMISSION_MODE_AUTO
| FE_CAN_GUARD_INTERVAL_AUTO
|
667 FE_CAN_HIERARCHY_AUTO
| FE_CAN_RECOVER
|
671 .release
= zl10353_release
,
673 .init
= zl10353_init
,
674 .sleep
= zl10353_sleep
,
675 .i2c_gate_ctrl
= zl10353_i2c_gate_ctrl
,
676 .write
= zl10353_write
,
678 .set_frontend
= zl10353_set_parameters
,
679 .get_frontend
= zl10353_get_parameters
,
680 .get_tune_settings
= zl10353_get_tune_settings
,
682 .read_status
= zl10353_read_status
,
683 .read_ber
= zl10353_read_ber
,
684 .read_signal_strength
= zl10353_read_signal_strength
,
685 .read_snr
= zl10353_read_snr
,
686 .read_ucblocks
= zl10353_read_ucblocks
,
689 module_param(debug
, int, 0644);
690 MODULE_PARM_DESC(debug
, "Turn on/off frontend debugging (default:off).");
692 module_param(debug_regs
, int, 0644);
693 MODULE_PARM_DESC(debug_regs
, "Turn on/off frontend register dumps (default:off).");
695 MODULE_DESCRIPTION("Zarlink ZL10353 DVB-T demodulator driver");
696 MODULE_AUTHOR("Chris Pascoe");
697 MODULE_LICENSE("GPL");
699 EXPORT_SYMBOL(zl10353_attach
);