2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 Close an open file handle.
21 This function closes a specified file handle. All "dirty" cached file data is
22 flushed to the device, and the file is closed. In all cases the handle is
25 @param[in] FileHandle The file handle to close.
27 @retval EFI_SUCCESS The file handle was closed successfully.
32 IN SHELL_FILE_HANDLE FileHandle
35 ShellFileHandleRemove(FileHandle
);
36 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
40 Internal worker to determine whether there is a BlockIo somewhere
41 upon the device path specified.
43 @param[in] DevicePath The device path to test.
45 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
46 @retval FALSE gEfiBlockIoProtocolGuid was not found.
50 InternalShellProtocolIsBlockIoPresent(
51 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
54 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
60 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
61 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
63 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
70 Internal worker to determine whether there is a file system somewhere
71 upon the device path specified.
73 @param[in] DevicePath The device path to test.
75 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
76 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
80 InternalShellProtocolIsSimpleFileSystemPresent(
81 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
84 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
90 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
91 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
93 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
100 Internal worker debug helper function to print out maps as they are added.
102 @param[in] Mapping string mapping that has been added
103 @param[in] DevicePath pointer to device path that has been mapped.
105 @retval EFI_SUCCESS the operation was successful.
106 @return other an error ocurred
113 InternalShellProtocolDebugPrintMessage (
114 IN CONST CHAR16
*Mapping
,
115 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
121 Status
= EFI_SUCCESS
;
124 if (Mapping
!= NULL
) {
125 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
127 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
128 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
136 This function creates a mapping for a device path.
138 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
140 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
141 then the mapping will be deleted.
142 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
144 @retval EFI_SUCCESS Mapping created or deleted successfully.
145 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
146 boot service function LocateDevicePath().
147 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
148 @retval EFI_INVALID_PARAMETER Mapping was NULL
149 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
150 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
151 @retval EFI_NOT_FOUND There was no mapping found to delete
152 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
157 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
158 IN CONST CHAR16
*Mapping
162 SHELL_MAP_LIST
*MapListNode
;
164 if (Mapping
== NULL
){
165 return (EFI_INVALID_PARAMETER
);
168 if (Mapping
[StrLen(Mapping
)-1] != ':') {
169 return (EFI_INVALID_PARAMETER
);
173 // Delete the mapping
175 if (DevicePath
== NULL
) {
176 if (IsListEmpty(&gShellMapList
.Link
)) {
177 return (EFI_NOT_FOUND
);
179 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
180 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
181 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
183 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
184 RemoveEntryList(&MapListNode
->Link
);
185 FreePool(MapListNode
);
186 return (EFI_SUCCESS
);
191 // We didnt find one to delete
193 return (EFI_NOT_FOUND
);
197 // make sure this is a valid to add device path
199 ///@todo add BlockIo to this test...
200 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
201 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
202 return (EFI_INVALID_PARAMETER
);
206 // First make sure there is no old mapping
208 Status
= EfiShellSetMap(NULL
, Mapping
);
209 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
214 // now add the new one.
216 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
222 Gets the device path from the mapping.
224 This function gets the device path associated with a mapping.
226 @param Mapping A pointer to the mapping
228 @retval !=NULL Pointer to the device path that corresponds to the
229 device mapping. The returned pointer does not need
231 @retval NULL There is no device path associated with the
234 CONST EFI_DEVICE_PATH_PROTOCOL
*
236 EfiShellGetDevicePathFromMap(
237 IN CONST CHAR16
*Mapping
240 SHELL_MAP_LIST
*MapListItem
;
247 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
248 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
249 StrnCatGrow(&NewName
, &Size
, L
":", 0);
252 MapListItem
= ShellCommandFindMapItem(NewName
);
256 if (MapListItem
!= NULL
) {
257 return (MapListItem
->DevicePath
);
263 Gets the mapping(s) that most closely matches the device path.
265 This function gets the mapping which corresponds to the device path *DevicePath. If
266 there is no exact match, then the mapping which most closely matches *DevicePath
267 is returned, and *DevicePath is updated to point to the remaining portion of the
268 device path. If there is an exact match, the mapping is returned and *DevicePath
269 points to the end-of-device-path node.
271 If there are multiple map names they will be semi-colon seperated in the
272 NULL-terminated string.
274 @param DevicePath On entry, points to a device path pointer. On
275 exit, updates the pointer to point to the
276 portion of the device path after the mapping.
278 @retval NULL No mapping was found.
279 @return !=NULL Pointer to NULL-terminated mapping. The buffer
280 is callee allocated and should be freed by the caller.
284 EfiShellGetMapFromDevicePath(
285 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
288 SHELL_MAP_LIST
*Node
;
289 CHAR16
*PathForReturn
;
291 // EFI_HANDLE PathHandle;
292 // EFI_HANDLE MapHandle;
293 // EFI_STATUS Status;
294 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
295 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
297 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
301 PathForReturn
= NULL
;
304 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
305 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
306 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
309 // check for exact match
311 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
312 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
314 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
316 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
319 if (PathForReturn
!= NULL
) {
320 while (!IsDevicePathEndType (*DevicePath
)) {
321 *DevicePath
= NextDevicePathNode (*DevicePath
);
323 SetDevicePathEndNode (*DevicePath
);
326 ///@todo finish code for inexact matches.
327 if (PathForReturn == NULL) {
330 DevicePathCopy = DuplicateDevicePath(*DevicePath);
331 ASSERT(DevicePathCopy != NULL);
332 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
333 ASSERT_EFI_ERROR(Status);
335 // check each of the device paths we have to get the root of the path for consist mappings
337 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
338 ; !IsNull(&gShellMapList.Link, &Node->Link)
339 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
341 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
344 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
345 ASSERT(MapPathCopy != NULL);
346 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
347 if (MapHandle == PathHandle) {
349 *DevicePath = DevicePathCopy;
352 DevicePathCopy = NULL;
353 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
354 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
359 // now add on the non-consistent mappings
361 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
362 ; !IsNull(&gShellMapList.Link, &Node->Link)
363 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
365 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
368 MapPathCopy = Node->DevicePath;
369 ASSERT(MapPathCopy != NULL);
370 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
371 if (MapHandle == PathHandle) {
372 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
373 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
380 return (AddBufferToFreeList(PathForReturn
));
384 Converts a device path to a file system-style path.
386 This function converts a device path to a file system path by replacing part, or all, of
387 the device path with the file-system mapping. If there are more than one application
388 file system mappings, the one that most closely matches Path will be used.
390 @param Path The pointer to the device path
392 @retval NULL the device path could not be found.
393 @return all The pointer of the NULL-terminated file path. The path
394 is callee-allocated and should be freed by the caller.
398 EfiShellGetFilePathFromDevicePath(
399 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
402 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
403 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
404 SHELL_MAP_LIST
*MapListItem
;
405 CHAR16
*PathForReturn
;
407 EFI_HANDLE PathHandle
;
408 EFI_HANDLE MapHandle
;
410 FILEPATH_DEVICE_PATH
*FilePath
;
411 FILEPATH_DEVICE_PATH
*AlignedNode
;
413 PathForReturn
= NULL
;
416 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
417 ASSERT(DevicePathCopy
!= NULL
);
418 if (DevicePathCopy
== NULL
) {
422 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
424 if (EFI_ERROR(Status
)) {
428 // check each of the device paths we have to get the root of the path
430 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
431 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
432 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
434 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
435 ASSERT(MapPathCopy
!= NULL
);
437 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
438 if (MapHandle
== PathHandle
) {
439 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
440 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
442 // go through all the remaining nodes in the device path
444 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
445 ; !IsDevicePathEnd (&FilePath
->Header
)
446 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
449 // all the rest should be file path nodes
451 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
452 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
453 FreePool(PathForReturn
);
454 PathForReturn
= NULL
;
458 // append the path part onto the filepath.
460 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
462 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
463 ASSERT (AlignedNode
!= NULL
);
465 // File Path Device Path Nodes 'can optionally add a "\" separator to
466 // the beginning and/or the end of the Path Name string.'
467 // (UEFI Spec 2.4 section 9.3.6.4).
468 // If necessary, add a "\", but otherwise don't
469 // (This is specified in the above section, and also implied by the
470 // UEFI Shell spec section 3.7)
471 if ((PathSize
!= 0) &&
472 (PathForReturn
!= NULL
) &&
473 (PathForReturn
[PathSize
- 1] != L
'\\') &&
474 (AlignedNode
->PathName
[0] != L
'\\')) {
475 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
478 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
479 FreePool(AlignedNode
);
481 } // for loop of remaining nodes
483 if (PathForReturn
!= NULL
) {
486 } // for loop of paths to check
487 return(PathForReturn
);
491 Converts a file system style name to a device path.
493 This function converts a file system style name to a device path, by replacing any
494 mapping references to the associated device path.
496 @param[in] Path The pointer to the path.
498 @return The pointer of the file path. The file path is callee
499 allocated and should be freed by the caller.
500 @retval NULL The path could not be found.
501 @retval NULL There was not enough available memory.
503 EFI_DEVICE_PATH_PROTOCOL
*
505 EfiShellGetDevicePathFromFilePath(
506 IN CONST CHAR16
*Path
513 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
514 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
515 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
516 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
527 if (StrStr(Path
, L
":") == NULL
) {
528 Cwd
= EfiShellGetCurDir(NULL
);
533 Size
+= StrSize(Path
);
534 NewPath
= AllocateZeroPool(Size
);
535 if (NewPath
== NULL
) {
538 StrCpy(NewPath
, Cwd
);
539 if (*Path
== L
'\\') {
541 while (PathRemoveLastItem(NewPath
)) ;
543 StrCat(NewPath
, Path
);
544 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
546 return (DevicePathForReturn
);
551 // find the part before (but including) the : for the map name
553 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
554 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
555 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
560 // look up the device path in the map
562 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
563 if (DevicePath
== NULL
) {
565 // Must have been a bad Mapname
571 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
573 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
574 if (DevicePathCopy
== NULL
) {
583 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
584 if (EFI_ERROR(Status
)) {
585 if (DevicePathCopyForFree
!= NULL
) {
586 FreePool(DevicePathCopyForFree
);
593 // build the full device path
595 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
596 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
598 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
602 if (DevicePathCopyForFree
!= NULL
) {
603 FreePool(DevicePathCopyForFree
);
606 return (DevicePathForReturn
);
610 Gets the name of the device specified by the device handle.
612 This function gets the user-readable name of the device specified by the device
613 handle. If no user-readable name could be generated, then *BestDeviceName will be
614 NULL and EFI_NOT_FOUND will be returned.
616 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
617 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
620 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
621 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
622 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
623 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
624 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
626 @param DeviceHandle The handle of the device.
627 @param Flags Determines the possible sources of component names.
629 EFI_DEVICE_NAME_USE_COMPONENT_NAME
630 EFI_DEVICE_NAME_USE_DEVICE_PATH
631 @param Language A pointer to the language specified for the device
632 name, in the same format as described in the UEFI
633 specification, Appendix M
634 @param BestDeviceName On return, points to the callee-allocated NULL-
635 terminated name of the device. If no device name
636 could be found, points to NULL. The name must be
637 freed by the caller...
639 @retval EFI_SUCCESS Get the name successfully.
640 @retval EFI_NOT_FOUND Fail to get the device name.
641 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
642 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
643 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
647 EfiShellGetDeviceName(
648 IN EFI_HANDLE DeviceHandle
,
649 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
651 OUT CHAR16
**BestDeviceName
655 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
656 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
657 EFI_HANDLE
*HandleList
;
660 CHAR16
*DeviceNameToReturn
;
662 UINTN ParentControllerCount
;
663 EFI_HANDLE
*ParentControllerBuffer
;
664 UINTN ParentDriverCount
;
665 EFI_HANDLE
*ParentDriverBuffer
;
667 if (BestDeviceName
== NULL
||
670 return (EFI_INVALID_PARAMETER
);
674 // make sure one of the 2 supported bits is on
676 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
677 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
678 return (EFI_INVALID_PARAMETER
);
681 DeviceNameToReturn
= NULL
;
682 *BestDeviceName
= NULL
;
687 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
688 Status
= ParseHandleDatabaseByRelationship(
691 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
694 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
696 // Go through those handles until we get one that passes for GetComponentName
698 Status
= gBS
->OpenProtocol(
700 &gEfiComponentName2ProtocolGuid
,
704 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
705 if (EFI_ERROR(Status
)) {
706 Status
= gBS
->OpenProtocol(
708 &gEfiComponentNameProtocolGuid
,
712 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
715 if (EFI_ERROR(Status
)) {
718 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
719 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
722 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
726 if (HandleList
!= NULL
) {
727 FreePool(HandleList
);
731 // Now check the parent controller using this as the child.
733 if (DeviceNameToReturn
== NULL
){
734 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
735 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
736 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
737 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
739 // try using that driver's component name with controller and our driver as the child.
741 Status
= gBS
->OpenProtocol(
742 ParentDriverBuffer
[HandleCount
],
743 &gEfiComponentName2ProtocolGuid
,
747 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
748 if (EFI_ERROR(Status
)) {
749 Status
= gBS
->OpenProtocol(
750 ParentDriverBuffer
[HandleCount
],
751 &gEfiComponentNameProtocolGuid
,
755 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
758 if (EFI_ERROR(Status
)) {
761 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
762 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
765 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
772 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
773 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
777 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
780 // dont return on fail since we will try device path if that bit is on
782 if (DeviceNameToReturn
!= NULL
){
783 ASSERT(BestDeviceName
!= NULL
);
784 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
785 return (EFI_SUCCESS
);
788 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
789 Status
= gBS
->OpenProtocol(
791 &gEfiDevicePathProtocolGuid
,
795 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
796 if (!EFI_ERROR(Status
)) {
798 // use device path to text on the device path
800 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
801 return (EFI_SUCCESS
);
805 // none of the selected bits worked.
807 return (EFI_NOT_FOUND
);
811 Opens the root directory of a device on a handle
813 This function opens the root directory of a device and returns a file handle to it.
815 @param DeviceHandle The handle of the device that contains the volume.
816 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
819 @retval EFI_SUCCESS Root opened successfully.
820 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
822 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
823 @retval EFI_DEVICE_ERROR The device had an error
827 EfiShellOpenRootByHandle(
828 IN EFI_HANDLE DeviceHandle
,
829 OUT SHELL_FILE_HANDLE
*FileHandle
833 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
834 EFI_FILE_PROTOCOL
*RealFileHandle
;
835 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
838 // get the simple file system interface
840 Status
= gBS
->OpenProtocol(DeviceHandle
,
841 &gEfiSimpleFileSystemProtocolGuid
,
842 (VOID
**)&SimpleFileSystem
,
845 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
846 if (EFI_ERROR(Status
)) {
847 return (EFI_NOT_FOUND
);
850 Status
= gBS
->OpenProtocol(DeviceHandle
,
851 &gEfiDevicePathProtocolGuid
,
855 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
856 if (EFI_ERROR(Status
)) {
857 return (EFI_NOT_FOUND
);
860 // Open the root volume now...
862 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
863 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
868 Opens the root directory of a device.
870 This function opens the root directory of a device and returns a file handle to it.
872 @param DevicePath Points to the device path corresponding to the device where the
873 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
874 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
877 @retval EFI_SUCCESS Root opened successfully.
878 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
880 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
881 @retval EFI_DEVICE_ERROR The device had an error
882 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
887 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
888 OUT SHELL_FILE_HANDLE
*FileHandle
894 if (FileHandle
== NULL
) {
895 return (EFI_INVALID_PARAMETER
);
899 // find the handle of the device with that device handle and the file system
902 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
905 if (EFI_ERROR(Status
)) {
906 return (EFI_NOT_FOUND
);
909 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
913 Returns whether any script files are currently being processed.
915 @retval TRUE There is at least one script file active.
916 @retval FALSE No script files are active now.
921 EfiShellBatchIsActive (
925 if (ShellCommandGetCurrentScriptFile() == NULL
) {
932 Worker function to open a file based on a device path. this will open the root
933 of the volume and then traverse down to the file itself.
935 @param DevicePath Device Path of the file.
936 @param FileHandle Pointer to the file upon a successful return.
937 @param OpenMode mode to open file in.
938 @param Attributes the File Attributes to use when creating a new file.
940 @retval EFI_SUCCESS the file is open and FileHandle is valid
941 @retval EFI_UNSUPPORTED the device path cotained non-path elements
942 @retval other an error ocurred.
946 InternalOpenFileDevicePath(
947 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
948 OUT SHELL_FILE_HANDLE
*FileHandle
,
950 IN UINT64 Attributes OPTIONAL
954 FILEPATH_DEVICE_PATH
*FilePathNode
;
956 SHELL_FILE_HANDLE ShellHandle
;
957 EFI_FILE_PROTOCOL
*Handle1
;
958 EFI_FILE_PROTOCOL
*Handle2
;
959 FILEPATH_DEVICE_PATH
*AlignedNode
;
961 if (FileHandle
== NULL
) {
962 return (EFI_INVALID_PARAMETER
);
972 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
974 if (!EFI_ERROR(Status
)) {
975 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
976 if (Handle1
!= NULL
) {
978 // chop off the begining part before the file system part...
981 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
984 if (!EFI_ERROR(Status
)) {
986 // To access as a file system, the file path should only
987 // contain file path components. Follow the file path nodes
988 // and find the target file
990 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
991 ; !IsDevicePathEnd (&FilePathNode
->Header
)
992 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
994 SHELL_FREE_NON_NULL(AlignedNode
);
995 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
997 // For file system access each node should be a file path component
999 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
1000 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1002 Status
= EFI_UNSUPPORTED
;
1007 // Open this file path node
1013 // if this is the last node in the DevicePath always create (if that was requested).
1015 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1016 Status
= Handle2
->Open (
1019 AlignedNode
->PathName
,
1026 // This is not the last node and we dont want to 'create' existing
1027 // directory entries...
1031 // open without letting it create
1032 // prevents error on existing files/directories
1034 Status
= Handle2
->Open (
1037 AlignedNode
->PathName
,
1038 OpenMode
&~EFI_FILE_MODE_CREATE
,
1042 // if above failed now open and create the 'item'
1043 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1045 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1046 Status
= Handle2
->Open (
1049 AlignedNode
->PathName
,
1056 // Close the last node
1058 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1061 // If there's been an error, stop
1063 if (EFI_ERROR (Status
)) {
1070 SHELL_FREE_NON_NULL(AlignedNode
);
1071 if (EFI_ERROR(Status
)) {
1072 if (Handle1
!= NULL
) {
1073 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1076 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1082 Creates a file or directory by name.
1084 This function creates an empty new file or directory with the specified attributes and
1085 returns the new file's handle. If the file already exists and is read-only, then
1086 EFI_INVALID_PARAMETER will be returned.
1088 If the file already existed, it is truncated and its attributes updated. If the file is
1089 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1091 If the file name begins with >v, then the file handle which is returned refers to the
1092 shell environment variable with the specified name. If the shell environment variable
1093 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1095 @param FileName Pointer to NULL-terminated file path
1096 @param FileAttribs The new file's attrbiutes. the different attributes are
1097 described in EFI_FILE_PROTOCOL.Open().
1098 @param FileHandle On return, points to the created file handle or directory's handle
1100 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1101 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1102 @retval EFI_UNSUPPORTED could not open the file path
1103 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1104 file the file system on the device.
1105 @retval EFI_NO_MEDIA the device has no medium.
1106 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1108 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1110 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1111 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1112 when the media is write-protected.
1113 @retval EFI_ACCESS_DENIED The service denied access to the file.
1114 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1115 @retval EFI_VOLUME_FULL The volume is full.
1120 IN CONST CHAR16
*FileName
,
1121 IN UINT64 FileAttribs
,
1122 OUT SHELL_FILE_HANDLE
*FileHandle
1125 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1129 // Is this for an environment variable
1130 // do we start with >v
1132 if (StrStr(FileName
, L
">v") == FileName
) {
1133 if (!IsVolatileEnv(FileName
+2)) {
1134 return (EFI_INVALID_PARAMETER
);
1136 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1137 return (EFI_SUCCESS
);
1141 // We are opening a regular file.
1143 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1144 if (DevicePath
== NULL
) {
1145 return (EFI_NOT_FOUND
);
1148 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
); // 0 = no specific file attributes
1149 FreePool(DevicePath
);
1155 Opens a file or a directory by file name.
1157 This function opens the specified file in the specified OpenMode and returns a file
1159 If the file name begins with >v, then the file handle which is returned refers to the
1160 shell environment variable with the specified name. If the shell environment variable
1161 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1162 EFI_INVALID_PARAMETER is returned.
1164 If the file name is >i, then the file handle which is returned refers to the standard
1165 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1168 If the file name is >o, then the file handle which is returned refers to the standard
1169 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1172 If the file name is >e, then the file handle which is returned refers to the standard
1173 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1176 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1177 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1180 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1183 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1184 @param FileHandle On return, points to the file handle.
1185 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1186 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1188 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1189 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1190 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1191 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1192 system could not be found on the device. FileHandle is NULL.
1193 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1194 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1195 longer supported. FileHandle is NULL.
1196 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1197 the FileName. FileHandle is NULL.
1198 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1199 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1200 when the media is write-protected. FileHandle is NULL.
1201 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1202 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1204 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1208 EfiShellOpenFileByName(
1209 IN CONST CHAR16
*FileName
,
1210 OUT SHELL_FILE_HANDLE
*FileHandle
,
1214 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1220 // Is this for StdIn
1222 if (StrCmp(FileName
, L
">i") == 0) {
1224 // make sure not writing to StdIn
1226 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1227 return (EFI_INVALID_PARAMETER
);
1229 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1230 ASSERT(*FileHandle
!= NULL
);
1231 return (EFI_SUCCESS
);
1235 // Is this for StdOut
1237 if (StrCmp(FileName
, L
">o") == 0) {
1239 // make sure not writing to StdIn
1241 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1242 return (EFI_INVALID_PARAMETER
);
1244 *FileHandle
= &FileInterfaceStdOut
;
1245 return (EFI_SUCCESS
);
1249 // Is this for NUL file
1251 if (StrCmp(FileName
, L
"NUL") == 0) {
1252 *FileHandle
= &FileInterfaceNulFile
;
1253 return (EFI_SUCCESS
);
1257 // Is this for StdErr
1259 if (StrCmp(FileName
, L
">e") == 0) {
1261 // make sure not writing to StdIn
1263 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1264 return (EFI_INVALID_PARAMETER
);
1266 *FileHandle
= &FileInterfaceStdErr
;
1267 return (EFI_SUCCESS
);
1271 // Is this for an environment variable
1272 // do we start with >v
1274 if (StrStr(FileName
, L
">v") == FileName
) {
1275 if (!IsVolatileEnv(FileName
+2) &&
1276 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1277 return (EFI_INVALID_PARAMETER
);
1279 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1280 return (EFI_SUCCESS
);
1284 // We are opening a regular file.
1286 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1287 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1288 if (DevicePath
== NULL
) {
1289 return (EFI_NOT_FOUND
);
1293 // Copy the device path, open the file, then free the memory
1295 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1296 FreePool(DevicePath
);
1302 Deletes the file specified by the file name.
1304 This function deletes a file.
1306 @param FileName Points to the NULL-terminated file name.
1308 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1309 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1310 @sa EfiShellCreateFile
1314 EfiShellDeleteFileByName(
1315 IN CONST CHAR16
*FileName
1318 SHELL_FILE_HANDLE FileHandle
;
1324 // get a handle to the file
1326 Status
= EfiShellCreateFile(FileName
,
1329 if (EFI_ERROR(Status
)) {
1333 // now delete the file
1335 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1339 Disables the page break output mode.
1343 EfiShellDisablePageBreak (
1347 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1351 Enables the page break output mode.
1355 EfiShellEnablePageBreak (
1359 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1363 internal worker function to load and run an image via device path.
1365 @param ParentImageHandle A handle of the image that is executing the specified
1367 @param DevicePath device path of the file to execute
1368 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1369 containing the command line. If NULL then the command-
1371 @param Environment Points to a NULL-terminated array of environment
1372 variables with the format 'x=y', where x is the
1373 environment variable name and y is the value. If this
1374 is NULL, then the current shell environment is used.
1376 @param[out] StartImageStatus Returned status from gBS->StartImage.
1377 @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
1378 @param[out] ExitData ExitData as returned from gBS->StartImage
1380 @retval EFI_SUCCESS The command executed successfully. The status code
1381 returned by the command is pointed to by StatusCode.
1382 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1383 @retval EFI_OUT_OF_RESOURCES Out of resources.
1384 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1388 InternalShellExecuteDevicePath(
1389 IN CONST EFI_HANDLE
*ParentImageHandle
,
1390 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1391 IN CONST CHAR16
*CommandLine OPTIONAL
,
1392 IN CONST CHAR16
**Environment OPTIONAL
,
1393 OUT EFI_STATUS
*StartImageStatus OPTIONAL
,
1394 OUT UINTN
*ExitDataSize OPTIONAL
,
1395 OUT CHAR16
**ExitData OPTIONAL
1399 EFI_STATUS StartStatus
;
1400 EFI_STATUS CleanupStatus
;
1401 EFI_HANDLE NewHandle
;
1402 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1403 LIST_ENTRY OrigEnvs
;
1404 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1405 UINTN InternalExitDataSize
;
1406 UINTN
*ExitDataSizePtr
;
1410 // ExitDataSize is not OPTIONAL for gBS->BootServices, provide somewhere for
1411 // it to be dumped if the caller doesn't want it.
1412 if (ExitData
== NULL
) {
1413 ExitDataSizePtr
= &InternalExitDataSize
;
1415 ExitDataSizePtr
= ExitDataSize
;
1418 if (ParentImageHandle
== NULL
) {
1419 return (EFI_INVALID_PARAMETER
);
1422 InitializeListHead(&OrigEnvs
);
1427 // Load the image with:
1428 // FALSE - not from boot manager and NULL, 0 being not already in memory
1430 Status
= gBS
->LoadImage(
1433 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1438 if (EFI_ERROR(Status
)) {
1439 if (NewHandle
!= NULL
) {
1440 gBS
->UnloadImage(NewHandle
);
1444 Status
= gBS
->OpenProtocol(
1446 &gEfiLoadedImageProtocolGuid
,
1447 (VOID
**)&LoadedImage
,
1450 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1452 if (!EFI_ERROR(Status
)) {
1453 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1454 if (CommandLine
!= NULL
) {
1455 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(CommandLine
);
1456 LoadedImage
->LoadOptions
= (VOID
*)CommandLine
;
1460 // Save our current environment settings for later restoration if necessary
1462 if (Environment
!= NULL
) {
1463 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1464 if (!EFI_ERROR(Status
)) {
1465 Status
= SetEnvironmentVariables(Environment
);
1470 // Initialize and install a shell parameters protocol on the image.
1472 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1473 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1474 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1475 Status
= UpdateArgcArgv(&ShellParamsProtocol
, CommandLine
, NULL
, NULL
);
1476 ASSERT_EFI_ERROR(Status
);
1478 // Replace Argv[0] with the full path of the binary we're executing:
1479 // If the command line was "foo", the binary might be called "foo.efi".
1480 // "The first entry in [Argv] is always the full file path of the
1481 // executable" - UEFI Shell Spec section 2.3
1483 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1484 // The image we're executing isn't necessarily in a filesystem - it might
1485 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1486 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1487 if (ImagePath
!= NULL
) {
1488 if (ShellParamsProtocol
.Argv
== NULL
) {
1489 // Command line was empty or null.
1490 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1491 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1492 if (ShellParamsProtocol
.Argv
== NULL
) {
1493 Status
= EFI_OUT_OF_RESOURCES
;
1496 ShellParamsProtocol
.Argc
= 1;
1498 // Free the string UpdateArgcArgv put in Argv[0];
1499 FreePool (ShellParamsProtocol
.Argv
[0]);
1501 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1504 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1505 ASSERT_EFI_ERROR(Status
);
1507 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1510 // now start the image, passing up exit data if the caller requested it
1512 if (!EFI_ERROR(Status
)) {
1513 StartStatus
= gBS
->StartImage(
1518 if (StartImageStatus
!= NULL
) {
1519 *StartImageStatus
= StartStatus
;
1522 CleanupStatus
= gBS
->UninstallProtocolInterface(
1524 &gEfiShellParametersProtocolGuid
,
1525 &ShellParamsProtocol
1527 ASSERT_EFI_ERROR(CleanupStatus
);
1533 // Unload image - We should only get here if we didn't call StartImage
1534 gBS
->UnloadImage (NewHandle
);
1537 // Free Argv (Allocated in UpdateArgcArgv)
1538 if (ShellParamsProtocol
.Argv
!= NULL
) {
1539 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1540 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1541 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1544 FreePool (ShellParamsProtocol
.Argv
);
1548 // Restore environment variables
1549 if (!IsListEmpty(&OrigEnvs
)) {
1550 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1551 ASSERT_EFI_ERROR (CleanupStatus
);
1557 Execute the command line.
1559 This function creates a nested instance of the shell and executes the specified
1560 command (CommandLine) with the specified environment (Environment). Upon return,
1561 the status code returned by the specified command is placed in StatusCode.
1563 If Environment is NULL, then the current environment is used and all changes made
1564 by the commands executed will be reflected in the current environment. If the
1565 Environment is non-NULL, then the changes made will be discarded.
1567 The CommandLine is executed from the current working directory on the current
1570 @param ParentImageHandle A handle of the image that is executing the specified
1572 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1573 containing the command line. If NULL then the command-
1575 @param Environment Points to a NULL-terminated array of environment
1576 variables with the format 'x=y', where x is the
1577 environment variable name and y is the value. If this
1578 is NULL, then the current shell environment is used.
1579 @param StatusCode Points to the status code returned by the command.
1581 @retval EFI_SUCCESS The command executed successfully. The status code
1582 returned by the command is pointed to by StatusCode.
1583 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1584 @retval EFI_OUT_OF_RESOURCES Out of resources.
1585 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1586 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1588 @sa InternalShellExecuteDevicePath
1593 IN EFI_HANDLE
*ParentImageHandle
,
1594 IN CHAR16
*CommandLine OPTIONAL
,
1595 IN CHAR16
**Environment OPTIONAL
,
1596 OUT EFI_STATUS
*StatusCode OPTIONAL
1601 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1606 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1607 return (EFI_UNSUPPORTED
);
1610 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1613 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1615 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1617 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1623 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1624 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1625 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1627 Status
= InternalShellExecuteDevicePath(
1631 (CONST CHAR16
**)Environment
,
1636 if (Status
== EFI_ABORTED
) {
1637 // If the command exited with an error, the shell should put the exit
1638 // status in ExitData, preceded by a null-terminated string.
1639 ASSERT (ExitDataSize
== StrSize (ExitData
) + sizeof (SHELL_STATUS
));
1641 if (StatusCode
!= NULL
) {
1642 // Skip the null-terminated string
1643 ExitData
+= StrLen (ExitData
) + 1;
1645 // Use CopyMem to avoid alignment faults
1646 CopyMem (StatusCode
, ExitData
, sizeof (SHELL_STATUS
));
1648 // Convert from SHELL_STATUS to EFI_STATUS
1649 // EFI_STATUSes have top bit set when they are errors.
1650 // (See UEFI Spec Appendix D)
1651 if (*StatusCode
!= SHELL_SUCCESS
) {
1652 *StatusCode
= (EFI_STATUS
) *StatusCode
| MAX_BIT
;
1655 FreePool (ExitData
);
1656 Status
= EFI_SUCCESS
;
1660 // de-allocate and return
1668 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1670 1) frees all pointers (non-NULL)
1671 2) Closes the SHELL_FILE_HANDLE
1673 @param FileListNode pointer to the list node to free
1677 InternalFreeShellFileInfoNode(
1678 IN EFI_SHELL_FILE_INFO
*FileListNode
1681 if (FileListNode
->Info
!= NULL
) {
1682 FreePool((VOID
*)FileListNode
->Info
);
1684 if (FileListNode
->FileName
!= NULL
) {
1685 FreePool((VOID
*)FileListNode
->FileName
);
1687 if (FileListNode
->FullName
!= NULL
) {
1688 FreePool((VOID
*)FileListNode
->FullName
);
1690 if (FileListNode
->Handle
!= NULL
) {
1691 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1693 FreePool(FileListNode
);
1696 Frees the file list.
1698 This function cleans up the file list and any related data structures. It has no
1699 impact on the files themselves.
1701 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1702 defined in OpenFileList()
1704 @retval EFI_SUCCESS Free the file list successfully.
1705 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1709 EfiShellFreeFileList(
1710 IN EFI_SHELL_FILE_INFO
**FileList
1713 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1715 if (FileList
== NULL
|| *FileList
== NULL
) {
1716 return (EFI_INVALID_PARAMETER
);
1719 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1720 ; !IsListEmpty(&(*FileList
)->Link
)
1721 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1723 RemoveEntryList(&ShellFileListItem
->Link
);
1724 InternalFreeShellFileInfoNode(ShellFileListItem
);
1726 InternalFreeShellFileInfoNode(*FileList
);
1728 return(EFI_SUCCESS
);
1732 Deletes the duplicate file names files in the given file list.
1734 This function deletes the reduplicate files in the given file list.
1736 @param FileList A pointer to the first entry in the file list.
1738 @retval EFI_SUCCESS Always success.
1739 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1743 EfiShellRemoveDupInFileList(
1744 IN EFI_SHELL_FILE_INFO
**FileList
1747 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1748 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1749 EFI_SHELL_FILE_INFO
*TempNode
;
1751 if (FileList
== NULL
|| *FileList
== NULL
) {
1752 return (EFI_INVALID_PARAMETER
);
1754 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1755 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1756 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1758 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1759 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1760 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1762 if (gUnicodeCollation
->StriColl(
1764 (CHAR16
*)ShellFileListItem
->FullName
,
1765 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1767 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1769 &ShellFileListItem2
->Link
1771 RemoveEntryList(&ShellFileListItem2
->Link
);
1772 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1773 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1774 // memory in GetNextNode in the loop expression above.
1775 ShellFileListItem2
= TempNode
;
1779 return (EFI_SUCCESS
);
1783 // This is the same structure as the external version, but it has no CONST qualifiers.
1786 LIST_ENTRY Link
; ///< Linked list members.
1787 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1788 CHAR16
*FullName
; ///< Fully qualified filename.
1789 CHAR16
*FileName
; ///< name of this file.
1790 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1791 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1792 } EFI_SHELL_FILE_INFO_NO_CONST
;
1795 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1797 @param[in] Node The node to copy from.
1798 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1800 @retval NULL a memory allocation error ocurred
1801 @return != NULL a pointer to the new node
1803 EFI_SHELL_FILE_INFO
*
1805 InternalDuplicateShellFileInfo(
1806 IN EFI_SHELL_FILE_INFO
*Node
,
1810 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1813 // try to confirm that the objects are in sync
1815 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1817 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1818 if (NewNode
== NULL
) {
1821 NewNode
->FullName
= AllocateZeroPool(StrSize(Node
->FullName
));
1823 NewNode
->FileName
= AllocateZeroPool(StrSize(Node
->FileName
));
1824 NewNode
->Info
= AllocateZeroPool((UINTN
)Node
->Info
->Size
);
1825 if ( NewNode
->FullName
== NULL
1826 || NewNode
->FileName
== NULL
1827 || NewNode
->Info
== NULL
1829 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1830 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1831 SHELL_FREE_NON_NULL(NewNode
->Info
);
1832 SHELL_FREE_NON_NULL(NewNode
);
1835 NewNode
->Status
= Node
->Status
;
1836 NewNode
->Handle
= Node
->Handle
;
1838 Node
->Handle
= NULL
;
1840 StrCpy((CHAR16
*)NewNode
->FullName
, Node
->FullName
);
1841 StrCpy((CHAR16
*)NewNode
->FileName
, Node
->FileName
);
1842 CopyMem(NewNode
->Info
, Node
->Info
, (UINTN
)Node
->Info
->Size
);
1844 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1848 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1849 failed it will return NULL.
1851 @param[in] BasePath the Path to prepend onto filename for FullPath
1852 @param[in] Status Status member initial value.
1853 @param[in] FileName FileName member initial value.
1854 @param[in] Handle Handle member initial value.
1855 @param[in] Info Info struct to copy.
1857 @retval NULL An error ocurred.
1858 @return a pointer to the newly allocated structure.
1860 EFI_SHELL_FILE_INFO
*
1862 CreateAndPopulateShellFileInfo(
1863 IN CONST CHAR16
*BasePath
,
1864 IN CONST EFI_STATUS Status
,
1865 IN CONST CHAR16
*FileName
,
1866 IN CONST SHELL_FILE_HANDLE Handle
,
1867 IN CONST EFI_FILE_INFO
*Info
1870 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1877 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1878 if (ShellFileListItem
== NULL
) {
1881 if (Info
!= NULL
&& Info
->Size
!= 0) {
1882 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1883 if (ShellFileListItem
->Info
== NULL
) {
1884 FreePool(ShellFileListItem
);
1887 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1889 ShellFileListItem
->Info
= NULL
;
1891 if (FileName
!= NULL
) {
1892 ASSERT(TempString
== NULL
);
1893 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1894 if (ShellFileListItem
->FileName
== NULL
) {
1895 FreePool(ShellFileListItem
->Info
);
1896 FreePool(ShellFileListItem
);
1900 ShellFileListItem
->FileName
= NULL
;
1904 if (BasePath
!= NULL
) {
1905 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1906 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1907 if (TempString
== NULL
) {
1908 FreePool((VOID
*)ShellFileListItem
->FileName
);
1909 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1910 FreePool(ShellFileListItem
);
1914 if (ShellFileListItem
->FileName
!= NULL
) {
1915 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1916 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1917 if (TempString
== NULL
) {
1918 FreePool((VOID
*)ShellFileListItem
->FileName
);
1919 FreePool(ShellFileListItem
->Info
);
1920 FreePool(ShellFileListItem
);
1925 TempString
= PathCleanUpDirectories(TempString
);
1927 ShellFileListItem
->FullName
= TempString
;
1928 ShellFileListItem
->Status
= Status
;
1929 ShellFileListItem
->Handle
= Handle
;
1931 return (ShellFileListItem
);
1935 Find all files in a specified directory.
1937 @param FileDirHandle Handle of the directory to search.
1938 @param FileList On return, points to the list of files in the directory
1939 or NULL if there are no files in the directory.
1941 @retval EFI_SUCCESS File information was returned successfully.
1942 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1943 @retval EFI_DEVICE_ERROR The device reported an error.
1944 @retval EFI_NO_MEDIA The device media is not present.
1945 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1946 @return An error from FileHandleGetFileName().
1950 EfiShellFindFilesInDir(
1951 IN SHELL_FILE_HANDLE FileDirHandle
,
1952 OUT EFI_SHELL_FILE_INFO
**FileList
1955 EFI_SHELL_FILE_INFO
*ShellFileList
;
1956 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1957 EFI_FILE_INFO
*FileInfo
;
1966 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1967 if (EFI_ERROR(Status
)) {
1971 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1974 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1975 if (TempString
== NULL
) {
1976 SHELL_FREE_NON_NULL(BasePath
);
1977 return (EFI_OUT_OF_RESOURCES
);
1979 TempSpot
= StrStr(TempString
, L
";");
1981 if (TempSpot
!= NULL
) {
1982 *TempSpot
= CHAR_NULL
;
1985 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1986 if (TempString
== NULL
) {
1987 SHELL_FREE_NON_NULL(BasePath
);
1988 return (EFI_OUT_OF_RESOURCES
);
1990 SHELL_FREE_NON_NULL(BasePath
);
1991 BasePath
= TempString
;
1995 ShellFileList
= NULL
;
1996 ShellFileListItem
= NULL
;
1998 Status
= EFI_SUCCESS
;
2001 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2002 ; !EFI_ERROR(Status
) && !NoFile
2003 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2006 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2008 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2010 EFI_SUCCESS
, // success since we didnt fail to open it...
2012 NULL
, // no handle since not open
2015 if (ShellFileList
== NULL
) {
2016 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2017 ASSERT(ShellFileList
!= NULL
);
2018 InitializeListHead(&ShellFileList
->Link
);
2020 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2022 if (EFI_ERROR(Status
)) {
2023 EfiShellFreeFileList(&ShellFileList
);
2026 *FileList
= ShellFileList
;
2028 SHELL_FREE_NON_NULL(BasePath
);
2033 Updates a file name to be preceeded by the mapped drive name
2035 @param[in] BasePath the Mapped drive name to prepend
2036 @param[in, out] Path pointer to pointer to the file name to update.
2039 @retval EFI_OUT_OF_RESOURCES
2044 IN CONST CHAR16
*BasePath
,
2045 IN OUT CHAR16
**Path
2054 ASSERT(Path
!= NULL
);
2055 ASSERT(*Path
!= NULL
);
2056 ASSERT(BasePath
!= NULL
);
2059 // convert a local path to an absolute path
2061 if (StrStr(*Path
, L
":") == NULL
) {
2062 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2063 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2064 if (Path2
== NULL
) {
2065 return (EFI_OUT_OF_RESOURCES
);
2067 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2068 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2069 if (Path2
== NULL
) {
2070 return (EFI_OUT_OF_RESOURCES
);
2077 return (EFI_SUCCESS
);
2081 If FileHandle is a directory then the function reads from FileHandle and reads in
2082 each of the FileInfo structures. If one of them matches the Pattern's first
2083 "level" then it opens that handle and calls itself on that handle.
2085 If FileHandle is a file and matches all of the remaining Pattern (which would be
2086 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2088 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2089 FreeFileList with FileList.
2091 @param[in] FilePattern The FilePattern to check against.
2092 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2093 @param[in] FileHandle The FileHandle to start with
2094 @param[in, out] FileList pointer to pointer to list of found files.
2095 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2096 @param[in] MapName The file system name this file is on.
2098 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2099 @retval EFI_NOT_FOUND no files were found
2100 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2105 IN CONST CHAR16
*FilePattern
,
2106 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2107 IN SHELL_FILE_HANDLE FileHandle
,
2108 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2109 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2110 IN CONST CHAR16
*MapName
2114 CONST CHAR16
*NextFilePatternStart
;
2115 CHAR16
*CurrentFilePattern
;
2116 EFI_SHELL_FILE_INFO
*ShellInfo
;
2117 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2118 EFI_SHELL_FILE_INFO
*NewShellNode
;
2119 EFI_FILE_INFO
*FileInfo
;
2121 CHAR16
*NewFullName
;
2124 if ( FilePattern
== NULL
2125 || UnicodeCollation
== NULL
2128 return (EFI_INVALID_PARAMETER
);
2131 CurrentFilePattern
= NULL
;
2133 if (*FilePattern
== L
'\\') {
2137 for( NextFilePatternStart
= FilePattern
2138 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2139 ; NextFilePatternStart
++);
2141 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2142 ASSERT(CurrentFilePattern
!= NULL
);
2143 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2145 if (CurrentFilePattern
[0] == CHAR_NULL
2146 &&NextFilePatternStart
[0] == CHAR_NULL
2149 // we want the parent or root node (if no parent)
2151 if (ParentNode
== NULL
) {
2153 // We want the root node. create the node.
2155 FileInfo
= FileHandleGetInfo(FileHandle
);
2156 NewShellNode
= CreateAndPopulateShellFileInfo(
2163 SHELL_FREE_NON_NULL(FileInfo
);
2166 // Add the current parameter FileHandle to the list, then end...
2168 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2170 if (NewShellNode
== NULL
) {
2171 Status
= EFI_OUT_OF_RESOURCES
;
2173 NewShellNode
->Handle
= NULL
;
2174 if (*FileList
== NULL
) {
2175 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2176 InitializeListHead(&((*FileList
)->Link
));
2180 // Add to the returning to use list
2182 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2184 Status
= EFI_SUCCESS
;
2187 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2189 if (!EFI_ERROR(Status
)){
2190 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2195 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2196 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2197 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2199 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2200 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2201 Size
= StrSize(ShellInfoNode
->FullName
);
2202 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2203 NewFullName
= AllocateZeroPool(Size
);
2204 if (NewFullName
== NULL
) {
2205 Status
= EFI_OUT_OF_RESOURCES
;
2207 StrCpy(NewFullName
, MapName
);
2208 StrCat(NewFullName
, ShellInfoNode
->FullName
+1);
2209 FreePool((VOID
*)ShellInfoNode
->FullName
);
2210 ShellInfoNode
->FullName
= NewFullName
;
2213 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2215 // should be a directory
2219 // don't open the . and .. directories
2221 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2222 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2227 if (EFI_ERROR(Status
)) {
2231 // Open the directory since we need that handle in the next recursion.
2233 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2236 // recurse with the next part of the pattern
2238 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2240 } else if (!EFI_ERROR(Status
)) {
2246 // copy the information we need into a new Node
2248 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2249 ASSERT(NewShellNode
!= NULL
);
2250 if (NewShellNode
== NULL
) {
2251 Status
= EFI_OUT_OF_RESOURCES
;
2253 if (*FileList
== NULL
) {
2254 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2255 InitializeListHead(&((*FileList
)->Link
));
2259 // Add to the returning to use list
2261 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2264 if (EFI_ERROR(Status
)) {
2268 if (EFI_ERROR(Status
)) {
2269 EfiShellFreeFileList(&ShellInfo
);
2271 Status
= EfiShellFreeFileList(&ShellInfo
);
2276 FreePool(CurrentFilePattern
);
2281 Find files that match a specified pattern.
2283 This function searches for all files and directories that match the specified
2284 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2285 information is placed in the file list FileList.
2287 Wildcards are processed
2288 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2290 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2291 field is set to NULL.
2293 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2295 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2296 @param FileList On return, points to the start of a file list containing the names
2297 of all matching files or else points to NULL if no matching files
2298 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2300 @retval EFI_SUCCESS Files found. FileList is a valid list.
2301 @retval EFI_NOT_FOUND No files found.
2302 @retval EFI_NO_MEDIA The device has no media
2303 @retval EFI_DEVICE_ERROR The device reported an error
2304 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2309 IN CONST CHAR16
*FilePattern
,
2310 OUT EFI_SHELL_FILE_INFO
**FileList
2314 CHAR16
*PatternCopy
;
2315 CHAR16
*PatternCurrentLocation
;
2316 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2317 SHELL_FILE_HANDLE RootFileHandle
;
2321 if ( FilePattern
== NULL
2323 || StrStr(FilePattern
, L
":") == NULL
2325 return (EFI_INVALID_PARAMETER
);
2327 Status
= EFI_SUCCESS
;
2328 RootDevicePath
= NULL
;
2329 RootFileHandle
= NULL
;
2331 PatternCopy
= AllocateZeroPool(StrSize(FilePattern
));
2332 if (PatternCopy
== NULL
) {
2333 return (EFI_OUT_OF_RESOURCES
);
2335 StrCpy(PatternCopy
, FilePattern
);
2337 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2339 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2342 ASSERT(MapName
== NULL
);
2343 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2344 if (MapName
== NULL
) {
2345 Status
= EFI_OUT_OF_RESOURCES
;
2347 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2348 if (RootDevicePath
== NULL
) {
2349 Status
= EFI_INVALID_PARAMETER
;
2351 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2352 if (!EFI_ERROR(Status
)) {
2353 for ( PatternCurrentLocation
= PatternCopy
2354 ; *PatternCurrentLocation
!= ':'
2355 ; PatternCurrentLocation
++);
2356 PatternCurrentLocation
++;
2357 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2359 FreePool(RootDevicePath
);
2363 SHELL_FREE_NON_NULL(PatternCopy
);
2364 SHELL_FREE_NON_NULL(MapName
);
2370 Opens the files that match the path specified.
2372 This function opens all of the files specified by Path. Wildcards are processed
2373 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2374 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2376 @param Path A pointer to the path string.
2377 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2378 EFI_FILE_MODE_WRITE.
2379 @param FileList Points to the start of a list of files opened.
2381 @retval EFI_SUCCESS Create the file list successfully.
2382 @return Others Can't create the file list.
2386 EfiShellOpenFileList(
2389 IN OUT EFI_SHELL_FILE_INFO
**FileList
2393 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2396 CONST CHAR16
*CurDir
;
2399 PathCleanUpDirectories(Path
);
2404 if (FileList
== NULL
|| *FileList
== NULL
) {
2405 return (EFI_INVALID_PARAMETER
);
2408 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2413 // convert a local path to an absolute path
2415 if (StrStr(Path
, L
":") == NULL
) {
2416 CurDir
= EfiShellGetCurDir(NULL
);
2417 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2418 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2419 if (*Path
== L
'\\') {
2421 while (PathRemoveLastItem(Path2
)) ;
2423 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2424 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2426 ASSERT(Path2
== NULL
);
2427 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2430 PathCleanUpDirectories (Path2
);
2435 Status
= EfiShellFindFiles(Path2
, FileList
);
2439 if (EFI_ERROR(Status
)) {
2445 // We had no errors so open all the files (that are not already opened...)
2447 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2448 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2449 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2451 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2452 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2458 return (EFI_NOT_FOUND
);
2460 return(EFI_SUCCESS
);
2464 This function updated with errata.
2466 Gets either a single or list of environment variables.
2468 If name is not NULL then this function returns the current value of the specified
2469 environment variable.
2471 If Name is NULL, then a list of all environment variable names is returned. Each is a
2472 NULL terminated string with a double NULL terminating the list.
2474 @param Name A pointer to the environment variable name. If
2475 Name is NULL, then the function will return all
2476 of the defined shell environment variables. In
2477 the case where multiple environment variables are
2478 being returned, each variable will be terminated by
2479 a NULL, and the list will be terminated by a double
2482 @return !=NULL A pointer to the returned string.
2483 The returned pointer does not need to be freed by the caller.
2485 @retval NULL The environment variable doesn't exist or there are
2486 no environment variables.
2491 IN CONST CHAR16
*Name
2499 CHAR16
*CurrentWriteLocation
;
2506 // Get all our environment variables
2508 InitializeListHead(&List
);
2509 Status
= GetEnvironmentVariableList(&List
);
2510 if (EFI_ERROR(Status
)){
2515 // Build the semi-colon delimited list. (2 passes)
2517 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2518 ; !IsNull(&List
, &Node
->Link
)
2519 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2521 ASSERT(Node
->Key
!= NULL
);
2522 Size
+= StrSize(Node
->Key
);
2525 Size
+= 2*sizeof(CHAR16
);
2527 Buffer
= AllocateZeroPool(Size
);
2528 if (Buffer
== NULL
) {
2529 if (!IsListEmpty (&List
)) {
2530 FreeEnvironmentVariableList(&List
);
2534 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2536 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2537 ; !IsNull(&List
, &Node
->Link
)
2538 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2540 ASSERT(Node
->Key
!= NULL
);
2541 StrCpy(CurrentWriteLocation
, Node
->Key
);
2542 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2548 if (!IsListEmpty (&List
)) {
2549 FreeEnvironmentVariableList(&List
);
2553 // We are doing a specific environment variable
2557 // get the size we need for this EnvVariable
2559 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2560 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2562 // Allocate the space and recall the get function
2564 Buffer
= AllocateZeroPool(Size
);
2565 ASSERT(Buffer
!= NULL
);
2566 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2569 // we didnt get it (might not exist)
2570 // free the memory if we allocated any and return NULL
2572 if (EFI_ERROR(Status
)) {
2573 if (Buffer
!= NULL
) {
2581 // return the buffer
2583 return (AddBufferToFreeList(Buffer
));
2587 Internal variable setting function. Allows for setting of the read only variables.
2589 @param Name Points to the NULL-terminated environment variable name.
2590 @param Value Points to the NULL-terminated environment variable value. If the value is an
2591 empty string then the environment variable is deleted.
2592 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2594 @retval EFI_SUCCESS The environment variable was successfully updated.
2598 InternalEfiShellSetEnv(
2599 IN CONST CHAR16
*Name
,
2600 IN CONST CHAR16
*Value
,
2604 if (Value
== NULL
|| StrLen(Value
) == 0) {
2605 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2607 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2609 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2611 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2617 Sets the environment variable.
2619 This function changes the current value of the specified environment variable. If the
2620 environment variable exists and the Value is an empty string, then the environment
2621 variable is deleted. If the environment variable exists and the Value is not an empty
2622 string, then the value of the environment variable is changed. If the environment
2623 variable does not exist and the Value is an empty string, there is no action. If the
2624 environment variable does not exist and the Value is a non-empty string, then the
2625 environment variable is created and assigned the specified value.
2627 For a description of volatile and non-volatile environment variables, see UEFI Shell
2628 2.0 specification section 3.6.1.
2630 @param Name Points to the NULL-terminated environment variable name.
2631 @param Value Points to the NULL-terminated environment variable value. If the value is an
2632 empty string then the environment variable is deleted.
2633 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2635 @retval EFI_SUCCESS The environment variable was successfully updated.
2640 IN CONST CHAR16
*Name
,
2641 IN CONST CHAR16
*Value
,
2645 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2646 return (EFI_INVALID_PARAMETER
);
2649 // Make sure we dont 'set' a predefined read only variable
2651 if (gUnicodeCollation
->StriColl(
2655 ||gUnicodeCollation
->StriColl(
2659 ||gUnicodeCollation
->StriColl(
2663 ||gUnicodeCollation
->StriColl(
2666 L
"uefishellsupport") == 0
2667 ||gUnicodeCollation
->StriColl(
2670 L
"uefishellversion") == 0
2671 ||gUnicodeCollation
->StriColl(
2674 L
"uefiversion") == 0
2676 return (EFI_INVALID_PARAMETER
);
2678 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2682 Returns the current directory on the specified device.
2684 If FileSystemMapping is NULL, it returns the current working directory. If the
2685 FileSystemMapping is not NULL, it returns the current directory associated with the
2686 FileSystemMapping. In both cases, the returned name includes the file system
2687 mapping (i.e. fs0:\current-dir).
2689 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2690 then the current working directory is returned.
2692 @retval !=NULL The current directory.
2693 @retval NULL Current directory does not exist.
2698 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2701 CHAR16
*PathToReturn
;
2703 SHELL_MAP_LIST
*MapListItem
;
2704 if (!IsListEmpty(&gShellMapList
.Link
)) {
2706 // if parameter is NULL, use current
2708 if (FileSystemMapping
== NULL
) {
2709 return (EfiShellGetEnv(L
"cwd"));
2712 PathToReturn
= NULL
;
2713 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2714 if (MapListItem
!= NULL
) {
2715 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2716 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2717 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2720 return (AddBufferToFreeList(PathToReturn
));
2727 Changes the current directory on the specified device.
2729 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2730 mapped name, this function changes the current working directory.
2732 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2733 current file system and the current directory on that file system are changed.
2735 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2738 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2739 directory on the specified file system.
2741 If the current working directory or the current working file system is changed then the
2742 %cwd% environment variable will be updated
2744 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2745 directory is changed.
2746 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2748 @retval EFI_SUCCESS The operation was sucessful
2749 @retval EFI_NOT_FOUND The file system could not be found
2754 IN CONST CHAR16
*FileSystem OPTIONAL
,
2755 IN CONST CHAR16
*Dir
2759 SHELL_MAP_LIST
*MapListItem
;
2763 CHAR16
*DirectoryName
;
2770 DirectoryName
= NULL
;
2772 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2773 return (EFI_INVALID_PARAMETER
);
2776 if (IsListEmpty(&gShellMapList
.Link
)){
2777 return (EFI_NOT_FOUND
);
2780 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2781 ASSERT(DirectoryName
!= NULL
);
2783 PathCleanUpDirectories(DirectoryName
);
2785 if (FileSystem
== NULL
) {
2787 // determine the file system mapping to use
2789 if (StrStr(DirectoryName
, L
":") != NULL
) {
2790 ASSERT(MapName
== NULL
);
2791 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2794 // find the file system mapping's entry in the list
2797 if (MapName
!= NULL
) {
2798 MapListItem
= ShellCommandFindMapItem(MapName
);
2801 // make that the current file system mapping
2803 if (MapListItem
!= NULL
) {
2804 gShellCurDir
= MapListItem
;
2807 MapListItem
= gShellCurDir
;
2810 if (MapListItem
== NULL
) {
2811 return (EFI_NOT_FOUND
);
2815 // now update the MapListItem's current directory
2817 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2818 FreePool(MapListItem
->CurrentDirectoryPath
);
2819 MapListItem
->CurrentDirectoryPath
= NULL
;
2821 if (MapName
!= NULL
) {
2822 TempLen
= StrLen(MapName
);
2823 if (TempLen
!= StrLen(DirectoryName
)) {
2824 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2825 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2828 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2829 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2831 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2832 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2833 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2837 // cant have a mapping in the directory...
2839 if (StrStr(DirectoryName
, L
":") != NULL
) {
2840 return (EFI_INVALID_PARAMETER
);
2843 // FileSystem != NULL
2845 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2846 if (MapListItem
== NULL
) {
2847 return (EFI_INVALID_PARAMETER
);
2849 // gShellCurDir = MapListItem;
2850 if (DirectoryName
!= NULL
) {
2852 // change current dir on that file system
2855 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2856 FreePool(MapListItem
->CurrentDirectoryPath
);
2857 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2859 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2860 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2861 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2862 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2863 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2864 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2865 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
2866 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2867 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2872 // if updated the current directory then update the environment variable
2874 if (MapListItem
== gShellCurDir
) {
2876 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2877 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
2878 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2879 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2880 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
2881 FreePool(TempString
);
2884 return(EFI_SUCCESS
);
2888 Return help information about a specific command.
2890 This function returns the help information for the specified command. The help text
2891 can be internal to the shell or can be from a UEFI Shell manual page.
2893 If Sections is specified, then each section name listed will be compared in a casesensitive
2894 manner, to the section names described in Appendix B. If the section exists,
2895 it will be appended to the returned help text. If the section does not exist, no
2896 information will be returned. If Sections is NULL, then all help text information
2897 available will be returned.
2899 @param Command Points to the NULL-terminated UEFI Shell command name.
2900 @param Sections Points to the NULL-terminated comma-delimited
2901 section names to return. If NULL, then all
2902 sections will be returned.
2903 @param HelpText On return, points to a callee-allocated buffer
2904 containing all specified help text.
2906 @retval EFI_SUCCESS The help text was returned.
2907 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
2909 @retval EFI_INVALID_PARAMETER HelpText is NULL
2910 @retval EFI_NOT_FOUND There is no help text available for Command.
2914 EfiShellGetHelpText(
2915 IN CONST CHAR16
*Command
,
2916 IN CONST CHAR16
*Sections OPTIONAL
,
2917 OUT CHAR16
**HelpText
2920 CONST CHAR16
*ManFileName
;
2924 ASSERT(HelpText
!= NULL
);
2927 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
2929 if (ManFileName
!= NULL
) {
2930 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
2932 if ((StrLen(Command
)> 4)
2933 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
2934 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
2935 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
2936 && (Command
[StrLen(Command
)-4] == L
'.')
2938 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
2939 ASSERT(FixCommand
!= NULL
);
2941 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
2942 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
2943 FreePool(FixCommand
);
2946 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
2952 Gets the enable status of the page break output mode.
2954 User can use this function to determine current page break mode.
2956 @retval TRUE The page break output mode is enabled.
2957 @retval FALSE The page break output mode is disabled.
2961 EfiShellGetPageBreak(
2965 return(ShellInfoObject
.PageBreakEnabled
);
2969 Judges whether the active shell is the root shell.
2971 This function makes the user to know that whether the active Shell is the root shell.
2973 @retval TRUE The active Shell is the root Shell.
2974 @retval FALSE The active Shell is NOT the root Shell.
2978 EfiShellIsRootShell(
2982 return(ShellInfoObject
.RootShellInstance
);
2986 function to return a semi-colon delimeted list of all alias' in the current shell
2988 up to caller to free the memory.
2990 @retval NULL No alias' were found
2991 @retval NULL An error ocurred getting alias'
2992 @return !NULL a list of all alias'
2996 InternalEfiShellGetListAlias(
3004 CHAR16
*VariableName
;
3009 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
3010 ASSERT_EFI_ERROR(Status
);
3012 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
3016 if (VariableName
== NULL
) {
3020 VariableName
[0] = CHAR_NULL
;
3023 NameSize
= (UINTN
)MaxVarSize
;
3024 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3025 if (Status
== EFI_NOT_FOUND
){
3028 ASSERT_EFI_ERROR(Status
);
3029 if (EFI_ERROR(Status
)) {
3032 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3033 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3034 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3035 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3038 FreePool(VariableName
);
3044 Convert a null-terminated unicode string, in-place, to all lowercase.
3047 @param Str The null-terminated string to be converted to all lowercase.
3049 @return The null-terminated string converted into all lowercase.
3058 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3059 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3060 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3067 This function returns the command associated with a alias or a list of all
3070 @param[in] Alias Points to the NULL-terminated shell alias.
3071 If this parameter is NULL, then all
3072 aliases will be returned in ReturnedData.
3073 @param[out] Volatile upon return of a single command if TRUE indicates
3074 this is stored in a volatile fashion. FALSE otherwise.
3076 @return If Alias is not NULL, it will return a pointer to
3077 the NULL-terminated command for that alias.
3078 If Alias is NULL, ReturnedData points to a ';'
3079 delimited list of alias (e.g.
3080 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3081 @retval NULL an error ocurred
3082 @retval NULL Alias was not a valid Alias
3087 IN CONST CHAR16
*Alias
,
3088 OUT BOOLEAN
*Volatile OPTIONAL
3097 // Convert to lowercase to make aliases case-insensitive
3098 if (Alias
!= NULL
) {
3099 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3100 ASSERT (AliasLower
!= NULL
);
3101 ToLower (AliasLower
);
3103 if (Volatile
== NULL
) {
3104 return (AddBufferToFreeList(GetVariable(AliasLower
, &gShellAliasGuid
)));
3108 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3109 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3110 RetVal
= AllocateZeroPool(RetSize
);
3111 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3113 if (EFI_ERROR(Status
)) {
3114 if (RetVal
!= NULL
) {
3119 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3125 FreePool (AliasLower
);
3126 return (AddBufferToFreeList(RetVal
));
3128 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3132 Changes a shell command alias.
3134 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3136 this function does not check for built in alias'.
3138 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3139 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3140 Command refers to an alias, that alias will be deleted.
3141 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3142 Alias being set will be stored in a non-volatile fashion.
3144 @retval EFI_SUCCESS Alias created or deleted successfully.
3145 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3150 IN CONST CHAR16
*Command
,
3151 IN CONST CHAR16
*Alias
,
3158 // Convert to lowercase to make aliases case-insensitive
3159 if (Alias
!= NULL
) {
3160 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3161 ASSERT (AliasLower
!= NULL
);
3162 ToLower (AliasLower
);
3168 // We must be trying to remove one if Alias is NULL
3170 if (Alias
== NULL
) {
3172 // remove an alias (but passed in COMMAND parameter)
3174 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3177 // Add and replace are the same
3180 // We dont check the error return on purpose since the variable may not exist.
3181 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3183 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3186 if (Alias
!= NULL
) {
3187 FreePool (AliasLower
);
3193 Changes a shell command alias.
3195 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3198 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3199 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3200 Command refers to an alias, that alias will be deleted.
3201 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3202 FALSE and the alias already exists, then the existing alias is unchanged and
3203 EFI_ACCESS_DENIED is returned.
3204 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3205 Alias being set will be stored in a non-volatile fashion.
3207 @retval EFI_SUCCESS Alias created or deleted successfully.
3208 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3209 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3211 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3216 IN CONST CHAR16
*Command
,
3217 IN CONST CHAR16
*Alias
,
3222 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3224 // cant set over a built in alias
3226 return (EFI_ACCESS_DENIED
);
3227 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3229 // Command is null or empty
3231 return (EFI_INVALID_PARAMETER
);
3232 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3234 // Alias already exists, Replace not set
3236 return (EFI_ACCESS_DENIED
);
3238 return (InternalSetAlias(Command
, Alias
, Volatile
));
3242 // Pure FILE_HANDLE operations are passed to FileHandleLib
3243 // these functions are indicated by the *
3244 EFI_SHELL_PROTOCOL mShellProtocol
= {
3250 EfiShellGetHelpText
,
3251 EfiShellGetDevicePathFromMap
,
3252 EfiShellGetMapFromDevicePath
,
3253 EfiShellGetDevicePathFromFilePath
,
3254 EfiShellGetFilePathFromDevicePath
,
3258 EfiShellOpenFileList
,
3259 EfiShellFreeFileList
,
3260 EfiShellRemoveDupInFileList
,
3261 EfiShellBatchIsActive
,
3262 EfiShellIsRootShell
,
3263 EfiShellEnablePageBreak
,
3264 EfiShellDisablePageBreak
,
3265 EfiShellGetPageBreak
,
3266 EfiShellGetDeviceName
,
3267 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3268 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3269 EfiShellOpenFileByName
,
3272 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3273 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3274 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3275 EfiShellDeleteFileByName
,
3276 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3277 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3278 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3280 EfiShellFindFilesInDir
,
3281 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3283 EfiShellOpenRootByHandle
,
3285 SHELL_MAJOR_VERSION
,
3290 Function to create and install on the current handle.
3292 Will overwrite any existing ShellProtocols in the system to be sure that
3293 the current shell is in control.
3295 This must be removed via calling CleanUpShellProtocol().
3297 @param[in, out] NewShell The pointer to the pointer to the structure
3300 @retval EFI_SUCCESS The operation was successful.
3301 @return An error from LocateHandle, CreateEvent, or other core function.
3305 CreatePopulateInstallShellProtocol (
3306 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3312 UINTN HandleCounter
;
3313 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3315 if (NewShell
== NULL
) {
3316 return (EFI_INVALID_PARAMETER
);
3321 OldProtocolNode
= NULL
;
3322 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3325 // Initialize EfiShellProtocol object...
3327 Status
= gBS
->CreateEvent(0,
3331 &mShellProtocol
.ExecutionBreak
);
3332 if (EFI_ERROR(Status
)) {
3337 // Get the size of the buffer we need.
3339 Status
= gBS
->LocateHandle(ByProtocol
,
3340 &gEfiShellProtocolGuid
,
3344 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3346 // Allocate and recall with buffer of correct size
3348 Buffer
= AllocateZeroPool(BufferSize
);
3349 if (Buffer
== NULL
) {
3350 return (EFI_OUT_OF_RESOURCES
);
3352 Status
= gBS
->LocateHandle(ByProtocol
,
3353 &gEfiShellProtocolGuid
,
3357 if (EFI_ERROR(Status
)) {
3362 // now overwrite each of them, but save the info to restore when we end.
3364 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3365 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3366 ASSERT(OldProtocolNode
!= NULL
);
3367 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3368 &gEfiShellProtocolGuid
,
3369 (VOID
**) &(OldProtocolNode
->Interface
),
3372 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3374 if (!EFI_ERROR(Status
)) {
3376 // reinstall over the old one...
3378 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3379 Status
= gBS
->ReinstallProtocolInterface(
3380 OldProtocolNode
->Handle
,
3381 &gEfiShellProtocolGuid
,
3382 OldProtocolNode
->Interface
,
3383 (VOID
*)(&mShellProtocol
));
3384 if (!EFI_ERROR(Status
)) {
3386 // we reinstalled sucessfully. log this so we can reverse it later.
3390 // add to the list for subsequent...
3392 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3397 } else if (Status
== EFI_NOT_FOUND
) {
3398 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3400 // no one else published yet. just publish it ourselves.
3402 Status
= gBS
->InstallProtocolInterface (
3404 &gEfiShellProtocolGuid
,
3405 EFI_NATIVE_INTERFACE
,
3406 (VOID
*)(&mShellProtocol
));
3409 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3410 ///@todo support ShellEnvironment2
3411 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3414 if (!EFI_ERROR(Status
)) {
3415 *NewShell
= &mShellProtocol
;
3421 Opposite of CreatePopulateInstallShellProtocol.
3423 Free all memory and restore the system to the state it was in before calling
3424 CreatePopulateInstallShellProtocol.
3426 @param[in, out] NewShell The pointer to the new shell protocol structure.
3428 @retval EFI_SUCCESS The operation was successful.
3432 CleanUpShellProtocol (
3433 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3437 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3438 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3441 // if we need to restore old protocols...
3443 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3444 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3445 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3446 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3448 RemoveEntryList(&Node2
->Link
);
3449 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3450 &gEfiShellProtocolGuid
,
3457 // no need to restore
3459 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3460 &gEfiShellProtocolGuid
,
3463 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3464 NewShell
->ExecutionBreak
= NULL
;
3466 Status
= gBS
->OpenProtocol(
3467 gST
->ConsoleInHandle
,
3468 &gEfiSimpleTextInputExProtocolGuid
,
3472 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3474 if (!EFI_ERROR (Status
)) {
3475 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3476 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3477 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3478 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3479 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3480 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3481 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3482 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3488 Notification function for keystrokes.
3490 @param[in] KeyData The key that was pressed.
3492 @retval EFI_SUCCESS The operation was successful.
3496 NotificationFunction(
3497 IN EFI_KEY_DATA
*KeyData
3500 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3501 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3502 (KeyData
->Key
.UnicodeChar
== 3)
3504 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3505 return (EFI_UNSUPPORTED
);
3507 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3508 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3509 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3511 ShellInfoObject
.HaltOutput
= TRUE
;
3513 return (EFI_SUCCESS
);
3517 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3518 feature's enabled state was not known when the shell initially launched.
3520 @retval EFI_SUCCESS The feature is enabled.
3521 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3525 InernalEfiShellStartMonitor(
3529 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3530 EFI_KEY_DATA KeyData
;
3533 Status
= gBS
->OpenProtocol(
3534 gST
->ConsoleInHandle
,
3535 &gEfiSimpleTextInputExProtocolGuid
,
3539 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3540 if (EFI_ERROR(Status
)) {
3545 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3546 ShellInfoObject
.HiiHandle
);
3547 return (EFI_SUCCESS
);
3550 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3551 return (EFI_UNSUPPORTED
);
3554 KeyData
.KeyState
.KeyToggleState
= 0;
3555 KeyData
.Key
.ScanCode
= 0;
3556 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3557 KeyData
.Key
.UnicodeChar
= L
'c';
3559 Status
= SimpleEx
->RegisterKeyNotify(
3562 NotificationFunction
,
3563 &ShellInfoObject
.CtrlCNotifyHandle1
);
3565 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3566 if (!EFI_ERROR(Status
)) {
3567 Status
= SimpleEx
->RegisterKeyNotify(
3570 NotificationFunction
,
3571 &ShellInfoObject
.CtrlCNotifyHandle2
);
3573 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3574 KeyData
.Key
.UnicodeChar
= 3;
3575 if (!EFI_ERROR(Status
)) {
3576 Status
= SimpleEx
->RegisterKeyNotify(
3579 NotificationFunction
,
3580 &ShellInfoObject
.CtrlCNotifyHandle3
);
3582 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3583 if (!EFI_ERROR(Status
)) {
3584 Status
= SimpleEx
->RegisterKeyNotify(
3587 NotificationFunction
,
3588 &ShellInfoObject
.CtrlCNotifyHandle4
);