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>
35 #include "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);
372 static int tpm_request_locality(struct tpm_chip *chip, unsigned int flags)
376 if (flags & TPM_TRANSMIT_RAW)
379 if (!chip->ops->request_locality)
382 rc = chip->ops->request_locality(chip, 0);
391 static void tpm_relinquish_locality(struct tpm_chip *chip, unsigned int flags)
395 if (flags & TPM_TRANSMIT_RAW)
398 if (!chip->ops->relinquish_locality)
401 rc = chip->ops->relinquish_locality(chip, chip->locality);
403 dev_err(&chip->dev, "%s: : error %d\n", __func__, rc);
408 static int tpm_cmd_ready(struct tpm_chip *chip, unsigned int flags)
410 if (flags & TPM_TRANSMIT_RAW)
413 if (!chip->ops->cmd_ready)
416 return chip->ops->cmd_ready(chip);
419 static int tpm_go_idle(struct tpm_chip *chip, unsigned int flags)
421 if (flags & TPM_TRANSMIT_RAW)
424 if (!chip->ops->go_idle)
427 return chip->ops->go_idle(chip);
430 static ssize_t tpm_try_transmit(struct tpm_chip *chip,
431 struct tpm_space *space,
432 u8 *buf, size_t bufsiz,
435 struct tpm_output_header *header = (void *)buf;
442 rc = tpm_validate_command(chip, space, buf, bufsiz);
446 * If the command is not implemented by the TPM, synthesize a
447 * response with a TPM2_RC_COMMAND_CODE return for user-space.
449 if (rc == -EOPNOTSUPP) {
450 header->length = cpu_to_be32(sizeof(*header));
451 header->tag = cpu_to_be16(TPM2_ST_NO_SESSIONS);
452 header->return_code = cpu_to_be32(TPM2_RC_COMMAND_CODE |
453 TSS2_RESMGR_TPM_RC_LAYER);
454 return sizeof(*header);
457 if (bufsiz > TPM_BUFSIZE)
458 bufsiz = TPM_BUFSIZE;
460 count = be32_to_cpu(*((__be32 *) (buf + 2)));
461 ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
464 if (count > bufsiz) {
466 "invalid count value %x %zx\n", count, bufsiz);
470 if (!(flags & TPM_TRANSMIT_UNLOCKED))
471 mutex_lock(&chip->tpm_mutex);
474 if (chip->ops->clk_enable != NULL)
475 chip->ops->clk_enable(chip, true);
477 /* Store the decision as chip->locality will be changed. */
478 need_locality = chip->locality == -1;
481 rc = tpm_request_locality(chip, flags);
483 need_locality = false;
488 rc = tpm_cmd_ready(chip, flags);
492 rc = tpm2_prepare_space(chip, space, ordinal, buf);
496 rc = chip->ops->send(chip, (u8 *) buf, count);
500 "%s: send(): error %d\n", __func__, rc);
504 /* A sanity check. send() should just return zero on success e.g.
505 * not the command length.
509 "%s: send(): invalid value %d\n", __func__, rc);
513 if (chip->flags & TPM_CHIP_FLAG_IRQ)
516 if (chip->flags & TPM_CHIP_FLAG_TPM2)
517 stop = jiffies + tpm2_calc_ordinal_duration(chip, ordinal);
519 stop = jiffies + tpm_calc_ordinal_duration(chip, ordinal);
521 u8 status = chip->ops->status(chip);
522 if ((status & chip->ops->req_complete_mask) ==
523 chip->ops->req_complete_val)
526 if (chip->ops->req_canceled(chip, status)) {
527 dev_err(&chip->dev, "Operation Canceled\n");
532 tpm_msleep(TPM_TIMEOUT);
534 } while (time_before(jiffies, stop));
536 chip->ops->cancel(chip);
537 dev_err(&chip->dev, "Operation Timed out\n");
542 len = chip->ops->recv(chip, (u8 *) buf, bufsiz);
546 "tpm_transmit: tpm_recv: error %d\n", rc);
548 } else if (len < TPM_HEADER_SIZE) {
553 if (len != be32_to_cpu(header->length)) {
558 rc = tpm2_commit_space(chip, space, ordinal, buf, &len);
560 dev_err(&chip->dev, "tpm2_commit_space: error %d\n", rc);
563 /* may fail but do not override previous error value in rc */
564 tpm_go_idle(chip, flags);
568 tpm_relinquish_locality(chip, flags);
570 if (chip->ops->clk_enable != NULL)
571 chip->ops->clk_enable(chip, false);
573 if (!(flags & TPM_TRANSMIT_UNLOCKED))
574 mutex_unlock(&chip->tpm_mutex);
575 return rc ? rc : len;
579 * tpm_transmit - Internal kernel interface to transmit TPM commands.
581 * @chip: TPM chip to use
583 * @buf: TPM command buffer
584 * @bufsiz: length of the TPM command buffer
585 * @flags: tpm transmit flags - bitmap
587 * A wrapper around tpm_try_transmit that handles TPM2_RC_RETRY
588 * returns from the TPM and retransmits the command after a delay up
589 * to a maximum wait of TPM2_DURATION_LONG.
591 * Note: TPM1 never returns TPM2_RC_RETRY so the retry logic is TPM2
595 * the length of the return when the operation is successful.
596 * A negative number for system errors (errno).
598 ssize_t tpm_transmit(struct tpm_chip *chip, struct tpm_space *space,
599 u8 *buf, size_t bufsiz, unsigned int flags)
601 struct tpm_output_header *header = (struct tpm_output_header *)buf;
602 /* space for header and handles */
603 u8 save[TPM_HEADER_SIZE + 3*sizeof(u32)];
604 unsigned int delay_msec = TPM2_DURATION_SHORT;
607 const size_t save_size = min(space ? sizeof(save) : TPM_HEADER_SIZE,
611 * Subtlety here: if we have a space, the handles will be
612 * transformed, so when we restore the header we also have to
613 * restore the handles.
615 memcpy(save, buf, save_size);
618 ret = tpm_try_transmit(chip, space, buf, bufsiz, flags);
621 rc = be32_to_cpu(header->return_code);
622 if (rc != TPM2_RC_RETRY)
625 if (delay_msec > TPM2_DURATION_LONG) {
626 dev_err(&chip->dev, "TPM is in retry loop\n");
629 tpm_msleep(delay_msec);
631 memcpy(buf, save, save_size);
636 * tpm_transmit_cmd - send a tpm command to the device
637 * The function extracts tpm out header return code
639 * @chip: TPM chip to use
641 * @buf: TPM command buffer
642 * @bufsiz: length of the buffer
643 * @min_rsp_body_length: minimum expected length of response body
644 * @flags: tpm transmit flags - bitmap
645 * @desc: command description used in the error message
648 * 0 when the operation is successful.
649 * A negative number for system errors (errno).
650 * A positive number for a TPM error.
652 ssize_t tpm_transmit_cmd(struct tpm_chip *chip, struct tpm_space *space,
653 const void *buf, size_t bufsiz,
654 size_t min_rsp_body_length, unsigned int flags,
657 const struct tpm_output_header *header = buf;
661 len = tpm_transmit(chip, space, (u8 *)buf, bufsiz, flags);
665 err = be32_to_cpu(header->return_code);
666 if (err != 0 && err != TPM_ERR_DISABLED && err != TPM_ERR_DEACTIVATED
668 dev_err(&chip->dev, "A TPM error (%d) occurred %s\n", err,
673 if (len < min_rsp_body_length + TPM_HEADER_SIZE)
678 EXPORT_SYMBOL_GPL(tpm_transmit_cmd);
680 #define TPM_ORD_STARTUP 153
681 #define TPM_ST_CLEAR 1
684 * tpm_startup - turn on the TPM
685 * @chip: TPM chip to use
687 * Normally the firmware should start the TPM. This function is provided as a
688 * workaround if this does not happen. A legal case for this could be for
689 * example when a TPM emulator is used.
691 * Return: same as tpm_transmit_cmd()
693 int tpm_startup(struct tpm_chip *chip)
698 dev_info(&chip->dev, "starting up the TPM manually\n");
700 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
701 rc = tpm_buf_init(&buf, TPM2_ST_NO_SESSIONS, TPM2_CC_STARTUP);
705 tpm_buf_append_u16(&buf, TPM2_SU_CLEAR);
707 rc = tpm_buf_init(&buf, TPM_TAG_RQU_COMMAND, TPM_ORD_STARTUP);
711 tpm_buf_append_u16(&buf, TPM_ST_CLEAR);
714 rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE, 0, 0,
715 "attempting to start the TPM");
717 tpm_buf_destroy(&buf);
721 #define TPM_DIGEST_SIZE 20
722 #define TPM_RET_CODE_IDX 6
723 #define TPM_INTERNAL_RESULT_SIZE 200
724 #define TPM_ORD_GET_CAP 101
725 #define TPM_ORD_GET_RANDOM 70
727 static const struct tpm_input_header tpm_getcap_header = {
728 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
729 .length = cpu_to_be32(22),
730 .ordinal = cpu_to_be32(TPM_ORD_GET_CAP)
733 ssize_t tpm_getcap(struct tpm_chip *chip, u32 subcap_id, cap_t *cap,
734 const char *desc, size_t min_cap_length)
739 rc = tpm_buf_init(&buf, TPM_TAG_RQU_COMMAND, TPM_ORD_GET_CAP);
743 if (subcap_id == TPM_CAP_VERSION_1_1 ||
744 subcap_id == TPM_CAP_VERSION_1_2) {
745 tpm_buf_append_u32(&buf, subcap_id);
746 tpm_buf_append_u32(&buf, 0);
748 if (subcap_id == TPM_CAP_FLAG_PERM ||
749 subcap_id == TPM_CAP_FLAG_VOL)
750 tpm_buf_append_u32(&buf, TPM_CAP_FLAG);
752 tpm_buf_append_u32(&buf, TPM_CAP_PROP);
754 tpm_buf_append_u32(&buf, 4);
755 tpm_buf_append_u32(&buf, subcap_id);
757 rc = tpm_transmit_cmd(chip, NULL, buf.data, PAGE_SIZE,
758 min_cap_length, 0, desc);
760 *cap = *(cap_t *)&buf.data[TPM_HEADER_SIZE + 4];
762 tpm_buf_destroy(&buf);
765 EXPORT_SYMBOL_GPL(tpm_getcap);
767 int tpm_get_timeouts(struct tpm_chip *chip)
770 unsigned long timeout_old[4], timeout_chip[4], timeout_eff[4];
773 if (chip->flags & TPM_CHIP_FLAG_HAVE_TIMEOUTS)
776 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
777 /* Fixed timeouts for TPM2 */
778 chip->timeout_a = msecs_to_jiffies(TPM2_TIMEOUT_A);
779 chip->timeout_b = msecs_to_jiffies(TPM2_TIMEOUT_B);
780 chip->timeout_c = msecs_to_jiffies(TPM2_TIMEOUT_C);
781 chip->timeout_d = msecs_to_jiffies(TPM2_TIMEOUT_D);
782 chip->duration[TPM_SHORT] =
783 msecs_to_jiffies(TPM2_DURATION_SHORT);
784 chip->duration[TPM_MEDIUM] =
785 msecs_to_jiffies(TPM2_DURATION_MEDIUM);
786 chip->duration[TPM_LONG] =
787 msecs_to_jiffies(TPM2_DURATION_LONG);
789 chip->flags |= TPM_CHIP_FLAG_HAVE_TIMEOUTS;
793 rc = tpm_getcap(chip, TPM_CAP_PROP_TIS_TIMEOUT, &cap, NULL,
794 sizeof(cap.timeout));
795 if (rc == TPM_ERR_INVALID_POSTINIT) {
796 if (tpm_startup(chip))
799 rc = tpm_getcap(chip, TPM_CAP_PROP_TIS_TIMEOUT, &cap,
800 "attempting to determine the timeouts",
801 sizeof(cap.timeout));
806 "A TPM error (%zd) occurred attempting to determine the timeouts\n",
811 timeout_old[0] = jiffies_to_usecs(chip->timeout_a);
812 timeout_old[1] = jiffies_to_usecs(chip->timeout_b);
813 timeout_old[2] = jiffies_to_usecs(chip->timeout_c);
814 timeout_old[3] = jiffies_to_usecs(chip->timeout_d);
815 timeout_chip[0] = be32_to_cpu(cap.timeout.a);
816 timeout_chip[1] = be32_to_cpu(cap.timeout.b);
817 timeout_chip[2] = be32_to_cpu(cap.timeout.c);
818 timeout_chip[3] = be32_to_cpu(cap.timeout.d);
819 memcpy(timeout_eff, timeout_chip, sizeof(timeout_eff));
822 * Provide ability for vendor overrides of timeout values in case
825 if (chip->ops->update_timeouts != NULL)
826 chip->timeout_adjusted =
827 chip->ops->update_timeouts(chip, timeout_eff);
829 if (!chip->timeout_adjusted) {
830 /* Restore default if chip reported 0 */
833 for (i = 0; i < ARRAY_SIZE(timeout_eff); i++) {
837 timeout_eff[i] = timeout_old[i];
838 chip->timeout_adjusted = true;
841 if (timeout_eff[0] != 0 && timeout_eff[0] < 1000) {
842 /* timeouts in msec rather usec */
843 for (i = 0; i != ARRAY_SIZE(timeout_eff); i++)
844 timeout_eff[i] *= 1000;
845 chip->timeout_adjusted = true;
849 /* Report adjusted timeouts */
850 if (chip->timeout_adjusted) {
852 HW_ERR "Adjusting reported timeouts: A %lu->%luus B %lu->%luus C %lu->%luus D %lu->%luus\n",
853 timeout_chip[0], timeout_eff[0],
854 timeout_chip[1], timeout_eff[1],
855 timeout_chip[2], timeout_eff[2],
856 timeout_chip[3], timeout_eff[3]);
859 chip->timeout_a = usecs_to_jiffies(timeout_eff[0]);
860 chip->timeout_b = usecs_to_jiffies(timeout_eff[1]);
861 chip->timeout_c = usecs_to_jiffies(timeout_eff[2]);
862 chip->timeout_d = usecs_to_jiffies(timeout_eff[3]);
864 rc = tpm_getcap(chip, TPM_CAP_PROP_TIS_DURATION, &cap,
865 "attempting to determine the durations",
866 sizeof(cap.duration));
870 chip->duration[TPM_SHORT] =
871 usecs_to_jiffies(be32_to_cpu(cap.duration.tpm_short));
872 chip->duration[TPM_MEDIUM] =
873 usecs_to_jiffies(be32_to_cpu(cap.duration.tpm_medium));
874 chip->duration[TPM_LONG] =
875 usecs_to_jiffies(be32_to_cpu(cap.duration.tpm_long));
877 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
878 * value wrong and apparently reports msecs rather than usecs. So we
879 * fix up the resulting too-small TPM_SHORT value to make things work.
880 * We also scale the TPM_MEDIUM and -_LONG values by 1000.
882 if (chip->duration[TPM_SHORT] < (HZ / 100)) {
883 chip->duration[TPM_SHORT] = HZ;
884 chip->duration[TPM_MEDIUM] *= 1000;
885 chip->duration[TPM_LONG] *= 1000;
886 chip->duration_adjusted = true;
887 dev_info(&chip->dev, "Adjusting TPM timeout parameters.");
890 chip->flags |= TPM_CHIP_FLAG_HAVE_TIMEOUTS;
893 EXPORT_SYMBOL_GPL(tpm_get_timeouts);
895 #define TPM_ORD_CONTINUE_SELFTEST 83
896 #define CONTINUE_SELFTEST_RESULT_SIZE 10
898 static const struct tpm_input_header continue_selftest_header = {
899 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
900 .length = cpu_to_be32(10),
901 .ordinal = cpu_to_be32(TPM_ORD_CONTINUE_SELFTEST),
905 * tpm_continue_selftest -- run TPM's selftest
906 * @chip: TPM chip to use
908 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
911 static int tpm_continue_selftest(struct tpm_chip *chip)
914 struct tpm_cmd_t cmd;
916 cmd.header.in = continue_selftest_header;
917 rc = tpm_transmit_cmd(chip, NULL, &cmd, CONTINUE_SELFTEST_RESULT_SIZE,
918 0, 0, "continue selftest");
922 #define TPM_ORDINAL_PCRREAD 21
923 #define READ_PCR_RESULT_SIZE 30
924 #define READ_PCR_RESULT_BODY_SIZE 20
925 static const struct tpm_input_header pcrread_header = {
926 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
927 .length = cpu_to_be32(14),
928 .ordinal = cpu_to_be32(TPM_ORDINAL_PCRREAD)
931 int tpm_pcr_read_dev(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
934 struct tpm_cmd_t cmd;
936 cmd.header.in = pcrread_header;
937 cmd.params.pcrread_in.pcr_idx = cpu_to_be32(pcr_idx);
938 rc = tpm_transmit_cmd(chip, NULL, &cmd, READ_PCR_RESULT_SIZE,
939 READ_PCR_RESULT_BODY_SIZE, 0,
940 "attempting to read a pcr value");
943 memcpy(res_buf, cmd.params.pcrread_out.pcr_result,
949 * tpm_is_tpm2 - is the chip a TPM2 chip?
950 * @chip_num: tpm idx # or ANY
952 * Returns < 0 on error, and 1 or 0 on success depending whether the chip
955 int tpm_is_tpm2(u32 chip_num)
957 struct tpm_chip *chip;
960 chip = tpm_chip_find_get(chip_num);
964 rc = (chip->flags & TPM_CHIP_FLAG_TPM2) != 0;
970 EXPORT_SYMBOL_GPL(tpm_is_tpm2);
973 * tpm_pcr_read - read a pcr value
974 * @chip_num: tpm idx # or ANY
975 * @pcr_idx: pcr idx to retrieve
976 * @res_buf: TPM_PCR value
977 * size of res_buf is 20 bytes (or NULL if you don't care)
979 * The TPM driver should be built-in, but for whatever reason it
980 * isn't, protect against the chip disappearing, by incrementing
981 * the module usage count.
983 int tpm_pcr_read(u32 chip_num, int pcr_idx, u8 *res_buf)
985 struct tpm_chip *chip;
988 chip = tpm_chip_find_get(chip_num);
991 if (chip->flags & TPM_CHIP_FLAG_TPM2)
992 rc = tpm2_pcr_read(chip, pcr_idx, res_buf);
994 rc = tpm_pcr_read_dev(chip, pcr_idx, res_buf);
998 EXPORT_SYMBOL_GPL(tpm_pcr_read);
1000 #define TPM_ORD_PCR_EXTEND 20
1001 #define EXTEND_PCR_RESULT_SIZE 34
1002 #define EXTEND_PCR_RESULT_BODY_SIZE 20
1003 static const struct tpm_input_header pcrextend_header = {
1004 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
1005 .length = cpu_to_be32(34),
1006 .ordinal = cpu_to_be32(TPM_ORD_PCR_EXTEND)
1009 static int tpm1_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash,
1015 rc = tpm_buf_init(&buf, TPM_TAG_RQU_COMMAND, TPM_ORD_PCR_EXTEND);
1019 tpm_buf_append_u32(&buf, pcr_idx);
1020 tpm_buf_append(&buf, hash, TPM_DIGEST_SIZE);
1022 rc = tpm_transmit_cmd(chip, NULL, buf.data, EXTEND_PCR_RESULT_SIZE,
1023 EXTEND_PCR_RESULT_BODY_SIZE, 0, log_msg);
1024 tpm_buf_destroy(&buf);
1029 * tpm_pcr_extend - extend pcr value with hash
1030 * @chip_num: tpm idx # or AN&
1031 * @pcr_idx: pcr idx to extend
1032 * @hash: hash value used to extend pcr value
1034 * The TPM driver should be built-in, but for whatever reason it
1035 * isn't, protect against the chip disappearing, by incrementing
1036 * the module usage count.
1038 int tpm_pcr_extend(u32 chip_num, int pcr_idx, const u8 *hash)
1041 struct tpm_chip *chip;
1042 struct tpm2_digest digest_list[ARRAY_SIZE(chip->active_banks)];
1046 chip = tpm_chip_find_get(chip_num);
1050 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
1051 memset(digest_list, 0, sizeof(digest_list));
1053 for (i = 0; i < ARRAY_SIZE(chip->active_banks) &&
1054 chip->active_banks[i] != TPM2_ALG_ERROR; i++) {
1055 digest_list[i].alg_id = chip->active_banks[i];
1056 memcpy(digest_list[i].digest, hash, TPM_DIGEST_SIZE);
1060 rc = tpm2_pcr_extend(chip, pcr_idx, count, digest_list);
1065 rc = tpm1_pcr_extend(chip, pcr_idx, hash,
1066 "attempting extend a PCR value");
1070 EXPORT_SYMBOL_GPL(tpm_pcr_extend);
1073 * tpm_do_selftest - have the TPM continue its selftest and wait until it
1074 * can receive further commands
1075 * @chip: TPM chip to use
1077 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
1080 int tpm_do_selftest(struct tpm_chip *chip)
1084 unsigned int delay_msec = 100;
1085 unsigned long duration;
1086 u8 dummy[TPM_DIGEST_SIZE];
1088 duration = tpm_calc_ordinal_duration(chip, TPM_ORD_CONTINUE_SELFTEST);
1090 loops = jiffies_to_msecs(duration) / delay_msec;
1092 rc = tpm_continue_selftest(chip);
1093 if (rc == TPM_ERR_INVALID_POSTINIT) {
1094 chip->flags |= TPM_CHIP_FLAG_ALWAYS_POWERED;
1095 dev_info(&chip->dev, "TPM not ready (%d)\n", rc);
1097 /* This may fail if there was no TPM driver during a suspend/resume
1098 * cycle; some may return 10 (BAD_ORDINAL), others 28 (FAILEDSELFTEST)
1104 /* Attempt to read a PCR value */
1105 rc = tpm_pcr_read_dev(chip, 0, dummy);
1107 /* Some buggy TPMs will not respond to tpm_tis_ready() for
1108 * around 300ms while the self test is ongoing, keep trying
1109 * until the self test duration expires. */
1113 "TPM command timed out during continue self test");
1114 tpm_msleep(delay_msec);
1118 if (rc == TPM_ERR_DISABLED || rc == TPM_ERR_DEACTIVATED) {
1119 dev_info(&chip->dev,
1120 "TPM is disabled/deactivated (0x%X)\n", rc);
1121 /* TPM is disabled and/or deactivated; driver can
1122 * proceed and TPM does handle commands for
1123 * suspend/resume correctly
1127 if (rc != TPM_WARN_DOING_SELFTEST)
1129 tpm_msleep(delay_msec);
1130 } while (--loops > 0);
1134 EXPORT_SYMBOL_GPL(tpm_do_selftest);
1137 * tpm1_auto_startup - Perform the standard automatic TPM initialization
1139 * @chip: TPM chip to use
1141 * Returns 0 on success, < 0 in case of fatal error.
1143 int tpm1_auto_startup(struct tpm_chip *chip)
1147 rc = tpm_get_timeouts(chip);
1150 rc = tpm_do_selftest(chip);
1152 dev_err(&chip->dev, "TPM self test failed\n");
1163 int tpm_send(u32 chip_num, void *cmd, size_t buflen)
1165 struct tpm_chip *chip;
1168 chip = tpm_chip_find_get(chip_num);
1172 rc = tpm_transmit_cmd(chip, NULL, cmd, buflen, 0, 0,
1173 "attempting tpm_cmd");
1177 EXPORT_SYMBOL_GPL(tpm_send);
1179 static bool wait_for_tpm_stat_cond(struct tpm_chip *chip, u8 mask,
1180 bool check_cancel, bool *canceled)
1182 u8 status = chip->ops->status(chip);
1185 if ((status & mask) == mask)
1187 if (check_cancel && chip->ops->req_canceled(chip, status)) {
1194 int wait_for_tpm_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
1195 wait_queue_head_t *queue, bool check_cancel)
1200 bool canceled = false;
1202 /* check current status */
1203 status = chip->ops->status(chip);
1204 if ((status & mask) == mask)
1207 stop = jiffies + timeout;
1209 if (chip->flags & TPM_CHIP_FLAG_IRQ) {
1211 timeout = stop - jiffies;
1212 if ((long)timeout <= 0)
1214 rc = wait_event_interruptible_timeout(*queue,
1215 wait_for_tpm_stat_cond(chip, mask, check_cancel,
1223 if (rc == -ERESTARTSYS && freezing(current)) {
1224 clear_thread_flag(TIF_SIGPENDING);
1229 tpm_msleep(TPM_TIMEOUT);
1230 status = chip->ops->status(chip);
1231 if ((status & mask) == mask)
1233 } while (time_before(jiffies, stop));
1237 EXPORT_SYMBOL_GPL(wait_for_tpm_stat);
1239 #define TPM_ORD_SAVESTATE 152
1240 #define SAVESTATE_RESULT_SIZE 10
1242 static const struct tpm_input_header savestate_header = {
1243 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
1244 .length = cpu_to_be32(10),
1245 .ordinal = cpu_to_be32(TPM_ORD_SAVESTATE)
1249 * We are about to suspend. Save the TPM state
1250 * so that it can be restored.
1252 int tpm_pm_suspend(struct device *dev)
1254 struct tpm_chip *chip = dev_get_drvdata(dev);
1255 struct tpm_cmd_t cmd;
1258 u8 dummy_hash[TPM_DIGEST_SIZE] = { 0 };
1263 if (chip->flags & TPM_CHIP_FLAG_ALWAYS_POWERED)
1266 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
1267 tpm2_shutdown(chip, TPM2_SU_STATE);
1271 /* for buggy tpm, flush pcrs with extend to selected dummy */
1272 if (tpm_suspend_pcr)
1273 rc = tpm1_pcr_extend(chip, tpm_suspend_pcr, dummy_hash,
1274 "extending dummy pcr before suspend");
1276 /* now do the actual savestate */
1277 for (try = 0; try < TPM_RETRY; try++) {
1278 cmd.header.in = savestate_header;
1279 rc = tpm_transmit_cmd(chip, NULL, &cmd, SAVESTATE_RESULT_SIZE,
1283 * If the TPM indicates that it is too busy to respond to
1284 * this command then retry before giving up. It can take
1285 * several seconds for this TPM to be ready.
1287 * This can happen if the TPM has already been sent the
1288 * SaveState command before the driver has loaded. TCG 1.2
1289 * specification states that any communication after SaveState
1290 * may cause the TPM to invalidate previously saved state.
1292 if (rc != TPM_WARN_RETRY)
1294 tpm_msleep(TPM_TIMEOUT_RETRY);
1299 "Error (%d) sending savestate before suspend\n", rc);
1301 dev_warn(&chip->dev, "TPM savestate took %dms\n",
1302 try * TPM_TIMEOUT_RETRY);
1306 EXPORT_SYMBOL_GPL(tpm_pm_suspend);
1309 * Resume from a power safe. The BIOS already restored
1312 int tpm_pm_resume(struct device *dev)
1314 struct tpm_chip *chip = dev_get_drvdata(dev);
1321 EXPORT_SYMBOL_GPL(tpm_pm_resume);
1323 #define TPM_GETRANDOM_RESULT_SIZE 18
1324 static const struct tpm_input_header tpm_getrandom_header = {
1325 .tag = cpu_to_be16(TPM_TAG_RQU_COMMAND),
1326 .length = cpu_to_be32(14),
1327 .ordinal = cpu_to_be32(TPM_ORD_GET_RANDOM)
1331 * tpm_get_random() - Get random bytes from the tpm's RNG
1332 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1333 * @out: destination buffer for the random bytes
1334 * @max: the max number of bytes to write to @out
1336 * Returns < 0 on error and the number of bytes read on success
1338 int tpm_get_random(u32 chip_num, u8 *out, size_t max)
1340 struct tpm_chip *chip;
1341 struct tpm_cmd_t tpm_cmd;
1342 u32 recd, num_bytes = min_t(u32, max, TPM_MAX_RNG_DATA), rlength;
1343 int err, total = 0, retries = 5;
1346 if (!out || !num_bytes || max > TPM_MAX_RNG_DATA)
1349 chip = tpm_chip_find_get(chip_num);
1353 if (chip->flags & TPM_CHIP_FLAG_TPM2) {
1354 err = tpm2_get_random(chip, out, max);
1360 tpm_cmd.header.in = tpm_getrandom_header;
1361 tpm_cmd.params.getrandom_in.num_bytes = cpu_to_be32(num_bytes);
1363 err = tpm_transmit_cmd(chip, NULL, &tpm_cmd,
1364 TPM_GETRANDOM_RESULT_SIZE + num_bytes,
1365 offsetof(struct tpm_getrandom_out,
1367 0, "attempting get random");
1371 recd = be32_to_cpu(tpm_cmd.params.getrandom_out.rng_data_len);
1372 if (recd > num_bytes) {
1377 rlength = be32_to_cpu(tpm_cmd.header.out.length);
1378 if (rlength < offsetof(struct tpm_getrandom_out, rng_data) +
1383 memcpy(dest, tpm_cmd.params.getrandom_out.rng_data, recd);
1388 } while (retries-- && total < max);
1391 return total ? total : -EIO;
1393 EXPORT_SYMBOL_GPL(tpm_get_random);
1396 * tpm_seal_trusted() - seal a trusted key
1397 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1398 * @options: authentication values and other options
1399 * @payload: the key data in clear and encrypted form
1401 * Returns < 0 on error and 0 on success. At the moment, only TPM 2.0 chips
1404 int tpm_seal_trusted(u32 chip_num, struct trusted_key_payload *payload,
1405 struct trusted_key_options *options)
1407 struct tpm_chip *chip;
1410 chip = tpm_chip_find_get(chip_num);
1411 if (chip == NULL || !(chip->flags & TPM_CHIP_FLAG_TPM2))
1414 rc = tpm2_seal_trusted(chip, payload, options);
1419 EXPORT_SYMBOL_GPL(tpm_seal_trusted);
1422 * tpm_unseal_trusted() - unseal a trusted key
1423 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1424 * @options: authentication values and other options
1425 * @payload: the key data in clear and encrypted form
1427 * Returns < 0 on error and 0 on success. At the moment, only TPM 2.0 chips
1430 int tpm_unseal_trusted(u32 chip_num, struct trusted_key_payload *payload,
1431 struct trusted_key_options *options)
1433 struct tpm_chip *chip;
1436 chip = tpm_chip_find_get(chip_num);
1437 if (chip == NULL || !(chip->flags & TPM_CHIP_FLAG_TPM2))
1440 rc = tpm2_unseal_trusted(chip, payload, options);
1446 EXPORT_SYMBOL_GPL(tpm_unseal_trusted);
1448 static int __init tpm_init(void)
1452 tpm_class = class_create(THIS_MODULE, "tpm");
1453 if (IS_ERR(tpm_class)) {
1454 pr_err("couldn't create tpm class\n");
1455 return PTR_ERR(tpm_class);
1458 tpmrm_class = class_create(THIS_MODULE, "tpmrm");
1459 if (IS_ERR(tpmrm_class)) {
1460 pr_err("couldn't create tpmrm class\n");
1461 class_destroy(tpm_class);
1462 return PTR_ERR(tpmrm_class);
1465 rc = alloc_chrdev_region(&tpm_devt, 0, 2*TPM_NUM_DEVICES, "tpm");
1467 pr_err("tpm: failed to allocate char dev region\n");
1468 class_destroy(tpmrm_class);
1469 class_destroy(tpm_class);
1476 static void __exit tpm_exit(void)
1478 idr_destroy(&dev_nums_idr);
1479 class_destroy(tpm_class);
1480 class_destroy(tpmrm_class);
1481 unregister_chrdev_region(tpm_devt, 2*TPM_NUM_DEVICES);
1484 subsys_initcall(tpm_init);
1485 module_exit(tpm_exit);
1487 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1488 MODULE_DESCRIPTION("TPM Driver");
1489 MODULE_VERSION("2.0");
1490 MODULE_LICENSE("GPL");