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 | |
Tim Wawrzynczak | 63632d7 | 2022-02-16 13:44:48 -0700 | [diff] [blame] | 6 | #include <types.h> |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 7 | |
Furquan Shaikh | 260b297 | 2017-04-07 13:26:01 -0700 | [diff] [blame] | 8 | enum tis_access { |
| 9 | TPM_ACCESS_VALID = (1 << 7), |
| 10 | TPM_ACCESS_ACTIVE_LOCALITY = (1 << 5), |
| 11 | TPM_ACCESS_REQUEST_PENDING = (1 << 2), |
| 12 | TPM_ACCESS_REQUEST_USE = (1 << 1), |
| 13 | TPM_ACCESS_ESTABLISHMENT = (1 << 0), |
| 14 | }; |
| 15 | |
| 16 | enum tis_status { |
| 17 | TPM_STS_FAMILY_SHIFT = 26, |
| 18 | TPM_STS_FAMILY_MASK = (0x3 << TPM_STS_FAMILY_SHIFT), |
| 19 | TPM_STS_FAMILY_TPM_2_0 = (1 << TPM_STS_FAMILY_SHIFT), |
| 20 | TPM_STS_FAMILY_TPM_1_2 = (0 << TPM_STS_FAMILY_SHIFT), |
| 21 | TPM_STS_RESET_ESTABLISHMENT = (1 << 25), |
| 22 | TPM_STS_COMMAND_CANCEL = (1 << 24), |
| 23 | TPM_STS_BURST_COUNT_SHIFT = 8, |
| 24 | TPM_STS_BURST_COUNT_MASK = (0xFFFF << TPM_STS_BURST_COUNT_SHIFT), |
| 25 | TPM_STS_VALID = (1 << 7), |
| 26 | TPM_STS_COMMAND_READY = (1 << 6), |
| 27 | TPM_STS_GO = (1 << 5), |
| 28 | TPM_STS_DATA_AVAIL = (1 << 4), |
| 29 | TPM_STS_DATA_EXPECT = (1 << 3), |
| 30 | TPM_STS_SELF_TEST_DONE = (1 << 2), |
| 31 | TPM_STS_RESPONSE_RETRY = (1 << 1), |
| 32 | }; |
| 33 | |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 34 | /* |
Sergii Dmytruk | 4ee0317 | 2022-12-22 19:35:25 +0200 | [diff] [blame] | 35 | * tis_init() |
| 36 | * |
| 37 | * Initialize the TPM device. Returns 0 on success or -1 on |
| 38 | * failure (in case device probing did not succeed). |
| 39 | */ |
| 40 | int tis_init(void); |
| 41 | |
| 42 | /* |
| 43 | * tis_open() |
| 44 | * |
| 45 | * Requests access to locality 0 for the caller. |
| 46 | * |
| 47 | * Returns 0 on success, -1 on failure. |
| 48 | */ |
| 49 | int tis_open(void); |
| 50 | |
| 51 | /* |
| 52 | * tis_sendrecv() |
| 53 | * |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 54 | * Send the requested data to the TPM and then try to get its response |
| 55 | * |
| 56 | * @sendbuf - buffer of the data to send |
| 57 | * @send_size size of the data to send |
| 58 | * @recvbuf - memory to save the response to |
| 59 | * @recv_len - pointer to the size of the response buffer |
| 60 | * |
| 61 | * Returns 0 on success (and places the number of response bytes at recv_len) |
| 62 | * or -1 on failure. |
| 63 | */ |
Sergii Dmytruk | 4ee0317 | 2022-12-22 19:35:25 +0200 | [diff] [blame] | 64 | int tis_sendrecv(const u8 *sendbuf, size_t send_size, u8 *recvbuf, |
| 65 | size_t *recv_len); |
Stefan Reinauer | 7cb01e0 | 2013-08-29 16:05:02 -0700 | [diff] [blame] | 66 | |
Yu-Ping Wu | ae1e702 | 2022-05-17 09:33:18 +0800 | [diff] [blame] | 67 | /* TODO: This is supposed to be used only for Google TPM. |
| 68 | Consider moving this to drivers/tpm/cr50.h. */ |
Jeffy Chen | 19e3d33 | 2017-03-03 18:24:02 +0800 | [diff] [blame] | 69 | /* |
| 70 | * tis_plat_irq_status() |
| 71 | * |
| 72 | * Check tpm irq and clear it. |
| 73 | * |
| 74 | * Returns 1 when irq pending or 0 when not. |
| 75 | */ |
| 76 | int tis_plat_irq_status(void); |
| 77 | |
Tim Wawrzynczak | 63632d7 | 2022-02-16 13:44:48 -0700 | [diff] [blame] | 78 | /* |
| 79 | * tis_vendor_write() |
| 80 | * |
| 81 | * Vendor-specific function to send the requested data to the TPM. |
| 82 | * |
| 83 | * @addr - address of the register to write to |
| 84 | * @sendbuf - buffer of the data to send |
| 85 | * @send_size - size of the data to send |
| 86 | * |
| 87 | * Returns CB_SUCCESS 0 on success, CB_ERR on failure. |
| 88 | */ |
Subrata Banik | 60b2ab8 | 2022-03-09 12:55:34 +0530 | [diff] [blame] | 89 | 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] | 90 | |
| 91 | /* |
| 92 | * tis_vendor_read() |
| 93 | * |
| 94 | * Vendor-specific function to read the requested data from the TPM. |
| 95 | * |
| 96 | * @addr - address of the register to read from |
| 97 | * @recvbuf - buffer of the data to read |
| 98 | * @recv_size - size of the output buffer |
| 99 | * |
| 100 | * Returns CB_SUCCESS on success or -1 on failure. |
| 101 | */ |
Subrata Banik | 60b2ab8 | 2022-03-09 12:55:34 +0530 | [diff] [blame] | 102 | 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] | 103 | |
Tim Wawrzynczak | 6b8599f | 2022-02-14 16:04:21 -0700 | [diff] [blame] | 104 | static inline bool tpm_first_access_this_boot(void) |
| 105 | { |
| 106 | return ENV_SEPARATE_VERSTAGE || ENV_BOOTBLOCK || !CONFIG(VBOOT); |
| 107 | } |
Tim Wawrzynczak | 63632d7 | 2022-02-16 13:44:48 -0700 | [diff] [blame] | 108 | |
Philipp Deppenwiese | d88fb36 | 2017-10-18 20:26:18 +0200 | [diff] [blame] | 109 | #endif /* TIS_H_ */ |