MdePkg/Library/BaseDebugLibSerialPort/DebugLib.c

   1 /** @file
   2   Base Debug library instance base on Serial Port library.
   3   It uses PrintLib to send debug messages to serial port device.
   4
   5   Copyright (c) 2006 - 2008, Intel Corporation<BR>
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #include <Base.h>
  17 #include <Library/DebugLib.h>
  18 #include <Library/BaseLib.h>
  19 #include <Library/PrintLib.h>
  20 #include <Library/PcdLib.h>
  21 #include <Library/BaseMemoryLib.h>
  22 #include <Library/SerialPortLib.h>
  23
  24
  25 //
  26 // Define the maximum debug and assert message length that this library supports
  27 //
  28 #define MAX_DEBUG_MESSAGE_LENGTH  0x100
  29
  30
  31 /**
  32   Prints a debug message to the debug output device if the specified error level is enabled.
  33
  34   If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
  35   the message specified by Format and the associated variable argument list to
  36   the debug output device.
  37
  38   If Format is NULL, then ASSERT().
  39
  40   @param  ErrorLevel  The error level of the debug message.
  41   @param  Format      Format string for the debug message to print.
  42   @param  ...         Variable argument list whose contents are accessed
  43                       based on the format string specified by Format.
  44
  45 **/
  46 VOID
  47 EFIAPI
  48 DebugPrint (
  49   IN  UINTN        ErrorLevel,
  50   IN  CONST CHAR8  *Format,
  51   ...
  52   )
  53 {
  54   CHAR8    Buffer[MAX_DEBUG_MESSAGE_LENGTH];
  55   VA_LIST  Marker;
  56
  57   //
  58   // If Format is NULL, then ASSERT().
  59   //
  60   ASSERT (Format != NULL);
  61
  62   //
  63   // Check driver debug mask value and global mask
  64   //
  65   if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {
  66     return;
  67   }
  68
  69   //
  70   // Convert the DEBUG() message to an ASCII String
  71   //
  72   VA_START (Marker, Format);
  73   AsciiVSPrint (Buffer, sizeof (Buffer), Format, Marker);
  74   VA_END (Marker);
  75
  76   //
  77   // Send the print string to a Serial Port
  78   //
  79   SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));
  80 }
  81
  82
  83 /**
  84   Prints an assert message containing a filename, line number, and description.
  85   This may be followed by a breakpoint or a dead loop.
  86
  87   Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
  88   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
  89   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
  90   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
  91   CpuDeadLoop() is called.  If neither of these bits are set, then this function
  92   returns immediately after the message is printed to the debug output device.
  93   DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while
  94   processing another DebugAssert(), then DebugAssert() must return immediately.
  95
  96   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
  97
  98   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
  99
 100   @param  FileName     Pointer to the name of the source file that generated the assert condition.
 101   @param  LineNumber   The line number in the source file that generated the assert condition
 102   @param  Description  Pointer to the description of the assert condition.
 103
 104 **/
 105 VOID
 106 EFIAPI
 107 DebugAssert (
 108   IN CONST CHAR8  *FileName,
 109   IN UINTN        LineNumber,
 110   IN CONST CHAR8  *Description
 111   )
 112 {
 113   CHAR8  Buffer[MAX_DEBUG_MESSAGE_LENGTH];
 114
 115   //
 116   // Generate the ASSERT() message in Ascii format
 117   //
 118   AsciiSPrint (Buffer, sizeof (Buffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);
 119
 120   //
 121   // Send the print string to the Console Output device
 122   //
 123   SerialPortWrite ((UINT8 *) Buffer, AsciiStrLen(Buffer));
 124
 125   //
 126   // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
 127   //
 128   if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
 129     CpuBreakpoint ();
 130   } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
 131     CpuDeadLoop ();
 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 be filled with PcdDebugClearMemoryValue.
 147   @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
 148
 149   @return  Buffer filled with PcdDebugClearMemoryValue.
 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   Returns TRUE if ASSERT() macros are enabled.
 173
 174   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
 175   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 176
 177   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
 178   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
 179
 180 **/
 181 BOOLEAN
 182 EFIAPI
 183 DebugAssertEnabled (
 184   VOID
 185   )
 186 {
 187   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
 188 }
 189
 190
 191 /**
 192   Returns TRUE if the DEBUG() macro is enabled.
 193
 194   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
 195   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 196
 197   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
 198   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
 199
 200 **/
 201 BOOLEAN
 202 EFIAPI
 203 DebugPrintEnabled (
 204   VOID
 205   )
 206 {
 207   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
 208 }
 209
 210
 211 /**
 212   Returns TRUE if the DEBUG_CODE() macros are enabled.
 213
 214   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
 215   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 216
 217   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
 218   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
 219
 220 **/
 221 BOOLEAN
 222 EFIAPI
 223 DebugCodeEnabled (
 224   VOID
 225   )
 226 {
 227   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
 228 }
 229
 230
 231 /**
 232   Returns TRUE if the DEBUG_CLEAR_MEMORY() macro is enabled.
 233
 234   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
 235   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 236
 237   @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
 238   @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
 239
 240 **/
 241 BOOLEAN
 242 EFIAPI
 243 DebugClearMemoryEnabled (
 244   VOID
 245   )
 246 {
 247   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
 248 }