1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Silicon Labs Si2146/2147/2148/2157/2158 silicon tuner driver
5 * Copyright (C) 2014 Antti Palosaari <crope@iki.fi>
8 #include "si2157_priv.h"
10 static const struct dvb_tuner_ops si2157_ops;
12 /* execute firmware command */
13 static int si2157_cmd_execute(struct i2c_client *client, struct si2157_cmd *cmd)
15 struct si2157_dev *dev = i2c_get_clientdata(client);
17 unsigned long timeout;
19 mutex_lock(&dev->i2c_mutex);
22 /* write cmd and args for firmware */
23 ret = i2c_master_send(client, cmd->args, cmd->wlen);
25 goto err_mutex_unlock;
26 } else if (ret != cmd->wlen) {
28 goto err_mutex_unlock;
33 /* wait cmd execution terminate */
35 timeout = jiffies + msecs_to_jiffies(TIMEOUT);
36 while (!time_after(jiffies, timeout)) {
37 ret = i2c_master_recv(client, cmd->args, cmd->rlen);
39 goto err_mutex_unlock;
40 } else if (ret != cmd->rlen) {
42 goto err_mutex_unlock;
46 if ((cmd->args[0] >> 7) & 0x01)
50 dev_dbg(&client->dev, "cmd execution took %d ms\n",
51 jiffies_to_msecs(jiffies) -
52 (jiffies_to_msecs(timeout) - TIMEOUT));
54 if (!((cmd->args[0] >> 7) & 0x01)) {
56 goto err_mutex_unlock;
60 mutex_unlock(&dev->i2c_mutex);
64 mutex_unlock(&dev->i2c_mutex);
65 dev_dbg(&client->dev, "failed=%d\n", ret);
69 static int si2157_init(struct dvb_frontend *fe)
71 struct i2c_client *client = fe->tuner_priv;
72 struct si2157_dev *dev = i2c_get_clientdata(client);
73 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
74 int ret, len, remaining;
75 struct si2157_cmd cmd;
76 const struct firmware *fw;
78 unsigned int uitmp, chip_id;
80 dev_dbg(&client->dev, "\n");
82 /* Returned IF frequency is garbage when firmware is not running */
83 memcpy(cmd.args, "\x15\x00\x06\x07", 4);
86 ret = si2157_cmd_execute(client, &cmd);
90 uitmp = cmd.args[2] << 0 | cmd.args[3] << 8;
91 dev_dbg(&client->dev, "if_frequency kHz=%u\n", uitmp);
93 if (uitmp == dev->if_frequency / 1000)
97 if (dev->chiptype == SI2157_CHIPTYPE_SI2146) {
98 memcpy(cmd.args, "\xc0\x05\x01\x00\x00\x0b\x00\x00\x01", 9);
100 } else if (dev->chiptype == SI2157_CHIPTYPE_SI2141) {
101 memcpy(cmd.args, "\xc0\x00\x0d\x0e\x00\x01\x01\x01\x01\x03", 10);
104 memcpy(cmd.args, "\xc0\x00\x0c\x00\x00\x01\x01\x01\x01\x01\x01\x02\x00\x00\x01", 15);
108 ret = si2157_cmd_execute(client, &cmd);
112 /* Si2141 needs a second command before it answers the revision query */
113 if (dev->chiptype == SI2157_CHIPTYPE_SI2141) {
114 memcpy(cmd.args, "\xc0\x08\x01\x02\x00\x00\x01", 7);
116 ret = si2157_cmd_execute(client, &cmd);
121 if (dev->dont_load_firmware) {
122 dev_info(&client->dev, "device is buggy, skipping firmware download\n");
123 goto skip_fw_download;
126 /* query chip revision */
127 memcpy(cmd.args, "\x02", 1);
130 ret = si2157_cmd_execute(client, &cmd);
134 chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 | cmd.args[3] << 8 |
137 #define SI2177_A30 ('A' << 24 | 77 << 16 | '3' << 8 | '0' << 0)
138 #define SI2158_A20 ('A' << 24 | 58 << 16 | '2' << 8 | '0' << 0)
139 #define SI2148_A20 ('A' << 24 | 48 << 16 | '2' << 8 | '0' << 0)
140 #define SI2157_A30 ('A' << 24 | 57 << 16 | '3' << 8 | '0' << 0)
141 #define SI2147_A30 ('A' << 24 | 47 << 16 | '3' << 8 | '0' << 0)
142 #define SI2146_A10 ('A' << 24 | 46 << 16 | '1' << 8 | '0' << 0)
143 #define SI2141_A10 ('A' << 24 | 41 << 16 | '1' << 8 | '0' << 0)
148 fw_name = SI2158_A20_FIRMWARE;
151 fw_name = SI2141_A10_FIRMWARE;
154 fw_name = SI2157_A30_FIRMWARE;
162 dev_err(&client->dev, "unknown chip version Si21%d-%c%c%c\n",
163 cmd.args[2], cmd.args[1],
164 cmd.args[3], cmd.args[4]);
169 dev_info(&client->dev, "found a 'Silicon Labs Si21%d-%c%c%c'\n",
170 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]);
173 goto skip_fw_download;
175 /* request the firmware, this will block and timeout */
176 ret = request_firmware(&fw, fw_name, &client->dev);
178 dev_err(&client->dev, "firmware file '%s' not found\n",
183 /* firmware should be n chunks of 17 bytes */
184 if (fw->size % 17 != 0) {
185 dev_err(&client->dev, "firmware file '%s' is invalid\n",
188 goto err_release_firmware;
191 dev_info(&client->dev, "downloading firmware from file '%s'\n",
194 for (remaining = fw->size; remaining > 0; remaining -= 17) {
195 len = fw->data[fw->size - remaining];
196 if (len > SI2157_ARGLEN) {
197 dev_err(&client->dev, "Bad firmware length\n");
199 goto err_release_firmware;
201 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
204 ret = si2157_cmd_execute(client, &cmd);
206 dev_err(&client->dev, "firmware download failed %d\n",
208 goto err_release_firmware;
212 release_firmware(fw);
215 /* reboot the tuner with new firmware? */
216 memcpy(cmd.args, "\x01\x01", 2);
219 ret = si2157_cmd_execute(client, &cmd);
223 /* query firmware version */
224 memcpy(cmd.args, "\x11", 1);
227 ret = si2157_cmd_execute(client, &cmd);
231 dev_info(&client->dev, "firmware version: %c.%c.%d\n",
232 cmd.args[6], cmd.args[7], cmd.args[8]);
234 /* init statistics in order signal app which are supported */
236 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
237 /* start statistics polling */
238 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(1000));
242 err_release_firmware:
243 release_firmware(fw);
245 dev_dbg(&client->dev, "failed=%d\n", ret);
249 static int si2157_sleep(struct dvb_frontend *fe)
251 struct i2c_client *client = fe->tuner_priv;
252 struct si2157_dev *dev = i2c_get_clientdata(client);
254 struct si2157_cmd cmd;
256 dev_dbg(&client->dev, "\n");
260 /* stop statistics polling */
261 cancel_delayed_work_sync(&dev->stat_work);
264 memcpy(cmd.args, "\x16\x00", 2);
267 ret = si2157_cmd_execute(client, &cmd);
273 dev_dbg(&client->dev, "failed=%d\n", ret);
277 static int si2157_set_params(struct dvb_frontend *fe)
279 struct i2c_client *client = fe->tuner_priv;
280 struct si2157_dev *dev = i2c_get_clientdata(client);
281 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
283 struct si2157_cmd cmd;
284 u8 bandwidth, delivery_system;
285 u32 if_frequency = 5000000;
287 dev_dbg(&client->dev,
288 "delivery_system=%d frequency=%u bandwidth_hz=%u\n",
289 c->delivery_system, c->frequency, c->bandwidth_hz);
296 if (c->bandwidth_hz <= 6000000)
298 else if (c->bandwidth_hz <= 7000000)
300 else if (c->bandwidth_hz <= 8000000)
305 switch (c->delivery_system) {
307 delivery_system = 0x00;
308 if_frequency = 3250000;
310 case SYS_DVBC_ANNEX_B:
311 delivery_system = 0x10;
312 if_frequency = 4000000;
315 case SYS_DVBT2: /* it seems DVB-T and DVB-T2 both are 0x20 here */
316 delivery_system = 0x20;
318 case SYS_DVBC_ANNEX_A:
319 delivery_system = 0x30;
326 memcpy(cmd.args, "\x14\x00\x03\x07\x00\x00", 6);
327 cmd.args[4] = delivery_system | bandwidth;
332 ret = si2157_cmd_execute(client, &cmd);
336 if (dev->chiptype == SI2157_CHIPTYPE_SI2146)
337 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x01", 6);
339 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x00", 6);
340 cmd.args[4] = dev->if_port;
343 ret = si2157_cmd_execute(client, &cmd);
347 /* set if frequency if needed */
348 if (if_frequency != dev->if_frequency) {
349 memcpy(cmd.args, "\x14\x00\x06\x07", 4);
350 cmd.args[4] = (if_frequency / 1000) & 0xff;
351 cmd.args[5] = ((if_frequency / 1000) >> 8) & 0xff;
354 ret = si2157_cmd_execute(client, &cmd);
358 dev->if_frequency = if_frequency;
362 memcpy(cmd.args, "\x41\x00\x00\x00\x00\x00\x00\x00", 8);
363 cmd.args[4] = (c->frequency >> 0) & 0xff;
364 cmd.args[5] = (c->frequency >> 8) & 0xff;
365 cmd.args[6] = (c->frequency >> 16) & 0xff;
366 cmd.args[7] = (c->frequency >> 24) & 0xff;
369 ret = si2157_cmd_execute(client, &cmd);
375 dev_dbg(&client->dev, "failed=%d\n", ret);
379 static int si2157_get_if_frequency(struct dvb_frontend *fe, u32 *frequency)
381 struct i2c_client *client = fe->tuner_priv;
382 struct si2157_dev *dev = i2c_get_clientdata(client);
384 *frequency = dev->if_frequency;
388 static const struct dvb_tuner_ops si2157_ops = {
390 .name = "Silicon Labs Si2141/Si2146/2147/2148/2157/2158",
391 .frequency_min_hz = 42 * MHz,
392 .frequency_max_hz = 870 * MHz,
396 .sleep = si2157_sleep,
397 .set_params = si2157_set_params,
398 .get_if_frequency = si2157_get_if_frequency,
401 static void si2157_stat_work(struct work_struct *work)
403 struct si2157_dev *dev = container_of(work, struct si2157_dev, stat_work.work);
404 struct dvb_frontend *fe = dev->fe;
405 struct i2c_client *client = fe->tuner_priv;
406 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
407 struct si2157_cmd cmd;
410 dev_dbg(&client->dev, "\n");
412 memcpy(cmd.args, "\x42\x00", 2);
415 ret = si2157_cmd_execute(client, &cmd);
419 c->strength.stat[0].scale = FE_SCALE_DECIBEL;
420 c->strength.stat[0].svalue = (s8) cmd.args[3] * 1000;
422 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(2000));
425 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
426 dev_dbg(&client->dev, "failed=%d\n", ret);
429 static int si2157_probe(struct i2c_client *client,
430 const struct i2c_device_id *id)
432 struct si2157_config *cfg = client->dev.platform_data;
433 struct dvb_frontend *fe = cfg->fe;
434 struct si2157_dev *dev;
435 struct si2157_cmd cmd;
438 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
441 dev_err(&client->dev, "kzalloc() failed\n");
445 i2c_set_clientdata(client, dev);
447 dev->inversion = cfg->inversion;
448 dev->dont_load_firmware = cfg->dont_load_firmware;
449 dev->if_port = cfg->if_port;
450 dev->chiptype = (u8)id->driver_data;
451 dev->if_frequency = 5000000; /* default value of property 0x0706 */
452 mutex_init(&dev->i2c_mutex);
453 INIT_DELAYED_WORK(&dev->stat_work, si2157_stat_work);
455 /* check if the tuner is there */
458 ret = si2157_cmd_execute(client, &cmd);
462 memcpy(&fe->ops.tuner_ops, &si2157_ops, sizeof(struct dvb_tuner_ops));
463 fe->tuner_priv = client;
465 #ifdef CONFIG_MEDIA_CONTROLLER
467 dev->mdev = cfg->mdev;
469 dev->ent.name = KBUILD_MODNAME;
470 dev->ent.function = MEDIA_ENT_F_TUNER;
472 dev->pad[SI2157_PAD_RF_INPUT].flags = MEDIA_PAD_FL_SINK;
473 dev->pad[SI2157_PAD_RF_INPUT].sig_type = PAD_SIGNAL_ANALOG;
474 dev->pad[SI2157_PAD_VID_OUT].flags = MEDIA_PAD_FL_SOURCE;
475 dev->pad[SI2157_PAD_VID_OUT].sig_type = PAD_SIGNAL_ANALOG;
476 dev->pad[SI2157_PAD_AUD_OUT].flags = MEDIA_PAD_FL_SOURCE;
477 dev->pad[SI2157_PAD_AUD_OUT].sig_type = PAD_SIGNAL_AUDIO;
479 ret = media_entity_pads_init(&dev->ent, SI2157_NUM_PADS,
485 ret = media_device_register_entity(cfg->mdev, &dev->ent);
487 media_entity_cleanup(&dev->ent);
493 dev_info(&client->dev, "Silicon Labs %s successfully attached\n",
494 dev->chiptype == SI2157_CHIPTYPE_SI2141 ? "Si2141" :
495 dev->chiptype == SI2157_CHIPTYPE_SI2146 ?
496 "Si2146" : "Si2147/2148/2157/2158");
503 dev_dbg(&client->dev, "failed=%d\n", ret);
507 static int si2157_remove(struct i2c_client *client)
509 struct si2157_dev *dev = i2c_get_clientdata(client);
510 struct dvb_frontend *fe = dev->fe;
512 dev_dbg(&client->dev, "\n");
514 /* stop statistics polling */
515 cancel_delayed_work_sync(&dev->stat_work);
517 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
519 media_device_unregister_entity(&dev->ent);
522 memset(&fe->ops.tuner_ops, 0, sizeof(struct dvb_tuner_ops));
523 fe->tuner_priv = NULL;
529 static const struct i2c_device_id si2157_id_table[] = {
530 {"si2157", SI2157_CHIPTYPE_SI2157},
531 {"si2146", SI2157_CHIPTYPE_SI2146},
532 {"si2141", SI2157_CHIPTYPE_SI2141},
533 {"si2177", SI2157_CHIPTYPE_SI2177},
536 MODULE_DEVICE_TABLE(i2c, si2157_id_table);
538 static struct i2c_driver si2157_driver = {
541 .suppress_bind_attrs = true,
543 .probe = si2157_probe,
544 .remove = si2157_remove,
545 .id_table = si2157_id_table,
548 module_i2c_driver(si2157_driver);
550 MODULE_DESCRIPTION("Silicon Labs Si2141/Si2146/2147/2148/2157/2158 silicon tuner driver");
551 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
552 MODULE_LICENSE("GPL");
553 MODULE_FIRMWARE(SI2158_A20_FIRMWARE);
554 MODULE_FIRMWARE(SI2141_A10_FIRMWARE);
555 MODULE_FIRMWARE(SI2157_A30_FIRMWARE);