sys/dev/tpm/tpm_tis.c

   1 /*-
   2  * Copyright (c) 2018 Stormshield.
   3  * Copyright (c) 2018 Semihalf.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  19  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  23  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  24  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25  * POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 __FBSDID("$FreeBSD$");
  30
  31 #include "tpm20.h"
  32
  33 /*
  34  * TIS register space as defined in
  35  * TCG_PC_Client_Platform_TPM_Profile_PTP_2.0_r1.03_v22
  36  */
  37 #define TPM_ACCESS                      0x0
  38 #define TPM_INT_ENABLE          0x8
  39 #define TPM_INT_VECTOR          0xc
  40 #define TPM_INT_STS                     0x10
  41 #define TPM_INTF_CAPS           0x14
  42 #define TPM_STS                         0x18
  43 #define TPM_DATA_FIFO           0x24
  44 #define TPM_INTF_ID                     0x30
  45 #define TPM_XDATA_FIFO          0x80
  46 #define TPM_DID_VID                     0xF00
  47 #define TPM_RID                         0xF04
  48
  49 #define TPM_ACCESS_LOC_REQ                      BIT(1)
  50 #define TPM_ACCESS_LOC_Seize            BIT(3)
  51 #define TPM_ACCESS_LOC_ACTIVE           BIT(5)
  52 #define TPM_ACCESS_LOC_RELINQUISH       BIT(5)
  53 #define TPM_ACCESS_VALID                        BIT(7)
  54
  55 #define TPM_INT_ENABLE_GLOBAL_ENABLE    BIT(31)
  56 #define TPM_INT_ENABLE_CMD_RDY                  BIT(7)
  57 #define TPM_INT_ENABLE_LOC_CHANGE               BIT(2)
  58 #define TPM_INT_ENABLE_STS_VALID                BIT(1)
  59 #define TPM_INT_ENABLE_DATA_AVAIL               BIT(0)
  60
  61 #define TPM_INT_STS_CMD_RDY             BIT(7)
  62 #define TPM_INT_STS_LOC_CHANGE  BIT(2)
  63 #define TPM_INT_STS_VALID               BIT(1)
  64 #define TPM_INT_STS_DATA_AVAIL  BIT(0)
  65
  66 #define TPM_INTF_CAPS_VERSION   0x70000000
  67 #define TPM_INTF_CAPS_TPM20             0x30000000
  68
  69 #define TPM_STS_VALID                   BIT(7)
  70 #define TPM_STS_CMD_RDY                 BIT(6)
  71 #define TPM_STS_CMD_START               BIT(5)
  72 #define TPM_STS_DATA_AVAIL              BIT(4)
  73 #define TPM_STS_DATA_EXPECTED   BIT(3)
  74 #define TPM_STS_BURST_MASK              0xFFFF00
  75 #define TPM_STS_BURST_OFFSET    0x8
  76
  77 static int tpmtis_transmit(struct tpm_sc *sc, size_t length);
  78
  79 static int tpmtis_acpi_probe(device_t dev);
  80 static int tpmtis_attach(device_t dev);
  81 static int tpmtis_detach(device_t dev);
  82
  83 static void tpmtis_intr_handler(void *arg);
  84
  85 static ACPI_STATUS tpmtis_get_SIRQ_channel(ACPI_RESOURCE *res, void *arg);
  86 static bool tpmtis_setup_intr(struct tpm_sc *sc);
  87
  88 static bool tpmtis_read_bytes(struct tpm_sc *sc, size_t count, uint8_t *buf);
  89 static bool tpmtis_write_bytes(struct tpm_sc *sc, size_t count, uint8_t *buf);
  90 static bool tpmtis_request_locality(struct tpm_sc *sc, int locality);
  91 static void tpmtis_relinquish_locality(struct tpm_sc *sc);
  92 static bool tpmtis_go_ready(struct tpm_sc *sc);
  93
  94 static bool tpm_wait_for_u32(struct tpm_sc *sc, bus_size_t off,
  95     uint32_t mask, uint32_t val, int32_t timeout);
  96 static uint16_t tpmtis_wait_for_burst(struct tpm_sc *sc);
  97
  98 char *tpmtis_ids[] = {"MSFT0101", NULL};
  99
 100 static int
 101 tpmtis_acpi_probe(device_t dev)
 102 {
 103         int err = 0;
 104         ACPI_TABLE_TPM2 *tbl;
 105         ACPI_STATUS status;
 106
 107         if (ACPI_ID_PROBE(device_get_parent(dev), dev, tpmtis_ids) == NULL)
 108                 return (ENXIO);
 109
 110         /*Find TPM2 Header*/
 111         status = AcpiGetTable(ACPI_SIG_TPM2, 1, (ACPI_TABLE_HEADER **) &tbl);
 112         if(ACPI_FAILURE(status) ||
 113            tbl->StartMethod != TPM2_START_METHOD_TIS)
 114             err = ENXIO;
 115
 116         device_set_desc(dev, "Trusted Platform Module 2.0, FIFO mode");
 117         return (err);
 118 }
 119
 120 static int
 121 tpmtis_attach(device_t dev)
 122 {
 123         struct tpm_sc *sc;
 124         int result;
 125
 126         sc = device_get_softc(dev);
 127         sc->dev = dev;
 128
 129         sc->mem_rid = 0;
 130         sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->mem_rid,
 131                     RF_ACTIVE);
 132         if (sc->mem_res == NULL)
 133                 return (ENXIO);
 134
 135         sc->irq_rid = 0;
 136         sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->irq_rid,
 137                     RF_ACTIVE | RF_SHAREABLE);
 138         if (sc->irq_res != NULL) {
 139                 if (bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
 140                     NULL, tpmtis_intr_handler, sc, &sc->intr_cookie))
 141                         sc->interrupts = false;
 142                 else
 143                         sc->interrupts = tpmtis_setup_intr(sc);
 144         } else {
 145                 sc->interrupts = false;
 146         }
 147
 148         sc->intr_type = -1;
 149
 150         sc->transmit = tpmtis_transmit;
 151
 152         result = tpm20_init(sc);
 153         if (result != 0)
 154                 tpmtis_detach(dev);
 155
 156         return (result);
 157 }
 158
 159 static int
 160 tpmtis_detach(device_t dev)
 161 {
 162         struct tpm_sc *sc;
 163
 164         sc = device_get_softc(dev);
 165
 166         if (sc->intr_cookie != NULL)
 167                 bus_teardown_intr(dev, sc->irq_res, sc->intr_cookie);
 168
 169         if (sc->irq_res != NULL)
 170                 bus_release_resource(dev, SYS_RES_IRQ,
 171                     sc->irq_rid, sc->irq_res);
 172
 173         if (sc->mem_res != NULL)
 174                 bus_release_resource(dev, SYS_RES_MEMORY,
 175                     sc->mem_rid, sc->mem_res);
 176
 177         tpm20_release(sc);
 178         return (0);
 179 }
 180
 181 static ACPI_STATUS
 182 tpmtis_get_SIRQ_channel(ACPI_RESOURCE *res, void *arg)
 183 {
 184         struct tpm_sc *sc;
 185         uint8_t channel;
 186
 187         sc = (struct tpm_sc *)arg;
 188
 189         switch (res->Type) {
 190         case ACPI_RESOURCE_TYPE_IRQ:
 191                 channel = res->Data.Irq.Interrupts[0];
 192                 break;
 193         case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
 194                 channel = res->Data.ExtendedIrq.Interrupts[0];
 195                 break;
 196         default:
 197                 return (AE_OK);
 198         }
 199
 200         WR1(sc, TPM_INT_VECTOR, channel);
 201         return (AE_OK);
 202 }
 203
 204 static bool
 205 tpmtis_setup_intr(struct tpm_sc *sc)
 206 {
 207         ACPI_STATUS status;
 208         ACPI_HANDLE handle;
 209         uint32_t irq_mask;
 210
 211         handle = acpi_get_handle(sc->dev);
 212
 213         if(!tpmtis_request_locality(sc, 0))
 214                 return (false);
 215
 216         irq_mask = RD4(sc, TPM_INT_ENABLE);
 217         irq_mask |= TPM_INT_ENABLE_GLOBAL_ENABLE |
 218             TPM_INT_ENABLE_DATA_AVAIL |
 219             TPM_INT_ENABLE_LOC_CHANGE |
 220             TPM_INT_ENABLE_CMD_RDY |
 221             TPM_INT_ENABLE_STS_VALID;
 222         WR4(sc, TPM_INT_ENABLE, irq_mask);
 223
 224         status = AcpiWalkResources(handle, "_CRS",
 225             tpmtis_get_SIRQ_channel, (void *)sc);
 226
 227         tpmtis_relinquish_locality(sc);
 228
 229         return (ACPI_SUCCESS(status));
 230 }
 231
 232 static void
 233 tpmtis_intr_handler(void *arg)
 234 {
 235         struct tpm_sc *sc;
 236         uint32_t status;
 237
 238         sc = (struct tpm_sc *)arg;
 239         status = RD4(sc, TPM_INT_STS);
 240
 241         WR4(sc, TPM_INT_STS, status);
 242         if (sc->intr_type != -1 && sc->intr_type & status)
 243                 wakeup(sc);
 244 }
 245
 246 static bool
 247 tpm_wait_for_u32(struct tpm_sc *sc, bus_size_t off, uint32_t mask, uint32_t val,
 248     int32_t timeout)
 249 {
 250
 251         /* Check for condition */
 252         if ((RD4(sc, off) & mask) == val)
 253                 return (true);
 254
 255         /* If interrupts are enabled sleep for timeout duration */
 256         if(sc->interrupts && sc->intr_type != -1) {
 257                 tsleep(sc, PWAIT, "TPM WITH INTERRUPTS", timeout / tick);
 258
 259                 sc->intr_type = -1;
 260                 return ((RD4(sc, off) & mask) == val);
 261         }
 262
 263         /* If we don't have interrupts poll the device every tick */
 264         while (timeout > 0) {
 265                 if ((RD4(sc, off) & mask) == val)
 266                         return (true);
 267
 268                 pause("TPM POLLING", 1);
 269                 timeout -= tick;
 270         }
 271         return (false);
 272 }
 273
 274 static uint16_t
 275 tpmtis_wait_for_burst(struct tpm_sc *sc)
 276 {
 277         int timeout;
 278         uint16_t burst_count;
 279
 280         timeout = TPM_TIMEOUT_A;
 281
 282         while (timeout-- > 0) {
 283                 burst_count = (RD4(sc, TPM_STS) & TPM_STS_BURST_MASK) >>
 284                     TPM_STS_BURST_OFFSET;
 285                 if (burst_count > 0)
 286                         break;
 287
 288                 DELAY(1);
 289         }
 290         return (burst_count);
 291 }
 292
 293 static bool
 294 tpmtis_read_bytes(struct tpm_sc *sc, size_t count, uint8_t *buf)
 295 {
 296         uint16_t burst_count;
 297
 298         while (count > 0) {
 299                 burst_count = tpmtis_wait_for_burst(sc);
 300                 if (burst_count == 0)
 301                         return (false);
 302
 303                 burst_count = MIN(burst_count, count);
 304                 count -= burst_count;
 305
 306                 while (burst_count-- > 0)
 307                         *buf++ = RD1(sc, TPM_DATA_FIFO);
 308         }
 309
 310         return (true);
 311 }
 312
 313 static bool
 314 tpmtis_write_bytes(struct tpm_sc *sc, size_t count, uint8_t *buf)
 315 {
 316         uint16_t burst_count;
 317
 318         while (count > 0) {
 319                 burst_count = tpmtis_wait_for_burst(sc);
 320                 if (burst_count == 0)
 321                         return (false);
 322
 323                 burst_count = MIN(burst_count, count);
 324                 count -= burst_count;
 325
 326                 while (burst_count-- > 0)
 327                         WR1(sc, TPM_DATA_FIFO, *buf++);
 328         }
 329
 330         return (true);
 331 }
 332
 333
 334 static bool
 335 tpmtis_request_locality(struct tpm_sc *sc, int locality)
 336 {
 337         uint8_t mask;
 338         int timeout;
 339
 340         /* Currently we only support Locality 0 */
 341         if (locality != 0)
 342                 return (false);
 343
 344         mask = TPM_ACCESS_LOC_ACTIVE | TPM_ACCESS_VALID;
 345         timeout = TPM_TIMEOUT_A;
 346         sc->intr_type = TPM_INT_STS_LOC_CHANGE;
 347
 348         WR1(sc, TPM_ACCESS, TPM_ACCESS_LOC_REQ);
 349         bus_barrier(sc->mem_res, TPM_ACCESS, 1, BUS_SPACE_BARRIER_WRITE);
 350         if(sc->interrupts) {
 351                 tsleep(sc, PWAIT, "TPMLOCREQUEST with INTR", timeout / tick);
 352                 return ((RD1(sc, TPM_ACCESS) & mask) == mask);
 353         } else  {
 354                 while(timeout > 0) {
 355                         if ((RD1(sc, TPM_ACCESS) & mask) == mask)
 356                                 return (true);
 357
 358                         pause("TPMLOCREQUEST POLLING", 1);
 359                         timeout -= tick;
 360                 }
 361         }
 362
 363         return (false);
 364 }
 365
 366 static void
 367 tpmtis_relinquish_locality(struct tpm_sc *sc)
 368 {
 369
 370         /*
 371          * Interrupts can only be cleared when a locality is active.
 372          * Clear them now in case interrupt handler didn't make it in time.
 373          */
 374         if(sc->interrupts)
 375                 AND4(sc, TPM_INT_STS, RD4(sc, TPM_INT_STS));
 376
 377         OR1(sc, TPM_ACCESS, TPM_ACCESS_LOC_RELINQUISH);
 378 }
 379
 380 static bool
 381 tpmtis_go_ready(struct tpm_sc *sc)
 382 {
 383         uint32_t mask;
 384
 385         mask = TPM_STS_CMD_RDY;
 386         sc->intr_type = TPM_INT_STS_CMD_RDY;
 387
 388         OR4(sc, TPM_STS, TPM_STS_CMD_RDY);
 389         bus_barrier(sc->mem_res, TPM_STS, 4, BUS_SPACE_BARRIER_WRITE);
 390         if (!tpm_wait_for_u32(sc, TPM_STS, mask, mask, TPM_TIMEOUT_B))
 391                 return (false);
 392
 393         AND4(sc, TPM_STS, ~TPM_STS_CMD_RDY);
 394         return (true);
 395 }
 396
 397 static int
 398 tpmtis_transmit(struct tpm_sc *sc, size_t length)
 399 {
 400         size_t bytes_available;
 401         uint32_t mask, curr_cmd;
 402         int timeout;
 403
 404         sx_assert(&sc->dev_lock, SA_XLOCKED);
 405
 406         if (!tpmtis_request_locality(sc, 0)) {
 407                 device_printf(sc->dev,
 408                     "Failed to obtain locality\n");
 409                 return (EIO);
 410         }
 411         if (!tpmtis_go_ready(sc)) {
 412                 device_printf(sc->dev,
 413                     "Failed to switch to ready state\n");
 414                 return (EIO);
 415         }
 416         if (!tpmtis_write_bytes(sc, length, sc->buf)) {
 417                 device_printf(sc->dev,
 418                     "Failed to write cmd to device\n");
 419                 return (EIO);
 420         }
 421
 422         mask = TPM_STS_VALID;
 423         sc->intr_type = TPM_INT_STS_VALID;
 424         if (!tpm_wait_for_u32(sc, TPM_STS, mask, mask, TPM_TIMEOUT_C)) {
 425                 device_printf(sc->dev,
 426                     "Timeout while waiting for valid bit\n");
 427                 return (EIO);
 428         }
 429         if (RD4(sc, TPM_STS) & TPM_STS_DATA_EXPECTED) {
 430                 device_printf(sc->dev,
 431                     "Device expects more data even though we already"
 432                     " sent everything we had\n");
 433                 return (EIO);
 434         }
 435
 436         /*
 437          * Calculate timeout for current command.
 438          * Command code is passed in bytes 6-10.
 439          */
 440         curr_cmd = be32toh(*(uint32_t *) (&sc->buf[6]));
 441         timeout = tpm20_get_timeout(curr_cmd);
 442
 443         WR4(sc, TPM_STS, TPM_STS_CMD_START);
 444         bus_barrier(sc->mem_res, TPM_STS, 4, BUS_SPACE_BARRIER_WRITE);
 445
 446         mask = TPM_STS_DATA_AVAIL | TPM_STS_VALID;
 447         sc->intr_type = TPM_INT_STS_DATA_AVAIL;
 448         if (!tpm_wait_for_u32(sc, TPM_STS, mask, mask, timeout)) {
 449                 device_printf(sc->dev,
 450                     "Timeout while waiting for device to process cmd\n");
 451                 /*
 452                  * Switching to ready state also cancels processing
 453                  * current command
 454                  */
 455                 if (!tpmtis_go_ready(sc))
 456                         return (EIO);
 457
 458                 /*
 459                  * After canceling a command we should get a response,
 460                  * check if there is one.
 461                  */
 462                 sc->intr_type = TPM_INT_STS_DATA_AVAIL;
 463                 if (!tpm_wait_for_u32(sc, TPM_STS, mask, mask, TPM_TIMEOUT_C))
 464                         return (EIO);
 465         }
 466         /* Read response header. Length is passed in bytes 2 - 6. */
 467         if(!tpmtis_read_bytes(sc, TPM_HEADER_SIZE, sc->buf)) {
 468                 device_printf(sc->dev,
 469                     "Failed to read response header\n");
 470                 return (EIO);
 471         }
 472         bytes_available = be32toh(*(uint32_t *) (&sc->buf[2]));
 473
 474         if (bytes_available > TPM_BUFSIZE || bytes_available < TPM_HEADER_SIZE) {
 475                 device_printf(sc->dev,
 476                     "Incorrect response size: %zu\n",
 477                     bytes_available);
 478                 return (EIO);
 479         }
 480         if(!tpmtis_read_bytes(sc, bytes_available - TPM_HEADER_SIZE,
 481             &sc->buf[TPM_HEADER_SIZE])) {
 482                 device_printf(sc->dev,
 483                     "Failed to read response\n");
 484                 return (EIO);
 485         }
 486         tpmtis_relinquish_locality(sc);
 487         sc->pending_data_length = bytes_available;
 488
 489         return (0);
 490 }
 491
 492 /* ACPI Driver */
 493 static device_method_t tpmtis_methods[] = {
 494         DEVMETHOD(device_probe,         tpmtis_acpi_probe),
 495         DEVMETHOD(device_attach,        tpmtis_attach),
 496         DEVMETHOD(device_detach,        tpmtis_detach),
 497         DEVMETHOD(device_shutdown,      tpm20_shutdown),
 498         DEVMETHOD(device_suspend,       tpm20_suspend),
 499         {0, 0}
 500 };
 501 static driver_t tpmtis_driver = {
 502         "tpmtis", tpmtis_methods, sizeof(struct tpm_sc),
 503 };
 504
 505 devclass_t tpmtis_devclass;
 506 DRIVER_MODULE(tpmtis, acpi, tpmtis_driver, tpmtis_devclass, 0, 0);