MdePkg/Library/UefiDebugLibConOut/DebugLib.c

   1 /** @file
   2   UEFI Debug Library that uses PrintLib to send messages to CONOUT.
   3
   4   Copyright (c) 2006 - 2007, 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
  46 **/
  47 VOID
  48 EFIAPI
  49 DebugPrint (
  50   IN  UINTN        ErrorLevel,
  51   IN  CONST CHAR8  *Format,
  52   ...
  53   )
  54 {
  55   CHAR16   Buffer[MAX_DEBUG_MESSAGE_LENGTH];
  56   VA_LIST  Marker;
  57
  58   //
  59   // If Format is NULL, then ASSERT().
  60   //
  61   ASSERT (Format != NULL);
  62
  63   //
  64   // Check driver debug mask value and global mask
  65   //
  66   if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {
  67     return;
  68   }
  69
  70   //
  71   // Convert the DEBUG() message to a Unicode String
  72   //
  73   VA_START (Marker, Format);
  74   UnicodeVSPrintAsciiFormat (Buffer, sizeof (Buffer), Format, Marker);
  75   VA_END (Marker);
  76
  77   //
  78   // Send the print string to the Console Output device
  79   //
  80   if ((gST != NULL) && (gST->ConOut != NULL)) {
  81     gST->ConOut->OutputString (gST->ConOut, Buffer);
  82   }
  83 }
  84
  85
  86 /**
  87
  88   Prints an assert message containing a filename, line number, and description.
  89   This may be followed by a breakpoint or a dead loop.
  90
  91   Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
  92   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
  93   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
  94   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
  95   CpuDeadLoop() is called.  If neither of these bits are set, then this function
  96   returns immediately after the message is printed to the debug output device.
  97   DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while
  98   processing another DebugAssert(), then DebugAssert() must return immediately.
  99
 100   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
 101
 102   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
 103
 104   @param  FileName     Pointer to the name of the source file that generated the assert condition.
 105   @param  LineNumber   The line number in the source file that generated the assert condition
 106   @param  Description  Pointer to the description of the assert condition.
 107
 108 **/
 109 VOID
 110 EFIAPI
 111 DebugAssert (
 112   IN CONST CHAR8  *FileName,
 113   IN UINTN        LineNumber,
 114   IN CONST CHAR8  *Description
 115   )
 116 {
 117   CHAR16  Buffer[MAX_DEBUG_MESSAGE_LENGTH];
 118
 119   //
 120   // Generate the ASSERT() message in Unicode format
 121   //
 122   UnicodeSPrintAsciiFormat (Buffer, sizeof (Buffer), "ASSERT %s(%d): %s\n", FileName, LineNumber, Description);
 123
 124   //
 125   // Send the print string to the Console Output device
 126   //
 127   if ((gST != NULL) && (gST->ConOut != NULL)) {
 128     gST->ConOut->OutputString (gST->ConOut, Buffer);
 129   }
 130
 131   //
 132   // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
 133   //
 134   if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
 135     CpuBreakpoint ();
 136   } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
 137     CpuDeadLoop ();
 138   }
 139 }
 140
 141
 142 /**
 143
 144   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
 145
 146   This function fills Length bytes of Buffer with the value specified by
 147   PcdDebugClearMemoryValue, and returns Buffer.
 148
 149   If Buffer is NULL, then ASSERT().
 150
 151   If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
 152
 153   @param   Buffer  Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
 154   @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
 155
 156   @return  Buffer
 157
 158 **/
 159 VOID *
 160 EFIAPI
 161 DebugClearMemory (
 162   OUT VOID  *Buffer,
 163   IN UINTN  Length
 164   )
 165 {
 166   //
 167   // If Buffer is NULL, then ASSERT().
 168   //
 169   ASSERT (Buffer != NULL);
 170
 171   //
 172   // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
 173   //
 174   return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
 175 }
 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
 201   Returns TRUE if DEBUG()macros are enabled.
 202
 203   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
 204   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 205
 206   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
 207   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
 208
 209 **/
 210 BOOLEAN
 211 EFIAPI
 212 DebugPrintEnabled (
 213   VOID
 214   )
 215 {
 216   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
 217 }
 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
 243   Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
 244
 245   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
 246   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 247
 248   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
 249   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
 250
 251 **/
 252 BOOLEAN
 253 EFIAPI
 254 DebugClearMemoryEnabled (
 255   VOID
 256   )
 257 {
 258   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
 259 }