Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / StatusCode / RuntimeDxe / StatusCodeRuntimeDxe.c

/** @file\r
  Status code driver for IA32/X64/EBC architecture.\r
\r
  Copyright (c) 2006 - 2009, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "StatusCodeRuntimeDxe.h"\r
\r
EFI_EVENT    mVirtualAddressChangeEvent = NULL;\r
EFI_HANDLE   mHandle = NULL;\r
\r
//\r
// Declaration of status code protocol.\r
//\r
EFI_STATUS_CODE_PROTOCOL  mEfiStatusCodeProtocol  = {\r
  ReportDispatcher\r
};\r
\r
//\r
// Report operation nest status.\r
// If it is set, then the report operation has nested.\r
//\r
UINT32  mStatusCodeNestStatus = 0;\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 installs Status Code Runtime Protocol, 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
StatusCodeRuntimeDxeEntry (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Dispatch initialization request to supported devices\r
  //\r
  InitializationDispatcherWorker ();\r
\r
  //\r
  // Install Status Code Runtime Protocol implementation as defined in PI Specification.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &mHandle,\r
                  &gEfiStatusCodeRuntimeProtocolGuid,\r
                  &mEfiStatusCodeProtocol,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\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
\r
/**\r
  Report status code to all supported device.\r
\r
  This function implements EFI_STATUS_CODE_PROTOCOL.ReportStatusCode().\r
  It calls into the workers which dispatches the platform specific listeners.\r
\r
  @param  CodeType         Indicates the type of status code being reported.\r
  @param  Value            Describes the current status of a hardware or software entity.\r
                           This included information about the class and subclass that is used to\r
                           classify the entity as well as an operation.\r
  @param  Instance         The enumeration of a hardware or software entity within\r
                           the system. Valid instance numbers start with 1.\r
  @param  CallerId         This optional parameter may be used to identify the caller.\r
                           This parameter allows the status code driver to apply different rules to\r
                           different callers.\r
  @param  Data             This optional parameter may be used to pass additional data.\r
\r
  @retval EFI_SUCCESS      The function completed successfully\r
  @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ReportDispatcher (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId  OPTIONAL,\r
  IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL\r
  )\r
{\r
  //\r
  // Use atom operation to avoid the reentant of report.\r
  // If current status is not zero, then the function is reentrancy.\r
  //\r
  if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (FeaturePcdGet (PcdStatusCodeUseEfiSerial) || FeaturePcdGet (PcdStatusCodeUseHardSerial)) {\r
    SerialStatusCodeReportWorker (\r
      CodeType,\r
      Value,\r
      Instance,\r
      CallerId,\r
      Data\r
      );\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseRuntimeMemory)) {\r
    RtMemoryStatusCodeReportWorker (\r
      CodeType,\r
      Value,\r
      Instance\r
      );\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseDataHub)) {\r
    DataHubStatusCodeReportWorker (\r
      CodeType,\r
      Value,\r
      Instance,\r
      CallerId,\r
      Data\r
      );\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseOEM)) {\r
    //\r
    // Call OEM hook status code library API to report status code to OEM device\r
    //\r
    OemHookStatusCodeReport (\r
      CodeType,\r
      Value,\r
      Instance,\r
      CallerId,\r
      Data\r
      );\r
  }\r
\r
  //\r
  // Restore the nest status of report\r
  //\r
  InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0);\r
\r
  return EFI_SUCCESS;\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                             ExpectedPacketIndex;\r
  UINTN                             Index;\r
  VOID                              *HobStart;\r
\r
  //\r
  // If enable UseSerial, then initialize serial port.\r
  // if enable UseRuntimeMemory, then initialize runtime memory status code worker.\r
  // if enable UseDataHub, then initialize data hub status code worker.\r
  //\r
  if (FeaturePcdGet (PcdStatusCodeUseEfiSerial)) {\r
    Status = EfiSerialStatusCodeInitializeWorker ();\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseHardSerial)) {\r
    //\r
    // Call Serial Port Lib API to initialize serial port.\r
    //\r
    Status = SerialPortInitialize ();\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseRuntimeMemory)) {\r
    Status = RtMemoryStatusCodeInitializeWorker ();\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseDataHub)) {\r
    Status = DataHubStatusCodeInitializeWorker ();\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
  if (FeaturePcdGet (PcdStatusCodeUseOEM)) {\r
    //\r
    // Call OEM hook status code library API to initialize OEM device for status code.\r
    //\r
    Status = OemHookStatusCodeInitialize ();\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
  //\r
  // Replay Status code which saved in GUID'ed HOB to all supported devices. \r
  //\r
\r
  // \r
  // Journal GUID'ed HOBs to find all record entry, if found, \r
  // then output record to support replay device.\r
  //\r
  ExpectedPacketIndex = 0;\r
  Hob.Raw   = GetFirstGuidHob (&gMemoryStatusCodeRecordGuid);\r
  HobStart  = Hob.Raw;\r
  while (Hob.Raw != NULL) {\r
    PacketHeader = (MEMORY_STATUSCODE_PACKET_HEADER *) GET_GUID_HOB_DATA (Hob.Guid);\r
    if (PacketHeader->PacketIndex == ExpectedPacketIndex) {\r
      Record = (MEMORY_STATUSCODE_RECORD *) (PacketHeader + 1);\r
      for (Index = 0; Index < PacketHeader->RecordIndex; Index++) {\r
        //\r
        // Dispatch records to devices based on feature flag.\r
        //\r
        if (FeaturePcdGet (PcdStatusCodeReplayInSerial) && \r
            (FeaturePcdGet (PcdStatusCodeUseHardSerial) ||\r
             FeaturePcdGet (PcdStatusCodeUseEfiSerial))) {\r
          SerialStatusCodeReportWorker (\r
            Record[Index].CodeType,\r
            Record[Index].Value,\r
            Record[Index].Instance,\r
            NULL,\r
            NULL\r
            );\r
        }\r
        if (FeaturePcdGet (PcdStatusCodeReplayInRuntimeMemory) &&\r
            FeaturePcdGet (PcdStatusCodeUseRuntimeMemory)) {\r
          RtMemoryStatusCodeReportWorker (\r
            Record[Index].CodeType,\r
            Record[Index].Value,\r
            Record[Index].Instance\r
            );\r
        }\r
        if (FeaturePcdGet (PcdStatusCodeReplayInDataHub) &&\r
            FeaturePcdGet (PcdStatusCodeUseDataHub)) {\r
          DataHubStatusCodeReportWorker (\r
            Record[Index].CodeType,\r
            Record[Index].Value,\r
            Record[Index].Instance,\r
            NULL,\r
            NULL\r
            );\r
        }\r
        if (FeaturePcdGet (PcdStatusCodeReplayInOEM) &&\r
            FeaturePcdGet (PcdStatusCodeUseOEM)) {\r
          //\r
          // Call OEM hook status code library API to report status code to OEM device\r
          //\r
          OemHookStatusCodeReport (\r
            Record[Index].CodeType,\r
            Record[Index].Value,\r
            Record[Index].Instance,\r
            NULL,\r
            NULL\r
            );\r
        }\r
      }\r
      ExpectedPacketIndex++;\r
\r
      //\r
      // See whether there is gap of packet or not\r
      //\r
      if (HobStart != NULL) {\r
        HobStart  = NULL;\r
        Hob.Raw   = HobStart;\r
        continue;\r
      }\r
    } else if (HobStart != NULL) {\r
      //\r
      // Cache the found packet for improve the performance\r
      //\r
      HobStart = Hob.Raw;\r
    }\r
\r
    Hob.Raw = GetNextGuidHob (&gMemoryStatusCodeRecordGuid, Hob.Raw);\r
  }\r
}\r