MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / StatusCodeHandler / RuntimeDxe / StatusCodeHandlerRuntimeDxe.c

/** @file\r
  Status Code Handler Driver which produces general handlers and hook them\r
  onto the DXE status code router.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "StatusCodeHandlerRuntimeDxe.h"\r
\r
EFI_EVENT                 mVirtualAddressChangeEvent = NULL;\r
EFI_EVENT                 mExitBootServicesEvent     = NULL;\r
EFI_RSC_HANDLER_PROTOCOL  *mRscHandlerProtocol       = NULL;\r
\r
/**\r
  Unregister status code callback functions only available at boot time from\r
  report status code router when exiting boot services.\r
\r
  @param  Event         Event whose notification function is being invoked.\r
  @param  Context       Pointer to the notification function's context, which is\r
                        always zero in current implementation.\r
\r
**/\r
VOID\r
EFIAPI\r
UnregisterBootTimeHandlers (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  if (FeaturePcdGet (PcdStatusCodeUseSerial)) {\r
    mRscHandlerProtocol->Unregister (SerialStatusCodeReportWorker);\r
  }\r
}\r
\r
/**\r
  Virtual address change notification call back. It converts global pointer\r
  to virtual address.\r
\r
  @param  Event         Event whose notification function is being invoked.\r
  @param  Context       Pointer to the notification function's context, which is\r
                        always zero in current implementation.\r
\r
**/\r
VOID\r
EFIAPI\r
VirtualAddressChangeCallBack (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  //\r
  // Convert memory status code table to virtual address;\r
  //\r
  EfiConvertPointer (\r
    0,\r
    (VOID **) &mRtMemoryStatusCodeTable\r
    );\r
}\r
\r
/**\r
  Dispatch initialization request to sub status code devices based on\r
  customized feature flags.\r
\r
**/\r
VOID\r
InitializationDispatcherWorker (\r
  VOID\r
  )\r
{\r
  EFI_PEI_HOB_POINTERS              Hob;\r
  EFI_STATUS                        Status;\r
  MEMORY_STATUSCODE_PACKET_HEADER   *PacketHeader;\r
  MEMORY_STATUSCODE_RECORD          *Record;\r
  UINTN                             Index;\r
  UINTN                             MaxRecordNumber;\r
\r
  //\r
  // If enable UseSerial, then initialize serial port.\r
  // if enable UseRuntimeMemory, then initialize runtime memory status code worker.\r
  //\r
  if (FeaturePcdGet (PcdStatusCodeUseSerial)) {\r
    //\r
    // Call Serial Port Lib API to initialize serial port.\r
    //\r
    Status = SerialPortInitialize ();\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseMemory)) {\r
    Status = RtMemoryStatusCodeInitializeWorker ();\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  //\r
  // Replay Status code which saved in GUID'ed HOB to all supported devices.\r
  //\r
  if (FeaturePcdGet (PcdStatusCodeReplayIn)) {\r
    //\r
    // Journal GUID'ed HOBs to find all record entry, if found,\r
    // then output record to support replay device.\r
    //\r
    Hob.Raw   = GetFirstGuidHob (&gMemoryStatusCodeRecordGuid);\r
    if (Hob.Raw != NULL) {\r
      PacketHeader = (MEMORY_STATUSCODE_PACKET_HEADER *) GET_GUID_HOB_DATA (Hob.Guid);\r
      Record = (MEMORY_STATUSCODE_RECORD *) (PacketHeader + 1);\r
      MaxRecordNumber = (UINTN) PacketHeader->RecordIndex;\r
      if (PacketHeader->PacketIndex > 0) {\r
        //\r
        // Record has been wrapped around. So, record number has arrived at max number.\r
        //\r
        MaxRecordNumber = (UINTN) PacketHeader->MaxRecordsNumber;\r
      }\r
      for (Index = 0; Index < MaxRecordNumber; Index++) {\r
        //\r
        // Dispatch records to devices based on feature flag.\r
        //\r
        if (FeaturePcdGet (PcdStatusCodeUseSerial)) {\r
          SerialStatusCodeReportWorker (\r
            Record[Index].CodeType,\r
            Record[Index].Value,\r
            Record[Index].Instance,\r
            NULL,\r
            NULL\r
            );\r
        }\r
        if (FeaturePcdGet (PcdStatusCodeUseMemory)) {\r
          RtMemoryStatusCodeReportWorker (\r
            Record[Index].CodeType,\r
            Record[Index].Value,\r
            Record[Index].Instance,\r
            NULL,\r
            NULL\r
            );\r
        }\r
      }\r
    }\r
  }\r
}\r
\r
/**\r
  Entry point of DXE Status Code Driver.\r
\r
  This function is the entry point of this DXE Status Code Driver.\r
  It initializes registers status code handlers, and registers event for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.\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 entry point is executed successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
StatusCodeHandlerRuntimeDxeEntry (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS                Status;\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiRscHandlerProtocolGuid,\r
                  NULL,\r
                  (VOID **) &mRscHandlerProtocol\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Dispatch initialization request to supported devices\r
  //\r
  InitializationDispatcherWorker ();\r
\r
  if (FeaturePcdGet (PcdStatusCodeUseSerial)) {\r
    mRscHandlerProtocol->Register (SerialStatusCodeReportWorker, TPL_HIGH_LEVEL);\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseMemory)) {\r
    mRscHandlerProtocol->Register (RtMemoryStatusCodeReportWorker, TPL_HIGH_LEVEL);\r
  }\r
\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  UnregisterBootTimeHandlers,\r
                  NULL,\r
                  &gEfiEventExitBootServicesGuid,\r
                  &mExitBootServicesEvent\r
                  );\r
\r
  Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  VirtualAddressChangeCallBack,\r
                  NULL,\r
                  &gEfiEventVirtualAddressChangeGuid,\r
                  &mVirtualAddressChangeEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return EFI_SUCCESS;\r
}\r