]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
MdePkg BaseStackCheckLib: Correct style of file header
[mirror_edk2.git] / MdePkg / Library / UefiDebugLibStdErr / DebugLib.c
CommitLineData
e386b444 1/** @file\r
eceb3a4c 2 UEFI Debug Lib that sends messages to the Standard Error Device in the EFI System Table.\r
e386b444 3\r
b4ac3c8a 4 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
19388d29 5 This program and the accompanying materials \r
e386b444 6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
2fc59a00 8 http://opensource.org/licenses/bsd-license.php. \r
e386b444 9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
13**/\r
14\r
c892d846 15\r
c7d265a9 16#include <Uefi.h>\r
c892d846 17\r
c7d265a9 18#include <Library/DebugLib.h>\r
19#include <Library/UefiBootServicesTableLib.h>\r
20#include <Library/PrintLib.h>\r
21#include <Library/PcdLib.h>\r
22#include <Library/BaseLib.h>\r
23#include <Library/BaseMemoryLib.h>\r
2891fc8b 24#include <Library/DebugPrintErrorLevelLib.h>\r
e386b444 25\r
26//\r
27// Define the maximum debug and assert message length that this library supports \r
28//\r
29#define MAX_DEBUG_MESSAGE_LENGTH 0x100\r
30\r
31\r
32/**\r
e386b444 33 Prints a debug message to the debug output device if the specified error level is enabled.\r
34\r
2891fc8b 35 If any bit in ErrorLevel is also set in DebugPrintErrorLevelLib function \r
36 GetDebugPrintErrorLevel (), then print the message specified by Format and the \r
37 associated variable argument list to the debug output device.\r
e386b444 38\r
39 If Format is NULL, then ASSERT().\r
40\r
41 @param ErrorLevel The error level of the debug message.\r
58380e9c 42 @param Format The format string for the debug message to print.\r
43 @param ... The variable argument list whose contents are accessed \r
285010e7 44 based on the format string specified by Format.\r
e386b444 45\r
46**/\r
47VOID\r
48EFIAPI\r
49DebugPrint (\r
50 IN UINTN ErrorLevel,\r
51 IN CONST CHAR8 *Format,\r
52 ...\r
53 )\r
54{\r
55 CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
56 VA_LIST Marker;\r
57\r
58 //\r
59 // If Format is NULL, then ASSERT().\r
60 //\r
61 ASSERT (Format != NULL);\r
62\r
63 //\r
64 // Check driver debug mask value and global mask\r
65 //\r
2891fc8b 66 if ((ErrorLevel & GetDebugPrintErrorLevel ()) == 0) {\r
e386b444 67 return;\r
68 }\r
69\r
70 //\r
71 // Convert the DEBUG() message to a Unicode String\r
72 //\r
73 VA_START (Marker, Format);\r
6cff95cd 74 UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);\r
e386b444 75 VA_END (Marker);\r
76\r
77 //\r
78 // Send the print string to the Standard Error device\r
79 //\r
80 if ((gST != NULL) && (gST->StdErr != NULL)) {\r
81 gST->StdErr->OutputString (gST->StdErr, Buffer);\r
82 }\r
83}\r
84\r
85\r
86/**\r
e386b444 87 Prints an assert message containing a filename, line number, and description. \r
88 This may be followed by a breakpoint or a dead loop.\r
89\r
3e5c3238 90 Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
e386b444 91 to the debug output device. If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
92 PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
93 DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
94 CpuDeadLoop() is called. If neither of these bits are set, then this function \r
95 returns immediately after the message is printed to the debug output device.\r
3e5c3238 96 DebugAssert() must actively prevent recursion. If DebugAssert() is called while\r
e386b444 97 processing another DebugAssert(), then DebugAssert() must return immediately.\r
98\r
99 If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
e386b444 100 If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
101\r
58380e9c 102 @param FileName The pointer to the name of the source file that generated \r
103 the assert condition.\r
104 @param LineNumber The line number in the source file that generated the \r
105 assert condition\r
2fc59a00 106 @param Description The pointer to the description of the assert condition.\r
e386b444 107\r
108**/\r
109VOID\r
110EFIAPI\r
111DebugAssert (\r
112 IN CONST CHAR8 *FileName,\r
113 IN UINTN LineNumber,\r
114 IN CONST CHAR8 *Description\r
115 )\r
116{\r
117 CHAR16 Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
118\r
119 //\r
120 // Generate the ASSERT() message in Unicode format\r
121 //\r
6cff95cd 122 UnicodeSPrintAsciiFormat (\r
123 Buffer, \r
dbcecd5d 124 sizeof (Buffer),\r
aa0a5149
BA
125 "ASSERT [%a] %a(%d): %a\n",\r
126 gEfiCallerBaseName,\r
6cff95cd 127 FileName, \r
128 LineNumber, \r
129 Description\r
130 );\r
131 \r
e386b444 132 //\r
133 // Send the print string to the Standard Error device\r
134 //\r
135 if ((gST != NULL) && (gST->StdErr != NULL)) {\r
136 gST->StdErr->OutputString (gST->StdErr, Buffer);\r
137 }\r
138\r
139 //\r
140 // Generate a Breakpoint, DeadLoop, or NOP based on PCD settings\r
141 //\r
142 if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED) != 0) {\r
143 CpuBreakpoint ();\r
144 } else if ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED) != 0) {\r
145 CpuDeadLoop ();\r
146 }\r
147}\r
148\r
149\r
150/**\r
e386b444 151 Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
152\r
153 This function fills Length bytes of Buffer with the value specified by \r
154 PcdDebugClearMemoryValue, and returns Buffer.\r
155\r
156 If Buffer is NULL, then ASSERT().\r
4ef55dfc 157 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
e386b444 158\r
2fc59a00 159 @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
160 @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
e386b444 161\r
2fc59a00 162 @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
e386b444 163\r
164**/\r
165VOID *\r
166EFIAPI\r
167DebugClearMemory (\r
168 OUT VOID *Buffer,\r
169 IN UINTN Length\r
170 )\r
171{\r
172 //\r
173 // If Buffer is NULL, then ASSERT().\r
174 //\r
175 ASSERT (Buffer != NULL);\r
176\r
177 //\r
178 // SetMem() checks for the the ASSERT() condition on Length and returns Buffer\r
179 //\r
180 return SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));\r
181}\r
182\r
183\r
184/**\r
e386b444 185 Returns TRUE if ASSERT() macros are enabled.\r
186\r
187 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
188 PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
189\r
190 @retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
191 @retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
192\r
193**/\r
194BOOLEAN\r
195EFIAPI\r
196DebugAssertEnabled (\r
197 VOID\r
198 )\r
199{\r
200 return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);\r
201}\r
202\r
203\r
3e5c3238 204/** \r
205 Returns TRUE if DEBUG() macros are enabled.\r
e386b444 206\r
207 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
208 PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
209\r
210 @retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
211 @retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
212\r
213**/\r
214BOOLEAN\r
215EFIAPI\r
216DebugPrintEnabled (\r
217 VOID\r
218 )\r
219{\r
220 return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);\r
221}\r
222\r
223\r
3e5c3238 224/** \r
225 Returns TRUE if DEBUG_CODE() macros are enabled.\r
e386b444 226\r
227 This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
228 PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
229\r
230 @retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
231 @retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
232\r
233**/\r
234BOOLEAN\r
235EFIAPI\r
236DebugCodeEnabled (\r
237 VOID\r
238 )\r
239{\r
240 return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);\r
241}\r
242\r
243\r
3e5c3238 244/** \r
245 Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
e386b444 246\r
eceb3a4c 247 This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
e386b444 248 PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
249\r
eceb3a4c
LG
250 @retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
251 @retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
e386b444 252\r
253**/\r
254BOOLEAN\r
255EFIAPI\r
256DebugClearMemoryEnabled (\r
257 VOID\r
258 )\r
259{\r
260 return (BOOLEAN) ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);\r
261}\r
b4ac3c8a
LG
262\r
263/**\r
264 Returns TRUE if any one of the bit is set both in ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
265\r
266 This function compares the bit mask of ErrorLevel and PcdFixedDebugPrintErrorLevel.\r
267\r
268 @retval TRUE Current ErrorLevel is supported.\r
269 @retval FALSE Current ErrorLevel is not supported.\r
270\r
271**/\r
272BOOLEAN\r
273EFIAPI\r
274DebugPrintLevelEnabled (\r
275 IN CONST UINTN ErrorLevel\r
276 )\r
277{\r
278 return (BOOLEAN) ((ErrorLevel & PcdGet32(PcdFixedDebugPrintErrorLevel)) != 0);\r
279}\r