]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
MdeModulePkg/CapsuleApp: Fix potential NULL pointer dereference issue
[mirror_edk2.git] / MdeModulePkg / Application / CapsuleApp / CapsuleDump.c
CommitLineData
592bad04
JY
1/** @file\r
2 Dump Capsule image information.\r
3\r
97473291 4 Copyright (c) 2016 - 2019, Intel Corporation. All rights reserved.<BR>\r
592bad04
JY
5 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
15#include <PiDxe.h>\r
16#include <Library/BaseLib.h>\r
17#include <Library/DebugLib.h>\r
18#include <Library/BaseMemoryLib.h>\r
19#include <Library/MemoryAllocationLib.h>\r
20#include <Library/UefiBootServicesTableLib.h>\r
21#include <Library/UefiRuntimeServicesTableLib.h>\r
22#include <Library/UefiLib.h>\r
23#include <Library/PrintLib.h>\r
97473291
CC
24#include <Library/FileHandleLib.h>\r
25#include <Library/SortLib.h>\r
26#include <Library/UefiBootManagerLib.h>\r
27#include <Library/DevicePathLib.h>\r
592bad04 28#include <Protocol/FirmwareManagement.h>\r
97473291
CC
29#include <Protocol/SimpleFileSystem.h>\r
30#include <Protocol/Shell.h>\r
592bad04
JY
31#include <Guid/ImageAuthentication.h>\r
32#include <Guid/CapsuleReport.h>\r
33#include <Guid/SystemResourceTable.h>\r
34#include <Guid/FmpCapsule.h>\r
97473291 35#include <Guid/CapsuleVendor.h>\r
592bad04
JY
36#include <IndustryStandard/WindowsUxCapsule.h>\r
37\r
97473291
CC
38//\r
39// (20 * (6+5+2))+1) unicode characters from EFI FAT spec (doubled for bytes)\r
40//\r
41#define MAX_FILE_NAME_SIZE 522\r
42#define MAX_FILE_NAME_LEN (MAX_FILE_NAME_SIZE / sizeof(CHAR16))\r
43\r
592bad04
JY
44/**\r
45 Read a file.\r
46\r
11ee1bc9
DB
47 @param[in] FileName The file to be read.\r
48 @param[out] BufferSize The file buffer size\r
49 @param[out] Buffer The file buffer\r
592bad04
JY
50\r
51 @retval EFI_SUCCESS Read file successfully\r
52 @retval EFI_NOT_FOUND File not found\r
53**/\r
54EFI_STATUS\r
55ReadFileToBuffer (\r
56 IN CHAR16 *FileName,\r
57 OUT UINTN *BufferSize,\r
58 OUT VOID **Buffer\r
59 );\r
60\r
1e09ec09
JY
61/**\r
62 Write a file.\r
63\r
64 @param[in] FileName The file to be written.\r
65 @param[in] BufferSize The file buffer size\r
66 @param[in] Buffer The file buffer\r
67\r
68 @retval EFI_SUCCESS Write file successfully\r
69**/\r
70EFI_STATUS\r
71WriteFileFromBuffer (\r
72 IN CHAR16 *FileName,\r
73 IN UINTN BufferSize,\r
74 IN VOID *Buffer\r
75 );\r
76\r
97473291
CC
77/**\r
78 Get shell protocol.\r
79\r
80 @return Pointer to shell protocol.\r
81\r
82**/\r
83EFI_SHELL_PROTOCOL *\r
84GetShellProtocol (\r
85 VOID\r
86 );\r
87\r
88/**\r
89 Get SimpleFileSystem from boot option file path.\r
90\r
91 @param[in] DevicePath The file path of boot option\r
92 @param[out] FullPath The full device path of boot device\r
93 @param[out] Fs The file system within EfiSysPartition\r
94\r
95 @retval EFI_SUCCESS Get file system successfully\r
96 @retval EFI_NOT_FOUND No valid file system found\r
97 @retval others Get file system failed\r
98\r
99**/\r
100EFI_STATUS\r
101EFIAPI\r
102GetEfiSysPartitionFromBootOptionFilePath (\r
103 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
104 OUT EFI_DEVICE_PATH_PROTOCOL **FullPath,\r
105 OUT EFI_SIMPLE_FILE_SYSTEM_PROTOCOL **Fs\r
106 );\r
107\r
fb57c30b
SZ
108/**\r
109 Validate if it is valid capsule header\r
110\r
111 This function assumes the caller provided correct CapsuleHeader pointer\r
112 and CapsuleSize.\r
113\r
114 This function validates the fields in EFI_CAPSULE_HEADER.\r
115\r
116 @param[in] CapsuleHeader Points to a capsule header.\r
117 @param[in] CapsuleSize Size of the whole capsule image.\r
118\r
119**/\r
120BOOLEAN\r
121IsValidCapsuleHeader (\r
122 IN EFI_CAPSULE_HEADER *CapsuleHeader,\r
123 IN UINT64 CapsuleSize\r
124 );\r
125\r
592bad04
JY
126/**\r
127 Dump UX capsule information.\r
128\r
129 @param[in] CapsuleHeader The UX capsule header\r
130**/\r
131VOID\r
132DumpUxCapsule (\r
133 IN EFI_CAPSULE_HEADER *CapsuleHeader\r
134 )\r
135{\r
136 EFI_DISPLAY_CAPSULE *DisplayCapsule;\r
137 DisplayCapsule = (EFI_DISPLAY_CAPSULE *)CapsuleHeader;\r
138 Print(L"[UxCapusule]\n");\r
139 Print(L"CapsuleHeader:\n");\r
140 Print(L" CapsuleGuid - %g\n", &DisplayCapsule->CapsuleHeader.CapsuleGuid);\r
141 Print(L" HeaderSize - 0x%x\n", DisplayCapsule->CapsuleHeader.HeaderSize);\r
142 Print(L" Flags - 0x%x\n", DisplayCapsule->CapsuleHeader.Flags);\r
143 Print(L" CapsuleImageSize - 0x%x\n", DisplayCapsule->CapsuleHeader.CapsuleImageSize);\r
144 Print(L"ImagePayload:\n");\r
145 Print(L" Version - 0x%x\n", DisplayCapsule->ImagePayload.Version);\r
146 Print(L" Checksum - 0x%x\n", DisplayCapsule->ImagePayload.Checksum);\r
147 Print(L" ImageType - 0x%x\n", DisplayCapsule->ImagePayload.ImageType);\r
148 Print(L" Mode - 0x%x\n", DisplayCapsule->ImagePayload.Mode);\r
149 Print(L" OffsetX - 0x%x\n", DisplayCapsule->ImagePayload.OffsetX);\r
150 Print(L" OffsetY - 0x%x\n", DisplayCapsule->ImagePayload.OffsetY);\r
151}\r
152\r
592bad04
JY
153\r
154/**\r
155 Dump a non-nested FMP capsule.\r
156\r
157 @param[in] CapsuleHeader A pointer to CapsuleHeader\r
158**/\r
159VOID\r
160DumpFmpCapsule (\r
161 IN EFI_CAPSULE_HEADER *CapsuleHeader\r
162 )\r
163{\r
164 EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER *FmpCapsuleHeader;\r
165 UINT64 *ItemOffsetList;\r
166 UINTN Index;\r
167 UINTN Count;\r
168 EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER *FmpImageHeader;\r
169\r
97473291 170 Print(L"[FmpCapsule]\n");\r
592bad04
JY
171 Print(L"CapsuleHeader:\n");\r
172 Print(L" CapsuleGuid - %g\n", &CapsuleHeader->CapsuleGuid);\r
173 Print(L" HeaderSize - 0x%x\n", CapsuleHeader->HeaderSize);\r
174 Print(L" Flags - 0x%x\n", CapsuleHeader->Flags);\r
175 Print(L" CapsuleImageSize - 0x%x\n", CapsuleHeader->CapsuleImageSize);\r
176\r
177 FmpCapsuleHeader = (EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER *)((UINT8 *)CapsuleHeader + CapsuleHeader->HeaderSize);\r
178 ItemOffsetList = (UINT64 *)(FmpCapsuleHeader + 1);\r
179 Print(L"FmpHeader:\n");\r
180 Print(L" Version - 0x%x\n", FmpCapsuleHeader->Version);\r
181 Print(L" EmbeddedDriverCount - 0x%x\n", FmpCapsuleHeader->EmbeddedDriverCount);\r
182 Print(L" PayloadItemCount - 0x%x\n", FmpCapsuleHeader->PayloadItemCount);\r
183 Count = FmpCapsuleHeader->EmbeddedDriverCount + FmpCapsuleHeader->PayloadItemCount;\r
184 for (Index = 0; Index < Count; Index++) {\r
185 Print(L" Offset[%d] - 0x%x\n", Index, ItemOffsetList[Index]);\r
186 }\r
187\r
188 for (Index = FmpCapsuleHeader->EmbeddedDriverCount; Index < Count; Index++) {\r
189 Print(L"FmpPayload[%d] ImageHeader:\n", Index);\r
190 FmpImageHeader = (EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER *)((UINT8 *)FmpCapsuleHeader + ItemOffsetList[Index]);\r
191 Print(L" Version - 0x%x\n", FmpImageHeader->Version);\r
192 Print(L" UpdateImageTypeId - %g\n", &FmpImageHeader->UpdateImageTypeId);\r
193 Print(L" UpdateImageIndex - 0x%x\n", FmpImageHeader->UpdateImageIndex);\r
194 Print(L" UpdateImageSize - 0x%x\n", FmpImageHeader->UpdateImageSize);\r
195 Print(L" UpdateVendorCodeSize - 0x%x\n", FmpImageHeader->UpdateVendorCodeSize);\r
196 if (FmpImageHeader->Version >= EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER_INIT_VERSION) {\r
197 Print(L" UpdateHardwareInstance - 0x%lx\n", FmpImageHeader->UpdateHardwareInstance);\r
198 }\r
199 }\r
200}\r
201\r
202/**\r
203 Return if there is a FMP header below capsule header.\r
204\r
205 @param[in] CapsuleHeader A pointer to EFI_CAPSULE_HEADER\r
206\r
207 @retval TRUE There is a FMP header below capsule header.\r
208 @retval FALSE There is not a FMP header below capsule header\r
209**/\r
210BOOLEAN\r
211IsNestedFmpCapsule (\r
212 IN EFI_CAPSULE_HEADER *CapsuleHeader\r
213 )\r
214{\r
215 EFI_STATUS Status;\r
216 EFI_SYSTEM_RESOURCE_TABLE *Esrt;\r
217 EFI_SYSTEM_RESOURCE_ENTRY *EsrtEntry;\r
218 UINTN Index;\r
219 BOOLEAN EsrtGuidFound;\r
220 EFI_CAPSULE_HEADER *NestedCapsuleHeader;\r
221 UINTN NestedCapsuleSize;\r
222\r
223 //\r
224 // Check ESRT\r
225 //\r
226 EsrtGuidFound = FALSE;\r
227 Status = EfiGetSystemConfigurationTable(&gEfiSystemResourceTableGuid, (VOID **)&Esrt);\r
228 if (!EFI_ERROR(Status)) {\r
229 ASSERT (Esrt != NULL);\r
230 EsrtEntry = (VOID *)(Esrt + 1);\r
231 for (Index = 0; Index < Esrt->FwResourceCount; Index++, EsrtEntry++) {\r
232 if (CompareGuid(&EsrtEntry->FwClass, &CapsuleHeader->CapsuleGuid)) {\r
233 EsrtGuidFound = TRUE;\r
234 break;\r
235 }\r
236 }\r
237 }\r
238\r
239 if (!EsrtGuidFound) {\r
240 return FALSE;\r
241 }\r
242\r
243 //\r
244 // Check nested capsule header\r
245 // FMP GUID after ESRT one\r
246 //\r
247 NestedCapsuleHeader = (EFI_CAPSULE_HEADER *)((UINT8 *)CapsuleHeader + CapsuleHeader->HeaderSize);\r
23d08334 248 NestedCapsuleSize = (UINTN)CapsuleHeader + CapsuleHeader->CapsuleImageSize- (UINTN)NestedCapsuleHeader;\r
592bad04
JY
249 if (NestedCapsuleSize < sizeof(EFI_CAPSULE_HEADER)) {\r
250 return FALSE;\r
251 }\r
252 if (!CompareGuid(&NestedCapsuleHeader->CapsuleGuid, &gEfiFmpCapsuleGuid)) {\r
253 return FALSE;\r
254 }\r
255 return TRUE;\r
256}\r
257\r
258/**\r
259 Dump capsule information\r
260\r
261 @param[in] CapsuleName The name of the capsule image.\r
262\r
263 @retval EFI_SUCCESS The capsule information is dumped.\r
264 @retval EFI_UNSUPPORTED Input parameter is not valid.\r
265**/\r
266EFI_STATUS\r
267DumpCapsule (\r
268 IN CHAR16 *CapsuleName\r
269 )\r
270{\r
271 VOID *Buffer;\r
272 UINTN FileSize;\r
273 EFI_CAPSULE_HEADER *CapsuleHeader;\r
274 EFI_STATUS Status;\r
275\r
2e3032b4 276 Buffer = NULL;\r
592bad04
JY
277 Status = ReadFileToBuffer(CapsuleName, &FileSize, &Buffer);\r
278 if (EFI_ERROR(Status)) {\r
279 Print(L"CapsuleApp: Capsule (%s) is not found.\n", CapsuleName);\r
280 goto Done;\r
281 }\r
fb57c30b
SZ
282 if (!IsValidCapsuleHeader (Buffer, FileSize)) {\r
283 Print(L"CapsuleApp: Capsule image (%s) is not a valid capsule.\n", CapsuleName);\r
284 Status = EFI_INVALID_PARAMETER;\r
285 goto Done;\r
286 }\r
592bad04
JY
287\r
288 CapsuleHeader = Buffer;\r
289 if (CompareGuid(&CapsuleHeader->CapsuleGuid, &gWindowsUxCapsuleGuid)) {\r
290 DumpUxCapsule(CapsuleHeader);\r
291 Status = EFI_SUCCESS;\r
292 goto Done;\r
293 }\r
294\r
295 if (CompareGuid(&CapsuleHeader->CapsuleGuid, &gEfiFmpCapsuleGuid)) {\r
296 DumpFmpCapsule(CapsuleHeader);\r
297 }\r
298 if (IsNestedFmpCapsule(CapsuleHeader)) {\r
299 Print(L"[NestedCapusule]\n");\r
300 Print(L"CapsuleHeader:\n");\r
301 Print(L" CapsuleGuid - %g\n", &CapsuleHeader->CapsuleGuid);\r
302 Print(L" HeaderSize - 0x%x\n", CapsuleHeader->HeaderSize);\r
303 Print(L" Flags - 0x%x\n", CapsuleHeader->Flags);\r
304 Print(L" CapsuleImageSize - 0x%x\n", CapsuleHeader->CapsuleImageSize);\r
305 DumpFmpCapsule((EFI_CAPSULE_HEADER *)((UINTN)CapsuleHeader + CapsuleHeader->HeaderSize));\r
306 }\r
307\r
308Done:\r
2e3032b4
SZ
309 if (Buffer != NULL) {\r
310 FreePool(Buffer);\r
311 }\r
592bad04
JY
312 return Status;\r
313}\r
314\r
315/**\r
316 Dump capsule status variable.\r
317\r
318 @retval EFI_SUCCESS The capsule status variable is dumped.\r
319 @retval EFI_UNSUPPORTED Input parameter is not valid.\r
320**/\r
321EFI_STATUS\r
8b03c82d 322DumpCapsuleStatusVariable (\r
592bad04
JY
323 VOID\r
324 )\r
325{\r
326 EFI_STATUS Status;\r
327 UINT32 Index;\r
328 CHAR16 CapsuleVarName[20];\r
329 CHAR16 *TempVarName;\r
330 EFI_CAPSULE_RESULT_VARIABLE_HEADER *CapsuleResult;\r
331 EFI_CAPSULE_RESULT_VARIABLE_FMP *CapsuleResultFmp;\r
332 UINTN CapsuleFileNameSize;\r
333 CHAR16 CapsuleIndexData[12];\r
334 CHAR16 *CapsuleIndex;\r
de5209d5
JY
335 CHAR16 *CapsuleFileName;\r
336 CHAR16 *CapsuleTarget;\r
592bad04
JY
337\r
338 Status = GetVariable2(\r
339 L"CapsuleMax",\r
340 &gEfiCapsuleReportGuid,\r
341 (VOID **)&CapsuleIndex,\r
342 NULL\r
343 );\r
344 if (!EFI_ERROR(Status)) {\r
a522ad7c 345 ASSERT (CapsuleIndex != NULL);\r
592bad04
JY
346 CopyMem(CapsuleIndexData, CapsuleIndex, 11 * sizeof(CHAR16));\r
347 CapsuleIndexData[11] = 0;\r
348 Print(L"CapsuleMax - %s\n", CapsuleIndexData);\r
349 FreePool(CapsuleIndex);\r
350 }\r
351 Status = GetVariable2(\r
352 L"CapsuleLast",\r
353 &gEfiCapsuleReportGuid,\r
354 (VOID **)&CapsuleIndex,\r
355 NULL\r
356 );\r
357 if (!EFI_ERROR(Status)) {\r
a522ad7c 358 ASSERT (CapsuleIndex != NULL);\r
592bad04
JY
359 CopyMem(CapsuleIndexData, CapsuleIndex, 11 * sizeof(CHAR16));\r
360 CapsuleIndexData[11] = 0;\r
361 Print(L"CapsuleLast - %s\n", CapsuleIndexData);\r
362 FreePool(CapsuleIndex);\r
363 }\r
364\r
365\r
366 StrCpyS (CapsuleVarName, sizeof(CapsuleVarName)/sizeof(CapsuleVarName[0]), L"Capsule");\r
367 TempVarName = CapsuleVarName + StrLen (CapsuleVarName);\r
368 Index = 0;\r
369\r
370 while (TRUE) {\r
371 UnicodeSPrint (TempVarName, 5 * sizeof(CHAR16), L"%04x", Index);\r
372\r
373 Status = GetVariable2 (\r
374 CapsuleVarName,\r
375 &gEfiCapsuleReportGuid,\r
376 (VOID **) &CapsuleResult,\r
377 NULL\r
378 );\r
379 if (Status == EFI_NOT_FOUND) {\r
380 break;\r
381 } else if (EFI_ERROR(Status)) {\r
382 continue;\r
383 }\r
384 ASSERT (CapsuleResult != NULL);\r
385\r
386 //\r
387 // display capsule process status\r
388 //\r
389 if (CapsuleResult->VariableTotalSize >= sizeof(EFI_CAPSULE_RESULT_VARIABLE_HEADER)) {\r
390 Print (L"CapsuleName: %s\n", CapsuleVarName);\r
391 Print (L" Capsule Guid: %g\n", &CapsuleResult->CapsuleGuid);\r
392 Print (L" Capsule ProcessedTime: %t\n", &CapsuleResult->CapsuleProcessed);\r
393 Print (L" Capsule Status: %r\n", CapsuleResult->CapsuleStatus);\r
394 }\r
395\r
396 if (CompareGuid(&CapsuleResult->CapsuleGuid, &gEfiFmpCapsuleGuid)) {\r
de5209d5 397 if (CapsuleResult->VariableTotalSize >= sizeof(EFI_CAPSULE_RESULT_VARIABLE_HEADER) + sizeof(EFI_CAPSULE_RESULT_VARIABLE_FMP) + sizeof(CHAR16) * 2) {\r
592bad04
JY
398 CapsuleResultFmp = (EFI_CAPSULE_RESULT_VARIABLE_FMP *)(CapsuleResult + 1);\r
399 Print(L" Capsule FMP Version: 0x%x\n", CapsuleResultFmp->Version);\r
400 Print(L" Capsule FMP PayloadIndex: 0x%x\n", CapsuleResultFmp->PayloadIndex);\r
401 Print(L" Capsule FMP UpdateImageIndex: 0x%x\n", CapsuleResultFmp->UpdateImageIndex);\r
402 Print(L" Capsule FMP UpdateImageTypeId: %g\n", &CapsuleResultFmp->UpdateImageTypeId);\r
de5209d5
JY
403 CapsuleFileName = (CHAR16 *)(CapsuleResultFmp + 1);\r
404 Print(L" Capsule FMP CapsuleFileName: \"%s\"\n", CapsuleFileName);\r
405 CapsuleFileNameSize = StrSize(CapsuleFileName);\r
406 CapsuleTarget = (CHAR16 *)((UINTN)CapsuleFileName + CapsuleFileNameSize);\r
407 Print(L" Capsule FMP CapsuleTarget: \"%s\"\n", CapsuleTarget);\r
592bad04
JY
408 }\r
409 }\r
410\r
411 FreePool(CapsuleResult);\r
412\r
413 Index++;\r
414 if (Index > 0xFFFF) {\r
415 break;\r
416 }\r
417 }\r
418\r
419 return EFI_SUCCESS;\r
420}\r
421\r
422CHAR8 *mFwTypeString[] = {\r
423 "Unknown",\r
424 "SystemFirmware",\r
425 "DeviceFirmware",\r
426 "UefiDriver",\r
427};\r
428\r
429CHAR8 *mLastAttemptStatusString[] = {\r
430 "Success",\r
431 "Error: Unsuccessful",\r
432 "Error: Insufficient Resources",\r
433 "Error: Incorrect Version",\r
434 "Error: Invalid Format",\r
435 "Error: Auth Error",\r
436 "Error: Power Event AC",\r
437 "Error: Power Event Battery",\r
438};\r
439\r
440/**\r
441 Convert FwType to a string.\r
442\r
443 @param[in] FwType FwType in ESRT\r
444\r
445 @return a string for FwType.\r
446**/\r
447CHAR8 *\r
448FwTypeToString (\r
449 IN UINT32 FwType\r
450 )\r
451{\r
452 if (FwType < sizeof(mFwTypeString) / sizeof(mFwTypeString[0])) {\r
453 return mFwTypeString[FwType];\r
454 } else {\r
455 return "Invalid";\r
456 }\r
457}\r
458\r
459/**\r
460 Convert LastAttemptStatus to a string.\r
461\r
462 @param[in] LastAttemptStatus LastAttemptStatus in FMP or ESRT\r
463\r
464 @return a string for LastAttemptStatus.\r
465**/\r
466CHAR8 *\r
467LastAttemptStatusToString (\r
468 IN UINT32 LastAttemptStatus\r
469 )\r
470{\r
471 if (LastAttemptStatus < sizeof(mLastAttemptStatusString) / sizeof(mLastAttemptStatusString[0])) {\r
472 return mLastAttemptStatusString[LastAttemptStatus];\r
473 } else {\r
474 return "Error: Unknown";\r
475 }\r
476}\r
477\r
478/**\r
479 Dump ESRT entry.\r
480\r
481 @param[in] EsrtEntry ESRT entry\r
482**/\r
483VOID\r
484DumpEsrtEntry (\r
485 IN EFI_SYSTEM_RESOURCE_ENTRY *EsrtEntry\r
486 )\r
487{\r
488 Print(L" FwClass - %g\n", &EsrtEntry->FwClass);\r
489 Print(L" FwType - 0x%x (%a)\n", EsrtEntry->FwType, FwTypeToString(EsrtEntry->FwType));\r
490 Print(L" FwVersion - 0x%x\n", EsrtEntry->FwVersion);\r
491 Print(L" LowestSupportedFwVersion - 0x%x\n", EsrtEntry->LowestSupportedFwVersion);\r
492 Print(L" CapsuleFlags - 0x%x\n", EsrtEntry->CapsuleFlags);\r
592bad04
JY
493 Print(L" LastAttemptVersion - 0x%x\n", EsrtEntry->LastAttemptVersion);\r
494 Print(L" LastAttemptStatus - 0x%x (%a)\n", EsrtEntry->LastAttemptStatus, LastAttemptStatusToString(EsrtEntry->LastAttemptStatus));\r
495}\r
496\r
497/**\r
498 Dump ESRT table.\r
499\r
500 @param[in] Esrt ESRT table\r
501**/\r
502VOID\r
503DumpEsrt (\r
504 IN EFI_SYSTEM_RESOURCE_TABLE *Esrt\r
505 )\r
506{\r
507 UINTN Index;\r
508 EFI_SYSTEM_RESOURCE_ENTRY *EsrtEntry;\r
509\r
510 if (Esrt == NULL) {\r
511 return ;\r
512 }\r
513\r
514 Print(L"EFI_SYSTEM_RESOURCE_TABLE:\n");\r
515 Print(L"FwResourceCount - 0x%x\n", Esrt->FwResourceCount);\r
516 Print(L"FwResourceCountMax - 0x%x\n", Esrt->FwResourceCountMax);\r
517 Print(L"FwResourceVersion - 0x%lx\n", Esrt->FwResourceVersion);\r
518\r
519 EsrtEntry = (VOID *)(Esrt + 1);\r
520 for (Index = 0; Index < Esrt->FwResourceCount; Index++) {\r
521 Print(L"EFI_SYSTEM_RESOURCE_ENTRY (%d):\n", Index);\r
522 DumpEsrtEntry(EsrtEntry);\r
523 EsrtEntry++;\r
524 }\r
525}\r
526\r
527/**\r
528 Dump ESRT info.\r
529**/\r
530VOID\r
531DumpEsrtData (\r
532 VOID\r
533 )\r
534{\r
535 EFI_STATUS Status;\r
536 EFI_SYSTEM_RESOURCE_TABLE *Esrt;\r
537\r
538 Print(L"##############\n");\r
539 Print(L"# ESRT TABLE #\n");\r
540 Print(L"##############\n");\r
541\r
542 Status = EfiGetSystemConfigurationTable (&gEfiSystemResourceTableGuid, (VOID **)&Esrt);\r
543 if (EFI_ERROR(Status)) {\r
544 Print(L"ESRT - %r\n", Status);\r
545 return;\r
546 }\r
547 DumpEsrt(Esrt);\r
548 Print(L"\n");\r
549}\r
550\r
97473291
CC
551\r
552/**\r
553 Dump capsule information from CapsuleHeader\r
554\r
555 @param[in] CapsuleHeader The CapsuleHeader of the capsule image.\r
556\r
557 @retval EFI_SUCCESS The capsule information is dumped.\r
558\r
559**/\r
560EFI_STATUS\r
561DumpCapsuleFromBuffer (\r
562 IN EFI_CAPSULE_HEADER *CapsuleHeader\r
563 )\r
564{\r
565 if (CompareGuid (&CapsuleHeader->CapsuleGuid, &gWindowsUxCapsuleGuid)) {\r
566 DumpUxCapsule (CapsuleHeader);\r
567 return EFI_SUCCESS;\r
568 }\r
569\r
570 if (CompareGuid (&CapsuleHeader->CapsuleGuid, &gEfiFmpCapsuleGuid)) {\r
571 DumpFmpCapsule (CapsuleHeader);\r
572 }\r
573 if (IsNestedFmpCapsule (CapsuleHeader)) {\r
574 Print (L"[NestedCapusule]\n");\r
575 Print (L"CapsuleHeader:\n");\r
576 Print (L" CapsuleGuid - %g\n", &CapsuleHeader->CapsuleGuid);\r
577 Print (L" HeaderSize - 0x%x\n", CapsuleHeader->HeaderSize);\r
578 Print (L" Flags - 0x%x\n", CapsuleHeader->Flags);\r
579 Print (L" CapsuleImageSize - 0x%x\n", CapsuleHeader->CapsuleImageSize);\r
580 DumpFmpCapsule ((EFI_CAPSULE_HEADER *)((UINTN)CapsuleHeader + CapsuleHeader->HeaderSize));\r
581 }\r
582\r
583 return EFI_SUCCESS;\r
584}\r
585\r
586/**\r
587 This routine is called to upper case given unicode string.\r
588\r
589 @param[in] Str String to upper case\r
590\r
591 @retval upper cased string after process\r
592\r
593**/\r
594STATIC\r
595CHAR16 *\r
596UpperCaseString (\r
597 IN CHAR16 *Str\r
598 )\r
599{\r
600 CHAR16 *Cptr;\r
601\r
602 for (Cptr = Str; *Cptr != L'\0'; Cptr++) {\r
603 if (L'a' <= *Cptr && *Cptr <= L'z') {\r
604 *Cptr = *Cptr - L'a' + L'A';\r
605 }\r
606 }\r
607\r
608 return Str;\r
609}\r
610\r
611/**\r
612 This routine is used to return substring before period '.' or '\0'\r
613 Caller should respsonsible of substr space allocation & free\r
614\r
615 @param[in] Str String to check\r
616 @param[out] SubStr First part of string before period or '\0'\r
617 @param[out] SubStrLen Length of first part of string\r
618\r
619**/\r
620STATIC\r
621VOID\r
622GetSubStringBeforePeriod (\r
623 IN CHAR16 *Str,\r
624 OUT CHAR16 *SubStr,\r
625 OUT UINTN *SubStrLen\r
626 )\r
627{\r
628 UINTN Index;\r
629 for (Index = 0; Str[Index] != L'.' && Str[Index] != L'\0'; Index++) {\r
630 SubStr[Index] = Str[Index];\r
631 }\r
632\r
633 SubStr[Index] = L'\0';\r
634 *SubStrLen = Index;\r
635}\r
636\r
637/**\r
638 This routine pad the string in tail with input character.\r
639\r
640 @param[in] StrBuf Str buffer to be padded, should be enough room for\r
641 @param[in] PadLen Expected padding length\r
642 @param[in] Character Character used to pad\r
643\r
644**/\r
645STATIC\r
646VOID\r
647PadStrInTail (\r
648 IN CHAR16 *StrBuf,\r
649 IN UINTN PadLen,\r
650 IN CHAR16 Character\r
651 )\r
652{\r
653 UINTN Index;\r
654\r
655 for (Index = 0; StrBuf[Index] != L'\0'; Index++);\r
656\r
657 while(PadLen != 0) {\r
658 StrBuf[Index] = Character;\r
659 Index++;\r
660 PadLen--;\r
661 }\r
662\r
663 StrBuf[Index] = L'\0';\r
664}\r
665\r
666/**\r
667 This routine find the offset of the last period '.' of string. if No period exists\r
668 function FileNameExtension is set to L'\0'\r
669\r
670 @param[in] FileName File name to split between last period\r
671 @param[out] FileNameFirst First FileName before last period\r
672 @param[out] FileNameExtension FileName after last period\r
673\r
674**/\r
675STATIC\r
676VOID\r
677SplitFileNameExtension (\r
678 IN CHAR16 *FileName,\r
679 OUT CHAR16 *FileNameFirst,\r
680 OUT CHAR16 *FileNameExtension\r
681 )\r
682{\r
683 UINTN Index;\r
684 UINTN StringLen;\r
685\r
686 StringLen = StrLen(FileName);\r
687 for (Index = StringLen; Index > 0 && FileName[Index] != L'.'; Index--);\r
688\r
689 //\r
690 // No period exists. No FileName Extension\r
691 //\r
692 if (Index == 0 && FileName[Index] != L'.') {\r
693 FileNameExtension[0] = L'\0';\r
694 Index = StringLen;\r
695 } else {\r
696 StrCpyS (FileNameExtension, MAX_FILE_NAME_LEN, &FileName[Index+1]);\r
697 }\r
698\r
699 //\r
700 // Copy First file name\r
701 //\r
702 StrnCpyS (FileNameFirst, MAX_FILE_NAME_LEN, FileName, Index);\r
703 FileNameFirst[Index] = L'\0';\r
704}\r
705\r
706/**\r
707 The function is called by PerformQuickSort to sort file name in alphabet.\r
708\r
709 @param[in] Left The pointer to first buffer.\r
710 @param[in] Right The pointer to second buffer.\r
711\r
712 @retval 0 Buffer1 equal to Buffer2.\r
713 @return <0 Buffer1 is less than Buffer2.\r
714 @return >0 Buffer1 is greater than Buffer2.\r
715\r
716**/\r
717INTN\r
718EFIAPI\r
719CompareFileNameInAlphabet (\r
720 IN VOID *Left,\r
721 IN VOID *Right\r
722 )\r
723{\r
724 EFI_FILE_INFO *FileInfo1;\r
725 EFI_FILE_INFO *FileInfo2;\r
726 CHAR16 FileName1[MAX_FILE_NAME_SIZE];\r
727 CHAR16 FileExtension1[MAX_FILE_NAME_SIZE];\r
728 CHAR16 FileName2[MAX_FILE_NAME_SIZE];\r
729 CHAR16 FileExtension2[MAX_FILE_NAME_SIZE];\r
730 CHAR16 TempSubStr1[MAX_FILE_NAME_SIZE];\r
731 CHAR16 TempSubStr2[MAX_FILE_NAME_SIZE];\r
732 UINTN SubStrLen1;\r
733 UINTN SubStrLen2;\r
734 INTN SubStrCmpResult;\r
735\r
736 FileInfo1 = (EFI_FILE_INFO *) (*(UINTN *)Left);\r
737 FileInfo2 = (EFI_FILE_INFO *) (*(UINTN *)Right);\r
738\r
739 SplitFileNameExtension (FileInfo1->FileName, FileName1, FileExtension1);\r
740 SplitFileNameExtension (FileInfo2->FileName, FileName2, FileExtension2);\r
741\r
742 UpperCaseString (FileName1);\r
743 UpperCaseString (FileName2);\r
744\r
745 GetSubStringBeforePeriod (FileName1, TempSubStr1, &SubStrLen1);\r
746 GetSubStringBeforePeriod (FileName2, TempSubStr2, &SubStrLen2);\r
747\r
748 if (SubStrLen1 > SubStrLen2) {\r
749 //\r
750 // Substr in NewFileName is longer. Pad tail with SPACE\r
751 //\r
752 PadStrInTail (TempSubStr2, SubStrLen1 - SubStrLen2, L' ');\r
753 } else if (SubStrLen1 < SubStrLen2){\r
754 //\r
755 // Substr in ListedFileName is longer. Pad tail with SPACE\r
756 //\r
757 PadStrInTail (TempSubStr1, SubStrLen2 - SubStrLen1, L' ');\r
758 }\r
759\r
760 SubStrCmpResult = StrnCmp (TempSubStr1, TempSubStr2, MAX_FILE_NAME_LEN);\r
761 if (SubStrCmpResult != 0) {\r
762 return SubStrCmpResult;\r
763 }\r
764\r
765 UpperCaseString (FileExtension1);\r
766 UpperCaseString (FileExtension2);\r
767\r
768 return StrnCmp (FileExtension1, FileExtension2, MAX_FILE_NAME_LEN);\r
769}\r
770\r
771/**\r
772 Dump capsule information from disk.\r
773\r
774 @param[in] Fs The device path of disk.\r
775 @param[in] DumpCapsuleInfo The flag to indicate whether to dump the capsule inforomation.\r
776\r
777 @retval EFI_SUCCESS The capsule information is dumped.\r
778\r
779**/\r
780EFI_STATUS\r
781DumpCapsuleFromDisk (\r
782 IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Fs,\r
783 IN BOOLEAN DumpCapsuleInfo\r
784 )\r
785{\r
786 EFI_STATUS Status;\r
787 EFI_FILE *Root;\r
788 EFI_FILE *DirHandle;\r
789 EFI_FILE *FileHandle;\r
790 UINTN Index;\r
791 UINTN FileSize;\r
792 VOID *FileBuffer;\r
793 EFI_FILE_INFO **FileInfoBuffer;\r
794 EFI_FILE_INFO *FileInfo;\r
795 UINTN FileCount;\r
796 BOOLEAN NoFile;\r
797\r
e98212cb
CC
798 DirHandle = NULL;\r
799 FileHandle = NULL;\r
800 Index = 0;\r
801 FileInfoBuffer = NULL;\r
802 FileInfo = NULL;\r
803 FileCount = 0;\r
804 NoFile = FALSE;\r
97473291
CC
805\r
806 Status = Fs->OpenVolume (Fs, &Root);\r
807 if (EFI_ERROR (Status)) {\r
808 Print (L"Cannot open volume. Status = %r\n", Status);\r
809 return EFI_NOT_FOUND;\r
810 }\r
811\r
812 Status = Root->Open (Root, &DirHandle, EFI_CAPSULE_FILE_DIRECTORY, EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE , 0);\r
813 if (EFI_ERROR (Status)) {\r
814 Print (L"Cannot open %s. Status = %r\n", EFI_CAPSULE_FILE_DIRECTORY, Status);\r
815 return EFI_NOT_FOUND;\r
816 }\r
817\r
818 //\r
819 // Get file count first\r
820 //\r
821 for ( Status = FileHandleFindFirstFile (DirHandle, &FileInfo)\r
822 ; !EFI_ERROR(Status) && !NoFile\r
823 ; Status = FileHandleFindNextFile (DirHandle, FileInfo, &NoFile)\r
824 ){\r
825 if ((FileInfo->Attribute & (EFI_FILE_SYSTEM | EFI_FILE_ARCHIVE)) == 0) {\r
826 continue;\r
827 }\r
828 FileCount++;\r
829 }\r
830\r
831 if (FileCount == 0) {\r
832 Print (L"Error: No capsule file found!\n");\r
833 return EFI_NOT_FOUND;\r
834 }\r
835\r
836 FileInfoBuffer = AllocatePool (sizeof(FileInfo) * FileCount);\r
837 NoFile = FALSE;\r
838\r
839 //\r
840 // Get all file info\r
841 //\r
842 for ( Status = FileHandleFindFirstFile (DirHandle, &FileInfo)\r
843 ; !EFI_ERROR (Status) && !NoFile\r
844 ; Status = FileHandleFindNextFile (DirHandle, FileInfo, &NoFile)\r
845 ){\r
846 if ((FileInfo->Attribute & (EFI_FILE_SYSTEM | EFI_FILE_ARCHIVE)) == 0) {\r
847 continue;\r
848 }\r
849 FileInfoBuffer[Index++] = AllocateCopyPool ((UINTN)FileInfo->Size, FileInfo);\r
850 }\r
851\r
852 //\r
853 // Sort FileInfoBuffer by alphabet order\r
854 //\r
855 PerformQuickSort (\r
856 FileInfoBuffer,\r
857 FileCount,\r
858 sizeof (FileInfo),\r
859 (SORT_COMPARE) CompareFileNameInAlphabet\r
860 );\r
861\r
862 Print (L"The capsules will be performed by following order:\n");\r
863\r
864 for (Index = 0; Index < FileCount; Index++) {\r
865 Print (L" %d.%s\n", Index + 1, FileInfoBuffer[Index]->FileName);\r
866 }\r
867\r
868 if (!DumpCapsuleInfo) {\r
869 return EFI_SUCCESS;\r
870 }\r
871\r
872 Print(L"The infomation of the capsules:\n");\r
873\r
874 for (Index = 0; Index < FileCount; Index++) {\r
875 FileHandle = NULL;\r
876 Status = DirHandle->Open (DirHandle, &FileHandle, FileInfoBuffer[Index]->FileName, EFI_FILE_MODE_READ, 0);\r
877 if (EFI_ERROR (Status)) {\r
878 break;\r
879 }\r
880\r
881 Status = FileHandleGetSize (FileHandle, (UINT64 *) &FileSize);\r
882 if (EFI_ERROR (Status)) {\r
883 Print (L"Cannot read file %s. Status = %r\n", FileInfoBuffer[Index]->FileName, Status);\r
884 FileHandleClose (FileHandle);\r
885 return Status;\r
886 }\r
887\r
888 FileBuffer = AllocatePool (FileSize);\r
889 if (FileBuffer == NULL) {\r
890 return RETURN_OUT_OF_RESOURCES;\r
891 }\r
892\r
893 Status = FileHandleRead (FileHandle, &FileSize, FileBuffer);\r
894 if (EFI_ERROR (Status)) {\r
895 Print (L"Cannot read file %s. Status = %r\n", FileInfoBuffer[Index]->FileName, Status);\r
896 FreePool (FileBuffer);\r
897 FileHandleClose (FileHandle);\r
898 return Status;\r
899 }\r
900\r
901 Print (L"**************************\n");\r
902 Print (L" %d.%s:\n", Index + 1, FileInfoBuffer[Index]->FileName);\r
903 Print (L"**************************\n");\r
904 DumpCapsuleFromBuffer ((EFI_CAPSULE_HEADER *) FileBuffer);\r
905 FileHandleClose (FileHandle);\r
906 FreePool (FileBuffer);\r
907 }\r
908\r
909 return EFI_SUCCESS;\r
910}\r
911\r
912/**\r
913 Dump capsule inforomation form Gather list.\r
914\r
915 @param[in] BlockDescriptors The block descriptors for the capsule images\r
916 @param[in] DumpCapsuleInfo The flag to indicate whether to dump the capsule inforomation.\r
917\r
918**/\r
919VOID\r
920DumpBlockDescriptors (\r
921 IN EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockDescriptors,\r
922 IN BOOLEAN DumpCapsuleInfo\r
923 )\r
924{\r
925 EFI_CAPSULE_BLOCK_DESCRIPTOR *TempBlockPtr;\r
926\r
927 TempBlockPtr = BlockDescriptors;\r
928\r
929 while (TRUE) {\r
930 if (TempBlockPtr->Length != 0) {\r
931 if (DumpCapsuleInfo) {\r
932 Print(L"******************************************************\n");\r
933 }\r
934 Print(L"Capsule data starts at 0x%08x with size 0x%08x\n", TempBlockPtr->Union.DataBlock, TempBlockPtr->Length);\r
935 if (DumpCapsuleInfo) {\r
936 Print(L"******************************************************\n");\r
937 DumpCapsuleFromBuffer ((EFI_CAPSULE_HEADER *) (UINTN) TempBlockPtr->Union.DataBlock);\r
938 }\r
939 TempBlockPtr += 1;\r
940 } else {\r
941 if (TempBlockPtr->Union.ContinuationPointer == (UINTN)NULL) {\r
942 break;\r
943 } else {\r
944 TempBlockPtr = (EFI_CAPSULE_BLOCK_DESCRIPTOR *) (UINTN) TempBlockPtr->Union.ContinuationPointer;\r
945 }\r
946 }\r
947 }\r
948}\r
949\r
950/**\r
951 Dump Provisioned Capsule.\r
952\r
953 @param[in] DumpCapsuleInfo The flag to indicate whether to dump the capsule inforomation.\r
954\r
955**/\r
956VOID\r
957DumpProvisionedCapsule (\r
958 IN BOOLEAN DumpCapsuleInfo\r
959 )\r
960{\r
961 EFI_STATUS Status;\r
962 CHAR16 CapsuleVarName[30];\r
963 CHAR16 *TempVarName;\r
964 UINTN Index;\r
965 EFI_PHYSICAL_ADDRESS *CapsuleDataPtr64;\r
966 UINT16 *BootNext;\r
967 CHAR16 BootOptionName[20];\r
968 EFI_BOOT_MANAGER_LOAD_OPTION BootNextOptionEntry;\r
969 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
970 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Fs;\r
971 EFI_SHELL_PROTOCOL *ShellProtocol;\r
972\r
973 ShellProtocol = GetShellProtocol ();\r
974\r
e98212cb
CC
975 Index = 0;\r
976 CapsuleDataPtr64 = NULL;\r
977 BootNext = NULL;\r
978 ShellProtocol = NULL;\r
97473291
CC
979\r
980 //\r
981 // Dump capsule provisioned on Memory\r
982 //\r
983 Print (L"#########################\n");\r
984 Print (L"### Capsule on Memory ###\n");\r
985 Print (L"#########################\n");\r
986 StrCpyS (CapsuleVarName, sizeof(CapsuleVarName)/sizeof(CHAR16), EFI_CAPSULE_VARIABLE_NAME);\r
987 TempVarName = CapsuleVarName + StrLen (CapsuleVarName);\r
988 while (TRUE) {\r
989 if (Index > 0) {\r
990 UnicodeValueToStringS (\r
991 TempVarName,\r
992 sizeof (CapsuleVarName) - ((UINTN)TempVarName - (UINTN)CapsuleVarName),\r
993 0,\r
994 Index,\r
995 0\r
996 );\r
997 }\r
998\r
999 Status = GetVariable2 (\r
1000 CapsuleVarName,\r
1001 &gEfiCapsuleVendorGuid,\r
1002 (VOID **) &CapsuleDataPtr64,\r
1003 NULL\r
1004 );\r
1005 if (EFI_ERROR (Status)) {\r
1006 if (Index == 0) {\r
1007 Print (L"No data.\n");\r
1008 }\r
1009 break;\r
1010 } else {\r
1011 Index++;\r
1012 Print (L"Capsule Description at 0x%08x\n", *CapsuleDataPtr64);\r
1013 DumpBlockDescriptors ((EFI_CAPSULE_BLOCK_DESCRIPTOR*) (UINTN) *CapsuleDataPtr64, DumpCapsuleInfo);\r
1014 }\r
1015 }\r
1016\r
1017 //\r
1018 // Dump capsule provisioned on Disk\r
1019 //\r
1020 Print (L"#########################\n");\r
1021 Print (L"### Capsule on Disk #####\n");\r
1022 Print (L"#########################\n");\r
1023 Status = GetVariable2 (\r
1024 L"BootNext",\r
1025 &gEfiGlobalVariableGuid,\r
1026 (VOID **) &BootNext,\r
1027 NULL\r
1028 );\r
1029 if (!EFI_ERROR (Status)) {\r
1030 UnicodeSPrint (BootOptionName, sizeof (BootOptionName), L"Boot%04x", *BootNext);\r
1031 Status = EfiBootManagerVariableToLoadOption (BootOptionName, &BootNextOptionEntry);\r
1032 if (!EFI_ERROR (Status)) {\r
1033 //\r
1034 // Display description and device path\r
1035 //\r
1036 GetEfiSysPartitionFromBootOptionFilePath (BootNextOptionEntry.FilePath, &DevicePath, &Fs);\r
1037 if(!EFI_ERROR (Status)) {\r
1038 Print (L"Capsules are provisioned on BootOption: %s\n", BootNextOptionEntry.Description);\r
1039 Print (L" %s %s\n", ShellProtocol->GetMapFromDevicePath (&DevicePath), ConvertDevicePathToText(DevicePath, TRUE, TRUE));\r
1040 DumpCapsuleFromDisk (Fs, DumpCapsuleInfo);\r
1041 }\r
1042 }\r
1043 }\r
1044}\r
1045\r
592bad04
JY
1046/**\r
1047 Dump FMP information.\r
1048\r
1049 @param[in] ImageInfoSize The size of ImageInfo, in bytes.\r
1050 @param[in] ImageInfo A pointer to EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
1051 @param[in] DescriptorVersion The version of EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
1052 @param[in] DescriptorCount The count of EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
1053 @param[in] DescriptorSize The size of an individual EFI_FIRMWARE_IMAGE_DESCRIPTOR, in bytes.\r
1054 @param[in] PackageVersion The version of package.\r
1055 @param[in] PackageVersionName The version name of package.\r
1056**/\r
1057VOID\r
1058DumpFmpImageInfo (\r
1059 IN UINTN ImageInfoSize,\r
1060 IN EFI_FIRMWARE_IMAGE_DESCRIPTOR *ImageInfo,\r
1061 IN UINT32 DescriptorVersion,\r
1062 IN UINT8 DescriptorCount,\r
1063 IN UINTN DescriptorSize,\r
1064 IN UINT32 PackageVersion,\r
1065 IN CHAR16 *PackageVersionName\r
1066 )\r
1067{\r
1068 EFI_FIRMWARE_IMAGE_DESCRIPTOR *CurrentImageInfo;\r
1069 UINTN Index;\r
1070\r
1071 Print(L" DescriptorVersion - 0x%x\n", DescriptorVersion);\r
1072 Print(L" DescriptorCount - 0x%x\n", DescriptorCount);\r
1073 Print(L" DescriptorSize - 0x%x\n", DescriptorSize);\r
1074 Print(L" PackageVersion - 0x%x\n", PackageVersion);\r
1075 Print(L" PackageVersionName - \"%s\"\n", PackageVersionName);\r
1076 CurrentImageInfo = ImageInfo;\r
1077 for (Index = 0; Index < DescriptorCount; Index++) {\r
1078 Print(L" ImageDescriptor (%d)\n", Index);\r
1079 Print(L" ImageIndex - 0x%x\n", CurrentImageInfo->ImageIndex);\r
1080 Print(L" ImageTypeId - %g\n", &CurrentImageInfo->ImageTypeId);\r
1081 Print(L" ImageId - 0x%lx\n", CurrentImageInfo->ImageId);\r
1082 Print(L" ImageIdName - \"%s\"\n", CurrentImageInfo->ImageIdName);\r
1083 Print(L" Version - 0x%x\n", CurrentImageInfo->Version);\r
1084 Print(L" VersionName - \"%s\"\n", CurrentImageInfo->VersionName);\r
1085 Print(L" Size - 0x%x\n", CurrentImageInfo->Size);\r
1086 Print(L" AttributesSupported - 0x%lx\n", CurrentImageInfo->AttributesSupported);\r
1087 Print(L" IMAGE_UPDATABLE - 0x%lx\n", CurrentImageInfo->AttributesSupported & IMAGE_ATTRIBUTE_IMAGE_UPDATABLE);\r
1088 Print(L" RESET_REQUIRED - 0x%lx\n", CurrentImageInfo->AttributesSupported & IMAGE_ATTRIBUTE_RESET_REQUIRED);\r
1089 Print(L" AUTHENTICATION_REQUIRED - 0x%lx\n", CurrentImageInfo->AttributesSupported & IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED);\r
1090 Print(L" IN_USE - 0x%lx\n", CurrentImageInfo->AttributesSupported & IMAGE_ATTRIBUTE_IN_USE);\r
1091 Print(L" UEFI_IMAGE - 0x%lx\n", CurrentImageInfo->AttributesSupported & IMAGE_ATTRIBUTE_UEFI_IMAGE);\r
1092 Print(L" AttributesSetting - 0x%lx\n", CurrentImageInfo->AttributesSetting);\r
1093 Print(L" IMAGE_UPDATABLE - 0x%lx\n", CurrentImageInfo->AttributesSetting & IMAGE_ATTRIBUTE_IMAGE_UPDATABLE);\r
1094 Print(L" RESET_REQUIRED - 0x%lx\n", CurrentImageInfo->AttributesSetting & IMAGE_ATTRIBUTE_RESET_REQUIRED);\r
1095 Print(L" AUTHENTICATION_REQUIRED - 0x%lx\n", CurrentImageInfo->AttributesSetting & IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED);\r
1096 Print(L" IN_USE - 0x%lx\n", CurrentImageInfo->AttributesSetting & IMAGE_ATTRIBUTE_IN_USE);\r
1097 Print(L" UEFI_IMAGE - 0x%lx\n", CurrentImageInfo->AttributesSetting & IMAGE_ATTRIBUTE_UEFI_IMAGE);\r
1098 Print(L" Compatibilities - 0x%lx\n", CurrentImageInfo->Compatibilities);\r
1099 Print(L" COMPATIB_CHECK_SUPPORTED - 0x%lx\n", CurrentImageInfo->Compatibilities & IMAGE_COMPATIBILITY_CHECK_SUPPORTED);\r
1100 if (DescriptorVersion > 1) {\r
1101 Print(L" LowestSupportedImageVersion - 0x%x\n", CurrentImageInfo->LowestSupportedImageVersion);\r
1102 if (DescriptorVersion > 2) {\r
1103 Print(L" LastAttemptVersion - 0x%x\n", CurrentImageInfo->LastAttemptVersion);\r
1104 Print(L" LastAttemptStatus - 0x%x (%a)\n", CurrentImageInfo->LastAttemptStatus, LastAttemptStatusToString(CurrentImageInfo->LastAttemptStatus));\r
1105 Print(L" HardwareInstance - 0x%lx\n", CurrentImageInfo->HardwareInstance);\r
1106 }\r
1107 }\r
1108 //\r
1109 // Use DescriptorSize to move ImageInfo Pointer to stay compatible with different ImageInfo version\r
1110 //\r
1111 CurrentImageInfo = (EFI_FIRMWARE_IMAGE_DESCRIPTOR *)((UINT8 *)CurrentImageInfo + DescriptorSize);\r
1112 }\r
1113}\r
1114\r
1115/**\r
1116 Dump FMP package information.\r
1117\r
1118 @param[in] PackageVersion The version of package.\r
1119 @param[in] PackageVersionName The version name of package.\r
1120 @param[in] PackageVersionNameMaxLen The maximum length of PackageVersionName.\r
1121 @param[in] AttributesSupported Package attributes that are supported by this device.\r
1122 @param[in] AttributesSetting Package attributes.\r
1123**/\r
1124VOID\r
1125DumpFmpPackageInfo (\r
1126 IN UINT32 PackageVersion,\r
1127 IN CHAR16 *PackageVersionName,\r
1128 IN UINT32 PackageVersionNameMaxLen,\r
1129 IN UINT64 AttributesSupported,\r
1130 IN UINT64 AttributesSetting\r
1131 )\r
1132{\r
1133 Print(L" PackageVersion - 0x%x\n", PackageVersion);\r
1134 Print(L" PackageVersionName - \"%s\"\n", PackageVersionName);\r
1135 Print(L" PackageVersionNameMaxLen - 0x%x\n", PackageVersionNameMaxLen);\r
1136 Print(L" AttributesSupported - 0x%lx\n", AttributesSupported);\r
1137 Print(L" IMAGE_UPDATABLE - 0x%lx\n", AttributesSupported & IMAGE_ATTRIBUTE_IMAGE_UPDATABLE);\r
1138 Print(L" RESET_REQUIRED - 0x%lx\n", AttributesSupported & IMAGE_ATTRIBUTE_RESET_REQUIRED);\r
1139 Print(L" AUTHENTICATION_REQUIRED - 0x%lx\n", AttributesSupported & IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED);\r
1140 Print(L" AttributesSetting - 0x%lx\n", AttributesSetting);\r
1141 Print(L" IMAGE_UPDATABLE - 0x%lx\n", AttributesSetting & IMAGE_ATTRIBUTE_IMAGE_UPDATABLE);\r
1142 Print(L" RESET_REQUIRED - 0x%lx\n", AttributesSetting & IMAGE_ATTRIBUTE_RESET_REQUIRED);\r
1143 Print(L" AUTHENTICATION_REQUIRED - 0x%lx\n", AttributesSetting & IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED);\r
1144}\r
1145\r
1146/**\r
1147 Dump FMP protocol info.\r
1148**/\r
1149VOID\r
1150DumpFmpData (\r
1151 VOID\r
1152 )\r
1153{\r
1154 EFI_STATUS Status;\r
1155 EFI_FIRMWARE_MANAGEMENT_PROTOCOL *Fmp;\r
1156 EFI_HANDLE *HandleBuffer;\r
1157 UINTN NumberOfHandles;\r
1158 UINTN Index;\r
1159 EFI_FIRMWARE_IMAGE_DESCRIPTOR *FmpImageInfoBuf;\r
1160 UINTN ImageInfoSize;\r
1161 UINT32 FmpImageInfoDescriptorVer;\r
1162 UINT8 FmpImageInfoCount;\r
1163 UINTN DescriptorSize;\r
1164 UINT32 PackageVersion;\r
1165 CHAR16 *PackageVersionName;\r
1166 UINT32 PackageVersionNameMaxLen;\r
1167 UINT64 AttributesSupported;\r
1168 UINT64 AttributesSetting;\r
1169\r
1170 Print(L"############\n");\r
1171 Print(L"# FMP DATA #\n");\r
1172 Print(L"############\n");\r
1173 Status = gBS->LocateHandleBuffer (\r
1174 ByProtocol,\r
1175 &gEfiFirmwareManagementProtocolGuid,\r
1176 NULL,\r
1177 &NumberOfHandles,\r
1178 &HandleBuffer\r
1179 );\r
1180 if (EFI_ERROR(Status)) {\r
1181 Print(L"FMP protocol - %r\n", EFI_NOT_FOUND);\r
1182 return;\r
1183 }\r
1184\r
1185 for (Index = 0; Index < NumberOfHandles; Index++) {\r
1186 Status = gBS->HandleProtocol(\r
1187 HandleBuffer[Index],\r
1188 &gEfiFirmwareManagementProtocolGuid,\r
1189 (VOID **)&Fmp\r
1190 );\r
1191 if (EFI_ERROR(Status)) {\r
1192 continue;\r
1193 }\r
1194\r
1195 ImageInfoSize = 0;\r
1196 Status = Fmp->GetImageInfo (\r
1197 Fmp,\r
1198 &ImageInfoSize,\r
1199 NULL,\r
1200 NULL,\r
1201 NULL,\r
1202 NULL,\r
1203 NULL,\r
1204 NULL\r
1205 );\r
1206 if (Status != EFI_BUFFER_TOO_SMALL) {\r
1207 continue;\r
1208 }\r
1209\r
1210 FmpImageInfoBuf = NULL;\r
1211 FmpImageInfoBuf = AllocateZeroPool (ImageInfoSize);\r
1212 if (FmpImageInfoBuf == NULL) {\r
1213 Status = EFI_OUT_OF_RESOURCES;\r
1214 goto EXIT;\r
1215 }\r
1216\r
1217 PackageVersionName = NULL;\r
1218 Status = Fmp->GetImageInfo (\r
1219 Fmp,\r
1220 &ImageInfoSize, // ImageInfoSize\r
1221 FmpImageInfoBuf, // ImageInfo\r
1222 &FmpImageInfoDescriptorVer, // DescriptorVersion\r
1223 &FmpImageInfoCount, // DescriptorCount\r
1224 &DescriptorSize, // DescriptorSize\r
1225 &PackageVersion, // PackageVersion\r
1226 &PackageVersionName // PackageVersionName\r
1227 );\r
1228\r
1229 //\r
1230 // If FMP GetInformation interface failed, skip this resource\r
1231 //\r
1232 if (EFI_ERROR(Status)) {\r
1233 Print(L"FMP (%d) ImageInfo - %r\n", Index, Status);\r
1234 FreePool(FmpImageInfoBuf);\r
1235 continue;\r
1236 }\r
1237\r
1238 Print(L"FMP (%d) ImageInfo:\n", Index);\r
1239 DumpFmpImageInfo(\r
1240 ImageInfoSize, // ImageInfoSize\r
1241 FmpImageInfoBuf, // ImageInfo\r
1242 FmpImageInfoDescriptorVer, // DescriptorVersion\r
1243 FmpImageInfoCount, // DescriptorCount\r
1244 DescriptorSize, // DescriptorSize\r
1245 PackageVersion, // PackageVersion\r
1246 PackageVersionName // PackageVersionName\r
1247 );\r
1248\r
1249 if (PackageVersionName != NULL) {\r
1250 FreePool(PackageVersionName);\r
1251 }\r
1252 FreePool(FmpImageInfoBuf);\r
1253\r
1254 //\r
1255 // Get package info\r
1256 //\r
1257 PackageVersionName = NULL;\r
1258 Status = Fmp->GetPackageInfo (\r
1259 Fmp,\r
1260 &PackageVersion, // PackageVersion\r
1261 &PackageVersionName, // PackageVersionName\r
1262 &PackageVersionNameMaxLen, // PackageVersionNameMaxLen\r
1263 &AttributesSupported, // AttributesSupported\r
1264 &AttributesSetting // AttributesSetting\r
1265 );\r
1266 if (EFI_ERROR(Status)) {\r
1267 Print(L"FMP (%d) PackageInfo - %r\n", Index, Status);\r
1268 } else {\r
1269 Print(L"FMP (%d) ImageInfo:\n", Index);\r
1270 DumpFmpPackageInfo(\r
1271 PackageVersion, // PackageVersion\r
1272 PackageVersionName, // PackageVersionName\r
1273 PackageVersionNameMaxLen, // PackageVersionNameMaxLen\r
1274 AttributesSupported, // AttributesSupported\r
1275 AttributesSetting // AttributesSetting\r
1276 );\r
1277\r
1278 if (PackageVersionName != NULL) {\r
1279 FreePool(PackageVersionName);\r
1280 }\r
1281 }\r
1282 }\r
1283 Print(L"\n");\r
1284\r
1285EXIT:\r
1286 FreePool(HandleBuffer);\r
1287}\r
1e09ec09
JY
1288\r
1289/**\r
1290 Check if the ImageInfo includes the ImageTypeId.\r
1291\r
1292 @param[in] ImageInfo A pointer to EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
1293 @param[in] DescriptorCount The count of EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
1294 @param[in] DescriptorSize The size of an individual EFI_FIRMWARE_IMAGE_DESCRIPTOR, in bytes.\r
1295 @param[in] ImageTypeId A unique GUID identifying the firmware image type.\r
1296\r
1297 @return TRUE This ImageInfo includes the ImageTypeId\r
1298 @return FALSE This ImageInfo does not include the ImageTypeId\r
1299**/\r
1300BOOLEAN\r
1301IsThisFmpImageInfo (\r
1302 IN EFI_FIRMWARE_IMAGE_DESCRIPTOR *ImageInfo,\r
1303 IN UINT8 DescriptorCount,\r
1304 IN UINTN DescriptorSize,\r
1305 IN EFI_GUID *ImageTypeId\r
1306 )\r
1307{\r
1308 EFI_FIRMWARE_IMAGE_DESCRIPTOR *CurrentImageInfo;\r
1309 UINTN Index;\r
1310\r
1311 CurrentImageInfo = ImageInfo;\r
1312 for (Index = 0; Index < DescriptorCount; Index++) {\r
1313 if (CompareGuid (&CurrentImageInfo->ImageTypeId, ImageTypeId)) {\r
1314 return TRUE;\r
1315 }\r
1316 CurrentImageInfo = (EFI_FIRMWARE_IMAGE_DESCRIPTOR *)((UINT8 *)CurrentImageInfo + DescriptorSize);\r
1317 }\r
1318 return FALSE;\r
1319}\r
1320\r
1321/**\r
1322 return the FMP whoes ImageInfo includes the ImageTypeId.\r
1323\r
1324 @param[in] ImageTypeId A unique GUID identifying the firmware image type.\r
1325\r
1326 @return The FMP whoes ImageInfo includes the ImageTypeId\r
1327**/\r
1328EFI_FIRMWARE_MANAGEMENT_PROTOCOL *\r
1329FindFmpFromImageTypeId (\r
1330 IN EFI_GUID *ImageTypeId\r
1331 )\r
1332{\r
1333 EFI_STATUS Status;\r
1334 EFI_FIRMWARE_MANAGEMENT_PROTOCOL *Fmp;\r
1335 EFI_FIRMWARE_MANAGEMENT_PROTOCOL *TargetFmp;\r
1336 EFI_HANDLE *HandleBuffer;\r
1337 UINTN NumberOfHandles;\r
1338 UINTN Index;\r
1339 EFI_FIRMWARE_IMAGE_DESCRIPTOR *FmpImageInfoBuf;\r
1340 UINTN ImageInfoSize;\r
1341 UINT32 FmpImageInfoDescriptorVer;\r
1342 UINT8 FmpImageInfoCount;\r
1343 UINTN DescriptorSize;\r
1344 UINT32 PackageVersion;\r
1345 CHAR16 *PackageVersionName;\r
1346\r
1347 Status = gBS->LocateHandleBuffer (\r
1348 ByProtocol,\r
1349 &gEfiFirmwareManagementProtocolGuid,\r
1350 NULL,\r
1351 &NumberOfHandles,\r
1352 &HandleBuffer\r
1353 );\r
1354 if (EFI_ERROR(Status)) {\r
1355 Print(L"FMP protocol - %r\n", EFI_NOT_FOUND);\r
1356 return NULL;\r
1357 }\r
1358\r
1359 TargetFmp = NULL;\r
1360 for (Index = 0; Index < NumberOfHandles; Index++) {\r
1361 Status = gBS->HandleProtocol(\r
1362 HandleBuffer[Index],\r
1363 &gEfiFirmwareManagementProtocolGuid,\r
1364 (VOID **)&Fmp\r
1365 );\r
1366 if (EFI_ERROR(Status)) {\r
1367 continue;\r
1368 }\r
1369\r
1370 ImageInfoSize = 0;\r
1371 Status = Fmp->GetImageInfo (\r
1372 Fmp,\r
1373 &ImageInfoSize,\r
1374 NULL,\r
1375 NULL,\r
1376 NULL,\r
1377 NULL,\r
1378 NULL,\r
1379 NULL\r
1380 );\r
1381 if (Status != EFI_BUFFER_TOO_SMALL) {\r
1382 continue;\r
1383 }\r
1384\r
1385 FmpImageInfoBuf = NULL;\r
1386 FmpImageInfoBuf = AllocateZeroPool (ImageInfoSize);\r
1387 if (FmpImageInfoBuf == NULL) {\r
1388 FreePool(HandleBuffer);\r
1389 Print(L"Out of resource\n");\r
1390 return NULL;\r
1391 }\r
1392\r
1393 PackageVersionName = NULL;\r
1394 Status = Fmp->GetImageInfo (\r
1395 Fmp,\r
1396 &ImageInfoSize, // ImageInfoSize\r
1397 FmpImageInfoBuf, // ImageInfo\r
1398 &FmpImageInfoDescriptorVer, // DescriptorVersion\r
1399 &FmpImageInfoCount, // DescriptorCount\r
1400 &DescriptorSize, // DescriptorSize\r
1401 &PackageVersion, // PackageVersion\r
1402 &PackageVersionName // PackageVersionName\r
1403 );\r
1404\r
1405 //\r
1406 // If FMP GetInformation interface failed, skip this resource\r
1407 //\r
1408 if (EFI_ERROR(Status)) {\r
1409 FreePool(FmpImageInfoBuf);\r
1410 continue;\r
1411 }\r
1412\r
1413 if (PackageVersionName != NULL) {\r
1414 FreePool(PackageVersionName);\r
1415 }\r
1416\r
1417 if (IsThisFmpImageInfo (FmpImageInfoBuf, FmpImageInfoCount, DescriptorSize, ImageTypeId)) {\r
1418 TargetFmp = Fmp;\r
1419 }\r
1420 FreePool(FmpImageInfoBuf);\r
1421 if (TargetFmp != NULL) {\r
1422 break;\r
1423 }\r
1424 }\r
1425 FreePool(HandleBuffer);\r
1426 return TargetFmp;\r
1427}\r
1428\r
1429/**\r
1430 Dump FMP image data.\r
1431\r
1432 @param[in] ImageTypeId The ImageTypeId of the FMP image.\r
1433 It is used to identify the FMP protocol.\r
1434 @param[in] ImageIndex The ImageIndex of the FMP image.\r
1435 It is the input parameter for FMP->GetImage().\r
1436 @param[in] ImageName The file name to hold the output FMP image.\r
1437**/\r
1438VOID\r
1439DumpFmpImage (\r
1440 IN EFI_GUID *ImageTypeId,\r
1441 IN UINTN ImageIndex,\r
1442 IN CHAR16 *ImageName\r
1443 )\r
1444{\r
1445 EFI_STATUS Status;\r
1446 EFI_FIRMWARE_MANAGEMENT_PROTOCOL *Fmp;\r
1447 VOID *Image;\r
1448 UINTN ImageSize;\r
1449\r
1450 Fmp = FindFmpFromImageTypeId (ImageTypeId);\r
1451 if (Fmp == NULL) {\r
1452 Print(L"No FMP include ImageTypeId %g\n", ImageTypeId);\r
1453 return ;\r
1454 }\r
1455\r
1456 if (ImageIndex > 0xFF) {\r
1457 Print(L"ImageIndex 0x%x too big\n", ImageIndex);\r
1458 return ;\r
1459 }\r
1460\r
1461 Image = Fmp;\r
1462 ImageSize = 0;\r
1463 Status = Fmp->GetImage (Fmp, (UINT8)ImageIndex, Image, &ImageSize);\r
1464 if (Status != EFI_BUFFER_TOO_SMALL) {\r
1465 Print(L"Fmp->GetImage - %r\n", Status);\r
1466 return ;\r
1467 }\r
1468\r
1469 Image = AllocatePool (ImageSize);\r
1470 if (Image == NULL) {\r
1471 Print(L"Allocate FmpImage 0x%x - %r\n", ImageSize, EFI_OUT_OF_RESOURCES);\r
1472 return ;\r
1473 }\r
1474\r
1475 Status = Fmp->GetImage (Fmp, (UINT8)ImageIndex, Image, &ImageSize);\r
1476 if (EFI_ERROR(Status)) {\r
1477 Print(L"Fmp->GetImage - %r\n", Status);\r
1478 return ;\r
1479 }\r
1480\r
1481 Status = WriteFileFromBuffer(ImageName, ImageSize, Image);\r
1482 Print(L"CapsuleApp: Dump %g ImageIndex (0x%x) to %s %r\n", ImageTypeId, ImageIndex, ImageName, Status);\r
1483\r
d4d91167
SZ
1484 FreePool (Image);\r
1485\r
1e09ec09
JY
1486 return ;\r
1487}\r