2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 (C) Copyright 2014, Hewlett-Packard Development Company, L.P.
6 Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 Close an open file handle.
22 This function closes a specified file handle. All "dirty" cached file data is
23 flushed to the device, and the file is closed. In all cases the handle is
26 @param[in] FileHandle The file handle to close.
28 @retval EFI_SUCCESS The file handle was closed successfully.
33 IN SHELL_FILE_HANDLE FileHandle
36 ShellFileHandleRemove(FileHandle
);
37 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
41 Internal worker to determine whether there is a BlockIo somewhere
42 upon the device path specified.
44 @param[in] DevicePath The device path to test.
46 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
47 @retval FALSE gEfiBlockIoProtocolGuid was not found.
51 InternalShellProtocolIsBlockIoPresent(
52 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
55 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
61 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
62 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
64 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
71 Internal worker to determine whether there is a file system somewhere
72 upon the device path specified.
74 @param[in] DevicePath The device path to test.
76 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
77 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
81 InternalShellProtocolIsSimpleFileSystemPresent(
82 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
85 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
91 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
92 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
94 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
101 Internal worker debug helper function to print out maps as they are added.
103 @param[in] Mapping string mapping that has been added
104 @param[in] DevicePath pointer to device path that has been mapped.
106 @retval EFI_SUCCESS the operation was successful.
107 @return other an error ocurred
114 InternalShellProtocolDebugPrintMessage (
115 IN CONST CHAR16
*Mapping
,
116 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
122 Status
= EFI_SUCCESS
;
125 if (Mapping
!= NULL
) {
126 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
128 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
129 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
137 This function creates a mapping for a device path.
139 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
141 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
142 then the mapping will be deleted.
143 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
145 @retval EFI_SUCCESS Mapping created or deleted successfully.
146 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
147 boot service function LocateDevicePath().
148 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
149 @retval EFI_INVALID_PARAMETER Mapping was NULL
150 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
151 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
152 @retval EFI_NOT_FOUND There was no mapping found to delete
153 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
158 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
159 IN CONST CHAR16
*Mapping
163 SHELL_MAP_LIST
*MapListNode
;
165 if (Mapping
== NULL
){
166 return (EFI_INVALID_PARAMETER
);
169 if (Mapping
[StrLen(Mapping
)-1] != ':') {
170 return (EFI_INVALID_PARAMETER
);
174 // Delete the mapping
176 if (DevicePath
== NULL
) {
177 if (IsListEmpty(&gShellMapList
.Link
)) {
178 return (EFI_NOT_FOUND
);
180 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
181 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
182 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
184 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
185 RemoveEntryList(&MapListNode
->Link
);
186 FreePool(MapListNode
);
187 return (EFI_SUCCESS
);
192 // We didnt find one to delete
194 return (EFI_NOT_FOUND
);
198 // make sure this is a valid to add device path
200 ///@todo add BlockIo to this test...
201 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
202 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
203 return (EFI_INVALID_PARAMETER
);
207 // First make sure there is no old mapping
209 Status
= EfiShellSetMap(NULL
, Mapping
);
210 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
215 // now add the new one.
217 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
223 Gets the device path from the mapping.
225 This function gets the device path associated with a mapping.
227 @param Mapping A pointer to the mapping
229 @retval !=NULL Pointer to the device path that corresponds to the
230 device mapping. The returned pointer does not need
232 @retval NULL There is no device path associated with the
235 CONST EFI_DEVICE_PATH_PROTOCOL
*
237 EfiShellGetDevicePathFromMap(
238 IN CONST CHAR16
*Mapping
241 SHELL_MAP_LIST
*MapListItem
;
248 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
249 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
250 StrnCatGrow(&NewName
, &Size
, L
":", 0);
253 MapListItem
= ShellCommandFindMapItem(NewName
);
257 if (MapListItem
!= NULL
) {
258 return (MapListItem
->DevicePath
);
264 Gets the mapping(s) that most closely matches the device path.
266 This function gets the mapping which corresponds to the device path *DevicePath. If
267 there is no exact match, then the mapping which most closely matches *DevicePath
268 is returned, and *DevicePath is updated to point to the remaining portion of the
269 device path. If there is an exact match, the mapping is returned and *DevicePath
270 points to the end-of-device-path node.
272 If there are multiple map names they will be semi-colon seperated in the
273 NULL-terminated string.
275 @param DevicePath On entry, points to a device path pointer. On
276 exit, updates the pointer to point to the
277 portion of the device path after the mapping.
279 @retval NULL No mapping was found.
280 @return !=NULL Pointer to NULL-terminated mapping. The buffer
281 is callee allocated and should be freed by the caller.
285 EfiShellGetMapFromDevicePath(
286 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
289 SHELL_MAP_LIST
*Node
;
290 CHAR16
*PathForReturn
;
292 // EFI_HANDLE PathHandle;
293 // EFI_HANDLE MapHandle;
294 // EFI_STATUS Status;
295 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
296 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
298 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
302 PathForReturn
= NULL
;
305 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
306 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
307 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
310 // check for exact match
312 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
313 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
315 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
317 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
320 if (PathForReturn
!= NULL
) {
321 while (!IsDevicePathEndType (*DevicePath
)) {
322 *DevicePath
= NextDevicePathNode (*DevicePath
);
324 SetDevicePathEndNode (*DevicePath
);
327 ///@todo finish code for inexact matches.
328 if (PathForReturn == NULL) {
331 DevicePathCopy = DuplicateDevicePath(*DevicePath);
332 ASSERT(DevicePathCopy != NULL);
333 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
334 ASSERT_EFI_ERROR(Status);
336 // check each of the device paths we have to get the root of the path for consist mappings
338 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
339 ; !IsNull(&gShellMapList.Link, &Node->Link)
340 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
342 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
345 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
346 ASSERT(MapPathCopy != NULL);
347 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
348 if (MapHandle == PathHandle) {
350 *DevicePath = DevicePathCopy;
353 DevicePathCopy = NULL;
354 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
355 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
360 // now add on the non-consistent mappings
362 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
363 ; !IsNull(&gShellMapList.Link, &Node->Link)
364 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
366 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
369 MapPathCopy = Node->DevicePath;
370 ASSERT(MapPathCopy != NULL);
371 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
372 if (MapHandle == PathHandle) {
373 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
374 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
381 return (AddBufferToFreeList(PathForReturn
));
385 Converts a device path to a file system-style path.
387 This function converts a device path to a file system path by replacing part, or all, of
388 the device path with the file-system mapping. If there are more than one application
389 file system mappings, the one that most closely matches Path will be used.
391 @param Path The pointer to the device path
393 @retval NULL the device path could not be found.
394 @return all The pointer of the NULL-terminated file path. The path
395 is callee-allocated and should be freed by the caller.
399 EfiShellGetFilePathFromDevicePath(
400 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
403 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
404 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
405 SHELL_MAP_LIST
*MapListItem
;
406 CHAR16
*PathForReturn
;
408 EFI_HANDLE PathHandle
;
409 EFI_HANDLE MapHandle
;
411 FILEPATH_DEVICE_PATH
*FilePath
;
412 FILEPATH_DEVICE_PATH
*AlignedNode
;
414 PathForReturn
= NULL
;
417 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
418 ASSERT(DevicePathCopy
!= NULL
);
419 if (DevicePathCopy
== NULL
) {
423 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
425 if (EFI_ERROR(Status
)) {
429 // check each of the device paths we have to get the root of the path
431 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
432 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
433 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
435 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
436 ASSERT(MapPathCopy
!= NULL
);
438 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
439 if (MapHandle
== PathHandle
) {
440 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
441 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
443 // go through all the remaining nodes in the device path
445 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
446 ; !IsDevicePathEnd (&FilePath
->Header
)
447 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
450 // all the rest should be file path nodes
452 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
453 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
454 FreePool(PathForReturn
);
455 PathForReturn
= NULL
;
459 // append the path part onto the filepath.
461 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
463 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
464 ASSERT (AlignedNode
!= NULL
);
466 // File Path Device Path Nodes 'can optionally add a "\" separator to
467 // the beginning and/or the end of the Path Name string.'
468 // (UEFI Spec 2.4 section 9.3.6.4).
469 // If necessary, add a "\", but otherwise don't
470 // (This is specified in the above section, and also implied by the
471 // UEFI Shell spec section 3.7)
472 if ((PathSize
!= 0) &&
473 (PathForReturn
!= NULL
) &&
474 (PathForReturn
[PathSize
- 1] != L
'\\') &&
475 (AlignedNode
->PathName
[0] != L
'\\')) {
476 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
479 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
480 FreePool(AlignedNode
);
482 } // for loop of remaining nodes
484 if (PathForReturn
!= NULL
) {
487 } // for loop of paths to check
488 return(PathForReturn
);
492 Converts a file system style name to a device path.
494 This function converts a file system style name to a device path, by replacing any
495 mapping references to the associated device path.
497 @param[in] Path The pointer to the path.
499 @return The pointer of the file path. The file path is callee
500 allocated and should be freed by the caller.
501 @retval NULL The path could not be found.
502 @retval NULL There was not enough available memory.
504 EFI_DEVICE_PATH_PROTOCOL
*
506 EfiShellGetDevicePathFromFilePath(
507 IN CONST CHAR16
*Path
514 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
515 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
516 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
517 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
528 if (StrStr(Path
, L
":") == NULL
) {
529 Cwd
= EfiShellGetCurDir(NULL
);
533 Size
= StrSize(Cwd
) + StrSize(Path
) - sizeof(CHAR16
);
534 NewPath
= AllocateZeroPool(Size
);
535 if (NewPath
== NULL
) {
538 StrnCpy(NewPath
, Cwd
, Size
/sizeof(CHAR16
)-1);
539 if (*Path
== L
'\\') {
541 while (PathRemoveLastItem(NewPath
)) ;
543 StrnCat(NewPath
, Path
, Size
/sizeof(CHAR16
) - 1 - StrLen(NewPath
));
544 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
546 return (DevicePathForReturn
);
551 // find the part before (but including) the : for the map name
553 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
554 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
555 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
560 // look up the device path in the map
562 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
563 if (DevicePath
== NULL
) {
565 // Must have been a bad Mapname
571 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
573 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
574 if (DevicePathCopy
== NULL
) {
583 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
584 if (EFI_ERROR(Status
)) {
585 if (DevicePathCopyForFree
!= NULL
) {
586 FreePool(DevicePathCopyForFree
);
593 // build the full device path
595 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
596 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
598 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
602 if (DevicePathCopyForFree
!= NULL
) {
603 FreePool(DevicePathCopyForFree
);
606 return (DevicePathForReturn
);
610 Gets the name of the device specified by the device handle.
612 This function gets the user-readable name of the device specified by the device
613 handle. If no user-readable name could be generated, then *BestDeviceName will be
614 NULL and EFI_NOT_FOUND will be returned.
616 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
617 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
620 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
621 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
622 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
623 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
624 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
626 @param DeviceHandle The handle of the device.
627 @param Flags Determines the possible sources of component names.
629 EFI_DEVICE_NAME_USE_COMPONENT_NAME
630 EFI_DEVICE_NAME_USE_DEVICE_PATH
631 @param Language A pointer to the language specified for the device
632 name, in the same format as described in the UEFI
633 specification, Appendix M
634 @param BestDeviceName On return, points to the callee-allocated NULL-
635 terminated name of the device. If no device name
636 could be found, points to NULL. The name must be
637 freed by the caller...
639 @retval EFI_SUCCESS Get the name successfully.
640 @retval EFI_NOT_FOUND Fail to get the device name.
641 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
642 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
643 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
647 EfiShellGetDeviceName(
648 IN EFI_HANDLE DeviceHandle
,
649 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
651 OUT CHAR16
**BestDeviceName
655 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
656 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
657 EFI_HANDLE
*HandleList
;
660 CHAR16
*DeviceNameToReturn
;
662 UINTN ParentControllerCount
;
663 EFI_HANDLE
*ParentControllerBuffer
;
664 UINTN ParentDriverCount
;
665 EFI_HANDLE
*ParentDriverBuffer
;
667 if (BestDeviceName
== NULL
||
670 return (EFI_INVALID_PARAMETER
);
674 // make sure one of the 2 supported bits is on
676 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
677 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
678 return (EFI_INVALID_PARAMETER
);
681 DeviceNameToReturn
= NULL
;
682 *BestDeviceName
= NULL
;
687 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
688 Status
= ParseHandleDatabaseByRelationship(
691 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
694 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
696 // Go through those handles until we get one that passes for GetComponentName
698 Status
= gBS
->OpenProtocol(
700 &gEfiComponentName2ProtocolGuid
,
704 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
705 if (EFI_ERROR(Status
)) {
706 Status
= gBS
->OpenProtocol(
708 &gEfiComponentNameProtocolGuid
,
712 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
715 if (EFI_ERROR(Status
)) {
718 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
719 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
722 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
726 if (HandleList
!= NULL
) {
727 FreePool(HandleList
);
731 // Now check the parent controller using this as the child.
733 if (DeviceNameToReturn
== NULL
){
734 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
735 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
736 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
737 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
739 // try using that driver's component name with controller and our driver as the child.
741 Status
= gBS
->OpenProtocol(
742 ParentDriverBuffer
[HandleCount
],
743 &gEfiComponentName2ProtocolGuid
,
747 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
748 if (EFI_ERROR(Status
)) {
749 Status
= gBS
->OpenProtocol(
750 ParentDriverBuffer
[HandleCount
],
751 &gEfiComponentNameProtocolGuid
,
755 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
758 if (EFI_ERROR(Status
)) {
761 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
762 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
765 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
772 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
773 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
777 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
780 // dont return on fail since we will try device path if that bit is on
782 if (DeviceNameToReturn
!= NULL
){
783 ASSERT(BestDeviceName
!= NULL
);
784 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
785 return (EFI_SUCCESS
);
788 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
789 Status
= gBS
->OpenProtocol(
791 &gEfiDevicePathProtocolGuid
,
795 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
796 if (!EFI_ERROR(Status
)) {
798 // use device path to text on the device path
800 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
801 return (EFI_SUCCESS
);
805 // none of the selected bits worked.
807 return (EFI_NOT_FOUND
);
811 Opens the root directory of a device on a handle
813 This function opens the root directory of a device and returns a file handle to it.
815 @param DeviceHandle The handle of the device that contains the volume.
816 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
819 @retval EFI_SUCCESS Root opened successfully.
820 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
822 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
823 @retval EFI_DEVICE_ERROR The device had an error
827 EfiShellOpenRootByHandle(
828 IN EFI_HANDLE DeviceHandle
,
829 OUT SHELL_FILE_HANDLE
*FileHandle
833 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
834 EFI_FILE_PROTOCOL
*RealFileHandle
;
835 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
838 // get the simple file system interface
840 Status
= gBS
->OpenProtocol(DeviceHandle
,
841 &gEfiSimpleFileSystemProtocolGuid
,
842 (VOID
**)&SimpleFileSystem
,
845 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
846 if (EFI_ERROR(Status
)) {
847 return (EFI_NOT_FOUND
);
850 Status
= gBS
->OpenProtocol(DeviceHandle
,
851 &gEfiDevicePathProtocolGuid
,
855 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
856 if (EFI_ERROR(Status
)) {
857 return (EFI_NOT_FOUND
);
860 // Open the root volume now...
862 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
863 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
868 Opens the root directory of a device.
870 This function opens the root directory of a device and returns a file handle to it.
872 @param DevicePath Points to the device path corresponding to the device where the
873 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
874 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
877 @retval EFI_SUCCESS Root opened successfully.
878 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
880 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
881 @retval EFI_DEVICE_ERROR The device had an error
882 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
887 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
888 OUT SHELL_FILE_HANDLE
*FileHandle
894 if (FileHandle
== NULL
) {
895 return (EFI_INVALID_PARAMETER
);
899 // find the handle of the device with that device handle and the file system
902 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
905 if (EFI_ERROR(Status
)) {
906 return (EFI_NOT_FOUND
);
909 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
913 Returns whether any script files are currently being processed.
915 @retval TRUE There is at least one script file active.
916 @retval FALSE No script files are active now.
921 EfiShellBatchIsActive (
925 if (ShellCommandGetCurrentScriptFile() == NULL
) {
932 Worker function to open a file based on a device path. this will open the root
933 of the volume and then traverse down to the file itself.
935 @param DevicePath Device Path of the file.
936 @param FileHandle Pointer to the file upon a successful return.
937 @param OpenMode mode to open file in.
938 @param Attributes the File Attributes to use when creating a new file.
940 @retval EFI_SUCCESS the file is open and FileHandle is valid
941 @retval EFI_UNSUPPORTED the device path cotained non-path elements
942 @retval other an error ocurred.
946 InternalOpenFileDevicePath(
947 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
948 OUT SHELL_FILE_HANDLE
*FileHandle
,
950 IN UINT64 Attributes OPTIONAL
954 FILEPATH_DEVICE_PATH
*FilePathNode
;
956 SHELL_FILE_HANDLE ShellHandle
;
957 EFI_FILE_PROTOCOL
*Handle1
;
958 EFI_FILE_PROTOCOL
*Handle2
;
959 FILEPATH_DEVICE_PATH
*AlignedNode
;
961 if (FileHandle
== NULL
) {
962 return (EFI_INVALID_PARAMETER
);
972 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
974 if (!EFI_ERROR(Status
)) {
975 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
976 if (Handle1
!= NULL
) {
978 // chop off the begining part before the file system part...
981 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
984 if (!EFI_ERROR(Status
)) {
986 // To access as a file system, the file path should only
987 // contain file path components. Follow the file path nodes
988 // and find the target file
990 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
991 ; !IsDevicePathEnd (&FilePathNode
->Header
)
992 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
994 SHELL_FREE_NON_NULL(AlignedNode
);
995 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
997 // For file system access each node should be a file path component
999 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
1000 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1002 Status
= EFI_UNSUPPORTED
;
1007 // Open this file path node
1013 // if this is the last node in the DevicePath always create (if that was requested).
1015 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1016 Status
= Handle2
->Open (
1019 AlignedNode
->PathName
,
1026 // This is not the last node and we dont want to 'create' existing
1027 // directory entries...
1031 // open without letting it create
1032 // prevents error on existing files/directories
1034 Status
= Handle2
->Open (
1037 AlignedNode
->PathName
,
1038 OpenMode
&~EFI_FILE_MODE_CREATE
,
1042 // if above failed now open and create the 'item'
1043 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1045 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1046 Status
= Handle2
->Open (
1049 AlignedNode
->PathName
,
1056 // Close the last node
1058 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1061 // If there's been an error, stop
1063 if (EFI_ERROR (Status
)) {
1070 SHELL_FREE_NON_NULL(AlignedNode
);
1071 if (EFI_ERROR(Status
)) {
1072 if (Handle1
!= NULL
) {
1073 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1076 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1082 Creates a file or directory by name.
1084 This function creates an empty new file or directory with the specified attributes and
1085 returns the new file's handle. If the file already exists and is read-only, then
1086 EFI_INVALID_PARAMETER will be returned.
1088 If the file already existed, it is truncated and its attributes updated. If the file is
1089 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1091 If the file name begins with >v, then the file handle which is returned refers to the
1092 shell environment variable with the specified name. If the shell environment variable
1093 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1095 @param FileName Pointer to NULL-terminated file path
1096 @param FileAttribs The new file's attrbiutes. the different attributes are
1097 described in EFI_FILE_PROTOCOL.Open().
1098 @param FileHandle On return, points to the created file handle or directory's handle
1100 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1101 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1102 @retval EFI_UNSUPPORTED could not open the file path
1103 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1104 file the file system on the device.
1105 @retval EFI_NO_MEDIA the device has no medium.
1106 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1108 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1110 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1111 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1112 when the media is write-protected.
1113 @retval EFI_ACCESS_DENIED The service denied access to the file.
1114 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1115 @retval EFI_VOLUME_FULL The volume is full.
1120 IN CONST CHAR16
*FileName
,
1121 IN UINT64 FileAttribs
,
1122 OUT SHELL_FILE_HANDLE
*FileHandle
1125 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1129 // Is this for an environment variable
1130 // do we start with >v
1132 if (StrStr(FileName
, L
">v") == FileName
) {
1133 if (!IsVolatileEnv(FileName
+2)) {
1134 return (EFI_INVALID_PARAMETER
);
1136 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1137 return (EFI_SUCCESS
);
1141 // We are opening a regular file.
1143 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1144 if (DevicePath
== NULL
) {
1145 return (EFI_NOT_FOUND
);
1148 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
);
1149 FreePool(DevicePath
);
1155 Register a GUID and a localized human readable name for it.
1157 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1158 names must be used whenever a shell command outputs GUID information.
1160 This function is only available when the major and minor versions in the
1161 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1163 @param[in] Guid A pointer to the GUID being registered.
1164 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1166 @retval EFI_SUCCESS The operation was successful.
1167 @retval EFI_INVALID_PARAMETER Guid was NULL.
1168 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1169 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1173 EfiShellRegisterGuidName(
1174 IN CONST EFI_GUID
*Guid
,
1175 IN CONST CHAR16
*GuidName
1178 return (AddNewGuidNameMapping(Guid
, GuidName
, NULL
));
1182 Opens a file or a directory by file name.
1184 This function opens the specified file in the specified OpenMode and returns a file
1186 If the file name begins with >v, then the file handle which is returned refers to the
1187 shell environment variable with the specified name. If the shell environment variable
1188 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1189 EFI_INVALID_PARAMETER is returned.
1191 If the file name is >i, then the file handle which is returned refers to the standard
1192 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1195 If the file name is >o, then the file handle which is returned refers to the standard
1196 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1199 If the file name is >e, then the file handle which is returned refers to the standard
1200 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1203 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1204 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1207 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1210 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1211 @param FileHandle On return, points to the file handle.
1212 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1213 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1215 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1216 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1217 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1218 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1219 system could not be found on the device. FileHandle is NULL.
1220 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1221 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1222 longer supported. FileHandle is NULL.
1223 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1224 the FileName. FileHandle is NULL.
1225 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1226 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1227 when the media is write-protected. FileHandle is NULL.
1228 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1229 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1231 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1235 EfiShellOpenFileByName(
1236 IN CONST CHAR16
*FileName
,
1237 OUT SHELL_FILE_HANDLE
*FileHandle
,
1241 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1247 // Is this for StdIn
1249 if (StrCmp(FileName
, L
">i") == 0) {
1251 // make sure not writing to StdIn
1253 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1254 return (EFI_INVALID_PARAMETER
);
1256 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1257 ASSERT(*FileHandle
!= NULL
);
1258 return (EFI_SUCCESS
);
1262 // Is this for StdOut
1264 if (StrCmp(FileName
, L
">o") == 0) {
1266 // make sure not writing to StdIn
1268 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1269 return (EFI_INVALID_PARAMETER
);
1271 *FileHandle
= &FileInterfaceStdOut
;
1272 return (EFI_SUCCESS
);
1276 // Is this for NUL file
1278 if (StrCmp(FileName
, L
"NUL") == 0) {
1279 *FileHandle
= &FileInterfaceNulFile
;
1280 return (EFI_SUCCESS
);
1284 // Is this for StdErr
1286 if (StrCmp(FileName
, L
">e") == 0) {
1288 // make sure not writing to StdIn
1290 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1291 return (EFI_INVALID_PARAMETER
);
1293 *FileHandle
= &FileInterfaceStdErr
;
1294 return (EFI_SUCCESS
);
1298 // Is this for an environment variable
1299 // do we start with >v
1301 if (StrStr(FileName
, L
">v") == FileName
) {
1302 if (!IsVolatileEnv(FileName
+2) &&
1303 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1304 return (EFI_INVALID_PARAMETER
);
1306 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1307 return (EFI_SUCCESS
);
1311 // We are opening a regular file.
1313 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1314 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1315 if (DevicePath
== NULL
) {
1316 return (EFI_NOT_FOUND
);
1320 // Copy the device path, open the file, then free the memory
1322 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1323 FreePool(DevicePath
);
1329 Deletes the file specified by the file name.
1331 This function deletes a file.
1333 @param FileName Points to the NULL-terminated file name.
1335 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1336 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1337 @sa EfiShellCreateFile
1341 EfiShellDeleteFileByName(
1342 IN CONST CHAR16
*FileName
1345 SHELL_FILE_HANDLE FileHandle
;
1351 // get a handle to the file
1353 Status
= EfiShellCreateFile(FileName
,
1356 if (EFI_ERROR(Status
)) {
1360 // now delete the file
1362 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1366 Disables the page break output mode.
1370 EfiShellDisablePageBreak (
1374 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1378 Enables the page break output mode.
1382 EfiShellEnablePageBreak (
1386 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1390 internal worker function to load and run an image via device path.
1392 @param ParentImageHandle A handle of the image that is executing the specified
1394 @param DevicePath device path of the file to execute
1395 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1396 containing the command line. If NULL then the command-
1398 @param Environment Points to a NULL-terminated array of environment
1399 variables with the format 'x=y', where x is the
1400 environment variable name and y is the value. If this
1401 is NULL, then the current shell environment is used.
1403 @param[out] StartImageStatus Returned status from gBS->StartImage.
1404 @param[out] ExitDataSize ExitDataSize as returned from gBS->StartImage
1405 @param[out] ExitData ExitData as returned from gBS->StartImage
1407 @retval EFI_SUCCESS The command executed successfully. The status code
1408 returned by the command is pointed to by StatusCode.
1409 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1410 @retval EFI_OUT_OF_RESOURCES Out of resources.
1411 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1415 InternalShellExecuteDevicePath(
1416 IN CONST EFI_HANDLE
*ParentImageHandle
,
1417 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1418 IN CONST CHAR16
*CommandLine OPTIONAL
,
1419 IN CONST CHAR16
**Environment OPTIONAL
,
1420 OUT EFI_STATUS
*StartImageStatus OPTIONAL
,
1421 OUT UINTN
*ExitDataSize OPTIONAL
,
1422 OUT CHAR16
**ExitData OPTIONAL
1426 EFI_STATUS StartStatus
;
1427 EFI_STATUS CleanupStatus
;
1428 EFI_HANDLE NewHandle
;
1429 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1430 LIST_ENTRY OrigEnvs
;
1431 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1432 UINTN InternalExitDataSize
;
1433 UINTN
*ExitDataSizePtr
;
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
= AllocateCopyPool(StrSize(Node
->FullName
), Node
->FullName
);
1849 NewNode
->FileName
= AllocateCopyPool(StrSize(Node
->FileName
), Node
->FileName
);
1850 NewNode
->Info
= AllocateCopyPool((UINTN
)Node
->Info
->Size
, Node
->Info
);
1851 if ( NewNode
->FullName
== NULL
1852 || NewNode
->FileName
== NULL
1853 || NewNode
->Info
== NULL
1855 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1856 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1857 SHELL_FREE_NON_NULL(NewNode
->Info
);
1858 SHELL_FREE_NON_NULL(NewNode
);
1861 NewNode
->Status
= Node
->Status
;
1862 NewNode
->Handle
= Node
->Handle
;
1864 Node
->Handle
= NULL
;
1867 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1871 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1872 failed it will return NULL.
1874 @param[in] BasePath the Path to prepend onto filename for FullPath
1875 @param[in] Status Status member initial value.
1876 @param[in] FileName FileName member initial value.
1877 @param[in] Handle Handle member initial value.
1878 @param[in] Info Info struct to copy.
1880 @retval NULL An error ocurred.
1881 @return a pointer to the newly allocated structure.
1883 EFI_SHELL_FILE_INFO
*
1885 CreateAndPopulateShellFileInfo(
1886 IN CONST CHAR16
*BasePath
,
1887 IN CONST EFI_STATUS Status
,
1888 IN CONST CHAR16
*FileName
,
1889 IN CONST SHELL_FILE_HANDLE Handle
,
1890 IN CONST EFI_FILE_INFO
*Info
1893 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1900 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1901 if (ShellFileListItem
== NULL
) {
1904 if (Info
!= NULL
&& Info
->Size
!= 0) {
1905 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1906 if (ShellFileListItem
->Info
== NULL
) {
1907 FreePool(ShellFileListItem
);
1910 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1912 ShellFileListItem
->Info
= NULL
;
1914 if (FileName
!= NULL
) {
1915 ASSERT(TempString
== NULL
);
1916 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1917 if (ShellFileListItem
->FileName
== NULL
) {
1918 FreePool(ShellFileListItem
->Info
);
1919 FreePool(ShellFileListItem
);
1923 ShellFileListItem
->FileName
= NULL
;
1927 if (BasePath
!= NULL
) {
1928 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1929 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1930 if (TempString
== NULL
) {
1931 FreePool((VOID
*)ShellFileListItem
->FileName
);
1932 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1933 FreePool(ShellFileListItem
);
1937 if (ShellFileListItem
->FileName
!= NULL
) {
1938 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1939 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1940 if (TempString
== NULL
) {
1941 FreePool((VOID
*)ShellFileListItem
->FileName
);
1942 FreePool(ShellFileListItem
->Info
);
1943 FreePool(ShellFileListItem
);
1948 TempString
= PathCleanUpDirectories(TempString
);
1950 ShellFileListItem
->FullName
= TempString
;
1951 ShellFileListItem
->Status
= Status
;
1952 ShellFileListItem
->Handle
= Handle
;
1954 return (ShellFileListItem
);
1958 Find all files in a specified directory.
1960 @param FileDirHandle Handle of the directory to search.
1961 @param FileList On return, points to the list of files in the directory
1962 or NULL if there are no files in the directory.
1964 @retval EFI_SUCCESS File information was returned successfully.
1965 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1966 @retval EFI_DEVICE_ERROR The device reported an error.
1967 @retval EFI_NO_MEDIA The device media is not present.
1968 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1969 @return An error from FileHandleGetFileName().
1973 EfiShellFindFilesInDir(
1974 IN SHELL_FILE_HANDLE FileDirHandle
,
1975 OUT EFI_SHELL_FILE_INFO
**FileList
1978 EFI_SHELL_FILE_INFO
*ShellFileList
;
1979 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1980 EFI_FILE_INFO
*FileInfo
;
1989 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1990 if (EFI_ERROR(Status
)) {
1994 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1997 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1998 if (TempString
== NULL
) {
1999 SHELL_FREE_NON_NULL(BasePath
);
2000 return (EFI_OUT_OF_RESOURCES
);
2002 TempSpot
= StrStr(TempString
, L
";");
2004 if (TempSpot
!= NULL
) {
2005 *TempSpot
= CHAR_NULL
;
2008 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2009 if (TempString
== NULL
) {
2010 SHELL_FREE_NON_NULL(BasePath
);
2011 return (EFI_OUT_OF_RESOURCES
);
2013 SHELL_FREE_NON_NULL(BasePath
);
2014 BasePath
= TempString
;
2018 ShellFileList
= NULL
;
2019 ShellFileListItem
= NULL
;
2021 Status
= EFI_SUCCESS
;
2024 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2025 ; !EFI_ERROR(Status
) && !NoFile
2026 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2029 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2031 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2033 EFI_SUCCESS
, // success since we didnt fail to open it...
2035 NULL
, // no handle since not open
2038 if (ShellFileList
== NULL
) {
2039 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2040 ASSERT(ShellFileList
!= NULL
);
2041 InitializeListHead(&ShellFileList
->Link
);
2043 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2045 if (EFI_ERROR(Status
)) {
2046 EfiShellFreeFileList(&ShellFileList
);
2049 *FileList
= ShellFileList
;
2051 SHELL_FREE_NON_NULL(BasePath
);
2056 Get the GUID value from a human readable name.
2058 If GuidName is a known GUID name, then update Guid to have the correct value for
2061 This function is only available when the major and minor versions in the
2062 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2064 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2065 @param[out] Guid A pointer to the GUID structure to be filled in.
2067 @retval EFI_SUCCESS The operation was successful.
2068 @retval EFI_INVALID_PARAMETER Guid was NULL.
2069 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2070 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2074 EfiShellGetGuidFromName(
2075 IN CONST CHAR16
*GuidName
,
2082 if (Guid
== NULL
|| GuidName
== NULL
) {
2083 return (EFI_INVALID_PARAMETER
);
2086 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2088 if (!EFI_ERROR(Status
)) {
2089 CopyGuid(NewGuid
, Guid
);
2096 Get the human readable name for a GUID from the value.
2098 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2099 should not modify the value.
2101 This function is only available when the major and minor versions in the
2102 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2104 @param[in] Guid A pointer to the GUID being queried.
2105 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2107 @retval EFI_SUCCESS The operation was successful.
2108 @retval EFI_INVALID_PARAMETER Guid was NULL.
2109 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2110 @retval EFI_NOT_FOUND Guid is not assigned a name.
2114 EfiShellGetGuidName(
2115 IN CONST EFI_GUID
*Guid
,
2116 OUT CONST CHAR16
**GuidName
2121 if (Guid
== NULL
|| GuidName
== NULL
) {
2122 return (EFI_INVALID_PARAMETER
);
2125 Name
= GetStringNameFromGuid(Guid
, NULL
);
2126 if (Name
== NULL
|| StrLen(Name
) == 0) {
2127 SHELL_FREE_NON_NULL(Name
);
2128 return (EFI_NOT_FOUND
);
2131 *GuidName
= AddBufferToFreeList(Name
);
2133 return (EFI_SUCCESS
);
2137 Updates a file name to be preceeded by the mapped drive name
2139 @param[in] BasePath the Mapped drive name to prepend
2140 @param[in, out] Path pointer to pointer to the file name to update.
2143 @retval EFI_OUT_OF_RESOURCES
2148 IN CONST CHAR16
*BasePath
,
2149 IN OUT CHAR16
**Path
2158 ASSERT(Path
!= NULL
);
2159 ASSERT(*Path
!= NULL
);
2160 ASSERT(BasePath
!= NULL
);
2163 // convert a local path to an absolute path
2165 if (StrStr(*Path
, L
":") == NULL
) {
2166 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2167 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2168 if (Path2
== NULL
) {
2169 return (EFI_OUT_OF_RESOURCES
);
2171 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2172 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2173 if (Path2
== NULL
) {
2174 return (EFI_OUT_OF_RESOURCES
);
2181 return (EFI_SUCCESS
);
2185 If FileHandle is a directory then the function reads from FileHandle and reads in
2186 each of the FileInfo structures. If one of them matches the Pattern's first
2187 "level" then it opens that handle and calls itself on that handle.
2189 If FileHandle is a file and matches all of the remaining Pattern (which would be
2190 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2192 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2193 FreeFileList with FileList.
2195 @param[in] FilePattern The FilePattern to check against.
2196 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2197 @param[in] FileHandle The FileHandle to start with
2198 @param[in, out] FileList pointer to pointer to list of found files.
2199 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2200 @param[in] MapName The file system name this file is on.
2202 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2203 @retval EFI_NOT_FOUND no files were found
2204 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2209 IN CONST CHAR16
*FilePattern
,
2210 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2211 IN SHELL_FILE_HANDLE FileHandle
,
2212 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2213 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2214 IN CONST CHAR16
*MapName
2218 CONST CHAR16
*NextFilePatternStart
;
2219 CHAR16
*CurrentFilePattern
;
2220 EFI_SHELL_FILE_INFO
*ShellInfo
;
2221 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2222 EFI_SHELL_FILE_INFO
*NewShellNode
;
2223 EFI_FILE_INFO
*FileInfo
;
2225 CHAR16
*NewFullName
;
2228 if ( FilePattern
== NULL
2229 || UnicodeCollation
== NULL
2232 return (EFI_INVALID_PARAMETER
);
2235 CurrentFilePattern
= NULL
;
2237 if (*FilePattern
== L
'\\') {
2241 for( NextFilePatternStart
= FilePattern
2242 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2243 ; NextFilePatternStart
++);
2245 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2246 ASSERT(CurrentFilePattern
!= NULL
);
2247 StrnCpy(CurrentFilePattern
, FilePattern
, NextFilePatternStart
-FilePattern
);
2249 if (CurrentFilePattern
[0] == CHAR_NULL
2250 &&NextFilePatternStart
[0] == CHAR_NULL
2253 // we want the parent or root node (if no parent)
2255 if (ParentNode
== NULL
) {
2257 // We want the root node. create the node.
2259 FileInfo
= FileHandleGetInfo(FileHandle
);
2260 NewShellNode
= CreateAndPopulateShellFileInfo(
2267 SHELL_FREE_NON_NULL(FileInfo
);
2270 // Add the current parameter FileHandle to the list, then end...
2272 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2274 if (NewShellNode
== NULL
) {
2275 Status
= EFI_OUT_OF_RESOURCES
;
2277 NewShellNode
->Handle
= NULL
;
2278 if (*FileList
== NULL
) {
2279 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2280 InitializeListHead(&((*FileList
)->Link
));
2284 // Add to the returning to use list
2286 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2288 Status
= EFI_SUCCESS
;
2291 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2293 if (!EFI_ERROR(Status
)){
2294 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2299 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2300 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2301 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2303 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2304 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2305 Size
= StrSize(ShellInfoNode
->FullName
);
2306 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2307 NewFullName
= AllocateZeroPool(Size
);
2308 if (NewFullName
== NULL
) {
2309 Status
= EFI_OUT_OF_RESOURCES
;
2311 StrnCpy(NewFullName
, MapName
, Size
/sizeof(CHAR16
)-1);
2312 StrnCat(NewFullName
, ShellInfoNode
->FullName
+1, (Size
/sizeof(CHAR16
))-StrLen(NewFullName
)-1);
2313 FreePool((VOID
*)ShellInfoNode
->FullName
);
2314 ShellInfoNode
->FullName
= NewFullName
;
2317 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2319 // should be a directory
2323 // don't open the . and .. directories
2325 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2326 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2331 if (EFI_ERROR(Status
)) {
2335 // Open the directory since we need that handle in the next recursion.
2337 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2340 // recurse with the next part of the pattern
2342 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2344 } else if (!EFI_ERROR(Status
)) {
2350 // copy the information we need into a new Node
2352 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2353 ASSERT(NewShellNode
!= NULL
);
2354 if (NewShellNode
== NULL
) {
2355 Status
= EFI_OUT_OF_RESOURCES
;
2357 if (*FileList
== NULL
) {
2358 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2359 InitializeListHead(&((*FileList
)->Link
));
2363 // Add to the returning to use list
2365 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2368 if (EFI_ERROR(Status
)) {
2372 if (EFI_ERROR(Status
)) {
2373 EfiShellFreeFileList(&ShellInfo
);
2375 Status
= EfiShellFreeFileList(&ShellInfo
);
2380 FreePool(CurrentFilePattern
);
2385 Find files that match a specified pattern.
2387 This function searches for all files and directories that match the specified
2388 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2389 information is placed in the file list FileList.
2391 Wildcards are processed
2392 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2394 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2395 field is set to NULL.
2397 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2399 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2400 @param FileList On return, points to the start of a file list containing the names
2401 of all matching files or else points to NULL if no matching files
2402 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2404 @retval EFI_SUCCESS Files found. FileList is a valid list.
2405 @retval EFI_NOT_FOUND No files found.
2406 @retval EFI_NO_MEDIA The device has no media
2407 @retval EFI_DEVICE_ERROR The device reported an error
2408 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2413 IN CONST CHAR16
*FilePattern
,
2414 OUT EFI_SHELL_FILE_INFO
**FileList
2418 CHAR16
*PatternCopy
;
2419 CHAR16
*PatternCurrentLocation
;
2420 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2421 SHELL_FILE_HANDLE RootFileHandle
;
2425 if ( FilePattern
== NULL
2427 || StrStr(FilePattern
, L
":") == NULL
2429 return (EFI_INVALID_PARAMETER
);
2431 Status
= EFI_SUCCESS
;
2432 RootDevicePath
= NULL
;
2433 RootFileHandle
= NULL
;
2435 PatternCopy
= AllocateCopyPool(StrSize(FilePattern
), FilePattern
);
2436 if (PatternCopy
== NULL
) {
2437 return (EFI_OUT_OF_RESOURCES
);
2440 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2442 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2445 ASSERT(MapName
== NULL
);
2446 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2447 if (MapName
== NULL
) {
2448 Status
= EFI_OUT_OF_RESOURCES
;
2450 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2451 if (RootDevicePath
== NULL
) {
2452 Status
= EFI_INVALID_PARAMETER
;
2454 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2455 if (!EFI_ERROR(Status
)) {
2456 for ( PatternCurrentLocation
= PatternCopy
2457 ; *PatternCurrentLocation
!= ':'
2458 ; PatternCurrentLocation
++);
2459 PatternCurrentLocation
++;
2460 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2462 FreePool(RootDevicePath
);
2466 SHELL_FREE_NON_NULL(PatternCopy
);
2467 SHELL_FREE_NON_NULL(MapName
);
2473 Opens the files that match the path specified.
2475 This function opens all of the files specified by Path. Wildcards are processed
2476 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2477 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2479 @param Path A pointer to the path string.
2480 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2481 EFI_FILE_MODE_WRITE.
2482 @param FileList Points to the start of a list of files opened.
2484 @retval EFI_SUCCESS Create the file list successfully.
2485 @return Others Can't create the file list.
2489 EfiShellOpenFileList(
2492 IN OUT EFI_SHELL_FILE_INFO
**FileList
2496 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2499 CONST CHAR16
*CurDir
;
2502 PathCleanUpDirectories(Path
);
2507 if (FileList
== NULL
|| *FileList
== NULL
) {
2508 return (EFI_INVALID_PARAMETER
);
2511 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2516 // convert a local path to an absolute path
2518 if (StrStr(Path
, L
":") == NULL
) {
2519 CurDir
= EfiShellGetCurDir(NULL
);
2520 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2521 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2522 if (*Path
== L
'\\') {
2524 while (PathRemoveLastItem(Path2
)) ;
2526 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2527 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2529 ASSERT(Path2
== NULL
);
2530 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2533 PathCleanUpDirectories (Path2
);
2538 Status
= EfiShellFindFiles(Path2
, FileList
);
2542 if (EFI_ERROR(Status
)) {
2548 // We had no errors so open all the files (that are not already opened...)
2550 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2551 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2552 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2554 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2555 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2561 return (EFI_NOT_FOUND
);
2563 return(EFI_SUCCESS
);
2567 Gets the environment variable and Attributes, or list of environment variables. Can be
2568 used instead of GetEnv().
2570 This function returns the current value of the specified environment variable and
2571 the Attributes. If no variable name was specified, then all of the known
2572 variables will be returned.
2574 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2575 then the function will return all of the defined shell
2576 environment variables. In the case where multiple environment
2577 variables are being returned, each variable will be terminated
2578 by a NULL, and the list will be terminated by a double NULL.
2579 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2580 the environment variable. In the case where Name is NULL, and
2581 multiple environment variables are being returned, Attributes
2584 @retval NULL The environment variable doesn't exist.
2585 @return A non-NULL value points to the variable's value. The returned
2586 pointer does not need to be freed by the caller.
2591 IN CONST CHAR16
*Name
,
2592 OUT UINT32
*Attributes OPTIONAL
2600 CHAR16
*CurrentWriteLocation
;
2607 // Get all our environment variables
2609 InitializeListHead(&List
);
2610 Status
= GetEnvironmentVariableList(&List
);
2611 if (EFI_ERROR(Status
)){
2616 // Build the semi-colon delimited list. (2 passes)
2618 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2619 ; !IsNull(&List
, &Node
->Link
)
2620 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2622 ASSERT(Node
->Key
!= NULL
);
2623 Size
+= StrSize(Node
->Key
);
2626 Size
+= 2*sizeof(CHAR16
);
2628 Buffer
= AllocateZeroPool(Size
);
2629 if (Buffer
== NULL
) {
2630 if (!IsListEmpty (&List
)) {
2631 FreeEnvironmentVariableList(&List
);
2635 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2637 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2638 ; !IsNull(&List
, &Node
->Link
)
2639 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2641 ASSERT(Node
->Key
!= NULL
);
2642 StrnCpy(CurrentWriteLocation
, Node
->Key
, (Size
)/sizeof(CHAR16
) - (CurrentWriteLocation
- ((CHAR16
*)Buffer
)) - 1);
2643 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2649 if (!IsListEmpty (&List
)) {
2650 FreeEnvironmentVariableList(&List
);
2654 // We are doing a specific environment variable
2658 // get the size we need for this EnvVariable
2660 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2661 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2663 // Allocate the space and recall the get function
2665 Buffer
= AllocateZeroPool(Size
);
2666 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2669 // we didnt get it (might not exist)
2670 // free the memory if we allocated any and return NULL
2672 if (EFI_ERROR(Status
)) {
2673 if (Buffer
!= NULL
) {
2681 // return the buffer
2683 return (AddBufferToFreeList(Buffer
));
2687 Gets either a single or list of environment variables.
2689 If name is not NULL then this function returns the current value of the specified
2690 environment variable.
2692 If Name is NULL, then a list of all environment variable names is returned. Each is a
2693 NULL terminated string with a double NULL terminating the list.
2695 @param Name A pointer to the environment variable name. If
2696 Name is NULL, then the function will return all
2697 of the defined shell environment variables. In
2698 the case where multiple environment variables are
2699 being returned, each variable will be terminated by
2700 a NULL, and the list will be terminated by a double
2703 @retval !=NULL A pointer to the returned string.
2704 The returned pointer does not need to be freed by the caller.
2706 @retval NULL The environment variable doesn't exist or there are
2707 no environment variables.
2712 IN CONST CHAR16
*Name
2715 return (EfiShellGetEnvEx(Name
, NULL
));
2719 Internal variable setting function. Allows for setting of the read only variables.
2721 @param Name Points to the NULL-terminated environment variable name.
2722 @param Value Points to the NULL-terminated environment variable value. If the value is an
2723 empty string then the environment variable is deleted.
2724 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2726 @retval EFI_SUCCESS The environment variable was successfully updated.
2730 InternalEfiShellSetEnv(
2731 IN CONST CHAR16
*Name
,
2732 IN CONST CHAR16
*Value
,
2736 if (Value
== NULL
|| StrLen(Value
) == 0) {
2737 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2739 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2741 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2743 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2749 Sets the environment variable.
2751 This function changes the current value of the specified environment variable. If the
2752 environment variable exists and the Value is an empty string, then the environment
2753 variable is deleted. If the environment variable exists and the Value is not an empty
2754 string, then the value of the environment variable is changed. If the environment
2755 variable does not exist and the Value is an empty string, there is no action. If the
2756 environment variable does not exist and the Value is a non-empty string, then the
2757 environment variable is created and assigned the specified value.
2759 For a description of volatile and non-volatile environment variables, see UEFI Shell
2760 2.0 specification section 3.6.1.
2762 @param Name Points to the NULL-terminated environment variable name.
2763 @param Value Points to the NULL-terminated environment variable value. If the value is an
2764 empty string then the environment variable is deleted.
2765 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2767 @retval EFI_SUCCESS The environment variable was successfully updated.
2772 IN CONST CHAR16
*Name
,
2773 IN CONST CHAR16
*Value
,
2777 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2778 return (EFI_INVALID_PARAMETER
);
2781 // Make sure we dont 'set' a predefined read only variable
2783 if (gUnicodeCollation
->StriColl(
2787 ||gUnicodeCollation
->StriColl(
2791 ||gUnicodeCollation
->StriColl(
2795 ||gUnicodeCollation
->StriColl(
2798 L
"uefishellsupport") == 0
2799 ||gUnicodeCollation
->StriColl(
2802 L
"uefishellversion") == 0
2803 ||gUnicodeCollation
->StriColl(
2806 L
"uefiversion") == 0
2808 return (EFI_INVALID_PARAMETER
);
2810 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2814 Returns the current directory on the specified device.
2816 If FileSystemMapping is NULL, it returns the current working directory. If the
2817 FileSystemMapping is not NULL, it returns the current directory associated with the
2818 FileSystemMapping. In both cases, the returned name includes the file system
2819 mapping (i.e. fs0:\current-dir).
2821 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2822 then the current working directory is returned.
2824 @retval !=NULL The current directory.
2825 @retval NULL Current directory does not exist.
2830 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2833 CHAR16
*PathToReturn
;
2835 SHELL_MAP_LIST
*MapListItem
;
2836 if (!IsListEmpty(&gShellMapList
.Link
)) {
2838 // if parameter is NULL, use current
2840 if (FileSystemMapping
== NULL
) {
2841 return (EfiShellGetEnv(L
"cwd"));
2844 PathToReturn
= NULL
;
2845 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2846 if (MapListItem
!= NULL
) {
2847 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2848 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2849 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2852 return (AddBufferToFreeList(PathToReturn
));
2859 Changes the current directory on the specified device.
2861 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2862 mapped name, this function changes the current working directory.
2864 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2865 current file system and the current directory on that file system are changed.
2867 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2870 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2871 directory on the specified file system.
2873 If the current working directory or the current working file system is changed then the
2874 %cwd% environment variable will be updated
2876 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2877 directory is changed.
2878 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2880 @retval EFI_SUCCESS The operation was sucessful
2881 @retval EFI_NOT_FOUND The file system could not be found
2886 IN CONST CHAR16
*FileSystem OPTIONAL
,
2887 IN CONST CHAR16
*Dir
2891 SHELL_MAP_LIST
*MapListItem
;
2895 CHAR16
*DirectoryName
;
2902 DirectoryName
= NULL
;
2904 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2905 return (EFI_INVALID_PARAMETER
);
2908 if (IsListEmpty(&gShellMapList
.Link
)){
2909 return (EFI_NOT_FOUND
);
2912 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2913 ASSERT(DirectoryName
!= NULL
);
2915 PathCleanUpDirectories(DirectoryName
);
2917 if (FileSystem
== NULL
) {
2919 // determine the file system mapping to use
2921 if (StrStr(DirectoryName
, L
":") != NULL
) {
2922 ASSERT(MapName
== NULL
);
2923 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2926 // find the file system mapping's entry in the list
2929 if (MapName
!= NULL
) {
2930 MapListItem
= ShellCommandFindMapItem(MapName
);
2933 // make that the current file system mapping
2935 if (MapListItem
!= NULL
) {
2936 gShellCurDir
= MapListItem
;
2939 MapListItem
= gShellCurDir
;
2942 if (MapListItem
== NULL
) {
2943 return (EFI_NOT_FOUND
);
2947 // now update the MapListItem's current directory
2949 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2950 FreePool(MapListItem
->CurrentDirectoryPath
);
2951 MapListItem
->CurrentDirectoryPath
= NULL
;
2953 if (MapName
!= NULL
) {
2954 TempLen
= StrLen(MapName
);
2955 if (TempLen
!= StrLen(DirectoryName
)) {
2956 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2957 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2960 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2961 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2963 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2964 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2965 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2969 // cant have a mapping in the directory...
2971 if (StrStr(DirectoryName
, L
":") != NULL
) {
2972 return (EFI_INVALID_PARAMETER
);
2975 // FileSystem != NULL
2977 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2978 if (MapListItem
== NULL
) {
2979 return (EFI_INVALID_PARAMETER
);
2981 // gShellCurDir = MapListItem;
2982 if (DirectoryName
!= NULL
) {
2984 // change current dir on that file system
2987 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2988 FreePool(MapListItem
->CurrentDirectoryPath
);
2989 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2991 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2992 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
2993 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2994 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
2995 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2996 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2997 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] != L
'\\') {
2998 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2999 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3004 // if updated the current directory then update the environment variable
3006 if (MapListItem
== gShellCurDir
) {
3008 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3009 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3010 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3011 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3012 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3013 FreePool(TempString
);
3016 return(EFI_SUCCESS
);
3020 Return help information about a specific command.
3022 This function returns the help information for the specified command. The help text
3023 can be internal to the shell or can be from a UEFI Shell manual page.
3025 If Sections is specified, then each section name listed will be compared in a casesensitive
3026 manner, to the section names described in Appendix B. If the section exists,
3027 it will be appended to the returned help text. If the section does not exist, no
3028 information will be returned. If Sections is NULL, then all help text information
3029 available will be returned.
3031 @param Command Points to the NULL-terminated UEFI Shell command name.
3032 @param Sections Points to the NULL-terminated comma-delimited
3033 section names to return. If NULL, then all
3034 sections will be returned.
3035 @param HelpText On return, points to a callee-allocated buffer
3036 containing all specified help text.
3038 @retval EFI_SUCCESS The help text was returned.
3039 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3041 @retval EFI_INVALID_PARAMETER HelpText is NULL
3042 @retval EFI_NOT_FOUND There is no help text available for Command.
3046 EfiShellGetHelpText(
3047 IN CONST CHAR16
*Command
,
3048 IN CONST CHAR16
*Sections OPTIONAL
,
3049 OUT CHAR16
**HelpText
3052 CONST CHAR16
*ManFileName
;
3056 ASSERT(HelpText
!= NULL
);
3059 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3061 if (ManFileName
!= NULL
) {
3062 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3064 if ((StrLen(Command
)> 4)
3065 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3066 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3067 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3068 && (Command
[StrLen(Command
)-4] == L
'.')
3070 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3071 ASSERT(FixCommand
!= NULL
);
3073 StrnCpy(FixCommand
, Command
, StrLen(Command
)-4);
3074 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3075 FreePool(FixCommand
);
3078 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3084 Gets the enable status of the page break output mode.
3086 User can use this function to determine current page break mode.
3088 @retval TRUE The page break output mode is enabled.
3089 @retval FALSE The page break output mode is disabled.
3093 EfiShellGetPageBreak(
3097 return(ShellInfoObject
.PageBreakEnabled
);
3101 Judges whether the active shell is the root shell.
3103 This function makes the user to know that whether the active Shell is the root shell.
3105 @retval TRUE The active Shell is the root Shell.
3106 @retval FALSE The active Shell is NOT the root Shell.
3110 EfiShellIsRootShell(
3114 return(ShellInfoObject
.RootShellInstance
);
3118 function to return a semi-colon delimeted list of all alias' in the current shell
3120 up to caller to free the memory.
3122 @retval NULL No alias' were found
3123 @retval NULL An error ocurred getting alias'
3124 @return !NULL a list of all alias'
3128 InternalEfiShellGetListAlias(
3136 CHAR16
*VariableName
;
3141 Status
= gRT
->QueryVariableInfo(EFI_VARIABLE_NON_VOLATILE
|EFI_VARIABLE_BOOTSERVICE_ACCESS
, &MaxStorSize
, &RemStorSize
, &MaxVarSize
);
3142 ASSERT_EFI_ERROR(Status
);
3144 VariableName
= AllocateZeroPool((UINTN
)MaxVarSize
);
3148 if (VariableName
== NULL
) {
3152 VariableName
[0] = CHAR_NULL
;
3155 NameSize
= (UINTN
)MaxVarSize
;
3156 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3157 if (Status
== EFI_NOT_FOUND
){
3160 ASSERT_EFI_ERROR(Status
);
3161 if (EFI_ERROR(Status
)) {
3164 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3165 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3166 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3167 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3170 FreePool(VariableName
);
3176 Convert a null-terminated unicode string, in-place, to all lowercase.
3179 @param Str The null-terminated string to be converted to all lowercase.
3181 @return The null-terminated string converted into all lowercase.
3190 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3191 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3192 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3199 This function returns the command associated with a alias or a list of all
3202 @param[in] Alias Points to the NULL-terminated shell alias.
3203 If this parameter is NULL, then all
3204 aliases will be returned in ReturnedData.
3205 @param[out] Volatile upon return of a single command if TRUE indicates
3206 this is stored in a volatile fashion. FALSE otherwise.
3208 @return If Alias is not NULL, it will return a pointer to
3209 the NULL-terminated command for that alias.
3210 If Alias is NULL, ReturnedData points to a ';'
3211 delimited list of alias (e.g.
3212 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3213 @retval NULL an error ocurred
3214 @retval NULL Alias was not a valid Alias
3219 IN CONST CHAR16
*Alias
,
3220 OUT BOOLEAN
*Volatile OPTIONAL
3229 // Convert to lowercase to make aliases case-insensitive
3230 if (Alias
!= NULL
) {
3231 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3232 ASSERT (AliasLower
!= NULL
);
3233 ToLower (AliasLower
);
3235 if (Volatile
== NULL
) {
3236 return (AddBufferToFreeList(GetVariable(AliasLower
, &gShellAliasGuid
)));
3240 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3241 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3242 RetVal
= AllocateZeroPool(RetSize
);
3243 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3245 if (EFI_ERROR(Status
)) {
3246 if (RetVal
!= NULL
) {
3251 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3257 FreePool (AliasLower
);
3258 return (AddBufferToFreeList(RetVal
));
3260 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3264 Changes a shell command alias.
3266 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3268 this function does not check for built in alias'.
3270 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3271 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3272 Command refers to an alias, that alias will be deleted.
3273 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3274 Alias being set will be stored in a non-volatile fashion.
3276 @retval EFI_SUCCESS Alias created or deleted successfully.
3277 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3282 IN CONST CHAR16
*Command
,
3283 IN CONST CHAR16
*Alias
,
3290 // Convert to lowercase to make aliases case-insensitive
3291 if (Alias
!= NULL
) {
3292 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3293 ASSERT (AliasLower
!= NULL
);
3294 ToLower (AliasLower
);
3300 // We must be trying to remove one if Alias is NULL
3302 if (Alias
== NULL
) {
3304 // remove an alias (but passed in COMMAND parameter)
3306 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3309 // Add and replace are the same
3312 // We dont check the error return on purpose since the variable may not exist.
3313 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3315 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3318 if (Alias
!= NULL
) {
3319 FreePool (AliasLower
);
3325 Changes a shell command alias.
3327 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3330 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3331 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3332 Command refers to an alias, that alias will be deleted.
3333 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3334 FALSE and the alias already exists, then the existing alias is unchanged and
3335 EFI_ACCESS_DENIED is returned.
3336 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3337 Alias being set will be stored in a non-volatile fashion.
3339 @retval EFI_SUCCESS Alias created or deleted successfully.
3340 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3341 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3343 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3348 IN CONST CHAR16
*Command
,
3349 IN CONST CHAR16
*Alias
,
3354 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3356 // cant set over a built in alias
3358 return (EFI_ACCESS_DENIED
);
3359 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3361 // Command is null or empty
3363 return (EFI_INVALID_PARAMETER
);
3364 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3366 // Alias already exists, Replace not set
3368 return (EFI_ACCESS_DENIED
);
3370 return (InternalSetAlias(Command
, Alias
, Volatile
));
3374 // Pure FILE_HANDLE operations are passed to FileHandleLib
3375 // these functions are indicated by the *
3376 EFI_SHELL_PROTOCOL mShellProtocol
= {
3382 EfiShellGetHelpText
,
3383 EfiShellGetDevicePathFromMap
,
3384 EfiShellGetMapFromDevicePath
,
3385 EfiShellGetDevicePathFromFilePath
,
3386 EfiShellGetFilePathFromDevicePath
,
3390 EfiShellOpenFileList
,
3391 EfiShellFreeFileList
,
3392 EfiShellRemoveDupInFileList
,
3393 EfiShellBatchIsActive
,
3394 EfiShellIsRootShell
,
3395 EfiShellEnablePageBreak
,
3396 EfiShellDisablePageBreak
,
3397 EfiShellGetPageBreak
,
3398 EfiShellGetDeviceName
,
3399 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3400 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3401 EfiShellOpenFileByName
,
3404 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3405 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3406 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3407 EfiShellDeleteFileByName
,
3408 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3409 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3410 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3412 EfiShellFindFilesInDir
,
3413 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3415 EfiShellOpenRootByHandle
,
3417 SHELL_MAJOR_VERSION
,
3418 SHELL_MINOR_VERSION
,
3420 // New for UEFI Shell 2.1
3421 EfiShellRegisterGuidName
,
3422 EfiShellGetGuidName
,
3423 EfiShellGetGuidFromName
,
3428 Function to create and install on the current handle.
3430 Will overwrite any existing ShellProtocols in the system to be sure that
3431 the current shell is in control.
3433 This must be removed via calling CleanUpShellProtocol().
3435 @param[in, out] NewShell The pointer to the pointer to the structure
3438 @retval EFI_SUCCESS The operation was successful.
3439 @return An error from LocateHandle, CreateEvent, or other core function.
3443 CreatePopulateInstallShellProtocol (
3444 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3450 UINTN HandleCounter
;
3451 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3453 if (NewShell
== NULL
) {
3454 return (EFI_INVALID_PARAMETER
);
3459 OldProtocolNode
= NULL
;
3460 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3463 // Initialize EfiShellProtocol object...
3465 Status
= gBS
->CreateEvent(0,
3469 &mShellProtocol
.ExecutionBreak
);
3470 if (EFI_ERROR(Status
)) {
3475 // Get the size of the buffer we need.
3477 Status
= gBS
->LocateHandle(ByProtocol
,
3478 &gEfiShellProtocolGuid
,
3482 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3484 // Allocate and recall with buffer of correct size
3486 Buffer
= AllocateZeroPool(BufferSize
);
3487 if (Buffer
== NULL
) {
3488 return (EFI_OUT_OF_RESOURCES
);
3490 Status
= gBS
->LocateHandle(ByProtocol
,
3491 &gEfiShellProtocolGuid
,
3495 if (EFI_ERROR(Status
)) {
3500 // now overwrite each of them, but save the info to restore when we end.
3502 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3503 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3504 ASSERT(OldProtocolNode
!= NULL
);
3505 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3506 &gEfiShellProtocolGuid
,
3507 (VOID
**) &(OldProtocolNode
->Interface
),
3510 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3512 if (!EFI_ERROR(Status
)) {
3514 // reinstall over the old one...
3516 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3517 Status
= gBS
->ReinstallProtocolInterface(
3518 OldProtocolNode
->Handle
,
3519 &gEfiShellProtocolGuid
,
3520 OldProtocolNode
->Interface
,
3521 (VOID
*)(&mShellProtocol
));
3522 if (!EFI_ERROR(Status
)) {
3524 // we reinstalled sucessfully. log this so we can reverse it later.
3528 // add to the list for subsequent...
3530 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3535 } else if (Status
== EFI_NOT_FOUND
) {
3536 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3538 // no one else published yet. just publish it ourselves.
3540 Status
= gBS
->InstallProtocolInterface (
3542 &gEfiShellProtocolGuid
,
3543 EFI_NATIVE_INTERFACE
,
3544 (VOID
*)(&mShellProtocol
));
3547 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3548 ///@todo support ShellEnvironment2
3549 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3552 if (!EFI_ERROR(Status
)) {
3553 *NewShell
= &mShellProtocol
;
3559 Opposite of CreatePopulateInstallShellProtocol.
3561 Free all memory and restore the system to the state it was in before calling
3562 CreatePopulateInstallShellProtocol.
3564 @param[in, out] NewShell The pointer to the new shell protocol structure.
3566 @retval EFI_SUCCESS The operation was successful.
3570 CleanUpShellProtocol (
3571 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3575 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3576 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3579 // if we need to restore old protocols...
3581 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3582 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3583 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3584 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3586 RemoveEntryList(&Node2
->Link
);
3587 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3588 &gEfiShellProtocolGuid
,
3595 // no need to restore
3597 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3598 &gEfiShellProtocolGuid
,
3601 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3602 NewShell
->ExecutionBreak
= NULL
;
3604 Status
= gBS
->OpenProtocol(
3605 gST
->ConsoleInHandle
,
3606 &gEfiSimpleTextInputExProtocolGuid
,
3610 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3612 if (!EFI_ERROR (Status
)) {
3613 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3614 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3615 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3616 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3617 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3618 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3619 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3620 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3626 Notification function for keystrokes.
3628 @param[in] KeyData The key that was pressed.
3630 @retval EFI_SUCCESS The operation was successful.
3634 NotificationFunction(
3635 IN EFI_KEY_DATA
*KeyData
3638 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3639 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3640 (KeyData
->Key
.UnicodeChar
== 3)
3642 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3643 return (EFI_UNSUPPORTED
);
3645 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3646 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3647 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3649 ShellInfoObject
.HaltOutput
= TRUE
;
3651 return (EFI_SUCCESS
);
3655 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3656 feature's enabled state was not known when the shell initially launched.
3658 @retval EFI_SUCCESS The feature is enabled.
3659 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3663 InernalEfiShellStartMonitor(
3667 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3668 EFI_KEY_DATA KeyData
;
3671 Status
= gBS
->OpenProtocol(
3672 gST
->ConsoleInHandle
,
3673 &gEfiSimpleTextInputExProtocolGuid
,
3677 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3678 if (EFI_ERROR(Status
)) {
3683 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3684 ShellInfoObject
.HiiHandle
);
3685 return (EFI_SUCCESS
);
3688 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3689 return (EFI_UNSUPPORTED
);
3692 KeyData
.KeyState
.KeyToggleState
= 0;
3693 KeyData
.Key
.ScanCode
= 0;
3694 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3695 KeyData
.Key
.UnicodeChar
= L
'c';
3697 Status
= SimpleEx
->RegisterKeyNotify(
3700 NotificationFunction
,
3701 &ShellInfoObject
.CtrlCNotifyHandle1
);
3703 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3704 if (!EFI_ERROR(Status
)) {
3705 Status
= SimpleEx
->RegisterKeyNotify(
3708 NotificationFunction
,
3709 &ShellInfoObject
.CtrlCNotifyHandle2
);
3711 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3712 KeyData
.Key
.UnicodeChar
= 3;
3713 if (!EFI_ERROR(Status
)) {
3714 Status
= SimpleEx
->RegisterKeyNotify(
3717 NotificationFunction
,
3718 &ShellInfoObject
.CtrlCNotifyHandle3
);
3720 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3721 if (!EFI_ERROR(Status
)) {
3722 Status
= SimpleEx
->RegisterKeyNotify(
3725 NotificationFunction
,
3726 &ShellInfoObject
.CtrlCNotifyHandle4
);