2 * Copyright (C) 2005, 2006 IBM Corporation
5 * Leendert van Doorn <leendert@watson.ibm.com>
6 * Kylene Hall <kjhall@us.ibm.com>
8 * Device driver for TCG/TCPA TPM (trusted platform module).
9 * Specifications at www.trustedcomputinggroup.org
11 * This device driver implements the TPM interface as defined in
12 * the TCG TPM Interface Spec version 1.2, revision 1.0.
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License as
16 * published by the Free Software Foundation, version 2 of the
19 #include <linux/pnp.h>
20 #include <linux/interrupt.h>
21 #include <linux/wait.h>
24 #define TPM_HEADER_SIZE 10
27 TPM_ACCESS_VALID = 0x80,
28 TPM_ACCESS_ACTIVE_LOCALITY = 0x20,
29 TPM_ACCESS_REQUEST_PENDING = 0x04,
30 TPM_ACCESS_REQUEST_USE = 0x02,
35 TPM_STS_COMMAND_READY = 0x40,
37 TPM_STS_DATA_AVAIL = 0x10,
38 TPM_STS_DATA_EXPECT = 0x08,
42 TPM_GLOBAL_INT_ENABLE = 0x80000000,
43 TPM_INTF_BURST_COUNT_STATIC = 0x100,
44 TPM_INTF_CMD_READY_INT = 0x080,
45 TPM_INTF_INT_EDGE_FALLING = 0x040,
46 TPM_INTF_INT_EDGE_RISING = 0x020,
47 TPM_INTF_INT_LEVEL_LOW = 0x010,
48 TPM_INTF_INT_LEVEL_HIGH = 0x008,
49 TPM_INTF_LOCALITY_CHANGE_INT = 0x004,
50 TPM_INTF_STS_VALID_INT = 0x002,
51 TPM_INTF_DATA_AVAIL_INT = 0x001,
55 TIS_MEM_BASE = 0xFED4000,
57 TIS_SHORT_TIMEOUT = 750, /* ms */
58 TIS_LONG_TIMEOUT = 2000, /* 2 sec */
61 #define TPM_ACCESS(l) (0x0000 | ((l) << 12))
62 #define TPM_INT_ENABLE(l) (0x0008 | ((l) << 12))
63 #define TPM_INT_VECTOR(l) (0x000C | ((l) << 12))
64 #define TPM_INT_STATUS(l) (0x0010 | ((l) << 12))
65 #define TPM_INTF_CAPS(l) (0x0014 | ((l) << 12))
66 #define TPM_STS(l) (0x0018 | ((l) << 12))
67 #define TPM_DATA_FIFO(l) (0x0024 | ((l) << 12))
69 #define TPM_DID_VID(l) (0x0F00 | ((l) << 12))
70 #define TPM_RID(l) (0x0F04 | ((l) << 12))
72 static LIST_HEAD(tis_chips);
73 static DEFINE_SPINLOCK(tis_lock);
75 static int check_locality(struct tpm_chip *chip, int l)
77 if ((ioread8(chip->vendor.iobase + TPM_ACCESS(l)) &
78 (TPM_ACCESS_ACTIVE_LOCALITY | TPM_ACCESS_VALID)) ==
79 (TPM_ACCESS_ACTIVE_LOCALITY | TPM_ACCESS_VALID))
80 return chip->vendor.locality = l;
85 static void release_locality(struct tpm_chip *chip, int l, int force)
87 if (force || (ioread8(chip->vendor.iobase + TPM_ACCESS(l)) &
88 (TPM_ACCESS_REQUEST_PENDING | TPM_ACCESS_VALID)) ==
89 (TPM_ACCESS_REQUEST_PENDING | TPM_ACCESS_VALID))
90 iowrite8(TPM_ACCESS_ACTIVE_LOCALITY,
91 chip->vendor.iobase + TPM_ACCESS(l));
94 static int request_locality(struct tpm_chip *chip, int l)
99 if (check_locality(chip, l) >= 0)
102 iowrite8(TPM_ACCESS_REQUEST_USE,
103 chip->vendor.iobase + TPM_ACCESS(l));
105 if (chip->vendor.irq) {
106 rc = wait_event_interruptible_timeout(chip->vendor.int_queue,
109 chip->vendor.timeout_a);
114 /* wait for burstcount */
115 stop = jiffies + chip->vendor.timeout_a;
117 if (check_locality(chip, l) >= 0)
121 while (time_before(jiffies, stop));
126 static u8 tpm_tis_status(struct tpm_chip *chip)
128 return ioread8(chip->vendor.iobase +
129 TPM_STS(chip->vendor.locality));
132 static void tpm_tis_ready(struct tpm_chip *chip)
134 /* this causes the current command to be aborted */
135 iowrite8(TPM_STS_COMMAND_READY,
136 chip->vendor.iobase + TPM_STS(chip->vendor.locality));
139 static int get_burstcount(struct tpm_chip *chip)
144 /* wait for burstcount */
145 /* which timeout value, spec has 2 answers (c & d) */
146 stop = jiffies + chip->vendor.timeout_d;
148 burstcnt = ioread8(chip->vendor.iobase +
149 TPM_STS(chip->vendor.locality) + 1);
150 burstcnt += ioread8(chip->vendor.iobase +
151 TPM_STS(chip->vendor.locality) +
156 } while (time_before(jiffies, stop));
160 static int wait_for_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
161 wait_queue_head_t *queue)
167 /* check current status */
168 status = tpm_tis_status(chip);
169 if ((status & mask) == mask)
172 if (chip->vendor.irq) {
173 rc = wait_event_interruptible_timeout(*queue,
180 stop = jiffies + timeout;
183 status = tpm_tis_status(chip);
184 if ((status & mask) == mask)
186 } while (time_before(jiffies, stop));
191 static int recv_data(struct tpm_chip *chip, u8 *buf, size_t count)
193 int size = 0, burstcnt;
194 while (size < count &&
196 TPM_STS_DATA_AVAIL | TPM_STS_VALID,
197 chip->vendor.timeout_c,
198 &chip->vendor.read_queue)
200 burstcnt = get_burstcount(chip);
201 for (; burstcnt > 0 && size < count; burstcnt--)
202 buf[size++] = ioread8(chip->vendor.iobase +
203 TPM_DATA_FIFO(chip->vendor.
209 static int tpm_tis_recv(struct tpm_chip *chip, u8 *buf, size_t count)
212 int expected, status;
214 if (count < TPM_HEADER_SIZE) {
219 /* read first 10 bytes, including tag, paramsize, and result */
221 recv_data(chip, buf, TPM_HEADER_SIZE)) < TPM_HEADER_SIZE) {
222 dev_err(chip->dev, "Unable to read header\n");
226 expected = be32_to_cpu(*(__be32 *) (buf + 2));
227 if (expected > count) {
233 recv_data(chip, &buf[TPM_HEADER_SIZE],
234 expected - TPM_HEADER_SIZE)) < expected) {
235 dev_err(chip->dev, "Unable to read remainder of result\n");
240 wait_for_stat(chip, TPM_STS_VALID, chip->vendor.timeout_c,
241 &chip->vendor.int_queue);
242 status = tpm_tis_status(chip);
243 if (status & TPM_STS_DATA_AVAIL) { /* retry? */
244 dev_err(chip->dev, "Error left over data\n");
251 release_locality(chip, chip->vendor.locality, 0);
256 * If interrupts are used (signaled by an irq set in the vendor structure)
257 * tpm.c can skip polling for the data to be available as the interrupt is
260 static int tpm_tis_send(struct tpm_chip *chip, u8 *buf, size_t len)
262 int rc, status, burstcnt;
266 if (request_locality(chip, 0) < 0)
269 status = tpm_tis_status(chip);
270 if ((status & TPM_STS_COMMAND_READY) == 0) {
273 (chip, TPM_STS_COMMAND_READY, chip->vendor.timeout_b,
274 &chip->vendor.int_queue) < 0) {
280 while (count < len - 1) {
281 burstcnt = get_burstcount(chip);
282 for (; burstcnt > 0 && count < len - 1; burstcnt--) {
283 iowrite8(buf[count], chip->vendor.iobase +
284 TPM_DATA_FIFO(chip->vendor.locality));
288 wait_for_stat(chip, TPM_STS_VALID, chip->vendor.timeout_c,
289 &chip->vendor.int_queue);
290 status = tpm_tis_status(chip);
291 if ((status & TPM_STS_DATA_EXPECT) == 0) {
297 /* write last byte */
299 chip->vendor.iobase +
300 TPM_DATA_FIFO(chip->vendor.locality));
301 wait_for_stat(chip, TPM_STS_VALID, chip->vendor.timeout_c,
302 &chip->vendor.int_queue);
303 status = tpm_tis_status(chip);
304 if ((status & TPM_STS_DATA_EXPECT) != 0) {
311 chip->vendor.iobase + TPM_STS(chip->vendor.locality));
313 if (chip->vendor.irq) {
314 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
316 (chip, TPM_STS_DATA_AVAIL | TPM_STS_VALID,
317 tpm_calc_ordinal_duration(chip, ordinal),
318 &chip->vendor.read_queue) < 0) {
326 release_locality(chip, chip->vendor.locality, 0);
330 static struct file_operations tis_ops = {
331 .owner = THIS_MODULE,
336 .release = tpm_release,
339 static DEVICE_ATTR(pubek, S_IRUGO, tpm_show_pubek, NULL);
340 static DEVICE_ATTR(pcrs, S_IRUGO, tpm_show_pcrs, NULL);
341 static DEVICE_ATTR(enabled, S_IRUGO, tpm_show_enabled, NULL);
342 static DEVICE_ATTR(active, S_IRUGO, tpm_show_active, NULL);
343 static DEVICE_ATTR(owned, S_IRUGO, tpm_show_owned, NULL);
344 static DEVICE_ATTR(temp_deactivated, S_IRUGO, tpm_show_temp_deactivated,
346 static DEVICE_ATTR(caps, S_IRUGO, tpm_show_caps_1_2, NULL);
347 static DEVICE_ATTR(cancel, S_IWUSR | S_IWGRP, NULL, tpm_store_cancel);
349 static struct attribute *tis_attrs[] = {
350 &dev_attr_pubek.attr,
352 &dev_attr_enabled.attr,
353 &dev_attr_active.attr,
354 &dev_attr_owned.attr,
355 &dev_attr_temp_deactivated.attr,
357 &dev_attr_cancel.attr, NULL,
360 static struct attribute_group tis_attr_grp = {
364 static struct tpm_vendor_specific tpm_tis = {
365 .status = tpm_tis_status,
366 .recv = tpm_tis_recv,
367 .send = tpm_tis_send,
368 .cancel = tpm_tis_ready,
369 .req_complete_mask = TPM_STS_DATA_AVAIL | TPM_STS_VALID,
370 .req_complete_val = TPM_STS_DATA_AVAIL | TPM_STS_VALID,
371 .req_canceled = TPM_STS_COMMAND_READY,
372 .attr_group = &tis_attr_grp,
377 static irqreturn_t tis_int_probe(int irq, void *dev_id, struct pt_regs *regs)
379 struct tpm_chip *chip = (struct tpm_chip *) dev_id;
382 interrupt = ioread32(chip->vendor.iobase +
383 TPM_INT_STATUS(chip->vendor.locality));
388 chip->vendor.irq = irq;
390 /* Clear interrupts handled with TPM_EOI */
392 chip->vendor.iobase +
393 TPM_INT_STATUS(chip->vendor.locality));
397 static irqreturn_t tis_int_handler(int irq, void *dev_id, struct pt_regs *regs)
399 struct tpm_chip *chip = (struct tpm_chip *) dev_id;
403 interrupt = ioread32(chip->vendor.iobase +
404 TPM_INT_STATUS(chip->vendor.locality));
409 if (interrupt & TPM_INTF_DATA_AVAIL_INT)
410 wake_up_interruptible(&chip->vendor.read_queue);
411 if (interrupt & TPM_INTF_LOCALITY_CHANGE_INT)
412 for (i = 0; i < 5; i++)
413 if (check_locality(chip, i) >= 0)
416 (TPM_INTF_LOCALITY_CHANGE_INT | TPM_INTF_STS_VALID_INT |
417 TPM_INTF_CMD_READY_INT))
418 wake_up_interruptible(&chip->vendor.int_queue);
420 /* Clear interrupts handled with TPM_EOI */
422 chip->vendor.iobase +
423 TPM_INT_STATUS(chip->vendor.locality));
427 static int __devinit tpm_tis_pnp_init(struct pnp_dev *pnp_dev,
428 const struct pnp_device_id *pnp_id)
430 u32 vendor, intfcaps, intmask;
432 unsigned long start, len;
433 struct tpm_chip *chip;
435 start = pnp_mem_start(pnp_dev, 0);
436 len = pnp_mem_len(pnp_dev, 0);
439 start = TIS_MEM_BASE;
443 if (!(chip = tpm_register_hardware(&pnp_dev->dev, &tpm_tis)))
446 chip->vendor.iobase = ioremap(start, len);
447 if (!chip->vendor.iobase) {
452 vendor = ioread32(chip->vendor.iobase + TPM_DID_VID(0));
453 if ((vendor & 0xFFFF) == 0xFFFF) {
458 /* Default timeouts */
459 chip->vendor.timeout_a = msecs_to_jiffies(TIS_SHORT_TIMEOUT);
460 chip->vendor.timeout_b = msecs_to_jiffies(TIS_LONG_TIMEOUT);
461 chip->vendor.timeout_c = msecs_to_jiffies(TIS_SHORT_TIMEOUT);
462 chip->vendor.timeout_d = msecs_to_jiffies(TIS_SHORT_TIMEOUT);
464 dev_info(&pnp_dev->dev,
465 "1.2 TPM (device-id 0x%X, rev-id %d)\n",
466 vendor >> 16, ioread8(chip->vendor.iobase + TPM_RID(0)));
468 /* Figure out the capabilities */
470 ioread32(chip->vendor.iobase +
471 TPM_INTF_CAPS(chip->vendor.locality));
472 dev_dbg(&pnp_dev->dev, "TPM interface capabilities (0x%x):\n",
474 if (intfcaps & TPM_INTF_BURST_COUNT_STATIC)
475 dev_dbg(&pnp_dev->dev, "\tBurst Count Static\n");
476 if (intfcaps & TPM_INTF_CMD_READY_INT)
477 dev_dbg(&pnp_dev->dev, "\tCommand Ready Int Support\n");
478 if (intfcaps & TPM_INTF_INT_EDGE_FALLING)
479 dev_dbg(&pnp_dev->dev, "\tInterrupt Edge Falling\n");
480 if (intfcaps & TPM_INTF_INT_EDGE_RISING)
481 dev_dbg(&pnp_dev->dev, "\tInterrupt Edge Rising\n");
482 if (intfcaps & TPM_INTF_INT_LEVEL_LOW)
483 dev_dbg(&pnp_dev->dev, "\tInterrupt Level Low\n");
484 if (intfcaps & TPM_INTF_INT_LEVEL_HIGH)
485 dev_dbg(&pnp_dev->dev, "\tInterrupt Level High\n");
486 if (intfcaps & TPM_INTF_LOCALITY_CHANGE_INT)
487 dev_dbg(&pnp_dev->dev, "\tLocality Change Int Support\n");
488 if (intfcaps & TPM_INTF_STS_VALID_INT)
489 dev_dbg(&pnp_dev->dev, "\tSts Valid Int Support\n");
490 if (intfcaps & TPM_INTF_DATA_AVAIL_INT)
491 dev_dbg(&pnp_dev->dev, "\tData Avail Int Support\n");
493 if (request_locality(chip, 0) != 0) {
498 /* INTERRUPT Setup */
499 init_waitqueue_head(&chip->vendor.read_queue);
500 init_waitqueue_head(&chip->vendor.int_queue);
503 ioread32(chip->vendor.iobase +
504 TPM_INT_ENABLE(chip->vendor.locality));
506 intmask |= TPM_INTF_CMD_READY_INT
507 | TPM_INTF_LOCALITY_CHANGE_INT | TPM_INTF_DATA_AVAIL_INT
508 | TPM_INTF_STS_VALID_INT;
511 chip->vendor.iobase +
512 TPM_INT_ENABLE(chip->vendor.locality));
515 ioread8(chip->vendor.iobase +
516 TPM_INT_VECTOR(chip->vendor.locality));
518 for (i = 3; i < 16 && chip->vendor.irq == 0; i++) {
520 chip->vendor.iobase +
521 TPM_INT_VECTOR(chip->vendor.locality));
523 (i, tis_int_probe, SA_SHIRQ,
524 chip->vendor.miscdev.name, chip) != 0) {
526 "Unable to request irq: %d for probe\n",
531 /* Clear all existing */
533 (chip->vendor.iobase +
534 TPM_INT_STATUS(chip->vendor.locality)),
535 chip->vendor.iobase +
536 TPM_INT_STATUS(chip->vendor.locality));
539 iowrite32(intmask | TPM_GLOBAL_INT_ENABLE,
540 chip->vendor.iobase +
541 TPM_INT_ENABLE(chip->vendor.locality));
543 /* Generate Interrupts */
544 tpm_gen_interrupt(chip);
548 chip->vendor.iobase +
549 TPM_INT_ENABLE(chip->vendor.locality));
552 if (chip->vendor.irq) {
553 iowrite8(chip->vendor.irq,
554 chip->vendor.iobase +
555 TPM_INT_VECTOR(chip->vendor.locality));
557 (chip->vendor.irq, tis_int_handler, SA_SHIRQ,
558 chip->vendor.miscdev.name, chip) != 0) {
560 "Unable to request irq: %d for use\n", i);
561 chip->vendor.irq = 0;
563 /* Clear all existing */
565 (chip->vendor.iobase +
566 TPM_INT_STATUS(chip->vendor.locality)),
567 chip->vendor.iobase +
568 TPM_INT_STATUS(chip->vendor.locality));
571 iowrite32(intmask | TPM_GLOBAL_INT_ENABLE,
572 chip->vendor.iobase +
573 TPM_INT_ENABLE(chip->vendor.locality));
577 INIT_LIST_HEAD(&chip->vendor.list);
578 spin_lock(&tis_lock);
579 list_add(&chip->vendor.list, &tis_chips);
580 spin_unlock(&tis_lock);
582 tpm_get_timeouts(chip);
583 tpm_continue_selftest(chip);
587 if (chip->vendor.iobase)
588 iounmap(chip->vendor.iobase);
589 tpm_remove_hardware(chip->dev);
593 static int tpm_tis_pnp_suspend(struct pnp_dev *dev, pm_message_t msg)
595 return tpm_pm_suspend(&dev->dev, msg);
598 static int tpm_tis_pnp_resume(struct pnp_dev *dev)
600 return tpm_pm_resume(&dev->dev);
603 static struct pnp_device_id tpm_pnp_tbl[] __devinitdata = {
604 {"PNP0C31", 0}, /* TPM */
608 static struct pnp_driver tis_pnp_driver = {
610 .id_table = tpm_pnp_tbl,
611 .probe = tpm_tis_pnp_init,
612 .suspend = tpm_tis_pnp_suspend,
613 .resume = tpm_tis_pnp_resume,
616 static int __init init_tis(void)
618 return pnp_register_driver(&tis_pnp_driver);
621 static void __exit cleanup_tis(void)
623 struct tpm_vendor_specific *i, *j;
624 struct tpm_chip *chip;
625 spin_lock(&tis_lock);
626 list_for_each_entry_safe(i, j, &tis_chips, list) {
627 chip = to_tpm_chip(i);
628 iowrite32(~TPM_GLOBAL_INT_ENABLE &
629 ioread32(chip->vendor.iobase +
630 TPM_INT_ENABLE(chip->vendor.
632 chip->vendor.iobase +
633 TPM_INT_ENABLE(chip->vendor.locality));
634 release_locality(chip, chip->vendor.locality, 1);
635 if (chip->vendor.irq)
636 free_irq(chip->vendor.irq, chip);
639 tpm_remove_hardware(chip->dev);
641 spin_unlock(&tis_lock);
642 pnp_unregister_driver(&tis_pnp_driver);
645 module_init(init_tis);
646 module_exit(cleanup_tis);
647 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
648 MODULE_DESCRIPTION("TPM Driver");
649 MODULE_VERSION("2.0");
650 MODULE_LICENSE("GPL");