2 * Driver for Zarlink ZL10039 DVB-S tuner
4 * Copyright 2007 Jan D. Louw <jd.louw@mweb.co.za>
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 #include <linux/module.h>
23 #include <linux/init.h>
24 #include <linux/string.h>
25 #include <linux/slab.h>
26 #include <linux/dvb/frontend.h>
28 #include "dvb_frontend.h"
33 /* Max transfer size done by I2C transfer functions */
34 #define MAX_XFER_SIZE 64
36 #define dprintk(args...) \
39 printk(KERN_DEBUG args); \
42 enum zl10039_model_id {
46 struct zl10039_state {
47 struct i2c_adapter *i2c;
52 enum zl10039_reg_addr {
71 static int zl10039_read(const struct zl10039_state *state,
72 const enum zl10039_reg_addr reg, u8 *buf,
75 u8 regbuf[] = { reg };
76 struct i2c_msg msg[] = {
77 {/* Write register address */
78 .addr = state->i2c_addr,
82 }, {/* Read count bytes */
83 .addr = state->i2c_addr,
90 dprintk("%s\n", __func__);
92 if (i2c_transfer(state->i2c, msg, 2) != 2) {
93 dprintk("%s: i2c read error\n", __func__);
97 return 0; /* Success */
100 static int zl10039_write(struct zl10039_state *state,
101 const enum zl10039_reg_addr reg, const u8 *src,
104 u8 buf[MAX_XFER_SIZE];
105 struct i2c_msg msg = {
106 .addr = state->i2c_addr,
112 if (1 + count > sizeof(buf)) {
114 "%s: i2c wr reg=%04x: len=%zu is too big!\n",
115 KBUILD_MODNAME, reg, count);
119 dprintk("%s\n", __func__);
120 /* Write register address and data in one go */
122 memcpy(&buf[1], src, count);
123 if (i2c_transfer(state->i2c, &msg, 1) != 1) {
124 dprintk("%s: i2c write error\n", __func__);
128 return 0; /* Success */
131 static inline int zl10039_readreg(struct zl10039_state *state,
132 const enum zl10039_reg_addr reg, u8 *val)
134 return zl10039_read(state, reg, val, 1);
137 static inline int zl10039_writereg(struct zl10039_state *state,
138 const enum zl10039_reg_addr reg,
141 const u8 tmp = val; /* see gcc.gnu.org/bugzilla/show_bug.cgi?id=81715 */
143 return zl10039_write(state, reg, &tmp, 1);
146 static int zl10039_init(struct dvb_frontend *fe)
148 struct zl10039_state *state = fe->tuner_priv;
151 dprintk("%s\n", __func__);
152 if (fe->ops.i2c_gate_ctrl)
153 fe->ops.i2c_gate_ctrl(fe, 1);
155 ret = zl10039_writereg(state, GENERAL, 0x40);
157 dprintk("Note: i2c write error normal when resetting the "
161 ret = zl10039_writereg(state, GENERAL, 0x01);
163 dprintk("Tuner power up failed\n");
166 if (fe->ops.i2c_gate_ctrl)
167 fe->ops.i2c_gate_ctrl(fe, 0);
172 static int zl10039_sleep(struct dvb_frontend *fe)
174 struct zl10039_state *state = fe->tuner_priv;
177 dprintk("%s\n", __func__);
178 if (fe->ops.i2c_gate_ctrl)
179 fe->ops.i2c_gate_ctrl(fe, 1);
180 ret = zl10039_writereg(state, GENERAL, 0x80);
182 dprintk("Tuner sleep failed\n");
185 if (fe->ops.i2c_gate_ctrl)
186 fe->ops.i2c_gate_ctrl(fe, 0);
191 static int zl10039_set_params(struct dvb_frontend *fe)
193 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
194 struct zl10039_state *state = fe->tuner_priv;
201 dprintk("%s\n", __func__);
202 dprintk("Set frequency = %d, symbol rate = %d\n",
203 c->frequency, c->symbol_rate);
205 /* Assumed 10.111 MHz crystal oscillator */
206 /* Cancelled num/den 80 to prevent overflow */
207 div = (c->frequency * 1000) / 126387;
208 fbw = (c->symbol_rate * 27) / 32000;
209 /* Cancelled num/den 10 to prevent overflow */
210 bf = ((fbw * 5088) / 1011100) - 1;
213 buf[0] = (div >> 8) & 0x7f;
214 buf[1] = (div >> 0) & 0xff;
215 /*Reference divider*/
216 /* Select reference ratio of 80 */
220 /*RF Control register*/
221 buf[4] = 0x6E; /* Bypass enable */
222 /*Baseband filter cutoff */
226 if (fe->ops.i2c_gate_ctrl)
227 fe->ops.i2c_gate_ctrl(fe, 1);
228 /* BR = 10, Enable filter adjustment */
229 ret = zl10039_writereg(state, BASE1, 0x0A);
232 /* Write new config values */
233 ret = zl10039_write(state, PLL0, buf, sizeof(buf));
236 /* BR = 10, Disable filter adjustment */
237 ret = zl10039_writereg(state, BASE1, 0x6A);
242 if (fe->ops.i2c_gate_ctrl)
243 fe->ops.i2c_gate_ctrl(fe, 0);
246 dprintk("Error setting tuner\n");
250 static int zl10039_release(struct dvb_frontend *fe)
252 struct zl10039_state *state = fe->tuner_priv;
254 dprintk("%s\n", __func__);
256 fe->tuner_priv = NULL;
260 static const struct dvb_tuner_ops zl10039_ops = {
261 .release = zl10039_release,
262 .init = zl10039_init,
263 .sleep = zl10039_sleep,
264 .set_params = zl10039_set_params,
267 struct dvb_frontend *zl10039_attach(struct dvb_frontend *fe,
268 u8 i2c_addr, struct i2c_adapter *i2c)
270 struct zl10039_state *state = NULL;
272 dprintk("%s\n", __func__);
273 state = kmalloc(sizeof(struct zl10039_state), GFP_KERNEL);
278 state->i2c_addr = i2c_addr;
281 if (fe->ops.i2c_gate_ctrl)
282 fe->ops.i2c_gate_ctrl(fe, 1);
283 /* check if this is a valid tuner */
284 if (zl10039_readreg(state, GENERAL, &state->id) < 0) {
286 if (fe->ops.i2c_gate_ctrl)
287 fe->ops.i2c_gate_ctrl(fe, 0);
291 if (fe->ops.i2c_gate_ctrl)
292 fe->ops.i2c_gate_ctrl(fe, 0);
294 state->id = state->id & 0x0f;
297 strcpy(fe->ops.tuner_ops.info.name,
298 "Zarlink ZL10039 DVB-S tuner");
301 dprintk("Chip ID=%x does not match a known type\n", state->id);
305 memcpy(&fe->ops.tuner_ops, &zl10039_ops, sizeof(struct dvb_tuner_ops));
306 fe->tuner_priv = state;
307 dprintk("Tuner attached @ i2c address 0x%02x\n", i2c_addr);
313 EXPORT_SYMBOL(zl10039_attach);
315 module_param(debug, int, 0644);
316 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
317 MODULE_DESCRIPTION("Zarlink ZL10039 DVB-S tuner driver");
318 MODULE_AUTHOR("Jan D. Louw <jd.louw@mweb.co.za>");
319 MODULE_LICENSE("GPL");