MdeModulePkg PiDxeS3BootScriptLib: Remove a hidden assumption.

What to do:
1. Remove a hidden assumption "No SMM driver writes BootScript between
SmmReadyToLock and S3SleepEntryCallback".
 1.1. Use SmmExitBootServices and SmmLegacyBoot notification to record
      AtRuntime flag.
 1.2. Use mBootScriptDataBootTimeGuid LockBox to save boot time boot
      script data to handle potential INSERT boot script at runtime in SMM.
2. Do not depend on OS to help restore ACPINvs data and use
EfiReservedMemoryType instead of EfiACPIMemoryNVS.
 2.1. Use mBootScriptSmmPrivateDataGuid LockBox to save boot script
      SMM private data with BackFromS3 = TRUE at runtime. S3 resume
      will help restore it to tell the Library the system is back
      from S3.

Why to do:
1. The hidden assumption "No SMM driver writes BootScript between
SmmReadyToLock and S3SleepEntryCallback" will cause confusion to
the library's consumer and block the usage of "SMM driver writes
BootScript after SmmReadyToLock". So Remove the assumption.
2. In original code, there might be a corner case that malicious
code patch ACPINvs boot TableLength field same as SMM boot script.
So that it can skip the table restore. The impact is that BootScript
in SMM may be overridden by malicious code.
--------------------
    CopyMem ((VOID*)&TableHeader, (VOID*)mS3BootScriptTablePtr->TableBase, sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER));
    if (mS3BootScriptTablePtr->TableLength + sizeof(EFI_BOOT_SCRIPT_TERMINATE) != TableHeader.TableLength) { // TableLength is in NVS
      ......
      //
      // NOTE: We should NOT use TableHeader.TableLength, because it is already updated to be whole length.
      //
      mS3BootScriptTablePtr->TableLength = (UINT32)(mLockBoxLength - sizeof(EFI_BOOT_SCRIPT_TERMINATE)); ? This line can be skipped.
--------------------
So use EfiReservedMemoryType instead of EfiACPIMemoryNVS as the code
has been updated to not depend on OS to help restore ACPINvs data.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@18467 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 11 insertions, 6 deletions

diff --git a/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h b/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h
index 3e2a0d2bac..e540278483 100644
--- a/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h
+++ b/MdeModulePkg/Library/PiDxeS3BootScriptLib/InternalBootScriptLib.h
@@ -2,7 +2,7 @@
   Support for S3 boot script lib. This file defined some internal macro and internal 

   data structure

  

-  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>

 

   This program and the accompanying materials

   are licensed and made available under the terms and conditions

@@ -23,6 +23,8 @@
 #include <Protocol/SmmBase2.h>

 #include <Protocol/DxeSmmReadyToLock.h>

 #include <Protocol/SmmReadyToLock.h>

+#include <Protocol/SmmExitBootServices.h>

+#include <Protocol/SmmLegacyBoot.h>

 

 #include <Library/S3BootScriptLib.h>

 

@@ -70,11 +72,14 @@ typedef union {
 // The boot script private data.

 //

 typedef struct {

-  UINT8           *TableBase;

-  UINT32          TableLength;               // Record the actual memory length 

-  UINT16          TableMemoryPageNumber;     // Record the page number Allocated for the table 

-  BOOLEAN         AtRuntime;                 // Record if current state is after SmmReadyToLock

-  BOOLEAN         InSmm;                     // Record if this library is in SMM.

+  UINT8     *TableBase;

+  UINT32    TableLength;            // Record the actual memory length 

+  UINT16    TableMemoryPageNumber;  // Record the page number Allocated for the table 

+  BOOLEAN   InSmm;                  // Record if this library is in SMM.

+  BOOLEAN   AtRuntime;              // Record if current state is after SmmExitBootServices or SmmLegacyBoot.

+  UINT32    BootTimeScriptLength;   // Maintain boot time script length in LockBox after SmmReadyToLock in SMM.

+  BOOLEAN   SmmLocked;              // Record if current state is after SmmReadyToLock

+  BOOLEAN   BackFromS3;             // Indicate that the system is back from S3.

 } SCRIPT_TABLE_PRIVATE_DATA;

 

 typedef