OvmfPkg/Library/PlatformDebugLibIoPort/DebugLib.c

   1 /** @file
   2   Base Debug library instance for QEMU debug port.
   3   It uses PrintLib to send debug messages to a fixed I/O port.
   4
   5   Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
   6   Copyright (c) 2012, Red Hat, Inc.<BR>
   7   This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php.
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #include <Base.h>
  18 #include <Uefi.h>
  19 #include <Library/DebugLib.h>
  20 #include <Library/BaseLib.h>
  21 #include <Library/IoLib.h>
  22 #include <Library/PrintLib.h>
  23 #include <Library/PcdLib.h>
  24 #include <Library/BaseMemoryLib.h>
  25 #include <Library/DebugPrintErrorLevelLib.h>
  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   This constructor function does not have to do anything.
  34
  35   @retval EFI_SUCCESS   The constructor always returns RETURN_SUCCESS.
  36
  37 **/
  38 RETURN_STATUS
  39 EFIAPI
  40 PlatformDebugLibIoPortConstructor (
  41   VOID
  42   )
  43 {
  44   return EFI_SUCCESS;
  45 }
  46
  47 /**
  48   Prints a debug message to the debug output device if the specified error level is enabled.
  49
  50   If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
  51   GetDebugPrintErrorLevel (), then print the message specified by Format and the
  52   associated variable argument list to the debug output device.
  53
  54   If Format is NULL, then ASSERT().
  55
  56   @param  ErrorLevel  The error level of the debug message.
  57   @param  Format      Format string for the debug message to print.
  58   @param  ...         Variable argument list whose contents are accessed
  59                       based on the format string specified by Format.
  60
  61 **/
  62 VOID
  63 EFIAPI
  64 DebugPrint (
  65   IN  UINTN        ErrorLevel,
  66   IN  CONST CHAR8  *Format,
  67   ...
  68   )
  69 {
  70   CHAR8    Buffer[MAX_DEBUG_MESSAGE_LENGTH];
  71   VA_LIST  Marker;
  72   UINT8    *Ptr;
  73
  74   //
  75   // If Format is NULL, then ASSERT().
  76   //
  77   ASSERT (Format != NULL);
  78
  79   //
  80   // Check driver debug mask value and global mask
  81   //
  82   if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {
  83     return;
  84   }
  85
  86   //
  87   // Convert the DEBUG() message to an ASCII String
  88   //
  89   VA_START (Marker, Format);
  90   AsciiVSPrint (Buffer, sizeof (Buffer), Format, Marker);
  91   VA_END (Marker);
  92
  93   //
  94   // Send the print string to the debug I/O port
  95   //
  96   for (Ptr = (UINT8 *) Buffer; *Ptr; Ptr++) {
  97     IoWrite8 (PcdGet16(PcdDebugIoPort), *Ptr);
  98   }
  99 }
 100
 101
 102 /**
 103   Prints an assert message containing a filename, line number, and description.
 104   This may be followed by a breakpoint or a dead loop.
 105
 106   Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
 107   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
 108   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
 109   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
 110   CpuDeadLoop() is called.  If neither of these bits are set, then this function
 111   returns immediately after the message is printed to the debug output device.
 112   DebugAssert() must actively prevent recursion.  If DebugAssert() is called while
 113   processing another DebugAssert(), then DebugAssert() must return immediately.
 114
 115   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
 116   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
 117
 118   @param  FileName     The pointer to the name of the source file that generated the assert condition.
 119   @param  LineNumber   The line number in the source file that generated the assert condition
 120   @param  Description  The pointer to the description of the assert condition.
 121
 122 **/
 123 VOID
 124 EFIAPI
 125 DebugAssert (
 126   IN CONST CHAR8  *FileName,
 127   IN UINTN        LineNumber,
 128   IN CONST CHAR8  *Description
 129   )
 130 {
 131   CHAR8  Buffer[MAX_DEBUG_MESSAGE_LENGTH];
 132   UINT8 *Ptr;
 133
 134   //
 135   // Generate the ASSERT() message in Ascii format
 136   //
 137   AsciiSPrint (Buffer, sizeof (Buffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);
 138
 139   //
 140   // Send the print string to the Console Output device
 141   //
 142   for (Ptr = (UINT8 *) Buffer; *Ptr; Ptr++) {
 143     IoWrite8 (PcdGet16(PcdDebugIoPort), *Ptr);
 144   }
 145
 146   //
 147   // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
 148   //
 149   if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {
 150     CpuBreakpoint ();
 151   } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {
 152     CpuDeadLoop ();
 153   }
 154 }
 155
 156
 157 /**
 158   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
 159
 160   This function fills Length bytes of Buffer with the value specified by
 161   PcdDebugClearMemoryValue, and returns Buffer.
 162
 163   If Buffer is NULL, then ASSERT().
 164   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
 165
 166   @param   Buffer  The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
 167   @param   Length  The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
 168
 169   @return  Buffer  The pointer to the target buffer filled with PcdDebugClearMemoryValue.
 170
 171 **/
 172 VOID *
 173 EFIAPI
 174 DebugClearMemory (
 175   OUT VOID  *Buffer,
 176   IN UINTN  Length
 177   )
 178 {
 179   //
 180   // If Buffer is NULL, then ASSERT().
 181   //
 182   ASSERT (Buffer != NULL);
 183
 184   //
 185   // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
 186   //
 187   return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
 188 }
 189
 190
 191 /**
 192   Returns TRUE if ASSERT() macros are enabled.
 193
 194   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
 195   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 196
 197   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
 198   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
 199
 200 **/
 201 BOOLEAN
 202 EFIAPI
 203 DebugAssertEnabled (
 204   VOID
 205   )
 206 {
 207   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
 208 }
 209
 210
 211 /**
 212   Returns TRUE if DEBUG() macros are enabled.
 213
 214   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
 215   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 216
 217   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
 218   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
 219
 220 **/
 221 BOOLEAN
 222 EFIAPI
 223 DebugPrintEnabled (
 224   VOID
 225   )
 226 {
 227   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
 228 }
 229
 230
 231 /**
 232   Returns TRUE if DEBUG_CODE() macros are enabled.
 233
 234   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
 235   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 236
 237   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
 238   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
 239
 240 **/
 241 BOOLEAN
 242 EFIAPI
 243 DebugCodeEnabled (
 244   VOID
 245   )
 246 {
 247   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
 248 }
 249
 250
 251 /**
 252   Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
 253
 254   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
 255   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 256
 257   @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
 258   @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
 259
 260 **/
 261 BOOLEAN
 262 EFIAPI
 263 DebugClearMemoryEnabled (
 264   VOID
 265   )
 266 {
 267   return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
 268 }
 269
 270 /**
 271   Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
 272
 273   This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
 274
 275   @retval  TRUE    Current ErrorLevel is supported.
 276   @retval  FALSE   Current ErrorLevel is not supported.
 277
 278 **/
 279 BOOLEAN
 280 EFIAPI
 281 DebugPrintLevelEnabled (
 282   IN  CONST UINTN        ErrorLevel
 283   )
 284 {
 285   return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);
 286 }