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