2 * Copyright (C) 2004 IBM Corporation
3 * Copyright (C) 2014 Intel Corporation
6 * Leendert van Doorn <leendert@watson.ibm.com>
7 * Dave Safford <safford@watson.ibm.com>
8 * Reiner Sailer <sailer@watson.ibm.com>
9 * Kylene Hall <kjhall@us.ibm.com>
11 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
13 * Device driver for TCG/TCPA TPM (trusted platform module).
14 * Specifications at www.trustedcomputinggroup.org
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License as
18 * published by the Free Software Foundation, version 2 of the
21 * Note, the TPM chip is not interrupt driven (only polling)
22 * and can have very long timeouts (minutes!). Hence the unusual
27 #include <linux/poll.h>
28 #include <linux/slab.h>
29 #include <linux/mutex.h>
30 #include <linux/spinlock.h>
31 #include <linux/freezer.h>
32 #include <linux/pm_runtime.h>
33 #include <linux/tpm_eventlog.h>
37 #define TPM_MAX_ORDINAL 243
38 #define TSC_MAX_ORDINAL 12
39 #define TPM_PROTECTED_COMMAND 0x00
40 #define TPM_CONNECTION_COMMAND 0x40
43 * Bug workaround - some TPM's don't flush the most
44 * recently changed pcr on suspend, so force the flush
45 * with an extend to the selected _unused_ non-volatile pcr.
47 static int tpm_suspend_pcr;
48 module_param_named(suspend_pcr, tpm_suspend_pcr, uint, 0644);
49 MODULE_PARM_DESC(suspend_pcr,
50 "PCR to use for dummy writes to facilitate flush on suspend.");
53 * Array with one entry per ordinal defining the maximum amount
54 * of time the chip could take to return the result. The ordinal
55 * designation of short, medium or long is defined in a table in
56 * TCG Specification TPM Main Part 2 TPM Structures Section 17. The
57 * values of the SHORT, MEDIUM, and LONG durations are retrieved
58 * from the chip during initialization with a call to tpm_get_timeouts.
60 static const u8 tpm_ordinal_duration[TPM_MAX_ORDINAL] = {
61 TPM_UNDEFINED, /* 0 */
66 TPM_UNDEFINED, /* 5 */
116 TPM_UNDEFINED, /* 55 */
136 TPM_UNDEFINED, /* 75 */
146 TPM_UNDEFINED, /* 85 */
156 TPM_UNDEFINED, /* 95 */
161 TPM_MEDIUM, /* 100 */
166 TPM_UNDEFINED, /* 105 */
196 TPM_UNDEFINED, /* 135 */
206 TPM_UNDEFINED, /* 145 */
216 TPM_UNDEFINED, /* 155 */
226 TPM_UNDEFINED, /* 165 */
236 TPM_UNDEFINED, /* 175 */
241 TPM_MEDIUM, /* 180 */
246 TPM_MEDIUM, /* 185 */
251 TPM_UNDEFINED, /* 190 */
256 TPM_UNDEFINED, /* 195 */
271 TPM_MEDIUM, /* 210 */
276 TPM_UNDEFINED, /* 215 */
286 TPM_UNDEFINED, /* 225 */
296 TPM_UNDEFINED, /* 235 */
307 * Returns max number of jiffies to wait
309 unsigned long tpm_calc_ordinal_duration(struct tpm_chip *chip,
312 int duration_idx = TPM_UNDEFINED;
316 * We only have a duration table for protected commands, where the upper
317 * 16 bits are 0. For the few other ordinals the fallback will be used.
319 if (ordinal < TPM_MAX_ORDINAL)
320 duration_idx = tpm_ordinal_duration[ordinal];
322 if (duration_idx != TPM_UNDEFINED)
323 duration = chip->duration[duration_idx];
329 EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration);
331 static int tpm_validate_command(struct tpm_chip *chip,
332 struct tpm_space *space,
336 const struct tpm_input_header *header = (const void *)cmd;
340 unsigned int nr_handles;
342 if (len < TPM_HEADER_SIZE)
348 if (chip->flags & TPM_CHIP_FLAG_TPM2 && chip->nr_commands) {
349 cc = be32_to_cpu(header->ordinal);
351 i = tpm2_find_cc(chip, cc);
353 dev_dbg(&chip->dev, "0x%04X is an invalid command\n",
358 attrs = chip->cc_attrs_tbl[i];
360 4 * ((attrs >> TPM2_CC_ATTR_CHANDLES) & GENMASK(2, 0));
361 if (len < TPM_HEADER_SIZE + 4 * nr_handles)
368 "%s: insufficient command length %zu", __func__, len);
373 * tmp_transmit - Internal kernel interface to transmit TPM commands.
375 * @chip: TPM chip to use
376 * @buf: TPM command buffer
377 * @bufsiz: length of the TPM command buffer
378 * @flags: tpm transmit flags - bitmap
381 * 0 when the operation is successful.
382 * A negative number for system errors (errno).
384 ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
385 u8 *buf, size_t bufsiz, unsigned int flags)
387 struct tpm_output_header *header = (void *)buf;
394 rc = tpm_validate_command(chip, space, buf, bufsiz);
398 * If the command is not implemented by the TPM, synthesize a
399 * response with a TPM2_RC_COMMAND_CODE return for user-space.
401 if (rc == -EOPNOTSUPP) {
402 header->length = cpu_to_be32(sizeof(*header));
403 header->tag = cpu_to_be16(TPM2_ST_NO_SESSIONS);
404 header->return_code = cpu_to_be32(TPM2_RC_COMMAND_CODE |
405 TSS2_RESMGR_TPM_RC_LAYER);
409 if (bufsiz > TPM_BUFSIZE)
410 bufsiz = TPM_BUFSIZE;
412 count = be32_to_cpu(*((__be32 *) (buf + 2)));
413 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
416 if (count > bufsiz) {
418 "invalid count value %x %zx\n", count, bufsiz);
422 if (!(flags & TPM_TRANSMIT_UNLOCKED))
423 mutex_lock(&chip->tpm_mutex);
425 if (chip->dev.parent)
426 pm_runtime_get_sync(chip->dev.parent);
428 if (chip->ops->clk_enable != NULL)
429 chip->ops->clk_enable(chip, true);
431 /* Store the decision as chip->locality will be changed. */
432 need_locality = chip->locality == -1;
434 if (!(flags & TPM_TRANSMIT_RAW) &&
435 need_locality && chip->ops->request_locality) {
436 rc = chip->ops->request_locality(chip, 0);
438 goto out_no_locality;
442 rc = tpm2_prepare_space(chip, space, ordinal, buf);
446 rc = chip->ops->send(chip, (u8 *) buf, count);
450 "%s: tpm_send: error %d\n", __func__, rc);
454 if (chip->flags & TPM_CHIP_FLAG_IRQ)
457 if (chip->flags & TPM_CHIP_FLAG_TPM2)
458 stop = jiffies + tpm2_calc_ordinal_duration(chip, ordinal);
460 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
462 u8 status = chip->ops->status(chip);
463 if ((status & chip->ops->req_complete_mask) ==
464 chip->ops->req_complete_val)
467 if (chip->ops->req_canceled(chip, status)) {
468 dev_err(&chip->dev, "Operation Canceled\n");
473 tpm_msleep(TPM_TIMEOUT);
475 } while (time_before(jiffies, stop));
477 chip->ops->cancel(chip);
478 dev_err(&chip->dev, "Operation Timed out\n");
483 len = chip->ops->recv(chip, (u8 *) buf, bufsiz);
487 "tpm_transmit: tpm_recv: error %d\n", rc);
489 } else if (len < TPM_HEADER_SIZE) {
494 if (len != be32_to_cpu(header->length)) {
499 rc = tpm2_commit_space(chip, space, ordinal, buf, &len);
502 if (need_locality && chip->ops->relinquish_locality) {
503 chip->ops->relinquish_locality(chip, chip->locality);
507 if (chip->ops->clk_enable != NULL)
508 chip->ops->clk_enable(chip, false);
510 if (chip->dev.parent)
511 pm_runtime_put_sync(chip->dev.parent);
513 if (!(flags & TPM_TRANSMIT_UNLOCKED))
514 mutex_unlock(&chip->tpm_mutex);
515 return rc ? rc : len;
519 * tmp_transmit_cmd - send a tpm command to the device
520 * The function extracts tpm out header return code
522 * @chip: TPM chip to use
523 * @buf: TPM command buffer
524 * @bufsiz: length of the buffer
525 * @min_rsp_body_length: minimum expected length of response body
526 * @flags: tpm transmit flags - bitmap
527 * @desc: command description used in the error message
530 * 0 when the operation is successful.
531 * A negative number for system errors (errno).
532 * A positive number for a TPM error.
534 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space,
535 const void *buf, size_t bufsiz,
536 size_t min_rsp_body_length, unsigned int flags,
539 const struct tpm_output_header *header = buf;
543 len = tpm_transmit(chip, space, (u8 *)buf, bufsiz, flags);
547 err = be32_to_cpu(header->return_code);
548 if (err != 0 && desc)
549 dev_err(&chip->dev, "A TPM error (%d) occurred %s\n", err,
554 if (len < min_rsp_body_length + TPM_HEADER_SIZE)
559 EXPORT_SYMBOL_GPL(tpm_transmit_cmd);
561 #define TPM_ORD_STARTUP 153
562 #define TPM_ST_CLEAR 1
565 * tpm_startup - turn on the TPM
566 * @chip: TPM chip to use
568 * Normally the firmware should start the TPM. This function is provided as a
569 * workaround if this does not happen. A legal case for this could be for
570 * example when a TPM emulator is used.
572 * Return: same as tpm_transmit_cmd()
574 int tpm_startup(struct tpm_chip *chip)
579 dev_info(&chip->dev, "starting up the TPM manually\n");
581 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
582 rc = tpm_buf_init(&buf, TPM2_ST_NO_SESSIONS, TPM2_CC_STARTUP);
586 tpm_buf_append_u16(&buf, TPM2_SU_CLEAR);
588 rc = tpm_buf_init(&buf, TPM_TAG_RQU_COMMAND, TPM_ORD_STARTUP);
592 tpm_buf_append_u16(&buf, TPM_ST_CLEAR);
595 rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0,
596 "attempting to start the TPM");
598 tpm_buf_destroy(&buf);
602 #define TPM_DIGEST_SIZE 20
603 #define TPM_RET_CODE_IDX 6
604 #define TPM_INTERNAL_RESULT_SIZE 200
605 #define TPM_ORD_GET_CAP 101
606 #define TPM_ORD_GET_RANDOM 70
608 static const struct tpm_input_header tpm_getcap_header = {
609 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
610 .length = cpu_to_be32(22),
611 .ordinal = cpu_to_be32(TPM_ORD_GET_CAP)
614 ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
615 const char *desc, size_t min_cap_length)
620 rc = tpm_buf_init(&buf, TPM_TAG_RQU_COMMAND, TPM_ORD_GET_CAP);
624 if (subcap_id == TPM_CAP_VERSION_1_1 ||
625 subcap_id == TPM_CAP_VERSION_1_2) {
626 tpm_buf_append_u32(&buf, subcap_id);
627 tpm_buf_append_u32(&buf, 0);
629 if (subcap_id == TPM_CAP_FLAG_PERM ||
630 subcap_id == TPM_CAP_FLAG_VOL)
631 tpm_buf_append_u32(&buf, TPM_CAP_FLAG);
633 tpm_buf_append_u32(&buf, TPM_CAP_PROP);
635 tpm_buf_append_u32(&buf, 4);
636 tpm_buf_append_u32(&buf, subcap_id);
638 rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE,
639 min_cap_length, 0, desc);
641 *cap = *(cap_t *)&buf.data[TPM_HEADER_SIZE + 4];
643 tpm_buf_destroy(&buf);
646 EXPORT_SYMBOL_GPL(tpm_getcap);
648 int tpm_get_timeouts(struct tpm_chip *chip)
651 unsigned long timeout_old[4], timeout_chip[4], timeout_eff[4];
654 if (chip->flags & TPM_CHIP_FLAG_HAVE_TIMEOUTS)
657 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
658 /* Fixed timeouts for TPM2 */
659 chip->timeout_a = msecs_to_jiffies(TPM2_TIMEOUT_A);
660 chip->timeout_b = msecs_to_jiffies(TPM2_TIMEOUT_B);
661 chip->timeout_c = msecs_to_jiffies(TPM2_TIMEOUT_C);
662 chip->timeout_d = msecs_to_jiffies(TPM2_TIMEOUT_D);
663 chip->duration[TPM_SHORT] =
664 msecs_to_jiffies(TPM2_DURATION_SHORT);
665 chip->duration[TPM_MEDIUM] =
666 msecs_to_jiffies(TPM2_DURATION_MEDIUM);
667 chip->duration[TPM_LONG] =
668 msecs_to_jiffies(TPM2_DURATION_LONG);
670 chip->flags |= TPM_CHIP_FLAG_HAVE_TIMEOUTS;
674 rc = tpm_getcap(chip, TPM_CAP_PROP_TIS_TIMEOUT, &cap, NULL,
675 sizeof(cap.timeout));
676 if (rc == TPM_ERR_INVALID_POSTINIT) {
677 if (tpm_startup(chip))
680 rc = tpm_getcap(chip, TPM_CAP_PROP_TIS_TIMEOUT, &cap,
681 "attempting to determine the timeouts",
682 sizeof(cap.timeout));
687 "A TPM error (%zd) occurred attempting to determine the timeouts\n",
692 timeout_old[0] = jiffies_to_usecs(chip->timeout_a);
693 timeout_old[1] = jiffies_to_usecs(chip->timeout_b);
694 timeout_old[2] = jiffies_to_usecs(chip->timeout_c);
695 timeout_old[3] = jiffies_to_usecs(chip->timeout_d);
696 timeout_chip[0] = be32_to_cpu(cap.timeout.a);
697 timeout_chip[1] = be32_to_cpu(cap.timeout.b);
698 timeout_chip[2] = be32_to_cpu(cap.timeout.c);
699 timeout_chip[3] = be32_to_cpu(cap.timeout.d);
700 memcpy(timeout_eff, timeout_chip, sizeof(timeout_eff));
703 * Provide ability for vendor overrides of timeout values in case
706 if (chip->ops->update_timeouts != NULL)
707 chip->timeout_adjusted =
708 chip->ops->update_timeouts(chip, timeout_eff);
710 if (!chip->timeout_adjusted) {
711 /* Restore default if chip reported 0 */
714 for (i = 0; i < ARRAY_SIZE(timeout_eff); i++) {
718 timeout_eff[i] = timeout_old[i];
719 chip->timeout_adjusted = true;
722 if (timeout_eff[0] != 0 && timeout_eff[0] < 1000) {
723 /* timeouts in msec rather usec */
724 for (i = 0; i != ARRAY_SIZE(timeout_eff); i++)
725 timeout_eff[i] *= 1000;
726 chip->timeout_adjusted = true;
730 /* Report adjusted timeouts */
731 if (chip->timeout_adjusted) {
733 HW_ERR "Adjusting reported timeouts: A %lu->%luus B %lu->%luus C %lu->%luus D %lu->%luus\n",
734 timeout_chip[0], timeout_eff[0],
735 timeout_chip[1], timeout_eff[1],
736 timeout_chip[2], timeout_eff[2],
737 timeout_chip[3], timeout_eff[3]);
740 chip->timeout_a = usecs_to_jiffies(timeout_eff[0]);
741 chip->timeout_b = usecs_to_jiffies(timeout_eff[1]);
742 chip->timeout_c = usecs_to_jiffies(timeout_eff[2]);
743 chip->timeout_d = usecs_to_jiffies(timeout_eff[3]);
745 rc = tpm_getcap(chip, TPM_CAP_PROP_TIS_DURATION, &cap,
746 "attempting to determine the durations",
747 sizeof(cap.duration));
751 chip->duration[TPM_SHORT] =
752 usecs_to_jiffies(be32_to_cpu(cap.duration.tpm_short));
753 chip->duration[TPM_MEDIUM] =
754 usecs_to_jiffies(be32_to_cpu(cap.duration.tpm_medium));
755 chip->duration[TPM_LONG] =
756 usecs_to_jiffies(be32_to_cpu(cap.duration.tpm_long));
758 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
759 * value wrong and apparently reports msecs rather than usecs. So we
760 * fix up the resulting too-small TPM_SHORT value to make things work.
761 * We also scale the TPM_MEDIUM and -_LONG values by 1000.
763 if (chip->duration[TPM_SHORT] < (HZ / 100)) {
764 chip->duration[TPM_SHORT] = HZ;
765 chip->duration[TPM_MEDIUM] *= 1000;
766 chip->duration[TPM_LONG] *= 1000;
767 chip->duration_adjusted = true;
768 dev_info(&chip->dev, "Adjusting TPM timeout parameters.");
771 chip->flags |= TPM_CHIP_FLAG_HAVE_TIMEOUTS;
774 EXPORT_SYMBOL_GPL(tpm_get_timeouts);
776 #define TPM_ORD_CONTINUE_SELFTEST 83
777 #define CONTINUE_SELFTEST_RESULT_SIZE 10
779 static const struct tpm_input_header continue_selftest_header = {
780 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
781 .length = cpu_to_be32(10),
782 .ordinal = cpu_to_be32(TPM_ORD_CONTINUE_SELFTEST),
786 * tpm_continue_selftest -- run TPM's selftest
787 * @chip: TPM chip to use
789 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
792 static int tpm_continue_selftest(struct tpm_chip *chip)
795 struct tpm_cmd_t cmd;
797 cmd.header.in = continue_selftest_header;
798 rc = tpm_transmit_cmd(chip, NULL, &cmd, CONTINUE_SELFTEST_RESULT_SIZE,
799 0, 0, "continue selftest");
803 #define TPM_ORDINAL_PCRREAD 21
804 #define READ_PCR_RESULT_SIZE 30
805 #define READ_PCR_RESULT_BODY_SIZE 20
806 static const struct tpm_input_header pcrread_header = {
807 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
808 .length = cpu_to_be32(14),
809 .ordinal = cpu_to_be32(TPM_ORDINAL_PCRREAD)
812 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
815 struct tpm_cmd_t cmd;
817 cmd.header.in = pcrread_header;
818 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
819 rc = tpm_transmit_cmd(chip, NULL, &cmd, READ_PCR_RESULT_SIZE,
820 READ_PCR_RESULT_BODY_SIZE, 0,
821 "attempting to read a pcr value");
824 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
830 * tpm_is_tpm2 - do we a have a TPM2 chip?
831 * @chip: a &struct tpm_chip instance, %NULL for the default chip
834 * 1 if we have a TPM2 chip.
835 * 0 if we don't have a TPM2 chip.
836 * A negative number for system errors (errno).
838 int tpm_is_tpm2(struct tpm_chip *chip)
842 chip = tpm_chip_find_get(chip);
846 rc = (chip->flags & TPM_CHIP_FLAG_TPM2) != 0;
852 EXPORT_SYMBOL_GPL(tpm_is_tpm2);
855 * tpm_pcr_read - read a PCR value from SHA1 bank
856 * @chip: a &struct tpm_chip instance, %NULL for the default chip
857 * @pcr_idx: the PCR to be retrieved
858 * @res_buf: the value of the PCR
860 * Return: same as with tpm_transmit_cmd()
862 int tpm_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
866 chip = tpm_chip_find_get(chip);
869 if (chip->flags & TPM_CHIP_FLAG_TPM2)
870 rc = tpm2_pcr_read(chip, pcr_idx, res_buf);
872 rc = tpm_pcr_read_dev(chip, pcr_idx, res_buf);
876 EXPORT_SYMBOL_GPL(tpm_pcr_read);
878 #define TPM_ORD_PCR_EXTEND 20
879 #define EXTEND_PCR_RESULT_SIZE 34
880 #define EXTEND_PCR_RESULT_BODY_SIZE 20
881 static const struct tpm_input_header pcrextend_header = {
882 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
883 .length = cpu_to_be32(34),
884 .ordinal = cpu_to_be32(TPM_ORD_PCR_EXTEND)
887 static int tpm1_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash,
893 rc = tpm_buf_init(&buf, TPM_TAG_RQU_COMMAND, TPM_ORD_PCR_EXTEND);
897 tpm_buf_append_u32(&buf, pcr_idx);
898 tpm_buf_append(&buf, hash, TPM_DIGEST_SIZE);
900 rc = tpm_transmit_cmd(chip, NULL, buf.data, EXTEND_PCR_RESULT_SIZE,
901 EXTEND_PCR_RESULT_BODY_SIZE, 0, log_msg);
902 tpm_buf_destroy(&buf);
907 * tpm_pcr_extend - extend a PCR value in SHA1 bank.
908 * @chip: a &struct tpm_chip instance, %NULL for the default chip
909 * @pcr_idx: the PCR to be retrieved
910 * @hash: the hash value used to extend the PCR value
912 * Note: with TPM 2.0 extends also those banks with a known digest size to the
913 * cryto subsystem in order to prevent malicious use of those PCR banks. In the
914 * future we should dynamically determine digest sizes.
916 * Return: same as with tpm_transmit_cmd()
918 int tpm_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash)
921 struct tpm2_digest digest_list[ARRAY_SIZE(chip->active_banks)];
925 chip = tpm_chip_find_get(chip);
929 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
930 memset(digest_list, 0, sizeof(digest_list));
932 for (i = 0; i < ARRAY_SIZE(chip->active_banks) &&
933 chip->active_banks[i] != TPM2_ALG_ERROR; i++) {
934 digest_list[i].alg_id = chip->active_banks[i];
935 memcpy(digest_list[i].digest, hash, TPM_DIGEST_SIZE);
939 rc = tpm2_pcr_extend(chip, pcr_idx, count, digest_list);
944 rc = tpm1_pcr_extend(chip, pcr_idx, hash,
945 "attempting extend a PCR value");
949 EXPORT_SYMBOL_GPL(tpm_pcr_extend);
952 * tpm_do_selftest - have the TPM continue its selftest and wait until it
953 * can receive further commands
954 * @chip: TPM chip to use
956 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
959 int tpm_do_selftest(struct tpm_chip *chip)
963 unsigned int delay_msec = 100;
964 unsigned long duration;
965 u8 dummy[TPM_DIGEST_SIZE];
967 duration = tpm_calc_ordinal_duration(chip, TPM_ORD_CONTINUE_SELFTEST);
969 loops = jiffies_to_msecs(duration) / delay_msec;
971 rc = tpm_continue_selftest(chip);
972 /* This may fail if there was no TPM driver during a suspend/resume
973 * cycle; some may return 10 (BAD_ORDINAL), others 28 (FAILEDSELFTEST)
979 /* Attempt to read a PCR value */
980 rc = tpm_pcr_read_dev(chip, 0, dummy);
982 /* Some buggy TPMs will not respond to tpm_tis_ready() for
983 * around 300ms while the self test is ongoing, keep trying
984 * until the self test duration expires. */
988 "TPM command timed out during continue self test");
989 tpm_msleep(delay_msec);
993 if (rc == TPM_ERR_DISABLED || rc == TPM_ERR_DEACTIVATED) {
995 "TPM is disabled/deactivated (0x%X)\n", rc);
996 /* TPM is disabled and/or deactivated; driver can
997 * proceed and TPM does handle commands for
998 * suspend/resume correctly
1002 if (rc != TPM_WARN_DOING_SELFTEST)
1004 tpm_msleep(delay_msec);
1005 } while (--loops > 0);
1009 EXPORT_SYMBOL_GPL(tpm_do_selftest);
1012 * tpm1_auto_startup - Perform the standard automatic TPM initialization
1014 * @chip: TPM chip to use
1016 * Returns 0 on success, < 0 in case of fatal error.
1018 int tpm1_auto_startup(struct tpm_chip *chip)
1022 rc = tpm_get_timeouts(chip);
1025 rc = tpm_do_selftest(chip);
1027 dev_err(&chip->dev, "TPM self test failed\n");
1039 * tpm_send - send a TPM command
1040 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1041 * @cmd: a TPM command buffer
1042 * @buflen: the length of the TPM command buffer
1044 * Return: same as with tpm_transmit_cmd()
1046 int tpm_send(struct tpm_chip *chip, void *cmd, size_t buflen)
1050 chip = tpm_chip_find_get(chip);
1054 rc = tpm_transmit_cmd(chip, NULL, cmd, buflen, 0, 0,
1055 "attempting to a send a command");
1059 EXPORT_SYMBOL_GPL(tpm_send);
1061 #define TPM_ORD_SAVESTATE 152
1062 #define SAVESTATE_RESULT_SIZE 10
1064 static const struct tpm_input_header savestate_header = {
1065 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
1066 .length = cpu_to_be32(10),
1067 .ordinal = cpu_to_be32(TPM_ORD_SAVESTATE)
1071 * We are about to suspend. Save the TPM state
1072 * so that it can be restored.
1074 int tpm_pm_suspend(struct device *dev)
1076 struct tpm_chip *chip = dev_get_drvdata(dev);
1077 struct tpm_cmd_t cmd;
1080 u8 dummy_hash[TPM_DIGEST_SIZE] = { 0 };
1085 if (chip->flags & TPM_CHIP_FLAG_ALWAYS_POWERED)
1088 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
1089 tpm2_shutdown(chip, TPM2_SU_STATE);
1093 /* for buggy tpm, flush pcrs with extend to selected dummy */
1094 if (tpm_suspend_pcr)
1095 rc = tpm1_pcr_extend(chip, tpm_suspend_pcr, dummy_hash,
1096 "extending dummy pcr before suspend");
1098 /* now do the actual savestate */
1099 for (try = 0; try < TPM_RETRY; try++) {
1100 cmd.header.in = savestate_header;
1101 rc = tpm_transmit_cmd(chip, NULL, &cmd, SAVESTATE_RESULT_SIZE,
1105 * If the TPM indicates that it is too busy to respond to
1106 * this command then retry before giving up. It can take
1107 * several seconds for this TPM to be ready.
1109 * This can happen if the TPM has already been sent the
1110 * SaveState command before the driver has loaded. TCG 1.2
1111 * specification states that any communication after SaveState
1112 * may cause the TPM to invalidate previously saved state.
1114 if (rc != TPM_WARN_RETRY)
1116 tpm_msleep(TPM_TIMEOUT_RETRY);
1121 "Error (%d) sending savestate before suspend\n", rc);
1123 dev_warn(&chip->dev, "TPM savestate took %dms\n",
1124 try * TPM_TIMEOUT_RETRY);
1128 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
1131 * Resume from a power safe. The BIOS already restored
1134 int tpm_pm_resume(struct device *dev)
1136 struct tpm_chip *chip = dev_get_drvdata(dev);
1143 EXPORT_SYMBOL_GPL(tpm_pm_resume);
1145 #define TPM_GETRANDOM_RESULT_SIZE 18
1146 static const struct tpm_input_header tpm_getrandom_header = {
1147 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
1148 .length = cpu_to_be32(14),
1149 .ordinal = cpu_to_be32(TPM_ORD_GET_RANDOM)
1153 * tpm_get_random() - get random bytes from the TPM's RNG
1154 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1155 * @out: destination buffer for the random bytes
1156 * @max: the max number of bytes to write to @out
1158 * Return: same as with tpm_transmit_cmd()
1160 int tpm_get_random(struct tpm_chip *chip, u8 *out, size_t max)
1162 struct tpm_cmd_t tpm_cmd;
1163 u32 recd, num_bytes = min_t(u32, max, TPM_MAX_RNG_DATA), rlength;
1164 int err, total = 0, retries = 5;
1167 if (!out || !num_bytes || max > TPM_MAX_RNG_DATA)
1170 chip = tpm_chip_find_get(chip);
1174 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
1175 err = tpm2_get_random(chip, out, max);
1181 tpm_cmd.header.in = tpm_getrandom_header;
1182 tpm_cmd.params.getrandom_in.num_bytes = cpu_to_be32(num_bytes);
1184 err = tpm_transmit_cmd(chip, NULL, &tpm_cmd,
1185 TPM_GETRANDOM_RESULT_SIZE + num_bytes,
1186 offsetof(struct tpm_getrandom_out,
1188 0, "attempting get random");
1192 recd = be32_to_cpu(tpm_cmd.params.getrandom_out.rng_data_len);
1194 rlength = be32_to_cpu(tpm_cmd.header.out.length);
1195 if (rlength < offsetof(struct tpm_getrandom_out, rng_data) +
1200 memcpy(dest, tpm_cmd.params.getrandom_out.rng_data, recd);
1205 } while (retries-- && total < max);
1208 return total ? total : -EIO;
1210 EXPORT_SYMBOL_GPL(tpm_get_random);
1213 * tpm_seal_trusted() - seal a trusted key payload
1214 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1215 * @options: authentication values and other options
1216 * @payload: the key data in clear and encrypted form
1218 * Note: only TPM 2.0 chip are supported. TPM 1.x implementation is located in
1219 * the keyring subsystem.
1221 * Return: same as with tpm_transmit_cmd()
1223 int tpm_seal_trusted(struct tpm_chip *chip, struct trusted_key_payload *payload,
1224 struct trusted_key_options *options)
1228 chip = tpm_chip_find_get(chip);
1229 if (!chip || !(chip->flags & TPM_CHIP_FLAG_TPM2))
1232 rc = tpm2_seal_trusted(chip, payload, options);
1237 EXPORT_SYMBOL_GPL(tpm_seal_trusted);
1240 * tpm_unseal_trusted() - unseal a trusted key
1241 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1242 * @options: authentication values and other options
1243 * @payload: the key data in clear and encrypted form
1245 * Note: only TPM 2.0 chip are supported. TPM 1.x implementation is located in
1246 * the keyring subsystem.
1248 * Return: same as with tpm_transmit_cmd()
1250 int tpm_unseal_trusted(struct tpm_chip *chip,
1251 struct trusted_key_payload *payload,
1252 struct trusted_key_options *options)
1256 chip = tpm_chip_find_get(chip);
1257 if (!chip || !(chip->flags & TPM_CHIP_FLAG_TPM2))
1260 rc = tpm2_unseal_trusted(chip, payload, options);
1266 EXPORT_SYMBOL_GPL(tpm_unseal_trusted);
1268 static int __init tpm_init(void)
1272 tpm_class = class_create(THIS_MODULE, "tpm");
1273 if (IS_ERR(tpm_class)) {
1274 pr_err("couldn't create tpm class\n");
1275 return PTR_ERR(tpm_class);
1278 tpmrm_class = class_create(THIS_MODULE, "tpmrm");
1279 if (IS_ERR(tpmrm_class)) {
1280 pr_err("couldn't create tpmrm class\n");
1281 class_destroy(tpm_class);
1282 return PTR_ERR(tpmrm_class);
1285 rc = alloc_chrdev_region(&tpm_devt, 0, 2*TPM_NUM_DEVICES, "tpm");
1287 pr_err("tpm: failed to allocate char dev region\n");
1288 class_destroy(tpmrm_class);
1289 class_destroy(tpm_class);
1296 static void __exit tpm_exit(void)
1298 idr_destroy(&dev_nums_idr);
1299 class_destroy(tpm_class);
1300 class_destroy(tpmrm_class);
1301 unregister_chrdev_region(tpm_devt, 2*TPM_NUM_DEVICES);
1304 subsys_initcall(tpm_init);
1305 module_exit(tpm_exit);
1307 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1308 MODULE_DESCRIPTION("TPM Driver");
1309 MODULE_VERSION("2.0");
1310 MODULE_LICENSE("GPL");