MdeModulePkg/FaultTolerantWriteDxe: implement standalone MM version

[mirror_edk2.git] / MdeModulePkg / Universal / FaultTolerantWriteDxe / FaultTolerantWriteTraditionalMm.c

/** @file\r
\r
  Parts of the SMM/MM implementation that are specific to traditional MM\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved. <BR>\r
Copyright (c) 2018, Linaro, Ltd. All rights reserved. <BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this 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,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <Library/SmmMemLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include "FaultTolerantWrite.h"\r
#include "FaultTolerantWriteSmmCommon.h"\r
\r
/**\r
  This function checks if the buffer is valid per processor architecture and\r
  does not overlap with SMRAM.\r
\r
  @param Buffer The buffer start address to be checked.\r
  @param Length The buffer length to be checked.\r
\r
  @retval TRUE  This buffer is valid per processor architecture and does not\r
                overlap with SMRAM.\r
  @retval FALSE This buffer is not valid per processor architecture or overlaps\r
                with SMRAM.\r
**/\r
BOOLEAN\r
FtwSmmIsBufferOutsideSmmValid (\r
  IN EFI_PHYSICAL_ADDRESS  Buffer,\r
  IN UINT64                Length\r
  )\r
{\r
  return SmmIsBufferOutsideSmmValid (Buffer, Length);\r
}\r
\r
/**\r
  Internal implementation of CRC32. Depending on the execution context\r
  (traditional SMM or DXE vs standalone MM), this function is implemented\r
  via a call to the CalculateCrc32 () boot service, or via a library\r
  call.\r
\r
  If Buffer is NULL, then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
  @param[in]  Buffer       A pointer to the buffer on which the 32-bit CRC is\r
                           to be computed.\r
  @param[in]  Length       The number of bytes in the buffer Data.\r
\r
  @retval Crc32            The 32-bit CRC was computed for the data buffer.\r
\r
**/\r
UINT32\r
FtwCalculateCrc32 (\r
  IN  VOID                         *Buffer,\r
  IN  UINTN                        Length\r
  )\r
{\r
  EFI_STATUS    Status;\r
  UINT32        ReturnValue;\r
\r
  Status = gBS->CalculateCrc32 (Buffer, Length, &ReturnValue);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return ReturnValue;\r
}\r
\r
/**\r
  Notify the system that the SMM FTW driver is ready\r
**/\r
VOID\r
FtwNotifySmmReady (\r
  VOID\r
  )\r
{\r
  EFI_HANDLE          FtwHandle;\r
  EFI_STATUS          Status;\r
\r
  FtwHandle = NULL;\r
  Status = gBS->InstallProtocolInterface (\r
                  &FtwHandle,\r
                  &gEfiSmmFaultTolerantWriteProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
  This function is the entry point of the Fault Tolerant Write driver.\r
\r
  @param[in] ImageHandle        A handle for the image that is initializing this driver\r
  @param[in] SystemTable        A pointer to the EFI system table\r
\r
  @retval EFI_SUCCESS           The initialization finished successfully.\r
  @retval EFI_OUT_OF_RESOURCES  Allocate memory error\r
  @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmFaultTolerantWriteInitialize (\r
  IN EFI_HANDLE            ImageHandle,\r
  IN EFI_SYSTEM_TABLE      *SystemTable\r
  )\r
{\r
  return MmFaultTolerantWriteInitialize ();\r
}\r