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 */ 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 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; 88 89 dev_dbg(&client->dev, "\n"); 90 91 if (dev->fw_loaded) 92 goto warm; 93 94 /* power up */ 95 if (dev->chiptype == SI2157_CHIPTYPE_SI2146) { 96 memcpy(cmd.args, "\xc0\x05\x01\x00\x00\x0b\x00\x00\x01", 9); 97 cmd.wlen = 9; 98 } else { 99 memcpy(cmd.args, "\xc0\x00\x0c\x00\x00\x01\x01\x01\x01\x01\x01\x02\x00\x00\x01", 15); 100 cmd.wlen = 15; 101 } 102 cmd.rlen = 1; 103 ret = si2157_cmd_execute(client, &cmd); 104 if (ret) 105 goto err; 106 107 /* query chip revision */ 108 memcpy(cmd.args, "\x02", 1); 109 cmd.wlen = 1; 110 cmd.rlen = 13; 111 ret = si2157_cmd_execute(client, &cmd); 112 if (ret) 113 goto err; 114 115 chip_id = cmd.args[1] << 24 | cmd.args[2] << 16 | cmd.args[3] << 8 | 116 cmd.args[4] << 0; 117 118 #define SI2158_A20 ('A' << 24 | 58 << 16 | '2' << 8 | '0' << 0) 119 #define SI2148_A20 ('A' << 24 | 48 << 16 | '2' << 8 | '0' << 0) 120 #define SI2157_A30 ('A' << 24 | 57 << 16 | '3' << 8 | '0' << 0) 121 #define SI2147_A30 ('A' << 24 | 47 << 16 | '3' << 8 | '0' << 0) 122 #define SI2146_A10 ('A' << 24 | 46 << 16 | '1' << 8 | '0' << 0) 123 124 switch (chip_id) { 125 case SI2158_A20: 126 case SI2148_A20: 127 fw_name = SI2158_A20_FIRMWARE; 128 break; 129 case SI2157_A30: 130 case SI2147_A30: 131 case SI2146_A10: 132 fw_name = NULL; 133 break; 134 default: 135 dev_err(&client->dev, "unknown chip version Si21%d-%c%c%c\n", 136 cmd.args[2], cmd.args[1], 137 cmd.args[3], cmd.args[4]); 138 ret = -EINVAL; 139 goto err; 140 } 141 142 dev_info(&client->dev, "found a 'Silicon Labs Si21%d-%c%c%c'\n", 143 cmd.args[2], cmd.args[1], cmd.args[3], cmd.args[4]); 144 145 if (fw_name == NULL) 146 goto skip_fw_download; 147 148 /* request the firmware, this will block and timeout */ 149 ret = request_firmware(&fw, fw_name, &client->dev); 150 if (ret) { 151 dev_err(&client->dev, "firmware file '%s' not found\n", 152 fw_name); 153 goto err; 154 } 155 156 /* firmware should be n chunks of 17 bytes */ 157 if (fw->size % 17 != 0) { 158 dev_err(&client->dev, "firmware file '%s' is invalid\n", 159 fw_name); 160 ret = -EINVAL; 161 goto err_release_firmware; 162 } 163 164 dev_info(&client->dev, "downloading firmware from file '%s'\n", 165 fw_name); 166 167 for (remaining = fw->size; remaining > 0; remaining -= 17) { 168 len = fw->data[fw->size - remaining]; 169 memcpy(cmd.args, &fw->data[(fw->size - remaining) + 1], len); 170 cmd.wlen = len; 171 cmd.rlen = 1; 172 ret = si2157_cmd_execute(client, &cmd); 173 if (ret) { 174 dev_err(&client->dev, "firmware download failed %d\n", 175 ret); 176 goto err_release_firmware; 177 } 178 } 179 180 release_firmware(fw); 181 182 skip_fw_download: 183 /* reboot the tuner with new firmware? */ 184 memcpy(cmd.args, "\x01\x01", 2); 185 cmd.wlen = 2; 186 cmd.rlen = 1; 187 ret = si2157_cmd_execute(client, &cmd); 188 if (ret) 189 goto err; 190 191 /* query firmware version */ 192 memcpy(cmd.args, "\x11", 1); 193 cmd.wlen = 1; 194 cmd.rlen = 10; 195 ret = si2157_cmd_execute(client, &cmd); 196 if (ret) 197 goto err; 198 199 dev_info(&client->dev, "firmware version: %c.%c.%d\n", 200 cmd.args[6], cmd.args[7], cmd.args[8]); 201 202 dev->fw_loaded = true; 203 204 warm: 205 /* init statistics in order signal app which are supported */ 206 c->strength.len = 1; 207 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE; 208 /* start statistics polling */ 209 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(1000)); 210 211 dev->active = true; 212 return 0; 213 err_release_firmware: 214 release_firmware(fw); 215 err: 216 dev_dbg(&client->dev, "failed=%d\n", ret); 217 return ret; 218 } 219 220 static int si2157_sleep(struct dvb_frontend *fe) 221 { 222 struct i2c_client *client = fe->tuner_priv; 223 struct si2157_dev *dev = i2c_get_clientdata(client); 224 int ret; 225 struct si2157_cmd cmd; 226 227 dev_dbg(&client->dev, "\n"); 228 229 dev->active = false; 230 231 /* stop statistics polling */ 232 cancel_delayed_work_sync(&dev->stat_work); 233 234 /* standby */ 235 memcpy(cmd.args, "\x16\x00", 2); 236 cmd.wlen = 2; 237 cmd.rlen = 1; 238 ret = si2157_cmd_execute(client, &cmd); 239 if (ret) 240 goto err; 241 242 return 0; 243 err: 244 dev_dbg(&client->dev, "failed=%d\n", ret); 245 return ret; 246 } 247 248 static int si2157_set_params(struct dvb_frontend *fe) 249 { 250 struct i2c_client *client = fe->tuner_priv; 251 struct si2157_dev *dev = i2c_get_clientdata(client); 252 struct dtv_frontend_properties *c = &fe->dtv_property_cache; 253 int ret; 254 struct si2157_cmd cmd; 255 u8 bandwidth, delivery_system; 256 u32 if_frequency = 5000000; 257 258 dev_dbg(&client->dev, 259 "delivery_system=%d frequency=%u bandwidth_hz=%u\n", 260 c->delivery_system, c->frequency, c->bandwidth_hz); 261 262 if (!dev->active) { 263 ret = -EAGAIN; 264 goto err; 265 } 266 267 if (c->bandwidth_hz <= 6000000) 268 bandwidth = 0x06; 269 else if (c->bandwidth_hz <= 7000000) 270 bandwidth = 0x07; 271 else if (c->bandwidth_hz <= 8000000) 272 bandwidth = 0x08; 273 else 274 bandwidth = 0x0f; 275 276 switch (c->delivery_system) { 277 case SYS_ATSC: 278 delivery_system = 0x00; 279 if_frequency = 3250000; 280 break; 281 case SYS_DVBC_ANNEX_B: 282 delivery_system = 0x10; 283 if_frequency = 4000000; 284 break; 285 case SYS_DVBT: 286 case SYS_DVBT2: /* it seems DVB-T and DVB-T2 both are 0x20 here */ 287 delivery_system = 0x20; 288 break; 289 case SYS_DVBC_ANNEX_A: 290 delivery_system = 0x30; 291 break; 292 default: 293 ret = -EINVAL; 294 goto err; 295 } 296 297 memcpy(cmd.args, "\x14\x00\x03\x07\x00\x00", 6); 298 cmd.args[4] = delivery_system | bandwidth; 299 if (dev->inversion) 300 cmd.args[5] = 0x01; 301 cmd.wlen = 6; 302 cmd.rlen = 4; 303 ret = si2157_cmd_execute(client, &cmd); 304 if (ret) 305 goto err; 306 307 if (dev->chiptype == SI2157_CHIPTYPE_SI2146) 308 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x01", 6); 309 else 310 memcpy(cmd.args, "\x14\x00\x02\x07\x00\x00", 6); 311 cmd.args[4] = dev->if_port; 312 cmd.wlen = 6; 313 cmd.rlen = 4; 314 ret = si2157_cmd_execute(client, &cmd); 315 if (ret) 316 goto err; 317 318 /* set if frequency if needed */ 319 if (if_frequency != dev->if_frequency) { 320 memcpy(cmd.args, "\x14\x00\x06\x07", 4); 321 cmd.args[4] = (if_frequency / 1000) & 0xff; 322 cmd.args[5] = ((if_frequency / 1000) >> 8) & 0xff; 323 cmd.wlen = 6; 324 cmd.rlen = 4; 325 ret = si2157_cmd_execute(client, &cmd); 326 if (ret) 327 goto err; 328 329 dev->if_frequency = if_frequency; 330 } 331 332 /* set frequency */ 333 memcpy(cmd.args, "\x41\x00\x00\x00\x00\x00\x00\x00", 8); 334 cmd.args[4] = (c->frequency >> 0) & 0xff; 335 cmd.args[5] = (c->frequency >> 8) & 0xff; 336 cmd.args[6] = (c->frequency >> 16) & 0xff; 337 cmd.args[7] = (c->frequency >> 24) & 0xff; 338 cmd.wlen = 8; 339 cmd.rlen = 1; 340 ret = si2157_cmd_execute(client, &cmd); 341 if (ret) 342 goto err; 343 344 return 0; 345 err: 346 dev_dbg(&client->dev, "failed=%d\n", ret); 347 return ret; 348 } 349 350 static int si2157_get_if_frequency(struct dvb_frontend *fe, u32 *frequency) 351 { 352 struct i2c_client *client = fe->tuner_priv; 353 struct si2157_dev *dev = i2c_get_clientdata(client); 354 355 *frequency = dev->if_frequency; 356 return 0; 357 } 358 359 static const struct dvb_tuner_ops si2157_ops = { 360 .info = { 361 .name = "Silicon Labs Si2146/2147/2148/2157/2158", 362 .frequency_min = 55000000, 363 .frequency_max = 862000000, 364 }, 365 366 .init = si2157_init, 367 .sleep = si2157_sleep, 368 .set_params = si2157_set_params, 369 .get_if_frequency = si2157_get_if_frequency, 370 }; 371 372 static void si2157_stat_work(struct work_struct *work) 373 { 374 struct si2157_dev *dev = container_of(work, struct si2157_dev, stat_work.work); 375 struct dvb_frontend *fe = dev->fe; 376 struct i2c_client *client = fe->tuner_priv; 377 struct dtv_frontend_properties *c = &fe->dtv_property_cache; 378 struct si2157_cmd cmd; 379 int ret; 380 381 dev_dbg(&client->dev, "\n"); 382 383 memcpy(cmd.args, "\x42\x00", 2); 384 cmd.wlen = 2; 385 cmd.rlen = 12; 386 ret = si2157_cmd_execute(client, &cmd); 387 if (ret) 388 goto err; 389 390 c->strength.stat[0].scale = FE_SCALE_DECIBEL; 391 c->strength.stat[0].svalue = (s8) cmd.args[3] * 1000; 392 393 schedule_delayed_work(&dev->stat_work, msecs_to_jiffies(2000)); 394 return; 395 err: 396 c->strength.stat[0].scale = FE_SCALE_NOT_AVAILABLE; 397 dev_dbg(&client->dev, "failed=%d\n", ret); 398 } 399 400 static int si2157_probe(struct i2c_client *client, 401 const struct i2c_device_id *id) 402 { 403 struct si2157_config *cfg = client->dev.platform_data; 404 struct dvb_frontend *fe = cfg->fe; 405 struct si2157_dev *dev; 406 struct si2157_cmd cmd; 407 int ret; 408 409 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 410 if (!dev) { 411 ret = -ENOMEM; 412 dev_err(&client->dev, "kzalloc() failed\n"); 413 goto err; 414 } 415 416 i2c_set_clientdata(client, dev); 417 dev->fe = cfg->fe; 418 dev->inversion = cfg->inversion; 419 dev->if_port = cfg->if_port; 420 dev->fw_loaded = false; 421 dev->chiptype = (u8)id->driver_data; 422 dev->if_frequency = 5000000; /* default value of property 0x0706 */ 423 mutex_init(&dev->i2c_mutex); 424 INIT_DELAYED_WORK(&dev->stat_work, si2157_stat_work); 425 426 /* check if the tuner is there */ 427 cmd.wlen = 0; 428 cmd.rlen = 1; 429 ret = si2157_cmd_execute(client, &cmd); 430 if (ret) 431 goto err_kfree; 432 433 memcpy(&fe->ops.tuner_ops, &si2157_ops, sizeof(struct dvb_tuner_ops)); 434 fe->tuner_priv = client; 435 436 dev_info(&client->dev, "Silicon Labs %s successfully attached\n", 437 dev->chiptype == SI2157_CHIPTYPE_SI2146 ? 438 "Si2146" : "Si2147/2148/2157/2158"); 439 440 return 0; 441 442 err_kfree: 443 kfree(dev); 444 err: 445 dev_dbg(&client->dev, "failed=%d\n", ret); 446 return ret; 447 } 448 449 static int si2157_remove(struct i2c_client *client) 450 { 451 struct si2157_dev *dev = i2c_get_clientdata(client); 452 struct dvb_frontend *fe = dev->fe; 453 454 dev_dbg(&client->dev, "\n"); 455 456 memset(&fe->ops.tuner_ops, 0, sizeof(struct dvb_tuner_ops)); 457 fe->tuner_priv = NULL; 458 kfree(dev); 459 460 return 0; 461 } 462 463 static const struct i2c_device_id si2157_id_table[] = { 464 {"si2157", SI2157_CHIPTYPE_SI2157}, 465 {"si2146", SI2157_CHIPTYPE_SI2146}, 466 {} 467 }; 468 MODULE_DEVICE_TABLE(i2c, si2157_id_table); 469 470 static struct i2c_driver si2157_driver = { 471 .driver = { 472 .name = "si2157", 473 }, 474 .probe = si2157_probe, 475 .remove = si2157_remove, 476 .id_table = si2157_id_table, 477 }; 478 479 module_i2c_driver(si2157_driver); 480 481 MODULE_DESCRIPTION("Silicon Labs Si2146/2147/2148/2157/2158 silicon tuner driver"); 482 MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>"); 483 MODULE_LICENSE("GPL"); 484 MODULE_FIRMWARE(SI2158_A20_FIRMWARE); 485