]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Library/PeiDxeDebugLibReportStatusCode/DebugLib.c
IntelFrameworkModulePkg/DebugLib: Fix string copy issue
[mirror_edk2.git] / IntelFrameworkModulePkg / Library / PeiDxeDebugLibReportStatusCode / DebugLib.c
index f6ab54ed6a87d86697d7867ff17a40f195cad36f..1840b6d68313399fd2da301cbefdae2059c25863 100644 (file)
@@ -4,18 +4,12 @@
   Note that if the debug message length is larger than the maximum allowable\r
   record length, then the debug message will be ignored directly.\r
 \r
-  Copyright (c) 2006 - 2012, Intel Corporation. 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
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-#include <FrameworkPei.h>\r
+#include <PiPei.h>\r
 \r
 #include <Guid/StatusCodeDataTypeId.h>\r
 #include <Guid/StatusCodeDataTypeDebug.h>\r
 #include <Library/PcdLib.h>\r
 #include <Library/DebugPrintErrorLevelLib.h>\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
   Prints a debug message to the debug output device if the specified 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 the \r
+  If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function\r
+  GetDebugPrintErrorLevel (), then print the message specified by Format and the\r
   associated variable argument list to the debug output device.\r
 \r
   If Format is NULL, then ASSERT().\r
@@ -41,7 +41,7 @@
 \r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
-  @param  ...         Variable argument list whose contents are accessed \r
+  @param  ...         Variable argument list whose contents are accessed\r
                       based on the format string specified by Format.\r
 \r
 **/\r
@@ -52,12 +52,49 @@ DebugPrint (
   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
+  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
+  Only one list type is used.\r
+  If BaseListMarker == NULL, then use VaListMarker.\r
+  Otherwise use BaseListMarker and the VaListMarker should be initilized as\r
+  mVaListNull.\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
   UINT64          Buffer[(EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof (UINT64)) + 1];\r
   EFI_DEBUG_INFO  *DebugInfo;\r
   UINTN           TotalSize;\r
-  VA_LIST         VaListMarker;\r
-  BASE_LIST       BaseListMarker;\r
+  UINTN           DestBufferSize;\r
+  BASE_LIST       BaseListMarkerPointer;\r
   CHAR8           *FormatString;\r
   BOOLEAN         Long;\r
 \r
@@ -75,54 +112,59 @@ DebugPrint (
 \r
   //\r
   // Compute the total size of the record.\r
-  // Note that the passing-in format string and variable parameters will be constructed to \r
+  // Note that the passing-in format string and variable parameters will be constructed to\r
   // the following layout:\r
   //\r
-  //         Buffer->|------------------------|\r
-  //                 |         Padding        | 4 bytes\r
-  //      DebugInfo->|------------------------|\r
-  //                 |      EFI_DEBUG_INFO    | sizeof(EFI_DEBUG_INFO)\r
-  // BaseListMarker->|------------------------|\r
-  //                 |           ...          |\r
-  //                 |   variable arguments   | 12 * sizeof (UINT64)\r
-  //                 |           ...          |\r
-  //                 |------------------------|\r
-  //                 |       Format String    |\r
-  //                 |------------------------|<- (UINT8 *)Buffer + sizeof(Buffer)\r
+  //                Buffer->|------------------------|\r
+  //                        |         Padding        | 4 bytes\r
+  //             DebugInfo->|------------------------|\r
+  //                        |      EFI_DEBUG_INFO    | sizeof(EFI_DEBUG_INFO)\r
+  // BaseListMarkerPointer->|------------------------|\r
+  //                        |           ...          |\r
+  //                        |   variable arguments   | 12 * sizeof (UINT64)\r
+  //                        |           ...          |\r
+  //                        |------------------------|\r
+  //                        |       Format String    |\r
+  //                        |------------------------|<- (UINT8 *)Buffer + sizeof(Buffer)\r
   //\r
   TotalSize = 4 + sizeof (EFI_DEBUG_INFO) + 12 * sizeof (UINT64) + AsciiStrSize (Format);\r
 \r
   //\r
-  // If the TotalSize is larger than the maximum record size, then return\r
+  // If the TotalSize is larger than the maximum record size, then truncate it.\r
   //\r
   if (TotalSize > sizeof (Buffer)) {\r
-    return;\r
+    TotalSize = sizeof (Buffer);\r
   }\r
 \r
   //\r
   // Fill in EFI_DEBUG_INFO\r
   //\r
-  // Here we skip the first 4 bytes of Buffer, because we must ensure BaseListMarker is\r
-  // 64-bit aligned, otherwise retrieving 64-bit parameter from BaseListMarker will cause\r
+  // Here we skip the first 4 bytes of Buffer, because we must ensure BaseListMarkerPointer is\r
+  // 64-bit aligned, otherwise retrieving 64-bit parameter from BaseListMarkerPointer will cause\r
   // exception on IPF. Buffer starts at 64-bit aligned address, so skipping 4 types (sizeof(EFI_DEBUG_INFO))\r
-  // just makes address of BaseListMarker, which follows DebugInfo, 64-bit aligned.\r
+  // just makes address of BaseListMarkerPointer, which follows DebugInfo, 64-bit aligned.\r
   //\r
   DebugInfo             = (EFI_DEBUG_INFO *)(Buffer) + 1;\r
   DebugInfo->ErrorLevel = (UINT32)ErrorLevel;\r
-  BaseListMarker        = (BASE_LIST)(DebugInfo + 1);\r
+  BaseListMarkerPointer = (BASE_LIST)(DebugInfo + 1);\r
   FormatString          = (CHAR8 *)((UINT64 *)(DebugInfo + 1) + 12);\r
 \r
   //\r
-  // Copy the Format string into the record\r
+  // Copy the Format string into the record. It will be truncated if it's too long.\r
   //\r
-  AsciiStrCpy (FormatString, Format);\r
+  // According to the content structure of Buffer shown above, the size of\r
+  // the FormatString buffer is the size of Buffer minus the Padding\r
+  // (4 bytes), minus the size of EFI_DEBUG_INFO, minus the size of\r
+  // variable arguments (12 * sizeof (UINT64)).\r
+  //\r
+  DestBufferSize = sizeof (Buffer) - 4 - sizeof (EFI_DEBUG_INFO) - 12 * sizeof (UINT64);\r
+  AsciiStrnCpyS (FormatString, DestBufferSize / sizeof (CHAR8), Format, DestBufferSize / sizeof (CHAR8) - 1);\r
 \r
   //\r
   // The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments\r
   // of format in DEBUG string, which is followed by the DEBUG format string.\r
   // Here we will process the variable arguments and pack them in this area.\r
   //\r
-  VA_START (VaListMarker, Format);\r
   for (; *Format != '\0'; Format++) {\r
     //\r
     // Only format with prefix % is processed.\r
@@ -159,13 +201,17 @@ DebugPrint (
         // '*' in format field means the precision of the field is specified by\r
         // a UINTN argument in the argument list.\r
         //\r
-        BASE_ARG (BaseListMarker, UINTN) = VA_ARG (VaListMarker, UINTN);\r
+        if (BaseListMarker == NULL) {\r
+          BASE_ARG (BaseListMarkerPointer, UINTN) = VA_ARG (VaListMarker, UINTN);\r
+        } else {\r
+          BASE_ARG (BaseListMarkerPointer, UINTN) = BASE_ARG (BaseListMarker, UINTN);\r
+        }\r
         continue;\r
       }\r
       if (*Format == '\0') {\r
         //\r
         // Make no output if Format string terminates unexpectedly when\r
-        // looking up for flag, width, precision and type. \r
+        // looking up for flag, width, precision and type.\r
         //\r
         Format--;\r
       }\r
@@ -175,43 +221,61 @@ DebugPrint (
       //\r
       break;\r
     }\r
-    \r
+\r
     //\r
     // Pack variable arguments into the storage area following EFI_DEBUG_INFO.\r
     //\r
     if ((*Format == 'p') && (sizeof (VOID *) > 4)) {\r
       Long = TRUE;\r
     }\r
-    if (*Format == 'p' || *Format == 'X' || *Format == 'x' || *Format == 'd') {\r
+    if (*Format == 'p' || *Format == 'X' || *Format == 'x' || *Format == 'd' || *Format == 'u') {\r
       if (Long) {\r
-        BASE_ARG (BaseListMarker, INT64) = VA_ARG (VaListMarker, INT64);\r
+        if (BaseListMarker == NULL) {\r
+          BASE_ARG (BaseListMarkerPointer, INT64) = VA_ARG (VaListMarker, INT64);\r
+        } else {\r
+          BASE_ARG (BaseListMarkerPointer, INT64) = BASE_ARG (BaseListMarker, INT64);\r
+        }\r
       } else {\r
-        BASE_ARG (BaseListMarker, int) = VA_ARG (VaListMarker, int);\r
+        if (BaseListMarker == NULL) {\r
+          BASE_ARG (BaseListMarkerPointer, int) = VA_ARG (VaListMarker, int);\r
+        } else {\r
+          BASE_ARG (BaseListMarkerPointer, int) = BASE_ARG (BaseListMarker, int);\r
+        }\r
       }\r
     } else if (*Format == 's' || *Format == 'S' || *Format == 'a' || *Format == 'g' || *Format == 't') {\r
-      BASE_ARG (BaseListMarker, VOID *) = VA_ARG (VaListMarker, VOID *);\r
+      if (BaseListMarker == NULL) {\r
+        BASE_ARG (BaseListMarkerPointer, VOID *) = VA_ARG (VaListMarker, VOID *);\r
+      } else {\r
+        BASE_ARG (BaseListMarkerPointer, VOID *) = BASE_ARG (BaseListMarker, VOID *);\r
+      }\r
     } else if (*Format == 'c') {\r
-      BASE_ARG (BaseListMarker, UINTN) = VA_ARG (VaListMarker, UINTN);\r
+      if (BaseListMarker == NULL) {\r
+        BASE_ARG (BaseListMarkerPointer, UINTN) = VA_ARG (VaListMarker, UINTN);\r
+      } else {\r
+        BASE_ARG (BaseListMarkerPointer, UINTN) = BASE_ARG (BaseListMarker, UINTN);\r
+      }\r
     } else if (*Format == 'r') {\r
-      BASE_ARG (BaseListMarker, RETURN_STATUS) = VA_ARG (VaListMarker, RETURN_STATUS);\r
+      if (BaseListMarker == NULL) {\r
+        BASE_ARG (BaseListMarkerPointer, RETURN_STATUS) = VA_ARG (VaListMarker, RETURN_STATUS);\r
+      } else {\r
+        BASE_ARG (BaseListMarkerPointer, RETURN_STATUS) = BASE_ARG (BaseListMarker, RETURN_STATUS);\r
+      }\r
     }\r
 \r
     //\r
     // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then ASSERT()\r
-    // This indicates that the DEBUG() macro is passing in more argument than can be handled by \r
+    // This indicates that the DEBUG() macro is passing in more argument than can be handled by\r
     // the EFI_DEBUG_INFO record\r
     //\r
-    ASSERT ((CHAR8 *)BaseListMarker <= FormatString);\r
+    ASSERT ((CHAR8 *)BaseListMarkerPointer <= FormatString);\r
 \r
     //\r
     // If the converted BASE_LIST is larger than the 12 * sizeof (UINT64) allocated bytes, then return\r
     //\r
-    if ((CHAR8 *)BaseListMarker > FormatString) {\r
-      VA_END (VaListMarker);\r
+    if ((CHAR8 *)BaseListMarkerPointer > FormatString) {\r
       return;\r
     }\r
   }\r
-  VA_END (VaListMarker);\r
 \r
   //\r
   // Send the DebugInfo record\r
@@ -228,14 +292,68 @@ DebugPrint (
 }\r
 \r
 /**\r
-  Prints an assert message containing a filename, line number, and description.  \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
+  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
+  Prints an assert message containing a filename, line number, and description.\r
   This may be followed by a breakpoint or a dead loop.\r
 \r
   Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
-  to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
-  PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
-  DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
-  CpuDeadLoop() is called.  If neither of these bits are set, then this function \r
+  to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of\r
+  PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if\r
+  DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then\r
+  CpuDeadLoop() is called.  If neither of these bits are set, then this function\r
   returns immediately after the message is printed to the debug output device.\r
   DebugAssert() must actively prevent recursion.  If DebugAssert() is called while\r
   processing another DebugAssert(), then DebugAssert() must return immediately.\r
@@ -258,45 +376,93 @@ DebugAssert (
 {\r
   UINT64                 Buffer[EFI_STATUS_CODE_DATA_MAX_SIZE / sizeof(UINT64)];\r
   EFI_DEBUG_ASSERT_DATA  *AssertData;\r
+  UINTN                  HeaderSize;\r
   UINTN                  TotalSize;\r
   CHAR8                  *Temp;\r
+  UINTN                  ModuleNameSize;\r
   UINTN                  FileNameSize;\r
   UINTN                  DescriptionSize;\r
 \r
   //\r
-  // Make sure it will all fit in the passed in buffer\r
+  // Get string size\r
   //\r
-  FileNameSize    = AsciiStrSize (FileName);\r
-  DescriptionSize = AsciiStrSize (Description);\r
-  TotalSize = sizeof (EFI_DEBUG_ASSERT_DATA) + FileNameSize + DescriptionSize;\r
-  if (TotalSize <= sizeof (Buffer)) {\r
-    //\r
-    // Fill in EFI_DEBUG_ASSERT_DATA\r
-    //\r
-    AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;\r
-    AssertData->LineNumber = (UINT32)LineNumber;\r
+  HeaderSize       = sizeof (EFI_DEBUG_ASSERT_DATA);\r
+  //\r
+  // Compute string size of module name enclosed by []\r
+  //\r
+  ModuleNameSize   = 2 + AsciiStrSize (gEfiCallerBaseName);\r
+  FileNameSize     = AsciiStrSize (FileName);\r
+  DescriptionSize  = AsciiStrSize (Description);\r
 \r
+  //\r
+  // Make sure it will all fit in the passed in buffer.\r
+  //\r
+  if (HeaderSize + ModuleNameSize + FileNameSize + DescriptionSize > sizeof (Buffer)) {\r
     //\r
-    // Copy Ascii FileName including NULL.\r
+    // remove module name if it's too long to be filled into buffer\r
     //\r
-    Temp = AsciiStrCpy ((CHAR8 *)(AssertData + 1), FileName);\r
+    ModuleNameSize = 0;\r
+    if (HeaderSize + FileNameSize + DescriptionSize > sizeof (Buffer)) {\r
+      //\r
+      // FileName + Description is too long to be filled into buffer.\r
+      //\r
+      if (HeaderSize + FileNameSize < sizeof (Buffer)) {\r
+        //\r
+        // Description has enough buffer to be truncated.\r
+        //\r
+        DescriptionSize = sizeof (Buffer) - HeaderSize - FileNameSize;\r
+      } else {\r
+        //\r
+        // FileName is too long to be filled into buffer.\r
+        // FileName will be truncated. Reserved one byte for Description NULL terminator.\r
+        //\r
+        DescriptionSize = 1;\r
+        FileNameSize    = sizeof (Buffer) - HeaderSize - DescriptionSize;\r
+      }\r
+    }\r
+  }\r
+  //\r
+  // Fill in EFI_DEBUG_ASSERT_DATA\r
+  //\r
+  AssertData = (EFI_DEBUG_ASSERT_DATA *)Buffer;\r
+  AssertData->LineNumber = (UINT32)LineNumber;\r
+  TotalSize  = sizeof (EFI_DEBUG_ASSERT_DATA);\r
 \r
-    //\r
-    // Copy Ascii Description\r
-    //\r
-    AsciiStrCpy (Temp + FileNameSize, Description);\r
-\r
-    REPORT_STATUS_CODE_EX (\r
-      (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),\r
-      (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),\r
-      0,\r
-      NULL,\r
-      NULL,\r
-      AssertData,\r
-      TotalSize\r
-      );\r
+  Temp = (CHAR8 *)(AssertData + 1);\r
+\r
+  //\r
+  // Copy Ascii [ModuleName].\r
+  //\r
+  if (ModuleNameSize != 0) {\r
+    CopyMem(Temp, "[", 1);\r
+    CopyMem(Temp + 1, gEfiCallerBaseName, ModuleNameSize - 3);\r
+    CopyMem(Temp + ModuleNameSize - 2, "] ", 2);\r
   }\r
 \r
+  //\r
+  // Copy Ascii FileName including NULL terminator.\r
+  //\r
+  Temp = CopyMem (Temp + ModuleNameSize, FileName, FileNameSize);\r
+  Temp[FileNameSize - 1] = 0;\r
+  TotalSize += (ModuleNameSize + FileNameSize);\r
+\r
+  //\r
+  // Copy Ascii Description include NULL terminator.\r
+  //\r
+  Temp = CopyMem (Temp + FileNameSize, Description, DescriptionSize);\r
+  Temp[DescriptionSize - 1] = 0;\r
+  TotalSize += DescriptionSize;\r
+\r
+  REPORT_STATUS_CODE_EX (\r
+    (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED),\r
+    (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ILLEGAL_SOFTWARE_STATE),\r
+    0,\r
+    NULL,\r
+    NULL,\r
+    AssertData,\r
+    TotalSize\r
+    );\r
+\r
   //\r
   // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
   //\r
@@ -311,14 +477,14 @@ DebugAssert (
 /**\r
   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
 \r
-  This function fills Length bytes of Buffer with the value specified by \r
+  This function fills Length bytes of Buffer with the value specified by\r
   PcdDebugClearMemoryValue, and returns Buffer.\r
 \r
   If Buffer is NULL, then ASSERT().\r
-  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
+  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
   @param   Buffer  Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
-  @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
+  @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.\r
 \r
   @return  Buffer  Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
 \r
@@ -339,7 +505,7 @@ DebugClearMemory (
 /**\r
   Returns TRUE if ASSERT() macros are enabled.\r
 \r
-  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
+  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of\r
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
@@ -356,10 +522,10 @@ DebugAssertEnabled (
 }\r
 \r
 \r
-/**  \r
+/**\r
   Returns TRUE if DEBUG() macros are enabled.\r
 \r
-  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
+  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of\r
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
@@ -376,10 +542,10 @@ DebugPrintEnabled (
 }\r
 \r
 \r
-/**  \r
+/**\r
   Returns TRUE if DEBUG_CODE() macros are enabled.\r
 \r
-  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
+  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of\r
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
@@ -396,10 +562,10 @@ DebugCodeEnabled (
 }\r
 \r
 \r
-/**  \r
+/**\r
   Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
 \r
-  This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
+  This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of\r
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
@@ -414,3 +580,21 @@ DebugClearMemoryEnabled (
 {\r
   return (BOOLEAN) ((PcdGet8 (PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
 }\r
+\r
+/**\r
+  Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
+\r
+  This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
+\r
+  @retval  TRUE    Current ErrorLevel is supported.\r
+  @retval  FALSE   Current ErrorLevel is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DebugPrintLevelEnabled (\r
+  IN  CONST UINTN        ErrorLevel\r
+  )\r
+{\r
+  return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);\r
+}\r