Remove the library instance of BaseReportStatusCodeLibNull

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

2 files changed, 0 insertions, 506 deletions

diff --git a/MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLibNull.msa b/MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLibNull.msa
deleted file mode 100644
index 2c9a392628..0000000000
--- a/MdePkg/Library/BaseReportStatusCodeLibNull/BaseReportStatusCodeLibNull.msa
+++ /dev/null
@@ -1,67 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>

-<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0">

-  <MsaHeader>

-    <ModuleName>BaseReportStatusCodeLibNull</ModuleName>

-    <ModuleType>DXE_DRIVER</ModuleType>

-    <GuidValue>55c61087-7367-4546-bc32-4937c5e6aff3</GuidValue>

-    <Version>1.0</Version>

-    <Abstract>Component description file for NULL Report Status Code Library.</Abstract>

-    <Description>Null instance for Report Status Code Library.</Description>

-    <Copyright>Copyright (c) 2006, Intel Corporation.</Copyright>

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

-    <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052</Specification>

-  </MsaHeader>

-  <ModuleDefinitions>

-    <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>

-    <BinaryModule>false</BinaryModule>

-    <OutputFileBasename>BaseReportStatusCodeLibNull</OutputFileBasename>

-  </ModuleDefinitions>

-  <LibraryClassDefinitions>

-    <LibraryClass Usage="ALWAYS_PRODUCED">

-      <Keyword>ReportStatusCodeLib</Keyword>

-    </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>BaseLib</Keyword>

-    </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>BaseMemoryLib</Keyword>

-    </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>DebugLib</Keyword>

-    </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>PcdLib</Keyword>

-    </LibraryClass>

-    <LibraryClass Usage="ALWAYS_CONSUMED">

-      <Keyword>IoLib</Keyword>

-    </LibraryClass>

-  </LibraryClassDefinitions>

-  <SourceFiles>

-    <Filename>ReportStatusCodeLib.c</Filename>

-  </SourceFiles>

-  <PackageDependencies>

-    <Package PackageGuid="5e0e9358-46b6-4ae2-8218-4ab8b9bbdcec"/>

-  </PackageDependencies>

-  <Guids>

-    <GuidCNames Usage="ALWAYS_CONSUMED">

-      <GuidCName>gEfiStatusCodeDataTypeDebugGuid</GuidCName>

-    </GuidCNames>

-  </Guids>

-  <Externs>

-    <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>

-    <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>

-  </Externs>

-  <PcdCoded>

-    <PcdEntry PcdItemType="FIXED_AT_BUILD">

-      <C_Name>PcdReportStatusCodePropertyMask</C_Name>

-      <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>

-      <HelpText>The bitmask of flags that specify the enable/disable of

-                Progress Code, Error Code and Debug Code.</HelpText>

-    </PcdEntry>

-  </PcdCoded>

-</ModuleSurfaceArea>
\ No newline at end of file
diff --git a/MdePkg/Library/BaseReportStatusCodeLibNull/ReportStatusCodeLib.c b/MdePkg/Library/BaseReportStatusCodeLibNull/ReportStatusCodeLib.c
deleted file mode 100644
index 4459c0350e..0000000000
--- a/MdePkg/Library/BaseReportStatusCodeLibNull/ReportStatusCodeLib.c
+++ /dev/null
@@ -1,439 +0,0 @@
-/** @file

-  Report Status Code Library template for Base modules.

-

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

-

-**/

-

-/**

-  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 

-  and returns the 8-bit POST code in PostCode.  If CodeType is an 

-  EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode 

-  are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits 

-  24..26 of Value., and TRUE is returned.  Otherwise, FALSE is returned.  

-

-  If PostCode is NULL, then ASSERT().

-

-  @param  CodeType  The type of status code being converted.

-  @param  Value     The status code value being converted.

-  @param  PostCode  A pointer to the 8-bit POST code value to return. 

-

-  @retval  TRUE   The status code specified by CodeType and Value was converted 

-                  to an 8-bit POST code and returned in  PostCode.

-  @retval  FALSE  The status code specified by CodeType and Value could not be 

-                  converted to an 8-bit POST code value.

-

-**/

-BOOLEAN

-EFIAPI

-CodeTypeToPostCode (

-  IN  EFI_STATUS_CODE_TYPE   CodeType,

-  IN  EFI_STATUS_CODE_VALUE  Value,

-  OUT UINT8                  *PostCode

-  )

-{

-  //

-  // If PostCode is NULL, then ASSERT()

-  //

-  ASSERT (PostCode != NULL);

-

-  //

-  // Convert Value to an 8 bit post code

-  //

-  if (((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_PROGRESS_CODE) ||

-      ((CodeType & EFI_STATUS_CODE_TYPE_MASK) == EFI_ERROR_CODE)       ) {

-    *PostCode  = (UINT8) (((Value & EFI_STATUS_CODE_CLASS_MASK) >> 24) << 5);

-    *PostCode |= (UINT8) (((Value & EFI_STATUS_CODE_SUBCLASS_MASK) >> 16) & 0x1f);

-    return TRUE;

-  }

-  return FALSE;

-}

-

-

-/**

-  Extracts ASSERT() information from a status code structure.

-

-  Converts the status code specified by CodeType, Value, and Data to the ASSERT()

-  arguments specified by Filename, Description, and LineNumber.  If CodeType is 

-  an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and 

-  Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract 

-  Filename, Description, and LineNumber from the optional data area of the 

-  status code buffer specified by Data.  The optional data area of Data contains 

-  a Null-terminated ASCII string for the FileName, followed by a Null-terminated 

-  ASCII string for the Description, followed by a 32-bit LineNumber.  If the 

-  ASSERT() information could be extracted from Data, then return TRUE.  

-  Otherwise, FALSE is returned.  

-

-  If Data is NULL, then ASSERT().

-  If Filename is NULL, then ASSERT().

-  If Description is NULL, then ASSERT().

-  If LineNumber is NULL, then ASSERT().

-

-  @param  CodeType     The type of status code being converted.

-  @param  Value        The status code value being converted.

-  @param  Data         Pointer to status code data buffer. 

-  @param  Filename     Pointer to the source file name that generated the ASSERT().

-  @param  Description  Pointer to the description of the ASSERT().

-  @param  LineNumber   Pointer to source line number that generated the ASSERT().

-

-  @retval  TRUE   The status code specified by CodeType, Value, and Data was 

-                  converted ASSERT() arguments specified by Filename, Description, 

-                  and LineNumber.

-  @retval  FALSE  The status code specified by CodeType, Value, and Data could 

-                  not be converted to ASSERT() arguments.

-

-**/

-BOOLEAN

-EFIAPI

-ReportStatusCodeExtractAssertInfo (

-  IN EFI_STATUS_CODE_TYPE        CodeType,

-  IN EFI_STATUS_CODE_VALUE       Value,  

-  IN CONST EFI_STATUS_CODE_DATA  *Data, 

-  OUT CHAR8                      **Filename,

-  OUT CHAR8                      **Description,

-  OUT UINT32                     *LineNumber

-  )

-{

-  EFI_DEBUG_ASSERT_DATA  *AssertData;

-

-  ASSERT (Data        != NULL);

-  ASSERT (Filename    != NULL);

-  ASSERT (Description != NULL);

-  ASSERT (LineNumber  != NULL);

-

-  if (((CodeType & EFI_STATUS_CODE_TYPE_MASK)      == EFI_ERROR_CODE) && 

-      ((CodeType & EFI_STATUS_CODE_SEVERITY_MASK)  == EFI_ERROR_UNRECOVERED) &&

-      ((Value    & EFI_STATUS_CODE_OPERATION_MASK) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE)) {

-    AssertData   = (EFI_DEBUG_ASSERT_DATA *)(Data + 1);

-    *Filename    = (CHAR8 *)(AssertData + 1);

-    *Description = *Filename + AsciiStrLen (*Filename) + 1;

-    *LineNumber  = AssertData->LineNumber;

-    return TRUE;

-  }

-  return FALSE;

-}

-

-

-/**

-  Extracts DEBUG() information from a status code structure.

-

-  Converts the status code specified by Data to the DEBUG() arguments specified 

-  by ErrorLevel, Marker, and Format.  If type GUID in Data is 

-  EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and 

-  Format from the optional data area of the status code buffer specified by Data.  

-  The optional data area of Data contains a 32-bit ErrorLevel followed by Marker 

-  which is 12 UINTN parameters, followed by a Null-terminated ASCII string for 

-  the Format.  If the DEBUG() information could be extracted from Data, then 

-  return TRUE.  Otherwise, FALSE is returned.

-

-  If Data is NULL, then ASSERT().

-  If ErrorLevel is NULL, then ASSERT().

-  If Marker is NULL, then ASSERT().

-  If Format is NULL, then ASSERT().

-

-  @param  Data        Pointer to status code data buffer. 

-  @param  ErrorLevel  Pointer to error level mask for a debug message.

-  @param  Marker      Pointer to the variable argument list associated with Format.

-  @param  Format      Pointer to a Null-terminated ASCII format string of a 

-                      debug message.

-

-  @retval  TRUE   The status code specified by Data was converted DEBUG() arguments 

-                  specified by ErrorLevel, Marker, and Format.

-  @retval  FALSE  The status code specified by Data could not be converted to 

-                  DEBUG() arguments.

-

-**/

-BOOLEAN

-EFIAPI

-ReportStatusCodeExtractDebugInfo (

-  IN CONST EFI_STATUS_CODE_DATA  *Data, 

-  OUT UINT32                     *ErrorLevel,

-  OUT VA_LIST                    *Marker,

-  OUT CHAR8                      **Format

-  )

-{

-  EFI_DEBUG_INFO  *DebugInfo;

-

-  ASSERT (Data       != NULL);

-  ASSERT (ErrorLevel != NULL);

-  ASSERT (Marker     != NULL);

-  ASSERT (Format     != NULL);

-

-  //

-  // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE

-  //

-  if (!CompareGuid (&Data->Type, &gEfiStatusCodeDataTypeDebugGuid)) {

-    return FALSE;

-  }

-

-  //

-  // Retrieve the debug information from the status code record

-  //

-  DebugInfo = (EFI_DEBUG_INFO *)(Data + 1);

-

-  *ErrorLevel = DebugInfo->ErrorLevel;

-

-  //

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

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

-  //

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

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

-

-  return TRUE;

-}

-

-

-/**

-  Reports a status code.

-

-  Reports the status code specified by the parameters Type and Value.  Status 

-  code also require an instance, caller ID, and extended data.  This function 

-  passed in a zero instance, NULL extended data, and a caller ID of 

-  gEfiCallerIdGuid, which is the GUID for the module.  

-  

-  ReportStatusCode()must actively prevent recusrsion.  If ReportStatusCode() 

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

-  then ReportStatusCode() must return immediately.

-

-  @param  Type   Status code type. 

-  @param  Value  Status code value.

-

-  @retval  EFI_SUCCESS       The status code was reported.

-  @retval  EFI_DEVICE_ERROR  There status code could not be reported due to a 

-                             device error.

-  @retval  EFI_UNSUPPORTED   Report status code is not supported

-

-**/

-EFI_STATUS

-EFIAPI

-ReportStatusCode (

-  IN EFI_STATUS_CODE_TYPE   Type,

-  IN EFI_STATUS_CODE_VALUE  Value

-  )

-{

-  return EFI_UNSUPPORTED;

-}

-

-

-/**

-  Reports a status code with a Device Path Protocol as the extended data.

-

-  Allocates and fills in the extended data section of a status code with the 

-  Device Path Protocol specified by DevicePath.  This function is responsible 

-  for allocating a buffer large enough for the standard header and the device 

-  path.  The standard header is filled in with a GUID of 

-  gEfiStatusCodeSpecificDataGuid.  The status code is reported with a zero 

-  instance and a caller ID of gEfiCallerIdGuid.

-

-  ReportStatusCodeWithDevicePath()must actively prevent recursion.  If 

-  ReportStatusCodeWithDevicePath() is called while processing another any other 

-  Report Status Code Library function, then ReportStatusCodeWithDevicePath() 

-  must return EFI_DEVICE_ERROR immediately.

-

-  If DevicePath is NULL, then ASSERT().

-

-  @param  Type        Status code type. 

-  @param  Value       Status code value.

-  @param  DevicePath  Pointer to the Device Path Protocol to be reported.

-

-  @retval  EFI_SUCCESS           The status code was reported with the extended 

-                                 data specified by DevicePath.

-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the 

-                                 extended data section.

-  @retval  EFI_UNSUPPORTED       Report status code is not supported

-

-**/

-EFI_STATUS

-EFIAPI

-ReportStatusCodeWithDevicePath (

-  IN EFI_STATUS_CODE_TYPE            Type,

-  IN EFI_STATUS_CODE_VALUE           Value,

-  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath

-  )

-{

-  ASSERT (DevicePath != NULL);

-  return EFI_UNSUPPORTED;

-}

-

-

-/**

-  Reports a status code with an extended data buffer.

-

-  Allocates and fills in the extended data section of a status code with the 

-  extended data specified by ExtendedData and ExtendedDataSize.  ExtendedData 

-  is assumed to be one of the data structures specified in Related Definitions.  

-  These data structure do not have the standard 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 of  gEfiStatusCodeSpecificDataGuid.  The status code is reported 

-  with a zero instance and a caller ID of gEfiCallerIdGuid.

-

-  ReportStatusCodeWithExtendedData()must actively prevent recursion.  If 

-  ReportStatusCodeWithExtendedData() is called while processing another any other 

-  Report Status Code Library function, then ReportStatusCodeWithExtendedData() 

-  must return EFI_DEVICE_ERROR immediately.

-

-  If ExtendedData is NULL, then ASSERT().

-  If ExtendedDataSize is 0, then ASSERT().

-

-  @param  Type              Status code type. 

-  @param  Value             Status code value.

-  @param  ExtendedData      Pointer to the extended data buffer to be reported.

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

-                            be reported.

-

-  @retval  EFI_SUCCESS           The status code was reported with the extended 

-                                 data specified by ExtendedData and ExtendedDataSize.

-  @retval  EFI_OUT_OF_RESOURCES  There were not enough resources to allocate the 

-                                 extended data section.

-  @retval  EFI_UNSUPPORTED       Report status code is not supported

-

-**/

-EFI_STATUS

-EFIAPI

-ReportStatusCodeWithExtendedData (

-  IN EFI_STATUS_CODE_TYPE   Type,

-  IN EFI_STATUS_CODE_VALUE  Value,

-  IN CONST VOID             *ExtendedData,

-  IN UINTN                  ExtendedDataSize

-  )

-{

-  ASSERT (ExtendedData     != NULL);

-  ASSERT (ExtendedDataSize != 0);

-  return EFI_UNSUPPORTED;

-}

-

-

-/**

-  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

-ReportStatusCodeEx (

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

-  return EFI_UNSUPPORTED;

-}

-

-

-/**

-  Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled

-

-  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED 

-  bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.

-

-  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of 

-                  PcdReportStatusCodeProperyMask is set.

-  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of 

-                  PcdReportStatusCodeProperyMask is clear.

-

-**/

-BOOLEAN

-EFIAPI

-ReportProgressCodeEnabled (

-  VOID

-  )

-{

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

-}

-

-

-/**

-  Returns TRUE if status codes of type EFI_ERROR_CODE are enabled

-

-  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED 

-  bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.

-

-  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of 

-                  PcdReportStatusCodeProperyMask is set.

-  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of 

-                  PcdReportStatusCodeProperyMask is clear.

-

-**/

-BOOLEAN

-EFIAPI

-ReportErrorCodeEnabled (

-  VOID

-  )

-{

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

-}

-

-

-/**

-  Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled

-

-  This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED 

-  bit of PcdReportStatusCodeProperyMask is set.  Otherwise FALSE is returned.

-

-  @retval  TRUE   The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of 

-                  PcdReportStatusCodeProperyMask is set.

-  @retval  FALSE  The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of 

-                  PcdReportStatusCodeProperyMask is clear.

-

-**/

-BOOLEAN

-EFIAPI

-ReportDebugCodeEnabled (

-  VOID

-  )

-{

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

-}