Code have been checked with spec

[mirror_edk2.git] / MdePkg / Library / UefiRuntimeLib / RuntimeLib.c

/** @file\r
  UEFI Runtime Library implementation for non IPF processor types.\r
\r
Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
All rights reserved. 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 "RuntimeLibInternal.h"\r
\r
///\r
/// Driver Lib Module Globals\r
///\r
\r
EFI_EVENT              mEfiVirtualNotifyEvent;\r
EFI_EVENT              mEfiExitBootServicesEvent;\r
BOOLEAN                mEfiGoneVirtual         = FALSE;\r
BOOLEAN                mEfiAtRuntime           = FALSE;\r
EFI_RUNTIME_SERVICES          *mRT;\r
\r
/**\r
  Set AtRuntime flag as TRUE after ExitBootServices.\r
\r
  @param[in]  Event   The Event that is being processed\r
  @param[in]  Context Event Context\r
**/\r
VOID\r
EFIAPI\r
RuntimeLibExitBootServicesEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  //\r
  // Clear out BootService globals\r
  //\r
  gBS             = NULL;\r
\r
  mEfiAtRuntime = TRUE;\r
}\r
\r
/**\r
  Fixup internal data so that EFI can be call in virtual mode.\r
  Call the passed in Child Notify event and convert any pointers in\r
  lib to virtual mode.\r
\r
  @param[in]    Event   The Event that is being processed\r
  @param[in]    Context Event Context\r
**/\r
VOID\r
EFIAPI\r
RuntimeLibVirtualNotifyEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  //\r
  // Update global for Runtime Services Table and IO\r
  //\r
  EfiConvertPointer (0, (VOID **) &mRT);\r
\r
  mEfiGoneVirtual = TRUE;\r
}\r
\r
/**\r
  Intialize runtime Driver Lib if it has not yet been initialized.\r
  It will ASSERT() if gRT is NULL or gBS is NULL.\r
  It will ASSERT() if that operation fails.\r
\r
  @param[in]  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param[in]  SystemTable   A pointer to the EFI System Table.\r
\r
  @return     EFI_STATUS    always returns EFI_SUCCESS except EFI_ALREADY_STARTED if already started.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverLibConstruct (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  ASSERT (gRT != NULL);\r
  ASSERT (gBS != NULL);\r
\r
  mRT = gRT;\r
  //\r
  // Register SetVirtualAddressMap () notify function\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r
                  TPL_NOTIFY,\r
                  RuntimeLibVirtualNotifyEvent,\r
                  NULL,\r
                  &mEfiVirtualNotifyEvent\r
                  );\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_SIGNAL_EXIT_BOOT_SERVICES,\r
                  TPL_NOTIFY,\r
                  RuntimeLibExitBootServicesEvent,\r
                  NULL,\r
                  &mEfiExitBootServicesEvent\r
                  );\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
\r
/**\r
  If a runtime driver exits with an error, it must call this routine \r
  to free the allocated resource before the exiting.\r
  It will ASSERT() if gBS is NULL.\r
  It will ASSERT() if that operation fails.\r
\r
  @param[in]  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param[in]  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval     EFI_SUCCESS       Shutdown the Runtime Driver Lib successfully\r
  @retval     EFI_UNSUPPORTED   Runtime Driver lib was not initialized at all\r
**/\r
EFI_STATUS\r
EFIAPI\r
RuntimeDriverLibDeconstruct (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Close SetVirtualAddressMap () notify function\r
  //\r
  ASSERT (gBS != NULL);\r
  Status = gBS->CloseEvent (mEfiVirtualNotifyEvent);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = gBS->CloseEvent (mEfiExitBootServicesEvent);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
\r
/**\r
  This function allows the caller to determine if UEFI ExitBootServices() has been called.\r
\r
  This function returns TRUE after all the EVT_SIGNAL_EXIT_BOOT_SERVICES functions have\r
  executed as a result of the OS calling ExitBootServices().  Prior to this time FALSE\r
  is returned. This function is used by runtime code to decide it is legal to access\r
  services that go away after ExitBootServices().\r
\r
  @retval  TRUE  The system has finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.\r
  @retval  FALSE The system has not finished executing the EVT_SIGNAL_EXIT_BOOT_SERVICES event.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
EfiAtRuntime (\r
  VOID\r
  )\r
{\r
  return mEfiAtRuntime;\r
}\r
\r
/**\r
  This function allows the caller to determine if UEFI SetVirtualAddressMap() has been called. \r
\r
  This function returns TRUE after all the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE functions have\r
  executed as a result of the OS calling SetVirtualAddressMap(). Prior to this time FALSE\r
  is returned. This function is used by runtime code to decide it is legal to access services\r
  that go away after SetVirtualAddressMap().\r
\r
  @retval  TRUE  The system has finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r
  @retval  FALSE The system has not finished executing the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
EfiGoneVirtual (\r
  VOID\r
  )\r
{\r
  return mEfiGoneVirtual;\r
}\r
\r