SecurityPkg: Tpm2DeviceLib: Enable CapCRBIdleBypass support
[mirror_edk2.git] / SecurityPkg / Library / Tpm2DeviceLibDTpm / Tpm2InstanceLibDTpm.c
1 /** @file
2 This library is TPM2 DTPM instance.
3 It can be registered to Tpm2 Device router, to be active TPM2 engine,
4 based on platform setting.
5
6 Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved. <BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 **/
16
17 #include <Library/BaseLib.h>
18 #include <Library/BaseMemoryLib.h>
19 #include <Library/DebugLib.h>
20 #include <Library/Tpm2DeviceLib.h>
21 #include <Library/PcdLib.h>
22
23 #include <Guid/TpmInstance.h>
24
25 /**
26 Return PTP interface type.
27
28 @param[in] Register Pointer to PTP register.
29
30 @return PTP interface type.
31 **/
32 TPM2_PTP_INTERFACE_TYPE
33 Tpm2GetPtpInterface (
34 IN VOID *Register
35 );
36
37 /**
38 Return PTP CRB interface IdleByPass state.
39
40 @param[in] Register Pointer to PTP register.
41
42 @return PTP CRB interface IdleByPass state.
43 **/
44 UINT8
45 Tpm2GetIdleByPass (
46 IN VOID *Register
47 );
48
49 /**
50 Dump PTP register information.
51
52 @param[in] Register Pointer to PTP register.
53 **/
54 VOID
55 DumpPtpInfo (
56 IN VOID *Register
57 );
58
59 /**
60 This service enables the sending of commands to the TPM2.
61
62 @param[in] InputParameterBlockSize Size of the TPM2 input parameter block.
63 @param[in] InputParameterBlock Pointer to the TPM2 input parameter block.
64 @param[in,out] OutputParameterBlockSize Size of the TPM2 output parameter block.
65 @param[in] OutputParameterBlock Pointer to the TPM2 output parameter block.
66
67 @retval EFI_SUCCESS The command byte stream was successfully sent to the device and a response was successfully received.
68 @retval EFI_DEVICE_ERROR The command was not successfully sent to the device or a response was not successfully received from the device.
69 @retval EFI_BUFFER_TOO_SMALL The output parameter block is too small.
70 **/
71 EFI_STATUS
72 EFIAPI
73 DTpm2SubmitCommand (
74 IN UINT32 InputParameterBlockSize,
75 IN UINT8 *InputParameterBlock,
76 IN OUT UINT32 *OutputParameterBlockSize,
77 IN UINT8 *OutputParameterBlock
78 );
79
80 /**
81 This service requests use TPM2.
82
83 @retval EFI_SUCCESS Get the control of TPM2 chip.
84 @retval EFI_NOT_FOUND TPM2 not found.
85 @retval EFI_DEVICE_ERROR Unexpected device behavior.
86 **/
87 EFI_STATUS
88 EFIAPI
89 DTpm2RequestUseTpm (
90 VOID
91 );
92
93 TPM2_DEVICE_INTERFACE mDTpm2InternalTpm2Device = {
94 TPM_DEVICE_INTERFACE_TPM20_DTPM,
95 DTpm2SubmitCommand,
96 DTpm2RequestUseTpm,
97 };
98
99 /**
100 The function register DTPM2.0 instance and caches current active TPM interface type.
101
102 @retval EFI_SUCCESS DTPM2.0 instance is registered, or system dose not surpport registr DTPM2.0 instance
103 **/
104 EFI_STATUS
105 EFIAPI
106 Tpm2InstanceLibDTpmConstructor (
107 VOID
108 )
109 {
110 EFI_STATUS Status;
111 TPM2_PTP_INTERFACE_TYPE PtpInterface;
112 UINT8 IdleByPass;
113
114 Status = Tpm2RegisterTpm2DeviceLib (&mDTpm2InternalTpm2Device);
115 if ((Status == EFI_SUCCESS) || (Status == EFI_UNSUPPORTED)) {
116 //
117 // Unsupported means platform policy does not need this instance enabled.
118 //
119 if (Status == EFI_SUCCESS) {
120 //
121 // Cache current active TpmInterfaceType only when needed
122 //
123 if (PcdGet8(PcdActiveTpmInterfaceType) == 0xFF) {
124 PtpInterface = Tpm2GetPtpInterface ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));
125 PcdSet8S(PcdActiveTpmInterfaceType, PtpInterface);
126 }
127
128 if (PcdGet8(PcdActiveTpmInterfaceType) == PtpInterfaceCrb && PcdGet8(PcdCRBIdleByPass) == 0xFF) {
129 IdleByPass = Tpm2GetIdleByPass((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));
130 PcdSet8S(PcdCRBIdleByPass, IdleByPass);
131 }
132
133 DumpPtpInfo ((VOID *) (UINTN) PcdGet64 (PcdTpmBaseAddress));
134 }
135 return EFI_SUCCESS;
136 }
137 return Status;
138 }