MdeModulePkg LockBoxLib: Support LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY

[mirror_edk2.git] / MdeModulePkg / Include / Library / LockBoxLib.h

diff --git a/MdeModulePkg/Include/Library/LockBoxLib.h b/MdeModulePkg/Include/Library/LockBoxLib.h
index db7fd05def582ce3acf1690720773887732a0f8e..80beb4d0f880aa23816d4c1e074e8d9ccd344c7c 100644 (file)
--- a/MdeModulePkg/Include/Library/LockBoxLib.h
+++ b/MdeModulePkg/Include/Library/LockBoxLib.h
@@ -2,7 +2,7 @@
   This library is only intended to be used by DXE modules that need save\r
   confidential information to LockBox and get it by PEI modules in S3 phase.\r
 \r
-Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
 \r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions\r
@@ -62,9 +62,17 @@ SetLockBoxAttributes (
   );\r
 \r
 //\r
-// With this flag, this LockBox can be restored to this Buffer with RestoreAllLockBoxInPlace()\r
+// With this flag, this LockBox can be restored to this Buffer\r
+// with RestoreAllLockBoxInPlace()\r
 //\r
-#define LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE  BIT0\r
+#define LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE     BIT0\r
+//\r
+// With this flag, this LockBox can be restored in S3 resume only.\r
+// This LockBox can not be restored after SmmReadyToLock in normal boot\r
+// and after EndOfS3Resume in S3 resume.\r
+// It can not be set together with LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE.\r
+//\r
+#define LOCK_BOX_ATTRIBUTE_RESTORE_IN_S3_ONLY   BIT1\r
 \r
 /**\r
   This function will update confidential information to lockbox.\r