2 * Copyright (C) 2014, 2015 Intel Corporation
5 * Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>
7 * Maintained by: <tpmdd-devel@lists.sourceforge.net>
9 * This file contains TPM2 protocol implementations of the commands
10 * used by the kernel internally.
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; version 2
19 #include <crypto/hash_info.h>
20 #include <keys/trusted-type.h>
22 enum tpm2_object_attributes
{
23 TPM2_OA_USER_WITH_AUTH
= BIT(6),
26 enum tpm2_session_attributes
{
27 TPM2_SA_CONTINUE_SESSION
= BIT(0),
30 struct tpm2_startup_in
{
34 struct tpm2_self_test_in
{
38 struct tpm2_get_tpm_pt_in
{
44 struct tpm2_get_tpm_pt_out
{
52 struct tpm2_get_random_in
{
56 struct tpm2_get_random_out
{
58 u8 buffer
[TPM_MAX_RNG_DATA
];
61 union tpm2_cmd_params
{
62 struct tpm2_startup_in startup_in
;
63 struct tpm2_self_test_in selftest_in
;
64 struct tpm2_get_tpm_pt_in get_tpm_pt_in
;
65 struct tpm2_get_tpm_pt_out get_tpm_pt_out
;
66 struct tpm2_get_random_in getrandom_in
;
67 struct tpm2_get_random_out getrandom_out
;
71 tpm_cmd_header header
;
72 union tpm2_cmd_params params
;
76 unsigned int crypto_id
;
80 static struct tpm2_hash tpm2_hash_map
[] = {
81 {HASH_ALGO_SHA1
, TPM2_ALG_SHA1
},
82 {HASH_ALGO_SHA256
, TPM2_ALG_SHA256
},
83 {HASH_ALGO_SHA384
, TPM2_ALG_SHA384
},
84 {HASH_ALGO_SHA512
, TPM2_ALG_SHA512
},
85 {HASH_ALGO_SM3_256
, TPM2_ALG_SM3_256
},
89 * Array with one entry per ordinal defining the maximum amount
90 * of time the chip could take to return the result. The values
91 * of the SHORT, MEDIUM, and LONG durations are taken from the
92 * PC Client Profile (PTP) specification.
94 static const u8 tpm2_ordinal_duration
[TPM2_CC_LAST
- TPM2_CC_FIRST
+ 1] = {
95 TPM_UNDEFINED
, /* 11F */
96 TPM_UNDEFINED
, /* 120 */
98 TPM_UNDEFINED
, /* 122 */
99 TPM_UNDEFINED
, /* 123 */
100 TPM_UNDEFINED
, /* 124 */
101 TPM_UNDEFINED
, /* 125 */
102 TPM_UNDEFINED
, /* 126 */
103 TPM_UNDEFINED
, /* 127 */
104 TPM_UNDEFINED
, /* 128 */
106 TPM_UNDEFINED
, /* 12a */
107 TPM_UNDEFINED
, /* 12b */
108 TPM_UNDEFINED
, /* 12c */
109 TPM_UNDEFINED
, /* 12d */
110 TPM_UNDEFINED
, /* 12e */
111 TPM_UNDEFINED
, /* 12f */
112 TPM_UNDEFINED
, /* 130 */
113 TPM_UNDEFINED
, /* 131 */
114 TPM_UNDEFINED
, /* 132 */
115 TPM_UNDEFINED
, /* 133 */
116 TPM_UNDEFINED
, /* 134 */
117 TPM_UNDEFINED
, /* 135 */
118 TPM_UNDEFINED
, /* 136 */
119 TPM_UNDEFINED
, /* 137 */
120 TPM_UNDEFINED
, /* 138 */
121 TPM_UNDEFINED
, /* 139 */
122 TPM_UNDEFINED
, /* 13a */
123 TPM_UNDEFINED
, /* 13b */
124 TPM_UNDEFINED
, /* 13c */
125 TPM_UNDEFINED
, /* 13d */
126 TPM_MEDIUM
, /* 13e */
127 TPM_UNDEFINED
, /* 13f */
128 TPM_UNDEFINED
, /* 140 */
129 TPM_UNDEFINED
, /* 141 */
130 TPM_UNDEFINED
, /* 142 */
132 TPM_MEDIUM
, /* 144 */
133 TPM_UNDEFINED
, /* 145 */
134 TPM_UNDEFINED
, /* 146 */
135 TPM_UNDEFINED
, /* 147 */
136 TPM_UNDEFINED
, /* 148 */
137 TPM_UNDEFINED
, /* 149 */
138 TPM_UNDEFINED
, /* 14a */
139 TPM_UNDEFINED
, /* 14b */
140 TPM_UNDEFINED
, /* 14c */
141 TPM_UNDEFINED
, /* 14d */
143 TPM_UNDEFINED
, /* 14f */
144 TPM_UNDEFINED
, /* 150 */
145 TPM_UNDEFINED
, /* 151 */
146 TPM_UNDEFINED
, /* 152 */
147 TPM_UNDEFINED
, /* 153 */
148 TPM_UNDEFINED
, /* 154 */
149 TPM_UNDEFINED
, /* 155 */
150 TPM_UNDEFINED
, /* 156 */
151 TPM_UNDEFINED
, /* 157 */
152 TPM_UNDEFINED
, /* 158 */
153 TPM_UNDEFINED
, /* 159 */
154 TPM_UNDEFINED
, /* 15a */
155 TPM_UNDEFINED
, /* 15b */
156 TPM_MEDIUM
, /* 15c */
157 TPM_UNDEFINED
, /* 15d */
158 TPM_UNDEFINED
, /* 15e */
159 TPM_UNDEFINED
, /* 15f */
160 TPM_UNDEFINED
, /* 160 */
161 TPM_UNDEFINED
, /* 161 */
162 TPM_UNDEFINED
, /* 162 */
163 TPM_UNDEFINED
, /* 163 */
164 TPM_UNDEFINED
, /* 164 */
165 TPM_UNDEFINED
, /* 165 */
166 TPM_UNDEFINED
, /* 166 */
167 TPM_UNDEFINED
, /* 167 */
168 TPM_UNDEFINED
, /* 168 */
169 TPM_UNDEFINED
, /* 169 */
170 TPM_UNDEFINED
, /* 16a */
171 TPM_UNDEFINED
, /* 16b */
172 TPM_UNDEFINED
, /* 16c */
173 TPM_UNDEFINED
, /* 16d */
174 TPM_UNDEFINED
, /* 16e */
175 TPM_UNDEFINED
, /* 16f */
176 TPM_UNDEFINED
, /* 170 */
177 TPM_UNDEFINED
, /* 171 */
178 TPM_UNDEFINED
, /* 172 */
179 TPM_UNDEFINED
, /* 173 */
180 TPM_UNDEFINED
, /* 174 */
181 TPM_UNDEFINED
, /* 175 */
182 TPM_UNDEFINED
, /* 176 */
184 TPM_UNDEFINED
, /* 178 */
185 TPM_UNDEFINED
, /* 179 */
186 TPM_MEDIUM
, /* 17a */
188 TPM_UNDEFINED
, /* 17c */
189 TPM_UNDEFINED
, /* 17d */
190 TPM_UNDEFINED
, /* 17e */
191 TPM_UNDEFINED
, /* 17f */
192 TPM_UNDEFINED
, /* 180 */
193 TPM_UNDEFINED
, /* 181 */
194 TPM_MEDIUM
, /* 182 */
195 TPM_UNDEFINED
, /* 183 */
196 TPM_UNDEFINED
, /* 184 */
197 TPM_MEDIUM
, /* 185 */
198 TPM_MEDIUM
, /* 186 */
199 TPM_UNDEFINED
, /* 187 */
200 TPM_UNDEFINED
, /* 188 */
201 TPM_UNDEFINED
, /* 189 */
202 TPM_UNDEFINED
, /* 18a */
203 TPM_UNDEFINED
, /* 18b */
204 TPM_UNDEFINED
, /* 18c */
205 TPM_UNDEFINED
, /* 18d */
206 TPM_UNDEFINED
, /* 18e */
207 TPM_UNDEFINED
/* 18f */
210 struct tpm2_pcr_read_out
{
212 __be32 pcr_selects_cnt
;
215 u8 pcr_select
[TPM2_PCR_SELECT_MIN
];
222 * tpm2_pcr_read() - read a PCR value
223 * @chip: TPM chip to use.
224 * @pcr_idx: index of the PCR to read.
225 * @res_buf: buffer to store the resulting hash.
227 * Return: Same as with tpm_transmit_cmd.
229 int tpm2_pcr_read(struct tpm_chip
*chip
, int pcr_idx
, u8
*res_buf
)
233 struct tpm2_pcr_read_out
*out
;
234 u8 pcr_select
[TPM2_PCR_SELECT_MIN
] = {0};
236 if (pcr_idx
>= TPM2_PLATFORM_PCR
)
239 rc
= tpm_buf_init(&buf
, TPM2_ST_NO_SESSIONS
, TPM2_CC_PCR_READ
);
243 pcr_select
[pcr_idx
>> 3] = 1 << (pcr_idx
& 0x7);
245 tpm_buf_append_u32(&buf
, 1);
246 tpm_buf_append_u16(&buf
, TPM2_ALG_SHA1
);
247 tpm_buf_append_u8(&buf
, TPM2_PCR_SELECT_MIN
);
248 tpm_buf_append(&buf
, (const unsigned char *)pcr_select
,
251 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 0, 0,
252 res_buf
? "attempting to read a pcr value" : NULL
);
253 if (rc
== 0 && res_buf
) {
254 out
= (struct tpm2_pcr_read_out
*)&buf
.data
[TPM_HEADER_SIZE
];
255 memcpy(res_buf
, out
->digest
, SHA1_DIGEST_SIZE
);
258 tpm_buf_destroy(&buf
);
262 struct tpm2_null_auth_area
{
270 * tpm2_pcr_extend() - extend a PCR value
272 * @chip: TPM chip to use.
273 * @pcr_idx: index of the PCR.
274 * @count: number of digests passed.
275 * @digests: list of pcr banks and corresponding digest values to extend.
277 * Return: Same as with tpm_transmit_cmd.
279 int tpm2_pcr_extend(struct tpm_chip
*chip
, int pcr_idx
, u32 count
,
280 struct tpm2_digest
*digests
)
283 struct tpm2_null_auth_area auth_area
;
288 if (count
> ARRAY_SIZE(chip
->active_banks
))
291 rc
= tpm_buf_init(&buf
, TPM2_ST_SESSIONS
, TPM2_CC_PCR_EXTEND
);
295 tpm_buf_append_u32(&buf
, pcr_idx
);
297 auth_area
.handle
= cpu_to_be32(TPM2_RS_PW
);
298 auth_area
.nonce_size
= 0;
299 auth_area
.attributes
= 0;
300 auth_area
.auth_size
= 0;
302 tpm_buf_append_u32(&buf
, sizeof(struct tpm2_null_auth_area
));
303 tpm_buf_append(&buf
, (const unsigned char *)&auth_area
,
305 tpm_buf_append_u32(&buf
, count
);
307 for (i
= 0; i
< count
; i
++) {
308 for (j
= 0; j
< ARRAY_SIZE(tpm2_hash_map
); j
++) {
309 if (digests
[i
].alg_id
!= tpm2_hash_map
[j
].tpm_id
)
311 tpm_buf_append_u16(&buf
, digests
[i
].alg_id
);
312 tpm_buf_append(&buf
, (const unsigned char
313 *)&digests
[i
].digest
,
314 hash_digest_size
[tpm2_hash_map
[j
].crypto_id
]);
318 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 0, 0,
319 "attempting extend a PCR value");
321 tpm_buf_destroy(&buf
);
327 #define TPM2_GETRANDOM_IN_SIZE \
328 (sizeof(struct tpm_input_header) + \
329 sizeof(struct tpm2_get_random_in))
331 static const struct tpm_input_header tpm2_getrandom_header
= {
332 .tag
= cpu_to_be16(TPM2_ST_NO_SESSIONS
),
333 .length
= cpu_to_be32(TPM2_GETRANDOM_IN_SIZE
),
334 .ordinal
= cpu_to_be32(TPM2_CC_GET_RANDOM
)
338 * tpm2_get_random() - get random bytes from the TPM RNG
340 * @chip: TPM chip to use
341 * @out: destination buffer for the random bytes
342 * @max: the max number of bytes to write to @out
345 * Size of the output buffer, or -EIO on error.
347 int tpm2_get_random(struct tpm_chip
*chip
, u8
*out
, size_t max
)
357 num_bytes
= min_t(u32
, max
, sizeof(cmd
.params
.getrandom_out
.buffer
));
359 if (!out
|| !num_bytes
||
360 max
> sizeof(cmd
.params
.getrandom_out
.buffer
))
364 cmd
.header
.in
= tpm2_getrandom_header
;
365 cmd
.params
.getrandom_in
.size
= cpu_to_be16(num_bytes
);
367 err
= tpm_transmit_cmd(chip
, NULL
, &cmd
, sizeof(cmd
),
368 offsetof(struct tpm2_get_random_out
,
370 0, "attempting get random");
374 recd
= min_t(u32
, be16_to_cpu(cmd
.params
.getrandom_out
.size
),
376 rlength
= be32_to_cpu(cmd
.header
.out
.length
);
377 if (rlength
< offsetof(struct tpm2_get_random_out
, buffer
) +
380 memcpy(dest
, cmd
.params
.getrandom_out
.buffer
, recd
);
385 } while (retries
-- && total
< max
);
387 return total
? total
: -EIO
;
390 #define TPM2_GET_TPM_PT_IN_SIZE \
391 (sizeof(struct tpm_input_header) + \
392 sizeof(struct tpm2_get_tpm_pt_in))
394 #define TPM2_GET_TPM_PT_OUT_BODY_SIZE \
395 sizeof(struct tpm2_get_tpm_pt_out)
397 static const struct tpm_input_header tpm2_get_tpm_pt_header
= {
398 .tag
= cpu_to_be16(TPM2_ST_NO_SESSIONS
),
399 .length
= cpu_to_be32(TPM2_GET_TPM_PT_IN_SIZE
),
400 .ordinal
= cpu_to_be32(TPM2_CC_GET_CAPABILITY
)
404 * tpm2_flush_context_cmd() - execute a TPM2_FlushContext command
405 * @chip: TPM chip to use
406 * @payload: the key data in clear and encrypted form
407 * @options: authentication values and other options
409 * Return: same as with tpm_transmit_cmd
411 void tpm2_flush_context_cmd(struct tpm_chip
*chip
, u32 handle
,
417 rc
= tpm_buf_init(&buf
, TPM2_ST_NO_SESSIONS
, TPM2_CC_FLUSH_CONTEXT
);
419 dev_warn(&chip
->dev
, "0x%08x was not flushed, out of memory\n",
424 tpm_buf_append_u32(&buf
, handle
);
426 (void) tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 0, flags
,
429 tpm_buf_destroy(&buf
);
433 * tpm_buf_append_auth() - append TPMS_AUTH_COMMAND to the buffer.
435 * @buf: an allocated tpm_buf instance
436 * @session_handle: session handle
437 * @nonce: the session nonce, may be NULL if not used
438 * @nonce_len: the session nonce length, may be 0 if not used
439 * @attributes: the session attributes
440 * @hmac: the session HMAC or password, may be NULL if not used
441 * @hmac_len: the session HMAC or password length, maybe 0 if not used
443 static void tpm2_buf_append_auth(struct tpm_buf
*buf
, u32 session_handle
,
444 const u8
*nonce
, u16 nonce_len
,
446 const u8
*hmac
, u16 hmac_len
)
448 tpm_buf_append_u32(buf
, 9 + nonce_len
+ hmac_len
);
449 tpm_buf_append_u32(buf
, session_handle
);
450 tpm_buf_append_u16(buf
, nonce_len
);
452 if (nonce
&& nonce_len
)
453 tpm_buf_append(buf
, nonce
, nonce_len
);
455 tpm_buf_append_u8(buf
, attributes
);
456 tpm_buf_append_u16(buf
, hmac_len
);
458 if (hmac
&& hmac_len
)
459 tpm_buf_append(buf
, hmac
, hmac_len
);
463 * tpm2_seal_trusted() - seal the payload of a trusted key
465 * @chip: TPM chip to use
466 * @payload: the key data in clear and encrypted form
467 * @options: authentication values and other options
469 * Return: < 0 on error and 0 on success.
471 int tpm2_seal_trusted(struct tpm_chip
*chip
,
472 struct trusted_key_payload
*payload
,
473 struct trusted_key_options
*options
)
475 unsigned int blob_len
;
481 for (i
= 0; i
< ARRAY_SIZE(tpm2_hash_map
); i
++) {
482 if (options
->hash
== tpm2_hash_map
[i
].crypto_id
) {
483 hash
= tpm2_hash_map
[i
].tpm_id
;
488 if (i
== ARRAY_SIZE(tpm2_hash_map
))
491 rc
= tpm_buf_init(&buf
, TPM2_ST_SESSIONS
, TPM2_CC_CREATE
);
495 tpm_buf_append_u32(&buf
, options
->keyhandle
);
496 tpm2_buf_append_auth(&buf
, TPM2_RS_PW
,
498 0 /* session_attributes */,
499 options
->keyauth
/* hmac */,
503 tpm_buf_append_u16(&buf
, 4 + TPM_DIGEST_SIZE
+ payload
->key_len
+ 1);
505 tpm_buf_append_u16(&buf
, TPM_DIGEST_SIZE
);
506 tpm_buf_append(&buf
, options
->blobauth
, TPM_DIGEST_SIZE
);
507 tpm_buf_append_u16(&buf
, payload
->key_len
+ 1);
508 tpm_buf_append(&buf
, payload
->key
, payload
->key_len
);
509 tpm_buf_append_u8(&buf
, payload
->migratable
);
512 tpm_buf_append_u16(&buf
, 14 + options
->policydigest_len
);
513 tpm_buf_append_u16(&buf
, TPM2_ALG_KEYEDHASH
);
514 tpm_buf_append_u16(&buf
, hash
);
517 if (options
->policydigest_len
) {
518 tpm_buf_append_u32(&buf
, 0);
519 tpm_buf_append_u16(&buf
, options
->policydigest_len
);
520 tpm_buf_append(&buf
, options
->policydigest
,
521 options
->policydigest_len
);
523 tpm_buf_append_u32(&buf
, TPM2_OA_USER_WITH_AUTH
);
524 tpm_buf_append_u16(&buf
, 0);
527 /* public parameters */
528 tpm_buf_append_u16(&buf
, TPM2_ALG_NULL
);
529 tpm_buf_append_u16(&buf
, 0);
532 tpm_buf_append_u16(&buf
, 0);
535 tpm_buf_append_u32(&buf
, 0);
537 if (buf
.flags
& TPM_BUF_OVERFLOW
) {
542 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 4, 0,
547 blob_len
= be32_to_cpup((__be32
*) &buf
.data
[TPM_HEADER_SIZE
]);
548 if (blob_len
> MAX_BLOB_SIZE
) {
552 rlength
= be32_to_cpu(((struct tpm2_cmd
*)&buf
)->header
.out
.length
);
553 if (rlength
< TPM_HEADER_SIZE
+ 4 + blob_len
) {
558 memcpy(payload
->blob
, &buf
.data
[TPM_HEADER_SIZE
+ 4], blob_len
);
559 payload
->blob_len
= blob_len
;
562 tpm_buf_destroy(&buf
);
565 if (tpm2_rc_value(rc
) == TPM2_RC_HASH
)
575 * tpm2_load_cmd() - execute a TPM2_Load command
577 * @chip: TPM chip to use
578 * @payload: the key data in clear and encrypted form
579 * @options: authentication values and other options
580 * @blob_handle: returned blob handle
581 * @flags: tpm transmit flags
583 * Return: 0 on success.
584 * -E2BIG on wrong payload size.
585 * -EPERM on tpm error status.
586 * < 0 error from tpm_transmit_cmd.
588 static int tpm2_load_cmd(struct tpm_chip
*chip
,
589 struct trusted_key_payload
*payload
,
590 struct trusted_key_options
*options
,
591 u32
*blob_handle
, unsigned int flags
)
594 unsigned int private_len
;
595 unsigned int public_len
;
596 unsigned int blob_len
;
599 private_len
= be16_to_cpup((__be16
*) &payload
->blob
[0]);
600 if (private_len
> (payload
->blob_len
- 2))
603 public_len
= be16_to_cpup((__be16
*) &payload
->blob
[2 + private_len
]);
604 blob_len
= private_len
+ public_len
+ 4;
605 if (blob_len
> payload
->blob_len
)
608 rc
= tpm_buf_init(&buf
, TPM2_ST_SESSIONS
, TPM2_CC_LOAD
);
612 tpm_buf_append_u32(&buf
, options
->keyhandle
);
613 tpm2_buf_append_auth(&buf
, TPM2_RS_PW
,
615 0 /* session_attributes */,
616 options
->keyauth
/* hmac */,
619 tpm_buf_append(&buf
, payload
->blob
, blob_len
);
621 if (buf
.flags
& TPM_BUF_OVERFLOW
) {
626 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 4, flags
,
629 *blob_handle
= be32_to_cpup(
630 (__be32
*) &buf
.data
[TPM_HEADER_SIZE
]);
633 tpm_buf_destroy(&buf
);
642 * tpm2_unseal_cmd() - execute a TPM2_Unload command
644 * @chip: TPM chip to use
645 * @payload: the key data in clear and encrypted form
646 * @options: authentication values and other options
647 * @blob_handle: blob handle
648 * @flags: tpm_transmit_cmd flags
650 * Return: 0 on success
651 * -EPERM on tpm error status
652 * < 0 error from tpm_transmit_cmd
654 static int tpm2_unseal_cmd(struct tpm_chip
*chip
,
655 struct trusted_key_payload
*payload
,
656 struct trusted_key_options
*options
,
657 u32 blob_handle
, unsigned int flags
)
665 rc
= tpm_buf_init(&buf
, TPM2_ST_SESSIONS
, TPM2_CC_UNSEAL
);
669 tpm_buf_append_u32(&buf
, blob_handle
);
670 tpm2_buf_append_auth(&buf
,
671 options
->policyhandle
?
672 options
->policyhandle
: TPM2_RS_PW
,
674 TPM2_SA_CONTINUE_SESSION
,
675 options
->blobauth
/* hmac */,
678 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 6, flags
,
684 data_len
= be16_to_cpup(
685 (__be16
*) &buf
.data
[TPM_HEADER_SIZE
+ 4]);
687 rlength
= be32_to_cpu(((struct tpm2_cmd
*)&buf
)
688 ->header
.out
.length
);
689 if (rlength
< TPM_HEADER_SIZE
+ 6 + data_len
) {
693 data
= &buf
.data
[TPM_HEADER_SIZE
+ 6];
695 memcpy(payload
->key
, data
, data_len
- 1);
696 payload
->key_len
= data_len
- 1;
697 payload
->migratable
= data
[data_len
- 1];
701 tpm_buf_destroy(&buf
);
706 * tpm2_unseal_trusted() - unseal the payload of a trusted key
708 * @chip: TPM chip to use
709 * @payload: the key data in clear and encrypted form
710 * @options: authentication values and other options
712 * Return: Same as with tpm_transmit_cmd.
714 int tpm2_unseal_trusted(struct tpm_chip
*chip
,
715 struct trusted_key_payload
*payload
,
716 struct trusted_key_options
*options
)
721 mutex_lock(&chip
->tpm_mutex
);
722 rc
= tpm2_load_cmd(chip
, payload
, options
, &blob_handle
,
723 TPM_TRANSMIT_UNLOCKED
);
727 rc
= tpm2_unseal_cmd(chip
, payload
, options
, blob_handle
,
728 TPM_TRANSMIT_UNLOCKED
);
729 tpm2_flush_context_cmd(chip
, blob_handle
, TPM_TRANSMIT_UNLOCKED
);
731 mutex_unlock(&chip
->tpm_mutex
);
736 * tpm2_get_tpm_pt() - get value of a TPM_CAP_TPM_PROPERTIES type property
737 * @chip: TPM chip to use.
738 * @property_id: property ID.
739 * @value: output variable.
740 * @desc: passed to tpm_transmit_cmd()
742 * Return: Same as with tpm_transmit_cmd.
744 ssize_t
tpm2_get_tpm_pt(struct tpm_chip
*chip
, u32 property_id
, u32
*value
,
750 cmd
.header
.in
= tpm2_get_tpm_pt_header
;
751 cmd
.params
.get_tpm_pt_in
.cap_id
= cpu_to_be32(TPM2_CAP_TPM_PROPERTIES
);
752 cmd
.params
.get_tpm_pt_in
.property_id
= cpu_to_be32(property_id
);
753 cmd
.params
.get_tpm_pt_in
.property_cnt
= cpu_to_be32(1);
755 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, sizeof(cmd
),
756 TPM2_GET_TPM_PT_OUT_BODY_SIZE
, 0, desc
);
758 *value
= be32_to_cpu(cmd
.params
.get_tpm_pt_out
.value
);
762 EXPORT_SYMBOL_GPL(tpm2_get_tpm_pt
);
764 #define TPM2_SHUTDOWN_IN_SIZE \
765 (sizeof(struct tpm_input_header) + \
766 sizeof(struct tpm2_startup_in))
768 static const struct tpm_input_header tpm2_shutdown_header
= {
769 .tag
= cpu_to_be16(TPM2_ST_NO_SESSIONS
),
770 .length
= cpu_to_be32(TPM2_SHUTDOWN_IN_SIZE
),
771 .ordinal
= cpu_to_be32(TPM2_CC_SHUTDOWN
)
775 * tpm2_shutdown() - send shutdown command to the TPM chip
777 * @chip: TPM chip to use.
778 * @shutdown_type: shutdown type. The value is either
779 * TPM_SU_CLEAR or TPM_SU_STATE.
781 void tpm2_shutdown(struct tpm_chip
*chip
, u16 shutdown_type
)
786 cmd
.header
.in
= tpm2_shutdown_header
;
787 cmd
.params
.startup_in
.startup_type
= cpu_to_be16(shutdown_type
);
789 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, sizeof(cmd
), 0, 0,
792 /* In places where shutdown command is sent there's no much we can do
793 * except print the error code on a system failure.
795 if (rc
< 0 && rc
!= -EPIPE
)
796 dev_warn(&chip
->dev
, "transmit returned %d while stopping the TPM",
801 * tpm2_calc_ordinal_duration() - maximum duration for a command
803 * @chip: TPM chip to use.
804 * @ordinal: command code number.
806 * Return: maximum duration for a command
808 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip
*chip
, u32 ordinal
)
810 int index
= TPM_UNDEFINED
;
813 if (ordinal
>= TPM2_CC_FIRST
&& ordinal
<= TPM2_CC_LAST
)
814 index
= tpm2_ordinal_duration
[ordinal
- TPM2_CC_FIRST
];
816 if (index
!= TPM_UNDEFINED
)
817 duration
= chip
->duration
[index
];
820 duration
= 2 * 60 * HZ
;
824 EXPORT_SYMBOL_GPL(tpm2_calc_ordinal_duration
);
826 #define TPM2_SELF_TEST_IN_SIZE \
827 (sizeof(struct tpm_input_header) + \
828 sizeof(struct tpm2_self_test_in))
830 static const struct tpm_input_header tpm2_selftest_header
= {
831 .tag
= cpu_to_be16(TPM2_ST_NO_SESSIONS
),
832 .length
= cpu_to_be32(TPM2_SELF_TEST_IN_SIZE
),
833 .ordinal
= cpu_to_be32(TPM2_CC_SELF_TEST
)
837 * tpm2_do_selftest() - ensure that all self tests have passed
839 * @chip: TPM chip to use
841 * Return: Same as with tpm_transmit_cmd.
843 * The TPM can either run all self tests synchronously and then return
844 * RC_SUCCESS once all tests were successful. Or it can choose to run the tests
845 * asynchronously and return RC_TESTING immediately while the self tests still
846 * execute in the background. This function handles both cases and waits until
847 * all tests have completed.
849 static int tpm2_do_selftest(struct tpm_chip
*chip
)
852 unsigned int delay_msec
= 10;
856 duration
= jiffies_to_msecs(
857 tpm2_calc_ordinal_duration(chip
, TPM2_CC_SELF_TEST
));
860 cmd
.header
.in
= tpm2_selftest_header
;
861 cmd
.params
.selftest_in
.full_test
= 0;
863 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, TPM2_SELF_TEST_IN_SIZE
,
864 0, 0, "continue selftest");
866 if (rc
!= TPM2_RC_TESTING
|| delay_msec
>= duration
)
869 /* wait longer than before */
871 tpm_msleep(delay_msec
);
878 * tpm2_probe() - probe TPM 2.0
879 * @chip: TPM chip to use
881 * Return: < 0 error and 0 on success.
883 * Send idempotent TPM 2.0 command and see whether TPM 2.0 chip replied based on
886 int tpm2_probe(struct tpm_chip
*chip
)
891 cmd
.header
.in
= tpm2_get_tpm_pt_header
;
892 cmd
.params
.get_tpm_pt_in
.cap_id
= cpu_to_be32(TPM2_CAP_TPM_PROPERTIES
);
893 cmd
.params
.get_tpm_pt_in
.property_id
= cpu_to_be32(0x100);
894 cmd
.params
.get_tpm_pt_in
.property_cnt
= cpu_to_be32(1);
896 rc
= tpm_transmit_cmd(chip
, NULL
, &cmd
, sizeof(cmd
), 0, 0, NULL
);
900 if (be16_to_cpu(cmd
.header
.out
.tag
) == TPM2_ST_NO_SESSIONS
)
901 chip
->flags
|= TPM_CHIP_FLAG_TPM2
;
905 EXPORT_SYMBOL_GPL(tpm2_probe
);
907 struct tpm2_pcr_selection
{
913 static ssize_t
tpm2_get_pcr_allocation(struct tpm_chip
*chip
)
915 struct tpm2_pcr_selection pcr_selection
;
919 void *pcr_select_offset
;
921 u32 sizeof_pcr_selection
;
926 rc
= tpm_buf_init(&buf
, TPM2_ST_NO_SESSIONS
, TPM2_CC_GET_CAPABILITY
);
930 tpm_buf_append_u32(&buf
, TPM2_CAP_PCRS
);
931 tpm_buf_append_u32(&buf
, 0);
932 tpm_buf_append_u32(&buf
, 1);
934 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
, 9, 0,
935 "get tpm pcr allocation");
939 count
= be32_to_cpup(
940 (__be32
*)&buf
.data
[TPM_HEADER_SIZE
+ 5]);
942 if (count
> ARRAY_SIZE(chip
->active_banks
)) {
947 marker
= &buf
.data
[TPM_HEADER_SIZE
+ 9];
949 rsp_len
= be32_to_cpup((__be32
*)&buf
.data
[2]);
950 end
= &buf
.data
[rsp_len
];
952 for (i
= 0; i
< count
; i
++) {
953 pcr_select_offset
= marker
+
954 offsetof(struct tpm2_pcr_selection
, size_of_select
);
955 if (pcr_select_offset
>= end
) {
960 memcpy(&pcr_selection
, marker
, sizeof(pcr_selection
));
961 chip
->active_banks
[i
] = be16_to_cpu(pcr_selection
.hash_alg
);
962 sizeof_pcr_selection
= sizeof(pcr_selection
.hash_alg
) +
963 sizeof(pcr_selection
.size_of_select
) +
964 pcr_selection
.size_of_select
;
965 marker
= marker
+ sizeof_pcr_selection
;
969 if (i
< ARRAY_SIZE(chip
->active_banks
))
970 chip
->active_banks
[i
] = TPM2_ALG_ERROR
;
972 tpm_buf_destroy(&buf
);
977 static int tpm2_get_cc_attrs_tbl(struct tpm_chip
*chip
)
986 rc
= tpm2_get_tpm_pt(chip
, TPM_PT_TOTAL_COMMANDS
, &nr_commands
, NULL
);
990 if (nr_commands
> 0xFFFFF) {
995 chip
->cc_attrs_tbl
= devm_kzalloc(&chip
->dev
, 4 * nr_commands
,
998 rc
= tpm_buf_init(&buf
, TPM2_ST_NO_SESSIONS
, TPM2_CC_GET_CAPABILITY
);
1002 tpm_buf_append_u32(&buf
, TPM2_CAP_COMMANDS
);
1003 tpm_buf_append_u32(&buf
, TPM2_CC_FIRST
);
1004 tpm_buf_append_u32(&buf
, nr_commands
);
1006 rc
= tpm_transmit_cmd(chip
, NULL
, buf
.data
, PAGE_SIZE
,
1007 9 + 4 * nr_commands
, 0, NULL
);
1009 tpm_buf_destroy(&buf
);
1014 be32_to_cpup((__be32
*)&buf
.data
[TPM_HEADER_SIZE
+ 5])) {
1015 tpm_buf_destroy(&buf
);
1019 chip
->nr_commands
= nr_commands
;
1021 attrs
= (__be32
*)&buf
.data
[TPM_HEADER_SIZE
+ 9];
1022 for (i
= 0; i
< nr_commands
; i
++, attrs
++) {
1023 chip
->cc_attrs_tbl
[i
] = be32_to_cpup(attrs
);
1024 cc
= chip
->cc_attrs_tbl
[i
] & 0xFFFF;
1026 if (cc
== TPM2_CC_CONTEXT_SAVE
|| cc
== TPM2_CC_FLUSH_CONTEXT
) {
1027 chip
->cc_attrs_tbl
[i
] &=
1028 ~(GENMASK(2, 0) << TPM2_CC_ATTR_CHANDLES
);
1029 chip
->cc_attrs_tbl
[i
] |= 1 << TPM2_CC_ATTR_CHANDLES
;
1033 tpm_buf_destroy(&buf
);
1042 * tpm2_auto_startup - Perform the standard automatic TPM initialization
1044 * @chip: TPM chip to use
1046 * Returns 0 on success, < 0 in case of fatal error.
1048 int tpm2_auto_startup(struct tpm_chip
*chip
)
1052 rc
= tpm_get_timeouts(chip
);
1056 rc
= tpm2_do_selftest(chip
);
1057 if (rc
!= 0 && rc
!= TPM2_RC_INITIALIZE
) {
1058 dev_err(&chip
->dev
, "TPM self test failed\n");
1062 if (rc
== TPM2_RC_INITIALIZE
) {
1063 rc
= tpm_startup(chip
);
1067 rc
= tpm2_do_selftest(chip
);
1069 dev_err(&chip
->dev
, "TPM self test failed\n");
1074 rc
= tpm2_get_pcr_allocation(chip
);
1078 rc
= tpm2_get_cc_attrs_tbl(chip
);
1086 int tpm2_find_cc(struct tpm_chip
*chip
, u32 cc
)
1090 for (i
= 0; i
< chip
->nr_commands
; i
++)
1091 if (cc
== (chip
->cc_attrs_tbl
[i
] & GENMASK(15, 0)))