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 // all the rest should be file path nodes
454 if ((DevicePathType(&FilePath
->Header
) != MEDIA_DEVICE_PATH
) ||
455 (DevicePathSubType(&FilePath
->Header
) != MEDIA_FILEPATH_DP
)) {
456 FreePool(PathForReturn
);
457 PathForReturn
= NULL
;
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
);
484 } // for loop of remaining nodes
486 if (PathForReturn
!= NULL
) {
489 } // for loop of paths to check
490 return(PathForReturn
);
494 Converts a file system style name to a device path.
496 This function converts a file system style name to a device path, by replacing any
497 mapping references to the associated device path.
499 @param[in] Path The pointer to the path.
501 @return The pointer of the file path. The file path is callee
502 allocated and should be freed by the caller.
503 @retval NULL The path could not be found.
504 @retval NULL There was not enough available memory.
506 EFI_DEVICE_PATH_PROTOCOL
*
508 EfiShellGetDevicePathFromFilePath(
509 IN CONST CHAR16
*Path
516 CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
517 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopy
;
518 EFI_DEVICE_PATH_PROTOCOL
*DevicePathCopyForFree
;
519 EFI_DEVICE_PATH_PROTOCOL
*DevicePathForReturn
;
530 if (StrStr(Path
, L
":") == NULL
) {
531 Cwd
= EfiShellGetCurDir(NULL
);
535 Size
= StrSize(Cwd
) + StrSize(Path
);
536 NewPath
= AllocateZeroPool(Size
);
537 if (NewPath
== NULL
) {
540 StrCpyS(NewPath
, Size
/sizeof(CHAR16
), Cwd
);
541 StrCatS(NewPath
, Size
/sizeof(CHAR16
), L
"\\");
542 if (*Path
== L
'\\') {
544 while (PathRemoveLastItem(NewPath
)) ;
546 StrCatS(NewPath
, Size
/sizeof(CHAR16
), Path
);
547 DevicePathForReturn
= EfiShellGetDevicePathFromFilePath(NewPath
);
549 return (DevicePathForReturn
);
554 // find the part before (but including) the : for the map name
556 ASSERT((MapName
== NULL
&& Size
== 0) || (MapName
!= NULL
));
557 MapName
= StrnCatGrow(&MapName
, &Size
, Path
, (StrStr(Path
, L
":")-Path
+1));
558 if (MapName
== NULL
|| MapName
[StrLen(MapName
)-1] != L
':') {
563 // look up the device path in the map
565 DevicePath
= EfiShellGetDevicePathFromMap(MapName
);
566 if (DevicePath
== NULL
) {
568 // Must have been a bad Mapname
574 // make a copy for LocateDevicePath to modify (also save a pointer to call FreePool with)
576 DevicePathCopyForFree
= DevicePathCopy
= DuplicateDevicePath(DevicePath
);
577 if (DevicePathCopy
== NULL
) {
586 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
, &DevicePathCopy
, &Handle
);
587 if (EFI_ERROR(Status
)) {
588 if (DevicePathCopyForFree
!= NULL
) {
589 FreePool(DevicePathCopyForFree
);
596 // build the full device path
598 if (*(Path
+StrLen(MapName
)+1) == CHAR_NULL
) {
599 DevicePathForReturn
= FileDevicePath(Handle
, L
"\\");
601 DevicePathForReturn
= FileDevicePath(Handle
, Path
+StrLen(MapName
));
605 if (DevicePathCopyForFree
!= NULL
) {
606 FreePool(DevicePathCopyForFree
);
609 return (DevicePathForReturn
);
613 Gets the name of the device specified by the device handle.
615 This function gets the user-readable name of the device specified by the device
616 handle. If no user-readable name could be generated, then *BestDeviceName will be
617 NULL and EFI_NOT_FOUND will be returned.
619 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
620 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
623 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
624 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
625 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
626 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
627 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
629 @param DeviceHandle The handle of the device.
630 @param Flags Determines the possible sources of component names.
632 EFI_DEVICE_NAME_USE_COMPONENT_NAME
633 EFI_DEVICE_NAME_USE_DEVICE_PATH
634 @param Language A pointer to the language specified for the device
635 name, in the same format as described in the UEFI
636 specification, Appendix M
637 @param BestDeviceName On return, points to the callee-allocated NULL-
638 terminated name of the device. If no device name
639 could be found, points to NULL. The name must be
640 freed by the caller...
642 @retval EFI_SUCCESS Get the name successfully.
643 @retval EFI_NOT_FOUND Fail to get the device name.
644 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
645 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
646 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
650 EfiShellGetDeviceName(
651 IN EFI_HANDLE DeviceHandle
,
652 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
654 OUT CHAR16
**BestDeviceName
658 EFI_COMPONENT_NAME2_PROTOCOL
*CompName2
;
659 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
660 EFI_HANDLE
*HandleList
;
663 CHAR16
*DeviceNameToReturn
;
665 UINTN ParentControllerCount
;
666 EFI_HANDLE
*ParentControllerBuffer
;
667 UINTN ParentDriverCount
;
668 EFI_HANDLE
*ParentDriverBuffer
;
670 if (BestDeviceName
== NULL
||
673 return (EFI_INVALID_PARAMETER
);
677 // make sure one of the 2 supported bits is on
679 if (((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) == 0) &&
680 ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) == 0)) {
681 return (EFI_INVALID_PARAMETER
);
684 DeviceNameToReturn
= NULL
;
685 *BestDeviceName
= NULL
;
690 if ((Flags
& EFI_DEVICE_NAME_USE_COMPONENT_NAME
) != 0) {
691 Status
= ParseHandleDatabaseByRelationship(
694 HR_DRIVER_BINDING_HANDLE
|HR_DEVICE_DRIVER
,
697 for (LoopVar
= 0; LoopVar
< HandleCount
; LoopVar
++){
699 // Go through those handles until we get one that passes for GetComponentName
701 Status
= gBS
->OpenProtocol(
703 &gEfiComponentName2ProtocolGuid
,
707 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
708 if (EFI_ERROR(Status
)) {
709 Status
= gBS
->OpenProtocol(
711 &gEfiComponentNameProtocolGuid
,
715 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
718 if (EFI_ERROR(Status
)) {
721 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
722 Status
= CompName2
->GetControllerName(CompName2
, DeviceHandle
, NULL
, Lang
, &DeviceNameToReturn
);
725 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
729 if (HandleList
!= NULL
) {
730 FreePool(HandleList
);
734 // Now check the parent controller using this as the child.
736 if (DeviceNameToReturn
== NULL
){
737 PARSE_HANDLE_DATABASE_PARENTS(DeviceHandle
, &ParentControllerCount
, &ParentControllerBuffer
);
738 for (LoopVar
= 0 ; LoopVar
< ParentControllerCount
; LoopVar
++) {
739 PARSE_HANDLE_DATABASE_UEFI_DRIVERS(ParentControllerBuffer
[LoopVar
], &ParentDriverCount
, &ParentDriverBuffer
);
740 for (HandleCount
= 0 ; HandleCount
< ParentDriverCount
; HandleCount
++) {
742 // try using that driver's component name with controller and our driver as the child.
744 Status
= gBS
->OpenProtocol(
745 ParentDriverBuffer
[HandleCount
],
746 &gEfiComponentName2ProtocolGuid
,
750 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
751 if (EFI_ERROR(Status
)) {
752 Status
= gBS
->OpenProtocol(
753 ParentDriverBuffer
[HandleCount
],
754 &gEfiComponentNameProtocolGuid
,
758 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
761 if (EFI_ERROR(Status
)) {
764 Lang
= GetBestLanguageForDriver(CompName2
->SupportedLanguages
, Language
, FALSE
);
765 Status
= CompName2
->GetControllerName(CompName2
, ParentControllerBuffer
[LoopVar
], DeviceHandle
, Lang
, &DeviceNameToReturn
);
768 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
775 SHELL_FREE_NON_NULL(ParentDriverBuffer
);
776 if (!EFI_ERROR(Status
) && DeviceNameToReturn
!= NULL
) {
780 SHELL_FREE_NON_NULL(ParentControllerBuffer
);
783 // dont return on fail since we will try device path if that bit is on
785 if (DeviceNameToReturn
!= NULL
){
786 ASSERT(BestDeviceName
!= NULL
);
787 StrnCatGrow(BestDeviceName
, NULL
, DeviceNameToReturn
, 0);
788 return (EFI_SUCCESS
);
791 if ((Flags
& EFI_DEVICE_NAME_USE_DEVICE_PATH
) != 0) {
792 Status
= gBS
->OpenProtocol(
794 &gEfiDevicePathProtocolGuid
,
798 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
799 if (!EFI_ERROR(Status
)) {
801 // use device path to text on the device path
803 *BestDeviceName
= ConvertDevicePathToText(DevicePath
, TRUE
, TRUE
);
804 return (EFI_SUCCESS
);
808 // none of the selected bits worked.
810 return (EFI_NOT_FOUND
);
814 Opens the root directory of a device on a handle
816 This function opens the root directory of a device and returns a file handle to it.
818 @param DeviceHandle The handle of the device that contains the volume.
819 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
822 @retval EFI_SUCCESS Root opened successfully.
823 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
825 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
826 @retval EFI_DEVICE_ERROR The device had an error
830 EfiShellOpenRootByHandle(
831 IN EFI_HANDLE DeviceHandle
,
832 OUT SHELL_FILE_HANDLE
*FileHandle
836 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFileSystem
;
837 EFI_FILE_PROTOCOL
*RealFileHandle
;
838 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
841 // get the simple file system interface
843 Status
= gBS
->OpenProtocol(DeviceHandle
,
844 &gEfiSimpleFileSystemProtocolGuid
,
845 (VOID
**)&SimpleFileSystem
,
848 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
849 if (EFI_ERROR(Status
)) {
850 return (EFI_NOT_FOUND
);
853 Status
= gBS
->OpenProtocol(DeviceHandle
,
854 &gEfiDevicePathProtocolGuid
,
858 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
859 if (EFI_ERROR(Status
)) {
860 return (EFI_NOT_FOUND
);
863 // Open the root volume now...
865 Status
= SimpleFileSystem
->OpenVolume(SimpleFileSystem
, &RealFileHandle
);
866 *FileHandle
= ConvertEfiFileProtocolToShellHandle(RealFileHandle
, EfiShellGetMapFromDevicePath(&DevPath
));
871 Opens the root directory of a device.
873 This function opens the root directory of a device and returns a file handle to it.
875 @param DevicePath Points to the device path corresponding to the device where the
876 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
877 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
880 @retval EFI_SUCCESS Root opened successfully.
881 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
883 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
884 @retval EFI_DEVICE_ERROR The device had an error
885 @retval EFI_INVALID_PARAMETER FileHandle is NULL.
890 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
891 OUT SHELL_FILE_HANDLE
*FileHandle
897 if (FileHandle
== NULL
) {
898 return (EFI_INVALID_PARAMETER
);
902 // find the handle of the device with that device handle and the file system
905 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
908 if (EFI_ERROR(Status
)) {
909 return (EFI_NOT_FOUND
);
912 return (EfiShellOpenRootByHandle(Handle
, FileHandle
));
916 Returns whether any script files are currently being processed.
918 @retval TRUE There is at least one script file active.
919 @retval FALSE No script files are active now.
924 EfiShellBatchIsActive (
928 if (ShellCommandGetCurrentScriptFile() == NULL
) {
935 Worker function to open a file based on a device path. this will open the root
936 of the volume and then traverse down to the file itself.
938 @param DevicePath Device Path of the file.
939 @param FileHandle Pointer to the file upon a successful return.
940 @param OpenMode mode to open file in.
941 @param Attributes the File Attributes to use when creating a new file.
943 @retval EFI_SUCCESS the file is open and FileHandle is valid
944 @retval EFI_UNSUPPORTED the device path cotained non-path elements
945 @retval other an error ocurred.
949 InternalOpenFileDevicePath(
950 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
951 OUT SHELL_FILE_HANDLE
*FileHandle
,
953 IN UINT64 Attributes OPTIONAL
957 FILEPATH_DEVICE_PATH
*FilePathNode
;
959 SHELL_FILE_HANDLE ShellHandle
;
960 EFI_FILE_PROTOCOL
*Handle1
;
961 EFI_FILE_PROTOCOL
*Handle2
;
962 FILEPATH_DEVICE_PATH
*AlignedNode
;
964 if (FileHandle
== NULL
) {
965 return (EFI_INVALID_PARAMETER
);
975 Status
= EfiShellOpenRoot(DevicePath
, &ShellHandle
);
977 if (!EFI_ERROR(Status
)) {
978 Handle1
= ConvertShellHandleToEfiFileProtocol(ShellHandle
);
979 if (Handle1
!= NULL
) {
981 // chop off the begining part before the file system part...
984 Status
= gBS
->LocateDevicePath(&gEfiSimpleFileSystemProtocolGuid
,
987 if (!EFI_ERROR(Status
)) {
989 // To access as a file system, the file path should only
990 // contain file path components. Follow the file path nodes
991 // and find the target file
993 for ( FilePathNode
= (FILEPATH_DEVICE_PATH
*)DevicePath
994 ; !IsDevicePathEnd (&FilePathNode
->Header
)
995 ; FilePathNode
= (FILEPATH_DEVICE_PATH
*) NextDevicePathNode (&FilePathNode
->Header
)
997 SHELL_FREE_NON_NULL(AlignedNode
);
998 AlignedNode
= AllocateCopyPool (DevicePathNodeLength(FilePathNode
), FilePathNode
);
1000 // For file system access each node should be a file path component
1002 if (DevicePathType (&FilePathNode
->Header
) != MEDIA_DEVICE_PATH
||
1003 DevicePathSubType (&FilePathNode
->Header
) != MEDIA_FILEPATH_DP
1005 Status
= EFI_UNSUPPORTED
;
1010 // Open this file path node
1016 // if this is the last node in the DevicePath always create (if that was requested).
1018 if (IsDevicePathEnd ((NextDevicePathNode (&FilePathNode
->Header
)))) {
1019 Status
= Handle2
->Open (
1022 AlignedNode
->PathName
,
1029 // This is not the last node and we dont want to 'create' existing
1030 // directory entries...
1034 // open without letting it create
1035 // prevents error on existing files/directories
1037 Status
= Handle2
->Open (
1040 AlignedNode
->PathName
,
1041 OpenMode
&~EFI_FILE_MODE_CREATE
,
1045 // if above failed now open and create the 'item'
1046 // if OpenMode EFI_FILE_MODE_CREATE bit was on (but disabled above)
1048 if ((EFI_ERROR (Status
)) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)) {
1049 Status
= Handle2
->Open (
1052 AlignedNode
->PathName
,
1059 // Close the last node
1061 ShellInfoObject
.NewEfiShellProtocol
->CloseFile (Handle2
);
1064 // If there's been an error, stop
1066 if (EFI_ERROR (Status
)) {
1073 SHELL_FREE_NON_NULL(AlignedNode
);
1074 if (EFI_ERROR(Status
)) {
1075 if (Handle1
!= NULL
) {
1076 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(Handle1
);
1079 *FileHandle
= ConvertEfiFileProtocolToShellHandle(Handle1
, ShellFileHandleGetPath(ShellHandle
));
1085 Creates a file or directory by name.
1087 This function creates an empty new file or directory with the specified attributes and
1088 returns the new file's handle. If the file already exists and is read-only, then
1089 EFI_INVALID_PARAMETER will be returned.
1091 If the file already existed, it is truncated and its attributes updated. If the file is
1092 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
1094 If the file name begins with >v, then the file handle which is returned refers to the
1095 shell environment variable with the specified name. If the shell environment variable
1096 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
1098 @param FileName Pointer to NULL-terminated file path
1099 @param FileAttribs The new file's attrbiutes. the different attributes are
1100 described in EFI_FILE_PROTOCOL.Open().
1101 @param FileHandle On return, points to the created file handle or directory's handle
1103 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
1104 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1105 @retval EFI_UNSUPPORTED could not open the file path
1106 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
1107 file the file system on the device.
1108 @retval EFI_NO_MEDIA the device has no medium.
1109 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1111 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1113 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1114 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1115 when the media is write-protected.
1116 @retval EFI_ACCESS_DENIED The service denied access to the file.
1117 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
1118 @retval EFI_VOLUME_FULL The volume is full.
1123 IN CONST CHAR16
*FileName
,
1124 IN UINT64 FileAttribs
,
1125 OUT SHELL_FILE_HANDLE
*FileHandle
1128 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1132 // Is this for an environment variable
1133 // do we start with >v
1135 if (StrStr(FileName
, L
">v") == FileName
) {
1136 if (!IsVolatileEnv(FileName
+2)) {
1137 return (EFI_INVALID_PARAMETER
);
1139 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1140 return (EFI_SUCCESS
);
1144 // We are opening a regular file.
1146 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1147 if (DevicePath
== NULL
) {
1148 return (EFI_NOT_FOUND
);
1151 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, EFI_FILE_MODE_READ
|EFI_FILE_MODE_WRITE
|EFI_FILE_MODE_CREATE
, FileAttribs
);
1152 FreePool(DevicePath
);
1158 Register a GUID and a localized human readable name for it.
1160 If Guid is not assigned a name, then assign GuidName to Guid. This list of GUID
1161 names must be used whenever a shell command outputs GUID information.
1163 This function is only available when the major and minor versions in the
1164 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
1166 @param[in] Guid A pointer to the GUID being registered.
1167 @param[in] GuidName A pointer to the localized name for the GUID being registered.
1169 @retval EFI_SUCCESS The operation was successful.
1170 @retval EFI_INVALID_PARAMETER Guid was NULL.
1171 @retval EFI_INVALID_PARAMETER GuidName was NULL.
1172 @retval EFI_ACCESS_DENIED Guid already is assigned a name.
1176 EfiShellRegisterGuidName(
1177 IN CONST EFI_GUID
*Guid
,
1178 IN CONST CHAR16
*GuidName
1181 return (AddNewGuidNameMapping(Guid
, GuidName
, NULL
));
1185 Opens a file or a directory by file name.
1187 This function opens the specified file in the specified OpenMode and returns a file
1189 If the file name begins with >v, then the file handle which is returned refers to the
1190 shell environment variable with the specified name. If the shell environment variable
1191 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
1192 EFI_INVALID_PARAMETER is returned.
1194 If the file name is >i, then the file handle which is returned refers to the standard
1195 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
1198 If the file name is >o, then the file handle which is returned refers to the standard
1199 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1202 If the file name is >e, then the file handle which is returned refers to the standard
1203 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
1206 If the file name is NUL, then the file handle that is returned refers to the standard NUL
1207 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
1210 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
1213 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
1214 @param FileHandle On return, points to the file handle.
1215 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
1216 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
1218 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
1219 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
1220 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
1221 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
1222 system could not be found on the device. FileHandle is NULL.
1223 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
1224 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
1225 longer supported. FileHandle is NULL.
1226 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
1227 the FileName. FileHandle is NULL.
1228 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
1229 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
1230 when the media is write-protected. FileHandle is NULL.
1231 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
1232 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
1234 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
1238 EfiShellOpenFileByName(
1239 IN CONST CHAR16
*FileName
,
1240 OUT SHELL_FILE_HANDLE
*FileHandle
,
1244 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1250 // Is this for StdIn
1252 if (StrCmp(FileName
, L
">i") == 0) {
1254 // make sure not writing to StdIn
1256 if ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0) {
1257 return (EFI_INVALID_PARAMETER
);
1259 *FileHandle
= ShellInfoObject
.NewShellParametersProtocol
->StdIn
;
1260 ASSERT(*FileHandle
!= NULL
);
1261 return (EFI_SUCCESS
);
1265 // Is this for StdOut
1267 if (StrCmp(FileName
, L
">o") == 0) {
1269 // make sure not writing to StdIn
1271 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1272 return (EFI_INVALID_PARAMETER
);
1274 *FileHandle
= &FileInterfaceStdOut
;
1275 return (EFI_SUCCESS
);
1279 // Is this for NUL file
1281 if (StrCmp(FileName
, L
"NUL") == 0) {
1282 *FileHandle
= &FileInterfaceNulFile
;
1283 return (EFI_SUCCESS
);
1287 // Is this for StdErr
1289 if (StrCmp(FileName
, L
">e") == 0) {
1291 // make sure not writing to StdIn
1293 if ((OpenMode
& EFI_FILE_MODE_READ
) != 0) {
1294 return (EFI_INVALID_PARAMETER
);
1296 *FileHandle
= &FileInterfaceStdErr
;
1297 return (EFI_SUCCESS
);
1301 // Is this for an environment variable
1302 // do we start with >v
1304 if (StrStr(FileName
, L
">v") == FileName
) {
1305 if (!IsVolatileEnv(FileName
+2) &&
1306 ((OpenMode
& EFI_FILE_MODE_WRITE
) != 0)) {
1307 return (EFI_INVALID_PARAMETER
);
1309 *FileHandle
= CreateFileInterfaceEnv(FileName
+2);
1310 return (EFI_SUCCESS
);
1314 // We are opening a regular file.
1316 DevicePath
= EfiShellGetDevicePathFromFilePath(FileName
);
1317 // DEBUG_CODE(InternalShellProtocolDebugPrintMessage (NULL, DevicePath););
1318 if (DevicePath
== NULL
) {
1319 return (EFI_NOT_FOUND
);
1323 // Copy the device path, open the file, then free the memory
1325 Status
= InternalOpenFileDevicePath(DevicePath
, FileHandle
, OpenMode
, 0); // 0 = no specific file attributes
1326 FreePool(DevicePath
);
1332 Deletes the file specified by the file name.
1334 This function deletes a file.
1336 @param FileName Points to the NULL-terminated file name.
1338 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
1339 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
1340 @sa EfiShellCreateFile
1344 EfiShellDeleteFileByName(
1345 IN CONST CHAR16
*FileName
1348 SHELL_FILE_HANDLE FileHandle
;
1354 // get a handle to the file
1356 Status
= EfiShellCreateFile(FileName
,
1359 if (EFI_ERROR(Status
)) {
1363 // now delete the file
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
, 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 if ((PcdGet8(PcdShellSupportLevel
) < 1)) {
1637 return (EFI_UNSUPPORTED
);
1640 if (Environment
!= NULL
) {
1641 // If Environment isn't null, load a new image of the shell with its own
1643 DevPath
= AppendDevicePath (ShellInfoObject
.ImageDevPath
, ShellInfoObject
.FileDevPath
);
1646 Temp
= ConvertDevicePathToText(ShellInfoObject
.FileDevPath
, TRUE
, TRUE
);
1648 Temp
= ConvertDevicePathToText(ShellInfoObject
.ImageDevPath
, TRUE
, TRUE
);
1650 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
1656 ASSERT((Temp
== NULL
&& Size
== 0) || (Temp
!= NULL
));
1657 StrnCatGrow(&Temp
, &Size
, L
"Shell.efi -_exit ", 0);
1658 StrnCatGrow(&Temp
, &Size
, CommandLine
, 0);
1660 Status
= InternalShellExecuteDevicePath(
1664 (CONST CHAR16
**)Environment
,
1668 // de-allocate and return
1673 // If Environment is NULL, we are free to use and mutate the current shell
1674 // environment. This is much faster as uses much less memory.
1676 if (CommandLine
== NULL
) {
1680 Status
= RunShellCommand (CommandLine
, &CalleeStatusCode
);
1682 // Pass up the command's exit code if the caller wants it
1683 if (StatusCode
!= NULL
) {
1684 *StatusCode
= (EFI_STATUS
) CalleeStatusCode
;
1692 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
1694 1) frees all pointers (non-NULL)
1695 2) Closes the SHELL_FILE_HANDLE
1697 @param FileListNode pointer to the list node to free
1701 InternalFreeShellFileInfoNode(
1702 IN EFI_SHELL_FILE_INFO
*FileListNode
1705 if (FileListNode
->Info
!= NULL
) {
1706 FreePool((VOID
*)FileListNode
->Info
);
1708 if (FileListNode
->FileName
!= NULL
) {
1709 FreePool((VOID
*)FileListNode
->FileName
);
1711 if (FileListNode
->FullName
!= NULL
) {
1712 FreePool((VOID
*)FileListNode
->FullName
);
1714 if (FileListNode
->Handle
!= NULL
) {
1715 ShellInfoObject
.NewEfiShellProtocol
->CloseFile(FileListNode
->Handle
);
1717 FreePool(FileListNode
);
1720 Frees the file list.
1722 This function cleans up the file list and any related data structures. It has no
1723 impact on the files themselves.
1725 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
1726 defined in OpenFileList()
1728 @retval EFI_SUCCESS Free the file list successfully.
1729 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1733 EfiShellFreeFileList(
1734 IN EFI_SHELL_FILE_INFO
**FileList
1737 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1739 if (FileList
== NULL
|| *FileList
== NULL
) {
1740 return (EFI_INVALID_PARAMETER
);
1743 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1744 ; !IsListEmpty(&(*FileList
)->Link
)
1745 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1747 RemoveEntryList(&ShellFileListItem
->Link
);
1748 InternalFreeShellFileInfoNode(ShellFileListItem
);
1750 InternalFreeShellFileInfoNode(*FileList
);
1752 return(EFI_SUCCESS
);
1756 Deletes the duplicate file names files in the given file list.
1758 This function deletes the reduplicate files in the given file list.
1760 @param FileList A pointer to the first entry in the file list.
1762 @retval EFI_SUCCESS Always success.
1763 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
1767 EfiShellRemoveDupInFileList(
1768 IN EFI_SHELL_FILE_INFO
**FileList
1771 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1772 EFI_SHELL_FILE_INFO
*ShellFileListItem2
;
1773 EFI_SHELL_FILE_INFO
*TempNode
;
1775 if (FileList
== NULL
|| *FileList
== NULL
) {
1776 return (EFI_INVALID_PARAMETER
);
1778 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
1779 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1780 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1782 for ( ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
1783 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1784 ; ShellFileListItem2
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem2
->Link
)
1786 if (gUnicodeCollation
->StriColl(
1788 (CHAR16
*)ShellFileListItem
->FullName
,
1789 (CHAR16
*)ShellFileListItem2
->FullName
) == 0
1791 TempNode
= (EFI_SHELL_FILE_INFO
*)GetPreviousNode(
1793 &ShellFileListItem2
->Link
1795 RemoveEntryList(&ShellFileListItem2
->Link
);
1796 InternalFreeShellFileInfoNode(ShellFileListItem2
);
1797 // Set ShellFileListItem2 to PreviousNode so we don't access Freed
1798 // memory in GetNextNode in the loop expression above.
1799 ShellFileListItem2
= TempNode
;
1803 return (EFI_SUCCESS
);
1807 // This is the same structure as the external version, but it has no CONST qualifiers.
1810 LIST_ENTRY Link
; ///< Linked list members.
1811 EFI_STATUS Status
; ///< Status of opening the file. Valid only if Handle != NULL.
1812 CHAR16
*FullName
; ///< Fully qualified filename.
1813 CHAR16
*FileName
; ///< name of this file.
1814 SHELL_FILE_HANDLE Handle
; ///< Handle for interacting with the opened file or NULL if closed.
1815 EFI_FILE_INFO
*Info
; ///< Pointer to the FileInfo struct for this file or NULL.
1816 } EFI_SHELL_FILE_INFO_NO_CONST
;
1819 Allocates and duplicates a EFI_SHELL_FILE_INFO node.
1821 @param[in] Node The node to copy from.
1822 @param[in] Save TRUE to set Node->Handle to NULL, FALSE otherwise.
1824 @retval NULL a memory allocation error ocurred
1825 @return != NULL a pointer to the new node
1827 EFI_SHELL_FILE_INFO
*
1829 InternalDuplicateShellFileInfo(
1830 IN EFI_SHELL_FILE_INFO
*Node
,
1834 EFI_SHELL_FILE_INFO_NO_CONST
*NewNode
;
1837 // try to confirm that the objects are in sync
1839 ASSERT(sizeof(EFI_SHELL_FILE_INFO_NO_CONST
) == sizeof(EFI_SHELL_FILE_INFO
));
1841 NewNode
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1842 if (NewNode
== NULL
) {
1845 NewNode
->FullName
= AllocateCopyPool(StrSize(Node
->FullName
), Node
->FullName
);
1846 NewNode
->FileName
= AllocateCopyPool(StrSize(Node
->FileName
), Node
->FileName
);
1847 NewNode
->Info
= AllocateCopyPool((UINTN
)Node
->Info
->Size
, Node
->Info
);
1848 if ( NewNode
->FullName
== NULL
1849 || NewNode
->FileName
== NULL
1850 || NewNode
->Info
== NULL
1852 SHELL_FREE_NON_NULL(NewNode
->FullName
);
1853 SHELL_FREE_NON_NULL(NewNode
->FileName
);
1854 SHELL_FREE_NON_NULL(NewNode
->Info
);
1855 SHELL_FREE_NON_NULL(NewNode
);
1858 NewNode
->Status
= Node
->Status
;
1859 NewNode
->Handle
= Node
->Handle
;
1861 Node
->Handle
= NULL
;
1864 return((EFI_SHELL_FILE_INFO
*)NewNode
);
1868 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
1869 failed it will return NULL.
1871 @param[in] BasePath the Path to prepend onto filename for FullPath
1872 @param[in] Status Status member initial value.
1873 @param[in] FileName FileName member initial value.
1874 @param[in] Handle Handle member initial value.
1875 @param[in] Info Info struct to copy.
1877 @retval NULL An error ocurred.
1878 @return a pointer to the newly allocated structure.
1880 EFI_SHELL_FILE_INFO
*
1882 CreateAndPopulateShellFileInfo(
1883 IN CONST CHAR16
*BasePath
,
1884 IN CONST EFI_STATUS Status
,
1885 IN CONST CHAR16
*FileName
,
1886 IN CONST SHELL_FILE_HANDLE Handle
,
1887 IN CONST EFI_FILE_INFO
*Info
1890 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1897 ShellFileListItem
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1898 if (ShellFileListItem
== NULL
) {
1901 if (Info
!= NULL
&& Info
->Size
!= 0) {
1902 ShellFileListItem
->Info
= AllocateZeroPool((UINTN
)Info
->Size
);
1903 if (ShellFileListItem
->Info
== NULL
) {
1904 FreePool(ShellFileListItem
);
1907 CopyMem(ShellFileListItem
->Info
, Info
, (UINTN
)Info
->Size
);
1909 ShellFileListItem
->Info
= NULL
;
1911 if (FileName
!= NULL
) {
1912 ASSERT(TempString
== NULL
);
1913 ShellFileListItem
->FileName
= StrnCatGrow(&TempString
, 0, FileName
, 0);
1914 if (ShellFileListItem
->FileName
== NULL
) {
1915 FreePool(ShellFileListItem
->Info
);
1916 FreePool(ShellFileListItem
);
1920 ShellFileListItem
->FileName
= NULL
;
1924 if (BasePath
!= NULL
) {
1925 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1926 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
1927 if (TempString
== NULL
) {
1928 FreePool((VOID
*)ShellFileListItem
->FileName
);
1929 SHELL_FREE_NON_NULL(ShellFileListItem
->Info
);
1930 FreePool(ShellFileListItem
);
1934 if (ShellFileListItem
->FileName
!= NULL
) {
1935 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
1936 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileListItem
->FileName
, 0);
1937 if (TempString
== NULL
) {
1938 FreePool((VOID
*)ShellFileListItem
->FileName
);
1939 FreePool(ShellFileListItem
->Info
);
1940 FreePool(ShellFileListItem
);
1945 TempString
= PathCleanUpDirectories(TempString
);
1947 ShellFileListItem
->FullName
= TempString
;
1948 ShellFileListItem
->Status
= Status
;
1949 ShellFileListItem
->Handle
= Handle
;
1951 return (ShellFileListItem
);
1955 Find all files in a specified directory.
1957 @param FileDirHandle Handle of the directory to search.
1958 @param FileList On return, points to the list of files in the directory
1959 or NULL if there are no files in the directory.
1961 @retval EFI_SUCCESS File information was returned successfully.
1962 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
1963 @retval EFI_DEVICE_ERROR The device reported an error.
1964 @retval EFI_NO_MEDIA The device media is not present.
1965 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
1966 @return An error from FileHandleGetFileName().
1970 EfiShellFindFilesInDir(
1971 IN SHELL_FILE_HANDLE FileDirHandle
,
1972 OUT EFI_SHELL_FILE_INFO
**FileList
1975 EFI_SHELL_FILE_INFO
*ShellFileList
;
1976 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
1977 EFI_FILE_INFO
*FileInfo
;
1986 Status
= FileHandleGetFileName(FileDirHandle
, &BasePath
);
1987 if (EFI_ERROR(Status
)) {
1991 if (ShellFileHandleGetPath(FileDirHandle
) != NULL
) {
1994 TempString
= StrnCatGrow(&TempString
, &Size
, ShellFileHandleGetPath(FileDirHandle
), 0);
1995 if (TempString
== NULL
) {
1996 SHELL_FREE_NON_NULL(BasePath
);
1997 return (EFI_OUT_OF_RESOURCES
);
1999 TempSpot
= StrStr(TempString
, L
";");
2001 if (TempSpot
!= NULL
) {
2002 *TempSpot
= CHAR_NULL
;
2005 TempString
= StrnCatGrow(&TempString
, &Size
, BasePath
, 0);
2006 if (TempString
== NULL
) {
2007 SHELL_FREE_NON_NULL(BasePath
);
2008 return (EFI_OUT_OF_RESOURCES
);
2010 SHELL_FREE_NON_NULL(BasePath
);
2011 BasePath
= TempString
;
2015 ShellFileList
= NULL
;
2016 ShellFileListItem
= NULL
;
2018 Status
= EFI_SUCCESS
;
2021 for ( Status
= FileHandleFindFirstFile(FileDirHandle
, &FileInfo
)
2022 ; !EFI_ERROR(Status
) && !NoFile
2023 ; Status
= FileHandleFindNextFile(FileDirHandle
, FileInfo
, &NoFile
)
2026 // allocate a new EFI_SHELL_FILE_INFO and populate it...
2028 ShellFileListItem
= CreateAndPopulateShellFileInfo(
2030 EFI_SUCCESS
, // success since we didnt fail to open it...
2032 NULL
, // no handle since not open
2035 if (ShellFileList
== NULL
) {
2036 ShellFileList
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2037 ASSERT(ShellFileList
!= NULL
);
2038 InitializeListHead(&ShellFileList
->Link
);
2040 InsertTailList(&ShellFileList
->Link
, &ShellFileListItem
->Link
);
2042 if (EFI_ERROR(Status
)) {
2043 EfiShellFreeFileList(&ShellFileList
);
2046 *FileList
= ShellFileList
;
2048 SHELL_FREE_NON_NULL(BasePath
);
2053 Get the GUID value from a human readable name.
2055 If GuidName is a known GUID name, then update Guid to have the correct value for
2058 This function is only available when the major and minor versions in the
2059 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2061 @param[in] GuidName A pointer to the localized name for the GUID being queried.
2062 @param[out] Guid A pointer to the GUID structure to be filled in.
2064 @retval EFI_SUCCESS The operation was successful.
2065 @retval EFI_INVALID_PARAMETER Guid was NULL.
2066 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2067 @retval EFI_NOT_FOUND GuidName is not a known GUID Name.
2071 EfiShellGetGuidFromName(
2072 IN CONST CHAR16
*GuidName
,
2079 if (Guid
== NULL
|| GuidName
== NULL
) {
2080 return (EFI_INVALID_PARAMETER
);
2083 Status
= GetGuidFromStringName(GuidName
, NULL
, &NewGuid
);
2085 if (!EFI_ERROR(Status
)) {
2086 CopyGuid(NewGuid
, Guid
);
2093 Get the human readable name for a GUID from the value.
2095 If Guid is assigned a name, then update *GuidName to point to the name. The callee
2096 should not modify the value.
2098 This function is only available when the major and minor versions in the
2099 EfiShellProtocol are greater than or equal to 2 and 1, respectively.
2101 @param[in] Guid A pointer to the GUID being queried.
2102 @param[out] GuidName A pointer to a pointer the localized to name for the GUID being requested
2104 @retval EFI_SUCCESS The operation was successful.
2105 @retval EFI_INVALID_PARAMETER Guid was NULL.
2106 @retval EFI_INVALID_PARAMETER GuidName was NULL.
2107 @retval EFI_NOT_FOUND Guid is not assigned a name.
2111 EfiShellGetGuidName(
2112 IN CONST EFI_GUID
*Guid
,
2113 OUT CONST CHAR16
**GuidName
2118 if (Guid
== NULL
|| GuidName
== NULL
) {
2119 return (EFI_INVALID_PARAMETER
);
2122 Name
= GetStringNameFromGuid(Guid
, NULL
);
2123 if (Name
== NULL
|| StrLen(Name
) == 0) {
2124 SHELL_FREE_NON_NULL(Name
);
2125 return (EFI_NOT_FOUND
);
2128 *GuidName
= AddBufferToFreeList(Name
);
2130 return (EFI_SUCCESS
);
2134 Updates a file name to be preceeded by the mapped drive name
2136 @param[in] BasePath the Mapped drive name to prepend
2137 @param[in, out] Path pointer to pointer to the file name to update.
2140 @retval EFI_OUT_OF_RESOURCES
2145 IN CONST CHAR16
*BasePath
,
2146 IN OUT CHAR16
**Path
2155 ASSERT(Path
!= NULL
);
2156 ASSERT(*Path
!= NULL
);
2157 ASSERT(BasePath
!= NULL
);
2160 // convert a local path to an absolute path
2162 if (StrStr(*Path
, L
":") == NULL
) {
2163 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2164 StrnCatGrow(&Path2
, &Path2Size
, BasePath
, 0);
2165 if (Path2
== NULL
) {
2166 return (EFI_OUT_OF_RESOURCES
);
2168 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2169 StrnCatGrow(&Path2
, &Path2Size
, (*Path
)[0] == L
'\\'?(*Path
) + 1 :*Path
, 0);
2170 if (Path2
== NULL
) {
2171 return (EFI_OUT_OF_RESOURCES
);
2178 return (EFI_SUCCESS
);
2182 If FileHandle is a directory then the function reads from FileHandle and reads in
2183 each of the FileInfo structures. If one of them matches the Pattern's first
2184 "level" then it opens that handle and calls itself on that handle.
2186 If FileHandle is a file and matches all of the remaining Pattern (which would be
2187 on its last node), then add a EFI_SHELL_FILE_INFO object for this file to fileList.
2189 Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call
2190 FreeFileList with FileList.
2192 @param[in] FilePattern The FilePattern to check against.
2193 @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure
2194 @param[in] FileHandle The FileHandle to start with
2195 @param[in, out] FileList pointer to pointer to list of found files.
2196 @param[in] ParentNode The node for the parent. Same file as identified by HANDLE.
2197 @param[in] MapName The file system name this file is on.
2199 @retval EFI_SUCCESS all files were found and the FileList contains a list.
2200 @retval EFI_NOT_FOUND no files were found
2201 @retval EFI_OUT_OF_RESOURCES a memory allocation failed
2206 IN CONST CHAR16
*FilePattern
,
2207 IN EFI_UNICODE_COLLATION_PROTOCOL
*UnicodeCollation
,
2208 IN SHELL_FILE_HANDLE FileHandle
,
2209 IN OUT EFI_SHELL_FILE_INFO
**FileList
,
2210 IN CONST EFI_SHELL_FILE_INFO
*ParentNode OPTIONAL
,
2211 IN CONST CHAR16
*MapName
2215 CONST CHAR16
*NextFilePatternStart
;
2216 CHAR16
*CurrentFilePattern
;
2217 EFI_SHELL_FILE_INFO
*ShellInfo
;
2218 EFI_SHELL_FILE_INFO
*ShellInfoNode
;
2219 EFI_SHELL_FILE_INFO
*NewShellNode
;
2220 EFI_FILE_INFO
*FileInfo
;
2222 CHAR16
*NewFullName
;
2225 if ( FilePattern
== NULL
2226 || UnicodeCollation
== NULL
2229 return (EFI_INVALID_PARAMETER
);
2232 CurrentFilePattern
= NULL
;
2234 if (*FilePattern
== L
'\\') {
2238 for( NextFilePatternStart
= FilePattern
2239 ; *NextFilePatternStart
!= CHAR_NULL
&& *NextFilePatternStart
!= L
'\\'
2240 ; NextFilePatternStart
++);
2242 CurrentFilePattern
= AllocateZeroPool((NextFilePatternStart
-FilePattern
+1)*sizeof(CHAR16
));
2243 ASSERT(CurrentFilePattern
!= NULL
);
2244 StrnCpyS(CurrentFilePattern
, NextFilePatternStart
-FilePattern
+1, FilePattern
, NextFilePatternStart
-FilePattern
);
2246 if (CurrentFilePattern
[0] == CHAR_NULL
2247 &&NextFilePatternStart
[0] == CHAR_NULL
2250 // we want the parent or root node (if no parent)
2252 if (ParentNode
== NULL
) {
2254 // We want the root node. create the node.
2256 FileInfo
= FileHandleGetInfo(FileHandle
);
2257 NewShellNode
= CreateAndPopulateShellFileInfo(
2264 SHELL_FREE_NON_NULL(FileInfo
);
2267 // Add the current parameter FileHandle to the list, then end...
2269 NewShellNode
= InternalDuplicateShellFileInfo((EFI_SHELL_FILE_INFO
*)ParentNode
, TRUE
);
2271 if (NewShellNode
== NULL
) {
2272 Status
= EFI_OUT_OF_RESOURCES
;
2274 NewShellNode
->Handle
= NULL
;
2275 if (*FileList
== NULL
) {
2276 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2277 InitializeListHead(&((*FileList
)->Link
));
2281 // Add to the returning to use list
2283 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2285 Status
= EFI_SUCCESS
;
2288 Status
= EfiShellFindFilesInDir(FileHandle
, &ShellInfo
);
2290 if (!EFI_ERROR(Status
)){
2291 if (StrStr(NextFilePatternStart
, L
"\\") != NULL
){
2296 for ( ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&ShellInfo
->Link
)
2297 ; !IsNull (&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2298 ; ShellInfoNode
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&ShellInfo
->Link
, &ShellInfoNode
->Link
)
2300 if (UnicodeCollation
->MetaiMatch(UnicodeCollation
, (CHAR16
*)ShellInfoNode
->FileName
, CurrentFilePattern
)){
2301 if (ShellInfoNode
->FullName
!= NULL
&& StrStr(ShellInfoNode
->FullName
, L
":") == NULL
) {
2302 Size
= StrSize(ShellInfoNode
->FullName
);
2303 Size
+= StrSize(MapName
) + sizeof(CHAR16
);
2304 NewFullName
= AllocateZeroPool(Size
);
2305 if (NewFullName
== NULL
) {
2306 Status
= EFI_OUT_OF_RESOURCES
;
2308 StrCpyS(NewFullName
, Size
/sizeof(CHAR16
), MapName
);
2309 StrCatS(NewFullName
, Size
/sizeof(CHAR16
), ShellInfoNode
->FullName
+1);
2310 FreePool((VOID
*)ShellInfoNode
->FullName
);
2311 ShellInfoNode
->FullName
= NewFullName
;
2314 if (Directory
&& !EFI_ERROR(Status
) && ShellInfoNode
->FullName
!= NULL
&& ShellInfoNode
->FileName
!= NULL
){
2316 // should be a directory
2320 // don't open the . and .. directories
2322 if ( (StrCmp(ShellInfoNode
->FileName
, L
".") != 0)
2323 && (StrCmp(ShellInfoNode
->FileName
, L
"..") != 0)
2328 if (EFI_ERROR(Status
)) {
2332 // Open the directory since we need that handle in the next recursion.
2334 ShellInfoNode
->Status
= EfiShellOpenFileByName (ShellInfoNode
->FullName
, &ShellInfoNode
->Handle
, EFI_FILE_MODE_READ
);
2337 // recurse with the next part of the pattern
2339 Status
= ShellSearchHandle(NextFilePatternStart
, UnicodeCollation
, ShellInfoNode
->Handle
, FileList
, ShellInfoNode
, MapName
);
2341 } else if (!EFI_ERROR(Status
)) {
2347 // copy the information we need into a new Node
2349 NewShellNode
= InternalDuplicateShellFileInfo(ShellInfoNode
, FALSE
);
2350 ASSERT(NewShellNode
!= NULL
);
2351 if (NewShellNode
== NULL
) {
2352 Status
= EFI_OUT_OF_RESOURCES
;
2354 if (*FileList
== NULL
) {
2355 *FileList
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
2356 InitializeListHead(&((*FileList
)->Link
));
2360 // Add to the returning to use list
2362 InsertTailList(&(*FileList
)->Link
, &NewShellNode
->Link
);
2365 if (EFI_ERROR(Status
)) {
2369 if (EFI_ERROR(Status
)) {
2370 EfiShellFreeFileList(&ShellInfo
);
2372 Status
= EfiShellFreeFileList(&ShellInfo
);
2377 FreePool(CurrentFilePattern
);
2382 Find files that match a specified pattern.
2384 This function searches for all files and directories that match the specified
2385 FilePattern. The FilePattern can contain wild-card characters. The resulting file
2386 information is placed in the file list FileList.
2388 Wildcards are processed
2389 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
2391 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
2392 field is set to NULL.
2394 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
2396 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
2397 @param FileList On return, points to the start of a file list containing the names
2398 of all matching files or else points to NULL if no matching files
2399 were found. only on a EFI_SUCCESS return will; this be non-NULL.
2401 @retval EFI_SUCCESS Files found. FileList is a valid list.
2402 @retval EFI_NOT_FOUND No files found.
2403 @retval EFI_NO_MEDIA The device has no media
2404 @retval EFI_DEVICE_ERROR The device reported an error
2405 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
2410 IN CONST CHAR16
*FilePattern
,
2411 OUT EFI_SHELL_FILE_INFO
**FileList
2415 CHAR16
*PatternCopy
;
2416 CHAR16
*PatternCurrentLocation
;
2417 EFI_DEVICE_PATH_PROTOCOL
*RootDevicePath
;
2418 SHELL_FILE_HANDLE RootFileHandle
;
2422 if ( FilePattern
== NULL
2424 || StrStr(FilePattern
, L
":") == NULL
2426 return (EFI_INVALID_PARAMETER
);
2428 Status
= EFI_SUCCESS
;
2429 RootDevicePath
= NULL
;
2430 RootFileHandle
= NULL
;
2432 PatternCopy
= AllocateCopyPool(StrSize(FilePattern
), FilePattern
);
2433 if (PatternCopy
== NULL
) {
2434 return (EFI_OUT_OF_RESOURCES
);
2437 PatternCopy
= PathCleanUpDirectories(PatternCopy
);
2439 Count
= StrStr(PatternCopy
, L
":") - PatternCopy
;
2442 ASSERT(MapName
== NULL
);
2443 MapName
= StrnCatGrow(&MapName
, NULL
, PatternCopy
, Count
);
2444 if (MapName
== NULL
) {
2445 Status
= EFI_OUT_OF_RESOURCES
;
2447 RootDevicePath
= EfiShellGetDevicePathFromFilePath(PatternCopy
);
2448 if (RootDevicePath
== NULL
) {
2449 Status
= EFI_INVALID_PARAMETER
;
2451 Status
= EfiShellOpenRoot(RootDevicePath
, &RootFileHandle
);
2452 if (!EFI_ERROR(Status
)) {
2453 for ( PatternCurrentLocation
= PatternCopy
2454 ; *PatternCurrentLocation
!= ':'
2455 ; PatternCurrentLocation
++);
2456 PatternCurrentLocation
++;
2457 Status
= ShellSearchHandle(PatternCurrentLocation
, gUnicodeCollation
, RootFileHandle
, FileList
, NULL
, MapName
);
2459 FreePool(RootDevicePath
);
2463 SHELL_FREE_NON_NULL(PatternCopy
);
2464 SHELL_FREE_NON_NULL(MapName
);
2470 Opens the files that match the path specified.
2472 This function opens all of the files specified by Path. Wildcards are processed
2473 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
2474 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
2476 @param Path A pointer to the path string.
2477 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
2478 EFI_FILE_MODE_WRITE.
2479 @param FileList Points to the start of a list of files opened.
2481 @retval EFI_SUCCESS Create the file list successfully.
2482 @return Others Can't create the file list.
2486 EfiShellOpenFileList(
2489 IN OUT EFI_SHELL_FILE_INFO
**FileList
2493 EFI_SHELL_FILE_INFO
*ShellFileListItem
;
2496 CONST CHAR16
*CurDir
;
2499 PathCleanUpDirectories(Path
);
2504 if (FileList
== NULL
|| *FileList
== NULL
) {
2505 return (EFI_INVALID_PARAMETER
);
2508 if (*Path
== L
'.' && *(Path
+1) == L
'\\') {
2513 // convert a local path to an absolute path
2515 if (StrStr(Path
, L
":") == NULL
) {
2516 CurDir
= EfiShellGetCurDir(NULL
);
2517 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2518 StrnCatGrow(&Path2
, &Path2Size
, CurDir
, 0);
2519 StrnCatGrow(&Path2
, &Path2Size
, L
"\\", 0);
2520 if (*Path
== L
'\\') {
2522 while (PathRemoveLastItem(Path2
)) ;
2524 ASSERT((Path2
== NULL
&& Path2Size
== 0) || (Path2
!= NULL
));
2525 StrnCatGrow(&Path2
, &Path2Size
, Path
, 0);
2527 ASSERT(Path2
== NULL
);
2528 StrnCatGrow(&Path2
, NULL
, Path
, 0);
2531 PathCleanUpDirectories (Path2
);
2536 Status
= EfiShellFindFiles(Path2
, FileList
);
2540 if (EFI_ERROR(Status
)) {
2546 // We had no errors so open all the files (that are not already opened...)
2548 for ( ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetFirstNode(&(*FileList
)->Link
)
2549 ; !IsNull(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2550 ; ShellFileListItem
= (EFI_SHELL_FILE_INFO
*)GetNextNode(&(*FileList
)->Link
, &ShellFileListItem
->Link
)
2552 if (ShellFileListItem
->Status
== 0 && ShellFileListItem
->Handle
== NULL
) {
2553 ShellFileListItem
->Status
= EfiShellOpenFileByName (ShellFileListItem
->FullName
, &ShellFileListItem
->Handle
, OpenMode
);
2559 return (EFI_NOT_FOUND
);
2561 return(EFI_SUCCESS
);
2565 Gets the environment variable and Attributes, or list of environment variables. Can be
2566 used instead of GetEnv().
2568 This function returns the current value of the specified environment variable and
2569 the Attributes. If no variable name was specified, then all of the known
2570 variables will be returned.
2572 @param[in] Name A pointer to the environment variable name. If Name is NULL,
2573 then the function will return all of the defined shell
2574 environment variables. In the case where multiple environment
2575 variables are being returned, each variable will be terminated
2576 by a NULL, and the list will be terminated by a double NULL.
2577 @param[out] Attributes If not NULL, a pointer to the returned attributes bitmask for
2578 the environment variable. In the case where Name is NULL, and
2579 multiple environment variables are being returned, Attributes
2582 @retval NULL The environment variable doesn't exist.
2583 @return A non-NULL value points to the variable's value. The returned
2584 pointer does not need to be freed by the caller.
2589 IN CONST CHAR16
*Name
,
2590 OUT UINT32
*Attributes OPTIONAL
2598 CHAR16
*CurrentWriteLocation
;
2605 // Get all our environment variables
2607 InitializeListHead(&List
);
2608 Status
= GetEnvironmentVariableList(&List
);
2609 if (EFI_ERROR(Status
)){
2614 // Build the semi-colon delimited list. (2 passes)
2616 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2617 ; !IsNull(&List
, &Node
->Link
)
2618 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2620 ASSERT(Node
->Key
!= NULL
);
2621 Size
+= StrSize(Node
->Key
);
2624 Size
+= 2*sizeof(CHAR16
);
2626 Buffer
= AllocateZeroPool(Size
);
2627 if (Buffer
== NULL
) {
2628 if (!IsListEmpty (&List
)) {
2629 FreeEnvironmentVariableList(&List
);
2633 CurrentWriteLocation
= (CHAR16
*)Buffer
;
2635 for ( Node
= (ENV_VAR_LIST
*)GetFirstNode(&List
)
2636 ; !IsNull(&List
, &Node
->Link
)
2637 ; Node
= (ENV_VAR_LIST
*)GetNextNode(&List
, &Node
->Link
)
2639 ASSERT(Node
->Key
!= NULL
);
2640 StrCpyS( CurrentWriteLocation
,
2641 (Size
)/sizeof(CHAR16
) - (CurrentWriteLocation
- ((CHAR16
*)Buffer
)),
2644 CurrentWriteLocation
+= StrLen(CurrentWriteLocation
) + 1;
2650 if (!IsListEmpty (&List
)) {
2651 FreeEnvironmentVariableList(&List
);
2655 // We are doing a specific environment variable
2659 // get the size we need for this EnvVariable
2661 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2662 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2664 // Allocate the space and recall the get function
2666 Buffer
= AllocateZeroPool(Size
);
2667 Status
= SHELL_GET_ENVIRONMENT_VARIABLE_AND_ATTRIBUTES(Name
, Attributes
, &Size
, Buffer
);
2670 // we didnt get it (might not exist)
2671 // free the memory if we allocated any and return NULL
2673 if (EFI_ERROR(Status
)) {
2674 if (Buffer
!= NULL
) {
2682 // return the buffer
2684 return (AddBufferToFreeList(Buffer
));
2688 Gets either a single or list of environment variables.
2690 If name is not NULL then this function returns the current value of the specified
2691 environment variable.
2693 If Name is NULL, then a list of all environment variable names is returned. Each is a
2694 NULL terminated string with a double NULL terminating the list.
2696 @param Name A pointer to the environment variable name. If
2697 Name is NULL, then the function will return all
2698 of the defined shell environment variables. In
2699 the case where multiple environment variables are
2700 being returned, each variable will be terminated by
2701 a NULL, and the list will be terminated by a double
2704 @retval !=NULL A pointer to the returned string.
2705 The returned pointer does not need to be freed by the caller.
2707 @retval NULL The environment variable doesn't exist or there are
2708 no environment variables.
2713 IN CONST CHAR16
*Name
2716 return (EfiShellGetEnvEx(Name
, NULL
));
2720 Internal variable setting function. Allows for setting of the read only variables.
2722 @param Name Points to the NULL-terminated environment variable name.
2723 @param Value Points to the NULL-terminated environment variable value. If the value is an
2724 empty string then the environment variable is deleted.
2725 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2727 @retval EFI_SUCCESS The environment variable was successfully updated.
2731 InternalEfiShellSetEnv(
2732 IN CONST CHAR16
*Name
,
2733 IN CONST CHAR16
*Value
,
2737 if (Value
== NULL
|| StrLen(Value
) == 0) {
2738 return (SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
));
2740 SHELL_DELETE_ENVIRONMENT_VARIABLE(Name
);
2742 return (SHELL_SET_ENVIRONMENT_VARIABLE_V(Name
, StrSize(Value
), Value
));
2744 return (SHELL_SET_ENVIRONMENT_VARIABLE_NV(Name
, StrSize(Value
), Value
));
2750 Sets the environment variable.
2752 This function changes the current value of the specified environment variable. If the
2753 environment variable exists and the Value is an empty string, then the environment
2754 variable is deleted. If the environment variable exists and the Value is not an empty
2755 string, then the value of the environment variable is changed. If the environment
2756 variable does not exist and the Value is an empty string, there is no action. If the
2757 environment variable does not exist and the Value is a non-empty string, then the
2758 environment variable is created and assigned the specified value.
2760 For a description of volatile and non-volatile environment variables, see UEFI Shell
2761 2.0 specification section 3.6.1.
2763 @param Name Points to the NULL-terminated environment variable name.
2764 @param Value Points to the NULL-terminated environment variable value. If the value is an
2765 empty string then the environment variable is deleted.
2766 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
2768 @retval EFI_SUCCESS The environment variable was successfully updated.
2773 IN CONST CHAR16
*Name
,
2774 IN CONST CHAR16
*Value
,
2778 if (Name
== NULL
|| *Name
== CHAR_NULL
) {
2779 return (EFI_INVALID_PARAMETER
);
2782 // Make sure we dont 'set' a predefined read only variable
2784 if (gUnicodeCollation
->StriColl(
2788 ||gUnicodeCollation
->StriColl(
2792 ||gUnicodeCollation
->StriColl(
2796 ||gUnicodeCollation
->StriColl(
2799 L
"uefishellsupport") == 0
2800 ||gUnicodeCollation
->StriColl(
2803 L
"uefishellversion") == 0
2804 ||gUnicodeCollation
->StriColl(
2807 L
"uefiversion") == 0
2809 return (EFI_INVALID_PARAMETER
);
2811 return (InternalEfiShellSetEnv(Name
, Value
, Volatile
));
2815 Returns the current directory on the specified device.
2817 If FileSystemMapping is NULL, it returns the current working directory. If the
2818 FileSystemMapping is not NULL, it returns the current directory associated with the
2819 FileSystemMapping. In both cases, the returned name includes the file system
2820 mapping (i.e. fs0:\current-dir).
2822 Note that the current directory string should exclude the tailing backslash character.
2824 @param FileSystemMapping A pointer to the file system mapping. If NULL,
2825 then the current working directory is returned.
2827 @retval !=NULL The current directory.
2828 @retval NULL Current directory does not exist.
2833 IN CONST CHAR16
*FileSystemMapping OPTIONAL
2836 CHAR16
*PathToReturn
;
2838 SHELL_MAP_LIST
*MapListItem
;
2839 if (!IsListEmpty(&gShellMapList
.Link
)) {
2841 // if parameter is NULL, use current
2843 if (FileSystemMapping
== NULL
) {
2844 return (EfiShellGetEnv(L
"cwd"));
2847 PathToReturn
= NULL
;
2848 MapListItem
= ShellCommandFindMapItem(FileSystemMapping
);
2849 if (MapListItem
!= NULL
) {
2850 ASSERT((PathToReturn
== NULL
&& Size
== 0) || (PathToReturn
!= NULL
));
2851 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->MapName
, 0);
2852 PathToReturn
= StrnCatGrow(&PathToReturn
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
2855 return (AddBufferToFreeList(PathToReturn
));
2862 Changes the current directory on the specified device.
2864 If the FileSystem is NULL, and the directory Dir does not contain a file system's
2865 mapped name, this function changes the current working directory.
2867 If the FileSystem is NULL and the directory Dir contains a mapped name, then the
2868 current file system and the current directory on that file system are changed.
2870 If FileSystem is NULL, and Dir is not NULL, then this changes the current working file
2873 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
2874 directory on the specified file system.
2876 If the current working directory or the current working file system is changed then the
2877 %cwd% environment variable will be updated
2879 Note that the current directory string should exclude the tailing backslash character.
2881 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
2882 directory is changed.
2883 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
2885 @retval EFI_SUCCESS The operation was sucessful
2886 @retval EFI_NOT_FOUND The file system could not be found
2891 IN CONST CHAR16
*FileSystem OPTIONAL
,
2892 IN CONST CHAR16
*Dir
2896 SHELL_MAP_LIST
*MapListItem
;
2900 CHAR16
*DirectoryName
;
2907 DirectoryName
= NULL
;
2909 if ((FileSystem
== NULL
&& Dir
== NULL
) || Dir
== NULL
) {
2910 return (EFI_INVALID_PARAMETER
);
2913 if (IsListEmpty(&gShellMapList
.Link
)){
2914 return (EFI_NOT_FOUND
);
2917 DirectoryName
= StrnCatGrow(&DirectoryName
, NULL
, Dir
, 0);
2918 ASSERT(DirectoryName
!= NULL
);
2920 PathCleanUpDirectories(DirectoryName
);
2922 if (FileSystem
== NULL
) {
2924 // determine the file system mapping to use
2926 if (StrStr(DirectoryName
, L
":") != NULL
) {
2927 ASSERT(MapName
== NULL
);
2928 MapName
= StrnCatGrow(&MapName
, NULL
, DirectoryName
, (StrStr(DirectoryName
, L
":")-DirectoryName
+1));
2931 // find the file system mapping's entry in the list
2934 if (MapName
!= NULL
) {
2935 MapListItem
= ShellCommandFindMapItem(MapName
);
2938 // make that the current file system mapping
2940 if (MapListItem
!= NULL
) {
2941 gShellCurDir
= MapListItem
;
2944 MapListItem
= gShellCurDir
;
2947 if (MapListItem
== NULL
) {
2948 return (EFI_NOT_FOUND
);
2952 // now update the MapListItem's current directory
2954 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& DirectoryName
[StrLen(DirectoryName
) - 1] != L
':') {
2955 FreePool(MapListItem
->CurrentDirectoryPath
);
2956 MapListItem
->CurrentDirectoryPath
= NULL
;
2958 if (MapName
!= NULL
) {
2959 TempLen
= StrLen(MapName
);
2960 if (TempLen
!= StrLen(DirectoryName
)) {
2961 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2962 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
+StrLen(MapName
), 0);
2965 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2966 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
2968 if ((MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') || (MapListItem
->CurrentDirectoryPath
== NULL
)) {
2969 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
2970 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2971 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
2976 // cant have a mapping in the directory...
2978 if (StrStr(DirectoryName
, L
":") != NULL
) {
2979 return (EFI_INVALID_PARAMETER
);
2982 // FileSystem != NULL
2984 MapListItem
= ShellCommandFindMapItem(FileSystem
);
2985 if (MapListItem
== NULL
) {
2986 return (EFI_INVALID_PARAMETER
);
2988 // gShellCurDir = MapListItem;
2989 if (DirectoryName
!= NULL
) {
2991 // change current dir on that file system
2994 if (MapListItem
->CurrentDirectoryPath
!= NULL
) {
2995 FreePool(MapListItem
->CurrentDirectoryPath
);
2996 DEBUG_CODE(MapListItem
->CurrentDirectoryPath
= NULL
;);
2998 // ASSERT((MapListItem->CurrentDirectoryPath == NULL && Size == 0) || (MapListItem->CurrentDirectoryPath != NULL));
2999 // MapListItem->CurrentDirectoryPath = StrnCatGrow(&MapListItem->CurrentDirectoryPath, &Size, FileSystem, 0);
3000 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3001 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, L
"\\", 0);
3002 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3003 MapListItem
->CurrentDirectoryPath
= StrnCatGrow(&MapListItem
->CurrentDirectoryPath
, &Size
, DirectoryName
, 0);
3004 if (MapListItem
->CurrentDirectoryPath
!= NULL
&& MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] == L
'\\') {
3005 ASSERT((MapListItem
->CurrentDirectoryPath
== NULL
&& Size
== 0) || (MapListItem
->CurrentDirectoryPath
!= NULL
));
3006 MapListItem
->CurrentDirectoryPath
[StrLen(MapListItem
->CurrentDirectoryPath
)-1] = CHAR_NULL
;
3011 // if updated the current directory then update the environment variable
3013 if (MapListItem
== gShellCurDir
) {
3015 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3016 StrnCatGrow(&TempString
, &Size
, MapListItem
->MapName
, 0);
3017 ASSERT((TempString
== NULL
&& Size
== 0) || (TempString
!= NULL
));
3018 StrnCatGrow(&TempString
, &Size
, MapListItem
->CurrentDirectoryPath
, 0);
3019 Status
= InternalEfiShellSetEnv(L
"cwd", TempString
, TRUE
);
3020 FreePool(TempString
);
3023 return(EFI_SUCCESS
);
3027 Return help information about a specific command.
3029 This function returns the help information for the specified command. The help text
3030 can be internal to the shell or can be from a UEFI Shell manual page.
3032 If Sections is specified, then each section name listed will be compared in a casesensitive
3033 manner, to the section names described in Appendix B. If the section exists,
3034 it will be appended to the returned help text. If the section does not exist, no
3035 information will be returned. If Sections is NULL, then all help text information
3036 available will be returned.
3038 @param Command Points to the NULL-terminated UEFI Shell command name.
3039 @param Sections Points to the NULL-terminated comma-delimited
3040 section names to return. If NULL, then all
3041 sections will be returned.
3042 @param HelpText On return, points to a callee-allocated buffer
3043 containing all specified help text.
3045 @retval EFI_SUCCESS The help text was returned.
3046 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
3048 @retval EFI_INVALID_PARAMETER HelpText is NULL
3049 @retval EFI_NOT_FOUND There is no help text available for Command.
3053 EfiShellGetHelpText(
3054 IN CONST CHAR16
*Command
,
3055 IN CONST CHAR16
*Sections OPTIONAL
,
3056 OUT CHAR16
**HelpText
3059 CONST CHAR16
*ManFileName
;
3063 ASSERT(HelpText
!= NULL
);
3066 ManFileName
= ShellCommandGetManFileNameHandler(Command
);
3068 if (ManFileName
!= NULL
) {
3069 return (ProcessManFile(ManFileName
, Command
, Sections
, NULL
, HelpText
));
3071 if ((StrLen(Command
)> 4)
3072 && (Command
[StrLen(Command
)-1] == L
'i' || Command
[StrLen(Command
)-1] == L
'I')
3073 && (Command
[StrLen(Command
)-2] == L
'f' || Command
[StrLen(Command
)-2] == L
'F')
3074 && (Command
[StrLen(Command
)-3] == L
'e' || Command
[StrLen(Command
)-3] == L
'E')
3075 && (Command
[StrLen(Command
)-4] == L
'.')
3077 FixCommand
= AllocateZeroPool(StrSize(Command
) - 4 * sizeof (CHAR16
));
3078 ASSERT(FixCommand
!= NULL
);
3080 StrnCpyS( FixCommand
,
3081 (StrSize(Command
) - 4 * sizeof (CHAR16
))/sizeof(CHAR16
),
3085 Status
= ProcessManFile(FixCommand
, FixCommand
, Sections
, NULL
, HelpText
);
3086 FreePool(FixCommand
);
3089 return (ProcessManFile(Command
, Command
, Sections
, NULL
, HelpText
));
3095 Gets the enable status of the page break output mode.
3097 User can use this function to determine current page break mode.
3099 @retval TRUE The page break output mode is enabled.
3100 @retval FALSE The page break output mode is disabled.
3104 EfiShellGetPageBreak(
3108 return(ShellInfoObject
.PageBreakEnabled
);
3112 Judges whether the active shell is the root shell.
3114 This function makes the user to know that whether the active Shell is the root shell.
3116 @retval TRUE The active Shell is the root Shell.
3117 @retval FALSE The active Shell is NOT the root Shell.
3121 EfiShellIsRootShell(
3125 return(ShellInfoObject
.RootShellInstance
);
3129 function to return a semi-colon delimeted list of all alias' in the current shell
3131 up to caller to free the memory.
3133 @retval NULL No alias' were found
3134 @retval NULL An error ocurred getting alias'
3135 @return !NULL a list of all alias'
3139 InternalEfiShellGetListAlias(
3145 CHAR16
*VariableName
;
3147 UINTN NameBufferSize
;
3151 NameBufferSize
= INIT_NAME_BUFFER_SIZE
;
3152 VariableName
= AllocateZeroPool(NameBufferSize
);
3156 if (VariableName
== NULL
) {
3160 VariableName
[0] = CHAR_NULL
;
3163 NameSize
= NameBufferSize
;
3164 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3165 if (Status
== EFI_NOT_FOUND
){
3167 } else if (Status
== EFI_BUFFER_TOO_SMALL
) {
3168 NameBufferSize
= NameSize
> NameBufferSize
* 2 ? NameSize
: NameBufferSize
* 2;
3169 SHELL_FREE_NON_NULL(VariableName
);
3170 VariableName
= AllocateZeroPool(NameBufferSize
);
3171 if (VariableName
== NULL
) {
3172 Status
= EFI_OUT_OF_RESOURCES
;
3173 SHELL_FREE_NON_NULL(RetVal
);
3178 NameSize
= NameBufferSize
;
3179 Status
= gRT
->GetNextVariableName(&NameSize
, VariableName
, &Guid
);
3182 if (EFI_ERROR (Status
)) {
3183 SHELL_FREE_NON_NULL(RetVal
);
3188 if (CompareGuid(&Guid
, &gShellAliasGuid
)){
3189 ASSERT((RetVal
== NULL
&& RetSize
== 0) || (RetVal
!= NULL
));
3190 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, VariableName
, 0);
3191 RetVal
= StrnCatGrow(&RetVal
, &RetSize
, L
";", 0);
3194 SHELL_FREE_NON_NULL(VariableName
);
3200 Convert a null-terminated unicode string, in-place, to all lowercase.
3203 @param Str The null-terminated string to be converted to all lowercase.
3205 @return The null-terminated string converted into all lowercase.
3214 for (Index
= 0; Str
[Index
] != L
'\0'; Index
++) {
3215 if (Str
[Index
] >= L
'A' && Str
[Index
] <= L
'Z') {
3216 Str
[Index
] -= (CHAR16
)(L
'A' - L
'a');
3223 This function returns the command associated with a alias or a list of all
3226 @param[in] Alias Points to the NULL-terminated shell alias.
3227 If this parameter is NULL, then all
3228 aliases will be returned in ReturnedData.
3229 @param[out] Volatile upon return of a single command if TRUE indicates
3230 this is stored in a volatile fashion. FALSE otherwise.
3232 @return If Alias is not NULL, it will return a pointer to
3233 the NULL-terminated command for that alias.
3234 If Alias is NULL, ReturnedData points to a ';'
3235 delimited list of alias (e.g.
3236 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
3237 @retval NULL an error ocurred
3238 @retval NULL Alias was not a valid Alias
3243 IN CONST CHAR16
*Alias
,
3244 OUT BOOLEAN
*Volatile OPTIONAL
3254 // Convert to lowercase to make aliases case-insensitive
3255 if (Alias
!= NULL
) {
3256 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3257 ASSERT (AliasLower
!= NULL
);
3258 ToLower (AliasLower
);
3260 if (Volatile
== NULL
) {
3261 GetVariable2 (AliasLower
, &gShellAliasGuid
, (VOID
**)&AliasVal
, NULL
);
3262 return (AddBufferToFreeList(AliasVal
));
3266 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3267 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3268 RetVal
= AllocateZeroPool(RetSize
);
3269 Status
= gRT
->GetVariable(AliasLower
, &gShellAliasGuid
, &Attribs
, &RetSize
, RetVal
);
3271 if (EFI_ERROR(Status
)) {
3272 if (RetVal
!= NULL
) {
3277 if ((EFI_VARIABLE_NON_VOLATILE
& Attribs
) == EFI_VARIABLE_NON_VOLATILE
) {
3283 FreePool (AliasLower
);
3284 return (AddBufferToFreeList(RetVal
));
3286 return (AddBufferToFreeList(InternalEfiShellGetListAlias()));
3290 Changes a shell command alias.
3292 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3294 this function does not check for built in alias'.
3296 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3297 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3298 Command refers to an alias, that alias will be deleted.
3299 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3300 Alias being set will be stored in a non-volatile fashion.
3302 @retval EFI_SUCCESS Alias created or deleted successfully.
3303 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3308 IN CONST CHAR16
*Command
,
3309 IN CONST CHAR16
*Alias
,
3316 // Convert to lowercase to make aliases case-insensitive
3317 if (Alias
!= NULL
) {
3318 AliasLower
= AllocateCopyPool (StrSize (Alias
), Alias
);
3319 ASSERT (AliasLower
!= NULL
);
3320 ToLower (AliasLower
);
3326 // We must be trying to remove one if Alias is NULL
3328 if (Alias
== NULL
) {
3330 // remove an alias (but passed in COMMAND parameter)
3332 Status
= (gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
));
3335 // Add and replace are the same
3338 // We dont check the error return on purpose since the variable may not exist.
3339 gRT
->SetVariable((CHAR16
*)Command
, &gShellAliasGuid
, 0, 0, NULL
);
3341 Status
= (gRT
->SetVariable((CHAR16
*)Alias
, &gShellAliasGuid
, EFI_VARIABLE_BOOTSERVICE_ACCESS
|(Volatile
?0:EFI_VARIABLE_NON_VOLATILE
), StrSize(Command
), (VOID
*)Command
));
3344 if (Alias
!= NULL
) {
3345 FreePool (AliasLower
);
3351 Changes a shell command alias.
3353 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
3356 @param[in] Command Points to the NULL-terminated shell command or existing alias.
3357 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
3358 Command refers to an alias, that alias will be deleted.
3359 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
3360 FALSE and the alias already exists, then the existing alias is unchanged and
3361 EFI_ACCESS_DENIED is returned.
3362 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
3363 Alias being set will be stored in a non-volatile fashion.
3365 @retval EFI_SUCCESS Alias created or deleted successfully.
3366 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
3367 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
3369 @retval EFI_INVALID_PARAMETER Command is null or the empty string.
3374 IN CONST CHAR16
*Command
,
3375 IN CONST CHAR16
*Alias
,
3380 if (ShellCommandIsOnAliasList(Alias
==NULL
?Command
:Alias
)) {
3382 // cant set over a built in alias
3384 return (EFI_ACCESS_DENIED
);
3385 } else if (Command
== NULL
|| *Command
== CHAR_NULL
|| StrLen(Command
) == 0) {
3387 // Command is null or empty
3389 return (EFI_INVALID_PARAMETER
);
3390 } else if (EfiShellGetAlias(Command
, NULL
) != NULL
&& !Replace
) {
3392 // Alias already exists, Replace not set
3394 return (EFI_ACCESS_DENIED
);
3396 return (InternalSetAlias(Command
, Alias
, Volatile
));
3400 // Pure FILE_HANDLE operations are passed to FileHandleLib
3401 // these functions are indicated by the *
3402 EFI_SHELL_PROTOCOL mShellProtocol
= {
3408 EfiShellGetHelpText
,
3409 EfiShellGetDevicePathFromMap
,
3410 EfiShellGetMapFromDevicePath
,
3411 EfiShellGetDevicePathFromFilePath
,
3412 EfiShellGetFilePathFromDevicePath
,
3416 EfiShellOpenFileList
,
3417 EfiShellFreeFileList
,
3418 EfiShellRemoveDupInFileList
,
3419 EfiShellBatchIsActive
,
3420 EfiShellIsRootShell
,
3421 EfiShellEnablePageBreak
,
3422 EfiShellDisablePageBreak
,
3423 EfiShellGetPageBreak
,
3424 EfiShellGetDeviceName
,
3425 (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
, //*
3426 (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
, //*
3427 EfiShellOpenFileByName
,
3430 (EFI_SHELL_READ_FILE
)FileHandleRead
, //*
3431 (EFI_SHELL_WRITE_FILE
)FileHandleWrite
, //*
3432 (EFI_SHELL_DELETE_FILE
)FileHandleDelete
, //*
3433 EfiShellDeleteFileByName
,
3434 (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
, //*
3435 (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
, //*
3436 (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
, //*
3438 EfiShellFindFilesInDir
,
3439 (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
, //*
3441 EfiShellOpenRootByHandle
,
3443 SHELL_MAJOR_VERSION
,
3444 SHELL_MINOR_VERSION
,
3446 // New for UEFI Shell 2.1
3447 EfiShellRegisterGuidName
,
3448 EfiShellGetGuidName
,
3449 EfiShellGetGuidFromName
,
3454 Function to create and install on the current handle.
3456 Will overwrite any existing ShellProtocols in the system to be sure that
3457 the current shell is in control.
3459 This must be removed via calling CleanUpShellProtocol().
3461 @param[in, out] NewShell The pointer to the pointer to the structure
3464 @retval EFI_SUCCESS The operation was successful.
3465 @return An error from LocateHandle, CreateEvent, or other core function.
3469 CreatePopulateInstallShellProtocol (
3470 IN OUT EFI_SHELL_PROTOCOL
**NewShell
3476 UINTN HandleCounter
;
3477 SHELL_PROTOCOL_HANDLE_LIST
*OldProtocolNode
;
3479 if (NewShell
== NULL
) {
3480 return (EFI_INVALID_PARAMETER
);
3485 OldProtocolNode
= NULL
;
3486 InitializeListHead(&ShellInfoObject
.OldShellList
.Link
);
3489 // Initialize EfiShellProtocol object...
3491 Status
= gBS
->CreateEvent(0,
3495 &mShellProtocol
.ExecutionBreak
);
3496 if (EFI_ERROR(Status
)) {
3501 // Get the size of the buffer we need.
3503 Status
= gBS
->LocateHandle(ByProtocol
,
3504 &gEfiShellProtocolGuid
,
3508 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3510 // Allocate and recall with buffer of correct size
3512 Buffer
= AllocateZeroPool(BufferSize
);
3513 if (Buffer
== NULL
) {
3514 return (EFI_OUT_OF_RESOURCES
);
3516 Status
= gBS
->LocateHandle(ByProtocol
,
3517 &gEfiShellProtocolGuid
,
3521 if (EFI_ERROR(Status
)) {
3526 // now overwrite each of them, but save the info to restore when we end.
3528 for (HandleCounter
= 0 ; HandleCounter
< (BufferSize
/sizeof(EFI_HANDLE
)) ; HandleCounter
++) {
3529 OldProtocolNode
= AllocateZeroPool(sizeof(SHELL_PROTOCOL_HANDLE_LIST
));
3530 ASSERT(OldProtocolNode
!= NULL
);
3531 Status
= gBS
->OpenProtocol(Buffer
[HandleCounter
],
3532 &gEfiShellProtocolGuid
,
3533 (VOID
**) &(OldProtocolNode
->Interface
),
3536 EFI_OPEN_PROTOCOL_GET_PROTOCOL
3538 if (!EFI_ERROR(Status
)) {
3540 // reinstall over the old one...
3542 OldProtocolNode
->Handle
= Buffer
[HandleCounter
];
3543 Status
= gBS
->ReinstallProtocolInterface(
3544 OldProtocolNode
->Handle
,
3545 &gEfiShellProtocolGuid
,
3546 OldProtocolNode
->Interface
,
3547 (VOID
*)(&mShellProtocol
));
3548 if (!EFI_ERROR(Status
)) {
3550 // we reinstalled sucessfully. log this so we can reverse it later.
3554 // add to the list for subsequent...
3556 InsertTailList(&ShellInfoObject
.OldShellList
.Link
, &OldProtocolNode
->Link
);
3561 } else if (Status
== EFI_NOT_FOUND
) {
3562 ASSERT(IsListEmpty(&ShellInfoObject
.OldShellList
.Link
));
3564 // no one else published yet. just publish it ourselves.
3566 Status
= gBS
->InstallProtocolInterface (
3568 &gEfiShellProtocolGuid
,
3569 EFI_NATIVE_INTERFACE
,
3570 (VOID
*)(&mShellProtocol
));
3573 if (PcdGetBool(PcdShellSupportOldProtocols
)){
3574 ///@todo support ShellEnvironment2
3575 ///@todo do we need to support ShellEnvironment (not ShellEnvironment2) also?
3578 if (!EFI_ERROR(Status
)) {
3579 *NewShell
= &mShellProtocol
;
3585 Opposite of CreatePopulateInstallShellProtocol.
3587 Free all memory and restore the system to the state it was in before calling
3588 CreatePopulateInstallShellProtocol.
3590 @param[in, out] NewShell The pointer to the new shell protocol structure.
3592 @retval EFI_SUCCESS The operation was successful.
3596 CleanUpShellProtocol (
3597 IN OUT EFI_SHELL_PROTOCOL
*NewShell
3601 SHELL_PROTOCOL_HANDLE_LIST
*Node2
;
3602 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3605 // if we need to restore old protocols...
3607 if (!IsListEmpty(&ShellInfoObject
.OldShellList
.Link
)) {
3608 for (Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3609 ; !IsListEmpty (&ShellInfoObject
.OldShellList
.Link
)
3610 ; Node2
= (SHELL_PROTOCOL_HANDLE_LIST
*)GetFirstNode(&ShellInfoObject
.OldShellList
.Link
)
3612 RemoveEntryList(&Node2
->Link
);
3613 Status
= gBS
->ReinstallProtocolInterface(Node2
->Handle
,
3614 &gEfiShellProtocolGuid
,
3621 // no need to restore
3623 Status
= gBS
->UninstallProtocolInterface(gImageHandle
,
3624 &gEfiShellProtocolGuid
,
3627 Status
= gBS
->CloseEvent(NewShell
->ExecutionBreak
);
3628 NewShell
->ExecutionBreak
= NULL
;
3630 Status
= gBS
->OpenProtocol(
3631 gST
->ConsoleInHandle
,
3632 &gEfiSimpleTextInputExProtocolGuid
,
3636 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3638 if (!EFI_ERROR (Status
)) {
3639 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle1
);
3640 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle2
);
3641 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle3
);
3642 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlCNotifyHandle4
);
3643 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle1
);
3644 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle2
);
3645 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle3
);
3646 Status
= SimpleEx
->UnregisterKeyNotify(SimpleEx
, ShellInfoObject
.CtrlSNotifyHandle4
);
3652 Notification function for keystrokes.
3654 @param[in] KeyData The key that was pressed.
3656 @retval EFI_SUCCESS The operation was successful.
3660 NotificationFunction(
3661 IN EFI_KEY_DATA
*KeyData
3664 if ( ((KeyData
->Key
.UnicodeChar
== L
'c') &&
3665 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))) ||
3666 (KeyData
->Key
.UnicodeChar
== 3)
3668 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3669 return (EFI_UNSUPPORTED
);
3671 return (gBS
->SignalEvent(ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
));
3672 } else if ((KeyData
->Key
.UnicodeChar
== L
's') &&
3673 (KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
) || KeyData
->KeyState
.KeyShiftState
== (EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
))
3675 ShellInfoObject
.HaltOutput
= TRUE
;
3677 return (EFI_SUCCESS
);
3681 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
3682 feature's enabled state was not known when the shell initially launched.
3684 @retval EFI_SUCCESS The feature is enabled.
3685 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
3689 InernalEfiShellStartMonitor(
3693 EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL
*SimpleEx
;
3694 EFI_KEY_DATA KeyData
;
3697 Status
= gBS
->OpenProtocol(
3698 gST
->ConsoleInHandle
,
3699 &gEfiSimpleTextInputExProtocolGuid
,
3703 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
3704 if (EFI_ERROR(Status
)) {
3709 STRING_TOKEN (STR_SHELL_NO_IN_EX
),
3710 ShellInfoObject
.HiiHandle
);
3711 return (EFI_SUCCESS
);
3714 if (ShellInfoObject
.NewEfiShellProtocol
->ExecutionBreak
== NULL
) {
3715 return (EFI_UNSUPPORTED
);
3718 KeyData
.KeyState
.KeyToggleState
= 0;
3719 KeyData
.Key
.ScanCode
= 0;
3720 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3721 KeyData
.Key
.UnicodeChar
= L
'c';
3723 Status
= SimpleEx
->RegisterKeyNotify(
3726 NotificationFunction
,
3727 &ShellInfoObject
.CtrlCNotifyHandle1
);
3729 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3730 if (!EFI_ERROR(Status
)) {
3731 Status
= SimpleEx
->RegisterKeyNotify(
3734 NotificationFunction
,
3735 &ShellInfoObject
.CtrlCNotifyHandle2
);
3737 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_LEFT_CONTROL_PRESSED
;
3738 KeyData
.Key
.UnicodeChar
= 3;
3739 if (!EFI_ERROR(Status
)) {
3740 Status
= SimpleEx
->RegisterKeyNotify(
3743 NotificationFunction
,
3744 &ShellInfoObject
.CtrlCNotifyHandle3
);
3746 KeyData
.KeyState
.KeyShiftState
= EFI_SHIFT_STATE_VALID
|EFI_RIGHT_CONTROL_PRESSED
;
3747 if (!EFI_ERROR(Status
)) {
3748 Status
= SimpleEx
->RegisterKeyNotify(
3751 NotificationFunction
,
3752 &ShellInfoObject
.CtrlCNotifyHandle4
);