2 * Driver for Silicon Labs Si2161 DVB-T and Si2165 DVB-C/-T Demodulator
4 * Copyright (C) 2013-2014 Matthias Schwarzott <zzam@gentoo.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 * http://www.silabs.com/Support%20Documents/TechnicalDocs/Si2165-short.pdf
20 #include <linux/delay.h>
21 #include <linux/errno.h>
22 #include <linux/init.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/string.h>
26 #include <linux/slab.h>
27 #include <linux/firmware.h>
29 #include "dvb_frontend.h"
31 #include "si2165_priv.h"
35 * Hauppauge WinTV-HVR-930C-HD B130 / PCTV QuatroStick 521e 1113xx
38 * Hauppauge WinTV-HVR-930C-HD B131 / PCTV QuatroStick 522e 1114xx
39 * uses 24 MHz clock provided by tuner
43 struct i2c_adapter *i2c;
45 struct dvb_frontend fe;
47 struct si2165_config config;
52 /* calculated by xtal and div settings */
62 #define DEBUG_OTHER 0x01
63 #define DEBUG_I2C_WRITE 0x02
64 #define DEBUG_I2C_READ 0x04
65 #define DEBUG_REG_READ 0x08
66 #define DEBUG_REG_WRITE 0x10
67 #define DEBUG_FW_LOAD 0x20
69 static int debug = 0x00;
71 #define dprintk(args...) \
73 if (debug & DEBUG_OTHER) \
74 printk(KERN_DEBUG "si2165: " args); \
77 #define deb_i2c_write(args...) \
79 if (debug & DEBUG_I2C_WRITE) \
80 printk(KERN_DEBUG "si2165: i2c write: " args); \
83 #define deb_i2c_read(args...) \
85 if (debug & DEBUG_I2C_READ) \
86 printk(KERN_DEBUG "si2165: i2c read: " args); \
89 #define deb_readreg(args...) \
91 if (debug & DEBUG_REG_READ) \
92 printk(KERN_DEBUG "si2165: reg read: " args); \
95 #define deb_writereg(args...) \
97 if (debug & DEBUG_REG_WRITE) \
98 printk(KERN_DEBUG "si2165: reg write: " args); \
101 #define deb_fw_load(args...) \
103 if (debug & DEBUG_FW_LOAD) \
104 printk(KERN_DEBUG "si2165: fw load: " args); \
107 static int si2165_write(struct si2165_state *state, const u16 reg,
108 const u8 *src, const int count)
112 u8 buf[2 + 4]; /* write a maximum of 4 bytes of data */
114 if (count + 2 > sizeof(buf)) {
115 dev_warn(&state->i2c->dev,
116 "%s: i2c wr reg=%04x: count=%d is too big!\n",
117 KBUILD_MODNAME, reg, count);
122 memcpy(buf + 2, src, count);
124 msg.addr = state->config.i2c_addr;
129 if (debug & DEBUG_I2C_WRITE)
130 deb_i2c_write("reg: 0x%04x, data: %*ph\n", reg, count, src);
132 ret = i2c_transfer(state->i2c, &msg, 1);
135 dev_err(&state->i2c->dev, "%s: ret == %d\n", __func__, ret);
145 static int si2165_read(struct si2165_state *state,
146 const u16 reg, u8 *val, const int count)
149 u8 reg_buf[] = { reg >> 8, reg & 0xff };
150 struct i2c_msg msg[] = {
151 { .addr = state->config.i2c_addr,
152 .flags = 0, .buf = reg_buf, .len = 2 },
153 { .addr = state->config.i2c_addr,
154 .flags = I2C_M_RD, .buf = val, .len = count },
157 ret = i2c_transfer(state->i2c, msg, 2);
160 dev_err(&state->i2c->dev, "%s: error (addr %02x reg %04x error (ret == %i)\n",
161 __func__, state->config.i2c_addr, reg, ret);
168 if (debug & DEBUG_I2C_READ)
169 deb_i2c_read("reg: 0x%04x, data: %*ph\n", reg, count, val);
174 static int si2165_readreg8(struct si2165_state *state,
175 const u16 reg, u8 *val)
179 ret = si2165_read(state, reg, val, 1);
180 deb_readreg("R(0x%04x)=0x%02x\n", reg, *val);
184 static int si2165_readreg16(struct si2165_state *state,
185 const u16 reg, u16 *val)
189 int ret = si2165_read(state, reg, buf, 2);
190 *val = buf[0] | buf[1] << 8;
191 deb_readreg("R(0x%04x)=0x%04x\n", reg, *val);
195 static int si2165_writereg8(struct si2165_state *state, const u16 reg, u8 val)
197 return si2165_write(state, reg, &val, 1);
200 static int si2165_writereg16(struct si2165_state *state, const u16 reg, u16 val)
202 u8 buf[2] = { val & 0xff, (val >> 8) & 0xff };
204 return si2165_write(state, reg, buf, 2);
207 static int si2165_writereg24(struct si2165_state *state, const u16 reg, u32 val)
209 u8 buf[3] = { val & 0xff, (val >> 8) & 0xff, (val >> 16) & 0xff };
211 return si2165_write(state, reg, buf, 3);
214 static int si2165_writereg32(struct si2165_state *state, const u16 reg, u32 val)
222 return si2165_write(state, reg, buf, 4);
225 static int si2165_writereg_mask8(struct si2165_state *state, const u16 reg,
232 ret = si2165_readreg8(state, reg, &tmp);
241 ret = si2165_writereg8(state, reg, val);
246 static int si2165_get_tune_settings(struct dvb_frontend *fe,
247 struct dvb_frontend_tune_settings *s)
249 s->min_delay_ms = 1000;
253 static int si2165_init_pll(struct si2165_state *state)
255 u32 ref_freq_Hz = state->config.ref_freq_Hz;
256 u8 divr = 1; /* 1..7 */
257 u8 divp = 1; /* only 1 or 4 */
258 u8 divn = 56; /* 1..63 */
264 * hardcoded values can be deleted if calculation is verified
265 * or it yields the same values as the windows driver
267 switch (ref_freq_Hz) {
277 /* ref_freq / divr must be between 4 and 16 MHz */
278 if (ref_freq_Hz > 16000000u)
282 * now select divn and divp such that
283 * fvco is in 1624..1824 MHz
285 if (1624000000u * divr > ref_freq_Hz * 2u * 63u)
288 /* is this already correct regarding rounding? */
289 divn = 1624000000u * divr / (ref_freq_Hz * 2u * divp);
293 /* adc_clk and sys_clk depend on xtal and pll settings */
294 state->fvco_hz = ref_freq_Hz / divr
296 state->adc_clk = state->fvco_hz / (divm * 4u);
297 state->sys_clk = state->fvco_hz / (divl * 2u);
299 /* write pll registers 0x00a0..0x00a3 at once */
302 buf[2] = (divn & 0x3f) | ((divp == 1) ? 0x40 : 0x00) | 0x80;
304 return si2165_write(state, 0x00a0, buf, 4);
307 static int si2165_adjust_pll_divl(struct si2165_state *state, u8 divl)
309 state->sys_clk = state->fvco_hz / (divl * 2u);
310 return si2165_writereg8(state, 0x00a0, divl); /* pll_divl */
313 static u32 si2165_get_fe_clk(struct si2165_state *state)
315 /* assume Oversampling mode Ovr4 is used */
316 return state->adc_clk;
319 static int si2165_wait_init_done(struct si2165_state *state)
325 for (i = 0; i < 3; ++i) {
326 si2165_readreg8(state, 0x0054, &val);
329 usleep_range(1000, 50000);
331 dev_err(&state->i2c->dev, "%s: init_done was not set\n",
336 static int si2165_upload_firmware_block(struct si2165_state *state,
337 const u8 *data, u32 len, u32 *poffset, u32 block_count)
340 u8 buf_ctrl[4] = { 0x00, 0x00, 0x00, 0xc0 };
343 u32 offset = poffset ? *poffset : 0;
351 "si2165_upload_firmware_block called with len=0x%x offset=0x%x blockcount=0x%x\n",
352 len, offset, block_count);
353 while (offset+12 <= len && cur_block < block_count) {
355 "si2165_upload_firmware_block in while len=0x%x offset=0x%x cur_block=0x%x blockcount=0x%x\n",
356 len, offset, cur_block, block_count);
357 wordcount = data[offset];
358 if (wordcount < 1 || data[offset+1] ||
359 data[offset+2] || data[offset+3]) {
360 dev_warn(&state->i2c->dev,
361 "%s: bad fw data[0..3] = %*ph\n",
362 KBUILD_MODNAME, 4, data);
366 if (offset + 8 + wordcount * 4 > len) {
367 dev_warn(&state->i2c->dev,
368 "%s: len is too small for block len=%d, wordcount=%d\n",
369 KBUILD_MODNAME, len, wordcount);
373 buf_ctrl[0] = wordcount - 1;
375 ret = si2165_write(state, 0x0364, buf_ctrl, 4);
378 ret = si2165_write(state, 0x0368, data+offset+4, 4);
384 while (wordcount > 0) {
385 ret = si2165_write(state, 0x36c, data+offset, 4);
395 "si2165_upload_firmware_block after while len=0x%x offset=0x%x cur_block=0x%x blockcount=0x%x\n",
396 len, offset, cur_block, block_count);
401 deb_fw_load("si2165_upload_firmware_block returned offset=0x%x\n",
409 static int si2165_upload_firmware(struct si2165_state *state)
416 const struct firmware *fw = NULL;
425 switch (state->chip_revcode) {
426 case 0x03: /* revision D */
427 fw_file = SI2165_FIRMWARE_REV_D;
430 dev_info(&state->i2c->dev, "%s: no firmware file for revision=%d\n",
431 KBUILD_MODNAME, state->chip_revcode);
435 /* request the firmware, this will block and timeout */
436 ret = request_firmware(&fw, fw_file, state->i2c->dev.parent);
438 dev_warn(&state->i2c->dev, "%s: firmware file '%s' not found\n",
439 KBUILD_MODNAME, fw_file);
446 dev_info(&state->i2c->dev, "%s: downloading firmware from file '%s' size=%d\n",
447 KBUILD_MODNAME, fw_file, len);
450 dev_warn(&state->i2c->dev, "%s: firmware size is not multiple of 4\n",
456 /* check header (8 bytes) */
458 dev_warn(&state->i2c->dev, "%s: firmware header is missing\n",
464 if (data[0] != 1 || data[1] != 0) {
465 dev_warn(&state->i2c->dev, "%s: firmware file version is wrong\n",
471 patch_version = data[2];
472 block_count = data[4];
473 crc_expected = data[7] << 8 | data[6];
475 /* start uploading fw */
476 /* boot/wdog status */
477 ret = si2165_writereg8(state, 0x0341, 0x00);
481 ret = si2165_writereg8(state, 0x00c0, 0x00);
484 /* boot/wdog status */
485 ret = si2165_readreg8(state, 0x0341, val);
489 /* enable reset on error */
490 ret = si2165_readreg8(state, 0x035c, val);
493 ret = si2165_readreg8(state, 0x035c, val);
496 ret = si2165_writereg8(state, 0x035c, 0x02);
500 /* start right after the header */
503 dev_info(&state->i2c->dev, "%s: si2165_upload_firmware extracted patch_version=0x%02x, block_count=0x%02x, crc_expected=0x%04x\n",
504 KBUILD_MODNAME, patch_version, block_count, crc_expected);
506 ret = si2165_upload_firmware_block(state, data, len, &offset, 1);
510 ret = si2165_writereg8(state, 0x0344, patch_version);
515 ret = si2165_writereg8(state, 0x0379, 0x01);
519 ret = si2165_upload_firmware_block(state, data, len,
520 &offset, block_count);
522 dev_err(&state->i2c->dev,
523 "%s: firmare could not be uploaded\n",
529 ret = si2165_readreg16(state, 0x037a, &val16);
533 if (val16 != crc_expected) {
534 dev_err(&state->i2c->dev,
535 "%s: firmware crc mismatch %04x != %04x\n",
536 KBUILD_MODNAME, val16, crc_expected);
541 ret = si2165_upload_firmware_block(state, data, len, &offset, 5);
546 dev_err(&state->i2c->dev,
547 "%s: firmare len mismatch %04x != %04x\n",
548 KBUILD_MODNAME, len, offset);
553 /* reset watchdog error register */
554 ret = si2165_writereg_mask8(state, 0x0341, 0x02, 0x02);
558 /* enable reset on error */
559 ret = si2165_writereg_mask8(state, 0x035c, 0x01, 0x01);
563 dev_info(&state->i2c->dev, "%s: fw load finished\n", KBUILD_MODNAME);
566 state->firmware_loaded = true;
569 release_firmware(fw);
576 static int si2165_init(struct dvb_frontend *fe)
579 struct si2165_state *state = fe->demodulator_priv;
581 u8 patch_version = 0x00;
583 dprintk("%s: called\n", __func__);
586 ret = si2165_writereg8(state, 0x0000, state->config.chip_mode);
589 /* dsp_clock_enable */
590 ret = si2165_writereg8(state, 0x0104, 0x01);
593 ret = si2165_readreg8(state, 0x0000, &val); /* verify chip_mode */
596 if (val != state->config.chip_mode) {
597 dev_err(&state->i2c->dev, "%s: could not set chip_mode\n",
603 ret = si2165_writereg8(state, 0x018b, 0x00);
606 ret = si2165_writereg8(state, 0x0190, 0x01);
609 ret = si2165_writereg8(state, 0x0170, 0x00);
612 ret = si2165_writereg8(state, 0x0171, 0x07);
616 ret = si2165_writereg8(state, 0x0646, 0x00);
619 ret = si2165_writereg8(state, 0x0641, 0x00);
623 ret = si2165_init_pll(state);
627 /* enable chip_init */
628 ret = si2165_writereg8(state, 0x0050, 0x01);
632 ret = si2165_writereg8(state, 0x0096, 0x01);
635 ret = si2165_wait_init_done(state);
639 /* disable chip_init */
640 ret = si2165_writereg8(state, 0x0050, 0x00);
645 ret = si2165_writereg16(state, 0x0470, 0x7530);
649 ret = si2165_readreg8(state, 0x0344, &patch_version);
653 ret = si2165_writereg8(state, 0x00cb, 0x00);
658 ret = si2165_writereg32(state, 0x0348, 0xf4000000);
661 /* boot/wdog status */
662 ret = si2165_readreg8(state, 0x0341, &val);
666 if (patch_version == 0x00) {
667 ret = si2165_upload_firmware(state);
672 /* write adc values after each reset*/
673 ret = si2165_writereg8(state, 0x012a, 0x46);
676 ret = si2165_writereg8(state, 0x012c, 0x00);
679 ret = si2165_writereg8(state, 0x012e, 0x0a);
682 ret = si2165_writereg8(state, 0x012f, 0xff);
685 ret = si2165_writereg8(state, 0x0123, 0x70);
694 static int si2165_sleep(struct dvb_frontend *fe)
697 struct si2165_state *state = fe->demodulator_priv;
699 /* dsp clock disable */
700 ret = si2165_writereg8(state, 0x0104, 0x00);
704 ret = si2165_writereg8(state, 0x0000, SI2165_MODE_OFF);
710 static int si2165_read_status(struct dvb_frontend *fe, enum fe_status *status)
714 struct si2165_state *state = fe->demodulator_priv;
716 if (!state->has_dvbt)
720 ret = si2165_readreg8(state, 0x4e0, &fec_lock);
724 if (fec_lock & 0x01) {
725 *status |= FE_HAS_SIGNAL;
726 *status |= FE_HAS_CARRIER;
727 *status |= FE_HAS_VITERBI;
728 *status |= FE_HAS_SYNC;
729 *status |= FE_HAS_LOCK;
735 static int si2165_set_oversamp(struct si2165_state *state, u32 dvb_rate)
740 oversamp = si2165_get_fe_clk(state);
742 do_div(oversamp, dvb_rate);
743 reg_value = oversamp & 0x3fffffff;
745 /* oversamp, usbdump contained 0x03100000; */
746 return si2165_writereg32(state, 0x00e4, reg_value);
749 static int si2165_set_if_freq_shift(struct si2165_state *state, u32 IF)
753 u32 fe_clk = si2165_get_fe_clk(state);
756 if_freq_shift <<= 29;
758 do_div(if_freq_shift, fe_clk);
759 reg_value = (s32)if_freq_shift;
761 if (state->config.inversion)
762 reg_value = -reg_value;
764 reg_value = reg_value & 0x1fffffff;
766 /* if_freq_shift, usbdump contained 0x023ee08f; */
767 return si2165_writereg32(state, 0x00e8, reg_value);
770 static int si2165_set_parameters(struct dvb_frontend *fe)
773 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
774 struct si2165_state *state = fe->demodulator_priv;
780 dprintk("%s: called\n", __func__);
782 if (!fe->ops.tuner_ops.get_if_frequency) {
783 dev_err(&state->i2c->dev,
784 "%s: Error: get_if_frequency() not defined at tuner. Can't work without it!\n",
789 if (!state->has_dvbt)
792 if (p->bandwidth_hz > 0) {
793 dvb_rate = p->bandwidth_hz * 8 / 7;
794 bw10k = p->bandwidth_hz / 10000;
796 dvb_rate = 8 * 8 / 7;
800 /* standard = DVB-T */
801 ret = si2165_writereg8(state, 0x00ec, 0x01);
804 ret = si2165_adjust_pll_divl(state, 12);
808 fe->ops.tuner_ops.get_if_frequency(fe, &IF);
809 ret = si2165_set_if_freq_shift(state, IF);
812 ret = si2165_writereg8(state, 0x08f8, 0x00);
815 /* ts output config */
816 ret = si2165_writereg8(state, 0x04e4, 0x20);
819 ret = si2165_writereg16(state, 0x04ef, 0x00fe);
822 ret = si2165_writereg24(state, 0x04f4, 0x555555);
825 ret = si2165_writereg8(state, 0x04e5, 0x01);
828 /* bandwidth in 10KHz steps */
829 ret = si2165_writereg16(state, 0x0308, bw10k);
832 ret = si2165_set_oversamp(state, dvb_rate);
835 /* impulsive_noise_remover */
836 ret = si2165_writereg8(state, 0x031c, 0x01);
839 ret = si2165_writereg8(state, 0x00cb, 0x00);
843 ret = si2165_writereg8(state, 0x016e, 0x41);
846 ret = si2165_writereg8(state, 0x016c, 0x0e);
849 ret = si2165_writereg8(state, 0x016d, 0x10);
853 ret = si2165_writereg8(state, 0x015b, 0x03);
856 ret = si2165_writereg8(state, 0x0150, 0x78);
860 ret = si2165_writereg8(state, 0x01a0, 0x78);
863 ret = si2165_writereg8(state, 0x01c8, 0x68);
866 /* freq_sync_range */
867 ret = si2165_writereg16(state, 0x030c, 0x0064);
871 ret = si2165_readreg8(state, 0x0387, val);
874 ret = si2165_writereg8(state, 0x0387, 0x00);
878 ret = si2165_writereg32(state, 0x0348, 0xf4000000);
882 if (fe->ops.tuner_ops.set_params)
883 fe->ops.tuner_ops.set_params(fe);
885 /* recalc if_freq_shift if IF might has changed */
886 fe->ops.tuner_ops.get_if_frequency(fe, &IF);
887 ret = si2165_set_if_freq_shift(state, IF);
891 /* boot/wdog status */
892 ret = si2165_readreg8(state, 0x0341, val);
895 ret = si2165_writereg8(state, 0x0341, 0x00);
899 ret = si2165_writereg8(state, 0x00c0, 0x00);
903 ret = si2165_writereg32(state, 0x0384, 0x00000000);
907 ret = si2165_writereg8(state, 0x02e0, 0x01);
910 /* boot/wdog status */
911 ret = si2165_readreg8(state, 0x0341, val);
918 static void si2165_release(struct dvb_frontend *fe)
920 struct si2165_state *state = fe->demodulator_priv;
922 dprintk("%s: called\n", __func__);
926 static struct dvb_frontend_ops si2165_ops = {
928 .name = "Silicon Labs ",
929 .caps = FE_CAN_FEC_1_2 |
942 FE_CAN_TRANSMISSION_MODE_AUTO |
943 FE_CAN_GUARD_INTERVAL_AUTO |
944 FE_CAN_HIERARCHY_AUTO |
946 FE_CAN_TRANSMISSION_MODE_AUTO |
950 .get_tune_settings = si2165_get_tune_settings,
953 .sleep = si2165_sleep,
955 .set_frontend = si2165_set_parameters,
956 .read_status = si2165_read_status,
958 .release = si2165_release,
961 struct dvb_frontend *si2165_attach(const struct si2165_config *config,
962 struct i2c_adapter *i2c)
964 struct si2165_state *state = NULL;
969 const char *chip_name;
971 if (config == NULL || i2c == NULL)
974 /* allocate memory for the internal state */
975 state = kzalloc(sizeof(struct si2165_state), GFP_KERNEL);
979 /* setup the state */
981 state->config = *config;
983 if (state->config.ref_freq_Hz < 4000000
984 || state->config.ref_freq_Hz > 27000000) {
985 dev_err(&state->i2c->dev, "%s: ref_freq of %d Hz not supported by this driver\n",
986 KBUILD_MODNAME, state->config.ref_freq_Hz);
990 /* create dvb_frontend */
991 memcpy(&state->fe.ops, &si2165_ops,
992 sizeof(struct dvb_frontend_ops));
993 state->fe.demodulator_priv = state;
996 io_ret = si2165_writereg8(state, 0x0000, state->config.chip_mode);
1000 io_ret = si2165_readreg8(state, 0x0000, &val);
1003 if (val != state->config.chip_mode)
1006 io_ret = si2165_readreg8(state, 0x0023, &state->chip_revcode);
1010 io_ret = si2165_readreg8(state, 0x0118, &state->chip_type);
1015 io_ret = si2165_writereg8(state, 0x0000, SI2165_MODE_OFF);
1019 if (state->chip_revcode < 26)
1020 rev_char = 'A' + state->chip_revcode;
1024 switch (state->chip_type) {
1026 chip_name = "Si2161";
1027 state->has_dvbt = true;
1030 chip_name = "Si2165";
1031 state->has_dvbt = true;
1032 state->has_dvbc = true;
1035 dev_err(&state->i2c->dev, "%s: Unsupported Silicon Labs chip (type %d, rev %d)\n",
1036 KBUILD_MODNAME, state->chip_type, state->chip_revcode);
1040 dev_info(&state->i2c->dev,
1041 "%s: Detected Silicon Labs %s-%c (type %d, rev %d)\n",
1042 KBUILD_MODNAME, chip_name, rev_char, state->chip_type,
1043 state->chip_revcode);
1045 strlcat(state->fe.ops.info.name, chip_name,
1046 sizeof(state->fe.ops.info.name));
1049 if (state->has_dvbt) {
1050 state->fe.ops.delsys[n++] = SYS_DVBT;
1051 strlcat(state->fe.ops.info.name, " DVB-T",
1052 sizeof(state->fe.ops.info.name));
1054 if (state->has_dvbc)
1055 dev_warn(&state->i2c->dev, "%s: DVB-C is not yet supported.\n",
1064 EXPORT_SYMBOL(si2165_attach);
1066 module_param(debug, int, 0644);
1067 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
1069 MODULE_DESCRIPTION("Silicon Labs Si2165 DVB-C/-T Demodulator driver");
1070 MODULE_AUTHOR("Matthias Schwarzott <zzam@gentoo.org>");
1071 MODULE_LICENSE("GPL");
1072 MODULE_FIRMWARE(SI2165_FIRMWARE_REV_D);