1 /* 2 * Silicon Labs Si2141/2146/2147/2148/2151/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 */ 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 78 #define MAX_RESET_ATTEMPTS 10 79 static int si2157_init(struct dvb_frontend *fe) 80 { 81 struct i2c_client *client = fe->tuner_priv; 82 struct si2157_dev *dev = i2c_get_clientdata(client); 83 struct dtv_frontend_properties *c = &fe->dtv_property_cache; 84 int ret, len, remaining; 85 struct si2157_cmd cmd; 86 const struct firmware *fw; 87 const char *fw_name; 88 unsigned int uitmp, chip_id, i; 89 90 dev_dbg(&client->dev, "\n"); 91 92 /* Returned IF frequency is garbage when firmware is not running */ 93 memcpy(cmd.args, "\x15\x00\x06\x07", 4); 94 cmd.wlen = 4; 95 cmd.rlen = 4; 96 ret = si2157_cmd_execute(client, &cmd); 97 if (ret) 98 goto err; 99 100 uitmp = cmd.args[2] << 0 | cmd.args[3] << 8; 101 dev_dbg(&client->dev, "if_frequency kHz=%u\n", uitmp); 102 103 if (uitmp == dev->if_frequency / 1000) 104 goto warm; 105 106 if (dev->chiptype == SI2157_CHIPTYPE_SI2141) { 107 for (i = 0; i < MAX_RESET_ATTEMPTS; i++) { 108 /* reset */ 109 memcpy(cmd.args, "\xc0\x05\x00\x00", 4); 110 cmd.wlen = 4; 111 cmd.rlen = 1; 112 ret = si2157_cmd_execute(client, &cmd); 113 if (ret) 114 goto err; 115 116 memcpy(cmd.args, "\xc0\x00\x0d\x0e\x00\x01\x01\x01\x01\x03", 10); 117 cmd.wlen = 10; 118 cmd.rlen = 1; 119 ret = si2157_cmd_execute(client, &cmd); 120 if (ret) 121 goto err; 122 if (cmd.args[0] != 0xfe) 123 break; 124 } 125 if (i >= MAX_RESET_ATTEMPTS) 126 goto err; 127 } 128 129 /* power up */ 130 switch (dev->chiptype) { 131 case SI2157_CHIPTYPE_SI2146: 132 memcpy(cmd.args, "\xc0\x05\x01\x00\x00\x0b\x00\x00\x01", 9); 133 cmd.wlen = 9; 134 break; 135 case SI2157_CHIPTYPE_SI2141: 136 memcpy(cmd.args, "\xc0\x08\x01\x02\x00\x08\x01", 7); 137 cmd.wlen = 7; 138 break; 139 default: 140 memcpy(cmd.args, "\xc0\x00\x0c\x00\x00\x01\x01\x01\x01\x01\x01\x02\x00\x00\x01", 15); 141 cmd.wlen = 15; 142 } 143 144 cmd.rlen = 1; 145 ret = si2157_cmd_execute(client, &cmd); 146 if (ret) 147 goto err; 148 149 /* query chip revision */ 150 memcpy(cmd.args, "\x02", 1); 151 cmd.wlen = 1; 152 cmd.rlen = 13; 153 ret = si2157_cmd_execute(client, &cmd); 154 if (ret) 155 goto err; 156 157 chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 | cmd.args[3] << 8 | 158 cmd.args[4] << 0; 159 160 #define SI2158_A20 ('A' << 24 | 58 << 16 | '2' << 8 | '0' << 0) 161 #define SI2148_A20 ('A' << 24 | 48 << 16 | '2' << 8 | '0' << 0) 162 #define SI2157_A30 ('A' << 24 | 57 << 16 | '3' << 8 | '0' << 0) 163 #define SI2147_A30 ('A' << 24 | 47 << 16 | '3' << 8 | '0' << 0) 164 #define SI2146_A10 ('A' << 24 | 46 << 16 | '1' << 8 | '0' << 0) 165 #define SI2141_A10 ('A' << 24 | 41 << 16 | '1' << 8 | '0' << 0) 166 #define SI2151_A10 ('A' << 24 | 51 << 16 | '1' << 8 | '0' << 0) 167 168 switch (chip_id) { 169 case SI2158_A20: 170 case SI2148_A20: 171 fw_name = SI2158_A20_FIRMWARE; 172 break; 173 case SI2157_A30: 174 case SI2147_A30: 175 case SI2146_A10: 176 fw_name = NULL; 177 break; 178 case SI2141_A10: 179 case SI2151_A10: 180 fw_name = SI2141_A10_FIRMWARE; 181 break; 182 default: 183 dev_err(&client->dev, "unknown chip version Si21%d-%c%c%c\n", 184 cmd.args[2], cmd.args[1], 185 cmd.args[3], cmd.args[4]); 186 ret = -EINVAL; 187 goto err; 188 } 189 190 dev_info(&client->dev, "found a 'Silicon Labs Si21%d-%c%c%c'\n", 191 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]); 192 193 if (fw_name == NULL) 194 goto skip_fw_download; 195 196 /* request the firmware, this will block and timeout */ 197 ret = request_firmware(&fw, fw_name, &client->dev); 198 if (ret) { 199 dev_err(&client->dev, "firmware file '%s' not found\n", 200 fw_name); 201 goto err; 202 } 203 204 /* firmware should be n chunks of 17 bytes */ 205 if (fw->size % 17 != 0) { 206 dev_err(&client->dev, "firmware file '%s' is invalid\n", 207 fw_name); 208 ret = -EINVAL; 209 goto err_release_firmware; 210 } 211 212 dev_info(&client->dev, "downloading firmware from file '%s'\n", 213 fw_name); 214 215 for (remaining = fw->size; remaining > 0; remaining -= 17) { 216 len = fw->data[fw->size - remaining]; 217 if (len > SI2157_ARGLEN) { 218 dev_err(&client->dev, "Bad firmware length\n"); 219 ret = -EINVAL; 220 goto err_release_firmware; 221 } 222 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len); 223 cmd.wlen = len; 224 cmd.rlen = 1; 225 ret = si2157_cmd_execute(client, &cmd); 226 if (ret) { 227 dev_err(&client->dev, "firmware download failed %d\n", 228 ret); 229 goto err_release_firmware; 230 } 231 } 232 233 release_firmware(fw); 234 235 skip_fw_download: 236 /* reboot the tuner with new firmware? */ 237 memcpy(cmd.args, "\x01\x01", 2); 238 cmd.wlen = 2; 239 cmd.rlen = 1; 240 ret = si2157_cmd_execute(client, &cmd); 241 if (ret) 242 goto err; 243 244 /* query firmware version */ 245 memcpy(cmd.args, "\x11", 1); 246 cmd.wlen = 1; 247 cmd.rlen = 10; 248 ret = si2157_cmd_execute(client, &cmd); 249 if (ret) 250 goto err; 251 252 dev_info(&client->dev, "firmware version: %c.%c.%d\n", 253 cmd.args[6], cmd.args[7], cmd.args[8]); 254 255 if (dev->chiptype == SI2157_CHIPTYPE_SI2141) { 256 /* set clock */ 257 memcpy(cmd.args, "\xc0\x00\x0d", 3); 258 cmd.wlen = 3; 259 cmd.rlen = 1; 260 ret = si2157_cmd_execute(client, &cmd); 261 if (ret) 262 goto err; 263 /* setup PIN */ 264 memcpy(cmd.args, "\x12\x80\x80\x85\x00\x81\x00", 7); 265 cmd.wlen = 7; 266 cmd.rlen = 7; 267 ret = si2157_cmd_execute(client, &cmd); 268 if (ret) 269 goto err; 270 } 271 warm: 272 /* init statistics in order signal app which are supported */ 273 c->strength.len = 1; 274 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE; 275 /* start statistics polling */ 276 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(1000)); 277 278 dev->active = true; 279 return 0; 280 err_release_firmware: 281 release_firmware(fw); 282 err: 283 dev_dbg(&client->dev, "failed=%d\n", ret); 284 return ret; 285 } 286 287 static int si2157_sleep(struct dvb_frontend *fe) 288 { 289 struct i2c_client *client = fe->tuner_priv; 290 struct si2157_dev *dev = i2c_get_clientdata(client); 291 int ret; 292 struct si2157_cmd cmd; 293 294 dev_dbg(&client->dev, "\n"); 295 296 dev->active = false; 297 298 /* stop statistics polling */ 299 cancel_delayed_work_sync(&dev->stat_work); 300 301 /* standby */ 302 memcpy(cmd.args, "\x16\x00", 2); 303 cmd.wlen = 2; 304 cmd.rlen = 1; 305 ret = si2157_cmd_execute(client, &cmd); 306 if (ret) 307 goto err; 308 309 return 0; 310 err: 311 dev_dbg(&client->dev, "failed=%d\n", ret); 312 return ret; 313 } 314 315 static int si2157_set_params(struct dvb_frontend *fe) 316 { 317 struct i2c_client *client = fe->tuner_priv; 318 struct si2157_dev *dev = i2c_get_clientdata(client); 319 struct dtv_frontend_properties *c = &fe->dtv_property_cache; 320 int ret; 321 struct si2157_cmd cmd; 322 u8 bandwidth, delivery_system; 323 u32 if_frequency = 5000000; 324 325 dev_dbg(&client->dev, 326 "delivery_system=%d frequency=%u bandwidth_hz=%u\n", 327 c->delivery_system, c->frequency, c->bandwidth_hz); 328 329 if (!dev->active) { 330 ret = -EAGAIN; 331 goto err; 332 } 333 334 if (c->bandwidth_hz <= 6000000) 335 bandwidth = 0x06; 336 else if (c->bandwidth_hz <= 7000000) 337 bandwidth = 0x07; 338 else if (c->bandwidth_hz <= 8000000) 339 bandwidth = 0x08; 340 else 341 bandwidth = 0x0f; 342 343 switch (c->delivery_system) { 344 case SYS_ATSC: 345 delivery_system = 0x00; 346 if_frequency = 3250000; 347 break; 348 case SYS_DVBC_ANNEX_B: 349 delivery_system = 0x10; 350 if_frequency = 4000000; 351 break; 352 case SYS_DVBT: 353 case SYS_DVBT2: /* it seems DVB-T and DVB-T2 both are 0x20 here */ 354 delivery_system = 0x20; 355 break; 356 case SYS_DVBC_ANNEX_A: 357 delivery_system = 0x30; 358 break; 359 default: 360 ret = -EINVAL; 361 goto err; 362 } 363 364 memcpy(cmd.args, "\x14\x00\x03\x07\x00\x00", 6); 365 cmd.args[4] = delivery_system | bandwidth; 366 if (dev->inversion) 367 cmd.args[5] = 0x01; 368 cmd.wlen = 6; 369 cmd.rlen = 4; 370 ret = si2157_cmd_execute(client, &cmd); 371 if (ret) 372 goto err; 373 374 if (dev->chiptype == SI2157_CHIPTYPE_SI2146) 375 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x01", 6); 376 else 377 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x00", 6); 378 cmd.args[4] = dev->if_port; 379 cmd.wlen = 6; 380 cmd.rlen = 4; 381 ret = si2157_cmd_execute(client, &cmd); 382 if (ret) 383 goto err; 384 385 /* set if frequency if needed */ 386 if (if_frequency != dev->if_frequency) { 387 memcpy(cmd.args, "\x14\x00\x06\x07", 4); 388 cmd.args[4] = (if_frequency / 1000) & 0xff; 389 cmd.args[5] = ((if_frequency / 1000) >> 8) & 0xff; 390 cmd.wlen = 6; 391 cmd.rlen = 4; 392 ret = si2157_cmd_execute(client, &cmd); 393 if (ret) 394 goto err; 395 396 dev->if_frequency = if_frequency; 397 } 398 399 /* set frequency */ 400 memcpy(cmd.args, "\x41\x00\x00\x00\x00\x00\x00\x00", 8); 401 cmd.args[4] = (c->frequency >> 0) & 0xff; 402 cmd.args[5] = (c->frequency >> 8) & 0xff; 403 cmd.args[6] = (c->frequency >> 16) & 0xff; 404 cmd.args[7] = (c->frequency >> 24) & 0xff; 405 cmd.wlen = 8; 406 cmd.rlen = 1; 407 ret = si2157_cmd_execute(client, &cmd); 408 if (ret) 409 goto err; 410 411 return 0; 412 err: 413 dev_dbg(&client->dev, "failed=%d\n", ret); 414 return ret; 415 } 416 417 static int si2157_get_if_frequency(struct dvb_frontend *fe, u32 *frequency) 418 { 419 struct i2c_client *client = fe->tuner_priv; 420 struct si2157_dev *dev = i2c_get_clientdata(client); 421 422 *frequency = dev->if_frequency; 423 return 0; 424 } 425 426 static const struct dvb_tuner_ops si2157_ops = { 427 .info = { 428 .name = "Silicon Labs Si2146/2147/2148/2157/2158", 429 .frequency_min = 42000000, 430 .frequency_max = 870000000, 431 }, 432 433 .init = si2157_init, 434 .sleep = si2157_sleep, 435 .set_params = si2157_set_params, 436 .get_if_frequency = si2157_get_if_frequency, 437 }; 438 439 static void si2157_stat_work(struct work_struct *work) 440 { 441 struct si2157_dev *dev = container_of(work, struct si2157_dev, stat_work.work); 442 struct dvb_frontend *fe = dev->fe; 443 struct i2c_client *client = fe->tuner_priv; 444 struct dtv_frontend_properties *c = &fe->dtv_property_cache; 445 struct si2157_cmd cmd; 446 int ret; 447 448 dev_dbg(&client->dev, "\n"); 449 450 memcpy(cmd.args, "\x42\x00", 2); 451 cmd.wlen = 2; 452 cmd.rlen = 12; 453 ret = si2157_cmd_execute(client, &cmd); 454 if (ret) 455 goto err; 456 457 c->strength.stat[0].scale = FE_SCALE_DECIBEL; 458 c->strength.stat[0].svalue = (s8) cmd.args[3] * 1000; 459 460 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(2000)); 461 return; 462 err: 463 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE; 464 dev_dbg(&client->dev, "failed=%d\n", ret); 465 } 466 467 static int si2157_probe(struct i2c_client *client, 468 const struct i2c_device_id *id) 469 { 470 struct si2157_config *cfg = client->dev.platform_data; 471 struct dvb_frontend *fe = cfg->fe; 472 struct si2157_dev *dev; 473 struct si2157_cmd cmd; 474 int ret; 475 476 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 477 if (!dev) { 478 ret = -ENOMEM; 479 dev_err(&client->dev, "kzalloc() failed\n"); 480 goto err; 481 } 482 483 i2c_set_clientdata(client, dev); 484 dev->fe = cfg->fe; 485 dev->inversion = cfg->inversion; 486 dev->if_port = cfg->if_port; 487 dev->chiptype = (u8)id->driver_data; 488 dev->if_frequency = 5000000; /* default value of property 0x0706 */ 489 mutex_init(&dev->i2c_mutex); 490 INIT_DELAYED_WORK(&dev->stat_work, si2157_stat_work); 491 492 /* check if the tuner is there */ 493 cmd.wlen = 0; 494 cmd.rlen = 1; 495 ret = si2157_cmd_execute(client, &cmd); 496 if (ret) 497 goto err_kfree; 498 499 memcpy(&fe->ops.tuner_ops, &si2157_ops, sizeof(struct dvb_tuner_ops)); 500 fe->tuner_priv = client; 501 502 #ifdef CONFIG_MEDIA_CONTROLLER 503 if (cfg->mdev) { 504 dev->mdev = cfg->mdev; 505 506 dev->ent.name = KBUILD_MODNAME; 507 dev->ent.function = MEDIA_ENT_F_TUNER; 508 509 dev->pad[TUNER_PAD_RF_INPUT].flags = MEDIA_PAD_FL_SINK; 510 dev->pad[TUNER_PAD_OUTPUT].flags = MEDIA_PAD_FL_SOURCE; 511 dev->pad[TUNER_PAD_AUD_OUT].flags = MEDIA_PAD_FL_SOURCE; 512 513 ret = media_entity_pads_init(&dev->ent, TUNER_NUM_PADS, 514 &dev->pad[0]); 515 516 if (ret) 517 goto err_kfree; 518 519 ret = media_device_register_entity(cfg->mdev, &dev->ent); 520 if (ret) { 521 media_entity_cleanup(&dev->ent); 522 goto err_kfree; 523 } 524 } 525 #endif 526 527 dev_info(&client->dev, "Silicon Labs %s successfully attached\n", 528 dev->chiptype == SI2157_CHIPTYPE_SI2141 ? 529 "Si2141/2151" : dev->chiptype == SI2157_CHIPTYPE_SI2146 ? 530 "Si2146" : "Si2147/2148/2157/2158"); 531 532 return 0; 533 534 err_kfree: 535 kfree(dev); 536 err: 537 dev_dbg(&client->dev, "failed=%d\n", ret); 538 return ret; 539 } 540 541 static int si2157_remove(struct i2c_client *client) 542 { 543 struct si2157_dev *dev = i2c_get_clientdata(client); 544 struct dvb_frontend *fe = dev->fe; 545 546 dev_dbg(&client->dev, "\n"); 547 548 /* stop statistics polling */ 549 cancel_delayed_work_sync(&dev->stat_work); 550 551 #ifdef CONFIG_MEDIA_CONTROLLER_DVB 552 if (dev->mdev) 553 media_device_unregister_entity(&dev->ent); 554 #endif 555 556 memset(&fe->ops.tuner_ops, 0, sizeof(struct dvb_tuner_ops)); 557 fe->tuner_priv = NULL; 558 kfree(dev); 559 560 return 0; 561 } 562 563 static const struct i2c_device_id si2157_id_table[] = { 564 {"si2157", SI2157_CHIPTYPE_SI2157}, 565 {"si2146", SI2157_CHIPTYPE_SI2146}, 566 {"si2141", SI2157_CHIPTYPE_SI2141}, 567 {"si2151", SI2157_CHIPTYPE_SI2141}, 568 {} 569 }; 570 MODULE_DEVICE_TABLE(i2c, si2157_id_table); 571 572 static struct i2c_driver si2157_driver = { 573 .driver = { 574 .name = "si2157", 575 .suppress_bind_attrs = true, 576 }, 577 .probe = si2157_probe, 578 .remove = si2157_remove, 579 .id_table = si2157_id_table, 580 }; 581 582 module_i2c_driver(si2157_driver); 583 584 MODULE_DESCRIPTION("Silicon Labs Si2141/2146/2147/2148/2151/2157/2158 silicon tuner driver"); 585 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>"); 586 MODULE_LICENSE("GPL"); 587 MODULE_FIRMWARE(SI2158_A20_FIRMWARE); 588 MODULE_FIRMWARE(SI2141_A10_FIRMWARE); 589