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