1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Silicon Labs Si2168 DVB-T/T2/C demodulator driver
5 * Copyright (C) 2014 Antti Palosaari <crope@iki.fi>
8 #include <linux/delay.h>
10 #include "si2168_priv.h"
12 static const struct dvb_frontend_ops si2168_ops;
14 /* execute firmware command */
15 static int si2168_cmd_execute(struct i2c_client *client, struct si2168_cmd *cmd)
17 struct si2168_dev *dev = i2c_get_clientdata(client);
19 unsigned long timeout;
21 mutex_lock(&dev->i2c_mutex);
24 /* write cmd and args for firmware */
25 ret = i2c_master_send(client, cmd->args, cmd->wlen);
27 goto err_mutex_unlock;
28 } else if (ret != cmd->wlen) {
30 goto err_mutex_unlock;
35 /* wait cmd execution terminate */
37 timeout = jiffies + msecs_to_jiffies(TIMEOUT);
38 while (!time_after(jiffies, timeout)) {
39 ret = i2c_master_recv(client, cmd->args, cmd->rlen);
41 goto err_mutex_unlock;
42 } else if (ret != cmd->rlen) {
44 goto err_mutex_unlock;
48 if ((cmd->args[0] >> 7) & 0x01)
52 dev_dbg(&client->dev, "cmd execution took %d ms\n",
53 jiffies_to_msecs(jiffies) -
54 (jiffies_to_msecs(timeout) - TIMEOUT));
57 if ((cmd->args[0] >> 6) & 0x01) {
59 goto err_mutex_unlock;
62 if (!((cmd->args[0] >> 7) & 0x01)) {
64 goto err_mutex_unlock;
68 mutex_unlock(&dev->i2c_mutex);
71 mutex_unlock(&dev->i2c_mutex);
72 dev_dbg(&client->dev, "failed=%d\n", ret);
76 static int si2168_ts_bus_ctrl(struct dvb_frontend *fe, int acquire)
78 struct i2c_client *client = fe->demodulator_priv;
79 struct si2168_dev *dev = i2c_get_clientdata(client);
80 struct si2168_cmd cmd;
83 dev_dbg(&client->dev, "%s acquire: %d\n", __func__, acquire);
85 /* set manual value */
86 if (dev->ts_mode & SI2168_TS_CLK_MANUAL) {
87 memcpy(cmd.args, "\x14\x00\x0d\x10\xe8\x03", 6);
90 ret = si2168_cmd_execute(client, &cmd);
94 /* set TS_MODE property */
95 memcpy(cmd.args, "\x14\x00\x01\x10\x10\x00", 6);
96 if (dev->ts_mode & SI2168_TS_CLK_MANUAL)
97 cmd.args[4] = SI2168_TS_CLK_MANUAL;
99 cmd.args[4] |= dev->ts_mode;
101 cmd.args[4] |= SI2168_TS_TRISTATE;
102 if (dev->ts_clock_gapped)
106 ret = si2168_cmd_execute(client, &cmd);
111 static int si2168_read_status(struct dvb_frontend *fe, enum fe_status *status)
113 struct i2c_client *client = fe->demodulator_priv;
114 struct si2168_dev *dev = i2c_get_clientdata(client);
115 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
117 unsigned int utmp, utmp1, utmp2;
118 struct si2168_cmd cmd;
127 switch (c->delivery_system) {
129 memcpy(cmd.args, "\xa0\x01", 2);
133 case SYS_DVBC_ANNEX_A:
134 memcpy(cmd.args, "\x90\x01", 2);
139 memcpy(cmd.args, "\x50\x01", 2);
148 ret = si2168_cmd_execute(client, &cmd);
152 switch ((cmd.args[2] >> 1) & 0x03) {
154 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER;
157 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI |
158 FE_HAS_SYNC | FE_HAS_LOCK;
162 dev->fe_status = *status;
164 if (*status & FE_HAS_LOCK) {
166 c->cnr.stat[0].scale = FE_SCALE_DECIBEL;
167 c->cnr.stat[0].svalue = cmd.args[3] * 1000 / 4;
170 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
173 dev_dbg(&client->dev, "status=%02x args=%*ph\n",
174 *status, cmd.rlen, cmd.args);
177 if (*status & FE_HAS_VITERBI) {
178 memcpy(cmd.args, "\x82\x00", 2);
181 ret = si2168_cmd_execute(client, &cmd);
186 * Firmware returns [0, 255] mantissa and [0, 8] exponent.
187 * Convert to DVB API: mantissa * 10^(8 - exponent) / 10^8
189 utmp = clamp(8 - cmd.args[1], 0, 8);
190 for (i = 0, utmp1 = 1; i < utmp; i++)
193 utmp1 = cmd.args[2] * utmp1;
194 utmp2 = 100000000; /* 10^8 */
196 dev_dbg(&client->dev,
197 "post_bit_error=%u post_bit_count=%u ber=%u*10^-%u\n",
198 utmp1, utmp2, cmd.args[2], cmd.args[1]);
200 c->post_bit_error.stat[0].scale = FE_SCALE_COUNTER;
201 c->post_bit_error.stat[0].uvalue += utmp1;
202 c->post_bit_count.stat[0].scale = FE_SCALE_COUNTER;
203 c->post_bit_count.stat[0].uvalue += utmp2;
205 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
206 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
210 if (*status & FE_HAS_SYNC) {
211 memcpy(cmd.args, "\x84\x01", 2);
214 ret = si2168_cmd_execute(client, &cmd);
218 utmp1 = cmd.args[2] << 8 | cmd.args[1] << 0;
219 dev_dbg(&client->dev, "block_error=%u\n", utmp1);
221 /* Sometimes firmware returns bogus value */
225 c->block_error.stat[0].scale = FE_SCALE_COUNTER;
226 c->block_error.stat[0].uvalue += utmp1;
228 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
233 dev_dbg(&client->dev, "failed=%d\n", ret);
237 static int si2168_set_frontend(struct dvb_frontend *fe)
239 struct i2c_client *client = fe->demodulator_priv;
240 struct si2168_dev *dev = i2c_get_clientdata(client);
241 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
243 struct si2168_cmd cmd;
244 u8 bandwidth, delivery_system;
246 dev_dbg(&client->dev,
247 "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%u stream_id=%u\n",
248 c->delivery_system, c->modulation, c->frequency,
249 c->bandwidth_hz, c->symbol_rate, c->inversion,
257 switch (c->delivery_system) {
259 delivery_system = 0x20;
261 case SYS_DVBC_ANNEX_A:
262 delivery_system = 0x30;
265 delivery_system = 0x70;
272 if (c->bandwidth_hz == 0) {
275 } else if (c->bandwidth_hz <= 2000000)
277 else if (c->bandwidth_hz <= 5000000)
279 else if (c->bandwidth_hz <= 6000000)
281 else if (c->bandwidth_hz <= 7000000)
283 else if (c->bandwidth_hz <= 8000000)
285 else if (c->bandwidth_hz <= 9000000)
287 else if (c->bandwidth_hz <= 10000000)
293 if (fe->ops.tuner_ops.set_params) {
294 ret = fe->ops.tuner_ops.set_params(fe);
299 memcpy(cmd.args, "\x88\x02\x02\x02\x02", 5);
302 ret = si2168_cmd_execute(client, &cmd);
306 /* that has no big effect */
307 if (c->delivery_system == SYS_DVBT)
308 memcpy(cmd.args, "\x89\x21\x06\x11\xff\x98", 6);
309 else if (c->delivery_system == SYS_DVBC_ANNEX_A)
310 memcpy(cmd.args, "\x89\x21\x06\x11\x89\xf0", 6);
311 else if (c->delivery_system == SYS_DVBT2)
312 memcpy(cmd.args, "\x89\x21\x06\x11\x89\x20", 6);
315 ret = si2168_cmd_execute(client, &cmd);
319 if (c->delivery_system == SYS_DVBT2) {
322 cmd.args[1] = c->stream_id & 0xff;
323 cmd.args[2] = c->stream_id == NO_STREAM_ID_FILTER ? 0 : 1;
326 ret = si2168_cmd_execute(client, &cmd);
331 memcpy(cmd.args, "\x51\x03", 2);
334 ret = si2168_cmd_execute(client, &cmd);
338 memcpy(cmd.args, "\x12\x08\x04", 3);
341 ret = si2168_cmd_execute(client, &cmd);
345 memcpy(cmd.args, "\x14\x00\x0c\x10\x12\x00", 6);
348 ret = si2168_cmd_execute(client, &cmd);
352 memcpy(cmd.args, "\x14\x00\x06\x10\x24\x00", 6);
355 ret = si2168_cmd_execute(client, &cmd);
359 memcpy(cmd.args, "\x14\x00\x07\x10\x00\x24", 6);
362 ret = si2168_cmd_execute(client, &cmd);
366 memcpy(cmd.args, "\x14\x00\x0a\x10\x00\x00", 6);
367 cmd.args[4] = delivery_system | bandwidth;
368 if (dev->spectral_inversion)
372 ret = si2168_cmd_execute(client, &cmd);
376 /* set DVB-C symbol rate */
377 if (c->delivery_system == SYS_DVBC_ANNEX_A) {
378 memcpy(cmd.args, "\x14\x00\x02\x11", 4);
379 cmd.args[4] = ((c->symbol_rate / 1000) >> 0) & 0xff;
380 cmd.args[5] = ((c->symbol_rate / 1000) >> 8) & 0xff;
383 ret = si2168_cmd_execute(client, &cmd);
388 memcpy(cmd.args, "\x14\x00\x0f\x10\x10\x00", 6);
391 ret = si2168_cmd_execute(client, &cmd);
395 memcpy(cmd.args, "\x14\x00\x09\x10\xe3\x08", 6);
396 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
399 ret = si2168_cmd_execute(client, &cmd);
403 memcpy(cmd.args, "\x14\x00\x08\x10\xd7\x05", 6);
404 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
407 ret = si2168_cmd_execute(client, &cmd);
411 memcpy(cmd.args, "\x14\x00\x01\x12\x00\x00", 6);
414 ret = si2168_cmd_execute(client, &cmd);
418 memcpy(cmd.args, "\x14\x00\x01\x03\x0c\x00", 6);
421 ret = si2168_cmd_execute(client, &cmd);
425 memcpy(cmd.args, "\x85", 1);
428 ret = si2168_cmd_execute(client, &cmd);
432 dev->delivery_system = c->delivery_system;
435 ret = si2168_ts_bus_ctrl(fe, 1);
441 dev_dbg(&client->dev, "failed=%d\n", ret);
445 static int si2168_init(struct dvb_frontend *fe)
447 struct i2c_client *client = fe->demodulator_priv;
448 struct si2168_dev *dev = i2c_get_clientdata(client);
449 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
450 int ret, len, remaining;
451 const struct firmware *fw;
452 struct si2168_cmd cmd;
454 dev_dbg(&client->dev, "\n");
457 memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
460 ret = si2168_cmd_execute(client, &cmd);
466 memcpy(cmd.args, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8);
469 ret = si2168_cmd_execute(client, &cmd);
474 memcpy(cmd.args, "\x85", 1);
477 ret = si2168_cmd_execute(client, &cmd);
485 memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
488 ret = si2168_cmd_execute(client, &cmd);
492 /* request the firmware, this will block and timeout */
493 ret = request_firmware(&fw, dev->firmware_name, &client->dev);
495 /* fallback mechanism to handle old name for Si2168 B40 fw */
496 if (dev->chip_id == SI2168_CHIP_ID_B40) {
497 dev->firmware_name = SI2168_B40_FIRMWARE_FALLBACK;
498 ret = request_firmware(&fw, dev->firmware_name,
503 dev_notice(&client->dev,
504 "please install firmware file '%s'\n",
505 SI2168_B40_FIRMWARE);
507 dev_err(&client->dev,
508 "firmware file '%s' not found\n",
510 goto err_release_firmware;
514 dev_info(&client->dev, "downloading firmware from file '%s'\n",
517 if ((fw->size % 17 == 0) && (fw->data[0] > 5)) {
518 /* firmware is in the new format */
519 for (remaining = fw->size; remaining > 0; remaining -= 17) {
520 len = fw->data[fw->size - remaining];
521 if (len > SI2168_ARGLEN) {
525 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
528 ret = si2168_cmd_execute(client, &cmd);
532 } else if (fw->size % 8 == 0) {
533 /* firmware is in the old format */
534 for (remaining = fw->size; remaining > 0; remaining -= 8) {
536 memcpy(cmd.args, &fw->data[fw->size - remaining], len);
539 ret = si2168_cmd_execute(client, &cmd);
544 /* bad or unknown firmware format */
549 dev_err(&client->dev, "firmware download failed %d\n", ret);
550 goto err_release_firmware;
553 release_firmware(fw);
555 memcpy(cmd.args, "\x01\x01", 2);
558 ret = si2168_cmd_execute(client, &cmd);
562 /* query firmware version */
563 memcpy(cmd.args, "\x11", 1);
566 ret = si2168_cmd_execute(client, &cmd);
570 dev->version = (cmd.args[9] + '@') << 24 | (cmd.args[6] - '0') << 16 |
571 (cmd.args[7] - '0') << 8 | (cmd.args[8]) << 0;
572 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
573 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
574 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
577 ret = si2168_ts_bus_ctrl(fe, 1);
583 /* Init stats here to indicate which stats are supported */
585 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
586 c->post_bit_error.len = 1;
587 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
588 c->post_bit_count.len = 1;
589 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
590 c->block_error.len = 1;
591 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
596 err_release_firmware:
597 release_firmware(fw);
599 dev_dbg(&client->dev, "failed=%d\n", ret);
603 static int si2168_sleep(struct dvb_frontend *fe)
605 struct i2c_client *client = fe->demodulator_priv;
606 struct si2168_dev *dev = i2c_get_clientdata(client);
608 struct si2168_cmd cmd;
610 dev_dbg(&client->dev, "\n");
614 /* tri-state data bus */
615 ret = si2168_ts_bus_ctrl(fe, 0);
619 /* Firmware later than B 4.0-11 loses warm state during sleep */
620 if (dev->version > ('B' << 24 | 4 << 16 | 0 << 8 | 11 << 0))
623 memcpy(cmd.args, "\x13", 1);
626 ret = si2168_cmd_execute(client, &cmd);
632 dev_dbg(&client->dev, "failed=%d\n", ret);
636 static int si2168_get_tune_settings(struct dvb_frontend *fe,
637 struct dvb_frontend_tune_settings *s)
639 s->min_delay_ms = 900;
644 static int si2168_select(struct i2c_mux_core *muxc, u32 chan)
646 struct i2c_client *client = i2c_mux_priv(muxc);
648 struct si2168_cmd cmd;
651 memcpy(cmd.args, "\xc0\x0d\x01", 3);
654 ret = si2168_cmd_execute(client, &cmd);
660 dev_dbg(&client->dev, "failed=%d\n", ret);
664 static int si2168_deselect(struct i2c_mux_core *muxc, u32 chan)
666 struct i2c_client *client = i2c_mux_priv(muxc);
668 struct si2168_cmd cmd;
671 memcpy(cmd.args, "\xc0\x0d\x00", 3);
674 ret = si2168_cmd_execute(client, &cmd);
680 dev_dbg(&client->dev, "failed=%d\n", ret);
684 static const struct dvb_frontend_ops si2168_ops = {
685 .delsys = {SYS_DVBT, SYS_DVBT2, SYS_DVBC_ANNEX_A},
687 .name = "Silicon Labs Si2168",
688 .frequency_min_hz = 48 * MHz,
689 .frequency_max_hz = 870 * MHz,
690 .frequency_stepsize_hz = 62500,
691 .symbol_rate_min = 1000000,
692 .symbol_rate_max = 7200000,
693 .caps = FE_CAN_FEC_1_2 |
706 FE_CAN_TRANSMISSION_MODE_AUTO |
707 FE_CAN_GUARD_INTERVAL_AUTO |
708 FE_CAN_HIERARCHY_AUTO |
710 FE_CAN_2G_MODULATION |
714 .get_tune_settings = si2168_get_tune_settings,
717 .sleep = si2168_sleep,
719 .set_frontend = si2168_set_frontend,
721 .read_status = si2168_read_status,
724 static int si2168_probe(struct i2c_client *client,
725 const struct i2c_device_id *id)
727 struct si2168_config *config = client->dev.platform_data;
728 struct si2168_dev *dev;
730 struct si2168_cmd cmd;
732 dev_dbg(&client->dev, "\n");
734 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
740 i2c_set_clientdata(client, dev);
741 mutex_init(&dev->i2c_mutex);
744 memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
747 ret = si2168_cmd_execute(client, &cmd);
752 memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
755 ret = si2168_cmd_execute(client, &cmd);
759 /* Query chip revision */
760 memcpy(cmd.args, "\x02", 1);
763 ret = si2168_cmd_execute(client, &cmd);
767 dev->chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 |
768 cmd.args[3] << 8 | cmd.args[4] << 0;
770 switch (dev->chip_id) {
771 case SI2168_CHIP_ID_A20:
772 dev->firmware_name = SI2168_A20_FIRMWARE;
774 case SI2168_CHIP_ID_A30:
775 dev->firmware_name = SI2168_A30_FIRMWARE;
777 case SI2168_CHIP_ID_B40:
778 dev->firmware_name = SI2168_B40_FIRMWARE;
780 case SI2168_CHIP_ID_D60:
781 dev->firmware_name = SI2168_D60_FIRMWARE;
784 dev_dbg(&client->dev, "unknown chip version Si21%d-%c%c%c\n",
785 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]);
790 dev->version = (cmd.args[1]) << 24 | (cmd.args[3] - '0') << 16 |
791 (cmd.args[4] - '0') << 8 | (cmd.args[5]) << 0;
793 /* create mux i2c adapter for tuner */
794 dev->muxc = i2c_mux_alloc(client->adapter, &client->dev,
795 1, 0, I2C_MUX_LOCKED,
796 si2168_select, si2168_deselect);
801 dev->muxc->priv = client;
802 ret = i2c_mux_add_adapter(dev->muxc, 0, 0, 0);
806 /* create dvb_frontend */
807 memcpy(&dev->fe.ops, &si2168_ops, sizeof(struct dvb_frontend_ops));
808 dev->fe.demodulator_priv = client;
809 *config->i2c_adapter = dev->muxc->adapter[0];
810 *config->fe = &dev->fe;
811 dev->ts_mode = config->ts_mode;
812 dev->ts_clock_inv = config->ts_clock_inv;
813 dev->ts_clock_gapped = config->ts_clock_gapped;
814 dev->spectral_inversion = config->spectral_inversion;
816 dev_info(&client->dev, "Silicon Labs Si2168-%c%d%d successfully identified\n",
817 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
818 dev->version >> 8 & 0xff);
819 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
820 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
821 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
827 dev_warn(&client->dev, "probe failed = %d\n", ret);
831 static int si2168_remove(struct i2c_client *client)
833 struct si2168_dev *dev = i2c_get_clientdata(client);
835 dev_dbg(&client->dev, "\n");
837 i2c_mux_del_adapters(dev->muxc);
839 dev->fe.ops.release = NULL;
840 dev->fe.demodulator_priv = NULL;
847 static const struct i2c_device_id si2168_id_table[] = {
851 MODULE_DEVICE_TABLE(i2c, si2168_id_table);
853 static struct i2c_driver si2168_driver = {
856 .suppress_bind_attrs = true,
858 .probe = si2168_probe,
859 .remove = si2168_remove,
860 .id_table = si2168_id_table,
863 module_i2c_driver(si2168_driver);
865 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
866 MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver");
867 MODULE_LICENSE("GPL");
868 MODULE_FIRMWARE(SI2168_A20_FIRMWARE);
869 MODULE_FIRMWARE(SI2168_A30_FIRMWARE);
870 MODULE_FIRMWARE(SI2168_B40_FIRMWARE);
871 MODULE_FIRMWARE(SI2168_D60_FIRMWARE);