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
);
464 // File Path Device Path Nodes 'can optionally add a "\" separator to
465 // the beginning and/or the end of the Path Name string.'
466 // (UEFI Spec 2.4 section 9.3.6.4).
467 // If necessary, add a "\", but otherwise don't
468 // (This is specified in the above section, and also implied by the
469 // UEFI Shell spec section 3.7)
470 if ((PathSize
!= 0) &&
471 (PathForReturn
!= NULL
) &&
472 (PathForReturn
[PathSize
- 1] != L
'\\') &&
473 (AlignedNode
->PathName
[0] != L
'\\')) {
474 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
477 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
478 FreePool(AlignedNode
);
480 } // for loop of remaining nodes
482 if (PathForReturn
!= NULL
) {
485 } // for loop of paths to check
486 return(PathForReturn
);
490 Converts a file system style name to a device path.
492 This function converts a file system style name to a device path, by replacing any
493 mapping references to the associated device path.
495 @param[in] Path The pointer to the path.
497 @return The pointer of the file path. The file path is callee
498 allocated and should be freed by the caller.
499 @retval NULL The path could not be found.
500 @retval NULL There was not enough available memory.
502 EFI_DEVICE_PATH_PROTOCOL
*
504 EfiShellGetDevicePathFromFilePath(
505 IN CONST CHAR16
*Path
512 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
513 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
514 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
515 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
526 if (StrStr(Path
, L
":") == NULL
) {
527 Cwd
= EfiShellGetCurDir(NULL
);
532 Size
+= StrSize(Path
);
533 NewPath
= AllocateZeroPool(Size
);
534 if (NewPath
== NULL
) {
537 StrCpy(NewPath
, Cwd
);
538 if (*Path
== L
'\\') {
540 while (PathRemoveLastItem(NewPath
)) ;
542 StrCat(NewPath
, Path
);
543 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
545 return (DevicePathForReturn
);
550 // find the part before (but including) the : for the map name
552 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
553 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
554 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
559 // look up the device path in the map
561 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
562 if (DevicePath
== NULL
) {
564 // Must have been a bad Mapname
570 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
572 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
573 if (DevicePathCopy
== NULL
) {
582 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
583 if (EFI_ERROR(Status
)) {
584 if (DevicePathCopyForFree
!= NULL
) {
585 FreePool(DevicePathCopyForFree
);
592 // build the full device path
594 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
595 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
597 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
601 if (DevicePathCopyForFree
!= NULL
) {
602 FreePool(DevicePathCopyForFree
);
605 return (DevicePathForReturn
);
609 Gets the name of the device specified by the device handle.
611 This function gets the user-readable name of the device specified by the device
612 handle. If no user-readable name could be generated, then *BestDeviceName will be
613 NULL and EFI_NOT_FOUND will be returned.
615 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
616 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
619 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
620 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
621 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
622 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
623 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
625 @param DeviceHandle The handle of the device.
626 @param Flags Determines the possible sources of component names.
628 EFI_DEVICE_NAME_USE_COMPONENT_NAME
629 EFI_DEVICE_NAME_USE_DEVICE_PATH
630 @param Language A pointer to the language specified for the device
631 name, in the same format as described in the UEFI
632 specification, Appendix M
633 @param BestDeviceName On return, points to the callee-allocated NULL-
634 terminated name of the device. If no device name
635 could be found, points to NULL. The name must be
636 freed by the caller...
638 @retval EFI_SUCCESS Get the name successfully.
639 @retval EFI_NOT_FOUND Fail to get the device name.
640 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
641 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
642 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
646 EfiShellGetDeviceName(
647 IN EFI_HANDLE DeviceHandle
,
648 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
650 OUT CHAR16
**BestDeviceName
654 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
655 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
656 EFI_HANDLE
*HandleList
;
659 CHAR16
*DeviceNameToReturn
;
661 UINTN ParentControllerCount
;
662 EFI_HANDLE
*ParentControllerBuffer
;
663 UINTN ParentDriverCount
;
664 EFI_HANDLE
*ParentDriverBuffer
;
666 if (BestDeviceName
== NULL
||
669 return (EFI_INVALID_PARAMETER
);
673 // make sure one of the 2 supported bits is on
675 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
676 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
677 return (EFI_INVALID_PARAMETER
);
680 DeviceNameToReturn
= NULL
;
681 *BestDeviceName
= NULL
;
686 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
687 Status
= ParseHandleDatabaseByRelationship(
690 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
693 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
695 // Go through those handles until we get one that passes for GetComponentName
697 Status
= gBS
->OpenProtocol(
699 &gEfiComponentName2ProtocolGuid
,
703 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
704 if (EFI_ERROR(Status
)) {
705 Status
= gBS
->OpenProtocol(
707 &gEfiComponentNameProtocolGuid
,
711 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
714 if (EFI_ERROR(Status
)) {
717 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
718 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
721 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
725 if (HandleList
!= NULL
) {
726 FreePool(HandleList
);
730 // Now check the parent controller using this as the child.
732 if (DeviceNameToReturn
== NULL
){
733 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
734 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
735 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
736 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
738 // try using that driver's component name with controller and our driver as the child.
740 Status
= gBS
->OpenProtocol(
741 ParentDriverBuffer
[HandleCount
],
742 &gEfiComponentName2ProtocolGuid
,
746 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
747 if (EFI_ERROR(Status
)) {
748 Status
= gBS
->OpenProtocol(
749 ParentDriverBuffer
[HandleCount
],
750 &gEfiComponentNameProtocolGuid
,
754 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
757 if (EFI_ERROR(Status
)) {
760 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
761 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
764 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
771 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
772 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
776 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
779 // dont return on fail since we will try device path if that bit is on
781 if (DeviceNameToReturn
!= NULL
){
782 ASSERT(BestDeviceName
!= NULL
);
783 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
784 return (EFI_SUCCESS
);
787 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
788 Status
= gBS
->OpenProtocol(
790 &gEfiDevicePathProtocolGuid
,
794 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
795 if (!EFI_ERROR(Status
)) {
797 // use device path to text on the device path
799 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
800 return (EFI_SUCCESS
);
804 // none of the selected bits worked.
806 return (EFI_NOT_FOUND
);
810 Opens the root directory of a device on a handle
812 This function opens the root directory of a device and returns a file handle to it.
814 @param DeviceHandle The handle of the device that contains the volume.
815 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
818 @retval EFI_SUCCESS Root opened successfully.
819 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
821 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
822 @retval EFI_DEVICE_ERROR The device had an error
826 EfiShellOpenRootByHandle(
827 IN EFI_HANDLE DeviceHandle
,
828 OUT SHELL_FILE_HANDLE
*FileHandle
832 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
833 EFI_FILE_PROTOCOL
*RealFileHandle
;
834 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
837 // get the simple file system interface
839 Status
= gBS
->OpenProtocol(DeviceHandle
,
840 &gEfiSimpleFileSystemProtocolGuid
,
841 (VOID
**)&SimpleFileSystem
,
844 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
845 if (EFI_ERROR(Status
)) {
846 return (EFI_NOT_FOUND
);
849 Status
= gBS
->OpenProtocol(DeviceHandle
,
850 &gEfiDevicePathProtocolGuid
,
854 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
855 if (EFI_ERROR(Status
)) {
856 return (EFI_NOT_FOUND
);
859 // Open the root volume now...
861 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
862 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
867 Opens the root directory of a device.
869 This function opens the root directory of a device and returns a file handle to it.
871 @param DevicePath Points to the device path corresponding to the device where the
872 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
873 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
876 @retval EFI_SUCCESS Root opened successfully.
877 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
879 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
880 @retval EFI_DEVICE_ERROR The device had an error
881 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
886 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
887 OUT SHELL_FILE_HANDLE
*FileHandle
893 if (FileHandle
== NULL
) {
894 return (EFI_INVALID_PARAMETER
);
898 // find the handle of the device with that device handle and the file system
901 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
904 if (EFI_ERROR(Status
)) {
905 return (EFI_NOT_FOUND
);
908 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
912 Returns whether any script files are currently being processed.
914 @retval TRUE There is at least one script file active.
915 @retval FALSE No script files are active now.
920 EfiShellBatchIsActive (
924 if (ShellCommandGetCurrentScriptFile() == NULL
) {
931 Worker function to open a file based on a device path. this will open the root
932 of the volume and then traverse down to the file itself.
934 @param DevicePath Device Path of the file.
935 @param FileHandle Pointer to the file upon a successful return.
936 @param OpenMode mode to open file in.
937 @param Attributes the File Attributes to use when creating a new file.
939 @retval EFI_SUCCESS the file is open and FileHandle is valid
940 @retval EFI_UNSUPPORTED the device path cotained non-path elements
941 @retval other an error ocurred.
945 InternalOpenFileDevicePath(
946 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
947 OUT SHELL_FILE_HANDLE
*FileHandle
,
949 IN UINT64 Attributes OPTIONAL
953 FILEPATH_DEVICE_PATH
*FilePathNode
;
955 SHELL_FILE_HANDLE ShellHandle
;
956 EFI_FILE_PROTOCOL
*Handle1
;
957 EFI_FILE_PROTOCOL
*Handle2
;
958 FILEPATH_DEVICE_PATH
*AlignedNode
;
960 if (FileHandle
== NULL
) {
961 return (EFI_INVALID_PARAMETER
);
971 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
973 if (!EFI_ERROR(Status
)) {
974 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
975 if (Handle1
!= NULL
) {
977 // chop off the begining part before the file system part...
980 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
983 if (!EFI_ERROR(Status
)) {
985 // To access as a file system, the file path should only
986 // contain file path components. Follow the file path nodes
987 // and find the target file
989 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
990 ; !IsDevicePathEnd (&FilePathNode
->Header
)
991 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
993 SHELL_FREE_NON_NULL(AlignedNode
);
994 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
996 // For file system access each node should be a file path component
998 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
999 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1001 Status
= EFI_UNSUPPORTED
;
1006 // Open this file path node
1012 // if this is the last node in the DevicePath always create (if that was requested).
1014 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1015 Status
= Handle2
->Open (
1018 AlignedNode
->PathName
,
1025 // This is not the last node and we dont want to 'create' existing
1026 // directory entries...
1030 // open without letting it create
1031 // prevents error on existing files/directories
1033 Status
= Handle2
->Open (
1036 AlignedNode
->PathName
,
1037 OpenMode
&~EFI_FILE_MODE_CREATE
,
1041 // if above failed now open and create the 'item'
1042 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1044 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1045 Status
= Handle2
->Open (
1048 AlignedNode
->PathName
,
1055 // Close the last node
1057 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1060 // If there's been an error, stop
1062 if (EFI_ERROR (Status
)) {
1069 SHELL_FREE_NON_NULL(AlignedNode
);
1070 if (EFI_ERROR(Status
)) {
1071 if (Handle1
!= NULL
) {
1072 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1075 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1081 Creates a file or directory by name.
1083 This function creates an empty new file or directory with the specified attributes and
1084 returns the new file's handle. If the file already exists and is read-only, then
1085 EFI_INVALID_PARAMETER will be returned.
1087 If the file already existed, it is truncated and its attributes updated. If the file is
1088 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1090 If the file name begins with >v, then the file handle which is returned refers to the
1091 shell environment variable with the specified name. If the shell environment variable
1092 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1094 @param FileName Pointer to NULL-terminated file path
1095 @param FileAttribs The new file's attrbiutes. the different attributes are
1096 described in EFI_FILE_PROTOCOL.Open().
1097 @param FileHandle On return, points to the created file handle or directory's handle
1099 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1100 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1101 @retval EFI_UNSUPPORTED could not open the file path
1102 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1103 file the file system on the device.
1104 @retval EFI_NO_MEDIA the device has no medium.
1105 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1107 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1109 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1110 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1111 when the media is write-protected.
1112 @retval EFI_ACCESS_DENIED The service denied access to the file.
1113 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1114 @retval EFI_VOLUME_FULL The volume is full.
1119 IN CONST CHAR16
*FileName
,
1120 IN UINT64 FileAttribs
,
1121 OUT SHELL_FILE_HANDLE
*FileHandle
1124 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1128 // Is this for an environment variable
1129 // do we start with >v
1131 if (StrStr(FileName
, L
">v") == FileName
) {
1132 if (!IsVolatileEnv(FileName
+2)) {
1133 return (EFI_INVALID_PARAMETER
);
1135 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1136 return (EFI_SUCCESS
);
1140 // We are opening a regular file.
1142 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1143 if (DevicePath
== NULL
) {
1144 return (EFI_NOT_FOUND
);
1147 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
); // 0 = no specific file attributes
1148 FreePool(DevicePath
);
1154 Opens a file or a directory by file name.
1156 This function opens the specified file in the specified OpenMode and returns a file
1158 If the file name begins with >v, then the file handle which is returned refers to the
1159 shell environment variable with the specified name. If the shell environment variable
1160 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1161 EFI_INVALID_PARAMETER is returned.
1163 If the file name is >i, then the file handle which is returned refers to the standard
1164 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1167 If the file name is >o, then the file handle which is returned refers to the standard
1168 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1171 If the file name is >e, then the file handle which is returned refers to the standard
1172 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1175 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1176 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1179 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1182 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1183 @param FileHandle On return, points to the file handle.
1184 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1185 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1187 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1188 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1189 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1190 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1191 system could not be found on the device. FileHandle is NULL.
1192 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1193 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1194 longer supported. FileHandle is NULL.
1195 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1196 the FileName. FileHandle is NULL.
1197 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1198 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1199 when the media is write-protected. FileHandle is NULL.
1200 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1201 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1203 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1207 EfiShellOpenFileByName(
1208 IN CONST CHAR16
*FileName
,
1209 OUT SHELL_FILE_HANDLE
*FileHandle
,
1213 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1219 // Is this for StdIn
1221 if (StrCmp(FileName
, L
">i") == 0) {
1223 // make sure not writing to StdIn
1225 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1226 return (EFI_INVALID_PARAMETER
);
1228 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1229 ASSERT(*FileHandle
!= NULL
);
1230 return (EFI_SUCCESS
);
1234 // Is this for StdOut
1236 if (StrCmp(FileName
, L
">o") == 0) {
1238 // make sure not writing to StdIn
1240 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1241 return (EFI_INVALID_PARAMETER
);
1243 *FileHandle
= &FileInterfaceStdOut
;
1244 return (EFI_SUCCESS
);
1248 // Is this for NUL file
1250 if (StrCmp(FileName
, L
"NUL") == 0) {
1251 *FileHandle
= &FileInterfaceNulFile
;
1252 return (EFI_SUCCESS
);
1256 // Is this for StdErr
1258 if (StrCmp(FileName
, L
">e") == 0) {
1260 // make sure not writing to StdIn
1262 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1263 return (EFI_INVALID_PARAMETER
);
1265 *FileHandle
= &FileInterfaceStdErr
;
1266 return (EFI_SUCCESS
);
1270 // Is this for an environment variable
1271 // do we start with >v
1273 if (StrStr(FileName
, L
">v") == FileName
) {
1274 if (!IsVolatileEnv(FileName
+2) &&
1275 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1276 return (EFI_INVALID_PARAMETER
);
1278 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1279 return (EFI_SUCCESS
);
1283 // We are opening a regular file.
1285 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1286 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1287 if (DevicePath
== NULL
) {
1288 return (EFI_NOT_FOUND
);
1292 // Copy the device path, open the file, then free the memory
1294 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1295 FreePool(DevicePath
);
1301 Deletes the file specified by the file name.
1303 This function deletes a file.
1305 @param FileName Points to the NULL-terminated file name.
1307 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1308 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1309 @sa EfiShellCreateFile
1313 EfiShellDeleteFileByName(
1314 IN CONST CHAR16
*FileName
1317 SHELL_FILE_HANDLE FileHandle
;
1321 // get a handle to the file
1323 Status
= EfiShellCreateFile(FileName
,
1326 if (EFI_ERROR(Status
)) {
1330 // now delete the file
1332 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1336 Disables the page break output mode.
1340 EfiShellDisablePageBreak (
1344 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1348 Enables the page break output mode.
1352 EfiShellEnablePageBreak (
1356 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1360 internal worker function to load and run an image via device path.
1362 @param ParentImageHandle A handle of the image that is executing the specified
1364 @param DevicePath device path of the file to execute
1365 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1366 containing the command line. If NULL then the command-
1368 @param Environment Points to a NULL-terminated array of environment
1369 variables with the format 'x=y', where x is the
1370 environment variable name and y is the value. If this
1371 is NULL, then the current shell environment is used.
1373 @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
1374 @param[out] ExitData ExitData as returned from gBS->StartImage
1376 @retval EFI_SUCCESS The command executed successfully. The status code
1377 returned by the command is pointed to by StatusCode.
1378 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1379 @retval EFI_OUT_OF_RESOURCES Out of resources.
1380 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1384 InternalShellExecuteDevicePath(
1385 IN CONST EFI_HANDLE
*ParentImageHandle
,
1386 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1387 IN CONST CHAR16
*CommandLine OPTIONAL
,
1388 IN CONST CHAR16
**Environment OPTIONAL
,
1389 OUT EFI_STATUS
*StartImageStatus OPTIONAL
,
1390 OUT UINTN
*ExitDataSize OPTIONAL
,
1391 OUT CHAR16
**ExitData OPTIONAL
1395 EFI_STATUS StartStatus
;
1396 EFI_STATUS CleanupStatus
;
1397 EFI_HANDLE NewHandle
;
1398 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1399 LIST_ENTRY OrigEnvs
;
1400 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1401 UINTN InternalExitDataSize
;
1402 UINTN
*ExitDataSizePtr
;
1406 // ExitDataSize is not OPTIONAL for gBS->BootServices, provide somewhere for
1407 // it to be dumped if the caller doesn't want it.
1408 if (ExitData
== NULL
) {
1409 ExitDataSizePtr
= &InternalExitDataSize
;
1411 ExitDataSizePtr
= ExitDataSize
;
1414 if (ParentImageHandle
== NULL
) {
1415 return (EFI_INVALID_PARAMETER
);
1418 InitializeListHead(&OrigEnvs
);
1423 // Load the image with:
1424 // FALSE - not from boot manager and NULL, 0 being not already in memory
1426 Status
= gBS
->LoadImage(
1429 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1434 if (EFI_ERROR(Status
)) {
1435 if (NewHandle
!= NULL
) {
1436 gBS
->UnloadImage(NewHandle
);
1440 Status
= gBS
->OpenProtocol(
1442 &gEfiLoadedImageProtocolGuid
,
1443 (VOID
**)&LoadedImage
,
1446 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1448 if (!EFI_ERROR(Status
)) {
1449 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1450 if (CommandLine
!= NULL
) {
1451 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(CommandLine
);
1452 LoadedImage
->LoadOptions
= (VOID
*)CommandLine
;
1456 // Save our current environment settings for later restoration if necessary
1458 if (Environment
!= NULL
) {
1459 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1460 if (!EFI_ERROR(Status
)) {
1461 Status
= SetEnvironmentVariables(Environment
);
1466 // Initialize and install a shell parameters protocol on the image.
1468 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1469 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1470 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1471 Status
= UpdateArgcArgv(&ShellParamsProtocol
, CommandLine
, NULL
, NULL
);
1472 ASSERT_EFI_ERROR(Status
);
1474 // Replace Argv[0] with the full path of the binary we're executing:
1475 // If the command line was "foo", the binary might be called "foo.efi".
1476 // "The first entry in [Argv] is always the full file path of the
1477 // executable" - UEFI Shell Spec section 2.3
1479 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1480 // The image we're executing isn't necessarily in a filesystem - it might
1481 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1482 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1483 if (ImagePath
!= NULL
) {
1484 if (ShellParamsProtocol
.Argv
== NULL
) {
1485 // Command line was empty or null.
1486 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1487 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1488 if (ShellParamsProtocol
.Argv
== NULL
) {
1489 Status
= EFI_OUT_OF_RESOURCES
;
1492 ShellParamsProtocol
.Argc
= 1;
1494 // Free the string UpdateArgcArgv put in Argv[0];
1495 FreePool (ShellParamsProtocol
.Argv
[0]);
1497 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1500 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1501 ASSERT_EFI_ERROR(Status
);
1503 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1506 // now start the image, passing up exit data if the caller requested it
1508 if (!EFI_ERROR(Status
)) {
1509 StartStatus
= gBS
->StartImage(
1514 if (StartImageStatus
!= NULL
) {
1515 *StartImageStatus
= StartStatus
;
1518 CleanupStatus
= gBS
->UninstallProtocolInterface(
1520 &gEfiShellParametersProtocolGuid
,
1521 &ShellParamsProtocol
1523 ASSERT_EFI_ERROR(CleanupStatus
);
1529 // Unload image - We should only get here if we didn't call StartImage
1530 gBS
->UnloadImage (NewHandle
);
1533 // Free Argv (Allocated in UpdateArgcArgv)
1534 if (ShellParamsProtocol
.Argv
!= NULL
) {
1535 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1536 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1537 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1540 FreePool (ShellParamsProtocol
.Argv
);
1544 // Restore environment variables
1545 if (!IsListEmpty(&OrigEnvs
)) {
1546 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1547 ASSERT_EFI_ERROR (CleanupStatus
);
1553 Execute the command line.
1555 This function creates a nested instance of the shell and executes the specified
1556 command (CommandLine) with the specified environment (Environment). Upon return,
1557 the status code returned by the specified command is placed in StatusCode.
1559 If Environment is NULL, then the current environment is used and all changes made
1560 by the commands executed will be reflected in the current environment. If the
1561 Environment is non-NULL, then the changes made will be discarded.
1563 The CommandLine is executed from the current working directory on the current
1566 @param ParentImageHandle A handle of the image that is executing the specified
1568 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1569 containing the command line. If NULL then the command-
1571 @param Environment Points to a NULL-terminated array of environment
1572 variables with the format 'x=y', where x is the
1573 environment variable name and y is the value. If this
1574 is NULL, then the current shell environment is used.
1575 @param StatusCode Points to the status code returned by the command.
1577 @retval EFI_SUCCESS The command executed successfully. The status code
1578 returned by the command is pointed to by StatusCode.
1579 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1580 @retval EFI_OUT_OF_RESOURCES Out of resources.
1581 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1582 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1584 @sa InternalShellExecuteDevicePath
1589 IN EFI_HANDLE
*ParentImageHandle
,
1590 IN CHAR16
*CommandLine OPTIONAL
,
1591 IN CHAR16
**Environment OPTIONAL
,
1592 OUT EFI_STATUS
*StatusCode OPTIONAL
1597 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1602 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1603 return (EFI_UNSUPPORTED
);
1606 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1609 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1611 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1613 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1619 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1620 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1621 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1623 Status
= InternalShellExecuteDevicePath(
1627 (CONST CHAR16
**)Environment
,
1632 if (Status
== EFI_ABORTED
) {
1633 // If the command exited with an error, the shell should put the exit
1634 // status in ExitData, preceded by a null-terminated string.
1635 ASSERT (ExitDataSize
== StrSize (ExitData
) + sizeof (SHELL_STATUS
));
1637 if (StatusCode
!= NULL
) {
1638 // Skip the null-terminated string
1639 ExitData
+= StrLen (ExitData
) + 1;
1641 // Use CopyMem to avoid alignment faults
1642 CopyMem (StatusCode
, ExitData
, sizeof (SHELL_STATUS
));
1644 // Convert from SHELL_STATUS to EFI_STATUS
1645 // EFI_STATUSes have top bit set when they are errors.
1646 // (See UEFI Spec Appendix D)
1647 if (*StatusCode
!= SHELL_SUCCESS
) {
1648 *StatusCode
= (EFI_STATUS
) *StatusCode
| MAX_BIT
;
1651 FreePool (ExitData
);
1652 Status
= EFI_SUCCESS
;
1656 // de-allocate and return
1664 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1666 1) frees all pointers (non-NULL)
1667 2) Closes the SHELL_FILE_HANDLE
1669 @param FileListNode pointer to the list node to free
1673 InternalFreeShellFileInfoNode(
1674 IN EFI_SHELL_FILE_INFO
*FileListNode
1677 if (FileListNode
->Info
!= NULL
) {
1678 FreePool((VOID
*)FileListNode
->Info
);
1680 if (FileListNode
->FileName
!= NULL
) {
1681 FreePool((VOID
*)FileListNode
->FileName
);
1683 if (FileListNode
->FullName
!= NULL
) {
1684 FreePool((VOID
*)FileListNode
->FullName
);
1686 if (FileListNode
->Handle
!= NULL
) {
1687 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1689 FreePool(FileListNode
);
1692 Frees the file list.
1694 This function cleans up the file list and any related data structures. It has no
1695 impact on the files themselves.
1697 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1698 defined in OpenFileList()
1700 @retval EFI_SUCCESS Free the file list successfully.
1701 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1705 EfiShellFreeFileList(
1706 IN EFI_SHELL_FILE_INFO
**FileList
1709 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1711 if (FileList
== NULL
|| *FileList
== NULL
) {
1712 return (EFI_INVALID_PARAMETER
);
1715 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1716 ; !IsListEmpty(&(*FileList
)->Link
)
1717 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1719 RemoveEntryList(&ShellFileListItem
->Link
);
1720 InternalFreeShellFileInfoNode(ShellFileListItem
);
1722 InternalFreeShellFileInfoNode(*FileList
);
1724 return(EFI_SUCCESS
);
1728 Deletes the duplicate file names files in the given file list.
1730 This function deletes the reduplicate files in the given file list.
1732 @param FileList A pointer to the first entry in the file list.
1734 @retval EFI_SUCCESS Always success.
1735 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1739 EfiShellRemoveDupInFileList(
1740 IN EFI_SHELL_FILE_INFO
**FileList
1743 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1744 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1745 EFI_SHELL_FILE_INFO
*TempNode
;
1747 if (FileList
== NULL
|| *FileList
== NULL
) {
1748 return (EFI_INVALID_PARAMETER
);
1750 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1751 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1752 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1754 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1755 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1756 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1758 if (gUnicodeCollation
->StriColl(
1760 (CHAR16
*)ShellFileListItem
->FullName
,
1761 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1763 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1765 &ShellFileListItem2
->Link
1767 RemoveEntryList(&ShellFileListItem2
->Link
);
1768 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1769 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1770 // memory in GetNextNode in the loop expression above.
1771 ShellFileListItem2
= TempNode
;
1775 return (EFI_SUCCESS
);
1779 // This is the same structure as the external version, but it has no CONST qualifiers.
1782 LIST_ENTRY Link
; ///< Linked list members.
1783 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1784 CHAR16
*FullName
; ///< Fully qualified filename.
1785 CHAR16
*FileName
; ///< name of this file.
1786 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1787 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1788 } EFI_SHELL_FILE_INFO_NO_CONST
;
1791 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1793 @param[in] Node The node to copy from.
1794 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1796 @retval NULL a memory allocation error ocurred
1797 @return != NULL a pointer to the new node
1799 EFI_SHELL_FILE_INFO
*
1801 InternalDuplicateShellFileInfo(
1802 IN EFI_SHELL_FILE_INFO
*Node
,
1806 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1809 // try to confirm that the objects are in sync
1811 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1813 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1814 if (NewNode
== NULL
) {
1817 NewNode
->FullName
= AllocateZeroPool(StrSize(Node
->FullName
));
1819 NewNode
->FileName
= AllocateZeroPool(StrSize(Node
->FileName
));
1820 NewNode
->Info
= AllocateZeroPool((UINTN
)Node
->Info
->Size
);
1821 if ( NewNode
->FullName
== NULL
1822 || NewNode
->FileName
== NULL
1823 || NewNode
->Info
== NULL
1825 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1826 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1827 SHELL_FREE_NON_NULL(NewNode
->Info
);
1828 SHELL_FREE_NON_NULL(NewNode
);
1831 NewNode
->Status
= Node
->Status
;
1832 NewNode
->Handle
= Node
->Handle
;
1834 Node
->Handle
= NULL
;
1836 StrCpy((CHAR16
*)NewNode
->FullName
, Node
->FullName
);
1837 StrCpy((CHAR16
*)NewNode
->FileName
, Node
->FileName
);
1838 CopyMem(NewNode
->Info
, Node
->Info
, (UINTN
)Node
->Info
->Size
);
1840 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1844 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1845 failed it will return NULL.
1847 @param[in] BasePath the Path to prepend onto filename for FullPath
1848 @param[in] Status Status member initial value.
1849 @param[in] FileName FileName member initial value.
1850 @param[in] Handle Handle member initial value.
1851 @param[in] Info Info struct to copy.
1853 @retval NULL An error ocurred.
1854 @return a pointer to the newly allocated structure.
1856 EFI_SHELL_FILE_INFO
*
1858 CreateAndPopulateShellFileInfo(
1859 IN CONST CHAR16
*BasePath
,
1860 IN CONST EFI_STATUS Status
,
1861 IN CONST CHAR16
*FileName
,
1862 IN CONST SHELL_FILE_HANDLE Handle
,
1863 IN CONST EFI_FILE_INFO
*Info
1866 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1873 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1874 if (ShellFileListItem
== NULL
) {
1877 if (Info
!= NULL
&& Info
->Size
!= 0) {
1878 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1879 if (ShellFileListItem
->Info
== NULL
) {
1880 FreePool(ShellFileListItem
);
1883 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1885 ShellFileListItem
->Info
= NULL
;
1887 if (FileName
!= NULL
) {
1888 ASSERT(TempString
== NULL
);
1889 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1890 if (ShellFileListItem
->FileName
== NULL
) {
1891 FreePool(ShellFileListItem
->Info
);
1892 FreePool(ShellFileListItem
);
1896 ShellFileListItem
->FileName
= NULL
;
1900 if (BasePath
!= NULL
) {
1901 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1902 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1903 if (TempString
== NULL
) {
1904 FreePool((VOID
*)ShellFileListItem
->FileName
);
1905 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1906 FreePool(ShellFileListItem
);
1910 if (ShellFileListItem
->FileName
!= NULL
) {
1911 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1912 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1913 if (TempString
== NULL
) {
1914 FreePool((VOID
*)ShellFileListItem
->FileName
);
1915 FreePool(ShellFileListItem
->Info
);
1916 FreePool(ShellFileListItem
);
1921 TempString
= PathCleanUpDirectories(TempString
);
1923 ShellFileListItem
->FullName
= TempString
;
1924 ShellFileListItem
->Status
= Status
;
1925 ShellFileListItem
->Handle
= Handle
;
1927 return (ShellFileListItem
);
1931 Find all files in a specified directory.
1933 @param FileDirHandle Handle of the directory to search.
1934 @param FileList On return, points to the list of files in the directory
1935 or NULL if there are no files in the directory.
1937 @retval EFI_SUCCESS File information was returned successfully.
1938 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1939 @retval EFI_DEVICE_ERROR The device reported an error.
1940 @retval EFI_NO_MEDIA The device media is not present.
1941 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1942 @return An error from FileHandleGetFileName().
1946 EfiShellFindFilesInDir(
1947 IN SHELL_FILE_HANDLE FileDirHandle
,
1948 OUT EFI_SHELL_FILE_INFO
**FileList
1951 EFI_SHELL_FILE_INFO
*ShellFileList
;
1952 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1953 EFI_FILE_INFO
*FileInfo
;
1961 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1962 if (EFI_ERROR(Status
)) {
1966 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1969 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1970 if (TempString
== NULL
) {
1971 SHELL_FREE_NON_NULL(BasePath
);
1972 return (EFI_OUT_OF_RESOURCES
);
1974 TempSpot
= StrStr(TempString
, L
";");
1976 if (TempSpot
!= NULL
) {
1977 *TempSpot
= CHAR_NULL
;
1980 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1981 if (TempString
== NULL
) {
1982 SHELL_FREE_NON_NULL(BasePath
);
1983 return (EFI_OUT_OF_RESOURCES
);
1985 SHELL_FREE_NON_NULL(BasePath
);
1986 BasePath
= TempString
;
1990 ShellFileList
= NULL
;
1991 ShellFileListItem
= NULL
;
1993 Status
= EFI_SUCCESS
;
1996 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
1997 ; !EFI_ERROR(Status
) && !NoFile
1998 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2001 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2003 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2005 EFI_SUCCESS
, // success since we didnt fail to open it...
2007 NULL
, // no handle since not open
2010 if (ShellFileList
== NULL
) {
2011 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2012 ASSERT(ShellFileList
!= NULL
);
2013 InitializeListHead(&ShellFileList
->Link
);
2015 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2017 if (EFI_ERROR(Status
)) {
2018 EfiShellFreeFileList(&ShellFileList
);
2021 *FileList
= ShellFileList
;
2023 SHELL_FREE_NON_NULL(BasePath
);
2028 Updates a file name to be preceeded by the mapped drive name
2030 @param[in] BasePath the Mapped drive name to prepend
2031 @param[in, out] Path pointer to pointer to the file name to update.
2034 @retval EFI_OUT_OF_RESOURCES
2039 IN CONST CHAR16
*BasePath
,
2040 IN OUT CHAR16
**Path
2049 ASSERT(Path
!= NULL
);
2050 ASSERT(*Path
!= NULL
);
2051 ASSERT(BasePath
!= NULL
);
2054 // convert a local path to an absolute path
2056 if (StrStr(*Path
, L
":") == NULL
) {
2057 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2058 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2059 if (Path2
== NULL
) {
2060 return (EFI_OUT_OF_RESOURCES
);
2062 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2063 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2064 if (Path2
== NULL
) {
2065 return (EFI_OUT_OF_RESOURCES
);
2072 return (EFI_SUCCESS
);
2076 If FileHandle is a directory then the function reads from FileHandle and reads in
2077 each of the FileInfo structures. If one of them matches the Pattern's first
2078 "level" then it opens that handle and calls itself on that handle.
2080 If FileHandle is a file and matches all of the remaining Pattern (which would be
2081 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2083 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2084 FreeFileList with FileList.
2086 @param[in] FilePattern The FilePattern to check against.
2087 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2088 @param[in] FileHandle The FileHandle to start with
2089 @param[in, out] FileList pointer to pointer to list of found files.
2090 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2091 @param[in] MapName The file system name this file is on.
2093 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2094 @retval EFI_NOT_FOUND no files were found
2095 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2100 IN CONST CHAR16
*FilePattern
,
2101 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2102 IN SHELL_FILE_HANDLE FileHandle
,
2103 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2104 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2105 IN CONST CHAR16
*MapName
2109 CONST CHAR16
*NextFilePatternStart
;
2110 CHAR16
*CurrentFilePattern
;
2111 EFI_SHELL_FILE_INFO
*ShellInfo
;
2112 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2113 EFI_SHELL_FILE_INFO
*NewShellNode
;
2114 EFI_FILE_INFO
*FileInfo
;
2116 CHAR16
*NewFullName
;
2119 if ( FilePattern
== NULL
2120 || UnicodeCollation
== NULL
2123 return (EFI_INVALID_PARAMETER
);
2126 CurrentFilePattern
= NULL
;
2128 if (*FilePattern
== L
'\\') {
2132 for( NextFilePatternStart
= FilePattern
2133 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2134 ; NextFilePatternStart
++);
2136 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2137 ASSERT(CurrentFilePattern
!= NULL
);
2138 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2140 if (CurrentFilePattern
[0] == CHAR_NULL
2141 &&NextFilePatternStart
[0] == CHAR_NULL
2144 // we want the parent or root node (if no parent)
2146 if (ParentNode
== NULL
) {
2148 // We want the root node. create the node.
2150 FileInfo
= FileHandleGetInfo(FileHandle
);
2151 NewShellNode
= CreateAndPopulateShellFileInfo(
2158 SHELL_FREE_NON_NULL(FileInfo
);
2161 // Add the current parameter FileHandle to the list, then end...
2163 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2165 if (NewShellNode
== NULL
) {
2166 Status
= EFI_OUT_OF_RESOURCES
;
2168 NewShellNode
->Handle
= NULL
;
2169 if (*FileList
== NULL
) {
2170 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2171 InitializeListHead(&((*FileList
)->Link
));
2175 // Add to the returning to use list
2177 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2179 Status
= EFI_SUCCESS
;
2182 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2184 if (!EFI_ERROR(Status
)){
2185 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2190 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2191 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2192 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2194 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2195 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2196 Size
= StrSize(ShellInfoNode
->FullName
);
2197 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2198 NewFullName
= AllocateZeroPool(Size
);
2199 if (NewFullName
== NULL
) {
2200 Status
= EFI_OUT_OF_RESOURCES
;
2202 StrCpy(NewFullName
, MapName
);
2203 StrCat(NewFullName
, ShellInfoNode
->FullName
+1);
2204 FreePool((VOID
*)ShellInfoNode
->FullName
);
2205 ShellInfoNode
->FullName
= NewFullName
;
2208 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2210 // should be a directory
2214 // don't open the . and .. directories
2216 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2217 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2222 if (EFI_ERROR(Status
)) {
2226 // Open the directory since we need that handle in the next recursion.
2228 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2231 // recurse with the next part of the pattern
2233 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2235 } else if (!EFI_ERROR(Status
)) {
2241 // copy the information we need into a new Node
2243 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2244 ASSERT(NewShellNode
!= NULL
);
2245 if (NewShellNode
== NULL
) {
2246 Status
= EFI_OUT_OF_RESOURCES
;
2248 if (*FileList
== NULL
) {
2249 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2250 InitializeListHead(&((*FileList
)->Link
));
2254 // Add to the returning to use list
2256 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2259 if (EFI_ERROR(Status
)) {
2263 if (EFI_ERROR(Status
)) {
2264 EfiShellFreeFileList(&ShellInfo
);
2266 Status
= EfiShellFreeFileList(&ShellInfo
);
2271 FreePool(CurrentFilePattern
);
2276 Find files that match a specified pattern.
2278 This function searches for all files and directories that match the specified
2279 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2280 information is placed in the file list FileList.
2282 Wildcards are processed
2283 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2285 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2286 field is set to NULL.
2288 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2290 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2291 @param FileList On return, points to the start of a file list containing the names
2292 of all matching files or else points to NULL if no matching files
2293 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2295 @retval EFI_SUCCESS Files found. FileList is a valid list.
2296 @retval EFI_NOT_FOUND No files found.
2297 @retval EFI_NO_MEDIA The device has no media
2298 @retval EFI_DEVICE_ERROR The device reported an error
2299 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2304 IN CONST CHAR16
*FilePattern
,
2305 OUT EFI_SHELL_FILE_INFO
**FileList
2309 CHAR16
*PatternCopy
;
2310 CHAR16
*PatternCurrentLocation
;
2311 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2312 SHELL_FILE_HANDLE RootFileHandle
;
2316 if ( FilePattern
== NULL
2318 || StrStr(FilePattern
, L
":") == NULL
2320 return (EFI_INVALID_PARAMETER
);
2322 Status
= EFI_SUCCESS
;
2323 RootDevicePath
= NULL
;
2324 RootFileHandle
= NULL
;
2326 PatternCopy
= AllocateZeroPool(StrSize(FilePattern
));
2327 if (PatternCopy
== NULL
) {
2328 return (EFI_OUT_OF_RESOURCES
);
2330 StrCpy(PatternCopy
, FilePattern
);
2332 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2334 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2337 ASSERT(MapName
== NULL
);
2338 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2339 if (MapName
== NULL
) {
2340 Status
= EFI_OUT_OF_RESOURCES
;
2342 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2343 if (RootDevicePath
== NULL
) {
2344 Status
= EFI_INVALID_PARAMETER
;
2346 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2347 if (!EFI_ERROR(Status
)) {
2348 for ( PatternCurrentLocation
= PatternCopy
2349 ; *PatternCurrentLocation
!= ':'
2350 ; PatternCurrentLocation
++);
2351 PatternCurrentLocation
++;
2352 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2354 FreePool(RootDevicePath
);
2358 SHELL_FREE_NON_NULL(PatternCopy
);
2359 SHELL_FREE_NON_NULL(MapName
);
2365 Opens the files that match the path specified.
2367 This function opens all of the files specified by Path. Wildcards are processed
2368 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2369 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2371 @param Path A pointer to the path string.
2372 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2373 EFI_FILE_MODE_WRITE.
2374 @param FileList Points to the start of a list of files opened.
2376 @retval EFI_SUCCESS Create the file list successfully.
2377 @return Others Can't create the file list.
2381 EfiShellOpenFileList(
2384 IN OUT EFI_SHELL_FILE_INFO
**FileList
2388 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2391 CONST CHAR16
*CurDir
;
2394 PathCleanUpDirectories(Path
);
2399 if (FileList
== NULL
|| *FileList
== NULL
) {
2400 return (EFI_INVALID_PARAMETER
);
2403 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2408 // convert a local path to an absolute path
2410 if (StrStr(Path
, L
":") == NULL
) {
2411 CurDir
= EfiShellGetCurDir(NULL
);
2412 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2413 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2414 if (*Path
== L
'\\') {
2416 while (PathRemoveLastItem(Path2
)) ;
2418 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2419 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2421 ASSERT(Path2
== NULL
);
2422 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2425 PathCleanUpDirectories (Path2
);
2430 Status
= EfiShellFindFiles(Path2
, FileList
);
2434 if (EFI_ERROR(Status
)) {
2440 // We had no errors so open all the files (that are not already opened...)
2442 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2443 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2444 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2446 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2447 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2453 return (EFI_NOT_FOUND
);
2455 return(EFI_SUCCESS
);
2459 This function updated with errata.
2461 Gets either a single or list of environment variables.
2463 If name is not NULL then this function returns the current value of the specified
2464 environment variable.
2466 If Name is NULL, then a list of all environment variable names is returned. Each is a
2467 NULL terminated string with a double NULL terminating the list.
2469 @param Name A pointer to the environment variable name. If
2470 Name is NULL, then the function will return all
2471 of the defined shell environment variables. In
2472 the case where multiple environment variables are
2473 being returned, each variable will be terminated by
2474 a NULL, and the list will be terminated by a double
2477 @return !=NULL A pointer to the returned string.
2478 The returned pointer does not need to be freed by the caller.
2480 @retval NULL The environment variable doesn't exist or there are
2481 no environment variables.
2486 IN CONST CHAR16
*Name
2494 CHAR16
*CurrentWriteLocation
;
2501 // Get all our environment variables
2503 InitializeListHead(&List
);
2504 Status
= GetEnvironmentVariableList(&List
);
2505 if (EFI_ERROR(Status
)){
2510 // Build the semi-colon delimited list. (2 passes)
2512 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2513 ; !IsNull(&List
, &Node
->Link
)
2514 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2516 ASSERT(Node
->Key
!= NULL
);
2517 Size
+= StrSize(Node
->Key
);
2520 Size
+= 2*sizeof(CHAR16
);
2522 Buffer
= AllocateZeroPool(Size
);
2523 if (Buffer
== NULL
) {
2524 if (!IsListEmpty (&List
)) {
2525 FreeEnvironmentVariableList(&List
);
2529 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2531 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2532 ; !IsNull(&List
, &Node
->Link
)
2533 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2535 ASSERT(Node
->Key
!= NULL
);
2536 StrCpy(CurrentWriteLocation
, Node
->Key
);
2537 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2543 if (!IsListEmpty (&List
)) {
2544 FreeEnvironmentVariableList(&List
);
2548 // We are doing a specific environment variable
2552 // get the size we need for this EnvVariable
2554 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2555 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2557 // Allocate the space and recall the get function
2559 Buffer
= AllocateZeroPool(Size
);
2560 ASSERT(Buffer
!= NULL
);
2561 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2564 // we didnt get it (might not exist)
2565 // free the memory if we allocated any and return NULL
2567 if (EFI_ERROR(Status
)) {
2568 if (Buffer
!= NULL
) {
2576 // return the buffer
2578 return (AddBufferToFreeList(Buffer
));
2582 Internal variable setting function. Allows for setting of the read only variables.
2584 @param Name Points to the NULL-terminated environment variable name.
2585 @param Value Points to the NULL-terminated environment variable value. If the value is an
2586 empty string then the environment variable is deleted.
2587 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2589 @retval EFI_SUCCESS The environment variable was successfully updated.
2593 InternalEfiShellSetEnv(
2594 IN CONST CHAR16
*Name
,
2595 IN CONST CHAR16
*Value
,
2599 if (Value
== NULL
|| StrLen(Value
) == 0) {
2600 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2602 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2604 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2606 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2612 Sets the environment variable.
2614 This function changes the current value of the specified environment variable. If the
2615 environment variable exists and the Value is an empty string, then the environment
2616 variable is deleted. If the environment variable exists and the Value is not an empty
2617 string, then the value of the environment variable is changed. If the environment
2618 variable does not exist and the Value is an empty string, there is no action. If the
2619 environment variable does not exist and the Value is a non-empty string, then the
2620 environment variable is created and assigned the specified value.
2622 For a description of volatile and non-volatile environment variables, see UEFI Shell
2623 2.0 specification section 3.6.1.
2625 @param Name Points to the NULL-terminated environment variable name.
2626 @param Value Points to the NULL-terminated environment variable value. If the value is an
2627 empty string then the environment variable is deleted.
2628 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2630 @retval EFI_SUCCESS The environment variable was successfully updated.
2635 IN CONST CHAR16
*Name
,
2636 IN CONST CHAR16
*Value
,
2640 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2641 return (EFI_INVALID_PARAMETER
);
2644 // Make sure we dont 'set' a predefined read only variable
2646 if (gUnicodeCollation
->StriColl(
2650 ||gUnicodeCollation
->StriColl(
2654 ||gUnicodeCollation
->StriColl(
2658 ||gUnicodeCollation
->StriColl(
2661 L
"uefishellsupport") == 0
2662 ||gUnicodeCollation
->StriColl(
2665 L
"uefishellversion") == 0
2666 ||gUnicodeCollation
->StriColl(
2669 L
"uefiversion") == 0
2671 return (EFI_INVALID_PARAMETER
);
2673 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2677 Returns the current directory on the specified device.
2679 If FileSystemMapping is NULL, it returns the current working directory. If the
2680 FileSystemMapping is not NULL, it returns the current directory associated with the
2681 FileSystemMapping. In both cases, the returned name includes the file system
2682 mapping (i.e. fs0:\current-dir).
2684 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2685 then the current working directory is returned.
2687 @retval !=NULL The current directory.
2688 @retval NULL Current directory does not exist.
2693 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2696 CHAR16
*PathToReturn
;
2698 SHELL_MAP_LIST
*MapListItem
;
2699 if (!IsListEmpty(&gShellMapList
.Link
)) {
2701 // if parameter is NULL, use current
2703 if (FileSystemMapping
== NULL
) {
2704 return (EfiShellGetEnv(L
"cwd"));
2707 PathToReturn
= NULL
;
2708 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2709 if (MapListItem
!= NULL
) {
2710 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2711 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2712 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2715 return (AddBufferToFreeList(PathToReturn
));
2722 Changes the current directory on the specified device.
2724 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2725 mapped name, this function changes the current working directory.
2727 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2728 current file system and the current directory on that file system are changed.
2730 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2733 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2734 directory on the specified file system.
2736 If the current working directory or the current working file system is changed then the
2737 %cwd% environment variable will be updated
2739 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2740 directory is changed.
2741 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2743 @retval EFI_SUCCESS The operation was sucessful
2744 @retval EFI_NOT_FOUND The file system could not be found
2749 IN CONST CHAR16
*FileSystem OPTIONAL
,
2750 IN CONST CHAR16
*Dir
2754 SHELL_MAP_LIST
*MapListItem
;
2758 CHAR16
*DirectoryName
;
2765 DirectoryName
= NULL
;
2767 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2768 return (EFI_INVALID_PARAMETER
);
2771 if (IsListEmpty(&gShellMapList
.Link
)){
2772 return (EFI_NOT_FOUND
);
2775 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2776 ASSERT(DirectoryName
!= NULL
);
2778 PathCleanUpDirectories(DirectoryName
);
2780 if (FileSystem
== NULL
) {
2782 // determine the file system mapping to use
2784 if (StrStr(DirectoryName
, L
":") != NULL
) {
2785 ASSERT(MapName
== NULL
);
2786 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2789 // find the file system mapping's entry in the list
2792 if (MapName
!= NULL
) {
2793 MapListItem
= ShellCommandFindMapItem(MapName
);
2796 // make that the current file system mapping
2798 if (MapListItem
!= NULL
) {
2799 gShellCurDir
= MapListItem
;
2802 MapListItem
= gShellCurDir
;
2805 if (MapListItem
== NULL
) {
2806 return (EFI_NOT_FOUND
);
2810 // now update the MapListItem's current directory
2812 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2813 FreePool(MapListItem
->CurrentDirectoryPath
);
2814 MapListItem
->CurrentDirectoryPath
= NULL
;
2816 if (MapName
!= NULL
) {
2817 TempLen
= StrLen(MapName
);
2818 if (TempLen
!= StrLen(DirectoryName
)) {
2819 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2820 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2823 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2824 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2826 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2827 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2828 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2832 // cant have a mapping in the directory...
2834 if (StrStr(DirectoryName
, L
":") != NULL
) {
2835 return (EFI_INVALID_PARAMETER
);
2838 // FileSystem != NULL
2840 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2841 if (MapListItem
== NULL
) {
2842 return (EFI_INVALID_PARAMETER
);
2844 // gShellCurDir = MapListItem;
2845 if (DirectoryName
!= NULL
) {
2847 // change current dir on that file system
2850 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2851 FreePool(MapListItem
->CurrentDirectoryPath
);
2852 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2854 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2855 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2856 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2857 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2858 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2859 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2860 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
2861 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2862 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2867 // if updated the current directory then update the environment variable
2869 if (MapListItem
== gShellCurDir
) {
2871 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2872 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
2873 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2874 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2875 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
2876 FreePool(TempString
);
2879 return(EFI_SUCCESS
);
2883 Return help information about a specific command.
2885 This function returns the help information for the specified command. The help text
2886 can be internal to the shell or can be from a UEFI Shell manual page.
2888 If Sections is specified, then each section name listed will be compared in a casesensitive
2889 manner, to the section names described in Appendix B. If the section exists,
2890 it will be appended to the returned help text. If the section does not exist, no
2891 information will be returned. If Sections is NULL, then all help text information
2892 available will be returned.
2894 @param Command Points to the NULL-terminated UEFI Shell command name.
2895 @param Sections Points to the NULL-terminated comma-delimited
2896 section names to return. If NULL, then all
2897 sections will be returned.
2898 @param HelpText On return, points to a callee-allocated buffer
2899 containing all specified help text.
2901 @retval EFI_SUCCESS The help text was returned.
2902 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
2904 @retval EFI_INVALID_PARAMETER HelpText is NULL
2905 @retval EFI_NOT_FOUND There is no help text available for Command.
2909 EfiShellGetHelpText(
2910 IN CONST CHAR16
*Command
,
2911 IN CONST CHAR16
*Sections OPTIONAL
,
2912 OUT CHAR16
**HelpText
2915 CONST CHAR16
*ManFileName
;
2919 ASSERT(HelpText
!= NULL
);
2922 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
2924 if (ManFileName
!= NULL
) {
2925 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
2927 if ((StrLen(Command
)> 4)
2928 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
2929 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
2930 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
2931 && (Command
[StrLen(Command
)-4] == L
'.')
2933 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
2934 ASSERT(FixCommand
!= NULL
);
2936 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
2937 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
2938 FreePool(FixCommand
);
2941 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
2947 Gets the enable status of the page break output mode.
2949 User can use this function to determine current page break mode.
2951 @retval TRUE The page break output mode is enabled.
2952 @retval FALSE The page break output mode is disabled.
2956 EfiShellGetPageBreak(
2960 return(ShellInfoObject
.PageBreakEnabled
);
2964 Judges whether the active shell is the root shell.
2966 This function makes the user to know that whether the active Shell is the root shell.
2968 @retval TRUE The active Shell is the root Shell.
2969 @retval FALSE The active Shell is NOT the root Shell.
2973 EfiShellIsRootShell(
2977 return(ShellInfoObject
.RootShellInstance
);
2981 function to return a semi-colon delimeted list of all alias' in the current shell
2983 up to caller to free the memory.
2985 @retval NULL No alias' were found
2986 @retval NULL An error ocurred getting alias'
2987 @return !NULL a list of all alias'
2991 InternalEfiShellGetListAlias(
2999 CHAR16
*VariableName
;
3004 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
3005 ASSERT_EFI_ERROR(Status
);
3007 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
3011 if (VariableName
== NULL
) {
3015 VariableName
[0] = CHAR_NULL
;
3018 NameSize
= (UINTN
)MaxVarSize
;
3019 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3020 if (Status
== EFI_NOT_FOUND
){
3023 ASSERT_EFI_ERROR(Status
);
3024 if (EFI_ERROR(Status
)) {
3027 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3028 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3029 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3030 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3033 FreePool(VariableName
);
3039 Convert a null-terminated unicode string, in-place, to all lowercase.
3042 @param Str The null-terminated string to be converted to all lowercase.
3044 @return The null-terminated string converted into all lowercase.
3053 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3054 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3055 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3062 This function returns the command associated with a alias or a list of all
3065 @param[in] Alias Points to the NULL-terminated shell alias.
3066 If this parameter is NULL, then all
3067 aliases will be returned in ReturnedData.
3068 @param[out] Volatile upon return of a single command if TRUE indicates
3069 this is stored in a volatile fashion. FALSE otherwise.
3071 @return If Alias is not NULL, it will return a pointer to
3072 the NULL-terminated command for that alias.
3073 If Alias is NULL, ReturnedData points to a ';'
3074 delimited list of alias (e.g.
3075 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3076 @retval NULL an error ocurred
3077 @retval NULL Alias was not a valid Alias
3082 IN CONST CHAR16
*Alias
,
3083 OUT BOOLEAN
*Volatile OPTIONAL
3092 // Convert to lowercase to make aliases case-insensitive
3093 if (Alias
!= NULL
) {
3094 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3095 ASSERT (AliasLower
!= NULL
);
3096 ToLower (AliasLower
);
3098 if (Volatile
== NULL
) {
3099 return (AddBufferToFreeList(GetVariable(AliasLower
, &gShellAliasGuid
)));
3103 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3104 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3105 RetVal
= AllocateZeroPool(RetSize
);
3106 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3108 if (EFI_ERROR(Status
)) {
3109 if (RetVal
!= NULL
) {
3114 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3120 FreePool (AliasLower
);
3121 return (AddBufferToFreeList(RetVal
));
3123 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3127 Changes a shell command alias.
3129 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3131 this function does not check for built in alias'.
3133 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3134 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3135 Command refers to an alias, that alias will be deleted.
3136 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3137 Alias being set will be stored in a non-volatile fashion.
3139 @retval EFI_SUCCESS Alias created or deleted successfully.
3140 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3145 IN CONST CHAR16
*Command
,
3146 IN CONST CHAR16
*Alias
,
3153 // Convert to lowercase to make aliases case-insensitive
3154 if (Alias
!= NULL
) {
3155 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3156 ASSERT (AliasLower
!= NULL
);
3157 ToLower (AliasLower
);
3163 // We must be trying to remove one if Alias is NULL
3165 if (Alias
== NULL
) {
3167 // remove an alias (but passed in COMMAND parameter)
3169 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3172 // Add and replace are the same
3175 // We dont check the error return on purpose since the variable may not exist.
3176 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3178 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3181 if (Alias
!= NULL
) {
3182 FreePool (AliasLower
);
3188 Changes a shell command alias.
3190 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3193 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3194 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3195 Command refers to an alias, that alias will be deleted.
3196 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3197 FALSE and the alias already exists, then the existing alias is unchanged and
3198 EFI_ACCESS_DENIED is returned.
3199 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3200 Alias being set will be stored in a non-volatile fashion.
3202 @retval EFI_SUCCESS Alias created or deleted successfully.
3203 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3204 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3206 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3211 IN CONST CHAR16
*Command
,
3212 IN CONST CHAR16
*Alias
,
3217 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3219 // cant set over a built in alias
3221 return (EFI_ACCESS_DENIED
);
3222 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3224 // Command is null or empty
3226 return (EFI_INVALID_PARAMETER
);
3227 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3229 // Alias already exists, Replace not set
3231 return (EFI_ACCESS_DENIED
);
3233 return (InternalSetAlias(Command
, Alias
, Volatile
));
3237 // Pure FILE_HANDLE operations are passed to FileHandleLib
3238 // these functions are indicated by the *
3239 EFI_SHELL_PROTOCOL mShellProtocol
= {
3245 EfiShellGetHelpText
,
3246 EfiShellGetDevicePathFromMap
,
3247 EfiShellGetMapFromDevicePath
,
3248 EfiShellGetDevicePathFromFilePath
,
3249 EfiShellGetFilePathFromDevicePath
,
3253 EfiShellOpenFileList
,
3254 EfiShellFreeFileList
,
3255 EfiShellRemoveDupInFileList
,
3256 EfiShellBatchIsActive
,
3257 EfiShellIsRootShell
,
3258 EfiShellEnablePageBreak
,
3259 EfiShellDisablePageBreak
,
3260 EfiShellGetPageBreak
,
3261 EfiShellGetDeviceName
,
3262 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3263 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3264 EfiShellOpenFileByName
,
3267 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3268 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3269 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3270 EfiShellDeleteFileByName
,
3271 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3272 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3273 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3275 EfiShellFindFilesInDir
,
3276 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3278 EfiShellOpenRootByHandle
,
3280 SHELL_MAJOR_VERSION
,
3285 Function to create and install on the current handle.
3287 Will overwrite any existing ShellProtocols in the system to be sure that
3288 the current shell is in control.
3290 This must be removed via calling CleanUpShellProtocol().
3292 @param[in, out] NewShell The pointer to the pointer to the structure
3295 @retval EFI_SUCCESS The operation was successful.
3296 @return An error from LocateHandle, CreateEvent, or other core function.
3300 CreatePopulateInstallShellProtocol (
3301 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3307 UINTN HandleCounter
;
3308 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3310 if (NewShell
== NULL
) {
3311 return (EFI_INVALID_PARAMETER
);
3316 OldProtocolNode
= NULL
;
3317 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3320 // Initialize EfiShellProtocol object...
3322 Status
= gBS
->CreateEvent(0,
3326 &mShellProtocol
.ExecutionBreak
);
3327 if (EFI_ERROR(Status
)) {
3332 // Get the size of the buffer we need.
3334 Status
= gBS
->LocateHandle(ByProtocol
,
3335 &gEfiShellProtocolGuid
,
3339 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3341 // Allocate and recall with buffer of correct size
3343 Buffer
= AllocateZeroPool(BufferSize
);
3344 if (Buffer
== NULL
) {
3345 return (EFI_OUT_OF_RESOURCES
);
3347 Status
= gBS
->LocateHandle(ByProtocol
,
3348 &gEfiShellProtocolGuid
,
3352 if (EFI_ERROR(Status
)) {
3357 // now overwrite each of them, but save the info to restore when we end.
3359 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3360 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3361 ASSERT(OldProtocolNode
!= NULL
);
3362 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3363 &gEfiShellProtocolGuid
,
3364 (VOID
**) &(OldProtocolNode
->Interface
),
3367 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3369 if (!EFI_ERROR(Status
)) {
3371 // reinstall over the old one...
3373 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3374 Status
= gBS
->ReinstallProtocolInterface(
3375 OldProtocolNode
->Handle
,
3376 &gEfiShellProtocolGuid
,
3377 OldProtocolNode
->Interface
,
3378 (VOID
*)(&mShellProtocol
));
3379 if (!EFI_ERROR(Status
)) {
3381 // we reinstalled sucessfully. log this so we can reverse it later.
3385 // add to the list for subsequent...
3387 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3392 } else if (Status
== EFI_NOT_FOUND
) {
3393 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3395 // no one else published yet. just publish it ourselves.
3397 Status
= gBS
->InstallProtocolInterface (
3399 &gEfiShellProtocolGuid
,
3400 EFI_NATIVE_INTERFACE
,
3401 (VOID
*)(&mShellProtocol
));
3404 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3405 ///@todo support ShellEnvironment2
3406 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3409 if (!EFI_ERROR(Status
)) {
3410 *NewShell
= &mShellProtocol
;
3416 Opposite of CreatePopulateInstallShellProtocol.
3418 Free all memory and restore the system to the state it was in before calling
3419 CreatePopulateInstallShellProtocol.
3421 @param[in, out] NewShell The pointer to the new shell protocol structure.
3423 @retval EFI_SUCCESS The operation was successful.
3427 CleanUpShellProtocol (
3428 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3432 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3433 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3436 // if we need to restore old protocols...
3438 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3439 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3440 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3441 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3443 RemoveEntryList(&Node2
->Link
);
3444 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3445 &gEfiShellProtocolGuid
,
3452 // no need to restore
3454 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3455 &gEfiShellProtocolGuid
,
3458 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3459 NewShell
->ExecutionBreak
= NULL
;
3461 Status
= gBS
->OpenProtocol(
3462 gST
->ConsoleInHandle
,
3463 &gEfiSimpleTextInputExProtocolGuid
,
3467 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3469 if (!EFI_ERROR (Status
)) {
3470 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3471 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3472 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3473 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3474 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3475 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3476 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3477 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3483 Notification function for keystrokes.
3485 @param[in] KeyData The key that was pressed.
3487 @retval EFI_SUCCESS The operation was successful.
3491 NotificationFunction(
3492 IN EFI_KEY_DATA
*KeyData
3495 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3496 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3497 (KeyData
->Key
.UnicodeChar
== 3)
3499 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3500 return (EFI_UNSUPPORTED
);
3502 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3503 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3504 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3506 ShellInfoObject
.HaltOutput
= TRUE
;
3508 return (EFI_SUCCESS
);
3512 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3513 feature's enabled state was not known when the shell initially launched.
3515 @retval EFI_SUCCESS The feature is enabled.
3516 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3520 InernalEfiShellStartMonitor(
3524 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3525 EFI_KEY_DATA KeyData
;
3528 Status
= gBS
->OpenProtocol(
3529 gST
->ConsoleInHandle
,
3530 &gEfiSimpleTextInputExProtocolGuid
,
3534 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3535 if (EFI_ERROR(Status
)) {
3540 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3541 ShellInfoObject
.HiiHandle
);
3542 return (EFI_SUCCESS
);
3545 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3546 return (EFI_UNSUPPORTED
);
3549 KeyData
.KeyState
.KeyToggleState
= 0;
3550 KeyData
.Key
.ScanCode
= 0;
3551 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3552 KeyData
.Key
.UnicodeChar
= L
'c';
3554 Status
= SimpleEx
->RegisterKeyNotify(
3557 NotificationFunction
,
3558 &ShellInfoObject
.CtrlCNotifyHandle1
);
3560 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3561 if (!EFI_ERROR(Status
)) {
3562 Status
= SimpleEx
->RegisterKeyNotify(
3565 NotificationFunction
,
3566 &ShellInfoObject
.CtrlCNotifyHandle2
);
3568 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3569 KeyData
.Key
.UnicodeChar
= 3;
3570 if (!EFI_ERROR(Status
)) {
3571 Status
= SimpleEx
->RegisterKeyNotify(
3574 NotificationFunction
,
3575 &ShellInfoObject
.CtrlCNotifyHandle3
);
3577 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3578 if (!EFI_ERROR(Status
)) {
3579 Status
= SimpleEx
->RegisterKeyNotify(
3582 NotificationFunction
,
3583 &ShellInfoObject
.CtrlCNotifyHandle4
);