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