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];
374 EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration);
377 * Internal kernel interface to transmit TPM commands
379 static ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
386 count = be32_to_cpu(*((__be32 *) (buf + 2)));
387 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
390 if (count > bufsiz) {
392 "invalid count value %x %zx \n", count, bufsiz);
396 mutex_lock(&chip->tpm_mutex);
398 if ((rc = chip->vendor.send(chip, (u8 *) buf, count)) < 0) {
400 "tpm_transmit: tpm_send: error %zd\n", rc);
404 if (chip->vendor.irq)
407 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
409 u8 status = chip->vendor.status(chip);
410 if ((status & chip->vendor.req_complete_mask) ==
411 chip->vendor.req_complete_val)
414 if ((status == chip->vendor.req_canceled)) {
415 dev_err(chip->dev, "Operation Canceled\n");
420 msleep(TPM_TIMEOUT); /* CHECK */
422 } while (time_before(jiffies, stop));
424 chip->vendor.cancel(chip);
425 dev_err(chip->dev, "Operation Timed out\n");
430 rc = chip->vendor.recv(chip, (u8 *) buf, bufsiz);
433 "tpm_transmit: tpm_recv: error %zd\n", rc);
435 mutex_unlock(&chip->tpm_mutex);
439 #define TPM_DIGEST_SIZE 20
440 #define TPM_ERROR_SIZE 10
441 #define TPM_RET_CODE_IDX 6
443 enum tpm_capabilities {
444 TPM_CAP_FLAG = cpu_to_be32(4),
445 TPM_CAP_PROP = cpu_to_be32(5),
446 CAP_VERSION_1_1 = cpu_to_be32(0x06),
447 CAP_VERSION_1_2 = cpu_to_be32(0x1A)
450 enum tpm_sub_capabilities {
451 TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
452 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
453 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
454 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
455 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
456 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
457 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
461 static ssize_t transmit_cmd(struct tpm_chip *chip, struct tpm_cmd_t *cmd,
462 int len, const char *desc)
466 len = tpm_transmit(chip,(u8 *) cmd, len);
469 if (len == TPM_ERROR_SIZE) {
470 err = be32_to_cpu(cmd->header.out.return_code);
471 dev_dbg(chip->dev, "A TPM error (%d) occurred %s\n", err, desc);
477 #define TPM_INTERNAL_RESULT_SIZE 200
478 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
479 #define TPM_ORD_GET_CAP cpu_to_be32(101)
481 static const struct tpm_input_header tpm_getcap_header = {
482 .tag = TPM_TAG_RQU_COMMAND,
483 .length = cpu_to_be32(22),
484 .ordinal = TPM_ORD_GET_CAP
487 ssize_t tpm_getcap(struct device *dev, __be32 subcap_id, cap_t *cap,
490 struct tpm_cmd_t tpm_cmd;
492 struct tpm_chip *chip = dev_get_drvdata(dev);
494 tpm_cmd.header.in = tpm_getcap_header;
495 if (subcap_id == CAP_VERSION_1_1 || subcap_id == CAP_VERSION_1_2) {
496 tpm_cmd.params.getcap_in.cap = subcap_id;
497 /*subcap field not necessary */
498 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(0);
499 tpm_cmd.header.in.length -= cpu_to_be32(sizeof(__be32));
501 if (subcap_id == TPM_CAP_FLAG_PERM ||
502 subcap_id == TPM_CAP_FLAG_VOL)
503 tpm_cmd.params.getcap_in.cap = TPM_CAP_FLAG;
505 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
506 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
507 tpm_cmd.params.getcap_in.subcap = subcap_id;
509 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, desc);
511 *cap = tpm_cmd.params.getcap_out.cap;
515 void tpm_gen_interrupt(struct tpm_chip *chip)
517 struct tpm_cmd_t tpm_cmd;
520 tpm_cmd.header.in = tpm_getcap_header;
521 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
522 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
523 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
525 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
526 "attempting to determine the timeouts");
528 EXPORT_SYMBOL_GPL(tpm_gen_interrupt);
530 void tpm_get_timeouts(struct tpm_chip *chip)
532 struct tpm_cmd_t tpm_cmd;
533 struct timeout_t *timeout_cap;
534 struct duration_t *duration_cap;
537 unsigned int scale = 1;
539 tpm_cmd.header.in = tpm_getcap_header;
540 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
541 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
542 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
544 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
545 "attempting to determine the timeouts");
549 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
550 be32_to_cpu(tpm_cmd.header.out.length)
551 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 4 * sizeof(u32))
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);
557 if (timeout && timeout < 1000) {
558 /* timeouts in msec rather usec */
562 chip->vendor.timeout_a = usecs_to_jiffies(timeout * scale);
563 timeout = be32_to_cpu(timeout_cap->b);
565 chip->vendor.timeout_b = usecs_to_jiffies(timeout * scale);
566 timeout = be32_to_cpu(timeout_cap->c);
568 chip->vendor.timeout_c = usecs_to_jiffies(timeout * scale);
569 timeout = be32_to_cpu(timeout_cap->d);
571 chip->vendor.timeout_d = usecs_to_jiffies(timeout * scale);
574 tpm_cmd.header.in = tpm_getcap_header;
575 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
576 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
577 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_DURATION;
579 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
580 "attempting to determine the durations");
584 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
585 be32_to_cpu(tpm_cmd.header.out.length)
586 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 3 * sizeof(u32))
589 duration_cap = &tpm_cmd.params.getcap_out.cap.duration;
590 chip->vendor.duration[TPM_SHORT] =
591 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_short));
592 chip->vendor.duration[TPM_MEDIUM] =
593 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_medium));
594 chip->vendor.duration[TPM_LONG] =
595 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_long));
597 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
598 * value wrong and apparently reports msecs rather than usecs. So we
599 * fix up the resulting too-small TPM_SHORT value to make things work.
600 * We also scale the TPM_MEDIUM and -_LONG values by 1000.
602 if (chip->vendor.duration[TPM_SHORT] < (HZ / 100)) {
603 chip->vendor.duration[TPM_SHORT] = HZ;
604 chip->vendor.duration[TPM_MEDIUM] *= 1000;
605 chip->vendor.duration[TPM_LONG] *= 1000;
606 chip->vendor.duration_adjusted = true;
607 dev_info(chip->dev, "Adjusting TPM timeout parameters.");
610 EXPORT_SYMBOL_GPL(tpm_get_timeouts);
612 void tpm_continue_selftest(struct tpm_chip *chip)
615 0, 193, /* TPM_TAG_RQU_COMMAND */
616 0, 0, 0, 10, /* length */
617 0, 0, 0, 83, /* TPM_ORD_GetCapability */
620 tpm_transmit(chip, data, sizeof(data));
622 EXPORT_SYMBOL_GPL(tpm_continue_selftest);
624 ssize_t tpm_show_enabled(struct device * dev, struct device_attribute * attr,
630 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
631 "attempting to determine the permanent enabled state");
635 rc = sprintf(buf, "%d\n", !cap.perm_flags.disable);
638 EXPORT_SYMBOL_GPL(tpm_show_enabled);
640 ssize_t tpm_show_active(struct device * dev, struct device_attribute * attr,
646 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
647 "attempting to determine the permanent active state");
651 rc = sprintf(buf, "%d\n", !cap.perm_flags.deactivated);
654 EXPORT_SYMBOL_GPL(tpm_show_active);
656 ssize_t tpm_show_owned(struct device * dev, struct device_attribute * attr,
662 rc = tpm_getcap(dev, TPM_CAP_PROP_OWNER, &cap,
663 "attempting to determine the owner state");
667 rc = sprintf(buf, "%d\n", cap.owned);
670 EXPORT_SYMBOL_GPL(tpm_show_owned);
672 ssize_t tpm_show_temp_deactivated(struct device * dev,
673 struct device_attribute * attr, char *buf)
678 rc = tpm_getcap(dev, TPM_CAP_FLAG_VOL, &cap,
679 "attempting to determine the temporary state");
683 rc = sprintf(buf, "%d\n", cap.stclear_flags.deactivated);
686 EXPORT_SYMBOL_GPL(tpm_show_temp_deactivated);
689 * tpm_chip_find_get - return tpm_chip for given chip number
691 static struct tpm_chip *tpm_chip_find_get(int chip_num)
693 struct tpm_chip *pos, *chip = NULL;
696 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
697 if (chip_num != TPM_ANY_NUM && chip_num != pos->dev_num)
700 if (try_module_get(pos->dev->driver->owner)) {
709 #define TPM_ORDINAL_PCRREAD cpu_to_be32(21)
710 #define READ_PCR_RESULT_SIZE 30
711 static struct tpm_input_header pcrread_header = {
712 .tag = TPM_TAG_RQU_COMMAND,
713 .length = cpu_to_be32(14),
714 .ordinal = TPM_ORDINAL_PCRREAD
717 int __tpm_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
720 struct tpm_cmd_t cmd;
722 cmd.header.in = pcrread_header;
723 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
724 rc = transmit_cmd(chip, &cmd, READ_PCR_RESULT_SIZE,
725 "attempting to read a pcr value");
728 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
734 * tpm_pcr_read - read a pcr value
735 * @chip_num: tpm idx # or ANY
736 * @pcr_idx: pcr idx to retrieve
737 * @res_buf: TPM_PCR value
738 * size of res_buf is 20 bytes (or NULL if you don't care)
740 * The TPM driver should be built-in, but for whatever reason it
741 * isn't, protect against the chip disappearing, by incrementing
742 * the module usage count.
744 int tpm_pcr_read(u32 chip_num, int pcr_idx, u8 *res_buf)
746 struct tpm_chip *chip;
749 chip = tpm_chip_find_get(chip_num);
752 rc = __tpm_pcr_read(chip, pcr_idx, res_buf);
756 EXPORT_SYMBOL_GPL(tpm_pcr_read);
759 * tpm_pcr_extend - extend pcr value with hash
760 * @chip_num: tpm idx # or AN&
761 * @pcr_idx: pcr idx to extend
762 * @hash: hash value used to extend pcr value
764 * The TPM driver should be built-in, but for whatever reason it
765 * isn't, protect against the chip disappearing, by incrementing
766 * the module usage count.
768 #define TPM_ORD_PCR_EXTEND cpu_to_be32(20)
769 #define EXTEND_PCR_RESULT_SIZE 34
770 static struct tpm_input_header pcrextend_header = {
771 .tag = TPM_TAG_RQU_COMMAND,
772 .length = cpu_to_be32(34),
773 .ordinal = TPM_ORD_PCR_EXTEND
776 int tpm_pcr_extend(u32 chip_num, int pcr_idx, const u8 *hash)
778 struct tpm_cmd_t cmd;
780 struct tpm_chip *chip;
782 chip = tpm_chip_find_get(chip_num);
786 cmd.header.in = pcrextend_header;
787 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(pcr_idx);
788 memcpy(cmd.params.pcrextend_in.hash, hash, TPM_DIGEST_SIZE);
789 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
790 "attempting extend a PCR value");
795 EXPORT_SYMBOL_GPL(tpm_pcr_extend);
797 int tpm_send(u32 chip_num, void *cmd, size_t buflen)
799 struct tpm_chip *chip;
802 chip = tpm_chip_find_get(chip_num);
806 rc = transmit_cmd(chip, cmd, buflen, "attempting tpm_cmd");
811 EXPORT_SYMBOL_GPL(tpm_send);
813 ssize_t tpm_show_pcrs(struct device *dev, struct device_attribute *attr,
817 u8 digest[TPM_DIGEST_SIZE];
821 struct tpm_chip *chip = dev_get_drvdata(dev);
823 rc = tpm_getcap(dev, TPM_CAP_PROP_PCR, &cap,
824 "attempting to determine the number of PCRS");
828 num_pcrs = be32_to_cpu(cap.num_pcrs);
829 for (i = 0; i < num_pcrs; i++) {
830 rc = __tpm_pcr_read(chip, i, digest);
833 str += sprintf(str, "PCR-%02d: ", i);
834 for (j = 0; j < TPM_DIGEST_SIZE; j++)
835 str += sprintf(str, "%02X ", digest[j]);
836 str += sprintf(str, "\n");
840 EXPORT_SYMBOL_GPL(tpm_show_pcrs);
842 #define READ_PUBEK_RESULT_SIZE 314
843 #define TPM_ORD_READPUBEK cpu_to_be32(124)
844 struct tpm_input_header tpm_readpubek_header = {
845 .tag = TPM_TAG_RQU_COMMAND,
846 .length = cpu_to_be32(30),
847 .ordinal = TPM_ORD_READPUBEK
850 ssize_t tpm_show_pubek(struct device *dev, struct device_attribute *attr,
854 struct tpm_cmd_t tpm_cmd;
859 struct tpm_chip *chip = dev_get_drvdata(dev);
861 tpm_cmd.header.in = tpm_readpubek_header;
862 err = transmit_cmd(chip, &tpm_cmd, READ_PUBEK_RESULT_SIZE,
863 "attempting to read the PUBEK");
868 ignore header 10 bytes
869 algorithm 32 bits (1 == RSA )
872 parameters (RSA 12->bytes: keybit, #primes, expbit)
875 ignore checksum 20 bytes
877 data = tpm_cmd.params.readpubek_out_buffer;
880 "Algorithm: %02X %02X %02X %02X\nEncscheme: %02X %02X\n"
881 "Sigscheme: %02X %02X\nParameters: %02X %02X %02X %02X"
882 " %02X %02X %02X %02X %02X %02X %02X %02X\n"
883 "Modulus length: %d\nModulus: \n",
884 data[10], data[11], data[12], data[13], data[14],
885 data[15], data[16], data[17], data[22], data[23],
886 data[24], data[25], data[26], data[27], data[28],
887 data[29], data[30], data[31], data[32], data[33],
888 be32_to_cpu(*((__be32 *) (data + 34))));
890 for (i = 0; i < 256; i++) {
891 str += sprintf(str, "%02X ", data[i + 38]);
892 if ((i + 1) % 16 == 0)
893 str += sprintf(str, "\n");
899 EXPORT_SYMBOL_GPL(tpm_show_pubek);
902 ssize_t tpm_show_caps(struct device *dev, struct device_attribute *attr,
909 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
910 "attempting to determine the manufacturer");
913 str += sprintf(str, "Manufacturer: 0x%x\n",
914 be32_to_cpu(cap.manufacturer_id));
916 rc = tpm_getcap(dev, CAP_VERSION_1_1, &cap,
917 "attempting to determine the 1.1 version");
921 "TCG version: %d.%d\nFirmware version: %d.%d\n",
922 cap.tpm_version.Major, cap.tpm_version.Minor,
923 cap.tpm_version.revMajor, cap.tpm_version.revMinor);
926 EXPORT_SYMBOL_GPL(tpm_show_caps);
928 ssize_t tpm_show_caps_1_2(struct device * dev,
929 struct device_attribute * attr, char *buf)
935 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
936 "attempting to determine the manufacturer");
939 str += sprintf(str, "Manufacturer: 0x%x\n",
940 be32_to_cpu(cap.manufacturer_id));
941 rc = tpm_getcap(dev, CAP_VERSION_1_2, &cap,
942 "attempting to determine the 1.2 version");
946 "TCG version: %d.%d\nFirmware version: %d.%d\n",
947 cap.tpm_version_1_2.Major, cap.tpm_version_1_2.Minor,
948 cap.tpm_version_1_2.revMajor,
949 cap.tpm_version_1_2.revMinor);
952 EXPORT_SYMBOL_GPL(tpm_show_caps_1_2);
954 ssize_t tpm_show_durations(struct device *dev, struct device_attribute *attr,
957 struct tpm_chip *chip = dev_get_drvdata(dev);
959 return sprintf(buf, "%d %d %d [%s]\n",
960 jiffies_to_usecs(chip->vendor.duration[TPM_SHORT]),
961 jiffies_to_usecs(chip->vendor.duration[TPM_MEDIUM]),
962 jiffies_to_usecs(chip->vendor.duration[TPM_LONG]),
963 chip->vendor.duration_adjusted
964 ? "adjusted" : "original");
966 EXPORT_SYMBOL_GPL(tpm_show_durations);
968 ssize_t tpm_store_cancel(struct device *dev, struct device_attribute *attr,
969 const char *buf, size_t count)
971 struct tpm_chip *chip = dev_get_drvdata(dev);
975 chip->vendor.cancel(chip);
978 EXPORT_SYMBOL_GPL(tpm_store_cancel);
981 * Device file system interface to the TPM
983 * It's assured that the chip will be opened just once,
984 * by the check of is_open variable, which is protected
987 int tpm_open(struct inode *inode, struct file *file)
989 int minor = iminor(inode);
990 struct tpm_chip *chip = NULL, *pos;
993 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
994 if (pos->vendor.miscdev.minor == minor) {
996 get_device(chip->dev);
1005 if (test_and_set_bit(0, &chip->is_open)) {
1006 dev_dbg(chip->dev, "Another process owns this TPM\n");
1007 put_device(chip->dev);
1011 chip->data_buffer = kzalloc(TPM_BUFSIZE, GFP_KERNEL);
1012 if (chip->data_buffer == NULL) {
1013 clear_bit(0, &chip->is_open);
1014 put_device(chip->dev);
1018 atomic_set(&chip->data_pending, 0);
1020 file->private_data = chip;
1023 EXPORT_SYMBOL_GPL(tpm_open);
1026 * Called on file close
1028 int tpm_release(struct inode *inode, struct file *file)
1030 struct tpm_chip *chip = file->private_data;
1032 del_singleshot_timer_sync(&chip->user_read_timer);
1033 flush_work_sync(&chip->work);
1034 file->private_data = NULL;
1035 atomic_set(&chip->data_pending, 0);
1036 kfree(chip->data_buffer);
1037 clear_bit(0, &chip->is_open);
1038 put_device(chip->dev);
1041 EXPORT_SYMBOL_GPL(tpm_release);
1043 ssize_t tpm_write(struct file *file, const char __user *buf,
1044 size_t size, loff_t *off)
1046 struct tpm_chip *chip = file->private_data;
1047 size_t in_size = size, out_size;
1049 /* cannot perform a write until the read has cleared
1050 either via tpm_read or a user_read_timer timeout */
1051 while (atomic_read(&chip->data_pending) != 0)
1052 msleep(TPM_TIMEOUT);
1054 mutex_lock(&chip->buffer_mutex);
1056 if (in_size > TPM_BUFSIZE)
1057 in_size = TPM_BUFSIZE;
1060 (chip->data_buffer, (void __user *) buf, in_size)) {
1061 mutex_unlock(&chip->buffer_mutex);
1065 /* atomic tpm command send and result receive */
1066 out_size = tpm_transmit(chip, chip->data_buffer, TPM_BUFSIZE);
1068 atomic_set(&chip->data_pending, out_size);
1069 mutex_unlock(&chip->buffer_mutex);
1071 /* Set a timeout by which the reader must come claim the result */
1072 mod_timer(&chip->user_read_timer, jiffies + (60 * HZ));
1076 EXPORT_SYMBOL_GPL(tpm_write);
1078 ssize_t tpm_read(struct file *file, char __user *buf,
1079 size_t size, loff_t *off)
1081 struct tpm_chip *chip = file->private_data;
1084 del_singleshot_timer_sync(&chip->user_read_timer);
1085 flush_work_sync(&chip->work);
1086 ret_size = atomic_read(&chip->data_pending);
1087 atomic_set(&chip->data_pending, 0);
1088 if (ret_size > 0) { /* relay data */
1089 if (size < ret_size)
1092 mutex_lock(&chip->buffer_mutex);
1093 if (copy_to_user(buf, chip->data_buffer, ret_size))
1095 mutex_unlock(&chip->buffer_mutex);
1100 EXPORT_SYMBOL_GPL(tpm_read);
1102 void tpm_remove_hardware(struct device *dev)
1104 struct tpm_chip *chip = dev_get_drvdata(dev);
1107 dev_err(dev, "No device data found\n");
1111 spin_lock(&driver_lock);
1112 list_del_rcu(&chip->list);
1113 spin_unlock(&driver_lock);
1116 misc_deregister(&chip->vendor.miscdev);
1117 sysfs_remove_group(&dev->kobj, chip->vendor.attr_group);
1118 tpm_bios_log_teardown(chip->bios_dir);
1120 /* write it this way to be explicit (chip->dev == dev) */
1121 put_device(chip->dev);
1123 EXPORT_SYMBOL_GPL(tpm_remove_hardware);
1125 #define TPM_ORD_SAVESTATE cpu_to_be32(152)
1126 #define SAVESTATE_RESULT_SIZE 10
1128 static struct tpm_input_header savestate_header = {
1129 .tag = TPM_TAG_RQU_COMMAND,
1130 .length = cpu_to_be32(10),
1131 .ordinal = TPM_ORD_SAVESTATE
1135 * We are about to suspend. Save the TPM state
1136 * so that it can be restored.
1138 int tpm_pm_suspend(struct device *dev, pm_message_t pm_state)
1140 struct tpm_chip *chip = dev_get_drvdata(dev);
1141 struct tpm_cmd_t cmd;
1144 u8 dummy_hash[TPM_DIGEST_SIZE] = { 0 };
1149 /* for buggy tpm, flush pcrs with extend to selected dummy */
1150 if (tpm_suspend_pcr) {
1151 cmd.header.in = pcrextend_header;
1152 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(tpm_suspend_pcr);
1153 memcpy(cmd.params.pcrextend_in.hash, dummy_hash,
1155 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
1156 "extending dummy pcr before suspend");
1159 /* now do the actual savestate */
1160 cmd.header.in = savestate_header;
1161 rc = transmit_cmd(chip, &cmd, SAVESTATE_RESULT_SIZE,
1162 "sending savestate before suspend");
1165 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
1168 * Resume from a power safe. The BIOS already restored
1171 int tpm_pm_resume(struct device *dev)
1173 struct tpm_chip *chip = dev_get_drvdata(dev);
1180 EXPORT_SYMBOL_GPL(tpm_pm_resume);
1182 /* In case vendor provided release function, call it too.*/
1184 void tpm_dev_vendor_release(struct tpm_chip *chip)
1186 if (chip->vendor.release)
1187 chip->vendor.release(chip->dev);
1189 clear_bit(chip->dev_num, dev_mask);
1190 kfree(chip->vendor.miscdev.name);
1192 EXPORT_SYMBOL_GPL(tpm_dev_vendor_release);
1196 * Once all references to platform device are down to 0,
1197 * release all allocated structures.
1199 void tpm_dev_release(struct device *dev)
1201 struct tpm_chip *chip = dev_get_drvdata(dev);
1203 tpm_dev_vendor_release(chip);
1208 EXPORT_SYMBOL_GPL(tpm_dev_release);
1211 * Called from tpm_<specific>.c probe function only for devices
1212 * the driver has determined it should claim. Prior to calling
1213 * this function the specific probe function has called pci_enable_device
1214 * upon errant exit from this function specific probe function should call
1215 * pci_disable_device
1217 struct tpm_chip *tpm_register_hardware(struct device *dev,
1218 const struct tpm_vendor_specific *entry)
1220 #define DEVNAME_SIZE 7
1223 struct tpm_chip *chip;
1225 /* Driver specific per-device data */
1226 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
1227 devname = kmalloc(DEVNAME_SIZE, GFP_KERNEL);
1229 if (chip == NULL || devname == NULL)
1232 mutex_init(&chip->buffer_mutex);
1233 mutex_init(&chip->tpm_mutex);
1234 INIT_LIST_HEAD(&chip->list);
1236 INIT_WORK(&chip->work, timeout_work);
1238 setup_timer(&chip->user_read_timer, user_reader_timeout,
1239 (unsigned long)chip);
1241 memcpy(&chip->vendor, entry, sizeof(struct tpm_vendor_specific));
1243 chip->dev_num = find_first_zero_bit(dev_mask, TPM_NUM_DEVICES);
1245 if (chip->dev_num >= TPM_NUM_DEVICES) {
1246 dev_err(dev, "No available tpm device numbers\n");
1248 } else if (chip->dev_num == 0)
1249 chip->vendor.miscdev.minor = TPM_MINOR;
1251 chip->vendor.miscdev.minor = MISC_DYNAMIC_MINOR;
1253 set_bit(chip->dev_num, dev_mask);
1255 scnprintf(devname, DEVNAME_SIZE, "%s%d", "tpm", chip->dev_num);
1256 chip->vendor.miscdev.name = devname;
1258 chip->vendor.miscdev.parent = dev;
1259 chip->dev = get_device(dev);
1260 chip->release = dev->release;
1261 dev->release = tpm_dev_release;
1262 dev_set_drvdata(dev, chip);
1264 if (misc_register(&chip->vendor.miscdev)) {
1266 "unable to misc_register %s, minor %d\n",
1267 chip->vendor.miscdev.name,
1268 chip->vendor.miscdev.minor);
1269 put_device(chip->dev);
1273 if (sysfs_create_group(&dev->kobj, chip->vendor.attr_group)) {
1274 misc_deregister(&chip->vendor.miscdev);
1275 put_device(chip->dev);
1280 chip->bios_dir = tpm_bios_log_setup(devname);
1282 /* Make chip available */
1283 spin_lock(&driver_lock);
1284 list_add_rcu(&chip->list, &tpm_chip_list);
1285 spin_unlock(&driver_lock);
1294 EXPORT_SYMBOL_GPL(tpm_register_hardware);
1296 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1297 MODULE_DESCRIPTION("TPM Driver");
1298 MODULE_VERSION("2.0");
1299 MODULE_LICENSE("GPL");