[SCSI] libfc: remove redundant timer init for fcp
[sfrench/cifs-2.6.git] / drivers / media / dvb / dvb-usb / mxl111sf-demod.c
1 /*
2  *  mxl111sf-demod.c - driver for the MaxLinear MXL111SF DVB-T demodulator
3  *
4  *  Copyright (C) 2010 Michael Krufky <mkrufky@kernellabs.com>
5  *
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.
10  *
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
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19  */
20
21 #include "mxl111sf-demod.h"
22 #include "mxl111sf-reg.h"
23
24 /* debug */
25 static int mxl111sf_demod_debug;
26 module_param_named(debug, mxl111sf_demod_debug, int, 0644);
27 MODULE_PARM_DESC(debug, "set debugging level (1=info (or-able)).");
28
29 #define mxl_dbg(fmt, arg...) \
30         if (mxl111sf_demod_debug) \
31                 mxl_printk(KERN_DEBUG, fmt, ##arg)
32
33 /* ------------------------------------------------------------------------ */
34
35 struct mxl111sf_demod_state {
36         struct mxl111sf_state *mxl_state;
37
38         struct mxl111sf_demod_config *cfg;
39
40         struct dvb_frontend fe;
41 };
42
43 /* ------------------------------------------------------------------------ */
44
45 static int mxl111sf_demod_read_reg(struct mxl111sf_demod_state *state,
46                                    u8 addr, u8 *data)
47 {
48         return (state->cfg->read_reg) ?
49                 state->cfg->read_reg(state->mxl_state, addr, data) :
50                 -EINVAL;
51 }
52
53 static int mxl111sf_demod_write_reg(struct mxl111sf_demod_state *state,
54                                     u8 addr, u8 data)
55 {
56         return (state->cfg->write_reg) ?
57                 state->cfg->write_reg(state->mxl_state, addr, data) :
58                 -EINVAL;
59 }
60
61 static
62 int mxl111sf_demod_program_regs(struct mxl111sf_demod_state *state,
63                                 struct mxl111sf_reg_ctrl_info *ctrl_reg_info)
64 {
65         return (state->cfg->program_regs) ?
66                 state->cfg->program_regs(state->mxl_state, ctrl_reg_info) :
67                 -EINVAL;
68 }
69
70 /* ------------------------------------------------------------------------ */
71 /* TPS */
72
73 static
74 int mxl1x1sf_demod_get_tps_code_rate(struct mxl111sf_demod_state *state,
75                                      fe_code_rate_t *code_rate)
76 {
77         u8 val;
78         int ret = mxl111sf_demod_read_reg(state, V6_CODE_RATE_TPS_REG, &val);
79         /* bit<2:0> - 000:1/2, 001:2/3, 010:3/4, 011:5/6, 100:7/8 */
80         if (mxl_fail(ret))
81                 goto fail;
82
83         switch (val & V6_CODE_RATE_TPS_MASK) {
84         case 0:
85                 *code_rate = FEC_1_2;
86                 break;
87         case 1:
88                 *code_rate = FEC_2_3;
89                 break;
90         case 2:
91                 *code_rate = FEC_3_4;
92                 break;
93         case 3:
94                 *code_rate = FEC_5_6;
95                 break;
96         case 4:
97                 *code_rate = FEC_7_8;
98                 break;
99         }
100 fail:
101         return ret;
102 }
103
104 static
105 int mxl1x1sf_demod_get_tps_constellation(struct mxl111sf_demod_state *state,
106                                          fe_modulation_t *constellation)
107 {
108         u8 val;
109         int ret = mxl111sf_demod_read_reg(state, V6_MODORDER_TPS_REG, &val);
110         /* Constellation, 00 : QPSK, 01 : 16QAM, 10:64QAM */
111         if (mxl_fail(ret))
112                 goto fail;
113
114         switch ((val & V6_PARAM_CONSTELLATION_MASK) >> 4) {
115         case 0:
116                 *constellation = QPSK;
117                 break;
118         case 1:
119                 *constellation = QAM_16;
120                 break;
121         case 2:
122                 *constellation = QAM_64;
123                 break;
124         }
125 fail:
126         return ret;
127 }
128
129 static
130 int mxl1x1sf_demod_get_tps_guard_fft_mode(struct mxl111sf_demod_state *state,
131                                           fe_transmit_mode_t *fft_mode)
132 {
133         u8 val;
134         int ret = mxl111sf_demod_read_reg(state, V6_MODE_TPS_REG, &val);
135         /* FFT Mode, 00:2K, 01:8K, 10:4K */
136         if (mxl_fail(ret))
137                 goto fail;
138
139         switch ((val & V6_PARAM_FFT_MODE_MASK) >> 2) {
140         case 0:
141                 *fft_mode = TRANSMISSION_MODE_2K;
142                 break;
143         case 1:
144                 *fft_mode = TRANSMISSION_MODE_8K;
145                 break;
146         case 2:
147                 *fft_mode = TRANSMISSION_MODE_4K;
148                 break;
149         }
150 fail:
151         return ret;
152 }
153
154 static
155 int mxl1x1sf_demod_get_tps_guard_interval(struct mxl111sf_demod_state *state,
156                                           fe_guard_interval_t *guard)
157 {
158         u8 val;
159         int ret = mxl111sf_demod_read_reg(state, V6_CP_TPS_REG, &val);
160         /* 00:1/32, 01:1/16, 10:1/8, 11:1/4 */
161         if (mxl_fail(ret))
162                 goto fail;
163
164         switch ((val & V6_PARAM_GI_MASK) >> 4) {
165         case 0:
166                 *guard = GUARD_INTERVAL_1_32;
167                 break;
168         case 1:
169                 *guard = GUARD_INTERVAL_1_16;
170                 break;
171         case 2:
172                 *guard = GUARD_INTERVAL_1_8;
173                 break;
174         case 3:
175                 *guard = GUARD_INTERVAL_1_4;
176                 break;
177         }
178 fail:
179         return ret;
180 }
181
182 static
183 int mxl1x1sf_demod_get_tps_hierarchy(struct mxl111sf_demod_state *state,
184                                      fe_hierarchy_t *hierarchy)
185 {
186         u8 val;
187         int ret = mxl111sf_demod_read_reg(state, V6_TPS_HIERACHY_REG, &val);
188         /* bit<6:4> - 000:Non hierarchy, 001:1, 010:2, 011:4 */
189         if (mxl_fail(ret))
190                 goto fail;
191
192         switch ((val & V6_TPS_HIERARCHY_INFO_MASK) >> 6) {
193         case 0:
194                 *hierarchy = HIERARCHY_NONE;
195                 break;
196         case 1:
197                 *hierarchy = HIERARCHY_1;
198                 break;
199         case 2:
200                 *hierarchy = HIERARCHY_2;
201                 break;
202         case 3:
203                 *hierarchy = HIERARCHY_4;
204                 break;
205         }
206 fail:
207         return ret;
208 }
209
210 /* ------------------------------------------------------------------------ */
211 /* LOCKS */
212
213 static
214 int mxl1x1sf_demod_get_sync_lock_status(struct mxl111sf_demod_state *state,
215                                         int *sync_lock)
216 {
217         u8 val = 0;
218         int ret = mxl111sf_demod_read_reg(state, V6_SYNC_LOCK_REG, &val);
219         if (mxl_fail(ret))
220                 goto fail;
221         *sync_lock = (val & SYNC_LOCK_MASK) >> 4;
222 fail:
223         return ret;
224 }
225
226 static
227 int mxl1x1sf_demod_get_rs_lock_status(struct mxl111sf_demod_state *state,
228                                       int *rs_lock)
229 {
230         u8 val = 0;
231         int ret = mxl111sf_demod_read_reg(state, V6_RS_LOCK_DET_REG, &val);
232         if (mxl_fail(ret))
233                 goto fail;
234         *rs_lock = (val & RS_LOCK_DET_MASK) >> 3;
235 fail:
236         return ret;
237 }
238
239 static
240 int mxl1x1sf_demod_get_tps_lock_status(struct mxl111sf_demod_state *state,
241                                        int *tps_lock)
242 {
243         u8 val = 0;
244         int ret = mxl111sf_demod_read_reg(state, V6_TPS_LOCK_REG, &val);
245         if (mxl_fail(ret))
246                 goto fail;
247         *tps_lock = (val & V6_PARAM_TPS_LOCK_MASK) >> 6;
248 fail:
249         return ret;
250 }
251
252 static
253 int mxl1x1sf_demod_get_fec_lock_status(struct mxl111sf_demod_state *state,
254                                        int *fec_lock)
255 {
256         u8 val = 0;
257         int ret = mxl111sf_demod_read_reg(state, V6_IRQ_STATUS_REG, &val);
258         if (mxl_fail(ret))
259                 goto fail;
260         *fec_lock = (val & IRQ_MASK_FEC_LOCK) >> 4;
261 fail:
262         return ret;
263 }
264
265 #if 0
266 static
267 int mxl1x1sf_demod_get_cp_lock_status(struct mxl111sf_demod_state *state,
268                                       int *cp_lock)
269 {
270         u8 val = 0;
271         int ret = mxl111sf_demod_read_reg(state, V6_CP_LOCK_DET_REG, &val);
272         if (mxl_fail(ret))
273                 goto fail;
274         *cp_lock = (val & V6_CP_LOCK_DET_MASK) >> 2;
275 fail:
276         return ret;
277 }
278 #endif
279
280 static int mxl1x1sf_demod_reset_irq_status(struct mxl111sf_demod_state *state)
281 {
282         return mxl111sf_demod_write_reg(state, 0x0e, 0xff);
283 }
284
285 /* ------------------------------------------------------------------------ */
286
287 static int mxl111sf_demod_set_frontend(struct dvb_frontend *fe,
288                                        struct dvb_frontend_parameters *param)
289 {
290         struct mxl111sf_demod_state *state = fe->demodulator_priv;
291         int ret = 0;
292
293         struct mxl111sf_reg_ctrl_info phy_pll_patch[] = {
294                 {0x00, 0xff, 0x01}, /* change page to 1 */
295                 {0x40, 0xff, 0x05},
296                 {0x40, 0xff, 0x01},
297                 {0x41, 0xff, 0xca},
298                 {0x41, 0xff, 0xc0},
299                 {0x00, 0xff, 0x00}, /* change page to 0 */
300                 {0,    0,    0}
301         };
302
303         mxl_dbg("()");
304
305         if (fe->ops.tuner_ops.set_params) {
306                 ret = fe->ops.tuner_ops.set_params(fe, param);
307                 if (mxl_fail(ret))
308                         goto fail;
309                 msleep(50);
310         }
311         ret = mxl111sf_demod_program_regs(state, phy_pll_patch);
312         mxl_fail(ret);
313         msleep(50);
314         ret = mxl1x1sf_demod_reset_irq_status(state);
315         mxl_fail(ret);
316         msleep(100);
317 fail:
318         return ret;
319 }
320
321 /* ------------------------------------------------------------------------ */
322
323 #if 0
324 /* resets TS Packet error count */
325 /* After setting 7th bit of V5_PER_COUNT_RESET_REG, it should be reset to 0. */
326 static
327 int mxl1x1sf_demod_reset_packet_error_count(struct mxl111sf_demod_state *state)
328 {
329         struct mxl111sf_reg_ctrl_info reset_per_count[] = {
330                 {0x20, 0x01, 0x01},
331                 {0x20, 0x01, 0x00},
332                 {0,    0,    0}
333         };
334         return mxl111sf_demod_program_regs(state, reset_per_count);
335 }
336 #endif
337
338 /* returns TS Packet error count */
339 /* PER Count = FEC_PER_COUNT * (2 ** (FEC_PER_SCALE * 4)) */
340 static int mxl111sf_demod_read_ucblocks(struct dvb_frontend *fe, u32 *ucblocks)
341 {
342         struct mxl111sf_demod_state *state = fe->demodulator_priv;
343         u32 fec_per_count, fec_per_scale;
344         u8 val;
345         int ret;
346
347         *ucblocks = 0;
348
349         /* FEC_PER_COUNT Register */
350         ret = mxl111sf_demod_read_reg(state, V6_FEC_PER_COUNT_REG, &val);
351         if (mxl_fail(ret))
352                 goto fail;
353
354         fec_per_count = val;
355
356         /* FEC_PER_SCALE Register */
357         ret = mxl111sf_demod_read_reg(state, V6_FEC_PER_SCALE_REG, &val);
358         if (mxl_fail(ret))
359                 goto fail;
360
361         val &= V6_FEC_PER_SCALE_MASK;
362         val *= 4;
363
364         fec_per_scale = 1 << val;
365
366         fec_per_count *= fec_per_scale;
367
368         *ucblocks = fec_per_count;
369 fail:
370         return ret;
371 }
372
373 #ifdef MXL111SF_DEMOD_ENABLE_CALCULATIONS
374 /* FIXME: leaving this enabled breaks the build on some architectures,
375  * and we shouldn't have any floating point math in the kernel, anyway.
376  *
377  * These macros need to be re-written, but it's harmless to simply
378  * return zero for now. */
379 #define CALCULATE_BER(avg_errors, count) \
380         ((u32)(avg_errors * 4)/(count*64*188*8))
381 #define CALCULATE_SNR(data) \
382         ((u32)((10 * (u32)data / 64) - 2.5))
383 #else
384 #define CALCULATE_BER(avg_errors, count) 0
385 #define CALCULATE_SNR(data) 0
386 #endif
387
388 static int mxl111sf_demod_read_ber(struct dvb_frontend *fe, u32 *ber)
389 {
390         struct mxl111sf_demod_state *state = fe->demodulator_priv;
391         u8 val1, val2, val3;
392         int ret;
393
394         *ber = 0;
395
396         ret = mxl111sf_demod_read_reg(state, V6_RS_AVG_ERRORS_LSB_REG, &val1);
397         if (mxl_fail(ret))
398                 goto fail;
399         ret = mxl111sf_demod_read_reg(state, V6_RS_AVG_ERRORS_MSB_REG, &val2);
400         if (mxl_fail(ret))
401                 goto fail;
402         ret = mxl111sf_demod_read_reg(state, V6_N_ACCUMULATE_REG, &val3);
403         if (mxl_fail(ret))
404                 goto fail;
405
406         *ber = CALCULATE_BER((val1 | (val2 << 8)), val3);
407 fail:
408         return ret;
409 }
410
411 static int mxl111sf_demod_calc_snr(struct mxl111sf_demod_state *state,
412                                    u16 *snr)
413 {
414         u8 val1, val2;
415         int ret;
416
417         *snr = 0;
418
419         ret = mxl111sf_demod_read_reg(state, V6_SNR_RB_LSB_REG, &val1);
420         if (mxl_fail(ret))
421                 goto fail;
422         ret = mxl111sf_demod_read_reg(state, V6_SNR_RB_MSB_REG, &val2);
423         if (mxl_fail(ret))
424                 goto fail;
425
426         *snr = CALCULATE_SNR(val1 | ((val2 & 0x03) << 8));
427 fail:
428         return ret;
429 }
430
431 static int mxl111sf_demod_read_snr(struct dvb_frontend *fe, u16 *snr)
432 {
433         struct mxl111sf_demod_state *state = fe->demodulator_priv;
434
435         int ret = mxl111sf_demod_calc_snr(state, snr);
436         if (mxl_fail(ret))
437                 goto fail;
438
439         *snr /= 10; /* 0.1 dB */
440 fail:
441         return ret;
442 }
443
444 static int mxl111sf_demod_read_status(struct dvb_frontend *fe,
445                                       fe_status_t *status)
446 {
447         struct mxl111sf_demod_state *state = fe->demodulator_priv;
448         int ret, locked, cr_lock, sync_lock, fec_lock;
449
450         *status = 0;
451
452         ret = mxl1x1sf_demod_get_rs_lock_status(state, &locked);
453         if (mxl_fail(ret))
454                 goto fail;
455         ret = mxl1x1sf_demod_get_tps_lock_status(state, &cr_lock);
456         if (mxl_fail(ret))
457                 goto fail;
458         ret = mxl1x1sf_demod_get_sync_lock_status(state, &sync_lock);
459         if (mxl_fail(ret))
460                 goto fail;
461         ret = mxl1x1sf_demod_get_fec_lock_status(state, &fec_lock);
462         if (mxl_fail(ret))
463                 goto fail;
464
465         if (locked)
466                 *status |= FE_HAS_SIGNAL;
467         if (cr_lock)
468                 *status |= FE_HAS_CARRIER;
469         if (sync_lock)
470                 *status |= FE_HAS_SYNC;
471         if (fec_lock) /* false positives? */
472                 *status |= FE_HAS_VITERBI;
473
474         if ((locked) && (cr_lock) && (sync_lock))
475                 *status |= FE_HAS_LOCK;
476 fail:
477         return ret;
478 }
479
480 static int mxl111sf_demod_read_signal_strength(struct dvb_frontend *fe,
481                                                u16 *signal_strength)
482 {
483         struct mxl111sf_demod_state *state = fe->demodulator_priv;
484         fe_modulation_t constellation;
485         u16 snr;
486
487         mxl111sf_demod_calc_snr(state, &snr);
488         mxl1x1sf_demod_get_tps_constellation(state, &constellation);
489
490         switch (constellation) {
491         case QPSK:
492                 *signal_strength = (snr >= 1300) ?
493                         min(65535, snr * 44) : snr * 38;
494                 break;
495         case QAM_16:
496                 *signal_strength = (snr >= 1500) ?
497                         min(65535, snr * 38) : snr * 33;
498                 break;
499         case QAM_64:
500                 *signal_strength = (snr >= 2000) ?
501                         min(65535, snr * 29) : snr * 25;
502                 break;
503         default:
504                 *signal_strength = 0;
505                 return -EINVAL;
506         }
507
508         return 0;
509 }
510
511 static int mxl111sf_demod_get_frontend(struct dvb_frontend *fe,
512                                        struct dvb_frontend_parameters *p)
513 {
514         struct mxl111sf_demod_state *state = fe->demodulator_priv;
515
516         mxl_dbg("()");
517 #if 0
518         p->inversion = /* FIXME */ ? INVERSION_ON : INVERSION_OFF;
519 #endif
520         if (fe->ops.tuner_ops.get_bandwidth)
521                 fe->ops.tuner_ops.get_bandwidth(fe, &p->u.ofdm.bandwidth);
522         if (fe->ops.tuner_ops.get_frequency)
523                 fe->ops.tuner_ops.get_frequency(fe, &p->frequency);
524         mxl1x1sf_demod_get_tps_code_rate(state, &p->u.ofdm.code_rate_HP);
525         mxl1x1sf_demod_get_tps_code_rate(state, &p->u.ofdm.code_rate_LP);
526         mxl1x1sf_demod_get_tps_constellation(state, &p->u.ofdm.constellation);
527         mxl1x1sf_demod_get_tps_guard_fft_mode(state,
528                                               &p->u.ofdm.transmission_mode);
529         mxl1x1sf_demod_get_tps_guard_interval(state,
530                                               &p->u.ofdm.guard_interval);
531         mxl1x1sf_demod_get_tps_hierarchy(state,
532                                          &p->u.ofdm.hierarchy_information);
533
534         return 0;
535 }
536
537 static
538 int mxl111sf_demod_get_tune_settings(struct dvb_frontend *fe,
539                                      struct dvb_frontend_tune_settings *tune)
540 {
541         tune->min_delay_ms = 1000;
542         return 0;
543 }
544
545 static void mxl111sf_demod_release(struct dvb_frontend *fe)
546 {
547         struct mxl111sf_demod_state *state = fe->demodulator_priv;
548         mxl_dbg("()");
549         kfree(state);
550         fe->demodulator_priv = NULL;
551 }
552
553 static struct dvb_frontend_ops mxl111sf_demod_ops = {
554
555         .info = {
556                 .name               = "MaxLinear MxL111SF DVB-T demodulator",
557                 .type               = FE_OFDM,
558                 .frequency_min      = 177000000,
559                 .frequency_max      = 858000000,
560                 .frequency_stepsize = 166666,
561                 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
562                         FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
563                         FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 |
564                         FE_CAN_QAM_AUTO |
565                         FE_CAN_HIERARCHY_AUTO | FE_CAN_GUARD_INTERVAL_AUTO |
566                         FE_CAN_TRANSMISSION_MODE_AUTO | FE_CAN_RECOVER
567         },
568         .release              = mxl111sf_demod_release,
569 #if 0
570         .init                 = mxl111sf_init,
571         .i2c_gate_ctrl        = mxl111sf_i2c_gate_ctrl,
572 #endif
573         .set_frontend         = mxl111sf_demod_set_frontend,
574         .get_frontend         = mxl111sf_demod_get_frontend,
575         .get_tune_settings    = mxl111sf_demod_get_tune_settings,
576         .read_status          = mxl111sf_demod_read_status,
577         .read_signal_strength = mxl111sf_demod_read_signal_strength,
578         .read_ber             = mxl111sf_demod_read_ber,
579         .read_snr             = mxl111sf_demod_read_snr,
580         .read_ucblocks        = mxl111sf_demod_read_ucblocks,
581 };
582
583 struct dvb_frontend *mxl111sf_demod_attach(struct mxl111sf_state *mxl_state,
584                                            struct mxl111sf_demod_config *cfg)
585 {
586         struct mxl111sf_demod_state *state = NULL;
587
588         mxl_dbg("()");
589
590         state = kzalloc(sizeof(struct mxl111sf_demod_state), GFP_KERNEL);
591         if (state == NULL)
592                 return NULL;
593
594         state->mxl_state = mxl_state;
595         state->cfg = cfg;
596
597         memcpy(&state->fe.ops, &mxl111sf_demod_ops,
598                sizeof(struct dvb_frontend_ops));
599
600         state->fe.demodulator_priv = state;
601         return &state->fe;
602 }
603 EXPORT_SYMBOL_GPL(mxl111sf_demod_attach);
604
605 MODULE_DESCRIPTION("MaxLinear MxL111SF DVB-T demodulator driver");
606 MODULE_AUTHOR("Michael Krufky <mkrufky@kernellabs.com>");
607 MODULE_LICENSE("GPL");
608 MODULE_VERSION("0.1");
609
610 /*
611  * Local variables:
612  * c-basic-offset: 8
613  * End:
614  */