MdePkg: Do not use CreateEventEx unless required

[mirror_edk2.git] / MdePkg / Library / PciSegmentLibSegmentInfo / DxeRuntimePciSegmentLib.c

/** @file\r
  Instance of Runtime PCI Segment Library that support multi-segment PCI configuration access.\r
\r
  PCI Segment Library that consumes segment information provided by PciSegmentInfoLib to\r
   support multi-segment PCI configuration access through enhanced configuration access mechanism.\r
\r
  Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "PciSegmentLibCommon.h"\r
#include <PiDxe.h>\r
#include <Guid/EventGroup.h>\r
#include <Library/UefiRuntimeLib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PciSegmentInfoLib.h>\r
\r
///\r
/// Define table for mapping PCI Segment MMIO physical addresses to virtual addresses at OS runtime\r
///\r
typedef struct {\r
  UINTN  PhysicalAddress;\r
  UINTN  VirtualAddress;\r
} PCI_SEGMENT_RUNTIME_REGISTRATION_TABLE;\r
\r
///\r
/// Set Virtual Address Map Event\r
///\r
EFI_EVENT                               mDxeRuntimePciSegmentLibVirtualNotifyEvent = NULL;\r
\r
///\r
/// The number of PCI devices that have been registered for runtime access.\r
///\r
UINTN                                   mDxeRuntimePciSegmentLibNumberOfRuntimeRanges = 0;\r
\r
///\r
/// The table of PCI devices that have been registered for runtime access.\r
///\r
PCI_SEGMENT_RUNTIME_REGISTRATION_TABLE  *mDxeRuntimePciSegmentLibRegistrationTable = NULL;\r
\r
///\r
/// The table index of the most recent virtual address lookup.\r
///\r
UINTN                                   mDxeRuntimePciSegmentLibLastRuntimeRange = 0;\r
\r
/**\r
  Convert the physical PCI Express MMIO addresses for all registered PCI devices\r
  to virtual addresses.\r
\r
  @param[in]    Event   The event that is being processed.\r
  @param[in]    Context The Event Context.\r
**/\r
VOID\r
EFIAPI\r
DxeRuntimePciSegmentLibVirtualNotify (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  UINTN         Index;\r
  EFI_STATUS    Status;\r
\r
  //\r
  // If there have been no runtime registrations, then just return\r
  //\r
  if (mDxeRuntimePciSegmentLibRegistrationTable == NULL) {\r
    return;\r
  }\r
\r
  //\r
  // Convert physical addresses associated with the set of registered PCI devices to\r
  // virtual addresses.\r
  //\r
  for (Index = 0; Index < mDxeRuntimePciSegmentLibNumberOfRuntimeRanges; Index++) {\r
    Status = EfiConvertPointer (0, (VOID **) &(mDxeRuntimePciSegmentLibRegistrationTable[Index].VirtualAddress));\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  //\r
  // Convert table pointer that is allocated from EfiRuntimeServicesData to a virtual address.\r
  //\r
  Status = EfiConvertPointer (0, (VOID **) &mDxeRuntimePciSegmentLibRegistrationTable);\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
  The constructor function caches the PCI Express Base Address and creates a\r
  Set Virtual Address Map event to convert physical address to virtual addresses.\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
DxeRuntimePciSegmentLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Register SetVirtualAddressMap () notify function\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r
                  TPL_NOTIFY,\r
                  DxeRuntimePciSegmentLibVirtualNotify,\r
                  NULL,\r
                  &mDxeRuntimePciSegmentLibVirtualNotifyEvent\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
DxeRuntimePciSegmentLibDestructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // If one or more PCI devices have been registered for runtime access, then\r
  // free the registration table.\r
  //\r
  if (mDxeRuntimePciSegmentLibRegistrationTable != NULL) {\r
    FreePool (mDxeRuntimePciSegmentLibRegistrationTable);\r
  }\r
\r
  //\r
  // Close the Set Virtual Address Map event\r
  //\r
  Status = gBS->CloseEvent (mDxeRuntimePciSegmentLibVirtualNotifyEvent);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
\r
/**\r
  Register a PCI device so PCI configuration registers may be accessed after\r
  SetVirtualAddressMap().\r
\r
  If any reserved bits in Address are set, then ASSERT().\r
\r
  @param  Address The address that encodes the PCI Bus, Device, Function and\r
                  Register.\r
\r
  @retval RETURN_SUCCESS           The PCI device was registered for runtime access.\r
  @retval RETURN_UNSUPPORTED       An attempt was made to call this function\r
                                   after ExitBootServices().\r
  @retval RETURN_UNSUPPORTED       The resources required to access the PCI device\r
                                   at runtime could not be mapped.\r
  @retval RETURN_OUT_OF_RESOURCES  There are not enough resources available to\r
                                   complete the registration.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PciSegmentRegisterForRuntimeAccess (\r
  IN UINTN  Address\r
  )\r
{\r
  RETURN_STATUS                    Status;\r
  EFI_GCD_MEMORY_SPACE_DESCRIPTOR  Descriptor;\r
  UINTN                            Index;\r
  VOID                             *NewTable;\r
  UINTN                            Count;\r
  PCI_SEGMENT_INFO                 *SegmentInfo;\r
  UINT64                           EcamAddress;\r
\r
  //\r
  // Convert Address to a ECAM address at the beginning of the PCI Configuration\r
  // header for the specified PCI Bus/Dev/Func\r
  //\r
  Address &= ~(UINTN)EFI_PAGE_MASK;\r
  SegmentInfo = GetPciSegmentInfo (&Count);\r
  EcamAddress = PciSegmentLibGetEcamAddress (Address, SegmentInfo, Count);\r
\r
  //\r
  // Return an error if this function is called after ExitBootServices().\r
  //\r
  if (EfiAtRuntime ()) {\r
    return RETURN_UNSUPPORTED;\r
  }\r
  if (sizeof (UINTN) == sizeof (UINT32)) {\r
    ASSERT (EcamAddress < BASE_4GB);\r
  }\r
  Address = (UINTN)EcamAddress;\r
\r
  //\r
  // See if Address has already been registerd for runtime access\r
  //\r
  for (Index = 0; Index < mDxeRuntimePciSegmentLibNumberOfRuntimeRanges; Index++) {\r
    if (mDxeRuntimePciSegmentLibRegistrationTable[Index].PhysicalAddress == Address) {\r
      return RETURN_SUCCESS;\r
    }\r
  }\r
\r
  //\r
  // Get the GCD Memory Descriptor for the ECAM Address\r
  //\r
  Status = gDS->GetMemorySpaceDescriptor (Address, &Descriptor);\r
  if (EFI_ERROR (Status)) {\r
    return RETURN_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Mark the 4KB region for the PCI Express Bus/Dev/Func as EFI_RUNTIME_MEMORY so the OS\r
  // will allocate a virtual address range for the 4KB PCI Configuration Header.\r
  //\r
  Status = gDS->SetMemorySpaceAttributes (Address, EFI_PAGE_SIZE, Descriptor.Attributes | EFI_MEMORY_RUNTIME);\r
  if (EFI_ERROR (Status)) {\r
    return RETURN_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Grow the size of the registration table\r
  //\r
  NewTable = ReallocateRuntimePool (\r
               (mDxeRuntimePciSegmentLibNumberOfRuntimeRanges + 0) * sizeof (PCI_SEGMENT_RUNTIME_REGISTRATION_TABLE),\r
               (mDxeRuntimePciSegmentLibNumberOfRuntimeRanges + 1) * sizeof (PCI_SEGMENT_RUNTIME_REGISTRATION_TABLE),\r
               mDxeRuntimePciSegmentLibRegistrationTable\r
               );\r
  if (NewTable == NULL) {\r
    return RETURN_OUT_OF_RESOURCES;\r
  }\r
  mDxeRuntimePciSegmentLibRegistrationTable = NewTable;\r
  mDxeRuntimePciSegmentLibRegistrationTable[mDxeRuntimePciSegmentLibNumberOfRuntimeRanges].PhysicalAddress = Address;\r
  mDxeRuntimePciSegmentLibRegistrationTable[mDxeRuntimePciSegmentLibNumberOfRuntimeRanges].VirtualAddress  = Address;\r
  mDxeRuntimePciSegmentLibNumberOfRuntimeRanges++;\r
\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  Return the linear address for the physical address.\r
\r
  @param  Address  The physical address.\r
\r
  @retval The linear address.\r
**/\r
UINTN\r
PciSegmentLibVirtualAddress (\r
  IN UINTN                     Address\r
  )\r
{\r
  UINTN                        Index;\r
  //\r
  // If SetVirtualAddressMap() has not been called, then just return the physical address\r
  //\r
  if (!EfiGoneVirtual ()) {\r
    return Address;\r
  }\r
\r
  //\r
  // See if there is a physical address match at the exact same index as the last address match\r
  //\r
  if (mDxeRuntimePciSegmentLibRegistrationTable[mDxeRuntimePciSegmentLibLastRuntimeRange].PhysicalAddress == (Address & (~(UINTN)EFI_PAGE_MASK))) {\r
    //\r
    // Convert the physical address to a virtual address and return the virtual address\r
    //\r
    return (Address & EFI_PAGE_MASK) + mDxeRuntimePciSegmentLibRegistrationTable[mDxeRuntimePciSegmentLibLastRuntimeRange].VirtualAddress;\r
  }\r
\r
  //\r
  // Search the entire table for a physical address match\r
  //\r
  for (Index = 0; Index < mDxeRuntimePciSegmentLibNumberOfRuntimeRanges; Index++) {\r
    if (mDxeRuntimePciSegmentLibRegistrationTable[Index].PhysicalAddress == (Address & (~(UINTN)EFI_PAGE_MASK))) {\r
      //\r
      // Cache the matching index value\r
      //\r
      mDxeRuntimePciSegmentLibLastRuntimeRange = Index;\r
      //\r
      // Convert the physical address to a virtual address and return the virtual address\r
      //\r
      return (Address & EFI_PAGE_MASK) + mDxeRuntimePciSegmentLibRegistrationTable[Index].VirtualAddress;\r
    }\r
  }\r
\r
  //\r
  // No match was found.  This is a critical error at OS runtime, so ASSERT() and force a breakpoint.\r
  //\r
  ASSERT (FALSE);\r
  CpuBreakpoint ();\r
\r
  //\r
  // Return the physical address\r
  //\r
  return Address;\r
}\r