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