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  ...         A 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
 101                        the assert condition.
 102   @param  LineNumber   The line number in the source file that generated the
 103                        assert condition
 104   @param  Description  The pointer to the description of the assert condition.
 105
 106 **/
 107 VOID
 108 EFIAPI
 109 DebugAssert (
 110   IN CONST CHAR8  *FileName,
 111   IN UINTN        LineNumber,
 112   IN CONST CHAR8  *Description
 113   )
 114 {
 115   CHAR16  Buffer[MAX_DEBUG_MESSAGE_LENGTH];
 116
 117   //
 118   // Generate the ASSERT() message in Unicode format
 119   //
 120   UnicodeSPrintAsciiFormat (
 121     Buffer,
 122     MAX_DEBUG_MESSAGE_LENGTH,
 123     "ASSERT %a(%d): %a\n",
 124     FileName,
 125     LineNumber,
 126     Description
 127     );
 128
 129   //
 130   // Send the print string to the Console Output device
 131   //
 132   if ((gST != NULL) && (gST->ConOut != NULL)) {
 133     gST->ConOut->OutputString (gST->ConOut, Buffer);
 134   }
 135
 136   //
 137   // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
 138   //
 139   if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
 140     CpuBreakpoint ();
 141   } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
 142     CpuDeadLoop ();
 143   }
 144 }
 145
 146
 147 /**
 148   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
 149
 150   This function fills Length bytes of Buffer with the value specified by
 151   PcdDebugClearMemoryValue, and returns Buffer.
 152
 153   If Buffer is NULL, then ASSERT().
 154   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
 155
 156   @param   Buffer  The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
 157   @param   Length  The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
 158
 159   @return  Buffer  The pointer to the target buffer filled with PcdDebugClearMemoryValue.
 160
 161 **/
 162 VOID *
 163 EFIAPI
 164 DebugClearMemory (
 165   OUT VOID  *Buffer,
 166   IN UINTN  Length
 167   )
 168 {
 169   //
 170   // If Buffer is NULL, then ASSERT().
 171   //
 172   ASSERT (Buffer != NULL);
 173
 174   //
 175   // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
 176   //
 177   return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
 178 }
 179
 180
 181 /**
 182   Returns TRUE if ASSERT() macros are enabled.
 183
 184   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
 185   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 186
 187   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
 188   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
 189
 190 **/
 191 BOOLEAN
 192 EFIAPI
 193 DebugAssertEnabled (
 194   VOID
 195   )
 196 {
 197   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
 198 }
 199
 200
 201 /**
 202   Returns TRUE if DEBUG() macros are enabled.
 203
 204   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
 205   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 206
 207   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
 208   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
 209
 210 **/
 211 BOOLEAN
 212 EFIAPI
 213 DebugPrintEnabled (
 214   VOID
 215   )
 216 {
 217   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
 218 }
 219
 220
 221 /**
 222   Returns TRUE if DEBUG_CODE() macros are enabled.
 223
 224   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
 225   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 226
 227   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
 228   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
 229
 230 **/
 231 BOOLEAN
 232 EFIAPI
 233 DebugCodeEnabled (
 234   VOID
 235   )
 236 {
 237   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
 238 }
 239
 240
 241 /**
 242   Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
 243
 244   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
 245   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 246
 247   @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
 248   @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
 249
 250 **/
 251 BOOLEAN
 252 EFIAPI
 253 DebugClearMemoryEnabled (
 254   VOID
 255   )
 256 {
 257   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
 258 }