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