MdePkg/Library/BaseDebugLibNull/DebugLib.c

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