Angel Pons | 986d50e | 2020-04-02 23:48:53 +0200 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 2 | |
Philipp Deppenwiese | d88fb36 | 2017-10-18 20:26:18 +0200 | [diff] [blame] | 3 | #ifndef TIS_H_ |
| 4 | #define TIS_H_ |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 5 | |
Jon Murphy | d7b8dc9 | 2023-09-05 11:36:43 -0600 | [diff] [blame] | 6 | #include <security/tpm/tss_errors.h> |
Tim Wawrzynczak | 63632d7 | 2022-02-16 13:44:48 -0700 | [diff] [blame] | 7 | #include <types.h> |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 8 | |
Furquan Shaikh | 260b297 | 2017-04-07 13:26:01 -0700 | [diff] [blame] | 9 | enum tis_access { |
| 10 | TPM_ACCESS_VALID = (1 << 7), |
| 11 | TPM_ACCESS_ACTIVE_LOCALITY = (1 << 5), |
| 12 | TPM_ACCESS_REQUEST_PENDING = (1 << 2), |
| 13 | TPM_ACCESS_REQUEST_USE = (1 << 1), |
| 14 | TPM_ACCESS_ESTABLISHMENT = (1 << 0), |
| 15 | }; |
| 16 | |
| 17 | enum tis_status { |
| 18 | TPM_STS_FAMILY_SHIFT = 26, |
| 19 | TPM_STS_FAMILY_MASK = (0x3 << TPM_STS_FAMILY_SHIFT), |
| 20 | TPM_STS_FAMILY_TPM_2_0 = (1 << TPM_STS_FAMILY_SHIFT), |
| 21 | TPM_STS_FAMILY_TPM_1_2 = (0 << TPM_STS_FAMILY_SHIFT), |
| 22 | TPM_STS_RESET_ESTABLISHMENT = (1 << 25), |
| 23 | TPM_STS_COMMAND_CANCEL = (1 << 24), |
| 24 | TPM_STS_BURST_COUNT_SHIFT = 8, |
| 25 | TPM_STS_BURST_COUNT_MASK = (0xFFFF << TPM_STS_BURST_COUNT_SHIFT), |
| 26 | TPM_STS_VALID = (1 << 7), |
| 27 | TPM_STS_COMMAND_READY = (1 << 6), |
| 28 | TPM_STS_GO = (1 << 5), |
| 29 | TPM_STS_DATA_AVAIL = (1 << 4), |
| 30 | TPM_STS_DATA_EXPECT = (1 << 3), |
| 31 | TPM_STS_SELF_TEST_DONE = (1 << 2), |
| 32 | TPM_STS_RESPONSE_RETRY = (1 << 1), |
| 33 | }; |
| 34 | |
Sergii Dmytruk | febf9b9 | 2022-10-31 15:30:15 +0200 | [diff] [blame^] | 35 | enum tpm_family { |
| 36 | TPM_UNKNOWN = 0, |
| 37 | TPM_1 = 1, |
| 38 | TPM_2 = 2, |
| 39 | }; |
| 40 | |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 41 | /* |
Sergii Dmytruk | 4ee0317 | 2022-12-22 19:35:25 +0200 | [diff] [blame] | 42 | * tis_sendrecv() |
| 43 | * |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 44 | * Send the requested data to the TPM and then try to get its response |
| 45 | * |
| 46 | * @sendbuf - buffer of the data to send |
| 47 | * @send_size size of the data to send |
| 48 | * @recvbuf - memory to save the response to |
| 49 | * @recv_len - pointer to the size of the response buffer |
| 50 | * |
Jon Murphy | d7b8dc9 | 2023-09-05 11:36:43 -0600 | [diff] [blame] | 51 | * Returns TSS Return Code from TCG TPM Structures. See tss_errors.h |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 52 | */ |
Sergii Dmytruk | 963f7b9 | 2022-10-29 20:42:28 +0300 | [diff] [blame] | 53 | typedef tpm_result_t (*tis_sendrecv_fn)(const u8 *sendbuf, size_t send_size, u8 *recvbuf, |
| 54 | size_t *recv_len); |
| 55 | |
| 56 | /* |
| 57 | * tis_probe() |
| 58 | * |
Sergii Dmytruk | febf9b9 | 2022-10-31 15:30:15 +0200 | [diff] [blame^] | 59 | * Probe for the TPM device and set it up for use within locality 0. |
| 60 | * |
| 61 | * @family - pointer which is set to TPM family of the device |
| 62 | * |
| 63 | * Returns pointer to send-receive function on success or NULL on failure. |
Sergii Dmytruk | 963f7b9 | 2022-10-29 20:42:28 +0300 | [diff] [blame] | 64 | * |
| 65 | * Do not call this explicitly, it's meant to be used exclusively by TSS |
| 66 | * implementation (tlcl_lib_init() function to be specific). |
| 67 | */ |
Sergii Dmytruk | febf9b9 | 2022-10-31 15:30:15 +0200 | [diff] [blame^] | 68 | tis_sendrecv_fn tis_probe(enum tpm_family *family); |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 69 | |
Tim Wawrzynczak | 63632d7 | 2022-02-16 13:44:48 -0700 | [diff] [blame] | 70 | /* |
| 71 | * tis_vendor_write() |
| 72 | * |
| 73 | * Vendor-specific function to send the requested data to the TPM. |
| 74 | * |
| 75 | * @addr - address of the register to write to |
| 76 | * @sendbuf - buffer of the data to send |
| 77 | * @send_size - size of the data to send |
| 78 | * |
| 79 | * Returns CB_SUCCESS 0 on success, CB_ERR on failure. |
| 80 | */ |
Subrata Banik | 60b2ab8 | 2022-03-09 12:55:34 +0530 | [diff] [blame] | 81 | enum cb_err tis_vendor_write(unsigned int addr, const void *sendbuf, size_t send_size); |
Tim Wawrzynczak | 63632d7 | 2022-02-16 13:44:48 -0700 | [diff] [blame] | 82 | |
| 83 | /* |
| 84 | * tis_vendor_read() |
| 85 | * |
| 86 | * Vendor-specific function to read the requested data from the TPM. |
| 87 | * |
| 88 | * @addr - address of the register to read from |
| 89 | * @recvbuf - buffer of the data to read |
| 90 | * @recv_size - size of the output buffer |
| 91 | * |
| 92 | * Returns CB_SUCCESS on success or -1 on failure. |
| 93 | */ |
Subrata Banik | 60b2ab8 | 2022-03-09 12:55:34 +0530 | [diff] [blame] | 94 | enum cb_err tis_vendor_read(unsigned int addr, void *recvbuf, size_t recv_size); |
Tim Wawrzynczak | 63632d7 | 2022-02-16 13:44:48 -0700 | [diff] [blame] | 95 | |
Tim Wawrzynczak | 6b8599f | 2022-02-14 16:04:21 -0700 | [diff] [blame] | 96 | static inline bool tpm_first_access_this_boot(void) |
| 97 | { |
| 98 | return ENV_SEPARATE_VERSTAGE || ENV_BOOTBLOCK || !CONFIG(VBOOT); |
| 99 | } |
Tim Wawrzynczak | 63632d7 | 2022-02-16 13:44:48 -0700 | [diff] [blame] | 100 | |
Philipp Deppenwiese | d88fb36 | 2017-10-18 20:26:18 +0200 | [diff] [blame] | 101 | #endif /* TIS_H_ */ |