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.
6 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 Close an open file handle.
22 This function closes a specified file handle. All "dirty" cached file data is
23 flushed to the device, and the file is closed. In all cases the handle is
26 @param[in] FileHandle The file handle to close.
28 @retval EFI_SUCCESS The file handle was closed successfully.
33 IN SHELL_FILE_HANDLE FileHandle
36 ShellFileHandleRemove(FileHandle
);
37 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
41 Internal worker to determine whether there is a BlockIo somewhere
42 upon the device path specified.
44 @param[in] DevicePath The device path to test.
46 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
47 @retval FALSE gEfiBlockIoProtocolGuid was not found.
51 InternalShellProtocolIsBlockIoPresent(
52 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
55 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
61 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
62 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
64 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
71 Internal worker to determine whether there is a file system somewhere
72 upon the device path specified.
74 @param[in] DevicePath The device path to test.
76 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
77 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
81 InternalShellProtocolIsSimpleFileSystemPresent(
82 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
85 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
91 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
92 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
94 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
101 Internal worker debug helper function to print out maps as they are added.
103 @param[in] Mapping string mapping that has been added
104 @param[in] DevicePath pointer to device path that has been mapped.
106 @retval EFI_SUCCESS the operation was successful.
107 @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 FreePool(MapListNode
);
187 return (EFI_SUCCESS
);
192 // We didnt find one to delete
194 return (EFI_NOT_FOUND
);
198 // make sure this is a valid to add device path
200 ///@todo add BlockIo to this test...
201 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
202 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
203 return (EFI_INVALID_PARAMETER
);
207 // First make sure there is no old mapping
209 Status
= EfiShellSetMap(NULL
, Mapping
);
210 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
215 // now add the new one.
217 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
223 Gets the device path from the mapping.
225 This function gets the device path associated with a mapping.
227 @param Mapping A pointer to the mapping
229 @retval !=NULL Pointer to the device path that corresponds to the
230 device mapping. The returned pointer does not need
232 @retval NULL There is no device path associated with the
235 CONST EFI_DEVICE_PATH_PROTOCOL
*
237 EfiShellGetDevicePathFromMap(
238 IN CONST CHAR16
*Mapping
241 SHELL_MAP_LIST
*MapListItem
;
248 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
249 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
250 StrnCatGrow(&NewName
, &Size
, L
":", 0);
253 MapListItem
= ShellCommandFindMapItem(NewName
);
257 if (MapListItem
!= NULL
) {
258 return (MapListItem
->DevicePath
);
264 Gets the mapping(s) that most closely matches the device path.
266 This function gets the mapping which corresponds to the device path *DevicePath. If
267 there is no exact match, then the mapping which most closely matches *DevicePath
268 is returned, and *DevicePath is updated to point to the remaining portion of the
269 device path. If there is an exact match, the mapping is returned and *DevicePath
270 points to the end-of-device-path node.
272 If there are multiple map names they will be semi-colon seperated in the
273 NULL-terminated string.
275 @param DevicePath On entry, points to a device path pointer. On
276 exit, updates the pointer to point to the
277 portion of the device path after the mapping.
279 @retval NULL No mapping was found.
280 @return !=NULL Pointer to NULL-terminated mapping. The buffer
281 is callee allocated and should be freed by the caller.
285 EfiShellGetMapFromDevicePath(
286 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
289 SHELL_MAP_LIST
*Node
;
290 CHAR16
*PathForReturn
;
292 // EFI_HANDLE PathHandle;
293 // EFI_HANDLE MapHandle;
294 // EFI_STATUS Status;
295 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
296 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
298 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
302 PathForReturn
= NULL
;
305 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
306 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
307 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
310 // check for exact match
312 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
313 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
315 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
317 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
320 if (PathForReturn
!= NULL
) {
321 while (!IsDevicePathEndType (*DevicePath
)) {
322 *DevicePath
= NextDevicePathNode (*DevicePath
);
324 SetDevicePathEndNode (*DevicePath
);
327 ///@todo finish code for inexact matches.
328 if (PathForReturn == NULL) {
331 DevicePathCopy = DuplicateDevicePath(*DevicePath);
332 ASSERT(DevicePathCopy != NULL);
333 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
334 ASSERT_EFI_ERROR(Status);
336 // check each of the device paths we have to get the root of the path for consist mappings
338 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
339 ; !IsNull(&gShellMapList.Link, &Node->Link)
340 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
342 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
345 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
346 ASSERT(MapPathCopy != NULL);
347 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
348 if (MapHandle == PathHandle) {
350 *DevicePath = DevicePathCopy;
353 DevicePathCopy = NULL;
354 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
355 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
360 // now add on the non-consistent mappings
362 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
363 ; !IsNull(&gShellMapList.Link, &Node->Link)
364 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
366 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
369 MapPathCopy = Node->DevicePath;
370 ASSERT(MapPathCopy != NULL);
371 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
372 if (MapHandle == PathHandle) {
373 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
374 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
381 return (AddBufferToFreeList(PathForReturn
));
385 Converts a device path to a file system-style path.
387 This function converts a device path to a file system path by replacing part, or all, of
388 the device path with the file-system mapping. If there are more than one application
389 file system mappings, the one that most closely matches Path will be used.
391 @param Path The pointer to the device path
393 @retval NULL the device path could not be found.
394 @return all The pointer of the NULL-terminated file path. The path
395 is callee-allocated and should be freed by the caller.
399 EfiShellGetFilePathFromDevicePath(
400 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
403 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
404 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
405 SHELL_MAP_LIST
*MapListItem
;
406 CHAR16
*PathForReturn
;
408 EFI_HANDLE PathHandle
;
409 EFI_HANDLE MapHandle
;
411 FILEPATH_DEVICE_PATH
*FilePath
;
412 FILEPATH_DEVICE_PATH
*AlignedNode
;
414 PathForReturn
= NULL
;
417 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
418 ASSERT(DevicePathCopy
!= NULL
);
419 if (DevicePathCopy
== NULL
) {
423 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
425 if (EFI_ERROR(Status
)) {
429 // check each of the device paths we have to get the root of the path
431 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
432 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
433 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
435 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
436 ASSERT(MapPathCopy
!= NULL
);
438 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
439 if (MapHandle
== PathHandle
) {
440 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
441 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
443 // go through all the remaining nodes in the device path
445 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
446 ; !IsDevicePathEnd (&FilePath
->Header
)
447 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
450 // all the rest should be file path nodes
452 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
453 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
454 FreePool(PathForReturn
);
455 PathForReturn
= NULL
;
459 // append the path part onto the filepath.
461 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
463 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
464 ASSERT (AlignedNode
!= NULL
);
466 // File Path Device Path Nodes 'can optionally add a "\" separator to
467 // the beginning and/or the end of the Path Name string.'
468 // (UEFI Spec 2.4 section 9.3.6.4).
469 // If necessary, add a "\", but otherwise don't
470 // (This is specified in the above section, and also implied by the
471 // UEFI Shell spec section 3.7)
472 if ((PathSize
!= 0) &&
473 (PathForReturn
!= NULL
) &&
474 (PathForReturn
[PathSize
- 1] != L
'\\') &&
475 (AlignedNode
->PathName
[0] != L
'\\')) {
476 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
479 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
480 FreePool(AlignedNode
);
482 } // for loop of remaining nodes
484 if (PathForReturn
!= NULL
) {
487 } // for loop of paths to check
488 return(PathForReturn
);
492 Converts a file system style name to a device path.
494 This function converts a file system style name to a device path, by replacing any
495 mapping references to the associated device path.
497 @param[in] Path The pointer to the path.
499 @return The pointer of the file path. The file path is callee
500 allocated and should be freed by the caller.
501 @retval NULL The path could not be found.
502 @retval NULL There was not enough available memory.
504 EFI_DEVICE_PATH_PROTOCOL
*
506 EfiShellGetDevicePathFromFilePath(
507 IN CONST CHAR16
*Path
514 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
515 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
516 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
517 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
528 if (StrStr(Path
, L
":") == NULL
) {
529 Cwd
= EfiShellGetCurDir(NULL
);
533 Size
= StrSize(Cwd
) + StrSize(Path
) - sizeof(CHAR16
);
534 NewPath
= AllocateZeroPool(Size
);
535 if (NewPath
== NULL
) {
538 StrnCpy(NewPath
, Cwd
, Size
/sizeof(CHAR16
)-1);
539 if (*Path
== L
'\\') {
541 while (PathRemoveLastItem(NewPath
)) ;
543 StrnCat(NewPath
, Path
, Size
/sizeof(CHAR16
) - 1 - StrLen(NewPath
));
544 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
546 return (DevicePathForReturn
);
551 // find the part before (but including) the : for the map name
553 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
554 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
555 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
560 // look up the device path in the map
562 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
563 if (DevicePath
== NULL
) {
565 // Must have been a bad Mapname
571 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
573 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
574 if (DevicePathCopy
== NULL
) {
583 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
584 if (EFI_ERROR(Status
)) {
585 if (DevicePathCopyForFree
!= NULL
) {
586 FreePool(DevicePathCopyForFree
);
593 // build the full device path
595 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
596 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
598 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
602 if (DevicePathCopyForFree
!= NULL
) {
603 FreePool(DevicePathCopyForFree
);
606 return (DevicePathForReturn
);
610 Gets the name of the device specified by the device handle.
612 This function gets the user-readable name of the device specified by the device
613 handle. If no user-readable name could be generated, then *BestDeviceName will be
614 NULL and EFI_NOT_FOUND will be returned.
616 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
617 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
620 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
621 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
622 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
623 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
624 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
626 @param DeviceHandle The handle of the device.
627 @param Flags Determines the possible sources of component names.
629 EFI_DEVICE_NAME_USE_COMPONENT_NAME
630 EFI_DEVICE_NAME_USE_DEVICE_PATH
631 @param Language A pointer to the language specified for the device
632 name, in the same format as described in the UEFI
633 specification, Appendix M
634 @param BestDeviceName On return, points to the callee-allocated NULL-
635 terminated name of the device. If no device name
636 could be found, points to NULL. The name must be
637 freed by the caller...
639 @retval EFI_SUCCESS Get the name successfully.
640 @retval EFI_NOT_FOUND Fail to get the device name.
641 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
642 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
643 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
647 EfiShellGetDeviceName(
648 IN EFI_HANDLE DeviceHandle
,
649 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
651 OUT CHAR16
**BestDeviceName
655 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
656 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
657 EFI_HANDLE
*HandleList
;
660 CHAR16
*DeviceNameToReturn
;
662 UINTN ParentControllerCount
;
663 EFI_HANDLE
*ParentControllerBuffer
;
664 UINTN ParentDriverCount
;
665 EFI_HANDLE
*ParentDriverBuffer
;
667 if (BestDeviceName
== NULL
||
670 return (EFI_INVALID_PARAMETER
);
674 // make sure one of the 2 supported bits is on
676 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
677 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
678 return (EFI_INVALID_PARAMETER
);
681 DeviceNameToReturn
= NULL
;
682 *BestDeviceName
= NULL
;
687 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
688 Status
= ParseHandleDatabaseByRelationship(
691 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
694 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
696 // Go through those handles until we get one that passes for GetComponentName
698 Status
= gBS
->OpenProtocol(
700 &gEfiComponentName2ProtocolGuid
,
704 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
705 if (EFI_ERROR(Status
)) {
706 Status
= gBS
->OpenProtocol(
708 &gEfiComponentNameProtocolGuid
,
712 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
715 if (EFI_ERROR(Status
)) {
718 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
719 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
722 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
726 if (HandleList
!= NULL
) {
727 FreePool(HandleList
);
731 // Now check the parent controller using this as the child.
733 if (DeviceNameToReturn
== NULL
){
734 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
735 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
736 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
737 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
739 // try using that driver's component name with controller and our driver as the child.
741 Status
= gBS
->OpenProtocol(
742 ParentDriverBuffer
[HandleCount
],
743 &gEfiComponentName2ProtocolGuid
,
747 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
748 if (EFI_ERROR(Status
)) {
749 Status
= gBS
->OpenProtocol(
750 ParentDriverBuffer
[HandleCount
],
751 &gEfiComponentNameProtocolGuid
,
755 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
758 if (EFI_ERROR(Status
)) {
761 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
762 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
765 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
772 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
773 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
777 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
780 // dont return on fail since we will try device path if that bit is on
782 if (DeviceNameToReturn
!= NULL
){
783 ASSERT(BestDeviceName
!= NULL
);
784 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
785 return (EFI_SUCCESS
);
788 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
789 Status
= gBS
->OpenProtocol(
791 &gEfiDevicePathProtocolGuid
,
795 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
796 if (!EFI_ERROR(Status
)) {
798 // use device path to text on the device path
800 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
801 return (EFI_SUCCESS
);
805 // none of the selected bits worked.
807 return (EFI_NOT_FOUND
);
811 Opens the root directory of a device on a handle
813 This function opens the root directory of a device and returns a file handle to it.
815 @param DeviceHandle The handle of the device that contains the volume.
816 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
819 @retval EFI_SUCCESS Root opened successfully.
820 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
822 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
823 @retval EFI_DEVICE_ERROR The device had an error
827 EfiShellOpenRootByHandle(
828 IN EFI_HANDLE DeviceHandle
,
829 OUT SHELL_FILE_HANDLE
*FileHandle
833 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
834 EFI_FILE_PROTOCOL
*RealFileHandle
;
835 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
838 // get the simple file system interface
840 Status
= gBS
->OpenProtocol(DeviceHandle
,
841 &gEfiSimpleFileSystemProtocolGuid
,
842 (VOID
**)&SimpleFileSystem
,
845 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
846 if (EFI_ERROR(Status
)) {
847 return (EFI_NOT_FOUND
);
850 Status
= gBS
->OpenProtocol(DeviceHandle
,
851 &gEfiDevicePathProtocolGuid
,
855 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
856 if (EFI_ERROR(Status
)) {
857 return (EFI_NOT_FOUND
);
860 // Open the root volume now...
862 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
863 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
868 Opens the root directory of a device.
870 This function opens the root directory of a device and returns a file handle to it.
872 @param DevicePath Points to the device path corresponding to the device where the
873 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
874 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
877 @retval EFI_SUCCESS Root opened successfully.
878 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
880 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
881 @retval EFI_DEVICE_ERROR The device had an error
882 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
887 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
888 OUT SHELL_FILE_HANDLE
*FileHandle
894 if (FileHandle
== NULL
) {
895 return (EFI_INVALID_PARAMETER
);
899 // find the handle of the device with that device handle and the file system
902 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
905 if (EFI_ERROR(Status
)) {
906 return (EFI_NOT_FOUND
);
909 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
913 Returns whether any script files are currently being processed.
915 @retval TRUE There is at least one script file active.
916 @retval FALSE No script files are active now.
921 EfiShellBatchIsActive (
925 if (ShellCommandGetCurrentScriptFile() == NULL
) {
932 Worker function to open a file based on a device path. this will open the root
933 of the volume and then traverse down to the file itself.
935 @param DevicePath Device Path of the file.
936 @param FileHandle Pointer to the file upon a successful return.
937 @param OpenMode mode to open file in.
938 @param Attributes the File Attributes to use when creating a new file.
940 @retval EFI_SUCCESS the file is open and FileHandle is valid
941 @retval EFI_UNSUPPORTED the device path cotained non-path elements
942 @retval other an error ocurred.
946 InternalOpenFileDevicePath(
947 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
948 OUT SHELL_FILE_HANDLE
*FileHandle
,
950 IN UINT64 Attributes OPTIONAL
954 FILEPATH_DEVICE_PATH
*FilePathNode
;
956 SHELL_FILE_HANDLE ShellHandle
;
957 EFI_FILE_PROTOCOL
*Handle1
;
958 EFI_FILE_PROTOCOL
*Handle2
;
959 FILEPATH_DEVICE_PATH
*AlignedNode
;
961 if (FileHandle
== NULL
) {
962 return (EFI_INVALID_PARAMETER
);
972 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
974 if (!EFI_ERROR(Status
)) {
975 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
976 if (Handle1
!= NULL
) {
978 // chop off the begining part before the file system part...
981 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
984 if (!EFI_ERROR(Status
)) {
986 // To access as a file system, the file path should only
987 // contain file path components. Follow the file path nodes
988 // and find the target file
990 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
991 ; !IsDevicePathEnd (&FilePathNode
->Header
)
992 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
994 SHELL_FREE_NON_NULL(AlignedNode
);
995 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
997 // For file system access each node should be a file path component
999 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
1000 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1002 Status
= EFI_UNSUPPORTED
;
1007 // Open this file path node
1013 // if this is the last node in the DevicePath always create (if that was requested).
1015 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1016 Status
= Handle2
->Open (
1019 AlignedNode
->PathName
,
1026 // This is not the last node and we dont want to 'create' existing
1027 // directory entries...
1031 // open without letting it create
1032 // prevents error on existing files/directories
1034 Status
= Handle2
->Open (
1037 AlignedNode
->PathName
,
1038 OpenMode
&~EFI_FILE_MODE_CREATE
,
1042 // if above failed now open and create the 'item'
1043 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1045 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1046 Status
= Handle2
->Open (
1049 AlignedNode
->PathName
,
1056 // Close the last node
1058 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1061 // If there's been an error, stop
1063 if (EFI_ERROR (Status
)) {
1070 SHELL_FREE_NON_NULL(AlignedNode
);
1071 if (EFI_ERROR(Status
)) {
1072 if (Handle1
!= NULL
) {
1073 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1076 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1082 Creates a file or directory by name.
1084 This function creates an empty new file or directory with the specified attributes and
1085 returns the new file's handle. If the file already exists and is read-only, then
1086 EFI_INVALID_PARAMETER will be returned.
1088 If the file already existed, it is truncated and its attributes updated. If the file is
1089 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1091 If the file name begins with >v, then the file handle which is returned refers to the
1092 shell environment variable with the specified name. If the shell environment variable
1093 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1095 @param FileName Pointer to NULL-terminated file path
1096 @param FileAttribs The new file's attrbiutes. the different attributes are
1097 described in EFI_FILE_PROTOCOL.Open().
1098 @param FileHandle On return, points to the created file handle or directory's handle
1100 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1101 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1102 @retval EFI_UNSUPPORTED could not open the file path
1103 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1104 file the file system on the device.
1105 @retval EFI_NO_MEDIA the device has no medium.
1106 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1108 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1110 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1111 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1112 when the media is write-protected.
1113 @retval EFI_ACCESS_DENIED The service denied access to the file.
1114 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1115 @retval EFI_VOLUME_FULL The volume is full.
1120 IN CONST CHAR16
*FileName
,
1121 IN UINT64 FileAttribs
,
1122 OUT SHELL_FILE_HANDLE
*FileHandle
1125 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1129 // Is this for an environment variable
1130 // do we start with >v
1132 if (StrStr(FileName
, L
">v") == FileName
) {
1133 if (!IsVolatileEnv(FileName
+2)) {
1134 return (EFI_INVALID_PARAMETER
);
1136 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1137 return (EFI_SUCCESS
);
1141 // We are opening a regular file.
1143 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1144 if (DevicePath
== NULL
) {
1145 return (EFI_NOT_FOUND
);
1148 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
);
1149 FreePool(DevicePath
);
1155 Register a GUID and a localized human readable name for it.
1157 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1158 names must be used whenever a shell command outputs GUID information.
1160 This function is only available when the major and minor versions in the
1161 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1163 @param[in] Guid A pointer to the GUID being registered.
1164 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1166 @retval EFI_SUCCESS The operation was successful.
1167 @retval EFI_INVALID_PARAMETER Guid was NULL.
1168 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1169 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1173 EfiShellRegisterGuidName(
1174 IN CONST EFI_GUID
*Guid
,
1175 IN CONST CHAR16
*GuidName
1178 return (AddNewGuidNameMapping(Guid
, GuidName
, NULL
));
1182 Opens a file or a directory by file name.
1184 This function opens the specified file in the specified OpenMode and returns a file
1186 If the file name begins with >v, then the file handle which is returned refers to the
1187 shell environment variable with the specified name. If the shell environment variable
1188 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1189 EFI_INVALID_PARAMETER is returned.
1191 If the file name is >i, then the file handle which is returned refers to the standard
1192 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1195 If the file name is >o, then the file handle which is returned refers to the standard
1196 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1199 If the file name is >e, then the file handle which is returned refers to the standard
1200 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1203 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1204 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1207 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1210 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1211 @param FileHandle On return, points to the file handle.
1212 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1213 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1215 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1216 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1217 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1218 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1219 system could not be found on the device. FileHandle is NULL.
1220 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1221 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1222 longer supported. FileHandle is NULL.
1223 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1224 the FileName. FileHandle is NULL.
1225 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1226 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1227 when the media is write-protected. FileHandle is NULL.
1228 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1229 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1231 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1235 EfiShellOpenFileByName(
1236 IN CONST CHAR16
*FileName
,
1237 OUT SHELL_FILE_HANDLE
*FileHandle
,
1241 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1247 // Is this for StdIn
1249 if (StrCmp(FileName
, L
">i") == 0) {
1251 // make sure not writing to StdIn
1253 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1254 return (EFI_INVALID_PARAMETER
);
1256 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1257 ASSERT(*FileHandle
!= NULL
);
1258 return (EFI_SUCCESS
);
1262 // Is this for StdOut
1264 if (StrCmp(FileName
, L
">o") == 0) {
1266 // make sure not writing to StdIn
1268 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1269 return (EFI_INVALID_PARAMETER
);
1271 *FileHandle
= &FileInterfaceStdOut
;
1272 return (EFI_SUCCESS
);
1276 // Is this for NUL file
1278 if (StrCmp(FileName
, L
"NUL") == 0) {
1279 *FileHandle
= &FileInterfaceNulFile
;
1280 return (EFI_SUCCESS
);
1284 // Is this for StdErr
1286 if (StrCmp(FileName
, L
">e") == 0) {
1288 // make sure not writing to StdIn
1290 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1291 return (EFI_INVALID_PARAMETER
);
1293 *FileHandle
= &FileInterfaceStdErr
;
1294 return (EFI_SUCCESS
);
1298 // Is this for an environment variable
1299 // do we start with >v
1301 if (StrStr(FileName
, L
">v") == FileName
) {
1302 if (!IsVolatileEnv(FileName
+2) &&
1303 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1304 return (EFI_INVALID_PARAMETER
);
1306 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1307 return (EFI_SUCCESS
);
1311 // We are opening a regular file.
1313 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1314 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1315 if (DevicePath
== NULL
) {
1316 return (EFI_NOT_FOUND
);
1320 // Copy the device path, open the file, then free the memory
1322 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1323 FreePool(DevicePath
);
1329 Deletes the file specified by the file name.
1331 This function deletes a file.
1333 @param FileName Points to the NULL-terminated file name.
1335 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1336 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1337 @sa EfiShellCreateFile
1341 EfiShellDeleteFileByName(
1342 IN CONST CHAR16
*FileName
1345 SHELL_FILE_HANDLE FileHandle
;
1351 // get a handle to the file
1353 Status
= EfiShellCreateFile(FileName
,
1356 if (EFI_ERROR(Status
)) {
1360 // now delete the file
1362 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1366 Disables the page break output mode.
1370 EfiShellDisablePageBreak (
1374 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1378 Enables the page break output mode.
1382 EfiShellEnablePageBreak (
1386 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1390 internal worker function to load and run an image via device path.
1392 @param ParentImageHandle A handle of the image that is executing the specified
1394 @param DevicePath device path of the file to execute
1395 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1396 containing the command line. If NULL then the command-
1398 @param Environment Points to a NULL-terminated array of environment
1399 variables with the format 'x=y', where x is the
1400 environment variable name and y is the value. If this
1401 is NULL, then the current shell environment is used.
1403 @param[out] StartImageStatus Returned status from gBS->StartImage.
1404 @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
1405 @param[out] ExitData ExitData as returned from gBS->StartImage
1407 @retval EFI_SUCCESS The command executed successfully. The status code
1408 returned by the command is pointed to by StatusCode.
1409 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1410 @retval EFI_OUT_OF_RESOURCES Out of resources.
1411 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1415 InternalShellExecuteDevicePath(
1416 IN CONST EFI_HANDLE
*ParentImageHandle
,
1417 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1418 IN CONST CHAR16
*CommandLine OPTIONAL
,
1419 IN CONST CHAR16
**Environment OPTIONAL
,
1420 OUT EFI_STATUS
*StartImageStatus OPTIONAL
,
1421 OUT UINTN
*ExitDataSize OPTIONAL
,
1422 OUT CHAR16
**ExitData OPTIONAL
1426 EFI_STATUS StartStatus
;
1427 EFI_STATUS CleanupStatus
;
1428 EFI_HANDLE NewHandle
;
1429 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1430 LIST_ENTRY OrigEnvs
;
1431 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1432 UINTN InternalExitDataSize
;
1433 UINTN
*ExitDataSizePtr
;
1439 // ExitDataSize is not OPTIONAL for gBS->BootServices, provide somewhere for
1440 // it to be dumped if the caller doesn't want it.
1441 if (ExitData
== NULL
) {
1442 ExitDataSizePtr
= &InternalExitDataSize
;
1444 ExitDataSizePtr
= ExitDataSize
;
1447 if (ParentImageHandle
== NULL
) {
1448 return (EFI_INVALID_PARAMETER
);
1451 InitializeListHead(&OrigEnvs
);
1455 NewCmdLine
= AllocateCopyPool (StrSize (CommandLine
), CommandLine
);
1456 if (NewCmdLine
== NULL
) {
1457 return EFI_OUT_OF_RESOURCES
;
1460 for (Walker
= NewCmdLine
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
1461 if (*Walker
== L
'^' && *(Walker
+1) == L
'#') {
1462 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));
1467 // Load the image with:
1468 // FALSE - not from boot manager and NULL, 0 being not already in memory
1470 Status
= gBS
->LoadImage(
1473 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1478 if (EFI_ERROR(Status
)) {
1479 if (NewHandle
!= NULL
) {
1480 gBS
->UnloadImage(NewHandle
);
1484 Status
= gBS
->OpenProtocol(
1486 &gEfiLoadedImageProtocolGuid
,
1487 (VOID
**)&LoadedImage
,
1490 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1492 if (!EFI_ERROR(Status
)) {
1493 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1494 if (NewCmdLine
!= NULL
) {
1495 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(NewCmdLine
);
1496 LoadedImage
->LoadOptions
= (VOID
*)NewCmdLine
;
1500 // Save our current environment settings for later restoration if necessary
1502 if (Environment
!= NULL
) {
1503 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1504 if (!EFI_ERROR(Status
)) {
1505 Status
= SetEnvironmentVariables(Environment
);
1510 // Initialize and install a shell parameters protocol on the image.
1512 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1513 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1514 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1515 Status
= UpdateArgcArgv(&ShellParamsProtocol
, NewCmdLine
, NULL
, NULL
);
1516 ASSERT_EFI_ERROR(Status
);
1518 // Replace Argv[0] with the full path of the binary we're executing:
1519 // If the command line was "foo", the binary might be called "foo.efi".
1520 // "The first entry in [Argv] is always the full file path of the
1521 // executable" - UEFI Shell Spec section 2.3
1523 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1524 // The image we're executing isn't necessarily in a filesystem - it might
1525 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1526 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1527 if (ImagePath
!= NULL
) {
1528 if (ShellParamsProtocol
.Argv
== NULL
) {
1529 // Command line was empty or null.
1530 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1531 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1532 if (ShellParamsProtocol
.Argv
== NULL
) {
1533 Status
= EFI_OUT_OF_RESOURCES
;
1536 ShellParamsProtocol
.Argc
= 1;
1538 // Free the string UpdateArgcArgv put in Argv[0];
1539 FreePool (ShellParamsProtocol
.Argv
[0]);
1541 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1544 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1545 ASSERT_EFI_ERROR(Status
);
1547 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1550 // now start the image, passing up exit data if the caller requested it
1552 if (!EFI_ERROR(Status
)) {
1553 StartStatus
= gBS
->StartImage(
1558 if (StartImageStatus
!= NULL
) {
1559 *StartImageStatus
= StartStatus
;
1562 CleanupStatus
= gBS
->UninstallProtocolInterface(
1564 &gEfiShellParametersProtocolGuid
,
1565 &ShellParamsProtocol
1567 ASSERT_EFI_ERROR(CleanupStatus
);
1573 // Unload image - We should only get here if we didn't call StartImage
1574 gBS
->UnloadImage (NewHandle
);
1577 // Free Argv (Allocated in UpdateArgcArgv)
1578 if (ShellParamsProtocol
.Argv
!= NULL
) {
1579 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1580 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1581 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1584 FreePool (ShellParamsProtocol
.Argv
);
1588 // Restore environment variables
1589 if (!IsListEmpty(&OrigEnvs
)) {
1590 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1591 ASSERT_EFI_ERROR (CleanupStatus
);
1594 FreePool (NewCmdLine
);
1599 Execute the command line.
1601 This function creates a nested instance of the shell and executes the specified
1602 command (CommandLine) with the specified environment (Environment). Upon return,
1603 the status code returned by the specified command is placed in StatusCode.
1605 If Environment is NULL, then the current environment is used and all changes made
1606 by the commands executed will be reflected in the current environment. If the
1607 Environment is non-NULL, then the changes made will be discarded.
1609 The CommandLine is executed from the current working directory on the current
1612 @param ParentImageHandle A handle of the image that is executing the specified
1614 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1615 containing the command line. If NULL then the command-
1617 @param Environment Points to a NULL-terminated array of environment
1618 variables with the format 'x=y', where x is the
1619 environment variable name and y is the value. If this
1620 is NULL, then the current shell environment is used.
1621 @param StatusCode Points to the status code returned by the command.
1623 @retval EFI_SUCCESS The command executed successfully. The status code
1624 returned by the command is pointed to by StatusCode.
1625 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1626 @retval EFI_OUT_OF_RESOURCES Out of resources.
1627 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1628 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1630 @sa InternalShellExecuteDevicePath
1635 IN EFI_HANDLE
*ParentImageHandle
,
1636 IN CHAR16
*CommandLine OPTIONAL
,
1637 IN CHAR16
**Environment OPTIONAL
,
1638 OUT EFI_STATUS
*StatusCode OPTIONAL
1643 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1648 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1649 return (EFI_UNSUPPORTED
);
1652 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1655 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1657 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1659 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1665 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1666 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1667 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1669 Status
= InternalShellExecuteDevicePath(
1673 (CONST CHAR16
**)Environment
,
1678 if (Status
== EFI_ABORTED
) {
1679 // If the command exited with an error, the shell should put the exit
1680 // status in ExitData, preceded by a null-terminated string.
1681 ASSERT (ExitDataSize
== StrSize (ExitData
) + sizeof (SHELL_STATUS
));
1683 if (StatusCode
!= NULL
) {
1684 // Skip the null-terminated string
1685 ExitData
+= StrLen (ExitData
) + 1;
1687 // Use CopyMem to avoid alignment faults
1688 CopyMem (StatusCode
, ExitData
, sizeof (SHELL_STATUS
));
1690 // Convert from SHELL_STATUS to EFI_STATUS
1691 // EFI_STATUSes have top bit set when they are errors.
1692 // (See UEFI Spec Appendix D)
1693 if (*StatusCode
!= SHELL_SUCCESS
) {
1694 *StatusCode
= (EFI_STATUS
) *StatusCode
| MAX_BIT
;
1697 FreePool (ExitData
);
1698 Status
= EFI_SUCCESS
;
1702 // de-allocate and return
1710 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1712 1) frees all pointers (non-NULL)
1713 2) Closes the SHELL_FILE_HANDLE
1715 @param FileListNode pointer to the list node to free
1719 InternalFreeShellFileInfoNode(
1720 IN EFI_SHELL_FILE_INFO
*FileListNode
1723 if (FileListNode
->Info
!= NULL
) {
1724 FreePool((VOID
*)FileListNode
->Info
);
1726 if (FileListNode
->FileName
!= NULL
) {
1727 FreePool((VOID
*)FileListNode
->FileName
);
1729 if (FileListNode
->FullName
!= NULL
) {
1730 FreePool((VOID
*)FileListNode
->FullName
);
1732 if (FileListNode
->Handle
!= NULL
) {
1733 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1735 FreePool(FileListNode
);
1738 Frees the file list.
1740 This function cleans up the file list and any related data structures. It has no
1741 impact on the files themselves.
1743 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1744 defined in OpenFileList()
1746 @retval EFI_SUCCESS Free the file list successfully.
1747 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1751 EfiShellFreeFileList(
1752 IN EFI_SHELL_FILE_INFO
**FileList
1755 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1757 if (FileList
== NULL
|| *FileList
== NULL
) {
1758 return (EFI_INVALID_PARAMETER
);
1761 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1762 ; !IsListEmpty(&(*FileList
)->Link
)
1763 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1765 RemoveEntryList(&ShellFileListItem
->Link
);
1766 InternalFreeShellFileInfoNode(ShellFileListItem
);
1768 InternalFreeShellFileInfoNode(*FileList
);
1770 return(EFI_SUCCESS
);
1774 Deletes the duplicate file names files in the given file list.
1776 This function deletes the reduplicate files in the given file list.
1778 @param FileList A pointer to the first entry in the file list.
1780 @retval EFI_SUCCESS Always success.
1781 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1785 EfiShellRemoveDupInFileList(
1786 IN EFI_SHELL_FILE_INFO
**FileList
1789 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1790 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1791 EFI_SHELL_FILE_INFO
*TempNode
;
1793 if (FileList
== NULL
|| *FileList
== NULL
) {
1794 return (EFI_INVALID_PARAMETER
);
1796 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1797 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1798 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1800 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1801 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1802 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1804 if (gUnicodeCollation
->StriColl(
1806 (CHAR16
*)ShellFileListItem
->FullName
,
1807 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1809 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1811 &ShellFileListItem2
->Link
1813 RemoveEntryList(&ShellFileListItem2
->Link
);
1814 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1815 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1816 // memory in GetNextNode in the loop expression above.
1817 ShellFileListItem2
= TempNode
;
1821 return (EFI_SUCCESS
);
1825 // This is the same structure as the external version, but it has no CONST qualifiers.
1828 LIST_ENTRY Link
; ///< Linked list members.
1829 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1830 CHAR16
*FullName
; ///< Fully qualified filename.
1831 CHAR16
*FileName
; ///< name of this file.
1832 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1833 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1834 } EFI_SHELL_FILE_INFO_NO_CONST
;
1837 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1839 @param[in] Node The node to copy from.
1840 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1842 @retval NULL a memory allocation error ocurred
1843 @return != NULL a pointer to the new node
1845 EFI_SHELL_FILE_INFO
*
1847 InternalDuplicateShellFileInfo(
1848 IN EFI_SHELL_FILE_INFO
*Node
,
1852 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1855 // try to confirm that the objects are in sync
1857 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1859 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1860 if (NewNode
== NULL
) {
1863 NewNode
->FullName
= AllocateCopyPool(StrSize(Node
->FullName
), Node
->FullName
);
1864 NewNode
->FileName
= AllocateCopyPool(StrSize(Node
->FileName
), Node
->FileName
);
1865 NewNode
->Info
= AllocateCopyPool((UINTN
)Node
->Info
->Size
, Node
->Info
);
1866 if ( NewNode
->FullName
== NULL
1867 || NewNode
->FileName
== NULL
1868 || NewNode
->Info
== NULL
1870 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1871 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1872 SHELL_FREE_NON_NULL(NewNode
->Info
);
1873 SHELL_FREE_NON_NULL(NewNode
);
1876 NewNode
->Status
= Node
->Status
;
1877 NewNode
->Handle
= Node
->Handle
;
1879 Node
->Handle
= NULL
;
1882 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1886 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1887 failed it will return NULL.
1889 @param[in] BasePath the Path to prepend onto filename for FullPath
1890 @param[in] Status Status member initial value.
1891 @param[in] FileName FileName member initial value.
1892 @param[in] Handle Handle member initial value.
1893 @param[in] Info Info struct to copy.
1895 @retval NULL An error ocurred.
1896 @return a pointer to the newly allocated structure.
1898 EFI_SHELL_FILE_INFO
*
1900 CreateAndPopulateShellFileInfo(
1901 IN CONST CHAR16
*BasePath
,
1902 IN CONST EFI_STATUS Status
,
1903 IN CONST CHAR16
*FileName
,
1904 IN CONST SHELL_FILE_HANDLE Handle
,
1905 IN CONST EFI_FILE_INFO
*Info
1908 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1915 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1916 if (ShellFileListItem
== NULL
) {
1919 if (Info
!= NULL
&& Info
->Size
!= 0) {
1920 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1921 if (ShellFileListItem
->Info
== NULL
) {
1922 FreePool(ShellFileListItem
);
1925 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1927 ShellFileListItem
->Info
= NULL
;
1929 if (FileName
!= NULL
) {
1930 ASSERT(TempString
== NULL
);
1931 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1932 if (ShellFileListItem
->FileName
== NULL
) {
1933 FreePool(ShellFileListItem
->Info
);
1934 FreePool(ShellFileListItem
);
1938 ShellFileListItem
->FileName
= NULL
;
1942 if (BasePath
!= NULL
) {
1943 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1944 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1945 if (TempString
== NULL
) {
1946 FreePool((VOID
*)ShellFileListItem
->FileName
);
1947 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1948 FreePool(ShellFileListItem
);
1952 if (ShellFileListItem
->FileName
!= NULL
) {
1953 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1954 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1955 if (TempString
== NULL
) {
1956 FreePool((VOID
*)ShellFileListItem
->FileName
);
1957 FreePool(ShellFileListItem
->Info
);
1958 FreePool(ShellFileListItem
);
1963 TempString
= PathCleanUpDirectories(TempString
);
1965 ShellFileListItem
->FullName
= TempString
;
1966 ShellFileListItem
->Status
= Status
;
1967 ShellFileListItem
->Handle
= Handle
;
1969 return (ShellFileListItem
);
1973 Find all files in a specified directory.
1975 @param FileDirHandle Handle of the directory to search.
1976 @param FileList On return, points to the list of files in the directory
1977 or NULL if there are no files in the directory.
1979 @retval EFI_SUCCESS File information was returned successfully.
1980 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1981 @retval EFI_DEVICE_ERROR The device reported an error.
1982 @retval EFI_NO_MEDIA The device media is not present.
1983 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1984 @return An error from FileHandleGetFileName().
1988 EfiShellFindFilesInDir(
1989 IN SHELL_FILE_HANDLE FileDirHandle
,
1990 OUT EFI_SHELL_FILE_INFO
**FileList
1993 EFI_SHELL_FILE_INFO
*ShellFileList
;
1994 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1995 EFI_FILE_INFO
*FileInfo
;
2004 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
2005 if (EFI_ERROR(Status
)) {
2009 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
2012 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
2013 if (TempString
== NULL
) {
2014 SHELL_FREE_NON_NULL(BasePath
);
2015 return (EFI_OUT_OF_RESOURCES
);
2017 TempSpot
= StrStr(TempString
, L
";");
2019 if (TempSpot
!= NULL
) {
2020 *TempSpot
= CHAR_NULL
;
2023 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2024 if (TempString
== NULL
) {
2025 SHELL_FREE_NON_NULL(BasePath
);
2026 return (EFI_OUT_OF_RESOURCES
);
2028 SHELL_FREE_NON_NULL(BasePath
);
2029 BasePath
= TempString
;
2033 ShellFileList
= NULL
;
2034 ShellFileListItem
= NULL
;
2036 Status
= EFI_SUCCESS
;
2039 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2040 ; !EFI_ERROR(Status
) && !NoFile
2041 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2044 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2046 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2048 EFI_SUCCESS
, // success since we didnt fail to open it...
2050 NULL
, // no handle since not open
2053 if (ShellFileList
== NULL
) {
2054 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2055 ASSERT(ShellFileList
!= NULL
);
2056 InitializeListHead(&ShellFileList
->Link
);
2058 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2060 if (EFI_ERROR(Status
)) {
2061 EfiShellFreeFileList(&ShellFileList
);
2064 *FileList
= ShellFileList
;
2066 SHELL_FREE_NON_NULL(BasePath
);
2071 Get the GUID value from a human readable name.
2073 If GuidName is a known GUID name, then update Guid to have the correct value for
2076 This function is only available when the major and minor versions in the
2077 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2079 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2080 @param[out] Guid A pointer to the GUID structure to be filled in.
2082 @retval EFI_SUCCESS The operation was successful.
2083 @retval EFI_INVALID_PARAMETER Guid was NULL.
2084 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2085 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2089 EfiShellGetGuidFromName(
2090 IN CONST CHAR16
*GuidName
,
2097 if (Guid
== NULL
|| GuidName
== NULL
) {
2098 return (EFI_INVALID_PARAMETER
);
2101 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2103 if (!EFI_ERROR(Status
)) {
2104 CopyGuid(NewGuid
, Guid
);
2111 Get the human readable name for a GUID from the value.
2113 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2114 should not modify the value.
2116 This function is only available when the major and minor versions in the
2117 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2119 @param[in] Guid A pointer to the GUID being queried.
2120 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2122 @retval EFI_SUCCESS The operation was successful.
2123 @retval EFI_INVALID_PARAMETER Guid was NULL.
2124 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2125 @retval EFI_NOT_FOUND Guid is not assigned a name.
2129 EfiShellGetGuidName(
2130 IN CONST EFI_GUID
*Guid
,
2131 OUT CONST CHAR16
**GuidName
2136 if (Guid
== NULL
|| GuidName
== NULL
) {
2137 return (EFI_INVALID_PARAMETER
);
2140 Name
= GetStringNameFromGuid(Guid
, NULL
);
2141 if (Name
== NULL
|| StrLen(Name
) == 0) {
2142 SHELL_FREE_NON_NULL(Name
);
2143 return (EFI_NOT_FOUND
);
2146 *GuidName
= AddBufferToFreeList(Name
);
2148 return (EFI_SUCCESS
);
2152 Updates a file name to be preceeded by the mapped drive name
2154 @param[in] BasePath the Mapped drive name to prepend
2155 @param[in, out] Path pointer to pointer to the file name to update.
2158 @retval EFI_OUT_OF_RESOURCES
2163 IN CONST CHAR16
*BasePath
,
2164 IN OUT CHAR16
**Path
2173 ASSERT(Path
!= NULL
);
2174 ASSERT(*Path
!= NULL
);
2175 ASSERT(BasePath
!= NULL
);
2178 // convert a local path to an absolute path
2180 if (StrStr(*Path
, L
":") == NULL
) {
2181 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2182 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2183 if (Path2
== NULL
) {
2184 return (EFI_OUT_OF_RESOURCES
);
2186 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2187 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2188 if (Path2
== NULL
) {
2189 return (EFI_OUT_OF_RESOURCES
);
2196 return (EFI_SUCCESS
);
2200 If FileHandle is a directory then the function reads from FileHandle and reads in
2201 each of the FileInfo structures. If one of them matches the Pattern's first
2202 "level" then it opens that handle and calls itself on that handle.
2204 If FileHandle is a file and matches all of the remaining Pattern (which would be
2205 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2207 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2208 FreeFileList with FileList.
2210 @param[in] FilePattern The FilePattern to check against.
2211 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2212 @param[in] FileHandle The FileHandle to start with
2213 @param[in, out] FileList pointer to pointer to list of found files.
2214 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2215 @param[in] MapName The file system name this file is on.
2217 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2218 @retval EFI_NOT_FOUND no files were found
2219 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2224 IN CONST CHAR16
*FilePattern
,
2225 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2226 IN SHELL_FILE_HANDLE FileHandle
,
2227 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2228 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2229 IN CONST CHAR16
*MapName
2233 CONST CHAR16
*NextFilePatternStart
;
2234 CHAR16
*CurrentFilePattern
;
2235 EFI_SHELL_FILE_INFO
*ShellInfo
;
2236 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2237 EFI_SHELL_FILE_INFO
*NewShellNode
;
2238 EFI_FILE_INFO
*FileInfo
;
2240 CHAR16
*NewFullName
;
2243 if ( FilePattern
== NULL
2244 || UnicodeCollation
== NULL
2247 return (EFI_INVALID_PARAMETER
);
2250 CurrentFilePattern
= NULL
;
2252 if (*FilePattern
== L
'\\') {
2256 for( NextFilePatternStart
= FilePattern
2257 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2258 ; NextFilePatternStart
++);
2260 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2261 ASSERT(CurrentFilePattern
!= NULL
);
2262 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2264 if (CurrentFilePattern
[0] == CHAR_NULL
2265 &&NextFilePatternStart
[0] == CHAR_NULL
2268 // we want the parent or root node (if no parent)
2270 if (ParentNode
== NULL
) {
2272 // We want the root node. create the node.
2274 FileInfo
= FileHandleGetInfo(FileHandle
);
2275 NewShellNode
= CreateAndPopulateShellFileInfo(
2282 SHELL_FREE_NON_NULL(FileInfo
);
2285 // Add the current parameter FileHandle to the list, then end...
2287 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2289 if (NewShellNode
== NULL
) {
2290 Status
= EFI_OUT_OF_RESOURCES
;
2292 NewShellNode
->Handle
= NULL
;
2293 if (*FileList
== NULL
) {
2294 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2295 InitializeListHead(&((*FileList
)->Link
));
2299 // Add to the returning to use list
2301 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2303 Status
= EFI_SUCCESS
;
2306 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2308 if (!EFI_ERROR(Status
)){
2309 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2314 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2315 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2316 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2318 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2319 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2320 Size
= StrSize(ShellInfoNode
->FullName
);
2321 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2322 NewFullName
= AllocateZeroPool(Size
);
2323 if (NewFullName
== NULL
) {
2324 Status
= EFI_OUT_OF_RESOURCES
;
2326 StrnCpy(NewFullName
, MapName
, Size
/sizeof(CHAR16
)-1);
2327 StrnCat(NewFullName
, ShellInfoNode
->FullName
+1, (Size
/sizeof(CHAR16
))-StrLen(NewFullName
)-1);
2328 FreePool((VOID
*)ShellInfoNode
->FullName
);
2329 ShellInfoNode
->FullName
= NewFullName
;
2332 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2334 // should be a directory
2338 // don't open the . and .. directories
2340 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2341 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2346 if (EFI_ERROR(Status
)) {
2350 // Open the directory since we need that handle in the next recursion.
2352 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2355 // recurse with the next part of the pattern
2357 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2359 } else if (!EFI_ERROR(Status
)) {
2365 // copy the information we need into a new Node
2367 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2368 ASSERT(NewShellNode
!= NULL
);
2369 if (NewShellNode
== NULL
) {
2370 Status
= EFI_OUT_OF_RESOURCES
;
2372 if (*FileList
== NULL
) {
2373 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2374 InitializeListHead(&((*FileList
)->Link
));
2378 // Add to the returning to use list
2380 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2383 if (EFI_ERROR(Status
)) {
2387 if (EFI_ERROR(Status
)) {
2388 EfiShellFreeFileList(&ShellInfo
);
2390 Status
= EfiShellFreeFileList(&ShellInfo
);
2395 FreePool(CurrentFilePattern
);
2400 Find files that match a specified pattern.
2402 This function searches for all files and directories that match the specified
2403 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2404 information is placed in the file list FileList.
2406 Wildcards are processed
2407 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2409 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2410 field is set to NULL.
2412 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2414 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2415 @param FileList On return, points to the start of a file list containing the names
2416 of all matching files or else points to NULL if no matching files
2417 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2419 @retval EFI_SUCCESS Files found. FileList is a valid list.
2420 @retval EFI_NOT_FOUND No files found.
2421 @retval EFI_NO_MEDIA The device has no media
2422 @retval EFI_DEVICE_ERROR The device reported an error
2423 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2428 IN CONST CHAR16
*FilePattern
,
2429 OUT EFI_SHELL_FILE_INFO
**FileList
2433 CHAR16
*PatternCopy
;
2434 CHAR16
*PatternCurrentLocation
;
2435 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2436 SHELL_FILE_HANDLE RootFileHandle
;
2440 if ( FilePattern
== NULL
2442 || StrStr(FilePattern
, L
":") == NULL
2444 return (EFI_INVALID_PARAMETER
);
2446 Status
= EFI_SUCCESS
;
2447 RootDevicePath
= NULL
;
2448 RootFileHandle
= NULL
;
2450 PatternCopy
= AllocateCopyPool(StrSize(FilePattern
), FilePattern
);
2451 if (PatternCopy
== NULL
) {
2452 return (EFI_OUT_OF_RESOURCES
);
2455 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2457 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2460 ASSERT(MapName
== NULL
);
2461 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2462 if (MapName
== NULL
) {
2463 Status
= EFI_OUT_OF_RESOURCES
;
2465 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2466 if (RootDevicePath
== NULL
) {
2467 Status
= EFI_INVALID_PARAMETER
;
2469 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2470 if (!EFI_ERROR(Status
)) {
2471 for ( PatternCurrentLocation
= PatternCopy
2472 ; *PatternCurrentLocation
!= ':'
2473 ; PatternCurrentLocation
++);
2474 PatternCurrentLocation
++;
2475 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2477 FreePool(RootDevicePath
);
2481 SHELL_FREE_NON_NULL(PatternCopy
);
2482 SHELL_FREE_NON_NULL(MapName
);
2488 Opens the files that match the path specified.
2490 This function opens all of the files specified by Path. Wildcards are processed
2491 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2492 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2494 @param Path A pointer to the path string.
2495 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2496 EFI_FILE_MODE_WRITE.
2497 @param FileList Points to the start of a list of files opened.
2499 @retval EFI_SUCCESS Create the file list successfully.
2500 @return Others Can't create the file list.
2504 EfiShellOpenFileList(
2507 IN OUT EFI_SHELL_FILE_INFO
**FileList
2511 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2514 CONST CHAR16
*CurDir
;
2517 PathCleanUpDirectories(Path
);
2522 if (FileList
== NULL
|| *FileList
== NULL
) {
2523 return (EFI_INVALID_PARAMETER
);
2526 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2531 // convert a local path to an absolute path
2533 if (StrStr(Path
, L
":") == NULL
) {
2534 CurDir
= EfiShellGetCurDir(NULL
);
2535 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2536 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2537 if (*Path
== L
'\\') {
2539 while (PathRemoveLastItem(Path2
)) ;
2541 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2542 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2544 ASSERT(Path2
== NULL
);
2545 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2548 PathCleanUpDirectories (Path2
);
2553 Status
= EfiShellFindFiles(Path2
, FileList
);
2557 if (EFI_ERROR(Status
)) {
2563 // We had no errors so open all the files (that are not already opened...)
2565 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2566 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2567 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2569 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2570 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2576 return (EFI_NOT_FOUND
);
2578 return(EFI_SUCCESS
);
2582 Gets the environment variable and Attributes, or list of environment variables. Can be
2583 used instead of GetEnv().
2585 This function returns the current value of the specified environment variable and
2586 the Attributes. If no variable name was specified, then all of the known
2587 variables will be returned.
2589 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2590 then the function will return all of the defined shell
2591 environment variables. In the case where multiple environment
2592 variables are being returned, each variable will be terminated
2593 by a NULL, and the list will be terminated by a double NULL.
2594 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2595 the environment variable. In the case where Name is NULL, and
2596 multiple environment variables are being returned, Attributes
2599 @retval NULL The environment variable doesn't exist.
2600 @return A non-NULL value points to the variable's value. The returned
2601 pointer does not need to be freed by the caller.
2606 IN CONST CHAR16
*Name
,
2607 OUT UINT32
*Attributes OPTIONAL
2615 CHAR16
*CurrentWriteLocation
;
2622 // Get all our environment variables
2624 InitializeListHead(&List
);
2625 Status
= GetEnvironmentVariableList(&List
);
2626 if (EFI_ERROR(Status
)){
2631 // Build the semi-colon delimited list. (2 passes)
2633 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2634 ; !IsNull(&List
, &Node
->Link
)
2635 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2637 ASSERT(Node
->Key
!= NULL
);
2638 Size
+= StrSize(Node
->Key
);
2641 Size
+= 2*sizeof(CHAR16
);
2643 Buffer
= AllocateZeroPool(Size
);
2644 if (Buffer
== NULL
) {
2645 if (!IsListEmpty (&List
)) {
2646 FreeEnvironmentVariableList(&List
);
2650 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2652 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2653 ; !IsNull(&List
, &Node
->Link
)
2654 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2656 ASSERT(Node
->Key
!= NULL
);
2657 StrnCpy(CurrentWriteLocation
, Node
->Key
, (Size
)/sizeof(CHAR16
) - (CurrentWriteLocation
- ((CHAR16
*)Buffer
)) - 1);
2658 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2664 if (!IsListEmpty (&List
)) {
2665 FreeEnvironmentVariableList(&List
);
2669 // We are doing a specific environment variable
2673 // get the size we need for this EnvVariable
2675 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2676 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2678 // Allocate the space and recall the get function
2680 Buffer
= AllocateZeroPool(Size
);
2681 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2684 // we didnt get it (might not exist)
2685 // free the memory if we allocated any and return NULL
2687 if (EFI_ERROR(Status
)) {
2688 if (Buffer
!= NULL
) {
2696 // return the buffer
2698 return (AddBufferToFreeList(Buffer
));
2702 Gets either a single or list of environment variables.
2704 If name is not NULL then this function returns the current value of the specified
2705 environment variable.
2707 If Name is NULL, then a list of all environment variable names is returned. Each is a
2708 NULL terminated string with a double NULL terminating the list.
2710 @param Name A pointer to the environment variable name. If
2711 Name is NULL, then the function will return all
2712 of the defined shell environment variables. In
2713 the case where multiple environment variables are
2714 being returned, each variable will be terminated by
2715 a NULL, and the list will be terminated by a double
2718 @retval !=NULL A pointer to the returned string.
2719 The returned pointer does not need to be freed by the caller.
2721 @retval NULL The environment variable doesn't exist or there are
2722 no environment variables.
2727 IN CONST CHAR16
*Name
2730 return (EfiShellGetEnvEx(Name
, NULL
));
2734 Internal variable setting function. Allows for setting of the read only variables.
2736 @param Name Points to the NULL-terminated environment variable name.
2737 @param Value Points to the NULL-terminated environment variable value. If the value is an
2738 empty string then the environment variable is deleted.
2739 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2741 @retval EFI_SUCCESS The environment variable was successfully updated.
2745 InternalEfiShellSetEnv(
2746 IN CONST CHAR16
*Name
,
2747 IN CONST CHAR16
*Value
,
2751 if (Value
== NULL
|| StrLen(Value
) == 0) {
2752 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2754 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2756 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2758 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2764 Sets the environment variable.
2766 This function changes the current value of the specified environment variable. If the
2767 environment variable exists and the Value is an empty string, then the environment
2768 variable is deleted. If the environment variable exists and the Value is not an empty
2769 string, then the value of the environment variable is changed. If the environment
2770 variable does not exist and the Value is an empty string, there is no action. If the
2771 environment variable does not exist and the Value is a non-empty string, then the
2772 environment variable is created and assigned the specified value.
2774 For a description of volatile and non-volatile environment variables, see UEFI Shell
2775 2.0 specification section 3.6.1.
2777 @param Name Points to the NULL-terminated environment variable name.
2778 @param Value Points to the NULL-terminated environment variable value. If the value is an
2779 empty string then the environment variable is deleted.
2780 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2782 @retval EFI_SUCCESS The environment variable was successfully updated.
2787 IN CONST CHAR16
*Name
,
2788 IN CONST CHAR16
*Value
,
2792 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2793 return (EFI_INVALID_PARAMETER
);
2796 // Make sure we dont 'set' a predefined read only variable
2798 if (gUnicodeCollation
->StriColl(
2802 ||gUnicodeCollation
->StriColl(
2806 ||gUnicodeCollation
->StriColl(
2810 ||gUnicodeCollation
->StriColl(
2813 L
"uefishellsupport") == 0
2814 ||gUnicodeCollation
->StriColl(
2817 L
"uefishellversion") == 0
2818 ||gUnicodeCollation
->StriColl(
2821 L
"uefiversion") == 0
2823 return (EFI_INVALID_PARAMETER
);
2825 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2829 Returns the current directory on the specified device.
2831 If FileSystemMapping is NULL, it returns the current working directory. If the
2832 FileSystemMapping is not NULL, it returns the current directory associated with the
2833 FileSystemMapping. In both cases, the returned name includes the file system
2834 mapping (i.e. fs0:\current-dir).
2836 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2837 then the current working directory is returned.
2839 @retval !=NULL The current directory.
2840 @retval NULL Current directory does not exist.
2845 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2848 CHAR16
*PathToReturn
;
2850 SHELL_MAP_LIST
*MapListItem
;
2851 if (!IsListEmpty(&gShellMapList
.Link
)) {
2853 // if parameter is NULL, use current
2855 if (FileSystemMapping
== NULL
) {
2856 return (EfiShellGetEnv(L
"cwd"));
2859 PathToReturn
= NULL
;
2860 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2861 if (MapListItem
!= NULL
) {
2862 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2863 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2864 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2867 return (AddBufferToFreeList(PathToReturn
));
2874 Changes the current directory on the specified device.
2876 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2877 mapped name, this function changes the current working directory.
2879 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2880 current file system and the current directory on that file system are changed.
2882 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2885 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2886 directory on the specified file system.
2888 If the current working directory or the current working file system is changed then the
2889 %cwd% environment variable will be updated
2891 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2892 directory is changed.
2893 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2895 @retval EFI_SUCCESS The operation was sucessful
2896 @retval EFI_NOT_FOUND The file system could not be found
2901 IN CONST CHAR16
*FileSystem OPTIONAL
,
2902 IN CONST CHAR16
*Dir
2906 SHELL_MAP_LIST
*MapListItem
;
2910 CHAR16
*DirectoryName
;
2917 DirectoryName
= NULL
;
2919 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2920 return (EFI_INVALID_PARAMETER
);
2923 if (IsListEmpty(&gShellMapList
.Link
)){
2924 return (EFI_NOT_FOUND
);
2927 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2928 ASSERT(DirectoryName
!= NULL
);
2930 PathCleanUpDirectories(DirectoryName
);
2932 if (FileSystem
== NULL
) {
2934 // determine the file system mapping to use
2936 if (StrStr(DirectoryName
, L
":") != NULL
) {
2937 ASSERT(MapName
== NULL
);
2938 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2941 // find the file system mapping's entry in the list
2944 if (MapName
!= NULL
) {
2945 MapListItem
= ShellCommandFindMapItem(MapName
);
2948 // make that the current file system mapping
2950 if (MapListItem
!= NULL
) {
2951 gShellCurDir
= MapListItem
;
2954 MapListItem
= gShellCurDir
;
2957 if (MapListItem
== NULL
) {
2958 return (EFI_NOT_FOUND
);
2962 // now update the MapListItem's current directory
2964 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2965 FreePool(MapListItem
->CurrentDirectoryPath
);
2966 MapListItem
->CurrentDirectoryPath
= NULL
;
2968 if (MapName
!= NULL
) {
2969 TempLen
= StrLen(MapName
);
2970 if (TempLen
!= StrLen(DirectoryName
)) {
2971 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2972 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2975 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2976 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2978 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2979 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2980 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2984 // cant have a mapping in the directory...
2986 if (StrStr(DirectoryName
, L
":") != NULL
) {
2987 return (EFI_INVALID_PARAMETER
);
2990 // FileSystem != NULL
2992 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2993 if (MapListItem
== NULL
) {
2994 return (EFI_INVALID_PARAMETER
);
2996 // gShellCurDir = MapListItem;
2997 if (DirectoryName
!= NULL
) {
2999 // change current dir on that file system
3002 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
3003 FreePool(MapListItem
->CurrentDirectoryPath
);
3004 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
3006 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3007 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
3008 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3009 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3010 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3011 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3012 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
3013 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3014 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3019 // if updated the current directory then update the environment variable
3021 if (MapListItem
== gShellCurDir
) {
3023 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3024 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3025 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3026 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3027 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3028 FreePool(TempString
);
3031 return(EFI_SUCCESS
);
3035 Return help information about a specific command.
3037 This function returns the help information for the specified command. The help text
3038 can be internal to the shell or can be from a UEFI Shell manual page.
3040 If Sections is specified, then each section name listed will be compared in a casesensitive
3041 manner, to the section names described in Appendix B. If the section exists,
3042 it will be appended to the returned help text. If the section does not exist, no
3043 information will be returned. If Sections is NULL, then all help text information
3044 available will be returned.
3046 @param Command Points to the NULL-terminated UEFI Shell command name.
3047 @param Sections Points to the NULL-terminated comma-delimited
3048 section names to return. If NULL, then all
3049 sections will be returned.
3050 @param HelpText On return, points to a callee-allocated buffer
3051 containing all specified help text.
3053 @retval EFI_SUCCESS The help text was returned.
3054 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3056 @retval EFI_INVALID_PARAMETER HelpText is NULL
3057 @retval EFI_NOT_FOUND There is no help text available for Command.
3061 EfiShellGetHelpText(
3062 IN CONST CHAR16
*Command
,
3063 IN CONST CHAR16
*Sections OPTIONAL
,
3064 OUT CHAR16
**HelpText
3067 CONST CHAR16
*ManFileName
;
3071 ASSERT(HelpText
!= NULL
);
3074 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3076 if (ManFileName
!= NULL
) {
3077 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3079 if ((StrLen(Command
)> 4)
3080 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3081 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3082 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3083 && (Command
[StrLen(Command
)-4] == L
'.')
3085 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3086 ASSERT(FixCommand
!= NULL
);
3088 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
3089 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3090 FreePool(FixCommand
);
3093 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3099 Gets the enable status of the page break output mode.
3101 User can use this function to determine current page break mode.
3103 @retval TRUE The page break output mode is enabled.
3104 @retval FALSE The page break output mode is disabled.
3108 EfiShellGetPageBreak(
3112 return(ShellInfoObject
.PageBreakEnabled
);
3116 Judges whether the active shell is the root shell.
3118 This function makes the user to know that whether the active Shell is the root shell.
3120 @retval TRUE The active Shell is the root Shell.
3121 @retval FALSE The active Shell is NOT the root Shell.
3125 EfiShellIsRootShell(
3129 return(ShellInfoObject
.RootShellInstance
);
3133 function to return a semi-colon delimeted list of all alias' in the current shell
3135 up to caller to free the memory.
3137 @retval NULL No alias' were found
3138 @retval NULL An error ocurred getting alias'
3139 @return !NULL a list of all alias'
3143 InternalEfiShellGetListAlias(
3151 CHAR16
*VariableName
;
3156 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
3157 ASSERT_EFI_ERROR(Status
);
3159 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
3163 if (VariableName
== NULL
) {
3167 VariableName
[0] = CHAR_NULL
;
3170 NameSize
= (UINTN
)MaxVarSize
;
3171 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3172 if (Status
== EFI_NOT_FOUND
){
3175 ASSERT_EFI_ERROR(Status
);
3176 if (EFI_ERROR(Status
)) {
3179 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3180 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3181 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3182 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3185 FreePool(VariableName
);
3191 Convert a null-terminated unicode string, in-place, to all lowercase.
3194 @param Str The null-terminated string to be converted to all lowercase.
3196 @return The null-terminated string converted into all lowercase.
3205 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3206 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3207 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3214 This function returns the command associated with a alias or a list of all
3217 @param[in] Alias Points to the NULL-terminated shell alias.
3218 If this parameter is NULL, then all
3219 aliases will be returned in ReturnedData.
3220 @param[out] Volatile upon return of a single command if TRUE indicates
3221 this is stored in a volatile fashion. FALSE otherwise.
3223 @return If Alias is not NULL, it will return a pointer to
3224 the NULL-terminated command for that alias.
3225 If Alias is NULL, ReturnedData points to a ';'
3226 delimited list of alias (e.g.
3227 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3228 @retval NULL an error ocurred
3229 @retval NULL Alias was not a valid Alias
3234 IN CONST CHAR16
*Alias
,
3235 OUT BOOLEAN
*Volatile OPTIONAL
3244 // Convert to lowercase to make aliases case-insensitive
3245 if (Alias
!= NULL
) {
3246 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3247 ASSERT (AliasLower
!= NULL
);
3248 ToLower (AliasLower
);
3250 if (Volatile
== NULL
) {
3251 return (AddBufferToFreeList(GetVariable(AliasLower
, &gShellAliasGuid
)));
3255 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3256 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3257 RetVal
= AllocateZeroPool(RetSize
);
3258 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3260 if (EFI_ERROR(Status
)) {
3261 if (RetVal
!= NULL
) {
3266 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3272 FreePool (AliasLower
);
3273 return (AddBufferToFreeList(RetVal
));
3275 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3279 Changes a shell command alias.
3281 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3283 this function does not check for built in alias'.
3285 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3286 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3287 Command refers to an alias, that alias will be deleted.
3288 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3289 Alias being set will be stored in a non-volatile fashion.
3291 @retval EFI_SUCCESS Alias created or deleted successfully.
3292 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3297 IN CONST CHAR16
*Command
,
3298 IN CONST CHAR16
*Alias
,
3305 // Convert to lowercase to make aliases case-insensitive
3306 if (Alias
!= NULL
) {
3307 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3308 ASSERT (AliasLower
!= NULL
);
3309 ToLower (AliasLower
);
3315 // We must be trying to remove one if Alias is NULL
3317 if (Alias
== NULL
) {
3319 // remove an alias (but passed in COMMAND parameter)
3321 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3324 // Add and replace are the same
3327 // We dont check the error return on purpose since the variable may not exist.
3328 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3330 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3333 if (Alias
!= NULL
) {
3334 FreePool (AliasLower
);
3340 Changes a shell command alias.
3342 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3345 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3346 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3347 Command refers to an alias, that alias will be deleted.
3348 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3349 FALSE and the alias already exists, then the existing alias is unchanged and
3350 EFI_ACCESS_DENIED is returned.
3351 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3352 Alias being set will be stored in a non-volatile fashion.
3354 @retval EFI_SUCCESS Alias created or deleted successfully.
3355 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3356 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3358 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3363 IN CONST CHAR16
*Command
,
3364 IN CONST CHAR16
*Alias
,
3369 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3371 // cant set over a built in alias
3373 return (EFI_ACCESS_DENIED
);
3374 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3376 // Command is null or empty
3378 return (EFI_INVALID_PARAMETER
);
3379 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3381 // Alias already exists, Replace not set
3383 return (EFI_ACCESS_DENIED
);
3385 return (InternalSetAlias(Command
, Alias
, Volatile
));
3389 // Pure FILE_HANDLE operations are passed to FileHandleLib
3390 // these functions are indicated by the *
3391 EFI_SHELL_PROTOCOL mShellProtocol
= {
3397 EfiShellGetHelpText
,
3398 EfiShellGetDevicePathFromMap
,
3399 EfiShellGetMapFromDevicePath
,
3400 EfiShellGetDevicePathFromFilePath
,
3401 EfiShellGetFilePathFromDevicePath
,
3405 EfiShellOpenFileList
,
3406 EfiShellFreeFileList
,
3407 EfiShellRemoveDupInFileList
,
3408 EfiShellBatchIsActive
,
3409 EfiShellIsRootShell
,
3410 EfiShellEnablePageBreak
,
3411 EfiShellDisablePageBreak
,
3412 EfiShellGetPageBreak
,
3413 EfiShellGetDeviceName
,
3414 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3415 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3416 EfiShellOpenFileByName
,
3419 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3420 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3421 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3422 EfiShellDeleteFileByName
,
3423 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3424 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3425 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3427 EfiShellFindFilesInDir
,
3428 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3430 EfiShellOpenRootByHandle
,
3432 SHELL_MAJOR_VERSION
,
3433 SHELL_MINOR_VERSION
,
3435 // New for UEFI Shell 2.1
3436 EfiShellRegisterGuidName
,
3437 EfiShellGetGuidName
,
3438 EfiShellGetGuidFromName
,
3443 Function to create and install on the current handle.
3445 Will overwrite any existing ShellProtocols in the system to be sure that
3446 the current shell is in control.
3448 This must be removed via calling CleanUpShellProtocol().
3450 @param[in, out] NewShell The pointer to the pointer to the structure
3453 @retval EFI_SUCCESS The operation was successful.
3454 @return An error from LocateHandle, CreateEvent, or other core function.
3458 CreatePopulateInstallShellProtocol (
3459 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3465 UINTN HandleCounter
;
3466 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3468 if (NewShell
== NULL
) {
3469 return (EFI_INVALID_PARAMETER
);
3474 OldProtocolNode
= NULL
;
3475 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3478 // Initialize EfiShellProtocol object...
3480 Status
= gBS
->CreateEvent(0,
3484 &mShellProtocol
.ExecutionBreak
);
3485 if (EFI_ERROR(Status
)) {
3490 // Get the size of the buffer we need.
3492 Status
= gBS
->LocateHandle(ByProtocol
,
3493 &gEfiShellProtocolGuid
,
3497 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3499 // Allocate and recall with buffer of correct size
3501 Buffer
= AllocateZeroPool(BufferSize
);
3502 if (Buffer
== NULL
) {
3503 return (EFI_OUT_OF_RESOURCES
);
3505 Status
= gBS
->LocateHandle(ByProtocol
,
3506 &gEfiShellProtocolGuid
,
3510 if (EFI_ERROR(Status
)) {
3515 // now overwrite each of them, but save the info to restore when we end.
3517 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3518 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3519 ASSERT(OldProtocolNode
!= NULL
);
3520 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3521 &gEfiShellProtocolGuid
,
3522 (VOID
**) &(OldProtocolNode
->Interface
),
3525 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3527 if (!EFI_ERROR(Status
)) {
3529 // reinstall over the old one...
3531 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3532 Status
= gBS
->ReinstallProtocolInterface(
3533 OldProtocolNode
->Handle
,
3534 &gEfiShellProtocolGuid
,
3535 OldProtocolNode
->Interface
,
3536 (VOID
*)(&mShellProtocol
));
3537 if (!EFI_ERROR(Status
)) {
3539 // we reinstalled sucessfully. log this so we can reverse it later.
3543 // add to the list for subsequent...
3545 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3550 } else if (Status
== EFI_NOT_FOUND
) {
3551 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3553 // no one else published yet. just publish it ourselves.
3555 Status
= gBS
->InstallProtocolInterface (
3557 &gEfiShellProtocolGuid
,
3558 EFI_NATIVE_INTERFACE
,
3559 (VOID
*)(&mShellProtocol
));
3562 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3563 ///@todo support ShellEnvironment2
3564 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3567 if (!EFI_ERROR(Status
)) {
3568 *NewShell
= &mShellProtocol
;
3574 Opposite of CreatePopulateInstallShellProtocol.
3576 Free all memory and restore the system to the state it was in before calling
3577 CreatePopulateInstallShellProtocol.
3579 @param[in, out] NewShell The pointer to the new shell protocol structure.
3581 @retval EFI_SUCCESS The operation was successful.
3585 CleanUpShellProtocol (
3586 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3590 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3591 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3594 // if we need to restore old protocols...
3596 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3597 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3598 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3599 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3601 RemoveEntryList(&Node2
->Link
);
3602 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3603 &gEfiShellProtocolGuid
,
3610 // no need to restore
3612 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3613 &gEfiShellProtocolGuid
,
3616 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3617 NewShell
->ExecutionBreak
= NULL
;
3619 Status
= gBS
->OpenProtocol(
3620 gST
->ConsoleInHandle
,
3621 &gEfiSimpleTextInputExProtocolGuid
,
3625 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3627 if (!EFI_ERROR (Status
)) {
3628 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3629 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3630 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3631 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3632 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3633 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3634 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3635 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3641 Notification function for keystrokes.
3643 @param[in] KeyData The key that was pressed.
3645 @retval EFI_SUCCESS The operation was successful.
3649 NotificationFunction(
3650 IN EFI_KEY_DATA
*KeyData
3653 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3654 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3655 (KeyData
->Key
.UnicodeChar
== 3)
3657 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3658 return (EFI_UNSUPPORTED
);
3660 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3661 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3662 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3664 ShellInfoObject
.HaltOutput
= TRUE
;
3666 return (EFI_SUCCESS
);
3670 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3671 feature's enabled state was not known when the shell initially launched.
3673 @retval EFI_SUCCESS The feature is enabled.
3674 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3678 InernalEfiShellStartMonitor(
3682 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3683 EFI_KEY_DATA KeyData
;
3686 Status
= gBS
->OpenProtocol(
3687 gST
->ConsoleInHandle
,
3688 &gEfiSimpleTextInputExProtocolGuid
,
3692 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3693 if (EFI_ERROR(Status
)) {
3698 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3699 ShellInfoObject
.HiiHandle
);
3700 return (EFI_SUCCESS
);
3703 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3704 return (EFI_UNSUPPORTED
);
3707 KeyData
.KeyState
.KeyToggleState
= 0;
3708 KeyData
.Key
.ScanCode
= 0;
3709 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3710 KeyData
.Key
.UnicodeChar
= L
'c';
3712 Status
= SimpleEx
->RegisterKeyNotify(
3715 NotificationFunction
,
3716 &ShellInfoObject
.CtrlCNotifyHandle1
);
3718 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3719 if (!EFI_ERROR(Status
)) {
3720 Status
= SimpleEx
->RegisterKeyNotify(
3723 NotificationFunction
,
3724 &ShellInfoObject
.CtrlCNotifyHandle2
);
3726 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3727 KeyData
.Key
.UnicodeChar
= 3;
3728 if (!EFI_ERROR(Status
)) {
3729 Status
= SimpleEx
->RegisterKeyNotify(
3732 NotificationFunction
,
3733 &ShellInfoObject
.CtrlCNotifyHandle3
);
3735 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3736 if (!EFI_ERROR(Status
)) {
3737 Status
= SimpleEx
->RegisterKeyNotify(
3740 NotificationFunction
,
3741 &ShellInfoObject
.CtrlCNotifyHandle4
);