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];
163
struct i2c_msg msg = {
164
.addr = state->config->tuner_address + reg,
170
rc = i2c_transfer(state->i2c, &msg, 1);
172
if (unlikely(reg >= STB6100_NUMREGS)) {
173
dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
176
if (unlikely(verbose > FE_DEBUG)) {
177
dprintk(verbose, FE_DEBUG, 1, " Read from 0x%02x", state->config->tuner_address);
178
dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[reg], regs[0]);
181
return (unsigned int)regs[0];
184
static int stb6100_write_reg_range(struct stb6100_state *state, u8 buf[], int start, int len)
188
struct i2c_msg msg = {
189
.addr = state->config->tuner_address,
195
if (unlikely(start < 1 || start + len > STB6100_NUMREGS)) {
196
dprintk(verbose, FE_ERROR, 1, "Invalid register range %d:%d",
200
memcpy(&cmdbuf[1], buf, len);
203
if (unlikely(verbose > FE_DEBUG)) {
206
dprintk(verbose, FE_DEBUG, 1, " Write @ 0x%02x: [%d:%d]", state->config->tuner_address, start, len);
207
for (i = 0; i < len; i++)
208
dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[start + i], buf[i]);
210
rc = i2c_transfer(state->i2c, &msg, 1);
211
if (unlikely(rc != 1)) {
212
dprintk(verbose, FE_ERROR, 1, "(0x%x) write err [%d:%d], rc=[%d]",
213
(unsigned int)state->config->tuner_address, start, len, rc);
219
static int stb6100_write_reg(struct stb6100_state *state, u8 reg, u8 data)
221
if (unlikely(reg >= STB6100_NUMREGS)) {
222
dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
225
data = (data & stb6100_template[reg].mask) | stb6100_template[reg].set;
226
return stb6100_write_reg_range(state, &data, reg, 1);
230
static int stb6100_get_status(struct dvb_frontend *fe, u32 *status)
233
struct stb6100_state *state = fe->tuner_priv;
235
rc = stb6100_read_reg(state, STB6100_LD);
237
dprintk(verbose, FE_ERROR, 1, "%s failed", __func__);
240
return (rc & STB6100_LD_LOCK) ? TUNER_STATUS_LOCKED : 0;
243
static int stb6100_get_bandwidth(struct dvb_frontend *fe, u32 *bandwidth)
247
struct stb6100_state *state = fe->tuner_priv;
249
rc = stb6100_read_reg(state, STB6100_F);
252
f = rc & STB6100_F_F;
254
state->status.bandwidth = (f + 5) * 2000; /* x2 for ZIF */
256
*bandwidth = state->bandwidth = state->status.bandwidth * 1000;
257
dprintk(verbose, FE_DEBUG, 1, "bandwidth = %u Hz", state->bandwidth);
261
static int stb6100_set_bandwidth(struct dvb_frontend *fe, u32 bandwidth)
265
struct stb6100_state *state = fe->tuner_priv;
267
dprintk(verbose, FE_DEBUG, 1, "set bandwidth to %u Hz", bandwidth);
269
bandwidth /= 2; /* ZIF */
271
if (bandwidth >= 36000000) /* F[4:0] BW/2 max =31+5=36 mhz for F=31 */
273
else if (bandwidth <= 5000000) /* bw/2 min = 5Mhz for F=0 */
275
else /* if 5 < bw/2 < 36 */
276
tmp = (bandwidth + 500000) / 1000000 - 5;
278
/* Turn on LPF bandwidth setting clock control,
279
* set bandwidth, wait 10ms, turn off.
281
rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d | STB6100_FCCK_FCCK);
284
rc = stb6100_write_reg(state, STB6100_F, 0xc0 | tmp);
288
msleep(5); /* This is dangerous as another (related) thread may start */
290
rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
294
msleep(10); /* This is dangerous as another (related) thread may start */
299
static int stb6100_get_frequency(struct dvb_frontend *fe, u32 *frequency)
302
u32 nint, nfrac, fvco;
304
struct stb6100_state *state = fe->tuner_priv;
305
u8 regs[STB6100_NUMREGS];
307
rc = stb6100_read_regs(state, regs);
311
odiv = (regs[STB6100_VCO] & STB6100_VCO_ODIV) >> STB6100_VCO_ODIV_SHIFT;
312
psd2 = (regs[STB6100_K] & STB6100_K_PSD2) >> STB6100_K_PSD2_SHIFT;
313
nint = regs[STB6100_NI];
314
nfrac = ((regs[STB6100_K] & STB6100_K_NF_MSB) << 8) | regs[STB6100_NF_LSB];
315
fvco = (nfrac * state->reference >> (9 - psd2)) + (nint * state->reference << psd2);
316
*frequency = state->frequency = fvco >> (odiv + 1);
318
dprintk(verbose, FE_DEBUG, 1,
319
"frequency = %u kHz, odiv = %u, psd2 = %u, fxtal = %u kHz, fvco = %u kHz, N(I) = %u, N(F) = %u",
320
state->frequency, odiv, psd2, state->reference, fvco, nint, nfrac);
325
static int stb6100_set_frequency(struct dvb_frontend *fe, u32 frequency)
328
const struct stb6100_lkup *ptr;
329
struct stb6100_state *state = fe->tuner_priv;
330
struct dvb_frontend_parameters p;
332
u32 srate = 0, fvco, nint, nfrac;
333
u8 regs[STB6100_NUMREGS];
336
dprintk(verbose, FE_DEBUG, 1, "Version 2010-8-14 13:51");
338
if (fe->ops.get_frontend) {
339
dprintk(verbose, FE_DEBUG, 1, "Get frontend parameters");
340
fe->ops.get_frontend(fe, &p);
342
srate = p.u.qpsk.symbol_rate;
344
/* Set up tuner cleanly, LPF calibration on */
345
rc = stb6100_write_reg(state, STB6100_FCCK, 0x4d | STB6100_FCCK_FCCK);
347
return rc; /* allow LPF calibration */
349
/* PLL Loop disabled, bias on, VCO on, synth on */
350
regs[STB6100_LPEN] = 0xeb;
351
rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
355
/* Program the registers with their data values */
357
/* VCO divide ratio (LO divide ratio, VCO prescaler enable). */
358
if (frequency <= 1075000)
363
/* VCO enabled, search clock off as per LL3.7, 3.4.1 */
364
regs[STB6100_VCO] = 0xe0 | (odiv << STB6100_VCO_ODIV_SHIFT);
368
(ptr->val_high != 0) && !CHKRANGE(frequency, ptr->val_low, ptr->val_high);
371
if (ptr->val_high == 0) {
372
printk(KERN_ERR "%s: frequency out of range: %u kHz\n", __func__, frequency);
375
regs[STB6100_VCO] = (regs[STB6100_VCO] & ~STB6100_VCO_OSM) | ptr->reg;
376
rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
380
if ((frequency > 1075000) && (frequency <= 1325000))
384
/* F(VCO) = F(LO) * (ODIV == 0 ? 2 : 4) */
385
fvco = frequency << (1 + odiv);
386
/* N(I) = floor(f(VCO) / (f(XTAL) * (PSD2 ? 2 : 1))) */
387
nint = fvco / (state->reference << psd2);
388
/* N(F) = round(f(VCO) / f(XTAL) * (PSD2 ? 2 : 1) - N(I)) * 2 ^ 9 */
389
nfrac = DIV_ROUND_CLOSEST((fvco - (nint * state->reference << psd2))
390
<< (9 - psd2), state->reference);
393
regs[STB6100_NI] = nint;
394
rc = stb6100_write_reg(state, STB6100_NI, regs[STB6100_NI]);
399
regs[STB6100_NF_LSB] = nfrac;
400
rc = stb6100_write_reg(state, STB6100_NF_LSB, regs[STB6100_NF_LSB]);
405
regs[STB6100_K] = (0x38 & ~STB6100_K_PSD2) | (psd2 << STB6100_K_PSD2_SHIFT);
406
regs[STB6100_K] = (regs[STB6100_K] & ~STB6100_K_NF_MSB) | ((nfrac >> 8) & STB6100_K_NF_MSB);
407
rc = stb6100_write_reg(state, STB6100_K, regs[STB6100_K]);
411
/* G Baseband gain. */
412
if (srate >= 15000000)
414
else if (srate >= 5000000)
419
regs[STB6100_G] = (0x10 & ~STB6100_G_G) | g;
420
regs[STB6100_G] &= ~STB6100_G_GCT; /* mask GCT */
421
regs[STB6100_G] |= (1 << 5); /* 2Vp-p Mode */
422
rc = stb6100_write_reg(state, STB6100_G, regs[STB6100_G]);
426
/* F we don't write as it is set up in BW set */
428
/* DLB set DC servo loop BW to 160Hz (LLA 3.8 / 2.1) */
429
regs[STB6100_DLB] = 0xcc;
430
rc = stb6100_write_reg(state, STB6100_DLB, regs[STB6100_DLB]);
434
dprintk(verbose, FE_DEBUG, 1,
435
"frequency = %u, srate = %u, g = %u, odiv = %u, psd2 = %u, fxtal = %u, osm = %u, fvco = %u, N(I) = %u, N(F) = %u",
436
frequency, srate, (unsigned int)g, (unsigned int)odiv,
437
(unsigned int)psd2, state->reference,
438
ptr->reg, fvco, nint, nfrac);
440
/* Set up the test registers */
441
regs[STB6100_TEST1] = 0x8f;
442
rc = stb6100_write_reg(state, STB6100_TEST1, regs[STB6100_TEST1]);
445
regs[STB6100_TEST3] = 0xde;
446
rc = stb6100_write_reg(state, STB6100_TEST3, regs[STB6100_TEST3]);
450
/* Bring up tuner according to LLA 3.7 3.4.1, step 2 */
451
regs[STB6100_LPEN] = 0xfb; /* PLL Loop enabled, bias on, VCO on, synth on */
452
rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
458
/* Bring up tuner according to LLA 3.7 3.4.1, step 3 */
459
regs[STB6100_VCO] &= ~STB6100_VCO_OCK; /* VCO fast search */
460
rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
464
msleep(10); /* This is dangerous as another (related) thread may start */ /* wait for LO to lock */
466
regs[STB6100_VCO] &= ~STB6100_VCO_OSCH; /* vco search disabled */
467
regs[STB6100_VCO] |= STB6100_VCO_OCK; /* search clock off */
468
rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
472
rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
474
return rc; /* Stop LPF calibration */
476
msleep(10); /* This is dangerous as another (related) thread may start */
477
/* wait for stabilisation, (should not be necessary) */
481
static int stb6100_sleep(struct dvb_frontend *fe)
483
/* TODO: power down */
487
static int stb6100_init(struct dvb_frontend *fe)
489
struct stb6100_state *state = fe->tuner_priv;
490
struct tuner_state *status = &state->status;
492
status->tunerstep = 125000;
494
status->refclock = 27000000; /* Hz */
496
status->bandwidth = 36000; /* kHz */
497
state->bandwidth = status->bandwidth * 1000; /* Hz */
498
state->reference = status->refclock / 1000; /* kHz */
500
/* Set default bandwidth. Modified, PN 13-May-10 */
504
static int stb6100_get_state(struct dvb_frontend *fe,
505
enum tuner_param param,
506
struct tuner_state *state)
509
case DVBFE_TUNER_FREQUENCY:
510
stb6100_get_frequency(fe, &state->frequency);
512
case DVBFE_TUNER_TUNERSTEP:
514
case DVBFE_TUNER_IFFREQ:
516
case DVBFE_TUNER_BANDWIDTH:
517
stb6100_get_bandwidth(fe, &state->bandwidth);
519
case DVBFE_TUNER_REFCLOCK:
528
static int stb6100_set_state(struct dvb_frontend *fe,
529
enum tuner_param param,
530
struct tuner_state *state)
532
struct stb6100_state *tstate = fe->tuner_priv;
535
case DVBFE_TUNER_FREQUENCY:
536
stb6100_set_frequency(fe, state->frequency);
537
tstate->frequency = state->frequency;
539
case DVBFE_TUNER_TUNERSTEP:
541
case DVBFE_TUNER_IFFREQ:
543
case DVBFE_TUNER_BANDWIDTH:
544
stb6100_set_bandwidth(fe, state->bandwidth);
545
tstate->bandwidth = state->bandwidth;
547
case DVBFE_TUNER_REFCLOCK:
556
static struct dvb_tuner_ops stb6100_ops = {
558
.name = "STB6100 Silicon Tuner",
559
.frequency_min = 950000,
560
.frequency_max = 2150000,
564
.init = stb6100_init,
565
.sleep = stb6100_sleep,
566
.get_status = stb6100_get_status,
567
.get_state = stb6100_get_state,
568
.set_state = stb6100_set_state,
569
.release = stb6100_release
572
struct dvb_frontend *stb6100_attach(struct dvb_frontend *fe,
573
const struct stb6100_config *config,
574
struct i2c_adapter *i2c)
576
struct stb6100_state *state = NULL;
578
state = kzalloc(sizeof (struct stb6100_state), GFP_KERNEL);
582
state->config = config;
584
state->frontend = fe;
585
state->reference = config->refclock / 1000; /* kHz */
586
fe->tuner_priv = state;
587
fe->ops.tuner_ops = stb6100_ops;
589
printk("%s: Attaching STB6100 \n", __func__);
597
static int stb6100_release(struct dvb_frontend *fe)
599
struct stb6100_state *state = fe->tuner_priv;
601
fe->tuner_priv = NULL;
607
EXPORT_SYMBOL(stb6100_attach);
608
MODULE_PARM_DESC(verbose, "Set Verbosity level");
610
MODULE_AUTHOR("Manu Abraham");
611
MODULE_DESCRIPTION("STB6100 Silicon tuner");
612
MODULE_LICENSE("GPL");