2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 Copyright (c) 2009 - 2013, 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 return(EFI_SUCCESS
);
1626 Deletes the duplicate file names files in the given file list.
1628 This function deletes the reduplicate files in the given file list.
1630 @param FileList A pointer to the first entry in the file list.
1632 @retval EFI_SUCCESS Always success.
1633 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1637 EfiShellRemoveDupInFileList(
1638 IN EFI_SHELL_FILE_INFO
**FileList
1641 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1642 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1644 if (FileList
== NULL
|| *FileList
== NULL
) {
1645 return (EFI_INVALID_PARAMETER
);
1647 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1648 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1649 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1651 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1652 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1653 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1655 if (gUnicodeCollation
->StriColl(
1657 (CHAR16
*)ShellFileListItem
->FullName
,
1658 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1660 RemoveEntryList(&ShellFileListItem2
->Link
);
1661 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1665 return (EFI_SUCCESS
);
1668 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1670 @param[in] Node The node to copy from.
1671 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1673 @retval NULL a memory allocation error ocurred
1674 @return != NULL a pointer to the new node
1676 EFI_SHELL_FILE_INFO
*
1678 InternalDuplicateShellFileInfo(
1679 IN EFI_SHELL_FILE_INFO
*Node
,
1683 EFI_SHELL_FILE_INFO
*NewNode
;
1685 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1686 if (NewNode
== NULL
) {
1689 NewNode
->FullName
= AllocateZeroPool(StrSize(Node
->FullName
));
1691 NewNode
->FileName
= AllocateZeroPool(StrSize(Node
->FileName
));
1692 NewNode
->Info
= AllocateZeroPool((UINTN
)Node
->Info
->Size
);
1693 if ( NewNode
->FullName
== NULL
1694 || NewNode
->FileName
== NULL
1695 || NewNode
->Info
== NULL
1699 NewNode
->Status
= Node
->Status
;
1700 NewNode
->Handle
= Node
->Handle
;
1702 Node
->Handle
= NULL
;
1704 StrCpy((CHAR16
*)NewNode
->FullName
, Node
->FullName
);
1705 StrCpy((CHAR16
*)NewNode
->FileName
, Node
->FileName
);
1706 CopyMem(NewNode
->Info
, Node
->Info
, (UINTN
)Node
->Info
->Size
);
1712 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1713 failed it will return NULL.
1715 @param[in] BasePath the Path to prepend onto filename for FullPath
1716 @param[in] Status Status member initial value.
1717 @param[in] FullName FullName 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
*FullName
,
1731 IN CONST CHAR16
*FileName
,
1732 IN CONST SHELL_FILE_HANDLE Handle
,
1733 IN CONST EFI_FILE_INFO
*Info
1736 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1743 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1744 if (ShellFileListItem
== NULL
) {
1747 if (Info
!= NULL
&& Info
->Size
!= 0) {
1748 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1749 if (ShellFileListItem
->Info
== NULL
) {
1750 FreePool(ShellFileListItem
);
1753 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1755 ShellFileListItem
->Info
= NULL
;
1757 if (FileName
!= NULL
) {
1758 ASSERT(TempString
== NULL
);
1759 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1760 if (ShellFileListItem
->FileName
== NULL
) {
1761 FreePool(ShellFileListItem
->Info
);
1762 FreePool(ShellFileListItem
);
1766 ShellFileListItem
->FileName
= NULL
;
1770 if (BasePath
!= NULL
) {
1771 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1772 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1773 if (TempString
== NULL
) {
1774 FreePool((VOID
*)ShellFileListItem
->FileName
);
1775 FreePool(ShellFileListItem
->Info
);
1776 FreePool(ShellFileListItem
);
1780 if (ShellFileListItem
->FileName
!= NULL
) {
1781 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1782 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1783 if (TempString
== NULL
) {
1784 FreePool((VOID
*)ShellFileListItem
->FileName
);
1785 FreePool(ShellFileListItem
->Info
);
1786 FreePool(ShellFileListItem
);
1791 ShellFileListItem
->FullName
= TempString
;
1792 ShellFileListItem
->Status
= Status
;
1793 ShellFileListItem
->Handle
= Handle
;
1795 return (ShellFileListItem
);
1799 Find all files in a specified directory.
1801 @param FileDirHandle Handle of the directory to search.
1802 @param FileList On return, points to the list of files in the directory
1803 or NULL if there are no files in the directory.
1805 @retval EFI_SUCCESS File information was returned successfully.
1806 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1807 @retval EFI_DEVICE_ERROR The device reported an error.
1808 @retval EFI_NO_MEDIA The device media is not present.
1809 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1810 @return An error from FileHandleGetFileName().
1814 EfiShellFindFilesInDir(
1815 IN SHELL_FILE_HANDLE FileDirHandle
,
1816 OUT EFI_SHELL_FILE_INFO
**FileList
1819 EFI_SHELL_FILE_INFO
*ShellFileList
;
1820 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1821 EFI_FILE_INFO
*FileInfo
;
1829 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1830 if (EFI_ERROR(Status
)) {
1834 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1837 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1838 if (TempString
== NULL
) {
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 return (EFI_OUT_OF_RESOURCES
);
1851 BasePath
= TempString
;
1855 ShellFileList
= NULL
;
1856 ShellFileListItem
= NULL
;
1858 Status
= EFI_SUCCESS
;
1861 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
1862 ; !EFI_ERROR(Status
) && !NoFile
1863 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
1868 // allocate a new EFI_SHELL_FILE_INFO and populate it...
1870 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1871 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1872 TempString
= StrnCatGrow(&TempString
, &Size
, FileInfo
->FileName
, 0);
1873 ShellFileListItem
= CreateAndPopulateShellFileInfo(
1875 EFI_SUCCESS
, // success since we didnt fail to open it...
1878 NULL
, // no handle since not open
1881 if (ShellFileList
== NULL
) {
1882 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1883 ASSERT(ShellFileList
!= NULL
);
1884 InitializeListHead(&ShellFileList
->Link
);
1886 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
1888 if (EFI_ERROR(Status
)) {
1889 EfiShellFreeFileList(&ShellFileList
);
1892 *FileList
= ShellFileList
;
1894 SHELL_FREE_NON_NULL(BasePath
);
1899 Updates a file name to be preceeded by the mapped drive name
1901 @param[in] BasePath the Mapped drive name to prepend
1902 @param[in, out] Path pointer to pointer to the file name to update.
1905 @retval EFI_OUT_OF_RESOURCES
1910 IN CONST CHAR16
*BasePath
,
1911 IN OUT CHAR16
**Path
1920 ASSERT(Path
!= NULL
);
1921 ASSERT(*Path
!= NULL
);
1922 ASSERT(BasePath
!= NULL
);
1925 // convert a local path to an absolute path
1927 if (StrStr(*Path
, L
":") == NULL
) {
1928 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
1929 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
1930 if (Path2
== NULL
) {
1931 return (EFI_OUT_OF_RESOURCES
);
1933 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
1934 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
1935 if (Path2
== NULL
) {
1936 return (EFI_OUT_OF_RESOURCES
);
1943 return (EFI_SUCCESS
);
1947 If FileHandle is a directory then the function reads from FileHandle and reads in
1948 each of the FileInfo structures. If one of them matches the Pattern's first
1949 "level" then it opens that handle and calls itself on that handle.
1951 If FileHandle is a file and matches all of the remaining Pattern (which would be
1952 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
1954 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
1955 FreeFileList with FileList.
1957 @param[in] FilePattern The FilePattern to check against.
1958 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
1959 @param[in] FileHandle The FileHandle to start with
1960 @param[in, out] FileList pointer to pointer to list of found files.
1961 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
1962 @param[in] MapName The file system name this file is on.
1964 @retval EFI_SUCCESS all files were found and the FileList contains a list.
1965 @retval EFI_NOT_FOUND no files were found
1966 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
1971 IN CONST CHAR16
*FilePattern
,
1972 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
1973 IN SHELL_FILE_HANDLE FileHandle
,
1974 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
1975 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
1976 IN CONST CHAR16
*MapName
1980 CONST CHAR16
*NextFilePatternStart
;
1981 CHAR16
*CurrentFilePattern
;
1982 EFI_SHELL_FILE_INFO
*ShellInfo
;
1983 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
1984 EFI_SHELL_FILE_INFO
*NewShellNode
;
1986 CHAR16
*NewFullName
;
1989 if ( FilePattern
== NULL
1990 || UnicodeCollation
== NULL
1993 return (EFI_INVALID_PARAMETER
);
1996 CurrentFilePattern
= NULL
;
1998 if (*FilePattern
== L
'\\') {
2002 for( NextFilePatternStart
= FilePattern
2003 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2004 ; NextFilePatternStart
++);
2006 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2007 ASSERT(CurrentFilePattern
!= NULL
);
2008 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2010 if (CurrentFilePattern
[0] == CHAR_NULL
2011 &&NextFilePatternStart
[0] == CHAR_NULL
2014 // Add the current parameter FileHandle to the list, then end...
2016 if (ParentNode
== NULL
) {
2017 Status
= EFI_INVALID_PARAMETER
;
2019 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2020 if (NewShellNode
== NULL
) {
2021 Status
= EFI_OUT_OF_RESOURCES
;
2023 NewShellNode
->Handle
= NULL
;
2024 if (*FileList
== NULL
) {
2025 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2026 InitializeListHead(&((*FileList
)->Link
));
2030 // Add to the returning to use list
2032 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2034 Status
= EFI_SUCCESS
;
2038 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2040 if (!EFI_ERROR(Status
)){
2041 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2046 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2047 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2048 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2050 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2051 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2052 Size
= StrSize(ShellInfoNode
->FullName
);
2053 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2054 NewFullName
= AllocateZeroPool(Size
);
2055 if (NewFullName
== NULL
) {
2056 Status
= EFI_OUT_OF_RESOURCES
;
2058 StrCpy(NewFullName
, MapName
);
2059 StrCat(NewFullName
, ShellInfoNode
->FullName
+1);
2060 FreePool((VOID
*)ShellInfoNode
->FullName
);
2061 ShellInfoNode
->FullName
= NewFullName
;
2064 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2066 // should be a directory
2070 // don't open the . and .. directories
2072 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2073 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2078 if (EFI_ERROR(Status
)) {
2082 // Open the directory since we need that handle in the next recursion.
2084 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2087 // recurse with the next part of the pattern
2089 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2091 } else if (!EFI_ERROR(Status
)) {
2097 // copy the information we need into a new Node
2099 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2100 ASSERT(NewShellNode
!= NULL
);
2101 if (NewShellNode
== NULL
) {
2102 Status
= EFI_OUT_OF_RESOURCES
;
2104 if (*FileList
== NULL
) {
2105 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2106 InitializeListHead(&((*FileList
)->Link
));
2110 // Add to the returning to use list
2112 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2115 if (EFI_ERROR(Status
)) {
2119 if (EFI_ERROR(Status
)) {
2120 EfiShellFreeFileList(&ShellInfo
);
2122 Status
= EfiShellFreeFileList(&ShellInfo
);
2127 FreePool(CurrentFilePattern
);
2132 Find files that match a specified pattern.
2134 This function searches for all files and directories that match the specified
2135 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2136 information is placed in the file list FileList.
2138 Wildcards are processed
2139 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2141 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2142 field is set to NULL.
2144 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2146 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2147 @param FileList On return, points to the start of a file list containing the names
2148 of all matching files or else points to NULL if no matching files
2149 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2151 @retval EFI_SUCCESS Files found. FileList is a valid list.
2152 @retval EFI_NOT_FOUND No files found.
2153 @retval EFI_NO_MEDIA The device has no media
2154 @retval EFI_DEVICE_ERROR The device reported an error
2155 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2160 IN CONST CHAR16
*FilePattern
,
2161 OUT EFI_SHELL_FILE_INFO
**FileList
2165 CHAR16
*PatternCopy
;
2166 CHAR16
*PatternCurrentLocation
;
2167 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2168 SHELL_FILE_HANDLE RootFileHandle
;
2172 if ( FilePattern
== NULL
2174 || StrStr(FilePattern
, L
":") == NULL
2176 return (EFI_INVALID_PARAMETER
);
2178 Status
= EFI_SUCCESS
;
2179 RootDevicePath
= NULL
;
2180 RootFileHandle
= NULL
;
2182 PatternCopy
= AllocateZeroPool(StrSize(FilePattern
));
2183 if (PatternCopy
== NULL
) {
2184 return (EFI_OUT_OF_RESOURCES
);
2186 StrCpy(PatternCopy
, FilePattern
);
2188 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2190 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2193 ASSERT(MapName
== NULL
);
2194 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2195 if (MapName
== NULL
) {
2196 Status
= EFI_OUT_OF_RESOURCES
;
2198 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2199 if (RootDevicePath
== NULL
) {
2200 Status
= EFI_INVALID_PARAMETER
;
2202 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2203 if (!EFI_ERROR(Status
)) {
2204 for ( PatternCurrentLocation
= PatternCopy
2205 ; *PatternCurrentLocation
!= ':'
2206 ; PatternCurrentLocation
++);
2207 PatternCurrentLocation
++;
2208 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2210 FreePool(RootDevicePath
);
2214 SHELL_FREE_NON_NULL(PatternCopy
);
2215 SHELL_FREE_NON_NULL(MapName
);
2221 Opens the files that match the path specified.
2223 This function opens all of the files specified by Path. Wildcards are processed
2224 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2225 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2227 @param Path A pointer to the path string.
2228 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2229 EFI_FILE_MODE_WRITE.
2230 @param FileList Points to the start of a list of files opened.
2232 @retval EFI_SUCCESS Create the file list successfully.
2233 @return Others Can't create the file list.
2237 EfiShellOpenFileList(
2240 IN OUT EFI_SHELL_FILE_INFO
**FileList
2244 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2247 CONST CHAR16
*CurDir
;
2250 PathCleanUpDirectories(Path
);
2255 if (FileList
== NULL
|| *FileList
== NULL
) {
2256 return (EFI_INVALID_PARAMETER
);
2259 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2264 // convert a local path to an absolute path
2266 if (StrStr(Path
, L
":") == NULL
) {
2267 CurDir
= EfiShellGetCurDir(NULL
);
2268 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2269 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2270 if (*Path
== L
'\\') {
2272 while (PathRemoveLastItem(Path2
)) ;
2274 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2275 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2277 ASSERT(Path2
== NULL
);
2278 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2281 PathCleanUpDirectories (Path2
);
2286 Status
= EfiShellFindFiles(Path2
, FileList
);
2290 if (EFI_ERROR(Status
)) {
2296 // We had no errors so open all the files (that are not already opened...)
2298 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2299 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2300 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2302 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2303 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2309 return (EFI_NOT_FOUND
);
2311 return(EFI_SUCCESS
);
2315 This function updated with errata.
2317 Gets either a single or list of environment variables.
2319 If name is not NULL then this function returns the current value of the specified
2320 environment variable.
2322 If Name is NULL, then a list of all environment variable names is returned. Each is a
2323 NULL terminated string with a double NULL terminating the list.
2325 @param Name A pointer to the environment variable name. If
2326 Name is NULL, then the function will return all
2327 of the defined shell environment variables. In
2328 the case where multiple environment variables are
2329 being returned, each variable will be terminated by
2330 a NULL, and the list will be terminated by a double
2333 @return !=NULL A pointer to the returned string.
2334 The returned pointer does not need to be freed by the caller.
2336 @retval NULL The environment variable doesn't exist or there are
2337 no environment variables.
2342 IN CONST CHAR16
*Name
2350 CHAR16
*CurrentWriteLocation
;
2357 // Get all our environment variables
2359 InitializeListHead(&List
);
2360 Status
= GetEnvironmentVariableList(&List
);
2361 if (EFI_ERROR(Status
)){
2366 // Build the semi-colon delimited list. (2 passes)
2368 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2369 ; !IsNull(&List
, &Node
->Link
)
2370 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2372 ASSERT(Node
->Key
!= NULL
);
2373 Size
+= StrSize(Node
->Key
);
2376 Size
+= 2*sizeof(CHAR16
);
2378 Buffer
= AllocateZeroPool(Size
);
2379 if (Buffer
== NULL
) {
2380 if (!IsListEmpty (&List
)) {
2381 FreeEnvironmentVariableList(&List
);
2385 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2387 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2388 ; !IsNull(&List
, &Node
->Link
)
2389 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2391 ASSERT(Node
->Key
!= NULL
);
2392 StrCpy(CurrentWriteLocation
, Node
->Key
);
2393 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2399 if (!IsListEmpty (&List
)) {
2400 FreeEnvironmentVariableList(&List
);
2404 // We are doing a specific environment variable
2408 // get the size we need for this EnvVariable
2410 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2411 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2413 // Allocate the space and recall the get function
2415 Buffer
= AllocateZeroPool(Size
);
2416 ASSERT(Buffer
!= NULL
);
2417 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2420 // we didnt get it (might not exist)
2421 // free the memory if we allocated any and return NULL
2423 if (EFI_ERROR(Status
)) {
2424 if (Buffer
!= NULL
) {
2432 // return the buffer
2434 return (AddBufferToFreeList(Buffer
));
2438 Internal variable setting function. Allows for setting of the read only variables.
2440 @param Name Points to the NULL-terminated environment variable name.
2441 @param Value Points to the NULL-terminated environment variable value. If the value is an
2442 empty string then the environment variable is deleted.
2443 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2445 @retval EFI_SUCCESS The environment variable was successfully updated.
2449 InternalEfiShellSetEnv(
2450 IN CONST CHAR16
*Name
,
2451 IN CONST CHAR16
*Value
,
2455 if (Value
== NULL
|| StrLen(Value
) == 0) {
2456 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2458 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2460 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2462 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2468 Sets the environment variable.
2470 This function changes the current value of the specified environment variable. If the
2471 environment variable exists and the Value is an empty string, then the environment
2472 variable is deleted. If the environment variable exists and the Value is not an empty
2473 string, then the value of the environment variable is changed. If the environment
2474 variable does not exist and the Value is an empty string, there is no action. If the
2475 environment variable does not exist and the Value is a non-empty string, then the
2476 environment variable is created and assigned the specified value.
2478 For a description of volatile and non-volatile environment variables, see UEFI Shell
2479 2.0 specification section 3.6.1.
2481 @param Name Points to the NULL-terminated environment variable name.
2482 @param Value Points to the NULL-terminated environment variable value. If the value is an
2483 empty string then the environment variable is deleted.
2484 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2486 @retval EFI_SUCCESS The environment variable was successfully updated.
2491 IN CONST CHAR16
*Name
,
2492 IN CONST CHAR16
*Value
,
2496 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2497 return (EFI_INVALID_PARAMETER
);
2500 // Make sure we dont 'set' a predefined read only variable
2502 if (gUnicodeCollation
->StriColl(
2506 ||gUnicodeCollation
->StriColl(
2510 ||gUnicodeCollation
->StriColl(
2514 ||gUnicodeCollation
->StriColl(
2517 L
"uefishellsupport") == 0
2518 ||gUnicodeCollation
->StriColl(
2521 L
"uefishellversion") == 0
2522 ||gUnicodeCollation
->StriColl(
2525 L
"uefiversion") == 0
2527 return (EFI_INVALID_PARAMETER
);
2529 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2533 Returns the current directory on the specified device.
2535 If FileSystemMapping is NULL, it returns the current working directory. If the
2536 FileSystemMapping is not NULL, it returns the current directory associated with the
2537 FileSystemMapping. In both cases, the returned name includes the file system
2538 mapping (i.e. fs0:\current-dir).
2540 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2541 then the current working directory is returned.
2543 @retval !=NULL The current directory.
2544 @retval NULL Current directory does not exist.
2549 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2552 CHAR16
*PathToReturn
;
2554 SHELL_MAP_LIST
*MapListItem
;
2555 if (!IsListEmpty(&gShellMapList
.Link
)) {
2557 // if parameter is NULL, use current
2559 if (FileSystemMapping
== NULL
) {
2560 return (EfiShellGetEnv(L
"cwd"));
2563 PathToReturn
= NULL
;
2564 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2565 if (MapListItem
!= NULL
) {
2566 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2567 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2568 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2571 return (AddBufferToFreeList(PathToReturn
));
2578 Changes the current directory on the specified device.
2580 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2581 mapped name, this function changes the current working directory.
2583 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2584 current file system and the current directory on that file system are changed.
2586 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2589 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2590 directory on the specified file system.
2592 If the current working directory or the current working file system is changed then the
2593 %cwd% environment variable will be updated
2595 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2596 directory is changed.
2597 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2599 @retval EFI_SUCCESS The operation was sucessful
2600 @retval EFI_NOT_FOUND The file system could not be found
2605 IN CONST CHAR16
*FileSystem OPTIONAL
,
2606 IN CONST CHAR16
*Dir
2610 SHELL_MAP_LIST
*MapListItem
;
2614 CHAR16
*DirectoryName
;
2621 DirectoryName
= NULL
;
2623 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2624 return (EFI_INVALID_PARAMETER
);
2627 if (IsListEmpty(&gShellMapList
.Link
)){
2628 return (EFI_NOT_FOUND
);
2631 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2632 ASSERT(DirectoryName
!= NULL
);
2634 PathCleanUpDirectories(DirectoryName
);
2636 if (FileSystem
== NULL
) {
2638 // determine the file system mapping to use
2640 if (StrStr(DirectoryName
, L
":") != NULL
) {
2641 ASSERT(MapName
== NULL
);
2642 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2645 // find the file system mapping's entry in the list
2648 if (MapName
!= NULL
) {
2649 MapListItem
= ShellCommandFindMapItem(MapName
);
2652 // make that the current file system mapping
2654 if (MapListItem
!= NULL
) {
2655 gShellCurDir
= MapListItem
;
2658 MapListItem
= gShellCurDir
;
2661 if (MapListItem
== NULL
) {
2662 return (EFI_NOT_FOUND
);
2666 // now update the MapListItem's current directory
2668 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2669 FreePool(MapListItem
->CurrentDirectoryPath
);
2670 MapListItem
->CurrentDirectoryPath
= NULL
;
2672 if (MapName
!= NULL
) {
2673 TempLen
= StrLen(MapName
);
2674 if (TempLen
!= StrLen(DirectoryName
)) {
2675 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2676 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2679 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2680 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2682 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2683 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2684 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2688 // cant have a mapping in the directory...
2690 if (StrStr(DirectoryName
, L
":") != NULL
) {
2691 return (EFI_INVALID_PARAMETER
);
2694 // FileSystem != NULL
2696 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2697 if (MapListItem
== NULL
) {
2698 return (EFI_INVALID_PARAMETER
);
2700 // gShellCurDir = MapListItem;
2701 if (DirectoryName
!= NULL
) {
2703 // change current dir on that file system
2706 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2707 FreePool(MapListItem
->CurrentDirectoryPath
);
2708 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2710 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2711 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2712 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2713 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2714 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2715 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2716 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
2717 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2718 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2723 // if updated the current directory then update the environment variable
2725 if (MapListItem
== gShellCurDir
) {
2727 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2728 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
2729 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2730 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2731 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
2732 FreePool(TempString
);
2735 return(EFI_SUCCESS
);
2739 Return help information about a specific command.
2741 This function returns the help information for the specified command. The help text
2742 can be internal to the shell or can be from a UEFI Shell manual page.
2744 If Sections is specified, then each section name listed will be compared in a casesensitive
2745 manner, to the section names described in Appendix B. If the section exists,
2746 it will be appended to the returned help text. If the section does not exist, no
2747 information will be returned. If Sections is NULL, then all help text information
2748 available will be returned.
2750 @param Command Points to the NULL-terminated UEFI Shell command name.
2751 @param Sections Points to the NULL-terminated comma-delimited
2752 section names to return. If NULL, then all
2753 sections will be returned.
2754 @param HelpText On return, points to a callee-allocated buffer
2755 containing all specified help text.
2757 @retval EFI_SUCCESS The help text was returned.
2758 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
2760 @retval EFI_INVALID_PARAMETER HelpText is NULL
2761 @retval EFI_NOT_FOUND There is no help text available for Command.
2765 EfiShellGetHelpText(
2766 IN CONST CHAR16
*Command
,
2767 IN CONST CHAR16
*Sections OPTIONAL
,
2768 OUT CHAR16
**HelpText
2771 CONST CHAR16
*ManFileName
;
2775 ASSERT(HelpText
!= NULL
);
2778 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
2780 if (ManFileName
!= NULL
) {
2781 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
2783 if ((StrLen(Command
)> 4)
2784 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
2785 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
2786 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
2787 && (Command
[StrLen(Command
)-4] == L
'.')
2789 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
2790 ASSERT(FixCommand
!= NULL
);
2792 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
2793 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
2794 FreePool(FixCommand
);
2797 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
2803 Gets the enable status of the page break output mode.
2805 User can use this function to determine current page break mode.
2807 @retval TRUE The page break output mode is enabled.
2808 @retval FALSE The page break output mode is disabled.
2812 EfiShellGetPageBreak(
2816 return(ShellInfoObject
.PageBreakEnabled
);
2820 Judges whether the active shell is the root shell.
2822 This function makes the user to know that whether the active Shell is the root shell.
2824 @retval TRUE The active Shell is the root Shell.
2825 @retval FALSE The active Shell is NOT the root Shell.
2829 EfiShellIsRootShell(
2833 return(ShellInfoObject
.RootShellInstance
);
2837 function to return a semi-colon delimeted list of all alias' in the current shell
2839 up to caller to free the memory.
2841 @retval NULL No alias' were found
2842 @retval NULL An error ocurred getting alias'
2843 @return !NULL a list of all alias'
2847 InternalEfiShellGetListAlias(
2855 CHAR16
*VariableName
;
2860 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
2861 ASSERT_EFI_ERROR(Status
);
2863 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
2867 if (VariableName
== NULL
) {
2871 VariableName
[0] = CHAR_NULL
;
2874 NameSize
= (UINTN
)MaxVarSize
;
2875 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
2876 if (Status
== EFI_NOT_FOUND
){
2879 ASSERT_EFI_ERROR(Status
);
2880 if (EFI_ERROR(Status
)) {
2883 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
2884 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
2885 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
2886 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
2889 FreePool(VariableName
);
2895 This function returns the command associated with a alias or a list of all
2898 @param[in] Alias Points to the NULL-terminated shell alias.
2899 If this parameter is NULL, then all
2900 aliases will be returned in ReturnedData.
2901 @param[out] Volatile upon return of a single command if TRUE indicates
2902 this is stored in a volatile fashion. FALSE otherwise.
2904 @return If Alias is not NULL, it will return a pointer to
2905 the NULL-terminated command for that alias.
2906 If Alias is NULL, ReturnedData points to a ';'
2907 delimited list of alias (e.g.
2908 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
2909 @retval NULL an error ocurred
2910 @retval NULL Alias was not a valid Alias
2915 IN CONST CHAR16
*Alias
,
2916 OUT BOOLEAN
*Volatile OPTIONAL
2924 if (Alias
!= NULL
) {
2925 if (Volatile
== NULL
) {
2926 return (AddBufferToFreeList(GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
)));
2930 Status
= gRT
->GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
2931 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2932 RetVal
= AllocateZeroPool(RetSize
);
2933 Status
= gRT
->GetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
2935 if (EFI_ERROR(Status
)) {
2936 if (RetVal
!= NULL
) {
2941 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
2947 return (AddBufferToFreeList(RetVal
));
2949 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
2953 Changes a shell command alias.
2955 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
2957 this function does not check for built in alias'.
2959 @param[in] Command Points to the NULL-terminated shell command or existing alias.
2960 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
2961 Command refers to an alias, that alias will be deleted.
2962 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
2963 Alias being set will be stored in a non-volatile fashion.
2965 @retval EFI_SUCCESS Alias created or deleted successfully.
2966 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
2971 IN CONST CHAR16
*Command
,
2972 IN CONST CHAR16
*Alias
,
2977 // We must be trying to remove one if Alias is NULL
2979 if (Alias
== NULL
) {
2981 // remove an alias (but passed in COMMAND parameter)
2983 return (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
2986 // Add and replace are the same
2989 // We dont check the error return on purpose since the variable may not exist.
2990 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
2992 return (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
2997 Changes a shell command alias.
2999 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3002 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3003 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3004 Command refers to an alias, that alias will be deleted.
3005 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3006 FALSE and the alias already exists, then the existing alias is unchanged and
3007 EFI_ACCESS_DENIED is returned.
3008 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3009 Alias being set will be stored in a non-volatile fashion.
3011 @retval EFI_SUCCESS Alias created or deleted successfully.
3012 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3013 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3019 IN CONST CHAR16
*Command
,
3020 IN CONST CHAR16
*Alias
,
3026 // cant set over a built in alias
3028 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3029 return (EFI_ACCESS_DENIED
);
3031 if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3032 return (EFI_INVALID_PARAMETER
);
3035 if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3036 return (EFI_ACCESS_DENIED
);
3039 return (InternalSetAlias(Command
, Alias
, Volatile
));
3042 // Pure FILE_HANDLE operations are passed to FileHandleLib
3043 // these functions are indicated by the *
3044 EFI_SHELL_PROTOCOL mShellProtocol
= {
3050 EfiShellGetHelpText
,
3051 EfiShellGetDevicePathFromMap
,
3052 EfiShellGetMapFromDevicePath
,
3053 EfiShellGetDevicePathFromFilePath
,
3054 EfiShellGetFilePathFromDevicePath
,
3058 EfiShellOpenFileList
,
3059 EfiShellFreeFileList
,
3060 EfiShellRemoveDupInFileList
,
3061 EfiShellBatchIsActive
,
3062 EfiShellIsRootShell
,
3063 EfiShellEnablePageBreak
,
3064 EfiShellDisablePageBreak
,
3065 EfiShellGetPageBreak
,
3066 EfiShellGetDeviceName
,
3067 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3068 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3069 EfiShellOpenFileByName
,
3072 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3073 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3074 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3075 EfiShellDeleteFileByName
,
3076 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3077 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3078 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3080 EfiShellFindFilesInDir
,
3081 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3083 EfiShellOpenRootByHandle
,
3085 SHELL_MAJOR_VERSION
,
3090 Function to create and install on the current handle.
3092 Will overwrite any existing ShellProtocols in the system to be sure that
3093 the current shell is in control.
3095 This must be removed via calling CleanUpShellProtocol().
3097 @param[in, out] NewShell The pointer to the pointer to the structure
3100 @retval EFI_SUCCESS The operation was successful.
3101 @return An error from LocateHandle, CreateEvent, or other core function.
3105 CreatePopulateInstallShellProtocol (
3106 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3112 UINTN HandleCounter
;
3113 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3115 if (NewShell
== NULL
) {
3116 return (EFI_INVALID_PARAMETER
);
3121 OldProtocolNode
= NULL
;
3122 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3125 // Initialize EfiShellProtocol object...
3127 Status
= gBS
->CreateEvent(0,
3131 &mShellProtocol
.ExecutionBreak
);
3132 if (EFI_ERROR(Status
)) {
3137 // Get the size of the buffer we need.
3139 Status
= gBS
->LocateHandle(ByProtocol
,
3140 &gEfiShellProtocolGuid
,
3144 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3146 // Allocate and recall with buffer of correct size
3148 Buffer
= AllocateZeroPool(BufferSize
);
3149 if (Buffer
== NULL
) {
3150 return (EFI_OUT_OF_RESOURCES
);
3152 Status
= gBS
->LocateHandle(ByProtocol
,
3153 &gEfiShellProtocolGuid
,
3157 if (EFI_ERROR(Status
)) {
3162 // now overwrite each of them, but save the info to restore when we end.
3164 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3165 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3166 ASSERT(OldProtocolNode
!= NULL
);
3167 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3168 &gEfiShellProtocolGuid
,
3169 (VOID
**) &(OldProtocolNode
->Interface
),
3172 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3174 if (!EFI_ERROR(Status
)) {
3176 // reinstall over the old one...
3178 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3179 Status
= gBS
->ReinstallProtocolInterface(
3180 OldProtocolNode
->Handle
,
3181 &gEfiShellProtocolGuid
,
3182 OldProtocolNode
->Interface
,
3183 (VOID
*)(&mShellProtocol
));
3184 if (!EFI_ERROR(Status
)) {
3186 // we reinstalled sucessfully. log this so we can reverse it later.
3190 // add to the list for subsequent...
3192 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3197 } else if (Status
== EFI_NOT_FOUND
) {
3198 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3200 // no one else published yet. just publish it ourselves.
3202 Status
= gBS
->InstallProtocolInterface (
3204 &gEfiShellProtocolGuid
,
3205 EFI_NATIVE_INTERFACE
,
3206 (VOID
*)(&mShellProtocol
));
3209 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3210 ///@todo support ShellEnvironment2
3211 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3214 if (!EFI_ERROR(Status
)) {
3215 *NewShell
= &mShellProtocol
;
3221 Opposite of CreatePopulateInstallShellProtocol.
3223 Free all memory and restore the system to the state it was in before calling
3224 CreatePopulateInstallShellProtocol.
3226 @param[in, out] NewShell The pointer to the new shell protocol structure.
3228 @retval EFI_SUCCESS The operation was successful.
3232 CleanUpShellProtocol (
3233 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3237 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3238 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3241 // if we need to restore old protocols...
3243 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3244 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3245 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3246 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3248 RemoveEntryList(&Node2
->Link
);
3249 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3250 &gEfiShellProtocolGuid
,
3257 // no need to restore
3259 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3260 &gEfiShellProtocolGuid
,
3263 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3264 NewShell
->ExecutionBreak
= NULL
;
3266 Status
= gBS
->OpenProtocol(
3267 gST
->ConsoleInHandle
,
3268 &gEfiSimpleTextInputExProtocolGuid
,
3272 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3274 if (!EFI_ERROR (Status
)) {
3275 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3276 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3277 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3278 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3279 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3280 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3281 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3282 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3288 Notification function for keystrokes.
3290 @param[in] KeyData The key that was pressed.
3292 @retval EFI_SUCCESS The operation was successful.
3296 NotificationFunction(
3297 IN EFI_KEY_DATA
*KeyData
3301 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3302 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3303 (KeyData
->Key
.UnicodeChar
== 3)
3305 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3306 return (EFI_UNSUPPORTED
);
3308 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3309 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3310 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3312 ShellInfoObject
.HaltOutput
= TRUE
;
3315 // Make sure that there are no pending keystrokes to pervent the pause.
3317 gST
->ConIn
->Reset(gST
->ConIn
, FALSE
);
3318 while (gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
)==EFI_SUCCESS
);
3320 return (EFI_SUCCESS
);
3324 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3325 feature's enabled state was not known when the shell initially launched.
3327 @retval EFI_SUCCESS The feature is enabled.
3328 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3332 InernalEfiShellStartMonitor(
3336 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3337 EFI_KEY_DATA KeyData
;
3340 Status
= gBS
->OpenProtocol(
3341 gST
->ConsoleInHandle
,
3342 &gEfiSimpleTextInputExProtocolGuid
,
3346 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3347 if (EFI_ERROR(Status
)) {
3352 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3353 ShellInfoObject
.HiiHandle
);
3354 return (EFI_SUCCESS
);
3357 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3358 return (EFI_UNSUPPORTED
);
3361 KeyData
.KeyState
.KeyToggleState
= 0;
3362 KeyData
.Key
.ScanCode
= 0;
3363 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3364 KeyData
.Key
.UnicodeChar
= L
'c';
3366 Status
= SimpleEx
->RegisterKeyNotify(
3369 NotificationFunction
,
3370 &ShellInfoObject
.CtrlCNotifyHandle1
);
3372 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3373 if (!EFI_ERROR(Status
)) {
3374 Status
= SimpleEx
->RegisterKeyNotify(
3377 NotificationFunction
,
3378 &ShellInfoObject
.CtrlCNotifyHandle2
);
3380 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3381 KeyData
.Key
.UnicodeChar
= 3;
3382 if (!EFI_ERROR(Status
)) {
3383 Status
= SimpleEx
->RegisterKeyNotify(
3386 NotificationFunction
,
3387 &ShellInfoObject
.CtrlCNotifyHandle3
);
3389 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3390 if (!EFI_ERROR(Status
)) {
3391 Status
= SimpleEx
->RegisterKeyNotify(
3394 NotificationFunction
,
3395 &ShellInfoObject
.CtrlCNotifyHandle4
);