]> 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
SourceLevelDebugPkg/DebugTimer: Timer count value 0 not calculated
[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 (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #include "UefiHandleParsingLib.h"
17 #include "IndustryStandard/Acpi10.h"
18
19 EFI_HANDLE mHandleParsingHiiHandle = NULL;
20 HANDLE_INDEX_LIST mHandleList = {{{NULL,NULL},0,0},0};
21 GUID_INFO_BLOCK *GuidList;
22 UINTN GuidListCount;
23 /**
24 Function to translate the EFI_MEMORY_TYPE into a string.
25
26 @param[in] Memory The memory type.
27
28 @retval A string representation of the type allocated from BS Pool.
29 **/
30 CHAR16*
31 EFIAPI
32 ConvertMemoryType (
33 IN CONST EFI_MEMORY_TYPE Memory
34 )
35 {
36 CHAR16 *RetVal;
37 RetVal = NULL;
38
39 switch (Memory) {
40 case EfiReservedMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiReservedMemoryType", 0); break;
41 case EfiLoaderCode: StrnCatGrow(&RetVal, NULL, L"EfiLoaderCode", 0); break;
42 case EfiLoaderData: StrnCatGrow(&RetVal, NULL, L"EfiLoaderData", 0); break;
43 case EfiBootServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesCode", 0); break;
44 case EfiBootServicesData: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesData", 0); break;
45 case EfiRuntimeServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesCode", 0); break;
46 case EfiRuntimeServicesData: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesData", 0); break;
47 case EfiConventionalMemory: StrnCatGrow(&RetVal, NULL, L"EfiConventionalMemory", 0); break;
48 case EfiUnusableMemory: StrnCatGrow(&RetVal, NULL, L"EfiUnusableMemory", 0); break;
49 case EfiACPIReclaimMemory: StrnCatGrow(&RetVal, NULL, L"EfiACPIReclaimMemory", 0); break;
50 case EfiACPIMemoryNVS: StrnCatGrow(&RetVal, NULL, L"EfiACPIMemoryNVS", 0); break;
51 case EfiMemoryMappedIO: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIO", 0); break;
52 case EfiMemoryMappedIOPortSpace: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIOPortSpace", 0); break;
53 case EfiPalCode: StrnCatGrow(&RetVal, NULL, L"EfiPalCode", 0); break;
54 case EfiMaxMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiMaxMemoryType", 0); break;
55 default: ASSERT(FALSE);
56 }
57 return (RetVal);
58 }
59
60 /**
61 Function to translate the EFI_GRAPHICS_PIXEL_FORMAT into a string.
62
63 @param[in] Fmt The format type.
64
65 @retval A string representation of the type allocated from BS Pool.
66 **/
67 CHAR16*
68 EFIAPI
69 ConvertPixelFormat (
70 IN CONST EFI_GRAPHICS_PIXEL_FORMAT Fmt
71 )
72 {
73 CHAR16 *RetVal;
74 RetVal = NULL;
75
76 switch (Fmt) {
77 case PixelRedGreenBlueReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelRedGreenBlueReserved8BitPerColor", 0); break;
78 case PixelBlueGreenRedReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelBlueGreenRedReserved8BitPerColor", 0); break;
79 case PixelBitMask: StrnCatGrow(&RetVal, NULL, L"PixelBitMask", 0); break;
80 case PixelBltOnly: StrnCatGrow(&RetVal, NULL, L"PixelBltOnly", 0); break;
81 case PixelFormatMax: StrnCatGrow(&RetVal, NULL, L"PixelFormatMax", 0); break;
82 default: ASSERT(FALSE);
83 }
84 return (RetVal);
85 }
86
87 /**
88 Constructor for the library.
89
90 @param[in] ImageHandle Ignored.
91 @param[in] SystemTable Ignored.
92
93 @retval EFI_SUCCESS The operation was successful.
94 **/
95 EFI_STATUS
96 EFIAPI
97 HandleParsingLibConstructor (
98 IN EFI_HANDLE ImageHandle,
99 IN EFI_SYSTEM_TABLE *SystemTable
100 )
101 {
102 GuidListCount = 0;
103 GuidList = NULL;
104
105 //
106 // Do nothing with mHandleParsingHiiHandle. Initialize HII as needed.
107 //
108 return (EFI_SUCCESS);
109 }
110
111 /**
112 Initialization function for HII packages.
113
114 **/
115 VOID
116 HandleParsingHiiInit (VOID)
117 {
118 if (mHandleParsingHiiHandle == NULL) {
119 mHandleParsingHiiHandle = HiiAddPackages (&gHandleParsingHiiGuid, gImageHandle, UefiHandleParsingLibStrings, NULL);
120 ASSERT (mHandleParsingHiiHandle != NULL);
121 }
122 }
123
124 /**
125 Destructor for the library. free any resources.
126
127 @param[in] ImageHandle Ignored.
128 @param[in] SystemTable Ignored.
129
130 @retval EFI_SUCCESS The operation was successful.
131 **/
132 EFI_STATUS
133 EFIAPI
134 HandleParsingLibDestructor (
135 IN EFI_HANDLE ImageHandle,
136 IN EFI_SYSTEM_TABLE *SystemTable
137 )
138 {
139 UINTN LoopCount;
140
141 for (LoopCount = 0; GuidList != NULL && LoopCount < GuidListCount; LoopCount++) {
142 SHELL_FREE_NON_NULL(GuidList[LoopCount].GuidId);
143 }
144
145 SHELL_FREE_NON_NULL(GuidList);
146 if (mHandleParsingHiiHandle != NULL) {
147 HiiRemovePackages(mHandleParsingHiiHandle);
148 }
149 return (EFI_SUCCESS);
150 }
151
152 /**
153 Function to dump information about LoadedImage.
154
155 This will allocate the return buffer from boot services pool.
156
157 @param[in] TheHandle The handle that has LoadedImage installed.
158 @param[in] Verbose TRUE for additional information, FALSE otherwise.
159
160 @retval A poitner to a string containing the information.
161 **/
162 CHAR16*
163 EFIAPI
164 LoadedImageProtocolDumpInformation(
165 IN CONST EFI_HANDLE TheHandle,
166 IN CONST BOOLEAN Verbose
167 )
168 {
169 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
170 EFI_STATUS Status;
171 CHAR16 *RetVal;
172 CHAR16 *Temp;
173 CHAR16 *CodeType;
174 CHAR16 *DataType;
175
176 if (!Verbose) {
177 return (CatSPrint(NULL, L"LoadedImage"));
178 }
179
180 HandleParsingHiiInit();
181
182 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_LI_DUMP_MAIN), NULL);
183 RetVal = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));
184 if (Temp == NULL || RetVal == NULL) {
185 SHELL_FREE_NON_NULL(Temp);
186 SHELL_FREE_NON_NULL(RetVal);
187 return NULL;
188 }
189
190 Status = gBS->OpenProtocol (
191 TheHandle,
192 &gEfiLoadedImageProtocolGuid,
193 (VOID**)&LoadedImage,
194 gImageHandle,
195 NULL,
196 EFI_OPEN_PROTOCOL_GET_PROTOCOL
197 );
198
199 if (EFI_ERROR (Status)) {
200 SHELL_FREE_NON_NULL (Temp);
201 SHELL_FREE_NON_NULL (RetVal);
202 return NULL;
203 }
204
205 DataType = ConvertMemoryType(LoadedImage->ImageDataType);
206 CodeType = ConvertMemoryType(LoadedImage->ImageCodeType);
207
208 RetVal = CatSPrint(RetVal,
209 Temp,
210 LoadedImage->Revision,
211 LoadedImage->ParentHandle,
212 LoadedImage->SystemTable,
213 LoadedImage->DeviceHandle,
214 LoadedImage->FilePath,
215 LoadedImage->LoadOptionsSize,
216 LoadedImage->LoadOptions,
217 LoadedImage->ImageBase,
218 LoadedImage->ImageSize,
219 CodeType,
220 DataType,
221 LoadedImage->Unload);
222
223
224 SHELL_FREE_NON_NULL(Temp);
225 SHELL_FREE_NON_NULL(CodeType);
226 SHELL_FREE_NON_NULL(DataType);
227
228 return RetVal;
229 }
230
231 /**
232 Function to dump information about GOP.
233
234 This will allocate the return buffer from boot services pool.
235
236 @param[in] TheHandle The handle that has LoadedImage installed.
237 @param[in] Verbose TRUE for additional information, FALSE otherwise.
238
239 @retval A poitner to a string containing the information.
240 **/
241 CHAR16*
242 EFIAPI
243 GraphicsOutputProtocolDumpInformation(
244 IN CONST EFI_HANDLE TheHandle,
245 IN CONST BOOLEAN Verbose
246 )
247 {
248 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
249 EFI_STATUS Status;
250 CHAR16 *RetVal;
251 CHAR16 *Temp;
252 CHAR16 *Fmt;
253
254 if (!Verbose) {
255 return (CatSPrint(NULL, L"GraphicsOutput"));
256 }
257
258 HandleParsingHiiInit();
259
260 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_GOP_DUMP_MAIN), NULL);
261 RetVal = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));
262 if (Temp == NULL || RetVal == NULL) {
263 SHELL_FREE_NON_NULL(Temp);
264 SHELL_FREE_NON_NULL(RetVal);
265 return NULL;
266 }
267
268 Status = gBS->OpenProtocol (
269 TheHandle,
270 &gEfiGraphicsOutputProtocolGuid,
271 (VOID**)&GraphicsOutput,
272 gImageHandle,
273 NULL,
274 EFI_OPEN_PROTOCOL_GET_PROTOCOL
275 );
276
277 if (EFI_ERROR (Status)) {
278 SHELL_FREE_NON_NULL (Temp);
279 SHELL_FREE_NON_NULL (RetVal);
280 return NULL;
281 }
282
283 Fmt = ConvertPixelFormat(GraphicsOutput->Mode->Info->PixelFormat);
284
285 RetVal = CatSPrint(RetVal,
286 Temp,
287 GraphicsOutput->Mode->MaxMode,
288 GraphicsOutput->Mode->Mode,
289 GraphicsOutput->Mode->FrameBufferBase,
290 (UINT64)GraphicsOutput->Mode->FrameBufferSize,
291 (UINT64)GraphicsOutput->Mode->SizeOfInfo,
292 GraphicsOutput->Mode->Info->Version,
293 GraphicsOutput->Mode->Info->HorizontalResolution,
294 GraphicsOutput->Mode->Info->VerticalResolution,
295 Fmt,
296 GraphicsOutput->Mode->Info->PixelsPerScanLine,
297 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.RedMask,
298 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.GreenMask,
299 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.BlueMask
300 );
301
302 SHELL_FREE_NON_NULL(Temp);
303 SHELL_FREE_NON_NULL(Fmt);
304
305 return RetVal;
306 }
307
308 /**
309 Function to dump information about PciRootBridgeIo.
310
311 This will allocate the return buffer from boot services pool.
312
313 @param[in] TheHandle The handle that has PciRootBridgeIo installed.
314 @param[in] Verbose TRUE for additional information, FALSE otherwise.
315
316 @retval A poitner to a string containing the information.
317 **/
318 CHAR16*
319 EFIAPI
320 PciRootBridgeIoDumpInformation(
321 IN CONST EFI_HANDLE TheHandle,
322 IN CONST BOOLEAN Verbose
323 )
324 {
325 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;
326 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Configuration;
327 UINT64 Supports;
328 UINT64 Attributes;
329 CHAR16 *Temp;
330 CHAR16 *Temp2;
331 CHAR16 *RetVal;
332 EFI_STATUS Status;
333
334 RetVal = NULL;
335
336 if (!Verbose) {
337 return (CatSPrint(NULL, L"PciRootBridgeIo"));
338 }
339
340 HandleParsingHiiInit();
341
342 Status = gBS->HandleProtocol(
343 TheHandle,
344 &gEfiPciRootBridgeIoProtocolGuid,
345 (VOID**)&PciRootBridgeIo);
346
347 if (EFI_ERROR(Status)) {
348 return NULL;
349 }
350
351 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_PH), NULL);
352 if (Temp == NULL) {
353 return NULL;
354 }
355 Temp2 = CatSPrint(L"\r\n", Temp, PciRootBridgeIo->ParentHandle);
356 FreePool(Temp);
357 RetVal = Temp2;
358 Temp2 = NULL;
359
360 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SEG), NULL);
361 if (Temp == NULL) {
362 SHELL_FREE_NON_NULL(RetVal);
363 return NULL;
364 }
365 Temp2 = CatSPrint(RetVal, Temp, PciRootBridgeIo->SegmentNumber);
366 FreePool(Temp);
367 FreePool(RetVal);
368 RetVal = Temp2;
369 Temp2 = NULL;
370
371 Supports = 0;
372 Attributes = 0;
373 Status = PciRootBridgeIo->GetAttributes (PciRootBridgeIo, &Supports, &Attributes);
374 if (!EFI_ERROR(Status)) {
375 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_ATT), NULL);
376 if (Temp == NULL) {
377 SHELL_FREE_NON_NULL(RetVal);
378 return NULL;
379 }
380 Temp2 = CatSPrint(RetVal, Temp, Attributes);
381 FreePool(Temp);
382 FreePool(RetVal);
383 RetVal = Temp2;
384 Temp2 = NULL;
385
386 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SUPPORTS), NULL);
387 if (Temp == NULL) {
388 SHELL_FREE_NON_NULL(RetVal);
389 return NULL;
390 }
391 Temp2 = CatSPrint(RetVal, Temp, Supports);
392 FreePool(Temp);
393 FreePool(RetVal);
394 RetVal = Temp2;
395 Temp2 = NULL;
396 }
397
398 Configuration = NULL;
399 Status = PciRootBridgeIo->Configuration (PciRootBridgeIo, (VOID **) &Configuration);
400 if (!EFI_ERROR(Status) && Configuration != NULL) {
401 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_TITLE), NULL);
402 if (Temp == NULL) {
403 SHELL_FREE_NON_NULL(RetVal);
404 return NULL;
405 }
406 Temp2 = CatSPrint(RetVal, Temp, Supports);
407 FreePool(Temp);
408 FreePool(RetVal);
409 RetVal = Temp2;
410 Temp2 = NULL;
411 while (Configuration->Desc == ACPI_ADDRESS_SPACE_DESCRIPTOR) {
412 Temp = NULL;
413 switch (Configuration->ResType) {
414 case ACPI_ADDRESS_SPACE_TYPE_MEM:
415 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_MEM), NULL);
416 break;
417 case ACPI_ADDRESS_SPACE_TYPE_IO:
418 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_IO), NULL);
419 break;
420 case ACPI_ADDRESS_SPACE_TYPE_BUS:
421 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_BUS), NULL);
422 break;
423 }
424 if (Temp != NULL) {
425 Temp2 = CatSPrint(RetVal, L"%s", Temp);
426 FreePool(Temp);
427 FreePool(RetVal);
428 RetVal = Temp2;
429 Temp2 = NULL;
430 }
431
432 Temp2 = CatSPrint(RetVal,
433 L"%H%02x %016lx %016lx %02x%N\r\n",
434 Configuration->SpecificFlag,
435 Configuration->AddrRangeMin,
436 Configuration->AddrRangeMax,
437 Configuration->AddrSpaceGranularity
438 );
439 FreePool(RetVal);
440 RetVal = Temp2;
441 Temp2 = NULL;
442 Configuration++;
443 }
444 }
445 return (RetVal);
446 }
447
448 /**
449 Function to dump information about SimpleTextOut.
450
451 This will allocate the return buffer from boot services pool.
452
453 @param[in] TheHandle The handle that has SimpleTextOut installed.
454 @param[in] Verbose TRUE for additional information, FALSE otherwise.
455
456 @retval A poitner to a string containing the information.
457 **/
458 CHAR16*
459 EFIAPI
460 TxtOutProtocolDumpInformation(
461 IN CONST EFI_HANDLE TheHandle,
462 IN CONST BOOLEAN Verbose
463 )
464 {
465 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Dev;
466 INTN Index;
467 UINTN Col;
468 UINTN Row;
469 EFI_STATUS Status;
470 CHAR16 *RetVal;
471 UINTN Size;
472 CHAR16 *Temp;
473 UINTN NewSize;
474
475 if (!Verbose) {
476 return (NULL);
477 }
478
479 HandleParsingHiiInit();
480
481 RetVal = NULL;
482 Size = 0;
483
484 Status = gBS->HandleProtocol(
485 TheHandle,
486 &gEfiSimpleTextOutProtocolGuid,
487 (VOID**)&Dev);
488
489 ASSERT_EFI_ERROR(Status);
490 ASSERT (Dev != NULL && Dev->Mode != NULL);
491
492 Size = (Dev->Mode->MaxMode + 1) * 80;
493 RetVal = AllocateZeroPool(Size);
494
495 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER), NULL);
496 if (Temp != NULL) {
497 UnicodeSPrint(RetVal, Size, Temp, Dev, Dev->Mode->Attribute);
498 FreePool(Temp);
499 }
500
501 //
502 // Dump TextOut Info
503 //
504 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE), NULL);
505 for (Index = 0; Index < Dev->Mode->MaxMode; Index++) {
506 Status = Dev->QueryMode (Dev, Index, &Col, &Row);
507 NewSize = Size - StrSize(RetVal);
508 UnicodeSPrint(
509 RetVal + StrLen(RetVal),
510 NewSize,
511 Temp == NULL?L"":Temp,
512 Index == Dev->Mode->Mode ? L'*' : L' ',
513 Index,
514 !EFI_ERROR(Status)?(INTN)Col:-1,
515 !EFI_ERROR(Status)?(INTN)Row:-1
516 );
517 }
518 FreePool(Temp);
519 return (RetVal);
520 }
521
522 STATIC CONST UINTN VersionStringSize = 60;
523
524 /**
525 Function to dump information about EfiDriverSupportedEfiVersion protocol.
526
527 This will allocate the return buffer from boot services pool.
528
529 @param[in] TheHandle The handle that has the protocol installed.
530 @param[in] Verbose TRUE for additional information, FALSE otherwise.
531
532 @retval A poitner to a string containing the information.
533 **/
534 CHAR16*
535 EFIAPI
536 DriverEfiVersionProtocolDumpInformation(
537 IN CONST EFI_HANDLE TheHandle,
538 IN CONST BOOLEAN Verbose
539 )
540 {
541 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL *DriverEfiVersion;
542 EFI_STATUS Status;
543 CHAR16 *RetVal;
544
545 Status = gBS->HandleProtocol(
546 TheHandle,
547 &gEfiDriverSupportedEfiVersionProtocolGuid,
548 (VOID**)&DriverEfiVersion);
549
550 ASSERT_EFI_ERROR(Status);
551
552 RetVal = AllocateZeroPool(VersionStringSize);
553 ASSERT(RetVal != NULL);
554 UnicodeSPrint(RetVal, VersionStringSize, L"0x%08x", DriverEfiVersion->FirmwareVersion);
555 return (RetVal);
556 }
557
558 /**
559 Function to dump information about DevicePath protocol.
560
561 This will allocate the return buffer from boot services pool.
562
563 @param[in] TheHandle The handle that has the protocol installed.
564 @param[in] Verbose TRUE for additional information, FALSE otherwise.
565
566 @retval A poitner to a string containing the information.
567 **/
568 CHAR16*
569 EFIAPI
570 DevicePathProtocolDumpInformation(
571 IN CONST EFI_HANDLE TheHandle,
572 IN CONST BOOLEAN Verbose
573 )
574 {
575 EFI_DEVICE_PATH_PROTOCOL *DevPath;
576 CHAR16 *Temp;
577 CHAR16 *Temp2;
578 EFI_STATUS Status;
579 Temp = NULL;
580
581 Status = gBS->OpenProtocol(TheHandle, &gEfiDevicePathProtocolGuid, (VOID**)&DevPath, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
582 if (!EFI_ERROR(Status)) {
583 //
584 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)
585 //
586 Temp = ConvertDevicePathToText(DevPath, TRUE, TRUE);
587 gBS->CloseProtocol(TheHandle, &gEfiDevicePathProtocolGuid, gImageHandle, NULL);
588 }
589 if (!Verbose && Temp != NULL && StrLen(Temp) > 30) {
590 Temp2 = NULL;
591 Temp2 = StrnCatGrow(&Temp2, NULL, Temp+(StrLen(Temp) - 30), 30);
592 FreePool(Temp);
593 Temp = Temp2;
594 }
595 return (Temp);
596 }
597
598 /**
599 Function to dump information about EfiAdapterInformation Protocol.
600
601 @param[in] TheHandle The handle that has the protocol installed.
602 @param[in] Verbose TRUE for additional information, FALSE otherwise.
603
604 @retval A pointer to a string containing the information.
605 **/
606 CHAR16*
607 EFIAPI
608 AdapterInformationDumpInformation (
609 IN CONST EFI_HANDLE TheHandle,
610 IN CONST BOOLEAN Verbose
611 )
612 {
613 EFI_STATUS Status;
614 EFI_ADAPTER_INFORMATION_PROTOCOL *EfiAdptrInfoProtocol;
615 UINTN InfoTypesBufferCount;
616 UINTN GuidIndex;
617 EFI_GUID *InfoTypesBuffer;
618 CHAR16 *GuidStr;
619 CHAR16 *TempStr;
620 CHAR16 *RetVal;
621 VOID *InformationBlock;
622 UINTN InformationBlockSize;
623
624 if (!Verbose) {
625 return (CatSPrint(NULL, L"AdapterInfo"));
626 }
627
628 InfoTypesBuffer = NULL;
629 InformationBlock = NULL;
630
631 //
632 // Allocate print buffer to store data
633 //
634 RetVal = AllocateZeroPool (PcdGet16(PcdShellPrintBufferSize));
635 if (RetVal == NULL) {
636 return NULL;
637 }
638
639 Status = gBS->OpenProtocol (
640 (EFI_HANDLE) (TheHandle),
641 &gEfiAdapterInformationProtocolGuid,
642 (VOID **) &EfiAdptrInfoProtocol,
643 NULL,
644 NULL,
645 EFI_OPEN_PROTOCOL_GET_PROTOCOL
646 );
647
648 if (EFI_ERROR (Status)) {
649 SHELL_FREE_NON_NULL (RetVal);
650 return NULL;
651 }
652
653 //
654 // Get a list of supported information types for this instance of the protocol.
655 //
656 Status = EfiAdptrInfoProtocol->GetSupportedTypes (
657 EfiAdptrInfoProtocol,
658 &InfoTypesBuffer,
659 &InfoTypesBufferCount
660 );
661 if (EFI_ERROR (Status)) {
662 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GET_SUPP_TYPES_FAILED), NULL);
663 if (TempStr != NULL) {
664 RetVal = CatSPrint (RetVal, TempStr, Status);
665 } else {
666 goto ERROR_EXIT;
667 }
668 } else {
669 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_SUPP_TYPE_HEADER), NULL);
670 if (TempStr == NULL) {
671 goto ERROR_EXIT;
672 }
673 RetVal = CatSPrint (RetVal, TempStr);
674 SHELL_FREE_NON_NULL (TempStr);
675
676 for (GuidIndex = 0; GuidIndex < InfoTypesBufferCount; GuidIndex++) {
677 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GUID_NUMBER), NULL);
678 if (TempStr == NULL) {
679 goto ERROR_EXIT;
680 }
681 RetVal = CatSPrint (RetVal, TempStr, (GuidIndex + 1), InfoTypesBuffer[GuidIndex]);
682 SHELL_FREE_NON_NULL (TempStr);
683
684 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GUID_STRING), NULL);
685 if (TempStr == NULL) {
686 goto ERROR_EXIT;
687 }
688
689 if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoMediaStateGuid)) {
690 RetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoMediaStateGuid");
691 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoNetworkBootGuid)) {
692 RetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoNetworkBootGuid");
693 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoSanMacAddressGuid)) {
694 RetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoSanMacAddressGuid");
695 } else {
696
697 GuidStr = GetStringNameFromGuid (&InfoTypesBuffer[GuidIndex], NULL);
698
699 if (GuidStr != NULL) {
700 if (StrCmp(GuidStr, L"UnknownDevice") == 0) {
701 RetVal = CatSPrint (RetVal, TempStr, L"UnknownInfoType");
702
703 SHELL_FREE_NON_NULL (TempStr);
704 SHELL_FREE_NON_NULL(GuidStr);
705 //
706 // So that we never have to pass this UnknownInfoType to the parsing function "GetInformation" service of AIP
707 //
708 continue;
709 } else {
710 RetVal = CatSPrint (RetVal, TempStr, GuidStr);
711 SHELL_FREE_NON_NULL(GuidStr);
712 }
713 }
714 }
715
716 SHELL_FREE_NON_NULL (TempStr);
717
718 Status = EfiAdptrInfoProtocol->GetInformation (
719 EfiAdptrInfoProtocol,
720 &InfoTypesBuffer[GuidIndex],
721 &InformationBlock,
722 &InformationBlockSize
723 );
724
725 if (EFI_ERROR (Status)) {
726 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GETINFO_FAILED), NULL);
727 if (TempStr == NULL) {
728 goto ERROR_EXIT;
729 }
730 RetVal = CatSPrint (RetVal, TempStr, Status);
731 } else {
732 if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoMediaStateGuid)) {
733 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_MEDIA_STATE), NULL);
734 if (TempStr == NULL) {
735 goto ERROR_EXIT;
736 }
737 RetVal = CatSPrint (
738 RetVal,
739 TempStr,
740 ((EFI_ADAPTER_INFO_MEDIA_STATE *)InformationBlock)->MediaState,
741 ((EFI_ADAPTER_INFO_MEDIA_STATE *)InformationBlock)->MediaState
742 );
743 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoNetworkBootGuid)) {
744 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_NETWORK_BOOT_INFO), NULL);
745 if (TempStr == NULL) {
746 goto ERROR_EXIT;
747 }
748 RetVal = CatSPrint (
749 RetVal,
750 TempStr,
751 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv4BootCapablity,
752 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv6BootCapablity,
753 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->FCoeBootCapablity,
754 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->OffloadCapability,
755 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiMpioCapability,
756 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv4Boot,
757 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv6Boot,
758 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->FCoeBoot
759 );
760 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoSanMacAddressGuid) == TRUE) {
761 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_SAN_MAC_ADDRESS_INFO), NULL);
762 if (TempStr == NULL) {
763 goto ERROR_EXIT;
764 }
765 RetVal = CatSPrint (
766 RetVal,
767 TempStr,
768 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[0],
769 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[1],
770 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[2],
771 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[3],
772 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[4],
773 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[5]
774 );
775 } else {
776 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_UNKNOWN_INFO_TYPE), NULL);
777 if (TempStr == NULL) {
778 goto ERROR_EXIT;
779 }
780 RetVal = CatSPrint (RetVal, TempStr, &InfoTypesBuffer[GuidIndex]);
781 }
782 }
783 SHELL_FREE_NON_NULL (TempStr);
784 SHELL_FREE_NON_NULL (InformationBlock);
785 }
786 }
787
788 SHELL_FREE_NON_NULL (InfoTypesBuffer);
789 return RetVal;
790
791 ERROR_EXIT:
792 SHELL_FREE_NON_NULL (RetVal);
793 SHELL_FREE_NON_NULL (InfoTypesBuffer);
794 SHELL_FREE_NON_NULL (InformationBlock);
795 return NULL;
796 }
797 //
798 // Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg
799 //
800 #define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \
801 { \
802 0x58c518b1, 0x76f3, 0x11d4, { 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
803 }
804
805 #define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \
806 { \
807 0x96eb4ad6, 0xa32a, 0x11d4, { 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
808 }
809
810 #define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \
811 { \
812 0xc95a93d, 0xa006, 0x11d4, { 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
813 }
814 STATIC CONST EFI_GUID WinNtThunkProtocolGuid = LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID;
815 STATIC CONST EFI_GUID WinNtIoProtocolGuid = LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID;
816 STATIC CONST EFI_GUID WinNtSerialPortGuid = LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID;
817
818 //
819 // Deprecated protocols we dont want to link from IntelFrameworkModulePkg
820 //
821 #define LOCAL_EFI_ISA_IO_PROTOCOL_GUID \
822 { \
823 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
824 }
825 #define LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID \
826 { \
827 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 } \
828 }
829 STATIC CONST EFI_GUID EfiIsaIoProtocolGuid = LOCAL_EFI_ISA_IO_PROTOCOL_GUID;
830 STATIC CONST EFI_GUID EfiIsaAcpiProtocolGuid = LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID;
831
832
833 STATIC CONST GUID_INFO_BLOCK mGuidStringListNT[] = {
834 {STRING_TOKEN(STR_WINNT_THUNK), (EFI_GUID*)&WinNtThunkProtocolGuid, NULL},
835 {STRING_TOKEN(STR_WINNT_DRIVER_IO), (EFI_GUID*)&WinNtIoProtocolGuid, NULL},
836 {STRING_TOKEN(STR_WINNT_SERIAL_PORT), (EFI_GUID*)&WinNtSerialPortGuid, NULL},
837 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},
838 };
839
840 STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {
841 {STRING_TOKEN(STR_LOADED_IMAGE), &gEfiLoadedImageProtocolGuid, LoadedImageProtocolDumpInformation},
842 {STRING_TOKEN(STR_DEVICE_PATH), &gEfiDevicePathProtocolGuid, DevicePathProtocolDumpInformation},
843 {STRING_TOKEN(STR_IMAGE_PATH), &gEfiLoadedImageDevicePathProtocolGuid, DevicePathProtocolDumpInformation},
844 {STRING_TOKEN(STR_DEVICE_PATH_UTIL), &gEfiDevicePathUtilitiesProtocolGuid, NULL},
845 {STRING_TOKEN(STR_DEVICE_PATH_TXT), &gEfiDevicePathToTextProtocolGuid, NULL},
846 {STRING_TOKEN(STR_DEVICE_PATH_FTXT), &gEfiDevicePathFromTextProtocolGuid, NULL},
847 {STRING_TOKEN(STR_DEVICE_PATH_PC), &gEfiPcAnsiGuid, NULL},
848 {STRING_TOKEN(STR_DEVICE_PATH_VT100), &gEfiVT100Guid, NULL},
849 {STRING_TOKEN(STR_DEVICE_PATH_VT100P), &gEfiVT100PlusGuid, NULL},
850 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8), &gEfiVTUTF8Guid, NULL},
851 {STRING_TOKEN(STR_DRIVER_BINDING), &gEfiDriverBindingProtocolGuid, NULL},
852 {STRING_TOKEN(STR_PLATFORM_OVERRIDE), &gEfiPlatformDriverOverrideProtocolGuid, NULL},
853 {STRING_TOKEN(STR_BUS_OVERRIDE), &gEfiBusSpecificDriverOverrideProtocolGuid, NULL},
854 {STRING_TOKEN(STR_DRIVER_DIAG), &gEfiDriverDiagnosticsProtocolGuid, NULL},
855 {STRING_TOKEN(STR_DRIVER_DIAG2), &gEfiDriverDiagnostics2ProtocolGuid, NULL},
856 {STRING_TOKEN(STR_DRIVER_CN), &gEfiComponentNameProtocolGuid, NULL},
857 {STRING_TOKEN(STR_DRIVER_CN2), &gEfiComponentName2ProtocolGuid, NULL},
858 {STRING_TOKEN(STR_PLAT_DRV_CFG), &gEfiPlatformToDriverConfigurationProtocolGuid, NULL},
859 {STRING_TOKEN(STR_DRIVER_VERSION), &gEfiDriverSupportedEfiVersionProtocolGuid, DriverEfiVersionProtocolDumpInformation},
860 {STRING_TOKEN(STR_TXT_IN), &gEfiSimpleTextInProtocolGuid, NULL},
861 {STRING_TOKEN(STR_TXT_IN_EX), &gEfiSimpleTextInputExProtocolGuid, NULL},
862 {STRING_TOKEN(STR_TXT_OUT), &gEfiSimpleTextOutProtocolGuid, TxtOutProtocolDumpInformation},
863 {STRING_TOKEN(STR_SIM_POINTER), &gEfiSimplePointerProtocolGuid, NULL},
864 {STRING_TOKEN(STR_ABS_POINTER), &gEfiAbsolutePointerProtocolGuid, NULL},
865 {STRING_TOKEN(STR_SERIAL_IO), &gEfiSerialIoProtocolGuid, NULL},
866 {STRING_TOKEN(STR_GRAPHICS_OUTPUT), &gEfiGraphicsOutputProtocolGuid, GraphicsOutputProtocolDumpInformation},
867 {STRING_TOKEN(STR_EDID_DISCOVERED), &gEfiEdidDiscoveredProtocolGuid, NULL},
868 {STRING_TOKEN(STR_EDID_ACTIVE), &gEfiEdidActiveProtocolGuid, NULL},
869 {STRING_TOKEN(STR_EDID_OVERRIDE), &gEfiEdidOverrideProtocolGuid, NULL},
870 {STRING_TOKEN(STR_CON_IN), &gEfiConsoleInDeviceGuid, NULL},
871 {STRING_TOKEN(STR_CON_OUT), &gEfiConsoleOutDeviceGuid, NULL},
872 {STRING_TOKEN(STR_STD_ERR), &gEfiStandardErrorDeviceGuid, NULL},
873 {STRING_TOKEN(STR_LOAD_FILE), &gEfiLoadFileProtocolGuid, NULL},
874 {STRING_TOKEN(STR_LOAD_FILE2), &gEfiLoadFile2ProtocolGuid, NULL},
875 {STRING_TOKEN(STR_SIMPLE_FILE_SYS), &gEfiSimpleFileSystemProtocolGuid, NULL},
876 {STRING_TOKEN(STR_TAPE_IO), &gEfiTapeIoProtocolGuid, NULL},
877 {STRING_TOKEN(STR_DISK_IO), &gEfiDiskIoProtocolGuid, NULL},
878 {STRING_TOKEN(STR_BLK_IO), &gEfiBlockIoProtocolGuid, NULL},
879 {STRING_TOKEN(STR_UC), &gEfiUnicodeCollationProtocolGuid, NULL},
880 {STRING_TOKEN(STR_UC2), &gEfiUnicodeCollation2ProtocolGuid, NULL},
881 {STRING_TOKEN(STR_PCIRB_IO), &gEfiPciRootBridgeIoProtocolGuid, PciRootBridgeIoDumpInformation},
882 {STRING_TOKEN(STR_PCI_IO), &gEfiPciIoProtocolGuid, NULL},
883 {STRING_TOKEN(STR_SCSI_PT), &gEfiScsiPassThruProtocolGuid, NULL},
884 {STRING_TOKEN(STR_SCSI_IO), &gEfiScsiIoProtocolGuid, NULL},
885 {STRING_TOKEN(STR_SCSI_PT_EXT), &gEfiExtScsiPassThruProtocolGuid, NULL},
886 {STRING_TOKEN(STR_ISCSI), &gEfiIScsiInitiatorNameProtocolGuid, NULL},
887 {STRING_TOKEN(STR_USB_IO), &gEfiUsbIoProtocolGuid, NULL},
888 {STRING_TOKEN(STR_USB_HC), &gEfiUsbHcProtocolGuid, NULL},
889 {STRING_TOKEN(STR_USB_HC2), &gEfiUsb2HcProtocolGuid, NULL},
890 {STRING_TOKEN(STR_DEBUG_SUPPORT), &gEfiDebugSupportProtocolGuid, NULL},
891 {STRING_TOKEN(STR_DEBUG_PORT), &gEfiDebugPortProtocolGuid, NULL},
892 {STRING_TOKEN(STR_DECOMPRESS), &gEfiDecompressProtocolGuid, NULL},
893 {STRING_TOKEN(STR_ACPI_TABLE), &gEfiAcpiTableProtocolGuid, NULL},
894 {STRING_TOKEN(STR_EBC_INTERPRETER), &gEfiEbcProtocolGuid, NULL},
895 {STRING_TOKEN(STR_SNP), &gEfiSimpleNetworkProtocolGuid, NULL},
896 {STRING_TOKEN(STR_NII), &gEfiNetworkInterfaceIdentifierProtocolGuid, NULL},
897 {STRING_TOKEN(STR_NII_31), &gEfiNetworkInterfaceIdentifierProtocolGuid_31, NULL},
898 {STRING_TOKEN(STR_PXE_BC), &gEfiPxeBaseCodeProtocolGuid, NULL},
899 {STRING_TOKEN(STR_PXE_CB), &gEfiPxeBaseCodeCallbackProtocolGuid, NULL},
900 {STRING_TOKEN(STR_BIS), &gEfiBisProtocolGuid, NULL},
901 {STRING_TOKEN(STR_MNP_SB), &gEfiManagedNetworkServiceBindingProtocolGuid, NULL},
902 {STRING_TOKEN(STR_MNP), &gEfiManagedNetworkProtocolGuid, NULL},
903 {STRING_TOKEN(STR_ARP_SB), &gEfiArpServiceBindingProtocolGuid, NULL},
904 {STRING_TOKEN(STR_ARP), &gEfiArpProtocolGuid, NULL},
905 {STRING_TOKEN(STR_DHCPV4_SB), &gEfiDhcp4ServiceBindingProtocolGuid, NULL},
906 {STRING_TOKEN(STR_DHCPV4), &gEfiDhcp4ProtocolGuid, NULL},
907 {STRING_TOKEN(STR_TCPV4_SB), &gEfiTcp4ServiceBindingProtocolGuid, NULL},
908 {STRING_TOKEN(STR_TCPV4), &gEfiTcp4ProtocolGuid, NULL},
909 {STRING_TOKEN(STR_IPV4_SB), &gEfiIp4ServiceBindingProtocolGuid, NULL},
910 {STRING_TOKEN(STR_IPV4), &gEfiIp4ProtocolGuid, NULL},
911 {STRING_TOKEN(STR_IPV4_CFG), &gEfiIp4ConfigProtocolGuid, NULL},
912 {STRING_TOKEN(STR_IPV4_CFG2), &gEfiIp4Config2ProtocolGuid, NULL},
913 {STRING_TOKEN(STR_UDPV4_SB), &gEfiUdp4ServiceBindingProtocolGuid, NULL},
914 {STRING_TOKEN(STR_UDPV4), &gEfiUdp4ProtocolGuid, NULL},
915 {STRING_TOKEN(STR_MTFTPV4_SB), &gEfiMtftp4ServiceBindingProtocolGuid, NULL},
916 {STRING_TOKEN(STR_MTFTPV4), &gEfiMtftp4ProtocolGuid, NULL},
917 {STRING_TOKEN(STR_AUTH_INFO), &gEfiAuthenticationInfoProtocolGuid, NULL},
918 {STRING_TOKEN(STR_HASH_SB), &gEfiHashServiceBindingProtocolGuid, NULL},
919 {STRING_TOKEN(STR_HASH), &gEfiHashProtocolGuid, NULL},
920 {STRING_TOKEN(STR_HII_FONT), &gEfiHiiFontProtocolGuid, NULL},
921 {STRING_TOKEN(STR_HII_STRING), &gEfiHiiStringProtocolGuid, NULL},
922 {STRING_TOKEN(STR_HII_IMAGE), &gEfiHiiImageProtocolGuid, NULL},
923 {STRING_TOKEN(STR_HII_DATABASE), &gEfiHiiDatabaseProtocolGuid, NULL},
924 {STRING_TOKEN(STR_HII_CONFIG_ROUT), &gEfiHiiConfigRoutingProtocolGuid, NULL},
925 {STRING_TOKEN(STR_HII_CONFIG_ACC), &gEfiHiiConfigAccessProtocolGuid, NULL},
926 {STRING_TOKEN(STR_HII_FORM_BROWSER2), &gEfiFormBrowser2ProtocolGuid, NULL},
927 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE), &gEfiDriverFamilyOverrideProtocolGuid, NULL},
928 {STRING_TOKEN(STR_PCD), &gPcdProtocolGuid, NULL},
929 {STRING_TOKEN(STR_TCG), &gEfiTcgProtocolGuid, NULL},
930 {STRING_TOKEN(STR_HII_PACKAGE_LIST), &gEfiHiiPackageListProtocolGuid, NULL},
931
932 //
933 // the ones under this are deprecated by the current UEFI Spec, but may be found anyways...
934 //
935 {STRING_TOKEN(STR_SHELL_INTERFACE), &gEfiShellInterfaceGuid, NULL},
936 {STRING_TOKEN(STR_SHELL_ENV2), &gEfiShellEnvironment2Guid, NULL},
937 {STRING_TOKEN(STR_SHELL_ENV), &gEfiShellEnvironment2Guid, NULL},
938 {STRING_TOKEN(STR_DEVICE_IO), &gEfiDeviceIoProtocolGuid, NULL},
939 {STRING_TOKEN(STR_UGA_DRAW), &gEfiUgaDrawProtocolGuid, NULL},
940 {STRING_TOKEN(STR_UGA_IO), &gEfiUgaIoProtocolGuid, NULL},
941 {STRING_TOKEN(STR_ESP), &gEfiPartTypeSystemPartGuid, NULL},
942 {STRING_TOKEN(STR_GPT_NBR), &gEfiPartTypeLegacyMbrGuid, NULL},
943 {STRING_TOKEN(STR_DRIVER_CONFIG), &gEfiDriverConfigurationProtocolGuid, NULL},
944 {STRING_TOKEN(STR_DRIVER_CONFIG2), &gEfiDriverConfiguration2ProtocolGuid, NULL},
945
946 //
947 // these are using local (non-global) definitions to reduce package dependancy.
948 //
949 {STRING_TOKEN(STR_ISA_IO), (EFI_GUID*)&EfiIsaIoProtocolGuid, NULL},
950 {STRING_TOKEN(STR_ISA_ACPI), (EFI_GUID*)&EfiIsaAcpiProtocolGuid, NULL},
951
952 //
953 // the ones under this are GUID identified structs, not protocols
954 //
955 {STRING_TOKEN(STR_FILE_INFO), &gEfiFileInfoGuid, NULL},
956 {STRING_TOKEN(STR_FILE_SYS_INFO), &gEfiFileSystemInfoGuid, NULL},
957
958 //
959 // the ones under this are misc GUIDS.
960 //
961 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE), &gEfiGlobalVariableGuid, NULL},
962
963 //
964 // UEFI 2.2
965 //
966 {STRING_TOKEN(STR_IP6_SB), &gEfiIp6ServiceBindingProtocolGuid, NULL},
967 {STRING_TOKEN(STR_IP6), &gEfiIp6ProtocolGuid, NULL},
968 {STRING_TOKEN(STR_IP6_CONFIG), &gEfiIp6ConfigProtocolGuid, NULL},
969 {STRING_TOKEN(STR_MTFTP6_SB), &gEfiMtftp6ServiceBindingProtocolGuid, NULL},
970 {STRING_TOKEN(STR_MTFTP6), &gEfiMtftp6ProtocolGuid, NULL},
971 {STRING_TOKEN(STR_DHCP6_SB), &gEfiDhcp6ServiceBindingProtocolGuid, NULL},
972 {STRING_TOKEN(STR_DHCP6), &gEfiDhcp6ProtocolGuid, NULL},
973 {STRING_TOKEN(STR_UDP6_SB), &gEfiUdp6ServiceBindingProtocolGuid, NULL},
974 {STRING_TOKEN(STR_UDP6), &gEfiUdp6ProtocolGuid, NULL},
975 {STRING_TOKEN(STR_TCP6_SB), &gEfiTcp6ServiceBindingProtocolGuid, NULL},
976 {STRING_TOKEN(STR_TCP6), &gEfiTcp6ProtocolGuid, NULL},
977 {STRING_TOKEN(STR_VLAN_CONFIG), &gEfiVlanConfigProtocolGuid, NULL},
978 {STRING_TOKEN(STR_EAP), &gEfiEapProtocolGuid, NULL},
979 {STRING_TOKEN(STR_EAP_MGMT), &gEfiEapManagementProtocolGuid, NULL},
980 {STRING_TOKEN(STR_FTP4_SB), &gEfiFtp4ServiceBindingProtocolGuid, NULL},
981 {STRING_TOKEN(STR_FTP4), &gEfiFtp4ProtocolGuid, NULL},
982 {STRING_TOKEN(STR_IP_SEC_CONFIG), &gEfiIpSecConfigProtocolGuid, NULL},
983 {STRING_TOKEN(STR_DH), &gEfiDriverHealthProtocolGuid, NULL},
984 {STRING_TOKEN(STR_DEF_IMG_LOAD), &gEfiDeferredImageLoadProtocolGuid, NULL},
985 {STRING_TOKEN(STR_USER_CRED), &gEfiUserCredentialProtocolGuid, NULL},
986 {STRING_TOKEN(STR_USER_MNGR), &gEfiUserManagerProtocolGuid, NULL},
987 {STRING_TOKEN(STR_ATA_PASS_THRU), &gEfiAtaPassThruProtocolGuid, NULL},
988
989 //
990 // UEFI 2.3
991 //
992 {STRING_TOKEN(STR_FW_MGMT), &gEfiFirmwareManagementProtocolGuid, NULL},
993 {STRING_TOKEN(STR_IP_SEC), &gEfiIpSecProtocolGuid, NULL},
994 {STRING_TOKEN(STR_IP_SEC2), &gEfiIpSec2ProtocolGuid, NULL},
995
996 //
997 // UEFI 2.3.1
998 //
999 {STRING_TOKEN(STR_KMS), &gEfiKmsProtocolGuid, NULL},
1000 {STRING_TOKEN(STR_BLK_IO2), &gEfiBlockIo2ProtocolGuid, NULL},
1001 {STRING_TOKEN(STR_SSC), &gEfiStorageSecurityCommandProtocolGuid, NULL},
1002 {STRING_TOKEN(STR_UCRED2), &gEfiUserCredential2ProtocolGuid, NULL},
1003
1004 //
1005 // UEFI 2.4
1006 //
1007 {STRING_TOKEN(STR_DISK_IO2), &gEfiDiskIo2ProtocolGuid, NULL},
1008 {STRING_TOKEN(STR_ADAPTER_INFO), &gEfiAdapterInformationProtocolGuid, AdapterInformationDumpInformation},
1009
1010 //
1011 // PI Spec ones
1012 //
1013 {STRING_TOKEN(STR_IDE_CONT_INIT), &gEfiIdeControllerInitProtocolGuid, NULL},
1014 {STRING_TOKEN(STR_DISK_INFO), &gEfiDiskInfoProtocolGuid, NULL},
1015
1016 //
1017 // UEFI Shell Spec 2.0
1018 //
1019 {STRING_TOKEN(STR_SHELL_PARAMETERS), &gEfiShellParametersProtocolGuid, NULL},
1020 {STRING_TOKEN(STR_SHELL), &gEfiShellProtocolGuid, NULL},
1021
1022 //
1023 // UEFI Shell Spec 2.1
1024 //
1025 {STRING_TOKEN(STR_SHELL_DYNAMIC), &gEfiShellDynamicCommandProtocolGuid, NULL},
1026
1027 //
1028 // terminator
1029 //
1030 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},
1031 };
1032
1033 /**
1034 Function to get the node for a protocol or struct from it's GUID.
1035
1036 if Guid is NULL, then ASSERT.
1037
1038 @param[in] Guid The GUID to look for the name of.
1039
1040 @return The node.
1041 **/
1042 CONST GUID_INFO_BLOCK *
1043 EFIAPI
1044 InternalShellGetNodeFromGuid(
1045 IN CONST EFI_GUID* Guid
1046 )
1047 {
1048 CONST GUID_INFO_BLOCK *ListWalker;
1049 UINTN LoopCount;
1050
1051 ASSERT(Guid != NULL);
1052
1053 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {
1054 if (CompareGuid(ListWalker->GuidId, Guid)) {
1055 return (ListWalker);
1056 }
1057 }
1058
1059 if (PcdGetBool(PcdShellIncludeNtGuids)) {
1060 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
1061 if (CompareGuid(ListWalker->GuidId, Guid)) {
1062 return (ListWalker);
1063 }
1064 }
1065 }
1066 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
1067 if (CompareGuid(ListWalker->GuidId, Guid)) {
1068 return (ListWalker);
1069 }
1070 }
1071 return (NULL);
1072 }
1073
1074 /**
1075 Function to add a new GUID/Name mapping.
1076
1077 @param[in] Guid The Guid
1078 @param[in] NameID The STRING id of the HII string to use
1079 @param[in] DumpFunc The pointer to the dump function
1080
1081
1082 @retval EFI_SUCCESS The operation was sucessful
1083 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1084 @retval EFI_INVALID_PARAMETER Guid NameId was invalid
1085 **/
1086 EFI_STATUS
1087 EFIAPI
1088 InsertNewGuidNameMapping(
1089 IN CONST EFI_GUID *Guid,
1090 IN CONST EFI_STRING_ID NameID,
1091 IN CONST DUMP_PROTOCOL_INFO DumpFunc OPTIONAL
1092 )
1093 {
1094 ASSERT(Guid != NULL);
1095 ASSERT(NameID != 0);
1096
1097 GuidList = ReallocatePool(GuidListCount * sizeof(GUID_INFO_BLOCK), GuidListCount+1 * sizeof(GUID_INFO_BLOCK), GuidList);
1098 if (GuidList == NULL) {
1099 GuidListCount = 0;
1100 return (EFI_OUT_OF_RESOURCES);
1101 }
1102 GuidListCount++;
1103
1104 GuidList[GuidListCount - 1].GuidId = AllocateCopyPool(sizeof(EFI_GUID), Guid);
1105 GuidList[GuidListCount - 1].StringId = NameID;
1106 GuidList[GuidListCount - 1].DumpInfo = DumpFunc;
1107
1108 if (GuidList[GuidListCount - 1].GuidId == NULL) {
1109 return (EFI_OUT_OF_RESOURCES);
1110 }
1111
1112 return (EFI_SUCCESS);
1113 }
1114
1115 /**
1116 Function to add a new GUID/Name mapping.
1117
1118 This cannot overwrite an existing mapping.
1119
1120 @param[in] Guid The Guid
1121 @param[in] TheName The Guid's name
1122 @param[in] Lang RFC4646 language code list or NULL
1123
1124 @retval EFI_SUCCESS The operation was sucessful
1125 @retval EFI_ACCESS_DENIED There was a duplicate
1126 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1127 @retval EFI_INVALID_PARAMETER Guid or TheName was NULL
1128 **/
1129 EFI_STATUS
1130 EFIAPI
1131 AddNewGuidNameMapping(
1132 IN CONST EFI_GUID *Guid,
1133 IN CONST CHAR16 *TheName,
1134 IN CONST CHAR8 *Lang OPTIONAL
1135 )
1136 {
1137 EFI_STRING_ID NameID;
1138
1139 HandleParsingHiiInit();
1140
1141 if (Guid == NULL || TheName == NULL){
1142 return (EFI_INVALID_PARAMETER);
1143 }
1144
1145 if ((InternalShellGetNodeFromGuid(Guid)) != NULL) {
1146 return (EFI_ACCESS_DENIED);
1147 }
1148
1149 NameID = HiiSetString(mHandleParsingHiiHandle, 0, (CHAR16*)TheName, Lang);
1150 if (NameID == 0) {
1151 return (EFI_OUT_OF_RESOURCES);
1152 }
1153
1154 return (InsertNewGuidNameMapping(Guid, NameID, NULL));
1155 }
1156
1157 /**
1158 Function to get the name of a protocol or struct from it's GUID.
1159
1160 if Guid is NULL, then ASSERT.
1161
1162 @param[in] Guid The GUID to look for the name of.
1163 @param[in] Lang The language to use.
1164
1165 @return pointer to string of the name. The caller
1166 is responsible to free this memory.
1167 **/
1168 CHAR16*
1169 EFIAPI
1170 GetStringNameFromGuid(
1171 IN CONST EFI_GUID *Guid,
1172 IN CONST CHAR8 *Lang OPTIONAL
1173 )
1174 {
1175 CONST GUID_INFO_BLOCK *Id;
1176
1177 HandleParsingHiiInit();
1178
1179 Id = InternalShellGetNodeFromGuid(Guid);
1180 return (HiiGetString(mHandleParsingHiiHandle, Id==NULL?STRING_TOKEN(STR_UNKNOWN_DEVICE):Id->StringId, Lang));
1181 }
1182
1183 /**
1184 Function to dump protocol information from a handle.
1185
1186 This function will return a allocated string buffer containing the
1187 information. The caller is responsible for freeing the memory.
1188
1189 If Guid is NULL, ASSERT().
1190 If TheHandle is NULL, ASSERT().
1191
1192 @param[in] TheHandle The handle to dump information from.
1193 @param[in] Guid The GUID of the protocol to dump.
1194 @param[in] Verbose TRUE for extra info. FALSE otherwise.
1195
1196 @return The pointer to string.
1197 @retval NULL An error was encountered.
1198 **/
1199 CHAR16*
1200 EFIAPI
1201 GetProtocolInformationDump(
1202 IN CONST EFI_HANDLE TheHandle,
1203 IN CONST EFI_GUID *Guid,
1204 IN CONST BOOLEAN Verbose
1205 )
1206 {
1207 CONST GUID_INFO_BLOCK *Id;
1208
1209 ASSERT(TheHandle != NULL);
1210 ASSERT(Guid != NULL);
1211
1212 if (TheHandle == NULL || Guid == NULL) {
1213 return (NULL);
1214 }
1215
1216 Id = InternalShellGetNodeFromGuid(Guid);
1217 if (Id != NULL && Id->DumpInfo != NULL) {
1218 return (Id->DumpInfo(TheHandle, Verbose));
1219 }
1220 return (NULL);
1221 }
1222
1223 /**
1224 Function to get the Guid for a protocol or struct based on it's string name.
1225
1226 do not modify the returned Guid.
1227
1228 @param[in] Name The pointer to the string name.
1229 @param[in] Lang The pointer to the language code.
1230 @param[out] Guid The pointer to the Guid.
1231
1232 @retval EFI_SUCCESS The operation was sucessful.
1233 **/
1234 EFI_STATUS
1235 EFIAPI
1236 GetGuidFromStringName(
1237 IN CONST CHAR16 *Name,
1238 IN CONST CHAR8 *Lang OPTIONAL,
1239 OUT EFI_GUID **Guid
1240 )
1241 {
1242 CONST GUID_INFO_BLOCK *ListWalker;
1243 CHAR16 *String;
1244 UINTN LoopCount;
1245
1246 HandleParsingHiiInit();
1247
1248 ASSERT(Guid != NULL);
1249 if (Guid == NULL) {
1250 return (EFI_INVALID_PARAMETER);
1251 }
1252 *Guid = NULL;
1253
1254 if (PcdGetBool(PcdShellIncludeNtGuids)) {
1255 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
1256 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);
1257 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {
1258 *Guid = ListWalker->GuidId;
1259 }
1260 SHELL_FREE_NON_NULL(String);
1261 if (*Guid != NULL) {
1262 return (EFI_SUCCESS);
1263 }
1264 }
1265 }
1266 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
1267 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);
1268 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {
1269 *Guid = ListWalker->GuidId;
1270 }
1271 SHELL_FREE_NON_NULL(String);
1272 if (*Guid != NULL) {
1273 return (EFI_SUCCESS);
1274 }
1275 }
1276
1277 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {
1278 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);
1279 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {
1280 *Guid = ListWalker->GuidId;
1281 }
1282 SHELL_FREE_NON_NULL(String);
1283 if (*Guid != NULL) {
1284 return (EFI_SUCCESS);
1285 }
1286 }
1287
1288 return (EFI_NOT_FOUND);
1289 }
1290
1291 /**
1292 Get best support language for this driver.
1293
1294 First base on the user input language to search, second base on the current
1295 platform used language to search, third get the first language from the
1296 support language list. The caller need to free the buffer of the best language.
1297
1298 @param[in] SupportedLanguages The support languages for this driver.
1299 @param[in] InputLanguage The user input language.
1300 @param[in] Iso639Language Whether get language for ISO639.
1301
1302 @return The best support language for this driver.
1303 **/
1304 CHAR8 *
1305 EFIAPI
1306 GetBestLanguageForDriver (
1307 IN CONST CHAR8 *SupportedLanguages,
1308 IN CONST CHAR8 *InputLanguage,
1309 IN BOOLEAN Iso639Language
1310 )
1311 {
1312 CHAR8 *LanguageVariable;
1313 CHAR8 *BestLanguage;
1314
1315 LanguageVariable = GetVariable (Iso639Language ? L"Lang" : L"PlatformLang", &gEfiGlobalVariableGuid);
1316
1317 BestLanguage = GetBestLanguage(
1318 SupportedLanguages,
1319 Iso639Language,
1320 (InputLanguage != NULL) ? InputLanguage : "",
1321 (LanguageVariable != NULL) ? LanguageVariable : "",
1322 SupportedLanguages,
1323 NULL
1324 );
1325
1326 if (LanguageVariable != NULL) {
1327 FreePool (LanguageVariable);
1328 }
1329
1330 return BestLanguage;
1331 }
1332
1333 /**
1334 Function to retrieve the driver name (if possible) from the ComponentName or
1335 ComponentName2 protocol
1336
1337 @param[in] TheHandle The driver handle to get the name of.
1338 @param[in] Language The language to use.
1339
1340 @retval NULL The name could not be found.
1341 @return A pointer to the string name. Do not de-allocate the memory.
1342 **/
1343 CONST CHAR16*
1344 EFIAPI
1345 GetStringNameFromHandle(
1346 IN CONST EFI_HANDLE TheHandle,
1347 IN CONST CHAR8 *Language
1348 )
1349 {
1350 EFI_COMPONENT_NAME2_PROTOCOL *CompNameStruct;
1351 EFI_STATUS Status;
1352 CHAR16 *RetVal;
1353 CHAR8 *BestLang;
1354
1355 BestLang = NULL;
1356
1357 Status = gBS->OpenProtocol(
1358 TheHandle,
1359 &gEfiComponentName2ProtocolGuid,
1360 (VOID**)&CompNameStruct,
1361 gImageHandle,
1362 NULL,
1363 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
1364 if (!EFI_ERROR(Status)) {
1365 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);
1366 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);
1367 if (BestLang != NULL) {
1368 FreePool (BestLang);
1369 BestLang = NULL;
1370 }
1371 if (!EFI_ERROR(Status)) {
1372 return (RetVal);
1373 }
1374 }
1375 Status = gBS->OpenProtocol(
1376 TheHandle,
1377 &gEfiComponentNameProtocolGuid,
1378 (VOID**)&CompNameStruct,
1379 gImageHandle,
1380 NULL,
1381 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
1382 if (!EFI_ERROR(Status)) {
1383 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);
1384 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);
1385 if (BestLang != NULL) {
1386 FreePool (BestLang);
1387 }
1388 if (!EFI_ERROR(Status)) {
1389 return (RetVal);
1390 }
1391 }
1392 return (NULL);
1393 }
1394
1395 /**
1396 Function to initialize the file global mHandleList object for use in
1397 vonverting handles to index and index to handle.
1398
1399 @retval EFI_SUCCESS The operation was successful.
1400 **/
1401 EFI_STATUS
1402 EFIAPI
1403 InternalShellInitHandleList(
1404 VOID
1405 )
1406 {
1407 EFI_STATUS Status;
1408 EFI_HANDLE *HandleBuffer;
1409 UINTN HandleCount;
1410 HANDLE_LIST *ListWalker;
1411
1412 if (mHandleList.NextIndex != 0) {
1413 return EFI_SUCCESS;
1414 }
1415 InitializeListHead(&mHandleList.List.Link);
1416 mHandleList.NextIndex = 1;
1417 Status = gBS->LocateHandleBuffer (
1418 AllHandles,
1419 NULL,
1420 NULL,
1421 &HandleCount,
1422 &HandleBuffer
1423 );
1424 ASSERT_EFI_ERROR(Status);
1425 if (EFI_ERROR(Status)) {
1426 return (Status);
1427 }
1428 for (mHandleList.NextIndex = 1 ; mHandleList.NextIndex <= HandleCount ; mHandleList.NextIndex++){
1429 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));
1430 ASSERT(ListWalker != NULL);
1431 ListWalker->TheHandle = HandleBuffer[mHandleList.NextIndex-1];
1432 ListWalker->TheIndex = mHandleList.NextIndex;
1433 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);
1434 }
1435 FreePool(HandleBuffer);
1436 return (EFI_SUCCESS);
1437 }
1438
1439 /**
1440 Function to retrieve the human-friendly index of a given handle. If the handle
1441 does not have a index one will be automatically assigned. The index value is valid
1442 until the termination of the shell application.
1443
1444 @param[in] TheHandle The handle to retrieve an index for.
1445
1446 @retval 0 A memory allocation failed.
1447 @return The index of the handle.
1448
1449 **/
1450 UINTN
1451 EFIAPI
1452 ConvertHandleToHandleIndex(
1453 IN CONST EFI_HANDLE TheHandle
1454 )
1455 {
1456 EFI_STATUS Status;
1457 EFI_GUID **ProtocolBuffer;
1458 UINTN ProtocolCount;
1459 HANDLE_LIST *ListWalker;
1460
1461 if (TheHandle == NULL) {
1462 return 0;
1463 }
1464
1465 InternalShellInitHandleList();
1466
1467 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)
1468 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)
1469 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)
1470 ){
1471 if (ListWalker->TheHandle == TheHandle) {
1472 //
1473 // Verify that TheHandle is still present in the Handle Database
1474 //
1475 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);
1476 if (EFI_ERROR (Status)) {
1477 //
1478 // TheHandle is not present in the Handle Database, so delete from the handle list
1479 //
1480 RemoveEntryList (&ListWalker->Link);
1481 return 0;
1482 }
1483 FreePool (ProtocolBuffer);
1484 return (ListWalker->TheIndex);
1485 }
1486 }
1487
1488 //
1489 // Verify that TheHandle is valid handle
1490 //
1491 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);
1492 if (EFI_ERROR (Status)) {
1493 //
1494 // TheHandle is not valid, so do not add to handle list
1495 //
1496 return 0;
1497 }
1498 FreePool (ProtocolBuffer);
1499
1500 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));
1501 ASSERT(ListWalker != NULL);
1502 ListWalker->TheHandle = TheHandle;
1503 ListWalker->TheIndex = mHandleList.NextIndex++;
1504 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);
1505 return (ListWalker->TheIndex);
1506 }
1507
1508
1509
1510 /**
1511 Function to retrieve the EFI_HANDLE from the human-friendly index.
1512
1513 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.
1514
1515 @retval NULL The index was invalid.
1516 @return The EFI_HANDLE that index represents.
1517
1518 **/
1519 EFI_HANDLE
1520 EFIAPI
1521 ConvertHandleIndexToHandle(
1522 IN CONST UINTN TheIndex
1523 )
1524 {
1525 EFI_STATUS Status;
1526 EFI_GUID **ProtocolBuffer;
1527 UINTN ProtocolCount;
1528 HANDLE_LIST *ListWalker;
1529
1530 InternalShellInitHandleList();
1531
1532 if (TheIndex >= mHandleList.NextIndex) {
1533 return NULL;
1534 }
1535
1536 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)
1537 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)
1538 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)
1539 ){
1540 if (ListWalker->TheIndex == TheIndex && ListWalker->TheHandle != NULL) {
1541 //
1542 // Verify that LinkWalker->TheHandle is valid handle
1543 //
1544 Status = gBS->ProtocolsPerHandle(ListWalker->TheHandle, &ProtocolBuffer, &ProtocolCount);
1545 if (EFI_ERROR (Status)) {
1546 //
1547 // TheHandle is not valid, so do not add to handle list
1548 //
1549 ListWalker->TheHandle = NULL;
1550 }
1551 return (ListWalker->TheHandle);
1552 }
1553 }
1554 return NULL;
1555 }
1556
1557 /**
1558 Gets all the related EFI_HANDLEs based on the mask supplied.
1559
1560 This function scans all EFI_HANDLES in the UEFI environment's handle database
1561 and returns the ones with the specified relationship (Mask) to the specified
1562 controller handle.
1563
1564 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
1565 If MatchingHandleCount is NULL, then ASSERT.
1566
1567 If MatchingHandleBuffer is not NULL upon a successful return the memory must be
1568 caller freed.
1569
1570 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.
1571 @param[in] ControllerHandle The handle with Device Path protocol on it.
1572 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in
1573 MatchingHandleBuffer.
1574 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount
1575 EFI_HANDLEs with a terminating NULL EFI_HANDLE.
1576 @param[out] HandleType An array of type information.
1577
1578 @retval EFI_SUCCESS The operation was successful, and any related handles
1579 are in MatchingHandleBuffer.
1580 @retval EFI_NOT_FOUND No matching handles were found.
1581 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
1582 **/
1583 EFI_STATUS
1584 EFIAPI
1585 ParseHandleDatabaseByRelationshipWithType (
1586 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
1587 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
1588 IN UINTN *HandleCount,
1589 OUT EFI_HANDLE **HandleBuffer,
1590 OUT UINTN **HandleType
1591 )
1592 {
1593 EFI_STATUS Status;
1594 UINTN HandleIndex;
1595 EFI_GUID **ProtocolGuidArray;
1596 UINTN ArrayCount;
1597 UINTN ProtocolIndex;
1598 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;
1599 UINTN OpenInfoCount;
1600 UINTN OpenInfoIndex;
1601 UINTN ChildIndex;
1602 INTN DriverBindingHandleIndex;
1603
1604 ASSERT(HandleCount != NULL);
1605 ASSERT(HandleBuffer != NULL);
1606 ASSERT(HandleType != NULL);
1607 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);
1608
1609 *HandleCount = 0;
1610 *HandleBuffer = NULL;
1611 *HandleType = NULL;
1612
1613 //
1614 // Retrieve the list of all handles from the handle database
1615 //
1616 Status = gBS->LocateHandleBuffer (
1617 AllHandles,
1618 NULL,
1619 NULL,
1620 HandleCount,
1621 HandleBuffer
1622 );
1623 if (EFI_ERROR (Status)) {
1624 return (Status);
1625 }
1626
1627 *HandleType = AllocateZeroPool (*HandleCount * sizeof (UINTN));
1628 ASSERT(*HandleType != NULL);
1629
1630 DriverBindingHandleIndex = -1;
1631 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {
1632 if (DriverBindingHandle != NULL && (*HandleBuffer)[HandleIndex] == DriverBindingHandle) {
1633 DriverBindingHandleIndex = (INTN)HandleIndex;
1634 }
1635 }
1636
1637 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {
1638 //
1639 // Retrieve the list of all the protocols on each handle
1640 //
1641 Status = gBS->ProtocolsPerHandle (
1642 (*HandleBuffer)[HandleIndex],
1643 &ProtocolGuidArray,
1644 &ArrayCount
1645 );
1646 if (EFI_ERROR (Status)) {
1647 continue;
1648 }
1649
1650 for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {
1651
1652 //
1653 // Set the bit describing what this handle has
1654 //
1655 if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiLoadedImageProtocolGuid) ) {
1656 (*HandleType)[HandleIndex] |= (UINTN)HR_IMAGE_HANDLE;
1657 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverBindingProtocolGuid) ) {
1658 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_BINDING_HANDLE;
1659 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfiguration2ProtocolGuid)) {
1660 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;
1661 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfigurationProtocolGuid) ) {
1662 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;
1663 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnostics2ProtocolGuid) ) {
1664 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;
1665 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnosticsProtocolGuid) ) {
1666 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;
1667 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentName2ProtocolGuid) ) {
1668 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;
1669 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentNameProtocolGuid) ) {
1670 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;
1671 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDevicePathProtocolGuid) ) {
1672 (*HandleType)[HandleIndex] |= (UINTN)HR_DEVICE_HANDLE;
1673 } else {
1674 DEBUG_CODE_BEGIN();
1675 ASSERT((*HandleType)[HandleIndex] == (*HandleType)[HandleIndex]);
1676 DEBUG_CODE_END();
1677 }
1678 //
1679 // Retrieve the list of agents that have opened each protocol
1680 //
1681 Status = gBS->OpenProtocolInformation (
1682 (*HandleBuffer)[HandleIndex],
1683 ProtocolGuidArray[ProtocolIndex],
1684 &OpenInfo,
1685 &OpenInfoCount
1686 );
1687 if (EFI_ERROR (Status)) {
1688 continue;
1689 }
1690
1691 if (ControllerHandle == NULL) {
1692 //
1693 // ControllerHandle == NULL and DriverBindingHandle != NULL.
1694 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing
1695 //
1696 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
1697 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {
1698 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
1699 if (DriverBindingHandleIndex != -1) {
1700 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;
1701 }
1702 }
1703 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
1704 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
1705 if (DriverBindingHandleIndex != -1) {
1706 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);
1707 }
1708 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
1709 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {
1710 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);
1711 }
1712 }
1713 }
1714 }
1715 }
1716 if (DriverBindingHandle == NULL && ControllerHandle != NULL) {
1717 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {
1718 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
1719 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
1720 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {
1721 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
1722 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {
1723 (*HandleType)[ChildIndex] |= (UINTN)HR_DEVICE_DRIVER;
1724 }
1725 }
1726 }
1727 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
1728 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
1729 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {
1730 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);
1731 }
1732 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {
1733 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);
1734 }
1735 }
1736 }
1737 }
1738 } else {
1739 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
1740 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
1741 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {
1742 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);
1743 }
1744 }
1745 }
1746 }
1747 }
1748 if (DriverBindingHandle != NULL && ControllerHandle != NULL) {
1749 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {
1750 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
1751 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
1752 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {
1753 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {
1754 if (DriverBindingHandleIndex != -1) {
1755 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;
1756 }
1757 }
1758 }
1759 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
1760 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {
1761 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
1762 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {
1763 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);
1764 }
1765 }
1766 }
1767
1768 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
1769 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {
1770 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);
1771 }
1772 }
1773 }
1774 }
1775 } else {
1776 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
1777 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
1778 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {
1779 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);
1780 }
1781 }
1782 }
1783 }
1784 }
1785 FreePool (OpenInfo);
1786 }
1787 FreePool (ProtocolGuidArray);
1788 }
1789 return EFI_SUCCESS;
1790 }
1791
1792 /**
1793 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask
1794 supplied.
1795
1796 This function will scan all EFI_HANDLES in the UEFI environment's handle database
1797 and return all the ones with the specified relationship (Mask) to the specified
1798 controller handle.
1799
1800 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
1801 If MatchingHandleCount is NULL, then ASSERT.
1802
1803 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be
1804 caller freed.
1805
1806 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol
1807 on it.
1808 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.
1809 @param[in] Mask Mask of what relationship(s) is desired.
1810 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in
1811 MatchingHandleBuffer.
1812 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount
1813 EFI_HANDLEs and a terminating NULL EFI_HANDLE.
1814
1815 @retval EFI_SUCCESS The operation was sucessful and any related handles
1816 are in MatchingHandleBuffer;
1817 @retval EFI_NOT_FOUND No matching handles were found.
1818 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
1819 **/
1820 EFI_STATUS
1821 EFIAPI
1822 ParseHandleDatabaseByRelationship (
1823 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
1824 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
1825 IN CONST UINTN Mask,
1826 IN UINTN *MatchingHandleCount,
1827 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
1828 )
1829 {
1830 EFI_STATUS Status;
1831 UINTN HandleCount;
1832 EFI_HANDLE *HandleBuffer;
1833 UINTN *HandleType;
1834 UINTN HandleIndex;
1835
1836 ASSERT(MatchingHandleCount != NULL);
1837 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);
1838
1839 if ((Mask & HR_VALID_MASK) != Mask) {
1840 return (EFI_INVALID_PARAMETER);
1841 }
1842
1843 if ((Mask & HR_CHILD_HANDLE) != 0 && DriverBindingHandle == NULL) {
1844 return (EFI_INVALID_PARAMETER);
1845 }
1846
1847 *MatchingHandleCount = 0;
1848 if (MatchingHandleBuffer != NULL) {
1849 *MatchingHandleBuffer = NULL;
1850 }
1851
1852 HandleBuffer = NULL;
1853 HandleType = NULL;
1854
1855 Status = ParseHandleDatabaseByRelationshipWithType (
1856 DriverBindingHandle,
1857 ControllerHandle,
1858 &HandleCount,
1859 &HandleBuffer,
1860 &HandleType
1861 );
1862 if (!EFI_ERROR (Status)) {
1863 //
1864 // Count the number of handles that match the attributes in Mask
1865 //
1866 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {
1867 if ((HandleType[HandleIndex] & Mask) == Mask) {
1868 (*MatchingHandleCount)++;
1869 }
1870 }
1871 //
1872 // If no handles match the attributes in Mask then return EFI_NOT_FOUND
1873 //
1874 if (*MatchingHandleCount == 0) {
1875 Status = EFI_NOT_FOUND;
1876 } else {
1877
1878 if (MatchingHandleBuffer == NULL) {
1879 //
1880 // Someone just wanted the count...
1881 //
1882 Status = EFI_SUCCESS;
1883 } else {
1884 //
1885 // Allocate a handle buffer for the number of handles that matched the attributes in Mask
1886 //
1887 *MatchingHandleBuffer = AllocateZeroPool ((*MatchingHandleCount +1)* sizeof (EFI_HANDLE));
1888 ASSERT(*MatchingHandleBuffer != NULL);
1889
1890 for (HandleIndex = 0,*MatchingHandleCount = 0
1891 ; HandleIndex < HandleCount
1892 ; HandleIndex++
1893 ){
1894 //
1895 // Fill the allocated buffer with the handles that matched the attributes in Mask
1896 //
1897 if ((HandleType[HandleIndex] & Mask) == Mask) {
1898 (*MatchingHandleBuffer)[(*MatchingHandleCount)++] = HandleBuffer[HandleIndex];
1899 }
1900 }
1901
1902 //
1903 // Make the last one NULL
1904 //
1905 (*MatchingHandleBuffer)[*MatchingHandleCount] = NULL;
1906
1907 Status = EFI_SUCCESS;
1908 } // MacthingHandleBuffer == NULL (ELSE)
1909 } // *MatchingHandleCount == 0 (ELSE)
1910 } // no error on ParseHandleDatabaseByRelationshipWithType
1911
1912 if (HandleBuffer != NULL) {
1913 FreePool (HandleBuffer);
1914 }
1915
1916 if (HandleType != NULL) {
1917 FreePool (HandleType);
1918 }
1919
1920 return Status;
1921 }
1922
1923 /**
1924 Gets handles for any child controllers of the passed in controller.
1925
1926 @param[in] ControllerHandle The handle of the "parent controller"
1927 @param[in] MatchingHandleCount Pointer to the number of handles in
1928 MatchingHandleBuffer on return.
1929 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
1930 return.
1931
1932
1933 @retval EFI_SUCCESS The operation was sucessful.
1934 **/
1935 EFI_STATUS
1936 EFIAPI
1937 ParseHandleDatabaseForChildControllers(
1938 IN CONST EFI_HANDLE ControllerHandle,
1939 IN UINTN *MatchingHandleCount,
1940 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
1941 )
1942 {
1943 EFI_STATUS Status;
1944 UINTN HandleIndex;
1945 UINTN DriverBindingHandleCount;
1946 EFI_HANDLE *DriverBindingHandleBuffer;
1947 UINTN DriverBindingHandleIndex;
1948 UINTN ChildControllerHandleCount;
1949 EFI_HANDLE *ChildControllerHandleBuffer;
1950 UINTN ChildControllerHandleIndex;
1951 EFI_HANDLE *HandleBufferForReturn;
1952
1953 if (MatchingHandleCount == NULL) {
1954 return (EFI_INVALID_PARAMETER);
1955 }
1956 *MatchingHandleCount = 0;
1957
1958 Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
1959 ControllerHandle,
1960 &DriverBindingHandleCount,
1961 &DriverBindingHandleBuffer
1962 );
1963 if (EFI_ERROR (Status)) {
1964 return Status;
1965 }
1966
1967 //
1968 // Get a buffer big enough for all the controllers.
1969 //
1970 HandleBufferForReturn = GetHandleListByProtocol(NULL);
1971 if (HandleBufferForReturn == NULL) {
1972 FreePool (DriverBindingHandleBuffer);
1973 return (EFI_NOT_FOUND);
1974 }
1975
1976 for (DriverBindingHandleIndex = 0; DriverBindingHandleIndex < DriverBindingHandleCount; DriverBindingHandleIndex++) {
1977 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
1978 DriverBindingHandleBuffer[DriverBindingHandleIndex],
1979 ControllerHandle,
1980 &ChildControllerHandleCount,
1981 &ChildControllerHandleBuffer
1982 );
1983 if (EFI_ERROR (Status)) {
1984 continue;
1985 }
1986
1987 for (ChildControllerHandleIndex = 0;
1988 ChildControllerHandleIndex < ChildControllerHandleCount;
1989 ChildControllerHandleIndex++
1990 ) {
1991 for (HandleIndex = 0; HandleIndex < *MatchingHandleCount; HandleIndex++) {
1992 if (HandleBufferForReturn[HandleIndex] == ChildControllerHandleBuffer[ChildControllerHandleIndex]) {
1993 break;
1994 }
1995 }
1996 if (HandleIndex >= *MatchingHandleCount) {
1997 HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];
1998 }
1999 }
2000
2001 FreePool (ChildControllerHandleBuffer);
2002 }
2003
2004 FreePool (DriverBindingHandleBuffer);
2005
2006 if (MatchingHandleBuffer != NULL) {
2007 *MatchingHandleBuffer = HandleBufferForReturn;
2008 } else {
2009 FreePool(HandleBufferForReturn);
2010 }
2011
2012 return (EFI_SUCCESS);
2013 }
2014
2015 /**
2016 Appends 1 buffer to another buffer. This will re-allocate the destination buffer
2017 if necessary to fit all of the data.
2018
2019 If DestinationBuffer is NULL, then ASSERT().
2020
2021 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.
2022 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.
2023 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.
2024 @param[in] SourceSize The number of bytes of SourceBuffer to append.
2025
2026 @retval NULL A memory allocation failed.
2027 @retval NULL A parameter was invalid.
2028 @return A pointer to (*DestinationBuffer).
2029 **/
2030 VOID*
2031 EFIAPI
2032 BuffernCatGrow (
2033 IN OUT VOID **DestinationBuffer,
2034 IN OUT UINTN *DestinationSize,
2035 IN VOID *SourceBuffer,
2036 IN UINTN SourceSize
2037 )
2038 {
2039 UINTN LocalDestinationSize;
2040 UINTN LocalDestinationFinalSize;
2041
2042 ASSERT(DestinationBuffer != NULL);
2043
2044 if (SourceSize == 0 || SourceBuffer == NULL) {
2045 return (*DestinationBuffer);
2046 }
2047
2048 if (DestinationSize == NULL) {
2049 LocalDestinationSize = 0;
2050 } else {
2051 LocalDestinationSize = *DestinationSize;
2052 }
2053
2054 LocalDestinationFinalSize = LocalDestinationSize + SourceSize;
2055
2056 if (DestinationSize != NULL) {
2057 *DestinationSize = LocalDestinationSize;
2058 }
2059
2060 if (LocalDestinationSize == 0) {
2061 // allcoate
2062 *DestinationBuffer = AllocateZeroPool(LocalDestinationFinalSize);
2063 } else {
2064 // reallocate
2065 *DestinationBuffer = ReallocatePool(LocalDestinationSize, LocalDestinationFinalSize, *DestinationBuffer);
2066 }
2067
2068 ASSERT(*DestinationBuffer != NULL);
2069
2070 // copy
2071 return (CopyMem(((UINT8*)(*DestinationBuffer)) + LocalDestinationSize, SourceBuffer, SourceSize));
2072 }
2073
2074 /**
2075 Gets handles for any child devices produced by the passed in driver.
2076
2077 @param[in] DriverHandle The handle of the driver.
2078 @param[in] MatchingHandleCount Pointer to the number of handles in
2079 MatchingHandleBuffer on return.
2080 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
2081 return.
2082 @retval EFI_SUCCESS The operation was sucessful.
2083 @sa ParseHandleDatabaseByRelationship
2084 **/
2085 EFI_STATUS
2086 EFIAPI
2087 ParseHandleDatabaseForChildDevices(
2088 IN CONST EFI_HANDLE DriverHandle,
2089 IN UINTN *MatchingHandleCount,
2090 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
2091 )
2092 {
2093 EFI_HANDLE *Buffer;
2094 EFI_HANDLE *Buffer2;
2095 UINTN Count1;
2096 UINTN Count2;
2097 UINTN HandleIndex;
2098 EFI_STATUS Status;
2099 UINTN HandleBufferSize;
2100
2101 ASSERT(MatchingHandleCount != NULL);
2102
2103 HandleBufferSize = 0;
2104 Buffer = NULL;
2105 Buffer2 = NULL;
2106 *MatchingHandleCount = 0;
2107
2108 Status = PARSE_HANDLE_DATABASE_DEVICES (
2109 DriverHandle,
2110 &Count1,
2111 &Buffer
2112 );
2113 if (!EFI_ERROR (Status)) {
2114 for (HandleIndex = 0; HandleIndex < Count1; HandleIndex++) {
2115 //
2116 // now find the children
2117 //
2118 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
2119 DriverHandle,
2120 Buffer[HandleIndex],
2121 &Count2,
2122 &Buffer2
2123 );
2124 if (EFI_ERROR(Status)) {
2125 break;
2126 }
2127 //
2128 // save out required and optional data elements
2129 //
2130 *MatchingHandleCount += Count2;
2131 if (MatchingHandleBuffer != NULL) {
2132 *MatchingHandleBuffer = BuffernCatGrow((VOID**)MatchingHandleBuffer, &HandleBufferSize, Buffer2, Count2 * sizeof(Buffer2[0]));
2133 }
2134
2135 //
2136 // free the memory
2137 //
2138 if (Buffer2 != NULL) {
2139 FreePool(Buffer2);
2140 }
2141 }
2142 }
2143
2144 if (Buffer != NULL) {
2145 FreePool(Buffer);
2146 }
2147 return (Status);
2148 }
2149
2150 /**
2151 Function to get all handles that support a given protocol or all handles.
2152
2153 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL
2154 then the function will return all handles.
2155
2156 @retval NULL A memory allocation failed.
2157 @return A NULL terminated list of handles.
2158 **/
2159 EFI_HANDLE*
2160 EFIAPI
2161 GetHandleListByProtocol (
2162 IN CONST EFI_GUID *ProtocolGuid OPTIONAL
2163 )
2164 {
2165 EFI_HANDLE *HandleList;
2166 UINTN Size;
2167 EFI_STATUS Status;
2168
2169 Size = 0;
2170 HandleList = NULL;
2171
2172 //
2173 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!
2174 //
2175 if (ProtocolGuid == NULL) {
2176 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);
2177 if (Status == EFI_BUFFER_TOO_SMALL) {
2178 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));
2179 if (HandleList == NULL) {
2180 return (NULL);
2181 }
2182 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);
2183 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;
2184 }
2185 } else {
2186 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);
2187 if (Status == EFI_BUFFER_TOO_SMALL) {
2188 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));
2189 if (HandleList == NULL) {
2190 return (NULL);
2191 }
2192 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);
2193 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;
2194 }
2195 }
2196 if (EFI_ERROR(Status)) {
2197 if (HandleList != NULL) {
2198 FreePool(HandleList);
2199 }
2200 return (NULL);
2201 }
2202 return (HandleList);
2203 }
2204
2205 /**
2206 Function to get all handles that support some protocols.
2207
2208 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.
2209
2210 @retval NULL A memory allocation failed.
2211 @retval NULL ProtocolGuids was NULL.
2212 @return A NULL terminated list of EFI_HANDLEs.
2213 **/
2214 EFI_HANDLE*
2215 EFIAPI
2216 GetHandleListByProtocolList (
2217 IN CONST EFI_GUID **ProtocolGuids
2218 )
2219 {
2220 EFI_HANDLE *HandleList;
2221 UINTN Size;
2222 UINTN TotalSize;
2223 UINTN TempSize;
2224 EFI_STATUS Status;
2225 CONST EFI_GUID **GuidWalker;
2226 EFI_HANDLE *HandleWalker1;
2227 EFI_HANDLE *HandleWalker2;
2228
2229 Size = 0;
2230 HandleList = NULL;
2231 TotalSize = sizeof(EFI_HANDLE);
2232
2233 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++,Size = 0){
2234 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &Size, NULL);
2235 if (Status == EFI_BUFFER_TOO_SMALL) {
2236 TotalSize += Size;
2237 }
2238 }
2239
2240 //
2241 // No handles were found...
2242 //
2243 if (TotalSize == sizeof(EFI_HANDLE)) {
2244 return (NULL);
2245 }
2246
2247 HandleList = AllocateZeroPool(TotalSize);
2248 if (HandleList == NULL) {
2249 return (NULL);
2250 }
2251
2252 Size = 0;
2253 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++){
2254 TempSize = TotalSize - Size;
2255 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &TempSize, HandleList+(Size/sizeof(EFI_HANDLE)));
2256
2257 //
2258 // Allow for missing protocols... Only update the 'used' size upon success.
2259 //
2260 if (!EFI_ERROR(Status)) {
2261 Size += TempSize;
2262 }
2263 }
2264 ASSERT(HandleList[(TotalSize/sizeof(EFI_HANDLE))-1] == NULL);
2265
2266 for (HandleWalker1 = HandleList ; HandleWalker1 != NULL && *HandleWalker1 != NULL ; HandleWalker1++) {
2267 for (HandleWalker2 = HandleWalker1 + 1; HandleWalker2 != NULL && *HandleWalker2 != NULL ; HandleWalker2++) {
2268 if (*HandleWalker1 == *HandleWalker2) {
2269 //
2270 // copy memory back 1 handle width.
2271 //
2272 CopyMem(HandleWalker2, HandleWalker2 + 1, TotalSize - ((HandleWalker2-HandleList+1)*sizeof(EFI_HANDLE)));
2273 }
2274 }
2275 }
2276
2277 return (HandleList);
2278 }
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
EFI Development Kit II mirror for PVE