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/poll.h>
27 #include <linux/slab.h>
28 #include <linux/mutex.h>
29 #include <linux/spinlock.h>
34 TPM_MINOR = 224, /* officially assigned */
36 TPM_NUM_DEVICES = 256,
46 #define TPM_MAX_ORDINAL 243
47 #define TPM_MAX_PROTECTED_ORDINAL 12
48 #define TPM_PROTECTED_ORDINAL_MASK 0xFF
51 * Bug workaround - some TPM's don't flush the most
52 * recently changed pcr on suspend, so force the flush
53 * with an extend to the selected _unused_ non-volatile pcr.
55 static int tpm_suspend_pcr;
56 module_param_named(suspend_pcr, tpm_suspend_pcr, uint, 0644);
57 MODULE_PARM_DESC(suspend_pcr,
58 "PCR to use for dummy writes to faciltate flush on suspend.");
60 static LIST_HEAD(tpm_chip_list);
61 static DEFINE_SPINLOCK(driver_lock);
62 static DECLARE_BITMAP(dev_mask, TPM_NUM_DEVICES);
65 * Array with one entry per ordinal defining the maximum amount
66 * of time the chip could take to return the result. The ordinal
67 * designation of short, medium or long is defined in a table in
68 * TCG Specification TPM Main Part 2 TPM Structures Section 17. The
69 * values of the SHORT, MEDIUM, and LONG durations are retrieved
70 * from the chip during initialization with a call to tpm_get_timeouts.
72 static const u8 tpm_protected_ordinal_duration[TPM_MAX_PROTECTED_ORDINAL] = {
73 TPM_UNDEFINED, /* 0 */
78 TPM_UNDEFINED, /* 5 */
87 static const u8 tpm_ordinal_duration[TPM_MAX_ORDINAL] = {
88 TPM_UNDEFINED, /* 0 */
93 TPM_UNDEFINED, /* 5 */
143 TPM_UNDEFINED, /* 55 */
163 TPM_UNDEFINED, /* 75 */
173 TPM_UNDEFINED, /* 85 */
183 TPM_UNDEFINED, /* 95 */
188 TPM_MEDIUM, /* 100 */
193 TPM_UNDEFINED, /* 105 */
223 TPM_UNDEFINED, /* 135 */
233 TPM_UNDEFINED, /* 145 */
243 TPM_UNDEFINED, /* 155 */
253 TPM_UNDEFINED, /* 165 */
263 TPM_UNDEFINED, /* 175 */
268 TPM_MEDIUM, /* 180 */
273 TPM_MEDIUM, /* 185 */
278 TPM_UNDEFINED, /* 190 */
283 TPM_UNDEFINED, /* 195 */
298 TPM_MEDIUM, /* 210 */
303 TPM_UNDEFINED, /* 215 */
313 TPM_UNDEFINED, /* 225 */
323 TPM_UNDEFINED, /* 235 */
333 static void user_reader_timeout(unsigned long ptr)
335 struct tpm_chip *chip = (struct tpm_chip *) ptr;
337 schedule_work(&chip->work);
340 static void timeout_work(struct work_struct *work)
342 struct tpm_chip *chip = container_of(work, struct tpm_chip, work);
344 mutex_lock(&chip->buffer_mutex);
345 atomic_set(&chip->data_pending, 0);
346 memset(chip->data_buffer, 0, TPM_BUFSIZE);
347 mutex_unlock(&chip->buffer_mutex);
351 * Returns max number of jiffies to wait
353 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip,
356 int duration_idx = TPM_UNDEFINED;
359 if (ordinal < TPM_MAX_ORDINAL)
360 duration_idx = tpm_ordinal_duration[ordinal];
361 else if ((ordinal & TPM_PROTECTED_ORDINAL_MASK) <
362 TPM_MAX_PROTECTED_ORDINAL)
364 tpm_protected_ordinal_duration[ordinal &
365 TPM_PROTECTED_ORDINAL_MASK];
367 if (duration_idx != TPM_UNDEFINED) {
368 duration = chip->vendor.duration[duration_idx];
369 /* if duration is 0, it's because chip->vendor.duration wasn't */
370 /* filled yet, so we set the lowest timeout just to give enough */
371 /* time for tpm_get_timeouts() to succeed */
372 return (duration <= 0 ? HZ : duration);
376 EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration);
379 * Internal kernel interface to transmit TPM commands
381 static ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
388 count = be32_to_cpu(*((__be32 *) (buf + 2)));
389 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
392 if (count > bufsiz) {
394 "invalid count value %x %zx \n", count, bufsiz);
398 mutex_lock(&chip->tpm_mutex);
400 if ((rc = chip->vendor.send(chip, (u8 *) buf, count)) < 0) {
402 "tpm_transmit: tpm_send: error %zd\n", rc);
406 if (chip->vendor.irq)
409 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
411 u8 status = chip->vendor.status(chip);
412 if ((status & chip->vendor.req_complete_mask) ==
413 chip->vendor.req_complete_val)
416 if ((status == chip->vendor.req_canceled)) {
417 dev_err(chip->dev, "Operation Canceled\n");
422 msleep(TPM_TIMEOUT); /* CHECK */
424 } while (time_before(jiffies, stop));
426 chip->vendor.cancel(chip);
427 dev_err(chip->dev, "Operation Timed out\n");
432 rc = chip->vendor.recv(chip, (u8 *) buf, bufsiz);
435 "tpm_transmit: tpm_recv: error %zd\n", rc);
437 mutex_unlock(&chip->tpm_mutex);
441 #define TPM_DIGEST_SIZE 20
442 #define TPM_ERROR_SIZE 10
443 #define TPM_RET_CODE_IDX 6
445 enum tpm_capabilities {
446 TPM_CAP_FLAG = cpu_to_be32(4),
447 TPM_CAP_PROP = cpu_to_be32(5),
448 CAP_VERSION_1_1 = cpu_to_be32(0x06),
449 CAP_VERSION_1_2 = cpu_to_be32(0x1A)
452 enum tpm_sub_capabilities {
453 TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
454 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
455 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
456 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
457 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
458 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
459 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
463 static ssize_t transmit_cmd(struct tpm_chip *chip, struct tpm_cmd_t *cmd,
464 int len, const char *desc)
468 len = tpm_transmit(chip,(u8 *) cmd, len);
471 if (len == TPM_ERROR_SIZE) {
472 err = be32_to_cpu(cmd->header.out.return_code);
473 dev_dbg(chip->dev, "A TPM error (%d) occurred %s\n", err, desc);
479 #define TPM_INTERNAL_RESULT_SIZE 200
480 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
481 #define TPM_ORD_GET_CAP cpu_to_be32(101)
483 static const struct tpm_input_header tpm_getcap_header = {
484 .tag = TPM_TAG_RQU_COMMAND,
485 .length = cpu_to_be32(22),
486 .ordinal = TPM_ORD_GET_CAP
489 ssize_t tpm_getcap(struct device *dev, __be32 subcap_id, cap_t *cap,
492 struct tpm_cmd_t tpm_cmd;
494 struct tpm_chip *chip = dev_get_drvdata(dev);
496 tpm_cmd.header.in = tpm_getcap_header;
497 if (subcap_id == CAP_VERSION_1_1 || subcap_id == CAP_VERSION_1_2) {
498 tpm_cmd.params.getcap_in.cap = subcap_id;
499 /*subcap field not necessary */
500 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(0);
501 tpm_cmd.header.in.length -= cpu_to_be32(sizeof(__be32));
503 if (subcap_id == TPM_CAP_FLAG_PERM ||
504 subcap_id == TPM_CAP_FLAG_VOL)
505 tpm_cmd.params.getcap_in.cap = TPM_CAP_FLAG;
507 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
508 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
509 tpm_cmd.params.getcap_in.subcap = subcap_id;
511 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, desc);
513 *cap = tpm_cmd.params.getcap_out.cap;
517 void tpm_gen_interrupt(struct tpm_chip *chip)
519 struct tpm_cmd_t tpm_cmd;
522 tpm_cmd.header.in = tpm_getcap_header;
523 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
524 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
525 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
527 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
528 "attempting to determine the timeouts");
530 EXPORT_SYMBOL_GPL(tpm_gen_interrupt);
532 void tpm_get_timeouts(struct tpm_chip *chip)
534 struct tpm_cmd_t tpm_cmd;
535 struct timeout_t *timeout_cap;
536 struct duration_t *duration_cap;
540 tpm_cmd.header.in = tpm_getcap_header;
541 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
542 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
543 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
545 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
546 "attempting to determine the timeouts");
550 if (be32_to_cpu(tpm_cmd.header.out.length)
554 timeout_cap = &tpm_cmd.params.getcap_out.cap.timeout;
555 /* Don't overwrite default if value is 0 */
556 timeout = be32_to_cpu(timeout_cap->a);
558 chip->vendor.timeout_a = usecs_to_jiffies(timeout);
559 timeout = be32_to_cpu(timeout_cap->b);
561 chip->vendor.timeout_b = usecs_to_jiffies(timeout);
562 timeout = be32_to_cpu(timeout_cap->c);
564 chip->vendor.timeout_c = usecs_to_jiffies(timeout);
565 timeout = be32_to_cpu(timeout_cap->d);
567 chip->vendor.timeout_d = usecs_to_jiffies(timeout);
570 tpm_cmd.header.in = tpm_getcap_header;
571 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
572 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
573 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_DURATION;
575 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
576 "attempting to determine the durations");
580 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
581 be32_to_cpu(tpm_cmd.header.out.length)
582 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 3 * sizeof(u32))
585 duration_cap = &tpm_cmd.params.getcap_out.cap.duration;
586 chip->vendor.duration[TPM_SHORT] =
587 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_short));
588 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
589 * value wrong and apparently reports msecs rather than usecs. So we
590 * fix up the resulting too-small TPM_SHORT value to make things work.
592 if (chip->vendor.duration[TPM_SHORT] < (HZ/100))
593 chip->vendor.duration[TPM_SHORT] = HZ;
595 chip->vendor.duration[TPM_MEDIUM] =
596 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_medium));
597 chip->vendor.duration[TPM_LONG] =
598 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_long));
600 EXPORT_SYMBOL_GPL(tpm_get_timeouts);
602 void tpm_continue_selftest(struct tpm_chip *chip)
605 0, 193, /* TPM_TAG_RQU_COMMAND */
606 0, 0, 0, 10, /* length */
607 0, 0, 0, 83, /* TPM_ORD_GetCapability */
610 tpm_transmit(chip, data, sizeof(data));
612 EXPORT_SYMBOL_GPL(tpm_continue_selftest);
614 ssize_t tpm_show_enabled(struct device * dev, struct device_attribute * attr,
620 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
621 "attempting to determine the permanent enabled state");
625 rc = sprintf(buf, "%d\n", !cap.perm_flags.disable);
628 EXPORT_SYMBOL_GPL(tpm_show_enabled);
630 ssize_t tpm_show_active(struct device * dev, struct device_attribute * attr,
636 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
637 "attempting to determine the permanent active state");
641 rc = sprintf(buf, "%d\n", !cap.perm_flags.deactivated);
644 EXPORT_SYMBOL_GPL(tpm_show_active);
646 ssize_t tpm_show_owned(struct device * dev, struct device_attribute * attr,
652 rc = tpm_getcap(dev, TPM_CAP_PROP_OWNER, &cap,
653 "attempting to determine the owner state");
657 rc = sprintf(buf, "%d\n", cap.owned);
660 EXPORT_SYMBOL_GPL(tpm_show_owned);
662 ssize_t tpm_show_temp_deactivated(struct device * dev,
663 struct device_attribute * attr, char *buf)
668 rc = tpm_getcap(dev, TPM_CAP_FLAG_VOL, &cap,
669 "attempting to determine the temporary state");
673 rc = sprintf(buf, "%d\n", cap.stclear_flags.deactivated);
676 EXPORT_SYMBOL_GPL(tpm_show_temp_deactivated);
679 * tpm_chip_find_get - return tpm_chip for given chip number
681 static struct tpm_chip *tpm_chip_find_get(int chip_num)
683 struct tpm_chip *pos, *chip = NULL;
686 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
687 if (chip_num != TPM_ANY_NUM && chip_num != pos->dev_num)
690 if (try_module_get(pos->dev->driver->owner)) {
699 #define TPM_ORDINAL_PCRREAD cpu_to_be32(21)
700 #define READ_PCR_RESULT_SIZE 30
701 static struct tpm_input_header pcrread_header = {
702 .tag = TPM_TAG_RQU_COMMAND,
703 .length = cpu_to_be32(14),
704 .ordinal = TPM_ORDINAL_PCRREAD
707 int __tpm_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
710 struct tpm_cmd_t cmd;
712 cmd.header.in = pcrread_header;
713 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
714 rc = transmit_cmd(chip, &cmd, READ_PCR_RESULT_SIZE,
715 "attempting to read a pcr value");
718 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
724 * tpm_pcr_read - read a pcr value
725 * @chip_num: tpm idx # or ANY
726 * @pcr_idx: pcr idx to retrieve
727 * @res_buf: TPM_PCR value
728 * size of res_buf is 20 bytes (or NULL if you don't care)
730 * The TPM driver should be built-in, but for whatever reason it
731 * isn't, protect against the chip disappearing, by incrementing
732 * the module usage count.
734 int tpm_pcr_read(u32 chip_num, int pcr_idx, u8 *res_buf)
736 struct tpm_chip *chip;
739 chip = tpm_chip_find_get(chip_num);
742 rc = __tpm_pcr_read(chip, pcr_idx, res_buf);
746 EXPORT_SYMBOL_GPL(tpm_pcr_read);
749 * tpm_pcr_extend - extend pcr value with hash
750 * @chip_num: tpm idx # or AN&
751 * @pcr_idx: pcr idx to extend
752 * @hash: hash value used to extend pcr value
754 * The TPM driver should be built-in, but for whatever reason it
755 * isn't, protect against the chip disappearing, by incrementing
756 * the module usage count.
758 #define TPM_ORD_PCR_EXTEND cpu_to_be32(20)
759 #define EXTEND_PCR_RESULT_SIZE 34
760 static struct tpm_input_header pcrextend_header = {
761 .tag = TPM_TAG_RQU_COMMAND,
762 .length = cpu_to_be32(34),
763 .ordinal = TPM_ORD_PCR_EXTEND
766 int tpm_pcr_extend(u32 chip_num, int pcr_idx, const u8 *hash)
768 struct tpm_cmd_t cmd;
770 struct tpm_chip *chip;
772 chip = tpm_chip_find_get(chip_num);
776 cmd.header.in = pcrextend_header;
777 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(pcr_idx);
778 memcpy(cmd.params.pcrextend_in.hash, hash, TPM_DIGEST_SIZE);
779 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
780 "attempting extend a PCR value");
785 EXPORT_SYMBOL_GPL(tpm_pcr_extend);
787 int tpm_send(u32 chip_num, void *cmd, size_t buflen)
789 struct tpm_chip *chip;
792 chip = tpm_chip_find_get(chip_num);
796 rc = transmit_cmd(chip, cmd, buflen, "attempting tpm_cmd");
801 EXPORT_SYMBOL_GPL(tpm_send);
803 ssize_t tpm_show_pcrs(struct device *dev, struct device_attribute *attr,
807 u8 digest[TPM_DIGEST_SIZE];
811 struct tpm_chip *chip = dev_get_drvdata(dev);
813 rc = tpm_getcap(dev, TPM_CAP_PROP_PCR, &cap,
814 "attempting to determine the number of PCRS");
818 num_pcrs = be32_to_cpu(cap.num_pcrs);
819 for (i = 0; i < num_pcrs; i++) {
820 rc = __tpm_pcr_read(chip, i, digest);
823 str += sprintf(str, "PCR-%02d: ", i);
824 for (j = 0; j < TPM_DIGEST_SIZE; j++)
825 str += sprintf(str, "%02X ", digest[j]);
826 str += sprintf(str, "\n");
830 EXPORT_SYMBOL_GPL(tpm_show_pcrs);
832 #define READ_PUBEK_RESULT_SIZE 314
833 #define TPM_ORD_READPUBEK cpu_to_be32(124)
834 struct tpm_input_header tpm_readpubek_header = {
835 .tag = TPM_TAG_RQU_COMMAND,
836 .length = cpu_to_be32(30),
837 .ordinal = TPM_ORD_READPUBEK
840 ssize_t tpm_show_pubek(struct device *dev, struct device_attribute *attr,
844 struct tpm_cmd_t tpm_cmd;
849 struct tpm_chip *chip = dev_get_drvdata(dev);
851 tpm_cmd.header.in = tpm_readpubek_header;
852 err = transmit_cmd(chip, &tpm_cmd, READ_PUBEK_RESULT_SIZE,
853 "attempting to read the PUBEK");
858 ignore header 10 bytes
859 algorithm 32 bits (1 == RSA )
862 parameters (RSA 12->bytes: keybit, #primes, expbit)
865 ignore checksum 20 bytes
867 data = tpm_cmd.params.readpubek_out_buffer;
870 "Algorithm: %02X %02X %02X %02X\nEncscheme: %02X %02X\n"
871 "Sigscheme: %02X %02X\nParameters: %02X %02X %02X %02X"
872 " %02X %02X %02X %02X %02X %02X %02X %02X\n"
873 "Modulus length: %d\nModulus: \n",
874 data[10], data[11], data[12], data[13], data[14],
875 data[15], data[16], data[17], data[22], data[23],
876 data[24], data[25], data[26], data[27], data[28],
877 data[29], data[30], data[31], data[32], data[33],
878 be32_to_cpu(*((__be32 *) (data + 34))));
880 for (i = 0; i < 256; i++) {
881 str += sprintf(str, "%02X ", data[i + 38]);
882 if ((i + 1) % 16 == 0)
883 str += sprintf(str, "\n");
889 EXPORT_SYMBOL_GPL(tpm_show_pubek);
892 ssize_t tpm_show_caps(struct device *dev, struct device_attribute *attr,
899 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
900 "attempting to determine the manufacturer");
903 str += sprintf(str, "Manufacturer: 0x%x\n",
904 be32_to_cpu(cap.manufacturer_id));
906 rc = tpm_getcap(dev, CAP_VERSION_1_1, &cap,
907 "attempting to determine the 1.1 version");
911 "TCG version: %d.%d\nFirmware version: %d.%d\n",
912 cap.tpm_version.Major, cap.tpm_version.Minor,
913 cap.tpm_version.revMajor, cap.tpm_version.revMinor);
916 EXPORT_SYMBOL_GPL(tpm_show_caps);
918 ssize_t tpm_show_caps_1_2(struct device * dev,
919 struct device_attribute * attr, char *buf)
925 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
926 "attempting to determine the manufacturer");
929 str += sprintf(str, "Manufacturer: 0x%x\n",
930 be32_to_cpu(cap.manufacturer_id));
931 rc = tpm_getcap(dev, CAP_VERSION_1_2, &cap,
932 "attempting to determine the 1.2 version");
936 "TCG version: %d.%d\nFirmware version: %d.%d\n",
937 cap.tpm_version_1_2.Major, cap.tpm_version_1_2.Minor,
938 cap.tpm_version_1_2.revMajor,
939 cap.tpm_version_1_2.revMinor);
942 EXPORT_SYMBOL_GPL(tpm_show_caps_1_2);
944 ssize_t tpm_show_timeouts(struct device *dev, struct device_attribute *attr,
947 struct tpm_chip *chip = dev_get_drvdata(dev);
949 return sprintf(buf, "%d %d %d\n",
950 jiffies_to_usecs(chip->vendor.duration[TPM_SHORT]),
951 jiffies_to_usecs(chip->vendor.duration[TPM_MEDIUM]),
952 jiffies_to_usecs(chip->vendor.duration[TPM_LONG]));
954 EXPORT_SYMBOL_GPL(tpm_show_timeouts);
956 ssize_t tpm_store_cancel(struct device *dev, struct device_attribute *attr,
957 const char *buf, size_t count)
959 struct tpm_chip *chip = dev_get_drvdata(dev);
963 chip->vendor.cancel(chip);
966 EXPORT_SYMBOL_GPL(tpm_store_cancel);
969 * Device file system interface to the TPM
971 * It's assured that the chip will be opened just once,
972 * by the check of is_open variable, which is protected
975 int tpm_open(struct inode *inode, struct file *file)
977 int minor = iminor(inode);
978 struct tpm_chip *chip = NULL, *pos;
981 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
982 if (pos->vendor.miscdev.minor == minor) {
984 get_device(chip->dev);
993 if (test_and_set_bit(0, &chip->is_open)) {
994 dev_dbg(chip->dev, "Another process owns this TPM\n");
995 put_device(chip->dev);
999 chip->data_buffer = kmalloc(TPM_BUFSIZE * sizeof(u8), GFP_KERNEL);
1000 if (chip->data_buffer == NULL) {
1001 clear_bit(0, &chip->is_open);
1002 put_device(chip->dev);
1006 atomic_set(&chip->data_pending, 0);
1008 file->private_data = chip;
1011 EXPORT_SYMBOL_GPL(tpm_open);
1014 * Called on file close
1016 int tpm_release(struct inode *inode, struct file *file)
1018 struct tpm_chip *chip = file->private_data;
1020 del_singleshot_timer_sync(&chip->user_read_timer);
1021 flush_work_sync(&chip->work);
1022 file->private_data = NULL;
1023 atomic_set(&chip->data_pending, 0);
1024 kfree(chip->data_buffer);
1025 clear_bit(0, &chip->is_open);
1026 put_device(chip->dev);
1029 EXPORT_SYMBOL_GPL(tpm_release);
1031 ssize_t tpm_write(struct file *file, const char __user *buf,
1032 size_t size, loff_t *off)
1034 struct tpm_chip *chip = file->private_data;
1035 size_t in_size = size, out_size;
1037 /* cannot perform a write until the read has cleared
1038 either via tpm_read or a user_read_timer timeout */
1039 while (atomic_read(&chip->data_pending) != 0)
1040 msleep(TPM_TIMEOUT);
1042 mutex_lock(&chip->buffer_mutex);
1044 if (in_size > TPM_BUFSIZE)
1045 in_size = TPM_BUFSIZE;
1048 (chip->data_buffer, (void __user *) buf, in_size)) {
1049 mutex_unlock(&chip->buffer_mutex);
1053 /* atomic tpm command send and result receive */
1054 out_size = tpm_transmit(chip, chip->data_buffer, TPM_BUFSIZE);
1056 atomic_set(&chip->data_pending, out_size);
1057 mutex_unlock(&chip->buffer_mutex);
1059 /* Set a timeout by which the reader must come claim the result */
1060 mod_timer(&chip->user_read_timer, jiffies + (60 * HZ));
1064 EXPORT_SYMBOL_GPL(tpm_write);
1066 ssize_t tpm_read(struct file *file, char __user *buf,
1067 size_t size, loff_t *off)
1069 struct tpm_chip *chip = file->private_data;
1072 del_singleshot_timer_sync(&chip->user_read_timer);
1073 flush_work_sync(&chip->work);
1074 ret_size = atomic_read(&chip->data_pending);
1075 atomic_set(&chip->data_pending, 0);
1076 if (ret_size > 0) { /* relay data */
1077 if (size < ret_size)
1080 mutex_lock(&chip->buffer_mutex);
1081 if (copy_to_user(buf, chip->data_buffer, ret_size))
1083 mutex_unlock(&chip->buffer_mutex);
1088 EXPORT_SYMBOL_GPL(tpm_read);
1090 void tpm_remove_hardware(struct device *dev)
1092 struct tpm_chip *chip = dev_get_drvdata(dev);
1095 dev_err(dev, "No device data found\n");
1099 spin_lock(&driver_lock);
1100 list_del_rcu(&chip->list);
1101 spin_unlock(&driver_lock);
1104 misc_deregister(&chip->vendor.miscdev);
1105 sysfs_remove_group(&dev->kobj, chip->vendor.attr_group);
1106 tpm_bios_log_teardown(chip->bios_dir);
1108 /* write it this way to be explicit (chip->dev == dev) */
1109 put_device(chip->dev);
1111 EXPORT_SYMBOL_GPL(tpm_remove_hardware);
1113 #define TPM_ORD_SAVESTATE cpu_to_be32(152)
1114 #define SAVESTATE_RESULT_SIZE 10
1116 static struct tpm_input_header savestate_header = {
1117 .tag = TPM_TAG_RQU_COMMAND,
1118 .length = cpu_to_be32(10),
1119 .ordinal = TPM_ORD_SAVESTATE
1123 * We are about to suspend. Save the TPM state
1124 * so that it can be restored.
1126 int tpm_pm_suspend(struct device *dev, pm_message_t pm_state)
1128 struct tpm_chip *chip = dev_get_drvdata(dev);
1129 struct tpm_cmd_t cmd;
1132 u8 dummy_hash[TPM_DIGEST_SIZE] = { 0 };
1137 /* for buggy tpm, flush pcrs with extend to selected dummy */
1138 if (tpm_suspend_pcr) {
1139 cmd.header.in = pcrextend_header;
1140 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(tpm_suspend_pcr);
1141 memcpy(cmd.params.pcrextend_in.hash, dummy_hash,
1143 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
1144 "extending dummy pcr before suspend");
1147 /* now do the actual savestate */
1148 cmd.header.in = savestate_header;
1149 rc = transmit_cmd(chip, &cmd, SAVESTATE_RESULT_SIZE,
1150 "sending savestate before suspend");
1153 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
1156 * Resume from a power safe. The BIOS already restored
1159 int tpm_pm_resume(struct device *dev)
1161 struct tpm_chip *chip = dev_get_drvdata(dev);
1168 EXPORT_SYMBOL_GPL(tpm_pm_resume);
1170 /* In case vendor provided release function, call it too.*/
1172 void tpm_dev_vendor_release(struct tpm_chip *chip)
1174 if (chip->vendor.release)
1175 chip->vendor.release(chip->dev);
1177 clear_bit(chip->dev_num, dev_mask);
1178 kfree(chip->vendor.miscdev.name);
1180 EXPORT_SYMBOL_GPL(tpm_dev_vendor_release);
1184 * Once all references to platform device are down to 0,
1185 * release all allocated structures.
1187 void tpm_dev_release(struct device *dev)
1189 struct tpm_chip *chip = dev_get_drvdata(dev);
1191 tpm_dev_vendor_release(chip);
1196 EXPORT_SYMBOL_GPL(tpm_dev_release);
1199 * Called from tpm_<specific>.c probe function only for devices
1200 * the driver has determined it should claim. Prior to calling
1201 * this function the specific probe function has called pci_enable_device
1202 * upon errant exit from this function specific probe function should call
1203 * pci_disable_device
1205 struct tpm_chip *tpm_register_hardware(struct device *dev,
1206 const struct tpm_vendor_specific *entry)
1208 #define DEVNAME_SIZE 7
1211 struct tpm_chip *chip;
1213 /* Driver specific per-device data */
1214 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
1215 devname = kmalloc(DEVNAME_SIZE, GFP_KERNEL);
1217 if (chip == NULL || devname == NULL)
1220 mutex_init(&chip->buffer_mutex);
1221 mutex_init(&chip->tpm_mutex);
1222 INIT_LIST_HEAD(&chip->list);
1224 INIT_WORK(&chip->work, timeout_work);
1226 setup_timer(&chip->user_read_timer, user_reader_timeout,
1227 (unsigned long)chip);
1229 memcpy(&chip->vendor, entry, sizeof(struct tpm_vendor_specific));
1231 chip->dev_num = find_first_zero_bit(dev_mask, TPM_NUM_DEVICES);
1233 if (chip->dev_num >= TPM_NUM_DEVICES) {
1234 dev_err(dev, "No available tpm device numbers\n");
1236 } else if (chip->dev_num == 0)
1237 chip->vendor.miscdev.minor = TPM_MINOR;
1239 chip->vendor.miscdev.minor = MISC_DYNAMIC_MINOR;
1241 set_bit(chip->dev_num, dev_mask);
1243 scnprintf(devname, DEVNAME_SIZE, "%s%d", "tpm", chip->dev_num);
1244 chip->vendor.miscdev.name = devname;
1246 chip->vendor.miscdev.parent = dev;
1247 chip->dev = get_device(dev);
1248 chip->release = dev->release;
1249 dev->release = tpm_dev_release;
1250 dev_set_drvdata(dev, chip);
1252 if (misc_register(&chip->vendor.miscdev)) {
1254 "unable to misc_register %s, minor %d\n",
1255 chip->vendor.miscdev.name,
1256 chip->vendor.miscdev.minor);
1257 put_device(chip->dev);
1261 if (sysfs_create_group(&dev->kobj, chip->vendor.attr_group)) {
1262 misc_deregister(&chip->vendor.miscdev);
1263 put_device(chip->dev);
1268 chip->bios_dir = tpm_bios_log_setup(devname);
1270 /* Make chip available */
1271 spin_lock(&driver_lock);
1272 list_add_rcu(&chip->list, &tpm_chip_list);
1273 spin_unlock(&driver_lock);
1282 EXPORT_SYMBOL_GPL(tpm_register_hardware);
1284 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1285 MODULE_DESCRIPTION("TPM Driver");
1286 MODULE_VERSION("2.0");
1287 MODULE_LICENSE("GPL");