Library/SmmLockBoxLib/SmmLockBoxDxeLib.c

4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2010, 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 <PiDxe.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/UefiBootServicesTableLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/UefiRuntimeServicesTableLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/BaseLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/BaseMemoryLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/LockBoxLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/DebugLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Protocol/SmmCommunication.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Guid/SmmLockBox.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include "SmmLockBoxLibPrivate.h"
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  EFI_STATUS                      Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATION_PROTOCOL  *SmmCommunication;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_LOCK_BOX_PARAMETER_SAVE *LockBoxParameterSave;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATE_HEADER      *CommHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINT8                           CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SAVE)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINTN                           CommSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SaveLockBox - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Basic check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Get needed resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = gBS->LocateProtocol (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  &gEfiSmmCommunicationProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  (VOID **)&SmmCommunication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_NOT_STARTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Prepare parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader->MessageLength = sizeof(*LockBoxParameterSave);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSave = (EFI_SMM_LOCK_BOX_PARAMETER_SAVE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSave->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_SAVE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSave->Header.DataLength = sizeof(*LockBoxParameterSave);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSave->Header.ReturnStatus = (UINT64)-1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&LockBoxParameterSave->Guid, Guid, sizeof(*Guid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSave->Buffer     = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSave->Length     = (UINT64)Length;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Send command
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommSize = sizeof(CommBuffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = SmmCommunication->Communicate (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               SmmCommunication,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommBuffer[0],
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = (EFI_STATUS)LockBoxParameterSave->Header.ReturnStatus;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SaveLockBox - Exit (%r)\n", Status));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return Status;
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  EFI_STATUS                                Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATION_PROTOCOL            *SmmCommunication;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *LockBoxParameterSetAttributes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATE_HEADER                *CommHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINT8                                     CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINTN                                     CommSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SetLockBoxAttributes - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Basic check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ((Guid == NULL) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      ((Attributes & ~LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE) != 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Get needed resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = gBS->LocateProtocol (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  &gEfiSmmCommunicationProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  (VOID **)&SmmCommunication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_NOT_STARTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Prepare parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader->MessageLength = sizeof(*LockBoxParameterSetAttributes);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSetAttributes = (EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSetAttributes->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_SET_ATTRIBUTES;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSetAttributes->Header.DataLength = sizeof(*LockBoxParameterSetAttributes);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSetAttributes->Header.ReturnStatus = (UINT64)-1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&LockBoxParameterSetAttributes->Guid, Guid, sizeof(*Guid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterSetAttributes->Attributes = (UINT64)Attributes;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Send command
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommSize = sizeof(CommBuffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = SmmCommunication->Communicate (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               SmmCommunication,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommBuffer[0],
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = (EFI_STATUS)LockBoxParameterSetAttributes->Header.ReturnStatus;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib SetLockBoxAttributes - Exit (%r)\n", Status));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return Status;
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  EFI_STATUS                        Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATION_PROTOCOL    *SmmCommunication;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *LockBoxParameterUpdate;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATE_HEADER        *CommHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINT8                             CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_UPDATE)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINTN                             CommSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib UpdateLockBox - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Basic check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ((Guid == NULL) || (Buffer == NULL) || (Length == 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Get needed resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = gBS->LocateProtocol (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  &gEfiSmmCommunicationProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  (VOID **)&SmmCommunication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_NOT_STARTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Prepare parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader->MessageLength = sizeof(*LockBoxParameterUpdate);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterUpdate = (EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *)(UINTN)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterUpdate->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_UPDATE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterUpdate->Header.DataLength = sizeof(*LockBoxParameterUpdate);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)-1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&LockBoxParameterUpdate->Guid, Guid, sizeof(*Guid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterUpdate->Offset = (UINT64)Offset;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterUpdate->Buffer = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterUpdate->Length = (UINT64)Length;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Send command
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommSize = sizeof(CommBuffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = SmmCommunication->Communicate (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               SmmCommunication,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommBuffer[0],
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = (EFI_STATUS)LockBoxParameterUpdate->Header.ReturnStatus;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib UpdateLockBox - Exit (%r)\n", Status));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return Status;
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  EFI_STATUS                         Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATION_PROTOCOL     *SmmCommunication;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *LockBoxParameterRestore;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATE_HEADER         *CommHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINT8                              CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINTN                              CommSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreLockBox - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Basic check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if ((Guid == NULL) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      ((Buffer == NULL) && (Length != NULL)) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync      ((Buffer != NULL) && (Length == NULL))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Get needed resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = gBS->LocateProtocol (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  &gEfiSmmCommunicationProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  (VOID **)&SmmCommunication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_NOT_STARTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Prepare parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader->MessageLength = sizeof(*LockBoxParameterRestore);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestore = (EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestore->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_RESTORE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestore->Header.DataLength = sizeof(*LockBoxParameterRestore);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestore->Header.ReturnStatus = (UINT64)-1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&LockBoxParameterRestore->Guid, Guid, sizeof(*Guid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestore->Buffer = (EFI_PHYSICAL_ADDRESS)(UINTN)Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (Length != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    LockBoxParameterRestore->Length = (EFI_PHYSICAL_ADDRESS)*Length;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    LockBoxParameterRestore->Length = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Send command
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommSize = sizeof(CommBuffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = SmmCommunication->Communicate (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               SmmCommunication,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommBuffer[0],
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (Length != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    *Length = (UINTN)LockBoxParameterRestore->Length;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = (EFI_STATUS)LockBoxParameterRestore->Header.ReturnStatus;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreLockBox - Exit (%r)\n", Status));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return Status;
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  EFI_STATUS                                      Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATION_PROTOCOL                  *SmmCommunication;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *LockBoxParameterRestoreAllInPlace;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  EFI_SMM_COMMUNICATE_HEADER                      *CommHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINT8                                           CommBuffer[sizeof(EFI_GUID) + sizeof(UINTN) + sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  UINTN                                           CommSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreAllLockBoxInPlace - Enter\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Get needed resource
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = gBS->LocateProtocol (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  &gEfiSmmCommunicationProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  (VOID **)&SmmCommunication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                  );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  if (EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync    return EFI_NOT_STARTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Prepare parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader = (EFI_SMM_COMMUNICATE_HEADER *)&CommBuffer[0];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CopyMem (&CommHeader->HeaderGuid, &gEfiSmmLockBoxCommunicationGuid, sizeof(gEfiSmmLockBoxCommunicationGuid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommHeader->MessageLength = sizeof(*LockBoxParameterRestoreAllInPlace);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestoreAllInPlace = (EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *)&CommBuffer[OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER, Data)];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestoreAllInPlace->Header.Command    = EFI_SMM_LOCK_BOX_COMMAND_RESTORE_ALL_IN_PLACE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestoreAllInPlace->Header.DataLength = sizeof(*LockBoxParameterRestoreAllInPlace);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  LockBoxParameterRestoreAllInPlace->Header.ReturnStatus = (UINT64)-1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Send command
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  CommSize = sizeof(CommBuffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = SmmCommunication->Communicate (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               SmmCommunication,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommBuffer[0],
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               &CommSize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync                               );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  Status = (EFI_STATUS)LockBoxParameterRestoreAllInPlace->Header.ReturnStatus;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  DEBUG ((EFI_D_INFO, "SmmLockBoxDxeLib RestoreAllLockBoxInPlace - Exit (%r)\n", Status));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  // Done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync  return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync