2 Provides interface to shell functionality for shell commands and applications.
4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "UefiShellLib.h"
16 #include <ShellBase.h>
17 #include <Library/SortLib.h>
19 #define FIND_XXXXX_FILE_BUFFER_SIZE (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)
24 SHELL_PARAM_ITEM EmptyParamList
[] = {
27 SHELL_PARAM_ITEM SfoParamList
[] = {
31 EFI_SHELL_ENVIRONMENT2
*mEfiShellEnvironment2
;
32 EFI_SHELL_INTERFACE
*mEfiShellInterface
;
33 EFI_SHELL_PROTOCOL
*gEfiShellProtocol
;
34 EFI_SHELL_PARAMETERS_PROTOCOL
*gEfiShellParametersProtocol
;
35 EFI_HANDLE mEfiShellEnvironment2Handle
;
36 FILE_HANDLE_FUNCTION_MAP FileFunctionMap
;
39 Check if a Unicode character is a hexadecimal character.
41 This internal function checks if a Unicode character is a
42 numeric character. The valid hexadecimal characters are
43 L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
45 @param Char The character to check against.
47 @retval TRUE If the Char is a hexadecmial character.
48 @retval FALSE If the Char is not a hexadecmial character.
53 ShellIsHexaDecimalDigitCharacter (
57 return (BOOLEAN
) ((Char
>= L
'0' && Char
<= L
'9') || (Char
>= L
'A' && Char
<= L
'F') || (Char
>= L
'a' && Char
<= L
'f'));
61 Check if a Unicode character is a decimal character.
63 This internal function checks if a Unicode character is a
64 decimal character. The valid characters are
68 @param Char The character to check against.
70 @retval TRUE If the Char is a hexadecmial character.
71 @retval FALSE If the Char is not a hexadecmial character.
76 ShellIsDecimalDigitCharacter (
80 return (BOOLEAN
) (Char
>= L
'0' && Char
<= L
'9');
84 Helper function to find ShellEnvironment2 for constructor.
86 @param[in] ImageHandle A copy of the calling image's handle.
88 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
93 IN EFI_HANDLE ImageHandle
103 Status
= gBS
->OpenProtocol(ImageHandle
,
104 &gEfiShellEnvironment2Guid
,
105 (VOID
**)&mEfiShellEnvironment2
,
108 EFI_OPEN_PROTOCOL_GET_PROTOCOL
111 // look for the mEfiShellEnvironment2 protocol at a higher level
113 if (EFI_ERROR (Status
) || !(CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
))){
115 // figure out how big of a buffer we need.
117 Status
= gBS
->LocateHandle (ByProtocol
,
118 &gEfiShellEnvironment2Guid
,
119 NULL
, // ignored for ByProtocol
124 // maybe it's not there???
126 if (Status
== EFI_BUFFER_TOO_SMALL
) {
127 Buffer
= (EFI_HANDLE
*)AllocateZeroPool(BufferSize
);
128 if (Buffer
== NULL
) {
129 return (EFI_OUT_OF_RESOURCES
);
131 Status
= gBS
->LocateHandle (ByProtocol
,
132 &gEfiShellEnvironment2Guid
,
133 NULL
, // ignored for ByProtocol
138 if (!EFI_ERROR (Status
) && Buffer
!= NULL
) {
140 // now parse the list of returned handles
142 Status
= EFI_NOT_FOUND
;
143 for (HandleIndex
= 0; HandleIndex
< (BufferSize
/sizeof(Buffer
[0])); HandleIndex
++) {
144 Status
= gBS
->OpenProtocol(Buffer
[HandleIndex
],
145 &gEfiShellEnvironment2Guid
,
146 (VOID
**)&mEfiShellEnvironment2
,
149 EFI_OPEN_PROTOCOL_GET_PROTOCOL
151 if (CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
)) {
152 mEfiShellEnvironment2Handle
= Buffer
[HandleIndex
];
153 Status
= EFI_SUCCESS
;
159 if (Buffer
!= NULL
) {
166 Function to do most of the work of the constructor. Allows for calling
167 multiple times without complete re-initialization.
169 @param[in] ImageHandle A copy of the ImageHandle.
170 @param[in] SystemTable A pointer to the SystemTable for the application.
172 @retval EFI_SUCCESS The operationw as successful.
176 ShellLibConstructorWorker (
177 IN EFI_HANDLE ImageHandle
,
178 IN EFI_SYSTEM_TABLE
*SystemTable
184 // UEFI 2.0 shell interfaces (used preferentially)
186 Status
= gBS
->OpenProtocol(
188 &gEfiShellProtocolGuid
,
189 (VOID
**)&gEfiShellProtocol
,
192 EFI_OPEN_PROTOCOL_GET_PROTOCOL
194 if (EFI_ERROR(Status
)) {
196 // Search for the shell protocol
198 Status
= gBS
->LocateProtocol(
199 &gEfiShellProtocolGuid
,
201 (VOID
**)&gEfiShellProtocol
203 if (EFI_ERROR(Status
)) {
204 gEfiShellProtocol
= NULL
;
207 Status
= gBS
->OpenProtocol(
209 &gEfiShellParametersProtocolGuid
,
210 (VOID
**)&gEfiShellParametersProtocol
,
213 EFI_OPEN_PROTOCOL_GET_PROTOCOL
215 if (EFI_ERROR(Status
)) {
216 gEfiShellParametersProtocol
= NULL
;
219 if (gEfiShellParametersProtocol
== NULL
|| gEfiShellProtocol
== NULL
) {
221 // Moved to seperate function due to complexity
223 Status
= ShellFindSE2(ImageHandle
);
225 if (EFI_ERROR(Status
)) {
226 DEBUG((DEBUG_ERROR
, "Status: 0x%08x\r\n", Status
));
227 mEfiShellEnvironment2
= NULL
;
229 Status
= gBS
->OpenProtocol(ImageHandle
,
230 &gEfiShellInterfaceGuid
,
231 (VOID
**)&mEfiShellInterface
,
234 EFI_OPEN_PROTOCOL_GET_PROTOCOL
236 if (EFI_ERROR(Status
)) {
237 mEfiShellInterface
= NULL
;
242 // only success getting 2 of either the old or new, but no 1/2 and 1/2
244 if ((mEfiShellEnvironment2
!= NULL
&& mEfiShellInterface
!= NULL
) ||
245 (gEfiShellProtocol
!= NULL
&& gEfiShellParametersProtocol
!= NULL
) ) {
246 if (gEfiShellProtocol
!= NULL
) {
247 FileFunctionMap
.GetFileInfo
= gEfiShellProtocol
->GetFileInfo
;
248 FileFunctionMap
.SetFileInfo
= gEfiShellProtocol
->SetFileInfo
;
249 FileFunctionMap
.ReadFile
= gEfiShellProtocol
->ReadFile
;
250 FileFunctionMap
.WriteFile
= gEfiShellProtocol
->WriteFile
;
251 FileFunctionMap
.CloseFile
= gEfiShellProtocol
->CloseFile
;
252 FileFunctionMap
.DeleteFile
= gEfiShellProtocol
->DeleteFile
;
253 FileFunctionMap
.GetFilePosition
= gEfiShellProtocol
->GetFilePosition
;
254 FileFunctionMap
.SetFilePosition
= gEfiShellProtocol
->SetFilePosition
;
255 FileFunctionMap
.FlushFile
= gEfiShellProtocol
->FlushFile
;
256 FileFunctionMap
.GetFileSize
= gEfiShellProtocol
->GetFileSize
;
258 FileFunctionMap
.GetFileInfo
= (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
;
259 FileFunctionMap
.SetFileInfo
= (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
;
260 FileFunctionMap
.ReadFile
= (EFI_SHELL_READ_FILE
)FileHandleRead
;
261 FileFunctionMap
.WriteFile
= (EFI_SHELL_WRITE_FILE
)FileHandleWrite
;
262 FileFunctionMap
.CloseFile
= (EFI_SHELL_CLOSE_FILE
)FileHandleClose
;
263 FileFunctionMap
.DeleteFile
= (EFI_SHELL_DELETE_FILE
)FileHandleDelete
;
264 FileFunctionMap
.GetFilePosition
= (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
;
265 FileFunctionMap
.SetFilePosition
= (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
;
266 FileFunctionMap
.FlushFile
= (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
;
267 FileFunctionMap
.GetFileSize
= (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
;
269 return (EFI_SUCCESS
);
271 return (EFI_NOT_FOUND
);
274 Constructor for the Shell library.
276 Initialize the library and determine if the underlying is a UEFI Shell 2.0 or an EFI shell.
278 @param ImageHandle the image handle of the process
279 @param SystemTable the EFI System Table pointer
281 @retval EFI_SUCCESS the initialization was complete sucessfully
282 @return others an error ocurred during initialization
286 ShellLibConstructor (
287 IN EFI_HANDLE ImageHandle
,
288 IN EFI_SYSTEM_TABLE
*SystemTable
291 mEfiShellEnvironment2
= NULL
;
292 gEfiShellProtocol
= NULL
;
293 gEfiShellParametersProtocol
= NULL
;
294 mEfiShellInterface
= NULL
;
295 mEfiShellEnvironment2Handle
= NULL
;
298 // verify that auto initialize is not set false
300 if (PcdGetBool(PcdShellLibAutoInitialize
) == 0) {
301 return (EFI_SUCCESS
);
304 return (ShellLibConstructorWorker(ImageHandle
, SystemTable
));
308 Destructor for the library. free any resources.
310 @param[in] ImageHandle A copy of the ImageHandle.
311 @param[in] SystemTable A pointer to the SystemTable for the application.
313 @retval EFI_SUCCESS The operation was successful.
314 @return An error from the CloseProtocol function.
319 IN EFI_HANDLE ImageHandle
,
320 IN EFI_SYSTEM_TABLE
*SystemTable
323 if (mEfiShellEnvironment2
!= NULL
) {
324 gBS
->CloseProtocol(mEfiShellEnvironment2Handle
==NULL
?ImageHandle
:mEfiShellEnvironment2Handle
,
325 &gEfiShellEnvironment2Guid
,
328 mEfiShellEnvironment2
= NULL
;
330 if (mEfiShellInterface
!= NULL
) {
331 gBS
->CloseProtocol(ImageHandle
,
332 &gEfiShellInterfaceGuid
,
335 mEfiShellInterface
= NULL
;
337 if (gEfiShellProtocol
!= NULL
) {
338 gBS
->CloseProtocol(ImageHandle
,
339 &gEfiShellProtocolGuid
,
342 gEfiShellProtocol
= NULL
;
344 if (gEfiShellParametersProtocol
!= NULL
) {
345 gBS
->CloseProtocol(ImageHandle
,
346 &gEfiShellParametersProtocolGuid
,
349 gEfiShellParametersProtocol
= NULL
;
351 mEfiShellEnvironment2Handle
= NULL
;
353 return (EFI_SUCCESS
);
357 This function causes the shell library to initialize itself. If the shell library
358 is already initialized it will de-initialize all the current protocol poitners and
359 re-populate them again.
361 When the library is used with PcdShellLibAutoInitialize set to true this function
362 will return EFI_SUCCESS and perform no actions.
364 This function is intended for internal access for shell commands only.
366 @retval EFI_SUCCESS the initialization was complete sucessfully
375 // if auto initialize is not false then skip
377 if (PcdGetBool(PcdShellLibAutoInitialize
) != 0) {
378 return (EFI_SUCCESS
);
382 // deinit the current stuff
384 ASSERT_EFI_ERROR(ShellLibDestructor(gImageHandle
, gST
));
387 // init the new stuff
389 return (ShellLibConstructorWorker(gImageHandle
, gST
));
393 This function will retrieve the information about the file for the handle
394 specified and store it in allocated pool memory.
396 This function allocates a buffer to store the file's information. It is the
397 caller's responsibility to free the buffer
399 @param FileHandle The file handle of the file for which information is
402 @retval NULL information could not be retrieved.
404 @return the information about the file
409 IN SHELL_FILE_HANDLE FileHandle
412 return (FileFunctionMap
.GetFileInfo(FileHandle
));
416 This function sets the information about the file for the opened handle
419 @param[in] FileHandle The file handle of the file for which information
422 @param[in] FileInfo The information to set.
424 @retval EFI_SUCCESS The information was set.
425 @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.
426 @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.
427 @retval EFI_NO_MEDIA The device has no medium.
428 @retval EFI_DEVICE_ERROR The device reported an error.
429 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
430 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
431 @retval EFI_ACCESS_DENIED The file was opened read only.
432 @retval EFI_VOLUME_FULL The volume is full.
437 IN SHELL_FILE_HANDLE FileHandle
,
438 IN EFI_FILE_INFO
*FileInfo
441 return (FileFunctionMap
.SetFileInfo(FileHandle
, FileInfo
));
445 This function will open a file or directory referenced by DevicePath.
447 This function opens a file with the open mode according to the file path. The
448 Attributes is valid only for EFI_FILE_MODE_CREATE.
450 @param FilePath on input the device path to the file. On output
451 the remaining device path.
452 @param DeviceHandle pointer to the system device handle.
453 @param FileHandle pointer to the file handle.
454 @param OpenMode the mode to open the file with.
455 @param Attributes the file's file attributes.
457 @retval EFI_SUCCESS The information was set.
458 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
459 @retval EFI_UNSUPPORTED Could not open the file path.
460 @retval EFI_NOT_FOUND The specified file could not be found on the
461 device or the file system could not be found on
463 @retval EFI_NO_MEDIA The device has no medium.
464 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
465 medium is no longer supported.
466 @retval EFI_DEVICE_ERROR The device reported an error.
467 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
468 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
469 @retval EFI_ACCESS_DENIED The file was opened read only.
470 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
472 @retval EFI_VOLUME_FULL The volume is full.
476 ShellOpenFileByDevicePath(
477 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
,
478 OUT EFI_HANDLE
*DeviceHandle
,
479 OUT SHELL_FILE_HANDLE
*FileHandle
,
486 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*EfiSimpleFileSystemProtocol
;
487 EFI_FILE_PROTOCOL
*Handle1
;
488 EFI_FILE_PROTOCOL
*Handle2
;
490 if (FilePath
== NULL
|| FileHandle
== NULL
|| DeviceHandle
== NULL
) {
491 return (EFI_INVALID_PARAMETER
);
495 // which shell interface should we use
497 if (gEfiShellProtocol
!= NULL
) {
499 // use UEFI Shell 2.0 method.
501 FileName
= gEfiShellProtocol
->GetFilePathFromDevicePath(*FilePath
);
502 if (FileName
== NULL
) {
503 return (EFI_INVALID_PARAMETER
);
505 Status
= ShellOpenFileByName(FileName
, FileHandle
, OpenMode
, Attributes
);
512 // use old shell method.
514 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
,
517 if (EFI_ERROR (Status
)) {
520 Status
= gBS
->OpenProtocol(*DeviceHandle
,
521 &gEfiSimpleFileSystemProtocolGuid
,
522 (VOID
**)&EfiSimpleFileSystemProtocol
,
525 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
526 if (EFI_ERROR (Status
)) {
529 Status
= EfiSimpleFileSystemProtocol
->OpenVolume(EfiSimpleFileSystemProtocol
, &Handle1
);
530 if (EFI_ERROR (Status
)) {
536 // go down directories one node at a time.
538 while (!IsDevicePathEnd (*FilePath
)) {
540 // For file system access each node should be a file path component
542 if (DevicePathType (*FilePath
) != MEDIA_DEVICE_PATH
||
543 DevicePathSubType (*FilePath
) != MEDIA_FILEPATH_DP
546 return (EFI_INVALID_PARAMETER
);
549 // Open this file path node
555 // Try to test opening an existing file
557 Status
= Handle2
->Open (
560 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
561 OpenMode
&~EFI_FILE_MODE_CREATE
,
566 // see if the error was that it needs to be created
568 if ((EFI_ERROR (Status
)) && (OpenMode
!= (OpenMode
&~EFI_FILE_MODE_CREATE
))) {
569 Status
= Handle2
->Open (
572 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
578 // Close the last node
580 Handle2
->Close (Handle2
);
582 if (EFI_ERROR(Status
)) {
589 *FilePath
= NextDevicePathNode (*FilePath
);
593 // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!
595 *FileHandle
= (VOID
*)Handle1
;
596 return (EFI_SUCCESS
);
600 This function will open a file or directory referenced by filename.
602 If return is EFI_SUCCESS, the Filehandle is the opened file's handle;
603 otherwise, the Filehandle is NULL. The Attributes is valid only for
604 EFI_FILE_MODE_CREATE.
606 if FileName is NULL then ASSERT()
608 @param FileName pointer to file name
609 @param FileHandle pointer to the file handle.
610 @param OpenMode the mode to open the file with.
611 @param Attributes the file's file attributes.
613 @retval EFI_SUCCESS The information was set.
614 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
615 @retval EFI_UNSUPPORTED Could not open the file path.
616 @retval EFI_NOT_FOUND The specified file could not be found on the
617 device or the file system could not be found
619 @retval EFI_NO_MEDIA The device has no medium.
620 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
621 medium is no longer supported.
622 @retval EFI_DEVICE_ERROR The device reported an error.
623 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
624 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
625 @retval EFI_ACCESS_DENIED The file was opened read only.
626 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
628 @retval EFI_VOLUME_FULL The volume is full.
633 IN CONST CHAR16
*FileName
,
634 OUT SHELL_FILE_HANDLE
*FileHandle
,
639 EFI_HANDLE DeviceHandle
;
640 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
642 EFI_FILE_INFO
*FileInfo
;
645 // ASSERT if FileName is NULL
647 ASSERT(FileName
!= NULL
);
649 if (FileName
== NULL
) {
650 return (EFI_INVALID_PARAMETER
);
653 if (gEfiShellProtocol
!= NULL
) {
654 if ((OpenMode
& EFI_FILE_MODE_CREATE
) == EFI_FILE_MODE_CREATE
&& (Attributes
& EFI_FILE_DIRECTORY
) == EFI_FILE_DIRECTORY
) {
655 return ShellCreateDirectory(FileName
, FileHandle
);
658 // Use UEFI Shell 2.0 method
660 Status
= gEfiShellProtocol
->OpenFileByName(FileName
,
663 if (StrCmp(FileName
, L
"NUL") != 0 && !EFI_ERROR(Status
) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)){
664 FileInfo
= FileFunctionMap
.GetFileInfo(*FileHandle
);
665 ASSERT(FileInfo
!= NULL
);
666 FileInfo
->Attribute
= Attributes
;
667 Status
= FileFunctionMap
.SetFileInfo(*FileHandle
, FileInfo
);
673 // Using EFI Shell version
674 // this means convert name to path and call that function
675 // since this will use EFI method again that will open it.
677 ASSERT(mEfiShellEnvironment2
!= NULL
);
678 FilePath
= mEfiShellEnvironment2
->NameToPath ((CHAR16
*)FileName
);
679 if (FilePath
!= NULL
) {
680 return (ShellOpenFileByDevicePath(&FilePath
,
686 return (EFI_DEVICE_ERROR
);
689 This function create a directory
691 If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;
692 otherwise, the Filehandle is NULL. If the directory already existed, this
693 function opens the existing directory.
695 @param DirectoryName pointer to directory name
696 @param FileHandle pointer to the file handle.
698 @retval EFI_SUCCESS The information was set.
699 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
700 @retval EFI_UNSUPPORTED Could not open the file path.
701 @retval EFI_NOT_FOUND The specified file could not be found on the
702 device or the file system could not be found
704 @retval EFI_NO_MEDIA The device has no medium.
705 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
706 medium is no longer supported.
707 @retval EFI_DEVICE_ERROR The device reported an error.
708 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
709 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
710 @retval EFI_ACCESS_DENIED The file was opened read only.
711 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
713 @retval EFI_VOLUME_FULL The volume is full.
714 @sa ShellOpenFileByName
718 ShellCreateDirectory(
719 IN CONST CHAR16
*DirectoryName
,
720 OUT SHELL_FILE_HANDLE
*FileHandle
723 if (gEfiShellProtocol
!= NULL
) {
725 // Use UEFI Shell 2.0 method
727 return (gEfiShellProtocol
->CreateFile(DirectoryName
,
732 return (ShellOpenFileByName(DirectoryName
,
734 EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
,
741 This function reads information from an opened file.
743 If FileHandle is not a directory, the function reads the requested number of
744 bytes from the file at the file's current position and returns them in Buffer.
745 If the read goes beyond the end of the file, the read length is truncated to the
746 end of the file. The file's current position is increased by the number of bytes
747 returned. If FileHandle is a directory, the function reads the directory entry
748 at the file's current position and returns the entry in Buffer. If the Buffer
749 is not large enough to hold the current directory entry, then
750 EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
751 BufferSize is set to be the size of the buffer needed to read the entry. On
752 success, the current position is updated to the next directory entry. If there
753 are no more directory entries, the read returns a zero-length buffer.
754 EFI_FILE_INFO is the structure returned as the directory entry.
756 @param FileHandle the opened file handle
757 @param BufferSize on input the size of buffer in bytes. on return
758 the number of bytes written.
759 @param Buffer the buffer to put read data into.
761 @retval EFI_SUCCESS Data was read.
762 @retval EFI_NO_MEDIA The device has no media.
763 @retval EFI_DEVICE_ERROR The device reported an error.
764 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
765 @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
772 IN SHELL_FILE_HANDLE FileHandle
,
773 IN OUT UINTN
*BufferSize
,
777 return (FileFunctionMap
.ReadFile(FileHandle
, BufferSize
, Buffer
));
782 Write data to a file.
784 This function writes the specified number of bytes to the file at the current
785 file position. The current file position is advanced the actual number of bytes
786 written, which is returned in BufferSize. Partial writes only occur when there
787 has been a data error during the write attempt (such as "volume space full").
788 The file is automatically grown to hold the data if required. Direct writes to
789 opened directories are not supported.
791 @param FileHandle The opened file for writing
792 @param BufferSize on input the number of bytes in Buffer. On output
793 the number of bytes written.
794 @param Buffer the buffer containing data to write is stored.
796 @retval EFI_SUCCESS Data was written.
797 @retval EFI_UNSUPPORTED Writes to an open directory are not supported.
798 @retval EFI_NO_MEDIA The device has no media.
799 @retval EFI_DEVICE_ERROR The device reported an error.
800 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
801 @retval EFI_WRITE_PROTECTED The device is write-protected.
802 @retval EFI_ACCESS_DENIED The file was open for read only.
803 @retval EFI_VOLUME_FULL The volume is full.
808 IN SHELL_FILE_HANDLE FileHandle
,
809 IN OUT UINTN
*BufferSize
,
813 return (FileFunctionMap
.WriteFile(FileHandle
, BufferSize
, Buffer
));
817 Close an open file handle.
819 This function closes a specified file handle. All "dirty" cached file data is
820 flushed to the device, and the file is closed. In all cases the handle is
823 @param FileHandle the file handle to close.
825 @retval EFI_SUCCESS the file handle was closed sucessfully.
830 IN SHELL_FILE_HANDLE
*FileHandle
833 return (FileFunctionMap
.CloseFile(*FileHandle
));
837 Delete a file and close the handle
839 This function closes and deletes a file. In all cases the file handle is closed.
840 If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
841 returned, but the handle is still closed.
843 @param FileHandle the file handle to delete
845 @retval EFI_SUCCESS the file was closed sucessfully
846 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
848 @retval INVALID_PARAMETER One of the parameters has an invalid value.
853 IN SHELL_FILE_HANDLE
*FileHandle
856 return (FileFunctionMap
.DeleteFile(*FileHandle
));
860 Set the current position in a file.
862 This function sets the current file position for the handle to the position
863 supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only
864 absolute positioning is supported, and seeking past the end of the file is
865 allowed (a subsequent write would grow the file). Seeking to position
866 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
867 If FileHandle is a directory, the only position that may be set is zero. This
868 has the effect of starting the read process of the directory entries over.
870 @param FileHandle The file handle on which the position is being set
871 @param Position Byte position from begining of file
873 @retval EFI_SUCCESS Operation completed sucessfully.
874 @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on
876 @retval INVALID_PARAMETER One of the parameters has an invalid value.
880 ShellSetFilePosition (
881 IN SHELL_FILE_HANDLE FileHandle
,
885 return (FileFunctionMap
.SetFilePosition(FileHandle
, Position
));
889 Gets a file's current position
891 This function retrieves the current file position for the file handle. For
892 directories, the current file position has no meaning outside of the file
893 system driver and as such the operation is not supported. An error is returned
894 if FileHandle is a directory.
896 @param FileHandle The open file handle on which to get the position.
897 @param Position Byte position from begining of file.
899 @retval EFI_SUCCESS the operation completed sucessfully.
900 @retval INVALID_PARAMETER One of the parameters has an invalid value.
901 @retval EFI_UNSUPPORTED the request is not valid on directories.
905 ShellGetFilePosition (
906 IN SHELL_FILE_HANDLE FileHandle
,
910 return (FileFunctionMap
.GetFilePosition(FileHandle
, Position
));
913 Flushes data on a file
915 This function flushes all modified data associated with a file to a device.
917 @param FileHandle The file handle on which to flush data
919 @retval EFI_SUCCESS The data was flushed.
920 @retval EFI_NO_MEDIA The device has no media.
921 @retval EFI_DEVICE_ERROR The device reported an error.
922 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
923 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
924 @retval EFI_ACCESS_DENIED The file was opened for read only.
929 IN SHELL_FILE_HANDLE FileHandle
932 return (FileFunctionMap
.FlushFile(FileHandle
));
936 Retrieves the first file from a directory
938 This function opens a directory and gets the first file's info in the
939 directory. Caller can use ShellFindNextFile() to get other files. When
940 complete the caller is responsible for calling FreePool() on Buffer.
942 @param DirHandle The file handle of the directory to search
943 @param Buffer Pointer to buffer for file's information
945 @retval EFI_SUCCESS Found the first file.
946 @retval EFI_NOT_FOUND Cannot find the directory.
947 @retval EFI_NO_MEDIA The device has no media.
948 @retval EFI_DEVICE_ERROR The device reported an error.
949 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
950 @return Others status of ShellGetFileInfo, ShellSetFilePosition,
956 IN SHELL_FILE_HANDLE DirHandle
,
957 OUT EFI_FILE_INFO
**Buffer
961 // pass to file handle lib
963 return (FileHandleFindFirstFile(DirHandle
, Buffer
));
966 Retrieves the next file in a directory.
968 To use this function, caller must call the ShellFindFirstFile() to get the
969 first file, and then use this function get other files. This function can be
970 called for several times to get each file's information in the directory. If
971 the call of ShellFindNextFile() got the last file in the directory, the next
972 call of this function has no file to get. *NoFile will be set to TRUE and the
973 Buffer memory will be automatically freed.
975 @param DirHandle the file handle of the directory
976 @param Buffer pointer to buffer for file's information
977 @param NoFile pointer to boolean when last file is found
979 @retval EFI_SUCCESS Found the next file, or reached last file
980 @retval EFI_NO_MEDIA The device has no media.
981 @retval EFI_DEVICE_ERROR The device reported an error.
982 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
987 IN SHELL_FILE_HANDLE DirHandle
,
988 OUT EFI_FILE_INFO
*Buffer
,
993 // pass to file handle lib
995 return (FileHandleFindNextFile(DirHandle
, Buffer
, NoFile
));
998 Retrieve the size of a file.
1000 if FileHandle is NULL then ASSERT()
1001 if Size is NULL then ASSERT()
1003 This function extracts the file size info from the FileHandle's EFI_FILE_INFO
1006 @param FileHandle file handle from which size is retrieved
1007 @param Size pointer to size
1009 @retval EFI_SUCCESS operation was completed sucessfully
1010 @retval EFI_DEVICE_ERROR cannot access the file
1015 IN SHELL_FILE_HANDLE FileHandle
,
1019 return (FileFunctionMap
.GetFileSize(FileHandle
, Size
));
1022 Retrieves the status of the break execution flag
1024 this function is useful to check whether the application is being asked to halt by the shell.
1026 @retval TRUE the execution break is enabled
1027 @retval FALSE the execution break is not enabled
1031 ShellGetExecutionBreakFlag(
1036 // Check for UEFI Shell 2.0 protocols
1038 if (gEfiShellProtocol
!= NULL
) {
1041 // We are using UEFI Shell 2.0; see if the event has been triggered
1043 if (gBS
->CheckEvent(gEfiShellProtocol
->ExecutionBreak
) != EFI_SUCCESS
) {
1050 // using EFI Shell; call the function to check
1052 if (mEfiShellEnvironment2
!= NULL
) {
1053 return (mEfiShellEnvironment2
->GetExecutionBreak());
1059 return the value of an environment variable
1061 this function gets the value of the environment variable set by the
1062 ShellSetEnvironmentVariable function
1064 @param EnvKey The key name of the environment variable.
1066 @retval NULL the named environment variable does not exist.
1067 @return != NULL pointer to the value of the environment variable
1071 ShellGetEnvironmentVariable (
1072 IN CONST CHAR16
*EnvKey
1076 // Check for UEFI Shell 2.0 protocols
1078 if (gEfiShellProtocol
!= NULL
) {
1079 return (gEfiShellProtocol
->GetEnv(EnvKey
));
1083 // Check for EFI shell
1085 if (mEfiShellEnvironment2
!= NULL
) {
1086 return (mEfiShellEnvironment2
->GetEnv((CHAR16
*)EnvKey
));
1092 set the value of an environment variable
1094 This function changes the current value of the specified environment variable. If the
1095 environment variable exists and the Value is an empty string, then the environment
1096 variable is deleted. If the environment variable exists and the Value is not an empty
1097 string, then the value of the environment variable is changed. If the environment
1098 variable does not exist and the Value is an empty string, there is no action. If the
1099 environment variable does not exist and the Value is a non-empty string, then the
1100 environment variable is created and assigned the specified value.
1102 This is not supported pre-UEFI Shell 2.0.
1104 @param EnvKey The key name of the environment variable.
1105 @param EnvVal The Value of the environment variable
1106 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
1108 @retval EFI_SUCCESS the operation was completed sucessfully
1109 @retval EFI_UNSUPPORTED This operation is not allowed in pre UEFI 2.0 Shell environments
1113 ShellSetEnvironmentVariable (
1114 IN CONST CHAR16
*EnvKey
,
1115 IN CONST CHAR16
*EnvVal
,
1120 // Check for UEFI Shell 2.0 protocols
1122 if (gEfiShellProtocol
!= NULL
) {
1123 return (gEfiShellProtocol
->SetEnv(EnvKey
, EnvVal
, Volatile
));
1127 // This feature does not exist under EFI shell
1129 return (EFI_UNSUPPORTED
);
1133 Cause the shell to parse and execute a command line.
1135 This function creates a nested instance of the shell and executes the specified
1136 command (CommandLine) with the specified environment (Environment). Upon return,
1137 the status code returned by the specified command is placed in StatusCode.
1138 If Environment is NULL, then the current environment is used and all changes made
1139 by the commands executed will be reflected in the current environment. If the
1140 Environment is non-NULL, then the changes made will be discarded.
1141 The CommandLine is executed from the current working directory on the current
1144 The EnvironmentVariables and Status parameters are ignored in a pre-UEFI Shell 2.0
1145 environment. The values pointed to by the parameters will be unchanged by the
1146 ShellExecute() function. The Output parameter has no effect in a
1147 UEFI Shell 2.0 environment.
1149 @param[in] ParentHandle The parent image starting the operation.
1150 @param[in] CommandLine The pointer to a NULL terminated command line.
1151 @param[in] Output True to display debug output. False to hide it.
1152 @param[in] EnvironmentVariables Optional pointer to array of environment variables
1153 in the form "x=y". If NULL, the current set is used.
1154 @param[out] Status The status of the run command line.
1156 @retval EFI_SUCCESS The operation completed sucessfully. Status
1157 contains the status code returned.
1158 @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.
1159 @retval EFI_OUT_OF_RESOURCES Out of resources.
1160 @retval EFI_UNSUPPORTED The operation is not allowed.
1165 IN EFI_HANDLE
*ParentHandle
,
1166 IN CHAR16
*CommandLine OPTIONAL
,
1167 IN BOOLEAN Output OPTIONAL
,
1168 IN CHAR16
**EnvironmentVariables OPTIONAL
,
1169 OUT EFI_STATUS
*Status OPTIONAL
1173 // Check for UEFI Shell 2.0 protocols
1175 if (gEfiShellProtocol
!= NULL
) {
1177 // Call UEFI Shell 2.0 version (not using Output parameter)
1179 return (gEfiShellProtocol
->Execute(ParentHandle
,
1181 EnvironmentVariables
,
1186 // Check for EFI shell
1188 if (mEfiShellEnvironment2
!= NULL
) {
1190 // Call EFI Shell version (not using EnvironmentVariables or Status parameters)
1191 // Due to oddity in the EFI shell we want to dereference the ParentHandle here
1193 return (mEfiShellEnvironment2
->Execute(*ParentHandle
,
1198 return (EFI_UNSUPPORTED
);
1201 Retreives the current directory path
1203 If the DeviceName is NULL, it returns the current device's current directory
1204 name. If the DeviceName is not NULL, it returns the current directory name
1207 @param DeviceName the name of the drive to get directory on
1209 @retval NULL the directory does not exist
1210 @return != NULL the directory
1214 ShellGetCurrentDir (
1215 IN CHAR16
* CONST DeviceName OPTIONAL
1219 // Check for UEFI Shell 2.0 protocols
1221 if (gEfiShellProtocol
!= NULL
) {
1222 return (gEfiShellProtocol
->GetCurDir(DeviceName
));
1226 // Check for EFI shell
1228 if (mEfiShellEnvironment2
!= NULL
) {
1229 return (mEfiShellEnvironment2
->CurDir(DeviceName
));
1235 sets (enabled or disabled) the page break mode
1237 when page break mode is enabled the screen will stop scrolling
1238 and wait for operator input before scrolling a subsequent screen.
1240 @param CurrentState TRUE to enable and FALSE to disable
1244 ShellSetPageBreakMode (
1245 IN BOOLEAN CurrentState
1249 // check for enabling
1251 if (CurrentState
!= 0x00) {
1253 // check for UEFI Shell 2.0
1255 if (gEfiShellProtocol
!= NULL
) {
1257 // Enable with UEFI 2.0 Shell
1259 gEfiShellProtocol
->EnablePageBreak();
1263 // Check for EFI shell
1265 if (mEfiShellEnvironment2
!= NULL
) {
1267 // Enable with EFI Shell
1269 mEfiShellEnvironment2
->EnablePageBreak (DEFAULT_INIT_ROW
, DEFAULT_AUTO_LF
);
1275 // check for UEFI Shell 2.0
1277 if (gEfiShellProtocol
!= NULL
) {
1279 // Disable with UEFI 2.0 Shell
1281 gEfiShellProtocol
->DisablePageBreak();
1285 // Check for EFI shell
1287 if (mEfiShellEnvironment2
!= NULL
) {
1289 // Disable with EFI Shell
1291 mEfiShellEnvironment2
->DisablePageBreak ();
1299 /// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.
1300 /// This allows for the struct to be populated.
1307 SHELL_FILE_HANDLE Handle
;
1308 EFI_FILE_INFO
*Info
;
1309 } EFI_SHELL_FILE_INFO_NO_CONST
;
1312 Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.
1314 if OldStyleFileList is NULL then ASSERT()
1316 this function will convert a SHELL_FILE_ARG based list into a callee allocated
1317 EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
1318 the ShellCloseFileMetaArg function.
1320 @param[in] FileList the EFI shell list type
1321 @param[in, out] ListHead the list to add to
1323 @retval the resultant head of the double linked new format list;
1327 InternalShellConvertFileListType (
1328 IN LIST_ENTRY
*FileList
,
1329 IN OUT LIST_ENTRY
*ListHead
1332 SHELL_FILE_ARG
*OldInfo
;
1334 EFI_SHELL_FILE_INFO_NO_CONST
*NewInfo
;
1339 ASSERT(FileList
!= NULL
);
1340 ASSERT(ListHead
!= NULL
);
1343 // enumerate through each member of the old list and copy
1345 for (Link
= FileList
->ForwardLink
; Link
!= FileList
; Link
= Link
->ForwardLink
) {
1346 OldInfo
= CR (Link
, SHELL_FILE_ARG
, Link
, SHELL_FILE_ARG_SIGNATURE
);
1347 ASSERT(OldInfo
!= NULL
);
1350 // Skip ones that failed to open...
1352 if (OldInfo
->Status
!= EFI_SUCCESS
) {
1357 // make sure the old list was valid
1359 ASSERT(OldInfo
->Info
!= NULL
);
1360 ASSERT(OldInfo
->FullName
!= NULL
);
1361 ASSERT(OldInfo
->FileName
!= NULL
);
1364 // allocate a new EFI_SHELL_FILE_INFO object
1366 NewInfo
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1367 if (NewInfo
== NULL
) {
1368 ShellCloseFileMetaArg(&(EFI_SHELL_FILE_INFO
*)ListHead
);
1374 // copy the simple items
1376 NewInfo
->Handle
= OldInfo
->Handle
;
1377 NewInfo
->Status
= OldInfo
->Status
;
1379 // old shell checks for 0 not NULL
1380 OldInfo
->Handle
= 0;
1383 // allocate new space to copy strings and structure
1385 NewInfo
->FullName
= AllocateZeroPool(StrSize(OldInfo
->FullName
));
1386 NewInfo
->FileName
= AllocateZeroPool(StrSize(OldInfo
->FileName
));
1387 NewInfo
->Info
= AllocateZeroPool((UINTN
)OldInfo
->Info
->Size
);
1390 // make sure all the memory allocations were sucessful
1392 if (NULL
== NewInfo
->FullName
|| NewInfo
->FileName
== NULL
|| NewInfo
->Info
== NULL
) {
1393 ShellCloseFileMetaArg(&(EFI_SHELL_FILE_INFO
*)ListHead
);
1399 // Copt the strings and structure
1401 StrCpy(NewInfo
->FullName
, OldInfo
->FullName
);
1402 StrCpy(NewInfo
->FileName
, OldInfo
->FileName
);
1403 gBS
->CopyMem (NewInfo
->Info
, OldInfo
->Info
, (UINTN
)OldInfo
->Info
->Size
);
1406 // add that to the list
1408 InsertTailList(ListHead
, &NewInfo
->Link
);
1413 Opens a group of files based on a path.
1415 This function uses the Arg to open all the matching files. Each matched
1416 file has a SHELL_FILE_ARG structure to record the file information. These
1417 structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
1418 structures from ListHead to access each file. This function supports wildcards
1419 and will process '?' and '*' as such. the list must be freed with a call to
1420 ShellCloseFileMetaArg().
1422 If you are NOT appending to an existing list *ListHead must be NULL. If
1423 *ListHead is NULL then it must be callee freed.
1425 @param Arg pointer to path string
1426 @param OpenMode mode to open files with
1427 @param ListHead head of linked list of results
1429 @retval EFI_SUCCESS the operation was sucessful and the list head
1430 contains the list of opened files
1431 @return != EFI_SUCCESS the operation failed
1433 @sa InternalShellConvertFileListType
1437 ShellOpenFileMetaArg (
1440 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1444 LIST_ENTRY mOldStyleFileList
;
1447 // ASSERT that Arg and ListHead are not NULL
1449 ASSERT(Arg
!= NULL
);
1450 ASSERT(ListHead
!= NULL
);
1453 // Check for UEFI Shell 2.0 protocols
1455 if (gEfiShellProtocol
!= NULL
) {
1456 if (*ListHead
== NULL
) {
1457 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1458 if (*ListHead
== NULL
) {
1459 return (EFI_OUT_OF_RESOURCES
);
1461 InitializeListHead(&((*ListHead
)->Link
));
1463 Status
= gEfiShellProtocol
->OpenFileList(Arg
,
1466 if (EFI_ERROR(Status
)) {
1467 gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1469 Status
= gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1471 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1472 FreePool(*ListHead
);
1474 return (EFI_NOT_FOUND
);
1480 // Check for EFI shell
1482 if (mEfiShellEnvironment2
!= NULL
) {
1484 // make sure the list head is initialized
1486 InitializeListHead(&mOldStyleFileList
);
1489 // Get the EFI Shell list of files
1491 Status
= mEfiShellEnvironment2
->FileMetaArg(Arg
, &mOldStyleFileList
);
1492 if (EFI_ERROR(Status
)) {
1497 if (*ListHead
== NULL
) {
1498 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1499 if (*ListHead
== NULL
) {
1500 return (EFI_OUT_OF_RESOURCES
);
1502 InitializeListHead(&((*ListHead
)->Link
));
1506 // Convert that to equivalent of UEFI Shell 2.0 structure
1508 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1511 // Free the EFI Shell version that was converted.
1513 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1515 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1516 FreePool(*ListHead
);
1518 Status
= EFI_NOT_FOUND
;
1523 return (EFI_UNSUPPORTED
);
1526 Free the linked list returned from ShellOpenFileMetaArg.
1528 if ListHead is NULL then ASSERT().
1530 @param ListHead the pointer to free.
1532 @retval EFI_SUCCESS the operation was sucessful.
1536 ShellCloseFileMetaArg (
1537 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1543 // ASSERT that ListHead is not NULL
1545 ASSERT(ListHead
!= NULL
);
1548 // Check for UEFI Shell 2.0 protocols
1550 if (gEfiShellProtocol
!= NULL
) {
1551 return (gEfiShellProtocol
->FreeFileList(ListHead
));
1552 } else if (mEfiShellEnvironment2
!= NULL
) {
1554 // Since this is EFI Shell version we need to free our internally made copy
1557 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1558 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1559 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1560 RemoveEntryList(Node
);
1561 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1562 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1563 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1564 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1565 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1570 return (EFI_UNSUPPORTED
);
1574 Find a file by searching the CWD and then the path.
1576 If FileName is NULL then ASSERT.
1578 If the return value is not NULL then the memory must be caller freed.
1580 @param FileName Filename string.
1582 @retval NULL the file was not found
1583 @return !NULL the full path to the file.
1588 IN CONST CHAR16
*FileName
1592 SHELL_FILE_HANDLE Handle
;
1596 CONST CHAR16
*Walker
;
1603 // First make sure its not an absolute path.
1605 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1606 if (!EFI_ERROR(Status
)){
1607 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1608 ASSERT(RetVal
== NULL
);
1609 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1610 ShellCloseFile(&Handle
);
1613 ShellCloseFile(&Handle
);
1617 Path
= ShellGetEnvironmentVariable(L
"cwd");
1619 Size
= StrSize(Path
);
1620 Size
+= StrSize(FileName
);
1621 TestPath
= AllocateZeroPool(Size
);
1622 if (TestPath
== NULL
) {
1625 StrCpy(TestPath
, Path
);
1626 StrCat(TestPath
, FileName
);
1627 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1628 if (!EFI_ERROR(Status
)){
1629 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1630 ASSERT(RetVal
== NULL
);
1631 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1632 ShellCloseFile(&Handle
);
1636 ShellCloseFile(&Handle
);
1641 Path
= ShellGetEnvironmentVariable(L
"path");
1643 Size
= StrSize(Path
)+sizeof(CHAR16
);
1644 Size
+= StrSize(FileName
);
1645 TestPath
= AllocateZeroPool(Size
);
1646 if (TestPath
== NULL
) {
1649 Walker
= (CHAR16
*)Path
;
1651 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1652 if (TestPath
!= NULL
) {
1653 TempChar
= StrStr(TestPath
, L
";");
1654 if (TempChar
!= NULL
) {
1655 *TempChar
= CHAR_NULL
;
1657 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1658 StrCat(TestPath
, L
"\\");
1660 if (FileName
[0] == L
'\\') {
1663 StrCat(TestPath
, FileName
);
1664 if (StrStr(Walker
, L
";") != NULL
) {
1665 Walker
= StrStr(Walker
, L
";") + 1;
1669 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1670 if (!EFI_ERROR(Status
)){
1671 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1672 ASSERT(RetVal
== NULL
);
1673 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1674 ShellCloseFile(&Handle
);
1677 ShellCloseFile(&Handle
);
1681 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1688 Find a file by searching the CWD and then the path with a variable set of file
1689 extensions. If the file is not found it will append each extension in the list
1690 in the order provided and return the first one that is successful.
1692 If FileName is NULL, then ASSERT.
1693 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1695 If the return value is not NULL then the memory must be caller freed.
1697 @param[in] FileName Filename string.
1698 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1700 @retval NULL The file was not found.
1701 @retval !NULL The path to the file.
1705 ShellFindFilePathEx (
1706 IN CONST CHAR16
*FileName
,
1707 IN CONST CHAR16
*FileExtension
1712 CONST CHAR16
*ExtensionWalker
;
1717 ASSERT(FileName
!= NULL
);
1718 if (FileExtension
== NULL
) {
1719 return (ShellFindFilePath(FileName
));
1721 RetVal
= ShellFindFilePath(FileName
);
1722 if (RetVal
!= NULL
) {
1725 Size
= StrSize(FileName
);
1726 Size
+= StrSize(FileExtension
);
1727 TestPath
= AllocateZeroPool(Size
);
1728 if (TestPath
== NULL
) {
1731 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1732 StrCpy(TestPath
, FileName
);
1733 if (ExtensionWalker
!= NULL
) {
1734 StrCat(TestPath
, ExtensionWalker
);
1736 TempChar
= StrStr(TestPath
, L
";");
1737 if (TempChar
!= NULL
) {
1738 *TempChar
= CHAR_NULL
;
1740 RetVal
= ShellFindFilePath(TestPath
);
1741 if (RetVal
!= NULL
) {
1744 ASSERT(ExtensionWalker
!= NULL
);
1745 TempChar2
= StrStr(ExtensionWalker
, L
";");
1754 SHELL_PARAM_TYPE Type
;
1756 UINTN OriginalPosition
;
1757 } SHELL_PARAM_PACKAGE
;
1760 Checks the list of valid arguments and returns TRUE if the item was found. If the
1761 return value is TRUE then the type parameter is set also.
1763 if CheckList is NULL then ASSERT();
1764 if Name is NULL then ASSERT();
1765 if Type is NULL then ASSERT();
1767 @param Name pointer to Name of parameter found
1768 @param CheckList List to check against
1769 @param Type pointer to type of parameter if it was found
1771 @retval TRUE the Parameter was found. Type is valid.
1772 @retval FALSE the Parameter was not found. Type is not valid.
1776 InternalIsOnCheckList (
1777 IN CONST CHAR16
*Name
,
1778 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1779 OUT SHELL_PARAM_TYPE
*Type
1782 SHELL_PARAM_ITEM
*TempListItem
;
1786 // ASSERT that all 3 pointer parameters aren't NULL
1788 ASSERT(CheckList
!= NULL
);
1789 ASSERT(Type
!= NULL
);
1790 ASSERT(Name
!= NULL
);
1793 // question mark and page break mode are always supported
1795 if ((StrCmp(Name
, L
"-?") == 0) ||
1796 (StrCmp(Name
, L
"-b") == 0)
1803 // Enumerate through the list
1805 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1807 // If the Type is TypeStart only check the first characters of the passed in param
1808 // If it matches set the type and return TRUE
1810 if (TempListItem
->Type
== TypeStart
) {
1811 if (StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1812 *Type
= TempListItem
->Type
;
1816 TempString
= StrnCatGrow(&TempString
, NULL
, Name
, StrLen(TempListItem
->Name
));
1817 if (TempString
!= NULL
) {
1818 if (StringNoCaseCompare(&TempString
, &TempListItem
->Name
) == 0) {
1819 *Type
= TempListItem
->Type
;
1820 FreePool(TempString
);
1823 FreePool(TempString
);
1825 } else if (StringNoCaseCompare(&Name
, &TempListItem
->Name
) == 0) {
1826 *Type
= TempListItem
->Type
;
1834 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1836 @param[in] Name pointer to Name of parameter found
1837 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1839 @retval TRUE the Parameter is a flag.
1840 @retval FALSE the Parameter not a flag.
1845 IN CONST CHAR16
*Name
,
1846 IN BOOLEAN AlwaysAllowNumbers
1850 // ASSERT that Name isn't NULL
1852 ASSERT(Name
!= NULL
);
1855 // If we accept numbers then dont return TRUE. (they will be values)
1857 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && ShellIsHexaDecimalDigitCharacter(Name
[1])) && AlwaysAllowNumbers
) {
1862 // If the Name has a /, +, or - as the first character return TRUE
1864 if ((Name
[0] == L
'/') ||
1865 (Name
[0] == L
'-') ||
1874 Checks the command line arguments passed against the list of valid ones.
1876 If no initialization is required, then return RETURN_SUCCESS.
1878 @param[in] CheckList pointer to list of parameters to check
1879 @param[out] CheckPackage pointer to pointer to list checked values
1880 @param[out] ProblemParam optional pointer to pointer to unicode string for
1881 the paramater that caused failure. If used then the
1882 caller is responsible for freeing the memory.
1883 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1884 @param[in] Argv pointer to array of parameters
1885 @param[in] Argc Count of parameters in Argv
1886 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1888 @retval EFI_SUCCESS The operation completed sucessfully.
1889 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1890 @retval EFI_INVALID_PARAMETER A parameter was invalid
1891 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1892 duplicated. the duplicated command line argument
1893 was returned in ProblemParam if provided.
1894 @retval EFI_NOT_FOUND a argument required a value that was missing.
1895 the invalid command line argument was returned in
1896 ProblemParam if provided.
1900 InternalCommandLineParse (
1901 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1902 OUT LIST_ENTRY
**CheckPackage
,
1903 OUT CHAR16
**ProblemParam OPTIONAL
,
1904 IN BOOLEAN AutoPageBreak
,
1905 IN CONST CHAR16
**Argv
,
1907 IN BOOLEAN AlwaysAllowNumbers
1911 SHELL_PARAM_TYPE CurrentItemType
;
1912 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
1916 CONST CHAR16
*TempPointer
;
1918 CurrentItemPackage
= NULL
;
1924 // If there is only 1 item we dont need to do anything
1927 *CheckPackage
= NULL
;
1928 return (EFI_SUCCESS
);
1934 ASSERT(CheckList
!= NULL
);
1935 ASSERT(Argv
!= NULL
);
1938 // initialize the linked list
1940 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
1941 if (*CheckPackage
== NULL
) {
1942 return (EFI_OUT_OF_RESOURCES
);
1945 InitializeListHead(*CheckPackage
);
1948 // loop through each of the arguments
1950 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
1951 if (Argv
[LoopCounter
] == NULL
) {
1953 // do nothing for NULL argv
1955 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
1957 // We might have leftover if last parameter didnt have optional value
1959 if (GetItemValue
!= 0) {
1961 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1966 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
1967 if (CurrentItemPackage
== NULL
) {
1968 ShellCommandLineFreeVarList(*CheckPackage
);
1969 *CheckPackage
= NULL
;
1970 return (EFI_OUT_OF_RESOURCES
);
1972 CurrentItemPackage
->Name
= AllocateZeroPool(StrSize(Argv
[LoopCounter
]));
1973 if (CurrentItemPackage
->Name
== NULL
) {
1974 ShellCommandLineFreeVarList(*CheckPackage
);
1975 *CheckPackage
= NULL
;
1976 return (EFI_OUT_OF_RESOURCES
);
1978 StrCpy(CurrentItemPackage
->Name
, Argv
[LoopCounter
]);
1979 CurrentItemPackage
->Type
= CurrentItemType
;
1980 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
1981 CurrentItemPackage
->Value
= NULL
;
1984 // Does this flag require a value
1986 switch (CurrentItemPackage
->Type
) {
1988 // possibly trigger the next loop(s) to populate the value of this item
1994 case TypeDoubleValue
:
1999 GetItemValue
= (UINTN
)(-1);
2004 // this item has no value expected; we are done
2006 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2007 ASSERT(GetItemValue
== 0);
2010 } else if (GetItemValue
!= 0 && !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
)) {
2011 ASSERT(CurrentItemPackage
!= NULL
);
2013 // get the item VALUE for a previous flag
2015 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
), CurrentItemPackage
->Value
);
2016 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2017 if (ValueSize
== 0) {
2018 StrCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
2020 StrCat(CurrentItemPackage
->Value
, L
" ");
2021 StrCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
2023 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2025 if (GetItemValue
== 0) {
2026 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2028 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
) ){ //|| ProblemParam == NULL) {
2030 // add this one as a non-flag
2033 TempPointer
= Argv
[LoopCounter
];
2034 if ((*TempPointer
== L
'^' && *(TempPointer
+1) == L
'-')
2035 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'/')
2036 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'+')
2040 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2041 if (CurrentItemPackage
== NULL
) {
2042 ShellCommandLineFreeVarList(*CheckPackage
);
2043 *CheckPackage
= NULL
;
2044 return (EFI_OUT_OF_RESOURCES
);
2046 CurrentItemPackage
->Name
= NULL
;
2047 CurrentItemPackage
->Type
= TypePosition
;
2048 CurrentItemPackage
->Value
= AllocateZeroPool(StrSize(TempPointer
));
2049 if (CurrentItemPackage
->Value
== NULL
) {
2050 ShellCommandLineFreeVarList(*CheckPackage
);
2051 *CheckPackage
= NULL
;
2052 return (EFI_OUT_OF_RESOURCES
);
2054 StrCpy(CurrentItemPackage
->Value
, TempPointer
);
2055 CurrentItemPackage
->OriginalPosition
= Count
++;
2056 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2059 // this was a non-recognised flag... error!
2061 if (ProblemParam
!= NULL
) {
2062 *ProblemParam
= AllocateZeroPool(StrSize(Argv
[LoopCounter
]));
2063 if (*ProblemParam
!= NULL
) {
2064 StrCpy(*ProblemParam
, Argv
[LoopCounter
]);
2067 ShellCommandLineFreeVarList(*CheckPackage
);
2068 *CheckPackage
= NULL
;
2069 return (EFI_VOLUME_CORRUPTED
);
2072 if (GetItemValue
!= 0) {
2074 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2077 // support for AutoPageBreak
2079 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2080 ShellSetPageBreakMode(TRUE
);
2082 return (EFI_SUCCESS
);
2086 Checks the command line arguments passed against the list of valid ones.
2087 Optionally removes NULL values first.
2089 If no initialization is required, then return RETURN_SUCCESS.
2091 @param[in] CheckList The pointer to list of parameters to check.
2092 @param[out] CheckPackage The package of checked values.
2093 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2094 the paramater that caused failure.
2095 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2096 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2098 @retval EFI_SUCCESS The operation completed sucessfully.
2099 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2100 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2101 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2102 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2103 of the command line arguments was returned in
2104 ProblemParam if provided.
2105 @retval EFI_NOT_FOUND A argument required a value that was missing.
2106 The invalid command line argument was returned in
2107 ProblemParam if provided.
2111 ShellCommandLineParseEx (
2112 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2113 OUT LIST_ENTRY
**CheckPackage
,
2114 OUT CHAR16
**ProblemParam OPTIONAL
,
2115 IN BOOLEAN AutoPageBreak
,
2116 IN BOOLEAN AlwaysAllowNumbers
2120 // ASSERT that CheckList and CheckPackage aren't NULL
2122 ASSERT(CheckList
!= NULL
);
2123 ASSERT(CheckPackage
!= NULL
);
2126 // Check for UEFI Shell 2.0 protocols
2128 if (gEfiShellParametersProtocol
!= NULL
) {
2129 return (InternalCommandLineParse(CheckList
,
2133 (CONST CHAR16
**) gEfiShellParametersProtocol
->Argv
,
2134 gEfiShellParametersProtocol
->Argc
,
2135 AlwaysAllowNumbers
));
2139 // ASSERT That EFI Shell is not required
2141 ASSERT (mEfiShellInterface
!= NULL
);
2142 return (InternalCommandLineParse(CheckList
,
2146 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2147 mEfiShellInterface
->Argc
,
2148 AlwaysAllowNumbers
));
2152 Frees shell variable list that was returned from ShellCommandLineParse.
2154 This function will free all the memory that was used for the CheckPackage
2155 list of postprocessed shell arguments.
2157 this function has no return value.
2159 if CheckPackage is NULL, then return
2161 @param CheckPackage the list to de-allocate
2165 ShellCommandLineFreeVarList (
2166 IN LIST_ENTRY
*CheckPackage
2172 // check for CheckPackage == NULL
2174 if (CheckPackage
== NULL
) {
2179 // for each node in the list
2181 for ( Node
= GetFirstNode(CheckPackage
)
2182 ; !IsListEmpty(CheckPackage
)
2183 ; Node
= GetFirstNode(CheckPackage
)
2186 // Remove it from the list
2188 RemoveEntryList(Node
);
2191 // if it has a name free the name
2193 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2194 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2198 // if it has a value free the value
2200 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2201 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2205 // free the node structure
2207 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2210 // free the list head node
2212 FreePool(CheckPackage
);
2215 Checks for presence of a flag parameter
2217 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2219 if CheckPackage is NULL then return FALSE.
2220 if KeyString is NULL then ASSERT()
2222 @param CheckPackage The package of parsed command line arguments
2223 @param KeyString the Key of the command line argument to check for
2225 @retval TRUE the flag is on the command line
2226 @retval FALSE the flag is not on the command line
2230 ShellCommandLineGetFlag (
2231 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2232 IN CONST CHAR16
* CONST KeyString
2239 // return FALSE for no package or KeyString is NULL
2241 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2246 // enumerate through the list of parametrs
2248 for ( Node
= GetFirstNode(CheckPackage
)
2249 ; !IsNull (CheckPackage
, Node
)
2250 ; Node
= GetNextNode(CheckPackage
, Node
)
2253 // If the Name matches, return TRUE (and there may be NULL name)
2255 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2257 // If Type is TypeStart then only compare the begining of the strings
2259 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2260 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2264 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2265 if (TempString
!= NULL
) {
2266 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2267 FreePool(TempString
);
2270 FreePool(TempString
);
2272 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2280 Returns value from command line argument.
2282 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2284 If CheckPackage is NULL, then return NULL.
2286 @param[in] CheckPackage The package of parsed command line arguments.
2287 @param[in] KeyString The Key of the command line argument to check for.
2289 @retval NULL The flag is not on the command line.
2290 @retval !=NULL The pointer to unicode string of the value.
2294 ShellCommandLineGetValue (
2295 IN CONST LIST_ENTRY
*CheckPackage
,
2296 IN CHAR16
*KeyString
2303 // return NULL for no package or KeyString is NULL
2305 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2310 // enumerate through the list of parametrs
2312 for ( Node
= GetFirstNode(CheckPackage
)
2313 ; !IsNull (CheckPackage
, Node
)
2314 ; Node
= GetNextNode(CheckPackage
, Node
)
2317 // If the Name matches, return TRUE (and there may be NULL name)
2319 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2321 // If Type is TypeStart then only compare the begining of the strings
2323 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2324 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2325 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2328 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2329 if (TempString
!= NULL
) {
2330 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2331 FreePool(TempString
);
2332 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2334 FreePool(TempString
);
2336 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2337 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2345 Returns raw value from command line argument.
2347 Raw value parameters are in the form of "value" in a specific position in the list.
2349 If CheckPackage is NULL, then return NULL.
2351 @param[in] CheckPackage The package of parsed command line arguments.
2352 @param[in] Position The position of the value.
2354 @retval NULL The flag is not on the command line.
2355 @retval !=NULL The pointer to unicode string of the value.
2359 ShellCommandLineGetRawValue (
2360 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2367 // check for CheckPackage == NULL
2369 if (CheckPackage
== NULL
) {
2374 // enumerate through the list of parametrs
2376 for ( Node
= GetFirstNode(CheckPackage
)
2377 ; !IsNull (CheckPackage
, Node
)
2378 ; Node
= GetNextNode(CheckPackage
, Node
)
2381 // If the position matches, return the value
2383 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2384 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2391 returns the number of command line value parameters that were parsed.
2393 this will not include flags.
2395 @param[in] CheckPackage The package of parsed command line arguments.
2397 @retval (UINTN)-1 No parsing has ocurred
2398 @return other The number of value parameters found
2402 ShellCommandLineGetCount(
2403 IN CONST LIST_ENTRY
*CheckPackage
2409 if (CheckPackage
== NULL
) {
2412 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2413 ; !IsNull (CheckPackage
, Node1
)
2414 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2416 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2424 Determins if a parameter is duplicated.
2426 If Param is not NULL then it will point to a callee allocated string buffer
2427 with the parameter value if a duplicate is found.
2429 If CheckPackage is NULL, then ASSERT.
2431 @param[in] CheckPackage The package of parsed command line arguments.
2432 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2434 @retval EFI_SUCCESS No parameters were duplicated.
2435 @retval EFI_DEVICE_ERROR A duplicate was found.
2439 ShellCommandLineCheckDuplicate (
2440 IN CONST LIST_ENTRY
*CheckPackage
,
2447 ASSERT(CheckPackage
!= NULL
);
2449 for ( Node1
= GetFirstNode(CheckPackage
)
2450 ; !IsNull (CheckPackage
, Node1
)
2451 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2453 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2454 ; !IsNull (CheckPackage
, Node2
)
2455 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2457 if ((((SHELL_PARAM_PACKAGE
*)Node1
)->Name
!= NULL
) && (((SHELL_PARAM_PACKAGE
*)Node2
)->Name
!= NULL
) && StrCmp(((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, ((SHELL_PARAM_PACKAGE
*)Node2
)->Name
) == 0) {
2458 if (Param
!= NULL
) {
2460 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2462 return (EFI_DEVICE_ERROR
);
2466 return (EFI_SUCCESS
);
2470 This is a find and replace function. Upon successful return the NewString is a copy of
2471 SourceString with each instance of FindTarget replaced with ReplaceWith.
2473 If SourceString and NewString overlap the behavior is undefined.
2475 If the string would grow bigger than NewSize it will halt and return error.
2477 @param[in] SourceString The string with source buffer.
2478 @param[in, out] NewString The string with resultant buffer.
2479 @param[in] NewSize The size in bytes of NewString.
2480 @param[in] FindTarget The string to look for.
2481 @param[in] ReplaceWith The string to replace FindTarget with.
2482 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2483 immediately before it.
2484 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2486 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2487 @retval EFI_INVALID_PARAMETER NewString was NULL.
2488 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2489 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2490 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2491 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2492 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2493 the new string (truncation occurred).
2494 @retval EFI_SUCCESS The string was successfully copied with replacement.
2498 ShellCopySearchAndReplace(
2499 IN CHAR16 CONST
*SourceString
,
2500 IN OUT CHAR16
*NewString
,
2502 IN CONST CHAR16
*FindTarget
,
2503 IN CONST CHAR16
*ReplaceWith
,
2504 IN CONST BOOLEAN SkipPreCarrot
,
2505 IN CONST BOOLEAN ParameterReplacing
2511 if ( (SourceString
== NULL
)
2512 || (NewString
== NULL
)
2513 || (FindTarget
== NULL
)
2514 || (ReplaceWith
== NULL
)
2515 || (StrLen(FindTarget
) < 1)
2516 || (StrLen(SourceString
) < 1)
2518 return (EFI_INVALID_PARAMETER
);
2521 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2522 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2524 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2525 if (Replace
!= NULL
) {
2526 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2529 if (Replace
== NULL
) {
2530 return (EFI_OUT_OF_RESOURCES
);
2532 NewString
= SetMem16(NewString
, NewSize
, CHAR_NULL
);
2533 while (*SourceString
!= CHAR_NULL
) {
2535 // if we find the FindTarget and either Skip == FALSE or Skip and we
2536 // dont have a carrot do a replace...
2538 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2539 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2541 SourceString
+= StrLen(FindTarget
);
2542 Size
= StrSize(NewString
);
2543 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2545 return (EFI_BUFFER_TOO_SMALL
);
2547 StrCat(NewString
, Replace
);
2549 Size
= StrSize(NewString
);
2550 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2552 return (EFI_BUFFER_TOO_SMALL
);
2554 StrnCat(NewString
, SourceString
, 1);
2559 return (EFI_SUCCESS
);
2563 Internal worker function to output a string.
2565 This function will output a string to the correct StdOut.
2567 @param[in] String The string to print out.
2569 @retval EFI_SUCCESS The operation was sucessful.
2570 @retval !EFI_SUCCESS The operation failed.
2575 IN CONST CHAR16
*String
2579 Size
= StrSize(String
) - sizeof(CHAR16
);
2581 return (EFI_SUCCESS
);
2583 if (gEfiShellParametersProtocol
!= NULL
) {
2584 return (gEfiShellProtocol
->WriteFile(gEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2586 if (mEfiShellInterface
!= NULL
) {
2588 // Divide in half for old shell. Must be string length not size.
2591 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2594 return (EFI_UNSUPPORTED
);
2598 Print at a specific location on the screen.
2600 This function will move the cursor to a given screen location and print the specified string
2602 If -1 is specified for either the Row or Col the current screen location for BOTH
2605 if either Row or Col is out of range for the current console, then ASSERT
2606 if Format is NULL, then ASSERT
2608 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2609 the following additional flags:
2610 %N - Set output attribute to normal
2611 %H - Set output attribute to highlight
2612 %E - Set output attribute to error
2613 %B - Set output attribute to blue color
2614 %V - Set output attribute to green color
2616 Note: The background color is controlled by the shell command cls.
2618 @param[in] Col the column to print at
2619 @param[in] Row the row to print at
2620 @param[in] Format the format string
2621 @param[in] Marker the marker for the variable argument list
2623 @return EFI_SUCCESS The operation was successful.
2624 @return EFI_DEVICE_ERROR The console device reported an error.
2628 InternalShellPrintWorker(
2629 IN INT32 Col OPTIONAL
,
2630 IN INT32 Row OPTIONAL
,
2631 IN CONST CHAR16
*Format
,
2636 CHAR16
*ResumeLocation
;
2637 CHAR16
*FormatWalker
;
2638 UINTN OriginalAttribute
;
2639 CHAR16
*mPostReplaceFormat
;
2640 CHAR16
*mPostReplaceFormat2
;
2642 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2643 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2645 if (mPostReplaceFormat
== NULL
|| mPostReplaceFormat2
== NULL
) {
2646 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2647 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2648 return (EFI_OUT_OF_RESOURCES
);
2651 Status
= EFI_SUCCESS
;
2652 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2655 // Back and forth each time fixing up 1 of our flags...
2657 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2658 ASSERT_EFI_ERROR(Status
);
2659 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2660 ASSERT_EFI_ERROR(Status
);
2661 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2662 ASSERT_EFI_ERROR(Status
);
2663 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2664 ASSERT_EFI_ERROR(Status
);
2665 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2666 ASSERT_EFI_ERROR(Status
);
2669 // Use the last buffer from replacing to print from...
2671 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2673 if (Col
!= -1 && Row
!= -1) {
2674 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2677 FormatWalker
= mPostReplaceFormat2
;
2678 while (*FormatWalker
!= CHAR_NULL
) {
2680 // Find the next attribute change request
2682 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2683 if (ResumeLocation
!= NULL
) {
2684 *ResumeLocation
= CHAR_NULL
;
2687 // print the current FormatWalker string
2689 if (StrLen(FormatWalker
)>0) {
2690 Status
= InternalPrintTo(FormatWalker
);
2691 if (EFI_ERROR(Status
)) {
2697 // update the attribute
2699 if (ResumeLocation
!= NULL
) {
2700 if (*(ResumeLocation
-1) == L
'^') {
2702 // Print a simple '%' symbol
2704 Status
= InternalPrintTo(L
"%");
2705 ResumeLocation
= ResumeLocation
- 1;
2707 switch (*(ResumeLocation
+1)) {
2709 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2712 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2715 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2718 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2721 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2725 // Print a simple '%' symbol
2727 Status
= InternalPrintTo(L
"%");
2728 if (EFI_ERROR(Status
)) {
2731 ResumeLocation
= ResumeLocation
- 1;
2737 // reset to normal now...
2743 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2745 FormatWalker
= ResumeLocation
+ 2;
2748 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2750 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2751 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2756 Print at a specific location on the screen.
2758 This function will move the cursor to a given screen location and print the specified string.
2760 If -1 is specified for either the Row or Col the current screen location for BOTH
2763 If either Row or Col is out of range for the current console, then ASSERT.
2764 If Format is NULL, then ASSERT.
2766 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2767 the following additional flags:
2768 %N - Set output attribute to normal
2769 %H - Set output attribute to highlight
2770 %E - Set output attribute to error
2771 %B - Set output attribute to blue color
2772 %V - Set output attribute to green color
2774 Note: The background color is controlled by the shell command cls.
2776 @param[in] Col the column to print at
2777 @param[in] Row the row to print at
2778 @param[in] Format the format string
2779 @param[in] ... The variable argument list.
2781 @return EFI_SUCCESS The printing was successful.
2782 @return EFI_DEVICE_ERROR The console device reported an error.
2787 IN INT32 Col OPTIONAL
,
2788 IN INT32 Row OPTIONAL
,
2789 IN CONST CHAR16
*Format
,
2795 if (Format
== NULL
) {
2796 return (EFI_INVALID_PARAMETER
);
2798 VA_START (Marker
, Format
);
2799 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2805 Print at a specific location on the screen.
2807 This function will move the cursor to a given screen location and print the specified string.
2809 If -1 is specified for either the Row or Col the current screen location for BOTH
2812 If either Row or Col is out of range for the current console, then ASSERT.
2813 If Format is NULL, then ASSERT.
2815 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2816 the following additional flags:
2817 %N - Set output attribute to normal.
2818 %H - Set output attribute to highlight.
2819 %E - Set output attribute to error.
2820 %B - Set output attribute to blue color.
2821 %V - Set output attribute to green color.
2823 Note: The background color is controlled by the shell command cls.
2825 @param[in] Col The column to print at.
2826 @param[in] Row The row to print at.
2827 @param[in] Language The language of the string to retrieve. If this parameter
2828 is NULL, then the current platform language is used.
2829 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2830 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2831 @param[in] ... The variable argument list.
2833 @return EFI_SUCCESS The printing was successful.
2834 @return EFI_DEVICE_ERROR The console device reported an error.
2839 IN INT32 Col OPTIONAL
,
2840 IN INT32 Row OPTIONAL
,
2841 IN CONST CHAR8
*Language OPTIONAL
,
2842 IN CONST EFI_STRING_ID HiiFormatStringId
,
2843 IN CONST EFI_HANDLE HiiFormatHandle
,
2848 CHAR16
*HiiFormatString
;
2851 VA_START (Marker
, HiiFormatHandle
);
2852 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2853 ASSERT(HiiFormatString
!= NULL
);
2855 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2857 SHELL_FREE_NON_NULL(HiiFormatString
);
2864 Function to determine if a given filename represents a file or a directory.
2866 @param[in] DirName Path to directory to test.
2868 @retval EFI_SUCCESS The Path represents a directory
2869 @retval EFI_NOT_FOUND The Path does not represent a directory
2870 @return other The path failed to open
2875 IN CONST CHAR16
*DirName
2879 SHELL_FILE_HANDLE Handle
;
2880 CHAR16
*TempLocation
;
2881 CHAR16
*TempLocation2
;
2883 ASSERT(DirName
!= NULL
);
2886 TempLocation
= NULL
;
2888 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
2889 if (EFI_ERROR(Status
)) {
2891 // try good logic first.
2893 if (gEfiShellProtocol
!= NULL
) {
2894 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
2895 TempLocation2
= StrStr(TempLocation
, L
":");
2896 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
2897 *(TempLocation2
+1) = CHAR_NULL
;
2899 if (gEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
2900 FreePool(TempLocation
);
2901 return (EFI_SUCCESS
);
2903 FreePool(TempLocation
);
2906 // probably a map name?!?!!?
2908 TempLocation
= StrStr(DirName
, L
"\\");
2909 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
2910 return (EFI_SUCCESS
);
2916 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
2917 ShellCloseFile(&Handle
);
2918 return (EFI_SUCCESS
);
2920 ShellCloseFile(&Handle
);
2921 return (EFI_NOT_FOUND
);
2925 Function to determine if a given filename represents a file.
2927 @param[in] Name Path to file to test.
2929 @retval EFI_SUCCESS The Path represents a file.
2930 @retval EFI_NOT_FOUND The Path does not represent a file.
2931 @retval other The path failed to open.
2936 IN CONST CHAR16
*Name
2940 SHELL_FILE_HANDLE Handle
;
2942 ASSERT(Name
!= NULL
);
2946 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
2947 if (EFI_ERROR(Status
)) {
2951 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
2952 ShellCloseFile(&Handle
);
2953 return (EFI_SUCCESS
);
2955 ShellCloseFile(&Handle
);
2956 return (EFI_NOT_FOUND
);
2960 Function to determine if a given filename represents a file.
2962 This will search the CWD and then the Path.
2964 If Name is NULL, then ASSERT.
2966 @param[in] Name Path to file to test.
2968 @retval EFI_SUCCESS The Path represents a file.
2969 @retval EFI_NOT_FOUND The Path does not represent a file.
2970 @retval other The path failed to open.
2975 IN CONST CHAR16
*Name
2981 if (!EFI_ERROR(ShellIsFile(Name
))) {
2982 return (EFI_SUCCESS
);
2985 NewName
= ShellFindFilePath(Name
);
2986 if (NewName
== NULL
) {
2987 return (EFI_NOT_FOUND
);
2989 Status
= ShellIsFile(NewName
);
2995 Function to determine whether a string is decimal or hex representation of a number
2996 and return the number converted from the string.
2998 @param[in] String String representation of a number
3001 @retval (UINTN)(-1) An error ocurred.
3006 IN CONST CHAR16
*String
3014 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, TRUE
)) {
3018 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, Hex
, TRUE
))) {
3019 return ((UINTN
)RetVal
);
3021 return ((UINTN
)(-1));
3025 Safely append with automatic string resizing given length of Destination and
3026 desired length of copy from Source.
3028 append the first D characters of Source to the end of Destination, where D is
3029 the lesser of Count and the StrLen() of Source. If appending those D characters
3030 will fit within Destination (whose Size is given as CurrentSize) and
3031 still leave room for a NULL terminator, then those characters are appended,
3032 starting at the original terminating NULL of Destination, and a new terminating
3035 If appending D characters onto Destination will result in a overflow of the size
3036 given in CurrentSize the string will be grown such that the copy can be performed
3037 and CurrentSize will be updated to the new size.
3039 If Source is NULL, there is nothing to append, just return the current buffer in
3042 if Destination is NULL, then ASSERT()
3043 if Destination's current length (including NULL terminator) is already more then
3044 CurrentSize, then ASSERT()
3046 @param[in, out] Destination The String to append onto
3047 @param[in, out] CurrentSize on call the number of bytes in Destination. On
3048 return possibly the new size (still in bytes). if NULL
3049 then allocate whatever is needed.
3050 @param[in] Source The String to append from
3051 @param[in] Count Maximum number of characters to append. if 0 then
3054 @return Destination return the resultant string.
3059 IN OUT CHAR16
**Destination
,
3060 IN OUT UINTN
*CurrentSize
,
3061 IN CONST CHAR16
*Source
,
3065 UINTN DestinationStartSize
;
3071 ASSERT(Destination
!= NULL
);
3074 // If there's nothing to do then just return Destination
3076 if (Source
== NULL
) {
3077 return (*Destination
);
3081 // allow for un-initialized pointers, based on size being 0
3083 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
3084 *Destination
= NULL
;
3088 // allow for NULL pointers address as Destination
3090 if (*Destination
!= NULL
) {
3091 ASSERT(CurrentSize
!= 0);
3092 DestinationStartSize
= StrSize(*Destination
);
3093 ASSERT(DestinationStartSize
<= *CurrentSize
);
3095 DestinationStartSize
= 0;
3096 // ASSERT(*CurrentSize == 0);
3100 // Append all of Source?
3103 Count
= StrLen(Source
);
3107 // Test and grow if required
3109 if (CurrentSize
!= NULL
) {
3110 NewSize
= *CurrentSize
;
3111 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3112 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3114 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3115 *CurrentSize
= NewSize
;
3117 *Destination
= AllocateZeroPool((Count
+1)*sizeof(CHAR16
));
3121 // Now use standard StrnCat on a big enough buffer
3123 if (*Destination
== NULL
) {
3126 return StrnCat(*Destination
, Source
, Count
);
3130 Prompt the user and return the resultant answer to the requestor.
3132 This function will display the requested question on the shell prompt and then
3133 wait for an apropriate answer to be input from the console.
3135 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3136 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3138 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3141 In either case *Response must be callee freed if Response was not NULL;
3143 @param Type What type of question is asked. This is used to filter the input
3144 to prevent invalid answers to question.
3145 @param Prompt Pointer to string prompt to use to request input.
3146 @param Response Pointer to Response which will be populated upon return.
3148 @retval EFI_SUCCESS The operation was sucessful.
3149 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3150 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3151 @return other The operation failed.
3155 ShellPromptForResponse (
3156 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3157 IN CHAR16
*Prompt OPTIONAL
,
3158 IN OUT VOID
**Response OPTIONAL
3164 SHELL_PROMPT_RESPONSE
*Resp
;
3168 Status
= EFI_UNSUPPORTED
;
3172 if (Type
!= ShellPromptResponseTypeFreeform
) {
3173 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE
));
3175 return (EFI_OUT_OF_RESOURCES
);
3180 case ShellPromptResponseTypeQuitContinue
:
3181 if (Prompt
!= NULL
) {
3182 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3185 // wait for valid response
3187 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3188 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3189 ASSERT_EFI_ERROR(Status
);
3190 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3191 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3192 *Resp
= ShellPromptResponseQuit
;
3194 *Resp
= ShellPromptResponseContinue
;
3197 case ShellPromptResponseTypeYesNoCancel
:
3198 if (Prompt
!= NULL
) {
3199 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3202 // wait for valid response
3204 *Resp
= ShellPromptResponseMax
;
3205 while (*Resp
== ShellPromptResponseMax
) {
3206 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3207 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3208 ASSERT_EFI_ERROR(Status
);
3209 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3210 switch (Key
.UnicodeChar
) {
3213 *Resp
= ShellPromptResponseYes
;
3217 *Resp
= ShellPromptResponseNo
;
3221 *Resp
= ShellPromptResponseCancel
;
3225 break; case ShellPromptResponseTypeYesNoAllCancel
:
3226 if (Prompt
!= NULL
) {
3227 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3230 // wait for valid response
3232 *Resp
= ShellPromptResponseMax
;
3233 while (*Resp
== ShellPromptResponseMax
) {
3234 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3235 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3236 ASSERT_EFI_ERROR(Status
);
3237 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3238 switch (Key
.UnicodeChar
) {
3241 *Resp
= ShellPromptResponseYes
;
3245 *Resp
= ShellPromptResponseNo
;
3249 *Resp
= ShellPromptResponseAll
;
3253 *Resp
= ShellPromptResponseCancel
;
3258 case ShellPromptResponseTypeEnterContinue
:
3259 case ShellPromptResponseTypeAnyKeyContinue
:
3260 if (Prompt
!= NULL
) {
3261 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3264 // wait for valid response
3266 *Resp
= ShellPromptResponseMax
;
3267 while (*Resp
== ShellPromptResponseMax
) {
3268 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3269 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3270 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3271 ASSERT_EFI_ERROR(Status
);
3272 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3273 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3274 *Resp
= ShellPromptResponseContinue
;
3278 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3279 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3280 ASSERT_EFI_ERROR(Status
);
3281 *Resp
= ShellPromptResponseContinue
;
3286 case ShellPromptResponseTypeYesNo
:
3287 if (Prompt
!= NULL
) {
3288 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3291 // wait for valid response
3293 *Resp
= ShellPromptResponseMax
;
3294 while (*Resp
== ShellPromptResponseMax
) {
3295 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3296 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3297 ASSERT_EFI_ERROR(Status
);
3298 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3299 switch (Key
.UnicodeChar
) {
3302 *Resp
= ShellPromptResponseYes
;
3306 *Resp
= ShellPromptResponseNo
;
3311 case ShellPromptResponseTypeFreeform
:
3312 if (Prompt
!= NULL
) {
3313 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3316 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3317 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3318 ASSERT_EFI_ERROR(Status
);
3319 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3320 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3323 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3324 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3328 // This is the location to add new prompt types.
3334 if (Response
!= NULL
) {
3337 } else if (Buffer
!= NULL
) {
3344 if (Buffer
!= NULL
) {
3349 ShellPrintEx(-1, -1, L
"\r\n");
3354 Prompt the user and return the resultant answer to the requestor.
3356 This function is the same as ShellPromptForResponse, except that the prompt is
3357 automatically pulled from HII.
3359 @param Type What type of question is asked. This is used to filter the input
3360 to prevent invalid answers to question.
3361 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3362 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3363 @param Response Pointer to Response which will be populated upon return.
3365 @retval EFI_SUCCESS the operation was sucessful.
3366 @return other the operation failed.
3368 @sa ShellPromptForResponse
3372 ShellPromptForResponseHii (
3373 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3374 IN CONST EFI_STRING_ID HiiFormatStringId
,
3375 IN CONST EFI_HANDLE HiiFormatHandle
,
3376 IN OUT VOID
**Response
3382 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3383 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3389 Function to determin if an entire string is a valid number.
3391 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3393 @param[in] String The string to evaluate.
3394 @param[in] ForceHex TRUE - always assume hex.
3395 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3397 @retval TRUE It is all numeric (dec/hex) characters.
3398 @retval FALSE There is a non-numeric character.
3402 InternalShellIsHexOrDecimalNumber (
3403 IN CONST CHAR16
*String
,
3404 IN CONST BOOLEAN ForceHex
,
3405 IN CONST BOOLEAN StopAtSpace
3411 // chop off a single negative sign
3413 if (String
!= NULL
&& *String
== L
'-') {
3417 if (String
== NULL
) {
3422 // chop leading zeroes
3424 while(String
!= NULL
&& *String
== L
'0'){
3428 // allow '0x' or '0X', but not 'x' or 'X'
3430 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3431 if (*(String
-1) != L
'0') {
3433 // we got an x without a preceeding 0
3439 } else if (ForceHex
) {
3446 // loop through the remaining characters and use the lib function
3448 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3450 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3454 if (!ShellIsDecimalDigitCharacter(*String
)) {
3464 Function to determine if a given filename exists.
3466 @param[in] Name Path to test.
3468 @retval EFI_SUCCESS The Path represents a file.
3469 @retval EFI_NOT_FOUND The Path does not represent a file.
3470 @retval other The path failed to open.
3475 IN CONST CHAR16
*Name
3479 EFI_SHELL_FILE_INFO
*List
;
3481 ASSERT(Name
!= NULL
);
3484 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3485 if (EFI_ERROR(Status
)) {
3489 ShellCloseFileMetaArg(&List
);
3491 return (EFI_SUCCESS
);
3495 Convert a Unicode character to upper case only if
3496 it maps to a valid small-case ASCII character.
3498 This internal function only deal with Unicode character
3499 which maps to a valid small-case ASCII character, i.e.
3500 L'a' to L'z'. For other Unicode character, the input character
3501 is returned directly.
3503 @param Char The character to convert.
3505 @retval LowerCharacter If the Char is with range L'a' to L'z'.
3506 @retval Unchanged Otherwise.
3511 InternalShellCharToUpper (
3515 if (Char
>= L
'a' && Char
<= L
'z') {
3516 return (CHAR16
) (Char
- (L
'a' - L
'A'));
3523 Convert a Unicode character to numerical value.
3525 This internal function only deal with Unicode character
3526 which maps to a valid hexadecimal ASII character, i.e.
3527 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
3528 Unicode character, the value returned does not make sense.
3530 @param Char The character to convert.
3532 @return The numerical value converted.
3537 InternalShellHexCharToUintn (
3541 if (ShellIsDecimalDigitCharacter (Char
)) {
3545 return (UINTN
) (10 + InternalShellCharToUpper (Char
) - L
'A');
3549 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
3551 This function returns a value of type UINTN by interpreting the contents
3552 of the Unicode string specified by String as a hexadecimal number.
3553 The format of the input Unicode string String is:
3555 [spaces][zeros][x][hexadecimal digits].
3557 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
3558 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
3559 If "x" appears in the input string, it must be prefixed with at least one 0.
3560 The function will ignore the pad space, which includes spaces or tab characters,
3561 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
3562 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
3563 first valid hexadecimal digit. Then, the function stops at the first character that is
3564 a not a valid hexadecimal character or NULL, whichever one comes first.
3566 If String has only pad spaces, then zero is returned.
3567 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
3568 then zero is returned.
3570 @param[in] String A pointer to a Null-terminated Unicode string.
3571 @param[out] Value Upon a successful return the value of the conversion.
3572 @param[in] StopAtSpace FALSE to skip spaces.
3574 @retval EFI_SUCCESS The conversion was successful.
3575 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3576 @retval EFI_DEVICE_ERROR An overflow occured.
3580 InternalShellStrHexToUint64 (
3581 IN CONST CHAR16
*String
,
3583 IN CONST BOOLEAN StopAtSpace
3588 if (String
== NULL
|| StrSize(String
) == 0 || Value
== NULL
) {
3589 return (EFI_INVALID_PARAMETER
);
3593 // Ignore the pad spaces (space or tab)
3595 while ((*String
== L
' ') || (*String
== L
'\t')) {
3600 // Ignore leading Zeros after the spaces
3602 while (*String
== L
'0') {
3606 if (InternalShellCharToUpper (*String
) == L
'X') {
3607 if (*(String
- 1) != L
'0') {
3619 // Skip spaces if requested
3621 while (StopAtSpace
&& *String
== L
' ') {
3625 while (ShellIsHexaDecimalDigitCharacter (*String
)) {
3627 // If the Hex Number represented by String overflows according
3628 // to the range defined by UINTN, then ASSERT().
3630 if (!(Result
<= (RShiftU64((((UINT64
) ~0) - InternalShellHexCharToUintn (*String
)), 4)))) {
3631 // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {
3632 return (EFI_DEVICE_ERROR
);
3635 Result
= (LShiftU64(Result
, 4));
3636 Result
+= InternalShellHexCharToUintn (*String
);
3640 // Skip spaces if requested
3642 while (StopAtSpace
&& *String
== L
' ') {
3648 return (EFI_SUCCESS
);
3652 Convert a Null-terminated Unicode decimal string to a value of
3655 This function returns a value of type UINT64 by interpreting the contents
3656 of the Unicode string specified by String as a decimal number. The format
3657 of the input Unicode string String is:
3659 [spaces] [decimal digits].
3661 The valid decimal digit character is in the range [0-9]. The
3662 function will ignore the pad space, which includes spaces or
3663 tab characters, before [decimal digits]. The running zero in the
3664 beginning of [decimal digits] will be ignored. Then, the function
3665 stops at the first character that is a not a valid decimal character
3666 or a Null-terminator, whichever one comes first.
3668 If String has only pad spaces, then 0 is returned.
3669 If String has no pad spaces or valid decimal digits,
3672 @param[in] String A pointer to a Null-terminated Unicode string.
3673 @param[out] Value Upon a successful return the value of the conversion.
3674 @param[in] StopAtSpace FALSE to skip spaces.
3676 @retval EFI_SUCCESS The conversion was successful.
3677 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3678 @retval EFI_DEVICE_ERROR An overflow occured.
3682 InternalShellStrDecimalToUint64 (
3683 IN CONST CHAR16
*String
,
3685 IN CONST BOOLEAN StopAtSpace
3690 if (String
== NULL
|| StrSize (String
) == 0 || Value
== NULL
) {
3691 return (EFI_INVALID_PARAMETER
);
3695 // Ignore the pad spaces (space or tab)
3697 while ((*String
== L
' ') || (*String
== L
'\t')) {
3702 // Ignore leading Zeros after the spaces
3704 while (*String
== L
'0') {
3711 // Skip spaces if requested
3713 while (StopAtSpace
&& *String
== L
' ') {
3716 while (ShellIsDecimalDigitCharacter (*String
)) {
3718 // If the number represented by String overflows according
3719 // to the range defined by UINT64, then ASSERT().
3722 if (!(Result
<= (DivU64x32((((UINT64
) ~0) - (*String
- L
'0')),10)))) {
3723 return (EFI_DEVICE_ERROR
);
3726 Result
= MultU64x32(Result
, 10) + (*String
- L
'0');
3730 // Stop at spaces if requested
3732 if (StopAtSpace
&& *String
== L
' ') {
3739 return (EFI_SUCCESS
);
3743 Function to verify and convert a string to its numerical value.
3745 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
3747 @param[in] String The string to evaluate.
3748 @param[out] Value Upon a successful return the value of the conversion.
3749 @param[in] ForceHex TRUE - always assume hex.
3750 @param[in] StopAtSpace FALSE to skip spaces.
3752 @retval EFI_SUCCESS The conversion was successful.
3753 @retval EFI_INVALID_PARAMETER String contained an invalid character.
3754 @retval EFI_NOT_FOUND String was a number, but Value was NULL.
3758 ShellConvertStringToUint64(
3759 IN CONST CHAR16
*String
,
3761 IN CONST BOOLEAN ForceHex
,
3762 IN CONST BOOLEAN StopAtSpace
3766 CONST CHAR16
*Walker
;
3772 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3775 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3776 return (EFI_INVALID_PARAMETER
);
3779 return (EFI_INVALID_PARAMETER
);
3784 // Chop off leading spaces
3786 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
3789 // make sure we have something left that is numeric.
3791 if (Walker
== NULL
|| *Walker
== CHAR_NULL
|| !InternalShellIsHexOrDecimalNumber(Walker
, Hex
, StopAtSpace
)) {
3792 return (EFI_INVALID_PARAMETER
);
3796 // do the conversion.
3798 if (Hex
|| StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
3799 Status
= InternalShellStrHexToUint64(Walker
, &RetVal
, StopAtSpace
);
3801 Status
= InternalShellStrDecimalToUint64(Walker
, &RetVal
, StopAtSpace
);
3804 if (Value
== NULL
&& !EFI_ERROR(Status
)) {
3805 return (EFI_NOT_FOUND
);
3808 if (Value
!= NULL
) {
3816 Function to determin if an entire string is a valid number.
3818 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3820 @param[in] String The string to evaluate.
3821 @param[in] ForceHex TRUE - always assume hex.
3822 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3824 @retval TRUE It is all numeric (dec/hex) characters.
3825 @retval FALSE There is a non-numeric character.
3829 ShellIsHexOrDecimalNumber (
3830 IN CONST CHAR16
*String
,
3831 IN CONST BOOLEAN ForceHex
,
3832 IN CONST BOOLEAN StopAtSpace
3835 if (ShellConvertStringToUint64(String
, NULL
, ForceHex
, StopAtSpace
) == EFI_NOT_FOUND
) {
3842 Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned
3843 buffer. The returned buffer must be callee freed.
3845 If the position upon start is 0, then the Ascii Boolean will be set. This should be
3846 maintained and not changed for all operations with the same file.
3848 @param[in] Handle SHELL_FILE_HANDLE to read from.
3849 @param[in, out] Ascii Boolean value for indicating whether the file is
3850 Ascii (TRUE) or UCS2 (FALSE).
3852 @return The line of text from the file.
3853 @retval NULL There was not enough memory available.
3855 @sa ShellFileHandleReadLine
3859 ShellFileHandleReturnLine(
3860 IN SHELL_FILE_HANDLE Handle
,
3861 IN OUT BOOLEAN
*Ascii
3871 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
3872 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3873 RetVal
= AllocateZeroPool(Size
);
3874 if (RetVal
== NULL
) {
3877 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
3880 if (EFI_ERROR(Status
) && (RetVal
!= NULL
)) {
3888 Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.
3890 If the position upon start is 0, then the Ascii Boolean will be set. This should be
3891 maintained and not changed for all operations with the same file.
3893 @param[in] Handle SHELL_FILE_HANDLE to read from.
3894 @param[in, out] Buffer The pointer to buffer to read into.
3895 @param[in, out] Size The pointer to number of bytes in Buffer.
3896 @param[in] Truncate If the buffer is large enough, this has no effect.
3897 If the buffer is is too small and Truncate is TRUE,
3898 the line will be truncated.
3899 If the buffer is is too small and Truncate is FALSE,
3900 then no read will occur.
3902 @param[in, out] Ascii Boolean value for indicating whether the file is
3903 Ascii (TRUE) or UCS2 (FALSE).
3905 @retval EFI_SUCCESS The operation was successful. The line is stored in
3907 @retval EFI_INVALID_PARAMETER Handle was NULL.
3908 @retval EFI_INVALID_PARAMETER Size was NULL.
3909 @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.
3910 Size was updated to the minimum space required.
3914 ShellFileHandleReadLine(
3915 IN SHELL_FILE_HANDLE Handle
,
3916 IN OUT CHAR16
*Buffer
,
3918 IN BOOLEAN Truncate
,
3919 IN OUT BOOLEAN
*Ascii
3926 UINT64 OriginalFilePosition
;
3932 return (EFI_INVALID_PARAMETER
);
3934 if (Buffer
== NULL
) {
3937 *Buffer
= CHAR_NULL
;
3939 gEfiShellProtocol
->GetFilePosition(Handle
, &OriginalFilePosition
);
3940 if (OriginalFilePosition
== 0) {
3941 CharSize
= sizeof(CHAR16
);
3942 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
3943 ASSERT_EFI_ERROR(Status
);
3944 if (CharBuffer
== gUnicodeFileTag
) {
3948 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
3952 for (CountSoFar
= 0;;CountSoFar
++){
3955 CharSize
= sizeof(CHAR8
);
3957 CharSize
= sizeof(CHAR16
);
3959 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
3960 if ( EFI_ERROR(Status
)
3962 || (CharBuffer
== L
'\n' && !(*Ascii
))
3963 || (CharBuffer
== '\n' && *Ascii
)
3968 // if we have space save it...
3970 if ((CountSoFar
+1)*sizeof(CHAR16
) < *Size
){
3971 ASSERT(Buffer
!= NULL
);
3972 ((CHAR16
*)Buffer
)[CountSoFar
] = CharBuffer
;
3973 ((CHAR16
*)Buffer
)[CountSoFar
+1] = CHAR_NULL
;
3978 // if we ran out of space tell when...
3980 if ((CountSoFar
+1)*sizeof(CHAR16
) > *Size
){
3981 *Size
= (CountSoFar
+1)*sizeof(CHAR16
);
3983 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
3985 DEBUG((DEBUG_WARN
, "The line was truncated in ShellFileHandleReadLine"));
3987 return (EFI_BUFFER_TOO_SMALL
);
3989 while(Buffer
[StrLen(Buffer
)-1] == L
'\r') {
3990 Buffer
[StrLen(Buffer
)-1] = CHAR_NULL
;