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_read_status(struct dvb_frontend *fe, enum fe_status *status)
87 struct i2c_client *client = fe->demodulator_priv;
88 struct si2168_dev *dev = i2c_get_clientdata(client);
89 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
91 struct si2168_cmd cmd;
100 switch (c->delivery_system) {
102 memcpy(cmd.args, "\xa0\x01", 2);
106 case SYS_DVBC_ANNEX_A:
107 memcpy(cmd.args, "\x90\x01", 2);
112 memcpy(cmd.args, "\x50\x01", 2);
121 ret = si2168_cmd_execute(client, &cmd);
125 switch ((cmd.args[2] >> 1) & 0x03) {
127 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER;
130 *status = FE_HAS_SIGNAL | FE_HAS_CARRIER | FE_HAS_VITERBI |
131 FE_HAS_SYNC | FE_HAS_LOCK;
135 dev->fe_status = *status;
137 if (*status & FE_HAS_LOCK) {
139 c->cnr.stat[0].scale = FE_SCALE_DECIBEL;
140 c->cnr.stat[0].svalue = cmd.args[3] * 1000 / 4;
143 c->cnr.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
146 dev_dbg(&client->dev, "status=%02x args=%*ph\n",
147 *status, cmd.rlen, cmd.args);
151 dev_dbg(&client->dev, "failed=%d\n", ret);
155 static int si2168_set_frontend(struct dvb_frontend *fe)
157 struct i2c_client *client = fe->demodulator_priv;
158 struct si2168_dev *dev = i2c_get_clientdata(client);
159 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
161 struct si2168_cmd cmd;
162 u8 bandwidth, delivery_system;
164 dev_dbg(&client->dev,
165 "delivery_system=%u modulation=%u frequency=%u bandwidth_hz=%u symbol_rate=%u inversion=%u stream_id=%u\n",
166 c->delivery_system, c->modulation, c->frequency,
167 c->bandwidth_hz, c->symbol_rate, c->inversion,
175 switch (c->delivery_system) {
177 delivery_system = 0x20;
179 case SYS_DVBC_ANNEX_A:
180 delivery_system = 0x30;
183 delivery_system = 0x70;
190 if (c->bandwidth_hz == 0) {
193 } else if (c->bandwidth_hz <= 2000000)
195 else if (c->bandwidth_hz <= 5000000)
197 else if (c->bandwidth_hz <= 6000000)
199 else if (c->bandwidth_hz <= 7000000)
201 else if (c->bandwidth_hz <= 8000000)
203 else if (c->bandwidth_hz <= 9000000)
205 else if (c->bandwidth_hz <= 10000000)
211 if (fe->ops.tuner_ops.set_params) {
212 ret = fe->ops.tuner_ops.set_params(fe);
217 memcpy(cmd.args, "\x88\x02\x02\x02\x02", 5);
220 ret = si2168_cmd_execute(client, &cmd);
224 /* that has no big effect */
225 if (c->delivery_system == SYS_DVBT)
226 memcpy(cmd.args, "\x89\x21\x06\x11\xff\x98", 6);
227 else if (c->delivery_system == SYS_DVBC_ANNEX_A)
228 memcpy(cmd.args, "\x89\x21\x06\x11\x89\xf0", 6);
229 else if (c->delivery_system == SYS_DVBT2)
230 memcpy(cmd.args, "\x89\x21\x06\x11\x89\x20", 6);
233 ret = si2168_cmd_execute(client, &cmd);
237 if (c->delivery_system == SYS_DVBT2) {
240 cmd.args[1] = c->stream_id & 0xff;
241 cmd.args[2] = c->stream_id == NO_STREAM_ID_FILTER ? 0 : 1;
244 ret = si2168_cmd_execute(client, &cmd);
249 memcpy(cmd.args, "\x51\x03", 2);
252 ret = si2168_cmd_execute(client, &cmd);
256 memcpy(cmd.args, "\x12\x08\x04", 3);
259 ret = si2168_cmd_execute(client, &cmd);
263 memcpy(cmd.args, "\x14\x00\x0c\x10\x12\x00", 6);
266 ret = si2168_cmd_execute(client, &cmd);
270 memcpy(cmd.args, "\x14\x00\x06\x10\x24\x00", 6);
273 ret = si2168_cmd_execute(client, &cmd);
277 memcpy(cmd.args, "\x14\x00\x07\x10\x00\x24", 6);
280 ret = si2168_cmd_execute(client, &cmd);
284 memcpy(cmd.args, "\x14\x00\x0a\x10\x00\x00", 6);
285 cmd.args[4] = delivery_system | bandwidth;
288 ret = si2168_cmd_execute(client, &cmd);
292 /* set DVB-C symbol rate */
293 if (c->delivery_system == SYS_DVBC_ANNEX_A) {
294 memcpy(cmd.args, "\x14\x00\x02\x11", 4);
295 cmd.args[4] = ((c->symbol_rate / 1000) >> 0) & 0xff;
296 cmd.args[5] = ((c->symbol_rate / 1000) >> 8) & 0xff;
299 ret = si2168_cmd_execute(client, &cmd);
304 memcpy(cmd.args, "\x14\x00\x0f\x10\x10\x00", 6);
307 ret = si2168_cmd_execute(client, &cmd);
311 memcpy(cmd.args, "\x14\x00\x09\x10\xe3\x08", 6);
312 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
315 ret = si2168_cmd_execute(client, &cmd);
319 memcpy(cmd.args, "\x14\x00\x08\x10\xd7\x05", 6);
320 cmd.args[5] |= dev->ts_clock_inv ? 0x00 : 0x10;
323 ret = si2168_cmd_execute(client, &cmd);
327 memcpy(cmd.args, "\x14\x00\x01\x12\x00\x00", 6);
330 ret = si2168_cmd_execute(client, &cmd);
334 memcpy(cmd.args, "\x14\x00\x01\x03\x0c\x00", 6);
337 ret = si2168_cmd_execute(client, &cmd);
341 memcpy(cmd.args, "\x85", 1);
344 ret = si2168_cmd_execute(client, &cmd);
348 dev->delivery_system = c->delivery_system;
352 dev_dbg(&client->dev, "failed=%d\n", ret);
356 static int si2168_init(struct dvb_frontend *fe)
358 struct i2c_client *client = fe->demodulator_priv;
359 struct si2168_dev *dev = i2c_get_clientdata(client);
360 int ret, len, remaining;
361 const struct firmware *fw;
362 struct si2168_cmd cmd;
364 dev_dbg(&client->dev, "\n");
367 memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
370 ret = si2168_cmd_execute(client, &cmd);
376 memcpy(cmd.args, "\xc0\x06\x08\x0f\x00\x20\x21\x01", 8);
379 ret = si2168_cmd_execute(client, &cmd);
384 memcpy(cmd.args, "\x85", 1);
387 ret = si2168_cmd_execute(client, &cmd);
395 memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
398 ret = si2168_cmd_execute(client, &cmd);
402 /* request the firmware, this will block and timeout */
403 ret = reject_firmware(&fw, dev->firmware_name, &client->dev);
405 /* fallback mechanism to handle old name for Si2168 B40 fw */
406 if (dev->chip_id == SI2168_CHIP_ID_B40) {
407 dev->firmware_name = SI2168_B40_FIRMWARE_FALLBACK;
408 ret = reject_firmware(&fw, dev->firmware_name,
413 dev_notice(&client->dev,
414 "please install firmware file '%s'\n",
415 SI2168_B40_FIRMWARE);
417 dev_err(&client->dev,
418 "firmware file '%s' not found\n",
420 goto err_release_firmware;
424 dev_info(&client->dev, "downloading firmware from file '%s'\n",
427 if ((fw->size % 17 == 0) && (fw->data[0] > 5)) {
428 /* firmware is in the new format */
429 for (remaining = fw->size; remaining > 0; remaining -= 17) {
430 len = fw->data[fw->size - remaining];
431 if (len > SI2168_ARGLEN) {
435 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
438 ret = si2168_cmd_execute(client, &cmd);
442 } else if (fw->size % 8 == 0) {
443 /* firmware is in the old format */
444 for (remaining = fw->size; remaining > 0; remaining -= 8) {
446 memcpy(cmd.args, &fw->data[fw->size - remaining], len);
449 ret = si2168_cmd_execute(client, &cmd);
454 /* bad or unknown firmware format */
459 dev_err(&client->dev, "firmware download failed %d\n", ret);
460 goto err_release_firmware;
463 release_firmware(fw);
465 memcpy(cmd.args, "\x01\x01", 2);
468 ret = si2168_cmd_execute(client, &cmd);
472 /* query firmware version */
473 memcpy(cmd.args, "\x11", 1);
476 ret = si2168_cmd_execute(client, &cmd);
480 dev->version = (cmd.args[9] + '@') << 24 | (cmd.args[6] - '0') << 16 |
481 (cmd.args[7] - '0') << 8 | (cmd.args[8]) << 0;
482 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
483 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
484 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
487 memcpy(cmd.args, "\x14\x00\x01\x10\x10\x00", 6);
488 cmd.args[4] |= dev->ts_mode;
489 if (dev->ts_clock_gapped)
493 ret = si2168_cmd_execute(client, &cmd);
503 err_release_firmware:
504 release_firmware(fw);
506 dev_dbg(&client->dev, "failed=%d\n", ret);
510 static int si2168_sleep(struct dvb_frontend *fe)
512 struct i2c_client *client = fe->demodulator_priv;
513 struct si2168_dev *dev = i2c_get_clientdata(client);
515 struct si2168_cmd cmd;
517 dev_dbg(&client->dev, "\n");
521 /* Firmware B 4.0-11 or later loses warm state during sleep */
522 if (dev->version > ('B' << 24 | 4 << 16 | 0 << 8 | 11 << 0))
525 memcpy(cmd.args, "\x13", 1);
528 ret = si2168_cmd_execute(client, &cmd);
534 dev_dbg(&client->dev, "failed=%d\n", ret);
538 static int si2168_get_tune_settings(struct dvb_frontend *fe,
539 struct dvb_frontend_tune_settings *s)
541 s->min_delay_ms = 900;
546 static int si2168_select(struct i2c_mux_core *muxc, u32 chan)
548 struct i2c_client *client = i2c_mux_priv(muxc);
550 struct si2168_cmd cmd;
553 memcpy(cmd.args, "\xc0\x0d\x01", 3);
556 ret = si2168_cmd_execute(client, &cmd);
562 dev_dbg(&client->dev, "failed=%d\n", ret);
566 static int si2168_deselect(struct i2c_mux_core *muxc, u32 chan)
568 struct i2c_client *client = i2c_mux_priv(muxc);
570 struct si2168_cmd cmd;
573 memcpy(cmd.args, "\xc0\x0d\x00", 3);
576 ret = si2168_cmd_execute(client, &cmd);
582 dev_dbg(&client->dev, "failed=%d\n", ret);
586 static const struct dvb_frontend_ops si2168_ops = {
587 .delsys = {SYS_DVBT, SYS_DVBT2, SYS_DVBC_ANNEX_A},
589 .name = "Silicon Labs Si2168",
590 .symbol_rate_min = 1000000,
591 .symbol_rate_max = 7200000,
592 .caps = FE_CAN_FEC_1_2 |
605 FE_CAN_TRANSMISSION_MODE_AUTO |
606 FE_CAN_GUARD_INTERVAL_AUTO |
607 FE_CAN_HIERARCHY_AUTO |
609 FE_CAN_2G_MODULATION |
613 .get_tune_settings = si2168_get_tune_settings,
616 .sleep = si2168_sleep,
618 .set_frontend = si2168_set_frontend,
620 .read_status = si2168_read_status,
623 static int si2168_probe(struct i2c_client *client,
624 const struct i2c_device_id *id)
626 struct si2168_config *config = client->dev.platform_data;
627 struct si2168_dev *dev;
629 struct si2168_cmd cmd;
631 dev_dbg(&client->dev, "\n");
633 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
636 dev_err(&client->dev, "kzalloc() failed\n");
640 i2c_set_clientdata(client, dev);
641 mutex_init(&dev->i2c_mutex);
644 memcpy(cmd.args, "\xc0\x12\x00\x0c\x00\x0d\x16\x00\x00\x00\x00\x00\x00", 13);
647 ret = si2168_cmd_execute(client, &cmd);
652 memcpy(cmd.args, "\xc0\x06\x01\x0f\x00\x20\x20\x01", 8);
655 ret = si2168_cmd_execute(client, &cmd);
659 /* Query chip revision */
660 memcpy(cmd.args, "\x02", 1);
663 ret = si2168_cmd_execute(client, &cmd);
667 dev->chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 |
668 cmd.args[3] << 8 | cmd.args[4] << 0;
670 switch (dev->chip_id) {
671 case SI2168_CHIP_ID_A20:
672 dev->firmware_name = SI2168_A20_FIRMWARE;
674 case SI2168_CHIP_ID_A30:
675 dev->firmware_name = SI2168_A30_FIRMWARE;
677 case SI2168_CHIP_ID_B40:
678 dev->firmware_name = SI2168_B40_FIRMWARE;
681 dev_dbg(&client->dev, "unknown chip version Si21%d-%c%c%c\n",
682 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]);
687 dev->version = (cmd.args[1]) << 24 | (cmd.args[3] - '0') << 16 |
688 (cmd.args[4] - '0') << 8 | (cmd.args[5]) << 0;
690 /* create mux i2c adapter for tuner */
691 dev->muxc = i2c_mux_alloc(client->adapter, &client->dev,
692 1, 0, I2C_MUX_LOCKED,
693 si2168_select, si2168_deselect);
698 dev->muxc->priv = client;
699 ret = i2c_mux_add_adapter(dev->muxc, 0, 0, 0);
703 /* create dvb_frontend */
704 memcpy(&dev->fe.ops, &si2168_ops, sizeof(struct dvb_frontend_ops));
705 dev->fe.demodulator_priv = client;
706 *config->i2c_adapter = dev->muxc->adapter[0];
707 *config->fe = &dev->fe;
708 dev->ts_mode = config->ts_mode;
709 dev->ts_clock_inv = config->ts_clock_inv;
710 dev->ts_clock_gapped = config->ts_clock_gapped;
712 dev_info(&client->dev, "Silicon Labs Si2168-%c%d%d successfully identified\n",
713 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
714 dev->version >> 8 & 0xff);
715 dev_info(&client->dev, "firmware version: %c %d.%d.%d\n",
716 dev->version >> 24 & 0xff, dev->version >> 16 & 0xff,
717 dev->version >> 8 & 0xff, dev->version >> 0 & 0xff);
723 dev_dbg(&client->dev, "failed=%d\n", ret);
727 static int si2168_remove(struct i2c_client *client)
729 struct si2168_dev *dev = i2c_get_clientdata(client);
731 dev_dbg(&client->dev, "\n");
733 i2c_mux_del_adapters(dev->muxc);
735 dev->fe.ops.release = NULL;
736 dev->fe.demodulator_priv = NULL;
743 static const struct i2c_device_id si2168_id_table[] = {
747 MODULE_DEVICE_TABLE(i2c, si2168_id_table);
749 static struct i2c_driver si2168_driver = {
752 .suppress_bind_attrs = true,
754 .probe = si2168_probe,
755 .remove = si2168_remove,
756 .id_table = si2168_id_table,
759 module_i2c_driver(si2168_driver);
761 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
762 MODULE_DESCRIPTION("Silicon Labs Si2168 DVB-T/T2/C demodulator driver");
763 MODULE_LICENSE("GPL");