drivers/char/tpm/tpm_crb.c

   1 /*
   2  * Copyright (C) 2014 Intel Corporation
   3  *
   4  * Authors:
   5  * Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>
   6  *
   7  * Maintained by: <tpmdd-devel@lists.sourceforge.net>
   8  *
   9  * This device driver implements the TPM interface as defined in
  10  * the TCG CRB 2.0 TPM specification.
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; version 2
  15  * of the License.
  16  */
  17
  18 #include <linux/acpi.h>
  19 #include <linux/highmem.h>
  20 #include <linux/rculist.h>
  21 #include <linux/module.h>
  22 #include "tpm.h"
  23
  24 #define ACPI_SIG_TPM2 "TPM2"
  25
  26 static const u8 CRB_ACPI_START_UUID[] = {
  27         /* 0000 */ 0xAB, 0x6C, 0xBF, 0x6B, 0x63, 0x54, 0x14, 0x47,
  28         /* 0008 */ 0xB7, 0xCD, 0xF0, 0x20, 0x3C, 0x03, 0x68, 0xD4
  29 };
  30
  31 enum crb_defaults {
  32         CRB_ACPI_START_REVISION_ID = 1,
  33         CRB_ACPI_START_INDEX = 1,
  34 };
  35
  36 enum crb_ctrl_req {
  37         CRB_CTRL_REQ_CMD_READY  = BIT(0),
  38         CRB_CTRL_REQ_GO_IDLE    = BIT(1),
  39 };
  40
  41 enum crb_ctrl_sts {
  42         CRB_CTRL_STS_ERROR      = BIT(0),
  43         CRB_CTRL_STS_TPM_IDLE   = BIT(1),
  44 };
  45
  46 enum crb_start {
  47         CRB_START_INVOKE        = BIT(0),
  48 };
  49
  50 enum crb_cancel {
  51         CRB_CANCEL_INVOKE       = BIT(0),
  52 };
  53
  54 struct crb_control_area {
  55         u32 req;
  56         u32 sts;
  57         u32 cancel;
  58         u32 start;
  59         u32 int_enable;
  60         u32 int_sts;
  61         u32 cmd_size;
  62         u32 cmd_pa_low;
  63         u32 cmd_pa_high;
  64         u32 rsp_size;
  65         u64 rsp_pa;
  66 } __packed;
  67
  68 enum crb_status {
  69         CRB_DRV_STS_COMPLETE    = BIT(0),
  70 };
  71
  72 enum crb_flags {
  73         CRB_FL_ACPI_START       = BIT(0),
  74         CRB_FL_CRB_START        = BIT(1),
  75 };
  76
  77 struct crb_priv {
  78         unsigned int flags;
  79         void __iomem *iobase;
  80         struct crb_control_area __iomem *cca;
  81         u8 __iomem *cmd;
  82         u8 __iomem *rsp;
  83         u32 cmd_size;
  84 };
  85
  86 /**
  87  * crb_go_idle - request tpm crb device to go the idle state
  88  *
  89  * @dev:  crb device
  90  * @priv: crb private data
  91  *
  92  * Write CRB_CTRL_REQ_GO_IDLE to TPM_CRB_CTRL_REQ
  93  * The device should respond within TIMEOUT_C by clearing the bit.
  94  * Anyhow, we do not wait here as a consequent CMD_READY request
  95  * will be handled correctly even if idle was not completed.
  96  *
  97  * The function does nothing for devices with ACPI-start method.
  98  *
  99  * Return: 0 always
 100  */
 101 static int __maybe_unused crb_go_idle(struct device *dev, struct crb_priv *priv)
 102 {
 103         if (priv->flags & CRB_FL_ACPI_START)
 104                 return 0;
 105
 106         iowrite32(CRB_CTRL_REQ_GO_IDLE, &priv->cca->req);
 107         /* we don't really care when this settles */
 108
 109         return 0;
 110 }
 111
 112 /**
 113  * crb_cmd_ready - request tpm crb device to enter ready state
 114  *
 115  * @dev:  crb device
 116  * @priv: crb private data
 117  *
 118  * Write CRB_CTRL_REQ_CMD_READY to TPM_CRB_CTRL_REQ
 119  * and poll till the device acknowledge it by clearing the bit.
 120  * The device should respond within TIMEOUT_C.
 121  *
 122  * The function does nothing for devices with ACPI-start method
 123  *
 124  * Return: 0 on success -ETIME on timeout;
 125  */
 126 static int __maybe_unused crb_cmd_ready(struct device *dev,
 127                                         struct crb_priv *priv)
 128 {
 129         ktime_t stop, start;
 130
 131         if (priv->flags & CRB_FL_ACPI_START)
 132                 return 0;
 133
 134         iowrite32(CRB_CTRL_REQ_CMD_READY, &priv->cca->req);
 135
 136         start = ktime_get();
 137         stop = ktime_add(start, ms_to_ktime(TPM2_TIMEOUT_C));
 138         do {
 139                 if (!(ioread32(&priv->cca->req) & CRB_CTRL_REQ_CMD_READY)) {
 140                         dev_dbg(dev, "cmdReady in %lld usecs\n",
 141                                 ktime_to_us(ktime_sub(ktime_get(), start)));
 142                         return 0;
 143                 }
 144                 usleep_range(50, 100);
 145         } while (ktime_before(ktime_get(), stop));
 146
 147         if (ioread32(&priv->cca->req) & CRB_CTRL_REQ_CMD_READY) {
 148                 dev_warn(dev, "cmdReady timed out\n");
 149                 return -ETIME;
 150         }
 151
 152         return 0;
 153 }
 154
 155 static SIMPLE_DEV_PM_OPS(crb_pm, tpm_pm_suspend, tpm_pm_resume);
 156
 157 static u8 crb_status(struct tpm_chip *chip)
 158 {
 159         struct crb_priv *priv = dev_get_drvdata(&chip->dev);
 160         u8 sts = 0;
 161
 162         if ((ioread32(&priv->cca->start) & CRB_START_INVOKE) !=
 163             CRB_START_INVOKE)
 164                 sts |= CRB_DRV_STS_COMPLETE;
 165
 166         return sts;
 167 }
 168
 169 static int crb_recv(struct tpm_chip *chip, u8 *buf, size_t count)
 170 {
 171         struct crb_priv *priv = dev_get_drvdata(&chip->dev);
 172         unsigned int expected;
 173
 174         /* sanity check */
 175         if (count < 6)
 176                 return -EIO;
 177
 178         if (ioread32(&priv->cca->sts) & CRB_CTRL_STS_ERROR)
 179                 return -EIO;
 180
 181         memcpy_fromio(buf, priv->rsp, 6);
 182         expected = be32_to_cpup((__be32 *) &buf[2]);
 183
 184         if (expected > count)
 185                 return -EIO;
 186
 187         memcpy_fromio(&buf[6], &priv->rsp[6], expected - 6);
 188
 189         return expected;
 190 }
 191
 192 static int crb_do_acpi_start(struct tpm_chip *chip)
 193 {
 194         union acpi_object *obj;
 195         int rc;
 196
 197         obj = acpi_evaluate_dsm(chip->acpi_dev_handle,
 198                                 CRB_ACPI_START_UUID,
 199                                 CRB_ACPI_START_REVISION_ID,
 200                                 CRB_ACPI_START_INDEX,
 201                                 NULL);
 202         if (!obj)
 203                 return -ENXIO;
 204         rc = obj->integer.value == 0 ? 0 : -ENXIO;
 205         ACPI_FREE(obj);
 206         return rc;
 207 }
 208
 209 static int crb_send(struct tpm_chip *chip, u8 *buf, size_t len)
 210 {
 211         struct crb_priv *priv = dev_get_drvdata(&chip->dev);
 212         int rc = 0;
 213
 214         /* Zero the cancel register so that the next command will not get
 215          * canceled.
 216          */
 217         iowrite32(0, &priv->cca->cancel);
 218
 219         if (len > priv->cmd_size) {
 220                 dev_err(&chip->dev, "invalid command count value %zd %d\n",
 221                         len, priv->cmd_size);
 222                 return -E2BIG;
 223         }
 224
 225         memcpy_toio(priv->cmd, buf, len);
 226
 227         /* Make sure that cmd is populated before issuing start. */
 228         wmb();
 229
 230         if (priv->flags & CRB_FL_CRB_START)
 231                 iowrite32(CRB_START_INVOKE, &priv->cca->start);
 232
 233         if (priv->flags & CRB_FL_ACPI_START)
 234                 rc = crb_do_acpi_start(chip);
 235
 236         return rc;
 237 }
 238
 239 static void crb_cancel(struct tpm_chip *chip)
 240 {
 241         struct crb_priv *priv = dev_get_drvdata(&chip->dev);
 242
 243         iowrite32(CRB_CANCEL_INVOKE, &priv->cca->cancel);
 244
 245         if ((priv->flags & CRB_FL_ACPI_START) && crb_do_acpi_start(chip))
 246                 dev_err(&chip->dev, "ACPI Start failed\n");
 247 }
 248
 249 static bool crb_req_canceled(struct tpm_chip *chip, u8 status)
 250 {
 251         struct crb_priv *priv = dev_get_drvdata(&chip->dev);
 252         u32 cancel = ioread32(&priv->cca->cancel);
 253
 254         return (cancel & CRB_CANCEL_INVOKE) == CRB_CANCEL_INVOKE;
 255 }
 256
 257 static const struct tpm_class_ops tpm_crb = {
 258         .flags = TPM_OPS_AUTO_STARTUP,
 259         .status = crb_status,
 260         .recv = crb_recv,
 261         .send = crb_send,
 262         .cancel = crb_cancel,
 263         .req_canceled = crb_req_canceled,
 264         .req_complete_mask = CRB_DRV_STS_COMPLETE,
 265         .req_complete_val = CRB_DRV_STS_COMPLETE,
 266 };
 267
 268 static int crb_init(struct acpi_device *device, struct crb_priv *priv)
 269 {
 270         struct tpm_chip *chip;
 271
 272         chip = tpmm_chip_alloc(&device->dev, &tpm_crb);
 273         if (IS_ERR(chip))
 274                 return PTR_ERR(chip);
 275
 276         dev_set_drvdata(&chip->dev, priv);
 277         chip->acpi_dev_handle = device->handle;
 278         chip->flags = TPM_CHIP_FLAG_TPM2;
 279
 280         return tpm_chip_register(chip);
 281 }
 282
 283 static int crb_check_resource(struct acpi_resource *ares, void *data)
 284 {
 285         struct resource *io_res = data;
 286         struct resource res;
 287
 288         if (acpi_dev_resource_memory(ares, &res)) {
 289                 *io_res = res;
 290                 io_res->name = NULL;
 291         }
 292
 293         return 1;
 294 }
 295
 296 static void __iomem *crb_map_res(struct device *dev, struct crb_priv *priv,
 297                                  struct resource *io_res, u64 start, u32 size)
 298 {
 299         struct resource new_res = {
 300                 .start  = start,
 301                 .end    = start + size - 1,
 302                 .flags  = IORESOURCE_MEM,
 303         };
 304
 305         /* Detect a 64 bit address on a 32 bit system */
 306         if (start != new_res.start)
 307                 return (void __iomem *) ERR_PTR(-EINVAL);
 308
 309         if (!resource_contains(io_res, &new_res))
 310                 return devm_ioremap_resource(dev, &new_res);
 311
 312         return priv->iobase + (new_res.start - io_res->start);
 313 }
 314
 315 static int crb_map_io(struct acpi_device *device, struct crb_priv *priv,
 316                       struct acpi_table_tpm2 *buf)
 317 {
 318         struct list_head resources;
 319         struct resource io_res;
 320         struct device *dev = &device->dev;
 321         u64 cmd_pa;
 322         u32 cmd_size;
 323         u64 rsp_pa;
 324         u32 rsp_size;
 325         int ret;
 326
 327         INIT_LIST_HEAD(&resources);
 328         ret = acpi_dev_get_resources(device, &resources, crb_check_resource,
 329                                      &io_res);
 330         if (ret < 0)
 331                 return ret;
 332         acpi_dev_free_resource_list(&resources);
 333
 334         if (resource_type(&io_res) != IORESOURCE_MEM) {
 335                 dev_err(dev, FW_BUG "TPM2 ACPI table does not define a memory resource\n");
 336                 return -EINVAL;
 337         }
 338
 339         priv->iobase = devm_ioremap_resource(dev, &io_res);
 340         if (IS_ERR(priv->iobase))
 341                 return PTR_ERR(priv->iobase);
 342
 343         priv->cca = crb_map_res(dev, priv, &io_res, buf->control_address,
 344                                 sizeof(struct crb_control_area));
 345         if (IS_ERR(priv->cca))
 346                 return PTR_ERR(priv->cca);
 347
 348         cmd_pa = ((u64) ioread32(&priv->cca->cmd_pa_high) << 32) |
 349                   (u64) ioread32(&priv->cca->cmd_pa_low);
 350         cmd_size = ioread32(&priv->cca->cmd_size);
 351         priv->cmd = crb_map_res(dev, priv, &io_res, cmd_pa, cmd_size);
 352         if (IS_ERR(priv->cmd))
 353                 return PTR_ERR(priv->cmd);
 354
 355         memcpy_fromio(&rsp_pa, &priv->cca->rsp_pa, 8);
 356         rsp_pa = le64_to_cpu(rsp_pa);
 357         rsp_size = ioread32(&priv->cca->rsp_size);
 358
 359         if (cmd_pa != rsp_pa) {
 360                 priv->rsp = crb_map_res(dev, priv, &io_res, rsp_pa, rsp_size);
 361                 return PTR_ERR_OR_ZERO(priv->rsp);
 362         }
 363
 364         /* According to the PTP specification, overlapping command and response
 365          * buffer sizes must be identical.
 366          */
 367         if (cmd_size != rsp_size) {
 368                 dev_err(dev, FW_BUG "overlapping command and response buffer sizes are not identical");
 369                 return -EINVAL;
 370         }
 371         priv->cmd_size = cmd_size;
 372
 373         priv->rsp = priv->cmd;
 374         return 0;
 375 }
 376
 377 static int crb_acpi_add(struct acpi_device *device)
 378 {
 379         struct acpi_table_tpm2 *buf;
 380         struct crb_priv *priv;
 381         struct device *dev = &device->dev;
 382         acpi_status status;
 383         u32 sm;
 384         int rc;
 385
 386         status = acpi_get_table(ACPI_SIG_TPM2, 1,
 387                                 (struct acpi_table_header **) &buf);
 388         if (ACPI_FAILURE(status) || buf->header.length < sizeof(*buf)) {
 389                 dev_err(dev, FW_BUG "failed to get TPM2 ACPI table\n");
 390                 return -EINVAL;
 391         }
 392
 393         /* Should the FIFO driver handle this? */
 394         sm = buf->start_method;
 395         if (sm == ACPI_TPM2_MEMORY_MAPPED)
 396                 return -ENODEV;
 397
 398         priv = devm_kzalloc(dev, sizeof(struct crb_priv), GFP_KERNEL);
 399         if (!priv)
 400                 return -ENOMEM;
 401
 402         /* The reason for the extra quirk is that the PTT in 4th Gen Core CPUs
 403          * report only ACPI start but in practice seems to require both
 404          * ACPI start and CRB start.
 405          */
 406         if (sm == ACPI_TPM2_COMMAND_BUFFER || sm == ACPI_TPM2_MEMORY_MAPPED ||
 407             !strcmp(acpi_device_hid(device), "MSFT0101"))
 408                 priv->flags |= CRB_FL_CRB_START;
 409
 410         if (sm == ACPI_TPM2_START_METHOD ||
 411             sm == ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD)
 412                 priv->flags |= CRB_FL_ACPI_START;
 413
 414         rc = crb_map_io(device, priv, buf);
 415         if (rc)
 416                 return rc;
 417
 418         return crb_init(device, priv);
 419 }
 420
 421 static int crb_acpi_remove(struct acpi_device *device)
 422 {
 423         struct device *dev = &device->dev;
 424         struct tpm_chip *chip = dev_get_drvdata(dev);
 425
 426         tpm_chip_unregister(chip);
 427
 428         return 0;
 429 }
 430
 431 static struct acpi_device_id crb_device_ids[] = {
 432         {"MSFT0101", 0},
 433         {"", 0},
 434 };
 435 MODULE_DEVICE_TABLE(acpi, crb_device_ids);
 436
 437 static struct acpi_driver crb_acpi_driver = {
 438         .name = "tpm_crb",
 439         .ids = crb_device_ids,
 440         .ops = {
 441                 .add = crb_acpi_add,
 442                 .remove = crb_acpi_remove,
 443         },
 444         .drv = {
 445                 .pm = &crb_pm,
 446         },
 447 };
 448
 449 module_acpi_driver(crb_acpi_driver);
 450 MODULE_AUTHOR("Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>");
 451 MODULE_DESCRIPTION("TPM2 Driver");
 452 MODULE_VERSION("0.1");
 453 MODULE_LICENSE("GPL");