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 "si2168_priv.h"
19 static const struct dvb_frontend_ops si2168_ops;
21 /* execute firmware command */
22 static int si2168_cmd_execute(struct i2c_client *client, struct si2168_cmd *cmd)
24 struct si2168_dev *dev = i2c_get_clientdata(client);
26 unsigned long timeout;
28 mutex_lock(&dev->i2c_mutex);
31 /* write cmd and args for firmware */
32 ret = i2c_master_send(client, cmd->args, cmd->wlen);
34 goto err_mutex_unlock;
35 } else if (ret != cmd->wlen) {
37 goto err_mutex_unlock;
42 /* wait cmd execution terminate */
44 timeout = jiffies + msecs_to_jiffies(TIMEOUT);
45 while (!time_after(jiffies, timeout)) {
46 ret = i2c_master_recv(client, cmd->args, cmd->rlen);
48 goto err_mutex_unlock;
49 } else if (ret != cmd->rlen) {
51 goto err_mutex_unlock;
55 if ((cmd->args[0] >> 7) & 0x01)
59 dev_dbg(&client->dev, "cmd execution took %d ms\n",
60 jiffies_to_msecs(jiffies) -
61 (jiffies_to_msecs(timeout) - TIMEOUT));
64 if ((cmd->args[0] >> 6) & 0x01) {
66 goto err_mutex_unlock;
69 if (!((cmd->args[0] >> 7) & 0x01)) {
71 goto err_mutex_unlock;
75 mutex_unlock(&dev->i2c_mutex);
78 mutex_unlock(&dev->i2c_mutex);
79 dev_dbg(&client->dev, "failed=%d\n", ret);
83 static int si2168_read_status(struct dvb_frontend *fe, enum fe_status *status)
85 struct i2c_client *client = fe->demodulator_priv;
86 struct si2168_dev *dev = i2c_get_clientdata(client);
87 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
89 unsigned int utmp, utmp1, utmp2;
90 struct si2168_cmd cmd;
99 switch (c->delivery_system) {
101 memcpy(cmd.args, "\xa0\x01", 2);
105 case SYS_DVBC_ANNEX_A:
106 memcpy(cmd.args, "\x90\x01", 2);
111 memcpy(cmd.args, "\x50\x01", 2);
120 ret = si2168_cmd_execute(client, &cmd);
124 switch ((cmd.args[2] >> 1) & 0x03) {
126 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER;
129 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI |
130 FE_HAS_SYNC | FE_HAS_LOCK;
134 dev->fe_status = *status;
136 if (*status & FE_HAS_LOCK) {
138 c->cnr.stat[0].scale = FE_SCALE_DECIBEL;
139 c->cnr.stat[0].svalue = cmd.args[3] * 1000 / 4;
142 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
145 dev_dbg(&client->dev, "status=%02x args=%*ph\n",
146 *status, cmd.rlen, cmd.args);
149 if (*status & FE_HAS_VITERBI) {
150 memcpy(cmd.args, "\x82\x00", 2);
153 ret = si2168_cmd_execute(client, &cmd);
158 * Firmware returns [0, 255] mantissa and [0, 8] exponent.
159 * Convert to DVB API: mantissa * 10^(8 - exponent) / 10^8
161 utmp = clamp(8 - cmd.args[1], 0, 8);
162 for (i = 0, utmp1 = 1; i < utmp; i++)
165 utmp1 = cmd.args[2] * utmp1;
166 utmp2 = 100000000; /* 10^8 */
168 dev_dbg(&client->dev,
169 "post_bit_error=%u post_bit_count=%u ber=%u*10^-%u\n",
170 utmp1, utmp2, cmd.args[2], cmd.args[1]);
172 c->post_bit_error.stat[0].scale = FE_SCALE_COUNTER;
173 c->post_bit_error.stat[0].uvalue += utmp1;
174 c->post_bit_count.stat[0].scale = FE_SCALE_COUNTER;
175 c->post_bit_count.stat[0].uvalue += utmp2;
177 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
178 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
182 if (*status & FE_HAS_SYNC) {
183 memcpy(cmd.args, "\x84\x01", 2);
186 ret = si2168_cmd_execute(client, &cmd);
190 utmp1 = cmd.args[2] << 8 | cmd.args[1] << 0;
191 dev_dbg(&client->dev, "block_error=%u\n", utmp1);
193 /* Sometimes firmware returns bogus value */
197 c->block_error.stat[0].scale = FE_SCALE_COUNTER;
198 c->block_error.stat[0].uvalue += utmp1;
200 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
205 dev_dbg(&client->dev, "failed=%d\n", ret);
209 static int si2168_set_frontend(struct dvb_frontend *fe)
211 struct i2c_client *client = fe->demodulator_priv;
212 struct si2168_dev *dev = i2c_get_clientdata(client);
213 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
215 struct si2168_cmd cmd;
216 u8 bandwidth, delivery_system;
218 dev_dbg(&client->dev,
219 "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%u stream_id=%u\n",
220 c->delivery_system, c->modulation, c->frequency,
221 c->bandwidth_hz, c->symbol_rate, c->inversion,
229 switch (c->delivery_system) {
231 delivery_system = 0x20;
233 case SYS_DVBC_ANNEX_A:
234 delivery_system = 0x30;
237 delivery_system = 0x70;
244 if (c->bandwidth_hz == 0) {
247 } else if (c->bandwidth_hz <= 2000000)
249 else if (c->bandwidth_hz <= 5000000)
251 else if (c->bandwidth_hz <= 6000000)
253 else if (c->bandwidth_hz <= 7000000)
255 else if (c->bandwidth_hz <= 8000000)
257 else if (c->bandwidth_hz <= 9000000)
259 else if (c->bandwidth_hz <= 10000000)
265 if (fe->ops.tuner_ops.set_params) {
266 ret = fe->ops.tuner_ops.set_params(fe);
271 memcpy(cmd.args, "\x88\x02\x02\x02\x02", 5);
274 ret = si2168_cmd_execute(client, &cmd);
278 /* that has no big effect */
279 if (c->delivery_system == SYS_DVBT)
280 memcpy(cmd.args, "\x89\x21\x06\x11\xff\x98", 6);
281 else if (c->delivery_system == SYS_DVBC_ANNEX_A)
282 memcpy(cmd.args, "\x89\x21\x06\x11\x89\xf0", 6);
283 else if (c->delivery_system == SYS_DVBT2)
284 memcpy(cmd.args, "\x89\x21\x06\x11\x89\x20", 6);
287 ret = si2168_cmd_execute(client, &cmd);
291 if (c->delivery_system == SYS_DVBT2) {
294 cmd.args[1] = c->stream_id & 0xff;
295 cmd.args[2] = c->stream_id == NO_STREAM_ID_FILTER ? 0 : 1;
298 ret = si2168_cmd_execute(client, &cmd);
303 memcpy(cmd.args, "\x51\x03", 2);
306 ret = si2168_cmd_execute(client, &cmd);
310 memcpy(cmd.args, "\x12\x08\x04", 3);
313 ret = si2168_cmd_execute(client, &cmd);
317 memcpy(cmd.args, "\x14\x00\x0c\x10\x12\x00", 6);
320 ret = si2168_cmd_execute(client, &cmd);
324 memcpy(cmd.args, "\x14\x00\x06\x10\x24\x00", 6);
327 ret = si2168_cmd_execute(client, &cmd);
331 memcpy(cmd.args, "\x14\x00\x07\x10\x00\x24", 6);
334 ret = si2168_cmd_execute(client, &cmd);
338 memcpy(cmd.args, "\x14\x00\x0a\x10\x00\x00", 6);
339 cmd.args[4] = delivery_system | bandwidth;
342 ret = si2168_cmd_execute(client, &cmd);
346 /* set DVB-C symbol rate */
347 if (c->delivery_system == SYS_DVBC_ANNEX_A) {
348 memcpy(cmd.args, "\x14\x00\x02\x11", 4);
349 cmd.args[4] = ((c->symbol_rate / 1000) >> 0) & 0xff;
350 cmd.args[5] = ((c->symbol_rate / 1000) >> 8) & 0xff;
353 ret = si2168_cmd_execute(client, &cmd);
358 memcpy(cmd.args, "\x14\x00\x0f\x10\x10\x00", 6);
361 ret = si2168_cmd_execute(client, &cmd);
365 memcpy(cmd.args, "\x14\x00\x09\x10\xe3\x08", 6);
366 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
369 ret = si2168_cmd_execute(client, &cmd);
373 memcpy(cmd.args, "\x14\x00\x08\x10\xd7\x05", 6);
374 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
377 ret = si2168_cmd_execute(client, &cmd);
381 memcpy(cmd.args, "\x14\x00\x01\x12\x00\x00", 6);
384 ret = si2168_cmd_execute(client, &cmd);
388 memcpy(cmd.args, "\x14\x00\x01\x03\x0c\x00", 6);
391 ret = si2168_cmd_execute(client, &cmd);
395 memcpy(cmd.args, "\x85", 1);
398 ret = si2168_cmd_execute(client, &cmd);
402 dev->delivery_system = c->delivery_system;
406 dev_dbg(&client->dev, "failed=%d\n", ret);
410 static int si2168_init(struct dvb_frontend *fe)
412 struct i2c_client *client = fe->demodulator_priv;
413 struct si2168_dev *dev = i2c_get_clientdata(client);
414 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
415 int ret, len, remaining;
416 const struct firmware *fw;
417 struct si2168_cmd cmd;
419 dev_dbg(&client->dev, "\n");
422 memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
425 ret = si2168_cmd_execute(client, &cmd);
431 memcpy(cmd.args, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8);
434 ret = si2168_cmd_execute(client, &cmd);
438 memcpy(cmd.args, "\x85", 1);
441 ret = si2168_cmd_execute(client, &cmd);
449 memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
452 ret = si2168_cmd_execute(client, &cmd);
456 /* request the firmware, this will block and timeout */
457 ret = request_firmware(&fw, dev->firmware_name, &client->dev);
459 /* fallback mechanism to handle old name for Si2168 B40 fw */
460 if (dev->chip_id == SI2168_CHIP_ID_B40) {
461 dev->firmware_name = SI2168_B40_FIRMWARE_FALLBACK;
462 ret = request_firmware(&fw, dev->firmware_name,
467 dev_notice(&client->dev,
468 "please install firmware file '%s'\n",
469 SI2168_B40_FIRMWARE);
471 dev_err(&client->dev,
472 "firmware file '%s' not found\n",
474 goto err_release_firmware;
478 dev_info(&client->dev, "downloading firmware from file '%s'\n",
481 if ((fw->size % 17 == 0) && (fw->data[0] > 5)) {
482 /* firmware is in the new format */
483 for (remaining = fw->size; remaining > 0; remaining -= 17) {
484 len = fw->data[fw->size - remaining];
485 if (len > SI2168_ARGLEN) {
489 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
492 ret = si2168_cmd_execute(client, &cmd);
496 } else if (fw->size % 8 == 0) {
497 /* firmware is in the old format */
498 for (remaining = fw->size; remaining > 0; remaining -= 8) {
500 memcpy(cmd.args, &fw->data[fw->size - remaining], len);
503 ret = si2168_cmd_execute(client, &cmd);
508 /* bad or unknown firmware format */
513 dev_err(&client->dev, "firmware download failed %d\n", ret);
514 goto err_release_firmware;
517 release_firmware(fw);
519 memcpy(cmd.args, "\x01\x01", 2);
522 ret = si2168_cmd_execute(client, &cmd);
526 /* query firmware version */
527 memcpy(cmd.args, "\x11", 1);
530 ret = si2168_cmd_execute(client, &cmd);
534 dev->version = (cmd.args[9] + '@') << 24 | (cmd.args[6] - '0') << 16 |
535 (cmd.args[7] - '0') << 8 | (cmd.args[8]) << 0;
536 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
537 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
538 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
541 memcpy(cmd.args, "\x14\x00\x01\x10\x10\x00", 6);
542 cmd.args[4] |= dev->ts_mode;
543 if (dev->ts_clock_gapped)
547 ret = si2168_cmd_execute(client, &cmd);
553 /* Init stats here to indicate which stats are supported */
555 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
556 c->post_bit_error.len = 1;
557 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
558 c->post_bit_count.len = 1;
559 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
560 c->block_error.len = 1;
561 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
566 err_release_firmware:
567 release_firmware(fw);
569 dev_dbg(&client->dev, "failed=%d\n", ret);
573 static int si2168_sleep(struct dvb_frontend *fe)
575 struct i2c_client *client = fe->demodulator_priv;
576 struct si2168_dev *dev = i2c_get_clientdata(client);
578 struct si2168_cmd cmd;
580 dev_dbg(&client->dev, "\n");
584 /* Firmware B 4.0-11 or later loses warm state during sleep */
585 if (dev->version > ('B' << 24 | 4 << 16 | 0 << 8 | 11 << 0))
588 memcpy(cmd.args, "\x13", 1);
591 ret = si2168_cmd_execute(client, &cmd);
597 dev_dbg(&client->dev, "failed=%d\n", ret);
601 static int si2168_get_tune_settings(struct dvb_frontend *fe,
602 struct dvb_frontend_tune_settings *s)
604 s->min_delay_ms = 900;
609 static int si2168_select(struct i2c_mux_core *muxc, u32 chan)
611 struct i2c_client *client = i2c_mux_priv(muxc);
613 struct si2168_cmd cmd;
616 memcpy(cmd.args, "\xc0\x0d\x01", 3);
619 ret = si2168_cmd_execute(client, &cmd);
625 dev_dbg(&client->dev, "failed=%d\n", ret);
629 static int si2168_deselect(struct i2c_mux_core *muxc, u32 chan)
631 struct i2c_client *client = i2c_mux_priv(muxc);
633 struct si2168_cmd cmd;
636 memcpy(cmd.args, "\xc0\x0d\x00", 3);
639 ret = si2168_cmd_execute(client, &cmd);
645 dev_dbg(&client->dev, "failed=%d\n", ret);
649 static const struct dvb_frontend_ops si2168_ops = {
650 .delsys = {SYS_DVBT, SYS_DVBT2, SYS_DVBC_ANNEX_A},
652 .name = "Silicon Labs Si2168",
653 .symbol_rate_min = 1000000,
654 .symbol_rate_max = 7200000,
655 .caps = FE_CAN_FEC_1_2 |
668 FE_CAN_TRANSMISSION_MODE_AUTO |
669 FE_CAN_GUARD_INTERVAL_AUTO |
670 FE_CAN_HIERARCHY_AUTO |
672 FE_CAN_2G_MODULATION |
676 .get_tune_settings = si2168_get_tune_settings,
679 .sleep = si2168_sleep,
681 .set_frontend = si2168_set_frontend,
683 .read_status = si2168_read_status,
686 static int si2168_probe(struct i2c_client *client,
687 const struct i2c_device_id *id)
689 struct si2168_config *config = client->dev.platform_data;
690 struct si2168_dev *dev;
692 struct si2168_cmd cmd;
694 dev_dbg(&client->dev, "\n");
696 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
699 dev_err(&client->dev, "kzalloc() failed\n");
703 i2c_set_clientdata(client, dev);
704 mutex_init(&dev->i2c_mutex);
707 memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
710 ret = si2168_cmd_execute(client, &cmd);
715 memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
718 ret = si2168_cmd_execute(client, &cmd);
722 /* Query chip revision */
723 memcpy(cmd.args, "\x02", 1);
726 ret = si2168_cmd_execute(client, &cmd);
730 dev->chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 |
731 cmd.args[3] << 8 | cmd.args[4] << 0;
733 switch (dev->chip_id) {
734 case SI2168_CHIP_ID_A20:
735 dev->firmware_name = SI2168_A20_FIRMWARE;
737 case SI2168_CHIP_ID_A30:
738 dev->firmware_name = SI2168_A30_FIRMWARE;
740 case SI2168_CHIP_ID_B40:
741 dev->firmware_name = SI2168_B40_FIRMWARE;
744 dev_dbg(&client->dev, "unknown chip version Si21%d-%c%c%c\n",
745 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]);
750 dev->version = (cmd.args[1]) << 24 | (cmd.args[3] - '0') << 16 |
751 (cmd.args[4] - '0') << 8 | (cmd.args[5]) << 0;
753 /* create mux i2c adapter for tuner */
754 dev->muxc = i2c_mux_alloc(client->adapter, &client->dev,
755 1, 0, I2C_MUX_LOCKED,
756 si2168_select, si2168_deselect);
761 dev->muxc->priv = client;
762 ret = i2c_mux_add_adapter(dev->muxc, 0, 0, 0);
766 /* create dvb_frontend */
767 memcpy(&dev->fe.ops, &si2168_ops, sizeof(struct dvb_frontend_ops));
768 dev->fe.demodulator_priv = client;
769 *config->i2c_adapter = dev->muxc->adapter[0];
770 *config->fe = &dev->fe;
771 dev->ts_mode = config->ts_mode;
772 dev->ts_clock_inv = config->ts_clock_inv;
773 dev->ts_clock_gapped = config->ts_clock_gapped;
775 dev_info(&client->dev, "Silicon Labs Si2168-%c%d%d successfully identified\n",
776 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
777 dev->version >> 8 & 0xff);
778 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
779 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
780 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
786 dev_dbg(&client->dev, "failed=%d\n", ret);
790 static int si2168_remove(struct i2c_client *client)
792 struct si2168_dev *dev = i2c_get_clientdata(client);
794 dev_dbg(&client->dev, "\n");
796 i2c_mux_del_adapters(dev->muxc);
798 dev->fe.ops.release = NULL;
799 dev->fe.demodulator_priv = NULL;
806 static const struct i2c_device_id si2168_id_table[] = {
810 MODULE_DEVICE_TABLE(i2c, si2168_id_table);
812 static struct i2c_driver si2168_driver = {
815 .suppress_bind_attrs = true,
817 .probe = si2168_probe,
818 .remove = si2168_remove,
819 .id_table = si2168_id_table,
822 module_i2c_driver(si2168_driver);
824 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
825 MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver");
826 MODULE_LICENSE("GPL");
827 MODULE_FIRMWARE(SI2168_A20_FIRMWARE);
828 MODULE_FIRMWARE(SI2168_A30_FIRMWARE);
829 MODULE_FIRMWARE(SI2168_B40_FIRMWARE);