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