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
*mEfiShellProtocol
;
34 EFI_SHELL_PARAMETERS_PROTOCOL
*mEfiShellParametersProtocol
;
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.
91 IN EFI_HANDLE ImageHandle
101 Status
= gBS
->OpenProtocol(ImageHandle
,
102 &gEfiShellEnvironment2Guid
,
103 (VOID
**)&mEfiShellEnvironment2
,
106 EFI_OPEN_PROTOCOL_GET_PROTOCOL
109 // look for the mEfiShellEnvironment2 protocol at a higher level
111 if (EFI_ERROR (Status
) || !(CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
))){
113 // figure out how big of a buffer we need.
115 Status
= gBS
->LocateHandle (ByProtocol
,
116 &gEfiShellEnvironment2Guid
,
117 NULL
, // ignored for ByProtocol
122 // maybe it's not there???
124 if (Status
== EFI_BUFFER_TOO_SMALL
) {
125 Buffer
= (EFI_HANDLE
*)AllocateZeroPool(BufferSize
);
126 ASSERT(Buffer
!= NULL
);
127 Status
= gBS
->LocateHandle (ByProtocol
,
128 &gEfiShellEnvironment2Guid
,
129 NULL
, // ignored for ByProtocol
134 if (!EFI_ERROR (Status
) && Buffer
!= NULL
) {
136 // now parse the list of returned handles
138 Status
= EFI_NOT_FOUND
;
139 for (HandleIndex
= 0; HandleIndex
< (BufferSize
/sizeof(Buffer
[0])); HandleIndex
++) {
140 Status
= gBS
->OpenProtocol(Buffer
[HandleIndex
],
141 &gEfiShellEnvironment2Guid
,
142 (VOID
**)&mEfiShellEnvironment2
,
145 EFI_OPEN_PROTOCOL_GET_PROTOCOL
147 if (CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
)) {
148 mEfiShellEnvironment2Handle
= Buffer
[HandleIndex
];
149 Status
= EFI_SUCCESS
;
155 if (Buffer
!= NULL
) {
162 Function to do most of the work of the constructor. Allows for calling
163 multiple times without complete re-initialization.
165 @param[in] ImageHandle A copy of the ImageHandle.
166 @param[in] SystemTable A pointer to the SystemTable for the application.
168 @retval EFI_SUCCESS The operationw as successful.
172 ShellLibConstructorWorker (
173 IN EFI_HANDLE ImageHandle
,
174 IN EFI_SYSTEM_TABLE
*SystemTable
180 // UEFI 2.0 shell interfaces (used preferentially)
182 Status
= gBS
->OpenProtocol(
184 &gEfiShellProtocolGuid
,
185 (VOID
**)&mEfiShellProtocol
,
188 EFI_OPEN_PROTOCOL_GET_PROTOCOL
190 if (EFI_ERROR(Status
)) {
192 // Search for the shell protocol
194 Status
= gBS
->LocateProtocol(
195 &gEfiShellProtocolGuid
,
197 (VOID
**)&mEfiShellProtocol
199 if (EFI_ERROR(Status
)) {
200 mEfiShellProtocol
= NULL
;
203 Status
= gBS
->OpenProtocol(
205 &gEfiShellParametersProtocolGuid
,
206 (VOID
**)&mEfiShellParametersProtocol
,
209 EFI_OPEN_PROTOCOL_GET_PROTOCOL
211 if (EFI_ERROR(Status
)) {
212 mEfiShellParametersProtocol
= NULL
;
215 if (mEfiShellParametersProtocol
== NULL
|| mEfiShellProtocol
== NULL
) {
217 // Moved to seperate function due to complexity
219 Status
= ShellFindSE2(ImageHandle
);
221 if (EFI_ERROR(Status
)) {
222 DEBUG((DEBUG_ERROR
, "Status: 0x%08x\r\n", Status
));
223 mEfiShellEnvironment2
= NULL
;
225 Status
= gBS
->OpenProtocol(ImageHandle
,
226 &gEfiShellInterfaceGuid
,
227 (VOID
**)&mEfiShellInterface
,
230 EFI_OPEN_PROTOCOL_GET_PROTOCOL
232 if (EFI_ERROR(Status
)) {
233 mEfiShellInterface
= NULL
;
238 // only success getting 2 of either the old or new, but no 1/2 and 1/2
240 if ((mEfiShellEnvironment2
!= NULL
&& mEfiShellInterface
!= NULL
) ||
241 (mEfiShellProtocol
!= NULL
&& mEfiShellParametersProtocol
!= NULL
) ) {
242 if (mEfiShellProtocol
!= NULL
) {
243 FileFunctionMap
.GetFileInfo
= mEfiShellProtocol
->GetFileInfo
;
244 FileFunctionMap
.SetFileInfo
= mEfiShellProtocol
->SetFileInfo
;
245 FileFunctionMap
.ReadFile
= mEfiShellProtocol
->ReadFile
;
246 FileFunctionMap
.WriteFile
= mEfiShellProtocol
->WriteFile
;
247 FileFunctionMap
.CloseFile
= mEfiShellProtocol
->CloseFile
;
248 FileFunctionMap
.DeleteFile
= mEfiShellProtocol
->DeleteFile
;
249 FileFunctionMap
.GetFilePosition
= mEfiShellProtocol
->GetFilePosition
;
250 FileFunctionMap
.SetFilePosition
= mEfiShellProtocol
->SetFilePosition
;
251 FileFunctionMap
.FlushFile
= mEfiShellProtocol
->FlushFile
;
252 FileFunctionMap
.GetFileSize
= mEfiShellProtocol
->GetFileSize
;
254 FileFunctionMap
.GetFileInfo
= (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
;
255 FileFunctionMap
.SetFileInfo
= (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
;
256 FileFunctionMap
.ReadFile
= (EFI_SHELL_READ_FILE
)FileHandleRead
;
257 FileFunctionMap
.WriteFile
= (EFI_SHELL_WRITE_FILE
)FileHandleWrite
;
258 FileFunctionMap
.CloseFile
= (EFI_SHELL_CLOSE_FILE
)FileHandleClose
;
259 FileFunctionMap
.DeleteFile
= (EFI_SHELL_DELETE_FILE
)FileHandleDelete
;
260 FileFunctionMap
.GetFilePosition
= (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
;
261 FileFunctionMap
.SetFilePosition
= (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
;
262 FileFunctionMap
.FlushFile
= (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
;
263 FileFunctionMap
.GetFileSize
= (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
;
265 return (EFI_SUCCESS
);
267 return (EFI_NOT_FOUND
);
270 Constructor for the Shell library.
272 Initialize the library and determine if the underlying is a UEFI Shell 2.0 or an EFI shell.
274 @param ImageHandle the image handle of the process
275 @param SystemTable the EFI System Table pointer
277 @retval EFI_SUCCESS the initialization was complete sucessfully
278 @return others an error ocurred during initialization
282 ShellLibConstructor (
283 IN EFI_HANDLE ImageHandle
,
284 IN EFI_SYSTEM_TABLE
*SystemTable
287 mEfiShellEnvironment2
= NULL
;
288 mEfiShellProtocol
= NULL
;
289 mEfiShellParametersProtocol
= NULL
;
290 mEfiShellInterface
= NULL
;
291 mEfiShellEnvironment2Handle
= NULL
;
294 // verify that auto initialize is not set false
296 if (PcdGetBool(PcdShellLibAutoInitialize
) == 0) {
297 return (EFI_SUCCESS
);
300 return (ShellLibConstructorWorker(ImageHandle
, SystemTable
));
304 Destructor for the library. free any resources.
306 @param[in] ImageHandle A copy of the ImageHandle.
307 @param[in] SystemTable A pointer to the SystemTable for the application.
309 @retval EFI_SUCCESS The operation was successful.
310 @return An error from the CloseProtocol function.
315 IN EFI_HANDLE ImageHandle
,
316 IN EFI_SYSTEM_TABLE
*SystemTable
319 if (mEfiShellEnvironment2
!= NULL
) {
320 gBS
->CloseProtocol(mEfiShellEnvironment2Handle
==NULL
?ImageHandle
:mEfiShellEnvironment2Handle
,
321 &gEfiShellEnvironment2Guid
,
324 mEfiShellEnvironment2
= NULL
;
326 if (mEfiShellInterface
!= NULL
) {
327 gBS
->CloseProtocol(ImageHandle
,
328 &gEfiShellInterfaceGuid
,
331 mEfiShellInterface
= NULL
;
333 if (mEfiShellProtocol
!= NULL
) {
334 gBS
->CloseProtocol(ImageHandle
,
335 &gEfiShellProtocolGuid
,
338 mEfiShellProtocol
= NULL
;
340 if (mEfiShellParametersProtocol
!= NULL
) {
341 gBS
->CloseProtocol(ImageHandle
,
342 &gEfiShellParametersProtocolGuid
,
345 mEfiShellParametersProtocol
= NULL
;
347 mEfiShellEnvironment2Handle
= NULL
;
349 return (EFI_SUCCESS
);
353 This function causes the shell library to initialize itself. If the shell library
354 is already initialized it will de-initialize all the current protocol poitners and
355 re-populate them again.
357 When the library is used with PcdShellLibAutoInitialize set to true this function
358 will return EFI_SUCCESS and perform no actions.
360 This function is intended for internal access for shell commands only.
362 @retval EFI_SUCCESS the initialization was complete sucessfully
371 // if auto initialize is not false then skip
373 if (PcdGetBool(PcdShellLibAutoInitialize
) != 0) {
374 return (EFI_SUCCESS
);
378 // deinit the current stuff
380 ASSERT_EFI_ERROR(ShellLibDestructor(gImageHandle
, gST
));
383 // init the new stuff
385 return (ShellLibConstructorWorker(gImageHandle
, gST
));
389 This function will retrieve the information about the file for the handle
390 specified and store it in allocated pool memory.
392 This function allocates a buffer to store the file's information. It is the
393 caller's responsibility to free the buffer
395 @param FileHandle The file handle of the file for which information is
398 @retval NULL information could not be retrieved.
400 @return the information about the file
405 IN SHELL_FILE_HANDLE FileHandle
408 return (FileFunctionMap
.GetFileInfo(FileHandle
));
412 This function sets the information about the file for the opened handle
415 @param[in] FileHandle The file handle of the file for which information
418 @param[in] FileInfo The information to set.
420 @retval EFI_SUCCESS The information was set.
421 @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.
422 @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.
423 @retval EFI_NO_MEDIA The device has no medium.
424 @retval EFI_DEVICE_ERROR The device reported an error.
425 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
426 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
427 @retval EFI_ACCESS_DENIED The file was opened read only.
428 @retval EFI_VOLUME_FULL The volume is full.
433 IN SHELL_FILE_HANDLE FileHandle
,
434 IN EFI_FILE_INFO
*FileInfo
437 return (FileFunctionMap
.SetFileInfo(FileHandle
, FileInfo
));
441 This function will open a file or directory referenced by DevicePath.
443 This function opens a file with the open mode according to the file path. The
444 Attributes is valid only for EFI_FILE_MODE_CREATE.
446 @param FilePath on input the device path to the file. On output
447 the remaining device path.
448 @param DeviceHandle pointer to the system device handle.
449 @param FileHandle pointer to the file handle.
450 @param OpenMode the mode to open the file with.
451 @param Attributes the file's file attributes.
453 @retval EFI_SUCCESS The information was set.
454 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
455 @retval EFI_UNSUPPORTED Could not open the file path.
456 @retval EFI_NOT_FOUND The specified file could not be found on the
457 device or the file system could not be found on
459 @retval EFI_NO_MEDIA The device has no medium.
460 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
461 medium is no longer supported.
462 @retval EFI_DEVICE_ERROR The device reported an error.
463 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
464 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
465 @retval EFI_ACCESS_DENIED The file was opened read only.
466 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
468 @retval EFI_VOLUME_FULL The volume is full.
472 ShellOpenFileByDevicePath(
473 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
,
474 OUT EFI_HANDLE
*DeviceHandle
,
475 OUT SHELL_FILE_HANDLE
*FileHandle
,
482 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*EfiSimpleFileSystemProtocol
;
483 EFI_FILE_PROTOCOL
*Handle1
;
484 EFI_FILE_PROTOCOL
*Handle2
;
487 // ASERT for FileHandle, FilePath, and DeviceHandle being NULL
489 ASSERT(FilePath
!= NULL
);
490 ASSERT(FileHandle
!= NULL
);
491 ASSERT(DeviceHandle
!= NULL
);
493 // which shell interface should we use
495 if (mEfiShellProtocol
!= NULL
) {
497 // use UEFI Shell 2.0 method.
499 FileName
= mEfiShellProtocol
->GetFilePathFromDevicePath(*FilePath
);
500 if (FileName
== NULL
) {
501 return (EFI_INVALID_PARAMETER
);
503 Status
= ShellOpenFileByName(FileName
, FileHandle
, OpenMode
, Attributes
);
510 // use old shell method.
512 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
,
515 if (EFI_ERROR (Status
)) {
518 Status
= gBS
->OpenProtocol(*DeviceHandle
,
519 &gEfiSimpleFileSystemProtocolGuid
,
520 (VOID
**)&EfiSimpleFileSystemProtocol
,
523 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
524 if (EFI_ERROR (Status
)) {
527 Status
= EfiSimpleFileSystemProtocol
->OpenVolume(EfiSimpleFileSystemProtocol
, &Handle1
);
528 if (EFI_ERROR (Status
)) {
534 // go down directories one node at a time.
536 while (!IsDevicePathEnd (*FilePath
)) {
538 // For file system access each node should be a file path component
540 if (DevicePathType (*FilePath
) != MEDIA_DEVICE_PATH
||
541 DevicePathSubType (*FilePath
) != MEDIA_FILEPATH_DP
544 return (EFI_INVALID_PARAMETER
);
547 // Open this file path node
553 // Try to test opening an existing file
555 Status
= Handle2
->Open (
558 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
559 OpenMode
&~EFI_FILE_MODE_CREATE
,
564 // see if the error was that it needs to be created
566 if ((EFI_ERROR (Status
)) && (OpenMode
!= (OpenMode
&~EFI_FILE_MODE_CREATE
))) {
567 Status
= Handle2
->Open (
570 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
576 // Close the last node
578 Handle2
->Close (Handle2
);
580 if (EFI_ERROR(Status
)) {
587 *FilePath
= NextDevicePathNode (*FilePath
);
591 // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!
593 *FileHandle
= (VOID
*)Handle1
;
594 return (EFI_SUCCESS
);
598 This function will open a file or directory referenced by filename.
600 If return is EFI_SUCCESS, the Filehandle is the opened file's handle;
601 otherwise, the Filehandle is NULL. The Attributes is valid only for
602 EFI_FILE_MODE_CREATE.
604 if FileNAme is NULL then ASSERT()
606 @param FileName pointer to file name
607 @param FileHandle pointer to the file handle.
608 @param OpenMode the mode to open the file with.
609 @param Attributes the file's file attributes.
611 @retval EFI_SUCCESS The information was set.
612 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
613 @retval EFI_UNSUPPORTED Could not open the file path.
614 @retval EFI_NOT_FOUND The specified file could not be found on the
615 device or the file system could not be found
617 @retval EFI_NO_MEDIA The device has no medium.
618 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
619 medium is no longer supported.
620 @retval EFI_DEVICE_ERROR The device reported an error.
621 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
622 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
623 @retval EFI_ACCESS_DENIED The file was opened read only.
624 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
626 @retval EFI_VOLUME_FULL The volume is full.
631 IN CONST CHAR16
*FileName
,
632 OUT SHELL_FILE_HANDLE
*FileHandle
,
637 EFI_HANDLE DeviceHandle
;
638 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
640 EFI_FILE_INFO
*FileInfo
;
643 // ASSERT if FileName is NULL
645 ASSERT(FileName
!= NULL
);
647 if (FileName
== NULL
) {
648 return (EFI_INVALID_PARAMETER
);
651 if (mEfiShellProtocol
!= NULL
) {
652 if ((OpenMode
& EFI_FILE_MODE_CREATE
) == EFI_FILE_MODE_CREATE
&& (Attributes
& EFI_FILE_DIRECTORY
) == EFI_FILE_DIRECTORY
) {
653 return ShellCreateDirectory(FileName
, FileHandle
);
656 // Use UEFI Shell 2.0 method
658 Status
= mEfiShellProtocol
->OpenFileByName(FileName
,
661 if (StrCmp(FileName
, L
"NUL") != 0 && !EFI_ERROR(Status
) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)){
662 FileInfo
= FileFunctionMap
.GetFileInfo(*FileHandle
);
663 ASSERT(FileInfo
!= NULL
);
664 FileInfo
->Attribute
= Attributes
;
665 Status
= FileFunctionMap
.SetFileInfo(*FileHandle
, FileInfo
);
671 // Using EFI Shell version
672 // this means convert name to path and call that function
673 // since this will use EFI method again that will open it.
675 ASSERT(mEfiShellEnvironment2
!= NULL
);
676 FilePath
= mEfiShellEnvironment2
->NameToPath ((CHAR16
*)FileName
);
677 if (FilePath
!= NULL
) {
678 return (ShellOpenFileByDevicePath(&FilePath
,
684 return (EFI_DEVICE_ERROR
);
687 This function create a directory
689 If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;
690 otherwise, the Filehandle is NULL. If the directory already existed, this
691 function opens the existing directory.
693 @param DirectoryName pointer to directory name
694 @param FileHandle pointer to the file handle.
696 @retval EFI_SUCCESS The information was set.
697 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
698 @retval EFI_UNSUPPORTED Could not open the file path.
699 @retval EFI_NOT_FOUND The specified file could not be found on the
700 device or the file system could not be found
702 @retval EFI_NO_MEDIA The device has no medium.
703 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
704 medium is no longer supported.
705 @retval EFI_DEVICE_ERROR The device reported an error.
706 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
707 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
708 @retval EFI_ACCESS_DENIED The file was opened read only.
709 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
711 @retval EFI_VOLUME_FULL The volume is full.
712 @sa ShellOpenFileByName
716 ShellCreateDirectory(
717 IN CONST CHAR16
*DirectoryName
,
718 OUT SHELL_FILE_HANDLE
*FileHandle
721 if (mEfiShellProtocol
!= NULL
) {
723 // Use UEFI Shell 2.0 method
725 return (mEfiShellProtocol
->CreateFile(DirectoryName
,
730 return (ShellOpenFileByName(DirectoryName
,
732 EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
,
739 This function reads information from an opened file.
741 If FileHandle is not a directory, the function reads the requested number of
742 bytes from the file at the file's current position and returns them in Buffer.
743 If the read goes beyond the end of the file, the read length is truncated to the
744 end of the file. The file's current position is increased by the number of bytes
745 returned. If FileHandle is a directory, the function reads the directory entry
746 at the file's current position and returns the entry in Buffer. If the Buffer
747 is not large enough to hold the current directory entry, then
748 EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
749 BufferSize is set to be the size of the buffer needed to read the entry. On
750 success, the current position is updated to the next directory entry. If there
751 are no more directory entries, the read returns a zero-length buffer.
752 EFI_FILE_INFO is the structure returned as the directory entry.
754 @param FileHandle the opened file handle
755 @param BufferSize on input the size of buffer in bytes. on return
756 the number of bytes written.
757 @param Buffer the buffer to put read data into.
759 @retval EFI_SUCCESS Data was read.
760 @retval EFI_NO_MEDIA The device has no media.
761 @retval EFI_DEVICE_ERROR The device reported an error.
762 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
763 @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
770 IN SHELL_FILE_HANDLE FileHandle
,
771 IN OUT UINTN
*BufferSize
,
775 return (FileFunctionMap
.ReadFile(FileHandle
, BufferSize
, Buffer
));
780 Write data to a file.
782 This function writes the specified number of bytes to the file at the current
783 file position. The current file position is advanced the actual number of bytes
784 written, which is returned in BufferSize. Partial writes only occur when there
785 has been a data error during the write attempt (such as "volume space full").
786 The file is automatically grown to hold the data if required. Direct writes to
787 opened directories are not supported.
789 @param FileHandle The opened file for writing
790 @param BufferSize on input the number of bytes in Buffer. On output
791 the number of bytes written.
792 @param Buffer the buffer containing data to write is stored.
794 @retval EFI_SUCCESS Data was written.
795 @retval EFI_UNSUPPORTED Writes to an open directory are not supported.
796 @retval EFI_NO_MEDIA The device has no media.
797 @retval EFI_DEVICE_ERROR The device reported an error.
798 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
799 @retval EFI_WRITE_PROTECTED The device is write-protected.
800 @retval EFI_ACCESS_DENIED The file was open for read only.
801 @retval EFI_VOLUME_FULL The volume is full.
806 IN SHELL_FILE_HANDLE FileHandle
,
807 IN OUT UINTN
*BufferSize
,
811 return (FileFunctionMap
.WriteFile(FileHandle
, BufferSize
, Buffer
));
815 Close an open file handle.
817 This function closes a specified file handle. All "dirty" cached file data is
818 flushed to the device, and the file is closed. In all cases the handle is
821 @param FileHandle the file handle to close.
823 @retval EFI_SUCCESS the file handle was closed sucessfully.
828 IN SHELL_FILE_HANDLE
*FileHandle
831 return (FileFunctionMap
.CloseFile(*FileHandle
));
835 Delete a file and close the handle
837 This function closes and deletes a file. In all cases the file handle is closed.
838 If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
839 returned, but the handle is still closed.
841 @param FileHandle the file handle to delete
843 @retval EFI_SUCCESS the file was closed sucessfully
844 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
846 @retval INVALID_PARAMETER One of the parameters has an invalid value.
851 IN SHELL_FILE_HANDLE
*FileHandle
854 return (FileFunctionMap
.DeleteFile(*FileHandle
));
858 Set the current position in a file.
860 This function sets the current file position for the handle to the position
861 supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only
862 absolute positioning is supported, and seeking past the end of the file is
863 allowed (a subsequent write would grow the file). Seeking to position
864 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
865 If FileHandle is a directory, the only position that may be set is zero. This
866 has the effect of starting the read process of the directory entries over.
868 @param FileHandle The file handle on which the position is being set
869 @param Position Byte position from begining of file
871 @retval EFI_SUCCESS Operation completed sucessfully.
872 @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on
874 @retval INVALID_PARAMETER One of the parameters has an invalid value.
878 ShellSetFilePosition (
879 IN SHELL_FILE_HANDLE FileHandle
,
883 return (FileFunctionMap
.SetFilePosition(FileHandle
, Position
));
887 Gets a file's current position
889 This function retrieves the current file position for the file handle. For
890 directories, the current file position has no meaning outside of the file
891 system driver and as such the operation is not supported. An error is returned
892 if FileHandle is a directory.
894 @param FileHandle The open file handle on which to get the position.
895 @param Position Byte position from begining of file.
897 @retval EFI_SUCCESS the operation completed sucessfully.
898 @retval INVALID_PARAMETER One of the parameters has an invalid value.
899 @retval EFI_UNSUPPORTED the request is not valid on directories.
903 ShellGetFilePosition (
904 IN SHELL_FILE_HANDLE FileHandle
,
908 return (FileFunctionMap
.GetFilePosition(FileHandle
, Position
));
911 Flushes data on a file
913 This function flushes all modified data associated with a file to a device.
915 @param FileHandle The file handle on which to flush data
917 @retval EFI_SUCCESS The data was flushed.
918 @retval EFI_NO_MEDIA The device has no media.
919 @retval EFI_DEVICE_ERROR The device reported an error.
920 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
921 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
922 @retval EFI_ACCESS_DENIED The file was opened for read only.
927 IN SHELL_FILE_HANDLE FileHandle
930 return (FileFunctionMap
.FlushFile(FileHandle
));
934 Retrieves the first file from a directory
936 This function opens a directory and gets the first file's info in the
937 directory. Caller can use ShellFindNextFile() to get other files. When
938 complete the caller is responsible for calling FreePool() on Buffer.
940 @param DirHandle The file handle of the directory to search
941 @param Buffer Pointer to buffer for file's information
943 @retval EFI_SUCCESS Found the first file.
944 @retval EFI_NOT_FOUND Cannot find the directory.
945 @retval EFI_NO_MEDIA The device has no media.
946 @retval EFI_DEVICE_ERROR The device reported an error.
947 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
948 @return Others status of ShellGetFileInfo, ShellSetFilePosition,
954 IN SHELL_FILE_HANDLE DirHandle
,
955 OUT EFI_FILE_INFO
**Buffer
959 // pass to file handle lib
961 return (FileHandleFindFirstFile(DirHandle
, Buffer
));
964 Retrieves the next file in a directory.
966 To use this function, caller must call the ShellFindFirstFile() to get the
967 first file, and then use this function get other files. This function can be
968 called for several times to get each file's information in the directory. If
969 the call of ShellFindNextFile() got the last file in the directory, the next
970 call of this function has no file to get. *NoFile will be set to TRUE and the
971 Buffer memory will be automatically freed.
973 @param DirHandle the file handle of the directory
974 @param Buffer pointer to buffer for file's information
975 @param NoFile pointer to boolean when last file is found
977 @retval EFI_SUCCESS Found the next file, or reached last file
978 @retval EFI_NO_MEDIA The device has no media.
979 @retval EFI_DEVICE_ERROR The device reported an error.
980 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
985 IN SHELL_FILE_HANDLE DirHandle
,
986 OUT EFI_FILE_INFO
*Buffer
,
991 // pass to file handle lib
993 return (FileHandleFindNextFile(DirHandle
, Buffer
, NoFile
));
996 Retrieve the size of a file.
998 if FileHandle is NULL then ASSERT()
999 if Size is NULL then ASSERT()
1001 This function extracts the file size info from the FileHandle's EFI_FILE_INFO
1004 @param FileHandle file handle from which size is retrieved
1005 @param Size pointer to size
1007 @retval EFI_SUCCESS operation was completed sucessfully
1008 @retval EFI_DEVICE_ERROR cannot access the file
1013 IN SHELL_FILE_HANDLE FileHandle
,
1017 return (FileFunctionMap
.GetFileSize(FileHandle
, Size
));
1020 Retrieves the status of the break execution flag
1022 this function is useful to check whether the application is being asked to halt by the shell.
1024 @retval TRUE the execution break is enabled
1025 @retval FALSE the execution break is not enabled
1029 ShellGetExecutionBreakFlag(
1034 // Check for UEFI Shell 2.0 protocols
1036 if (mEfiShellProtocol
!= NULL
) {
1039 // We are using UEFI Shell 2.0; see if the event has been triggered
1041 if (gBS
->CheckEvent(mEfiShellProtocol
->ExecutionBreak
) != EFI_SUCCESS
) {
1048 // using EFI Shell; call the function to check
1050 ASSERT(mEfiShellEnvironment2
!= NULL
);
1051 return (mEfiShellEnvironment2
->GetExecutionBreak());
1054 return the value of an environment variable
1056 this function gets the value of the environment variable set by the
1057 ShellSetEnvironmentVariable function
1059 @param EnvKey The key name of the environment variable.
1061 @retval NULL the named environment variable does not exist.
1062 @return != NULL pointer to the value of the environment variable
1066 ShellGetEnvironmentVariable (
1067 IN CONST CHAR16
*EnvKey
1071 // Check for UEFI Shell 2.0 protocols
1073 if (mEfiShellProtocol
!= NULL
) {
1074 return (mEfiShellProtocol
->GetEnv(EnvKey
));
1078 // ASSERT that we must have EFI shell
1080 ASSERT(mEfiShellEnvironment2
!= NULL
);
1085 return (mEfiShellEnvironment2
->GetEnv((CHAR16
*)EnvKey
));
1088 set the value of an environment variable
1090 This function changes the current value of the specified environment variable. If the
1091 environment variable exists and the Value is an empty string, then the environment
1092 variable is deleted. If the environment variable exists and the Value is not an empty
1093 string, then the value of the environment variable is changed. If the environment
1094 variable does not exist and the Value is an empty string, there is no action. If the
1095 environment variable does not exist and the Value is a non-empty string, then the
1096 environment variable is created and assigned the specified value.
1098 This is not supported pre-UEFI Shell 2.0.
1100 @param EnvKey The key name of the environment variable.
1101 @param EnvVal The Value of the environment variable
1102 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
1104 @retval EFI_SUCCESS the operation was completed sucessfully
1105 @retval EFI_UNSUPPORTED This operation is not allowed in pre UEFI 2.0 Shell environments
1109 ShellSetEnvironmentVariable (
1110 IN CONST CHAR16
*EnvKey
,
1111 IN CONST CHAR16
*EnvVal
,
1116 // Check for UEFI Shell 2.0 protocols
1118 if (mEfiShellProtocol
!= NULL
) {
1119 return (mEfiShellProtocol
->SetEnv(EnvKey
, EnvVal
, Volatile
));
1123 // This feature does not exist under EFI shell
1125 return (EFI_UNSUPPORTED
);
1129 Cause the shell to parse and execute a command line.
1131 This function creates a nested instance of the shell and executes the specified
1132 command (CommandLine) with the specified environment (Environment). Upon return,
1133 the status code returned by the specified command is placed in StatusCode.
1134 If Environment is NULL, then the current environment is used and all changes made
1135 by the commands executed will be reflected in the current environment. If the
1136 Environment is non-NULL, then the changes made will be discarded.
1137 The CommandLine is executed from the current working directory on the current
1140 The EnvironmentVariables and Status parameters are ignored in a pre-UEFI Shell 2.0
1141 environment. The values pointed to by the parameters will be unchanged by the
1142 ShellExecute() function. The Output parameter has no effect in a
1143 UEFI Shell 2.0 environment.
1145 @param[in] ParentHandle The parent image starting the operation.
1146 @param[in] CommandLine The pointer to a NULL terminated command line.
1147 @param[in] Output True to display debug output. False to hide it.
1148 @param[in] EnvironmentVariables Optional pointer to array of environment variables
1149 in the form "x=y". If NULL, the current set is used.
1150 @param[out] Status The status of the run command line.
1152 @retval EFI_SUCCESS The operation completed sucessfully. Status
1153 contains the status code returned.
1154 @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.
1155 @retval EFI_OUT_OF_RESOURCES Out of resources.
1156 @retval EFI_UNSUPPORTED The operation is not allowed.
1161 IN EFI_HANDLE
*ParentHandle
,
1162 IN CHAR16
*CommandLine OPTIONAL
,
1163 IN BOOLEAN Output OPTIONAL
,
1164 IN CHAR16
**EnvironmentVariables OPTIONAL
,
1165 OUT EFI_STATUS
*Status OPTIONAL
1169 // Check for UEFI Shell 2.0 protocols
1171 if (mEfiShellProtocol
!= NULL
) {
1173 // Call UEFI Shell 2.0 version (not using Output parameter)
1175 return (mEfiShellProtocol
->Execute(ParentHandle
,
1177 EnvironmentVariables
,
1181 // ASSERT that we must have EFI shell
1183 ASSERT(mEfiShellEnvironment2
!= NULL
);
1185 // Call EFI Shell version (not using EnvironmentVariables or Status parameters)
1186 // Due to oddity in the EFI shell we want to dereference the ParentHandle here
1188 return (mEfiShellEnvironment2
->Execute(*ParentHandle
,
1193 Retreives the current directory path
1195 If the DeviceName is NULL, it returns the current device's current directory
1196 name. If the DeviceName is not NULL, it returns the current directory name
1199 @param DeviceName the name of the drive to get directory on
1201 @retval NULL the directory does not exist
1202 @return != NULL the directory
1206 ShellGetCurrentDir (
1207 IN CHAR16
* CONST DeviceName OPTIONAL
1211 // Check for UEFI Shell 2.0 protocols
1213 if (mEfiShellProtocol
!= NULL
) {
1214 return (mEfiShellProtocol
->GetCurDir(DeviceName
));
1217 // ASSERT that we must have EFI shell
1219 ASSERT(mEfiShellEnvironment2
!= NULL
);
1220 return (mEfiShellEnvironment2
->CurDir(DeviceName
));
1223 sets (enabled or disabled) the page break mode
1225 when page break mode is enabled the screen will stop scrolling
1226 and wait for operator input before scrolling a subsequent screen.
1228 @param CurrentState TRUE to enable and FALSE to disable
1232 ShellSetPageBreakMode (
1233 IN BOOLEAN CurrentState
1237 // check for enabling
1239 if (CurrentState
!= 0x00) {
1241 // check for UEFI Shell 2.0
1243 if (mEfiShellProtocol
!= NULL
) {
1245 // Enable with UEFI 2.0 Shell
1247 mEfiShellProtocol
->EnablePageBreak();
1251 // ASSERT that must have EFI Shell
1253 ASSERT(mEfiShellEnvironment2
!= NULL
);
1255 // Enable with EFI Shell
1257 mEfiShellEnvironment2
->EnablePageBreak (DEFAULT_INIT_ROW
, DEFAULT_AUTO_LF
);
1262 // check for UEFI Shell 2.0
1264 if (mEfiShellProtocol
!= NULL
) {
1266 // Disable with UEFI 2.0 Shell
1268 mEfiShellProtocol
->DisablePageBreak();
1272 // ASSERT that must have EFI Shell
1274 ASSERT(mEfiShellEnvironment2
!= NULL
);
1276 // Disable with EFI Shell
1278 mEfiShellEnvironment2
->DisablePageBreak ();
1285 /// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.
1286 /// This allows for the struct to be populated.
1293 SHELL_FILE_HANDLE Handle
;
1294 EFI_FILE_INFO
*Info
;
1295 } EFI_SHELL_FILE_INFO_NO_CONST
;
1298 Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.
1300 if OldStyleFileList is NULL then ASSERT()
1302 this function will convert a SHELL_FILE_ARG based list into a callee allocated
1303 EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
1304 the ShellCloseFileMetaArg function.
1306 @param[in] FileList the EFI shell list type
1307 @param[in,out] ListHead the list to add to
1309 @retval the resultant head of the double linked new format list;
1313 InternalShellConvertFileListType (
1314 IN LIST_ENTRY
*FileList
,
1315 IN OUT LIST_ENTRY
*ListHead
1318 SHELL_FILE_ARG
*OldInfo
;
1320 EFI_SHELL_FILE_INFO_NO_CONST
*NewInfo
;
1325 ASSERT(FileList
!= NULL
);
1326 ASSERT(ListHead
!= NULL
);
1329 // enumerate through each member of the old list and copy
1331 for (Link
= FileList
->ForwardLink
; Link
!= FileList
; Link
= Link
->ForwardLink
) {
1332 OldInfo
= CR (Link
, SHELL_FILE_ARG
, Link
, SHELL_FILE_ARG_SIGNATURE
);
1333 ASSERT(OldInfo
!= NULL
);
1336 // Skip ones that failed to open...
1338 if (OldInfo
->Status
!= EFI_SUCCESS
) {
1343 // make sure the old list was valid
1345 ASSERT(OldInfo
->Info
!= NULL
);
1346 ASSERT(OldInfo
->FullName
!= NULL
);
1347 ASSERT(OldInfo
->FileName
!= NULL
);
1350 // allocate a new EFI_SHELL_FILE_INFO object
1352 NewInfo
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1353 ASSERT(NewInfo
!= NULL
);
1354 if (NewInfo
== NULL
) {
1359 // copy the simple items
1361 NewInfo
->Handle
= OldInfo
->Handle
;
1362 NewInfo
->Status
= OldInfo
->Status
;
1364 // old shell checks for 0 not NULL
1365 OldInfo
->Handle
= 0;
1368 // allocate new space to copy strings and structure
1370 NewInfo
->FullName
= AllocateZeroPool(StrSize(OldInfo
->FullName
));
1371 NewInfo
->FileName
= AllocateZeroPool(StrSize(OldInfo
->FileName
));
1372 NewInfo
->Info
= AllocateZeroPool((UINTN
)OldInfo
->Info
->Size
);
1375 // make sure all the memory allocations were sucessful
1377 ASSERT(NewInfo
->FullName
!= NULL
);
1378 ASSERT(NewInfo
->FileName
!= NULL
);
1379 ASSERT(NewInfo
->Info
!= NULL
);
1382 // Copt the strings and structure
1384 StrCpy(NewInfo
->FullName
, OldInfo
->FullName
);
1385 StrCpy(NewInfo
->FileName
, OldInfo
->FileName
);
1386 gBS
->CopyMem (NewInfo
->Info
, OldInfo
->Info
, (UINTN
)OldInfo
->Info
->Size
);
1389 // add that to the list
1391 InsertTailList(ListHead
, &NewInfo
->Link
);
1396 Opens a group of files based on a path.
1398 This function uses the Arg to open all the matching files. Each matched
1399 file has a SHELL_FILE_ARG structure to record the file information. These
1400 structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
1401 structures from ListHead to access each file. This function supports wildcards
1402 and will process '?' and '*' as such. the list must be freed with a call to
1403 ShellCloseFileMetaArg().
1405 If you are NOT appending to an existing list *ListHead must be NULL. If
1406 *ListHead is NULL then it must be callee freed.
1408 @param Arg pointer to path string
1409 @param OpenMode mode to open files with
1410 @param ListHead head of linked list of results
1412 @retval EFI_SUCCESS the operation was sucessful and the list head
1413 contains the list of opened files
1414 @return != EFI_SUCCESS the operation failed
1416 @sa InternalShellConvertFileListType
1420 ShellOpenFileMetaArg (
1423 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1427 LIST_ENTRY mOldStyleFileList
;
1430 // ASSERT that Arg and ListHead are not NULL
1432 ASSERT(Arg
!= NULL
);
1433 ASSERT(ListHead
!= NULL
);
1436 // Check for UEFI Shell 2.0 protocols
1438 if (mEfiShellProtocol
!= NULL
) {
1439 if (*ListHead
== NULL
) {
1440 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1441 if (*ListHead
== NULL
) {
1442 return (EFI_OUT_OF_RESOURCES
);
1444 InitializeListHead(&((*ListHead
)->Link
));
1446 Status
= mEfiShellProtocol
->OpenFileList(Arg
,
1449 if (EFI_ERROR(Status
)) {
1450 mEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1452 Status
= mEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1454 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1455 FreePool(*ListHead
);
1457 return (EFI_NOT_FOUND
);
1463 // ASSERT that we must have EFI shell
1465 ASSERT(mEfiShellEnvironment2
!= NULL
);
1468 // make sure the list head is initialized
1470 InitializeListHead(&mOldStyleFileList
);
1473 // Get the EFI Shell list of files
1475 Status
= mEfiShellEnvironment2
->FileMetaArg(Arg
, &mOldStyleFileList
);
1476 if (EFI_ERROR(Status
)) {
1481 if (*ListHead
== NULL
) {
1482 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1483 if (*ListHead
== NULL
) {
1484 return (EFI_OUT_OF_RESOURCES
);
1486 InitializeListHead(&((*ListHead
)->Link
));
1490 // Convert that to equivalent of UEFI Shell 2.0 structure
1492 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1495 // Free the EFI Shell version that was converted.
1497 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1499 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1500 FreePool(*ListHead
);
1502 Status
= EFI_NOT_FOUND
;
1508 Free the linked list returned from ShellOpenFileMetaArg.
1510 if ListHead is NULL then ASSERT().
1512 @param ListHead the pointer to free.
1514 @retval EFI_SUCCESS the operation was sucessful.
1518 ShellCloseFileMetaArg (
1519 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1525 // ASSERT that ListHead is not NULL
1527 ASSERT(ListHead
!= NULL
);
1530 // Check for UEFI Shell 2.0 protocols
1532 if (mEfiShellProtocol
!= NULL
) {
1533 return (mEfiShellProtocol
->FreeFileList(ListHead
));
1536 // Since this is EFI Shell version we need to free our internally made copy
1539 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1540 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1541 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1542 RemoveEntryList(Node
);
1543 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1544 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1545 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1546 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1547 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1554 Find a file by searching the CWD and then the path.
1556 If FileName is NULL then ASSERT.
1558 If the return value is not NULL then the memory must be caller freed.
1560 @param FileName Filename string.
1562 @retval NULL the file was not found
1563 @return !NULL the full path to the file.
1568 IN CONST CHAR16
*FileName
1572 SHELL_FILE_HANDLE Handle
;
1576 CONST CHAR16
*Walker
;
1583 // First make sure its not an absolute path.
1585 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1586 if (!EFI_ERROR(Status
)){
1587 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1588 ASSERT(RetVal
== NULL
);
1589 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1590 ShellCloseFile(&Handle
);
1593 ShellCloseFile(&Handle
);
1597 Path
= ShellGetEnvironmentVariable(L
"cwd");
1599 Size
= StrSize(Path
);
1600 Size
+= StrSize(FileName
);
1601 TestPath
= AllocateZeroPool(Size
);
1602 ASSERT(TestPath
!= NULL
);
1603 if (TestPath
== NULL
) {
1606 StrCpy(TestPath
, Path
);
1607 StrCat(TestPath
, FileName
);
1608 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1609 if (!EFI_ERROR(Status
)){
1610 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1611 ASSERT(RetVal
== NULL
);
1612 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1613 ShellCloseFile(&Handle
);
1617 ShellCloseFile(&Handle
);
1622 Path
= ShellGetEnvironmentVariable(L
"path");
1624 Size
= StrSize(Path
)+sizeof(CHAR16
);
1625 Size
+= StrSize(FileName
);
1626 TestPath
= AllocateZeroPool(Size
);
1627 if (TestPath
== NULL
) {
1630 Walker
= (CHAR16
*)Path
;
1632 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1633 if (TestPath
!= NULL
) {
1634 TempChar
= StrStr(TestPath
, L
";");
1635 if (TempChar
!= NULL
) {
1636 *TempChar
= CHAR_NULL
;
1638 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1639 StrCat(TestPath
, L
"\\");
1641 if (FileName
[0] == L
'\\') {
1644 StrCat(TestPath
, FileName
);
1645 if (StrStr(Walker
, L
";") != NULL
) {
1646 Walker
= StrStr(Walker
, L
";") + 1;
1650 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1651 if (!EFI_ERROR(Status
)){
1652 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1653 ASSERT(RetVal
== NULL
);
1654 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1655 ShellCloseFile(&Handle
);
1658 ShellCloseFile(&Handle
);
1662 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1669 Find a file by searching the CWD and then the path with a variable set of file
1670 extensions. If the file is not found it will append each extension in the list
1671 in the order provided and return the first one that is successful.
1673 If FileName is NULL, then ASSERT.
1674 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1676 If the return value is not NULL then the memory must be caller freed.
1678 @param[in] FileName Filename string.
1679 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1681 @retval NULL The file was not found.
1682 @retval !NULL The path to the file.
1686 ShellFindFilePathEx (
1687 IN CONST CHAR16
*FileName
,
1688 IN CONST CHAR16
*FileExtension
1693 CONST CHAR16
*ExtensionWalker
;
1698 ASSERT(FileName
!= NULL
);
1699 if (FileExtension
== NULL
) {
1700 return (ShellFindFilePath(FileName
));
1702 RetVal
= ShellFindFilePath(FileName
);
1703 if (RetVal
!= NULL
) {
1706 Size
= StrSize(FileName
);
1707 Size
+= StrSize(FileExtension
);
1708 TestPath
= AllocateZeroPool(Size
);
1709 ASSERT(TestPath
!= NULL
);
1710 if (TestPath
== NULL
) {
1713 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1714 StrCpy(TestPath
, FileName
);
1715 if (ExtensionWalker
!= NULL
) {
1716 StrCat(TestPath
, ExtensionWalker
);
1718 TempChar
= StrStr(TestPath
, L
";");
1719 if (TempChar
!= NULL
) {
1720 *TempChar
= CHAR_NULL
;
1722 RetVal
= ShellFindFilePath(TestPath
);
1723 if (RetVal
!= NULL
) {
1726 ASSERT(ExtensionWalker
!= NULL
);
1727 TempChar2
= StrStr(ExtensionWalker
, L
";");
1736 SHELL_PARAM_TYPE Type
;
1738 UINTN OriginalPosition
;
1739 } SHELL_PARAM_PACKAGE
;
1742 Checks the list of valid arguments and returns TRUE if the item was found. If the
1743 return value is TRUE then the type parameter is set also.
1745 if CheckList is NULL then ASSERT();
1746 if Name is NULL then ASSERT();
1747 if Type is NULL then ASSERT();
1749 @param Name pointer to Name of parameter found
1750 @param CheckList List to check against
1751 @param Type pointer to type of parameter if it was found
1753 @retval TRUE the Parameter was found. Type is valid.
1754 @retval FALSE the Parameter was not found. Type is not valid.
1758 InternalIsOnCheckList (
1759 IN CONST CHAR16
*Name
,
1760 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1761 OUT SHELL_PARAM_TYPE
*Type
1764 SHELL_PARAM_ITEM
*TempListItem
;
1768 // ASSERT that all 3 pointer parameters aren't NULL
1770 ASSERT(CheckList
!= NULL
);
1771 ASSERT(Type
!= NULL
);
1772 ASSERT(Name
!= NULL
);
1775 // question mark and page break mode are always supported
1777 if ((StrCmp(Name
, L
"-?") == 0) ||
1778 (StrCmp(Name
, L
"-b") == 0)
1785 // Enumerate through the list
1787 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1789 // If the Type is TypeStart only check the first characters of the passed in param
1790 // If it matches set the type and return TRUE
1792 if (TempListItem
->Type
== TypeStart
) {
1793 if (StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1794 *Type
= TempListItem
->Type
;
1798 TempString
= StrnCatGrow(&TempString
, NULL
, Name
, StrLen(TempListItem
->Name
));
1799 if (TempString
!= NULL
) {
1800 if (StringNoCaseCompare(&TempString
, &TempListItem
->Name
) == 0) {
1801 *Type
= TempListItem
->Type
;
1802 FreePool(TempString
);
1805 FreePool(TempString
);
1807 } else if (StringNoCaseCompare(&Name
, &TempListItem
->Name
) == 0) {
1808 *Type
= TempListItem
->Type
;
1816 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1818 @param[in] Name pointer to Name of parameter found
1819 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1821 @retval TRUE the Parameter is a flag.
1822 @retval FALSE the Parameter not a flag.
1827 IN CONST CHAR16
*Name
,
1828 IN BOOLEAN AlwaysAllowNumbers
1832 // ASSERT that Name isn't NULL
1834 ASSERT(Name
!= NULL
);
1837 // If we accept numbers then dont return TRUE. (they will be values)
1839 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && ShellIsHexaDecimalDigitCharacter(Name
[1])) && AlwaysAllowNumbers
) {
1844 // If the Name has a /, +, or - as the first character return TRUE
1846 if ((Name
[0] == L
'/') ||
1847 (Name
[0] == L
'-') ||
1856 Checks the command line arguments passed against the list of valid ones.
1858 If no initialization is required, then return RETURN_SUCCESS.
1860 @param[in] CheckList pointer to list of parameters to check
1861 @param[out] CheckPackage pointer to pointer to list checked values
1862 @param[out] ProblemParam optional pointer to pointer to unicode string for
1863 the paramater that caused failure. If used then the
1864 caller is responsible for freeing the memory.
1865 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1866 @param[in] Argv pointer to array of parameters
1867 @param[in] Argc Count of parameters in Argv
1868 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1870 @retval EFI_SUCCESS The operation completed sucessfully.
1871 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1872 @retval EFI_INVALID_PARAMETER A parameter was invalid
1873 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1874 duplicated. the duplicated command line argument
1875 was returned in ProblemParam if provided.
1876 @retval EFI_NOT_FOUND a argument required a value that was missing.
1877 the invalid command line argument was returned in
1878 ProblemParam if provided.
1882 InternalCommandLineParse (
1883 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1884 OUT LIST_ENTRY
**CheckPackage
,
1885 OUT CHAR16
**ProblemParam OPTIONAL
,
1886 IN BOOLEAN AutoPageBreak
,
1887 IN CONST CHAR16
**Argv
,
1889 IN BOOLEAN AlwaysAllowNumbers
1893 SHELL_PARAM_TYPE CurrentItemType
;
1894 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
1898 CONST CHAR16
*TempPointer
;
1900 CurrentItemPackage
= NULL
;
1906 // If there is only 1 item we dont need to do anything
1909 *CheckPackage
= NULL
;
1910 return (EFI_SUCCESS
);
1916 ASSERT(CheckList
!= NULL
);
1917 ASSERT(Argv
!= NULL
);
1920 // initialize the linked list
1922 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
1923 InitializeListHead(*CheckPackage
);
1926 // loop through each of the arguments
1928 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
1929 if (Argv
[LoopCounter
] == NULL
) {
1931 // do nothing for NULL argv
1933 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
1935 // We might have leftover if last parameter didnt have optional value
1937 if (GetItemValue
!= 0) {
1939 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1944 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
1945 ASSERT(CurrentItemPackage
!= NULL
);
1946 CurrentItemPackage
->Name
= AllocateZeroPool(StrSize(Argv
[LoopCounter
]));
1947 ASSERT(CurrentItemPackage
->Name
!= NULL
);
1948 StrCpy(CurrentItemPackage
->Name
, Argv
[LoopCounter
]);
1949 CurrentItemPackage
->Type
= CurrentItemType
;
1950 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
1951 CurrentItemPackage
->Value
= NULL
;
1954 // Does this flag require a value
1956 switch (CurrentItemPackage
->Type
) {
1958 // possibly trigger the next loop(s) to populate the value of this item
1964 case TypeDoubleValue
:
1969 GetItemValue
= (UINTN
)(-1);
1974 // this item has no value expected; we are done
1976 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1977 ASSERT(GetItemValue
== 0);
1980 } else if (GetItemValue
!= 0 && !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
)) {
1981 ASSERT(CurrentItemPackage
!= NULL
);
1983 // get the item VALUE for a previous flag
1985 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
), CurrentItemPackage
->Value
);
1986 ASSERT(CurrentItemPackage
->Value
!= NULL
);
1987 if (ValueSize
== 0) {
1988 StrCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
1990 StrCat(CurrentItemPackage
->Value
, L
" ");
1991 StrCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
1993 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
1995 if (GetItemValue
== 0) {
1996 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1998 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
) ){ //|| ProblemParam == NULL) {
2000 // add this one as a non-flag
2003 TempPointer
= Argv
[LoopCounter
];
2004 if ((*TempPointer
== L
'^' && *(TempPointer
+1) == L
'-')
2005 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'/')
2006 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'+')
2010 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2011 ASSERT(CurrentItemPackage
!= NULL
);
2012 CurrentItemPackage
->Name
= NULL
;
2013 CurrentItemPackage
->Type
= TypePosition
;
2014 CurrentItemPackage
->Value
= AllocateZeroPool(StrSize(TempPointer
));
2015 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2016 StrCpy(CurrentItemPackage
->Value
, TempPointer
);
2017 CurrentItemPackage
->OriginalPosition
= Count
++;
2018 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2021 // this was a non-recognised flag... error!
2023 if (ProblemParam
!= NULL
) {
2024 *ProblemParam
= AllocateZeroPool(StrSize(Argv
[LoopCounter
]));
2025 ASSERT(*ProblemParam
!= NULL
);
2026 StrCpy(*ProblemParam
, Argv
[LoopCounter
]);
2028 ShellCommandLineFreeVarList(*CheckPackage
);
2029 *CheckPackage
= NULL
;
2030 return (EFI_VOLUME_CORRUPTED
);
2033 if (GetItemValue
!= 0) {
2035 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2038 // support for AutoPageBreak
2040 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2041 ShellSetPageBreakMode(TRUE
);
2043 return (EFI_SUCCESS
);
2047 Checks the command line arguments passed against the list of valid ones.
2048 Optionally removes NULL values first.
2050 If no initialization is required, then return RETURN_SUCCESS.
2052 @param[in] CheckList The pointer to list of parameters to check.
2053 @param[out] CheckPackage The package of checked values.
2054 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2055 the paramater that caused failure.
2056 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2057 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2059 @retval EFI_SUCCESS The operation completed sucessfully.
2060 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2061 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2062 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2063 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2064 of the command line arguments was returned in
2065 ProblemParam if provided.
2066 @retval EFI_NOT_FOUND A argument required a value that was missing.
2067 The invalid command line argument was returned in
2068 ProblemParam if provided.
2072 ShellCommandLineParseEx (
2073 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2074 OUT LIST_ENTRY
**CheckPackage
,
2075 OUT CHAR16
**ProblemParam OPTIONAL
,
2076 IN BOOLEAN AutoPageBreak
,
2077 IN BOOLEAN AlwaysAllowNumbers
2081 // ASSERT that CheckList and CheckPackage aren't NULL
2083 ASSERT(CheckList
!= NULL
);
2084 ASSERT(CheckPackage
!= NULL
);
2087 // Check for UEFI Shell 2.0 protocols
2089 if (mEfiShellParametersProtocol
!= NULL
) {
2090 return (InternalCommandLineParse(CheckList
,
2094 (CONST CHAR16
**) mEfiShellParametersProtocol
->Argv
,
2095 mEfiShellParametersProtocol
->Argc
,
2096 AlwaysAllowNumbers
));
2100 // ASSERT That EFI Shell is not required
2102 ASSERT (mEfiShellInterface
!= NULL
);
2103 return (InternalCommandLineParse(CheckList
,
2107 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2108 mEfiShellInterface
->Argc
,
2109 AlwaysAllowNumbers
));
2113 Frees shell variable list that was returned from ShellCommandLineParse.
2115 This function will free all the memory that was used for the CheckPackage
2116 list of postprocessed shell arguments.
2118 this function has no return value.
2120 if CheckPackage is NULL, then return
2122 @param CheckPackage the list to de-allocate
2126 ShellCommandLineFreeVarList (
2127 IN LIST_ENTRY
*CheckPackage
2133 // check for CheckPackage == NULL
2135 if (CheckPackage
== NULL
) {
2140 // for each node in the list
2142 for ( Node
= GetFirstNode(CheckPackage
)
2143 ; !IsListEmpty(CheckPackage
)
2144 ; Node
= GetFirstNode(CheckPackage
)
2147 // Remove it from the list
2149 RemoveEntryList(Node
);
2152 // if it has a name free the name
2154 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2155 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2159 // if it has a value free the value
2161 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2162 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2166 // free the node structure
2168 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2171 // free the list head node
2173 FreePool(CheckPackage
);
2176 Checks for presence of a flag parameter
2178 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2180 if CheckPackage is NULL then return FALSE.
2181 if KeyString is NULL then ASSERT()
2183 @param CheckPackage The package of parsed command line arguments
2184 @param KeyString the Key of the command line argument to check for
2186 @retval TRUE the flag is on the command line
2187 @retval FALSE the flag is not on the command line
2191 ShellCommandLineGetFlag (
2192 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2193 IN CONST CHAR16
* CONST KeyString
2200 // ASSERT that both CheckPackage and KeyString aren't NULL
2202 ASSERT(KeyString
!= NULL
);
2205 // return FALSE for no package
2207 if (CheckPackage
== NULL
) {
2212 // enumerate through the list of parametrs
2214 for ( Node
= GetFirstNode(CheckPackage
)
2215 ; !IsNull (CheckPackage
, Node
)
2216 ; Node
= GetNextNode(CheckPackage
, Node
)
2219 // If the Name matches, return TRUE (and there may be NULL name)
2221 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2223 // If Type is TypeStart then only compare the begining of the strings
2225 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2226 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2230 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2231 if (TempString
!= NULL
) {
2232 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2233 FreePool(TempString
);
2236 FreePool(TempString
);
2238 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2246 Returns value from command line argument.
2248 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2250 If CheckPackage is NULL, then return NULL.
2252 @param[in] CheckPackage The package of parsed command line arguments.
2253 @param[in] KeyString The Key of the command line argument to check for.
2255 @retval NULL The flag is not on the command line.
2256 @retval !=NULL The pointer to unicode string of the value.
2260 ShellCommandLineGetValue (
2261 IN CONST LIST_ENTRY
*CheckPackage
,
2262 IN CHAR16
*KeyString
2269 // check for CheckPackage == NULL
2271 if (CheckPackage
== NULL
) {
2276 // enumerate through the list of parametrs
2278 for ( Node
= GetFirstNode(CheckPackage
)
2279 ; !IsNull (CheckPackage
, Node
)
2280 ; Node
= GetNextNode(CheckPackage
, Node
)
2283 // If the Name matches, return TRUE (and there may be NULL name)
2285 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2287 // If Type is TypeStart then only compare the begining of the strings
2289 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2290 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2291 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2294 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2295 if (TempString
!= NULL
) {
2296 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2297 FreePool(TempString
);
2298 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2300 FreePool(TempString
);
2302 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2303 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2311 Returns raw value from command line argument.
2313 Raw value parameters are in the form of "value" in a specific position in the list.
2315 If CheckPackage is NULL, then return NULL.
2317 @param[in] CheckPackage The package of parsed command line arguments.
2318 @param[in] Position The position of the value.
2320 @retval NULL The flag is not on the command line.
2321 @retval !=NULL The pointer to unicode string of the value.
2325 ShellCommandLineGetRawValue (
2326 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2333 // check for CheckPackage == NULL
2335 if (CheckPackage
== NULL
) {
2340 // enumerate through the list of parametrs
2342 for ( Node
= GetFirstNode(CheckPackage
)
2343 ; !IsNull (CheckPackage
, Node
)
2344 ; Node
= GetNextNode(CheckPackage
, Node
)
2347 // If the position matches, return the value
2349 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2350 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2357 returns the number of command line value parameters that were parsed.
2359 this will not include flags.
2361 @param[in] CheckPackage The package of parsed command line arguments.
2363 @retval (UINTN)-1 No parsing has ocurred
2364 @return other The number of value parameters found
2368 ShellCommandLineGetCount(
2369 IN CONST LIST_ENTRY
*CheckPackage
2375 if (CheckPackage
== NULL
) {
2378 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2379 ; !IsNull (CheckPackage
, Node1
)
2380 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2382 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2390 Determins if a parameter is duplicated.
2392 If Param is not NULL then it will point to a callee allocated string buffer
2393 with the parameter value if a duplicate is found.
2395 If CheckPackage is NULL, then ASSERT.
2397 @param[in] CheckPackage The package of parsed command line arguments.
2398 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2400 @retval EFI_SUCCESS No parameters were duplicated.
2401 @retval EFI_DEVICE_ERROR A duplicate was found.
2405 ShellCommandLineCheckDuplicate (
2406 IN CONST LIST_ENTRY
*CheckPackage
,
2413 ASSERT(CheckPackage
!= NULL
);
2415 for ( Node1
= GetFirstNode(CheckPackage
)
2416 ; !IsNull (CheckPackage
, Node1
)
2417 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2419 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2420 ; !IsNull (CheckPackage
, Node2
)
2421 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2423 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) {
2424 if (Param
!= NULL
) {
2426 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2428 return (EFI_DEVICE_ERROR
);
2432 return (EFI_SUCCESS
);
2436 This is a find and replace function. Upon successful return the NewString is a copy of
2437 SourceString with each instance of FindTarget replaced with ReplaceWith.
2439 If SourceString and NewString overlap the behavior is undefined.
2441 If the string would grow bigger than NewSize it will halt and return error.
2443 @param[in] SourceString The string with source buffer.
2444 @param[in,out] NewString The string with resultant buffer.
2445 @param[in] NewSize The size in bytes of NewString.
2446 @param[in] FindTarget The string to look for.
2447 @param[in] ReplaceWith The string to replace FindTarget with.
2448 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2449 immediately before it.
2450 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2452 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2453 @retval EFI_INVALID_PARAMETER NewString was NULL.
2454 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2455 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2456 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2457 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2458 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2459 the new string (truncation occurred).
2460 @retval EFI_SUCCESS The string was successfully copied with replacement.
2464 ShellCopySearchAndReplace(
2465 IN CHAR16 CONST
*SourceString
,
2466 IN OUT CHAR16
*NewString
,
2468 IN CONST CHAR16
*FindTarget
,
2469 IN CONST CHAR16
*ReplaceWith
,
2470 IN CONST BOOLEAN SkipPreCarrot
,
2471 IN CONST BOOLEAN ParameterReplacing
2477 if ( (SourceString
== NULL
)
2478 || (NewString
== NULL
)
2479 || (FindTarget
== NULL
)
2480 || (ReplaceWith
== NULL
)
2481 || (StrLen(FindTarget
) < 1)
2482 || (StrLen(SourceString
) < 1)
2484 return (EFI_INVALID_PARAMETER
);
2487 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2488 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2490 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2491 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2493 if (Replace
== NULL
) {
2494 return (EFI_OUT_OF_RESOURCES
);
2496 NewString
= SetMem16(NewString
, NewSize
, CHAR_NULL
);
2497 while (*SourceString
!= CHAR_NULL
) {
2499 // if we find the FindTarget and either Skip == FALSE or Skip and we
2500 // dont have a carrot do a replace...
2502 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2503 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2505 SourceString
+= StrLen(FindTarget
);
2506 Size
= StrSize(NewString
);
2507 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2509 return (EFI_BUFFER_TOO_SMALL
);
2511 StrCat(NewString
, Replace
);
2513 Size
= StrSize(NewString
);
2514 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2516 return (EFI_BUFFER_TOO_SMALL
);
2518 StrnCat(NewString
, SourceString
, 1);
2523 return (EFI_SUCCESS
);
2527 Internal worker function to output a string.
2529 This function will output a string to the correct StdOut.
2531 @param[in] String The string to print out.
2533 @retval EFI_SUCCESS The operation was sucessful.
2534 @retval !EFI_SUCCESS The operation failed.
2539 IN CONST CHAR16
*String
2543 Size
= StrSize(String
) - sizeof(CHAR16
);
2545 return (EFI_SUCCESS
);
2547 if (mEfiShellParametersProtocol
!= NULL
) {
2548 return (mEfiShellProtocol
->WriteFile(mEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2550 if (mEfiShellInterface
!= NULL
) {
2552 // Divide in half for old shell. Must be string length not size.
2555 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2558 return (EFI_UNSUPPORTED
);
2562 Print at a specific location on the screen.
2564 This function will move the cursor to a given screen location and print the specified string
2566 If -1 is specified for either the Row or Col the current screen location for BOTH
2569 if either Row or Col is out of range for the current console, then ASSERT
2570 if Format is NULL, then ASSERT
2572 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2573 the following additional flags:
2574 %N - Set output attribute to normal
2575 %H - Set output attribute to highlight
2576 %E - Set output attribute to error
2577 %B - Set output attribute to blue color
2578 %V - Set output attribute to green color
2580 Note: The background color is controlled by the shell command cls.
2582 @param[in] Col the column to print at
2583 @param[in] Row the row to print at
2584 @param[in] Format the format string
2585 @param[in] Marker the marker for the variable argument list
2587 @return EFI_SUCCESS The operation was successful.
2588 @return EFI_DEVICE_ERROR The console device reported an error.
2592 InternalShellPrintWorker(
2593 IN INT32 Col OPTIONAL
,
2594 IN INT32 Row OPTIONAL
,
2595 IN CONST CHAR16
*Format
,
2600 CHAR16
*ResumeLocation
;
2601 CHAR16
*FormatWalker
;
2602 UINTN OriginalAttribute
;
2603 CHAR16
*mPostReplaceFormat
;
2604 CHAR16
*mPostReplaceFormat2
;
2606 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2607 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2609 if (mPostReplaceFormat
== NULL
|| mPostReplaceFormat2
== NULL
) {
2610 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2611 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2612 return (EFI_OUT_OF_RESOURCES
);
2615 Status
= EFI_SUCCESS
;
2616 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2619 // Back and forth each time fixing up 1 of our flags...
2621 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2622 ASSERT_EFI_ERROR(Status
);
2623 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2624 ASSERT_EFI_ERROR(Status
);
2625 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2626 ASSERT_EFI_ERROR(Status
);
2627 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2628 ASSERT_EFI_ERROR(Status
);
2629 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2630 ASSERT_EFI_ERROR(Status
);
2633 // Use the last buffer from replacing to print from...
2635 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2637 if (Col
!= -1 && Row
!= -1) {
2638 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2641 FormatWalker
= mPostReplaceFormat2
;
2642 while (*FormatWalker
!= CHAR_NULL
) {
2644 // Find the next attribute change request
2646 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2647 if (ResumeLocation
!= NULL
) {
2648 *ResumeLocation
= CHAR_NULL
;
2651 // print the current FormatWalker string
2653 if (StrLen(FormatWalker
)>0) {
2654 Status
= InternalPrintTo(FormatWalker
);
2655 if (EFI_ERROR(Status
)) {
2661 // update the attribute
2663 if (ResumeLocation
!= NULL
) {
2664 switch (*(ResumeLocation
+1)) {
2666 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2669 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2672 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2675 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2678 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2682 // Print a simple '%' symbol
2684 Status
= InternalPrintTo(L
"%");
2685 if (EFI_ERROR(Status
)) {
2688 ResumeLocation
= ResumeLocation
- 1;
2693 // reset to normal now...
2699 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2701 FormatWalker
= ResumeLocation
+ 2;
2704 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2706 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2707 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2712 Print at a specific location on the screen.
2714 This function will move the cursor to a given screen location and print the specified string.
2716 If -1 is specified for either the Row or Col the current screen location for BOTH
2719 If either Row or Col is out of range for the current console, then ASSERT.
2720 If Format is NULL, then ASSERT.
2722 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2723 the following additional flags:
2724 %N - Set output attribute to normal
2725 %H - Set output attribute to highlight
2726 %E - Set output attribute to error
2727 %B - Set output attribute to blue color
2728 %V - Set output attribute to green color
2730 Note: The background color is controlled by the shell command cls.
2732 @param[in] Col the column to print at
2733 @param[in] Row the row to print at
2734 @param[in] Format the format string
2735 @param[in] ... The variable argument list.
2737 @return EFI_SUCCESS The printing was successful.
2738 @return EFI_DEVICE_ERROR The console device reported an error.
2743 IN INT32 Col OPTIONAL
,
2744 IN INT32 Row OPTIONAL
,
2745 IN CONST CHAR16
*Format
,
2751 if (Format
== NULL
) {
2752 return (EFI_INVALID_PARAMETER
);
2754 VA_START (Marker
, Format
);
2755 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2761 Print at a specific location on the screen.
2763 This function will move the cursor to a given screen location and print the specified string.
2765 If -1 is specified for either the Row or Col the current screen location for BOTH
2768 If either Row or Col is out of range for the current console, then ASSERT.
2769 If Format is NULL, then ASSERT.
2771 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2772 the following additional flags:
2773 %N - Set output attribute to normal.
2774 %H - Set output attribute to highlight.
2775 %E - Set output attribute to error.
2776 %B - Set output attribute to blue color.
2777 %V - Set output attribute to green color.
2779 Note: The background color is controlled by the shell command cls.
2781 @param[in] Col The column to print at.
2782 @param[in] Row The row to print at.
2783 @param[in] Language The language of the string to retrieve. If this parameter
2784 is NULL, then the current platform language is used.
2785 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2786 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2787 @param[in] ... The variable argument list.
2789 @return EFI_SUCCESS The printing was successful.
2790 @return EFI_DEVICE_ERROR The console device reported an error.
2795 IN INT32 Col OPTIONAL
,
2796 IN INT32 Row OPTIONAL
,
2797 IN CONST CHAR8
*Language OPTIONAL
,
2798 IN CONST EFI_STRING_ID HiiFormatStringId
,
2799 IN CONST EFI_HANDLE HiiFormatHandle
,
2804 CHAR16
*HiiFormatString
;
2807 VA_START (Marker
, HiiFormatHandle
);
2808 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2809 ASSERT(HiiFormatString
!= NULL
);
2811 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2813 SHELL_FREE_NON_NULL(HiiFormatString
);
2820 Function to determine if a given filename represents a file or a directory.
2822 @param[in] DirName Path to directory to test.
2824 @retval EFI_SUCCESS The Path represents a directory
2825 @retval EFI_NOT_FOUND The Path does not represent a directory
2826 @return other The path failed to open
2831 IN CONST CHAR16
*DirName
2835 SHELL_FILE_HANDLE Handle
;
2836 CHAR16
*TempLocation
;
2837 CHAR16
*TempLocation2
;
2839 ASSERT(DirName
!= NULL
);
2842 TempLocation
= NULL
;
2844 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
2845 if (EFI_ERROR(Status
)) {
2847 // try good logic first.
2849 if (mEfiShellProtocol
!= NULL
) {
2850 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
2851 TempLocation2
= StrStr(TempLocation
, L
":");
2852 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
2853 *(TempLocation2
+1) = CHAR_NULL
;
2855 if (mEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
2856 FreePool(TempLocation
);
2857 return (EFI_SUCCESS
);
2859 FreePool(TempLocation
);
2862 // probably a map name?!?!!?
2864 TempLocation
= StrStr(DirName
, L
"\\");
2865 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
2866 return (EFI_SUCCESS
);
2872 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
2873 ShellCloseFile(&Handle
);
2874 return (EFI_SUCCESS
);
2876 ShellCloseFile(&Handle
);
2877 return (EFI_NOT_FOUND
);
2881 Function to determine if a given filename represents a file.
2883 @param[in] Name Path to file to test.
2885 @retval EFI_SUCCESS The Path represents a file.
2886 @retval EFI_NOT_FOUND The Path does not represent a file.
2887 @retval other The path failed to open.
2892 IN CONST CHAR16
*Name
2896 SHELL_FILE_HANDLE Handle
;
2898 ASSERT(Name
!= NULL
);
2902 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
2903 if (EFI_ERROR(Status
)) {
2907 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
2908 ShellCloseFile(&Handle
);
2909 return (EFI_SUCCESS
);
2911 ShellCloseFile(&Handle
);
2912 return (EFI_NOT_FOUND
);
2916 Function to determine if a given filename represents a file.
2918 This will search the CWD and then the Path.
2920 If Name is NULL, then ASSERT.
2922 @param[in] Name Path to file to test.
2924 @retval EFI_SUCCESS The Path represents a file.
2925 @retval EFI_NOT_FOUND The Path does not represent a file.
2926 @retval other The path failed to open.
2931 IN CONST CHAR16
*Name
2937 if (!EFI_ERROR(ShellIsFile(Name
))) {
2938 return (EFI_SUCCESS
);
2941 NewName
= ShellFindFilePath(Name
);
2942 if (NewName
== NULL
) {
2943 return (EFI_NOT_FOUND
);
2945 Status
= ShellIsFile(NewName
);
2951 Function to determine whether a string is decimal or hex representation of a number
2952 and return the number converted from the string.
2954 @param[in] String String representation of a number
2957 @retval (UINTN)(-1) An error ocurred.
2962 IN CONST CHAR16
*String
2970 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, TRUE
)) {
2974 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, Hex
, TRUE
))) {
2975 return ((UINTN
)RetVal
);
2977 return ((UINTN
)(-1));
2981 Safely append with automatic string resizing given length of Destination and
2982 desired length of copy from Source.
2984 append the first D characters of Source to the end of Destination, where D is
2985 the lesser of Count and the StrLen() of Source. If appending those D characters
2986 will fit within Destination (whose Size is given as CurrentSize) and
2987 still leave room for a NULL terminator, then those characters are appended,
2988 starting at the original terminating NULL of Destination, and a new terminating
2991 If appending D characters onto Destination will result in a overflow of the size
2992 given in CurrentSize the string will be grown such that the copy can be performed
2993 and CurrentSize will be updated to the new size.
2995 If Source is NULL, there is nothing to append, just return the current buffer in
2998 if Destination is NULL, then ASSERT()
2999 if Destination's current length (including NULL terminator) is already more then
3000 CurrentSize, then ASSERT()
3002 @param[in,out] Destination The String to append onto
3003 @param[in,out] CurrentSize on call the number of bytes in Destination. On
3004 return possibly the new size (still in bytes). if NULL
3005 then allocate whatever is needed.
3006 @param[in] Source The String to append from
3007 @param[in] Count Maximum number of characters to append. if 0 then
3010 @return Destination return the resultant string.
3015 IN OUT CHAR16
**Destination
,
3016 IN OUT UINTN
*CurrentSize
,
3017 IN CONST CHAR16
*Source
,
3021 UINTN DestinationStartSize
;
3027 ASSERT(Destination
!= NULL
);
3030 // If there's nothing to do then just return Destination
3032 if (Source
== NULL
) {
3033 return (*Destination
);
3037 // allow for un-initialized pointers, based on size being 0
3039 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
3040 *Destination
= NULL
;
3044 // allow for NULL pointers address as Destination
3046 if (*Destination
!= NULL
) {
3047 ASSERT(CurrentSize
!= 0);
3048 DestinationStartSize
= StrSize(*Destination
);
3049 ASSERT(DestinationStartSize
<= *CurrentSize
);
3051 DestinationStartSize
= 0;
3052 // ASSERT(*CurrentSize == 0);
3056 // Append all of Source?
3059 Count
= StrLen(Source
);
3063 // Test and grow if required
3065 if (CurrentSize
!= NULL
) {
3066 NewSize
= *CurrentSize
;
3067 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3068 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3070 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3071 ASSERT(*Destination
!= NULL
);
3072 *CurrentSize
= NewSize
;
3074 *Destination
= AllocateZeroPool((Count
+1)*sizeof(CHAR16
));
3075 ASSERT(*Destination
!= NULL
);
3079 // Now use standard StrnCat on a big enough buffer
3081 if (*Destination
== NULL
) {
3084 return StrnCat(*Destination
, Source
, Count
);
3088 Prompt the user and return the resultant answer to the requestor.
3090 This function will display the requested question on the shell prompt and then
3091 wait for an apropriate answer to be input from the console.
3093 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3094 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3096 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3099 In either case *Response must be callee freed if Response was not NULL;
3101 @param Type What type of question is asked. This is used to filter the input
3102 to prevent invalid answers to question.
3103 @param Prompt Pointer to string prompt to use to request input.
3104 @param Response Pointer to Response which will be populated upon return.
3106 @retval EFI_SUCCESS The operation was sucessful.
3107 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3108 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3109 @return other The operation failed.
3113 ShellPromptForResponse (
3114 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3115 IN CHAR16
*Prompt OPTIONAL
,
3116 IN OUT VOID
**Response OPTIONAL
3122 SHELL_PROMPT_RESPONSE
*Resp
;
3126 Status
= EFI_UNSUPPORTED
;
3130 if (Type
!= ShellPromptResponseTypeFreeform
) {
3131 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE
));
3133 return (EFI_OUT_OF_RESOURCES
);
3138 case ShellPromptResponseTypeQuitContinue
:
3139 if (Prompt
!= NULL
) {
3140 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3143 // wait for valid response
3145 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3146 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3147 ASSERT_EFI_ERROR(Status
);
3148 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3149 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3150 *Resp
= ShellPromptResponseQuit
;
3152 *Resp
= ShellPromptResponseContinue
;
3155 case ShellPromptResponseTypeYesNoCancel
:
3156 if (Prompt
!= NULL
) {
3157 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3160 // wait for valid response
3162 *Resp
= ShellPromptResponseMax
;
3163 while (*Resp
== ShellPromptResponseMax
) {
3164 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3165 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3166 ASSERT_EFI_ERROR(Status
);
3167 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3168 switch (Key
.UnicodeChar
) {
3171 *Resp
= ShellPromptResponseYes
;
3175 *Resp
= ShellPromptResponseNo
;
3179 *Resp
= ShellPromptResponseCancel
;
3183 break; case ShellPromptResponseTypeYesNoAllCancel
:
3184 if (Prompt
!= NULL
) {
3185 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3188 // wait for valid response
3190 *Resp
= ShellPromptResponseMax
;
3191 while (*Resp
== ShellPromptResponseMax
) {
3192 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3193 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3194 ASSERT_EFI_ERROR(Status
);
3195 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3196 switch (Key
.UnicodeChar
) {
3199 *Resp
= ShellPromptResponseYes
;
3203 *Resp
= ShellPromptResponseNo
;
3207 *Resp
= ShellPromptResponseAll
;
3211 *Resp
= ShellPromptResponseCancel
;
3216 case ShellPromptResponseTypeEnterContinue
:
3217 case ShellPromptResponseTypeAnyKeyContinue
:
3218 if (Prompt
!= NULL
) {
3219 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3222 // wait for valid response
3224 *Resp
= ShellPromptResponseMax
;
3225 while (*Resp
== ShellPromptResponseMax
) {
3226 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3227 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3228 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3229 ASSERT_EFI_ERROR(Status
);
3230 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3231 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3232 *Resp
= ShellPromptResponseContinue
;
3236 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3237 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3238 ASSERT_EFI_ERROR(Status
);
3239 *Resp
= ShellPromptResponseContinue
;
3244 case ShellPromptResponseTypeYesNo
:
3245 if (Prompt
!= NULL
) {
3246 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3249 // wait for valid response
3251 *Resp
= ShellPromptResponseMax
;
3252 while (*Resp
== ShellPromptResponseMax
) {
3253 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3254 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3255 ASSERT_EFI_ERROR(Status
);
3256 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3257 switch (Key
.UnicodeChar
) {
3260 *Resp
= ShellPromptResponseYes
;
3264 *Resp
= ShellPromptResponseNo
;
3269 case ShellPromptResponseTypeFreeform
:
3270 if (Prompt
!= NULL
) {
3271 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3274 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3275 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3276 ASSERT_EFI_ERROR(Status
);
3277 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3278 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3281 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3282 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3286 // This is the location to add new prompt types.
3292 if (Response
!= NULL
) {
3295 } else if (Buffer
!= NULL
) {
3302 if (Buffer
!= NULL
) {
3307 ShellPrintEx(-1, -1, L
"\r\n");
3312 Prompt the user and return the resultant answer to the requestor.
3314 This function is the same as ShellPromptForResponse, except that the prompt is
3315 automatically pulled from HII.
3317 @param Type What type of question is asked. This is used to filter the input
3318 to prevent invalid answers to question.
3319 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3320 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3321 @param Response Pointer to Response which will be populated upon return.
3323 @retval EFI_SUCCESS the operation was sucessful.
3324 @return other the operation failed.
3326 @sa ShellPromptForResponse
3330 ShellPromptForResponseHii (
3331 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3332 IN CONST EFI_STRING_ID HiiFormatStringId
,
3333 IN CONST EFI_HANDLE HiiFormatHandle
,
3334 IN OUT VOID
**Response
3340 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3341 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3347 Function to determin if an entire string is a valid number.
3349 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3351 @param[in] String The string to evaluate.
3352 @param[in] ForceHex TRUE - always assume hex.
3353 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3355 @retval TRUE It is all numeric (dec/hex) characters.
3356 @retval FALSE There is a non-numeric character.
3360 InternalShellIsHexOrDecimalNumber (
3361 IN CONST CHAR16
*String
,
3362 IN CONST BOOLEAN ForceHex
,
3363 IN CONST BOOLEAN StopAtSpace
3369 // chop off a single negative sign
3371 if (String
!= NULL
&& *String
== L
'-') {
3375 if (String
== NULL
) {
3380 // chop leading zeroes
3382 while(String
!= NULL
&& *String
== L
'0'){
3386 // allow '0x' or '0X', but not 'x' or 'X'
3388 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3389 if (*(String
-1) != L
'0') {
3391 // we got an x without a preceeding 0
3397 } else if (ForceHex
) {
3404 // loop through the remaining characters and use the lib function
3406 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3408 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3412 if (!ShellIsDecimalDigitCharacter(*String
)) {
3422 Function to determine if a given filename exists.
3424 @param[in] Name Path to test.
3426 @retval EFI_SUCCESS The Path represents a file.
3427 @retval EFI_NOT_FOUND The Path does not represent a file.
3428 @retval other The path failed to open.
3433 IN CONST CHAR16
*Name
3437 EFI_SHELL_FILE_INFO
*List
;
3439 ASSERT(Name
!= NULL
);
3442 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3443 if (EFI_ERROR(Status
)) {
3447 ShellCloseFileMetaArg(&List
);
3449 return (EFI_SUCCESS
);
3453 Convert a Unicode character to upper case only if
3454 it maps to a valid small-case ASCII character.
3456 This internal function only deal with Unicode character
3457 which maps to a valid small-case ASCII character, i.e.
3458 L'a' to L'z'. For other Unicode character, the input character
3459 is returned directly.
3461 @param Char The character to convert.
3463 @retval LowerCharacter If the Char is with range L'a' to L'z'.
3464 @retval Unchanged Otherwise.
3469 InternalShellCharToUpper (
3473 if (Char
>= L
'a' && Char
<= L
'z') {
3474 return (CHAR16
) (Char
- (L
'a' - L
'A'));
3481 Convert a Unicode character to numerical value.
3483 This internal function only deal with Unicode character
3484 which maps to a valid hexadecimal ASII character, i.e.
3485 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
3486 Unicode character, the value returned does not make sense.
3488 @param Char The character to convert.
3490 @return The numerical value converted.
3495 InternalShellHexCharToUintn (
3499 if (ShellIsDecimalDigitCharacter (Char
)) {
3503 return (UINTN
) (10 + InternalShellCharToUpper (Char
) - L
'A');
3507 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
3509 This function returns a value of type UINTN by interpreting the contents
3510 of the Unicode string specified by String as a hexadecimal number.
3511 The format of the input Unicode string String is:
3513 [spaces][zeros][x][hexadecimal digits].
3515 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
3516 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
3517 If "x" appears in the input string, it must be prefixed with at least one 0.
3518 The function will ignore the pad space, which includes spaces or tab characters,
3519 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
3520 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
3521 first valid hexadecimal digit. Then, the function stops at the first character that is
3522 a not a valid hexadecimal character or NULL, whichever one comes first.
3524 If String has only pad spaces, then zero is returned.
3525 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
3526 then zero is returned.
3528 @param[in] String A pointer to a Null-terminated Unicode string.
3529 @param[out] Value Upon a successful return the value of the conversion.
3530 @param[in] StopAtSpace FALSE to skip spaces.
3532 @retval EFI_SUCCESS The conversion was successful.
3533 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3534 @retval EFI_DEVICE_ERROR An overflow occured.
3538 InternalShellStrHexToUint64 (
3539 IN CONST CHAR16
*String
,
3541 IN CONST BOOLEAN StopAtSpace
3546 if (String
== NULL
|| StrSize(String
) == 0 || Value
== NULL
) {
3547 return (EFI_INVALID_PARAMETER
);
3551 // Ignore the pad spaces (space or tab)
3553 while ((*String
== L
' ') || (*String
== L
'\t')) {
3558 // Ignore leading Zeros after the spaces
3560 while (*String
== L
'0') {
3564 if (InternalShellCharToUpper (*String
) == L
'X') {
3565 if (*(String
- 1) != L
'0') {
3577 // Skip spaces if requested
3579 while (StopAtSpace
&& *String
== L
' ') {
3583 while (ShellIsHexaDecimalDigitCharacter (*String
)) {
3585 // If the Hex Number represented by String overflows according
3586 // to the range defined by UINTN, then ASSERT().
3588 if (!(Result
<= (RShiftU64((((UINT64
) ~0) - InternalShellHexCharToUintn (*String
)), 4)))) {
3589 // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {
3590 return (EFI_DEVICE_ERROR
);
3593 Result
= (LShiftU64(Result
, 4));
3594 Result
+= InternalShellHexCharToUintn (*String
);
3598 // Skip spaces if requested
3600 while (StopAtSpace
&& *String
== L
' ') {
3606 return (EFI_SUCCESS
);
3610 Convert a Null-terminated Unicode decimal string to a value of
3613 This function returns a value of type UINT64 by interpreting the contents
3614 of the Unicode string specified by String as a decimal number. The format
3615 of the input Unicode string String is:
3617 [spaces] [decimal digits].
3619 The valid decimal digit character is in the range [0-9]. The
3620 function will ignore the pad space, which includes spaces or
3621 tab characters, before [decimal digits]. The running zero in the
3622 beginning of [decimal digits] will be ignored. Then, the function
3623 stops at the first character that is a not a valid decimal character
3624 or a Null-terminator, whichever one comes first.
3626 If String has only pad spaces, then 0 is returned.
3627 If String has no pad spaces or valid decimal digits,
3630 @param[in] String A pointer to a Null-terminated Unicode string.
3631 @param[out] Value Upon a successful return the value of the conversion.
3632 @param[in] StopAtSpace FALSE to skip spaces.
3634 @retval EFI_SUCCESS The conversion was successful.
3635 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3636 @retval EFI_DEVICE_ERROR An overflow occured.
3640 InternalShellStrDecimalToUint64 (
3641 IN CONST CHAR16
*String
,
3643 IN CONST BOOLEAN StopAtSpace
3648 if (String
== NULL
|| StrSize (String
) == 0 || Value
== NULL
) {
3649 return (EFI_INVALID_PARAMETER
);
3653 // Ignore the pad spaces (space or tab)
3655 while ((*String
== L
' ') || (*String
== L
'\t')) {
3660 // Ignore leading Zeros after the spaces
3662 while (*String
== L
'0') {
3669 // Skip spaces if requested
3671 while (StopAtSpace
&& *String
== L
' ') {
3674 while (ShellIsDecimalDigitCharacter (*String
)) {
3676 // If the number represented by String overflows according
3677 // to the range defined by UINT64, then ASSERT().
3680 if (!(Result
<= (DivU64x32((((UINT64
) ~0) - (*String
- L
'0')),10)))) {
3681 return (EFI_DEVICE_ERROR
);
3684 Result
= MultU64x32(Result
, 10) + (*String
- L
'0');
3688 // Stop at spaces if requested
3690 if (StopAtSpace
&& *String
== L
' ') {
3697 return (EFI_SUCCESS
);
3701 Function to verify and convert a string to its numerical value.
3703 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
3705 @param[in] String The string to evaluate.
3706 @param[out] Value Upon a successful return the value of the conversion.
3707 @param[in] ForceHex TRUE - always assume hex.
3708 @param[in] StopAtSpace FALSE to skip spaces.
3710 @retval EFI_SUCCESS The conversion was successful.
3711 @retval EFI_INVALID_PARAMETER String contained an invalid character.
3712 @retval EFI_NOT_FOUND String was a number, but Value was NULL.
3716 ShellConvertStringToUint64(
3717 IN CONST CHAR16
*String
,
3719 IN CONST BOOLEAN ForceHex
,
3720 IN CONST BOOLEAN StopAtSpace
3724 CONST CHAR16
*Walker
;
3730 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3733 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3734 return (EFI_INVALID_PARAMETER
);
3737 return (EFI_INVALID_PARAMETER
);
3742 // Chop off leading spaces
3744 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
3747 // make sure we have something left that is numeric.
3749 if (Walker
== NULL
|| *Walker
== CHAR_NULL
|| !InternalShellIsHexOrDecimalNumber(Walker
, Hex
, StopAtSpace
)) {
3750 return (EFI_INVALID_PARAMETER
);
3754 // do the conversion.
3756 if (Hex
|| StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
3757 Status
= InternalShellStrHexToUint64(Walker
, &RetVal
, StopAtSpace
);
3759 Status
= InternalShellStrDecimalToUint64(Walker
, &RetVal
, StopAtSpace
);
3762 if (Value
== NULL
&& !EFI_ERROR(Status
)) {
3763 return (EFI_NOT_FOUND
);
3766 if (Value
!= NULL
) {
3774 Function to determin if an entire string is a valid number.
3776 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3778 @param[in] String The string to evaluate.
3779 @param[in] ForceHex TRUE - always assume hex.
3780 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3782 @retval TRUE It is all numeric (dec/hex) characters.
3783 @retval FALSE There is a non-numeric character.
3787 ShellIsHexOrDecimalNumber (
3788 IN CONST CHAR16
*String
,
3789 IN CONST BOOLEAN ForceHex
,
3790 IN CONST BOOLEAN StopAtSpace
3793 if (ShellConvertStringToUint64(String
, NULL
, ForceHex
, StopAtSpace
) == EFI_NOT_FOUND
) {