1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/*++
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
DebugLib.c
Abstract:
UEFI Debug Library that uses PrintLib to send messages to CONOUT
--*/
static BOOLEAN mDebugLevelInstalled = FALSE;
static EFI_DEBUG_LEVEL_PROTOCOL mDebugLevel = { 0 };
EFI_STATUS
DebugLibConstructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
/*++
Routine Description:
Arguments:
Returns:
--*/
{
EFI_STATUS Status;
//
// Initialize Debug Level Protocol
//
mDebugLevel.DebugLevel = PcdGet32(PcdDebugPrintErrorLevel);
//
// Install Debug Level Protocol
//
Status = gBS->InstallMultipleProtocolInterfaces (
&ImageHandle,
&gEfiDebugLevelProtocolGuid, &mDebugLevel,
NULL
);
ASSERT_EFI_ERROR (Status);
//
// Set flag to show that the Debug Level Protocol has been installed
//
mDebugLevelInstalled = TRUE;
return EFI_SUCCESS;
}
VOID
EFIAPI
DebugPrint (
IN UINTN ErrorLevel,
IN CHAR8 *Format,
...
)
/*++
Routine Description:
Wrapper for DebugVPrint ()
Arguments:
ErrorLevel - If error level is set do the debug print.
Format - String to use for the print, followed by Print arguments.
... - Print arguments.
Returns:
None
--*/
{
CHAR16 Buffer[0x100];
CHAR16 UnicodeBuffer[0x100];
UINT32 Index;
VA_LIST Marker;
//
// Check to see if CONOUT is avilable
//
if (gST->ConOut == NULL) {
return;
}
//
// Check driver Debug Level value and global debug level
//
if (mDebugLevelInstalled) {
if ((ErrorLevel & mDebugLevel.DebugLevel) == 0) {
return;
}
} else {
if ((ErrorLevel & PcdGet32(PcdDebugPrintErrorLevel)) == 0) {
return;
}
}
//
// BUGBUG: Need print that take CHAR8 Format and returns CHAR16 Buffer
//
for (Index = 0; Format[Index] != 0; Index++) {
UnicodeBuffer[Index] = Format[Index];
}
UnicodeBuffer[Index] = Format[Index];
//
// Convert the DEBUG() message to a Unicode String
//
VA_START (Marker, Format);
UnicodeVSPrint (Buffer, sizeof (Buffer), UnicodeBuffer, Marker);
VA_END (Marker);
//
// Send the print string to the Standard Error device
//
gST->ConOut->OutputString (gST->ConOut, Buffer);
}
VOID
EFIAPI
DebugAssert (
IN CHAR8 *FileName,
IN INTN LineNumber,
IN CHAR8 *Description
)
/*++
Routine Description:
Worker function for ASSERT(). If Error Logging hub is loaded log ASSERT
information. If Error Logging hub is not loaded CpuBreakpoint ().
We use UINT64 buffers due to IPF alignment concerns.
Arguments:
FileName - File name of failing routine.
LineNumber - Line number of failing ASSERT().
Description - Descritption, usally the assertion,
Returns:
None
--*/
{
CHAR16 Buffer[0x100];
//
// Check to see if CONOUT is avilable
//
if (gST->ConOut == NULL) {
return;
}
//
// Generate the ASSERT() message in Unicode format
//
UnicodeSPrint (Buffer, sizeof (Buffer), (CHAR16 *)L"ASSERT %s(%d): %s\n", FileName, LineNumber, Description);
//
// Send the print string to the Standard Error device
//
gST->ConOut->OutputString (gST->ConOut, Buffer);
//
// Put break point in module that contained the error.
//
CpuBreakpoint ();
}
/**
Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
This function fills Length bytes of Buffer with the value specified by
PcdDebugClearMemoryValue, and returns Buffer.
If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS – Buffer + 1), then ASSERT().
@param Buffer Pointer to the target buffer to fill with PcdDebugClearMemoryValue.
@param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue.
@return Buffer
**/
VOID *
EFIAPI
DebugClearMemory (
OUT VOID *Buffer,
IN UINTN Length
)
{
// SetMem (Buffer, Length, PcdGet8(PcdDebugClearMemoryValue));
SetMem (Buffer, Length, 0xAF);
return Buffer;
}
BOOLEAN
EFIAPI
DebugAssertEnabled (
VOID
)
{
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED) != 0);
}
BOOLEAN
EFIAPI
DebugPrintEnabled (
VOID
)
{
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_PRINT_ENABLED) != 0);
}
BOOLEAN
EFIAPI
DebugCodeEnabled (
VOID
)
{
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_DEBUG_CODE_ENABLED) != 0);
}
BOOLEAN
EFIAPI
DebugClearMemoryEnabled (
VOID
)
{
return ((PcdGet8(PcdDebugPropertyMask) & DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED) != 0);
}
|
