2 Main file for DrvCfg shell Driver1 function.
4 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2010 - 2016, 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
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.
16 #include "UefiShellDriver1CommandsLib.h"
17 #include <Protocol/HiiConfigAccess.h>
18 #include <Protocol/HiiDatabase.h>
20 STATIC CONST EFI_GUID
*CfgGuidList
[] = {&gEfiDriverConfigurationProtocolGuid
, &gEfiDriverConfiguration2ProtocolGuid
, NULL
};
23 Find the EFI_HII_HANDLE by device path.
25 @param[in] DevPath1 The Device Path to match.
26 @param[out] HiiHandle The EFI_HII_HANDLE after the converstion.
27 @param[in] HiiDb The Hii database protocol
29 @retval EFI_SUCCESS The operation was successful.
30 @retval EFI_NOT_FOUND There was no EFI_HII_HANDLE found for that deviec path.
34 FindHiiHandleViaDevPath(
35 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevPath1
,
36 OUT EFI_HII_HANDLE
*HiiHandle
,
37 IN EFI_HII_DATABASE_PROTOCOL
*HiiDb
40 EFI_HII_HANDLE
*HandleBuffer
;
41 UINTN HandleBufferSize
;
44 EFI_HII_PACKAGE_LIST_HEADER
*PackageListHeader
;
45 EFI_HII_PACKAGE_HEADER
*PackageHeader
;
47 EFI_DEVICE_PATH_PROTOCOL
*DevPath2
;
50 ASSERT(DevPath1
!= NULL
);
51 ASSERT(HiiHandle
!= NULL
);
52 ASSERT(*HiiHandle
== NULL
);
53 ASSERT(HiiDb
!= NULL
);
57 Status
= HiiDb
->ListPackageLists(HiiDb
, EFI_HII_PACKAGE_DEVICE_PATH
, NULL
, &HandleBufferSize
, HandleBuffer
);
58 if (Status
== EFI_BUFFER_TOO_SMALL
) {
59 HandleBuffer
= AllocateZeroPool(HandleBufferSize
);
60 if (HandleBuffer
== NULL
) {
61 Status
= EFI_OUT_OF_RESOURCES
;
63 Status
= HiiDb
->ListPackageLists (HiiDb
, EFI_HII_PACKAGE_DEVICE_PATH
, NULL
, &HandleBufferSize
, HandleBuffer
);
66 if (EFI_ERROR(Status
)) {
67 SHELL_FREE_NON_NULL(HandleBuffer
);
71 if (HandleBuffer
== NULL
) {
75 for (LoopVariable
= 0 ; LoopVariable
< (HandleBufferSize
/sizeof(HandleBuffer
[0])) && *HiiHandle
== NULL
; LoopVariable
++) {
78 Status
= HiiDb
->ExportPackageLists(HiiDb
, HandleBuffer
[LoopVariable
], &MainBufferSize
, MainBuffer
);
79 if (Status
== EFI_BUFFER_TOO_SMALL
) {
80 MainBuffer
= AllocateZeroPool(MainBufferSize
);
81 if (MainBuffer
!= NULL
) {
82 Status
= HiiDb
->ExportPackageLists (HiiDb
, HandleBuffer
[LoopVariable
], &MainBufferSize
, MainBuffer
);
85 if (EFI_ERROR (Status
)) {
89 // Enumerate through the block of returned memory.
90 // This should actually be a small block, but we need to be sure.
92 for (PackageListHeader
= (EFI_HII_PACKAGE_LIST_HEADER
*)MainBuffer
93 ; PackageListHeader
!= NULL
&& ((CHAR8
*)PackageListHeader
) < (((CHAR8
*)MainBuffer
)+MainBufferSize
) && *HiiHandle
== NULL
94 ; PackageListHeader
= (EFI_HII_PACKAGE_LIST_HEADER
*)(((CHAR8
*)(PackageListHeader
)) + PackageListHeader
->PackageLength
)) {
95 for (PackageHeader
= (EFI_HII_PACKAGE_HEADER
*)(((CHAR8
*)(PackageListHeader
))+sizeof(EFI_HII_PACKAGE_LIST_HEADER
))
96 ; PackageHeader
!= NULL
&& ((CHAR8
*)PackageHeader
) < (((CHAR8
*)MainBuffer
)+MainBufferSize
) && PackageHeader
->Type
!= EFI_HII_PACKAGE_END
&& *HiiHandle
== NULL
97 ; PackageHeader
= (EFI_HII_PACKAGE_HEADER
*)(((CHAR8
*)(PackageHeader
))+PackageHeader
->Length
)) {
98 if (PackageHeader
->Type
== EFI_HII_PACKAGE_DEVICE_PATH
) {
99 DevPath2
= (EFI_DEVICE_PATH_PROTOCOL
*)(((CHAR8
*)PackageHeader
) + sizeof(EFI_HII_PACKAGE_HEADER
));
100 if (DevicePathCompare(&DevPath1
, &DevPath2
) == 0) {
101 *HiiHandle
= HandleBuffer
[LoopVariable
];
107 SHELL_FREE_NON_NULL(MainBuffer
);
109 SHELL_FREE_NON_NULL(HandleBuffer
);
111 if (*HiiHandle
== NULL
) {
112 return (EFI_NOT_FOUND
);
114 return (EFI_SUCCESS
);
118 Convert a EFI_HANDLE to a EFI_HII_HANDLE.
120 @param[in] Handle The EFI_HANDLE to convert.
121 @param[out] HiiHandle The EFI_HII_HANDLE after the converstion.
122 @param[in] HiiDb The Hii database protocol
124 @retval EFI_SUCCESS The operation was successful.
128 ConvertHandleToHiiHandle(
129 IN CONST EFI_HANDLE Handle
,
130 OUT EFI_HII_HANDLE
*HiiHandle
,
131 IN EFI_HII_DATABASE_PROTOCOL
*HiiDb
135 EFI_DEVICE_PATH_PROTOCOL
*DevPath1
;
137 if (HiiHandle
== NULL
|| HiiDb
== NULL
) {
138 return (EFI_INVALID_PARAMETER
);
142 if (Handle
== NULL
) {
143 return (EFI_SUCCESS
);
147 Status
= gBS
->OpenProtocol(Handle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&DevPath1
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
148 if (EFI_ERROR(Status
) || DevPath1
== NULL
) {
149 return (EFI_NOT_FOUND
);
152 return (FindHiiHandleViaDevPath(DevPath1
, HiiHandle
, HiiDb
));
156 Function to print out all HII configuration information to a file.
158 @param[in] Handle The handle to get info on. NULL to do all handles.
159 @param[in] FileName The filename to rwite the info to.
164 IN CONST EFI_HANDLE Handle
,
165 IN CONST CHAR16
*FileName
168 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
171 UINTN MainBufferSize
;
172 EFI_HII_HANDLE HiiHandle
;
173 SHELL_FILE_HANDLE FileHandle
;
180 Status
= ShellOpenFileByName(FileName
, &FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, 0);
181 if (EFI_ERROR(Status
)) {
186 STRING_TOKEN(STR_GEN_FILE_OPEN_FAIL
),
187 gShellDriver1HiiHandle
,
191 return (SHELL_DEVICE_ERROR
);
195 // Locate HII Database protocol
197 Status
= gBS
->LocateProtocol (
198 &gEfiHiiDatabaseProtocolGuid
,
200 (VOID
**) &HiiDatabase
203 if (EFI_ERROR(Status
) || HiiDatabase
== NULL
) {
208 STRING_TOKEN(STR_GEN_PROTOCOL_NF
),
209 gShellDriver1HiiHandle
,
211 L
"EfiHiiDatabaseProtocol",
212 &gEfiHiiDatabaseProtocolGuid
);
213 ShellCloseFile(&FileHandle
);
214 return (SHELL_NOT_FOUND
);
218 Status
= ConvertHandleToHiiHandle(Handle
, &HiiHandle
, HiiDatabase
);
219 if (EFI_ERROR(Status
)) {
224 STRING_TOKEN(STR_GEN_HANDLE_NOT
),
225 gShellDriver1HiiHandle
,
227 ConvertHandleToHandleIndex(Handle
),
229 ShellCloseFile(&FileHandle
);
230 return (SHELL_DEVICE_ERROR
);
233 Status
= HiiDatabase
->ExportPackageLists(HiiDatabase
, HiiHandle
, &MainBufferSize
, MainBuffer
);
234 if (Status
== EFI_BUFFER_TOO_SMALL
) {
235 MainBuffer
= AllocateZeroPool(MainBufferSize
);
236 Status
= HiiDatabase
->ExportPackageLists(HiiDatabase
, HiiHandle
, &MainBufferSize
, MainBuffer
);
239 Status
= ShellWriteFile(FileHandle
, &MainBufferSize
, MainBuffer
);
241 ShellCloseFile(&FileHandle
);
242 SHELL_FREE_NON_NULL(MainBuffer
);
244 if (EFI_ERROR(Status
)) {
249 STRING_TOKEN(STR_FILE_WRITE_FAIL
),
250 gShellDriver1HiiHandle
,
253 return (SHELL_DEVICE_ERROR
);
259 STRING_TOKEN(STR_DRVCFG_COMP
),
260 gShellDriver1HiiHandle
);
262 return (SHELL_SUCCESS
);
266 Function to read in HII configuration information from a file.
268 @param[in] Handle The handle to get info for.
269 @param[in] FileName The filename to read the info from.
274 IN EFI_HANDLE Handle
,
275 IN CONST CHAR16
*FileName
278 EFI_HII_DATABASE_PROTOCOL
*HiiDatabase
;
282 UINTN MainBufferSize
;
283 EFI_HII_HANDLE HiiHandle
;
284 SHELL_FILE_HANDLE FileHandle
;
285 CHAR16
*TempDevPathString
;
286 EFI_HII_PACKAGE_LIST_HEADER
*PackageListHeader
;
287 EFI_HII_PACKAGE_HEADER
*PackageHeader
;
288 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
296 Status
= ShellOpenFileByName(FileName
, &FileHandle
, EFI_FILE_MODE_READ
, 0);
297 if (EFI_ERROR(Status
)) {
302 STRING_TOKEN(STR_GEN_FILE_OPEN_FAIL
),
303 gShellDriver1HiiHandle
,
307 return (SHELL_DEVICE_ERROR
);
311 // Locate HII Database protocol
313 Status
= gBS
->LocateProtocol (
314 &gEfiHiiDatabaseProtocolGuid
,
316 (VOID
**) &HiiDatabase
319 if (EFI_ERROR(Status
) || HiiDatabase
== NULL
) {
324 STRING_TOKEN(STR_GEN_PROTOCOL_NF
),
325 gShellDriver1HiiHandle
,
327 L
"EfiHiiDatabaseProtocol",
328 &gEfiHiiDatabaseProtocolGuid
);
329 ShellCloseFile(&FileHandle
);
330 return (SHELL_NOT_FOUND
);
333 Status
= ShellGetFileSize(FileHandle
, &Temp
);
334 MainBufferSize
= (UINTN
)Temp
;
335 if (EFI_ERROR(Status
)) {
340 STRING_TOKEN(STR_FILE_READ_FAIL
),
341 gShellDriver1HiiHandle
,
345 ShellCloseFile(&FileHandle
);
346 return (SHELL_DEVICE_ERROR
);
348 MainBuffer
= AllocateZeroPool((UINTN
)MainBufferSize
);
349 if (EFI_ERROR(Status
)) {
354 STRING_TOKEN(STR_GEN_OUT_MEM
),
355 gShellDriver1HiiHandle
, L
"drvcfg");
356 ShellCloseFile(&FileHandle
);
357 return (SHELL_DEVICE_ERROR
);
359 Status
= ShellReadFile(FileHandle
, &MainBufferSize
, MainBuffer
);
360 if (EFI_ERROR(Status
)) {
365 STRING_TOKEN(STR_FILE_READ_FAIL
),
366 gShellDriver1HiiHandle
,
370 ShellCloseFile(&FileHandle
);
371 SHELL_FREE_NON_NULL(MainBuffer
);
372 return (SHELL_DEVICE_ERROR
);
375 ShellCloseFile(&FileHandle
);
377 if (Handle
!= NULL
) {
379 // User override in place. Just do it.
382 Status
= ConvertHandleToHiiHandle(Handle
, &HiiHandle
, HiiDatabase
);
383 if (EFI_ERROR(Status
)) {
388 STRING_TOKEN(STR_GEN_HANDLE_NOT
),
389 gShellDriver1HiiHandle
, L
"drvcfg",
390 ConvertHandleToHandleIndex(Handle
),
392 ShellCloseFile(&FileHandle
);
393 return (SHELL_DEVICE_ERROR
);
395 Status
= HiiDatabase
->UpdatePackageList(HiiDatabase
, HiiHandle
, MainBuffer
);
396 if (EFI_ERROR(Status
)) {
401 STRING_TOKEN(STR_GEN_UEFI_FUNC_WARN
),
402 gShellDriver1HiiHandle
,
404 L
"HiiDatabase->UpdatePackageList",
406 return (SHELL_DEVICE_ERROR
);
410 // we need to parse the buffer and try to match the device paths for each item to try to find it's device path.
413 for (PackageListHeader
= (EFI_HII_PACKAGE_LIST_HEADER
*)MainBuffer
414 ; PackageListHeader
!= NULL
&& ((CHAR8
*)PackageListHeader
) < (((CHAR8
*)MainBuffer
)+MainBufferSize
)
415 ; PackageListHeader
= (EFI_HII_PACKAGE_LIST_HEADER
*)(((CHAR8
*)(PackageListHeader
)) + PackageListHeader
->PackageLength
)) {
416 for (PackageHeader
= (EFI_HII_PACKAGE_HEADER
*)(((CHAR8
*)(PackageListHeader
))+sizeof(EFI_HII_PACKAGE_LIST_HEADER
))
417 ; PackageHeader
!= NULL
&& ((CHAR8
*)PackageHeader
) < (((CHAR8
*)MainBuffer
)+MainBufferSize
) && PackageHeader
->Type
!= EFI_HII_PACKAGE_END
418 ; PackageHeader
= (EFI_HII_PACKAGE_HEADER
*)(((CHAR8
*)(PackageHeader
))+PackageHeader
->Length
)) {
419 if (PackageHeader
->Type
== EFI_HII_PACKAGE_DEVICE_PATH
) {
421 Status
= FindHiiHandleViaDevPath((EFI_DEVICE_PATH_PROTOCOL
*)(((CHAR8
*)PackageHeader
) + sizeof(EFI_HII_PACKAGE_HEADER
)), &HiiHandle
, HiiDatabase
);
422 if (EFI_ERROR(Status
)) {
424 // print out an error.
426 TempDevPathString
= ConvertDevicePathToText((EFI_DEVICE_PATH_PROTOCOL
*)(((CHAR8
*)PackageHeader
) + sizeof(EFI_HII_PACKAGE_HEADER
)), TRUE
, TRUE
);
431 STRING_TOKEN(STR_DRVCFG_IN_FILE_NF
),
432 gShellDriver1HiiHandle
,
434 SHELL_FREE_NON_NULL(TempDevPathString
);
436 Status
= HiiDatabase
->UpdatePackageList(HiiDatabase
, HiiHandle
, PackageListHeader
);
437 if (EFI_ERROR(Status
)) {
442 STRING_TOKEN(STR_GEN_UEFI_FUNC_WARN
),
443 gShellDriver1HiiHandle
,
445 L
"HiiDatabase->UpdatePackageList",
447 return (SHELL_DEVICE_ERROR
);
449 DevPath
= (EFI_DEVICE_PATH_PROTOCOL
*)(((CHAR8
*)PackageHeader
) + sizeof(EFI_HII_PACKAGE_HEADER
));
450 gBS
->LocateDevicePath(&gEfiHiiConfigAccessProtocolGuid
, &DevPath
, &Handle
);
451 HandleIndex
= ConvertHandleToHandleIndex(Handle
);
456 STRING_TOKEN(STR_DRVCFG_DONE_HII
),
457 gShellDriver1HiiHandle
,
466 SHELL_FREE_NON_NULL(MainBuffer
);
473 STRING_TOKEN(STR_DRVCFG_COMP
),
474 gShellDriver1HiiHandle
);
475 return (SHELL_SUCCESS
);
479 Present a requested action to the user.
481 @param[in] DriverImageHandle The handle for the driver to configure.
482 @param[in] ControllerHandle The handle of the device being managed by the Driver specified.
483 @param[in] ChildHandle The handle of a child device of the specified device.
484 @param[in] ActionRequired The required HII action.
486 @retval SHELL_INVALID_PARAMETER A parameter has a invalid value.
490 ShellCmdDriverConfigurationProcessActionRequired (
491 EFI_HANDLE DriverImageHandle
,
492 EFI_HANDLE ControllerHandle
,
493 EFI_HANDLE ChildHandle
,
494 EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED ActionRequired
497 EFI_HANDLE ConnectControllerContextOverride
[2];
499 switch (ActionRequired
) {
500 case EfiDriverConfigurationActionNone
:
501 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_NONE
), gShellDriver1HiiHandle
);
504 case EfiDriverConfigurationActionStopController
:
505 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_STOP
), gShellDriver1HiiHandle
);
506 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_ENTER_S
), gShellDriver1HiiHandle
, L
"stop controller");
507 ShellPromptForResponse(ShellPromptResponseTypeEnterContinue
, NULL
, NULL
);
509 gBS
->DisconnectController (ControllerHandle
, DriverImageHandle
, ChildHandle
);
510 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_CTLR_S
), gShellDriver1HiiHandle
, L
"stopped");
513 case EfiDriverConfigurationActionRestartController
:
514 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_RESTART_S
), gShellDriver1HiiHandle
, L
"controller");
515 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_ENTER_S
), gShellDriver1HiiHandle
, L
"restart controller");
516 ShellPromptForResponse(ShellPromptResponseTypeEnterContinue
, NULL
, NULL
);
518 gBS
->DisconnectController (ControllerHandle
, DriverImageHandle
, ChildHandle
);
519 ConnectControllerContextOverride
[0] = DriverImageHandle
;
520 ConnectControllerContextOverride
[1] = NULL
;
521 gBS
->ConnectController (ControllerHandle
, ConnectControllerContextOverride
, NULL
, TRUE
);
522 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_CTLR_S
), gShellDriver1HiiHandle
, L
"restarted");
525 case EfiDriverConfigurationActionRestartPlatform
:
526 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_RESTART_S
), gShellDriver1HiiHandle
, L
"platform");
527 ShellPrintHiiEx(-1,-1,NULL
,STRING_TOKEN (STR_DRVCFG_ENTER_S
), gShellDriver1HiiHandle
, L
"restart platform");
528 ShellPromptForResponse(ShellPromptResponseTypeEnterContinue
, NULL
, NULL
);
530 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
534 return (EFI_INVALID_PARAMETER
);
541 Do the configuration in an environment without HII.
543 @param[in] Language The language code.
544 @param[in] ForceDefaults TRUE to force defaults, FALSE otherwise.
545 @param[in] DefaultType If ForceDefaults is TRUE, specifies the default type.
546 @param[in] AllChildren TRUE to configure all children, FALSE otherwise.
547 @param[in] ValidateOptions TRUE to validate existing options, FALSE otherwise.
548 @param[in] SetOptions TRUE to set options, FALSE otherwise.
549 @param[in] DriverImageHandle The handle for the driver to configure.
550 @param[in] DeviceHandle The handle of the device being managed by the Driver specified.
551 @param[in] ChildHandle The handle of a child device of the specified device.
553 @retval SHELL_NOT_FOUND A specified handle could not be found.
554 @retval SHELL_INVALID_PARAMETER A parameter has a invalid value.
559 IN CONST CHAR8
*Language
,
560 IN BOOLEAN ForceDefaults
,
561 IN UINT32 DefaultType
,
562 IN BOOLEAN AllChildren
,
563 IN BOOLEAN ValidateOptions
,
564 IN BOOLEAN SetOptions
,
565 IN EFI_HANDLE DriverImageHandle
,
566 IN EFI_HANDLE DeviceHandle
,
567 IN EFI_HANDLE ChildHandle
571 SHELL_STATUS ShellStatus
;
572 UINTN OuterLoopCounter
;
574 UINTN DriverImageHandleCount
;
575 EFI_HANDLE
*DriverImageHandleBuffer
;
577 EFI_HANDLE
*HandleBuffer
;
581 UINTN ChildHandleCount
;
582 EFI_HANDLE
*ChildHandleBuffer
;
583 UINTN
*ChildHandleType
;
584 EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED ActionRequired
;
585 EFI_DRIVER_CONFIGURATION_PROTOCOL
*DriverConfiguration
;
586 BOOLEAN Iso639Language
;
591 ShellStatus
= SHELL_SUCCESS
;
593 if (ChildHandle
== NULL
&& AllChildren
) {
602 STRING_TOKEN (STR_DRVCFG_FORCE_D
),
603 gShellDriver1HiiHandle
,
605 } else if (ValidateOptions
) {
610 STRING_TOKEN (STR_DRVCFG_VALIDATE
),
611 gShellDriver1HiiHandle
);
612 } else if (SetOptions
) {
617 STRING_TOKEN (STR_DRVCFG_SET
),
618 gShellDriver1HiiHandle
);
621 if (DriverImageHandle
== 0) {
622 DriverImageHandleBuffer
= GetHandleListByProtocolList(CfgGuidList
);
623 if (DriverImageHandleBuffer
== NULL
) {
624 ShellStatus
= SHELL_NOT_FOUND
;
628 HandleBuffer
= DriverImageHandleBuffer
, DriverImageHandleCount
= 0
629 ; HandleBuffer
!= NULL
&& *HandleBuffer
!= NULL
630 ; HandleBuffer
++,DriverImageHandleCount
++);
632 DriverImageHandleCount
= 1;
634 // Allocate buffer to hold the image handle so as to
635 // keep consistent with the above clause
637 DriverImageHandleBuffer
= AllocatePool (sizeof (EFI_HANDLE
));
638 ASSERT (DriverImageHandleBuffer
);
639 DriverImageHandleBuffer
[0] = DriverImageHandle
;
642 for (OuterLoopCounter
= 0; OuterLoopCounter
< DriverImageHandleCount
; OuterLoopCounter
++) {
643 Iso639Language
= FALSE
;
644 Status
= gBS
->OpenProtocol (
645 DriverImageHandleBuffer
[OuterLoopCounter
],
646 &gEfiDriverConfiguration2ProtocolGuid
,
647 (VOID
**) &DriverConfiguration
,
650 EFI_OPEN_PROTOCOL_GET_PROTOCOL
652 if (EFI_ERROR (Status
)) {
653 Iso639Language
= TRUE
;
654 Status
= gBS
->OpenProtocol (
655 DriverImageHandleBuffer
[OuterLoopCounter
],
656 &gEfiDriverConfigurationProtocolGuid
,
657 (VOID
**) &DriverConfiguration
,
660 EFI_OPEN_PROTOCOL_GET_PROTOCOL
663 if (EFI_ERROR (Status
)) {
668 // STRING_TOKEN (STR_DRVCFG_NOT_SUPPORT),
669 // gShellDriver1HiiHandle,
670 // ConvertHandleToHandleIndex (DriverImageHandleBuffer[OuterLoopCounter])
672 ShellStatus
= SHELL_UNSUPPORTED
;
676 BestLanguage
= GetBestLanguage (
677 DriverConfiguration
->SupportedLanguages
,
679 Language
!=NULL
?Language
:"",
680 DriverConfiguration
->SupportedLanguages
,
683 if (BestLanguage
== NULL
) {
688 STRING_TOKEN (STR_GEN_NO_VALUE
),
689 gShellDriver1HiiHandle
,
693 ShellStatus
= SHELL_INVALID_PARAMETER
;
697 Status
= ParseHandleDatabaseByRelationshipWithType (
698 DriverImageHandleBuffer
[OuterLoopCounter
],
704 if (EFI_ERROR (Status
)) {
708 if (SetOptions
&& DeviceHandle
== NULL
) {
710 gST
->ConOut
->ClearScreen (gST
->ConOut
);
711 Status
= DriverConfiguration
->SetOptions (
718 gST
->ConOut
->ClearScreen (gST
->ConOut
);
724 STRING_TOKEN (STR_DRVCFG_ALL_LANG
),
725 gShellDriver1HiiHandle
,
726 ConvertHandleToHandleIndex (DriverImageHandleBuffer
[OuterLoopCounter
]),
727 DriverConfiguration
->SupportedLanguages
729 if (!EFI_ERROR (Status
)) {
734 STRING_TOKEN (STR_DRVCFG_OPTIONS_SET
),
735 gShellDriver1HiiHandle
);
736 for (LoopCounter
= 0; LoopCounter
< HandleCount
; LoopCounter
++) {
737 if ((HandleType
[LoopCounter
] & HR_CONTROLLER_HANDLE
) == HR_CONTROLLER_HANDLE
) {
738 ShellCmdDriverConfigurationProcessActionRequired (
739 DriverImageHandleBuffer
[OuterLoopCounter
],
740 HandleBuffer
[LoopCounter
],
751 STRING_TOKEN (STR_DRVCFG_NOT_SET
),
752 gShellDriver1HiiHandle
,
758 for (LoopCounter
= 0; LoopCounter
< HandleCount
; LoopCounter
++) {
759 if ((HandleType
[LoopCounter
] & HR_CONTROLLER_HANDLE
) != HR_CONTROLLER_HANDLE
) {
762 if (DeviceHandle
!= NULL
&& DeviceHandle
!= HandleBuffer
[LoopCounter
]) {
765 if (ChildHandle
== NULL
) {
766 HandleIndex1
= ConvertHandleToHandleIndex (DriverImageHandleBuffer
[OuterLoopCounter
]);
767 HandleIndex2
= ConvertHandleToHandleIndex (HandleBuffer
[LoopCounter
]);
772 STRING_TOKEN (STR_DRVCFG_CTRL_LANG
),
773 gShellDriver1HiiHandle
,
776 DriverConfiguration
->SupportedLanguages
780 Status
= DriverConfiguration
->ForceDefaults (
782 HandleBuffer
[LoopCounter
],
788 if (!EFI_ERROR (Status
)) {
793 STRING_TOKEN (STR_DRVCFG_DEF_FORCED
),
794 gShellDriver1HiiHandle
);
795 ShellCmdDriverConfigurationProcessActionRequired (
796 DriverImageHandleBuffer
[OuterLoopCounter
],
797 HandleBuffer
[LoopCounter
],
806 STRING_TOKEN (STR_DRVCFG_FORCE_FAILED
),
807 gShellDriver1HiiHandle
,
809 ShellStatus
= SHELL_DEVICE_ERROR
;
811 } else if (ValidateOptions
) {
812 Status
= DriverConfiguration
->OptionsValid (
814 HandleBuffer
[LoopCounter
],
818 if (!EFI_ERROR (Status
)) {
823 STRING_TOKEN (STR_DRVCFG_OPTIONS_VALID
),
824 gShellDriver1HiiHandle
);
830 STRING_TOKEN (STR_DRVCFG_OPTIONS_INV
),
831 gShellDriver1HiiHandle
,
833 ShellStatus
= SHELL_DEVICE_ERROR
;
835 } else if (SetOptions
) {
836 gST
->ConOut
->ClearScreen (gST
->ConOut
);
837 Status
= DriverConfiguration
->SetOptions (
839 HandleBuffer
[LoopCounter
],
844 gST
->ConOut
->ClearScreen (gST
->ConOut
);
845 HandleIndex1
= ConvertHandleToHandleIndex (DriverImageHandleBuffer
[OuterLoopCounter
]);
846 HandleIndex2
= ConvertHandleToHandleIndex (HandleBuffer
[LoopCounter
]);
851 STRING_TOKEN (STR_DRVCFG_CTRL_LANG
),
852 gShellDriver1HiiHandle
,
855 DriverConfiguration
->SupportedLanguages
857 if (!EFI_ERROR (Status
)) {
862 STRING_TOKEN (STR_DRVCFG_OPTIONS_SET
),
863 gShellDriver1HiiHandle
);
865 ShellCmdDriverConfigurationProcessActionRequired (
866 DriverImageHandleBuffer
[OuterLoopCounter
],
867 HandleBuffer
[LoopCounter
],
877 STRING_TOKEN (STR_DRVCFG_NOT_SET
),
878 gShellDriver1HiiHandle
,
880 ShellStatus
= SHELL_DEVICE_ERROR
;
887 if (ChildHandle
== NULL
&& !AllChildren
) {
891 Status
= ParseHandleDatabaseByRelationshipWithType (
892 DriverImageHandleBuffer
[OuterLoopCounter
],
893 HandleBuffer
[LoopCounter
],
898 if (EFI_ERROR (Status
)) {
902 for (ChildIndex
= 0; ChildIndex
< ChildHandleCount
; ChildIndex
++) {
904 if ((ChildHandleType
[ChildIndex
] & HR_CHILD_HANDLE
) != HR_CHILD_HANDLE
) {
908 if (ChildHandle
!= NULL
&& ChildHandle
!= ChildHandleBuffer
[ChildIndex
]) {
912 HandleIndex1
= ConvertHandleToHandleIndex (DriverImageHandleBuffer
[OuterLoopCounter
]);
913 HandleIndex2
= ConvertHandleToHandleIndex (HandleBuffer
[LoopCounter
]);
914 HandleIndex3
= ConvertHandleToHandleIndex (ChildHandleBuffer
[ChildIndex
]);
919 STRING_TOKEN (STR_DRVCFG_CHILD_LANG
),
920 gShellDriver1HiiHandle
,
924 DriverConfiguration
->SupportedLanguages
);
927 Status
= DriverConfiguration
->ForceDefaults (
929 HandleBuffer
[LoopCounter
],
930 ChildHandleBuffer
[ChildIndex
],
935 if (!EFI_ERROR (Status
)) {
940 STRING_TOKEN (STR_DRVCFG_DEF_FORCED
),
941 gShellDriver1HiiHandle
);
943 ShellCmdDriverConfigurationProcessActionRequired (
944 DriverImageHandleBuffer
[OuterLoopCounter
],
945 HandleBuffer
[LoopCounter
],
946 ChildHandleBuffer
[ChildIndex
],
955 STRING_TOKEN (STR_DRVCFG_FORCE_FAILED
),
956 gShellDriver1HiiHandle
,
958 ShellStatus
= SHELL_DEVICE_ERROR
;
960 } else if (ValidateOptions
) {
961 Status
= DriverConfiguration
->OptionsValid (
963 HandleBuffer
[LoopCounter
],
964 ChildHandleBuffer
[ChildIndex
]
967 if (!EFI_ERROR (Status
)) {
972 STRING_TOKEN (STR_DRVCFG_OPTIONS_VALID
),
973 gShellDriver1HiiHandle
);
979 STRING_TOKEN (STR_DRVCFG_OPTIONS_INV
),
980 gShellDriver1HiiHandle
,
982 ShellStatus
= SHELL_DEVICE_ERROR
;
984 } else if (SetOptions
) {
985 gST
->ConOut
->ClearScreen (gST
->ConOut
);
986 Status
= DriverConfiguration
->SetOptions (
988 HandleBuffer
[LoopCounter
],
989 ChildHandleBuffer
[ChildIndex
],
993 gST
->ConOut
->ClearScreen (gST
->ConOut
);
994 HandleIndex1
= ConvertHandleToHandleIndex (DriverImageHandleBuffer
[OuterLoopCounter
]);
995 HandleIndex2
= ConvertHandleToHandleIndex (HandleBuffer
[LoopCounter
]);
996 HandleIndex3
= ConvertHandleToHandleIndex (ChildHandleBuffer
[ChildIndex
]);
1001 STRING_TOKEN (STR_DRVCFG_CHILD_LANG
),
1002 gShellDriver1HiiHandle
,
1006 DriverConfiguration
->SupportedLanguages
1008 if (!EFI_ERROR (Status
)) {
1013 STRING_TOKEN (STR_DRVCFG_OPTIONS_SET
),
1014 gShellDriver1HiiHandle
);
1016 ShellCmdDriverConfigurationProcessActionRequired (
1017 DriverImageHandleBuffer
[OuterLoopCounter
],
1018 HandleBuffer
[LoopCounter
],
1019 ChildHandleBuffer
[ChildIndex
],
1028 STRING_TOKEN (STR_DRVCFG_NOT_SET
),
1029 gShellDriver1HiiHandle
,
1031 ShellStatus
= SHELL_DEVICE_ERROR
;
1038 FreePool (ChildHandleBuffer
);
1039 FreePool (ChildHandleType
);
1042 FreePool (BestLanguage
);
1043 FreePool (HandleBuffer
);
1044 FreePool (HandleType
);
1047 if (DriverImageHandle
!= NULL
&& DriverImageHandleCount
!= 0) {
1048 FreePool (DriverImageHandleBuffer
);
1056 Function to print out configuration information on all configurable handles.
1058 @param[in] ChildrenToo TRUE to tewst for children.
1059 @param[in] Language ASCII string for language code.
1060 @param[in] UseHii TRUE to check for Hii and DPC, FALSE for DCP only.
1062 @retval SHELL_SUCCESS The operation was successful.
1066 PrintConfigInfoOnAll(
1067 IN CONST BOOLEAN ChildrenToo
,
1068 IN CONST CHAR8
*Language
,
1069 IN CONST BOOLEAN UseHii
1072 EFI_HANDLE
*HandleList
;
1073 EFI_HANDLE
*CurrentHandle
;
1080 CurrentHandle
= NULL
;
1086 HandleList
= GetHandleListByProtocol(&gEfiHiiConfigAccessProtocolGuid
);
1087 for (CurrentHandle
= HandleList
; CurrentHandle
!= NULL
&& *CurrentHandle
!= NULL
; CurrentHandle
++){
1089 Index2
= *CurrentHandle
== NULL
? 0 : ConvertHandleToHandleIndex(*CurrentHandle
);
1094 STRING_TOKEN (STR_DRVCFG_LINE_HII
),
1095 gShellDriver1HiiHandle
,
1099 SHELL_FREE_NON_NULL(HandleList
);
1111 0) == SHELL_SUCCESS
) {
1116 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_DRVCFG_NONE_FOUND
), gShellDriver1HiiHandle
);
1117 return (SHELL_SUCCESS
);
1120 return (SHELL_SUCCESS
);
1123 STATIC CONST SHELL_PARAM_ITEM ParamListHii
[] = {
1131 STATIC CONST SHELL_PARAM_ITEM ParamListPreHii
[] = {
1141 Function for 'drvcfg' command.
1143 @param[in] ImageHandle Handle to the Image (NULL if Internal).
1144 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
1148 ShellCommandRunDrvCfg (
1149 IN EFI_HANDLE ImageHandle
,
1150 IN EFI_SYSTEM_TABLE
*SystemTable
1154 LIST_ENTRY
*Package
;
1155 CHAR16
*ProblemParam
;
1156 SHELL_STATUS ShellStatus
;
1159 CONST CHAR16
*HandleIndex1
;
1160 CONST CHAR16
*HandleIndex2
;
1161 CONST CHAR16
*HandleIndex3
;
1162 CONST CHAR16
*ForceTypeString
;
1168 BOOLEAN AllChildren
;
1171 UINT64 Intermediate
;
1175 CONST CHAR16
*FileName
;
1177 ShellStatus
= SHELL_SUCCESS
;
1178 Status
= EFI_SUCCESS
;
1181 ProblemParam
= NULL
;
1184 // initialize the shell lib (we must be in non-auto-init...)
1186 Status
= ShellInitialize();
1187 ASSERT_EFI_ERROR(Status
);
1189 Status
= CommandInit();
1190 ASSERT_EFI_ERROR(Status
);
1193 // parse the command line
1195 Status
= ShellCommandLineParse (ParamListHii
, &Package
, &ProblemParam
, TRUE
);
1196 if (EFI_ERROR(Status
) || ShellCommandLineGetCount(Package
) > 2) {
1198 if (Package
!= NULL
) {
1199 ShellCommandLineFreeVarList (Package
);
1201 SHELL_FREE_NON_NULL(ProblemParam
);
1202 Status
= ShellCommandLineParse (ParamListPreHii
, &Package
, &ProblemParam
, TRUE
);
1203 if (EFI_ERROR(Status
)) {
1204 if (Status
== EFI_VOLUME_CORRUPTED
&& ProblemParam
!= NULL
) {
1205 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), gShellDriver1HiiHandle
, L
"drvcfg", ProblemParam
);
1206 FreePool(ProblemParam
);
1207 ShellStatus
= SHELL_INVALID_PARAMETER
;
1214 if (ShellStatus
== SHELL_SUCCESS
) {
1215 Lang
= ShellCommandLineGetValue(Package
, L
"-l");
1217 Language
= AllocateZeroPool(StrSize(Lang
));
1218 AsciiSPrint(Language
, StrSize(Lang
), "%S", Lang
);
1219 } else if (ShellCommandLineGetFlag(Package
, L
"-l")){
1220 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"drvcfg", L
"-l");
1221 ShellStatus
= SHELL_INVALID_PARAMETER
;
1224 Set
= ShellCommandLineGetFlag (Package
, L
"-s");
1225 Validate
= ShellCommandLineGetFlag (Package
, L
"-v");
1226 InFromFile
= ShellCommandLineGetFlag (Package
, L
"-i");
1227 OutToFile
= ShellCommandLineGetFlag (Package
, L
"-o");
1228 AllChildren
= ShellCommandLineGetFlag (Package
, L
"-c");
1229 Force
= ShellCommandLineGetFlag (Package
, L
"-f");
1230 ForceTypeString
= ShellCommandLineGetValue(Package
, L
"-f");
1233 FileName
= ShellCommandLineGetValue(Package
, L
"-o");
1234 } else if (InFromFile
) {
1235 FileName
= ShellCommandLineGetValue(Package
, L
"-i");
1240 if (InFromFile
&& EFI_ERROR(ShellFileExists(FileName
))) {
1241 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FIND_FAIL
), gShellDriver1HiiHandle
, L
"drvcfg", FileName
);
1242 ShellStatus
= SHELL_INVALID_PARAMETER
;
1245 if (OutToFile
&& !EFI_ERROR(ShellFileExists(FileName
))) {
1246 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_EXIST
), gShellDriver1HiiHandle
, L
"drvcfg", FileName
);
1247 ShellStatus
= SHELL_INVALID_PARAMETER
;
1250 if (Force
&& ForceTypeString
== NULL
) {
1251 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"drvcfg", L
"-f");
1252 ShellStatus
= SHELL_INVALID_PARAMETER
;
1256 Status
= ShellConvertStringToUint64(ForceTypeString
, &Intermediate
, FALSE
, FALSE
);
1257 if (EFI_ERROR(Status
)) {
1258 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM_VAL
), gShellDriver1HiiHandle
, L
"drvcfg", ForceTypeString
, L
"-f");
1259 ShellStatus
= SHELL_INVALID_PARAMETER
;
1262 ForceType
= (UINT32
)Intermediate
;
1266 HandleIndex1
= ShellCommandLineGetRawValue(Package
, 1);
1268 if (HandleIndex1
!= NULL
&& !EFI_ERROR(ShellConvertStringToUint64(HandleIndex1
, &Intermediate
, TRUE
, FALSE
))) {
1269 Handle1
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
1270 if (Handle1
== NULL
|| (UINT64
)(UINTN
)Intermediate
!= Intermediate
) {
1271 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_INV_HANDLE
), gShellDriver1HiiHandle
, L
"drvcfg", HandleIndex1
);
1272 ShellStatus
= SHELL_INVALID_PARAMETER
;
1276 HandleIndex2
= ShellCommandLineGetRawValue(Package
, 2);
1278 if (HandleIndex2
!= NULL
&& !EFI_ERROR(ShellConvertStringToUint64(HandleIndex2
, &Intermediate
, TRUE
, FALSE
))) {
1279 Handle2
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
1280 if (Handle2
== NULL
|| (UINT64
)(UINTN
)Intermediate
!= Intermediate
) {
1281 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_INV_HANDLE
), gShellDriver1HiiHandle
, L
"drvcfg", HandleIndex2
);
1282 ShellStatus
= SHELL_INVALID_PARAMETER
;
1286 HandleIndex3
= ShellCommandLineGetRawValue(Package
, 3);
1288 if (HandleIndex3
!= NULL
&& !EFI_ERROR(ShellConvertStringToUint64(HandleIndex3
, &Intermediate
, TRUE
, FALSE
))) {
1289 Handle3
= ConvertHandleIndexToHandle((UINTN
)Intermediate
);
1290 if (Handle3
== NULL
|| (UINT64
)(UINTN
)Intermediate
!= Intermediate
) {
1291 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_INV_HANDLE
), gShellDriver1HiiHandle
, L
"drvcfg", HandleIndex3
);
1292 ShellStatus
= SHELL_INVALID_PARAMETER
;
1297 if ((InFromFile
|| OutToFile
) && (FileName
== NULL
)) {
1298 if (FileName
== NULL
) {
1299 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_NO_VALUE
), gShellDriver1HiiHandle
, L
"drvcfg", InFromFile
?L
"-i":L
"-o");
1301 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_HANDLE_REQ
), gShellDriver1HiiHandle
, L
"drvcfg");
1303 ShellStatus
= SHELL_INVALID_PARAMETER
;
1306 if (!UseHii
&& (InFromFile
|| OutToFile
)) {
1308 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
), gShellDriver1HiiHandle
, L
"drvcfg", L
"-i");
1309 ShellStatus
= SHELL_INVALID_PARAMETER
;
1313 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
), gShellDriver1HiiHandle
, L
"drvcfg", L
"-o");
1314 ShellStatus
= SHELL_INVALID_PARAMETER
;
1318 if (Validate
&& Force
) {
1319 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CONFLICT
), gShellDriver1HiiHandle
, L
"drvcfg", L
"-v", L
"-f");
1320 ShellStatus
= SHELL_INVALID_PARAMETER
;
1323 if (Validate
&& Set
) {
1324 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CONFLICT
), gShellDriver1HiiHandle
, L
"drvcfg", L
"-v", L
"-s");
1325 ShellStatus
= SHELL_INVALID_PARAMETER
;
1329 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CONFLICT
), gShellDriver1HiiHandle
, L
"drvcfg", L
"-s", L
"-f");
1330 ShellStatus
= SHELL_INVALID_PARAMETER
;
1333 if (OutToFile
&& InFromFile
) {
1334 ShellPrintHiiEx(-1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_CONFLICT
), gShellDriver1HiiHandle
, L
"drvcfg", L
"-i", L
"-o");
1335 ShellStatus
= SHELL_INVALID_PARAMETER
;
1343 if (Handle1
!= NULL
&& EFI_ERROR(gBS
->OpenProtocol(Handle1
, &gEfiHiiConfigAccessProtocolGuid
, NULL
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
1345 // no HII on this handle.
1347 ShellStatus
= SHELL_UNSUPPORTED
;
1348 } else if (Validate
) {
1351 } else if (InFromFile
) {
1352 ShellStatus
= ConfigFromFile(Handle1
, FileName
);
1353 if (Handle1
!= NULL
&& ShellStatus
== SHELL_SUCCESS
) {
1356 } else if (OutToFile
) {
1357 ShellStatus
= ConfigToFile(Handle1
, FileName
);
1358 if (Handle1
!= NULL
&& ShellStatus
== SHELL_SUCCESS
) {
1361 } else if (HandleIndex1
== NULL
) {
1363 // display all that are configurable
1365 ShellStatus
= PrintConfigInfoOnAll(AllChildren
, Language
, UseHii
);
1368 if (!EFI_ERROR(gBS
->OpenProtocol(Handle1
, &gEfiHiiConfigAccessProtocolGuid
, NULL
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_TEST_PROTOCOL
))) {
1373 STRING_TOKEN (STR_DRVCFG_LINE_HII
),
1374 gShellDriver1HiiHandle
,
1375 ConvertHandleToHandleIndex(Handle1
)
1383 // We allways need to do this one since it does both by default.
1385 if (!InFromFile
&& !OutToFile
) {
1386 ShellStatus
= PreHiiDrvCfg (
1398 if (ShellStatus
== SHELL_UNSUPPORTED
) {
1403 STRING_TOKEN (STR_DRVCFG_NOT_SUPPORT
),
1404 gShellDriver1HiiHandle
,
1405 ConvertHandleToHandleIndex(Handle1
)
1411 ShellCommandLineFreeVarList (Package
);
1412 SHELL_FREE_NON_NULL(Language
);
1413 return (ShellStatus
);