MdeModulePkg/DxeCapsuleLibFmp: clone ESRT for runtime access

[mirror_edk2.git] / MdeModulePkg / Library / DxeCapsuleLibFmp / DxeCapsuleRuntime.c

/** @file\r
  Capsule library runtime support.\r
\r
  Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiDxe.h>\r
\r
#include <Guid/FmpCapsule.h>\r
#include <Guid/SystemResourceTable.h>\r
#include <Guid/EventGroup.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DxeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
extern EFI_SYSTEM_RESOURCE_TABLE *mEsrtTable;\r
extern BOOLEAN                   mIsVirtualAddrConverted;\r
EFI_EVENT                 mDxeRuntimeCapsuleLibVirtualAddressChangeEvent  = NULL;\r
EFI_EVENT                 mDxeRuntimeCapsuleLibReadyToBootEvent  = NULL;\r
\r
/**\r
  Convert EsrtTable physical address to virtual address.\r
\r
  @param[in] Event      Event whose notification function is being invoked.\r
  @param[in] Context    The pointer to the notification function's context, which\r
                        is implementation-dependent.\r
**/\r
VOID\r
EFIAPI\r
DxeCapsuleLibVirtualAddressChangeEvent (\r
  IN  EFI_EVENT   Event,\r
  IN  VOID        *Context\r
  )\r
{\r
  gRT->ConvertPointer (EFI_OPTIONAL_PTR, (VOID **)&mEsrtTable);\r
  mIsVirtualAddrConverted = TRUE;\r
}\r
\r
/**\r
  Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT.\r
\r
  @param[in]  Event   The Event that is being processed.\r
  @param[in]  Context The Event Context.\r
\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
DxeCapsuleLibReadyToBootEventNotify (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  UINTN                       Index;\r
  EFI_CONFIGURATION_TABLE     *ConfigEntry;\r
  EFI_SYSTEM_RESOURCE_TABLE   *EsrtTable;\r
\r
  //\r
  // Get Esrt table first\r
  //\r
  ConfigEntry = gST->ConfigurationTable;\r
  for (Index = 0; Index < gST->NumberOfTableEntries; Index++) {\r
    if (CompareGuid(&gEfiSystemResourceTableGuid, &ConfigEntry->VendorGuid)) {\r
      break;\r
    }\r
    ConfigEntry++;\r
  }\r
\r
  //\r
  // If no Esrt table installed in Configure Table\r
  //\r
  if (Index < gST->NumberOfTableEntries) {\r
    //\r
    // Search Esrt to check given capsule is qualified\r
    //\r
    EsrtTable = (EFI_SYSTEM_RESOURCE_TABLE *) ConfigEntry->VendorTable;\r
\r
    mEsrtTable = AllocateRuntimeCopyPool (\r
                   sizeof (EFI_SYSTEM_RESOURCE_TABLE) +\r
                   EsrtTable->FwResourceCount * sizeof (EFI_SYSTEM_RESOURCE_ENTRY),\r
                   EsrtTable);\r
    ASSERT (mEsrtTable != NULL);\r
\r
    //\r
    // Set FwResourceCountMax to a sane value.\r
    //\r
    mEsrtTable->FwResourceCountMax = mEsrtTable->FwResourceCount;\r
  }\r
}\r
\r
/**\r
  The constructor function hook VirtualAddressChange event to use ESRT table as capsule routing table.\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 successfully .\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeRuntimeCapsuleLibConstructor (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS     Status;\r
\r
  //\r
  // Make sure we can handle virtual address changes.\r
  //\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  DxeCapsuleLibVirtualAddressChangeEvent,\r
                  NULL,\r
                  &gEfiEventVirtualAddressChangeGuid,\r
                  &mDxeRuntimeCapsuleLibVirtualAddressChangeEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Register notify function to cache the FMP capsule GUIDs at ReadyToBoot.\r
  //\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_CALLBACK,\r
                  DxeCapsuleLibReadyToBootEventNotify,\r
                  NULL,\r
                  &gEfiEventReadyToBootGuid,\r
                  &mDxeRuntimeCapsuleLibReadyToBootEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The destructor function closes the VirtualAddressChange 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
**/\r
EFI_STATUS\r
EFIAPI\r
DxeRuntimeCapsuleLibDestructor (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS    Status;\r
\r
  //\r
  // Close the VirtualAddressChange event.\r
  //\r
  Status = gBS->CloseEvent (mDxeRuntimeCapsuleLibVirtualAddressChangeEvent);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Close the ReadyToBoot event.\r
  //\r
  Status = gBS->CloseEvent (mDxeRuntimeCapsuleLibReadyToBootEvent);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r