2 Base Debug library instance for hypervisor debug port.
3 It uses PrintLib to send debug messages to a fixed I/O port.
5 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
6 Copyright (c) 2012, Red Hat, Inc.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
12 #include <Library/DebugLib.h>
13 #include <Library/BaseLib.h>
14 #include <Library/IoLib.h>
15 #include <Library/PrintLib.h>
16 #include <Library/PcdLib.h>
17 #include <Library/BaseMemoryLib.h>
18 #include <Library/DebugPrintErrorLevelLib.h>
19 #include "DebugLibDetect.h"
22 // Define the maximum debug and assert message length that this library supports
24 #define MAX_DEBUG_MESSAGE_LENGTH 0x100
27 // VA_LIST can not initialize to NULL for all compiler, so we use this to
28 // indicate a null VA_LIST
33 Prints a debug message to the debug output device if the specified error level is enabled.
35 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
36 GetDebugPrintErrorLevel (), then print the message specified by Format and the
37 associated variable argument list to the debug output device.
39 If Format is NULL, then ASSERT().
41 @param ErrorLevel The error level of the debug message.
42 @param Format Format string for the debug message to print.
43 @param ... Variable argument list whose contents are accessed
44 based on the format string specified by Format.
51 IN CONST CHAR8
*Format
,
57 VA_START (Marker
, Format
);
58 DebugVPrint (ErrorLevel
, Format
, Marker
);
64 Prints a debug message to the debug output device if the specified
65 error level is enabled base on Null-terminated format string and a
66 VA_LIST argument list or a BASE_LIST argument list.
68 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
69 GetDebugPrintErrorLevel (), then print the message specified by Format and
70 the associated variable argument list to the debug output device.
72 If Format is NULL, then ASSERT().
74 @param ErrorLevel The error level of the debug message.
75 @param Format Format string for the debug message to print.
76 @param VaListMarker VA_LIST marker for the variable argument list.
77 @param BaseListMarker BASE_LIST marker for the variable argument list.
83 IN CONST CHAR8
*Format
,
84 IN VA_LIST VaListMarker
,
85 IN BASE_LIST BaseListMarker
88 CHAR8 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
92 // If Format is NULL, then ASSERT().
94 ASSERT (Format
!= NULL
);
97 // Check if the global mask disables this message or the device is inactive
99 if ((ErrorLevel
& GetDebugPrintErrorLevel ()) == 0 ||
100 !PlatformDebugLibIoPortFound ()) {
105 // Convert the DEBUG() message to an ASCII String
107 if (BaseListMarker
== NULL
) {
108 Length
= AsciiVSPrint (Buffer
, sizeof (Buffer
), Format
, VaListMarker
);
110 Length
= AsciiBSPrint (Buffer
, sizeof (Buffer
), Format
, BaseListMarker
);
114 // Send the print string to the debug I/O port
116 IoWriteFifo8 (PcdGet16 (PcdDebugIoPort
), Length
, Buffer
);
121 Prints a debug message to the debug output device if the specified
122 error level is enabled.
124 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
125 GetDebugPrintErrorLevel (), then print the message specified by Format and
126 the associated variable argument list to the debug output device.
128 If Format is NULL, then ASSERT().
130 @param ErrorLevel The error level of the debug message.
131 @param Format Format string for the debug message to print.
132 @param VaListMarker VA_LIST marker for the variable argument list.
139 IN CONST CHAR8
*Format
,
140 IN VA_LIST VaListMarker
143 DebugPrintMarker (ErrorLevel
, Format
, VaListMarker
, NULL
);
148 Prints a debug message to the debug output device if the specified
149 error level is enabled.
150 This function use BASE_LIST which would provide a more compatible
151 service than VA_LIST.
153 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
154 GetDebugPrintErrorLevel (), then print the message specified by Format and
155 the associated variable argument list to the debug output device.
157 If Format is NULL, then ASSERT().
159 @param ErrorLevel The error level of the debug message.
160 @param Format Format string for the debug message to print.
161 @param BaseListMarker BASE_LIST marker for the variable argument list.
168 IN CONST CHAR8
*Format
,
169 IN BASE_LIST BaseListMarker
172 DebugPrintMarker (ErrorLevel
, Format
, mVaListNull
, BaseListMarker
);
177 Prints an assert message containing a filename, line number, and description.
178 This may be followed by a breakpoint or a dead loop.
180 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
181 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
182 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
183 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
184 CpuDeadLoop() is called. If neither of these bits are set, then this function
185 returns immediately after the message is printed to the debug output device.
186 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
187 processing another DebugAssert(), then DebugAssert() must return immediately.
189 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
190 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
192 @param FileName The pointer to the name of the source file that generated the assert condition.
193 @param LineNumber The line number in the source file that generated the assert condition
194 @param Description The pointer to the description of the assert condition.
200 IN CONST CHAR8
*FileName
,
202 IN CONST CHAR8
*Description
205 CHAR8 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
209 // Generate the ASSERT() message in Ascii format
211 Length
= AsciiSPrint (Buffer
, sizeof Buffer
, "ASSERT %a(%Lu): %a\n",
212 FileName
, (UINT64
)LineNumber
, Description
);
215 // Send the print string to the debug I/O port, if present
217 if (PlatformDebugLibIoPortFound ()) {
218 IoWriteFifo8 (PcdGet16 (PcdDebugIoPort
), Length
, Buffer
);
222 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
224 if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
226 } else if ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
233 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
235 This function fills Length bytes of Buffer with the value specified by
236 PcdDebugClearMemoryValue, and returns Buffer.
238 If Buffer is NULL, then ASSERT().
239 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
241 @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
242 @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
244 @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.
255 // If Buffer is NULL, then ASSERT().
257 ASSERT (Buffer
!= NULL
);
260 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
262 return SetMem (Buffer
, Length
, PcdGet8(PcdDebugClearMemoryValue
));
267 Returns TRUE if ASSERT() macros are enabled.
269 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
270 PcdDebugProperyMask is set. Otherwise FALSE is returned.
272 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
273 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
282 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED
) != 0);
287 Returns TRUE if DEBUG() macros are enabled.
289 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of
290 PcdDebugProperyMask is set. Otherwise FALSE is returned.
292 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.
293 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.
302 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED
) != 0);
307 Returns TRUE if DEBUG_CODE() macros are enabled.
309 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
310 PcdDebugProperyMask is set. Otherwise FALSE is returned.
312 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
313 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
322 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
327 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
329 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
330 PcdDebugProperyMask is set. Otherwise FALSE is returned.
332 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
333 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
338 DebugClearMemoryEnabled (
342 return (BOOLEAN
) ((PcdGet8(PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);
346 Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
348 This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
350 @retval TRUE Current ErrorLevel is supported.
351 @retval FALSE Current ErrorLevel is not supported.
356 DebugPrintLevelEnabled (
357 IN CONST UINTN ErrorLevel
360 return (BOOLEAN
) ((ErrorLevel
& PcdGet32(PcdFixedDebugPrintErrorLevel
)) != 0);