1) Move EFI_DEBUG_INFO structure to IntelFrameworkModule/Include/DebugInfo.h header file.

2) Move BaseReportStatusCodeLib, PeiDxeDebugLibReportStatusCode, DxeReportStatusCodeLibFramework,PeiReportStatusCodeLib to IntelFrameworkModulePkg

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

3 files changed, 434 insertions, 0 deletions

diff --git a/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
new file mode 100644
index 0000000000..9ff476ecde
--- /dev/null
+++ b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
@@ -0,0 +1,300 @@
+/** @file

+  Debug Library that fowards all messages to ReportStatusCode()

+

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

+

+**/

+

+

+

+#include <FrameworkPei.h>

+

+#include <Guid/StatusCodeDataTypeId.h>

+

+#include <Library/DebugLib.h>

+#include <Library/BaseLib.h>

+#include <Library/BaseMemoryLib.h>

+#include <Library/ReportStatusCodeLib.h>

+#include <Library/PcdLib.h>

+

+#include <DebugInfo.h>

+

+/**

+

+  Prints a debug message to the debug output device if the specified error level is enabled.

+

+  If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print

+  the message specified by Format and the associated variable argument list to

+  the debug output device.

+

+  If Format is NULL, then ASSERT().

+

+  @param  ErrorLevel  The error level of the debug message.

+  @param  Format      Format string for the debug message to print.

+

+**/

+VOID

+EFIAPI

+DebugPrint (

+  IN  UINTN        ErrorLevel,

+  IN  CONST CHAR8  *Format,

+  ...

+  )

+{

+  UINT64          Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof (UINT64)];

+  EFI_DEBUG_INFO  *DebugInfo;

+  UINTN           TotalSize;

+  UINTN           Index;

+  VA_LIST         Marker;

+  UINT64          *ArgumentPointer;

+

+  //

+  // If Format is NULL, then ASSERT().

+  //

+  ASSERT (Format != NULL);

+

+  //

+  // Check driver Debug Level value and global debug level

+  //

+  if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {

+    return;

+  }

+

+  TotalSize = sizeof (EFI_DEBUG_INFO) + 12 * sizeof (UINT64) + AsciiStrLen (Format) + 1;

+  if (TotalSize > EFI_STATUS_CODE_DATA_MAX_SIZE) {

+    return;

+  }

+

+  //

+  // Then EFI_DEBUG_INFO

+  //

+  DebugInfo = (EFI_DEBUG_INFO *)Buffer;

+  DebugInfo->ErrorLevel = (UINT32)ErrorLevel;

+

+  //

+  // 256 byte mini Var Arg stack. That is followed by the format string.

+  //

+  VA_START (Marker, Format);

+  for (Index = 0, ArgumentPointer = (UINT64 *)(DebugInfo + 1); Index < 12; Index++, ArgumentPointer++) {

+    WriteUnaligned64(ArgumentPointer, VA_ARG (Marker, UINT64));

+  }

+  VA_END (Marker);

+  AsciiStrCpy ((CHAR8 *)ArgumentPointer, Format);

+

+  REPORT_STATUS_CODE_EX (

+    EFI_DEBUG_CODE,

+    (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_DC_UNSPECIFIED),

+    0,

+    NULL,

+    &gEfiStatusCodeDataTypeDebugGuid,

+    DebugInfo,

+    TotalSize

+    );

+}

+

+

+/**

+

+  Prints an assert message containing a filename, line number, and description.

+  This may be followed by a breakpoint or a dead loop.

+

+  Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"

+  to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of

+  PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if

+  DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then

+  CpuDeadLoop() is called.  If neither of these bits are set, then this function

+  returns immediately after the message is printed to the debug output device.

+  DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while

+  processing another DebugAssert(), then DebugAssert() must return immediately.

+

+  If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.

+

+  If Description is NULL, then a <Description> string of "(NULL) Description" is printed.

+

+  @param  FileName     Pointer to the name of the source file that generated the assert condition.

+  @param  LineNumber   The line number in the source file that generated the assert condition

+  @param  Description  Pointer to the description of the assert condition.

+

+**/

+VOID

+EFIAPI

+DebugAssert (

+  IN CONST CHAR8  *FileName,

+  IN UINTN        LineNumber,

+  IN CONST CHAR8  *Description

+  )

+{

+  UINT64                 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof(UINT64)];

+  EFI_DEBUG_ASSERT_DATA  *AssertData;

+  UINTN                  TotalSize;

+  CHAR8                  *Temp;

+  UINTN                  FileNameLength;

+  UINTN                  DescriptionLength;

+

+  //

+  // Make sure it will all fit in the passed in buffer

+  //

+  FileNameLength    = AsciiStrLen (FileName);

+  DescriptionLength = AsciiStrLen (Description);

+  TotalSize = sizeof (EFI_DEBUG_ASSERT_DATA) + FileNameLength + 1 + DescriptionLength + 1;

+  if (TotalSize <= EFI_STATUS_CODE_DATA_MAX_SIZE) {

+    //

+    // Fill in EFI_DEBUG_ASSERT_DATA

+    //

+    AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;

+    AssertData->LineNumber = (UINT32)LineNumber;

+

+    //

+    // Copy Ascii FileName including NULL.

+    //

+    Temp = AsciiStrCpy ((CHAR8 *)(AssertData + 1), FileName);

+

+    //

+    // Copy Ascii Description

+    //

+    AsciiStrCpy (Temp + AsciiStrLen (FileName) + 1, Description);

+

+    REPORT_STATUS_CODE_WITH_EXTENDED_DATA (

+      (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),

+      (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),

+      AssertData,

+      TotalSize

+      );

+  }

+

+  //

+  // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings

+  //

+  if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {

+    CpuBreakpoint ();

+  } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {

+    CpuDeadLoop ();

+  }

+}

+

+

+/**

+

+  Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.

+

+  This function fills Length bytes of Buffer with the value specified by

+  PcdDebugClearMemoryValue, and returns Buffer.

+

+  If Buffer is NULL, then ASSERT().

+

+  If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().

+

+  @param   Buffer  Pointer to the target buffer to fill with PcdDebugClearMemoryValue.

+  @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.

+

+  @return  Buffer

+

+**/

+VOID *

+EFIAPI

+DebugClearMemory (

+  OUT VOID  *Buffer,

+  IN UINTN  Length

+  )

+{

+  //

+  // If Buffer is NULL, then ASSERT().

+  //

+  ASSERT (Buffer != NULL);

+

+  //

+  // SetMem() checks for the the ASSERT() condition on Length and returns Buffer

+  //

+  return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));

+}

+

+

+/**

+

+  Returns TRUE if ASSERT() macros are enabled.

+

+  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of

+  PcdDebugProperyMask is set.  Otherwise FALSE is returned.

+

+  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.

+  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.

+

+**/

+BOOLEAN

+EFIAPI

+DebugAssertEnabled (

+  VOID

+  )

+{

+  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);

+}

+

+

+/**

+

+  Returns TRUE if DEBUG()macros are enabled.

+

+  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of

+  PcdDebugProperyMask is set.  Otherwise FALSE is returned.

+

+  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.

+  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.

+

+**/

+BOOLEAN

+EFIAPI

+DebugPrintEnabled (

+  VOID

+  )

+{

+  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);

+}

+

+

+/**

+

+  Returns TRUE if DEBUG_CODE()macros are enabled.

+

+  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of

+  PcdDebugProperyMask is set.  Otherwise FALSE is returned.

+

+  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.

+  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.

+

+**/

+BOOLEAN

+EFIAPI

+DebugCodeEnabled (

+  VOID

+  )

+{

+  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);

+}

+

+

+/**

+

+  Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.

+

+  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of

+  PcdDebugProperyMask is set.  Otherwise FALSE is returned.

+

+  @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.

+  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.

+

+**/

+BOOLEAN

+EFIAPI

+DebugClearMemoryEnabled (

+  VOID

+  )

+{

+  return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);

+}

diff --git a/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf
new file mode 100644
index 0000000000..4335694ea5
--- /dev/null
+++ b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.inf
@@ -0,0 +1,57 @@
+#/** @file

+# Debug Library based on report status code library

+#

+# Debug Library for PEIMs and DXE drivers that send debug messages to ReportStatusCode

+# Copyright (c) 2006, Intel Corporation.

+#

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

+#

+#

+#**/

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = PeiDxeDebugLibReportStatusCode

+  FILE_GUID                      = bda39d3a-451b-4350-8266-81ab10fa0523

+  MODULE_TYPE                    = PEIM

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = DebugLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER PEIM PEI_CORE UEFI_APPLICATION UEFI_DRIVER

+  EDK_RELEASE_VERSION            = 0x00020000

+  EFI_SPECIFICATION_VERSION      = 0x00020000

+

+

+#

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

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+[Sources.common]

+  DebugLib.c

+

+

+[Packages]

+  MdePkg/MdePkg.dec

+  IntelFrameworkPkg/IntelFrameworkPkg.dec

+  IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec

+  

+[LibraryClasses]

+  PcdLib

+  ReportStatusCodeLib

+  BaseMemoryLib

+  BaseLib

+

+

+[PcdsFixedAtBuild.common]

+  PcdDebugClearMemoryValue|gEfiMdePkgTokenSpaceGuid

+  PcdDebugPropertyMask|gEfiMdePkgTokenSpaceGuid

+

+

+[PcdsDynamic.common]

+  PcdDebugPrintErrorLevel|gEfiMdePkgTokenSpaceGuid

+

diff --git a/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.msa b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.msa
new file mode 100644
index 0000000000..cd0052e0ef
--- /dev/null
+++ b/IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/PeiDxeDebugLibReportStatusCode.msa
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

+  <MsaHeader>

+    <ModuleName>PeiDxeDebugLibReportStatusCode</ModuleName>

+    <ModuleType>PEIM</ModuleType>

+    <GuidValue>bda39d3a-451b-4350-8266-81ab10fa0523</GuidValue>

+    <Version>1.0</Version>

+    <Abstract>Debug Library based on report status code library</Abstract>

+    <Description>Debug Library for PEIMs and DXE drivers that send debug messages to ReportStatusCode</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>PeiDxeDebugLibReportStatusCode</OutputFileBasename>

+  </ModuleDefinitions>

+  <LibraryClassDefinitions>

+    <LibraryClass Usage="ALWAYS_PRODUCED" SupModuleList="DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER PEIM PEI_CORE UEFI_APPLICATION UEFI_DRIVER">

+      <Keyword>DebugLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>BaseLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>BaseMemoryLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>ReportStatusCodeLib</Keyword>

+    </LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">

+      <Keyword>PcdLib</Keyword>

+    </LibraryClass>

+  </LibraryClassDefinitions>

+  <SourceFiles>

+    <Filename>DebugLib.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>PcdDebugPropertyMask</C_Name>

+      <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>

+      <HelpText>The bitmask of flags that specify the enable/disable of Debug
+                Assert, Debug Print, Debug Code, Clear Memory, Assert
+                Breakpoint and Assert Deadloop.</HelpText>

+    </PcdEntry>

+    <PcdEntry PcdItemType="FIXED_AT_BUILD">

+      <C_Name>PcdDebugClearMemoryValue</C_Name>

+      <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>

+      <HelpText>The value used by DebugClearMemory () to fill a certain range
+                of memory.</HelpText>

+    </PcdEntry>

+    <PcdEntry PcdItemType="DYNAMIC">

+      <C_Name>PcdDebugPrintErrorLevel</C_Name>

+      <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>

+      <HelpText>The bitmask of flags that specify the kind of debug message
+                output when Debug Print is enabled.</HelpText>

+    </PcdEntry>

+  </PcdCoded>

+</ModuleSurfaceArea>
\ No newline at end of file