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/slab.h>
26 #include <linux/string.h>
28 #include "dvb_frontend.h"
31 static unsigned int verbose;
32 module_param(verbose, int, 0644);
40 #define dprintk(x, y, z, format, arg...) do { \
42 if ((x > FE_ERROR) && (x > y)) \
43 printk(KERN_ERR "%s: " format "\n", __func__ , ##arg); \
44 else if ((x > FE_NOTICE) && (x > y)) \
45 printk(KERN_NOTICE "%s: " format "\n", __func__ , ##arg); \
46 else if ((x > FE_INFO) && (x > y)) \
47 printk(KERN_INFO "%s: " format "\n", __func__ , ##arg); \
48 else if ((x > FE_DEBUG) && (x > y)) \
49 printk(KERN_DEBUG "%s: " format "\n", __func__ , ##arg); \
52 printk(format, ##arg); \
62 static int stb6100_release(struct dvb_frontend *fe);
64 static const struct stb6100_lkup lkup[] = {
66 { 950000, 1000000, 0x0a },
67 { 1000000, 1075000, 0x0c },
68 { 1075000, 1200000, 0x00 },
69 { 1200000, 1300000, 0x01 },
70 { 1300000, 1370000, 0x02 },
71 { 1370000, 1470000, 0x04 },
72 { 1470000, 1530000, 0x05 },
73 { 1530000, 1650000, 0x06 },
74 { 1650000, 1800000, 0x08 },
75 { 1800000, 1950000, 0x0a },
76 { 1950000, 2150000, 0x0c },
77 { 2150000, 9999999, 0x0c },
81 /* Register names for easy debugging. */
82 static const char *stb6100_regnames[] = {
84 [STB6100_VCO] = "VCO",
86 [STB6100_NF_LSB] = "NF",
90 [STB6100_DLB] = "DLB",
91 [STB6100_TEST1] = "TEST1",
92 [STB6100_FCCK] = "FCCK",
93 [STB6100_LPEN] = "LPEN",
94 [STB6100_TEST3] = "TEST3",
97 /* Template for normalisation, i.e. setting unused or undocumented
98 * bits as required according to the documentation.
100 struct stb6100_regmask {
105 static const struct stb6100_regmask stb6100_template[] = {
106 [STB6100_LD] = { 0xff, 0x00 },
107 [STB6100_VCO] = { 0xff, 0x00 },
108 [STB6100_NI] = { 0xff, 0x00 },
109 [STB6100_NF_LSB] = { 0xff, 0x00 },
110 [STB6100_K] = { 0xc7, 0x38 },
111 [STB6100_G] = { 0xef, 0x10 },
112 [STB6100_F] = { 0x1f, 0xc0 },
113 [STB6100_DLB] = { 0x38, 0xc4 },
114 [STB6100_TEST1] = { 0x00, 0x8f },
115 [STB6100_FCCK] = { 0x40, 0x0d },
116 [STB6100_LPEN] = { 0xf0, 0x0b },
117 [STB6100_TEST3] = { 0x00, 0xde },
121 * Currently unused. Some boards might need it in the future
123 static inline void stb6100_normalise_regs(u8 regs[])
127 for (i = 0; i < STB6100_NUMREGS; i++)
128 regs[i] = (regs[i] & stb6100_template[i].mask) | stb6100_template[i].set;
131 static int stb6100_read_regs(struct stb6100_state *state, u8 regs[])
134 struct i2c_msg msg = {
135 .addr = state->config->tuner_address,
138 .len = STB6100_NUMREGS
141 rc = i2c_transfer(state->i2c, &msg, 1);
142 if (unlikely(rc != 1)) {
143 dprintk(verbose, FE_ERROR, 1, "Read (0x%x) err, rc=[%d]",
144 state->config->tuner_address, rc);
148 if (unlikely(verbose > FE_DEBUG)) {
151 dprintk(verbose, FE_DEBUG, 1, " Read from 0x%02x", state->config->tuner_address);
152 for (i = 0; i < STB6100_NUMREGS; i++)
153 dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[i], regs[i]);
158 static int stb6100_read_reg(struct stb6100_state *state, u8 reg)
160 u8 regs[STB6100_NUMREGS];
162 struct i2c_msg msg = {
163 .addr = state->config->tuner_address + reg,
169 i2c_transfer(state->i2c, &msg, 1);
171 if (unlikely(reg >= STB6100_NUMREGS)) {
172 dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
175 if (unlikely(verbose > FE_DEBUG)) {
176 dprintk(verbose, FE_DEBUG, 1, " Read from 0x%02x", state->config->tuner_address);
177 dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[reg], regs[0]);
180 return (unsigned int)regs[0];
183 static int stb6100_write_reg_range(struct stb6100_state *state, u8 buf[], int start, int len)
187 struct i2c_msg msg = {
188 .addr = state->config->tuner_address,
194 if (unlikely(start < 1 || start + len > STB6100_NUMREGS)) {
195 dprintk(verbose, FE_ERROR, 1, "Invalid register range %d:%d",
199 memcpy(&cmdbuf[1], buf, len);
202 if (unlikely(verbose > FE_DEBUG)) {
205 dprintk(verbose, FE_DEBUG, 1, " Write @ 0x%02x: [%d:%d]", state->config->tuner_address, start, len);
206 for (i = 0; i < len; i++)
207 dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[start + i], buf[i]);
209 rc = i2c_transfer(state->i2c, &msg, 1);
210 if (unlikely(rc != 1)) {
211 dprintk(verbose, FE_ERROR, 1, "(0x%x) write err [%d:%d], rc=[%d]",
212 (unsigned int)state->config->tuner_address, start, len, rc);
218 static int stb6100_write_reg(struct stb6100_state *state, u8 reg, u8 data)
220 if (unlikely(reg >= STB6100_NUMREGS)) {
221 dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
224 data = (data & stb6100_template[reg].mask) | stb6100_template[reg].set;
225 return stb6100_write_reg_range(state, &data, reg, 1);
229 static int stb6100_get_status(struct dvb_frontend *fe, u32 *status)
232 struct stb6100_state *state = fe->tuner_priv;
234 rc = stb6100_read_reg(state, STB6100_LD);
236 dprintk(verbose, FE_ERROR, 1, "%s failed", __func__);
239 return (rc & STB6100_LD_LOCK) ? TUNER_STATUS_LOCKED : 0;
242 static int stb6100_get_bandwidth(struct dvb_frontend *fe, u32 *bandwidth)
246 struct stb6100_state *state = fe->tuner_priv;
248 rc = stb6100_read_reg(state, STB6100_F);
251 f = rc & STB6100_F_F;
253 state->status.bandwidth = (f + 5) * 2000; /* x2 for ZIF */
255 *bandwidth = state->bandwidth = state->status.bandwidth * 1000;
256 dprintk(verbose, FE_DEBUG, 1, "bandwidth = %u Hz", state->bandwidth);
260 static int stb6100_set_bandwidth(struct dvb_frontend *fe, u32 bandwidth)
264 struct stb6100_state *state = fe->tuner_priv;
266 dprintk(verbose, FE_DEBUG, 1, "set bandwidth to %u Hz", bandwidth);
268 bandwidth /= 2; /* ZIF */
270 if (bandwidth >= 36000000) /* F[4:0] BW/2 max =31+5=36 mhz for F=31 */
272 else if (bandwidth <= 5000000) /* bw/2 min = 5Mhz for F=0 */
274 else /* if 5 < bw/2 < 36 */
275 tmp = (bandwidth + 500000) / 1000000 - 5;
277 /* Turn on LPF bandwidth setting clock control,
278 * set bandwidth, wait 10ms, turn off.
280 rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d | STB6100_FCCK_FCCK);
283 rc = stb6100_write_reg(state, STB6100_F, 0xc0 | tmp);
287 msleep(5); /* This is dangerous as another (related) thread may start */
289 rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
293 msleep(10); /* This is dangerous as another (related) thread may start */
298 static int stb6100_get_frequency(struct dvb_frontend *fe, u32 *frequency)
301 u32 nint, nfrac, fvco;
303 struct stb6100_state *state = fe->tuner_priv;
304 u8 regs[STB6100_NUMREGS];
306 rc = stb6100_read_regs(state, regs);
310 odiv = (regs[STB6100_VCO] & STB6100_VCO_ODIV) >> STB6100_VCO_ODIV_SHIFT;
311 psd2 = (regs[STB6100_K] & STB6100_K_PSD2) >> STB6100_K_PSD2_SHIFT;
312 nint = regs[STB6100_NI];
313 nfrac = ((regs[STB6100_K] & STB6100_K_NF_MSB) << 8) | regs[STB6100_NF_LSB];
314 fvco = (nfrac * state->reference >> (9 - psd2)) + (nint * state->reference << psd2);
315 *frequency = state->frequency = fvco >> (odiv + 1);
317 dprintk(verbose, FE_DEBUG, 1,
318 "frequency = %u kHz, odiv = %u, psd2 = %u, fxtal = %u kHz, fvco = %u kHz, N(I) = %u, N(F) = %u",
319 state->frequency, odiv, psd2, state->reference, fvco, nint, nfrac);
324 static int stb6100_set_frequency(struct dvb_frontend *fe, u32 frequency)
327 const struct stb6100_lkup *ptr;
328 struct stb6100_state *state = fe->tuner_priv;
329 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
331 u32 srate = 0, fvco, nint, nfrac;
332 u8 regs[STB6100_NUMREGS];
335 dprintk(verbose, FE_DEBUG, 1, "Version 2010-8-14 13:51");
337 if (fe->ops.get_frontend) {
338 dprintk(verbose, FE_DEBUG, 1, "Get frontend parameters");
339 fe->ops.get_frontend(fe);
341 srate = p->symbol_rate;
343 /* Set up tuner cleanly, LPF calibration on */
344 rc = stb6100_write_reg(state, STB6100_FCCK, 0x4d | STB6100_FCCK_FCCK);
346 return rc; /* allow LPF calibration */
348 /* PLL Loop disabled, bias on, VCO on, synth on */
349 regs[STB6100_LPEN] = 0xeb;
350 rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
354 /* Program the registers with their data values */
356 /* VCO divide ratio (LO divide ratio, VCO prescaler enable). */
357 if (frequency <= 1075000)
362 /* VCO enabled, search clock off as per LL3.7, 3.4.1 */
363 regs[STB6100_VCO] = 0xe0 | (odiv << STB6100_VCO_ODIV_SHIFT);
367 (ptr->val_high != 0) && !CHKRANGE(frequency, ptr->val_low, ptr->val_high);
370 if (ptr->val_high == 0) {
371 printk(KERN_ERR "%s: frequency out of range: %u kHz\n", __func__, frequency);
374 regs[STB6100_VCO] = (regs[STB6100_VCO] & ~STB6100_VCO_OSM) | ptr->reg;
375 rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
379 if ((frequency > 1075000) && (frequency <= 1325000))
383 /* F(VCO) = F(LO) * (ODIV == 0 ? 2 : 4) */
384 fvco = frequency << (1 + odiv);
385 /* N(I) = floor(f(VCO) / (f(XTAL) * (PSD2 ? 2 : 1))) */
386 nint = fvco / (state->reference << psd2);
387 /* N(F) = round(f(VCO) / f(XTAL) * (PSD2 ? 2 : 1) - N(I)) * 2 ^ 9 */
388 nfrac = DIV_ROUND_CLOSEST((fvco - (nint * state->reference << psd2))
389 << (9 - psd2), state->reference);
392 regs[STB6100_NI] = nint;
393 rc = stb6100_write_reg(state, STB6100_NI, regs[STB6100_NI]);
398 regs[STB6100_NF_LSB] = nfrac;
399 rc = stb6100_write_reg(state, STB6100_NF_LSB, regs[STB6100_NF_LSB]);
404 regs[STB6100_K] = (0x38 & ~STB6100_K_PSD2) | (psd2 << STB6100_K_PSD2_SHIFT);
405 regs[STB6100_K] = (regs[STB6100_K] & ~STB6100_K_NF_MSB) | ((nfrac >> 8) & STB6100_K_NF_MSB);
406 rc = stb6100_write_reg(state, STB6100_K, regs[STB6100_K]);
410 /* G Baseband gain. */
411 if (srate >= 15000000)
413 else if (srate >= 5000000)
418 regs[STB6100_G] = (0x10 & ~STB6100_G_G) | g;
419 regs[STB6100_G] &= ~STB6100_G_GCT; /* mask GCT */
420 regs[STB6100_G] |= (1 << 5); /* 2Vp-p Mode */
421 rc = stb6100_write_reg(state, STB6100_G, regs[STB6100_G]);
425 /* F we don't write as it is set up in BW set */
427 /* DLB set DC servo loop BW to 160Hz (LLA 3.8 / 2.1) */
428 regs[STB6100_DLB] = 0xcc;
429 rc = stb6100_write_reg(state, STB6100_DLB, regs[STB6100_DLB]);
433 dprintk(verbose, FE_DEBUG, 1,
434 "frequency = %u, srate = %u, g = %u, odiv = %u, psd2 = %u, fxtal = %u, osm = %u, fvco = %u, N(I) = %u, N(F) = %u",
435 frequency, srate, (unsigned int)g, (unsigned int)odiv,
436 (unsigned int)psd2, state->reference,
437 ptr->reg, fvco, nint, nfrac);
439 /* Set up the test registers */
440 regs[STB6100_TEST1] = 0x8f;
441 rc = stb6100_write_reg(state, STB6100_TEST1, regs[STB6100_TEST1]);
444 regs[STB6100_TEST3] = 0xde;
445 rc = stb6100_write_reg(state, STB6100_TEST3, regs[STB6100_TEST3]);
449 /* Bring up tuner according to LLA 3.7 3.4.1, step 2 */
450 regs[STB6100_LPEN] = 0xfb; /* PLL Loop enabled, bias on, VCO on, synth on */
451 rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
457 /* Bring up tuner according to LLA 3.7 3.4.1, step 3 */
458 regs[STB6100_VCO] &= ~STB6100_VCO_OCK; /* VCO fast search */
459 rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
463 msleep(10); /* This is dangerous as another (related) thread may start */ /* wait for LO to lock */
465 regs[STB6100_VCO] &= ~STB6100_VCO_OSCH; /* vco search disabled */
466 regs[STB6100_VCO] |= STB6100_VCO_OCK; /* search clock off */
467 rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
471 rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
473 return rc; /* Stop LPF calibration */
475 msleep(10); /* This is dangerous as another (related) thread may start */
476 /* wait for stabilisation, (should not be necessary) */
480 static int stb6100_sleep(struct dvb_frontend *fe)
482 /* TODO: power down */
486 static int stb6100_init(struct dvb_frontend *fe)
488 struct stb6100_state *state = fe->tuner_priv;
489 struct tuner_state *status = &state->status;
491 status->tunerstep = 125000;
493 status->refclock = 27000000; /* Hz */
495 status->bandwidth = 36000; /* kHz */
496 state->bandwidth = status->bandwidth * 1000; /* Hz */
497 state->reference = status->refclock / 1000; /* kHz */
499 /* Set default bandwidth. Modified, PN 13-May-10 */
503 static int stb6100_get_state(struct dvb_frontend *fe,
504 enum tuner_param param,
505 struct tuner_state *state)
508 case DVBFE_TUNER_FREQUENCY:
509 stb6100_get_frequency(fe, &state->frequency);
511 case DVBFE_TUNER_TUNERSTEP:
513 case DVBFE_TUNER_IFFREQ:
515 case DVBFE_TUNER_BANDWIDTH:
516 stb6100_get_bandwidth(fe, &state->bandwidth);
518 case DVBFE_TUNER_REFCLOCK:
527 static int stb6100_set_state(struct dvb_frontend *fe,
528 enum tuner_param param,
529 struct tuner_state *state)
531 struct stb6100_state *tstate = fe->tuner_priv;
534 case DVBFE_TUNER_FREQUENCY:
535 stb6100_set_frequency(fe, state->frequency);
536 tstate->frequency = state->frequency;
538 case DVBFE_TUNER_TUNERSTEP:
540 case DVBFE_TUNER_IFFREQ:
542 case DVBFE_TUNER_BANDWIDTH:
543 stb6100_set_bandwidth(fe, state->bandwidth);
544 tstate->bandwidth = state->bandwidth;
546 case DVBFE_TUNER_REFCLOCK:
555 static struct dvb_tuner_ops stb6100_ops = {
557 .name = "STB6100 Silicon Tuner",
558 .frequency_min = 950000,
559 .frequency_max = 2150000,
563 .init = stb6100_init,
564 .sleep = stb6100_sleep,
565 .get_status = stb6100_get_status,
566 .get_state = stb6100_get_state,
567 .set_state = stb6100_set_state,
568 .release = stb6100_release
571 struct dvb_frontend *stb6100_attach(struct dvb_frontend *fe,
572 const struct stb6100_config *config,
573 struct i2c_adapter *i2c)
575 struct stb6100_state *state = NULL;
577 state = kzalloc(sizeof (struct stb6100_state), GFP_KERNEL);
581 state->config = config;
583 state->frontend = fe;
584 state->reference = config->refclock / 1000; /* kHz */
585 fe->tuner_priv = state;
586 fe->ops.tuner_ops = stb6100_ops;
588 printk("%s: Attaching STB6100 \n", __func__);
592 static int stb6100_release(struct dvb_frontend *fe)
594 struct stb6100_state *state = fe->tuner_priv;
596 fe->tuner_priv = NULL;
602 EXPORT_SYMBOL(stb6100_attach);
603 MODULE_PARM_DESC(verbose, "Set Verbosity level");
605 MODULE_AUTHOR("Manu Abraham");
606 MODULE_DESCRIPTION("STB6100 Silicon tuner");
607 MODULE_LICENSE("GPL");