2 * Silicon Labs Si2146/2147/2148/2157/2158 silicon tuner 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 "si2157_priv.h"
19 static const struct dvb_tuner_ops si2157_ops;
21 /* execute firmware command */
22 static int si2157_cmd_execute(struct i2c_client *client, struct si2157_cmd *cmd)
24 struct si2157_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));
63 if (!((cmd->args[0] >> 7) & 0x01)) {
65 goto err_mutex_unlock;
69 mutex_unlock(&dev->i2c_mutex);
73 mutex_unlock(&dev->i2c_mutex);
74 dev_dbg(&client->dev, "failed=%d\n", ret);
78 static int si2157_init(struct dvb_frontend *fe)
80 struct i2c_client *client = fe->tuner_priv;
81 struct si2157_dev *dev = i2c_get_clientdata(client);
82 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
83 int ret, len, remaining;
84 struct si2157_cmd cmd;
85 const struct firmware *fw;
87 unsigned int chip_id, xtal_trim;
89 dev_dbg(&client->dev, "\n");
91 /* Try to get Xtal trim property, to verify tuner still running */
92 memcpy(cmd.args, "\x15\x00\x04\x02", 4);
95 ret = si2157_cmd_execute(client, &cmd);
97 xtal_trim = cmd.args[2] | (cmd.args[3] << 8);
99 if (ret == 0 && xtal_trim < 16)
102 dev->if_frequency = 0; /* we no longer know current tuner state */
105 if (dev->chiptype == SI2157_CHIPTYPE_SI2146) {
106 memcpy(cmd.args, "\xc0\x05\x01\x00\x00\x0b\x00\x00\x01", 9);
108 } else if (dev->chiptype == SI2157_CHIPTYPE_SI2141) {
109 memcpy(cmd.args, "\xc0\x00\x0d\x0e\x00\x01\x01\x01\x01\x03", 10);
112 memcpy(cmd.args, "\xc0\x00\x0c\x00\x00\x01\x01\x01\x01\x01\x01\x02\x00\x00\x01", 15);
116 ret = si2157_cmd_execute(client, &cmd);
120 /* Si2141 needs a second command before it answers the revision query */
121 if (dev->chiptype == SI2157_CHIPTYPE_SI2141) {
122 memcpy(cmd.args, "\xc0\x08\x01\x02\x00\x00\x01", 7);
124 ret = si2157_cmd_execute(client, &cmd);
129 /* query chip revision */
130 memcpy(cmd.args, "\x02", 1);
133 ret = si2157_cmd_execute(client, &cmd);
137 chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 | cmd.args[3] << 8 |
140 #define SI2158_A20 ('A' << 24 | 58 << 16 | '2' << 8 | '0' << 0)
141 #define SI2148_A20 ('A' << 24 | 48 << 16 | '2' << 8 | '0' << 0)
142 #define SI2157_A30 ('A' << 24 | 57 << 16 | '3' << 8 | '0' << 0)
143 #define SI2147_A30 ('A' << 24 | 47 << 16 | '3' << 8 | '0' << 0)
144 #define SI2146_A10 ('A' << 24 | 46 << 16 | '1' << 8 | '0' << 0)
145 #define SI2141_A10 ('A' << 24 | 41 << 16 | '1' << 8 | '0' << 0)
150 fw_name = SI2158_A20_FIRMWARE;
153 fw_name = SI2141_A10_FIRMWARE;
161 dev_err(&client->dev, "unknown chip version Si21%d-%c%c%c\n",
162 cmd.args[2], cmd.args[1],
163 cmd.args[3], cmd.args[4]);
168 dev_info(&client->dev, "found a 'Silicon Labs Si21%d-%c%c%c'\n",
169 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]);
172 goto skip_fw_download;
174 /* request the firmware, this will block and timeout */
175 ret = reject_firmware(&fw, fw_name, &client->dev);
177 dev_err(&client->dev, "firmware file '%s' not found\n",
182 /* firmware should be n chunks of 17 bytes */
183 if (fw->size % 17 != 0) {
184 dev_err(&client->dev, "firmware file '%s' is invalid\n",
187 goto err_release_firmware;
190 dev_info(&client->dev, "downloading firmware from file '%s'\n",
193 for (remaining = fw->size; remaining > 0; remaining -= 17) {
194 len = fw->data[fw->size - remaining];
195 if (len > SI2157_ARGLEN) {
196 dev_err(&client->dev, "Bad firmware length\n");
198 goto err_release_firmware;
200 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
203 ret = si2157_cmd_execute(client, &cmd);
205 dev_err(&client->dev, "firmware download failed %d\n",
207 goto err_release_firmware;
211 release_firmware(fw);
214 /* reboot the tuner with new firmware? */
215 memcpy(cmd.args, "\x01\x01", 2);
218 ret = si2157_cmd_execute(client, &cmd);
222 /* query firmware version */
223 memcpy(cmd.args, "\x11", 1);
226 ret = si2157_cmd_execute(client, &cmd);
230 dev_info(&client->dev, "firmware version: %c.%c.%d\n",
231 cmd.args[6], cmd.args[7], cmd.args[8]);
233 /* init statistics in order signal app which are supported */
235 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
236 /* start statistics polling */
237 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(1000));
241 err_release_firmware:
242 release_firmware(fw);
244 dev_dbg(&client->dev, "failed=%d\n", ret);
248 static int si2157_sleep(struct dvb_frontend *fe)
250 struct i2c_client *client = fe->tuner_priv;
251 struct si2157_dev *dev = i2c_get_clientdata(client);
253 struct si2157_cmd cmd;
255 dev_dbg(&client->dev, "\n");
259 /* stop statistics polling */
260 cancel_delayed_work_sync(&dev->stat_work);
263 memcpy(cmd.args, "\x16\x00", 2);
266 ret = si2157_cmd_execute(client, &cmd);
272 dev_dbg(&client->dev, "failed=%d\n", ret);
276 static int si2157_set_params(struct dvb_frontend *fe)
278 struct i2c_client *client = fe->tuner_priv;
279 struct si2157_dev *dev = i2c_get_clientdata(client);
280 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
282 struct si2157_cmd cmd;
283 u8 bandwidth, delivery_system;
284 u32 if_frequency = 5000000;
286 dev_dbg(&client->dev,
287 "delivery_system=%d frequency=%u bandwidth_hz=%u\n",
288 c->delivery_system, c->frequency, c->bandwidth_hz);
295 if (c->bandwidth_hz <= 6000000)
297 else if (c->bandwidth_hz <= 7000000)
299 else if (c->bandwidth_hz <= 8000000)
304 switch (c->delivery_system) {
306 delivery_system = 0x00;
307 if_frequency = 3250000;
309 case SYS_DVBC_ANNEX_B:
310 delivery_system = 0x10;
311 if_frequency = 4000000;
314 case SYS_DVBT2: /* it seems DVB-T and DVB-T2 both are 0x20 here */
315 delivery_system = 0x20;
317 case SYS_DVBC_ANNEX_A:
318 delivery_system = 0x30;
325 memcpy(cmd.args, "\x14\x00\x03\x07\x00\x00", 6);
326 cmd.args[4] = delivery_system | bandwidth;
331 ret = si2157_cmd_execute(client, &cmd);
335 if (dev->chiptype == SI2157_CHIPTYPE_SI2146)
336 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x01", 6);
338 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x00", 6);
339 cmd.args[4] = dev->if_port;
342 ret = si2157_cmd_execute(client, &cmd);
346 /* set if frequency if needed */
347 if (if_frequency != dev->if_frequency) {
348 memcpy(cmd.args, "\x14\x00\x06\x07", 4);
349 cmd.args[4] = (if_frequency / 1000) & 0xff;
350 cmd.args[5] = ((if_frequency / 1000) >> 8) & 0xff;
353 ret = si2157_cmd_execute(client, &cmd);
357 dev->if_frequency = if_frequency;
361 memcpy(cmd.args, "\x41\x00\x00\x00\x00\x00\x00\x00", 8);
362 cmd.args[4] = (c->frequency >> 0) & 0xff;
363 cmd.args[5] = (c->frequency >> 8) & 0xff;
364 cmd.args[6] = (c->frequency >> 16) & 0xff;
365 cmd.args[7] = (c->frequency >> 24) & 0xff;
368 ret = si2157_cmd_execute(client, &cmd);
374 dev_dbg(&client->dev, "failed=%d\n", ret);
378 static int si2157_get_if_frequency(struct dvb_frontend *fe, u32 *frequency)
380 struct i2c_client *client = fe->tuner_priv;
381 struct si2157_dev *dev = i2c_get_clientdata(client);
383 *frequency = dev->if_frequency;
387 static const struct dvb_tuner_ops si2157_ops = {
389 .name = "Silicon Labs Si2141/Si2146/2147/2148/2157/2158",
390 .frequency_min = 42000000,
391 .frequency_max = 870000000,
395 .sleep = si2157_sleep,
396 .set_params = si2157_set_params,
397 .get_if_frequency = si2157_get_if_frequency,
400 static void si2157_stat_work(struct work_struct *work)
402 struct si2157_dev *dev = container_of(work, struct si2157_dev, stat_work.work);
403 struct dvb_frontend *fe = dev->fe;
404 struct i2c_client *client = fe->tuner_priv;
405 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
406 struct si2157_cmd cmd;
409 dev_dbg(&client->dev, "\n");
411 memcpy(cmd.args, "\x42\x00", 2);
414 ret = si2157_cmd_execute(client, &cmd);
418 c->strength.stat[0].scale = FE_SCALE_DECIBEL;
419 c->strength.stat[0].svalue = (s8) cmd.args[3] * 1000;
421 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(2000));
424 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
425 dev_dbg(&client->dev, "failed=%d\n", ret);
428 static int si2157_probe(struct i2c_client *client,
429 const struct i2c_device_id *id)
431 struct si2157_config *cfg = client->dev.platform_data;
432 struct dvb_frontend *fe = cfg->fe;
433 struct si2157_dev *dev;
434 struct si2157_cmd cmd;
437 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
440 dev_err(&client->dev, "kzalloc() failed\n");
444 i2c_set_clientdata(client, dev);
446 dev->inversion = cfg->inversion;
447 dev->if_port = cfg->if_port;
448 dev->chiptype = (u8)id->driver_data;
449 dev->if_frequency = 5000000; /* default value of property 0x0706 */
450 mutex_init(&dev->i2c_mutex);
451 INIT_DELAYED_WORK(&dev->stat_work, si2157_stat_work);
453 /* check if the tuner is there */
456 ret = si2157_cmd_execute(client, &cmd);
460 memcpy(&fe->ops.tuner_ops, &si2157_ops, sizeof(struct dvb_tuner_ops));
461 fe->tuner_priv = client;
463 #ifdef CONFIG_MEDIA_CONTROLLER
465 dev->mdev = cfg->mdev;
467 dev->ent.name = KBUILD_MODNAME;
468 dev->ent.function = MEDIA_ENT_F_TUNER;
470 dev->pad[TUNER_PAD_RF_INPUT].flags = MEDIA_PAD_FL_SINK;
471 dev->pad[TUNER_PAD_OUTPUT].flags = MEDIA_PAD_FL_SOURCE;
472 dev->pad[TUNER_PAD_AUD_OUT].flags = MEDIA_PAD_FL_SOURCE;
474 ret = media_entity_pads_init(&dev->ent, TUNER_NUM_PADS,
480 ret = media_device_register_entity(cfg->mdev, &dev->ent);
482 media_entity_cleanup(&dev->ent);
488 dev_info(&client->dev, "Silicon Labs %s successfully attached\n",
489 dev->chiptype == SI2157_CHIPTYPE_SI2141 ? "Si2141" :
490 dev->chiptype == SI2157_CHIPTYPE_SI2146 ?
491 "Si2146" : "Si2147/2148/2157/2158");
498 dev_dbg(&client->dev, "failed=%d\n", ret);
502 static int si2157_remove(struct i2c_client *client)
504 struct si2157_dev *dev = i2c_get_clientdata(client);
505 struct dvb_frontend *fe = dev->fe;
507 dev_dbg(&client->dev, "\n");
509 /* stop statistics polling */
510 cancel_delayed_work_sync(&dev->stat_work);
512 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
514 media_device_unregister_entity(&dev->ent);
517 memset(&fe->ops.tuner_ops, 0, sizeof(struct dvb_tuner_ops));
518 fe->tuner_priv = NULL;
524 static const struct i2c_device_id si2157_id_table[] = {
525 {"si2157", SI2157_CHIPTYPE_SI2157},
526 {"si2146", SI2157_CHIPTYPE_SI2146},
527 {"si2141", SI2157_CHIPTYPE_SI2141},
530 MODULE_DEVICE_TABLE(i2c, si2157_id_table);
532 static struct i2c_driver si2157_driver = {
535 .suppress_bind_attrs = true,
537 .probe = si2157_probe,
538 .remove = si2157_remove,
539 .id_table = si2157_id_table,
542 module_i2c_driver(si2157_driver);
544 MODULE_DESCRIPTION("Silicon Labs Si2141/Si2146/2147/2148/2157/2158 silicon tuner driver");
545 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
546 MODULE_LICENSE("GPL");