Add GlueLib SmmRuntimeDxeReportStatusCodeLib into EdkCompatibilityPkg , which provide...
authorlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 15 Mar 2010 09:25:21 +0000 (09:25 +0000)
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 15 Mar 2010 09:25:21 +0000 (09:25 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk@10246 6f19259b-4bc3-4df7-8a09-765794883524

edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/ReportStatusCodeLib.c [new file with mode: 0644]
edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/ReportStatusCodeLibInternal.h [new file with mode: 0644]
edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/SmmRuntimeDxeReportStatusCodeLib.inf [new file with mode: 0644]
edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/SmmRuntimeDxeSupport.c [new file with mode: 0644]

diff --git a/edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/ReportStatusCodeLib.c b/edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/ReportStatusCodeLib.c
new file mode 100644 (file)
index 0000000..643c772
--- /dev/null
@@ -0,0 +1,557 @@
+/*++\r
+\r
+Copyright (c) 2004 - 2010, 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
+Module Name:\r
+\r
+  ReportStatusCodeLib.c\r
+  \r
+Abstract: \r
+\r
+  Report Status Code Library for SMM Runtime driver.\r
+\r
+--*/\r
+\r
+#include "ReportStatusCodeLibInternal.h"\r
+\r
\r
+EFI_REPORT_STATUS_CODE  mReportStatusCode = NULL;\r
+\r
+/**\r
+  Internal worker function that reports a status code through the Status Code Protocol\r
+\r
+  This function checks to see if a Status Code Protocol is present in the handle\r
+  database.  If a Status Code Protocol is not present, then EFI_UNSUPPORTED is\r
+  returned.  If a Status Code Protocol is present, then it is cached in gStatusCode,\r
+  and the ReportStatusCode() service of the Status Code Protocol is called passing in\r
+  Type, Value, Instance, CallerId, and Data.  The result of this call is returned.\r
+\r
+  @param  Type              Status code type.\r
+  @param  Value             Status code value.\r
+  @param  Instance          Status code instance number.\r
+  @param  CallerId          Pointer to a GUID that identifies the caller of this\r
+                            function.  This is an optional parameter that may be\r
+                            NULL.\r
+  @param  Data              Pointer to the extended data buffer.  This is an\r
+                            optional parameter that may be NULL.\r
+\r
+  @retval  EFI_SUCCESS           The status code was reported.\r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to report the status code.\r
+  @retval  EFI_UNSUPPORTED       Status Code Protocol is not available.\r
+\r
+**/\r
+EFI_STATUS\r
+InternalReportStatusCode (\r
+  IN EFI_STATUS_CODE_TYPE     Type,\r
+  IN EFI_STATUS_CODE_VALUE    Value,\r
+  IN UINT32                   Instance,\r
+  IN CONST EFI_GUID           *CallerId OPTIONAL,\r
+  IN EFI_STATUS_CODE_DATA     *Data     OPTIONAL\r
+  )\r
+{\r
+  //\r
+  // If gStatusCode is NULL, then see if a Status Code Protocol instance is present\r
+  // in the handle database.\r
+  //\r
+  if (mReportStatusCode == NULL) {\r
+    mReportStatusCode = InternalGetReportStatusCode ();\r
+    if (mReportStatusCode == NULL) {\r
+      return EFI_UNSUPPORTED;\r
+    }\r
+  }\r
+\r
+  //\r
+  // A Status Code Protocol is present in the handle database, so pass in all the\r
+  // parameters to the ReportStatusCode() service of the Status Code Protocol\r
+  //\r
+  return (*mReportStatusCode) (Type, Value, Instance, (EFI_GUID *)CallerId, Data);\r
+}\r
+\r
+\r
+/**\r
+  Computes and returns the size, in bytes, of a device path.\r
+\r
+  @param  DevicePath  A pointer to a device path.\r
+\r
+  @return  The size, in bytes, of DevicePath.\r
+\r
+**/\r
+UINTN\r
+InternalReportStatusCodeDevicePathSize (\r
+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
+  )\r
+{\r
+  CONST EFI_DEVICE_PATH_PROTOCOL  *Start;\r
+\r
+  //\r
+  // Search for the end of the device path structure\r
+  //\r
+  Start = DevicePath;\r
+  while (!IsDevicePathEnd (DevicePath)) {\r
+    DevicePath = NextDevicePathNode (DevicePath);\r
+  }\r
+\r
+  //\r
+  // Subtract the start node from the end node and add in the size of the end node\r
+  //\r
+  return ((UINTN) DevicePath - (UINTN) Start) + DevicePathNodeLength (DevicePath);\r
+}\r
+\r
+\r
+/**\r
+  Converts a status code to an 8-bit POST code value.\r
+\r
+  Converts the status code specified by CodeType and Value to an 8-bit POST code\r
+  and returns the 8-bit POST code in PostCode.  If CodeType is an\r
+  EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode\r
+  are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits\r
+  24..26 of Value., and TRUE is returned.  Otherwise, FALSE is returned.\r
+\r
+  If PostCode is NULL, then ASSERT().\r
+\r
+  @param  CodeType  The type of status code being converted.\r
+  @param  Value     The status code value being converted.\r
+  @param  PostCode  A pointer to the 8-bit POST code value to return.\r
+\r
+  @retval  TRUE   The status code specified by CodeType and Value was converted\r
+                  to an 8-bit POST code and returned in  PostCode.\r
+  @retval  FALSE  The status code specified by CodeType and Value could not be\r
+                  converted to an 8-bit POST code value.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+GlueCodeTypeToPostCode (\r
+  IN  EFI_STATUS_CODE_TYPE   CodeType,\r
+  IN  EFI_STATUS_CODE_VALUE  Value,\r
+  OUT UINT8                  *PostCode\r
+  )\r
+{\r
+  //\r
+  // If PostCode is NULL, then ASSERT()\r
+  //\r
+  ASSERT (PostCode != NULL);\r
+\r
+  //\r
+  // Convert Value to an 8 bit post code\r
+  //\r
+  if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||\r
+      ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE)       ) {\r
+    *PostCode  = (UINT8) ((((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5) |\r
+                          (((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f));\r
+    return TRUE;\r
+  }\r
+  return FALSE;\r
+}\r
+\r
+\r
+/**\r
+  Extracts ASSERT() information from a status code structure.\r
+\r
+  Converts the status code specified by CodeType, Value, and Data to the ASSERT()\r
+  arguments specified by Filename, Description, and LineNumber.  If CodeType is\r
+  an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and\r
+  Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract\r
+  Filename, Description, and LineNumber from the optional data area of the\r
+  status code buffer specified by Data.  The optional data area of Data contains\r
+  a Null-terminated ASCII string for the FileName, followed by a Null-terminated\r
+  ASCII string for the Description, followed by a 32-bit LineNumber.  If the\r
+  ASSERT() information could be extracted from Data, then return TRUE.\r
+  Otherwise, FALSE is returned.\r
+\r
+  If Data is NULL, then ASSERT().\r
+  If Filename is NULL, then ASSERT().\r
+  If Description is NULL, then ASSERT().\r
+  If LineNumber is NULL, then ASSERT().\r
+\r
+  @param  CodeType     The type of status code being converted.\r
+  @param  Value        The status code value being converted.\r
+  @param  Data         Pointer to status code data buffer.\r
+  @param  Filename     Pointer to the source file name that generated the ASSERT().\r
+  @param  Description  Pointer to the description of the ASSERT().\r
+  @param  LineNumber   Pointer to source line number that generated the ASSERT().\r
+\r
+  @retval  TRUE   The status code specified by CodeType, Value, and Data was\r
+                  converted ASSERT() arguments specified by Filename, Description,\r
+                  and LineNumber.\r
+  @retval  FALSE  The status code specified by CodeType, Value, and Data could\r
+                  not be converted to ASSERT() arguments.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+GlueReportStatusCodeExtractAssertInfo (\r
+  IN EFI_STATUS_CODE_TYPE        CodeType,\r
+  IN EFI_STATUS_CODE_VALUE       Value,\r
+  IN CONST EFI_STATUS_CODE_DATA  *Data,\r
+  OUT CHAR8                      **Filename,\r
+  OUT CHAR8                      **Description,\r
+  OUT UINT32                     *LineNumber\r
+  )\r
+{\r
+  EFI_DEBUG_ASSERT_DATA  *AssertData;\r
+\r
+  ASSERT (Data        != NULL);\r
+  ASSERT (Filename    != NULL);\r
+  ASSERT (Description != NULL);\r
+  ASSERT (LineNumber  != NULL);\r
+\r
+  if (((CodeType & EFI_STATUS_CODE_TYPE_MASK)      == EFI_ERROR_CODE) &&\r
+      ((CodeType & EFI_STATUS_CODE_SEVERITY_MASK)  == EFI_ERROR_UNRECOVERED) &&\r
+      ((Value    & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {\r
+    AssertData   = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);\r
+    *Filename    = (CHAR8 *)(AssertData + 1);\r
+    *Description = *Filename + AsciiStrLen (*Filename) + 1;\r
+    *LineNumber  = AssertData->LineNumber;\r
+    return TRUE;\r
+  }\r
+  return FALSE;\r
+}\r
+\r
+\r
+/**\r
+  Extracts DEBUG() information from a status code structure.\r
+\r
+  Converts the status code specified by Data to the DEBUG() arguments specified\r
+  by ErrorLevel, Marker, and Format.  If type GUID in Data is\r
+  EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and\r
+  Format from the optional data area of the status code buffer specified by Data.\r
+  The optional data area of Data contains a 32-bit ErrorLevel followed by Marker\r
+  which is 12 UINTN parameters, followed by a Null-terminated ASCII string for\r
+  the Format.  If the DEBUG() information could be extracted from Data, then\r
+  return TRUE.  Otherwise, FALSE is returned.\r
+\r
+  If Data is NULL, then ASSERT().\r
+  If ErrorLevel is NULL, then ASSERT().\r
+  If Marker is NULL, then ASSERT().\r
+  If Format is NULL, then ASSERT().\r
+\r
+  @param  Data        Pointer to status code data buffer.\r
+  @param  ErrorLevel  Pointer to error level mask for a debug message.\r
+  @param  Marker      Pointer to the variable argument list associated with Format.\r
+  @param  Format      Pointer to a Null-terminated ASCII format string of a\r
+                      debug message.\r
+\r
+  @retval  TRUE   The status code specified by Data was converted DEBUG() arguments\r
+                  specified by ErrorLevel, Marker, and Format.\r
+  @retval  FALSE  The status code specified by Data could not be converted to\r
+                  DEBUG() arguments.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+GlueReportStatusCodeExtractDebugInfo (\r
+  IN CONST EFI_STATUS_CODE_DATA  *Data,\r
+  OUT UINT32                     *ErrorLevel,\r
+  OUT VA_LIST                    *Marker,\r
+  OUT CHAR8                      **Format\r
+  )\r
+{\r
+  EFI_DEBUG_INFO  *DebugInfo;\r
+\r
+  ASSERT (Data       != NULL);\r
+  ASSERT (ErrorLevel != NULL);\r
+  ASSERT (Marker     != NULL);\r
+  ASSERT (Format     != NULL);\r
+\r
+  //\r
+  // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE\r
+  //\r
+  if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {\r
+    return FALSE;\r
+  }\r
+\r
+  //\r
+  // Retrieve the debug information from the status code record\r
+  //\r
+  DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);\r
+\r
+  *ErrorLevel = DebugInfo->ErrorLevel;\r
+\r
+  //\r
+  // The first 12 * UINTN bytes of the string are really an\r
+  // argument stack to support varargs on the Format string.\r
+  //\r
+  *Marker = (VA_LIST) (DebugInfo + 1);\r
+  *Format = (CHAR8 *)(((UINT64 *)*Marker) + 12);\r
+\r
+  return TRUE;\r
+}\r
+\r
+\r
+/**\r
+  Reports a status code.\r
+\r
+  Reports the status code specified by the parameters Type and Value.  Status\r
+  code also require an instance, caller ID, and extended data.  This function\r
+  passed in a zero instance, NULL extended data, and a caller ID of\r
+  gEfiCallerIdGuid, which is the GUID for the module.\r
+\r
+  ReportStatusCode()must actively prevent recusrsion.  If ReportStatusCode()\r
+  is called while processing another any other Report Status Code Library function,\r
+  then ReportStatusCode() must return immediately.\r
+\r
+  @param  Type   Status code type.\r
+  @param  Value  Status code value.\r
+\r
+  @retval  EFI_SUCCESS       The status code was reported.\r
+  @retval  EFI_DEVICE_ERROR  There status code could not be reported due to a\r
+                             device error.\r
+  @retval  EFI_UNSUPPORTED   Report status code is not supported\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GlueReportStatusCode (\r
+  IN EFI_STATUS_CODE_TYPE   Type,\r
+  IN EFI_STATUS_CODE_VALUE  Value\r
+  )\r
+{\r
+  return InternalReportStatusCode (Type, Value, 0, &gEfiCallerIdGuid, NULL);\r
+}\r
+\r
+\r
+/**\r
+  Reports a status code with a Device Path Protocol as the extended data.\r
+\r
+  Allocates and fills in the extended data section of a status code with the\r
+  Device Path Protocol specified by DevicePath.  This function is responsible\r
+  for allocating a buffer large enough for the standard header and the device\r
+  path.  The standard header is filled in with a GUID of\r
+  gEfiStatusCodeSpecificDataGuid.  The status code is reported with a zero\r
+  instance and a caller ID of gEfiCallerIdGuid.\r
+\r
+  ReportStatusCodeWithDevicePath()must actively prevent recursion.  If\r
+  ReportStatusCodeWithDevicePath() is called while processing another any other\r
+  Report Status Code Library function, then ReportStatusCodeWithDevicePath()\r
+  must return EFI_DEVICE_ERROR immediately.\r
+\r
+  If DevicePath is NULL, then ASSERT().\r
+\r
+  @param  Type        Status code type.\r
+  @param  Value       Status code value.\r
+  @param  DevicePath  Pointer to the Device Path Protocol to be reported.\r
+\r
+  @retval  EFI_SUCCESS           The status code was reported with the extended\r
+                                 data specified by DevicePath.\r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the\r
+                                 extended data section.\r
+  @retval  EFI_UNSUPPORTED       Report status code is not supported\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GlueReportStatusCodeWithDevicePath (\r
+  IN EFI_STATUS_CODE_TYPE            Type,\r
+  IN EFI_STATUS_CODE_VALUE           Value,\r
+  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
+  )\r
+{\r
+  ASSERT (DevicePath != NULL);\r
+  return ReportStatusCodeWithExtendedData (\r
+           Type,\r
+           Value,\r
+           (VOID *)DevicePath,\r
+           InternalReportStatusCodeDevicePathSize (DevicePath)\r
+           );\r
+}\r
+\r
+\r
+/**\r
+  Reports a status code with an extended data buffer.\r
+\r
+  Allocates and fills in the extended data section of a status code with the\r
+  extended data specified by ExtendedData and ExtendedDataSize.  ExtendedData\r
+  is assumed to be one of the data structures specified in Related Definitions.\r
+  These data structure do not have the standard header, so this function is\r
+  responsible for allocating a buffer large enough for the standard header and\r
+  the extended data passed into this function.  The standard header is filled\r
+  in with a GUID of  gEfiStatusCodeSpecificDataGuid.  The status code is reported\r
+  with a zero instance and a caller ID of gEfiCallerIdGuid.\r
+\r
+  ReportStatusCodeWithExtendedData()must actively prevent recursion.  If\r
+  ReportStatusCodeWithExtendedData() is called while processing another any other\r
+  Report Status Code Library function, then ReportStatusCodeWithExtendedData()\r
+  must return EFI_DEVICE_ERROR immediately.\r
+\r
+  If ExtendedData is NULL, then ASSERT().\r
+  If ExtendedDataSize is 0, then ASSERT().\r
+\r
+  @param  Type              Status code type.\r
+  @param  Value             Status code value.\r
+  @param  ExtendedData      Pointer to the extended data buffer to be reported.\r
+  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer to\r
+                            be reported.\r
+\r
+  @retval  EFI_SUCCESS           The status code was reported with the extended\r
+                                 data specified by ExtendedData and ExtendedDataSize.\r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the\r
+                                 extended data section.\r
+  @retval  EFI_UNSUPPORTED       Report status code is not supported\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GlueReportStatusCodeWithExtendedData (\r
+  IN EFI_STATUS_CODE_TYPE   Type,\r
+  IN EFI_STATUS_CODE_VALUE  Value,\r
+  IN CONST VOID             *ExtendedData,\r
+  IN UINTN                  ExtendedDataSize\r
+  )\r
+{\r
+  ASSERT (ExtendedData     != NULL);\r
+  ASSERT (ExtendedDataSize != 0);\r
+  return ReportStatusCodeEx (\r
+           Type,\r
+           Value,\r
+           0,\r
+           NULL,\r
+           NULL,\r
+           ExtendedData,\r
+           ExtendedDataSize\r
+           );\r
+}\r
+\r
+\r
+/**\r
+  Reports a status code with full parameters.\r
+\r
+  The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize\r
+  is 0, then an extended data buffer is not reported.  If ExtendedData is not\r
+  NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.\r
+  ExtendedData is assumed not have the standard status code header, so this function\r
+  is responsible for allocating a buffer large enough for the standard header and\r
+  the extended data passed into this function.  The standard header is filled in\r
+  with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a\r
+  GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with\r
+  an instance specified by Instance and a caller ID specified by CallerId.  If\r
+  CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
+\r
+  ReportStatusCodeEx()must actively prevent recursion. If\r
+  ReportStatusCodeEx() is called while processing another any\r
+  other Report Status Code Library function, then\r
+  ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r
+\r
+  If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
+  If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
+\r
+  @param  Type              Status code type.\r
+  @param  Value             Status code value.\r
+  @param  Instance          Status code instance number.\r
+  @param  CallerId          Pointer to a GUID that identifies the caller of this\r
+                            function.  If this parameter is NULL, then a caller\r
+                            ID of gEfiCallerIdGuid is used.\r
+  @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.\r
+                            If this parameter is NULL, then a the status code\r
+                            standard header is filled in with\r
+                            gEfiStatusCodeSpecificDataGuid.\r
+  @param  ExtendedData      Pointer to the extended data buffer.  This is an\r
+                            optional parameter that may be NULL.\r
+  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.\r
+\r
+  @retval  EFI_SUCCESS           The status code was reported.\r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate\r
+                                 the extended data section if it was specified.\r
+  @retval  EFI_UNSUPPORTED       Report status code is not supported\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GlueReportStatusCodeEx (\r
+  IN EFI_STATUS_CODE_TYPE   Type,\r
+  IN EFI_STATUS_CODE_VALUE  Value,\r
+  IN UINT32                 Instance,\r
+  IN CONST EFI_GUID         *CallerId          OPTIONAL,\r
+  IN CONST EFI_GUID         *ExtendedDataGuid  OPTIONAL,\r
+  IN CONST VOID             *ExtendedData      OPTIONAL,\r
+  IN UINTN                  ExtendedDataSize\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+\r
+  Status = InternalReportStatusCodeEx (\r
+             Type,\r
+             Value,\r
+             Instance,\r
+             CallerId,\r
+             ExtendedDataGuid,\r
+             ExtendedData,\r
+             ExtendedDataSize\r
+             );\r
+\r
+  return Status;\r
+}\r
+\r
+\r
+/**\r
+  Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled\r
+\r
+  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED\r
+  bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.\r
+\r
+  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
+                  PcdReportStatusCodeProperyMask is set.\r
+  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of\r
+                  PcdReportStatusCodeProperyMask is clear.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+GlueReportProgressCodeEnabled (\r
+  VOID\r
+  )\r
+{\r
+  return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED) != 0);\r
+}\r
+\r
+\r
+/**\r
+  Returns TRUE if status codes of type EFI_ERROR_CODE are enabled\r
+\r
+  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED\r
+  bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.\r
+\r
+  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
+                  PcdReportStatusCodeProperyMask is set.\r
+  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of\r
+                  PcdReportStatusCodeProperyMask is clear.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+GlueReportErrorCodeEnabled (\r
+  VOID\r
+  )\r
+{\r
+  return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED) != 0);\r
+}\r
+\r
+\r
+/**\r
+  Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled\r
+\r
+  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED\r
+  bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.\r
+\r
+  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
+                  PcdReportStatusCodeProperyMask is set.\r
+  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of\r
+                  PcdReportStatusCodeProperyMask is clear.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+GlueReportDebugCodeEnabled (\r
+  VOID\r
+  )\r
+{\r
+  return (BOOLEAN) ((PcdGet8(PcdReportStatusCodePropertyMask) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
+}\r
diff --git a/edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/ReportStatusCodeLibInternal.h b/edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/ReportStatusCodeLibInternal.h
new file mode 100644 (file)
index 0000000..c1d0480
--- /dev/null
@@ -0,0 +1,128 @@
+/*++\r
+\r
+Copyright (c) 2004 - 2010, 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
+Module Name:\r
+\r
+  ReportStatusCodeLibInternal.h\r
+  \r
+Abstract: \r
+\r
+  Internal Header file of Report Status Code Library for RUNTIME\r
+  DXE Phase.\r
+\r
+--*/\r
+\r
+#ifndef __REPORT_STATUS_CODE_LIB_INTERNAL__H\r
+#define __REPORT_STATUS_CODE_LIB_INTERNAL__H\r
+\r
+#include "EdkIIGlueDxe.h"\r
+\r
+/**\r
+  Locatet he report status code service.\r
+\r
+  @return     EFI_REPORT_STATUS_CODE    function point to\r
+              ReportStatusCode.\r
+**/\r
+EFI_REPORT_STATUS_CODE\r
+InternalGetReportStatusCode (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Internal worker function that reports a status code through the Status Code Protocol\r
+\r
+  This function checks to see if a Status Code Protocol is present in the handle\r
+  database.  If a Status Code Protocol is not present, then EFI_UNSUPPORTED is\r
+  returned.  If a Status Code Protocol is present, then it is cached in gStatusCode,\r
+  and the ReportStatusCode() service of the Status Code Protocol is called passing in\r
+  Type, Value, Instance, CallerId, and Data.  The result of this call is returned.\r
+\r
+  @param  Type              Status code type.\r
+  @param  Value             Status code value.\r
+  @param  Instance          Status code instance number.\r
+  @param  CallerId          Pointer to a GUID that identifies the caller of this\r
+                            function.  This is an optional parameter that may be\r
+                            NULL.\r
+  @param  Data              Pointer to the extended data buffer.  This is an\r
+                            optional parameter that may be NULL.\r
+\r
+  @retval  EFI_SUCCESS           The status code was reported.\r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to report the status code.\r
+  @retval  EFI_UNSUPPORTED       Status Code Protocol is not available.\r
+\r
+**/\r
+EFI_STATUS\r
+InternalReportStatusCode (\r
+  IN EFI_STATUS_CODE_TYPE     Type,\r
+  IN EFI_STATUS_CODE_VALUE    Value,\r
+  IN UINT32                   Instance,\r
+  IN CONST EFI_GUID           *CallerId OPTIONAL,\r
+  IN EFI_STATUS_CODE_DATA     *Data     OPTIONAL\r
+  );\r
+\r
+/**\r
+  Reports a status code with full parameters.\r
+\r
+  The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize\r
+  is 0, then an extended data buffer is not reported.  If ExtendedData is not\r
+  NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.\r
+  ExtendedData is assumed not have the standard status code header, so this function\r
+  is responsible for allocating a buffer large enough for the standard header and\r
+  the extended data passed into this function.  The standard header is filled in\r
+  with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a\r
+  GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with\r
+  an instance specified by Instance and a caller ID specified by CallerId.  If\r
+  CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
+\r
+  ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx()\r
+  is called while processing another any other Report Status Code Library function,\r
+  then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r
+\r
+  If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
+  If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
+\r
+  @param  Type              Status code type.\r
+  @param  Value             Status code value.\r
+  @param  Instance          Status code instance number.\r
+  @param  CallerId          Pointer to a GUID that identifies the caller of this\r
+                            function.  If this parameter is NULL, then a caller\r
+                            ID of gEfiCallerIdGuid is used.\r
+  @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.\r
+                            If this parameter is NULL, then a the status code\r
+                            standard header is filled in with\r
+                            gEfiStatusCodeSpecificDataGuid.\r
+  @param  ExtendedData      Pointer to the extended data buffer.  This is an\r
+                            optional parameter that may be NULL.\r
+  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.\r
+\r
+  @retval  EFI_SUCCESS           The status code was reported.\r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate\r
+                                 the extended data section if it was specified.\r
+  @retval  EFI_UNSUPPORTED       Report status code is not supported\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalReportStatusCodeEx (\r
+  IN EFI_STATUS_CODE_TYPE   Type,\r
+  IN EFI_STATUS_CODE_VALUE  Value,\r
+  IN UINT32                 Instance,\r
+  IN CONST EFI_GUID         *CallerId          OPTIONAL,\r
+  IN CONST EFI_GUID         *ExtendedDataGuid  OPTIONAL,\r
+  IN CONST VOID             *ExtendedData      OPTIONAL,\r
+  IN UINTN                  ExtendedDataSize\r
+  );\r
+\r
+extern EFI_REPORT_STATUS_CODE  mReportStatusCode;\r
+\r
+#endif // __REPORT_STATUS_CODE_LIB_INTERNAL__H\r
+\r
diff --git a/edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/SmmRuntimeDxeReportStatusCodeLib.inf b/edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/SmmRuntimeDxeReportStatusCodeLib.inf
new file mode 100644 (file)
index 0000000..bf53073
--- /dev/null
@@ -0,0 +1,96 @@
+#/*++\r
+#\r
+# Copyright (c) 2004 - 2010, 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
+#   SmmRuntimeDxeReportStatusCodeLib.inf\r
+#\r
+#  Abstract:\r
+#\r
+#    Component description file for SmmRuntimeDxeReportStatusCodeLib\r
+#\r
+#--*/\r
+\r
+[defines]\r
+BASE_NAME       = EdkIIGlueSmmRuntimeDxeReportStatusCodeLib\r
+COMPONENT_TYPE  = LIBRARY\r
+\r
+[sources.common]\r
+  ReportStatusCodeLib.c\r
+  SmmRuntimeDxeSupport.c\r
+  ReportStatusCodeLibInternal.h\r
+\r
+[sources.ia32]\r
+  \r
+[sources.x64]\r
+\r
+[sources.ipf]\r
+\r
+[sources.ebc]\r
+  \r
+\r
+[includes.common]\r
+  .\r
+  ..\..\Include\r
+  ..\..\include\Library\r
+  $(EDK_SOURCE)\Foundation\r
+  $(EDK_SOURCE)\Foundation\Framework\r
+  $(EDK_SOURCE)\Foundation\Efi\r
+  $(EDK_SOURCE)\Foundation\Include\r
+  $(EDK_SOURCE)\Foundation\Efi\Include\r
+  $(EDK_SOURCE)\Foundation\Framework\Include\r
+  $(EDK_SOURCE)\Foundation\Include\IndustryStandard\r
+  $(EDK_SOURCE)\Foundation\Core\Dxe\r
+  $(EDK_SOURCE)\Foundation\Library\Dxe\Include\r
+  $(EDK_SOURCE)\Foundation\Cpu\Pentium\Include\r
+  $(EDK_SOURCE)\Foundation\Framework\Guid\DataHubRecords\r
+  $(EDK_SOURCE)\Foundation\Framework\Guid\StatusCodeDataTypeId\r
+  $(EDK_SOURCE)\Foundation\Core\Dxe\ArchProtocol\StatusCode\r
+\r
+[libraries.common]\r
+  EdkIIGlueBaseLib\r
+  EdkIIGlueBaseMemoryLib\r
+  EdkIIGlueUefiBootServicesTableLib\r
+#\r
+# when EFI_SPECIFICATION_VERSION < 0x00020000, gRT is used\r
+# \r
+  EdkIIGlueUefiRuntimeServicesTableLib\r
+# R8.x lib\r
+  EfiProtocolLib\r
+# Possibly, gEfiCallerIdGuid might be used.\r
+  EdkGuidLib\r
+  ArchProtocolLib\r
+\r
+\r
+[libraries.ia32]\r
+\r
+[libraries.x64]\r
+\r
+[libraries.ebc]\r
+\r
+\r
+[nmake.common]\r
+  C_FLAGS = $(C_FLAGS) /D EDKII_GLUE_LIBRARY_IMPLEMENTATION\r
+  LIB_STD_FLAGS = $(LIB_STD_FLAGS) /IGNORE:4006 /IGNORE:4221\r
+\r
+[nmake.ia32]\r
+  C_FLAGS = $(C_FLAGS) /D MDE_CPU_IA32\r
+\r
+[nmake.x64]\r
+  C_FLAGS = $(C_FLAGS) /D MDE_CPU_X64\r
+\r
+[nmake.ipf]\r
+  C_FLAGS = $(C_FLAGS) /D MDE_CPU_IPF\r
+\r
+[nmake.ebc]\r
+  EBC_C_STD_FLAGS = $(EBC_C_STD_FLAGS) /D EDKII_GLUE_LIBRARY_IMPLEMENTATION\r
+  EBC_LIB_STD_FLAGS = $(EBC_LIB_STD_FLAGS)  /IGNORE:4006 /IGNORE:4221\r
+  EBC_C_STD_FLAGS = $(EBC_C_STD_FLAGS) /D MDE_CPU_EBC\r
diff --git a/edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/SmmRuntimeDxeSupport.c b/edk2/EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/SmmRuntimeDxeReportStatusCodeLib/SmmRuntimeDxeSupport.c
new file mode 100644 (file)
index 0000000..6cb0f0b
--- /dev/null
@@ -0,0 +1,342 @@
+/*++\r
+\r
+Copyright (c) 2004 - 2010, 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
+Module Name:\r
+\r
+  SmmRuntimeDxeSupport.c\r
+  \r
+Abstract: \r
+\r
+  Report Status Code Library for DXE Phase.\r
+\r
+--*/\r
+\r
+#include "ReportStatusCodeLibInternal.h"\r
+#include EFI_PROTOCOL_DEFINITION (SmmStatusCode)\r
+\r
+EFI_EVENT             mVirtualAddressChangeEvent;\r
+\r
+EFI_EVENT             mExitBootServicesEvent;\r
+\r
+EFI_STATUS_CODE_DATA  *mStatusCodeData;\r
+\r
+BOOLEAN               mInSmm;\r
+\r
+EFI_SMM_BASE_PROTOCOL *mSmmBase;\r
+\r
+EFI_RUNTIME_SERVICES  *mRTSmmRuntimeDxeReportStatusCodeLib;\r
+\r
+BOOLEAN               mHaveExitedBootServices = FALSE;\r
+\r
+EFI_SMM_STATUS_CODE_PROTOCOL  *mSmmStatusCode;\r
+\r
+VOID\r
+SmmStatusCodeInitialize (\r
+  VOID\r
+  )\r
+{\r
+  EFI_STATUS Status;\r
+\r
+  Status = gBS->LocateProtocol (&gEfiSmmStatusCodeProtocolGuid, NULL, (VOID **) &mSmmStatusCode);\r
+  if (EFI_ERROR (Status)) {\r
+    mSmmStatusCode = NULL;\r
+  }\r
+}\r
+\r
+EFI_STATUS\r
+SmmStatusCodeReport (\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
+  if (mSmmStatusCode != NULL) {\r
+    (mSmmStatusCode->ReportStatusCode) (mSmmStatusCode, Type, Value, Instance, CallerId, Data);\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Locate he report status code service.\r
+\r
+  @return     EFI_REPORT_STATUS_CODE    function point to\r
+              ReportStatusCode.\r
+**/\r
+EFI_REPORT_STATUS_CODE\r
+InternalGetReportStatusCode (\r
+  VOID\r
+  )\r
+{\r
+#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
+  EFI_STATUS_CODE_PROTOCOL  *StatusCodeProtocol;\r
+  EFI_STATUS                Status;\r
+#endif\r
+\r
+  if (mInSmm) {\r
+    return (EFI_REPORT_STATUS_CODE) SmmStatusCodeReport;\r
+#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
+  } else if (!mHaveExitedBootServices) {\r
+       //\r
+       // Check gBS just in case. ReportStatusCode is called before gBS is initialized.\r
+       //\r
+    if (gBS != NULL) {\r
+      Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID**)&StatusCodeProtocol);\r
+      if (!EFI_ERROR (Status) && StatusCodeProtocol != NULL) {\r
+        return StatusCodeProtocol->ReportStatusCode;\r
+      }\r
+    }\r
+  }\r
+#elif (TIANO_RELEASE_VERSION != 0)\r
+  } else if (mRTSmmRuntimeDxeReportStatusCodeLib != NULL) {\r
+    return mRTSmmRuntimeDxeReportStatusCodeLib->ReportStatusCode;\r
+  }\r
+#endif\r
+\r
+  return NULL;\r
+}\r
+\r
+\r
+/**\r
+  Fixup internal report status code protocol interface.\r
+\r
+  @param[in]    Event   The Event that is being processed\r
+  @param[in]    Context Event Context\r
+**/\r
+VOID\r
+EFIAPI\r
+ReportStatusCodeLibVirtualAddressChange (\r
+  IN EFI_EVENT        Event,\r
+  IN VOID             *Context\r
+  )\r
+{\r
+  if (NULL != mReportStatusCode) {\r
+    mRTSmmRuntimeDxeReportStatusCodeLib->ConvertPointer (0, (VOID **) &mReportStatusCode);\r
+  }\r
+  mRTSmmRuntimeDxeReportStatusCodeLib->ConvertPointer (0, (VOID **) &mStatusCodeData);\r
+  mRTSmmRuntimeDxeReportStatusCodeLib->ConvertPointer (0, (VOID **) &mRTSmmRuntimeDxeReportStatusCodeLib);\r
+}\r
+\r
+/**\r
+  Update the In Runtime Indicator.\r
+\r
+  @param[in]    Event   The Event that is being processed\r
+  @param[in]    Context Event Context\r
+**/\r
+VOID\r
+EFIAPI\r
+ReportStatusCodeLibExitBootServices (\r
+  IN EFI_EVENT        Event,\r
+  IN VOID             *Context\r
+  )\r
+{\r
+  mHaveExitedBootServices = TRUE;\r
+}\r
+\r
+/**\r
+  Intialize Report Status Code Lib.\r
+\r
+  @param[in]  ImageHandle   The firmware allocated handle for the EFI image.\r
+  @param[in]  SystemTable   A pointer to the EFI System Table.\r
+\r
+  @return     EFI_STATUS    always returns EFI_SUCCESS.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ReportStatusCodeLibConstruct (\r
+  IN EFI_HANDLE           ImageHandle,\r
+  IN EFI_SYSTEM_TABLE     *SystemTable\r
+  )\r
+{\r
+  EFI_STATUS            Status;\r
+\r
+  //\r
+  // SMM driver depends on the SMM BASE protocol.\r
+  // the SMM driver must be success to locate protocol.\r
+  // \r
+  Status = gBS->LocateProtocol (&gEfiSmmBaseProtocolGuid, NULL, (VOID **) &mSmmBase);\r
+  if (!EFI_ERROR (Status)) {\r
+    mSmmBase->InSmm (mSmmBase, &mInSmm);\r
+    if (mInSmm) {\r
+      Status = mSmmBase->SmmAllocatePool (\r
+                           mSmmBase,\r
+                           EfiRuntimeServicesData, \r
+                           sizeof (EFI_STATUS_CODE_DATA) + EFI_STATUS_CODE_DATA_MAX_SIZE, \r
+                           (VOID **) &mStatusCodeData\r
+                           );\r
+      ASSERT_EFI_ERROR (Status);\r
+      SmmStatusCodeInitialize ();\r
+      return EFI_SUCCESS;\r
+    }\r
+  }\r
+\r
+  //\r
+  // Library should not use the gRT directly, since it\r
+  // may be converted by other library instance.\r
+  // \r
+  mRTSmmRuntimeDxeReportStatusCodeLib = gRT;\r
+  mInSmm  = FALSE;\r
+\r
+  (gBS->AllocatePool) (EfiRuntimeServicesData, sizeof (EFI_STATUS_CODE_DATA) + EFI_STATUS_CODE_DATA_MAX_SIZE, (VOID **)&mStatusCodeData);\r
+  ASSERT (NULL != mStatusCodeData);\r
+  //\r
+  // Cache the report status code service\r
+  // \r
+  mReportStatusCode = InternalGetReportStatusCode ();\r
+\r
+  //\r
+  // Register the call back of virtual address change\r
+  // \r
+  Status = gBS->CreateEvent (\r
+                  EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r
+                  TPL_NOTIFY,\r
+                  ReportStatusCodeLibVirtualAddressChange,\r
+                  NULL,\r
+                  &mVirtualAddressChangeEvent\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+\r
+  //\r
+  // Register the call back of exit boot services\r
+  // \r
+  Status = gBS->CreateEvent (\r
+                  EFI_EVENT_SIGNAL_EXIT_BOOT_SERVICES,\r
+                  TPL_NOTIFY,\r
+                  ReportStatusCodeLibExitBootServices,\r
+                  NULL,\r
+                  &mExitBootServicesEvent\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Desctructor of library will close events.\r
+  \r
+  @param ImageHandle callder module's image handle\r
+  @param SystemTable pointer to EFI system table.\r
+  @return the status of close event.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ReportStatusCodeLibDestruct (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+\r
+  if (!mInSmm) {\r
+    //\r
+    // Close SetVirtualAddressMap () notify function\r
+    //\r
+    ASSERT (gBS != NULL);\r
+    Status = gBS->CloseEvent (mVirtualAddressChangeEvent);\r
+    ASSERT_EFI_ERROR (Status);\r
+    Status = gBS->CloseEvent (mExitBootServicesEvent);\r
+    ASSERT_EFI_ERROR (Status);\r
+\r
+    (gBS->FreePool) (mStatusCodeData);\r
+  } else {\r
+    mSmmBase->SmmFreePool (mSmmBase, mStatusCodeData);\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Reports a status code with full parameters.\r
+\r
+  The function reports a status code.  If ExtendedData is NULL and ExtendedDataSize\r
+  is 0, then an extended data buffer is not reported.  If ExtendedData is not\r
+  NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.\r
+  ExtendedData is assumed not have the standard status code header, so this function\r
+  is responsible for allocating a buffer large enough for the standard header and\r
+  the extended data passed into this function.  The standard header is filled in\r
+  with a GUID specified by ExtendedDataGuid.  If ExtendedDataGuid is NULL, then a\r
+  GUID of gEfiStatusCodeSpecificDatauid is used.  The status code is reported with\r
+  an instance specified by Instance and a caller ID specified by CallerId.  If\r
+  CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
+\r
+  ReportStatusCodeEx()must actively prevent recursion.  If ReportStatusCodeEx()\r
+  is called while processing another any other Report Status Code Library function,\r
+  then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.\r
+\r
+  If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
+  If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
+\r
+  @param  Type              Status code type.\r
+  @param  Value             Status code value.\r
+  @param  Instance          Status code instance number.\r
+  @param  CallerId          Pointer to a GUID that identifies the caller of this\r
+                            function.  If this parameter is NULL, then a caller\r
+                            ID of gEfiCallerIdGuid is used.\r
+  @param  ExtendedDataGuid  Pointer to the GUID for the extended data buffer.\r
+                            If this parameter is NULL, then a the status code\r
+                            standard header is filled in with\r
+                            gEfiStatusCodeSpecificDataGuid.\r
+  @param  ExtendedData      Pointer to the extended data buffer.  This is an\r
+                            optional parameter that may be NULL.\r
+  @param  ExtendedDataSize  The size, in bytes, of the extended data buffer.\r
+\r
+  @retval  EFI_SUCCESS           The status code was reported.\r
+  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate\r
+                                 the extended data section if it was specified.\r
+  @retval  EFI_UNSUPPORTED       Report status code is not supported\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalReportStatusCodeEx (\r
+  IN EFI_STATUS_CODE_TYPE   Type,\r
+  IN EFI_STATUS_CODE_VALUE  Value,\r
+  IN UINT32                 Instance,\r
+  IN CONST EFI_GUID         *CallerId          OPTIONAL,\r
+  IN CONST EFI_GUID         *ExtendedDataGuid  OPTIONAL,\r
+  IN CONST VOID             *ExtendedData      OPTIONAL,\r
+  IN UINTN                  ExtendedDataSize\r
+  )\r
+{\r
+  ASSERT (!((ExtendedData == NULL) && (ExtendedDataSize != 0)));\r
+  ASSERT (!((ExtendedData != NULL) && (ExtendedDataSize == 0)));\r
+\r
+  if (ExtendedDataSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  //\r
+  // Fill in the extended data header\r
+  //\r
+  mStatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);\r
+  mStatusCodeData->Size = (UINT16)ExtendedDataSize;\r
+  if (ExtendedDataGuid == NULL) {\r
+    ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;\r
+  }\r
+  CopyGuid (&mStatusCodeData->Type, ExtendedDataGuid);\r
+\r
+  //\r
+  // Fill in the extended data buffer\r
+  //\r
+  CopyMem (mStatusCodeData + 1, ExtendedData, ExtendedDataSize);\r
+\r
+  //\r
+  // Report the status code\r
+  //\r
+  if (CallerId == NULL) {\r
+    CallerId = &gEfiCallerIdGuid;\r
+  }\r
+  return  InternalReportStatusCode (Type, Value, Instance, CallerId, mStatusCodeData);\r
+}\r
+\r