]> git.proxmox.com Git - mirror_edk2.git/blob - ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
ShellPkg/dh: Refine the dump output
[mirror_edk2.git] / ShellPkg / Library / UefiHandleParsingLib / UefiHandleParsingLib.c
1 /** @file
2 Provides interface to advanced shell functionality for parsing both handle and protocol database.
3
4 Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
6 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
11
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14
15 **/
16
17 #include "UefiHandleParsingLib.h"
18 #include "IndustryStandard/Acpi10.h"
19 #include "IndustryStandard/Pci.h"
20 #include <PiDxe.h>
21 #include <Protocol/FirmwareVolume2.h>
22
23 EFI_HANDLE mHandleParsingHiiHandle = NULL;
24 HANDLE_INDEX_LIST mHandleList = {{{NULL,NULL},0,0},0};
25 GUID_INFO_BLOCK *mGuidList;
26 UINTN mGuidListCount;
27
28 /**
29 Function to find the file name associated with a LoadedImageProtocol.
30
31 @param[in] LoadedImage An instance of LoadedImageProtocol.
32
33 @retval A string representation of the file name associated
34 with LoadedImage, or NULL if no name can be found.
35 **/
36 CHAR16*
37 FindLoadedImageFileName (
38 IN EFI_LOADED_IMAGE_PROTOCOL *LoadedImage
39 )
40 {
41 EFI_GUID *NameGuid;
42 EFI_STATUS Status;
43 EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv;
44 VOID *Buffer;
45 UINTN BufferSize;
46 UINT32 AuthenticationStatus;
47
48 if ((LoadedImage == NULL) || (LoadedImage->FilePath == NULL)) {
49 return NULL;
50 }
51
52 NameGuid = EfiGetNameGuidFromFwVolDevicePathNode((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)LoadedImage->FilePath);
53
54 if (NameGuid == NULL) {
55 return NULL;
56 }
57
58 //
59 // Get the FirmwareVolume2Protocol of the device handle that this image was loaded from.
60 //
61 Status = gBS->HandleProtocol (LoadedImage->DeviceHandle, &gEfiFirmwareVolume2ProtocolGuid, (VOID**) &Fv);
62
63 //
64 // FirmwareVolume2Protocol is PI, and is not required to be available.
65 //
66 if (EFI_ERROR (Status)) {
67 return NULL;
68 }
69
70 //
71 // Read the user interface section of the image.
72 //
73 Buffer = NULL;
74 Status = Fv->ReadSection(Fv, NameGuid, EFI_SECTION_USER_INTERFACE, 0, &Buffer, &BufferSize, &AuthenticationStatus);
75
76 if (EFI_ERROR (Status)) {
77 return NULL;
78 }
79
80 //
81 // ReadSection returns just the section data, without any section header. For
82 // a user interface section, the only data is the file name.
83 //
84 return Buffer;
85 }
86
87 /**
88 Function to translate the EFI_MEMORY_TYPE into a string.
89
90 @param[in] Memory The memory type.
91
92 @retval A string representation of the type allocated from BS Pool.
93 **/
94 CHAR16*
95 ConvertMemoryType (
96 IN CONST EFI_MEMORY_TYPE Memory
97 )
98 {
99 CHAR16 *RetVal;
100 RetVal = NULL;
101
102 switch (Memory) {
103 case EfiReservedMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiReservedMemoryType", 0); break;
104 case EfiLoaderCode: StrnCatGrow(&RetVal, NULL, L"EfiLoaderCode", 0); break;
105 case EfiLoaderData: StrnCatGrow(&RetVal, NULL, L"EfiLoaderData", 0); break;
106 case EfiBootServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesCode", 0); break;
107 case EfiBootServicesData: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesData", 0); break;
108 case EfiRuntimeServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesCode", 0); break;
109 case EfiRuntimeServicesData: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesData", 0); break;
110 case EfiConventionalMemory: StrnCatGrow(&RetVal, NULL, L"EfiConventionalMemory", 0); break;
111 case EfiUnusableMemory: StrnCatGrow(&RetVal, NULL, L"EfiUnusableMemory", 0); break;
112 case EfiACPIReclaimMemory: StrnCatGrow(&RetVal, NULL, L"EfiACPIReclaimMemory", 0); break;
113 case EfiACPIMemoryNVS: StrnCatGrow(&RetVal, NULL, L"EfiACPIMemoryNVS", 0); break;
114 case EfiMemoryMappedIO: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIO", 0); break;
115 case EfiMemoryMappedIOPortSpace: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIOPortSpace", 0); break;
116 case EfiPalCode: StrnCatGrow(&RetVal, NULL, L"EfiPalCode", 0); break;
117 case EfiMaxMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiMaxMemoryType", 0); break;
118 default: ASSERT(FALSE);
119 }
120 return (RetVal);
121 }
122
123 /**
124 Function to translate the EFI_GRAPHICS_PIXEL_FORMAT into a string.
125
126 @param[in] Fmt The format type.
127
128 @retval A string representation of the type allocated from BS Pool.
129 **/
130 CHAR16*
131 ConvertPixelFormat (
132 IN CONST EFI_GRAPHICS_PIXEL_FORMAT Fmt
133 )
134 {
135 CHAR16 *RetVal;
136 RetVal = NULL;
137
138 switch (Fmt) {
139 case PixelRedGreenBlueReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelRedGreenBlueReserved8BitPerColor", 0); break;
140 case PixelBlueGreenRedReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelBlueGreenRedReserved8BitPerColor", 0); break;
141 case PixelBitMask: StrnCatGrow(&RetVal, NULL, L"PixelBitMask", 0); break;
142 case PixelBltOnly: StrnCatGrow(&RetVal, NULL, L"PixelBltOnly", 0); break;
143 case PixelFormatMax: StrnCatGrow(&RetVal, NULL, L"PixelFormatMax", 0); break;
144 default: ASSERT(FALSE);
145 }
146 return (RetVal);
147 }
148
149 /**
150 Constructor for the library.
151
152 @param[in] ImageHandle Ignored.
153 @param[in] SystemTable Ignored.
154
155 @retval EFI_SUCCESS The operation was successful.
156 **/
157 EFI_STATUS
158 EFIAPI
159 HandleParsingLibConstructor (
160 IN EFI_HANDLE ImageHandle,
161 IN EFI_SYSTEM_TABLE *SystemTable
162 )
163 {
164 mGuidListCount = 0;
165 mGuidList = NULL;
166
167 //
168 // Do nothing with mHandleParsingHiiHandle. Initialize HII as needed.
169 //
170 return (EFI_SUCCESS);
171 }
172
173 /**
174 Initialization function for HII packages.
175
176 **/
177 VOID
178 HandleParsingHiiInit (VOID)
179 {
180 if (mHandleParsingHiiHandle == NULL) {
181 mHandleParsingHiiHandle = HiiAddPackages (&gHandleParsingHiiGuid, gImageHandle, UefiHandleParsingLibStrings, NULL);
182 ASSERT (mHandleParsingHiiHandle != NULL);
183 }
184 }
185
186 /**
187 Destructor for the library. free any resources.
188
189 @param[in] ImageHandle Ignored.
190 @param[in] SystemTable Ignored.
191
192 @retval EFI_SUCCESS The operation was successful.
193 **/
194 EFI_STATUS
195 EFIAPI
196 HandleParsingLibDestructor (
197 IN EFI_HANDLE ImageHandle,
198 IN EFI_SYSTEM_TABLE *SystemTable
199 )
200 {
201 UINTN LoopCount;
202
203 for (LoopCount = 0; mGuidList != NULL && LoopCount < mGuidListCount; LoopCount++) {
204 SHELL_FREE_NON_NULL(mGuidList[LoopCount].GuidId);
205 }
206
207 SHELL_FREE_NON_NULL(mGuidList);
208 if (mHandleParsingHiiHandle != NULL) {
209 HiiRemovePackages(mHandleParsingHiiHandle);
210 }
211 return (EFI_SUCCESS);
212 }
213
214 /**
215 Function to dump information about LoadedImage.
216
217 This will allocate the return buffer from boot services pool.
218
219 @param[in] TheHandle The handle that has LoadedImage installed.
220 @param[in] Verbose TRUE for additional information, FALSE otherwise.
221
222 @retval A poitner to a string containing the information.
223 **/
224 CHAR16*
225 EFIAPI
226 LoadedImageProtocolDumpInformation(
227 IN CONST EFI_HANDLE TheHandle,
228 IN CONST BOOLEAN Verbose
229 )
230 {
231 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
232 EFI_STATUS Status;
233 CHAR16 *RetVal;
234 CHAR16 *Temp;
235 CHAR16 *FileName;
236 CHAR8 *PdbFileName;
237 CHAR16 *FilePath;
238 CHAR16 *CodeType;
239 CHAR16 *DataType;
240
241 Status = gBS->OpenProtocol (
242 TheHandle,
243 &gEfiLoadedImageProtocolGuid,
244 (VOID**)&LoadedImage,
245 gImageHandle,
246 NULL,
247 EFI_OPEN_PROTOCOL_GET_PROTOCOL
248 );
249
250 if (EFI_ERROR (Status)) {
251 return NULL;
252 }
253
254 FileName = FindLoadedImageFileName(LoadedImage);
255 FilePath = ConvertDevicePathToText(LoadedImage->FilePath, TRUE, TRUE);
256 if (!Verbose) {
257 if (FileName == NULL) {
258 FileName = FilePath;
259 } else {
260 SHELL_FREE_NON_NULL(FilePath);
261 }
262 RetVal = CatSPrint(NULL, FileName);
263 SHELL_FREE_NON_NULL(FileName);
264 return RetVal;
265 }
266
267 HandleParsingHiiInit();
268 RetVal = NULL;
269 if (FileName != NULL) {
270 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_LI_DUMP_NAME), NULL);
271
272 if (Temp != NULL) {
273 RetVal = CatSPrint(NULL, Temp, FileName);
274 }
275
276 SHELL_FREE_NON_NULL(Temp);
277 SHELL_FREE_NON_NULL(FileName);
278 }
279
280 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_LI_DUMP_MAIN), NULL);
281 if (Temp == NULL) {
282 return NULL;
283 }
284 PdbFileName = PeCoffLoaderGetPdbPointer (LoadedImage->ImageBase);
285 DataType = ConvertMemoryType(LoadedImage->ImageDataType);
286 CodeType = ConvertMemoryType(LoadedImage->ImageCodeType);
287
288 RetVal = CatSPrint(
289 RetVal,
290 Temp,
291 LoadedImage->Revision,
292 LoadedImage->ParentHandle,
293 LoadedImage->SystemTable,
294 LoadedImage->DeviceHandle,
295 FilePath,
296 PdbFileName,
297 LoadedImage->LoadOptionsSize,
298 LoadedImage->LoadOptions,
299 LoadedImage->ImageBase,
300 LoadedImage->ImageSize,
301 CodeType,
302 DataType,
303 LoadedImage->Unload
304 );
305
306
307 SHELL_FREE_NON_NULL(Temp);
308 SHELL_FREE_NON_NULL(FilePath);
309 SHELL_FREE_NON_NULL(CodeType);
310 SHELL_FREE_NON_NULL(DataType);
311
312 return RetVal;
313 }
314
315 /**
316 Function to dump information about GOP.
317
318 This will allocate the return buffer from boot services pool.
319
320 @param[in] TheHandle The handle that has LoadedImage installed.
321 @param[in] Verbose TRUE for additional information, FALSE otherwise.
322
323 @retval A poitner to a string containing the information.
324 **/
325 CHAR16*
326 EFIAPI
327 GraphicsOutputProtocolDumpInformation(
328 IN CONST EFI_HANDLE TheHandle,
329 IN CONST BOOLEAN Verbose
330 )
331 {
332 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
333 EFI_STATUS Status;
334 CHAR16 *RetVal;
335 CHAR16 *Temp;
336 CHAR16 *Fmt;
337 CHAR16 *TempRetVal;
338 UINTN GopInfoSize;
339 UINT32 Mode;
340 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *GopInfo;
341
342 if (!Verbose) {
343 return (CatSPrint(NULL, L"GraphicsOutput"));
344 }
345
346 HandleParsingHiiInit();
347
348 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_GOP_DUMP_MAIN), NULL);
349 if (Temp == NULL) {
350 return NULL;
351 }
352
353 Status = gBS->OpenProtocol (
354 TheHandle,
355 &gEfiGraphicsOutputProtocolGuid,
356 (VOID**)&GraphicsOutput,
357 gImageHandle,
358 NULL,
359 EFI_OPEN_PROTOCOL_GET_PROTOCOL
360 );
361
362 if (EFI_ERROR (Status)) {
363 SHELL_FREE_NON_NULL (Temp);
364 return NULL;
365 }
366
367 Fmt = ConvertPixelFormat(GraphicsOutput->Mode->Info->PixelFormat);
368
369 RetVal = CatSPrint(
370 NULL,
371 Temp,
372 GraphicsOutput->Mode->MaxMode,
373 GraphicsOutput->Mode->Mode,
374 GraphicsOutput->Mode->FrameBufferBase,
375 (UINT64)GraphicsOutput->Mode->FrameBufferSize,
376 (UINT64)GraphicsOutput->Mode->SizeOfInfo,
377 GraphicsOutput->Mode->Info->Version,
378 GraphicsOutput->Mode->Info->HorizontalResolution,
379 GraphicsOutput->Mode->Info->VerticalResolution,
380 Fmt,
381 GraphicsOutput->Mode->Info->PixelsPerScanLine,
382 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.RedMask,
383 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.GreenMask,
384 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.BlueMask
385 );
386
387 SHELL_FREE_NON_NULL (Temp);
388
389 Temp = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN (STR_GOP_RES_LIST_MAIN), NULL);
390 if (Temp == NULL) {
391 SHELL_FREE_NON_NULL (RetVal);
392 goto EXIT;
393 }
394
395 TempRetVal = CatSPrint (RetVal, Temp);
396 SHELL_FREE_NON_NULL (RetVal);
397 if (TempRetVal == NULL) {
398 goto EXIT;
399 }
400 RetVal = TempRetVal;
401 SHELL_FREE_NON_NULL (Temp);
402
403 Temp = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN (STR_GOP_RES_LIST_ENTRY), NULL);
404 if (Temp == NULL) {
405 SHELL_FREE_NON_NULL (RetVal);
406 goto EXIT;
407 }
408
409
410 for (Mode = 0; Mode < GraphicsOutput->Mode->MaxMode; Mode++) {
411 Status = GraphicsOutput->QueryMode (
412 GraphicsOutput,
413 Mode,
414 &GopInfoSize,
415 &GopInfo
416 );
417 if (EFI_ERROR (Status)) {
418 continue;
419 }
420
421 TempRetVal = CatSPrint (
422 RetVal,
423 Temp,
424 Mode,
425 GopInfo->HorizontalResolution,
426 GopInfo->VerticalResolution
427 );
428
429 SHELL_FREE_NON_NULL (GopInfo);
430 SHELL_FREE_NON_NULL (RetVal);
431 RetVal = TempRetVal;
432 }
433
434
435 EXIT:
436 SHELL_FREE_NON_NULL(Temp);
437 SHELL_FREE_NON_NULL(Fmt);
438
439 return RetVal;
440 }
441
442 /**
443 Function to dump information about EDID Discovered Protocol.
444
445 This will allocate the return buffer from boot services pool.
446
447 @param[in] TheHandle The handle that has LoadedImage installed.
448 @param[in] Verbose TRUE for additional information, FALSE otherwise.
449
450 @retval A pointer to a string containing the information.
451 **/
452 CHAR16*
453 EFIAPI
454 EdidDiscoveredProtocolDumpInformation (
455 IN CONST EFI_HANDLE TheHandle,
456 IN CONST BOOLEAN Verbose
457 )
458 {
459 EFI_EDID_DISCOVERED_PROTOCOL *EdidDiscovered;
460 EFI_STATUS Status;
461 CHAR16 *RetVal;
462 CHAR16 *Temp;
463 CHAR16 *TempRetVal;
464
465 if (!Verbose) {
466 return (CatSPrint (NULL, L"EDIDDiscovered"));
467 }
468
469 Status = gBS->OpenProtocol (
470 TheHandle,
471 &gEfiEdidDiscoveredProtocolGuid,
472 (VOID**)&EdidDiscovered,
473 NULL,
474 NULL,
475 EFI_OPEN_PROTOCOL_GET_PROTOCOL
476 );
477
478 if (EFI_ERROR (Status)) {
479 return NULL;
480 }
481
482 Temp = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN (STR_EDID_DISCOVERED_MAIN), NULL);
483 if (Temp == NULL) {
484 return NULL;
485 }
486
487 RetVal = CatSPrint (NULL, Temp, EdidDiscovered->SizeOfEdid);
488 SHELL_FREE_NON_NULL (Temp);
489
490 if (EdidDiscovered->SizeOfEdid != 0) {
491 Temp = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN (STR_EDID_DISCOVERED_DATA), NULL);
492 if (Temp == NULL) {
493 SHELL_FREE_NON_NULL (RetVal);
494 return NULL;
495 }
496 TempRetVal = CatSPrint (RetVal, Temp);
497 SHELL_FREE_NON_NULL (RetVal);
498 RetVal = TempRetVal;
499
500 TempRetVal = CatSDumpHex (RetVal, 4, 0, EdidDiscovered->SizeOfEdid, EdidDiscovered->Edid);
501 RetVal = TempRetVal;
502 }
503 return RetVal;
504 }
505
506 /**
507 Function to dump information about EDID Active Protocol.
508
509 This will allocate the return buffer from boot services pool.
510
511 @param[in] TheHandle The handle that has LoadedImage installed.
512 @param[in] Verbose TRUE for additional information, FALSE otherwise.
513
514 @retval A pointer to a string containing the information.
515 **/
516 CHAR16*
517 EFIAPI
518 EdidActiveProtocolDumpInformation (
519 IN CONST EFI_HANDLE TheHandle,
520 IN CONST BOOLEAN Verbose
521 )
522 {
523 EFI_EDID_ACTIVE_PROTOCOL *EdidActive;
524 EFI_STATUS Status;
525 CHAR16 *RetVal;
526 CHAR16 *Temp;
527 CHAR16 *TempRetVal;
528
529 if (!Verbose) {
530 return (CatSPrint (NULL, L"EDIDActive"));
531 }
532
533 Status = gBS->OpenProtocol (
534 TheHandle,
535 &gEfiEdidActiveProtocolGuid,
536 (VOID**)&EdidActive,
537 NULL,
538 NULL,
539 EFI_OPEN_PROTOCOL_GET_PROTOCOL
540 );
541
542 if (EFI_ERROR (Status)) {
543 return NULL;
544 }
545
546 Temp = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN (STR_EDID_ACTIVE_MAIN), NULL);
547 if (Temp == NULL) {
548 return NULL;
549 }
550
551 RetVal = CatSPrint (NULL, Temp, EdidActive->SizeOfEdid);
552 SHELL_FREE_NON_NULL (Temp);
553
554 if (EdidActive->SizeOfEdid != 0) {
555 Temp = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN (STR_EDID_ACTIVE_DATA), NULL);
556 if (Temp == NULL) {
557 SHELL_FREE_NON_NULL (RetVal);
558 return NULL;
559 }
560 TempRetVal = CatSPrint (RetVal, Temp);
561 SHELL_FREE_NON_NULL (RetVal);
562 RetVal = TempRetVal;
563
564 TempRetVal = CatSDumpHex (RetVal, 4, 0, EdidActive->SizeOfEdid, EdidActive->Edid);
565 RetVal = TempRetVal;
566 }
567 return RetVal;
568 }
569
570 /**
571 Function to dump information about PciRootBridgeIo.
572
573 This will allocate the return buffer from boot services pool.
574
575 @param[in] TheHandle The handle that has PciRootBridgeIo installed.
576 @param[in] Verbose TRUE for additional information, FALSE otherwise.
577
578 @retval A poitner to a string containing the information.
579 **/
580 CHAR16*
581 EFIAPI
582 PciRootBridgeIoDumpInformation(
583 IN CONST EFI_HANDLE TheHandle,
584 IN CONST BOOLEAN Verbose
585 )
586 {
587 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;
588 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Configuration;
589 UINT64 Supports;
590 UINT64 Attributes;
591 CHAR16 *Temp;
592 CHAR16 *Temp2;
593 CHAR16 *RetVal;
594 EFI_STATUS Status;
595
596 RetVal = NULL;
597
598 if (!Verbose) {
599 return (CatSPrint(NULL, L"PciRootBridgeIo"));
600 }
601
602 HandleParsingHiiInit();
603
604 Status = gBS->HandleProtocol(
605 TheHandle,
606 &gEfiPciRootBridgeIoProtocolGuid,
607 (VOID**)&PciRootBridgeIo);
608
609 if (EFI_ERROR(Status)) {
610 return NULL;
611 }
612
613 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_PH), NULL);
614 if (Temp == NULL) {
615 return NULL;
616 }
617 Temp2 = CatSPrint(NULL, Temp, PciRootBridgeIo->ParentHandle);
618 FreePool(Temp);
619 RetVal = Temp2;
620 Temp2 = NULL;
621
622 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SEG), NULL);
623 if (Temp == NULL) {
624 SHELL_FREE_NON_NULL(RetVal);
625 return NULL;
626 }
627 Temp2 = CatSPrint(RetVal, Temp, PciRootBridgeIo->SegmentNumber);
628 FreePool(Temp);
629 FreePool(RetVal);
630 RetVal = Temp2;
631 Temp2 = NULL;
632
633 Supports = 0;
634 Attributes = 0;
635 Status = PciRootBridgeIo->GetAttributes (PciRootBridgeIo, &Supports, &Attributes);
636 if (!EFI_ERROR(Status)) {
637 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_ATT), NULL);
638 if (Temp == NULL) {
639 SHELL_FREE_NON_NULL(RetVal);
640 return NULL;
641 }
642 Temp2 = CatSPrint(RetVal, Temp, Attributes);
643 FreePool(Temp);
644 FreePool(RetVal);
645 RetVal = Temp2;
646 Temp2 = NULL;
647
648 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SUPPORTS), NULL);
649 if (Temp == NULL) {
650 SHELL_FREE_NON_NULL(RetVal);
651 return NULL;
652 }
653 Temp2 = CatSPrint(RetVal, Temp, Supports);
654 FreePool(Temp);
655 FreePool(RetVal);
656 RetVal = Temp2;
657 Temp2 = NULL;
658 }
659
660 Configuration = NULL;
661 Status = PciRootBridgeIo->Configuration (PciRootBridgeIo, (VOID **) &Configuration);
662 if (!EFI_ERROR(Status) && Configuration != NULL) {
663 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_TITLE), NULL);
664 if (Temp == NULL) {
665 SHELL_FREE_NON_NULL(RetVal);
666 return NULL;
667 }
668 Temp2 = CatSPrint(RetVal, Temp, Supports);
669 FreePool(Temp);
670 FreePool(RetVal);
671 RetVal = Temp2;
672 Temp2 = NULL;
673 while (Configuration->Desc == ACPI_ADDRESS_SPACE_DESCRIPTOR) {
674 Temp = NULL;
675 switch (Configuration->ResType) {
676 case ACPI_ADDRESS_SPACE_TYPE_MEM:
677 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_MEM), NULL);
678 break;
679 case ACPI_ADDRESS_SPACE_TYPE_IO:
680 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_IO), NULL);
681 break;
682 case ACPI_ADDRESS_SPACE_TYPE_BUS:
683 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_BUS), NULL);
684 break;
685 }
686 if (Temp != NULL) {
687 Temp2 = CatSPrint(RetVal, L"%s", Temp);
688 FreePool(Temp);
689 FreePool(RetVal);
690 RetVal = Temp2;
691 Temp2 = NULL;
692 }
693
694 Temp2 = CatSPrint(RetVal,
695 L"\r\n%%H%02x %016lx %016lx %02x%%N",
696 Configuration->SpecificFlag,
697 Configuration->AddrRangeMin,
698 Configuration->AddrRangeMax,
699 Configuration->AddrSpaceGranularity
700 );
701 FreePool(RetVal);
702 RetVal = Temp2;
703 Temp2 = NULL;
704 Configuration++;
705 }
706 }
707 return (RetVal);
708 }
709
710 /**
711 Function to dump information about SimpleTextOut.
712
713 This will allocate the return buffer from boot services pool.
714
715 @param[in] TheHandle The handle that has SimpleTextOut installed.
716 @param[in] Verbose TRUE for additional information, FALSE otherwise.
717
718 @retval A poitner to a string containing the information.
719 **/
720 CHAR16*
721 EFIAPI
722 TxtOutProtocolDumpInformation(
723 IN CONST EFI_HANDLE TheHandle,
724 IN CONST BOOLEAN Verbose
725 )
726 {
727 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Dev;
728 INTN Index;
729 UINTN Col;
730 UINTN Row;
731 EFI_STATUS Status;
732 CHAR16 *RetVal;
733 UINTN Size;
734 CHAR16 *Temp;
735 UINTN NewSize;
736
737 if (!Verbose) {
738 return (NULL);
739 }
740
741 HandleParsingHiiInit();
742
743 RetVal = NULL;
744 Size = 0;
745
746 Status = gBS->HandleProtocol(
747 TheHandle,
748 &gEfiSimpleTextOutProtocolGuid,
749 (VOID**)&Dev);
750
751 ASSERT_EFI_ERROR(Status);
752 ASSERT (Dev != NULL && Dev->Mode != NULL);
753
754 Size = (Dev->Mode->MaxMode + 1) * 80;
755 RetVal = AllocateZeroPool(Size);
756
757 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER), NULL);
758 if (Temp != NULL) {
759 UnicodeSPrint(RetVal, Size, Temp, Dev, Dev->Mode->Attribute);
760 FreePool(Temp);
761 }
762
763 //
764 // Dump TextOut Info
765 //
766 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE), NULL);
767 for (Index = 0; Index < Dev->Mode->MaxMode; Index++) {
768 Status = Dev->QueryMode (Dev, Index, &Col, &Row);
769 NewSize = Size - StrSize(RetVal);
770 UnicodeSPrint(
771 RetVal + StrLen(RetVal),
772 NewSize,
773 Temp == NULL?L"":Temp,
774 Index == Dev->Mode->Mode ? L'*' : L' ',
775 Index,
776 !EFI_ERROR(Status)?(INTN)Col:-1,
777 !EFI_ERROR(Status)?(INTN)Row:-1
778 );
779 }
780 FreePool(Temp);
781 return (RetVal);
782 }
783
784 STATIC CONST UINTN VersionStringSize = 60;
785
786 /**
787 Function to dump information about EfiDriverSupportedEfiVersion protocol.
788
789 This will allocate the return buffer from boot services pool.
790
791 @param[in] TheHandle The handle that has the protocol installed.
792 @param[in] Verbose TRUE for additional information, FALSE otherwise.
793
794 @retval A poitner to a string containing the information.
795 **/
796 CHAR16*
797 EFIAPI
798 DriverEfiVersionProtocolDumpInformation(
799 IN CONST EFI_HANDLE TheHandle,
800 IN CONST BOOLEAN Verbose
801 )
802 {
803 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL *DriverEfiVersion;
804 EFI_STATUS Status;
805 CHAR16 *RetVal;
806
807 Status = gBS->HandleProtocol(
808 TheHandle,
809 &gEfiDriverSupportedEfiVersionProtocolGuid,
810 (VOID**)&DriverEfiVersion);
811
812 ASSERT_EFI_ERROR(Status);
813
814 RetVal = AllocateZeroPool(VersionStringSize);
815 if (RetVal != NULL) {
816 UnicodeSPrint (RetVal, VersionStringSize, L"0x%08x", DriverEfiVersion->FirmwareVersion);
817 }
818 return (RetVal);
819 }
820 /**
821 Function to convert device path to string.
822
823 This will allocate the return buffer from boot services pool.
824
825 @param[in] DevPath Pointer to device path instance.
826 @param[in] Verbose TRUE for additional information, FALSE otherwise.
827 @param[in] Length Maximum allowed text length of the device path.
828
829 @retval A pointer to a string containing the information.
830 **/
831 CHAR16*
832 ConvertDevicePathToShortText(
833 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevPath,
834 IN CONST BOOLEAN Verbose,
835 IN CONST UINTN Length
836 )
837 {
838 CHAR16 *Temp;
839 CHAR16 *Temp2;
840 UINTN Size;
841
842 //
843 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)
844 //
845 Temp = ConvertDevicePathToText(DevPath, TRUE, TRUE);
846 if (!Verbose && Temp != NULL && StrLen(Temp) > Length) {
847 Temp2 = NULL;
848 Size = 0;
849 Temp2 = StrnCatGrow(&Temp2, &Size, L"..", 0);
850 Temp2 = StrnCatGrow(&Temp2, &Size, Temp+(StrLen(Temp) - (Length - 2)), 0);
851 FreePool(Temp);
852 Temp = Temp2;
853 }
854 return (Temp);
855 }
856
857 /**
858 Function to dump protocol information.
859
860 This will allocate the return buffer from boot services pool.
861
862 @param[in] TheHandle The handle that has the protocol installed.
863 @param[in] Verbose TRUE for additional information, FALSE otherwise.
864 @param[in] Protocol The protocol is needed to dump.
865
866 @retval A pointer to a string containing the information.
867 **/
868 STATIC CHAR16*
869 EFIAPI
870 DevicePathProtocolDumpInformationEx (
871 IN CONST EFI_HANDLE TheHandle,
872 IN CONST BOOLEAN Verbose,
873 IN EFI_GUID *Protocol
874 )
875 {
876 EFI_DEVICE_PATH_PROTOCOL *DevPath;
877 CHAR16 *DevPathStr;
878 CHAR16 *DevPathStrTemp;
879 UINTN Size;
880 EFI_STATUS Status;
881 DevPathStr = NULL;
882 DevPathStrTemp = NULL;
883 Status = gBS->OpenProtocol(TheHandle, Protocol, (VOID**)&DevPath, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
884 if (!EFI_ERROR(Status)) {
885 DevPathStr = ConvertDevicePathToShortText (DevPath, Verbose, 30);
886 if (Verbose) {
887 Size = StrSize(DevPathStr) + sizeof(CHAR16) * 2;
888 DevPathStrTemp = AllocateZeroPool (Size);
889 if (DevPathStrTemp != NULL) {
890 StrnCatS (DevPathStrTemp, Size/sizeof(CHAR16), L" ", 2);
891 StrnCatS (DevPathStrTemp, Size/sizeof(CHAR16), DevPathStr, StrLen (DevPathStr));
892 }
893 FreePool (DevPathStr);
894 DevPathStr = DevPathStrTemp;
895 }
896 gBS->CloseProtocol(TheHandle, Protocol, gImageHandle, NULL);
897 }
898 return DevPathStr;
899 }
900
901 /**
902 Function to dump information about DevicePath protocol.
903
904 This will allocate the return buffer from boot services pool.
905
906 @param[in] TheHandle The handle that has the protocol installed.
907 @param[in] Verbose TRUE for additional information, FALSE otherwise.
908
909 @retval A pointer to a string containing the information.
910 **/
911 CHAR16*
912 EFIAPI
913 DevicePathProtocolDumpInformation(
914 IN CONST EFI_HANDLE TheHandle,
915 IN CONST BOOLEAN Verbose
916 )
917 {
918 return DevicePathProtocolDumpInformationEx (TheHandle, Verbose, &gEfiDevicePathProtocolGuid);
919 }
920
921 /**
922 Function to dump information about LoadedImageDevicePath protocol.
923
924 This will allocate the return buffer from boot services pool.
925
926 @param[in] TheHandle The handle that has the protocol installed.
927 @param[in] Verbose TRUE for additional information, FALSE otherwise.
928
929 @retval A pointer to a string containing the information.
930 **/
931 CHAR16*
932 EFIAPI
933 LoadedImageDevicePathProtocolDumpInformation(
934 IN CONST EFI_HANDLE TheHandle,
935 IN CONST BOOLEAN Verbose
936 )
937 {
938 return DevicePathProtocolDumpInformationEx (TheHandle, Verbose, &gEfiLoadedImageDevicePathProtocolGuid);
939 }
940
941 /**
942 Function to dump information about BusSpecificDriverOverride protocol.
943
944 This will allocate the return buffer from boot services pool.
945
946 @param[in] TheHandle The handle that has the protocol installed.
947 @param[in] Verbose TRUE for additional information, FALSE otherwise.
948
949 @retval A pointer to a string containing the information.
950 **/
951 CHAR16*
952 EFIAPI
953 BusSpecificDriverOverrideProtocolDumpInformation (
954 IN CONST EFI_HANDLE TheHandle,
955 IN CONST BOOLEAN Verbose
956 )
957 {
958 EFI_STATUS Status;
959 CHAR16 *GetString;
960 CHAR16 *RetVal;
961 CHAR16 *TempRetVal;
962 EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *BusSpecificDriverOverride;
963 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
964 EFI_HANDLE ImageHandle;
965 UINTN Size;
966
967 if (!Verbose) {
968 return NULL;
969 }
970 Size = 0;
971 GetString = NULL;
972 RetVal = NULL;
973 TempRetVal = NULL;
974 ImageHandle = 0;
975
976 Status = gBS->OpenProtocol (
977 TheHandle,
978 &gEfiBusSpecificDriverOverrideProtocolGuid,
979 (VOID**)&BusSpecificDriverOverride,
980 gImageHandle,
981 NULL,
982 EFI_OPEN_PROTOCOL_GET_PROTOCOL
983 );
984 if (EFI_ERROR (Status)) {
985 return NULL;
986 }
987 HandleParsingHiiInit ();
988 GetString = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_BSDO_DUMP_MAIN), NULL);
989 if (GetString == NULL) {
990 return NULL;
991 }
992 do {
993 Status = BusSpecificDriverOverride->GetDriver (
994 BusSpecificDriverOverride,
995 &ImageHandle
996 );
997 if (!EFI_ERROR (Status)) {
998 Status = gBS->HandleProtocol (
999 ImageHandle,
1000 &gEfiLoadedImageProtocolGuid,
1001 (VOID **) &LoadedImage
1002 );
1003 if(!EFI_ERROR (Status)) {
1004 TempRetVal = CatSPrint (
1005 TempRetVal,
1006 GetString,
1007 ConvertHandleToHandleIndex (ImageHandle),
1008 ConvertDevicePathToText (LoadedImage->FilePath, TRUE, TRUE)
1009 );
1010 StrnCatGrow (&RetVal, &Size, TempRetVal, 0);
1011 SHELL_FREE_NON_NULL (TempRetVal);
1012 }
1013 }
1014 } while (!EFI_ERROR (Status));
1015
1016 SHELL_FREE_NON_NULL (GetString);
1017 return RetVal;
1018 }
1019
1020 /**
1021 Function to dump information about BlockIo protocol.
1022
1023 This will allocate the return buffer from boot services pool.
1024
1025 @param[in] TheHandle The handle that has the protocol installed.
1026 @param[in] Verbose TRUE for additional information, FALSE otherwise.
1027
1028 @retval A pointer to a string containing the information.
1029 **/
1030 CHAR16*
1031 EFIAPI
1032 BlockIoProtocolDumpInformation (
1033 IN CONST EFI_HANDLE TheHandle,
1034 IN CONST BOOLEAN Verbose
1035 )
1036 {
1037 EFI_STATUS Status;
1038 EFI_BLOCK_IO_PROTOCOL *BlockIo;
1039 EFI_BLOCK_IO_MEDIA *BlockMedia;
1040 CHAR16 *GetString;
1041 CHAR16 *RetVal;
1042
1043 if (!Verbose) {
1044 return NULL;
1045 }
1046 GetString = NULL;
1047 RetVal = NULL;
1048
1049 Status = gBS->OpenProtocol (
1050 TheHandle,
1051 &gEfiBlockIoProtocolGuid,
1052 (VOID**)&BlockIo,
1053 gImageHandle,
1054 NULL,
1055 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1056 );
1057 if (EFI_ERROR (Status)) {
1058 return NULL;
1059 }
1060 BlockMedia = BlockIo->Media;
1061 //
1062 // Per spec:
1063 // The function (ReadBlocks) must return EFI_NO_MEDIA or
1064 // EFI_MEDIA_CHANGED even if LBA, BufferSize, or Buffer are invalid so the caller can probe
1065 // for changes in media state.
1066 //
1067 BlockIo->ReadBlocks (
1068 BlockIo,
1069 BlockIo->Media->MediaId,
1070 0,
1071 0,
1072 NULL
1073 );
1074
1075 HandleParsingHiiInit ();
1076 GetString = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_BLOCKIO_INFO), NULL);
1077 if (GetString == NULL) {
1078 return NULL;
1079 }
1080 RetVal = CatSPrint (
1081 RetVal,
1082 GetString,
1083 BlockMedia->RemovableMedia ? L"Removable " : L"Fixed ",
1084 BlockMedia->MediaPresent ? L"" : L"not-present ",
1085 BlockMedia->MediaId,
1086 BlockMedia->BlockSize,
1087 BlockMedia->LastBlock,
1088 MultU64x32 (BlockMedia->LastBlock + 1, BlockMedia->BlockSize),
1089 BlockMedia->LogicalPartition ? L"partition" : L"raw",
1090 BlockMedia->ReadOnly ? L"ro" : L"rw",
1091 BlockMedia->WriteCaching ? L"cached" : L"!cached"
1092 );
1093
1094 SHELL_FREE_NON_NULL (GetString);
1095 return RetVal;
1096 }
1097
1098 /**
1099 Function to dump information about DebugSupport Protocol.
1100
1101 @param[in] TheHandle The handle that has the protocol installed.
1102 @param[in] Verbose TRUE for additional information, FALSE otherwise.
1103
1104 @retval A pointer to a string containing the information.
1105 **/
1106 CHAR16*
1107 EFIAPI
1108 DebugSupportProtocolDumpInformation (
1109 IN CONST EFI_HANDLE TheHandle,
1110 IN CONST BOOLEAN Verbose
1111 )
1112 {
1113 EFI_STATUS Status;
1114 EFI_DEBUG_SUPPORT_PROTOCOL *DebugSupport;
1115 CHAR16 *GetString;
1116 CHAR16 *RetVal;
1117
1118 if (!Verbose) {
1119 return NULL;
1120 }
1121 GetString = NULL;
1122 RetVal = NULL;
1123 Status = gBS->OpenProtocol (
1124 TheHandle,
1125 &gEfiDebugSupportProtocolGuid,
1126 (VOID**)&DebugSupport,
1127 gImageHandle,
1128 NULL,
1129 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1130 );
1131 if (EFI_ERROR (Status)) {
1132 return NULL;
1133 }
1134 HandleParsingHiiInit ();
1135 GetString = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_DEBUGSUPPORT_INFO), NULL);
1136 if (GetString == NULL) {
1137 return NULL;
1138 }
1139 //
1140 // Dump Debug support info
1141 //
1142 switch (DebugSupport->Isa) {
1143 case (IsaIa32):
1144 RetVal = CatSPrint (RetVal, GetString, L"IA-32");
1145 break;
1146 case (IsaIpf):
1147 RetVal = CatSPrint (RetVal, GetString, L"IPF");
1148 break;
1149 case (IsaEbc):
1150 RetVal = CatSPrint (RetVal, GetString, L"EBC");
1151 break;
1152 default:
1153 SHELL_FREE_NON_NULL (GetString);
1154 GetString = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_DEBUGSUPPORT_UNKNOWN), NULL);
1155 RetVal = GetString != NULL ? CatSPrint (RetVal, GetString, DebugSupport->Isa) : NULL;
1156 break;
1157 }
1158
1159 SHELL_FREE_NON_NULL (GetString);
1160 return RetVal;
1161 }
1162
1163 /**
1164 Function to dump information about PciIoProtocol.
1165
1166 This will allocate the return buffer from boot services pool.
1167
1168 @param[in] TheHandle The handle that has PciRootBridgeIo installed.
1169 @param[in] Verbose TRUE for additional information, FALSE otherwise.
1170
1171 @retval A poitner to a string containing the information.
1172 **/
1173 CHAR16*
1174 EFIAPI
1175 PciIoProtocolDumpInformation (
1176 IN CONST EFI_HANDLE TheHandle,
1177 IN CONST BOOLEAN Verbose
1178 )
1179 {
1180 EFI_STATUS Status;
1181 EFI_PCI_IO_PROTOCOL *PciIo;
1182 PCI_TYPE00 Pci;
1183 UINTN Segment;
1184 UINTN Bus;
1185 UINTN Device;
1186 UINTN Function;
1187 UINTN Index;
1188 CHAR16 *GetString;
1189 CHAR16 *TempRetVal;
1190 CHAR16 *RetVal;
1191
1192 if (!Verbose) {
1193 return (NULL);
1194 }
1195 RetVal = NULL;
1196 GetString = NULL;
1197 TempRetVal = NULL;
1198 Status = gBS->OpenProtocol (
1199 TheHandle,
1200 &gEfiPciIoProtocolGuid,
1201 (VOID**)&PciIo,
1202 gImageHandle,
1203 NULL,
1204 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1205 );
1206
1207 if (EFI_ERROR(Status)) {
1208 return NULL;
1209 }
1210 PciIo->Pci.Read (PciIo, EfiPciIoWidthUint8, 0, sizeof (Pci), &Pci);
1211 PciIo->GetLocation (PciIo, &Segment, &Bus, &Device, &Function);
1212 HandleParsingHiiInit ();
1213 GetString = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIIO_DUMP_MAIN), NULL);
1214 if (GetString == NULL) {
1215 return NULL;
1216 }
1217 RetVal = CatSPrint (
1218 NULL,
1219 GetString,
1220 Segment,
1221 Bus,
1222 Device,
1223 Function,
1224 PciIo->RomSize,
1225 PciIo->RomImage,
1226 Pci.Hdr.VendorId,
1227 Pci.Hdr.DeviceId,
1228 Pci.Hdr.ClassCode[0],
1229 Pci.Hdr.ClassCode[1],
1230 Pci.Hdr.ClassCode[2]
1231 );
1232 for (Index = 0; Index < sizeof (Pci); Index ++) {
1233 if ((Index % 0x10) == 0) {
1234 TempRetVal = CatSPrint (RetVal, L"\r\n %02x", *((UINT8 *) (&Pci) + Index));
1235 } else {
1236 TempRetVal = CatSPrint (RetVal, L"%02x", *((UINT8 *) (&Pci) + Index));
1237 }
1238 FreePool (RetVal);
1239 RetVal = TempRetVal;
1240 TempRetVal = NULL;
1241 }
1242
1243 FreePool(GetString);
1244 return RetVal;
1245 }
1246
1247 /**
1248 Function to dump information about UsbIoProtocol.
1249
1250 This will allocate the return buffer from boot services pool.
1251
1252 @param[in] TheHandle The handle that has PciRootBridgeIo installed.
1253 @param[in] Verbose TRUE for additional information, FALSE otherwise.
1254
1255 @retval A poitner to a string containing the information.
1256 **/
1257 CHAR16*
1258 EFIAPI
1259 UsbIoProtocolDumpInformation (
1260 IN CONST EFI_HANDLE TheHandle,
1261 IN CONST BOOLEAN Verbose
1262 )
1263 {
1264 EFI_STATUS Status;
1265 EFI_USB_IO_PROTOCOL *UsbIo;
1266 EFI_USB_INTERFACE_DESCRIPTOR InterfaceDesc;
1267 CHAR16 *GetString;
1268 CHAR16 *RetVal;
1269
1270 if (!Verbose) {
1271 return (NULL);
1272 }
1273 RetVal = NULL;
1274 GetString = NULL;
1275 Status = gBS->OpenProtocol (
1276 TheHandle,
1277 &gEfiUsbIoProtocolGuid,
1278 (VOID**)&UsbIo,
1279 gImageHandle,
1280 NULL,
1281 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1282 );
1283
1284 if (EFI_ERROR(Status)) {
1285 return NULL;
1286 }
1287 UsbIo->UsbGetInterfaceDescriptor (UsbIo, &InterfaceDesc);
1288 HandleParsingHiiInit ();
1289 GetString = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_USBIO_DUMP_MAIN), NULL);
1290 if (GetString == NULL) {
1291 return NULL;
1292 }
1293 RetVal = CatSPrint (
1294 NULL,
1295 GetString,
1296 InterfaceDesc.InterfaceNumber,
1297 InterfaceDesc.InterfaceClass,
1298 InterfaceDesc.InterfaceSubClass,
1299 InterfaceDesc.InterfaceProtocol
1300 );
1301
1302 FreePool (GetString);
1303 return RetVal;
1304 }
1305
1306 /**
1307 Function to dump information about EfiAdapterInformation Protocol.
1308
1309 @param[in] TheHandle The handle that has the protocol installed.
1310 @param[in] Verbose TRUE for additional information, FALSE otherwise.
1311
1312 @retval A pointer to a string containing the information.
1313 **/
1314 CHAR16*
1315 EFIAPI
1316 AdapterInformationDumpInformation (
1317 IN CONST EFI_HANDLE TheHandle,
1318 IN CONST BOOLEAN Verbose
1319 )
1320 {
1321 EFI_STATUS Status;
1322 EFI_ADAPTER_INFORMATION_PROTOCOL *EfiAdptrInfoProtocol;
1323 UINTN InfoTypesBufferCount;
1324 UINTN GuidIndex;
1325 EFI_GUID *InfoTypesBuffer;
1326 CHAR16 *GuidStr;
1327 CHAR16 *TempStr;
1328 CHAR16 *RetVal;
1329 CHAR16 *TempRetVal;
1330 VOID *InformationBlock;
1331 UINTN InformationBlockSize;
1332
1333 if (!Verbose) {
1334 return (CatSPrint(NULL, L"AdapterInfo"));
1335 }
1336
1337 InfoTypesBuffer = NULL;
1338 InformationBlock = NULL;
1339
1340
1341 Status = gBS->OpenProtocol (
1342 (EFI_HANDLE) (TheHandle),
1343 &gEfiAdapterInformationProtocolGuid,
1344 (VOID **) &EfiAdptrInfoProtocol,
1345 NULL,
1346 NULL,
1347 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1348 );
1349
1350 if (EFI_ERROR (Status)) {
1351 return NULL;
1352 }
1353
1354 //
1355 // Get a list of supported information types for this instance of the protocol.
1356 //
1357 Status = EfiAdptrInfoProtocol->GetSupportedTypes (
1358 EfiAdptrInfoProtocol,
1359 &InfoTypesBuffer,
1360 &InfoTypesBufferCount
1361 );
1362 RetVal = NULL;
1363 if (EFI_ERROR (Status)) {
1364 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GET_SUPP_TYPES_FAILED), NULL);
1365 if (TempStr != NULL) {
1366 RetVal = CatSPrint (NULL, TempStr, Status);
1367 } else {
1368 goto ERROR_EXIT;
1369 }
1370 } else {
1371 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_SUPP_TYPE_HEADER), NULL);
1372 if (TempStr == NULL) {
1373 goto ERROR_EXIT;
1374 }
1375 RetVal = CatSPrint (NULL, TempStr);
1376 SHELL_FREE_NON_NULL (TempStr);
1377
1378 for (GuidIndex = 0; GuidIndex < InfoTypesBufferCount; GuidIndex++) {
1379 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GUID_NUMBER), NULL);
1380 if (TempStr == NULL) {
1381 goto ERROR_EXIT;
1382 }
1383 TempRetVal = CatSPrint (RetVal, TempStr, (GuidIndex + 1), &InfoTypesBuffer[GuidIndex]);
1384 SHELL_FREE_NON_NULL (RetVal);
1385 RetVal = TempRetVal;
1386 SHELL_FREE_NON_NULL (TempStr);
1387
1388 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GUID_STRING), NULL);
1389 if (TempStr == NULL) {
1390 goto ERROR_EXIT;
1391 }
1392
1393 if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoMediaStateGuid)) {
1394 TempRetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoMediaStateGuid");
1395 SHELL_FREE_NON_NULL (RetVal);
1396 RetVal = TempRetVal;
1397 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoNetworkBootGuid)) {
1398 TempRetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoNetworkBootGuid");
1399 SHELL_FREE_NON_NULL (RetVal);
1400 RetVal = TempRetVal;
1401 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoSanMacAddressGuid)) {
1402 TempRetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoSanMacAddressGuid");
1403 SHELL_FREE_NON_NULL (RetVal);
1404 RetVal = TempRetVal;
1405 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoUndiIpv6SupportGuid)) {
1406 TempRetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoUndiIpv6SupportGuid");
1407 SHELL_FREE_NON_NULL (RetVal);
1408 RetVal = TempRetVal;
1409 } else {
1410
1411 GuidStr = GetStringNameFromGuid (&InfoTypesBuffer[GuidIndex], NULL);
1412 if (GuidStr == NULL) {
1413 TempRetVal = CatSPrint (RetVal, TempStr, L"UnknownInfoType");
1414 SHELL_FREE_NON_NULL (RetVal);
1415 RetVal = TempRetVal;
1416
1417 SHELL_FREE_NON_NULL (TempStr);
1418 SHELL_FREE_NON_NULL(GuidStr);
1419 //
1420 // So that we never have to pass this UnknownInfoType to the parsing function "GetInformation" service of AIP
1421 //
1422 continue;
1423 } else {
1424 TempRetVal = CatSPrint (RetVal, TempStr, GuidStr);
1425 SHELL_FREE_NON_NULL (RetVal);
1426 RetVal = TempRetVal;
1427 SHELL_FREE_NON_NULL(GuidStr);
1428 }
1429 }
1430
1431 SHELL_FREE_NON_NULL (TempStr);
1432
1433 Status = EfiAdptrInfoProtocol->GetInformation (
1434 EfiAdptrInfoProtocol,
1435 &InfoTypesBuffer[GuidIndex],
1436 &InformationBlock,
1437 &InformationBlockSize
1438 );
1439
1440 if (EFI_ERROR (Status)) {
1441 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GETINFO_FAILED), NULL);
1442 if (TempStr == NULL) {
1443 goto ERROR_EXIT;
1444 }
1445 TempRetVal = CatSPrint (RetVal, TempStr, Status);
1446 SHELL_FREE_NON_NULL (RetVal);
1447 RetVal = TempRetVal;
1448 } else {
1449 if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoMediaStateGuid)) {
1450 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_MEDIA_STATE), NULL);
1451 if (TempStr == NULL) {
1452 goto ERROR_EXIT;
1453 }
1454 TempRetVal = CatSPrint (
1455 RetVal,
1456 TempStr,
1457 ((EFI_ADAPTER_INFO_MEDIA_STATE *)InformationBlock)->MediaState,
1458 ((EFI_ADAPTER_INFO_MEDIA_STATE *)InformationBlock)->MediaState
1459 );
1460 SHELL_FREE_NON_NULL (RetVal);
1461 RetVal = TempRetVal;
1462 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoNetworkBootGuid)) {
1463 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_NETWORK_BOOT_INFO), NULL);
1464 if (TempStr == NULL) {
1465 goto ERROR_EXIT;
1466 }
1467 TempRetVal = CatSPrint (
1468 RetVal,
1469 TempStr,
1470 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv4BootCapablity,
1471 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv6BootCapablity,
1472 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->FCoeBootCapablity,
1473 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->OffloadCapability,
1474 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiMpioCapability,
1475 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv4Boot,
1476 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv6Boot,
1477 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->FCoeBoot
1478 );
1479 SHELL_FREE_NON_NULL (RetVal);
1480 RetVal = TempRetVal;
1481 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoSanMacAddressGuid) == TRUE) {
1482 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_SAN_MAC_ADDRESS_INFO), NULL);
1483 if (TempStr == NULL) {
1484 goto ERROR_EXIT;
1485 }
1486 TempRetVal = CatSPrint (
1487 RetVal,
1488 TempStr,
1489 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[0],
1490 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[1],
1491 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[2],
1492 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[3],
1493 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[4],
1494 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[5]
1495 );
1496 SHELL_FREE_NON_NULL (RetVal);
1497 RetVal = TempRetVal;
1498 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoUndiIpv6SupportGuid) == TRUE) {
1499 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_UNDI_IPV6_INFO), NULL);
1500 if (TempStr == NULL) {
1501 goto ERROR_EXIT;
1502 }
1503
1504 TempRetVal = CatSPrint (
1505 RetVal,
1506 TempStr,
1507 ((EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT *)InformationBlock)->Ipv6Support
1508 );
1509 SHELL_FREE_NON_NULL (RetVal);
1510 RetVal = TempRetVal;
1511 } else {
1512 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_UNKNOWN_INFO_TYPE), NULL);
1513 if (TempStr == NULL) {
1514 goto ERROR_EXIT;
1515 }
1516 TempRetVal = CatSPrint (RetVal, TempStr, &InfoTypesBuffer[GuidIndex]);
1517 SHELL_FREE_NON_NULL (RetVal);
1518 RetVal = TempRetVal;
1519 }
1520 }
1521 SHELL_FREE_NON_NULL (TempStr);
1522 SHELL_FREE_NON_NULL (InformationBlock);
1523 }
1524 }
1525
1526 SHELL_FREE_NON_NULL (InfoTypesBuffer);
1527 return RetVal;
1528
1529 ERROR_EXIT:
1530 SHELL_FREE_NON_NULL (RetVal);
1531 SHELL_FREE_NON_NULL (InfoTypesBuffer);
1532 SHELL_FREE_NON_NULL (InformationBlock);
1533 return NULL;
1534 }
1535
1536 /**
1537 Function to dump information about EFI_FIRMWARE_MANAGEMENT_PROTOCOL Protocol.
1538
1539 @param[in] TheHandle The handle that has the protocol installed.
1540 @param[in] Verbose TRUE for additional information, FALSE otherwise.
1541
1542 @retval A pointer to a string containing the information.
1543 **/
1544 CHAR16*
1545 EFIAPI
1546 FirmwareManagementDumpInformation (
1547 IN CONST EFI_HANDLE TheHandle,
1548 IN CONST BOOLEAN Verbose
1549 )
1550 {
1551 EFI_STATUS Status;
1552 EFI_FIRMWARE_MANAGEMENT_PROTOCOL *EfiFwMgmtProtocol;
1553 EFI_FIRMWARE_IMAGE_DESCRIPTOR *ImageInfo;
1554 EFI_FIRMWARE_IMAGE_DESCRIPTOR_V1 *ImageInfoV1;
1555 EFI_FIRMWARE_IMAGE_DESCRIPTOR_V2 *ImageInfoV2;
1556 UINT64 AttributeSetting;
1557 UINTN ImageInfoSize;
1558 UINTN DescriptorSize;
1559 UINT32 DescriptorVersion;
1560 UINT32 PackageVersion;
1561 UINT8 DescriptorCount;
1562 UINT8 Index;
1563 UINT8 Index1;
1564 UINT8 ImageCount;
1565 CHAR16 *PackageVersionName;
1566 CHAR16 *TempStr;
1567 CHAR16 *RetVal;
1568 CHAR16 *TempRetVal;
1569 CHAR16 *AttributeSettingStr;
1570 BOOLEAN Found;
1571 BOOLEAN AttributeSupported;
1572
1573 //
1574 // Initialize local variables
1575 //
1576 ImageCount = 0;
1577 ImageInfoSize = 1;
1578 AttributeSetting = 0;
1579 Found = FALSE;
1580 AttributeSupported = FALSE;
1581 ImageInfo = NULL;
1582 ImageInfoV1 = NULL;
1583 ImageInfoV2 = NULL;
1584 PackageVersionName = NULL;
1585 RetVal = NULL;
1586 TempRetVal = NULL;
1587 TempStr = NULL;
1588 AttributeSettingStr = NULL;
1589
1590 if (!Verbose) {
1591 return (CatSPrint(NULL, L"FirmwareManagement"));
1592 }
1593
1594 Status = gBS->OpenProtocol (
1595 (EFI_HANDLE) (TheHandle),
1596 &gEfiFirmwareManagementProtocolGuid,
1597 (VOID **) &EfiFwMgmtProtocol,
1598 NULL,
1599 NULL,
1600 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1601 );
1602
1603 if (EFI_ERROR (Status)) {
1604 return NULL;
1605 }
1606
1607 Status = EfiFwMgmtProtocol->GetImageInfo (
1608 EfiFwMgmtProtocol,
1609 &ImageInfoSize,
1610 ImageInfo,
1611 &DescriptorVersion,
1612 &DescriptorCount,
1613 &DescriptorSize,
1614 &PackageVersion,
1615 &PackageVersionName
1616 );
1617
1618 if (Status == EFI_BUFFER_TOO_SMALL) {
1619 ImageInfo = AllocateZeroPool (ImageInfoSize);
1620
1621 if (ImageInfo == NULL) {
1622 Status = EFI_OUT_OF_RESOURCES;
1623 } else {
1624 Status = EfiFwMgmtProtocol->GetImageInfo (
1625 EfiFwMgmtProtocol,
1626 &ImageInfoSize,
1627 ImageInfo,
1628 &DescriptorVersion,
1629 &DescriptorCount,
1630 &DescriptorSize,
1631 &PackageVersion,
1632 &PackageVersionName
1633 );
1634 }
1635 }
1636
1637 if (EFI_ERROR (Status)) {
1638 goto ERROR_EXIT;
1639 }
1640
1641 //
1642 // Decode Image Descriptor data only if its version is supported
1643 //
1644 if (DescriptorVersion <= EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION) {
1645
1646 if (ImageInfo == NULL) {
1647 goto ERROR_EXIT;
1648 }
1649
1650 ImageInfoV1 = (EFI_FIRMWARE_IMAGE_DESCRIPTOR_V1 *)ImageInfo;
1651 ImageInfoV2 = (EFI_FIRMWARE_IMAGE_DESCRIPTOR_V2 *)ImageInfo;
1652
1653 //
1654 // Set ImageInfoSize in return buffer
1655 //
1656 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGE_INFO_SIZE), NULL);
1657 if (TempStr == NULL) {
1658 goto ERROR_EXIT;
1659 }
1660 RetVal = CatSPrint (NULL, TempStr, ImageInfoSize);
1661 SHELL_FREE_NON_NULL (TempStr);
1662
1663 //
1664 // Set DescriptorVersion in return buffer
1665 //
1666 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_DESCRIPTOR_VERSION), NULL);
1667 if (TempStr == NULL) {
1668 goto ERROR_EXIT;
1669 }
1670 TempRetVal = CatSPrint (RetVal, TempStr, DescriptorVersion);
1671 SHELL_FREE_NON_NULL (RetVal);
1672 RetVal = TempRetVal;
1673 SHELL_FREE_NON_NULL (TempStr);
1674
1675 //
1676 // Set DescriptorCount in return buffer
1677 //
1678 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_DESCRIPTOR_COUNT), NULL);
1679 if (TempStr == NULL) {
1680 goto ERROR_EXIT;
1681 }
1682 TempRetVal = CatSPrint (RetVal, TempStr, DescriptorCount);
1683 SHELL_FREE_NON_NULL (RetVal);
1684 RetVal = TempRetVal;
1685 SHELL_FREE_NON_NULL (TempStr);
1686
1687
1688 //
1689 // Set DescriptorSize in return buffer
1690 //
1691 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_DESCRIPTOR_SIZE), NULL);
1692 if (TempStr == NULL) {
1693 goto ERROR_EXIT;
1694 }
1695 TempRetVal = CatSPrint (RetVal, TempStr, DescriptorSize);
1696 SHELL_FREE_NON_NULL (RetVal);
1697 RetVal = TempRetVal;
1698 SHELL_FREE_NON_NULL (TempStr);
1699
1700 //
1701 // Set PackageVersion in return buffer
1702 //
1703 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_PACKAGE_VERSION), NULL);
1704 if (TempStr == NULL) {
1705 goto ERROR_EXIT;
1706 }
1707 TempRetVal = CatSPrint (RetVal, TempStr, PackageVersion);
1708 SHELL_FREE_NON_NULL (RetVal);
1709 RetVal = TempRetVal;
1710 SHELL_FREE_NON_NULL (TempStr);
1711
1712 //
1713 // Set PackageVersionName in return buffer
1714 //
1715 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_PACKAGE_VERSION_NAME), NULL);
1716 if (TempStr == NULL) {
1717 goto ERROR_EXIT;
1718 }
1719 TempRetVal = CatSPrint (RetVal, TempStr, PackageVersionName);
1720 SHELL_FREE_NON_NULL (RetVal);
1721 RetVal = TempRetVal;
1722 SHELL_FREE_NON_NULL (TempStr);
1723
1724 for (Index = 0; Index < DescriptorCount; Index++) {
1725 //
1726 // First check if Attribute is supported
1727 // and generate a string for AttributeSetting field
1728 //
1729 SHELL_FREE_NON_NULL (AttributeSettingStr);
1730 AttributeSupported = FALSE;
1731 AttributeSetting = 0;
1732 if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1) {
1733 if (ImageInfoV1[Index].AttributesSupported != 0x0) {
1734 AttributeSupported = TRUE;
1735 AttributeSetting = ImageInfoV1[Index].AttributesSetting;
1736 }
1737 } else if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2) {
1738 if (ImageInfoV2[Index].AttributesSupported != 0x0) {
1739 AttributeSupported = TRUE;
1740 AttributeSetting = ImageInfoV2[Index].AttributesSetting;
1741 }
1742 } else {
1743 if (ImageInfo[Index].AttributesSupported != 0x0) {
1744 AttributeSupported = TRUE;
1745 AttributeSetting = ImageInfo[Index].AttributesSetting;
1746 }
1747 }
1748
1749 if (!AttributeSupported) {
1750 AttributeSettingStr = CatSPrint (NULL, L"None");
1751 } else {
1752 AttributeSettingStr = CatSPrint (NULL, L"(");
1753
1754 if ((AttributeSetting & IMAGE_ATTRIBUTE_IMAGE_UPDATABLE) != 0x0) {
1755 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_IMAGE_UPDATABLE");
1756 SHELL_FREE_NON_NULL (AttributeSettingStr);
1757 AttributeSettingStr = TempRetVal;
1758 }
1759 if ((AttributeSetting & IMAGE_ATTRIBUTE_RESET_REQUIRED) != 0x0) {
1760 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_RESET_REQUIRED");
1761 SHELL_FREE_NON_NULL (AttributeSettingStr);
1762 AttributeSettingStr = TempRetVal;
1763 }
1764 if ((AttributeSetting & IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED) != 0x0) {
1765 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED");
1766 SHELL_FREE_NON_NULL (AttributeSettingStr);
1767 AttributeSettingStr = TempRetVal;
1768 }
1769 if ((AttributeSetting & IMAGE_ATTRIBUTE_IN_USE) != 0x0) {
1770 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_IN_USE");
1771 SHELL_FREE_NON_NULL (AttributeSettingStr);
1772 AttributeSettingStr = TempRetVal;
1773 }
1774 if ((AttributeSetting & IMAGE_ATTRIBUTE_UEFI_IMAGE) != 0x0) {
1775 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_UEFI_IMAGE");
1776 SHELL_FREE_NON_NULL (AttributeSettingStr);
1777 AttributeSettingStr = TempRetVal;
1778 }
1779 TempRetVal = CatSPrint (AttributeSettingStr, L" )");
1780 SHELL_FREE_NON_NULL (AttributeSettingStr);
1781 AttributeSettingStr = TempRetVal;
1782 }
1783
1784 if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1) {
1785 if (ImageInfoV1[Index].ImageIndex != 0x0) {
1786 ImageCount++;
1787 }
1788
1789 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO_V1), NULL);
1790 if (TempStr == NULL) {
1791 goto ERROR_EXIT;
1792 }
1793 TempRetVal = CatSPrint (
1794 RetVal,
1795 TempStr,
1796 Index,
1797 ImageInfoV1[Index].ImageIndex,
1798 &ImageInfoV1[Index].ImageTypeId,
1799 ImageInfoV1[Index].ImageId,
1800 ImageInfoV1[Index].ImageIdName,
1801 ImageInfoV1[Index].Version,
1802 ImageInfoV1[Index].VersionName,
1803 ImageInfoV1[Index].Size,
1804 ImageInfoV1[Index].AttributesSupported,
1805 AttributeSettingStr,
1806 ImageInfoV1[Index].Compatibilities
1807 );
1808 SHELL_FREE_NON_NULL (RetVal);
1809 RetVal = TempRetVal;
1810 SHELL_FREE_NON_NULL (TempStr);
1811 } else if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2) {
1812 if (ImageInfoV2[Index].ImageIndex != 0x0) {
1813 ImageCount++;
1814 }
1815
1816 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO_V2), NULL);
1817 if (TempStr == NULL) {
1818 goto ERROR_EXIT;
1819 }
1820 TempRetVal = CatSPrint (
1821 RetVal,
1822 TempStr,
1823 Index,
1824 ImageInfoV2[Index].ImageIndex,
1825 &ImageInfoV2[Index].ImageTypeId,
1826 ImageInfoV2[Index].ImageId,
1827 ImageInfoV2[Index].ImageIdName,
1828 ImageInfoV2[Index].Version,
1829 ImageInfoV2[Index].VersionName,
1830 ImageInfoV2[Index].Size,
1831 ImageInfoV2[Index].AttributesSupported,
1832 AttributeSettingStr,
1833 ImageInfoV2[Index].Compatibilities,
1834 ImageInfoV2[Index].LowestSupportedImageVersion
1835 );
1836 SHELL_FREE_NON_NULL (RetVal);
1837 RetVal = TempRetVal;
1838 SHELL_FREE_NON_NULL (TempStr);
1839 } else {
1840 if (ImageInfo[Index].ImageIndex != 0x0) {
1841 ImageCount++;
1842 }
1843
1844 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO), NULL);
1845 if (TempStr == NULL) {
1846 goto ERROR_EXIT;
1847 }
1848 TempRetVal = CatSPrint (
1849 RetVal,
1850 TempStr,
1851 Index,
1852 ImageInfo[Index].ImageIndex,
1853 &ImageInfo[Index].ImageTypeId,
1854 ImageInfo[Index].ImageId,
1855 ImageInfo[Index].ImageIdName,
1856 ImageInfo[Index].Version,
1857 ImageInfo[Index].VersionName,
1858 ImageInfo[Index].Size,
1859 ImageInfo[Index].AttributesSupported,
1860 AttributeSettingStr,
1861 ImageInfo[Index].Compatibilities,
1862 ImageInfo[Index].LowestSupportedImageVersion,
1863 ImageInfo[Index].LastAttemptVersion,
1864 ImageInfo[Index].LastAttemptStatus,
1865 ImageInfo[Index].HardwareInstance
1866 );
1867 SHELL_FREE_NON_NULL (RetVal);
1868 RetVal = TempRetVal;
1869 SHELL_FREE_NON_NULL (TempStr);
1870 }
1871 }
1872 }
1873
1874 if (ImageCount > 0) {
1875 for (Index=0; Index<DescriptorCount; Index++) {
1876 for (Index1=Index+1; Index1<DescriptorCount; Index1++) {
1877 if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1) {
1878 if (ImageInfoV1[Index].ImageId == ImageInfoV1[Index1].ImageId) {
1879 Found = TRUE;
1880 //
1881 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed
1882 //
1883 goto ENDLOOP;
1884 }
1885 } else if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2) {
1886 if (ImageInfoV2[Index].ImageId == ImageInfoV2[Index1].ImageId) {
1887 Found = TRUE;
1888 //
1889 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed
1890 //
1891 goto ENDLOOP;
1892 }
1893 } else {
1894 if (ImageInfo[Index].ImageId == ImageInfo[Index1].ImageId) {
1895 Found = TRUE;
1896 //
1897 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed
1898 //
1899 goto ENDLOOP;
1900 }
1901 }
1902 }
1903 }
1904 }
1905
1906 ENDLOOP:
1907 //
1908 // Check if ImageId with duplicate value was found
1909 //
1910 if (Found) {
1911 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGEID_NON_UNIQUE), NULL);
1912 if (TempStr == NULL) {
1913 goto ERROR_EXIT;
1914 }
1915 TempRetVal = CatSPrint (RetVal, TempStr);
1916 SHELL_FREE_NON_NULL (RetVal);
1917 RetVal = TempRetVal;
1918 SHELL_FREE_NON_NULL (TempStr);
1919 }
1920
1921 SHELL_FREE_NON_NULL (ImageInfo);
1922 SHELL_FREE_NON_NULL (PackageVersionName);
1923 SHELL_FREE_NON_NULL (AttributeSettingStr);
1924
1925 return RetVal;
1926
1927 ERROR_EXIT:
1928 SHELL_FREE_NON_NULL (RetVal);
1929 SHELL_FREE_NON_NULL (ImageInfo);
1930 SHELL_FREE_NON_NULL (PackageVersionName);
1931 SHELL_FREE_NON_NULL (AttributeSettingStr);
1932
1933 return NULL;
1934 }
1935
1936 //
1937 // Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg
1938 //
1939 #define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \
1940 { \
1941 0x58c518b1, 0x76f3, 0x11d4, { 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
1942 }
1943
1944 #define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \
1945 { \
1946 0x96eb4ad6, 0xa32a, 0x11d4, { 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
1947 }
1948
1949 #define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \
1950 { \
1951 0xc95a93d, 0xa006, 0x11d4, { 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
1952 }
1953 STATIC CONST EFI_GUID WinNtThunkProtocolGuid = LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID;
1954 STATIC CONST EFI_GUID WinNtIoProtocolGuid = LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID;
1955 STATIC CONST EFI_GUID WinNtSerialPortGuid = LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID;
1956
1957 //
1958 // Deprecated protocols we dont want to link from IntelFrameworkModulePkg
1959 //
1960 #define LOCAL_EFI_ISA_IO_PROTOCOL_GUID \
1961 { \
1962 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
1963 }
1964 #define LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID \
1965 { \
1966 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 } \
1967 }
1968 STATIC CONST EFI_GUID EfiIsaIoProtocolGuid = LOCAL_EFI_ISA_IO_PROTOCOL_GUID;
1969 STATIC CONST EFI_GUID EfiIsaAcpiProtocolGuid = LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID;
1970
1971
1972 STATIC CONST GUID_INFO_BLOCK mGuidStringListNT[] = {
1973 {STRING_TOKEN(STR_WINNT_THUNK), (EFI_GUID*)&WinNtThunkProtocolGuid, NULL},
1974 {STRING_TOKEN(STR_WINNT_DRIVER_IO), (EFI_GUID*)&WinNtIoProtocolGuid, NULL},
1975 {STRING_TOKEN(STR_WINNT_SERIAL_PORT), (EFI_GUID*)&WinNtSerialPortGuid, NULL},
1976 {0, NULL, NULL},
1977 };
1978
1979 STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {
1980 {STRING_TOKEN(STR_LOADED_IMAGE), &gEfiLoadedImageProtocolGuid, LoadedImageProtocolDumpInformation},
1981 {STRING_TOKEN(STR_DEVICE_PATH), &gEfiDevicePathProtocolGuid, DevicePathProtocolDumpInformation},
1982 {STRING_TOKEN(STR_IMAGE_PATH), &gEfiLoadedImageDevicePathProtocolGuid, LoadedImageDevicePathProtocolDumpInformation},
1983 {STRING_TOKEN(STR_DEVICE_PATH_UTIL), &gEfiDevicePathUtilitiesProtocolGuid, NULL},
1984 {STRING_TOKEN(STR_DEVICE_PATH_TXT), &gEfiDevicePathToTextProtocolGuid, NULL},
1985 {STRING_TOKEN(STR_DEVICE_PATH_FTXT), &gEfiDevicePathFromTextProtocolGuid, NULL},
1986 {STRING_TOKEN(STR_DEVICE_PATH_PC), &gEfiPcAnsiGuid, NULL},
1987 {STRING_TOKEN(STR_DEVICE_PATH_VT100), &gEfiVT100Guid, NULL},
1988 {STRING_TOKEN(STR_DEVICE_PATH_VT100P), &gEfiVT100PlusGuid, NULL},
1989 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8), &gEfiVTUTF8Guid, NULL},
1990 {STRING_TOKEN(STR_DRIVER_BINDING), &gEfiDriverBindingProtocolGuid, NULL},
1991 {STRING_TOKEN(STR_PLATFORM_OVERRIDE), &gEfiPlatformDriverOverrideProtocolGuid, NULL},
1992 {STRING_TOKEN(STR_BUS_OVERRIDE), &gEfiBusSpecificDriverOverrideProtocolGuid, BusSpecificDriverOverrideProtocolDumpInformation},
1993 {STRING_TOKEN(STR_DRIVER_DIAG), &gEfiDriverDiagnosticsProtocolGuid, NULL},
1994 {STRING_TOKEN(STR_DRIVER_DIAG2), &gEfiDriverDiagnostics2ProtocolGuid, NULL},
1995 {STRING_TOKEN(STR_DRIVER_CN), &gEfiComponentNameProtocolGuid, NULL},
1996 {STRING_TOKEN(STR_DRIVER_CN2), &gEfiComponentName2ProtocolGuid, NULL},
1997 {STRING_TOKEN(STR_PLAT_DRV_CFG), &gEfiPlatformToDriverConfigurationProtocolGuid, NULL},
1998 {STRING_TOKEN(STR_DRIVER_VERSION), &gEfiDriverSupportedEfiVersionProtocolGuid, DriverEfiVersionProtocolDumpInformation},
1999 {STRING_TOKEN(STR_TXT_IN), &gEfiSimpleTextInProtocolGuid, NULL},
2000 {STRING_TOKEN(STR_TXT_IN_EX), &gEfiSimpleTextInputExProtocolGuid, NULL},
2001 {STRING_TOKEN(STR_TXT_OUT), &gEfiSimpleTextOutProtocolGuid, TxtOutProtocolDumpInformation},
2002 {STRING_TOKEN(STR_SIM_POINTER), &gEfiSimplePointerProtocolGuid, NULL},
2003 {STRING_TOKEN(STR_ABS_POINTER), &gEfiAbsolutePointerProtocolGuid, NULL},
2004 {STRING_TOKEN(STR_SERIAL_IO), &gEfiSerialIoProtocolGuid, NULL},
2005 {STRING_TOKEN(STR_GRAPHICS_OUTPUT), &gEfiGraphicsOutputProtocolGuid, GraphicsOutputProtocolDumpInformation},
2006 {STRING_TOKEN(STR_EDID_DISCOVERED), &gEfiEdidDiscoveredProtocolGuid, EdidDiscoveredProtocolDumpInformation},
2007 {STRING_TOKEN(STR_EDID_ACTIVE), &gEfiEdidActiveProtocolGuid, EdidActiveProtocolDumpInformation},
2008 {STRING_TOKEN(STR_EDID_OVERRIDE), &gEfiEdidOverrideProtocolGuid, NULL},
2009 {STRING_TOKEN(STR_CON_IN), &gEfiConsoleInDeviceGuid, NULL},
2010 {STRING_TOKEN(STR_CON_OUT), &gEfiConsoleOutDeviceGuid, NULL},
2011 {STRING_TOKEN(STR_STD_ERR), &gEfiStandardErrorDeviceGuid, NULL},
2012 {STRING_TOKEN(STR_LOAD_FILE), &gEfiLoadFileProtocolGuid, NULL},
2013 {STRING_TOKEN(STR_LOAD_FILE2), &gEfiLoadFile2ProtocolGuid, NULL},
2014 {STRING_TOKEN(STR_SIMPLE_FILE_SYS), &gEfiSimpleFileSystemProtocolGuid, NULL},
2015 {STRING_TOKEN(STR_TAPE_IO), &gEfiTapeIoProtocolGuid, NULL},
2016 {STRING_TOKEN(STR_DISK_IO), &gEfiDiskIoProtocolGuid, NULL},
2017 {STRING_TOKEN(STR_BLK_IO), &gEfiBlockIoProtocolGuid, BlockIoProtocolDumpInformation},
2018 {STRING_TOKEN(STR_UC), &gEfiUnicodeCollationProtocolGuid, NULL},
2019 {STRING_TOKEN(STR_UC2), &gEfiUnicodeCollation2ProtocolGuid, NULL},
2020 {STRING_TOKEN(STR_PCIRB_IO), &gEfiPciRootBridgeIoProtocolGuid, PciRootBridgeIoDumpInformation},
2021 {STRING_TOKEN(STR_PCI_IO), &gEfiPciIoProtocolGuid, PciIoProtocolDumpInformation},
2022 {STRING_TOKEN(STR_SCSI_PT), &gEfiScsiPassThruProtocolGuid, NULL},
2023 {STRING_TOKEN(STR_SCSI_IO), &gEfiScsiIoProtocolGuid, NULL},
2024 {STRING_TOKEN(STR_SCSI_PT_EXT), &gEfiExtScsiPassThruProtocolGuid, NULL},
2025 {STRING_TOKEN(STR_ISCSI), &gEfiIScsiInitiatorNameProtocolGuid, NULL},
2026 {STRING_TOKEN(STR_USB_IO), &gEfiUsbIoProtocolGuid, UsbIoProtocolDumpInformation},
2027 {STRING_TOKEN(STR_USB_HC), &gEfiUsbHcProtocolGuid, NULL},
2028 {STRING_TOKEN(STR_USB_HC2), &gEfiUsb2HcProtocolGuid, NULL},
2029 {STRING_TOKEN(STR_DEBUG_SUPPORT), &gEfiDebugSupportProtocolGuid, DebugSupportProtocolDumpInformation},
2030 {STRING_TOKEN(STR_DEBUG_PORT), &gEfiDebugPortProtocolGuid, NULL},
2031 {STRING_TOKEN(STR_DECOMPRESS), &gEfiDecompressProtocolGuid, NULL},
2032 {STRING_TOKEN(STR_ACPI_TABLE), &gEfiAcpiTableProtocolGuid, NULL},
2033 {STRING_TOKEN(STR_EBC_INTERPRETER), &gEfiEbcProtocolGuid, NULL},
2034 {STRING_TOKEN(STR_SNP), &gEfiSimpleNetworkProtocolGuid, NULL},
2035 {STRING_TOKEN(STR_NII), &gEfiNetworkInterfaceIdentifierProtocolGuid, NULL},
2036 {STRING_TOKEN(STR_NII_31), &gEfiNetworkInterfaceIdentifierProtocolGuid_31, NULL},
2037 {STRING_TOKEN(STR_PXE_BC), &gEfiPxeBaseCodeProtocolGuid, NULL},
2038 {STRING_TOKEN(STR_PXE_CB), &gEfiPxeBaseCodeCallbackProtocolGuid, NULL},
2039 {STRING_TOKEN(STR_BIS), &gEfiBisProtocolGuid, NULL},
2040 {STRING_TOKEN(STR_MNP_SB), &gEfiManagedNetworkServiceBindingProtocolGuid, NULL},
2041 {STRING_TOKEN(STR_MNP), &gEfiManagedNetworkProtocolGuid, NULL},
2042 {STRING_TOKEN(STR_ARP_SB), &gEfiArpServiceBindingProtocolGuid, NULL},
2043 {STRING_TOKEN(STR_ARP), &gEfiArpProtocolGuid, NULL},
2044 {STRING_TOKEN(STR_DHCPV4_SB), &gEfiDhcp4ServiceBindingProtocolGuid, NULL},
2045 {STRING_TOKEN(STR_DHCPV4), &gEfiDhcp4ProtocolGuid, NULL},
2046 {STRING_TOKEN(STR_TCPV4_SB), &gEfiTcp4ServiceBindingProtocolGuid, NULL},
2047 {STRING_TOKEN(STR_TCPV4), &gEfiTcp4ProtocolGuid, NULL},
2048 {STRING_TOKEN(STR_IPV4_SB), &gEfiIp4ServiceBindingProtocolGuid, NULL},
2049 {STRING_TOKEN(STR_IPV4), &gEfiIp4ProtocolGuid, NULL},
2050 {STRING_TOKEN(STR_IPV4_CFG), &gEfiIp4ConfigProtocolGuid, NULL},
2051 {STRING_TOKEN(STR_IPV4_CFG2), &gEfiIp4Config2ProtocolGuid, NULL},
2052 {STRING_TOKEN(STR_UDPV4_SB), &gEfiUdp4ServiceBindingProtocolGuid, NULL},
2053 {STRING_TOKEN(STR_UDPV4), &gEfiUdp4ProtocolGuid, NULL},
2054 {STRING_TOKEN(STR_MTFTPV4_SB), &gEfiMtftp4ServiceBindingProtocolGuid, NULL},
2055 {STRING_TOKEN(STR_MTFTPV4), &gEfiMtftp4ProtocolGuid, NULL},
2056 {STRING_TOKEN(STR_AUTH_INFO), &gEfiAuthenticationInfoProtocolGuid, NULL},
2057 {STRING_TOKEN(STR_HASH_SB), &gEfiHashServiceBindingProtocolGuid, NULL},
2058 {STRING_TOKEN(STR_HASH), &gEfiHashProtocolGuid, NULL},
2059 {STRING_TOKEN(STR_HII_FONT), &gEfiHiiFontProtocolGuid, NULL},
2060 {STRING_TOKEN(STR_HII_STRING), &gEfiHiiStringProtocolGuid, NULL},
2061 {STRING_TOKEN(STR_HII_IMAGE), &gEfiHiiImageProtocolGuid, NULL},
2062 {STRING_TOKEN(STR_HII_DATABASE), &gEfiHiiDatabaseProtocolGuid, NULL},
2063 {STRING_TOKEN(STR_HII_CONFIG_ROUT), &gEfiHiiConfigRoutingProtocolGuid, NULL},
2064 {STRING_TOKEN(STR_HII_CONFIG_ACC), &gEfiHiiConfigAccessProtocolGuid, NULL},
2065 {STRING_TOKEN(STR_HII_FORM_BROWSER2), &gEfiFormBrowser2ProtocolGuid, NULL},
2066 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE), &gEfiDriverFamilyOverrideProtocolGuid, NULL},
2067 {STRING_TOKEN(STR_PCD), &gPcdProtocolGuid, NULL},
2068 {STRING_TOKEN(STR_TCG), &gEfiTcgProtocolGuid, NULL},
2069 {STRING_TOKEN(STR_HII_PACKAGE_LIST), &gEfiHiiPackageListProtocolGuid, NULL},
2070
2071 //
2072 // the ones under this are deprecated by the current UEFI Spec, but may be found anyways...
2073 //
2074 {STRING_TOKEN(STR_SHELL_INTERFACE), &gEfiShellInterfaceGuid, NULL},
2075 {STRING_TOKEN(STR_SHELL_ENV2), &gEfiShellEnvironment2Guid, NULL},
2076 {STRING_TOKEN(STR_SHELL_ENV), &gEfiShellEnvironment2Guid, NULL},
2077 {STRING_TOKEN(STR_DEVICE_IO), &gEfiDeviceIoProtocolGuid, NULL},
2078 {STRING_TOKEN(STR_UGA_DRAW), &gEfiUgaDrawProtocolGuid, NULL},
2079 {STRING_TOKEN(STR_UGA_IO), &gEfiUgaIoProtocolGuid, NULL},
2080 {STRING_TOKEN(STR_ESP), &gEfiPartTypeSystemPartGuid, NULL},
2081 {STRING_TOKEN(STR_GPT_NBR), &gEfiPartTypeLegacyMbrGuid, NULL},
2082 {STRING_TOKEN(STR_DRIVER_CONFIG), &gEfiDriverConfigurationProtocolGuid, NULL},
2083 {STRING_TOKEN(STR_DRIVER_CONFIG2), &gEfiDriverConfiguration2ProtocolGuid, NULL},
2084
2085 //
2086 // these are using local (non-global) definitions to reduce package dependancy.
2087 //
2088 {STRING_TOKEN(STR_ISA_IO), (EFI_GUID*)&EfiIsaIoProtocolGuid, NULL},
2089 {STRING_TOKEN(STR_ISA_ACPI), (EFI_GUID*)&EfiIsaAcpiProtocolGuid, NULL},
2090
2091 //
2092 // the ones under this are GUID identified structs, not protocols
2093 //
2094 {STRING_TOKEN(STR_FILE_INFO), &gEfiFileInfoGuid, NULL},
2095 {STRING_TOKEN(STR_FILE_SYS_INFO), &gEfiFileSystemInfoGuid, NULL},
2096
2097 //
2098 // the ones under this are misc GUIDS.
2099 //
2100 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE), &gEfiGlobalVariableGuid, NULL},
2101
2102 //
2103 // UEFI 2.2
2104 //
2105 {STRING_TOKEN(STR_IP6_SB), &gEfiIp6ServiceBindingProtocolGuid, NULL},
2106 {STRING_TOKEN(STR_IP6), &gEfiIp6ProtocolGuid, NULL},
2107 {STRING_TOKEN(STR_IP6_CONFIG), &gEfiIp6ConfigProtocolGuid, NULL},
2108 {STRING_TOKEN(STR_MTFTP6_SB), &gEfiMtftp6ServiceBindingProtocolGuid, NULL},
2109 {STRING_TOKEN(STR_MTFTP6), &gEfiMtftp6ProtocolGuid, NULL},
2110 {STRING_TOKEN(STR_DHCP6_SB), &gEfiDhcp6ServiceBindingProtocolGuid, NULL},
2111 {STRING_TOKEN(STR_DHCP6), &gEfiDhcp6ProtocolGuid, NULL},
2112 {STRING_TOKEN(STR_UDP6_SB), &gEfiUdp6ServiceBindingProtocolGuid, NULL},
2113 {STRING_TOKEN(STR_UDP6), &gEfiUdp6ProtocolGuid, NULL},
2114 {STRING_TOKEN(STR_TCP6_SB), &gEfiTcp6ServiceBindingProtocolGuid, NULL},
2115 {STRING_TOKEN(STR_TCP6), &gEfiTcp6ProtocolGuid, NULL},
2116 {STRING_TOKEN(STR_VLAN_CONFIG), &gEfiVlanConfigProtocolGuid, NULL},
2117 {STRING_TOKEN(STR_EAP), &gEfiEapProtocolGuid, NULL},
2118 {STRING_TOKEN(STR_EAP_MGMT), &gEfiEapManagementProtocolGuid, NULL},
2119 {STRING_TOKEN(STR_FTP4_SB), &gEfiFtp4ServiceBindingProtocolGuid, NULL},
2120 {STRING_TOKEN(STR_FTP4), &gEfiFtp4ProtocolGuid, NULL},
2121 {STRING_TOKEN(STR_IP_SEC_CONFIG), &gEfiIpSecConfigProtocolGuid, NULL},
2122 {STRING_TOKEN(STR_DH), &gEfiDriverHealthProtocolGuid, NULL},
2123 {STRING_TOKEN(STR_DEF_IMG_LOAD), &gEfiDeferredImageLoadProtocolGuid, NULL},
2124 {STRING_TOKEN(STR_USER_CRED), &gEfiUserCredentialProtocolGuid, NULL},
2125 {STRING_TOKEN(STR_USER_MNGR), &gEfiUserManagerProtocolGuid, NULL},
2126 {STRING_TOKEN(STR_ATA_PASS_THRU), &gEfiAtaPassThruProtocolGuid, NULL},
2127
2128 //
2129 // UEFI 2.3
2130 //
2131 {STRING_TOKEN(STR_FW_MGMT), &gEfiFirmwareManagementProtocolGuid, FirmwareManagementDumpInformation},
2132 {STRING_TOKEN(STR_IP_SEC), &gEfiIpSecProtocolGuid, NULL},
2133 {STRING_TOKEN(STR_IP_SEC2), &gEfiIpSec2ProtocolGuid, NULL},
2134
2135 //
2136 // UEFI 2.3.1
2137 //
2138 {STRING_TOKEN(STR_KMS), &gEfiKmsProtocolGuid, NULL},
2139 {STRING_TOKEN(STR_BLK_IO2), &gEfiBlockIo2ProtocolGuid, NULL},
2140 {STRING_TOKEN(STR_SSC), &gEfiStorageSecurityCommandProtocolGuid, NULL},
2141 {STRING_TOKEN(STR_UCRED2), &gEfiUserCredential2ProtocolGuid, NULL},
2142
2143 //
2144 // UEFI 2.4
2145 //
2146 {STRING_TOKEN(STR_DISK_IO2), &gEfiDiskIo2ProtocolGuid, NULL},
2147 {STRING_TOKEN(STR_ADAPTER_INFO), &gEfiAdapterInformationProtocolGuid, AdapterInformationDumpInformation},
2148
2149 //
2150 // PI Spec ones
2151 //
2152 {STRING_TOKEN(STR_IDE_CONT_INIT), &gEfiIdeControllerInitProtocolGuid, NULL},
2153 {STRING_TOKEN(STR_DISK_INFO), &gEfiDiskInfoProtocolGuid, NULL},
2154
2155 //
2156 // PI Spec 1.0
2157 //
2158 {STRING_TOKEN(STR_BDS_ARCH), &gEfiBdsArchProtocolGuid, NULL},
2159 {STRING_TOKEN(STR_CPU_ARCH), &gEfiCpuArchProtocolGuid, NULL},
2160 {STRING_TOKEN(STR_MET_ARCH), &gEfiMetronomeArchProtocolGuid, NULL},
2161 {STRING_TOKEN(STR_MON_ARCH), &gEfiMonotonicCounterArchProtocolGuid, NULL},
2162 {STRING_TOKEN(STR_RTC_ARCH), &gEfiRealTimeClockArchProtocolGuid, NULL},
2163 {STRING_TOKEN(STR_RESET_ARCH), &gEfiResetArchProtocolGuid, NULL},
2164 {STRING_TOKEN(STR_RT_ARCH), &gEfiRuntimeArchProtocolGuid, NULL},
2165 {STRING_TOKEN(STR_SEC_ARCH), &gEfiSecurityArchProtocolGuid, NULL},
2166 {STRING_TOKEN(STR_TIMER_ARCH), &gEfiTimerArchProtocolGuid, NULL},
2167 {STRING_TOKEN(STR_VAR_ARCH), &gEfiVariableWriteArchProtocolGuid, NULL},
2168 {STRING_TOKEN(STR_V_ARCH), &gEfiVariableArchProtocolGuid, NULL},
2169 {STRING_TOKEN(STR_SECP), &gEfiSecurityPolicyProtocolGuid, NULL},
2170 {STRING_TOKEN(STR_WDT_ARCH), &gEfiWatchdogTimerArchProtocolGuid, NULL},
2171 {STRING_TOKEN(STR_SCR), &gEfiStatusCodeRuntimeProtocolGuid, NULL},
2172 {STRING_TOKEN(STR_SMB_HC), &gEfiSmbusHcProtocolGuid, NULL},
2173 {STRING_TOKEN(STR_FV_2), &gEfiFirmwareVolume2ProtocolGuid, NULL},
2174 {STRING_TOKEN(STR_FV_BLOCK), &gEfiFirmwareVolumeBlockProtocolGuid, NULL},
2175 {STRING_TOKEN(STR_CAP_ARCH), &gEfiCapsuleArchProtocolGuid, NULL},
2176 {STRING_TOKEN(STR_MP_SERVICE), &gEfiMpServiceProtocolGuid, NULL},
2177 {STRING_TOKEN(STR_HBRAP), &gEfiPciHostBridgeResourceAllocationProtocolGuid, NULL},
2178 {STRING_TOKEN(STR_PCIP), &gEfiPciPlatformProtocolGuid, NULL},
2179 {STRING_TOKEN(STR_PCIO), &gEfiPciOverrideProtocolGuid, NULL},
2180 {STRING_TOKEN(STR_PCIE), &gEfiPciEnumerationCompleteProtocolGuid, NULL},
2181 {STRING_TOKEN(STR_IPCID), &gEfiIncompatiblePciDeviceSupportProtocolGuid, NULL},
2182 {STRING_TOKEN(STR_PCIHPI), &gEfiPciHotPlugInitProtocolGuid, NULL},
2183 {STRING_TOKEN(STR_PCIHPR), &gEfiPciHotPlugRequestProtocolGuid, NULL},
2184 {STRING_TOKEN(STR_SMBIOS), &gEfiSmbiosProtocolGuid, NULL},
2185 {STRING_TOKEN(STR_S3_SAVE), &gEfiS3SaveStateProtocolGuid, NULL},
2186 {STRING_TOKEN(STR_S3_S_SMM), &gEfiS3SmmSaveStateProtocolGuid, NULL},
2187 {STRING_TOKEN(STR_RSC), &gEfiRscHandlerProtocolGuid, NULL},
2188 {STRING_TOKEN(STR_S_RSC), &gEfiSmmRscHandlerProtocolGuid, NULL},
2189 {STRING_TOKEN(STR_ACPI_SDT), &gEfiAcpiSdtProtocolGuid, NULL},
2190 {STRING_TOKEN(STR_SIO), &gEfiSioProtocolGuid, NULL},
2191 {STRING_TOKEN(STR_S_CPU2), &gEfiSmmCpuIo2ProtocolGuid, NULL},
2192 {STRING_TOKEN(STR_S_BASE2), &gEfiSmmBase2ProtocolGuid, NULL},
2193 {STRING_TOKEN(STR_S_ACC_2), &gEfiSmmAccess2ProtocolGuid, NULL},
2194 {STRING_TOKEN(STR_S_CON_2), &gEfiSmmControl2ProtocolGuid, NULL},
2195 {STRING_TOKEN(STR_S_CONFIG), &gEfiSmmConfigurationProtocolGuid, NULL},
2196 {STRING_TOKEN(STR_S_RTL), &gEfiSmmReadyToLockProtocolGuid, NULL},
2197 {STRING_TOKEN(STR_DS_RTL), &gEfiDxeSmmReadyToLockProtocolGuid, NULL},
2198 {STRING_TOKEN(STR_S_COMM), &gEfiSmmCommunicationProtocolGuid, NULL},
2199 {STRING_TOKEN(STR_S_STAT), &gEfiSmmStatusCodeProtocolGuid, NULL},
2200 {STRING_TOKEN(STR_S_CPU), &gEfiSmmCpuProtocolGuid, NULL},
2201 {STRING_TOKEN(STR_S_PCIRBIO), &gEfiPciRootBridgeIoProtocolGuid, NULL},
2202 {STRING_TOKEN(STR_S_SWD), &gEfiSmmSwDispatch2ProtocolGuid, NULL},
2203 {STRING_TOKEN(STR_S_SXD), &gEfiSmmSxDispatch2ProtocolGuid, NULL},
2204 {STRING_TOKEN(STR_S_PTD2), &gEfiSmmPeriodicTimerDispatch2ProtocolGuid, NULL},
2205 {STRING_TOKEN(STR_S_UD2), &gEfiSmmUsbDispatch2ProtocolGuid, NULL},
2206 {STRING_TOKEN(STR_S_GD2), &gEfiSmmGpiDispatch2ProtocolGuid, NULL},
2207 {STRING_TOKEN(STR_S_SBD2), &gEfiSmmStandbyButtonDispatch2ProtocolGuid, NULL},
2208 {STRING_TOKEN(STR_S_PBD2), &gEfiSmmPowerButtonDispatch2ProtocolGuid, NULL},
2209 {STRING_TOKEN(STR_S_ITD2), &gEfiSmmIoTrapDispatch2ProtocolGuid, NULL},
2210 {STRING_TOKEN(STR_PCD), &gEfiPcdProtocolGuid, NULL},
2211 {STRING_TOKEN(STR_FVB2), &gEfiFirmwareVolumeBlock2ProtocolGuid, NULL},
2212 {STRING_TOKEN(STR_CPUIO2), &gEfiCpuIo2ProtocolGuid, NULL},
2213 {STRING_TOKEN(STR_LEGACY_R2), &gEfiLegacyRegion2ProtocolGuid, NULL},
2214 {STRING_TOKEN(STR_SAL_MIP), &gEfiSalMcaInitPmiProtocolGuid, NULL},
2215 {STRING_TOKEN(STR_ES_BS), &gEfiExtendedSalBootServiceProtocolGuid, NULL},
2216 {STRING_TOKEN(STR_ES_BIO), &gEfiExtendedSalBaseIoServicesProtocolGuid, NULL},
2217 {STRING_TOKEN(STR_ES_STALL), &gEfiExtendedSalStallServicesProtocolGuid, NULL},
2218 {STRING_TOKEN(STR_ES_RTC), &gEfiExtendedSalRtcServicesProtocolGuid, NULL},
2219 {STRING_TOKEN(STR_ES_VS), &gEfiExtendedSalVariableServicesProtocolGuid, NULL},
2220 {STRING_TOKEN(STR_ES_MTC), &gEfiExtendedSalMtcServicesProtocolGuid, NULL},
2221 {STRING_TOKEN(STR_ES_RESET), &gEfiExtendedSalResetServicesProtocolGuid, NULL},
2222 {STRING_TOKEN(STR_ES_SC), &gEfiExtendedSalStatusCodeServicesProtocolGuid, NULL},
2223 {STRING_TOKEN(STR_ES_FBS), &gEfiExtendedSalFvBlockServicesProtocolGuid, NULL},
2224 {STRING_TOKEN(STR_ES_MP), &gEfiExtendedSalMpServicesProtocolGuid, NULL},
2225 {STRING_TOKEN(STR_ES_PAL), &gEfiExtendedSalPalServicesProtocolGuid, NULL},
2226 {STRING_TOKEN(STR_ES_BASE), &gEfiExtendedSalBaseServicesProtocolGuid, NULL},
2227 {STRING_TOKEN(STR_ES_MCA), &gEfiExtendedSalMcaServicesProtocolGuid, NULL},
2228 {STRING_TOKEN(STR_ES_PCI), &gEfiExtendedSalPciServicesProtocolGuid, NULL},
2229 {STRING_TOKEN(STR_ES_CACHE), &gEfiExtendedSalCacheServicesProtocolGuid, NULL},
2230 {STRING_TOKEN(STR_ES_MCA_LOG), &gEfiExtendedSalMcaLogServicesProtocolGuid, NULL},
2231 {STRING_TOKEN(STR_S2ARCH), &gEfiSecurity2ArchProtocolGuid, NULL},
2232 {STRING_TOKEN(STR_EODXE), &gEfiSmmEndOfDxeProtocolGuid, NULL},
2233 {STRING_TOKEN(STR_ISAHC), &gEfiIsaHcProtocolGuid, NULL},
2234 {STRING_TOKEN(STR_ISAHC_B), &gEfiIsaHcServiceBindingProtocolGuid, NULL},
2235 {STRING_TOKEN(STR_SIO_C), &gEfiSioControlProtocolGuid, NULL},
2236 {STRING_TOKEN(STR_GET_PCD), &gEfiGetPcdInfoProtocolGuid, NULL},
2237 {STRING_TOKEN(STR_I2C_M), &gEfiI2cMasterProtocolGuid, NULL},
2238 {STRING_TOKEN(STR_I2CIO), &gEfiI2cIoProtocolGuid, NULL},
2239 {STRING_TOKEN(STR_I2CEN), &gEfiI2cEnumerateProtocolGuid, NULL},
2240 {STRING_TOKEN(STR_I2C_H), &gEfiI2cHostProtocolGuid, NULL},
2241 {STRING_TOKEN(STR_I2C_BCM), &gEfiI2cBusConfigurationManagementProtocolGuid, NULL},
2242 {STRING_TOKEN(STR_TREE), &gEfiTrEEProtocolGuid, NULL},
2243 {STRING_TOKEN(STR_TCG2), &gEfiTcg2ProtocolGuid, NULL},
2244 {STRING_TOKEN(STR_TIMESTAMP), &gEfiTimestampProtocolGuid, NULL},
2245 {STRING_TOKEN(STR_RNG), &gEfiRngProtocolGuid, NULL},
2246 {STRING_TOKEN(STR_NVMEPT), &gEfiNvmExpressPassThruProtocolGuid, NULL},
2247 {STRING_TOKEN(STR_H2_SB), &gEfiHash2ServiceBindingProtocolGuid, NULL},
2248 {STRING_TOKEN(STR_HASH2), &gEfiHash2ProtocolGuid, NULL},
2249 {STRING_TOKEN(STR_BIO_C), &gEfiBlockIoCryptoProtocolGuid, NULL},
2250 {STRING_TOKEN(STR_SCR), &gEfiSmartCardReaderProtocolGuid, NULL},
2251 {STRING_TOKEN(STR_SCE), &gEfiSmartCardEdgeProtocolGuid, NULL},
2252 {STRING_TOKEN(STR_USB_FIO), &gEfiUsbFunctionIoProtocolGuid, NULL},
2253 {STRING_TOKEN(STR_BC_HC), &gEfiBluetoothHcProtocolGuid, NULL},
2254 {STRING_TOKEN(STR_BC_IO_SB), &gEfiBluetoothIoServiceBindingProtocolGuid, NULL},
2255 {STRING_TOKEN(STR_BC_IO), &gEfiBluetoothIoProtocolGuid, NULL},
2256 {STRING_TOKEN(STR_BC_C), &gEfiBluetoothConfigProtocolGuid, NULL},
2257 {STRING_TOKEN(STR_REG_EXP), &gEfiRegularExpressionProtocolGuid, NULL},
2258 {STRING_TOKEN(STR_B_MGR_P), &gEfiBootManagerPolicyProtocolGuid, NULL},
2259 {STRING_TOKEN(STR_CKH), &gEfiConfigKeywordHandlerProtocolGuid, NULL},
2260 {STRING_TOKEN(STR_WIFI), &gEfiWiFiProtocolGuid, NULL},
2261 {STRING_TOKEN(STR_EAP_M), &gEfiEapManagement2ProtocolGuid, NULL},
2262 {STRING_TOKEN(STR_EAP_C), &gEfiEapConfigurationProtocolGuid, NULL},
2263 {STRING_TOKEN(STR_PKCS7), &gEfiPkcs7VerifyProtocolGuid, NULL},
2264 {STRING_TOKEN(STR_NET_DNS4_SB), &gEfiDns4ServiceBindingProtocolGuid, NULL},
2265 {STRING_TOKEN(STR_NET_DNS4), &gEfiDns4ProtocolGuid, NULL},
2266 {STRING_TOKEN(STR_NET_DNS6_SB), &gEfiDns6ServiceBindingProtocolGuid, NULL},
2267 {STRING_TOKEN(STR_NET_DNS6), &gEfiDns6ProtocolGuid, NULL},
2268 {STRING_TOKEN(STR_NET_HTTP_SB), &gEfiHttpServiceBindingProtocolGuid, NULL},
2269 {STRING_TOKEN(STR_NET_HTTP), &gEfiHttpProtocolGuid, NULL},
2270 {STRING_TOKEN(STR_NET_HTTP_U), &gEfiHttpUtilitiesProtocolGuid, NULL},
2271 {STRING_TOKEN(STR_REST), &gEfiRestProtocolGuid, NULL},
2272
2273 //
2274 // UEFI Shell Spec 2.0
2275 //
2276 {STRING_TOKEN(STR_SHELL_PARAMETERS), &gEfiShellParametersProtocolGuid, NULL},
2277 {STRING_TOKEN(STR_SHELL), &gEfiShellProtocolGuid, NULL},
2278
2279 //
2280 // UEFI Shell Spec 2.1
2281 //
2282 {STRING_TOKEN(STR_SHELL_DYNAMIC), &gEfiShellDynamicCommandProtocolGuid, NULL},
2283
2284 //
2285 // Misc
2286 //
2287 {STRING_TOKEN(STR_PCDINFOPROT), &gGetPcdInfoProtocolGuid, NULL},
2288
2289 //
2290 // terminator
2291 //
2292 {0, NULL, NULL},
2293 };
2294
2295 /**
2296 Function to get the node for a protocol or struct from it's GUID.
2297
2298 if Guid is NULL, then ASSERT.
2299
2300 @param[in] Guid The GUID to look for the name of.
2301
2302 @return The node.
2303 **/
2304 CONST GUID_INFO_BLOCK *
2305 InternalShellGetNodeFromGuid(
2306 IN CONST EFI_GUID* Guid
2307 )
2308 {
2309 CONST GUID_INFO_BLOCK *ListWalker;
2310 UINTN LoopCount;
2311
2312 ASSERT(Guid != NULL);
2313
2314 for (LoopCount = 0, ListWalker = mGuidList; mGuidList != NULL && LoopCount < mGuidListCount; LoopCount++, ListWalker++) {
2315 if (CompareGuid(ListWalker->GuidId, Guid)) {
2316 return (ListWalker);
2317 }
2318 }
2319
2320 if (PcdGetBool(PcdShellIncludeNtGuids)) {
2321 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
2322 if (CompareGuid(ListWalker->GuidId, Guid)) {
2323 return (ListWalker);
2324 }
2325 }
2326 }
2327 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
2328 if (CompareGuid(ListWalker->GuidId, Guid)) {
2329 return (ListWalker);
2330 }
2331 }
2332 return (NULL);
2333 }
2334
2335 /**
2336 Function to add a new GUID/Name mapping.
2337
2338 @param[in] Guid The Guid
2339 @param[in] NameID The STRING id of the HII string to use
2340 @param[in] DumpFunc The pointer to the dump function
2341
2342
2343 @retval EFI_SUCCESS The operation was sucessful
2344 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
2345 @retval EFI_INVALID_PARAMETER Guid NameId was invalid
2346 **/
2347 EFI_STATUS
2348 InsertNewGuidNameMapping(
2349 IN CONST EFI_GUID *Guid,
2350 IN CONST EFI_STRING_ID NameID,
2351 IN CONST DUMP_PROTOCOL_INFO DumpFunc OPTIONAL
2352 )
2353 {
2354 ASSERT(Guid != NULL);
2355 ASSERT(NameID != 0);
2356
2357 mGuidList = ReallocatePool(mGuidListCount * sizeof(GUID_INFO_BLOCK), mGuidListCount+1 * sizeof(GUID_INFO_BLOCK), mGuidList);
2358 if (mGuidList == NULL) {
2359 mGuidListCount = 0;
2360 return (EFI_OUT_OF_RESOURCES);
2361 }
2362 mGuidListCount++;
2363
2364 mGuidList[mGuidListCount - 1].GuidId = AllocateCopyPool(sizeof(EFI_GUID), Guid);
2365 mGuidList[mGuidListCount - 1].StringId = NameID;
2366 mGuidList[mGuidListCount - 1].DumpInfo = DumpFunc;
2367
2368 if (mGuidList[mGuidListCount - 1].GuidId == NULL) {
2369 return (EFI_OUT_OF_RESOURCES);
2370 }
2371
2372 return (EFI_SUCCESS);
2373 }
2374
2375 /**
2376 Function to add a new GUID/Name mapping.
2377
2378 This cannot overwrite an existing mapping.
2379
2380 @param[in] Guid The Guid
2381 @param[in] TheName The Guid's name
2382 @param[in] Lang RFC4646 language code list or NULL
2383
2384 @retval EFI_SUCCESS The operation was sucessful
2385 @retval EFI_ACCESS_DENIED There was a duplicate
2386 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
2387 @retval EFI_INVALID_PARAMETER Guid or TheName was NULL
2388 **/
2389 EFI_STATUS
2390 EFIAPI
2391 AddNewGuidNameMapping(
2392 IN CONST EFI_GUID *Guid,
2393 IN CONST CHAR16 *TheName,
2394 IN CONST CHAR8 *Lang OPTIONAL
2395 )
2396 {
2397 EFI_STRING_ID NameID;
2398
2399 HandleParsingHiiInit();
2400
2401 if (Guid == NULL || TheName == NULL){
2402 return (EFI_INVALID_PARAMETER);
2403 }
2404
2405 if ((InternalShellGetNodeFromGuid(Guid)) != NULL) {
2406 return (EFI_ACCESS_DENIED);
2407 }
2408
2409 NameID = HiiSetString(mHandleParsingHiiHandle, 0, (CHAR16*)TheName, Lang);
2410 if (NameID == 0) {
2411 return (EFI_OUT_OF_RESOURCES);
2412 }
2413
2414 return (InsertNewGuidNameMapping(Guid, NameID, NULL));
2415 }
2416
2417 /**
2418 Function to get the name of a protocol or struct from it's GUID.
2419
2420 if Guid is NULL, then ASSERT.
2421
2422 @param[in] Guid The GUID to look for the name of.
2423 @param[in] Lang The language to use.
2424
2425 @return pointer to string of the name. The caller
2426 is responsible to free this memory.
2427 **/
2428 CHAR16*
2429 EFIAPI
2430 GetStringNameFromGuid(
2431 IN CONST EFI_GUID *Guid,
2432 IN CONST CHAR8 *Lang OPTIONAL
2433 )
2434 {
2435 CONST GUID_INFO_BLOCK *Id;
2436
2437 HandleParsingHiiInit();
2438
2439 Id = InternalShellGetNodeFromGuid(Guid);
2440 if (Id == NULL) {
2441 return NULL;
2442 }
2443 return HiiGetString (mHandleParsingHiiHandle, Id->StringId, Lang);
2444 }
2445
2446 /**
2447 Function to dump protocol information from a handle.
2448
2449 This function will return a allocated string buffer containing the
2450 information. The caller is responsible for freeing the memory.
2451
2452 If Guid is NULL, ASSERT().
2453 If TheHandle is NULL, ASSERT().
2454
2455 @param[in] TheHandle The handle to dump information from.
2456 @param[in] Guid The GUID of the protocol to dump.
2457 @param[in] Verbose TRUE for extra info. FALSE otherwise.
2458
2459 @return The pointer to string.
2460 @retval NULL An error was encountered.
2461 **/
2462 CHAR16*
2463 EFIAPI
2464 GetProtocolInformationDump(
2465 IN CONST EFI_HANDLE TheHandle,
2466 IN CONST EFI_GUID *Guid,
2467 IN CONST BOOLEAN Verbose
2468 )
2469 {
2470 CONST GUID_INFO_BLOCK *Id;
2471
2472 ASSERT(TheHandle != NULL);
2473 ASSERT(Guid != NULL);
2474
2475 if (TheHandle == NULL || Guid == NULL) {
2476 return (NULL);
2477 }
2478
2479 Id = InternalShellGetNodeFromGuid(Guid);
2480 if (Id != NULL && Id->DumpInfo != NULL) {
2481 return (Id->DumpInfo(TheHandle, Verbose));
2482 }
2483 return (NULL);
2484 }
2485
2486 /**
2487 Function to get the Guid for a protocol or struct based on it's string name.
2488
2489 do not modify the returned Guid.
2490
2491 @param[in] Name The pointer to the string name.
2492 @param[in] Lang The pointer to the language code.
2493 @param[out] Guid The pointer to the Guid.
2494
2495 @retval EFI_SUCCESS The operation was sucessful.
2496 **/
2497 EFI_STATUS
2498 EFIAPI
2499 GetGuidFromStringName(
2500 IN CONST CHAR16 *Name,
2501 IN CONST CHAR8 *Lang OPTIONAL,
2502 OUT EFI_GUID **Guid
2503 )
2504 {
2505 CONST GUID_INFO_BLOCK *ListWalker;
2506 CHAR16 *String;
2507 UINTN LoopCount;
2508
2509 HandleParsingHiiInit();
2510
2511 ASSERT(Guid != NULL);
2512 if (Guid == NULL) {
2513 return (EFI_INVALID_PARAMETER);
2514 }
2515 *Guid = NULL;
2516
2517 if (PcdGetBool(PcdShellIncludeNtGuids)) {
2518 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
2519 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);
2520 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {
2521 *Guid = ListWalker->GuidId;
2522 }
2523 SHELL_FREE_NON_NULL(String);
2524 if (*Guid != NULL) {
2525 return (EFI_SUCCESS);
2526 }
2527 }
2528 }
2529 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
2530 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);
2531 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {
2532 *Guid = ListWalker->GuidId;
2533 }
2534 SHELL_FREE_NON_NULL(String);
2535 if (*Guid != NULL) {
2536 return (EFI_SUCCESS);
2537 }
2538 }
2539
2540 for (LoopCount = 0, ListWalker = mGuidList; mGuidList != NULL && LoopCount < mGuidListCount; LoopCount++, ListWalker++) {
2541 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);
2542 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {
2543 *Guid = ListWalker->GuidId;
2544 }
2545 SHELL_FREE_NON_NULL(String);
2546 if (*Guid != NULL) {
2547 return (EFI_SUCCESS);
2548 }
2549 }
2550
2551 return (EFI_NOT_FOUND);
2552 }
2553
2554 /**
2555 Get best support language for this driver.
2556
2557 First base on the user input language to search, second base on the current
2558 platform used language to search, third get the first language from the
2559 support language list. The caller need to free the buffer of the best language.
2560
2561 @param[in] SupportedLanguages The support languages for this driver.
2562 @param[in] InputLanguage The user input language.
2563 @param[in] Iso639Language Whether get language for ISO639.
2564
2565 @return The best support language for this driver.
2566 **/
2567 CHAR8 *
2568 EFIAPI
2569 GetBestLanguageForDriver (
2570 IN CONST CHAR8 *SupportedLanguages,
2571 IN CONST CHAR8 *InputLanguage,
2572 IN BOOLEAN Iso639Language
2573 )
2574 {
2575 CHAR8 *LanguageVariable;
2576 CHAR8 *BestLanguage;
2577
2578 GetVariable2 (Iso639Language ? L"Lang" : L"PlatformLang", &gEfiGlobalVariableGuid, (VOID**)&LanguageVariable, NULL);
2579
2580 BestLanguage = GetBestLanguage(
2581 SupportedLanguages,
2582 Iso639Language,
2583 (InputLanguage != NULL) ? InputLanguage : "",
2584 (LanguageVariable != NULL) ? LanguageVariable : "",
2585 SupportedLanguages,
2586 NULL
2587 );
2588
2589 if (LanguageVariable != NULL) {
2590 FreePool (LanguageVariable);
2591 }
2592
2593 return BestLanguage;
2594 }
2595
2596 /**
2597 Function to retrieve the driver name (if possible) from the ComponentName or
2598 ComponentName2 protocol
2599
2600 @param[in] TheHandle The driver handle to get the name of.
2601 @param[in] Language The language to use.
2602
2603 @retval NULL The name could not be found.
2604 @return A pointer to the string name. Do not de-allocate the memory.
2605 **/
2606 CONST CHAR16*
2607 EFIAPI
2608 GetStringNameFromHandle(
2609 IN CONST EFI_HANDLE TheHandle,
2610 IN CONST CHAR8 *Language
2611 )
2612 {
2613 EFI_COMPONENT_NAME2_PROTOCOL *CompNameStruct;
2614 EFI_STATUS Status;
2615 CHAR16 *RetVal;
2616 CHAR8 *BestLang;
2617
2618 BestLang = NULL;
2619
2620 Status = gBS->OpenProtocol(
2621 TheHandle,
2622 &gEfiComponentName2ProtocolGuid,
2623 (VOID**)&CompNameStruct,
2624 gImageHandle,
2625 NULL,
2626 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
2627 if (!EFI_ERROR(Status)) {
2628 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);
2629 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);
2630 if (BestLang != NULL) {
2631 FreePool (BestLang);
2632 BestLang = NULL;
2633 }
2634 if (!EFI_ERROR(Status)) {
2635 return (RetVal);
2636 }
2637 }
2638 Status = gBS->OpenProtocol(
2639 TheHandle,
2640 &gEfiComponentNameProtocolGuid,
2641 (VOID**)&CompNameStruct,
2642 gImageHandle,
2643 NULL,
2644 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
2645 if (!EFI_ERROR(Status)) {
2646 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);
2647 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);
2648 if (BestLang != NULL) {
2649 FreePool (BestLang);
2650 }
2651 if (!EFI_ERROR(Status)) {
2652 return (RetVal);
2653 }
2654 }
2655 return (NULL);
2656 }
2657
2658 /**
2659 Function to initialize the file global mHandleList object for use in
2660 vonverting handles to index and index to handle.
2661
2662 @retval EFI_SUCCESS The operation was successful.
2663 **/
2664 EFI_STATUS
2665 InternalShellInitHandleList(
2666 VOID
2667 )
2668 {
2669 EFI_STATUS Status;
2670 EFI_HANDLE *HandleBuffer;
2671 UINTN HandleCount;
2672 HANDLE_LIST *ListWalker;
2673
2674 if (mHandleList.NextIndex != 0) {
2675 return EFI_SUCCESS;
2676 }
2677 InitializeListHead(&mHandleList.List.Link);
2678 mHandleList.NextIndex = 1;
2679 Status = gBS->LocateHandleBuffer (
2680 AllHandles,
2681 NULL,
2682 NULL,
2683 &HandleCount,
2684 &HandleBuffer
2685 );
2686 ASSERT_EFI_ERROR(Status);
2687 if (EFI_ERROR(Status)) {
2688 return (Status);
2689 }
2690 for (mHandleList.NextIndex = 1 ; mHandleList.NextIndex <= HandleCount ; mHandleList.NextIndex++){
2691 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));
2692 if (ListWalker != NULL) {
2693 ListWalker->TheHandle = HandleBuffer[mHandleList.NextIndex - 1];
2694 ListWalker->TheIndex = mHandleList.NextIndex;
2695 InsertTailList (&mHandleList.List.Link, &ListWalker->Link);
2696 }
2697 }
2698 FreePool(HandleBuffer);
2699 return (EFI_SUCCESS);
2700 }
2701
2702 /**
2703 Function to retrieve the human-friendly index of a given handle. If the handle
2704 does not have a index one will be automatically assigned. The index value is valid
2705 until the termination of the shell application.
2706
2707 @param[in] TheHandle The handle to retrieve an index for.
2708
2709 @retval 0 A memory allocation failed.
2710 @return The index of the handle.
2711
2712 **/
2713 UINTN
2714 EFIAPI
2715 ConvertHandleToHandleIndex(
2716 IN CONST EFI_HANDLE TheHandle
2717 )
2718 {
2719 EFI_STATUS Status;
2720 EFI_GUID **ProtocolBuffer;
2721 UINTN ProtocolCount;
2722 HANDLE_LIST *ListWalker;
2723
2724 if (TheHandle == NULL) {
2725 return 0;
2726 }
2727
2728 InternalShellInitHandleList();
2729
2730 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)
2731 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)
2732 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)
2733 ){
2734 if (ListWalker->TheHandle == TheHandle) {
2735 //
2736 // Verify that TheHandle is still present in the Handle Database
2737 //
2738 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);
2739 if (EFI_ERROR (Status)) {
2740 //
2741 // TheHandle is not present in the Handle Database, so delete from the handle list
2742 //
2743 RemoveEntryList (&ListWalker->Link);
2744 return 0;
2745 }
2746 FreePool (ProtocolBuffer);
2747 return (ListWalker->TheIndex);
2748 }
2749 }
2750
2751 //
2752 // Verify that TheHandle is valid handle
2753 //
2754 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);
2755 if (EFI_ERROR (Status)) {
2756 //
2757 // TheHandle is not valid, so do not add to handle list
2758 //
2759 return 0;
2760 }
2761 FreePool (ProtocolBuffer);
2762
2763 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));
2764 if (ListWalker == NULL) {
2765 return 0;
2766 }
2767 ListWalker->TheHandle = TheHandle;
2768 ListWalker->TheIndex = mHandleList.NextIndex++;
2769 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);
2770 return (ListWalker->TheIndex);
2771 }
2772
2773
2774
2775 /**
2776 Function to retrieve the EFI_HANDLE from the human-friendly index.
2777
2778 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.
2779
2780 @retval NULL The index was invalid.
2781 @return The EFI_HANDLE that index represents.
2782
2783 **/
2784 EFI_HANDLE
2785 EFIAPI
2786 ConvertHandleIndexToHandle(
2787 IN CONST UINTN TheIndex
2788 )
2789 {
2790 EFI_STATUS Status;
2791 EFI_GUID **ProtocolBuffer;
2792 UINTN ProtocolCount;
2793 HANDLE_LIST *ListWalker;
2794
2795 InternalShellInitHandleList();
2796
2797 if (TheIndex >= mHandleList.NextIndex) {
2798 return NULL;
2799 }
2800
2801 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)
2802 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)
2803 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)
2804 ){
2805 if (ListWalker->TheIndex == TheIndex && ListWalker->TheHandle != NULL) {
2806 //
2807 // Verify that LinkWalker->TheHandle is valid handle
2808 //
2809 Status = gBS->ProtocolsPerHandle(ListWalker->TheHandle, &ProtocolBuffer, &ProtocolCount);
2810 if (!EFI_ERROR (Status)) {
2811 FreePool (ProtocolBuffer);
2812 } else {
2813 //
2814 // TheHandle is not valid, so do not add to handle list
2815 //
2816 ListWalker->TheHandle = NULL;
2817 }
2818 return (ListWalker->TheHandle);
2819 }
2820 }
2821 return NULL;
2822 }
2823
2824 /**
2825 Gets all the related EFI_HANDLEs based on the mask supplied.
2826
2827 This function scans all EFI_HANDLES in the UEFI environment's handle database
2828 and returns the ones with the specified relationship (Mask) to the specified
2829 controller handle.
2830
2831 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
2832 If MatchingHandleCount is NULL, then ASSERT.
2833
2834 If MatchingHandleBuffer is not NULL upon a successful return the memory must be
2835 caller freed.
2836
2837 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.
2838 @param[in] ControllerHandle The handle with Device Path protocol on it.
2839 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in
2840 MatchingHandleBuffer.
2841 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount
2842 EFI_HANDLEs with a terminating NULL EFI_HANDLE.
2843 @param[out] HandleType An array of type information.
2844
2845 @retval EFI_SUCCESS The operation was successful, and any related handles
2846 are in MatchingHandleBuffer.
2847 @retval EFI_NOT_FOUND No matching handles were found.
2848 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
2849 **/
2850 EFI_STATUS
2851 EFIAPI
2852 ParseHandleDatabaseByRelationshipWithType (
2853 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
2854 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
2855 IN UINTN *HandleCount,
2856 OUT EFI_HANDLE **HandleBuffer,
2857 OUT UINTN **HandleType
2858 )
2859 {
2860 EFI_STATUS Status;
2861 UINTN HandleIndex;
2862 EFI_GUID **ProtocolGuidArray;
2863 UINTN ArrayCount;
2864 UINTN ProtocolIndex;
2865 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;
2866 UINTN OpenInfoCount;
2867 UINTN OpenInfoIndex;
2868 UINTN ChildIndex;
2869 INTN DriverBindingHandleIndex;
2870
2871 ASSERT(HandleCount != NULL);
2872 ASSERT(HandleBuffer != NULL);
2873 ASSERT(HandleType != NULL);
2874 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);
2875
2876 *HandleCount = 0;
2877 *HandleBuffer = NULL;
2878 *HandleType = NULL;
2879
2880 //
2881 // Retrieve the list of all handles from the handle database
2882 //
2883 Status = gBS->LocateHandleBuffer (
2884 AllHandles,
2885 NULL,
2886 NULL,
2887 HandleCount,
2888 HandleBuffer
2889 );
2890 if (EFI_ERROR (Status)) {
2891 return (Status);
2892 }
2893
2894 *HandleType = AllocateZeroPool (*HandleCount * sizeof (UINTN));
2895 if (*HandleType == NULL) {
2896 SHELL_FREE_NON_NULL (*HandleBuffer);
2897 *HandleCount = 0;
2898 return EFI_OUT_OF_RESOURCES;
2899 }
2900
2901 DriverBindingHandleIndex = -1;
2902 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {
2903 if (DriverBindingHandle != NULL && (*HandleBuffer)[HandleIndex] == DriverBindingHandle) {
2904 DriverBindingHandleIndex = (INTN)HandleIndex;
2905 }
2906 }
2907
2908 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {
2909 //
2910 // Retrieve the list of all the protocols on each handle
2911 //
2912 Status = gBS->ProtocolsPerHandle (
2913 (*HandleBuffer)[HandleIndex],
2914 &ProtocolGuidArray,
2915 &ArrayCount
2916 );
2917 if (EFI_ERROR (Status)) {
2918 continue;
2919 }
2920
2921 for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {
2922
2923 //
2924 // Set the bit describing what this handle has
2925 //
2926 if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiLoadedImageProtocolGuid) ) {
2927 (*HandleType)[HandleIndex] |= (UINTN)HR_IMAGE_HANDLE;
2928 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverBindingProtocolGuid) ) {
2929 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_BINDING_HANDLE;
2930 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfiguration2ProtocolGuid)) {
2931 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;
2932 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfigurationProtocolGuid) ) {
2933 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;
2934 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnostics2ProtocolGuid) ) {
2935 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;
2936 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnosticsProtocolGuid) ) {
2937 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;
2938 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentName2ProtocolGuid) ) {
2939 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;
2940 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentNameProtocolGuid) ) {
2941 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;
2942 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDevicePathProtocolGuid) ) {
2943 (*HandleType)[HandleIndex] |= (UINTN)HR_DEVICE_HANDLE;
2944 }
2945 //
2946 // Retrieve the list of agents that have opened each protocol
2947 //
2948 Status = gBS->OpenProtocolInformation (
2949 (*HandleBuffer)[HandleIndex],
2950 ProtocolGuidArray[ProtocolIndex],
2951 &OpenInfo,
2952 &OpenInfoCount
2953 );
2954 if (EFI_ERROR (Status)) {
2955 continue;
2956 }
2957
2958 if (ControllerHandle == NULL) {
2959 //
2960 // ControllerHandle == NULL and DriverBindingHandle != NULL.
2961 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing
2962 //
2963 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
2964 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {
2965 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
2966 if (DriverBindingHandleIndex != -1) {
2967 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;
2968 }
2969 }
2970 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
2971 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
2972 if (DriverBindingHandleIndex != -1) {
2973 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);
2974 }
2975 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
2976 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {
2977 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);
2978 }
2979 }
2980 }
2981 }
2982 }
2983 if (DriverBindingHandle == NULL && ControllerHandle != NULL) {
2984 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {
2985 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
2986 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
2987 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {
2988 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
2989 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {
2990 (*HandleType)[ChildIndex] |= (UINTN)HR_DEVICE_DRIVER;
2991 }
2992 }
2993 }
2994 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
2995 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
2996 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {
2997 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);
2998 }
2999 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {
3000 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);
3001 }
3002 }
3003 }
3004 }
3005 } else {
3006 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
3007 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
3008 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {
3009 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);
3010 }
3011 }
3012 }
3013 }
3014 }
3015 if (DriverBindingHandle != NULL && ControllerHandle != NULL) {
3016 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {
3017 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
3018 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
3019 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {
3020 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {
3021 if (DriverBindingHandleIndex != -1) {
3022 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;
3023 }
3024 }
3025 }
3026 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
3027 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {
3028 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
3029 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {
3030 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);
3031 }
3032 }
3033 }
3034
3035 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
3036 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {
3037 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);
3038 }
3039 }
3040 }
3041 }
3042 } else {
3043 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
3044 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
3045 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {
3046 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);
3047 }
3048 }
3049 }
3050 }
3051 }
3052 FreePool (OpenInfo);
3053 }
3054 FreePool (ProtocolGuidArray);
3055 }
3056 return EFI_SUCCESS;
3057 }
3058
3059 /**
3060 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask
3061 supplied.
3062
3063 This function will scan all EFI_HANDLES in the UEFI environment's handle database
3064 and return all the ones with the specified relationship (Mask) to the specified
3065 controller handle.
3066
3067 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
3068 If MatchingHandleCount is NULL, then ASSERT.
3069
3070 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be
3071 caller freed.
3072
3073 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol
3074 on it.
3075 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.
3076 @param[in] Mask Mask of what relationship(s) is desired.
3077 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in
3078 MatchingHandleBuffer.
3079 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount
3080 EFI_HANDLEs and a terminating NULL EFI_HANDLE.
3081
3082 @retval EFI_SUCCESS The operation was sucessful and any related handles
3083 are in MatchingHandleBuffer;
3084 @retval EFI_NOT_FOUND No matching handles were found.
3085 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
3086 **/
3087 EFI_STATUS
3088 EFIAPI
3089 ParseHandleDatabaseByRelationship (
3090 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
3091 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
3092 IN CONST UINTN Mask,
3093 IN UINTN *MatchingHandleCount,
3094 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
3095 )
3096 {
3097 EFI_STATUS Status;
3098 UINTN HandleCount;
3099 EFI_HANDLE *HandleBuffer;
3100 UINTN *HandleType;
3101 UINTN HandleIndex;
3102
3103 ASSERT(MatchingHandleCount != NULL);
3104 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);
3105
3106 if ((Mask & HR_VALID_MASK) != Mask) {
3107 return (EFI_INVALID_PARAMETER);
3108 }
3109
3110 if ((Mask & HR_CHILD_HANDLE) != 0 && DriverBindingHandle == NULL) {
3111 return (EFI_INVALID_PARAMETER);
3112 }
3113
3114 *MatchingHandleCount = 0;
3115 if (MatchingHandleBuffer != NULL) {
3116 *MatchingHandleBuffer = NULL;
3117 }
3118
3119 HandleBuffer = NULL;
3120 HandleType = NULL;
3121
3122 Status = ParseHandleDatabaseByRelationshipWithType (
3123 DriverBindingHandle,
3124 ControllerHandle,
3125 &HandleCount,
3126 &HandleBuffer,
3127 &HandleType
3128 );
3129 if (!EFI_ERROR (Status)) {
3130 //
3131 // Count the number of handles that match the attributes in Mask
3132 //
3133 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {
3134 if ((HandleType[HandleIndex] & Mask) == Mask) {
3135 (*MatchingHandleCount)++;
3136 }
3137 }
3138 //
3139 // If no handles match the attributes in Mask then return EFI_NOT_FOUND
3140 //
3141 if (*MatchingHandleCount == 0) {
3142 Status = EFI_NOT_FOUND;
3143 } else {
3144
3145 if (MatchingHandleBuffer == NULL) {
3146 //
3147 // Someone just wanted the count...
3148 //
3149 Status = EFI_SUCCESS;
3150 } else {
3151 //
3152 // Allocate a handle buffer for the number of handles that matched the attributes in Mask
3153 //
3154 *MatchingHandleBuffer = AllocateZeroPool ((*MatchingHandleCount +1)* sizeof (EFI_HANDLE));
3155 if (*MatchingHandleBuffer == NULL) {
3156 Status = EFI_OUT_OF_RESOURCES;
3157 } else {
3158 for (HandleIndex = 0, *MatchingHandleCount = 0
3159 ; HandleIndex < HandleCount
3160 ; HandleIndex++
3161 ) {
3162 //
3163 // Fill the allocated buffer with the handles that matched the attributes in Mask
3164 //
3165 if ((HandleType[HandleIndex] & Mask) == Mask) {
3166 (*MatchingHandleBuffer)[(*MatchingHandleCount)++] = HandleBuffer[HandleIndex];
3167 }
3168 }
3169
3170 //
3171 // Make the last one NULL
3172 //
3173 (*MatchingHandleBuffer)[*MatchingHandleCount] = NULL;
3174
3175 Status = EFI_SUCCESS;
3176 } // *MatchingHandleBuffer == NULL (ELSE)
3177 } // MacthingHandleBuffer == NULL (ELSE)
3178 } // *MatchingHandleCount == 0 (ELSE)
3179 } // no error on ParseHandleDatabaseByRelationshipWithType
3180
3181 if (HandleBuffer != NULL) {
3182 FreePool (HandleBuffer);
3183 }
3184
3185 if (HandleType != NULL) {
3186 FreePool (HandleType);
3187 }
3188
3189 ASSERT ((MatchingHandleBuffer == NULL) ||
3190 (*MatchingHandleCount == 0 && *MatchingHandleBuffer == NULL) ||
3191 (*MatchingHandleCount != 0 && *MatchingHandleBuffer != NULL));
3192 return Status;
3193 }
3194
3195 /**
3196 Gets handles for any child controllers of the passed in controller.
3197
3198 @param[in] ControllerHandle The handle of the "parent controller"
3199 @param[out] MatchingHandleCount Pointer to the number of handles in
3200 MatchingHandleBuffer on return.
3201 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
3202 return.
3203
3204
3205 @retval EFI_SUCCESS The operation was sucessful.
3206 **/
3207 EFI_STATUS
3208 EFIAPI
3209 ParseHandleDatabaseForChildControllers(
3210 IN CONST EFI_HANDLE ControllerHandle,
3211 OUT UINTN *MatchingHandleCount,
3212 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
3213 )
3214 {
3215 EFI_STATUS Status;
3216 UINTN HandleIndex;
3217 UINTN DriverBindingHandleCount;
3218 EFI_HANDLE *DriverBindingHandleBuffer;
3219 UINTN DriverBindingHandleIndex;
3220 UINTN ChildControllerHandleCount;
3221 EFI_HANDLE *ChildControllerHandleBuffer;
3222 UINTN ChildControllerHandleIndex;
3223 EFI_HANDLE *HandleBufferForReturn;
3224
3225 if (MatchingHandleCount == NULL) {
3226 return (EFI_INVALID_PARAMETER);
3227 }
3228 *MatchingHandleCount = 0;
3229
3230 Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
3231 ControllerHandle,
3232 &DriverBindingHandleCount,
3233 &DriverBindingHandleBuffer
3234 );
3235 if (EFI_ERROR (Status)) {
3236 return Status;
3237 }
3238
3239 //
3240 // Get a buffer big enough for all the controllers.
3241 //
3242 HandleBufferForReturn = GetHandleListByProtocol(NULL);
3243 if (HandleBufferForReturn == NULL) {
3244 FreePool (DriverBindingHandleBuffer);
3245 return (EFI_NOT_FOUND);
3246 }
3247
3248 for (DriverBindingHandleIndex = 0; DriverBindingHandleIndex < DriverBindingHandleCount; DriverBindingHandleIndex++) {
3249 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
3250 DriverBindingHandleBuffer[DriverBindingHandleIndex],
3251 ControllerHandle,
3252 &ChildControllerHandleCount,
3253 &ChildControllerHandleBuffer
3254 );
3255 if (EFI_ERROR (Status)) {
3256 continue;
3257 }
3258
3259 for (ChildControllerHandleIndex = 0;
3260 ChildControllerHandleIndex < ChildControllerHandleCount;
3261 ChildControllerHandleIndex++
3262 ) {
3263 for (HandleIndex = 0; HandleIndex < *MatchingHandleCount; HandleIndex++) {
3264 if (HandleBufferForReturn[HandleIndex] == ChildControllerHandleBuffer[ChildControllerHandleIndex]) {
3265 break;
3266 }
3267 }
3268 if (HandleIndex >= *MatchingHandleCount) {
3269 HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];
3270 }
3271 }
3272
3273 FreePool (ChildControllerHandleBuffer);
3274 }
3275
3276 FreePool (DriverBindingHandleBuffer);
3277
3278 if (MatchingHandleBuffer == NULL || *MatchingHandleCount == 0) {
3279 //
3280 // The caller is not interested in the actual handles, or we've found none.
3281 //
3282 FreePool (HandleBufferForReturn);
3283 HandleBufferForReturn = NULL;
3284 }
3285
3286 if (MatchingHandleBuffer != NULL) {
3287 *MatchingHandleBuffer = HandleBufferForReturn;
3288 }
3289
3290 ASSERT ((MatchingHandleBuffer == NULL) ||
3291 (*MatchingHandleCount == 0 && *MatchingHandleBuffer == NULL) ||
3292 (*MatchingHandleCount != 0 && *MatchingHandleBuffer != NULL));
3293
3294 return (EFI_SUCCESS);
3295 }
3296
3297 /**
3298 Appends 1 buffer to another buffer. This will re-allocate the destination buffer
3299 if necessary to fit all of the data.
3300
3301 If DestinationBuffer is NULL, then ASSERT().
3302
3303 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.
3304 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.
3305 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.
3306 @param[in] SourceSize The number of bytes of SourceBuffer to append.
3307
3308 @retval NULL A memory allocation failed.
3309 @retval NULL A parameter was invalid.
3310 @return A pointer to (*DestinationBuffer).
3311 **/
3312 VOID*
3313 BuffernCatGrow (
3314 IN OUT VOID **DestinationBuffer,
3315 IN OUT UINTN *DestinationSize,
3316 IN VOID *SourceBuffer,
3317 IN UINTN SourceSize
3318 )
3319 {
3320 UINTN LocalDestinationSize;
3321 UINTN LocalDestinationFinalSize;
3322
3323 ASSERT(DestinationBuffer != NULL);
3324
3325 if (SourceSize == 0 || SourceBuffer == NULL) {
3326 return (*DestinationBuffer);
3327 }
3328
3329 if (DestinationSize == NULL) {
3330 LocalDestinationSize = 0;
3331 } else {
3332 LocalDestinationSize = *DestinationSize;
3333 }
3334
3335 LocalDestinationFinalSize = LocalDestinationSize + SourceSize;
3336
3337 if (DestinationSize != NULL) {
3338 *DestinationSize = LocalDestinationSize;
3339 }
3340
3341 if (LocalDestinationSize == 0) {
3342 // allcoate
3343 *DestinationBuffer = AllocateZeroPool(LocalDestinationFinalSize);
3344 } else {
3345 // reallocate
3346 *DestinationBuffer = ReallocatePool(LocalDestinationSize, LocalDestinationFinalSize, *DestinationBuffer);
3347 }
3348
3349 ASSERT(*DestinationBuffer != NULL);
3350
3351 // copy
3352 return (CopyMem(((UINT8*)(*DestinationBuffer)) + LocalDestinationSize, SourceBuffer, SourceSize));
3353 }
3354
3355 /**
3356 Gets handles for any child devices produced by the passed in driver.
3357
3358 @param[in] DriverHandle The handle of the driver.
3359 @param[in] MatchingHandleCount Pointer to the number of handles in
3360 MatchingHandleBuffer on return.
3361 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
3362 return.
3363 @retval EFI_SUCCESS The operation was sucessful.
3364 @sa ParseHandleDatabaseByRelationship
3365 **/
3366 EFI_STATUS
3367 EFIAPI
3368 ParseHandleDatabaseForChildDevices(
3369 IN CONST EFI_HANDLE DriverHandle,
3370 IN UINTN *MatchingHandleCount,
3371 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
3372 )
3373 {
3374 EFI_HANDLE *Buffer;
3375 EFI_HANDLE *Buffer2;
3376 UINTN Count1;
3377 UINTN Count2;
3378 UINTN HandleIndex;
3379 EFI_STATUS Status;
3380 UINTN HandleBufferSize;
3381
3382 ASSERT(MatchingHandleCount != NULL);
3383
3384 HandleBufferSize = 0;
3385 Buffer = NULL;
3386 Buffer2 = NULL;
3387 *MatchingHandleCount = 0;
3388
3389 Status = PARSE_HANDLE_DATABASE_DEVICES (
3390 DriverHandle,
3391 &Count1,
3392 &Buffer
3393 );
3394 if (!EFI_ERROR (Status)) {
3395 for (HandleIndex = 0; HandleIndex < Count1; HandleIndex++) {
3396 //
3397 // now find the children
3398 //
3399 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
3400 DriverHandle,
3401 Buffer[HandleIndex],
3402 &Count2,
3403 &Buffer2
3404 );
3405 if (EFI_ERROR(Status)) {
3406 break;
3407 }
3408 //
3409 // save out required and optional data elements
3410 //
3411 *MatchingHandleCount += Count2;
3412 if (MatchingHandleBuffer != NULL) {
3413 *MatchingHandleBuffer = BuffernCatGrow((VOID**)MatchingHandleBuffer, &HandleBufferSize, Buffer2, Count2 * sizeof(Buffer2[0]));
3414 }
3415
3416 //
3417 // free the memory
3418 //
3419 if (Buffer2 != NULL) {
3420 FreePool(Buffer2);
3421 }
3422 }
3423 }
3424
3425 if (Buffer != NULL) {
3426 FreePool(Buffer);
3427 }
3428 return (Status);
3429 }
3430
3431 /**
3432 Function to get all handles that support a given protocol or all handles.
3433
3434 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL
3435 then the function will return all handles.
3436
3437 @retval NULL A memory allocation failed.
3438 @return A NULL terminated list of handles.
3439 **/
3440 EFI_HANDLE*
3441 EFIAPI
3442 GetHandleListByProtocol (
3443 IN CONST EFI_GUID *ProtocolGuid OPTIONAL
3444 )
3445 {
3446 EFI_HANDLE *HandleList;
3447 UINTN Size;
3448 EFI_STATUS Status;
3449
3450 Size = 0;
3451 HandleList = NULL;
3452
3453 //
3454 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!
3455 //
3456 if (ProtocolGuid == NULL) {
3457 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);
3458 if (Status == EFI_BUFFER_TOO_SMALL) {
3459 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));
3460 if (HandleList == NULL) {
3461 return (NULL);
3462 }
3463 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);
3464 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;
3465 }
3466 } else {
3467 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);
3468 if (Status == EFI_BUFFER_TOO_SMALL) {
3469 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));
3470 if (HandleList == NULL) {
3471 return (NULL);
3472 }
3473 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);
3474 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;
3475 }
3476 }
3477 if (EFI_ERROR(Status)) {
3478 if (HandleList != NULL) {
3479 FreePool(HandleList);
3480 }
3481 return (NULL);
3482 }
3483 return (HandleList);
3484 }
3485
3486 /**
3487 Function to get all handles that support some protocols.
3488
3489 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.
3490
3491 @retval NULL A memory allocation failed.
3492 @retval NULL ProtocolGuids was NULL.
3493 @return A NULL terminated list of EFI_HANDLEs.
3494 **/
3495 EFI_HANDLE*
3496 EFIAPI
3497 GetHandleListByProtocolList (
3498 IN CONST EFI_GUID **ProtocolGuids
3499 )
3500 {
3501 EFI_HANDLE *HandleList;
3502 UINTN Size;
3503 UINTN TotalSize;
3504 UINTN TempSize;
3505 EFI_STATUS Status;
3506 CONST EFI_GUID **GuidWalker;
3507 EFI_HANDLE *HandleWalker1;
3508 EFI_HANDLE *HandleWalker2;
3509
3510 Size = 0;
3511 HandleList = NULL;
3512 TotalSize = sizeof(EFI_HANDLE);
3513
3514 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++,Size = 0){
3515 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &Size, NULL);
3516 if (Status == EFI_BUFFER_TOO_SMALL) {
3517 TotalSize += Size;
3518 }
3519 }
3520
3521 //
3522 // No handles were found...
3523 //
3524 if (TotalSize == sizeof(EFI_HANDLE)) {
3525 return (NULL);
3526 }
3527
3528 HandleList = AllocateZeroPool(TotalSize);
3529 if (HandleList == NULL) {
3530 return (NULL);
3531 }
3532
3533 Size = 0;
3534 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++){
3535 TempSize = TotalSize - Size;
3536 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &TempSize, HandleList+(Size/sizeof(EFI_HANDLE)));
3537
3538 //
3539 // Allow for missing protocols... Only update the 'used' size upon success.
3540 //
3541 if (!EFI_ERROR(Status)) {
3542 Size += TempSize;
3543 }
3544 }
3545 ASSERT(HandleList[(TotalSize/sizeof(EFI_HANDLE))-1] == NULL);
3546
3547 for (HandleWalker1 = HandleList ; HandleWalker1 != NULL && *HandleWalker1 != NULL ; HandleWalker1++) {
3548 for (HandleWalker2 = HandleWalker1 + 1; HandleWalker2 != NULL && *HandleWalker2 != NULL ; HandleWalker2++) {
3549 if (*HandleWalker1 == *HandleWalker2) {
3550 //
3551 // copy memory back 1 handle width.
3552 //
3553 CopyMem(HandleWalker2, HandleWalker2 + 1, TotalSize - ((HandleWalker2-HandleList+1)*sizeof(EFI_HANDLE)));
3554 }
3555 }
3556 }
3557
3558 return (HandleList);
3559 }
3560
3561 /**
3562 Return all supported GUIDs.
3563
3564 @param[out] Guids The buffer to return all supported GUIDs.
3565 @param[in, out] Count On input, the count of GUIDs the buffer can hold,
3566 On output, the count of GUIDs to return.
3567
3568 @retval EFI_INVALID_PARAMETER Count is NULL.
3569 @retval EFI_BUFFER_TOO_SMALL Buffer is not enough to hold all GUIDs.
3570 @retval EFI_SUCCESS GUIDs are returned successfully.
3571 **/
3572 EFI_STATUS
3573 EFIAPI
3574 GetAllMappingGuids (
3575 OUT EFI_GUID *Guids,
3576 IN OUT UINTN *Count
3577 )
3578 {
3579 UINTN GuidCount;
3580 UINTN NtGuidCount;
3581 UINTN Index;
3582
3583 if (Count == NULL) {
3584 return EFI_INVALID_PARAMETER;
3585 }
3586
3587 NtGuidCount = 0;
3588 if (PcdGetBool (PcdShellIncludeNtGuids)) {
3589 NtGuidCount = ARRAY_SIZE (mGuidStringListNT) - 1;
3590 }
3591 GuidCount = ARRAY_SIZE (mGuidStringList) - 1;
3592
3593 if (*Count < NtGuidCount + GuidCount + mGuidListCount) {
3594 *Count = NtGuidCount + GuidCount + mGuidListCount;
3595 return EFI_BUFFER_TOO_SMALL;
3596 }
3597
3598 for (Index = 0; Index < NtGuidCount; Index++) {
3599 CopyGuid (&Guids[Index], mGuidStringListNT[Index].GuidId);
3600 }
3601
3602 for (Index = 0; Index < GuidCount; Index++) {
3603 CopyGuid (&Guids[NtGuidCount + Index], mGuidStringList[Index].GuidId);
3604 }
3605
3606 for (Index = 0; Index < mGuidListCount; Index++) {
3607 CopyGuid (&Guids[NtGuidCount + GuidCount + Index], mGuidList[Index].GuidId);
3608 }
3609
3610 return EFI_SUCCESS;
3611 }
EFI Development Kit II mirror for PVE