]> git.proxmox.com Git - mirror_edk2.git/blobdiff - EdkModulePkg/Universal/StatusCode/Dxe/Ipf/DxeStatusCodeIpf.c
Added the StatusCode protocol installation for the IPF architecture; removed the...
[mirror_edk2.git] / EdkModulePkg / Universal / StatusCode / Dxe / Ipf / DxeStatusCodeIpf.c
index 614ad5094e8704f338550e3bbc4d2cf2004acde1..506a2a1a91fbb01692e39416733d17d287037687 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
 * Status code driver for IPF architecture.\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
+  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:  DxeStatusCodeIpf.c\r
 \r
 #include "DxeStatusCode.h"\r
 \r
 \r
+/**\r
+  Report status code to all supported device.\r
+  Calls into the workers which dispatches the platform specific\r
+  listeners.\r
+\r
+  @param  Type          Indicates the type of status code being reported.\r
+                        The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
+  @param  Value         Describes the current status of a hardware or software entity.\r
+                        This includes information about the class and subclass that is used to classify the entity\r
+                        as well as an operation.  For progress codes, the operation is the current activity.\r
+                        For error codes, it is the exception.  For debug codes, it is not defined at this time.\r
+                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.\r
+                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
+  @param  Instance      The enumeration of a hardware or software entity within the system.\r
+                        A system may contain multiple entities that match a class/subclass pairing.\r
+                        The instance differentiates between them.  An instance of 0 indicates that instance\r
+                        information is unavailable, not meaningful, or not relevant.  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 different callers.\r
+  @param  Data          This optional parameter may be used to pass additional data.\r
+                        Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.\r
+                        The contents of this data type may have additional GUID-specific data.  The standard GUIDs and\r
+                        their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.\r
+\r
+  @return               Always return EFI_SUCCESS.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ReportDispatcher (\r
+  IN EFI_STATUS_CODE_TYPE     Type,\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
+// Declaration of status code protocol.\r
+//\r
+STATIC\r
+EFI_STATUS_CODE_PROTOCOL  mEfiStatusCodeProtocol  = {\r
+  ReportDispatcher\r
+};\r
+\r
 //\r
-// Delaration of DXE status code controller \r
+// Delaration of DXE status code controller\r
 //\r
 DXE_STATUS_CODE_CONTROLLER gDxeStatusCode = {\r
   //\r
-  // Initialize nest status as non nested. \r
-  // \r
+  // Initialize nest status as non nested.\r
+  //\r
   0,\r
   {NULL, NULL}\r
 };\r
 \r
+/**\r
+  Report status code to all supported device.\r
+  Calls into the workers which dispatches the platform specific\r
+  listeners.\r
+\r
+  @param  CodeType      Indicates the type of status code being reported.\r
+                        The type EFI_STATUS_CODE_TYPE is defined in "Related Definitions" below.\r
+  @param  Value         Describes the current status of a hardware or software entity.\r
+                        This includes information about the class and subclass that is used to classify the entity\r
+                        as well as an operation.  For progress codes, the operation is the current activity.\r
+                        For error codes, it is the exception.  For debug codes, it is not defined at this time.\r
+                        Type EFI_STATUS_CODE_VALUE is defined in "Related Definitions" below.\r
+                        Specific values are discussed in the Intel? Platform Innovation Framework for EFI Status Code Specification.\r
+  @param  Instance      The enumeration of a hardware or software entity within the system.\r
+                        A system may contain multiple entities that match a class/subclass pairing.\r
+                        The instance differentiates between them.  An instance of 0 indicates that instance\r
+                        information is unavailable, not meaningful, or not relevant.  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 different callers.\r
+  @param  Data          This optional parameter may be used to pass additional data.\r
+                        Type EFI_STATUS_CODE_DATA is defined in "Related Definitions" below.\r
+                        The contents of this data type may have additional GUID-specific data.  The standard GUIDs and\r
+                        their associated data structures are defined in the Intel? Platform Innovation Framework for EFI Status Codes Specification.\r
+\r
+  @return               Always return EFI_SUCCESS.\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 (1 == InterlockedCompareExchange32 (&gDxeStatusCode.StatusCodeNestStatus, 0, 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
+      gDxeStatusCode.RtMemoryStatusCodeTable[PHYSICAL_MODE],\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
+    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 (&gDxeStatusCode.StatusCodeNestStatus, 1, 0);\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+\r
 /**\r
 \r
   Main entry for Extended SAL ReportStatusCode Services\r
@@ -35,15 +170,15 @@ DXE_STATUS_CODE_CONTROLLER gDxeStatusCode = {
   @param FunctionId        Function Id which needed to be called\r
   @param Arg2              Efi status code type\r
   @param Arg3              Efi status code value\r
-  @param Arg4              Instance number \r
+  @param Arg4              Instance number\r
   @param Arg5              Caller Id\r
   @param Arg6              Efi status code data\r
-  @param Arg7              Not used       \r
-  @param Arg8              Not used       \r
-  @param ExtendedSalProc   Esal Proc pointer    \r
+  @param Arg7              Not used\r
+  @param Arg8              Not used\r
+  @param ExtendedSalProc   Esal Proc pointer\r
   @param VirtualMode       If this function is called in virtual mode\r
   @param Global            This module's global variable pointer\r
-  \r
+\r
   @return Value returned in SAL_RETURN_REGS\r
 \r
 --*/\r
@@ -150,19 +285,32 @@ DxeStatusCodeDriverEntry (
   IN EFI_SYSTEM_TABLE  *SystemTable\r
   )\r
 {\r
-  EFI_STATUS Status;\r
+  EFI_STATUS  Status;\r
+  EFI_HANDLE  Handle       = NULL;\r
 \r
   //\r
   // Dispatch initialization request to supported devices\r
   //\r
   InitializationDispatcherWorker ();\r
 \r
+  //\r
+  // Install Status Code Architectural Protocol implementation as defined in Tiano\r
+  // Architecture Specification.\r
+  //\r
+  Status = gBS->InstallMultipleProtocolInterfaces (\r
+                  &Handle,\r
+                  &gEfiStatusCodeRuntimeProtocolGuid,\r
+                  &mEfiStatusCodeProtocol,\r
+                  NULL\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
   //\r
   // Initialize ESAL capabilities.\r
   //\r
   Status = RegisterEsalClass (\r
              &gEfiExtendedSalStatusCodeServicesProtocolGuid,\r
-             &gDxeStatusCode,\r
+            &gDxeStatusCode,\r
              ReportEsalServiceEntry,\r
              StatusCode,\r
              NULL\r
@@ -174,7 +322,7 @@ DxeStatusCodeDriverEntry (
 \r
 \r
 /**\r
-  Virtual address change notification call back. It converts physical mode global pointer to \r
+  Virtual address change notification call back. It converts physical mode global pointer to\r
   virtual mode.\r
 \r
   @param  Event         Event whose notification function is being invoked.\r
@@ -189,7 +337,7 @@ VirtualAddressChangeCallBack (
   IN VOID             *Context\r
   )\r
 {\r
-  gDxeStatusCode.RtMemoryStatusCodeTable[VIRTUAL_MODE] = \r
+  gDxeStatusCode.RtMemoryStatusCodeTable[VIRTUAL_MODE] =\r
     gDxeStatusCode.RtMemoryStatusCodeTable[PHYSICAL_MODE];\r
 \r
   //\r