2 Driver for the Spase sp887x demodulator
7 #include <linux/init.h>
8 #include <linux/module.h>
9 #include <linux/device.h>
10 #include <linux/firmware.h>
11 #include <linux/string.h>
12 #include <linux/slab.h>
14 #include "dvb_frontend.h"
19 struct i2c_adapter* i2c;
20 const struct sp887x_config* config;
21 struct dvb_frontend frontend;
23 /* demodulator private data */
28 #define dprintk(args...) \
30 if (debug) printk(KERN_DEBUG "sp887x: " args); \
33 static int i2c_writebytes (struct sp887x_state* state, u8 *buf, u8 len)
35 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = len };
38 if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
39 printk ("%s: i2c write error (addr %02x, err == %i)\n",
40 __func__, state->config->demod_address, err);
47 static int sp887x_writereg (struct sp887x_state* state, u16 reg, u16 data)
49 u8 b0 [] = { reg >> 8 , reg & 0xff, data >> 8, data & 0xff };
50 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 4 };
53 if ((ret = i2c_transfer(state->i2c, &msg, 1)) != 1) {
55 * in case of soft reset we ignore ACK errors...
57 if (!(reg == 0xf1a && data == 0x000 &&
58 (ret == -EREMOTEIO || ret == -EFAULT)))
60 printk("%s: writereg error (reg %03x, data %03x, ret == %i)\n",
61 __func__, reg & 0xffff, data & 0xffff, ret);
69 static int sp887x_readreg (struct sp887x_state* state, u16 reg)
71 u8 b0 [] = { reg >> 8 , reg & 0xff };
74 struct i2c_msg msg[] = {{ .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 2 },
75 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 2 }};
77 if ((ret = i2c_transfer(state->i2c, msg, 2)) != 2) {
78 printk("%s: readreg error (ret == %i)\n", __func__, ret);
82 return (((b1[0] << 8) | b1[1]) & 0xfff);
85 static void sp887x_microcontroller_stop (struct sp887x_state* state)
87 dprintk("%s\n", __func__);
88 sp887x_writereg(state, 0xf08, 0x000);
89 sp887x_writereg(state, 0xf09, 0x000);
91 /* microcontroller STOP */
92 sp887x_writereg(state, 0xf00, 0x000);
95 static void sp887x_microcontroller_start (struct sp887x_state* state)
97 dprintk("%s\n", __func__);
98 sp887x_writereg(state, 0xf08, 0x000);
99 sp887x_writereg(state, 0xf09, 0x000);
101 /* microcontroller START */
102 sp887x_writereg(state, 0xf00, 0x001);
105 static void sp887x_setup_agc (struct sp887x_state* state)
107 /* setup AGC parameters */
108 dprintk("%s\n", __func__);
109 sp887x_writereg(state, 0x33c, 0x054);
110 sp887x_writereg(state, 0x33b, 0x04c);
111 sp887x_writereg(state, 0x328, 0x000);
112 sp887x_writereg(state, 0x327, 0x005);
113 sp887x_writereg(state, 0x326, 0x001);
114 sp887x_writereg(state, 0x325, 0x001);
115 sp887x_writereg(state, 0x324, 0x001);
116 sp887x_writereg(state, 0x318, 0x050);
117 sp887x_writereg(state, 0x317, 0x3fe);
118 sp887x_writereg(state, 0x316, 0x001);
119 sp887x_writereg(state, 0x313, 0x005);
120 sp887x_writereg(state, 0x312, 0x002);
121 sp887x_writereg(state, 0x306, 0x000);
122 sp887x_writereg(state, 0x303, 0x000);
126 #define FW_SIZE 0x4000
128 * load firmware and setup MPEG interface...
130 static int sp887x_initial_setup (struct dvb_frontend* fe, const struct firmware *fw)
132 struct sp887x_state* state = fe->demodulator_priv;
133 u8 buf [BLOCKSIZE+2];
135 int fw_size = fw->size;
136 const unsigned char *mem = fw->data;
138 dprintk("%s\n", __func__);
140 /* ignore the first 10 bytes, then we expect 0x4000 bytes of firmware */
141 if (fw_size < FW_SIZE+10)
147 sp887x_writereg(state, 0xf1a, 0x000);
149 sp887x_microcontroller_stop (state);
151 printk ("%s: firmware upload... ", __func__);
153 /* setup write pointer to -1 (end of memory) */
154 /* bit 0x8000 in address is set to enable 13bit mode */
155 sp887x_writereg(state, 0x8f08, 0x1fff);
157 /* dummy write (wrap around to start of memory) */
158 sp887x_writereg(state, 0x8f0a, 0x0000);
160 for (i = 0; i < FW_SIZE; i += BLOCKSIZE) {
167 /* bit 0x8000 in address is set to enable 13bit mode */
168 /* bit 0x4000 enables multibyte read/write transfers */
169 /* write register is 0xf0a */
173 memcpy(&buf[2], mem + i, c);
175 if ((err = i2c_writebytes (state, buf, c+2)) < 0) {
176 printk ("failed.\n");
177 printk ("%s: i2c error (err == %i)\n", __func__, err);
182 /* don't write RS bytes between packets */
183 sp887x_writereg(state, 0xc13, 0x001);
185 /* suppress clock if (!data_valid) */
186 sp887x_writereg(state, 0xc14, 0x000);
188 /* setup MPEG interface... */
189 sp887x_writereg(state, 0xc1a, 0x872);
190 sp887x_writereg(state, 0xc1b, 0x001);
191 sp887x_writereg(state, 0xc1c, 0x000); /* parallel mode (serial mode == 1) */
192 sp887x_writereg(state, 0xc1a, 0x871);
194 /* ADC mode, 2 for MT8872, 3 for SP8870/SP8871 */
195 sp887x_writereg(state, 0x301, 0x002);
197 sp887x_setup_agc(state);
199 /* bit 0x010: enable data valid signal */
200 sp887x_writereg(state, 0xd00, 0x010);
201 sp887x_writereg(state, 0x0d1, 0x000);
205 static int configure_reg0xc05(struct dtv_frontend_properties *p, u16 *reg0xc05)
207 int known_parameters = 1;
211 switch (p->modulation) {
215 *reg0xc05 |= (1 << 10);
218 *reg0xc05 |= (2 << 10);
221 known_parameters = 0;
227 switch (p->hierarchy) {
231 *reg0xc05 |= (1 << 7);
234 *reg0xc05 |= (2 << 7);
237 *reg0xc05 |= (3 << 7);
240 known_parameters = 0;
246 switch (p->code_rate_HP) {
250 *reg0xc05 |= (1 << 3);
253 *reg0xc05 |= (2 << 3);
256 *reg0xc05 |= (3 << 3);
259 *reg0xc05 |= (4 << 3);
262 known_parameters = 0;
268 if (known_parameters)
269 *reg0xc05 |= (2 << 1); /* use specified parameters */
271 *reg0xc05 |= (1 << 1); /* enable autoprobing */
277 * estimates division of two 24bit numbers,
278 * derived from the ves1820/stv0299 driver code
280 static void divide (int n, int d, int *quotient_i, int *quotient_f)
292 q = (q << 8) | (r / d);
294 *quotient_f = (q << 8) | (r / d);
298 static void sp887x_correct_offsets (struct sp887x_state* state,
299 struct dtv_frontend_properties *p,
302 static const u32 srate_correction [] = { 1879617, 4544878, 8098561 };
304 int freq_offset = actual_freq - p->frequency;
305 int sysclock = 61003; //[kHz]
306 int ifreq = 36000000;
310 switch (p->bandwidth_hz) {
323 if (p->inversion == INVERSION_ON)
324 freq = ifreq - freq_offset;
326 freq = ifreq + freq_offset;
328 divide(freq / 333, sysclock, NULL, &frequency_shift);
330 if (p->inversion == INVERSION_ON)
331 frequency_shift = -frequency_shift;
333 /* sample rate correction */
334 sp887x_writereg(state, 0x319, srate_correction[bw_index] >> 12);
335 sp887x_writereg(state, 0x31a, srate_correction[bw_index] & 0xfff);
337 /* carrier offset correction */
338 sp887x_writereg(state, 0x309, frequency_shift >> 12);
339 sp887x_writereg(state, 0x30a, frequency_shift & 0xfff);
342 static int sp887x_setup_frontend_parameters(struct dvb_frontend *fe)
344 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
345 struct sp887x_state* state = fe->demodulator_priv;
346 unsigned actual_freq;
350 if (p->bandwidth_hz != 8000000 &&
351 p->bandwidth_hz != 7000000 &&
352 p->bandwidth_hz != 6000000)
355 if ((err = configure_reg0xc05(p, ®0xc05)))
358 sp887x_microcontroller_stop(state);
361 if (fe->ops.tuner_ops.set_params) {
362 fe->ops.tuner_ops.set_params(fe);
363 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
365 if (fe->ops.tuner_ops.get_frequency) {
366 fe->ops.tuner_ops.get_frequency(fe, &actual_freq);
367 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
369 actual_freq = p->frequency;
372 /* read status reg in order to clear <pending irqs */
373 sp887x_readreg(state, 0x200);
375 sp887x_correct_offsets(state, p, actual_freq);
377 /* filter for 6/7/8 Mhz channel */
378 if (p->bandwidth_hz == 6000000)
380 else if (p->bandwidth_hz == 7000000)
385 sp887x_writereg(state, 0x311, val);
387 /* scan order: 2k first = 0, 8k first = 1 */
388 if (p->transmission_mode == TRANSMISSION_MODE_2K)
389 sp887x_writereg(state, 0x338, 0x000);
391 sp887x_writereg(state, 0x338, 0x001);
393 sp887x_writereg(state, 0xc05, reg0xc05);
395 if (p->bandwidth_hz == 6000000)
397 else if (p->bandwidth_hz == 7000000)
402 /* enable OFDM and SAW bits as lock indicators in sync register 0xf17,
403 * optimize algorithm for given bandwidth...
405 sp887x_writereg(state, 0xf14, 0x160 | val);
406 sp887x_writereg(state, 0xf15, 0x000);
408 sp887x_microcontroller_start(state);
412 static int sp887x_read_status(struct dvb_frontend *fe, enum fe_status *status)
414 struct sp887x_state* state = fe->demodulator_priv;
415 u16 snr12 = sp887x_readreg(state, 0xf16);
416 u16 sync0x200 = sp887x_readreg(state, 0x200);
417 u16 sync0xf17 = sp887x_readreg(state, 0xf17);
422 *status |= FE_HAS_SIGNAL;
424 //if (sync0x200 & 0x004)
425 // *status |= FE_HAS_SYNC | FE_HAS_CARRIER;
427 //if (sync0x200 & 0x008)
428 // *status |= FE_HAS_VITERBI;
430 if ((sync0xf17 & 0x00f) == 0x002) {
431 *status |= FE_HAS_LOCK;
432 *status |= FE_HAS_VITERBI | FE_HAS_SYNC | FE_HAS_CARRIER;
435 if (sync0x200 & 0x001) { /* tuner adjustment requested...*/
436 int steps = (sync0x200 >> 4) & 0x00f;
439 dprintk("sp887x: implement tuner adjustment (%+i steps)!!\n",
446 static int sp887x_read_ber(struct dvb_frontend* fe, u32* ber)
448 struct sp887x_state* state = fe->demodulator_priv;
450 *ber = (sp887x_readreg(state, 0xc08) & 0x3f) |
451 (sp887x_readreg(state, 0xc07) << 6);
452 sp887x_writereg(state, 0xc08, 0x000);
453 sp887x_writereg(state, 0xc07, 0x000);
460 static int sp887x_read_signal_strength(struct dvb_frontend* fe, u16* strength)
462 struct sp887x_state* state = fe->demodulator_priv;
464 u16 snr12 = sp887x_readreg(state, 0xf16);
465 u32 signal = 3 * (snr12 << 4);
466 *strength = (signal < 0xffff) ? signal : 0xffff;
471 static int sp887x_read_snr(struct dvb_frontend* fe, u16* snr)
473 struct sp887x_state* state = fe->demodulator_priv;
475 u16 snr12 = sp887x_readreg(state, 0xf16);
476 *snr = (snr12 << 4) | (snr12 >> 8);
481 static int sp887x_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
483 struct sp887x_state* state = fe->demodulator_priv;
485 *ucblocks = sp887x_readreg(state, 0xc0c);
486 if (*ucblocks == 0xfff)
492 static int sp887x_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
494 struct sp887x_state* state = fe->demodulator_priv;
497 return sp887x_writereg(state, 0x206, 0x001);
499 return sp887x_writereg(state, 0x206, 0x000);
503 static int sp887x_sleep(struct dvb_frontend* fe)
505 struct sp887x_state* state = fe->demodulator_priv;
507 /* tristate TS output and disable interface pins */
508 sp887x_writereg(state, 0xc18, 0x000);
513 static int sp887x_init(struct dvb_frontend* fe)
515 struct sp887x_state* state = fe->demodulator_priv;
516 const struct firmware *fw = NULL;
519 if (!state->initialised) {
520 /* request the firmware, this will block until someone uploads it */
521 printk("sp887x: waiting for firmware upload (%s)...\n", "/*(DEBLOBBED)*/");
522 ret = state->config->request_firmware(fe, &fw, "/*(DEBLOBBED)*/");
524 printk("sp887x: no firmware upload (timeout or file not found?)\n");
528 ret = sp887x_initial_setup(fe, fw);
529 release_firmware(fw);
531 printk("sp887x: writing firmware to device failed\n");
534 printk("sp887x: firmware upload complete\n");
535 state->initialised = 1;
538 /* enable TS output and interface pins */
539 sp887x_writereg(state, 0xc18, 0x00d);
544 static int sp887x_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
546 fesettings->min_delay_ms = 350;
547 fesettings->step_size = 166666*2;
548 fesettings->max_drift = (166666*2)+1;
552 static void sp887x_release(struct dvb_frontend* fe)
554 struct sp887x_state* state = fe->demodulator_priv;
558 static const struct dvb_frontend_ops sp887x_ops;
560 struct dvb_frontend* sp887x_attach(const struct sp887x_config* config,
561 struct i2c_adapter* i2c)
563 struct sp887x_state* state = NULL;
565 /* allocate memory for the internal state */
566 state = kzalloc(sizeof(struct sp887x_state), GFP_KERNEL);
567 if (state == NULL) goto error;
569 /* setup the state */
570 state->config = config;
572 state->initialised = 0;
574 /* check if the demod is there */
575 if (sp887x_readreg(state, 0x0200) < 0) goto error;
577 /* create dvb_frontend */
578 memcpy(&state->frontend.ops, &sp887x_ops, sizeof(struct dvb_frontend_ops));
579 state->frontend.demodulator_priv = state;
580 return &state->frontend;
587 static const struct dvb_frontend_ops sp887x_ops = {
588 .delsys = { SYS_DVBT },
590 .name = "Spase SP887x DVB-T",
591 .frequency_min = 50500000,
592 .frequency_max = 858000000,
593 .frequency_stepsize = 166666,
594 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
595 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
596 FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 |
600 .release = sp887x_release,
603 .sleep = sp887x_sleep,
604 .i2c_gate_ctrl = sp887x_i2c_gate_ctrl,
606 .set_frontend = sp887x_setup_frontend_parameters,
607 .get_tune_settings = sp887x_get_tune_settings,
609 .read_status = sp887x_read_status,
610 .read_ber = sp887x_read_ber,
611 .read_signal_strength = sp887x_read_signal_strength,
612 .read_snr = sp887x_read_snr,
613 .read_ucblocks = sp887x_read_ucblocks,
616 module_param(debug, int, 0644);
617 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
619 MODULE_DESCRIPTION("Spase sp887x DVB-T demodulator driver");
620 MODULE_LICENSE("GPL");
622 EXPORT_SYMBOL(sp887x_attach);