2 * Silicon Labs Si2168 DVB-T/T2/C demodulator driver
4 * Copyright (C) 2014 Antti Palosaari <crope@iki.fi>
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 #include <linux/delay.h>
19 #include "si2168_priv.h"
21 static const struct dvb_frontend_ops si2168_ops;
23 /* execute firmware command */
24 static int si2168_cmd_execute(struct i2c_client *client, struct si2168_cmd *cmd)
26 struct si2168_dev *dev = i2c_get_clientdata(client);
28 unsigned long timeout;
30 mutex_lock(&dev->i2c_mutex);
33 /* write cmd and args for firmware */
34 ret = i2c_master_send(client, cmd->args, cmd->wlen);
36 goto err_mutex_unlock;
37 } else if (ret != cmd->wlen) {
39 goto err_mutex_unlock;
44 /* wait cmd execution terminate */
46 timeout = jiffies + msecs_to_jiffies(TIMEOUT);
47 while (!time_after(jiffies, timeout)) {
48 ret = i2c_master_recv(client, cmd->args, cmd->rlen);
50 goto err_mutex_unlock;
51 } else if (ret != cmd->rlen) {
53 goto err_mutex_unlock;
57 if ((cmd->args[0] >> 7) & 0x01)
61 dev_dbg(&client->dev, "cmd execution took %d ms\n",
62 jiffies_to_msecs(jiffies) -
63 (jiffies_to_msecs(timeout) - TIMEOUT));
66 if ((cmd->args[0] >> 6) & 0x01) {
68 goto err_mutex_unlock;
71 if (!((cmd->args[0] >> 7) & 0x01)) {
73 goto err_mutex_unlock;
77 mutex_unlock(&dev->i2c_mutex);
80 mutex_unlock(&dev->i2c_mutex);
81 dev_dbg(&client->dev, "failed=%d\n", ret);
85 static int si2168_ts_bus_ctrl(struct dvb_frontend *fe, int acquire)
87 struct i2c_client *client = fe->demodulator_priv;
88 struct si2168_dev *dev = i2c_get_clientdata(client);
89 struct si2168_cmd cmd;
92 dev_dbg(&client->dev, "%s acquire: %d\n", __func__, acquire);
94 /* set TS_MODE property */
95 memcpy(cmd.args, "\x14\x00\x01\x10\x10\x00", 6);
97 cmd.args[4] |= dev->ts_mode;
99 cmd.args[4] |= SI2168_TS_TRISTATE;
100 if (dev->ts_clock_gapped)
104 ret = si2168_cmd_execute(client, &cmd);
109 static int si2168_read_status(struct dvb_frontend *fe, enum fe_status *status)
111 struct i2c_client *client = fe->demodulator_priv;
112 struct si2168_dev *dev = i2c_get_clientdata(client);
113 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
115 unsigned int utmp, utmp1, utmp2;
116 struct si2168_cmd cmd;
125 switch (c->delivery_system) {
127 memcpy(cmd.args, "\xa0\x01", 2);
131 case SYS_DVBC_ANNEX_A:
132 memcpy(cmd.args, "\x90\x01", 2);
137 memcpy(cmd.args, "\x50\x01", 2);
146 ret = si2168_cmd_execute(client, &cmd);
150 switch ((cmd.args[2] >> 1) & 0x03) {
152 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER;
155 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI |
156 FE_HAS_SYNC | FE_HAS_LOCK;
160 dev->fe_status = *status;
162 if (*status & FE_HAS_LOCK) {
164 c->cnr.stat[0].scale = FE_SCALE_DECIBEL;
165 c->cnr.stat[0].svalue = cmd.args[3] * 1000 / 4;
168 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
171 dev_dbg(&client->dev, "status=%02x args=%*ph\n",
172 *status, cmd.rlen, cmd.args);
175 if (*status & FE_HAS_VITERBI) {
176 memcpy(cmd.args, "\x82\x00", 2);
179 ret = si2168_cmd_execute(client, &cmd);
184 * Firmware returns [0, 255] mantissa and [0, 8] exponent.
185 * Convert to DVB API: mantissa * 10^(8 - exponent) / 10^8
187 utmp = clamp(8 - cmd.args[1], 0, 8);
188 for (i = 0, utmp1 = 1; i < utmp; i++)
191 utmp1 = cmd.args[2] * utmp1;
192 utmp2 = 100000000; /* 10^8 */
194 dev_dbg(&client->dev,
195 "post_bit_error=%u post_bit_count=%u ber=%u*10^-%u\n",
196 utmp1, utmp2, cmd.args[2], cmd.args[1]);
198 c->post_bit_error.stat[0].scale = FE_SCALE_COUNTER;
199 c->post_bit_error.stat[0].uvalue += utmp1;
200 c->post_bit_count.stat[0].scale = FE_SCALE_COUNTER;
201 c->post_bit_count.stat[0].uvalue += utmp2;
203 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
204 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
208 if (*status & FE_HAS_SYNC) {
209 memcpy(cmd.args, "\x84\x01", 2);
212 ret = si2168_cmd_execute(client, &cmd);
216 utmp1 = cmd.args[2] << 8 | cmd.args[1] << 0;
217 dev_dbg(&client->dev, "block_error=%u\n", utmp1);
219 /* Sometimes firmware returns bogus value */
223 c->block_error.stat[0].scale = FE_SCALE_COUNTER;
224 c->block_error.stat[0].uvalue += utmp1;
226 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
231 dev_dbg(&client->dev, "failed=%d\n", ret);
235 static int si2168_set_frontend(struct dvb_frontend *fe)
237 struct i2c_client *client = fe->demodulator_priv;
238 struct si2168_dev *dev = i2c_get_clientdata(client);
239 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
241 struct si2168_cmd cmd;
242 u8 bandwidth, delivery_system;
244 dev_dbg(&client->dev,
245 "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%u stream_id=%u\n",
246 c->delivery_system, c->modulation, c->frequency,
247 c->bandwidth_hz, c->symbol_rate, c->inversion,
255 switch (c->delivery_system) {
257 delivery_system = 0x20;
259 case SYS_DVBC_ANNEX_A:
260 delivery_system = 0x30;
263 delivery_system = 0x70;
270 if (c->bandwidth_hz == 0) {
273 } else if (c->bandwidth_hz <= 2000000)
275 else if (c->bandwidth_hz <= 5000000)
277 else if (c->bandwidth_hz <= 6000000)
279 else if (c->bandwidth_hz <= 7000000)
281 else if (c->bandwidth_hz <= 8000000)
283 else if (c->bandwidth_hz <= 9000000)
285 else if (c->bandwidth_hz <= 10000000)
291 if (fe->ops.tuner_ops.set_params) {
292 ret = fe->ops.tuner_ops.set_params(fe);
297 memcpy(cmd.args, "\x88\x02\x02\x02\x02", 5);
300 ret = si2168_cmd_execute(client, &cmd);
304 /* that has no big effect */
305 if (c->delivery_system == SYS_DVBT)
306 memcpy(cmd.args, "\x89\x21\x06\x11\xff\x98", 6);
307 else if (c->delivery_system == SYS_DVBC_ANNEX_A)
308 memcpy(cmd.args, "\x89\x21\x06\x11\x89\xf0", 6);
309 else if (c->delivery_system == SYS_DVBT2)
310 memcpy(cmd.args, "\x89\x21\x06\x11\x89\x20", 6);
313 ret = si2168_cmd_execute(client, &cmd);
317 if (c->delivery_system == SYS_DVBT2) {
320 cmd.args[1] = c->stream_id & 0xff;
321 cmd.args[2] = c->stream_id == NO_STREAM_ID_FILTER ? 0 : 1;
324 ret = si2168_cmd_execute(client, &cmd);
329 memcpy(cmd.args, "\x51\x03", 2);
332 ret = si2168_cmd_execute(client, &cmd);
336 memcpy(cmd.args, "\x12\x08\x04", 3);
339 ret = si2168_cmd_execute(client, &cmd);
343 memcpy(cmd.args, "\x14\x00\x0c\x10\x12\x00", 6);
346 ret = si2168_cmd_execute(client, &cmd);
350 memcpy(cmd.args, "\x14\x00\x06\x10\x24\x00", 6);
353 ret = si2168_cmd_execute(client, &cmd);
357 memcpy(cmd.args, "\x14\x00\x07\x10\x00\x24", 6);
360 ret = si2168_cmd_execute(client, &cmd);
364 memcpy(cmd.args, "\x14\x00\x0a\x10\x00\x00", 6);
365 cmd.args[4] = delivery_system | bandwidth;
366 if (dev->spectral_inversion)
370 ret = si2168_cmd_execute(client, &cmd);
374 /* set DVB-C symbol rate */
375 if (c->delivery_system == SYS_DVBC_ANNEX_A) {
376 memcpy(cmd.args, "\x14\x00\x02\x11", 4);
377 cmd.args[4] = ((c->symbol_rate / 1000) >> 0) & 0xff;
378 cmd.args[5] = ((c->symbol_rate / 1000) >> 8) & 0xff;
381 ret = si2168_cmd_execute(client, &cmd);
386 memcpy(cmd.args, "\x14\x00\x0f\x10\x10\x00", 6);
389 ret = si2168_cmd_execute(client, &cmd);
393 memcpy(cmd.args, "\x14\x00\x09\x10\xe3\x08", 6);
394 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
397 ret = si2168_cmd_execute(client, &cmd);
401 memcpy(cmd.args, "\x14\x00\x08\x10\xd7\x05", 6);
402 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
405 ret = si2168_cmd_execute(client, &cmd);
409 memcpy(cmd.args, "\x14\x00\x01\x12\x00\x00", 6);
412 ret = si2168_cmd_execute(client, &cmd);
416 memcpy(cmd.args, "\x14\x00\x01\x03\x0c\x00", 6);
419 ret = si2168_cmd_execute(client, &cmd);
423 memcpy(cmd.args, "\x85", 1);
426 ret = si2168_cmd_execute(client, &cmd);
430 dev->delivery_system = c->delivery_system;
433 ret = si2168_ts_bus_ctrl(fe, 1);
439 dev_dbg(&client->dev, "failed=%d\n", ret);
443 static int si2168_init(struct dvb_frontend *fe)
445 struct i2c_client *client = fe->demodulator_priv;
446 struct si2168_dev *dev = i2c_get_clientdata(client);
447 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
448 int ret, len, remaining;
449 const struct firmware *fw;
450 struct si2168_cmd cmd;
452 dev_dbg(&client->dev, "\n");
455 memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
458 ret = si2168_cmd_execute(client, &cmd);
464 memcpy(cmd.args, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8);
467 ret = si2168_cmd_execute(client, &cmd);
472 memcpy(cmd.args, "\x85", 1);
475 ret = si2168_cmd_execute(client, &cmd);
483 memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
486 ret = si2168_cmd_execute(client, &cmd);
490 /* request the firmware, this will block and timeout */
491 ret = request_firmware(&fw, dev->firmware_name, &client->dev);
493 /* fallback mechanism to handle old name for Si2168 B40 fw */
494 if (dev->chip_id == SI2168_CHIP_ID_B40) {
495 dev->firmware_name = SI2168_B40_FIRMWARE_FALLBACK;
496 ret = request_firmware(&fw, dev->firmware_name,
501 dev_notice(&client->dev,
502 "please install firmware file '%s'\n",
503 SI2168_B40_FIRMWARE);
505 dev_err(&client->dev,
506 "firmware file '%s' not found\n",
508 goto err_release_firmware;
512 dev_info(&client->dev, "downloading firmware from file '%s'\n",
515 if ((fw->size % 17 == 0) && (fw->data[0] > 5)) {
516 /* firmware is in the new format */
517 for (remaining = fw->size; remaining > 0; remaining -= 17) {
518 len = fw->data[fw->size - remaining];
519 if (len > SI2168_ARGLEN) {
523 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
526 ret = si2168_cmd_execute(client, &cmd);
530 } else if (fw->size % 8 == 0) {
531 /* firmware is in the old format */
532 for (remaining = fw->size; remaining > 0; remaining -= 8) {
534 memcpy(cmd.args, &fw->data[fw->size - remaining], len);
537 ret = si2168_cmd_execute(client, &cmd);
542 /* bad or unknown firmware format */
547 dev_err(&client->dev, "firmware download failed %d\n", ret);
548 goto err_release_firmware;
551 release_firmware(fw);
553 memcpy(cmd.args, "\x01\x01", 2);
556 ret = si2168_cmd_execute(client, &cmd);
560 /* query firmware version */
561 memcpy(cmd.args, "\x11", 1);
564 ret = si2168_cmd_execute(client, &cmd);
568 dev->version = (cmd.args[9] + '@') << 24 | (cmd.args[6] - '0') << 16 |
569 (cmd.args[7] - '0') << 8 | (cmd.args[8]) << 0;
570 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
571 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
572 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
575 ret = si2168_ts_bus_ctrl(fe, 1);
581 /* Init stats here to indicate which stats are supported */
583 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
584 c->post_bit_error.len = 1;
585 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
586 c->post_bit_count.len = 1;
587 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
588 c->block_error.len = 1;
589 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
594 err_release_firmware:
595 release_firmware(fw);
597 dev_dbg(&client->dev, "failed=%d\n", ret);
601 static int si2168_sleep(struct dvb_frontend *fe)
603 struct i2c_client *client = fe->demodulator_priv;
604 struct si2168_dev *dev = i2c_get_clientdata(client);
606 struct si2168_cmd cmd;
608 dev_dbg(&client->dev, "\n");
612 /* tri-state data bus */
613 ret = si2168_ts_bus_ctrl(fe, 0);
617 /* Firmware later than B 4.0-11 loses warm state during sleep */
618 if (dev->version > ('B' << 24 | 4 << 16 | 0 << 8 | 11 << 0))
621 memcpy(cmd.args, "\x13", 1);
624 ret = si2168_cmd_execute(client, &cmd);
630 dev_dbg(&client->dev, "failed=%d\n", ret);
634 static int si2168_get_tune_settings(struct dvb_frontend *fe,
635 struct dvb_frontend_tune_settings *s)
637 s->min_delay_ms = 900;
642 static int si2168_select(struct i2c_mux_core *muxc, u32 chan)
644 struct i2c_client *client = i2c_mux_priv(muxc);
646 struct si2168_cmd cmd;
649 memcpy(cmd.args, "\xc0\x0d\x01", 3);
652 ret = si2168_cmd_execute(client, &cmd);
658 dev_dbg(&client->dev, "failed=%d\n", ret);
662 static int si2168_deselect(struct i2c_mux_core *muxc, u32 chan)
664 struct i2c_client *client = i2c_mux_priv(muxc);
666 struct si2168_cmd cmd;
669 memcpy(cmd.args, "\xc0\x0d\x00", 3);
672 ret = si2168_cmd_execute(client, &cmd);
678 dev_dbg(&client->dev, "failed=%d\n", ret);
682 static const struct dvb_frontend_ops si2168_ops = {
683 .delsys = {SYS_DVBT, SYS_DVBT2, SYS_DVBC_ANNEX_A},
685 .name = "Silicon Labs Si2168",
686 .symbol_rate_min = 1000000,
687 .symbol_rate_max = 7200000,
688 .caps = FE_CAN_FEC_1_2 |
701 FE_CAN_TRANSMISSION_MODE_AUTO |
702 FE_CAN_GUARD_INTERVAL_AUTO |
703 FE_CAN_HIERARCHY_AUTO |
705 FE_CAN_2G_MODULATION |
709 .get_tune_settings = si2168_get_tune_settings,
712 .sleep = si2168_sleep,
714 .set_frontend = si2168_set_frontend,
716 .read_status = si2168_read_status,
719 static int si2168_probe(struct i2c_client *client,
720 const struct i2c_device_id *id)
722 struct si2168_config *config = client->dev.platform_data;
723 struct si2168_dev *dev;
725 struct si2168_cmd cmd;
727 dev_dbg(&client->dev, "\n");
729 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
735 i2c_set_clientdata(client, dev);
736 mutex_init(&dev->i2c_mutex);
739 memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
742 ret = si2168_cmd_execute(client, &cmd);
747 memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
750 ret = si2168_cmd_execute(client, &cmd);
754 /* Query chip revision */
755 memcpy(cmd.args, "\x02", 1);
758 ret = si2168_cmd_execute(client, &cmd);
762 dev->chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 |
763 cmd.args[3] << 8 | cmd.args[4] << 0;
765 switch (dev->chip_id) {
766 case SI2168_CHIP_ID_A20:
767 dev->firmware_name = SI2168_A20_FIRMWARE;
769 case SI2168_CHIP_ID_A30:
770 dev->firmware_name = SI2168_A30_FIRMWARE;
772 case SI2168_CHIP_ID_B40:
773 dev->firmware_name = SI2168_B40_FIRMWARE;
775 case SI2168_CHIP_ID_D60:
776 dev->firmware_name = SI2168_D60_FIRMWARE;
779 dev_dbg(&client->dev, "unknown chip version Si21%d-%c%c%c\n",
780 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]);
785 dev->version = (cmd.args[1]) << 24 | (cmd.args[3] - '0') << 16 |
786 (cmd.args[4] - '0') << 8 | (cmd.args[5]) << 0;
788 /* create mux i2c adapter for tuner */
789 dev->muxc = i2c_mux_alloc(client->adapter, &client->dev,
790 1, 0, I2C_MUX_LOCKED,
791 si2168_select, si2168_deselect);
796 dev->muxc->priv = client;
797 ret = i2c_mux_add_adapter(dev->muxc, 0, 0, 0);
801 /* create dvb_frontend */
802 memcpy(&dev->fe.ops, &si2168_ops, sizeof(struct dvb_frontend_ops));
803 dev->fe.demodulator_priv = client;
804 *config->i2c_adapter = dev->muxc->adapter[0];
805 *config->fe = &dev->fe;
806 dev->ts_mode = config->ts_mode;
807 dev->ts_clock_inv = config->ts_clock_inv;
808 dev->ts_clock_gapped = config->ts_clock_gapped;
809 dev->spectral_inversion = config->spectral_inversion;
811 dev_info(&client->dev, "Silicon Labs Si2168-%c%d%d successfully identified\n",
812 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
813 dev->version >> 8 & 0xff);
814 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
815 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
816 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
822 dev_warn(&client->dev, "probe failed = %d\n", ret);
826 static int si2168_remove(struct i2c_client *client)
828 struct si2168_dev *dev = i2c_get_clientdata(client);
830 dev_dbg(&client->dev, "\n");
832 i2c_mux_del_adapters(dev->muxc);
834 dev->fe.ops.release = NULL;
835 dev->fe.demodulator_priv = NULL;
842 static const struct i2c_device_id si2168_id_table[] = {
846 MODULE_DEVICE_TABLE(i2c, si2168_id_table);
848 static struct i2c_driver si2168_driver = {
851 .suppress_bind_attrs = true,
853 .probe = si2168_probe,
854 .remove = si2168_remove,
855 .id_table = si2168_id_table,
858 module_i2c_driver(si2168_driver);
860 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
861 MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver");
862 MODULE_LICENSE("GPL");
863 MODULE_FIRMWARE(SI2168_A20_FIRMWARE);
864 MODULE_FIRMWARE(SI2168_A30_FIRMWARE);
865 MODULE_FIRMWARE(SI2168_B40_FIRMWARE);
866 MODULE_FIRMWARE(SI2168_D60_FIRMWARE);