Initial import.

[mirror_edk2.git] / EdkModulePkg / Universal / StatusCode / RuntimeDxe / StatusCode.c

/*++\r
\r
Copyright (c) 2006, 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
Module Name:\r
\r
  StatusCode.c\r
\r
Abstract:\r
\r
  Status Code Architectural Protocol implementation as defined in Tiano\r
  Architecture Specification.\r
\r
  This driver also depends on the DataHub, and will log all status code info \r
  to the DataHub. Fatal Errors are Printed to Standard Error (StdErr) and not \r
  logged to the data hub (If you crash what good is the data in the data hub).\r
\r
  This driver has limited functionality at runtime and will not log to Data Hub\r
  at runtime.\r
\r
  Notes:\r
  This driver assumes the following ReportStatusCode strategy:\r
  PEI       -> uses PeiReportStatusCode\r
  DXE IPL   -> uses PeiReportStatusCode\r
  early DXE -> uses PeiReportStatusCode via HOB\r
  DXE       -> This driver\r
  RT        -> This driver\r
\r
--*/\r
\r
#include "StatusCode.h"\r
\r
EFI_LOCK  mStatusCodeLock;\r
BOOLEAN   mStatusCodeFlag = FALSE;\r
\r
//\r
// Function implemenations\r
//\r
\r
\r
EFI_STATUS\r
EFIAPI\r
StatusCodeReportStatusCode (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId,\r
  IN EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Calls into the platform library which dispatches the platform specific\r
  listeners. For NT environments we still call back into PEI because the \r
  ReportStatusCode functionality requires Win32 services and is built into\r
  the SecMain.exe utility.\r
\r
Arguments:\r
\r
  (See Tiano Runtime Specification)\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Acquire the lock required to update mStatusCodeFlag\r
  //\r
  Status = EfiAcquireLockOrFail (&mStatusCodeLock);\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Check for reentrancy of the lock\r
    //\r
    return EFI_DEVICE_ERROR;\r
  }\r
  //\r
  // Check to see if we are already in the middle of a ReportStatusCode()\r
  //\r
  if (mStatusCodeFlag) {\r
    EfiReleaseLock (&mStatusCodeLock);\r
    return EFI_DEVICE_ERROR;\r
  }\r
  //\r
  // Set the flag to show we are in the middle of a ReportStatusCode()\r
  //\r
  mStatusCodeFlag = TRUE;\r
\r
  //\r
  // Release the lock for updating mStatusCodeFlag\r
  //\r
  EfiReleaseLock (&mStatusCodeLock);\r
\r
  //\r
  // Go do the work required to report a status code\r
  //\r
  RtPlatformReportStatusCode (CodeType, Value, Instance, CallerId, Data);\r
\r
  //\r
  // Acquire the lock required to update mStatusCodeFlag\r
  //\r
  Status = EfiAcquireLockOrFail (&mStatusCodeLock);\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Check for reentrancy of the lock\r
    //\r
    return EFI_DEVICE_ERROR;\r
  }\r
  //\r
  // Clear the flag to show we are no longer in the middle of a ReportStatusCode()\r
  //\r
  mStatusCodeFlag = FALSE;\r
\r
  //\r
  // Release the lock for updating mStatusCodeFlag\r
  //\r
  EfiReleaseLock (&mStatusCodeLock);\r
\r
  return EFI_SUCCESS;\r
}\r
//\r
// Protocol instance, there can be only one.\r
//\r
EFI_STATUS\r
InitializeStatusCode (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Install Driver to produce Report Status Code Arch Protocol\r
\r
Arguments:\r
\r
  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
\r
Returns:\r
\r
  EFI_SUCCESS - Logging Hub protocol installed\r
  Other       - No protocol installed, unload driver.\r
\r
--*/\r
{\r
\r
  EfiInitializeLock (&mStatusCodeLock, EFI_TPL_HIGH_LEVEL);\r
\r
  //\r
  // Call the platform hook to initialize the different listeners.\r
  //\r
  RtPlatformStatusCodeInitialize ();\r
\r
  //\r
  // Register a protocol that EfiUtilityLib can use to implement DEBUG () and ASSERT ()\r
  // Macros.\r
  //\r
  InstallStatusCodeDebugAssert ();\r
\r
  return EFI_SUCCESS;\r
}\r