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 UINTN
*ExitDataSize OPTIONAL
,
1390 OUT CHAR16
**ExitData OPTIONAL
1394 EFI_STATUS CleanupStatus
;
1395 EFI_HANDLE NewHandle
;
1396 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1397 LIST_ENTRY OrigEnvs
;
1398 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1399 UINTN InternalExitDataSize
;
1400 UINTN
*ExitDataSizePtr
;
1404 // ExitDataSize is not OPTIONAL for gBS->BootServices, provide somewhere for
1405 // it to be dumped if the caller doesn't want it.
1406 if (ExitData
== NULL
) {
1407 ExitDataSizePtr
= &InternalExitDataSize
;
1409 ExitDataSizePtr
= ExitDataSize
;
1412 if (ParentImageHandle
== NULL
) {
1413 return (EFI_INVALID_PARAMETER
);
1416 InitializeListHead(&OrigEnvs
);
1421 // Load the image with:
1422 // FALSE - not from boot manager and NULL, 0 being not already in memory
1424 Status
= gBS
->LoadImage(
1427 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1432 if (EFI_ERROR(Status
)) {
1433 if (NewHandle
!= NULL
) {
1434 gBS
->UnloadImage(NewHandle
);
1438 Status
= gBS
->OpenProtocol(
1440 &gEfiLoadedImageProtocolGuid
,
1441 (VOID
**)&LoadedImage
,
1444 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1446 if (!EFI_ERROR(Status
)) {
1447 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1448 if (CommandLine
!= NULL
) {
1449 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(CommandLine
);
1450 LoadedImage
->LoadOptions
= (VOID
*)CommandLine
;
1454 // Save our current environment settings for later restoration if necessary
1456 if (Environment
!= NULL
) {
1457 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1458 if (!EFI_ERROR(Status
)) {
1459 Status
= SetEnvironmentVariables(Environment
);
1464 // Initialize and install a shell parameters protocol on the image.
1466 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1467 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1468 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1469 Status
= UpdateArgcArgv(&ShellParamsProtocol
, CommandLine
, NULL
, NULL
);
1470 ASSERT_EFI_ERROR(Status
);
1472 // Replace Argv[0] with the full path of the binary we're executing:
1473 // If the command line was "foo", the binary might be called "foo.efi".
1474 // "The first entry in [Argv] is always the full file path of the
1475 // executable" - UEFI Shell Spec section 2.3
1477 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1478 // The image we're executing isn't necessarily in a filesystem - it might
1479 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1480 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1481 if (ImagePath
!= NULL
) {
1482 if (ShellParamsProtocol
.Argv
== NULL
) {
1483 // Command line was empty or null.
1484 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1485 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1486 if (ShellParamsProtocol
.Argv
== NULL
) {
1487 Status
= EFI_OUT_OF_RESOURCES
;
1490 ShellParamsProtocol
.Argc
= 1;
1492 // Free the string UpdateArgcArgv put in Argv[0];
1493 FreePool (ShellParamsProtocol
.Argv
[0]);
1495 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1498 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1499 ASSERT_EFI_ERROR(Status
);
1501 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1504 // now start the image, passing up exit data if the caller requested it
1506 if (!EFI_ERROR(Status
)) {
1507 Status
= gBS
->StartImage(
1513 CleanupStatus
= gBS
->UninstallProtocolInterface(
1515 &gEfiShellParametersProtocolGuid
,
1516 &ShellParamsProtocol
1518 ASSERT_EFI_ERROR(CleanupStatus
);
1524 // Unload image - We should only get here if we didn't call StartImage
1525 gBS
->UnloadImage (NewHandle
);
1528 // Free Argv (Allocated in UpdateArgcArgv)
1529 if (ShellParamsProtocol
.Argv
!= NULL
) {
1530 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1531 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1532 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1535 FreePool (ShellParamsProtocol
.Argv
);
1539 // Restore environment variables
1540 if (!IsListEmpty(&OrigEnvs
)) {
1541 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1542 ASSERT_EFI_ERROR (CleanupStatus
);
1548 Execute the command line.
1550 This function creates a nested instance of the shell and executes the specified
1551 command (CommandLine) with the specified environment (Environment). Upon return,
1552 the status code returned by the specified command is placed in StatusCode.
1554 If Environment is NULL, then the current environment is used and all changes made
1555 by the commands executed will be reflected in the current environment. If the
1556 Environment is non-NULL, then the changes made will be discarded.
1558 The CommandLine is executed from the current working directory on the current
1561 @param ParentImageHandle A handle of the image that is executing the specified
1563 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1564 containing the command line. If NULL then the command-
1566 @param Environment Points to a NULL-terminated array of environment
1567 variables with the format 'x=y', where x is the
1568 environment variable name and y is the value. If this
1569 is NULL, then the current shell environment is used.
1570 @param StatusCode Points to the status code returned by the command.
1572 @retval EFI_SUCCESS The command executed successfully. The status code
1573 returned by the command is pointed to by StatusCode.
1574 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1575 @retval EFI_OUT_OF_RESOURCES Out of resources.
1576 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1577 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1579 @sa InternalShellExecuteDevicePath
1584 IN EFI_HANDLE
*ParentImageHandle
,
1585 IN CHAR16
*CommandLine OPTIONAL
,
1586 IN CHAR16
**Environment OPTIONAL
,
1587 OUT EFI_STATUS
*StatusCode OPTIONAL
1592 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1597 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1598 return (EFI_UNSUPPORTED
);
1601 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1604 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1606 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1608 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1614 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1615 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1616 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1618 Status
= InternalShellExecuteDevicePath(
1622 (CONST CHAR16
**)Environment
,
1626 if (Status
== EFI_ABORTED
) {
1627 // If the command exited with an error, the shell should put the exit
1628 // status in ExitData, preceded by a null-terminated string.
1629 ASSERT (ExitDataSize
== StrSize (ExitData
) + sizeof (SHELL_STATUS
));
1631 if (StatusCode
!= NULL
) {
1632 // Skip the null-terminated string
1633 ExitData
+= StrLen (ExitData
) + 1;
1635 // Use CopyMem to avoid alignment faults
1636 CopyMem (StatusCode
, ExitData
, sizeof (SHELL_STATUS
));
1638 // Convert from SHELL_STATUS to EFI_STATUS
1639 // EFI_STATUSes have top bit set when they are errors.
1640 // (See UEFI Spec Appendix D)
1641 if (*StatusCode
!= SHELL_SUCCESS
) {
1642 *StatusCode
= (EFI_STATUS
) *StatusCode
| MAX_BIT
;
1645 FreePool (ExitData
);
1646 Status
= EFI_SUCCESS
;
1647 } else if ((StatusCode
!= NULL
) && !EFI_ERROR(Status
)) {
1648 *StatusCode
= EFI_SUCCESS
;
1652 // de-allocate and return
1660 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1662 1) frees all pointers (non-NULL)
1663 2) Closes the SHELL_FILE_HANDLE
1665 @param FileListNode pointer to the list node to free
1669 InternalFreeShellFileInfoNode(
1670 IN EFI_SHELL_FILE_INFO
*FileListNode
1673 if (FileListNode
->Info
!= NULL
) {
1674 FreePool((VOID
*)FileListNode
->Info
);
1676 if (FileListNode
->FileName
!= NULL
) {
1677 FreePool((VOID
*)FileListNode
->FileName
);
1679 if (FileListNode
->FullName
!= NULL
) {
1680 FreePool((VOID
*)FileListNode
->FullName
);
1682 if (FileListNode
->Handle
!= NULL
) {
1683 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1685 FreePool(FileListNode
);
1688 Frees the file list.
1690 This function cleans up the file list and any related data structures. It has no
1691 impact on the files themselves.
1693 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1694 defined in OpenFileList()
1696 @retval EFI_SUCCESS Free the file list successfully.
1697 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1701 EfiShellFreeFileList(
1702 IN EFI_SHELL_FILE_INFO
**FileList
1705 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1707 if (FileList
== NULL
|| *FileList
== NULL
) {
1708 return (EFI_INVALID_PARAMETER
);
1711 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1712 ; !IsListEmpty(&(*FileList
)->Link
)
1713 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1715 RemoveEntryList(&ShellFileListItem
->Link
);
1716 InternalFreeShellFileInfoNode(ShellFileListItem
);
1718 InternalFreeShellFileInfoNode(*FileList
);
1720 return(EFI_SUCCESS
);
1724 Deletes the duplicate file names files in the given file list.
1726 This function deletes the reduplicate files in the given file list.
1728 @param FileList A pointer to the first entry in the file list.
1730 @retval EFI_SUCCESS Always success.
1731 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1735 EfiShellRemoveDupInFileList(
1736 IN EFI_SHELL_FILE_INFO
**FileList
1739 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1740 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1741 EFI_SHELL_FILE_INFO
*TempNode
;
1743 if (FileList
== NULL
|| *FileList
== NULL
) {
1744 return (EFI_INVALID_PARAMETER
);
1746 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1747 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1748 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1750 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1751 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1752 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1754 if (gUnicodeCollation
->StriColl(
1756 (CHAR16
*)ShellFileListItem
->FullName
,
1757 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1759 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1761 &ShellFileListItem2
->Link
1763 RemoveEntryList(&ShellFileListItem2
->Link
);
1764 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1765 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1766 // memory in GetNextNode in the loop expression above.
1767 ShellFileListItem2
= TempNode
;
1771 return (EFI_SUCCESS
);
1775 // This is the same structure as the external version, but it has no CONST qualifiers.
1778 LIST_ENTRY Link
; ///< Linked list members.
1779 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1780 CHAR16
*FullName
; ///< Fully qualified filename.
1781 CHAR16
*FileName
; ///< name of this file.
1782 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1783 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1784 } EFI_SHELL_FILE_INFO_NO_CONST
;
1787 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1789 @param[in] Node The node to copy from.
1790 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1792 @retval NULL a memory allocation error ocurred
1793 @return != NULL a pointer to the new node
1795 EFI_SHELL_FILE_INFO
*
1797 InternalDuplicateShellFileInfo(
1798 IN EFI_SHELL_FILE_INFO
*Node
,
1802 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1805 // try to confirm that the objects are in sync
1807 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1809 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1810 if (NewNode
== NULL
) {
1813 NewNode
->FullName
= AllocateZeroPool(StrSize(Node
->FullName
));
1815 NewNode
->FileName
= AllocateZeroPool(StrSize(Node
->FileName
));
1816 NewNode
->Info
= AllocateZeroPool((UINTN
)Node
->Info
->Size
);
1817 if ( NewNode
->FullName
== NULL
1818 || NewNode
->FileName
== NULL
1819 || NewNode
->Info
== NULL
1821 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1822 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1823 SHELL_FREE_NON_NULL(NewNode
->Info
);
1824 SHELL_FREE_NON_NULL(NewNode
);
1827 NewNode
->Status
= Node
->Status
;
1828 NewNode
->Handle
= Node
->Handle
;
1830 Node
->Handle
= NULL
;
1832 StrCpy((CHAR16
*)NewNode
->FullName
, Node
->FullName
);
1833 StrCpy((CHAR16
*)NewNode
->FileName
, Node
->FileName
);
1834 CopyMem(NewNode
->Info
, Node
->Info
, (UINTN
)Node
->Info
->Size
);
1836 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1840 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1841 failed it will return NULL.
1843 @param[in] BasePath the Path to prepend onto filename for FullPath
1844 @param[in] Status Status member initial value.
1845 @param[in] FileName FileName member initial value.
1846 @param[in] Handle Handle member initial value.
1847 @param[in] Info Info struct to copy.
1849 @retval NULL An error ocurred.
1850 @return a pointer to the newly allocated structure.
1852 EFI_SHELL_FILE_INFO
*
1854 CreateAndPopulateShellFileInfo(
1855 IN CONST CHAR16
*BasePath
,
1856 IN CONST EFI_STATUS Status
,
1857 IN CONST CHAR16
*FileName
,
1858 IN CONST SHELL_FILE_HANDLE Handle
,
1859 IN CONST EFI_FILE_INFO
*Info
1862 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1869 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1870 if (ShellFileListItem
== NULL
) {
1873 if (Info
!= NULL
&& Info
->Size
!= 0) {
1874 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1875 if (ShellFileListItem
->Info
== NULL
) {
1876 FreePool(ShellFileListItem
);
1879 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1881 ShellFileListItem
->Info
= NULL
;
1883 if (FileName
!= NULL
) {
1884 ASSERT(TempString
== NULL
);
1885 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1886 if (ShellFileListItem
->FileName
== NULL
) {
1887 FreePool(ShellFileListItem
->Info
);
1888 FreePool(ShellFileListItem
);
1892 ShellFileListItem
->FileName
= NULL
;
1896 if (BasePath
!= NULL
) {
1897 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1898 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1899 if (TempString
== NULL
) {
1900 FreePool((VOID
*)ShellFileListItem
->FileName
);
1901 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1902 FreePool(ShellFileListItem
);
1906 if (ShellFileListItem
->FileName
!= NULL
) {
1907 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1908 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1909 if (TempString
== NULL
) {
1910 FreePool((VOID
*)ShellFileListItem
->FileName
);
1911 FreePool(ShellFileListItem
->Info
);
1912 FreePool(ShellFileListItem
);
1917 ShellFileListItem
->FullName
= TempString
;
1918 ShellFileListItem
->Status
= Status
;
1919 ShellFileListItem
->Handle
= Handle
;
1921 return (ShellFileListItem
);
1925 Find all files in a specified directory.
1927 @param FileDirHandle Handle of the directory to search.
1928 @param FileList On return, points to the list of files in the directory
1929 or NULL if there are no files in the directory.
1931 @retval EFI_SUCCESS File information was returned successfully.
1932 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1933 @retval EFI_DEVICE_ERROR The device reported an error.
1934 @retval EFI_NO_MEDIA The device media is not present.
1935 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1936 @return An error from FileHandleGetFileName().
1940 EfiShellFindFilesInDir(
1941 IN SHELL_FILE_HANDLE FileDirHandle
,
1942 OUT EFI_SHELL_FILE_INFO
**FileList
1945 EFI_SHELL_FILE_INFO
*ShellFileList
;
1946 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1947 EFI_FILE_INFO
*FileInfo
;
1955 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1956 if (EFI_ERROR(Status
)) {
1960 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1963 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1964 if (TempString
== NULL
) {
1965 SHELL_FREE_NON_NULL(BasePath
);
1966 return (EFI_OUT_OF_RESOURCES
);
1968 TempSpot
= StrStr(TempString
, L
";");
1970 if (TempSpot
!= NULL
) {
1971 *TempSpot
= CHAR_NULL
;
1974 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1975 if (TempString
== NULL
) {
1976 SHELL_FREE_NON_NULL(BasePath
);
1977 return (EFI_OUT_OF_RESOURCES
);
1979 SHELL_FREE_NON_NULL(BasePath
);
1980 BasePath
= TempString
;
1984 ShellFileList
= NULL
;
1985 ShellFileListItem
= NULL
;
1987 Status
= EFI_SUCCESS
;
1990 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
1991 ; !EFI_ERROR(Status
) && !NoFile
1992 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
1995 // allocate a new EFI_SHELL_FILE_INFO and populate it...
1997 ShellFileListItem
= CreateAndPopulateShellFileInfo(
1999 EFI_SUCCESS
, // success since we didnt fail to open it...
2001 NULL
, // no handle since not open
2004 if (ShellFileList
== NULL
) {
2005 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2006 ASSERT(ShellFileList
!= NULL
);
2007 InitializeListHead(&ShellFileList
->Link
);
2009 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2011 if (EFI_ERROR(Status
)) {
2012 EfiShellFreeFileList(&ShellFileList
);
2015 *FileList
= ShellFileList
;
2017 SHELL_FREE_NON_NULL(BasePath
);
2022 Updates a file name to be preceeded by the mapped drive name
2024 @param[in] BasePath the Mapped drive name to prepend
2025 @param[in, out] Path pointer to pointer to the file name to update.
2028 @retval EFI_OUT_OF_RESOURCES
2033 IN CONST CHAR16
*BasePath
,
2034 IN OUT CHAR16
**Path
2043 ASSERT(Path
!= NULL
);
2044 ASSERT(*Path
!= NULL
);
2045 ASSERT(BasePath
!= NULL
);
2048 // convert a local path to an absolute path
2050 if (StrStr(*Path
, L
":") == NULL
) {
2051 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2052 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2053 if (Path2
== NULL
) {
2054 return (EFI_OUT_OF_RESOURCES
);
2056 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2057 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2058 if (Path2
== NULL
) {
2059 return (EFI_OUT_OF_RESOURCES
);
2066 return (EFI_SUCCESS
);
2070 If FileHandle is a directory then the function reads from FileHandle and reads in
2071 each of the FileInfo structures. If one of them matches the Pattern's first
2072 "level" then it opens that handle and calls itself on that handle.
2074 If FileHandle is a file and matches all of the remaining Pattern (which would be
2075 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2077 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2078 FreeFileList with FileList.
2080 @param[in] FilePattern The FilePattern to check against.
2081 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2082 @param[in] FileHandle The FileHandle to start with
2083 @param[in, out] FileList pointer to pointer to list of found files.
2084 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2085 @param[in] MapName The file system name this file is on.
2087 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2088 @retval EFI_NOT_FOUND no files were found
2089 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2094 IN CONST CHAR16
*FilePattern
,
2095 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2096 IN SHELL_FILE_HANDLE FileHandle
,
2097 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2098 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2099 IN CONST CHAR16
*MapName
2103 CONST CHAR16
*NextFilePatternStart
;
2104 CHAR16
*CurrentFilePattern
;
2105 EFI_SHELL_FILE_INFO
*ShellInfo
;
2106 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2107 EFI_SHELL_FILE_INFO
*NewShellNode
;
2108 EFI_FILE_INFO
*FileInfo
;
2110 CHAR16
*NewFullName
;
2113 if ( FilePattern
== NULL
2114 || UnicodeCollation
== NULL
2117 return (EFI_INVALID_PARAMETER
);
2120 CurrentFilePattern
= NULL
;
2122 if (*FilePattern
== L
'\\') {
2126 for( NextFilePatternStart
= FilePattern
2127 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2128 ; NextFilePatternStart
++);
2130 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2131 ASSERT(CurrentFilePattern
!= NULL
);
2132 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2134 if (CurrentFilePattern
[0] == CHAR_NULL
2135 &&NextFilePatternStart
[0] == CHAR_NULL
2138 // we want the parent or root node (if no parent)
2140 if (ParentNode
== NULL
) {
2142 // We want the root node. create the node.
2144 FileInfo
= FileHandleGetInfo(FileHandle
);
2145 NewShellNode
= CreateAndPopulateShellFileInfo(
2152 SHELL_FREE_NON_NULL(FileInfo
);
2155 // Add the current parameter FileHandle to the list, then end...
2157 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2159 if (NewShellNode
== NULL
) {
2160 Status
= EFI_OUT_OF_RESOURCES
;
2162 NewShellNode
->Handle
= NULL
;
2163 if (*FileList
== NULL
) {
2164 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2165 InitializeListHead(&((*FileList
)->Link
));
2169 // Add to the returning to use list
2171 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2173 Status
= EFI_SUCCESS
;
2176 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2178 if (!EFI_ERROR(Status
)){
2179 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2184 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2185 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2186 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2188 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2189 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2190 Size
= StrSize(ShellInfoNode
->FullName
);
2191 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2192 NewFullName
= AllocateZeroPool(Size
);
2193 if (NewFullName
== NULL
) {
2194 Status
= EFI_OUT_OF_RESOURCES
;
2196 StrCpy(NewFullName
, MapName
);
2197 StrCat(NewFullName
, ShellInfoNode
->FullName
+1);
2198 FreePool((VOID
*)ShellInfoNode
->FullName
);
2199 ShellInfoNode
->FullName
= NewFullName
;
2202 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2204 // should be a directory
2208 // don't open the . and .. directories
2210 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2211 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2216 if (EFI_ERROR(Status
)) {
2220 // Open the directory since we need that handle in the next recursion.
2222 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2225 // recurse with the next part of the pattern
2227 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2229 } else if (!EFI_ERROR(Status
)) {
2235 // copy the information we need into a new Node
2237 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2238 ASSERT(NewShellNode
!= NULL
);
2239 if (NewShellNode
== NULL
) {
2240 Status
= EFI_OUT_OF_RESOURCES
;
2242 if (*FileList
== NULL
) {
2243 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2244 InitializeListHead(&((*FileList
)->Link
));
2248 // Add to the returning to use list
2250 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2253 if (EFI_ERROR(Status
)) {
2257 if (EFI_ERROR(Status
)) {
2258 EfiShellFreeFileList(&ShellInfo
);
2260 Status
= EfiShellFreeFileList(&ShellInfo
);
2265 FreePool(CurrentFilePattern
);
2270 Find files that match a specified pattern.
2272 This function searches for all files and directories that match the specified
2273 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2274 information is placed in the file list FileList.
2276 Wildcards are processed
2277 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2279 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2280 field is set to NULL.
2282 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2284 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2285 @param FileList On return, points to the start of a file list containing the names
2286 of all matching files or else points to NULL if no matching files
2287 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2289 @retval EFI_SUCCESS Files found. FileList is a valid list.
2290 @retval EFI_NOT_FOUND No files found.
2291 @retval EFI_NO_MEDIA The device has no media
2292 @retval EFI_DEVICE_ERROR The device reported an error
2293 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2298 IN CONST CHAR16
*FilePattern
,
2299 OUT EFI_SHELL_FILE_INFO
**FileList
2303 CHAR16
*PatternCopy
;
2304 CHAR16
*PatternCurrentLocation
;
2305 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2306 SHELL_FILE_HANDLE RootFileHandle
;
2310 if ( FilePattern
== NULL
2312 || StrStr(FilePattern
, L
":") == NULL
2314 return (EFI_INVALID_PARAMETER
);
2316 Status
= EFI_SUCCESS
;
2317 RootDevicePath
= NULL
;
2318 RootFileHandle
= NULL
;
2320 PatternCopy
= AllocateZeroPool(StrSize(FilePattern
));
2321 if (PatternCopy
== NULL
) {
2322 return (EFI_OUT_OF_RESOURCES
);
2324 StrCpy(PatternCopy
, FilePattern
);
2326 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2328 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2331 ASSERT(MapName
== NULL
);
2332 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2333 if (MapName
== NULL
) {
2334 Status
= EFI_OUT_OF_RESOURCES
;
2336 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2337 if (RootDevicePath
== NULL
) {
2338 Status
= EFI_INVALID_PARAMETER
;
2340 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2341 if (!EFI_ERROR(Status
)) {
2342 for ( PatternCurrentLocation
= PatternCopy
2343 ; *PatternCurrentLocation
!= ':'
2344 ; PatternCurrentLocation
++);
2345 PatternCurrentLocation
++;
2346 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2348 FreePool(RootDevicePath
);
2352 SHELL_FREE_NON_NULL(PatternCopy
);
2353 SHELL_FREE_NON_NULL(MapName
);
2359 Opens the files that match the path specified.
2361 This function opens all of the files specified by Path. Wildcards are processed
2362 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2363 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2365 @param Path A pointer to the path string.
2366 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2367 EFI_FILE_MODE_WRITE.
2368 @param FileList Points to the start of a list of files opened.
2370 @retval EFI_SUCCESS Create the file list successfully.
2371 @return Others Can't create the file list.
2375 EfiShellOpenFileList(
2378 IN OUT EFI_SHELL_FILE_INFO
**FileList
2382 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2385 CONST CHAR16
*CurDir
;
2388 PathCleanUpDirectories(Path
);
2393 if (FileList
== NULL
|| *FileList
== NULL
) {
2394 return (EFI_INVALID_PARAMETER
);
2397 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2402 // convert a local path to an absolute path
2404 if (StrStr(Path
, L
":") == NULL
) {
2405 CurDir
= EfiShellGetCurDir(NULL
);
2406 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2407 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2408 if (*Path
== L
'\\') {
2410 while (PathRemoveLastItem(Path2
)) ;
2412 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2413 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2415 ASSERT(Path2
== NULL
);
2416 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2419 PathCleanUpDirectories (Path2
);
2424 Status
= EfiShellFindFiles(Path2
, FileList
);
2428 if (EFI_ERROR(Status
)) {
2434 // We had no errors so open all the files (that are not already opened...)
2436 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2437 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2438 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2440 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2441 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2447 return (EFI_NOT_FOUND
);
2449 return(EFI_SUCCESS
);
2453 This function updated with errata.
2455 Gets either a single or list of environment variables.
2457 If name is not NULL then this function returns the current value of the specified
2458 environment variable.
2460 If Name is NULL, then a list of all environment variable names is returned. Each is a
2461 NULL terminated string with a double NULL terminating the list.
2463 @param Name A pointer to the environment variable name. If
2464 Name is NULL, then the function will return all
2465 of the defined shell environment variables. In
2466 the case where multiple environment variables are
2467 being returned, each variable will be terminated by
2468 a NULL, and the list will be terminated by a double
2471 @return !=NULL A pointer to the returned string.
2472 The returned pointer does not need to be freed by the caller.
2474 @retval NULL The environment variable doesn't exist or there are
2475 no environment variables.
2480 IN CONST CHAR16
*Name
2488 CHAR16
*CurrentWriteLocation
;
2495 // Get all our environment variables
2497 InitializeListHead(&List
);
2498 Status
= GetEnvironmentVariableList(&List
);
2499 if (EFI_ERROR(Status
)){
2504 // Build the semi-colon delimited list. (2 passes)
2506 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2507 ; !IsNull(&List
, &Node
->Link
)
2508 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2510 ASSERT(Node
->Key
!= NULL
);
2511 Size
+= StrSize(Node
->Key
);
2514 Size
+= 2*sizeof(CHAR16
);
2516 Buffer
= AllocateZeroPool(Size
);
2517 if (Buffer
== NULL
) {
2518 if (!IsListEmpty (&List
)) {
2519 FreeEnvironmentVariableList(&List
);
2523 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2525 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2526 ; !IsNull(&List
, &Node
->Link
)
2527 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2529 ASSERT(Node
->Key
!= NULL
);
2530 StrCpy(CurrentWriteLocation
, Node
->Key
);
2531 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2537 if (!IsListEmpty (&List
)) {
2538 FreeEnvironmentVariableList(&List
);
2542 // We are doing a specific environment variable
2546 // get the size we need for this EnvVariable
2548 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2549 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2551 // Allocate the space and recall the get function
2553 Buffer
= AllocateZeroPool(Size
);
2554 ASSERT(Buffer
!= NULL
);
2555 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(Name
, &Size
, Buffer
);
2558 // we didnt get it (might not exist)
2559 // free the memory if we allocated any and return NULL
2561 if (EFI_ERROR(Status
)) {
2562 if (Buffer
!= NULL
) {
2570 // return the buffer
2572 return (AddBufferToFreeList(Buffer
));
2576 Internal variable setting function. Allows for setting of the read only variables.
2578 @param Name Points to the NULL-terminated environment variable name.
2579 @param Value Points to the NULL-terminated environment variable value. If the value is an
2580 empty string then the environment variable is deleted.
2581 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2583 @retval EFI_SUCCESS The environment variable was successfully updated.
2587 InternalEfiShellSetEnv(
2588 IN CONST CHAR16
*Name
,
2589 IN CONST CHAR16
*Value
,
2593 if (Value
== NULL
|| StrLen(Value
) == 0) {
2594 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2596 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2598 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2600 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2606 Sets the environment variable.
2608 This function changes the current value of the specified environment variable. If the
2609 environment variable exists and the Value is an empty string, then the environment
2610 variable is deleted. If the environment variable exists and the Value is not an empty
2611 string, then the value of the environment variable is changed. If the environment
2612 variable does not exist and the Value is an empty string, there is no action. If the
2613 environment variable does not exist and the Value is a non-empty string, then the
2614 environment variable is created and assigned the specified value.
2616 For a description of volatile and non-volatile environment variables, see UEFI Shell
2617 2.0 specification section 3.6.1.
2619 @param Name Points to the NULL-terminated environment variable name.
2620 @param Value Points to the NULL-terminated environment variable value. If the value is an
2621 empty string then the environment variable is deleted.
2622 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2624 @retval EFI_SUCCESS The environment variable was successfully updated.
2629 IN CONST CHAR16
*Name
,
2630 IN CONST CHAR16
*Value
,
2634 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2635 return (EFI_INVALID_PARAMETER
);
2638 // Make sure we dont 'set' a predefined read only variable
2640 if (gUnicodeCollation
->StriColl(
2644 ||gUnicodeCollation
->StriColl(
2648 ||gUnicodeCollation
->StriColl(
2652 ||gUnicodeCollation
->StriColl(
2655 L
"uefishellsupport") == 0
2656 ||gUnicodeCollation
->StriColl(
2659 L
"uefishellversion") == 0
2660 ||gUnicodeCollation
->StriColl(
2663 L
"uefiversion") == 0
2665 return (EFI_INVALID_PARAMETER
);
2667 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2671 Returns the current directory on the specified device.
2673 If FileSystemMapping is NULL, it returns the current working directory. If the
2674 FileSystemMapping is not NULL, it returns the current directory associated with the
2675 FileSystemMapping. In both cases, the returned name includes the file system
2676 mapping (i.e. fs0:\current-dir).
2678 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2679 then the current working directory is returned.
2681 @retval !=NULL The current directory.
2682 @retval NULL Current directory does not exist.
2687 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2690 CHAR16
*PathToReturn
;
2692 SHELL_MAP_LIST
*MapListItem
;
2693 if (!IsListEmpty(&gShellMapList
.Link
)) {
2695 // if parameter is NULL, use current
2697 if (FileSystemMapping
== NULL
) {
2698 return (EfiShellGetEnv(L
"cwd"));
2701 PathToReturn
= NULL
;
2702 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2703 if (MapListItem
!= NULL
) {
2704 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2705 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2706 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2709 return (AddBufferToFreeList(PathToReturn
));
2716 Changes the current directory on the specified device.
2718 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2719 mapped name, this function changes the current working directory.
2721 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2722 current file system and the current directory on that file system are changed.
2724 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2727 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2728 directory on the specified file system.
2730 If the current working directory or the current working file system is changed then the
2731 %cwd% environment variable will be updated
2733 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2734 directory is changed.
2735 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2737 @retval EFI_SUCCESS The operation was sucessful
2738 @retval EFI_NOT_FOUND The file system could not be found
2743 IN CONST CHAR16
*FileSystem OPTIONAL
,
2744 IN CONST CHAR16
*Dir
2748 SHELL_MAP_LIST
*MapListItem
;
2752 CHAR16
*DirectoryName
;
2759 DirectoryName
= NULL
;
2761 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2762 return (EFI_INVALID_PARAMETER
);
2765 if (IsListEmpty(&gShellMapList
.Link
)){
2766 return (EFI_NOT_FOUND
);
2769 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2770 ASSERT(DirectoryName
!= NULL
);
2772 PathCleanUpDirectories(DirectoryName
);
2774 if (FileSystem
== NULL
) {
2776 // determine the file system mapping to use
2778 if (StrStr(DirectoryName
, L
":") != NULL
) {
2779 ASSERT(MapName
== NULL
);
2780 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2783 // find the file system mapping's entry in the list
2786 if (MapName
!= NULL
) {
2787 MapListItem
= ShellCommandFindMapItem(MapName
);
2790 // make that the current file system mapping
2792 if (MapListItem
!= NULL
) {
2793 gShellCurDir
= MapListItem
;
2796 MapListItem
= gShellCurDir
;
2799 if (MapListItem
== NULL
) {
2800 return (EFI_NOT_FOUND
);
2804 // now update the MapListItem's current directory
2806 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2807 FreePool(MapListItem
->CurrentDirectoryPath
);
2808 MapListItem
->CurrentDirectoryPath
= NULL
;
2810 if (MapName
!= NULL
) {
2811 TempLen
= StrLen(MapName
);
2812 if (TempLen
!= StrLen(DirectoryName
)) {
2813 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2814 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2817 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2818 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2820 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2821 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2822 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2826 // cant have a mapping in the directory...
2828 if (StrStr(DirectoryName
, L
":") != NULL
) {
2829 return (EFI_INVALID_PARAMETER
);
2832 // FileSystem != NULL
2834 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2835 if (MapListItem
== NULL
) {
2836 return (EFI_INVALID_PARAMETER
);
2838 // gShellCurDir = MapListItem;
2839 if (DirectoryName
!= NULL
) {
2841 // change current dir on that file system
2844 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2845 FreePool(MapListItem
->CurrentDirectoryPath
);
2846 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2848 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2849 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2850 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2851 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2852 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2853 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2854 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
2855 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2856 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2861 // if updated the current directory then update the environment variable
2863 if (MapListItem
== gShellCurDir
) {
2865 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2866 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
2867 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2868 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2869 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
2870 FreePool(TempString
);
2873 return(EFI_SUCCESS
);
2877 Return help information about a specific command.
2879 This function returns the help information for the specified command. The help text
2880 can be internal to the shell or can be from a UEFI Shell manual page.
2882 If Sections is specified, then each section name listed will be compared in a casesensitive
2883 manner, to the section names described in Appendix B. If the section exists,
2884 it will be appended to the returned help text. If the section does not exist, no
2885 information will be returned. If Sections is NULL, then all help text information
2886 available will be returned.
2888 @param Command Points to the NULL-terminated UEFI Shell command name.
2889 @param Sections Points to the NULL-terminated comma-delimited
2890 section names to return. If NULL, then all
2891 sections will be returned.
2892 @param HelpText On return, points to a callee-allocated buffer
2893 containing all specified help text.
2895 @retval EFI_SUCCESS The help text was returned.
2896 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
2898 @retval EFI_INVALID_PARAMETER HelpText is NULL
2899 @retval EFI_NOT_FOUND There is no help text available for Command.
2903 EfiShellGetHelpText(
2904 IN CONST CHAR16
*Command
,
2905 IN CONST CHAR16
*Sections OPTIONAL
,
2906 OUT CHAR16
**HelpText
2909 CONST CHAR16
*ManFileName
;
2913 ASSERT(HelpText
!= NULL
);
2916 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
2918 if (ManFileName
!= NULL
) {
2919 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
2921 if ((StrLen(Command
)> 4)
2922 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
2923 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
2924 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
2925 && (Command
[StrLen(Command
)-4] == L
'.')
2927 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
2928 ASSERT(FixCommand
!= NULL
);
2930 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
2931 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
2932 FreePool(FixCommand
);
2935 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
2941 Gets the enable status of the page break output mode.
2943 User can use this function to determine current page break mode.
2945 @retval TRUE The page break output mode is enabled.
2946 @retval FALSE The page break output mode is disabled.
2950 EfiShellGetPageBreak(
2954 return(ShellInfoObject
.PageBreakEnabled
);
2958 Judges whether the active shell is the root shell.
2960 This function makes the user to know that whether the active Shell is the root shell.
2962 @retval TRUE The active Shell is the root Shell.
2963 @retval FALSE The active Shell is NOT the root Shell.
2967 EfiShellIsRootShell(
2971 return(ShellInfoObject
.RootShellInstance
);
2975 function to return a semi-colon delimeted list of all alias' in the current shell
2977 up to caller to free the memory.
2979 @retval NULL No alias' were found
2980 @retval NULL An error ocurred getting alias'
2981 @return !NULL a list of all alias'
2985 InternalEfiShellGetListAlias(
2993 CHAR16
*VariableName
;
2998 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
2999 ASSERT_EFI_ERROR(Status
);
3001 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
3005 if (VariableName
== NULL
) {
3009 VariableName
[0] = CHAR_NULL
;
3012 NameSize
= (UINTN
)MaxVarSize
;
3013 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3014 if (Status
== EFI_NOT_FOUND
){
3017 ASSERT_EFI_ERROR(Status
);
3018 if (EFI_ERROR(Status
)) {
3021 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3022 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3023 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3024 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3027 FreePool(VariableName
);
3033 Convert a null-terminated unicode string, in-place, to all lowercase.
3036 @param Str The null-terminated string to be converted to all lowercase.
3038 @return The null-terminated string converted into all lowercase.
3047 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3048 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3049 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3056 This function returns the command associated with a alias or a list of all
3059 @param[in] Alias Points to the NULL-terminated shell alias.
3060 If this parameter is NULL, then all
3061 aliases will be returned in ReturnedData.
3062 @param[out] Volatile upon return of a single command if TRUE indicates
3063 this is stored in a volatile fashion. FALSE otherwise.
3065 @return If Alias is not NULL, it will return a pointer to
3066 the NULL-terminated command for that alias.
3067 If Alias is NULL, ReturnedData points to a ';'
3068 delimited list of alias (e.g.
3069 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3070 @retval NULL an error ocurred
3071 @retval NULL Alias was not a valid Alias
3076 IN CONST CHAR16
*Alias
,
3077 OUT BOOLEAN
*Volatile OPTIONAL
3086 // Convert to lowercase to make aliases case-insensitive
3087 if (Alias
!= NULL
) {
3088 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3089 ASSERT (AliasLower
!= NULL
);
3090 ToLower (AliasLower
);
3092 if (Volatile
== NULL
) {
3093 return (AddBufferToFreeList(GetVariable(AliasLower
, &gShellAliasGuid
)));
3097 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3098 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3099 RetVal
= AllocateZeroPool(RetSize
);
3100 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3102 if (EFI_ERROR(Status
)) {
3103 if (RetVal
!= NULL
) {
3108 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3114 FreePool (AliasLower
);
3115 return (AddBufferToFreeList(RetVal
));
3117 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3121 Changes a shell command alias.
3123 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3125 this function does not check for built in alias'.
3127 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3128 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3129 Command refers to an alias, that alias will be deleted.
3130 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3131 Alias being set will be stored in a non-volatile fashion.
3133 @retval EFI_SUCCESS Alias created or deleted successfully.
3134 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3139 IN CONST CHAR16
*Command
,
3140 IN CONST CHAR16
*Alias
,
3147 // Convert to lowercase to make aliases case-insensitive
3148 if (Alias
!= NULL
) {
3149 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3150 ASSERT (AliasLower
!= NULL
);
3151 ToLower (AliasLower
);
3157 // We must be trying to remove one if Alias is NULL
3159 if (Alias
== NULL
) {
3161 // remove an alias (but passed in COMMAND parameter)
3163 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3166 // Add and replace are the same
3169 // We dont check the error return on purpose since the variable may not exist.
3170 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3172 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3175 if (Alias
!= NULL
) {
3176 FreePool (AliasLower
);
3182 Changes a shell command alias.
3184 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3187 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3188 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3189 Command refers to an alias, that alias will be deleted.
3190 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3191 FALSE and the alias already exists, then the existing alias is unchanged and
3192 EFI_ACCESS_DENIED is returned.
3193 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3194 Alias being set will be stored in a non-volatile fashion.
3196 @retval EFI_SUCCESS Alias created or deleted successfully.
3197 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3198 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3200 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3205 IN CONST CHAR16
*Command
,
3206 IN CONST CHAR16
*Alias
,
3211 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3213 // cant set over a built in alias
3215 return (EFI_ACCESS_DENIED
);
3216 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3218 // Command is null or empty
3220 return (EFI_INVALID_PARAMETER
);
3221 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3223 // Alias already exists, Replace not set
3225 return (EFI_ACCESS_DENIED
);
3227 return (InternalSetAlias(Command
, Alias
, Volatile
));
3231 // Pure FILE_HANDLE operations are passed to FileHandleLib
3232 // these functions are indicated by the *
3233 EFI_SHELL_PROTOCOL mShellProtocol
= {
3239 EfiShellGetHelpText
,
3240 EfiShellGetDevicePathFromMap
,
3241 EfiShellGetMapFromDevicePath
,
3242 EfiShellGetDevicePathFromFilePath
,
3243 EfiShellGetFilePathFromDevicePath
,
3247 EfiShellOpenFileList
,
3248 EfiShellFreeFileList
,
3249 EfiShellRemoveDupInFileList
,
3250 EfiShellBatchIsActive
,
3251 EfiShellIsRootShell
,
3252 EfiShellEnablePageBreak
,
3253 EfiShellDisablePageBreak
,
3254 EfiShellGetPageBreak
,
3255 EfiShellGetDeviceName
,
3256 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3257 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3258 EfiShellOpenFileByName
,
3261 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3262 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3263 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3264 EfiShellDeleteFileByName
,
3265 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3266 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3267 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3269 EfiShellFindFilesInDir
,
3270 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3272 EfiShellOpenRootByHandle
,
3274 SHELL_MAJOR_VERSION
,
3279 Function to create and install on the current handle.
3281 Will overwrite any existing ShellProtocols in the system to be sure that
3282 the current shell is in control.
3284 This must be removed via calling CleanUpShellProtocol().
3286 @param[in, out] NewShell The pointer to the pointer to the structure
3289 @retval EFI_SUCCESS The operation was successful.
3290 @return An error from LocateHandle, CreateEvent, or other core function.
3294 CreatePopulateInstallShellProtocol (
3295 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3301 UINTN HandleCounter
;
3302 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3304 if (NewShell
== NULL
) {
3305 return (EFI_INVALID_PARAMETER
);
3310 OldProtocolNode
= NULL
;
3311 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3314 // Initialize EfiShellProtocol object...
3316 Status
= gBS
->CreateEvent(0,
3320 &mShellProtocol
.ExecutionBreak
);
3321 if (EFI_ERROR(Status
)) {
3326 // Get the size of the buffer we need.
3328 Status
= gBS
->LocateHandle(ByProtocol
,
3329 &gEfiShellProtocolGuid
,
3333 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3335 // Allocate and recall with buffer of correct size
3337 Buffer
= AllocateZeroPool(BufferSize
);
3338 if (Buffer
== NULL
) {
3339 return (EFI_OUT_OF_RESOURCES
);
3341 Status
= gBS
->LocateHandle(ByProtocol
,
3342 &gEfiShellProtocolGuid
,
3346 if (EFI_ERROR(Status
)) {
3351 // now overwrite each of them, but save the info to restore when we end.
3353 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3354 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3355 ASSERT(OldProtocolNode
!= NULL
);
3356 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3357 &gEfiShellProtocolGuid
,
3358 (VOID
**) &(OldProtocolNode
->Interface
),
3361 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3363 if (!EFI_ERROR(Status
)) {
3365 // reinstall over the old one...
3367 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3368 Status
= gBS
->ReinstallProtocolInterface(
3369 OldProtocolNode
->Handle
,
3370 &gEfiShellProtocolGuid
,
3371 OldProtocolNode
->Interface
,
3372 (VOID
*)(&mShellProtocol
));
3373 if (!EFI_ERROR(Status
)) {
3375 // we reinstalled sucessfully. log this so we can reverse it later.
3379 // add to the list for subsequent...
3381 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3386 } else if (Status
== EFI_NOT_FOUND
) {
3387 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3389 // no one else published yet. just publish it ourselves.
3391 Status
= gBS
->InstallProtocolInterface (
3393 &gEfiShellProtocolGuid
,
3394 EFI_NATIVE_INTERFACE
,
3395 (VOID
*)(&mShellProtocol
));
3398 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3399 ///@todo support ShellEnvironment2
3400 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3403 if (!EFI_ERROR(Status
)) {
3404 *NewShell
= &mShellProtocol
;
3410 Opposite of CreatePopulateInstallShellProtocol.
3412 Free all memory and restore the system to the state it was in before calling
3413 CreatePopulateInstallShellProtocol.
3415 @param[in, out] NewShell The pointer to the new shell protocol structure.
3417 @retval EFI_SUCCESS The operation was successful.
3421 CleanUpShellProtocol (
3422 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3426 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3427 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3430 // if we need to restore old protocols...
3432 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3433 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3434 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3435 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3437 RemoveEntryList(&Node2
->Link
);
3438 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3439 &gEfiShellProtocolGuid
,
3446 // no need to restore
3448 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3449 &gEfiShellProtocolGuid
,
3452 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3453 NewShell
->ExecutionBreak
= NULL
;
3455 Status
= gBS
->OpenProtocol(
3456 gST
->ConsoleInHandle
,
3457 &gEfiSimpleTextInputExProtocolGuid
,
3461 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3463 if (!EFI_ERROR (Status
)) {
3464 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3465 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3466 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3467 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3468 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3469 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3470 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3471 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3477 Notification function for keystrokes.
3479 @param[in] KeyData The key that was pressed.
3481 @retval EFI_SUCCESS The operation was successful.
3485 NotificationFunction(
3486 IN EFI_KEY_DATA
*KeyData
3489 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3490 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3491 (KeyData
->Key
.UnicodeChar
== 3)
3493 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3494 return (EFI_UNSUPPORTED
);
3496 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3497 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3498 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3500 ShellInfoObject
.HaltOutput
= TRUE
;
3502 return (EFI_SUCCESS
);
3506 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3507 feature's enabled state was not known when the shell initially launched.
3509 @retval EFI_SUCCESS The feature is enabled.
3510 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3514 InernalEfiShellStartMonitor(
3518 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3519 EFI_KEY_DATA KeyData
;
3522 Status
= gBS
->OpenProtocol(
3523 gST
->ConsoleInHandle
,
3524 &gEfiSimpleTextInputExProtocolGuid
,
3528 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3529 if (EFI_ERROR(Status
)) {
3534 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3535 ShellInfoObject
.HiiHandle
);
3536 return (EFI_SUCCESS
);
3539 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3540 return (EFI_UNSUPPORTED
);
3543 KeyData
.KeyState
.KeyToggleState
= 0;
3544 KeyData
.Key
.ScanCode
= 0;
3545 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3546 KeyData
.Key
.UnicodeChar
= L
'c';
3548 Status
= SimpleEx
->RegisterKeyNotify(
3551 NotificationFunction
,
3552 &ShellInfoObject
.CtrlCNotifyHandle1
);
3554 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3555 if (!EFI_ERROR(Status
)) {
3556 Status
= SimpleEx
->RegisterKeyNotify(
3559 NotificationFunction
,
3560 &ShellInfoObject
.CtrlCNotifyHandle2
);
3562 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3563 KeyData
.Key
.UnicodeChar
= 3;
3564 if (!EFI_ERROR(Status
)) {
3565 Status
= SimpleEx
->RegisterKeyNotify(
3568 NotificationFunction
,
3569 &ShellInfoObject
.CtrlCNotifyHandle3
);
3571 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3572 if (!EFI_ERROR(Status
)) {
3573 Status
= SimpleEx
->RegisterKeyNotify(
3576 NotificationFunction
,
3577 &ShellInfoObject
.CtrlCNotifyHandle4
);