OldMdePkg/Library/BaseDebugLibNull/DebugLib.c

   1 /** @file
   2   Base Debug Library that uses PrintLib to print messages to a memory buffer.
   3
   4   Copyright (c) 2006, Intel Corporation
   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
  17   Prints a debug message to the debug output device if the specified error level is enabled.
  18
  19   If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
  20   the message specified by Format and the associated variable argument list to
  21   the debug output device.
  22
  23   If Format is NULL, then ASSERT().
  24
  25   @param  ErrorLevel  The error level of the debug message.
  26   @param  Format      Format string for the debug message to print.
  27
  28 **/
  29 VOID
  30 EFIAPI
  31 DebugPrint (
  32   IN  UINTN        ErrorLevel,
  33   IN  CONST CHAR8  *Format,
  34   ...
  35   )
  36 {
  37 }
  38
  39
  40 /**
  41
  42   Prints an assert message containing a filename, line number, and description.
  43   This may be followed by a breakpoint or a dead loop.
  44
  45   Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
  46   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
  47   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
  48   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
  49   CpuDeadLoop() is called.  If neither of these bits are set, then this function
  50   returns immediately after the message is printed to the debug output device.
  51   DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while
  52   processing another DebugAssert(), then DebugAssert() must return immediately.
  53
  54   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
  55
  56   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
  57
  58   @param  FileName     Pointer to the name of the source file that generated the assert condition.
  59   @param  LineNumber   The line number in the source file that generated the assert condition
  60   @param  Description  Pointer to the description of the assert condition.
  61
  62 **/
  63 VOID
  64 EFIAPI
  65 DebugAssert (
  66   IN CONST CHAR8  *FileName,
  67   IN UINTN        LineNumber,
  68   IN CONST CHAR8  *Description
  69   )
  70 {
  71 }
  72
  73
  74 /**
  75
  76   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
  77
  78   This function fills Length bytes of Buffer with the value specified by
  79   PcdDebugClearMemoryValue, and returns Buffer.
  80
  81   If Buffer is NULL, then ASSERT().
  82
  83   If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
  84
  85   @param   Buffer  Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
  86   @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
  87
  88   @return  Buffer
  89
  90 **/
  91 VOID *
  92 EFIAPI
  93 DebugClearMemory (
  94   OUT VOID  *Buffer,
  95   IN UINTN  Length
  96   )
  97 {
  98   return Buffer;
  99 }
 100
 101
 102 /**
 103
 104   Returns TRUE if ASSERT() macros are enabled.
 105
 106   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
 107   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 108
 109   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
 110   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
 111
 112 **/
 113 BOOLEAN
 114 EFIAPI
 115 DebugAssertEnabled (
 116   VOID
 117   )
 118 {
 119   return FALSE;
 120 }
 121
 122
 123 /**
 124
 125   Returns TRUE if DEBUG()macros are enabled.
 126
 127   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
 128   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 129
 130   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
 131   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
 132
 133 **/
 134 BOOLEAN
 135 EFIAPI
 136 DebugPrintEnabled (
 137   VOID
 138   )
 139 {
 140   return FALSE;
 141 }
 142
 143
 144 /**
 145
 146   Returns TRUE if DEBUG_CODE()macros are enabled.
 147
 148   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
 149   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 150
 151   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
 152   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
 153
 154 **/
 155 BOOLEAN
 156 EFIAPI
 157 DebugCodeEnabled (
 158   VOID
 159   )
 160 {
 161   return FALSE;
 162 }
 163
 164
 165 /**
 166
 167   Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
 168
 169   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
 170   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 171
 172   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
 173   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
 174
 175 **/
 176 BOOLEAN
 177 EFIAPI
 178 DebugClearMemoryEnabled (
 179   VOID
 180   )
 181 {
 182   return FALSE;
 183 }