drivers/media/tuners/si2157.c

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