2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
6 Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #define INIT_NAME_BUFFER_SIZE 128
22 Close an open file handle.
24 This function closes a specified file handle. All "dirty" cached file data is
25 flushed to the device, and the file is closed. In all cases the handle is
28 @param[in] FileHandle The file handle to close.
30 @retval EFI_SUCCESS The file handle was closed successfully.
35 IN SHELL_FILE_HANDLE FileHandle
38 ShellFileHandleRemove(FileHandle
);
39 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
43 Internal worker to determine whether there is a BlockIo somewhere
44 upon the device path specified.
46 @param[in] DevicePath The device path to test.
48 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
49 @retval FALSE gEfiBlockIoProtocolGuid was not found.
53 InternalShellProtocolIsBlockIoPresent(
54 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
57 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
63 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
64 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
66 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
73 Internal worker to determine whether there is a file system somewhere
74 upon the device path specified.
76 @param[in] DevicePath The device path to test.
78 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
79 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
83 InternalShellProtocolIsSimpleFileSystemPresent(
84 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
87 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
93 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
94 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
96 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
103 Internal worker debug helper function to print out maps as they are added.
105 @param[in] Mapping string mapping that has been added
106 @param[in] DevicePath pointer to device path that has been mapped.
108 @retval EFI_SUCCESS the operation was successful.
109 @return other an error ocurred
116 InternalShellProtocolDebugPrintMessage (
117 IN CONST CHAR16
*Mapping
,
118 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
124 Status
= EFI_SUCCESS
;
127 if (Mapping
!= NULL
) {
128 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
130 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
131 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
139 This function creates a mapping for a device path.
141 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
143 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
144 then the mapping will be deleted.
145 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
147 @retval EFI_SUCCESS Mapping created or deleted successfully.
148 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
149 boot service function LocateDevicePath().
150 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
151 @retval EFI_INVALID_PARAMETER Mapping was NULL
152 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
153 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
154 @retval EFI_NOT_FOUND There was no mapping found to delete
155 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
160 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
161 IN CONST CHAR16
*Mapping
165 SHELL_MAP_LIST
*MapListNode
;
167 if (Mapping
== NULL
){
168 return (EFI_INVALID_PARAMETER
);
171 if (Mapping
[StrLen(Mapping
)-1] != ':') {
172 return (EFI_INVALID_PARAMETER
);
176 // Delete the mapping
178 if (DevicePath
== NULL
) {
179 if (IsListEmpty(&gShellMapList
.Link
)) {
180 return (EFI_NOT_FOUND
);
182 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
183 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
184 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
186 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
187 RemoveEntryList(&MapListNode
->Link
);
188 SHELL_FREE_NON_NULL(MapListNode
->DevicePath
);
189 SHELL_FREE_NON_NULL(MapListNode
->MapName
);
190 SHELL_FREE_NON_NULL(MapListNode
->CurrentDirectoryPath
);
191 FreePool(MapListNode
);
192 return (EFI_SUCCESS
);
197 // We didnt find one to delete
199 return (EFI_NOT_FOUND
);
203 // make sure this is a valid to add device path
205 ///@todo add BlockIo to this test...
206 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
207 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
208 return (EFI_INVALID_PARAMETER
);
212 // First make sure there is no old mapping
214 Status
= EfiShellSetMap(NULL
, Mapping
);
215 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
220 // now add the new one.
222 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
228 Gets the device path from the mapping.
230 This function gets the device path associated with a mapping.
232 @param Mapping A pointer to the mapping
234 @retval !=NULL Pointer to the device path that corresponds to the
235 device mapping. The returned pointer does not need
237 @retval NULL There is no device path associated with the
240 CONST EFI_DEVICE_PATH_PROTOCOL
*
242 EfiShellGetDevicePathFromMap(
243 IN CONST CHAR16
*Mapping
246 SHELL_MAP_LIST
*MapListItem
;
253 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
254 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
255 StrnCatGrow(&NewName
, &Size
, L
":", 0);
258 MapListItem
= ShellCommandFindMapItem(NewName
);
262 if (MapListItem
!= NULL
) {
263 return (MapListItem
->DevicePath
);
269 Gets the mapping(s) that most closely matches the device path.
271 This function gets the mapping which corresponds to the device path *DevicePath. If
272 there is no exact match, then the mapping which most closely matches *DevicePath
273 is returned, and *DevicePath is updated to point to the remaining portion of the
274 device path. If there is an exact match, the mapping is returned and *DevicePath
275 points to the end-of-device-path node.
277 If there are multiple map names they will be semi-colon seperated in the
278 NULL-terminated string.
280 @param DevicePath On entry, points to a device path pointer. On
281 exit, updates the pointer to point to the
282 portion of the device path after the mapping.
284 @retval NULL No mapping was found.
285 @return !=NULL Pointer to NULL-terminated mapping. The buffer
286 is callee allocated and should be freed by the caller.
290 EfiShellGetMapFromDevicePath(
291 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
294 SHELL_MAP_LIST
*Node
;
295 CHAR16
*PathForReturn
;
297 // EFI_HANDLE PathHandle;
298 // EFI_HANDLE MapHandle;
299 // EFI_STATUS Status;
300 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
301 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
303 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
307 PathForReturn
= NULL
;
310 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
311 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
312 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
315 // check for exact match
317 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
318 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
320 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
322 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
325 if (PathForReturn
!= NULL
) {
326 while (!IsDevicePathEndType (*DevicePath
)) {
327 *DevicePath
= NextDevicePathNode (*DevicePath
);
329 SetDevicePathEndNode (*DevicePath
);
332 ///@todo finish code for inexact matches.
333 if (PathForReturn == NULL) {
336 DevicePathCopy = DuplicateDevicePath(*DevicePath);
337 ASSERT(DevicePathCopy != NULL);
338 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
339 ASSERT_EFI_ERROR(Status);
341 // check each of the device paths we have to get the root of the path for consist mappings
343 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
344 ; !IsNull(&gShellMapList.Link, &Node->Link)
345 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
347 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
350 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
351 ASSERT(MapPathCopy != NULL);
352 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
353 if (MapHandle == PathHandle) {
355 *DevicePath = DevicePathCopy;
358 DevicePathCopy = NULL;
359 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
360 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
365 // now add on the non-consistent mappings
367 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
368 ; !IsNull(&gShellMapList.Link, &Node->Link)
369 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
371 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
374 MapPathCopy = Node->DevicePath;
375 ASSERT(MapPathCopy != NULL);
376 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
377 if (MapHandle == PathHandle) {
378 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
379 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
386 return (AddBufferToFreeList(PathForReturn
));
390 Converts a device path to a file system-style path.
392 This function converts a device path to a file system path by replacing part, or all, of
393 the device path with the file-system mapping. If there are more than one application
394 file system mappings, the one that most closely matches Path will be used.
396 @param Path The pointer to the device path
398 @retval NULL the device path could not be found.
399 @return all The pointer of the NULL-terminated file path. The path
400 is callee-allocated and should be freed by the caller.
404 EfiShellGetFilePathFromDevicePath(
405 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
408 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
409 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
410 SHELL_MAP_LIST
*MapListItem
;
411 CHAR16
*PathForReturn
;
413 EFI_HANDLE PathHandle
;
414 EFI_HANDLE MapHandle
;
416 FILEPATH_DEVICE_PATH
*FilePath
;
417 FILEPATH_DEVICE_PATH
*AlignedNode
;
419 PathForReturn
= NULL
;
422 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
423 ASSERT(DevicePathCopy
!= NULL
);
424 if (DevicePathCopy
== NULL
) {
428 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
430 if (EFI_ERROR(Status
)) {
434 // check each of the device paths we have to get the root of the path
436 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
437 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
438 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
440 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
441 ASSERT(MapPathCopy
!= NULL
);
443 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
444 if (MapHandle
== PathHandle
) {
445 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
446 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
448 // go through all the remaining nodes in the device path
450 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
451 ; !IsDevicePathEnd (&FilePath
->Header
)
452 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
455 // If any node is not a file path node, then the conversion can not be completed
457 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
458 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
459 FreePool(PathForReturn
);
464 // append the path part onto the filepath.
466 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
468 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
469 ASSERT (AlignedNode
!= NULL
);
471 // File Path Device Path Nodes 'can optionally add a "\" separator to
472 // the beginning and/or the end of the Path Name string.'
473 // (UEFI Spec 2.4 section 9.3.6.4).
474 // If necessary, add a "\", but otherwise don't
475 // (This is specified in the above section, and also implied by the
476 // UEFI Shell spec section 3.7)
477 if ((PathSize
!= 0) &&
478 (PathForReturn
!= NULL
) &&
479 (PathForReturn
[PathSize
- 1] != L
'\\') &&
480 (AlignedNode
->PathName
[0] != L
'\\')) {
481 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
484 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
485 FreePool(AlignedNode
);
486 } // for loop of remaining nodes
488 if (PathForReturn
!= NULL
) {
491 } // for loop of paths to check
492 return(PathForReturn
);
496 Converts a file system style name to a device path.
498 This function converts a file system style name to a device path, by replacing any
499 mapping references to the associated device path.
501 @param[in] Path The pointer to the path.
503 @return The pointer of the file path. The file path is callee
504 allocated and should be freed by the caller.
505 @retval NULL The path could not be found.
506 @retval NULL There was not enough available memory.
508 EFI_DEVICE_PATH_PROTOCOL
*
510 EfiShellGetDevicePathFromFilePath(
511 IN CONST CHAR16
*Path
518 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
519 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
520 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
521 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
532 if (StrStr(Path
, L
":") == NULL
) {
533 Cwd
= EfiShellGetCurDir(NULL
);
537 Size
= StrSize(Cwd
) + StrSize(Path
);
538 NewPath
= AllocateZeroPool(Size
);
539 if (NewPath
== NULL
) {
542 StrCpyS(NewPath
, Size
/sizeof(CHAR16
), Cwd
);
543 StrCatS(NewPath
, Size
/sizeof(CHAR16
), L
"\\");
544 if (*Path
== L
'\\') {
546 while (PathRemoveLastItem(NewPath
)) ;
548 StrCatS(NewPath
, Size
/sizeof(CHAR16
), Path
);
549 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
551 return (DevicePathForReturn
);
556 // find the part before (but including) the : for the map name
558 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
559 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
560 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
565 // look up the device path in the map
567 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
568 if (DevicePath
== NULL
) {
570 // Must have been a bad Mapname
576 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
578 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
579 if (DevicePathCopy
== NULL
) {
588 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
589 if (EFI_ERROR(Status
)) {
590 if (DevicePathCopyForFree
!= NULL
) {
591 FreePool(DevicePathCopyForFree
);
598 // build the full device path
600 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
601 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
603 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
607 if (DevicePathCopyForFree
!= NULL
) {
608 FreePool(DevicePathCopyForFree
);
611 return (DevicePathForReturn
);
615 Gets the name of the device specified by the device handle.
617 This function gets the user-readable name of the device specified by the device
618 handle. If no user-readable name could be generated, then *BestDeviceName will be
619 NULL and EFI_NOT_FOUND will be returned.
621 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
622 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
625 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
626 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
627 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
628 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
629 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
631 @param DeviceHandle The handle of the device.
632 @param Flags Determines the possible sources of component names.
634 EFI_DEVICE_NAME_USE_COMPONENT_NAME
635 EFI_DEVICE_NAME_USE_DEVICE_PATH
636 @param Language A pointer to the language specified for the device
637 name, in the same format as described in the UEFI
638 specification, Appendix M
639 @param BestDeviceName On return, points to the callee-allocated NULL-
640 terminated name of the device. If no device name
641 could be found, points to NULL. The name must be
642 freed by the caller...
644 @retval EFI_SUCCESS Get the name successfully.
645 @retval EFI_NOT_FOUND Fail to get the device name.
646 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
647 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
648 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
652 EfiShellGetDeviceName(
653 IN EFI_HANDLE DeviceHandle
,
654 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
656 OUT CHAR16
**BestDeviceName
660 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
661 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
662 EFI_HANDLE
*HandleList
;
665 CHAR16
*DeviceNameToReturn
;
667 UINTN ParentControllerCount
;
668 EFI_HANDLE
*ParentControllerBuffer
;
669 UINTN ParentDriverCount
;
670 EFI_HANDLE
*ParentDriverBuffer
;
672 if (BestDeviceName
== NULL
||
675 return (EFI_INVALID_PARAMETER
);
679 // make sure one of the 2 supported bits is on
681 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
682 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
683 return (EFI_INVALID_PARAMETER
);
686 DeviceNameToReturn
= NULL
;
687 *BestDeviceName
= NULL
;
692 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
693 Status
= ParseHandleDatabaseByRelationship(
696 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
699 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
701 // Go through those handles until we get one that passes for GetComponentName
703 Status
= gBS
->OpenProtocol(
705 &gEfiComponentName2ProtocolGuid
,
709 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
710 if (EFI_ERROR(Status
)) {
711 Status
= gBS
->OpenProtocol(
713 &gEfiComponentNameProtocolGuid
,
717 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
720 if (EFI_ERROR(Status
)) {
723 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
724 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
727 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
731 if (HandleList
!= NULL
) {
732 FreePool(HandleList
);
736 // Now check the parent controller using this as the child.
738 if (DeviceNameToReturn
== NULL
){
739 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
740 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
741 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
742 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
744 // try using that driver's component name with controller and our driver as the child.
746 Status
= gBS
->OpenProtocol(
747 ParentDriverBuffer
[HandleCount
],
748 &gEfiComponentName2ProtocolGuid
,
752 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
753 if (EFI_ERROR(Status
)) {
754 Status
= gBS
->OpenProtocol(
755 ParentDriverBuffer
[HandleCount
],
756 &gEfiComponentNameProtocolGuid
,
760 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
763 if (EFI_ERROR(Status
)) {
766 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
767 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
770 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
777 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
778 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
782 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
785 // dont return on fail since we will try device path if that bit is on
787 if (DeviceNameToReturn
!= NULL
){
788 ASSERT(BestDeviceName
!= NULL
);
789 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
790 return (EFI_SUCCESS
);
793 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
794 Status
= gBS
->OpenProtocol(
796 &gEfiDevicePathProtocolGuid
,
800 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
801 if (!EFI_ERROR(Status
)) {
803 // use device path to text on the device path
805 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
806 return (EFI_SUCCESS
);
810 // none of the selected bits worked.
812 return (EFI_NOT_FOUND
);
816 Opens the root directory of a device on a handle
818 This function opens the root directory of a device and returns a file handle to it.
820 @param DeviceHandle The handle of the device that contains the volume.
821 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
824 @retval EFI_SUCCESS Root opened successfully.
825 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
827 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
828 @retval EFI_DEVICE_ERROR The device had an error
832 EfiShellOpenRootByHandle(
833 IN EFI_HANDLE DeviceHandle
,
834 OUT SHELL_FILE_HANDLE
*FileHandle
838 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
839 EFI_FILE_PROTOCOL
*RealFileHandle
;
840 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
843 // get the simple file system interface
845 Status
= gBS
->OpenProtocol(DeviceHandle
,
846 &gEfiSimpleFileSystemProtocolGuid
,
847 (VOID
**)&SimpleFileSystem
,
850 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
851 if (EFI_ERROR(Status
)) {
852 return (EFI_NOT_FOUND
);
855 Status
= gBS
->OpenProtocol(DeviceHandle
,
856 &gEfiDevicePathProtocolGuid
,
860 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
861 if (EFI_ERROR(Status
)) {
862 return (EFI_NOT_FOUND
);
865 // Open the root volume now...
867 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
868 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
873 Opens the root directory of a device.
875 This function opens the root directory of a device and returns a file handle to it.
877 @param DevicePath Points to the device path corresponding to the device where the
878 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
879 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
882 @retval EFI_SUCCESS Root opened successfully.
883 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
885 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
886 @retval EFI_DEVICE_ERROR The device had an error
887 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
892 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
893 OUT SHELL_FILE_HANDLE
*FileHandle
899 if (FileHandle
== NULL
) {
900 return (EFI_INVALID_PARAMETER
);
904 // find the handle of the device with that device handle and the file system
907 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
910 if (EFI_ERROR(Status
)) {
911 return (EFI_NOT_FOUND
);
914 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
918 Returns whether any script files are currently being processed.
920 @retval TRUE There is at least one script file active.
921 @retval FALSE No script files are active now.
926 EfiShellBatchIsActive (
930 if (ShellCommandGetCurrentScriptFile() == NULL
) {
937 Worker function to open a file based on a device path. this will open the root
938 of the volume and then traverse down to the file itself.
940 @param DevicePath Device Path of the file.
941 @param FileHandle Pointer to the file upon a successful return.
942 @param OpenMode mode to open file in.
943 @param Attributes the File Attributes to use when creating a new file.
945 @retval EFI_SUCCESS the file is open and FileHandle is valid
946 @retval EFI_UNSUPPORTED the device path cotained non-path elements
947 @retval other an error ocurred.
951 InternalOpenFileDevicePath(
952 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
953 OUT SHELL_FILE_HANDLE
*FileHandle
,
955 IN UINT64 Attributes OPTIONAL
959 FILEPATH_DEVICE_PATH
*FilePathNode
;
961 SHELL_FILE_HANDLE ShellHandle
;
962 EFI_FILE_PROTOCOL
*Handle1
;
963 EFI_FILE_PROTOCOL
*Handle2
;
964 FILEPATH_DEVICE_PATH
*AlignedNode
;
966 if (FileHandle
== NULL
) {
967 return (EFI_INVALID_PARAMETER
);
977 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
979 if (!EFI_ERROR(Status
)) {
980 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
981 if (Handle1
!= NULL
) {
983 // chop off the begining part before the file system part...
986 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
989 if (!EFI_ERROR(Status
)) {
991 // To access as a file system, the file path should only
992 // contain file path components. Follow the file path nodes
993 // and find the target file
995 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
996 ; !IsDevicePathEnd (&FilePathNode
->Header
)
997 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
999 SHELL_FREE_NON_NULL(AlignedNode
);
1000 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
1002 // For file system access each node should be a file path component
1004 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
1005 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1007 Status
= EFI_UNSUPPORTED
;
1012 // Open this file path node
1018 // if this is the last node in the DevicePath always create (if that was requested).
1020 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1021 Status
= Handle2
->Open (
1024 AlignedNode
->PathName
,
1031 // This is not the last node and we dont want to 'create' existing
1032 // directory entries...
1036 // open without letting it create
1037 // prevents error on existing files/directories
1039 Status
= Handle2
->Open (
1042 AlignedNode
->PathName
,
1043 OpenMode
&~EFI_FILE_MODE_CREATE
,
1047 // if above failed now open and create the 'item'
1048 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1050 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1051 Status
= Handle2
->Open (
1054 AlignedNode
->PathName
,
1061 // Close the last node
1063 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1066 // If there's been an error, stop
1068 if (EFI_ERROR (Status
)) {
1075 SHELL_FREE_NON_NULL(AlignedNode
);
1076 if (EFI_ERROR(Status
)) {
1077 if (Handle1
!= NULL
) {
1078 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1081 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1087 Creates a file or directory by name.
1089 This function creates an empty new file or directory with the specified attributes and
1090 returns the new file's handle. If the file already exists and is read-only, then
1091 EFI_INVALID_PARAMETER will be returned.
1093 If the file already existed, it is truncated and its attributes updated. If the file is
1094 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1096 If the file name begins with >v, then the file handle which is returned refers to the
1097 shell environment variable with the specified name. If the shell environment variable
1098 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1100 @param FileName Pointer to NULL-terminated file path
1101 @param FileAttribs The new file's attrbiutes. the different attributes are
1102 described in EFI_FILE_PROTOCOL.Open().
1103 @param FileHandle On return, points to the created file handle or directory's handle
1105 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1106 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1107 @retval EFI_UNSUPPORTED could not open the file path
1108 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1109 file the file system on the device.
1110 @retval EFI_NO_MEDIA the device has no medium.
1111 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1113 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1115 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1116 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1117 when the media is write-protected.
1118 @retval EFI_ACCESS_DENIED The service denied access to the file.
1119 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1120 @retval EFI_VOLUME_FULL The volume is full.
1125 IN CONST CHAR16
*FileName
,
1126 IN UINT64 FileAttribs
,
1127 OUT SHELL_FILE_HANDLE
*FileHandle
1130 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1134 // Is this for an environment variable
1135 // do we start with >v
1137 if (StrStr(FileName
, L
">v") == FileName
) {
1138 if (!IsVolatileEnv(FileName
+2)) {
1139 return (EFI_INVALID_PARAMETER
);
1141 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1142 return (EFI_SUCCESS
);
1146 // We are opening a regular file.
1148 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1149 if (DevicePath
== NULL
) {
1150 return (EFI_NOT_FOUND
);
1153 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
);
1154 FreePool(DevicePath
);
1160 Register a GUID and a localized human readable name for it.
1162 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1163 names must be used whenever a shell command outputs GUID information.
1165 This function is only available when the major and minor versions in the
1166 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1168 @param[in] Guid A pointer to the GUID being registered.
1169 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1171 @retval EFI_SUCCESS The operation was successful.
1172 @retval EFI_INVALID_PARAMETER Guid was NULL.
1173 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1174 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1178 EfiShellRegisterGuidName(
1179 IN CONST EFI_GUID
*Guid
,
1180 IN CONST CHAR16
*GuidName
1183 return (AddNewGuidNameMapping(Guid
, GuidName
, NULL
));
1187 Opens a file or a directory by file name.
1189 This function opens the specified file in the specified OpenMode and returns a file
1191 If the file name begins with >v, then the file handle which is returned refers to the
1192 shell environment variable with the specified name. If the shell environment variable
1193 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1194 EFI_INVALID_PARAMETER is returned.
1196 If the file name is >i, then the file handle which is returned refers to the standard
1197 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1200 If the file name is >o, then the file handle which is returned refers to the standard
1201 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1204 If the file name is >e, then the file handle which is returned refers to the standard
1205 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1208 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1209 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1212 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1215 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1216 @param FileHandle On return, points to the file handle.
1217 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1218 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1220 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1221 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1222 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1223 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1224 system could not be found on the device. FileHandle is NULL.
1225 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1226 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1227 longer supported. FileHandle is NULL.
1228 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1229 the FileName. FileHandle is NULL.
1230 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1231 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1232 when the media is write-protected. FileHandle is NULL.
1233 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1234 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1236 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1240 EfiShellOpenFileByName(
1241 IN CONST CHAR16
*FileName
,
1242 OUT SHELL_FILE_HANDLE
*FileHandle
,
1246 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1252 // Is this for StdIn
1254 if (StrCmp(FileName
, L
">i") == 0) {
1256 // make sure not writing to StdIn
1258 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1259 return (EFI_INVALID_PARAMETER
);
1261 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1262 ASSERT(*FileHandle
!= NULL
);
1263 return (EFI_SUCCESS
);
1267 // Is this for StdOut
1269 if (StrCmp(FileName
, L
">o") == 0) {
1271 // make sure not writing to StdIn
1273 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1274 return (EFI_INVALID_PARAMETER
);
1276 *FileHandle
= &FileInterfaceStdOut
;
1277 return (EFI_SUCCESS
);
1281 // Is this for NUL file
1283 if (StrCmp(FileName
, L
"NUL") == 0) {
1284 *FileHandle
= &FileInterfaceNulFile
;
1285 return (EFI_SUCCESS
);
1289 // Is this for StdErr
1291 if (StrCmp(FileName
, L
">e") == 0) {
1293 // make sure not writing to StdIn
1295 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1296 return (EFI_INVALID_PARAMETER
);
1298 *FileHandle
= &FileInterfaceStdErr
;
1299 return (EFI_SUCCESS
);
1303 // Is this for an environment variable
1304 // do we start with >v
1306 if (StrStr(FileName
, L
">v") == FileName
) {
1307 if (!IsVolatileEnv(FileName
+2) &&
1308 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1309 return (EFI_INVALID_PARAMETER
);
1311 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1312 return (EFI_SUCCESS
);
1316 // We are opening a regular file.
1318 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1319 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1320 if (DevicePath
== NULL
) {
1321 return (EFI_NOT_FOUND
);
1325 // Copy the device path, open the file, then free the memory
1327 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1328 FreePool(DevicePath
);
1334 Deletes the file specified by the file name.
1336 This function deletes a file.
1338 @param FileName Points to the NULL-terminated file name.
1340 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1341 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1342 @sa EfiShellCreateFile
1346 EfiShellDeleteFileByName(
1347 IN CONST CHAR16
*FileName
1350 SHELL_FILE_HANDLE FileHandle
;
1356 // get a handle to the file
1358 Status
= EfiShellCreateFile(FileName
,
1361 if (EFI_ERROR(Status
)) {
1365 // now delete the file
1367 ShellFileHandleRemove(FileHandle
);
1368 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1372 Disables the page break output mode.
1376 EfiShellDisablePageBreak (
1380 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1384 Enables the page break output mode.
1388 EfiShellEnablePageBreak (
1392 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1396 internal worker function to load and run an image via device path.
1398 @param ParentImageHandle A handle of the image that is executing the specified
1400 @param DevicePath device path of the file to execute
1401 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1402 containing the command line. If NULL then the command-
1404 @param Environment Points to a NULL-terminated array of environment
1405 variables with the format 'x=y', where x is the
1406 environment variable name and y is the value. If this
1407 is NULL, then the current shell environment is used.
1409 @param[out] StartImageStatus Returned status from gBS->StartImage.
1411 @retval EFI_SUCCESS The command executed successfully. The status code
1412 returned by the command is pointed to by StatusCode.
1413 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1414 @retval EFI_OUT_OF_RESOURCES Out of resources.
1415 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1419 InternalShellExecuteDevicePath(
1420 IN CONST EFI_HANDLE
*ParentImageHandle
,
1421 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1422 IN CONST CHAR16
*CommandLine OPTIONAL
,
1423 IN CONST CHAR16
**Environment OPTIONAL
,
1424 OUT EFI_STATUS
*StartImageStatus OPTIONAL
1428 EFI_STATUS StartStatus
;
1429 EFI_STATUS CleanupStatus
;
1430 EFI_HANDLE NewHandle
;
1431 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1432 LIST_ENTRY OrigEnvs
;
1433 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1439 if (ParentImageHandle
== NULL
) {
1440 return (EFI_INVALID_PARAMETER
);
1443 InitializeListHead(&OrigEnvs
);
1447 NewCmdLine
= AllocateCopyPool (StrSize (CommandLine
), CommandLine
);
1448 if (NewCmdLine
== NULL
) {
1449 return EFI_OUT_OF_RESOURCES
;
1452 for (Walker
= NewCmdLine
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
1453 if (*Walker
== L
'^' && *(Walker
+1) == L
'#') {
1454 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));
1459 // Load the image with:
1460 // FALSE - not from boot manager and NULL, 0 being not already in memory
1462 Status
= gBS
->LoadImage(
1465 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1470 if (EFI_ERROR(Status
)) {
1471 if (NewHandle
!= NULL
) {
1472 gBS
->UnloadImage(NewHandle
);
1474 FreePool (NewCmdLine
);
1477 Status
= gBS
->OpenProtocol(
1479 &gEfiLoadedImageProtocolGuid
,
1480 (VOID
**)&LoadedImage
,
1483 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1485 if (!EFI_ERROR(Status
)) {
1486 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1487 if (NewCmdLine
!= NULL
) {
1488 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(NewCmdLine
);
1489 LoadedImage
->LoadOptions
= (VOID
*)NewCmdLine
;
1493 // Save our current environment settings for later restoration if necessary
1495 if (Environment
!= NULL
) {
1496 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1497 if (!EFI_ERROR(Status
)) {
1498 Status
= SetEnvironmentVariables(Environment
);
1503 // Initialize and install a shell parameters protocol on the image.
1505 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1506 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1507 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1508 Status
= UpdateArgcArgv(&ShellParamsProtocol
, NewCmdLine
, Efi_Application
, NULL
, NULL
);
1509 ASSERT_EFI_ERROR(Status
);
1511 // Replace Argv[0] with the full path of the binary we're executing:
1512 // If the command line was "foo", the binary might be called "foo.efi".
1513 // "The first entry in [Argv] is always the full file path of the
1514 // executable" - UEFI Shell Spec section 2.3
1516 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1517 // The image we're executing isn't necessarily in a filesystem - it might
1518 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1519 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1520 if (ImagePath
!= NULL
) {
1521 if (ShellParamsProtocol
.Argv
== NULL
) {
1522 // Command line was empty or null.
1523 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1524 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1525 if (ShellParamsProtocol
.Argv
== NULL
) {
1526 Status
= EFI_OUT_OF_RESOURCES
;
1529 ShellParamsProtocol
.Argc
= 1;
1531 // Free the string UpdateArgcArgv put in Argv[0];
1532 FreePool (ShellParamsProtocol
.Argv
[0]);
1534 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1537 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1538 ASSERT_EFI_ERROR(Status
);
1540 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1543 // now start the image and if the caller wanted the return code pass it to them...
1545 if (!EFI_ERROR(Status
)) {
1546 StartStatus
= gBS
->StartImage(
1551 if (StartImageStatus
!= NULL
) {
1552 *StartImageStatus
= StartStatus
;
1555 CleanupStatus
= gBS
->UninstallProtocolInterface(
1557 &gEfiShellParametersProtocolGuid
,
1558 &ShellParamsProtocol
1560 ASSERT_EFI_ERROR(CleanupStatus
);
1566 // Unload image - We should only get here if we didn't call StartImage
1567 gBS
->UnloadImage (NewHandle
);
1570 // Free Argv (Allocated in UpdateArgcArgv)
1571 if (ShellParamsProtocol
.Argv
!= NULL
) {
1572 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1573 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1574 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1577 FreePool (ShellParamsProtocol
.Argv
);
1581 // Restore environment variables
1582 if (!IsListEmpty(&OrigEnvs
)) {
1583 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1584 ASSERT_EFI_ERROR (CleanupStatus
);
1587 FreePool (NewCmdLine
);
1593 internal worker function to load and run an image in the current shell.
1595 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1596 containing the command line. If NULL then the command-
1598 @param Environment Points to a NULL-terminated array of environment
1599 variables with the format 'x=y', where x is the
1600 environment variable name and y is the value. If this
1601 is NULL, then the current shell environment is used.
1603 @param[out] StartImageStatus Returned status from the command line.
1605 @retval EFI_SUCCESS The command executed successfully. The status code
1606 returned by the command is pointed to by StatusCode.
1607 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1608 @retval EFI_OUT_OF_RESOURCES Out of resources.
1609 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1613 InternalShellExecute(
1614 IN CONST CHAR16
*CommandLine OPTIONAL
,
1615 IN CONST CHAR16
**Environment OPTIONAL
,
1616 OUT EFI_STATUS
*StartImageStatus OPTIONAL
1620 EFI_STATUS CleanupStatus
;
1621 LIST_ENTRY OrigEnvs
;
1623 InitializeListHead(&OrigEnvs
);
1626 // Save our current environment settings for later restoration if necessary
1628 if (Environment
!= NULL
) {
1629 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1630 if (!EFI_ERROR(Status
)) {
1631 Status
= SetEnvironmentVariables(Environment
);
1637 Status
= RunShellCommand(CommandLine
, StartImageStatus
);
1639 // Restore environment variables
1640 if (!IsListEmpty(&OrigEnvs
)) {
1641 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1642 ASSERT_EFI_ERROR (CleanupStatus
);
1649 Determine if the UEFI Shell is currently running with nesting enabled or disabled.
1651 @retval FALSE nesting is required
1652 @retval other nesting is enabled
1670 if (ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoNest
) {
1673 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(mNoNestingEnvVarName
, &TempSize
, Temp
);
1674 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1675 Temp
= AllocateZeroPool(TempSize
+ sizeof(CHAR16
));
1677 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(mNoNestingEnvVarName
, &TempSize
, Temp
);
1680 Temp2
= StrnCatGrow(&Temp2
, NULL
, mNoNestingTrue
, 0);
1681 if (Temp
!= NULL
&& Temp2
!= NULL
&& StringNoCaseCompare(&Temp
, &Temp2
) == 0) {
1683 // Use the no nesting method.
1689 SHELL_FREE_NON_NULL(Temp
);
1690 SHELL_FREE_NON_NULL(Temp2
);
1695 Execute the command line.
1697 This function creates a nested instance of the shell and executes the specified
1698 command (CommandLine) with the specified environment (Environment). Upon return,
1699 the status code returned by the specified command is placed in StatusCode.
1701 If Environment is NULL, then the current environment is used and all changes made
1702 by the commands executed will be reflected in the current environment. If the
1703 Environment is non-NULL, then the changes made will be discarded.
1705 The CommandLine is executed from the current working directory on the current
1708 @param ParentImageHandle A handle of the image that is executing the specified
1710 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1711 containing the command line. If NULL then the command-
1713 @param Environment Points to a NULL-terminated array of environment
1714 variables with the format 'x=y', where x is the
1715 environment variable name and y is the value. If this
1716 is NULL, then the current shell environment is used.
1717 @param StatusCode Points to the status code returned by the CommandLine.
1719 @retval EFI_SUCCESS The command executed successfully. The status code
1720 returned by the command is pointed to by StatusCode.
1721 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1722 @retval EFI_OUT_OF_RESOURCES Out of resources.
1723 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1724 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1726 @sa InternalShellExecuteDevicePath
1731 IN EFI_HANDLE
*ParentImageHandle
,
1732 IN CHAR16
*CommandLine OPTIONAL
,
1733 IN CHAR16
**Environment OPTIONAL
,
1734 OUT EFI_STATUS
*StatusCode OPTIONAL
1739 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1742 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1743 return (EFI_UNSUPPORTED
);
1746 if (NestingEnabled()) {
1747 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1750 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1752 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1754 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1760 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1761 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1762 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1764 Status
= InternalShellExecuteDevicePath(
1768 (CONST CHAR16
**)Environment
,
1772 // de-allocate and return
1777 Status
= InternalShellExecute(
1778 (CONST CHAR16
*)CommandLine
,
1779 (CONST CHAR16
**)Environment
,
1787 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1789 1) frees all pointers (non-NULL)
1790 2) Closes the SHELL_FILE_HANDLE
1792 @param FileListNode pointer to the list node to free
1796 InternalFreeShellFileInfoNode(
1797 IN EFI_SHELL_FILE_INFO
*FileListNode
1800 if (FileListNode
->Info
!= NULL
) {
1801 FreePool((VOID
*)FileListNode
->Info
);
1803 if (FileListNode
->FileName
!= NULL
) {
1804 FreePool((VOID
*)FileListNode
->FileName
);
1806 if (FileListNode
->FullName
!= NULL
) {
1807 FreePool((VOID
*)FileListNode
->FullName
);
1809 if (FileListNode
->Handle
!= NULL
) {
1810 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1812 FreePool(FileListNode
);
1815 Frees the file list.
1817 This function cleans up the file list and any related data structures. It has no
1818 impact on the files themselves.
1820 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1821 defined in OpenFileList()
1823 @retval EFI_SUCCESS Free the file list successfully.
1824 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1828 EfiShellFreeFileList(
1829 IN EFI_SHELL_FILE_INFO
**FileList
1832 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1834 if (FileList
== NULL
|| *FileList
== NULL
) {
1835 return (EFI_INVALID_PARAMETER
);
1838 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1839 ; !IsListEmpty(&(*FileList
)->Link
)
1840 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1842 RemoveEntryList(&ShellFileListItem
->Link
);
1843 InternalFreeShellFileInfoNode(ShellFileListItem
);
1845 InternalFreeShellFileInfoNode(*FileList
);
1847 return(EFI_SUCCESS
);
1851 Deletes the duplicate file names files in the given file list.
1853 This function deletes the reduplicate files in the given file list.
1855 @param FileList A pointer to the first entry in the file list.
1857 @retval EFI_SUCCESS Always success.
1858 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1862 EfiShellRemoveDupInFileList(
1863 IN EFI_SHELL_FILE_INFO
**FileList
1866 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1867 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1868 EFI_SHELL_FILE_INFO
*TempNode
;
1870 if (FileList
== NULL
|| *FileList
== NULL
) {
1871 return (EFI_INVALID_PARAMETER
);
1873 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1874 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1875 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1877 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1878 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1879 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1881 if (gUnicodeCollation
->StriColl(
1883 (CHAR16
*)ShellFileListItem
->FullName
,
1884 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1886 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1888 &ShellFileListItem2
->Link
1890 RemoveEntryList(&ShellFileListItem2
->Link
);
1891 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1892 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1893 // memory in GetNextNode in the loop expression above.
1894 ShellFileListItem2
= TempNode
;
1898 return (EFI_SUCCESS
);
1902 // This is the same structure as the external version, but it has no CONST qualifiers.
1905 LIST_ENTRY Link
; ///< Linked list members.
1906 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1907 CHAR16
*FullName
; ///< Fully qualified filename.
1908 CHAR16
*FileName
; ///< name of this file.
1909 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1910 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1911 } EFI_SHELL_FILE_INFO_NO_CONST
;
1914 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1916 @param[in] Node The node to copy from.
1917 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1919 @retval NULL a memory allocation error ocurred
1920 @return != NULL a pointer to the new node
1922 EFI_SHELL_FILE_INFO
*
1924 InternalDuplicateShellFileInfo(
1925 IN EFI_SHELL_FILE_INFO
*Node
,
1929 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1932 // try to confirm that the objects are in sync
1934 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1936 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1937 if (NewNode
== NULL
) {
1940 NewNode
->FullName
= AllocateCopyPool(StrSize(Node
->FullName
), Node
->FullName
);
1941 NewNode
->FileName
= AllocateCopyPool(StrSize(Node
->FileName
), Node
->FileName
);
1942 NewNode
->Info
= AllocateCopyPool((UINTN
)Node
->Info
->Size
, Node
->Info
);
1943 if ( NewNode
->FullName
== NULL
1944 || NewNode
->FileName
== NULL
1945 || NewNode
->Info
== NULL
1947 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1948 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1949 SHELL_FREE_NON_NULL(NewNode
->Info
);
1950 SHELL_FREE_NON_NULL(NewNode
);
1953 NewNode
->Status
= Node
->Status
;
1954 NewNode
->Handle
= Node
->Handle
;
1956 Node
->Handle
= NULL
;
1959 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1963 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1964 failed it will return NULL.
1966 @param[in] BasePath the Path to prepend onto filename for FullPath
1967 @param[in] Status Status member initial value.
1968 @param[in] FileName FileName member initial value.
1969 @param[in] Handle Handle member initial value.
1970 @param[in] Info Info struct to copy.
1972 @retval NULL An error ocurred.
1973 @return a pointer to the newly allocated structure.
1975 EFI_SHELL_FILE_INFO
*
1977 CreateAndPopulateShellFileInfo(
1978 IN CONST CHAR16
*BasePath
,
1979 IN CONST EFI_STATUS Status
,
1980 IN CONST CHAR16
*FileName
,
1981 IN CONST SHELL_FILE_HANDLE Handle
,
1982 IN CONST EFI_FILE_INFO
*Info
1985 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1992 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1993 if (ShellFileListItem
== NULL
) {
1996 if (Info
!= NULL
&& Info
->Size
!= 0) {
1997 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1998 if (ShellFileListItem
->Info
== NULL
) {
1999 FreePool(ShellFileListItem
);
2002 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
2004 ShellFileListItem
->Info
= NULL
;
2006 if (FileName
!= NULL
) {
2007 ASSERT(TempString
== NULL
);
2008 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
2009 if (ShellFileListItem
->FileName
== NULL
) {
2010 FreePool(ShellFileListItem
->Info
);
2011 FreePool(ShellFileListItem
);
2015 ShellFileListItem
->FileName
= NULL
;
2019 if (BasePath
!= NULL
) {
2020 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2021 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2022 if (TempString
== NULL
) {
2023 FreePool((VOID
*)ShellFileListItem
->FileName
);
2024 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
2025 FreePool(ShellFileListItem
);
2029 if (ShellFileListItem
->FileName
!= NULL
) {
2030 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2031 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
2032 if (TempString
== NULL
) {
2033 FreePool((VOID
*)ShellFileListItem
->FileName
);
2034 FreePool(ShellFileListItem
->Info
);
2035 FreePool(ShellFileListItem
);
2040 TempString
= PathCleanUpDirectories(TempString
);
2042 ShellFileListItem
->FullName
= TempString
;
2043 ShellFileListItem
->Status
= Status
;
2044 ShellFileListItem
->Handle
= Handle
;
2046 return (ShellFileListItem
);
2050 Find all files in a specified directory.
2052 @param FileDirHandle Handle of the directory to search.
2053 @param FileList On return, points to the list of files in the directory
2054 or NULL if there are no files in the directory.
2056 @retval EFI_SUCCESS File information was returned successfully.
2057 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
2058 @retval EFI_DEVICE_ERROR The device reported an error.
2059 @retval EFI_NO_MEDIA The device media is not present.
2060 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
2061 @return An error from FileHandleGetFileName().
2065 EfiShellFindFilesInDir(
2066 IN SHELL_FILE_HANDLE FileDirHandle
,
2067 OUT EFI_SHELL_FILE_INFO
**FileList
2070 EFI_SHELL_FILE_INFO
*ShellFileList
;
2071 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2072 EFI_FILE_INFO
*FileInfo
;
2081 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
2082 if (EFI_ERROR(Status
)) {
2086 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
2089 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
2090 if (TempString
== NULL
) {
2091 SHELL_FREE_NON_NULL(BasePath
);
2092 return (EFI_OUT_OF_RESOURCES
);
2094 TempSpot
= StrStr(TempString
, L
";");
2096 if (TempSpot
!= NULL
) {
2097 *TempSpot
= CHAR_NULL
;
2100 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2101 if (TempString
== NULL
) {
2102 SHELL_FREE_NON_NULL(BasePath
);
2103 return (EFI_OUT_OF_RESOURCES
);
2105 SHELL_FREE_NON_NULL(BasePath
);
2106 BasePath
= TempString
;
2110 ShellFileList
= NULL
;
2111 ShellFileListItem
= NULL
;
2113 Status
= EFI_SUCCESS
;
2116 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2117 ; !EFI_ERROR(Status
) && !NoFile
2118 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2121 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2123 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2125 EFI_SUCCESS
, // success since we didnt fail to open it...
2127 NULL
, // no handle since not open
2130 if (ShellFileList
== NULL
) {
2131 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2132 ASSERT(ShellFileList
!= NULL
);
2133 InitializeListHead(&ShellFileList
->Link
);
2135 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2137 if (EFI_ERROR(Status
)) {
2138 EfiShellFreeFileList(&ShellFileList
);
2141 *FileList
= ShellFileList
;
2143 SHELL_FREE_NON_NULL(BasePath
);
2148 Get the GUID value from a human readable name.
2150 If GuidName is a known GUID name, then update Guid to have the correct value for
2153 This function is only available when the major and minor versions in the
2154 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2156 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2157 @param[out] Guid A pointer to the GUID structure to be filled in.
2159 @retval EFI_SUCCESS The operation was successful.
2160 @retval EFI_INVALID_PARAMETER Guid was NULL.
2161 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2162 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2166 EfiShellGetGuidFromName(
2167 IN CONST CHAR16
*GuidName
,
2174 if (Guid
== NULL
|| GuidName
== NULL
) {
2175 return (EFI_INVALID_PARAMETER
);
2178 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2180 if (!EFI_ERROR(Status
)) {
2181 CopyGuid(NewGuid
, Guid
);
2188 Get the human readable name for a GUID from the value.
2190 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2191 should not modify the value.
2193 This function is only available when the major and minor versions in the
2194 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2196 @param[in] Guid A pointer to the GUID being queried.
2197 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2199 @retval EFI_SUCCESS The operation was successful.
2200 @retval EFI_INVALID_PARAMETER Guid was NULL.
2201 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2202 @retval EFI_NOT_FOUND Guid is not assigned a name.
2206 EfiShellGetGuidName(
2207 IN CONST EFI_GUID
*Guid
,
2208 OUT CONST CHAR16
**GuidName
2213 if (Guid
== NULL
|| GuidName
== NULL
) {
2214 return (EFI_INVALID_PARAMETER
);
2217 Name
= GetStringNameFromGuid(Guid
, NULL
);
2218 if (Name
== NULL
|| StrLen(Name
) == 0) {
2219 SHELL_FREE_NON_NULL(Name
);
2220 return (EFI_NOT_FOUND
);
2223 *GuidName
= AddBufferToFreeList(Name
);
2225 return (EFI_SUCCESS
);
2229 Updates a file name to be preceeded by the mapped drive name
2231 @param[in] BasePath the Mapped drive name to prepend
2232 @param[in, out] Path pointer to pointer to the file name to update.
2235 @retval EFI_OUT_OF_RESOURCES
2240 IN CONST CHAR16
*BasePath
,
2241 IN OUT CHAR16
**Path
2250 ASSERT(Path
!= NULL
);
2251 ASSERT(*Path
!= NULL
);
2252 ASSERT(BasePath
!= NULL
);
2255 // convert a local path to an absolute path
2257 if (StrStr(*Path
, L
":") == NULL
) {
2258 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2259 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2260 if (Path2
== NULL
) {
2261 return (EFI_OUT_OF_RESOURCES
);
2263 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2264 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2265 if (Path2
== NULL
) {
2266 return (EFI_OUT_OF_RESOURCES
);
2273 return (EFI_SUCCESS
);
2277 If FileHandle is a directory then the function reads from FileHandle and reads in
2278 each of the FileInfo structures. If one of them matches the Pattern's first
2279 "level" then it opens that handle and calls itself on that handle.
2281 If FileHandle is a file and matches all of the remaining Pattern (which would be
2282 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2284 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2285 FreeFileList with FileList.
2287 @param[in] FilePattern The FilePattern to check against.
2288 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2289 @param[in] FileHandle The FileHandle to start with
2290 @param[in, out] FileList pointer to pointer to list of found files.
2291 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2292 @param[in] MapName The file system name this file is on.
2294 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2295 @retval EFI_NOT_FOUND no files were found
2296 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2301 IN CONST CHAR16
*FilePattern
,
2302 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2303 IN SHELL_FILE_HANDLE FileHandle
,
2304 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2305 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2306 IN CONST CHAR16
*MapName
2310 CONST CHAR16
*NextFilePatternStart
;
2311 CHAR16
*CurrentFilePattern
;
2312 EFI_SHELL_FILE_INFO
*ShellInfo
;
2313 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2314 EFI_SHELL_FILE_INFO
*NewShellNode
;
2315 EFI_FILE_INFO
*FileInfo
;
2317 CHAR16
*NewFullName
;
2320 if ( FilePattern
== NULL
2321 || UnicodeCollation
== NULL
2324 return (EFI_INVALID_PARAMETER
);
2327 CurrentFilePattern
= NULL
;
2329 if (*FilePattern
== L
'\\') {
2333 for( NextFilePatternStart
= FilePattern
2334 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2335 ; NextFilePatternStart
++);
2337 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2338 ASSERT(CurrentFilePattern
!= NULL
);
2339 StrnCpyS(CurrentFilePattern
, NextFilePatternStart
-FilePattern
+1, FilePattern
, NextFilePatternStart
-FilePattern
);
2341 if (CurrentFilePattern
[0] == CHAR_NULL
2342 &&NextFilePatternStart
[0] == CHAR_NULL
2345 // we want the parent or root node (if no parent)
2347 if (ParentNode
== NULL
) {
2349 // We want the root node. create the node.
2351 FileInfo
= FileHandleGetInfo(FileHandle
);
2352 NewShellNode
= CreateAndPopulateShellFileInfo(
2359 SHELL_FREE_NON_NULL(FileInfo
);
2362 // Add the current parameter FileHandle to the list, then end...
2364 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2366 if (NewShellNode
== NULL
) {
2367 Status
= EFI_OUT_OF_RESOURCES
;
2369 NewShellNode
->Handle
= NULL
;
2370 if (*FileList
== NULL
) {
2371 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2372 InitializeListHead(&((*FileList
)->Link
));
2376 // Add to the returning to use list
2378 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2380 Status
= EFI_SUCCESS
;
2383 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2385 if (!EFI_ERROR(Status
)){
2386 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2391 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2392 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2393 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2395 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2396 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2397 Size
= StrSize(ShellInfoNode
->FullName
);
2398 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2399 NewFullName
= AllocateZeroPool(Size
);
2400 if (NewFullName
== NULL
) {
2401 Status
= EFI_OUT_OF_RESOURCES
;
2403 StrCpyS(NewFullName
, Size
/sizeof(CHAR16
), MapName
);
2404 StrCatS(NewFullName
, Size
/sizeof(CHAR16
), ShellInfoNode
->FullName
+1);
2405 FreePool((VOID
*)ShellInfoNode
->FullName
);
2406 ShellInfoNode
->FullName
= NewFullName
;
2409 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2411 // should be a directory
2415 // don't open the . and .. directories
2417 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2418 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2423 if (EFI_ERROR(Status
)) {
2427 // Open the directory since we need that handle in the next recursion.
2429 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2432 // recurse with the next part of the pattern
2434 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2435 EfiShellClose(ShellInfoNode
->Handle
);
2436 ShellInfoNode
->Handle
= NULL
;
2438 } else if (!EFI_ERROR(Status
)) {
2444 // copy the information we need into a new Node
2446 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2447 ASSERT(NewShellNode
!= NULL
);
2448 if (NewShellNode
== NULL
) {
2449 Status
= EFI_OUT_OF_RESOURCES
;
2451 if (*FileList
== NULL
) {
2452 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2453 InitializeListHead(&((*FileList
)->Link
));
2457 // Add to the returning to use list
2459 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2462 if (EFI_ERROR(Status
)) {
2466 if (EFI_ERROR(Status
)) {
2467 EfiShellFreeFileList(&ShellInfo
);
2469 Status
= EfiShellFreeFileList(&ShellInfo
);
2474 FreePool(CurrentFilePattern
);
2479 Find files that match a specified pattern.
2481 This function searches for all files and directories that match the specified
2482 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2483 information is placed in the file list FileList.
2485 Wildcards are processed
2486 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2488 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2489 field is set to NULL.
2491 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2493 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2494 @param FileList On return, points to the start of a file list containing the names
2495 of all matching files or else points to NULL if no matching files
2496 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2498 @retval EFI_SUCCESS Files found. FileList is a valid list.
2499 @retval EFI_NOT_FOUND No files found.
2500 @retval EFI_NO_MEDIA The device has no media
2501 @retval EFI_DEVICE_ERROR The device reported an error
2502 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2507 IN CONST CHAR16
*FilePattern
,
2508 OUT EFI_SHELL_FILE_INFO
**FileList
2512 CHAR16
*PatternCopy
;
2513 CHAR16
*PatternCurrentLocation
;
2514 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2515 SHELL_FILE_HANDLE RootFileHandle
;
2519 if ( FilePattern
== NULL
2521 || StrStr(FilePattern
, L
":") == NULL
2523 return (EFI_INVALID_PARAMETER
);
2525 Status
= EFI_SUCCESS
;
2526 RootDevicePath
= NULL
;
2527 RootFileHandle
= NULL
;
2529 PatternCopy
= AllocateCopyPool(StrSize(FilePattern
), FilePattern
);
2530 if (PatternCopy
== NULL
) {
2531 return (EFI_OUT_OF_RESOURCES
);
2534 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2536 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2539 ASSERT(MapName
== NULL
);
2540 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2541 if (MapName
== NULL
) {
2542 Status
= EFI_OUT_OF_RESOURCES
;
2544 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2545 if (RootDevicePath
== NULL
) {
2546 Status
= EFI_INVALID_PARAMETER
;
2548 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2549 if (!EFI_ERROR(Status
)) {
2550 for ( PatternCurrentLocation
= PatternCopy
2551 ; *PatternCurrentLocation
!= ':'
2552 ; PatternCurrentLocation
++);
2553 PatternCurrentLocation
++;
2554 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2555 EfiShellClose(RootFileHandle
);
2557 FreePool(RootDevicePath
);
2561 SHELL_FREE_NON_NULL(PatternCopy
);
2562 SHELL_FREE_NON_NULL(MapName
);
2568 Opens the files that match the path specified.
2570 This function opens all of the files specified by Path. Wildcards are processed
2571 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2572 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2574 @param Path A pointer to the path string.
2575 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2576 EFI_FILE_MODE_WRITE.
2577 @param FileList Points to the start of a list of files opened.
2579 @retval EFI_SUCCESS Create the file list successfully.
2580 @return Others Can't create the file list.
2584 EfiShellOpenFileList(
2587 IN OUT EFI_SHELL_FILE_INFO
**FileList
2591 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2594 CONST CHAR16
*CurDir
;
2597 PathCleanUpDirectories(Path
);
2602 if (FileList
== NULL
|| *FileList
== NULL
) {
2603 return (EFI_INVALID_PARAMETER
);
2606 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2611 // convert a local path to an absolute path
2613 if (StrStr(Path
, L
":") == NULL
) {
2614 CurDir
= EfiShellGetCurDir(NULL
);
2615 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2616 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2617 StrnCatGrow(&Path2
, &Path2Size
, L
"\\", 0);
2618 if (*Path
== L
'\\') {
2620 while (PathRemoveLastItem(Path2
)) ;
2622 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2623 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2625 ASSERT(Path2
== NULL
);
2626 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2629 PathCleanUpDirectories (Path2
);
2634 Status
= EfiShellFindFiles(Path2
, FileList
);
2638 if (EFI_ERROR(Status
)) {
2644 // We had no errors so open all the files (that are not already opened...)
2646 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2647 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2648 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2650 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2651 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2657 return (EFI_NOT_FOUND
);
2659 return(EFI_SUCCESS
);
2663 Gets the environment variable and Attributes, or list of environment variables. Can be
2664 used instead of GetEnv().
2666 This function returns the current value of the specified environment variable and
2667 the Attributes. If no variable name was specified, then all of the known
2668 variables will be returned.
2670 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2671 then the function will return all of the defined shell
2672 environment variables. In the case where multiple environment
2673 variables are being returned, each variable will be terminated
2674 by a NULL, and the list will be terminated by a double NULL.
2675 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2676 the environment variable. In the case where Name is NULL, and
2677 multiple environment variables are being returned, Attributes
2680 @retval NULL The environment variable doesn't exist.
2681 @return A non-NULL value points to the variable's value. The returned
2682 pointer does not need to be freed by the caller.
2687 IN CONST CHAR16
*Name
,
2688 OUT UINT32
*Attributes OPTIONAL
2696 CHAR16
*CurrentWriteLocation
;
2703 // Get all our environment variables
2705 InitializeListHead(&List
);
2706 Status
= GetEnvironmentVariableList(&List
);
2707 if (EFI_ERROR(Status
)){
2712 // Build the semi-colon delimited list. (2 passes)
2714 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2715 ; !IsNull(&List
, &Node
->Link
)
2716 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2718 ASSERT(Node
->Key
!= NULL
);
2719 Size
+= StrSize(Node
->Key
);
2722 Size
+= 2*sizeof(CHAR16
);
2724 Buffer
= AllocateZeroPool(Size
);
2725 if (Buffer
== NULL
) {
2726 if (!IsListEmpty (&List
)) {
2727 FreeEnvironmentVariableList(&List
);
2731 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2733 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2734 ; !IsNull(&List
, &Node
->Link
)
2735 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2737 ASSERT(Node
->Key
!= NULL
);
2738 StrCpyS( CurrentWriteLocation
,
2739 (Size
)/sizeof(CHAR16
) - (CurrentWriteLocation
- ((CHAR16
*)Buffer
)),
2742 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2748 if (!IsListEmpty (&List
)) {
2749 FreeEnvironmentVariableList(&List
);
2753 // We are doing a specific environment variable
2757 // get the size we need for this EnvVariable
2759 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2760 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2762 // Allocate the space and recall the get function
2764 Buffer
= AllocateZeroPool(Size
);
2765 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2768 // we didnt get it (might not exist)
2769 // free the memory if we allocated any and return NULL
2771 if (EFI_ERROR(Status
)) {
2772 if (Buffer
!= NULL
) {
2780 // return the buffer
2782 return (AddBufferToFreeList(Buffer
));
2786 Gets either a single or list of environment variables.
2788 If name is not NULL then this function returns the current value of the specified
2789 environment variable.
2791 If Name is NULL, then a list of all environment variable names is returned. Each is a
2792 NULL terminated string with a double NULL terminating the list.
2794 @param Name A pointer to the environment variable name. If
2795 Name is NULL, then the function will return all
2796 of the defined shell environment variables. In
2797 the case where multiple environment variables are
2798 being returned, each variable will be terminated by
2799 a NULL, and the list will be terminated by a double
2802 @retval !=NULL A pointer to the returned string.
2803 The returned pointer does not need to be freed by the caller.
2805 @retval NULL The environment variable doesn't exist or there are
2806 no environment variables.
2811 IN CONST CHAR16
*Name
2814 return (EfiShellGetEnvEx(Name
, NULL
));
2818 Internal variable setting function. Allows for setting of the read only variables.
2820 @param Name Points to the NULL-terminated environment variable name.
2821 @param Value Points to the NULL-terminated environment variable value. If the value is an
2822 empty string then the environment variable is deleted.
2823 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2825 @retval EFI_SUCCESS The environment variable was successfully updated.
2829 InternalEfiShellSetEnv(
2830 IN CONST CHAR16
*Name
,
2831 IN CONST CHAR16
*Value
,
2835 if (Value
== NULL
|| StrLen(Value
) == 0) {
2836 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2838 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2840 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2842 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2848 Sets the environment variable.
2850 This function changes the current value of the specified environment variable. If the
2851 environment variable exists and the Value is an empty string, then the environment
2852 variable is deleted. If the environment variable exists and the Value is not an empty
2853 string, then the value of the environment variable is changed. If the environment
2854 variable does not exist and the Value is an empty string, there is no action. If the
2855 environment variable does not exist and the Value is a non-empty string, then the
2856 environment variable is created and assigned the specified value.
2858 For a description of volatile and non-volatile environment variables, see UEFI Shell
2859 2.0 specification section 3.6.1.
2861 @param Name Points to the NULL-terminated environment variable name.
2862 @param Value Points to the NULL-terminated environment variable value. If the value is an
2863 empty string then the environment variable is deleted.
2864 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2866 @retval EFI_SUCCESS The environment variable was successfully updated.
2871 IN CONST CHAR16
*Name
,
2872 IN CONST CHAR16
*Value
,
2876 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2877 return (EFI_INVALID_PARAMETER
);
2880 // Make sure we dont 'set' a predefined read only variable
2882 if (gUnicodeCollation
->StriColl(
2886 ||gUnicodeCollation
->StriColl(
2890 ||gUnicodeCollation
->StriColl(
2894 ||gUnicodeCollation
->StriColl(
2897 L
"uefishellsupport") == 0
2898 ||gUnicodeCollation
->StriColl(
2901 L
"uefishellversion") == 0
2902 ||gUnicodeCollation
->StriColl(
2905 L
"uefiversion") == 0
2906 ||(!ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoNest
&&
2907 gUnicodeCollation
->StriColl(
2910 (CHAR16
*)mNoNestingEnvVarName
) == 0)
2912 return (EFI_INVALID_PARAMETER
);
2914 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2918 Returns the current directory on the specified device.
2920 If FileSystemMapping is NULL, it returns the current working directory. If the
2921 FileSystemMapping is not NULL, it returns the current directory associated with the
2922 FileSystemMapping. In both cases, the returned name includes the file system
2923 mapping (i.e. fs0:\current-dir).
2925 Note that the current directory string should exclude the tailing backslash character.
2927 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2928 then the current working directory is returned.
2930 @retval !=NULL The current directory.
2931 @retval NULL Current directory does not exist.
2936 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2939 CHAR16
*PathToReturn
;
2941 SHELL_MAP_LIST
*MapListItem
;
2942 if (!IsListEmpty(&gShellMapList
.Link
)) {
2944 // if parameter is NULL, use current
2946 if (FileSystemMapping
== NULL
) {
2947 return (EfiShellGetEnv(L
"cwd"));
2950 PathToReturn
= NULL
;
2951 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2952 if (MapListItem
!= NULL
) {
2953 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2954 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2955 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2958 return (AddBufferToFreeList(PathToReturn
));
2965 Changes the current directory on the specified device.
2967 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2968 mapped name, this function changes the current working directory.
2970 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2971 current file system and the current directory on that file system are changed.
2973 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2976 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2977 directory on the specified file system.
2979 If the current working directory or the current working file system is changed then the
2980 %cwd% environment variable will be updated
2982 Note that the current directory string should exclude the tailing backslash character.
2984 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2985 directory is changed.
2986 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2988 @retval EFI_SUCCESS The operation was sucessful
2989 @retval EFI_NOT_FOUND The file system could not be found
2994 IN CONST CHAR16
*FileSystem OPTIONAL
,
2995 IN CONST CHAR16
*Dir
2999 SHELL_MAP_LIST
*MapListItem
;
3003 CHAR16
*DirectoryName
;
3010 DirectoryName
= NULL
;
3012 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
3013 return (EFI_INVALID_PARAMETER
);
3016 if (IsListEmpty(&gShellMapList
.Link
)){
3017 return (EFI_NOT_FOUND
);
3020 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
3021 ASSERT(DirectoryName
!= NULL
);
3023 PathCleanUpDirectories(DirectoryName
);
3025 if (FileSystem
== NULL
) {
3027 // determine the file system mapping to use
3029 if (StrStr(DirectoryName
, L
":") != NULL
) {
3030 ASSERT(MapName
== NULL
);
3031 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
3034 // find the file system mapping's entry in the list
3037 if (MapName
!= NULL
) {
3038 MapListItem
= ShellCommandFindMapItem(MapName
);
3041 // make that the current file system mapping
3043 if (MapListItem
!= NULL
) {
3044 gShellCurDir
= MapListItem
;
3047 MapListItem
= gShellCurDir
;
3050 if (MapListItem
== NULL
) {
3051 FreePool (DirectoryName
);
3052 SHELL_FREE_NON_NULL(MapName
);
3053 return (EFI_NOT_FOUND
);
3057 // now update the MapListItem's current directory
3059 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
3060 FreePool(MapListItem
->CurrentDirectoryPath
);
3061 MapListItem
->CurrentDirectoryPath
= NULL
;
3063 if (MapName
!= NULL
) {
3064 TempLen
= StrLen(MapName
);
3065 if (TempLen
!= StrLen(DirectoryName
)) {
3066 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3067 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
3071 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3072 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3074 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
3075 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3076 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
3077 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
3082 // cant have a mapping in the directory...
3084 if (StrStr(DirectoryName
, L
":") != NULL
) {
3085 FreePool (DirectoryName
);
3086 return (EFI_INVALID_PARAMETER
);
3089 // FileSystem != NULL
3091 MapListItem
= ShellCommandFindMapItem(FileSystem
);
3092 if (MapListItem
== NULL
) {
3093 FreePool (DirectoryName
);
3094 return (EFI_INVALID_PARAMETER
);
3096 // gShellCurDir = MapListItem;
3097 if (DirectoryName
!= NULL
) {
3099 // change current dir on that file system
3102 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
3103 FreePool(MapListItem
->CurrentDirectoryPath
);
3104 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
3106 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3107 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
3108 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3109 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3110 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3111 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3112 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') {
3113 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3114 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
3118 FreePool (DirectoryName
);
3120 // if updated the current directory then update the environment variable
3122 if (MapListItem
== gShellCurDir
) {
3124 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3125 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3126 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3127 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3128 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3129 FreePool(TempString
);
3132 return(EFI_SUCCESS
);
3136 Return help information about a specific command.
3138 This function returns the help information for the specified command. The help text
3139 can be internal to the shell or can be from a UEFI Shell manual page.
3141 If Sections is specified, then each section name listed will be compared in a casesensitive
3142 manner, to the section names described in Appendix B. If the section exists,
3143 it will be appended to the returned help text. If the section does not exist, no
3144 information will be returned. If Sections is NULL, then all help text information
3145 available will be returned.
3147 @param Command Points to the NULL-terminated UEFI Shell command name.
3148 @param Sections Points to the NULL-terminated comma-delimited
3149 section names to return. If NULL, then all
3150 sections will be returned.
3151 @param HelpText On return, points to a callee-allocated buffer
3152 containing all specified help text.
3154 @retval EFI_SUCCESS The help text was returned.
3155 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3157 @retval EFI_INVALID_PARAMETER HelpText is NULL
3158 @retval EFI_NOT_FOUND There is no help text available for Command.
3162 EfiShellGetHelpText(
3163 IN CONST CHAR16
*Command
,
3164 IN CONST CHAR16
*Sections OPTIONAL
,
3165 OUT CHAR16
**HelpText
3168 CONST CHAR16
*ManFileName
;
3172 ASSERT(HelpText
!= NULL
);
3175 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3177 if (ManFileName
!= NULL
) {
3178 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3180 if ((StrLen(Command
)> 4)
3181 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3182 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3183 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3184 && (Command
[StrLen(Command
)-4] == L
'.')
3186 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3187 ASSERT(FixCommand
!= NULL
);
3189 StrnCpyS( FixCommand
,
3190 (StrSize(Command
) - 4 * sizeof (CHAR16
))/sizeof(CHAR16
),
3194 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3195 FreePool(FixCommand
);
3198 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3204 Gets the enable status of the page break output mode.
3206 User can use this function to determine current page break mode.
3208 @retval TRUE The page break output mode is enabled.
3209 @retval FALSE The page break output mode is disabled.
3213 EfiShellGetPageBreak(
3217 return(ShellInfoObject
.PageBreakEnabled
);
3221 Judges whether the active shell is the root shell.
3223 This function makes the user to know that whether the active Shell is the root shell.
3225 @retval TRUE The active Shell is the root Shell.
3226 @retval FALSE The active Shell is NOT the root Shell.
3230 EfiShellIsRootShell(
3234 return(ShellInfoObject
.RootShellInstance
);
3238 function to return a semi-colon delimeted list of all alias' in the current shell
3240 up to caller to free the memory.
3242 @retval NULL No alias' were found
3243 @retval NULL An error ocurred getting alias'
3244 @return !NULL a list of all alias'
3248 InternalEfiShellGetListAlias(
3254 CHAR16
*VariableName
;
3256 UINTN NameBufferSize
;
3260 NameBufferSize
= INIT_NAME_BUFFER_SIZE
;
3261 VariableName
= AllocateZeroPool(NameBufferSize
);
3265 if (VariableName
== NULL
) {
3269 VariableName
[0] = CHAR_NULL
;
3272 NameSize
= NameBufferSize
;
3273 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3274 if (Status
== EFI_NOT_FOUND
){
3276 } else if (Status
== EFI_BUFFER_TOO_SMALL
) {
3277 NameBufferSize
= NameSize
> NameBufferSize
* 2 ? NameSize
: NameBufferSize
* 2;
3278 SHELL_FREE_NON_NULL(VariableName
);
3279 VariableName
= AllocateZeroPool(NameBufferSize
);
3280 if (VariableName
== NULL
) {
3281 Status
= EFI_OUT_OF_RESOURCES
;
3282 SHELL_FREE_NON_NULL(RetVal
);
3287 NameSize
= NameBufferSize
;
3288 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3291 if (EFI_ERROR (Status
)) {
3292 SHELL_FREE_NON_NULL(RetVal
);
3297 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3298 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3299 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3300 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3303 SHELL_FREE_NON_NULL(VariableName
);
3309 Convert a null-terminated unicode string, in-place, to all lowercase.
3312 @param Str The null-terminated string to be converted to all lowercase.
3314 @return The null-terminated string converted into all lowercase.
3323 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3324 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3325 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3332 This function returns the command associated with a alias or a list of all
3335 @param[in] Alias Points to the NULL-terminated shell alias.
3336 If this parameter is NULL, then all
3337 aliases will be returned in ReturnedData.
3338 @param[out] Volatile upon return of a single command if TRUE indicates
3339 this is stored in a volatile fashion. FALSE otherwise.
3341 @return If Alias is not NULL, it will return a pointer to
3342 the NULL-terminated command for that alias.
3343 If Alias is NULL, ReturnedData points to a ';'
3344 delimited list of alias (e.g.
3345 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3346 @retval NULL an error ocurred
3347 @retval NULL Alias was not a valid Alias
3352 IN CONST CHAR16
*Alias
,
3353 OUT BOOLEAN
*Volatile OPTIONAL
3363 // Convert to lowercase to make aliases case-insensitive
3364 if (Alias
!= NULL
) {
3365 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3366 ASSERT (AliasLower
!= NULL
);
3367 ToLower (AliasLower
);
3369 if (Volatile
== NULL
) {
3370 GetVariable2 (AliasLower
, &gShellAliasGuid
, (VOID
**)&AliasVal
, NULL
);
3371 FreePool(AliasLower
);
3372 return (AddBufferToFreeList(AliasVal
));
3376 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3377 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3378 RetVal
= AllocateZeroPool(RetSize
);
3379 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3381 if (EFI_ERROR(Status
)) {
3382 if (RetVal
!= NULL
) {
3385 FreePool(AliasLower
);
3388 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3394 FreePool (AliasLower
);
3395 return (AddBufferToFreeList(RetVal
));
3397 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3401 Changes a shell command alias.
3403 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3405 this function does not check for built in alias'.
3407 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3408 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3409 Command refers to an alias, that alias will be deleted.
3410 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3411 Alias being set will be stored in a non-volatile fashion.
3413 @retval EFI_SUCCESS Alias created or deleted successfully.
3414 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3419 IN CONST CHAR16
*Command
,
3420 IN CONST CHAR16
*Alias
,
3427 // Convert to lowercase to make aliases case-insensitive
3428 if (Alias
!= NULL
) {
3429 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3430 ASSERT (AliasLower
!= NULL
);
3431 ToLower (AliasLower
);
3437 // We must be trying to remove one if Alias is NULL
3439 if (Alias
== NULL
) {
3441 // remove an alias (but passed in COMMAND parameter)
3443 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3446 // Add and replace are the same
3449 // We dont check the error return on purpose since the variable may not exist.
3450 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3452 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3455 if (Alias
!= NULL
) {
3456 FreePool (AliasLower
);
3462 Changes a shell command alias.
3464 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3467 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3468 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3469 Command refers to an alias, that alias will be deleted.
3470 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3471 FALSE and the alias already exists, then the existing alias is unchanged and
3472 EFI_ACCESS_DENIED is returned.
3473 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3474 Alias being set will be stored in a non-volatile fashion.
3476 @retval EFI_SUCCESS Alias created or deleted successfully.
3477 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3478 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3480 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3485 IN CONST CHAR16
*Command
,
3486 IN CONST CHAR16
*Alias
,
3491 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3493 // cant set over a built in alias
3495 return (EFI_ACCESS_DENIED
);
3496 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3498 // Command is null or empty
3500 return (EFI_INVALID_PARAMETER
);
3501 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3503 // Alias already exists, Replace not set
3505 return (EFI_ACCESS_DENIED
);
3507 return (InternalSetAlias(Command
, Alias
, Volatile
));
3511 // Pure FILE_HANDLE operations are passed to FileHandleLib
3512 // these functions are indicated by the *
3513 EFI_SHELL_PROTOCOL mShellProtocol
= {
3519 EfiShellGetHelpText
,
3520 EfiShellGetDevicePathFromMap
,
3521 EfiShellGetMapFromDevicePath
,
3522 EfiShellGetDevicePathFromFilePath
,
3523 EfiShellGetFilePathFromDevicePath
,
3527 EfiShellOpenFileList
,
3528 EfiShellFreeFileList
,
3529 EfiShellRemoveDupInFileList
,
3530 EfiShellBatchIsActive
,
3531 EfiShellIsRootShell
,
3532 EfiShellEnablePageBreak
,
3533 EfiShellDisablePageBreak
,
3534 EfiShellGetPageBreak
,
3535 EfiShellGetDeviceName
,
3536 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3537 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3538 EfiShellOpenFileByName
,
3541 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3542 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3543 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3544 EfiShellDeleteFileByName
,
3545 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3546 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3547 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3549 EfiShellFindFilesInDir
,
3550 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3552 EfiShellOpenRootByHandle
,
3554 SHELL_MAJOR_VERSION
,
3555 SHELL_MINOR_VERSION
,
3557 // New for UEFI Shell 2.1
3558 EfiShellRegisterGuidName
,
3559 EfiShellGetGuidName
,
3560 EfiShellGetGuidFromName
,
3565 Function to create and install on the current handle.
3567 Will overwrite any existing ShellProtocols in the system to be sure that
3568 the current shell is in control.
3570 This must be removed via calling CleanUpShellProtocol().
3572 @param[in, out] NewShell The pointer to the pointer to the structure
3575 @retval EFI_SUCCESS The operation was successful.
3576 @return An error from LocateHandle, CreateEvent, or other core function.
3580 CreatePopulateInstallShellProtocol (
3581 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3587 UINTN HandleCounter
;
3588 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3590 if (NewShell
== NULL
) {
3591 return (EFI_INVALID_PARAMETER
);
3596 OldProtocolNode
= NULL
;
3597 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3600 // Initialize EfiShellProtocol object...
3602 Status
= gBS
->CreateEvent(0,
3606 &mShellProtocol
.ExecutionBreak
);
3607 if (EFI_ERROR(Status
)) {
3612 // Get the size of the buffer we need.
3614 Status
= gBS
->LocateHandle(ByProtocol
,
3615 &gEfiShellProtocolGuid
,
3619 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3621 // Allocate and recall with buffer of correct size
3623 Buffer
= AllocateZeroPool(BufferSize
);
3624 if (Buffer
== NULL
) {
3625 return (EFI_OUT_OF_RESOURCES
);
3627 Status
= gBS
->LocateHandle(ByProtocol
,
3628 &gEfiShellProtocolGuid
,
3632 if (EFI_ERROR(Status
)) {
3637 // now overwrite each of them, but save the info to restore when we end.
3639 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3640 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3641 ASSERT(OldProtocolNode
!= NULL
);
3642 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3643 &gEfiShellProtocolGuid
,
3644 (VOID
**) &(OldProtocolNode
->Interface
),
3647 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3649 if (!EFI_ERROR(Status
)) {
3651 // reinstall over the old one...
3653 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3654 Status
= gBS
->ReinstallProtocolInterface(
3655 OldProtocolNode
->Handle
,
3656 &gEfiShellProtocolGuid
,
3657 OldProtocolNode
->Interface
,
3658 (VOID
*)(&mShellProtocol
));
3659 if (!EFI_ERROR(Status
)) {
3661 // we reinstalled sucessfully. log this so we can reverse it later.
3665 // add to the list for subsequent...
3667 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3672 } else if (Status
== EFI_NOT_FOUND
) {
3673 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3675 // no one else published yet. just publish it ourselves.
3677 Status
= gBS
->InstallProtocolInterface (
3679 &gEfiShellProtocolGuid
,
3680 EFI_NATIVE_INTERFACE
,
3681 (VOID
*)(&mShellProtocol
));
3684 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3685 ///@todo support ShellEnvironment2
3686 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3689 if (!EFI_ERROR(Status
)) {
3690 *NewShell
= &mShellProtocol
;
3696 Opposite of CreatePopulateInstallShellProtocol.
3698 Free all memory and restore the system to the state it was in before calling
3699 CreatePopulateInstallShellProtocol.
3701 @param[in, out] NewShell The pointer to the new shell protocol structure.
3703 @retval EFI_SUCCESS The operation was successful.
3707 CleanUpShellProtocol (
3708 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3712 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3713 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3716 // if we need to restore old protocols...
3718 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3719 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3720 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3721 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3723 RemoveEntryList(&Node2
->Link
);
3724 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3725 &gEfiShellProtocolGuid
,
3732 // no need to restore
3734 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3735 &gEfiShellProtocolGuid
,
3738 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3739 NewShell
->ExecutionBreak
= NULL
;
3741 Status
= gBS
->OpenProtocol(
3742 gST
->ConsoleInHandle
,
3743 &gEfiSimpleTextInputExProtocolGuid
,
3747 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3749 if (!EFI_ERROR (Status
)) {
3750 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3751 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3752 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3753 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3754 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3755 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3756 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3757 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3763 Notification function for keystrokes.
3765 @param[in] KeyData The key that was pressed.
3767 @retval EFI_SUCCESS The operation was successful.
3771 NotificationFunction(
3772 IN EFI_KEY_DATA
*KeyData
3775 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3776 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3777 (KeyData
->Key
.UnicodeChar
== 3)
3779 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3780 return (EFI_UNSUPPORTED
);
3782 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3783 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3784 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3786 ShellInfoObject
.HaltOutput
= TRUE
;
3788 return (EFI_SUCCESS
);
3792 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3793 feature's enabled state was not known when the shell initially launched.
3795 @retval EFI_SUCCESS The feature is enabled.
3796 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3800 InernalEfiShellStartMonitor(
3804 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3805 EFI_KEY_DATA KeyData
;
3808 Status
= gBS
->OpenProtocol(
3809 gST
->ConsoleInHandle
,
3810 &gEfiSimpleTextInputExProtocolGuid
,
3814 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3815 if (EFI_ERROR(Status
)) {
3820 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3821 ShellInfoObject
.HiiHandle
);
3822 return (EFI_SUCCESS
);
3825 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3826 return (EFI_UNSUPPORTED
);
3829 KeyData
.KeyState
.KeyToggleState
= 0;
3830 KeyData
.Key
.ScanCode
= 0;
3831 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3832 KeyData
.Key
.UnicodeChar
= L
'c';
3834 Status
= SimpleEx
->RegisterKeyNotify(
3837 NotificationFunction
,
3838 &ShellInfoObject
.CtrlCNotifyHandle1
);
3840 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3841 if (!EFI_ERROR(Status
)) {
3842 Status
= SimpleEx
->RegisterKeyNotify(
3845 NotificationFunction
,
3846 &ShellInfoObject
.CtrlCNotifyHandle2
);
3848 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3849 KeyData
.Key
.UnicodeChar
= 3;
3850 if (!EFI_ERROR(Status
)) {
3851 Status
= SimpleEx
->RegisterKeyNotify(
3854 NotificationFunction
,
3855 &ShellInfoObject
.CtrlCNotifyHandle3
);
3857 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3858 if (!EFI_ERROR(Status
)) {
3859 Status
= SimpleEx
->RegisterKeyNotify(
3862 NotificationFunction
,
3863 &ShellInfoObject
.CtrlCNotifyHandle4
);