MdePkg/Library/UefiDebugLibConOut/DebugLib.c

   1 /** @file
   2   UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php.
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include <Uefi.h>
  16
  17 #include <Library/DebugLib.h>
  18 #include <Library/UefiBootServicesTableLib.h>
  19 #include <Library/PrintLib.h>
  20 #include <Library/PcdLib.h>
  21 #include <Library/BaseLib.h>
  22 #include <Library/BaseMemoryLib.h>
  23
  24 //
  25 // Define the maximum debug and assert message length that this library supports
  26 //
  27 #define MAX_DEBUG_MESSAGE_LENGTH  0x100
  28
  29 /**
  30   Prints a debug message to the debug output device if the specified error level is enabled.
  31
  32   If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
  33   the message specified by Format and the associated variable argument list to
  34   the debug output device.
  35
  36   If Format is NULL, then ASSERT().
  37
  38   @param  ErrorLevel  The error level of the debug message.
  39   @param  Format      Format string for the debug message to print.
  40   @param  ...         Variable argument list whose contents are accessed
  41                       based on the format string specified by Format.
  42
  43 **/
  44 VOID
  45 EFIAPI
  46 DebugPrint (
  47   IN  UINTN        ErrorLevel,
  48   IN  CONST CHAR8  *Format,
  49   ...
  50   )
  51 {
  52   CHAR16   Buffer[MAX_DEBUG_MESSAGE_LENGTH];
  53   VA_LIST  Marker;
  54
  55   //
  56   // If Format is NULL, then ASSERT().
  57   //
  58   ASSERT (Format != NULL);
  59
  60   //
  61   // Check driver debug mask value and global mask
  62   //
  63   if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {
  64     return;
  65   }
  66
  67   //
  68   // Convert the DEBUG() message to a Unicode String
  69   //
  70   VA_START (Marker, Format);
  71   UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH,  Format, Marker);
  72   VA_END (Marker);
  73
  74
  75   //
  76   // Send the print string to the Console Output device
  77   //
  78   if ((gST != NULL) && (gST->ConOut != NULL)) {
  79     gST->ConOut->OutputString (gST->ConOut, Buffer);
  80   }
  81 }
  82
  83
  84 /**
  85   Prints an assert message containing a filename, line number, and description.
  86   This may be followed by a breakpoint or a dead loop.
  87
  88   Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
  89   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
  90   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
  91   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
  92   CpuDeadLoop() is called.  If neither of these bits are set, then this function
  93   returns immediately after the message is printed to the debug output device.
  94   DebugAssert() must actively prevent recursion.  If DebugAssert() is called while
  95   processing another DebugAssert(), then DebugAssert() must return immediately.
  96
  97   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
  98   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
  99
 100   @param  FileName     The pointer to the name of the source file that generated the assert condition.
 101   @param  LineNumber   The line number in the source file that generated the assert condition
 102   @param  Description  The pointer to the description of the assert condition.
 103
 104 **/
 105 VOID
 106 EFIAPI
 107 DebugAssert (
 108   IN CONST CHAR8  *FileName,
 109   IN UINTN        LineNumber,
 110   IN CONST CHAR8  *Description
 111   )
 112 {
 113   CHAR16  Buffer[MAX_DEBUG_MESSAGE_LENGTH];
 114
 115   //
 116   // Generate the ASSERT() message in Unicode format
 117   //
 118   UnicodeSPrintAsciiFormat (
 119     Buffer,
 120     MAX_DEBUG_MESSAGE_LENGTH,
 121     "ASSERT %a(%d): %a\n",
 122     FileName,
 123     LineNumber,
 124     Description
 125     );
 126
 127   //
 128   // Send the print string to the Console Output device
 129   //
 130   if ((gST != NULL) && (gST->ConOut != NULL)) {
 131     gST->ConOut->OutputString (gST->ConOut, Buffer);
 132   }
 133
 134   //
 135   // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
 136   //
 137   if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
 138     CpuBreakpoint ();
 139   } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
 140     CpuDeadLoop ();
 141   }
 142 }
 143
 144
 145 /**
 146   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
 147
 148   This function fills Length bytes of Buffer with the value specified by
 149   PcdDebugClearMemoryValue, and returns Buffer.
 150
 151   If Buffer is NULL, then ASSERT().
 152   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
 153
 154   @param   Buffer  The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
 155   @param   Length  The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
 156
 157   @return  Buffer  The pointer to the target buffer filled with PcdDebugClearMemoryValue.
 158
 159 **/
 160 VOID *
 161 EFIAPI
 162 DebugClearMemory (
 163   OUT VOID  *Buffer,
 164   IN UINTN  Length
 165   )
 166 {
 167   //
 168   // If Buffer is NULL, then ASSERT().
 169   //
 170   ASSERT (Buffer != NULL);
 171
 172   //
 173   // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
 174   //
 175   return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
 176 }
 177
 178
 179 /**
 180   Returns TRUE if ASSERT() macros are enabled.
 181
 182   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
 183   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 184
 185   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
 186   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
 187
 188 **/
 189 BOOLEAN
 190 EFIAPI
 191 DebugAssertEnabled (
 192   VOID
 193   )
 194 {
 195   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
 196 }
 197
 198
 199 /**
 200   Returns TRUE if DEBUG() macros are enabled.
 201
 202   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
 203   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 204
 205   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
 206   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
 207
 208 **/
 209 BOOLEAN
 210 EFIAPI
 211 DebugPrintEnabled (
 212   VOID
 213   )
 214 {
 215   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
 216 }
 217
 218
 219 /**
 220   Returns TRUE if DEBUG_CODE() macros are enabled.
 221
 222   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
 223   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 224
 225   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
 226   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
 227
 228 **/
 229 BOOLEAN
 230 EFIAPI
 231 DebugCodeEnabled (
 232   VOID
 233   )
 234 {
 235   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
 236 }
 237
 238
 239 /**
 240   Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
 241
 242   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
 243   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 244
 245   @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
 246   @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
 247
 248 **/
 249 BOOLEAN
 250 EFIAPI
 251 DebugClearMemoryEnabled (
 252   VOID
 253   )
 254 {
 255   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
 256 }