From: Laszlo Ersek <[email protected]>

The S3 suspend/resume infrastructure depends on the LockBox library class.
The edk2 tree currently contains Null and SMM instances. The Null instance
is useless, and the SMM instance would require SMM emulation by including
the SMM core and adding several new drivers, which is deemed too complex.

Hence add a simple LockBoxLib instance for OVMF.

[email protected]:
 * use PCDs instead of EmuNvramLib
   - clear memory in PlatformPei on non S3 boots
 * allocate NVS memory and store a pointer to that memory
   - reduces memory use at fixed locations

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <[email protected]>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jordan Justen <[email protected]>
---
 OvmfPkg/Library/LockBoxLib/LockBoxBase.c      |  42 +++
 OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf |  44 ++++
 OvmfPkg/Library/LockBoxLib/LockBoxDxe.c       |  62 +++++
 OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf  |  45 ++++
 OvmfPkg/Library/LockBoxLib/LockBoxLib.c       | 358 ++++++++++++++++++++++++++
 OvmfPkg/Library/LockBoxLib/LockBoxLib.h       |  47 ++++
 OvmfPkg/OvmfPkg.dec                           |   2 +
 OvmfPkg/OvmfPkgIa32.dsc                       |   3 +-
 OvmfPkg/OvmfPkgIa32.fdf                       |   3 +
 OvmfPkg/OvmfPkgIa32X64.dsc                    |   3 +-
 OvmfPkg/OvmfPkgIa32X64.fdf                    |   3 +
 OvmfPkg/OvmfPkgX64.dsc                        |   3 +-
 OvmfPkg/OvmfPkgX64.fdf                        |   3 +
 OvmfPkg/PlatformPei/MemDetect.c               |  17 ++
 OvmfPkg/PlatformPei/PlatformPei.inf           |   2 +
 15 files changed, 634 insertions(+), 3 deletions(-)
 create mode 100644 OvmfPkg/Library/LockBoxLib/LockBoxBase.c
 create mode 100644 OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
 create mode 100644 OvmfPkg/Library/LockBoxLib/LockBoxDxe.c
 create mode 100644 OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
 create mode 100644 OvmfPkg/Library/LockBoxLib/LockBoxLib.c
 create mode 100644 OvmfPkg/Library/LockBoxLib/LockBoxLib.h

diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxBase.c 
b/OvmfPkg/Library/LockBoxLib/LockBoxBase.c
new file mode 100644
index 0000000..723daa3
--- /dev/null
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxBase.c
@@ -0,0 +1,42 @@
+/** @file
+
+  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
+
+  This program and the accompanying materials                          
+  are licensed and made available under the terms and conditions of the BSD 
License         
+  which accompanies this distribution.  The full text of the license may be 
found at        
+  http://opensource.org/licenses/bsd-license.php.                              
              
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,        
             
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR 
IMPLIED.             
+
+**/
+
+#include <Uefi.h>
+
+#include <Library/DebugLib.h>
+#include <LockBoxLib.h>
+
+/**
+  Allocates a buffer of type EfiACPIMemoryNVS.
+
+  Allocates the number bytes specified by AllocationSize of type
+  EfiACPIMemoryNVS and returns a pointer to the allocated buffer.
+  If AllocationSize is 0, then a valid buffer of 0 size is
+  returned.  If there is not enough memory remaining to satisfy
+  the request, then NULL is returned.
+
+  @param  AllocationSize        The number of bytes to allocate.
+
+  @return A pointer to the allocated buffer or NULL if allocation fails.
+
+**/
+VOID *
+EFIAPI
+AllocateAcpiNvsPool (
+  IN UINTN  AllocationSize
+  )
+{
+  ASSERT_EFI_ERROR (RETURN_UNSUPPORTED);
+  return NULL;
+}
diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf 
b/OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
new file mode 100644
index 0000000..ad67f96
--- /dev/null
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
@@ -0,0 +1,44 @@
+## @file
+#
+#  Library implementing the LockBox interface for OVMF
+#
+#  Copyright (C) 2013, Red Hat, Inc.
+#  Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>
+#
+#  This program and the accompanying materials are licensed and made available
+#  under the terms and conditions of the BSD License which accompanies this
+#  distribution. The full text of the license may be found at
+#  http://opensource.org/licenses/bsd-license.php
+#
+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
+#  IMPLIED.
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x00010005
+  BASE_NAME                      = LockBoxLib
+  FILE_GUID                      = 17CA9B37-5BAB-492C-A09C-7121FBE34CE6
+  MODULE_TYPE                    = BASE
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = LockBoxLib
+
+  CONSTRUCTOR                    = LockBoxLibInitialize
+
+[Sources]
+  LockBoxBase.c
+  LockBoxLib.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+  OvmfPkg/OvmfPkg.dec
+
+[LibraryClasses]
+  BaseMemoryLib
+  DebugLib
+
+[Pcd]
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize
diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxDxe.c 
b/OvmfPkg/Library/LockBoxLib/LockBoxDxe.c
new file mode 100644
index 0000000..88cdff9
--- /dev/null
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxDxe.c
@@ -0,0 +1,62 @@
+/** @file
+
+  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
+
+  This program and the accompanying materials                          
+  are licensed and made available under the terms and conditions of the BSD 
License         
+  which accompanies this distribution.  The full text of the license may be 
found at        
+  http://opensource.org/licenses/bsd-license.php.                              
              
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,        
             
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR 
IMPLIED.             
+
+**/
+
+#include <Uefi.h>
+
+#include <Library/MemoryAllocationLib.h>
+#include <Library/UefiBootServicesTableLib.h>
+#include <Library/BaseMemoryLib.h>
+#include <Library/DebugLib.h>
+#include <LockBoxLib.h>
+
+/**
+  Allocates a buffer of type EfiACPIMemoryNVS.
+
+  Allocates the number bytes specified by AllocationSize of type
+  EfiACPIMemoryNVS and returns a pointer to the allocated buffer.
+  If AllocationSize is 0, then a valid buffer of 0 size is
+  returned.  If there is not enough memory remaining to satisfy
+  the request, then NULL is returned.
+
+  @param  AllocationSize        The number of bytes to allocate.
+
+  @return A pointer to the allocated buffer or NULL if allocation fails.
+
+**/
+VOID *
+EFIAPI
+AllocateAcpiNvsPool (
+  IN UINTN  AllocationSize
+  )
+{
+  EFI_STATUS  Status;
+  VOID        *Memory;
+
+  Status = gBS->AllocatePool (EfiACPIMemoryNVS, AllocationSize, &Memory);
+  if (EFI_ERROR (Status)) {
+    Memory = NULL;
+  }
+  return Memory;
+}
+
+
+EFI_STATUS
+EFIAPI
+LockBoxDxeLibInitialize (
+  IN EFI_HANDLE        ImageHandle,
+  IN EFI_SYSTEM_TABLE  *SystemTable
+  )
+{
+  return LockBoxLibInitialize ();
+}
diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf 
b/OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
new file mode 100644
index 0000000..6d2cbd5
--- /dev/null
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
@@ -0,0 +1,45 @@
+## @file
+#
+#  Library implementing the LockBox interface for OVMF
+#
+#  Copyright (C) 2013, Red Hat, Inc.
+#  Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>
+#
+#  This program and the accompanying materials are licensed and made available
+#  under the terms and conditions of the BSD License which accompanies this
+#  distribution. The full text of the license may be found at
+#  http://opensource.org/licenses/bsd-license.php
+#
+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR
+#  IMPLIED.
+#
+##
+
+[Defines]
+  INF_VERSION                    = 0x00010005
+  BASE_NAME                      = LockBoxLib
+  FILE_GUID                      = 17CA9B37-5BAB-492C-A09C-7121FBE34CE6
+  MODULE_TYPE                    = DXE_DRIVER
+  VERSION_STRING                 = 1.0
+  LIBRARY_CLASS                  = LockBoxLib
+
+  CONSTRUCTOR                    = LockBoxDxeLibInitialize
+
+[Sources]
+  LockBoxDxe.c
+  LockBoxLib.c
+
+[Packages]
+  MdePkg/MdePkg.dec
+  MdeModulePkg/MdeModulePkg.dec
+  OvmfPkg/OvmfPkg.dec
+
+[LibraryClasses]
+  BaseMemoryLib
+  DebugLib
+  UefiBootServicesTableLib
+
+[Pcd]
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize
diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxLib.c 
b/OvmfPkg/Library/LockBoxLib/LockBoxLib.c
new file mode 100644
index 0000000..6146389
--- /dev/null
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxLib.c
@@ -0,0 +1,358 @@
+/** @file
+
+  Library implementing the LockBox interface for OVMF
+
+  Copyright (C) 2013, Red Hat, Inc.
+  Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
+
+  This program and the accompanying materials are licensed and made available
+  under the terms and conditions of the BSD License which accompanies this
+  distribution. The full text of the license may be found at
+  http://opensource.org/licenses/bsd-license.php
+
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
+  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#include <Uefi.h>
+#include <Library/BaseMemoryLib.h>
+#include <Library/DebugLib.h>
+#include <Library/LockBoxLib.h>
+#include <Library/PcdLib.h>
+#include <LockBoxLib.h>
+
+#pragma pack(1)
+typedef struct {
+  EFI_GUID             Guid;
+  EFI_PHYSICAL_ADDRESS OrigAddress;
+  EFI_PHYSICAL_ADDRESS CopyAddress;
+  UINT32               Size;
+  UINT64               Attributes;
+} LOCK_BOX_HEADER;
+#pragma pack()
+
+
+RETURN_STATUS
+EFIAPI
+LockBoxLibInitialize (
+  VOID
+  )
+{
+  return RETURN_SUCCESS;
+}
+
+
+/**
+  Find LockBox entry based on GUID.
+
+  @param[in] Guid  The GUID to search for.
+
+  @return  Address of the LOCK_BOX_HEADER found. If LOCK_BOX_HEADER.Size is
+           greater than sizeof(LOCK_BOX_HEADER), then the returned header
+           contains the Guid of interest. Otherwise, the Guid was not found and
+           the terminator header is returned (whose size is exactly
+           sizeof(LOCK_BOX_HEADER)).
+**/
+STATIC
+LOCK_BOX_HEADER *
+EFIAPI
+FindHeaderByGuid (
+  IN CONST EFI_GUID *Guid
+  )
+{
+  LOCK_BOX_HEADER *Start, *Header, *End;
+
+  Start = (LOCK_BOX_HEADER *)(UINTN) PcdGet32 (PcdOvmfLockBoxStorageBase);
+  End = Start + (PcdGet32 (PcdOvmfLockBoxStorageBase) / sizeof (*Start));
+  for (Header = Start; Header < End; Header++) {
+    if (Header->Size == 0 || CompareGuid (Guid, &Header->Guid)) {
+      return Header;
+    }
+  }
+
+  return NULL;
+}
+
+
+/**
+  This function will save confidential information to lockbox.
+
+  @param Guid       the guid to identify the confidential information
+  @param Buffer     the address of the confidential information
+  @param Length     the length of the confidential information
+
+  @retval RETURN_SUCCESS            the information is saved successfully.
+  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or
+                                    Length is 0
+  @retval RETURN_ALREADY_STARTED    the requested GUID already exist.
+  @retval RETURN_OUT_OF_RESOURCES   no enough resource to save the information.
+  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface
+  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
+  @retval RETURN_UNSUPPORTED        the service is not supported by
+                                    implementaion.
+**/
+RETURN_STATUS
+EFIAPI
+SaveLockBox (
+  IN  GUID                        *Guid,
+  IN  VOID                        *Buffer,
+  IN  UINTN                       Length
+  )
+{
+  LOCK_BOX_HEADER *Header;
+  VOID            *CopyBuffer;
+
+  DEBUG ((DEBUG_VERBOSE, "%a: Guid=%g Buffer=%p Length=0x%x\n", __FUNCTION__,
+    Guid, Buffer, (UINT32) Length));
+
+  if (Guid == NULL || Buffer == NULL || Length == 0) {
+    return RETURN_INVALID_PARAMETER;
+  }
+
+  if (Length > 0xFFFFFFFF - sizeof *Header) {
+    return RETURN_OUT_OF_RESOURCES;
+  }
+
+  Header = FindHeaderByGuid (Guid);
+  if (Header == NULL) {
+    return RETURN_OUT_OF_RESOURCES;
+  }
+
+  if (Header->Size > 0) {
+    return RETURN_ALREADY_STARTED;
+  }
+
+  CopyBuffer = AllocateAcpiNvsPool (Length);
+  if (CopyBuffer == NULL) {
+    return RETURN_OUT_OF_RESOURCES;
+  }
+
+  //
+  // overwrite the current terminator header with new metadata
+  //
+  CopyGuid (&Header->Guid, Guid);
+  Header->OrigAddress = (UINTN) Buffer;
+  Header->CopyAddress = (UINTN) CopyBuffer;
+  Header->Size        = Length;
+  Header->Attributes  = 0;
+
+  //
+  // copy contents
+  //
+  CopyMem (CopyBuffer, Buffer, Length);
+
+  DEBUG ((DEBUG_VERBOSE, "%a: Guid=%g Buffer=%p Length=0x%x\n", __FUNCTION__,
+    Guid, Buffer, (UINT32) Length));
+  return RETURN_SUCCESS;
+}
+
+
+/**
+  This function will set lockbox attributes.
+
+  @param Guid       the guid to identify the confidential information
+  @param Attributes the attributes of the lockbox
+
+  @retval RETURN_SUCCESS            the information is saved successfully.
+  @retval RETURN_INVALID_PARAMETER  attributes is invalid.
+  @retval RETURN_NOT_FOUND          the requested GUID not found.
+  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface
+  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
+  @retval RETURN_UNSUPPORTED        the service is not supported by
+                                    implementaion.
+**/
+RETURN_STATUS
+EFIAPI
+SetLockBoxAttributes (
+  IN  GUID                        *Guid,
+  IN  UINT64                      Attributes
+  )
+{
+  LOCK_BOX_HEADER *Header;
+
+  if (Guid == NULL) {
+    return RETURN_INVALID_PARAMETER;
+  }
+  if (PcdGet32 (PcdOvmfLockBoxStorageSize) == 0) {
+    return RETURN_UNSUPPORTED;
+  }
+
+  Header = FindHeaderByGuid (Guid);
+  if (!Header || Header->Size == 0) {
+    return RETURN_NOT_FOUND;
+  }
+  Header->Attributes = Attributes;
+
+  DEBUG ((DEBUG_VERBOSE, "%a: Guid=%g Attributes=0x%Lx\n", __FUNCTION__, Guid,
+    Attributes));
+  return RETURN_SUCCESS;
+}
+
+
+/**
+  This function will update confidential information to lockbox.
+
+  @param Guid   the guid to identify the original confidential information
+  @param Offset the offset of the original confidential information
+  @param Buffer the address of the updated confidential information
+  @param Length the length of the updated confidential information
+
+  @retval RETURN_SUCCESS            the information is saved successfully.
+  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or
+                                    Length is 0.
+  @retval RETURN_NOT_FOUND          the requested GUID not found.
+  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold
+                                    new information.
+  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface
+  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
+  @retval RETURN_UNSUPPORTED        the service is not supported by
+                                    implementaion.
+**/
+RETURN_STATUS
+EFIAPI
+UpdateLockBox (
+  IN  GUID                        *Guid,
+  IN  UINTN                       Offset,
+  IN  VOID                        *Buffer,
+  IN  UINTN                       Length
+  )
+{
+  LOCK_BOX_HEADER *Header;
+
+  if (Guid == NULL || Buffer == NULL || Length == 0) {
+    return RETURN_INVALID_PARAMETER;
+  }
+  if (PcdGet32 (PcdOvmfLockBoxStorageSize) == 0) {
+    return RETURN_UNSUPPORTED;
+  }
+
+  Header = FindHeaderByGuid (Guid);
+  if (!Header || Header->Size == 0) {
+    return RETURN_NOT_FOUND;
+  }
+
+  if (Header->Size < Offset ||
+      Offset + Length > Header->Size) {
+    return RETURN_BUFFER_TOO_SMALL;
+  }
+  CopyMem ((UINT8 *)(UINTN) (Header->CopyAddress) + Offset, Buffer, Length);
+
+  DEBUG ((DEBUG_VERBOSE, "%a: Guid=%g Offset=0x%x Length=0x%x\n", __FUNCTION__,
+    Guid, (UINT32) Offset, (UINT32) Length));
+  return RETURN_SUCCESS;
+}
+
+
+/**
+  This function will restore confidential information from lockbox.
+
+  @param Guid   the guid to identify the confidential information
+  @param Buffer the address of the restored confidential information
+                NULL means restored to original address, Length MUST be NULL at
+                same time.
+  @param Length the length of the restored confidential information
+
+  @retval RETURN_SUCCESS            the information is restored successfully.
+  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or one of Buffer and
+                                    Length is NULL.
+  @retval RETURN_WRITE_PROTECTED    Buffer and Length are NULL, but the LockBox
+                                    has no LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE
+                                    attribute.
+  @retval RETURN_BUFFER_TOO_SMALL   the Length is too small to hold the
+                                    confidential information.
+  @retval RETURN_NOT_FOUND          the requested GUID not found.
+  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
+  @retval RETURN_ACCESS_DENIED      not allow to restore to the address
+  @retval RETURN_UNSUPPORTED        the service is not supported by
+                                    implementaion.
+**/
+RETURN_STATUS
+EFIAPI
+RestoreLockBox (
+  IN  GUID                        *Guid,
+  IN  VOID                        *Buffer, OPTIONAL
+  IN  OUT UINTN                   *Length  OPTIONAL
+  )
+{
+  LOCK_BOX_HEADER *Header;
+
+  if ((Guid == NULL) ||
+      ((Buffer == NULL) && (Length != NULL)) ||
+      ((Buffer != NULL) && (Length == NULL))) {
+    return EFI_INVALID_PARAMETER;
+  }
+
+  if (PcdGet32 (PcdOvmfLockBoxStorageSize) == 0) {
+    return RETURN_UNSUPPORTED;
+  }
+
+  Header = FindHeaderByGuid (Guid);
+  if (!Header || Header->Size == 0) {
+    return RETURN_NOT_FOUND;
+  }
+
+  if (Buffer == NULL) {
+    if (!(Header->Attributes & LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE)) {
+      return RETURN_WRITE_PROTECTED;
+    }
+    if (Header->OrigAddress + Header->Size > MAX_ADDRESS) {
+      return RETURN_UNSUPPORTED;
+    }
+    Buffer = (VOID *)(UINTN) Header->OrigAddress;
+  } else {
+    if (Header->Size > *Length) {
+      return RETURN_BUFFER_TOO_SMALL;
+    }
+  }
+
+  if (Header->CopyAddress + Header->Size > MAX_ADDRESS) {
+    return RETURN_UNSUPPORTED;
+  }
+
+  CopyMem (Buffer, (VOID*)(UINTN) Header->CopyAddress, Header->Size);
+  if (Length != NULL) {
+    *Length = Header->Size;
+  }
+
+  DEBUG ((DEBUG_VERBOSE, "%a: Guid=%g Buffer=%p\n", __FUNCTION__, Guid,
+    Buffer));
+  return RETURN_SUCCESS;
+}
+
+
+/**
+  This function will restore confidential information from all lockbox which
+  have RestoreInPlace attribute.
+
+  @retval RETURN_SUCCESS            the information is restored successfully.
+  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
+  @retval RETURN_UNSUPPORTED        the service is not supported by
+                                    implementaion.
+**/
+RETURN_STATUS
+EFIAPI
+RestoreAllLockBoxInPlace (
+  VOID
+  )
+{
+  LOCK_BOX_HEADER *Start, *Header, *End;
+
+  Start = (LOCK_BOX_HEADER *)(UINTN) PcdGet32 (PcdOvmfLockBoxStorageBase);
+  End = Start + (PcdGet32 (PcdOvmfLockBoxStorageBase) / sizeof (*Start));
+
+  for (Header = Start; Header < End && Header->Size > 0; Header++) {
+    if (Header->Attributes & LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) {
+      VOID *Buffer;
+
+      if ((UINTN) Header->OrigAddress != Header->OrigAddress) {
+        return RETURN_UNSUPPORTED;
+      }
+      Buffer = (VOID *)(UINTN) Header->OrigAddress;
+      CopyMem (Buffer, (VOID*)(UINTN)Header->CopyAddress, Header->Size);
+      DEBUG ((DEBUG_VERBOSE, "%a: Guid=%g Buffer=%p\n", __FUNCTION__,
+        Header->Guid, Buffer));
+    }
+  }
+  return RETURN_SUCCESS;
+}
diff --git a/OvmfPkg/Library/LockBoxLib/LockBoxLib.h 
b/OvmfPkg/Library/LockBoxLib/LockBoxLib.h
new file mode 100644
index 0000000..8b558e1
--- /dev/null
+++ b/OvmfPkg/Library/LockBoxLib/LockBoxLib.h
@@ -0,0 +1,47 @@
+/** @file
+  
+ Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
+
+ This program and the accompanying materials
+ are licensed and made available under the terms and conditions of the BSD 
License
+ which accompanies this distribution.  The full text of the license may be 
found at
+ http://opensource.org/licenses/bsd-license.php
+
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef __LOCK_BOX_LIB_IMPL_H__
+#define __LOCK_BOX_LIB_IMPL_H__
+
+
+/**
+  Allocates a buffer of type EfiACPIMemoryNVS.
+
+  Allocates the number bytes specified by AllocationSize of type
+  EfiACPIMemoryNVS and returns a pointer to the allocated buffer.
+  If AllocationSize is 0, then a valid buffer of 0 size is
+  returned.  If there is not enough memory remaining to satisfy
+  the request, then NULL is returned.
+
+  @param  AllocationSize        The number of bytes to allocate.
+
+  @return A pointer to the allocated buffer or NULL if allocation fails.
+
+**/
+VOID *
+EFIAPI
+AllocateAcpiNvsPool (
+  IN UINTN  AllocationSize
+  );
+
+
+RETURN_STATUS
+EFIAPI
+LockBoxLibInitialize (
+  VOID
+  );
+
+
+#endif
diff --git a/OvmfPkg/OvmfPkg.dec b/OvmfPkg/OvmfPkg.dec
index 8a52bb1..b8a4cd5 100644
--- a/OvmfPkg/OvmfPkg.dec
+++ b/OvmfPkg/OvmfPkg.dec
@@ -85,6 +85,8 @@
   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamBase|0x0|UINT32|0x13
   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamSize|0x0|UINT32|0x14
   gUefiOvmfPkgTokenSpaceGuid.PcdS3AcpiReservedMemoryBase|0x0|UINT32|0x17
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase|0x0|UINT32|0x18
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize|0x0|UINT32|0x19
 
 [PcdsDynamic, PcdsDynamicEx]
   gUefiOvmfPkgTokenSpaceGuid.PcdEmuVariableEvent|0|UINT64|2
diff --git a/OvmfPkg/OvmfPkgIa32.dsc b/OvmfPkg/OvmfPkgIa32.dsc
index 2986e51..3d0c226 100644
--- a/OvmfPkg/OvmfPkgIa32.dsc
+++ b/OvmfPkg/OvmfPkgIa32.dsc
@@ -99,7 +99,7 @@
   QemuFwCfgLib|OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.inf
   VirtioLib|OvmfPkg/Library/VirtioLib/VirtioLib.inf
   LoadLinuxLib|OvmfPkg/Library/LoadLinuxLib/LoadLinuxLib.inf
-  LockBoxLib|MdeModulePkg/Library/LockBoxNullLib/LockBoxNullLib.inf
+  LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
   
CustomizedDisplayLib|MdeModulePkg/Library/CustomizedDisplayLib/CustomizedDisplayLib.inf
 
 !ifdef $(SOURCE_DEBUG_ENABLE)
@@ -244,6 +244,7 @@
   DpcLib|MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.inf
   PlatformBdsLib|OvmfPkg/Library/PlatformBdsLib/PlatformBdsLib.inf
   
CpuExceptionHandlerLib|UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeCpuExceptionHandlerLib.inf
+  LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
 
 [LibraryClasses.common.UEFI_APPLICATION]
   HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf
diff --git a/OvmfPkg/OvmfPkgIa32.fdf b/OvmfPkg/OvmfPkgIa32.fdf
index ebdc77c..7e2d659 100644
--- a/OvmfPkg/OvmfPkgIa32.fdf
+++ b/OvmfPkg/OvmfPkgIa32.fdf
@@ -138,6 +138,9 @@ NumBlocks     = 0x80
 0x000000|0x006000
 
gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesSize
 
+0x006000|0x001000
+gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize
+
 0x010000|0x008000
 
gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamSize
 
diff --git a/OvmfPkg/OvmfPkgIa32X64.dsc b/OvmfPkg/OvmfPkgIa32X64.dsc
index e0582cc..a41b538 100644
--- a/OvmfPkg/OvmfPkgIa32X64.dsc
+++ b/OvmfPkg/OvmfPkgIa32X64.dsc
@@ -104,7 +104,7 @@
   QemuFwCfgLib|OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.inf
   VirtioLib|OvmfPkg/Library/VirtioLib/VirtioLib.inf
   LoadLinuxLib|OvmfPkg/Library/LoadLinuxLib/LoadLinuxLib.inf
-  LockBoxLib|MdeModulePkg/Library/LockBoxNullLib/LockBoxNullLib.inf
+  LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
   
CustomizedDisplayLib|MdeModulePkg/Library/CustomizedDisplayLib/CustomizedDisplayLib.inf
 
 !ifdef $(SOURCE_DEBUG_ENABLE)
@@ -249,6 +249,7 @@
   DpcLib|MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.inf
   PlatformBdsLib|OvmfPkg/Library/PlatformBdsLib/PlatformBdsLib.inf
   
CpuExceptionHandlerLib|UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeCpuExceptionHandlerLib.inf
+  LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
 
 [LibraryClasses.common.UEFI_APPLICATION]
   HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf
diff --git a/OvmfPkg/OvmfPkgIa32X64.fdf b/OvmfPkg/OvmfPkgIa32X64.fdf
index ad2a425..3800629 100644
--- a/OvmfPkg/OvmfPkgIa32X64.fdf
+++ b/OvmfPkg/OvmfPkgIa32X64.fdf
@@ -138,6 +138,9 @@ NumBlocks     = 0x80
 0x000000|0x006000
 
gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesSize
 
+0x006000|0x001000
+gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize
+
 0x010000|0x008000
 
gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamSize
 
diff --git a/OvmfPkg/OvmfPkgX64.dsc b/OvmfPkg/OvmfPkgX64.dsc
index 9747a75..69ddcbb 100644
--- a/OvmfPkg/OvmfPkgX64.dsc
+++ b/OvmfPkg/OvmfPkgX64.dsc
@@ -104,7 +104,7 @@
   QemuFwCfgLib|OvmfPkg/Library/QemuFwCfgLib/QemuFwCfgLib.inf
   VirtioLib|OvmfPkg/Library/VirtioLib/VirtioLib.inf
   LoadLinuxLib|OvmfPkg/Library/LoadLinuxLib/LoadLinuxLib.inf
-  LockBoxLib|MdeModulePkg/Library/LockBoxNullLib/LockBoxNullLib.inf
+  LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxBaseLib.inf
   
CustomizedDisplayLib|MdeModulePkg/Library/CustomizedDisplayLib/CustomizedDisplayLib.inf
 
 !ifdef $(SOURCE_DEBUG_ENABLE)
@@ -249,6 +249,7 @@
   DpcLib|MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.inf
   PlatformBdsLib|OvmfPkg/Library/PlatformBdsLib/PlatformBdsLib.inf
   
CpuExceptionHandlerLib|UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeCpuExceptionHandlerLib.inf
+  LockBoxLib|OvmfPkg/Library/LockBoxLib/LockBoxDxeLib.inf
 
 [LibraryClasses.common.UEFI_APPLICATION]
   HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf
diff --git a/OvmfPkg/OvmfPkgX64.fdf b/OvmfPkg/OvmfPkgX64.fdf
index 3e3b6de..dd9c659 100644
--- a/OvmfPkg/OvmfPkgX64.fdf
+++ b/OvmfPkg/OvmfPkgX64.fdf
@@ -138,6 +138,9 @@ NumBlocks     = 0x80
 0x000000|0x006000
 
gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesSize
 
+0x006000|0x001000
+gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize
+
 0x010000|0x008000
 
gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamBase|gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamSize
 
diff --git a/OvmfPkg/PlatformPei/MemDetect.c b/OvmfPkg/PlatformPei/MemDetect.c
index 091f012..dd88e1d 100644
--- a/OvmfPkg/PlatformPei/MemDetect.c
+++ b/OvmfPkg/PlatformPei/MemDetect.c
@@ -24,6 +24,7 @@ Module Name:
 //
 // The Library classes this module consumes
 //
+#include <Library/BaseMemoryLib.h>
 #include <Library/DebugLib.h>
 #include <Library/HobLib.h>
 #include <Library/IoLib.h>
@@ -201,6 +202,22 @@ MemDetect (
       EfiACPIMemoryNVS
       );
 #endif
+
+    //
+    // Reserve the lock box storage area
+    //
+    // Since this memory range will be used on S3 resume, it must be
+    // reserved as ACPI NVS.
+    //
+    ZeroMem (
+      (VOID*)(UINTN) PcdGet32 (PcdOvmfLockBoxStorageBase),
+      (UINTN) PcdGet32 (PcdOvmfLockBoxStorageSize)
+      );
+    BuildMemoryAllocationHob (
+      (EFI_PHYSICAL_ADDRESS)(UINTN) PcdGet32 (PcdOvmfLockBoxStorageBase),
+      (UINT64)(UINTN) PcdGet32 (PcdOvmfLockBoxStorageSize),
+      EfiACPIMemoryNVS
+      );
   }
 
   return LowerMemorySize;
diff --git a/OvmfPkg/PlatformPei/PlatformPei.inf 
b/OvmfPkg/PlatformPei/PlatformPei.inf
index d62863c..d67b59f 100644
--- a/OvmfPkg/PlatformPei/PlatformPei.inf
+++ b/OvmfPkg/PlatformPei/PlatformPei.inf
@@ -69,6 +69,8 @@
   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPeiTempRamSize
   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesBase
   gUefiOvmfPkgTokenSpaceGuid.PcdOvmfSecPageTablesSize
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageBase
+  gUefiOvmfPkgTokenSpaceGuid.PcdOvmfLockBoxStorageSize
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdS3AcpiReservedMemorySize
   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize
   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize
-- 
1.8.5.2


------------------------------------------------------------------------------
CenturyLink Cloud: The Leader in Enterprise Cloud Services.
Learn Why More Businesses Are Choosing CenturyLink Cloud For
Critical Workloads, Development Environments & Everything In Between.
Get a Quote or Start a Free Trial Today. 
http://pubads.g.doubleclick.net/gampad/clk?id=119420431&iu=/4140/ostg.clktrk
_______________________________________________
edk2-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/edk2-devel

Reply via email to