]>
Commit | Line | Data |
---|---|---|
0c18794e | 1 | /** @file\r |
07309c3d | 2 | This library is only intended to be used by TPM modules.\r |
0c18794e | 3 | It provides basic TPM Interface Specification (TIS) and Command functions.\r |
4 | \r | |
b3548d32 | 5 | Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r |
289b714b | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
0c18794e | 7 | \r |
8 | **/\r | |
9 | \r | |
10 | #ifndef _TPM_COMM_LIB_H_\r | |
11 | #define _TPM_COMM_LIB_H_\r | |
12 | \r | |
13 | #include <IndustryStandard/Tpm12.h>\r | |
14 | \r | |
c411b485 | 15 | typedef EFI_HANDLE TIS_TPM_HANDLE;\r |
0c18794e | 16 | \r |
17 | ///\r | |
18 | /// TPM register base address.\r | |
19 | ///\r | |
c411b485 | 20 | #define TPM_BASE_ADDRESS 0xfed40000\r |
0c18794e | 21 | \r |
22 | //\r | |
23 | // Set structure alignment to 1-byte\r | |
24 | //\r | |
25 | #pragma pack (1)\r | |
26 | \r | |
27 | //\r | |
28 | // Register set map as specified in TIS specification Chapter 10\r | |
29 | //\r | |
30 | typedef struct {\r | |
31 | ///\r | |
32 | /// Used to gain ownership for this particular port.\r | |
33 | ///\r | |
c411b485 MK |
34 | UINT8 Access; // 0\r |
35 | UINT8 Reserved1[7]; // 1\r | |
0c18794e | 36 | ///\r |
37 | /// Controls interrupts.\r | |
38 | ///\r | |
c411b485 | 39 | UINT32 IntEnable; // 8\r |
0c18794e | 40 | ///\r |
41 | /// SIRQ vector to be used by the TPM.\r | |
42 | ///\r | |
c411b485 MK |
43 | UINT8 IntVector; // 0ch\r |
44 | UINT8 Reserved2[3]; // 0dh\r | |
0c18794e | 45 | ///\r |
46 | /// What caused interrupt.\r | |
47 | ///\r | |
c411b485 | 48 | UINT32 IntSts; // 10h\r |
0c18794e | 49 | ///\r |
50 | /// Shows which interrupts are supported by that particular TPM.\r | |
51 | ///\r | |
c411b485 | 52 | UINT32 IntfCapability; // 14h\r |
0c18794e | 53 | ///\r |
54 | /// Status Register. Provides status of the TPM.\r | |
55 | ///\r | |
c411b485 | 56 | UINT8 Status; // 18h\r |
0c18794e | 57 | ///\r |
58 | /// Number of consecutive writes that can be done to the TPM.\r | |
59 | ///\r | |
c411b485 MK |
60 | UINT16 BurstCount; // 19h\r |
61 | UINT8 Reserved3[9];\r | |
0c18794e | 62 | ///\r |
63 | /// Read or write FIFO, depending on transaction.\r | |
64 | ///\r | |
c411b485 MK |
65 | UINT32 DataFifo; // 24\r |
66 | UINT8 Reserved4[0xed8]; // 28h\r | |
0c18794e | 67 | ///\r |
68 | /// Vendor ID\r | |
69 | ///\r | |
c411b485 | 70 | UINT16 Vid; // 0f00h\r |
0c18794e | 71 | ///\r |
72 | /// Device ID\r | |
73 | ///\r | |
c411b485 | 74 | UINT16 Did; // 0f02h\r |
0c18794e | 75 | ///\r |
76 | /// Revision ID\r | |
77 | ///\r | |
c411b485 | 78 | UINT8 Rid; // 0f04h\r |
0c18794e | 79 | ///\r |
80 | /// TCG defined configuration registers.\r | |
81 | ///\r | |
c411b485 | 82 | UINT8 TcgDefined[0x7b]; // 0f05h\r |
0c18794e | 83 | ///\r |
84 | /// Alias to I/O legacy space.\r | |
85 | ///\r | |
c411b485 | 86 | UINT32 LegacyAddress1; // 0f80h\r |
0c18794e | 87 | ///\r |
88 | /// Additional 8 bits for I/O legacy space extension.\r | |
89 | ///\r | |
c411b485 | 90 | UINT32 LegacyAddress1Ex; // 0f84h\r |
0c18794e | 91 | ///\r |
92 | /// Alias to second I/O legacy space.\r | |
93 | ///\r | |
c411b485 | 94 | UINT32 LegacyAddress2; // 0f88h\r |
0c18794e | 95 | ///\r |
96 | /// Additional 8 bits for second I/O legacy space extension.\r | |
97 | ///\r | |
c411b485 | 98 | UINT32 LegacyAddress2Ex; // 0f8ch\r |
0c18794e | 99 | ///\r |
100 | /// Vendor-defined configuration registers.\r | |
101 | ///\r | |
c411b485 | 102 | UINT8 VendorDefined[0x70]; // 0f90h\r |
0c18794e | 103 | } TIS_PC_REGISTERS;\r |
104 | \r | |
105 | //\r | |
106 | // Restore original structure alignment\r | |
107 | //\r | |
108 | #pragma pack ()\r | |
109 | \r | |
110 | //\r | |
111 | // Define pointer types used to access TIS registers on PC\r | |
112 | //\r | |
c411b485 | 113 | typedef TIS_PC_REGISTERS *TIS_PC_REGISTERS_PTR;\r |
0c18794e | 114 | \r |
115 | //\r | |
116 | // TCG Platform Type based on TCG ACPI Specification Version 1.00\r | |
117 | //\r | |
c411b485 MK |
118 | #define TCG_PLATFORM_TYPE_CLIENT 0\r |
119 | #define TCG_PLATFORM_TYPE_SERVER 1\r | |
0c18794e | 120 | \r |
121 | //\r | |
122 | // Define bits of ACCESS and STATUS registers\r | |
123 | //\r | |
124 | \r | |
125 | ///\r | |
126 | /// This bit is a 1 to indicate that the other bits in this register are valid.\r | |
127 | ///\r | |
c411b485 | 128 | #define TIS_PC_VALID BIT7\r |
0c18794e | 129 | ///\r |
130 | /// Indicate that this locality is active.\r | |
131 | ///\r | |
c411b485 | 132 | #define TIS_PC_ACC_ACTIVE BIT5\r |
0c18794e | 133 | ///\r |
134 | /// Set to 1 to indicate that this locality had the TPM taken away while\r | |
135 | /// this locality had the TIS_PC_ACC_ACTIVE bit set.\r | |
136 | ///\r | |
c411b485 | 137 | #define TIS_PC_ACC_SEIZED BIT4\r |
0c18794e | 138 | ///\r |
139 | /// Set to 1 to indicate that TPM MUST reset the\r | |
140 | /// TIS_PC_ACC_ACTIVE bit and remove ownership for localities less than the\r | |
141 | /// locality that is writing this bit.\r | |
142 | ///\r | |
c411b485 | 143 | #define TIS_PC_ACC_SEIZE BIT3\r |
0c18794e | 144 | ///\r |
145 | /// When this bit is 1, another locality is requesting usage of the TPM.\r | |
146 | ///\r | |
c411b485 | 147 | #define TIS_PC_ACC_PENDIND BIT2\r |
0c18794e | 148 | ///\r |
149 | /// Set to 1 to indicate that this locality is requesting to use TPM.\r | |
150 | ///\r | |
c411b485 | 151 | #define TIS_PC_ACC_RQUUSE BIT1\r |
0c18794e | 152 | ///\r |
153 | /// A value of 1 indicates that a T/OS has not been established on the platform\r | |
154 | ///\r | |
c411b485 | 155 | #define TIS_PC_ACC_ESTABLISH BIT0\r |
0c18794e | 156 | \r |
157 | ///\r | |
b3548d32 | 158 | /// When this bit is 1, TPM is in the Ready state,\r |
0c18794e | 159 | /// indicating it is ready to receive a new command.\r |
160 | ///\r | |
c411b485 | 161 | #define TIS_PC_STS_READY BIT6\r |
0c18794e | 162 | ///\r |
163 | /// Write a 1 to this bit to cause the TPM to execute that command.\r | |
164 | ///\r | |
c411b485 | 165 | #define TIS_PC_STS_GO BIT5\r |
0c18794e | 166 | ///\r |
167 | /// This bit indicates that the TPM has data available as a response.\r | |
168 | ///\r | |
c411b485 | 169 | #define TIS_PC_STS_DATA BIT4\r |
0c18794e | 170 | ///\r |
171 | /// The TPM sets this bit to a value of 1 when it expects another byte of data for a command.\r | |
172 | ///\r | |
c411b485 | 173 | #define TIS_PC_STS_EXPECT BIT3\r |
0c18794e | 174 | ///\r |
175 | /// Writes a 1 to this bit to force the TPM to re-send the response.\r | |
176 | ///\r | |
c411b485 | 177 | #define TIS_PC_STS_RETRY BIT1\r |
0c18794e | 178 | \r |
179 | //\r | |
180 | // Default TimeOut value\r | |
181 | //\r | |
c411b485 MK |
182 | #define TIS_TIMEOUT_A 750 * 1000 // 750ms\r |
183 | #define TIS_TIMEOUT_B 2000 * 1000 // 2s\r | |
184 | #define TIS_TIMEOUT_C 750 * 1000 // 750ms\r | |
185 | #define TIS_TIMEOUT_D 750 * 1000 // 750ms\r | |
0c18794e | 186 | \r |
187 | //\r | |
f9fd0c21 | 188 | // Max TPM command/response length\r |
0c18794e | 189 | //\r |
c411b485 | 190 | #define TPMCMDBUFLENGTH 1024\r |
0c18794e | 191 | \r |
192 | /**\r | |
193 | Check whether the value of a TPM chip register satisfies the input BIT setting.\r | |
194 | \r | |
195 | @param[in] Register Address port of register to be checked.\r | |
196 | @param[in] BitSet Check these data bits are set.\r | |
197 | @param[in] BitClear Check these data bits are clear.\r | |
198 | @param[in] TimeOut The max wait time (unit MicroSecond) when checking register.\r | |
199 | \r | |
200 | @retval EFI_SUCCESS The register satisfies the check bit.\r | |
201 | @retval EFI_TIMEOUT The register can't run into the expected status in time.\r | |
202 | **/\r | |
203 | EFI_STATUS\r | |
204 | EFIAPI\r | |
205 | TisPcWaitRegisterBits (\r | |
206 | IN UINT8 *Register,\r | |
b3548d32 LG |
207 | IN UINT8 BitSet,\r |
208 | IN UINT8 BitClear,\r | |
209 | IN UINT32 TimeOut\r | |
0c18794e | 210 | );\r |
211 | \r | |
212 | /**\r | |
f9fd0c21 | 213 | Get BurstCount by reading the burstCount field of a TIS register\r |
0c18794e | 214 | in the time of default TIS_TIMEOUT_D.\r |
215 | \r | |
216 | @param[in] TisReg Pointer to TIS register.\r | |
d6b926e7 | 217 | @param[out] BurstCount Pointer to a buffer to store the got BurstCount.\r |
0c18794e | 218 | \r |
219 | @retval EFI_SUCCESS Get BurstCount.\r | |
220 | @retval EFI_INVALID_PARAMETER TisReg is NULL or BurstCount is NULL.\r | |
221 | @retval EFI_TIMEOUT BurstCount can't be got in time.\r | |
222 | **/\r | |
223 | EFI_STATUS\r | |
224 | EFIAPI\r | |
225 | TisPcReadBurstCount (\r | |
226 | IN TIS_PC_REGISTERS_PTR TisReg,\r | |
227 | OUT UINT16 *BurstCount\r | |
228 | );\r | |
229 | \r | |
230 | /**\r | |
b3548d32 | 231 | Set TPM chip to ready state by sending ready command TIS_PC_STS_READY\r |
0c18794e | 232 | to Status Register in time.\r |
233 | \r | |
234 | @param[in] TisReg Pointer to TIS register.\r | |
235 | \r | |
236 | @retval EFI_SUCCESS TPM chip enters into ready state.\r | |
237 | @retval EFI_INVALID_PARAMETER TisReg is NULL.\r | |
238 | @retval EFI_TIMEOUT TPM chip can't be set to ready state in time.\r | |
239 | **/\r | |
240 | EFI_STATUS\r | |
241 | EFIAPI\r | |
242 | TisPcPrepareCommand (\r | |
243 | IN TIS_PC_REGISTERS_PTR TisReg\r | |
244 | );\r | |
245 | \r | |
246 | /**\r | |
b3548d32 | 247 | Get the control of TPM chip by sending requestUse command TIS_PC_ACC_RQUUSE\r |
0c18794e | 248 | to ACCESS Register in the time of default TIS_TIMEOUT_D.\r |
249 | \r | |
250 | @param[in] TisReg Pointer to TIS register.\r | |
251 | \r | |
252 | @retval EFI_SUCCESS Get the control of TPM chip.\r | |
253 | @retval EFI_INVALID_PARAMETER TisReg is NULL.\r | |
254 | @retval EFI_NOT_FOUND TPM chip doesn't exit.\r | |
255 | @retval EFI_TIMEOUT Can't get the TPM control in time.\r | |
256 | **/\r | |
257 | EFI_STATUS\r | |
258 | EFIAPI\r | |
259 | TisPcRequestUseTpm (\r | |
260 | IN TIS_PC_REGISTERS_PTR TisReg\r | |
261 | );\r | |
262 | \r | |
263 | /**\r | |
264 | Single function calculates SHA1 digest value for all raw data. It\r | |
265 | combines Sha1Init(), Sha1Update() and Sha1Final().\r | |
266 | \r | |
267 | @param[in] Data Raw data to be digested.\r | |
268 | @param[in] DataLen Size of the raw data.\r | |
269 | @param[out] Digest Pointer to a buffer that stores the final digest.\r | |
b3548d32 | 270 | \r |
0c18794e | 271 | @retval EFI_SUCCESS Always successfully calculate the final digest.\r |
272 | **/\r | |
273 | EFI_STATUS\r | |
274 | EFIAPI\r | |
275 | TpmCommHashAll (\r | |
276 | IN CONST UINT8 *Data,\r | |
277 | IN UINTN DataLen,\r | |
278 | OUT TPM_DIGEST *Digest\r | |
279 | );\r | |
280 | \r | |
281 | #endif\r |