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