OvmfPkg: SmmCpuFeaturesLib: customize state save map format

[mirror_edk2.git] / OvmfPkg / SmmAccess / SmmAccess2Dxe.c

/** @file\r
\r
  A DXE_DRIVER providing SMRAM access by producing EFI_SMM_ACCESS2_PROTOCOL.\r
\r
  Q35 TSEG is expected to have been verified and set up by the SmmAccessPei\r
  driver.\r
\r
  Copyright (C) 2013, 2015, Red Hat, Inc.<BR>\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  distribution. The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <Library/DebugLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Protocol/SmmAccess2.h>\r
\r
#include "SmramInternal.h"\r
\r
/**\r
  Opens the SMRAM area to be accessible by a boot-service driver.\r
\r
  This function "opens" SMRAM so that it is visible while not inside of SMM.\r
  The function should return EFI_UNSUPPORTED if the hardware does not support\r
  hiding of SMRAM. The function should return EFI_DEVICE_ERROR if the SMRAM\r
  configuration is locked.\r
\r
  @param[in] This           The EFI_SMM_ACCESS2_PROTOCOL instance.\r
\r
  @retval EFI_SUCCESS       The operation was successful.\r
  @retval EFI_UNSUPPORTED   The system does not support opening and closing of\r
                            SMRAM.\r
  @retval EFI_DEVICE_ERROR  SMRAM cannot be opened, perhaps because it is\r
                            locked.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
SmmAccess2DxeOpen (\r
  IN EFI_SMM_ACCESS2_PROTOCOL  *This\r
  )\r
{\r
  return SmramAccessOpen (&This->LockState, &This->OpenState);\r
}\r
\r
/**\r
  Inhibits access to the SMRAM.\r
\r
  This function "closes" SMRAM so that it is not visible while outside of SMM.\r
  The function should return EFI_UNSUPPORTED if the hardware does not support\r
  hiding of SMRAM.\r
\r
  @param[in] This           The EFI_SMM_ACCESS2_PROTOCOL instance.\r
\r
  @retval EFI_SUCCESS       The operation was successful.\r
  @retval EFI_UNSUPPORTED   The system does not support opening and closing of\r
                            SMRAM.\r
  @retval EFI_DEVICE_ERROR  SMRAM cannot be closed.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
SmmAccess2DxeClose (\r
  IN EFI_SMM_ACCESS2_PROTOCOL  *This\r
  )\r
{\r
  return SmramAccessClose (&This->LockState, &This->OpenState);\r
}\r
\r
/**\r
  Inhibits access to the SMRAM.\r
\r
  This function prohibits access to the SMRAM region.  This function is usually\r
  implemented such that it is a write-once operation.\r
\r
  @param[in] This          The EFI_SMM_ACCESS2_PROTOCOL instance.\r
\r
  @retval EFI_SUCCESS      The device was successfully locked.\r
  @retval EFI_UNSUPPORTED  The system does not support locking of SMRAM.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
SmmAccess2DxeLock (\r
  IN EFI_SMM_ACCESS2_PROTOCOL  *This\r
  )\r
{\r
  return SmramAccessLock (&This->LockState, &This->OpenState);\r
}\r
\r
/**\r
  Queries the memory controller for the possible regions that will support\r
  SMRAM.\r
\r
  @param[in]     This           The EFI_SMM_ACCESS2_PROTOCOL instance.\r
  @param[in,out] SmramMapSize   A pointer to the size, in bytes, of the\r
                                SmramMemoryMap buffer.\r
  @param[in,out] SmramMap       A pointer to the buffer in which firmware\r
                                places the current memory map.\r
\r
  @retval EFI_SUCCESS           The chipset supported the given resource.\r
  @retval EFI_BUFFER_TOO_SMALL  The SmramMap parameter was too small.  The\r
                                current buffer size needed to hold the memory\r
                                map is returned in SmramMapSize.\r
**/\r
STATIC\r
EFI_STATUS\r
EFIAPI\r
SmmAccess2DxeGetCapabilities (\r
  IN CONST EFI_SMM_ACCESS2_PROTOCOL  *This,\r
  IN OUT UINTN                       *SmramMapSize,\r
  IN OUT EFI_SMRAM_DESCRIPTOR        *SmramMap\r
  )\r
{\r
  return SmramAccessGetCapabilities (This->LockState, This->OpenState,\r
           SmramMapSize, SmramMap);\r
}\r
\r
//\r
// LockState and OpenState will be filled in by the entry point.\r
//\r
STATIC EFI_SMM_ACCESS2_PROTOCOL mAccess2 = {\r
  &SmmAccess2DxeOpen,\r
  &SmmAccess2DxeClose,\r
  &SmmAccess2DxeLock,\r
  &SmmAccess2DxeGetCapabilities\r
};\r
\r
//\r
// Entry point of this driver.\r
//\r
EFI_STATUS\r
EFIAPI\r
SmmAccess2DxeEntryPoint (\r
  IN EFI_HANDLE       ImageHandle,\r
  IN EFI_SYSTEM_TABLE *SystemTable\r
  )\r
{\r
  //\r
  // This module should only be included if SMRAM support is required.\r
  //\r
  ASSERT (FeaturePcdGet (PcdSmmSmramRequire));\r
\r
  GetStates (&mAccess2.LockState, &mAccess2.OpenState);\r
  return gBS->InstallMultipleProtocolInterfaces (&ImageHandle,\r
                &gEfiSmmAccess2ProtocolGuid, &mAccess2,\r
                NULL);\r
}\r