2 Initialize TPM2 device and measure FVs before handing off control to DXE.
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include <IndustryStandard/UefiTcgPlatform.h>
18 #include <Ppi/FirmwareVolumeInfo.h>
19 #include <Ppi/FirmwareVolumeInfo2.h>
20 #include <Ppi/LockPhysicalPresence.h>
21 #include <Ppi/TpmInitialized.h>
22 #include <Ppi/FirmwareVolume.h>
23 #include <Ppi/EndOfPeiPhase.h>
24 #include <Ppi/FirmwareVolumeInfoMeasurementExcluded.h>
26 #include <Guid/TcgEventHob.h>
27 #include <Guid/MeasuredFvHob.h>
28 #include <Guid/TpmInstance.h>
30 #include <Library/DebugLib.h>
31 #include <Library/BaseMemoryLib.h>
32 #include <Library/PeiServicesLib.h>
33 #include <Library/PeimEntryPoint.h>
34 #include <Library/Tpm2CommandLib.h>
35 #include <Library/Tpm2DeviceLib.h>
36 #include <Library/HashLib.h>
37 #include <Library/HobLib.h>
38 #include <Library/PcdLib.h>
39 #include <Library/PeiServicesTablePointerLib.h>
40 #include <Protocol/Tcg2Protocol.h>
41 #include <Library/PerformanceLib.h>
42 #include <Library/MemoryAllocationLib.h>
43 #include <Library/ReportStatusCodeLib.h>
44 #include <Library/Tcg2PhysicalPresenceLib.h>
46 #define PERF_ID_TCG2_PEI 0x3080
50 EFI_TCG2_EVENT_LOG_FORMAT LogFormat
;
51 } TCG2_EVENT_INFO_STRUCT
;
53 TCG2_EVENT_INFO_STRUCT mTcg2EventInfo
[] = {
54 {&gTcgEventEntryHobGuid
, EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2
},
55 {&gTcgEvent2EntryHobGuid
, EFI_TCG2_EVENT_LOG_FORMAT_TCG_2
},
58 BOOLEAN mImageInMemory
= FALSE
;
59 EFI_PEI_FILE_HANDLE mFileHandle
;
61 EFI_PEI_PPI_DESCRIPTOR mTpmInitializedPpiList
= {
62 EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
,
63 &gPeiTpmInitializedPpiGuid
,
67 EFI_PEI_PPI_DESCRIPTOR mTpmInitializationDonePpiList
= {
68 EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
,
69 &gPeiTpmInitializationDonePpiGuid
,
73 EFI_PLATFORM_FIRMWARE_BLOB
*mMeasuredBaseFvInfo
;
74 UINT32 mMeasuredBaseFvIndex
= 0;
76 EFI_PLATFORM_FIRMWARE_BLOB
*mMeasuredChildFvInfo
;
77 UINT32 mMeasuredChildFvIndex
= 0;
80 Measure and record the Firmware Volum Information once FvInfoPPI install.
82 @param[in] PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
83 @param[in] NotifyDescriptor Address of the notification descriptor data structure.
84 @param[in] Ppi Address of the PPI that was installed.
86 @retval EFI_SUCCESS The FV Info is measured and recorded to TPM.
87 @return Others Fail to measure FV.
92 FirmwareVolmeInfoPpiNotifyCallback (
93 IN EFI_PEI_SERVICES
**PeiServices
,
94 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
99 Record all measured Firmware Volum Information into a Guid Hob
101 @param[in] PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
102 @param[in] NotifyDescriptor Address of the notification descriptor data structure.
103 @param[in] Ppi Address of the PPI that was installed.
105 @retval EFI_SUCCESS The FV Info is measured and recorded to TPM.
106 @return Others Fail to measure FV.
111 EndofPeiSignalNotifyCallBack (
112 IN EFI_PEI_SERVICES
**PeiServices
,
113 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
117 EFI_PEI_NOTIFY_DESCRIPTOR mNotifyList
[] = {
119 EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK
,
120 &gEfiPeiFirmwareVolumeInfoPpiGuid
,
121 FirmwareVolmeInfoPpiNotifyCallback
124 EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK
,
125 &gEfiPeiFirmwareVolumeInfo2PpiGuid
,
126 FirmwareVolmeInfoPpiNotifyCallback
129 (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
130 &gEfiEndOfPeiSignalPpiGuid
,
131 EndofPeiSignalNotifyCallBack
135 EFI_PEI_FIRMWARE_VOLUME_INFO_MEASUREMENT_EXCLUDED_PPI
*mMeasurementExcludedFvPpi
;
138 Record all measured Firmware Volum Information into a Guid Hob
139 Guid Hob payload layout is
141 UINT32 *************************** FIRMWARE_BLOB number
142 EFI_PLATFORM_FIRMWARE_BLOB******** BLOB Array
144 @param[in] PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
145 @param[in] NotifyDescriptor Address of the notification descriptor data structure.
146 @param[in] Ppi Address of the PPI that was installed.
148 @retval EFI_SUCCESS The FV Info is measured and recorded to TPM.
149 @return Others Fail to measure FV.
154 EndofPeiSignalNotifyCallBack (
155 IN EFI_PEI_SERVICES
**PeiServices
,
156 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
160 MEASURED_HOB_DATA
*MeasuredHobData
;
162 MeasuredHobData
= NULL
;
165 // Create a Guid hob to save all measured Fv
167 MeasuredHobData
= BuildGuidHob(
169 sizeof(UINTN
) + sizeof(EFI_PLATFORM_FIRMWARE_BLOB
) * (mMeasuredBaseFvIndex
+ mMeasuredChildFvIndex
)
172 if (MeasuredHobData
!= NULL
){
174 // Save measured FV info enty number
176 MeasuredHobData
->Num
= mMeasuredBaseFvIndex
+ mMeasuredChildFvIndex
;
179 // Save measured base Fv info
181 CopyMem (MeasuredHobData
->MeasuredFvBuf
, mMeasuredBaseFvInfo
, sizeof(EFI_PLATFORM_FIRMWARE_BLOB
) * (mMeasuredBaseFvIndex
));
184 // Save measured child Fv info
186 CopyMem (&MeasuredHobData
->MeasuredFvBuf
[mMeasuredBaseFvIndex
] , mMeasuredChildFvInfo
, sizeof(EFI_PLATFORM_FIRMWARE_BLOB
) * (mMeasuredChildFvIndex
));
193 Get TPML_DIGEST_VALUES data size.
195 @param[in] DigestList TPML_DIGEST_VALUES data.
197 @return TPML_DIGEST_VALUES data size.
201 IN TPML_DIGEST_VALUES
*DigestList
208 TotalSize
= sizeof(DigestList
->count
);
209 for (Index
= 0; Index
< DigestList
->count
; Index
++) {
210 DigestSize
= GetHashSizeFromAlgo (DigestList
->digests
[Index
].hashAlg
);
211 TotalSize
+= sizeof(DigestList
->digests
[Index
].hashAlg
) + DigestSize
;
218 Return if hash alg is supported in TPM PCR bank.
220 @param HashAlg Hash algorithm to be checked.
222 @retval TRUE Hash algorithm is supported.
223 @retval FALSE Hash algorithm is not supported.
226 IsHashAlgSupportedInPcrBank (
227 IN TPMI_ALG_HASH HashAlg
230 UINT32 ActivePcrBanks
;
232 ActivePcrBanks
= PcdGet32 (PcdTpm2HashMask
);
235 if ((ActivePcrBanks
& EFI_TCG2_BOOT_HASH_ALG_SHA1
) != 0) {
240 if ((ActivePcrBanks
& EFI_TCG2_BOOT_HASH_ALG_SHA256
) != 0) {
245 if ((ActivePcrBanks
& EFI_TCG2_BOOT_HASH_ALG_SHA384
) != 0) {
250 if ((ActivePcrBanks
& EFI_TCG2_BOOT_HASH_ALG_SHA512
) != 0) {
254 case TPM_ALG_SM3_256
:
255 if ((ActivePcrBanks
& EFI_TCG2_BOOT_HASH_ALG_SM3_256
) != 0) {
265 Copy TPML_DIGEST_VALUES into a buffer
267 @param[in,out] Buffer Buffer to hold TPML_DIGEST_VALUES.
268 @param[in] DigestList TPML_DIGEST_VALUES to be copied.
270 @return The end of buffer to hold TPML_DIGEST_VALUES.
273 CopyDigestListToBuffer (
275 IN TPML_DIGEST_VALUES
*DigestList
281 CopyMem (Buffer
, &DigestList
->count
, sizeof(DigestList
->count
));
282 Buffer
= (UINT8
*)Buffer
+ sizeof(DigestList
->count
);
283 for (Index
= 0; Index
< DigestList
->count
; Index
++) {
284 if (!IsHashAlgSupportedInPcrBank (DigestList
->digests
[Index
].hashAlg
)) {
285 DEBUG ((EFI_D_ERROR
, "WARNING: TPM2 Event log has HashAlg unsupported by PCR bank (0x%x)\n", DigestList
->digests
[Index
].hashAlg
));
288 CopyMem (Buffer
, &DigestList
->digests
[Index
].hashAlg
, sizeof(DigestList
->digests
[Index
].hashAlg
));
289 Buffer
= (UINT8
*)Buffer
+ sizeof(DigestList
->digests
[Index
].hashAlg
);
290 DigestSize
= GetHashSizeFromAlgo (DigestList
->digests
[Index
].hashAlg
);
291 CopyMem (Buffer
, &DigestList
->digests
[Index
].digest
, DigestSize
);
292 Buffer
= (UINT8
*)Buffer
+ DigestSize
;
299 Set Tpm2HashMask PCD value according to TPM2 PCR bank.
307 UINT32 ActivePcrBanks
;
308 TPML_PCR_SELECTION Pcrs
;
311 DEBUG ((EFI_D_ERROR
, "SetTpm2HashMask!\n"));
313 Status
= Tpm2GetCapabilityPcrs (&Pcrs
);
314 if (EFI_ERROR (Status
)) {
315 DEBUG ((EFI_D_ERROR
, "Tpm2GetCapabilityPcrs fail!\n"));
316 ActivePcrBanks
= EFI_TCG2_BOOT_HASH_ALG_SHA1
;
318 DEBUG ((EFI_D_INFO
, "Tpm2GetCapabilityPcrs Count - %08x\n", Pcrs
.count
));
320 for (Index
= 0; Index
< Pcrs
.count
; Index
++) {
321 DEBUG ((EFI_D_INFO
, "hash - %x\n", Pcrs
.pcrSelections
[Index
].hash
));
322 switch (Pcrs
.pcrSelections
[Index
].hash
) {
324 if (!IsZeroBuffer (Pcrs
.pcrSelections
[Index
].pcrSelect
, Pcrs
.pcrSelections
[Index
].sizeofSelect
)) {
325 ActivePcrBanks
|= EFI_TCG2_BOOT_HASH_ALG_SHA1
;
329 if (!IsZeroBuffer (Pcrs
.pcrSelections
[Index
].pcrSelect
, Pcrs
.pcrSelections
[Index
].sizeofSelect
)) {
330 ActivePcrBanks
|= EFI_TCG2_BOOT_HASH_ALG_SHA256
;
334 if (!IsZeroBuffer (Pcrs
.pcrSelections
[Index
].pcrSelect
, Pcrs
.pcrSelections
[Index
].sizeofSelect
)) {
335 ActivePcrBanks
|= EFI_TCG2_BOOT_HASH_ALG_SHA384
;
339 if (!IsZeroBuffer (Pcrs
.pcrSelections
[Index
].pcrSelect
, Pcrs
.pcrSelections
[Index
].sizeofSelect
)) {
340 ActivePcrBanks
|= EFI_TCG2_BOOT_HASH_ALG_SHA512
;
343 case TPM_ALG_SM3_256
:
344 if (!IsZeroBuffer (Pcrs
.pcrSelections
[Index
].pcrSelect
, Pcrs
.pcrSelections
[Index
].sizeofSelect
)) {
345 ActivePcrBanks
|= EFI_TCG2_BOOT_HASH_ALG_SM3_256
;
351 Status
= PcdSet32S (PcdTpm2HashMask
, ActivePcrBanks
);
352 ASSERT_EFI_ERROR (Status
);
356 Add a new entry to the Event Log.
358 @param[in] DigestList A list of digest.
359 @param[in,out] NewEventHdr Pointer to a TCG_PCR_EVENT_HDR data structure.
360 @param[in] NewEventData Pointer to the new event data.
362 @retval EFI_SUCCESS The new event log entry was added.
363 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
367 IN TPML_DIGEST_VALUES
*DigestList
,
368 IN OUT TCG_PCR_EVENT_HDR
*NewEventHdr
,
369 IN UINT8
*NewEventData
375 EFI_STATUS RetStatus
;
376 UINT32 SupportedEventLogs
;
377 TCG_PCR_EVENT2
*TcgPcrEvent2
;
380 SupportedEventLogs
= EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2
| EFI_TCG2_EVENT_LOG_FORMAT_TCG_2
;
382 RetStatus
= EFI_SUCCESS
;
383 for (Index
= 0; Index
< sizeof(mTcg2EventInfo
)/sizeof(mTcg2EventInfo
[0]); Index
++) {
384 if ((SupportedEventLogs
& mTcg2EventInfo
[Index
].LogFormat
) != 0) {
385 DEBUG ((EFI_D_INFO
, " LogFormat - 0x%08x\n", mTcg2EventInfo
[Index
].LogFormat
));
386 switch (mTcg2EventInfo
[Index
].LogFormat
) {
387 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_1_2
:
388 Status
= GetDigestFromDigestList (TPM_ALG_SHA1
, DigestList
, &NewEventHdr
->Digest
);
389 if (!EFI_ERROR (Status
)) {
390 HobData
= BuildGuidHob (
391 &gTcgEventEntryHobGuid
,
392 sizeof (*NewEventHdr
) + NewEventHdr
->EventSize
394 if (HobData
== NULL
) {
395 RetStatus
= EFI_OUT_OF_RESOURCES
;
399 CopyMem (HobData
, NewEventHdr
, sizeof (*NewEventHdr
));
400 HobData
= (VOID
*) ((UINT8
*)HobData
+ sizeof (*NewEventHdr
));
401 CopyMem (HobData
, NewEventData
, NewEventHdr
->EventSize
);
404 case EFI_TCG2_EVENT_LOG_FORMAT_TCG_2
:
405 HobData
= BuildGuidHob (
406 &gTcgEvent2EntryHobGuid
,
407 sizeof(TcgPcrEvent2
->PCRIndex
) + sizeof(TcgPcrEvent2
->EventType
) + GetDigestListSize (DigestList
) + sizeof(TcgPcrEvent2
->EventSize
) + NewEventHdr
->EventSize
409 if (HobData
== NULL
) {
410 RetStatus
= EFI_OUT_OF_RESOURCES
;
414 TcgPcrEvent2
= HobData
;
415 TcgPcrEvent2
->PCRIndex
= NewEventHdr
->PCRIndex
;
416 TcgPcrEvent2
->EventType
= NewEventHdr
->EventType
;
417 DigestBuffer
= (UINT8
*)&TcgPcrEvent2
->Digest
;
418 DigestBuffer
= CopyDigestListToBuffer (DigestBuffer
, DigestList
);
419 CopyMem (DigestBuffer
, &NewEventHdr
->EventSize
, sizeof(TcgPcrEvent2
->EventSize
));
420 DigestBuffer
= DigestBuffer
+ sizeof(TcgPcrEvent2
->EventSize
);
421 CopyMem (DigestBuffer
, NewEventData
, NewEventHdr
->EventSize
);
431 Do a hash operation on a data buffer, extend a specific TPM PCR with the hash result,
432 and build a GUIDed HOB recording the event which will be passed to the DXE phase and
433 added into the Event Log.
435 @param[in] Flags Bitmap providing additional information.
436 @param[in] HashData Physical address of the start of the data buffer
437 to be hashed, extended, and logged.
438 @param[in] HashDataLen The length, in bytes, of the buffer referenced by HashData.
439 @param[in] NewEventHdr Pointer to a TCG_PCR_EVENT_HDR data structure.
440 @param[in] NewEventData Pointer to the new event data.
442 @retval EFI_SUCCESS Operation completed successfully.
443 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
444 @retval EFI_DEVICE_ERROR The command was unsuccessful.
451 IN UINTN HashDataLen
,
452 IN TCG_PCR_EVENT_HDR
*NewEventHdr
,
453 IN UINT8
*NewEventData
457 TPML_DIGEST_VALUES DigestList
;
459 if (GetFirstGuidHob (&gTpmErrorHobGuid
) != NULL
) {
460 return EFI_DEVICE_ERROR
;
463 Status
= HashAndExtend (
464 NewEventHdr
->PCRIndex
,
469 if (!EFI_ERROR (Status
)) {
470 if ((Flags
& EFI_TCG2_EXTEND_ONLY
) == 0) {
471 Status
= LogHashEvent (&DigestList
, NewEventHdr
, NewEventData
);
475 if (Status
== EFI_DEVICE_ERROR
) {
476 DEBUG ((EFI_D_ERROR
, "HashLogExtendEvent - %r. Disable TPM.\n", Status
));
477 BuildGuidHob (&gTpmErrorHobGuid
,0);
479 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
480 (PcdGet32 (PcdStatusCodeSubClassTpmDevice
) | EFI_P_EC_INTERFACE_ERROR
)
488 Measure CRTM version.
490 @retval EFI_SUCCESS Operation completed successfully.
491 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
492 @retval EFI_DEVICE_ERROR The command was unsuccessful.
500 TCG_PCR_EVENT_HDR TcgEventHdr
;
503 // Use FirmwareVersion string to represent CRTM version.
504 // OEMs should get real CRTM version string and measure it.
507 TcgEventHdr
.PCRIndex
= 0;
508 TcgEventHdr
.EventType
= EV_S_CRTM_VERSION
;
509 TcgEventHdr
.EventSize
= (UINT32
) StrSize((CHAR16
*)PcdGetPtr (PcdFirmwareVersionString
));
511 return HashLogExtendEvent (
513 (UINT8
*)PcdGetPtr (PcdFirmwareVersionString
),
514 TcgEventHdr
.EventSize
,
516 (UINT8
*)PcdGetPtr (PcdFirmwareVersionString
)
522 Add it into the measured FV list after the FV is measured successfully.
524 @param[in] FvBase Base address of FV image.
525 @param[in] FvLength Length of FV image.
527 @retval EFI_SUCCESS Fv image is measured successfully
528 or it has been already measured.
529 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
530 @retval EFI_DEVICE_ERROR The command was unsuccessful.
535 IN EFI_PHYSICAL_ADDRESS FvBase
,
541 EFI_PLATFORM_FIRMWARE_BLOB FvBlob
;
542 TCG_PCR_EVENT_HDR TcgEventHdr
;
545 // Check if it is in Excluded FV list
547 if (mMeasurementExcludedFvPpi
!= NULL
) {
548 for (Index
= 0; Index
< mMeasurementExcludedFvPpi
->Count
; Index
++) {
549 if (mMeasurementExcludedFvPpi
->Fv
[Index
].FvBase
== FvBase
) {
550 DEBUG ((DEBUG_INFO
, "The FV which is excluded by Tcg2Pei starts at: 0x%x\n", FvBase
));
551 DEBUG ((DEBUG_INFO
, "The FV which is excluded by Tcg2Pei has the size: 0x%x\n", FvLength
));
558 // Check whether FV is in the measured FV list.
560 for (Index
= 0; Index
< mMeasuredBaseFvIndex
; Index
++) {
561 if (mMeasuredBaseFvInfo
[Index
].BlobBase
== FvBase
) {
567 // Measure and record the FV to the TPM
569 FvBlob
.BlobBase
= FvBase
;
570 FvBlob
.BlobLength
= FvLength
;
572 DEBUG ((DEBUG_INFO
, "The FV which is measured by Tcg2Pei starts at: 0x%x\n", FvBlob
.BlobBase
));
573 DEBUG ((DEBUG_INFO
, "The FV which is measured by Tcg2Pei has the size: 0x%x\n", FvBlob
.BlobLength
));
575 TcgEventHdr
.PCRIndex
= 0;
576 TcgEventHdr
.EventType
= EV_EFI_PLATFORM_FIRMWARE_BLOB
;
577 TcgEventHdr
.EventSize
= sizeof (FvBlob
);
579 Status
= HashLogExtendEvent (
581 (UINT8
*) (UINTN
) FvBlob
.BlobBase
,
582 (UINTN
) FvBlob
.BlobLength
,
588 // Add new FV into the measured FV list.
590 ASSERT (mMeasuredBaseFvIndex
< PcdGet32 (PcdPeiCoreMaxFvSupported
));
591 if (mMeasuredBaseFvIndex
< PcdGet32 (PcdPeiCoreMaxFvSupported
)) {
592 mMeasuredBaseFvInfo
[mMeasuredBaseFvIndex
].BlobBase
= FvBase
;
593 mMeasuredBaseFvInfo
[mMeasuredBaseFvIndex
].BlobLength
= FvLength
;
594 mMeasuredBaseFvIndex
++;
603 @retval EFI_SUCCESS Operation completed successfully.
604 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
605 @retval EFI_DEVICE_ERROR The command was unsuccessful.
615 EFI_PEI_FV_HANDLE VolumeHandle
;
616 EFI_FV_INFO VolumeInfo
;
617 EFI_PEI_FIRMWARE_VOLUME_PPI
*FvPpi
;
619 PERF_START_EX (mFileHandle
, "EventRec", "Tcg2Pei", 0, PERF_ID_TCG2_PEI
);
623 // Traverse all firmware volume instances of Static Core Root of Trust for Measurement
624 // (S-CRTM), this firmware volume measure policy can be modified/enhanced by special
625 // platform for special CRTM TPM measuring.
627 Status
= PeiServicesFfsFindNextVolume (FvInstances
, &VolumeHandle
);
628 if (EFI_ERROR (Status
)) {
633 // Measure and record the firmware volume that is dispatched by PeiCore
635 Status
= PeiServicesFfsGetVolumeInfo (VolumeHandle
, &VolumeInfo
);
636 ASSERT_EFI_ERROR (Status
);
638 // Locate the corresponding FV_PPI according to founded FV's format guid
640 Status
= PeiServicesLocatePpi (
641 &VolumeInfo
.FvFormat
,
646 if (!EFI_ERROR (Status
)) {
647 MeasureFvImage ((EFI_PHYSICAL_ADDRESS
) (UINTN
) VolumeInfo
.FvStart
, VolumeInfo
.FvSize
);
652 PERF_END_EX (mFileHandle
, "EventRec", "Tcg2Pei", 0, PERF_ID_TCG2_PEI
+ 1);
658 Measure and record the Firmware Volum Information once FvInfoPPI install.
660 @param[in] PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
661 @param[in] NotifyDescriptor Address of the notification descriptor data structure.
662 @param[in] Ppi Address of the PPI that was installed.
664 @retval EFI_SUCCESS The FV Info is measured and recorded to TPM.
665 @return Others Fail to measure FV.
670 FirmwareVolmeInfoPpiNotifyCallback (
671 IN EFI_PEI_SERVICES
**PeiServices
,
672 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
676 EFI_PEI_FIRMWARE_VOLUME_INFO_PPI
*Fv
;
678 EFI_PEI_FIRMWARE_VOLUME_PPI
*FvPpi
;
681 Fv
= (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI
*) Ppi
;
684 // The PEI Core can not dispatch or load files from memory mapped FVs that do not support FvPpi.
686 Status
= PeiServicesLocatePpi (
692 if (EFI_ERROR (Status
)) {
697 // This is an FV from an FFS file, and the parent FV must have already been measured,
698 // No need to measure twice, so just record the FV and return
700 if (Fv
->ParentFvName
!= NULL
|| Fv
->ParentFileName
!= NULL
) {
702 ASSERT (mMeasuredChildFvIndex
< PcdGet32 (PcdPeiCoreMaxFvSupported
));
703 if (mMeasuredChildFvIndex
< PcdGet32 (PcdPeiCoreMaxFvSupported
)) {
705 // Check whether FV is in the measured child FV list.
707 for (Index
= 0; Index
< mMeasuredChildFvIndex
; Index
++) {
708 if (mMeasuredChildFvInfo
[Index
].BlobBase
== (EFI_PHYSICAL_ADDRESS
) (UINTN
) Fv
->FvInfo
) {
712 mMeasuredChildFvInfo
[mMeasuredChildFvIndex
].BlobBase
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) Fv
->FvInfo
;
713 mMeasuredChildFvInfo
[mMeasuredChildFvIndex
].BlobLength
= Fv
->FvInfoSize
;
714 mMeasuredChildFvIndex
++;
719 return MeasureFvImage ((EFI_PHYSICAL_ADDRESS
) (UINTN
) Fv
->FvInfo
, Fv
->FvInfoSize
);
723 Do measurement after memory is ready.
725 @param[in] PeiServices Describes the list of possible PEI Services.
727 @retval EFI_SUCCESS Operation completed successfully.
728 @retval EFI_OUT_OF_RESOURCES No enough memory to log the new event.
729 @retval EFI_DEVICE_ERROR The command was unsuccessful.
734 IN EFI_PEI_SERVICES
**PeiServices
739 Status
= PeiServicesLocatePpi (
740 &gEfiPeiFirmwareVolumeInfoMeasurementExcludedPpiGuid
,
743 (VOID
**)&mMeasurementExcludedFvPpi
745 // Do not check status, because it is optional
747 mMeasuredBaseFvInfo
= (EFI_PLATFORM_FIRMWARE_BLOB
*) AllocateZeroPool (sizeof (EFI_PLATFORM_FIRMWARE_BLOB
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
748 ASSERT (mMeasuredBaseFvInfo
!= NULL
);
749 mMeasuredChildFvInfo
= (EFI_PLATFORM_FIRMWARE_BLOB
*) AllocateZeroPool (sizeof (EFI_PLATFORM_FIRMWARE_BLOB
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
750 ASSERT (mMeasuredChildFvInfo
!= NULL
);
752 if (PcdGet8 (PcdTpm2ScrtmPolicy
) == 1) {
753 Status
= MeasureCRTMVersion ();
756 Status
= MeasureMainBios ();
760 // for the FvInfoPpi services to measure and record
761 // the additional Fvs to TPM
763 Status
= PeiServicesNotifyPpi (&mNotifyList
[0]);
764 ASSERT_EFI_ERROR (Status
);
770 Measure and log Separator event with error, and extend the measurement result into a specific PCR.
772 @param[in] PCRIndex PCR index.
774 @retval EFI_SUCCESS Operation completed successfully.
775 @retval EFI_DEVICE_ERROR The operation was unsuccessful.
779 MeasureSeparatorEventWithError (
780 IN TPM_PCRINDEX PCRIndex
783 TCG_PCR_EVENT_HDR TcgEvent
;
787 // Use EventData 0x1 to indicate there is error.
790 TcgEvent
.PCRIndex
= PCRIndex
;
791 TcgEvent
.EventType
= EV_SEPARATOR
;
792 TcgEvent
.EventSize
= (UINT32
)sizeof (EventData
);
793 return HashLogExtendEvent(0,(UINT8
*)&EventData
, TcgEvent
.EventSize
, &TcgEvent
,(UINT8
*)&EventData
);
797 Entry point of this module.
799 @param[in] FileHandle Handle of the file being invoked.
800 @param[in] PeiServices Describes the list of possible PEI Services.
808 IN EFI_PEI_FILE_HANDLE FileHandle
,
809 IN CONST EFI_PEI_SERVICES
**PeiServices
814 EFI_BOOT_MODE BootMode
;
815 TPM_PCRINDEX PcrIndex
;
816 BOOLEAN S3ErrorReport
;
818 if (CompareGuid (PcdGetPtr(PcdTpmInstanceGuid
), &gEfiTpmDeviceInstanceNoneGuid
) ||
819 CompareGuid (PcdGetPtr(PcdTpmInstanceGuid
), &gEfiTpmDeviceInstanceTpm12Guid
)){
820 DEBUG ((EFI_D_ERROR
, "No TPM2 instance required!\n"));
821 return EFI_UNSUPPORTED
;
824 if (GetFirstGuidHob (&gTpmErrorHobGuid
) != NULL
) {
825 DEBUG ((EFI_D_ERROR
, "TPM2 error!\n"));
826 return EFI_DEVICE_ERROR
;
829 Status
= PeiServicesGetBootMode (&BootMode
);
830 ASSERT_EFI_ERROR (Status
);
833 // In S3 path, skip shadow logic. no measurement is required
835 if (BootMode
!= BOOT_ON_S3_RESUME
) {
836 Status
= (**PeiServices
).RegisterForShadow(FileHandle
);
837 if (Status
== EFI_ALREADY_STARTED
) {
838 mImageInMemory
= TRUE
;
839 mFileHandle
= FileHandle
;
840 } else if (Status
== EFI_NOT_FOUND
) {
841 ASSERT_EFI_ERROR (Status
);
845 if (!mImageInMemory
) {
847 // Initialize TPM device
849 Status
= Tpm2RequestUseTpm ();
850 if (EFI_ERROR (Status
)) {
851 DEBUG ((DEBUG_ERROR
, "TPM2 not detected!\n"));
855 S3ErrorReport
= FALSE
;
856 if (PcdGet8 (PcdTpm2InitializationPolicy
) == 1) {
857 if (BootMode
== BOOT_ON_S3_RESUME
) {
858 Status
= Tpm2Startup (TPM_SU_STATE
);
859 if (EFI_ERROR (Status
) ) {
860 Status
= Tpm2Startup (TPM_SU_CLEAR
);
861 if (!EFI_ERROR(Status
)) {
862 S3ErrorReport
= TRUE
;
866 Status
= Tpm2Startup (TPM_SU_CLEAR
);
868 if (EFI_ERROR (Status
) ) {
874 // Update Tpm2HashMask according to PCR bank.
880 // The system firmware that resumes from S3 MUST deal with a
881 // TPM2_Startup error appropriately.
882 // For example, issue a TPM2_Startup(TPM_SU_CLEAR) command and
883 // configuring the device securely by taking actions like extending a
884 // separator with an error digest (0x01) into PCRs 0 through 7.
886 for (PcrIndex
= 0; PcrIndex
< 8; PcrIndex
++) {
887 Status
= MeasureSeparatorEventWithError (PcrIndex
);
888 if (EFI_ERROR (Status
)) {
889 DEBUG ((EFI_D_ERROR
, "Separator Event with Error not Measured. Error!\n"));
895 // TpmSelfTest is optional on S3 path, skip it to save S3 time
897 if (BootMode
!= BOOT_ON_S3_RESUME
) {
898 if (PcdGet8 (PcdTpm2SelfTestPolicy
) == 1) {
899 Status
= Tpm2SelfTest (NO
);
900 if (EFI_ERROR (Status
)) {
907 // Only intall TpmInitializedPpi on success
909 Status
= PeiServicesInstallPpi (&mTpmInitializedPpiList
);
910 ASSERT_EFI_ERROR (Status
);
913 if (mImageInMemory
) {
914 Status
= PeimEntryMP ((EFI_PEI_SERVICES
**)PeiServices
);
919 if (EFI_ERROR (Status
)) {
920 DEBUG ((EFI_D_ERROR
, "TPM2 error! Build Hob\n"));
921 BuildGuidHob (&gTpmErrorHobGuid
,0);
923 EFI_ERROR_CODE
| EFI_ERROR_MINOR
,
924 (PcdGet32 (PcdStatusCodeSubClassTpmDevice
) | EFI_P_EC_INTERFACE_ERROR
)
928 // Always intall TpmInitializationDonePpi no matter success or fail.
929 // Other driver can know TPM initialization state by TpmInitializedPpi.
931 Status2
= PeiServicesInstallPpi (&mTpmInitializationDonePpiList
);
932 ASSERT_EFI_ERROR (Status2
);