2 Driver for Silicon Labs 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"
34 /* Hauppauge WinTV-HVR-930C-HD B130 / PCTV QuatroStick 521e 1113xx
37 /* Hauppauge WinTV-HVR-930C-HD B131 / PCTV QuatroStick 522e 1114xx
38 * uses 24 MHz clock provided by tuner */
41 struct i2c_adapter *i2c;
43 struct dvb_frontend frontend;
45 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 */
263 /* hardcoded values can be deleted if calculation is verified
264 * or it yields the same values as the windows driver */
265 switch (ref_freq_Hz) {
275 /* ref_freq / divr must be between 4 and 16 MHz */
276 if (ref_freq_Hz > 16000000u)
279 /* now select divn and divp such that
280 * fvco is in 1624..1824 MHz */
281 if (1624000000u * divr > ref_freq_Hz * 2u * 63u)
284 /* is this already correct regarding rounding? */
285 divn = 1624000000u * divr / (ref_freq_Hz * 2u * divp);
289 /* adc_clk and sys_clk depend on xtal and pll settings */
290 state->fvco_hz = ref_freq_Hz / divr
292 state->adc_clk = state->fvco_hz / (divm * 4u);
293 state->sys_clk = state->fvco_hz / (divl * 2u);
295 /* write pll registers 0x00a0..0x00a3 at once */
298 buf[2] = (divn & 0x3f) | ((divp == 1) ? 0x40 : 0x00) | 0x80;
300 return si2165_write(state, 0x00a0, buf, 4);
303 static int si2165_adjust_pll_divl(struct si2165_state *state, u8 divl)
305 state->sys_clk = state->fvco_hz / (divl * 2u);
306 return si2165_writereg8(state, 0x00a0, divl); /* pll_divl */
309 static u32 si2165_get_fe_clk(struct si2165_state *state)
311 /* assume Oversampling mode Ovr4 is used */
312 return state->adc_clk;
315 static bool si2165_wait_init_done(struct si2165_state *state)
321 for (i = 0; i < 3; ++i) {
322 si2165_readreg8(state, 0x0054, &val);
325 usleep_range(1000, 50000);
327 dev_err(&state->i2c->dev, "%s: init_done was not set\n",
332 static int si2165_upload_firmware_block(struct si2165_state *state,
333 const u8 *data, u32 len, u32 *poffset, u32 block_count)
336 u8 buf_ctrl[4] = { 0x00, 0x00, 0x00, 0xc0 };
339 u32 offset = poffset ? *poffset : 0;
346 deb_fw_load("si2165_upload_firmware_block called with len=0x%x offset=0x%x blockcount=0x%x\n",
347 len, offset, block_count);
348 while (offset+12 <= len && cur_block < block_count) {
349 deb_fw_load("si2165_upload_firmware_block in while len=0x%x offset=0x%x cur_block=0x%x blockcount=0x%x\n",
350 len, offset, cur_block, block_count);
351 wordcount = data[offset];
352 if (wordcount < 1 || data[offset+1] ||
353 data[offset+2] || data[offset+3]) {
354 dev_warn(&state->i2c->dev,
355 "%s: bad fw data[0..3] = %*ph\n",
356 KBUILD_MODNAME, 4, data);
360 if (offset + 8 + wordcount * 4 > len) {
361 dev_warn(&state->i2c->dev,
362 "%s: len is too small for block len=%d, wordcount=%d\n",
363 KBUILD_MODNAME, len, wordcount);
367 buf_ctrl[0] = wordcount - 1;
369 ret = si2165_write(state, 0x0364, buf_ctrl, 4);
372 ret = si2165_write(state, 0x0368, data+offset+4, 4);
378 while (wordcount > 0) {
379 ret = si2165_write(state, 0x36c, data+offset, 4);
388 deb_fw_load("si2165_upload_firmware_block after while len=0x%x offset=0x%x cur_block=0x%x blockcount=0x%x\n",
389 len, offset, cur_block, block_count);
394 deb_fw_load("si2165_upload_firmware_block returned offset=0x%x\n",
402 static int si2165_upload_firmware(struct si2165_state *state)
409 const struct firmware *fw = NULL;
410 u8 *fw_file = SI2165_FIRMWARE;
418 /* request the firmware, this will block and timeout */
419 ret = request_firmware(&fw, fw_file, state->i2c->dev.parent);
421 dev_warn(&state->i2c->dev, "%s: firmare file '%s' not found\n",
422 KBUILD_MODNAME, fw_file);
429 dev_info(&state->i2c->dev, "%s: downloading firmware from file '%s' size=%d\n",
430 KBUILD_MODNAME, fw_file, len);
433 dev_warn(&state->i2c->dev, "%s: firmware size is not multiple of 4\n",
439 /* check header (8 bytes) */
441 dev_warn(&state->i2c->dev, "%s: firmware header is missing\n",
447 if (data[0] != 1 || data[1] != 0) {
448 dev_warn(&state->i2c->dev, "%s: firmware file version is wrong\n",
454 patch_version = data[2];
455 block_count = data[4];
456 crc_expected = data[7] << 8 | data[6];
458 /* start uploading fw */
459 /* boot/wdog status */
460 ret = si2165_writereg8(state, 0x0341, 0x00);
464 ret = si2165_writereg8(state, 0x00c0, 0x00);
467 /* boot/wdog status */
468 ret = si2165_readreg8(state, 0x0341, val);
472 /* enable reset on error */
473 ret = si2165_readreg8(state, 0x035c, val);
476 ret = si2165_readreg8(state, 0x035c, val);
479 ret = si2165_writereg8(state, 0x035c, 0x02);
483 /* start right after the header */
486 dev_info(&state->i2c->dev, "%s: si2165_upload_firmware extracted patch_version=0x%02x, block_count=0x%02x, crc_expected=0x%04x\n",
487 KBUILD_MODNAME, patch_version, block_count, crc_expected);
489 ret = si2165_upload_firmware_block(state, data, len, &offset, 1);
493 ret = si2165_writereg8(state, 0x0344, patch_version);
498 ret = si2165_writereg8(state, 0x0379, 0x01);
502 ret = si2165_upload_firmware_block(state, data, len,
503 &offset, block_count);
505 dev_err(&state->i2c->dev,
506 "%s: firmare could not be uploaded\n",
512 ret = si2165_readreg16(state, 0x037a, &val16);
516 if (val16 != crc_expected) {
517 dev_err(&state->i2c->dev,
518 "%s: firmware crc mismatch %04x != %04x\n",
519 KBUILD_MODNAME, val16, crc_expected);
524 ret = si2165_upload_firmware_block(state, data, len, &offset, 5);
529 dev_err(&state->i2c->dev,
530 "%s: firmare len mismatch %04x != %04x\n",
531 KBUILD_MODNAME, len, offset);
536 /* reset watchdog error register */
537 ret = si2165_writereg_mask8(state, 0x0341, 0x02, 0x02);
541 /* enable reset on error */
542 ret = si2165_writereg_mask8(state, 0x035c, 0x01, 0x01);
546 dev_info(&state->i2c->dev, "%s: fw load finished\n", KBUILD_MODNAME);
549 state->firmware_loaded = true;
552 release_firmware(fw);
559 static int si2165_init(struct dvb_frontend *fe)
562 struct si2165_state *state = fe->demodulator_priv;
564 u8 patch_version = 0x00;
566 dprintk("%s: called\n", __func__);
569 ret = si2165_writereg8(state, 0x0000, state->config.chip_mode);
572 /* dsp_clock_enable */
573 ret = si2165_writereg8(state, 0x0104, 0x01);
576 ret = si2165_readreg8(state, 0x0000, &val); /* verify chip_mode */
579 if (val != state->config.chip_mode) {
580 dev_err(&state->i2c->dev, "%s: could not set chip_mode\n",
586 ret = si2165_writereg8(state, 0x018b, 0x00);
589 ret = si2165_writereg8(state, 0x0190, 0x01);
592 ret = si2165_writereg8(state, 0x0170, 0x00);
595 ret = si2165_writereg8(state, 0x0171, 0x07);
599 ret = si2165_writereg8(state, 0x0646, 0x00);
602 ret = si2165_writereg8(state, 0x0641, 0x00);
606 ret = si2165_init_pll(state);
610 /* enable chip_init */
611 ret = si2165_writereg8(state, 0x0050, 0x01);
615 ret = si2165_writereg8(state, 0x0096, 0x01);
618 ret = si2165_wait_init_done(state);
622 /* disable chip_init */
623 ret = si2165_writereg8(state, 0x0050, 0x00);
628 ret = si2165_writereg16(state, 0x0470 , 0x7530);
632 ret = si2165_readreg8(state, 0x0344, &patch_version);
636 ret = si2165_writereg8(state, 0x00cb, 0x00);
641 ret = si2165_writereg32(state, 0x0348, 0xf4000000);
644 /* boot/wdog status */
645 ret = si2165_readreg8(state, 0x0341, &val);
649 if (patch_version == 0x00) {
650 ret = si2165_upload_firmware(state);
655 /* write adc values after each reset*/
656 ret = si2165_writereg8(state, 0x012a, 0x46);
659 ret = si2165_writereg8(state, 0x012c, 0x00);
662 ret = si2165_writereg8(state, 0x012e, 0x0a);
665 ret = si2165_writereg8(state, 0x012f, 0xff);
668 ret = si2165_writereg8(state, 0x0123, 0x70);
677 static int si2165_sleep(struct dvb_frontend *fe)
680 struct si2165_state *state = fe->demodulator_priv;
682 /* dsp clock disable */
683 ret = si2165_writereg8(state, 0x0104, 0x00);
687 ret = si2165_writereg8(state, 0x0000, SI2165_MODE_OFF);
693 static int si2165_read_status(struct dvb_frontend *fe, fe_status_t *status)
697 struct si2165_state *state = fe->demodulator_priv;
699 if (!state->has_dvbt)
703 ret = si2165_readreg8(state, 0x4e0, &fec_lock);
707 if (fec_lock & 0x01) {
708 *status |= FE_HAS_SIGNAL;
709 *status |= FE_HAS_CARRIER;
710 *status |= FE_HAS_VITERBI;
711 *status |= FE_HAS_SYNC;
712 *status |= FE_HAS_LOCK;
718 static int si2165_set_oversamp(struct si2165_state *state, u32 dvb_rate)
723 oversamp = si2165_get_fe_clk(state);
725 do_div(oversamp, dvb_rate);
726 reg_value = oversamp & 0x3fffffff;
728 /* oversamp, usbdump contained 0x03100000; */
729 return si2165_writereg32(state, 0x00e4, reg_value);
732 static int si2165_set_if_freq_shift(struct si2165_state *state, u32 IF)
736 u32 fe_clk = si2165_get_fe_clk(state);
739 if_freq_shift <<= 29;
741 do_div(if_freq_shift, fe_clk);
742 reg_value = (s32)if_freq_shift;
744 if (state->config.inversion)
745 reg_value = -reg_value;
747 reg_value = reg_value & 0x1fffffff;
749 /* if_freq_shift, usbdump contained 0x023ee08f; */
750 return si2165_writereg32(state, 0x00e8, reg_value);
753 static int si2165_set_parameters(struct dvb_frontend *fe)
756 struct dtv_frontend_properties *p = &fe->dtv_property_cache;
757 struct si2165_state *state = fe->demodulator_priv;
763 dprintk("%s: called\n", __func__);
765 if (!fe->ops.tuner_ops.get_if_frequency) {
766 dev_err(&state->i2c->dev,
767 "%s: Error: get_if_frequency() not defined at tuner. Can't work without it!\n",
772 if (!state->has_dvbt)
775 if (p->bandwidth_hz > 0) {
776 dvb_rate = p->bandwidth_hz * 8 / 7;
777 bw10k = p->bandwidth_hz / 10000;
779 dvb_rate = 8 * 8 / 7;
783 /* standard = DVB-T */
784 ret = si2165_writereg8(state, 0x00ec, 0x01);
787 ret = si2165_adjust_pll_divl(state, 12);
791 fe->ops.tuner_ops.get_if_frequency(fe, &IF);
792 ret = si2165_set_if_freq_shift(state, IF);
795 ret = si2165_writereg8(state, 0x08f8, 0x00);
798 /* ts output config */
799 ret = si2165_writereg8(state, 0x04e4, 0x20);
802 ret = si2165_writereg16(state, 0x04ef, 0x00fe);
805 ret = si2165_writereg24(state, 0x04f4, 0x555555);
808 ret = si2165_writereg8(state, 0x04e5, 0x01);
811 /* bandwidth in 10KHz steps */
812 ret = si2165_writereg16(state, 0x0308, bw10k);
815 ret = si2165_set_oversamp(state, dvb_rate);
818 /* impulsive_noise_remover */
819 ret = si2165_writereg8(state, 0x031c, 0x01);
822 ret = si2165_writereg8(state, 0x00cb, 0x00);
826 ret = si2165_writereg8(state, 0x016e, 0x41);
829 ret = si2165_writereg8(state, 0x016c, 0x0e);
832 ret = si2165_writereg8(state, 0x016d, 0x10);
836 ret = si2165_writereg8(state, 0x015b, 0x03);
839 ret = si2165_writereg8(state, 0x0150, 0x78);
843 ret = si2165_writereg8(state, 0x01a0, 0x78);
846 ret = si2165_writereg8(state, 0x01c8, 0x68);
849 /* freq_sync_range */
850 ret = si2165_writereg16(state, 0x030c, 0x0064);
854 ret = si2165_readreg8(state, 0x0387, val);
857 ret = si2165_writereg8(state, 0x0387, 0x00);
861 ret = si2165_writereg32(state, 0x0348, 0xf4000000);
865 if (fe->ops.tuner_ops.set_params)
866 fe->ops.tuner_ops.set_params(fe);
868 /* recalc if_freq_shift if IF might has changed */
869 fe->ops.tuner_ops.get_if_frequency(fe, &IF);
870 ret = si2165_set_if_freq_shift(state, IF);
874 /* boot/wdog status */
875 ret = si2165_readreg8(state, 0x0341, val);
878 ret = si2165_writereg8(state, 0x0341, 0x00);
882 ret = si2165_writereg8(state, 0x00c0, 0x00);
886 ret = si2165_writereg32(state, 0x0384, 0x00000000);
890 ret = si2165_writereg8(state, 0x02e0, 0x01);
893 /* boot/wdog status */
894 ret = si2165_readreg8(state, 0x0341, val);
901 static void si2165_release(struct dvb_frontend *fe)
903 struct si2165_state *state = fe->demodulator_priv;
905 dprintk("%s: called\n", __func__);
909 static struct dvb_frontend_ops si2165_ops = {
911 .name = "Silicon Labs Si2165",
912 .caps = FE_CAN_FEC_1_2 |
925 FE_CAN_TRANSMISSION_MODE_AUTO |
926 FE_CAN_GUARD_INTERVAL_AUTO |
927 FE_CAN_HIERARCHY_AUTO |
929 FE_CAN_TRANSMISSION_MODE_AUTO |
933 .get_tune_settings = si2165_get_tune_settings,
936 .sleep = si2165_sleep,
938 .set_frontend = si2165_set_parameters,
939 .read_status = si2165_read_status,
941 .release = si2165_release,
944 struct dvb_frontend *si2165_attach(const struct si2165_config *config,
945 struct i2c_adapter *i2c)
947 struct si2165_state *state = NULL;
952 if (config == NULL || i2c == NULL)
955 /* allocate memory for the internal state */
956 state = kzalloc(sizeof(struct si2165_state), GFP_KERNEL);
960 /* setup the state */
962 state->config = *config;
964 if (state->config.ref_freq_Hz < 4000000
965 || state->config.ref_freq_Hz > 27000000) {
966 dev_err(&state->i2c->dev, "%s: ref_freq of %d Hz not supported by this driver\n",
967 KBUILD_MODNAME, state->config.ref_freq_Hz);
971 /* create dvb_frontend */
972 memcpy(&state->frontend.ops, &si2165_ops,
973 sizeof(struct dvb_frontend_ops));
974 state->frontend.demodulator_priv = state;
977 io_ret = si2165_writereg8(state, 0x0000, state->config.chip_mode);
981 io_ret = si2165_readreg8(state, 0x0000, &val);
984 if (val != state->config.chip_mode)
987 io_ret = si2165_readreg8(state, 0x0023 , &state->revcode);
991 io_ret = si2165_readreg8(state, 0x0118, &state->chip_type);
996 io_ret = si2165_writereg8(state, 0x0000, SI2165_MODE_OFF);
1000 dev_info(&state->i2c->dev, "%s: hardware revision 0x%02x, chip type 0x%02x\n",
1001 KBUILD_MODNAME, state->revcode, state->chip_type);
1003 /* It is a guess that register 0x0118 (chip type?) can be used to
1004 * differ between si2161, si2163 and si2165
1005 * Only si2165 has been tested.
1007 if (state->revcode == 0x03 && state->chip_type == 0x07) {
1008 state->has_dvbt = true;
1009 state->has_dvbc = true;
1011 dev_err(&state->i2c->dev, "%s: Unsupported chip.\n",
1017 if (state->has_dvbt) {
1018 state->frontend.ops.delsys[n++] = SYS_DVBT;
1019 strlcat(state->frontend.ops.info.name, " DVB-T",
1020 sizeof(state->frontend.ops.info.name));
1022 if (state->has_dvbc)
1023 dev_warn(&state->i2c->dev, "%s: DVB-C is not yet supported.\n",
1026 return &state->frontend;
1032 EXPORT_SYMBOL(si2165_attach);
1034 module_param(debug, int, 0644);
1035 MODULE_PARM_DESC(debug, "Turn on/off frontend debugging (default:off).");
1037 MODULE_DESCRIPTION("Silicon Labs Si2165 DVB-C/-T Demodulator driver");
1038 MODULE_AUTHOR("Matthias Schwarzott <zzam@gentoo.org>");
1039 MODULE_LICENSE("GPL");
1040 MODULE_FIRMWARE(SI2165_FIRMWARE);