2 * Support for OR51132 (pcHDTV HD-3000) - VSB/QAM
5 * Copyright (C) 2007 Trent Piepho <xyzzy@speakeasy.org>
7 * Copyright (C) 2005 Kirk Lapray <kirk_lapray@bigfoot.com>
9 * Based on code from Jack Kelliher (kelliher@xmission.com)
10 * Copyright (C) 2002 & pcHDTV, inc.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
25 #define OR51132_VSB_FIRMWARE "/*(DEBLOBBED)*/"
26 #define OR51132_QAM_FIRMWARE "/*(DEBLOBBED)*/"
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/init.h>
31 #include <linux/delay.h>
32 #include <linux/string.h>
33 #include <linux/slab.h>
34 #include <asm/byteorder.h>
37 #include "dvb_frontend.h"
41 #define dprintk(args...) \
43 if (debug) printk(KERN_DEBUG "or51132: " args); \
49 struct i2c_adapter* i2c;
51 /* Configuration settings */
52 const struct or51132_config* config;
54 struct dvb_frontend frontend;
56 /* Demodulator private data */
57 enum fe_modulation current_modulation;
58 u32 snr; /* Result of last SNR calculation */
60 /* Tuner private data */
61 u32 current_frequency;
65 /* Write buffer to demod */
66 static int or51132_writebuf(struct or51132_state *state, const u8 *buf, int len)
69 struct i2c_msg msg = { .addr = state->config->demod_address,
70 .flags = 0, .buf = (u8*)buf, .len = len };
72 /* msleep(20); */ /* doesn't appear to be necessary */
73 if ((err = i2c_transfer(state->i2c, &msg, 1)) != 1) {
74 printk(KERN_WARNING "or51132: I2C write (addr 0x%02x len %d) error: %d\n",
75 msg.addr, msg.len, err);
81 /* Write constant bytes, e.g. or51132_writebytes(state, 0x04, 0x42, 0x00);
82 Less code and more efficient that loading a buffer on the stack with
83 the bytes to send and then calling or51132_writebuf() on that. */
84 #define or51132_writebytes(state, data...) \
85 ({ static const u8 _data[] = {data}; \
86 or51132_writebuf(state, _data, sizeof(_data)); })
88 /* Read data from demod into buffer. Returns 0 on success. */
89 static int or51132_readbuf(struct or51132_state *state, u8 *buf, int len)
92 struct i2c_msg msg = { .addr = state->config->demod_address,
93 .flags = I2C_M_RD, .buf = buf, .len = len };
95 /* msleep(20); */ /* doesn't appear to be necessary */
96 if ((err = i2c_transfer(state->i2c, &msg, 1)) != 1) {
97 printk(KERN_WARNING "or51132: I2C read (addr 0x%02x len %d) error: %d\n",
98 msg.addr, msg.len, err);
104 /* Reads a 16-bit demod register. Returns <0 on error. */
105 static int or51132_readreg(struct or51132_state *state, u8 reg)
107 u8 buf[2] = { 0x04, reg };
108 struct i2c_msg msg[2] = {
109 {.addr = state->config->demod_address, .flags = 0,
110 .buf = buf, .len = 2 },
111 {.addr = state->config->demod_address, .flags = I2C_M_RD,
112 .buf = buf, .len = 2 }};
115 if ((err = i2c_transfer(state->i2c, msg, 2)) != 2) {
116 printk(KERN_WARNING "or51132: I2C error reading register %d: %d\n",
120 return buf[0] | (buf[1] << 8);
123 static int or51132_load_firmware (struct dvb_frontend* fe, const struct firmware *fw)
125 struct or51132_state* state = fe->demodulator_priv;
126 static const u8 run_buf[] = {0x7F,0x01};
128 u32 firmwareAsize, firmwareBsize;
131 dprintk("Firmware is %zd bytes\n",fw->size);
133 /* Get size of firmware A and B */
134 firmwareAsize = le32_to_cpu(*((__le32*)fw->data));
135 dprintk("FirmwareA is %i bytes\n",firmwareAsize);
136 firmwareBsize = le32_to_cpu(*((__le32*)(fw->data+4)));
137 dprintk("FirmwareB is %i bytes\n",firmwareBsize);
139 /* Upload firmware */
140 if ((ret = or51132_writebuf(state, &fw->data[8], firmwareAsize))) {
141 printk(KERN_WARNING "or51132: load_firmware error 1\n");
144 if ((ret = or51132_writebuf(state, &fw->data[8+firmwareAsize],
146 printk(KERN_WARNING "or51132: load_firmware error 2\n");
150 if ((ret = or51132_writebuf(state, run_buf, 2))) {
151 printk(KERN_WARNING "or51132: load_firmware error 3\n");
154 if ((ret = or51132_writebuf(state, run_buf, 2))) {
155 printk(KERN_WARNING "or51132: load_firmware error 4\n");
159 /* 50ms for operation to begin */
162 /* Read back ucode version to besure we loaded correctly and are really up and running */
163 /* Get uCode version */
164 if ((ret = or51132_writebytes(state, 0x10, 0x10, 0x00))) {
165 printk(KERN_WARNING "or51132: load_firmware error a\n");
168 if ((ret = or51132_writebytes(state, 0x04, 0x17))) {
169 printk(KERN_WARNING "or51132: load_firmware error b\n");
172 if ((ret = or51132_writebytes(state, 0x00, 0x00))) {
173 printk(KERN_WARNING "or51132: load_firmware error c\n");
177 /* Once upon a time, this command might have had something
178 to do with getting the firmware version, but it's
180 {0x04,0x00,0x30,0x00,i+1} */
181 /* Read 8 bytes, two bytes at a time */
182 if ((ret = or51132_readbuf(state, &rec_buf[i*2], 2))) {
184 "or51132: load_firmware error d - %d\n",i);
190 "or51132: Version: %02X%02X%02X%02X-%02X%02X%02X%02X (%02X%01X-%01X-%02X%01X-%01X)\n",
191 rec_buf[1],rec_buf[0],rec_buf[3],rec_buf[2],
192 rec_buf[5],rec_buf[4],rec_buf[7],rec_buf[6],
193 rec_buf[3],rec_buf[2]>>4,rec_buf[2]&0x0f,
194 rec_buf[5],rec_buf[4]>>4,rec_buf[4]&0x0f);
196 if ((ret = or51132_writebytes(state, 0x10, 0x00, 0x00))) {
197 printk(KERN_WARNING "or51132: load_firmware error e\n");
203 static int or51132_init(struct dvb_frontend* fe)
208 static int or51132_read_ber(struct dvb_frontend* fe, u32* ber)
214 static int or51132_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
220 static int or51132_sleep(struct dvb_frontend* fe)
225 static int or51132_setmode(struct dvb_frontend* fe)
227 struct or51132_state* state = fe->demodulator_priv;
228 u8 cmd_buf1[3] = {0x04, 0x01, 0x5f};
229 u8 cmd_buf2[3] = {0x1c, 0x00, 0 };
231 dprintk("setmode %d\n",(int)state->current_modulation);
233 switch (state->current_modulation) {
235 /* Auto CH, Auto NTSC rej, MPEGser, MPEG2tr, phase noise-high */
237 /* REC MODE inv IF spectrum, Normal */
239 /* Channel MODE ATSC/VSB8 */
242 /* All QAM modes are:
243 Auto-deinterleave; MPEGser, MPEG2tr, phase noise-high
244 REC MODE Normal Carrier Lock */
246 /* Channel MODE Auto QAM64/256 */
250 /* Channel MODE QAM256 */
254 /* Channel MODE QAM64 */
259 "or51132: setmode: Modulation set to unsupported value (%d)\n",
260 state->current_modulation);
264 /* Set Receiver 1 register */
265 if (or51132_writebuf(state, cmd_buf1, 3)) {
266 printk(KERN_WARNING "or51132: set_mode error 1\n");
269 dprintk("set #1 to %02x\n", cmd_buf1[2]);
271 /* Set operation mode in Receiver 6 register */
272 if (or51132_writebuf(state, cmd_buf2, 3)) {
273 printk(KERN_WARNING "or51132: set_mode error 2\n");
276 dprintk("set #6 to 0x%02x%02x\n", cmd_buf2[1], cmd_buf2[2]);
281 /* Some modulations use the same firmware. This classifies modulations
282 by the firmware they use. */
283 #define MOD_FWCLASS_UNKNOWN 0
284 #define MOD_FWCLASS_VSB 1
285 #define MOD_FWCLASS_QAM 2
286 static int modulation_fw_class(enum fe_modulation modulation)
290 return MOD_FWCLASS_VSB;
294 return MOD_FWCLASS_QAM;
296 return MOD_FWCLASS_UNKNOWN;
300 static int or51132_set_parameters(struct dvb_frontend *fe)
302 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
304 struct or51132_state* state = fe->demodulator_priv;
305 const struct firmware *fw;
309 /* Upload new firmware only if we need a different one */
310 if (modulation_fw_class(state->current_modulation) !=
311 modulation_fw_class(p->modulation)) {
312 switch (modulation_fw_class(p->modulation)) {
313 case MOD_FWCLASS_VSB:
314 dprintk("set_parameters VSB MODE\n");
315 fwname = OR51132_VSB_FIRMWARE;
317 /* Set non-punctured clock for VSB */
320 case MOD_FWCLASS_QAM:
321 dprintk("set_parameters QAM MODE\n");
322 fwname = OR51132_QAM_FIRMWARE;
324 /* Set punctured clock for QAM */
328 printk("or51132: Modulation type(%d) UNSUPPORTED\n",
332 printk("or51132: Waiting for firmware upload(%s)...\n",
334 ret = reject_firmware(&fw, fwname, state->i2c->dev.parent);
336 printk(KERN_WARNING "or51132: No firmware uploaded(timeout or file not found?)\n");
339 ret = or51132_load_firmware(fe, fw);
340 release_firmware(fw);
342 printk(KERN_WARNING "or51132: Writing firmware to device failed!\n");
345 printk("or51132: Firmware upload complete.\n");
346 state->config->set_ts_params(fe, clock_mode);
348 /* Change only if we are actually changing the modulation */
349 if (state->current_modulation != p->modulation) {
350 state->current_modulation = p->modulation;
354 if (fe->ops.tuner_ops.set_params) {
355 fe->ops.tuner_ops.set_params(fe);
356 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
359 /* Set to current mode */
362 /* Update current frequency */
363 state->current_frequency = p->frequency;
367 static int or51132_get_parameters(struct dvb_frontend* fe,
368 struct dtv_frontend_properties *p)
370 struct or51132_state* state = fe->demodulator_priv;
375 /* Receiver Status */
376 if ((status = or51132_readreg(state, 0x00)) < 0) {
377 printk(KERN_WARNING "or51132: get_parameters: error reading receiver status\n");
380 switch(status&0xff) {
382 p->modulation = VSB_8;
385 p->modulation = QAM_64;
388 p->modulation = QAM_256;
393 printk(KERN_WARNING "or51132: unknown status 0x%02x\n",
398 /* FIXME: Read frequency from frontend, take AFC into account */
399 p->frequency = state->current_frequency;
401 /* FIXME: How to read inversion setting? Receiver 6 register? */
402 p->inversion = INVERSION_AUTO;
407 static int or51132_read_status(struct dvb_frontend *fe, enum fe_status *status)
409 struct or51132_state* state = fe->demodulator_priv;
412 /* Receiver Status */
413 if ((reg = or51132_readreg(state, 0x00)) < 0) {
414 printk(KERN_WARNING "or51132: read_status: error reading receiver status: %d\n", reg);
418 dprintk("%s: read_status %04x\n", __func__, reg);
420 if (reg & 0x0100) /* Receiver Lock */
421 *status = FE_HAS_SIGNAL|FE_HAS_CARRIER|FE_HAS_VITERBI|
422 FE_HAS_SYNC|FE_HAS_LOCK;
428 /* Calculate SNR estimation (scaled by 2^24)
430 8-VSB SNR and QAM equations from Oren datasheets
433 SNR[dB] = 10 * log10(897152044.8282 / MSE^2 ) - K
435 Where K = 0 if NTSC rejection filter is OFF; and
436 K = 3 if NTSC rejection filter is ON
439 SNR[dB] = 10 * log10(897152044.8282 / MSE^2 )
442 SNR[dB] = 10 * log10(907832426.314266 / MSE^2 )
444 We re-write the snr equation as:
445 SNR * 2^24 = 10*(c - 2*intlog10(MSE))
446 Where for QAM256, c = log10(907832426.314266) * 2^24
447 and for 8-VSB and QAM64, c = log10(897152044.8282) * 2^24 */
449 static u32 calculate_snr(u32 mse, u32 c)
451 if (mse == 0) /* No signal */
454 mse = 2*intlog10(mse);
456 /* Negative SNR, which is possible, but realisticly the
457 demod will lose lock before the signal gets this bad. The
458 API only allows for unsigned values, so just return 0 */
464 static int or51132_read_snr(struct dvb_frontend* fe, u16* snr)
466 struct or51132_state* state = fe->demodulator_priv;
472 /* SNR after Equalizer */
473 noise = or51132_readreg(state, 0x02);
475 printk(KERN_WARNING "or51132: read_snr: error reading equalizer\n");
478 dprintk("read_snr noise (%d)\n", noise);
480 /* Read status, contains modulation type for QAM_AUTO and
481 NTSC filter for VSB */
482 reg = or51132_readreg(state, 0x00);
484 printk(KERN_WARNING "or51132: read_snr: error reading receiver status\n");
490 if (reg & 0x1000) usK = 3 << 24;
492 case 0x43: /* QAM64 */
499 printk(KERN_WARNING "or51132: unknown status 0x%02x\n", reg&0xff);
500 if (retry--) goto start;
503 dprintk("%s: modulation %02x, NTSC rej O%s\n", __func__,
504 reg&0xff, reg&0x1000?"n":"ff");
506 /* Calculate SNR using noise, c, and NTSC rejection correction */
507 state->snr = calculate_snr(noise, c) - usK;
508 *snr = (state->snr) >> 16;
510 dprintk("%s: noise = 0x%08x, snr = %d.%02d dB\n", __func__, noise,
511 state->snr >> 24, (((state->snr>>8) & 0xffff) * 100) >> 16);
516 static int or51132_read_signal_strength(struct dvb_frontend* fe, u16* strength)
518 /* Calculate Strength from SNR up to 35dB */
519 /* Even though the SNR can go higher than 35dB, there is some comfort */
520 /* factor in having a range of strong signals that can show at 100% */
521 struct or51132_state* state = (struct or51132_state*) fe->demodulator_priv;
525 ret = fe->ops.read_snr(fe, &snr);
528 /* Rather than use the 8.8 value snr, use state->snr which is 8.24 */
529 /* scale the range 0 - 35*2^24 into 0 - 65535 */
530 if (state->snr >= 8960 * 0x10000)
533 *strength = state->snr / 8960;
538 static int or51132_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fe_tune_settings)
540 fe_tune_settings->min_delay_ms = 500;
541 fe_tune_settings->step_size = 0;
542 fe_tune_settings->max_drift = 0;
547 static void or51132_release(struct dvb_frontend* fe)
549 struct or51132_state* state = fe->demodulator_priv;
553 static const struct dvb_frontend_ops or51132_ops;
555 struct dvb_frontend* or51132_attach(const struct or51132_config* config,
556 struct i2c_adapter* i2c)
558 struct or51132_state* state = NULL;
560 /* Allocate memory for the internal state */
561 state = kzalloc(sizeof(struct or51132_state), GFP_KERNEL);
565 /* Setup the state */
566 state->config = config;
568 state->current_frequency = -1;
569 state->current_modulation = -1;
571 /* Create dvb_frontend */
572 memcpy(&state->frontend.ops, &or51132_ops, sizeof(struct dvb_frontend_ops));
573 state->frontend.demodulator_priv = state;
574 return &state->frontend;
577 static const struct dvb_frontend_ops or51132_ops = {
578 .delsys = { SYS_ATSC, SYS_DVBC_ANNEX_B },
580 .name = "Oren OR51132 VSB/QAM Frontend",
581 .frequency_min = 44000000,
582 .frequency_max = 958000000,
583 .frequency_stepsize = 166666,
584 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
585 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
586 FE_CAN_QAM_64 | FE_CAN_QAM_256 | FE_CAN_QAM_AUTO |
590 .release = or51132_release,
592 .init = or51132_init,
593 .sleep = or51132_sleep,
595 .set_frontend = or51132_set_parameters,
596 .get_frontend = or51132_get_parameters,
597 .get_tune_settings = or51132_get_tune_settings,
599 .read_status = or51132_read_status,
600 .read_ber = or51132_read_ber,
601 .read_signal_strength = or51132_read_signal_strength,
602 .read_snr = or51132_read_snr,
603 .read_ucblocks = or51132_read_ucblocks,
606 module_param(debug, int, 0644);
607 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
609 MODULE_DESCRIPTION("OR51132 ATSC [pcHDTV HD-3000] (8VSB & ITU J83 AnnexB FEC QAM64/256) Demodulator Driver");
610 MODULE_AUTHOR("Kirk Lapray");
611 MODULE_AUTHOR("Trent Piepho");
612 MODULE_LICENSE("GPL");
614 EXPORT_SYMBOL_GPL(or51132_attach);