1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Silicon Labs Si2168 DVB-T/T2/C demodulator driver
8 #include <linux/delay.h>
10 #include "si2168_priv.h"
12 static const struct dvb_frontend_ops si2168_ops;
14 static void cmd_init(struct si2168_cmd *cmd, const u8 *buf, int wlen, int rlen)
16 memcpy(cmd->args, buf, wlen);
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_ts_bus_ctrl(struct dvb_frontend *fe, int acquire)
85 struct i2c_client *client = fe->demodulator_priv;
86 struct si2168_dev *dev = i2c_get_clientdata(client);
87 struct si2168_cmd cmd;
90 dev_dbg(&client->dev, "%s acquire: %d\n", __func__, acquire);
92 /* set manual value */
93 if (dev->ts_mode & SI2168_TS_CLK_MANUAL) {
94 cmd_init(&cmd, "\x14\x00\x0d\x10\xe8\x03", 6, 4);
95 ret = si2168_cmd_execute(client, &cmd);
99 /* set TS_MODE property */
100 cmd_init(&cmd, "\x14\x00\x01\x10\x10\x00", 6, 4);
101 if (dev->ts_mode & SI2168_TS_CLK_MANUAL)
102 cmd.args[4] = SI2168_TS_CLK_MANUAL;
104 cmd.args[4] |= dev->ts_mode;
106 cmd.args[4] |= SI2168_TS_TRISTATE;
107 if (dev->ts_clock_gapped)
109 ret = si2168_cmd_execute(client, &cmd);
114 static int si2168_read_status(struct dvb_frontend *fe, enum fe_status *status)
116 struct i2c_client *client = fe->demodulator_priv;
117 struct si2168_dev *dev = i2c_get_clientdata(client);
118 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
120 unsigned int utmp, utmp1, utmp2;
121 struct si2168_cmd cmd;
130 switch (c->delivery_system) {
132 cmd_init(&cmd, "\xa0\x01", 2, 13);
134 case SYS_DVBC_ANNEX_A:
135 cmd_init(&cmd, "\x90\x01", 2, 9);
138 cmd_init(&cmd, "\x50\x01", 2, 14);
145 ret = si2168_cmd_execute(client, &cmd);
149 switch ((cmd.args[2] >> 1) & 0x03) {
151 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER;
154 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI |
155 FE_HAS_SYNC | FE_HAS_LOCK;
159 dev->fe_status = *status;
161 if (*status & FE_HAS_LOCK) {
163 c->cnr.stat[0].scale = FE_SCALE_DECIBEL;
164 c->cnr.stat[0].svalue = cmd.args[3] * 1000 / 4;
167 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
170 dev_dbg(&client->dev, "status=%02x args=%*ph\n",
171 *status, cmd.rlen, cmd.args);
174 if (*status & FE_HAS_VITERBI) {
175 cmd_init(&cmd, "\x82\x00", 2, 3);
176 ret = si2168_cmd_execute(client, &cmd);
181 * Firmware returns [0, 255] mantissa and [0, 8] exponent.
182 * Convert to DVB API: mantissa * 10^(8 - exponent) / 10^8
184 utmp = clamp(8 - cmd.args[1], 0, 8);
185 for (i = 0, utmp1 = 1; i < utmp; i++)
188 utmp1 = cmd.args[2] * utmp1;
189 utmp2 = 100000000; /* 10^8 */
191 dev_dbg(&client->dev,
192 "post_bit_error=%u post_bit_count=%u ber=%u*10^-%u\n",
193 utmp1, utmp2, cmd.args[2], cmd.args[1]);
195 c->post_bit_error.stat[0].scale = FE_SCALE_COUNTER;
196 c->post_bit_error.stat[0].uvalue += utmp1;
197 c->post_bit_count.stat[0].scale = FE_SCALE_COUNTER;
198 c->post_bit_count.stat[0].uvalue += utmp2;
200 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
201 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
205 if (*status & FE_HAS_SYNC) {
206 cmd_init(&cmd, "\x84\x01", 2, 3);
207 ret = si2168_cmd_execute(client, &cmd);
211 utmp1 = cmd.args[2] << 8 | cmd.args[1] << 0;
212 dev_dbg(&client->dev, "block_error=%u\n", utmp1);
214 /* Sometimes firmware returns bogus value */
218 c->block_error.stat[0].scale = FE_SCALE_COUNTER;
219 c->block_error.stat[0].uvalue += utmp1;
221 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
226 dev_dbg(&client->dev, "failed=%d\n", ret);
230 static int si2168_set_frontend(struct dvb_frontend *fe)
232 struct i2c_client *client = fe->demodulator_priv;
233 struct si2168_dev *dev = i2c_get_clientdata(client);
234 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
236 struct si2168_cmd cmd;
237 u8 bandwidth, delivery_system;
239 dev_dbg(&client->dev,
240 "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%u stream_id=%u\n",
241 c->delivery_system, c->modulation, c->frequency,
242 c->bandwidth_hz, c->symbol_rate, c->inversion,
250 switch (c->delivery_system) {
252 delivery_system = 0x20;
254 case SYS_DVBC_ANNEX_A:
255 delivery_system = 0x30;
258 delivery_system = 0x70;
265 if (c->bandwidth_hz == 0) {
268 } else if (c->bandwidth_hz <= 2000000)
270 else if (c->bandwidth_hz <= 5000000)
272 else if (c->bandwidth_hz <= 6000000)
274 else if (c->bandwidth_hz <= 7000000)
276 else if (c->bandwidth_hz <= 8000000)
278 else if (c->bandwidth_hz <= 9000000)
280 else if (c->bandwidth_hz <= 10000000)
286 if (fe->ops.tuner_ops.set_params) {
287 ret = fe->ops.tuner_ops.set_params(fe);
292 cmd_init(&cmd, "\x88\x02\x02\x02\x02", 5, 5);
293 ret = si2168_cmd_execute(client, &cmd);
297 /* that has no big effect */
298 if (c->delivery_system == SYS_DVBT)
299 cmd_init(&cmd, "\x89\x21\x06\x11\xff\x98", 6, 3);
300 else if (c->delivery_system == SYS_DVBC_ANNEX_A)
301 cmd_init(&cmd, "\x89\x21\x06\x11\x89\xf0", 6, 3);
302 else if (c->delivery_system == SYS_DVBT2)
303 cmd_init(&cmd, "\x89\x21\x06\x11\x89\x20", 6, 3);
304 ret = si2168_cmd_execute(client, &cmd);
308 if (c->delivery_system == SYS_DVBT2) {
311 cmd.args[1] = c->stream_id & 0xff;
312 cmd.args[2] = c->stream_id == NO_STREAM_ID_FILTER ? 0 : 1;
315 ret = si2168_cmd_execute(client, &cmd);
320 cmd_init(&cmd, "\x51\x03", 2, 12);
321 ret = si2168_cmd_execute(client, &cmd);
325 cmd_init(&cmd, "\x12\x08\x04", 3, 3);
326 ret = si2168_cmd_execute(client, &cmd);
330 cmd_init(&cmd, "\x14\x00\x0c\x10\x12\x00", 6, 4);
331 ret = si2168_cmd_execute(client, &cmd);
335 cmd_init(&cmd, "\x14\x00\x06\x10\x24\x00", 6, 4);
336 ret = si2168_cmd_execute(client, &cmd);
340 cmd_init(&cmd, "\x14\x00\x07\x10\x00\x24", 6, 4);
341 ret = si2168_cmd_execute(client, &cmd);
345 cmd_init(&cmd, "\x14\x00\x0a\x10\x00\x00", 6, 4);
346 cmd.args[4] = delivery_system | bandwidth;
347 if (dev->spectral_inversion)
349 ret = si2168_cmd_execute(client, &cmd);
353 /* set DVB-C symbol rate */
354 if (c->delivery_system == SYS_DVBC_ANNEX_A) {
355 cmd_init(&cmd, "\x14\x00\x02\x11\x00\x00", 6, 4);
356 cmd.args[4] = ((c->symbol_rate / 1000) >> 0) & 0xff;
357 cmd.args[5] = ((c->symbol_rate / 1000) >> 8) & 0xff;
358 ret = si2168_cmd_execute(client, &cmd);
363 cmd_init(&cmd, "\x14\x00\x0f\x10\x10\x00", 6, 4);
364 ret = si2168_cmd_execute(client, &cmd);
368 cmd_init(&cmd, "\x14\x00\x09\x10\xe3\x08", 6, 4);
369 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
370 ret = si2168_cmd_execute(client, &cmd);
374 cmd_init(&cmd, "\x14\x00\x08\x10\xd7\x05", 6, 4);
375 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
376 ret = si2168_cmd_execute(client, &cmd);
380 cmd_init(&cmd, "\x14\x00\x01\x12\x00\x00", 6, 4);
381 ret = si2168_cmd_execute(client, &cmd);
385 cmd_init(&cmd, "\x14\x00\x01\x03\x0c\x00", 6, 4);
386 ret = si2168_cmd_execute(client, &cmd);
390 cmd_init(&cmd, "\x85", 1, 1);
391 ret = si2168_cmd_execute(client, &cmd);
395 dev->delivery_system = c->delivery_system;
398 ret = si2168_ts_bus_ctrl(fe, 1);
404 dev_dbg(&client->dev, "failed=%d\n", ret);
408 static int si2168_init(struct dvb_frontend *fe)
410 struct i2c_client *client = fe->demodulator_priv;
411 struct si2168_dev *dev = i2c_get_clientdata(client);
412 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
413 int ret, len, remaining;
414 const struct firmware *fw;
415 struct si2168_cmd cmd;
417 dev_dbg(&client->dev, "\n");
420 cmd_init(&cmd, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00",
422 ret = si2168_cmd_execute(client, &cmd);
428 cmd_init(&cmd, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8, 1);
429 ret = si2168_cmd_execute(client, &cmd);
434 cmd_init(&cmd, "\x85", 1, 1);
435 ret = si2168_cmd_execute(client, &cmd);
443 cmd_init(&cmd, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8, 1);
444 ret = si2168_cmd_execute(client, &cmd);
448 /* request the firmware, this will block and timeout */
449 ret = request_firmware(&fw, dev->firmware_name, &client->dev);
451 dev_err(&client->dev,
452 "firmware file '%s' not found\n",
454 goto err_release_firmware;
457 dev_info(&client->dev, "downloading firmware from file '%s'\n",
460 if ((fw->size % 17 == 0) && (fw->data[0] > 5)) {
461 /* firmware is in the new format */
462 for (remaining = fw->size; remaining > 0; remaining -= 17) {
463 len = fw->data[fw->size - remaining];
464 if (len > SI2168_ARGLEN) {
468 cmd_init(&cmd, &fw->data[(fw->size - remaining) + 1],
470 ret = si2168_cmd_execute(client, &cmd);
474 } else if (fw->size % 8 == 0) {
475 /* firmware is in the old format */
476 for (remaining = fw->size; remaining > 0; remaining -= 8) {
477 cmd_init(&cmd, &fw->data[fw->size - remaining], 8, 1);
478 ret = si2168_cmd_execute(client, &cmd);
483 /* bad or unknown firmware format */
488 dev_err(&client->dev, "firmware download failed %d\n", ret);
489 goto err_release_firmware;
492 release_firmware(fw);
494 cmd_init(&cmd, "\x01\x01", 2, 1);
495 ret = si2168_cmd_execute(client, &cmd);
499 /* query firmware version */
500 cmd_init(&cmd, "\x11", 1, 10);
501 ret = si2168_cmd_execute(client, &cmd);
505 dev->version = (cmd.args[9] + '@') << 24 | (cmd.args[6] - '0') << 16 |
506 (cmd.args[7] - '0') << 8 | (cmd.args[8]) << 0;
507 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
508 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
509 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
512 ret = si2168_ts_bus_ctrl(fe, 1);
517 dev->initialized = true;
519 /* Init stats here to indicate which stats are supported */
521 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
522 c->post_bit_error.len = 1;
523 c->post_bit_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
524 c->post_bit_count.len = 1;
525 c->post_bit_count.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
526 c->block_error.len = 1;
527 c->block_error.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
532 err_release_firmware:
533 release_firmware(fw);
535 dev_dbg(&client->dev, "failed=%d\n", ret);
539 static int si2168_resume(struct dvb_frontend *fe)
541 struct i2c_client *client = fe->demodulator_priv;
542 struct si2168_dev *dev = i2c_get_clientdata(client);
545 * check whether si2168_init() has been called successfully
546 * outside of a resume cycle. Only call it (and load firmware)
547 * in this case. si2168_init() is only called during resume
548 * once the device has actually been used. Otherwise, leave the
551 if (dev->initialized) {
552 dev_dbg(&client->dev, "previously initialized, call si2168_init()\n");
553 return si2168_init(fe);
555 dev_dbg(&client->dev, "not initialized yet, skipping init on resume\n");
559 static int si2168_sleep(struct dvb_frontend *fe)
561 struct i2c_client *client = fe->demodulator_priv;
562 struct si2168_dev *dev = i2c_get_clientdata(client);
564 struct si2168_cmd cmd;
566 dev_dbg(&client->dev, "\n");
570 /* tri-state data bus */
571 ret = si2168_ts_bus_ctrl(fe, 0);
575 /* Firmware later than B 4.0-11 loses warm state during sleep */
576 if (dev->version > ('B' << 24 | 4 << 16 | 0 << 8 | 11 << 0))
579 cmd_init(&cmd, "\x13", 1, 0);
580 ret = si2168_cmd_execute(client, &cmd);
586 dev_dbg(&client->dev, "failed=%d\n", ret);
590 static int si2168_get_tune_settings(struct dvb_frontend *fe,
591 struct dvb_frontend_tune_settings *s)
593 s->min_delay_ms = 900;
598 static int si2168_select(struct i2c_mux_core *muxc, u32 chan)
600 struct i2c_client *client = i2c_mux_priv(muxc);
602 struct si2168_cmd cmd;
605 cmd_init(&cmd, "\xc0\x0d\x01", 3, 0);
606 ret = si2168_cmd_execute(client, &cmd);
612 dev_dbg(&client->dev, "failed=%d\n", ret);
616 static int si2168_deselect(struct i2c_mux_core *muxc, u32 chan)
618 struct i2c_client *client = i2c_mux_priv(muxc);
620 struct si2168_cmd cmd;
623 cmd_init(&cmd, "\xc0\x0d\x00", 3, 0);
624 ret = si2168_cmd_execute(client, &cmd);
630 dev_dbg(&client->dev, "failed=%d\n", ret);
634 static const struct dvb_frontend_ops si2168_ops = {
635 .delsys = {SYS_DVBT, SYS_DVBT2, SYS_DVBC_ANNEX_A},
637 .name = "Silicon Labs Si2168",
638 .frequency_min_hz = 48 * MHz,
639 .frequency_max_hz = 870 * MHz,
640 .frequency_stepsize_hz = 62500,
641 .symbol_rate_min = 1000000,
642 .symbol_rate_max = 7200000,
643 .caps = FE_CAN_FEC_1_2 |
656 FE_CAN_TRANSMISSION_MODE_AUTO |
657 FE_CAN_GUARD_INTERVAL_AUTO |
658 FE_CAN_HIERARCHY_AUTO |
660 FE_CAN_2G_MODULATION |
664 .get_tune_settings = si2168_get_tune_settings,
667 .sleep = si2168_sleep,
668 .resume = si2168_resume,
670 .set_frontend = si2168_set_frontend,
672 .read_status = si2168_read_status,
675 static int si2168_probe(struct i2c_client *client)
677 struct si2168_config *config = client->dev.platform_data;
678 struct si2168_dev *dev;
680 struct si2168_cmd cmd;
682 dev_dbg(&client->dev, "\n");
684 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
690 i2c_set_clientdata(client, dev);
691 mutex_init(&dev->i2c_mutex);
694 cmd_init(&cmd, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00",
696 ret = si2168_cmd_execute(client, &cmd);
701 cmd_init(&cmd, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8, 1);
702 ret = si2168_cmd_execute(client, &cmd);
706 /* Query chip revision */
707 cmd_init(&cmd, "\x02", 1, 13);
708 ret = si2168_cmd_execute(client, &cmd);
712 dev->chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 |
713 cmd.args[3] << 8 | cmd.args[4] << 0;
715 switch (dev->chip_id) {
716 case SI2168_CHIP_ID_A20:
717 dev->firmware_name = SI2168_A20_FIRMWARE;
719 case SI2168_CHIP_ID_A30:
720 dev->firmware_name = SI2168_A30_FIRMWARE;
722 case SI2168_CHIP_ID_B40:
723 dev->firmware_name = SI2168_B40_FIRMWARE;
725 case SI2168_CHIP_ID_D60:
726 dev->firmware_name = SI2168_D60_FIRMWARE;
729 dev_dbg(&client->dev, "unknown chip version Si21%d-%c%c%c\n",
730 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]);
735 dev->version = (cmd.args[1]) << 24 | (cmd.args[3] - '0') << 16 |
736 (cmd.args[4] - '0') << 8 | (cmd.args[5]) << 0;
738 /* create mux i2c adapter for tuner */
739 dev->muxc = i2c_mux_alloc(client->adapter, &client->dev,
740 1, 0, I2C_MUX_LOCKED,
741 si2168_select, si2168_deselect);
746 dev->muxc->priv = client;
747 ret = i2c_mux_add_adapter(dev->muxc, 0, 0, 0);
751 /* create dvb_frontend */
752 memcpy(&dev->fe.ops, &si2168_ops, sizeof(struct dvb_frontend_ops));
753 dev->fe.demodulator_priv = client;
754 *config->i2c_adapter = dev->muxc->adapter[0];
755 *config->fe = &dev->fe;
756 dev->ts_mode = config->ts_mode;
757 dev->ts_clock_inv = config->ts_clock_inv;
758 dev->ts_clock_gapped = config->ts_clock_gapped;
759 dev->spectral_inversion = config->spectral_inversion;
761 dev_info(&client->dev, "Silicon Labs Si2168-%c%d%d successfully identified\n",
762 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
763 dev->version >> 8 & 0xff);
764 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
765 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
766 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
772 dev_warn(&client->dev, "probe failed = %d\n", ret);
776 static void si2168_remove(struct i2c_client *client)
778 struct si2168_dev *dev = i2c_get_clientdata(client);
780 dev_dbg(&client->dev, "\n");
782 i2c_mux_del_adapters(dev->muxc);
784 dev->fe.ops.release = NULL;
785 dev->fe.demodulator_priv = NULL;
790 static const struct i2c_device_id si2168_id_table[] = {
794 MODULE_DEVICE_TABLE(i2c, si2168_id_table);
796 static struct i2c_driver si2168_driver = {
799 .suppress_bind_attrs = true,
801 .probe = si2168_probe,
802 .remove = si2168_remove,
803 .id_table = si2168_id_table,
806 module_i2c_driver(si2168_driver);
809 MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver");
810 MODULE_LICENSE("GPL");
811 MODULE_FIRMWARE(SI2168_A20_FIRMWARE);
812 MODULE_FIRMWARE(SI2168_A30_FIRMWARE);
813 MODULE_FIRMWARE(SI2168_B40_FIRMWARE);
814 MODULE_FIRMWARE(SI2168_D60_FIRMWARE);