2 UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.
4 Copyright (c) 2006 - 2008, 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.
19 #include <Library/DebugLib.h>
20 #include <Library/UefiBootServicesTableLib.h>
21 #include <Library/PrintLib.h>
22 #include <Library/PcdLib.h>
23 #include <Library/BaseLib.h>
24 #include <Library/BaseMemoryLib.h>
27 // Define the maximum debug and assert message length that this library supports
29 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
34 Prints a debug message to the debug output device if the specified error level is enabled.
36 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
37 the message specified by Format and the associated variable argument list to
38 the debug output device.
40 If Format is NULL, then ASSERT().
42 @param ErrorLevel The error level of the debug message.
43 @param Format Format string for the debug message to print.
44 @param ... The variable argument list.
51 IN CONST CHAR8
*Format
,
55 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
59 // If Format is NULL, then ASSERT().
61 ASSERT (Format
!= NULL
);
64 // Check driver debug mask value and global mask
66 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
71 // Convert the DEBUG() message to a Unicode String
73 VA_START (Marker
, Format
);
74 UnicodeVSPrintAsciiFormat (Buffer
, MAX_DEBUG_MESSAGE_LENGTH
, Format
, Marker
);
78 // Send the print string to the Standard Error device
80 if ((gST
!= NULL
) && (gST
->StdErr
!= NULL
)) {
81 gST
->StdErr
->OutputString (gST
->StdErr
, Buffer
);
88 Prints an assert message containing a filename, line number, and description.
89 This may be followed by a breakpoint or a dead loop.
91 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
92 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
93 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
94 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
95 CpuDeadLoop() is called. If neither of these bits are set, then this function
96 returns immediately after the message is printed to the debug output device.
97 DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
98 processing another DebugAssert(), then DebugAssert() must return immediately.
100 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
102 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
104 @param FileName Pointer to the name of the source file that generated the assert condition.
105 @param LineNumber The line number in the source file that generated the assert condition
106 @param Description Pointer to the description of the assert condition.
112 IN CONST CHAR8
*FileName
,
114 IN CONST CHAR8
*Description
117 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
120 // Generate the ASSERT() message in Unicode format
122 UnicodeSPrintAsciiFormat (
124 MAX_DEBUG_MESSAGE_LENGTH
,
125 "ASSERT %a(%d): %a\n",
132 // Send the print string to the Standard Error device
134 if ((gST
!= NULL
) && (gST
->StdErr
!= NULL
)) {
135 gST
->StdErr
->OutputString (gST
->StdErr
, Buffer
);
139 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
141 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
143 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
151 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
153 This function fills Length bytes of Buffer with the value specified by
154 PcdDebugClearMemoryValue, and returns Buffer.
156 If Buffer is NULL, then ASSERT().
158 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
160 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
161 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
163 @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.
174 // If Buffer is NULL, then ASSERT().
176 ASSERT (Buffer
!= NULL
);
179 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
181 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
187 Returns TRUE if ASSERT() macros are enabled.
189 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
190 PcdDebugProperyMask is set. Otherwise FALSE is returned.
192 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
193 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
202 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
208 Returns TRUE if DEBUG()macros are enabled.
210 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
211 PcdDebugProperyMask is set. Otherwise FALSE is returned.
213 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
214 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
223 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
229 Returns TRUE if DEBUG_CODE()macros are enabled.
231 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
232 PcdDebugProperyMask is set. Otherwise FALSE is returned.
234 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
235 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
244 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
250 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
252 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
253 PcdDebugProperyMask is set. Otherwise FALSE is returned.
255 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
256 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
261 DebugClearMemoryEnabled (
265 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);