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 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
7 Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>
8 This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 #define INIT_NAME_BUFFER_SIZE 128
23 Close an open file handle.
25 This function closes a specified file handle. All "dirty" cached file data is
26 flushed to the device, and the file is closed. In all cases the handle is
29 @param[in] FileHandle The file handle to close.
31 @retval EFI_SUCCESS The file handle was closed successfully.
36 IN SHELL_FILE_HANDLE FileHandle
39 ShellFileHandleRemove(FileHandle
);
40 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
44 Internal worker to determine whether there is a BlockIo somewhere
45 upon the device path specified.
47 @param[in] DevicePath The device path to test.
49 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
50 @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.
82 InternalShellProtocolIsSimpleFileSystemPresent(
83 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
86 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
92 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
93 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
95 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
102 Internal worker debug helper function to print out maps as they are added.
104 @param[in] Mapping string mapping that has been added
105 @param[in] DevicePath pointer to device path that has been mapped.
107 @retval EFI_SUCCESS the operation was successful.
108 @return other an error ocurred
114 InternalShellProtocolDebugPrintMessage (
115 IN CONST CHAR16
*Mapping
,
116 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
122 Status
= EFI_SUCCESS
;
125 if (Mapping
!= NULL
) {
126 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
128 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
129 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
137 This function creates a mapping for a device path.
139 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
141 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
142 then the mapping will be deleted.
143 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
145 @retval EFI_SUCCESS Mapping created or deleted successfully.
146 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
147 boot service function LocateDevicePath().
148 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
149 @retval EFI_INVALID_PARAMETER Mapping was NULL
150 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
151 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
152 @retval EFI_NOT_FOUND There was no mapping found to delete
153 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
158 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
159 IN CONST CHAR16
*Mapping
163 SHELL_MAP_LIST
*MapListNode
;
165 if (Mapping
== NULL
){
166 return (EFI_INVALID_PARAMETER
);
169 if (Mapping
[StrLen(Mapping
)-1] != ':') {
170 return (EFI_INVALID_PARAMETER
);
174 // Delete the mapping
176 if (DevicePath
== NULL
) {
177 if (IsListEmpty(&gShellMapList
.Link
)) {
178 return (EFI_NOT_FOUND
);
180 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
181 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
182 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
184 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
185 RemoveEntryList(&MapListNode
->Link
);
186 SHELL_FREE_NON_NULL(MapListNode
->DevicePath
);
187 SHELL_FREE_NON_NULL(MapListNode
->MapName
);
188 SHELL_FREE_NON_NULL(MapListNode
->CurrentDirectoryPath
);
189 FreePool(MapListNode
);
190 return (EFI_SUCCESS
);
195 // We didnt find one to delete
197 return (EFI_NOT_FOUND
);
201 // make sure this is a valid to add device path
203 ///@todo add BlockIo to this test...
204 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
205 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
206 return (EFI_INVALID_PARAMETER
);
210 // First make sure there is no old mapping
212 Status
= EfiShellSetMap(NULL
, Mapping
);
213 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
218 // now add the new one.
220 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
226 Gets the device path from the mapping.
228 This function gets the device path associated with a mapping.
230 @param Mapping A pointer to the mapping
232 @retval !=NULL Pointer to the device path that corresponds to the
233 device mapping. The returned pointer does not need
235 @retval NULL There is no device path associated with the
238 CONST EFI_DEVICE_PATH_PROTOCOL
*
240 EfiShellGetDevicePathFromMap(
241 IN CONST CHAR16
*Mapping
244 SHELL_MAP_LIST
*MapListItem
;
251 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
252 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
253 StrnCatGrow(&NewName
, &Size
, L
":", 0);
256 MapListItem
= ShellCommandFindMapItem(NewName
);
260 if (MapListItem
!= NULL
) {
261 return (MapListItem
->DevicePath
);
267 Gets the mapping(s) that most closely matches the device path.
269 This function gets the mapping which corresponds to the device path *DevicePath. If
270 there is no exact match, then the mapping which most closely matches *DevicePath
271 is returned, and *DevicePath is updated to point to the remaining portion of the
272 device path. If there is an exact match, the mapping is returned and *DevicePath
273 points to the end-of-device-path node.
275 If there are multiple map names they will be semi-colon seperated in the
276 NULL-terminated string.
278 @param DevicePath On entry, points to a device path pointer. On
279 exit, updates the pointer to point to the
280 portion of the device path after the mapping.
282 @retval NULL No mapping was found.
283 @return !=NULL Pointer to NULL-terminated mapping. The buffer
284 is callee allocated and should be freed by the caller.
288 EfiShellGetMapFromDevicePath(
289 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
292 SHELL_MAP_LIST
*Node
;
293 CHAR16
*PathForReturn
;
295 // EFI_HANDLE PathHandle;
296 // EFI_HANDLE MapHandle;
297 // EFI_STATUS Status;
298 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
299 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
301 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
305 PathForReturn
= NULL
;
308 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
309 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
310 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
313 // check for exact match
315 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
316 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
318 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
320 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
323 if (PathForReturn
!= NULL
) {
324 while (!IsDevicePathEndType (*DevicePath
)) {
325 *DevicePath
= NextDevicePathNode (*DevicePath
);
327 SetDevicePathEndNode (*DevicePath
);
330 ///@todo finish code for inexact matches.
331 if (PathForReturn == NULL) {
334 DevicePathCopy = DuplicateDevicePath(*DevicePath);
335 ASSERT(DevicePathCopy != NULL);
336 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
337 ASSERT_EFI_ERROR(Status);
339 // check each of the device paths we have to get the root of the path for consist mappings
341 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
342 ; !IsNull(&gShellMapList.Link, &Node->Link)
343 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
345 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
348 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
349 ASSERT(MapPathCopy != NULL);
350 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
351 if (MapHandle == PathHandle) {
353 *DevicePath = DevicePathCopy;
356 DevicePathCopy = NULL;
357 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
358 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
363 // now add on the non-consistent mappings
365 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
366 ; !IsNull(&gShellMapList.Link, &Node->Link)
367 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
369 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
372 MapPathCopy = Node->DevicePath;
373 ASSERT(MapPathCopy != NULL);
374 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
375 if (MapHandle == PathHandle) {
376 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
377 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
384 return (AddBufferToFreeList(PathForReturn
));
388 Converts a device path to a file system-style path.
390 This function converts a device path to a file system path by replacing part, or all, of
391 the device path with the file-system mapping. If there are more than one application
392 file system mappings, the one that most closely matches Path will be used.
394 @param Path The pointer to the device path
396 @retval NULL the device path could not be found.
397 @return all The pointer of the NULL-terminated file path. The path
398 is callee-allocated and should be freed by the caller.
402 EfiShellGetFilePathFromDevicePath(
403 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
406 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
407 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
408 SHELL_MAP_LIST
*MapListItem
;
409 CHAR16
*PathForReturn
;
411 EFI_HANDLE PathHandle
;
412 EFI_HANDLE MapHandle
;
414 FILEPATH_DEVICE_PATH
*FilePath
;
415 FILEPATH_DEVICE_PATH
*AlignedNode
;
417 PathForReturn
= NULL
;
420 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
421 ASSERT(DevicePathCopy
!= NULL
);
422 if (DevicePathCopy
== NULL
) {
426 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
428 if (EFI_ERROR(Status
)) {
432 // check each of the device paths we have to get the root of the path
434 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
435 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
436 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
438 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
439 ASSERT(MapPathCopy
!= NULL
);
441 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
442 if (MapHandle
== PathHandle
) {
443 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
444 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
446 // go through all the remaining nodes in the device path
448 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
449 ; !IsDevicePathEnd (&FilePath
->Header
)
450 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
453 // If any node is not a file path node, then the conversion can not be completed
455 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
456 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
457 FreePool(PathForReturn
);
462 // append the path part onto the filepath.
464 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
466 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
467 if (AlignedNode
== NULL
) {
468 FreePool (PathForReturn
);
472 // File Path Device Path Nodes 'can optionally add a "\" separator to
473 // the beginning and/or the end of the Path Name string.'
474 // (UEFI Spec 2.4 section 9.3.6.4).
475 // If necessary, add a "\", but otherwise don't
476 // (This is specified in the above section, and also implied by the
477 // UEFI Shell spec section 3.7)
478 if ((PathSize
!= 0) &&
479 (PathForReturn
!= NULL
) &&
480 (PathForReturn
[PathSize
/ sizeof (CHAR16
) - 1] != L
'\\') &&
481 (AlignedNode
->PathName
[0] != L
'\\')) {
482 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
485 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
486 FreePool(AlignedNode
);
487 } // for loop of remaining nodes
489 if (PathForReturn
!= NULL
) {
492 } // for loop of paths to check
493 return(PathForReturn
);
497 Converts a file system style name to a device path.
499 This function converts a file system style name to a device path, by replacing any
500 mapping references to the associated device path.
502 @param[in] Path The pointer to the path.
504 @return The pointer of the file path. The file path is callee
505 allocated and should be freed by the caller.
506 @retval NULL The path could not be found.
507 @retval NULL There was not enough available memory.
509 EFI_DEVICE_PATH_PROTOCOL
*
511 EfiShellGetDevicePathFromFilePath(
512 IN CONST CHAR16
*Path
519 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
520 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
521 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
522 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
533 if (StrStr(Path
, L
":") == NULL
) {
534 Cwd
= EfiShellGetCurDir(NULL
);
538 Size
= StrSize(Cwd
) + StrSize(Path
);
539 NewPath
= AllocateZeroPool(Size
);
540 if (NewPath
== NULL
) {
543 StrCpyS(NewPath
, Size
/sizeof(CHAR16
), Cwd
);
544 StrCatS(NewPath
, Size
/sizeof(CHAR16
), L
"\\");
545 if (*Path
== L
'\\') {
547 while (PathRemoveLastItem(NewPath
)) ;
549 StrCatS(NewPath
, Size
/sizeof(CHAR16
), Path
);
550 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
552 return (DevicePathForReturn
);
557 // find the part before (but including) the : for the map name
559 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
560 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
561 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
566 // look up the device path in the map
568 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
569 if (DevicePath
== NULL
) {
571 // Must have been a bad Mapname
577 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
579 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
580 if (DevicePathCopy
== NULL
) {
589 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
590 if (EFI_ERROR(Status
)) {
591 if (DevicePathCopyForFree
!= NULL
) {
592 FreePool(DevicePathCopyForFree
);
599 // build the full device path
601 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
602 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
604 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
608 if (DevicePathCopyForFree
!= NULL
) {
609 FreePool(DevicePathCopyForFree
);
612 return (DevicePathForReturn
);
616 Gets the name of the device specified by the device handle.
618 This function gets the user-readable name of the device specified by the device
619 handle. If no user-readable name could be generated, then *BestDeviceName will be
620 NULL and EFI_NOT_FOUND will be returned.
622 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
623 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
626 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
627 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
628 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
629 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
630 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
632 @param DeviceHandle The handle of the device.
633 @param Flags Determines the possible sources of component names.
635 EFI_DEVICE_NAME_USE_COMPONENT_NAME
636 EFI_DEVICE_NAME_USE_DEVICE_PATH
637 @param Language A pointer to the language specified for the device
638 name, in the same format as described in the UEFI
639 specification, Appendix M
640 @param BestDeviceName On return, points to the callee-allocated NULL-
641 terminated name of the device. If no device name
642 could be found, points to NULL. The name must be
643 freed by the caller...
645 @retval EFI_SUCCESS Get the name successfully.
646 @retval EFI_NOT_FOUND Fail to get the device name.
647 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
648 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
649 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
653 EfiShellGetDeviceName(
654 IN EFI_HANDLE DeviceHandle
,
655 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
657 OUT CHAR16
**BestDeviceName
661 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
662 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
663 EFI_HANDLE
*HandleList
;
666 CHAR16
*DeviceNameToReturn
;
668 UINTN ParentControllerCount
;
669 EFI_HANDLE
*ParentControllerBuffer
;
670 UINTN ParentDriverCount
;
671 EFI_HANDLE
*ParentDriverBuffer
;
673 if (BestDeviceName
== NULL
||
676 return (EFI_INVALID_PARAMETER
);
680 // make sure one of the 2 supported bits is on
682 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
683 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
684 return (EFI_INVALID_PARAMETER
);
687 DeviceNameToReturn
= NULL
;
688 *BestDeviceName
= NULL
;
693 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
694 Status
= ParseHandleDatabaseByRelationship(
697 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
700 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
702 // Go through those handles until we get one that passes for GetComponentName
704 Status
= gBS
->OpenProtocol(
706 &gEfiComponentName2ProtocolGuid
,
710 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
711 if (EFI_ERROR(Status
)) {
712 Status
= gBS
->OpenProtocol(
714 &gEfiComponentNameProtocolGuid
,
718 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
721 if (EFI_ERROR(Status
)) {
724 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
725 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
728 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
732 if (HandleList
!= NULL
) {
733 FreePool(HandleList
);
737 // Now check the parent controller using this as the child.
739 if (DeviceNameToReturn
== NULL
){
740 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
741 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
742 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
743 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
745 // try using that driver's component name with controller and our driver as the child.
747 Status
= gBS
->OpenProtocol(
748 ParentDriverBuffer
[HandleCount
],
749 &gEfiComponentName2ProtocolGuid
,
753 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
754 if (EFI_ERROR(Status
)) {
755 Status
= gBS
->OpenProtocol(
756 ParentDriverBuffer
[HandleCount
],
757 &gEfiComponentNameProtocolGuid
,
761 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
764 if (EFI_ERROR(Status
)) {
767 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
768 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
771 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
778 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
779 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
783 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
786 // dont return on fail since we will try device path if that bit is on
788 if (DeviceNameToReturn
!= NULL
){
789 ASSERT(BestDeviceName
!= NULL
);
790 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
791 return (EFI_SUCCESS
);
794 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
795 Status
= gBS
->OpenProtocol(
797 &gEfiDevicePathProtocolGuid
,
801 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
802 if (!EFI_ERROR(Status
)) {
804 // use device path to text on the device path
806 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
807 return (EFI_SUCCESS
);
811 // none of the selected bits worked.
813 return (EFI_NOT_FOUND
);
817 Opens the root directory of a device on a handle
819 This function opens the root directory of a device and returns a file handle to it.
821 @param DeviceHandle The handle of the device that contains the volume.
822 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
825 @retval EFI_SUCCESS Root opened successfully.
826 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
828 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
829 @retval EFI_DEVICE_ERROR The device had an error
833 EfiShellOpenRootByHandle(
834 IN EFI_HANDLE DeviceHandle
,
835 OUT SHELL_FILE_HANDLE
*FileHandle
839 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
840 EFI_FILE_PROTOCOL
*RealFileHandle
;
841 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
844 // get the simple file system interface
846 Status
= gBS
->OpenProtocol(DeviceHandle
,
847 &gEfiSimpleFileSystemProtocolGuid
,
848 (VOID
**)&SimpleFileSystem
,
851 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
852 if (EFI_ERROR(Status
)) {
853 return (EFI_NOT_FOUND
);
856 Status
= gBS
->OpenProtocol(DeviceHandle
,
857 &gEfiDevicePathProtocolGuid
,
861 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
862 if (EFI_ERROR(Status
)) {
863 return (EFI_NOT_FOUND
);
866 // Open the root volume now...
868 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
869 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
874 Opens the root directory of a device.
876 This function opens the root directory of a device and returns a file handle to it.
878 @param DevicePath Points to the device path corresponding to the device where the
879 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
880 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
883 @retval EFI_SUCCESS Root opened successfully.
884 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
886 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
887 @retval EFI_DEVICE_ERROR The device had an error
888 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
893 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
894 OUT SHELL_FILE_HANDLE
*FileHandle
900 if (FileHandle
== NULL
) {
901 return (EFI_INVALID_PARAMETER
);
905 // find the handle of the device with that device handle and the file system
908 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
911 if (EFI_ERROR(Status
)) {
912 return (EFI_NOT_FOUND
);
915 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
919 Returns whether any script files are currently being processed.
921 @retval TRUE There is at least one script file active.
922 @retval FALSE No script files are active now.
927 EfiShellBatchIsActive (
931 if (ShellCommandGetCurrentScriptFile() == NULL
) {
938 Worker function to open a file based on a device path. this will open the root
939 of the volume and then traverse down to the file itself.
941 @param DevicePath Device Path of the file.
942 @param FileHandle Pointer to the file upon a successful return.
943 @param OpenMode mode to open file in.
944 @param Attributes the File Attributes to use when creating a new file.
946 @retval EFI_SUCCESS the file is open and FileHandle is valid
947 @retval EFI_UNSUPPORTED the device path cotained non-path elements
948 @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
;
1135 // Is this for an environment variable
1136 // do we start with >v
1138 if (StrStr(FileName
, L
">v") == FileName
) {
1139 Status
= IsVolatileEnv (FileName
+ 2, &Volatile
);
1140 if (EFI_ERROR (Status
)) {
1144 return (EFI_INVALID_PARAMETER
);
1146 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1147 return (EFI_SUCCESS
);
1151 // We are opening a regular file.
1153 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1154 if (DevicePath
== NULL
) {
1155 return (EFI_NOT_FOUND
);
1158 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
);
1159 FreePool(DevicePath
);
1165 Register a GUID and a localized human readable name for it.
1167 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1168 names must be used whenever a shell command outputs GUID information.
1170 This function is only available when the major and minor versions in the
1171 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1173 @param[in] Guid A pointer to the GUID being registered.
1174 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1176 @retval EFI_SUCCESS The operation was successful.
1177 @retval EFI_INVALID_PARAMETER Guid was NULL.
1178 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1179 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1183 EfiShellRegisterGuidName(
1184 IN CONST EFI_GUID
*Guid
,
1185 IN CONST CHAR16
*GuidName
1188 return (AddNewGuidNameMapping(Guid
, GuidName
, NULL
));
1192 Opens a file or a directory by file name.
1194 This function opens the specified file in the specified OpenMode and returns a file
1196 If the file name begins with >v, then the file handle which is returned refers to the
1197 shell environment variable with the specified name. If the shell environment variable
1198 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1199 EFI_INVALID_PARAMETER is returned.
1201 If the file name is >i, then the file handle which is returned refers to the standard
1202 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1205 If the file name is >o, then the file handle which is returned refers to the standard
1206 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1209 If the file name is >e, then the file handle which is returned refers to the standard
1210 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1213 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1214 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1217 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1220 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1221 @param FileHandle On return, points to the file handle.
1222 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1223 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1225 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1226 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1227 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1228 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1229 system could not be found on the device. FileHandle is NULL.
1230 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1231 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1232 longer supported. FileHandle is NULL.
1233 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1234 the FileName. FileHandle is NULL.
1235 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1236 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1237 when the media is write-protected. FileHandle is NULL.
1238 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1239 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1241 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1245 EfiShellOpenFileByName(
1246 IN CONST CHAR16
*FileName
,
1247 OUT SHELL_FILE_HANDLE
*FileHandle
,
1251 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1258 // Is this for StdIn
1260 if (StrCmp(FileName
, L
">i") == 0) {
1262 // make sure not writing to StdIn
1264 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1265 return (EFI_INVALID_PARAMETER
);
1267 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1268 ASSERT(*FileHandle
!= NULL
);
1269 return (EFI_SUCCESS
);
1273 // Is this for StdOut
1275 if (StrCmp(FileName
, L
">o") == 0) {
1277 // make sure not writing to StdIn
1279 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1280 return (EFI_INVALID_PARAMETER
);
1282 *FileHandle
= &FileInterfaceStdOut
;
1283 return (EFI_SUCCESS
);
1287 // Is this for NUL / NULL file
1289 if ((gUnicodeCollation
->StriColl (gUnicodeCollation
, (CHAR16
*)FileName
, L
"NUL") == 0) ||
1290 (gUnicodeCollation
->StriColl (gUnicodeCollation
, (CHAR16
*)FileName
, L
"NULL") == 0)) {
1291 *FileHandle
= &FileInterfaceNulFile
;
1292 return (EFI_SUCCESS
);
1296 // Is this for StdErr
1298 if (StrCmp(FileName
, L
">e") == 0) {
1300 // make sure not writing to StdIn
1302 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1303 return (EFI_INVALID_PARAMETER
);
1305 *FileHandle
= &FileInterfaceStdErr
;
1306 return (EFI_SUCCESS
);
1310 // Is this for an environment variable
1311 // do we start with >v
1313 if (StrStr(FileName
, L
">v") == FileName
) {
1314 Status
= IsVolatileEnv (FileName
+ 2, &Volatile
);
1315 if (EFI_ERROR (Status
)) {
1319 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1320 return (EFI_INVALID_PARAMETER
);
1322 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1323 return (EFI_SUCCESS
);
1327 // We are opening a regular file.
1329 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1330 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1331 if (DevicePath
== NULL
) {
1332 return (EFI_NOT_FOUND
);
1336 // Copy the device path, open the file, then free the memory
1338 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1339 FreePool(DevicePath
);
1345 Deletes the file specified by the file name.
1347 This function deletes a file.
1349 @param FileName Points to the NULL-terminated file name.
1351 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1352 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1353 @sa EfiShellCreateFile
1357 EfiShellDeleteFileByName(
1358 IN CONST CHAR16
*FileName
1361 SHELL_FILE_HANDLE FileHandle
;
1367 // get a handle to the file
1369 Status
= EfiShellCreateFile(FileName
,
1372 if (EFI_ERROR(Status
)) {
1376 // now delete the file
1378 ShellFileHandleRemove(FileHandle
);
1379 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1383 Disables the page break output mode.
1387 EfiShellDisablePageBreak (
1391 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1395 Enables the page break output mode.
1399 EfiShellEnablePageBreak (
1403 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1407 internal worker function to load and run an image via device path.
1409 @param ParentImageHandle A handle of the image that is executing the specified
1411 @param DevicePath device path of the file to execute
1412 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1413 containing the command line. If NULL then the command-
1415 @param Environment Points to a NULL-terminated array of environment
1416 variables with the format 'x=y', where x is the
1417 environment variable name and y is the value. If this
1418 is NULL, then the current shell environment is used.
1420 @param[out] StartImageStatus Returned status from gBS->StartImage.
1422 @retval EFI_SUCCESS The command executed successfully. The status code
1423 returned by the command is pointed to by StatusCode.
1424 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1425 @retval EFI_OUT_OF_RESOURCES Out of resources.
1426 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1429 InternalShellExecuteDevicePath(
1430 IN CONST EFI_HANDLE
*ParentImageHandle
,
1431 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1432 IN CONST CHAR16
*CommandLine OPTIONAL
,
1433 IN CONST CHAR16
**Environment OPTIONAL
,
1434 OUT EFI_STATUS
*StartImageStatus OPTIONAL
1438 EFI_STATUS StartStatus
;
1439 EFI_STATUS CleanupStatus
;
1440 EFI_HANDLE NewHandle
;
1441 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1442 LIST_ENTRY OrigEnvs
;
1443 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1449 if (ParentImageHandle
== NULL
) {
1450 return (EFI_INVALID_PARAMETER
);
1453 InitializeListHead(&OrigEnvs
);
1454 ZeroMem(&ShellParamsProtocol
, sizeof(EFI_SHELL_PARAMETERS_PROTOCOL
));
1458 NewCmdLine
= AllocateCopyPool (StrSize (CommandLine
), CommandLine
);
1459 if (NewCmdLine
== NULL
) {
1460 return EFI_OUT_OF_RESOURCES
;
1463 for (Walker
= NewCmdLine
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
1464 if (*Walker
== L
'^' && *(Walker
+1) == L
'#') {
1465 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));
1470 // Load the image with:
1471 // FALSE - not from boot manager and NULL, 0 being not already in memory
1473 Status
= gBS
->LoadImage(
1476 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1481 if (EFI_ERROR(Status
)) {
1482 if (NewHandle
!= NULL
) {
1483 gBS
->UnloadImage(NewHandle
);
1485 FreePool (NewCmdLine
);
1488 Status
= gBS
->OpenProtocol(
1490 &gEfiLoadedImageProtocolGuid
,
1491 (VOID
**)&LoadedImage
,
1494 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1496 if (!EFI_ERROR(Status
)) {
1498 // If the image is not an app abort it.
1500 if (LoadedImage
->ImageCodeType
!= EfiLoaderCode
){
1505 STRING_TOKEN (STR_SHELL_IMAGE_NOT_APP
),
1506 ShellInfoObject
.HiiHandle
1511 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1512 if (NewCmdLine
!= NULL
) {
1513 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(NewCmdLine
);
1514 LoadedImage
->LoadOptions
= (VOID
*)NewCmdLine
;
1518 // Save our current environment settings for later restoration if necessary
1520 if (Environment
!= NULL
) {
1521 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1522 if (!EFI_ERROR(Status
)) {
1523 Status
= SetEnvironmentVariables(Environment
);
1528 // Initialize and install a shell parameters protocol on the image.
1530 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1531 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1532 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1533 Status
= UpdateArgcArgv(&ShellParamsProtocol
, NewCmdLine
, Efi_Application
, NULL
, NULL
);
1534 ASSERT_EFI_ERROR(Status
);
1536 // Replace Argv[0] with the full path of the binary we're executing:
1537 // If the command line was "foo", the binary might be called "foo.efi".
1538 // "The first entry in [Argv] is always the full file path of the
1539 // executable" - UEFI Shell Spec section 2.3
1541 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1542 // The image we're executing isn't necessarily in a filesystem - it might
1543 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1544 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1545 if (ImagePath
!= NULL
) {
1546 if (ShellParamsProtocol
.Argv
== NULL
) {
1547 // Command line was empty or null.
1548 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1549 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1550 if (ShellParamsProtocol
.Argv
== NULL
) {
1551 Status
= EFI_OUT_OF_RESOURCES
;
1554 ShellParamsProtocol
.Argc
= 1;
1556 // Free the string UpdateArgcArgv put in Argv[0];
1557 FreePool (ShellParamsProtocol
.Argv
[0]);
1559 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1562 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1563 ASSERT_EFI_ERROR(Status
);
1565 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1568 // now start the image and if the caller wanted the return code pass it to them...
1570 if (!EFI_ERROR(Status
)) {
1571 StartStatus
= gBS
->StartImage(
1576 if (StartImageStatus
!= NULL
) {
1577 *StartImageStatus
= StartStatus
;
1580 CleanupStatus
= gBS
->UninstallProtocolInterface(
1582 &gEfiShellParametersProtocolGuid
,
1583 &ShellParamsProtocol
1585 ASSERT_EFI_ERROR(CleanupStatus
);
1591 // Unload image - We should only get here if we didn't call StartImage
1592 gBS
->UnloadImage (NewHandle
);
1595 // Free Argv (Allocated in UpdateArgcArgv)
1596 if (ShellParamsProtocol
.Argv
!= NULL
) {
1597 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1598 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1599 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1602 FreePool (ShellParamsProtocol
.Argv
);
1606 // Restore environment variables
1607 if (!IsListEmpty(&OrigEnvs
)) {
1608 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1609 ASSERT_EFI_ERROR (CleanupStatus
);
1612 FreePool (NewCmdLine
);
1618 internal worker function to load and run an image in the current shell.
1620 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1621 containing the command line. If NULL then the command-
1623 @param Environment Points to a NULL-terminated array of environment
1624 variables with the format 'x=y', where x is the
1625 environment variable name and y is the value. If this
1626 is NULL, then the current shell environment is used.
1628 @param[out] StartImageStatus Returned status from the command line.
1630 @retval EFI_SUCCESS The command executed successfully. The status code
1631 returned by the command is pointed to by StatusCode.
1632 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1633 @retval EFI_OUT_OF_RESOURCES Out of resources.
1634 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1637 InternalShellExecute(
1638 IN CONST CHAR16
*CommandLine OPTIONAL
,
1639 IN CONST CHAR16
**Environment OPTIONAL
,
1640 OUT EFI_STATUS
*StartImageStatus OPTIONAL
1644 EFI_STATUS CleanupStatus
;
1645 LIST_ENTRY OrigEnvs
;
1647 InitializeListHead(&OrigEnvs
);
1650 // Save our current environment settings for later restoration if necessary
1652 if (Environment
!= NULL
) {
1653 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1654 if (!EFI_ERROR(Status
)) {
1655 Status
= SetEnvironmentVariables(Environment
);
1661 Status
= RunShellCommand(CommandLine
, StartImageStatus
);
1663 // Restore environment variables
1664 if (!IsListEmpty(&OrigEnvs
)) {
1665 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1666 ASSERT_EFI_ERROR (CleanupStatus
);
1673 Determine if the UEFI Shell is currently running with nesting enabled or disabled.
1675 @retval FALSE nesting is required
1676 @retval other nesting is enabled
1693 if (ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoNest
) {
1696 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(mNoNestingEnvVarName
, &TempSize
, Temp
);
1697 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1698 Temp
= AllocateZeroPool(TempSize
+ sizeof(CHAR16
));
1700 Status
= SHELL_GET_ENVIRONMENT_VARIABLE(mNoNestingEnvVarName
, &TempSize
, Temp
);
1703 Temp2
= StrnCatGrow(&Temp2
, NULL
, mNoNestingTrue
, 0);
1704 if (Temp
!= NULL
&& Temp2
!= NULL
&& StringNoCaseCompare(&Temp
, &Temp2
) == 0) {
1706 // Use the no nesting method.
1712 SHELL_FREE_NON_NULL(Temp
);
1713 SHELL_FREE_NON_NULL(Temp2
);
1718 Execute the command line.
1720 This function creates a nested instance of the shell and executes the specified
1721 command (CommandLine) with the specified environment (Environment). Upon return,
1722 the status code returned by the specified command is placed in StatusCode.
1724 If Environment is NULL, then the current environment is used and all changes made
1725 by the commands executed will be reflected in the current environment. If the
1726 Environment is non-NULL, then the changes made will be discarded.
1728 The CommandLine is executed from the current working directory on the current
1731 @param ParentImageHandle A handle of the image that is executing the specified
1733 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1734 containing the command line. If NULL then the command-
1736 @param Environment Points to a NULL-terminated array of environment
1737 variables with the format 'x=y', where x is the
1738 environment variable name and y is the value. If this
1739 is NULL, then the current shell environment is used.
1740 @param StatusCode Points to the status code returned by the CommandLine.
1742 @retval EFI_SUCCESS The command executed successfully. The status code
1743 returned by the command is pointed to by StatusCode.
1744 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1745 @retval EFI_OUT_OF_RESOURCES Out of resources.
1746 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1747 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1749 @sa InternalShellExecuteDevicePath
1754 IN EFI_HANDLE
*ParentImageHandle
,
1755 IN CHAR16
*CommandLine OPTIONAL
,
1756 IN CHAR16
**Environment OPTIONAL
,
1757 OUT EFI_STATUS
*StatusCode OPTIONAL
1762 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1765 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1766 return (EFI_UNSUPPORTED
);
1769 if (NestingEnabled()) {
1770 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1773 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1775 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1777 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1783 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1784 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -exit ", 0);
1785 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1787 Status
= InternalShellExecuteDevicePath(
1791 (CONST CHAR16
**)Environment
,
1795 // de-allocate and return
1800 Status
= InternalShellExecute(
1801 (CONST CHAR16
*)CommandLine
,
1802 (CONST CHAR16
**)Environment
,
1810 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1812 1) frees all pointers (non-NULL)
1813 2) Closes the SHELL_FILE_HANDLE
1815 @param FileListNode pointer to the list node to free
1818 InternalFreeShellFileInfoNode(
1819 IN EFI_SHELL_FILE_INFO
*FileListNode
1822 if (FileListNode
->Info
!= NULL
) {
1823 FreePool((VOID
*)FileListNode
->Info
);
1825 if (FileListNode
->FileName
!= NULL
) {
1826 FreePool((VOID
*)FileListNode
->FileName
);
1828 if (FileListNode
->FullName
!= NULL
) {
1829 FreePool((VOID
*)FileListNode
->FullName
);
1831 if (FileListNode
->Handle
!= NULL
) {
1832 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1834 FreePool(FileListNode
);
1837 Frees the file list.
1839 This function cleans up the file list and any related data structures. It has no
1840 impact on the files themselves.
1842 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1843 defined in OpenFileList()
1845 @retval EFI_SUCCESS Free the file list successfully.
1846 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1850 EfiShellFreeFileList(
1851 IN EFI_SHELL_FILE_INFO
**FileList
1854 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1856 if (FileList
== NULL
|| *FileList
== NULL
) {
1857 return (EFI_INVALID_PARAMETER
);
1860 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1861 ; !IsListEmpty(&(*FileList
)->Link
)
1862 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1864 RemoveEntryList(&ShellFileListItem
->Link
);
1865 InternalFreeShellFileInfoNode(ShellFileListItem
);
1867 InternalFreeShellFileInfoNode(*FileList
);
1869 return(EFI_SUCCESS
);
1873 Deletes the duplicate file names files in the given file list.
1875 This function deletes the reduplicate files in the given file list.
1877 @param FileList A pointer to the first entry in the file list.
1879 @retval EFI_SUCCESS Always success.
1880 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1884 EfiShellRemoveDupInFileList(
1885 IN EFI_SHELL_FILE_INFO
**FileList
1888 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1889 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1890 EFI_SHELL_FILE_INFO
*TempNode
;
1892 if (FileList
== NULL
|| *FileList
== NULL
) {
1893 return (EFI_INVALID_PARAMETER
);
1895 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1896 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1897 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1899 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1900 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1901 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1903 if (gUnicodeCollation
->StriColl(
1905 (CHAR16
*)ShellFileListItem
->FullName
,
1906 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1908 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1910 &ShellFileListItem2
->Link
1912 RemoveEntryList(&ShellFileListItem2
->Link
);
1913 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1914 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1915 // memory in GetNextNode in the loop expression above.
1916 ShellFileListItem2
= TempNode
;
1920 return (EFI_SUCCESS
);
1924 // This is the same structure as the external version, but it has no CONST qualifiers.
1927 LIST_ENTRY Link
; ///< Linked list members.
1928 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1929 CHAR16
*FullName
; ///< Fully qualified filename.
1930 CHAR16
*FileName
; ///< name of this file.
1931 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1932 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1933 } EFI_SHELL_FILE_INFO_NO_CONST
;
1936 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1938 @param[in] Node The node to copy from.
1939 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1941 @retval NULL a memory allocation error ocurred
1942 @return != NULL a pointer to the new node
1944 EFI_SHELL_FILE_INFO
*
1945 InternalDuplicateShellFileInfo(
1946 IN EFI_SHELL_FILE_INFO
*Node
,
1950 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1953 // try to confirm that the objects are in sync
1955 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1957 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1958 if (NewNode
== NULL
) {
1961 NewNode
->FullName
= AllocateCopyPool(StrSize(Node
->FullName
), Node
->FullName
);
1962 NewNode
->FileName
= AllocateCopyPool(StrSize(Node
->FileName
), Node
->FileName
);
1963 NewNode
->Info
= AllocateCopyPool((UINTN
)Node
->Info
->Size
, Node
->Info
);
1964 if ( NewNode
->FullName
== NULL
1965 || NewNode
->FileName
== NULL
1966 || NewNode
->Info
== NULL
1968 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1969 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1970 SHELL_FREE_NON_NULL(NewNode
->Info
);
1971 SHELL_FREE_NON_NULL(NewNode
);
1974 NewNode
->Status
= Node
->Status
;
1975 NewNode
->Handle
= Node
->Handle
;
1977 Node
->Handle
= NULL
;
1980 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1984 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1985 failed it will return NULL.
1987 @param[in] BasePath the Path to prepend onto filename for FullPath
1988 @param[in] Status Status member initial value.
1989 @param[in] FileName FileName member initial value.
1990 @param[in] Handle Handle member initial value.
1991 @param[in] Info Info struct to copy.
1993 @retval NULL An error ocurred.
1994 @return a pointer to the newly allocated structure.
1996 EFI_SHELL_FILE_INFO
*
1997 CreateAndPopulateShellFileInfo(
1998 IN CONST CHAR16
*BasePath
,
1999 IN CONST EFI_STATUS Status
,
2000 IN CONST CHAR16
*FileName
,
2001 IN CONST SHELL_FILE_HANDLE Handle
,
2002 IN CONST EFI_FILE_INFO
*Info
2005 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2012 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2013 if (ShellFileListItem
== NULL
) {
2016 if (Info
!= NULL
&& Info
->Size
!= 0) {
2017 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
2018 if (ShellFileListItem
->Info
== NULL
) {
2019 FreePool(ShellFileListItem
);
2022 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
2024 ShellFileListItem
->Info
= NULL
;
2026 if (FileName
!= NULL
) {
2027 ASSERT(TempString
== NULL
);
2028 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
2029 if (ShellFileListItem
->FileName
== NULL
) {
2030 FreePool(ShellFileListItem
->Info
);
2031 FreePool(ShellFileListItem
);
2035 ShellFileListItem
->FileName
= NULL
;
2039 if (BasePath
!= NULL
) {
2040 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2041 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2042 if (TempString
== NULL
) {
2043 FreePool((VOID
*)ShellFileListItem
->FileName
);
2044 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
2045 FreePool(ShellFileListItem
);
2049 if (ShellFileListItem
->FileName
!= NULL
) {
2050 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
2051 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
2052 if (TempString
== NULL
) {
2053 FreePool((VOID
*)ShellFileListItem
->FileName
);
2054 FreePool(ShellFileListItem
->Info
);
2055 FreePool(ShellFileListItem
);
2060 TempString
= PathCleanUpDirectories(TempString
);
2062 ShellFileListItem
->FullName
= TempString
;
2063 ShellFileListItem
->Status
= Status
;
2064 ShellFileListItem
->Handle
= Handle
;
2066 return (ShellFileListItem
);
2070 Find all files in a specified directory.
2072 @param FileDirHandle Handle of the directory to search.
2073 @param FileList On return, points to the list of files in the directory
2074 or NULL if there are no files in the directory.
2076 @retval EFI_SUCCESS File information was returned successfully.
2077 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
2078 @retval EFI_DEVICE_ERROR The device reported an error.
2079 @retval EFI_NO_MEDIA The device media is not present.
2080 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
2081 @return An error from FileHandleGetFileName().
2085 EfiShellFindFilesInDir(
2086 IN SHELL_FILE_HANDLE FileDirHandle
,
2087 OUT EFI_SHELL_FILE_INFO
**FileList
2090 EFI_SHELL_FILE_INFO
*ShellFileList
;
2091 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2092 EFI_FILE_INFO
*FileInfo
;
2101 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
2102 if (EFI_ERROR(Status
)) {
2106 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
2109 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
2110 if (TempString
== NULL
) {
2111 SHELL_FREE_NON_NULL(BasePath
);
2112 return (EFI_OUT_OF_RESOURCES
);
2114 TempSpot
= StrStr(TempString
, L
";");
2116 if (TempSpot
!= NULL
) {
2117 *TempSpot
= CHAR_NULL
;
2120 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2121 if (TempString
== NULL
) {
2122 SHELL_FREE_NON_NULL(BasePath
);
2123 return (EFI_OUT_OF_RESOURCES
);
2125 SHELL_FREE_NON_NULL(BasePath
);
2126 BasePath
= TempString
;
2130 ShellFileList
= NULL
;
2131 ShellFileListItem
= NULL
;
2133 Status
= EFI_SUCCESS
;
2136 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2137 ; !EFI_ERROR(Status
) && !NoFile
2138 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2140 if (ShellFileList
== NULL
) {
2141 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2142 if (ShellFileList
== NULL
) {
2143 SHELL_FREE_NON_NULL (BasePath
);
2144 return EFI_OUT_OF_RESOURCES
;
2146 InitializeListHead(&ShellFileList
->Link
);
2149 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2151 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2153 EFI_SUCCESS
, // success since we didnt fail to open it...
2155 NULL
, // no handle since not open
2157 if (ShellFileListItem
== NULL
) {
2158 Status
= EFI_OUT_OF_RESOURCES
;
2160 // Free resources outside the loop.
2164 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2166 if (EFI_ERROR(Status
)) {
2167 EfiShellFreeFileList(&ShellFileList
);
2170 *FileList
= ShellFileList
;
2172 SHELL_FREE_NON_NULL(BasePath
);
2177 Get the GUID value from a human readable name.
2179 If GuidName is a known GUID name, then update Guid to have the correct value for
2182 This function is only available when the major and minor versions in the
2183 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2185 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2186 @param[out] Guid A pointer to the GUID structure to be filled in.
2188 @retval EFI_SUCCESS The operation was successful.
2189 @retval EFI_INVALID_PARAMETER Guid was NULL.
2190 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2191 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2195 EfiShellGetGuidFromName(
2196 IN CONST CHAR16
*GuidName
,
2203 if (Guid
== NULL
|| GuidName
== NULL
) {
2204 return (EFI_INVALID_PARAMETER
);
2207 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2209 if (!EFI_ERROR(Status
)) {
2210 CopyGuid(Guid
, NewGuid
);
2217 Get the human readable name for a GUID from the value.
2219 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2220 should not modify the value.
2222 This function is only available when the major and minor versions in the
2223 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2225 @param[in] Guid A pointer to the GUID being queried.
2226 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2228 @retval EFI_SUCCESS The operation was successful.
2229 @retval EFI_INVALID_PARAMETER Guid was NULL.
2230 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2231 @retval EFI_NOT_FOUND Guid is not assigned a name.
2235 EfiShellGetGuidName(
2236 IN CONST EFI_GUID
*Guid
,
2237 OUT CONST CHAR16
**GuidName
2242 if (Guid
== NULL
|| GuidName
== NULL
) {
2243 return (EFI_INVALID_PARAMETER
);
2246 Name
= GetStringNameFromGuid(Guid
, NULL
);
2247 if (Name
== NULL
|| StrLen(Name
) == 0) {
2248 SHELL_FREE_NON_NULL(Name
);
2249 return (EFI_NOT_FOUND
);
2252 *GuidName
= AddBufferToFreeList(Name
);
2254 return (EFI_SUCCESS
);
2258 Updates a file name to be preceeded by the mapped drive name
2260 @param[in] BasePath the Mapped drive name to prepend
2261 @param[in, out] Path pointer to pointer to the file name to update.
2264 @retval EFI_OUT_OF_RESOURCES
2268 IN CONST CHAR16
*BasePath
,
2269 IN OUT CHAR16
**Path
2278 ASSERT(Path
!= NULL
);
2279 ASSERT(*Path
!= NULL
);
2280 ASSERT(BasePath
!= NULL
);
2283 // convert a local path to an absolute path
2285 if (StrStr(*Path
, L
":") == NULL
) {
2286 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2287 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2288 if (Path2
== NULL
) {
2289 return (EFI_OUT_OF_RESOURCES
);
2291 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2292 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2293 if (Path2
== NULL
) {
2294 return (EFI_OUT_OF_RESOURCES
);
2301 return (EFI_SUCCESS
);
2305 If FileHandle is a directory then the function reads from FileHandle and reads in
2306 each of the FileInfo structures. If one of them matches the Pattern's first
2307 "level" then it opens that handle and calls itself on that handle.
2309 If FileHandle is a file and matches all of the remaining Pattern (which would be
2310 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2312 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2313 FreeFileList with FileList.
2315 @param[in] FilePattern The FilePattern to check against.
2316 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2317 @param[in] FileHandle The FileHandle to start with
2318 @param[in, out] FileList pointer to pointer to list of found files.
2319 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2320 @param[in] MapName The file system name this file is on.
2322 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2323 @retval EFI_NOT_FOUND no files were found
2324 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2328 IN CONST CHAR16
*FilePattern
,
2329 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2330 IN SHELL_FILE_HANDLE FileHandle
,
2331 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2332 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2333 IN CONST CHAR16
*MapName
2337 CONST CHAR16
*NextFilePatternStart
;
2338 CHAR16
*CurrentFilePattern
;
2339 EFI_SHELL_FILE_INFO
*ShellInfo
;
2340 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2341 EFI_SHELL_FILE_INFO
*NewShellNode
;
2342 EFI_FILE_INFO
*FileInfo
;
2344 CHAR16
*NewFullName
;
2347 if ( FilePattern
== NULL
2348 || UnicodeCollation
== NULL
2351 return (EFI_INVALID_PARAMETER
);
2354 CurrentFilePattern
= NULL
;
2356 if (*FilePattern
== L
'\\') {
2360 for( NextFilePatternStart
= FilePattern
2361 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2362 ; NextFilePatternStart
++);
2364 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2365 if (CurrentFilePattern
== NULL
) {
2366 return EFI_OUT_OF_RESOURCES
;
2369 StrnCpyS(CurrentFilePattern
, NextFilePatternStart
-FilePattern
+1, FilePattern
, NextFilePatternStart
-FilePattern
);
2371 if (CurrentFilePattern
[0] == CHAR_NULL
2372 &&NextFilePatternStart
[0] == CHAR_NULL
2375 // we want the parent or root node (if no parent)
2377 if (ParentNode
== NULL
) {
2379 // We want the root node. create the node.
2381 FileInfo
= FileHandleGetInfo(FileHandle
);
2382 NewShellNode
= CreateAndPopulateShellFileInfo(
2389 SHELL_FREE_NON_NULL(FileInfo
);
2392 // Add the current parameter FileHandle to the list, then end...
2394 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2396 if (NewShellNode
== NULL
) {
2397 Status
= EFI_OUT_OF_RESOURCES
;
2399 NewShellNode
->Handle
= NULL
;
2400 if (*FileList
== NULL
) {
2401 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2402 InitializeListHead(&((*FileList
)->Link
));
2406 // Add to the returning to use list
2408 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2410 Status
= EFI_SUCCESS
;
2413 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2415 if (!EFI_ERROR(Status
)){
2416 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2421 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2422 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2423 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2425 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2426 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2427 Size
= StrSize (ShellInfoNode
->FullName
) + StrSize (MapName
);
2428 NewFullName
= AllocateZeroPool(Size
);
2429 if (NewFullName
== NULL
) {
2430 Status
= EFI_OUT_OF_RESOURCES
;
2432 StrCpyS(NewFullName
, Size
/ sizeof(CHAR16
), MapName
);
2433 StrCatS(NewFullName
, Size
/ sizeof(CHAR16
), ShellInfoNode
->FullName
);
2434 FreePool ((VOID
*) ShellInfoNode
->FullName
);
2435 ShellInfoNode
->FullName
= NewFullName
;
2438 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2440 // should be a directory
2444 // don't open the . and .. directories
2446 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2447 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2452 if (EFI_ERROR(Status
)) {
2456 // Open the directory since we need that handle in the next recursion.
2458 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2461 // recurse with the next part of the pattern
2463 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2464 EfiShellClose(ShellInfoNode
->Handle
);
2465 ShellInfoNode
->Handle
= NULL
;
2467 } else if (!EFI_ERROR(Status
)) {
2473 // copy the information we need into a new Node
2475 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2476 if (NewShellNode
== NULL
) {
2477 Status
= EFI_OUT_OF_RESOURCES
;
2479 if (*FileList
== NULL
) {
2480 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2481 InitializeListHead(&((*FileList
)->Link
));
2485 // Add to the returning to use list
2487 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2490 if (EFI_ERROR(Status
)) {
2494 if (EFI_ERROR(Status
)) {
2495 EfiShellFreeFileList(&ShellInfo
);
2497 Status
= EfiShellFreeFileList(&ShellInfo
);
2502 if (*FileList
== NULL
|| (*FileList
!= NULL
&& IsListEmpty(&(*FileList
)->Link
))) {
2503 Status
= EFI_NOT_FOUND
;
2506 FreePool(CurrentFilePattern
);
2511 Find files that match a specified pattern.
2513 This function searches for all files and directories that match the specified
2514 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2515 information is placed in the file list FileList.
2517 Wildcards are processed
2518 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2520 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2521 field is set to NULL.
2523 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2525 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2526 @param FileList On return, points to the start of a file list containing the names
2527 of all matching files or else points to NULL if no matching files
2528 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2530 @retval EFI_SUCCESS Files found. FileList is a valid list.
2531 @retval EFI_NOT_FOUND No files found.
2532 @retval EFI_NO_MEDIA The device has no media
2533 @retval EFI_DEVICE_ERROR The device reported an error
2534 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2539 IN CONST CHAR16
*FilePattern
,
2540 OUT EFI_SHELL_FILE_INFO
**FileList
2544 CHAR16
*PatternCopy
;
2545 CHAR16
*PatternCurrentLocation
;
2546 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2547 SHELL_FILE_HANDLE RootFileHandle
;
2551 if ( FilePattern
== NULL
2553 || StrStr(FilePattern
, L
":") == NULL
2555 return (EFI_INVALID_PARAMETER
);
2557 Status
= EFI_SUCCESS
;
2558 RootDevicePath
= NULL
;
2559 RootFileHandle
= NULL
;
2561 PatternCopy
= AllocateCopyPool(StrSize(FilePattern
), FilePattern
);
2562 if (PatternCopy
== NULL
) {
2563 return (EFI_OUT_OF_RESOURCES
);
2566 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2568 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
+ 1;
2569 ASSERT (Count
<= StrLen (PatternCopy
));
2571 ASSERT(MapName
== NULL
);
2572 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2573 if (MapName
== NULL
) {
2574 Status
= EFI_OUT_OF_RESOURCES
;
2576 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2577 if (RootDevicePath
== NULL
) {
2578 Status
= EFI_INVALID_PARAMETER
;
2580 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2581 if (!EFI_ERROR(Status
)) {
2582 for ( PatternCurrentLocation
= PatternCopy
2583 ; *PatternCurrentLocation
!= ':'
2584 ; PatternCurrentLocation
++);
2585 PatternCurrentLocation
++;
2586 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2587 EfiShellClose(RootFileHandle
);
2589 FreePool(RootDevicePath
);
2593 SHELL_FREE_NON_NULL(PatternCopy
);
2594 SHELL_FREE_NON_NULL(MapName
);
2600 Opens the files that match the path specified.
2602 This function opens all of the files specified by Path. Wildcards are processed
2603 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2604 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2606 @param Path A pointer to the path string.
2607 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2608 EFI_FILE_MODE_WRITE.
2609 @param FileList Points to the start of a list of files opened.
2611 @retval EFI_SUCCESS Create the file list successfully.
2612 @return Others Can't create the file list.
2616 EfiShellOpenFileList(
2619 IN OUT EFI_SHELL_FILE_INFO
**FileList
2623 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2626 CONST CHAR16
*CurDir
;
2629 PathCleanUpDirectories(Path
);
2634 if (FileList
== NULL
|| *FileList
== NULL
) {
2635 return (EFI_INVALID_PARAMETER
);
2638 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2643 // convert a local path to an absolute path
2645 if (StrStr(Path
, L
":") == NULL
) {
2646 CurDir
= EfiShellGetCurDir(NULL
);
2647 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2648 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2649 StrnCatGrow(&Path2
, &Path2Size
, L
"\\", 0);
2650 if (*Path
== L
'\\') {
2652 while (PathRemoveLastItem(Path2
)) ;
2654 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2655 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2657 ASSERT(Path2
== NULL
);
2658 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2661 PathCleanUpDirectories (Path2
);
2666 Status
= EfiShellFindFiles(Path2
, FileList
);
2670 if (EFI_ERROR(Status
)) {
2676 // We had no errors so open all the files (that are not already opened...)
2678 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2679 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2680 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2682 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2683 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2689 return (EFI_NOT_FOUND
);
2691 return(EFI_SUCCESS
);
2695 Gets the environment variable and Attributes, or list of environment variables. Can be
2696 used instead of GetEnv().
2698 This function returns the current value of the specified environment variable and
2699 the Attributes. If no variable name was specified, then all of the known
2700 variables will be returned.
2702 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2703 then the function will return all of the defined shell
2704 environment variables. In the case where multiple environment
2705 variables are being returned, each variable will be terminated
2706 by a NULL, and the list will be terminated by a double NULL.
2707 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2708 the environment variable. In the case where Name is NULL, and
2709 multiple environment variables are being returned, Attributes
2712 @retval NULL The environment variable doesn't exist.
2713 @return A non-NULL value points to the variable's value. The returned
2714 pointer does not need to be freed by the caller.
2719 IN CONST CHAR16
*Name
,
2720 OUT UINT32
*Attributes OPTIONAL
2727 CHAR16
*CurrentWriteLocation
;
2735 // Build the semi-colon delimited list. (2 passes)
2737 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&gShellEnvVarList
.Link
)
2738 ; !IsNull(&gShellEnvVarList
.Link
, &Node
->Link
)
2739 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&gShellEnvVarList
.Link
, &Node
->Link
)
2741 ASSERT(Node
->Key
!= NULL
);
2742 Size
+= StrSize(Node
->Key
);
2745 Size
+= 2*sizeof(CHAR16
);
2747 Buffer
= AllocateZeroPool(Size
);
2748 if (Buffer
== NULL
) {
2751 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2753 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&gShellEnvVarList
.Link
)
2754 ; !IsNull(&gShellEnvVarList
.Link
, &Node
->Link
)
2755 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&gShellEnvVarList
.Link
, &Node
->Link
)
2757 ASSERT(Node
->Key
!= NULL
);
2758 StrCpyS( CurrentWriteLocation
,
2759 (Size
)/sizeof(CHAR16
) - (CurrentWriteLocation
- ((CHAR16
*)Buffer
)),
2762 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2767 // We are doing a specific environment variable
2769 Status
= ShellFindEnvVarInList(Name
, (CHAR16
**)&Buffer
, &Size
, Attributes
);
2771 if (EFI_ERROR(Status
)){
2773 // get the size we need for this EnvVariable
2775 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2776 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2778 // Allocate the space and recall the get function
2780 Buffer
= AllocateZeroPool(Size
);
2781 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2784 // we didnt get it (might not exist)
2785 // free the memory if we allocated any and return NULL
2787 if (EFI_ERROR(Status
)) {
2788 if (Buffer
!= NULL
) {
2794 // If we did not find the environment variable in the gShellEnvVarList
2795 // but get it from UEFI variable storage successfully then we need update
2796 // the gShellEnvVarList.
2798 ShellFreeEnvVarList ();
2799 Status
= ShellInitEnvVarList ();
2800 ASSERT (Status
== EFI_SUCCESS
);
2806 // return the buffer
2808 return (AddBufferToFreeList(Buffer
));
2812 Gets either a single or list of environment variables.
2814 If name is not NULL then this function returns the current value of the specified
2815 environment variable.
2817 If Name is NULL, then a list of all environment variable names is returned. Each is a
2818 NULL terminated string with a double NULL terminating the list.
2820 @param Name A pointer to the environment variable name. If
2821 Name is NULL, then the function will return all
2822 of the defined shell environment variables. In
2823 the case where multiple environment variables are
2824 being returned, each variable will be terminated by
2825 a NULL, and the list will be terminated by a double
2828 @retval !=NULL A pointer to the returned string.
2829 The returned pointer does not need to be freed by the caller.
2831 @retval NULL The environment variable doesn't exist or there are
2832 no environment variables.
2837 IN CONST CHAR16
*Name
2840 return (EfiShellGetEnvEx(Name
, NULL
));
2844 Internal variable setting function. Allows for setting of the read only variables.
2846 @param Name Points to the NULL-terminated environment variable name.
2847 @param Value Points to the NULL-terminated environment variable value. If the value is an
2848 empty string then the environment variable is deleted.
2849 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2851 @retval EFI_SUCCESS The environment variable was successfully updated.
2854 InternalEfiShellSetEnv(
2855 IN CONST CHAR16
*Name
,
2856 IN CONST CHAR16
*Value
,
2862 if (Value
== NULL
|| StrLen(Value
) == 0) {
2863 Status
= SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2864 if (!EFI_ERROR(Status
)) {
2865 ShellRemvoeEnvVarFromList(Name
);
2868 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2869 Status
= ShellAddEnvVarToList(
2870 Name
, Value
, StrSize(Value
),
2871 EFI_VARIABLE_BOOTSERVICE_ACCESS
| (Volatile
? 0 : EFI_VARIABLE_NON_VOLATILE
)
2873 if (!EFI_ERROR (Status
)) {
2875 ? SHELL_SET_ENVIRONMENT_VARIABLE_V (Name
, StrSize (Value
) - sizeof (CHAR16
), Value
)
2876 : SHELL_SET_ENVIRONMENT_VARIABLE_NV (Name
, StrSize (Value
) - sizeof (CHAR16
), Value
);
2877 if (EFI_ERROR (Status
)) {
2878 ShellRemvoeEnvVarFromList(Name
);
2886 Sets the environment variable.
2888 This function changes the current value of the specified environment variable. If the
2889 environment variable exists and the Value is an empty string, then the environment
2890 variable is deleted. If the environment variable exists and the Value is not an empty
2891 string, then the value of the environment variable is changed. If the environment
2892 variable does not exist and the Value is an empty string, there is no action. If the
2893 environment variable does not exist and the Value is a non-empty string, then the
2894 environment variable is created and assigned the specified value.
2896 For a description of volatile and non-volatile environment variables, see UEFI Shell
2897 2.0 specification section 3.6.1.
2899 @param Name Points to the NULL-terminated environment variable name.
2900 @param Value Points to the NULL-terminated environment variable value. If the value is an
2901 empty string then the environment variable is deleted.
2902 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2904 @retval EFI_SUCCESS The environment variable was successfully updated.
2909 IN CONST CHAR16
*Name
,
2910 IN CONST CHAR16
*Value
,
2914 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2915 return (EFI_INVALID_PARAMETER
);
2918 // Make sure we dont 'set' a predefined read only variable
2920 if (gUnicodeCollation
->StriColl(
2924 ||gUnicodeCollation
->StriColl(
2928 ||gUnicodeCollation
->StriColl(
2932 ||gUnicodeCollation
->StriColl(
2935 L
"uefishellsupport") == 0
2936 ||gUnicodeCollation
->StriColl(
2939 L
"uefishellversion") == 0
2940 ||gUnicodeCollation
->StriColl(
2943 L
"uefiversion") == 0
2944 ||(!ShellInfoObject
.ShellInitSettings
.BitUnion
.Bits
.NoNest
&&
2945 gUnicodeCollation
->StriColl(
2948 (CHAR16
*)mNoNestingEnvVarName
) == 0)
2950 return (EFI_INVALID_PARAMETER
);
2952 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2956 Returns the current directory on the specified device.
2958 If FileSystemMapping is NULL, it returns the current working directory. If the
2959 FileSystemMapping is not NULL, it returns the current directory associated with the
2960 FileSystemMapping. In both cases, the returned name includes the file system
2961 mapping (i.e. fs0:\current-dir).
2963 Note that the current directory string should exclude the tailing backslash character.
2965 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2966 then the current working directory is returned.
2968 @retval !=NULL The current directory.
2969 @retval NULL Current directory does not exist.
2974 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2977 CHAR16
*PathToReturn
;
2979 SHELL_MAP_LIST
*MapListItem
;
2980 if (!IsListEmpty(&gShellMapList
.Link
)) {
2982 // if parameter is NULL, use current
2984 if (FileSystemMapping
== NULL
) {
2985 return (EfiShellGetEnv(L
"cwd"));
2988 PathToReturn
= NULL
;
2989 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2990 if (MapListItem
!= NULL
) {
2991 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2992 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2993 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2996 return (AddBufferToFreeList(PathToReturn
));
3003 Changes the current directory on the specified device.
3005 If the FileSystem is NULL, and the directory Dir does not contain a file system's
3006 mapped name, this function changes the current working directory.
3008 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
3009 current file system and the current directory on that file system are changed.
3011 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
3014 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
3015 directory on the specified file system.
3017 If the current working directory or the current working file system is changed then the
3018 %cwd% environment variable will be updated
3020 Note that the current directory string should exclude the tailing backslash character.
3022 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
3023 directory is changed.
3024 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
3026 @retval EFI_SUCCESS The operation was sucessful
3027 @retval EFI_NOT_FOUND The file system could not be found
3032 IN CONST CHAR16
*FileSystem OPTIONAL
,
3033 IN CONST CHAR16
*Dir
3037 SHELL_MAP_LIST
*MapListItem
;
3041 CHAR16
*DirectoryName
;
3048 DirectoryName
= NULL
;
3050 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
3051 return (EFI_INVALID_PARAMETER
);
3054 if (IsListEmpty(&gShellMapList
.Link
)){
3055 return (EFI_NOT_FOUND
);
3058 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
3059 ASSERT(DirectoryName
!= NULL
);
3061 PathCleanUpDirectories(DirectoryName
);
3063 if (FileSystem
== NULL
) {
3065 // determine the file system mapping to use
3067 if (StrStr(DirectoryName
, L
":") != NULL
) {
3068 ASSERT(MapName
== NULL
);
3069 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
3072 // find the file system mapping's entry in the list
3075 if (MapName
!= NULL
) {
3076 MapListItem
= ShellCommandFindMapItem(MapName
);
3079 // make that the current file system mapping
3081 if (MapListItem
!= NULL
) {
3082 gShellCurDir
= MapListItem
;
3085 MapListItem
= gShellCurDir
;
3088 if (MapListItem
== NULL
) {
3089 FreePool (DirectoryName
);
3090 SHELL_FREE_NON_NULL(MapName
);
3091 return (EFI_NOT_FOUND
);
3095 // now update the MapListItem's current directory
3097 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
3098 FreePool(MapListItem
->CurrentDirectoryPath
);
3099 MapListItem
->CurrentDirectoryPath
= NULL
;
3101 if (MapName
!= NULL
) {
3102 TempLen
= StrLen(MapName
);
3103 if (TempLen
!= StrLen(DirectoryName
)) {
3104 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3105 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
3109 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3110 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3112 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
3113 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3114 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
3115 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
3120 // cant have a mapping in the directory...
3122 if (StrStr(DirectoryName
, L
":") != NULL
) {
3123 FreePool (DirectoryName
);
3124 return (EFI_INVALID_PARAMETER
);
3127 // FileSystem != NULL
3129 MapListItem
= ShellCommandFindMapItem(FileSystem
);
3130 if (MapListItem
== NULL
) {
3131 FreePool (DirectoryName
);
3132 return (EFI_INVALID_PARAMETER
);
3134 // gShellCurDir = MapListItem;
3135 if (DirectoryName
!= NULL
) {
3137 // change current dir on that file system
3140 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
3141 FreePool(MapListItem
->CurrentDirectoryPath
);
3142 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
3144 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3145 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
3146 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3147 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3148 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3149 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3150 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') {
3151 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3152 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
3156 FreePool (DirectoryName
);
3158 // if updated the current directory then update the environment variable
3160 if (MapListItem
== gShellCurDir
) {
3162 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3163 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3164 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3165 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3166 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3167 FreePool(TempString
);
3170 return(EFI_SUCCESS
);
3174 Return help information about a specific command.
3176 This function returns the help information for the specified command. The help text
3177 can be internal to the shell or can be from a UEFI Shell manual page.
3179 If Sections is specified, then each section name listed will be compared in a casesensitive
3180 manner, to the section names described in Appendix B. If the section exists,
3181 it will be appended to the returned help text. If the section does not exist, no
3182 information will be returned. If Sections is NULL, then all help text information
3183 available will be returned.
3185 @param Command Points to the NULL-terminated UEFI Shell command name.
3186 @param Sections Points to the NULL-terminated comma-delimited
3187 section names to return. If NULL, then all
3188 sections will be returned.
3189 @param HelpText On return, points to a callee-allocated buffer
3190 containing all specified help text.
3192 @retval EFI_SUCCESS The help text was returned.
3193 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3195 @retval EFI_INVALID_PARAMETER HelpText is NULL
3196 @retval EFI_NOT_FOUND There is no help text available for Command.
3200 EfiShellGetHelpText(
3201 IN CONST CHAR16
*Command
,
3202 IN CONST CHAR16
*Sections OPTIONAL
,
3203 OUT CHAR16
**HelpText
3206 CONST CHAR16
*ManFileName
;
3210 ASSERT(HelpText
!= NULL
);
3213 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3215 if (ManFileName
!= NULL
) {
3216 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3218 if ((StrLen(Command
)> 4)
3219 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3220 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3221 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3222 && (Command
[StrLen(Command
)-4] == L
'.')
3224 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3225 if (FixCommand
== NULL
) {
3226 return EFI_OUT_OF_RESOURCES
;
3229 StrnCpyS( FixCommand
,
3230 (StrSize(Command
) - 4 * sizeof (CHAR16
))/sizeof(CHAR16
),
3234 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3235 FreePool(FixCommand
);
3238 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3244 Gets the enable status of the page break output mode.
3246 User can use this function to determine current page break mode.
3248 @retval TRUE The page break output mode is enabled.
3249 @retval FALSE The page break output mode is disabled.
3253 EfiShellGetPageBreak(
3257 return(ShellInfoObject
.PageBreakEnabled
);
3261 Judges whether the active shell is the root shell.
3263 This function makes the user to know that whether the active Shell is the root shell.
3265 @retval TRUE The active Shell is the root Shell.
3266 @retval FALSE The active Shell is NOT the root Shell.
3270 EfiShellIsRootShell(
3274 return(ShellInfoObject
.RootShellInstance
);
3278 function to return a semi-colon delimeted list of all alias' in the current shell
3280 up to caller to free the memory.
3282 @retval NULL No alias' were found
3283 @retval NULL An error ocurred getting alias'
3284 @return !NULL a list of all alias'
3287 InternalEfiShellGetListAlias(
3293 CHAR16
*VariableName
;
3295 UINTN NameBufferSize
;
3299 NameBufferSize
= INIT_NAME_BUFFER_SIZE
;
3300 VariableName
= AllocateZeroPool(NameBufferSize
);
3304 if (VariableName
== NULL
) {
3308 VariableName
[0] = CHAR_NULL
;
3311 NameSize
= NameBufferSize
;
3312 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3313 if (Status
== EFI_NOT_FOUND
){
3315 } else if (Status
== EFI_BUFFER_TOO_SMALL
) {
3316 NameBufferSize
= NameSize
> NameBufferSize
* 2 ? NameSize
: NameBufferSize
* 2;
3317 SHELL_FREE_NON_NULL(VariableName
);
3318 VariableName
= AllocateZeroPool(NameBufferSize
);
3319 if (VariableName
== NULL
) {
3320 Status
= EFI_OUT_OF_RESOURCES
;
3321 SHELL_FREE_NON_NULL(RetVal
);
3326 NameSize
= NameBufferSize
;
3327 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3330 if (EFI_ERROR (Status
)) {
3331 SHELL_FREE_NON_NULL(RetVal
);
3336 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3337 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3338 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3339 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3342 SHELL_FREE_NON_NULL(VariableName
);
3348 Convert a null-terminated unicode string, in-place, to all lowercase.
3351 @param Str The null-terminated string to be converted to all lowercase.
3353 @return The null-terminated string converted into all lowercase.
3362 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3363 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3364 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3371 This function returns the command associated with a alias or a list of all
3374 @param[in] Alias Points to the NULL-terminated shell alias.
3375 If this parameter is NULL, then all
3376 aliases will be returned in ReturnedData.
3377 @param[out] Volatile upon return of a single command if TRUE indicates
3378 this is stored in a volatile fashion. FALSE otherwise.
3380 @return If Alias is not NULL, it will return a pointer to
3381 the NULL-terminated command for that alias.
3382 If Alias is NULL, ReturnedData points to a ';'
3383 delimited list of alias (e.g.
3384 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3385 @retval NULL an error ocurred
3386 @retval NULL Alias was not a valid Alias
3391 IN CONST CHAR16
*Alias
,
3392 OUT BOOLEAN
*Volatile OPTIONAL
3402 // Convert to lowercase to make aliases case-insensitive
3403 if (Alias
!= NULL
) {
3404 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3405 if (AliasLower
== NULL
) {
3408 ToLower (AliasLower
);
3410 if (Volatile
== NULL
) {
3411 GetVariable2 (AliasLower
, &gShellAliasGuid
, (VOID
**)&AliasVal
, NULL
);
3412 FreePool(AliasLower
);
3413 return (AddBufferToFreeList(AliasVal
));
3417 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3418 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3419 RetVal
= AllocateZeroPool(RetSize
);
3420 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3422 if (EFI_ERROR(Status
)) {
3423 if (RetVal
!= NULL
) {
3426 FreePool(AliasLower
);
3429 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3435 FreePool (AliasLower
);
3436 return (AddBufferToFreeList(RetVal
));
3438 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3442 Changes a shell command alias.
3444 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3446 this function does not check for built in alias'.
3448 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3449 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3450 Command refers to an alias, that alias will be deleted.
3451 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3452 Alias being set will be stored in a non-volatile fashion.
3454 @retval EFI_SUCCESS Alias created or deleted successfully.
3455 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3459 IN CONST CHAR16
*Command
,
3460 IN CONST CHAR16
*Alias
,
3466 BOOLEAN DeleteAlias
;
3468 DeleteAlias
= FALSE
;
3469 if (Alias
== NULL
) {
3471 // We must be trying to remove one if Alias is NULL
3472 // remove an alias (but passed in COMMAND parameter)
3477 ASSERT (Alias
!= NULL
);
3480 // Convert to lowercase to make aliases case-insensitive
3482 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3483 if (AliasLower
== NULL
) {
3484 return EFI_OUT_OF_RESOURCES
;
3486 ToLower (AliasLower
);
3489 Status
= gRT
->SetVariable (AliasLower
, &gShellAliasGuid
, 0, 0, NULL
);
3491 Status
= gRT
->SetVariable (
3492 AliasLower
, &gShellAliasGuid
,
3493 EFI_VARIABLE_BOOTSERVICE_ACCESS
| (Volatile
? 0 : EFI_VARIABLE_NON_VOLATILE
),
3494 StrSize (Command
), (VOID
*) Command
3498 FreePool (AliasLower
);
3504 Changes a shell command alias.
3506 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3509 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3510 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3511 Command refers to an alias, that alias will be deleted.
3512 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3513 FALSE and the alias already exists, then the existing alias is unchanged and
3514 EFI_ACCESS_DENIED is returned.
3515 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3516 Alias being set will be stored in a non-volatile fashion.
3518 @retval EFI_SUCCESS Alias created or deleted successfully.
3519 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3520 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3522 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3527 IN CONST CHAR16
*Command
,
3528 IN CONST CHAR16
*Alias
,
3533 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3535 // cant set over a built in alias
3537 return (EFI_ACCESS_DENIED
);
3538 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3540 // Command is null or empty
3542 return (EFI_INVALID_PARAMETER
);
3543 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3545 // Alias already exists, Replace not set
3547 return (EFI_ACCESS_DENIED
);
3549 return (InternalSetAlias(Command
, Alias
, Volatile
));
3553 // Pure FILE_HANDLE operations are passed to FileHandleLib
3554 // these functions are indicated by the *
3555 EFI_SHELL_PROTOCOL mShellProtocol
= {
3561 EfiShellGetHelpText
,
3562 EfiShellGetDevicePathFromMap
,
3563 EfiShellGetMapFromDevicePath
,
3564 EfiShellGetDevicePathFromFilePath
,
3565 EfiShellGetFilePathFromDevicePath
,
3569 EfiShellOpenFileList
,
3570 EfiShellFreeFileList
,
3571 EfiShellRemoveDupInFileList
,
3572 EfiShellBatchIsActive
,
3573 EfiShellIsRootShell
,
3574 EfiShellEnablePageBreak
,
3575 EfiShellDisablePageBreak
,
3576 EfiShellGetPageBreak
,
3577 EfiShellGetDeviceName
,
3578 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3579 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3580 EfiShellOpenFileByName
,
3583 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3584 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3585 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3586 EfiShellDeleteFileByName
,
3587 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3588 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3589 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3591 EfiShellFindFilesInDir
,
3592 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3594 EfiShellOpenRootByHandle
,
3596 SHELL_MAJOR_VERSION
,
3597 SHELL_MINOR_VERSION
,
3599 // New for UEFI Shell 2.1
3600 EfiShellRegisterGuidName
,
3601 EfiShellGetGuidName
,
3602 EfiShellGetGuidFromName
,
3607 Function to create and install on the current handle.
3609 Will overwrite any existing ShellProtocols in the system to be sure that
3610 the current shell is in control.
3612 This must be removed via calling CleanUpShellProtocol().
3614 @param[in, out] NewShell The pointer to the pointer to the structure
3617 @retval EFI_SUCCESS The operation was successful.
3618 @return An error from LocateHandle, CreateEvent, or other core function.
3621 CreatePopulateInstallShellProtocol (
3622 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3628 UINTN HandleCounter
;
3629 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3630 EFI_SHELL_PROTOCOL
*OldShell
;
3632 if (NewShell
== NULL
) {
3633 return (EFI_INVALID_PARAMETER
);
3638 OldProtocolNode
= NULL
;
3639 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3642 // Initialize EfiShellProtocol object...
3644 Status
= gBS
->CreateEvent(0,
3648 &mShellProtocol
.ExecutionBreak
);
3649 if (EFI_ERROR(Status
)) {
3654 // Get the size of the buffer we need.
3656 Status
= gBS
->LocateHandle(ByProtocol
,
3657 &gEfiShellProtocolGuid
,
3661 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3663 // Allocate and recall with buffer of correct size
3665 Buffer
= AllocateZeroPool(BufferSize
);
3666 if (Buffer
== NULL
) {
3667 return (EFI_OUT_OF_RESOURCES
);
3669 Status
= gBS
->LocateHandle(ByProtocol
,
3670 &gEfiShellProtocolGuid
,
3674 if (EFI_ERROR(Status
)) {
3679 // now overwrite each of them, but save the info to restore when we end.
3681 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3682 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3683 &gEfiShellProtocolGuid
,
3684 (VOID
**) &OldShell
,
3687 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3689 if (!EFI_ERROR(Status
)) {
3690 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3691 if (OldProtocolNode
== NULL
) {
3692 if (!IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)) {
3693 CleanUpShellProtocol (&mShellProtocol
);
3695 Status
= EFI_OUT_OF_RESOURCES
;
3699 // reinstall over the old one...
3701 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3702 OldProtocolNode
->Interface
= OldShell
;
3703 Status
= gBS
->ReinstallProtocolInterface(
3704 OldProtocolNode
->Handle
,
3705 &gEfiShellProtocolGuid
,
3706 OldProtocolNode
->Interface
,
3707 (VOID
*)(&mShellProtocol
));
3708 if (!EFI_ERROR(Status
)) {
3710 // we reinstalled sucessfully. log this so we can reverse it later.
3714 // add to the list for subsequent...
3716 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3721 } else if (Status
== EFI_NOT_FOUND
) {
3722 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3724 // no one else published yet. just publish it ourselves.
3726 Status
= gBS
->InstallProtocolInterface (
3728 &gEfiShellProtocolGuid
,
3729 EFI_NATIVE_INTERFACE
,
3730 (VOID
*)(&mShellProtocol
));
3733 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3734 ///@todo support ShellEnvironment2
3735 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3738 if (!EFI_ERROR(Status
)) {
3739 *NewShell
= &mShellProtocol
;
3745 Opposite of CreatePopulateInstallShellProtocol.
3747 Free all memory and restore the system to the state it was in before calling
3748 CreatePopulateInstallShellProtocol.
3750 @param[in, out] NewShell The pointer to the new shell protocol structure.
3752 @retval EFI_SUCCESS The operation was successful.
3755 CleanUpShellProtocol (
3756 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3759 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3762 // if we need to restore old protocols...
3764 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3765 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*) GetFirstNode (&ShellInfoObject
.OldShellList
.Link
)
3766 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3767 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*) GetFirstNode (&ShellInfoObject
.OldShellList
.Link
)
3769 RemoveEntryList (&Node2
->Link
);
3770 gBS
->ReinstallProtocolInterface (Node2
->Handle
, &gEfiShellProtocolGuid
, NewShell
, Node2
->Interface
);
3775 // no need to restore
3777 gBS
->UninstallProtocolInterface (gImageHandle
, &gEfiShellProtocolGuid
, NewShell
);
3783 Cleanup the shell environment.
3785 @param[in, out] NewShell The pointer to the new shell protocol structure.
3787 @retval EFI_SUCCESS The operation was successful.
3790 CleanUpShellEnvironment (
3791 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3795 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3797 CleanUpShellProtocol (NewShell
);
3799 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3800 NewShell
->ExecutionBreak
= NULL
;
3802 Status
= gBS
->OpenProtocol(
3803 gST
->ConsoleInHandle
,
3804 &gEfiSimpleTextInputExProtocolGuid
,
3808 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3810 if (!EFI_ERROR (Status
)) {
3811 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3812 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3813 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3814 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3815 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3816 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3817 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3818 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3824 Notification function for keystrokes.
3826 @param[in] KeyData The key that was pressed.
3828 @retval EFI_SUCCESS The operation was successful.
3832 NotificationFunction(
3833 IN EFI_KEY_DATA
*KeyData
3836 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3837 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3838 (KeyData
->Key
.UnicodeChar
== 3)
3840 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3841 return (EFI_UNSUPPORTED
);
3843 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3844 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3845 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3847 ShellInfoObject
.HaltOutput
= TRUE
;
3849 return (EFI_SUCCESS
);
3853 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3854 feature's enabled state was not known when the shell initially launched.
3856 @retval EFI_SUCCESS The feature is enabled.
3857 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3860 InernalEfiShellStartMonitor(
3864 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3865 EFI_KEY_DATA KeyData
;
3868 Status
= gBS
->OpenProtocol(
3869 gST
->ConsoleInHandle
,
3870 &gEfiSimpleTextInputExProtocolGuid
,
3874 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3875 if (EFI_ERROR(Status
)) {
3880 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3881 ShellInfoObject
.HiiHandle
);
3882 return (EFI_SUCCESS
);
3885 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3886 return (EFI_UNSUPPORTED
);
3889 KeyData
.KeyState
.KeyToggleState
= 0;
3890 KeyData
.Key
.ScanCode
= 0;
3891 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3892 KeyData
.Key
.UnicodeChar
= L
'c';
3894 Status
= SimpleEx
->RegisterKeyNotify(
3897 NotificationFunction
,
3898 &ShellInfoObject
.CtrlCNotifyHandle1
);
3900 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3901 if (!EFI_ERROR(Status
)) {
3902 Status
= SimpleEx
->RegisterKeyNotify(
3905 NotificationFunction
,
3906 &ShellInfoObject
.CtrlCNotifyHandle2
);
3908 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3909 KeyData
.Key
.UnicodeChar
= 3;
3910 if (!EFI_ERROR(Status
)) {
3911 Status
= SimpleEx
->RegisterKeyNotify(
3914 NotificationFunction
,
3915 &ShellInfoObject
.CtrlCNotifyHandle3
);
3917 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3918 if (!EFI_ERROR(Status
)) {
3919 Status
= SimpleEx
->RegisterKeyNotify(
3922 NotificationFunction
,
3923 &ShellInfoObject
.CtrlCNotifyHandle4
);