2 Auvitek AU8522 QAM/8VSB demodulator driver
4 Copyright (C) 2008 Steven Toth <stoth@hauppauge.com>
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.
22 #include <linux/kernel.h>
23 #include <linux/init.h>
24 #include <linux/module.h>
25 #include <linux/string.h>
26 #include <linux/slab.h>
27 #include <linux/delay.h>
28 #include "dvb_frontend.h"
33 struct i2c_adapter *i2c;
35 /* configuration settings */
36 const struct au8522_config *config;
38 struct dvb_frontend frontend;
40 u32 current_frequency;
41 fe_modulation_t current_modulation;
47 #define dprintk(arg...) do { \
52 /* 16 bit registers, 8 bit values */
53 static int au8522_writereg(struct au8522_state *state, u16 reg, u8 data)
56 u8 buf [] = { reg >> 8, reg & 0xff, data };
58 struct i2c_msg msg = { .addr = state->config->demod_address,
59 .flags = 0, .buf = buf, .len = 3 };
61 ret = i2c_transfer(state->i2c, &msg, 1);
64 printk("%s: writereg error (reg == 0x%02x, val == 0x%04x, "
65 "ret == %i)\n", __func__, reg, data, ret);
67 return (ret != 1) ? -1 : 0;
70 static u8 au8522_readreg(struct au8522_state *state, u16 reg)
73 u8 b0 [] = { reg >> 8, reg & 0xff };
76 struct i2c_msg msg [] = {
77 { .addr = state->config->demod_address, .flags = 0,
78 .buf = b0, .len = 2 },
79 { .addr = state->config->demod_address, .flags = I2C_M_RD,
80 .buf = b1, .len = 1 } };
82 ret = i2c_transfer(state->i2c, msg, 2);
85 printk(KERN_ERR "%s: readreg error (ret == %i)\n",
90 static int au8522_i2c_gate_ctrl(struct dvb_frontend *fe, int enable)
92 struct au8522_state *state = fe->demodulator_priv;
94 dprintk("%s(%d)\n", __func__, enable);
97 return au8522_writereg(state, 0x106, 1);
99 return au8522_writereg(state, 0x106, 0);
107 /* VSB SNR lookup table */
108 static struct mse2snr_tab vsb_mse2snr_tab[] = {
141 /* QAM64 SNR lookup table */
142 static struct mse2snr_tab qam64_mse2snr_tab[] = {
222 /* QAM256 SNR lookup table */
223 static struct mse2snr_tab qam256_mse2snr_tab[] = {
290 static int au8522_mse2snr_lookup(struct mse2snr_tab *tab, int sz, int mse,
293 int i, ret = -EINVAL;
294 dprintk("%s()\n", __func__);
296 for (i = 0; i < sz; i++) {
297 if (mse < tab[i].val) {
303 dprintk("%s() snr=%d\n", __func__, *snr);
307 /* VSB Modulation table */
344 /* QAM Modulation table */
426 static int au8522_enable_modulation(struct dvb_frontend *fe,
429 struct au8522_state *state = fe->demodulator_priv;
432 dprintk("%s(0x%08x)\n", __func__, m);
436 dprintk("%s() VSB_8\n", __func__);
437 for (i = 0; i < ARRAY_SIZE(VSB_mod_tab); i++)
438 au8522_writereg(state,
440 VSB_mod_tab[i].data);
444 dprintk("%s() QAM 64/256\n", __func__);
445 for (i = 0; i < ARRAY_SIZE(QAM_mod_tab); i++)
446 au8522_writereg(state,
448 QAM_mod_tab[i].data);
451 dprintk("%s() Invalid modulation\n", __func__);
455 state->current_modulation = m;
460 /* Talk to the demod, set the FEC, GUARD, QAM settings etc */
461 static int au8522_set_frontend(struct dvb_frontend *fe,
462 struct dvb_frontend_parameters *p)
464 struct au8522_state *state = fe->demodulator_priv;
467 dprintk("%s(frequency=%d)\n", __func__, p->frequency);
469 if ((state->current_frequency == p->frequency) &&
470 (state->current_modulation == p->u.vsb.modulation))
473 au8522_enable_modulation(fe, p->u.vsb.modulation);
475 /* Allow the demod to settle */
478 if (fe->ops.tuner_ops.set_params) {
479 if (fe->ops.i2c_gate_ctrl)
480 fe->ops.i2c_gate_ctrl(fe, 1);
481 ret = fe->ops.tuner_ops.set_params(fe, p);
482 if (fe->ops.i2c_gate_ctrl)
483 fe->ops.i2c_gate_ctrl(fe, 0);
489 state->current_frequency = p->frequency;
494 /* Reset the demod hardware and reset all of the configuration registers
495 to a default state. */
496 static int au8522_init(struct dvb_frontend *fe)
498 struct au8522_state *state = fe->demodulator_priv;
499 dprintk("%s()\n", __func__);
501 au8522_writereg(state, 0xa4, 1 << 5);
503 au8522_i2c_gate_ctrl(fe, 1);
508 static int au8522_sleep(struct dvb_frontend *fe)
510 struct au8522_state *state = fe->demodulator_priv;
511 dprintk("%s()\n", __func__);
513 state->current_frequency = 0;
518 static int au8522_read_status(struct dvb_frontend *fe, fe_status_t *status)
520 struct au8522_state *state = fe->demodulator_priv;
522 u32 tuner_status = 0;
526 if (state->current_modulation == VSB_8) {
527 dprintk("%s() Checking VSB_8\n", __func__);
528 reg = au8522_readreg(state, 0x4088);
529 if ((reg & 0x03) == 0x03)
530 *status |= FE_HAS_LOCK | FE_HAS_SYNC | FE_HAS_VITERBI;
532 dprintk("%s() Checking QAM\n", __func__);
533 reg = au8522_readreg(state, 0x4541);
535 *status |= FE_HAS_VITERBI;
537 *status |= FE_HAS_LOCK | FE_HAS_SYNC;
540 switch (state->config->status_mode) {
541 case AU8522_DEMODLOCKING:
542 dprintk("%s() DEMODLOCKING\n", __func__);
543 if (*status & FE_HAS_VITERBI)
544 *status |= FE_HAS_CARRIER | FE_HAS_SIGNAL;
546 case AU8522_TUNERLOCKING:
547 /* Get the tuner status */
548 dprintk("%s() TUNERLOCKING\n", __func__);
549 if (fe->ops.tuner_ops.get_status) {
550 if (fe->ops.i2c_gate_ctrl)
551 fe->ops.i2c_gate_ctrl(fe, 1);
553 fe->ops.tuner_ops.get_status(fe, &tuner_status);
555 if (fe->ops.i2c_gate_ctrl)
556 fe->ops.i2c_gate_ctrl(fe, 0);
559 *status |= FE_HAS_CARRIER | FE_HAS_SIGNAL;
563 dprintk("%s() status 0x%08x\n", __func__, *status);
568 static int au8522_read_snr(struct dvb_frontend *fe, u16 *snr)
570 struct au8522_state *state = fe->demodulator_priv;
573 dprintk("%s()\n", __func__);
575 if (state->current_modulation == QAM_256)
576 ret = au8522_mse2snr_lookup(qam256_mse2snr_tab,
577 ARRAY_SIZE(qam256_mse2snr_tab),
578 au8522_readreg(state, 0x4522),
580 else if (state->current_modulation == QAM_64)
581 ret = au8522_mse2snr_lookup(qam64_mse2snr_tab,
582 ARRAY_SIZE(qam64_mse2snr_tab),
583 au8522_readreg(state, 0x4522),
586 ret = au8522_mse2snr_lookup(vsb_mse2snr_tab,
587 ARRAY_SIZE(vsb_mse2snr_tab),
588 au8522_readreg(state, 0x4311),
594 static int au8522_read_signal_strength(struct dvb_frontend *fe,
595 u16 *signal_strength)
597 return au8522_read_snr(fe, signal_strength);
600 static int au8522_read_ucblocks(struct dvb_frontend *fe, u32 *ucblocks)
602 struct au8522_state *state = fe->demodulator_priv;
604 if (state->current_modulation == VSB_8)
605 *ucblocks = au8522_readreg(state, 0x4087);
607 *ucblocks = au8522_readreg(state, 0x4543);
612 static int au8522_read_ber(struct dvb_frontend *fe, u32 *ber)
614 return au8522_read_ucblocks(fe, ber);
617 static int au8522_get_frontend(struct dvb_frontend *fe,
618 struct dvb_frontend_parameters *p)
620 struct au8522_state *state = fe->demodulator_priv;
622 p->frequency = state->current_frequency;
623 p->u.vsb.modulation = state->current_modulation;
628 static int au8522_get_tune_settings(struct dvb_frontend *fe,
629 struct dvb_frontend_tune_settings *tune)
631 tune->min_delay_ms = 1000;
635 static void au8522_release(struct dvb_frontend *fe)
637 struct au8522_state *state = fe->demodulator_priv;
641 static struct dvb_frontend_ops au8522_ops;
643 struct dvb_frontend *au8522_attach(const struct au8522_config *config,
644 struct i2c_adapter *i2c)
646 struct au8522_state *state = NULL;
648 /* allocate memory for the internal state */
649 state = kmalloc(sizeof(struct au8522_state), GFP_KERNEL);
653 /* setup the state */
654 state->config = config;
656 /* create dvb_frontend */
657 memcpy(&state->frontend.ops, &au8522_ops,
658 sizeof(struct dvb_frontend_ops));
659 state->frontend.demodulator_priv = state;
661 if (au8522_init(&state->frontend) != 0) {
662 printk(KERN_ERR "%s: Failed to initialize correctly\n",
667 /* Note: Leaving the I2C gate open here. */
668 au8522_i2c_gate_ctrl(&state->frontend, 1);
670 return &state->frontend;
676 EXPORT_SYMBOL(au8522_attach);
678 static struct dvb_frontend_ops au8522_ops = {
681 .name = "Auvitek AU8522 QAM/8VSB Frontend",
683 .frequency_min = 54000000,
684 .frequency_max = 858000000,
685 .frequency_stepsize = 62500,
686 .caps = FE_CAN_QAM_64 | FE_CAN_QAM_256 | FE_CAN_8VSB
690 .sleep = au8522_sleep,
691 .i2c_gate_ctrl = au8522_i2c_gate_ctrl,
692 .set_frontend = au8522_set_frontend,
693 .get_frontend = au8522_get_frontend,
694 .get_tune_settings = au8522_get_tune_settings,
695 .read_status = au8522_read_status,
696 .read_ber = au8522_read_ber,
697 .read_signal_strength = au8522_read_signal_strength,
698 .read_snr = au8522_read_snr,
699 .read_ucblocks = au8522_read_ucblocks,
700 .release = au8522_release,
703 module_param(debug, int, 0644);
704 MODULE_PARM_DESC(debug, "Enable verbose debug messages");
706 MODULE_DESCRIPTION("Auvitek AU8522 QAM-B/ATSC Demodulator driver");
707 MODULE_AUTHOR("Steven Toth");
708 MODULE_LICENSE("GPL");