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
);
63 Prints a debug message to the debug output device if the specified
64 error level is enabled base on Null-terminated format string and a
65 VA_LIST argument list or a BASE_LIST argument list.
67 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
68 GetDebugPrintErrorLevel (), then print the message specified by Format and
69 the associated variable argument list to the debug output device.
71 If Format is NULL, then ASSERT().
73 @param ErrorLevel The error level of the debug message.
74 @param Format Format string for the debug message to print.
75 @param VaListMarker VA_LIST marker for the variable argument list.
76 @param BaseListMarker BASE_LIST marker for the variable argument list.
82 IN CONST CHAR8
*Format
,
83 IN VA_LIST VaListMarker
,
84 IN BASE_LIST BaseListMarker
87 CHAR8 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
91 // If Format is NULL, then ASSERT().
93 ASSERT (Format
!= NULL
);
96 // Check if the global mask disables this message or the device is inactive
98 if (((ErrorLevel
& GetDebugPrintErrorLevel ()) == 0) ||
99 !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
);
120 Prints a debug message to the debug output device if the specified
121 error level is enabled.
123 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
124 GetDebugPrintErrorLevel (), then print the message specified by Format and
125 the associated variable argument list to the debug output device.
127 If Format is NULL, then ASSERT().
129 @param ErrorLevel The error level of the debug message.
130 @param Format Format string for the debug message to print.
131 @param VaListMarker VA_LIST marker for the variable argument list.
138 IN CONST CHAR8
*Format
,
139 IN VA_LIST VaListMarker
142 DebugPrintMarker (ErrorLevel
, Format
, VaListMarker
, NULL
);
146 Prints a debug message to the debug output device if the specified
147 error level is enabled.
148 This function use BASE_LIST which would provide a more compatible
149 service than VA_LIST.
151 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function
152 GetDebugPrintErrorLevel (), then print the message specified by Format and
153 the associated variable argument list to the debug output device.
155 If Format is NULL, then ASSERT().
157 @param ErrorLevel The error level of the debug message.
158 @param Format Format string for the debug message to print.
159 @param BaseListMarker BASE_LIST marker for the variable argument list.
166 IN CONST CHAR8
*Format
,
167 IN BASE_LIST BaseListMarker
170 DebugPrintMarker (ErrorLevel
, Format
, mVaListNull
, BaseListMarker
);
174 Prints an assert message containing a filename, line number, and description.
175 This may be followed by a breakpoint or a dead loop.
177 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
178 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of
179 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if
180 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then
181 CpuDeadLoop() is called. If neither of these bits are set, then this function
182 returns immediately after the message is printed to the debug output device.
183 DebugAssert() must actively prevent recursion. If DebugAssert() is called while
184 processing another DebugAssert(), then DebugAssert() must return immediately.
186 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
187 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
189 @param FileName The pointer to the name of the source file that generated the assert condition.
190 @param LineNumber The line number in the source file that generated the assert condition
191 @param Description The pointer to the description of the assert condition.
197 IN CONST CHAR8
*FileName
,
199 IN CONST CHAR8
*Description
202 CHAR8 Buffer
[MAX_DEBUG_MESSAGE_LENGTH
];
206 // Generate the ASSERT() message in Ascii format
208 Length
= AsciiSPrint (
211 "ASSERT %a(%Lu): %a\n",
218 // Send the print string to the debug I/O port, if present
220 if (PlatformDebugLibIoPortFound ()) {
221 IoWriteFifo8 (PcdGet16 (PcdDebugIoPort
), Length
, Buffer
);
225 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings
227 if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED
) != 0) {
229 } else if ((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED
) != 0) {
235 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
237 This function fills Length bytes of Buffer with the value specified by
238 PcdDebugClearMemoryValue, and returns Buffer.
240 If Buffer is NULL, then ASSERT().
241 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
243 @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
244 @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
246 @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.
257 // If Buffer is NULL, then ASSERT().
259 ASSERT (Buffer
!= NULL
);
262 // SetMem() checks for the ASSERT() condition on Length and returns Buffer
264 return SetMem (Buffer
, Length
, PcdGet8 (PcdDebugClearMemoryValue
));
268 Returns TRUE if ASSERT() macros are enabled.
270 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of
271 PcdDebugProperyMask is set. Otherwise FALSE is returned.
273 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.
274 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.
283 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);
306 Returns TRUE if DEBUG_CODE() macros are enabled.
308 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of
309 PcdDebugProperyMask is set. Otherwise FALSE is returned.
311 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.
312 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.
321 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED
) != 0);
325 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
327 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of
328 PcdDebugProperyMask is set. Otherwise FALSE is returned.
330 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.
331 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.
336 DebugClearMemoryEnabled (
340 return (BOOLEAN
)((PcdGet8 (PcdDebugPropertyMask
) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED
) != 0);
344 Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.
346 This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.
348 @retval TRUE Current ErrorLevel is supported.
349 @retval FALSE Current ErrorLevel is not supported.
354 DebugPrintLevelEnabled (
355 IN CONST UINTN ErrorLevel
358 return (BOOLEAN
)((ErrorLevel
& PcdGet32 (PcdFixedDebugPrintErrorLevel
)) != 0);