2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 (C) Copyright 2014, Hewlett-Packard Development Company, L.P.
6 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 Close an open file handle.
22 This function closes a specified file handle. All "dirty" cached file data is
23 flushed to the device, and the file is closed. In all cases the handle is
26 @param[in] FileHandle The file handle to close.
28 @retval EFI_SUCCESS The file handle was closed successfully.
33 IN SHELL_FILE_HANDLE FileHandle
36 ShellFileHandleRemove(FileHandle
);
37 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
41 Internal worker to determine whether there is a BlockIo somewhere
42 upon the device path specified.
44 @param[in] DevicePath The device path to test.
46 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
47 @retval FALSE gEfiBlockIoProtocolGuid was not found.
51 InternalShellProtocolIsBlockIoPresent(
52 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
55 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
61 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
62 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
64 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
71 Internal worker to determine whether there is a file system somewhere
72 upon the device path specified.
74 @param[in] DevicePath The device path to test.
76 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
77 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
81 InternalShellProtocolIsSimpleFileSystemPresent(
82 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
85 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
91 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
92 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
94 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
101 Internal worker debug helper function to print out maps as they are added.
103 @param[in] Mapping string mapping that has been added
104 @param[in] DevicePath pointer to device path that has been mapped.
106 @retval EFI_SUCCESS the operation was successful.
107 @return other an error ocurred
114 InternalShellProtocolDebugPrintMessage (
115 IN CONST CHAR16
*Mapping
,
116 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
122 Status
= EFI_SUCCESS
;
125 if (Mapping
!= NULL
) {
126 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
128 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
129 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
137 This function creates a mapping for a device path.
139 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
141 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
142 then the mapping will be deleted.
143 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
145 @retval EFI_SUCCESS Mapping created or deleted successfully.
146 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
147 boot service function LocateDevicePath().
148 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
149 @retval EFI_INVALID_PARAMETER Mapping was NULL
150 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
151 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
152 @retval EFI_NOT_FOUND There was no mapping found to delete
153 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
158 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
159 IN CONST CHAR16
*Mapping
163 SHELL_MAP_LIST
*MapListNode
;
165 if (Mapping
== NULL
){
166 return (EFI_INVALID_PARAMETER
);
169 if (Mapping
[StrLen(Mapping
)-1] != ':') {
170 return (EFI_INVALID_PARAMETER
);
174 // Delete the mapping
176 if (DevicePath
== NULL
) {
177 if (IsListEmpty(&gShellMapList
.Link
)) {
178 return (EFI_NOT_FOUND
);
180 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
181 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
182 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
184 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
185 RemoveEntryList(&MapListNode
->Link
);
186 FreePool(MapListNode
);
187 return (EFI_SUCCESS
);
192 // We didnt find one to delete
194 return (EFI_NOT_FOUND
);
198 // make sure this is a valid to add device path
200 ///@todo add BlockIo to this test...
201 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
202 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
203 return (EFI_INVALID_PARAMETER
);
207 // First make sure there is no old mapping
209 Status
= EfiShellSetMap(NULL
, Mapping
);
210 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
215 // now add the new one.
217 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
223 Gets the device path from the mapping.
225 This function gets the device path associated with a mapping.
227 @param Mapping A pointer to the mapping
229 @retval !=NULL Pointer to the device path that corresponds to the
230 device mapping. The returned pointer does not need
232 @retval NULL There is no device path associated with the
235 CONST EFI_DEVICE_PATH_PROTOCOL
*
237 EfiShellGetDevicePathFromMap(
238 IN CONST CHAR16
*Mapping
241 SHELL_MAP_LIST
*MapListItem
;
248 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
249 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
250 StrnCatGrow(&NewName
, &Size
, L
":", 0);
253 MapListItem
= ShellCommandFindMapItem(NewName
);
257 if (MapListItem
!= NULL
) {
258 return (MapListItem
->DevicePath
);
264 Gets the mapping(s) that most closely matches the device path.
266 This function gets the mapping which corresponds to the device path *DevicePath. If
267 there is no exact match, then the mapping which most closely matches *DevicePath
268 is returned, and *DevicePath is updated to point to the remaining portion of the
269 device path. If there is an exact match, the mapping is returned and *DevicePath
270 points to the end-of-device-path node.
272 If there are multiple map names they will be semi-colon seperated in the
273 NULL-terminated string.
275 @param DevicePath On entry, points to a device path pointer. On
276 exit, updates the pointer to point to the
277 portion of the device path after the mapping.
279 @retval NULL No mapping was found.
280 @return !=NULL Pointer to NULL-terminated mapping. The buffer
281 is callee allocated and should be freed by the caller.
285 EfiShellGetMapFromDevicePath(
286 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
289 SHELL_MAP_LIST
*Node
;
290 CHAR16
*PathForReturn
;
292 // EFI_HANDLE PathHandle;
293 // EFI_HANDLE MapHandle;
294 // EFI_STATUS Status;
295 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
296 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
298 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
302 PathForReturn
= NULL
;
305 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
306 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
307 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
310 // check for exact match
312 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
313 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
315 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
317 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
320 if (PathForReturn
!= NULL
) {
321 while (!IsDevicePathEndType (*DevicePath
)) {
322 *DevicePath
= NextDevicePathNode (*DevicePath
);
324 SetDevicePathEndNode (*DevicePath
);
327 ///@todo finish code for inexact matches.
328 if (PathForReturn == NULL) {
331 DevicePathCopy = DuplicateDevicePath(*DevicePath);
332 ASSERT(DevicePathCopy != NULL);
333 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
334 ASSERT_EFI_ERROR(Status);
336 // check each of the device paths we have to get the root of the path for consist mappings
338 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
339 ; !IsNull(&gShellMapList.Link, &Node->Link)
340 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
342 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
345 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
346 ASSERT(MapPathCopy != NULL);
347 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
348 if (MapHandle == PathHandle) {
350 *DevicePath = DevicePathCopy;
353 DevicePathCopy = NULL;
354 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
355 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
360 // now add on the non-consistent mappings
362 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
363 ; !IsNull(&gShellMapList.Link, &Node->Link)
364 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
366 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
369 MapPathCopy = Node->DevicePath;
370 ASSERT(MapPathCopy != NULL);
371 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
372 if (MapHandle == PathHandle) {
373 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
374 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
381 return (AddBufferToFreeList(PathForReturn
));
385 Converts a device path to a file system-style path.
387 This function converts a device path to a file system path by replacing part, or all, of
388 the device path with the file-system mapping. If there are more than one application
389 file system mappings, the one that most closely matches Path will be used.
391 @param Path The pointer to the device path
393 @retval NULL the device path could not be found.
394 @return all The pointer of the NULL-terminated file path. The path
395 is callee-allocated and should be freed by the caller.
399 EfiShellGetFilePathFromDevicePath(
400 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
403 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
404 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
405 SHELL_MAP_LIST
*MapListItem
;
406 CHAR16
*PathForReturn
;
408 EFI_HANDLE PathHandle
;
409 EFI_HANDLE MapHandle
;
411 FILEPATH_DEVICE_PATH
*FilePath
;
412 FILEPATH_DEVICE_PATH
*AlignedNode
;
414 PathForReturn
= NULL
;
417 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
418 ASSERT(DevicePathCopy
!= NULL
);
419 if (DevicePathCopy
== NULL
) {
423 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
425 if (EFI_ERROR(Status
)) {
429 // check each of the device paths we have to get the root of the path
431 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
432 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
433 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
435 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
436 ASSERT(MapPathCopy
!= NULL
);
438 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
439 if (MapHandle
== PathHandle
) {
440 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
441 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
443 // go through all the remaining nodes in the device path
445 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
446 ; !IsDevicePathEnd (&FilePath
->Header
)
447 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
450 // all the rest should be file path nodes
452 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
453 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
454 FreePool(PathForReturn
);
455 PathForReturn
= NULL
;
459 // append the path part onto the filepath.
461 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
463 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
464 ASSERT (AlignedNode
!= NULL
);
466 // File Path Device Path Nodes 'can optionally add a "\" separator to
467 // the beginning and/or the end of the Path Name string.'
468 // (UEFI Spec 2.4 section 9.3.6.4).
469 // If necessary, add a "\", but otherwise don't
470 // (This is specified in the above section, and also implied by the
471 // UEFI Shell spec section 3.7)
472 if ((PathSize
!= 0) &&
473 (PathForReturn
!= NULL
) &&
474 (PathForReturn
[PathSize
- 1] != L
'\\') &&
475 (AlignedNode
->PathName
[0] != L
'\\')) {
476 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
479 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
480 FreePool(AlignedNode
);
482 } // for loop of remaining nodes
484 if (PathForReturn
!= NULL
) {
487 } // for loop of paths to check
488 return(PathForReturn
);
492 Converts a file system style name to a device path.
494 This function converts a file system style name to a device path, by replacing any
495 mapping references to the associated device path.
497 @param[in] Path The pointer to the path.
499 @return The pointer of the file path. The file path is callee
500 allocated and should be freed by the caller.
501 @retval NULL The path could not be found.
502 @retval NULL There was not enough available memory.
504 EFI_DEVICE_PATH_PROTOCOL
*
506 EfiShellGetDevicePathFromFilePath(
507 IN CONST CHAR16
*Path
514 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
515 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
516 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
517 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
528 if (StrStr(Path
, L
":") == NULL
) {
529 Cwd
= EfiShellGetCurDir(NULL
);
533 Size
= StrSize(Cwd
) + StrSize(Path
) - sizeof(CHAR16
);
534 NewPath
= AllocateZeroPool(Size
);
535 if (NewPath
== NULL
) {
538 StrnCpy(NewPath
, Cwd
, Size
/sizeof(CHAR16
)-1);
539 if (*Path
== L
'\\') {
541 while (PathRemoveLastItem(NewPath
)) ;
543 StrnCat(NewPath
, Path
, Size
/sizeof(CHAR16
) - 1 - StrLen(NewPath
));
544 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
546 return (DevicePathForReturn
);
551 // find the part before (but including) the : for the map name
553 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
554 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
555 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
560 // look up the device path in the map
562 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
563 if (DevicePath
== NULL
) {
565 // Must have been a bad Mapname
571 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
573 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
574 if (DevicePathCopy
== NULL
) {
583 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
584 if (EFI_ERROR(Status
)) {
585 if (DevicePathCopyForFree
!= NULL
) {
586 FreePool(DevicePathCopyForFree
);
593 // build the full device path
595 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
596 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
598 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
602 if (DevicePathCopyForFree
!= NULL
) {
603 FreePool(DevicePathCopyForFree
);
606 return (DevicePathForReturn
);
610 Gets the name of the device specified by the device handle.
612 This function gets the user-readable name of the device specified by the device
613 handle. If no user-readable name could be generated, then *BestDeviceName will be
614 NULL and EFI_NOT_FOUND will be returned.
616 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
617 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
620 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
621 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
622 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
623 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
624 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
626 @param DeviceHandle The handle of the device.
627 @param Flags Determines the possible sources of component names.
629 EFI_DEVICE_NAME_USE_COMPONENT_NAME
630 EFI_DEVICE_NAME_USE_DEVICE_PATH
631 @param Language A pointer to the language specified for the device
632 name, in the same format as described in the UEFI
633 specification, Appendix M
634 @param BestDeviceName On return, points to the callee-allocated NULL-
635 terminated name of the device. If no device name
636 could be found, points to NULL. The name must be
637 freed by the caller...
639 @retval EFI_SUCCESS Get the name successfully.
640 @retval EFI_NOT_FOUND Fail to get the device name.
641 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
642 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
643 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
647 EfiShellGetDeviceName(
648 IN EFI_HANDLE DeviceHandle
,
649 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
651 OUT CHAR16
**BestDeviceName
655 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
656 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
657 EFI_HANDLE
*HandleList
;
660 CHAR16
*DeviceNameToReturn
;
662 UINTN ParentControllerCount
;
663 EFI_HANDLE
*ParentControllerBuffer
;
664 UINTN ParentDriverCount
;
665 EFI_HANDLE
*ParentDriverBuffer
;
667 if (BestDeviceName
== NULL
||
670 return (EFI_INVALID_PARAMETER
);
674 // make sure one of the 2 supported bits is on
676 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
677 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
678 return (EFI_INVALID_PARAMETER
);
681 DeviceNameToReturn
= NULL
;
682 *BestDeviceName
= NULL
;
687 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
688 Status
= ParseHandleDatabaseByRelationship(
691 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
694 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
696 // Go through those handles until we get one that passes for GetComponentName
698 Status
= gBS
->OpenProtocol(
700 &gEfiComponentName2ProtocolGuid
,
704 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
705 if (EFI_ERROR(Status
)) {
706 Status
= gBS
->OpenProtocol(
708 &gEfiComponentNameProtocolGuid
,
712 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
715 if (EFI_ERROR(Status
)) {
718 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
719 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
722 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
726 if (HandleList
!= NULL
) {
727 FreePool(HandleList
);
731 // Now check the parent controller using this as the child.
733 if (DeviceNameToReturn
== NULL
){
734 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
735 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
736 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
737 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
739 // try using that driver's component name with controller and our driver as the child.
741 Status
= gBS
->OpenProtocol(
742 ParentDriverBuffer
[HandleCount
],
743 &gEfiComponentName2ProtocolGuid
,
747 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
748 if (EFI_ERROR(Status
)) {
749 Status
= gBS
->OpenProtocol(
750 ParentDriverBuffer
[HandleCount
],
751 &gEfiComponentNameProtocolGuid
,
755 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
758 if (EFI_ERROR(Status
)) {
761 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
762 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
765 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
772 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
773 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
777 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
780 // dont return on fail since we will try device path if that bit is on
782 if (DeviceNameToReturn
!= NULL
){
783 ASSERT(BestDeviceName
!= NULL
);
784 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
785 return (EFI_SUCCESS
);
788 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
789 Status
= gBS
->OpenProtocol(
791 &gEfiDevicePathProtocolGuid
,
795 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
796 if (!EFI_ERROR(Status
)) {
798 // use device path to text on the device path
800 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
801 return (EFI_SUCCESS
);
805 // none of the selected bits worked.
807 return (EFI_NOT_FOUND
);
811 Opens the root directory of a device on a handle
813 This function opens the root directory of a device and returns a file handle to it.
815 @param DeviceHandle The handle of the device that contains the volume.
816 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
819 @retval EFI_SUCCESS Root opened successfully.
820 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
822 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
823 @retval EFI_DEVICE_ERROR The device had an error
827 EfiShellOpenRootByHandle(
828 IN EFI_HANDLE DeviceHandle
,
829 OUT SHELL_FILE_HANDLE
*FileHandle
833 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
834 EFI_FILE_PROTOCOL
*RealFileHandle
;
835 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
838 // get the simple file system interface
840 Status
= gBS
->OpenProtocol(DeviceHandle
,
841 &gEfiSimpleFileSystemProtocolGuid
,
842 (VOID
**)&SimpleFileSystem
,
845 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
846 if (EFI_ERROR(Status
)) {
847 return (EFI_NOT_FOUND
);
850 Status
= gBS
->OpenProtocol(DeviceHandle
,
851 &gEfiDevicePathProtocolGuid
,
855 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
856 if (EFI_ERROR(Status
)) {
857 return (EFI_NOT_FOUND
);
860 // Open the root volume now...
862 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
863 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
868 Opens the root directory of a device.
870 This function opens the root directory of a device and returns a file handle to it.
872 @param DevicePath Points to the device path corresponding to the device where the
873 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
874 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
877 @retval EFI_SUCCESS Root opened successfully.
878 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
880 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
881 @retval EFI_DEVICE_ERROR The device had an error
882 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
887 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
888 OUT SHELL_FILE_HANDLE
*FileHandle
894 if (FileHandle
== NULL
) {
895 return (EFI_INVALID_PARAMETER
);
899 // find the handle of the device with that device handle and the file system
902 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
905 if (EFI_ERROR(Status
)) {
906 return (EFI_NOT_FOUND
);
909 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
913 Returns whether any script files are currently being processed.
915 @retval TRUE There is at least one script file active.
916 @retval FALSE No script files are active now.
921 EfiShellBatchIsActive (
925 if (ShellCommandGetCurrentScriptFile() == NULL
) {
932 Worker function to open a file based on a device path. this will open the root
933 of the volume and then traverse down to the file itself.
935 @param DevicePath Device Path of the file.
936 @param FileHandle Pointer to the file upon a successful return.
937 @param OpenMode mode to open file in.
938 @param Attributes the File Attributes to use when creating a new file.
940 @retval EFI_SUCCESS the file is open and FileHandle is valid
941 @retval EFI_UNSUPPORTED the device path cotained non-path elements
942 @retval other an error ocurred.
946 InternalOpenFileDevicePath(
947 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
948 OUT SHELL_FILE_HANDLE
*FileHandle
,
950 IN UINT64 Attributes OPTIONAL
954 FILEPATH_DEVICE_PATH
*FilePathNode
;
956 SHELL_FILE_HANDLE ShellHandle
;
957 EFI_FILE_PROTOCOL
*Handle1
;
958 EFI_FILE_PROTOCOL
*Handle2
;
959 FILEPATH_DEVICE_PATH
*AlignedNode
;
961 if (FileHandle
== NULL
) {
962 return (EFI_INVALID_PARAMETER
);
972 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
974 if (!EFI_ERROR(Status
)) {
975 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
976 if (Handle1
!= NULL
) {
978 // chop off the begining part before the file system part...
981 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
984 if (!EFI_ERROR(Status
)) {
986 // To access as a file system, the file path should only
987 // contain file path components. Follow the file path nodes
988 // and find the target file
990 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
991 ; !IsDevicePathEnd (&FilePathNode
->Header
)
992 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
994 SHELL_FREE_NON_NULL(AlignedNode
);
995 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
997 // For file system access each node should be a file path component
999 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
1000 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1002 Status
= EFI_UNSUPPORTED
;
1007 // Open this file path node
1013 // if this is the last node in the DevicePath always create (if that was requested).
1015 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1016 Status
= Handle2
->Open (
1019 AlignedNode
->PathName
,
1026 // This is not the last node and we dont want to 'create' existing
1027 // directory entries...
1031 // open without letting it create
1032 // prevents error on existing files/directories
1034 Status
= Handle2
->Open (
1037 AlignedNode
->PathName
,
1038 OpenMode
&~EFI_FILE_MODE_CREATE
,
1042 // if above failed now open and create the 'item'
1043 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1045 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1046 Status
= Handle2
->Open (
1049 AlignedNode
->PathName
,
1056 // Close the last node
1058 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1061 // If there's been an error, stop
1063 if (EFI_ERROR (Status
)) {
1070 SHELL_FREE_NON_NULL(AlignedNode
);
1071 if (EFI_ERROR(Status
)) {
1072 if (Handle1
!= NULL
) {
1073 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1076 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1082 Creates a file or directory by name.
1084 This function creates an empty new file or directory with the specified attributes and
1085 returns the new file's handle. If the file already exists and is read-only, then
1086 EFI_INVALID_PARAMETER will be returned.
1088 If the file already existed, it is truncated and its attributes updated. If the file is
1089 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1091 If the file name begins with >v, then the file handle which is returned refers to the
1092 shell environment variable with the specified name. If the shell environment variable
1093 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1095 @param FileName Pointer to NULL-terminated file path
1096 @param FileAttribs The new file's attrbiutes. the different attributes are
1097 described in EFI_FILE_PROTOCOL.Open().
1098 @param FileHandle On return, points to the created file handle or directory's handle
1100 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1101 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1102 @retval EFI_UNSUPPORTED could not open the file path
1103 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1104 file the file system on the device.
1105 @retval EFI_NO_MEDIA the device has no medium.
1106 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1108 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1110 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1111 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1112 when the media is write-protected.
1113 @retval EFI_ACCESS_DENIED The service denied access to the file.
1114 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1115 @retval EFI_VOLUME_FULL The volume is full.
1120 IN CONST CHAR16
*FileName
,
1121 IN UINT64 FileAttribs
,
1122 OUT SHELL_FILE_HANDLE
*FileHandle
1125 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1129 // Is this for an environment variable
1130 // do we start with >v
1132 if (StrStr(FileName
, L
">v") == FileName
) {
1133 if (!IsVolatileEnv(FileName
+2)) {
1134 return (EFI_INVALID_PARAMETER
);
1136 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1137 return (EFI_SUCCESS
);
1141 // We are opening a regular file.
1143 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1144 if (DevicePath
== NULL
) {
1145 return (EFI_NOT_FOUND
);
1148 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
);
1149 FreePool(DevicePath
);
1155 Register a GUID and a localized human readable name for it.
1157 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1158 names must be used whenever a shell command outputs GUID information.
1160 This function is only available when the major and minor versions in the
1161 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1163 @param[in] Guid A pointer to the GUID being registered.
1164 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1166 @retval EFI_SUCCESS The operation was successful.
1167 @retval EFI_INVALID_PARAMETER Guid was NULL.
1168 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1169 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1173 EfiShellRegisterGuidName(
1174 IN CONST EFI_GUID
*Guid
,
1175 IN CONST CHAR16
*GuidName
1178 return (AddNewGuidNameMapping(Guid
, GuidName
, NULL
));
1182 Opens a file or a directory by file name.
1184 This function opens the specified file in the specified OpenMode and returns a file
1186 If the file name begins with >v, then the file handle which is returned refers to the
1187 shell environment variable with the specified name. If the shell environment variable
1188 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1189 EFI_INVALID_PARAMETER is returned.
1191 If the file name is >i, then the file handle which is returned refers to the standard
1192 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1195 If the file name is >o, then the file handle which is returned refers to the standard
1196 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1199 If the file name is >e, then the file handle which is returned refers to the standard
1200 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1203 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1204 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1207 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1210 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1211 @param FileHandle On return, points to the file handle.
1212 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1213 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1215 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1216 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1217 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1218 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1219 system could not be found on the device. FileHandle is NULL.
1220 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1221 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1222 longer supported. FileHandle is NULL.
1223 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1224 the FileName. FileHandle is NULL.
1225 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1226 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1227 when the media is write-protected. FileHandle is NULL.
1228 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1229 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1231 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1235 EfiShellOpenFileByName(
1236 IN CONST CHAR16
*FileName
,
1237 OUT SHELL_FILE_HANDLE
*FileHandle
,
1241 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1247 // Is this for StdIn
1249 if (StrCmp(FileName
, L
">i") == 0) {
1251 // make sure not writing to StdIn
1253 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1254 return (EFI_INVALID_PARAMETER
);
1256 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1257 ASSERT(*FileHandle
!= NULL
);
1258 return (EFI_SUCCESS
);
1262 // Is this for StdOut
1264 if (StrCmp(FileName
, L
">o") == 0) {
1266 // make sure not writing to StdIn
1268 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1269 return (EFI_INVALID_PARAMETER
);
1271 *FileHandle
= &FileInterfaceStdOut
;
1272 return (EFI_SUCCESS
);
1276 // Is this for NUL file
1278 if (StrCmp(FileName
, L
"NUL") == 0) {
1279 *FileHandle
= &FileInterfaceNulFile
;
1280 return (EFI_SUCCESS
);
1284 // Is this for StdErr
1286 if (StrCmp(FileName
, L
">e") == 0) {
1288 // make sure not writing to StdIn
1290 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1291 return (EFI_INVALID_PARAMETER
);
1293 *FileHandle
= &FileInterfaceStdErr
;
1294 return (EFI_SUCCESS
);
1298 // Is this for an environment variable
1299 // do we start with >v
1301 if (StrStr(FileName
, L
">v") == FileName
) {
1302 if (!IsVolatileEnv(FileName
+2) &&
1303 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1304 return (EFI_INVALID_PARAMETER
);
1306 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1307 return (EFI_SUCCESS
);
1311 // We are opening a regular file.
1313 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1314 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1315 if (DevicePath
== NULL
) {
1316 return (EFI_NOT_FOUND
);
1320 // Copy the device path, open the file, then free the memory
1322 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1323 FreePool(DevicePath
);
1329 Deletes the file specified by the file name.
1331 This function deletes a file.
1333 @param FileName Points to the NULL-terminated file name.
1335 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1336 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1337 @sa EfiShellCreateFile
1341 EfiShellDeleteFileByName(
1342 IN CONST CHAR16
*FileName
1345 SHELL_FILE_HANDLE FileHandle
;
1351 // get a handle to the file
1353 Status
= EfiShellCreateFile(FileName
,
1356 if (EFI_ERROR(Status
)) {
1360 // now delete the file
1362 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1366 Disables the page break output mode.
1370 EfiShellDisablePageBreak (
1374 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1378 Enables the page break output mode.
1382 EfiShellEnablePageBreak (
1386 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1390 internal worker function to load and run an image via device path.
1392 @param ParentImageHandle A handle of the image that is executing the specified
1394 @param DevicePath device path of the file to execute
1395 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1396 containing the command line. If NULL then the command-
1398 @param Environment Points to a NULL-terminated array of environment
1399 variables with the format 'x=y', where x is the
1400 environment variable name and y is the value. If this
1401 is NULL, then the current shell environment is used.
1403 @param[out] StartImageStatus Returned status from gBS->StartImage.
1405 @retval EFI_SUCCESS The command executed successfully. The status code
1406 returned by the command is pointed to by StatusCode.
1407 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1408 @retval EFI_OUT_OF_RESOURCES Out of resources.
1409 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1413 InternalShellExecuteDevicePath(
1414 IN CONST EFI_HANDLE
*ParentImageHandle
,
1415 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1416 IN CONST CHAR16
*CommandLine OPTIONAL
,
1417 IN CONST CHAR16
**Environment OPTIONAL
,
1418 OUT EFI_STATUS
*StartImageStatus OPTIONAL
1422 EFI_STATUS StartStatus
;
1423 EFI_STATUS CleanupStatus
;
1424 EFI_HANDLE NewHandle
;
1425 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1426 LIST_ENTRY OrigEnvs
;
1427 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1433 if (ParentImageHandle
== NULL
) {
1434 return (EFI_INVALID_PARAMETER
);
1437 InitializeListHead(&OrigEnvs
);
1441 NewCmdLine
= AllocateCopyPool (StrSize (CommandLine
), CommandLine
);
1442 if (NewCmdLine
== NULL
) {
1443 return EFI_OUT_OF_RESOURCES
;
1446 for (Walker
= NewCmdLine
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
1447 if (*Walker
== L
'^' && *(Walker
+1) == L
'#') {
1448 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));
1453 // Load the image with:
1454 // FALSE - not from boot manager and NULL, 0 being not already in memory
1456 Status
= gBS
->LoadImage(
1459 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1464 if (EFI_ERROR(Status
)) {
1465 if (NewHandle
!= NULL
) {
1466 gBS
->UnloadImage(NewHandle
);
1470 Status
= gBS
->OpenProtocol(
1472 &gEfiLoadedImageProtocolGuid
,
1473 (VOID
**)&LoadedImage
,
1476 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1478 if (!EFI_ERROR(Status
)) {
1479 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1480 if (NewCmdLine
!= NULL
) {
1481 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(NewCmdLine
);
1482 LoadedImage
->LoadOptions
= (VOID
*)NewCmdLine
;
1486 // Save our current environment settings for later restoration if necessary
1488 if (Environment
!= NULL
) {
1489 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1490 if (!EFI_ERROR(Status
)) {
1491 Status
= SetEnvironmentVariables(Environment
);
1496 // Initialize and install a shell parameters protocol on the image.
1498 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1499 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1500 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1501 Status
= UpdateArgcArgv(&ShellParamsProtocol
, NewCmdLine
, NULL
, NULL
);
1502 ASSERT_EFI_ERROR(Status
);
1504 // Replace Argv[0] with the full path of the binary we're executing:
1505 // If the command line was "foo", the binary might be called "foo.efi".
1506 // "The first entry in [Argv] is always the full file path of the
1507 // executable" - UEFI Shell Spec section 2.3
1509 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1510 // The image we're executing isn't necessarily in a filesystem - it might
1511 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1512 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1513 if (ImagePath
!= NULL
) {
1514 if (ShellParamsProtocol
.Argv
== NULL
) {
1515 // Command line was empty or null.
1516 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1517 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1518 if (ShellParamsProtocol
.Argv
== NULL
) {
1519 Status
= EFI_OUT_OF_RESOURCES
;
1522 ShellParamsProtocol
.Argc
= 1;
1524 // Free the string UpdateArgcArgv put in Argv[0];
1525 FreePool (ShellParamsProtocol
.Argv
[0]);
1527 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1530 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1531 ASSERT_EFI_ERROR(Status
);
1533 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1536 // now start the image and if the caller wanted the return code pass it to them...
1538 if (!EFI_ERROR(Status
)) {
1539 StartStatus
= gBS
->StartImage(
1544 if (StartImageStatus
!= NULL
) {
1545 *StartImageStatus
= StartStatus
;
1548 CleanupStatus
= gBS
->UninstallProtocolInterface(
1550 &gEfiShellParametersProtocolGuid
,
1551 &ShellParamsProtocol
1553 ASSERT_EFI_ERROR(CleanupStatus
);
1559 // Unload image - We should only get here if we didn't call StartImage
1560 gBS
->UnloadImage (NewHandle
);
1563 // Free Argv (Allocated in UpdateArgcArgv)
1564 if (ShellParamsProtocol
.Argv
!= NULL
) {
1565 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1566 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1567 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1570 FreePool (ShellParamsProtocol
.Argv
);
1574 // Restore environment variables
1575 if (!IsListEmpty(&OrigEnvs
)) {
1576 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1577 ASSERT_EFI_ERROR (CleanupStatus
);
1580 FreePool (NewCmdLine
);
1585 Execute the command line.
1587 This function creates a nested instance of the shell and executes the specified
1588 command (CommandLine) with the specified environment (Environment). Upon return,
1589 the status code returned by the specified command is placed in StatusCode.
1591 If Environment is NULL, then the current environment is used and all changes made
1592 by the commands executed will be reflected in the current environment. If the
1593 Environment is non-NULL, then the changes made will be discarded.
1595 The CommandLine is executed from the current working directory on the current
1598 @param ParentImageHandle A handle of the image that is executing the specified
1600 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1601 containing the command line. If NULL then the command-
1603 @param Environment Points to a NULL-terminated array of environment
1604 variables with the format 'x=y', where x is the
1605 environment variable name and y is the value. If this
1606 is NULL, then the current shell environment is used.
1607 @param StatusCode Points to the status code returned by the command.
1609 @retval EFI_SUCCESS The command executed successfully. The status code
1610 returned by the command is pointed to by StatusCode.
1611 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1612 @retval EFI_OUT_OF_RESOURCES Out of resources.
1613 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1614 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1616 @sa InternalShellExecuteDevicePath
1621 IN EFI_HANDLE
*ParentImageHandle
,
1622 IN CHAR16
*CommandLine OPTIONAL
,
1623 IN CHAR16
**Environment OPTIONAL
,
1624 OUT EFI_STATUS
*StatusCode OPTIONAL
1629 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1632 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1633 return (EFI_UNSUPPORTED
);
1636 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1639 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1641 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1643 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1649 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1650 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1651 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1653 Status
= InternalShellExecuteDevicePath(
1657 (CONST CHAR16
**)Environment
,
1661 // de-allocate and return
1669 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1671 1) frees all pointers (non-NULL)
1672 2) Closes the SHELL_FILE_HANDLE
1674 @param FileListNode pointer to the list node to free
1678 InternalFreeShellFileInfoNode(
1679 IN EFI_SHELL_FILE_INFO
*FileListNode
1682 if (FileListNode
->Info
!= NULL
) {
1683 FreePool((VOID
*)FileListNode
->Info
);
1685 if (FileListNode
->FileName
!= NULL
) {
1686 FreePool((VOID
*)FileListNode
->FileName
);
1688 if (FileListNode
->FullName
!= NULL
) {
1689 FreePool((VOID
*)FileListNode
->FullName
);
1691 if (FileListNode
->Handle
!= NULL
) {
1692 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1694 FreePool(FileListNode
);
1697 Frees the file list.
1699 This function cleans up the file list and any related data structures. It has no
1700 impact on the files themselves.
1702 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1703 defined in OpenFileList()
1705 @retval EFI_SUCCESS Free the file list successfully.
1706 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1710 EfiShellFreeFileList(
1711 IN EFI_SHELL_FILE_INFO
**FileList
1714 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1716 if (FileList
== NULL
|| *FileList
== NULL
) {
1717 return (EFI_INVALID_PARAMETER
);
1720 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1721 ; !IsListEmpty(&(*FileList
)->Link
)
1722 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1724 RemoveEntryList(&ShellFileListItem
->Link
);
1725 InternalFreeShellFileInfoNode(ShellFileListItem
);
1727 InternalFreeShellFileInfoNode(*FileList
);
1729 return(EFI_SUCCESS
);
1733 Deletes the duplicate file names files in the given file list.
1735 This function deletes the reduplicate files in the given file list.
1737 @param FileList A pointer to the first entry in the file list.
1739 @retval EFI_SUCCESS Always success.
1740 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1744 EfiShellRemoveDupInFileList(
1745 IN EFI_SHELL_FILE_INFO
**FileList
1748 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1749 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1750 EFI_SHELL_FILE_INFO
*TempNode
;
1752 if (FileList
== NULL
|| *FileList
== NULL
) {
1753 return (EFI_INVALID_PARAMETER
);
1755 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1756 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1757 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1759 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1760 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1761 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1763 if (gUnicodeCollation
->StriColl(
1765 (CHAR16
*)ShellFileListItem
->FullName
,
1766 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1768 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1770 &ShellFileListItem2
->Link
1772 RemoveEntryList(&ShellFileListItem2
->Link
);
1773 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1774 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1775 // memory in GetNextNode in the loop expression above.
1776 ShellFileListItem2
= TempNode
;
1780 return (EFI_SUCCESS
);
1784 // This is the same structure as the external version, but it has no CONST qualifiers.
1787 LIST_ENTRY Link
; ///< Linked list members.
1788 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1789 CHAR16
*FullName
; ///< Fully qualified filename.
1790 CHAR16
*FileName
; ///< name of this file.
1791 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1792 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1793 } EFI_SHELL_FILE_INFO_NO_CONST
;
1796 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1798 @param[in] Node The node to copy from.
1799 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1801 @retval NULL a memory allocation error ocurred
1802 @return != NULL a pointer to the new node
1804 EFI_SHELL_FILE_INFO
*
1806 InternalDuplicateShellFileInfo(
1807 IN EFI_SHELL_FILE_INFO
*Node
,
1811 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1814 // try to confirm that the objects are in sync
1816 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1818 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1819 if (NewNode
== NULL
) {
1822 NewNode
->FullName
= AllocateCopyPool(StrSize(Node
->FullName
), Node
->FullName
);
1823 NewNode
->FileName
= AllocateCopyPool(StrSize(Node
->FileName
), Node
->FileName
);
1824 NewNode
->Info
= AllocateCopyPool((UINTN
)Node
->Info
->Size
, Node
->Info
);
1825 if ( NewNode
->FullName
== NULL
1826 || NewNode
->FileName
== NULL
1827 || NewNode
->Info
== NULL
1829 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1830 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1831 SHELL_FREE_NON_NULL(NewNode
->Info
);
1832 SHELL_FREE_NON_NULL(NewNode
);
1835 NewNode
->Status
= Node
->Status
;
1836 NewNode
->Handle
= Node
->Handle
;
1838 Node
->Handle
= NULL
;
1841 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1845 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1846 failed it will return NULL.
1848 @param[in] BasePath the Path to prepend onto filename for FullPath
1849 @param[in] Status Status member initial value.
1850 @param[in] FileName FileName member initial value.
1851 @param[in] Handle Handle member initial value.
1852 @param[in] Info Info struct to copy.
1854 @retval NULL An error ocurred.
1855 @return a pointer to the newly allocated structure.
1857 EFI_SHELL_FILE_INFO
*
1859 CreateAndPopulateShellFileInfo(
1860 IN CONST CHAR16
*BasePath
,
1861 IN CONST EFI_STATUS Status
,
1862 IN CONST CHAR16
*FileName
,
1863 IN CONST SHELL_FILE_HANDLE Handle
,
1864 IN CONST EFI_FILE_INFO
*Info
1867 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1874 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1875 if (ShellFileListItem
== NULL
) {
1878 if (Info
!= NULL
&& Info
->Size
!= 0) {
1879 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1880 if (ShellFileListItem
->Info
== NULL
) {
1881 FreePool(ShellFileListItem
);
1884 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1886 ShellFileListItem
->Info
= NULL
;
1888 if (FileName
!= NULL
) {
1889 ASSERT(TempString
== NULL
);
1890 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1891 if (ShellFileListItem
->FileName
== NULL
) {
1892 FreePool(ShellFileListItem
->Info
);
1893 FreePool(ShellFileListItem
);
1897 ShellFileListItem
->FileName
= NULL
;
1901 if (BasePath
!= NULL
) {
1902 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1903 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1904 if (TempString
== NULL
) {
1905 FreePool((VOID
*)ShellFileListItem
->FileName
);
1906 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1907 FreePool(ShellFileListItem
);
1911 if (ShellFileListItem
->FileName
!= NULL
) {
1912 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1913 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1914 if (TempString
== NULL
) {
1915 FreePool((VOID
*)ShellFileListItem
->FileName
);
1916 FreePool(ShellFileListItem
->Info
);
1917 FreePool(ShellFileListItem
);
1922 TempString
= PathCleanUpDirectories(TempString
);
1924 ShellFileListItem
->FullName
= TempString
;
1925 ShellFileListItem
->Status
= Status
;
1926 ShellFileListItem
->Handle
= Handle
;
1928 return (ShellFileListItem
);
1932 Find all files in a specified directory.
1934 @param FileDirHandle Handle of the directory to search.
1935 @param FileList On return, points to the list of files in the directory
1936 or NULL if there are no files in the directory.
1938 @retval EFI_SUCCESS File information was returned successfully.
1939 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1940 @retval EFI_DEVICE_ERROR The device reported an error.
1941 @retval EFI_NO_MEDIA The device media is not present.
1942 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1943 @return An error from FileHandleGetFileName().
1947 EfiShellFindFilesInDir(
1948 IN SHELL_FILE_HANDLE FileDirHandle
,
1949 OUT EFI_SHELL_FILE_INFO
**FileList
1952 EFI_SHELL_FILE_INFO
*ShellFileList
;
1953 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1954 EFI_FILE_INFO
*FileInfo
;
1963 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1964 if (EFI_ERROR(Status
)) {
1968 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1971 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1972 if (TempString
== NULL
) {
1973 SHELL_FREE_NON_NULL(BasePath
);
1974 return (EFI_OUT_OF_RESOURCES
);
1976 TempSpot
= StrStr(TempString
, L
";");
1978 if (TempSpot
!= NULL
) {
1979 *TempSpot
= CHAR_NULL
;
1982 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1983 if (TempString
== NULL
) {
1984 SHELL_FREE_NON_NULL(BasePath
);
1985 return (EFI_OUT_OF_RESOURCES
);
1987 SHELL_FREE_NON_NULL(BasePath
);
1988 BasePath
= TempString
;
1992 ShellFileList
= NULL
;
1993 ShellFileListItem
= NULL
;
1995 Status
= EFI_SUCCESS
;
1998 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
1999 ; !EFI_ERROR(Status
) && !NoFile
2000 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2003 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2005 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2007 EFI_SUCCESS
, // success since we didnt fail to open it...
2009 NULL
, // no handle since not open
2012 if (ShellFileList
== NULL
) {
2013 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2014 ASSERT(ShellFileList
!= NULL
);
2015 InitializeListHead(&ShellFileList
->Link
);
2017 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2019 if (EFI_ERROR(Status
)) {
2020 EfiShellFreeFileList(&ShellFileList
);
2023 *FileList
= ShellFileList
;
2025 SHELL_FREE_NON_NULL(BasePath
);
2030 Get the GUID value from a human readable name.
2032 If GuidName is a known GUID name, then update Guid to have the correct value for
2035 This function is only available when the major and minor versions in the
2036 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2038 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2039 @param[out] Guid A pointer to the GUID structure to be filled in.
2041 @retval EFI_SUCCESS The operation was successful.
2042 @retval EFI_INVALID_PARAMETER Guid was NULL.
2043 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2044 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2048 EfiShellGetGuidFromName(
2049 IN CONST CHAR16
*GuidName
,
2056 if (Guid
== NULL
|| GuidName
== NULL
) {
2057 return (EFI_INVALID_PARAMETER
);
2060 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2062 if (!EFI_ERROR(Status
)) {
2063 CopyGuid(NewGuid
, Guid
);
2070 Get the human readable name for a GUID from the value.
2072 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2073 should not modify the value.
2075 This function is only available when the major and minor versions in the
2076 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2078 @param[in] Guid A pointer to the GUID being queried.
2079 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2081 @retval EFI_SUCCESS The operation was successful.
2082 @retval EFI_INVALID_PARAMETER Guid was NULL.
2083 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2084 @retval EFI_NOT_FOUND Guid is not assigned a name.
2088 EfiShellGetGuidName(
2089 IN CONST EFI_GUID
*Guid
,
2090 OUT CONST CHAR16
**GuidName
2095 if (Guid
== NULL
|| GuidName
== NULL
) {
2096 return (EFI_INVALID_PARAMETER
);
2099 Name
= GetStringNameFromGuid(Guid
, NULL
);
2100 if (Name
== NULL
|| StrLen(Name
) == 0) {
2101 SHELL_FREE_NON_NULL(Name
);
2102 return (EFI_NOT_FOUND
);
2105 *GuidName
= AddBufferToFreeList(Name
);
2107 return (EFI_SUCCESS
);
2111 Updates a file name to be preceeded by the mapped drive name
2113 @param[in] BasePath the Mapped drive name to prepend
2114 @param[in, out] Path pointer to pointer to the file name to update.
2117 @retval EFI_OUT_OF_RESOURCES
2122 IN CONST CHAR16
*BasePath
,
2123 IN OUT CHAR16
**Path
2132 ASSERT(Path
!= NULL
);
2133 ASSERT(*Path
!= NULL
);
2134 ASSERT(BasePath
!= NULL
);
2137 // convert a local path to an absolute path
2139 if (StrStr(*Path
, L
":") == NULL
) {
2140 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2141 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2142 if (Path2
== NULL
) {
2143 return (EFI_OUT_OF_RESOURCES
);
2145 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2146 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2147 if (Path2
== NULL
) {
2148 return (EFI_OUT_OF_RESOURCES
);
2155 return (EFI_SUCCESS
);
2159 If FileHandle is a directory then the function reads from FileHandle and reads in
2160 each of the FileInfo structures. If one of them matches the Pattern's first
2161 "level" then it opens that handle and calls itself on that handle.
2163 If FileHandle is a file and matches all of the remaining Pattern (which would be
2164 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2166 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2167 FreeFileList with FileList.
2169 @param[in] FilePattern The FilePattern to check against.
2170 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2171 @param[in] FileHandle The FileHandle to start with
2172 @param[in, out] FileList pointer to pointer to list of found files.
2173 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2174 @param[in] MapName The file system name this file is on.
2176 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2177 @retval EFI_NOT_FOUND no files were found
2178 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2183 IN CONST CHAR16
*FilePattern
,
2184 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2185 IN SHELL_FILE_HANDLE FileHandle
,
2186 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2187 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2188 IN CONST CHAR16
*MapName
2192 CONST CHAR16
*NextFilePatternStart
;
2193 CHAR16
*CurrentFilePattern
;
2194 EFI_SHELL_FILE_INFO
*ShellInfo
;
2195 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2196 EFI_SHELL_FILE_INFO
*NewShellNode
;
2197 EFI_FILE_INFO
*FileInfo
;
2199 CHAR16
*NewFullName
;
2202 if ( FilePattern
== NULL
2203 || UnicodeCollation
== NULL
2206 return (EFI_INVALID_PARAMETER
);
2209 CurrentFilePattern
= NULL
;
2211 if (*FilePattern
== L
'\\') {
2215 for( NextFilePatternStart
= FilePattern
2216 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2217 ; NextFilePatternStart
++);
2219 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2220 ASSERT(CurrentFilePattern
!= NULL
);
2221 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2223 if (CurrentFilePattern
[0] == CHAR_NULL
2224 &&NextFilePatternStart
[0] == CHAR_NULL
2227 // we want the parent or root node (if no parent)
2229 if (ParentNode
== NULL
) {
2231 // We want the root node. create the node.
2233 FileInfo
= FileHandleGetInfo(FileHandle
);
2234 NewShellNode
= CreateAndPopulateShellFileInfo(
2241 SHELL_FREE_NON_NULL(FileInfo
);
2244 // Add the current parameter FileHandle to the list, then end...
2246 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2248 if (NewShellNode
== NULL
) {
2249 Status
= EFI_OUT_OF_RESOURCES
;
2251 NewShellNode
->Handle
= NULL
;
2252 if (*FileList
== NULL
) {
2253 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2254 InitializeListHead(&((*FileList
)->Link
));
2258 // Add to the returning to use list
2260 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2262 Status
= EFI_SUCCESS
;
2265 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2267 if (!EFI_ERROR(Status
)){
2268 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2273 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2274 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2275 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2277 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2278 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2279 Size
= StrSize(ShellInfoNode
->FullName
);
2280 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2281 NewFullName
= AllocateZeroPool(Size
);
2282 if (NewFullName
== NULL
) {
2283 Status
= EFI_OUT_OF_RESOURCES
;
2285 StrnCpy(NewFullName
, MapName
, Size
/sizeof(CHAR16
)-1);
2286 StrnCat(NewFullName
, ShellInfoNode
->FullName
+1, (Size
/sizeof(CHAR16
))-StrLen(NewFullName
)-1);
2287 FreePool((VOID
*)ShellInfoNode
->FullName
);
2288 ShellInfoNode
->FullName
= NewFullName
;
2291 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2293 // should be a directory
2297 // don't open the . and .. directories
2299 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2300 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2305 if (EFI_ERROR(Status
)) {
2309 // Open the directory since we need that handle in the next recursion.
2311 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2314 // recurse with the next part of the pattern
2316 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2318 } else if (!EFI_ERROR(Status
)) {
2324 // copy the information we need into a new Node
2326 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2327 ASSERT(NewShellNode
!= NULL
);
2328 if (NewShellNode
== NULL
) {
2329 Status
= EFI_OUT_OF_RESOURCES
;
2331 if (*FileList
== NULL
) {
2332 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2333 InitializeListHead(&((*FileList
)->Link
));
2337 // Add to the returning to use list
2339 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2342 if (EFI_ERROR(Status
)) {
2346 if (EFI_ERROR(Status
)) {
2347 EfiShellFreeFileList(&ShellInfo
);
2349 Status
= EfiShellFreeFileList(&ShellInfo
);
2354 FreePool(CurrentFilePattern
);
2359 Find files that match a specified pattern.
2361 This function searches for all files and directories that match the specified
2362 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2363 information is placed in the file list FileList.
2365 Wildcards are processed
2366 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2368 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2369 field is set to NULL.
2371 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2373 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2374 @param FileList On return, points to the start of a file list containing the names
2375 of all matching files or else points to NULL if no matching files
2376 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2378 @retval EFI_SUCCESS Files found. FileList is a valid list.
2379 @retval EFI_NOT_FOUND No files found.
2380 @retval EFI_NO_MEDIA The device has no media
2381 @retval EFI_DEVICE_ERROR The device reported an error
2382 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2387 IN CONST CHAR16
*FilePattern
,
2388 OUT EFI_SHELL_FILE_INFO
**FileList
2392 CHAR16
*PatternCopy
;
2393 CHAR16
*PatternCurrentLocation
;
2394 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2395 SHELL_FILE_HANDLE RootFileHandle
;
2399 if ( FilePattern
== NULL
2401 || StrStr(FilePattern
, L
":") == NULL
2403 return (EFI_INVALID_PARAMETER
);
2405 Status
= EFI_SUCCESS
;
2406 RootDevicePath
= NULL
;
2407 RootFileHandle
= NULL
;
2409 PatternCopy
= AllocateCopyPool(StrSize(FilePattern
), FilePattern
);
2410 if (PatternCopy
== NULL
) {
2411 return (EFI_OUT_OF_RESOURCES
);
2414 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2416 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2419 ASSERT(MapName
== NULL
);
2420 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2421 if (MapName
== NULL
) {
2422 Status
= EFI_OUT_OF_RESOURCES
;
2424 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2425 if (RootDevicePath
== NULL
) {
2426 Status
= EFI_INVALID_PARAMETER
;
2428 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2429 if (!EFI_ERROR(Status
)) {
2430 for ( PatternCurrentLocation
= PatternCopy
2431 ; *PatternCurrentLocation
!= ':'
2432 ; PatternCurrentLocation
++);
2433 PatternCurrentLocation
++;
2434 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2436 FreePool(RootDevicePath
);
2440 SHELL_FREE_NON_NULL(PatternCopy
);
2441 SHELL_FREE_NON_NULL(MapName
);
2447 Opens the files that match the path specified.
2449 This function opens all of the files specified by Path. Wildcards are processed
2450 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2451 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2453 @param Path A pointer to the path string.
2454 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2455 EFI_FILE_MODE_WRITE.
2456 @param FileList Points to the start of a list of files opened.
2458 @retval EFI_SUCCESS Create the file list successfully.
2459 @return Others Can't create the file list.
2463 EfiShellOpenFileList(
2466 IN OUT EFI_SHELL_FILE_INFO
**FileList
2470 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2473 CONST CHAR16
*CurDir
;
2476 PathCleanUpDirectories(Path
);
2481 if (FileList
== NULL
|| *FileList
== NULL
) {
2482 return (EFI_INVALID_PARAMETER
);
2485 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2490 // convert a local path to an absolute path
2492 if (StrStr(Path
, L
":") == NULL
) {
2493 CurDir
= EfiShellGetCurDir(NULL
);
2494 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2495 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2496 if (*Path
== L
'\\') {
2498 while (PathRemoveLastItem(Path2
)) ;
2500 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2501 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2503 ASSERT(Path2
== NULL
);
2504 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2507 PathCleanUpDirectories (Path2
);
2512 Status
= EfiShellFindFiles(Path2
, FileList
);
2516 if (EFI_ERROR(Status
)) {
2522 // We had no errors so open all the files (that are not already opened...)
2524 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2525 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2526 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2528 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2529 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2535 return (EFI_NOT_FOUND
);
2537 return(EFI_SUCCESS
);
2541 Gets the environment variable and Attributes, or list of environment variables. Can be
2542 used instead of GetEnv().
2544 This function returns the current value of the specified environment variable and
2545 the Attributes. If no variable name was specified, then all of the known
2546 variables will be returned.
2548 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2549 then the function will return all of the defined shell
2550 environment variables. In the case where multiple environment
2551 variables are being returned, each variable will be terminated
2552 by a NULL, and the list will be terminated by a double NULL.
2553 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2554 the environment variable. In the case where Name is NULL, and
2555 multiple environment variables are being returned, Attributes
2558 @retval NULL The environment variable doesn't exist.
2559 @return A non-NULL value points to the variable's value. The returned
2560 pointer does not need to be freed by the caller.
2565 IN CONST CHAR16
*Name
,
2566 OUT UINT32
*Attributes OPTIONAL
2574 CHAR16
*CurrentWriteLocation
;
2581 // Get all our environment variables
2583 InitializeListHead(&List
);
2584 Status
= GetEnvironmentVariableList(&List
);
2585 if (EFI_ERROR(Status
)){
2590 // Build the semi-colon delimited list. (2 passes)
2592 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2593 ; !IsNull(&List
, &Node
->Link
)
2594 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2596 ASSERT(Node
->Key
!= NULL
);
2597 Size
+= StrSize(Node
->Key
);
2600 Size
+= 2*sizeof(CHAR16
);
2602 Buffer
= AllocateZeroPool(Size
);
2603 if (Buffer
== NULL
) {
2604 if (!IsListEmpty (&List
)) {
2605 FreeEnvironmentVariableList(&List
);
2609 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2611 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2612 ; !IsNull(&List
, &Node
->Link
)
2613 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2615 ASSERT(Node
->Key
!= NULL
);
2616 StrnCpy(CurrentWriteLocation
, Node
->Key
, (Size
)/sizeof(CHAR16
) - (CurrentWriteLocation
- ((CHAR16
*)Buffer
)) - 1);
2617 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2623 if (!IsListEmpty (&List
)) {
2624 FreeEnvironmentVariableList(&List
);
2628 // We are doing a specific environment variable
2632 // get the size we need for this EnvVariable
2634 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2635 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2637 // Allocate the space and recall the get function
2639 Buffer
= AllocateZeroPool(Size
);
2640 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2643 // we didnt get it (might not exist)
2644 // free the memory if we allocated any and return NULL
2646 if (EFI_ERROR(Status
)) {
2647 if (Buffer
!= NULL
) {
2655 // return the buffer
2657 return (AddBufferToFreeList(Buffer
));
2661 Gets either a single or list of environment variables.
2663 If name is not NULL then this function returns the current value of the specified
2664 environment variable.
2666 If Name is NULL, then a list of all environment variable names is returned. Each is a
2667 NULL terminated string with a double NULL terminating the list.
2669 @param Name A pointer to the environment variable name. If
2670 Name is NULL, then the function will return all
2671 of the defined shell environment variables. In
2672 the case where multiple environment variables are
2673 being returned, each variable will be terminated by
2674 a NULL, and the list will be terminated by a double
2677 @retval !=NULL A pointer to the returned string.
2678 The returned pointer does not need to be freed by the caller.
2680 @retval NULL The environment variable doesn't exist or there are
2681 no environment variables.
2686 IN CONST CHAR16
*Name
2689 return (EfiShellGetEnvEx(Name
, NULL
));
2693 Internal variable setting function. Allows for setting of the read only variables.
2695 @param Name Points to the NULL-terminated environment variable name.
2696 @param Value Points to the NULL-terminated environment variable value. If the value is an
2697 empty string then the environment variable is deleted.
2698 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2700 @retval EFI_SUCCESS The environment variable was successfully updated.
2704 InternalEfiShellSetEnv(
2705 IN CONST CHAR16
*Name
,
2706 IN CONST CHAR16
*Value
,
2710 if (Value
== NULL
|| StrLen(Value
) == 0) {
2711 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2713 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2715 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2717 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2723 Sets the environment variable.
2725 This function changes the current value of the specified environment variable. If the
2726 environment variable exists and the Value is an empty string, then the environment
2727 variable is deleted. If the environment variable exists and the Value is not an empty
2728 string, then the value of the environment variable is changed. If the environment
2729 variable does not exist and the Value is an empty string, there is no action. If the
2730 environment variable does not exist and the Value is a non-empty string, then the
2731 environment variable is created and assigned the specified value.
2733 For a description of volatile and non-volatile environment variables, see UEFI Shell
2734 2.0 specification section 3.6.1.
2736 @param Name Points to the NULL-terminated environment variable name.
2737 @param Value Points to the NULL-terminated environment variable value. If the value is an
2738 empty string then the environment variable is deleted.
2739 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2741 @retval EFI_SUCCESS The environment variable was successfully updated.
2746 IN CONST CHAR16
*Name
,
2747 IN CONST CHAR16
*Value
,
2751 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2752 return (EFI_INVALID_PARAMETER
);
2755 // Make sure we dont 'set' a predefined read only variable
2757 if (gUnicodeCollation
->StriColl(
2761 ||gUnicodeCollation
->StriColl(
2765 ||gUnicodeCollation
->StriColl(
2769 ||gUnicodeCollation
->StriColl(
2772 L
"uefishellsupport") == 0
2773 ||gUnicodeCollation
->StriColl(
2776 L
"uefishellversion") == 0
2777 ||gUnicodeCollation
->StriColl(
2780 L
"uefiversion") == 0
2782 return (EFI_INVALID_PARAMETER
);
2784 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2788 Returns the current directory on the specified device.
2790 If FileSystemMapping is NULL, it returns the current working directory. If the
2791 FileSystemMapping is not NULL, it returns the current directory associated with the
2792 FileSystemMapping. In both cases, the returned name includes the file system
2793 mapping (i.e. fs0:\current-dir).
2795 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2796 then the current working directory is returned.
2798 @retval !=NULL The current directory.
2799 @retval NULL Current directory does not exist.
2804 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2807 CHAR16
*PathToReturn
;
2809 SHELL_MAP_LIST
*MapListItem
;
2810 if (!IsListEmpty(&gShellMapList
.Link
)) {
2812 // if parameter is NULL, use current
2814 if (FileSystemMapping
== NULL
) {
2815 return (EfiShellGetEnv(L
"cwd"));
2818 PathToReturn
= NULL
;
2819 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2820 if (MapListItem
!= NULL
) {
2821 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2822 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2823 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2826 return (AddBufferToFreeList(PathToReturn
));
2833 Changes the current directory on the specified device.
2835 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2836 mapped name, this function changes the current working directory.
2838 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2839 current file system and the current directory on that file system are changed.
2841 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2844 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2845 directory on the specified file system.
2847 If the current working directory or the current working file system is changed then the
2848 %cwd% environment variable will be updated
2850 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2851 directory is changed.
2852 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2854 @retval EFI_SUCCESS The operation was sucessful
2855 @retval EFI_NOT_FOUND The file system could not be found
2860 IN CONST CHAR16
*FileSystem OPTIONAL
,
2861 IN CONST CHAR16
*Dir
2865 SHELL_MAP_LIST
*MapListItem
;
2869 CHAR16
*DirectoryName
;
2876 DirectoryName
= NULL
;
2878 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2879 return (EFI_INVALID_PARAMETER
);
2882 if (IsListEmpty(&gShellMapList
.Link
)){
2883 return (EFI_NOT_FOUND
);
2886 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2887 ASSERT(DirectoryName
!= NULL
);
2889 PathCleanUpDirectories(DirectoryName
);
2891 if (FileSystem
== NULL
) {
2893 // determine the file system mapping to use
2895 if (StrStr(DirectoryName
, L
":") != NULL
) {
2896 ASSERT(MapName
== NULL
);
2897 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2900 // find the file system mapping's entry in the list
2903 if (MapName
!= NULL
) {
2904 MapListItem
= ShellCommandFindMapItem(MapName
);
2907 // make that the current file system mapping
2909 if (MapListItem
!= NULL
) {
2910 gShellCurDir
= MapListItem
;
2913 MapListItem
= gShellCurDir
;
2916 if (MapListItem
== NULL
) {
2917 return (EFI_NOT_FOUND
);
2921 // now update the MapListItem's current directory
2923 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2924 FreePool(MapListItem
->CurrentDirectoryPath
);
2925 MapListItem
->CurrentDirectoryPath
= NULL
;
2927 if (MapName
!= NULL
) {
2928 TempLen
= StrLen(MapName
);
2929 if (TempLen
!= StrLen(DirectoryName
)) {
2930 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2931 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2934 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2935 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2937 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2938 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2939 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2943 // cant have a mapping in the directory...
2945 if (StrStr(DirectoryName
, L
":") != NULL
) {
2946 return (EFI_INVALID_PARAMETER
);
2949 // FileSystem != NULL
2951 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2952 if (MapListItem
== NULL
) {
2953 return (EFI_INVALID_PARAMETER
);
2955 // gShellCurDir = MapListItem;
2956 if (DirectoryName
!= NULL
) {
2958 // change current dir on that file system
2961 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2962 FreePool(MapListItem
->CurrentDirectoryPath
);
2963 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2965 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2966 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2967 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2968 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2969 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2970 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2971 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
2972 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2973 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2978 // if updated the current directory then update the environment variable
2980 if (MapListItem
== gShellCurDir
) {
2982 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2983 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
2984 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2985 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2986 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
2987 FreePool(TempString
);
2990 return(EFI_SUCCESS
);
2994 Return help information about a specific command.
2996 This function returns the help information for the specified command. The help text
2997 can be internal to the shell or can be from a UEFI Shell manual page.
2999 If Sections is specified, then each section name listed will be compared in a casesensitive
3000 manner, to the section names described in Appendix B. If the section exists,
3001 it will be appended to the returned help text. If the section does not exist, no
3002 information will be returned. If Sections is NULL, then all help text information
3003 available will be returned.
3005 @param Command Points to the NULL-terminated UEFI Shell command name.
3006 @param Sections Points to the NULL-terminated comma-delimited
3007 section names to return. If NULL, then all
3008 sections will be returned.
3009 @param HelpText On return, points to a callee-allocated buffer
3010 containing all specified help text.
3012 @retval EFI_SUCCESS The help text was returned.
3013 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3015 @retval EFI_INVALID_PARAMETER HelpText is NULL
3016 @retval EFI_NOT_FOUND There is no help text available for Command.
3020 EfiShellGetHelpText(
3021 IN CONST CHAR16
*Command
,
3022 IN CONST CHAR16
*Sections OPTIONAL
,
3023 OUT CHAR16
**HelpText
3026 CONST CHAR16
*ManFileName
;
3030 ASSERT(HelpText
!= NULL
);
3033 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3035 if (ManFileName
!= NULL
) {
3036 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3038 if ((StrLen(Command
)> 4)
3039 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3040 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3041 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3042 && (Command
[StrLen(Command
)-4] == L
'.')
3044 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3045 ASSERT(FixCommand
!= NULL
);
3047 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
3048 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3049 FreePool(FixCommand
);
3052 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3058 Gets the enable status of the page break output mode.
3060 User can use this function to determine current page break mode.
3062 @retval TRUE The page break output mode is enabled.
3063 @retval FALSE The page break output mode is disabled.
3067 EfiShellGetPageBreak(
3071 return(ShellInfoObject
.PageBreakEnabled
);
3075 Judges whether the active shell is the root shell.
3077 This function makes the user to know that whether the active Shell is the root shell.
3079 @retval TRUE The active Shell is the root Shell.
3080 @retval FALSE The active Shell is NOT the root Shell.
3084 EfiShellIsRootShell(
3088 return(ShellInfoObject
.RootShellInstance
);
3092 function to return a semi-colon delimeted list of all alias' in the current shell
3094 up to caller to free the memory.
3096 @retval NULL No alias' were found
3097 @retval NULL An error ocurred getting alias'
3098 @return !NULL a list of all alias'
3102 InternalEfiShellGetListAlias(
3110 CHAR16
*VariableName
;
3115 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
3116 ASSERT_EFI_ERROR(Status
);
3118 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
3122 if (VariableName
== NULL
) {
3126 VariableName
[0] = CHAR_NULL
;
3129 NameSize
= (UINTN
)MaxVarSize
;
3130 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3131 if (Status
== EFI_NOT_FOUND
){
3134 ASSERT_EFI_ERROR(Status
);
3135 if (EFI_ERROR(Status
)) {
3138 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3139 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3140 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3141 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3144 FreePool(VariableName
);
3150 Convert a null-terminated unicode string, in-place, to all lowercase.
3153 @param Str The null-terminated string to be converted to all lowercase.
3155 @return The null-terminated string converted into all lowercase.
3164 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3165 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3166 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3173 This function returns the command associated with a alias or a list of all
3176 @param[in] Alias Points to the NULL-terminated shell alias.
3177 If this parameter is NULL, then all
3178 aliases will be returned in ReturnedData.
3179 @param[out] Volatile upon return of a single command if TRUE indicates
3180 this is stored in a volatile fashion. FALSE otherwise.
3182 @return If Alias is not NULL, it will return a pointer to
3183 the NULL-terminated command for that alias.
3184 If Alias is NULL, ReturnedData points to a ';'
3185 delimited list of alias (e.g.
3186 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3187 @retval NULL an error ocurred
3188 @retval NULL Alias was not a valid Alias
3193 IN CONST CHAR16
*Alias
,
3194 OUT BOOLEAN
*Volatile OPTIONAL
3203 // Convert to lowercase to make aliases case-insensitive
3204 if (Alias
!= NULL
) {
3205 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3206 ASSERT (AliasLower
!= NULL
);
3207 ToLower (AliasLower
);
3209 if (Volatile
== NULL
) {
3210 return (AddBufferToFreeList(GetVariable(AliasLower
, &gShellAliasGuid
)));
3214 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3215 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3216 RetVal
= AllocateZeroPool(RetSize
);
3217 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3219 if (EFI_ERROR(Status
)) {
3220 if (RetVal
!= NULL
) {
3225 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3231 FreePool (AliasLower
);
3232 return (AddBufferToFreeList(RetVal
));
3234 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3238 Changes a shell command alias.
3240 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3242 this function does not check for built in alias'.
3244 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3245 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3246 Command refers to an alias, that alias will be deleted.
3247 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3248 Alias being set will be stored in a non-volatile fashion.
3250 @retval EFI_SUCCESS Alias created or deleted successfully.
3251 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3256 IN CONST CHAR16
*Command
,
3257 IN CONST CHAR16
*Alias
,
3264 // Convert to lowercase to make aliases case-insensitive
3265 if (Alias
!= NULL
) {
3266 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3267 ASSERT (AliasLower
!= NULL
);
3268 ToLower (AliasLower
);
3274 // We must be trying to remove one if Alias is NULL
3276 if (Alias
== NULL
) {
3278 // remove an alias (but passed in COMMAND parameter)
3280 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3283 // Add and replace are the same
3286 // We dont check the error return on purpose since the variable may not exist.
3287 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3289 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3292 if (Alias
!= NULL
) {
3293 FreePool (AliasLower
);
3299 Changes a shell command alias.
3301 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3304 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3305 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3306 Command refers to an alias, that alias will be deleted.
3307 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3308 FALSE and the alias already exists, then the existing alias is unchanged and
3309 EFI_ACCESS_DENIED is returned.
3310 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3311 Alias being set will be stored in a non-volatile fashion.
3313 @retval EFI_SUCCESS Alias created or deleted successfully.
3314 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3315 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3317 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3322 IN CONST CHAR16
*Command
,
3323 IN CONST CHAR16
*Alias
,
3328 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3330 // cant set over a built in alias
3332 return (EFI_ACCESS_DENIED
);
3333 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3335 // Command is null or empty
3337 return (EFI_INVALID_PARAMETER
);
3338 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3340 // Alias already exists, Replace not set
3342 return (EFI_ACCESS_DENIED
);
3344 return (InternalSetAlias(Command
, Alias
, Volatile
));
3348 // Pure FILE_HANDLE operations are passed to FileHandleLib
3349 // these functions are indicated by the *
3350 EFI_SHELL_PROTOCOL mShellProtocol
= {
3356 EfiShellGetHelpText
,
3357 EfiShellGetDevicePathFromMap
,
3358 EfiShellGetMapFromDevicePath
,
3359 EfiShellGetDevicePathFromFilePath
,
3360 EfiShellGetFilePathFromDevicePath
,
3364 EfiShellOpenFileList
,
3365 EfiShellFreeFileList
,
3366 EfiShellRemoveDupInFileList
,
3367 EfiShellBatchIsActive
,
3368 EfiShellIsRootShell
,
3369 EfiShellEnablePageBreak
,
3370 EfiShellDisablePageBreak
,
3371 EfiShellGetPageBreak
,
3372 EfiShellGetDeviceName
,
3373 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3374 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3375 EfiShellOpenFileByName
,
3378 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3379 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3380 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3381 EfiShellDeleteFileByName
,
3382 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3383 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3384 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3386 EfiShellFindFilesInDir
,
3387 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3389 EfiShellOpenRootByHandle
,
3391 SHELL_MAJOR_VERSION
,
3392 SHELL_MINOR_VERSION
,
3394 // New for UEFI Shell 2.1
3395 EfiShellRegisterGuidName
,
3396 EfiShellGetGuidName
,
3397 EfiShellGetGuidFromName
,
3402 Function to create and install on the current handle.
3404 Will overwrite any existing ShellProtocols in the system to be sure that
3405 the current shell is in control.
3407 This must be removed via calling CleanUpShellProtocol().
3409 @param[in, out] NewShell The pointer to the pointer to the structure
3412 @retval EFI_SUCCESS The operation was successful.
3413 @return An error from LocateHandle, CreateEvent, or other core function.
3417 CreatePopulateInstallShellProtocol (
3418 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3424 UINTN HandleCounter
;
3425 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3427 if (NewShell
== NULL
) {
3428 return (EFI_INVALID_PARAMETER
);
3433 OldProtocolNode
= NULL
;
3434 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3437 // Initialize EfiShellProtocol object...
3439 Status
= gBS
->CreateEvent(0,
3443 &mShellProtocol
.ExecutionBreak
);
3444 if (EFI_ERROR(Status
)) {
3449 // Get the size of the buffer we need.
3451 Status
= gBS
->LocateHandle(ByProtocol
,
3452 &gEfiShellProtocolGuid
,
3456 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3458 // Allocate and recall with buffer of correct size
3460 Buffer
= AllocateZeroPool(BufferSize
);
3461 if (Buffer
== NULL
) {
3462 return (EFI_OUT_OF_RESOURCES
);
3464 Status
= gBS
->LocateHandle(ByProtocol
,
3465 &gEfiShellProtocolGuid
,
3469 if (EFI_ERROR(Status
)) {
3474 // now overwrite each of them, but save the info to restore when we end.
3476 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3477 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3478 ASSERT(OldProtocolNode
!= NULL
);
3479 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3480 &gEfiShellProtocolGuid
,
3481 (VOID
**) &(OldProtocolNode
->Interface
),
3484 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3486 if (!EFI_ERROR(Status
)) {
3488 // reinstall over the old one...
3490 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3491 Status
= gBS
->ReinstallProtocolInterface(
3492 OldProtocolNode
->Handle
,
3493 &gEfiShellProtocolGuid
,
3494 OldProtocolNode
->Interface
,
3495 (VOID
*)(&mShellProtocol
));
3496 if (!EFI_ERROR(Status
)) {
3498 // we reinstalled sucessfully. log this so we can reverse it later.
3502 // add to the list for subsequent...
3504 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3509 } else if (Status
== EFI_NOT_FOUND
) {
3510 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3512 // no one else published yet. just publish it ourselves.
3514 Status
= gBS
->InstallProtocolInterface (
3516 &gEfiShellProtocolGuid
,
3517 EFI_NATIVE_INTERFACE
,
3518 (VOID
*)(&mShellProtocol
));
3521 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3522 ///@todo support ShellEnvironment2
3523 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3526 if (!EFI_ERROR(Status
)) {
3527 *NewShell
= &mShellProtocol
;
3533 Opposite of CreatePopulateInstallShellProtocol.
3535 Free all memory and restore the system to the state it was in before calling
3536 CreatePopulateInstallShellProtocol.
3538 @param[in, out] NewShell The pointer to the new shell protocol structure.
3540 @retval EFI_SUCCESS The operation was successful.
3544 CleanUpShellProtocol (
3545 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3549 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3550 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3553 // if we need to restore old protocols...
3555 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3556 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3557 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3558 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3560 RemoveEntryList(&Node2
->Link
);
3561 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3562 &gEfiShellProtocolGuid
,
3569 // no need to restore
3571 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3572 &gEfiShellProtocolGuid
,
3575 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3576 NewShell
->ExecutionBreak
= NULL
;
3578 Status
= gBS
->OpenProtocol(
3579 gST
->ConsoleInHandle
,
3580 &gEfiSimpleTextInputExProtocolGuid
,
3584 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3586 if (!EFI_ERROR (Status
)) {
3587 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3588 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3589 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3590 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3591 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3592 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3593 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3594 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3600 Notification function for keystrokes.
3602 @param[in] KeyData The key that was pressed.
3604 @retval EFI_SUCCESS The operation was successful.
3608 NotificationFunction(
3609 IN EFI_KEY_DATA
*KeyData
3612 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3613 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3614 (KeyData
->Key
.UnicodeChar
== 3)
3616 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3617 return (EFI_UNSUPPORTED
);
3619 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3620 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3621 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3623 ShellInfoObject
.HaltOutput
= TRUE
;
3625 return (EFI_SUCCESS
);
3629 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3630 feature's enabled state was not known when the shell initially launched.
3632 @retval EFI_SUCCESS The feature is enabled.
3633 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3637 InernalEfiShellStartMonitor(
3641 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3642 EFI_KEY_DATA KeyData
;
3645 Status
= gBS
->OpenProtocol(
3646 gST
->ConsoleInHandle
,
3647 &gEfiSimpleTextInputExProtocolGuid
,
3651 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3652 if (EFI_ERROR(Status
)) {
3657 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3658 ShellInfoObject
.HiiHandle
);
3659 return (EFI_SUCCESS
);
3662 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3663 return (EFI_UNSUPPORTED
);
3666 KeyData
.KeyState
.KeyToggleState
= 0;
3667 KeyData
.Key
.ScanCode
= 0;
3668 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3669 KeyData
.Key
.UnicodeChar
= L
'c';
3671 Status
= SimpleEx
->RegisterKeyNotify(
3674 NotificationFunction
,
3675 &ShellInfoObject
.CtrlCNotifyHandle1
);
3677 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3678 if (!EFI_ERROR(Status
)) {
3679 Status
= SimpleEx
->RegisterKeyNotify(
3682 NotificationFunction
,
3683 &ShellInfoObject
.CtrlCNotifyHandle2
);
3685 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3686 KeyData
.Key
.UnicodeChar
= 3;
3687 if (!EFI_ERROR(Status
)) {
3688 Status
= SimpleEx
->RegisterKeyNotify(
3691 NotificationFunction
,
3692 &ShellInfoObject
.CtrlCNotifyHandle3
);
3694 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3695 if (!EFI_ERROR(Status
)) {
3696 Status
= SimpleEx
->RegisterKeyNotify(
3699 NotificationFunction
,
3700 &ShellInfoObject
.CtrlCNotifyHandle4
);