SecurityPkg Tpm2DeviceLibDTpm: Update enum type name to match the one in lib
[mirror_edk2.git] / SecurityPkg / Library / Tpm2DeviceLibDTpm / Tpm2DeviceLibDTpm.c
CommitLineData
c1d93242 1/** @file\r
07309c3d 2 This library is TPM2 DTPM device lib.\r
c1d93242
JY
3 Choosing this library means platform uses and only uses DTPM device as TPM2 engine.\r
4\r
f15cb995 5Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved. <BR>\r
c1d93242
JY
6This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#include <Library/BaseLib.h>\r
17#include <Library/BaseMemoryLib.h>\r
18#include <Library/DebugLib.h>\r
19#include <Library/Tpm2DeviceLib.h>\r
f15cb995
ZC
20#include <Library/PcdLib.h>\r
21\r
22/**\r
23 Return PTP interface type.\r
24\r
25 @param[in] Register Pointer to PTP register.\r
26\r
27 @return PTP interface type.\r
28**/\r
29TPM2_PTP_INTERFACE_TYPE\r
30Tpm2GetPtpInterface (\r
31 IN VOID *Register\r
32 );\r
c1d93242 33\r
63197670
ZC
34/**\r
35 Return PTP CRB interface IdleByPass state.\r
36\r
37 @param[in] Register Pointer to PTP register.\r
38\r
39 @return PTP CRB interface IdleByPass state.\r
40**/\r
41UINT8\r
42Tpm2GetIdleByPass (\r
43 IN VOID *Register\r
44 );\r
45\r
c1d93242
JY
46/**\r
47 This service enables the sending of commands to the TPM2.\r
48\r
49 @param[in] InputParameterBlockSize Size of the TPM2 input parameter block.\r
50 @param[in] InputParameterBlock Pointer to the TPM2 input parameter block.\r
51 @param[in,out] OutputParameterBlockSize Size of the TPM2 output parameter block.\r
52 @param[in] OutputParameterBlock Pointer to the TPM2 output parameter block.\r
53\r
54 @retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.\r
55 @retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.\r
56 @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small. \r
57**/\r
58EFI_STATUS\r
59EFIAPI\r
60DTpm2SubmitCommand (\r
61 IN UINT32 InputParameterBlockSize,\r
62 IN UINT8 *InputParameterBlock,\r
63 IN OUT UINT32 *OutputParameterBlockSize,\r
64 IN UINT8 *OutputParameterBlock\r
65 );\r
66\r
67/**\r
68 This service requests use TPM2.\r
69\r
70 @retval EFI_SUCCESS Get the control of TPM2 chip.\r
71 @retval EFI_NOT_FOUND TPM2 not found.\r
72 @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
73**/\r
74EFI_STATUS\r
75EFIAPI\r
76DTpm2RequestUseTpm (\r
77 VOID\r
78 );\r
79\r
80/**\r
81 This service enables the sending of commands to the TPM2.\r
82\r
83 @param[in] InputParameterBlockSize Size of the TPM2 input parameter block.\r
84 @param[in] InputParameterBlock Pointer to the TPM2 input parameter block.\r
85 @param[in,out] OutputParameterBlockSize Size of the TPM2 output parameter block.\r
86 @param[in] OutputParameterBlock Pointer to the TPM2 output parameter block.\r
87\r
88 @retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.\r
89 @retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.\r
90 @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small. \r
91**/\r
92EFI_STATUS\r
93EFIAPI\r
94Tpm2SubmitCommand (\r
95 IN UINT32 InputParameterBlockSize,\r
96 IN UINT8 *InputParameterBlock,\r
97 IN OUT UINT32 *OutputParameterBlockSize,\r
98 IN UINT8 *OutputParameterBlock\r
99 )\r
100{\r
101 return DTpm2SubmitCommand (\r
102 InputParameterBlockSize,\r
103 InputParameterBlock,\r
104 OutputParameterBlockSize,\r
105 OutputParameterBlock\r
106 );\r
107}\r
108\r
109/**\r
110 This service requests use TPM2.\r
111\r
112 @retval EFI_SUCCESS Get the control of TPM2 chip.\r
113 @retval EFI_NOT_FOUND TPM2 not found.\r
114 @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
115**/\r
116EFI_STATUS\r
117EFIAPI\r
118Tpm2RequestUseTpm (\r
119 VOID\r
120 )\r
121{\r
122 return DTpm2RequestUseTpm ();\r
123}\r
124\r
125/**\r
126 This service register TPM2 device.\r
127\r
128 @param Tpm2Device TPM2 device\r
129\r
130 @retval EFI_SUCCESS This TPM2 device is registered successfully.\r
131 @retval EFI_UNSUPPORTED System does not support register this TPM2 device.\r
132 @retval EFI_ALREADY_STARTED System already register this TPM2 device.\r
133**/\r
134EFI_STATUS\r
135EFIAPI\r
136Tpm2RegisterTpm2DeviceLib (\r
137 IN TPM2_DEVICE_INTERFACE *Tpm2Device\r
138 )\r
139{\r
140 return EFI_UNSUPPORTED;\r
141}\r
f15cb995
ZC
142\r
143/**\r
144 The function caches current active TPM interface type.\r
145 \r
146 @retval EFI_SUCCESS DTPM2.0 instance is registered, or system dose not surpport registr DTPM2.0 instance\r
147**/\r
148EFI_STATUS\r
149EFIAPI\r
150Tpm2DeviceLibConstructor (\r
151 VOID\r
152 )\r
153{\r
154 TPM2_PTP_INTERFACE_TYPE PtpInterface;\r
63197670 155 UINT8 IdleByPass;\r
f15cb995
ZC
156\r
157 //\r
158 // Cache current active TpmInterfaceType only when needed\r
159 //\r
160 if (PcdGet8(PcdActiveTpmInterfaceType) == 0xFF) {\r
161 PtpInterface = Tpm2GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
162 PcdSet8S(PcdActiveTpmInterfaceType, PtpInterface);\r
163 }\r
63197670 164\r
975478f6 165 if (PcdGet8(PcdActiveTpmInterfaceType) == Tpm2PtpInterfaceCrb && PcdGet8(PcdCRBIdleByPass) == 0xFF) {\r
63197670
ZC
166 IdleByPass = Tpm2GetIdleByPass((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));\r
167 PcdSet8S(PcdCRBIdleByPass, IdleByPass);\r
168 }\r
169\r
f15cb995
ZC
170 return EFI_SUCCESS;\r
171}\r