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