Code scrub for SmmRuntimeDxeReportStatusCodeLibFramework.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8602 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 203 insertions, 336 deletions

diff --git a/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLib.c b/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLib.c
index b4d677ef4..165fc4abc 100644
--- a/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLib.c
+++ b/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLib.c
@@ -1,7 +1,7 @@
 /** @file

-  Report Status Code Library for SMM Runtime driver.

+  API implementation for instance of Report Status Code Library.

 

-  Copyright (c) 2006 - 2007, Intel Corporation<BR>

+  Copyright (c) 2006 - 2009, Intel Corporation<BR>

   All rights reserved. This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -14,91 +14,6 @@
 

 #include "ReportStatusCodeLibInternal.h"

 

-

- 

-EFI_REPORT_STATUS_CODE  mReportStatusCode = NULL;

-

-/**

-  Internal worker function that reports a status code through the Status Code Protocol

-

-  This function checks to see if a Status Code Protocol is present in the handle

-  database.  If a Status Code Protocol is not present, then EFI_UNSUPPORTED is

-  returned.  If a Status Code Protocol is present, then it is cached in gStatusCode,

-  and the ReportStatusCode() service of the Status Code Protocol is called passing in

-  Type, Value, Instance, CallerId, and Data.  The result of this call is returned.

-

-  @param  Type              Status code type.

-  @param  Value             Status code value.

-  @param  Instance          Status code instance number.

-  @param  CallerId          Pointer to a GUID that identifies the caller of this

-                            function.  This is an optional parameter that may be

-                            NULL.

-  @param  Data              Pointer to the extended data buffer.  This is an

-                            optional parameter that may be NULL.

-

-  @retval  EFI_SUCCESS           The status code was reported.

-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to report the status code.

-  @retval  EFI_UNSUPPORTED       Status Code Protocol is not available.

-

-**/

-EFI_STATUS

-InternalReportStatusCode (

-  IN EFI_STATUS_CODE_TYPE     Type,

-  IN EFI_STATUS_CODE_VALUE    Value,

-  IN UINT32                   Instance,

-  IN CONST EFI_GUID           *CallerId OPTIONAL,

-  IN EFI_STATUS_CODE_DATA     *Data     OPTIONAL

-  )

-{

-  //

-  // If gStatusCode is NULL, then see if a Status Code Protocol instance is present

-  // in the handle database.

-  //

-  if (mReportStatusCode == NULL) {

-    mReportStatusCode = InternalGetReportStatusCode ();

-    if (mReportStatusCode == NULL) {

-      return EFI_UNSUPPORTED;

-    }

-  }

-

-  //

-  // A Status Code Protocol is present in the handle database, so pass in all the

-  // parameters to the ReportStatusCode() service of the Status Code Protocol

-  //

-  return (*mReportStatusCode) (Type, Value, Instance, (EFI_GUID *)CallerId, Data);

-}

-

-

-/**

-  Computes and returns the size, in bytes, of a device path.

-

-  @param  DevicePath  A pointer to a device path.

-

-  @return  The size, in bytes, of DevicePath.

-

-**/

-UINTN

-InternalReportStatusCodeDevicePathSize (

-  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath

-  )

-{

-  CONST EFI_DEVICE_PATH_PROTOCOL  *Start;

-

-  //

-  // Search for the end of the device path structure

-  //

-  Start = DevicePath;

-  while (!IsDevicePathEnd (DevicePath)) {

-    DevicePath = NextDevicePathNode (DevicePath);

-  }

-

-  //

-  // Subtract the start node from the end node and add in the size of the end node

-  //

-  return ((UINTN) DevicePath - (UINTN) Start) + DevicePathNodeLength (DevicePath);

-}

-

-

 /**

   Converts a status code to an 8-bit POST code value.

 

@@ -250,8 +165,8 @@ ReportStatusCodeExtractDebugInfo (
 {

   EFI_DEBUG_INFO  *DebugInfo;

 

-  ASSERT (Data          != NULL);

-  ASSERT (ErrorLevel    != NULL);

+  ASSERT (Data       != NULL);

+  ASSERT (ErrorLevel != NULL);

   ASSERT (Marker     != NULL);

   ASSERT (Format     != NULL);

 

@@ -270,8 +185,13 @@ ReportStatusCodeExtractDebugInfo (
   *ErrorLevel = DebugInfo->ErrorLevel;

 

   //

-  // The first 12 * UINTN bytes of the string are really an

-  // argument stack to support varargs on the Format string.

+  // The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments

+  // of format in DEBUG string. Its address is returned in Marker and has to be 64-bit aligned.

+  // It must be noticed that EFI_DEBUG_INFO follows EFI_STATUS_CODE_DATA, whose size is

+  // 20 bytes. The size of EFI_DEBUG_INFO is 4 bytes, so we can ensure that Marker

+  // returned is 64-bit aligned.

+  // 64-bit aligned is a must, otherwise retrieving 64-bit parameter from BASE_LIST will

+  // cause unalignment exception.

   //

   *Marker = (BASE_LIST) (DebugInfo + 1);

   *Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);

@@ -353,7 +273,7 @@ ReportStatusCodeWithDevicePath (
            Type,

            Value,

            (VOID *)DevicePath,

-           InternalReportStatusCodeDevicePathSize (DevicePath)

+           GetDevicePathSize (DevicePath)

            );

 }

 

@@ -424,7 +344,7 @@ ReportStatusCodeWithExtendedData (
   is responsible for allocating a buffer large enough for the standard header and

   the extended data passed into this function.  The standard header is filled in

   with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a

-  GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with

+  GUID of gEfiStatusCodeSpecificDataGuid is used.  The status code is reported with

   an instance specified by Instance and a caller ID specified by CallerId.  If

   CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.

 

@@ -468,17 +388,39 @@ ReportStatusCodeEx (
   IN UINTN                  ExtendedDataSize

   )

 {

-  EFI_STATUS  Status;

-

-  Status = InternalReportStatusCodeEx (

-             Type,

-             Value,

-             Instance,

-             CallerId,

-             ExtendedDataGuid,

-             ExtendedData,

-             ExtendedDataSize

-             );

+  EFI_STATUS            Status;

+

+  ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));

+  ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));

+

+  if (ExtendedDataSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {

+    return EFI_OUT_OF_RESOURCES;

+  }

+

+  //

+  // Fill in the extended data header

+  //

+  mStatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);

+  mStatusCodeData->Size = (UINT16)ExtendedDataSize;

+  if (ExtendedDataGuid == NULL) {

+    ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;

+  }

+  CopyGuid (&mStatusCodeData->Type, ExtendedDataGuid);

+

+  //

+  // Fill in the extended data buffer

+  //

+  if (ExtendedData != NULL) {

+    CopyMem (mStatusCodeData + 1, ExtendedData, ExtendedDataSize);

+  }

+

+  //

+  // Report the status code

+  //

+  if (CallerId == NULL) {

+    CallerId = &gEfiCallerIdGuid;

+  }

+  Status = InternalReportStatusCode (Type, Value, Instance, CallerId, mStatusCodeData);

 

   return Status;

 }

@@ -502,7 +444,7 @@ ReportProgressCodeEnabled (
   VOID

   )

 {

-  return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);

+  return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);

 }

 

 

@@ -524,7 +466,7 @@ ReportErrorCodeEnabled (
   VOID

   )

 {

-  return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);

+  return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);

 }

 

 

@@ -546,5 +488,5 @@ ReportDebugCodeEnabled (
   VOID

   )

 {

-  return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);

+  return (BOOLEAN) ((PcdGet8 (PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);

 }

diff --git a/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLibInternal.h b/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLibInternal.h
index f85d0bf11..7faff0bce 100644
--- a/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLibInternal.h
+++ b/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/ReportStatusCodeLibInternal.h
@@ -2,7 +2,7 @@
   Internal Header file of Report Status Code Library for RUNTIME

   DXE Phase.

 

-  Copyright (c) 2006 - 2007, Intel Corporation<BR>

+  Copyright (c) 2006 - 2009, Intel Corporation<BR>

   All rights reserved. This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -12,8 +12,8 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 **/

-#ifndef __REPORT_STATUS_CODE_LIB_INTERNAL__H

-#define __REPORT_STATUS_CODE_LIB_INTERNAL__H

+#ifndef __REPORT_STATUS_CODE_LIB_INTERNAL__H__

+#define __REPORT_STATUS_CODE_LIB_INTERNAL__H__

 

 #include <FrameworkDxe.h>

 

@@ -25,19 +25,29 @@
 #include <Library/UefiRuntimeServicesTableLib.h>

 #include <Library/UefiBootServicesTableLib.h>

 #include <Library/DevicePathLib.h>

+#include <Library/OemHookStatusCodeLib.h>

+#include <Library/MemoryAllocationLib.h>

 

 #include <Guid/StatusCodeDataTypeId.h>

 #include <Guid/StatusCodeDataTypeDebug.h>

 #include <Guid/EventGroup.h>

+

 #include <Protocol/StatusCode.h>

+#include <Protocol/SmmBase.h>

+

 

-extern EFI_REPORT_STATUS_CODE  mReportStatusCode;

+extern EFI_STATUS_CODE_DATA    *mStatusCodeData;

 

 /**

-  Locatet he report status code service.

+  Locate the report status code service.

+

+  In SMM, it retrieves OemHookStatusCodeReport() from customized OEM Hook Status Code Lib.

+  Otherwise, it first tries to retrieve ReportStatusCode() in Runtime Services Table.

+  If not found, it then tries to retrieve ReportStatusCode() API of Report Status Code Protocol.

+

+  @return   Function pointer to the report status code service.

+            NULL is returned if no status code service is available.

 

-  @return     EFI_REPORT_STATUS_CODE    function point to

-              ReportStatusCode.

 **/

 EFI_REPORT_STATUS_CODE

 InternalGetReportStatusCode (

@@ -45,13 +55,12 @@ InternalGetReportStatusCode (
   );

 

 /**

-  Internal worker function that reports a status code through the Status Code Protocol

+  Internal worker function that reports a status code through the status code service.

 

-  This function checks to see if a Status Code Protocol is present in the handle

-  database.  If a Status Code Protocol is not present, then EFI_UNSUPPORTED is

-  returned.  If a Status Code Protocol is present, then it is cached in gStatusCode,

-  and the ReportStatusCode() service of the Status Code Protocol is called passing in

-  Type, Value, Instance, CallerId, and Data.  The result of this call is returned.

+  If status code service is not cached, then this function checks if status code service is

+  available in system.  If status code service is not available, then EFI_UNSUPPORTED is

+  returned.  If status code service is present, then it is cached in mReportStatusCode.

+  Finally this function reports status code through the status code service.

 

   @param  Type              Status code type.

   @param  Value             Status code value.

@@ -62,9 +71,9 @@ InternalGetReportStatusCode (
   @param  Data              Pointer to the extended data buffer.  This is an

                             optional parameter that may be NULL.

 

-  @retval  EFI_SUCCESS           The status code was reported.

-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to report the status code.

-  @retval  EFI_UNSUPPORTED       Status Code Protocol is not available.

+  @retval EFI_SUCCESS       The status code was reported.

+  @retval EFI_UNSUPPORTED   Status code service is not available.

+  @retval EFI_UNSUPPORTED   Status code type is not supported.

 

 **/

 EFI_STATUS

@@ -76,60 +85,5 @@ InternalReportStatusCode (
   IN EFI_STATUS_CODE_DATA     *Data     OPTIONAL

   );

 

-/**

-  Reports a status code with full parameters.

-

-  The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize

-  is 0, then an extended data buffer is not reported.  If ExtendedData is not

-  NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.

-  ExtendedData is assumed not have the standard status code header, so this function

-  is responsible for allocating a buffer large enough for the standard header and

-  the extended data passed into this function.  The standard header is filled in

-  with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a

-  GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with

-  an instance specified by Instance and a caller ID specified by CallerId.  If

-  CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.

-

-  ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx()

-  is called while processing another any other Report Status Code Library function,

-  then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.

-

-  If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().

-  If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().

-

-  @param  Type              Status code type.

-  @param  Value             Status code value.

-  @param  Instance          Status code instance number.

-  @param  CallerId          Pointer to a GUID that identifies the caller of this

-                            function.  If this parameter is NULL, then a caller

-                            ID of gEfiCallerIdGuid is used.

-  @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.

-                            If this parameter is NULL, then a the status code

-                            standard header is filled in with

-                            gEfiStatusCodeSpecificDataGuid.

-  @param  ExtendedData      Pointer to the extended data buffer.  This is an

-                            optional parameter that may be NULL.

-  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.

-

-  @retval  EFI_SUCCESS           The status code was reported.

-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate

-                                 the extended data section if it was specified.

-  @retval  EFI_UNSUPPORTED       Report status code is not supported

-

-**/

-EFI_STATUS

-EFIAPI

-InternalReportStatusCodeEx (

-  IN EFI_STATUS_CODE_TYPE   Type,

-  IN EFI_STATUS_CODE_VALUE  Value,

-  IN UINT32                 Instance,

-  IN CONST EFI_GUID         *CallerId          OPTIONAL,

-  IN CONST EFI_GUID         *ExtendedDataGuid  OPTIONAL,

-  IN CONST VOID             *ExtendedData      OPTIONAL,

-  IN UINTN                  ExtendedDataSize

-  );

-

-

-

-#endif // __REPORT_STATUS_CODE_LIB_INTERNAL__H

+#endif

 

diff --git a/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeReportStatusCodeLibFramework.inf b/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeReportStatusCodeLibFramework.inf
index bd8006db1..28a5a0f41 100644
--- a/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeReportStatusCodeLibFramework.inf
+++ b/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeReportStatusCodeLibFramework.inf
@@ -1,7 +1,10 @@
 #/** @file

-#  DXE report status code library

+#  Report status code library instance which supports logging message in SMM, as well as DXE & runtime phase.

+#

+#  This library instance supports status code report in SMM, as well as DXE & runtime phase.

+#  In SMM, it logs message via customized OemHookStatusCodeLib.

+#  Otherwise, it logs message to ReportStatusCode() in framework runtime services table or runtime report status code protocol.

 #

-#  Retrieve status code and report status code in DXE phase

 #  Copyright (c) 2006 - 2009, Intel Corporation.

 #

 #  All rights reserved. This program and the accompanying materials

@@ -21,7 +24,6 @@
   MODULE_TYPE                    = DXE_RUNTIME_DRIVER

   VERSION_STRING                 = 1.0

   LIBRARY_CLASS                  = ReportStatusCodeLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER UEFI_APPLICATION UEFI_DRIVER DXE_SMM_DRIVER

-  EFI_SPECIFICATION_VERSION      = 0x00020000

   

   CONSTRUCTOR                    = ReportStatusCodeLibConstruct

   DESTRUCTOR                     = ReportStatusCodeLibDestruct

@@ -34,7 +36,7 @@
 [Sources.common]

   ReportStatusCodeLib.c

   SmmRuntimeDxeSupport.c

-

+  ReportStatusCodeLibInternal.h

 

 

 [Packages]

@@ -51,17 +53,18 @@
   UefiBootServicesTableLib

   OemHookStatusCodeLib

   DevicePathLib

+  MemoryAllocationLib

 

 [Guids]

-  gEfiStatusCodeSpecificDataGuid                # ALWAYS_CONSUMED

-  gEfiStatusCodeDataTypeDebugGuid               # ALWAYS_CONSUMED

-  gEfiEventExitBootServicesGuid

-  gEfiEventVirtualAddressChangeGuid

+  gEfiStatusCodeSpecificDataGuid                ## CONSUMES

+  gEfiStatusCodeDataTypeDebugGuid               ## CONSUMES

+  gEfiEventExitBootServicesGuid                 ## CONSUMES ## Event

+  gEfiEventVirtualAddressChangeGuid             ## CONSUMES ## Event

 

 

 [Protocols]

-  gEfiStatusCodeRuntimeProtocolGuid             # PROTOCOL ALWAYS_CONSUMED

-  gEfiSmmBaseProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED

+  gEfiStatusCodeRuntimeProtocolGuid             ## CONSUMES

+  gEfiSmmBaseProtocolGuid                       ## CONSUMES

 

 

 [Pcd.common]

diff --git a/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeSupport.c b/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeSupport.c
index e176ecc36..089b9c5db 100644
--- a/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeSupport.c
+++ b/IntelFrameworkModulePkg/Library/SmmRuntimeDxeReportStatusCodeLibFramework/SmmRuntimeDxeSupport.c
@@ -1,7 +1,7 @@
 /** @file

-  Report Status Code Library for DXE Phase.

+  Library constructor & destructor, event handlers, and other internal worker functions.

 

-  Copyright (c) 2006 - 2007, Intel Corporation<BR>

+  Copyright (c) 2006 - 2009, Intel Corporation<BR>

   All rights reserved. This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

   which accompanies this distribution.  The full text of the license may be found at

@@ -14,31 +14,25 @@
 

 #include "ReportStatusCodeLibInternal.h"

 

-//

-// Resources need by SMM runtime instance

-// 

-#include <Library/OemHookStatusCodeLib.h>

-#include <Protocol/SmmBase.h>

+EFI_EVENT               mVirtualAddressChangeEvent;

+EFI_EVENT               mExitBootServicesEvent;

+EFI_STATUS_CODE_DATA    *mStatusCodeData;

+BOOLEAN                 mInSmm;

+EFI_SMM_BASE_PROTOCOL   *mSmmBase;

+EFI_RUNTIME_SERVICES    *mInternalRT;

+BOOLEAN                 mHaveExitedBootServices = FALSE;

+EFI_REPORT_STATUS_CODE  mReportStatusCode = NULL;

 

-EFI_EVENT             mVirtualAddressChangeEvent;

-

-EFI_EVENT             mExitBootServicesEvent;

-

-EFI_STATUS_CODE_DATA  *mStatusCodeData;

-

-BOOLEAN               mInSmm;

-

-EFI_SMM_BASE_PROTOCOL *mSmmBase;

-

-EFI_RUNTIME_SERVICES  *mRT;

+/**

+  Locate the report status code service.

 

-BOOLEAN               mHaveExitedBootServices = FALSE;

+  In SMM, it retrieves OemHookStatusCodeReport() from customized OEM Hook Status Code Lib.

+  Otherwise, it first tries to retrieve ReportStatusCode() in Runtime Services Table.

+  If not found, it then tries to retrieve ReportStatusCode() API of Report Status Code Protocol.

 

-/**

-  Locate he report status code service.

+  @return   Function pointer to the report status code service.

+            NULL is returned if no status code service is available.

 

-  @return     EFI_REPORT_STATUS_CODE    function point to

-              ReportStatusCode.

 **/

 EFI_REPORT_STATUS_CODE

 InternalGetReportStatusCode (

@@ -50,8 +44,8 @@ InternalGetReportStatusCode (
 

   if (mInSmm) {

     return (EFI_REPORT_STATUS_CODE) OemHookStatusCodeReport;

-  } else if (mRT != NULL && mRT->Hdr.Revision < 0x20000) {

-    return ((FRAMEWORK_EFI_RUNTIME_SERVICES*)mRT)->ReportStatusCode;

+  } else if (mInternalRT != NULL && mInternalRT->Hdr.Revision < 0x20000) {

+    return ((FRAMEWORK_EFI_RUNTIME_SERVICES*)mInternalRT)->ReportStatusCode;

   } else if (!mHaveExitedBootServices) {

   	//

   	// Check gBS just in case. ReportStatusCode is called before gBS is initialized.

@@ -67,12 +61,65 @@ InternalGetReportStatusCode (
   return NULL;

 }

 

+/**

+  Internal worker function that reports a status code through the status code service.

+

+  If status code service is not cached, then this function checks if status code service is

+  available in system.  If status code service is not available, then EFI_UNSUPPORTED is

+  returned.  If status code service is present, then it is cached in mReportStatusCode.

+  Finally this function reports status code through the status code service.

+

+  @param  Type              Status code type.

+  @param  Value             Status code value.

+  @param  Instance          Status code instance number.

+  @param  CallerId          Pointer to a GUID that identifies the caller of this

+                            function.  This is an optional parameter that may be

+                            NULL.

+  @param  Data              Pointer to the extended data buffer.  This is an

+                            optional parameter that may be NULL.

+

+  @retval EFI_SUCCESS       The status code was reported.

+  @retval EFI_UNSUPPORTED   Status code service is not available.

+  @retval EFI_UNSUPPORTED   Status code type is not supported.

+

+**/

+EFI_STATUS

+InternalReportStatusCode (

+  IN EFI_STATUS_CODE_TYPE     Type,

+  IN EFI_STATUS_CODE_VALUE    Value,

+  IN UINT32                   Instance,

+  IN CONST EFI_GUID           *CallerId OPTIONAL,

+  IN EFI_STATUS_CODE_DATA     *Data     OPTIONAL

+  )

+{

+  if ((ReportProgressCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||

+      (ReportErrorCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE) ||

+      (ReportDebugCodeEnabled() && ((Type) & EFI_STATUS_CODE_TYPE_MASK) == EFI_DEBUG_CODE)) {

+    //

+    // If mReportStatusCode is NULL, then check if status code service is available in system.

+    //

+    if (mReportStatusCode == NULL) {

+      mReportStatusCode = InternalGetReportStatusCode ();

+      if (mReportStatusCode == NULL) {

+        return EFI_UNSUPPORTED;

+      }

+    }

+  

+    //

+    // A status code service is present in system, so pass in all the parameters to the service.

+    //

+    return (*mReportStatusCode) (Type, Value, Instance, (EFI_GUID *)CallerId, Data);

+  }

+  

+  return EFI_UNSUPPORTED;

+}

 

 /**

-  Fixup internal report status code protocol interface.

+  Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.

+

+  @param  Event        Event whose notification function is being invoked.

+  @param  Context      Pointer to the notification function's context

 

-  @param[in]    Event   The Event that is being processed

-  @param[in]    Context Event Context

 **/

 VOID

 EFIAPI

@@ -81,18 +128,19 @@ ReportStatusCodeLibVirtualAddressChange (
   IN VOID             *Context

   )

 {

-  if (NULL != mReportStatusCode) {

-    mRT->ConvertPointer (0, (VOID **) &mReportStatusCode);

+  if (mReportStatusCode != NULL) {

+    mInternalRT->ConvertPointer (0, (VOID **) &mReportStatusCode);

   }

-  mRT->ConvertPointer (0, (VOID **) &mStatusCodeData);

-  mRT->ConvertPointer (0, (VOID **) &mRT);

+  mInternalRT->ConvertPointer (0, (VOID **) &mStatusCodeData);

+  mInternalRT->ConvertPointer (0, (VOID **) &mInternalRT);

 }

 

 /**

-  Update the In Runtime Indicator.

+  Notification function of EVT_SIGNAL_EXIT_BOOT_SERVICES.

+

+  @param  Event        Event whose notification function is being invoked.

+  @param  Context      Pointer to the notification function's context

 

-  @param[in]    Event   The Event that is being processed

-  @param[in]    Context Event Context

 **/

 VOID

 EFIAPI

@@ -105,12 +153,16 @@ ReportStatusCodeLibExitBootServices (
 }

 

 /**

-  Intialize Report Status Code Lib.

+  The constructor function of SMM Runtime DXE Report Status Code Lib.

 

-  @param[in]  ImageHandle   The firmware allocated handle for the EFI image.

-  @param[in]  SystemTable   A pointer to the EFI System Table.

+  This function allocates memory for extended status code data, caches

+  the report status code service, and registers events.

+

+  @param  ImageHandle   The firmware allocated handle for the EFI image.

+  @param  SystemTable   A pointer to the EFI System Table.

+  

+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.

 

-  @return     EFI_STATUS    always returns EFI_SUCCESS.

 **/

 EFI_STATUS

 EFIAPI

@@ -119,12 +171,11 @@ ReportStatusCodeLibConstruct (
   IN EFI_SYSTEM_TABLE     *SystemTable

   )

 {

-  EFI_STATUS            Status;

+  EFI_STATUS     Status;

 

   //

-  // SMM driver depends on the SMM BASE protocol.

-  // the SMM driver must be success to locate protocol.

-  // 

+  // If in SMM mode, then allocates memory from SMRAM for extended status code data.

+  //

   Status = gBS->LocateProtocol (&gEfiSmmBaseProtocolGuid, NULL, (VOID **) &mSmmBase);

   if (!EFI_ERROR (Status)) {

     mSmmBase->InSmm (mSmmBase, &mInSmm);

@@ -141,22 +192,24 @@ ReportStatusCodeLibConstruct (
     }

   }

 

+

   //

-  // Library should not use the gRT directly, since it

-  // may be converted by other library instance.

+  // If not in SMM mode, then allocate runtime memory for extended status code data.

+  //

+  // Library should not use the gRT directly, for it may be converted by other library instance.

   // 

-  mRT     = gRT;

-  mInSmm  = FALSE;

+  mInternalRT = gRT;

+  mInSmm      = FALSE;

 

-  gBS->AllocatePool (EfiRuntimeServicesData, sizeof (EFI_STATUS_CODE_DATA) + EFI_STATUS_CODE_DATA_MAX_SIZE, (VOID **)&mStatusCodeData);

-  ASSERT (NULL != mStatusCodeData);

+  mStatusCodeData = AllocateRuntimePool (sizeof (EFI_STATUS_CODE_DATA) + EFI_STATUS_CODE_DATA_MAX_SIZE);

+  ASSERT (mStatusCodeData != NULL);

   //

   // Cache the report status code service

   // 

   mReportStatusCode = InternalGetReportStatusCode ();

 

   //

-  // Register the call back of virtual address change

+  // Register notify function for EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE

   // 

   Status = gBS->CreateEventEx (

                   EVT_NOTIFY_SIGNAL,

@@ -168,9 +221,8 @@ ReportStatusCodeLibConstruct (
                   );

   ASSERT_EFI_ERROR (Status);

 

-

   //

-  // Register the call back of virtual address change

+  // Register notify function for EVT_SIGNAL_EXIT_BOOT_SERVICES

   // 

   Status = gBS->CreateEventEx (

                   EVT_NOTIFY_SIGNAL,

@@ -182,15 +234,20 @@ ReportStatusCodeLibConstruct (
                   );

   ASSERT_EFI_ERROR (Status);

 

-  return Status;

+  return EFI_SUCCESS;

 }

 

 /**

-  Desctructor of library will close events.

+  The destructor function of SMM Runtime DXE Report Status Code Lib.

+  

+  The destructor function frees memory allocated by constructor, and closes related events.

+  It will ASSERT() if that related operation fails and it will always return EFI_SUCCESS. 

+

+  @param  ImageHandle   The firmware allocated handle for the EFI image.

+  @param  SystemTable   A pointer to the EFI System Table.

   

-  @param ImageHandle callder module's image handle

-  @param SystemTable pointer to EFI system table.

-  @return the status of close event.

+  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.

+

 **/

 EFI_STATUS

 EFIAPI

@@ -202,16 +259,13 @@ ReportStatusCodeLibDestruct (
   EFI_STATUS  Status;

 

   if (!mInSmm) {

-    //

-    // Close SetVirtualAddressMap () notify function

-    //

     ASSERT (gBS != NULL);

     Status = gBS->CloseEvent (mVirtualAddressChangeEvent);

     ASSERT_EFI_ERROR (Status);

     Status = gBS->CloseEvent (mExitBootServicesEvent);

     ASSERT_EFI_ERROR (Status);

 

-    gBS->FreePool (mStatusCodeData);

+    FreePool (mStatusCodeData);

   } else {

     mSmmBase->SmmFreePool (mSmmBase, mStatusCodeData);

   }

@@ -219,89 +273,3 @@ ReportStatusCodeLibDestruct (
   return EFI_SUCCESS;

 }

 

-/**

-  Reports a status code with full parameters.

-

-  The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize

-  is 0, then an extended data buffer is not reported.  If ExtendedData is not

-  NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.

-  ExtendedData is assumed not have the standard status code header, so this function

-  is responsible for allocating a buffer large enough for the standard header and

-  the extended data passed into this function.  The standard header is filled in

-  with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a

-  GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with

-  an instance specified by Instance and a caller ID specified by CallerId.  If

-  CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.

-

-  ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx()

-  is called while processing another any other Report Status Code Library function,

-  then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.

-

-  If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().

-  If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().

-

-  @param  Type              Status code type.

-  @param  Value             Status code value.

-  @param  Instance          Status code instance number.

-  @param  CallerId          Pointer to a GUID that identifies the caller of this

-                            function.  If this parameter is NULL, then a caller

-                            ID of gEfiCallerIdGuid is used.

-  @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.

-                            If this parameter is NULL, then a the status code

-                            standard header is filled in with

-                            gEfiStatusCodeSpecificDataGuid.

-  @param  ExtendedData      Pointer to the extended data buffer.  This is an

-                            optional parameter that may be NULL.

-  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.

-

-  @retval  EFI_SUCCESS           The status code was reported.

-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate

-                                 the extended data section if it was specified.

-  @retval  EFI_UNSUPPORTED       Report status code is not supported

-

-**/

-EFI_STATUS

-EFIAPI

-InternalReportStatusCodeEx (

-  IN EFI_STATUS_CODE_TYPE   Type,

-  IN EFI_STATUS_CODE_VALUE  Value,

-  IN UINT32                 Instance,

-  IN CONST EFI_GUID         *CallerId          OPTIONAL,

-  IN CONST EFI_GUID         *ExtendedDataGuid  OPTIONAL,

-  IN CONST VOID             *ExtendedData      OPTIONAL,

-  IN UINTN                  ExtendedDataSize

-  )

-{

-  ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));

-  ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));

-

-  if (ExtendedDataSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {

-    return EFI_OUT_OF_RESOURCES;

-  }

-

-  //

-  // Fill in the extended data header

-  //

-  mStatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);

-  mStatusCodeData->Size = (UINT16)ExtendedDataSize;

-  if (ExtendedDataGuid == NULL) {

-    ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;

-  }

-  CopyGuid (&mStatusCodeData->Type, ExtendedDataGuid);

-

-  //

-  // Fill in the extended data buffer

-  //

-  if (ExtendedData != NULL) {

-    CopyMem (mStatusCodeData + 1, ExtendedData, ExtendedDataSize);

-  }

-

-  //

-  // Report the status code

-  //

-  if (CallerId == NULL) {

-    CallerId = &gEfiCallerIdGuid;

-  }

-  return  InternalReportStatusCode (Type, Value, Instance, CallerId, mStatusCodeData);

-}

-