Library/SmmLockBoxLib/SmmLockBoxSmmLib.c

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncof the BSD License which accompanies this distribution.  The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncfull text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <PiSmm.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/SmmServicesTableLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/BaseLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/BaseMemoryLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/LockBoxLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/DebugLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Guid/SmmLockBox.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include "SmmLockBoxLibPrivate.h"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  We need handle this library carefully. Only one library instance will construct the environment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Below 2 global variable can only be used in constructor. They should NOT be used in any other library functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSMM_LOCK_BOX_CONTEXT mSmmLockBoxContext;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncLIST_ENTRY           mLockBoxQueue = INITIALIZE_LIST_HEAD_VARIABLE (mLockBoxQueue);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This function return SmmLockBox context from SMST.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @return SmmLockBox context from SMST.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSMM_LOCK_BOX_CONTEXT *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncInternalGetSmmLockBoxContext (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINTN   Index;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Check if gEfiSmmLockBoxCommunicationGuid is installed by someone
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  for (Index = 0; Index < gSmst->NumberOfTableEntries; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    if (CompareGuid (&gSmst->SmmConfigurationTable[Index].VendorGuid, &gEfiSmmLockBoxCommunicationGuid)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      // Found. That means some other library instance is already run.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      // No need to install again, just return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      return (SMM_LOCK_BOX_CONTEXT *)gSmst->SmmConfigurationTable[Index].VendorTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Constructor for SmmLockBox library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This is used to set SmmLockBox context, which will be used in PEI phase in S3 boot path later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param[in] ImageHandle  Image handle of this driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param[in] SystemTable  A Pointer to the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval EFI_SUCEESS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @return Others          Some error occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSmmLockBoxSmmConstructuor (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN EFI_HANDLE        ImageHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN EFI_SYSTEM_TABLE  *SystemTable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_STATUS           Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SMM_LOCK_BOX_CONTEXT *SmmLockBoxContext;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxSmmConstructuor - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Check if gEfiSmmLockBoxCommunicationGuid is installed by someone
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SmmLockBoxContext = InternalGetSmmLockBoxContext ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (SmmLockBoxContext != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    // Find it. That means some other library instance is already run.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    // No need to install again, just return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxContext - already installed\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxSmmConstructuor - Exit\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // If no one install this, it means this is first instance. Install it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (sizeof(UINTN) == sizeof(UINT64)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    mSmmLockBoxContext.Signature = SMM_LOCK_BOX_SIGNATURE_64;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    mSmmLockBoxContext.Signature = SMM_LOCK_BOX_SIGNATURE_32;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  mSmmLockBoxContext.LockBoxDataAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)&mLockBoxQueue;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = gSmst->SmmInstallConfigurationTable (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    gSmst,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    &gEfiSmmLockBoxCommunicationGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    &mSmmLockBoxContext,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    sizeof(mSmmLockBoxContext)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxContext - %x\n", (UINTN)&mSmmLockBoxContext));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib LockBoxDataAddress - %x\n", (UINTN)&mLockBoxQueue));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SmmLockBoxSmmConstructuor - Exit\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This function return SmmLockBox queue address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @return SmmLockBox queue address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncLIST_ENTRY *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncInternalGetLockBoxQueue (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SMM_LOCK_BOX_CONTEXT        *SmmLockBoxContext;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SmmLockBoxContext = InternalGetSmmLockBoxContext ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT (SmmLockBoxContext != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (SmmLockBoxContext == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return (LIST_ENTRY *)(UINTN)SmmLockBoxContext->LockBoxDataAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This function find LockBox by GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Guid The guid to indentify the LockBox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @return LockBoxData
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSMM_LOCK_BOX_DATA *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncInternalFindLockBoxByGuid (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN EFI_GUID   *Guid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LIST_ENTRY                    *Link;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SMM_LOCK_BOX_DATA             *LockBox;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LIST_ENTRY                    *LockBoxQueue;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxQueue = InternalGetLockBoxQueue ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT (LockBoxQueue != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  for (Link = LockBoxQueue->ForwardLink;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync       Link != LockBoxQueue;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync       Link = Link->ForwardLink) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    LockBox = BASE_CR (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                Link,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                SMM_LOCK_BOX_DATA,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                Link
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    if (CompareGuid (&LockBox->Guid, Guid)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      return LockBox;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This function will save confidential information to lockbox.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Guid       the guid to identify the confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Buffer     the address of the confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Length     the length of the confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_SUCCESS            the information is saved successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_ALREADY_STARTED    the requested GUID already exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_OUT_OF_RESOURCES   no enough resource to save the information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSaveLockBox (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  GUID                        *Guid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  VOID                        *Buffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  UINTN                       Length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SMM_LOCK_BOX_DATA           *LockBox;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_PHYSICAL_ADDRESS        SmramBuffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_STATUS                  Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LIST_ENTRY                  *LockBoxQueue;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Basic check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_INVALID_PARAMETER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Find LockBox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox = InternalFindLockBoxByGuid (Guid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (LockBox != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_ALREADY_STARTED));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_ALREADY_STARTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Allocate SMRAM buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = gSmst->SmmAllocatePages (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    AllocateAnyPages,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    EfiRuntimeServicesData,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    EFI_SIZE_TO_PAGES (Length),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    &SmramBuffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_OUT_OF_RESOURCES));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_OUT_OF_RESOURCES;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Allocate LockBox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = gSmst->SmmAllocatePool (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    EfiRuntimeServicesData,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    sizeof(*LockBox),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    (VOID **)&LockBox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                    );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    gSmst->SmmFreePages (SmramBuffer, EFI_SIZE_TO_PAGES (Length));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_OUT_OF_RESOURCES));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_OUT_OF_RESOURCES;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Save data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem ((VOID *)(UINTN)SmramBuffer, (VOID *)(UINTN)Buffer, Length);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Insert LockBox to queue
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox->Signature   = SMM_LOCK_BOX_DATA_SIGNATURE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&LockBox->Guid, Guid, sizeof(EFI_GUID));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox->Buffer      = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox->Length      = (UINT64)Length;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox->Attributes  = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox->SmramBuffer = SmramBuffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxQueue = InternalGetLockBoxQueue ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT (LockBoxQueue != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  InsertTailList (LockBoxQueue, &LockBox->Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SaveLockBox - Exit (%r)\n", EFI_SUCCESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This function will set lockbox attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Guid       the guid to identify the confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Attributes the attributes of the lockbox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_SUCCESS            the information is saved successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_INVALID_PARAMETER  attributes is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_NOT_FOUND          the requested GUID not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSetLockBoxAttributes (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  GUID                        *Guid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  UINT64                      Attributes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SMM_LOCK_BOX_DATA              *LockBox;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SetLockBoxAttributes - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Basic check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ((Guid == NULL) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      ((Attributes & ~LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) != 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SetLockBoxAttributes - Exit (%r)\n", EFI_INVALID_PARAMETER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Find LockBox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox = InternalFindLockBoxByGuid (Guid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (LockBox == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SetLockBoxAttributes - Exit (%r)\n", EFI_NOT_FOUND));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Update data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox->Attributes = Attributes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib SetLockBoxAttributes - Exit (%r)\n", EFI_SUCCESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This function will update confidential information to lockbox.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Guid   the guid to identify the original confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Offset the offset of the original confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Buffer the address of the updated confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Length the length of the updated confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_SUCCESS            the information is saved successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or Buffer is NULL, or Length is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_NOT_FOUND          the requested GUID not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_BUFFER_TOO_SMALL   the original buffer to too small to hold new information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_ACCESS_DENIED      it is too late to invoke this interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUpdateLockBox (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  GUID                        *Guid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  UINTN                       Offset,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  VOID                        *Buffer,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  UINTN                       Length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SMM_LOCK_BOX_DATA             *LockBox;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Basic check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_INVALID_PARAMETER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Find LockBox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox = InternalFindLockBoxByGuid (Guid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (LockBox == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_NOT_FOUND));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Update data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (LockBox->Length < Offset + Length) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_BUFFER_TOO_SMALL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_BUFFER_TOO_SMALL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem ((VOID *)((UINTN)LockBox->SmramBuffer + Offset), Buffer, Length);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib UpdateLockBox - Exit (%r)\n", EFI_SUCCESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This function will restore confidential information from lockbox.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Guid   the guid to identify the confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Buffer the address of the restored confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                NULL means restored to original address, Length MUST be NULL at same time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @param Length the length of the restored confidential information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_SUCCESS            the information is restored successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_INVALID_PARAMETER  the Guid is NULL, or one of Buffer and Length is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_WRITE_PROTECTED    Buffer and Length are NULL, but the LockBox has no
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                                    LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE attribute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_BUFFER_TOO_SMALL   the Length is too small to hold the confidential information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_NOT_FOUND          the requested GUID not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_ACCESS_DENIED      not allow to restore to the address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRestoreLockBox (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  GUID                        *Guid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  VOID                        *Buffer, OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  IN  OUT UINTN                   *Length  OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SMM_LOCK_BOX_DATA              *LockBox;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  VOID                           *RestoreBuffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Restore this, Buffer and Length MUST be both NULL or both non-NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ((Guid == NULL) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      ((Buffer == NULL) && (Length != NULL)) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      ((Buffer != NULL) && (Length == NULL))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_INVALID_PARAMETER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Find LockBox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBox = InternalFindLockBoxByGuid (Guid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (LockBox == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    // Not found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_NOT_FOUND));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_NOT_FOUND;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Set RestoreBuffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (Buffer != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    // restore to new buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    RestoreBuffer = Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    // restore to original buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    if ((LockBox->Attributes & LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_WRITE_PROTECTED));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      return EFI_WRITE_PROTECTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    RestoreBuffer = (VOID *)(UINTN)LockBox->Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Set RestoreLength
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (Length != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    if (*Length < (UINTN)LockBox->Length) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      // Input buffer is too small to hold all data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      *Length = (UINTN)LockBox->Length;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_BUFFER_TOO_SMALL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      return EFI_BUFFER_TOO_SMALL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    *Length = (UINTN)LockBox->Length;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Restore data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (RestoreBuffer, (VOID *)(UINTN)LockBox->SmramBuffer, (UINTN)LockBox->Length);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreLockBox - Exit (%r)\n", EFI_SUCCESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  This function will restore confidential information from all lockbox which have RestoreInPlace attribute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_SUCCESS            the information is restored successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_NOT_STARTED        it is too early to invoke this interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  @retval RETURN_UNSUPPORTED        the service is not supported by implementaion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRETURN_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRestoreAllLockBoxInPlace (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  SMM_LOCK_BOX_DATA             *LockBox;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LIST_ENTRY                    *Link;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LIST_ENTRY                    *LockBoxQueue;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreAllLockBoxInPlace - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxQueue = InternalGetLockBoxQueue ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT (LockBoxQueue != NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Restore all, Buffer and Length MUST be NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  for (Link = LockBoxQueue->ForwardLink;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync       Link != LockBoxQueue;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync       Link = Link->ForwardLink) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    LockBox = BASE_CR (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                Link,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                SMM_LOCK_BOX_DATA,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                Link
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    if ((LockBox->Attributes & LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      // Restore data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      CopyMem ((VOID *)(UINTN)LockBox->Buffer, (VOID *)(UINTN)LockBox->SmramBuffer, (UINTN)LockBox->Length);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxSmmLib RestoreAllLockBoxInPlace - Exit (%r)\n", EFI_SUCCESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync