Initial import.

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

4 files changed, 389 insertions, 0 deletions

diff --git a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
new file mode 100644
index 0000000000..4c068087be
--- /dev/null
+++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
@@ -0,0 +1,247 @@
+/** @file

+  UEFI Debug Library that uses PrintLib to send messages to CONOUT.

+

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

+

+**/

+

+//

+// Define the maximum debug and assert message length that this library supports 

+//

+#define MAX_DEBUG_MESSAGE_LENGTH  0x100

+

+

+/**

+

+  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  CHAR8 *Format,

+  ...

+  )

+{

+  CHAR16   Buffer[MAX_DEBUG_MESSAGE_LENGTH];

+  VA_LIST  Marker;

+

+  //

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

+  //

+  ASSERT (Format != NULL);

+

+  //

+  // Check driver debug mask value and global mask

+  //

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

+    return;

+  }

+

+  //

+  // Convert the DEBUG() message to a Unicode String

+  //

+  VA_START (Marker, Format);

+  UnicodeVSPrintAsciiFormat (Buffer, sizeof (Buffer), Format, Marker);

+  VA_END (Marker);

+

+  //

+  // Send the print string to the Console Output device

+  //

+  if (gST->ConOut != NULL) {

+    gST->ConOut->OutputString (gST->ConOut, Buffer);

+  }

+}

+

+

+/**

+

+  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 CHAR8  *FileName,

+  IN INTN   LineNumber,

+  IN CHAR8  *Description

+  )

+{

+  CHAR16  Buffer[MAX_DEBUG_MESSAGE_LENGTH];

+

+  //

+  // Generate the ASSERT() message in Unicode format

+  //

+  UnicodeSPrintAsciiFormat (Buffer, sizeof (Buffer), "ASSERT %s(%d): %s\n", FileName, LineNumber, Description);

+

+  //

+  // Send the print string to the Console Output device

+  //

+  if (gST->ConOut != NULL) {

+    gST->ConOut->OutputString (gST->ConOut, Buffer);

+  }

+

+  //

+  // 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 ((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 ((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 ((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 ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);

+}

diff --git a/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.mbd b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.mbd
new file mode 100644
index 0000000000..12032d4094
--- /dev/null
+++ b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.mbd
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<!--

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

+-->

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

+  <MbdLibHeader>

+    <BaseName>UefiDebugLibConOut</BaseName>

+    <Guid>5cddfaf3-e9a7-4d16-bdce-1e002df475bb</Guid>

+    <Version>0</Version>

+    <Description>Library to abstract Framework extensions that conflict with UEFI 2.0 Specification</Description>

+    <Copyright>Copyright (c) 2004-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>

+    <Created>2006-03-09 23:12</Created>

+    <Modified>2006-03-19 15:17</Modified>

+  </MbdLibHeader>

+</LibraryModuleBuildDescription>

diff --git a/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.msa b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.msa
new file mode 100644
index 0000000000..6d41033d8d
--- /dev/null
+++ b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.msa
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<!--

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

+-->

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

+  <MsaLibHeader>

+    <BaseName>UefiDebugLibConOut</BaseName>

+    <ModuleType>UEFI_DRIVER</ModuleType>

+    <ComponentType>LIBRARY</ComponentType>

+    <Guid>5cddfaf3-e9a7-4d16-bdce-1e002df475bb</Guid>

+    <Version>0</Version>

+    <Abstract>Debug Library for UEFI drivers</Abstract>

+    <Description>Library to abstract Framework extensions that conflict with UEFI 2.0 Specification</Description>

+    <Copyright>Copyright (c) 2004-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>0</Specification>

+    <Created>2006-03-09 23:12</Created>

+    <Updated>2006-03-19 15:17</Updated>

+  </MsaLibHeader>

+  <LibraryClassDefinitions>

+    <LibraryClass Usage="ALWAYS_PRODUCED">DebugLib</LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">UefiBootServicesTableLib</LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">PrintLib</LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">PcdLib</LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">BaseLib</LibraryClass>

+    <LibraryClass Usage="ALWAYS_CONSUMED">BaseMemoryLib</LibraryClass>

+  </LibraryClassDefinitions>

+  <SourceFiles>

+    <Filename>DebugLib.c</Filename>

+  </SourceFiles>

+  <Includes>

+    <PackageName>MdePkg</PackageName>

+  </Includes>

+  <PCDs>

+    <PcdData ItemType="FIXED_AT_BUILD">

+      <C_Name>PcdDebugPropertyMask</C_Name>

+      <Token>0x00000005</Token>

+      <DatumType>UINT8</DatumType>

+    </PcdData>

+    <PcdData ItemType="FIXED_AT_BUILD">

+      <C_Name>PcdDebugClearMemoryValue</C_Name>

+      <Token>0x00000008</Token>

+      <DatumType>UINT8</DatumType>

+    </PcdData>

+    <PcdData ItemType="PATCHABLE_IN_MODULE">

+      <C_Name>PcdDebugPrintErrorLevel</C_Name>

+      <Token>0x00000006</Token>

+      <DatumType>UINT32</DatumType>

+    </PcdData>

+  </PCDs>

+</LibraryModuleSurfaceArea>

diff --git a/MdePkg/Library/UefiDebugLibConOut/build.xml b/MdePkg/Library/UefiDebugLibConOut/build.xml
new file mode 100644
index 0000000000..b314b5fffe
--- /dev/null
+++ b/MdePkg/Library/UefiDebugLibConOut/build.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?><!-- 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.-->

+<project basedir="." default="UefiDebugLibConOut"><!--Apply external ANT tasks-->

+   <taskdef resource="GenBuild.tasks"/>

+   <taskdef resource="net/sf/antcontrib/antlib.xml"/>

+   <property environment="env"/>

+   <property name="WORKSPACE_DIR" value="${env.WORKSPACE}"/>

+   <import file="${WORKSPACE_DIR}\Tools\Conf\BuildMacro.xml"/><!--MODULE_RELATIVE PATH is relative to PACKAGE_DIR-->

+   <property name="MODULE_RELATIVE_PATH" value="Library\UefiDebugLibConOut"/>

+   <property name="MODULE_DIR" value="${PACKAGE_DIR}\${MODULE_RELATIVE_PATH}"/>

+   <property name="COMMON_FILE" value="${WORKSPACE_DIR}\Tools\Conf\Common.xml"/>

+   <target name="UefiDebugLibConOut">

+      <GenBuild baseName="UefiDebugLibConOut" mbdFilename="${MODULE_DIR}\UefiDebugLibConOut.mbd" msaFilename="${MODULE_DIR}\UefiDebugLibConOut.msa"/>

+   </target>

+   <target depends="UefiDebugLibConOut_clean" name="clean"/>

+   <target depends="UefiDebugLibConOut_cleanall" name="cleanall"/>

+   <target name="UefiDebugLibConOut_clean">

+      <OutputDirSetup baseName="UefiDebugLibConOut" mbdFilename="${MODULE_DIR}\UefiDebugLibConOut.mbd" msaFilename="${MODULE_DIR}\UefiDebugLibConOut.msa"/>

+      <if>

+         <available file="${DEST_DIR_OUTPUT}\UefiDebugLibConOut_build.xml"/>

+         <then>

+            <ant antfile="${DEST_DIR_OUTPUT}\UefiDebugLibConOut_build.xml" target="clean"/>

+         </then>

+      </if>

+      <delete dir="${DEST_DIR_OUTPUT}" excludes="*.xml"/>

+   </target>

+   <target name="UefiDebugLibConOut_cleanall">

+      <OutputDirSetup baseName="UefiDebugLibConOut" mbdFilename="${MODULE_DIR}\UefiDebugLibConOut.mbd" msaFilename="${MODULE_DIR}\UefiDebugLibConOut.msa"/>

+      <if>

+         <available file="${DEST_DIR_OUTPUT}\UefiDebugLibConOut_build.xml"/>

+         <then>

+            <ant antfile="${DEST_DIR_OUTPUT}\UefiDebugLibConOut_build.xml" target="cleanall"/>

+         </then>

+      </if>

+      <delete dir="${DEST_DIR_OUTPUT}"/>

+      <delete dir="${DEST_DIR_DEBUG}"/>

+      <delete>

+         <fileset dir="${BIN_DIR}" includes="**UefiDebugLibConOut*"/>

+      </delete>

+   </target>

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