Add in the 1st version of ECP.

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / RuntimeDxe / EfiRuntimeLib / x64 / RuntimeLib.c

/*++\r
\r
Copyright (c) 2005 - 2006, Intel Corporation                                                         \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
Module Name:\r
\r
    RuntimeLib.c\r
\r
Abstract:\r
\r
  Light weight lib to support Tiano drivers.\r
\r
--*/\r
\r
#include "Tiano.h"\r
#include "EfiRuntimeLib.h"\r
#include EFI_PROTOCOL_DEFINITION (CpuIo)\r
#include EFI_PROTOCOL_DEFINITION (FirmwareVolumeBlock)\r
#include EFI_GUID_DEFINITION (StatusCodeCallerId)\r
#include EFI_ARCH_PROTOCOL_DEFINITION (StatusCode)\r
\r
//\r
// Driver Lib Module Globals\r
//\r
static EFI_RUNTIME_SERVICES *mRT;\r
static EFI_EVENT            mRuntimeNotifyEvent     = NULL;\r
static EFI_EVENT            mEfiVirtualNotifyEvent  = NULL;\r
static BOOLEAN              mRuntimeLibInitialized  = FALSE;\r
static BOOLEAN              mEfiGoneVirtual         = FALSE;\r
\r
//\r
// Runtime Global, but you should use the Lib functions\r
//\r
EFI_CPU_IO_PROTOCOL         *gCpuIo;\r
BOOLEAN                     mEfiAtRuntime = FALSE;\r
FVB_ENTRY                   *mFvbEntry;\r
\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
static EFI_STATUS_CODE_PROTOCOL  *gStatusCode = NULL;\r
#endif\r
\r
EFI_STATUS\r
EfiConvertPointer (\r
  IN UINTN                     DebugDisposition,\r
  IN OUT VOID                  *Address\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Determines the new virtual address that is to be used on subsequent memory accesses.\r
\r
Arguments:\r
\r
  DebugDisposition  - Supplies type information for the pointer being converted.\r
  Address           - A pointer to a pointer that is to be fixed to be the value needed\r
                      for the new virtual address mappings being applied.\r
\r
Returns:\r
\r
  Status code\r
\r
--*/\r
{\r
  return mRT->ConvertPointer (DebugDisposition, Address);\r
}\r
\r
EFI_STATUS\r
EfiConvertInternalPointer (\r
  IN OUT VOID                  *Address\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Call EfiConvertPointer() to convert internal pointer.\r
\r
Arguments:\r
\r
  Address - A pointer to a pointer that is to be fixed to be the value needed\r
            for the new virtual address mappings being applied.\r
\r
Returns:\r
\r
  Status code\r
\r
--*/\r
{\r
  return EfiConvertPointer (EFI_INTERNAL_POINTER, Address);\r
}\r
\r
VOID\r
EFIAPI\r
EfiRuntimeLibFvbVirtualNotifyEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Convert all pointers in mFvbEntry after ExitBootServices.\r
\r
Arguments:\r
\r
  Event   - The Event that is being processed\r
  \r
  Context - Event Context\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  UINTN Index;\r
  if (mFvbEntry != NULL) {\r
    for (Index = 0; Index < MAX_FVB_COUNT; Index++) {\r
      if (NULL != mFvbEntry[Index].Fvb) {\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].Fvb->GetBlockSize);\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].Fvb->GetPhysicalAddress);\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].Fvb->GetVolumeAttributes);\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].Fvb->SetVolumeAttributes);\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].Fvb->Read);\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].Fvb->Write);\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].Fvb->EraseBlocks);\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].Fvb);\r
      }\r
\r
      if (NULL != mFvbEntry[Index].FvbExtension) {\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].FvbExtension->EraseFvbCustomBlock);\r
        EfiConvertInternalPointer ((VOID **) &mFvbEntry[Index].FvbExtension);\r
      }\r
    }\r
\r
    EfiConvertInternalPointer ((VOID **) &mFvbEntry);\r
  }\r
}\r
\r
VOID\r
EFIAPI\r
RuntimeDriverExitBootServices (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Set AtRuntime flag as TRUE after ExitBootServices\r
\r
Arguments:\r
\r
  Event   - The Event that is being processed\r
  \r
  Context - Event Context\r
\r
Returns: \r
\r
  None\r
\r
--*/\r
{\r
  mEfiAtRuntime = TRUE;\r
}\r
\r
extern BOOLEAN  gEfiFvbInitialized;\r
\r
VOID\r
EFIAPI\r
EfiRuntimeLibVirtualNotifyEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
/*++\r
\r
Routine Description:\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
Arguments:\r
\r
  Event   - The Event that is being processed\r
  \r
  Context - Event Context\r
\r
Returns: \r
\r
  None\r
\r
--*/\r
{\r
  EFI_EVENT_NOTIFY  ChildNotifyEventHandler;\r
\r
  if (Context != NULL) {\r
    ChildNotifyEventHandler = (EFI_EVENT_NOTIFY) (UINTN) Context;\r
    ChildNotifyEventHandler (Event, NULL);\r
  }\r
\r
  if (gEfiFvbInitialized) {\r
    EfiRuntimeLibFvbVirtualNotifyEvent (Event, Context);\r
  }\r
  //\r
  // Update global for Runtime Services Table and IO\r
  //\r
  EfiConvertInternalPointer ((VOID **) &gCpuIo);\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
  if (gStatusCode != NULL) {\r
    EfiConvertInternalPointer ((VOID **) &gStatusCode->ReportStatusCode);\r
    EfiConvertInternalPointer ((VOID **) &gStatusCode);\r
  }\r
#endif\r
  EfiConvertInternalPointer ((VOID **) &mRT);\r
\r
  //\r
  // Clear out BootService globals\r
  //\r
  gBS             = NULL;\r
  gST             = NULL;\r
  mEfiGoneVirtual = TRUE;\r
}\r
\r
EFI_STATUS\r
EfiInitializeRuntimeDriverLib (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable,\r
  IN EFI_EVENT_NOTIFY     GoVirtualChildEvent\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Intialize runtime Driver Lib if it has not yet been initialized. \r
\r
Arguments:\r
\r
  ImageHandle     - The firmware allocated handle for the EFI image.\r
  \r
  SystemTable     - A pointer to the EFI System Table.\r
\r
  GoVirtualChildEvent - Caller can register a virtual notification event.\r
\r
Returns: \r
\r
  EFI_STATUS always returns EFI_SUCCESS except EFI_ALREADY_STARTED if already started.\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
\r
  if (mRuntimeLibInitialized) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  mRuntimeLibInitialized  = TRUE;\r
\r
  gST = SystemTable;\r
  ASSERT (gST != NULL);\r
\r
  gBS = SystemTable->BootServices;\r
  ASSERT (gBS != NULL);\r
  mRT = SystemTable->RuntimeServices;\r
  ASSERT (mRT != NULL);\r
\r
  Status  = EfiLibGetSystemConfigurationTable (&gEfiDxeServicesTableGuid, (VOID **) &gDS);\r
  ASSERT_EFI_ERROR (Status);\r
\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
  Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID **)&gStatusCode);\r
  if (EFI_ERROR (Status)) {\r
    gStatusCode = NULL;\r
  }\r
#endif\r
\r
  Status = gBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, &gCpuIo);\r
  if (EFI_ERROR (Status)) {\r
    gCpuIo = NULL;\r
  }\r
\r
  //\r
  // Register our ExitBootServices () notify function\r
  //\r
  Status = gBS->CreateEvent (\r
                  EFI_EVENT_SIGNAL_EXIT_BOOT_SERVICES,\r
                  EFI_TPL_NOTIFY,\r
                  RuntimeDriverExitBootServices,\r
                  NULL,\r
                  &mRuntimeNotifyEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Register SetVirtualAddressMap () notify function\r
  //\r
  Status = gBS->CreateEvent (\r
                  EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r
                  EFI_TPL_NOTIFY,\r
                  EfiRuntimeLibVirtualNotifyEvent,\r
                  (VOID *) (UINTN) GoVirtualChildEvent,\r
                  &mEfiVirtualNotifyEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EfiShutdownRuntimeDriverLib (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine will free some resources which have been allocated in\r
  EfiInitializeRuntimeDriverLib(). If a runtime driver exits with an error, \r
  it must call this routine to free the allocated resource before the exiting.\r
\r
Arguments:\r
\r
  None\r
\r
Returns: \r
\r
  EFI_SUCCESS     - Shotdown the Runtime Driver Lib successfully\r
  EFI_UNSUPPORTED - Runtime Driver lib was not initialized at all\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
\r
  if (!mRuntimeLibInitialized) {\r
    //\r
    // You must call EfiInitializeRuntimeDriverLib() first\r
    //\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  mRuntimeLibInitialized = FALSE;\r
\r
  //\r
  // Close our ExitBootServices () notify function\r
  //\r
  if (mRuntimeNotifyEvent != NULL) {\r
    Status = gBS->CloseEvent (mRuntimeNotifyEvent);\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  //\r
  // Close SetVirtualAddressMap () notify function\r
  //\r
  if (mEfiVirtualNotifyEvent != NULL) {\r
    Status = gBS->CloseEvent (mEfiVirtualNotifyEvent);\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EfiInitializeSmmDriverLib (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Intialize runtime Driver Lib if it has not yet been initialized. \r
\r
Arguments:\r
\r
  ImageHandle     - The firmware allocated handle for the EFI image.\r
  \r
  SystemTable     - A pointer to the EFI System Table.\r
\r
Returns: \r
\r
  EFI_STATUS always returns EFI_SUCCESS except EFI_ALREADY_STARTED if already started.\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
\r
  if (mRuntimeLibInitialized) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  mRuntimeLibInitialized  = TRUE;\r
\r
  gST = SystemTable;\r
  ASSERT (gST != NULL);\r
\r
  gBS = SystemTable->BootServices;\r
  ASSERT (gBS != NULL);\r
  mRT = SystemTable->RuntimeServices;\r
  ASSERT (mRT != NULL);\r
\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
  Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID **)&gStatusCode);\r
  if (EFI_ERROR (Status)) {\r
    gStatusCode = NULL;\r
  }\r
#endif\r
\r
  Status  = gBS->LocateProtocol (&gEfiCpuIoProtocolGuid, NULL, &gCpuIo);\r
  if (EFI_ERROR (Status)) {\r
    gCpuIo = NULL;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
BOOLEAN\r
EfiAtRuntime (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
  Return TRUE if ExitBootServices () has been called\r
\r
Arguments:\r
  NONE\r
\r
Returns: \r
  TRUE - If ExitBootServices () has been called\r
\r
--*/\r
{\r
  return mEfiAtRuntime;\r
}\r
\r
BOOLEAN\r
EfiGoneVirtual (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
  Return TRUE if SetVirtualAddressMap () has been called\r
\r
Arguments:\r
  NONE\r
\r
Returns: \r
  TRUE - If SetVirtualAddressMap () has been called\r
\r
--*/\r
{\r
  return mEfiGoneVirtual;\r
}\r
//\r
// The following functions hide the mRT local global from the call to\r
// runtime service in the EFI system table.\r
//\r
EFI_STATUS\r
EfiGetTime (\r
  OUT EFI_TIME                    *Time,\r
  OUT EFI_TIME_CAPABILITIES       *Capabilities\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Returns the current time and date information, and the time-keeping \r
  capabilities of the hardware platform.\r
\r
Arguments:\r
\r
  Time          - A pointer to storage to receive a snapshot of the current time.\r