2 Driver for Zarlink VP310/MT312 Satellite Channel Decoder
4 Copyright (C) 2003 Andreas Oberritter <obi@linuxtv.org>
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 http://products.zarlink.com/product_profiles/MT312.htm
23 http://products.zarlink.com/product_profiles/SL1935.htm
26 #include <linux/delay.h>
27 #include <linux/errno.h>
28 #include <linux/init.h>
29 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/string.h>
32 #include <linux/slab.h>
34 #include "dvb_frontend.h"
35 #include "mt312_priv.h"
40 struct i2c_adapter* i2c;
41 /* configuration settings */
42 const struct mt312_config* config;
43 struct dvb_frontend frontend;
50 #define dprintk(args...) \
52 if (debug) printk(KERN_DEBUG "mt312: " args); \
55 #define MT312_SYS_CLK 90000000UL /* 90 MHz */
56 #define MT312_LPOWER_SYS_CLK 60000000UL /* 60 MHz */
57 #define MT312_PLL_CLK 10000000UL /* 10 MHz */
59 static int mt312_read(struct mt312_state* state, const enum mt312_reg_addr reg,
60 void *buf, const size_t count)
63 struct i2c_msg msg[2];
64 u8 regbuf[1] = { reg };
66 msg[0].addr = state->config->demod_address;
70 msg[1].addr = state->config->demod_address;
71 msg[1].flags = I2C_M_RD;
75 ret = i2c_transfer(state->i2c, msg, 2);
78 printk(KERN_ERR "%s: ret == %d\n", __FUNCTION__, ret);
84 dprintk("R(%d):", reg & 0x7f);
85 for (i = 0; i < count; i++)
86 printk(" %02x", ((const u8 *) buf)[i]);
93 static int mt312_write(struct mt312_state* state, const enum mt312_reg_addr reg,
94 const void *src, const size_t count)
102 dprintk("W(%d):", reg & 0x7f);
103 for (i = 0; i < count; i++)
104 printk(" %02x", ((const u8 *) src)[i]);
109 memcpy(&buf[1], src, count);
111 msg.addr = state->config->demod_address;
116 ret = i2c_transfer(state->i2c, &msg, 1);
119 dprintk("%s: ret == %d\n", __FUNCTION__, ret);
126 static inline int mt312_readreg(struct mt312_state* state,
127 const enum mt312_reg_addr reg, u8 *val)
129 return mt312_read(state, reg, val, 1);
132 static inline int mt312_writereg(struct mt312_state* state,
133 const enum mt312_reg_addr reg, const u8 val)
135 return mt312_write(state, reg, &val, 1);
138 static inline u32 mt312_div(u32 a, u32 b)
140 return (a + (b / 2)) / b;
143 static int mt312_reset(struct mt312_state* state, const u8 full)
145 return mt312_writereg(state, RESET, full ? 0x80 : 0x40);
148 static int mt312_get_inversion(struct mt312_state* state,
149 fe_spectral_inversion_t *i)
154 if ((ret = mt312_readreg(state, VIT_MODE, &vit_mode)) < 0)
157 if (vit_mode & 0x80) /* auto inversion was used */
158 *i = (vit_mode & 0x40) ? INVERSION_ON : INVERSION_OFF;
163 static int mt312_get_symbol_rate(struct mt312_state* state, u32 *sr)
172 if ((ret = mt312_readreg(state, SYM_RATE_H, &sym_rate_h)) < 0)
175 if (sym_rate_h & 0x80) { /* symbol rate search was used */
176 if ((ret = mt312_writereg(state, MON_CTRL, 0x03)) < 0)
179 if ((ret = mt312_read(state, MONITOR_H, buf, sizeof(buf))) < 0)
182 monitor = (buf[0] << 8) | buf[1];
184 dprintk(KERN_DEBUG "sr(auto) = %u\n",
185 mt312_div(monitor * 15625, 4));
187 if ((ret = mt312_writereg(state, MON_CTRL, 0x05)) < 0)
190 if ((ret = mt312_read(state, MONITOR_H, buf, sizeof(buf))) < 0)
193 dec_ratio = ((buf[0] >> 5) & 0x07) * 32;
195 if ((ret = mt312_read(state, SYM_RAT_OP_H, buf, sizeof(buf))) < 0)
198 sym_rat_op = (buf[0] << 8) | buf[1];
200 dprintk(KERN_DEBUG "sym_rat_op=%d dec_ratio=%d\n",
201 sym_rat_op, dec_ratio);
202 dprintk(KERN_DEBUG "*sr(manual) = %lu\n",
203 (((MT312_PLL_CLK * 8192) / (sym_rat_op + 8192)) *
210 static int mt312_get_code_rate(struct mt312_state* state, fe_code_rate_t *cr)
212 const fe_code_rate_t fec_tab[8] =
213 { FEC_1_2, FEC_2_3, FEC_3_4, FEC_5_6, FEC_6_7, FEC_7_8,
214 FEC_AUTO, FEC_AUTO };
219 if ((ret = mt312_readreg(state, FEC_STATUS, &fec_status)) < 0)
222 *cr = fec_tab[(fec_status >> 4) & 0x07];
227 static int mt312_initfe(struct dvb_frontend* fe)
229 struct mt312_state *state = fe->demodulator_priv;
234 if ((ret = mt312_writereg(state, CONFIG, (state->frequency == 60 ? 0x88 : 0x8c))) < 0)
237 /* wait at least 150 usec */
241 if ((ret = mt312_reset(state, 1)) < 0)
244 // Per datasheet, write correct values. 09/28/03 ACCJr.
245 // If we don't do this, we won't get FE_HAS_VITERBI in the VP310.
247 u8 buf_def[8]={0x14, 0x12, 0x03, 0x02, 0x01, 0x00, 0x00, 0x00};
249 if ((ret = mt312_write(state, VIT_SETUP, buf_def, sizeof(buf_def))) < 0)
254 buf[0] = mt312_div((state->frequency == 60 ? MT312_LPOWER_SYS_CLK : MT312_SYS_CLK) * 2, 1000000);
257 buf[1] = mt312_div(MT312_PLL_CLK, 15000 * 4);
259 if ((ret = mt312_write(state, SYS_CLK, buf, sizeof(buf))) < 0)
262 if ((ret = mt312_writereg(state, SNR_THS_HIGH, 0x32)) < 0)
265 if ((ret = mt312_writereg(state, OP_CTRL, 0x53)) < 0)
272 if ((ret = mt312_write(state, TS_SW_LIM_L, buf, sizeof(buf))) < 0)
275 if ((ret = mt312_writereg(state, CS_SW_LIM, 0x69)) < 0)
281 static int mt312_send_master_cmd(struct dvb_frontend* fe,
282 struct dvb_diseqc_master_cmd *c)
284 struct mt312_state *state = fe->demodulator_priv;
288 if ((c->msg_len == 0) || (c->msg_len > sizeof(c->msg)))
291 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
295 mt312_write(state, (0x80 | DISEQC_INSTR), c->msg, c->msg_len)) < 0)
299 mt312_writereg(state, DISEQC_MODE,
300 (diseqc_mode & 0x40) | ((c->msg_len - 1) << 3)
304 /* set DISEQC_MODE[2:0] to zero if a return message is expected */
305 if (c->msg[0] & 0x02)
307 mt312_writereg(state, DISEQC_MODE, (diseqc_mode & 0x40))) < 0)
313 static int mt312_send_burst(struct dvb_frontend* fe, const fe_sec_mini_cmd_t c)
315 struct mt312_state *state = fe->demodulator_priv;
316 const u8 mini_tab[2] = { 0x02, 0x03 };
324 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
328 mt312_writereg(state, DISEQC_MODE,
329 (diseqc_mode & 0x40) | mini_tab[c])) < 0)
335 static int mt312_set_tone(struct dvb_frontend* fe, const fe_sec_tone_mode_t t)
337 struct mt312_state *state = fe->demodulator_priv;
338 const u8 tone_tab[2] = { 0x01, 0x00 };
343 if (t > SEC_TONE_OFF)
346 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
350 mt312_writereg(state, DISEQC_MODE,
351 (diseqc_mode & 0x40) | tone_tab[t])) < 0)
357 static int mt312_set_voltage(struct dvb_frontend* fe, const fe_sec_voltage_t v)
359 struct mt312_state *state = fe->demodulator_priv;
360 const u8 volt_tab[3] = { 0x00, 0x40, 0x00 };
362 if (v > SEC_VOLTAGE_OFF)
365 return mt312_writereg(state, DISEQC_MODE, volt_tab[v]);
368 static int mt312_read_status(struct dvb_frontend* fe, fe_status_t *s)
370 struct mt312_state *state = fe->demodulator_priv;
376 if ((ret = mt312_read(state, QPSK_STAT_H, status, sizeof(status))) < 0)
379 dprintk(KERN_DEBUG "QPSK_STAT_H: 0x%02x, QPSK_STAT_L: 0x%02x, FEC_STATUS: 0x%02x\n", status[0], status[1], status[2]);
381 if (status[0] & 0xc0)
382 *s |= FE_HAS_SIGNAL; /* signal noise ratio */
383 if (status[0] & 0x04)
384 *s |= FE_HAS_CARRIER; /* qpsk carrier lock */
385 if (status[2] & 0x02)
386 *s |= FE_HAS_VITERBI; /* viterbi lock */
387 if (status[2] & 0x04)
388 *s |= FE_HAS_SYNC; /* byte align lock */
389 if (status[0] & 0x01)
390 *s |= FE_HAS_LOCK; /* qpsk lock */
395 static int mt312_read_ber(struct dvb_frontend* fe, u32 *ber)
397 struct mt312_state *state = fe->demodulator_priv;
401 if ((ret = mt312_read(state, RS_BERCNT_H, buf, 3)) < 0)
404 *ber = ((buf[0] << 16) | (buf[1] << 8) | buf[2]) * 64;
409 static int mt312_read_signal_strength(struct dvb_frontend* fe, u16 *signal_strength)
411 struct mt312_state *state = fe->demodulator_priv;
417 if ((ret = mt312_read(state, AGC_H, buf, sizeof(buf))) < 0)
420 agc = (buf[0] << 6) | (buf[1] >> 2);
421 err_db = (s16) (((buf[1] & 0x03) << 14) | buf[2] << 6) >> 6;
423 *signal_strength = agc;
425 dprintk(KERN_DEBUG "agc=%08x err_db=%hd\n", agc, err_db);
430 static int mt312_read_snr(struct dvb_frontend* fe, u16 *snr)
432 struct mt312_state *state = fe->demodulator_priv;
436 if ((ret = mt312_read(state, M_SNR_H, &buf, sizeof(buf))) < 0)
439 *snr = 0xFFFF - ((((buf[0] & 0x7f) << 8) | buf[1]) << 1);
444 static int mt312_read_ucblocks(struct dvb_frontend* fe, u32 *ubc)
446 struct mt312_state *state = fe->demodulator_priv;
450 if ((ret = mt312_read(state, RS_UBC_H, &buf, sizeof(buf))) < 0)
453 *ubc = (buf[0] << 8) | buf[1];
458 static int mt312_set_frontend(struct dvb_frontend* fe,
459 struct dvb_frontend_parameters *p)
461 struct mt312_state *state = fe->demodulator_priv;
463 u8 buf[5], config_val;
466 const u8 fec_tab[10] =
467 { 0x00, 0x01, 0x02, 0x04, 0x3f, 0x08, 0x10, 0x20, 0x3f, 0x3f };
468 const u8 inv_tab[3] = { 0x00, 0x40, 0x80 };
470 dprintk("%s: Freq %d\n", __FUNCTION__, p->frequency);
472 if ((p->frequency < fe->ops.info.frequency_min)
473 || (p->frequency > fe->ops.info.frequency_max))
476 if ((p->inversion < INVERSION_OFF)
477 || (p->inversion > INVERSION_ON))
480 if ((p->u.qpsk.symbol_rate < fe->ops.info.symbol_rate_min)
481 || (p->u.qpsk.symbol_rate > fe->ops.info.symbol_rate_max))
484 if ((p->u.qpsk.fec_inner < FEC_NONE)
485 || (p->u.qpsk.fec_inner > FEC_AUTO))
488 if ((p->u.qpsk.fec_inner == FEC_4_5)
489 || (p->u.qpsk.fec_inner == FEC_8_9))
494 // For now we will do this only for the VP310.
495 // It should be better for the mt312 as well, but tunning will be slower. ACCJr 09/29/03
496 ret = mt312_readreg(state, CONFIG, &config_val);
499 if (p->u.qpsk.symbol_rate >= 30000000) //Note that 30MS/s should use 90MHz
501 if ((config_val & 0x0c) == 0x08) { //We are running 60MHz
502 state->frequency = 90;
503 if ((ret = mt312_initfe(fe)) < 0)
509 if ((config_val & 0x0c) == 0x0C) { //We are running 90MHz
510 state->frequency = 60;
511 if ((ret = mt312_initfe(fe)) < 0)
524 if (fe->ops.tuner_ops.set_params) {
525 fe->ops.tuner_ops.set_params(fe, p);
526 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
529 /* sr = (u16)(sr * 256.0 / 1000000.0) */
530 sr = mt312_div(p->u.qpsk.symbol_rate * 4, 15625);
533 buf[0] = (sr >> 8) & 0x3f;
534 buf[1] = (sr >> 0) & 0xff;
537 buf[2] = inv_tab[p->inversion] | fec_tab[p->u.qpsk.fec_inner];
540 buf[3] = 0x40; /* swap I and Q before QPSK demodulation */
542 if (p->u.qpsk.symbol_rate < 10000000)
543 buf[3] |= 0x04; /* use afc mode */
548 if ((ret = mt312_write(state, SYM_RATE_H, buf, sizeof(buf))) < 0)
551 mt312_reset(state, 0);
556 static int mt312_get_frontend(struct dvb_frontend* fe,
557 struct dvb_frontend_parameters *p)
559 struct mt312_state *state = fe->demodulator_priv;
562 if ((ret = mt312_get_inversion(state, &p->inversion)) < 0)
565 if ((ret = mt312_get_symbol_rate(state, &p->u.qpsk.symbol_rate)) < 0)
568 if ((ret = mt312_get_code_rate(state, &p->u.qpsk.fec_inner)) < 0)
574 static int mt312_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
576 struct mt312_state* state = fe->demodulator_priv;
579 return mt312_writereg(state, GPP_CTRL, 0x40);
581 return mt312_writereg(state, GPP_CTRL, 0x00);
585 static int mt312_sleep(struct dvb_frontend* fe)
587 struct mt312_state *state = fe->demodulator_priv;
591 /* reset all registers to defaults */
592 if ((ret = mt312_reset(state, 1)) < 0)
595 if ((ret = mt312_readreg(state, CONFIG, &config)) < 0)
599 if ((ret = mt312_writereg(state, CONFIG, config & 0x7f)) < 0)
605 static int mt312_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
607 fesettings->min_delay_ms = 50;
608 fesettings->step_size = 0;
609 fesettings->max_drift = 0;
613 static void mt312_release(struct dvb_frontend* fe)
615 struct mt312_state* state = fe->demodulator_priv;
619 static struct dvb_frontend_ops vp310_mt312_ops = {
622 .name = "Zarlink ???? DVB-S",
624 .frequency_min = 950000,
625 .frequency_max = 2150000,
626 .frequency_stepsize = (MT312_PLL_CLK / 1000) / 128,
627 .symbol_rate_min = MT312_SYS_CLK / 128,
628 .symbol_rate_max = MT312_SYS_CLK / 2,
630 FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 |
631 FE_CAN_FEC_3_4 | FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
632 FE_CAN_FEC_AUTO | FE_CAN_QPSK | FE_CAN_MUTE_TS |
636 .release = mt312_release,
638 .init = mt312_initfe,
639 .sleep = mt312_sleep,
640 .i2c_gate_ctrl = mt312_i2c_gate_ctrl,
642 .set_frontend = mt312_set_frontend,
643 .get_frontend = mt312_get_frontend,
644 .get_tune_settings = mt312_get_tune_settings,
646 .read_status = mt312_read_status,
647 .read_ber = mt312_read_ber,
648 .read_signal_strength = mt312_read_signal_strength,
649 .read_snr = mt312_read_snr,
650 .read_ucblocks = mt312_read_ucblocks,
652 .diseqc_send_master_cmd = mt312_send_master_cmd,
653 .diseqc_send_burst = mt312_send_burst,
654 .set_tone = mt312_set_tone,
655 .set_voltage = mt312_set_voltage,
658 struct dvb_frontend* vp310_mt312_attach(const struct mt312_config* config,
659 struct i2c_adapter* i2c)
661 struct mt312_state* state = NULL;
663 /* allocate memory for the internal state */
664 state = kmalloc(sizeof(struct mt312_state), GFP_KERNEL);
668 /* setup the state */
669 state->config = config;
672 /* check if the demod is there */
673 if (mt312_readreg(state, ID, &state->id) < 0)
676 /* create dvb_frontend */
677 memcpy(&state->frontend.ops, &vp310_mt312_ops, sizeof(struct dvb_frontend_ops));
678 state->frontend.demodulator_priv = state;
682 strcpy(state->frontend.ops.info.name, "Zarlink VP310 DVB-S");
683 state->frequency = 90;
686 strcpy(state->frontend.ops.info.name, "Zarlink MT312 DVB-S");
687 state->frequency = 60;
690 printk (KERN_WARNING "Only Zarlink VP310/MT312 are supported chips.\n");
694 return &state->frontend;
701 module_param(debug, int, 0644);
702 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
704 MODULE_DESCRIPTION("Zarlink VP310/MT312 DVB-S Demodulator driver");
705 MODULE_AUTHOR("Andreas Oberritter <obi@linuxtv.org>");
706 MODULE_LICENSE("GPL");
708 EXPORT_SYMBOL(vp310_mt312_attach);