]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Library/BaseDebugLibNull/DebugLib.c
2 Base Debug Library that uses PrintLib to print messages to a memory buffer.
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
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.
16 // The package level header files this module uses
21 // The Library classes this module produced
23 #include <Library/DebugLib.h>
27 Prints a debug message to the debug output device if the specified error level is enabled.
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.
33 If Format is NULL, then ASSERT().
35 @param ErrorLevel The error level of the debug message.
36 @param Format Format string for the debug message to print.
43 IN CONST CHAR8
*Format
,
52 Prints an assert message containing a filename, line number, and description.
53 This may be followed by a breakpoint or a dead loop.
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.
64 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
66 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
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.
76 IN CONST CHAR8
*FileName
,
78 IN CONST CHAR8
*Description
86 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
88 This function fills Length bytes of Buffer with the value specified by
89 PcdDebugClearMemoryValue, and returns Buffer.
91 If Buffer is NULL, then ASSERT().
93 If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
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.
114 Returns TRUE if ASSERT() macros are enabled.
116 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
117 PcdDebugProperyMask is set. Otherwise FALSE is returned.
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.
135 Returns TRUE if DEBUG()macros are enabled.
137 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
138 PcdDebugProperyMask is set. Otherwise FALSE is returned.
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.
156 Returns TRUE if DEBUG_CODE()macros are enabled.
158 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
159 PcdDebugProperyMask is set. Otherwise FALSE is returned.
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.
177 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
179 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
180 PcdDebugProperyMask is set. Otherwise FALSE is returned.
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.
188 DebugClearMemoryEnabled (