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/tpm_eventlog.h>
36 #define TPM_MAX_ORDINAL 243
37 #define TSC_MAX_ORDINAL 12
38 #define TPM_PROTECTED_COMMAND 0x00
39 #define TPM_CONNECTION_COMMAND 0x40
42 * Bug workaround - some TPM's don't flush the most
43 * recently changed pcr on suspend, so force the flush
44 * with an extend to the selected _unused_ non-volatile pcr.
46 static int tpm_suspend_pcr
;
47 module_param_named(suspend_pcr
, tpm_suspend_pcr
, uint
, 0644);
48 MODULE_PARM_DESC(suspend_pcr
,
49 "PCR to use for dummy writes to facilitate flush on suspend.");
52 * Array with one entry per ordinal defining the maximum amount
53 * of time the chip could take to return the result. The ordinal
54 * designation of short, medium or long is defined in a table in
55 * TCG Specification TPM Main Part 2 TPM Structures Section 17. The
56 * values of the SHORT, MEDIUM, and LONG durations are retrieved
57 * from the chip during initialization with a call to tpm_get_timeouts.
59 static const u8 tpm_ordinal_duration
[TPM_MAX_ORDINAL
] = {
60 TPM_UNDEFINED
, /* 0 */
65 TPM_UNDEFINED
, /* 5 */
115 TPM_UNDEFINED
, /* 55 */
135 TPM_UNDEFINED
, /* 75 */
145 TPM_UNDEFINED
, /* 85 */
155 TPM_UNDEFINED
, /* 95 */
160 TPM_MEDIUM
, /* 100 */
165 TPM_UNDEFINED
, /* 105 */
195 TPM_UNDEFINED
, /* 135 */
205 TPM_UNDEFINED
, /* 145 */
215 TPM_UNDEFINED
, /* 155 */
225 TPM_UNDEFINED
, /* 165 */
235 TPM_UNDEFINED
, /* 175 */
240 TPM_MEDIUM
, /* 180 */
245 TPM_MEDIUM
, /* 185 */
250 TPM_UNDEFINED
, /* 190 */
255 TPM_UNDEFINED
, /* 195 */
270 TPM_MEDIUM
, /* 210 */
275 TPM_UNDEFINED
, /* 215 */
285 TPM_UNDEFINED
, /* 225 */
295 TPM_UNDEFINED
, /* 235 */
306 * Returns max number of jiffies to wait
308 unsigned long tpm_calc_ordinal_duration(struct tpm_chip
*chip
,
311 int duration_idx
= TPM_UNDEFINED
;
315 * We only have a duration table for protected commands, where the upper
316 * 16 bits are 0. For the few other ordinals the fallback will be used.
318 if (ordinal
< TPM_MAX_ORDINAL
)
319 duration_idx
= tpm_ordinal_duration
[ordinal
];
321 if (duration_idx
!= TPM_UNDEFINED
)
322 duration
= chip
->duration
[duration_idx
];
328 EXPORT_SYMBOL_GPL(tpm_calc_ordinal_duration
);
330 static int tpm_validate_command(struct tpm_chip
*chip
,
331 struct tpm_space
*space
,
335 const struct tpm_input_header
*header
= (const void *)cmd
;
339 unsigned int nr_handles
;
341 if (len
< TPM_HEADER_SIZE
)
347 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
&& chip
->nr_commands
) {
348 cc
= be32_to_cpu(header
->ordinal
);
350 i
= tpm2_find_cc(chip
, cc
);
352 dev_dbg(&chip
->dev
, "0x%04X is an invalid command\n",
357 attrs
= chip
->cc_attrs_tbl
[i
];
359 4 * ((attrs
>> TPM2_CC_ATTR_CHANDLES
) & GENMASK(2, 0));
360 if (len
< TPM_HEADER_SIZE
+ 4 * nr_handles
)
367 "%s: insufficient command length %zu", __func__
, len
);
371 static int tpm_request_locality(struct tpm_chip
*chip
, unsigned int flags
)
375 if (flags
& TPM_TRANSMIT_NESTED
)
378 if (!chip
->ops
->request_locality
)
381 rc
= chip
->ops
->request_locality(chip
, 0);
390 static void tpm_relinquish_locality(struct tpm_chip
*chip
, unsigned int flags
)
394 if (flags
& TPM_TRANSMIT_NESTED
)
397 if (!chip
->ops
->relinquish_locality
)
400 rc
= chip
->ops
->relinquish_locality(chip
, chip
->locality
);
402 dev_err(&chip
->dev
, "%s: : error %d\n", __func__
, rc
);
407 static int tpm_cmd_ready(struct tpm_chip
*chip
, unsigned int flags
)
409 if (flags
& TPM_TRANSMIT_NESTED
)
412 if (!chip
->ops
->cmd_ready
)
415 return chip
->ops
->cmd_ready(chip
);
418 static int tpm_go_idle(struct tpm_chip
*chip
, unsigned int flags
)
420 if (flags
& TPM_TRANSMIT_NESTED
)
423 if (!chip
->ops
->go_idle
)
426 return chip
->ops
->go_idle(chip
);
429 static ssize_t
tpm_try_transmit(struct tpm_chip
*chip
,
430 struct tpm_space
*space
,
431 u8
*buf
, size_t bufsiz
,
434 struct tpm_output_header
*header
= (void *)buf
;
441 rc
= tpm_validate_command(chip
, space
, buf
, bufsiz
);
445 * If the command is not implemented by the TPM, synthesize a
446 * response with a TPM2_RC_COMMAND_CODE return for user-space.
448 if (rc
== -EOPNOTSUPP
) {
449 header
->length
= cpu_to_be32(sizeof(*header
));
450 header
->tag
= cpu_to_be16(TPM2_ST_NO_SESSIONS
);
451 header
->return_code
= cpu_to_be32(TPM2_RC_COMMAND_CODE
|
452 TSS2_RESMGR_TPM_RC_LAYER
);
453 return sizeof(*header
);
456 if (bufsiz
> TPM_BUFSIZE
)
457 bufsiz
= TPM_BUFSIZE
;
459 count
= be32_to_cpu(*((__be32
*) (buf
+ 2)));
460 ordinal
= be32_to_cpu(*((__be32
*) (buf
+ 6)));
463 if (count
> bufsiz
) {
465 "invalid count value %x %zx\n", count
, bufsiz
);
469 if (!(flags
& TPM_TRANSMIT_UNLOCKED
) && !(flags
& TPM_TRANSMIT_NESTED
))
470 mutex_lock(&chip
->tpm_mutex
);
472 if (chip
->ops
->clk_enable
!= NULL
)
473 chip
->ops
->clk_enable(chip
, true);
475 /* Store the decision as chip->locality will be changed. */
476 need_locality
= chip
->locality
== -1;
479 rc
= tpm_request_locality(chip
, flags
);
481 need_locality
= false;
486 rc
= tpm_cmd_ready(chip
, flags
);
490 rc
= tpm2_prepare_space(chip
, space
, ordinal
, buf
);
494 rc
= chip
->ops
->send(chip
, buf
, count
);
498 "%s: send(): error %d\n", __func__
, rc
);
502 /* A sanity check. send() should just return zero on success e.g.
503 * not the command length.
507 "%s: send(): invalid value %d\n", __func__
, rc
);
511 if (chip
->flags
& TPM_CHIP_FLAG_IRQ
)
514 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
)
515 stop
= jiffies
+ tpm2_calc_ordinal_duration(chip
, ordinal
);
517 stop
= jiffies
+ tpm_calc_ordinal_duration(chip
, ordinal
);
519 u8 status
= chip
->ops
->status(chip
);
520 if ((status
& chip
->ops
->req_complete_mask
) ==
521 chip
->ops
->req_complete_val
)
524 if (chip
->ops
->req_canceled(chip
, status
)) {
525 dev_err(&chip
->dev
, "Operation Canceled\n");
530 tpm_msleep(TPM_TIMEOUT_POLL
);
532 } while (time_before(jiffies
, stop
));
534 chip
->ops
->cancel(chip
);
535 dev_err(&chip
->dev
, "Operation Timed out\n");
540 len
= chip
->ops
->recv(chip
, buf
, bufsiz
);
544 "tpm_transmit: tpm_recv: error %d\n", rc
);
546 } else if (len
< TPM_HEADER_SIZE
) {
551 if (len
!= be32_to_cpu(header
->length
)) {
556 rc
= tpm2_commit_space(chip
, space
, ordinal
, buf
, &len
);
558 dev_err(&chip
->dev
, "tpm2_commit_space: error %d\n", rc
);
561 /* may fail but do not override previous error value in rc */
562 tpm_go_idle(chip
, flags
);
566 tpm_relinquish_locality(chip
, flags
);
568 if (chip
->ops
->clk_enable
!= NULL
)
569 chip
->ops
->clk_enable(chip
, false);
571 if (!(flags
& TPM_TRANSMIT_UNLOCKED
) && !(flags
& TPM_TRANSMIT_NESTED
))
572 mutex_unlock(&chip
->tpm_mutex
);
573 return rc
? rc
: len
;
577 * tpm_transmit - Internal kernel interface to transmit TPM commands.
579 * @chip: TPM chip to use
581 * @buf: TPM command buffer
582 * @bufsiz: length of the TPM command buffer
583 * @flags: tpm transmit flags - bitmap
585 * A wrapper around tpm_try_transmit that handles TPM2_RC_RETRY
586 * returns from the TPM and retransmits the command after a delay up
587 * to a maximum wait of TPM2_DURATION_LONG.
589 * Note: TPM1 never returns TPM2_RC_RETRY so the retry logic is TPM2
593 * the length of the return when the operation is successful.
594 * A negative number for system errors (errno).
596 ssize_t
tpm_transmit(struct tpm_chip
*chip
, struct tpm_space
*space
,
597 u8
*buf
, size_t bufsiz
, unsigned int flags
)
599 struct tpm_output_header
*header
= (struct tpm_output_header
*)buf
;
600 /* space for header and handles */
601 u8 save
[TPM_HEADER_SIZE
+ 3*sizeof(u32
)];
602 unsigned int delay_msec
= TPM2_DURATION_SHORT
;
605 const size_t save_size
= min(space
? sizeof(save
) : TPM_HEADER_SIZE
,
607 /* the command code is where the return code will be */
608 u32 cc
= be32_to_cpu(header
->return_code
);
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
&& rc
!= TPM2_RC_TESTING
)
625 * return immediately if self test returns test
626 * still running to shorten boot time.
628 if (rc
== TPM2_RC_TESTING
&& cc
== TPM2_CC_SELF_TEST
)
631 if (delay_msec
> TPM2_DURATION_LONG
) {
632 if (rc
== TPM2_RC_RETRY
)
633 dev_err(&chip
->dev
, "in retry loop\n");
636 "self test is still running\n");
639 tpm_msleep(delay_msec
);
641 memcpy(buf
, save
, save_size
);
646 * tpm_transmit_cmd - send a tpm command to the device
647 * The function extracts tpm out header return code
649 * @chip: TPM chip to use
651 * @buf: TPM command buffer
652 * @bufsiz: length of the buffer
653 * @min_rsp_body_length: minimum expected length of response body
654 * @flags: tpm transmit flags - bitmap
655 * @desc: command description used in the error message
658 * 0 when the operation is successful.
659 * A negative number for system errors (errno).
660 * A positive number for a TPM error.
662 ssize_t
tpm_transmit_cmd(struct tpm_chip
*chip
, struct tpm_space
*space
,
663 void *buf
, size_t bufsiz
,
664 size_t min_rsp_body_length
, unsigned int flags
,
667 const struct tpm_output_header
*header
= buf
;
671 len
= tpm_transmit(chip
, space
, buf
, bufsiz
, flags
);
675 err
= be32_to_cpu(header
->return_code
);
676 if (err
!= 0 && err
!= TPM_ERR_DISABLED
&& err
!= TPM_ERR_DEACTIVATED
678 dev_err(&chip
->dev
, "A TPM error (%d) occurred %s\n", err
,
683 if (len
< min_rsp_body_length
+ TPM_HEADER_SIZE
)
688 EXPORT_SYMBOL_GPL(tpm_transmit_cmd
);
690 #define TPM_ORD_STARTUP 153
691 #define TPM_ST_CLEAR 1
694 * tpm_startup - turn on the TPM
695 * @chip: TPM chip to use
697 * Normally the firmware should start the TPM. This function is provided as a
698 * workaround if this does not happen. A legal case for this could be for
699 * example when a TPM emulator is used.
701 * Return: same as tpm_transmit_cmd()
703 int tpm_startup(struct tpm_chip
*chip
)
708 dev_info(&chip
->dev
, "starting up the TPM manually\n");
710 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
711 rc
= tpm_buf_init(&buf
, TPM2_ST_NO_SESSIONS
, TPM2_CC_STARTUP
);
715 tpm_buf_append_u16(&buf
, TPM2_SU_CLEAR
);
717 rc
= tpm_buf_init(&buf
, TPM_TAG_RQU_COMMAND
, TPM_ORD_STARTUP
);
721 tpm_buf_append_u16(&buf
, TPM_ST_CLEAR
);
724 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 0, 0,
725 "attempting to start the TPM");
727 tpm_buf_destroy(&buf
);
731 #define TPM_DIGEST_SIZE 20
732 #define TPM_RET_CODE_IDX 6
733 #define TPM_INTERNAL_RESULT_SIZE 200
734 #define TPM_ORD_GET_CAP 101
735 #define TPM_ORD_GET_RANDOM 70
737 static const struct tpm_input_header tpm_getcap_header
= {
738 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
739 .length
= cpu_to_be32(22),
740 .ordinal
= cpu_to_be32(TPM_ORD_GET_CAP
)
743 ssize_t
tpm_getcap(struct tpm_chip
*chip
, u32 subcap_id
, cap_t
*cap
,
744 const char *desc
, size_t min_cap_length
)
749 rc
= tpm_buf_init(&buf
, TPM_TAG_RQU_COMMAND
, TPM_ORD_GET_CAP
);
753 if (subcap_id
== TPM_CAP_VERSION_1_1
||
754 subcap_id
== TPM_CAP_VERSION_1_2
) {
755 tpm_buf_append_u32(&buf
, subcap_id
);
756 tpm_buf_append_u32(&buf
, 0);
758 if (subcap_id
== TPM_CAP_FLAG_PERM
||
759 subcap_id
== TPM_CAP_FLAG_VOL
)
760 tpm_buf_append_u32(&buf
, TPM_CAP_FLAG
);
762 tpm_buf_append_u32(&buf
, TPM_CAP_PROP
);
764 tpm_buf_append_u32(&buf
, 4);
765 tpm_buf_append_u32(&buf
, subcap_id
);
767 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
,
768 min_cap_length
, 0, desc
);
770 *cap
= *(cap_t
*)&buf
.data
[TPM_HEADER_SIZE
+ 4];
772 tpm_buf_destroy(&buf
);
775 EXPORT_SYMBOL_GPL(tpm_getcap
);
777 int tpm_get_timeouts(struct tpm_chip
*chip
)
780 unsigned long timeout_old
[4], timeout_chip
[4], timeout_eff
[4];
783 if (chip
->flags
& TPM_CHIP_FLAG_HAVE_TIMEOUTS
)
786 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
787 /* Fixed timeouts for TPM2 */
788 chip
->timeout_a
= msecs_to_jiffies(TPM2_TIMEOUT_A
);
789 chip
->timeout_b
= msecs_to_jiffies(TPM2_TIMEOUT_B
);
790 chip
->timeout_c
= msecs_to_jiffies(TPM2_TIMEOUT_C
);
791 chip
->timeout_d
= msecs_to_jiffies(TPM2_TIMEOUT_D
);
792 chip
->duration
[TPM_SHORT
] =
793 msecs_to_jiffies(TPM2_DURATION_SHORT
);
794 chip
->duration
[TPM_MEDIUM
] =
795 msecs_to_jiffies(TPM2_DURATION_MEDIUM
);
796 chip
->duration
[TPM_LONG
] =
797 msecs_to_jiffies(TPM2_DURATION_LONG
);
798 chip
->duration
[TPM_LONG_LONG
] =
799 msecs_to_jiffies(TPM2_DURATION_LONG_LONG
);
801 chip
->flags
|= TPM_CHIP_FLAG_HAVE_TIMEOUTS
;
805 rc
= tpm_getcap(chip
, TPM_CAP_PROP_TIS_TIMEOUT
, &cap
, NULL
,
806 sizeof(cap
.timeout
));
807 if (rc
== TPM_ERR_INVALID_POSTINIT
) {
808 if (tpm_startup(chip
))
811 rc
= tpm_getcap(chip
, TPM_CAP_PROP_TIS_TIMEOUT
, &cap
,
812 "attempting to determine the timeouts",
813 sizeof(cap
.timeout
));
818 "A TPM error (%zd) occurred attempting to determine the timeouts\n",
823 timeout_old
[0] = jiffies_to_usecs(chip
->timeout_a
);
824 timeout_old
[1] = jiffies_to_usecs(chip
->timeout_b
);
825 timeout_old
[2] = jiffies_to_usecs(chip
->timeout_c
);
826 timeout_old
[3] = jiffies_to_usecs(chip
->timeout_d
);
827 timeout_chip
[0] = be32_to_cpu(cap
.timeout
.a
);
828 timeout_chip
[1] = be32_to_cpu(cap
.timeout
.b
);
829 timeout_chip
[2] = be32_to_cpu(cap
.timeout
.c
);
830 timeout_chip
[3] = be32_to_cpu(cap
.timeout
.d
);
831 memcpy(timeout_eff
, timeout_chip
, sizeof(timeout_eff
));
834 * Provide ability for vendor overrides of timeout values in case
837 if (chip
->ops
->update_timeouts
!= NULL
)
838 chip
->timeout_adjusted
=
839 chip
->ops
->update_timeouts(chip
, timeout_eff
);
841 if (!chip
->timeout_adjusted
) {
842 /* Restore default if chip reported 0 */
845 for (i
= 0; i
< ARRAY_SIZE(timeout_eff
); i
++) {
849 timeout_eff
[i
] = timeout_old
[i
];
850 chip
->timeout_adjusted
= true;
853 if (timeout_eff
[0] != 0 && timeout_eff
[0] < 1000) {
854 /* timeouts in msec rather usec */
855 for (i
= 0; i
!= ARRAY_SIZE(timeout_eff
); i
++)
856 timeout_eff
[i
] *= 1000;
857 chip
->timeout_adjusted
= true;
861 /* Report adjusted timeouts */
862 if (chip
->timeout_adjusted
) {
864 HW_ERR
"Adjusting reported timeouts: A %lu->%luus B %lu->%luus C %lu->%luus D %lu->%luus\n",
865 timeout_chip
[0], timeout_eff
[0],
866 timeout_chip
[1], timeout_eff
[1],
867 timeout_chip
[2], timeout_eff
[2],
868 timeout_chip
[3], timeout_eff
[3]);
871 chip
->timeout_a
= usecs_to_jiffies(timeout_eff
[0]);
872 chip
->timeout_b
= usecs_to_jiffies(timeout_eff
[1]);
873 chip
->timeout_c
= usecs_to_jiffies(timeout_eff
[2]);
874 chip
->timeout_d
= usecs_to_jiffies(timeout_eff
[3]);
876 rc
= tpm_getcap(chip
, TPM_CAP_PROP_TIS_DURATION
, &cap
,
877 "attempting to determine the durations",
878 sizeof(cap
.duration
));
882 chip
->duration
[TPM_SHORT
] =
883 usecs_to_jiffies(be32_to_cpu(cap
.duration
.tpm_short
));
884 chip
->duration
[TPM_MEDIUM
] =
885 usecs_to_jiffies(be32_to_cpu(cap
.duration
.tpm_medium
));
886 chip
->duration
[TPM_LONG
] =
887 usecs_to_jiffies(be32_to_cpu(cap
.duration
.tpm_long
));
888 chip
->duration
[TPM_LONG_LONG
] = 0; /* not used under 1.2 */
890 /* The Broadcom BCM0102 chipset in a Dell Latitude D820 gets the above
891 * value wrong and apparently reports msecs rather than usecs. So we
892 * fix up the resulting too-small TPM_SHORT value to make things work.
893 * We also scale the TPM_MEDIUM and -_LONG values by 1000.
895 if (chip
->duration
[TPM_SHORT
] < (HZ
/ 100)) {
896 chip
->duration
[TPM_SHORT
] = HZ
;
897 chip
->duration
[TPM_MEDIUM
] *= 1000;
898 chip
->duration
[TPM_LONG
] *= 1000;
899 chip
->duration_adjusted
= true;
900 dev_info(&chip
->dev
, "Adjusting TPM timeout parameters.");
903 chip
->flags
|= TPM_CHIP_FLAG_HAVE_TIMEOUTS
;
906 EXPORT_SYMBOL_GPL(tpm_get_timeouts
);
908 #define TPM_ORD_CONTINUE_SELFTEST 83
909 #define CONTINUE_SELFTEST_RESULT_SIZE 10
911 static const struct tpm_input_header continue_selftest_header
= {
912 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
913 .length
= cpu_to_be32(10),
914 .ordinal
= cpu_to_be32(TPM_ORD_CONTINUE_SELFTEST
),
918 * tpm_continue_selftest -- run TPM's selftest
919 * @chip: TPM chip to use
921 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
924 static int tpm_continue_selftest(struct tpm_chip
*chip
)
927 struct tpm_cmd_t cmd
;
929 cmd
.header
.in
= continue_selftest_header
;
930 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, CONTINUE_SELFTEST_RESULT_SIZE
,
931 0, 0, "continue selftest");
935 #define TPM_ORDINAL_PCRREAD 21
936 #define READ_PCR_RESULT_SIZE 30
937 #define READ_PCR_RESULT_BODY_SIZE 20
938 static const struct tpm_input_header pcrread_header
= {
939 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
940 .length
= cpu_to_be32(14),
941 .ordinal
= cpu_to_be32(TPM_ORDINAL_PCRREAD
)
944 int tpm_pcr_read_dev(struct tpm_chip
*chip
, int pcr_idx
, u8
*res_buf
)
947 struct tpm_cmd_t cmd
;
949 cmd
.header
.in
= pcrread_header
;
950 cmd
.params
.pcrread_in
.pcr_idx
= cpu_to_be32(pcr_idx
);
951 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, READ_PCR_RESULT_SIZE
,
952 READ_PCR_RESULT_BODY_SIZE
, 0,
953 "attempting to read a pcr value");
956 memcpy(res_buf
, cmd
.params
.pcrread_out
.pcr_result
,
962 * tpm_is_tpm2 - do we a have a TPM2 chip?
963 * @chip: a &struct tpm_chip instance, %NULL for the default chip
966 * 1 if we have a TPM2 chip.
967 * 0 if we don't have a TPM2 chip.
968 * A negative number for system errors (errno).
970 int tpm_is_tpm2(struct tpm_chip
*chip
)
974 chip
= tpm_find_get_ops(chip
);
978 rc
= (chip
->flags
& TPM_CHIP_FLAG_TPM2
) != 0;
984 EXPORT_SYMBOL_GPL(tpm_is_tpm2
);
987 * tpm_pcr_read - read a PCR value from SHA1 bank
988 * @chip: a &struct tpm_chip instance, %NULL for the default chip
989 * @pcr_idx: the PCR to be retrieved
990 * @res_buf: the value of the PCR
992 * Return: same as with tpm_transmit_cmd()
994 int tpm_pcr_read(struct tpm_chip
*chip
, int pcr_idx
, u8
*res_buf
)
998 chip
= tpm_find_get_ops(chip
);
1001 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
)
1002 rc
= tpm2_pcr_read(chip
, pcr_idx
, res_buf
);
1004 rc
= tpm_pcr_read_dev(chip
, pcr_idx
, res_buf
);
1008 EXPORT_SYMBOL_GPL(tpm_pcr_read
);
1010 #define TPM_ORD_PCR_EXTEND 20
1011 #define EXTEND_PCR_RESULT_SIZE 34
1012 #define EXTEND_PCR_RESULT_BODY_SIZE 20
1013 static const struct tpm_input_header pcrextend_header
= {
1014 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
1015 .length
= cpu_to_be32(34),
1016 .ordinal
= cpu_to_be32(TPM_ORD_PCR_EXTEND
)
1019 static int tpm1_pcr_extend(struct tpm_chip
*chip
, int pcr_idx
, const u8
*hash
,
1025 rc
= tpm_buf_init(&buf
, TPM_TAG_RQU_COMMAND
, TPM_ORD_PCR_EXTEND
);
1029 tpm_buf_append_u32(&buf
, pcr_idx
);
1030 tpm_buf_append(&buf
, hash
, TPM_DIGEST_SIZE
);
1032 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, EXTEND_PCR_RESULT_SIZE
,
1033 EXTEND_PCR_RESULT_BODY_SIZE
, 0, log_msg
);
1034 tpm_buf_destroy(&buf
);
1039 * tpm_pcr_extend - extend a PCR value in SHA1 bank.
1040 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1041 * @pcr_idx: the PCR to be retrieved
1042 * @hash: the hash value used to extend the PCR value
1044 * Note: with TPM 2.0 extends also those banks with a known digest size to the
1045 * cryto subsystem in order to prevent malicious use of those PCR banks. In the
1046 * future we should dynamically determine digest sizes.
1048 * Return: same as with tpm_transmit_cmd()
1050 int tpm_pcr_extend(struct tpm_chip
*chip
, int pcr_idx
, const u8
*hash
)
1053 struct tpm2_digest digest_list
[ARRAY_SIZE(chip
->active_banks
)];
1057 chip
= tpm_find_get_ops(chip
);
1061 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
1062 memset(digest_list
, 0, sizeof(digest_list
));
1064 for (i
= 0; i
< ARRAY_SIZE(chip
->active_banks
) &&
1065 chip
->active_banks
[i
] != TPM2_ALG_ERROR
; i
++) {
1066 digest_list
[i
].alg_id
= chip
->active_banks
[i
];
1067 memcpy(digest_list
[i
].digest
, hash
, TPM_DIGEST_SIZE
);
1071 rc
= tpm2_pcr_extend(chip
, pcr_idx
, count
, digest_list
);
1076 rc
= tpm1_pcr_extend(chip
, pcr_idx
, hash
,
1077 "attempting extend a PCR value");
1081 EXPORT_SYMBOL_GPL(tpm_pcr_extend
);
1084 * tpm_do_selftest - have the TPM continue its selftest and wait until it
1085 * can receive further commands
1086 * @chip: TPM chip to use
1088 * Returns 0 on success, < 0 in case of fatal error or a value > 0 representing
1091 int tpm_do_selftest(struct tpm_chip
*chip
)
1095 unsigned int delay_msec
= 100;
1096 unsigned long duration
;
1097 u8 dummy
[TPM_DIGEST_SIZE
];
1099 duration
= tpm_calc_ordinal_duration(chip
, TPM_ORD_CONTINUE_SELFTEST
);
1101 loops
= jiffies_to_msecs(duration
) / delay_msec
;
1103 rc
= tpm_continue_selftest(chip
);
1104 if (rc
== TPM_ERR_INVALID_POSTINIT
) {
1105 chip
->flags
|= TPM_CHIP_FLAG_ALWAYS_POWERED
;
1106 dev_info(&chip
->dev
, "TPM not ready (%d)\n", rc
);
1108 /* This may fail if there was no TPM driver during a suspend/resume
1109 * cycle; some may return 10 (BAD_ORDINAL), others 28 (FAILEDSELFTEST)
1115 /* Attempt to read a PCR value */
1116 rc
= tpm_pcr_read_dev(chip
, 0, dummy
);
1118 /* Some buggy TPMs will not respond to tpm_tis_ready() for
1119 * around 300ms while the self test is ongoing, keep trying
1120 * until the self test duration expires. */
1124 "TPM command timed out during continue self test");
1125 tpm_msleep(delay_msec
);
1129 if (rc
== TPM_ERR_DISABLED
|| rc
== TPM_ERR_DEACTIVATED
) {
1130 dev_info(&chip
->dev
,
1131 "TPM is disabled/deactivated (0x%X)\n", rc
);
1132 /* TPM is disabled and/or deactivated; driver can
1133 * proceed and TPM does handle commands for
1134 * suspend/resume correctly
1138 if (rc
!= TPM_WARN_DOING_SELFTEST
)
1140 tpm_msleep(delay_msec
);
1141 } while (--loops
> 0);
1145 EXPORT_SYMBOL_GPL(tpm_do_selftest
);
1148 * tpm1_auto_startup - Perform the standard automatic TPM initialization
1150 * @chip: TPM chip to use
1152 * Returns 0 on success, < 0 in case of fatal error.
1154 int tpm1_auto_startup(struct tpm_chip
*chip
)
1158 rc
= tpm_get_timeouts(chip
);
1161 rc
= tpm_do_selftest(chip
);
1163 dev_err(&chip
->dev
, "TPM self test failed\n");
1175 * tpm_send - send a TPM command
1176 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1177 * @cmd: a TPM command buffer
1178 * @buflen: the length of the TPM command buffer
1180 * Return: same as with tpm_transmit_cmd()
1182 int tpm_send(struct tpm_chip
*chip
, void *cmd
, size_t buflen
)
1186 chip
= tpm_find_get_ops(chip
);
1190 rc
= tpm_transmit_cmd(chip
, NULL
, cmd
, buflen
, 0, 0,
1191 "attempting to a send a command");
1195 EXPORT_SYMBOL_GPL(tpm_send
);
1197 #define TPM_ORD_SAVESTATE 152
1198 #define SAVESTATE_RESULT_SIZE 10
1200 static const struct tpm_input_header savestate_header
= {
1201 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
1202 .length
= cpu_to_be32(10),
1203 .ordinal
= cpu_to_be32(TPM_ORD_SAVESTATE
)
1207 * We are about to suspend. Save the TPM state
1208 * so that it can be restored.
1210 int tpm_pm_suspend(struct device
*dev
)
1212 struct tpm_chip
*chip
= dev_get_drvdata(dev
);
1213 struct tpm_cmd_t cmd
;
1216 u8 dummy_hash
[TPM_DIGEST_SIZE
] = { 0 };
1221 if (chip
->flags
& TPM_CHIP_FLAG_ALWAYS_POWERED
)
1224 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
1225 tpm2_shutdown(chip
, TPM2_SU_STATE
);
1229 /* for buggy tpm, flush pcrs with extend to selected dummy */
1230 if (tpm_suspend_pcr
)
1231 rc
= tpm1_pcr_extend(chip
, tpm_suspend_pcr
, dummy_hash
,
1232 "extending dummy pcr before suspend");
1234 /* now do the actual savestate */
1235 for (try = 0; try < TPM_RETRY
; try++) {
1236 cmd
.header
.in
= savestate_header
;
1237 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, SAVESTATE_RESULT_SIZE
,
1241 * If the TPM indicates that it is too busy to respond to
1242 * this command then retry before giving up. It can take
1243 * several seconds for this TPM to be ready.
1245 * This can happen if the TPM has already been sent the
1246 * SaveState command before the driver has loaded. TCG 1.2
1247 * specification states that any communication after SaveState
1248 * may cause the TPM to invalidate previously saved state.
1250 if (rc
!= TPM_WARN_RETRY
)
1252 tpm_msleep(TPM_TIMEOUT_RETRY
);
1257 "Error (%d) sending savestate before suspend\n", rc
);
1259 dev_warn(&chip
->dev
, "TPM savestate took %dms\n",
1260 try * TPM_TIMEOUT_RETRY
);
1264 EXPORT_SYMBOL_GPL(tpm_pm_suspend
);
1267 * Resume from a power safe. The BIOS already restored
1270 int tpm_pm_resume(struct device
*dev
)
1272 struct tpm_chip
*chip
= dev_get_drvdata(dev
);
1279 EXPORT_SYMBOL_GPL(tpm_pm_resume
);
1281 #define TPM_GETRANDOM_RESULT_SIZE 18
1282 static const struct tpm_input_header tpm_getrandom_header
= {
1283 .tag
= cpu_to_be16(TPM_TAG_RQU_COMMAND
),
1284 .length
= cpu_to_be32(14),
1285 .ordinal
= cpu_to_be32(TPM_ORD_GET_RANDOM
)
1289 * tpm_get_random() - get random bytes from the TPM's RNG
1290 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1291 * @out: destination buffer for the random bytes
1292 * @max: the max number of bytes to write to @out
1294 * Return: same as with tpm_transmit_cmd()
1296 int tpm_get_random(struct tpm_chip
*chip
, u8
*out
, size_t max
)
1298 struct tpm_cmd_t tpm_cmd
;
1299 u32 recd
, num_bytes
= min_t(u32
, max
, TPM_MAX_RNG_DATA
), rlength
;
1300 int err
, total
= 0, retries
= 5;
1303 if (!out
|| !num_bytes
|| max
> TPM_MAX_RNG_DATA
)
1306 chip
= tpm_find_get_ops(chip
);
1310 if (chip
->flags
& TPM_CHIP_FLAG_TPM2
) {
1311 err
= tpm2_get_random(chip
, out
, max
);
1317 tpm_cmd
.header
.in
= tpm_getrandom_header
;
1318 tpm_cmd
.params
.getrandom_in
.num_bytes
= cpu_to_be32(num_bytes
);
1320 err
= tpm_transmit_cmd(chip
, NULL
, &tpm_cmd
,
1321 TPM_GETRANDOM_RESULT_SIZE
+ num_bytes
,
1322 offsetof(struct tpm_getrandom_out
,
1324 0, "attempting get random");
1328 recd
= be32_to_cpu(tpm_cmd
.params
.getrandom_out
.rng_data_len
);
1329 if (recd
> num_bytes
) {
1334 rlength
= be32_to_cpu(tpm_cmd
.header
.out
.length
);
1335 if (rlength
< TPM_HEADER_SIZE
+
1336 offsetof(struct tpm_getrandom_out
, rng_data
) +
1341 memcpy(dest
, tpm_cmd
.params
.getrandom_out
.rng_data
, recd
);
1346 } while (retries
-- && total
< max
);
1349 return total
? total
: -EIO
;
1351 EXPORT_SYMBOL_GPL(tpm_get_random
);
1354 * tpm_seal_trusted() - seal a trusted key payload
1355 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1356 * @options: authentication values and other options
1357 * @payload: the key data in clear and encrypted form
1359 * Note: only TPM 2.0 chip are supported. TPM 1.x implementation is located in
1360 * the keyring subsystem.
1362 * Return: same as with tpm_transmit_cmd()
1364 int tpm_seal_trusted(struct tpm_chip
*chip
, struct trusted_key_payload
*payload
,
1365 struct trusted_key_options
*options
)
1369 chip
= tpm_find_get_ops(chip
);
1370 if (!chip
|| !(chip
->flags
& TPM_CHIP_FLAG_TPM2
))
1373 rc
= tpm2_seal_trusted(chip
, payload
, options
);
1378 EXPORT_SYMBOL_GPL(tpm_seal_trusted
);
1381 * tpm_unseal_trusted() - unseal a trusted key
1382 * @chip: a &struct tpm_chip instance, %NULL for the default chip
1383 * @options: authentication values and other options
1384 * @payload: the key data in clear and encrypted form
1386 * Note: only TPM 2.0 chip are supported. TPM 1.x implementation is located in
1387 * the keyring subsystem.
1389 * Return: same as with tpm_transmit_cmd()
1391 int tpm_unseal_trusted(struct tpm_chip
*chip
,
1392 struct trusted_key_payload
*payload
,
1393 struct trusted_key_options
*options
)
1397 chip
= tpm_find_get_ops(chip
);
1398 if (!chip
|| !(chip
->flags
& TPM_CHIP_FLAG_TPM2
))
1401 rc
= tpm2_unseal_trusted(chip
, payload
, options
);
1407 EXPORT_SYMBOL_GPL(tpm_unseal_trusted
);
1409 static int __init
tpm_init(void)
1413 tpm_class
= class_create(THIS_MODULE
, "tpm");
1414 if (IS_ERR(tpm_class
)) {
1415 pr_err("couldn't create tpm class\n");
1416 return PTR_ERR(tpm_class
);
1419 tpmrm_class
= class_create(THIS_MODULE
, "tpmrm");
1420 if (IS_ERR(tpmrm_class
)) {
1421 pr_err("couldn't create tpmrm class\n");
1422 class_destroy(tpm_class
);
1423 return PTR_ERR(tpmrm_class
);
1426 rc
= alloc_chrdev_region(&tpm_devt
, 0, 2*TPM_NUM_DEVICES
, "tpm");
1428 pr_err("tpm: failed to allocate char dev region\n");
1429 class_destroy(tpmrm_class
);
1430 class_destroy(tpm_class
);
1437 static void __exit
tpm_exit(void)
1439 idr_destroy(&dev_nums_idr
);
1440 class_destroy(tpm_class
);
1441 class_destroy(tpmrm_class
);
1442 unregister_chrdev_region(tpm_devt
, 2*TPM_NUM_DEVICES
);
1445 subsys_initcall(tpm_init
);
1446 module_exit(tpm_exit
);
1448 MODULE_AUTHOR("Leendert van Doorn (leendert@watson.ibm.com)");
1449 MODULE_DESCRIPTION("TPM Driver");
1450 MODULE_VERSION("2.0");
1451 MODULE_LICENSE("GPL");