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/moduleparam.h>
32 #include <linux/string.h>
33 #include <linux/slab.h>
35 #include "dvb_frontend.h"
36 #include "mt312_priv.h"
41 struct i2c_adapter* i2c;
42 /* configuration settings */
43 const struct mt312_config* config;
44 struct dvb_frontend frontend;
51 #define dprintk(args...) \
53 if (debug) printk(KERN_DEBUG "mt312: " args); \
56 #define MT312_SYS_CLK 90000000UL /* 90 MHz */
57 #define MT312_LPOWER_SYS_CLK 60000000UL /* 60 MHz */
58 #define MT312_PLL_CLK 10000000UL /* 10 MHz */
60 static int mt312_read(struct mt312_state* state, const enum mt312_reg_addr reg,
61 void *buf, const size_t count)
64 struct i2c_msg msg[2];
65 u8 regbuf[1] = { reg };
67 msg[0].addr = state->config->demod_address;
71 msg[1].addr = state->config->demod_address;
72 msg[1].flags = I2C_M_RD;
76 ret = i2c_transfer(state->i2c, msg, 2);
79 printk(KERN_ERR "%s: ret == %d\n", __FUNCTION__, ret);
85 dprintk("R(%d):", reg & 0x7f);
86 for (i = 0; i < count; i++)
87 printk(" %02x", ((const u8 *) buf)[i]);
94 static int mt312_write(struct mt312_state* state, const enum mt312_reg_addr reg,
95 const void *src, const size_t count)
103 dprintk("W(%d):", reg & 0x7f);
104 for (i = 0; i < count; i++)
105 printk(" %02x", ((const u8 *) src)[i]);
110 memcpy(&buf[1], src, count);
112 msg.addr = state->config->demod_address;
117 ret = i2c_transfer(state->i2c, &msg, 1);
120 dprintk("%s: ret == %d\n", __FUNCTION__, ret);
127 static inline int mt312_readreg(struct mt312_state* state,
128 const enum mt312_reg_addr reg, u8 *val)
130 return mt312_read(state, reg, val, 1);
133 static inline int mt312_writereg(struct mt312_state* state,
134 const enum mt312_reg_addr reg, const u8 val)
136 return mt312_write(state, reg, &val, 1);
139 static inline u32 mt312_div(u32 a, u32 b)
141 return (a + (b / 2)) / b;
144 static int mt312_reset(struct mt312_state* state, const u8 full)
146 return mt312_writereg(state, RESET, full ? 0x80 : 0x40);
149 static int mt312_get_inversion(struct mt312_state* state,
150 fe_spectral_inversion_t *i)
155 if ((ret = mt312_readreg(state, VIT_MODE, &vit_mode)) < 0)
158 if (vit_mode & 0x80) /* auto inversion was used */
159 *i = (vit_mode & 0x40) ? INVERSION_ON : INVERSION_OFF;
164 static int mt312_get_symbol_rate(struct mt312_state* state, u32 *sr)
173 if ((ret = mt312_readreg(state, SYM_RATE_H, &sym_rate_h)) < 0)
176 if (sym_rate_h & 0x80) { /* symbol rate search was used */
177 if ((ret = mt312_writereg(state, MON_CTRL, 0x03)) < 0)
180 if ((ret = mt312_read(state, MONITOR_H, buf, sizeof(buf))) < 0)
183 monitor = (buf[0] << 8) | buf[1];
185 dprintk(KERN_DEBUG "sr(auto) = %u\n",
186 mt312_div(monitor * 15625, 4));
188 if ((ret = mt312_writereg(state, MON_CTRL, 0x05)) < 0)
191 if ((ret = mt312_read(state, MONITOR_H, buf, sizeof(buf))) < 0)
194 dec_ratio = ((buf[0] >> 5) & 0x07) * 32;
196 if ((ret = mt312_read(state, SYM_RAT_OP_H, buf, sizeof(buf))) < 0)
199 sym_rat_op = (buf[0] << 8) | buf[1];
201 dprintk(KERN_DEBUG "sym_rat_op=%d dec_ratio=%d\n",
202 sym_rat_op, dec_ratio);
203 dprintk(KERN_DEBUG "*sr(manual) = %lu\n",
204 (((MT312_PLL_CLK * 8192) / (sym_rat_op + 8192)) *
211 static int mt312_get_code_rate(struct mt312_state* state, fe_code_rate_t *cr)
213 const fe_code_rate_t fec_tab[8] =
214 { FEC_1_2, FEC_2_3, FEC_3_4, FEC_5_6, FEC_6_7, FEC_7_8,
215 FEC_AUTO, FEC_AUTO };
220 if ((ret = mt312_readreg(state, FEC_STATUS, &fec_status)) < 0)
223 *cr = fec_tab[(fec_status >> 4) & 0x07];
228 static int mt312_initfe(struct dvb_frontend* fe)
230 struct mt312_state *state = fe->demodulator_priv;
235 if ((ret = mt312_writereg(state, CONFIG, (state->frequency == 60 ? 0x88 : 0x8c))) < 0)
238 /* wait at least 150 usec */
242 if ((ret = mt312_reset(state, 1)) < 0)
245 // Per datasheet, write correct values. 09/28/03 ACCJr.
246 // If we don't do this, we won't get FE_HAS_VITERBI in the VP310.
248 u8 buf_def[8]={0x14, 0x12, 0x03, 0x02, 0x01, 0x00, 0x00, 0x00};
250 if ((ret = mt312_write(state, VIT_SETUP, buf_def, sizeof(buf_def))) < 0)
255 buf[0] = mt312_div((state->frequency == 60 ? MT312_LPOWER_SYS_CLK : MT312_SYS_CLK) * 2, 1000000);
258 buf[1] = mt312_div(MT312_PLL_CLK, 15000 * 4);
260 if ((ret = mt312_write(state, SYS_CLK, buf, sizeof(buf))) < 0)
263 if ((ret = mt312_writereg(state, SNR_THS_HIGH, 0x32)) < 0)
266 if ((ret = mt312_writereg(state, OP_CTRL, 0x53)) < 0)
273 if ((ret = mt312_write(state, TS_SW_LIM_L, buf, sizeof(buf))) < 0)
276 if ((ret = mt312_writereg(state, CS_SW_LIM, 0x69)) < 0)
282 static int mt312_send_master_cmd(struct dvb_frontend* fe,
283 struct dvb_diseqc_master_cmd *c)
285 struct mt312_state *state = fe->demodulator_priv;
289 if ((c->msg_len == 0) || (c->msg_len > sizeof(c->msg)))
292 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
296 mt312_write(state, (0x80 | DISEQC_INSTR), c->msg, c->msg_len)) < 0)
300 mt312_writereg(state, DISEQC_MODE,
301 (diseqc_mode & 0x40) | ((c->msg_len - 1) << 3)
305 /* set DISEQC_MODE[2:0] to zero if a return message is expected */
306 if (c->msg[0] & 0x02)
308 mt312_writereg(state, DISEQC_MODE, (diseqc_mode & 0x40))) < 0)
314 static int mt312_send_burst(struct dvb_frontend* fe, const fe_sec_mini_cmd_t c)
316 struct mt312_state *state = fe->demodulator_priv;
317 const u8 mini_tab[2] = { 0x02, 0x03 };
325 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
329 mt312_writereg(state, DISEQC_MODE,
330 (diseqc_mode & 0x40) | mini_tab[c])) < 0)
336 static int mt312_set_tone(struct dvb_frontend* fe, const fe_sec_tone_mode_t t)
338 struct mt312_state *state = fe->demodulator_priv;
339 const u8 tone_tab[2] = { 0x01, 0x00 };
344 if (t > SEC_TONE_OFF)
347 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
351 mt312_writereg(state, DISEQC_MODE,
352 (diseqc_mode & 0x40) | tone_tab[t])) < 0)
358 static int mt312_set_voltage(struct dvb_frontend* fe, const fe_sec_voltage_t v)
360 struct mt312_state *state = fe->demodulator_priv;
361 const u8 volt_tab[3] = { 0x00, 0x40, 0x00 };
363 if (v > SEC_VOLTAGE_OFF)
366 return mt312_writereg(state, DISEQC_MODE, volt_tab[v]);
369 static int mt312_read_status(struct dvb_frontend* fe, fe_status_t *s)
371 struct mt312_state *state = fe->demodulator_priv;
377 if ((ret = mt312_read(state, QPSK_STAT_H, status, sizeof(status))) < 0)
380 dprintk(KERN_DEBUG "QPSK_STAT_H: 0x%02x, QPSK_STAT_L: 0x%02x, FEC_STATUS: 0x%02x\n", status[0], status[1], status[2]);
382 if (status[0] & 0xc0)
383 *s |= FE_HAS_SIGNAL; /* signal noise ratio */
384 if (status[0] & 0x04)
385 *s |= FE_HAS_CARRIER; /* qpsk carrier lock */
386 if (status[2] & 0x02)
387 *s |= FE_HAS_VITERBI; /* viterbi lock */
388 if (status[2] & 0x04)
389 *s |= FE_HAS_SYNC; /* byte align lock */
390 if (status[0] & 0x01)
391 *s |= FE_HAS_LOCK; /* qpsk lock */
396 static int mt312_read_ber(struct dvb_frontend* fe, u32 *ber)
398 struct mt312_state *state = fe->demodulator_priv;
402 if ((ret = mt312_read(state, RS_BERCNT_H, buf, 3)) < 0)
405 *ber = ((buf[0] << 16) | (buf[1] << 8) | buf[2]) * 64;
410 static int mt312_read_signal_strength(struct dvb_frontend* fe, u16 *signal_strength)
412 struct mt312_state *state = fe->demodulator_priv;
418 if ((ret = mt312_read(state, AGC_H, buf, sizeof(buf))) < 0)
421 agc = (buf[0] << 6) | (buf[1] >> 2);
422 err_db = (s16) (((buf[1] & 0x03) << 14) | buf[2] << 6) >> 6;
424 *signal_strength = agc;
426 dprintk(KERN_DEBUG "agc=%08x err_db=%hd\n", agc, err_db);
431 static int mt312_read_snr(struct dvb_frontend* fe, u16 *snr)
433 struct mt312_state *state = fe->demodulator_priv;
437 if ((ret = mt312_read(state, M_SNR_H, &buf, sizeof(buf))) < 0)
440 *snr = 0xFFFF - ((((buf[0] & 0x7f) << 8) | buf[1]) << 1);
445 static int mt312_read_ucblocks(struct dvb_frontend* fe, u32 *ubc)
447 struct mt312_state *state = fe->demodulator_priv;
451 if ((ret = mt312_read(state, RS_UBC_H, &buf, sizeof(buf))) < 0)
454 *ubc = (buf[0] << 8) | buf[1];
459 static int mt312_set_frontend(struct dvb_frontend* fe,
460 struct dvb_frontend_parameters *p)
462 struct mt312_state *state = fe->demodulator_priv;
464 u8 buf[5], config_val;
467 const u8 fec_tab[10] =
468 { 0x00, 0x01, 0x02, 0x04, 0x3f, 0x08, 0x10, 0x20, 0x3f, 0x3f };
469 const u8 inv_tab[3] = { 0x00, 0x40, 0x80 };
471 dprintk("%s: Freq %d\n", __FUNCTION__, p->frequency);
473 if ((p->frequency < fe->ops.info.frequency_min)
474 || (p->frequency > fe->ops.info.frequency_max))
477 if ((p->inversion < INVERSION_OFF)
478 || (p->inversion > INVERSION_ON))
481 if ((p->u.qpsk.symbol_rate < fe->ops.info.symbol_rate_min)
482 || (p->u.qpsk.symbol_rate > fe->ops.info.symbol_rate_max))
485 if ((p->u.qpsk.fec_inner < FEC_NONE)
486 || (p->u.qpsk.fec_inner > FEC_AUTO))
489 if ((p->u.qpsk.fec_inner == FEC_4_5)
490 || (p->u.qpsk.fec_inner == FEC_8_9))
495 // For now we will do this only for the VP310.
496 // It should be better for the mt312 as well, but tunning will be slower. ACCJr 09/29/03
497 ret = mt312_readreg(state, CONFIG, &config_val);
500 if (p->u.qpsk.symbol_rate >= 30000000) //Note that 30MS/s should use 90MHz
502 if ((config_val & 0x0c) == 0x08) { //We are running 60MHz
503 state->frequency = 90;
504 if ((ret = mt312_initfe(fe)) < 0)
510 if ((config_val & 0x0c) == 0x0C) { //We are running 90MHz
511 state->frequency = 60;
512 if ((ret = mt312_initfe(fe)) < 0)
525 if (fe->ops.tuner_ops.set_params) {
526 fe->ops.tuner_ops.set_params(fe, p);
527 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
530 /* sr = (u16)(sr * 256.0 / 1000000.0) */
531 sr = mt312_div(p->u.qpsk.symbol_rate * 4, 15625);
534 buf[0] = (sr >> 8) & 0x3f;
535 buf[1] = (sr >> 0) & 0xff;
538 buf[2] = inv_tab[p->inversion] | fec_tab[p->u.qpsk.fec_inner];
541 buf[3] = 0x40; /* swap I and Q before QPSK demodulation */
543 if (p->u.qpsk.symbol_rate < 10000000)
544 buf[3] |= 0x04; /* use afc mode */
549 if ((ret = mt312_write(state, SYM_RATE_H, buf, sizeof(buf))) < 0)
552 mt312_reset(state, 0);
557 static int mt312_get_frontend(struct dvb_frontend* fe,
558 struct dvb_frontend_parameters *p)
560 struct mt312_state *state = fe->demodulator_priv;
563 if ((ret = mt312_get_inversion(state, &p->inversion)) < 0)
566 if ((ret = mt312_get_symbol_rate(state, &p->u.qpsk.symbol_rate)) < 0)
569 if ((ret = mt312_get_code_rate(state, &p->u.qpsk.fec_inner)) < 0)
575 static int mt312_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
577 struct mt312_state* state = fe->demodulator_priv;
580 return mt312_writereg(state, GPP_CTRL, 0x40);
582 return mt312_writereg(state, GPP_CTRL, 0x00);
586 static int mt312_sleep(struct dvb_frontend* fe)
588 struct mt312_state *state = fe->demodulator_priv;
592 /* reset all registers to defaults */
593 if ((ret = mt312_reset(state, 1)) < 0)
596 if ((ret = mt312_readreg(state, CONFIG, &config)) < 0)
600 if ((ret = mt312_writereg(state, CONFIG, config & 0x7f)) < 0)
606 static int mt312_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
608 fesettings->min_delay_ms = 50;
609 fesettings->step_size = 0;
610 fesettings->max_drift = 0;
614 static void mt312_release(struct dvb_frontend* fe)
616 struct mt312_state* state = fe->demodulator_priv;
620 static struct dvb_frontend_ops vp310_mt312_ops = {
623 .name = "Zarlink ???? DVB-S",
625 .frequency_min = 950000,
626 .frequency_max = 2150000,
627 .frequency_stepsize = (MT312_PLL_CLK / 1000) / 128,
628 .symbol_rate_min = MT312_SYS_CLK / 128,
629 .symbol_rate_max = MT312_SYS_CLK / 2,
631 FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 |
632 FE_CAN_FEC_3_4 | FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
633 FE_CAN_FEC_AUTO | FE_CAN_QPSK | FE_CAN_MUTE_TS |
637 .release = mt312_release,
639 .init = mt312_initfe,
640 .sleep = mt312_sleep,
641 .i2c_gate_ctrl = mt312_i2c_gate_ctrl,
643 .set_frontend = mt312_set_frontend,
644 .get_frontend = mt312_get_frontend,
645 .get_tune_settings = mt312_get_tune_settings,
647 .read_status = mt312_read_status,
648 .read_ber = mt312_read_ber,
649 .read_signal_strength = mt312_read_signal_strength,
650 .read_snr = mt312_read_snr,
651 .read_ucblocks = mt312_read_ucblocks,
653 .diseqc_send_master_cmd = mt312_send_master_cmd,
654 .diseqc_send_burst = mt312_send_burst,
655 .set_tone = mt312_set_tone,
656 .set_voltage = mt312_set_voltage,
659 struct dvb_frontend* vp310_mt312_attach(const struct mt312_config* config,
660 struct i2c_adapter* i2c)
662 struct mt312_state* state = NULL;
664 /* allocate memory for the internal state */
665 state = kmalloc(sizeof(struct mt312_state), GFP_KERNEL);
669 /* setup the state */
670 state->config = config;
673 /* check if the demod is there */
674 if (mt312_readreg(state, ID, &state->id) < 0)
677 /* create dvb_frontend */
678 memcpy(&state->frontend.ops, &vp310_mt312_ops, sizeof(struct dvb_frontend_ops));
679 state->frontend.demodulator_priv = state;
683 strcpy(state->frontend.ops.info.name, "Zarlink VP310 DVB-S");
684 state->frequency = 90;
687 strcpy(state->frontend.ops.info.name, "Zarlink MT312 DVB-S");
688 state->frequency = 60;
691 printk (KERN_WARNING "Only Zarlink VP310/MT312 are supported chips.\n");
695 return &state->frontend;
702 module_param(debug, int, 0644);
703 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
705 MODULE_DESCRIPTION("Zarlink VP310/MT312 DVB-S Demodulator driver");
706 MODULE_AUTHOR("Andreas Oberritter <obi@linuxtv.org>");
707 MODULE_LICENSE("GPL");
709 EXPORT_SYMBOL(vp310_mt312_attach);