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
9 * or /lib/firmware (depending on configuration of firmware hotplug).
11 #define SP887X_DEFAULT_FIRMWARE "dvb-fe-sp887x.fw"
13 #include <linux/init.h>
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/device.h>
17 #include <linux/firmware.h>
18 #include <linux/string.h>
19 #include <linux/slab.h>
21 #include "dvb_frontend.h"
26 struct i2c_adapter* i2c;
27 struct dvb_frontend_ops ops;
28 const struct sp887x_config* config;
29 struct dvb_frontend frontend;
31 /* demodulator private data */
36 #define dprintk(args...) \
38 if (debug) printk(KERN_DEBUG "sp887x: " args); \
41 static int i2c_writebytes (struct sp887x_state* state, u8 *buf, u8 len)
43 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = buf, .len = len };
46 if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
47 printk ("%s: i2c write error (addr %02x, err == %i)\n",
48 __FUNCTION__, state->config->demod_address, err);
55 static int sp887x_writereg (struct sp887x_state* state, u16 reg, u16 data)
57 u8 b0 [] = { reg >> 8 , reg & 0xff, data >> 8, data & 0xff };
58 struct i2c_msg msg = { .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 4 };
61 if ((ret = i2c_transfer(state->i2c, &msg, 1)) != 1) {
63 * in case of soft reset we ignore ACK errors...
65 if (!(reg == 0xf1a && data == 0x000 &&
66 (ret == -EREMOTEIO || ret == -EFAULT)))
68 printk("%s: writereg error "
69 "(reg %03x, data %03x, ret == %i)\n",
70 __FUNCTION__, reg & 0xffff, data & 0xffff, ret);
78 static int sp887x_readreg (struct sp887x_state* state, u16 reg)
80 u8 b0 [] = { reg >> 8 , reg & 0xff };
83 struct i2c_msg msg[] = {{ .addr = state->config->demod_address, .flags = 0, .buf = b0, .len = 2 },
84 { .addr = state->config->demod_address, .flags = I2C_M_RD, .buf = b1, .len = 2 }};
86 if ((ret = i2c_transfer(state->i2c, msg, 2)) != 2) {
87 printk("%s: readreg error (ret == %i)\n", __FUNCTION__, ret);
91 return (((b1[0] << 8) | b1[1]) & 0xfff);
94 static void sp887x_microcontroller_stop (struct sp887x_state* state)
96 dprintk("%s\n", __FUNCTION__);
97 sp887x_writereg(state, 0xf08, 0x000);
98 sp887x_writereg(state, 0xf09, 0x000);
100 /* microcontroller STOP */
101 sp887x_writereg(state, 0xf00, 0x000);
104 static void sp887x_microcontroller_start (struct sp887x_state* state)
106 dprintk("%s\n", __FUNCTION__);
107 sp887x_writereg(state, 0xf08, 0x000);
108 sp887x_writereg(state, 0xf09, 0x000);
110 /* microcontroller START */
111 sp887x_writereg(state, 0xf00, 0x001);
114 static void sp887x_setup_agc (struct sp887x_state* state)
116 /* setup AGC parameters */
117 dprintk("%s\n", __FUNCTION__);
118 sp887x_writereg(state, 0x33c, 0x054);
119 sp887x_writereg(state, 0x33b, 0x04c);
120 sp887x_writereg(state, 0x328, 0x000);
121 sp887x_writereg(state, 0x327, 0x005);
122 sp887x_writereg(state, 0x326, 0x001);
123 sp887x_writereg(state, 0x325, 0x001);
124 sp887x_writereg(state, 0x324, 0x001);
125 sp887x_writereg(state, 0x318, 0x050);
126 sp887x_writereg(state, 0x317, 0x3fe);
127 sp887x_writereg(state, 0x316, 0x001);
128 sp887x_writereg(state, 0x313, 0x005);
129 sp887x_writereg(state, 0x312, 0x002);
130 sp887x_writereg(state, 0x306, 0x000);
131 sp887x_writereg(state, 0x303, 0x000);
135 #define FW_SIZE 0x4000
137 * load firmware and setup MPEG interface...
139 static int sp887x_initial_setup (struct dvb_frontend* fe, const struct firmware *fw)
141 struct sp887x_state* state = fe->demodulator_priv;
142 u8 buf [BLOCKSIZE+2];
144 int fw_size = fw->size;
145 unsigned char *mem = fw->data;
147 dprintk("%s\n", __FUNCTION__);
149 /* ignore the first 10 bytes, then we expect 0x4000 bytes of firmware */
150 if (fw_size < FW_SIZE+10)
156 sp887x_writereg(state, 0xf1a, 0x000);
158 sp887x_microcontroller_stop (state);
160 printk ("%s: firmware upload... ", __FUNCTION__);
162 /* setup write pointer to -1 (end of memory) */
163 /* bit 0x8000 in address is set to enable 13bit mode */
164 sp887x_writereg(state, 0x8f08, 0x1fff);
166 /* dummy write (wrap around to start of memory) */
167 sp887x_writereg(state, 0x8f0a, 0x0000);
169 for (i = 0; i < FW_SIZE; i += BLOCKSIZE) {
176 /* bit 0x8000 in address is set to enable 13bit mode */
177 /* bit 0x4000 enables multibyte read/write transfers */
178 /* write register is 0xf0a */
182 memcpy(&buf[2], mem + i, c);
184 if ((err = i2c_writebytes (state, buf, c+2)) < 0) {
185 printk ("failed.\n");
186 printk ("%s: i2c error (err == %i)\n", __FUNCTION__, err);
191 /* don't write RS bytes between packets */
192 sp887x_writereg(state, 0xc13, 0x001);
194 /* suppress clock if (!data_valid) */
195 sp887x_writereg(state, 0xc14, 0x000);
197 /* setup MPEG interface... */
198 sp887x_writereg(state, 0xc1a, 0x872);
199 sp887x_writereg(state, 0xc1b, 0x001);
200 sp887x_writereg(state, 0xc1c, 0x000); /* parallel mode (serial mode == 1) */
201 sp887x_writereg(state, 0xc1a, 0x871);
203 /* ADC mode, 2 for MT8872, 3 for SP8870/SP8871 */
204 sp887x_writereg(state, 0x301, 0x002);
206 sp887x_setup_agc(state);
208 /* bit 0x010: enable data valid signal */
209 sp887x_writereg(state, 0xd00, 0x010);
210 sp887x_writereg(state, 0x0d1, 0x000);
214 static int configure_reg0xc05 (struct dvb_frontend_parameters *p, u16 *reg0xc05)
216 int known_parameters = 1;
220 switch (p->u.ofdm.constellation) {
224 *reg0xc05 |= (1 << 10);
227 *reg0xc05 |= (2 << 10);
230 known_parameters = 0;
236 switch (p->u.ofdm.hierarchy_information) {
240 *reg0xc05 |= (1 << 7);
243 *reg0xc05 |= (2 << 7);
246 *reg0xc05 |= (3 << 7);
249 known_parameters = 0;
255 switch (p->u.ofdm.code_rate_HP) {
259 *reg0xc05 |= (1 << 3);
262 *reg0xc05 |= (2 << 3);
265 *reg0xc05 |= (3 << 3);
268 *reg0xc05 |= (4 << 3);
271 known_parameters = 0;
277 if (known_parameters)
278 *reg0xc05 |= (2 << 1); /* use specified parameters */
280 *reg0xc05 |= (1 << 1); /* enable autoprobing */
286 * estimates division of two 24bit numbers,
287 * derived from the ves1820/stv0299 driver code
289 static void divide (int n, int d, int *quotient_i, int *quotient_f)
301 q = (q << 8) | (r / d);
303 *quotient_f = (q << 8) | (r / d);
307 static void sp887x_correct_offsets (struct sp887x_state* state,
308 struct dvb_frontend_parameters *p,
311 static const u32 srate_correction [] = { 1879617, 4544878, 8098561 };
312 int bw_index = p->u.ofdm.bandwidth - BANDWIDTH_8_MHZ;
313 int freq_offset = actual_freq - p->frequency;
314 int sysclock = 61003; //[kHz]
315 int ifreq = 36000000;
319 if (p->inversion == INVERSION_ON)
320 freq = ifreq - freq_offset;
322 freq = ifreq + freq_offset;
324 divide(freq / 333, sysclock, NULL, &frequency_shift);
326 if (p->inversion == INVERSION_ON)
327 frequency_shift = -frequency_shift;
329 /* sample rate correction */
330 sp887x_writereg(state, 0x319, srate_correction[bw_index] >> 12);
331 sp887x_writereg(state, 0x31a, srate_correction[bw_index] & 0xfff);
333 /* carrier offset correction */
334 sp887x_writereg(state, 0x309, frequency_shift >> 12);
335 sp887x_writereg(state, 0x30a, frequency_shift & 0xfff);
338 static int sp887x_setup_frontend_parameters (struct dvb_frontend* fe,
339 struct dvb_frontend_parameters *p)
341 struct sp887x_state* state = fe->demodulator_priv;
342 int actual_freq, err;
345 if (p->u.ofdm.bandwidth != BANDWIDTH_8_MHZ &&
346 p->u.ofdm.bandwidth != BANDWIDTH_7_MHZ &&
347 p->u.ofdm.bandwidth != BANDWIDTH_6_MHZ)
350 if ((err = configure_reg0xc05(p, ®0xc05)))
353 sp887x_microcontroller_stop(state);
356 if (fe->ops->tuner_ops.set_params) {
357 fe->ops->tuner_ops.set_params(fe, p);
358 if (fe->ops->i2c_gate_ctrl) fe->ops->i2c_gate_ctrl(fe, 0);
360 if (fe->ops->tuner_ops.get_frequency) {
361 fe->ops->tuner_ops.get_frequency(fe, &actual_freq);
362 if (fe->ops->i2c_gate_ctrl) fe->ops->i2c_gate_ctrl(fe, 0);
364 actual_freq = p->frequency;
367 /* read status reg in order to clear <pending irqs */
368 sp887x_readreg(state, 0x200);
370 sp887x_correct_offsets(state, p, actual_freq);
372 /* filter for 6/7/8 Mhz channel */
373 if (p->u.ofdm.bandwidth == BANDWIDTH_6_MHZ)
375 else if (p->u.ofdm.bandwidth == BANDWIDTH_7_MHZ)
380 sp887x_writereg(state, 0x311, val);
382 /* scan order: 2k first = 0, 8k first = 1 */
383 if (p->u.ofdm.transmission_mode == TRANSMISSION_MODE_2K)
384 sp887x_writereg(state, 0x338, 0x000);
386 sp887x_writereg(state, 0x338, 0x001);
388 sp887x_writereg(state, 0xc05, reg0xc05);
390 if (p->u.ofdm.bandwidth == BANDWIDTH_6_MHZ)
392 else if (p->u.ofdm.bandwidth == BANDWIDTH_7_MHZ)
397 /* enable OFDM and SAW bits as lock indicators in sync register 0xf17,
398 * optimize algorithm for given bandwidth...
400 sp887x_writereg(state, 0xf14, 0x160 | val);
401 sp887x_writereg(state, 0xf15, 0x000);
403 sp887x_microcontroller_start(state);
407 static int sp887x_read_status(struct dvb_frontend* fe, fe_status_t* status)
409 struct sp887x_state* state = fe->demodulator_priv;
410 u16 snr12 = sp887x_readreg(state, 0xf16);
411 u16 sync0x200 = sp887x_readreg(state, 0x200);
412 u16 sync0xf17 = sp887x_readreg(state, 0xf17);
417 *status |= FE_HAS_SIGNAL;
419 //if (sync0x200 & 0x004)
420 // *status |= FE_HAS_SYNC | FE_HAS_CARRIER;
422 //if (sync0x200 & 0x008)
423 // *status |= FE_HAS_VITERBI;
425 if ((sync0xf17 & 0x00f) == 0x002) {
426 *status |= FE_HAS_LOCK;
427 *status |= FE_HAS_VITERBI | FE_HAS_SYNC | FE_HAS_CARRIER;
430 if (sync0x200 & 0x001) { /* tuner adjustment requested...*/
431 int steps = (sync0x200 >> 4) & 0x00f;
434 dprintk("sp887x: implement tuner adjustment (%+i steps)!!\n",
441 static int sp887x_read_ber(struct dvb_frontend* fe, u32* ber)
443 struct sp887x_state* state = fe->demodulator_priv;
445 *ber = (sp887x_readreg(state, 0xc08) & 0x3f) |
446 (sp887x_readreg(state, 0xc07) << 6);
447 sp887x_writereg(state, 0xc08, 0x000);
448 sp887x_writereg(state, 0xc07, 0x000);
455 static int sp887x_read_signal_strength(struct dvb_frontend* fe, u16* strength)
457 struct sp887x_state* state = fe->demodulator_priv;
459 u16 snr12 = sp887x_readreg(state, 0xf16);
460 u32 signal = 3 * (snr12 << 4);
461 *strength = (signal < 0xffff) ? signal : 0xffff;
466 static int sp887x_read_snr(struct dvb_frontend* fe, u16* snr)
468 struct sp887x_state* state = fe->demodulator_priv;
470 u16 snr12 = sp887x_readreg(state, 0xf16);
471 *snr = (snr12 << 4) | (snr12 >> 8);
476 static int sp887x_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
478 struct sp887x_state* state = fe->demodulator_priv;
480 *ucblocks = sp887x_readreg(state, 0xc0c);
481 if (*ucblocks == 0xfff)
487 static int sp887x_i2c_gate_ctrl(struct dvb_frontend* fe, int enable)
489 struct sp887x_state* state = fe->demodulator_priv;
492 return sp887x_writereg(state, 0x206, 0x001);
494 return sp887x_writereg(state, 0x206, 0x000);
498 static int sp887x_sleep(struct dvb_frontend* fe)
500 struct sp887x_state* state = fe->demodulator_priv;
502 /* tristate TS output and disable interface pins */
503 sp887x_writereg(state, 0xc18, 0x000);
508 static int sp887x_init(struct dvb_frontend* fe)
510 struct sp887x_state* state = fe->demodulator_priv;
511 const struct firmware *fw = NULL;
514 if (!state->initialised) {
515 /* request the firmware, this will block until someone uploads it */
516 printk("sp887x: waiting for firmware upload (%s)...\n", SP887X_DEFAULT_FIRMWARE);
517 ret = state->config->request_firmware(fe, &fw, SP887X_DEFAULT_FIRMWARE);
519 printk("sp887x: no firmware upload (timeout or file not found?)\n");
523 ret = sp887x_initial_setup(fe, fw);
525 printk("sp887x: writing firmware to device failed\n");
526 release_firmware(fw);
529 printk("sp887x: firmware upload complete\n");
530 state->initialised = 1;
533 /* enable TS output and interface pins */
534 sp887x_writereg(state, 0xc18, 0x00d);
539 static int sp887x_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fesettings)
541 fesettings->min_delay_ms = 350;
542 fesettings->step_size = 166666*2;
543 fesettings->max_drift = (166666*2)+1;
547 static void sp887x_release(struct dvb_frontend* fe)
549 struct sp887x_state* state = fe->demodulator_priv;
553 static struct dvb_frontend_ops sp887x_ops;
555 struct dvb_frontend* sp887x_attach(const struct sp887x_config* config,
556 struct i2c_adapter* i2c)
558 struct sp887x_state* state = NULL;
560 /* allocate memory for the internal state */
561 state = kmalloc(sizeof(struct sp887x_state), GFP_KERNEL);
562 if (state == NULL) goto error;
564 /* setup the state */
565 state->config = config;
567 memcpy(&state->ops, &sp887x_ops, sizeof(struct dvb_frontend_ops));
568 state->initialised = 0;
570 /* check if the demod is there */
571 if (sp887x_readreg(state, 0x0200) < 0) goto error;
573 /* create dvb_frontend */
574 state->frontend.ops = &state->ops;
575 state->frontend.demodulator_priv = state;
576 return &state->frontend;
583 static struct dvb_frontend_ops sp887x_ops = {
586 .name = "Spase SP887x DVB-T",
588 .frequency_min = 50500000,
589 .frequency_max = 858000000,
590 .frequency_stepsize = 166666,
591 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
592 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
593 FE_CAN_QPSK | FE_CAN_QAM_16 | FE_CAN_QAM_64 |
597 .release = sp887x_release,
600 .sleep = sp887x_sleep,
601 .i2c_gate_ctrl = sp887x_i2c_gate_ctrl,
603 .set_frontend = sp887x_setup_frontend_parameters,
604 .get_tune_settings = sp887x_get_tune_settings,
606 .read_status = sp887x_read_status,
607 .read_ber = sp887x_read_ber,
608 .read_signal_strength = sp887x_read_signal_strength,
609 .read_snr = sp887x_read_snr,
610 .read_ucblocks = sp887x_read_ucblocks,
613 module_param(debug, int, 0644);
614 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
616 MODULE_DESCRIPTION("Spase sp887x DVB-T demodulator driver");
617 MODULE_LICENSE("GPL");
619 EXPORT_SYMBOL(sp887x_attach);