QuarkSocPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / QuarkSocPkg / QuarkNorthCluster / Library / QNCAccessLib / RuntimeAccess.c

/** @file\r
Runtime Lib function for QNC internal network access.\r
\r
Copyright (c) 2013-2015 Intel Corporation.\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include <PiDxe.h>\r
\r
#include <Guid/EventGroup.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
#include <Library/QNCAccessLib.h>\r
\r
///\r
/// Set Virtual Address Map Event\r
///\r
EFI_EVENT                               mDxeRuntimeQncAccessLibVirtualNotifyEvent = NULL;\r
\r
///\r
/// Module global that contains the base physical address of the PCI Express MMIO range.\r
///\r
UINTN                                   mDxeRuntimeQncAccessLibPciExpressBaseAddress = 0;\r
\r
/**\r
  Convert the physical PCI Express MMIO address to a virtual address.\r
\r
  @param[in]    Event   The event that is being processed.\r
  @param[in]    Context The Event Context.\r
**/\r
VOID\r
EFIAPI\r
DxeRuntimeQncAccessLibVirtualNotify (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  EFI_STATUS                       Status;\r
\r
  //\r
  // Convert the physical PCI Express MMIO address to a virtual address.\r
  //\r
  Status = EfiConvertPointer (0, (VOID **) &mDxeRuntimeQncAccessLibPciExpressBaseAddress);\r
\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
  The constructor function to setup globals and goto virtual mode notify.\r
\r
  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS   The constructor completed successfully.\r
  @retval Other value   The constructor did not complete successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeRuntimeQncAccessLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Cache the physical address of the PCI Express MMIO range into a module global variable\r
  //\r
  mDxeRuntimeQncAccessLibPciExpressBaseAddress = (UINTN) PcdGet64(PcdPciExpressBaseAddress);\r
\r
  //\r
  // Register SetVirtualAddressMap () notify function\r
  //\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  DxeRuntimeQncAccessLibVirtualNotify,\r
                  NULL,\r
                  &gEfiEventVirtualAddressChangeGuid,\r
                  &mDxeRuntimeQncAccessLibVirtualNotifyEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
\r
/**\r
  The destructor function frees any allocated buffers and closes the Set Virtual\r
  Address Map event.\r
\r
  @param  ImageHandle   The firmware allocated handle for the EFI image.\r
  @param  SystemTable   A pointer to the EFI System Table.\r
\r
  @retval EFI_SUCCESS   The destructor completed successfully.\r
  @retval Other value   The destructor did not complete successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeRuntimeQncAccessLibDestructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Close the Set Virtual Address Map event\r
  //\r
  Status = gBS->CloseEvent (mDxeRuntimeQncAccessLibVirtualNotifyEvent);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
\r
/**\r
  Gets the base address of PCI Express for Quark North Cluster.\r
\r
  @return The base address of PCI Express for Quark North Cluster.\r
\r
**/\r
UINTN\r
EFIAPI\r
QncGetPciExpressBaseAddress (\r
  VOID\r
  )\r
{\r
  //\r
  // If system goes to virtual mode then virtual notify callback will update\r
  // mDxeRuntimeQncAccessLibPciExpressBaseAddress with virtual address of\r
  // PCIe memory base.\r
  //\r
  return mDxeRuntimeQncAccessLibPciExpressBaseAddress;\r
}\r
\r