1 /*
2 * Silicon Labs Si2146/2147/2148/2157/2158 silicon tuner driver
3 *
4 * Copyright (C) 2014 Antti Palosaari <crope@iki.fi>
5 *
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.
10 *
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.
15 */
16
17 #include "si2157_priv.h"
18
19 static const struct dvb_tuner_ops si2157_ops;
20
21 /* execute firmware command */
si2157_cmd_execute(struct i2c_client * client,struct si2157_cmd * cmd)22 static int si2157_cmd_execute(struct i2c_client *client, struct si2157_cmd *cmd)
23 {
24 struct si2157_dev *dev = i2c_get_clientdata(client);
25 int ret;
26 unsigned long timeout;
27
28 mutex_lock(&dev->i2c_mutex);
29
30 if (cmd->wlen) {
31 /* write cmd and args for firmware */
32 ret = i2c_master_send(client, cmd->args, cmd->wlen);
33 if (ret < 0) {
34 goto err_mutex_unlock;
35 } else if (ret != cmd->wlen) {
36 ret = -EREMOTEIO;
37 goto err_mutex_unlock;
38 }
39 }
40
41 if (cmd->rlen) {
42 /* wait cmd execution terminate */
43 #define TIMEOUT 80
44 timeout = jiffies + msecs_to_jiffies(TIMEOUT);
45 while (!time_after(jiffies, timeout)) {
46 ret = i2c_master_recv(client, cmd->args, cmd->rlen);
47 if (ret < 0) {
48 goto err_mutex_unlock;
49 } else if (ret != cmd->rlen) {
50 ret = -EREMOTEIO;
51 goto err_mutex_unlock;
52 }
53
54 /* firmware ready? */
55 if ((cmd->args[0] >> 7) & 0x01)
56 break;
57 }
58
59 dev_dbg(&client->dev, "cmd execution took %d ms\n",
60 jiffies_to_msecs(jiffies) -
61 (jiffies_to_msecs(timeout) - TIMEOUT));
62
63 if (!((cmd->args[0] >> 7) & 0x01)) {
64 ret = -ETIMEDOUT;
65 goto err_mutex_unlock;
66 }
67 }
68
69 mutex_unlock(&dev->i2c_mutex);
70 return 0;
71
72 err_mutex_unlock:
73 mutex_unlock(&dev->i2c_mutex);
74 dev_dbg(&client->dev, "failed=%d\n", ret);
75 return ret;
76 }
77
si2157_init(struct dvb_frontend * fe)78 static int si2157_init(struct dvb_frontend *fe)
79 {
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;
86 const char *fw_name;
87 unsigned int chip_id, xtal_trim;
88
89 dev_dbg(&client->dev, "\n");
90
91 /* Try to get Xtal trim property, to verify tuner still running */
92 memcpy(cmd.args, "\x15\x00\x02\x04", 4);
93 cmd.wlen = 4;
94 cmd.rlen = 4;
95 ret = si2157_cmd_execute(client, &cmd);
96
97 xtal_trim = cmd.args[2] | (cmd.args[3] << 8);
98
99 if (ret == 0 && xtal_trim < 16)
100 goto warm;
101
102 dev->if_frequency = 0; /* we no longer know current tuner state */
103
104 /* power up */
105 if (dev->chiptype == SI2157_CHIPTYPE_SI2146) {
106 memcpy(cmd.args, "\xc0\x05\x01\x00\x00\x0b\x00\x00\x01", 9);
107 cmd.wlen = 9;
108 } else if (dev->chiptype == SI2157_CHIPTYPE_SI2141) {
109 memcpy(cmd.args, "\xc0\x00\x0d\x0e\x00\x01\x01\x01\x01\x03", 10);
110 cmd.wlen = 10;
111 } else {
112 memcpy(cmd.args, "\xc0\x00\x0c\x00\x00\x01\x01\x01\x01\x01\x01\x02\x00\x00\x01", 15);
113 cmd.wlen = 15;
114 }
115 cmd.rlen = 1;
116 ret = si2157_cmd_execute(client, &cmd);
117 if (ret)
118 goto err;
119
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);
123 cmd.wlen = 7;
124 ret = si2157_cmd_execute(client, &cmd);
125 if (ret)
126 goto err;
127 }
128
129 /* query chip revision */
130 memcpy(cmd.args, "\x02", 1);
131 cmd.wlen = 1;
132 cmd.rlen = 13;
133 ret = si2157_cmd_execute(client, &cmd);
134 if (ret)
135 goto err;
136
137 chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 | cmd.args[3] << 8 |
138 cmd.args[4] << 0;
139
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)
146
147 switch (chip_id) {
148 case SI2158_A20:
149 case SI2148_A20:
150 fw_name = SI2158_A20_FIRMWARE;
151 break;
152 case SI2141_A10:
153 fw_name = SI2141_A10_FIRMWARE;
154 break;
155 case SI2157_A30:
156 case SI2147_A30:
157 case SI2146_A10:
158 fw_name = NULL;
159 break;
160 default:
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]);
164 ret = -EINVAL;
165 goto err;
166 }
167
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]);
170
171 if (fw_name == NULL)
172 goto skip_fw_download;
173
174 /* request the firmware, this will block and timeout */
175 ret = request_firmware(&fw, fw_name, &client->dev);
176 if (ret) {
177 dev_err(&client->dev, "firmware file '%s' not found\n",
178 fw_name);
179 goto err;
180 }
181
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",
185 fw_name);
186 ret = -EINVAL;
187 goto err_release_firmware;
188 }
189
190 dev_info(&client->dev, "downloading firmware from file '%s'\n",
191 fw_name);
192
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");
197 ret = -EINVAL;
198 goto err_release_firmware;
199 }
200 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len);
201 cmd.wlen = len;
202 cmd.rlen = 1;
203 ret = si2157_cmd_execute(client, &cmd);
204 if (ret) {
205 dev_err(&client->dev, "firmware download failed %d\n",
206 ret);
207 goto err_release_firmware;
208 }
209 }
210
211 release_firmware(fw);
212
213 skip_fw_download:
214 /* reboot the tuner with new firmware? */
215 memcpy(cmd.args, "\x01\x01", 2);
216 cmd.wlen = 2;
217 cmd.rlen = 1;
218 ret = si2157_cmd_execute(client, &cmd);
219 if (ret)
220 goto err;
221
222 /* query firmware version */
223 memcpy(cmd.args, "\x11", 1);
224 cmd.wlen = 1;
225 cmd.rlen = 10;
226 ret = si2157_cmd_execute(client, &cmd);
227 if (ret)
228 goto err;
229
230 dev_info(&client->dev, "firmware version: %c.%c.%d\n",
231 cmd.args[6], cmd.args[7], cmd.args[8]);
232 warm:
233 /* init statistics in order signal app which are supported */
234 c->strength.len = 1;
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));
238
239 dev->active = true;
240 return 0;
241 err_release_firmware:
242 release_firmware(fw);
243 err:
244 dev_dbg(&client->dev, "failed=%d\n", ret);
245 return ret;
246 }
247
si2157_sleep(struct dvb_frontend * fe)248 static int si2157_sleep(struct dvb_frontend *fe)
249 {
250 struct i2c_client *client = fe->tuner_priv;
251 struct si2157_dev *dev = i2c_get_clientdata(client);
252 int ret;
253 struct si2157_cmd cmd;
254
255 dev_dbg(&client->dev, "\n");
256
257 dev->active = false;
258
259 /* stop statistics polling */
260 cancel_delayed_work_sync(&dev->stat_work);
261
262 /* standby */
263 memcpy(cmd.args, "\x16\x00", 2);
264 cmd.wlen = 2;
265 cmd.rlen = 1;
266 ret = si2157_cmd_execute(client, &cmd);
267 if (ret)
268 goto err;
269
270 return 0;
271 err:
272 dev_dbg(&client->dev, "failed=%d\n", ret);
273 return ret;
274 }
275
si2157_set_params(struct dvb_frontend * fe)276 static int si2157_set_params(struct dvb_frontend *fe)
277 {
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;
281 int ret;
282 struct si2157_cmd cmd;
283 u8 bandwidth, delivery_system;
284 u32 if_frequency = 5000000;
285
286 dev_dbg(&client->dev,
287 "delivery_system=%d frequency=%u bandwidth_hz=%u\n",
288 c->delivery_system, c->frequency, c->bandwidth_hz);
289
290 if (!dev->active) {
291 ret = -EAGAIN;
292 goto err;
293 }
294
295 if (c->bandwidth_hz <= 6000000)
296 bandwidth = 0x06;
297 else if (c->bandwidth_hz <= 7000000)
298 bandwidth = 0x07;
299 else if (c->bandwidth_hz <= 8000000)
300 bandwidth = 0x08;
301 else
302 bandwidth = 0x0f;
303
304 switch (c->delivery_system) {
305 case SYS_ATSC:
306 delivery_system = 0x00;
307 if_frequency = 3250000;
308 break;
309 case SYS_DVBC_ANNEX_B:
310 delivery_system = 0x10;
311 if_frequency = 4000000;
312 break;
313 case SYS_DVBT:
314 case SYS_DVBT2: /* it seems DVB-T and DVB-T2 both are 0x20 here */
315 delivery_system = 0x20;
316 break;
317 case SYS_DVBC_ANNEX_A:
318 delivery_system = 0x30;
319 break;
320 default:
321 ret = -EINVAL;
322 goto err;
323 }
324
325 memcpy(cmd.args, "\x14\x00\x03\x07\x00\x00", 6);
326 cmd.args[4] = delivery_system | bandwidth;
327 if (dev->inversion)
328 cmd.args[5] = 0x01;
329 cmd.wlen = 6;
330 cmd.rlen = 4;
331 ret = si2157_cmd_execute(client, &cmd);
332 if (ret)
333 goto err;
334
335 if (dev->chiptype == SI2157_CHIPTYPE_SI2146)
336 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x01", 6);
337 else
338 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x00", 6);
339 cmd.args[4] = dev->if_port;
340 cmd.wlen = 6;
341 cmd.rlen = 4;
342 ret = si2157_cmd_execute(client, &cmd);
343 if (ret)
344 goto err;
345
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;
351 cmd.wlen = 6;
352 cmd.rlen = 4;
353 ret = si2157_cmd_execute(client, &cmd);
354 if (ret)
355 goto err;
356
357 dev->if_frequency = if_frequency;
358 }
359
360 /* set 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;
366 cmd.wlen = 8;
367 cmd.rlen = 1;
368 ret = si2157_cmd_execute(client, &cmd);
369 if (ret)
370 goto err;
371
372 return 0;
373 err:
374 dev_dbg(&client->dev, "failed=%d\n", ret);
375 return ret;
376 }
377
si2157_get_if_frequency(struct dvb_frontend * fe,u32 * frequency)378 static int si2157_get_if_frequency(struct dvb_frontend *fe, u32 *frequency)
379 {
380 struct i2c_client *client = fe->tuner_priv;
381 struct si2157_dev *dev = i2c_get_clientdata(client);
382
383 *frequency = dev->if_frequency;
384 return 0;
385 }
386
387 static const struct dvb_tuner_ops si2157_ops = {
388 .info = {
389 .name = "Silicon Labs Si2141/Si2146/2147/2148/2157/2158",
390 .frequency_min_hz = 42 * MHz,
391 .frequency_max_hz = 870 * MHz,
392 },
393
394 .init = si2157_init,
395 .sleep = si2157_sleep,
396 .set_params = si2157_set_params,
397 .get_if_frequency = si2157_get_if_frequency,
398 };
399
si2157_stat_work(struct work_struct * work)400 static void si2157_stat_work(struct work_struct *work)
401 {
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;
407 int ret;
408
409 dev_dbg(&client->dev, "\n");
410
411 memcpy(cmd.args, "\x42\x00", 2);
412 cmd.wlen = 2;
413 cmd.rlen = 12;
414 ret = si2157_cmd_execute(client, &cmd);
415 if (ret)
416 goto err;
417
418 c->strength.stat[0].scale = FE_SCALE_DECIBEL;
419 c->strength.stat[0].svalue = (s8) cmd.args[3] * 1000;
420
421 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(2000));
422 return;
423 err:
424 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE;
425 dev_dbg(&client->dev, "failed=%d\n", ret);
426 }
427
si2157_probe(struct i2c_client * client,const struct i2c_device_id * id)428 static int si2157_probe(struct i2c_client *client,
429 const struct i2c_device_id *id)
430 {
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;
435 int ret;
436
437 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
438 if (!dev) {
439 ret = -ENOMEM;
440 dev_err(&client->dev, "kzalloc() failed\n");
441 goto err;
442 }
443
444 i2c_set_clientdata(client, dev);
445 dev->fe = cfg->fe;
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);
452
453 /* check if the tuner is there */
454 cmd.wlen = 0;
455 cmd.rlen = 1;
456 ret = si2157_cmd_execute(client, &cmd);
457 if (ret)
458 goto err_kfree;
459
460 memcpy(&fe->ops.tuner_ops, &si2157_ops, sizeof(struct dvb_tuner_ops));
461 fe->tuner_priv = client;
462
463 #ifdef CONFIG_MEDIA_CONTROLLER
464 if (cfg->mdev) {
465 dev->mdev = cfg->mdev;
466
467 dev->ent.name = KBUILD_MODNAME;
468 dev->ent.function = MEDIA_ENT_F_TUNER;
469
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;
473
474 ret = media_entity_pads_init(&dev->ent, TUNER_NUM_PADS,
475 &dev->pad[0]);
476
477 if (ret)
478 goto err_kfree;
479
480 ret = media_device_register_entity(cfg->mdev, &dev->ent);
481 if (ret) {
482 media_entity_cleanup(&dev->ent);
483 goto err_kfree;
484 }
485 }
486 #endif
487
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");
492
493 return 0;
494
495 err_kfree:
496 kfree(dev);
497 err:
498 dev_dbg(&client->dev, "failed=%d\n", ret);
499 return ret;
500 }
501
si2157_remove(struct i2c_client * client)502 static int si2157_remove(struct i2c_client *client)
503 {
504 struct si2157_dev *dev = i2c_get_clientdata(client);
505 struct dvb_frontend *fe = dev->fe;
506
507 dev_dbg(&client->dev, "\n");
508
509 /* stop statistics polling */
510 cancel_delayed_work_sync(&dev->stat_work);
511
512 #ifdef CONFIG_MEDIA_CONTROLLER_DVB
513 if (dev->mdev)
514 media_device_unregister_entity(&dev->ent);
515 #endif
516
517 memset(&fe->ops.tuner_ops, 0, sizeof(struct dvb_tuner_ops));
518 fe->tuner_priv = NULL;
519 kfree(dev);
520
521 return 0;
522 }
523
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},
528 {}
529 };
530 MODULE_DEVICE_TABLE(i2c, si2157_id_table);
531
532 static struct i2c_driver si2157_driver = {
533 .driver = {
534 .name = "si2157",
535 .suppress_bind_attrs = true,
536 },
537 .probe = si2157_probe,
538 .remove = si2157_remove,
539 .id_table = si2157_id_table,
540 };
541
542 module_i2c_driver(si2157_driver);
543
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");
547 MODULE_FIRMWARE(SI2158_A20_FIRMWARE);
548 MODULE_FIRMWARE(SI2141_A10_FIRMWARE);
549