2 Driver for the Spase sp887x demodulator
6 * This driver needs external firmware. Please use the command
7 * "<kerneldir>/Documentation/dvb/get_dvb_firmware sp887x" to
8 * download/extract it, and then copy it to /usr/lib/hotplug/firmware.
10 #define SP887X_DEFAULT_FIRMWARE "dvb-fe-sp887x.fw"
12 #include <linux/init.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/device.h>
16 #include <linux/firmware.h>
18 #include "dvb_frontend.h"
24 struct i2c_adapter* i2c;
26 struct dvb_frontend_ops ops;
28 const struct sp887x_config* config;
30 struct dvb_frontend frontend;
32 /* demodulator private data */
37 #define dprintk(args...) \
39 if (debug) printk(KERN_DEBUG "sp887x: " args); \
42 static int i2c_writebytes (struct sp887x_state* state, u8 *buf, u8 len)
44 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = len };
47 if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
48 printk ("%s: i2c write error (addr %02x, err == %i)\n",
49 __FUNCTION__, state->config->demod_address, err);
56 static int sp887x_writereg (struct sp887x_state* state, u16 reg, u16 data)
58 u8 b0 [] = { reg >> 8 , reg & 0xff, data >> 8, data & 0xff };
59 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 4 };
62 if ((ret = i2c_transfer(state->i2c, &msg, 1)) != 1) {
64 * in case of soft reset we ignore ACK errors...
66 if (!(reg == 0xf1a && data == 0x000 &&
67 (ret == -EREMOTEIO || ret == -EFAULT)))
69 printk("%s: writereg error "
70 "(reg %03x, data %03x, ret == %i)\n",
71 __FUNCTION__, reg & 0xffff, data & 0xffff, ret);
79 static int sp887x_readreg (struct sp887x_state* state, u16 reg)
81 u8 b0 [] = { reg >> 8 , reg & 0xff };
84 struct i2c_msg msg[] = {{ .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 2 },
85 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 2 }};
87 if ((ret = i2c_transfer(state->i2c, msg, 2)) != 2) {
88 printk("%s: readreg error (ret == %i)\n", __FUNCTION__, ret);
92 return (((b1[0] << 8) | b1[1]) & 0xfff);
95 static void sp887x_microcontroller_stop (struct sp887x_state* state)
97 dprintk("%s\n", __FUNCTION__);
98 sp887x_writereg(state, 0xf08, 0x000);
99 sp887x_writereg(state, 0xf09, 0x000);
101 /* microcontroller STOP */
102 sp887x_writereg(state, 0xf00, 0x000);
105 static void sp887x_microcontroller_start (struct sp887x_state* state)
107 dprintk("%s\n", __FUNCTION__);
108 sp887x_writereg(state, 0xf08, 0x000);
109 sp887x_writereg(state, 0xf09, 0x000);
111 /* microcontroller START */
112 sp887x_writereg(state, 0xf00, 0x001);
115 static void sp887x_setup_agc (struct sp887x_state* state)
117 /* setup AGC parameters */
118 dprintk("%s\n", __FUNCTION__);
119 sp887x_writereg(state, 0x33c, 0x054);
120 sp887x_writereg(state, 0x33b, 0x04c);
121 sp887x_writereg(state, 0x328, 0x000);
122 sp887x_writereg(state, 0x327, 0x005);
123 sp887x_writereg(state, 0x326, 0x001);
124 sp887x_writereg(state, 0x325, 0x001);
125 sp887x_writereg(state, 0x324, 0x001);
126 sp887x_writereg(state, 0x318, 0x050);
127 sp887x_writereg(state, 0x317, 0x3fe);
128 sp887x_writereg(state, 0x316, 0x001);
129 sp887x_writereg(state, 0x313, 0x005);
130 sp887x_writereg(state, 0x312, 0x002);
131 sp887x_writereg(state, 0x306, 0x000);
132 sp887x_writereg(state, 0x303, 0x000);
136 #define FW_SIZE 0x4000
138 * load firmware and setup MPEG interface...
140 static int sp887x_initial_setup (struct dvb_frontend* fe, const struct firmware *fw)
142 struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
143 u8 buf [BLOCKSIZE+2];
145 int fw_size = fw->size;
146 unsigned char *mem = fw->data;
148 dprintk("%s\n", __FUNCTION__);
150 /* ignore the first 10 bytes, then we expect 0x4000 bytes of firmware */
151 if (fw_size < FW_SIZE+10)
157 sp887x_writereg(state, 0xf1a, 0x000);
159 sp887x_microcontroller_stop (state);
161 printk ("%s: firmware upload... ", __FUNCTION__);
163 /* setup write pointer to -1 (end of memory) */
164 /* bit 0x8000 in address is set to enable 13bit mode */
165 sp887x_writereg(state, 0x8f08, 0x1fff);
167 /* dummy write (wrap around to start of memory) */
168 sp887x_writereg(state, 0x8f0a, 0x0000);
170 for (i = 0; i < FW_SIZE; i += BLOCKSIZE) {
177 /* bit 0x8000 in address is set to enable 13bit mode */
178 /* bit 0x4000 enables multibyte read/write transfers */
179 /* write register is 0xf0a */
183 memcpy(&buf[2], mem + i, c);
185 if ((err = i2c_writebytes (state, buf, c+2)) < 0) {
186 printk ("failed.\n");
187 printk ("%s: i2c error (err == %i)\n", __FUNCTION__, err);
192 /* don't write RS bytes between packets */
193 sp887x_writereg(state, 0xc13, 0x001);
195 /* suppress clock if (!data_valid) */
196 sp887x_writereg(state, 0xc14, 0x000);
198 /* setup MPEG interface... */
199 sp887x_writereg(state, 0xc1a, 0x872);
200 sp887x_writereg(state, 0xc1b, 0x001);
201 sp887x_writereg(state, 0xc1c, 0x000); /* parallel mode (serial mode == 1) */
202 sp887x_writereg(state, 0xc1a, 0x871);
204 /* ADC mode, 2 for MT8872, 3 for SP8870/SP8871 */
205 sp887x_writereg(state, 0x301, 0x002);
207 sp887x_setup_agc(state);
209 /* bit 0x010: enable data valid signal */
210 sp887x_writereg(state, 0xd00, 0x010);
211 sp887x_writereg(state, 0x0d1, 0x000);
214 if (state->config->pll_init) {
215 sp887x_writereg(state, 0x206, 0x001);
216 state->config->pll_init(fe);
217 sp887x_writereg(state, 0x206, 0x000);
224 static int configure_reg0xc05 (struct dvb_frontend_parameters *p, u16 *reg0xc05)
226 int known_parameters = 1;
230 switch (p->u.ofdm.constellation) {
234 *reg0xc05 |= (1 << 10);
237 *reg0xc05 |= (2 << 10);
240 known_parameters = 0;
246 switch (p->u.ofdm.hierarchy_information) {
250 *reg0xc05 |= (1 << 7);
253 *reg0xc05 |= (2 << 7);
256 *reg0xc05 |= (3 << 7);
259 known_parameters = 0;
265 switch (p->u.ofdm.code_rate_HP) {
269 *reg0xc05 |= (1 << 3);
272 *reg0xc05 |= (2 << 3);
275 *reg0xc05 |= (3 << 3);
278 *reg0xc05 |= (4 << 3);
281 known_parameters = 0;
287 if (known_parameters)
288 *reg0xc05 |= (2 << 1); /* use specified parameters */
290 *reg0xc05 |= (1 << 1); /* enable autoprobing */
296 * estimates division of two 24bit numbers,
297 * derived from the ves1820/stv0299 driver code
299 static void divide (int n, int d, int *quotient_i, int *quotient_f)
311 q = (q << 8) | (r / d);
313 *quotient_f = (q << 8) | (r / d);
317 static void sp887x_correct_offsets (struct sp887x_state* state,
318 struct dvb_frontend_parameters *p,
321 static const u32 srate_correction [] = { 1879617, 4544878, 8098561 };
322 int bw_index = p->u.ofdm.bandwidth - BANDWIDTH_8_MHZ;
323 int freq_offset = actual_freq - p->frequency;
324 int sysclock = 61003; //[kHz]
325 int ifreq = 36000000;
329 if (p->inversion == INVERSION_ON)
330 freq = ifreq - freq_offset;
332 freq = ifreq + freq_offset;
334 divide(freq / 333, sysclock, NULL, &frequency_shift);
336 if (p->inversion == INVERSION_ON)
337 frequency_shift = -frequency_shift;
339 /* sample rate correction */
340 sp887x_writereg(state, 0x319, srate_correction[bw_index] >> 12);
341 sp887x_writereg(state, 0x31a, srate_correction[bw_index] & 0xfff);
343 /* carrier offset correction */
344 sp887x_writereg(state, 0x309, frequency_shift >> 12);
345 sp887x_writereg(state, 0x30a, frequency_shift & 0xfff);
361 static int sp887x_setup_frontend_parameters (struct dvb_frontend* fe,
362 struct dvb_frontend_parameters *p)
364 struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
365 int actual_freq, err;
368 if (p->u.ofdm.bandwidth != BANDWIDTH_8_MHZ &&
369 p->u.ofdm.bandwidth != BANDWIDTH_7_MHZ &&
370 p->u.ofdm.bandwidth != BANDWIDTH_6_MHZ)
373 if ((err = configure_reg0xc05(p, ®0xc05)))
376 sp887x_microcontroller_stop(state);
379 sp887x_writereg(state, 0x206, 0x001);
380 actual_freq = state->config->pll_set(fe, p);
381 sp887x_writereg(state, 0x206, 0x000);
383 /* read status reg in order to clear <pending irqs */
384 sp887x_readreg(state, 0x200);
386 sp887x_correct_offsets(state, p, actual_freq);
388 /* filter for 6/7/8 Mhz channel */
389 if (p->u.ofdm.bandwidth == BANDWIDTH_6_MHZ)
391 else if (p->u.ofdm.bandwidth == BANDWIDTH_7_MHZ)
396 sp887x_writereg(state, 0x311, val);
398 /* scan order: 2k first = 0, 8k first = 1 */
399 if (p->u.ofdm.transmission_mode == TRANSMISSION_MODE_2K)
400 sp887x_writereg(state, 0x338, 0x000);
402 sp887x_writereg(state, 0x338, 0x001);
404 sp887x_writereg(state, 0xc05, reg0xc05);
406 if (p->u.ofdm.bandwidth == BANDWIDTH_6_MHZ)
408 else if (p->u.ofdm.bandwidth == BANDWIDTH_7_MHZ)
413 /* enable OFDM and SAW bits as lock indicators in sync register 0xf17,
414 * optimize algorithm for given bandwidth...
416 sp887x_writereg(state, 0xf14, 0x160 | val);
417 sp887x_writereg(state, 0xf15, 0x000);
419 sp887x_microcontroller_start(state);
423 static int sp887x_read_status(struct dvb_frontend* fe, fe_status_t* status)
425 struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
426 u16 snr12 = sp887x_readreg(state, 0xf16);
427 u16 sync0x200 = sp887x_readreg(state, 0x200);
428 u16 sync0xf17 = sp887x_readreg(state, 0xf17);
433 *status |= FE_HAS_SIGNAL;
435 //if (sync0x200 & 0x004)
436 // *status |= FE_HAS_SYNC | FE_HAS_CARRIER;
438 //if (sync0x200 & 0x008)
439 // *status |= FE_HAS_VITERBI;
441 if ((sync0xf17 & 0x00f) == 0x002) {
442 *status |= FE_HAS_LOCK;
443 *status |= FE_HAS_VITERBI | FE_HAS_SYNC | FE_HAS_CARRIER;
446 if (sync0x200 & 0x001) { /* tuner adjustment requested...*/
447 int steps = (sync0x200 >> 4) & 0x00f;
450 dprintk("sp887x: implement tuner adjustment (%+i steps)!!\n",
457 static int sp887x_read_ber(struct dvb_frontend* fe, u32* ber)
459 struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
461 *ber = (sp887x_readreg(state, 0xc08) & 0x3f) |
462 (sp887x_readreg(state, 0xc07) << 6);
463 sp887x_writereg(state, 0xc08, 0x000);
464 sp887x_writereg(state, 0xc07, 0x000);
471 static int sp887x_read_signal_strength(struct dvb_frontend* fe, u16* strength)
473 struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
475 u16 snr12 = sp887x_readreg(state, 0xf16);
476 u32 signal = 3 * (snr12 << 4);
477 *strength = (signal < 0xffff) ? signal : 0xffff;
482 static int sp887x_read_snr(struct dvb_frontend* fe, u16* snr)
484 struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
486 u16 snr12 = sp887x_readreg(state, 0xf16);
487 *snr = (snr12 << 4) | (snr12 >> 8);
492 static int sp887x_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
494 struct sp887x_state* state = (struct sp887x_state*) fe->demodulator_priv;
496 *ucblocks = sp887x_readreg(state, 0xc0c);
497 if (*ucblocks == 0xfff)
503 static int sp887x_sleep(struct dvb_frontend* fe)
505 struct sp887x_state* state = (struct sp887x_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 = (struct sp887x_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", SP887X_DEFAULT_FIRMWARE);
522 ret = state->config->request_firmware(fe, &fw, SP887X_DEFAULT_FIRMWARE);
524 printk("sp887x: no firmware upload (timeout or file not found?)\n");
528 ret = sp887x_initial_setup(fe, fw);
530 printk("sp887x: writing firmware to device failed\n");
531 release_firmware(fw);
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 = (struct sp887x_state*) fe->demodulator_priv;
558 static 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 = (struct sp887x_state*) kmalloc(sizeof(struct sp887x_state), GFP_KERNEL);
567 if (state == NULL) goto error;
569 /* setup the state */
570 state->config = config;
572 memcpy(&state->ops, &sp887x_ops, sizeof(struct dvb_frontend_ops));
573 state->initialised = 0;
575 /* check if the demod is there */
576 if (sp887x_readreg(state, 0x0200) < 0) goto error;
578 /* create dvb_frontend */
579 state->frontend.ops = &state->ops;
580 state->frontend.demodulator_priv = state;
581 return &state->frontend;
584 if (state) kfree(state);
588 static struct dvb_frontend_ops sp887x_ops = {
591 .name = "Spase SP887x DVB-T",
593 .frequency_min = 50500000,
594 .frequency_max = 858000000,
595 .frequency_stepsize = 166666,
596 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
597 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
598 FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 |
602 .release = sp887x_release,
605 .sleep = sp887x_sleep,
607 .set_frontend = sp887x_setup_frontend_parameters,
608 .get_tune_settings = sp887x_get_tune_settings,
610 .read_status = sp887x_read_status,
611 .read_ber = sp887x_read_ber,
612 .read_signal_strength = sp887x_read_signal_strength,
613 .read_snr = sp887x_read_snr,
614 .read_ucblocks = sp887x_read_ucblocks,
617 module_param(debug, int, 0644);
618 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
620 MODULE_DESCRIPTION("Spase sp887x DVB-T demodulator driver");
621 MODULE_LICENSE("GPL");
623 EXPORT_SYMBOL(sp887x_attach);