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\x02\x04", 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);
109 memcpy(cmd.args, "\xc0\x00\x0c\x00\x00\x01\x01\x01\x01\x01\x01\x02\x00\x00\x01", 15);
113 ret = si2157_cmd_execute(client, &cmd);
117 /* query chip revision */
118 memcpy(cmd.args, "\x02", 1);
121 ret = si2157_cmd_execute(client, &cmd);
125 chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 | cmd.args[3] << 8 |
128 #define SI2158_A20 ('A' << 24 | 58 << 16 | '2' << 8 | '0' << 0)
129 #define SI2148_A20 ('A' << 24 | 48 << 16 | '2' << 8 | '0' << 0)
130 #define SI2157_A30 ('A' << 24 | 57 << 16 | '3' << 8 | '0' << 0)
131 #define SI2147_A30 ('A' << 24 | 47 << 16 | '3' << 8 | '0' << 0)
132 #define SI2146_A10 ('A' << 24 | 46 << 16 | '1' << 8 | '0' << 0)
137 fw_name = SI2158_A20_FIRMWARE;
145 dev_err(&client->dev, "unknown chip version Si21%d-%c%c%c\n",
146 cmd.args[2], cmd.args[1],
147 cmd.args[3], cmd.args[4]);
152 dev_info(&client->dev, "found a 'Silicon Labs Si21%d-%c%c%c'\n",
153 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]);
156 goto skip_fw_download;
158 /* request the firmware, this will block and timeout */
159 ret = reject_firmware(&fw, fw_name, &client->dev);
161 dev_err(&client->dev, "firmware file '%s' not found\n",
166 /* firmware should be n chunks of 17 bytes */
167 if (fw->size % 17 != 0) {
168 dev_err(&client->dev, "firmware file '%s' is invalid\n",
171 goto err_release_firmware;
174 dev_info(&client->dev, "downloading firmware from file '%s'\n",
177 for (remaining = fw->size; remaining > 0; remaining -= 17) {
178 len = fw->data[fw->size - remaining];
179 if (len > SI2157_ARGLEN) {
180 dev_err(&client->dev, "Bad firmware length\n");
182 goto err_release_firmware;
184 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
187 ret = si2157_cmd_execute(client, &cmd);
189 dev_err(&client->dev, "firmware download failed %d\n",
191 goto err_release_firmware;
195 release_firmware(fw);
198 /* reboot the tuner with new firmware? */
199 memcpy(cmd.args, "\x01\x01", 2);
202 ret = si2157_cmd_execute(client, &cmd);
206 /* query firmware version */
207 memcpy(cmd.args, "\x11", 1);
210 ret = si2157_cmd_execute(client, &cmd);
214 dev_info(&client->dev, "firmware version: %c.%c.%d\n",
215 cmd.args[6], cmd.args[7], cmd.args[8]);
217 /* init statistics in order signal app which are supported */
219 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
220 /* start statistics polling */
221 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(1000));
225 err_release_firmware:
226 release_firmware(fw);
228 dev_dbg(&client->dev, "failed=%d\n", ret);
232 static int si2157_sleep(struct dvb_frontend *fe)
234 struct i2c_client *client = fe->tuner_priv;
235 struct si2157_dev *dev = i2c_get_clientdata(client);
237 struct si2157_cmd cmd;
239 dev_dbg(&client->dev, "\n");
243 /* stop statistics polling */
244 cancel_delayed_work_sync(&dev->stat_work);
247 memcpy(cmd.args, "\x16\x00", 2);
250 ret = si2157_cmd_execute(client, &cmd);
256 dev_dbg(&client->dev, "failed=%d\n", ret);
260 static int si2157_set_params(struct dvb_frontend *fe)
262 struct i2c_client *client = fe->tuner_priv;
263 struct si2157_dev *dev = i2c_get_clientdata(client);
264 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
266 struct si2157_cmd cmd;
267 u8 bandwidth, delivery_system;
268 u32 if_frequency = 5000000;
270 dev_dbg(&client->dev,
271 "delivery_system=%d frequency=%u bandwidth_hz=%u\n",
272 c->delivery_system, c->frequency, c->bandwidth_hz);
279 if (c->bandwidth_hz <= 6000000)
281 else if (c->bandwidth_hz <= 7000000)
283 else if (c->bandwidth_hz <= 8000000)
288 switch (c->delivery_system) {
290 delivery_system = 0x00;
291 if_frequency = 3250000;
293 case SYS_DVBC_ANNEX_B:
294 delivery_system = 0x10;
295 if_frequency = 4000000;
298 case SYS_DVBT2: /* it seems DVB-T and DVB-T2 both are 0x20 here */
299 delivery_system = 0x20;
301 case SYS_DVBC_ANNEX_A:
302 delivery_system = 0x30;
309 memcpy(cmd.args, "\x14\x00\x03\x07\x00\x00", 6);
310 cmd.args[4] = delivery_system | bandwidth;
315 ret = si2157_cmd_execute(client, &cmd);
319 if (dev->chiptype == SI2157_CHIPTYPE_SI2146)
320 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x01", 6);
322 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x00", 6);
323 cmd.args[4] = dev->if_port;
326 ret = si2157_cmd_execute(client, &cmd);
330 /* set if frequency if needed */
331 if (if_frequency != dev->if_frequency) {
332 memcpy(cmd.args, "\x14\x00\x06\x07", 4);
333 cmd.args[4] = (if_frequency / 1000) & 0xff;
334 cmd.args[5] = ((if_frequency / 1000) >> 8) & 0xff;
337 ret = si2157_cmd_execute(client, &cmd);
341 dev->if_frequency = if_frequency;
345 memcpy(cmd.args, "\x41\x00\x00\x00\x00\x00\x00\x00", 8);
346 cmd.args[4] = (c->frequency >> 0) & 0xff;
347 cmd.args[5] = (c->frequency >> 8) & 0xff;
348 cmd.args[6] = (c->frequency >> 16) & 0xff;
349 cmd.args[7] = (c->frequency >> 24) & 0xff;
352 ret = si2157_cmd_execute(client, &cmd);
358 dev_dbg(&client->dev, "failed=%d\n", ret);
362 static int si2157_get_if_frequency(struct dvb_frontend *fe, u32 *frequency)
364 struct i2c_client *client = fe->tuner_priv;
365 struct si2157_dev *dev = i2c_get_clientdata(client);
367 *frequency = dev->if_frequency;
371 static const struct dvb_tuner_ops si2157_ops = {
373 .name = "Silicon Labs Si2146/2147/2148/2157/2158",
374 .frequency_min = 42000000,
375 .frequency_max = 870000000,
379 .sleep = si2157_sleep,
380 .set_params = si2157_set_params,
381 .get_if_frequency = si2157_get_if_frequency,
384 static void si2157_stat_work(struct work_struct *work)
386 struct si2157_dev *dev = container_of(work, struct si2157_dev, stat_work.work);
387 struct dvb_frontend *fe = dev->fe;
388 struct i2c_client *client = fe->tuner_priv;
389 struct dtv_frontend_properties *c = &fe->dtv_property_cache;
390 struct si2157_cmd cmd;
393 dev_dbg(&client->dev, "\n");
395 memcpy(cmd.args, "\x42\x00", 2);
398 ret = si2157_cmd_execute(client, &cmd);
402 c->strength.stat[0].scale = FE_SCALE_DECIBEL;
403 c->strength.stat[0].svalue = (s8) cmd.args[3] * 1000;
405 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(2000));
408 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
409 dev_dbg(&client->dev, "failed=%d\n", ret);
412 static int si2157_probe(struct i2c_client *client,
413 const struct i2c_device_id *id)
415 struct si2157_config *cfg = client->dev.platform_data;
416 struct dvb_frontend *fe = cfg->fe;
417 struct si2157_dev *dev;
418 struct si2157_cmd cmd;
421 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
424 dev_err(&client->dev, "kzalloc() failed\n");
428 i2c_set_clientdata(client, dev);
430 dev->inversion = cfg->inversion;
431 dev->if_port = cfg->if_port;
432 dev->chiptype = (u8)id->driver_data;
433 dev->if_frequency = 5000000; /* default value of property 0x0706 */
434 mutex_init(&dev->i2c_mutex);
435 INIT_DELAYED_WORK(&dev->stat_work, si2157_stat_work);
437 /* check if the tuner is there */
440 ret = si2157_cmd_execute(client, &cmd);
444 memcpy(&fe->ops.tuner_ops, &si2157_ops, sizeof(struct dvb_tuner_ops));
445 fe->tuner_priv = client;
447 #ifdef CONFIG_MEDIA_CONTROLLER
449 dev->mdev = cfg->mdev;
451 dev->ent.name = KBUILD_MODNAME;
452 dev->ent.function = MEDIA_ENT_F_TUNER;
454 dev->pad[TUNER_PAD_RF_INPUT].flags = MEDIA_PAD_FL_SINK;
455 dev->pad[TUNER_PAD_OUTPUT].flags = MEDIA_PAD_FL_SOURCE;
456 dev->pad[TUNER_PAD_AUD_OUT].flags = MEDIA_PAD_FL_SOURCE;
458 ret = media_entity_pads_init(&dev->ent, TUNER_NUM_PADS,
464 ret = media_device_register_entity(cfg->mdev, &dev->ent);
466 media_entity_cleanup(&dev->ent);
472 dev_info(&client->dev, "Silicon Labs %s successfully attached\n",
473 dev->chiptype == SI2157_CHIPTYPE_SI2146 ?
474 "Si2146" : "Si2147/2148/2157/2158");
481 dev_dbg(&client->dev, "failed=%d\n", ret);
485 static int si2157_remove(struct i2c_client *client)
487 struct si2157_dev *dev = i2c_get_clientdata(client);
488 struct dvb_frontend *fe = dev->fe;
490 dev_dbg(&client->dev, "\n");
492 /* stop statistics polling */
493 cancel_delayed_work_sync(&dev->stat_work);
495 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
497 media_device_unregister_entity(&dev->ent);
500 memset(&fe->ops.tuner_ops, 0, sizeof(struct dvb_tuner_ops));
501 fe->tuner_priv = NULL;
507 static const struct i2c_device_id si2157_id_table[] = {
508 {"si2157", SI2157_CHIPTYPE_SI2157},
509 {"si2146", SI2157_CHIPTYPE_SI2146},
512 MODULE_DEVICE_TABLE(i2c, si2157_id_table);
514 static struct i2c_driver si2157_driver = {
517 .suppress_bind_attrs = true,
519 .probe = si2157_probe,
520 .remove = si2157_remove,
521 .id_table = si2157_id_table,
524 module_i2c_driver(si2157_driver);
526 MODULE_DESCRIPTION("Silicon Labs Si2146/2147/2148/2157/2158 silicon tuner driver");
527 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
528 MODULE_LICENSE("GPL");