2 * Support for OR51211 (pcHDTV HD-2000) - VSB
4 * Copyright (C) 2005 Kirk Lapray <kirk_lapray@bigfoot.com>
6 * Based on code from Jack Kelliher (kelliher@xmission.com)
7 * Copyright (C) 2002 & pcHDTV, inc.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #define pr_fmt(fmt) KBUILD_MODNAME ": %s: " fmt, __func__
28 * This driver needs external firmware. Please use the command
29 * "<kerneldir>/Documentation/dvb/get_dvb_firmware or51211" to
30 * download/extract it, and then copy it to /usr/lib/hotplug/firmware
31 * or /lib/firmware (depending on configuration of firmware hotplug).
33 #define OR51211_DEFAULT_FIRMWARE "dvb-fe-or51211.fw"
35 #include <linux/kernel.h>
36 #include <linux/module.h>
37 #include <linux/device.h>
38 #include <linux/firmware.h>
39 #include <linux/string.h>
40 #include <linux/slab.h>
41 #include <asm/byteorder.h>
44 #include "dvb_frontend.h"
48 #define dprintk(args...) \
49 do { if (debug) pr_debug(args); } while (0)
51 static u8 run_buf[] = {0x7f,0x01};
52 static u8 cmd_buf[] = {0x04,0x01,0x50,0x80,0x06}; // ATSC
54 struct or51211_state {
56 struct i2c_adapter* i2c;
58 /* Configuration settings */
59 const struct or51211_config* config;
61 struct dvb_frontend frontend;
64 /* Demodulator private data */
66 u32 snr; /* Result of last SNR claculation */
68 /* Tuner private data */
69 u32 current_frequency;
72 static int i2c_writebytes (struct or51211_state* state, u8 reg, const u8 *buf,
82 if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
83 pr_warn("error (addr %02x, err == %i)\n", reg, err);
90 static int i2c_readbytes(struct or51211_state *state, u8 reg, u8 *buf, int len)
99 if ((err = i2c_transfer (state->i2c, &msg, 1)) != 1) {
100 pr_warn("error (addr %02x, err == %i)\n", reg, err);
107 static int or51211_load_firmware (struct dvb_frontend* fe,
108 const struct firmware *fw)
110 struct or51211_state* state = fe->demodulator_priv;
114 dprintk("Firmware is %zu bytes\n", fw->size);
118 if (i2c_writebytes(state,0x50,tudata,1)) {
119 pr_warn("error eprom addr\n");
122 if (i2c_readbytes(state,0x50,&tudata[145],192)) {
123 pr_warn("error eprom\n");
127 /* Create firmware buffer */
128 for (i = 0; i < 145; i++)
129 tudata[i] = fw->data[i];
131 for (i = 0; i < 248; i++)
132 tudata[i+337] = fw->data[145+i];
134 state->config->reset(fe);
136 if (i2c_writebytes(state,state->config->demod_address,tudata,585)) {
137 pr_warn("error 1\n");
142 if (i2c_writebytes(state,state->config->demod_address,
143 &fw->data[393],8125)) {
144 pr_warn("error 2\n");
149 if (i2c_writebytes(state,state->config->demod_address,run_buf,2)) {
150 pr_warn("error 3\n");
154 /* Wait at least 5 msec */
156 if (i2c_writebytes(state,state->config->demod_address,run_buf,2)) {
157 pr_warn("error 4\n");
166 static int or51211_setmode(struct dvb_frontend* fe, int mode)
168 struct or51211_state* state = fe->demodulator_priv;
171 state->config->setmode(fe, mode);
173 if (i2c_writebytes(state,state->config->demod_address,run_buf,2)) {
174 pr_warn("error 1\n");
178 /* Wait at least 5 msec */
180 if (i2c_writebytes(state,state->config->demod_address,run_buf,2)) {
181 pr_warn("error 2\n");
187 /* Set operation mode in Receiver 1 register;
189 * data 0x50h Automatic sets receiver channel conditions
190 * Automatic NTSC rejection filter
191 * Enable MPEG serial data output
193 * High tuner phase noise
194 * normal +/-150kHz Carrier acquisition range
196 if (i2c_writebytes(state,state->config->demod_address,cmd_buf,3)) {
197 pr_warn("error 3\n");
206 if (i2c_writebytes(state,state->config->demod_address,rec_buf,3)) {
207 pr_warn("error 5\n");
210 if (i2c_readbytes(state,state->config->demod_address,&rec_buf[10],2)) {
211 pr_warn("error 6\n");
214 dprintk("rec status %02x %02x\n", rec_buf[10], rec_buf[11]);
219 static int or51211_set_parameters(struct dvb_frontend *fe)
221 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
222 struct or51211_state* state = fe->demodulator_priv;
224 /* Change only if we are actually changing the channel */
225 if (state->current_frequency != p->frequency) {
226 if (fe->ops.tuner_ops.set_params) {
227 fe->ops.tuner_ops.set_params(fe);
228 if (fe->ops.i2c_gate_ctrl) fe->ops.i2c_gate_ctrl(fe, 0);
231 /* Set to ATSC mode */
232 or51211_setmode(fe,0);
234 /* Update current frequency */
235 state->current_frequency = p->frequency;
240 static int or51211_read_status(struct dvb_frontend *fe, enum fe_status *status)
242 struct or51211_state* state = fe->demodulator_priv;
243 unsigned char rec_buf[2];
244 unsigned char snd_buf[] = {0x04,0x00,0x03,0x00};
247 /* Receiver Status */
248 if (i2c_writebytes(state,state->config->demod_address,snd_buf,3)) {
249 pr_warn("write error\n");
253 if (i2c_readbytes(state,state->config->demod_address,rec_buf,2)) {
254 pr_warn("read error\n");
257 dprintk("%x %x\n", rec_buf[0], rec_buf[1]);
259 if (rec_buf[0] & 0x01) { /* Receiver Lock */
260 *status |= FE_HAS_SIGNAL;
261 *status |= FE_HAS_CARRIER;
262 *status |= FE_HAS_VITERBI;
263 *status |= FE_HAS_SYNC;
264 *status |= FE_HAS_LOCK;
269 /* Calculate SNR estimation (scaled by 2^24)
271 8-VSB SNR equation from Oren datasheets
274 SNR[dB] = 10 * log10(219037.9454 / MSE^2 )
276 We re-write the snr equation as:
277 SNR * 2^24 = 10*(c - 2*intlog10(MSE))
278 Where for 8-VSB, c = log10(219037.9454) * 2^24 */
280 static u32 calculate_snr(u32 mse, u32 c)
282 if (mse == 0) /* No signal */
285 mse = 2*intlog10(mse);
287 /* Negative SNR, which is possible, but realisticly the
288 demod will lose lock before the signal gets this bad. The
289 API only allows for unsigned values, so just return 0 */
295 static int or51211_read_snr(struct dvb_frontend* fe, u16* snr)
297 struct or51211_state* state = fe->demodulator_priv;
301 /* SNR after Equalizer */
306 if (i2c_writebytes(state,state->config->demod_address,snd_buf,3)) {
307 pr_warn("error writing snr reg\n");
310 if (i2c_readbytes(state,state->config->demod_address,rec_buf,2)) {
311 pr_warn("read_status read error\n");
315 state->snr = calculate_snr(rec_buf[0], 89599047);
316 *snr = (state->snr) >> 16;
318 dprintk("noise = 0x%02x, snr = %d.%02d dB\n", rec_buf[0],
319 state->snr >> 24, (((state->snr>>8) & 0xffff) * 100) >> 16);
324 static int or51211_read_signal_strength(struct dvb_frontend* fe, u16* strength)
326 /* Calculate Strength from SNR up to 35dB */
327 /* Even though the SNR can go higher than 35dB, there is some comfort */
328 /* factor in having a range of strong signals that can show at 100% */
329 struct or51211_state* state = (struct or51211_state*)fe->demodulator_priv;
333 ret = fe->ops.read_snr(fe, &snr);
336 /* Rather than use the 8.8 value snr, use state->snr which is 8.24 */
337 /* scale the range 0 - 35*2^24 into 0 - 65535 */
338 if (state->snr >= 8960 * 0x10000)
341 *strength = state->snr / 8960;
346 static int or51211_read_ber(struct dvb_frontend* fe, u32* ber)
352 static int or51211_read_ucblocks(struct dvb_frontend* fe, u32* ucblocks)
358 static int or51211_sleep(struct dvb_frontend* fe)
363 static int or51211_init(struct dvb_frontend* fe)
365 struct or51211_state* state = fe->demodulator_priv;
366 const struct or51211_config* config = state->config;
367 const struct firmware* fw;
368 unsigned char get_ver_buf[] = {0x04,0x00,0x30,0x00,0x00};
369 unsigned char rec_buf[14];
372 if (!state->initialized) {
373 /* Request the firmware, this will block until it uploads */
374 pr_info("Waiting for firmware upload (%s)...\n",
375 OR51211_DEFAULT_FIRMWARE);
376 ret = config->request_firmware(fe, &fw,
377 OR51211_DEFAULT_FIRMWARE);
378 pr_info("Got Hotplug firmware\n");
380 pr_warn("No firmware uploaded (timeout or file not found?)\n");
384 ret = or51211_load_firmware(fe, fw);
385 release_firmware(fw);
387 pr_warn("Writing firmware to device failed!\n");
390 pr_info("Firmware upload complete.\n");
392 /* Set operation mode in Receiver 1 register;
394 * data 0x50h Automatic sets receiver channel conditions
395 * Automatic NTSC rejection filter
396 * Enable MPEG serial data output
398 * High tuner phase noise
399 * normal +/-150kHz Carrier acquisition range
401 if (i2c_writebytes(state,state->config->demod_address,
403 pr_warn("Load DVR Error 5\n");
407 /* Read back ucode version to besure we loaded correctly */
408 /* and are really up and running */
414 if (i2c_writebytes(state,state->config->demod_address,
416 pr_warn("Load DVR Error A\n");
420 if (i2c_readbytes(state,state->config->demod_address,
422 pr_warn("Load DVR Error B\n");
431 if (i2c_writebytes(state,state->config->demod_address,
433 pr_warn("Load DVR Error C\n");
437 if (i2c_readbytes(state,state->config->demod_address,
439 pr_warn("Load DVR Error D\n");
443 for (i = 0; i < 8; i++)
446 for (i = 0; i < 5; i++) {
448 get_ver_buf[4] = i+1;
449 if (i2c_writebytes(state,state->config->demod_address,
451 pr_warn("Load DVR Error 6 - %d\n", i);
456 if (i2c_readbytes(state,state->config->demod_address,
458 pr_warn("Load DVR Error 7 - %d\n", i);
461 /* If we didn't receive the right index, try again */
462 if ((int)rec_buf[i*2+1]!=i+1){
466 dprintk("read_fwbits %10ph\n", rec_buf);
468 pr_info("ver TU%02x%02x%02x VSB mode %02x Status %02x\n",
469 rec_buf[2], rec_buf[4], rec_buf[6], rec_buf[12],
477 if (i2c_writebytes(state,state->config->demod_address,
479 pr_warn("Load DVR Error 8\n");
483 if (i2c_readbytes(state,state->config->demod_address,
485 pr_warn("Load DVR Error 9\n");
488 state->initialized = 1;
494 static int or51211_get_tune_settings(struct dvb_frontend* fe,
495 struct dvb_frontend_tune_settings* fesettings)
497 fesettings->min_delay_ms = 500;
498 fesettings->step_size = 0;
499 fesettings->max_drift = 0;
503 static void or51211_release(struct dvb_frontend* fe)
505 struct or51211_state* state = fe->demodulator_priv;
506 state->config->sleep(fe);
510 static const struct dvb_frontend_ops or51211_ops;
512 struct dvb_frontend* or51211_attach(const struct or51211_config* config,
513 struct i2c_adapter* i2c)
515 struct or51211_state* state = NULL;
517 /* Allocate memory for the internal state */
518 state = kzalloc(sizeof(struct or51211_state), GFP_KERNEL);
522 /* Setup the state */
523 state->config = config;
525 state->initialized = 0;
526 state->current_frequency = 0;
528 /* Create dvb_frontend */
529 memcpy(&state->frontend.ops, &or51211_ops, sizeof(struct dvb_frontend_ops));
530 state->frontend.demodulator_priv = state;
531 return &state->frontend;
534 static const struct dvb_frontend_ops or51211_ops = {
535 .delsys = { SYS_ATSC, SYS_DVBC_ANNEX_B },
537 .name = "Oren OR51211 VSB Frontend",
538 .frequency_min = 44000000,
539 .frequency_max = 958000000,
540 .frequency_stepsize = 166666,
541 .caps = FE_CAN_FEC_1_2 | FE_CAN_FEC_2_3 | FE_CAN_FEC_3_4 |
542 FE_CAN_FEC_5_6 | FE_CAN_FEC_7_8 | FE_CAN_FEC_AUTO |
546 .release = or51211_release,
548 .init = or51211_init,
549 .sleep = or51211_sleep,
551 .set_frontend = or51211_set_parameters,
552 .get_tune_settings = or51211_get_tune_settings,
554 .read_status = or51211_read_status,
555 .read_ber = or51211_read_ber,
556 .read_signal_strength = or51211_read_signal_strength,
557 .read_snr = or51211_read_snr,
558 .read_ucblocks = or51211_read_ucblocks,
561 module_param(debug, int, 0644);
562 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
564 MODULE_DESCRIPTION("Oren OR51211 VSB [pcHDTV HD-2000] Demodulator Driver");
565 MODULE_AUTHOR("Kirk Lapray");
566 MODULE_LICENSE("GPL");
568 EXPORT_SYMBOL(or51211_attach);