2 UEFI Debug Library that uses PrintLib to send messages to CONOUT.
4 Copyright (c) 2006, 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 // Include common header file for this module.
18 #include "CommonHeader.h"
21 // Define the maximum debug and assert message length that this library supports
23 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
28 Prints a debug message to the debug output device if the specified error level is enabled.
30 If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print
31 the message specified by Format and the associated variable argument list to
32 the debug output device.
34 If Format is NULL, then ASSERT().
36 @param ErrorLevel The error level of the debug message.
37 @param Format Format string for the debug message to print.
44 IN CONST CHAR8
*Format
,
48 CHAR8 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
52 // If Format is NULL, then ASSERT().
54 ASSERT (Format
!= NULL
);
57 // Check driver debug mask value and global mask
59 if ((ErrorLevel
& PcdGet32(PcdDebugPrintErrorLevel
)) == 0) {
64 // Convert the DEBUG() message to an ASCII String
66 VA_START (Marker
, Format
);
67 AsciiVSPrint (Buffer
, sizeof (Buffer
), Format
, Marker
);
71 // Send the print string to a Serial Port
73 SerialPortWrite ((UINT8
*) Buffer
, AsciiStrLen(Buffer
));
79 Prints an assert message containing a filename, line number, and description.
80 This may be followed by a breakpoint or a dead loop.
82 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
83 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
84 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
85 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
86 CpuDeadLoop() is called. If neither of these bits are set, then this function
87 returns immediately after the message is printed to the debug output device.
88 DebugAssert() must actively prevent recusrsion. If DebugAssert() is called while
89 processing another DebugAssert(), then DebugAssert() must return immediately.
91 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
93 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
95 @param FileName Pointer to the name of the source file that generated the assert condition.
96 @param LineNumber The line number in the source file that generated the assert condition
97 @param Description Pointer to the description of the assert condition.
103 IN CONST CHAR8
*FileName
,
105 IN CONST CHAR8
*Description
108 CHAR8 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
111 // Generate the ASSERT() message in Unicode format
113 AsciiSPrint (Buffer
, sizeof (Buffer
), "ASSERT %a(%d): %a\n", FileName
, LineNumber
, Description
);
116 // Send the print string to the Console Output device
118 SerialPortWrite ((UINT8
*) Buffer
, AsciiStrLen(Buffer
));
121 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
123 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
125 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
133 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
135 This function fills Length bytes of Buffer with the value specified by
136 PcdDebugClearMemoryValue, and returns Buffer.
138 If Buffer is NULL, then ASSERT().
140 If Length is greater than (MAX_ADDRESS ? Buffer + 1), then ASSERT().
142 @param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
143 @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
156 // If Buffer is NULL, then ASSERT().
158 ASSERT (Buffer
!= NULL
);
161 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
163 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
169 Returns TRUE if ASSERT() macros are enabled.
171 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
172 PcdDebugProperyMask is set. Otherwise FALSE is returned.
174 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
175 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
184 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
190 Returns TRUE if DEBUG()macros are enabled.
192 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
193 PcdDebugProperyMask is set. Otherwise FALSE is returned.
195 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
196 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
205 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
211 Returns TRUE if DEBUG_CODE()macros are enabled.
213 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
214 PcdDebugProperyMask is set. Otherwise FALSE is returned.
216 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
217 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
226 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
232 Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
234 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of
235 PcdDebugProperyMask is set. Otherwise FALSE is returned.
237 @retval TRUE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
238 @retval FALSE The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
243 DebugClearMemoryEnabled (
247 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);