EdkModulePkg/Library/DxeDebugLibSerialPort/DebugLib.c

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