Update the copyright notice format

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

/*++\r
\r
Copyright (c) 2007, 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
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_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 BOOLEAN              mRuntimeLibInitialized  = FALSE;\r
static BOOLEAN              mEfiGoneVirtual         = FALSE;\r
\r
//\r
// Runtime Global, but you should use the Lib functions\r
//\r
BOOLEAN                     mEfiAtRuntime = FALSE;\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
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
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
  //\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
  // To NOT register SetVirtualAddressMap () notify function,\r
  // because we do not know how to trigger it without our EBC driver.\r
  //\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
  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
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
  return EFI_UNSUPPORTED;\r
}\r
//\r
// Cache Flush Routine.\r
//\r
EFI_STATUS\r
EfiCpuFlushCache (\r
  IN EFI_PHYSICAL_ADDRESS          Start,\r
  IN UINT64                        Length\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Flush cache with specified range.\r
\r
Arguments:\r
\r
  Start   - Start address\r
  Length  - Length in bytes\r
\r
Returns:\r
\r
  Status code\r
  \r
  EFI_SUCCESS - success\r
\r
--*/\r
{\r
  return EFI_SUCCESS;\r
}\r