2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 Close an open file handle.
21 This function closes a specified file handle. All "dirty" cached file data is
22 flushed to the device, and the file is closed. In all cases the handle is
25 @param[in] FileHandle The file handle to close.
27 @retval EFI_SUCCESS The file handle was closed successfully.
32 IN SHELL_FILE_HANDLE FileHandle
35 ShellFileHandleRemove(FileHandle
);
36 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
40 Internal worker to determine whether there is a BlockIo somewhere
41 upon the device path specified.
43 @param[in] DevicePath The device path to test.
45 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
46 @retval FALSE gEfiBlockIoProtocolGuid was not found.
50 InternalShellProtocolIsBlockIoPresent(
51 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
54 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
60 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
61 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
63 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
70 Internal worker to determine whether there is a file system somewhere
71 upon the device path specified.
73 @param[in] DevicePath The device path to test.
75 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
76 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
80 InternalShellProtocolIsSimpleFileSystemPresent(
81 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
84 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
90 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
91 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
93 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
100 Internal worker debug helper function to print out maps as they are added.
102 @param[in] Mapping string mapping that has been added
103 @param[in] DevicePath pointer to device path that has been mapped.
105 @retval EFI_SUCCESS the operation was successful.
106 @return other an error ocurred
113 InternalShellProtocolDebugPrintMessage (
114 IN CONST CHAR16
*Mapping
,
115 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
121 Status
= EFI_SUCCESS
;
124 if (Mapping
!= NULL
) {
125 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
127 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
128 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
136 This function creates a mapping for a device path.
138 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
140 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
141 then the mapping will be deleted.
142 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
144 @retval EFI_SUCCESS Mapping created or deleted successfully.
145 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
146 boot service function LocateDevicePath().
147 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
148 @retval EFI_INVALID_PARAMETER Mapping was NULL
149 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
150 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
151 @retval EFI_NOT_FOUND There was no mapping found to delete
152 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
157 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
158 IN CONST CHAR16
*Mapping
162 SHELL_MAP_LIST
*MapListNode
;
164 if (Mapping
== NULL
){
165 return (EFI_INVALID_PARAMETER
);
168 if (Mapping
[StrLen(Mapping
)-1] != ':') {
169 return (EFI_INVALID_PARAMETER
);
173 // Delete the mapping
175 if (DevicePath
== NULL
) {
176 if (IsListEmpty(&gShellMapList
.Link
)) {
177 return (EFI_NOT_FOUND
);
179 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
180 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
181 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
183 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
184 RemoveEntryList(&MapListNode
->Link
);
185 FreePool(MapListNode
);
186 return (EFI_SUCCESS
);
191 // We didnt find one to delete
193 return (EFI_NOT_FOUND
);
197 // make sure this is a valid to add device path
199 ///@todo add BlockIo to this test...
200 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
201 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
202 return (EFI_INVALID_PARAMETER
);
206 // First make sure there is no old mapping
208 Status
= EfiShellSetMap(NULL
, Mapping
);
209 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
214 // now add the new one.
216 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
222 Gets the device path from the mapping.
224 This function gets the device path associated with a mapping.
226 @param Mapping A pointer to the mapping
228 @retval !=NULL Pointer to the device path that corresponds to the
229 device mapping. The returned pointer does not need
231 @retval NULL There is no device path associated with the
234 CONST EFI_DEVICE_PATH_PROTOCOL
*
236 EfiShellGetDevicePathFromMap(
237 IN CONST CHAR16
*Mapping
240 SHELL_MAP_LIST
*MapListItem
;
247 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
248 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
249 StrnCatGrow(&NewName
, &Size
, L
":", 0);
252 MapListItem
= ShellCommandFindMapItem(NewName
);
256 if (MapListItem
!= NULL
) {
257 return (MapListItem
->DevicePath
);
263 Gets the mapping(s) that most closely matches the device path.
265 This function gets the mapping which corresponds to the device path *DevicePath. If
266 there is no exact match, then the mapping which most closely matches *DevicePath
267 is returned, and *DevicePath is updated to point to the remaining portion of the
268 device path. If there is an exact match, the mapping is returned and *DevicePath
269 points to the end-of-device-path node.
271 If there are multiple map names they will be semi-colon seperated in the
272 NULL-terminated string.
274 @param DevicePath On entry, points to a device path pointer. On
275 exit, updates the pointer to point to the
276 portion of the device path after the mapping.
278 @retval NULL No mapping was found.
279 @return !=NULL Pointer to NULL-terminated mapping. The buffer
280 is callee allocated and should be freed by the caller.
284 EfiShellGetMapFromDevicePath(
285 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
288 SHELL_MAP_LIST
*Node
;
289 CHAR16
*PathForReturn
;
291 // EFI_HANDLE PathHandle;
292 // EFI_HANDLE MapHandle;
293 // EFI_STATUS Status;
294 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
295 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
297 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
301 PathForReturn
= NULL
;
304 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
305 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
306 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
309 // check for exact match
311 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
312 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
314 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
316 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
319 if (PathForReturn
!= NULL
) {
320 while (!IsDevicePathEndType (*DevicePath
)) {
321 *DevicePath
= NextDevicePathNode (*DevicePath
);
323 SetDevicePathEndNode (*DevicePath
);
326 ///@todo finish code for inexact matches.
327 if (PathForReturn == NULL) {
330 DevicePathCopy = DuplicateDevicePath(*DevicePath);
331 ASSERT(DevicePathCopy != NULL);
332 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
333 ASSERT_EFI_ERROR(Status);
335 // check each of the device paths we have to get the root of the path for consist mappings
337 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
338 ; !IsNull(&gShellMapList.Link, &Node->Link)
339 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
341 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
344 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
345 ASSERT(MapPathCopy != NULL);
346 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
347 if (MapHandle == PathHandle) {
349 *DevicePath = DevicePathCopy;
352 DevicePathCopy = NULL;
353 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
354 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
359 // now add on the non-consistent mappings
361 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
362 ; !IsNull(&gShellMapList.Link, &Node->Link)
363 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
365 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
368 MapPathCopy = Node->DevicePath;
369 ASSERT(MapPathCopy != NULL);
370 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
371 if (MapHandle == PathHandle) {
372 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
373 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
380 return (AddBufferToFreeList(PathForReturn
));
384 Converts a device path to a file system-style path.
386 This function converts a device path to a file system path by replacing part, or all, of
387 the device path with the file-system mapping. If there are more than one application
388 file system mappings, the one that most closely matches Path will be used.
390 @param Path The pointer to the device path
392 @retval NULL the device path could not be found.
393 @return all The pointer of the NULL-terminated file path. The path
394 is callee-allocated and should be freed by the caller.
398 EfiShellGetFilePathFromDevicePath(
399 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
402 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
403 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
404 SHELL_MAP_LIST
*MapListItem
;
405 CHAR16
*PathForReturn
;
407 EFI_HANDLE PathHandle
;
408 EFI_HANDLE MapHandle
;
410 FILEPATH_DEVICE_PATH
*FilePath
;
411 FILEPATH_DEVICE_PATH
*AlignedNode
;
413 PathForReturn
= NULL
;
416 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
417 ASSERT(DevicePathCopy
!= NULL
);
418 if (DevicePathCopy
== NULL
) {
422 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
424 if (EFI_ERROR(Status
)) {
428 // check each of the device paths we have to get the root of the path
430 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
431 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
432 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
434 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
435 ASSERT(MapPathCopy
!= NULL
);
437 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
438 if (MapHandle
== PathHandle
) {
439 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
440 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
442 // go through all the remaining nodes in the device path
444 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
445 ; !IsDevicePathEnd (&FilePath
->Header
)
446 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
449 // all the rest should be file path nodes
451 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
452 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
453 FreePool(PathForReturn
);
454 PathForReturn
= NULL
;
458 // append the path part onto the filepath.
460 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
461 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
"\\", 1);
463 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
464 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
465 FreePool(AlignedNode
);
467 } // for loop of remaining nodes
469 if (PathForReturn
!= NULL
) {
472 } // for loop of paths to check
473 return(PathForReturn
);
477 Converts a file system style name to a device path.
479 This function converts a file system style name to a device path, by replacing any
480 mapping references to the associated device path.
482 @param[in] Path The pointer to the path.
484 @return The pointer of the file path. The file path is callee
485 allocated and should be freed by the caller.
486 @retval NULL The path could not be found.
487 @retval NULL There was not enough available memory.
489 EFI_DEVICE_PATH_PROTOCOL
*
491 EfiShellGetDevicePathFromFilePath(
492 IN CONST CHAR16
*Path
499 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
500 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
501 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
502 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
513 if (StrStr(Path
, L
":") == NULL
) {
514 Cwd
= EfiShellGetCurDir(NULL
);
519 Size
+= StrSize(Path
);
520 NewPath
= AllocateZeroPool(Size
);
521 if (NewPath
== NULL
) {
524 StrCpy(NewPath
, Cwd
);
525 if (*Path
== L
'\\') {
527 while (PathRemoveLastItem(NewPath
)) ;
529 StrCat(NewPath
, Path
);
530 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
532 return (DevicePathForReturn
);
537 // find the part before (but including) the : for the map name
539 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
540 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
541 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
546 // look up the device path in the map
548 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
549 if (DevicePath
== NULL
) {
551 // Must have been a bad Mapname
557 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
559 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
560 if (DevicePathCopy
== NULL
) {
569 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
570 if (EFI_ERROR(Status
)) {
571 if (DevicePathCopyForFree
!= NULL
) {
572 FreePool(DevicePathCopyForFree
);
579 // build the full device path
581 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
582 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
584 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
588 if (DevicePathCopyForFree
!= NULL
) {
589 FreePool(DevicePathCopyForFree
);
592 return (DevicePathForReturn
);
596 Gets the name of the device specified by the device handle.
598 This function gets the user-readable name of the device specified by the device
599 handle. If no user-readable name could be generated, then *BestDeviceName will be
600 NULL and EFI_NOT_FOUND will be returned.
602 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
603 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
606 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
607 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
608 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
609 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
610 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
612 @param DeviceHandle The handle of the device.
613 @param Flags Determines the possible sources of component names.
615 EFI_DEVICE_NAME_USE_COMPONENT_NAME
616 EFI_DEVICE_NAME_USE_DEVICE_PATH
617 @param Language A pointer to the language specified for the device
618 name, in the same format as described in the UEFI
619 specification, Appendix M
620 @param BestDeviceName On return, points to the callee-allocated NULL-
621 terminated name of the device. If no device name
622 could be found, points to NULL. The name must be
623 freed by the caller...
625 @retval EFI_SUCCESS Get the name successfully.
626 @retval EFI_NOT_FOUND Fail to get the device name.
627 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
628 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
629 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
633 EfiShellGetDeviceName(
634 IN EFI_HANDLE DeviceHandle
,
635 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
637 OUT CHAR16
**BestDeviceName
641 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
642 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
643 EFI_HANDLE
*HandleList
;
646 CHAR16
*DeviceNameToReturn
;
648 UINTN ParentControllerCount
;
649 EFI_HANDLE
*ParentControllerBuffer
;
650 UINTN ParentDriverCount
;
651 EFI_HANDLE
*ParentDriverBuffer
;
653 if (BestDeviceName
== NULL
||
656 return (EFI_INVALID_PARAMETER
);
660 // make sure one of the 2 supported bits is on
662 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
663 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
664 return (EFI_INVALID_PARAMETER
);
667 DeviceNameToReturn
= NULL
;
668 *BestDeviceName
= NULL
;
673 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
674 Status
= ParseHandleDatabaseByRelationship(
677 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
680 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
682 // Go through those handles until we get one that passes for GetComponentName
684 Status
= gBS
->OpenProtocol(
686 &gEfiComponentName2ProtocolGuid
,
690 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
691 if (EFI_ERROR(Status
)) {
692 Status
= gBS
->OpenProtocol(
694 &gEfiComponentNameProtocolGuid
,
698 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
701 if (EFI_ERROR(Status
)) {
704 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
705 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
708 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
712 if (HandleList
!= NULL
) {
713 FreePool(HandleList
);
717 // Now check the parent controller using this as the child.
719 if (DeviceNameToReturn
== NULL
){
720 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
721 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
722 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
723 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
725 // try using that driver's component name with controller and our driver as the child.
727 Status
= gBS
->OpenProtocol(
728 ParentDriverBuffer
[HandleCount
],
729 &gEfiComponentName2ProtocolGuid
,
733 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
734 if (EFI_ERROR(Status
)) {
735 Status
= gBS
->OpenProtocol(
736 ParentDriverBuffer
[HandleCount
],
737 &gEfiComponentNameProtocolGuid
,
741 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
744 if (EFI_ERROR(Status
)) {
747 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
748 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
751 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
758 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
759 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
763 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
766 // dont return on fail since we will try device path if that bit is on
768 if (DeviceNameToReturn
!= NULL
){
769 ASSERT(BestDeviceName
!= NULL
);
770 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
771 return (EFI_SUCCESS
);
774 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
775 Status
= gBS
->OpenProtocol(
777 &gEfiDevicePathProtocolGuid
,
781 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
782 if (!EFI_ERROR(Status
)) {
784 // use device path to text on the device path
786 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
787 return (EFI_SUCCESS
);
791 // none of the selected bits worked.
793 return (EFI_NOT_FOUND
);
797 Opens the root directory of a device on a handle
799 This function opens the root directory of a device and returns a file handle to it.
801 @param DeviceHandle The handle of the device that contains the volume.
802 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
805 @retval EFI_SUCCESS Root opened successfully.
806 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
808 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
809 @retval EFI_DEVICE_ERROR The device had an error
813 EfiShellOpenRootByHandle(
814 IN EFI_HANDLE DeviceHandle
,
815 OUT SHELL_FILE_HANDLE
*FileHandle
819 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
820 EFI_FILE_PROTOCOL
*RealFileHandle
;
821 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
824 // get the simple file system interface
826 Status
= gBS
->OpenProtocol(DeviceHandle
,
827 &gEfiSimpleFileSystemProtocolGuid
,
828 (VOID
**)&SimpleFileSystem
,
831 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
832 if (EFI_ERROR(Status
)) {
833 return (EFI_NOT_FOUND
);
836 Status
= gBS
->OpenProtocol(DeviceHandle
,
837 &gEfiDevicePathProtocolGuid
,
841 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
842 if (EFI_ERROR(Status
)) {
843 return (EFI_NOT_FOUND
);
846 // Open the root volume now...
848 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
849 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
854 Opens the root directory of a device.
856 This function opens the root directory of a device and returns a file handle to it.
858 @param DevicePath Points to the device path corresponding to the device where the
859 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
860 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
863 @retval EFI_SUCCESS Root opened successfully.
864 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
866 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
867 @retval EFI_DEVICE_ERROR The device had an error
868 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
873 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
874 OUT SHELL_FILE_HANDLE
*FileHandle
880 if (FileHandle
== NULL
) {
881 return (EFI_INVALID_PARAMETER
);
885 // find the handle of the device with that device handle and the file system
888 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
891 if (EFI_ERROR(Status
)) {
892 return (EFI_NOT_FOUND
);
895 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
899 Returns whether any script files are currently being processed.
901 @retval TRUE There is at least one script file active.
902 @retval FALSE No script files are active now.
907 EfiShellBatchIsActive (
911 if (ShellCommandGetCurrentScriptFile() == NULL
) {
918 Worker function to open a file based on a device path. this will open the root
919 of the volume and then traverse down to the file itself.
921 @param DevicePath Device Path of the file.
922 @param FileHandle Pointer to the file upon a successful return.
923 @param OpenMode mode to open file in.
924 @param Attributes the File Attributes to use when creating a new file.
926 @retval EFI_SUCCESS the file is open and FileHandle is valid
927 @retval EFI_UNSUPPORTED the device path cotained non-path elements
928 @retval other an error ocurred.
932 InternalOpenFileDevicePath(
933 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
934 OUT SHELL_FILE_HANDLE
*FileHandle
,
936 IN UINT64 Attributes OPTIONAL
940 FILEPATH_DEVICE_PATH
*FilePathNode
;
942 SHELL_FILE_HANDLE ShellHandle
;
943 EFI_FILE_PROTOCOL
*Handle1
;
944 EFI_FILE_PROTOCOL
*Handle2
;
945 FILEPATH_DEVICE_PATH
*AlignedNode
;
947 if (FileHandle
== NULL
) {
948 return (EFI_INVALID_PARAMETER
);
958 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
960 if (!EFI_ERROR(Status
)) {
961 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
962 if (Handle1
!= NULL
) {
964 // chop off the begining part before the file system part...
967 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
970 if (!EFI_ERROR(Status
)) {
972 // To access as a file system, the file path should only
973 // contain file path components. Follow the file path nodes
974 // and find the target file
976 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
977 ; !IsDevicePathEnd (&FilePathNode
->Header
)
978 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
980 SHELL_FREE_NON_NULL(AlignedNode
);
981 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
983 // For file system access each node should be a file path component
985 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
986 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
988 Status
= EFI_UNSUPPORTED
;
993 // Open this file path node
999 // if this is the last node in the DevicePath always create (if that was requested).
1001 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1002 Status
= Handle2
->Open (
1005 AlignedNode
->PathName
,
1012 // This is not the last node and we dont want to 'create' existing
1013 // directory entries...
1017 // open without letting it create
1018 // prevents error on existing files/directories
1020 Status
= Handle2
->Open (
1023 AlignedNode
->PathName
,
1024 OpenMode
&~EFI_FILE_MODE_CREATE
,
1028 // if above failed now open and create the 'item'
1029 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1031 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1032 Status
= Handle2
->Open (
1035 AlignedNode
->PathName
,
1042 // Close the last node
1044 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1047 // If there's been an error, stop
1049 if (EFI_ERROR (Status
)) {
1056 SHELL_FREE_NON_NULL(AlignedNode
);
1057 if (EFI_ERROR(Status
)) {
1058 if (Handle1
!= NULL
) {
1059 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1062 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1068 Creates a file or directory by name.
1070 This function creates an empty new file or directory with the specified attributes and
1071 returns the new file's handle. If the file already exists and is read-only, then
1072 EFI_INVALID_PARAMETER will be returned.
1074 If the file already existed, it is truncated and its attributes updated. If the file is
1075 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1077 If the file name begins with >v, then the file handle which is returned refers to the
1078 shell environment variable with the specified name. If the shell environment variable
1079 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1081 @param FileName Pointer to NULL-terminated file path
1082 @param FileAttribs The new file's attrbiutes. the different attributes are
1083 described in EFI_FILE_PROTOCOL.Open().
1084 @param FileHandle On return, points to the created file handle or directory's handle
1086 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1087 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1088 @retval EFI_UNSUPPORTED could not open the file path
1089 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1090 file the file system on the device.
1091 @retval EFI_NO_MEDIA the device has no medium.
1092 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1094 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1096 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1097 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1098 when the media is write-protected.
1099 @retval EFI_ACCESS_DENIED The service denied access to the file.
1100 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1101 @retval EFI_VOLUME_FULL The volume is full.
1106 IN CONST CHAR16
*FileName
,
1107 IN UINT64 FileAttribs
,
1108 OUT SHELL_FILE_HANDLE
*FileHandle
1111 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1115 // Is this for an environment variable
1116 // do we start with >v
1118 if (StrStr(FileName
, L
">v") == FileName
) {
1119 if (!IsVolatileEnv(FileName
+2)) {
1120 return (EFI_INVALID_PARAMETER
);
1122 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1123 return (EFI_SUCCESS
);
1127 // We are opening a regular file.
1129 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1130 if (DevicePath
== NULL
) {
1131 return (EFI_NOT_FOUND
);
1134 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
); // 0 = no specific file attributes
1135 FreePool(DevicePath
);
1141 Opens a file or a directory by file name.
1143 This function opens the specified file in the specified OpenMode and returns a file
1145 If the file name begins with >v, then the file handle which is returned refers to the
1146 shell environment variable with the specified name. If the shell environment variable
1147 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1148 EFI_INVALID_PARAMETER is returned.
1150 If the file name is >i, then the file handle which is returned refers to the standard
1151 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1154 If the file name is >o, then the file handle which is returned refers to the standard
1155 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1158 If the file name is >e, then the file handle which is returned refers to the standard
1159 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1162 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1163 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1166 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1169 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1170 @param FileHandle On return, points to the file handle.
1171 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1172 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1174 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1175 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1176 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1177 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1178 system could not be found on the device. FileHandle is NULL.
1179 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1180 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1181 longer supported. FileHandle is NULL.
1182 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1183 the FileName. FileHandle is NULL.
1184 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1185 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1186 when the media is write-protected. FileHandle is NULL.
1187 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1188 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1190 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1194 EfiShellOpenFileByName(
1195 IN CONST CHAR16
*FileName
,
1196 OUT SHELL_FILE_HANDLE
*FileHandle
,
1200 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1206 // Is this for StdIn
1208 if (StrCmp(FileName
, L
">i") == 0) {
1210 // make sure not writing to StdIn
1212 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1213 return (EFI_INVALID_PARAMETER
);
1215 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1216 ASSERT(*FileHandle
!= NULL
);
1217 return (EFI_SUCCESS
);
1221 // Is this for StdOut
1223 if (StrCmp(FileName
, L
">o") == 0) {
1225 // make sure not writing to StdIn
1227 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1228 return (EFI_INVALID_PARAMETER
);
1230 *FileHandle
= &FileInterfaceStdOut
;
1231 return (EFI_SUCCESS
);
1235 // Is this for NUL file
1237 if (StrCmp(FileName
, L
"NUL") == 0) {
1238 *FileHandle
= &FileInterfaceNulFile
;
1239 return (EFI_SUCCESS
);
1243 // Is this for StdErr
1245 if (StrCmp(FileName
, L
">e") == 0) {
1247 // make sure not writing to StdIn
1249 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1250 return (EFI_INVALID_PARAMETER
);
1252 *FileHandle
= &FileInterfaceStdErr
;
1253 return (EFI_SUCCESS
);
1257 // Is this for an environment variable
1258 // do we start with >v
1260 if (StrStr(FileName
, L
">v") == FileName
) {
1261 if (!IsVolatileEnv(FileName
+2) &&
1262 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1263 return (EFI_INVALID_PARAMETER
);
1265 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1266 return (EFI_SUCCESS
);
1270 // We are opening a regular file.
1272 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1273 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1274 if (DevicePath
== NULL
) {
1275 return (EFI_NOT_FOUND
);
1279 // Copy the device path, open the file, then free the memory
1281 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1282 FreePool(DevicePath
);
1288 Deletes the file specified by the file name.
1290 This function deletes a file.
1292 @param FileName Points to the NULL-terminated file name.
1294 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1295 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1296 @sa EfiShellCreateFile
1300 EfiShellDeleteFileByName(
1301 IN CONST CHAR16
*FileName
1304 SHELL_FILE_HANDLE FileHandle
;
1308 // get a handle to the file
1310 Status
= EfiShellCreateFile(FileName
,
1313 if (EFI_ERROR(Status
)) {
1317 // now delete the file
1319 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1323 Disables the page break output mode.
1327 EfiShellDisablePageBreak (
1331 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1335 Enables the page break output mode.
1339 EfiShellEnablePageBreak (
1343 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1347 internal worker function to load and run an image via device path.
1349 @param ParentImageHandle A handle of the image that is executing the specified
1351 @param DevicePath device path of the file to execute
1352 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1353 containing the command line. If NULL then the command-
1355 @param Environment Points to a NULL-terminated array of environment
1356 variables with the format 'x=y', where x is the
1357 environment variable name and y is the value. If this
1358 is NULL, then the current shell environment is used.
1359 @param StatusCode Points to the status code returned by the command.
1361 @retval EFI_SUCCESS The command executed successfully. The status code
1362 returned by the command is pointed to by StatusCode.
1363 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1364 @retval EFI_OUT_OF_RESOURCES Out of resources.
1365 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1369 InternalShellExecuteDevicePath(
1370 IN CONST EFI_HANDLE
*ParentImageHandle
,
1371 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1372 IN CONST CHAR16
*CommandLine OPTIONAL
,
1373 IN CONST CHAR16
**Environment OPTIONAL
,
1374 OUT EFI_STATUS
*StatusCode OPTIONAL
1378 EFI_HANDLE NewHandle
;
1379 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1380 LIST_ENTRY OrigEnvs
;
1381 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1383 if (ParentImageHandle
== NULL
) {
1384 return (EFI_INVALID_PARAMETER
);
1387 InitializeListHead(&OrigEnvs
);
1392 // Load the image with:
1393 // FALSE - not from boot manager and NULL, 0 being not already in memory
1395 Status
= gBS
->LoadImage(
1398 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1403 if (EFI_ERROR(Status
)) {
1404 if (NewHandle
!= NULL
) {
1405 gBS
->UnloadImage(NewHandle
);
1409 Status
= gBS
->OpenProtocol(
1411 &gEfiLoadedImageProtocolGuid
,
1412 (VOID
**)&LoadedImage
,
1415 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1417 if (!EFI_ERROR(Status
)) {
1418 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1419 if (CommandLine
!= NULL
) {
1420 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(CommandLine
);
1421 LoadedImage
->LoadOptions
= (VOID
*)CommandLine
;
1425 // Save our current environment settings for later restoration if necessary
1427 if (Environment
!= NULL
) {
1428 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1429 if (!EFI_ERROR(Status
)) {
1430 Status
= SetEnvironmentVariables(Environment
);
1435 // Initialize and install a shell parameters protocol on the image.
1437 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1438 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1439 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1440 Status
= UpdateArgcArgv(&ShellParamsProtocol
, CommandLine
, NULL
, NULL
);
1441 ASSERT_EFI_ERROR(Status
);
1442 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1443 ASSERT_EFI_ERROR(Status
);
1445 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1448 // now start the image and if the caller wanted the return code pass it to them...
1450 if (!EFI_ERROR(Status
)) {
1451 if (StatusCode
!= NULL
) {
1452 *StatusCode
= gBS
->StartImage(NewHandle
, NULL
, NULL
);
1454 Status
= gBS
->StartImage(NewHandle
, NULL
, NULL
);
1459 // Cleanup (and dont overwrite errors)
1461 if (EFI_ERROR(Status
)) {
1462 gBS
->UninstallProtocolInterface(NewHandle
, &gEfiShellParametersProtocolGuid
, &ShellParamsProtocol
);
1464 Status
= gBS
->UninstallProtocolInterface(NewHandle
, &gEfiShellParametersProtocolGuid
, &ShellParamsProtocol
);
1465 ASSERT_EFI_ERROR(Status
);
1469 if (!IsListEmpty(&OrigEnvs
)) {
1470 if (EFI_ERROR(Status
)) {
1471 SetEnvironmentVariableList(&OrigEnvs
);
1473 Status
= SetEnvironmentVariableList(&OrigEnvs
);
1480 Execute the command line.
1482 This function creates a nested instance of the shell and executes the specified
1483 command (CommandLine) with the specified environment (Environment). Upon return,
1484 the status code returned by the specified command is placed in StatusCode.
1486 If Environment is NULL, then the current environment is used and all changes made
1487 by the commands executed will be reflected in the current environment. If the
1488 Environment is non-NULL, then the changes made will be discarded.
1490 The CommandLine is executed from the current working directory on the current
1493 @param ParentImageHandle A handle of the image that is executing the specified
1495 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1496 containing the command line. If NULL then the command-
1498 @param Environment Points to a NULL-terminated array of environment
1499 variables with the format 'x=y', where x is the
1500 environment variable name and y is the value. If this
1501 is NULL, then the current shell environment is used.
1502 @param StatusCode Points to the status code returned by the command.
1504 @retval EFI_SUCCESS The command executed successfully. The status code
1505 returned by the command is pointed to by StatusCode.
1506 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1507 @retval EFI_OUT_OF_RESOURCES Out of resources.
1508 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1509 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1511 @sa InternalShellExecuteDevicePath
1516 IN EFI_HANDLE
*ParentImageHandle
,
1517 IN CHAR16
*CommandLine OPTIONAL
,
1518 IN CHAR16
**Environment OPTIONAL
,
1519 OUT EFI_STATUS
*StatusCode OPTIONAL
1524 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1527 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1528 return (EFI_UNSUPPORTED
);
1531 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1534 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1536 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1538 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1544 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1545 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1546 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1548 Status
= InternalShellExecuteDevicePath(
1552 (CONST CHAR16
**)Environment
,
1556 // de-allocate and return
1564 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1566 1) frees all pointers (non-NULL)
1567 2) Closes the SHELL_FILE_HANDLE
1569 @param FileListNode pointer to the list node to free
1573 InternalFreeShellFileInfoNode(
1574 IN EFI_SHELL_FILE_INFO
*FileListNode
1577 if (FileListNode
->Info
!= NULL
) {
1578 FreePool((VOID
*)FileListNode
->Info
);
1580 if (FileListNode
->FileName
!= NULL
) {
1581 FreePool((VOID
*)FileListNode
->FileName
);
1583 if (FileListNode
->FullName
!= NULL
) {
1584 FreePool((VOID
*)FileListNode
->FullName
);
1586 if (FileListNode
->Handle
!= NULL
) {
1587 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1589 FreePool(FileListNode
);
1592 Frees the file list.
1594 This function cleans up the file list and any related data structures. It has no
1595 impact on the files themselves.
1597 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1598 defined in OpenFileList()
1600 @retval EFI_SUCCESS Free the file list successfully.
1601 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1605 EfiShellFreeFileList(
1606 IN EFI_SHELL_FILE_INFO
**FileList
1609 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1611 if (FileList
== NULL
|| *FileList
== NULL
) {
1612 return (EFI_INVALID_PARAMETER
);
1615 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1616 ; !IsListEmpty(&(*FileList
)->Link
)
1617 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1619 RemoveEntryList(&ShellFileListItem
->Link
);
1620 InternalFreeShellFileInfoNode(ShellFileListItem
);
1622 InternalFreeShellFileInfoNode(*FileList
);
1623 return(EFI_SUCCESS
);
1627 Deletes the duplicate file names files in the given file list.
1629 This function deletes the reduplicate files in the given file list.
1631 @param FileList A pointer to the first entry in the file list.
1633 @retval EFI_SUCCESS Always success.
1634 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1638 EfiShellRemoveDupInFileList(
1639 IN EFI_SHELL_FILE_INFO
**FileList
1642 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1643 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1645 if (FileList
== NULL
|| *FileList
== NULL
) {
1646 return (EFI_INVALID_PARAMETER
);
1648 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1649 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1650 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1652 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1653 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1654 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1656 if (gUnicodeCollation
->StriColl(
1658 (CHAR16
*)ShellFileListItem
->FullName
,
1659 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1661 RemoveEntryList(&ShellFileListItem2
->Link
);
1662 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1666 return (EFI_SUCCESS
);
1669 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1671 @param[in] Node The node to copy from.
1672 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1674 @retval NULL a memory allocation error ocurred
1675 @return != NULL a pointer to the new node
1677 EFI_SHELL_FILE_INFO
*
1679 InternalDuplicateShellFileInfo(
1680 IN EFI_SHELL_FILE_INFO
*Node
,
1684 EFI_SHELL_FILE_INFO
*NewNode
;
1686 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1687 if (NewNode
== NULL
) {
1690 NewNode
->FullName
= AllocateZeroPool(StrSize(Node
->FullName
));
1692 NewNode
->FileName
= AllocateZeroPool(StrSize(Node
->FileName
));
1693 NewNode
->Info
= AllocateZeroPool((UINTN
)Node
->Info
->Size
);
1694 if ( NewNode
->FullName
== NULL
1695 || NewNode
->FileName
== NULL
1696 || NewNode
->Info
== NULL
1700 NewNode
->Status
= Node
->Status
;
1701 NewNode
->Handle
= Node
->Handle
;
1703 Node
->Handle
= NULL
;
1705 StrCpy((CHAR16
*)NewNode
->FullName
, Node
->FullName
);
1706 StrCpy((CHAR16
*)NewNode
->FileName
, Node
->FileName
);
1707 CopyMem(NewNode
->Info
, Node
->Info
, (UINTN
)Node
->Info
->Size
);
1713 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1714 failed it will return NULL.
1716 @param[in] BasePath the Path to prepend onto filename for FullPath
1717 @param[in] Status Status member initial value.
1718 @param[in] FileName FileName member initial value.
1719 @param[in] Handle Handle member initial value.
1720 @param[in] Info Info struct to copy.
1722 @retval NULL An error ocurred.
1723 @return a pointer to the newly allocated structure.
1725 EFI_SHELL_FILE_INFO
*
1727 CreateAndPopulateShellFileInfo(
1728 IN CONST CHAR16
*BasePath
,
1729 IN CONST EFI_STATUS Status
,
1730 IN CONST CHAR16
*FileName
,
1731 IN CONST SHELL_FILE_HANDLE Handle
,
1732 IN CONST EFI_FILE_INFO
*Info
1735 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1742 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1743 if (ShellFileListItem
== NULL
) {
1746 if (Info
!= NULL
&& Info
->Size
!= 0) {
1747 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1748 if (ShellFileListItem
->Info
== NULL
) {
1749 FreePool(ShellFileListItem
);
1752 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1754 ShellFileListItem
->Info
= NULL
;
1756 if (FileName
!= NULL
) {
1757 ASSERT(TempString
== NULL
);
1758 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1759 if (ShellFileListItem
->FileName
== NULL
) {
1760 FreePool(ShellFileListItem
->Info
);
1761 FreePool(ShellFileListItem
);
1765 ShellFileListItem
->FileName
= NULL
;
1769 if (BasePath
!= NULL
) {
1770 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1771 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1772 if (TempString
== NULL
) {
1773 FreePool((VOID
*)ShellFileListItem
->FileName
);
1774 FreePool(ShellFileListItem
->Info
);
1775 FreePool(ShellFileListItem
);
1779 if (ShellFileListItem
->FileName
!= NULL
) {
1780 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1781 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1782 if (TempString
== NULL
) {
1783 FreePool((VOID
*)ShellFileListItem
->FileName
);
1784 FreePool(ShellFileListItem
->Info
);
1785 FreePool(ShellFileListItem
);
1790 ShellFileListItem
->FullName
= TempString
;
1791 ShellFileListItem
->Status
= Status
;
1792 ShellFileListItem
->Handle
= Handle
;
1794 return (ShellFileListItem
);
1798 Find all files in a specified directory.
1800 @param FileDirHandle Handle of the directory to search.
1801 @param FileList On return, points to the list of files in the directory
1802 or NULL if there are no files in the directory.
1804 @retval EFI_SUCCESS File information was returned successfully.
1805 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1806 @retval EFI_DEVICE_ERROR The device reported an error.
1807 @retval EFI_NO_MEDIA The device media is not present.
1808 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1809 @return An error from FileHandleGetFileName().
1813 EfiShellFindFilesInDir(
1814 IN SHELL_FILE_HANDLE FileDirHandle
,
1815 OUT EFI_SHELL_FILE_INFO
**FileList
1818 EFI_SHELL_FILE_INFO
*ShellFileList
;
1819 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1820 EFI_FILE_INFO
*FileInfo
;
1828 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1829 if (EFI_ERROR(Status
)) {
1833 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1836 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1837 if (TempString
== NULL
) {
1838 SHELL_FREE_NON_NULL(BasePath
);
1839 return (EFI_OUT_OF_RESOURCES
);
1841 TempSpot
= StrStr(TempString
, L
";");
1843 if (TempSpot
!= NULL
) {
1844 *TempSpot
= CHAR_NULL
;
1847 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1848 if (TempString
== NULL
) {
1849 SHELL_FREE_NON_NULL(BasePath
);
1850 return (EFI_OUT_OF_RESOURCES
);
1852 SHELL_FREE_NON_NULL(BasePath
);
1853 BasePath
= TempString
;
1857 ShellFileList
= NULL
;
1858 ShellFileListItem
= NULL
;
1860 Status
= EFI_SUCCESS
;
1863 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
1864 ; !EFI_ERROR(Status
) && !NoFile
1865 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
1868 // allocate a new EFI_SHELL_FILE_INFO and populate it...
1870 ShellFileListItem
= CreateAndPopulateShellFileInfo(
1872 EFI_SUCCESS
, // success since we didnt fail to open it...
1874 NULL
, // no handle since not open
1877 if (ShellFileList
== NULL
) {
1878 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1879 ASSERT(ShellFileList
!= NULL
);
1880 InitializeListHead(&ShellFileList
->Link
);
1882 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
1884 if (EFI_ERROR(Status
)) {
1885 EfiShellFreeFileList(&ShellFileList
);
1888 *FileList
= ShellFileList
;
1890 SHELL_FREE_NON_NULL(BasePath
);
1895 Updates a file name to be preceeded by the mapped drive name
1897 @param[in] BasePath the Mapped drive name to prepend
1898 @param[in, out] Path pointer to pointer to the file name to update.
1901 @retval EFI_OUT_OF_RESOURCES
1906 IN CONST CHAR16
*BasePath
,
1907 IN OUT CHAR16
**Path
1916 ASSERT(Path
!= NULL
);
1917 ASSERT(*Path
!= NULL
);
1918 ASSERT(BasePath
!= NULL
);
1921 // convert a local path to an absolute path
1923 if (StrStr(*Path
, L
":") == NULL
) {
1924 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
1925 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
1926 if (Path2
== NULL
) {
1927 return (EFI_OUT_OF_RESOURCES
);
1929 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
1930 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
1931 if (Path2
== NULL
) {
1932 return (EFI_OUT_OF_RESOURCES
);
1939 return (EFI_SUCCESS
);
1943 If FileHandle is a directory then the function reads from FileHandle and reads in
1944 each of the FileInfo structures. If one of them matches the Pattern's first
1945 "level" then it opens that handle and calls itself on that handle.
1947 If FileHandle is a file and matches all of the remaining Pattern (which would be
1948 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
1950 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
1951 FreeFileList with FileList.
1953 @param[in] FilePattern The FilePattern to check against.
1954 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
1955 @param[in] FileHandle The FileHandle to start with
1956 @param[in, out] FileList pointer to pointer to list of found files.
1957 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
1958 @param[in] MapName The file system name this file is on.
1960 @retval EFI_SUCCESS all files were found and the FileList contains a list.
1961 @retval EFI_NOT_FOUND no files were found
1962 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
1967 IN CONST CHAR16
*FilePattern
,
1968 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
1969 IN SHELL_FILE_HANDLE FileHandle
,
1970 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
1971 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
1972 IN CONST CHAR16
*MapName
1976 CONST CHAR16
*NextFilePatternStart
;
1977 CHAR16
*CurrentFilePattern
;
1978 EFI_SHELL_FILE_INFO
*ShellInfo
;
1979 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
1980 EFI_SHELL_FILE_INFO
*NewShellNode
;
1982 CHAR16
*NewFullName
;
1985 if ( FilePattern
== NULL
1986 || UnicodeCollation
== NULL
1989 return (EFI_INVALID_PARAMETER
);
1992 CurrentFilePattern
= NULL
;
1994 if (*FilePattern
== L
'\\') {
1998 for( NextFilePatternStart
= FilePattern
1999 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2000 ; NextFilePatternStart
++);
2002 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2003 ASSERT(CurrentFilePattern
!= NULL
);
2004 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2006 if (CurrentFilePattern
[0] == CHAR_NULL
2007 &&NextFilePatternStart
[0] == CHAR_NULL
2010 // Add the current parameter FileHandle to the list, then end...
2012 if (ParentNode
== NULL
) {
2013 Status
= EFI_INVALID_PARAMETER
;
2015 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2016 if (NewShellNode
== NULL
) {
2017 Status
= EFI_OUT_OF_RESOURCES
;
2019 NewShellNode
->Handle
= NULL
;
2020 if (*FileList
== NULL
) {
2021 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2022 InitializeListHead(&((*FileList
)->Link
));
2026 // Add to the returning to use list
2028 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2030 Status
= EFI_SUCCESS
;
2034 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2036 if (!EFI_ERROR(Status
)){
2037 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2042 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2043 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2044 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2046 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2047 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2048 Size
= StrSize(ShellInfoNode
->FullName
);
2049 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2050 NewFullName
= AllocateZeroPool(Size
);
2051 if (NewFullName
== NULL
) {
2052 Status
= EFI_OUT_OF_RESOURCES
;
2054 StrCpy(NewFullName
, MapName
);
2055 StrCat(NewFullName
, ShellInfoNode
->FullName
+1);
2056 FreePool((VOID
*)ShellInfoNode
->FullName
);
2057 ShellInfoNode
->FullName
= NewFullName
;
2060 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2062 // should be a directory
2066 // don't open the . and .. directories
2068 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2069 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2074 if (EFI_ERROR(Status
)) {
2078 // Open the directory since we need that handle in the next recursion.
2080 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2083 // recurse with the next part of the pattern
2085 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2087 } else if (!EFI_ERROR(Status
)) {
2093 // copy the information we need into a new Node
2095 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2096 ASSERT(NewShellNode
!= NULL
);
2097 if (NewShellNode
== NULL
) {
2098 Status
= EFI_OUT_OF_RESOURCES
;
2100 if (*FileList
== NULL
) {
2101 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2102 InitializeListHead(&((*FileList
)->Link
));
2106 // Add to the returning to use list
2108 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2111 if (EFI_ERROR(Status
)) {
2115 if (EFI_ERROR(Status
)) {
2116 EfiShellFreeFileList(&ShellInfo
);
2118 Status
= EfiShellFreeFileList(&ShellInfo
);
2123 FreePool(CurrentFilePattern
);
2128 Find files that match a specified pattern.
2130 This function searches for all files and directories that match the specified
2131 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2132 information is placed in the file list FileList.
2134 Wildcards are processed
2135 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2137 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2138 field is set to NULL.
2140 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2142 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2143 @param FileList On return, points to the start of a file list containing the names
2144 of all matching files or else points to NULL if no matching files
2145 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2147 @retval EFI_SUCCESS Files found. FileList is a valid list.
2148 @retval EFI_NOT_FOUND No files found.
2149 @retval EFI_NO_MEDIA The device has no media
2150 @retval EFI_DEVICE_ERROR The device reported an error
2151 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2156 IN CONST CHAR16
*FilePattern
,
2157 OUT EFI_SHELL_FILE_INFO
**FileList
2161 CHAR16
*PatternCopy
;
2162 CHAR16
*PatternCurrentLocation
;
2163 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2164 SHELL_FILE_HANDLE RootFileHandle
;
2168 if ( FilePattern
== NULL
2170 || StrStr(FilePattern
, L
":") == NULL
2172 return (EFI_INVALID_PARAMETER
);
2174 Status
= EFI_SUCCESS
;
2175 RootDevicePath
= NULL
;
2176 RootFileHandle
= NULL
;
2178 PatternCopy
= AllocateZeroPool(StrSize(FilePattern
));
2179 if (PatternCopy
== NULL
) {
2180 return (EFI_OUT_OF_RESOURCES
);
2182 StrCpy(PatternCopy
, FilePattern
);
2184 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2186 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2189 ASSERT(MapName
== NULL
);
2190 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2191 if (MapName
== NULL
) {
2192 Status
= EFI_OUT_OF_RESOURCES
;
2194 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2195 if (RootDevicePath
== NULL
) {
2196 Status
= EFI_INVALID_PARAMETER
;
2198 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2199 if (!EFI_ERROR(Status
)) {
2200 for ( PatternCurrentLocation
= PatternCopy
2201 ; *PatternCurrentLocation
!= ':'
2202 ; PatternCurrentLocation
++);
2203 PatternCurrentLocation
++;
2204 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2206 FreePool(RootDevicePath
);
2210 SHELL_FREE_NON_NULL(PatternCopy
);
2211 SHELL_FREE_NON_NULL(MapName
);
2217 Opens the files that match the path specified.
2219 This function opens all of the files specified by Path. Wildcards are processed
2220 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2221 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2223 @param Path A pointer to the path string.
2224 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2225 EFI_FILE_MODE_WRITE.
2226 @param FileList Points to the start of a list of files opened.
2228 @retval EFI_SUCCESS Create the file list successfully.
2229 @return Others Can't create the file list.
2233 EfiShellOpenFileList(
2236 IN OUT EFI_SHELL_FILE_INFO
**FileList
2240 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2243 CONST CHAR16
*CurDir
;
2246 PathCleanUpDirectories(Path
);
2251 if (FileList
== NULL
|| *FileList
== NULL
) {
2252 return (EFI_INVALID_PARAMETER
);
2255 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2260 // convert a local path to an absolute path
2262 if (StrStr(Path
, L
":") == NULL
) {
2263 CurDir
= EfiShellGetCurDir(NULL
);
2264 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2265 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2266 if (*Path
== L
'\\') {
2268 while (PathRemoveLastItem(Path2
)) ;
2270 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2271 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2273 ASSERT(Path2
== NULL
);
2274 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2277 PathCleanUpDirectories (Path2
);
2282 Status
= EfiShellFindFiles(Path2
, FileList
);
2286 if (EFI_ERROR(Status
)) {
2292 // We had no errors so open all the files (that are not already opened...)
2294 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2295 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2296 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2298 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2299 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2305 return (EFI_NOT_FOUND
);
2307 return(EFI_SUCCESS
);
2311 This function updated with errata.
2313 Gets either a single or list of environment variables.
2315 If name is not NULL then this function returns the current value of the specified
2316 environment variable.
2318 If Name is NULL, then a list of all environment variable names is returned. Each is a
2319 NULL terminated string with a double NULL terminating the list.
2321 @param Name A pointer to the environment variable name. If
2322 Name is NULL, then the function will return all
2323 of the defined shell environment variables. In
2324 the case where multiple environment variables are
2325 being returned, each variable will be terminated by
2326 a NULL, and the list will be terminated by a double
2329 @return !=NULL A pointer to the returned string.
2330 The returned pointer does not need to be freed by the caller.
2332 @retval NULL The environment variable doesn't exist or there are
2333 no environment variables.
2338 IN CONST CHAR16
*Name
2346 CHAR16
*CurrentWriteLocation
;
2353 // Get all our environment variables
2355 InitializeListHead(&List
);
2356 Status
= GetEnvironmentVariableList(&List
);
2357 if (EFI_ERROR(Status
)){
2362 // Build the semi-colon delimited list. (2 passes)
2364 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2365 ; !IsNull(&List
, &Node
->Link
)
2366 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2368 ASSERT(Node
->Key
!= NULL
);
2369 Size
+= StrSize(Node
->Key
);
2372 Size
+= 2*sizeof(CHAR16
);
2374 Buffer
= AllocateZeroPool(Size
);
2375 if (Buffer
== NULL
) {
2376 if (!IsListEmpty (&List
)) {
2377 FreeEnvironmentVariableList(&List
);
2381 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2383 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2384 ; !IsNull(&List
, &Node
->Link
)
2385 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2387 ASSERT(Node
->Key
!= NULL
);
2388 StrCpy(CurrentWriteLocation
, Node
->Key
);
2389 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2395 if (!IsListEmpty (&List
)) {
2396 FreeEnvironmentVariableList(&List
);
2400 // We are doing a specific environment variable
2404 // get the size we need for this EnvVariable
2406 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2407 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2409 // Allocate the space and recall the get function
2411 Buffer
= AllocateZeroPool(Size
);
2412 ASSERT(Buffer
!= NULL
);
2413 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2416 // we didnt get it (might not exist)
2417 // free the memory if we allocated any and return NULL
2419 if (EFI_ERROR(Status
)) {
2420 if (Buffer
!= NULL
) {
2428 // return the buffer
2430 return (AddBufferToFreeList(Buffer
));
2434 Internal variable setting function. Allows for setting of the read only variables.
2436 @param Name Points to the NULL-terminated environment variable name.
2437 @param Value Points to the NULL-terminated environment variable value. If the value is an
2438 empty string then the environment variable is deleted.
2439 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2441 @retval EFI_SUCCESS The environment variable was successfully updated.
2445 InternalEfiShellSetEnv(
2446 IN CONST CHAR16
*Name
,
2447 IN CONST CHAR16
*Value
,
2451 if (Value
== NULL
|| StrLen(Value
) == 0) {
2452 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2454 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2456 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2458 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2464 Sets the environment variable.
2466 This function changes the current value of the specified environment variable. If the
2467 environment variable exists and the Value is an empty string, then the environment
2468 variable is deleted. If the environment variable exists and the Value is not an empty
2469 string, then the value of the environment variable is changed. If the environment
2470 variable does not exist and the Value is an empty string, there is no action. If the
2471 environment variable does not exist and the Value is a non-empty string, then the
2472 environment variable is created and assigned the specified value.
2474 For a description of volatile and non-volatile environment variables, see UEFI Shell
2475 2.0 specification section 3.6.1.
2477 @param Name Points to the NULL-terminated environment variable name.
2478 @param Value Points to the NULL-terminated environment variable value. If the value is an
2479 empty string then the environment variable is deleted.
2480 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2482 @retval EFI_SUCCESS The environment variable was successfully updated.
2487 IN CONST CHAR16
*Name
,
2488 IN CONST CHAR16
*Value
,
2492 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2493 return (EFI_INVALID_PARAMETER
);
2496 // Make sure we dont 'set' a predefined read only variable
2498 if (gUnicodeCollation
->StriColl(
2502 ||gUnicodeCollation
->StriColl(
2506 ||gUnicodeCollation
->StriColl(
2510 ||gUnicodeCollation
->StriColl(
2513 L
"uefishellsupport") == 0
2514 ||gUnicodeCollation
->StriColl(
2517 L
"uefishellversion") == 0
2518 ||gUnicodeCollation
->StriColl(
2521 L
"uefiversion") == 0
2523 return (EFI_INVALID_PARAMETER
);
2525 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2529 Returns the current directory on the specified device.
2531 If FileSystemMapping is NULL, it returns the current working directory. If the
2532 FileSystemMapping is not NULL, it returns the current directory associated with the
2533 FileSystemMapping. In both cases, the returned name includes the file system
2534 mapping (i.e. fs0:\current-dir).
2536 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2537 then the current working directory is returned.
2539 @retval !=NULL The current directory.
2540 @retval NULL Current directory does not exist.
2545 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2548 CHAR16
*PathToReturn
;
2550 SHELL_MAP_LIST
*MapListItem
;
2551 if (!IsListEmpty(&gShellMapList
.Link
)) {
2553 // if parameter is NULL, use current
2555 if (FileSystemMapping
== NULL
) {
2556 return (EfiShellGetEnv(L
"cwd"));
2559 PathToReturn
= NULL
;
2560 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2561 if (MapListItem
!= NULL
) {
2562 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2563 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2564 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2567 return (AddBufferToFreeList(PathToReturn
));
2574 Changes the current directory on the specified device.
2576 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2577 mapped name, this function changes the current working directory.
2579 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2580 current file system and the current directory on that file system are changed.
2582 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2585 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2586 directory on the specified file system.
2588 If the current working directory or the current working file system is changed then the
2589 %cwd% environment variable will be updated
2591 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2592 directory is changed.
2593 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2595 @retval EFI_SUCCESS The operation was sucessful
2596 @retval EFI_NOT_FOUND The file system could not be found
2601 IN CONST CHAR16
*FileSystem OPTIONAL
,
2602 IN CONST CHAR16
*Dir
2606 SHELL_MAP_LIST
*MapListItem
;
2610 CHAR16
*DirectoryName
;
2617 DirectoryName
= NULL
;
2619 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2620 return (EFI_INVALID_PARAMETER
);
2623 if (IsListEmpty(&gShellMapList
.Link
)){
2624 return (EFI_NOT_FOUND
);
2627 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2628 ASSERT(DirectoryName
!= NULL
);
2630 PathCleanUpDirectories(DirectoryName
);
2632 if (FileSystem
== NULL
) {
2634 // determine the file system mapping to use
2636 if (StrStr(DirectoryName
, L
":") != NULL
) {
2637 ASSERT(MapName
== NULL
);
2638 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2641 // find the file system mapping's entry in the list
2644 if (MapName
!= NULL
) {
2645 MapListItem
= ShellCommandFindMapItem(MapName
);
2648 // make that the current file system mapping
2650 if (MapListItem
!= NULL
) {
2651 gShellCurDir
= MapListItem
;
2654 MapListItem
= gShellCurDir
;
2657 if (MapListItem
== NULL
) {
2658 return (EFI_NOT_FOUND
);
2662 // now update the MapListItem's current directory
2664 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2665 FreePool(MapListItem
->CurrentDirectoryPath
);
2666 MapListItem
->CurrentDirectoryPath
= NULL
;
2668 if (MapName
!= NULL
) {
2669 TempLen
= StrLen(MapName
);
2670 if (TempLen
!= StrLen(DirectoryName
)) {
2671 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2672 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2675 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2676 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2678 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2679 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2680 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2684 // cant have a mapping in the directory...
2686 if (StrStr(DirectoryName
, L
":") != NULL
) {
2687 return (EFI_INVALID_PARAMETER
);
2690 // FileSystem != NULL
2692 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2693 if (MapListItem
== NULL
) {
2694 return (EFI_INVALID_PARAMETER
);
2696 // gShellCurDir = MapListItem;
2697 if (DirectoryName
!= NULL
) {
2699 // change current dir on that file system
2702 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2703 FreePool(MapListItem
->CurrentDirectoryPath
);
2704 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2706 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2707 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2708 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2709 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2710 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2711 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2712 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
2713 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2714 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2719 // if updated the current directory then update the environment variable
2721 if (MapListItem
== gShellCurDir
) {
2723 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2724 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
2725 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2726 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2727 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
2728 FreePool(TempString
);
2731 return(EFI_SUCCESS
);
2735 Return help information about a specific command.
2737 This function returns the help information for the specified command. The help text
2738 can be internal to the shell or can be from a UEFI Shell manual page.
2740 If Sections is specified, then each section name listed will be compared in a casesensitive
2741 manner, to the section names described in Appendix B. If the section exists,
2742 it will be appended to the returned help text. If the section does not exist, no
2743 information will be returned. If Sections is NULL, then all help text information
2744 available will be returned.
2746 @param Command Points to the NULL-terminated UEFI Shell command name.
2747 @param Sections Points to the NULL-terminated comma-delimited
2748 section names to return. If NULL, then all
2749 sections will be returned.
2750 @param HelpText On return, points to a callee-allocated buffer
2751 containing all specified help text.
2753 @retval EFI_SUCCESS The help text was returned.
2754 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
2756 @retval EFI_INVALID_PARAMETER HelpText is NULL
2757 @retval EFI_NOT_FOUND There is no help text available for Command.
2761 EfiShellGetHelpText(
2762 IN CONST CHAR16
*Command
,
2763 IN CONST CHAR16
*Sections OPTIONAL
,
2764 OUT CHAR16
**HelpText
2767 CONST CHAR16
*ManFileName
;
2771 ASSERT(HelpText
!= NULL
);
2774 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
2776 if (ManFileName
!= NULL
) {
2777 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
2779 if ((StrLen(Command
)> 4)
2780 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
2781 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
2782 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
2783 && (Command
[StrLen(Command
)-4] == L
'.')
2785 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
2786 ASSERT(FixCommand
!= NULL
);
2788 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
2789 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
2790 FreePool(FixCommand
);
2793 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
2799 Gets the enable status of the page break output mode.
2801 User can use this function to determine current page break mode.
2803 @retval TRUE The page break output mode is enabled.
2804 @retval FALSE The page break output mode is disabled.
2808 EfiShellGetPageBreak(
2812 return(ShellInfoObject
.PageBreakEnabled
);
2816 Judges whether the active shell is the root shell.
2818 This function makes the user to know that whether the active Shell is the root shell.
2820 @retval TRUE The active Shell is the root Shell.
2821 @retval FALSE The active Shell is NOT the root Shell.
2825 EfiShellIsRootShell(
2829 return(ShellInfoObject
.RootShellInstance
);
2833 function to return a semi-colon delimeted list of all alias' in the current shell
2835 up to caller to free the memory.
2837 @retval NULL No alias' were found
2838 @retval NULL An error ocurred getting alias'
2839 @return !NULL a list of all alias'
2843 InternalEfiShellGetListAlias(
2851 CHAR16
*VariableName
;
2856 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
2857 ASSERT_EFI_ERROR(Status
);
2859 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
2863 if (VariableName
== NULL
) {
2867 VariableName
[0] = CHAR_NULL
;
2870 NameSize
= (UINTN
)MaxVarSize
;
2871 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
2872 if (Status
== EFI_NOT_FOUND
){
2875 ASSERT_EFI_ERROR(Status
);
2876 if (EFI_ERROR(Status
)) {
2879 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
2880 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
2881 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
2882 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
2885 FreePool(VariableName
);
2891 This function returns the command associated with a alias or a list of all
2894 @param[in] Alias Points to the NULL-terminated shell alias.
2895 If this parameter is NULL, then all
2896 aliases will be returned in ReturnedData.
2897 @param[out] Volatile upon return of a single command if TRUE indicates
2898 this is stored in a volatile fashion. FALSE otherwise.
2900 @return If Alias is not NULL, it will return a pointer to
2901 the NULL-terminated command for that alias.
2902 If Alias is NULL, ReturnedData points to a ';'
2903 delimited list of alias (e.g.
2904 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
2905 @retval NULL an error ocurred
2906 @retval NULL Alias was not a valid Alias
2911 IN CONST CHAR16
*Alias
,
2912 OUT BOOLEAN
*Volatile OPTIONAL
2920 if (Alias
!= NULL
) {
2921 if (Volatile
== NULL
) {
2922 return (AddBufferToFreeList(GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
)));
2926 Status
= gRT
->GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
2927 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2928 RetVal
= AllocateZeroPool(RetSize
);
2929 Status
= gRT
->GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
2931 if (EFI_ERROR(Status
)) {
2932 if (RetVal
!= NULL
) {
2937 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
2943 return (AddBufferToFreeList(RetVal
));
2945 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
2949 Changes a shell command alias.
2951 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
2953 this function does not check for built in alias'.
2955 @param[in] Command Points to the NULL-terminated shell command or existing alias.
2956 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
2957 Command refers to an alias, that alias will be deleted.
2958 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
2959 Alias being set will be stored in a non-volatile fashion.
2961 @retval EFI_SUCCESS Alias created or deleted successfully.
2962 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
2967 IN CONST CHAR16
*Command
,
2968 IN CONST CHAR16
*Alias
,
2973 // We must be trying to remove one if Alias is NULL
2975 if (Alias
== NULL
) {
2977 // remove an alias (but passed in COMMAND parameter)
2979 return (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
2982 // Add and replace are the same
2985 // We dont check the error return on purpose since the variable may not exist.
2986 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
2988 return (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
2993 Changes a shell command alias.
2995 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
2998 @param[in] Command Points to the NULL-terminated shell command or existing alias.
2999 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3000 Command refers to an alias, that alias will be deleted.
3001 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3002 FALSE and the alias already exists, then the existing alias is unchanged and
3003 EFI_ACCESS_DENIED is returned.
3004 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3005 Alias being set will be stored in a non-volatile fashion.
3007 @retval EFI_SUCCESS Alias created or deleted successfully.
3008 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3009 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3015 IN CONST CHAR16
*Command
,
3016 IN CONST CHAR16
*Alias
,
3022 // cant set over a built in alias
3024 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3025 return (EFI_ACCESS_DENIED
);
3027 if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3028 return (EFI_INVALID_PARAMETER
);
3031 if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3032 return (EFI_ACCESS_DENIED
);
3035 return (InternalSetAlias(Command
, Alias
, Volatile
));
3038 // Pure FILE_HANDLE operations are passed to FileHandleLib
3039 // these functions are indicated by the *
3040 EFI_SHELL_PROTOCOL mShellProtocol
= {
3046 EfiShellGetHelpText
,
3047 EfiShellGetDevicePathFromMap
,
3048 EfiShellGetMapFromDevicePath
,
3049 EfiShellGetDevicePathFromFilePath
,
3050 EfiShellGetFilePathFromDevicePath
,
3054 EfiShellOpenFileList
,
3055 EfiShellFreeFileList
,
3056 EfiShellRemoveDupInFileList
,
3057 EfiShellBatchIsActive
,
3058 EfiShellIsRootShell
,
3059 EfiShellEnablePageBreak
,
3060 EfiShellDisablePageBreak
,
3061 EfiShellGetPageBreak
,
3062 EfiShellGetDeviceName
,
3063 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3064 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3065 EfiShellOpenFileByName
,
3068 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3069 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3070 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3071 EfiShellDeleteFileByName
,
3072 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3073 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3074 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3076 EfiShellFindFilesInDir
,
3077 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3079 EfiShellOpenRootByHandle
,
3081 SHELL_MAJOR_VERSION
,
3086 Function to create and install on the current handle.
3088 Will overwrite any existing ShellProtocols in the system to be sure that
3089 the current shell is in control.
3091 This must be removed via calling CleanUpShellProtocol().
3093 @param[in, out] NewShell The pointer to the pointer to the structure
3096 @retval EFI_SUCCESS The operation was successful.
3097 @return An error from LocateHandle, CreateEvent, or other core function.
3101 CreatePopulateInstallShellProtocol (
3102 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3108 UINTN HandleCounter
;
3109 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3111 if (NewShell
== NULL
) {
3112 return (EFI_INVALID_PARAMETER
);
3117 OldProtocolNode
= NULL
;
3118 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3121 // Initialize EfiShellProtocol object...
3123 Status
= gBS
->CreateEvent(0,
3127 &mShellProtocol
.ExecutionBreak
);
3128 if (EFI_ERROR(Status
)) {
3133 // Get the size of the buffer we need.
3135 Status
= gBS
->LocateHandle(ByProtocol
,
3136 &gEfiShellProtocolGuid
,
3140 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3142 // Allocate and recall with buffer of correct size
3144 Buffer
= AllocateZeroPool(BufferSize
);
3145 if (Buffer
== NULL
) {
3146 return (EFI_OUT_OF_RESOURCES
);
3148 Status
= gBS
->LocateHandle(ByProtocol
,
3149 &gEfiShellProtocolGuid
,
3153 if (EFI_ERROR(Status
)) {
3158 // now overwrite each of them, but save the info to restore when we end.
3160 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3161 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3162 ASSERT(OldProtocolNode
!= NULL
);
3163 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3164 &gEfiShellProtocolGuid
,
3165 (VOID
**) &(OldProtocolNode
->Interface
),
3168 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3170 if (!EFI_ERROR(Status
)) {
3172 // reinstall over the old one...
3174 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3175 Status
= gBS
->ReinstallProtocolInterface(
3176 OldProtocolNode
->Handle
,
3177 &gEfiShellProtocolGuid
,
3178 OldProtocolNode
->Interface
,
3179 (VOID
*)(&mShellProtocol
));
3180 if (!EFI_ERROR(Status
)) {
3182 // we reinstalled sucessfully. log this so we can reverse it later.
3186 // add to the list for subsequent...
3188 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3193 } else if (Status
== EFI_NOT_FOUND
) {
3194 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3196 // no one else published yet. just publish it ourselves.
3198 Status
= gBS
->InstallProtocolInterface (
3200 &gEfiShellProtocolGuid
,
3201 EFI_NATIVE_INTERFACE
,
3202 (VOID
*)(&mShellProtocol
));
3205 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3206 ///@todo support ShellEnvironment2
3207 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3210 if (!EFI_ERROR(Status
)) {
3211 *NewShell
= &mShellProtocol
;
3217 Opposite of CreatePopulateInstallShellProtocol.
3219 Free all memory and restore the system to the state it was in before calling
3220 CreatePopulateInstallShellProtocol.
3222 @param[in, out] NewShell The pointer to the new shell protocol structure.
3224 @retval EFI_SUCCESS The operation was successful.
3228 CleanUpShellProtocol (
3229 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3233 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3234 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3237 // if we need to restore old protocols...
3239 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3240 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3241 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3242 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3244 RemoveEntryList(&Node2
->Link
);
3245 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3246 &gEfiShellProtocolGuid
,
3253 // no need to restore
3255 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3256 &gEfiShellProtocolGuid
,
3259 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3260 NewShell
->ExecutionBreak
= NULL
;
3262 Status
= gBS
->OpenProtocol(
3263 gST
->ConsoleInHandle
,
3264 &gEfiSimpleTextInputExProtocolGuid
,
3268 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3270 if (!EFI_ERROR (Status
)) {
3271 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3272 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3273 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3274 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3275 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3276 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3277 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3278 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3284 Notification function for keystrokes.
3286 @param[in] KeyData The key that was pressed.
3288 @retval EFI_SUCCESS The operation was successful.
3292 NotificationFunction(
3293 IN EFI_KEY_DATA
*KeyData
3296 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3297 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3298 (KeyData
->Key
.UnicodeChar
== 3)
3300 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3301 return (EFI_UNSUPPORTED
);
3303 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3304 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3305 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3307 ShellInfoObject
.HaltOutput
= TRUE
;
3309 return (EFI_SUCCESS
);
3313 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3314 feature's enabled state was not known when the shell initially launched.
3316 @retval EFI_SUCCESS The feature is enabled.
3317 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3321 InernalEfiShellStartMonitor(
3325 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3326 EFI_KEY_DATA KeyData
;
3329 Status
= gBS
->OpenProtocol(
3330 gST
->ConsoleInHandle
,
3331 &gEfiSimpleTextInputExProtocolGuid
,
3335 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3336 if (EFI_ERROR(Status
)) {
3341 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3342 ShellInfoObject
.HiiHandle
);
3343 return (EFI_SUCCESS
);
3346 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3347 return (EFI_UNSUPPORTED
);
3350 KeyData
.KeyState
.KeyToggleState
= 0;
3351 KeyData
.Key
.ScanCode
= 0;
3352 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3353 KeyData
.Key
.UnicodeChar
= L
'c';
3355 Status
= SimpleEx
->RegisterKeyNotify(
3358 NotificationFunction
,
3359 &ShellInfoObject
.CtrlCNotifyHandle1
);
3361 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3362 if (!EFI_ERROR(Status
)) {
3363 Status
= SimpleEx
->RegisterKeyNotify(
3366 NotificationFunction
,
3367 &ShellInfoObject
.CtrlCNotifyHandle2
);
3369 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3370 KeyData
.Key
.UnicodeChar
= 3;
3371 if (!EFI_ERROR(Status
)) {
3372 Status
= SimpleEx
->RegisterKeyNotify(
3375 NotificationFunction
,
3376 &ShellInfoObject
.CtrlCNotifyHandle3
);
3378 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3379 if (!EFI_ERROR(Status
)) {
3380 Status
= SimpleEx
->RegisterKeyNotify(
3383 NotificationFunction
,
3384 &ShellInfoObject
.CtrlCNotifyHandle4
);