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 // Check for EFI shell
1219 if (mEfiShellEnvironment2
!= NULL
) {
1220 return (mEfiShellEnvironment2
->CurDir(DeviceName
));
1226 sets (enabled or disabled) the page break mode
1228 when page break mode is enabled the screen will stop scrolling
1229 and wait for operator input before scrolling a subsequent screen.
1231 @param CurrentState TRUE to enable and FALSE to disable
1235 ShellSetPageBreakMode (
1236 IN BOOLEAN CurrentState
1240 // check for enabling
1242 if (CurrentState
!= 0x00) {
1244 // check for UEFI Shell 2.0
1246 if (mEfiShellProtocol
!= NULL
) {
1248 // Enable with UEFI 2.0 Shell
1250 mEfiShellProtocol
->EnablePageBreak();
1254 // ASSERT that must have EFI Shell
1256 ASSERT(mEfiShellEnvironment2
!= NULL
);
1258 // Enable with EFI Shell
1260 mEfiShellEnvironment2
->EnablePageBreak (DEFAULT_INIT_ROW
, DEFAULT_AUTO_LF
);
1265 // check for UEFI Shell 2.0
1267 if (mEfiShellProtocol
!= NULL
) {
1269 // Disable with UEFI 2.0 Shell
1271 mEfiShellProtocol
->DisablePageBreak();
1275 // ASSERT that must have EFI Shell
1277 ASSERT(mEfiShellEnvironment2
!= NULL
);
1279 // Disable with EFI Shell
1281 mEfiShellEnvironment2
->DisablePageBreak ();
1288 /// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.
1289 /// This allows for the struct to be populated.
1296 SHELL_FILE_HANDLE Handle
;
1297 EFI_FILE_INFO
*Info
;
1298 } EFI_SHELL_FILE_INFO_NO_CONST
;
1301 Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.
1303 if OldStyleFileList is NULL then ASSERT()
1305 this function will convert a SHELL_FILE_ARG based list into a callee allocated
1306 EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
1307 the ShellCloseFileMetaArg function.
1309 @param[in] FileList the EFI shell list type
1310 @param[in,out] ListHead the list to add to
1312 @retval the resultant head of the double linked new format list;
1316 InternalShellConvertFileListType (
1317 IN LIST_ENTRY
*FileList
,
1318 IN OUT LIST_ENTRY
*ListHead
1321 SHELL_FILE_ARG
*OldInfo
;
1323 EFI_SHELL_FILE_INFO_NO_CONST
*NewInfo
;
1328 ASSERT(FileList
!= NULL
);
1329 ASSERT(ListHead
!= NULL
);
1332 // enumerate through each member of the old list and copy
1334 for (Link
= FileList
->ForwardLink
; Link
!= FileList
; Link
= Link
->ForwardLink
) {
1335 OldInfo
= CR (Link
, SHELL_FILE_ARG
, Link
, SHELL_FILE_ARG_SIGNATURE
);
1336 ASSERT(OldInfo
!= NULL
);
1339 // Skip ones that failed to open...
1341 if (OldInfo
->Status
!= EFI_SUCCESS
) {
1346 // make sure the old list was valid
1348 ASSERT(OldInfo
->Info
!= NULL
);
1349 ASSERT(OldInfo
->FullName
!= NULL
);
1350 ASSERT(OldInfo
->FileName
!= NULL
);
1353 // allocate a new EFI_SHELL_FILE_INFO object
1355 NewInfo
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1356 ASSERT(NewInfo
!= NULL
);
1357 if (NewInfo
== NULL
) {
1362 // copy the simple items
1364 NewInfo
->Handle
= OldInfo
->Handle
;
1365 NewInfo
->Status
= OldInfo
->Status
;
1367 // old shell checks for 0 not NULL
1368 OldInfo
->Handle
= 0;
1371 // allocate new space to copy strings and structure
1373 NewInfo
->FullName
= AllocateZeroPool(StrSize(OldInfo
->FullName
));
1374 NewInfo
->FileName
= AllocateZeroPool(StrSize(OldInfo
->FileName
));
1375 NewInfo
->Info
= AllocateZeroPool((UINTN
)OldInfo
->Info
->Size
);
1378 // make sure all the memory allocations were sucessful
1380 ASSERT(NewInfo
->FullName
!= NULL
);
1381 ASSERT(NewInfo
->FileName
!= NULL
);
1382 ASSERT(NewInfo
->Info
!= NULL
);
1385 // Copt the strings and structure
1387 StrCpy(NewInfo
->FullName
, OldInfo
->FullName
);
1388 StrCpy(NewInfo
->FileName
, OldInfo
->FileName
);
1389 gBS
->CopyMem (NewInfo
->Info
, OldInfo
->Info
, (UINTN
)OldInfo
->Info
->Size
);
1392 // add that to the list
1394 InsertTailList(ListHead
, &NewInfo
->Link
);
1399 Opens a group of files based on a path.
1401 This function uses the Arg to open all the matching files. Each matched
1402 file has a SHELL_FILE_ARG structure to record the file information. These
1403 structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
1404 structures from ListHead to access each file. This function supports wildcards
1405 and will process '?' and '*' as such. the list must be freed with a call to
1406 ShellCloseFileMetaArg().
1408 If you are NOT appending to an existing list *ListHead must be NULL. If
1409 *ListHead is NULL then it must be callee freed.
1411 @param Arg pointer to path string
1412 @param OpenMode mode to open files with
1413 @param ListHead head of linked list of results
1415 @retval EFI_SUCCESS the operation was sucessful and the list head
1416 contains the list of opened files
1417 @return != EFI_SUCCESS the operation failed
1419 @sa InternalShellConvertFileListType
1423 ShellOpenFileMetaArg (
1426 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1430 LIST_ENTRY mOldStyleFileList
;
1433 // ASSERT that Arg and ListHead are not NULL
1435 ASSERT(Arg
!= NULL
);
1436 ASSERT(ListHead
!= NULL
);
1439 // Check for UEFI Shell 2.0 protocols
1441 if (mEfiShellProtocol
!= NULL
) {
1442 if (*ListHead
== NULL
) {
1443 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1444 if (*ListHead
== NULL
) {
1445 return (EFI_OUT_OF_RESOURCES
);
1447 InitializeListHead(&((*ListHead
)->Link
));
1449 Status
= mEfiShellProtocol
->OpenFileList(Arg
,
1452 if (EFI_ERROR(Status
)) {
1453 mEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1455 Status
= mEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1457 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1458 FreePool(*ListHead
);
1460 return (EFI_NOT_FOUND
);
1466 // ASSERT that we must have EFI shell
1468 ASSERT(mEfiShellEnvironment2
!= NULL
);
1471 // make sure the list head is initialized
1473 InitializeListHead(&mOldStyleFileList
);
1476 // Get the EFI Shell list of files
1478 Status
= mEfiShellEnvironment2
->FileMetaArg(Arg
, &mOldStyleFileList
);
1479 if (EFI_ERROR(Status
)) {
1484 if (*ListHead
== NULL
) {
1485 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1486 if (*ListHead
== NULL
) {
1487 return (EFI_OUT_OF_RESOURCES
);
1489 InitializeListHead(&((*ListHead
)->Link
));
1493 // Convert that to equivalent of UEFI Shell 2.0 structure
1495 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1498 // Free the EFI Shell version that was converted.
1500 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1502 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1503 FreePool(*ListHead
);
1505 Status
= EFI_NOT_FOUND
;
1511 Free the linked list returned from ShellOpenFileMetaArg.
1513 if ListHead is NULL then ASSERT().
1515 @param ListHead the pointer to free.
1517 @retval EFI_SUCCESS the operation was sucessful.
1521 ShellCloseFileMetaArg (
1522 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1528 // ASSERT that ListHead is not NULL
1530 ASSERT(ListHead
!= NULL
);
1533 // Check for UEFI Shell 2.0 protocols
1535 if (mEfiShellProtocol
!= NULL
) {
1536 return (mEfiShellProtocol
->FreeFileList(ListHead
));
1539 // Since this is EFI Shell version we need to free our internally made copy
1542 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1543 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1544 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1545 RemoveEntryList(Node
);
1546 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1547 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1548 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1549 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1550 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1557 Find a file by searching the CWD and then the path.
1559 If FileName is NULL then ASSERT.
1561 If the return value is not NULL then the memory must be caller freed.
1563 @param FileName Filename string.
1565 @retval NULL the file was not found
1566 @return !NULL the full path to the file.
1571 IN CONST CHAR16
*FileName
1575 SHELL_FILE_HANDLE Handle
;
1579 CONST CHAR16
*Walker
;
1586 // First make sure its not an absolute path.
1588 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1589 if (!EFI_ERROR(Status
)){
1590 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1591 ASSERT(RetVal
== NULL
);
1592 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1593 ShellCloseFile(&Handle
);
1596 ShellCloseFile(&Handle
);
1600 Path
= ShellGetEnvironmentVariable(L
"cwd");
1602 Size
= StrSize(Path
);
1603 Size
+= StrSize(FileName
);
1604 TestPath
= AllocateZeroPool(Size
);
1605 ASSERT(TestPath
!= NULL
);
1606 if (TestPath
== NULL
) {
1609 StrCpy(TestPath
, Path
);
1610 StrCat(TestPath
, FileName
);
1611 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1612 if (!EFI_ERROR(Status
)){
1613 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1614 ASSERT(RetVal
== NULL
);
1615 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1616 ShellCloseFile(&Handle
);
1620 ShellCloseFile(&Handle
);
1625 Path
= ShellGetEnvironmentVariable(L
"path");
1627 Size
= StrSize(Path
)+sizeof(CHAR16
);
1628 Size
+= StrSize(FileName
);
1629 TestPath
= AllocateZeroPool(Size
);
1630 if (TestPath
== NULL
) {
1633 Walker
= (CHAR16
*)Path
;
1635 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1636 if (TestPath
!= NULL
) {
1637 TempChar
= StrStr(TestPath
, L
";");
1638 if (TempChar
!= NULL
) {
1639 *TempChar
= CHAR_NULL
;
1641 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1642 StrCat(TestPath
, L
"\\");
1644 if (FileName
[0] == L
'\\') {
1647 StrCat(TestPath
, FileName
);
1648 if (StrStr(Walker
, L
";") != NULL
) {
1649 Walker
= StrStr(Walker
, L
";") + 1;
1653 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1654 if (!EFI_ERROR(Status
)){
1655 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1656 ASSERT(RetVal
== NULL
);
1657 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1658 ShellCloseFile(&Handle
);
1661 ShellCloseFile(&Handle
);
1665 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1672 Find a file by searching the CWD and then the path with a variable set of file
1673 extensions. If the file is not found it will append each extension in the list
1674 in the order provided and return the first one that is successful.
1676 If FileName is NULL, then ASSERT.
1677 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1679 If the return value is not NULL then the memory must be caller freed.
1681 @param[in] FileName Filename string.
1682 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1684 @retval NULL The file was not found.
1685 @retval !NULL The path to the file.
1689 ShellFindFilePathEx (
1690 IN CONST CHAR16
*FileName
,
1691 IN CONST CHAR16
*FileExtension
1696 CONST CHAR16
*ExtensionWalker
;
1701 ASSERT(FileName
!= NULL
);
1702 if (FileExtension
== NULL
) {
1703 return (ShellFindFilePath(FileName
));
1705 RetVal
= ShellFindFilePath(FileName
);
1706 if (RetVal
!= NULL
) {
1709 Size
= StrSize(FileName
);
1710 Size
+= StrSize(FileExtension
);
1711 TestPath
= AllocateZeroPool(Size
);
1712 ASSERT(TestPath
!= NULL
);
1713 if (TestPath
== NULL
) {
1716 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1717 StrCpy(TestPath
, FileName
);
1718 if (ExtensionWalker
!= NULL
) {
1719 StrCat(TestPath
, ExtensionWalker
);
1721 TempChar
= StrStr(TestPath
, L
";");
1722 if (TempChar
!= NULL
) {
1723 *TempChar
= CHAR_NULL
;
1725 RetVal
= ShellFindFilePath(TestPath
);
1726 if (RetVal
!= NULL
) {
1729 ASSERT(ExtensionWalker
!= NULL
);
1730 TempChar2
= StrStr(ExtensionWalker
, L
";");
1739 SHELL_PARAM_TYPE Type
;
1741 UINTN OriginalPosition
;
1742 } SHELL_PARAM_PACKAGE
;
1745 Checks the list of valid arguments and returns TRUE if the item was found. If the
1746 return value is TRUE then the type parameter is set also.
1748 if CheckList is NULL then ASSERT();
1749 if Name is NULL then ASSERT();
1750 if Type is NULL then ASSERT();
1752 @param Name pointer to Name of parameter found
1753 @param CheckList List to check against
1754 @param Type pointer to type of parameter if it was found
1756 @retval TRUE the Parameter was found. Type is valid.
1757 @retval FALSE the Parameter was not found. Type is not valid.
1761 InternalIsOnCheckList (
1762 IN CONST CHAR16
*Name
,
1763 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1764 OUT SHELL_PARAM_TYPE
*Type
1767 SHELL_PARAM_ITEM
*TempListItem
;
1771 // ASSERT that all 3 pointer parameters aren't NULL
1773 ASSERT(CheckList
!= NULL
);
1774 ASSERT(Type
!= NULL
);
1775 ASSERT(Name
!= NULL
);
1778 // question mark and page break mode are always supported
1780 if ((StrCmp(Name
, L
"-?") == 0) ||
1781 (StrCmp(Name
, L
"-b") == 0)
1788 // Enumerate through the list
1790 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1792 // If the Type is TypeStart only check the first characters of the passed in param
1793 // If it matches set the type and return TRUE
1795 if (TempListItem
->Type
== TypeStart
) {
1796 if (StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1797 *Type
= TempListItem
->Type
;
1801 TempString
= StrnCatGrow(&TempString
, NULL
, Name
, StrLen(TempListItem
->Name
));
1802 if (TempString
!= NULL
) {
1803 if (StringNoCaseCompare(&TempString
, &TempListItem
->Name
) == 0) {
1804 *Type
= TempListItem
->Type
;
1805 FreePool(TempString
);
1808 FreePool(TempString
);
1810 } else if (StringNoCaseCompare(&Name
, &TempListItem
->Name
) == 0) {
1811 *Type
= TempListItem
->Type
;
1819 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1821 @param[in] Name pointer to Name of parameter found
1822 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1824 @retval TRUE the Parameter is a flag.
1825 @retval FALSE the Parameter not a flag.
1830 IN CONST CHAR16
*Name
,
1831 IN BOOLEAN AlwaysAllowNumbers
1835 // ASSERT that Name isn't NULL
1837 ASSERT(Name
!= NULL
);
1840 // If we accept numbers then dont return TRUE. (they will be values)
1842 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && ShellIsHexaDecimalDigitCharacter(Name
[1])) && AlwaysAllowNumbers
) {
1847 // If the Name has a /, +, or - as the first character return TRUE
1849 if ((Name
[0] == L
'/') ||
1850 (Name
[0] == L
'-') ||
1859 Checks the command line arguments passed against the list of valid ones.
1861 If no initialization is required, then return RETURN_SUCCESS.
1863 @param[in] CheckList pointer to list of parameters to check
1864 @param[out] CheckPackage pointer to pointer to list checked values
1865 @param[out] ProblemParam optional pointer to pointer to unicode string for
1866 the paramater that caused failure. If used then the
1867 caller is responsible for freeing the memory.
1868 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1869 @param[in] Argv pointer to array of parameters
1870 @param[in] Argc Count of parameters in Argv
1871 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1873 @retval EFI_SUCCESS The operation completed sucessfully.
1874 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1875 @retval EFI_INVALID_PARAMETER A parameter was invalid
1876 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1877 duplicated. the duplicated command line argument
1878 was returned in ProblemParam if provided.
1879 @retval EFI_NOT_FOUND a argument required a value that was missing.
1880 the invalid command line argument was returned in
1881 ProblemParam if provided.
1885 InternalCommandLineParse (
1886 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1887 OUT LIST_ENTRY
**CheckPackage
,
1888 OUT CHAR16
**ProblemParam OPTIONAL
,
1889 IN BOOLEAN AutoPageBreak
,
1890 IN CONST CHAR16
**Argv
,
1892 IN BOOLEAN AlwaysAllowNumbers
1896 SHELL_PARAM_TYPE CurrentItemType
;
1897 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
1901 CONST CHAR16
*TempPointer
;
1903 CurrentItemPackage
= NULL
;
1909 // If there is only 1 item we dont need to do anything
1912 *CheckPackage
= NULL
;
1913 return (EFI_SUCCESS
);
1919 ASSERT(CheckList
!= NULL
);
1920 ASSERT(Argv
!= NULL
);
1923 // initialize the linked list
1925 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
1926 InitializeListHead(*CheckPackage
);
1929 // loop through each of the arguments
1931 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
1932 if (Argv
[LoopCounter
] == NULL
) {
1934 // do nothing for NULL argv
1936 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
1938 // We might have leftover if last parameter didnt have optional value
1940 if (GetItemValue
!= 0) {
1942 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1947 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
1948 ASSERT(CurrentItemPackage
!= NULL
);
1949 CurrentItemPackage
->Name
= AllocateZeroPool(StrSize(Argv
[LoopCounter
]));
1950 ASSERT(CurrentItemPackage
->Name
!= NULL
);
1951 StrCpy(CurrentItemPackage
->Name
, Argv
[LoopCounter
]);
1952 CurrentItemPackage
->Type
= CurrentItemType
;
1953 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
1954 CurrentItemPackage
->Value
= NULL
;
1957 // Does this flag require a value
1959 switch (CurrentItemPackage
->Type
) {
1961 // possibly trigger the next loop(s) to populate the value of this item
1967 case TypeDoubleValue
:
1972 GetItemValue
= (UINTN
)(-1);
1977 // this item has no value expected; we are done
1979 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1980 ASSERT(GetItemValue
== 0);
1983 } else if (GetItemValue
!= 0 && !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
)) {
1984 ASSERT(CurrentItemPackage
!= NULL
);
1986 // get the item VALUE for a previous flag
1988 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
), CurrentItemPackage
->Value
);
1989 ASSERT(CurrentItemPackage
->Value
!= NULL
);
1990 if (ValueSize
== 0) {
1991 StrCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
1993 StrCat(CurrentItemPackage
->Value
, L
" ");
1994 StrCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
1996 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
1998 if (GetItemValue
== 0) {
1999 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2001 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
) ){ //|| ProblemParam == NULL) {
2003 // add this one as a non-flag
2006 TempPointer
= Argv
[LoopCounter
];
2007 if ((*TempPointer
== L
'^' && *(TempPointer
+1) == L
'-')
2008 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'/')
2009 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'+')
2013 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2014 ASSERT(CurrentItemPackage
!= NULL
);
2015 CurrentItemPackage
->Name
= NULL
;
2016 CurrentItemPackage
->Type
= TypePosition
;
2017 CurrentItemPackage
->Value
= AllocateZeroPool(StrSize(TempPointer
));
2018 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2019 StrCpy(CurrentItemPackage
->Value
, TempPointer
);
2020 CurrentItemPackage
->OriginalPosition
= Count
++;
2021 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2024 // this was a non-recognised flag... error!
2026 if (ProblemParam
!= NULL
) {
2027 *ProblemParam
= AllocateZeroPool(StrSize(Argv
[LoopCounter
]));
2028 ASSERT(*ProblemParam
!= NULL
);
2029 StrCpy(*ProblemParam
, Argv
[LoopCounter
]);
2031 ShellCommandLineFreeVarList(*CheckPackage
);
2032 *CheckPackage
= NULL
;
2033 return (EFI_VOLUME_CORRUPTED
);
2036 if (GetItemValue
!= 0) {
2038 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2041 // support for AutoPageBreak
2043 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2044 ShellSetPageBreakMode(TRUE
);
2046 return (EFI_SUCCESS
);
2050 Checks the command line arguments passed against the list of valid ones.
2051 Optionally removes NULL values first.
2053 If no initialization is required, then return RETURN_SUCCESS.
2055 @param[in] CheckList The pointer to list of parameters to check.
2056 @param[out] CheckPackage The package of checked values.
2057 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2058 the paramater that caused failure.
2059 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2060 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2062 @retval EFI_SUCCESS The operation completed sucessfully.
2063 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2064 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2065 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2066 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2067 of the command line arguments was returned in
2068 ProblemParam if provided.
2069 @retval EFI_NOT_FOUND A argument required a value that was missing.
2070 The invalid command line argument was returned in
2071 ProblemParam if provided.
2075 ShellCommandLineParseEx (
2076 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2077 OUT LIST_ENTRY
**CheckPackage
,
2078 OUT CHAR16
**ProblemParam OPTIONAL
,
2079 IN BOOLEAN AutoPageBreak
,
2080 IN BOOLEAN AlwaysAllowNumbers
2084 // ASSERT that CheckList and CheckPackage aren't NULL
2086 ASSERT(CheckList
!= NULL
);
2087 ASSERT(CheckPackage
!= NULL
);
2090 // Check for UEFI Shell 2.0 protocols
2092 if (mEfiShellParametersProtocol
!= NULL
) {
2093 return (InternalCommandLineParse(CheckList
,
2097 (CONST CHAR16
**) mEfiShellParametersProtocol
->Argv
,
2098 mEfiShellParametersProtocol
->Argc
,
2099 AlwaysAllowNumbers
));
2103 // ASSERT That EFI Shell is not required
2105 ASSERT (mEfiShellInterface
!= NULL
);
2106 return (InternalCommandLineParse(CheckList
,
2110 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2111 mEfiShellInterface
->Argc
,
2112 AlwaysAllowNumbers
));
2116 Frees shell variable list that was returned from ShellCommandLineParse.
2118 This function will free all the memory that was used for the CheckPackage
2119 list of postprocessed shell arguments.
2121 this function has no return value.
2123 if CheckPackage is NULL, then return
2125 @param CheckPackage the list to de-allocate
2129 ShellCommandLineFreeVarList (
2130 IN LIST_ENTRY
*CheckPackage
2136 // check for CheckPackage == NULL
2138 if (CheckPackage
== NULL
) {
2143 // for each node in the list
2145 for ( Node
= GetFirstNode(CheckPackage
)
2146 ; !IsListEmpty(CheckPackage
)
2147 ; Node
= GetFirstNode(CheckPackage
)
2150 // Remove it from the list
2152 RemoveEntryList(Node
);
2155 // if it has a name free the name
2157 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2158 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2162 // if it has a value free the value
2164 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2165 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2169 // free the node structure
2171 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2174 // free the list head node
2176 FreePool(CheckPackage
);
2179 Checks for presence of a flag parameter
2181 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2183 if CheckPackage is NULL then return FALSE.
2184 if KeyString is NULL then ASSERT()
2186 @param CheckPackage The package of parsed command line arguments
2187 @param KeyString the Key of the command line argument to check for
2189 @retval TRUE the flag is on the command line
2190 @retval FALSE the flag is not on the command line
2194 ShellCommandLineGetFlag (
2195 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2196 IN CONST CHAR16
* CONST KeyString
2203 // ASSERT that both CheckPackage and KeyString aren't NULL
2205 ASSERT(KeyString
!= NULL
);
2208 // return FALSE for no package
2210 if (CheckPackage
== NULL
) {
2215 // enumerate through the list of parametrs
2217 for ( Node
= GetFirstNode(CheckPackage
)
2218 ; !IsNull (CheckPackage
, Node
)
2219 ; Node
= GetNextNode(CheckPackage
, Node
)
2222 // If the Name matches, return TRUE (and there may be NULL name)
2224 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2226 // If Type is TypeStart then only compare the begining of the strings
2228 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2229 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2233 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2234 if (TempString
!= NULL
) {
2235 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2236 FreePool(TempString
);
2239 FreePool(TempString
);
2241 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2249 Returns value from command line argument.
2251 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2253 If CheckPackage is NULL, then return NULL.
2255 @param[in] CheckPackage The package of parsed command line arguments.
2256 @param[in] KeyString The Key of the command line argument to check for.
2258 @retval NULL The flag is not on the command line.
2259 @retval !=NULL The pointer to unicode string of the value.
2263 ShellCommandLineGetValue (
2264 IN CONST LIST_ENTRY
*CheckPackage
,
2265 IN CHAR16
*KeyString
2272 // check for CheckPackage == NULL
2274 if (CheckPackage
== NULL
) {
2279 // enumerate through the list of parametrs
2281 for ( Node
= GetFirstNode(CheckPackage
)
2282 ; !IsNull (CheckPackage
, Node
)
2283 ; Node
= GetNextNode(CheckPackage
, Node
)
2286 // If the Name matches, return TRUE (and there may be NULL name)
2288 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2290 // If Type is TypeStart then only compare the begining of the strings
2292 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2293 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2294 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2297 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2298 if (TempString
!= NULL
) {
2299 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2300 FreePool(TempString
);
2301 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2303 FreePool(TempString
);
2305 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2306 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2314 Returns raw value from command line argument.
2316 Raw value parameters are in the form of "value" in a specific position in the list.
2318 If CheckPackage is NULL, then return NULL.
2320 @param[in] CheckPackage The package of parsed command line arguments.
2321 @param[in] Position The position of the value.
2323 @retval NULL The flag is not on the command line.
2324 @retval !=NULL The pointer to unicode string of the value.
2328 ShellCommandLineGetRawValue (
2329 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2336 // check for CheckPackage == NULL
2338 if (CheckPackage
== NULL
) {
2343 // enumerate through the list of parametrs
2345 for ( Node
= GetFirstNode(CheckPackage
)
2346 ; !IsNull (CheckPackage
, Node
)
2347 ; Node
= GetNextNode(CheckPackage
, Node
)
2350 // If the position matches, return the value
2352 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2353 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2360 returns the number of command line value parameters that were parsed.
2362 this will not include flags.
2364 @param[in] CheckPackage The package of parsed command line arguments.
2366 @retval (UINTN)-1 No parsing has ocurred
2367 @return other The number of value parameters found
2371 ShellCommandLineGetCount(
2372 IN CONST LIST_ENTRY
*CheckPackage
2378 if (CheckPackage
== NULL
) {
2381 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2382 ; !IsNull (CheckPackage
, Node1
)
2383 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2385 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2393 Determins if a parameter is duplicated.
2395 If Param is not NULL then it will point to a callee allocated string buffer
2396 with the parameter value if a duplicate is found.
2398 If CheckPackage is NULL, then ASSERT.
2400 @param[in] CheckPackage The package of parsed command line arguments.
2401 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2403 @retval EFI_SUCCESS No parameters were duplicated.
2404 @retval EFI_DEVICE_ERROR A duplicate was found.
2408 ShellCommandLineCheckDuplicate (
2409 IN CONST LIST_ENTRY
*CheckPackage
,
2416 ASSERT(CheckPackage
!= NULL
);
2418 for ( Node1
= GetFirstNode(CheckPackage
)
2419 ; !IsNull (CheckPackage
, Node1
)
2420 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2422 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2423 ; !IsNull (CheckPackage
, Node2
)
2424 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2426 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) {
2427 if (Param
!= NULL
) {
2429 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2431 return (EFI_DEVICE_ERROR
);
2435 return (EFI_SUCCESS
);
2439 This is a find and replace function. Upon successful return the NewString is a copy of
2440 SourceString with each instance of FindTarget replaced with ReplaceWith.
2442 If SourceString and NewString overlap the behavior is undefined.
2444 If the string would grow bigger than NewSize it will halt and return error.
2446 @param[in] SourceString The string with source buffer.
2447 @param[in,out] NewString The string with resultant buffer.
2448 @param[in] NewSize The size in bytes of NewString.
2449 @param[in] FindTarget The string to look for.
2450 @param[in] ReplaceWith The string to replace FindTarget with.
2451 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2452 immediately before it.
2453 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2455 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2456 @retval EFI_INVALID_PARAMETER NewString was NULL.
2457 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2458 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2459 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2460 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2461 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2462 the new string (truncation occurred).
2463 @retval EFI_SUCCESS The string was successfully copied with replacement.
2467 ShellCopySearchAndReplace(
2468 IN CHAR16 CONST
*SourceString
,
2469 IN OUT CHAR16
*NewString
,
2471 IN CONST CHAR16
*FindTarget
,
2472 IN CONST CHAR16
*ReplaceWith
,
2473 IN CONST BOOLEAN SkipPreCarrot
,
2474 IN CONST BOOLEAN ParameterReplacing
2480 if ( (SourceString
== NULL
)
2481 || (NewString
== NULL
)
2482 || (FindTarget
== NULL
)
2483 || (ReplaceWith
== NULL
)
2484 || (StrLen(FindTarget
) < 1)
2485 || (StrLen(SourceString
) < 1)
2487 return (EFI_INVALID_PARAMETER
);
2490 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2491 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2493 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2494 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2496 if (Replace
== NULL
) {
2497 return (EFI_OUT_OF_RESOURCES
);
2499 NewString
= SetMem16(NewString
, NewSize
, CHAR_NULL
);
2500 while (*SourceString
!= CHAR_NULL
) {
2502 // if we find the FindTarget and either Skip == FALSE or Skip and we
2503 // dont have a carrot do a replace...
2505 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2506 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2508 SourceString
+= StrLen(FindTarget
);
2509 Size
= StrSize(NewString
);
2510 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2512 return (EFI_BUFFER_TOO_SMALL
);
2514 StrCat(NewString
, Replace
);
2516 Size
= StrSize(NewString
);
2517 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2519 return (EFI_BUFFER_TOO_SMALL
);
2521 StrnCat(NewString
, SourceString
, 1);
2526 return (EFI_SUCCESS
);
2530 Internal worker function to output a string.
2532 This function will output a string to the correct StdOut.
2534 @param[in] String The string to print out.
2536 @retval EFI_SUCCESS The operation was sucessful.
2537 @retval !EFI_SUCCESS The operation failed.
2542 IN CONST CHAR16
*String
2546 Size
= StrSize(String
) - sizeof(CHAR16
);
2548 return (EFI_SUCCESS
);
2550 if (mEfiShellParametersProtocol
!= NULL
) {
2551 return (mEfiShellProtocol
->WriteFile(mEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2553 if (mEfiShellInterface
!= NULL
) {
2555 // Divide in half for old shell. Must be string length not size.
2558 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2561 return (EFI_UNSUPPORTED
);
2565 Print at a specific location on the screen.
2567 This function will move the cursor to a given screen location and print the specified string
2569 If -1 is specified for either the Row or Col the current screen location for BOTH
2572 if either Row or Col is out of range for the current console, then ASSERT
2573 if Format is NULL, then ASSERT
2575 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2576 the following additional flags:
2577 %N - Set output attribute to normal
2578 %H - Set output attribute to highlight
2579 %E - Set output attribute to error
2580 %B - Set output attribute to blue color
2581 %V - Set output attribute to green color
2583 Note: The background color is controlled by the shell command cls.
2585 @param[in] Col the column to print at
2586 @param[in] Row the row to print at
2587 @param[in] Format the format string
2588 @param[in] Marker the marker for the variable argument list
2590 @return EFI_SUCCESS The operation was successful.
2591 @return EFI_DEVICE_ERROR The console device reported an error.
2595 InternalShellPrintWorker(
2596 IN INT32 Col OPTIONAL
,
2597 IN INT32 Row OPTIONAL
,
2598 IN CONST CHAR16
*Format
,
2603 CHAR16
*ResumeLocation
;
2604 CHAR16
*FormatWalker
;
2605 UINTN OriginalAttribute
;
2606 CHAR16
*mPostReplaceFormat
;
2607 CHAR16
*mPostReplaceFormat2
;
2609 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2610 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2612 if (mPostReplaceFormat
== NULL
|| mPostReplaceFormat2
== NULL
) {
2613 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2614 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2615 return (EFI_OUT_OF_RESOURCES
);
2618 Status
= EFI_SUCCESS
;
2619 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2622 // Back and forth each time fixing up 1 of our flags...
2624 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2625 ASSERT_EFI_ERROR(Status
);
2626 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2627 ASSERT_EFI_ERROR(Status
);
2628 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2629 ASSERT_EFI_ERROR(Status
);
2630 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2631 ASSERT_EFI_ERROR(Status
);
2632 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2633 ASSERT_EFI_ERROR(Status
);
2636 // Use the last buffer from replacing to print from...
2638 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2640 if (Col
!= -1 && Row
!= -1) {
2641 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2644 FormatWalker
= mPostReplaceFormat2
;
2645 while (*FormatWalker
!= CHAR_NULL
) {
2647 // Find the next attribute change request
2649 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2650 if (ResumeLocation
!= NULL
) {
2651 *ResumeLocation
= CHAR_NULL
;
2654 // print the current FormatWalker string
2656 if (StrLen(FormatWalker
)>0) {
2657 Status
= InternalPrintTo(FormatWalker
);
2658 if (EFI_ERROR(Status
)) {
2664 // update the attribute
2666 if (ResumeLocation
!= NULL
) {
2667 switch (*(ResumeLocation
+1)) {
2669 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2672 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2675 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2678 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2681 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2685 // Print a simple '%' symbol
2687 Status
= InternalPrintTo(L
"%");
2688 if (EFI_ERROR(Status
)) {
2691 ResumeLocation
= ResumeLocation
- 1;
2696 // reset to normal now...
2702 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2704 FormatWalker
= ResumeLocation
+ 2;
2707 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2709 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2710 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2715 Print at a specific location on the screen.
2717 This function will move the cursor to a given screen location and print the specified string.
2719 If -1 is specified for either the Row or Col the current screen location for BOTH
2722 If either Row or Col is out of range for the current console, then ASSERT.
2723 If Format is NULL, then ASSERT.
2725 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2726 the following additional flags:
2727 %N - Set output attribute to normal
2728 %H - Set output attribute to highlight
2729 %E - Set output attribute to error
2730 %B - Set output attribute to blue color
2731 %V - Set output attribute to green color
2733 Note: The background color is controlled by the shell command cls.
2735 @param[in] Col the column to print at
2736 @param[in] Row the row to print at
2737 @param[in] Format the format string
2738 @param[in] ... The variable argument list.
2740 @return EFI_SUCCESS The printing was successful.
2741 @return EFI_DEVICE_ERROR The console device reported an error.
2746 IN INT32 Col OPTIONAL
,
2747 IN INT32 Row OPTIONAL
,
2748 IN CONST CHAR16
*Format
,
2754 if (Format
== NULL
) {
2755 return (EFI_INVALID_PARAMETER
);
2757 VA_START (Marker
, Format
);
2758 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2764 Print at a specific location on the screen.
2766 This function will move the cursor to a given screen location and print the specified string.
2768 If -1 is specified for either the Row or Col the current screen location for BOTH
2771 If either Row or Col is out of range for the current console, then ASSERT.
2772 If Format is NULL, then ASSERT.
2774 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2775 the following additional flags:
2776 %N - Set output attribute to normal.
2777 %H - Set output attribute to highlight.
2778 %E - Set output attribute to error.
2779 %B - Set output attribute to blue color.
2780 %V - Set output attribute to green color.
2782 Note: The background color is controlled by the shell command cls.
2784 @param[in] Col The column to print at.
2785 @param[in] Row The row to print at.
2786 @param[in] Language The language of the string to retrieve. If this parameter
2787 is NULL, then the current platform language is used.
2788 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2789 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2790 @param[in] ... The variable argument list.
2792 @return EFI_SUCCESS The printing was successful.
2793 @return EFI_DEVICE_ERROR The console device reported an error.
2798 IN INT32 Col OPTIONAL
,
2799 IN INT32 Row OPTIONAL
,
2800 IN CONST CHAR8
*Language OPTIONAL
,
2801 IN CONST EFI_STRING_ID HiiFormatStringId
,
2802 IN CONST EFI_HANDLE HiiFormatHandle
,
2807 CHAR16
*HiiFormatString
;
2810 VA_START (Marker
, HiiFormatHandle
);
2811 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2812 ASSERT(HiiFormatString
!= NULL
);
2814 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2816 SHELL_FREE_NON_NULL(HiiFormatString
);
2823 Function to determine if a given filename represents a file or a directory.
2825 @param[in] DirName Path to directory to test.
2827 @retval EFI_SUCCESS The Path represents a directory
2828 @retval EFI_NOT_FOUND The Path does not represent a directory
2829 @return other The path failed to open
2834 IN CONST CHAR16
*DirName
2838 SHELL_FILE_HANDLE Handle
;
2839 CHAR16
*TempLocation
;
2840 CHAR16
*TempLocation2
;
2842 ASSERT(DirName
!= NULL
);
2845 TempLocation
= NULL
;
2847 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
2848 if (EFI_ERROR(Status
)) {
2850 // try good logic first.
2852 if (mEfiShellProtocol
!= NULL
) {
2853 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
2854 TempLocation2
= StrStr(TempLocation
, L
":");
2855 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
2856 *(TempLocation2
+1) = CHAR_NULL
;
2858 if (mEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
2859 FreePool(TempLocation
);
2860 return (EFI_SUCCESS
);
2862 FreePool(TempLocation
);
2865 // probably a map name?!?!!?
2867 TempLocation
= StrStr(DirName
, L
"\\");
2868 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
2869 return (EFI_SUCCESS
);
2875 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
2876 ShellCloseFile(&Handle
);
2877 return (EFI_SUCCESS
);
2879 ShellCloseFile(&Handle
);
2880 return (EFI_NOT_FOUND
);
2884 Function to determine if a given filename represents a file.
2886 @param[in] Name Path to file to test.
2888 @retval EFI_SUCCESS The Path represents a file.
2889 @retval EFI_NOT_FOUND The Path does not represent a file.
2890 @retval other The path failed to open.
2895 IN CONST CHAR16
*Name
2899 SHELL_FILE_HANDLE Handle
;
2901 ASSERT(Name
!= NULL
);
2905 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
2906 if (EFI_ERROR(Status
)) {
2910 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
2911 ShellCloseFile(&Handle
);
2912 return (EFI_SUCCESS
);
2914 ShellCloseFile(&Handle
);
2915 return (EFI_NOT_FOUND
);
2919 Function to determine if a given filename represents a file.
2921 This will search the CWD and then the Path.
2923 If Name is NULL, then ASSERT.
2925 @param[in] Name Path to file to test.
2927 @retval EFI_SUCCESS The Path represents a file.
2928 @retval EFI_NOT_FOUND The Path does not represent a file.
2929 @retval other The path failed to open.
2934 IN CONST CHAR16
*Name
2940 if (!EFI_ERROR(ShellIsFile(Name
))) {
2941 return (EFI_SUCCESS
);
2944 NewName
= ShellFindFilePath(Name
);
2945 if (NewName
== NULL
) {
2946 return (EFI_NOT_FOUND
);
2948 Status
= ShellIsFile(NewName
);
2954 Function to determine whether a string is decimal or hex representation of a number
2955 and return the number converted from the string.
2957 @param[in] String String representation of a number
2960 @retval (UINTN)(-1) An error ocurred.
2965 IN CONST CHAR16
*String
2973 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, TRUE
)) {
2977 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, Hex
, TRUE
))) {
2978 return ((UINTN
)RetVal
);
2980 return ((UINTN
)(-1));
2984 Safely append with automatic string resizing given length of Destination and
2985 desired length of copy from Source.
2987 append the first D characters of Source to the end of Destination, where D is
2988 the lesser of Count and the StrLen() of Source. If appending those D characters
2989 will fit within Destination (whose Size is given as CurrentSize) and
2990 still leave room for a NULL terminator, then those characters are appended,
2991 starting at the original terminating NULL of Destination, and a new terminating
2994 If appending D characters onto Destination will result in a overflow of the size
2995 given in CurrentSize the string will be grown such that the copy can be performed
2996 and CurrentSize will be updated to the new size.
2998 If Source is NULL, there is nothing to append, just return the current buffer in
3001 if Destination is NULL, then ASSERT()
3002 if Destination's current length (including NULL terminator) is already more then
3003 CurrentSize, then ASSERT()
3005 @param[in,out] Destination The String to append onto
3006 @param[in,out] CurrentSize on call the number of bytes in Destination. On
3007 return possibly the new size (still in bytes). if NULL
3008 then allocate whatever is needed.
3009 @param[in] Source The String to append from
3010 @param[in] Count Maximum number of characters to append. if 0 then
3013 @return Destination return the resultant string.
3018 IN OUT CHAR16
**Destination
,
3019 IN OUT UINTN
*CurrentSize
,
3020 IN CONST CHAR16
*Source
,
3024 UINTN DestinationStartSize
;
3030 ASSERT(Destination
!= NULL
);
3033 // If there's nothing to do then just return Destination
3035 if (Source
== NULL
) {
3036 return (*Destination
);
3040 // allow for un-initialized pointers, based on size being 0
3042 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
3043 *Destination
= NULL
;
3047 // allow for NULL pointers address as Destination
3049 if (*Destination
!= NULL
) {
3050 ASSERT(CurrentSize
!= 0);
3051 DestinationStartSize
= StrSize(*Destination
);
3052 ASSERT(DestinationStartSize
<= *CurrentSize
);
3054 DestinationStartSize
= 0;
3055 // ASSERT(*CurrentSize == 0);
3059 // Append all of Source?
3062 Count
= StrLen(Source
);
3066 // Test and grow if required
3068 if (CurrentSize
!= NULL
) {
3069 NewSize
= *CurrentSize
;
3070 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3071 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3073 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3074 ASSERT(*Destination
!= NULL
);
3075 *CurrentSize
= NewSize
;
3077 *Destination
= AllocateZeroPool((Count
+1)*sizeof(CHAR16
));
3078 ASSERT(*Destination
!= NULL
);
3082 // Now use standard StrnCat on a big enough buffer
3084 if (*Destination
== NULL
) {
3087 return StrnCat(*Destination
, Source
, Count
);
3091 Prompt the user and return the resultant answer to the requestor.
3093 This function will display the requested question on the shell prompt and then
3094 wait for an apropriate answer to be input from the console.
3096 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3097 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3099 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3102 In either case *Response must be callee freed if Response was not NULL;
3104 @param Type What type of question is asked. This is used to filter the input
3105 to prevent invalid answers to question.
3106 @param Prompt Pointer to string prompt to use to request input.
3107 @param Response Pointer to Response which will be populated upon return.
3109 @retval EFI_SUCCESS The operation was sucessful.
3110 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3111 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3112 @return other The operation failed.
3116 ShellPromptForResponse (
3117 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3118 IN CHAR16
*Prompt OPTIONAL
,
3119 IN OUT VOID
**Response OPTIONAL
3125 SHELL_PROMPT_RESPONSE
*Resp
;
3129 Status
= EFI_UNSUPPORTED
;
3133 if (Type
!= ShellPromptResponseTypeFreeform
) {
3134 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE
));
3136 return (EFI_OUT_OF_RESOURCES
);
3141 case ShellPromptResponseTypeQuitContinue
:
3142 if (Prompt
!= NULL
) {
3143 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3146 // wait for valid response
3148 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3149 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3150 ASSERT_EFI_ERROR(Status
);
3151 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3152 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3153 *Resp
= ShellPromptResponseQuit
;
3155 *Resp
= ShellPromptResponseContinue
;
3158 case ShellPromptResponseTypeYesNoCancel
:
3159 if (Prompt
!= NULL
) {
3160 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3163 // wait for valid response
3165 *Resp
= ShellPromptResponseMax
;
3166 while (*Resp
== ShellPromptResponseMax
) {
3167 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3168 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3169 ASSERT_EFI_ERROR(Status
);
3170 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3171 switch (Key
.UnicodeChar
) {
3174 *Resp
= ShellPromptResponseYes
;
3178 *Resp
= ShellPromptResponseNo
;
3182 *Resp
= ShellPromptResponseCancel
;
3186 break; case ShellPromptResponseTypeYesNoAllCancel
:
3187 if (Prompt
!= NULL
) {
3188 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3191 // wait for valid response
3193 *Resp
= ShellPromptResponseMax
;
3194 while (*Resp
== ShellPromptResponseMax
) {
3195 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3196 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3197 ASSERT_EFI_ERROR(Status
);
3198 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3199 switch (Key
.UnicodeChar
) {
3202 *Resp
= ShellPromptResponseYes
;
3206 *Resp
= ShellPromptResponseNo
;
3210 *Resp
= ShellPromptResponseAll
;
3214 *Resp
= ShellPromptResponseCancel
;
3219 case ShellPromptResponseTypeEnterContinue
:
3220 case ShellPromptResponseTypeAnyKeyContinue
:
3221 if (Prompt
!= NULL
) {
3222 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3225 // wait for valid response
3227 *Resp
= ShellPromptResponseMax
;
3228 while (*Resp
== ShellPromptResponseMax
) {
3229 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3230 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3231 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3232 ASSERT_EFI_ERROR(Status
);
3233 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3234 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3235 *Resp
= ShellPromptResponseContinue
;
3239 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3240 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3241 ASSERT_EFI_ERROR(Status
);
3242 *Resp
= ShellPromptResponseContinue
;
3247 case ShellPromptResponseTypeYesNo
:
3248 if (Prompt
!= NULL
) {
3249 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3252 // wait for valid response
3254 *Resp
= ShellPromptResponseMax
;
3255 while (*Resp
== ShellPromptResponseMax
) {
3256 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3257 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3258 ASSERT_EFI_ERROR(Status
);
3259 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3260 switch (Key
.UnicodeChar
) {
3263 *Resp
= ShellPromptResponseYes
;
3267 *Resp
= ShellPromptResponseNo
;
3272 case ShellPromptResponseTypeFreeform
:
3273 if (Prompt
!= NULL
) {
3274 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3277 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3278 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3279 ASSERT_EFI_ERROR(Status
);
3280 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3281 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3284 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3285 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3289 // This is the location to add new prompt types.
3295 if (Response
!= NULL
) {
3298 } else if (Buffer
!= NULL
) {
3305 if (Buffer
!= NULL
) {
3310 ShellPrintEx(-1, -1, L
"\r\n");
3315 Prompt the user and return the resultant answer to the requestor.
3317 This function is the same as ShellPromptForResponse, except that the prompt is
3318 automatically pulled from HII.
3320 @param Type What type of question is asked. This is used to filter the input
3321 to prevent invalid answers to question.
3322 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3323 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3324 @param Response Pointer to Response which will be populated upon return.
3326 @retval EFI_SUCCESS the operation was sucessful.
3327 @return other the operation failed.
3329 @sa ShellPromptForResponse
3333 ShellPromptForResponseHii (
3334 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3335 IN CONST EFI_STRING_ID HiiFormatStringId
,
3336 IN CONST EFI_HANDLE HiiFormatHandle
,
3337 IN OUT VOID
**Response
3343 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3344 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3350 Function to determin if an entire string is a valid number.
3352 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3354 @param[in] String The string to evaluate.
3355 @param[in] ForceHex TRUE - always assume hex.
3356 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3358 @retval TRUE It is all numeric (dec/hex) characters.
3359 @retval FALSE There is a non-numeric character.
3363 InternalShellIsHexOrDecimalNumber (
3364 IN CONST CHAR16
*String
,
3365 IN CONST BOOLEAN ForceHex
,
3366 IN CONST BOOLEAN StopAtSpace
3372 // chop off a single negative sign
3374 if (String
!= NULL
&& *String
== L
'-') {
3378 if (String
== NULL
) {
3383 // chop leading zeroes
3385 while(String
!= NULL
&& *String
== L
'0'){
3389 // allow '0x' or '0X', but not 'x' or 'X'
3391 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3392 if (*(String
-1) != L
'0') {
3394 // we got an x without a preceeding 0
3400 } else if (ForceHex
) {
3407 // loop through the remaining characters and use the lib function
3409 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3411 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3415 if (!ShellIsDecimalDigitCharacter(*String
)) {
3425 Function to determine if a given filename exists.
3427 @param[in] Name Path to test.
3429 @retval EFI_SUCCESS The Path represents a file.
3430 @retval EFI_NOT_FOUND The Path does not represent a file.
3431 @retval other The path failed to open.
3436 IN CONST CHAR16
*Name
3440 EFI_SHELL_FILE_INFO
*List
;
3442 ASSERT(Name
!= NULL
);
3445 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3446 if (EFI_ERROR(Status
)) {
3450 ShellCloseFileMetaArg(&List
);
3452 return (EFI_SUCCESS
);
3456 Convert a Unicode character to upper case only if
3457 it maps to a valid small-case ASCII character.
3459 This internal function only deal with Unicode character
3460 which maps to a valid small-case ASCII character, i.e.
3461 L'a' to L'z'. For other Unicode character, the input character
3462 is returned directly.
3464 @param Char The character to convert.
3466 @retval LowerCharacter If the Char is with range L'a' to L'z'.
3467 @retval Unchanged Otherwise.
3472 InternalShellCharToUpper (
3476 if (Char
>= L
'a' && Char
<= L
'z') {
3477 return (CHAR16
) (Char
- (L
'a' - L
'A'));
3484 Convert a Unicode character to numerical value.
3486 This internal function only deal with Unicode character
3487 which maps to a valid hexadecimal ASII character, i.e.
3488 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
3489 Unicode character, the value returned does not make sense.
3491 @param Char The character to convert.
3493 @return The numerical value converted.
3498 InternalShellHexCharToUintn (
3502 if (ShellIsDecimalDigitCharacter (Char
)) {
3506 return (UINTN
) (10 + InternalShellCharToUpper (Char
) - L
'A');
3510 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
3512 This function returns a value of type UINTN by interpreting the contents
3513 of the Unicode string specified by String as a hexadecimal number.
3514 The format of the input Unicode string String is:
3516 [spaces][zeros][x][hexadecimal digits].
3518 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
3519 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
3520 If "x" appears in the input string, it must be prefixed with at least one 0.
3521 The function will ignore the pad space, which includes spaces or tab characters,
3522 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
3523 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
3524 first valid hexadecimal digit. Then, the function stops at the first character that is
3525 a not a valid hexadecimal character or NULL, whichever one comes first.
3527 If String has only pad spaces, then zero is returned.
3528 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
3529 then zero is returned.
3531 @param[in] String A pointer to a Null-terminated Unicode string.
3532 @param[out] Value Upon a successful return the value of the conversion.
3533 @param[in] StopAtSpace FALSE to skip spaces.
3535 @retval EFI_SUCCESS The conversion was successful.
3536 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3537 @retval EFI_DEVICE_ERROR An overflow occured.
3541 InternalShellStrHexToUint64 (
3542 IN CONST CHAR16
*String
,
3544 IN CONST BOOLEAN StopAtSpace
3549 if (String
== NULL
|| StrSize(String
) == 0 || Value
== NULL
) {
3550 return (EFI_INVALID_PARAMETER
);
3554 // Ignore the pad spaces (space or tab)
3556 while ((*String
== L
' ') || (*String
== L
'\t')) {
3561 // Ignore leading Zeros after the spaces
3563 while (*String
== L
'0') {
3567 if (InternalShellCharToUpper (*String
) == L
'X') {
3568 if (*(String
- 1) != L
'0') {
3580 // Skip spaces if requested
3582 while (StopAtSpace
&& *String
== L
' ') {
3586 while (ShellIsHexaDecimalDigitCharacter (*String
)) {
3588 // If the Hex Number represented by String overflows according
3589 // to the range defined by UINTN, then ASSERT().
3591 if (!(Result
<= (RShiftU64((((UINT64
) ~0) - InternalShellHexCharToUintn (*String
)), 4)))) {
3592 // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {
3593 return (EFI_DEVICE_ERROR
);
3596 Result
= (LShiftU64(Result
, 4));
3597 Result
+= InternalShellHexCharToUintn (*String
);
3601 // Skip spaces if requested
3603 while (StopAtSpace
&& *String
== L
' ') {
3609 return (EFI_SUCCESS
);
3613 Convert a Null-terminated Unicode decimal string to a value of
3616 This function returns a value of type UINT64 by interpreting the contents
3617 of the Unicode string specified by String as a decimal number. The format
3618 of the input Unicode string String is:
3620 [spaces] [decimal digits].
3622 The valid decimal digit character is in the range [0-9]. The
3623 function will ignore the pad space, which includes spaces or
3624 tab characters, before [decimal digits]. The running zero in the
3625 beginning of [decimal digits] will be ignored. Then, the function
3626 stops at the first character that is a not a valid decimal character
3627 or a Null-terminator, whichever one comes first.
3629 If String has only pad spaces, then 0 is returned.
3630 If String has no pad spaces or valid decimal digits,
3633 @param[in] String A pointer to a Null-terminated Unicode string.
3634 @param[out] Value Upon a successful return the value of the conversion.
3635 @param[in] StopAtSpace FALSE to skip spaces.
3637 @retval EFI_SUCCESS The conversion was successful.
3638 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3639 @retval EFI_DEVICE_ERROR An overflow occured.
3643 InternalShellStrDecimalToUint64 (
3644 IN CONST CHAR16
*String
,
3646 IN CONST BOOLEAN StopAtSpace
3651 if (String
== NULL
|| StrSize (String
) == 0 || Value
== NULL
) {
3652 return (EFI_INVALID_PARAMETER
);
3656 // Ignore the pad spaces (space or tab)
3658 while ((*String
== L
' ') || (*String
== L
'\t')) {
3663 // Ignore leading Zeros after the spaces
3665 while (*String
== L
'0') {
3672 // Skip spaces if requested
3674 while (StopAtSpace
&& *String
== L
' ') {
3677 while (ShellIsDecimalDigitCharacter (*String
)) {
3679 // If the number represented by String overflows according
3680 // to the range defined by UINT64, then ASSERT().
3683 if (!(Result
<= (DivU64x32((((UINT64
) ~0) - (*String
- L
'0')),10)))) {
3684 return (EFI_DEVICE_ERROR
);
3687 Result
= MultU64x32(Result
, 10) + (*String
- L
'0');
3691 // Stop at spaces if requested
3693 if (StopAtSpace
&& *String
== L
' ') {
3700 return (EFI_SUCCESS
);
3704 Function to verify and convert a string to its numerical value.
3706 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
3708 @param[in] String The string to evaluate.
3709 @param[out] Value Upon a successful return the value of the conversion.
3710 @param[in] ForceHex TRUE - always assume hex.
3711 @param[in] StopAtSpace FALSE to skip spaces.
3713 @retval EFI_SUCCESS The conversion was successful.
3714 @retval EFI_INVALID_PARAMETER String contained an invalid character.
3715 @retval EFI_NOT_FOUND String was a number, but Value was NULL.
3719 ShellConvertStringToUint64(
3720 IN CONST CHAR16
*String
,
3722 IN CONST BOOLEAN ForceHex
,
3723 IN CONST BOOLEAN StopAtSpace
3727 CONST CHAR16
*Walker
;
3733 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3736 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3737 return (EFI_INVALID_PARAMETER
);
3740 return (EFI_INVALID_PARAMETER
);
3745 // Chop off leading spaces
3747 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
3750 // make sure we have something left that is numeric.
3752 if (Walker
== NULL
|| *Walker
== CHAR_NULL
|| !InternalShellIsHexOrDecimalNumber(Walker
, Hex
, StopAtSpace
)) {
3753 return (EFI_INVALID_PARAMETER
);
3757 // do the conversion.
3759 if (Hex
|| StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
3760 Status
= InternalShellStrHexToUint64(Walker
, &RetVal
, StopAtSpace
);
3762 Status
= InternalShellStrDecimalToUint64(Walker
, &RetVal
, StopAtSpace
);
3765 if (Value
== NULL
&& !EFI_ERROR(Status
)) {
3766 return (EFI_NOT_FOUND
);
3769 if (Value
!= NULL
) {
3777 Function to determin if an entire string is a valid number.
3779 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3781 @param[in] String The string to evaluate.
3782 @param[in] ForceHex TRUE - always assume hex.
3783 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3785 @retval TRUE It is all numeric (dec/hex) characters.
3786 @retval FALSE There is a non-numeric character.
3790 ShellIsHexOrDecimalNumber (
3791 IN CONST CHAR16
*String
,
3792 IN CONST BOOLEAN ForceHex
,
3793 IN CONST BOOLEAN StopAtSpace
3796 if (ShellConvertStringToUint64(String
, NULL
, ForceHex
, StopAtSpace
) == EFI_NOT_FOUND
) {