ArmPkg/SemiHostingDebugLib: Add new APIs

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1395

Add new APIs' implementation (DebugVPrint, DebugBPrint)
in the DebugLib instance. These APIs would expose print
routines with VaList parameter and BaseList parameter.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael Turner <Michael.Turner@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>

diff --git a/ArmPkg/Library/SemiHostingDebugLib/DebugLib.c b/ArmPkg/Library/SemiHostingDebugLib/DebugLib.c
index ec03edb774402993c875cc8808e5a4dea4fb078b..a368dd43b8abec029c80974398d13404af314860 100644 (file)
--- a/ArmPkg/Library/SemiHostingDebugLib/DebugLib.c
+++ b/ArmPkg/Library/SemiHostingDebugLib/DebugLib.c
@@ -1,7 +1,7 @@
 /** @file\r
   UEFI Debug Library that uses PrintLib to send messages to STDERR.\r
 \r
 /** @file\r
   UEFI Debug Library that uses PrintLib to send messages to STDERR.\r
 \r

-  Copyright (c) 2006 - 2007, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r

   Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r


@@ -27,6 +27,12 @@
 //\r
 #define MAX_DEBUG_MESSAGE_LENGTH  0x100\r
 \r
 //\r
 #define MAX_DEBUG_MESSAGE_LENGTH  0x100\r
 \r

+//\r
+// VA_LIST can not initialize to NULL for all compiler, so we use this to\r
+// indicate a null VA_LIST\r
+//\r
+VA_LIST     mVaListNull;\r
+\r

 /**\r
 \r
   Prints a debug message to the debug output device if the specified error level is enabled.\r
 /**\r
 \r
   Prints a debug message to the debug output device if the specified error level is enabled.\r


@@ -48,9 +54,41 @@ DebugPrint (
   IN  CONST CHAR8  *Format,\r
   ...\r
   )\r
   IN  CONST CHAR8  *Format,\r
   ...\r
   )\r

+{\r
+  VA_LIST         Marker;\r
+\r
+  VA_START (Marker, Format);\r
+  DebugVPrint (ErrorLevel, Format, Marker);\r
+  VA_END (Marker);\r
+}\r
+\r
+\r
+/**\r
+  Prints a debug message to the debug output device if the specified\r
+  error level is enabled base on Null-terminated format string and a\r
+  VA_LIST argument list or a BASE_LIST argument list.\r
+\r
+  If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
+  GetDebugPrintErrorLevel (), then print the message specified by Format and\r
+  the associated variable argument list to the debug output device.\r
+\r
+  If Format is NULL, then ASSERT().\r
+\r
+  @param  ErrorLevel      The error level of the debug message.\r
+  @param  Format          Format string for the debug message to print.\r
+  @param  VaListMarker    VA_LIST marker for the variable argument list.\r
+  @param  BaseListMarker  BASE_LIST marker for the variable argument list.\r
+\r
+**/\r
+VOID\r
+DebugPrintMarker (\r
+  IN  UINTN         ErrorLevel,\r
+  IN  CONST CHAR8   *Format,\r
+  IN  VA_LIST       VaListMarker,\r
+  IN  BASE_LIST     BaseListMarker\r
+  )\r

 {\r
   CHAR8    AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];\r
 {\r
   CHAR8    AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];\r

-  VA_LIST  Marker;\r

 \r
   //\r
   // If Format is NULL, then ASSERT().\r
 \r
   //\r
   // If Format is NULL, then ASSERT().\r


@@ -67,14 +105,72 @@ DebugPrint (
   //\r
   // Convert the DEBUG() message to a Unicode String\r
   //\r
   //\r
   // Convert the DEBUG() message to a Unicode String\r
   //\r

-  VA_START (Marker, Format);\r
-  AsciiVSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, Marker);\r
-  VA_END (Marker);\r
+  if (BaseListMarker == NULL) {\r
+    AsciiVSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, VaListMarker);\r
+  } else {\r
+    AsciiBSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, BaseListMarker);\r
+  }\r

 \r
   SemihostWriteString (AsciiBuffer);\r
 }\r
 \r
 \r
 \r
   SemihostWriteString (AsciiBuffer);\r
 }\r
 \r
 \r

+/**\r
+  Prints a debug message to the debug output device if the specified\r
+  error level is enabled.\r
+\r
+  If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
+  GetDebugPrintErrorLevel (), then print the message specified by Format and\r
+  the associated variable argument list to the debug output device.\r
+\r
+  If Format is NULL, then ASSERT().\r
+\r
+  @param  ErrorLevel    The error level of the debug message.\r
+  @param  Format        Format string for the debug message to print.\r
+  @param  VaListMarker  VA_LIST marker for the variable argument list.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+DebugVPrint (\r
+  IN  UINTN         ErrorLevel,\r
+  IN  CONST CHAR8   *Format,\r
+  IN  VA_LIST       VaListMarker\r
+  )\r
+{\r
+  DebugPrintMarker (ErrorLevel, Format, VaListMarker, NULL);\r
+}\r
+\r
+\r
+/**\r
+  Prints a debug message to the debug output device if the specified\r
+  error level is enabled.\r
+  This function use BASE_LIST which would provide a more compatible\r
+  service than VA_LIST.\r
+\r
+  If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
+  GetDebugPrintErrorLevel (), then print the message specified by Format and\r
+  the associated variable argument list to the debug output device.\r
+\r
+  If Format is NULL, then ASSERT().\r
+\r
+  @param  ErrorLevel      The error level of the debug message.\r
+  @param  Format          Format string for the debug message to print.\r
+  @param  BaseListMarker  BASE_LIST marker for the variable argument list.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+DebugBPrint (\r
+  IN  UINTN         ErrorLevel,\r
+  IN  CONST CHAR8   *Format,\r
+  IN  BASE_LIST     BaseListMarker\r
+  )\r
+{\r
+  DebugPrintMarker (ErrorLevel, Format, mVaListNull, BaseListMarker);\r
+}\r
+\r
+\r

 /**\r
 \r
   Prints an assert message containing a filename, line number, and description.\r
 /**\r
 \r
   Prints an assert message containing a filename, line number, and description.\r