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