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