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
);
1444 ZeroMem(&ShellParamsProtocol
, sizeof(EFI_SHELL_PARAMETERS_PROTOCOL
));
1448 NewCmdLine
= AllocateCopyPool (StrSize (CommandLine
), CommandLine
);
1449 if (NewCmdLine
== NULL
) {
1450 return EFI_OUT_OF_RESOURCES
;
1453 for (Walker
= NewCmdLine
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
1454 if (*Walker
== L
'^' && *(Walker
+1) == L
'#') {
1455 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));
1460 // Load the image with:
1461 // FALSE - not from boot manager and NULL, 0 being not already in memory
1463 Status
= gBS
->LoadImage(
1466 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1471 if (EFI_ERROR(Status
)) {
1472 if (NewHandle
!= NULL
) {
1473 gBS
->UnloadImage(NewHandle
);
1475 FreePool (NewCmdLine
);
1478 Status
= gBS
->OpenProtocol(
1480 &gEfiLoadedImageProtocolGuid
,
1481 (VOID
**)&LoadedImage
,
1484 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1486 if (!EFI_ERROR(Status
)) {
1488 // If the image is not an app abort it.
1490 if (LoadedImage
->ImageCodeType
!= EfiLoaderCode
){
1495 STRING_TOKEN (STR_SHELL_IMAGE_NOT_APP
),
1496 ShellInfoObject
.HiiHandle
1501 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1502 if (NewCmdLine
!= NULL
) {
1503 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(NewCmdLine
);
1504 LoadedImage
->LoadOptions
= (VOID
*)NewCmdLine
;
1508 // Save our current environment settings for later restoration if necessary
1510 if (Environment
!= NULL
) {
1511 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1512 if (!EFI_ERROR(Status
)) {
1513 Status
= SetEnvironmentVariables(Environment
);
1518 // Initialize and install a shell parameters protocol on the image.
1520 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1521 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1522 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1523 Status
= UpdateArgcArgv(&ShellParamsProtocol
, NewCmdLine
, Efi_Application
, NULL
, NULL
);
1524 ASSERT_EFI_ERROR(Status
);
1526 // Replace Argv[0] with the full path of the binary we're executing:
1527 // If the command line was "foo", the binary might be called "foo.efi".
1528 // "The first entry in [Argv] is always the full file path of the
1529 // executable" - UEFI Shell Spec section 2.3
1531 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1532 // The image we're executing isn't necessarily in a filesystem - it might
1533 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1534 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1535 if (ImagePath
!= NULL
) {
1536 if (ShellParamsProtocol
.Argv
== NULL
) {
1537 // Command line was empty or null.
1538 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1539 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1540 if (ShellParamsProtocol
.Argv
== NULL
) {
1541 Status
= EFI_OUT_OF_RESOURCES
;
1544 ShellParamsProtocol
.Argc
= 1;
1546 // Free the string UpdateArgcArgv put in Argv[0];
1547 FreePool (ShellParamsProtocol
.Argv
[0]);
1549 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1552 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1553 ASSERT_EFI_ERROR(Status
);
1555 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1558 // now start the image and if the caller wanted the return code pass it to them...
1560 if (!EFI_ERROR(Status
)) {
1561 StartStatus
= gBS
->StartImage(
1566 if (StartImageStatus
!= NULL
) {
1567 *StartImageStatus
= StartStatus
;
1570 CleanupStatus
= gBS
->UninstallProtocolInterface(
1572 &gEfiShellParametersProtocolGuid
,
1573 &ShellParamsProtocol
1575 ASSERT_EFI_ERROR(CleanupStatus
);
1581 // Unload image - We should only get here if we didn't call StartImage
1582 gBS
->UnloadImage (NewHandle
);
1585 // Free Argv (Allocated in UpdateArgcArgv)
1586 if (ShellParamsProtocol
.Argv
!= NULL
) {
1587 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1588 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1589 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1592 FreePool (ShellParamsProtocol
.Argv
);
1596 // Restore environment variables
1597 if (!IsListEmpty(&OrigEnvs
)) {
1598 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1599 ASSERT_EFI_ERROR (CleanupStatus
);
1602 FreePool (NewCmdLine
);
1608 internal worker function to load and run an image in the current shell.
1610 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1611 containing the command line. If NULL then the command-
1613 @param Environment Points to a NULL-terminated array of environment
1614 variables with the format 'x=y', where x is the
1615 environment variable name and y is the value. If this
1616 is NULL, then the current shell environment is used.
1618 @param[out] StartImageStatus Returned status from the command line.
1620 @retval EFI_SUCCESS The command executed successfully. The status code
1621 returned by the command is pointed to by StatusCode.
1622 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1623 @retval EFI_OUT_OF_RESOURCES Out of resources.
1624 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1628 InternalShellExecute(
1629 IN CONST CHAR16
*CommandLine OPTIONAL
,
1630 IN CONST CHAR16
**Environment OPTIONAL
,
1631 OUT EFI_STATUS
*StartImageStatus OPTIONAL
1635 EFI_STATUS CleanupStatus
;
1636 LIST_ENTRY OrigEnvs
;
1638 InitializeListHead(&OrigEnvs
);
1641 // Save our current environment settings for later restoration if necessary
1643 if (Environment
!= NULL
) {
1644 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1645 if (!EFI_ERROR(Status
)) {
1646 Status
= SetEnvironmentVariables(Environment
);
1652 Status
= RunShellCommand(CommandLine
, StartImageStatus
);
1654 // Restore environment variables
1655 if (!IsListEmpty(&OrigEnvs
)) {
1656 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1657 ASSERT_EFI_ERROR (CleanupStatus
);
1664 Determine if the UEFI Shell is currently running with nesting enabled or disabled.
1666 @retval FALSE nesting is required
1667 @retval other nesting is enabled
1685 if (ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoNest
) {
1688 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(mNoNestingEnvVarName
, &TempSize
, Temp
);
1689 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1690 Temp
= AllocateZeroPool(TempSize
+ sizeof(CHAR16
));
1692 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(mNoNestingEnvVarName
, &TempSize
, Temp
);
1695 Temp2
= StrnCatGrow(&Temp2
, NULL
, mNoNestingTrue
, 0);
1696 if (Temp
!= NULL
&& Temp2
!= NULL
&& StringNoCaseCompare(&Temp
, &Temp2
) == 0) {
1698 // Use the no nesting method.
1704 SHELL_FREE_NON_NULL(Temp
);
1705 SHELL_FREE_NON_NULL(Temp2
);
1710 Execute the command line.
1712 This function creates a nested instance of the shell and executes the specified
1713 command (CommandLine) with the specified environment (Environment). Upon return,
1714 the status code returned by the specified command is placed in StatusCode.
1716 If Environment is NULL, then the current environment is used and all changes made
1717 by the commands executed will be reflected in the current environment. If the
1718 Environment is non-NULL, then the changes made will be discarded.
1720 The CommandLine is executed from the current working directory on the current
1723 @param ParentImageHandle A handle of the image that is executing the specified
1725 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1726 containing the command line. If NULL then the command-
1728 @param Environment Points to a NULL-terminated array of environment
1729 variables with the format 'x=y', where x is the
1730 environment variable name and y is the value. If this
1731 is NULL, then the current shell environment is used.
1732 @param StatusCode Points to the status code returned by the CommandLine.
1734 @retval EFI_SUCCESS The command executed successfully. The status code
1735 returned by the command is pointed to by StatusCode.
1736 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1737 @retval EFI_OUT_OF_RESOURCES Out of resources.
1738 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1739 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1741 @sa InternalShellExecuteDevicePath
1746 IN EFI_HANDLE
*ParentImageHandle
,
1747 IN CHAR16
*CommandLine OPTIONAL
,
1748 IN CHAR16
**Environment OPTIONAL
,
1749 OUT EFI_STATUS
*StatusCode OPTIONAL
1754 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1757 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1758 return (EFI_UNSUPPORTED
);
1761 if (NestingEnabled()) {
1762 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1765 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1767 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1769 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1775 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1776 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1777 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1779 Status
= InternalShellExecuteDevicePath(
1783 (CONST CHAR16
**)Environment
,
1787 // de-allocate and return
1792 Status
= InternalShellExecute(
1793 (CONST CHAR16
*)CommandLine
,
1794 (CONST CHAR16
**)Environment
,
1802 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1804 1) frees all pointers (non-NULL)
1805 2) Closes the SHELL_FILE_HANDLE
1807 @param FileListNode pointer to the list node to free
1811 InternalFreeShellFileInfoNode(
1812 IN EFI_SHELL_FILE_INFO
*FileListNode
1815 if (FileListNode
->Info
!= NULL
) {
1816 FreePool((VOID
*)FileListNode
->Info
);
1818 if (FileListNode
->FileName
!= NULL
) {
1819 FreePool((VOID
*)FileListNode
->FileName
);
1821 if (FileListNode
->FullName
!= NULL
) {
1822 FreePool((VOID
*)FileListNode
->FullName
);
1824 if (FileListNode
->Handle
!= NULL
) {
1825 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1827 FreePool(FileListNode
);
1830 Frees the file list.
1832 This function cleans up the file list and any related data structures. It has no
1833 impact on the files themselves.
1835 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1836 defined in OpenFileList()
1838 @retval EFI_SUCCESS Free the file list successfully.
1839 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1843 EfiShellFreeFileList(
1844 IN EFI_SHELL_FILE_INFO
**FileList
1847 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1849 if (FileList
== NULL
|| *FileList
== NULL
) {
1850 return (EFI_INVALID_PARAMETER
);
1853 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1854 ; !IsListEmpty(&(*FileList
)->Link
)
1855 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1857 RemoveEntryList(&ShellFileListItem
->Link
);
1858 InternalFreeShellFileInfoNode(ShellFileListItem
);
1860 InternalFreeShellFileInfoNode(*FileList
);
1862 return(EFI_SUCCESS
);
1866 Deletes the duplicate file names files in the given file list.
1868 This function deletes the reduplicate files in the given file list.
1870 @param FileList A pointer to the first entry in the file list.
1872 @retval EFI_SUCCESS Always success.
1873 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1877 EfiShellRemoveDupInFileList(
1878 IN EFI_SHELL_FILE_INFO
**FileList
1881 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1882 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1883 EFI_SHELL_FILE_INFO
*TempNode
;
1885 if (FileList
== NULL
|| *FileList
== NULL
) {
1886 return (EFI_INVALID_PARAMETER
);
1888 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1889 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1890 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1892 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1893 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1894 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1896 if (gUnicodeCollation
->StriColl(
1898 (CHAR16
*)ShellFileListItem
->FullName
,
1899 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1901 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1903 &ShellFileListItem2
->Link
1905 RemoveEntryList(&ShellFileListItem2
->Link
);
1906 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1907 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1908 // memory in GetNextNode in the loop expression above.
1909 ShellFileListItem2
= TempNode
;
1913 return (EFI_SUCCESS
);
1917 // This is the same structure as the external version, but it has no CONST qualifiers.
1920 LIST_ENTRY Link
; ///< Linked list members.
1921 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1922 CHAR16
*FullName
; ///< Fully qualified filename.
1923 CHAR16
*FileName
; ///< name of this file.
1924 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1925 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1926 } EFI_SHELL_FILE_INFO_NO_CONST
;
1929 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1931 @param[in] Node The node to copy from.
1932 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1934 @retval NULL a memory allocation error ocurred
1935 @return != NULL a pointer to the new node
1937 EFI_SHELL_FILE_INFO
*
1939 InternalDuplicateShellFileInfo(
1940 IN EFI_SHELL_FILE_INFO
*Node
,
1944 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1947 // try to confirm that the objects are in sync
1949 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1951 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1952 if (NewNode
== NULL
) {
1955 NewNode
->FullName
= AllocateCopyPool(StrSize(Node
->FullName
), Node
->FullName
);
1956 NewNode
->FileName
= AllocateCopyPool(StrSize(Node
->FileName
), Node
->FileName
);
1957 NewNode
->Info
= AllocateCopyPool((UINTN
)Node
->Info
->Size
, Node
->Info
);
1958 if ( NewNode
->FullName
== NULL
1959 || NewNode
->FileName
== NULL
1960 || NewNode
->Info
== NULL
1962 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1963 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1964 SHELL_FREE_NON_NULL(NewNode
->Info
);
1965 SHELL_FREE_NON_NULL(NewNode
);
1968 NewNode
->Status
= Node
->Status
;
1969 NewNode
->Handle
= Node
->Handle
;
1971 Node
->Handle
= NULL
;
1974 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1978 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1979 failed it will return NULL.
1981 @param[in] BasePath the Path to prepend onto filename for FullPath
1982 @param[in] Status Status member initial value.
1983 @param[in] FileName FileName member initial value.
1984 @param[in] Handle Handle member initial value.
1985 @param[in] Info Info struct to copy.
1987 @retval NULL An error ocurred.
1988 @return a pointer to the newly allocated structure.
1990 EFI_SHELL_FILE_INFO
*
1992 CreateAndPopulateShellFileInfo(
1993 IN CONST CHAR16
*BasePath
,
1994 IN CONST EFI_STATUS Status
,
1995 IN CONST CHAR16
*FileName
,
1996 IN CONST SHELL_FILE_HANDLE Handle
,
1997 IN CONST EFI_FILE_INFO
*Info
2000 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2007 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2008 if (ShellFileListItem
== NULL
) {
2011 if (Info
!= NULL
&& Info
->Size
!= 0) {
2012 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
2013 if (ShellFileListItem
->Info
== NULL
) {
2014 FreePool(ShellFileListItem
);
2017 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
2019 ShellFileListItem
->Info
= NULL
;
2021 if (FileName
!= NULL
) {
2022 ASSERT(TempString
== NULL
);
2023 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
2024 if (ShellFileListItem
->FileName
== NULL
) {
2025 FreePool(ShellFileListItem
->Info
);
2026 FreePool(ShellFileListItem
);
2030 ShellFileListItem
->FileName
= NULL
;
2034 if (BasePath
!= NULL
) {
2035 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2036 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2037 if (TempString
== NULL
) {
2038 FreePool((VOID
*)ShellFileListItem
->FileName
);
2039 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
2040 FreePool(ShellFileListItem
);
2044 if (ShellFileListItem
->FileName
!= NULL
) {
2045 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2046 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
2047 if (TempString
== NULL
) {
2048 FreePool((VOID
*)ShellFileListItem
->FileName
);
2049 FreePool(ShellFileListItem
->Info
);
2050 FreePool(ShellFileListItem
);
2055 TempString
= PathCleanUpDirectories(TempString
);
2057 ShellFileListItem
->FullName
= TempString
;
2058 ShellFileListItem
->Status
= Status
;
2059 ShellFileListItem
->Handle
= Handle
;
2061 return (ShellFileListItem
);
2065 Find all files in a specified directory.
2067 @param FileDirHandle Handle of the directory to search.
2068 @param FileList On return, points to the list of files in the directory
2069 or NULL if there are no files in the directory.
2071 @retval EFI_SUCCESS File information was returned successfully.
2072 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
2073 @retval EFI_DEVICE_ERROR The device reported an error.
2074 @retval EFI_NO_MEDIA The device media is not present.
2075 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
2076 @return An error from FileHandleGetFileName().
2080 EfiShellFindFilesInDir(
2081 IN SHELL_FILE_HANDLE FileDirHandle
,
2082 OUT EFI_SHELL_FILE_INFO
**FileList
2085 EFI_SHELL_FILE_INFO
*ShellFileList
;
2086 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2087 EFI_FILE_INFO
*FileInfo
;
2096 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
2097 if (EFI_ERROR(Status
)) {
2101 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
2104 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
2105 if (TempString
== NULL
) {
2106 SHELL_FREE_NON_NULL(BasePath
);
2107 return (EFI_OUT_OF_RESOURCES
);
2109 TempSpot
= StrStr(TempString
, L
";");
2111 if (TempSpot
!= NULL
) {
2112 *TempSpot
= CHAR_NULL
;
2115 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2116 if (TempString
== NULL
) {
2117 SHELL_FREE_NON_NULL(BasePath
);
2118 return (EFI_OUT_OF_RESOURCES
);
2120 SHELL_FREE_NON_NULL(BasePath
);
2121 BasePath
= TempString
;
2125 ShellFileList
= NULL
;
2126 ShellFileListItem
= NULL
;
2128 Status
= EFI_SUCCESS
;
2131 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2132 ; !EFI_ERROR(Status
) && !NoFile
2133 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2136 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2138 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2140 EFI_SUCCESS
, // success since we didnt fail to open it...
2142 NULL
, // no handle since not open
2145 if (ShellFileList
== NULL
) {
2146 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2147 ASSERT(ShellFileList
!= NULL
);
2148 InitializeListHead(&ShellFileList
->Link
);
2150 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2152 if (EFI_ERROR(Status
)) {
2153 EfiShellFreeFileList(&ShellFileList
);
2156 *FileList
= ShellFileList
;
2158 SHELL_FREE_NON_NULL(BasePath
);
2163 Get the GUID value from a human readable name.
2165 If GuidName is a known GUID name, then update Guid to have the correct value for
2168 This function is only available when the major and minor versions in the
2169 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2171 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2172 @param[out] Guid A pointer to the GUID structure to be filled in.
2174 @retval EFI_SUCCESS The operation was successful.
2175 @retval EFI_INVALID_PARAMETER Guid was NULL.
2176 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2177 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2181 EfiShellGetGuidFromName(
2182 IN CONST CHAR16
*GuidName
,
2189 if (Guid
== NULL
|| GuidName
== NULL
) {
2190 return (EFI_INVALID_PARAMETER
);
2193 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2195 if (!EFI_ERROR(Status
)) {
2196 CopyGuid(NewGuid
, Guid
);
2203 Get the human readable name for a GUID from the value.
2205 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2206 should not modify the value.
2208 This function is only available when the major and minor versions in the
2209 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2211 @param[in] Guid A pointer to the GUID being queried.
2212 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2214 @retval EFI_SUCCESS The operation was successful.
2215 @retval EFI_INVALID_PARAMETER Guid was NULL.
2216 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2217 @retval EFI_NOT_FOUND Guid is not assigned a name.
2221 EfiShellGetGuidName(
2222 IN CONST EFI_GUID
*Guid
,
2223 OUT CONST CHAR16
**GuidName
2228 if (Guid
== NULL
|| GuidName
== NULL
) {
2229 return (EFI_INVALID_PARAMETER
);
2232 Name
= GetStringNameFromGuid(Guid
, NULL
);
2233 if (Name
== NULL
|| StrLen(Name
) == 0) {
2234 SHELL_FREE_NON_NULL(Name
);
2235 return (EFI_NOT_FOUND
);
2238 *GuidName
= AddBufferToFreeList(Name
);
2240 return (EFI_SUCCESS
);
2244 Updates a file name to be preceeded by the mapped drive name
2246 @param[in] BasePath the Mapped drive name to prepend
2247 @param[in, out] Path pointer to pointer to the file name to update.
2250 @retval EFI_OUT_OF_RESOURCES
2255 IN CONST CHAR16
*BasePath
,
2256 IN OUT CHAR16
**Path
2265 ASSERT(Path
!= NULL
);
2266 ASSERT(*Path
!= NULL
);
2267 ASSERT(BasePath
!= NULL
);
2270 // convert a local path to an absolute path
2272 if (StrStr(*Path
, L
":") == NULL
) {
2273 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2274 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2275 if (Path2
== NULL
) {
2276 return (EFI_OUT_OF_RESOURCES
);
2278 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2279 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2280 if (Path2
== NULL
) {
2281 return (EFI_OUT_OF_RESOURCES
);
2288 return (EFI_SUCCESS
);
2292 If FileHandle is a directory then the function reads from FileHandle and reads in
2293 each of the FileInfo structures. If one of them matches the Pattern's first
2294 "level" then it opens that handle and calls itself on that handle.
2296 If FileHandle is a file and matches all of the remaining Pattern (which would be
2297 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2299 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2300 FreeFileList with FileList.
2302 @param[in] FilePattern The FilePattern to check against.
2303 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2304 @param[in] FileHandle The FileHandle to start with
2305 @param[in, out] FileList pointer to pointer to list of found files.
2306 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2307 @param[in] MapName The file system name this file is on.
2309 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2310 @retval EFI_NOT_FOUND no files were found
2311 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2316 IN CONST CHAR16
*FilePattern
,
2317 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2318 IN SHELL_FILE_HANDLE FileHandle
,
2319 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2320 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2321 IN CONST CHAR16
*MapName
2325 CONST CHAR16
*NextFilePatternStart
;
2326 CHAR16
*CurrentFilePattern
;
2327 EFI_SHELL_FILE_INFO
*ShellInfo
;
2328 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2329 EFI_SHELL_FILE_INFO
*NewShellNode
;
2330 EFI_FILE_INFO
*FileInfo
;
2332 CHAR16
*NewFullName
;
2335 if ( FilePattern
== NULL
2336 || UnicodeCollation
== NULL
2339 return (EFI_INVALID_PARAMETER
);
2342 CurrentFilePattern
= NULL
;
2344 if (*FilePattern
== L
'\\') {
2348 for( NextFilePatternStart
= FilePattern
2349 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2350 ; NextFilePatternStart
++);
2352 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2353 ASSERT(CurrentFilePattern
!= NULL
);
2354 StrnCpyS(CurrentFilePattern
, NextFilePatternStart
-FilePattern
+1, FilePattern
, NextFilePatternStart
-FilePattern
);
2356 if (CurrentFilePattern
[0] == CHAR_NULL
2357 &&NextFilePatternStart
[0] == CHAR_NULL
2360 // we want the parent or root node (if no parent)
2362 if (ParentNode
== NULL
) {
2364 // We want the root node. create the node.
2366 FileInfo
= FileHandleGetInfo(FileHandle
);
2367 NewShellNode
= CreateAndPopulateShellFileInfo(
2374 SHELL_FREE_NON_NULL(FileInfo
);
2377 // Add the current parameter FileHandle to the list, then end...
2379 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2381 if (NewShellNode
== NULL
) {
2382 Status
= EFI_OUT_OF_RESOURCES
;
2384 NewShellNode
->Handle
= NULL
;
2385 if (*FileList
== NULL
) {
2386 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2387 InitializeListHead(&((*FileList
)->Link
));
2391 // Add to the returning to use list
2393 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2395 Status
= EFI_SUCCESS
;
2398 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2400 if (!EFI_ERROR(Status
)){
2401 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2406 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2407 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2408 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2410 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2411 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2412 Size
= StrSize(ShellInfoNode
->FullName
);
2413 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2414 NewFullName
= AllocateZeroPool(Size
);
2415 if (NewFullName
== NULL
) {
2416 Status
= EFI_OUT_OF_RESOURCES
;
2418 StrCpyS(NewFullName
, Size
/sizeof(CHAR16
), MapName
);
2419 StrCatS(NewFullName
, Size
/sizeof(CHAR16
), ShellInfoNode
->FullName
+1);
2420 FreePool((VOID
*)ShellInfoNode
->FullName
);
2421 ShellInfoNode
->FullName
= NewFullName
;
2424 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2426 // should be a directory
2430 // don't open the . and .. directories
2432 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2433 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2438 if (EFI_ERROR(Status
)) {
2442 // Open the directory since we need that handle in the next recursion.
2444 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2447 // recurse with the next part of the pattern
2449 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2450 EfiShellClose(ShellInfoNode
->Handle
);
2451 ShellInfoNode
->Handle
= NULL
;
2453 } else if (!EFI_ERROR(Status
)) {
2459 // copy the information we need into a new Node
2461 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2462 ASSERT(NewShellNode
!= NULL
);
2463 if (NewShellNode
== NULL
) {
2464 Status
= EFI_OUT_OF_RESOURCES
;
2466 if (*FileList
== NULL
) {
2467 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2468 InitializeListHead(&((*FileList
)->Link
));
2472 // Add to the returning to use list
2474 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2477 if (EFI_ERROR(Status
)) {
2481 if (EFI_ERROR(Status
)) {
2482 EfiShellFreeFileList(&ShellInfo
);
2484 Status
= EfiShellFreeFileList(&ShellInfo
);
2489 FreePool(CurrentFilePattern
);
2494 Find files that match a specified pattern.
2496 This function searches for all files and directories that match the specified
2497 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2498 information is placed in the file list FileList.
2500 Wildcards are processed
2501 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2503 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2504 field is set to NULL.
2506 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2508 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2509 @param FileList On return, points to the start of a file list containing the names
2510 of all matching files or else points to NULL if no matching files
2511 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2513 @retval EFI_SUCCESS Files found. FileList is a valid list.
2514 @retval EFI_NOT_FOUND No files found.
2515 @retval EFI_NO_MEDIA The device has no media
2516 @retval EFI_DEVICE_ERROR The device reported an error
2517 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2522 IN CONST CHAR16
*FilePattern
,
2523 OUT EFI_SHELL_FILE_INFO
**FileList
2527 CHAR16
*PatternCopy
;
2528 CHAR16
*PatternCurrentLocation
;
2529 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2530 SHELL_FILE_HANDLE RootFileHandle
;
2534 if ( FilePattern
== NULL
2536 || StrStr(FilePattern
, L
":") == NULL
2538 return (EFI_INVALID_PARAMETER
);
2540 Status
= EFI_SUCCESS
;
2541 RootDevicePath
= NULL
;
2542 RootFileHandle
= NULL
;
2544 PatternCopy
= AllocateCopyPool(StrSize(FilePattern
), FilePattern
);
2545 if (PatternCopy
== NULL
) {
2546 return (EFI_OUT_OF_RESOURCES
);
2549 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2551 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2554 ASSERT(MapName
== NULL
);
2555 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2556 if (MapName
== NULL
) {
2557 Status
= EFI_OUT_OF_RESOURCES
;
2559 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2560 if (RootDevicePath
== NULL
) {
2561 Status
= EFI_INVALID_PARAMETER
;
2563 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2564 if (!EFI_ERROR(Status
)) {
2565 for ( PatternCurrentLocation
= PatternCopy
2566 ; *PatternCurrentLocation
!= ':'
2567 ; PatternCurrentLocation
++);
2568 PatternCurrentLocation
++;
2569 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2570 EfiShellClose(RootFileHandle
);
2572 FreePool(RootDevicePath
);
2576 SHELL_FREE_NON_NULL(PatternCopy
);
2577 SHELL_FREE_NON_NULL(MapName
);
2583 Opens the files that match the path specified.
2585 This function opens all of the files specified by Path. Wildcards are processed
2586 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2587 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2589 @param Path A pointer to the path string.
2590 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2591 EFI_FILE_MODE_WRITE.
2592 @param FileList Points to the start of a list of files opened.
2594 @retval EFI_SUCCESS Create the file list successfully.
2595 @return Others Can't create the file list.
2599 EfiShellOpenFileList(
2602 IN OUT EFI_SHELL_FILE_INFO
**FileList
2606 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2609 CONST CHAR16
*CurDir
;
2612 PathCleanUpDirectories(Path
);
2617 if (FileList
== NULL
|| *FileList
== NULL
) {
2618 return (EFI_INVALID_PARAMETER
);
2621 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2626 // convert a local path to an absolute path
2628 if (StrStr(Path
, L
":") == NULL
) {
2629 CurDir
= EfiShellGetCurDir(NULL
);
2630 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2631 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2632 StrnCatGrow(&Path2
, &Path2Size
, L
"\\", 0);
2633 if (*Path
== L
'\\') {
2635 while (PathRemoveLastItem(Path2
)) ;
2637 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2638 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2640 ASSERT(Path2
== NULL
);
2641 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2644 PathCleanUpDirectories (Path2
);
2649 Status
= EfiShellFindFiles(Path2
, FileList
);
2653 if (EFI_ERROR(Status
)) {
2659 // We had no errors so open all the files (that are not already opened...)
2661 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2662 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2663 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2665 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2666 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2672 return (EFI_NOT_FOUND
);
2674 return(EFI_SUCCESS
);
2678 Gets the environment variable and Attributes, or list of environment variables. Can be
2679 used instead of GetEnv().
2681 This function returns the current value of the specified environment variable and
2682 the Attributes. If no variable name was specified, then all of the known
2683 variables will be returned.
2685 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2686 then the function will return all of the defined shell
2687 environment variables. In the case where multiple environment
2688 variables are being returned, each variable will be terminated
2689 by a NULL, and the list will be terminated by a double NULL.
2690 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2691 the environment variable. In the case where Name is NULL, and
2692 multiple environment variables are being returned, Attributes
2695 @retval NULL The environment variable doesn't exist.
2696 @return A non-NULL value points to the variable's value. The returned
2697 pointer does not need to be freed by the caller.
2702 IN CONST CHAR16
*Name
,
2703 OUT UINT32
*Attributes OPTIONAL
2710 CHAR16
*CurrentWriteLocation
;
2718 // Build the semi-colon delimited list. (2 passes)
2720 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&gShellEnvVarList
.Link
)
2721 ; !IsNull(&gShellEnvVarList
.Link
, &Node
->Link
)
2722 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&gShellEnvVarList
.Link
, &Node
->Link
)
2724 ASSERT(Node
->Key
!= NULL
);
2725 Size
+= StrSize(Node
->Key
);
2728 Size
+= 2*sizeof(CHAR16
);
2730 Buffer
= AllocateZeroPool(Size
);
2731 if (Buffer
== NULL
) {
2734 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2736 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&gShellEnvVarList
.Link
)
2737 ; !IsNull(&gShellEnvVarList
.Link
, &Node
->Link
)
2738 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&gShellEnvVarList
.Link
, &Node
->Link
)
2740 ASSERT(Node
->Key
!= NULL
);
2741 StrCpyS( CurrentWriteLocation
,
2742 (Size
)/sizeof(CHAR16
) - (CurrentWriteLocation
- ((CHAR16
*)Buffer
)),
2745 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2750 // We are doing a specific environment variable
2752 Status
= ShellFindEnvVarInList(Name
, (CHAR16
**)&Buffer
, &Size
, Attributes
);
2754 if (EFI_ERROR(Status
)){
2756 // get the size we need for this EnvVariable
2758 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2759 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2761 // Allocate the space and recall the get function
2763 Buffer
= AllocateZeroPool(Size
);
2764 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2767 // we didnt get it (might not exist)
2768 // free the memory if we allocated any and return NULL
2770 if (EFI_ERROR(Status
)) {
2771 if (Buffer
!= NULL
) {
2777 // If we did not find the environment variable in the gShellEnvVarList
2778 // but get it from UEFI variable storage successfully then we need update
2779 // the gShellEnvVarList.
2781 ShellFreeEnvVarList ();
2782 Status
= ShellInitEnvVarList ();
2783 ASSERT (Status
== EFI_SUCCESS
);
2789 // return the buffer
2791 return (AddBufferToFreeList(Buffer
));
2795 Gets either a single or list of environment variables.
2797 If name is not NULL then this function returns the current value of the specified
2798 environment variable.
2800 If Name is NULL, then a list of all environment variable names is returned. Each is a
2801 NULL terminated string with a double NULL terminating the list.
2803 @param Name A pointer to the environment variable name. If
2804 Name is NULL, then the function will return all
2805 of the defined shell environment variables. In
2806 the case where multiple environment variables are
2807 being returned, each variable will be terminated by
2808 a NULL, and the list will be terminated by a double
2811 @retval !=NULL A pointer to the returned string.
2812 The returned pointer does not need to be freed by the caller.
2814 @retval NULL The environment variable doesn't exist or there are
2815 no environment variables.
2820 IN CONST CHAR16
*Name
2823 return (EfiShellGetEnvEx(Name
, NULL
));
2827 Internal variable setting function. Allows for setting of the read only variables.
2829 @param Name Points to the NULL-terminated environment variable name.
2830 @param Value Points to the NULL-terminated environment variable value. If the value is an
2831 empty string then the environment variable is deleted.
2832 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2834 @retval EFI_SUCCESS The environment variable was successfully updated.
2838 InternalEfiShellSetEnv(
2839 IN CONST CHAR16
*Name
,
2840 IN CONST CHAR16
*Value
,
2849 if (Value
== NULL
|| StrLen(Value
) == 0) {
2850 Status
= SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2851 if (!EFI_ERROR(Status
)) {
2852 ShellRemvoeEnvVarFromList(Name
);
2856 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2858 Status
= SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
);
2859 if (!EFI_ERROR(Status
)) {
2860 Atts
&= ~EFI_VARIABLE_NON_VOLATILE
;
2861 Atts
|= EFI_VARIABLE_BOOTSERVICE_ACCESS
;
2862 ShellAddEnvVarToList(Name
, Value
, StrSize(Value
), Atts
);
2866 Status
= SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
);
2867 if (!EFI_ERROR(Status
)) {
2868 Atts
|= EFI_VARIABLE_NON_VOLATILE
;
2869 Atts
|= EFI_VARIABLE_BOOTSERVICE_ACCESS
;
2870 ShellAddEnvVarToList(Name
, Value
, StrSize(Value
), Atts
);
2878 Sets the environment variable.
2880 This function changes the current value of the specified environment variable. If the
2881 environment variable exists and the Value is an empty string, then the environment
2882 variable is deleted. If the environment variable exists and the Value is not an empty
2883 string, then the value of the environment variable is changed. If the environment
2884 variable does not exist and the Value is an empty string, there is no action. If the
2885 environment variable does not exist and the Value is a non-empty string, then the
2886 environment variable is created and assigned the specified value.
2888 For a description of volatile and non-volatile environment variables, see UEFI Shell
2889 2.0 specification section 3.6.1.
2891 @param Name Points to the NULL-terminated environment variable name.
2892 @param Value Points to the NULL-terminated environment variable value. If the value is an
2893 empty string then the environment variable is deleted.
2894 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2896 @retval EFI_SUCCESS The environment variable was successfully updated.
2901 IN CONST CHAR16
*Name
,
2902 IN CONST CHAR16
*Value
,
2906 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2907 return (EFI_INVALID_PARAMETER
);
2910 // Make sure we dont 'set' a predefined read only variable
2912 if (gUnicodeCollation
->StriColl(
2916 ||gUnicodeCollation
->StriColl(
2920 ||gUnicodeCollation
->StriColl(
2924 ||gUnicodeCollation
->StriColl(
2927 L
"uefishellsupport") == 0
2928 ||gUnicodeCollation
->StriColl(
2931 L
"uefishellversion") == 0
2932 ||gUnicodeCollation
->StriColl(
2935 L
"uefiversion") == 0
2936 ||(!ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoNest
&&
2937 gUnicodeCollation
->StriColl(
2940 (CHAR16
*)mNoNestingEnvVarName
) == 0)
2942 return (EFI_INVALID_PARAMETER
);
2944 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2948 Returns the current directory on the specified device.
2950 If FileSystemMapping is NULL, it returns the current working directory. If the
2951 FileSystemMapping is not NULL, it returns the current directory associated with the
2952 FileSystemMapping. In both cases, the returned name includes the file system
2953 mapping (i.e. fs0:\current-dir).
2955 Note that the current directory string should exclude the tailing backslash character.
2957 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2958 then the current working directory is returned.
2960 @retval !=NULL The current directory.
2961 @retval NULL Current directory does not exist.
2966 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2969 CHAR16
*PathToReturn
;
2971 SHELL_MAP_LIST
*MapListItem
;
2972 if (!IsListEmpty(&gShellMapList
.Link
)) {
2974 // if parameter is NULL, use current
2976 if (FileSystemMapping
== NULL
) {
2977 return (EfiShellGetEnv(L
"cwd"));
2980 PathToReturn
= NULL
;
2981 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2982 if (MapListItem
!= NULL
) {
2983 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2984 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2985 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2988 return (AddBufferToFreeList(PathToReturn
));
2995 Changes the current directory on the specified device.
2997 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2998 mapped name, this function changes the current working directory.
3000 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
3001 current file system and the current directory on that file system are changed.
3003 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
3006 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
3007 directory on the specified file system.
3009 If the current working directory or the current working file system is changed then the
3010 %cwd% environment variable will be updated
3012 Note that the current directory string should exclude the tailing backslash character.
3014 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
3015 directory is changed.
3016 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
3018 @retval EFI_SUCCESS The operation was sucessful
3019 @retval EFI_NOT_FOUND The file system could not be found
3024 IN CONST CHAR16
*FileSystem OPTIONAL
,
3025 IN CONST CHAR16
*Dir
3029 SHELL_MAP_LIST
*MapListItem
;
3033 CHAR16
*DirectoryName
;
3040 DirectoryName
= NULL
;
3042 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
3043 return (EFI_INVALID_PARAMETER
);
3046 if (IsListEmpty(&gShellMapList
.Link
)){
3047 return (EFI_NOT_FOUND
);
3050 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
3051 ASSERT(DirectoryName
!= NULL
);
3053 PathCleanUpDirectories(DirectoryName
);
3055 if (FileSystem
== NULL
) {
3057 // determine the file system mapping to use
3059 if (StrStr(DirectoryName
, L
":") != NULL
) {
3060 ASSERT(MapName
== NULL
);
3061 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
3064 // find the file system mapping's entry in the list
3067 if (MapName
!= NULL
) {
3068 MapListItem
= ShellCommandFindMapItem(MapName
);
3071 // make that the current file system mapping
3073 if (MapListItem
!= NULL
) {
3074 gShellCurDir
= MapListItem
;
3077 MapListItem
= gShellCurDir
;
3080 if (MapListItem
== NULL
) {
3081 FreePool (DirectoryName
);
3082 SHELL_FREE_NON_NULL(MapName
);
3083 return (EFI_NOT_FOUND
);
3087 // now update the MapListItem's current directory
3089 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
3090 FreePool(MapListItem
->CurrentDirectoryPath
);
3091 MapListItem
->CurrentDirectoryPath
= NULL
;
3093 if (MapName
!= NULL
) {
3094 TempLen
= StrLen(MapName
);
3095 if (TempLen
!= StrLen(DirectoryName
)) {
3096 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3097 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
3101 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3102 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3104 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
3105 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3106 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
3107 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
3112 // cant have a mapping in the directory...
3114 if (StrStr(DirectoryName
, L
":") != NULL
) {
3115 FreePool (DirectoryName
);
3116 return (EFI_INVALID_PARAMETER
);
3119 // FileSystem != NULL
3121 MapListItem
= ShellCommandFindMapItem(FileSystem
);
3122 if (MapListItem
== NULL
) {
3123 FreePool (DirectoryName
);
3124 return (EFI_INVALID_PARAMETER
);
3126 // gShellCurDir = MapListItem;
3127 if (DirectoryName
!= NULL
) {
3129 // change current dir on that file system
3132 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
3133 FreePool(MapListItem
->CurrentDirectoryPath
);
3134 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
3136 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3137 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
3138 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3139 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3140 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3141 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3142 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') {
3143 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3144 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
3148 FreePool (DirectoryName
);
3150 // if updated the current directory then update the environment variable
3152 if (MapListItem
== gShellCurDir
) {
3154 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3155 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3156 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3157 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3158 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3159 FreePool(TempString
);
3162 return(EFI_SUCCESS
);
3166 Return help information about a specific command.
3168 This function returns the help information for the specified command. The help text
3169 can be internal to the shell or can be from a UEFI Shell manual page.
3171 If Sections is specified, then each section name listed will be compared in a casesensitive
3172 manner, to the section names described in Appendix B. If the section exists,
3173 it will be appended to the returned help text. If the section does not exist, no
3174 information will be returned. If Sections is NULL, then all help text information
3175 available will be returned.
3177 @param Command Points to the NULL-terminated UEFI Shell command name.
3178 @param Sections Points to the NULL-terminated comma-delimited
3179 section names to return. If NULL, then all
3180 sections will be returned.
3181 @param HelpText On return, points to a callee-allocated buffer
3182 containing all specified help text.
3184 @retval EFI_SUCCESS The help text was returned.
3185 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3187 @retval EFI_INVALID_PARAMETER HelpText is NULL
3188 @retval EFI_NOT_FOUND There is no help text available for Command.
3192 EfiShellGetHelpText(
3193 IN CONST CHAR16
*Command
,
3194 IN CONST CHAR16
*Sections OPTIONAL
,
3195 OUT CHAR16
**HelpText
3198 CONST CHAR16
*ManFileName
;
3202 ASSERT(HelpText
!= NULL
);
3205 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3207 if (ManFileName
!= NULL
) {
3208 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3210 if ((StrLen(Command
)> 4)
3211 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3212 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3213 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3214 && (Command
[StrLen(Command
)-4] == L
'.')
3216 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3217 ASSERT(FixCommand
!= NULL
);
3219 StrnCpyS( FixCommand
,
3220 (StrSize(Command
) - 4 * sizeof (CHAR16
))/sizeof(CHAR16
),
3224 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3225 FreePool(FixCommand
);
3228 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3234 Gets the enable status of the page break output mode.
3236 User can use this function to determine current page break mode.
3238 @retval TRUE The page break output mode is enabled.
3239 @retval FALSE The page break output mode is disabled.
3243 EfiShellGetPageBreak(
3247 return(ShellInfoObject
.PageBreakEnabled
);
3251 Judges whether the active shell is the root shell.
3253 This function makes the user to know that whether the active Shell is the root shell.
3255 @retval TRUE The active Shell is the root Shell.
3256 @retval FALSE The active Shell is NOT the root Shell.
3260 EfiShellIsRootShell(
3264 return(ShellInfoObject
.RootShellInstance
);
3268 function to return a semi-colon delimeted list of all alias' in the current shell
3270 up to caller to free the memory.
3272 @retval NULL No alias' were found
3273 @retval NULL An error ocurred getting alias'
3274 @return !NULL a list of all alias'
3278 InternalEfiShellGetListAlias(
3284 CHAR16
*VariableName
;
3286 UINTN NameBufferSize
;
3290 NameBufferSize
= INIT_NAME_BUFFER_SIZE
;
3291 VariableName
= AllocateZeroPool(NameBufferSize
);
3295 if (VariableName
== NULL
) {
3299 VariableName
[0] = CHAR_NULL
;
3302 NameSize
= NameBufferSize
;
3303 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3304 if (Status
== EFI_NOT_FOUND
){
3306 } else if (Status
== EFI_BUFFER_TOO_SMALL
) {
3307 NameBufferSize
= NameSize
> NameBufferSize
* 2 ? NameSize
: NameBufferSize
* 2;
3308 SHELL_FREE_NON_NULL(VariableName
);
3309 VariableName
= AllocateZeroPool(NameBufferSize
);
3310 if (VariableName
== NULL
) {
3311 Status
= EFI_OUT_OF_RESOURCES
;
3312 SHELL_FREE_NON_NULL(RetVal
);
3317 NameSize
= NameBufferSize
;
3318 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3321 if (EFI_ERROR (Status
)) {
3322 SHELL_FREE_NON_NULL(RetVal
);
3327 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3328 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3329 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3330 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3333 SHELL_FREE_NON_NULL(VariableName
);
3339 Convert a null-terminated unicode string, in-place, to all lowercase.
3342 @param Str The null-terminated string to be converted to all lowercase.
3344 @return The null-terminated string converted into all lowercase.
3353 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3354 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3355 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3362 This function returns the command associated with a alias or a list of all
3365 @param[in] Alias Points to the NULL-terminated shell alias.
3366 If this parameter is NULL, then all
3367 aliases will be returned in ReturnedData.
3368 @param[out] Volatile upon return of a single command if TRUE indicates
3369 this is stored in a volatile fashion. FALSE otherwise.
3371 @return If Alias is not NULL, it will return a pointer to
3372 the NULL-terminated command for that alias.
3373 If Alias is NULL, ReturnedData points to a ';'
3374 delimited list of alias (e.g.
3375 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3376 @retval NULL an error ocurred
3377 @retval NULL Alias was not a valid Alias
3382 IN CONST CHAR16
*Alias
,
3383 OUT BOOLEAN
*Volatile OPTIONAL
3393 // Convert to lowercase to make aliases case-insensitive
3394 if (Alias
!= NULL
) {
3395 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3396 ASSERT (AliasLower
!= NULL
);
3397 ToLower (AliasLower
);
3399 if (Volatile
== NULL
) {
3400 GetVariable2 (AliasLower
, &gShellAliasGuid
, (VOID
**)&AliasVal
, NULL
);
3401 FreePool(AliasLower
);
3402 return (AddBufferToFreeList(AliasVal
));
3406 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3407 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3408 RetVal
= AllocateZeroPool(RetSize
);
3409 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3411 if (EFI_ERROR(Status
)) {
3412 if (RetVal
!= NULL
) {
3415 FreePool(AliasLower
);
3418 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3424 FreePool (AliasLower
);
3425 return (AddBufferToFreeList(RetVal
));
3427 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3431 Changes a shell command alias.
3433 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3435 this function does not check for built in alias'.
3437 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3438 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3439 Command refers to an alias, that alias will be deleted.
3440 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3441 Alias being set will be stored in a non-volatile fashion.
3443 @retval EFI_SUCCESS Alias created or deleted successfully.
3444 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3449 IN CONST CHAR16
*Command
,
3450 IN CONST CHAR16
*Alias
,
3457 // Convert to lowercase to make aliases case-insensitive
3458 if (Alias
!= NULL
) {
3459 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3460 ASSERT (AliasLower
!= NULL
);
3461 ToLower (AliasLower
);
3467 // We must be trying to remove one if Alias is NULL
3469 if (Alias
== NULL
) {
3471 // remove an alias (but passed in COMMAND parameter)
3473 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3476 // Add and replace are the same
3479 // We dont check the error return on purpose since the variable may not exist.
3480 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3482 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3485 if (Alias
!= NULL
) {
3486 FreePool (AliasLower
);
3492 Changes a shell command alias.
3494 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3497 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3498 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3499 Command refers to an alias, that alias will be deleted.
3500 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3501 FALSE and the alias already exists, then the existing alias is unchanged and
3502 EFI_ACCESS_DENIED is returned.
3503 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3504 Alias being set will be stored in a non-volatile fashion.
3506 @retval EFI_SUCCESS Alias created or deleted successfully.
3507 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3508 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3510 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3515 IN CONST CHAR16
*Command
,
3516 IN CONST CHAR16
*Alias
,
3521 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3523 // cant set over a built in alias
3525 return (EFI_ACCESS_DENIED
);
3526 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3528 // Command is null or empty
3530 return (EFI_INVALID_PARAMETER
);
3531 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3533 // Alias already exists, Replace not set
3535 return (EFI_ACCESS_DENIED
);
3537 return (InternalSetAlias(Command
, Alias
, Volatile
));
3541 // Pure FILE_HANDLE operations are passed to FileHandleLib
3542 // these functions are indicated by the *
3543 EFI_SHELL_PROTOCOL mShellProtocol
= {
3549 EfiShellGetHelpText
,
3550 EfiShellGetDevicePathFromMap
,
3551 EfiShellGetMapFromDevicePath
,
3552 EfiShellGetDevicePathFromFilePath
,
3553 EfiShellGetFilePathFromDevicePath
,
3557 EfiShellOpenFileList
,
3558 EfiShellFreeFileList
,
3559 EfiShellRemoveDupInFileList
,
3560 EfiShellBatchIsActive
,
3561 EfiShellIsRootShell
,
3562 EfiShellEnablePageBreak
,
3563 EfiShellDisablePageBreak
,
3564 EfiShellGetPageBreak
,
3565 EfiShellGetDeviceName
,
3566 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3567 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3568 EfiShellOpenFileByName
,
3571 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3572 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3573 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3574 EfiShellDeleteFileByName
,
3575 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3576 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3577 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3579 EfiShellFindFilesInDir
,
3580 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3582 EfiShellOpenRootByHandle
,
3584 SHELL_MAJOR_VERSION
,
3585 SHELL_MINOR_VERSION
,
3587 // New for UEFI Shell 2.1
3588 EfiShellRegisterGuidName
,
3589 EfiShellGetGuidName
,
3590 EfiShellGetGuidFromName
,
3595 Function to create and install on the current handle.
3597 Will overwrite any existing ShellProtocols in the system to be sure that
3598 the current shell is in control.
3600 This must be removed via calling CleanUpShellProtocol().
3602 @param[in, out] NewShell The pointer to the pointer to the structure
3605 @retval EFI_SUCCESS The operation was successful.
3606 @return An error from LocateHandle, CreateEvent, or other core function.
3610 CreatePopulateInstallShellProtocol (
3611 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3617 UINTN HandleCounter
;
3618 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3620 if (NewShell
== NULL
) {
3621 return (EFI_INVALID_PARAMETER
);
3626 OldProtocolNode
= NULL
;
3627 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3630 // Initialize EfiShellProtocol object...
3632 Status
= gBS
->CreateEvent(0,
3636 &mShellProtocol
.ExecutionBreak
);
3637 if (EFI_ERROR(Status
)) {
3642 // Get the size of the buffer we need.
3644 Status
= gBS
->LocateHandle(ByProtocol
,
3645 &gEfiShellProtocolGuid
,
3649 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3651 // Allocate and recall with buffer of correct size
3653 Buffer
= AllocateZeroPool(BufferSize
);
3654 if (Buffer
== NULL
) {
3655 return (EFI_OUT_OF_RESOURCES
);
3657 Status
= gBS
->LocateHandle(ByProtocol
,
3658 &gEfiShellProtocolGuid
,
3662 if (EFI_ERROR(Status
)) {
3667 // now overwrite each of them, but save the info to restore when we end.
3669 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3670 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3671 ASSERT(OldProtocolNode
!= NULL
);
3672 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3673 &gEfiShellProtocolGuid
,
3674 (VOID
**) &(OldProtocolNode
->Interface
),
3677 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3679 if (!EFI_ERROR(Status
)) {
3681 // reinstall over the old one...
3683 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3684 Status
= gBS
->ReinstallProtocolInterface(
3685 OldProtocolNode
->Handle
,
3686 &gEfiShellProtocolGuid
,
3687 OldProtocolNode
->Interface
,
3688 (VOID
*)(&mShellProtocol
));
3689 if (!EFI_ERROR(Status
)) {
3691 // we reinstalled sucessfully. log this so we can reverse it later.
3695 // add to the list for subsequent...
3697 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3702 } else if (Status
== EFI_NOT_FOUND
) {
3703 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3705 // no one else published yet. just publish it ourselves.
3707 Status
= gBS
->InstallProtocolInterface (
3709 &gEfiShellProtocolGuid
,
3710 EFI_NATIVE_INTERFACE
,
3711 (VOID
*)(&mShellProtocol
));
3714 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3715 ///@todo support ShellEnvironment2
3716 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3719 if (!EFI_ERROR(Status
)) {
3720 *NewShell
= &mShellProtocol
;
3726 Opposite of CreatePopulateInstallShellProtocol.
3728 Free all memory and restore the system to the state it was in before calling
3729 CreatePopulateInstallShellProtocol.
3731 @param[in, out] NewShell The pointer to the new shell protocol structure.
3733 @retval EFI_SUCCESS The operation was successful.
3737 CleanUpShellProtocol (
3738 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3742 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3743 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3746 // if we need to restore old protocols...
3748 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3749 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3750 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3751 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3753 RemoveEntryList(&Node2
->Link
);
3754 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3755 &gEfiShellProtocolGuid
,
3762 // no need to restore
3764 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3765 &gEfiShellProtocolGuid
,
3768 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3769 NewShell
->ExecutionBreak
= NULL
;
3771 Status
= gBS
->OpenProtocol(
3772 gST
->ConsoleInHandle
,
3773 &gEfiSimpleTextInputExProtocolGuid
,
3777 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3779 if (!EFI_ERROR (Status
)) {
3780 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3781 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3782 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3783 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3784 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3785 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3786 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3787 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3793 Notification function for keystrokes.
3795 @param[in] KeyData The key that was pressed.
3797 @retval EFI_SUCCESS The operation was successful.
3801 NotificationFunction(
3802 IN EFI_KEY_DATA
*KeyData
3805 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3806 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3807 (KeyData
->Key
.UnicodeChar
== 3)
3809 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3810 return (EFI_UNSUPPORTED
);
3812 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3813 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3814 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3816 ShellInfoObject
.HaltOutput
= TRUE
;
3818 return (EFI_SUCCESS
);
3822 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3823 feature's enabled state was not known when the shell initially launched.
3825 @retval EFI_SUCCESS The feature is enabled.
3826 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3830 InernalEfiShellStartMonitor(
3834 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3835 EFI_KEY_DATA KeyData
;
3838 Status
= gBS
->OpenProtocol(
3839 gST
->ConsoleInHandle
,
3840 &gEfiSimpleTextInputExProtocolGuid
,
3844 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3845 if (EFI_ERROR(Status
)) {
3850 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3851 ShellInfoObject
.HiiHandle
);
3852 return (EFI_SUCCESS
);
3855 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3856 return (EFI_UNSUPPORTED
);
3859 KeyData
.KeyState
.KeyToggleState
= 0;
3860 KeyData
.Key
.ScanCode
= 0;
3861 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3862 KeyData
.Key
.UnicodeChar
= L
'c';
3864 Status
= SimpleEx
->RegisterKeyNotify(
3867 NotificationFunction
,
3868 &ShellInfoObject
.CtrlCNotifyHandle1
);
3870 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3871 if (!EFI_ERROR(Status
)) {
3872 Status
= SimpleEx
->RegisterKeyNotify(
3875 NotificationFunction
,
3876 &ShellInfoObject
.CtrlCNotifyHandle2
);
3878 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3879 KeyData
.Key
.UnicodeChar
= 3;
3880 if (!EFI_ERROR(Status
)) {
3881 Status
= SimpleEx
->RegisterKeyNotify(
3884 NotificationFunction
,
3885 &ShellInfoObject
.CtrlCNotifyHandle3
);
3887 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3888 if (!EFI_ERROR(Status
)) {
3889 Status
= SimpleEx
->RegisterKeyNotify(
3892 NotificationFunction
,
3893 &ShellInfoObject
.CtrlCNotifyHandle4
);