]>
Commit | Line | Data |
---|---|---|
c1d93242 JY |
1 | /** @file\r |
2 | This library is used by other modules to send TPM12 command.\r | |
3 | \r | |
e7c83012 | 4 | Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved. <BR>\r |
c1d93242 JY |
5 | This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _TPM12_COMMAND_LIB_H_\r | |
16 | #define _TPM12_COMMAND_LIB_H_\r | |
17 | \r | |
18 | #include <IndustryStandard/Tpm12.h>\r | |
19 | \r | |
20 | /**\r | |
21 | Send Startup command to TPM1.2.\r | |
22 | \r | |
23 | @param TpmSt Startup Type.\r | |
24 | \r | |
25 | @retval EFI_SUCCESS Operation completed successfully.\r | |
26 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
27 | **/\r | |
28 | EFI_STATUS\r | |
29 | EFIAPI\r | |
30 | Tpm12Startup (\r | |
31 | IN TPM_STARTUP_TYPE TpmSt\r | |
32 | );\r | |
33 | \r | |
9318b08e JY |
34 | /**\r |
35 | Send SaveState command to TPM1.2.\r | |
36 | \r | |
37 | @retval EFI_SUCCESS Operation completed successfully.\r | |
38 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
39 | **/\r | |
40 | EFI_STATUS\r | |
41 | EFIAPI\r | |
42 | Tpm12SaveState (\r | |
43 | VOID\r | |
44 | );\r | |
45 | \r | |
c1d93242 JY |
46 | /**\r |
47 | Send ForceClear command to TPM1.2.\r | |
48 | \r | |
49 | @retval EFI_SUCCESS Operation completed successfully.\r | |
50 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
51 | **/\r | |
52 | EFI_STATUS\r | |
53 | EFIAPI\r | |
54 | Tpm12ForceClear (\r | |
55 | VOID\r | |
56 | );\r | |
57 | \r | |
92ca0c67 JY |
58 | #pragma pack(1)\r |
59 | \r | |
60 | typedef struct {\r | |
61 | UINT16 sizeOfSelect;\r | |
62 | UINT8 pcrSelect[3];\r | |
63 | } TPM12_PCR_SELECTION;\r | |
64 | \r | |
65 | typedef struct {\r | |
66 | TPM12_PCR_SELECTION pcrSelection;\r | |
67 | TPM_LOCALITY_SELECTION localityAtRelease;\r | |
68 | TPM_COMPOSITE_HASH digestAtRelease;\r | |
69 | } TPM12_PCR_INFO_SHORT;\r | |
70 | \r | |
71 | typedef struct {\r | |
72 | TPM_STRUCTURE_TAG tag;\r | |
73 | TPM_NV_INDEX nvIndex;\r | |
74 | TPM12_PCR_INFO_SHORT pcrInfoRead;\r | |
75 | TPM12_PCR_INFO_SHORT pcrInfoWrite;\r | |
76 | TPM_NV_ATTRIBUTES permission;\r | |
77 | BOOLEAN bReadSTClear;\r | |
78 | BOOLEAN bWriteSTClear;\r | |
79 | BOOLEAN bWriteDefine;\r | |
80 | UINT32 dataSize;\r | |
81 | } TPM12_NV_DATA_PUBLIC;\r | |
82 | \r | |
83 | #pragma pack()\r | |
84 | \r | |
85 | /**\r | |
86 | Send NV DefineSpace command to TPM1.2.\r | |
87 | \r | |
88 | @param PubInfo The public parameters of the NV area.\r | |
89 | @param EncAuth The encrypted AuthData, only valid if the attributes require subsequent authorization.\r | |
90 | \r | |
91 | @retval EFI_SUCCESS Operation completed successfully.\r | |
92 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
93 | **/\r | |
94 | EFI_STATUS\r | |
95 | EFIAPI\r | |
96 | Tpm12NvDefineSpace (\r | |
97 | IN TPM12_NV_DATA_PUBLIC *PubInfo,\r | |
98 | IN TPM_ENCAUTH *EncAuth\r | |
99 | );\r | |
100 | \r | |
101 | /**\r | |
102 | Send NV ReadValue command to TPM1.2.\r | |
103 | \r | |
104 | @param NvIndex The index of the area to set.\r | |
105 | @param Offset The offset into the area.\r | |
106 | @param DataSize The size of the data area.\r | |
107 | @param Data The data to set the area to.\r | |
108 | \r | |
109 | @retval EFI_SUCCESS Operation completed successfully.\r | |
110 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
111 | **/\r | |
112 | EFI_STATUS\r | |
113 | EFIAPI\r | |
114 | Tpm12NvReadValue (\r | |
115 | IN TPM_NV_INDEX NvIndex,\r | |
116 | IN UINT32 Offset,\r | |
117 | IN OUT UINT32 *DataSize,\r | |
118 | OUT UINT8 *Data\r | |
119 | );\r | |
120 | \r | |
121 | /**\r | |
122 | Send NV WriteValue command to TPM1.2.\r | |
123 | \r | |
124 | @param NvIndex The index of the area to set.\r | |
125 | @param Offset The offset into the NV Area.\r | |
126 | @param DataSize The size of the data parameter.\r | |
127 | @param Data The data to set the area to.\r | |
128 | \r | |
129 | @retval EFI_SUCCESS Operation completed successfully.\r | |
130 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
131 | **/\r | |
132 | EFI_STATUS\r | |
133 | EFIAPI\r | |
134 | Tpm12NvWriteValue (\r | |
135 | IN TPM_NV_INDEX NvIndex,\r | |
136 | IN UINT32 Offset,\r | |
137 | IN UINT32 DataSize,\r | |
138 | IN UINT8 *Data\r | |
139 | );\r | |
140 | \r | |
e7c83012 MK |
141 | /**\r |
142 | Extend a TPM PCR.\r | |
143 | \r | |
144 | @param[in] DigestToExtend The 160 bit value representing the event to be recorded.\r | |
145 | @param[in] PcrIndex The PCR to be updated.\r | |
146 | @param[out] NewPcrValue New PCR value after extend.\r | |
147 | \r | |
148 | @retval EFI_SUCCESS Operation completed successfully.\r | |
149 | @retval EFI_TIMEOUT The register can't run into the expected status in time.\r | |
150 | @retval EFI_BUFFER_TOO_SMALL Response data buffer is too small.\r | |
151 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
152 | \r | |
153 | **/\r | |
154 | EFI_STATUS\r | |
155 | EFIAPI\r | |
156 | Tpm12Extend (\r | |
157 | IN TPM_DIGEST *DigestToExtend,\r | |
158 | IN TPM_PCRINDEX PcrIndex,\r | |
159 | OUT TPM_DIGEST *NewPcrValue\r | |
160 | );\r | |
161 | \r | |
162 | /**\r | |
163 | Send TSC_PhysicalPresence command to TPM.\r | |
164 | \r | |
165 | @param[in] PhysicalPresence The state to set the TPMs Physical Presence flags.\r | |
166 | \r | |
167 | @retval EFI_SUCCESS Operation completed successfully.\r | |
168 | @retval EFI_TIMEOUT The register can't run into the expected status in time.\r | |
169 | @retval EFI_BUFFER_TOO_SMALL Response data buffer is too small.\r | |
170 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
171 | \r | |
172 | **/\r | |
173 | EFI_STATUS\r | |
174 | EFIAPI\r | |
175 | Tpm12PhysicalPresence (\r | |
176 | IN TPM_PHYSICAL_PRESENCE PhysicalPresence\r | |
177 | );\r | |
178 | \r | |
179 | /**\r | |
180 | Send TPM_ContinueSelfTest command to TPM.\r | |
181 | \r | |
182 | @retval EFI_SUCCESS Operation completed successfully.\r | |
183 | @retval EFI_TIMEOUT The register can't run into the expected status in time.\r | |
184 | @retval EFI_BUFFER_TOO_SMALL Response data buffer is too small.\r | |
185 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
186 | \r | |
187 | **/\r | |
188 | EFI_STATUS\r | |
189 | EFIAPI\r | |
190 | Tpm12ContinueSelfTest (\r | |
191 | VOID\r | |
192 | );\r | |
193 | \r | |
194 | /**\r | |
195 | Get TPM capability permanent flags.\r | |
196 | \r | |
197 | @param[out] TpmPermanentFlags Pointer to the buffer for returned flag structure.\r | |
198 | \r | |
199 | @retval EFI_SUCCESS Operation completed successfully.\r | |
200 | @retval EFI_TIMEOUT The register can't run into the expected status in time.\r | |
201 | @retval EFI_BUFFER_TOO_SMALL Response data buffer is too small.\r | |
202 | @retval EFI_DEVICE_ERROR Unexpected device behavior.\r | |
203 | \r | |
204 | **/\r | |
205 | EFI_STATUS\r | |
206 | EFIAPI\r | |
207 | Tpm12GetCapabilityFlagPermanent (\r | |
208 | OUT TPM_PERMANENT_FLAGS *TpmPermanentFlags\r | |
209 | );\r | |
210 | \r | |
211 | /**\r | |
212 | Get TPM capability volatile flags.\r | |
213 | \r | |
214 | @param[out] VolatileFlags Pointer to the buffer for returned flag structure.\r | |
215 | \r | |
216 | @retval EFI_SUCCESS Operation completed successfully.\r | |
217 | @retval EFI_DEVICE_ERROR The command was unsuccessful.\r | |
218 | \r | |
219 | **/\r | |
220 | EFI_STATUS\r | |
221 | EFIAPI\r | |
222 | Tpm12GetCapabilityFlagVolatile (\r | |
223 | OUT TPM_STCLEAR_FLAGS *VolatileFlags\r | |
224 | );\r | |
c1d93242 | 225 | #endif\r |