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.
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>
28 // Define the maximum debug and assert message length that this library supports
30 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
35 Prints a debug message to the debug output device if the specified error level is enabled.
37 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
38 the message specified by Format and the associated variable argument list to
39 the debug output device.
41 If Format is NULL, then ASSERT().
43 @param ErrorLevel The error level of the debug message.
44 @param Format Format string for the debug message to print.
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
, sizeof (Buffer
), Format
, Marker
);
78 // Send the print string to the Console Output device
80 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
81 gST
->ConOut
->OutputString (gST
->ConOut
, 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 (Buffer
, sizeof (Buffer
), "ASSERT %s(%d): %s\n", FileName
, LineNumber
, Description
);
125 // Send the print string to the Console Output device
127 if ((gST
!= NULL
) && (gST
->ConOut
!= NULL
)) {
128 gST
->ConOut
->OutputString (gST
->ConOut
, Buffer
);
132 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
134 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
136 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
144 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
146 This function fills Length bytes of Buffer with the value specified by
147 PcdDebugClearMemoryValue, and returns Buffer.
149 If Buffer is NULL, then ASSERT().
151 If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
153 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
154 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
167 // If Buffer is NULL, then ASSERT().
169 ASSERT (Buffer
!= NULL
);
172 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
174 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
180 Returns TRUE if ASSERT() macros are enabled.
182 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
183 PcdDebugProperyMask is set. Otherwise FALSE is returned.
185 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
186 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
195 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
201 Returns TRUE if DEBUG()macros are enabled.
203 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
204 PcdDebugProperyMask is set. Otherwise FALSE is returned.
206 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
207 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
216 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
222 Returns TRUE if DEBUG_CODE()macros are enabled.
224 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
225 PcdDebugProperyMask is set. Otherwise FALSE is returned.
227 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
228 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
237 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
243 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
245 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
246 PcdDebugProperyMask is set. Otherwise FALSE is returned.
248 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
249 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
254 DebugClearMemoryEnabled (
258 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);