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 struct dvb_frontend_ops ops;
43 /* configuration settings */
44 const struct mt312_config* config;
45 struct dvb_frontend frontend;
52 #define dprintk(args...) \
54 if (debug) printk(KERN_DEBUG "mt312: " args); \
57 #define MT312_SYS_CLK 90000000UL /* 90 MHz */
58 #define MT312_LPOWER_SYS_CLK 60000000UL /* 60 MHz */
59 #define MT312_PLL_CLK 10000000UL /* 10 MHz */
61 static int mt312_read(struct mt312_state* state, const enum mt312_reg_addr reg,
62 void *buf, const size_t count)
65 struct i2c_msg msg[2];
66 u8 regbuf[1] = { reg };
68 msg[0].addr = state->config->demod_address;
72 msg[1].addr = state->config->demod_address;
73 msg[1].flags = I2C_M_RD;
77 ret = i2c_transfer(state->i2c, msg, 2);
80 printk(KERN_ERR "%s: ret == %d\n", __FUNCTION__, ret);
86 dprintk("R(%d):", reg & 0x7f);
87 for (i = 0; i < count; i++)
88 printk(" %02x", ((const u8 *) buf)[i]);
95 static int mt312_write(struct mt312_state* state, const enum mt312_reg_addr reg,
96 const void *src, const size_t count)
104 dprintk("W(%d):", reg & 0x7f);
105 for (i = 0; i < count; i++)
106 printk(" %02x", ((const u8 *) src)[i]);
111 memcpy(&buf[1], src, count);
113 msg.addr = state->config->demod_address;
118 ret = i2c_transfer(state->i2c, &msg, 1);
121 dprintk("%s: ret == %d\n", __FUNCTION__, ret);
128 static inline int mt312_readreg(struct mt312_state* state,
129 const enum mt312_reg_addr reg, u8 *val)
131 return mt312_read(state, reg, val, 1);
134 static inline int mt312_writereg(struct mt312_state* state,
135 const enum mt312_reg_addr reg, const u8 val)
137 return mt312_write(state, reg, &val, 1);
140 static inline u32 mt312_div(u32 a, u32 b)
142 return (a + (b / 2)) / b;
145 static int mt312_reset(struct mt312_state* state, const u8 full)
147 return mt312_writereg(state, RESET, full ? 0x80 : 0x40);
150 static int mt312_get_inversion(struct mt312_state* state,
151 fe_spectral_inversion_t *i)
156 if ((ret = mt312_readreg(state, VIT_MODE, &vit_mode)) < 0)
159 if (vit_mode & 0x80) /* auto inversion was used */
160 *i = (vit_mode & 0x40) ? INVERSION_ON : INVERSION_OFF;
165 static int mt312_get_symbol_rate(struct mt312_state* state, u32 *sr)
174 if ((ret = mt312_readreg(state, SYM_RATE_H, &sym_rate_h)) < 0)
177 if (sym_rate_h & 0x80) { /* symbol rate search was used */
178 if ((ret = mt312_writereg(state, MON_CTRL, 0x03)) < 0)
181 if ((ret = mt312_read(state, MONITOR_H, buf, sizeof(buf))) < 0)
184 monitor = (buf[0] << 8) | buf[1];
186 dprintk(KERN_DEBUG "sr(auto) = %u\n",
187 mt312_div(monitor * 15625, 4));
189 if ((ret = mt312_writereg(state, MON_CTRL, 0x05)) < 0)
192 if ((ret = mt312_read(state, MONITOR_H, buf, sizeof(buf))) < 0)
195 dec_ratio = ((buf[0] >> 5) & 0x07) * 32;
197 if ((ret = mt312_read(state, SYM_RAT_OP_H, buf, sizeof(buf))) < 0)
200 sym_rat_op = (buf[0] << 8) | buf[1];
202 dprintk(KERN_DEBUG "sym_rat_op=%d dec_ratio=%d\n",
203 sym_rat_op, dec_ratio);
204 dprintk(KERN_DEBUG "*sr(manual) = %lu\n",
205 (((MT312_PLL_CLK * 8192) / (sym_rat_op + 8192)) *
212 static int mt312_get_code_rate(struct mt312_state* state, fe_code_rate_t *cr)
214 const fe_code_rate_t fec_tab[8] =
215 { FEC_1_2, FEC_2_3, FEC_3_4, FEC_5_6, FEC_6_7, FEC_7_8,
216 FEC_AUTO, FEC_AUTO };
221 if ((ret = mt312_readreg(state, FEC_STATUS, &fec_status)) < 0)
224 *cr = fec_tab[(fec_status >> 4) & 0x07];
229 static int mt312_initfe(struct dvb_frontend* fe)
231 struct mt312_state *state = fe->demodulator_priv;
236 if ((ret = mt312_writereg(state, CONFIG, (state->frequency == 60 ? 0x88 : 0x8c))) < 0)
239 /* wait at least 150 usec */
243 if ((ret = mt312_reset(state, 1)) < 0)
246 // Per datasheet, write correct values. 09/28/03 ACCJr.
247 // If we don't do this, we won't get FE_HAS_VITERBI in the VP310.
249 u8 buf_def[8]={0x14, 0x12, 0x03, 0x02, 0x01, 0x00, 0x00, 0x00};
251 if ((ret = mt312_write(state, VIT_SETUP, buf_def, sizeof(buf_def))) < 0)
256 buf[0] = mt312_div((state->frequency == 60 ? MT312_LPOWER_SYS_CLK : MT312_SYS_CLK) * 2, 1000000);
259 buf[1] = mt312_div(MT312_PLL_CLK, 15000 * 4);
261 if ((ret = mt312_write(state, SYS_CLK, buf, sizeof(buf))) < 0)
264 if ((ret = mt312_writereg(state, SNR_THS_HIGH, 0x32)) < 0)
267 if ((ret = mt312_writereg(state, OP_CTRL, 0x53)) < 0)
274 if ((ret = mt312_write(state, TS_SW_LIM_L, buf, sizeof(buf))) < 0)
277 if ((ret = mt312_writereg(state, CS_SW_LIM, 0x69)) < 0)
280 if (state->config->pll_init) {
281 mt312_writereg(state, GPP_CTRL, 0x40);
282 state->config->pll_init(fe);
283 mt312_writereg(state, GPP_CTRL, 0x00);
289 static int mt312_send_master_cmd(struct dvb_frontend* fe,
290 struct dvb_diseqc_master_cmd *c)
292 struct mt312_state *state = fe->demodulator_priv;
296 if ((c->msg_len == 0) || (c->msg_len > sizeof(c->msg)))
299 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
303 mt312_write(state, (0x80 | DISEQC_INSTR), c->msg, c->msg_len)) < 0)
307 mt312_writereg(state, DISEQC_MODE,
308 (diseqc_mode & 0x40) | ((c->msg_len - 1) << 3)
312 /* set DISEQC_MODE[2:0] to zero if a return message is expected */
313 if (c->msg[0] & 0x02)
315 mt312_writereg(state, DISEQC_MODE, (diseqc_mode & 0x40))) < 0)
321 static int mt312_send_burst(struct dvb_frontend* fe, const fe_sec_mini_cmd_t c)
323 struct mt312_state *state = fe->demodulator_priv;
324 const u8 mini_tab[2] = { 0x02, 0x03 };
332 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
336 mt312_writereg(state, DISEQC_MODE,
337 (diseqc_mode & 0x40) | mini_tab[c])) < 0)
343 static int mt312_set_tone(struct dvb_frontend* fe, const fe_sec_tone_mode_t t)
345 struct mt312_state *state = fe->demodulator_priv;
346 const u8 tone_tab[2] = { 0x01, 0x00 };
351 if (t > SEC_TONE_OFF)
354 if ((ret = mt312_readreg(state, DISEQC_MODE, &diseqc_mode)) < 0)
358 mt312_writereg(state, DISEQC_MODE,
359 (diseqc_mode & 0x40) | tone_tab[t])) < 0)
365 static int mt312_set_voltage(struct dvb_frontend* fe, const fe_sec_voltage_t v)
367 struct mt312_state *state = fe->demodulator_priv;
368 const u8 volt_tab[3] = { 0x00, 0x40, 0x00 };
370 if (v > SEC_VOLTAGE_OFF)
373 return mt312_writereg(state, DISEQC_MODE, volt_tab[v]);
376 static int mt312_read_status(struct dvb_frontend* fe, fe_status_t *s)
378 struct mt312_state *state = fe->demodulator_priv;
384 if ((ret = mt312_read(state, QPSK_STAT_H, status, sizeof(status))) < 0)
387 dprintk(KERN_DEBUG "QPSK_STAT_H: 0x%02x, QPSK_STAT_L: 0x%02x, FEC_STATUS: 0x%02x\n", status[0], status[1], status[2]);
389 if (status[0] & 0xc0)
390 *s |= FE_HAS_SIGNAL; /* signal noise ratio */
391 if (status[0] & 0x04)
392 *s |= FE_HAS_CARRIER; /* qpsk carrier lock */
393 if (status[2] & 0x02)
394 *s |= FE_HAS_VITERBI; /* viterbi lock */
395 if (status[2] & 0x04)
396 *s |= FE_HAS_SYNC; /* byte align lock */
397 if (status[0] & 0x01)
398 *s |= FE_HAS_LOCK; /* qpsk lock */
403 static int mt312_read_ber(struct dvb_frontend* fe, u32 *ber)
405 struct mt312_state *state = fe->demodulator_priv;
409 if ((ret = mt312_read(state, RS_BERCNT_H, buf, 3)) < 0)
412 *ber = ((buf[0] << 16) | (buf[1] << 8) | buf[2]) * 64;
417 static int mt312_read_signal_strength(struct dvb_frontend* fe, u16 *signal_strength)
419 struct mt312_state *state = fe->demodulator_priv;
425 if ((ret = mt312_read(state, AGC_H, buf, sizeof(buf))) < 0)
428 agc = (buf[0] << 6) | (buf[1] >> 2);
429 err_db = (s16) (((buf[1] & 0x03) << 14) | buf[2] << 6) >> 6;
431 *signal_strength = agc;
433 dprintk(KERN_DEBUG "agc=%08x err_db=%hd\n", agc, err_db);
438 static int mt312_read_snr(struct dvb_frontend* fe, u16 *snr)
440 struct mt312_state *state = fe->demodulator_priv;
444 if ((ret = mt312_read(state, M_SNR_H, &buf, sizeof(buf))) < 0)
447 *snr = 0xFFFF - ((((buf[0] & 0x7f) << 8) | buf[1]) << 1);
452 static int mt312_read_ucblocks(struct dvb_frontend* fe, u32 *ubc)
454 struct mt312_state *state = fe->demodulator_priv;
458 if ((ret = mt312_read(state, RS_UBC_H, &buf, sizeof(buf))) < 0)
461 *ubc = (buf[0] << 8) | buf[1];
466 static int mt312_set_frontend(struct dvb_frontend* fe,
467 struct dvb_frontend_parameters *p)
469 struct mt312_state *state = fe->demodulator_priv;
471 u8 buf[5], config_val;
474 const u8 fec_tab[10] =
475 { 0x00, 0x01, 0x02, 0x04, 0x3f, 0x08, 0x10, 0x20, 0x3f, 0x3f };
476 const u8 inv_tab[3] = { 0x00, 0x40, 0x80 };
478 dprintk("%s: Freq %d\n", __FUNCTION__, p->frequency);
480 if ((p->frequency < fe->ops->info.frequency_min)
481 || (p->frequency > fe->ops->info.frequency_max))
484 if ((p->inversion < INVERSION_OFF)
485 || (p->inversion > INVERSION_ON))
488 if ((p->u.qpsk.symbol_rate < fe->ops->info.symbol_rate_min)
489 || (p->u.qpsk.symbol_rate > fe->ops->info.symbol_rate_max))
492 if ((p->u.qpsk.fec_inner < FEC_NONE)
493 || (p->u.qpsk.fec_inner > FEC_AUTO))
496 if ((p->u.qpsk.fec_inner == FEC_4_5)
497 || (p->u.qpsk.fec_inner == FEC_8_9))
502 // For now we will do this only for the VP310.
503 // It should be better for the mt312 as well, but tunning will be slower. ACCJr 09/29/03
504 if ((ret = mt312_readreg(state, CONFIG, &config_val) < 0))
506 if (p->u.qpsk.symbol_rate >= 30000000) //Note that 30MS/s should use 90MHz
508 if ((config_val & 0x0c) == 0x08) { //We are running 60MHz
509 state->frequency = 90;
510 if ((ret = mt312_initfe(fe)) < 0)
516 if ((config_val & 0x0c) == 0x0C) { //We are running 90MHz
517 state->frequency = 60;
518 if ((ret = mt312_initfe(fe)) < 0)
531 mt312_writereg(state, GPP_CTRL, 0x40);
532 state->config->pll_set(fe, p);
533 mt312_writereg(state, GPP_CTRL, 0x00);
535 /* sr = (u16)(sr * 256.0 / 1000000.0) */
536 sr = mt312_div(p->u.qpsk.symbol_rate * 4, 15625);
539 buf[0] = (sr >> 8) & 0x3f;
540 buf[1] = (sr >> 0) & 0xff;
543 buf[2] = inv_tab[p->inversion] | fec_tab[p->u.qpsk.fec_inner];
546 buf[3] = 0x40; /* swap I and Q before QPSK demodulation */
548 if (p->u.qpsk.symbol_rate < 10000000)
549 buf[3] |= 0x04; /* use afc mode */
554 if ((ret = mt312_write(state, SYM_RATE_H, buf, sizeof(buf))) < 0)
557 mt312_reset(state, 0);
562 static int mt312_get_frontend(struct dvb_frontend* fe,
563 struct dvb_frontend_parameters *p)
565 struct mt312_state *state = fe->demodulator_priv;
568 if ((ret = mt312_get_inversion(state, &p->inversion)) < 0)
571 if ((ret = mt312_get_symbol_rate(state, &p->u.qpsk.symbol_rate)) < 0)
574 if ((ret = mt312_get_code_rate(state, &p->u.qpsk.fec_inner)) < 0)
580 static int mt312_sleep(struct dvb_frontend* fe)
582 struct mt312_state *state = fe->demodulator_priv;
586 /* reset all registers to defaults */
587 if ((ret = mt312_reset(state, 1)) < 0)
590 if ((ret = mt312_readreg(state, CONFIG, &config)) < 0)
594 if ((ret = mt312_writereg(state, CONFIG, config & 0x7f)) < 0)
600 static int mt312_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
602 fesettings->min_delay_ms = 50;
603 fesettings->step_size = 0;
604 fesettings->max_drift = 0;
608 static void mt312_release(struct dvb_frontend* fe)
610 struct mt312_state* state = fe->demodulator_priv;
614 static struct dvb_frontend_ops vp310_mt312_ops;
616 struct dvb_frontend* vp310_attach(const struct mt312_config* config,
617 struct i2c_adapter* i2c)
619 struct mt312_state* state = NULL;
621 /* allocate memory for the internal state */
622 state = kmalloc(sizeof(struct mt312_state), GFP_KERNEL);
626 /* setup the state */
627 state->config = config;
629 memcpy(&state->ops, &vp310_mt312_ops, sizeof(struct dvb_frontend_ops));
630 strcpy(state->ops.info.name, "Zarlink VP310 DVB-S");
632 /* check if the demod is there */
633 if (mt312_readreg(state, ID, &state->id) < 0)
635 if (state->id != ID_VP310) {
639 /* create dvb_frontend */
640 state->frequency = 90;
641 state->frontend.ops = &state->ops;
642 state->frontend.demodulator_priv = state;
643 return &state->frontend;
650 struct dvb_frontend* mt312_attach(const struct mt312_config* config,
651 struct i2c_adapter* i2c)
653 struct mt312_state* state = NULL;
655 /* allocate memory for the internal state */
656 state = kmalloc(sizeof(struct mt312_state), GFP_KERNEL);
660 /* setup the state */
661 state->config = config;
663 memcpy(&state->ops, &vp310_mt312_ops, sizeof(struct dvb_frontend_ops));
664 strcpy(state->ops.info.name, "Zarlink MT312 DVB-S");
666 /* check if the demod is there */
667 if (mt312_readreg(state, ID, &state->id) < 0)
669 if (state->id != ID_MT312) {
673 /* create dvb_frontend */
674 state->frequency = 60;
675 state->frontend.ops = &state->ops;
676 state->frontend.demodulator_priv = state;
677 return &state->frontend;
684 static struct dvb_frontend_ops vp310_mt312_ops = {
687 .name = "Zarlink ???? DVB-S",
689 .frequency_min = 950000,
690 .frequency_max = 2150000,
691 .frequency_stepsize = (MT312_PLL_CLK / 1000) / 128,
692 .symbol_rate_min = MT312_SYS_CLK / 128,
693 .symbol_rate_max = MT312_SYS_CLK / 2,
695 FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 |
696 FE_CAN_FEC_3_4 | FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 |
697 FE_CAN_FEC_AUTO | FE_CAN_QPSK | FE_CAN_MUTE_TS |
701 .release = mt312_release,
703 .init = mt312_initfe,
704 .sleep = mt312_sleep,
706 .set_frontend = mt312_set_frontend,
707 .get_frontend = mt312_get_frontend,
708 .get_tune_settings = mt312_get_tune_settings,
710 .read_status = mt312_read_status,
711 .read_ber = mt312_read_ber,
712 .read_signal_strength = mt312_read_signal_strength,
713 .read_snr = mt312_read_snr,
714 .read_ucblocks = mt312_read_ucblocks,
716 .diseqc_send_master_cmd = mt312_send_master_cmd,
717 .diseqc_send_burst = mt312_send_burst,
718 .set_tone = mt312_set_tone,
719 .set_voltage = mt312_set_voltage,
722 module_param(debug, int, 0644);
723 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
725 MODULE_DESCRIPTION("Zarlink VP310/MT312 DVB-S Demodulator driver");
726 MODULE_AUTHOR("Andreas Oberritter <obi@linuxtv.org>");
727 MODULE_LICENSE("GPL");
729 EXPORT_SYMBOL(mt312_attach);
730 EXPORT_SYMBOL(vp310_attach);