2 * Copyright (C) 2004 IBM Corporation
5 * Leendert van Doorn <leendert@watson.ibm.com>
6 * Dave Safford <safford@watson.ibm.com>
7 * Reiner Sailer <sailer@watson.ibm.com>
8 * Kylene Hall <kjhall@us.ibm.com>
10 * Maintained by: <tpmdd_devel@lists.sourceforge.net>
12 * Device driver for TCG/TCPA TPM (trusted platform module).
13 * Specifications at www.trustedcomputinggroup.org
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License as
17 * published by the Free Software Foundation, version 2 of the
20 * Note, the TPM chip is not interrupt driven (only polling)
21 * and can have very long timeouts (minutes!). Hence the unusual
26 #include <linux/sched.h>
27 #include <linux/poll.h>
28 #include <linux/spinlock.h>
32 TPM_MINOR = 224, /* officially assigned */
34 TPM_NUM_DEVICES = 256,
35 TPM_NUM_MASK_ENTRIES = TPM_NUM_DEVICES / (8 * sizeof(int))
38 /* PCI configuration addresses */
39 enum tpm_pci_config_addr {
40 PCI_GEN_PMCON_1 = 0xA0,
48 TPM_INTERUPT_REG = 0x0A,
49 TPM_BASE_ADDR_LO = 0x08,
50 TPM_BASE_ADDR_HI = 0x09,
51 TPM_UNLOCK_VALUE = 0x55,
52 TPM_LOCK_VALUE = 0xAA,
53 TPM_DISABLE_INTERUPT_VALUE = 0x00
57 static LIST_HEAD(tpm_chip_list);
58 static DEFINE_SPINLOCK(driver_lock);
59 static int dev_mask[TPM_NUM_MASK_ENTRIES];
61 static void user_reader_timeout(unsigned long ptr)
63 struct tpm_chip *chip = (struct tpm_chip *) ptr;
65 down(&chip->buffer_mutex);
66 atomic_set(&chip->data_pending, 0);
67 memset(chip->data_buffer, 0, TPM_BUFSIZE);
68 up(&chip->buffer_mutex);
72 * Initialize the LPC bus and enable the TPM ports
74 int tpm_lpc_bus_init(struct pci_dev *pci_dev, u16 base)
79 switch (pci_dev->vendor) {
80 case PCI_VENDOR_ID_INTEL:
81 switch (pci_dev->device) {
82 case PCI_DEVICE_ID_INTEL_82801CA_12:
83 case PCI_DEVICE_ID_INTEL_82801DB_12:
87 /* init ICH (enable LPC) */
88 pci_read_config_dword(pci_dev, PCI_GEN1_DEC, &lpcenable);
89 lpcenable |= 0x20000000;
90 pci_write_config_dword(pci_dev, PCI_GEN1_DEC, lpcenable);
93 pci_read_config_dword(pci_dev, PCI_GEN1_DEC,
95 if ((lpcenable & 0x20000000) == 0) {
96 dev_err(&pci_dev->dev,
97 "cannot enable LPC\n");
102 /* initialize TPM registers */
103 pci_read_config_dword(pci_dev, PCI_GEN2_DEC, &tmp);
106 tmp = (tmp & 0xFFFF0000) | (base & 0xFFF0);
109 (tmp & 0xFFFF0000) | (base & 0xFFF0) |
112 pci_write_config_dword(pci_dev, PCI_GEN2_DEC, tmp);
115 pci_read_config_dword(pci_dev, PCI_GEN_PMCON_1,
117 tmp |= 0x00000004; /* enable CLKRUN */
118 pci_write_config_dword(pci_dev, PCI_GEN_PMCON_1,
122 case PCI_VENDOR_ID_AMD:
127 tpm_write_index(TPM_LOCK_REG, TPM_UNLOCK_VALUE);
128 tpm_write_index(TPM_INTERUPT_REG, TPM_DISABLE_INTERUPT_VALUE);
129 tpm_write_index(TPM_BASE_ADDR_LO, base);
130 tpm_write_index(TPM_BASE_ADDR_HI, (base & 0xFF00) >> 8);
131 tpm_write_index(TPM_LOCK_REG, TPM_LOCK_VALUE);
136 EXPORT_SYMBOL_GPL(tpm_lpc_bus_init);
139 * Internal kernel interface to transmit TPM commands
141 static ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
148 count = be32_to_cpu(*((__be32 *) (buf + 2)));
152 if (count > bufsiz) {
153 dev_err(&chip->pci_dev->dev,
154 "invalid count value %x %zx \n", count, bufsiz);
158 down(&chip->tpm_mutex);
160 if ((len = chip->vendor->send(chip, (u8 *) buf, count)) < 0) {
161 dev_err(&chip->pci_dev->dev,
162 "tpm_transmit: tpm_send: error %zd\n", len);
166 stop = jiffies + 2 * 60 * HZ;
168 u8 status = inb(chip->vendor->base + 1);
169 if ((status & chip->vendor->req_complete_mask) ==
170 chip->vendor->req_complete_val) {
173 msleep(TPM_TIMEOUT); /* CHECK */
175 } while (time_before(jiffies, stop));
178 chip->vendor->cancel(chip);
179 dev_err(&chip->pci_dev->dev, "Time expired\n");
180 up(&chip->tpm_mutex);
184 len = chip->vendor->recv(chip, (u8 *) buf, bufsiz);
186 dev_err(&chip->pci_dev->dev,
187 "tpm_transmit: tpm_recv: error %zd\n", len);
188 up(&chip->tpm_mutex);
192 #define TPM_DIGEST_SIZE 20
193 #define CAP_PCR_RESULT_SIZE 18
194 static const u8 cap_pcr[] = {
195 0, 193, /* TPM_TAG_RQU_COMMAND */
196 0, 0, 0, 22, /* length */
197 0, 0, 0, 101, /* TPM_ORD_GetCapability */
203 #define READ_PCR_RESULT_SIZE 30
204 static const u8 pcrread[] = {
205 0, 193, /* TPM_TAG_RQU_COMMAND */
206 0, 0, 0, 14, /* length */
207 0, 0, 0, 21, /* TPM_ORD_PcrRead */
208 0, 0, 0, 0 /* PCR index */
211 static ssize_t show_pcrs(struct device *dev, struct device_attribute *attr, char *buf)
213 u8 data[READ_PCR_RESULT_SIZE];
219 struct tpm_chip *chip =
220 pci_get_drvdata(to_pci_dev(dev));
224 memcpy(data, cap_pcr, sizeof(cap_pcr));
225 if ((len = tpm_transmit(chip, data, sizeof(data)))
226 < CAP_PCR_RESULT_SIZE)
229 num_pcrs = be32_to_cpu(*((__be32 *) (data + 14)));
231 for (i = 0; i < num_pcrs; i++) {
232 memcpy(data, pcrread, sizeof(pcrread));
233 index = cpu_to_be32(i);
234 memcpy(data + 10, &index, 4);
235 if ((len = tpm_transmit(chip, data, sizeof(data)))
236 < READ_PCR_RESULT_SIZE)
238 str += sprintf(str, "PCR-%02d: ", i);
239 for (j = 0; j < TPM_DIGEST_SIZE; j++)
240 str += sprintf(str, "%02X ", *(data + 10 + j));
241 str += sprintf(str, "\n");
246 static DEVICE_ATTR(pcrs, S_IRUGO, show_pcrs, NULL);
248 #define READ_PUBEK_RESULT_SIZE 314
249 static const u8 readpubek[] = {
250 0, 193, /* TPM_TAG_RQU_COMMAND */
251 0, 0, 0, 30, /* length */
252 0, 0, 0, 124, /* TPM_ORD_ReadPubek */
255 static ssize_t show_pubek(struct device *dev, struct device_attribute *attr, char *buf)
262 struct tpm_chip *chip =
263 pci_get_drvdata(to_pci_dev(dev));
267 data = kmalloc(READ_PUBEK_RESULT_SIZE, GFP_KERNEL);
271 memcpy(data, readpubek, sizeof(readpubek));
272 memset(data + sizeof(readpubek), 0, 20); /* zero nonce */
274 if ((len = tpm_transmit(chip, data, READ_PUBEK_RESULT_SIZE)) <
275 READ_PUBEK_RESULT_SIZE) {
281 ignore header 10 bytes
282 algorithm 32 bits (1 == RSA )
285 parameters (RSA 12->bytes: keybit, #primes, expbit)
288 ignore checksum 20 bytes
293 "Algorithm: %02X %02X %02X %02X\nEncscheme: %02X %02X\n"
294 "Sigscheme: %02X %02X\nParameters: %02X %02X %02X %02X"
295 " %02X %02X %02X %02X %02X %02X %02X %02X\n"
296 "Modulus length: %d\nModulus: \n",
297 data[10], data[11], data[12], data[13], data[14],
298 data[15], data[16], data[17], data[22], data[23],
299 data[24], data[25], data[26], data[27], data[28],
300 data[29], data[30], data[31], data[32], data[33],
301 be32_to_cpu(*((__be32 *) (data + 32))));
303 for (i = 0; i < 256; i++) {
304 str += sprintf(str, "%02X ", data[i + 39]);
305 if ((i + 1) % 16 == 0)
306 str += sprintf(str, "\n");
314 static DEVICE_ATTR(pubek, S_IRUGO, show_pubek, NULL);
316 #define CAP_VER_RESULT_SIZE 18
317 static const u8 cap_version[] = {
318 0, 193, /* TPM_TAG_RQU_COMMAND */
319 0, 0, 0, 18, /* length */
320 0, 0, 0, 101, /* TPM_ORD_GetCapability */
325 #define CAP_MANUFACTURER_RESULT_SIZE 18
326 static const u8 cap_manufacturer[] = {
327 0, 193, /* TPM_TAG_RQU_COMMAND */
328 0, 0, 0, 22, /* length */
329 0, 0, 0, 101, /* TPM_ORD_GetCapability */
335 static ssize_t show_caps(struct device *dev, struct device_attribute *attr, char *buf)
337 u8 data[sizeof(cap_manufacturer)];
341 struct tpm_chip *chip =
342 pci_get_drvdata(to_pci_dev(dev));
346 memcpy(data, cap_manufacturer, sizeof(cap_manufacturer));
348 if ((len = tpm_transmit(chip, data, sizeof(data))) <
349 CAP_MANUFACTURER_RESULT_SIZE)
352 str += sprintf(str, "Manufacturer: 0x%x\n",
353 be32_to_cpu(*((__be32 *) (data + 14))));
355 memcpy(data, cap_version, sizeof(cap_version));
357 if ((len = tpm_transmit(chip, data, sizeof(data))) <
362 sprintf(str, "TCG version: %d.%d\nFirmware version: %d.%d\n",
363 (int) data[14], (int) data[15], (int) data[16],
369 static DEVICE_ATTR(caps, S_IRUGO, show_caps, NULL);
372 * Device file system interface to the TPM
374 int tpm_open(struct inode *inode, struct file *file)
376 int rc = 0, minor = iminor(inode);
377 struct tpm_chip *chip = NULL, *pos;
379 spin_lock(&driver_lock);
381 list_for_each_entry(pos, &tpm_chip_list, list) {
382 if (pos->vendor->miscdev.minor == minor) {
393 if (chip->num_opens) {
394 dev_dbg(&chip->pci_dev->dev,
395 "Another process owns this TPM\n");
401 pci_dev_get(chip->pci_dev);
403 spin_unlock(&driver_lock);
405 chip->data_buffer = kmalloc(TPM_BUFSIZE * sizeof(u8), GFP_KERNEL);
406 if (chip->data_buffer == NULL) {
408 pci_dev_put(chip->pci_dev);
412 atomic_set(&chip->data_pending, 0);
414 file->private_data = chip;
418 spin_unlock(&driver_lock);
422 EXPORT_SYMBOL_GPL(tpm_open);
424 int tpm_release(struct inode *inode, struct file *file)
426 struct tpm_chip *chip = file->private_data;
428 file->private_data = NULL;
430 spin_lock(&driver_lock);
432 del_singleshot_timer_sync(&chip->user_read_timer);
433 atomic_set(&chip->data_pending, 0);
435 pci_dev_put(chip->pci_dev);
439 EXPORT_SYMBOL_GPL(tpm_release);
441 ssize_t tpm_write(struct file * file, const char __user * buf,
442 size_t size, loff_t * off)
444 struct tpm_chip *chip = file->private_data;
445 int in_size = size, out_size;
447 /* cannot perform a write until the read has cleared
448 either via tpm_read or a user_read_timer timeout */
449 while (atomic_read(&chip->data_pending) != 0)
452 down(&chip->buffer_mutex);
454 if (in_size > TPM_BUFSIZE)
455 in_size = TPM_BUFSIZE;
458 (chip->data_buffer, (void __user *) buf, in_size)) {
459 up(&chip->buffer_mutex);
463 /* atomic tpm command send and result receive */
464 out_size = tpm_transmit(chip, chip->data_buffer, TPM_BUFSIZE);
466 atomic_set(&chip->data_pending, out_size);
467 up(&chip->buffer_mutex);
469 /* Set a timeout by which the reader must come claim the result */
470 mod_timer(&chip->user_read_timer, jiffies + (60 * HZ));
475 EXPORT_SYMBOL_GPL(tpm_write);
477 ssize_t tpm_read(struct file * file, char __user * buf,
478 size_t size, loff_t * off)
480 struct tpm_chip *chip = file->private_data;
483 del_singleshot_timer_sync(&chip->user_read_timer);
484 ret_size = atomic_read(&chip->data_pending);
485 atomic_set(&chip->data_pending, 0);
486 if (ret_size > 0) { /* relay data */
490 down(&chip->buffer_mutex);
492 ((void __user *) buf, chip->data_buffer, ret_size))
494 up(&chip->buffer_mutex);
500 EXPORT_SYMBOL_GPL(tpm_read);
502 void __devexit tpm_remove(struct pci_dev *pci_dev)
504 struct tpm_chip *chip = pci_get_drvdata(pci_dev);
507 dev_err(&pci_dev->dev, "No device data found\n");
511 spin_lock(&driver_lock);
513 list_del(&chip->list);
515 spin_unlock(&driver_lock);
517 pci_set_drvdata(pci_dev, NULL);
518 misc_deregister(&chip->vendor->miscdev);
520 device_remove_file(&pci_dev->dev, &dev_attr_pubek);
521 device_remove_file(&pci_dev->dev, &dev_attr_pcrs);
522 device_remove_file(&pci_dev->dev, &dev_attr_caps);
524 pci_disable_device(pci_dev);
526 dev_mask[chip->dev_num / TPM_NUM_MASK_ENTRIES ] &= !(1 << (chip->dev_num % TPM_NUM_MASK_ENTRIES));
530 pci_dev_put(pci_dev);
533 EXPORT_SYMBOL_GPL(tpm_remove);
535 static u8 savestate[] = {
536 0, 193, /* TPM_TAG_RQU_COMMAND */
537 0, 0, 0, 10, /* blob length (in bytes) */
538 0, 0, 0, 152 /* TPM_ORD_SaveState */
542 * We are about to suspend. Save the TPM state
543 * so that it can be restored.
545 int tpm_pm_suspend(struct pci_dev *pci_dev, pm_message_t pm_state)
547 struct tpm_chip *chip = pci_get_drvdata(pci_dev);
551 tpm_transmit(chip, savestate, sizeof(savestate));
555 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
558 * Resume from a power safe. The BIOS already restored
561 int tpm_pm_resume(struct pci_dev *pci_dev)
563 struct tpm_chip *chip = pci_get_drvdata(pci_dev);
568 spin_lock(&driver_lock);
569 tpm_lpc_bus_init(pci_dev, chip->vendor->base);
570 spin_unlock(&driver_lock);
575 EXPORT_SYMBOL_GPL(tpm_pm_resume);
578 * Called from tpm_<specific>.c probe function only for devices
579 * the driver has determined it should claim. Prior to calling
580 * this function the specific probe function has called pci_enable_device
581 * upon errant exit from this function specific probe function should call
584 int tpm_register_hardware(struct pci_dev *pci_dev,
585 struct tpm_vendor_specific *entry)
588 struct tpm_chip *chip;
591 /* Driver specific per-device data */
592 chip = kmalloc(sizeof(*chip), GFP_KERNEL);
596 memset(chip, 0, sizeof(struct tpm_chip));
598 init_MUTEX(&chip->buffer_mutex);
599 init_MUTEX(&chip->tpm_mutex);
600 INIT_LIST_HEAD(&chip->list);
602 init_timer(&chip->user_read_timer);
603 chip->user_read_timer.function = user_reader_timeout;
604 chip->user_read_timer.data = (unsigned long) chip;
606 chip->vendor = entry;
610 for (i = 0; i < TPM_NUM_MASK_ENTRIES; i++)
611 for (j = 0; j < 8 * sizeof(int); j++)
612 if ((dev_mask[i] & (1 << j)) == 0) {
614 i * TPM_NUM_MASK_ENTRIES + j;
615 dev_mask[i] |= 1 << j;
616 goto dev_num_search_complete;
619 dev_num_search_complete:
620 if (chip->dev_num < 0) {
621 dev_err(&pci_dev->dev,
622 "No available tpm device numbers\n");
625 } else if (chip->dev_num == 0)
626 chip->vendor->miscdev.minor = TPM_MINOR;
628 chip->vendor->miscdev.minor = MISC_DYNAMIC_MINOR;
630 snprintf(devname, sizeof(devname), "%s%d", "tpm", chip->dev_num);
631 chip->vendor->miscdev.name = devname;
633 chip->vendor->miscdev.dev = &(pci_dev->dev);
634 chip->pci_dev = pci_dev_get(pci_dev);
636 if (misc_register(&chip->vendor->miscdev)) {
637 dev_err(&chip->pci_dev->dev,
638 "unable to misc_register %s, minor %d\n",
639 chip->vendor->miscdev.name,
640 chip->vendor->miscdev.minor);
641 pci_dev_put(pci_dev);
643 dev_mask[i] &= !(1 << j);
647 pci_set_drvdata(pci_dev, chip);
649 list_add(&chip->list, &tpm_chip_list);
651 device_create_file(&pci_dev->dev, &dev_attr_pubek);
652 device_create_file(&pci_dev->dev, &dev_attr_pcrs);
653 device_create_file(&pci_dev->dev, &dev_attr_caps);
658 EXPORT_SYMBOL_GPL(tpm_register_hardware);
660 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
661 MODULE_DESCRIPTION("TPM Driver");
662 MODULE_VERSION("2.0");
663 MODULE_LICENSE("GPL");