1) Add in EBC build support.

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

/*++\r
\r
Copyright (c) 2004 - 2005, 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 Sal drivers.\r
\r
--*/\r
\r
#include "Tiano.h"\r
#include "EfiRuntimeLib.h"\r
#include EFI_PROTOCOL_DEFINITION (ExtendedSalBootService)\r
#include EFI_PROTOCOL_DEFINITION (ExtendedSalGuid)\r
#include "IpfDefines.h"\r
#include "SalApi.h"\r
\r
//\r
// Worker functions in EsalLib.s\r
//\r
SAL_RETURN_REGS\r
GetEsalEntryPoint (\r
  VOID\r
  );\r
\r
SAL_RETURN_REGS\r
SetEsalPhysicalEntryPoint (\r
  IN  UINT64  EntryPoint,\r
  IN  UINT64  Gp\r
  );\r
\r
SAL_RETURN_REGS\r
SetEsalVirtualEntryPoint (\r
  IN  UINT64  EntryPoint,\r
  IN  UINT64  Gp\r
  );\r
\r
VOID\r
SalFlushCache (\r
  IN EFI_PHYSICAL_ADDRESS  Start,\r
  IN UINT64                Length\r
  );\r
\r
//\r
// Module Globals. It's not valid to use these after the\r
// EfiRuntimeLibVirtualNotifyEvent has fired.\r
//\r
static EFI_EVENT                          mEfiVirtualNotifyEvent;\r
static EFI_RUNTIME_SERVICES               *mRT;\r
static EFI_PLABEL                         mPlabel;\r
static EXTENDED_SAL_BOOT_SERVICE_PROTOCOL *mEsalBootService;\r
static BOOLEAN                            mRuntimeLibInitialized = FALSE;\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 and SAL 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  ChildNotify;\r
\r
  if (Context != NULL) {\r
    //\r
    // Call child event\r
    //\r
    ChildNotify = (EFI_EVENT_NOTIFY) (UINTN) Context;\r
    ChildNotify (Event, NULL);\r
  }\r
\r
  mRT->ConvertPointer (EFI_INTERNAL_POINTER, (VOID **) &mPlabel.EntryPoint);\r
  mRT->ConvertPointer (EFI_INTERNAL_POINTER | EFI_IPF_GP_POINTER, (VOID **) &mPlabel.GP);\r
\r
  SetEsalVirtualEntryPoint (mPlabel.EntryPoint, mPlabel.GP);\r
\r
  //\r
  // Clear out BootService globals\r
  //\r
  gBS = NULL;\r
  gST = NULL;\r
  mRT = NULL;\r
\r
  //\r
  // Pointers don't work you must use a direct lib call\r
  //\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
  EFI_PLABEL  *Plabel;\r
\r
  if (mRuntimeLibInitialized) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  mRuntimeLibInitialized  = TRUE;\r
\r
  gST                     = SystemTable;\r
  gBS                     = SystemTable->BootServices;\r
  mRT                     = SystemTable->RuntimeServices;\r
  Status                  = EfiLibGetSystemConfigurationTable (&gEfiDxeServicesTableGuid, (VOID **) &gDS);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // The protocol contains a function pointer, which is an indirect procedure call.\r
  // An indirect procedure call goes through a plabel, and pointer to a function is\r
  // a pointer to a plabel. To implement indirect procedure calls that can work in\r
  // both physical and virtual mode, two plabels are required (one physical and one\r
  // virtual). So lets grap the physical PLABEL for the EsalEntryPoint and store it\r
  // away. We cache it in a module global, so we can register the vitrual version.\r
  //\r
  Status = gBS->LocateProtocol (&gEfiExtendedSalBootServiceProtocolGuid, NULL, &mEsalBootService);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Plabel              = (EFI_PLABEL *) (UINTN) mEsalBootService->ExtendedSalProc;\r
\r
  mPlabel.EntryPoint  = Plabel->EntryPoint;\r
  mPlabel.GP          = Plabel->GP;\r
\r
  SetEsalPhysicalEntryPoint (mPlabel.EntryPoint, mPlabel.GP);\r
\r
  //\r
  // Create a Virtual address change notification event. Pass in the callers\r
  // GoVirtualChildEvent so it's get passed to the event as contex.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r
                  EFI_TPL_NOTIFY,\r
                  EfiRuntimeLibVirtualNotifyEvent,\r
                  (VOID *) 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 SetVirtualAddressMap () notify function\r
  //\r
  Status = gBS->CloseEvent (mEfiVirtualNotifyEvent);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
    \r
EFI_STATUS\r
RegisterEsalFunction (\r
  IN  UINT64                                    FunctionId,\r
  IN  EFI_GUID                                  *ClassGuid,\r
  IN  SAL_INTERNAL_EXTENDED_SAL_PROC            Function,\r
  IN  VOID                                      *ModuleGlobal\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Register ESAL Class Function and it's asociated global.\r
  This function is boot service only!\r
\r
Arguments:\r
  FunctionId    - ID of function to register\r
  ClassGuid     - GUID of function class \r
  Function      - Function to register under ClassGuid/FunctionId pair\r
  ModuleGlobal  - Module global for Function.\r
\r
Returns: \r
  EFI_SUCCESS - If ClassGuid/FunctionId Function was registered.\r
\r
--*/\r
{\r
  return mEsalBootService->AddExtendedSalProc (\r
                            mEsalBootService,\r
                            ClassGuid,\r
                            FunctionId,\r
                            Function,\r
                            ModuleGlobal\r
                            );\r
}\r
\r
EFI_STATUS\r
RegisterEsalClass (\r
  IN  EFI_GUID                                  *ClassGuid,\r
  IN  VOID                                      *ModuleGlobal,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Register ESAL Class and it's asociated global.\r
  This function is boot service only!\r
\r
Arguments:\r
  ClassGuid     - GUID of function class \r
  ModuleGlobal  - Module global for Function.\r
  ...           - SAL_INTERNAL_EXTENDED_SAL_PROC and FunctionId pairs. NULL \r
                  indicates the end of the list.\r
\r
Returns: \r
  EFI_SUCCESS - All members of ClassGuid registered\r
\r
--*/\r
{\r
  VA_LIST                         Args;\r
  EFI_STATUS                      Status;\r
  SAL_INTERNAL_EXTENDED_SAL_PROC  Function;\r
  UINT64                          FunctionId;\r
  EFI_HANDLE                      NewHandle;\r
\r
  VA_START (Args, ModuleGlobal);\r
\r
  Status = EFI_SUCCESS;\r
  while (!EFI_ERROR (Status)) {\r
    Function = (SAL_INTERNAL_EXTENDED_SAL_PROC) VA_ARG (Args, SAL_INTERNAL_EXTENDED_SAL_PROC);\r
    if (Function == NULL) {\r
      break;\r
    }\r
\r
    FunctionId  = VA_ARG (Args, UINT64);\r
\r
    Status      = RegisterEsalFunction (FunctionId, ClassGuid, Function, ModuleGlobal);\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  NewHandle = NULL;\r
  return gBS->InstallProtocolInterface (\r
                &NewHandle,\r
                ClassGuid,\r
                EFI_NATIVE_INTERFACE,\r
                NULL\r
                );\r
}\r
\r
SAL_RETURN_REGS\r
EfiCallEsalService (\r
  IN  EFI_GUID                                      *ClassGuid,\r
  IN  UINT64                                        FunctionId,\r
  IN  UINT64                                        Arg2,\r
  IN  UINT64                                        Arg3,\r
  IN  UINT64                                        Arg4,\r
  IN  UINT64                                        Arg5,\r
  IN  UINT64                                        Arg6,\r
  IN  UINT64                                        Arg7,\r
  IN  UINT64                                        Arg8\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Call module that is not linked direclty to this module. This code is IP \r
  relative and hides the binding issues of virtual or physical calling. The\r
  function that gets dispatched has extra arguments that include the registered\r
  module global and a boolean flag to indicate if the system is in virutal mode.\r
\r
Arguments:\r
  ClassGuid   - GUID of function\r
  FunctionId  - Function in ClassGuid to call\r
  Arg2        - Argument 2 ClassGuid/FunctionId defined\r
  Arg3        - Argument 3 ClassGuid/FunctionId defined\r
  Arg4        - Argument 4 ClassGuid/FunctionId defined\r
  Arg5        - Argument 5 ClassGuid/FunctionId defined\r
  Arg6        - Argument 6 ClassGuid/FunctionId defined\r
  Arg7        - Argument 7 ClassGuid/FunctionId defined\r
  Arg8        - Argument 8 ClassGuid/FunctionId defined\r
\r
Returns: \r
  Status of ClassGuid/FuncitonId\r
\r
--*/\r
{\r
  SAL_RETURN_REGS       ReturnReg;\r
  SAL_EXTENDED_SAL_PROC EsalProc;\r
\r
  ReturnReg = GetEsalEntryPoint ();\r
  if (ReturnReg.Status != EFI_SAL_SUCCESS) {\r
    return ReturnReg;\r
  }\r
\r
  if (ReturnReg.r11 & PSR_IT_MASK) {\r
    //\r
    // Virtual mode plabel to entry point\r
    //\r
    EsalProc = (SAL_EXTENDED_SAL_PROC) ReturnReg.r10;\r
  } else {\r
    //\r
    // Physical mode plabel to entry point\r
    //\r
    EsalProc = (SAL_EXTENDED_SAL_PROC) ReturnReg.r9;\r
  }\r
\r
  return EsalProc (\r
          ClassGuid,\r
          FunctionId,\r
          Arg2,\r
          Arg3,\r
          Arg4,\r
          Arg5,\r
          Arg6,\r
          Arg7,\r
          Arg8\r
          );\r
}\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
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
  EFI_GUID Guid = EFI_EXTENDED_SAL_VIRTUAL_SERVICES_PROTOCOL_GUID;\r
  SAL_RETURN_REGS ReturnReg;\r
\r
  ReturnReg = EfiCallEsalService (&Guid, IsVirtual, 0, 0, 0, 0, 0, 0, 0);\r
\r
  return (BOOLEAN) (ReturnReg.r9 == 1);\r
}\r
\r
BOOLEAN\r
EfiAtRuntime (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
  Return TRUE if ExitBootService () has been called\r
\r
Arguments:\r
  NONE\r
\r
Returns: \r
  TRUE - If ExitBootService () has been called\r
\r
--*/\r
{\r
  EFI_GUID Guid = EFI_EXTENDED_SAL_VIRTUAL_SERVICES_PROTOCOL_GUID;\r
  SAL_RETURN_REGS ReturnReg;\r
\r
  ReturnReg = EfiCallEsalService (&Guid, IsEfiRuntime, 0, 0, 0, 0, 0, 0, 0);\r
\r
  return (BOOLEAN) (ReturnReg.r9 == 1);\r
}\r
\r
EFI_STATUS\r
EfiReportStatusCode (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 * CallerId,\r
  IN EFI_STATUS_CODE_DATA     * Data OPTIONAL\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Status Code reporter\r
\r
Arguments:\r
\r
  CodeType    - Type of Status Code.\r
  \r
  Value       - Value to output for Status Code.\r
  \r
  Instance    - Instance Number of this status code.\r
  \r
  CallerId    - ID of the caller of this status code.\r
  \r
  Data        - Optional data associated with this status code.\r
\r
Returns:\r
\r
  Status code\r
\r
--*/\r
{\r
  EFI_GUID Guid = EFI_EXTENDED_SAL_STATUS_CODE_SERVICES_PROTOCOL_GUID;\r
  SAL_RETURN_REGS ReturnReg;\r
\r
\r
  ReturnReg = EfiCallEsalService (\r
                &Guid,\r
                StatusCode,\r
                (UINT64) CodeType,\r
                (UINT64) Value,\r
                (UINT64) Instance,\r
                (UINT64) CallerId,\r
                (UINT64) Data,\r
                0,\r
                0\r
                );\r
\r
  return (EFI_STATUS) ReturnReg.Status;\r
}\r
//\r
//  Sal Reset Driver Class\r
//\r
VOID\r
EfiResetSystem (\r
  IN EFI_RESET_TYPE     ResetType,\r
  IN EFI_STATUS         ResetStatus,\r
  IN UINTN              DataSize,\r
  IN CHAR16             *ResetData\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Resets the entire platform.\r
\r
Arguments:\r
\r
  ResetType   - The type of reset to perform.\r
  ResetStatus - The status code for the reset.\r
  DataSize    - The size, in bytes, of ResetData.\r
  ResetData   - A data buffer that includes a Null-terminated Unicode string, optionally\r
                followed by additional binary data.\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  EFI_GUID Guid = EFI_EXTENDED_SAL_RESET_SERVICES_PROTOCOL_GUID;\r
\r
  EfiCallEsalService (\r
    &Guid,\r
    ResetSystem,\r
    (UINT64) ResetType,\r
    (UINT64) ResetStatus,\r
    (UINT64) DataSize,\r
    (UINT64) ResetData,\r
    0,\r
    0,\r
    0\r
    );\r
}\r
//\r
//  Sal MTC Driver Class\r
//\r
EFI_STATUS\r
EfiGetNextHighMonotonicCount (\r
  OUT UINT32      *HighCount\r
  )\r
/*++\r
\r
Routine Description:\r
\r