Update DebugLib to provide support for "err" command in the EFI Shell to adjust the filter mask for DEBUG() messages. The "err" command provide the ability to adjust this filter mask at a global level through an EFI Variable and at the module level through a the Debug Mask Protocol. In order to support the degree of flexibility, the DebugLib needs to use library to abstract the get/set operations to the filter mask.

1) Define new DebugPrintErrorLevelLib that produces an API that DebugPrint() APIs in DebugLib implementations can use to retrieve the current mask for filtering DebugPrint() statements.
2) Add a BASE type implementation of the DebugPrintErrorLevelLib that directly accessed PcdDebugPrintErrorLevel to provide backward compatibility with the current EDK II DebugLib behavior.
3) Update description of the DebugPrint() API in the DebugLib to describe the new dependency on the DebugPrintErrorLevelLib that replaces the prior dependency in the PcdDebugPrintErrorLevel PCD.
4) Update the comments in BaseDebugLibNull to match (3).
5) Update BaseDebugLibSerialPort to use DebugPrintErrorLevelLib instead of the PcdDebugPrintErrorLevel PCD.
6) Update UefiDebugLinConOut to use DebugPrintErrorLevelLib instead of the PcdDebugPrintErrorLevel PCD.
7) Update UefiDebugLibStdErr to use DebugPrintErrorLevelLib instead of the PcdDebugPrintErrorLevel PCD.



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

11 files changed, 164 insertions, 28 deletions

diff --git a/MdePkg/Include/Library/DebugLib.h b/MdePkg/Include/Library/DebugLib.h
index 5e02dfd..7bb964f 100644
--- a/MdePkg/Include/Library/DebugLib.h
+++ b/MdePkg/Include/Library/DebugLib.h
@@ -77,9 +77,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**

   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 any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function 

+  GetDebugPrintErrorLevel (), then print the message specified by Format and the 

+  associated variable argument list to the debug output device.

 

   If Format is NULL, then ASSERT().

 

diff --git a/MdePkg/Include/Library/DebugPrintErrorLevelLib.h b/MdePkg/Include/Library/DebugPrintErrorLevelLib.h
new file mode 100644
index 0000000..1e6bd65
--- /dev/null
+++ b/MdePkg/Include/Library/DebugPrintErrorLevelLib.h
@@ -0,0 +1,38 @@
+/** @file

+  Debug Print Error Level Library class

+

+  Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>

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

+

+**/

+

+/**

+  Returns the debug print error level mask for the current module.

+

+  @return  Debug print error level mask for the current module.

+

+**/

+UINT32

+EFIAPI

+GetDebugPrintErrorLevel (

+  VOID

+  );

+

+/**

+  Sets the global debug print error level mask fpr the entire platform.

+

+  @retval  TRUE   The debug print error level mask was sucessfully set.

+  @retval  FALSE  The debug print error level mask could not be set.

+

+**/

+BOOLEAN

+EFIAPI

+SetDebugPrintErrorLevel (

+  UINT32  ErrorLevel

+  );

diff --git a/MdePkg/Library/BaseDebugLibNull/DebugLib.c b/MdePkg/Library/BaseDebugLibNull/DebugLib.c
index 648208d..4ba62cb 100644
--- a/MdePkg/Library/BaseDebugLibNull/DebugLib.c
+++ b/MdePkg/Library/BaseDebugLibNull/DebugLib.c
@@ -1,7 +1,7 @@
 /** @file

   Null Base Debug Library instance with empty functions.

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

   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

@@ -18,9 +18,9 @@
 /**

   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 any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function 

+  GetDebugPrintErrorLevel (), then print the message specified by Format and the 

+  associated variable argument list to the debug output device.

 

   If Format is NULL, then ASSERT().

 

diff --git a/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf b/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf
index be636c8..61befd6 100644
--- a/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf
+++ b/MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf
@@ -2,7 +2,7 @@
 #  Instance of Debug Library based on Serial Port Library.

 #  It uses Print Library to produce formatted output strings.

 #

-#  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+#  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

 #

 #  This program and the accompanying materials

 #  are licensed and made available under the terms and conditions of the BSD License

@@ -39,9 +39,9 @@
   PcdLib

   PrintLib

   BaseLib

+  DebugPrintErrorLevelLib

 

 [Pcd]

-  gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel

   gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue

   gEfiMdePkgTokenSpaceGuid.PcdDebugPropertyMask

 

diff --git a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
index b54fa15..e1674fc 100644
--- a/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
+++ b/MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c
@@ -7,7 +7,7 @@
   being blocked.  This may occur if a key(s) are pressed in a terminal emulator

   used to monitor the DEBUG() and ASSERT() messages. 

 

-  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

   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        

@@ -25,6 +25,7 @@
 #include <Library/PcdLib.h>

 #include <Library/BaseMemoryLib.h>

 #include <Library/SerialPortLib.h>

+#include <Library/DebugPrintErrorLevelLib.h>

 

 //

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

@@ -49,9 +50,9 @@ BaseDebugLibSerialPortConstructor (
 /**

   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 any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function 

+  GetDebugPrintErrorLevel (), then print the message specified by Format and the 

+  associated variable argument list to the debug output device.

 

   If Format is NULL, then ASSERT().

 

@@ -80,7 +81,7 @@ DebugPrint (
   //

   // Check driver debug mask value and global mask

   //

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

+  if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {

     return;

   }

 

diff --git a/MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.c b/MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.c
new file mode 100644
index 0000000..df4612e
--- /dev/null
+++ b/MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.c
@@ -0,0 +1,57 @@
+/** @file

+  Debug Print Error Level library instance that retrieves the current error 

+  level from PcdDebugPrintErrorLevel.  This generic library instance does not 

+  support the setting of the global debug print error level mask for the platform.

+

+  Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>

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

+#include <Library/DebugPrintErrorLevelLib.h>

+#include <Library/PcdLib.h>

+

+/**

+  Returns the debug print error level mask for the current module.

+

+  @return  Debug print error level mask for the current module.

+

+**/

+UINT32

+EFIAPI

+GetDebugPrintErrorLevel (

+  VOID

+  )

+{

+  //

+  // Retrieve the current debug print error level mask from PcdDebugPrintErrorLevel.

+  //

+  return PcdGet32 (PcdDebugPrintErrorLevel);

+}

+

+/**

+  Sets the global debug print error level mask fpr the entire platform.

+

+  @retval  TRUE   The debug print error level mask was sucessfully set.

+  @retval  FALSE  The debug print error level mask could not be set.

+

+**/

+BOOLEAN

+EFIAPI

+SetDebugPrintErrorLevel (

+  UINT32  ErrorLevel

+  )

+{

+  //

+  // This library uinstance does not support setting the global debug print error

+  // level mask.

+  //

+  return FALSE;

+}

diff --git a/MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.inf b/MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.inf
new file mode 100644
index 0000000..72102e4
--- /dev/null
+++ b/MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.inf
@@ -0,0 +1,38 @@
+## @file

+#  Debug Print Error Level library instance that retrieves the current error 

+#  level from PcdDebugPrintErrorLevel.  

+#

+#  Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>

+#

+#  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                      = BaseDebugPrintErrorLevelLib

+  FILE_GUID                      = A2C09E18-E4D2-407e-AFCC-628B79113F72

+  MODULE_TYPE                    = BASE

+  VERSION_STRING                 = 1.0

+  LIBRARY_CLASS                  = DebugPrintErrorLevelLib

+

+#

+#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC

+#

+

+[Sources]

+  BaseDebugPrintErrorLevelLib.c

+

+[Packages]

+  MdePkg/MdePkg.dec

+

+[LibraryClasses]

+  PcdLib

+  

+[Pcd]

+  gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel

diff --git a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
index 7893ec6..ce4b324 100644
--- a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
@@ -1,7 +1,7 @@
 /** @file

   UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

   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        

@@ -20,6 +20,7 @@
 #include <Library/PcdLib.h>

 #include <Library/BaseLib.h>

 #include <Library/BaseMemoryLib.h>

+#include <Library/DebugPrintErrorLevelLib.h>

 

 //

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

@@ -29,9 +30,9 @@
 /**

   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 any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function 

+  GetDebugPrintErrorLevel (), then print the message specified by Format and the 

+  associated variable argument list to the debug output device.

 

   If Format is NULL, then ASSERT().

 

@@ -60,7 +61,7 @@ DebugPrint (
   //

   // Check driver debug mask value and global mask

   //

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

+  if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {

     return;

   }

 

diff --git a/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf
index 9774d0a..0601709 100644
--- a/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf
+++ b/MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf
@@ -3,7 +3,7 @@
 #

 #  Debug Lib that sends messages to the Console Output Device in the EFI System Table.

 #

-#  Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>

+#  Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>

 #

 #  This program and the accompanying materials

 #  are licensed and made available under the terms and conditions of the BSD License

@@ -44,9 +44,9 @@
   PcdLib

   PrintLib

   UefiBootServicesTableLib

+  DebugPrintErrorLevelLib

 

 [Pcd]

-  gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel         ## CONSUMES

   gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue        ## CONSUMES

   gEfiMdePkgTokenSpaceGuid.PcdDebugPropertyMask            ## CONSUMES

 

diff --git a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
index 29a619b..73c7204 100644
--- a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
@@ -1,7 +1,7 @@
 /** @file

   UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.

 

-  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>

   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        

@@ -21,6 +21,7 @@
 #include <Library/PcdLib.h>

 #include <Library/BaseLib.h>

 #include <Library/BaseMemoryLib.h>

+#include <Library/DebugPrintErrorLevelLib.h>

 

 //

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

@@ -31,9 +32,9 @@
 /**

   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 any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function 

+  GetDebugPrintErrorLevel (), then print the message specified by Format and the 

+  associated variable argument list to the debug output device.

 

   If Format is NULL, then ASSERT().

 

@@ -62,7 +63,7 @@ DebugPrint (
   //

   // Check driver debug mask value and global mask

   //

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

+  if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {

     return;

   }

 

diff --git a/MdePkg/Library/UefiDebugLibStdErr/UefiDebugLibStdErr.inf b/MdePkg/Library/UefiDebugLibStdErr/UefiDebugLibStdErr.inf
index 30a74a5..7b93f4c 100644
--- a/MdePkg/Library/UefiDebugLibStdErr/UefiDebugLibStdErr.inf
+++ b/MdePkg/Library/UefiDebugLibStdErr/UefiDebugLibStdErr.inf
@@ -3,7 +3,7 @@
 #

 #  Debug Lib that sends messages to the the Standard Error Device in the EFI System Table.

 #

-#  Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>

+#  Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>

 #

 #  This program and the accompanying materials

 #  are licensed and made available under the terms and conditions of the BSD License

@@ -42,9 +42,9 @@
   PcdLib

   PrintLib

   UefiBootServicesTableLib

+  DebugPrintErrorLevelLib

 

 [Pcd]

-  gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel    ## CONSUMES

   gEfiMdePkgTokenSpaceGuid.PcdDebugClearMemoryValue   ## CONSUMES

   gEfiMdePkgTokenSpaceGuid.PcdDebugPropertyMask       ## CONSUMES