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,
149 native_size = (__force __be32 *) (buf + 2);
150 count = be32_to_cpu(*native_size);
154 if (count > bufsiz) {
155 dev_err(&chip->pci_dev->dev,
156 "invalid count value %x %zx \n", count, bufsiz);
160 down(&chip->tpm_mutex);
162 if ((len = chip->vendor->send(chip, (u8 *) buf, count)) < 0) {
163 dev_err(&chip->pci_dev->dev,
164 "tpm_transmit: tpm_send: error %zd\n", len);
168 stop = jiffies + 2 * 60 * HZ;
170 u8 status = inb(chip->vendor->base + 1);
171 if ((status & chip->vendor->req_complete_mask) ==
172 chip->vendor->req_complete_val) {
175 msleep(TPM_TIMEOUT); /* CHECK */
177 } while (time_before(jiffies, stop));
180 chip->vendor->cancel(chip);
181 dev_err(&chip->pci_dev->dev, "Time expired\n");
182 up(&chip->tpm_mutex);
186 len = chip->vendor->recv(chip, (u8 *) buf, bufsiz);
188 dev_err(&chip->pci_dev->dev,
189 "tpm_transmit: tpm_recv: error %zd\n", len);
190 up(&chip->tpm_mutex);
194 #define TPM_DIGEST_SIZE 20
195 #define CAP_PCR_RESULT_SIZE 18
196 static const u8 cap_pcr[] = {
197 0, 193, /* TPM_TAG_RQU_COMMAND */
198 0, 0, 0, 22, /* length */
199 0, 0, 0, 101, /* TPM_ORD_GetCapability */
205 #define READ_PCR_RESULT_SIZE 30
206 static const u8 pcrread[] = {
207 0, 193, /* TPM_TAG_RQU_COMMAND */
208 0, 0, 0, 14, /* length */
209 0, 0, 0, 21, /* TPM_ORD_PcrRead */
210 0, 0, 0, 0 /* PCR index */
213 static ssize_t show_pcrs(struct device *dev, struct device_attribute *attr, char *buf)
215 u8 data[READ_PCR_RESULT_SIZE];
217 int i, j, index, num_pcrs;
220 struct tpm_chip *chip =
221 pci_get_drvdata(container_of(dev, struct pci_dev, dev));
225 memcpy(data, cap_pcr, sizeof(cap_pcr));
226 if ((len = tpm_transmit(chip, data, sizeof(data)))
227 < CAP_PCR_RESULT_SIZE)
230 num_pcrs = be32_to_cpu(*((__force __be32 *) (data + 14)));
232 for (i = 0; i < num_pcrs; i++) {
233 memcpy(data, pcrread, sizeof(pcrread));
234 index = cpu_to_be32(i);
235 memcpy(data + 10, &index, 4);
236 if ((len = tpm_transmit(chip, data, sizeof(data)))
237 < READ_PCR_RESULT_SIZE)
239 str += sprintf(str, "PCR-%02d: ", i);
240 for (j = 0; j < TPM_DIGEST_SIZE; j++)
241 str += sprintf(str, "%02X ", *(data + 10 + j));
242 str += sprintf(str, "\n");
247 static DEVICE_ATTR(pcrs, S_IRUGO, show_pcrs, NULL);
249 #define READ_PUBEK_RESULT_SIZE 314
250 static const u8 readpubek[] = {
251 0, 193, /* TPM_TAG_RQU_COMMAND */
252 0, 0, 0, 30, /* length */
253 0, 0, 0, 124, /* TPM_ORD_ReadPubek */
256 static ssize_t show_pubek(struct device *dev, struct device_attribute *attr, char *buf)
264 struct tpm_chip *chip =
265 pci_get_drvdata(container_of(dev, struct pci_dev, dev));
269 data = kmalloc(READ_PUBEK_RESULT_SIZE, GFP_KERNEL);
273 memcpy(data, readpubek, sizeof(readpubek));
274 memset(data + sizeof(readpubek), 0, 20); /* zero nonce */
276 if ((len = tpm_transmit(chip, data, READ_PUBEK_RESULT_SIZE)) <
277 READ_PUBEK_RESULT_SIZE) {
283 ignore header 10 bytes
284 algorithm 32 bits (1 == RSA )
287 parameters (RSA 12->bytes: keybit, #primes, expbit)
290 ignore checksum 20 bytes
293 native_val = (__force __be32 *) (data + 34);
297 "Algorithm: %02X %02X %02X %02X\nEncscheme: %02X %02X\n"
298 "Sigscheme: %02X %02X\nParameters: %02X %02X %02X %02X"
299 " %02X %02X %02X %02X %02X %02X %02X %02X\n"
300 "Modulus length: %d\nModulus: \n",
301 data[10], data[11], data[12], data[13], data[14],
302 data[15], data[16], data[17], data[22], data[23],
303 data[24], data[25], data[26], data[27], data[28],
304 data[29], data[30], data[31], data[32], data[33],
305 be32_to_cpu(*native_val)
308 for (i = 0; i < 256; i++) {
309 str += sprintf(str, "%02X ", data[i + 39]);
310 if ((i + 1) % 16 == 0)
311 str += sprintf(str, "\n");
319 static DEVICE_ATTR(pubek, S_IRUGO, show_pubek, NULL);
321 #define CAP_VER_RESULT_SIZE 18
322 static const u8 cap_version[] = {
323 0, 193, /* TPM_TAG_RQU_COMMAND */
324 0, 0, 0, 18, /* length */
325 0, 0, 0, 101, /* TPM_ORD_GetCapability */
330 #define CAP_MANUFACTURER_RESULT_SIZE 18
331 static const u8 cap_manufacturer[] = {
332 0, 193, /* TPM_TAG_RQU_COMMAND */
333 0, 0, 0, 22, /* length */
334 0, 0, 0, 101, /* TPM_ORD_GetCapability */
340 static ssize_t show_caps(struct device *dev, struct device_attribute *attr, char *buf)
342 u8 data[sizeof(cap_manufacturer)];
346 struct tpm_chip *chip =
347 pci_get_drvdata(container_of(dev, struct pci_dev, dev));
351 memcpy(data, cap_manufacturer, sizeof(cap_manufacturer));
353 if ((len = tpm_transmit(chip, data, sizeof(data))) <
354 CAP_MANUFACTURER_RESULT_SIZE)
357 str += sprintf(str, "Manufacturer: 0x%x\n",
358 be32_to_cpu(*(data + 14)));
360 memcpy(data, cap_version, sizeof(cap_version));
362 if ((len = tpm_transmit(chip, data, sizeof(data))) <
367 sprintf(str, "TCG version: %d.%d\nFirmware version: %d.%d\n",
368 (int) data[14], (int) data[15], (int) data[16],
374 static DEVICE_ATTR(caps, S_IRUGO, show_caps, NULL);
377 * Device file system interface to the TPM
379 int tpm_open(struct inode *inode, struct file *file)
381 int rc = 0, minor = iminor(inode);
382 struct tpm_chip *chip = NULL, *pos;
384 spin_lock(&driver_lock);
386 list_for_each_entry(pos, &tpm_chip_list, list) {
387 if (pos->vendor->miscdev.minor == minor) {
398 if (chip->num_opens) {
399 dev_dbg(&chip->pci_dev->dev,
400 "Another process owns this TPM\n");
406 pci_dev_get(chip->pci_dev);
408 spin_unlock(&driver_lock);
410 chip->data_buffer = kmalloc(TPM_BUFSIZE * sizeof(u8), GFP_KERNEL);
411 if (chip->data_buffer == NULL) {
413 pci_dev_put(chip->pci_dev);
417 atomic_set(&chip->data_pending, 0);
419 file->private_data = chip;
423 spin_unlock(&driver_lock);
427 EXPORT_SYMBOL_GPL(tpm_open);
429 int tpm_release(struct inode *inode, struct file *file)
431 struct tpm_chip *chip = file->private_data;
433 file->private_data = NULL;
435 spin_lock(&driver_lock);
437 del_singleshot_timer_sync(&chip->user_read_timer);
438 atomic_set(&chip->data_pending, 0);
440 pci_dev_put(chip->pci_dev);
444 EXPORT_SYMBOL_GPL(tpm_release);
446 ssize_t tpm_write(struct file * file, const char __user * buf,
447 size_t size, loff_t * off)
449 struct tpm_chip *chip = file->private_data;
450 int in_size = size, out_size;
452 /* cannot perform a write until the read has cleared
453 either via tpm_read or a user_read_timer timeout */
454 while (atomic_read(&chip->data_pending) != 0)
457 down(&chip->buffer_mutex);
459 if (in_size > TPM_BUFSIZE)
460 in_size = TPM_BUFSIZE;
463 (chip->data_buffer, (void __user *) buf, in_size)) {
464 up(&chip->buffer_mutex);
468 /* atomic tpm command send and result receive */
469 out_size = tpm_transmit(chip, chip->data_buffer, TPM_BUFSIZE);
471 atomic_set(&chip->data_pending, out_size);
472 up(&chip->buffer_mutex);
474 /* Set a timeout by which the reader must come claim the result */
475 mod_timer(&chip->user_read_timer, jiffies + (60 * HZ));
480 EXPORT_SYMBOL_GPL(tpm_write);
482 ssize_t tpm_read(struct file * file, char __user * buf,
483 size_t size, loff_t * off)
485 struct tpm_chip *chip = file->private_data;
488 del_singleshot_timer_sync(&chip->user_read_timer);
489 ret_size = atomic_read(&chip->data_pending);
490 atomic_set(&chip->data_pending, 0);
491 if (ret_size > 0) { /* relay data */
495 down(&chip->buffer_mutex);
497 ((void __user *) buf, chip->data_buffer, ret_size))
499 up(&chip->buffer_mutex);
505 EXPORT_SYMBOL_GPL(tpm_read);
507 void __devexit tpm_remove(struct pci_dev *pci_dev)
509 struct tpm_chip *chip = pci_get_drvdata(pci_dev);
512 dev_err(&pci_dev->dev, "No device data found\n");
516 spin_lock(&driver_lock);
518 list_del(&chip->list);
520 spin_unlock(&driver_lock);
522 pci_set_drvdata(pci_dev, NULL);
523 misc_deregister(&chip->vendor->miscdev);
525 device_remove_file(&pci_dev->dev, &dev_attr_pubek);
526 device_remove_file(&pci_dev->dev, &dev_attr_pcrs);
527 device_remove_file(&pci_dev->dev, &dev_attr_caps);
529 pci_disable_device(pci_dev);
531 dev_mask[chip->dev_num / TPM_NUM_MASK_ENTRIES ] &= !(1 << (chip->dev_num % TPM_NUM_MASK_ENTRIES));
535 pci_dev_put(pci_dev);
538 EXPORT_SYMBOL_GPL(tpm_remove);
540 static u8 savestate[] = {
541 0, 193, /* TPM_TAG_RQU_COMMAND */
542 0, 0, 0, 10, /* blob length (in bytes) */
543 0, 0, 0, 152 /* TPM_ORD_SaveState */
547 * We are about to suspend. Save the TPM state
548 * so that it can be restored.
550 int tpm_pm_suspend(struct pci_dev *pci_dev, pm_message_t pm_state)
552 struct tpm_chip *chip = pci_get_drvdata(pci_dev);
556 tpm_transmit(chip, savestate, sizeof(savestate));
560 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
563 * Resume from a power safe. The BIOS already restored
566 int tpm_pm_resume(struct pci_dev *pci_dev)
568 struct tpm_chip *chip = pci_get_drvdata(pci_dev);
573 spin_lock(&driver_lock);
574 tpm_lpc_bus_init(pci_dev, chip->vendor->base);
575 spin_unlock(&driver_lock);
580 EXPORT_SYMBOL_GPL(tpm_pm_resume);
583 * Called from tpm_<specific>.c probe function only for devices
584 * the driver has determined it should claim. Prior to calling
585 * this function the specific probe function has called pci_enable_device
586 * upon errant exit from this function specific probe function should call
589 int tpm_register_hardware(struct pci_dev *pci_dev,
590 struct tpm_vendor_specific *entry)
593 struct tpm_chip *chip;
596 /* Driver specific per-device data */
597 chip = kmalloc(sizeof(*chip), GFP_KERNEL);
601 memset(chip, 0, sizeof(struct tpm_chip));
603 init_MUTEX(&chip->buffer_mutex);
604 init_MUTEX(&chip->tpm_mutex);
605 INIT_LIST_HEAD(&chip->list);
607 init_timer(&chip->user_read_timer);
608 chip->user_read_timer.function = user_reader_timeout;
609 chip->user_read_timer.data = (unsigned long) chip;
611 chip->vendor = entry;
615 for (i = 0; i < TPM_NUM_MASK_ENTRIES; i++)
616 for (j = 0; j < 8 * sizeof(int); j++)
617 if ((dev_mask[i] & (1 << j)) == 0) {
619 i * TPM_NUM_MASK_ENTRIES + j;
620 dev_mask[i] |= 1 << j;
621 goto dev_num_search_complete;
624 dev_num_search_complete:
625 if (chip->dev_num < 0) {
626 dev_err(&pci_dev->dev,
627 "No available tpm device numbers\n");
630 } else if (chip->dev_num == 0)
631 chip->vendor->miscdev.minor = TPM_MINOR;
633 chip->vendor->miscdev.minor = MISC_DYNAMIC_MINOR;
635 snprintf(devname, sizeof(devname), "%s%d", "tpm", chip->dev_num);
636 chip->vendor->miscdev.name = devname;
638 chip->vendor->miscdev.dev = &(pci_dev->dev);
639 chip->pci_dev = pci_dev_get(pci_dev);
641 if (misc_register(&chip->vendor->miscdev)) {
642 dev_err(&chip->pci_dev->dev,
643 "unable to misc_register %s, minor %d\n",
644 chip->vendor->miscdev.name,
645 chip->vendor->miscdev.minor);
646 pci_dev_put(pci_dev);
648 dev_mask[i] &= !(1 << j);
652 pci_set_drvdata(pci_dev, chip);
654 list_add(&chip->list, &tpm_chip_list);
656 device_create_file(&pci_dev->dev, &dev_attr_pubek);
657 device_create_file(&pci_dev->dev, &dev_attr_pcrs);
658 device_create_file(&pci_dev->dev, &dev_attr_caps);
663 EXPORT_SYMBOL_GPL(tpm_register_hardware);
665 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
666 MODULE_DESCRIPTION("TPM Driver");
667 MODULE_VERSION("2.0");
668 MODULE_LICENSE("GPL");