Code scrub for DxeReportStatusCodeLib.

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

4 files changed, 116 insertions, 353 deletions

diff --git a/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf b/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
index 773db9b723..7a92877c07 100644
--- a/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
+++ b/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeReportStatusCodeLib.inf
@@ -21,7 +21,6 @@
   MODULE_TYPE                    = DXE_DRIVER

   VERSION_STRING                 = 1.0

   LIBRARY_CLASS                  = ReportStatusCodeLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER

-  EFI_SPECIFICATION_VERSION      = 0x00020000

 

 #

 # The following information is for reference only and not required by the build tools.

@@ -31,9 +30,6 @@
 

 [Sources.common]

   ReportStatusCodeLib.c

-  DxeSupport.c

-

-

 

 [Packages]

   MdePkg/MdePkg.dec

@@ -43,20 +39,18 @@
 [LibraryClasses]

   PcdLib

   BaseMemoryLib

-  BaseLib

+  MemoryAllocationLib

   UefiBootServicesTableLib

   DebugLib

   UefiRuntimeServicesTableLib

   DevicePathLib

 

 [Guids]

-  gEfiStatusCodeSpecificDataGuid                # ALWAYS_CONSUMED

-  gEfiStatusCodeDataTypeDebugGuid               # ALWAYS_CONSUMED

-

+  gEfiStatusCodeSpecificDataGuid                ## CONSUMES

+  gEfiStatusCodeDataTypeDebugGuid               ## CONSUMES

 

 [Protocols]

-  gEfiStatusCodeRuntimeProtocolGuid             # PROTOCOL ALWAYS_CONSUMED

-

+  gEfiStatusCodeRuntimeProtocolGuid             ## SOMETIMES_CONSUMES (Used if revision of the EFI Specification is not less than 0x20000)

 

 [Pcd.common]

   gEfiMdePkgTokenSpaceGuid.PcdReportStatusCodePropertyMask

diff --git a/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeSupport.c b/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeSupport.c
deleted file mode 100644
index bfa5e51305..0000000000
--- a/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/DxeSupport.c
+++ /dev/null
@@ -1,147 +0,0 @@
-/** @file

-  Report Status Code Library for DXE Phase.

-

-  Copyright (c) 2006 - 2007, 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

-  http://opensource.org/licenses/bsd-license.php

-

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

-

-**/

-

-#include "ReportStatusCodeLibInternal.h"

-

-/**

-  Locate he report status code service.

-

-  @return     EFI_REPORT_STATUS_CODE    function point to

-              ReportStatusCode.

-**/

-EFI_REPORT_STATUS_CODE

-InternalGetReportStatusCode (

-  VOID

-  )

-{

-  EFI_STATUS_CODE_PROTOCOL  *StatusCodeProtocol;

-  EFI_STATUS                Status;

-

-  if (gRT->Hdr.Revision < 0x20000) {

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

-  } else if (gBS != NULL && gBS->LocateProtocol != NULL) {

-    Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID**)&StatusCodeProtocol);

-    if (!EFI_ERROR (Status) && StatusCodeProtocol != NULL) {

-      return StatusCodeProtocol->ReportStatusCode;

-    }

-  }

-

-  return NULL;

-}

-

-/**

-  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

-  )

-{

-  EFI_STATUS            Status;

-  EFI_STATUS_CODE_DATA  *StatusCodeData;

-

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

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

-

-  if (gBS == NULL || gBS->AllocatePool == NULL || gBS->FreePool == NULL) {

-    return EFI_UNSUPPORTED;

-  }

-

-  //

-  // Allocate space for the Status Code Header and its buffer

-  //

-  StatusCodeData = NULL;

-  gBS->AllocatePool (EfiBootServicesData, sizeof (EFI_STATUS_CODE_DATA) + ExtendedDataSize, (VOID **)&StatusCodeData);

-  if (StatusCodeData == NULL) {

-    return EFI_OUT_OF_RESOURCES;

-  }

-

-  //

-  // Fill in the extended data header

-  //

-  StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);

-  StatusCodeData->Size = (UINT16)ExtendedDataSize;

-  if (ExtendedDataGuid == NULL) {

-    ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;

-  }

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

-

-  //

-  // Fill in the extended data buffer

-  //

-  if (ExtendedData != NULL) {

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

-  }

-

-  //

-  // Report the status code

-  //

-  if (CallerId == NULL) {

-    CallerId = &gEfiCallerIdGuid;

-  }

-  Status = InternalReportStatusCode (Type, Value, Instance, CallerId, StatusCodeData);

-

-  //

-  // Free the allocated buffer

-  //

-  gBS->FreePool (StatusCodeData);

-

-  return Status;

-}

-

diff --git a/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/ReportStatusCodeLib.c b/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/ReportStatusCodeLib.c
index 0dd2990e75..941d01f92b 100644
--- a/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/ReportStatusCodeLib.c
+++ b/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/ReportStatusCodeLib.c
@@ -1,7 +1,7 @@
 /** @file

   Report Status Code Library for 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,18 +12,57 @@
 

 **/

 

-#include "ReportStatusCodeLibInternal.h"

- 

+#include <FrameworkDxe.h>

+

+#include <Library/ReportStatusCodeLib.h>

+#include <Library/DebugLib.h>

+#include <Library/UefiBootServicesTableLib.h>

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/MemoryAllocationLib.h>

+#include <Library/PcdLib.h>

+#include <Library/UefiRuntimeServicesTableLib.h>

+#include <Library/DevicePathLib.h>

+

+#include <Guid/StatusCodeDataTypeId.h>

+#include <Guid/StatusCodeDataTypeDebug.h>

+#include <Protocol/StatusCode.h>

+

 EFI_REPORT_STATUS_CODE  mReportStatusCode = NULL;

 

 /**

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

+  Locate the report status code service.

+

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

+

+**/

+EFI_REPORT_STATUS_CODE

+InternalGetReportStatusCode (

+  VOID

+  )

+{

+  EFI_STATUS_CODE_PROTOCOL  *StatusCodeProtocol;

+  EFI_STATUS                Status;

+

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

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

+  } else if (gBS != NULL && gBS->LocateProtocol != NULL) {

+    Status = gBS->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid, NULL, (VOID**)&StatusCodeProtocol);

+    if (!EFI_ERROR (Status) && StatusCodeProtocol != NULL) {

+      return StatusCodeProtocol->ReportStatusCode;

+    }

+  }

+

+  return NULL;

+}

+

+/**

+  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.

@@ -34,9 +73,9 @@ EFI_REPORT_STATUS_CODE  mReportStatusCode = 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.

+  @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

@@ -49,11 +88,10 @@ InternalReportStatusCode (
   )

 {

   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)) {

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

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

     //

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

-    // in the handle database.

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

     //

     if (mReportStatusCode == NULL) {

       mReportStatusCode = InternalGetReportStatusCode ();

@@ -63,8 +101,7 @@ InternalReportStatusCode (
     }

   

     //

-    // 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

+    // 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);

   }

@@ -74,36 +111,6 @@ InternalReportStatusCode (
 

 

 /**

-  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.

 

   Converts the status code specified by CodeType and Value to an 8-bit POST code

@@ -274,10 +281,18 @@ ReportStatusCodeExtractDebugInfo (
   *ErrorLevel = DebugInfo->ErrorLevel;

 

   //

+  // Here the address returned in Marker is 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);

+  //

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

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

   //

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

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

 

   return TRUE;

@@ -357,7 +372,7 @@ ReportStatusCodeWithDevicePath (
            Type,

            Value,

            (VOID *)DevicePath,

-           InternalReportStatusCodeDevicePathSize (DevicePath)

+           GetDevicePathSize (DevicePath)

            );

 }

 

@@ -472,17 +487,50 @@ ReportStatusCodeEx (
   IN UINTN                  ExtendedDataSize

   )

 {

-  EFI_STATUS  Status;

-

-  Status = InternalReportStatusCodeEx (

-             Type,

-             Value,

-             Instance,

-             CallerId,

-             ExtendedDataGuid,

-             ExtendedData,

-             ExtendedDataSize

-             );

+  EFI_STATUS            Status;

+  EFI_STATUS_CODE_DATA  *StatusCodeData;

+

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

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

+

+  //

+  // Allocate space for the Status Code Header and its buffer

+  //

+  StatusCodeData = NULL;

+  StatusCodeData = AllocatePool (sizeof (EFI_STATUS_CODE_DATA) + ExtendedDataSize);

+  if (StatusCodeData == NULL) {

+    return EFI_OUT_OF_RESOURCES;

+  }

+

+  //

+  // Fill in the extended data header

+  //

+  StatusCodeData->HeaderSize = sizeof (EFI_STATUS_CODE_DATA);

+  StatusCodeData->Size = (UINT16)ExtendedDataSize;

+  if (ExtendedDataGuid == NULL) {

+    ExtendedDataGuid = &gEfiStatusCodeSpecificDataGuid;

+  }

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

+

+  //

+  // Fill in the extended data buffer

+  //

+  if (ExtendedData != NULL) {

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

+  }

+

+  //

+  // Report the status code

+  //

+  if (CallerId == NULL) {

+    CallerId = &gEfiCallerIdGuid;

+  }

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

+

+  //

+  // Free the allocated buffer

+  //

+  FreePool (StatusCodeData);

 

   return Status;

 }

@@ -506,7 +554,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);

 }

 

 

@@ -528,7 +576,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);

 }

 

 

@@ -550,5 +598,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/DxeReportStatusCodeLibFramework/ReportStatusCodeLibInternal.h b/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/ReportStatusCodeLibInternal.h
deleted file mode 100644
index f5d9da3c84..0000000000
--- a/IntelFrameworkModulePkg/Library/DxeReportStatusCodeLibFramework/ReportStatusCodeLibInternal.h
+++ /dev/null
@@ -1,132 +0,0 @@
-/** @file

-  Internal Header file of Report Status Code Library for RUNTIME

-  DXE Phase.

-

-  Copyright (c) 2006 - 2007, 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

-  http://opensource.org/licenses/bsd-license.php

-

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

-  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

-

-#include <FrameworkDxe.h>

-

-#include <Library/ReportStatusCodeLib.h>

-#include <Library/DebugLib.h>

-#include <Library/UefiBootServicesTableLib.h>

-#include <Library/BaseLib.h>

-#include <Library/BaseMemoryLib.h>

-#include <Library/PcdLib.h>

-#include <Library/UefiRuntimeServicesTableLib.h>

-#include <Library/DevicePathLib.h>

-

-#include <Guid/StatusCodeDataTypeId.h>

-#include <Guid/StatusCodeDataTypeDebug.h>

-#include <Protocol/StatusCode.h>

-

-extern EFI_REPORT_STATUS_CODE  mReportStatusCode;

-

-/**

-  Locate he report status code service.

-

-  @return     EFI_REPORT_STATUS_CODE    function point to

-              ReportStatusCode.

-**/

-EFI_REPORT_STATUS_CODE

-InternalGetReportStatusCode (

-  VOID

-  );

-

-/**

-  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

-  );

-

-/**

-  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

-