Fix the return status when physical presence variable and MemoryOverwriteRequestContr...

[mirror_edk2.git] / SecurityPkg / Tcg / MemoryOverwriteControl / TcgMor.c

/** @file\r
  TCG MOR (Memory Overwrite Request) Control Driver.\r
\r
  This driver initilize MemoryOverwriteRequestControl variable. It \r
  will clear MOR_CLEAR_MEMORY_BIT bit if it is set.\r
\r
Copyright (c) 2009 - 2014, Intel Corporation. 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 "TcgMor.h"\r
\r
UINT8    mMorControl;\r
\r
/**\r
  Ready to Boot Event notification handler.\r
\r
  Sequence of OS boot events is measured in this event notification handler.\r
\r
  @param[in]  Event     Event whose notification function is being invoked\r
  @param[in]  Context   Pointer to the notification function's context\r
\r
**/\r
VOID\r
EFIAPI\r
OnReadyToBoot (\r
  IN      EFI_EVENT                 Event,\r
  IN      VOID                      *Context\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       DataSize;\r
  \r
  if (MOR_CLEAR_MEMORY_VALUE (mMorControl) == 0x0) {\r
    //\r
    // MorControl is expected, directly return to avoid unnecessary variable operation\r
    //\r
    return ;\r
  }\r
  //\r
  // Clear MOR_CLEAR_MEMORY_BIT\r
  //\r
  DEBUG ((EFI_D_INFO, "TcgMor: Clear MorClearMemory bit\n"));\r
  mMorControl &= 0xFE;  \r
\r
  DataSize = sizeof (mMorControl);\r
  Status   = gRT->SetVariable (\r
               MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
               &gEfiMemoryOverwriteControlDataGuid, \r
               EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
               DataSize, \r
               &mMorControl\r
               );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((EFI_D_ERROR, "TcgMor: Clear MOR_CLEAR_MEMORY_BIT failure, Status = %r\n"));\r
  }\r
}\r
\r
\r
/**\r
  Entry Point for TCG MOR Control driver.\r
\r
  @param[in] ImageHandle  Image handle of this driver.\r
  @param[in] SystemTable  A Pointer to the EFI System Table.\r
\r
  @retval EFI_SUCEESS     \r
  @return Others          Some error occurs.\r
**/\r
EFI_STATUS\r
EFIAPI\r
MorDriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       DataSize;\r
  EFI_EVENT   Event;\r
\r
  ///\r
  /// The firmware is required to create the MemoryOverwriteRequestControl UEFI variable.\r
  ///\r
\r
  DataSize = sizeof (mMorControl);\r
  Status = gRT->GetVariable (\r
                  MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
                  &gEfiMemoryOverwriteControlDataGuid, \r
                  NULL, \r
                  &DataSize, \r
                  &mMorControl\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Set default value to 0\r
    //\r
    mMorControl = 0;\r
    Status = gRT->SetVariable (\r
                    MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, \r
                    &gEfiMemoryOverwriteControlDataGuid, \r
                    EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
                    DataSize, \r
                    &mMorControl\r
                    );\r
    DEBUG ((EFI_D_INFO, "TcgMor: Create MOR variable! Status = %r\n", Status));\r
  } else {\r
    //\r
    // Create a Ready To Boot Event and Clear the MorControl bit in the call back function.\r
    //\r
    DEBUG ((EFI_D_INFO, "TcgMor: Create ReadyToBoot Event for MorControl Bit cleanning!\n"));\r
    Status = EfiCreateEventReadyToBootEx (\r
               TPL_CALLBACK,\r
               OnReadyToBoot,\r
               NULL,\r
               &Event\r
               );\r
  }    \r
  \r
  return Status;\r
}\r
\r
\r