drivers/media/tuners/si2157.c

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