2 Main file for Dh shell Driver1 function.
4 Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "UefiShellDriver1CommandsLib.h"
17 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
21 {L
"-verbose", TypeFlag
},
27 STATIC CONST EFI_GUID
*UefiDriverModelProtocolsGuidArray
[] = {
28 &gEfiDriverBindingProtocolGuid
,
29 &gEfiPlatformDriverOverrideProtocolGuid
,
30 &gEfiBusSpecificDriverOverrideProtocolGuid
,
31 &gEfiDriverDiagnosticsProtocolGuid
,
32 &gEfiDriverDiagnostics2ProtocolGuid
,
33 &gEfiComponentNameProtocolGuid
,
34 &gEfiComponentName2ProtocolGuid
,
35 &gEfiPlatformToDriverConfigurationProtocolGuid
,
36 &gEfiDriverSupportedEfiVersionProtocolGuid
,
37 &gEfiDriverFamilyOverrideProtocolGuid
,
38 &gEfiDriverHealthProtocolGuid
,
39 &gEfiLoadedImageProtocolGuid
,
44 Get the name of a driver by it's handle.
46 If a name is found the memory must be callee freed.
48 @param[in] TheHandle The driver's handle.
49 @param[in] Language The language to use.
50 @param[in] NameFound Upon a successful return the name found.
52 @retval EFI_SUCCESS The name was found.
57 IN EFI_HANDLE TheHandle
,
58 IN CONST CHAR8
*Language
,
65 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
68 // Go through those handles until we get one that passes for GetComponentName
70 Status
= gBS
->OpenProtocol(
72 &gEfiComponentName2ProtocolGuid
,
76 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
77 if (EFI_ERROR(Status
)) {
78 Status
= gBS
->OpenProtocol(
80 &gEfiComponentNameProtocolGuid
,
84 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
87 if (EFI_ERROR(Status
)) {
88 return (EFI_NOT_FOUND
);
90 if (Language
== NULL
) {
91 Lang
= AllocateZeroPool(AsciiStrSize(CompName2
->SupportedLanguages
));
93 return (EFI_OUT_OF_RESOURCES
);
95 AsciiStrCpy(Lang
, CompName2
->SupportedLanguages
);
96 TempChar
= AsciiStrStr(Lang
, ";");
97 if (TempChar
!= NULL
){
98 *TempChar
= CHAR_NULL
;
101 Lang
= AllocateZeroPool(AsciiStrSize(Language
));
103 return (EFI_OUT_OF_RESOURCES
);
105 AsciiStrCpy(Lang
, Language
);
107 Status
= CompName2
->GetDriverName(CompName2
, Lang
, &NameToReturn
);
110 if (!EFI_ERROR(Status
) && NameToReturn
!= NULL
) {
112 StrnCatGrow(NameFound
, NULL
, NameToReturn
, 0);
118 Discover if a protocol guid is one of the UEFI Driver Model Protocols.
120 @param[in] Guid The guid to test.
122 @retval TRUE The guid does represent a driver model protocol.
123 @retval FALSE The guid does not represent a driver model protocol.
128 IN CONST EFI_GUID
*Guid
131 CONST EFI_GUID
**GuidWalker
;
134 for (GuidWalker
= UefiDriverModelProtocolsGuidArray
135 ; GuidWalker
!= NULL
&& *GuidWalker
!= NULL
138 if (CompareGuid(*GuidWalker
, Guid
)) {
147 Get information for a handle.
149 @param[in] TheHandle The handles to show info on.
150 @param[in] Language Language string per UEFI specification.
151 @param[in] Seperator Separator string between information blocks.
152 @param[in] Verbose TRUE for extra info, FALSE otherwise.
153 @param[in] ExtraInfo TRUE for extra info, FALSE otherwise.
155 @retval SHELL_SUCCESS The operation was successful.
156 @retval SHELL_INVALID_PARAMETER ProtocolName was NULL or invalid.
160 GetProtocolInfoString(
161 IN CONST EFI_HANDLE TheHandle
,
162 IN CONST CHAR8
*Language
,
163 IN CONST CHAR16
*Seperator
,
164 IN CONST BOOLEAN Verbose
,
165 IN CONST BOOLEAN ExtraInfo
168 EFI_GUID
**ProtocolGuidArray
;
176 ProtocolGuidArray
= NULL
;
180 Status
= gBS
->ProtocolsPerHandle (
185 if (!EFI_ERROR (Status
)) {
186 for (ProtocolIndex
= 0; ProtocolIndex
< ArrayCount
; ProtocolIndex
++) {
187 Temp
= GetStringNameFromGuid(ProtocolGuidArray
[ProtocolIndex
], Language
);
189 ASSERT((RetVal
== NULL
&& Size
== 0) || (RetVal
!= NULL
));
191 StrnCatGrow(&RetVal
, &Size
, Seperator
, 0);
193 StrnCatGrow(&RetVal
, &Size
, L
"%H", 0);
194 StrnCatGrow(&RetVal
, &Size
, Temp
, 0);
195 StrnCatGrow(&RetVal
, &Size
, L
"%N", 0);
199 Temp
= GetProtocolInformationDump(TheHandle
, ProtocolGuidArray
[ProtocolIndex
], Verbose
);
201 ASSERT((RetVal
== NULL
&& Size
== 0) || (RetVal
!= NULL
));
203 StrnCatGrow(&RetVal
, &Size
, L
"(", 0);
204 StrnCatGrow(&RetVal
, &Size
, Temp
, 0);
205 StrnCatGrow(&RetVal
, &Size
, L
")\r\n", 0);
207 StrnCatGrow(&RetVal
, &Size
, Seperator
, 0);
208 StrnCatGrow(&RetVal
, &Size
, Temp
, 0);
216 SHELL_FREE_NON_NULL(ProtocolGuidArray
);
218 if (RetVal
== NULL
) {
222 ASSERT((RetVal
== NULL
&& Size
== 0) || (RetVal
!= NULL
));
223 StrnCatGrow(&RetVal
, &Size
, Seperator
, 0);
228 Gets the name of the loaded image.
230 @param[in] TheHandle The handle of the driver to get info on.
231 @param[out] Name The pointer to the pointer. Valid upon a successful return.
233 @retval EFI_SUCCESS The operation was successful.
238 IN EFI_HANDLE TheHandle
,
242 // get loaded image and devicepathtotext on image->Filepath
243 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
245 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
247 if (TheHandle
== NULL
|| Name
== NULL
) {
248 return (EFI_INVALID_PARAMETER
);
251 Status
= gBS
->OpenProtocol (
253 &gEfiLoadedImageProtocolGuid
,
254 (VOID
**) &LoadedImage
,
257 EFI_OPEN_PROTOCOL_GET_PROTOCOL
259 if (EFI_ERROR(Status
)) {
262 DevicePath
= LoadedImage
->FilePath
;
263 *Name
= gDevPathToText
->ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
264 return (EFI_SUCCESS
);
268 Display driver model information for a given handle.
270 @param[in] Handle The handle to display info on.
271 @param[in] BestName Use the best name?
272 @param[in] Language The language to output in.
276 DisplayDriverModelHandle (
277 IN EFI_HANDLE Handle
,
279 IN CONST CHAR8
*Language OPTIONAL
283 BOOLEAN ConfigurationStatus
;
284 BOOLEAN DiagnosticsStatus
;
285 UINTN DriverBindingHandleCount
;
286 EFI_HANDLE
*DriverBindingHandleBuffer
;
287 UINTN ParentControllerHandleCount
;
288 EFI_HANDLE
*ParentControllerHandleBuffer
;
289 UINTN ChildControllerHandleCount
;
290 EFI_HANDLE
*ChildControllerHandleBuffer
;
291 CHAR16
*TempStringPointer
;
292 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
295 EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
;
296 UINTN NumberOfChildren
;
298 UINTN ControllerHandleCount
;
299 EFI_HANDLE
*ControllerHandleBuffer
;
304 // See if Handle is a device handle and display its details.
306 DriverBindingHandleBuffer
= NULL
;
307 Status
= PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
309 &DriverBindingHandleCount
,
310 &DriverBindingHandleBuffer
313 ParentControllerHandleBuffer
= NULL
;
314 Status
= PARSE_HANDLE_DATABASE_PARENTS (
316 &ParentControllerHandleCount
,
317 &ParentControllerHandleBuffer
320 ChildControllerHandleBuffer
= NULL
;
321 Status
= ParseHandleDatabaseForChildControllers (
323 &ChildControllerHandleCount
,
324 &ChildControllerHandleBuffer
327 DiagnosticsStatus
= FALSE
;
328 ConfigurationStatus
= FALSE
;
330 if (!EFI_ERROR(gBS
->OpenProtocol(Handle
, &gEfiDriverConfigurationProtocolGuid
, NULL
, NULL
, gImageHandle
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
331 ConfigurationStatus
= TRUE
;
333 if (!EFI_ERROR(gBS
->OpenProtocol(Handle
, &gEfiDriverConfiguration2ProtocolGuid
, NULL
, NULL
, gImageHandle
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
334 ConfigurationStatus
= TRUE
;
336 if (!EFI_ERROR(gBS
->OpenProtocol(Handle
, &gEfiDriverDiagnosticsProtocolGuid
, NULL
, NULL
, gImageHandle
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
337 DiagnosticsStatus
= TRUE
;
339 if (!EFI_ERROR(gBS
->OpenProtocol(Handle
, &gEfiDriverDiagnostics2ProtocolGuid
, NULL
, NULL
, gImageHandle
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
340 DiagnosticsStatus
= TRUE
;
343 Status
= EFI_SUCCESS
;
345 if (DriverBindingHandleCount
> 0 || ParentControllerHandleCount
> 0 || ChildControllerHandleCount
> 0) {
350 TempStringPointer
= NULL
;
351 Status
= gBS
->HandleProtocol (Handle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&DevicePath
);
353 Status
= gEfiShellProtocol
->GetDeviceName(Handle
, EFI_DEVICE_NAME_USE_COMPONENT_NAME
|EFI_DEVICE_NAME_USE_DEVICE_PATH
, (CHAR8
*)Language
, &TempStringPointer
);
354 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DH_OUTPUT_DRIVER1
), gShellDriver1HiiHandle
, TempStringPointer
!=NULL
?TempStringPointer
:L
"<Unknown>");
355 SHELL_FREE_NON_NULL(TempStringPointer
);
357 TempStringPointer
= gDevPathToText
->ConvertDevicePathToText(DevicePath
, TRUE
, FALSE
);
362 STRING_TOKEN (STR_DH_OUTPUT_DRIVER2
),
363 gShellDriver1HiiHandle
,
364 TempStringPointer
!=NULL
?TempStringPointer
:L
"<None>",
365 ParentControllerHandleCount
== 0?L
"ROOT":(ChildControllerHandleCount
> 0)?L
"BUS":L
"DEVICE",
366 ConfigurationStatus
?L
"YES":L
"NO",
367 DiagnosticsStatus
?L
"YES":L
"NO"
370 SHELL_FREE_NON_NULL(TempStringPointer
);
372 if (DriverBindingHandleCount
== 0) {
377 STRING_TOKEN (STR_DH_OUTPUT_DRIVER3
),
378 gShellDriver1HiiHandle
,
386 STRING_TOKEN (STR_DH_OUTPUT_DRIVER3
),
387 gShellDriver1HiiHandle
,
390 for (Index
= 0; Index
< DriverBindingHandleCount
; Index
++) {
392 Status
= GetDriverName (
393 DriverBindingHandleBuffer
[Index
],
397 if (DriverName
== NULL
) {
398 Status
= GetDriverImageName (
399 DriverBindingHandleBuffer
[Index
],
409 STRING_TOKEN (STR_DH_OUTPUT_DRIVER4A
),
410 gShellDriver1HiiHandle
,
411 ConvertHandleToHandleIndex (DriverBindingHandleBuffer
[Index
]),
412 DriverName
!=NULL
?DriverName
:L
"<Unknown>"
419 STRING_TOKEN (STR_DH_OUTPUT_DRIVER4B
),
420 gShellDriver1HiiHandle
,
421 ConvertHandleToHandleIndex (DriverBindingHandleBuffer
[Index
]),
422 DriverName
!=NULL
?DriverName
:L
"<Unknown>"
425 SHELL_FREE_NON_NULL(DriverName
);
429 if (ParentControllerHandleCount
== 0) {
434 STRING_TOKEN (STR_DH_OUTPUT_DRIVER5
),
435 gShellDriver1HiiHandle
,
443 STRING_TOKEN (STR_DH_OUTPUT_DRIVER5
),
444 gShellDriver1HiiHandle
,
447 for (Index
= 0; Index
< ParentControllerHandleCount
; Index
++) {
448 Status
= gEfiShellProtocol
->GetDeviceName(ParentControllerHandleBuffer
[Index
], EFI_DEVICE_NAME_USE_COMPONENT_NAME
|EFI_DEVICE_NAME_USE_DEVICE_PATH
, (CHAR8
*)Language
, &TempStringPointer
);
453 STRING_TOKEN (STR_DH_OUTPUT_DRIVER5B
),
454 gShellDriver1HiiHandle
,
455 ConvertHandleToHandleIndex (ParentControllerHandleBuffer
[Index
]),
456 TempStringPointer
!=NULL
?TempStringPointer
:L
"<Unknown>"
458 SHELL_FREE_NON_NULL(TempStringPointer
);
462 if (ChildControllerHandleCount
== 0) {
467 STRING_TOKEN (STR_DH_OUTPUT_DRIVER6
),
468 gShellDriver1HiiHandle
,
476 STRING_TOKEN (STR_DH_OUTPUT_DRIVER6
),
477 gShellDriver1HiiHandle
,
480 for (Index
= 0; Index
< ChildControllerHandleCount
; Index
++) {
481 Status
= gEfiShellProtocol
->GetDeviceName(ChildControllerHandleBuffer
[Index
], EFI_DEVICE_NAME_USE_COMPONENT_NAME
|EFI_DEVICE_NAME_USE_DEVICE_PATH
, (CHAR8
*)Language
, &TempStringPointer
);
486 STRING_TOKEN (STR_DH_OUTPUT_DRIVER6B
),
487 gShellDriver1HiiHandle
,
488 ConvertHandleToHandleIndex (ChildControllerHandleBuffer
[Index
]),
489 TempStringPointer
!=NULL
?TempStringPointer
:L
"<Unknown>"
491 SHELL_FREE_NON_NULL(TempStringPointer
);
496 SHELL_FREE_NON_NULL(DriverBindingHandleBuffer
);
498 SHELL_FREE_NON_NULL(ParentControllerHandleBuffer
);
500 SHELL_FREE_NON_NULL(ChildControllerHandleBuffer
);
502 if (EFI_ERROR (Status
)) {
506 // See if Handle is a driver binding handle and display its details.
508 Status
= gBS
->OpenProtocol (
510 &gEfiDriverBindingProtocolGuid
,
511 (VOID
**) &DriverBinding
,
514 EFI_OPEN_PROTOCOL_GET_PROTOCOL
516 if (EFI_ERROR (Status
)) {
520 NumberOfChildren
= 0;
521 ControllerHandleBuffer
= NULL
;
522 Status
= PARSE_HANDLE_DATABASE_DEVICES (
524 &ControllerHandleCount
,
525 &ControllerHandleBuffer
527 if (ControllerHandleCount
> 0) {
528 for (HandleIndex
= 0; HandleIndex
< ControllerHandleCount
; HandleIndex
++) {
529 Status
= PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
531 ControllerHandleBuffer
[HandleIndex
],
532 &ChildControllerHandleCount
,
535 NumberOfChildren
+= ChildControllerHandleCount
;
539 Status
= GetDriverName (Handle
, Language
, &DriverName
);
545 STRING_TOKEN (STR_DH_OUTPUT_DRIVER6B
),
546 gShellDriver1HiiHandle
,
547 ConvertHandleToHandleIndex(Handle
),
548 DriverName
!=NULL
?DriverName
:L
"<Unknown>"
550 SHELL_FREE_NON_NULL(DriverName
);
552 Status
= GetDriverImageName (
560 STRING_TOKEN (STR_DH_OUTPUT_DRIVER7B
),
561 gShellDriver1HiiHandle
,
562 DriverName
!=NULL
?DriverName
:L
"<Unknown>"
564 SHELL_FREE_NON_NULL(DriverName
);
570 STRING_TOKEN (STR_DH_OUTPUT_DRIVER8
),
571 gShellDriver1HiiHandle
,
572 DriverBinding
->Version
,
573 NumberOfChildren
> 0?L
"Bus":ControllerHandleCount
> 0?L
"Device":L
"<Unknown>",
574 ConfigurationStatus
?L
"YES":L
"NO",
575 DiagnosticsStatus
?L
"YES":L
"NO"
578 if (ControllerHandleCount
== 0) {
583 STRING_TOKEN (STR_DH_OUTPUT_DRIVER6
),
584 gShellDriver1HiiHandle
,
592 STRING_TOKEN (STR_DH_OUTPUT_DRIVER6
),
593 gShellDriver1HiiHandle
,
596 for (HandleIndex
= 0; HandleIndex
< ControllerHandleCount
; HandleIndex
++) {
597 Status
= gEfiShellProtocol
->GetDeviceName(ControllerHandleBuffer
[HandleIndex
], EFI_DEVICE_NAME_USE_COMPONENT_NAME
|EFI_DEVICE_NAME_USE_DEVICE_PATH
, (CHAR8
*)Language
, &TempStringPointer
);
603 STRING_TOKEN (STR_DH_OUTPUT_DRIVER9B
),
604 gShellDriver1HiiHandle
,
605 ConvertHandleToHandleIndex(ControllerHandleBuffer
[HandleIndex
]),
606 TempStringPointer
!=NULL
?TempStringPointer
:L
"<Unknown>"
608 SHELL_FREE_NON_NULL(TempStringPointer
);
610 Status
= PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
612 ControllerHandleBuffer
[HandleIndex
],
613 &ChildControllerHandleCount
,
614 &ChildControllerHandleBuffer
616 if (!EFI_ERROR (Status
)) {
617 for (ChildIndex
= 0; ChildIndex
< ChildControllerHandleCount
; ChildIndex
++) {
618 Status
= gEfiShellProtocol
->GetDeviceName(ChildControllerHandleBuffer
[ChildIndex
], EFI_DEVICE_NAME_USE_COMPONENT_NAME
|EFI_DEVICE_NAME_USE_DEVICE_PATH
, (CHAR8
*)Language
, &TempStringPointer
);
624 STRING_TOKEN (STR_DH_OUTPUT_DRIVER6B
),
625 gShellDriver1HiiHandle
,
626 ConvertHandleToHandleIndex(ChildControllerHandleBuffer
[ChildIndex
]),
627 TempStringPointer
!=NULL
?TempStringPointer
:L
"<Unknown>"
629 SHELL_FREE_NON_NULL(TempStringPointer
);
632 SHELL_FREE_NON_NULL (ChildControllerHandleBuffer
);
636 SHELL_FREE_NON_NULL (ControllerHandleBuffer
);
643 Display information for a handle.
645 @param[in] TheHandle The handles to show info on.
646 @param[in] Verbose TRUE for extra info, FALSE otherwise.
647 @param[in] Sfo TRUE to output in standard format output (spec).
648 @param[in] Language Language string per UEFI specification.
649 @param[in] DriverInfo TRUE to show all info about the handle.
650 @param[in] Multiple TRUE indicates more than will be output,
651 FALSE for a single one.
653 @retval SHELL_SUCCESS The operation was successful.
654 @retval SHELL_INVALID_PARAMETER ProtocolName was NULL or invalid.
659 IN CONST EFI_HANDLE TheHandle
,
660 IN CONST BOOLEAN Verbose
,
661 IN CONST BOOLEAN Sfo
,
662 IN CONST CHAR8
*Language
,
663 IN CONST BOOLEAN DriverInfo
,
664 IN CONST BOOLEAN Multiple
667 CHAR16
*ProtocolInfoString
;
668 SHELL_STATUS ShellStatus
;
671 Status
= EFI_SUCCESS
;
672 ShellStatus
= SHELL_SUCCESS
;
673 ProtocolInfoString
= NULL
;
677 ProtocolInfoString
= GetProtocolInfoString(TheHandle
, Language
, L
" ", Verbose
, TRUE
);
682 STRING_TOKEN (STR_DH_OUTPUT
),
683 gShellDriver1HiiHandle
,
684 ConvertHandleToHandleIndex(TheHandle
),
685 ProtocolInfoString
==NULL
?L
"":ProtocolInfoString
);
687 ProtocolInfoString
= GetProtocolInfoString(TheHandle
, Language
, L
"\r\n", Verbose
, TRUE
);
692 STRING_TOKEN (STR_DH_OUTPUT_SINGLE
),
693 gShellDriver1HiiHandle
,
694 ConvertHandleToHandleIndex(TheHandle
),
696 ProtocolInfoString
==NULL
?L
"":ProtocolInfoString
);
700 DisplayDriverModelHandle ((EFI_HANDLE
)TheHandle
, TRUE
, Language
);
703 ProtocolInfoString
= GetProtocolInfoString(TheHandle
, Language
, L
";", FALSE
, FALSE
);
708 STRING_TOKEN (STR_DH_OUTPUT_SFO
),
709 gShellDriver1HiiHandle
,
710 Multiple
?L
"HandlesInfo":L
"HandleInfo",
713 ConvertHandleToHandleIndex(TheHandle
),
715 ProtocolInfoString
==NULL
?L
"":ProtocolInfoString
);
721 if (ProtocolInfoString
!= NULL
) {
722 FreePool(ProtocolInfoString
);
724 return (ShellStatus
);
728 Display information for all handles on a list.
730 @param[in] HandleList The NULL-terminated list of handles.
731 @param[in] Verbose TRUE for extra info, FALSE otherwise.
732 @param[in] Sfo TRUE to output in standard format output (spec).
733 @param[in] Language Language string per UEFI specification.
734 @param[in] DriverInfo TRUE to show all info about the handle.
736 @retval SHELL_SUCCESS The operation was successful.
737 @retval SHELL_INVALID_PARAMETER ProtocolName was NULL or invalid.
742 IN CONST EFI_HANDLE
*HandleList
,
743 IN CONST BOOLEAN Verbose
,
744 IN CONST BOOLEAN Sfo
,
745 IN CONST CHAR8
*Language
,
746 IN CONST BOOLEAN DriverInfo
749 CONST EFI_HANDLE
*HandleWalker
;
750 SHELL_STATUS ShellStatus
;
752 ShellStatus
= SHELL_SUCCESS
;
754 for (HandleWalker
= HandleList
; HandleWalker
!= NULL
&& *HandleWalker
!= NULL
&& ShellStatus
== SHELL_SUCCESS
; HandleWalker
++) {
755 ShellStatus
= DoDhByHandle(
764 return (ShellStatus
);
768 Display information for all handles.
770 @param[in] Sfo TRUE to output in standard format output (spec).
771 @param[in] Verbose TRUE for extra info, FALSE otherwise.
772 @param[in] Language Language string per UEFI specification.
773 @param[in] DriverInfo TRUE to show all info about the handle.
775 @retval SHELL_SUCCESS The operation was successful.
776 @retval SHELL_INVALID_PARAMETER ProtocolName was NULL or invalid.
781 IN CONST BOOLEAN Sfo
,
782 IN CONST BOOLEAN Verbose
,
783 IN CONST CHAR8
*Language
,
784 IN CONST BOOLEAN DriverInfo
787 EFI_HANDLE
*HandleList
;
788 SHELL_STATUS ShellStatus
;
790 HandleList
= GetHandleListByProtocol(NULL
);
792 ShellStatus
= DoDhForHandleList(
799 FreePool(HandleList
);
801 return (ShellStatus
);
805 Display information for all handles which have a specific protocol.
807 @param[in] ProtocolName The pointer to the name of the protocol.
808 @param[in] Verbose TRUE for extra info, FALSE otherwise.
809 @param[in] Sfo TRUE to output in standard format output (spec).
810 @param[in] Language Language string per UEFI specification.
811 @param[in] DriverInfo TRUE to show all info about the handle.
813 @retval SHELL_SUCCESS The operation was successful.
814 @retval SHELL_INVALID_PARAMETER ProtocolName was NULL or invalid.
819 IN CONST CHAR16
*ProtocolName
,
820 IN CONST BOOLEAN Verbose
,
821 IN CONST BOOLEAN Sfo
,
822 IN CONST CHAR8
*Language
,
823 IN CONST BOOLEAN DriverInfo
828 EFI_HANDLE
*HandleList
;
829 SHELL_STATUS ShellStatus
;
831 if (ProtocolName
== NULL
) {
832 return (SHELL_INVALID_PARAMETER
);
835 Status
= GetGuidFromStringName(ProtocolName
, Language
, &Guid
);
836 if (EFI_ERROR(Status
)) {
837 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DH_NO_GUID_FOUND
), gShellDriver1HiiHandle
, ProtocolName
);
838 return (SHELL_INVALID_PARAMETER
);
841 HandleList
= GetHandleListByProtocol(Guid
);
843 ShellStatus
= DoDhForHandleList(
850 SHELL_FREE_NON_NULL(HandleList
);
852 return (ShellStatus
);
856 Function for 'dh' command.
858 @param[in] ImageHandle Handle to the Image (NULL if Internal).
859 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
864 IN EFI_HANDLE ImageHandle
,
865 IN EFI_SYSTEM_TABLE
*SystemTable
870 CHAR16
*ProblemParam
;
871 SHELL_STATUS ShellStatus
;
880 ShellStatus
= SHELL_SUCCESS
;
881 Status
= EFI_SUCCESS
;
885 // initialize the shell lib (we must be in non-auto-init...)
887 Status
= ShellInitialize();
888 ASSERT_EFI_ERROR(Status
);
890 Status
= CommandInit();
891 ASSERT_EFI_ERROR(Status
);
894 // parse the command line
896 Status
= ShellCommandLineParse (ParamList
, &Package
, &ProblemParam
, TRUE
);
897 if (EFI_ERROR(Status
)) {
898 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
899 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellDriver1HiiHandle
, ProblemParam
);
900 FreePool(ProblemParam
);
901 ShellStatus
= SHELL_INVALID_PARAMETER
;
906 if (ShellCommandLineGetCount(Package
) > 2) {
907 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellDriver1HiiHandle
);
908 ShellCommandLineFreeVarList (Package
);
909 return (SHELL_INVALID_PARAMETER
);
912 Lang
= ShellCommandLineGetValue(Package
, L
"-l");
914 Language
= AllocateZeroPool(StrSize(Lang
));
915 AsciiSPrint(Language
, StrSize(Lang
), "%S", Lang
);
916 } else if (!ShellCommandLineGetFlag(Package
, L
"-l")){
917 Language
= AllocateZeroPool(10);
918 AsciiSPrint(Language
, 10, "en-us");
920 ASSERT(Language
== NULL
);
921 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"-l");
922 ShellCommandLineFreeVarList (Package
);
923 return (SHELL_INVALID_PARAMETER
);
926 SfoMode
= ShellCommandLineGetFlag(Package
, L
"-sfo");
927 FlagD
= ShellCommandLineGetFlag(Package
, L
"-d");
928 Verbose
= (BOOLEAN
)(ShellCommandLineGetFlag(Package
, L
"-v") || ShellCommandLineGetFlag(Package
, L
"-verbose"));
930 if (ShellCommandLineGetFlag(Package
, L
"-p")) {
931 if (ShellCommandLineGetCount(Package
) > 1) {
932 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
), gShellDriver1HiiHandle
);
933 ShellStatus
= SHELL_INVALID_PARAMETER
;
934 } else if (ShellCommandLineGetValue(Package
, L
"-p") == NULL
) {
935 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"-p");
936 ShellStatus
= SHELL_INVALID_PARAMETER
;
941 ShellStatus
= DoDhByProtocol(
942 ShellCommandLineGetValue(Package
, L
"-p"),
945 Lang
==NULL
?NULL
:Language
,
950 Temp2
= ShellCommandLineGetRawValue(Package
, 1);
955 ShellStatus
= DoDhForAll(
958 Lang
==NULL
?NULL
:Language
,
962 Status
= ShellConvertStringToUint64(Temp2
, &Intermediate
, TRUE
, FALSE
);
963 if (EFI_ERROR(Status
) || ConvertHandleIndexToHandle((UINTN
)Intermediate
) == NULL
) {
964 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_INV_HANDLE
), gShellDriver1HiiHandle
, Temp2
);
965 ShellStatus
= SHELL_INVALID_PARAMETER
;
970 ShellStatus
= DoDhByHandle(
971 ConvertHandleIndexToHandle((UINTN
)Intermediate
),
974 Lang
==NULL
?NULL
:Language
,
983 ShellCommandLineFreeVarList (Package
);
984 SHELL_FREE_NON_NULL(Language
);
987 return (ShellStatus
);