1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * 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.
14 #define OR51132_VSB_FIRMWARE "/*(DEBLOBBED)*/"
15 #define OR51132_QAM_FIRMWARE "/*(DEBLOBBED)*/"
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/delay.h>
21 #include <linux/string.h>
22 #include <linux/slab.h>
23 #include <asm/byteorder.h>
25 #include <media/dvb_math.h>
26 #include <media/dvb_frontend.h>
30 #define dprintk(args...) \
32 if (debug) printk(KERN_DEBUG "or51132: " args); \
38 struct i2c_adapter* i2c;
40 /* Configuration settings */
41 const struct or51132_config* config;
43 struct dvb_frontend frontend;
45 /* Demodulator private data */
46 enum fe_modulation current_modulation;
47 u32 snr; /* Result of last SNR calculation */
49 /* Tuner private data */
50 u32 current_frequency;
54 /* Write buffer to demod */
55 static int or51132_writebuf(struct or51132_state *state, const u8 *buf, int len)
58 struct i2c_msg msg = { .addr = state->config->demod_address,
59 .flags = 0, .buf = (u8*)buf, .len = len };
61 /* msleep(20); */ /* doesn't appear to be necessary */
62 if ((err = i2c_transfer(state->i2c, &msg, 1)) != 1) {
63 printk(KERN_WARNING "or51132: I2C write (addr 0x%02x len %d) error: %d\n",
64 msg.addr, msg.len, err);
70 /* Write constant bytes, e.g. or51132_writebytes(state, 0x04, 0x42, 0x00);
71 Less code and more efficient that loading a buffer on the stack with
72 the bytes to send and then calling or51132_writebuf() on that. */
73 #define or51132_writebytes(state, data...) \
74 ({ static const u8 _data[] = {data}; \
75 or51132_writebuf(state, _data, sizeof(_data)); })
77 /* Read data from demod into buffer. Returns 0 on success. */
78 static int or51132_readbuf(struct or51132_state *state, u8 *buf, int len)
81 struct i2c_msg msg = { .addr = state->config->demod_address,
82 .flags = I2C_M_RD, .buf = buf, .len = len };
84 /* msleep(20); */ /* doesn't appear to be necessary */
85 if ((err = i2c_transfer(state->i2c, &msg, 1)) != 1) {
86 printk(KERN_WARNING "or51132: I2C read (addr 0x%02x len %d) error: %d\n",
87 msg.addr, msg.len, err);
93 /* Reads a 16-bit demod register. Returns <0 on error. */
94 static int or51132_readreg(struct or51132_state *state, u8 reg)
96 u8 buf[2] = { 0x04, reg };
97 struct i2c_msg msg[2] = {
98 {.addr = state->config->demod_address, .flags = 0,
99 .buf = buf, .len = 2 },
100 {.addr = state->config->demod_address, .flags = I2C_M_RD,
101 .buf = buf, .len = 2 }};
104 if ((err = i2c_transfer(state->i2c, msg, 2)) != 2) {
105 printk(KERN_WARNING "or51132: I2C error reading register %d: %d\n",
109 return buf[0] | (buf[1] << 8);
112 static int or51132_load_firmware (struct dvb_frontend* fe, const struct firmware *fw)
114 struct or51132_state* state = fe->demodulator_priv;
115 static const u8 run_buf[] = {0x7F,0x01};
117 u32 firmwareAsize, firmwareBsize;
120 dprintk("Firmware is %zd bytes\n",fw->size);
122 /* Get size of firmware A and B */
123 firmwareAsize = le32_to_cpu(*((__le32*)fw->data));
124 dprintk("FirmwareA is %i bytes\n",firmwareAsize);
125 firmwareBsize = le32_to_cpu(*((__le32*)(fw->data+4)));
126 dprintk("FirmwareB is %i bytes\n",firmwareBsize);
128 /* Upload firmware */
129 if ((ret = or51132_writebuf(state, &fw->data[8], firmwareAsize))) {
130 printk(KERN_WARNING "or51132: load_firmware error 1\n");
133 if ((ret = or51132_writebuf(state, &fw->data[8+firmwareAsize],
135 printk(KERN_WARNING "or51132: load_firmware error 2\n");
139 if ((ret = or51132_writebuf(state, run_buf, 2))) {
140 printk(KERN_WARNING "or51132: load_firmware error 3\n");
143 if ((ret = or51132_writebuf(state, run_buf, 2))) {
144 printk(KERN_WARNING "or51132: load_firmware error 4\n");
148 /* 50ms for operation to begin */
151 /* Read back ucode version to besure we loaded correctly and are really up and running */
152 /* Get uCode version */
153 if ((ret = or51132_writebytes(state, 0x10, 0x10, 0x00))) {
154 printk(KERN_WARNING "or51132: load_firmware error a\n");
157 if ((ret = or51132_writebytes(state, 0x04, 0x17))) {
158 printk(KERN_WARNING "or51132: load_firmware error b\n");
161 if ((ret = or51132_writebytes(state, 0x00, 0x00))) {
162 printk(KERN_WARNING "or51132: load_firmware error c\n");
166 /* Once upon a time, this command might have had something
167 to do with getting the firmware version, but it's
169 {0x04,0x00,0x30,0x00,i+1} */
170 /* Read 8 bytes, two bytes at a time */
171 if ((ret = or51132_readbuf(state, &rec_buf[i*2], 2))) {
173 "or51132: load_firmware error d - %d\n",i);
179 "or51132: Version: %02X%02X%02X%02X-%02X%02X%02X%02X (%02X%01X-%01X-%02X%01X-%01X)\n",
180 rec_buf[1],rec_buf[0],rec_buf[3],rec_buf[2],
181 rec_buf[5],rec_buf[4],rec_buf[7],rec_buf[6],
182 rec_buf[3],rec_buf[2]>>4,rec_buf[2]&0x0f,
183 rec_buf[5],rec_buf[4]>>4,rec_buf[4]&0x0f);
185 if ((ret = or51132_writebytes(state, 0x10, 0x00, 0x00))) {
186 printk(KERN_WARNING "or51132: load_firmware error e\n");
192 static int or51132_init(struct dvb_frontend* fe)
197 static int or51132_read_ber(struct dvb_frontend* fe, u32* ber)
203 static int or51132_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
209 static int or51132_sleep(struct dvb_frontend* fe)
214 static int or51132_setmode(struct dvb_frontend* fe)
216 struct or51132_state* state = fe->demodulator_priv;
217 u8 cmd_buf1[3] = {0x04, 0x01, 0x5f};
218 u8 cmd_buf2[3] = {0x1c, 0x00, 0 };
220 dprintk("setmode %d\n",(int)state->current_modulation);
222 switch (state->current_modulation) {
224 /* Auto CH, Auto NTSC rej, MPEGser, MPEG2tr, phase noise-high */
226 /* REC MODE inv IF spectrum, Normal */
228 /* Channel MODE ATSC/VSB8 */
231 /* All QAM modes are:
232 Auto-deinterleave; MPEGser, MPEG2tr, phase noise-high
233 REC MODE Normal Carrier Lock */
235 /* Channel MODE Auto QAM64/256 */
239 /* Channel MODE QAM256 */
243 /* Channel MODE QAM64 */
248 "or51132: setmode: Modulation set to unsupported value (%d)\n",
249 state->current_modulation);
253 /* Set Receiver 1 register */
254 if (or51132_writebuf(state, cmd_buf1, 3)) {
255 printk(KERN_WARNING "or51132: set_mode error 1\n");
258 dprintk("set #1 to %02x\n", cmd_buf1[2]);
260 /* Set operation mode in Receiver 6 register */
261 if (or51132_writebuf(state, cmd_buf2, 3)) {
262 printk(KERN_WARNING "or51132: set_mode error 2\n");
265 dprintk("set #6 to 0x%02x%02x\n", cmd_buf2[1], cmd_buf2[2]);
270 /* Some modulations use the same firmware. This classifies modulations
271 by the firmware they use. */
272 #define MOD_FWCLASS_UNKNOWN 0
273 #define MOD_FWCLASS_VSB 1
274 #define MOD_FWCLASS_QAM 2
275 static int modulation_fw_class(enum fe_modulation modulation)
279 return MOD_FWCLASS_VSB;
283 return MOD_FWCLASS_QAM;
285 return MOD_FWCLASS_UNKNOWN;
289 static int or51132_set_parameters(struct dvb_frontend *fe)
291 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
293 struct or51132_state* state = fe->demodulator_priv;
294 const struct firmware *fw;
298 /* Upload new firmware only if we need a different one */
299 if (modulation_fw_class(state->current_modulation) !=
300 modulation_fw_class(p->modulation)) {
301 switch (modulation_fw_class(p->modulation)) {
302 case MOD_FWCLASS_VSB:
303 dprintk("set_parameters VSB MODE\n");
304 fwname = OR51132_VSB_FIRMWARE;
306 /* Set non-punctured clock for VSB */
309 case MOD_FWCLASS_QAM:
310 dprintk("set_parameters QAM MODE\n");
311 fwname = OR51132_QAM_FIRMWARE;
313 /* Set punctured clock for QAM */
317 printk("or51132: Modulation type(%d) UNSUPPORTED\n",
321 printk("or51132: Waiting for firmware upload(%s)...\n",
323 ret = reject_firmware(&fw, fwname, state->i2c->dev.parent);
325 printk(KERN_WARNING "or51132: No firmware uploaded(timeout or file not found?)\n");
328 ret = or51132_load_firmware(fe, fw);
329 release_firmware(fw);
331 printk(KERN_WARNING "or51132: Writing firmware to device failed!\n");
334 printk("or51132: Firmware upload complete.\n");
335 state->config->set_ts_params(fe, clock_mode);
337 /* Change only if we are actually changing the modulation */
338 if (state->current_modulation != p->modulation) {
339 state->current_modulation = p->modulation;
343 if (fe->ops.tuner_ops.set_params) {
344 fe->ops.tuner_ops.set_params(fe);
345 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
348 /* Set to current mode */
351 /* Update current frequency */
352 state->current_frequency = p->frequency;
356 static int or51132_get_parameters(struct dvb_frontend* fe,
357 struct dtv_frontend_properties *p)
359 struct or51132_state* state = fe->demodulator_priv;
364 /* Receiver Status */
365 if ((status = or51132_readreg(state, 0x00)) < 0) {
366 printk(KERN_WARNING "or51132: get_parameters: error reading receiver status\n");
369 switch(status&0xff) {
371 p->modulation = VSB_8;
374 p->modulation = QAM_64;
377 p->modulation = QAM_256;
382 printk(KERN_WARNING "or51132: unknown status 0x%02x\n",
387 /* FIXME: Read frequency from frontend, take AFC into account */
388 p->frequency = state->current_frequency;
390 /* FIXME: How to read inversion setting? Receiver 6 register? */
391 p->inversion = INVERSION_AUTO;
396 static int or51132_read_status(struct dvb_frontend *fe, enum fe_status *status)
398 struct or51132_state* state = fe->demodulator_priv;
401 /* Receiver Status */
402 if ((reg = or51132_readreg(state, 0x00)) < 0) {
403 printk(KERN_WARNING "or51132: read_status: error reading receiver status: %d\n", reg);
407 dprintk("%s: read_status %04x\n", __func__, reg);
409 if (reg & 0x0100) /* Receiver Lock */
410 *status = FE_HAS_SIGNAL|FE_HAS_CARRIER|FE_HAS_VITERBI|
411 FE_HAS_SYNC|FE_HAS_LOCK;
417 /* Calculate SNR estimation (scaled by 2^24)
419 8-VSB SNR and QAM equations from Oren datasheets
422 SNR[dB] = 10 * log10(897152044.8282 / MSE^2 ) - K
424 Where K = 0 if NTSC rejection filter is OFF; and
425 K = 3 if NTSC rejection filter is ON
428 SNR[dB] = 10 * log10(897152044.8282 / MSE^2 )
431 SNR[dB] = 10 * log10(907832426.314266 / MSE^2 )
433 We re-write the snr equation as:
434 SNR * 2^24 = 10*(c - 2*intlog10(MSE))
435 Where for QAM256, c = log10(907832426.314266) * 2^24
436 and for 8-VSB and QAM64, c = log10(897152044.8282) * 2^24 */
438 static u32 calculate_snr(u32 mse, u32 c)
440 if (mse == 0) /* No signal */
443 mse = 2*intlog10(mse);
445 /* Negative SNR, which is possible, but realisticly the
446 demod will lose lock before the signal gets this bad. The
447 API only allows for unsigned values, so just return 0 */
453 static int or51132_read_snr(struct dvb_frontend* fe, u16* snr)
455 struct or51132_state* state = fe->demodulator_priv;
461 /* SNR after Equalizer */
462 noise = or51132_readreg(state, 0x02);
464 printk(KERN_WARNING "or51132: read_snr: error reading equalizer\n");
467 dprintk("read_snr noise (%d)\n", noise);
469 /* Read status, contains modulation type for QAM_AUTO and
470 NTSC filter for VSB */
471 reg = or51132_readreg(state, 0x00);
473 printk(KERN_WARNING "or51132: read_snr: error reading receiver status\n");
479 if (reg & 0x1000) usK = 3 << 24;
481 case 0x43: /* QAM64 */
488 printk(KERN_WARNING "or51132: unknown status 0x%02x\n", reg&0xff);
489 if (retry--) goto start;
492 dprintk("%s: modulation %02x, NTSC rej O%s\n", __func__,
493 reg&0xff, reg&0x1000?"n":"ff");
495 /* Calculate SNR using noise, c, and NTSC rejection correction */
496 state->snr = calculate_snr(noise, c) - usK;
497 *snr = (state->snr) >> 16;
499 dprintk("%s: noise = 0x%08x, snr = %d.%02d dB\n", __func__, noise,
500 state->snr >> 24, (((state->snr>>8) & 0xffff) * 100) >> 16);
505 static int or51132_read_signal_strength(struct dvb_frontend* fe, u16* strength)
507 /* Calculate Strength from SNR up to 35dB */
508 /* Even though the SNR can go higher than 35dB, there is some comfort */
509 /* factor in having a range of strong signals that can show at 100% */
510 struct or51132_state* state = (struct or51132_state*) fe->demodulator_priv;
514 ret = fe->ops.read_snr(fe, &snr);
517 /* Rather than use the 8.8 value snr, use state->snr which is 8.24 */
518 /* scale the range 0 - 35*2^24 into 0 - 65535 */
519 if (state->snr >= 8960 * 0x10000)
522 *strength = state->snr / 8960;
527 static int or51132_get_tune_settings(struct dvb_frontend* fe, struct dvb_frontend_tune_settings* fe_tune_settings)
529 fe_tune_settings->min_delay_ms = 500;
530 fe_tune_settings->step_size = 0;
531 fe_tune_settings->max_drift = 0;
536 static void or51132_release(struct dvb_frontend* fe)
538 struct or51132_state* state = fe->demodulator_priv;
542 static const struct dvb_frontend_ops or51132_ops;
544 struct dvb_frontend* or51132_attach(const struct or51132_config* config,
545 struct i2c_adapter* i2c)
547 struct or51132_state* state = NULL;
549 /* Allocate memory for the internal state */
550 state = kzalloc(sizeof(struct or51132_state), GFP_KERNEL);
554 /* Setup the state */
555 state->config = config;
557 state->current_frequency = -1;
558 state->current_modulation = -1;
560 /* Create dvb_frontend */
561 memcpy(&state->frontend.ops, &or51132_ops, sizeof(struct dvb_frontend_ops));
562 state->frontend.demodulator_priv = state;
563 return &state->frontend;
566 static const struct dvb_frontend_ops or51132_ops = {
567 .delsys = { SYS_ATSC, SYS_DVBC_ANNEX_B },
569 .name = "Oren OR51132 VSB/QAM Frontend",
570 .frequency_min_hz = 44 * MHz,
571 .frequency_max_hz = 958 * MHz,
572 .frequency_stepsize_hz = 166666,
573 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
574 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
575 FE_CAN_QAM_64 | FE_CAN_QAM_256 | FE_CAN_QAM_AUTO |
579 .release = or51132_release,
581 .init = or51132_init,
582 .sleep = or51132_sleep,
584 .set_frontend = or51132_set_parameters,
585 .get_frontend = or51132_get_parameters,
586 .get_tune_settings = or51132_get_tune_settings,
588 .read_status = or51132_read_status,
589 .read_ber = or51132_read_ber,
590 .read_signal_strength = or51132_read_signal_strength,
591 .read_snr = or51132_read_snr,
592 .read_ucblocks = or51132_read_ucblocks,
595 module_param(debug, int, 0644);
596 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
598 MODULE_DESCRIPTION("OR51132 ATSC [pcHDTV HD-3000] (8VSB & ITU J83 AnnexB FEC QAM64/256) Demodulator Driver");
599 MODULE_AUTHOR("Kirk Lapray");
600 MODULE_AUTHOR("Trent Piepho");
601 MODULE_LICENSE("GPL");
603 EXPORT_SYMBOL(or51132_attach);