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 <keys/trusted-type.h>
21 enum tpm2_object_attributes {
22 TPM2_ATTR_USER_WITH_AUTH = BIT(6),
25 struct tpm2_startup_in {
29 struct tpm2_self_test_in {
33 struct tpm2_pcr_read_in {
34 __be32 pcr_selects_cnt;
37 u8 pcr_select[TPM2_PCR_SELECT_MIN];
40 struct tpm2_pcr_read_out {
42 __be32 pcr_selects_cnt;
45 u8 pcr_select[TPM2_PCR_SELECT_MIN];
48 u8 digest[TPM_DIGEST_SIZE];
51 struct tpm2_null_auth_area {
58 struct tpm2_pcr_extend_in {
60 __be32 auth_area_size;
61 struct tpm2_null_auth_area auth_area;
64 u8 digest[TPM_DIGEST_SIZE];
67 struct tpm2_get_tpm_pt_in {
73 struct tpm2_get_tpm_pt_out {
81 struct tpm2_get_random_in {
85 struct tpm2_get_random_out {
87 u8 buffer[TPM_MAX_RNG_DATA];
90 union tpm2_cmd_params {
91 struct tpm2_startup_in startup_in;
92 struct tpm2_self_test_in selftest_in;
93 struct tpm2_pcr_read_in pcrread_in;
94 struct tpm2_pcr_read_out pcrread_out;
95 struct tpm2_pcr_extend_in pcrextend_in;
96 struct tpm2_get_tpm_pt_in get_tpm_pt_in;
97 struct tpm2_get_tpm_pt_out get_tpm_pt_out;
98 struct tpm2_get_random_in getrandom_in;
99 struct tpm2_get_random_out getrandom_out;
103 tpm_cmd_header header;
104 union tpm2_cmd_params params;
108 * Array with one entry per ordinal defining the maximum amount
109 * of time the chip could take to return the result. The values
110 * of the SHORT, MEDIUM, and LONG durations are taken from the
111 * PC Client Profile (PTP) specification.
113 static const u8 tpm2_ordinal_duration[TPM2_CC_LAST - TPM2_CC_FIRST + 1] = {
114 TPM_UNDEFINED, /* 11F */
115 TPM_UNDEFINED, /* 120 */
117 TPM_UNDEFINED, /* 122 */
118 TPM_UNDEFINED, /* 123 */
119 TPM_UNDEFINED, /* 124 */
120 TPM_UNDEFINED, /* 125 */
121 TPM_UNDEFINED, /* 126 */
122 TPM_UNDEFINED, /* 127 */
123 TPM_UNDEFINED, /* 128 */
125 TPM_UNDEFINED, /* 12a */
126 TPM_UNDEFINED, /* 12b */
127 TPM_UNDEFINED, /* 12c */
128 TPM_UNDEFINED, /* 12d */
129 TPM_UNDEFINED, /* 12e */
130 TPM_UNDEFINED, /* 12f */
131 TPM_UNDEFINED, /* 130 */
132 TPM_UNDEFINED, /* 131 */
133 TPM_UNDEFINED, /* 132 */
134 TPM_UNDEFINED, /* 133 */
135 TPM_UNDEFINED, /* 134 */
136 TPM_UNDEFINED, /* 135 */
137 TPM_UNDEFINED, /* 136 */
138 TPM_UNDEFINED, /* 137 */
139 TPM_UNDEFINED, /* 138 */
140 TPM_UNDEFINED, /* 139 */
141 TPM_UNDEFINED, /* 13a */
142 TPM_UNDEFINED, /* 13b */
143 TPM_UNDEFINED, /* 13c */
144 TPM_UNDEFINED, /* 13d */
145 TPM_MEDIUM, /* 13e */
146 TPM_UNDEFINED, /* 13f */
147 TPM_UNDEFINED, /* 140 */
148 TPM_UNDEFINED, /* 141 */
149 TPM_UNDEFINED, /* 142 */
151 TPM_MEDIUM, /* 144 */
152 TPM_UNDEFINED, /* 145 */
153 TPM_UNDEFINED, /* 146 */
154 TPM_UNDEFINED, /* 147 */
155 TPM_UNDEFINED, /* 148 */
156 TPM_UNDEFINED, /* 149 */
157 TPM_UNDEFINED, /* 14a */
158 TPM_UNDEFINED, /* 14b */
159 TPM_UNDEFINED, /* 14c */
160 TPM_UNDEFINED, /* 14d */
162 TPM_UNDEFINED, /* 14f */
163 TPM_UNDEFINED, /* 150 */
164 TPM_UNDEFINED, /* 151 */
165 TPM_UNDEFINED, /* 152 */
166 TPM_UNDEFINED, /* 153 */
167 TPM_UNDEFINED, /* 154 */
168 TPM_UNDEFINED, /* 155 */
169 TPM_UNDEFINED, /* 156 */
170 TPM_UNDEFINED, /* 157 */
171 TPM_UNDEFINED, /* 158 */
172 TPM_UNDEFINED, /* 159 */
173 TPM_UNDEFINED, /* 15a */
174 TPM_UNDEFINED, /* 15b */
175 TPM_MEDIUM, /* 15c */
176 TPM_UNDEFINED, /* 15d */
177 TPM_UNDEFINED, /* 15e */
178 TPM_UNDEFINED, /* 15f */
179 TPM_UNDEFINED, /* 160 */
180 TPM_UNDEFINED, /* 161 */
181 TPM_UNDEFINED, /* 162 */
182 TPM_UNDEFINED, /* 163 */
183 TPM_UNDEFINED, /* 164 */
184 TPM_UNDEFINED, /* 165 */
185 TPM_UNDEFINED, /* 166 */
186 TPM_UNDEFINED, /* 167 */
187 TPM_UNDEFINED, /* 168 */
188 TPM_UNDEFINED, /* 169 */
189 TPM_UNDEFINED, /* 16a */
190 TPM_UNDEFINED, /* 16b */
191 TPM_UNDEFINED, /* 16c */
192 TPM_UNDEFINED, /* 16d */
193 TPM_UNDEFINED, /* 16e */
194 TPM_UNDEFINED, /* 16f */
195 TPM_UNDEFINED, /* 170 */
196 TPM_UNDEFINED, /* 171 */
197 TPM_UNDEFINED, /* 172 */
198 TPM_UNDEFINED, /* 173 */
199 TPM_UNDEFINED, /* 174 */
200 TPM_UNDEFINED, /* 175 */
201 TPM_UNDEFINED, /* 176 */
203 TPM_UNDEFINED, /* 178 */
204 TPM_UNDEFINED, /* 179 */
205 TPM_MEDIUM, /* 17a */
207 TPM_UNDEFINED, /* 17c */
208 TPM_UNDEFINED, /* 17d */
209 TPM_UNDEFINED, /* 17e */
210 TPM_UNDEFINED, /* 17f */
211 TPM_UNDEFINED, /* 180 */
212 TPM_UNDEFINED, /* 181 */
213 TPM_MEDIUM, /* 182 */
214 TPM_UNDEFINED, /* 183 */
215 TPM_UNDEFINED, /* 184 */
216 TPM_MEDIUM, /* 185 */
217 TPM_MEDIUM, /* 186 */
218 TPM_UNDEFINED, /* 187 */
219 TPM_UNDEFINED, /* 188 */
220 TPM_UNDEFINED, /* 189 */
221 TPM_UNDEFINED, /* 18a */
222 TPM_UNDEFINED, /* 18b */
223 TPM_UNDEFINED, /* 18c */
224 TPM_UNDEFINED, /* 18d */
225 TPM_UNDEFINED, /* 18e */
226 TPM_UNDEFINED /* 18f */
229 #define TPM2_PCR_READ_IN_SIZE \
230 (sizeof(struct tpm_input_header) + \
231 sizeof(struct tpm2_pcr_read_in))
233 static const struct tpm_input_header tpm2_pcrread_header = {
234 .tag = cpu_to_be16(TPM2_ST_NO_SESSIONS),
235 .length = cpu_to_be32(TPM2_PCR_READ_IN_SIZE),
236 .ordinal = cpu_to_be32(TPM2_CC_PCR_READ)
240 * tpm2_pcr_read() - read a PCR value
241 * @chip: TPM chip to use.
242 * @pcr_idx: index of the PCR to read.
243 * @ref_buf: buffer to store the resulting hash,
245 * 0 is returned when the operation is successful. If a negative number is
246 * returned it remarks a POSIX error code. If a positive number is returned
247 * it remarks a TPM error.
249 int tpm2_pcr_read(struct tpm_chip *chip, int pcr_idx, u8 *res_buf)
255 if (pcr_idx >= TPM2_PLATFORM_PCR)
258 cmd.header.in = tpm2_pcrread_header;
259 cmd.params.pcrread_in.pcr_selects_cnt = cpu_to_be32(1);
260 cmd.params.pcrread_in.hash_alg = cpu_to_be16(TPM2_ALG_SHA1);
261 cmd.params.pcrread_in.pcr_select_size = TPM2_PCR_SELECT_MIN;
263 memset(cmd.params.pcrread_in.pcr_select, 0,
264 sizeof(cmd.params.pcrread_in.pcr_select));
265 cmd.params.pcrread_in.pcr_select[pcr_idx >> 3] = 1 << (pcr_idx & 0x7);
267 rc = tpm_transmit_cmd(chip, &cmd, sizeof(cmd), 0,
268 "attempting to read a pcr value");
270 buf = cmd.params.pcrread_out.digest;
271 memcpy(res_buf, buf, TPM_DIGEST_SIZE);
277 #define TPM2_GET_PCREXTEND_IN_SIZE \
278 (sizeof(struct tpm_input_header) + \
279 sizeof(struct tpm2_pcr_extend_in))
281 static const struct tpm_input_header tpm2_pcrextend_header = {
282 .tag = cpu_to_be16(TPM2_ST_SESSIONS),
283 .length = cpu_to_be32(TPM2_GET_PCREXTEND_IN_SIZE),
284 .ordinal = cpu_to_be32(TPM2_CC_PCR_EXTEND)
288 * tpm2_pcr_extend() - extend a PCR value
289 * @chip: TPM chip to use.
290 * @pcr_idx: index of the PCR.
291 * @hash: hash value to use for the extend operation.
293 * 0 is returned when the operation is successful. If a negative number is
294 * returned it remarks a POSIX error code. If a positive number is returned
295 * it remarks a TPM error.
297 int tpm2_pcr_extend(struct tpm_chip *chip, int pcr_idx, const u8 *hash)
302 cmd.header.in = tpm2_pcrextend_header;
303 cmd.params.pcrextend_in.pcr_idx = cpu_to_be32(pcr_idx);
304 cmd.params.pcrextend_in.auth_area_size =
305 cpu_to_be32(sizeof(struct tpm2_null_auth_area));
306 cmd.params.pcrextend_in.auth_area.handle =
307 cpu_to_be32(TPM2_RS_PW);
308 cmd.params.pcrextend_in.auth_area.nonce_size = 0;
309 cmd.params.pcrextend_in.auth_area.attributes = 0;
310 cmd.params.pcrextend_in.auth_area.auth_size = 0;
311 cmd.params.pcrextend_in.digest_cnt = cpu_to_be32(1);
312 cmd.params.pcrextend_in.hash_alg = cpu_to_be16(TPM2_ALG_SHA1);
313 memcpy(cmd.params.pcrextend_in.digest, hash, TPM_DIGEST_SIZE);
315 rc = tpm_transmit_cmd(chip, &cmd, sizeof(cmd), 0,
316 "attempting extend a PCR value");
321 #define TPM2_GETRANDOM_IN_SIZE \
322 (sizeof(struct tpm_input_header) + \
323 sizeof(struct tpm2_get_random_in))
325 static const struct tpm_input_header tpm2_getrandom_header = {
326 .tag = cpu_to_be16(TPM2_ST_NO_SESSIONS),
327 .length = cpu_to_be32(TPM2_GETRANDOM_IN_SIZE),
328 .ordinal = cpu_to_be32(TPM2_CC_GET_RANDOM)
332 * tpm2_get_random() - get random bytes from the TPM RNG
333 * @chip: TPM chip to use
334 * @out: destination buffer for the random bytes
335 * @max: the max number of bytes to write to @out
337 * 0 is returned when the operation is successful. If a negative number is
338 * returned it remarks a POSIX error code. If a positive number is returned
339 * it remarks a TPM error.
341 int tpm2_get_random(struct tpm_chip *chip, u8 *out, size_t max)
351 num_bytes = min_t(u32, max, sizeof(cmd.params.getrandom_out.buffer));
353 if (!out || !num_bytes ||
354 max > sizeof(cmd.params.getrandom_out.buffer))
358 cmd.header.in = tpm2_getrandom_header;
359 cmd.params.getrandom_in.size = cpu_to_be16(num_bytes);
361 err = tpm_transmit_cmd(chip, &cmd, sizeof(cmd), 0,
362 "attempting get random");
366 recd = min_t(u32, be16_to_cpu(cmd.params.getrandom_out.size),
368 memcpy(dest, cmd.params.getrandom_out.buffer, recd);
373 } while (retries-- && total < max);
375 return total ? total : -EIO;
378 #define TPM2_GET_TPM_PT_IN_SIZE \
379 (sizeof(struct tpm_input_header) + \
380 sizeof(struct tpm2_get_tpm_pt_in))
382 static const struct tpm_input_header tpm2_get_tpm_pt_header = {
383 .tag = cpu_to_be16(TPM2_ST_NO_SESSIONS),
384 .length = cpu_to_be32(TPM2_GET_TPM_PT_IN_SIZE),
385 .ordinal = cpu_to_be32(TPM2_CC_GET_CAPABILITY)
389 * Append TPMS_AUTH_COMMAND to the buffer. The buffer must be allocated with
392 * @param buf: an allocated tpm_buf instance
393 * @param nonce: the session nonce, may be NULL if not used
394 * @param nonce_len: the session nonce length, may be 0 if not used
395 * @param attributes: the session attributes
396 * @param hmac: the session HMAC or password, may be NULL if not used
397 * @param hmac_len: the session HMAC or password length, maybe 0 if not used
399 static void tpm2_buf_append_auth(struct tpm_buf *buf, u32 session_handle,
400 const u8 *nonce, u16 nonce_len,
402 const u8 *hmac, u16 hmac_len)
404 tpm_buf_append_u32(buf, 9 + nonce_len + hmac_len);
405 tpm_buf_append_u32(buf, session_handle);
406 tpm_buf_append_u16(buf, nonce_len);
408 if (nonce && nonce_len)
409 tpm_buf_append(buf, nonce, nonce_len);
411 tpm_buf_append_u8(buf, attributes);
412 tpm_buf_append_u16(buf, hmac_len);
414 if (hmac && hmac_len)
415 tpm_buf_append(buf, hmac, hmac_len);
419 * tpm2_seal_trusted() - seal the payload of a trusted key
420 * @chip_num: TPM chip to use
421 * @payload: the key data in clear and encrypted form
422 * @options: authentication values and other options
424 * Return: < 0 on error and 0 on success.
426 int tpm2_seal_trusted(struct tpm_chip *chip,
427 struct trusted_key_payload *payload,
428 struct trusted_key_options *options)
430 unsigned int blob_len;
434 rc = tpm_buf_init(&buf, TPM2_ST_SESSIONS, TPM2_CC_CREATE);
438 tpm_buf_append_u32(&buf, options->keyhandle);
439 tpm2_buf_append_auth(&buf, TPM2_RS_PW,
441 0 /* session_attributes */,
442 options->keyauth /* hmac */,
446 tpm_buf_append_u16(&buf, 4 + TPM_DIGEST_SIZE + payload->key_len + 1);
448 tpm_buf_append_u16(&buf, TPM_DIGEST_SIZE);
449 tpm_buf_append(&buf, options->blobauth, TPM_DIGEST_SIZE);
450 tpm_buf_append_u16(&buf, payload->key_len + 1);
451 tpm_buf_append(&buf, payload->key, payload->key_len);
452 tpm_buf_append_u8(&buf, payload->migratable);
455 tpm_buf_append_u16(&buf, 14);
457 tpm_buf_append_u16(&buf, TPM2_ALG_KEYEDHASH);
458 tpm_buf_append_u16(&buf, TPM2_ALG_SHA256);
459 tpm_buf_append_u32(&buf, TPM2_ATTR_USER_WITH_AUTH);
460 tpm_buf_append_u16(&buf, 0); /* policy digest size */
461 tpm_buf_append_u16(&buf, TPM2_ALG_NULL);
462 tpm_buf_append_u16(&buf, 0);
465 tpm_buf_append_u16(&buf, 0);
468 tpm_buf_append_u32(&buf, 0);
470 if (buf.flags & TPM_BUF_OVERFLOW) {
475 rc = tpm_transmit_cmd(chip, buf.data, PAGE_SIZE, 0, "sealing data");
479 blob_len = be32_to_cpup((__be32 *) &buf.data[TPM_HEADER_SIZE]);
480 if (blob_len > MAX_BLOB_SIZE) {
485 memcpy(payload->blob, &buf.data[TPM_HEADER_SIZE + 4], blob_len);
486 payload->blob_len = blob_len;
489 tpm_buf_destroy(&buf);
498 * tpm2_load_cmd() - execute a TPM2_Load command
499 * @chip_num: TPM chip to use
500 * @payload: the key data in clear and encrypted form
501 * @options: authentication values and other options
503 * Return: same as with tpm_transmit_cmd
505 static int tpm2_load_cmd(struct tpm_chip *chip,
506 struct trusted_key_payload *payload,
507 struct trusted_key_options *options,
508 u32 *blob_handle, unsigned int flags)
511 unsigned int private_len;
512 unsigned int public_len;
513 unsigned int blob_len;
516 private_len = be16_to_cpup((__be16 *) &payload->blob[0]);
517 if (private_len > (payload->blob_len - 2))
520 public_len = be16_to_cpup((__be16 *) &payload->blob[2 + private_len]);
521 blob_len = private_len + public_len + 4;
522 if (blob_len > payload->blob_len)
525 rc = tpm_buf_init(&buf, TPM2_ST_SESSIONS, TPM2_CC_LOAD);
529 tpm_buf_append_u32(&buf, options->keyhandle);
530 tpm2_buf_append_auth(&buf, TPM2_RS_PW,
532 0 /* session_attributes */,
533 options->keyauth /* hmac */,
536 tpm_buf_append(&buf, payload->blob, blob_len);
538 if (buf.flags & TPM_BUF_OVERFLOW) {
543 rc = tpm_transmit_cmd(chip, buf.data, PAGE_SIZE, flags, "loading blob");
545 *blob_handle = be32_to_cpup(
546 (__be32 *) &buf.data[TPM_HEADER_SIZE]);
549 tpm_buf_destroy(&buf);
558 * tpm2_flush_context_cmd() - execute a TPM2_FlushContext command
559 * @chip_num: TPM chip to use
560 * @payload: the key data in clear and encrypted form
561 * @options: authentication values and other options
563 * Return: same as with tpm_transmit_cmd
565 static void tpm2_flush_context_cmd(struct tpm_chip *chip, u32 handle,
571 rc = tpm_buf_init(&buf, TPM2_ST_NO_SESSIONS, TPM2_CC_FLUSH_CONTEXT);
573 dev_warn(chip->pdev, "0x%08x was not flushed, out of memory\n",
578 tpm_buf_append_u32(&buf, handle);
580 rc = tpm_transmit_cmd(chip, buf.data, PAGE_SIZE, flags,
583 dev_warn(chip->pdev, "0x%08x was not flushed, rc=%d\n", handle,
586 tpm_buf_destroy(&buf);
590 * tpm2_unseal_cmd() - execute a TPM2_Unload command
591 * @chip_num: TPM chip to use
592 * @payload: the key data in clear and encrypted form
593 * @options: authentication values and other options
595 * Return: same as with tpm_transmit_cmd
597 static int tpm2_unseal_cmd(struct tpm_chip *chip,
598 struct trusted_key_payload *payload,
599 struct trusted_key_options *options,
600 u32 blob_handle, unsigned int flags)
607 rc = tpm_buf_init(&buf, TPM2_ST_SESSIONS, TPM2_CC_UNSEAL);
611 tpm_buf_append_u32(&buf, blob_handle);
612 tpm2_buf_append_auth(&buf, TPM2_RS_PW,
614 0 /* session_attributes */,
615 options->blobauth /* hmac */,
618 rc = tpm_transmit_cmd(chip, buf.data, PAGE_SIZE, flags, "unsealing");
623 data_len = be16_to_cpup(
624 (__be16 *) &buf.data[TPM_HEADER_SIZE + 4]);
625 data = &buf.data[TPM_HEADER_SIZE + 6];
627 memcpy(payload->key, data, data_len - 1);
628 payload->key_len = data_len - 1;
629 payload->migratable = data[data_len - 1];
632 tpm_buf_destroy(&buf);
637 * tpm_unseal_trusted() - unseal the payload of a trusted key
638 * @chip_num: TPM chip to use
639 * @payload: the key data in clear and encrypted form
640 * @options: authentication values and other options
642 * Return: < 0 on error and 0 on success.
644 int tpm2_unseal_trusted(struct tpm_chip *chip,
645 struct trusted_key_payload *payload,
646 struct trusted_key_options *options)
651 mutex_lock(&chip->tpm_mutex);
652 rc = tpm2_load_cmd(chip, payload, options, &blob_handle,
653 TPM_TRANSMIT_UNLOCKED);
657 rc = tpm2_unseal_cmd(chip, payload, options, blob_handle,
658 TPM_TRANSMIT_UNLOCKED);
659 tpm2_flush_context_cmd(chip, blob_handle, TPM_TRANSMIT_UNLOCKED);
661 mutex_unlock(&chip->tpm_mutex);
666 * tpm2_get_tpm_pt() - get value of a TPM_CAP_TPM_PROPERTIES type property
667 * @chip: TPM chip to use.
668 * @property_id: property ID.
669 * @value: output variable.
670 * @desc: passed to tpm_transmit_cmd()
672 * 0 is returned when the operation is successful. If a negative number is
673 * returned it remarks a POSIX error code. If a positive number is returned
674 * it remarks a TPM error.
676 ssize_t tpm2_get_tpm_pt(struct tpm_chip *chip, u32 property_id, u32 *value,
682 cmd.header.in = tpm2_get_tpm_pt_header;
683 cmd.params.get_tpm_pt_in.cap_id = cpu_to_be32(TPM2_CAP_TPM_PROPERTIES);
684 cmd.params.get_tpm_pt_in.property_id = cpu_to_be32(property_id);
685 cmd.params.get_tpm_pt_in.property_cnt = cpu_to_be32(1);
687 rc = tpm_transmit_cmd(chip, &cmd, sizeof(cmd), 0, desc);
689 *value = be32_to_cpu(cmd.params.get_tpm_pt_out.value);
694 #define TPM2_STARTUP_IN_SIZE \
695 (sizeof(struct tpm_input_header) + \
696 sizeof(struct tpm2_startup_in))
698 static const struct tpm_input_header tpm2_startup_header = {
699 .tag = cpu_to_be16(TPM2_ST_NO_SESSIONS),
700 .length = cpu_to_be32(TPM2_STARTUP_IN_SIZE),
701 .ordinal = cpu_to_be32(TPM2_CC_STARTUP)
705 * tpm2_startup() - send startup command to the TPM chip
706 * @chip: TPM chip to use.
707 * @startup_type startup type. The value is either
708 * TPM_SU_CLEAR or TPM_SU_STATE.
710 * 0 is returned when the operation is successful. If a negative number is
711 * returned it remarks a POSIX error code. If a positive number is returned
712 * it remarks a TPM error.
714 int tpm2_startup(struct tpm_chip *chip, u16 startup_type)
718 cmd.header.in = tpm2_startup_header;
720 cmd.params.startup_in.startup_type = cpu_to_be16(startup_type);
721 return tpm_transmit_cmd(chip, &cmd, sizeof(cmd), 0,
722 "attempting to start the TPM");
724 EXPORT_SYMBOL_GPL(tpm2_startup);
726 #define TPM2_SHUTDOWN_IN_SIZE \
727 (sizeof(struct tpm_input_header) + \
728 sizeof(struct tpm2_startup_in))
730 static const struct tpm_input_header tpm2_shutdown_header = {
731 .tag = cpu_to_be16(TPM2_ST_NO_SESSIONS),
732 .length = cpu_to_be32(TPM2_SHUTDOWN_IN_SIZE),
733 .ordinal = cpu_to_be32(TPM2_CC_SHUTDOWN)
737 * tpm2_shutdown() - send shutdown command to the TPM chip
738 * @chip: TPM chip to use.
739 * @shutdown_type shutdown type. The value is either
740 * TPM_SU_CLEAR or TPM_SU_STATE.
742 void tpm2_shutdown(struct tpm_chip *chip, u16 shutdown_type)
747 cmd.header.in = tpm2_shutdown_header;
748 cmd.params.startup_in.startup_type = cpu_to_be16(shutdown_type);
750 rc = tpm_transmit_cmd(chip, &cmd, sizeof(cmd), 0, "stopping the TPM");
752 /* In places where shutdown command is sent there's no much we can do
753 * except print the error code on a system failure.
756 dev_warn(chip->pdev, "transmit returned %d while stopping the TPM",
759 EXPORT_SYMBOL_GPL(tpm2_shutdown);
762 * tpm2_calc_ordinal_duration() - maximum duration for a command
763 * @chip: TPM chip to use.
764 * @ordinal: command code number.
766 * 0 is returned when the operation is successful. If a negative number is
767 * returned it remarks a POSIX error code. If a positive number is returned
768 * it remarks a TPM error.
770 unsigned long tpm2_calc_ordinal_duration(struct tpm_chip *chip, u32 ordinal)
772 int index = TPM_UNDEFINED;
775 if (ordinal >= TPM2_CC_FIRST && ordinal <= TPM2_CC_LAST)
776 index = tpm2_ordinal_duration[ordinal - TPM2_CC_FIRST];
778 if (index != TPM_UNDEFINED)
779 duration = chip->vendor.duration[index];
782 duration = 2 * 60 * HZ;
786 EXPORT_SYMBOL_GPL(tpm2_calc_ordinal_duration);
788 #define TPM2_SELF_TEST_IN_SIZE \
789 (sizeof(struct tpm_input_header) + \
790 sizeof(struct tpm2_self_test_in))
792 static const struct tpm_input_header tpm2_selftest_header = {
793 .tag = cpu_to_be16(TPM2_ST_NO_SESSIONS),
794 .length = cpu_to_be32(TPM2_SELF_TEST_IN_SIZE),
795 .ordinal = cpu_to_be32(TPM2_CC_SELF_TEST)
799 * tpm2_continue_selftest() - start a self test
800 * @chip: TPM chip to use
801 * @full: test all commands instead of testing only those that were not
804 * 0 is returned when the operation is successful. If a negative number is
805 * returned it remarks a POSIX error code. If a positive number is returned
806 * it remarks a TPM error.
808 static int tpm2_start_selftest(struct tpm_chip *chip, bool full)
813 cmd.header.in = tpm2_selftest_header;
814 cmd.params.selftest_in.full_test = full;
816 rc = tpm_transmit_cmd(chip, &cmd, TPM2_SELF_TEST_IN_SIZE, 0,
817 "continue selftest");
819 /* At least some prototype chips seem to give RC_TESTING error
820 * immediately. This is a workaround for that.
822 if (rc == TPM2_RC_TESTING) {
823 dev_warn(chip->pdev, "Got RC_TESTING, ignoring\n");
831 * tpm2_do_selftest() - run a full self test
832 * @chip: TPM chip to use
834 * During the self test TPM2 commands return with the error code RC_TESTING.
835 * Waiting is done by issuing PCR read until it executes successfully.
837 * 0 is returned when the operation is successful. If a negative number is
838 * returned it remarks a POSIX error code. If a positive number is returned
839 * it remarks a TPM error.
841 int tpm2_do_selftest(struct tpm_chip *chip)
845 unsigned int delay_msec = 100;
846 unsigned long duration;
850 duration = tpm2_calc_ordinal_duration(chip, TPM2_CC_SELF_TEST);
852 loops = jiffies_to_msecs(duration) / delay_msec;
854 rc = tpm2_start_selftest(chip, true);
858 for (i = 0; i < loops; i++) {
859 /* Attempt to read a PCR value */
860 cmd.header.in = tpm2_pcrread_header;
861 cmd.params.pcrread_in.pcr_selects_cnt = cpu_to_be32(1);
862 cmd.params.pcrread_in.hash_alg = cpu_to_be16(TPM2_ALG_SHA1);
863 cmd.params.pcrread_in.pcr_select_size = TPM2_PCR_SELECT_MIN;
864 cmd.params.pcrread_in.pcr_select[0] = 0x01;
865 cmd.params.pcrread_in.pcr_select[1] = 0x00;
866 cmd.params.pcrread_in.pcr_select[2] = 0x00;
868 rc = tpm_transmit_cmd(chip, &cmd, sizeof(cmd), 0, NULL);
872 rc = be32_to_cpu(cmd.header.out.return_code);
873 if (rc != TPM2_RC_TESTING)
881 EXPORT_SYMBOL_GPL(tpm2_do_selftest);
884 * tpm2_gen_interrupt() - generate an interrupt
885 * @chip: TPM chip to use
887 * 0 is returned when the operation is successful. If a negative number is
888 * returned it remarks a POSIX error code. If a positive number is returned
889 * it remarks a TPM error.
891 int tpm2_gen_interrupt(struct tpm_chip *chip)
895 return tpm2_get_tpm_pt(chip, 0x100, &dummy,
896 "attempting to generate an interrupt");
898 EXPORT_SYMBOL_GPL(tpm2_gen_interrupt);
901 * tpm2_probe() - probe TPM 2.0
902 * @chip: TPM chip to use
904 * Send idempotent TPM 2.0 command and see whether TPM 2.0 chip replied based on
907 int tpm2_probe(struct tpm_chip *chip)
912 cmd.header.in = tpm2_get_tpm_pt_header;
913 cmd.params.get_tpm_pt_in.cap_id = cpu_to_be32(TPM2_CAP_TPM_PROPERTIES);
914 cmd.params.get_tpm_pt_in.property_id = cpu_to_be32(0x100);
915 cmd.params.get_tpm_pt_in.property_cnt = cpu_to_be32(1);
917 rc = tpm_transmit(chip, (const u8 *)&cmd, sizeof(cmd), 0);
920 else if (rc < TPM_HEADER_SIZE)
923 if (be16_to_cpu(cmd.header.out.tag) == TPM2_ST_NO_SESSIONS)
924 chip->flags |= TPM_CHIP_FLAG_TPM2;
928 EXPORT_SYMBOL_GPL(tpm2_probe);