2 It updates TPM items in ACPI table and registers SMI callback
3 functions for physical presence and ClearMemory.
5 Caution: This module requires additional review when modified.
6 This driver will have external input - variable and ACPINvs data in SMM mode.
7 This external input must be validated carefully to avoid security issue.
9 PhysicalPresenceCallback() and MemoryClearCallback() will receive untrusted input and do some check.
11 Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>
12 This program and the accompanying materials
13 are licensed and made available under the terms and conditions of the BSD License
14 which accompanies this distribution. The full text of the license may be found at
15 http://opensource.org/licenses/bsd-license.php
17 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
18 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
24 EFI_SMM_VARIABLE_PROTOCOL
*mSmmVariable
;
28 Software SMI callback for TPM physical presence which is called from ACPI method.
30 Caution: This function may receive untrusted input.
31 Variable and ACPINvs are external input, so this function will validate
32 its data structure to be valid value.
34 @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
35 @param[in] Context Points to an optional handler context which was specified when the
36 handler was registered.
37 @param[in, out] CommBuffer A pointer to a collection of data in memory that will
38 be conveyed from a non-SMM environment into an SMM environment.
39 @param[in, out] CommBufferSize The size of the CommBuffer.
41 @retval EFI_SUCCESS The interrupt was handled successfully.
46 PhysicalPresenceCallback (
47 IN EFI_HANDLE DispatchHandle
,
48 IN CONST VOID
*Context
,
49 IN OUT VOID
*CommBuffer
,
50 IN OUT UINTN
*CommBufferSize
55 EFI_PHYSICAL_PRESENCE PpData
;
56 EFI_PHYSICAL_PRESENCE_FLAGS Flags
;
57 BOOLEAN RequestConfirmed
;
60 // Get the Physical Presence variable
62 DataSize
= sizeof (EFI_PHYSICAL_PRESENCE
);
63 Status
= mSmmVariable
->SmmGetVariable (
64 PHYSICAL_PRESENCE_VARIABLE
,
65 &gEfiPhysicalPresenceGuid
,
71 DEBUG ((EFI_D_INFO
, "[TPM] PP callback, Parameter = %x\n", mTcgNvs
->PhysicalPresence
.Parameter
));
72 if (mTcgNvs
->PhysicalPresence
.Parameter
== ACPI_FUNCTION_RETURN_REQUEST_RESPONSE_TO_OS
) {
73 if (EFI_ERROR (Status
)) {
74 mTcgNvs
->PhysicalPresence
.ReturnCode
= PP_RETURN_TPM_OPERATION_RESPONSE_FAILURE
;
75 mTcgNvs
->PhysicalPresence
.LastRequest
= 0;
76 mTcgNvs
->PhysicalPresence
.Response
= 0;
77 DEBUG ((EFI_D_ERROR
, "[TPM] Get PP variable failure! Status = %r\n", Status
));
80 mTcgNvs
->PhysicalPresence
.ReturnCode
= PP_RETURN_TPM_OPERATION_RESPONSE_SUCCESS
;
81 mTcgNvs
->PhysicalPresence
.LastRequest
= PpData
.LastPPRequest
;
82 mTcgNvs
->PhysicalPresence
.Response
= PpData
.PPResponse
;
83 } else if ((mTcgNvs
->PhysicalPresence
.Parameter
== ACPI_FUNCTION_SUBMIT_REQUEST_TO_BIOS
)
84 || (mTcgNvs
->PhysicalPresence
.Parameter
== ACPI_FUNCTION_SUBMIT_REQUEST_TO_BIOS_2
)) {
85 if (EFI_ERROR (Status
)) {
86 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE
;
87 DEBUG ((EFI_D_ERROR
, "[TPM] Get PP variable failure! Status = %r\n", Status
));
90 if (mTcgNvs
->PhysicalPresence
.Request
== PHYSICAL_PRESENCE_SET_OPERATOR_AUTH
) {
92 // This command requires UI to prompt user for Auth data.
94 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED
;
98 if (PpData
.PPRequest
!= mTcgNvs
->PhysicalPresence
.Request
) {
99 PpData
.PPRequest
= (UINT8
) mTcgNvs
->PhysicalPresence
.Request
;
100 DataSize
= sizeof (EFI_PHYSICAL_PRESENCE
);
101 Status
= mSmmVariable
->SmmSetVariable (
102 PHYSICAL_PRESENCE_VARIABLE
,
103 &gEfiPhysicalPresenceGuid
,
104 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
110 if (EFI_ERROR (Status
)) {
111 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_SUBMIT_REQUEST_TO_PREOS_GENERAL_FAILURE
;
114 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS
;
116 if (mTcgNvs
->PhysicalPresence
.Request
>= TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION
) {
117 DataSize
= sizeof (EFI_PHYSICAL_PRESENCE_FLAGS
);
118 Status
= mSmmVariable
->SmmGetVariable (
119 PHYSICAL_PRESENCE_FLAGS_VARIABLE
,
120 &gEfiPhysicalPresenceGuid
,
125 if (EFI_ERROR (Status
)) {
126 Flags
.PPFlags
= TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_PROVISION
;
128 mTcgNvs
->PhysicalPresence
.ReturnCode
= TcgPpVendorLibSubmitRequestToPreOSFunction (mTcgNvs
->PhysicalPresence
.Request
, Flags
.PPFlags
);
130 } else if (mTcgNvs
->PhysicalPresence
.Parameter
== ACPI_FUNCTION_GET_USER_CONFIRMATION_STATUS_FOR_REQUEST
) {
131 if (EFI_ERROR (Status
)) {
132 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_GET_USER_CONFIRMATION_BLOCKED_BY_BIOS_CONFIGURATION
;
133 DEBUG ((EFI_D_ERROR
, "[TPM] Get PP variable failure! Status = %r\n", Status
));
137 // Get the Physical Presence flags
139 DataSize
= sizeof (EFI_PHYSICAL_PRESENCE_FLAGS
);
140 Status
= mSmmVariable
->SmmGetVariable (
141 PHYSICAL_PRESENCE_FLAGS_VARIABLE
,
142 &gEfiPhysicalPresenceGuid
,
147 if (EFI_ERROR (Status
)) {
148 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_GET_USER_CONFIRMATION_BLOCKED_BY_BIOS_CONFIGURATION
;
149 DEBUG ((EFI_D_ERROR
, "[TPM] Get PP flags failure! Status = %r\n", Status
));
153 RequestConfirmed
= FALSE
;
155 switch (mTcgNvs
->PhysicalPresence
.Request
) {
156 case PHYSICAL_PRESENCE_ENABLE
:
157 case PHYSICAL_PRESENCE_DISABLE
:
158 case PHYSICAL_PRESENCE_ACTIVATE
:
159 case PHYSICAL_PRESENCE_DEACTIVATE
:
160 case PHYSICAL_PRESENCE_ENABLE_ACTIVATE
:
161 case PHYSICAL_PRESENCE_DEACTIVATE_DISABLE
:
162 case PHYSICAL_PRESENCE_SET_OWNER_INSTALL_TRUE
:
163 case PHYSICAL_PRESENCE_SET_OWNER_INSTALL_FALSE
:
164 case PHYSICAL_PRESENCE_ENABLE_ACTIVATE_OWNER_TRUE
:
165 case PHYSICAL_PRESENCE_DEACTIVATE_DISABLE_OWNER_FALSE
:
166 if ((Flags
.PPFlags
& TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_PROVISION
) != 0) {
167 RequestConfirmed
= TRUE
;
171 case PHYSICAL_PRESENCE_CLEAR
:
172 case PHYSICAL_PRESENCE_ENABLE_ACTIVATE_CLEAR
:
173 if ((Flags
.PPFlags
& TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_CLEAR
) != 0) {
174 RequestConfirmed
= TRUE
;
178 case PHYSICAL_PRESENCE_DEFERRED_PP_UNOWNERED_FIELD_UPGRADE
:
179 if ((Flags
.PPFlags
& TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_MAINTENANCE
) != 0) {
180 RequestConfirmed
= TRUE
;
184 case PHYSICAL_PRESENCE_ENABLE_ACTIVATE_CLEAR_ENABLE_ACTIVATE
:
185 case PHYSICAL_PRESENCE_CLEAR_ENABLE_ACTIVATE
:
186 if ((Flags
.PPFlags
& TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_CLEAR
) != 0 && (Flags
.PPFlags
& TCG_BIOS_TPM_MANAGEMENT_FLAG_NO_PPI_PROVISION
) != 0) {
187 RequestConfirmed
= TRUE
;
191 case PHYSICAL_PRESENCE_SET_NO_PPI_PROVISION_FALSE
:
192 case PHYSICAL_PRESENCE_SET_NO_PPI_CLEAR_FALSE
:
193 case PHYSICAL_PRESENCE_SET_NO_PPI_MAINTENANCE_FALSE
:
194 case PHYSICAL_PRESENCE_NO_ACTION
:
195 RequestConfirmed
= TRUE
;
198 case PHYSICAL_PRESENCE_SET_OPERATOR_AUTH
:
200 // This command requires UI to prompt user for Auth data
202 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_GET_USER_CONFIRMATION_NOT_IMPLEMENTED
;
208 if (RequestConfirmed
) {
209 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_NOT_REQUIRED
;
211 mTcgNvs
->PhysicalPresence
.ReturnCode
= TCG_PP_GET_USER_CONFIRMATION_ALLOWED_AND_PPUSER_REQUIRED
;
213 if (mTcgNvs
->PhysicalPresence
.Request
>= TCG_PHYSICAL_PRESENCE_VENDOR_SPECIFIC_OPERATION
) {
214 mTcgNvs
->PhysicalPresence
.ReturnCode
= TcgPpVendorLibGetUserConfirmationStatusFunction (mTcgNvs
->PhysicalPresence
.Request
, Flags
.PPFlags
);
223 Software SMI callback for MemoryClear which is called from ACPI method.
225 Caution: This function may receive untrusted input.
226 Variable and ACPINvs are external input, so this function will validate
227 its data structure to be valid value.
229 @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
230 @param[in] Context Points to an optional handler context which was specified when the
231 handler was registered.
232 @param[in, out] CommBuffer A pointer to a collection of data in memory that will
233 be conveyed from a non-SMM environment into an SMM environment.
234 @param[in, out] CommBufferSize The size of the CommBuffer.
236 @retval EFI_SUCCESS The interrupt was handled successfully.
241 MemoryClearCallback (
242 IN EFI_HANDLE DispatchHandle
,
243 IN CONST VOID
*Context
,
244 IN OUT VOID
*CommBuffer
,
245 IN OUT UINTN
*CommBufferSize
252 mTcgNvs
->MemoryClear
.ReturnCode
= MOR_REQUEST_SUCCESS
;
253 if (mTcgNvs
->MemoryClear
.Parameter
== ACPI_FUNCTION_DSM_MEMORY_CLEAR_INTERFACE
) {
254 MorControl
= (UINT8
) mTcgNvs
->MemoryClear
.Request
;
255 } else if (mTcgNvs
->MemoryClear
.Parameter
== ACPI_FUNCTION_PTS_CLEAR_MOR_BIT
) {
256 DataSize
= sizeof (UINT8
);
257 Status
= mSmmVariable
->SmmGetVariable (
258 MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME
,
259 &gEfiMemoryOverwriteControlDataGuid
,
264 if (EFI_ERROR (Status
)) {
265 mTcgNvs
->MemoryClear
.ReturnCode
= MOR_REQUEST_GENERAL_FAILURE
;
266 DEBUG ((EFI_D_ERROR
, "[TPM] Get MOR variable failure! Status = %r\n", Status
));
270 if (MOR_CLEAR_MEMORY_VALUE (MorControl
) == 0x0) {
273 MorControl
&= ~MOR_CLEAR_MEMORY_BIT_MASK
;
276 DataSize
= sizeof (UINT8
);
277 Status
= mSmmVariable
->SmmSetVariable (
278 MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME
,
279 &gEfiMemoryOverwriteControlDataGuid
,
280 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
284 if (EFI_ERROR (Status
)) {
285 mTcgNvs
->MemoryClear
.ReturnCode
= MOR_REQUEST_GENERAL_FAILURE
;
286 DEBUG ((EFI_D_ERROR
, "[TPM] Set MOR variable failure! Status = %r\n", Status
));
293 Find the operation region in TCG ACPI table by given Name and Size,
294 and initialize it if the region is found.
296 @param[in, out] Table The TPM item in ACPI table.
297 @param[in] Name The name string to find in TPM table.
298 @param[in] Size The size of the region to find.
300 @return The allocated address for the found region.
305 EFI_ACPI_DESCRIPTION_HEADER
*Table
,
311 AML_OP_REGION_32_8
*OpRegion
;
312 EFI_PHYSICAL_ADDRESS MemoryAddress
;
314 MemoryAddress
= SIZE_4GB
- 1;
317 // Patch some pointers for the ASL code before loading the SSDT.
319 for (OpRegion
= (AML_OP_REGION_32_8
*) (Table
+ 1);
320 OpRegion
<= (AML_OP_REGION_32_8
*) ((UINT8
*) Table
+ Table
->Length
);
321 OpRegion
= (AML_OP_REGION_32_8
*) ((UINT8
*) OpRegion
+ 1)) {
322 if ((OpRegion
->OpRegionOp
== AML_EXT_REGION_OP
) &&
323 (OpRegion
->NameString
== Name
) &&
324 (OpRegion
->DWordPrefix
== AML_DWORD_PREFIX
) &&
325 (OpRegion
->BytePrefix
== AML_BYTE_PREFIX
)) {
327 Status
= gBS
->AllocatePages(AllocateMaxAddress
, EfiACPIMemoryNVS
, EFI_SIZE_TO_PAGES (Size
), &MemoryAddress
);
328 ASSERT_EFI_ERROR (Status
);
329 ZeroMem ((VOID
*)(UINTN
)MemoryAddress
, Size
);
330 OpRegion
->RegionOffset
= (UINT32
) (UINTN
) MemoryAddress
;
331 OpRegion
->RegionLen
= (UINT8
) Size
;
336 return (VOID
*) (UINTN
) MemoryAddress
;
340 Initialize and publish TPM items in ACPI table.
342 @retval EFI_SUCCESS The TCG ACPI table is published successfully.
343 @retval Others The TCG ACPI table is not published.
352 EFI_ACPI_TABLE_PROTOCOL
*AcpiTable
;
354 EFI_ACPI_DESCRIPTION_HEADER
*Table
;
357 Status
= GetSectionFromFv (
364 ASSERT_EFI_ERROR (Status
);
368 // Measure to PCR[0] with event EV_POST_CODE ACPI DATA
370 TpmMeasureAndLogData(
373 EV_POSTCODE_INFO_ACPI_DATA
,
380 ASSERT (Table
->OemTableId
== SIGNATURE_64 ('T', 'c', 'g', 'T', 'a', 'b', 'l', 'e'));
381 CopyMem (Table
->OemId
, PcdGetPtr (PcdAcpiDefaultOemId
), sizeof (Table
->OemId
) );
382 mTcgNvs
= AssignOpRegion (Table
, SIGNATURE_32 ('T', 'N', 'V', 'S'), (UINT16
) sizeof (TCG_NVS
));
383 ASSERT (mTcgNvs
!= NULL
);
386 // Publish the TPM ACPI table
388 Status
= gBS
->LocateProtocol (&gEfiAcpiTableProtocolGuid
, NULL
, (VOID
**) &AcpiTable
);
389 ASSERT_EFI_ERROR (Status
);
392 Status
= AcpiTable
->InstallAcpiTable (
398 ASSERT_EFI_ERROR (Status
);
404 The driver's entry point.
406 It install callbacks for TPM physical presence and MemoryClear, and locate
407 SMM variable to be used in the callback function.
409 @param[in] ImageHandle The firmware allocated handle for the EFI image.
410 @param[in] SystemTable A pointer to the EFI System Table.
412 @retval EFI_SUCCESS The entry point is executed successfully.
413 @retval Others Some error occurs when executing this entry point.
419 IN EFI_HANDLE ImageHandle
,
420 IN EFI_SYSTEM_TABLE
*SystemTable
424 EFI_SMM_SW_DISPATCH2_PROTOCOL
*SwDispatch
;
425 EFI_SMM_SW_REGISTER_CONTEXT SwContext
;
428 if (!CompareGuid (PcdGetPtr(PcdTpmInstanceGuid
), &gEfiTpmDeviceInstanceTpm12Guid
)){
429 DEBUG ((EFI_D_ERROR
, "No TPM12 instance required!\n"));
430 return EFI_UNSUPPORTED
;
433 Status
= PublishAcpiTable ();
434 ASSERT_EFI_ERROR (Status
);
437 // Get the Sw dispatch protocol and register SMI callback functions.
439 Status
= gSmst
->SmmLocateProtocol (&gEfiSmmSwDispatch2ProtocolGuid
, NULL
, (VOID
**)&SwDispatch
);
440 ASSERT_EFI_ERROR (Status
);
441 SwContext
.SwSmiInputValue
= (UINTN
) -1;
442 Status
= SwDispatch
->Register (SwDispatch
, PhysicalPresenceCallback
, &SwContext
, &SwHandle
);
443 ASSERT_EFI_ERROR (Status
);
444 if (EFI_ERROR (Status
)) {
447 mTcgNvs
->PhysicalPresence
.SoftwareSmi
= (UINT8
) SwContext
.SwSmiInputValue
;
449 SwContext
.SwSmiInputValue
= (UINTN
) -1;
450 Status
= SwDispatch
->Register (SwDispatch
, MemoryClearCallback
, &SwContext
, &SwHandle
);
451 ASSERT_EFI_ERROR (Status
);
452 if (EFI_ERROR (Status
)) {
455 mTcgNvs
->MemoryClear
.SoftwareSmi
= (UINT8
) SwContext
.SwSmiInputValue
;
458 // Locate SmmVariableProtocol.
460 Status
= gSmst
->SmmLocateProtocol (&gEfiSmmVariableProtocolGuid
, NULL
, (VOID
**)&mSmmVariable
);
461 ASSERT_EFI_ERROR (Status
);