2 Driver for M88RS2000 demodulator and tuner
4 Copyright (C) 2012 Malcolm Priestley (tvboxspy@gmail.com)
7 Include various calculation code from DS3000 driver.
8 Copyright (C) 2009 Konstantin Dimitrov.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include <linux/init.h>
26 #include <linux/module.h>
27 #include <linux/device.h>
28 #include <linux/jiffies.h>
29 #include <linux/string.h>
30 #include <linux/slab.h>
31 #include <linux/types.h>
34 #include "dvb_frontend.h"
35 #include "m88rs2000.h"
37 struct m88rs2000_state
{
38 struct i2c_adapter
*i2c
;
39 const struct m88rs2000_config
*config
;
40 struct dvb_frontend frontend
;
44 fe_code_rate_t fec_inner
;
49 static int m88rs2000_debug
;
51 module_param_named(debug
, m88rs2000_debug
, int, 0644);
52 MODULE_PARM_DESC(debug
, "set debugging level (1=info (or-able)).");
54 #define dprintk(level, args...) do { \
55 if (level & m88rs2000_debug) \
56 printk(KERN_DEBUG "m88rs2000-fe: " args); \
59 #define deb_info(args...) dprintk(0x01, args)
60 #define info(format, arg...) \
61 printk(KERN_INFO "m88rs2000-fe: " format "\n" , ## arg)
63 static int m88rs2000_writereg(struct m88rs2000_state
*state
,
67 u8 buf
[] = { reg
, data
};
68 struct i2c_msg msg
= {
69 .addr
= state
->config
->demod_addr
,
75 ret
= i2c_transfer(state
->i2c
, &msg
, 1);
78 deb_info("%s: writereg error (reg == 0x%02x, val == 0x%02x, "
79 "ret == %i)\n", __func__
, reg
, data
, ret
);
81 return (ret
!= 1) ? -EREMOTEIO
: 0;
84 static u8
m88rs2000_readreg(struct m88rs2000_state
*state
, u8 reg
)
90 struct i2c_msg msg
[] = {
92 .addr
= state
->config
->demod_addr
,
97 .addr
= state
->config
->demod_addr
,
104 ret
= i2c_transfer(state
->i2c
, msg
, 2);
107 deb_info("%s: readreg error (reg == 0x%02x, ret == %i)\n",
113 static u32
m88rs2000_get_mclk(struct dvb_frontend
*fe
)
115 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
118 /* Must not be 0x00 or 0xff */
119 reg
= m88rs2000_readreg(state
, 0x86);
120 if (!reg
|| reg
== 0xff)
126 mclk
= (u32
)(reg
* RS2000_FE_CRYSTAL_KHZ
+ 28 / 2) / 28;
131 static int m88rs2000_set_carrieroffset(struct dvb_frontend
*fe
, s16 offset
)
133 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
139 mclk
= m88rs2000_get_mclk(fe
);
143 tmp
= (offset
* 4096 + (s32
)mclk
/ 2) / (s32
)mclk
;
148 ret
= m88rs2000_writereg(state
, 0x9c, (u8
)(tmp
>> 4));
150 reg
= m88rs2000_readreg(state
, 0x9d);
152 reg
|= (u8
)(tmp
& 0xf) << 4;
154 ret
|= m88rs2000_writereg(state
, 0x9d, reg
);
159 static int m88rs2000_set_symbolrate(struct dvb_frontend
*fe
, u32 srate
)
161 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
167 if ((srate
< 1000000) || (srate
> 45000000))
170 mclk
= m88rs2000_get_mclk(fe
);
179 b
[0] = (u8
) (temp
>> 16) & 0xff;
180 b
[1] = (u8
) (temp
>> 8) & 0xff;
181 b
[2] = (u8
) temp
& 0xff;
183 ret
= m88rs2000_writereg(state
, 0x93, b
[2]);
184 ret
|= m88rs2000_writereg(state
, 0x94, b
[1]);
185 ret
|= m88rs2000_writereg(state
, 0x95, b
[0]);
187 if (srate
> 10000000)
188 ret
|= m88rs2000_writereg(state
, 0xa0, 0x20);
190 ret
|= m88rs2000_writereg(state
, 0xa0, 0x60);
192 ret
|= m88rs2000_writereg(state
, 0xa1, 0xe0);
194 if (srate
> 12000000)
195 ret
|= m88rs2000_writereg(state
, 0xa3, 0x20);
196 else if (srate
> 2800000)
197 ret
|= m88rs2000_writereg(state
, 0xa3, 0x98);
199 ret
|= m88rs2000_writereg(state
, 0xa3, 0x90);
201 deb_info("m88rs2000: m88rs2000_set_symbolrate\n");
205 static int m88rs2000_send_diseqc_msg(struct dvb_frontend
*fe
,
206 struct dvb_diseqc_master_cmd
*m
)
208 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
212 deb_info("%s\n", __func__
);
213 m88rs2000_writereg(state
, 0x9a, 0x30);
214 reg
= m88rs2000_readreg(state
, 0xb2);
216 m88rs2000_writereg(state
, 0xb2, reg
);
217 for (i
= 0; i
< m
->msg_len
; i
++)
218 m88rs2000_writereg(state
, 0xb3 + i
, m
->msg
[i
]);
220 reg
= m88rs2000_readreg(state
, 0xb1);
222 reg
|= ((m
->msg_len
- 1) << 3) | 0x07;
224 m88rs2000_writereg(state
, 0xb1, reg
);
226 for (i
= 0; i
< 15; i
++) {
227 if ((m88rs2000_readreg(state
, 0xb1) & 0x40) == 0x0)
232 reg
= m88rs2000_readreg(state
, 0xb1);
233 if ((reg
& 0x40) > 0x0) {
236 m88rs2000_writereg(state
, 0xb1, reg
);
239 reg
= m88rs2000_readreg(state
, 0xb2);
242 m88rs2000_writereg(state
, 0xb2, reg
);
243 m88rs2000_writereg(state
, 0x9a, 0xb0);
249 static int m88rs2000_send_diseqc_burst(struct dvb_frontend
*fe
,
250 fe_sec_mini_cmd_t burst
)
252 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
254 deb_info("%s\n", __func__
);
255 m88rs2000_writereg(state
, 0x9a, 0x30);
257 reg0
= m88rs2000_readreg(state
, 0xb1);
258 reg1
= m88rs2000_readreg(state
, 0xb2);
259 /* TODO complete this section */
260 m88rs2000_writereg(state
, 0xb2, reg1
);
261 m88rs2000_writereg(state
, 0xb1, reg0
);
262 m88rs2000_writereg(state
, 0x9a, 0xb0);
267 static int m88rs2000_set_tone(struct dvb_frontend
*fe
, fe_sec_tone_mode_t tone
)
269 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
271 m88rs2000_writereg(state
, 0x9a, 0x30);
272 reg0
= m88rs2000_readreg(state
, 0xb1);
273 reg1
= m88rs2000_readreg(state
, 0xb2);
288 m88rs2000_writereg(state
, 0xb2, reg1
);
289 m88rs2000_writereg(state
, 0xb1, reg0
);
290 m88rs2000_writereg(state
, 0x9a, 0xb0);
300 struct inittab m88rs2000_setup
[] = {
301 {DEMOD_WRITE
, 0x9a, 0x30},
302 {DEMOD_WRITE
, 0x00, 0x01},
303 {WRITE_DELAY
, 0x19, 0x00},
304 {DEMOD_WRITE
, 0x00, 0x00},
305 {DEMOD_WRITE
, 0x9a, 0xb0},
306 {DEMOD_WRITE
, 0x81, 0xc1},
307 {DEMOD_WRITE
, 0x81, 0x81},
308 {DEMOD_WRITE
, 0x86, 0xc6},
309 {DEMOD_WRITE
, 0x9a, 0x30},
310 {DEMOD_WRITE
, 0xf0, 0x22},
311 {DEMOD_WRITE
, 0xf1, 0xbf},
312 {DEMOD_WRITE
, 0xb0, 0x45},
313 {DEMOD_WRITE
, 0xb2, 0x01}, /* set voltage pin always set 1*/
314 {DEMOD_WRITE
, 0x9a, 0xb0},
318 struct inittab m88rs2000_shutdown
[] = {
319 {DEMOD_WRITE
, 0x9a, 0x30},
320 {DEMOD_WRITE
, 0xb0, 0x00},
321 {DEMOD_WRITE
, 0xf1, 0x89},
322 {DEMOD_WRITE
, 0x00, 0x01},
323 {DEMOD_WRITE
, 0x9a, 0xb0},
324 {DEMOD_WRITE
, 0x81, 0x81},
328 struct inittab fe_reset
[] = {
329 {DEMOD_WRITE
, 0x00, 0x01},
330 {DEMOD_WRITE
, 0x20, 0x81},
331 {DEMOD_WRITE
, 0x21, 0x80},
332 {DEMOD_WRITE
, 0x10, 0x33},
333 {DEMOD_WRITE
, 0x11, 0x44},
334 {DEMOD_WRITE
, 0x12, 0x07},
335 {DEMOD_WRITE
, 0x18, 0x20},
336 {DEMOD_WRITE
, 0x28, 0x04},
337 {DEMOD_WRITE
, 0x29, 0x8e},
338 {DEMOD_WRITE
, 0x3b, 0xff},
339 {DEMOD_WRITE
, 0x32, 0x10},
340 {DEMOD_WRITE
, 0x33, 0x02},
341 {DEMOD_WRITE
, 0x34, 0x30},
342 {DEMOD_WRITE
, 0x35, 0xff},
343 {DEMOD_WRITE
, 0x38, 0x50},
344 {DEMOD_WRITE
, 0x39, 0x68},
345 {DEMOD_WRITE
, 0x3c, 0x7f},
346 {DEMOD_WRITE
, 0x3d, 0x0f},
347 {DEMOD_WRITE
, 0x45, 0x20},
348 {DEMOD_WRITE
, 0x46, 0x24},
349 {DEMOD_WRITE
, 0x47, 0x7c},
350 {DEMOD_WRITE
, 0x48, 0x16},
351 {DEMOD_WRITE
, 0x49, 0x04},
352 {DEMOD_WRITE
, 0x4a, 0x01},
353 {DEMOD_WRITE
, 0x4b, 0x78},
354 {DEMOD_WRITE
, 0X4d, 0xd2},
355 {DEMOD_WRITE
, 0x4e, 0x6d},
356 {DEMOD_WRITE
, 0x50, 0x30},
357 {DEMOD_WRITE
, 0x51, 0x30},
358 {DEMOD_WRITE
, 0x54, 0x7b},
359 {DEMOD_WRITE
, 0x56, 0x09},
360 {DEMOD_WRITE
, 0x58, 0x59},
361 {DEMOD_WRITE
, 0x59, 0x37},
362 {DEMOD_WRITE
, 0x63, 0xfa},
366 struct inittab fe_trigger
[] = {
367 {DEMOD_WRITE
, 0x97, 0x04},
368 {DEMOD_WRITE
, 0x99, 0x77},
369 {DEMOD_WRITE
, 0x9b, 0x64},
370 {DEMOD_WRITE
, 0x9e, 0x00},
371 {DEMOD_WRITE
, 0x9f, 0xf8},
372 {DEMOD_WRITE
, 0x98, 0xff},
373 {DEMOD_WRITE
, 0xc0, 0x0f},
374 {DEMOD_WRITE
, 0x89, 0x01},
375 {DEMOD_WRITE
, 0x00, 0x00},
376 {WRITE_DELAY
, 0x0a, 0x00},
377 {DEMOD_WRITE
, 0x00, 0x01},
378 {DEMOD_WRITE
, 0x00, 0x00},
379 {DEMOD_WRITE
, 0x9a, 0xb0},
383 static int m88rs2000_tab_set(struct m88rs2000_state
*state
,
391 for (i
= 0; i
< 255; i
++) {
392 switch (tab
[i
].cmd
) {
394 ret
= m88rs2000_writereg(state
, tab
[i
].reg
,
402 if (tab
[i
].reg
== 0xaa && tab
[i
].val
== 0xff)
415 static int m88rs2000_set_voltage(struct dvb_frontend
*fe
, fe_sec_voltage_t volt
)
417 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
420 data
= m88rs2000_readreg(state
, 0xb2);
421 data
|= 0x03; /* bit0 V/H, bit1 off/on */
431 case SEC_VOLTAGE_OFF
:
435 m88rs2000_writereg(state
, 0xb2, data
);
440 static int m88rs2000_init(struct dvb_frontend
*fe
)
442 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
445 deb_info("m88rs2000: init chip\n");
446 /* Setup frontend from shutdown/cold */
447 if (state
->config
->inittab
)
448 ret
= m88rs2000_tab_set(state
,
449 (struct inittab
*)state
->config
->inittab
);
451 ret
= m88rs2000_tab_set(state
, m88rs2000_setup
);
456 static int m88rs2000_sleep(struct dvb_frontend
*fe
)
458 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
460 /* Shutdown the frondend */
461 ret
= m88rs2000_tab_set(state
, m88rs2000_shutdown
);
465 static int m88rs2000_read_status(struct dvb_frontend
*fe
, fe_status_t
*status
)
467 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
468 u8 reg
= m88rs2000_readreg(state
, 0x8c);
472 if ((reg
& 0xee) == 0xee) {
473 *status
= FE_HAS_CARRIER
| FE_HAS_SIGNAL
| FE_HAS_VITERBI
474 | FE_HAS_SYNC
| FE_HAS_LOCK
;
475 if (state
->config
->set_ts_params
)
476 state
->config
->set_ts_params(fe
, CALL_IS_READ
);
481 static int m88rs2000_read_ber(struct dvb_frontend
*fe
, u32
*ber
)
483 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
486 m88rs2000_writereg(state
, 0x9a, 0x30);
487 tmp0
= m88rs2000_readreg(state
, 0xd8);
488 if ((tmp0
& 0x10) != 0) {
489 m88rs2000_writereg(state
, 0x9a, 0xb0);
494 *ber
= (m88rs2000_readreg(state
, 0xd7) << 8) |
495 m88rs2000_readreg(state
, 0xd6);
497 tmp1
= m88rs2000_readreg(state
, 0xd9);
498 m88rs2000_writereg(state
, 0xd9, (tmp1
& ~7) | 4);
500 m88rs2000_writereg(state
, 0xd8, (tmp0
& ~8) | 0x30);
501 m88rs2000_writereg(state
, 0xd8, (tmp0
& ~8) | 0x30);
502 m88rs2000_writereg(state
, 0x9a, 0xb0);
507 static int m88rs2000_read_signal_strength(struct dvb_frontend
*fe
,
510 if (fe
->ops
.tuner_ops
.get_rf_strength
)
511 fe
->ops
.tuner_ops
.get_rf_strength(fe
, strength
);
516 static int m88rs2000_read_snr(struct dvb_frontend
*fe
, u16
*snr
)
518 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
520 *snr
= 512 * m88rs2000_readreg(state
, 0x65);
525 static int m88rs2000_read_ucblocks(struct dvb_frontend
*fe
, u32
*ucblocks
)
527 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
530 *ucblocks
= (m88rs2000_readreg(state
, 0xd5) << 8) |
531 m88rs2000_readreg(state
, 0xd4);
532 tmp
= m88rs2000_readreg(state
, 0xd8);
533 m88rs2000_writereg(state
, 0xd8, tmp
& ~0x20);
534 /* needs two times */
535 m88rs2000_writereg(state
, 0xd8, tmp
| 0x20);
536 m88rs2000_writereg(state
, 0xd8, tmp
| 0x20);
541 static int m88rs2000_set_fec(struct m88rs2000_state
*state
,
568 reg
= m88rs2000_readreg(state
, 0x70);
570 ret
= m88rs2000_writereg(state
, 0x70, reg
| fec_set
);
572 ret
|= m88rs2000_writereg(state
, 0x76, 0x8);
577 static fe_code_rate_t
m88rs2000_get_fec(struct m88rs2000_state
*state
)
580 m88rs2000_writereg(state
, 0x9a, 0x30);
581 reg
= m88rs2000_readreg(state
, 0x76);
582 m88rs2000_writereg(state
, 0x9a, 0xb0);
605 static int m88rs2000_set_frontend(struct dvb_frontend
*fe
)
607 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
608 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
615 state
->no_lock_count
= 0;
617 if (c
->delivery_system
!= SYS_DVBS
) {
618 deb_info("%s: unsupported delivery "
619 "system selected (%d)\n",
620 __func__
, c
->delivery_system
);
625 if (fe
->ops
.tuner_ops
.set_params
)
626 ret
= fe
->ops
.tuner_ops
.set_params(fe
);
631 if (fe
->ops
.tuner_ops
.get_frequency
)
632 ret
= fe
->ops
.tuner_ops
.get_frequency(fe
, &tuner_freq
);
637 offset
= (s16
)((s32
)tuner_freq
- c
->frequency
);
639 /* default mclk value 96.4285 * 2 * 1000 = 192857 */
640 if (((c
->frequency
% 192857) >= (192857 - 3000)) ||
641 (c
->frequency
% 192857) <= 3000)
642 ret
= m88rs2000_writereg(state
, 0x86, 0xc2);
644 ret
= m88rs2000_writereg(state
, 0x86, 0xc6);
646 ret
|= m88rs2000_set_carrieroffset(fe
, offset
);
650 /* Reset demod by symbol rate */
651 if (c
->symbol_rate
> 27500000)
652 ret
= m88rs2000_writereg(state
, 0xf1, 0xa4);
654 ret
= m88rs2000_writereg(state
, 0xf1, 0xbf);
656 ret
|= m88rs2000_tab_set(state
, fe_reset
);
661 ret
= m88rs2000_set_fec(state
, c
->fec_inner
);
662 ret
|= m88rs2000_writereg(state
, 0x85, 0x1);
663 ret
|= m88rs2000_writereg(state
, 0x8a, 0xbf);
664 ret
|= m88rs2000_writereg(state
, 0x8d, 0x1e);
665 ret
|= m88rs2000_writereg(state
, 0x90, 0xf1);
666 ret
|= m88rs2000_writereg(state
, 0x91, 0x08);
671 /* Set Symbol Rate */
672 ret
= m88rs2000_set_symbolrate(fe
, c
->symbol_rate
);
677 ret
= m88rs2000_tab_set(state
, fe_trigger
);
681 for (i
= 0; i
< 25; i
++) {
682 reg
= m88rs2000_readreg(state
, 0x8c);
683 if ((reg
& 0xee) == 0xee) {
684 status
= FE_HAS_LOCK
;
687 state
->no_lock_count
++;
688 if (state
->no_lock_count
== 15) {
689 reg
= m88rs2000_readreg(state
, 0x70);
691 m88rs2000_writereg(state
, 0x70, reg
);
692 state
->no_lock_count
= 0;
697 if (status
& FE_HAS_LOCK
) {
698 state
->fec_inner
= m88rs2000_get_fec(state
);
699 /* Uknown suspect SNR level */
700 reg
= m88rs2000_readreg(state
, 0x65);
703 state
->tuner_frequency
= c
->frequency
;
704 state
->symbol_rate
= c
->symbol_rate
;
708 static int m88rs2000_get_frontend(struct dvb_frontend
*fe
)
710 struct dtv_frontend_properties
*c
= &fe
->dtv_property_cache
;
711 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
712 c
->fec_inner
= state
->fec_inner
;
713 c
->frequency
= state
->tuner_frequency
;
714 c
->symbol_rate
= state
->symbol_rate
;
718 static int m88rs2000_i2c_gate_ctrl(struct dvb_frontend
*fe
, int enable
)
720 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
723 m88rs2000_writereg(state
, 0x81, 0x84);
725 m88rs2000_writereg(state
, 0x81, 0x81);
730 static void m88rs2000_release(struct dvb_frontend
*fe
)
732 struct m88rs2000_state
*state
= fe
->demodulator_priv
;
736 static struct dvb_frontend_ops m88rs2000_ops
= {
737 .delsys
= { SYS_DVBS
},
739 .name
= "M88RS2000 DVB-S",
740 .frequency_min
= 950000,
741 .frequency_max
= 2150000,
742 .frequency_stepsize
= 1000, /* kHz for QPSK frontends */
743 .frequency_tolerance
= 5000,
744 .symbol_rate_min
= 1000000,
745 .symbol_rate_max
= 45000000,
746 .symbol_rate_tolerance
= 500, /* ppm */
747 .caps
= FE_CAN_FEC_1_2
| FE_CAN_FEC_2_3
| FE_CAN_FEC_3_4
|
748 FE_CAN_FEC_5_6
| FE_CAN_FEC_7_8
|
753 .release
= m88rs2000_release
,
754 .init
= m88rs2000_init
,
755 .sleep
= m88rs2000_sleep
,
756 .i2c_gate_ctrl
= m88rs2000_i2c_gate_ctrl
,
757 .read_status
= m88rs2000_read_status
,
758 .read_ber
= m88rs2000_read_ber
,
759 .read_signal_strength
= m88rs2000_read_signal_strength
,
760 .read_snr
= m88rs2000_read_snr
,
761 .read_ucblocks
= m88rs2000_read_ucblocks
,
762 .diseqc_send_master_cmd
= m88rs2000_send_diseqc_msg
,
763 .diseqc_send_burst
= m88rs2000_send_diseqc_burst
,
764 .set_tone
= m88rs2000_set_tone
,
765 .set_voltage
= m88rs2000_set_voltage
,
767 .set_frontend
= m88rs2000_set_frontend
,
768 .get_frontend
= m88rs2000_get_frontend
,
771 struct dvb_frontend
*m88rs2000_attach(const struct m88rs2000_config
*config
,
772 struct i2c_adapter
*i2c
)
774 struct m88rs2000_state
*state
= NULL
;
776 /* allocate memory for the internal state */
777 state
= kzalloc(sizeof(struct m88rs2000_state
), GFP_KERNEL
);
781 /* setup the state */
782 state
->config
= config
;
784 state
->tuner_frequency
= 0;
785 state
->symbol_rate
= 0;
786 state
->fec_inner
= 0;
788 /* create dvb_frontend */
789 memcpy(&state
->frontend
.ops
, &m88rs2000_ops
,
790 sizeof(struct dvb_frontend_ops
));
791 state
->frontend
.demodulator_priv
= state
;
792 return &state
->frontend
;
799 EXPORT_SYMBOL(m88rs2000_attach
);
801 MODULE_DESCRIPTION("M88RS2000 DVB-S Demodulator driver");
802 MODULE_AUTHOR("Malcolm Priestley tvboxspy@gmail.com");
803 MODULE_LICENSE("GPL");
804 MODULE_VERSION("1.13");