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>
30 #include <linux/freezer.h>
33 #include "tpm_eventlog.h"
42 #define TPM_MAX_ORDINAL 243
43 #define TSC_MAX_ORDINAL 12
44 #define TPM_PROTECTED_COMMAND 0x00
45 #define TPM_CONNECTION_COMMAND 0x40
48 * Bug workaround - some TPM's don't flush the most
49 * recently changed pcr on suspend, so force the flush
50 * with an extend to the selected _unused_ non-volatile pcr.
52 static int tpm_suspend_pcr;
53 module_param_named(suspend_pcr, tpm_suspend_pcr, uint, 0644);
54 MODULE_PARM_DESC(suspend_pcr,
55 "PCR to use for dummy writes to faciltate flush on suspend.");
57 static LIST_HEAD(tpm_chip_list);
58 static DEFINE_SPINLOCK(driver_lock);
59 static DECLARE_BITMAP(dev_mask, TPM_NUM_DEVICES);
62 * Array with one entry per ordinal defining the maximum amount
63 * of time the chip could take to return the result. The ordinal
64 * designation of short, medium or long is defined in a table in
65 * TCG Specification TPM Main Part 2 TPM Structures Section 17. The
66 * values of the SHORT, MEDIUM, and LONG durations are retrieved
67 * from the chip during initialization with a call to tpm_get_timeouts.
69 static const u8 tpm_ordinal_duration[TPM_MAX_ORDINAL] = {
70 TPM_UNDEFINED, /* 0 */
75 TPM_UNDEFINED, /* 5 */
125 TPM_UNDEFINED, /* 55 */
145 TPM_UNDEFINED, /* 75 */
155 TPM_UNDEFINED, /* 85 */
165 TPM_UNDEFINED, /* 95 */
170 TPM_MEDIUM, /* 100 */
175 TPM_UNDEFINED, /* 105 */
205 TPM_UNDEFINED, /* 135 */
215 TPM_UNDEFINED, /* 145 */
225 TPM_UNDEFINED, /* 155 */
235 TPM_UNDEFINED, /* 165 */
245 TPM_UNDEFINED, /* 175 */
250 TPM_MEDIUM, /* 180 */
255 TPM_MEDIUM, /* 185 */
260 TPM_UNDEFINED, /* 190 */
265 TPM_UNDEFINED, /* 195 */
280 TPM_MEDIUM, /* 210 */
285 TPM_UNDEFINED, /* 215 */
295 TPM_UNDEFINED, /* 225 */
305 TPM_UNDEFINED, /* 235 */
315 static void user_reader_timeout(unsigned long ptr)
317 struct tpm_chip *chip = (struct tpm_chip *) ptr;
319 schedule_work(&chip->work);
322 static void timeout_work(struct work_struct *work)
324 struct tpm_chip *chip = container_of(work, struct tpm_chip, work);
326 mutex_lock(&chip->buffer_mutex);
327 atomic_set(&chip->data_pending, 0);
328 memset(chip->data_buffer, 0, TPM_BUFSIZE);
329 mutex_unlock(&chip->buffer_mutex);
333 * Returns max number of jiffies to wait
335 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip,
338 int duration_idx = TPM_UNDEFINED;
340 u8 category = (ordinal >> 24) & 0xFF;
342 if ((category == TPM_PROTECTED_COMMAND && ordinal < TPM_MAX_ORDINAL) ||
343 (category == TPM_CONNECTION_COMMAND && ordinal < TSC_MAX_ORDINAL))
344 duration_idx = tpm_ordinal_duration[ordinal];
346 if (duration_idx != TPM_UNDEFINED)
347 duration = chip->vendor.duration[duration_idx];
353 EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration);
356 * Internal kernel interface to transmit TPM commands
358 static ssize_t tpm_transmit(struct tpm_chip *chip, const char *buf,
365 if (bufsiz > TPM_BUFSIZE)
366 bufsiz = TPM_BUFSIZE;
368 count = be32_to_cpu(*((__be32 *) (buf + 2)));
369 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
372 if (count > bufsiz) {
374 "invalid count value %x %zx \n", count, bufsiz);
378 mutex_lock(&chip->tpm_mutex);
380 if ((rc = chip->vendor.send(chip, (u8 *) buf, count)) < 0) {
382 "tpm_transmit: tpm_send: error %zd\n", rc);
386 if (chip->vendor.irq)
389 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
391 u8 status = chip->vendor.status(chip);
392 if ((status & chip->vendor.req_complete_mask) ==
393 chip->vendor.req_complete_val)
396 if (chip->vendor.req_canceled(chip, status)) {
397 dev_err(chip->dev, "Operation Canceled\n");
402 msleep(TPM_TIMEOUT); /* CHECK */
404 } while (time_before(jiffies, stop));
406 chip->vendor.cancel(chip);
407 dev_err(chip->dev, "Operation Timed out\n");
412 rc = chip->vendor.recv(chip, (u8 *) buf, bufsiz);
415 "tpm_transmit: tpm_recv: error %zd\n", rc);
417 mutex_unlock(&chip->tpm_mutex);
421 #define TPM_DIGEST_SIZE 20
422 #define TPM_RET_CODE_IDX 6
424 enum tpm_capabilities {
425 TPM_CAP_FLAG = cpu_to_be32(4),
426 TPM_CAP_PROP = cpu_to_be32(5),
427 CAP_VERSION_1_1 = cpu_to_be32(0x06),
428 CAP_VERSION_1_2 = cpu_to_be32(0x1A)
431 enum tpm_sub_capabilities {
432 TPM_CAP_PROP_PCR = cpu_to_be32(0x101),
433 TPM_CAP_PROP_MANUFACTURER = cpu_to_be32(0x103),
434 TPM_CAP_FLAG_PERM = cpu_to_be32(0x108),
435 TPM_CAP_FLAG_VOL = cpu_to_be32(0x109),
436 TPM_CAP_PROP_OWNER = cpu_to_be32(0x111),
437 TPM_CAP_PROP_TIS_TIMEOUT = cpu_to_be32(0x115),
438 TPM_CAP_PROP_TIS_DURATION = cpu_to_be32(0x120),
442 static ssize_t transmit_cmd(struct tpm_chip *chip, struct tpm_cmd_t *cmd,
443 int len, const char *desc)
447 len = tpm_transmit(chip,(u8 *) cmd, len);
450 else if (len < TPM_HEADER_SIZE)
453 err = be32_to_cpu(cmd->header.out.return_code);
454 if (err != 0 && desc)
455 dev_err(chip->dev, "A TPM error (%d) occurred %s\n", err, desc);
460 #define TPM_INTERNAL_RESULT_SIZE 200
461 #define TPM_TAG_RQU_COMMAND cpu_to_be16(193)
462 #define TPM_ORD_GET_CAP cpu_to_be32(101)
463 #define TPM_ORD_GET_RANDOM cpu_to_be32(70)
465 static const struct tpm_input_header tpm_getcap_header = {
466 .tag = TPM_TAG_RQU_COMMAND,
467 .length = cpu_to_be32(22),
468 .ordinal = TPM_ORD_GET_CAP
471 ssize_t tpm_getcap(struct device *dev, __be32 subcap_id, cap_t *cap,
474 struct tpm_cmd_t tpm_cmd;
476 struct tpm_chip *chip = dev_get_drvdata(dev);
478 tpm_cmd.header.in = tpm_getcap_header;
479 if (subcap_id == CAP_VERSION_1_1 || subcap_id == CAP_VERSION_1_2) {
480 tpm_cmd.params.getcap_in.cap = subcap_id;
481 /*subcap field not necessary */
482 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(0);
483 tpm_cmd.header.in.length -= cpu_to_be32(sizeof(__be32));
485 if (subcap_id == TPM_CAP_FLAG_PERM ||
486 subcap_id == TPM_CAP_FLAG_VOL)
487 tpm_cmd.params.getcap_in.cap = TPM_CAP_FLAG;
489 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
490 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
491 tpm_cmd.params.getcap_in.subcap = subcap_id;
493 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, desc);
495 *cap = tpm_cmd.params.getcap_out.cap;
499 void tpm_gen_interrupt(struct tpm_chip *chip)
501 struct tpm_cmd_t tpm_cmd;
504 tpm_cmd.header.in = tpm_getcap_header;
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 = TPM_CAP_PROP_TIS_TIMEOUT;
509 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
510 "attempting to determine the timeouts");
512 EXPORT_SYMBOL_GPL(tpm_gen_interrupt);
514 #define TPM_ORD_STARTUP cpu_to_be32(153)
515 #define TPM_ST_CLEAR cpu_to_be16(1)
516 #define TPM_ST_STATE cpu_to_be16(2)
517 #define TPM_ST_DEACTIVATED cpu_to_be16(3)
518 static const struct tpm_input_header tpm_startup_header = {
519 .tag = TPM_TAG_RQU_COMMAND,
520 .length = cpu_to_be32(12),
521 .ordinal = TPM_ORD_STARTUP
524 static int tpm_startup(struct tpm_chip *chip, __be16 startup_type)
526 struct tpm_cmd_t start_cmd;
527 start_cmd.header.in = tpm_startup_header;
528 start_cmd.params.startup_in.startup_type = startup_type;
529 return transmit_cmd(chip, &start_cmd, TPM_INTERNAL_RESULT_SIZE,
530 "attempting to start the TPM");
533 int tpm_get_timeouts(struct tpm_chip *chip)
535 struct tpm_cmd_t tpm_cmd;
536 struct timeout_t *timeout_cap;
537 struct duration_t *duration_cap;
540 unsigned int scale = 1;
542 tpm_cmd.header.in = tpm_getcap_header;
543 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
544 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
545 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
546 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE, NULL);
548 if (rc == TPM_ERR_INVALID_POSTINIT) {
549 /* The TPM is not started, we are the first to talk to it.
550 Execute a startup command. */
551 dev_info(chip->dev, "Issuing TPM_STARTUP");
552 if (tpm_startup(chip, TPM_ST_CLEAR))
555 tpm_cmd.header.in = tpm_getcap_header;
556 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
557 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
558 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_TIMEOUT;
559 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
564 "A TPM error (%zd) occurred attempting to determine the timeouts\n",
569 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
570 be32_to_cpu(tpm_cmd.header.out.length)
571 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 4 * sizeof(u32))
574 timeout_cap = &tpm_cmd.params.getcap_out.cap.timeout;
575 /* Don't overwrite default if value is 0 */
576 timeout = be32_to_cpu(timeout_cap->a);
577 if (timeout && timeout < 1000) {
578 /* timeouts in msec rather usec */
580 chip->vendor.timeout_adjusted = true;
583 chip->vendor.timeout_a = usecs_to_jiffies(timeout * scale);
584 timeout = be32_to_cpu(timeout_cap->b);
586 chip->vendor.timeout_b = usecs_to_jiffies(timeout * scale);
587 timeout = be32_to_cpu(timeout_cap->c);
589 chip->vendor.timeout_c = usecs_to_jiffies(timeout * scale);
590 timeout = be32_to_cpu(timeout_cap->d);
592 chip->vendor.timeout_d = usecs_to_jiffies(timeout * scale);
595 tpm_cmd.header.in = tpm_getcap_header;
596 tpm_cmd.params.getcap_in.cap = TPM_CAP_PROP;
597 tpm_cmd.params.getcap_in.subcap_size = cpu_to_be32(4);
598 tpm_cmd.params.getcap_in.subcap = TPM_CAP_PROP_TIS_DURATION;
600 rc = transmit_cmd(chip, &tpm_cmd, TPM_INTERNAL_RESULT_SIZE,
601 "attempting to determine the durations");
605 if (be32_to_cpu(tpm_cmd.header.out.return_code) != 0 ||
606 be32_to_cpu(tpm_cmd.header.out.length)
607 != sizeof(tpm_cmd.header.out) + sizeof(u32) + 3 * sizeof(u32))
610 duration_cap = &tpm_cmd.params.getcap_out.cap.duration;
611 chip->vendor.duration[TPM_SHORT] =
612 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_short));
613 chip->vendor.duration[TPM_MEDIUM] =
614 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_medium));
615 chip->vendor.duration[TPM_LONG] =
616 usecs_to_jiffies(be32_to_cpu(duration_cap->tpm_long));
618 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
619 * value wrong and apparently reports msecs rather than usecs. So we
620 * fix up the resulting too-small TPM_SHORT value to make things work.
621 * We also scale the TPM_MEDIUM and -_LONG values by 1000.
623 if (chip->vendor.duration[TPM_SHORT] < (HZ / 100)) {
624 chip->vendor.duration[TPM_SHORT] = HZ;
625 chip->vendor.duration[TPM_MEDIUM] *= 1000;
626 chip->vendor.duration[TPM_LONG] *= 1000;
627 chip->vendor.duration_adjusted = true;
628 dev_info(chip->dev, "Adjusting TPM timeout parameters.");
632 EXPORT_SYMBOL_GPL(tpm_get_timeouts);
634 #define TPM_ORD_CONTINUE_SELFTEST 83
635 #define CONTINUE_SELFTEST_RESULT_SIZE 10
637 static struct tpm_input_header continue_selftest_header = {
638 .tag = TPM_TAG_RQU_COMMAND,
639 .length = cpu_to_be32(10),
640 .ordinal = cpu_to_be32(TPM_ORD_CONTINUE_SELFTEST),
644 * tpm_continue_selftest -- run TPM's selftest
645 * @chip: TPM chip to use
647 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
650 static int tpm_continue_selftest(struct tpm_chip *chip)
653 struct tpm_cmd_t cmd;
655 cmd.header.in = continue_selftest_header;
656 rc = transmit_cmd(chip, &cmd, CONTINUE_SELFTEST_RESULT_SIZE,
657 "continue selftest");
661 ssize_t tpm_show_enabled(struct device * dev, struct device_attribute * attr,
667 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
668 "attempting to determine the permanent enabled state");
672 rc = sprintf(buf, "%d\n", !cap.perm_flags.disable);
675 EXPORT_SYMBOL_GPL(tpm_show_enabled);
677 ssize_t tpm_show_active(struct device * dev, struct device_attribute * attr,
683 rc = tpm_getcap(dev, TPM_CAP_FLAG_PERM, &cap,
684 "attempting to determine the permanent active state");
688 rc = sprintf(buf, "%d\n", !cap.perm_flags.deactivated);
691 EXPORT_SYMBOL_GPL(tpm_show_active);
693 ssize_t tpm_show_owned(struct device * dev, struct device_attribute * attr,
699 rc = tpm_getcap(dev, TPM_CAP_PROP_OWNER, &cap,
700 "attempting to determine the owner state");
704 rc = sprintf(buf, "%d\n", cap.owned);
707 EXPORT_SYMBOL_GPL(tpm_show_owned);
709 ssize_t tpm_show_temp_deactivated(struct device * dev,
710 struct device_attribute * attr, char *buf)
715 rc = tpm_getcap(dev, TPM_CAP_FLAG_VOL, &cap,
716 "attempting to determine the temporary state");
720 rc = sprintf(buf, "%d\n", cap.stclear_flags.deactivated);
723 EXPORT_SYMBOL_GPL(tpm_show_temp_deactivated);
726 * tpm_chip_find_get - return tpm_chip for given chip number
728 static struct tpm_chip *tpm_chip_find_get(int chip_num)
730 struct tpm_chip *pos, *chip = NULL;
733 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
734 if (chip_num != TPM_ANY_NUM && chip_num != pos->dev_num)
737 if (try_module_get(pos->dev->driver->owner)) {
746 #define TPM_ORDINAL_PCRREAD cpu_to_be32(21)
747 #define READ_PCR_RESULT_SIZE 30
748 static struct tpm_input_header pcrread_header = {
749 .tag = TPM_TAG_RQU_COMMAND,
750 .length = cpu_to_be32(14),
751 .ordinal = TPM_ORDINAL_PCRREAD
754 static int __tpm_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
757 struct tpm_cmd_t cmd;
759 cmd.header.in = pcrread_header;
760 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
761 rc = transmit_cmd(chip, &cmd, READ_PCR_RESULT_SIZE,
762 "attempting to read a pcr value");
765 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
771 * tpm_pcr_read - read a pcr value
772 * @chip_num: tpm idx # or ANY
773 * @pcr_idx: pcr idx to retrieve
774 * @res_buf: TPM_PCR value
775 * size of res_buf is 20 bytes (or NULL if you don't care)
777 * The TPM driver should be built-in, but for whatever reason it
778 * isn't, protect against the chip disappearing, by incrementing
779 * the module usage count.
781 int tpm_pcr_read(u32 chip_num, int pcr_idx, u8 *res_buf)
783 struct tpm_chip *chip;
786 chip = tpm_chip_find_get(chip_num);
789 rc = __tpm_pcr_read(chip, pcr_idx, res_buf);
793 EXPORT_SYMBOL_GPL(tpm_pcr_read);
796 * tpm_pcr_extend - extend pcr value with hash
797 * @chip_num: tpm idx # or AN&
798 * @pcr_idx: pcr idx to extend
799 * @hash: hash value used to extend pcr value
801 * The TPM driver should be built-in, but for whatever reason it
802 * isn't, protect against the chip disappearing, by incrementing
803 * the module usage count.
805 #define TPM_ORD_PCR_EXTEND cpu_to_be32(20)
806 #define EXTEND_PCR_RESULT_SIZE 34
807 static struct tpm_input_header pcrextend_header = {
808 .tag = TPM_TAG_RQU_COMMAND,
809 .length = cpu_to_be32(34),
810 .ordinal = TPM_ORD_PCR_EXTEND
813 int tpm_pcr_extend(u32 chip_num, int pcr_idx, const u8 *hash)
815 struct tpm_cmd_t cmd;
817 struct tpm_chip *chip;
819 chip = tpm_chip_find_get(chip_num);
823 cmd.header.in = pcrextend_header;
824 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(pcr_idx);
825 memcpy(cmd.params.pcrextend_in.hash, hash, TPM_DIGEST_SIZE);
826 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
827 "attempting extend a PCR value");
832 EXPORT_SYMBOL_GPL(tpm_pcr_extend);
835 * tpm_do_selftest - have the TPM continue its selftest and wait until it
836 * can receive further commands
837 * @chip: TPM chip to use
839 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
842 int tpm_do_selftest(struct tpm_chip *chip)
846 unsigned int delay_msec = 100;
847 unsigned long duration;
848 struct tpm_cmd_t cmd;
850 duration = tpm_calc_ordinal_duration(chip,
851 TPM_ORD_CONTINUE_SELFTEST);
853 loops = jiffies_to_msecs(duration) / delay_msec;
855 rc = tpm_continue_selftest(chip);
856 /* This may fail if there was no TPM driver during a suspend/resume
857 * cycle; some may return 10 (BAD_ORDINAL), others 28 (FAILEDSELFTEST)
863 /* Attempt to read a PCR value */
864 cmd.header.in = pcrread_header;
865 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(0);
866 rc = tpm_transmit(chip, (u8 *) &cmd, READ_PCR_RESULT_SIZE);
867 /* Some buggy TPMs will not respond to tpm_tis_ready() for
868 * around 300ms while the self test is ongoing, keep trying
869 * until the self test duration expires. */
871 dev_info(chip->dev, HW_ERR "TPM command timed out during continue self test");
876 if (rc < TPM_HEADER_SIZE)
879 rc = be32_to_cpu(cmd.header.out.return_code);
880 if (rc == TPM_ERR_DISABLED || rc == TPM_ERR_DEACTIVATED) {
882 "TPM is disabled/deactivated (0x%X)\n", rc);
883 /* TPM is disabled and/or deactivated; driver can
884 * proceed and TPM does handle commands for
885 * suspend/resume correctly
889 if (rc != TPM_WARN_DOING_SELFTEST)
892 } while (--loops > 0);
896 EXPORT_SYMBOL_GPL(tpm_do_selftest);
898 int tpm_send(u32 chip_num, void *cmd, size_t buflen)
900 struct tpm_chip *chip;
903 chip = tpm_chip_find_get(chip_num);
907 rc = transmit_cmd(chip, cmd, buflen, "attempting tpm_cmd");
912 EXPORT_SYMBOL_GPL(tpm_send);
914 ssize_t tpm_show_pcrs(struct device *dev, struct device_attribute *attr,
918 u8 digest[TPM_DIGEST_SIZE];
922 struct tpm_chip *chip = dev_get_drvdata(dev);
924 rc = tpm_getcap(dev, TPM_CAP_PROP_PCR, &cap,
925 "attempting to determine the number of PCRS");
929 num_pcrs = be32_to_cpu(cap.num_pcrs);
930 for (i = 0; i < num_pcrs; i++) {
931 rc = __tpm_pcr_read(chip, i, digest);
934 str += sprintf(str, "PCR-%02d: ", i);
935 for (j = 0; j < TPM_DIGEST_SIZE; j++)
936 str += sprintf(str, "%02X ", digest[j]);
937 str += sprintf(str, "\n");
941 EXPORT_SYMBOL_GPL(tpm_show_pcrs);
943 #define READ_PUBEK_RESULT_SIZE 314
944 #define TPM_ORD_READPUBEK cpu_to_be32(124)
945 static struct tpm_input_header tpm_readpubek_header = {
946 .tag = TPM_TAG_RQU_COMMAND,
947 .length = cpu_to_be32(30),
948 .ordinal = TPM_ORD_READPUBEK
951 ssize_t tpm_show_pubek(struct device *dev, struct device_attribute *attr,
955 struct tpm_cmd_t tpm_cmd;
960 struct tpm_chip *chip = dev_get_drvdata(dev);
962 tpm_cmd.header.in = tpm_readpubek_header;
963 err = transmit_cmd(chip, &tpm_cmd, READ_PUBEK_RESULT_SIZE,
964 "attempting to read the PUBEK");
969 ignore header 10 bytes
970 algorithm 32 bits (1 == RSA )
973 parameters (RSA 12->bytes: keybit, #primes, expbit)
976 ignore checksum 20 bytes
978 data = tpm_cmd.params.readpubek_out_buffer;
981 "Algorithm: %02X %02X %02X %02X\n"
982 "Encscheme: %02X %02X\n"
983 "Sigscheme: %02X %02X\n"
984 "Parameters: %02X %02X %02X %02X "
985 "%02X %02X %02X %02X "
986 "%02X %02X %02X %02X\n"
987 "Modulus length: %d\n"
989 data[0], data[1], data[2], data[3],
992 data[12], data[13], data[14], data[15],
993 data[16], data[17], data[18], data[19],
994 data[20], data[21], data[22], data[23],
995 be32_to_cpu(*((__be32 *) (data + 24))));
997 for (i = 0; i < 256; i++) {
998 str += sprintf(str, "%02X ", data[i + 28]);
999 if ((i + 1) % 16 == 0)
1000 str += sprintf(str, "\n");
1006 EXPORT_SYMBOL_GPL(tpm_show_pubek);
1009 ssize_t tpm_show_caps(struct device *dev, struct device_attribute *attr,
1016 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
1017 "attempting to determine the manufacturer");
1020 str += sprintf(str, "Manufacturer: 0x%x\n",
1021 be32_to_cpu(cap.manufacturer_id));
1023 rc = tpm_getcap(dev, CAP_VERSION_1_1, &cap,
1024 "attempting to determine the 1.1 version");
1028 "TCG version: %d.%d\nFirmware version: %d.%d\n",
1029 cap.tpm_version.Major, cap.tpm_version.Minor,
1030 cap.tpm_version.revMajor, cap.tpm_version.revMinor);
1033 EXPORT_SYMBOL_GPL(tpm_show_caps);
1035 ssize_t tpm_show_caps_1_2(struct device * dev,
1036 struct device_attribute * attr, char *buf)
1042 rc = tpm_getcap(dev, TPM_CAP_PROP_MANUFACTURER, &cap,
1043 "attempting to determine the manufacturer");
1046 str += sprintf(str, "Manufacturer: 0x%x\n",
1047 be32_to_cpu(cap.manufacturer_id));
1048 rc = tpm_getcap(dev, CAP_VERSION_1_2, &cap,
1049 "attempting to determine the 1.2 version");
1053 "TCG version: %d.%d\nFirmware version: %d.%d\n",
1054 cap.tpm_version_1_2.Major, cap.tpm_version_1_2.Minor,
1055 cap.tpm_version_1_2.revMajor,
1056 cap.tpm_version_1_2.revMinor);
1059 EXPORT_SYMBOL_GPL(tpm_show_caps_1_2);
1061 ssize_t tpm_show_durations(struct device *dev, struct device_attribute *attr,
1064 struct tpm_chip *chip = dev_get_drvdata(dev);
1066 if (chip->vendor.duration[TPM_LONG] == 0)
1069 return sprintf(buf, "%d %d %d [%s]\n",
1070 jiffies_to_usecs(chip->vendor.duration[TPM_SHORT]),
1071 jiffies_to_usecs(chip->vendor.duration[TPM_MEDIUM]),
1072 jiffies_to_usecs(chip->vendor.duration[TPM_LONG]),
1073 chip->vendor.duration_adjusted
1074 ? "adjusted" : "original");
1076 EXPORT_SYMBOL_GPL(tpm_show_durations);
1078 ssize_t tpm_show_timeouts(struct device *dev, struct device_attribute *attr,
1081 struct tpm_chip *chip = dev_get_drvdata(dev);
1083 return sprintf(buf, "%d %d %d %d [%s]\n",
1084 jiffies_to_usecs(chip->vendor.timeout_a),
1085 jiffies_to_usecs(chip->vendor.timeout_b),
1086 jiffies_to_usecs(chip->vendor.timeout_c),
1087 jiffies_to_usecs(chip->vendor.timeout_d),
1088 chip->vendor.timeout_adjusted
1089 ? "adjusted" : "original");
1091 EXPORT_SYMBOL_GPL(tpm_show_timeouts);
1093 ssize_t tpm_store_cancel(struct device *dev, struct device_attribute *attr,
1094 const char *buf, size_t count)
1096 struct tpm_chip *chip = dev_get_drvdata(dev);
1100 chip->vendor.cancel(chip);
1103 EXPORT_SYMBOL_GPL(tpm_store_cancel);
1105 static bool wait_for_tpm_stat_cond(struct tpm_chip *chip, u8 mask, bool check_cancel,
1108 u8 status = chip->vendor.status(chip);
1111 if ((status & mask) == mask)
1113 if (check_cancel && chip->vendor.req_canceled(chip, status)) {
1120 int wait_for_tpm_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
1121 wait_queue_head_t *queue, bool check_cancel)
1126 bool canceled = false;
1128 /* check current status */
1129 status = chip->vendor.status(chip);
1130 if ((status & mask) == mask)
1133 stop = jiffies + timeout;
1135 if (chip->vendor.irq) {
1137 timeout = stop - jiffies;
1138 if ((long)timeout <= 0)
1140 rc = wait_event_interruptible_timeout(*queue,
1141 wait_for_tpm_stat_cond(chip, mask, check_cancel,
1149 if (rc == -ERESTARTSYS && freezing(current)) {
1150 clear_thread_flag(TIF_SIGPENDING);
1155 msleep(TPM_TIMEOUT);
1156 status = chip->vendor.status(chip);
1157 if ((status & mask) == mask)
1159 } while (time_before(jiffies, stop));
1163 EXPORT_SYMBOL_GPL(wait_for_tpm_stat);
1165 * Device file system interface to the TPM
1167 * It's assured that the chip will be opened just once,
1168 * by the check of is_open variable, which is protected
1171 int tpm_open(struct inode *inode, struct file *file)
1173 int minor = iminor(inode);
1174 struct tpm_chip *chip = NULL, *pos;
1177 list_for_each_entry_rcu(pos, &tpm_chip_list, list) {
1178 if (pos->vendor.miscdev.minor == minor) {
1180 get_device(chip->dev);
1189 if (test_and_set_bit(0, &chip->is_open)) {
1190 dev_dbg(chip->dev, "Another process owns this TPM\n");
1191 put_device(chip->dev);
1195 chip->data_buffer = kzalloc(TPM_BUFSIZE, GFP_KERNEL);
1196 if (chip->data_buffer == NULL) {
1197 clear_bit(0, &chip->is_open);
1198 put_device(chip->dev);
1202 atomic_set(&chip->data_pending, 0);
1204 file->private_data = chip;
1207 EXPORT_SYMBOL_GPL(tpm_open);
1210 * Called on file close
1212 int tpm_release(struct inode *inode, struct file *file)
1214 struct tpm_chip *chip = file->private_data;
1216 del_singleshot_timer_sync(&chip->user_read_timer);
1217 flush_work(&chip->work);
1218 file->private_data = NULL;
1219 atomic_set(&chip->data_pending, 0);
1220 kzfree(chip->data_buffer);
1221 clear_bit(0, &chip->is_open);
1222 put_device(chip->dev);
1225 EXPORT_SYMBOL_GPL(tpm_release);
1227 ssize_t tpm_write(struct file *file, const char __user *buf,
1228 size_t size, loff_t *off)
1230 struct tpm_chip *chip = file->private_data;
1231 size_t in_size = size;
1234 /* cannot perform a write until the read has cleared
1235 either via tpm_read or a user_read_timer timeout.
1236 This also prevents splitted buffered writes from blocking here.
1238 if (atomic_read(&chip->data_pending) != 0)
1241 if (in_size > TPM_BUFSIZE)
1244 mutex_lock(&chip->buffer_mutex);
1247 (chip->data_buffer, (void __user *) buf, in_size)) {
1248 mutex_unlock(&chip->buffer_mutex);
1252 /* atomic tpm command send and result receive */
1253 out_size = tpm_transmit(chip, chip->data_buffer, TPM_BUFSIZE);
1255 mutex_unlock(&chip->buffer_mutex);
1259 atomic_set(&chip->data_pending, out_size);
1260 mutex_unlock(&chip->buffer_mutex);
1262 /* Set a timeout by which the reader must come claim the result */
1263 mod_timer(&chip->user_read_timer, jiffies + (60 * HZ));
1267 EXPORT_SYMBOL_GPL(tpm_write);
1269 ssize_t tpm_read(struct file *file, char __user *buf,
1270 size_t size, loff_t *off)
1272 struct tpm_chip *chip = file->private_data;
1276 del_singleshot_timer_sync(&chip->user_read_timer);
1277 flush_work(&chip->work);
1278 ret_size = atomic_read(&chip->data_pending);
1279 if (ret_size > 0) { /* relay data */
1280 ssize_t orig_ret_size = ret_size;
1281 if (size < ret_size)
1284 mutex_lock(&chip->buffer_mutex);
1285 rc = copy_to_user(buf, chip->data_buffer, ret_size);
1286 memset(chip->data_buffer, 0, orig_ret_size);
1290 mutex_unlock(&chip->buffer_mutex);
1293 atomic_set(&chip->data_pending, 0);
1297 EXPORT_SYMBOL_GPL(tpm_read);
1299 void tpm_remove_hardware(struct device *dev)
1301 struct tpm_chip *chip = dev_get_drvdata(dev);
1304 dev_err(dev, "No device data found\n");
1308 spin_lock(&driver_lock);
1309 list_del_rcu(&chip->list);
1310 spin_unlock(&driver_lock);
1313 misc_deregister(&chip->vendor.miscdev);
1314 sysfs_remove_group(&dev->kobj, chip->vendor.attr_group);
1315 tpm_remove_ppi(&dev->kobj);
1316 tpm_bios_log_teardown(chip->bios_dir);
1318 /* write it this way to be explicit (chip->dev == dev) */
1319 put_device(chip->dev);
1321 EXPORT_SYMBOL_GPL(tpm_remove_hardware);
1323 #define TPM_ORD_SAVESTATE cpu_to_be32(152)
1324 #define SAVESTATE_RESULT_SIZE 10
1326 static struct tpm_input_header savestate_header = {
1327 .tag = TPM_TAG_RQU_COMMAND,
1328 .length = cpu_to_be32(10),
1329 .ordinal = TPM_ORD_SAVESTATE
1333 * We are about to suspend. Save the TPM state
1334 * so that it can be restored.
1336 int tpm_pm_suspend(struct device *dev)
1338 struct tpm_chip *chip = dev_get_drvdata(dev);
1339 struct tpm_cmd_t cmd;
1342 u8 dummy_hash[TPM_DIGEST_SIZE] = { 0 };
1347 /* for buggy tpm, flush pcrs with extend to selected dummy */
1348 if (tpm_suspend_pcr) {
1349 cmd.header.in = pcrextend_header;
1350 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(tpm_suspend_pcr);
1351 memcpy(cmd.params.pcrextend_in.hash, dummy_hash,
1353 rc = transmit_cmd(chip, &cmd, EXTEND_PCR_RESULT_SIZE,
1354 "extending dummy pcr before suspend");
1357 /* now do the actual savestate */
1358 cmd.header.in = savestate_header;
1359 rc = transmit_cmd(chip, &cmd, SAVESTATE_RESULT_SIZE,
1360 "sending savestate before suspend");
1363 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
1366 * Resume from a power safe. The BIOS already restored
1369 int tpm_pm_resume(struct device *dev)
1371 struct tpm_chip *chip = dev_get_drvdata(dev);
1378 EXPORT_SYMBOL_GPL(tpm_pm_resume);
1380 #define TPM_GETRANDOM_RESULT_SIZE 18
1381 static struct tpm_input_header tpm_getrandom_header = {
1382 .tag = TPM_TAG_RQU_COMMAND,
1383 .length = cpu_to_be32(14),
1384 .ordinal = TPM_ORD_GET_RANDOM
1388 * tpm_get_random() - Get random bytes from the tpm's RNG
1389 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1390 * @out: destination buffer for the random bytes
1391 * @max: the max number of bytes to write to @out
1393 * Returns < 0 on error and the number of bytes read on success
1395 int tpm_get_random(u32 chip_num, u8 *out, size_t max)
1397 struct tpm_chip *chip;
1398 struct tpm_cmd_t tpm_cmd;
1399 u32 recd, num_bytes = min_t(u32, max, TPM_MAX_RNG_DATA);
1400 int err, total = 0, retries = 5;
1403 chip = tpm_chip_find_get(chip_num);
1407 if (!out || !num_bytes || max > TPM_MAX_RNG_DATA)
1411 tpm_cmd.header.in = tpm_getrandom_header;
1412 tpm_cmd.params.getrandom_in.num_bytes = cpu_to_be32(num_bytes);
1414 err = transmit_cmd(chip, &tpm_cmd,
1415 TPM_GETRANDOM_RESULT_SIZE + num_bytes,
1416 "attempting get random");
1420 recd = be32_to_cpu(tpm_cmd.params.getrandom_out.rng_data_len);
1421 memcpy(dest, tpm_cmd.params.getrandom_out.rng_data, recd);
1426 } while (retries-- && total < max);
1428 return total ? total : -EIO;
1430 EXPORT_SYMBOL_GPL(tpm_get_random);
1432 /* In case vendor provided release function, call it too.*/
1434 void tpm_dev_vendor_release(struct tpm_chip *chip)
1439 if (chip->vendor.release)
1440 chip->vendor.release(chip->dev);
1442 clear_bit(chip->dev_num, dev_mask);
1443 kfree(chip->vendor.miscdev.name);
1445 EXPORT_SYMBOL_GPL(tpm_dev_vendor_release);
1449 * Once all references to platform device are down to 0,
1450 * release all allocated structures.
1452 static void tpm_dev_release(struct device *dev)
1454 struct tpm_chip *chip = dev_get_drvdata(dev);
1459 tpm_dev_vendor_release(chip);
1464 EXPORT_SYMBOL_GPL(tpm_dev_release);
1467 * Called from tpm_<specific>.c probe function only for devices
1468 * the driver has determined it should claim. Prior to calling
1469 * this function the specific probe function has called pci_enable_device
1470 * upon errant exit from this function specific probe function should call
1471 * pci_disable_device
1473 struct tpm_chip *tpm_register_hardware(struct device *dev,
1474 const struct tpm_vendor_specific *entry)
1476 #define DEVNAME_SIZE 7
1479 struct tpm_chip *chip;
1481 /* Driver specific per-device data */
1482 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
1483 devname = kmalloc(DEVNAME_SIZE, GFP_KERNEL);
1485 if (chip == NULL || devname == NULL)
1488 mutex_init(&chip->buffer_mutex);
1489 mutex_init(&chip->tpm_mutex);
1490 INIT_LIST_HEAD(&chip->list);
1492 INIT_WORK(&chip->work, timeout_work);
1494 setup_timer(&chip->user_read_timer, user_reader_timeout,
1495 (unsigned long)chip);
1497 memcpy(&chip->vendor, entry, sizeof(struct tpm_vendor_specific));
1499 chip->dev_num = find_first_zero_bit(dev_mask, TPM_NUM_DEVICES);
1501 if (chip->dev_num >= TPM_NUM_DEVICES) {
1502 dev_err(dev, "No available tpm device numbers\n");
1504 } else if (chip->dev_num == 0)
1505 chip->vendor.miscdev.minor = TPM_MINOR;
1507 chip->vendor.miscdev.minor = MISC_DYNAMIC_MINOR;
1509 set_bit(chip->dev_num, dev_mask);
1511 scnprintf(devname, DEVNAME_SIZE, "%s%d", "tpm", chip->dev_num);
1512 chip->vendor.miscdev.name = devname;
1514 chip->vendor.miscdev.parent = dev;
1515 chip->dev = get_device(dev);
1516 chip->release = dev->release;
1517 dev->release = tpm_dev_release;
1518 dev_set_drvdata(dev, chip);
1520 if (misc_register(&chip->vendor.miscdev)) {
1522 "unable to misc_register %s, minor %d\n",
1523 chip->vendor.miscdev.name,
1524 chip->vendor.miscdev.minor);
1528 if (sysfs_create_group(&dev->kobj, chip->vendor.attr_group)) {
1529 misc_deregister(&chip->vendor.miscdev);
1533 if (tpm_add_ppi(&dev->kobj)) {
1534 misc_deregister(&chip->vendor.miscdev);
1538 chip->bios_dir = tpm_bios_log_setup(devname);
1540 /* Make chip available */
1541 spin_lock(&driver_lock);
1542 list_add_rcu(&chip->list, &tpm_chip_list);
1543 spin_unlock(&driver_lock);
1548 put_device(chip->dev);
1554 EXPORT_SYMBOL_GPL(tpm_register_hardware);
1556 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1557 MODULE_DESCRIPTION("TPM Driver");
1558 MODULE_VERSION("2.0");
1559 MODULE_LICENSE("GPL");