2 UEFI Debug Library that uses PrintLib to send messages to STDERR.
4 Copyright (c) 2006 - 2007, Intel Corporation<BR>
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
20 // The protocols, PPI and GUID defintions for this module
23 // The Library classes this module consumes
25 #include <Library/DebugLib.h>
26 #include <Library/UefiBootServicesTableLib.h>
27 #include <Library/PrintLib.h>
28 #include <Library/PcdLib.h>
29 #include <Library/BaseLib.h>
30 #include <Library/BaseMemoryLib.h>
33 // Define the maximum debug and assert message length that this library supports
35 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
40 Prints a debug message to the debug output device if the specified error level is enabled.
42 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
43 the message specified by Format and the associated variable argument list to
44 the debug output device.
46 If Format is NULL, then ASSERT().
48 @param ErrorLevel The error level of the debug message.
49 @param Format Format string for the debug message to print.
56 IN CONST CHAR8
*Format
,
60 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
64 // If Format is NULL, then ASSERT().
66 ASSERT (Format
!= NULL
);
69 // Check driver debug mask value and global mask
71 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
76 // Convert the DEBUG() message to a Unicode String
78 VA_START (Marker
, Format
);
79 UnicodeVSPrintAsciiFormat (Buffer
, sizeof (Buffer
), Format
, Marker
);
83 // Send the print string to the Standard Error device
85 if ((gST
!= NULL
) && (gST
->StdErr
!= NULL
)) {
86 gST
->StdErr
->OutputString (gST
->StdErr
, Buffer
);
93 Prints an assert message containing a filename, line number, and description.
94 This may be followed by a breakpoint or a dead loop.
96 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
97 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
98 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
99 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
100 CpuDeadLoop() is called. If neither of these bits are set, then this function
101 returns immediately after the message is printed to the debug output device.
102 DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
103 processing another DebugAssert(), then DebugAssert() must return immediately.
105 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
107 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
109 @param FileName Pointer to the name of the source file that generated the assert condition.
110 @param LineNumber The line number in the source file that generated the assert condition
111 @param Description Pointer to the description of the assert condition.
117 IN CONST CHAR8
*FileName
,
119 IN CONST CHAR8
*Description
122 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
125 // Generate the ASSERT() message in Unicode format
127 UnicodeSPrintAsciiFormat (Buffer
, sizeof (Buffer
), "ASSERT %s(%d): %s\n", FileName
, LineNumber
, Description
);
130 // Send the print string to the Standard Error device
132 if ((gST
!= NULL
) && (gST
->StdErr
!= NULL
)) {
133 gST
->StdErr
->OutputString (gST
->StdErr
, Buffer
);
137 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
139 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
141 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
149 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
151 This function fills Length bytes of Buffer with the value specified by
152 PcdDebugClearMemoryValue, and returns Buffer.
154 If Buffer is NULL, then ASSERT().
156 If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
158 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
159 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
172 // If Buffer is NULL, then ASSERT().
174 ASSERT (Buffer
!= NULL
);
177 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
179 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
185 Returns TRUE if ASSERT() macros are enabled.
187 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
188 PcdDebugProperyMask is set. Otherwise FALSE is returned.
190 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
191 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
200 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
206 Returns TRUE if DEBUG()macros are enabled.
208 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
209 PcdDebugProperyMask is set. Otherwise FALSE is returned.
211 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
212 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
221 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
227 Returns TRUE if DEBUG_CODE()macros are enabled.
229 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
230 PcdDebugProperyMask is set. Otherwise FALSE is returned.
232 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
233 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
242 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
248 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
250 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
251 PcdDebugProperyMask is set. Otherwise FALSE is returned.
253 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
254 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
259 DebugClearMemoryEnabled (
263 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);