2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 Close an open file handle.
21 This function closes a specified file handle. All "dirty" cached file data is
22 flushed to the device, and the file is closed. In all cases the handle is
25 @param[in] FileHandle The file handle to close.
27 @retval EFI_SUCCESS The file handle was closed successfully.
32 IN SHELL_FILE_HANDLE FileHandle
35 ShellFileHandleRemove(FileHandle
);
36 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
40 Internal worker to determine whether there is a BlockIo somewhere
41 upon the device path specified.
43 @param[in] DevicePath The device path to test.
45 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
46 @retval FALSE gEfiBlockIoProtocolGuid was not found.
50 InternalShellProtocolIsBlockIoPresent(
51 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
54 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
60 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
61 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
63 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
70 Internal worker to determine whether there is a file system somewhere
71 upon the device path specified.
73 @param[in] DevicePath The device path to test.
75 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
76 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
80 InternalShellProtocolIsSimpleFileSystemPresent(
81 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
84 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
90 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
91 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
93 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
100 Internal worker debug helper function to print out maps as they are added.
102 @param[in] Mapping string mapping that has been added
103 @param[in] DevicePath pointer to device path that has been mapped.
105 @retval EFI_SUCCESS the operation was successful.
106 @return other an error ocurred
113 InternalShellProtocolDebugPrintMessage (
114 IN CONST CHAR16
*Mapping
,
115 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
121 Status
= EFI_SUCCESS
;
124 if (Mapping
!= NULL
) {
125 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
127 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
128 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
136 This function creates a mapping for a device path.
138 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
140 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
141 then the mapping will be deleted.
142 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
144 @retval EFI_SUCCESS Mapping created or deleted successfully.
145 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
146 boot service function LocateDevicePath().
147 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
148 @retval EFI_INVALID_PARAMETER Mapping was NULL
149 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
150 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
151 @retval EFI_NOT_FOUND There was no mapping found to delete
152 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
157 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
158 IN CONST CHAR16
*Mapping
162 SHELL_MAP_LIST
*MapListNode
;
164 if (Mapping
== NULL
){
165 return (EFI_INVALID_PARAMETER
);
168 if (Mapping
[StrLen(Mapping
)-1] != ':') {
169 return (EFI_INVALID_PARAMETER
);
173 // Delete the mapping
175 if (DevicePath
== NULL
) {
176 if (IsListEmpty(&gShellMapList
.Link
)) {
177 return (EFI_NOT_FOUND
);
179 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
180 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
181 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
183 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
184 RemoveEntryList(&MapListNode
->Link
);
185 FreePool(MapListNode
);
186 return (EFI_SUCCESS
);
191 // We didnt find one to delete
193 return (EFI_NOT_FOUND
);
197 // make sure this is a valid to add device path
199 ///@todo add BlockIo to this test...
200 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
201 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
202 return (EFI_INVALID_PARAMETER
);
206 // First make sure there is no old mapping
208 Status
= EfiShellSetMap(NULL
, Mapping
);
209 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
214 // now add the new one.
216 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
222 Gets the device path from the mapping.
224 This function gets the device path associated with a mapping.
226 @param Mapping A pointer to the mapping
228 @retval !=NULL Pointer to the device path that corresponds to the
229 device mapping. The returned pointer does not need
231 @retval NULL There is no device path associated with the
234 CONST EFI_DEVICE_PATH_PROTOCOL
*
236 EfiShellGetDevicePathFromMap(
237 IN CONST CHAR16
*Mapping
240 SHELL_MAP_LIST
*MapListItem
;
247 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
248 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
249 StrnCatGrow(&NewName
, &Size
, L
":", 0);
252 MapListItem
= ShellCommandFindMapItem(NewName
);
256 if (MapListItem
!= NULL
) {
257 return (MapListItem
->DevicePath
);
263 Gets the mapping(s) that most closely matches the device path.
265 This function gets the mapping which corresponds to the device path *DevicePath. If
266 there is no exact match, then the mapping which most closely matches *DevicePath
267 is returned, and *DevicePath is updated to point to the remaining portion of the
268 device path. If there is an exact match, the mapping is returned and *DevicePath
269 points to the end-of-device-path node.
271 If there are multiple map names they will be semi-colon seperated in the
272 NULL-terminated string.
274 @param DevicePath On entry, points to a device path pointer. On
275 exit, updates the pointer to point to the
276 portion of the device path after the mapping.
278 @retval NULL No mapping was found.
279 @return !=NULL Pointer to NULL-terminated mapping. The buffer
280 is callee allocated and should be freed by the caller.
284 EfiShellGetMapFromDevicePath(
285 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
288 SHELL_MAP_LIST
*Node
;
289 CHAR16
*PathForReturn
;
291 // EFI_HANDLE PathHandle;
292 // EFI_HANDLE MapHandle;
293 // EFI_STATUS Status;
294 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
295 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
297 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
301 PathForReturn
= NULL
;
304 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
305 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
306 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
309 // check for exact match
311 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
312 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
314 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
316 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
319 if (PathForReturn
!= NULL
) {
320 while (!IsDevicePathEndType (*DevicePath
)) {
321 *DevicePath
= NextDevicePathNode (*DevicePath
);
323 SetDevicePathEndNode (*DevicePath
);
326 ///@todo finish code for inexact matches.
327 if (PathForReturn == NULL) {
330 DevicePathCopy = DuplicateDevicePath(*DevicePath);
331 ASSERT(DevicePathCopy != NULL);
332 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
333 ASSERT_EFI_ERROR(Status);
335 // check each of the device paths we have to get the root of the path for consist mappings
337 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
338 ; !IsNull(&gShellMapList.Link, &Node->Link)
339 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
341 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
344 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
345 ASSERT(MapPathCopy != NULL);
346 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
347 if (MapHandle == PathHandle) {
349 *DevicePath = DevicePathCopy;
352 DevicePathCopy = NULL;
353 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
354 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
359 // now add on the non-consistent mappings
361 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
362 ; !IsNull(&gShellMapList.Link, &Node->Link)
363 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
365 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
368 MapPathCopy = Node->DevicePath;
369 ASSERT(MapPathCopy != NULL);
370 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
371 if (MapHandle == PathHandle) {
372 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
373 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
380 return (AddBufferToFreeList(PathForReturn
));
384 Converts a device path to a file system-style path.
386 This function converts a device path to a file system path by replacing part, or all, of
387 the device path with the file-system mapping. If there are more than one application
388 file system mappings, the one that most closely matches Path will be used.
390 @param Path The pointer to the device path
392 @retval NULL the device path could not be found.
393 @return all The pointer of the NULL-terminated file path. The path
394 is callee-allocated and should be freed by the caller.
398 EfiShellGetFilePathFromDevicePath(
399 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
402 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
403 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
404 SHELL_MAP_LIST
*MapListItem
;
405 CHAR16
*PathForReturn
;
407 EFI_HANDLE PathHandle
;
408 EFI_HANDLE MapHandle
;
410 FILEPATH_DEVICE_PATH
*FilePath
;
411 FILEPATH_DEVICE_PATH
*AlignedNode
;
413 PathForReturn
= NULL
;
416 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
417 ASSERT(DevicePathCopy
!= NULL
);
418 if (DevicePathCopy
== NULL
) {
422 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
424 if (EFI_ERROR(Status
)) {
428 // check each of the device paths we have to get the root of the path
430 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
431 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
432 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
434 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
435 ASSERT(MapPathCopy
!= NULL
);
437 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
438 if (MapHandle
== PathHandle
) {
439 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
440 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
442 // go through all the remaining nodes in the device path
444 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
445 ; !IsDevicePathEnd (&FilePath
->Header
)
446 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
449 // all the rest should be file path nodes
451 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
452 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
453 FreePool(PathForReturn
);
454 PathForReturn
= NULL
;
458 // append the path part onto the filepath.
460 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
462 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
463 ASSERT (AlignedNode
!= NULL
);
465 // File Path Device Path Nodes 'can optionally add a "\" separator to
466 // the beginning and/or the end of the Path Name string.'
467 // (UEFI Spec 2.4 section 9.3.6.4).
468 // If necessary, add a "\", but otherwise don't
469 // (This is specified in the above section, and also implied by the
470 // UEFI Shell spec section 3.7)
471 if ((PathSize
!= 0) &&
472 (PathForReturn
!= NULL
) &&
473 (PathForReturn
[PathSize
- 1] != L
'\\') &&
474 (AlignedNode
->PathName
[0] != L
'\\')) {
475 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
478 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
479 FreePool(AlignedNode
);
481 } // for loop of remaining nodes
483 if (PathForReturn
!= NULL
) {
486 } // for loop of paths to check
487 return(PathForReturn
);
491 Converts a file system style name to a device path.
493 This function converts a file system style name to a device path, by replacing any
494 mapping references to the associated device path.
496 @param[in] Path The pointer to the path.
498 @return The pointer of the file path. The file path is callee
499 allocated and should be freed by the caller.
500 @retval NULL The path could not be found.
501 @retval NULL There was not enough available memory.
503 EFI_DEVICE_PATH_PROTOCOL
*
505 EfiShellGetDevicePathFromFilePath(
506 IN CONST CHAR16
*Path
513 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
514 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
515 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
516 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
527 if (StrStr(Path
, L
":") == NULL
) {
528 Cwd
= EfiShellGetCurDir(NULL
);
533 Size
+= StrSize(Path
);
534 NewPath
= AllocateZeroPool(Size
);
535 if (NewPath
== NULL
) {
538 StrCpy(NewPath
, Cwd
);
539 if (*Path
== L
'\\') {
541 while (PathRemoveLastItem(NewPath
)) ;
543 StrCat(NewPath
, Path
);
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
;
1437 // ExitDataSize is not OPTIONAL for gBS->BootServices, provide somewhere for
1438 // it to be dumped if the caller doesn't want it.
1439 if (ExitData
== NULL
) {
1440 ExitDataSizePtr
= &InternalExitDataSize
;
1442 ExitDataSizePtr
= ExitDataSize
;
1445 if (ParentImageHandle
== NULL
) {
1446 return (EFI_INVALID_PARAMETER
);
1449 InitializeListHead(&OrigEnvs
);
1454 // Load the image with:
1455 // FALSE - not from boot manager and NULL, 0 being not already in memory
1457 Status
= gBS
->LoadImage(
1460 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1465 if (EFI_ERROR(Status
)) {
1466 if (NewHandle
!= NULL
) {
1467 gBS
->UnloadImage(NewHandle
);
1471 Status
= gBS
->OpenProtocol(
1473 &gEfiLoadedImageProtocolGuid
,
1474 (VOID
**)&LoadedImage
,
1477 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1479 if (!EFI_ERROR(Status
)) {
1480 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1481 if (CommandLine
!= NULL
) {
1482 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(CommandLine
);
1483 LoadedImage
->LoadOptions
= (VOID
*)CommandLine
;
1487 // Save our current environment settings for later restoration if necessary
1489 if (Environment
!= NULL
) {
1490 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1491 if (!EFI_ERROR(Status
)) {
1492 Status
= SetEnvironmentVariables(Environment
);
1497 // Initialize and install a shell parameters protocol on the image.
1499 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1500 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1501 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1502 Status
= UpdateArgcArgv(&ShellParamsProtocol
, CommandLine
, NULL
, NULL
);
1503 ASSERT_EFI_ERROR(Status
);
1505 // Replace Argv[0] with the full path of the binary we're executing:
1506 // If the command line was "foo", the binary might be called "foo.efi".
1507 // "The first entry in [Argv] is always the full file path of the
1508 // executable" - UEFI Shell Spec section 2.3
1510 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1511 // The image we're executing isn't necessarily in a filesystem - it might
1512 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1513 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1514 if (ImagePath
!= NULL
) {
1515 if (ShellParamsProtocol
.Argv
== NULL
) {
1516 // Command line was empty or null.
1517 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1518 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1519 if (ShellParamsProtocol
.Argv
== NULL
) {
1520 Status
= EFI_OUT_OF_RESOURCES
;
1523 ShellParamsProtocol
.Argc
= 1;
1525 // Free the string UpdateArgcArgv put in Argv[0];
1526 FreePool (ShellParamsProtocol
.Argv
[0]);
1528 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1531 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1532 ASSERT_EFI_ERROR(Status
);
1534 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1537 // now start the image, passing up exit data if the caller requested it
1539 if (!EFI_ERROR(Status
)) {
1540 StartStatus
= gBS
->StartImage(
1545 if (StartImageStatus
!= NULL
) {
1546 *StartImageStatus
= StartStatus
;
1549 CleanupStatus
= gBS
->UninstallProtocolInterface(
1551 &gEfiShellParametersProtocolGuid
,
1552 &ShellParamsProtocol
1554 ASSERT_EFI_ERROR(CleanupStatus
);
1560 // Unload image - We should only get here if we didn't call StartImage
1561 gBS
->UnloadImage (NewHandle
);
1564 // Free Argv (Allocated in UpdateArgcArgv)
1565 if (ShellParamsProtocol
.Argv
!= NULL
) {
1566 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1567 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1568 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1571 FreePool (ShellParamsProtocol
.Argv
);
1575 // Restore environment variables
1576 if (!IsListEmpty(&OrigEnvs
)) {
1577 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1578 ASSERT_EFI_ERROR (CleanupStatus
);
1584 Execute the command line.
1586 This function creates a nested instance of the shell and executes the specified
1587 command (CommandLine) with the specified environment (Environment). Upon return,
1588 the status code returned by the specified command is placed in StatusCode.
1590 If Environment is NULL, then the current environment is used and all changes made
1591 by the commands executed will be reflected in the current environment. If the
1592 Environment is non-NULL, then the changes made will be discarded.
1594 The CommandLine is executed from the current working directory on the current
1597 @param ParentImageHandle A handle of the image that is executing the specified
1599 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1600 containing the command line. If NULL then the command-
1602 @param Environment Points to a NULL-terminated array of environment
1603 variables with the format 'x=y', where x is the
1604 environment variable name and y is the value. If this
1605 is NULL, then the current shell environment is used.
1606 @param StatusCode Points to the status code returned by the command.
1608 @retval EFI_SUCCESS The command executed successfully. The status code
1609 returned by the command is pointed to by StatusCode.
1610 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1611 @retval EFI_OUT_OF_RESOURCES Out of resources.
1612 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1613 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1615 @sa InternalShellExecuteDevicePath
1620 IN EFI_HANDLE
*ParentImageHandle
,
1621 IN CHAR16
*CommandLine OPTIONAL
,
1622 IN CHAR16
**Environment OPTIONAL
,
1623 OUT EFI_STATUS
*StatusCode OPTIONAL
1628 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1633 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1634 return (EFI_UNSUPPORTED
);
1637 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1640 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1642 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1644 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1650 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1651 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1652 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1654 Status
= InternalShellExecuteDevicePath(
1658 (CONST CHAR16
**)Environment
,
1663 if (Status
== EFI_ABORTED
) {
1664 // If the command exited with an error, the shell should put the exit
1665 // status in ExitData, preceded by a null-terminated string.
1666 ASSERT (ExitDataSize
== StrSize (ExitData
) + sizeof (SHELL_STATUS
));
1668 if (StatusCode
!= NULL
) {
1669 // Skip the null-terminated string
1670 ExitData
+= StrLen (ExitData
) + 1;
1672 // Use CopyMem to avoid alignment faults
1673 CopyMem (StatusCode
, ExitData
, sizeof (SHELL_STATUS
));
1675 // Convert from SHELL_STATUS to EFI_STATUS
1676 // EFI_STATUSes have top bit set when they are errors.
1677 // (See UEFI Spec Appendix D)
1678 if (*StatusCode
!= SHELL_SUCCESS
) {
1679 *StatusCode
= (EFI_STATUS
) *StatusCode
| MAX_BIT
;
1682 FreePool (ExitData
);
1683 Status
= EFI_SUCCESS
;
1687 // de-allocate and return
1695 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1697 1) frees all pointers (non-NULL)
1698 2) Closes the SHELL_FILE_HANDLE
1700 @param FileListNode pointer to the list node to free
1704 InternalFreeShellFileInfoNode(
1705 IN EFI_SHELL_FILE_INFO
*FileListNode
1708 if (FileListNode
->Info
!= NULL
) {
1709 FreePool((VOID
*)FileListNode
->Info
);
1711 if (FileListNode
->FileName
!= NULL
) {
1712 FreePool((VOID
*)FileListNode
->FileName
);
1714 if (FileListNode
->FullName
!= NULL
) {
1715 FreePool((VOID
*)FileListNode
->FullName
);
1717 if (FileListNode
->Handle
!= NULL
) {
1718 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1720 FreePool(FileListNode
);
1723 Frees the file list.
1725 This function cleans up the file list and any related data structures. It has no
1726 impact on the files themselves.
1728 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1729 defined in OpenFileList()
1731 @retval EFI_SUCCESS Free the file list successfully.
1732 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1736 EfiShellFreeFileList(
1737 IN EFI_SHELL_FILE_INFO
**FileList
1740 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1742 if (FileList
== NULL
|| *FileList
== NULL
) {
1743 return (EFI_INVALID_PARAMETER
);
1746 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1747 ; !IsListEmpty(&(*FileList
)->Link
)
1748 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1750 RemoveEntryList(&ShellFileListItem
->Link
);
1751 InternalFreeShellFileInfoNode(ShellFileListItem
);
1753 InternalFreeShellFileInfoNode(*FileList
);
1755 return(EFI_SUCCESS
);
1759 Deletes the duplicate file names files in the given file list.
1761 This function deletes the reduplicate files in the given file list.
1763 @param FileList A pointer to the first entry in the file list.
1765 @retval EFI_SUCCESS Always success.
1766 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1770 EfiShellRemoveDupInFileList(
1771 IN EFI_SHELL_FILE_INFO
**FileList
1774 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1775 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1776 EFI_SHELL_FILE_INFO
*TempNode
;
1778 if (FileList
== NULL
|| *FileList
== NULL
) {
1779 return (EFI_INVALID_PARAMETER
);
1781 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1782 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1783 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1785 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1786 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1787 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1789 if (gUnicodeCollation
->StriColl(
1791 (CHAR16
*)ShellFileListItem
->FullName
,
1792 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1794 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1796 &ShellFileListItem2
->Link
1798 RemoveEntryList(&ShellFileListItem2
->Link
);
1799 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1800 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1801 // memory in GetNextNode in the loop expression above.
1802 ShellFileListItem2
= TempNode
;
1806 return (EFI_SUCCESS
);
1810 // This is the same structure as the external version, but it has no CONST qualifiers.
1813 LIST_ENTRY Link
; ///< Linked list members.
1814 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1815 CHAR16
*FullName
; ///< Fully qualified filename.
1816 CHAR16
*FileName
; ///< name of this file.
1817 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1818 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1819 } EFI_SHELL_FILE_INFO_NO_CONST
;
1822 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1824 @param[in] Node The node to copy from.
1825 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1827 @retval NULL a memory allocation error ocurred
1828 @return != NULL a pointer to the new node
1830 EFI_SHELL_FILE_INFO
*
1832 InternalDuplicateShellFileInfo(
1833 IN EFI_SHELL_FILE_INFO
*Node
,
1837 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1840 // try to confirm that the objects are in sync
1842 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1844 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1845 if (NewNode
== NULL
) {
1848 NewNode
->FullName
= AllocateZeroPool(StrSize(Node
->FullName
));
1850 NewNode
->FileName
= AllocateZeroPool(StrSize(Node
->FileName
));
1851 NewNode
->Info
= AllocateZeroPool((UINTN
)Node
->Info
->Size
);
1852 if ( NewNode
->FullName
== NULL
1853 || NewNode
->FileName
== NULL
1854 || NewNode
->Info
== NULL
1856 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1857 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1858 SHELL_FREE_NON_NULL(NewNode
->Info
);
1859 SHELL_FREE_NON_NULL(NewNode
);
1862 NewNode
->Status
= Node
->Status
;
1863 NewNode
->Handle
= Node
->Handle
;
1865 Node
->Handle
= NULL
;
1867 StrCpy((CHAR16
*)NewNode
->FullName
, Node
->FullName
);
1868 StrCpy((CHAR16
*)NewNode
->FileName
, Node
->FileName
);
1869 CopyMem(NewNode
->Info
, Node
->Info
, (UINTN
)Node
->Info
->Size
);
1871 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1875 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1876 failed it will return NULL.
1878 @param[in] BasePath the Path to prepend onto filename for FullPath
1879 @param[in] Status Status member initial value.
1880 @param[in] FileName FileName member initial value.
1881 @param[in] Handle Handle member initial value.
1882 @param[in] Info Info struct to copy.
1884 @retval NULL An error ocurred.
1885 @return a pointer to the newly allocated structure.
1887 EFI_SHELL_FILE_INFO
*
1889 CreateAndPopulateShellFileInfo(
1890 IN CONST CHAR16
*BasePath
,
1891 IN CONST EFI_STATUS Status
,
1892 IN CONST CHAR16
*FileName
,
1893 IN CONST SHELL_FILE_HANDLE Handle
,
1894 IN CONST EFI_FILE_INFO
*Info
1897 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1904 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1905 if (ShellFileListItem
== NULL
) {
1908 if (Info
!= NULL
&& Info
->Size
!= 0) {
1909 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1910 if (ShellFileListItem
->Info
== NULL
) {
1911 FreePool(ShellFileListItem
);
1914 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1916 ShellFileListItem
->Info
= NULL
;
1918 if (FileName
!= NULL
) {
1919 ASSERT(TempString
== NULL
);
1920 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1921 if (ShellFileListItem
->FileName
== NULL
) {
1922 FreePool(ShellFileListItem
->Info
);
1923 FreePool(ShellFileListItem
);
1927 ShellFileListItem
->FileName
= NULL
;
1931 if (BasePath
!= NULL
) {
1932 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1933 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1934 if (TempString
== NULL
) {
1935 FreePool((VOID
*)ShellFileListItem
->FileName
);
1936 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1937 FreePool(ShellFileListItem
);
1941 if (ShellFileListItem
->FileName
!= NULL
) {
1942 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1943 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1944 if (TempString
== NULL
) {
1945 FreePool((VOID
*)ShellFileListItem
->FileName
);
1946 FreePool(ShellFileListItem
->Info
);
1947 FreePool(ShellFileListItem
);
1952 TempString
= PathCleanUpDirectories(TempString
);
1954 ShellFileListItem
->FullName
= TempString
;
1955 ShellFileListItem
->Status
= Status
;
1956 ShellFileListItem
->Handle
= Handle
;
1958 return (ShellFileListItem
);
1962 Find all files in a specified directory.
1964 @param FileDirHandle Handle of the directory to search.
1965 @param FileList On return, points to the list of files in the directory
1966 or NULL if there are no files in the directory.
1968 @retval EFI_SUCCESS File information was returned successfully.
1969 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1970 @retval EFI_DEVICE_ERROR The device reported an error.
1971 @retval EFI_NO_MEDIA The device media is not present.
1972 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1973 @return An error from FileHandleGetFileName().
1977 EfiShellFindFilesInDir(
1978 IN SHELL_FILE_HANDLE FileDirHandle
,
1979 OUT EFI_SHELL_FILE_INFO
**FileList
1982 EFI_SHELL_FILE_INFO
*ShellFileList
;
1983 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1984 EFI_FILE_INFO
*FileInfo
;
1993 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1994 if (EFI_ERROR(Status
)) {
1998 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
2001 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
2002 if (TempString
== NULL
) {
2003 SHELL_FREE_NON_NULL(BasePath
);
2004 return (EFI_OUT_OF_RESOURCES
);
2006 TempSpot
= StrStr(TempString
, L
";");
2008 if (TempSpot
!= NULL
) {
2009 *TempSpot
= CHAR_NULL
;
2012 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2013 if (TempString
== NULL
) {
2014 SHELL_FREE_NON_NULL(BasePath
);
2015 return (EFI_OUT_OF_RESOURCES
);
2017 SHELL_FREE_NON_NULL(BasePath
);
2018 BasePath
= TempString
;
2022 ShellFileList
= NULL
;
2023 ShellFileListItem
= NULL
;
2025 Status
= EFI_SUCCESS
;
2028 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2029 ; !EFI_ERROR(Status
) && !NoFile
2030 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2033 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2035 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2037 EFI_SUCCESS
, // success since we didnt fail to open it...
2039 NULL
, // no handle since not open
2042 if (ShellFileList
== NULL
) {
2043 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2044 ASSERT(ShellFileList
!= NULL
);
2045 InitializeListHead(&ShellFileList
->Link
);
2047 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2049 if (EFI_ERROR(Status
)) {
2050 EfiShellFreeFileList(&ShellFileList
);
2053 *FileList
= ShellFileList
;
2055 SHELL_FREE_NON_NULL(BasePath
);
2060 Get the GUID value from a human readable name.
2062 If GuidName is a known GUID name, then update Guid to have the correct value for
2065 This function is only available when the major and minor versions in the
2066 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2068 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2069 @param[out] Guid A pointer to the GUID structure to be filled in.
2071 @retval EFI_SUCCESS The operation was successful.
2072 @retval EFI_INVALID_PARAMETER Guid was NULL.
2073 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2074 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2078 EfiShellGetGuidFromName(
2079 IN CONST CHAR16
*GuidName
,
2086 if (Guid
== NULL
|| GuidName
== NULL
) {
2087 return (EFI_INVALID_PARAMETER
);
2090 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2092 if (!EFI_ERROR(Status
)) {
2093 CopyGuid(NewGuid
, Guid
);
2100 Get the human readable name for a GUID from the value.
2102 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2103 should not modify the value.
2105 This function is only available when the major and minor versions in the
2106 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2108 @param[in] Guid A pointer to the GUID being queried.
2109 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2111 @retval EFI_SUCCESS The operation was successful.
2112 @retval EFI_INVALID_PARAMETER Guid was NULL.
2113 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2114 @retval EFI_NOT_FOUND Guid is not assigned a name.
2118 EfiShellGetGuidName(
2119 IN CONST EFI_GUID
*Guid
,
2120 OUT CONST CHAR16
**GuidName
2125 if (Guid
== NULL
|| GuidName
== NULL
) {
2126 return (EFI_INVALID_PARAMETER
);
2129 Name
= GetStringNameFromGuid(Guid
, NULL
);
2130 if (Name
== NULL
|| StrLen(Name
) == 0) {
2131 SHELL_FREE_NON_NULL(Name
);
2132 return (EFI_NOT_FOUND
);
2135 *GuidName
= AddBufferToFreeList(Name
);
2137 return (EFI_SUCCESS
);
2141 Updates a file name to be preceeded by the mapped drive name
2143 @param[in] BasePath the Mapped drive name to prepend
2144 @param[in, out] Path pointer to pointer to the file name to update.
2147 @retval EFI_OUT_OF_RESOURCES
2152 IN CONST CHAR16
*BasePath
,
2153 IN OUT CHAR16
**Path
2162 ASSERT(Path
!= NULL
);
2163 ASSERT(*Path
!= NULL
);
2164 ASSERT(BasePath
!= NULL
);
2167 // convert a local path to an absolute path
2169 if (StrStr(*Path
, L
":") == NULL
) {
2170 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2171 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2172 if (Path2
== NULL
) {
2173 return (EFI_OUT_OF_RESOURCES
);
2175 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2176 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2177 if (Path2
== NULL
) {
2178 return (EFI_OUT_OF_RESOURCES
);
2185 return (EFI_SUCCESS
);
2189 If FileHandle is a directory then the function reads from FileHandle and reads in
2190 each of the FileInfo structures. If one of them matches the Pattern's first
2191 "level" then it opens that handle and calls itself on that handle.
2193 If FileHandle is a file and matches all of the remaining Pattern (which would be
2194 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2196 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2197 FreeFileList with FileList.
2199 @param[in] FilePattern The FilePattern to check against.
2200 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2201 @param[in] FileHandle The FileHandle to start with
2202 @param[in, out] FileList pointer to pointer to list of found files.
2203 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2204 @param[in] MapName The file system name this file is on.
2206 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2207 @retval EFI_NOT_FOUND no files were found
2208 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2213 IN CONST CHAR16
*FilePattern
,
2214 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2215 IN SHELL_FILE_HANDLE FileHandle
,
2216 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2217 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2218 IN CONST CHAR16
*MapName
2222 CONST CHAR16
*NextFilePatternStart
;
2223 CHAR16
*CurrentFilePattern
;
2224 EFI_SHELL_FILE_INFO
*ShellInfo
;
2225 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2226 EFI_SHELL_FILE_INFO
*NewShellNode
;
2227 EFI_FILE_INFO
*FileInfo
;
2229 CHAR16
*NewFullName
;
2232 if ( FilePattern
== NULL
2233 || UnicodeCollation
== NULL
2236 return (EFI_INVALID_PARAMETER
);
2239 CurrentFilePattern
= NULL
;
2241 if (*FilePattern
== L
'\\') {
2245 for( NextFilePatternStart
= FilePattern
2246 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2247 ; NextFilePatternStart
++);
2249 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2250 ASSERT(CurrentFilePattern
!= NULL
);
2251 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2253 if (CurrentFilePattern
[0] == CHAR_NULL
2254 &&NextFilePatternStart
[0] == CHAR_NULL
2257 // we want the parent or root node (if no parent)
2259 if (ParentNode
== NULL
) {
2261 // We want the root node. create the node.
2263 FileInfo
= FileHandleGetInfo(FileHandle
);
2264 NewShellNode
= CreateAndPopulateShellFileInfo(
2271 SHELL_FREE_NON_NULL(FileInfo
);
2274 // Add the current parameter FileHandle to the list, then end...
2276 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2278 if (NewShellNode
== NULL
) {
2279 Status
= EFI_OUT_OF_RESOURCES
;
2281 NewShellNode
->Handle
= NULL
;
2282 if (*FileList
== NULL
) {
2283 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2284 InitializeListHead(&((*FileList
)->Link
));
2288 // Add to the returning to use list
2290 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2292 Status
= EFI_SUCCESS
;
2295 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2297 if (!EFI_ERROR(Status
)){
2298 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2303 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2304 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2305 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2307 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2308 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2309 Size
= StrSize(ShellInfoNode
->FullName
);
2310 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2311 NewFullName
= AllocateZeroPool(Size
);
2312 if (NewFullName
== NULL
) {
2313 Status
= EFI_OUT_OF_RESOURCES
;
2315 StrCpy(NewFullName
, MapName
);
2316 StrCat(NewFullName
, ShellInfoNode
->FullName
+1);
2317 FreePool((VOID
*)ShellInfoNode
->FullName
);
2318 ShellInfoNode
->FullName
= NewFullName
;
2321 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2323 // should be a directory
2327 // don't open the . and .. directories
2329 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2330 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2335 if (EFI_ERROR(Status
)) {
2339 // Open the directory since we need that handle in the next recursion.
2341 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2344 // recurse with the next part of the pattern
2346 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2348 } else if (!EFI_ERROR(Status
)) {
2354 // copy the information we need into a new Node
2356 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2357 ASSERT(NewShellNode
!= NULL
);
2358 if (NewShellNode
== NULL
) {
2359 Status
= EFI_OUT_OF_RESOURCES
;
2361 if (*FileList
== NULL
) {
2362 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2363 InitializeListHead(&((*FileList
)->Link
));
2367 // Add to the returning to use list
2369 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2372 if (EFI_ERROR(Status
)) {
2376 if (EFI_ERROR(Status
)) {
2377 EfiShellFreeFileList(&ShellInfo
);
2379 Status
= EfiShellFreeFileList(&ShellInfo
);
2384 FreePool(CurrentFilePattern
);
2389 Find files that match a specified pattern.
2391 This function searches for all files and directories that match the specified
2392 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2393 information is placed in the file list FileList.
2395 Wildcards are processed
2396 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2398 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2399 field is set to NULL.
2401 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2403 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2404 @param FileList On return, points to the start of a file list containing the names
2405 of all matching files or else points to NULL if no matching files
2406 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2408 @retval EFI_SUCCESS Files found. FileList is a valid list.
2409 @retval EFI_NOT_FOUND No files found.
2410 @retval EFI_NO_MEDIA The device has no media
2411 @retval EFI_DEVICE_ERROR The device reported an error
2412 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2417 IN CONST CHAR16
*FilePattern
,
2418 OUT EFI_SHELL_FILE_INFO
**FileList
2422 CHAR16
*PatternCopy
;
2423 CHAR16
*PatternCurrentLocation
;
2424 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2425 SHELL_FILE_HANDLE RootFileHandle
;
2429 if ( FilePattern
== NULL
2431 || StrStr(FilePattern
, L
":") == NULL
2433 return (EFI_INVALID_PARAMETER
);
2435 Status
= EFI_SUCCESS
;
2436 RootDevicePath
= NULL
;
2437 RootFileHandle
= NULL
;
2439 PatternCopy
= AllocateZeroPool(StrSize(FilePattern
));
2440 if (PatternCopy
== NULL
) {
2441 return (EFI_OUT_OF_RESOURCES
);
2443 StrCpy(PatternCopy
, FilePattern
);
2445 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2447 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2450 ASSERT(MapName
== NULL
);
2451 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2452 if (MapName
== NULL
) {
2453 Status
= EFI_OUT_OF_RESOURCES
;
2455 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2456 if (RootDevicePath
== NULL
) {
2457 Status
= EFI_INVALID_PARAMETER
;
2459 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2460 if (!EFI_ERROR(Status
)) {
2461 for ( PatternCurrentLocation
= PatternCopy
2462 ; *PatternCurrentLocation
!= ':'
2463 ; PatternCurrentLocation
++);
2464 PatternCurrentLocation
++;
2465 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2467 FreePool(RootDevicePath
);
2471 SHELL_FREE_NON_NULL(PatternCopy
);
2472 SHELL_FREE_NON_NULL(MapName
);
2478 Opens the files that match the path specified.
2480 This function opens all of the files specified by Path. Wildcards are processed
2481 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2482 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2484 @param Path A pointer to the path string.
2485 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2486 EFI_FILE_MODE_WRITE.
2487 @param FileList Points to the start of a list of files opened.
2489 @retval EFI_SUCCESS Create the file list successfully.
2490 @return Others Can't create the file list.
2494 EfiShellOpenFileList(
2497 IN OUT EFI_SHELL_FILE_INFO
**FileList
2501 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2504 CONST CHAR16
*CurDir
;
2507 PathCleanUpDirectories(Path
);
2512 if (FileList
== NULL
|| *FileList
== NULL
) {
2513 return (EFI_INVALID_PARAMETER
);
2516 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2521 // convert a local path to an absolute path
2523 if (StrStr(Path
, L
":") == NULL
) {
2524 CurDir
= EfiShellGetCurDir(NULL
);
2525 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2526 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2527 if (*Path
== L
'\\') {
2529 while (PathRemoveLastItem(Path2
)) ;
2531 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2532 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2534 ASSERT(Path2
== NULL
);
2535 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2538 PathCleanUpDirectories (Path2
);
2543 Status
= EfiShellFindFiles(Path2
, FileList
);
2547 if (EFI_ERROR(Status
)) {
2553 // We had no errors so open all the files (that are not already opened...)
2555 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2556 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2557 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2559 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2560 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2566 return (EFI_NOT_FOUND
);
2568 return(EFI_SUCCESS
);
2572 Gets the environment variable and Attributes, or list of environment variables. Can be
2573 used instead of GetEnv().
2575 This function returns the current value of the specified environment variable and
2576 the Attributes. If no variable name was specified, then all of the known
2577 variables will be returned.
2579 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2580 then the function will return all of the defined shell
2581 environment variables. In the case where multiple environment
2582 variables are being returned, each variable will be terminated
2583 by a NULL, and the list will be terminated by a double NULL.
2584 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2585 the environment variable. In the case where Name is NULL, and
2586 multiple environment variables are being returned, Attributes
2589 @retval NULL The environment variable doesn't exist.
2590 @return A non-NULL value points to the variable's value. The returned
2591 pointer does not need to be freed by the caller.
2596 IN CONST CHAR16
*Name
,
2597 OUT UINT32
*Attributes OPTIONAL
2605 CHAR16
*CurrentWriteLocation
;
2612 // Get all our environment variables
2614 InitializeListHead(&List
);
2615 Status
= GetEnvironmentVariableList(&List
);
2616 if (EFI_ERROR(Status
)){
2621 // Build the semi-colon delimited list. (2 passes)
2623 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2624 ; !IsNull(&List
, &Node
->Link
)
2625 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2627 ASSERT(Node
->Key
!= NULL
);
2628 Size
+= StrSize(Node
->Key
);
2631 Size
+= 2*sizeof(CHAR16
);
2633 Buffer
= AllocateZeroPool(Size
);
2634 if (Buffer
== NULL
) {
2635 if (!IsListEmpty (&List
)) {
2636 FreeEnvironmentVariableList(&List
);
2640 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2642 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2643 ; !IsNull(&List
, &Node
->Link
)
2644 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2646 ASSERT(Node
->Key
!= NULL
);
2647 StrCpy(CurrentWriteLocation
, Node
->Key
);
2648 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2654 if (!IsListEmpty (&List
)) {
2655 FreeEnvironmentVariableList(&List
);
2659 // We are doing a specific environment variable
2663 // get the size we need for this EnvVariable
2665 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2666 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2668 // Allocate the space and recall the get function
2670 Buffer
= AllocateZeroPool(Size
);
2671 ASSERT(Buffer
!= NULL
);
2672 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2675 // we didnt get it (might not exist)
2676 // free the memory if we allocated any and return NULL
2678 if (EFI_ERROR(Status
)) {
2679 if (Buffer
!= NULL
) {
2687 // return the buffer
2689 return (AddBufferToFreeList(Buffer
));
2693 Gets either a single or list of environment variables.
2695 If name is not NULL then this function returns the current value of the specified
2696 environment variable.
2698 If Name is NULL, then a list of all environment variable names is returned. Each is a
2699 NULL terminated string with a double NULL terminating the list.
2701 @param Name A pointer to the environment variable name. If
2702 Name is NULL, then the function will return all
2703 of the defined shell environment variables. In
2704 the case where multiple environment variables are
2705 being returned, each variable will be terminated by
2706 a NULL, and the list will be terminated by a double
2709 @retval !=NULL A pointer to the returned string.
2710 The returned pointer does not need to be freed by the caller.
2712 @retval NULL The environment variable doesn't exist or there are
2713 no environment variables.
2718 IN CONST CHAR16
*Name
2721 return (EfiShellGetEnvEx(Name
, NULL
));
2725 Internal variable setting function. Allows for setting of the read only variables.
2727 @param Name Points to the NULL-terminated environment variable name.
2728 @param Value Points to the NULL-terminated environment variable value. If the value is an
2729 empty string then the environment variable is deleted.
2730 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2732 @retval EFI_SUCCESS The environment variable was successfully updated.
2736 InternalEfiShellSetEnv(
2737 IN CONST CHAR16
*Name
,
2738 IN CONST CHAR16
*Value
,
2742 if (Value
== NULL
|| StrLen(Value
) == 0) {
2743 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2745 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2747 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2749 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2755 Sets the environment variable.
2757 This function changes the current value of the specified environment variable. If the
2758 environment variable exists and the Value is an empty string, then the environment
2759 variable is deleted. If the environment variable exists and the Value is not an empty
2760 string, then the value of the environment variable is changed. If the environment
2761 variable does not exist and the Value is an empty string, there is no action. If the
2762 environment variable does not exist and the Value is a non-empty string, then the
2763 environment variable is created and assigned the specified value.
2765 For a description of volatile and non-volatile environment variables, see UEFI Shell
2766 2.0 specification section 3.6.1.
2768 @param Name Points to the NULL-terminated environment variable name.
2769 @param Value Points to the NULL-terminated environment variable value. If the value is an
2770 empty string then the environment variable is deleted.
2771 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2773 @retval EFI_SUCCESS The environment variable was successfully updated.
2778 IN CONST CHAR16
*Name
,
2779 IN CONST CHAR16
*Value
,
2783 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2784 return (EFI_INVALID_PARAMETER
);
2787 // Make sure we dont 'set' a predefined read only variable
2789 if (gUnicodeCollation
->StriColl(
2793 ||gUnicodeCollation
->StriColl(
2797 ||gUnicodeCollation
->StriColl(
2801 ||gUnicodeCollation
->StriColl(
2804 L
"uefishellsupport") == 0
2805 ||gUnicodeCollation
->StriColl(
2808 L
"uefishellversion") == 0
2809 ||gUnicodeCollation
->StriColl(
2812 L
"uefiversion") == 0
2814 return (EFI_INVALID_PARAMETER
);
2816 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2820 Returns the current directory on the specified device.
2822 If FileSystemMapping is NULL, it returns the current working directory. If the
2823 FileSystemMapping is not NULL, it returns the current directory associated with the
2824 FileSystemMapping. In both cases, the returned name includes the file system
2825 mapping (i.e. fs0:\current-dir).
2827 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2828 then the current working directory is returned.
2830 @retval !=NULL The current directory.
2831 @retval NULL Current directory does not exist.
2836 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2839 CHAR16
*PathToReturn
;
2841 SHELL_MAP_LIST
*MapListItem
;
2842 if (!IsListEmpty(&gShellMapList
.Link
)) {
2844 // if parameter is NULL, use current
2846 if (FileSystemMapping
== NULL
) {
2847 return (EfiShellGetEnv(L
"cwd"));
2850 PathToReturn
= NULL
;
2851 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2852 if (MapListItem
!= NULL
) {
2853 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2854 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2855 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2858 return (AddBufferToFreeList(PathToReturn
));
2865 Changes the current directory on the specified device.
2867 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2868 mapped name, this function changes the current working directory.
2870 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2871 current file system and the current directory on that file system are changed.
2873 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2876 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2877 directory on the specified file system.
2879 If the current working directory or the current working file system is changed then the
2880 %cwd% environment variable will be updated
2882 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2883 directory is changed.
2884 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2886 @retval EFI_SUCCESS The operation was sucessful
2887 @retval EFI_NOT_FOUND The file system could not be found
2892 IN CONST CHAR16
*FileSystem OPTIONAL
,
2893 IN CONST CHAR16
*Dir
2897 SHELL_MAP_LIST
*MapListItem
;
2901 CHAR16
*DirectoryName
;
2908 DirectoryName
= NULL
;
2910 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2911 return (EFI_INVALID_PARAMETER
);
2914 if (IsListEmpty(&gShellMapList
.Link
)){
2915 return (EFI_NOT_FOUND
);
2918 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2919 ASSERT(DirectoryName
!= NULL
);
2921 PathCleanUpDirectories(DirectoryName
);
2923 if (FileSystem
== NULL
) {
2925 // determine the file system mapping to use
2927 if (StrStr(DirectoryName
, L
":") != NULL
) {
2928 ASSERT(MapName
== NULL
);
2929 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2932 // find the file system mapping's entry in the list
2935 if (MapName
!= NULL
) {
2936 MapListItem
= ShellCommandFindMapItem(MapName
);
2939 // make that the current file system mapping
2941 if (MapListItem
!= NULL
) {
2942 gShellCurDir
= MapListItem
;
2945 MapListItem
= gShellCurDir
;
2948 if (MapListItem
== NULL
) {
2949 return (EFI_NOT_FOUND
);
2953 // now update the MapListItem's current directory
2955 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2956 FreePool(MapListItem
->CurrentDirectoryPath
);
2957 MapListItem
->CurrentDirectoryPath
= NULL
;
2959 if (MapName
!= NULL
) {
2960 TempLen
= StrLen(MapName
);
2961 if (TempLen
!= StrLen(DirectoryName
)) {
2962 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2963 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2966 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2967 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2969 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2970 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2971 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2975 // cant have a mapping in the directory...
2977 if (StrStr(DirectoryName
, L
":") != NULL
) {
2978 return (EFI_INVALID_PARAMETER
);
2981 // FileSystem != NULL
2983 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2984 if (MapListItem
== NULL
) {
2985 return (EFI_INVALID_PARAMETER
);
2987 // gShellCurDir = MapListItem;
2988 if (DirectoryName
!= NULL
) {
2990 // change current dir on that file system
2993 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2994 FreePool(MapListItem
->CurrentDirectoryPath
);
2995 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2997 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2998 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2999 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3000 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3001 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3002 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3003 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
3004 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3005 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3010 // if updated the current directory then update the environment variable
3012 if (MapListItem
== gShellCurDir
) {
3014 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3015 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3016 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3017 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3018 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3019 FreePool(TempString
);
3022 return(EFI_SUCCESS
);
3026 Return help information about a specific command.
3028 This function returns the help information for the specified command. The help text
3029 can be internal to the shell or can be from a UEFI Shell manual page.
3031 If Sections is specified, then each section name listed will be compared in a casesensitive
3032 manner, to the section names described in Appendix B. If the section exists,
3033 it will be appended to the returned help text. If the section does not exist, no
3034 information will be returned. If Sections is NULL, then all help text information
3035 available will be returned.
3037 @param Command Points to the NULL-terminated UEFI Shell command name.
3038 @param Sections Points to the NULL-terminated comma-delimited
3039 section names to return. If NULL, then all
3040 sections will be returned.
3041 @param HelpText On return, points to a callee-allocated buffer
3042 containing all specified help text.
3044 @retval EFI_SUCCESS The help text was returned.
3045 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3047 @retval EFI_INVALID_PARAMETER HelpText is NULL
3048 @retval EFI_NOT_FOUND There is no help text available for Command.
3052 EfiShellGetHelpText(
3053 IN CONST CHAR16
*Command
,
3054 IN CONST CHAR16
*Sections OPTIONAL
,
3055 OUT CHAR16
**HelpText
3058 CONST CHAR16
*ManFileName
;
3062 ASSERT(HelpText
!= NULL
);
3065 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3067 if (ManFileName
!= NULL
) {
3068 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3070 if ((StrLen(Command
)> 4)
3071 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3072 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3073 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3074 && (Command
[StrLen(Command
)-4] == L
'.')
3076 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3077 ASSERT(FixCommand
!= NULL
);
3079 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
3080 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3081 FreePool(FixCommand
);
3084 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3090 Gets the enable status of the page break output mode.
3092 User can use this function to determine current page break mode.
3094 @retval TRUE The page break output mode is enabled.
3095 @retval FALSE The page break output mode is disabled.
3099 EfiShellGetPageBreak(
3103 return(ShellInfoObject
.PageBreakEnabled
);
3107 Judges whether the active shell is the root shell.
3109 This function makes the user to know that whether the active Shell is the root shell.
3111 @retval TRUE The active Shell is the root Shell.
3112 @retval FALSE The active Shell is NOT the root Shell.
3116 EfiShellIsRootShell(
3120 return(ShellInfoObject
.RootShellInstance
);
3124 function to return a semi-colon delimeted list of all alias' in the current shell
3126 up to caller to free the memory.
3128 @retval NULL No alias' were found
3129 @retval NULL An error ocurred getting alias'
3130 @return !NULL a list of all alias'
3134 InternalEfiShellGetListAlias(
3142 CHAR16
*VariableName
;
3147 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
3148 ASSERT_EFI_ERROR(Status
);
3150 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
3154 if (VariableName
== NULL
) {
3158 VariableName
[0] = CHAR_NULL
;
3161 NameSize
= (UINTN
)MaxVarSize
;
3162 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3163 if (Status
== EFI_NOT_FOUND
){
3166 ASSERT_EFI_ERROR(Status
);
3167 if (EFI_ERROR(Status
)) {
3170 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3171 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3172 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3173 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3176 FreePool(VariableName
);
3182 Convert a null-terminated unicode string, in-place, to all lowercase.
3185 @param Str The null-terminated string to be converted to all lowercase.
3187 @return The null-terminated string converted into all lowercase.
3196 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3197 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3198 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3205 This function returns the command associated with a alias or a list of all
3208 @param[in] Alias Points to the NULL-terminated shell alias.
3209 If this parameter is NULL, then all
3210 aliases will be returned in ReturnedData.
3211 @param[out] Volatile upon return of a single command if TRUE indicates
3212 this is stored in a volatile fashion. FALSE otherwise.
3214 @return If Alias is not NULL, it will return a pointer to
3215 the NULL-terminated command for that alias.
3216 If Alias is NULL, ReturnedData points to a ';'
3217 delimited list of alias (e.g.
3218 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3219 @retval NULL an error ocurred
3220 @retval NULL Alias was not a valid Alias
3225 IN CONST CHAR16
*Alias
,
3226 OUT BOOLEAN
*Volatile OPTIONAL
3235 // Convert to lowercase to make aliases case-insensitive
3236 if (Alias
!= NULL
) {
3237 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3238 ASSERT (AliasLower
!= NULL
);
3239 ToLower (AliasLower
);
3241 if (Volatile
== NULL
) {
3242 return (AddBufferToFreeList(GetVariable(AliasLower
, &gShellAliasGuid
)));
3246 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3247 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3248 RetVal
= AllocateZeroPool(RetSize
);
3249 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3251 if (EFI_ERROR(Status
)) {
3252 if (RetVal
!= NULL
) {
3257 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3263 FreePool (AliasLower
);
3264 return (AddBufferToFreeList(RetVal
));
3266 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3270 Changes a shell command alias.
3272 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3274 this function does not check for built in alias'.
3276 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3277 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3278 Command refers to an alias, that alias will be deleted.
3279 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3280 Alias being set will be stored in a non-volatile fashion.
3282 @retval EFI_SUCCESS Alias created or deleted successfully.
3283 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3288 IN CONST CHAR16
*Command
,
3289 IN CONST CHAR16
*Alias
,
3296 // Convert to lowercase to make aliases case-insensitive
3297 if (Alias
!= NULL
) {
3298 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3299 ASSERT (AliasLower
!= NULL
);
3300 ToLower (AliasLower
);
3306 // We must be trying to remove one if Alias is NULL
3308 if (Alias
== NULL
) {
3310 // remove an alias (but passed in COMMAND parameter)
3312 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3315 // Add and replace are the same
3318 // We dont check the error return on purpose since the variable may not exist.
3319 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3321 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3324 if (Alias
!= NULL
) {
3325 FreePool (AliasLower
);
3331 Changes a shell command alias.
3333 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3336 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3337 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3338 Command refers to an alias, that alias will be deleted.
3339 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3340 FALSE and the alias already exists, then the existing alias is unchanged and
3341 EFI_ACCESS_DENIED is returned.
3342 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3343 Alias being set will be stored in a non-volatile fashion.
3345 @retval EFI_SUCCESS Alias created or deleted successfully.
3346 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3347 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3349 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3354 IN CONST CHAR16
*Command
,
3355 IN CONST CHAR16
*Alias
,
3360 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3362 // cant set over a built in alias
3364 return (EFI_ACCESS_DENIED
);
3365 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3367 // Command is null or empty
3369 return (EFI_INVALID_PARAMETER
);
3370 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3372 // Alias already exists, Replace not set
3374 return (EFI_ACCESS_DENIED
);
3376 return (InternalSetAlias(Command
, Alias
, Volatile
));
3380 // Pure FILE_HANDLE operations are passed to FileHandleLib
3381 // these functions are indicated by the *
3382 EFI_SHELL_PROTOCOL21 mShellProtocol
= {
3388 EfiShellGetHelpText
,
3389 EfiShellGetDevicePathFromMap
,
3390 EfiShellGetMapFromDevicePath
,
3391 EfiShellGetDevicePathFromFilePath
,
3392 EfiShellGetFilePathFromDevicePath
,
3396 EfiShellOpenFileList
,
3397 EfiShellFreeFileList
,
3398 EfiShellRemoveDupInFileList
,
3399 EfiShellBatchIsActive
,
3400 EfiShellIsRootShell
,
3401 EfiShellEnablePageBreak
,
3402 EfiShellDisablePageBreak
,
3403 EfiShellGetPageBreak
,
3404 EfiShellGetDeviceName
,
3405 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3406 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3407 EfiShellOpenFileByName
,
3410 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3411 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3412 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3413 EfiShellDeleteFileByName
,
3414 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3415 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3416 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3418 EfiShellFindFilesInDir
,
3419 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3421 EfiShellOpenRootByHandle
,
3423 2, // SHELL_MAJOR_VERSION,
3424 1, // SHELL_MINOR_VERSION,
3426 // New for UEFI Shell 2.1
3427 EfiShellRegisterGuidName
,
3428 EfiShellGetGuidName
,
3429 EfiShellGetGuidFromName
,
3434 Function to create and install on the current handle.
3436 Will overwrite any existing ShellProtocols in the system to be sure that
3437 the current shell is in control.
3439 This must be removed via calling CleanUpShellProtocol().
3441 @param[in, out] NewShell The pointer to the pointer to the structure
3444 @retval EFI_SUCCESS The operation was successful.
3445 @return An error from LocateHandle, CreateEvent, or other core function.
3449 CreatePopulateInstallShellProtocol (
3450 IN OUT EFI_SHELL_PROTOCOL21
**NewShell
3456 UINTN HandleCounter
;
3457 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3459 if (NewShell
== NULL
) {
3460 return (EFI_INVALID_PARAMETER
);
3465 OldProtocolNode
= NULL
;
3466 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3469 // Initialize EfiShellProtocol object...
3471 Status
= gBS
->CreateEvent(0,
3475 &mShellProtocol
.ExecutionBreak
);
3476 if (EFI_ERROR(Status
)) {
3481 // Get the size of the buffer we need.
3483 Status
= gBS
->LocateHandle(ByProtocol
,
3484 &gEfiShellProtocolGuid
,
3488 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3490 // Allocate and recall with buffer of correct size
3492 Buffer
= AllocateZeroPool(BufferSize
);
3493 if (Buffer
== NULL
) {
3494 return (EFI_OUT_OF_RESOURCES
);
3496 Status
= gBS
->LocateHandle(ByProtocol
,
3497 &gEfiShellProtocolGuid
,
3501 if (EFI_ERROR(Status
)) {
3506 // now overwrite each of them, but save the info to restore when we end.
3508 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3509 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3510 ASSERT(OldProtocolNode
!= NULL
);
3511 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3512 &gEfiShellProtocolGuid
,
3513 (VOID
**) &(OldProtocolNode
->Interface
),
3516 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3518 if (!EFI_ERROR(Status
)) {
3520 // reinstall over the old one...
3522 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3523 Status
= gBS
->ReinstallProtocolInterface(
3524 OldProtocolNode
->Handle
,
3525 &gEfiShellProtocolGuid
,
3526 OldProtocolNode
->Interface
,
3527 (VOID
*)(&mShellProtocol
));
3528 if (!EFI_ERROR(Status
)) {
3530 // we reinstalled sucessfully. log this so we can reverse it later.
3534 // add to the list for subsequent...
3536 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3541 } else if (Status
== EFI_NOT_FOUND
) {
3542 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3544 // no one else published yet. just publish it ourselves.
3546 Status
= gBS
->InstallProtocolInterface (
3548 &gEfiShellProtocolGuid
,
3549 EFI_NATIVE_INTERFACE
,
3550 (VOID
*)(&mShellProtocol
));
3553 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3554 ///@todo support ShellEnvironment2
3555 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3558 if (!EFI_ERROR(Status
)) {
3559 *NewShell
= &mShellProtocol
;
3565 Opposite of CreatePopulateInstallShellProtocol.
3567 Free all memory and restore the system to the state it was in before calling
3568 CreatePopulateInstallShellProtocol.
3570 @param[in, out] NewShell The pointer to the new shell protocol structure.
3572 @retval EFI_SUCCESS The operation was successful.
3576 CleanUpShellProtocol (
3577 IN OUT EFI_SHELL_PROTOCOL21
*NewShell
3581 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3582 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3585 // if we need to restore old protocols...
3587 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3588 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3589 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3590 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3592 RemoveEntryList(&Node2
->Link
);
3593 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3594 &gEfiShellProtocolGuid
,
3601 // no need to restore
3603 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3604 &gEfiShellProtocolGuid
,
3607 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3608 NewShell
->ExecutionBreak
= NULL
;
3610 Status
= gBS
->OpenProtocol(
3611 gST
->ConsoleInHandle
,
3612 &gEfiSimpleTextInputExProtocolGuid
,
3616 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3618 if (!EFI_ERROR (Status
)) {
3619 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3620 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3621 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3622 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3623 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3624 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3625 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3626 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3632 Notification function for keystrokes.
3634 @param[in] KeyData The key that was pressed.
3636 @retval EFI_SUCCESS The operation was successful.
3640 NotificationFunction(
3641 IN EFI_KEY_DATA
*KeyData
3644 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3645 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3646 (KeyData
->Key
.UnicodeChar
== 3)
3648 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3649 return (EFI_UNSUPPORTED
);
3651 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3652 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3653 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3655 ShellInfoObject
.HaltOutput
= TRUE
;
3657 return (EFI_SUCCESS
);
3661 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3662 feature's enabled state was not known when the shell initially launched.
3664 @retval EFI_SUCCESS The feature is enabled.
3665 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3669 InernalEfiShellStartMonitor(
3673 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3674 EFI_KEY_DATA KeyData
;
3677 Status
= gBS
->OpenProtocol(
3678 gST
->ConsoleInHandle
,
3679 &gEfiSimpleTextInputExProtocolGuid
,
3683 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3684 if (EFI_ERROR(Status
)) {
3689 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3690 ShellInfoObject
.HiiHandle
);
3691 return (EFI_SUCCESS
);
3694 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3695 return (EFI_UNSUPPORTED
);
3698 KeyData
.KeyState
.KeyToggleState
= 0;
3699 KeyData
.Key
.ScanCode
= 0;
3700 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3701 KeyData
.Key
.UnicodeChar
= L
'c';
3703 Status
= SimpleEx
->RegisterKeyNotify(
3706 NotificationFunction
,
3707 &ShellInfoObject
.CtrlCNotifyHandle1
);
3709 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3710 if (!EFI_ERROR(Status
)) {
3711 Status
= SimpleEx
->RegisterKeyNotify(
3714 NotificationFunction
,
3715 &ShellInfoObject
.CtrlCNotifyHandle2
);
3717 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3718 KeyData
.Key
.UnicodeChar
= 3;
3719 if (!EFI_ERROR(Status
)) {
3720 Status
= SimpleEx
->RegisterKeyNotify(
3723 NotificationFunction
,
3724 &ShellInfoObject
.CtrlCNotifyHandle3
);
3726 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3727 if (!EFI_ERROR(Status
)) {
3728 Status
= SimpleEx
->RegisterKeyNotify(
3731 NotificationFunction
,
3732 &ShellInfoObject
.CtrlCNotifyHandle4
);