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
;
44 #define dprintk(args...) \
46 if (debug) printk(KERN_DEBUG "zl10353: " args); \
49 static int debug_regs
;
51 static int zl10353_single_write(struct dvb_frontend
*fe
, u8 reg
, u8 val
)
53 struct zl10353_state
*state
= fe
->demodulator_priv
;
54 u8 buf
[2] = { reg
, val
};
55 struct i2c_msg msg
= { .addr
= state
->config
.demod_address
, .flags
= 0,
56 .buf
= buf
, .len
= 2 };
57 int err
= i2c_transfer(state
->i2c
, &msg
, 1);
59 printk("zl10353: write to reg %x failed (err = %d)!\n", reg
, err
);
65 static int zl10353_write(struct dvb_frontend
*fe
, u8
*ibuf
, int ilen
)
68 for (i
= 0; i
< ilen
- 1; i
++)
69 if ((err
= zl10353_single_write(fe
, ibuf
[0] + i
, ibuf
[i
+ 1])))
75 static int zl10353_read_register(struct zl10353_state
*state
, u8 reg
)
80 struct i2c_msg msg
[2] = { { .addr
= state
->config
.demod_address
,
82 .buf
= b0
, .len
= 1 },
83 { .addr
= state
->config
.demod_address
,
85 .buf
= b1
, .len
= 1 } };
87 ret
= i2c_transfer(state
->i2c
, msg
, 2);
90 printk("%s: readreg error (reg=%d, ret==%i)\n",
98 static void zl10353_dump_regs(struct dvb_frontend
*fe
)
100 struct zl10353_state
*state
= fe
->demodulator_priv
;
101 char buf
[52], buf2
[4];
105 /* Dump all registers. */
106 for (reg
= 0; ; reg
++) {
109 printk(KERN_DEBUG
"%s\n", buf
);
110 sprintf(buf
, "%02x: ", reg
);
112 ret
= zl10353_read_register(state
, reg
);
114 sprintf(buf2
, "%02x ", (u8
)ret
);
121 printk(KERN_DEBUG
"%s\n", buf
);
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 zl10353_single_write(fe
, RESET
, 0x80);
206 zl10353_single_write(fe
, 0xEA, 0x01);
208 zl10353_single_write(fe
, 0xEA, 0x00);
210 zl10353_single_write(fe
, AGC_TARGET
, 0x28);
212 if (op
->transmission_mode
!= TRANSMISSION_MODE_AUTO
)
214 if (op
->guard_interval
!= GUARD_INTERVAL_AUTO
)
216 zl10353_single_write(fe
, ACQ_CTL
, acq_ctl
);
218 switch (op
->bandwidth
) {
219 case BANDWIDTH_6_MHZ
:
220 /* These are extrapolated from the 7 and 8MHz values */
221 zl10353_single_write(fe
, MCLK_RATIO
, 0x97);
222 zl10353_single_write(fe
, 0x64, 0x34);
223 zl10353_single_write(fe
, 0xcc, 0xdd);
225 case BANDWIDTH_7_MHZ
:
226 zl10353_single_write(fe
, MCLK_RATIO
, 0x86);
227 zl10353_single_write(fe
, 0x64, 0x35);
228 zl10353_single_write(fe
, 0xcc, 0x73);
230 case BANDWIDTH_8_MHZ
:
232 zl10353_single_write(fe
, MCLK_RATIO
, 0x75);
233 zl10353_single_write(fe
, 0x64, 0x36);
234 zl10353_single_write(fe
, 0xcc, 0x73);
237 zl10353_calc_nominal_rate(fe
, op
->bandwidth
, &nominal_rate
);
238 zl10353_single_write(fe
, TRL_NOMINAL_RATE_1
, msb(nominal_rate
));
239 zl10353_single_write(fe
, TRL_NOMINAL_RATE_0
, lsb(nominal_rate
));
240 state
->bandwidth
= op
->bandwidth
;
242 zl10353_calc_input_freq(fe
, &input_freq
);
243 zl10353_single_write(fe
, INPUT_FREQ_1
, msb(input_freq
));
244 zl10353_single_write(fe
, INPUT_FREQ_0
, lsb(input_freq
));
246 /* Hint at TPS settings */
247 switch (op
->code_rate_HP
) {
267 switch (op
->code_rate_LP
) {
284 if (op
->hierarchy_information
== HIERARCHY_AUTO
||
285 op
->hierarchy_information
== HIERARCHY_NONE
)
291 switch (op
->constellation
) {
305 switch (op
->transmission_mode
) {
306 case TRANSMISSION_MODE_2K
:
307 case TRANSMISSION_MODE_AUTO
:
309 case TRANSMISSION_MODE_8K
:
316 switch (op
->guard_interval
) {
317 case GUARD_INTERVAL_1_32
:
318 case GUARD_INTERVAL_AUTO
:
320 case GUARD_INTERVAL_1_16
:
323 case GUARD_INTERVAL_1_8
:
326 case GUARD_INTERVAL_1_4
:
333 switch (op
->hierarchy_information
) {
350 zl10353_single_write(fe
, TPS_GIVEN_1
, msb(tps
));
351 zl10353_single_write(fe
, TPS_GIVEN_0
, lsb(tps
));
353 if (fe
->ops
.i2c_gate_ctrl
)
354 fe
->ops
.i2c_gate_ctrl(fe
, 0);
357 * If there is no tuner attached to the secondary I2C bus, we call
358 * set_params to program a potential tuner attached somewhere else.
359 * Otherwise, we update the PLL registers via calc_regs.
361 if (state
->config
.no_tuner
) {
362 if (fe
->ops
.tuner_ops
.set_params
) {
363 fe
->ops
.tuner_ops
.set_params(fe
, param
);
364 if (fe
->ops
.i2c_gate_ctrl
)
365 fe
->ops
.i2c_gate_ctrl(fe
, 0);
367 } else if (fe
->ops
.tuner_ops
.calc_regs
) {
368 fe
->ops
.tuner_ops
.calc_regs(fe
, param
, pllbuf
+ 1, 5);
370 zl10353_write(fe
, pllbuf
, sizeof(pllbuf
));
373 zl10353_single_write(fe
, 0x5F, 0x13);
375 /* If no attached tuner or invalid PLL registers, just start the FSM. */
376 if (state
->config
.no_tuner
|| fe
->ops
.tuner_ops
.calc_regs
== NULL
)
377 zl10353_single_write(fe
, FSM_GO
, 0x01);
379 zl10353_single_write(fe
, TUNER_GO
, 0x01);
384 static int zl10353_get_parameters(struct dvb_frontend
*fe
,
385 struct dvb_frontend_parameters
*param
)
387 struct zl10353_state
*state
= fe
->demodulator_priv
;
388 struct dvb_ofdm_parameters
*op
= ¶m
->u
.ofdm
;
391 static const u8 tps_fec_to_api
[8] = {
402 s6
= zl10353_read_register(state
, STATUS_6
);
403 s9
= zl10353_read_register(state
, STATUS_9
);
404 if (s6
< 0 || s9
< 0)
406 if ((s6
& (1 << 5)) == 0 || (s9
& (1 << 4)) == 0)
407 return -EINVAL
; /* no FE or TPS lock */
409 tps
= zl10353_read_register(state
, TPS_RECEIVED_1
) << 8 |
410 zl10353_read_register(state
, TPS_RECEIVED_0
);
412 op
->code_rate_HP
= tps_fec_to_api
[(tps
>> 7) & 7];
413 op
->code_rate_LP
= tps_fec_to_api
[(tps
>> 4) & 7];
415 switch ((tps
>> 13) & 3) {
417 op
->constellation
= QPSK
;
420 op
->constellation
= QAM_16
;
423 op
->constellation
= QAM_64
;
426 op
->constellation
= QAM_AUTO
;
430 op
->transmission_mode
= (tps
& 0x01) ? TRANSMISSION_MODE_8K
:
431 TRANSMISSION_MODE_2K
;
433 switch ((tps
>> 2) & 3) {
435 op
->guard_interval
= GUARD_INTERVAL_1_32
;
438 op
->guard_interval
= GUARD_INTERVAL_1_16
;
441 op
->guard_interval
= GUARD_INTERVAL_1_8
;
444 op
->guard_interval
= GUARD_INTERVAL_1_4
;
447 op
->guard_interval
= GUARD_INTERVAL_AUTO
;
451 switch ((tps
>> 10) & 7) {
453 op
->hierarchy_information
= HIERARCHY_NONE
;
456 op
->hierarchy_information
= HIERARCHY_1
;
459 op
->hierarchy_information
= HIERARCHY_2
;
462 op
->hierarchy_information
= HIERARCHY_4
;
465 op
->hierarchy_information
= HIERARCHY_AUTO
;
469 param
->frequency
= 0;
470 op
->bandwidth
= state
->bandwidth
;
471 param
->inversion
= INVERSION_AUTO
;
476 static int zl10353_read_status(struct dvb_frontend
*fe
, fe_status_t
*status
)
478 struct zl10353_state
*state
= fe
->demodulator_priv
;
481 if ((s6
= zl10353_read_register(state
, STATUS_6
)) < 0)
483 if ((s7
= zl10353_read_register(state
, STATUS_7
)) < 0)
485 if ((s8
= zl10353_read_register(state
, STATUS_8
)) < 0)
490 *status
|= FE_HAS_CARRIER
;
492 *status
|= FE_HAS_VITERBI
;
494 *status
|= FE_HAS_LOCK
;
496 *status
|= FE_HAS_SYNC
;
498 *status
|= FE_HAS_SIGNAL
;
500 if ((*status
& (FE_HAS_CARRIER
| FE_HAS_VITERBI
| FE_HAS_SYNC
)) !=
501 (FE_HAS_CARRIER
| FE_HAS_VITERBI
| FE_HAS_SYNC
))
502 *status
&= ~FE_HAS_LOCK
;
507 static int zl10353_read_ber(struct dvb_frontend
*fe
, u32
*ber
)
509 struct zl10353_state
*state
= fe
->demodulator_priv
;
511 *ber
= zl10353_read_register(state
, RS_ERR_CNT_2
) << 16 |
512 zl10353_read_register(state
, RS_ERR_CNT_1
) << 8 |
513 zl10353_read_register(state
, RS_ERR_CNT_0
);
518 static int zl10353_read_signal_strength(struct dvb_frontend
*fe
, u16
*strength
)
520 struct zl10353_state
*state
= fe
->demodulator_priv
;
522 u16 signal
= zl10353_read_register(state
, AGC_GAIN_1
) << 10 |
523 zl10353_read_register(state
, AGC_GAIN_0
) << 2 | 3;
530 static int zl10353_read_snr(struct dvb_frontend
*fe
, u16
*snr
)
532 struct zl10353_state
*state
= fe
->demodulator_priv
;
536 zl10353_dump_regs(fe
);
538 _snr
= zl10353_read_register(state
, SNR
);
539 *snr
= (_snr
<< 8) | _snr
;
544 static int zl10353_read_ucblocks(struct dvb_frontend
*fe
, u32
*ucblocks
)
546 struct zl10353_state
*state
= fe
->demodulator_priv
;
548 *ucblocks
= zl10353_read_register(state
, RS_UBC_1
) << 8 |
549 zl10353_read_register(state
, RS_UBC_0
);
554 static int zl10353_get_tune_settings(struct dvb_frontend
*fe
,
555 struct dvb_frontend_tune_settings
558 fe_tune_settings
->min_delay_ms
= 1000;
559 fe_tune_settings
->step_size
= 0;
560 fe_tune_settings
->max_drift
= 0;
565 static int zl10353_init(struct dvb_frontend
*fe
)
567 struct zl10353_state
*state
= fe
->demodulator_priv
;
568 u8 zl10353_reset_attach
[6] = { 0x50, 0x03, 0x64, 0x46, 0x15, 0x0F };
572 zl10353_dump_regs(fe
);
573 if (state
->config
.parallel_ts
)
574 zl10353_reset_attach
[2] &= ~0x20;
575 if (state
->config
.clock_ctl_1
)
576 zl10353_reset_attach
[3] = state
->config
.clock_ctl_1
;
577 if (state
->config
.pll_0
)
578 zl10353_reset_attach
[4] = state
->config
.pll_0
;
580 /* Do a "hard" reset if not already done */
581 if (zl10353_read_register(state
, 0x50) != zl10353_reset_attach
[1] ||
582 zl10353_read_register(state
, 0x51) != zl10353_reset_attach
[2]) {
583 rc
= zl10353_write(fe
, zl10353_reset_attach
,
584 sizeof(zl10353_reset_attach
));
586 zl10353_dump_regs(fe
);
592 static int zl10353_i2c_gate_ctrl(struct dvb_frontend
* fe
, int enable
)
594 struct zl10353_state
*state
= fe
->demodulator_priv
;
597 if (state
->config
.disable_i2c_gate_ctrl
) {
598 /* No tuner attached to the internal I2C bus */
599 /* If set enable I2C bridge, the main I2C bus stopped hardly */
606 return zl10353_single_write(fe
, 0x62, val
);
609 static void zl10353_release(struct dvb_frontend
*fe
)
611 struct zl10353_state
*state
= fe
->demodulator_priv
;
615 static struct dvb_frontend_ops zl10353_ops
;
617 struct dvb_frontend
*zl10353_attach(const struct zl10353_config
*config
,
618 struct i2c_adapter
*i2c
)
620 struct zl10353_state
*state
= NULL
;
623 /* allocate memory for the internal state */
624 state
= kzalloc(sizeof(struct zl10353_state
), GFP_KERNEL
);
628 /* setup the state */
630 memcpy(&state
->config
, config
, sizeof(struct zl10353_config
));
632 /* check if the demod is there */
633 id
= zl10353_read_register(state
, CHIP_ID
);
634 if ((id
!= ID_ZL10353
) && (id
!= ID_CE6230
) && (id
!= ID_CE6231
))
637 /* create dvb_frontend */
638 memcpy(&state
->frontend
.ops
, &zl10353_ops
, sizeof(struct dvb_frontend_ops
));
639 state
->frontend
.demodulator_priv
= state
;
641 return &state
->frontend
;
647 static struct dvb_frontend_ops zl10353_ops
= {
650 .name
= "Zarlink ZL10353 DVB-T",
652 .frequency_min
= 174000000,
653 .frequency_max
= 862000000,
654 .frequency_stepsize
= 166667,
655 .frequency_tolerance
= 0,
656 .caps
= FE_CAN_FEC_1_2
| FE_CAN_FEC_2_3
|
657 FE_CAN_FEC_3_4
| FE_CAN_FEC_5_6
| FE_CAN_FEC_7_8
|
659 FE_CAN_QPSK
| FE_CAN_QAM_16
| FE_CAN_QAM_64
| FE_CAN_QAM_AUTO
|
660 FE_CAN_TRANSMISSION_MODE_AUTO
| FE_CAN_GUARD_INTERVAL_AUTO
|
661 FE_CAN_HIERARCHY_AUTO
| FE_CAN_RECOVER
|
665 .release
= zl10353_release
,
667 .init
= zl10353_init
,
668 .sleep
= zl10353_sleep
,
669 .i2c_gate_ctrl
= zl10353_i2c_gate_ctrl
,
670 .write
= zl10353_write
,
672 .set_frontend
= zl10353_set_parameters
,
673 .get_frontend
= zl10353_get_parameters
,
674 .get_tune_settings
= zl10353_get_tune_settings
,
676 .read_status
= zl10353_read_status
,
677 .read_ber
= zl10353_read_ber
,
678 .read_signal_strength
= zl10353_read_signal_strength
,
679 .read_snr
= zl10353_read_snr
,
680 .read_ucblocks
= zl10353_read_ucblocks
,
683 module_param(debug
, int, 0644);
684 MODULE_PARM_DESC(debug
, "Turn on/off frontend debugging (default:off).");
686 module_param(debug_regs
, int, 0644);
687 MODULE_PARM_DESC(debug_regs
, "Turn on/off frontend register dumps (default:off).");
689 MODULE_DESCRIPTION("Zarlink ZL10353 DVB-T demodulator driver");
690 MODULE_AUTHOR("Chris Pascoe");
691 MODULE_LICENSE("GPL");
693 EXPORT_SYMBOL(zl10353_attach
);