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 bool 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 if (!tpm_validate_command(chip
, space
, buf
, bufsiz
))
397 if (bufsiz
> TPM_BUFSIZE
)
398 bufsiz
= TPM_BUFSIZE
;
400 count
= be32_to_cpu(*((__be32
*) (buf
+ 2)));
401 ordinal
= be32_to_cpu(*((__be32
*) (buf
+ 6)));
404 if (count
> bufsiz
) {
406 "invalid count value %x %zx\n", count
, bufsiz
);
410 if (!(flags
& TPM_TRANSMIT_UNLOCKED
))
411 mutex_lock(&chip
->tpm_mutex
);
413 if (chip
->dev
.parent
)
414 pm_runtime_get_sync(chip
->dev
.parent
);
416 /* Store the decision as chip->locality will be changed. */
417 need_locality
= chip
->locality
== -1;
419 if (!(flags
& TPM_TRANSMIT_RAW
) &&
420 need_locality
&& chip
->ops
->request_locality
) {
421 rc
= chip
->ops
->request_locality(chip
, 0);
423 goto out_no_locality
;
427 rc
= tpm2_prepare_space(chip
, space
, ordinal
, buf
);
431 rc
= chip
->ops
->send(chip
, (u8
*) buf
, count
);
435 "%s: tpm_send: error %d\n", __func__
, rc
);
439 if (chip
->flags
& TPM_CHIP_FLAG_IRQ
)
442 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
)
443 stop
= jiffies
+ tpm2_calc_ordinal_duration(chip
, ordinal
);
445 stop
= jiffies
+ tpm_calc_ordinal_duration(chip
, ordinal
);
447 u8 status
= chip
->ops
->status(chip
);
448 if ((status
& chip
->ops
->req_complete_mask
) ==
449 chip
->ops
->req_complete_val
)
452 if (chip
->ops
->req_canceled(chip
, status
)) {
453 dev_err(&chip
->dev
, "Operation Canceled\n");
458 tpm_msleep(TPM_TIMEOUT
);
460 } while (time_before(jiffies
, stop
));
462 chip
->ops
->cancel(chip
);
463 dev_err(&chip
->dev
, "Operation Timed out\n");
468 len
= chip
->ops
->recv(chip
, (u8
*) buf
, bufsiz
);
472 "tpm_transmit: tpm_recv: error %d\n", rc
);
474 } else if (len
< TPM_HEADER_SIZE
) {
479 if (len
!= be32_to_cpu(header
->length
)) {
484 rc
= tpm2_commit_space(chip
, space
, ordinal
, buf
, &len
);
487 if (need_locality
&& chip
->ops
->relinquish_locality
) {
488 chip
->ops
->relinquish_locality(chip
, chip
->locality
);
492 if (chip
->dev
.parent
)
493 pm_runtime_put_sync(chip
->dev
.parent
);
495 if (!(flags
& TPM_TRANSMIT_UNLOCKED
))
496 mutex_unlock(&chip
->tpm_mutex
);
497 return rc
? rc
: len
;
501 * tmp_transmit_cmd - send a tpm command to the device
502 * The function extracts tpm out header return code
504 * @chip: TPM chip to use
505 * @buf: TPM command buffer
506 * @bufsiz: length of the buffer
507 * @min_rsp_body_length: minimum expected length of response body
508 * @flags: tpm transmit flags - bitmap
509 * @desc: command description used in the error message
512 * 0 when the operation is successful.
513 * A negative number for system errors (errno).
514 * A positive number for a TPM error.
516 ssize_t
tpm_transmit_cmd(struct tpm_chip
*chip
, struct tpm_space
*space
,
517 const void *buf
, size_t bufsiz
,
518 size_t min_rsp_body_length
, unsigned int flags
,
521 const struct tpm_output_header
*header
= buf
;
525 len
= tpm_transmit(chip
, space
, (u8
*)buf
, bufsiz
, flags
);
529 err
= be32_to_cpu(header
->return_code
);
530 if (err
!= 0 && desc
)
531 dev_err(&chip
->dev
, "A TPM error (%d) occurred %s\n", err
,
536 if (len
< min_rsp_body_length
+ TPM_HEADER_SIZE
)
541 EXPORT_SYMBOL_GPL(tpm_transmit_cmd
);
543 #define TPM_ORD_STARTUP 153
544 #define TPM_ST_CLEAR 1
547 * tpm_startup - turn on the TPM
548 * @chip: TPM chip to use
550 * Normally the firmware should start the TPM. This function is provided as a
551 * workaround if this does not happen. A legal case for this could be for
552 * example when a TPM emulator is used.
554 * Return: same as tpm_transmit_cmd()
556 int tpm_startup(struct tpm_chip
*chip
)
561 dev_info(&chip
->dev
, "starting up the TPM manually\n");
563 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
564 rc
= tpm_buf_init(&buf
, TPM2_ST_NO_SESSIONS
, TPM2_CC_STARTUP
);
568 tpm_buf_append_u16(&buf
, TPM2_SU_CLEAR
);
570 rc
= tpm_buf_init(&buf
, TPM_TAG_RQU_COMMAND
, TPM_ORD_STARTUP
);
574 tpm_buf_append_u16(&buf
, TPM_ST_CLEAR
);
577 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 0, 0,
578 "attempting to start the TPM");
580 tpm_buf_destroy(&buf
);
584 #define TPM_DIGEST_SIZE 20
585 #define TPM_RET_CODE_IDX 6
586 #define TPM_INTERNAL_RESULT_SIZE 200
587 #define TPM_ORD_GET_CAP 101
588 #define TPM_ORD_GET_RANDOM 70
590 static const struct tpm_input_header tpm_getcap_header
= {
591 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
592 .length
= cpu_to_be32(22),
593 .ordinal
= cpu_to_be32(TPM_ORD_GET_CAP
)
596 ssize_t
tpm_getcap(struct tpm_chip
*chip
, u32 subcap_id
, cap_t
*cap
,
597 const char *desc
, size_t min_cap_length
)
602 rc
= tpm_buf_init(&buf
, TPM_TAG_RQU_COMMAND
, TPM_ORD_GET_CAP
);
606 if (subcap_id
== TPM_CAP_VERSION_1_1
||
607 subcap_id
== TPM_CAP_VERSION_1_2
) {
608 tpm_buf_append_u32(&buf
, subcap_id
);
609 tpm_buf_append_u32(&buf
, 0);
611 if (subcap_id
== TPM_CAP_FLAG_PERM
||
612 subcap_id
== TPM_CAP_FLAG_VOL
)
613 tpm_buf_append_u32(&buf
, TPM_CAP_FLAG
);
615 tpm_buf_append_u32(&buf
, TPM_CAP_PROP
);
617 tpm_buf_append_u32(&buf
, 4);
618 tpm_buf_append_u32(&buf
, subcap_id
);
620 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
,
621 min_cap_length
, 0, desc
);
623 *cap
= *(cap_t
*)&buf
.data
[TPM_HEADER_SIZE
+ 4];
625 tpm_buf_destroy(&buf
);
628 EXPORT_SYMBOL_GPL(tpm_getcap
);
630 int tpm_get_timeouts(struct tpm_chip
*chip
)
633 unsigned long timeout_old
[4], timeout_chip
[4], timeout_eff
[4];
636 if (chip
->flags
& TPM_CHIP_FLAG_HAVE_TIMEOUTS
)
639 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
640 /* Fixed timeouts for TPM2 */
641 chip
->timeout_a
= msecs_to_jiffies(TPM2_TIMEOUT_A
);
642 chip
->timeout_b
= msecs_to_jiffies(TPM2_TIMEOUT_B
);
643 chip
->timeout_c
= msecs_to_jiffies(TPM2_TIMEOUT_C
);
644 chip
->timeout_d
= msecs_to_jiffies(TPM2_TIMEOUT_D
);
645 chip
->duration
[TPM_SHORT
] =
646 msecs_to_jiffies(TPM2_DURATION_SHORT
);
647 chip
->duration
[TPM_MEDIUM
] =
648 msecs_to_jiffies(TPM2_DURATION_MEDIUM
);
649 chip
->duration
[TPM_LONG
] =
650 msecs_to_jiffies(TPM2_DURATION_LONG
);
652 chip
->flags
|= TPM_CHIP_FLAG_HAVE_TIMEOUTS
;
656 rc
= tpm_getcap(chip
, TPM_CAP_PROP_TIS_TIMEOUT
, &cap
, NULL
,
657 sizeof(cap
.timeout
));
658 if (rc
== TPM_ERR_INVALID_POSTINIT
) {
659 if (tpm_startup(chip
))
662 rc
= tpm_getcap(chip
, TPM_CAP_PROP_TIS_TIMEOUT
, &cap
,
663 "attempting to determine the timeouts",
664 sizeof(cap
.timeout
));
669 "A TPM error (%zd) occurred attempting to determine the timeouts\n",
674 timeout_old
[0] = jiffies_to_usecs(chip
->timeout_a
);
675 timeout_old
[1] = jiffies_to_usecs(chip
->timeout_b
);
676 timeout_old
[2] = jiffies_to_usecs(chip
->timeout_c
);
677 timeout_old
[3] = jiffies_to_usecs(chip
->timeout_d
);
678 timeout_chip
[0] = be32_to_cpu(cap
.timeout
.a
);
679 timeout_chip
[1] = be32_to_cpu(cap
.timeout
.b
);
680 timeout_chip
[2] = be32_to_cpu(cap
.timeout
.c
);
681 timeout_chip
[3] = be32_to_cpu(cap
.timeout
.d
);
682 memcpy(timeout_eff
, timeout_chip
, sizeof(timeout_eff
));
685 * Provide ability for vendor overrides of timeout values in case
688 if (chip
->ops
->update_timeouts
!= NULL
)
689 chip
->timeout_adjusted
=
690 chip
->ops
->update_timeouts(chip
, timeout_eff
);
692 if (!chip
->timeout_adjusted
) {
693 /* Restore default if chip reported 0 */
696 for (i
= 0; i
< ARRAY_SIZE(timeout_eff
); i
++) {
700 timeout_eff
[i
] = timeout_old
[i
];
701 chip
->timeout_adjusted
= true;
704 if (timeout_eff
[0] != 0 && timeout_eff
[0] < 1000) {
705 /* timeouts in msec rather usec */
706 for (i
= 0; i
!= ARRAY_SIZE(timeout_eff
); i
++)
707 timeout_eff
[i
] *= 1000;
708 chip
->timeout_adjusted
= true;
712 /* Report adjusted timeouts */
713 if (chip
->timeout_adjusted
) {
715 HW_ERR
"Adjusting reported timeouts: A %lu->%luus B %lu->%luus C %lu->%luus D %lu->%luus\n",
716 timeout_chip
[0], timeout_eff
[0],
717 timeout_chip
[1], timeout_eff
[1],
718 timeout_chip
[2], timeout_eff
[2],
719 timeout_chip
[3], timeout_eff
[3]);
722 chip
->timeout_a
= usecs_to_jiffies(timeout_eff
[0]);
723 chip
->timeout_b
= usecs_to_jiffies(timeout_eff
[1]);
724 chip
->timeout_c
= usecs_to_jiffies(timeout_eff
[2]);
725 chip
->timeout_d
= usecs_to_jiffies(timeout_eff
[3]);
727 rc
= tpm_getcap(chip
, TPM_CAP_PROP_TIS_DURATION
, &cap
,
728 "attempting to determine the durations",
729 sizeof(cap
.duration
));
733 chip
->duration
[TPM_SHORT
] =
734 usecs_to_jiffies(be32_to_cpu(cap
.duration
.tpm_short
));
735 chip
->duration
[TPM_MEDIUM
] =
736 usecs_to_jiffies(be32_to_cpu(cap
.duration
.tpm_medium
));
737 chip
->duration
[TPM_LONG
] =
738 usecs_to_jiffies(be32_to_cpu(cap
.duration
.tpm_long
));
740 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
741 * value wrong and apparently reports msecs rather than usecs. So we
742 * fix up the resulting too-small TPM_SHORT value to make things work.
743 * We also scale the TPM_MEDIUM and -_LONG values by 1000.
745 if (chip
->duration
[TPM_SHORT
] < (HZ
/ 100)) {
746 chip
->duration
[TPM_SHORT
] = HZ
;
747 chip
->duration
[TPM_MEDIUM
] *= 1000;
748 chip
->duration
[TPM_LONG
] *= 1000;
749 chip
->duration_adjusted
= true;
750 dev_info(&chip
->dev
, "Adjusting TPM timeout parameters.");
753 chip
->flags
|= TPM_CHIP_FLAG_HAVE_TIMEOUTS
;
756 EXPORT_SYMBOL_GPL(tpm_get_timeouts
);
758 #define TPM_ORD_CONTINUE_SELFTEST 83
759 #define CONTINUE_SELFTEST_RESULT_SIZE 10
761 static const struct tpm_input_header continue_selftest_header
= {
762 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
763 .length
= cpu_to_be32(10),
764 .ordinal
= cpu_to_be32(TPM_ORD_CONTINUE_SELFTEST
),
768 * tpm_continue_selftest -- run TPM's selftest
769 * @chip: TPM chip to use
771 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
774 static int tpm_continue_selftest(struct tpm_chip
*chip
)
777 struct tpm_cmd_t cmd
;
779 cmd
.header
.in
= continue_selftest_header
;
780 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, CONTINUE_SELFTEST_RESULT_SIZE
,
781 0, 0, "continue selftest");
785 #define TPM_ORDINAL_PCRREAD 21
786 #define READ_PCR_RESULT_SIZE 30
787 #define READ_PCR_RESULT_BODY_SIZE 20
788 static const struct tpm_input_header pcrread_header
= {
789 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
790 .length
= cpu_to_be32(14),
791 .ordinal
= cpu_to_be32(TPM_ORDINAL_PCRREAD
)
794 int tpm_pcr_read_dev(struct tpm_chip
*chip
, int pcr_idx
, u8
*res_buf
)
797 struct tpm_cmd_t cmd
;
799 cmd
.header
.in
= pcrread_header
;
800 cmd
.params
.pcrread_in
.pcr_idx
= cpu_to_be32(pcr_idx
);
801 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, READ_PCR_RESULT_SIZE
,
802 READ_PCR_RESULT_BODY_SIZE
, 0,
803 "attempting to read a pcr value");
806 memcpy(res_buf
, cmd
.params
.pcrread_out
.pcr_result
,
812 * tpm_is_tpm2 - is the chip a TPM2 chip?
813 * @chip_num: tpm idx # or ANY
815 * Returns < 0 on error, and 1 or 0 on success depending whether the chip
818 int tpm_is_tpm2(u32 chip_num
)
820 struct tpm_chip
*chip
;
823 chip
= tpm_chip_find_get(chip_num
);
827 rc
= (chip
->flags
& TPM_CHIP_FLAG_TPM2
) != 0;
833 EXPORT_SYMBOL_GPL(tpm_is_tpm2
);
836 * tpm_pcr_read - read a pcr value
837 * @chip_num: tpm idx # or ANY
838 * @pcr_idx: pcr idx to retrieve
839 * @res_buf: TPM_PCR value
840 * size of res_buf is 20 bytes (or NULL if you don't care)
842 * The TPM driver should be built-in, but for whatever reason it
843 * isn't, protect against the chip disappearing, by incrementing
844 * the module usage count.
846 int tpm_pcr_read(u32 chip_num
, int pcr_idx
, u8
*res_buf
)
848 struct tpm_chip
*chip
;
851 chip
= tpm_chip_find_get(chip_num
);
854 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
)
855 rc
= tpm2_pcr_read(chip
, pcr_idx
, res_buf
);
857 rc
= tpm_pcr_read_dev(chip
, pcr_idx
, res_buf
);
861 EXPORT_SYMBOL_GPL(tpm_pcr_read
);
863 #define TPM_ORD_PCR_EXTEND 20
864 #define EXTEND_PCR_RESULT_SIZE 34
865 #define EXTEND_PCR_RESULT_BODY_SIZE 20
866 static const struct tpm_input_header pcrextend_header
= {
867 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
868 .length
= cpu_to_be32(34),
869 .ordinal
= cpu_to_be32(TPM_ORD_PCR_EXTEND
)
872 static int tpm1_pcr_extend(struct tpm_chip
*chip
, int pcr_idx
, const u8
*hash
,
878 rc
= tpm_buf_init(&buf
, TPM_TAG_RQU_COMMAND
, TPM_ORD_PCR_EXTEND
);
882 tpm_buf_append_u32(&buf
, pcr_idx
);
883 tpm_buf_append(&buf
, hash
, TPM_DIGEST_SIZE
);
885 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, EXTEND_PCR_RESULT_SIZE
,
886 EXTEND_PCR_RESULT_BODY_SIZE
, 0, log_msg
);
887 tpm_buf_destroy(&buf
);
892 * tpm_pcr_extend - extend pcr value with hash
893 * @chip_num: tpm idx # or AN&
894 * @pcr_idx: pcr idx to extend
895 * @hash: hash value used to extend pcr value
897 * The TPM driver should be built-in, but for whatever reason it
898 * isn't, protect against the chip disappearing, by incrementing
899 * the module usage count.
901 int tpm_pcr_extend(u32 chip_num
, int pcr_idx
, const u8
*hash
)
904 struct tpm_chip
*chip
;
905 struct tpm2_digest digest_list
[ARRAY_SIZE(chip
->active_banks
)];
909 chip
= tpm_chip_find_get(chip_num
);
913 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
914 memset(digest_list
, 0, sizeof(digest_list
));
916 for (i
= 0; i
< ARRAY_SIZE(chip
->active_banks
) &&
917 chip
->active_banks
[i
] != TPM2_ALG_ERROR
; i
++) {
918 digest_list
[i
].alg_id
= chip
->active_banks
[i
];
919 memcpy(digest_list
[i
].digest
, hash
, TPM_DIGEST_SIZE
);
923 rc
= tpm2_pcr_extend(chip
, pcr_idx
, count
, digest_list
);
928 rc
= tpm1_pcr_extend(chip
, pcr_idx
, hash
,
929 "attempting extend a PCR value");
933 EXPORT_SYMBOL_GPL(tpm_pcr_extend
);
936 * tpm_do_selftest - have the TPM continue its selftest and wait until it
937 * can receive further commands
938 * @chip: TPM chip to use
940 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
943 int tpm_do_selftest(struct tpm_chip
*chip
)
947 unsigned int delay_msec
= 100;
948 unsigned long duration
;
949 u8 dummy
[TPM_DIGEST_SIZE
];
951 duration
= tpm_calc_ordinal_duration(chip
, TPM_ORD_CONTINUE_SELFTEST
);
953 loops
= jiffies_to_msecs(duration
) / delay_msec
;
955 rc
= tpm_continue_selftest(chip
);
956 /* This may fail if there was no TPM driver during a suspend/resume
957 * cycle; some may return 10 (BAD_ORDINAL), others 28 (FAILEDSELFTEST)
963 /* Attempt to read a PCR value */
964 rc
= tpm_pcr_read_dev(chip
, 0, dummy
);
966 /* Some buggy TPMs will not respond to tpm_tis_ready() for
967 * around 300ms while the self test is ongoing, keep trying
968 * until the self test duration expires. */
972 "TPM command timed out during continue self test");
973 tpm_msleep(delay_msec
);
977 if (rc
== TPM_ERR_DISABLED
|| rc
== TPM_ERR_DEACTIVATED
) {
979 "TPM is disabled/deactivated (0x%X)\n", rc
);
980 /* TPM is disabled and/or deactivated; driver can
981 * proceed and TPM does handle commands for
982 * suspend/resume correctly
986 if (rc
!= TPM_WARN_DOING_SELFTEST
)
988 tpm_msleep(delay_msec
);
989 } while (--loops
> 0);
993 EXPORT_SYMBOL_GPL(tpm_do_selftest
);
996 * tpm1_auto_startup - Perform the standard automatic TPM initialization
998 * @chip: TPM chip to use
1000 * Returns 0 on success, < 0 in case of fatal error.
1002 int tpm1_auto_startup(struct tpm_chip
*chip
)
1006 rc
= tpm_get_timeouts(chip
);
1009 rc
= tpm_do_selftest(chip
);
1011 dev_err(&chip
->dev
, "TPM self test failed\n");
1022 int tpm_send(u32 chip_num
, void *cmd
, size_t buflen
)
1024 struct tpm_chip
*chip
;
1027 chip
= tpm_chip_find_get(chip_num
);
1031 rc
= tpm_transmit_cmd(chip
, NULL
, cmd
, buflen
, 0, 0,
1032 "attempting tpm_cmd");
1036 EXPORT_SYMBOL_GPL(tpm_send
);
1038 static bool wait_for_tpm_stat_cond(struct tpm_chip
*chip
, u8 mask
,
1039 bool check_cancel
, bool *canceled
)
1041 u8 status
= chip
->ops
->status(chip
);
1044 if ((status
& mask
) == mask
)
1046 if (check_cancel
&& chip
->ops
->req_canceled(chip
, status
)) {
1053 int wait_for_tpm_stat(struct tpm_chip
*chip
, u8 mask
, unsigned long timeout
,
1054 wait_queue_head_t
*queue
, bool check_cancel
)
1059 bool canceled
= false;
1061 /* check current status */
1062 status
= chip
->ops
->status(chip
);
1063 if ((status
& mask
) == mask
)
1066 stop
= jiffies
+ timeout
;
1068 if (chip
->flags
& TPM_CHIP_FLAG_IRQ
) {
1070 timeout
= stop
- jiffies
;
1071 if ((long)timeout
<= 0)
1073 rc
= wait_event_interruptible_timeout(*queue
,
1074 wait_for_tpm_stat_cond(chip
, mask
, check_cancel
,
1082 if (rc
== -ERESTARTSYS
&& freezing(current
)) {
1083 clear_thread_flag(TIF_SIGPENDING
);
1088 tpm_msleep(TPM_TIMEOUT
);
1089 status
= chip
->ops
->status(chip
);
1090 if ((status
& mask
) == mask
)
1092 } while (time_before(jiffies
, stop
));
1096 EXPORT_SYMBOL_GPL(wait_for_tpm_stat
);
1098 #define TPM_ORD_SAVESTATE 152
1099 #define SAVESTATE_RESULT_SIZE 10
1101 static const struct tpm_input_header savestate_header
= {
1102 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
1103 .length
= cpu_to_be32(10),
1104 .ordinal
= cpu_to_be32(TPM_ORD_SAVESTATE
)
1108 * We are about to suspend. Save the TPM state
1109 * so that it can be restored.
1111 int tpm_pm_suspend(struct device
*dev
)
1113 struct tpm_chip
*chip
= dev_get_drvdata(dev
);
1114 struct tpm_cmd_t cmd
;
1117 u8 dummy_hash
[TPM_DIGEST_SIZE
] = { 0 };
1122 if (chip
->flags
& TPM_CHIP_FLAG_ALWAYS_POWERED
)
1125 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
1126 tpm2_shutdown(chip
, TPM2_SU_STATE
);
1130 /* for buggy tpm, flush pcrs with extend to selected dummy */
1131 if (tpm_suspend_pcr
)
1132 rc
= tpm1_pcr_extend(chip
, tpm_suspend_pcr
, dummy_hash
,
1133 "extending dummy pcr before suspend");
1135 /* now do the actual savestate */
1136 for (try = 0; try < TPM_RETRY
; try++) {
1137 cmd
.header
.in
= savestate_header
;
1138 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, SAVESTATE_RESULT_SIZE
,
1142 * If the TPM indicates that it is too busy to respond to
1143 * this command then retry before giving up. It can take
1144 * several seconds for this TPM to be ready.
1146 * This can happen if the TPM has already been sent the
1147 * SaveState command before the driver has loaded. TCG 1.2
1148 * specification states that any communication after SaveState
1149 * may cause the TPM to invalidate previously saved state.
1151 if (rc
!= TPM_WARN_RETRY
)
1153 tpm_msleep(TPM_TIMEOUT_RETRY
);
1158 "Error (%d) sending savestate before suspend\n", rc
);
1160 dev_warn(&chip
->dev
, "TPM savestate took %dms\n",
1161 try * TPM_TIMEOUT_RETRY
);
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 #define TPM_GETRANDOM_RESULT_SIZE 18
1183 static const struct tpm_input_header tpm_getrandom_header
= {
1184 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
1185 .length
= cpu_to_be32(14),
1186 .ordinal
= cpu_to_be32(TPM_ORD_GET_RANDOM
)
1190 * tpm_get_random() - Get random bytes from the tpm's RNG
1191 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1192 * @out: destination buffer for the random bytes
1193 * @max: the max number of bytes to write to @out
1195 * Returns < 0 on error and the number of bytes read on success
1197 int tpm_get_random(u32 chip_num
, u8
*out
, size_t max
)
1199 struct tpm_chip
*chip
;
1200 struct tpm_cmd_t tpm_cmd
;
1201 u32 recd
, num_bytes
= min_t(u32
, max
, TPM_MAX_RNG_DATA
), rlength
;
1202 int err
, total
= 0, retries
= 5;
1205 if (!out
|| !num_bytes
|| max
> TPM_MAX_RNG_DATA
)
1208 chip
= tpm_chip_find_get(chip_num
);
1212 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
1213 err
= tpm2_get_random(chip
, out
, max
);
1219 tpm_cmd
.header
.in
= tpm_getrandom_header
;
1220 tpm_cmd
.params
.getrandom_in
.num_bytes
= cpu_to_be32(num_bytes
);
1222 err
= tpm_transmit_cmd(chip
, NULL
, &tpm_cmd
,
1223 TPM_GETRANDOM_RESULT_SIZE
+ num_bytes
,
1224 offsetof(struct tpm_getrandom_out
,
1226 0, "attempting get random");
1230 recd
= be32_to_cpu(tpm_cmd
.params
.getrandom_out
.rng_data_len
);
1232 rlength
= be32_to_cpu(tpm_cmd
.header
.out
.length
);
1233 if (rlength
< offsetof(struct tpm_getrandom_out
, rng_data
) +
1238 memcpy(dest
, tpm_cmd
.params
.getrandom_out
.rng_data
, recd
);
1243 } while (retries
-- && total
< max
);
1246 return total
? total
: -EIO
;
1248 EXPORT_SYMBOL_GPL(tpm_get_random
);
1251 * tpm_seal_trusted() - seal a trusted key
1252 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1253 * @options: authentication values and other options
1254 * @payload: the key data in clear and encrypted form
1256 * Returns < 0 on error and 0 on success. At the moment, only TPM 2.0 chips
1259 int tpm_seal_trusted(u32 chip_num
, struct trusted_key_payload
*payload
,
1260 struct trusted_key_options
*options
)
1262 struct tpm_chip
*chip
;
1265 chip
= tpm_chip_find_get(chip_num
);
1266 if (chip
== NULL
|| !(chip
->flags
& TPM_CHIP_FLAG_TPM2
))
1269 rc
= tpm2_seal_trusted(chip
, payload
, options
);
1274 EXPORT_SYMBOL_GPL(tpm_seal_trusted
);
1277 * tpm_unseal_trusted() - unseal a trusted key
1278 * @chip_num: A specific chip number for the request or TPM_ANY_NUM
1279 * @options: authentication values and other options
1280 * @payload: the key data in clear and encrypted form
1282 * Returns < 0 on error and 0 on success. At the moment, only TPM 2.0 chips
1285 int tpm_unseal_trusted(u32 chip_num
, struct trusted_key_payload
*payload
,
1286 struct trusted_key_options
*options
)
1288 struct tpm_chip
*chip
;
1291 chip
= tpm_chip_find_get(chip_num
);
1292 if (chip
== NULL
|| !(chip
->flags
& TPM_CHIP_FLAG_TPM2
))
1295 rc
= tpm2_unseal_trusted(chip
, payload
, options
);
1301 EXPORT_SYMBOL_GPL(tpm_unseal_trusted
);
1303 static int __init
tpm_init(void)
1307 tpm_class
= class_create(THIS_MODULE
, "tpm");
1308 if (IS_ERR(tpm_class
)) {
1309 pr_err("couldn't create tpm class\n");
1310 return PTR_ERR(tpm_class
);
1313 tpmrm_class
= class_create(THIS_MODULE
, "tpmrm");
1314 if (IS_ERR(tpmrm_class
)) {
1315 pr_err("couldn't create tpmrm class\n");
1316 class_destroy(tpm_class
);
1317 return PTR_ERR(tpmrm_class
);
1320 rc
= alloc_chrdev_region(&tpm_devt
, 0, 2*TPM_NUM_DEVICES
, "tpm");
1322 pr_err("tpm: failed to allocate char dev region\n");
1323 class_destroy(tpmrm_class
);
1324 class_destroy(tpm_class
);
1331 static void __exit
tpm_exit(void)
1333 idr_destroy(&dev_nums_idr
);
1334 class_destroy(tpm_class
);
1335 class_destroy(tpmrm_class
);
1336 unregister_chrdev_region(tpm_devt
, 2*TPM_NUM_DEVICES
);
1339 subsys_initcall(tpm_init
);
1340 module_exit(tpm_exit
);
1342 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1343 MODULE_DESCRIPTION("TPM Driver");
1344 MODULE_VERSION("2.0");
1345 MODULE_LICENSE("GPL");