2 UEFI Debug Library that uses PrintLib to send messages to CONOUT.
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>
34 // Define the maximum debug and assert message length that this library supports
36 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
41 Prints a debug message to the debug output device if the specified error level is enabled.
43 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
44 the message specified by Format and the associated variable argument list to
45 the debug output device.
47 If Format is NULL, then ASSERT().
49 @param ErrorLevel The error level of the debug message.
50 @param Format Format string for the debug message to print.
57 IN CONST CHAR8
*Format
,
61 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
65 // If Format is NULL, then ASSERT().
67 ASSERT (Format
!= NULL
);
70 // Check driver debug mask value and global mask
72 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
77 // Convert the DEBUG() message to a Unicode String
79 VA_START (Marker
, Format
);
80 UnicodeVSPrintAsciiFormat (Buffer
, sizeof (Buffer
), Format
, Marker
);
84 // Send the print string to the Console Output device
86 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
87 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
94 Prints an assert message containing a filename, line number, and description.
95 This may be followed by a breakpoint or a dead loop.
97 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
98 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
99 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
100 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
101 CpuDeadLoop() is called. If neither of these bits are set, then this function
102 returns immediately after the message is printed to the debug output device.
103 DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
104 processing another DebugAssert(), then DebugAssert() must return immediately.
106 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
108 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
110 @param FileName Pointer to the name of the source file that generated the assert condition.
111 @param LineNumber The line number in the source file that generated the assert condition
112 @param Description Pointer to the description of the assert condition.
118 IN CONST CHAR8
*FileName
,
120 IN CONST CHAR8
*Description
123 CHAR16 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
126 // Generate the ASSERT() message in Unicode format
128 UnicodeSPrintAsciiFormat (Buffer
, sizeof (Buffer
), "ASSERT %s(%d): %s\n", FileName
, LineNumber
, Description
);
131 // Send the print string to the Console Output device
133 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
134 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
138 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
140 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
142 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
150 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
152 This function fills Length bytes of Buffer with the value specified by
153 PcdDebugClearMemoryValue, and returns Buffer.
155 If Buffer is NULL, then ASSERT().
157 If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
159 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
160 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
173 // If Buffer is NULL, then ASSERT().
175 ASSERT (Buffer
!= NULL
);
178 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
180 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
186 Returns TRUE if ASSERT() macros are enabled.
188 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
189 PcdDebugProperyMask is set. Otherwise FALSE is returned.
191 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
192 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
201 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
207 Returns TRUE if DEBUG()macros are enabled.
209 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
210 PcdDebugProperyMask is set. Otherwise FALSE is returned.
212 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
213 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
222 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
228 Returns TRUE if DEBUG_CODE()macros are enabled.
230 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
231 PcdDebugProperyMask is set. Otherwise FALSE is returned.
233 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
234 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
243 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
249 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
251 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
252 PcdDebugProperyMask is set. Otherwise FALSE is returned.
254 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
255 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
260 DebugClearMemoryEnabled (
264 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);