]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Universal/BdsDxe/MemoryTest.c
IntelFrameworkModulePkg: Clean up source files
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / MemoryTest.c
CommitLineData
5c08e117 1/** @file\r
2 Perform the platform memory test\r
3\r
0a6f4824 4Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
180a5a35 5This program and the accompanying materials\r
5c08e117 6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "Bds.h"\r
16#include "String.h"\r
17\r
18//\r
19// BDS Platform Functions\r
20//\r
21/**\r
22\r
23 Show progress bar with title above it. It only works in Graphics mode.\r
24\r
25\r
26 @param TitleForeground Foreground color for Title.\r
27 @param TitleBackground Background color for Title.\r
28 @param Title Title above progress bar.\r
29 @param ProgressColor Progress bar color.\r
30 @param Progress Progress (0-100)\r
31 @param PreviousValue The previous value of the progress.\r
32\r
33 @retval EFI_STATUS Success update the progress bar\r
34\r
35**/\r
36EFI_STATUS\r
37PlatformBdsShowProgress (\r
38 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r
39 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,\r
40 IN CHAR16 *Title,\r
41 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,\r
42 IN UINTN Progress,\r
43 IN UINTN PreviousValue\r
44 )\r
45{\r
46 EFI_STATUS Status;\r
47 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
48 EFI_UGA_DRAW_PROTOCOL *UgaDraw;\r
49 UINT32 SizeOfX;\r
50 UINT32 SizeOfY;\r
51 UINT32 ColorDepth;\r
52 UINT32 RefreshRate;\r
53 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color;\r
54 UINTN BlockHeight;\r
55 UINTN BlockWidth;\r
56 UINTN BlockNum;\r
57 UINTN PosX;\r
58 UINTN PosY;\r
59 UINTN Index;\r
60\r
61 if (Progress > 100) {\r
62 return EFI_INVALID_PARAMETER;\r
63 }\r
64\r
65 UgaDraw = NULL;\r
66 Status = gBS->HandleProtocol (\r
67 gST->ConsoleOutHandle,\r
68 &gEfiGraphicsOutputProtocolGuid,\r
69 (VOID **) &GraphicsOutput\r
70 );\r
71 if (EFI_ERROR (Status) && FeaturePcdGet (PcdUgaConsumeSupport)) {\r
72 GraphicsOutput = NULL;\r
73\r
74 Status = gBS->HandleProtocol (\r
75 gST->ConsoleOutHandle,\r
76 &gEfiUgaDrawProtocolGuid,\r
77 (VOID **) &UgaDraw\r
78 );\r
79 }\r
80 if (EFI_ERROR (Status)) {\r
81 return EFI_UNSUPPORTED;\r
82 }\r
83\r
84 SizeOfX = 0;\r
85 SizeOfY = 0;\r
86 if (GraphicsOutput != NULL) {\r
87 SizeOfX = GraphicsOutput->Mode->Info->HorizontalResolution;\r
88 SizeOfY = GraphicsOutput->Mode->Info->VerticalResolution;\r
89 } else if (UgaDraw != NULL) {\r
90 Status = UgaDraw->GetMode (\r
91 UgaDraw,\r
92 &SizeOfX,\r
93 &SizeOfY,\r
94 &ColorDepth,\r
95 &RefreshRate\r
96 );\r
97 if (EFI_ERROR (Status)) {\r
98 return EFI_UNSUPPORTED;\r
99 }\r
100 } else {\r
101 return EFI_UNSUPPORTED;\r
102 }\r
103\r
104 BlockWidth = SizeOfX / 100;\r
105 BlockHeight = SizeOfY / 50;\r
106\r
107 BlockNum = Progress;\r
108\r
109 PosX = 0;\r
110 PosY = SizeOfY * 48 / 50;\r
111\r
112 if (BlockNum == 0) {\r
113 //\r
114 // Clear progress area\r
115 //\r
116 SetMem (&Color, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0x0);\r
117\r
118 if (GraphicsOutput != NULL) {\r
119 Status = GraphicsOutput->Blt (\r
120 GraphicsOutput,\r
121 &Color,\r
122 EfiBltVideoFill,\r
123 0,\r
124 0,\r
125 0,\r
126 PosY - EFI_GLYPH_HEIGHT - 1,\r
127 SizeOfX,\r
128 SizeOfY - (PosY - EFI_GLYPH_HEIGHT - 1),\r
129 SizeOfX * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
130 );\r
131 } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {\r
132 Status = UgaDraw->Blt (\r
133 UgaDraw,\r
134 (EFI_UGA_PIXEL *) &Color,\r
135 EfiUgaVideoFill,\r
136 0,\r
137 0,\r
138 0,\r
139 PosY - EFI_GLYPH_HEIGHT - 1,\r
140 SizeOfX,\r
141 SizeOfY - (PosY - EFI_GLYPH_HEIGHT - 1),\r
142 SizeOfX * sizeof (EFI_UGA_PIXEL)\r
143 );\r
144 } else {\r
145 return EFI_UNSUPPORTED;\r
146 }\r
147 }\r
148 //\r
149 // Show progress by drawing blocks\r
150 //\r
151 for (Index = PreviousValue; Index < BlockNum; Index++) {\r
152 PosX = Index * BlockWidth;\r
153 if (GraphicsOutput != NULL) {\r
154 Status = GraphicsOutput->Blt (\r
155 GraphicsOutput,\r
156 &ProgressColor,\r
157 EfiBltVideoFill,\r
158 0,\r
159 0,\r
160 PosX,\r
161 PosY,\r
162 BlockWidth - 1,\r
163 BlockHeight,\r
164 (BlockWidth) * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
165 );\r
166 } else if (FeaturePcdGet (PcdUgaConsumeSupport)) {\r
167 Status = UgaDraw->Blt (\r
168 UgaDraw,\r
169 (EFI_UGA_PIXEL *) &ProgressColor,\r
170 EfiUgaVideoFill,\r
171 0,\r
172 0,\r
173 PosX,\r
174 PosY,\r
175 BlockWidth - 1,\r
176 BlockHeight,\r
177 (BlockWidth) * sizeof (EFI_UGA_PIXEL)\r
178 );\r
179 } else {\r
180 return EFI_UNSUPPORTED;\r
181 }\r
182 }\r
183\r
184 PrintXY (\r
185 (SizeOfX - StrLen (Title) * EFI_GLYPH_WIDTH) / 2,\r
186 PosY - EFI_GLYPH_HEIGHT - 1,\r
187 &TitleForeground,\r
188 &TitleBackground,\r
189 Title\r
190 );\r
191\r
192 return EFI_SUCCESS;\r
193}\r
194\r
195/**\r
5c08e117 196 Perform the memory test base on the memory test intensive level,\r
197 and update the memory resource.\r
198\r
a798a789 199 @param Level The memory test intensive level.\r
5c08e117 200\r
a798a789 201 @retval EFI_STATUS Success test all the system memory and update\r
202 the memory resource\r
5c08e117 203\r
204**/\r
205EFI_STATUS\r
8861fc79 206EFIAPI\r
5c08e117 207BdsMemoryTest (\r
208 IN EXTENDMEM_COVERAGE_LEVEL Level\r
209 )\r
210{\r
211 EFI_STATUS Status;\r
212 EFI_STATUS KeyStatus;\r
213 EFI_STATUS InitStatus;\r
214 EFI_STATUS ReturnStatus;\r
215 BOOLEAN RequireSoftECCInit;\r
216 EFI_GENERIC_MEMORY_TEST_PROTOCOL *GenMemoryTest;\r
217 UINT64 TestedMemorySize;\r
218 UINT64 TotalMemorySize;\r
219 UINTN TestPercent;\r
220 UINT64 PreviousValue;\r
221 BOOLEAN ErrorOut;\r
222 BOOLEAN TestAbort;\r
223 EFI_INPUT_KEY Key;\r
5d7c1609 224 CHAR16 StrPercent[80];\r
5c08e117 225 CHAR16 *StrTotalMemory;\r
226 CHAR16 *Pos;\r
227 CHAR16 *TmpStr;\r
228 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground;\r
229 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background;\r
230 EFI_GRAPHICS_OUTPUT_BLT_PIXEL Color;\r
08c4ca5b 231 BOOLEAN IsFirstBoot;\r
5c08e117 232 UINT32 TempData;\r
a1360fa3 233 UINTN StrTotalMemorySize;\r
5c08e117 234\r
235 ReturnStatus = EFI_SUCCESS;\r
236 ZeroMem (&Key, sizeof (EFI_INPUT_KEY));\r
237\r
a1360fa3
JF
238 StrTotalMemorySize = 128;\r
239 Pos = AllocateZeroPool (StrTotalMemorySize);\r
5c08e117 240\r
241 if (Pos == NULL) {\r
242 return ReturnStatus;\r
243 }\r
244\r
245 StrTotalMemory = Pos;\r
246\r
247 TestedMemorySize = 0;\r
248 TotalMemorySize = 0;\r
249 PreviousValue = 0;\r
250 ErrorOut = FALSE;\r
251 TestAbort = FALSE;\r
252\r
253 SetMem (&Foreground, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0xff);\r
254 SetMem (&Background, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0x0);\r
255 SetMem (&Color, sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL), 0xff);\r
256\r
257 RequireSoftECCInit = FALSE;\r
258\r
5c08e117 259 Status = gBS->LocateProtocol (\r
260 &gEfiGenericMemTestProtocolGuid,\r
261 NULL,\r
262 (VOID **) &GenMemoryTest\r
263 );\r
264 if (EFI_ERROR (Status)) {\r
265 FreePool (Pos);\r
266 return EFI_SUCCESS;\r
267 }\r
268\r
269 InitStatus = GenMemoryTest->MemoryTestInit (\r
270 GenMemoryTest,\r
271 Level,\r
272 &RequireSoftECCInit\r
273 );\r
274 if (InitStatus == EFI_NO_MEDIA) {\r
275 //\r
276 // The PEI codes also have the relevant memory test code to check the memory,\r
277 // it can select to test some range of the memory or all of them. If PEI code\r
278 // checks all the memory, this BDS memory test will has no not-test memory to\r
279 // do the test, and then the status of EFI_NO_MEDIA will be returned by\r
280 // "MemoryTestInit". So it does not need to test memory again, just return.\r
281 //\r
282 FreePool (Pos);\r
283 return EFI_SUCCESS;\r
284 }\r
0a6f4824 285\r
2df686c6 286 if (!FeaturePcdGet(PcdBootlogoOnlyEnable)) {\r
287 TmpStr = GetStringById (STRING_TOKEN (STR_ESC_TO_SKIP_MEM_TEST));\r
5c08e117 288\r
2df686c6 289 if (TmpStr != NULL) {\r
290 PrintXY (10, 10, NULL, NULL, TmpStr);\r
291 FreePool (TmpStr);\r
292 }\r
293 } else {\r
294 DEBUG ((EFI_D_INFO, "Enter memory test.\n"));\r
5c08e117 295 }\r
5c08e117 296 do {\r
297 Status = GenMemoryTest->PerformMemoryTest (\r
298 GenMemoryTest,\r
299 &TestedMemorySize,\r
300 &TotalMemorySize,\r
301 &ErrorOut,\r
302 TestAbort\r
303 );\r
304 if (ErrorOut && (Status == EFI_DEVICE_ERROR)) {\r
305 TmpStr = GetStringById (STRING_TOKEN (STR_SYSTEM_MEM_ERROR));\r
306 if (TmpStr != NULL) {\r
307 PrintXY (10, 10, NULL, NULL, TmpStr);\r
5c08e117 308 FreePool (TmpStr);\r
309 }\r
310\r
311 ASSERT (0);\r
312 }\r
0a6f4824 313\r
2df686c6 314 if (!FeaturePcdGet(PcdBootlogoOnlyEnable)) {\r
315 TempData = (UINT32) DivU64x32 (TotalMemorySize, 16);\r
316 TestPercent = (UINTN) DivU64x32 (\r
317 DivU64x32 (MultU64x32 (TestedMemorySize, 100), 16),\r
318 TempData\r
319 );\r
320 if (TestPercent != PreviousValue) {\r
0438f5e2 321 UnicodeValueToStringS (StrPercent, sizeof (StrPercent), 0, TestPercent, 0);\r
2df686c6 322 TmpStr = GetStringById (STRING_TOKEN (STR_MEMORY_TEST_PERCENT));\r
323 if (TmpStr != NULL) {\r
324 //\r
325 // TmpStr size is 64, StrPercent is reserved to 16.\r
326 //\r
83daa931
HW
327 StrnCatS (\r
328 StrPercent,\r
0a6f4824 329 sizeof (StrPercent) / sizeof (CHAR16),\r
83daa931
HW
330 TmpStr,\r
331 sizeof (StrPercent) / sizeof (CHAR16) - StrLen (StrPercent) - 1\r
332 );\r
2df686c6 333 PrintXY (10, 10, NULL, NULL, StrPercent);\r
334 FreePool (TmpStr);\r
335 }\r
5c08e117 336\r
5c08e117 337 TmpStr = GetStringById (STRING_TOKEN (STR_PERFORM_MEM_TEST));\r
338 if (TmpStr != NULL) {\r
339 PlatformBdsShowProgress (\r
340 Foreground,\r
341 Background,\r
342 TmpStr,\r
343 Color,\r
2df686c6 344 TestPercent,\r
5c08e117 345 (UINTN) PreviousValue\r
346 );\r
347 FreePool (TmpStr);\r
348 }\r
2df686c6 349 }\r
350\r
351 PreviousValue = TestPercent;\r
352 } else {\r
353 DEBUG ((EFI_D_INFO, "Perform memory test (ESC to skip).\n"));\r
354 }\r
5c08e117 355\r
18cf3950 356 if (!PcdGetBool (PcdConInConnectOnDemand)) {\r
357 KeyStatus = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
358 if (!EFI_ERROR (KeyStatus) && (Key.ScanCode == SCAN_ESC)) {\r
359 if (!RequireSoftECCInit) {\r
360 if (!FeaturePcdGet(PcdBootlogoOnlyEnable)) {\r
361 TmpStr = GetStringById (STRING_TOKEN (STR_PERFORM_MEM_TEST));\r
362 if (TmpStr != NULL) {\r
363 PlatformBdsShowProgress (\r
364 Foreground,\r
365 Background,\r
366 TmpStr,\r
367 Color,\r
368 100,\r
369 (UINTN) PreviousValue\r
370 );\r
371 FreePool (TmpStr);\r
372 }\r
373\r
374 PrintXY (10, 10, NULL, NULL, L"100");\r
2df686c6 375 }\r
18cf3950 376 Status = GenMemoryTest->Finished (GenMemoryTest);\r
377 goto Done;\r
2df686c6 378 }\r
5c08e117 379\r
18cf3950 380 TestAbort = TRUE;\r
381 }\r
5c08e117 382 }\r
383 } while (Status != EFI_NOT_FOUND);\r
384\r
385 Status = GenMemoryTest->Finished (GenMemoryTest);\r
386\r
387Done:\r
2df686c6 388 if (!FeaturePcdGet(PcdBootlogoOnlyEnable)) {\r
0438f5e2 389 UnicodeValueToStringS (StrTotalMemory, StrTotalMemorySize, COMMA_TYPE, TotalMemorySize, 0);\r
2df686c6 390 if (StrTotalMemory[0] == L',') {\r
391 StrTotalMemory++;\r
a1360fa3 392 StrTotalMemorySize -= sizeof (CHAR16);\r
2df686c6 393 }\r
5c08e117 394\r
2df686c6 395 TmpStr = GetStringById (STRING_TOKEN (STR_MEM_TEST_COMPLETED));\r
396 if (TmpStr != NULL) {\r
83daa931
HW
397 StrnCatS (\r
398 StrTotalMemory,\r
399 StrTotalMemorySize / sizeof (CHAR16),\r
400 TmpStr,\r
401 StrTotalMemorySize / sizeof (CHAR16) - StrLen (StrTotalMemory) - 1\r
402 );\r
2df686c6 403 FreePool (TmpStr);\r
404 }\r
5c08e117 405\r
2df686c6 406 PrintXY (10, 10, NULL, NULL, StrTotalMemory);\r
407 PlatformBdsShowProgress (\r
408 Foreground,\r
409 Background,\r
410 StrTotalMemory,\r
411 Color,\r
412 100,\r
413 (UINTN) PreviousValue\r
414 );\r
0a6f4824 415\r
2df686c6 416 } else {\r
417 DEBUG ((EFI_D_INFO, "%d bytes of system memory tested OK\r\n", TotalMemorySize));\r
418 }\r
0a6f4824 419\r
5c08e117 420 FreePool (Pos);\r
421\r
2df686c6 422\r
08c4ca5b 423 //\r
424 // Use a DynamicHii type pcd to save the boot status, which is used to\r
425 // control configuration mode, such as FULL/MINIMAL/NO_CHANGES configuration.\r
426 //\r
427 IsFirstBoot = PcdGetBool(PcdBootState);\r
428 if (IsFirstBoot) {\r
84db9040
ED
429 Status = PcdSetBoolS(PcdBootState, FALSE);\r
430 if (EFI_ERROR (Status)) {\r
431 DEBUG ((EFI_D_ERROR, "Set PcdBootState to FALSE failed.\n"));\r
432 }\r
5c08e117 433 }\r
434\r
435 return ReturnStatus;\r
436}\r