2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
6 Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #define INIT_NAME_BUFFER_SIZE 128
22 Close an open file handle.
24 This function closes a specified file handle. All "dirty" cached file data is
25 flushed to the device, and the file is closed. In all cases the handle is
28 @param[in] FileHandle The file handle to close.
30 @retval EFI_SUCCESS The file handle was closed successfully.
35 IN SHELL_FILE_HANDLE FileHandle
38 ShellFileHandleRemove(FileHandle
);
39 return (FileHandleClose(ConvertShellHandleToEfiFileProtocol(FileHandle
)));
43 Internal worker to determine whether there is a BlockIo somewhere
44 upon the device path specified.
46 @param[in] DevicePath The device path to test.
48 @retval TRUE gEfiBlockIoProtocolGuid was installed on a handle with this device path
49 @retval FALSE gEfiBlockIoProtocolGuid was not found.
53 InternalShellProtocolIsBlockIoPresent(
54 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
57 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
63 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
64 Status
= gBS
->LocateDevicePath(&gEfiBlockIoProtocolGuid
, &DevicePathCopy
, &Handle
);
66 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
73 Internal worker to determine whether there is a file system somewhere
74 upon the device path specified.
76 @param[in] DevicePath The device path to test.
78 @retval TRUE gEfiSimpleFileSystemProtocolGuid was installed on a handle with this device path
79 @retval FALSE gEfiSimpleFileSystemProtocolGuid was not found.
83 InternalShellProtocolIsSimpleFileSystemPresent(
84 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
87 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
93 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
;
94 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
96 if ((Handle
!= NULL
) && (!EFI_ERROR(Status
))) {
103 Internal worker debug helper function to print out maps as they are added.
105 @param[in] Mapping string mapping that has been added
106 @param[in] DevicePath pointer to device path that has been mapped.
108 @retval EFI_SUCCESS the operation was successful.
109 @return other an error ocurred
116 InternalShellProtocolDebugPrintMessage (
117 IN CONST CHAR16
*Mapping
,
118 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
124 Status
= EFI_SUCCESS
;
127 if (Mapping
!= NULL
) {
128 DEBUG((EFI_D_INFO
, "Added new map item:\"%S\"\r\n", Mapping
));
130 Temp
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
131 DEBUG((EFI_D_INFO
, "DevicePath: %S\r\n", Temp
));
139 This function creates a mapping for a device path.
141 If both DeviecPath and Mapping are NULL, this will reset the mapping to default values.
143 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
144 then the mapping will be deleted.
145 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
147 @retval EFI_SUCCESS Mapping created or deleted successfully.
148 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
149 boot service function LocateDevicePath().
150 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
151 @retval EFI_INVALID_PARAMETER Mapping was NULL
152 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
153 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
154 @retval EFI_NOT_FOUND There was no mapping found to delete
155 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
160 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
161 IN CONST CHAR16
*Mapping
165 SHELL_MAP_LIST
*MapListNode
;
167 if (Mapping
== NULL
){
168 return (EFI_INVALID_PARAMETER
);
171 if (Mapping
[StrLen(Mapping
)-1] != ':') {
172 return (EFI_INVALID_PARAMETER
);
176 // Delete the mapping
178 if (DevicePath
== NULL
) {
179 if (IsListEmpty(&gShellMapList
.Link
)) {
180 return (EFI_NOT_FOUND
);
182 for ( MapListNode
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
183 ; !IsNull(&gShellMapList
.Link
, &MapListNode
->Link
)
184 ; MapListNode
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListNode
->Link
)
186 if (StringNoCaseCompare(&MapListNode
->MapName
, &Mapping
) == 0) {
187 RemoveEntryList(&MapListNode
->Link
);
188 FreePool(MapListNode
);
189 return (EFI_SUCCESS
);
194 // We didnt find one to delete
196 return (EFI_NOT_FOUND
);
200 // make sure this is a valid to add device path
202 ///@todo add BlockIo to this test...
203 if (!InternalShellProtocolIsSimpleFileSystemPresent(DevicePath
)
204 && !InternalShellProtocolIsBlockIoPresent(DevicePath
)) {
205 return (EFI_INVALID_PARAMETER
);
209 // First make sure there is no old mapping
211 Status
= EfiShellSetMap(NULL
, Mapping
);
212 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_FOUND
)) {
217 // now add the new one.
219 Status
= ShellCommandAddMapItemAndUpdatePath(Mapping
, DevicePath
, 0, FALSE
);
225 Gets the device path from the mapping.
227 This function gets the device path associated with a mapping.
229 @param Mapping A pointer to the mapping
231 @retval !=NULL Pointer to the device path that corresponds to the
232 device mapping. The returned pointer does not need
234 @retval NULL There is no device path associated with the
237 CONST EFI_DEVICE_PATH_PROTOCOL
*
239 EfiShellGetDevicePathFromMap(
240 IN CONST CHAR16
*Mapping
243 SHELL_MAP_LIST
*MapListItem
;
250 StrnCatGrow(&NewName
, &Size
, Mapping
, 0);
251 if (Mapping
[StrLen(Mapping
)-1] != L
':') {
252 StrnCatGrow(&NewName
, &Size
, L
":", 0);
255 MapListItem
= ShellCommandFindMapItem(NewName
);
259 if (MapListItem
!= NULL
) {
260 return (MapListItem
->DevicePath
);
266 Gets the mapping(s) that most closely matches the device path.
268 This function gets the mapping which corresponds to the device path *DevicePath. If
269 there is no exact match, then the mapping which most closely matches *DevicePath
270 is returned, and *DevicePath is updated to point to the remaining portion of the
271 device path. If there is an exact match, the mapping is returned and *DevicePath
272 points to the end-of-device-path node.
274 If there are multiple map names they will be semi-colon seperated in the
275 NULL-terminated string.
277 @param DevicePath On entry, points to a device path pointer. On
278 exit, updates the pointer to point to the
279 portion of the device path after the mapping.
281 @retval NULL No mapping was found.
282 @return !=NULL Pointer to NULL-terminated mapping. The buffer
283 is callee allocated and should be freed by the caller.
287 EfiShellGetMapFromDevicePath(
288 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
291 SHELL_MAP_LIST
*Node
;
292 CHAR16
*PathForReturn
;
294 // EFI_HANDLE PathHandle;
295 // EFI_HANDLE MapHandle;
296 // EFI_STATUS Status;
297 // EFI_DEVICE_PATH_PROTOCOL *DevicePathCopy;
298 // EFI_DEVICE_PATH_PROTOCOL *MapPathCopy;
300 if (DevicePath
== NULL
|| *DevicePath
== NULL
) {
304 PathForReturn
= NULL
;
307 for ( Node
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
308 ; !IsNull(&gShellMapList
.Link
, &Node
->Link
)
309 ; Node
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &Node
->Link
)
312 // check for exact match
314 if (DevicePathCompare(DevicePath
, &Node
->DevicePath
) == 0) {
315 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
317 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, L
";", 0);
319 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, Node
->MapName
, 0);
322 if (PathForReturn
!= NULL
) {
323 while (!IsDevicePathEndType (*DevicePath
)) {
324 *DevicePath
= NextDevicePathNode (*DevicePath
);
326 SetDevicePathEndNode (*DevicePath
);
329 ///@todo finish code for inexact matches.
330 if (PathForReturn == NULL) {
333 DevicePathCopy = DuplicateDevicePath(*DevicePath);
334 ASSERT(DevicePathCopy != NULL);
335 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &DevicePathCopy, &PathHandle);
336 ASSERT_EFI_ERROR(Status);
338 // check each of the device paths we have to get the root of the path for consist mappings
340 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
341 ; !IsNull(&gShellMapList.Link, &Node->Link)
342 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
344 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) == 0) {
347 MapPathCopy = DuplicateDevicePath(Node->DevicePath);
348 ASSERT(MapPathCopy != NULL);
349 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
350 if (MapHandle == PathHandle) {
352 *DevicePath = DevicePathCopy;
355 DevicePathCopy = NULL;
356 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
357 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
362 // now add on the non-consistent mappings
364 for ( Node = (SHELL_MAP_LIST *)GetFirstNode(&gShellMapList.Link)
365 ; !IsNull(&gShellMapList.Link, &Node->Link)
366 ; Node = (SHELL_MAP_LIST *)GetNextNode(&gShellMapList.Link, &Node->Link)
368 if ((Node->Flags & SHELL_MAP_FLAGS_CONSIST) != 0) {
371 MapPathCopy = Node->DevicePath;
372 ASSERT(MapPathCopy != NULL);
373 Status = gBS->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid, &MapPathCopy, &MapHandle);
374 if (MapHandle == PathHandle) {
375 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, Node->MapName, 0);
376 PathForReturn = StrnCatGrow(&PathForReturn, &PathSize, L";", 0);
383 return (AddBufferToFreeList(PathForReturn
));
387 Converts a device path to a file system-style path.
389 This function converts a device path to a file system path by replacing part, or all, of
390 the device path with the file-system mapping. If there are more than one application
391 file system mappings, the one that most closely matches Path will be used.
393 @param Path The pointer to the device path
395 @retval NULL the device path could not be found.
396 @return all The pointer of the NULL-terminated file path. The path
397 is callee-allocated and should be freed by the caller.
401 EfiShellGetFilePathFromDevicePath(
402 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
405 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
406 EFI_DEVICE_PATH_PROTOCOL
*MapPathCopy
;
407 SHELL_MAP_LIST
*MapListItem
;
408 CHAR16
*PathForReturn
;
410 EFI_HANDLE PathHandle
;
411 EFI_HANDLE MapHandle
;
413 FILEPATH_DEVICE_PATH
*FilePath
;
414 FILEPATH_DEVICE_PATH
*AlignedNode
;
416 PathForReturn
= NULL
;
419 DevicePathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)Path
;
420 ASSERT(DevicePathCopy
!= NULL
);
421 if (DevicePathCopy
== NULL
) {
425 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &PathHandle
);
427 if (EFI_ERROR(Status
)) {
431 // check each of the device paths we have to get the root of the path
433 for ( MapListItem
= (SHELL_MAP_LIST
*)GetFirstNode(&gShellMapList
.Link
)
434 ; !IsNull(&gShellMapList
.Link
, &MapListItem
->Link
)
435 ; MapListItem
= (SHELL_MAP_LIST
*)GetNextNode(&gShellMapList
.Link
, &MapListItem
->Link
)
437 MapPathCopy
= (EFI_DEVICE_PATH_PROTOCOL
*)MapListItem
->DevicePath
;
438 ASSERT(MapPathCopy
!= NULL
);
440 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &MapPathCopy
, &MapHandle
);
441 if (MapHandle
== PathHandle
) {
442 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
443 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, MapListItem
->MapName
, 0);
445 // go through all the remaining nodes in the device path
447 for ( FilePath
= (FILEPATH_DEVICE_PATH
*)DevicePathCopy
448 ; !IsDevicePathEnd (&FilePath
->Header
)
449 ; FilePath
= (FILEPATH_DEVICE_PATH
*)NextDevicePathNode (&FilePath
->Header
)
452 // If any node is not a file path node, then the conversion can not be completed
454 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
455 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
456 FreePool(PathForReturn
);
461 // append the path part onto the filepath.
463 ASSERT((PathForReturn
== NULL
&& PathSize
== 0) || (PathForReturn
!= NULL
));
465 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePath
), FilePath
);
466 ASSERT (AlignedNode
!= NULL
);
468 // File Path Device Path Nodes 'can optionally add a "\" separator to
469 // the beginning and/or the end of the Path Name string.'
470 // (UEFI Spec 2.4 section 9.3.6.4).
471 // If necessary, add a "\", but otherwise don't
472 // (This is specified in the above section, and also implied by the
473 // UEFI Shell spec section 3.7)
474 if ((PathSize
!= 0) &&
475 (PathForReturn
!= NULL
) &&
476 (PathForReturn
[PathSize
- 1] != L
'\\') &&
477 (AlignedNode
->PathName
[0] != L
'\\')) {
478 PathForReturn
= StrnCatGrow (&PathForReturn
, &PathSize
, L
"\\", 1);
481 PathForReturn
= StrnCatGrow(&PathForReturn
, &PathSize
, AlignedNode
->PathName
, 0);
482 FreePool(AlignedNode
);
483 } // for loop of remaining nodes
485 if (PathForReturn
!= NULL
) {
488 } // for loop of paths to check
489 return(PathForReturn
);
493 Converts a file system style name to a device path.
495 This function converts a file system style name to a device path, by replacing any
496 mapping references to the associated device path.
498 @param[in] Path The pointer to the path.
500 @return The pointer of the file path. The file path is callee
501 allocated and should be freed by the caller.
502 @retval NULL The path could not be found.
503 @retval NULL There was not enough available memory.
505 EFI_DEVICE_PATH_PROTOCOL
*
507 EfiShellGetDevicePathFromFilePath(
508 IN CONST CHAR16
*Path
515 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
516 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
517 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
518 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
529 if (StrStr(Path
, L
":") == NULL
) {
530 Cwd
= EfiShellGetCurDir(NULL
);
534 Size
= StrSize(Cwd
) + StrSize(Path
);
535 NewPath
= AllocateZeroPool(Size
);
536 if (NewPath
== NULL
) {
539 StrCpyS(NewPath
, Size
/sizeof(CHAR16
), Cwd
);
540 StrCatS(NewPath
, Size
/sizeof(CHAR16
), L
"\\");
541 if (*Path
== L
'\\') {
543 while (PathRemoveLastItem(NewPath
)) ;
545 StrCatS(NewPath
, Size
/sizeof(CHAR16
), Path
);
546 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
548 return (DevicePathForReturn
);
553 // find the part before (but including) the : for the map name
555 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
556 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
557 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
562 // look up the device path in the map
564 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
565 if (DevicePath
== NULL
) {
567 // Must have been a bad Mapname
573 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
575 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
576 if (DevicePathCopy
== NULL
) {
585 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
586 if (EFI_ERROR(Status
)) {
587 if (DevicePathCopyForFree
!= NULL
) {
588 FreePool(DevicePathCopyForFree
);
595 // build the full device path
597 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
598 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
600 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
604 if (DevicePathCopyForFree
!= NULL
) {
605 FreePool(DevicePathCopyForFree
);
608 return (DevicePathForReturn
);
612 Gets the name of the device specified by the device handle.
614 This function gets the user-readable name of the device specified by the device
615 handle. If no user-readable name could be generated, then *BestDeviceName will be
616 NULL and EFI_NOT_FOUND will be returned.
618 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
619 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
622 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
623 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
624 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
625 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
626 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
628 @param DeviceHandle The handle of the device.
629 @param Flags Determines the possible sources of component names.
631 EFI_DEVICE_NAME_USE_COMPONENT_NAME
632 EFI_DEVICE_NAME_USE_DEVICE_PATH
633 @param Language A pointer to the language specified for the device
634 name, in the same format as described in the UEFI
635 specification, Appendix M
636 @param BestDeviceName On return, points to the callee-allocated NULL-
637 terminated name of the device. If no device name
638 could be found, points to NULL. The name must be
639 freed by the caller...
641 @retval EFI_SUCCESS Get the name successfully.
642 @retval EFI_NOT_FOUND Fail to get the device name.
643 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
644 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
645 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
649 EfiShellGetDeviceName(
650 IN EFI_HANDLE DeviceHandle
,
651 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
653 OUT CHAR16
**BestDeviceName
657 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
658 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
659 EFI_HANDLE
*HandleList
;
662 CHAR16
*DeviceNameToReturn
;
664 UINTN ParentControllerCount
;
665 EFI_HANDLE
*ParentControllerBuffer
;
666 UINTN ParentDriverCount
;
667 EFI_HANDLE
*ParentDriverBuffer
;
669 if (BestDeviceName
== NULL
||
672 return (EFI_INVALID_PARAMETER
);
676 // make sure one of the 2 supported bits is on
678 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
679 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
680 return (EFI_INVALID_PARAMETER
);
683 DeviceNameToReturn
= NULL
;
684 *BestDeviceName
= NULL
;
689 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
690 Status
= ParseHandleDatabaseByRelationship(
693 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
696 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
698 // Go through those handles until we get one that passes for GetComponentName
700 Status
= gBS
->OpenProtocol(
702 &gEfiComponentName2ProtocolGuid
,
706 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
707 if (EFI_ERROR(Status
)) {
708 Status
= gBS
->OpenProtocol(
710 &gEfiComponentNameProtocolGuid
,
714 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
717 if (EFI_ERROR(Status
)) {
720 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
721 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
724 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
728 if (HandleList
!= NULL
) {
729 FreePool(HandleList
);
733 // Now check the parent controller using this as the child.
735 if (DeviceNameToReturn
== NULL
){
736 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
737 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
738 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
739 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
741 // try using that driver's component name with controller and our driver as the child.
743 Status
= gBS
->OpenProtocol(
744 ParentDriverBuffer
[HandleCount
],
745 &gEfiComponentName2ProtocolGuid
,
749 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
750 if (EFI_ERROR(Status
)) {
751 Status
= gBS
->OpenProtocol(
752 ParentDriverBuffer
[HandleCount
],
753 &gEfiComponentNameProtocolGuid
,
757 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
760 if (EFI_ERROR(Status
)) {
763 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
764 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
767 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
774 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
775 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
779 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
782 // dont return on fail since we will try device path if that bit is on
784 if (DeviceNameToReturn
!= NULL
){
785 ASSERT(BestDeviceName
!= NULL
);
786 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
787 return (EFI_SUCCESS
);
790 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
791 Status
= gBS
->OpenProtocol(
793 &gEfiDevicePathProtocolGuid
,
797 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
798 if (!EFI_ERROR(Status
)) {
800 // use device path to text on the device path
802 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
803 return (EFI_SUCCESS
);
807 // none of the selected bits worked.
809 return (EFI_NOT_FOUND
);
813 Opens the root directory of a device on a handle
815 This function opens the root directory of a device and returns a file handle to it.
817 @param DeviceHandle The handle of the device that contains the volume.
818 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
821 @retval EFI_SUCCESS Root opened successfully.
822 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
824 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
825 @retval EFI_DEVICE_ERROR The device had an error
829 EfiShellOpenRootByHandle(
830 IN EFI_HANDLE DeviceHandle
,
831 OUT SHELL_FILE_HANDLE
*FileHandle
835 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
836 EFI_FILE_PROTOCOL
*RealFileHandle
;
837 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
840 // get the simple file system interface
842 Status
= gBS
->OpenProtocol(DeviceHandle
,
843 &gEfiSimpleFileSystemProtocolGuid
,
844 (VOID
**)&SimpleFileSystem
,
847 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
848 if (EFI_ERROR(Status
)) {
849 return (EFI_NOT_FOUND
);
852 Status
= gBS
->OpenProtocol(DeviceHandle
,
853 &gEfiDevicePathProtocolGuid
,
857 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
858 if (EFI_ERROR(Status
)) {
859 return (EFI_NOT_FOUND
);
862 // Open the root volume now...
864 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
865 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
870 Opens the root directory of a device.
872 This function opens the root directory of a device and returns a file handle to it.
874 @param DevicePath Points to the device path corresponding to the device where the
875 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
876 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
879 @retval EFI_SUCCESS Root opened successfully.
880 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
882 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
883 @retval EFI_DEVICE_ERROR The device had an error
884 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
889 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
890 OUT SHELL_FILE_HANDLE
*FileHandle
896 if (FileHandle
== NULL
) {
897 return (EFI_INVALID_PARAMETER
);
901 // find the handle of the device with that device handle and the file system
904 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
907 if (EFI_ERROR(Status
)) {
908 return (EFI_NOT_FOUND
);
911 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
915 Returns whether any script files are currently being processed.
917 @retval TRUE There is at least one script file active.
918 @retval FALSE No script files are active now.
923 EfiShellBatchIsActive (
927 if (ShellCommandGetCurrentScriptFile() == NULL
) {
934 Worker function to open a file based on a device path. this will open the root
935 of the volume and then traverse down to the file itself.
937 @param DevicePath Device Path of the file.
938 @param FileHandle Pointer to the file upon a successful return.
939 @param OpenMode mode to open file in.
940 @param Attributes the File Attributes to use when creating a new file.
942 @retval EFI_SUCCESS the file is open and FileHandle is valid
943 @retval EFI_UNSUPPORTED the device path cotained non-path elements
944 @retval other an error ocurred.
948 InternalOpenFileDevicePath(
949 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
950 OUT SHELL_FILE_HANDLE
*FileHandle
,
952 IN UINT64 Attributes OPTIONAL
956 FILEPATH_DEVICE_PATH
*FilePathNode
;
958 SHELL_FILE_HANDLE ShellHandle
;
959 EFI_FILE_PROTOCOL
*Handle1
;
960 EFI_FILE_PROTOCOL
*Handle2
;
961 FILEPATH_DEVICE_PATH
*AlignedNode
;
963 if (FileHandle
== NULL
) {
964 return (EFI_INVALID_PARAMETER
);
974 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
976 if (!EFI_ERROR(Status
)) {
977 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
978 if (Handle1
!= NULL
) {
980 // chop off the begining part before the file system part...
983 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
986 if (!EFI_ERROR(Status
)) {
988 // To access as a file system, the file path should only
989 // contain file path components. Follow the file path nodes
990 // and find the target file
992 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
993 ; !IsDevicePathEnd (&FilePathNode
->Header
)
994 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
996 SHELL_FREE_NON_NULL(AlignedNode
);
997 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
999 // For file system access each node should be a file path component
1001 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
1002 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1004 Status
= EFI_UNSUPPORTED
;
1009 // Open this file path node
1015 // if this is the last node in the DevicePath always create (if that was requested).
1017 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1018 Status
= Handle2
->Open (
1021 AlignedNode
->PathName
,
1028 // This is not the last node and we dont want to 'create' existing
1029 // directory entries...
1033 // open without letting it create
1034 // prevents error on existing files/directories
1036 Status
= Handle2
->Open (
1039 AlignedNode
->PathName
,
1040 OpenMode
&~EFI_FILE_MODE_CREATE
,
1044 // if above failed now open and create the 'item'
1045 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1047 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1048 Status
= Handle2
->Open (
1051 AlignedNode
->PathName
,
1058 // Close the last node
1060 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1063 // If there's been an error, stop
1065 if (EFI_ERROR (Status
)) {
1072 SHELL_FREE_NON_NULL(AlignedNode
);
1073 if (EFI_ERROR(Status
)) {
1074 if (Handle1
!= NULL
) {
1075 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1078 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1084 Creates a file or directory by name.
1086 This function creates an empty new file or directory with the specified attributes and
1087 returns the new file's handle. If the file already exists and is read-only, then
1088 EFI_INVALID_PARAMETER will be returned.
1090 If the file already existed, it is truncated and its attributes updated. If the file is
1091 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1093 If the file name begins with >v, then the file handle which is returned refers to the
1094 shell environment variable with the specified name. If the shell environment variable
1095 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1097 @param FileName Pointer to NULL-terminated file path
1098 @param FileAttribs The new file's attrbiutes. the different attributes are
1099 described in EFI_FILE_PROTOCOL.Open().
1100 @param FileHandle On return, points to the created file handle or directory's handle
1102 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1103 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1104 @retval EFI_UNSUPPORTED could not open the file path
1105 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1106 file the file system on the device.
1107 @retval EFI_NO_MEDIA the device has no medium.
1108 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1110 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1112 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1113 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1114 when the media is write-protected.
1115 @retval EFI_ACCESS_DENIED The service denied access to the file.
1116 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1117 @retval EFI_VOLUME_FULL The volume is full.
1122 IN CONST CHAR16
*FileName
,
1123 IN UINT64 FileAttribs
,
1124 OUT SHELL_FILE_HANDLE
*FileHandle
1127 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1131 // Is this for an environment variable
1132 // do we start with >v
1134 if (StrStr(FileName
, L
">v") == FileName
) {
1135 if (!IsVolatileEnv(FileName
+2)) {
1136 return (EFI_INVALID_PARAMETER
);
1138 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1139 return (EFI_SUCCESS
);
1143 // We are opening a regular file.
1145 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1146 if (DevicePath
== NULL
) {
1147 return (EFI_NOT_FOUND
);
1150 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
);
1151 FreePool(DevicePath
);
1157 Register a GUID and a localized human readable name for it.
1159 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1160 names must be used whenever a shell command outputs GUID information.
1162 This function is only available when the major and minor versions in the
1163 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1165 @param[in] Guid A pointer to the GUID being registered.
1166 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1168 @retval EFI_SUCCESS The operation was successful.
1169 @retval EFI_INVALID_PARAMETER Guid was NULL.
1170 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1171 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1175 EfiShellRegisterGuidName(
1176 IN CONST EFI_GUID
*Guid
,
1177 IN CONST CHAR16
*GuidName
1180 return (AddNewGuidNameMapping(Guid
, GuidName
, NULL
));
1184 Opens a file or a directory by file name.
1186 This function opens the specified file in the specified OpenMode and returns a file
1188 If the file name begins with >v, then the file handle which is returned refers to the
1189 shell environment variable with the specified name. If the shell environment variable
1190 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1191 EFI_INVALID_PARAMETER is returned.
1193 If the file name is >i, then the file handle which is returned refers to the standard
1194 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1197 If the file name is >o, then the file handle which is returned refers to the standard
1198 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1201 If the file name is >e, then the file handle which is returned refers to the standard
1202 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1205 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1206 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1209 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1212 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1213 @param FileHandle On return, points to the file handle.
1214 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1215 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1217 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1218 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1219 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1220 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1221 system could not be found on the device. FileHandle is NULL.
1222 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1223 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1224 longer supported. FileHandle is NULL.
1225 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1226 the FileName. FileHandle is NULL.
1227 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1228 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1229 when the media is write-protected. FileHandle is NULL.
1230 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1231 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1233 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1237 EfiShellOpenFileByName(
1238 IN CONST CHAR16
*FileName
,
1239 OUT SHELL_FILE_HANDLE
*FileHandle
,
1243 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1249 // Is this for StdIn
1251 if (StrCmp(FileName
, L
">i") == 0) {
1253 // make sure not writing to StdIn
1255 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1256 return (EFI_INVALID_PARAMETER
);
1258 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1259 ASSERT(*FileHandle
!= NULL
);
1260 return (EFI_SUCCESS
);
1264 // Is this for StdOut
1266 if (StrCmp(FileName
, L
">o") == 0) {
1268 // make sure not writing to StdIn
1270 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1271 return (EFI_INVALID_PARAMETER
);
1273 *FileHandle
= &FileInterfaceStdOut
;
1274 return (EFI_SUCCESS
);
1278 // Is this for NUL file
1280 if (StrCmp(FileName
, L
"NUL") == 0) {
1281 *FileHandle
= &FileInterfaceNulFile
;
1282 return (EFI_SUCCESS
);
1286 // Is this for StdErr
1288 if (StrCmp(FileName
, L
">e") == 0) {
1290 // make sure not writing to StdIn
1292 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1293 return (EFI_INVALID_PARAMETER
);
1295 *FileHandle
= &FileInterfaceStdErr
;
1296 return (EFI_SUCCESS
);
1300 // Is this for an environment variable
1301 // do we start with >v
1303 if (StrStr(FileName
, L
">v") == FileName
) {
1304 if (!IsVolatileEnv(FileName
+2) &&
1305 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1306 return (EFI_INVALID_PARAMETER
);
1308 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1309 return (EFI_SUCCESS
);
1313 // We are opening a regular file.
1315 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1316 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1317 if (DevicePath
== NULL
) {
1318 return (EFI_NOT_FOUND
);
1322 // Copy the device path, open the file, then free the memory
1324 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1325 FreePool(DevicePath
);
1331 Deletes the file specified by the file name.
1333 This function deletes a file.
1335 @param FileName Points to the NULL-terminated file name.
1337 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1338 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1339 @sa EfiShellCreateFile
1343 EfiShellDeleteFileByName(
1344 IN CONST CHAR16
*FileName
1347 SHELL_FILE_HANDLE FileHandle
;
1353 // get a handle to the file
1355 Status
= EfiShellCreateFile(FileName
,
1358 if (EFI_ERROR(Status
)) {
1362 // now delete the file
1364 ShellFileHandleRemove(FileHandle
);
1365 return (ShellInfoObject
.NewEfiShellProtocol
->DeleteFile(FileHandle
));
1369 Disables the page break output mode.
1373 EfiShellDisablePageBreak (
1377 ShellInfoObject
.PageBreakEnabled
= FALSE
;
1381 Enables the page break output mode.
1385 EfiShellEnablePageBreak (
1389 ShellInfoObject
.PageBreakEnabled
= TRUE
;
1393 internal worker function to load and run an image via device path.
1395 @param ParentImageHandle A handle of the image that is executing the specified
1397 @param DevicePath device path of the file to execute
1398 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1399 containing the command line. If NULL then the command-
1401 @param Environment Points to a NULL-terminated array of environment
1402 variables with the format 'x=y', where x is the
1403 environment variable name and y is the value. If this
1404 is NULL, then the current shell environment is used.
1406 @param[out] StartImageStatus Returned status from gBS->StartImage.
1408 @retval EFI_SUCCESS The command executed successfully. The status code
1409 returned by the command is pointed to by StatusCode.
1410 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1411 @retval EFI_OUT_OF_RESOURCES Out of resources.
1412 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1416 InternalShellExecuteDevicePath(
1417 IN CONST EFI_HANDLE
*ParentImageHandle
,
1418 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1419 IN CONST CHAR16
*CommandLine OPTIONAL
,
1420 IN CONST CHAR16
**Environment OPTIONAL
,
1421 OUT EFI_STATUS
*StartImageStatus OPTIONAL
1425 EFI_STATUS StartStatus
;
1426 EFI_STATUS CleanupStatus
;
1427 EFI_HANDLE NewHandle
;
1428 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
1429 LIST_ENTRY OrigEnvs
;
1430 EFI_SHELL_PARAMETERS_PROTOCOL ShellParamsProtocol
;
1436 if (ParentImageHandle
== NULL
) {
1437 return (EFI_INVALID_PARAMETER
);
1440 InitializeListHead(&OrigEnvs
);
1444 NewCmdLine
= AllocateCopyPool (StrSize (CommandLine
), CommandLine
);
1445 if (NewCmdLine
== NULL
) {
1446 return EFI_OUT_OF_RESOURCES
;
1449 for (Walker
= NewCmdLine
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
1450 if (*Walker
== L
'^' && *(Walker
+1) == L
'#') {
1451 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));
1456 // Load the image with:
1457 // FALSE - not from boot manager and NULL, 0 being not already in memory
1459 Status
= gBS
->LoadImage(
1462 (EFI_DEVICE_PATH_PROTOCOL
*)DevicePath
,
1467 if (EFI_ERROR(Status
)) {
1468 if (NewHandle
!= NULL
) {
1469 gBS
->UnloadImage(NewHandle
);
1473 Status
= gBS
->OpenProtocol(
1475 &gEfiLoadedImageProtocolGuid
,
1476 (VOID
**)&LoadedImage
,
1479 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1481 if (!EFI_ERROR(Status
)) {
1482 ASSERT(LoadedImage
->LoadOptionsSize
== 0);
1483 if (NewCmdLine
!= NULL
) {
1484 LoadedImage
->LoadOptionsSize
= (UINT32
)StrSize(NewCmdLine
);
1485 LoadedImage
->LoadOptions
= (VOID
*)NewCmdLine
;
1489 // Save our current environment settings for later restoration if necessary
1491 if (Environment
!= NULL
) {
1492 Status
= GetEnvironmentVariableList(&OrigEnvs
);
1493 if (!EFI_ERROR(Status
)) {
1494 Status
= SetEnvironmentVariables(Environment
);
1499 // Initialize and install a shell parameters protocol on the image.
1501 ShellParamsProtocol
.StdIn
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1502 ShellParamsProtocol
.StdOut
= ShellInfoObject
.NewShellParametersProtocol
->StdOut
;
1503 ShellParamsProtocol
.StdErr
= ShellInfoObject
.NewShellParametersProtocol
->StdErr
;
1504 Status
= UpdateArgcArgv(&ShellParamsProtocol
, NewCmdLine
, Efi_Application
, NULL
, NULL
);
1505 ASSERT_EFI_ERROR(Status
);
1507 // Replace Argv[0] with the full path of the binary we're executing:
1508 // If the command line was "foo", the binary might be called "foo.efi".
1509 // "The first entry in [Argv] is always the full file path of the
1510 // executable" - UEFI Shell Spec section 2.3
1512 ImagePath
= EfiShellGetFilePathFromDevicePath (DevicePath
);
1513 // The image we're executing isn't necessarily in a filesystem - it might
1514 // be memory mapped. In this case EfiShellGetFilePathFromDevicePath will
1515 // return NULL, and we'll leave Argv[0] as UpdateArgcArgv set it.
1516 if (ImagePath
!= NULL
) {
1517 if (ShellParamsProtocol
.Argv
== NULL
) {
1518 // Command line was empty or null.
1519 // (UpdateArgcArgv sets Argv to NULL when CommandLine is "" or NULL)
1520 ShellParamsProtocol
.Argv
= AllocatePool (sizeof (CHAR16
*));
1521 if (ShellParamsProtocol
.Argv
== NULL
) {
1522 Status
= EFI_OUT_OF_RESOURCES
;
1525 ShellParamsProtocol
.Argc
= 1;
1527 // Free the string UpdateArgcArgv put in Argv[0];
1528 FreePool (ShellParamsProtocol
.Argv
[0]);
1530 ShellParamsProtocol
.Argv
[0] = ImagePath
;
1533 Status
= gBS
->InstallProtocolInterface(&NewHandle
, &gEfiShellParametersProtocolGuid
, EFI_NATIVE_INTERFACE
, &ShellParamsProtocol
);
1534 ASSERT_EFI_ERROR(Status
);
1536 ///@todo initialize and install ShellInterface protocol on the new image for compatibility if - PcdGetBool(PcdShellSupportOldProtocols)
1539 // now start the image and if the caller wanted the return code pass it to them...
1541 if (!EFI_ERROR(Status
)) {
1542 StartStatus
= gBS
->StartImage(
1547 if (StartImageStatus
!= NULL
) {
1548 *StartImageStatus
= StartStatus
;
1551 CleanupStatus
= gBS
->UninstallProtocolInterface(
1553 &gEfiShellParametersProtocolGuid
,
1554 &ShellParamsProtocol
1556 ASSERT_EFI_ERROR(CleanupStatus
);
1562 // Unload image - We should only get here if we didn't call StartImage
1563 gBS
->UnloadImage (NewHandle
);
1566 // Free Argv (Allocated in UpdateArgcArgv)
1567 if (ShellParamsProtocol
.Argv
!= NULL
) {
1568 for (Index
= 0; Index
< ShellParamsProtocol
.Argc
; Index
++) {
1569 if (ShellParamsProtocol
.Argv
[Index
] != NULL
) {
1570 FreePool (ShellParamsProtocol
.Argv
[Index
]);
1573 FreePool (ShellParamsProtocol
.Argv
);
1577 // Restore environment variables
1578 if (!IsListEmpty(&OrigEnvs
)) {
1579 CleanupStatus
= SetEnvironmentVariableList(&OrigEnvs
);
1580 ASSERT_EFI_ERROR (CleanupStatus
);
1583 FreePool (NewCmdLine
);
1588 Execute the command line.
1590 This function creates a nested instance of the shell and executes the specified
1591 command (CommandLine) with the specified environment (Environment). Upon return,
1592 the status code returned by the specified command is placed in StatusCode.
1594 If Environment is NULL, then the current environment is used and all changes made
1595 by the commands executed will be reflected in the current environment. If the
1596 Environment is non-NULL, then the changes made will be discarded.
1598 The CommandLine is executed from the current working directory on the current
1601 @param ParentImageHandle A handle of the image that is executing the specified
1603 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
1604 containing the command line. If NULL then the command-
1606 @param Environment Points to a NULL-terminated array of environment
1607 variables with the format 'x=y', where x is the
1608 environment variable name and y is the value. If this
1609 is NULL, then the current shell environment is used.
1610 @param StatusCode Points to the status code returned by the command.
1612 @retval EFI_SUCCESS The command executed successfully. The status code
1613 returned by the command is pointed to by StatusCode.
1614 @retval EFI_INVALID_PARAMETER The parameters are invalid.
1615 @retval EFI_OUT_OF_RESOURCES Out of resources.
1616 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
1617 @retval EFI_UNSUPPORTED The support level required for this function is not present.
1619 @sa InternalShellExecuteDevicePath
1624 IN EFI_HANDLE
*ParentImageHandle
,
1625 IN CHAR16
*CommandLine OPTIONAL
,
1626 IN CHAR16
**Environment OPTIONAL
,
1627 OUT EFI_STATUS
*StatusCode OPTIONAL
1632 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
1634 EFI_STATUS CalleeStatusCode
;
1636 CalleeStatusCode
= EFI_SUCCESS
;
1638 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1639 return (EFI_UNSUPPORTED
);
1642 if (Environment
!= NULL
) {
1643 // If Environment isn't null, load a new image of the shell with its own
1645 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1648 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1650 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1652 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1658 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1659 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1660 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1662 Status
= InternalShellExecuteDevicePath(
1666 (CONST CHAR16
**)Environment
,
1670 // de-allocate and return
1675 // If Environment is NULL, we are free to use and mutate the current shell
1676 // environment. This is much faster as uses much less memory.
1678 if (CommandLine
== NULL
) {
1682 Status
= RunShellCommand (CommandLine
, &CalleeStatusCode
);
1684 // Pass up the command's exit code if the caller wants it
1685 if (StatusCode
!= NULL
) {
1686 *StatusCode
= (EFI_STATUS
) CalleeStatusCode
;
1694 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1696 1) frees all pointers (non-NULL)
1697 2) Closes the SHELL_FILE_HANDLE
1699 @param FileListNode pointer to the list node to free
1703 InternalFreeShellFileInfoNode(
1704 IN EFI_SHELL_FILE_INFO
*FileListNode
1707 if (FileListNode
->Info
!= NULL
) {
1708 FreePool((VOID
*)FileListNode
->Info
);
1710 if (FileListNode
->FileName
!= NULL
) {
1711 FreePool((VOID
*)FileListNode
->FileName
);
1713 if (FileListNode
->FullName
!= NULL
) {
1714 FreePool((VOID
*)FileListNode
->FullName
);
1716 if (FileListNode
->Handle
!= NULL
) {
1717 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1719 FreePool(FileListNode
);
1722 Frees the file list.
1724 This function cleans up the file list and any related data structures. It has no
1725 impact on the files themselves.
1727 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1728 defined in OpenFileList()
1730 @retval EFI_SUCCESS Free the file list successfully.
1731 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1735 EfiShellFreeFileList(
1736 IN EFI_SHELL_FILE_INFO
**FileList
1739 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1741 if (FileList
== NULL
|| *FileList
== NULL
) {
1742 return (EFI_INVALID_PARAMETER
);
1745 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1746 ; !IsListEmpty(&(*FileList
)->Link
)
1747 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1749 RemoveEntryList(&ShellFileListItem
->Link
);
1750 InternalFreeShellFileInfoNode(ShellFileListItem
);
1752 InternalFreeShellFileInfoNode(*FileList
);
1754 return(EFI_SUCCESS
);
1758 Deletes the duplicate file names files in the given file list.
1760 This function deletes the reduplicate files in the given file list.
1762 @param FileList A pointer to the first entry in the file list.
1764 @retval EFI_SUCCESS Always success.
1765 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1769 EfiShellRemoveDupInFileList(
1770 IN EFI_SHELL_FILE_INFO
**FileList
1773 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1774 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1775 EFI_SHELL_FILE_INFO
*TempNode
;
1777 if (FileList
== NULL
|| *FileList
== NULL
) {
1778 return (EFI_INVALID_PARAMETER
);
1780 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1781 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1782 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1784 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1785 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1786 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1788 if (gUnicodeCollation
->StriColl(
1790 (CHAR16
*)ShellFileListItem
->FullName
,
1791 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1793 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1795 &ShellFileListItem2
->Link
1797 RemoveEntryList(&ShellFileListItem2
->Link
);
1798 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1799 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1800 // memory in GetNextNode in the loop expression above.
1801 ShellFileListItem2
= TempNode
;
1805 return (EFI_SUCCESS
);
1809 // This is the same structure as the external version, but it has no CONST qualifiers.
1812 LIST_ENTRY Link
; ///< Linked list members.
1813 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1814 CHAR16
*FullName
; ///< Fully qualified filename.
1815 CHAR16
*FileName
; ///< name of this file.
1816 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1817 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1818 } EFI_SHELL_FILE_INFO_NO_CONST
;
1821 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1823 @param[in] Node The node to copy from.
1824 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1826 @retval NULL a memory allocation error ocurred
1827 @return != NULL a pointer to the new node
1829 EFI_SHELL_FILE_INFO
*
1831 InternalDuplicateShellFileInfo(
1832 IN EFI_SHELL_FILE_INFO
*Node
,
1836 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1839 // try to confirm that the objects are in sync
1841 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1843 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1844 if (NewNode
== NULL
) {
1847 NewNode
->FullName
= AllocateCopyPool(StrSize(Node
->FullName
), Node
->FullName
);
1848 NewNode
->FileName
= AllocateCopyPool(StrSize(Node
->FileName
), Node
->FileName
);
1849 NewNode
->Info
= AllocateCopyPool((UINTN
)Node
->Info
->Size
, Node
->Info
);
1850 if ( NewNode
->FullName
== NULL
1851 || NewNode
->FileName
== NULL
1852 || NewNode
->Info
== NULL
1854 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1855 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1856 SHELL_FREE_NON_NULL(NewNode
->Info
);
1857 SHELL_FREE_NON_NULL(NewNode
);
1860 NewNode
->Status
= Node
->Status
;
1861 NewNode
->Handle
= Node
->Handle
;
1863 Node
->Handle
= NULL
;
1866 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1870 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1871 failed it will return NULL.
1873 @param[in] BasePath the Path to prepend onto filename for FullPath
1874 @param[in] Status Status member initial value.
1875 @param[in] FileName FileName member initial value.
1876 @param[in] Handle Handle member initial value.
1877 @param[in] Info Info struct to copy.
1879 @retval NULL An error ocurred.
1880 @return a pointer to the newly allocated structure.
1882 EFI_SHELL_FILE_INFO
*
1884 CreateAndPopulateShellFileInfo(
1885 IN CONST CHAR16
*BasePath
,
1886 IN CONST EFI_STATUS Status
,
1887 IN CONST CHAR16
*FileName
,
1888 IN CONST SHELL_FILE_HANDLE Handle
,
1889 IN CONST EFI_FILE_INFO
*Info
1892 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1899 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1900 if (ShellFileListItem
== NULL
) {
1903 if (Info
!= NULL
&& Info
->Size
!= 0) {
1904 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1905 if (ShellFileListItem
->Info
== NULL
) {
1906 FreePool(ShellFileListItem
);
1909 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1911 ShellFileListItem
->Info
= NULL
;
1913 if (FileName
!= NULL
) {
1914 ASSERT(TempString
== NULL
);
1915 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1916 if (ShellFileListItem
->FileName
== NULL
) {
1917 FreePool(ShellFileListItem
->Info
);
1918 FreePool(ShellFileListItem
);
1922 ShellFileListItem
->FileName
= NULL
;
1926 if (BasePath
!= NULL
) {
1927 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1928 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1929 if (TempString
== NULL
) {
1930 FreePool((VOID
*)ShellFileListItem
->FileName
);
1931 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1932 FreePool(ShellFileListItem
);
1936 if (ShellFileListItem
->FileName
!= NULL
) {
1937 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1938 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1939 if (TempString
== NULL
) {
1940 FreePool((VOID
*)ShellFileListItem
->FileName
);
1941 FreePool(ShellFileListItem
->Info
);
1942 FreePool(ShellFileListItem
);
1947 TempString
= PathCleanUpDirectories(TempString
);
1949 ShellFileListItem
->FullName
= TempString
;
1950 ShellFileListItem
->Status
= Status
;
1951 ShellFileListItem
->Handle
= Handle
;
1953 return (ShellFileListItem
);
1957 Find all files in a specified directory.
1959 @param FileDirHandle Handle of the directory to search.
1960 @param FileList On return, points to the list of files in the directory
1961 or NULL if there are no files in the directory.
1963 @retval EFI_SUCCESS File information was returned successfully.
1964 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1965 @retval EFI_DEVICE_ERROR The device reported an error.
1966 @retval EFI_NO_MEDIA The device media is not present.
1967 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1968 @return An error from FileHandleGetFileName().
1972 EfiShellFindFilesInDir(
1973 IN SHELL_FILE_HANDLE FileDirHandle
,
1974 OUT EFI_SHELL_FILE_INFO
**FileList
1977 EFI_SHELL_FILE_INFO
*ShellFileList
;
1978 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1979 EFI_FILE_INFO
*FileInfo
;
1988 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1989 if (EFI_ERROR(Status
)) {
1993 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1996 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1997 if (TempString
== NULL
) {
1998 SHELL_FREE_NON_NULL(BasePath
);
1999 return (EFI_OUT_OF_RESOURCES
);
2001 TempSpot
= StrStr(TempString
, L
";");
2003 if (TempSpot
!= NULL
) {
2004 *TempSpot
= CHAR_NULL
;
2007 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2008 if (TempString
== NULL
) {
2009 SHELL_FREE_NON_NULL(BasePath
);
2010 return (EFI_OUT_OF_RESOURCES
);
2012 SHELL_FREE_NON_NULL(BasePath
);
2013 BasePath
= TempString
;
2017 ShellFileList
= NULL
;
2018 ShellFileListItem
= NULL
;
2020 Status
= EFI_SUCCESS
;
2023 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2024 ; !EFI_ERROR(Status
) && !NoFile
2025 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2028 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2030 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2032 EFI_SUCCESS
, // success since we didnt fail to open it...
2034 NULL
, // no handle since not open
2037 if (ShellFileList
== NULL
) {
2038 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2039 ASSERT(ShellFileList
!= NULL
);
2040 InitializeListHead(&ShellFileList
->Link
);
2042 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2044 if (EFI_ERROR(Status
)) {
2045 EfiShellFreeFileList(&ShellFileList
);
2048 *FileList
= ShellFileList
;
2050 SHELL_FREE_NON_NULL(BasePath
);
2055 Get the GUID value from a human readable name.
2057 If GuidName is a known GUID name, then update Guid to have the correct value for
2060 This function is only available when the major and minor versions in the
2061 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2063 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2064 @param[out] Guid A pointer to the GUID structure to be filled in.
2066 @retval EFI_SUCCESS The operation was successful.
2067 @retval EFI_INVALID_PARAMETER Guid was NULL.
2068 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2069 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2073 EfiShellGetGuidFromName(
2074 IN CONST CHAR16
*GuidName
,
2081 if (Guid
== NULL
|| GuidName
== NULL
) {
2082 return (EFI_INVALID_PARAMETER
);
2085 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2087 if (!EFI_ERROR(Status
)) {
2088 CopyGuid(NewGuid
, Guid
);
2095 Get the human readable name for a GUID from the value.
2097 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2098 should not modify the value.
2100 This function is only available when the major and minor versions in the
2101 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2103 @param[in] Guid A pointer to the GUID being queried.
2104 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2106 @retval EFI_SUCCESS The operation was successful.
2107 @retval EFI_INVALID_PARAMETER Guid was NULL.
2108 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2109 @retval EFI_NOT_FOUND Guid is not assigned a name.
2113 EfiShellGetGuidName(
2114 IN CONST EFI_GUID
*Guid
,
2115 OUT CONST CHAR16
**GuidName
2120 if (Guid
== NULL
|| GuidName
== NULL
) {
2121 return (EFI_INVALID_PARAMETER
);
2124 Name
= GetStringNameFromGuid(Guid
, NULL
);
2125 if (Name
== NULL
|| StrLen(Name
) == 0) {
2126 SHELL_FREE_NON_NULL(Name
);
2127 return (EFI_NOT_FOUND
);
2130 *GuidName
= AddBufferToFreeList(Name
);
2132 return (EFI_SUCCESS
);
2136 Updates a file name to be preceeded by the mapped drive name
2138 @param[in] BasePath the Mapped drive name to prepend
2139 @param[in, out] Path pointer to pointer to the file name to update.
2142 @retval EFI_OUT_OF_RESOURCES
2147 IN CONST CHAR16
*BasePath
,
2148 IN OUT CHAR16
**Path
2157 ASSERT(Path
!= NULL
);
2158 ASSERT(*Path
!= NULL
);
2159 ASSERT(BasePath
!= NULL
);
2162 // convert a local path to an absolute path
2164 if (StrStr(*Path
, L
":") == NULL
) {
2165 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2166 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2167 if (Path2
== NULL
) {
2168 return (EFI_OUT_OF_RESOURCES
);
2170 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2171 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2172 if (Path2
== NULL
) {
2173 return (EFI_OUT_OF_RESOURCES
);
2180 return (EFI_SUCCESS
);
2184 If FileHandle is a directory then the function reads from FileHandle and reads in
2185 each of the FileInfo structures. If one of them matches the Pattern's first
2186 "level" then it opens that handle and calls itself on that handle.
2188 If FileHandle is a file and matches all of the remaining Pattern (which would be
2189 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2191 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2192 FreeFileList with FileList.
2194 @param[in] FilePattern The FilePattern to check against.
2195 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2196 @param[in] FileHandle The FileHandle to start with
2197 @param[in, out] FileList pointer to pointer to list of found files.
2198 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2199 @param[in] MapName The file system name this file is on.
2201 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2202 @retval EFI_NOT_FOUND no files were found
2203 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2208 IN CONST CHAR16
*FilePattern
,
2209 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2210 IN SHELL_FILE_HANDLE FileHandle
,
2211 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2212 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2213 IN CONST CHAR16
*MapName
2217 CONST CHAR16
*NextFilePatternStart
;
2218 CHAR16
*CurrentFilePattern
;
2219 EFI_SHELL_FILE_INFO
*ShellInfo
;
2220 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2221 EFI_SHELL_FILE_INFO
*NewShellNode
;
2222 EFI_FILE_INFO
*FileInfo
;
2224 CHAR16
*NewFullName
;
2227 if ( FilePattern
== NULL
2228 || UnicodeCollation
== NULL
2231 return (EFI_INVALID_PARAMETER
);
2234 CurrentFilePattern
= NULL
;
2236 if (*FilePattern
== L
'\\') {
2240 for( NextFilePatternStart
= FilePattern
2241 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2242 ; NextFilePatternStart
++);
2244 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2245 ASSERT(CurrentFilePattern
!= NULL
);
2246 StrnCpyS(CurrentFilePattern
, NextFilePatternStart
-FilePattern
+1, FilePattern
, NextFilePatternStart
-FilePattern
);
2248 if (CurrentFilePattern
[0] == CHAR_NULL
2249 &&NextFilePatternStart
[0] == CHAR_NULL
2252 // we want the parent or root node (if no parent)
2254 if (ParentNode
== NULL
) {
2256 // We want the root node. create the node.
2258 FileInfo
= FileHandleGetInfo(FileHandle
);
2259 NewShellNode
= CreateAndPopulateShellFileInfo(
2266 SHELL_FREE_NON_NULL(FileInfo
);
2269 // Add the current parameter FileHandle to the list, then end...
2271 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2273 if (NewShellNode
== NULL
) {
2274 Status
= EFI_OUT_OF_RESOURCES
;
2276 NewShellNode
->Handle
= NULL
;
2277 if (*FileList
== NULL
) {
2278 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2279 InitializeListHead(&((*FileList
)->Link
));
2283 // Add to the returning to use list
2285 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2287 Status
= EFI_SUCCESS
;
2290 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2292 if (!EFI_ERROR(Status
)){
2293 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2298 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2299 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2300 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2302 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2303 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2304 Size
= StrSize(ShellInfoNode
->FullName
);
2305 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2306 NewFullName
= AllocateZeroPool(Size
);
2307 if (NewFullName
== NULL
) {
2308 Status
= EFI_OUT_OF_RESOURCES
;
2310 StrCpyS(NewFullName
, Size
/sizeof(CHAR16
), MapName
);
2311 StrCatS(NewFullName
, Size
/sizeof(CHAR16
), ShellInfoNode
->FullName
+1);
2312 FreePool((VOID
*)ShellInfoNode
->FullName
);
2313 ShellInfoNode
->FullName
= NewFullName
;
2316 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2318 // should be a directory
2322 // don't open the . and .. directories
2324 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2325 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2330 if (EFI_ERROR(Status
)) {
2334 // Open the directory since we need that handle in the next recursion.
2336 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2339 // recurse with the next part of the pattern
2341 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2342 EfiShellClose(ShellInfoNode
->Handle
);
2343 ShellInfoNode
->Handle
= NULL
;
2345 } else if (!EFI_ERROR(Status
)) {
2351 // copy the information we need into a new Node
2353 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2354 ASSERT(NewShellNode
!= NULL
);
2355 if (NewShellNode
== NULL
) {
2356 Status
= EFI_OUT_OF_RESOURCES
;
2358 if (*FileList
== NULL
) {
2359 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2360 InitializeListHead(&((*FileList
)->Link
));
2364 // Add to the returning to use list
2366 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2369 if (EFI_ERROR(Status
)) {
2373 if (EFI_ERROR(Status
)) {
2374 EfiShellFreeFileList(&ShellInfo
);
2376 Status
= EfiShellFreeFileList(&ShellInfo
);
2381 FreePool(CurrentFilePattern
);
2386 Find files that match a specified pattern.
2388 This function searches for all files and directories that match the specified
2389 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2390 information is placed in the file list FileList.
2392 Wildcards are processed
2393 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2395 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2396 field is set to NULL.
2398 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2400 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2401 @param FileList On return, points to the start of a file list containing the names
2402 of all matching files or else points to NULL if no matching files
2403 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2405 @retval EFI_SUCCESS Files found. FileList is a valid list.
2406 @retval EFI_NOT_FOUND No files found.
2407 @retval EFI_NO_MEDIA The device has no media
2408 @retval EFI_DEVICE_ERROR The device reported an error
2409 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2414 IN CONST CHAR16
*FilePattern
,
2415 OUT EFI_SHELL_FILE_INFO
**FileList
2419 CHAR16
*PatternCopy
;
2420 CHAR16
*PatternCurrentLocation
;
2421 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2422 SHELL_FILE_HANDLE RootFileHandle
;
2426 if ( FilePattern
== NULL
2428 || StrStr(FilePattern
, L
":") == NULL
2430 return (EFI_INVALID_PARAMETER
);
2432 Status
= EFI_SUCCESS
;
2433 RootDevicePath
= NULL
;
2434 RootFileHandle
= NULL
;
2436 PatternCopy
= AllocateCopyPool(StrSize(FilePattern
), FilePattern
);
2437 if (PatternCopy
== NULL
) {
2438 return (EFI_OUT_OF_RESOURCES
);
2441 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2443 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2446 ASSERT(MapName
== NULL
);
2447 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2448 if (MapName
== NULL
) {
2449 Status
= EFI_OUT_OF_RESOURCES
;
2451 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2452 if (RootDevicePath
== NULL
) {
2453 Status
= EFI_INVALID_PARAMETER
;
2455 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2456 if (!EFI_ERROR(Status
)) {
2457 for ( PatternCurrentLocation
= PatternCopy
2458 ; *PatternCurrentLocation
!= ':'
2459 ; PatternCurrentLocation
++);
2460 PatternCurrentLocation
++;
2461 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2462 EfiShellClose(RootFileHandle
);
2464 FreePool(RootDevicePath
);
2468 SHELL_FREE_NON_NULL(PatternCopy
);
2469 SHELL_FREE_NON_NULL(MapName
);
2475 Opens the files that match the path specified.
2477 This function opens all of the files specified by Path. Wildcards are processed
2478 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2479 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2481 @param Path A pointer to the path string.
2482 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2483 EFI_FILE_MODE_WRITE.
2484 @param FileList Points to the start of a list of files opened.
2486 @retval EFI_SUCCESS Create the file list successfully.
2487 @return Others Can't create the file list.
2491 EfiShellOpenFileList(
2494 IN OUT EFI_SHELL_FILE_INFO
**FileList
2498 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2501 CONST CHAR16
*CurDir
;
2504 PathCleanUpDirectories(Path
);
2509 if (FileList
== NULL
|| *FileList
== NULL
) {
2510 return (EFI_INVALID_PARAMETER
);
2513 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2518 // convert a local path to an absolute path
2520 if (StrStr(Path
, L
":") == NULL
) {
2521 CurDir
= EfiShellGetCurDir(NULL
);
2522 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2523 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2524 StrnCatGrow(&Path2
, &Path2Size
, L
"\\", 0);
2525 if (*Path
== L
'\\') {
2527 while (PathRemoveLastItem(Path2
)) ;
2529 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2530 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2532 ASSERT(Path2
== NULL
);
2533 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2536 PathCleanUpDirectories (Path2
);
2541 Status
= EfiShellFindFiles(Path2
, FileList
);
2545 if (EFI_ERROR(Status
)) {
2551 // We had no errors so open all the files (that are not already opened...)
2553 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2554 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2555 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2557 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2558 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2564 return (EFI_NOT_FOUND
);
2566 return(EFI_SUCCESS
);
2570 Gets the environment variable and Attributes, or list of environment variables. Can be
2571 used instead of GetEnv().
2573 This function returns the current value of the specified environment variable and
2574 the Attributes. If no variable name was specified, then all of the known
2575 variables will be returned.
2577 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2578 then the function will return all of the defined shell
2579 environment variables. In the case where multiple environment
2580 variables are being returned, each variable will be terminated
2581 by a NULL, and the list will be terminated by a double NULL.
2582 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2583 the environment variable. In the case where Name is NULL, and
2584 multiple environment variables are being returned, Attributes
2587 @retval NULL The environment variable doesn't exist.
2588 @return A non-NULL value points to the variable's value. The returned
2589 pointer does not need to be freed by the caller.
2594 IN CONST CHAR16
*Name
,
2595 OUT UINT32
*Attributes OPTIONAL
2603 CHAR16
*CurrentWriteLocation
;
2610 // Get all our environment variables
2612 InitializeListHead(&List
);
2613 Status
= GetEnvironmentVariableList(&List
);
2614 if (EFI_ERROR(Status
)){
2619 // Build the semi-colon delimited list. (2 passes)
2621 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2622 ; !IsNull(&List
, &Node
->Link
)
2623 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2625 ASSERT(Node
->Key
!= NULL
);
2626 Size
+= StrSize(Node
->Key
);
2629 Size
+= 2*sizeof(CHAR16
);
2631 Buffer
= AllocateZeroPool(Size
);
2632 if (Buffer
== NULL
) {
2633 if (!IsListEmpty (&List
)) {
2634 FreeEnvironmentVariableList(&List
);
2638 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2640 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2641 ; !IsNull(&List
, &Node
->Link
)
2642 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2644 ASSERT(Node
->Key
!= NULL
);
2645 StrCpyS( CurrentWriteLocation
,
2646 (Size
)/sizeof(CHAR16
) - (CurrentWriteLocation
- ((CHAR16
*)Buffer
)),
2649 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2655 if (!IsListEmpty (&List
)) {
2656 FreeEnvironmentVariableList(&List
);
2660 // We are doing a specific environment variable
2664 // get the size we need for this EnvVariable
2666 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2667 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2669 // Allocate the space and recall the get function
2671 Buffer
= AllocateZeroPool(Size
);
2672 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2675 // we didnt get it (might not exist)
2676 // free the memory if we allocated any and return NULL
2678 if (EFI_ERROR(Status
)) {
2679 if (Buffer
!= NULL
) {
2687 // return the buffer
2689 return (AddBufferToFreeList(Buffer
));
2693 Gets either a single or list of environment variables.
2695 If name is not NULL then this function returns the current value of the specified
2696 environment variable.
2698 If Name is NULL, then a list of all environment variable names is returned. Each is a
2699 NULL terminated string with a double NULL terminating the list.
2701 @param Name A pointer to the environment variable name. If
2702 Name is NULL, then the function will return all
2703 of the defined shell environment variables. In
2704 the case where multiple environment variables are
2705 being returned, each variable will be terminated by
2706 a NULL, and the list will be terminated by a double
2709 @retval !=NULL A pointer to the returned string.
2710 The returned pointer does not need to be freed by the caller.
2712 @retval NULL The environment variable doesn't exist or there are
2713 no environment variables.
2718 IN CONST CHAR16
*Name
2721 return (EfiShellGetEnvEx(Name
, NULL
));
2725 Internal variable setting function. Allows for setting of the read only variables.
2727 @param Name Points to the NULL-terminated environment variable name.
2728 @param Value Points to the NULL-terminated environment variable value. If the value is an
2729 empty string then the environment variable is deleted.
2730 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2732 @retval EFI_SUCCESS The environment variable was successfully updated.
2736 InternalEfiShellSetEnv(
2737 IN CONST CHAR16
*Name
,
2738 IN CONST CHAR16
*Value
,
2742 if (Value
== NULL
|| StrLen(Value
) == 0) {
2743 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2745 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2747 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2749 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2755 Sets the environment variable.
2757 This function changes the current value of the specified environment variable. If the
2758 environment variable exists and the Value is an empty string, then the environment
2759 variable is deleted. If the environment variable exists and the Value is not an empty
2760 string, then the value of the environment variable is changed. If the environment
2761 variable does not exist and the Value is an empty string, there is no action. If the
2762 environment variable does not exist and the Value is a non-empty string, then the
2763 environment variable is created and assigned the specified value.
2765 For a description of volatile and non-volatile environment variables, see UEFI Shell
2766 2.0 specification section 3.6.1.
2768 @param Name Points to the NULL-terminated environment variable name.
2769 @param Value Points to the NULL-terminated environment variable value. If the value is an
2770 empty string then the environment variable is deleted.
2771 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2773 @retval EFI_SUCCESS The environment variable was successfully updated.
2778 IN CONST CHAR16
*Name
,
2779 IN CONST CHAR16
*Value
,
2783 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2784 return (EFI_INVALID_PARAMETER
);
2787 // Make sure we dont 'set' a predefined read only variable
2789 if (gUnicodeCollation
->StriColl(
2793 ||gUnicodeCollation
->StriColl(
2797 ||gUnicodeCollation
->StriColl(
2801 ||gUnicodeCollation
->StriColl(
2804 L
"uefishellsupport") == 0
2805 ||gUnicodeCollation
->StriColl(
2808 L
"uefishellversion") == 0
2809 ||gUnicodeCollation
->StriColl(
2812 L
"uefiversion") == 0
2814 return (EFI_INVALID_PARAMETER
);
2816 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2820 Returns the current directory on the specified device.
2822 If FileSystemMapping is NULL, it returns the current working directory. If the
2823 FileSystemMapping is not NULL, it returns the current directory associated with the
2824 FileSystemMapping. In both cases, the returned name includes the file system
2825 mapping (i.e. fs0:\current-dir).
2827 Note that the current directory string should exclude the tailing backslash character.
2829 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2830 then the current working directory is returned.
2832 @retval !=NULL The current directory.
2833 @retval NULL Current directory does not exist.
2838 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2841 CHAR16
*PathToReturn
;
2843 SHELL_MAP_LIST
*MapListItem
;
2844 if (!IsListEmpty(&gShellMapList
.Link
)) {
2846 // if parameter is NULL, use current
2848 if (FileSystemMapping
== NULL
) {
2849 return (EfiShellGetEnv(L
"cwd"));
2852 PathToReturn
= NULL
;
2853 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2854 if (MapListItem
!= NULL
) {
2855 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2856 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2857 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2860 return (AddBufferToFreeList(PathToReturn
));
2867 Changes the current directory on the specified device.
2869 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2870 mapped name, this function changes the current working directory.
2872 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2873 current file system and the current directory on that file system are changed.
2875 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2878 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2879 directory on the specified file system.
2881 If the current working directory or the current working file system is changed then the
2882 %cwd% environment variable will be updated
2884 Note that the current directory string should exclude the tailing backslash character.
2886 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2887 directory is changed.
2888 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2890 @retval EFI_SUCCESS The operation was sucessful
2891 @retval EFI_NOT_FOUND The file system could not be found
2896 IN CONST CHAR16
*FileSystem OPTIONAL
,
2897 IN CONST CHAR16
*Dir
2901 SHELL_MAP_LIST
*MapListItem
;
2905 CHAR16
*DirectoryName
;
2912 DirectoryName
= NULL
;
2914 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2915 return (EFI_INVALID_PARAMETER
);
2918 if (IsListEmpty(&gShellMapList
.Link
)){
2919 return (EFI_NOT_FOUND
);
2922 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2923 ASSERT(DirectoryName
!= NULL
);
2925 PathCleanUpDirectories(DirectoryName
);
2927 if (FileSystem
== NULL
) {
2929 // determine the file system mapping to use
2931 if (StrStr(DirectoryName
, L
":") != NULL
) {
2932 ASSERT(MapName
== NULL
);
2933 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2936 // find the file system mapping's entry in the list
2939 if (MapName
!= NULL
) {
2940 MapListItem
= ShellCommandFindMapItem(MapName
);
2943 // make that the current file system mapping
2945 if (MapListItem
!= NULL
) {
2946 gShellCurDir
= MapListItem
;
2949 MapListItem
= gShellCurDir
;
2952 if (MapListItem
== NULL
) {
2953 return (EFI_NOT_FOUND
);
2957 // now update the MapListItem's current directory
2959 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2960 FreePool(MapListItem
->CurrentDirectoryPath
);
2961 MapListItem
->CurrentDirectoryPath
= NULL
;
2963 if (MapName
!= NULL
) {
2964 TempLen
= StrLen(MapName
);
2965 if (TempLen
!= StrLen(DirectoryName
)) {
2966 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2967 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2970 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2971 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2973 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2974 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2975 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2976 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
2981 // cant have a mapping in the directory...
2983 if (StrStr(DirectoryName
, L
":") != NULL
) {
2984 return (EFI_INVALID_PARAMETER
);
2987 // FileSystem != NULL
2989 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2990 if (MapListItem
== NULL
) {
2991 return (EFI_INVALID_PARAMETER
);
2993 // gShellCurDir = MapListItem;
2994 if (DirectoryName
!= NULL
) {
2996 // change current dir on that file system
2999 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
3000 FreePool(MapListItem
->CurrentDirectoryPath
);
3001 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
3003 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
3004 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
3005 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3006 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3007 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3008 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3009 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') {
3010 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3011 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
3016 // if updated the current directory then update the environment variable
3018 if (MapListItem
== gShellCurDir
) {
3020 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3021 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3022 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3023 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3024 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3025 FreePool(TempString
);
3028 return(EFI_SUCCESS
);
3032 Return help information about a specific command.
3034 This function returns the help information for the specified command. The help text
3035 can be internal to the shell or can be from a UEFI Shell manual page.
3037 If Sections is specified, then each section name listed will be compared in a casesensitive
3038 manner, to the section names described in Appendix B. If the section exists,
3039 it will be appended to the returned help text. If the section does not exist, no
3040 information will be returned. If Sections is NULL, then all help text information
3041 available will be returned.
3043 @param Command Points to the NULL-terminated UEFI Shell command name.
3044 @param Sections Points to the NULL-terminated comma-delimited
3045 section names to return. If NULL, then all
3046 sections will be returned.
3047 @param HelpText On return, points to a callee-allocated buffer
3048 containing all specified help text.
3050 @retval EFI_SUCCESS The help text was returned.
3051 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3053 @retval EFI_INVALID_PARAMETER HelpText is NULL
3054 @retval EFI_NOT_FOUND There is no help text available for Command.
3058 EfiShellGetHelpText(
3059 IN CONST CHAR16
*Command
,
3060 IN CONST CHAR16
*Sections OPTIONAL
,
3061 OUT CHAR16
**HelpText
3064 CONST CHAR16
*ManFileName
;
3068 ASSERT(HelpText
!= NULL
);
3071 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3073 if (ManFileName
!= NULL
) {
3074 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3076 if ((StrLen(Command
)> 4)
3077 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3078 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3079 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3080 && (Command
[StrLen(Command
)-4] == L
'.')
3082 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3083 ASSERT(FixCommand
!= NULL
);
3085 StrnCpyS( FixCommand
,
3086 (StrSize(Command
) - 4 * sizeof (CHAR16
))/sizeof(CHAR16
),
3090 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3091 FreePool(FixCommand
);
3094 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3100 Gets the enable status of the page break output mode.
3102 User can use this function to determine current page break mode.
3104 @retval TRUE The page break output mode is enabled.
3105 @retval FALSE The page break output mode is disabled.
3109 EfiShellGetPageBreak(
3113 return(ShellInfoObject
.PageBreakEnabled
);
3117 Judges whether the active shell is the root shell.
3119 This function makes the user to know that whether the active Shell is the root shell.
3121 @retval TRUE The active Shell is the root Shell.
3122 @retval FALSE The active Shell is NOT the root Shell.
3126 EfiShellIsRootShell(
3130 return(ShellInfoObject
.RootShellInstance
);
3134 function to return a semi-colon delimeted list of all alias' in the current shell
3136 up to caller to free the memory.
3138 @retval NULL No alias' were found
3139 @retval NULL An error ocurred getting alias'
3140 @return !NULL a list of all alias'
3144 InternalEfiShellGetListAlias(
3150 CHAR16
*VariableName
;
3152 UINTN NameBufferSize
;
3156 NameBufferSize
= INIT_NAME_BUFFER_SIZE
;
3157 VariableName
= AllocateZeroPool(NameBufferSize
);
3161 if (VariableName
== NULL
) {
3165 VariableName
[0] = CHAR_NULL
;
3168 NameSize
= NameBufferSize
;
3169 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3170 if (Status
== EFI_NOT_FOUND
){
3172 } else if (Status
== EFI_BUFFER_TOO_SMALL
) {
3173 NameBufferSize
= NameSize
> NameBufferSize
* 2 ? NameSize
: NameBufferSize
* 2;
3174 SHELL_FREE_NON_NULL(VariableName
);
3175 VariableName
= AllocateZeroPool(NameBufferSize
);
3176 if (VariableName
== NULL
) {
3177 Status
= EFI_OUT_OF_RESOURCES
;
3178 SHELL_FREE_NON_NULL(RetVal
);
3183 NameSize
= NameBufferSize
;
3184 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3187 if (EFI_ERROR (Status
)) {
3188 SHELL_FREE_NON_NULL(RetVal
);
3193 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3194 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3195 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3196 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3199 SHELL_FREE_NON_NULL(VariableName
);
3205 Convert a null-terminated unicode string, in-place, to all lowercase.
3208 @param Str The null-terminated string to be converted to all lowercase.
3210 @return The null-terminated string converted into all lowercase.
3219 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3220 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3221 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3228 This function returns the command associated with a alias or a list of all
3231 @param[in] Alias Points to the NULL-terminated shell alias.
3232 If this parameter is NULL, then all
3233 aliases will be returned in ReturnedData.
3234 @param[out] Volatile upon return of a single command if TRUE indicates
3235 this is stored in a volatile fashion. FALSE otherwise.
3237 @return If Alias is not NULL, it will return a pointer to
3238 the NULL-terminated command for that alias.
3239 If Alias is NULL, ReturnedData points to a ';'
3240 delimited list of alias (e.g.
3241 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3242 @retval NULL an error ocurred
3243 @retval NULL Alias was not a valid Alias
3248 IN CONST CHAR16
*Alias
,
3249 OUT BOOLEAN
*Volatile OPTIONAL
3259 // Convert to lowercase to make aliases case-insensitive
3260 if (Alias
!= NULL
) {
3261 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3262 ASSERT (AliasLower
!= NULL
);
3263 ToLower (AliasLower
);
3265 if (Volatile
== NULL
) {
3266 GetVariable2 (AliasLower
, &gShellAliasGuid
, (VOID
**)&AliasVal
, NULL
);
3267 FreePool(AliasLower
);
3268 return (AddBufferToFreeList(AliasVal
));
3272 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3273 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3274 RetVal
= AllocateZeroPool(RetSize
);
3275 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3277 if (EFI_ERROR(Status
)) {
3278 if (RetVal
!= NULL
) {
3281 FreePool(AliasLower
);
3284 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3290 FreePool (AliasLower
);
3291 return (AddBufferToFreeList(RetVal
));
3293 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3297 Changes a shell command alias.
3299 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3301 this function does not check for built in alias'.
3303 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3304 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3305 Command refers to an alias, that alias will be deleted.
3306 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3307 Alias being set will be stored in a non-volatile fashion.
3309 @retval EFI_SUCCESS Alias created or deleted successfully.
3310 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3315 IN CONST CHAR16
*Command
,
3316 IN CONST CHAR16
*Alias
,
3323 // Convert to lowercase to make aliases case-insensitive
3324 if (Alias
!= NULL
) {
3325 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3326 ASSERT (AliasLower
!= NULL
);
3327 ToLower (AliasLower
);
3333 // We must be trying to remove one if Alias is NULL
3335 if (Alias
== NULL
) {
3337 // remove an alias (but passed in COMMAND parameter)
3339 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3342 // Add and replace are the same
3345 // We dont check the error return on purpose since the variable may not exist.
3346 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3348 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3351 if (Alias
!= NULL
) {
3352 FreePool (AliasLower
);
3358 Changes a shell command alias.
3360 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3363 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3364 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3365 Command refers to an alias, that alias will be deleted.
3366 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3367 FALSE and the alias already exists, then the existing alias is unchanged and
3368 EFI_ACCESS_DENIED is returned.
3369 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3370 Alias being set will be stored in a non-volatile fashion.
3372 @retval EFI_SUCCESS Alias created or deleted successfully.
3373 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3374 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3376 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3381 IN CONST CHAR16
*Command
,
3382 IN CONST CHAR16
*Alias
,
3387 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3389 // cant set over a built in alias
3391 return (EFI_ACCESS_DENIED
);
3392 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3394 // Command is null or empty
3396 return (EFI_INVALID_PARAMETER
);
3397 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3399 // Alias already exists, Replace not set
3401 return (EFI_ACCESS_DENIED
);
3403 return (InternalSetAlias(Command
, Alias
, Volatile
));
3407 // Pure FILE_HANDLE operations are passed to FileHandleLib
3408 // these functions are indicated by the *
3409 EFI_SHELL_PROTOCOL mShellProtocol
= {
3415 EfiShellGetHelpText
,
3416 EfiShellGetDevicePathFromMap
,
3417 EfiShellGetMapFromDevicePath
,
3418 EfiShellGetDevicePathFromFilePath
,
3419 EfiShellGetFilePathFromDevicePath
,
3423 EfiShellOpenFileList
,
3424 EfiShellFreeFileList
,
3425 EfiShellRemoveDupInFileList
,
3426 EfiShellBatchIsActive
,
3427 EfiShellIsRootShell
,
3428 EfiShellEnablePageBreak
,
3429 EfiShellDisablePageBreak
,
3430 EfiShellGetPageBreak
,
3431 EfiShellGetDeviceName
,
3432 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3433 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3434 EfiShellOpenFileByName
,
3437 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3438 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3439 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3440 EfiShellDeleteFileByName
,
3441 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3442 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3443 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3445 EfiShellFindFilesInDir
,
3446 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3448 EfiShellOpenRootByHandle
,
3450 SHELL_MAJOR_VERSION
,
3451 SHELL_MINOR_VERSION
,
3453 // New for UEFI Shell 2.1
3454 EfiShellRegisterGuidName
,
3455 EfiShellGetGuidName
,
3456 EfiShellGetGuidFromName
,
3461 Function to create and install on the current handle.
3463 Will overwrite any existing ShellProtocols in the system to be sure that
3464 the current shell is in control.
3466 This must be removed via calling CleanUpShellProtocol().
3468 @param[in, out] NewShell The pointer to the pointer to the structure
3471 @retval EFI_SUCCESS The operation was successful.
3472 @return An error from LocateHandle, CreateEvent, or other core function.
3476 CreatePopulateInstallShellProtocol (
3477 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3483 UINTN HandleCounter
;
3484 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3486 if (NewShell
== NULL
) {
3487 return (EFI_INVALID_PARAMETER
);
3492 OldProtocolNode
= NULL
;
3493 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3496 // Initialize EfiShellProtocol object...
3498 Status
= gBS
->CreateEvent(0,
3502 &mShellProtocol
.ExecutionBreak
);
3503 if (EFI_ERROR(Status
)) {
3508 // Get the size of the buffer we need.
3510 Status
= gBS
->LocateHandle(ByProtocol
,
3511 &gEfiShellProtocolGuid
,
3515 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3517 // Allocate and recall with buffer of correct size
3519 Buffer
= AllocateZeroPool(BufferSize
);
3520 if (Buffer
== NULL
) {
3521 return (EFI_OUT_OF_RESOURCES
);
3523 Status
= gBS
->LocateHandle(ByProtocol
,
3524 &gEfiShellProtocolGuid
,
3528 if (EFI_ERROR(Status
)) {
3533 // now overwrite each of them, but save the info to restore when we end.
3535 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3536 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3537 ASSERT(OldProtocolNode
!= NULL
);
3538 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3539 &gEfiShellProtocolGuid
,
3540 (VOID
**) &(OldProtocolNode
->Interface
),
3543 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3545 if (!EFI_ERROR(Status
)) {
3547 // reinstall over the old one...
3549 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3550 Status
= gBS
->ReinstallProtocolInterface(
3551 OldProtocolNode
->Handle
,
3552 &gEfiShellProtocolGuid
,
3553 OldProtocolNode
->Interface
,
3554 (VOID
*)(&mShellProtocol
));
3555 if (!EFI_ERROR(Status
)) {
3557 // we reinstalled sucessfully. log this so we can reverse it later.
3561 // add to the list for subsequent...
3563 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3568 } else if (Status
== EFI_NOT_FOUND
) {
3569 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3571 // no one else published yet. just publish it ourselves.
3573 Status
= gBS
->InstallProtocolInterface (
3575 &gEfiShellProtocolGuid
,
3576 EFI_NATIVE_INTERFACE
,
3577 (VOID
*)(&mShellProtocol
));
3580 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3581 ///@todo support ShellEnvironment2
3582 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3585 if (!EFI_ERROR(Status
)) {
3586 *NewShell
= &mShellProtocol
;
3592 Opposite of CreatePopulateInstallShellProtocol.
3594 Free all memory and restore the system to the state it was in before calling
3595 CreatePopulateInstallShellProtocol.
3597 @param[in, out] NewShell The pointer to the new shell protocol structure.
3599 @retval EFI_SUCCESS The operation was successful.
3603 CleanUpShellProtocol (
3604 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3608 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3609 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3612 // if we need to restore old protocols...
3614 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3615 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3616 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3617 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3619 RemoveEntryList(&Node2
->Link
);
3620 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3621 &gEfiShellProtocolGuid
,
3628 // no need to restore
3630 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3631 &gEfiShellProtocolGuid
,
3634 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3635 NewShell
->ExecutionBreak
= NULL
;
3637 Status
= gBS
->OpenProtocol(
3638 gST
->ConsoleInHandle
,
3639 &gEfiSimpleTextInputExProtocolGuid
,
3643 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3645 if (!EFI_ERROR (Status
)) {
3646 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3647 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3648 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3649 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3650 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3651 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3652 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3653 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3659 Notification function for keystrokes.
3661 @param[in] KeyData The key that was pressed.
3663 @retval EFI_SUCCESS The operation was successful.
3667 NotificationFunction(
3668 IN EFI_KEY_DATA
*KeyData
3671 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3672 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3673 (KeyData
->Key
.UnicodeChar
== 3)
3675 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3676 return (EFI_UNSUPPORTED
);
3678 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3679 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3680 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3682 ShellInfoObject
.HaltOutput
= TRUE
;
3684 return (EFI_SUCCESS
);
3688 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3689 feature's enabled state was not known when the shell initially launched.
3691 @retval EFI_SUCCESS The feature is enabled.
3692 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3696 InernalEfiShellStartMonitor(
3700 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3701 EFI_KEY_DATA KeyData
;
3704 Status
= gBS
->OpenProtocol(
3705 gST
->ConsoleInHandle
,
3706 &gEfiSimpleTextInputExProtocolGuid
,
3710 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3711 if (EFI_ERROR(Status
)) {
3716 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3717 ShellInfoObject
.HiiHandle
);
3718 return (EFI_SUCCESS
);
3721 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3722 return (EFI_UNSUPPORTED
);
3725 KeyData
.KeyState
.KeyToggleState
= 0;
3726 KeyData
.Key
.ScanCode
= 0;
3727 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3728 KeyData
.Key
.UnicodeChar
= L
'c';
3730 Status
= SimpleEx
->RegisterKeyNotify(
3733 NotificationFunction
,
3734 &ShellInfoObject
.CtrlCNotifyHandle1
);
3736 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3737 if (!EFI_ERROR(Status
)) {
3738 Status
= SimpleEx
->RegisterKeyNotify(
3741 NotificationFunction
,
3742 &ShellInfoObject
.CtrlCNotifyHandle2
);
3744 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3745 KeyData
.Key
.UnicodeChar
= 3;
3746 if (!EFI_ERROR(Status
)) {
3747 Status
= SimpleEx
->RegisterKeyNotify(
3750 NotificationFunction
,
3751 &ShellInfoObject
.CtrlCNotifyHandle3
);
3753 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3754 if (!EFI_ERROR(Status
)) {
3755 Status
= SimpleEx
->RegisterKeyNotify(
3758 NotificationFunction
,
3759 &ShellInfoObject
.CtrlCNotifyHandle4
);