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  ...         The variable argument list.
  29
  30 **/
  31 VOID
  32 EFIAPI
  33 DebugPrint (
  34   IN  UINTN        ErrorLevel,
  35   IN  CONST CHAR8  *Format,
  36   ...
  37   )
  38 {
  39 }
  40
  41
  42 /**
  43   Prints an assert message containing a filename, line number, and description.
  44   This may be followed by a breakpoint or a dead loop.
  45
  46   Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
  47   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
  48   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
  49   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
  50   CpuDeadLoop() is called.  If neither of these bits are set, then this function
  51   returns immediately after the message is printed to the debug output device.
  52   DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while
  53   processing another DebugAssert(), then DebugAssert() must return immediately.
  54
  55   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
  56
  57   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
  58
  59   @param  FileName     Pointer to the name of the source file that generated the assert condition.
  60   @param  LineNumber   The line number in the source file that generated the assert condition
  61   @param  Description  Pointer to the description of the assert condition.
  62
  63 **/
  64 VOID
  65 EFIAPI
  66 DebugAssert (
  67   IN CONST CHAR8  *FileName,
  68   IN UINTN        LineNumber,
  69   IN CONST CHAR8  *Description
  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 filled with PcdDebugClearMemoryValue.
  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   Returns TRUE if ASSERT() macros are enabled.
 104
 105   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
 106   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 107
 108   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
 109   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
 110
 111   @return  Always return FALSE.
 112
 113 **/
 114 BOOLEAN
 115 EFIAPI
 116 DebugAssertEnabled (
 117   VOID
 118   )
 119 {
 120   return FALSE;
 121 }
 122
 123
 124 /**
 125   Returns TRUE if the DEBUG() macro is 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   @return Always return FALSE.
 134
 135 **/
 136 BOOLEAN
 137 EFIAPI
 138 DebugPrintEnabled (
 139   VOID
 140   )
 141 {
 142   return FALSE;
 143 }
 144
 145
 146 /**
 147   Returns TRUE if the DEBUG_CODE() macros are enabled.
 148
 149   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
 150   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 151
 152   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
 153   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
 154
 155   @return  Always return FALSE.
 156
 157 **/
 158 BOOLEAN
 159 EFIAPI
 160 DebugCodeEnabled (
 161   VOID
 162   )
 163 {
 164   return FALSE;
 165 }
 166
 167
 168 /**
 169   Returns TRUE if the DEBUG_CLEAR_MEMORY() macro is enabled.
 170
 171   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
 172   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
 173
 174   @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
 175   @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
 176
 177   @return  Always return FALSE.
 178
 179 **/
 180 BOOLEAN
 181 EFIAPI
 182 DebugClearMemoryEnabled (
 183   VOID
 184   )
 185 {
 186   return FALSE;
 187 }