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
);
534 Size
+= StrSize(Path
);
535 NewPath
= AllocateZeroPool(Size
);
536 if (NewPath
== NULL
) {
539 StrCpy(NewPath
, Cwd
);
540 if (*Path
== L
'\\') {
542 while (PathRemoveLastItem(NewPath
)) ;
544 StrCat(NewPath
, Path
);
545 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
547 return (DevicePathForReturn
);
552 // find the part before (but including) the : for the map name
554 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
555 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
556 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
561 // look up the device path in the map
563 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
564 if (DevicePath
== NULL
) {
566 // Must have been a bad Mapname
572 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
574 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
575 if (DevicePathCopy
== NULL
) {
584 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
585 if (EFI_ERROR(Status
)) {
586 if (DevicePathCopyForFree
!= NULL
) {
587 FreePool(DevicePathCopyForFree
);
594 // build the full device path
596 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
597 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
599 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
603 if (DevicePathCopyForFree
!= NULL
) {
604 FreePool(DevicePathCopyForFree
);
607 return (DevicePathForReturn
);
611 Gets the name of the device specified by the device handle.
613 This function gets the user-readable name of the device specified by the device
614 handle. If no user-readable name could be generated, then *BestDeviceName will be
615 NULL and EFI_NOT_FOUND will be returned.
617 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
618 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
621 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
622 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
623 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
624 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
625 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
627 @param DeviceHandle The handle of the device.
628 @param Flags Determines the possible sources of component names.
630 EFI_DEVICE_NAME_USE_COMPONENT_NAME
631 EFI_DEVICE_NAME_USE_DEVICE_PATH
632 @param Language A pointer to the language specified for the device
633 name, in the same format as described in the UEFI
634 specification, Appendix M
635 @param BestDeviceName On return, points to the callee-allocated NULL-
636 terminated name of the device. If no device name
637 could be found, points to NULL. The name must be
638 freed by the caller...
640 @retval EFI_SUCCESS Get the name successfully.
641 @retval EFI_NOT_FOUND Fail to get the device name.
642 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
643 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
644 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
648 EfiShellGetDeviceName(
649 IN EFI_HANDLE DeviceHandle
,
650 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
652 OUT CHAR16
**BestDeviceName
656 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
657 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
658 EFI_HANDLE
*HandleList
;
661 CHAR16
*DeviceNameToReturn
;
663 UINTN ParentControllerCount
;
664 EFI_HANDLE
*ParentControllerBuffer
;
665 UINTN ParentDriverCount
;
666 EFI_HANDLE
*ParentDriverBuffer
;
668 if (BestDeviceName
== NULL
||
671 return (EFI_INVALID_PARAMETER
);
675 // make sure one of the 2 supported bits is on
677 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
678 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
679 return (EFI_INVALID_PARAMETER
);
682 DeviceNameToReturn
= NULL
;
683 *BestDeviceName
= NULL
;
688 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
689 Status
= ParseHandleDatabaseByRelationship(
692 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
695 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
697 // Go through those handles until we get one that passes for GetComponentName
699 Status
= gBS
->OpenProtocol(
701 &gEfiComponentName2ProtocolGuid
,
705 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
706 if (EFI_ERROR(Status
)) {
707 Status
= gBS
->OpenProtocol(
709 &gEfiComponentNameProtocolGuid
,
713 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
716 if (EFI_ERROR(Status
)) {
719 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
720 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
723 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
727 if (HandleList
!= NULL
) {
728 FreePool(HandleList
);
732 // Now check the parent controller using this as the child.
734 if (DeviceNameToReturn
== NULL
){
735 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
736 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
737 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
738 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
740 // try using that driver's component name with controller and our driver as the child.
742 Status
= gBS
->OpenProtocol(
743 ParentDriverBuffer
[HandleCount
],
744 &gEfiComponentName2ProtocolGuid
,
748 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
749 if (EFI_ERROR(Status
)) {
750 Status
= gBS
->OpenProtocol(
751 ParentDriverBuffer
[HandleCount
],
752 &gEfiComponentNameProtocolGuid
,
756 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
759 if (EFI_ERROR(Status
)) {
762 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
763 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
766 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
773 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
774 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
778 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
781 // dont return on fail since we will try device path if that bit is on
783 if (DeviceNameToReturn
!= NULL
){
784 ASSERT(BestDeviceName
!= NULL
);
785 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
786 return (EFI_SUCCESS
);
789 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
790 Status
= gBS
->OpenProtocol(
792 &gEfiDevicePathProtocolGuid
,
796 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
797 if (!EFI_ERROR(Status
)) {
799 // use device path to text on the device path
801 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
802 return (EFI_SUCCESS
);
806 // none of the selected bits worked.
808 return (EFI_NOT_FOUND
);
812 Opens the root directory of a device on a handle
814 This function opens the root directory of a device and returns a file handle to it.
816 @param DeviceHandle The handle of the device that contains the volume.
817 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
820 @retval EFI_SUCCESS Root opened successfully.
821 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
823 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
824 @retval EFI_DEVICE_ERROR The device had an error
828 EfiShellOpenRootByHandle(
829 IN EFI_HANDLE DeviceHandle
,
830 OUT SHELL_FILE_HANDLE
*FileHandle
834 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
835 EFI_FILE_PROTOCOL
*RealFileHandle
;
836 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
839 // get the simple file system interface
841 Status
= gBS
->OpenProtocol(DeviceHandle
,
842 &gEfiSimpleFileSystemProtocolGuid
,
843 (VOID
**)&SimpleFileSystem
,
846 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
847 if (EFI_ERROR(Status
)) {
848 return (EFI_NOT_FOUND
);
851 Status
= gBS
->OpenProtocol(DeviceHandle
,
852 &gEfiDevicePathProtocolGuid
,
856 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
857 if (EFI_ERROR(Status
)) {
858 return (EFI_NOT_FOUND
);
861 // Open the root volume now...
863 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
864 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
869 Opens the root directory of a device.
871 This function opens the root directory of a device and returns a file handle to it.
873 @param DevicePath Points to the device path corresponding to the device where the
874 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
875 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
878 @retval EFI_SUCCESS Root opened successfully.
879 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
881 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
882 @retval EFI_DEVICE_ERROR The device had an error
883 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
888 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
889 OUT SHELL_FILE_HANDLE
*FileHandle
895 if (FileHandle
== NULL
) {
896 return (EFI_INVALID_PARAMETER
);
900 // find the handle of the device with that device handle and the file system
903 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
906 if (EFI_ERROR(Status
)) {
907 return (EFI_NOT_FOUND
);
910 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
914 Returns whether any script files are currently being processed.
916 @retval TRUE There is at least one script file active.
917 @retval FALSE No script files are active now.
922 EfiShellBatchIsActive (
926 if (ShellCommandGetCurrentScriptFile() == NULL
) {
933 Worker function to open a file based on a device path. this will open the root
934 of the volume and then traverse down to the file itself.
936 @param DevicePath Device Path of the file.
937 @param FileHandle Pointer to the file upon a successful return.
938 @param OpenMode mode to open file in.
939 @param Attributes the File Attributes to use when creating a new file.
941 @retval EFI_SUCCESS the file is open and FileHandle is valid
942 @retval EFI_UNSUPPORTED the device path cotained non-path elements
943 @retval other an error ocurred.
947 InternalOpenFileDevicePath(
948 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
949 OUT SHELL_FILE_HANDLE
*FileHandle
,
951 IN UINT64 Attributes OPTIONAL
955 FILEPATH_DEVICE_PATH
*FilePathNode
;
957 SHELL_FILE_HANDLE ShellHandle
;
958 EFI_FILE_PROTOCOL
*Handle1
;
959 EFI_FILE_PROTOCOL
*Handle2
;
960 FILEPATH_DEVICE_PATH
*AlignedNode
;
962 if (FileHandle
== NULL
) {
963 return (EFI_INVALID_PARAMETER
);
973 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
975 if (!EFI_ERROR(Status
)) {
976 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
977 if (Handle1
!= NULL
) {
979 // chop off the begining part before the file system part...
982 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
985 if (!EFI_ERROR(Status
)) {
987 // To access as a file system, the file path should only
988 // contain file path components. Follow the file path nodes
989 // and find the target file
991 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
992 ; !IsDevicePathEnd (&FilePathNode
->Header
)
993 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
995 SHELL_FREE_NON_NULL(AlignedNode
);
996 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
998 // For file system access each node should be a file path component
1000 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
1001 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1003 Status
= EFI_UNSUPPORTED
;
1008 // Open this file path node
1014 // if this is the last node in the DevicePath always create (if that was requested).
1016 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1017 Status
= Handle2
->Open (
1020 AlignedNode
->PathName
,
1027 // This is not the last node and we dont want to 'create' existing
1028 // directory entries...
1032 // open without letting it create
1033 // prevents error on existing files/directories
1035 Status
= Handle2
->Open (
1038 AlignedNode
->PathName
,
1039 OpenMode
&~EFI_FILE_MODE_CREATE
,
1043 // if above failed now open and create the 'item'
1044 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1046 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1047 Status
= Handle2
->Open (
1050 AlignedNode
->PathName
,
1057 // Close the last node
1059 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1062 // If there's been an error, stop
1064 if (EFI_ERROR (Status
)) {
1071 SHELL_FREE_NON_NULL(AlignedNode
);
1072 if (EFI_ERROR(Status
)) {
1073 if (Handle1
!= NULL
) {
1074 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1077 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1083 Creates a file or directory by name.
1085 This function creates an empty new file or directory with the specified attributes and
1086 returns the new file's handle. If the file already exists and is read-only, then
1087 EFI_INVALID_PARAMETER will be returned.
1089 If the file already existed, it is truncated and its attributes updated. If the file is
1090 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1092 If the file name begins with >v, then the file handle which is returned refers to the
1093 shell environment variable with the specified name. If the shell environment variable
1094 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1096 @param FileName Pointer to NULL-terminated file path
1097 @param FileAttribs The new file's attrbiutes. the different attributes are
1098 described in EFI_FILE_PROTOCOL.Open().
1099 @param FileHandle On return, points to the created file handle or directory's handle
1101 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1102 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1103 @retval EFI_UNSUPPORTED could not open the file path
1104 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1105 file the file system on the device.
1106 @retval EFI_NO_MEDIA the device has no medium.
1107 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1109 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1111 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1112 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1113 when the media is write-protected.
1114 @retval EFI_ACCESS_DENIED The service denied access to the file.
1115 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1116 @retval EFI_VOLUME_FULL The volume is full.
1121 IN CONST CHAR16
*FileName
,
1122 IN UINT64 FileAttribs
,
1123 OUT SHELL_FILE_HANDLE
*FileHandle
1126 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1130 // Is this for an environment variable
1131 // do we start with >v
1133 if (StrStr(FileName
, L
">v") == FileName
) {
1134 if (!IsVolatileEnv(FileName
+2)) {
1135 return (EFI_INVALID_PARAMETER
);
1137 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1138 return (EFI_SUCCESS
);
1142 // We are opening a regular file.
1144 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1145 if (DevicePath
== NULL
) {
1146 return (EFI_NOT_FOUND
);
1149 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
);
1150 FreePool(DevicePath
);
1156 Register a GUID and a localized human readable name for it.
1158 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1159 names must be used whenever a shell command outputs GUID information.
1161 This function is only available when the major and minor versions in the
1162 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1164 @param[in] Guid A pointer to the GUID being registered.
1165 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1167 @retval EFI_SUCCESS The operation was successful.
1168 @retval EFI_INVALID_PARAMETER Guid was NULL.
1169 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1170 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1174 EfiShellRegisterGuidName(
1175 IN CONST EFI_GUID
*Guid
,
1176 IN CONST CHAR16
*GuidName
1179 return (AddNewGuidNameMapping(Guid
, GuidName
, NULL
));
1183 Opens a file or a directory by file name.
1185 This function opens the specified file in the specified OpenMode and returns a file
1187 If the file name begins with >v, then the file handle which is returned refers to the
1188 shell environment variable with the specified name. If the shell environment variable
1189 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1190 EFI_INVALID_PARAMETER is returned.
1192 If the file name is >i, then the file handle which is returned refers to the standard
1193 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1196 If the file name is >o, then the file handle which is returned refers to the standard
1197 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1200 If the file name is >e, then the file handle which is returned refers to the standard
1201 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1204 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1205 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1208 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1211 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1212 @param FileHandle On return, points to the file handle.
1213 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1214 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1216 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1217 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1218 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1219 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1220 system could not be found on the device. FileHandle is NULL.
1221 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1222 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1223 longer supported. FileHandle is NULL.
1224 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1225 the FileName. FileHandle is NULL.
1226 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1227 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1228 when the media is write-protected. FileHandle is NULL.
1229 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1230 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1232 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1236 EfiShellOpenFileByName(
1237 IN CONST CHAR16
*FileName
,
1238 OUT SHELL_FILE_HANDLE
*FileHandle
,
1242 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1248 // Is this for StdIn
1250 if (StrCmp(FileName
, L
">i") == 0) {
1252 // make sure not writing to StdIn
1254 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1255 return (EFI_INVALID_PARAMETER
);
1257 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1258 ASSERT(*FileHandle
!= NULL
);
1259 return (EFI_SUCCESS
);
1263 // Is this for StdOut
1265 if (StrCmp(FileName
, L
">o") == 0) {
1267 // make sure not writing to StdIn
1269 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1270 return (EFI_INVALID_PARAMETER
);
1272 *FileHandle
= &FileInterfaceStdOut
;
1273 return (EFI_SUCCESS
);
1277 // Is this for NUL file
1279 if (StrCmp(FileName
, L
"NUL") == 0) {
1280 *FileHandle
= &FileInterfaceNulFile
;
1281 return (EFI_SUCCESS
);
1285 // Is this for StdErr
1287 if (StrCmp(FileName
, L
">e") == 0) {
1289 // make sure not writing to StdIn
1291 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1292 return (EFI_INVALID_PARAMETER
);
1294 *FileHandle
= &FileInterfaceStdErr
;
1295 return (EFI_SUCCESS
);
1299 // Is this for an environment variable
1300 // do we start with >v
1302 if (StrStr(FileName
, L
">v") == FileName
) {
1303 if (!IsVolatileEnv(FileName
+2) &&
1304 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1305 return (EFI_INVALID_PARAMETER
);
1307 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1308 return (EFI_SUCCESS
);
1312 // We are opening a regular file.
1314 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1315 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1316 if (DevicePath
== NULL
) {
1317 return (EFI_NOT_FOUND
);
1321 // Copy the device path, open the file, then free the memory
1323 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1324 FreePool(DevicePath
);
1330 Deletes the file specified by the file name.
1332 This function deletes a file.
1334 @param FileName Points to the NULL-terminated file name.
1336 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1337 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1338 @sa EfiShellCreateFile
1342 EfiShellDeleteFileByName(
1343 IN CONST CHAR16
*FileName
1346 SHELL_FILE_HANDLE FileHandle
;
1352 // get a handle to the file
1354 Status
= EfiShellCreateFile(FileName
,
1357 if (EFI_ERROR(Status
)) {
1361 // now delete the file
1363 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1367 Disables the page break output mode.
1371 EfiShellDisablePageBreak (
1375 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1379 Enables the page break output mode.
1383 EfiShellEnablePageBreak (
1387 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1391 internal worker function to load and run an image via device path.
1393 @param ParentImageHandle A handle of the image that is executing the specified
1395 @param DevicePath device path of the file to execute
1396 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1397 containing the command line. If NULL then the command-
1399 @param Environment Points to a NULL-terminated array of environment
1400 variables with the format 'x=y', where x is the
1401 environment variable name and y is the value. If this
1402 is NULL, then the current shell environment is used.
1404 @param[out] StartImageStatus Returned status from gBS->StartImage.
1405 @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
1406 @param[out] ExitData ExitData as returned from gBS->StartImage
1408 @retval EFI_SUCCESS The command executed successfully. The status code
1409 returned by the command is pointed to by StatusCode.
1410 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1411 @retval EFI_OUT_OF_RESOURCES Out of resources.
1412 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1416 InternalShellExecuteDevicePath(
1417 IN CONST EFI_HANDLE
*ParentImageHandle
,
1418 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1419 IN CONST CHAR16
*CommandLine OPTIONAL
,
1420 IN CONST CHAR16
**Environment OPTIONAL
,
1421 OUT EFI_STATUS
*StartImageStatus OPTIONAL
,
1422 OUT UINTN
*ExitDataSize OPTIONAL
,
1423 OUT CHAR16
**ExitData OPTIONAL
1427 EFI_STATUS StartStatus
;
1428 EFI_STATUS CleanupStatus
;
1429 EFI_HANDLE NewHandle
;
1430 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1431 LIST_ENTRY OrigEnvs
;
1432 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1433 UINTN InternalExitDataSize
;
1434 UINTN
*ExitDataSizePtr
;
1438 // ExitDataSize is not OPTIONAL for gBS->BootServices, provide somewhere for
1439 // it to be dumped if the caller doesn't want it.
1440 if (ExitData
== NULL
) {
1441 ExitDataSizePtr
= &InternalExitDataSize
;
1443 ExitDataSizePtr
= ExitDataSize
;
1446 if (ParentImageHandle
== NULL
) {
1447 return (EFI_INVALID_PARAMETER
);
1450 InitializeListHead(&OrigEnvs
);
1455 // Load the image with:
1456 // FALSE - not from boot manager and NULL, 0 being not already in memory
1458 Status
= gBS
->LoadImage(
1461 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1466 if (EFI_ERROR(Status
)) {
1467 if (NewHandle
!= NULL
) {
1468 gBS
->UnloadImage(NewHandle
);
1472 Status
= gBS
->OpenProtocol(
1474 &gEfiLoadedImageProtocolGuid
,
1475 (VOID
**)&LoadedImage
,
1478 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1480 if (!EFI_ERROR(Status
)) {
1481 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1482 if (CommandLine
!= NULL
) {
1483 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(CommandLine
);
1484 LoadedImage
->LoadOptions
= (VOID
*)CommandLine
;
1488 // Save our current environment settings for later restoration if necessary
1490 if (Environment
!= NULL
) {
1491 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1492 if (!EFI_ERROR(Status
)) {
1493 Status
= SetEnvironmentVariables(Environment
);
1498 // Initialize and install a shell parameters protocol on the image.
1500 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1501 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1502 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1503 Status
= UpdateArgcArgv(&ShellParamsProtocol
, CommandLine
, NULL
, NULL
);
1504 ASSERT_EFI_ERROR(Status
);
1506 // Replace Argv[0] with the full path of the binary we're executing:
1507 // If the command line was "foo", the binary might be called "foo.efi".
1508 // "The first entry in [Argv] is always the full file path of the
1509 // executable" - UEFI Shell Spec section 2.3
1511 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1512 // The image we're executing isn't necessarily in a filesystem - it might
1513 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1514 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1515 if (ImagePath
!= NULL
) {
1516 if (ShellParamsProtocol
.Argv
== NULL
) {
1517 // Command line was empty or null.
1518 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1519 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1520 if (ShellParamsProtocol
.Argv
== NULL
) {
1521 Status
= EFI_OUT_OF_RESOURCES
;
1524 ShellParamsProtocol
.Argc
= 1;
1526 // Free the string UpdateArgcArgv put in Argv[0];
1527 FreePool (ShellParamsProtocol
.Argv
[0]);
1529 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1532 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1533 ASSERT_EFI_ERROR(Status
);
1535 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1538 // now start the image, passing up exit data if the caller requested it
1540 if (!EFI_ERROR(Status
)) {
1541 StartStatus
= gBS
->StartImage(
1546 if (StartImageStatus
!= NULL
) {
1547 *StartImageStatus
= StartStatus
;
1550 CleanupStatus
= gBS
->UninstallProtocolInterface(
1552 &gEfiShellParametersProtocolGuid
,
1553 &ShellParamsProtocol
1555 ASSERT_EFI_ERROR(CleanupStatus
);
1561 // Unload image - We should only get here if we didn't call StartImage
1562 gBS
->UnloadImage (NewHandle
);
1565 // Free Argv (Allocated in UpdateArgcArgv)
1566 if (ShellParamsProtocol
.Argv
!= NULL
) {
1567 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1568 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1569 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1572 FreePool (ShellParamsProtocol
.Argv
);
1576 // Restore environment variables
1577 if (!IsListEmpty(&OrigEnvs
)) {
1578 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1579 ASSERT_EFI_ERROR (CleanupStatus
);
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
;
1634 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1635 return (EFI_UNSUPPORTED
);
1638 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1641 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1643 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1645 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1651 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1652 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1653 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1655 Status
= InternalShellExecuteDevicePath(
1659 (CONST CHAR16
**)Environment
,
1664 if (Status
== EFI_ABORTED
) {
1665 // If the command exited with an error, the shell should put the exit
1666 // status in ExitData, preceded by a null-terminated string.
1667 ASSERT (ExitDataSize
== StrSize (ExitData
) + sizeof (SHELL_STATUS
));
1669 if (StatusCode
!= NULL
) {
1670 // Skip the null-terminated string
1671 ExitData
+= StrLen (ExitData
) + 1;
1673 // Use CopyMem to avoid alignment faults
1674 CopyMem (StatusCode
, ExitData
, sizeof (SHELL_STATUS
));
1676 // Convert from SHELL_STATUS to EFI_STATUS
1677 // EFI_STATUSes have top bit set when they are errors.
1678 // (See UEFI Spec Appendix D)
1679 if (*StatusCode
!= SHELL_SUCCESS
) {
1680 *StatusCode
= (EFI_STATUS
) *StatusCode
| MAX_BIT
;
1683 FreePool (ExitData
);
1684 Status
= EFI_SUCCESS
;
1688 // de-allocate and return
1696 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1698 1) frees all pointers (non-NULL)
1699 2) Closes the SHELL_FILE_HANDLE
1701 @param FileListNode pointer to the list node to free
1705 InternalFreeShellFileInfoNode(
1706 IN EFI_SHELL_FILE_INFO
*FileListNode
1709 if (FileListNode
->Info
!= NULL
) {
1710 FreePool((VOID
*)FileListNode
->Info
);
1712 if (FileListNode
->FileName
!= NULL
) {
1713 FreePool((VOID
*)FileListNode
->FileName
);
1715 if (FileListNode
->FullName
!= NULL
) {
1716 FreePool((VOID
*)FileListNode
->FullName
);
1718 if (FileListNode
->Handle
!= NULL
) {
1719 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1721 FreePool(FileListNode
);
1724 Frees the file list.
1726 This function cleans up the file list and any related data structures. It has no
1727 impact on the files themselves.
1729 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1730 defined in OpenFileList()
1732 @retval EFI_SUCCESS Free the file list successfully.
1733 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1737 EfiShellFreeFileList(
1738 IN EFI_SHELL_FILE_INFO
**FileList
1741 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1743 if (FileList
== NULL
|| *FileList
== NULL
) {
1744 return (EFI_INVALID_PARAMETER
);
1747 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1748 ; !IsListEmpty(&(*FileList
)->Link
)
1749 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1751 RemoveEntryList(&ShellFileListItem
->Link
);
1752 InternalFreeShellFileInfoNode(ShellFileListItem
);
1754 InternalFreeShellFileInfoNode(*FileList
);
1756 return(EFI_SUCCESS
);
1760 Deletes the duplicate file names files in the given file list.
1762 This function deletes the reduplicate files in the given file list.
1764 @param FileList A pointer to the first entry in the file list.
1766 @retval EFI_SUCCESS Always success.
1767 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1771 EfiShellRemoveDupInFileList(
1772 IN EFI_SHELL_FILE_INFO
**FileList
1775 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1776 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1777 EFI_SHELL_FILE_INFO
*TempNode
;
1779 if (FileList
== NULL
|| *FileList
== NULL
) {
1780 return (EFI_INVALID_PARAMETER
);
1782 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1783 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1784 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1786 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1787 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1788 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1790 if (gUnicodeCollation
->StriColl(
1792 (CHAR16
*)ShellFileListItem
->FullName
,
1793 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1795 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1797 &ShellFileListItem2
->Link
1799 RemoveEntryList(&ShellFileListItem2
->Link
);
1800 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1801 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1802 // memory in GetNextNode in the loop expression above.
1803 ShellFileListItem2
= TempNode
;
1807 return (EFI_SUCCESS
);
1811 // This is the same structure as the external version, but it has no CONST qualifiers.
1814 LIST_ENTRY Link
; ///< Linked list members.
1815 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1816 CHAR16
*FullName
; ///< Fully qualified filename.
1817 CHAR16
*FileName
; ///< name of this file.
1818 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1819 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1820 } EFI_SHELL_FILE_INFO_NO_CONST
;
1823 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1825 @param[in] Node The node to copy from.
1826 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1828 @retval NULL a memory allocation error ocurred
1829 @return != NULL a pointer to the new node
1831 EFI_SHELL_FILE_INFO
*
1833 InternalDuplicateShellFileInfo(
1834 IN EFI_SHELL_FILE_INFO
*Node
,
1838 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1841 // try to confirm that the objects are in sync
1843 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1845 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1846 if (NewNode
== NULL
) {
1849 NewNode
->FullName
= AllocateZeroPool(StrSize(Node
->FullName
));
1851 NewNode
->FileName
= AllocateZeroPool(StrSize(Node
->FileName
));
1852 NewNode
->Info
= AllocateZeroPool((UINTN
)Node
->Info
->Size
);
1853 if ( NewNode
->FullName
== NULL
1854 || NewNode
->FileName
== NULL
1855 || NewNode
->Info
== NULL
1857 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1858 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1859 SHELL_FREE_NON_NULL(NewNode
->Info
);
1860 SHELL_FREE_NON_NULL(NewNode
);
1863 NewNode
->Status
= Node
->Status
;
1864 NewNode
->Handle
= Node
->Handle
;
1866 Node
->Handle
= NULL
;
1868 StrCpy((CHAR16
*)NewNode
->FullName
, Node
->FullName
);
1869 StrCpy((CHAR16
*)NewNode
->FileName
, Node
->FileName
);
1870 CopyMem(NewNode
->Info
, Node
->Info
, (UINTN
)Node
->Info
->Size
);
1872 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1876 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1877 failed it will return NULL.
1879 @param[in] BasePath the Path to prepend onto filename for FullPath
1880 @param[in] Status Status member initial value.
1881 @param[in] FileName FileName member initial value.
1882 @param[in] Handle Handle member initial value.
1883 @param[in] Info Info struct to copy.
1885 @retval NULL An error ocurred.
1886 @return a pointer to the newly allocated structure.
1888 EFI_SHELL_FILE_INFO
*
1890 CreateAndPopulateShellFileInfo(
1891 IN CONST CHAR16
*BasePath
,
1892 IN CONST EFI_STATUS Status
,
1893 IN CONST CHAR16
*FileName
,
1894 IN CONST SHELL_FILE_HANDLE Handle
,
1895 IN CONST EFI_FILE_INFO
*Info
1898 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1905 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1906 if (ShellFileListItem
== NULL
) {
1909 if (Info
!= NULL
&& Info
->Size
!= 0) {
1910 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1911 if (ShellFileListItem
->Info
== NULL
) {
1912 FreePool(ShellFileListItem
);
1915 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1917 ShellFileListItem
->Info
= NULL
;
1919 if (FileName
!= NULL
) {
1920 ASSERT(TempString
== NULL
);
1921 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1922 if (ShellFileListItem
->FileName
== NULL
) {
1923 FreePool(ShellFileListItem
->Info
);
1924 FreePool(ShellFileListItem
);
1928 ShellFileListItem
->FileName
= NULL
;
1932 if (BasePath
!= NULL
) {
1933 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1934 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1935 if (TempString
== NULL
) {
1936 FreePool((VOID
*)ShellFileListItem
->FileName
);
1937 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1938 FreePool(ShellFileListItem
);
1942 if (ShellFileListItem
->FileName
!= NULL
) {
1943 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1944 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1945 if (TempString
== NULL
) {
1946 FreePool((VOID
*)ShellFileListItem
->FileName
);
1947 FreePool(ShellFileListItem
->Info
);
1948 FreePool(ShellFileListItem
);
1953 TempString
= PathCleanUpDirectories(TempString
);
1955 ShellFileListItem
->FullName
= TempString
;
1956 ShellFileListItem
->Status
= Status
;
1957 ShellFileListItem
->Handle
= Handle
;
1959 return (ShellFileListItem
);
1963 Find all files in a specified directory.
1965 @param FileDirHandle Handle of the directory to search.
1966 @param FileList On return, points to the list of files in the directory
1967 or NULL if there are no files in the directory.
1969 @retval EFI_SUCCESS File information was returned successfully.
1970 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1971 @retval EFI_DEVICE_ERROR The device reported an error.
1972 @retval EFI_NO_MEDIA The device media is not present.
1973 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1974 @return An error from FileHandleGetFileName().
1978 EfiShellFindFilesInDir(
1979 IN SHELL_FILE_HANDLE FileDirHandle
,
1980 OUT EFI_SHELL_FILE_INFO
**FileList
1983 EFI_SHELL_FILE_INFO
*ShellFileList
;
1984 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1985 EFI_FILE_INFO
*FileInfo
;
1994 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1995 if (EFI_ERROR(Status
)) {
1999 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
2002 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
2003 if (TempString
== NULL
) {
2004 SHELL_FREE_NON_NULL(BasePath
);
2005 return (EFI_OUT_OF_RESOURCES
);
2007 TempSpot
= StrStr(TempString
, L
";");
2009 if (TempSpot
!= NULL
) {
2010 *TempSpot
= CHAR_NULL
;
2013 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2014 if (TempString
== NULL
) {
2015 SHELL_FREE_NON_NULL(BasePath
);
2016 return (EFI_OUT_OF_RESOURCES
);
2018 SHELL_FREE_NON_NULL(BasePath
);
2019 BasePath
= TempString
;
2023 ShellFileList
= NULL
;
2024 ShellFileListItem
= NULL
;
2026 Status
= EFI_SUCCESS
;
2029 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2030 ; !EFI_ERROR(Status
) && !NoFile
2031 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2034 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2036 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2038 EFI_SUCCESS
, // success since we didnt fail to open it...
2040 NULL
, // no handle since not open
2043 if (ShellFileList
== NULL
) {
2044 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2045 ASSERT(ShellFileList
!= NULL
);
2046 InitializeListHead(&ShellFileList
->Link
);
2048 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2050 if (EFI_ERROR(Status
)) {
2051 EfiShellFreeFileList(&ShellFileList
);
2054 *FileList
= ShellFileList
;
2056 SHELL_FREE_NON_NULL(BasePath
);
2061 Get the GUID value from a human readable name.
2063 If GuidName is a known GUID name, then update Guid to have the correct value for
2066 This function is only available when the major and minor versions in the
2067 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2069 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2070 @param[out] Guid A pointer to the GUID structure to be filled in.
2072 @retval EFI_SUCCESS The operation was successful.
2073 @retval EFI_INVALID_PARAMETER Guid was NULL.
2074 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2075 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2079 EfiShellGetGuidFromName(
2080 IN CONST CHAR16
*GuidName
,
2087 if (Guid
== NULL
|| GuidName
== NULL
) {
2088 return (EFI_INVALID_PARAMETER
);
2091 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2093 if (!EFI_ERROR(Status
)) {
2094 CopyGuid(NewGuid
, Guid
);
2101 Get the human readable name for a GUID from the value.
2103 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2104 should not modify the value.
2106 This function is only available when the major and minor versions in the
2107 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2109 @param[in] Guid A pointer to the GUID being queried.
2110 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2112 @retval EFI_SUCCESS The operation was successful.
2113 @retval EFI_INVALID_PARAMETER Guid was NULL.
2114 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2115 @retval EFI_NOT_FOUND Guid is not assigned a name.
2119 EfiShellGetGuidName(
2120 IN CONST EFI_GUID
*Guid
,
2121 OUT CONST CHAR16
**GuidName
2126 if (Guid
== NULL
|| GuidName
== NULL
) {
2127 return (EFI_INVALID_PARAMETER
);
2130 Name
= GetStringNameFromGuid(Guid
, NULL
);
2131 if (Name
== NULL
|| StrLen(Name
) == 0) {
2132 SHELL_FREE_NON_NULL(Name
);
2133 return (EFI_NOT_FOUND
);
2136 *GuidName
= AddBufferToFreeList(Name
);
2138 return (EFI_SUCCESS
);
2142 Updates a file name to be preceeded by the mapped drive name
2144 @param[in] BasePath the Mapped drive name to prepend
2145 @param[in, out] Path pointer to pointer to the file name to update.
2148 @retval EFI_OUT_OF_RESOURCES
2153 IN CONST CHAR16
*BasePath
,
2154 IN OUT CHAR16
**Path
2163 ASSERT(Path
!= NULL
);
2164 ASSERT(*Path
!= NULL
);
2165 ASSERT(BasePath
!= NULL
);
2168 // convert a local path to an absolute path
2170 if (StrStr(*Path
, L
":") == NULL
) {
2171 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2172 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2173 if (Path2
== NULL
) {
2174 return (EFI_OUT_OF_RESOURCES
);
2176 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2177 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2178 if (Path2
== NULL
) {
2179 return (EFI_OUT_OF_RESOURCES
);
2186 return (EFI_SUCCESS
);
2190 If FileHandle is a directory then the function reads from FileHandle and reads in
2191 each of the FileInfo structures. If one of them matches the Pattern's first
2192 "level" then it opens that handle and calls itself on that handle.
2194 If FileHandle is a file and matches all of the remaining Pattern (which would be
2195 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2197 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2198 FreeFileList with FileList.
2200 @param[in] FilePattern The FilePattern to check against.
2201 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2202 @param[in] FileHandle The FileHandle to start with
2203 @param[in, out] FileList pointer to pointer to list of found files.
2204 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2205 @param[in] MapName The file system name this file is on.
2207 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2208 @retval EFI_NOT_FOUND no files were found
2209 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2214 IN CONST CHAR16
*FilePattern
,
2215 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2216 IN SHELL_FILE_HANDLE FileHandle
,
2217 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2218 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2219 IN CONST CHAR16
*MapName
2223 CONST CHAR16
*NextFilePatternStart
;
2224 CHAR16
*CurrentFilePattern
;
2225 EFI_SHELL_FILE_INFO
*ShellInfo
;
2226 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2227 EFI_SHELL_FILE_INFO
*NewShellNode
;
2228 EFI_FILE_INFO
*FileInfo
;
2230 CHAR16
*NewFullName
;
2233 if ( FilePattern
== NULL
2234 || UnicodeCollation
== NULL
2237 return (EFI_INVALID_PARAMETER
);
2240 CurrentFilePattern
= NULL
;
2242 if (*FilePattern
== L
'\\') {
2246 for( NextFilePatternStart
= FilePattern
2247 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2248 ; NextFilePatternStart
++);
2250 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2251 ASSERT(CurrentFilePattern
!= NULL
);
2252 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2254 if (CurrentFilePattern
[0] == CHAR_NULL
2255 &&NextFilePatternStart
[0] == CHAR_NULL
2258 // we want the parent or root node (if no parent)
2260 if (ParentNode
== NULL
) {
2262 // We want the root node. create the node.
2264 FileInfo
= FileHandleGetInfo(FileHandle
);
2265 NewShellNode
= CreateAndPopulateShellFileInfo(
2272 SHELL_FREE_NON_NULL(FileInfo
);
2275 // Add the current parameter FileHandle to the list, then end...
2277 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2279 if (NewShellNode
== NULL
) {
2280 Status
= EFI_OUT_OF_RESOURCES
;
2282 NewShellNode
->Handle
= NULL
;
2283 if (*FileList
== NULL
) {
2284 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2285 InitializeListHead(&((*FileList
)->Link
));
2289 // Add to the returning to use list
2291 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2293 Status
= EFI_SUCCESS
;
2296 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2298 if (!EFI_ERROR(Status
)){
2299 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2304 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2305 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2306 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2308 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2309 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2310 Size
= StrSize(ShellInfoNode
->FullName
);
2311 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2312 NewFullName
= AllocateZeroPool(Size
);
2313 if (NewFullName
== NULL
) {
2314 Status
= EFI_OUT_OF_RESOURCES
;
2316 StrCpy(NewFullName
, MapName
);
2317 StrCat(NewFullName
, ShellInfoNode
->FullName
+1);
2318 FreePool((VOID
*)ShellInfoNode
->FullName
);
2319 ShellInfoNode
->FullName
= NewFullName
;
2322 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2324 // should be a directory
2328 // don't open the . and .. directories
2330 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2331 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2336 if (EFI_ERROR(Status
)) {
2340 // Open the directory since we need that handle in the next recursion.
2342 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2345 // recurse with the next part of the pattern
2347 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2349 } else if (!EFI_ERROR(Status
)) {
2355 // copy the information we need into a new Node
2357 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2358 ASSERT(NewShellNode
!= NULL
);
2359 if (NewShellNode
== NULL
) {
2360 Status
= EFI_OUT_OF_RESOURCES
;
2362 if (*FileList
== NULL
) {
2363 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2364 InitializeListHead(&((*FileList
)->Link
));
2368 // Add to the returning to use list
2370 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2373 if (EFI_ERROR(Status
)) {
2377 if (EFI_ERROR(Status
)) {
2378 EfiShellFreeFileList(&ShellInfo
);
2380 Status
= EfiShellFreeFileList(&ShellInfo
);
2385 FreePool(CurrentFilePattern
);
2390 Find files that match a specified pattern.
2392 This function searches for all files and directories that match the specified
2393 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2394 information is placed in the file list FileList.
2396 Wildcards are processed
2397 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2399 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2400 field is set to NULL.
2402 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2404 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2405 @param FileList On return, points to the start of a file list containing the names
2406 of all matching files or else points to NULL if no matching files
2407 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2409 @retval EFI_SUCCESS Files found. FileList is a valid list.
2410 @retval EFI_NOT_FOUND No files found.
2411 @retval EFI_NO_MEDIA The device has no media
2412 @retval EFI_DEVICE_ERROR The device reported an error
2413 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2418 IN CONST CHAR16
*FilePattern
,
2419 OUT EFI_SHELL_FILE_INFO
**FileList
2423 CHAR16
*PatternCopy
;
2424 CHAR16
*PatternCurrentLocation
;
2425 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2426 SHELL_FILE_HANDLE RootFileHandle
;
2430 if ( FilePattern
== NULL
2432 || StrStr(FilePattern
, L
":") == NULL
2434 return (EFI_INVALID_PARAMETER
);
2436 Status
= EFI_SUCCESS
;
2437 RootDevicePath
= NULL
;
2438 RootFileHandle
= NULL
;
2440 PatternCopy
= AllocateZeroPool(StrSize(FilePattern
));
2441 if (PatternCopy
== NULL
) {
2442 return (EFI_OUT_OF_RESOURCES
);
2444 StrCpy(PatternCopy
, FilePattern
);
2446 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2448 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2451 ASSERT(MapName
== NULL
);
2452 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2453 if (MapName
== NULL
) {
2454 Status
= EFI_OUT_OF_RESOURCES
;
2456 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2457 if (RootDevicePath
== NULL
) {
2458 Status
= EFI_INVALID_PARAMETER
;
2460 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2461 if (!EFI_ERROR(Status
)) {
2462 for ( PatternCurrentLocation
= PatternCopy
2463 ; *PatternCurrentLocation
!= ':'
2464 ; PatternCurrentLocation
++);
2465 PatternCurrentLocation
++;
2466 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2468 FreePool(RootDevicePath
);
2472 SHELL_FREE_NON_NULL(PatternCopy
);
2473 SHELL_FREE_NON_NULL(MapName
);
2479 Opens the files that match the path specified.
2481 This function opens all of the files specified by Path. Wildcards are processed
2482 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2483 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2485 @param Path A pointer to the path string.
2486 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2487 EFI_FILE_MODE_WRITE.
2488 @param FileList Points to the start of a list of files opened.
2490 @retval EFI_SUCCESS Create the file list successfully.
2491 @return Others Can't create the file list.
2495 EfiShellOpenFileList(
2498 IN OUT EFI_SHELL_FILE_INFO
**FileList
2502 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2505 CONST CHAR16
*CurDir
;
2508 PathCleanUpDirectories(Path
);
2513 if (FileList
== NULL
|| *FileList
== NULL
) {
2514 return (EFI_INVALID_PARAMETER
);
2517 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2522 // convert a local path to an absolute path
2524 if (StrStr(Path
, L
":") == NULL
) {
2525 CurDir
= EfiShellGetCurDir(NULL
);
2526 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2527 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2528 if (*Path
== L
'\\') {
2530 while (PathRemoveLastItem(Path2
)) ;
2532 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2533 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2535 ASSERT(Path2
== NULL
);
2536 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2539 PathCleanUpDirectories (Path2
);
2544 Status
= EfiShellFindFiles(Path2
, FileList
);
2548 if (EFI_ERROR(Status
)) {
2554 // We had no errors so open all the files (that are not already opened...)
2556 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2557 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2558 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2560 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2561 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2567 return (EFI_NOT_FOUND
);
2569 return(EFI_SUCCESS
);
2573 Gets the environment variable and Attributes, or list of environment variables. Can be
2574 used instead of GetEnv().
2576 This function returns the current value of the specified environment variable and
2577 the Attributes. If no variable name was specified, then all of the known
2578 variables will be returned.
2580 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2581 then the function will return all of the defined shell
2582 environment variables. In the case where multiple environment
2583 variables are being returned, each variable will be terminated
2584 by a NULL, and the list will be terminated by a double NULL.
2585 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2586 the environment variable. In the case where Name is NULL, and
2587 multiple environment variables are being returned, Attributes
2590 @retval NULL The environment variable doesn't exist.
2591 @return A non-NULL value points to the variable's value. The returned
2592 pointer does not need to be freed by the caller.
2597 IN CONST CHAR16
*Name
,
2598 OUT UINT32
*Attributes OPTIONAL
2606 CHAR16
*CurrentWriteLocation
;
2613 // Get all our environment variables
2615 InitializeListHead(&List
);
2616 Status
= GetEnvironmentVariableList(&List
);
2617 if (EFI_ERROR(Status
)){
2622 // Build the semi-colon delimited list. (2 passes)
2624 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2625 ; !IsNull(&List
, &Node
->Link
)
2626 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2628 ASSERT(Node
->Key
!= NULL
);
2629 Size
+= StrSize(Node
->Key
);
2632 Size
+= 2*sizeof(CHAR16
);
2634 Buffer
= AllocateZeroPool(Size
);
2635 if (Buffer
== NULL
) {
2636 if (!IsListEmpty (&List
)) {
2637 FreeEnvironmentVariableList(&List
);
2641 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2643 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2644 ; !IsNull(&List
, &Node
->Link
)
2645 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2647 ASSERT(Node
->Key
!= NULL
);
2648 StrCpy(CurrentWriteLocation
, Node
->Key
);
2649 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2655 if (!IsListEmpty (&List
)) {
2656 FreeEnvironmentVariableList(&List
);
2660 // We are doing a specific environment variable
2664 // get the size we need for this EnvVariable
2666 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2667 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2669 // Allocate the space and recall the get function
2671 Buffer
= AllocateZeroPool(Size
);
2672 ASSERT(Buffer
!= NULL
);
2673 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2676 // we didnt get it (might not exist)
2677 // free the memory if we allocated any and return NULL
2679 if (EFI_ERROR(Status
)) {
2680 if (Buffer
!= NULL
) {
2688 // return the buffer
2690 return (AddBufferToFreeList(Buffer
));
2694 Gets either a single or list of environment variables.
2696 If name is not NULL then this function returns the current value of the specified
2697 environment variable.
2699 If Name is NULL, then a list of all environment variable names is returned. Each is a
2700 NULL terminated string with a double NULL terminating the list.
2702 @param Name A pointer to the environment variable name. If
2703 Name is NULL, then the function will return all
2704 of the defined shell environment variables. In
2705 the case where multiple environment variables are
2706 being returned, each variable will be terminated by
2707 a NULL, and the list will be terminated by a double
2710 @retval !=NULL A pointer to the returned string.
2711 The returned pointer does not need to be freed by the caller.
2713 @retval NULL The environment variable doesn't exist or there are
2714 no environment variables.
2719 IN CONST CHAR16
*Name
2722 return (EfiShellGetEnvEx(Name
, NULL
));
2726 Internal variable setting function. Allows for setting of the read only variables.
2728 @param Name Points to the NULL-terminated environment variable name.
2729 @param Value Points to the NULL-terminated environment variable value. If the value is an
2730 empty string then the environment variable is deleted.
2731 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2733 @retval EFI_SUCCESS The environment variable was successfully updated.
2737 InternalEfiShellSetEnv(
2738 IN CONST CHAR16
*Name
,
2739 IN CONST CHAR16
*Value
,
2743 if (Value
== NULL
|| StrLen(Value
) == 0) {
2744 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2746 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2748 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2750 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2756 Sets the environment variable.
2758 This function changes the current value of the specified environment variable. If the
2759 environment variable exists and the Value is an empty string, then the environment
2760 variable is deleted. If the environment variable exists and the Value is not an empty
2761 string, then the value of the environment variable is changed. If the environment
2762 variable does not exist and the Value is an empty string, there is no action. If the
2763 environment variable does not exist and the Value is a non-empty string, then the
2764 environment variable is created and assigned the specified value.
2766 For a description of volatile and non-volatile environment variables, see UEFI Shell
2767 2.0 specification section 3.6.1.
2769 @param Name Points to the NULL-terminated environment variable name.
2770 @param Value Points to the NULL-terminated environment variable value. If the value is an
2771 empty string then the environment variable is deleted.
2772 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2774 @retval EFI_SUCCESS The environment variable was successfully updated.
2779 IN CONST CHAR16
*Name
,
2780 IN CONST CHAR16
*Value
,
2784 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2785 return (EFI_INVALID_PARAMETER
);
2788 // Make sure we dont 'set' a predefined read only variable
2790 if (gUnicodeCollation
->StriColl(
2794 ||gUnicodeCollation
->StriColl(
2798 ||gUnicodeCollation
->StriColl(
2802 ||gUnicodeCollation
->StriColl(
2805 L
"uefishellsupport") == 0
2806 ||gUnicodeCollation
->StriColl(
2809 L
"uefishellversion") == 0
2810 ||gUnicodeCollation
->StriColl(
2813 L
"uefiversion") == 0
2815 return (EFI_INVALID_PARAMETER
);
2817 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2821 Returns the current directory on the specified device.
2823 If FileSystemMapping is NULL, it returns the current working directory. If the
2824 FileSystemMapping is not NULL, it returns the current directory associated with the
2825 FileSystemMapping. In both cases, the returned name includes the file system
2826 mapping (i.e. fs0:\current-dir).
2828 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2829 then the current working directory is returned.
2831 @retval !=NULL The current directory.
2832 @retval NULL Current directory does not exist.
2837 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2840 CHAR16
*PathToReturn
;
2842 SHELL_MAP_LIST
*MapListItem
;
2843 if (!IsListEmpty(&gShellMapList
.Link
)) {
2845 // if parameter is NULL, use current
2847 if (FileSystemMapping
== NULL
) {
2848 return (EfiShellGetEnv(L
"cwd"));
2851 PathToReturn
= NULL
;
2852 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2853 if (MapListItem
!= NULL
) {
2854 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2855 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2856 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2859 return (AddBufferToFreeList(PathToReturn
));
2866 Changes the current directory on the specified device.
2868 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2869 mapped name, this function changes the current working directory.
2871 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2872 current file system and the current directory on that file system are changed.
2874 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2877 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2878 directory on the specified file system.
2880 If the current working directory or the current working file system is changed then the
2881 %cwd% environment variable will be updated
2883 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2884 directory is changed.
2885 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2887 @retval EFI_SUCCESS The operation was sucessful
2888 @retval EFI_NOT_FOUND The file system could not be found
2893 IN CONST CHAR16
*FileSystem OPTIONAL
,
2894 IN CONST CHAR16
*Dir
2898 SHELL_MAP_LIST
*MapListItem
;
2902 CHAR16
*DirectoryName
;
2909 DirectoryName
= NULL
;
2911 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2912 return (EFI_INVALID_PARAMETER
);
2915 if (IsListEmpty(&gShellMapList
.Link
)){
2916 return (EFI_NOT_FOUND
);
2919 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2920 ASSERT(DirectoryName
!= NULL
);
2922 PathCleanUpDirectories(DirectoryName
);
2924 if (FileSystem
== NULL
) {
2926 // determine the file system mapping to use
2928 if (StrStr(DirectoryName
, L
":") != NULL
) {
2929 ASSERT(MapName
== NULL
);
2930 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2933 // find the file system mapping's entry in the list
2936 if (MapName
!= NULL
) {
2937 MapListItem
= ShellCommandFindMapItem(MapName
);
2940 // make that the current file system mapping
2942 if (MapListItem
!= NULL
) {
2943 gShellCurDir
= MapListItem
;
2946 MapListItem
= gShellCurDir
;
2949 if (MapListItem
== NULL
) {
2950 return (EFI_NOT_FOUND
);
2954 // now update the MapListItem's current directory
2956 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2957 FreePool(MapListItem
->CurrentDirectoryPath
);
2958 MapListItem
->CurrentDirectoryPath
= NULL
;
2960 if (MapName
!= NULL
) {
2961 TempLen
= StrLen(MapName
);
2962 if (TempLen
!= StrLen(DirectoryName
)) {
2963 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2964 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2967 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2968 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2970 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2971 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2972 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2976 // cant have a mapping in the directory...
2978 if (StrStr(DirectoryName
, L
":") != NULL
) {
2979 return (EFI_INVALID_PARAMETER
);
2982 // FileSystem != NULL
2984 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2985 if (MapListItem
== NULL
) {
2986 return (EFI_INVALID_PARAMETER
);
2988 // gShellCurDir = MapListItem;
2989 if (DirectoryName
!= NULL
) {
2991 // change current dir on that file system
2994 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2995 FreePool(MapListItem
->CurrentDirectoryPath
);
2996 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2998 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2999 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
3000 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3001 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3002 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3003 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3004 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
3005 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3006 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3011 // if updated the current directory then update the environment variable
3013 if (MapListItem
== gShellCurDir
) {
3015 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3016 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3017 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3018 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3019 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3020 FreePool(TempString
);
3023 return(EFI_SUCCESS
);
3027 Return help information about a specific command.
3029 This function returns the help information for the specified command. The help text
3030 can be internal to the shell or can be from a UEFI Shell manual page.
3032 If Sections is specified, then each section name listed will be compared in a casesensitive
3033 manner, to the section names described in Appendix B. If the section exists,
3034 it will be appended to the returned help text. If the section does not exist, no
3035 information will be returned. If Sections is NULL, then all help text information
3036 available will be returned.
3038 @param Command Points to the NULL-terminated UEFI Shell command name.
3039 @param Sections Points to the NULL-terminated comma-delimited
3040 section names to return. If NULL, then all
3041 sections will be returned.
3042 @param HelpText On return, points to a callee-allocated buffer
3043 containing all specified help text.
3045 @retval EFI_SUCCESS The help text was returned.
3046 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3048 @retval EFI_INVALID_PARAMETER HelpText is NULL
3049 @retval EFI_NOT_FOUND There is no help text available for Command.
3053 EfiShellGetHelpText(
3054 IN CONST CHAR16
*Command
,
3055 IN CONST CHAR16
*Sections OPTIONAL
,
3056 OUT CHAR16
**HelpText
3059 CONST CHAR16
*ManFileName
;
3063 ASSERT(HelpText
!= NULL
);
3066 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3068 if (ManFileName
!= NULL
) {
3069 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3071 if ((StrLen(Command
)> 4)
3072 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3073 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3074 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3075 && (Command
[StrLen(Command
)-4] == L
'.')
3077 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3078 ASSERT(FixCommand
!= NULL
);
3080 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
3081 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3082 FreePool(FixCommand
);
3085 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3091 Gets the enable status of the page break output mode.
3093 User can use this function to determine current page break mode.
3095 @retval TRUE The page break output mode is enabled.
3096 @retval FALSE The page break output mode is disabled.
3100 EfiShellGetPageBreak(
3104 return(ShellInfoObject
.PageBreakEnabled
);
3108 Judges whether the active shell is the root shell.
3110 This function makes the user to know that whether the active Shell is the root shell.
3112 @retval TRUE The active Shell is the root Shell.
3113 @retval FALSE The active Shell is NOT the root Shell.
3117 EfiShellIsRootShell(
3121 return(ShellInfoObject
.RootShellInstance
);
3125 function to return a semi-colon delimeted list of all alias' in the current shell
3127 up to caller to free the memory.
3129 @retval NULL No alias' were found
3130 @retval NULL An error ocurred getting alias'
3131 @return !NULL a list of all alias'
3135 InternalEfiShellGetListAlias(
3143 CHAR16
*VariableName
;
3148 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
3149 ASSERT_EFI_ERROR(Status
);
3151 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
3155 if (VariableName
== NULL
) {
3159 VariableName
[0] = CHAR_NULL
;
3162 NameSize
= (UINTN
)MaxVarSize
;
3163 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3164 if (Status
== EFI_NOT_FOUND
){
3167 ASSERT_EFI_ERROR(Status
);
3168 if (EFI_ERROR(Status
)) {
3171 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3172 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3173 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3174 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3177 FreePool(VariableName
);
3183 Convert a null-terminated unicode string, in-place, to all lowercase.
3186 @param Str The null-terminated string to be converted to all lowercase.
3188 @return The null-terminated string converted into all lowercase.
3197 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3198 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3199 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3206 This function returns the command associated with a alias or a list of all
3209 @param[in] Alias Points to the NULL-terminated shell alias.
3210 If this parameter is NULL, then all
3211 aliases will be returned in ReturnedData.
3212 @param[out] Volatile upon return of a single command if TRUE indicates
3213 this is stored in a volatile fashion. FALSE otherwise.
3215 @return If Alias is not NULL, it will return a pointer to
3216 the NULL-terminated command for that alias.
3217 If Alias is NULL, ReturnedData points to a ';'
3218 delimited list of alias (e.g.
3219 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3220 @retval NULL an error ocurred
3221 @retval NULL Alias was not a valid Alias
3226 IN CONST CHAR16
*Alias
,
3227 OUT BOOLEAN
*Volatile OPTIONAL
3236 // Convert to lowercase to make aliases case-insensitive
3237 if (Alias
!= NULL
) {
3238 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3239 ASSERT (AliasLower
!= NULL
);
3240 ToLower (AliasLower
);
3242 if (Volatile
== NULL
) {
3243 return (AddBufferToFreeList(GetVariable(AliasLower
, &gShellAliasGuid
)));
3247 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3248 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3249 RetVal
= AllocateZeroPool(RetSize
);
3250 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3252 if (EFI_ERROR(Status
)) {
3253 if (RetVal
!= NULL
) {
3258 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3264 FreePool (AliasLower
);
3265 return (AddBufferToFreeList(RetVal
));
3267 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3271 Changes a shell command alias.
3273 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3275 this function does not check for built in alias'.
3277 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3278 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3279 Command refers to an alias, that alias will be deleted.
3280 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3281 Alias being set will be stored in a non-volatile fashion.
3283 @retval EFI_SUCCESS Alias created or deleted successfully.
3284 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3289 IN CONST CHAR16
*Command
,
3290 IN CONST CHAR16
*Alias
,
3297 // Convert to lowercase to make aliases case-insensitive
3298 if (Alias
!= NULL
) {
3299 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3300 ASSERT (AliasLower
!= NULL
);
3301 ToLower (AliasLower
);
3307 // We must be trying to remove one if Alias is NULL
3309 if (Alias
== NULL
) {
3311 // remove an alias (but passed in COMMAND parameter)
3313 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3316 // Add and replace are the same
3319 // We dont check the error return on purpose since the variable may not exist.
3320 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3322 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3325 if (Alias
!= NULL
) {
3326 FreePool (AliasLower
);
3332 Changes a shell command alias.
3334 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3337 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3338 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3339 Command refers to an alias, that alias will be deleted.
3340 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3341 FALSE and the alias already exists, then the existing alias is unchanged and
3342 EFI_ACCESS_DENIED is returned.
3343 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3344 Alias being set will be stored in a non-volatile fashion.
3346 @retval EFI_SUCCESS Alias created or deleted successfully.
3347 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3348 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3350 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3355 IN CONST CHAR16
*Command
,
3356 IN CONST CHAR16
*Alias
,
3361 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3363 // cant set over a built in alias
3365 return (EFI_ACCESS_DENIED
);
3366 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3368 // Command is null or empty
3370 return (EFI_INVALID_PARAMETER
);
3371 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3373 // Alias already exists, Replace not set
3375 return (EFI_ACCESS_DENIED
);
3377 return (InternalSetAlias(Command
, Alias
, Volatile
));
3381 // Pure FILE_HANDLE operations are passed to FileHandleLib
3382 // these functions are indicated by the *
3383 EFI_SHELL_PROTOCOL mShellProtocol
= {
3389 EfiShellGetHelpText
,
3390 EfiShellGetDevicePathFromMap
,
3391 EfiShellGetMapFromDevicePath
,
3392 EfiShellGetDevicePathFromFilePath
,
3393 EfiShellGetFilePathFromDevicePath
,
3397 EfiShellOpenFileList
,
3398 EfiShellFreeFileList
,
3399 EfiShellRemoveDupInFileList
,
3400 EfiShellBatchIsActive
,
3401 EfiShellIsRootShell
,
3402 EfiShellEnablePageBreak
,
3403 EfiShellDisablePageBreak
,
3404 EfiShellGetPageBreak
,
3405 EfiShellGetDeviceName
,
3406 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3407 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3408 EfiShellOpenFileByName
,
3411 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3412 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3413 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3414 EfiShellDeleteFileByName
,
3415 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3416 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3417 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3419 EfiShellFindFilesInDir
,
3420 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3422 EfiShellOpenRootByHandle
,
3424 SHELL_MAJOR_VERSION
,
3425 SHELL_MINOR_VERSION
,
3427 // New for UEFI Shell 2.1
3428 EfiShellRegisterGuidName
,
3429 EfiShellGetGuidName
,
3430 EfiShellGetGuidFromName
,
3435 Function to create and install on the current handle.
3437 Will overwrite any existing ShellProtocols in the system to be sure that
3438 the current shell is in control.
3440 This must be removed via calling CleanUpShellProtocol().
3442 @param[in, out] NewShell The pointer to the pointer to the structure
3445 @retval EFI_SUCCESS The operation was successful.
3446 @return An error from LocateHandle, CreateEvent, or other core function.
3450 CreatePopulateInstallShellProtocol (
3451 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3457 UINTN HandleCounter
;
3458 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3460 if (NewShell
== NULL
) {
3461 return (EFI_INVALID_PARAMETER
);
3466 OldProtocolNode
= NULL
;
3467 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3470 // Initialize EfiShellProtocol object...
3472 Status
= gBS
->CreateEvent(0,
3476 &mShellProtocol
.ExecutionBreak
);
3477 if (EFI_ERROR(Status
)) {
3482 // Get the size of the buffer we need.
3484 Status
= gBS
->LocateHandle(ByProtocol
,
3485 &gEfiShellProtocolGuid
,
3489 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3491 // Allocate and recall with buffer of correct size
3493 Buffer
= AllocateZeroPool(BufferSize
);
3494 if (Buffer
== NULL
) {
3495 return (EFI_OUT_OF_RESOURCES
);
3497 Status
= gBS
->LocateHandle(ByProtocol
,
3498 &gEfiShellProtocolGuid
,
3502 if (EFI_ERROR(Status
)) {
3507 // now overwrite each of them, but save the info to restore when we end.
3509 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3510 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3511 ASSERT(OldProtocolNode
!= NULL
);
3512 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3513 &gEfiShellProtocolGuid
,
3514 (VOID
**) &(OldProtocolNode
->Interface
),
3517 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3519 if (!EFI_ERROR(Status
)) {
3521 // reinstall over the old one...
3523 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3524 Status
= gBS
->ReinstallProtocolInterface(
3525 OldProtocolNode
->Handle
,
3526 &gEfiShellProtocolGuid
,
3527 OldProtocolNode
->Interface
,
3528 (VOID
*)(&mShellProtocol
));
3529 if (!EFI_ERROR(Status
)) {
3531 // we reinstalled sucessfully. log this so we can reverse it later.
3535 // add to the list for subsequent...
3537 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3542 } else if (Status
== EFI_NOT_FOUND
) {
3543 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3545 // no one else published yet. just publish it ourselves.
3547 Status
= gBS
->InstallProtocolInterface (
3549 &gEfiShellProtocolGuid
,
3550 EFI_NATIVE_INTERFACE
,
3551 (VOID
*)(&mShellProtocol
));
3554 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3555 ///@todo support ShellEnvironment2
3556 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3559 if (!EFI_ERROR(Status
)) {
3560 *NewShell
= &mShellProtocol
;
3566 Opposite of CreatePopulateInstallShellProtocol.
3568 Free all memory and restore the system to the state it was in before calling
3569 CreatePopulateInstallShellProtocol.
3571 @param[in, out] NewShell The pointer to the new shell protocol structure.
3573 @retval EFI_SUCCESS The operation was successful.
3577 CleanUpShellProtocol (
3578 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3582 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3583 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3586 // if we need to restore old protocols...
3588 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3589 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3590 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3591 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3593 RemoveEntryList(&Node2
->Link
);
3594 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3595 &gEfiShellProtocolGuid
,
3602 // no need to restore
3604 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3605 &gEfiShellProtocolGuid
,
3608 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3609 NewShell
->ExecutionBreak
= NULL
;
3611 Status
= gBS
->OpenProtocol(
3612 gST
->ConsoleInHandle
,
3613 &gEfiSimpleTextInputExProtocolGuid
,
3617 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3619 if (!EFI_ERROR (Status
)) {
3620 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3621 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3622 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3623 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3624 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3625 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3626 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3627 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3633 Notification function for keystrokes.
3635 @param[in] KeyData The key that was pressed.
3637 @retval EFI_SUCCESS The operation was successful.
3641 NotificationFunction(
3642 IN EFI_KEY_DATA
*KeyData
3645 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3646 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3647 (KeyData
->Key
.UnicodeChar
== 3)
3649 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3650 return (EFI_UNSUPPORTED
);
3652 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3653 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3654 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3656 ShellInfoObject
.HaltOutput
= TRUE
;
3658 return (EFI_SUCCESS
);
3662 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3663 feature's enabled state was not known when the shell initially launched.
3665 @retval EFI_SUCCESS The feature is enabled.
3666 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3670 InernalEfiShellStartMonitor(
3674 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3675 EFI_KEY_DATA KeyData
;
3678 Status
= gBS
->OpenProtocol(
3679 gST
->ConsoleInHandle
,
3680 &gEfiSimpleTextInputExProtocolGuid
,
3684 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3685 if (EFI_ERROR(Status
)) {
3690 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3691 ShellInfoObject
.HiiHandle
);
3692 return (EFI_SUCCESS
);
3695 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3696 return (EFI_UNSUPPORTED
);
3699 KeyData
.KeyState
.KeyToggleState
= 0;
3700 KeyData
.Key
.ScanCode
= 0;
3701 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3702 KeyData
.Key
.UnicodeChar
= L
'c';
3704 Status
= SimpleEx
->RegisterKeyNotify(
3707 NotificationFunction
,
3708 &ShellInfoObject
.CtrlCNotifyHandle1
);
3710 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3711 if (!EFI_ERROR(Status
)) {
3712 Status
= SimpleEx
->RegisterKeyNotify(
3715 NotificationFunction
,
3716 &ShellInfoObject
.CtrlCNotifyHandle2
);
3718 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3719 KeyData
.Key
.UnicodeChar
= 3;
3720 if (!EFI_ERROR(Status
)) {
3721 Status
= SimpleEx
->RegisterKeyNotify(
3724 NotificationFunction
,
3725 &ShellInfoObject
.CtrlCNotifyHandle3
);
3727 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3728 if (!EFI_ERROR(Status
)) {
3729 Status
= SimpleEx
->RegisterKeyNotify(
3732 NotificationFunction
,
3733 &ShellInfoObject
.CtrlCNotifyHandle4
);