?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 4.16.11
[linux/fpc-iii.git] / drivers / media / dvb-frontends / stb6100.c
blob3a851f524b16ba35b70c109922614846349d8d7f
1 /*
2 STB6100 Silicon Tuner
3 Copyright (C) Manu Abraham (abraham.manu@gmail.com)
4
5 Copyright (C) ST Microelectronics
6
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.
11
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.
16
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.
20 */
21
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>
27
28 #include <media/dvb_frontend.h>
29 #include "stb6100.h"
30
31 static unsigned int verbose;
32 module_param(verbose, int, 0644);
33
34 /* Max transfer size done by I2C transfer functions */
35 #define MAX_XFER_SIZE 64
36
37 #define FE_ERROR 0
38 #define FE_NOTICE 1
39 #define FE_INFO 2
40 #define FE_DEBUG 3
41
42 #define dprintk(x, y, z, format, arg...) do { \
43 if (z) { \
44 if ((x > FE_ERROR) && (x > y)) \
45 printk(KERN_ERR "%s: " format "\n", __func__ , ##arg); \
46 else if ((x > FE_NOTICE) && (x > y)) \
47 printk(KERN_NOTICE "%s: " format "\n", __func__ , ##arg); \
48 else if ((x > FE_INFO) && (x > y)) \
49 printk(KERN_INFO "%s: " format "\n", __func__ , ##arg); \
50 else if ((x > FE_DEBUG) && (x > y)) \
51 printk(KERN_DEBUG "%s: " format "\n", __func__ , ##arg); \
52 } else { \
53 if (x > y) \
54 printk(format, ##arg); \
55 } \
56 } while (0)
57
58 struct stb6100_lkup {
59 u32 val_low;
60 u32 val_high;
61 u8 reg;
62 };
63
64 static void stb6100_release(struct dvb_frontend *fe);
65
66 static const struct stb6100_lkup lkup[] = {
67 { 0, 950000, 0x0a },
68 { 950000, 1000000, 0x0a },
69 { 1000000, 1075000, 0x0c },
70 { 1075000, 1200000, 0x00 },
71 { 1200000, 1300000, 0x01 },
72 { 1300000, 1370000, 0x02 },
73 { 1370000, 1470000, 0x04 },
74 { 1470000, 1530000, 0x05 },
75 { 1530000, 1650000, 0x06 },
76 { 1650000, 1800000, 0x08 },
77 { 1800000, 1950000, 0x0a },
78 { 1950000, 2150000, 0x0c },
79 { 2150000, 9999999, 0x0c },
80 { 0, 0, 0x00 }
81 };
82
83 /* Register names for easy debugging. */
84 static const char *stb6100_regnames[] = {
85 [STB6100_LD] = "LD",
86 [STB6100_VCO] = "VCO",
87 [STB6100_NI] = "NI",
88 [STB6100_NF_LSB] = "NF",
89 [STB6100_K] = "K",
90 [STB6100_G] = "G",
91 [STB6100_F] = "F",
92 [STB6100_DLB] = "DLB",
93 [STB6100_TEST1] = "TEST1",
94 [STB6100_FCCK] = "FCCK",
95 [STB6100_LPEN] = "LPEN",
96 [STB6100_TEST3] = "TEST3",
97 };
98
99 /* Template for normalisation, i.e. setting unused or undocumented
100 * bits as required according to the documentation.
101 */
102 struct stb6100_regmask {
103 u8 mask;
104 u8 set;
105 };
106
107 static const struct stb6100_regmask stb6100_template[] = {
108 [STB6100_LD] = { 0xff, 0x00 },
109 [STB6100_VCO] = { 0xff, 0x00 },
110 [STB6100_NI] = { 0xff, 0x00 },
111 [STB6100_NF_LSB] = { 0xff, 0x00 },
112 [STB6100_K] = { 0xc7, 0x38 },
113 [STB6100_G] = { 0xef, 0x10 },
114 [STB6100_F] = { 0x1f, 0xc0 },
115 [STB6100_DLB] = { 0x38, 0xc4 },
116 [STB6100_TEST1] = { 0x00, 0x8f },
117 [STB6100_FCCK] = { 0x40, 0x0d },
118 [STB6100_LPEN] = { 0xf0, 0x0b },
119 [STB6100_TEST3] = { 0x00, 0xde },
120 };
121
122 /*
123 * Currently unused. Some boards might need it in the future
124 */
125 static inline void stb6100_normalise_regs(u8 regs[])
126 {
127 int i;
128
129 for (i = 0; i < STB6100_NUMREGS; i++)
130 regs[i] = (regs[i] & stb6100_template[i].mask) | stb6100_template[i].set;
131 }
132
133 static int stb6100_read_regs(struct stb6100_state *state, u8 regs[])
134 {
135 int rc;
136 struct i2c_msg msg = {
137 .addr = state->config->tuner_address,
138 .flags = I2C_M_RD,
139 .buf = regs,
140 .len = STB6100_NUMREGS
141 };
142
143 rc = i2c_transfer(state->i2c, &msg, 1);
144 if (unlikely(rc != 1)) {
145 dprintk(verbose, FE_ERROR, 1, "Read (0x%x) err, rc=[%d]",
146 state->config->tuner_address, rc);
147
148 return -EREMOTEIO;
149 }
150 if (unlikely(verbose > FE_DEBUG)) {
151 int i;
152
153 dprintk(verbose, FE_DEBUG, 1, " Read from 0x%02x", state->config->tuner_address);
154 for (i = 0; i < STB6100_NUMREGS; i++)
155 dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[i], regs[i]);
156 }
157 return 0;
158 }
159
160 static int stb6100_read_reg(struct stb6100_state *state, u8 reg)
161 {
162 u8 regs[STB6100_NUMREGS];
163
164 struct i2c_msg msg = {
165 .addr = state->config->tuner_address + reg,
166 .flags = I2C_M_RD,
167 .buf = regs,
168 .len = 1
169 };
170
171 i2c_transfer(state->i2c, &msg, 1);
172
173 if (unlikely(reg >= STB6100_NUMREGS)) {
174 dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
175 return -EINVAL;
176 }
177 if (unlikely(verbose > FE_DEBUG)) {
178 dprintk(verbose, FE_DEBUG, 1, " Read from 0x%02x", state->config->tuner_address);
179 dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[reg], regs[0]);
180 }
181
182 return (unsigned int)regs[0];
183 }
184
185 static int stb6100_write_reg_range(struct stb6100_state *state, u8 buf[], int start, int len)
186 {
187 int rc;
188 u8 cmdbuf[MAX_XFER_SIZE];
189 struct i2c_msg msg = {
190 .addr = state->config->tuner_address,
191 .flags = 0,
192 .buf = cmdbuf,
193 .len = len + 1
194 };
195
196 if (1 + len > sizeof(cmdbuf)) {
197 printk(KERN_WARNING
198 "%s: i2c wr: len=%d is too big!\n",
199 KBUILD_MODNAME, len);
200 return -EINVAL;
201 }
202
203 if (unlikely(start < 1 || start + len > STB6100_NUMREGS)) {
204 dprintk(verbose, FE_ERROR, 1, "Invalid register range %d:%d",
205 start, len);
206 return -EINVAL;
207 }
208 memcpy(&cmdbuf[1], buf, len);
209 cmdbuf[0] = start;
210
211 if (unlikely(verbose > FE_DEBUG)) {
212 int i;
213
214 dprintk(verbose, FE_DEBUG, 1, " Write @ 0x%02x: [%d:%d]", state->config->tuner_address, start, len);
215 for (i = 0; i < len; i++)
216 dprintk(verbose, FE_DEBUG, 1, " %s: 0x%02x", stb6100_regnames[start + i], buf[i]);
217 }
218 rc = i2c_transfer(state->i2c, &msg, 1);
219 if (unlikely(rc != 1)) {
220 dprintk(verbose, FE_ERROR, 1, "(0x%x) write err [%d:%d], rc=[%d]",
221 (unsigned int)state->config->tuner_address, start, len, rc);
222 return -EREMOTEIO;
223 }
224 return 0;
225 }
226
227 static int stb6100_write_reg(struct stb6100_state *state, u8 reg, u8 data)
228 {
229 u8 tmp = data; /* see gcc.gnu.org/bugzilla/show_bug.cgi?id=81715 */
230
231 if (unlikely(reg >= STB6100_NUMREGS)) {
232 dprintk(verbose, FE_ERROR, 1, "Invalid register offset 0x%x", reg);
233 return -EREMOTEIO;
234 }
235 tmp = (tmp & stb6100_template[reg].mask) | stb6100_template[reg].set;
236 return stb6100_write_reg_range(state, &tmp, reg, 1);
237 }
238
239
240 static int stb6100_get_status(struct dvb_frontend *fe, u32 *status)
241 {
242 int rc;
243 struct stb6100_state *state = fe->tuner_priv;
244
245 rc = stb6100_read_reg(state, STB6100_LD);
246 if (rc < 0) {
247 dprintk(verbose, FE_ERROR, 1, "%s failed", __func__);
248 return rc;
249 }
250 return (rc & STB6100_LD_LOCK) ? TUNER_STATUS_LOCKED : 0;
251 }
252
253 static int stb6100_get_bandwidth(struct dvb_frontend *fe, u32 *bandwidth)
254 {
255 int rc;
256 u8 f;
257 u32 bw;
258 struct stb6100_state *state = fe->tuner_priv;
259
260 rc = stb6100_read_reg(state, STB6100_F);
261 if (rc < 0)
262 return rc;
263 f = rc & STB6100_F_F;
264
265 bw = (f + 5) * 2000; /* x2 for ZIF */
266
267 *bandwidth = state->bandwidth = bw * 1000;
268 dprintk(verbose, FE_DEBUG, 1, "bandwidth = %u Hz", state->bandwidth);
269 return 0;
270 }
271
272 static int stb6100_set_bandwidth(struct dvb_frontend *fe, u32 bandwidth)
273 {
274 u32 tmp;
275 int rc;
276 struct stb6100_state *state = fe->tuner_priv;
277
278 dprintk(verbose, FE_DEBUG, 1, "set bandwidth to %u Hz", bandwidth);
279
280 bandwidth /= 2; /* ZIF */
281
282 if (bandwidth >= 36000000) /* F[4:0] BW/2 max =31+5=36 mhz for F=31 */
283 tmp = 31;
284 else if (bandwidth <= 5000000) /* bw/2 min = 5Mhz for F=0 */
285 tmp = 0;
286 else /* if 5 < bw/2 < 36 */
287 tmp = (bandwidth + 500000) / 1000000 - 5;
288
289 /* Turn on LPF bandwidth setting clock control,
290 * set bandwidth, wait 10ms, turn off.
291 */
292 rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d | STB6100_FCCK_FCCK);
293 if (rc < 0)
294 return rc;
295 rc = stb6100_write_reg(state, STB6100_F, 0xc0 | tmp);
296 if (rc < 0)
297 return rc;
298
299 msleep(5); /* This is dangerous as another (related) thread may start */
300
301 rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
302 if (rc < 0)
303 return rc;
304
305 msleep(10); /* This is dangerous as another (related) thread may start */
306
307 return 0;
308 }
309
310 static int stb6100_get_frequency(struct dvb_frontend *fe, u32 *frequency)
311 {
312 int rc;
313 u32 nint, nfrac, fvco;
314 int psd2, odiv;
315 struct stb6100_state *state = fe->tuner_priv;
316 u8 regs[STB6100_NUMREGS];
317
318 rc = stb6100_read_regs(state, regs);
319 if (rc < 0)
320 return rc;
321
322 odiv = (regs[STB6100_VCO] & STB6100_VCO_ODIV) >> STB6100_VCO_ODIV_SHIFT;
323 psd2 = (regs[STB6100_K] & STB6100_K_PSD2) >> STB6100_K_PSD2_SHIFT;
324 nint = regs[STB6100_NI];
325 nfrac = ((regs[STB6100_K] & STB6100_K_NF_MSB) << 8) | regs[STB6100_NF_LSB];
326 fvco = (nfrac * state->reference >> (9 - psd2)) + (nint * state->reference << psd2);
327 *frequency = state->frequency = fvco >> (odiv + 1);
328
329 dprintk(verbose, FE_DEBUG, 1,
330 "frequency = %u kHz, odiv = %u, psd2 = %u, fxtal = %u kHz, fvco = %u kHz, N(I) = %u, N(F) = %u",
331 state->frequency, odiv, psd2, state->reference, fvco, nint, nfrac);
332 return 0;
333 }
334
335
336 static int stb6100_set_frequency(struct dvb_frontend *fe, u32 frequency)
337 {
338 int rc;
339 const struct stb6100_lkup *ptr;
340 struct stb6100_state *state = fe->tuner_priv;
341 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
342
343 u32 srate = 0, fvco, nint, nfrac;
344 u8 regs[STB6100_NUMREGS];
345 u8 g, psd2, odiv;
346
347 dprintk(verbose, FE_DEBUG, 1, "Version 2010-8-14 13:51");
348
349 if (fe->ops.get_frontend) {
350 dprintk(verbose, FE_DEBUG, 1, "Get frontend parameters");
351 fe->ops.get_frontend(fe, p);
352 }
353 srate = p->symbol_rate;
354
355 /* Set up tuner cleanly, LPF calibration on */
356 rc = stb6100_write_reg(state, STB6100_FCCK, 0x4d | STB6100_FCCK_FCCK);
357 if (rc < 0)
358 return rc; /* allow LPF calibration */
359
360 /* PLL Loop disabled, bias on, VCO on, synth on */
361 regs[STB6100_LPEN] = 0xeb;
362 rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
363 if (rc < 0)
364 return rc;
365
366 /* Program the registers with their data values */
367
368 /* VCO divide ratio (LO divide ratio, VCO prescaler enable). */
369 if (frequency <= 1075000)
370 odiv = 1;
371 else
372 odiv = 0;
373
374 /* VCO enabled, search clock off as per LL3.7, 3.4.1 */
375 regs[STB6100_VCO] = 0xe0 | (odiv << STB6100_VCO_ODIV_SHIFT);
376
377 /* OSM */
378 for (ptr = lkup;
379 (ptr->val_high != 0) && !CHKRANGE(frequency, ptr->val_low, ptr->val_high);
380 ptr++);
381
382 if (ptr->val_high == 0) {
383 printk(KERN_ERR "%s: frequency out of range: %u kHz\n", __func__, frequency);
384 return -EINVAL;
385 }
386 regs[STB6100_VCO] = (regs[STB6100_VCO] & ~STB6100_VCO_OSM) | ptr->reg;
387 rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
388 if (rc < 0)
389 return rc;
390
391 if ((frequency > 1075000) && (frequency <= 1325000))
392 psd2 = 0;
393 else
394 psd2 = 1;
395 /* F(VCO) = F(LO) * (ODIV == 0 ? 2 : 4) */
396 fvco = frequency << (1 + odiv);
397 /* N(I) = floor(f(VCO) / (f(XTAL) * (PSD2 ? 2 : 1))) */
398 nint = fvco / (state->reference << psd2);
399 /* N(F) = round(f(VCO) / f(XTAL) * (PSD2 ? 2 : 1) - N(I)) * 2 ^ 9 */
400 nfrac = DIV_ROUND_CLOSEST((fvco - (nint * state->reference << psd2))
401 << (9 - psd2), state->reference);
402
403 /* NI */
404 regs[STB6100_NI] = nint;
405 rc = stb6100_write_reg(state, STB6100_NI, regs[STB6100_NI]);
406 if (rc < 0)
407 return rc;
408
409 /* NF */
410 regs[STB6100_NF_LSB] = nfrac;
411 rc = stb6100_write_reg(state, STB6100_NF_LSB, regs[STB6100_NF_LSB]);
412 if (rc < 0)
413 return rc;
414
415 /* K */
416 regs[STB6100_K] = (0x38 & ~STB6100_K_PSD2) | (psd2 << STB6100_K_PSD2_SHIFT);
417 regs[STB6100_K] = (regs[STB6100_K] & ~STB6100_K_NF_MSB) | ((nfrac >> 8) & STB6100_K_NF_MSB);
418 rc = stb6100_write_reg(state, STB6100_K, regs[STB6100_K]);
419 if (rc < 0)
420 return rc;
421
422 /* G Baseband gain. */
423 if (srate >= 15000000)
424 g = 9; /* +4 dB */
425 else if (srate >= 5000000)
426 g = 11; /* +8 dB */
427 else
428 g = 14; /* +14 dB */
429
430 regs[STB6100_G] = (0x10 & ~STB6100_G_G) | g;
431 regs[STB6100_G] &= ~STB6100_G_GCT; /* mask GCT */
432 regs[STB6100_G] |= (1 << 5); /* 2Vp-p Mode */
433 rc = stb6100_write_reg(state, STB6100_G, regs[STB6100_G]);
434 if (rc < 0)
435 return rc;
436
437 /* F we don't write as it is set up in BW set */
438
439 /* DLB set DC servo loop BW to 160Hz (LLA 3.8 / 2.1) */
440 regs[STB6100_DLB] = 0xcc;
441 rc = stb6100_write_reg(state, STB6100_DLB, regs[STB6100_DLB]);
442 if (rc < 0)
443 return rc;
444
445 dprintk(verbose, FE_DEBUG, 1,
446 "frequency = %u, srate = %u, g = %u, odiv = %u, psd2 = %u, fxtal = %u, osm = %u, fvco = %u, N(I) = %u, N(F) = %u",
447 frequency, srate, (unsigned int)g, (unsigned int)odiv,
448 (unsigned int)psd2, state->reference,
449 ptr->reg, fvco, nint, nfrac);
450
451 /* Set up the test registers */
452 regs[STB6100_TEST1] = 0x8f;
453 rc = stb6100_write_reg(state, STB6100_TEST1, regs[STB6100_TEST1]);
454 if (rc < 0)
455 return rc;
456 regs[STB6100_TEST3] = 0xde;
457 rc = stb6100_write_reg(state, STB6100_TEST3, regs[STB6100_TEST3]);
458 if (rc < 0)
459 return rc;
460
461 /* Bring up tuner according to LLA 3.7 3.4.1, step 2 */
462 regs[STB6100_LPEN] = 0xfb; /* PLL Loop enabled, bias on, VCO on, synth on */
463 rc = stb6100_write_reg(state, STB6100_LPEN, regs[STB6100_LPEN]);
464 if (rc < 0)
465 return rc;
466
467 msleep(2);
468
469 /* Bring up tuner according to LLA 3.7 3.4.1, step 3 */
470 regs[STB6100_VCO] &= ~STB6100_VCO_OCK; /* VCO fast search */
471 rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
472 if (rc < 0)
473 return rc;
474
475 msleep(10); /* This is dangerous as another (related) thread may start */ /* wait for LO to lock */
476
477 regs[STB6100_VCO] &= ~STB6100_VCO_OSCH; /* vco search disabled */
478 regs[STB6100_VCO] |= STB6100_VCO_OCK; /* search clock off */
479 rc = stb6100_write_reg(state, STB6100_VCO, regs[STB6100_VCO]);
480 if (rc < 0)
481 return rc;
482
483 rc = stb6100_write_reg(state, STB6100_FCCK, 0x0d);
484 if (rc < 0)
485 return rc; /* Stop LPF calibration */
486
487 msleep(10); /* This is dangerous as another (related) thread may start */
488 /* wait for stabilisation, (should not be necessary) */
489 return 0;
490 }
491
492 static int stb6100_sleep(struct dvb_frontend *fe)
493 {
494 /* TODO: power down */
495 return 0;
496 }
497
498 static int stb6100_init(struct dvb_frontend *fe)
499 {
500 struct stb6100_state *state = fe->tuner_priv;
501 int refclk = 27000000; /* Hz */
502
503 /*
504 * iqsense = 1
505 * tunerstep = 125000
506 */
507 state->bandwidth = 36000000; /* Hz */
508 state->reference = refclk / 1000; /* kHz */
509
510 /* Set default bandwidth. Modified, PN 13-May-10 */
511 return 0;
512 }
513
514 static int stb6100_set_params(struct dvb_frontend *fe)
515 {
516 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
517
518 if (c->frequency > 0)
519 stb6100_set_frequency(fe, c->frequency);
520
521 if (c->bandwidth_hz > 0)
522 stb6100_set_bandwidth(fe, c->bandwidth_hz);
523
524 return 0;
525 }
526
527 static const struct dvb_tuner_ops stb6100_ops = {
528 .info = {
529 .name = "STB6100 Silicon Tuner",
530 .frequency_min = 950000,
531 .frequency_max = 2150000,
532 .frequency_step = 0,
533 },
534
535 .init = stb6100_init,
536 .sleep = stb6100_sleep,
537 .get_status = stb6100_get_status,
538 .set_params = stb6100_set_params,
539 .get_frequency = stb6100_get_frequency,
540 .get_bandwidth = stb6100_get_bandwidth,
541 .release = stb6100_release
542 };
543
544 struct dvb_frontend *stb6100_attach(struct dvb_frontend *fe,
545 const struct stb6100_config *config,
546 struct i2c_adapter *i2c)
547 {
548 struct stb6100_state *state = NULL;
549
550 state = kzalloc(sizeof (struct stb6100_state), GFP_KERNEL);
551 if (!state)
552 return NULL;
553
554 state->config = config;
555 state->i2c = i2c;
556 state->frontend = fe;
557 state->reference = config->refclock / 1000; /* kHz */
558 fe->tuner_priv = state;
559 fe->ops.tuner_ops = stb6100_ops;
560
561 printk("%s: Attaching STB6100 \n", __func__);
562 return fe;
563 }
564
565 static void stb6100_release(struct dvb_frontend *fe)
566 {
567 struct stb6100_state *state = fe->tuner_priv;
568
569 fe->tuner_priv = NULL;
570 kfree(state);
571 }
572
573 EXPORT_SYMBOL(stb6100_attach);
574 MODULE_PARM_DESC(verbose, "Set Verbosity level");
575
576 MODULE_AUTHOR("Manu Abraham");
577 MODULE_DESCRIPTION("STB6100 Silicon tuner");
578 MODULE_LICENSE("GPL");
Linux with added FPC-III support