drivers/char/tpm/tpm_tis.c

   1 /*
   2  * Copyright (C) 2005, 2006 IBM Corporation
   3  * Copyright (C) 2014, 2015 Intel Corporation
   4  *
   5  * Authors:
   6  * Leendert van Doorn <leendert@watson.ibm.com>
   7  * Kylene Hall <kjhall@us.ibm.com>
   8  *
   9  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
  10  *
  11  * Device driver for TCG/TCPA TPM (trusted platform module).
  12  * Specifications at www.trustedcomputinggroup.org
  13  *
  14  * This device driver implements the TPM interface as defined in
  15  * the TCG TPM Interface Spec version 1.2, revision 1.0.
  16  *
  17  * This program is free software; you can redistribute it and/or
  18  * modify it under the terms of the GNU General Public License as
  19  * published by the Free Software Foundation, version 2 of the
  20  * License.
  21  */
  22 #include <linux/init.h>
  23 #include <linux/module.h>
  24 #include <linux/moduleparam.h>
  25 #include <linux/pnp.h>
  26 #include <linux/slab.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/wait.h>
  29 #include <linux/acpi.h>
  30 #include <linux/freezer.h>
  31 #include "tpm.h"
  32
  33 enum tis_access {
  34         TPM_ACCESS_VALID = 0x80,
  35         TPM_ACCESS_ACTIVE_LOCALITY = 0x20,
  36         TPM_ACCESS_REQUEST_PENDING = 0x04,
  37         TPM_ACCESS_REQUEST_USE = 0x02,
  38 };
  39
  40 enum tis_status {
  41         TPM_STS_VALID = 0x80,
  42         TPM_STS_COMMAND_READY = 0x40,
  43         TPM_STS_GO = 0x20,
  44         TPM_STS_DATA_AVAIL = 0x10,
  45         TPM_STS_DATA_EXPECT = 0x08,
  46 };
  47
  48 enum tis_int_flags {
  49         TPM_GLOBAL_INT_ENABLE = 0x80000000,
  50         TPM_INTF_BURST_COUNT_STATIC = 0x100,
  51         TPM_INTF_CMD_READY_INT = 0x080,
  52         TPM_INTF_INT_EDGE_FALLING = 0x040,
  53         TPM_INTF_INT_EDGE_RISING = 0x020,
  54         TPM_INTF_INT_LEVEL_LOW = 0x010,
  55         TPM_INTF_INT_LEVEL_HIGH = 0x008,
  56         TPM_INTF_LOCALITY_CHANGE_INT = 0x004,
  57         TPM_INTF_STS_VALID_INT = 0x002,
  58         TPM_INTF_DATA_AVAIL_INT = 0x001,
  59 };
  60
  61 enum tis_defaults {
  62         TIS_MEM_BASE = 0xFED40000,
  63         TIS_MEM_LEN = 0x5000,
  64         TIS_SHORT_TIMEOUT = 750,        /* ms */
  65         TIS_LONG_TIMEOUT = 2000,        /* 2 sec */
  66 };
  67
  68 struct tpm_info {
  69         struct resource res;
  70         /* irq > 0 means: use irq $irq;
  71          * irq = 0 means: autoprobe for an irq;
  72          * irq = -1 means: no irq support
  73          */
  74         int irq;
  75 };
  76
  77 static struct tpm_info tis_default_info = {
  78         .res = {
  79                 .start = TIS_MEM_BASE,
  80                 .end = TIS_MEM_BASE + TIS_MEM_LEN - 1,
  81                 .flags = IORESOURCE_MEM,
  82         },
  83         .irq = 0,
  84 };
  85
  86 /* Some timeout values are needed before it is known whether the chip is
  87  * TPM 1.0 or TPM 2.0.
  88  */
  89 #define TIS_TIMEOUT_A_MAX       max(TIS_SHORT_TIMEOUT, TPM2_TIMEOUT_A)
  90 #define TIS_TIMEOUT_B_MAX       max(TIS_LONG_TIMEOUT, TPM2_TIMEOUT_B)
  91 #define TIS_TIMEOUT_C_MAX       max(TIS_SHORT_TIMEOUT, TPM2_TIMEOUT_C)
  92 #define TIS_TIMEOUT_D_MAX       max(TIS_SHORT_TIMEOUT, TPM2_TIMEOUT_D)
  93
  94 #define TPM_ACCESS(l)                   (0x0000 | ((l) << 12))
  95 #define TPM_INT_ENABLE(l)               (0x0008 | ((l) << 12))
  96 #define TPM_INT_VECTOR(l)               (0x000C | ((l) << 12))
  97 #define TPM_INT_STATUS(l)               (0x0010 | ((l) << 12))
  98 #define TPM_INTF_CAPS(l)                (0x0014 | ((l) << 12))
  99 #define TPM_STS(l)                      (0x0018 | ((l) << 12))
 100 #define TPM_STS3(l)                     (0x001b | ((l) << 12))
 101 #define TPM_DATA_FIFO(l)                (0x0024 | ((l) << 12))
 102
 103 #define TPM_DID_VID(l)                  (0x0F00 | ((l) << 12))
 104 #define TPM_RID(l)                      (0x0F04 | ((l) << 12))
 105
 106 struct priv_data {
 107         bool irq_tested;
 108 };
 109
 110 #if defined(CONFIG_PNP) && defined(CONFIG_ACPI)
 111 static int has_hid(struct acpi_device *dev, const char *hid)
 112 {
 113         struct acpi_hardware_id *id;
 114
 115         list_for_each_entry(id, &dev->pnp.ids, list)
 116                 if (!strcmp(hid, id->id))
 117                         return 1;
 118
 119         return 0;
 120 }
 121
 122 static inline int is_itpm(struct acpi_device *dev)
 123 {
 124         return has_hid(dev, "INTC0102");
 125 }
 126 #else
 127 static inline int is_itpm(struct acpi_device *dev)
 128 {
 129         return 0;
 130 }
 131 #endif
 132
 133 /* Before we attempt to access the TPM we must see that the valid bit is set.
 134  * The specification says that this bit is 0 at reset and remains 0 until the
 135  * 'TPM has gone through its self test and initialization and has established
 136  * correct values in the other bits.' */
 137 static int wait_startup(struct tpm_chip *chip, int l)
 138 {
 139         unsigned long stop = jiffies + chip->vendor.timeout_a;
 140         do {
 141                 if (ioread8(chip->vendor.iobase + TPM_ACCESS(l)) &
 142                     TPM_ACCESS_VALID)
 143                         return 0;
 144                 msleep(TPM_TIMEOUT);
 145         } while (time_before(jiffies, stop));
 146         return -1;
 147 }
 148
 149 static int check_locality(struct tpm_chip *chip, int l)
 150 {
 151         if ((ioread8(chip->vendor.iobase + TPM_ACCESS(l)) &
 152              (TPM_ACCESS_ACTIVE_LOCALITY | TPM_ACCESS_VALID)) ==
 153             (TPM_ACCESS_ACTIVE_LOCALITY | TPM_ACCESS_VALID))
 154                 return chip->vendor.locality = l;
 155
 156         return -1;
 157 }
 158
 159 static void release_locality(struct tpm_chip *chip, int l, int force)
 160 {
 161         if (force || (ioread8(chip->vendor.iobase + TPM_ACCESS(l)) &
 162                       (TPM_ACCESS_REQUEST_PENDING | TPM_ACCESS_VALID)) ==
 163             (TPM_ACCESS_REQUEST_PENDING | TPM_ACCESS_VALID))
 164                 iowrite8(TPM_ACCESS_ACTIVE_LOCALITY,
 165                          chip->vendor.iobase + TPM_ACCESS(l));
 166 }
 167
 168 static int request_locality(struct tpm_chip *chip, int l)
 169 {
 170         unsigned long stop, timeout;
 171         long rc;
 172
 173         if (check_locality(chip, l) >= 0)
 174                 return l;
 175
 176         iowrite8(TPM_ACCESS_REQUEST_USE,
 177                  chip->vendor.iobase + TPM_ACCESS(l));
 178
 179         stop = jiffies + chip->vendor.timeout_a;
 180
 181         if (chip->vendor.irq) {
 182 again:
 183                 timeout = stop - jiffies;
 184                 if ((long)timeout <= 0)
 185                         return -1;
 186                 rc = wait_event_interruptible_timeout(chip->vendor.int_queue,
 187                                                       (check_locality
 188                                                        (chip, l) >= 0),
 189                                                       timeout);
 190                 if (rc > 0)
 191                         return l;
 192                 if (rc == -ERESTARTSYS && freezing(current)) {
 193                         clear_thread_flag(TIF_SIGPENDING);
 194                         goto again;
 195                 }
 196         } else {
 197                 /* wait for burstcount */
 198                 do {
 199                         if (check_locality(chip, l) >= 0)
 200                                 return l;
 201                         msleep(TPM_TIMEOUT);
 202                 }
 203                 while (time_before(jiffies, stop));
 204         }
 205         return -1;
 206 }
 207
 208 static u8 tpm_tis_status(struct tpm_chip *chip)
 209 {
 210         return ioread8(chip->vendor.iobase +
 211                        TPM_STS(chip->vendor.locality));
 212 }
 213
 214 static void tpm_tis_ready(struct tpm_chip *chip)
 215 {
 216         /* this causes the current command to be aborted */
 217         iowrite8(TPM_STS_COMMAND_READY,
 218                  chip->vendor.iobase + TPM_STS(chip->vendor.locality));
 219 }
 220
 221 static int get_burstcount(struct tpm_chip *chip)
 222 {
 223         unsigned long stop;
 224         int burstcnt;
 225
 226         /* wait for burstcount */
 227         /* which timeout value, spec has 2 answers (c & d) */
 228         stop = jiffies + chip->vendor.timeout_d;
 229         do {
 230                 burstcnt = ioread8(chip->vendor.iobase +
 231                                    TPM_STS(chip->vendor.locality) + 1);
 232                 burstcnt += ioread8(chip->vendor.iobase +
 233                                     TPM_STS(chip->vendor.locality) +
 234                                     2) << 8;
 235                 if (burstcnt)
 236                         return burstcnt;
 237                 msleep(TPM_TIMEOUT);
 238         } while (time_before(jiffies, stop));
 239         return -EBUSY;
 240 }
 241
 242 static int recv_data(struct tpm_chip *chip, u8 *buf, size_t count)
 243 {
 244         int size = 0, burstcnt;
 245         while (size < count &&
 246                wait_for_tpm_stat(chip,
 247                                  TPM_STS_DATA_AVAIL | TPM_STS_VALID,
 248                                  chip->vendor.timeout_c,
 249                                  &chip->vendor.read_queue, true)
 250                == 0) {
 251                 burstcnt = get_burstcount(chip);
 252                 for (; burstcnt > 0 && size < count; burstcnt--)
 253                         buf[size++] = ioread8(chip->vendor.iobase +
 254                                               TPM_DATA_FIFO(chip->vendor.
 255                                                             locality));
 256         }
 257         return size;
 258 }
 259
 260 static int tpm_tis_recv(struct tpm_chip *chip, u8 *buf, size_t count)
 261 {
 262         int size = 0;
 263         int expected, status;
 264
 265         if (count < TPM_HEADER_SIZE) {
 266                 size = -EIO;
 267                 goto out;
 268         }
 269
 270         /* read first 10 bytes, including tag, paramsize, and result */
 271         if ((size =
 272              recv_data(chip, buf, TPM_HEADER_SIZE)) < TPM_HEADER_SIZE) {
 273                 dev_err(chip->pdev, "Unable to read header\n");
 274                 goto out;
 275         }
 276
 277         expected = be32_to_cpu(*(__be32 *) (buf + 2));
 278         if (expected > count) {
 279                 size = -EIO;
 280                 goto out;
 281         }
 282
 283         if ((size +=
 284              recv_data(chip, &buf[TPM_HEADER_SIZE],
 285                        expected - TPM_HEADER_SIZE)) < expected) {
 286                 dev_err(chip->pdev, "Unable to read remainder of result\n");
 287                 size = -ETIME;
 288                 goto out;
 289         }
 290
 291         wait_for_tpm_stat(chip, TPM_STS_VALID, chip->vendor.timeout_c,
 292                           &chip->vendor.int_queue, false);
 293         status = tpm_tis_status(chip);
 294         if (status & TPM_STS_DATA_AVAIL) {      /* retry? */
 295                 dev_err(chip->pdev, "Error left over data\n");
 296                 size = -EIO;
 297                 goto out;
 298         }
 299
 300 out:
 301         tpm_tis_ready(chip);
 302         release_locality(chip, chip->vendor.locality, 0);
 303         return size;
 304 }
 305
 306 static bool itpm;
 307 module_param(itpm, bool, 0444);
 308 MODULE_PARM_DESC(itpm, "Force iTPM workarounds (found on some Lenovo laptops)");
 309
 310 /*
 311  * If interrupts are used (signaled by an irq set in the vendor structure)
 312  * tpm.c can skip polling for the data to be available as the interrupt is
 313  * waited for here
 314  */
 315 static int tpm_tis_send_data(struct tpm_chip *chip, u8 *buf, size_t len)
 316 {
 317         int rc, status, burstcnt;
 318         size_t count = 0;
 319
 320         if (request_locality(chip, 0) < 0)
 321                 return -EBUSY;
 322
 323         status = tpm_tis_status(chip);
 324         if ((status & TPM_STS_COMMAND_READY) == 0) {
 325                 tpm_tis_ready(chip);
 326                 if (wait_for_tpm_stat
 327                     (chip, TPM_STS_COMMAND_READY, chip->vendor.timeout_b,
 328                      &chip->vendor.int_queue, false) < 0) {
 329                         rc = -ETIME;
 330                         goto out_err;
 331                 }
 332         }
 333
 334         while (count < len - 1) {
 335                 burstcnt = get_burstcount(chip);
 336                 for (; burstcnt > 0 && count < len - 1; burstcnt--) {
 337                         iowrite8(buf[count], chip->vendor.iobase +
 338                                  TPM_DATA_FIFO(chip->vendor.locality));
 339                         count++;
 340                 }
 341
 342                 wait_for_tpm_stat(chip, TPM_STS_VALID, chip->vendor.timeout_c,
 343                                   &chip->vendor.int_queue, false);
 344                 status = tpm_tis_status(chip);
 345                 if (!itpm && (status & TPM_STS_DATA_EXPECT) == 0) {
 346                         rc = -EIO;
 347                         goto out_err;
 348                 }
 349         }
 350
 351         /* write last byte */
 352         iowrite8(buf[count],
 353                  chip->vendor.iobase + TPM_DATA_FIFO(chip->vendor.locality));
 354         wait_for_tpm_stat(chip, TPM_STS_VALID, chip->vendor.timeout_c,
 355                           &chip->vendor.int_queue, false);
 356         status = tpm_tis_status(chip);
 357         if ((status & TPM_STS_DATA_EXPECT) != 0) {
 358                 rc = -EIO;
 359                 goto out_err;
 360         }
 361
 362         return 0;
 363
 364 out_err:
 365         tpm_tis_ready(chip);
 366         release_locality(chip, chip->vendor.locality, 0);
 367         return rc;
 368 }
 369
 370 static void disable_interrupts(struct tpm_chip *chip)
 371 {
 372         u32 intmask;
 373
 374         intmask =
 375             ioread32(chip->vendor.iobase +
 376                      TPM_INT_ENABLE(chip->vendor.locality));
 377         intmask &= ~TPM_GLOBAL_INT_ENABLE;
 378         iowrite32(intmask,
 379                   chip->vendor.iobase +
 380                   TPM_INT_ENABLE(chip->vendor.locality));
 381         devm_free_irq(chip->pdev, chip->vendor.irq, chip);
 382         chip->vendor.irq = 0;
 383 }
 384
 385 /*
 386  * If interrupts are used (signaled by an irq set in the vendor structure)
 387  * tpm.c can skip polling for the data to be available as the interrupt is
 388  * waited for here
 389  */
 390 static int tpm_tis_send_main(struct tpm_chip *chip, u8 *buf, size_t len)
 391 {
 392         int rc;
 393         u32 ordinal;
 394         unsigned long dur;
 395
 396         rc = tpm_tis_send_data(chip, buf, len);
 397         if (rc < 0)
 398                 return rc;
 399
 400         /* go and do it */
 401         iowrite8(TPM_STS_GO,
 402                  chip->vendor.iobase + TPM_STS(chip->vendor.locality));
 403
 404         if (chip->vendor.irq) {
 405                 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
 406
 407                 if (chip->flags & TPM_CHIP_FLAG_TPM2)
 408                         dur = tpm2_calc_ordinal_duration(chip, ordinal);
 409                 else
 410                         dur = tpm_calc_ordinal_duration(chip, ordinal);
 411
 412                 if (wait_for_tpm_stat
 413                     (chip, TPM_STS_DATA_AVAIL | TPM_STS_VALID, dur,
 414                      &chip->vendor.read_queue, false) < 0) {
 415                         rc = -ETIME;
 416                         goto out_err;
 417                 }
 418         }
 419         return len;
 420 out_err:
 421         tpm_tis_ready(chip);
 422         release_locality(chip, chip->vendor.locality, 0);
 423         return rc;
 424 }
 425
 426 static int tpm_tis_send(struct tpm_chip *chip, u8 *buf, size_t len)
 427 {
 428         int rc, irq;
 429         struct priv_data *priv = chip->vendor.priv;
 430
 431         if (!chip->vendor.irq || priv->irq_tested)
 432                 return tpm_tis_send_main(chip, buf, len);
 433
 434         /* Verify receipt of the expected IRQ */
 435         irq = chip->vendor.irq;
 436         chip->vendor.irq = 0;
 437         rc = tpm_tis_send_main(chip, buf, len);
 438         chip->vendor.irq = irq;
 439         if (!priv->irq_tested)
 440                 msleep(1);
 441         if (!priv->irq_tested)
 442                 disable_interrupts(chip);
 443         priv->irq_tested = true;
 444         return rc;
 445 }
 446
 447 struct tis_vendor_timeout_override {
 448         u32 did_vid;
 449         unsigned long timeout_us[4];
 450 };
 451
 452 static const struct tis_vendor_timeout_override vendor_timeout_overrides[] = {
 453         /* Atmel 3204 */
 454         { 0x32041114, { (TIS_SHORT_TIMEOUT*1000), (TIS_LONG_TIMEOUT*1000),
 455                         (TIS_SHORT_TIMEOUT*1000), (TIS_SHORT_TIMEOUT*1000) } },
 456 };
 457
 458 static bool tpm_tis_update_timeouts(struct tpm_chip *chip,
 459                                     unsigned long *timeout_cap)
 460 {
 461         int i;
 462         u32 did_vid;
 463
 464         did_vid = ioread32(chip->vendor.iobase + TPM_DID_VID(0));
 465
 466         for (i = 0; i != ARRAY_SIZE(vendor_timeout_overrides); i++) {
 467                 if (vendor_timeout_overrides[i].did_vid != did_vid)
 468                         continue;
 469                 memcpy(timeout_cap, vendor_timeout_overrides[i].timeout_us,
 470                        sizeof(vendor_timeout_overrides[i].timeout_us));
 471                 return true;
 472         }
 473
 474         return false;
 475 }
 476
 477 /*
 478  * Early probing for iTPM with STS_DATA_EXPECT flaw.
 479  * Try sending command without itpm flag set and if that
 480  * fails, repeat with itpm flag set.
 481  */
 482 static int probe_itpm(struct tpm_chip *chip)
 483 {
 484         int rc = 0;
 485         u8 cmd_getticks[] = {
 486                 0x00, 0xc1, 0x00, 0x00, 0x00, 0x0a,
 487                 0x00, 0x00, 0x00, 0xf1
 488         };
 489         size_t len = sizeof(cmd_getticks);
 490         bool rem_itpm = itpm;
 491         u16 vendor = ioread16(chip->vendor.iobase + TPM_DID_VID(0));
 492
 493         /* probe only iTPMS */
 494         if (vendor != TPM_VID_INTEL)
 495                 return 0;
 496
 497         itpm = false;
 498
 499         rc = tpm_tis_send_data(chip, cmd_getticks, len);
 500         if (rc == 0)
 501                 goto out;
 502
 503         tpm_tis_ready(chip);
 504         release_locality(chip, chip->vendor.locality, 0);
 505
 506         itpm = true;
 507
 508         rc = tpm_tis_send_data(chip, cmd_getticks, len);
 509         if (rc == 0) {
 510                 dev_info(chip->pdev, "Detected an iTPM.\n");
 511                 rc = 1;
 512         } else
 513                 rc = -EFAULT;
 514
 515 out:
 516         itpm = rem_itpm;
 517         tpm_tis_ready(chip);
 518         release_locality(chip, chip->vendor.locality, 0);
 519
 520         return rc;
 521 }
 522
 523 static bool tpm_tis_req_canceled(struct tpm_chip *chip, u8 status)
 524 {
 525         switch (chip->vendor.manufacturer_id) {
 526         case TPM_VID_WINBOND:
 527                 return ((status == TPM_STS_VALID) ||
 528                         (status == (TPM_STS_VALID | TPM_STS_COMMAND_READY)));
 529         case TPM_VID_STM:
 530                 return (status == (TPM_STS_VALID | TPM_STS_COMMAND_READY));
 531         default:
 532                 return (status == TPM_STS_COMMAND_READY);
 533         }
 534 }
 535
 536 static const struct tpm_class_ops tpm_tis = {
 537         .status = tpm_tis_status,
 538         .recv = tpm_tis_recv,
 539         .send = tpm_tis_send,
 540         .cancel = tpm_tis_ready,
 541         .update_timeouts = tpm_tis_update_timeouts,
 542         .req_complete_mask = TPM_STS_DATA_AVAIL | TPM_STS_VALID,
 543         .req_complete_val = TPM_STS_DATA_AVAIL | TPM_STS_VALID,
 544         .req_canceled = tpm_tis_req_canceled,
 545 };
 546
 547 static irqreturn_t tis_int_handler(int dummy, void *dev_id)
 548 {
 549         struct tpm_chip *chip = dev_id;
 550         u32 interrupt;
 551         int i;
 552
 553         interrupt = ioread32(chip->vendor.iobase +
 554                              TPM_INT_STATUS(chip->vendor.locality));
 555
 556         if (interrupt == 0)
 557                 return IRQ_NONE;
 558
 559         ((struct priv_data *)chip->vendor.priv)->irq_tested = true;
 560         if (interrupt & TPM_INTF_DATA_AVAIL_INT)
 561                 wake_up_interruptible(&chip->vendor.read_queue);
 562         if (interrupt & TPM_INTF_LOCALITY_CHANGE_INT)
 563                 for (i = 0; i < 5; i++)
 564                         if (check_locality(chip, i) >= 0)
 565                                 break;
 566         if (interrupt &
 567             (TPM_INTF_LOCALITY_CHANGE_INT | TPM_INTF_STS_VALID_INT |
 568              TPM_INTF_CMD_READY_INT))
 569                 wake_up_interruptible(&chip->vendor.int_queue);
 570
 571         /* Clear interrupts handled with TPM_EOI */
 572         iowrite32(interrupt,
 573                   chip->vendor.iobase +
 574                   TPM_INT_STATUS(chip->vendor.locality));
 575         ioread32(chip->vendor.iobase + TPM_INT_STATUS(chip->vendor.locality));
 576         return IRQ_HANDLED;
 577 }
 578
 579 /* Register the IRQ and issue a command that will cause an interrupt. If an
 580  * irq is seen then leave the chip setup for IRQ operation, otherwise reverse
 581  * everything and leave in polling mode. Returns 0 on success.
 582  */
 583 static int tpm_tis_probe_irq_single(struct tpm_chip *chip, u32 intmask,
 584                                     int flags, int irq)
 585 {
 586         struct priv_data *priv = chip->vendor.priv;
 587         u8 original_int_vec;
 588
 589         if (devm_request_irq(chip->pdev, irq, tis_int_handler, flags,
 590                              chip->devname, chip) != 0) {
 591                 dev_info(chip->pdev, "Unable to request irq: %d for probe\n",
 592                          irq);
 593                 return -1;
 594         }
 595         chip->vendor.irq = irq;
 596
 597         original_int_vec = ioread8(chip->vendor.iobase +
 598                                    TPM_INT_VECTOR(chip->vendor.locality));
 599         iowrite8(irq,
 600                  chip->vendor.iobase + TPM_INT_VECTOR(chip->vendor.locality));
 601
 602         /* Clear all existing */
 603         iowrite32(ioread32(chip->vendor.iobase +
 604                            TPM_INT_STATUS(chip->vendor.locality)),
 605                   chip->vendor.iobase + TPM_INT_STATUS(chip->vendor.locality));
 606
 607         /* Turn on */
 608         iowrite32(intmask | TPM_GLOBAL_INT_ENABLE,
 609                   chip->vendor.iobase + TPM_INT_ENABLE(chip->vendor.locality));
 610
 611         priv->irq_tested = false;
 612
 613         /* Generate an interrupt by having the core call through to
 614          * tpm_tis_send
 615          */
 616         if (chip->flags & TPM_CHIP_FLAG_TPM2)
 617                 tpm2_gen_interrupt(chip);
 618         else
 619                 tpm_gen_interrupt(chip);
 620
 621         /* tpm_tis_send will either confirm the interrupt is working or it
 622          * will call disable_irq which undoes all of the above.
 623          */
 624         if (!chip->vendor.irq) {
 625                 iowrite8(original_int_vec,
 626                          chip->vendor.iobase +
 627                              TPM_INT_VECTOR(chip->vendor.locality));
 628                 return 1;
 629         }
 630
 631         return 0;
 632 }
 633
 634 /* Try to find the IRQ the TPM is using. This is for legacy x86 systems that
 635  * do not have ACPI/etc. We typically expect the interrupt to be declared if
 636  * present.
 637  */
 638 static void tpm_tis_probe_irq(struct tpm_chip *chip, u32 intmask)
 639 {
 640         u8 original_int_vec;
 641         int i;
 642
 643         original_int_vec = ioread8(chip->vendor.iobase +
 644                                    TPM_INT_VECTOR(chip->vendor.locality));
 645
 646         if (!original_int_vec) {
 647                 if (IS_ENABLED(CONFIG_X86))
 648                         for (i = 3; i <= 15; i++)
 649                                 if (!tpm_tis_probe_irq_single(chip, intmask, 0,
 650                                                               i))
 651                                         return;
 652         } else if (!tpm_tis_probe_irq_single(chip, intmask, 0,
 653                                              original_int_vec))
 654                 return;
 655 }
 656
 657 static bool interrupts = true;
 658 module_param(interrupts, bool, 0444);
 659 MODULE_PARM_DESC(interrupts, "Enable interrupts");
 660
 661 static void tpm_tis_remove(struct tpm_chip *chip)
 662 {
 663         if (chip->flags & TPM_CHIP_FLAG_TPM2)
 664                 tpm2_shutdown(chip, TPM2_SU_CLEAR);
 665
 666         iowrite32(~TPM_GLOBAL_INT_ENABLE &
 667                   ioread32(chip->vendor.iobase +
 668                            TPM_INT_ENABLE(chip->vendor.
 669                                           locality)),
 670                   chip->vendor.iobase +
 671                   TPM_INT_ENABLE(chip->vendor.locality));
 672         release_locality(chip, chip->vendor.locality, 1);
 673 }
 674
 675 static int tpm_tis_init(struct device *dev, struct tpm_info *tpm_info,
 676                         acpi_handle acpi_dev_handle)
 677 {
 678         u32 vendor, intfcaps, intmask;
 679         int rc, probe;
 680         struct tpm_chip *chip;
 681         struct priv_data *priv;
 682
 683         priv = devm_kzalloc(dev, sizeof(struct priv_data), GFP_KERNEL);
 684         if (priv == NULL)
 685                 return -ENOMEM;
 686
 687         chip = tpmm_chip_alloc(dev, &tpm_tis);
 688         if (IS_ERR(chip))
 689                 return PTR_ERR(chip);
 690
 691         chip->vendor.priv = priv;
 692 #ifdef CONFIG_ACPI
 693         chip->acpi_dev_handle = acpi_dev_handle;
 694 #endif
 695
 696         chip->vendor.iobase = devm_ioremap_resource(dev, &tpm_info->res);
 697         if (IS_ERR(chip->vendor.iobase))
 698                 return PTR_ERR(chip->vendor.iobase);
 699
 700         /* Maximum timeouts */
 701         chip->vendor.timeout_a = TIS_TIMEOUT_A_MAX;
 702         chip->vendor.timeout_b = TIS_TIMEOUT_B_MAX;
 703         chip->vendor.timeout_c = TIS_TIMEOUT_C_MAX;
 704         chip->vendor.timeout_d = TIS_TIMEOUT_D_MAX;
 705
 706         if (wait_startup(chip, 0) != 0) {
 707                 rc = -ENODEV;
 708                 goto out_err;
 709         }
 710
 711         /* Take control of the TPM's interrupt hardware and shut it off */
 712         intmask = ioread32(chip->vendor.iobase +
 713                            TPM_INT_ENABLE(chip->vendor.locality));
 714         intmask |= TPM_INTF_CMD_READY_INT | TPM_INTF_LOCALITY_CHANGE_INT |
 715                    TPM_INTF_DATA_AVAIL_INT | TPM_INTF_STS_VALID_INT;
 716         intmask &= ~TPM_GLOBAL_INT_ENABLE;
 717         iowrite32(intmask,
 718                   chip->vendor.iobase + TPM_INT_ENABLE(chip->vendor.locality));
 719
 720         if (request_locality(chip, 0) != 0) {
 721                 rc = -ENODEV;
 722                 goto out_err;
 723         }
 724
 725         rc = tpm2_probe(chip);
 726         if (rc)
 727                 goto out_err;
 728
 729         vendor = ioread32(chip->vendor.iobase + TPM_DID_VID(0));
 730         chip->vendor.manufacturer_id = vendor;
 731
 732         dev_info(dev, "%s TPM (device-id 0x%X, rev-id %d)\n",
 733                  (chip->flags & TPM_CHIP_FLAG_TPM2) ? "2.0" : "1.2",
 734                  vendor >> 16, ioread8(chip->vendor.iobase + TPM_RID(0)));
 735
 736         if (!itpm) {
 737                 probe = probe_itpm(chip);
 738                 if (probe < 0) {
 739                         rc = -ENODEV;
 740                         goto out_err;
 741                 }
 742                 itpm = !!probe;
 743         }
 744
 745         if (itpm)
 746                 dev_info(dev, "Intel iTPM workaround enabled\n");
 747
 748
 749         /* Figure out the capabilities */
 750         intfcaps =
 751             ioread32(chip->vendor.iobase +
 752                      TPM_INTF_CAPS(chip->vendor.locality));
 753         dev_dbg(dev, "TPM interface capabilities (0x%x):\n",
 754                 intfcaps);
 755         if (intfcaps & TPM_INTF_BURST_COUNT_STATIC)
 756                 dev_dbg(dev, "\tBurst Count Static\n");
 757         if (intfcaps & TPM_INTF_CMD_READY_INT)
 758                 dev_dbg(dev, "\tCommand Ready Int Support\n");
 759         if (intfcaps & TPM_INTF_INT_EDGE_FALLING)
 760                 dev_dbg(dev, "\tInterrupt Edge Falling\n");
 761         if (intfcaps & TPM_INTF_INT_EDGE_RISING)
 762                 dev_dbg(dev, "\tInterrupt Edge Rising\n");
 763         if (intfcaps & TPM_INTF_INT_LEVEL_LOW)
 764                 dev_dbg(dev, "\tInterrupt Level Low\n");
 765         if (intfcaps & TPM_INTF_INT_LEVEL_HIGH)
 766                 dev_dbg(dev, "\tInterrupt Level High\n");
 767         if (intfcaps & TPM_INTF_LOCALITY_CHANGE_INT)
 768                 dev_dbg(dev, "\tLocality Change Int Support\n");
 769         if (intfcaps & TPM_INTF_STS_VALID_INT)
 770                 dev_dbg(dev, "\tSts Valid Int Support\n");
 771         if (intfcaps & TPM_INTF_DATA_AVAIL_INT)
 772                 dev_dbg(dev, "\tData Avail Int Support\n");
 773
 774         /* Very early on issue a command to the TPM in polling mode to make
 775          * sure it works. May as well use that command to set the proper
 776          *  timeouts for the driver.
 777          */
 778         if (tpm_get_timeouts(chip)) {
 779                 dev_err(dev, "Could not get TPM timeouts and durations\n");
 780                 rc = -ENODEV;
 781                 goto out_err;
 782         }
 783
 784         /* INTERRUPT Setup */
 785         init_waitqueue_head(&chip->vendor.read_queue);
 786         init_waitqueue_head(&chip->vendor.int_queue);
 787         if (interrupts && tpm_info->irq != -1) {
 788                 if (tpm_info->irq) {
 789                         tpm_tis_probe_irq_single(chip, intmask, IRQF_SHARED,
 790                                                  tpm_info->irq);
 791                         if (!chip->vendor.irq)
 792                                 dev_err(chip->pdev, FW_BUG
 793                                         "TPM interrupt not working, polling instead\n");
 794                 } else
 795                         tpm_tis_probe_irq(chip, intmask);
 796         }
 797
 798         if (chip->flags & TPM_CHIP_FLAG_TPM2) {
 799                 rc = tpm2_do_selftest(chip);
 800                 if (rc == TPM2_RC_INITIALIZE) {
 801                         dev_warn(dev, "Firmware has not started TPM\n");
 802                         rc  = tpm2_startup(chip, TPM2_SU_CLEAR);
 803                         if (!rc)
 804                                 rc = tpm2_do_selftest(chip);
 805                 }
 806
 807                 if (rc) {
 808                         dev_err(dev, "TPM self test failed\n");
 809                         if (rc > 0)
 810                                 rc = -ENODEV;
 811                         goto out_err;
 812                 }
 813         } else {
 814                 if (tpm_do_selftest(chip)) {
 815                         dev_err(dev, "TPM self test failed\n");
 816                         rc = -ENODEV;
 817                         goto out_err;
 818                 }
 819         }
 820
 821         return tpm_chip_register(chip);
 822 out_err:
 823         tpm_tis_remove(chip);
 824         return rc;
 825 }
 826
 827 #ifdef CONFIG_PM_SLEEP
 828 static void tpm_tis_reenable_interrupts(struct tpm_chip *chip)
 829 {
 830         u32 intmask;
 831
 832         /* reenable interrupts that device may have lost or
 833            BIOS/firmware may have disabled */
 834         iowrite8(chip->vendor.irq, chip->vendor.iobase +
 835                  TPM_INT_VECTOR(chip->vendor.locality));
 836
 837         intmask =
 838             ioread32(chip->vendor.iobase +
 839                      TPM_INT_ENABLE(chip->vendor.locality));
 840
 841         intmask |= TPM_INTF_CMD_READY_INT
 842             | TPM_INTF_LOCALITY_CHANGE_INT | TPM_INTF_DATA_AVAIL_INT
 843             | TPM_INTF_STS_VALID_INT | TPM_GLOBAL_INT_ENABLE;
 844
 845         iowrite32(intmask,
 846                   chip->vendor.iobase + TPM_INT_ENABLE(chip->vendor.locality));
 847 }
 848
 849 static int tpm_tis_resume(struct device *dev)
 850 {
 851         struct tpm_chip *chip = dev_get_drvdata(dev);
 852         int ret;
 853
 854         if (chip->vendor.irq)
 855                 tpm_tis_reenable_interrupts(chip);
 856
 857         ret = tpm_pm_resume(dev);
 858         if (ret)
 859                 return ret;
 860
 861         /* TPM 1.2 requires self-test on resume. This function actually returns
 862          * an error code but for unknown reason it isn't handled.
 863          */
 864         if (!(chip->flags & TPM_CHIP_FLAG_TPM2))
 865                 tpm_do_selftest(chip);
 866
 867         return 0;
 868 }
 869 #endif
 870
 871 static SIMPLE_DEV_PM_OPS(tpm_tis_pm, tpm_pm_suspend, tpm_tis_resume);
 872
 873 #ifdef CONFIG_PNP
 874 static int tpm_tis_pnp_init(struct pnp_dev *pnp_dev,
 875                             const struct pnp_device_id *pnp_id)
 876 {
 877         struct tpm_info tpm_info = {};
 878         acpi_handle acpi_dev_handle = NULL;
 879         struct resource *res;
 880
 881         res = pnp_get_resource(pnp_dev, IORESOURCE_MEM, 0);
 882         if (!res)
 883                 return -ENODEV;
 884         tpm_info.res = *res;
 885
 886         if (pnp_irq_valid(pnp_dev, 0))
 887                 tpm_info.irq = pnp_irq(pnp_dev, 0);
 888         else
 889                 tpm_info.irq = -1;
 890
 891 #ifdef CONFIG_ACPI
 892         if (pnp_acpi_device(pnp_dev)) {
 893                 if (is_itpm(pnp_acpi_device(pnp_dev)))
 894                         itpm = true;
 895
 896                 acpi_dev_handle = pnp_acpi_device(pnp_dev)->handle;
 897         }
 898 #endif
 899
 900         return tpm_tis_init(&pnp_dev->dev, &tpm_info, acpi_dev_handle);
 901 }
 902
 903 static struct pnp_device_id tpm_pnp_tbl[] = {
 904         {"PNP0C31", 0},         /* TPM */
 905         {"ATM1200", 0},         /* Atmel */
 906         {"IFX0102", 0},         /* Infineon */
 907         {"BCM0101", 0},         /* Broadcom */
 908         {"BCM0102", 0},         /* Broadcom */
 909         {"NSC1200", 0},         /* National */
 910         {"ICO0102", 0},         /* Intel */
 911         /* Add new here */
 912         {"", 0},                /* User Specified */
 913         {"", 0}                 /* Terminator */
 914 };
 915 MODULE_DEVICE_TABLE(pnp, tpm_pnp_tbl);
 916
 917 static void tpm_tis_pnp_remove(struct pnp_dev *dev)
 918 {
 919         struct tpm_chip *chip = pnp_get_drvdata(dev);
 920
 921         tpm_chip_unregister(chip);
 922         tpm_tis_remove(chip);
 923 }
 924
 925 static struct pnp_driver tis_pnp_driver = {
 926         .name = "tpm_tis",
 927         .id_table = tpm_pnp_tbl,
 928         .probe = tpm_tis_pnp_init,
 929         .remove = tpm_tis_pnp_remove,
 930         .driver = {
 931                 .pm = &tpm_tis_pm,
 932         },
 933 };
 934
 935 #define TIS_HID_USR_IDX sizeof(tpm_pnp_tbl)/sizeof(struct pnp_device_id) -2
 936 module_param_string(hid, tpm_pnp_tbl[TIS_HID_USR_IDX].id,
 937                     sizeof(tpm_pnp_tbl[TIS_HID_USR_IDX].id), 0444);
 938 MODULE_PARM_DESC(hid, "Set additional specific HID for this driver to probe");
 939 #endif
 940
 941 #ifdef CONFIG_ACPI
 942 static int tpm_check_resource(struct acpi_resource *ares, void *data)
 943 {
 944         struct tpm_info *tpm_info = (struct tpm_info *) data;
 945         struct resource res;
 946
 947         if (acpi_dev_resource_interrupt(ares, 0, &res))
 948                 tpm_info->irq = res.start;
 949         else if (acpi_dev_resource_memory(ares, &res))
 950                 tpm_info->res = res;
 951
 952         return 1;
 953 }
 954
 955 static int tpm_tis_acpi_init(struct acpi_device *acpi_dev)
 956 {
 957         struct acpi_table_tpm2 *tbl;
 958         acpi_status st;
 959         struct list_head resources;
 960         struct tpm_info tpm_info = {};
 961         int ret;
 962
 963         st = acpi_get_table(ACPI_SIG_TPM2, 1,
 964                             (struct acpi_table_header **) &tbl);
 965         if (ACPI_FAILURE(st) || tbl->header.length < sizeof(*tbl)) {
 966                 dev_err(&acpi_dev->dev,
 967                         FW_BUG "failed to get TPM2 ACPI table\n");
 968                 return -EINVAL;
 969         }
 970
 971         if (tbl->start_method != ACPI_TPM2_MEMORY_MAPPED)
 972                 return -ENODEV;
 973
 974         INIT_LIST_HEAD(&resources);
 975         tpm_info.irq = -1;
 976         ret = acpi_dev_get_resources(acpi_dev, &resources, tpm_check_resource,
 977                                      &tpm_info);
 978         if (ret < 0)
 979                 return ret;
 980
 981         acpi_dev_free_resource_list(&resources);
 982
 983         if (resource_type(&tpm_info.res) != IORESOURCE_MEM) {
 984                 dev_err(&acpi_dev->dev,
 985                         FW_BUG "TPM2 ACPI table does not define a memory resource\n");
 986                 return -EINVAL;
 987         }
 988
 989         if (is_itpm(acpi_dev))
 990                 itpm = true;
 991
 992         return tpm_tis_init(&acpi_dev->dev, &tpm_info, acpi_dev->handle);
 993 }
 994
 995 static int tpm_tis_acpi_remove(struct acpi_device *dev)
 996 {
 997         struct tpm_chip *chip = dev_get_drvdata(&dev->dev);
 998
 999         tpm_chip_unregister(chip);
1000         tpm_tis_remove(chip);
1001
1002         return 0;
1003 }
1004
1005 static struct acpi_device_id tpm_acpi_tbl[] = {
1006         {"MSFT0101", 0},        /* TPM 2.0 */
1007         /* Add new here */
1008         {"", 0},                /* User Specified */
1009         {"", 0}                 /* Terminator */
1010 };
1011 MODULE_DEVICE_TABLE(acpi, tpm_acpi_tbl);
1012
1013 static struct acpi_driver tis_acpi_driver = {
1014         .name = "tpm_tis",
1015         .ids = tpm_acpi_tbl,
1016         .ops = {
1017                 .add = tpm_tis_acpi_init,
1018                 .remove = tpm_tis_acpi_remove,
1019         },
1020         .drv = {
1021                 .pm = &tpm_tis_pm,
1022         },
1023 };
1024 #endif
1025
1026 static struct platform_driver tis_drv = {
1027         .driver = {
1028                 .name           = "tpm_tis",
1029                 .pm             = &tpm_tis_pm,
1030         },
1031 };
1032
1033 static struct platform_device *pdev;
1034
1035 static bool force;
1036 module_param(force, bool, 0444);
1037 MODULE_PARM_DESC(force, "Force device probe rather than using ACPI entry");
1038 static int __init init_tis(void)
1039 {
1040         int rc;
1041 #ifdef CONFIG_PNP
1042         if (!force) {
1043                 rc = pnp_register_driver(&tis_pnp_driver);
1044                 if (rc)
1045                         return rc;
1046         }
1047 #endif
1048 #ifdef CONFIG_ACPI
1049         if (!force) {
1050                 rc = acpi_bus_register_driver(&tis_acpi_driver);
1051                 if (rc) {
1052 #ifdef CONFIG_PNP
1053                         pnp_unregister_driver(&tis_pnp_driver);
1054 #endif
1055                         return rc;
1056                 }
1057         }
1058 #endif
1059         if (!force)
1060                 return 0;
1061
1062         rc = platform_driver_register(&tis_drv);
1063         if (rc < 0)
1064                 return rc;
1065         pdev = platform_device_register_simple("tpm_tis", -1, NULL, 0);
1066         if (IS_ERR(pdev)) {
1067                 rc = PTR_ERR(pdev);
1068                 goto err_dev;
1069         }
1070         rc = tpm_tis_init(&pdev->dev, &tis_default_info, NULL);
1071         if (rc)
1072                 goto err_init;
1073         return 0;
1074 err_init:
1075         platform_device_unregister(pdev);
1076 err_dev:
1077         platform_driver_unregister(&tis_drv);
1078         return rc;
1079 }
1080
1081 static void __exit cleanup_tis(void)
1082 {
1083         struct tpm_chip *chip;
1084 #if defined(CONFIG_PNP) || defined(CONFIG_ACPI)
1085         if (!force) {
1086 #ifdef CONFIG_ACPI
1087                 acpi_bus_unregister_driver(&tis_acpi_driver);
1088 #endif
1089 #ifdef CONFIG_PNP
1090                 pnp_unregister_driver(&tis_pnp_driver);
1091 #endif
1092                 return;
1093         }
1094 #endif
1095         chip = dev_get_drvdata(&pdev->dev);
1096         tpm_chip_unregister(chip);
1097         tpm_tis_remove(chip);
1098         platform_device_unregister(pdev);
1099         platform_driver_unregister(&tis_drv);
1100 }
1101
1102 module_init(init_tis);
1103 module_exit(cleanup_tis);
1104 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1105 MODULE_DESCRIPTION("TPM Driver");
1106 MODULE_VERSION("2.0");
1107 MODULE_LICENSE("GPL");