3 Copyright (C) Manu Abraham (abraham.manu@gmail.com)
5 Copyright (C) ST Microelectronics
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 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/init.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/string.h>
27 #include "dvb_frontend.h"
30 static unsigned int verbose;
31 module_param(verbose, int, 0644);
39 #define dprintk(x, y, z, format, arg...) do { \
41 if ((x > FE_ERROR) && (x > y)) \
42 printk(KERN_ERR "%s: " format "\n", __func__ , ##arg); \
43 else if ((x > FE_NOTICE) && (x > y)) \
44 printk(KERN_NOTICE "%s: " format "\n", __func__ , ##arg); \
45 else if ((x > FE_INFO) && (x > y)) \
46 printk(KERN_INFO "%s: " format "\n", __func__ , ##arg); \
47 else if ((x > FE_DEBUG) && (x > y)) \
48 printk(KERN_DEBUG "%s: " format "\n", __func__ , ##arg); \
51 printk(format, ##arg); \
61 static int stb6100_release(struct dvb_frontend *fe);
63 static const struct stb6100_lkup lkup[] = {
65 { 950000, 1000000, 0x0a },
66 { 1000000, 1075000, 0x0c },
67 { 1075000, 1200000, 0x00 },
68 { 1200000, 1300000, 0x01 },
69 { 1300000, 1370000, 0x02 },
70 { 1370000, 1470000, 0x04 },
71 { 1470000, 1530000, 0x05 },
72 { 1530000, 1650000, 0x06 },
73 { 1650000, 1800000, 0x08 },
74 { 1800000, 1950000, 0x0a },
75 { 1950000, 2150000, 0x0c },
76 { 2150000, 9999999, 0x0c },
80 /* Register names for easy debugging. */
81 static const char *stb6100_regnames[] = {
83 [STB6100_VCO] = "VCO",
85 [STB6100_NF_LSB] = "NF",
89 [STB6100_DLB] = "DLB",
90 [STB6100_TEST1] = "TEST1",
91 [STB6100_FCCK] = "FCCK",
92 [STB6100_LPEN] = "LPEN",
93 [STB6100_TEST3] = "TEST3",
96 /* Template for normalisation, i.e. setting unused or undocumented
97 * bits as required according to the documentation.
99 struct stb6100_regmask {
104 static const struct stb6100_regmask stb6100_template[] = {
105 [STB6100_LD] = { 0xff, 0x00 },
106 [STB6100_VCO] = { 0xff, 0x00 },
107 [STB6100_NI] = { 0xff, 0x00 },
108 [STB6100_NF_LSB] = { 0xff, 0x00 },
109 [STB6100_K] = { 0xc7, 0x38 },
110 [STB6100_G] = { 0xef, 0x10 },
111 [STB6100_F] = { 0x1f, 0xc0 },
112 [STB6100_DLB] = { 0x38, 0xc4 },
113 [STB6100_TEST1] = { 0x00, 0x8f },
114 [STB6100_FCCK] = { 0x40, 0x0d },
115 [STB6100_LPEN] = { 0xf0, 0x0b },
116 [STB6100_TEST3] = { 0x00, 0xde },
119 static void stb6100_normalise_regs(u8 regs[])
123 for (i = 0; i < STB6100_NUMREGS; i++)
124 regs[i] = (regs[i] & stb6100_template[i].mask) | stb6100_template[i].set;
127 static int stb6100_read_regs(struct stb6100_state *state, u8 regs[])
130 struct i2c_msg msg = {
131 .addr = state->config->tuner_address,
134 .len = STB6100_NUMREGS
137 if (state->frontend->ops.i2c_gate_ctrl)
138 if ((rc = state->frontend->ops.i2c_gate_ctrl(state->frontend, 1)) < 0)
141 rc = i2c_transfer(state->i2c, &msg, 1);
142 if (state->frontend->ops.i2c_gate_ctrl) {
144 if ((rc2 = state->frontend->ops.i2c_gate_ctrl(state->frontend, 0)) < 0)
147 if (unlikely(rc != 1)) {
148 dprintk(verbose, FE_ERROR, 1, "Read (0x%x) err, rc=[%d]",
149 state->config->tuner_address, rc);
153 if (unlikely(verbose > FE_DEBUG)) {
156 dprintk(verbose, FE_DEBUG, 1, " Read from 0x%02x", state->config->tuner_address);
157 for (i = 0; i < STB6100_NUMREGS; i++)
158 dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[i], regs[i]);
163 static int stb6100_read_reg(struct stb6100_state *state, u8 reg)
165 u8 regs[STB6100_NUMREGS];
168 if (unlikely(reg >= STB6100_NUMREGS)) {
169 dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
172 if ((rc = stb6100_read_regs(state, regs)) < 0)
174 return (unsigned int)regs[reg];
177 static int stb6100_write_reg_range(struct stb6100_state *state, u8 buf[], int start, int len)
181 struct i2c_msg msg = {
182 .addr = state->config->tuner_address,
188 if (unlikely(start < 1 || start + len > STB6100_NUMREGS)) {
189 dprintk(verbose, FE_ERROR, 1, "Invalid register range %d:%d",
193 memcpy(&cmdbuf[1], buf, len);
196 if (unlikely(verbose > FE_DEBUG)) {
199 dprintk(verbose, FE_DEBUG, 1, " Write @ 0x%02x: [%d:%d]", state->config->tuner_address, start, len);
200 for (i = 0; i < len; i++)
201 dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[start + i], buf[i]);
203 if (state->frontend->ops.i2c_gate_ctrl)
204 if ((rc = state->frontend->ops.i2c_gate_ctrl(state->frontend, 1)) < 0)
206 rc = i2c_transfer(state->i2c, &msg, 1);
207 if (state->frontend->ops.i2c_gate_ctrl) {
209 if ((rc2 = state->frontend->ops.i2c_gate_ctrl(state->frontend, 0)) < 0)
212 if (unlikely(rc != 1)) {
213 dprintk(verbose, FE_ERROR, 1, "(0x%x) write err [%d:%d], rc=[%d]",
214 (unsigned int)state->config->tuner_address, start, len, rc);
220 static int stb6100_write_reg(struct stb6100_state *state, u8 reg, u8 data)
222 if (unlikely(reg >= STB6100_NUMREGS)) {
223 dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
226 data = (data & stb6100_template[reg].mask) | stb6100_template[reg].set;
227 return stb6100_write_reg_range(state, &data, reg, 1);
230 static int stb6100_write_regs(struct stb6100_state *state, u8 regs[])
232 stb6100_normalise_regs(regs);
233 return stb6100_write_reg_range(state, ®s[1], 1, STB6100_NUMREGS - 1);
236 static int stb6100_get_status(struct dvb_frontend *fe, u32 *status)
239 struct stb6100_state *state = fe->tuner_priv;
241 if ((rc = stb6100_read_reg(state, STB6100_LD)) < 0)
244 return (rc & STB6100_LD_LOCK) ? TUNER_STATUS_LOCKED : 0;
247 static int stb6100_get_bandwidth(struct dvb_frontend *fe, u32 *bandwidth)
251 struct stb6100_state *state = fe->tuner_priv;
253 if ((rc = stb6100_read_reg(state, STB6100_F)) < 0)
255 f = rc & STB6100_F_F;
257 state->status.bandwidth = (f + 5) * 2000; /* x2 for ZIF */
259 *bandwidth = state->bandwidth = state->status.bandwidth * 1000;
260 dprintk(verbose, FE_DEBUG, 1, "bandwidth = %u Hz", state->bandwidth);
264 static int stb6100_set_bandwidth(struct dvb_frontend *fe, u32 bandwidth)
268 struct stb6100_state *state = fe->tuner_priv;
270 dprintk(verbose, FE_DEBUG, 1, "set bandwidth to %u kHz", bandwidth);
272 bandwidth *= 1000 / 2; /* kHz -> Hz, bw / 2 */
274 if (bandwidth > 36000000) /* F[4:0] BW/2 max =31+5=36 mhz for F=31 */
276 if (bandwidth < 5000000) /* bw/2 min = 5Mhz for F=0 */
278 else /* if 5 < bw/2 < 36 */
279 tmp = bandwidth / 1000000 - 5;
281 /* Turn on LPF bandwidth setting clock control,
282 * set bandwidth, wait 10ms, turn off.
284 if ((rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d | STB6100_FCCK_FCCK)) < 0)
286 if ((rc = stb6100_write_reg(state, STB6100_F, 0xc0 | tmp)) < 0)
289 if ((rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d)) < 0)
295 static int stb6100_get_frequency(struct dvb_frontend *fe, u32 *frequency)
298 u32 nint, nfrac, fvco;
300 struct stb6100_state *state = fe->tuner_priv;
301 u8 regs[STB6100_NUMREGS];
303 if ((rc = stb6100_read_regs(state, regs)) < 0)
306 odiv = (regs[STB6100_VCO] & STB6100_VCO_ODIV) >> STB6100_VCO_ODIV_SHIFT;
307 psd2 = (regs[STB6100_K] & STB6100_K_PSD2) >> STB6100_K_PSD2_SHIFT;
308 nint = regs[STB6100_NI];
309 nfrac = ((regs[STB6100_K] & STB6100_K_NF_MSB) << 8) | regs[STB6100_NF_LSB];
310 fvco = (nfrac * state->reference >> (9 - psd2)) + (nint * state->reference << psd2);
311 *frequency = state->frequency = fvco >> (odiv + 1);
313 dprintk(verbose, FE_DEBUG, 1,
314 "frequency = %u kHz, odiv = %u, psd2 = %u, fxtal = %u kHz, fvco = %u kHz, N(I) = %u, N(F) = %u",
315 state->frequency, odiv, psd2, state->reference, fvco, nint, nfrac);
320 static int stb6100_set_frequency(struct dvb_frontend *fe, u32 frequency)
323 const struct stb6100_lkup *ptr;
324 struct stb6100_state *state = fe->tuner_priv;
325 struct dvbfe_params params;
327 u32 srate = 0, fvco, nint, nfrac;
328 u8 regs[STB6100_NUMREGS];
331 if ((rc = stb6100_read_regs(state, regs)) < 0)
333 if (fe->ops.get_params) {
334 dprintk(verbose, FE_DEBUG, 1, "Get Frontend parameters");
335 fe->ops.get_params(fe, ¶ms);
337 switch (params.delivery) {
338 case DVBFE_DELSYS_DVBS:
339 srate = params.delsys.dvbs.symbol_rate;
340 dprintk(verbose, FE_DEBUG, 1, "Delivery system = DVB-S, Symbol Rate=[%d]", srate);
342 case DVBFE_DELSYS_DSS:
343 dprintk(verbose, FE_DEBUG, 1, "Delivery system = DSS, Symbol Rate=[%d]", srate);
344 srate = params.delsys.dss.symbol_rate;
346 case DVBFE_DELSYS_DVBS2:
347 dprintk(verbose, FE_DEBUG, 1, "Delivery system = DVB-S2, Symbol Rate=[%d]", srate);
348 srate = params.delsys.dvbs2.symbol_rate;
351 dprintk(verbose, FE_NOTICE, 1, "symbol rate unknown!");
352 srate = 22000000; /* just a typical default value */
356 if (srate >= 15000000)
358 else if (state->srate >= 5000000)
362 regs[STB6100_G] = (regs[STB6100_G] & ~STB6100_G_G) | g;
364 /* VCO divide ratio (LO divide ratio, VCO prescaler enable). */
365 if (frequency <= 1075000)
369 regs[STB6100_VCO] = (regs[STB6100_VCO] & ~STB6100_VCO_ODIV) | (odiv << STB6100_VCO_ODIV_SHIFT);
371 if ((frequency > 1075000) && (frequency <= 1325000))
375 regs[STB6100_K] = (regs[STB6100_K] & ~STB6100_K_PSD2) | (psd2 << STB6100_K_PSD2_SHIFT);
379 (ptr->val_high != 0) && !CHKRANGE(frequency, ptr->val_low, ptr->val_high);
381 if (ptr->val_high == 0) {
382 printk(KERN_ERR "%s: frequency out of range: %u kHz\n", __func__, frequency);
385 regs[STB6100_VCO] = (regs[STB6100_VCO] & ~STB6100_VCO_OSM) | ptr->reg;
387 /* F(VCO) = F(LO) * (ODIV == 0 ? 2 : 4) */
388 fvco = frequency << (1 + odiv);
389 /* N(I) = floor(f(VCO) / (f(XTAL) * (PSD2 ? 2 : 1))) */
390 nint = fvco / (state->reference << psd2);
391 /* N(F) = round(f(VCO) / f(XTAL) * (PSD2 ? 2 : 1) - N(I)) * 2 ^ 9 */
392 nfrac = (((fvco - (nint * state->reference << psd2)) << (9 - psd2)) + state->reference / 2) / state->reference;
393 dprintk(verbose, FE_DEBUG, 1,
394 "frequency = %u, srate = %u, g = %u, odiv = %u, psd2 = %u, fxtal = %u, osm = %u, fvco = %u, N(I) = %u, N(F) = %u",
395 frequency, srate, (unsigned int)g, (unsigned int)odiv,
396 (unsigned int)psd2, state->reference,
397 ptr->reg, fvco, nint, nfrac);
398 regs[STB6100_NI] = nint;
399 regs[STB6100_NF_LSB] = nfrac;
400 regs[STB6100_K] = (regs[STB6100_K] & ~STB6100_K_NF_MSB) | ((nfrac >> 8) & STB6100_K_NF_MSB);
401 regs[STB6100_VCO] |= STB6100_VCO_OSCH; /* VCO search enabled */
402 regs[STB6100_VCO] |= STB6100_VCO_OCK; /* VCO search clock off */
403 regs[STB6100_FCCK] |= STB6100_FCCK_FCCK; /* LPF BW setting clock enabled */
404 regs[STB6100_LPEN] &= ~STB6100_LPEN_LPEN; /* PLL loop disabled */
406 regs[STB6100_LPEN] |= STB6100_LPEN_SYNP | STB6100_LPEN_OSCP | STB6100_LPEN_BEN;
408 if ((rc = stb6100_write_regs(state, regs)) < 0)
411 regs[STB6100_LPEN] |= STB6100_LPEN_LPEN; /* PLL loop enabled */
412 if ((rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN])) < 0)
415 regs[STB6100_VCO] &= ~STB6100_VCO_OCK; /* VCO fast search */
416 if ((rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO])) < 0)
419 msleep(5); /* wait for LO to lock */
420 regs[STB6100_VCO] &= ~STB6100_VCO_OSCH; /* vco search disabled */
421 regs[STB6100_VCO] |= STB6100_VCO_OCK; /* search clock off */
422 if ((rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO])) < 0)
424 regs[STB6100_FCCK] &= ~STB6100_FCCK_FCCK; /* LPF BW clock disabled */
425 if ((rc = stb6100_write_reg(state, STB6100_FCCK, regs[STB6100_FCCK])) < 0)
431 static int stb6100_sleep(struct dvb_frontend *fe)
433 /* TODO: power down */
437 static int stb6100_init(struct dvb_frontend *fe)
439 struct stb6100_state *state = fe->tuner_priv;
440 struct tuner_state *status = &state->status;
442 status->tunerstep = 125000;
444 status->refclock = 27000000; /* Hz */
446 status->bandwidth = 36000; /* kHz */
447 state->bandwidth = status->bandwidth * 1000; /* MHz */
448 state->reference = status->refclock / 1000; /* kHz */
450 /* Set default bandwidth. */
451 return stb6100_set_bandwidth(fe, status->bandwidth);
454 static int stb6100_get_state(struct dvb_frontend *fe,
455 enum tuner_param param,
456 struct tuner_state *state)
459 case DVBFE_TUNER_FREQUENCY:
460 stb6100_get_frequency(fe, &state->frequency);
462 case DVBFE_TUNER_TUNERSTEP:
464 case DVBFE_TUNER_IFFREQ:
466 case DVBFE_TUNER_BANDWIDTH:
467 stb6100_get_bandwidth(fe, &state->bandwidth);
469 case DVBFE_TUNER_REFCLOCK:
478 static int stb6100_set_state(struct dvb_frontend *fe,
479 enum tuner_param param,
480 struct tuner_state *state)
482 struct stb6100_state *tstate = fe->tuner_priv;
485 case DVBFE_TUNER_FREQUENCY:
486 stb6100_set_frequency(fe, state->frequency);
487 state->frequency = tstate->frequency;
489 case DVBFE_TUNER_TUNERSTEP:
491 case DVBFE_TUNER_IFFREQ:
493 case DVBFE_TUNER_BANDWIDTH:
494 stb6100_set_bandwidth(fe, state->bandwidth);
495 state->bandwidth = tstate->bandwidth;
497 case DVBFE_TUNER_REFCLOCK:
506 static struct dvb_tuner_ops stb6100_ops = {
508 .name = "STB6100 Silicon Tuner",
509 .frequency_min = 950000,
510 .frequency_max = 2150000,
514 .init = stb6100_init,
515 .sleep = stb6100_sleep,
516 .get_status = stb6100_get_status,
517 .get_state = stb6100_get_state,
518 .set_state = stb6100_set_state,
519 .get_frequency = stb6100_get_frequency,
520 .get_bandwidth = stb6100_get_bandwidth,
521 .release = stb6100_release
524 struct dvb_frontend *stb6100_attach(struct dvb_frontend *fe,
525 struct stb6100_config *config,
526 struct i2c_adapter *i2c)
528 struct stb6100_state *state = NULL;
530 state = kmalloc(sizeof (struct stb6100_state), GFP_KERNEL);
534 state->config = config;
536 state->frontend = fe;
537 state->reference = config->refclock;
538 fe->tuner_priv = state;
539 fe->ops.tuner_ops = stb6100_ops;
541 printk("%s: Attaching\n", __func__);
550 static int stb6100_release(struct dvb_frontend *fe)
552 struct stb6100_state *state = fe->tuner_priv;
554 fe->tuner_priv = NULL;
555 memset(&fe->ops.tuner_ops, 0, sizeof (fe->ops.tuner_ops));
561 EXPORT_SYMBOL(stb6100_attach);
562 MODULE_PARM_DESC(verbose, "Set Verbosity level");
564 MODULE_AUTHOR("Manu Abraham");
565 MODULE_DESCRIPTION("STB6100 Silicon tuner");
566 MODULE_LICENSE("GPL");