2 * Support for LGDT3302 and LGDT3303 - VSB/QAM
4 * Copyright (C) 2005 Wilson Michaels <wilsonmichaels@earthlink.net>
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
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 * NOTES ABOUT THIS DRIVER
25 * This Linux driver supports:
26 * DViCO FusionHDTV 3 Gold-Q
27 * DViCO FusionHDTV 3 Gold-T
28 * DViCO FusionHDTV 5 Gold
29 * DViCO FusionHDTV 5 Lite
30 * DViCO FusionHDTV 5 USB Gold
31 * Air2PC/AirStar 2 ATSC 3rd generation (HD5000)
35 * signal strength always returns 0.
39 #include <linux/kernel.h>
40 #include <linux/module.h>
41 #include <linux/moduleparam.h>
42 #include <linux/init.h>
43 #include <linux/delay.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <asm/byteorder.h>
48 #include "dvb_frontend.h"
49 #include "lgdt330x_priv.h"
53 module_param(debug, int, 0644);
54 MODULE_PARM_DESC(debug,"Turn on/off lgdt330x frontend debugging (default:off).");
55 #define dprintk(args...) \
57 if (debug) printk(KERN_DEBUG "lgdt330x: " args); \
62 struct i2c_adapter* i2c;
63 struct dvb_frontend_ops ops;
65 /* Configuration settings */
66 const struct lgdt330x_config* config;
68 struct dvb_frontend frontend;
70 /* Demodulator private data */
71 fe_modulation_t current_modulation;
73 /* Tuner private data */
74 u32 current_frequency;
77 static int i2c_write_demod_bytes (struct lgdt330x_state* state,
78 u8 *buf, /* data bytes to send */
79 int len /* number of bytes to send */ )
82 { .addr = state->config->demod_address,
89 for (i=0; i<len-1; i+=2){
90 if ((err = i2c_transfer(state->i2c, &msg, 1)) != 1) {
91 printk(KERN_WARNING "lgdt330x: %s error (addr %02x <- %02x, err = %i)\n", __FUNCTION__, msg.buf[0], msg.buf[1], err);
103 * This routine writes the register (reg) to the demod bus
104 * then reads the data returned for (len) bytes.
107 static u8 i2c_read_demod_bytes (struct lgdt330x_state* state,
108 enum I2C_REG reg, u8* buf, int len)
111 struct i2c_msg msg [] = {
112 { .addr = state->config->demod_address,
113 .flags = 0, .buf = wr, .len = 1 },
114 { .addr = state->config->demod_address,
115 .flags = I2C_M_RD, .buf = buf, .len = len },
118 ret = i2c_transfer(state->i2c, msg, 2);
120 printk(KERN_WARNING "lgdt330x: %s: addr 0x%02x select 0x%02x error (ret == %i)\n", __FUNCTION__, state->config->demod_address, reg, ret);
128 static int lgdt3302_SwReset(struct lgdt330x_state* state)
133 0x00 /* bit 6 is active low software reset
134 * bits 5-0 are 1 to mask interrupts */
137 ret = i2c_write_demod_bytes(state,
138 reset, sizeof(reset));
141 /* force reset high (inactive) and unmask interrupts */
143 ret = i2c_write_demod_bytes(state,
144 reset, sizeof(reset));
149 static int lgdt3303_SwReset(struct lgdt330x_state* state)
154 0x00 /* bit 0 is active low software reset */
157 ret = i2c_write_demod_bytes(state,
158 reset, sizeof(reset));
161 /* force reset high (inactive) */
163 ret = i2c_write_demod_bytes(state,
164 reset, sizeof(reset));
169 static int lgdt330x_SwReset(struct lgdt330x_state* state)
171 switch (state->config->demod_chip) {
173 return lgdt3302_SwReset(state);
175 return lgdt3303_SwReset(state);
181 static int lgdt330x_init(struct dvb_frontend* fe)
183 /* Hardware reset is done using gpio[0] of cx23880x chip.
184 * I'd like to do it here, but don't know how to find chip address.
185 * cx88-cards.c arranges for the reset bit to be inactive (high).
186 * Maybe there needs to be a callable function in cx88-core or
187 * the caller of this function needs to do it. */
190 * Array of byte pairs <address, value>
191 * to initialize each different chip
193 static u8 lgdt3302_init_data[] = {
194 /* Use 50MHz parameter values from spec sheet since xtal is 50 */
195 /* Change the value of NCOCTFV[25:0] of carrier
196 recovery center frequency register */
197 VSB_CARRIER_FREQ0, 0x00,
198 VSB_CARRIER_FREQ1, 0x87,
199 VSB_CARRIER_FREQ2, 0x8e,
200 VSB_CARRIER_FREQ3, 0x01,
201 /* Change the TPCLK pin polarity
202 data is valid on falling clock */
204 /* Change the value of IFBW[11:0] of
205 AGC IF/RF loop filter bandwidth register */
206 AGC_RF_BANDWIDTH0, 0x40,
207 AGC_RF_BANDWIDTH1, 0x93,
208 AGC_RF_BANDWIDTH2, 0x00,
209 /* Change the value of bit 6, 'nINAGCBY' and
210 'NSSEL[1:0] of ACG function control register 2 */
211 AGC_FUNC_CTRL2, 0xc6,
212 /* Change the value of bit 6 'RFFIX'
213 of AGC function control register 3 */
214 AGC_FUNC_CTRL3, 0x40,
215 /* Set the value of 'INLVTHD' register 0x2a/0x2c
219 /* Change the value of IAGCBW[15:8]
220 of inner AGC loop filter bandwith */
221 AGC_LOOP_BANDWIDTH0, 0x08,
222 AGC_LOOP_BANDWIDTH1, 0x9a
225 static u8 lgdt3303_init_data[] = {
229 static u8 flip_lgdt3303_init_data[] = {
234 struct lgdt330x_state* state = fe->demodulator_priv;
238 switch (state->config->demod_chip) {
240 chip_name = "LGDT3302";
241 err = i2c_write_demod_bytes(state, lgdt3302_init_data,
242 sizeof(lgdt3302_init_data));
245 chip_name = "LGDT3303";
246 if (state->config->clock_polarity_flip) {
247 err = i2c_write_demod_bytes(state, flip_lgdt3303_init_data,
248 sizeof(flip_lgdt3303_init_data));
250 err = i2c_write_demod_bytes(state, lgdt3303_init_data,
251 sizeof(lgdt3303_init_data));
255 chip_name = "undefined";
256 printk (KERN_WARNING "Only LGDT3302 and LGDT3303 are supported chips.\n");
259 dprintk("%s entered as %s\n", __FUNCTION__, chip_name);
262 return lgdt330x_SwReset(state);
265 static int lgdt330x_read_ber(struct dvb_frontend* fe, u32* ber)
267 *ber = 0; /* Not supplied by the demod chips */
271 static int lgdt330x_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
273 struct lgdt330x_state* state = fe->demodulator_priv;
277 switch (state->config->demod_chip) {
279 err = i2c_read_demod_bytes(state, LGDT3302_PACKET_ERR_COUNTER1,
283 err = i2c_read_demod_bytes(state, LGDT3303_PACKET_ERR_COUNTER1,
288 "Only LGDT3302 and LGDT3303 are supported chips.\n");
292 *ucblocks = (buf[0] << 8) | buf[1];
296 static int lgdt330x_set_parameters(struct dvb_frontend* fe,
297 struct dvb_frontend_parameters *param)
300 * Array of byte pairs <address, value>
301 * to initialize 8VSB for lgdt3303 chip 50 MHz IF
303 static u8 lgdt3303_8vsb_44_data[] = {
312 * Array of byte pairs <address, value>
313 * to initialize QAM for lgdt3303 chip
315 static u8 lgdt3303_qam_data[] = {
328 struct lgdt330x_state* state = fe->demodulator_priv;
330 static u8 top_ctrl_cfg[] = { TOP_CONTROL, 0x03 };
333 /* Change only if we are actually changing the modulation */
334 if (state->current_modulation != param->u.vsb.modulation) {
335 switch(param->u.vsb.modulation) {
337 dprintk("%s: VSB_8 MODE\n", __FUNCTION__);
339 /* Select VSB mode */
340 top_ctrl_cfg[1] = 0x03;
342 /* Select ANT connector if supported by card */
343 if (state->config->pll_rf_set)
344 state->config->pll_rf_set(fe, 1);
346 if (state->config->demod_chip == LGDT3303) {
347 err = i2c_write_demod_bytes(state, lgdt3303_8vsb_44_data,
348 sizeof(lgdt3303_8vsb_44_data));
353 dprintk("%s: QAM_64 MODE\n", __FUNCTION__);
355 /* Select QAM_64 mode */
356 top_ctrl_cfg[1] = 0x00;
358 /* Select CABLE connector if supported by card */
359 if (state->config->pll_rf_set)
360 state->config->pll_rf_set(fe, 0);
362 if (state->config->demod_chip == LGDT3303) {
363 err = i2c_write_demod_bytes(state, lgdt3303_qam_data,
364 sizeof(lgdt3303_qam_data));
369 dprintk("%s: QAM_256 MODE\n", __FUNCTION__);
371 /* Select QAM_256 mode */
372 top_ctrl_cfg[1] = 0x01;
374 /* Select CABLE connector if supported by card */
375 if (state->config->pll_rf_set)
376 state->config->pll_rf_set(fe, 0);
378 if (state->config->demod_chip == LGDT3303) {
379 err = i2c_write_demod_bytes(state, lgdt3303_qam_data,
380 sizeof(lgdt3303_qam_data));
384 printk(KERN_WARNING "lgdt330x: %s: Modulation type(%d) UNSUPPORTED\n", __FUNCTION__, param->u.vsb.modulation);
388 * select serial or parallel MPEG harware interface
389 * Serial: 0x04 for LGDT3302 or 0x40 for LGDT3303
392 top_ctrl_cfg[1] |= state->config->serial_mpeg;
394 /* Select the requested mode */
395 i2c_write_demod_bytes(state, top_ctrl_cfg,
396 sizeof(top_ctrl_cfg));
397 if (state->config->set_ts_params)
398 state->config->set_ts_params(fe, 0);
399 state->current_modulation = param->u.vsb.modulation;
402 /* Tune to the specified frequency */
403 if (fe->ops->tuner_ops.set_params) {
404 fe->ops->tuner_ops.set_params(fe, param);
405 if (fe->ops->i2c_gate_ctrl) fe->ops->i2c_gate_ctrl(fe, 0);
408 /* Keep track of the new frequency */
409 /* FIXME this is the wrong way to do this... */
410 /* The tuner is shared with the video4linux analog API */
411 state->current_frequency = param->frequency;
413 lgdt330x_SwReset(state);
417 static int lgdt330x_get_frontend(struct dvb_frontend* fe,
418 struct dvb_frontend_parameters* param)
420 struct lgdt330x_state *state = fe->demodulator_priv;
421 param->frequency = state->current_frequency;
425 static int lgdt3302_read_status(struct dvb_frontend* fe, fe_status_t* status)
427 struct lgdt330x_state* state = fe->demodulator_priv;
430 *status = 0; /* Reset status result */
432 /* AGC status register */
433 i2c_read_demod_bytes(state, AGC_STATUS, buf, 1);
434 dprintk("%s: AGC_STATUS = 0x%02x\n", __FUNCTION__, buf[0]);
435 if ((buf[0] & 0x0c) == 0x8){
436 /* Test signal does not exist flag */
437 /* as well as the AGC lock flag. */
438 *status |= FE_HAS_SIGNAL;
440 /* Without a signal all other status bits are meaningless */
445 * You must set the Mask bits to 1 in the IRQ_MASK in order
446 * to see that status bit in the IRQ_STATUS register.
447 * This is done in SwReset();
450 i2c_read_demod_bytes(state, TOP_CONTROL, buf, sizeof(buf));
451 dprintk("%s: TOP_CONTROL = 0x%02x, IRO_MASK = 0x%02x, IRQ_STATUS = 0x%02x\n", __FUNCTION__, buf[0], buf[1], buf[2]);
455 if ((buf[2] & 0x03) == 0x01) {
456 *status |= FE_HAS_SYNC;
459 /* FEC error status */
460 if ((buf[2] & 0x0c) == 0x08) {
461 *status |= FE_HAS_LOCK;
462 *status |= FE_HAS_VITERBI;
465 /* Carrier Recovery Lock Status Register */
466 i2c_read_demod_bytes(state, CARRIER_LOCK, buf, 1);
467 dprintk("%s: CARRIER_LOCK = 0x%02x\n", __FUNCTION__, buf[0]);
468 switch (state->current_modulation) {
471 /* Need to undestand why there are 3 lock levels here */
472 if ((buf[0] & 0x07) == 0x07)
473 *status |= FE_HAS_CARRIER;
476 if ((buf[0] & 0x80) == 0x80)
477 *status |= FE_HAS_CARRIER;
480 printk("KERN_WARNING lgdt330x: %s: Modulation set to unsupported value\n", __FUNCTION__);
486 static int lgdt3303_read_status(struct dvb_frontend* fe, fe_status_t* status)
488 struct lgdt330x_state* state = fe->demodulator_priv;
492 *status = 0; /* Reset status result */
494 /* lgdt3303 AGC status register */
495 err = i2c_read_demod_bytes(state, 0x58, buf, 1);
499 dprintk("%s: AGC_STATUS = 0x%02x\n", __FUNCTION__, buf[0]);
500 if ((buf[0] & 0x21) == 0x01){
501 /* Test input signal does not exist flag */
502 /* as well as the AGC lock flag. */
503 *status |= FE_HAS_SIGNAL;
505 /* Without a signal all other status bits are meaningless */
509 /* Carrier Recovery Lock Status Register */
510 i2c_read_demod_bytes(state, CARRIER_LOCK, buf, 1);
511 dprintk("%s: CARRIER_LOCK = 0x%02x\n", __FUNCTION__, buf[0]);
512 switch (state->current_modulation) {
515 /* Need to undestand why there are 3 lock levels here */
516 if ((buf[0] & 0x07) == 0x07)
517 *status |= FE_HAS_CARRIER;
520 i2c_read_demod_bytes(state, 0x8a, buf, 1);
521 if ((buf[0] & 0x04) == 0x04)
522 *status |= FE_HAS_SYNC;
523 if ((buf[0] & 0x01) == 0x01)
524 *status |= FE_HAS_LOCK;
525 if ((buf[0] & 0x08) == 0x08)
526 *status |= FE_HAS_VITERBI;
529 if ((buf[0] & 0x80) == 0x80)
530 *status |= FE_HAS_CARRIER;
533 i2c_read_demod_bytes(state, 0x38, buf, 1);
534 if ((buf[0] & 0x02) == 0x00)
535 *status |= FE_HAS_SYNC;
536 if ((buf[0] & 0x01) == 0x01) {
537 *status |= FE_HAS_LOCK;
538 *status |= FE_HAS_VITERBI;
542 printk("KERN_WARNING lgdt330x: %s: Modulation set to unsupported value\n", __FUNCTION__);
547 static int lgdt330x_read_signal_strength(struct dvb_frontend* fe, u16* strength)
549 /* not directly available. */
554 static int lgdt3302_read_snr(struct dvb_frontend* fe, u16* snr)
558 * Spec sheet shows formula for SNR_EQ = 10 log10(25 * 24**2 / noise)
559 * and SNR_PH = 10 log10(25 * 32**2 / noise) for equalizer and phase tracker
560 * respectively. The following tables are built on these formulas.
561 * The usual definition is SNR = 20 log10(signal/noise)
562 * If the specification is wrong the value retuned is 1/2 the actual SNR in db.
564 * This table is a an ordered list of noise values computed by the
565 * formula from the spec sheet such that the index into the table
566 * starting at 43 or 45 is the SNR value in db. There are duplicate noise
567 * value entries at the beginning because the SNR varies more than
568 * 1 db for a change of 1 digit in noise at very small values of noise.
570 * Examples from SNR_EQ table:
588 static const u32 SNR_EQ[] =
589 { 1, 2, 2, 2, 3, 3, 4, 4, 5, 7,
590 9, 11, 13, 17, 21, 26, 33, 41, 52, 65,
591 81, 102, 129, 162, 204, 257, 323, 406, 511, 644,
592 810, 1020, 1284, 1616, 2035, 2561, 3224, 4059, 5110, 6433,
593 8098, 10195, 12835, 16158, 20341, 25608, 32238, 40585, 51094, 64323,
594 80978, 101945, 128341, 161571, 203406, 256073, 0x40000
597 static const u32 SNR_PH[] =
598 { 1, 2, 2, 2, 3, 3, 4, 5, 6, 8,
599 10, 12, 15, 19, 23, 29, 37, 46, 58, 73,
600 91, 115, 144, 182, 229, 288, 362, 456, 574, 722,
601 909, 1144, 1440, 1813, 2282, 2873, 3617, 4553, 5732, 7216,
602 9084, 11436, 14396, 18124, 22817, 28724, 36161, 45524, 57312, 72151,
603 90833, 114351, 143960, 181235, 228161, 0x080000
606 static u8 buf[5];/* read data buffer */
607 static u32 noise; /* noise value */
608 static u32 snr_db; /* index into SNR_EQ[] */
609 struct lgdt330x_state* state = (struct lgdt330x_state*) fe->demodulator_priv;
611 /* read both equalizer and phase tracker noise data */
612 i2c_read_demod_bytes(state, EQPH_ERR0, buf, sizeof(buf));
614 if (state->current_modulation == VSB_8) {
615 /* Equalizer Mean-Square Error Register for VSB */
616 noise = ((buf[0] & 7) << 16) | (buf[1] << 8) | buf[2];
619 * Look up noise value in table.
620 * A better search algorithm could be used...
621 * watch out there are duplicate entries.
623 for (snr_db = 0; snr_db < sizeof(SNR_EQ); snr_db++) {
624 if (noise < SNR_EQ[snr_db]) {
630 /* Phase Tracker Mean-Square Error Register for QAM */
631 noise = ((buf[0] & 7<<3) << 13) | (buf[3] << 8) | buf[4];
633 /* Look up noise value in table. */
634 for (snr_db = 0; snr_db < sizeof(SNR_PH); snr_db++) {
635 if (noise < SNR_PH[snr_db]) {
642 /* Return the raw noise value */
643 static u8 buf[5];/* read data buffer */
644 static u32 noise; /* noise value */
645 struct lgdt330x_state* state = (struct lgdt330x_state*) fe->demodulator_priv;
647 /* read both equalizer and pase tracker noise data */
648 i2c_read_demod_bytes(state, EQPH_ERR0, buf, sizeof(buf));
650 if (state->current_modulation == VSB_8) {
651 /* Phase Tracker Mean-Square Error Register for VSB */
652 noise = ((buf[0] & 7<<3) << 13) | (buf[3] << 8) | buf[4];
655 /* Carrier Recovery Mean-Square Error for QAM */
656 i2c_read_demod_bytes(state, 0x1a, buf, 2);
657 noise = ((buf[0] & 3) << 8) | buf[1];
660 /* Small values for noise mean signal is better so invert noise */
664 dprintk("%s: noise = 0x%05x, snr = %idb\n",__FUNCTION__, noise, *snr);
669 static int lgdt3303_read_snr(struct dvb_frontend* fe, u16* snr)
671 /* Return the raw noise value */
672 static u8 buf[5];/* read data buffer */
673 static u32 noise; /* noise value */
674 struct lgdt330x_state* state = (struct lgdt330x_state*) fe->demodulator_priv;
676 if (state->current_modulation == VSB_8) {
678 /* Phase Tracker Mean-Square Error Register for VSB */
679 noise = ((buf[0] & 7) << 16) | (buf[3] << 8) | buf[4];
682 /* Carrier Recovery Mean-Square Error for QAM */
683 i2c_read_demod_bytes(state, 0x1a, buf, 2);
684 noise = (buf[0] << 8) | buf[1];
687 /* Small values for noise mean signal is better so invert noise */
690 dprintk("%s: noise = 0x%05x, snr = %idb\n",__FUNCTION__, noise, *snr);
695 static int lgdt330x_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fe_tune_settings)
697 /* I have no idea about this - it may not be needed */
698 fe_tune_settings->min_delay_ms = 500;
699 fe_tune_settings->step_size = 0;
700 fe_tune_settings->max_drift = 0;
704 static void lgdt330x_release(struct dvb_frontend* fe)
706 struct lgdt330x_state* state = (struct lgdt330x_state*) fe->demodulator_priv;
710 static struct dvb_frontend_ops lgdt3302_ops;
711 static struct dvb_frontend_ops lgdt3303_ops;
713 struct dvb_frontend* lgdt330x_attach(const struct lgdt330x_config* config,
714 struct i2c_adapter* i2c)
716 struct lgdt330x_state* state = NULL;
719 /* Allocate memory for the internal state */
720 state = kzalloc(sizeof(struct lgdt330x_state), GFP_KERNEL);
724 /* Setup the state */
725 state->config = config;
727 switch (config->demod_chip) {
729 memcpy(&state->ops, &lgdt3302_ops, sizeof(struct dvb_frontend_ops));
732 memcpy(&state->ops, &lgdt3303_ops, sizeof(struct dvb_frontend_ops));
738 /* Verify communication with demod chip */
739 if (i2c_read_demod_bytes(state, 2, buf, 1))
742 state->current_frequency = -1;
743 state->current_modulation = -1;
745 /* Create dvb_frontend */
746 state->frontend.ops = &state->ops;
747 state->frontend.demodulator_priv = state;
748 return &state->frontend;
752 dprintk("%s: ERROR\n",__FUNCTION__);
756 static struct dvb_frontend_ops lgdt3302_ops = {
758 .name= "LG Electronics LGDT3302 VSB/QAM Frontend",
760 .frequency_min= 54000000,
761 .frequency_max= 858000000,
762 .frequency_stepsize= 62500,
763 .symbol_rate_min = 5056941, /* QAM 64 */
764 .symbol_rate_max = 10762000, /* VSB 8 */
765 .caps = FE_CAN_QAM_64 | FE_CAN_QAM_256 | FE_CAN_8VSB
767 .init = lgdt330x_init,
768 .set_frontend = lgdt330x_set_parameters,
769 .get_frontend = lgdt330x_get_frontend,
770 .get_tune_settings = lgdt330x_get_tune_settings,
771 .read_status = lgdt3302_read_status,
772 .read_ber = lgdt330x_read_ber,
773 .read_signal_strength = lgdt330x_read_signal_strength,
774 .read_snr = lgdt3302_read_snr,
775 .read_ucblocks = lgdt330x_read_ucblocks,
776 .release = lgdt330x_release,
779 static struct dvb_frontend_ops lgdt3303_ops = {
781 .name= "LG Electronics LGDT3303 VSB/QAM Frontend",
783 .frequency_min= 54000000,
784 .frequency_max= 858000000,
785 .frequency_stepsize= 62500,
786 .symbol_rate_min = 5056941, /* QAM 64 */
787 .symbol_rate_max = 10762000, /* VSB 8 */
788 .caps = FE_CAN_QAM_64 | FE_CAN_QAM_256 | FE_CAN_8VSB
790 .init = lgdt330x_init,
791 .set_frontend = lgdt330x_set_parameters,
792 .get_frontend = lgdt330x_get_frontend,
793 .get_tune_settings = lgdt330x_get_tune_settings,
794 .read_status = lgdt3303_read_status,
795 .read_ber = lgdt330x_read_ber,
796 .read_signal_strength = lgdt330x_read_signal_strength,
797 .read_snr = lgdt3303_read_snr,
798 .read_ucblocks = lgdt330x_read_ucblocks,
799 .release = lgdt330x_release,
802 MODULE_DESCRIPTION("LGDT330X (ATSC 8VSB & ITU-T J.83 AnnexB 64/256 QAM) Demodulator Driver");
803 MODULE_AUTHOR("Wilson Michaels");
804 MODULE_LICENSE("GPL");
806 EXPORT_SYMBOL(lgdt330x_attach);