MdePkg: Apply uncrustify changes

[mirror_edk2.git] / MdePkg / Library / UefiDebugLibDebugPortProtocol / DebugLibConstructor.c

/** @file\r
  UEFI Dxe DebugLib constructor that prevent some debug service after ExitBootServices event,\r
  because some pointer is nulled at that phase.\r
\r
  Copyright (c) 2018, Microsoft Corporation\r
  Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include <Uefi.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
//\r
// BOOLEAN value to indicate if it is at the post ExitBootServices pahse\r
//\r
BOOLEAN  mPostEBS = FALSE;\r
\r
static EFI_EVENT  mExitBootServicesEvent;\r
\r
//\r
// Pointer to SystemTable\r
// This library instance may have a cycle consume with UefiBootServicesTableLib\r
// because of the constructors.\r
//\r
EFI_BOOT_SERVICES  *mDebugBS;\r
\r
/**\r
  This routine sets the mPostEBS for exit boot servies true\r
  to prevent DebugPort protocol dereferences when the pointer is nulled.\r
\r
  @param  Event        Event whose notification function is being invoked.\r
  @param  Context      Pointer to the notification function's context.\r
\r
**/\r
VOID\r
EFIAPI\r
ExitBootServicesCallback (\r
  EFI_EVENT  Event,\r
  VOID       *Context\r
  )\r
{\r
  mPostEBS = TRUE;\r
  return;\r
}\r
\r
/**\r
  The constructor gets the pointers to boot services table.\r
  And create a event to indicate it is after ExitBootServices.\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 always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeDebugLibConstructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  mDebugBS = SystemTable->BootServices;\r
\r
  mDebugBS->CreateEvent (\r
              EVT_SIGNAL_EXIT_BOOT_SERVICES,\r
              TPL_NOTIFY,\r
              ExitBootServicesCallback,\r
              NULL,\r
              &mExitBootServicesEvent\r
              );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  The destructor closes Exit Boot Services 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 always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeDebugLibDestructor (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  if (mExitBootServicesEvent != NULL) {\r
    SystemTable->BootServices->CloseEvent (mExitBootServicesEvent);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r