2 Provides interface to shell functionality for shell commands and applications.
4 Copyright (c) 2006 - 2010, 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>
18 #define FIND_XXXXX_FILE_BUFFER_SIZE (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)
23 SHELL_PARAM_ITEM EmptyParamList
[] = {
26 SHELL_PARAM_ITEM SfoParamList
[] = {
30 EFI_SHELL_ENVIRONMENT2
*mEfiShellEnvironment2
;
31 EFI_SHELL_INTERFACE
*mEfiShellInterface
;
32 EFI_SHELL_PROTOCOL
*mEfiShellProtocol
;
33 EFI_SHELL_PARAMETERS_PROTOCOL
*mEfiShellParametersProtocol
;
34 EFI_HANDLE mEfiShellEnvironment2Handle
;
35 FILE_HANDLE_FUNCTION_MAP FileFunctionMap
;
36 CHAR16
*mPostReplaceFormat
;
37 CHAR16
*mPostReplaceFormat2
;
40 Check if a Unicode character is a hexadecimal character.
42 This internal function checks if a Unicode character is a
43 numeric character. The valid hexadecimal characters are
44 L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
46 @param Char The character to check against.
48 @retval TRUE If the Char is a hexadecmial character.
49 @retval FALSE If the Char is not a hexadecmial character.
54 ShellIsHexaDecimalDigitCharacter (
58 return (BOOLEAN
) ((Char
>= L
'0' && Char
<= L
'9') || (Char
>= L
'A' && Char
<= L
'F') || (Char
>= L
'a' && Char
<= L
'f'));
62 Check if a Unicode character is a decimal character.
64 This internal function checks if a Unicode character is a
65 decimal character. The valid characters are
69 @param Char The character to check against.
71 @retval TRUE If the Char is a hexadecmial character.
72 @retval FALSE If the Char is not a hexadecmial character.
77 ShellIsDecimalDigitCharacter (
81 return (BOOLEAN
) (Char
>= L
'0' && Char
<= L
'9');
85 Helper function to find ShellEnvironment2 for constructor.
87 @param[in] ImageHandle A copy of the calling image's handle.
92 IN EFI_HANDLE ImageHandle
102 Status
= gBS
->OpenProtocol(ImageHandle
,
103 &gEfiShellEnvironment2Guid
,
104 (VOID
**)&mEfiShellEnvironment2
,
107 EFI_OPEN_PROTOCOL_GET_PROTOCOL
110 // look for the mEfiShellEnvironment2 protocol at a higher level
112 if (EFI_ERROR (Status
) || !(CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
))){
114 // figure out how big of a buffer we need.
116 Status
= gBS
->LocateHandle (ByProtocol
,
117 &gEfiShellEnvironment2Guid
,
118 NULL
, // ignored for ByProtocol
123 // maybe it's not there???
125 if (Status
== EFI_BUFFER_TOO_SMALL
) {
126 Buffer
= (EFI_HANDLE
*)AllocatePool(BufferSize
);
127 ASSERT(Buffer
!= NULL
);
128 Status
= gBS
->LocateHandle (ByProtocol
,
129 &gEfiShellEnvironment2Guid
,
130 NULL
, // ignored for ByProtocol
135 if (!EFI_ERROR (Status
) && Buffer
!= NULL
) {
137 // now parse the list of returned handles
139 Status
= EFI_NOT_FOUND
;
140 for (HandleIndex
= 0; HandleIndex
< (BufferSize
/sizeof(Buffer
[0])); HandleIndex
++) {
141 Status
= gBS
->OpenProtocol(Buffer
[HandleIndex
],
142 &gEfiShellEnvironment2Guid
,
143 (VOID
**)&mEfiShellEnvironment2
,
146 EFI_OPEN_PROTOCOL_GET_PROTOCOL
148 if (CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
)) {
149 mEfiShellEnvironment2Handle
= Buffer
[HandleIndex
];
150 Status
= EFI_SUCCESS
;
156 if (Buffer
!= NULL
) {
163 Function to do most of the work of the constructor. Allows for calling
164 multiple times without complete re-initialization.
166 @param[in] ImageHandle A copy of the ImageHandle.
167 @param[in] SystemTable A pointer to the SystemTable for the application.
171 ShellLibConstructorWorker (
172 IN EFI_HANDLE ImageHandle
,
173 IN EFI_SYSTEM_TABLE
*SystemTable
177 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
178 ASSERT (mPostReplaceFormat
!= NULL
);
179 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
180 ASSERT (mPostReplaceFormat2
!= NULL
);
183 // UEFI 2.0 shell interfaces (used preferentially)
185 Status
= gBS
->OpenProtocol(
187 &gEfiShellProtocolGuid
,
188 (VOID
**)&mEfiShellProtocol
,
191 EFI_OPEN_PROTOCOL_GET_PROTOCOL
193 if (EFI_ERROR(Status
)) {
195 // Search for the shell protocol
197 Status
= gBS
->LocateProtocol(
198 &gEfiShellProtocolGuid
,
200 (VOID
**)&mEfiShellProtocol
202 if (EFI_ERROR(Status
)) {
203 mEfiShellProtocol
= NULL
;
206 Status
= gBS
->OpenProtocol(
208 &gEfiShellParametersProtocolGuid
,
209 (VOID
**)&mEfiShellParametersProtocol
,
212 EFI_OPEN_PROTOCOL_GET_PROTOCOL
214 if (EFI_ERROR(Status
)) {
215 mEfiShellParametersProtocol
= NULL
;
218 if (mEfiShellParametersProtocol
== NULL
|| mEfiShellProtocol
== NULL
) {
220 // Moved to seperate function due to complexity
222 Status
= ShellFindSE2(ImageHandle
);
224 if (EFI_ERROR(Status
)) {
225 DEBUG((DEBUG_ERROR
, "Status: 0x%08x\r\n", Status
));
226 mEfiShellEnvironment2
= NULL
;
228 Status
= gBS
->OpenProtocol(ImageHandle
,
229 &gEfiShellInterfaceGuid
,
230 (VOID
**)&mEfiShellInterface
,
233 EFI_OPEN_PROTOCOL_GET_PROTOCOL
235 if (EFI_ERROR(Status
)) {
236 mEfiShellInterface
= NULL
;
241 // only success getting 2 of either the old or new, but no 1/2 and 1/2
243 if ((mEfiShellEnvironment2
!= NULL
&& mEfiShellInterface
!= NULL
) ||
244 (mEfiShellProtocol
!= NULL
&& mEfiShellParametersProtocol
!= NULL
) ) {
245 if (mEfiShellProtocol
!= NULL
) {
246 FileFunctionMap
.GetFileInfo
= mEfiShellProtocol
->GetFileInfo
;
247 FileFunctionMap
.SetFileInfo
= mEfiShellProtocol
->SetFileInfo
;
248 FileFunctionMap
.ReadFile
= mEfiShellProtocol
->ReadFile
;
249 FileFunctionMap
.WriteFile
= mEfiShellProtocol
->WriteFile
;
250 FileFunctionMap
.CloseFile
= mEfiShellProtocol
->CloseFile
;
251 FileFunctionMap
.DeleteFile
= mEfiShellProtocol
->DeleteFile
;
252 FileFunctionMap
.GetFilePosition
= mEfiShellProtocol
->GetFilePosition
;
253 FileFunctionMap
.SetFilePosition
= mEfiShellProtocol
->SetFilePosition
;
254 FileFunctionMap
.FlushFile
= mEfiShellProtocol
->FlushFile
;
255 FileFunctionMap
.GetFileSize
= mEfiShellProtocol
->GetFileSize
;
257 FileFunctionMap
.GetFileInfo
= (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
;
258 FileFunctionMap
.SetFileInfo
= (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
;
259 FileFunctionMap
.ReadFile
= (EFI_SHELL_READ_FILE
)FileHandleRead
;
260 FileFunctionMap
.WriteFile
= (EFI_SHELL_WRITE_FILE
)FileHandleWrite
;
261 FileFunctionMap
.CloseFile
= (EFI_SHELL_CLOSE_FILE
)FileHandleClose
;
262 FileFunctionMap
.DeleteFile
= (EFI_SHELL_DELETE_FILE
)FileHandleDelete
;
263 FileFunctionMap
.GetFilePosition
= (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
;
264 FileFunctionMap
.SetFilePosition
= (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
;
265 FileFunctionMap
.FlushFile
= (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
;
266 FileFunctionMap
.GetFileSize
= (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
;
268 return (EFI_SUCCESS
);
270 return (EFI_NOT_FOUND
);
273 Constructor for the Shell library.
275 Initialize the library and determine if the underlying is a UEFI Shell 2.0 or an EFI shell.
277 @param ImageHandle the image handle of the process
278 @param SystemTable the EFI System Table pointer
280 @retval EFI_SUCCESS the initialization was complete sucessfully
281 @return others an error ocurred during initialization
285 ShellLibConstructor (
286 IN EFI_HANDLE ImageHandle
,
287 IN EFI_SYSTEM_TABLE
*SystemTable
290 mEfiShellEnvironment2
= NULL
;
291 mEfiShellProtocol
= NULL
;
292 mEfiShellParametersProtocol
= NULL
;
293 mEfiShellInterface
= NULL
;
294 mEfiShellEnvironment2Handle
= NULL
;
295 mPostReplaceFormat
= NULL
;
296 mPostReplaceFormat2
= NULL
;
299 // verify that auto initialize is not set false
301 if (PcdGetBool(PcdShellLibAutoInitialize
) == 0) {
302 return (EFI_SUCCESS
);
305 return (ShellLibConstructorWorker(ImageHandle
, SystemTable
));
309 Destructor for the library. free any resources.
311 @param[in] ImageHandle A copy of the ImageHandle.
312 @param[in] SystemTable A pointer to the SystemTable for the application.
314 @retval EFI_SUCCESS The operation was successful.
315 @return An error from the CloseProtocol function.
320 IN EFI_HANDLE ImageHandle
,
321 IN EFI_SYSTEM_TABLE
*SystemTable
324 if (mEfiShellEnvironment2
!= NULL
) {
325 gBS
->CloseProtocol(mEfiShellEnvironment2Handle
==NULL
?ImageHandle
:mEfiShellEnvironment2Handle
,
326 &gEfiShellEnvironment2Guid
,
329 mEfiShellEnvironment2
= NULL
;
331 if (mEfiShellInterface
!= NULL
) {
332 gBS
->CloseProtocol(ImageHandle
,
333 &gEfiShellInterfaceGuid
,
336 mEfiShellInterface
= NULL
;
338 if (mEfiShellProtocol
!= NULL
) {
339 gBS
->CloseProtocol(ImageHandle
,
340 &gEfiShellProtocolGuid
,
343 mEfiShellProtocol
= NULL
;
345 if (mEfiShellParametersProtocol
!= NULL
) {
346 gBS
->CloseProtocol(ImageHandle
,
347 &gEfiShellParametersProtocolGuid
,
350 mEfiShellParametersProtocol
= NULL
;
352 mEfiShellEnvironment2Handle
= NULL
;
354 if (mPostReplaceFormat
!= NULL
) {
355 FreePool(mPostReplaceFormat
);
357 if (mPostReplaceFormat2
!= NULL
) {
358 FreePool(mPostReplaceFormat2
);
360 mPostReplaceFormat
= NULL
;
361 mPostReplaceFormat2
= NULL
;
363 return (EFI_SUCCESS
);
367 This function causes the shell library to initialize itself. If the shell library
368 is already initialized it will de-initialize all the current protocol poitners and
369 re-populate them again.
371 When the library is used with PcdShellLibAutoInitialize set to true this function
372 will return EFI_SUCCESS and perform no actions.
374 This function is intended for internal access for shell commands only.
376 @retval EFI_SUCCESS the initialization was complete sucessfully
385 // if auto initialize is not false then skip
387 if (PcdGetBool(PcdShellLibAutoInitialize
) != 0) {
388 return (EFI_SUCCESS
);
392 // deinit the current stuff
394 ASSERT_EFI_ERROR(ShellLibDestructor(gImageHandle
, gST
));
397 // init the new stuff
399 return (ShellLibConstructorWorker(gImageHandle
, gST
));
403 This function will retrieve the information about the file for the handle
404 specified and store it in allocated pool memory.
406 This function allocates a buffer to store the file's information. It is the
407 caller's responsibility to free the buffer
409 @param FileHandle The file handle of the file for which information is
412 @retval NULL information could not be retrieved.
414 @return the information about the file
419 IN SHELL_FILE_HANDLE FileHandle
422 return (FileFunctionMap
.GetFileInfo(FileHandle
));
426 This function sets the information about the file for the opened handle
429 @param[in] FileHandle The file handle of the file for which information
432 @param[in] FileInfo The information to set.
434 @retval EFI_SUCCESS The information was set.
435 @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.
436 @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.
437 @retval EFI_NO_MEDIA The device has no medium.
438 @retval EFI_DEVICE_ERROR The device reported an error.
439 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
440 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
441 @retval EFI_ACCESS_DENIED The file was opened read only.
442 @retval EFI_VOLUME_FULL The volume is full.
447 IN SHELL_FILE_HANDLE FileHandle
,
448 IN EFI_FILE_INFO
*FileInfo
451 return (FileFunctionMap
.SetFileInfo(FileHandle
, FileInfo
));
455 This function will open a file or directory referenced by DevicePath.
457 This function opens a file with the open mode according to the file path. The
458 Attributes is valid only for EFI_FILE_MODE_CREATE.
460 @param FilePath on input the device path to the file. On output
461 the remaining device path.
462 @param DeviceHandle pointer to the system device handle.
463 @param FileHandle pointer to the file handle.
464 @param OpenMode the mode to open the file with.
465 @param Attributes the file's file attributes.
467 @retval EFI_SUCCESS The information was set.
468 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
469 @retval EFI_UNSUPPORTED Could not open the file path.
470 @retval EFI_NOT_FOUND The specified file could not be found on the
471 device or the file system could not be found on
473 @retval EFI_NO_MEDIA The device has no medium.
474 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
475 medium is no longer supported.
476 @retval EFI_DEVICE_ERROR The device reported an error.
477 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
478 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
479 @retval EFI_ACCESS_DENIED The file was opened read only.
480 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
482 @retval EFI_VOLUME_FULL The volume is full.
486 ShellOpenFileByDevicePath(
487 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
,
488 OUT EFI_HANDLE
*DeviceHandle
,
489 OUT SHELL_FILE_HANDLE
*FileHandle
,
496 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*EfiSimpleFileSystemProtocol
;
497 EFI_FILE_PROTOCOL
*Handle1
;
498 EFI_FILE_PROTOCOL
*Handle2
;
501 // ASERT for FileHandle, FilePath, and DeviceHandle being NULL
503 ASSERT(FilePath
!= NULL
);
504 ASSERT(FileHandle
!= NULL
);
505 ASSERT(DeviceHandle
!= NULL
);
507 // which shell interface should we use
509 if (mEfiShellProtocol
!= NULL
) {
511 // use UEFI Shell 2.0 method.
513 FileName
= mEfiShellProtocol
->GetFilePathFromDevicePath(*FilePath
);
514 if (FileName
== NULL
) {
515 return (EFI_INVALID_PARAMETER
);
517 Status
= ShellOpenFileByName(FileName
, FileHandle
, OpenMode
, Attributes
);
524 // use old shell method.
526 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
,
529 if (EFI_ERROR (Status
)) {
532 Status
= gBS
->OpenProtocol(*DeviceHandle
,
533 &gEfiSimpleFileSystemProtocolGuid
,
534 (VOID
**)&EfiSimpleFileSystemProtocol
,
537 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
538 if (EFI_ERROR (Status
)) {
541 Status
= EfiSimpleFileSystemProtocol
->OpenVolume(EfiSimpleFileSystemProtocol
, &Handle1
);
542 if (EFI_ERROR (Status
)) {
548 // go down directories one node at a time.
550 while (!IsDevicePathEnd (*FilePath
)) {
552 // For file system access each node should be a file path component
554 if (DevicePathType (*FilePath
) != MEDIA_DEVICE_PATH
||
555 DevicePathSubType (*FilePath
) != MEDIA_FILEPATH_DP
558 return (EFI_INVALID_PARAMETER
);
561 // Open this file path node
567 // Try to test opening an existing file
569 Status
= Handle2
->Open (
572 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
573 OpenMode
&~EFI_FILE_MODE_CREATE
,
578 // see if the error was that it needs to be created
580 if ((EFI_ERROR (Status
)) && (OpenMode
!= (OpenMode
&~EFI_FILE_MODE_CREATE
))) {
581 Status
= Handle2
->Open (
584 ((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
,
590 // Close the last node
592 Handle2
->Close (Handle2
);
594 if (EFI_ERROR(Status
)) {
601 *FilePath
= NextDevicePathNode (*FilePath
);
605 // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!
607 *FileHandle
= (VOID
*)Handle1
;
608 return (EFI_SUCCESS
);
612 This function will open a file or directory referenced by filename.
614 If return is EFI_SUCCESS, the Filehandle is the opened file's handle;
615 otherwise, the Filehandle is NULL. The Attributes is valid only for
616 EFI_FILE_MODE_CREATE.
618 if FileNAme is NULL then ASSERT()
620 @param FileName pointer to file name
621 @param FileHandle pointer to the file handle.
622 @param OpenMode the mode to open the file with.
623 @param Attributes the file's file attributes.
625 @retval EFI_SUCCESS The information was set.
626 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
627 @retval EFI_UNSUPPORTED Could not open the file path.
628 @retval EFI_NOT_FOUND The specified file could not be found on the
629 device or the file system could not be found
631 @retval EFI_NO_MEDIA The device has no medium.
632 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
633 medium is no longer supported.
634 @retval EFI_DEVICE_ERROR The device reported an error.
635 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
636 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
637 @retval EFI_ACCESS_DENIED The file was opened read only.
638 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
640 @retval EFI_VOLUME_FULL The volume is full.
645 IN CONST CHAR16
*FileName
,
646 OUT SHELL_FILE_HANDLE
*FileHandle
,
651 EFI_HANDLE DeviceHandle
;
652 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
654 EFI_FILE_INFO
*FileInfo
;
657 // ASSERT if FileName is NULL
659 ASSERT(FileName
!= NULL
);
661 if (FileName
== NULL
) {
662 return (EFI_INVALID_PARAMETER
);
665 if (mEfiShellProtocol
!= NULL
) {
666 if ((OpenMode
& EFI_FILE_MODE_CREATE
) == EFI_FILE_MODE_CREATE
&& (Attributes
& EFI_FILE_DIRECTORY
) == EFI_FILE_DIRECTORY
) {
667 return ShellCreateDirectory(FileName
, FileHandle
);
670 // Use UEFI Shell 2.0 method
672 Status
= mEfiShellProtocol
->OpenFileByName(FileName
,
675 if (StrCmp(FileName
, L
"NUL") != 0 && !EFI_ERROR(Status
) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)){
676 FileInfo
= FileFunctionMap
.GetFileInfo(*FileHandle
);
677 ASSERT(FileInfo
!= NULL
);
678 FileInfo
->Attribute
= Attributes
;
679 Status
= FileFunctionMap
.SetFileInfo(*FileHandle
, FileInfo
);
685 // Using EFI Shell version
686 // this means convert name to path and call that function
687 // since this will use EFI method again that will open it.
689 ASSERT(mEfiShellEnvironment2
!= NULL
);
690 FilePath
= mEfiShellEnvironment2
->NameToPath ((CHAR16
*)FileName
);
691 if (FilePath
!= NULL
) {
692 return (ShellOpenFileByDevicePath(&FilePath
,
698 return (EFI_DEVICE_ERROR
);
701 This function create a directory
703 If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;
704 otherwise, the Filehandle is NULL. If the directory already existed, this
705 function opens the existing directory.
707 @param DirectoryName pointer to directory name
708 @param FileHandle pointer to the file handle.
710 @retval EFI_SUCCESS The information was set.
711 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
712 @retval EFI_UNSUPPORTED Could not open the file path.
713 @retval EFI_NOT_FOUND The specified file could not be found on the
714 device or the file system could not be found
716 @retval EFI_NO_MEDIA The device has no medium.
717 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
718 medium is no longer supported.
719 @retval EFI_DEVICE_ERROR The device reported an error.
720 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
721 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
722 @retval EFI_ACCESS_DENIED The file was opened read only.
723 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
725 @retval EFI_VOLUME_FULL The volume is full.
726 @sa ShellOpenFileByName
730 ShellCreateDirectory(
731 IN CONST CHAR16
*DirectoryName
,
732 OUT SHELL_FILE_HANDLE
*FileHandle
735 if (mEfiShellProtocol
!= NULL
) {
737 // Use UEFI Shell 2.0 method
739 return (mEfiShellProtocol
->CreateFile(DirectoryName
,
744 return (ShellOpenFileByName(DirectoryName
,
746 EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
,
753 This function reads information from an opened file.
755 If FileHandle is not a directory, the function reads the requested number of
756 bytes from the file at the file's current position and returns them in Buffer.
757 If the read goes beyond the end of the file, the read length is truncated to the
758 end of the file. The file's current position is increased by the number of bytes
759 returned. If FileHandle is a directory, the function reads the directory entry
760 at the file's current position and returns the entry in Buffer. If the Buffer
761 is not large enough to hold the current directory entry, then
762 EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
763 BufferSize is set to be the size of the buffer needed to read the entry. On
764 success, the current position is updated to the next directory entry. If there
765 are no more directory entries, the read returns a zero-length buffer.
766 EFI_FILE_INFO is the structure returned as the directory entry.
768 @param FileHandle the opened file handle
769 @param BufferSize on input the size of buffer in bytes. on return
770 the number of bytes written.
771 @param Buffer the buffer to put read data into.
773 @retval EFI_SUCCESS Data was read.
774 @retval EFI_NO_MEDIA The device has no media.
775 @retval EFI_DEVICE_ERROR The device reported an error.
776 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
777 @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
784 IN SHELL_FILE_HANDLE FileHandle
,
785 IN OUT UINTN
*BufferSize
,
789 return (FileFunctionMap
.ReadFile(FileHandle
, BufferSize
, Buffer
));
794 Write data to a file.
796 This function writes the specified number of bytes to the file at the current
797 file position. The current file position is advanced the actual number of bytes
798 written, which is returned in BufferSize. Partial writes only occur when there
799 has been a data error during the write attempt (such as "volume space full").
800 The file is automatically grown to hold the data if required. Direct writes to
801 opened directories are not supported.
803 @param FileHandle The opened file for writing
804 @param BufferSize on input the number of bytes in Buffer. On output
805 the number of bytes written.
806 @param Buffer the buffer containing data to write is stored.
808 @retval EFI_SUCCESS Data was written.
809 @retval EFI_UNSUPPORTED Writes to an open directory are not supported.
810 @retval EFI_NO_MEDIA The device has no media.
811 @retval EFI_DEVICE_ERROR The device reported an error.
812 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
813 @retval EFI_WRITE_PROTECTED The device is write-protected.
814 @retval EFI_ACCESS_DENIED The file was open for read only.
815 @retval EFI_VOLUME_FULL The volume is full.
820 IN SHELL_FILE_HANDLE FileHandle
,
821 IN OUT UINTN
*BufferSize
,
825 return (FileFunctionMap
.WriteFile(FileHandle
, BufferSize
, Buffer
));
829 Close an open file handle.
831 This function closes a specified file handle. All "dirty" cached file data is
832 flushed to the device, and the file is closed. In all cases the handle is
835 @param FileHandle the file handle to close.
837 @retval EFI_SUCCESS the file handle was closed sucessfully.
842 IN SHELL_FILE_HANDLE
*FileHandle
845 return (FileFunctionMap
.CloseFile(*FileHandle
));
849 Delete a file and close the handle
851 This function closes and deletes a file. In all cases the file handle is closed.
852 If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
853 returned, but the handle is still closed.
855 @param FileHandle the file handle to delete
857 @retval EFI_SUCCESS the file was closed sucessfully
858 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
860 @retval INVALID_PARAMETER One of the parameters has an invalid value.
865 IN SHELL_FILE_HANDLE
*FileHandle
868 return (FileFunctionMap
.DeleteFile(*FileHandle
));
872 Set the current position in a file.
874 This function sets the current file position for the handle to the position
875 supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only
876 absolute positioning is supported, and seeking past the end of the file is
877 allowed (a subsequent write would grow the file). Seeking to position
878 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
879 If FileHandle is a directory, the only position that may be set is zero. This
880 has the effect of starting the read process of the directory entries over.
882 @param FileHandle The file handle on which the position is being set
883 @param Position Byte position from begining of file
885 @retval EFI_SUCCESS Operation completed sucessfully.
886 @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on
888 @retval INVALID_PARAMETER One of the parameters has an invalid value.
892 ShellSetFilePosition (
893 IN SHELL_FILE_HANDLE FileHandle
,
897 return (FileFunctionMap
.SetFilePosition(FileHandle
, Position
));
901 Gets a file's current position
903 This function retrieves the current file position for the file handle. For
904 directories, the current file position has no meaning outside of the file
905 system driver and as such the operation is not supported. An error is returned
906 if FileHandle is a directory.
908 @param FileHandle The open file handle on which to get the position.
909 @param Position Byte position from begining of file.
911 @retval EFI_SUCCESS the operation completed sucessfully.
912 @retval INVALID_PARAMETER One of the parameters has an invalid value.
913 @retval EFI_UNSUPPORTED the request is not valid on directories.
917 ShellGetFilePosition (
918 IN SHELL_FILE_HANDLE FileHandle
,
922 return (FileFunctionMap
.GetFilePosition(FileHandle
, Position
));
925 Flushes data on a file
927 This function flushes all modified data associated with a file to a device.
929 @param FileHandle The file handle on which to flush data
931 @retval EFI_SUCCESS The data was flushed.
932 @retval EFI_NO_MEDIA The device has no media.
933 @retval EFI_DEVICE_ERROR The device reported an error.
934 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
935 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
936 @retval EFI_ACCESS_DENIED The file was opened for read only.
941 IN SHELL_FILE_HANDLE FileHandle
944 return (FileFunctionMap
.FlushFile(FileHandle
));
948 Retrieves the first file from a directory
950 This function opens a directory and gets the first file's info in the
951 directory. Caller can use ShellFindNextFile() to get other files. When
952 complete the caller is responsible for calling FreePool() on Buffer.
954 @param DirHandle The file handle of the directory to search
955 @param Buffer Pointer to buffer for file's information
957 @retval EFI_SUCCESS Found the first file.
958 @retval EFI_NOT_FOUND Cannot find the directory.
959 @retval EFI_NO_MEDIA The device has no media.
960 @retval EFI_DEVICE_ERROR The device reported an error.
961 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
962 @return Others status of ShellGetFileInfo, ShellSetFilePosition,
968 IN SHELL_FILE_HANDLE DirHandle
,
969 OUT EFI_FILE_INFO
**Buffer
973 // pass to file handle lib
975 return (FileHandleFindFirstFile(DirHandle
, Buffer
));
978 Retrieves the next file in a directory.
980 To use this function, caller must call the ShellFindFirstFile() to get the
981 first file, and then use this function get other files. This function can be
982 called for several times to get each file's information in the directory. If
983 the call of ShellFindNextFile() got the last file in the directory, the next
984 call of this function has no file to get. *NoFile will be set to TRUE and the
985 Buffer memory will be automatically freed.
987 @param DirHandle the file handle of the directory
988 @param Buffer pointer to buffer for file's information
989 @param NoFile pointer to boolean when last file is found
991 @retval EFI_SUCCESS Found the next file, or reached last file
992 @retval EFI_NO_MEDIA The device has no media.
993 @retval EFI_DEVICE_ERROR The device reported an error.
994 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
999 IN SHELL_FILE_HANDLE DirHandle
,
1000 OUT EFI_FILE_INFO
*Buffer
,
1005 // pass to file handle lib
1007 return (FileHandleFindNextFile(DirHandle
, Buffer
, NoFile
));
1010 Retrieve the size of a file.
1012 if FileHandle is NULL then ASSERT()
1013 if Size is NULL then ASSERT()
1015 This function extracts the file size info from the FileHandle's EFI_FILE_INFO
1018 @param FileHandle file handle from which size is retrieved
1019 @param Size pointer to size
1021 @retval EFI_SUCCESS operation was completed sucessfully
1022 @retval EFI_DEVICE_ERROR cannot access the file
1027 IN SHELL_FILE_HANDLE FileHandle
,
1031 return (FileFunctionMap
.GetFileSize(FileHandle
, Size
));
1034 Retrieves the status of the break execution flag
1036 this function is useful to check whether the application is being asked to halt by the shell.
1038 @retval TRUE the execution break is enabled
1039 @retval FALSE the execution break is not enabled
1043 ShellGetExecutionBreakFlag(
1048 // Check for UEFI Shell 2.0 protocols
1050 if (mEfiShellProtocol
!= NULL
) {
1053 // We are using UEFI Shell 2.0; see if the event has been triggered
1055 if (gBS
->CheckEvent(mEfiShellProtocol
->ExecutionBreak
) != EFI_SUCCESS
) {
1062 // using EFI Shell; call the function to check
1064 ASSERT(mEfiShellEnvironment2
!= NULL
);
1065 return (mEfiShellEnvironment2
->GetExecutionBreak());
1068 return the value of an environment variable
1070 this function gets the value of the environment variable set by the
1071 ShellSetEnvironmentVariable function
1073 @param EnvKey The key name of the environment variable.
1075 @retval NULL the named environment variable does not exist.
1076 @return != NULL pointer to the value of the environment variable
1080 ShellGetEnvironmentVariable (
1081 IN CONST CHAR16
*EnvKey
1085 // Check for UEFI Shell 2.0 protocols
1087 if (mEfiShellProtocol
!= NULL
) {
1088 return (mEfiShellProtocol
->GetEnv(EnvKey
));
1092 // ASSERT that we must have EFI shell
1094 ASSERT(mEfiShellEnvironment2
!= NULL
);
1099 return (mEfiShellEnvironment2
->GetEnv((CHAR16
*)EnvKey
));
1102 set the value of an environment variable
1104 This function changes the current value of the specified environment variable. If the
1105 environment variable exists and the Value is an empty string, then the environment
1106 variable is deleted. If the environment variable exists and the Value is not an empty
1107 string, then the value of the environment variable is changed. If the environment
1108 variable does not exist and the Value is an empty string, there is no action. If the
1109 environment variable does not exist and the Value is a non-empty string, then the
1110 environment variable is created and assigned the specified value.
1112 This is not supported pre-UEFI Shell 2.0.
1114 @param EnvKey The key name of the environment variable.
1115 @param EnvVal The Value of the environment variable
1116 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
1118 @retval EFI_SUCCESS the operation was completed sucessfully
1119 @retval EFI_UNSUPPORTED This operation is not allowed in pre UEFI 2.0 Shell environments
1123 ShellSetEnvironmentVariable (
1124 IN CONST CHAR16
*EnvKey
,
1125 IN CONST CHAR16
*EnvVal
,
1130 // Check for UEFI Shell 2.0 protocols
1132 if (mEfiShellProtocol
!= NULL
) {
1133 return (mEfiShellProtocol
->SetEnv(EnvKey
, EnvVal
, Volatile
));
1137 // This feature does not exist under EFI shell
1139 return (EFI_UNSUPPORTED
);
1143 Cause the shell to parse and execute a command line.
1145 This function creates a nested instance of the shell and executes the specified
1146 command (CommandLine) with the specified environment (Environment). Upon return,
1147 the status code returned by the specified command is placed in StatusCode.
1148 If Environment is NULL, then the current environment is used and all changes made
1149 by the commands executed will be reflected in the current environment. If the
1150 Environment is non-NULL, then the changes made will be discarded.
1151 The CommandLine is executed from the current working directory on the current
1154 The EnvironmentVariables and Status parameters are ignored in a pre-UEFI Shell 2.0
1155 environment. The values pointed to by the parameters will be unchanged by the
1156 ShellExecute() function. The Output parameter has no effect in a
1157 UEFI Shell 2.0 environment.
1159 @param[in] ParentHandle The parent image starting the operation.
1160 @param[in] CommandLine The pointer to a NULL terminated command line.
1161 @param[in] Output True to display debug output. False to hide it.
1162 @param[in] EnvironmentVariables Optional pointer to array of environment variables
1163 in the form "x=y". If NULL, the current set is used.
1164 @param[out] Status The status of the run command line.
1166 @retval EFI_SUCCESS The operation completed sucessfully. Status
1167 contains the status code returned.
1168 @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.
1169 @retval EFI_OUT_OF_RESOURCES Out of resources.
1170 @retval EFI_UNSUPPORTED The operation is not allowed.
1176 IN EFI_HANDLE
*ParentHandle
,
1177 IN CHAR16
*CommandLine OPTIONAL
,
1178 IN BOOLEAN Output OPTIONAL
,
1179 IN CHAR16
**EnvironmentVariables OPTIONAL
,
1180 OUT EFI_STATUS
*Status OPTIONAL
1184 // Check for UEFI Shell 2.0 protocols
1186 if (mEfiShellProtocol
!= NULL
) {
1188 // Call UEFI Shell 2.0 version (not using Output parameter)
1190 return (mEfiShellProtocol
->Execute(ParentHandle
,
1192 EnvironmentVariables
,
1196 // ASSERT that we must have EFI shell
1198 ASSERT(mEfiShellEnvironment2
!= NULL
);
1200 // Call EFI Shell version (not using EnvironmentVariables or Status parameters)
1201 // Due to oddity in the EFI shell we want to dereference the ParentHandle here
1203 return (mEfiShellEnvironment2
->Execute(*ParentHandle
,
1208 Retreives the current directory path
1210 If the DeviceName is NULL, it returns the current device's current directory
1211 name. If the DeviceName is not NULL, it returns the current directory name
1214 @param DeviceName the name of the drive to get directory on
1216 @retval NULL the directory does not exist
1217 @return != NULL the directory
1221 ShellGetCurrentDir (
1222 IN CHAR16
* CONST DeviceName OPTIONAL
1226 // Check for UEFI Shell 2.0 protocols
1228 if (mEfiShellProtocol
!= NULL
) {
1229 return (mEfiShellProtocol
->GetCurDir(DeviceName
));
1232 // ASSERT that we must have EFI shell
1234 ASSERT(mEfiShellEnvironment2
!= NULL
);
1235 return (mEfiShellEnvironment2
->CurDir(DeviceName
));
1238 sets (enabled or disabled) the page break mode
1240 when page break mode is enabled the screen will stop scrolling
1241 and wait for operator input before scrolling a subsequent screen.
1243 @param CurrentState TRUE to enable and FALSE to disable
1247 ShellSetPageBreakMode (
1248 IN BOOLEAN CurrentState
1252 // check for enabling
1254 if (CurrentState
!= 0x00) {
1256 // check for UEFI Shell 2.0
1258 if (mEfiShellProtocol
!= NULL
) {
1260 // Enable with UEFI 2.0 Shell
1262 mEfiShellProtocol
->EnablePageBreak();
1266 // ASSERT that must have EFI Shell
1268 ASSERT(mEfiShellEnvironment2
!= NULL
);
1270 // Enable with EFI Shell
1272 mEfiShellEnvironment2
->EnablePageBreak (DEFAULT_INIT_ROW
, DEFAULT_AUTO_LF
);
1277 // check for UEFI Shell 2.0
1279 if (mEfiShellProtocol
!= NULL
) {
1281 // Disable with UEFI 2.0 Shell
1283 mEfiShellProtocol
->DisablePageBreak();
1287 // ASSERT that must have EFI Shell
1289 ASSERT(mEfiShellEnvironment2
!= NULL
);
1291 // Disable with EFI Shell
1293 mEfiShellEnvironment2
->DisablePageBreak ();
1300 /// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.
1301 /// This allows for the struct to be populated.
1308 SHELL_FILE_HANDLE Handle
;
1309 EFI_FILE_INFO
*Info
;
1310 } EFI_SHELL_FILE_INFO_NO_CONST
;
1313 Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.
1315 if OldStyleFileList is NULL then ASSERT()
1317 this function will convert a SHELL_FILE_ARG based list into a callee allocated
1318 EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
1319 the ShellCloseFileMetaArg function.
1321 @param[in] FileList the EFI shell list type
1322 @param[in,out] ListHead the list to add to
1324 @retval the resultant head of the double linked new format list;
1328 InternalShellConvertFileListType (
1329 IN LIST_ENTRY
*FileList
,
1330 IN OUT LIST_ENTRY
*ListHead
1333 SHELL_FILE_ARG
*OldInfo
;
1335 EFI_SHELL_FILE_INFO_NO_CONST
*NewInfo
;
1340 ASSERT(FileList
!= NULL
);
1341 ASSERT(ListHead
!= NULL
);
1344 // enumerate through each member of the old list and copy
1346 for (Link
= FileList
->ForwardLink
; Link
!= FileList
; Link
= Link
->ForwardLink
) {
1347 OldInfo
= CR (Link
, SHELL_FILE_ARG
, Link
, SHELL_FILE_ARG_SIGNATURE
);
1348 ASSERT(OldInfo
!= NULL
);
1351 // Skip ones that failed to open...
1353 if (OldInfo
->Status
!= EFI_SUCCESS
) {
1358 // make sure the old list was valid
1360 ASSERT(OldInfo
->Info
!= NULL
);
1361 ASSERT(OldInfo
->FullName
!= NULL
);
1362 ASSERT(OldInfo
->FileName
!= NULL
);
1365 // allocate a new EFI_SHELL_FILE_INFO object
1367 NewInfo
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1368 ASSERT(NewInfo
!= NULL
);
1369 if (NewInfo
== NULL
) {
1374 // copy the simple items
1376 NewInfo
->Handle
= OldInfo
->Handle
;
1377 NewInfo
->Status
= OldInfo
->Status
;
1379 // old shell checks for 0 not NULL
1380 OldInfo
->Handle
= 0;
1383 // allocate new space to copy strings and structure
1385 NewInfo
->FullName
= AllocateZeroPool(StrSize(OldInfo
->FullName
));
1386 NewInfo
->FileName
= AllocateZeroPool(StrSize(OldInfo
->FileName
));
1387 NewInfo
->Info
= AllocateZeroPool((UINTN
)OldInfo
->Info
->Size
);
1390 // make sure all the memory allocations were sucessful
1392 ASSERT(NewInfo
->FullName
!= NULL
);
1393 ASSERT(NewInfo
->FileName
!= NULL
);
1394 ASSERT(NewInfo
->Info
!= NULL
);
1397 // Copt the strings and structure
1399 StrCpy(NewInfo
->FullName
, OldInfo
->FullName
);
1400 StrCpy(NewInfo
->FileName
, OldInfo
->FileName
);
1401 gBS
->CopyMem (NewInfo
->Info
, OldInfo
->Info
, (UINTN
)OldInfo
->Info
->Size
);
1404 // add that to the list
1406 InsertTailList(ListHead
, &NewInfo
->Link
);
1411 Opens a group of files based on a path.
1413 This function uses the Arg to open all the matching files. Each matched
1414 file has a SHELL_FILE_ARG structure to record the file information. These
1415 structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
1416 structures from ListHead to access each file. This function supports wildcards
1417 and will process '?' and '*' as such. the list must be freed with a call to
1418 ShellCloseFileMetaArg().
1420 If you are NOT appending to an existing list *ListHead must be NULL. If
1421 *ListHead is NULL then it must be callee freed.
1423 @param Arg pointer to path string
1424 @param OpenMode mode to open files with
1425 @param ListHead head of linked list of results
1427 @retval EFI_SUCCESS the operation was sucessful and the list head
1428 contains the list of opened files
1429 @return != EFI_SUCCESS the operation failed
1431 @sa InternalShellConvertFileListType
1435 ShellOpenFileMetaArg (
1438 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1442 LIST_ENTRY mOldStyleFileList
;
1445 // ASSERT that Arg and ListHead are not NULL
1447 ASSERT(Arg
!= NULL
);
1448 ASSERT(ListHead
!= NULL
);
1451 // Check for UEFI Shell 2.0 protocols
1453 if (mEfiShellProtocol
!= NULL
) {
1454 if (*ListHead
== NULL
) {
1455 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1456 if (*ListHead
== NULL
) {
1457 return (EFI_OUT_OF_RESOURCES
);
1459 InitializeListHead(&((*ListHead
)->Link
));
1461 Status
= mEfiShellProtocol
->OpenFileList(Arg
,
1464 if (EFI_ERROR(Status
)) {
1465 mEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1467 Status
= mEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1469 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1470 FreePool(*ListHead
);
1472 return (EFI_NOT_FOUND
);
1478 // ASSERT that we must have EFI shell
1480 ASSERT(mEfiShellEnvironment2
!= NULL
);
1483 // make sure the list head is initialized
1485 InitializeListHead(&mOldStyleFileList
);
1488 // Get the EFI Shell list of files
1490 Status
= mEfiShellEnvironment2
->FileMetaArg(Arg
, &mOldStyleFileList
);
1491 if (EFI_ERROR(Status
)) {
1496 if (*ListHead
== NULL
) {
1497 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1498 if (*ListHead
== NULL
) {
1499 return (EFI_OUT_OF_RESOURCES
);
1501 InitializeListHead(&((*ListHead
)->Link
));
1505 // Convert that to equivalent of UEFI Shell 2.0 structure
1507 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1510 // Free the EFI Shell version that was converted.
1512 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1514 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1515 FreePool(*ListHead
);
1517 Status
= EFI_NOT_FOUND
;
1523 Free the linked list returned from ShellOpenFileMetaArg.
1525 if ListHead is NULL then ASSERT().
1527 @param ListHead the pointer to free.
1529 @retval EFI_SUCCESS the operation was sucessful.
1533 ShellCloseFileMetaArg (
1534 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1540 // ASSERT that ListHead is not NULL
1542 ASSERT(ListHead
!= NULL
);
1545 // Check for UEFI Shell 2.0 protocols
1547 if (mEfiShellProtocol
!= NULL
) {
1548 return (mEfiShellProtocol
->FreeFileList(ListHead
));
1551 // Since this is EFI Shell version we need to free our internally made copy
1554 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1555 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1556 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1557 RemoveEntryList(Node
);
1558 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1559 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1560 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1561 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1562 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1569 Find a file by searching the CWD and then the path.
1571 If FileName is NULL then ASSERT.
1573 If the return value is not NULL then the memory must be caller freed.
1575 @param FileName Filename string.
1577 @retval NULL the file was not found
1578 @return !NULL the full path to the file.
1583 IN CONST CHAR16
*FileName
1587 SHELL_FILE_HANDLE Handle
;
1591 CONST CHAR16
*Walker
;
1598 // First make sure its not an absolute path.
1600 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1601 if (!EFI_ERROR(Status
)){
1602 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1603 ASSERT(RetVal
== NULL
);
1604 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1605 ShellCloseFile(&Handle
);
1608 ShellCloseFile(&Handle
);
1612 Path
= ShellGetEnvironmentVariable(L
"cwd");
1614 Size
= StrSize(Path
);
1615 Size
+= StrSize(FileName
);
1616 TestPath
= AllocateZeroPool(Size
);
1617 ASSERT(TestPath
!= NULL
);
1618 if (TestPath
== NULL
) {
1621 StrCpy(TestPath
, Path
);
1622 StrCat(TestPath
, FileName
);
1623 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1624 if (!EFI_ERROR(Status
)){
1625 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1626 ASSERT(RetVal
== NULL
);
1627 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1628 ShellCloseFile(&Handle
);
1632 ShellCloseFile(&Handle
);
1637 Path
= ShellGetEnvironmentVariable(L
"path");
1639 Size
= StrSize(Path
)+sizeof(CHAR16
);
1640 Size
+= StrSize(FileName
);
1641 TestPath
= AllocateZeroPool(Size
);
1642 if (TestPath
== NULL
) {
1645 Walker
= (CHAR16
*)Path
;
1647 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1648 if (TestPath
!= NULL
) {
1649 TempChar
= StrStr(TestPath
, L
";");
1650 if (TempChar
!= NULL
) {
1651 *TempChar
= CHAR_NULL
;
1653 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1654 StrCat(TestPath
, L
"\\");
1656 StrCat(TestPath
, FileName
);
1657 if (StrStr(Walker
, L
";") != NULL
) {
1658 Walker
= StrStr(Walker
, L
";") + 1;
1662 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1663 if (!EFI_ERROR(Status
)){
1664 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1665 ASSERT(RetVal
== NULL
);
1666 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1667 ShellCloseFile(&Handle
);
1670 ShellCloseFile(&Handle
);
1674 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1681 Find a file by searching the CWD and then the path with a variable set of file
1682 extensions. If the file is not found it will append each extension in the list
1683 in the order provided and return the first one that is successful.
1685 If FileName is NULL, then ASSERT.
1686 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1688 If the return value is not NULL then the memory must be caller freed.
1690 @param[in] FileName Filename string.
1691 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1693 @retval NULL The file was not found.
1694 @retval !NULL The path to the file.
1698 ShellFindFilePathEx (
1699 IN CONST CHAR16
*FileName
,
1700 IN CONST CHAR16
*FileExtension
1705 CONST CHAR16
*ExtensionWalker
;
1710 ASSERT(FileName
!= NULL
);
1711 if (FileExtension
== NULL
) {
1712 return (ShellFindFilePath(FileName
));
1714 RetVal
= ShellFindFilePath(FileName
);
1715 if (RetVal
!= NULL
) {
1718 Size
= StrSize(FileName
);
1719 Size
+= StrSize(FileExtension
);
1720 TestPath
= AllocateZeroPool(Size
);
1721 ASSERT(TestPath
!= NULL
);
1722 if (TestPath
== NULL
) {
1725 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1726 StrCpy(TestPath
, FileName
);
1727 if (ExtensionWalker
!= NULL
) {
1728 StrCat(TestPath
, ExtensionWalker
);
1730 TempChar
= StrStr(TestPath
, L
";");
1731 if (TempChar
!= NULL
) {
1732 *TempChar
= CHAR_NULL
;
1734 RetVal
= ShellFindFilePath(TestPath
);
1735 if (RetVal
!= NULL
) {
1738 ASSERT(ExtensionWalker
!= NULL
);
1739 TempChar2
= StrStr(ExtensionWalker
, L
";");
1748 SHELL_PARAM_TYPE Type
;
1750 UINTN OriginalPosition
;
1751 } SHELL_PARAM_PACKAGE
;
1754 Checks the list of valid arguments and returns TRUE if the item was found. If the
1755 return value is TRUE then the type parameter is set also.
1757 if CheckList is NULL then ASSERT();
1758 if Name is NULL then ASSERT();
1759 if Type is NULL then ASSERT();
1761 @param Name pointer to Name of parameter found
1762 @param CheckList List to check against
1763 @param Type pointer to type of parameter if it was found
1765 @retval TRUE the Parameter was found. Type is valid.
1766 @retval FALSE the Parameter was not found. Type is not valid.
1770 InternalIsOnCheckList (
1771 IN CONST CHAR16
*Name
,
1772 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1773 OUT SHELL_PARAM_TYPE
*Type
1776 SHELL_PARAM_ITEM
*TempListItem
;
1779 // ASSERT that all 3 pointer parameters aren't NULL
1781 ASSERT(CheckList
!= NULL
);
1782 ASSERT(Type
!= NULL
);
1783 ASSERT(Name
!= NULL
);
1786 // question mark and page break mode are always supported
1788 if ((StrCmp(Name
, L
"-?") == 0) ||
1789 (StrCmp(Name
, L
"-b") == 0)
1795 // Enumerate through the list
1797 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1799 // If the Type is TypeStart only check the first characters of the passed in param
1800 // If it matches set the type and return TRUE
1802 if (TempListItem
->Type
== TypeStart
&& StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1803 *Type
= TempListItem
->Type
;
1805 } else if (StrCmp(Name
, TempListItem
->Name
) == 0) {
1806 *Type
= TempListItem
->Type
;
1814 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1816 @param[in] Name pointer to Name of parameter found
1817 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1819 @retval TRUE the Parameter is a flag.
1820 @retval FALSE the Parameter not a flag.
1825 IN CONST CHAR16
*Name
,
1826 IN BOOLEAN AlwaysAllowNumbers
1830 // ASSERT that Name isn't NULL
1832 ASSERT(Name
!= NULL
);
1835 // If we accept numbers then dont return TRUE. (they will be values)
1837 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && ShellIsHexaDecimalDigitCharacter(Name
[1])) && AlwaysAllowNumbers
) {
1842 // If the Name has a /, +, or - as the first character return TRUE
1844 if ((Name
[0] == L
'/') ||
1845 (Name
[0] == L
'-') ||
1854 Checks the command line arguments passed against the list of valid ones.
1856 If no initialization is required, then return RETURN_SUCCESS.
1858 @param[in] CheckList pointer to list of parameters to check
1859 @param[out] CheckPackage pointer to pointer to list checked values
1860 @param[out] ProblemParam optional pointer to pointer to unicode string for
1861 the paramater that caused failure. If used then the
1862 caller is responsible for freeing the memory.
1863 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1864 @param[in] Argv pointer to array of parameters
1865 @param[in] Argc Count of parameters in Argv
1866 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1868 @retval EFI_SUCCESS The operation completed sucessfully.
1869 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1870 @retval EFI_INVALID_PARAMETER A parameter was invalid
1871 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1872 duplicated. the duplicated command line argument
1873 was returned in ProblemParam if provided.
1874 @retval EFI_NOT_FOUND a argument required a value that was missing.
1875 the invalid command line argument was returned in
1876 ProblemParam if provided.
1880 InternalCommandLineParse (
1881 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1882 OUT LIST_ENTRY
**CheckPackage
,
1883 OUT CHAR16
**ProblemParam OPTIONAL
,
1884 IN BOOLEAN AutoPageBreak
,
1885 IN CONST CHAR16
**Argv
,
1887 IN BOOLEAN AlwaysAllowNumbers
1891 SHELL_PARAM_TYPE CurrentItemType
;
1892 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
1897 CurrentItemPackage
= NULL
;
1903 // If there is only 1 item we dont need to do anything
1906 *CheckPackage
= NULL
;
1907 return (EFI_SUCCESS
);
1913 ASSERT(CheckList
!= NULL
);
1914 ASSERT(Argv
!= NULL
);
1917 // initialize the linked list
1919 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
1920 InitializeListHead(*CheckPackage
);
1923 // loop through each of the arguments
1925 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
1926 if (Argv
[LoopCounter
] == NULL
) {
1928 // do nothing for NULL argv
1930 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
1932 // We might have leftover if last parameter didnt have optional value
1934 if (GetItemValue
!= 0) {
1936 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1941 CurrentItemPackage
= AllocatePool(sizeof(SHELL_PARAM_PACKAGE
));
1942 ASSERT(CurrentItemPackage
!= NULL
);
1943 CurrentItemPackage
->Name
= AllocatePool(StrSize(Argv
[LoopCounter
]));
1944 ASSERT(CurrentItemPackage
->Name
!= NULL
);
1945 StrCpy(CurrentItemPackage
->Name
, Argv
[LoopCounter
]);
1946 CurrentItemPackage
->Type
= CurrentItemType
;
1947 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
1948 CurrentItemPackage
->Value
= NULL
;
1951 // Does this flag require a value
1953 switch (CurrentItemPackage
->Type
) {
1955 // possibly trigger the next loop(s) to populate the value of this item
1961 case TypeDoubleValue
:
1966 GetItemValue
= (UINTN
)(-1);
1971 // this item has no value expected; we are done
1973 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1974 ASSERT(GetItemValue
== 0);
1977 } else if (GetItemValue
!= 0 && !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
)) {
1978 ASSERT(CurrentItemPackage
!= NULL
);
1980 // get the item VALUE for a previous flag
1982 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
), CurrentItemPackage
->Value
);
1983 ASSERT(CurrentItemPackage
->Value
!= NULL
);
1984 if (ValueSize
== 0) {
1985 StrCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
1987 StrCat(CurrentItemPackage
->Value
, L
" ");
1988 StrCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
1990 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
1992 if (GetItemValue
== 0) {
1993 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
1995 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
) ){ //|| ProblemParam == NULL) {
1997 // add this one as a non-flag
1999 CurrentItemPackage
= AllocatePool(sizeof(SHELL_PARAM_PACKAGE
));
2000 ASSERT(CurrentItemPackage
!= NULL
);
2001 CurrentItemPackage
->Name
= NULL
;
2002 CurrentItemPackage
->Type
= TypePosition
;
2003 CurrentItemPackage
->Value
= AllocatePool(StrSize(Argv
[LoopCounter
]));
2004 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2005 StrCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
2006 CurrentItemPackage
->OriginalPosition
= Count
++;
2007 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2008 } else if (ProblemParam
!= NULL
) {
2010 // this was a non-recognised flag... error!
2012 *ProblemParam
= AllocatePool(StrSize(Argv
[LoopCounter
]));
2013 ASSERT(*ProblemParam
!= NULL
);
2014 StrCpy(*ProblemParam
, Argv
[LoopCounter
]);
2015 ShellCommandLineFreeVarList(*CheckPackage
);
2016 *CheckPackage
= NULL
;
2017 return (EFI_VOLUME_CORRUPTED
);
2022 if (GetItemValue
!= 0) {
2024 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2027 // support for AutoPageBreak
2029 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2030 ShellSetPageBreakMode(TRUE
);
2032 return (EFI_SUCCESS
);
2036 Checks the command line arguments passed against the list of valid ones.
2037 Optionally removes NULL values first.
2039 If no initialization is required, then return RETURN_SUCCESS.
2041 @param[in] CheckList The pointer to list of parameters to check.
2042 @param[out] CheckPackage The package of checked values.
2043 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2044 the paramater that caused failure.
2045 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2046 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2048 @retval EFI_SUCCESS The operation completed sucessfully.
2049 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2050 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2051 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2052 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2053 of the command line arguments was returned in
2054 ProblemParam if provided.
2055 @retval EFI_NOT_FOUND A argument required a value that was missing.
2056 The invalid command line argument was returned in
2057 ProblemParam if provided.
2061 ShellCommandLineParseEx (
2062 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2063 OUT LIST_ENTRY
**CheckPackage
,
2064 OUT CHAR16
**ProblemParam OPTIONAL
,
2065 IN BOOLEAN AutoPageBreak
,
2066 IN BOOLEAN AlwaysAllowNumbers
2070 // ASSERT that CheckList and CheckPackage aren't NULL
2072 ASSERT(CheckList
!= NULL
);
2073 ASSERT(CheckPackage
!= NULL
);
2076 // Check for UEFI Shell 2.0 protocols
2078 if (mEfiShellParametersProtocol
!= NULL
) {
2079 return (InternalCommandLineParse(CheckList
,
2083 (CONST CHAR16
**) mEfiShellParametersProtocol
->Argv
,
2084 mEfiShellParametersProtocol
->Argc
,
2085 AlwaysAllowNumbers
));
2089 // ASSERT That EFI Shell is not required
2091 ASSERT (mEfiShellInterface
!= NULL
);
2092 return (InternalCommandLineParse(CheckList
,
2096 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2097 mEfiShellInterface
->Argc
,
2098 AlwaysAllowNumbers
));
2102 Frees shell variable list that was returned from ShellCommandLineParse.
2104 This function will free all the memory that was used for the CheckPackage
2105 list of postprocessed shell arguments.
2107 this function has no return value.
2109 if CheckPackage is NULL, then return
2111 @param CheckPackage the list to de-allocate
2115 ShellCommandLineFreeVarList (
2116 IN LIST_ENTRY
*CheckPackage
2122 // check for CheckPackage == NULL
2124 if (CheckPackage
== NULL
) {
2129 // for each node in the list
2131 for ( Node
= GetFirstNode(CheckPackage
)
2132 ; !IsListEmpty(CheckPackage
)
2133 ; Node
= GetFirstNode(CheckPackage
)
2136 // Remove it from the list
2138 RemoveEntryList(Node
);
2141 // if it has a name free the name
2143 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2144 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2148 // if it has a value free the value
2150 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2151 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2155 // free the node structure
2157 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2160 // free the list head node
2162 FreePool(CheckPackage
);
2165 Checks for presence of a flag parameter
2167 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2169 if CheckPackage is NULL then return FALSE.
2170 if KeyString is NULL then ASSERT()
2172 @param CheckPackage The package of parsed command line arguments
2173 @param KeyString the Key of the command line argument to check for
2175 @retval TRUE the flag is on the command line
2176 @retval FALSE the flag is not on the command line
2180 ShellCommandLineGetFlag (
2181 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2182 IN CONST CHAR16
* CONST KeyString
2188 // ASSERT that both CheckPackage and KeyString aren't NULL
2190 ASSERT(KeyString
!= NULL
);
2193 // return FALSE for no package
2195 if (CheckPackage
== NULL
) {
2200 // enumerate through the list of parametrs
2202 for ( Node
= GetFirstNode(CheckPackage
)
2203 ; !IsNull (CheckPackage
, Node
)
2204 ; Node
= GetNextNode(CheckPackage
, Node
)
2207 // If the Name matches, return TRUE (and there may be NULL name)
2209 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2211 // If Type is TypeStart then only compare the begining of the strings
2213 if ( ((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
2214 && StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0
2217 } else if (StrCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2225 Returns value from command line argument.
2227 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2229 If CheckPackage is NULL, then return NULL.
2231 @param[in] CheckPackage The package of parsed command line arguments.
2232 @param[in] KeyString The Key of the command line argument to check for.
2234 @retval NULL The flag is not on the command line.
2235 @retval !=NULL The pointer to unicode string of the value.
2239 ShellCommandLineGetValue (
2240 IN CONST LIST_ENTRY
*CheckPackage
,
2241 IN CHAR16
*KeyString
2247 // check for CheckPackage == NULL
2249 if (CheckPackage
== NULL
) {
2254 // enumerate through the list of parametrs
2256 for ( Node
= GetFirstNode(CheckPackage
)
2257 ; !IsNull (CheckPackage
, Node
)
2258 ; Node
= GetNextNode(CheckPackage
, Node
)
2261 // If the Name matches, return the value (name can be NULL)
2263 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2265 // If Type is TypeStart then only compare the begining of the strings
2267 if ( ((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
2268 && StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0
2271 // return the string part after the flag
2273 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2274 } else if (StrCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2278 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2286 Returns raw value from command line argument.
2288 Raw value parameters are in the form of "value" in a specific position in the list.
2290 If CheckPackage is NULL, then return NULL.
2292 @param[in] CheckPackage The package of parsed command line arguments.
2293 @param[in] Position The position of the value.
2295 @retval NULL The flag is not on the command line.
2296 @retval !=NULL The pointer to unicode string of the value.
2300 ShellCommandLineGetRawValue (
2301 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2308 // check for CheckPackage == NULL
2310 if (CheckPackage
== NULL
) {
2315 // enumerate through the list of parametrs
2317 for ( Node
= GetFirstNode(CheckPackage
)
2318 ; !IsNull (CheckPackage
, Node
)
2319 ; Node
= GetNextNode(CheckPackage
, Node
)
2322 // If the position matches, return the value
2324 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2325 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2332 returns the number of command line value parameters that were parsed.
2334 this will not include flags.
2336 @param[in] CheckPackage The package of parsed command line arguments.
2338 @retval (UINTN)-1 No parsing has ocurred
2339 @return other The number of value parameters found
2343 ShellCommandLineGetCount(
2344 IN CONST LIST_ENTRY
*CheckPackage
2350 if (CheckPackage
== NULL
) {
2353 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2354 ; !IsNull (CheckPackage
, Node1
)
2355 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2357 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2365 Determins if a parameter is duplicated.
2367 If Param is not NULL then it will point to a callee allocated string buffer
2368 with the parameter value if a duplicate is found.
2370 If CheckPackage is NULL, then ASSERT.
2372 @param[in] CheckPackage The package of parsed command line arguments.
2373 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2375 @retval EFI_SUCCESS No parameters were duplicated.
2376 @retval EFI_DEVICE_ERROR A duplicate was found.
2380 ShellCommandLineCheckDuplicate (
2381 IN CONST LIST_ENTRY
*CheckPackage
,
2388 ASSERT(CheckPackage
!= NULL
);
2390 for ( Node1
= GetFirstNode(CheckPackage
)
2391 ; !IsNull (CheckPackage
, Node1
)
2392 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2394 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2395 ; !IsNull (CheckPackage
, Node2
)
2396 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2398 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) {
2399 if (Param
!= NULL
) {
2401 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2403 return (EFI_DEVICE_ERROR
);
2407 return (EFI_SUCCESS
);
2411 This is a find and replace function. Upon successful return the NewString is a copy of
2412 SourceString with each instance of FindTarget replaced with ReplaceWith.
2414 If SourceString and NewString overlap the behavior is undefined.
2416 If the string would grow bigger than NewSize it will halt and return error.
2418 @param[in] SourceString The string with source buffer.
2419 @param[in,out] NewString The string with resultant buffer.
2420 @param[in] NewSize The size in bytes of NewString.
2421 @param[in] FindTarget The string to look for.
2422 @param[in] ReplaceWith The string to replace FindTarget with.
2423 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2424 immediately before it.
2425 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2427 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2428 @retval EFI_INVALID_PARAMETER NewString was NULL.
2429 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2430 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2431 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2432 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2433 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2434 the new string (truncation occurred).
2435 @retval EFI_SUCCESS The string was successfully copied with replacement.
2439 ShellCopySearchAndReplace(
2440 IN CHAR16 CONST
*SourceString
,
2441 IN OUT CHAR16
*NewString
,
2443 IN CONST CHAR16
*FindTarget
,
2444 IN CONST CHAR16
*ReplaceWith
,
2445 IN CONST BOOLEAN SkipPreCarrot
,
2446 IN CONST BOOLEAN ParameterReplacing
2452 if ( (SourceString
== NULL
)
2453 || (NewString
== NULL
)
2454 || (FindTarget
== NULL
)
2455 || (ReplaceWith
== NULL
)
2456 || (StrLen(FindTarget
) < 1)
2457 || (StrLen(SourceString
) < 1)
2459 return (EFI_INVALID_PARAMETER
);
2462 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2463 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2465 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2466 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2468 if (Replace
== NULL
) {
2469 return (EFI_OUT_OF_RESOURCES
);
2471 NewString
= SetMem16(NewString
, NewSize
, CHAR_NULL
);
2472 while (*SourceString
!= CHAR_NULL
) {
2474 // if we find the FindTarget and either Skip == FALSE or Skip and we
2475 // dont have a carrot do a replace...
2477 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2478 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2480 SourceString
+= StrLen(FindTarget
);
2481 Size
= StrSize(NewString
);
2482 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2484 return (EFI_BUFFER_TOO_SMALL
);
2486 StrCat(NewString
, Replace
);
2488 Size
= StrSize(NewString
);
2489 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2491 return (EFI_BUFFER_TOO_SMALL
);
2493 StrnCat(NewString
, SourceString
, 1);
2498 return (EFI_SUCCESS
);
2502 Internal worker function to output a string.
2504 This function will output a string to the correct StdOut.
2506 @param[in] String The string to print out.
2508 @retval EFI_SUCCESS The operation was sucessful.
2509 @retval !EFI_SUCCESS The operation failed.
2514 IN CONST CHAR16
*String
2518 Size
= StrSize(String
) - sizeof(CHAR16
);
2520 return (EFI_SUCCESS
);
2522 if (mEfiShellParametersProtocol
!= NULL
) {
2523 return (mEfiShellProtocol
->WriteFile(mEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2525 if (mEfiShellInterface
!= NULL
) {
2527 // Divide in half for old shell. Must be string length not size.
2530 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2533 return (EFI_UNSUPPORTED
);
2537 Print at a specific location on the screen.
2539 This function will move the cursor to a given screen location and print the specified string
2541 If -1 is specified for either the Row or Col the current screen location for BOTH
2544 if either Row or Col is out of range for the current console, then ASSERT
2545 if Format is NULL, then ASSERT
2547 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2548 the following additional flags:
2549 %N - Set output attribute to normal
2550 %H - Set output attribute to highlight
2551 %E - Set output attribute to error
2552 %B - Set output attribute to blue color
2553 %V - Set output attribute to green color
2555 Note: The background color is controlled by the shell command cls.
2557 @param[in] Row the row to print at
2558 @param[in] Col the column to print at
2559 @param[in] Format the format string
2560 @param[in] Marker the marker for the variable argument list
2562 @return EFI_SUCCESS The operation was successful.
2563 @return EFI_DEVICE_ERROR The console device reported an error.
2567 InternalShellPrintWorker(
2568 IN INT32 Col OPTIONAL
,
2569 IN INT32 Row OPTIONAL
,
2570 IN CONST CHAR16
*Format
,
2575 CHAR16
*ResumeLocation
;
2576 CHAR16
*FormatWalker
;
2577 UINTN OriginalAttribute
;
2579 Status
= EFI_SUCCESS
;
2580 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2583 // Back and forth each time fixing up 1 of our flags...
2585 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2586 ASSERT_EFI_ERROR(Status
);
2587 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2588 ASSERT_EFI_ERROR(Status
);
2589 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2590 ASSERT_EFI_ERROR(Status
);
2591 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2592 ASSERT_EFI_ERROR(Status
);
2593 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2594 ASSERT_EFI_ERROR(Status
);
2597 // Use the last buffer from replacing to print from...
2599 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2601 if (Col
!= -1 && Row
!= -1) {
2602 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2603 ASSERT_EFI_ERROR(Status
);
2606 FormatWalker
= mPostReplaceFormat2
;
2607 while (*FormatWalker
!= CHAR_NULL
) {
2609 // Find the next attribute change request
2611 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2612 if (ResumeLocation
!= NULL
) {
2613 *ResumeLocation
= CHAR_NULL
;
2616 // print the current FormatWalker string
2618 if (StrLen(FormatWalker
)>0) {
2619 Status
= InternalPrintTo(FormatWalker
);
2620 if (EFI_ERROR(Status
)) {
2626 // update the attribute
2628 if (ResumeLocation
!= NULL
) {
2629 switch (*(ResumeLocation
+1)) {
2631 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2634 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2637 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2640 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2643 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2647 // Print a simple '%' symbol
2649 Status
= InternalPrintTo(L
"%");
2650 if (EFI_ERROR(Status
)) {
2653 ResumeLocation
= ResumeLocation
- 1;
2658 // reset to normal now...
2664 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2666 FormatWalker
= ResumeLocation
+ 2;
2669 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2674 Print at a specific location on the screen.
2676 This function will move the cursor to a given screen location and print the specified string.
2678 If -1 is specified for either the Row or Col the current screen location for BOTH
2681 If either Row or Col is out of range for the current console, then ASSERT.
2682 If Format is NULL, then ASSERT.
2684 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2685 the following additional flags:
2686 %N - Set output attribute to normal
2687 %H - Set output attribute to highlight
2688 %E - Set output attribute to error
2689 %B - Set output attribute to blue color
2690 %V - Set output attribute to green color
2692 Note: The background color is controlled by the shell command cls.
2694 @param[in] Col the column to print at
2695 @param[in] Row the row to print at
2696 @param[in] Format the format string
2697 @param[in] ... The variable argument list.
2699 @return EFI_SUCCESS The printing was successful.
2700 @return EFI_DEVICE_ERROR The console device reported an error.
2705 IN INT32 Col OPTIONAL
,
2706 IN INT32 Row OPTIONAL
,
2707 IN CONST CHAR16
*Format
,
2713 if (Format
== NULL
) {
2714 return (EFI_INVALID_PARAMETER
);
2716 VA_START (Marker
, Format
);
2717 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2723 Print at a specific location on the screen.
2725 This function will move the cursor to a given screen location and print the specified string.
2727 If -1 is specified for either the Row or Col the current screen location for BOTH
2730 If either Row or Col is out of range for the current console, then ASSERT.
2731 If Format is NULL, then ASSERT.
2733 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2734 the following additional flags:
2735 %N - Set output attribute to normal.
2736 %H - Set output attribute to highlight.
2737 %E - Set output attribute to error.
2738 %B - Set output attribute to blue color.
2739 %V - Set output attribute to green color.
2741 Note: The background color is controlled by the shell command cls.
2743 @param[in] Col The column to print at.
2744 @param[in] Row The row to print at.
2745 @param[in] Language The language of the string to retrieve. If this parameter
2746 is NULL, then the current platform language is used.
2747 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2748 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2749 @param[in] ... The variable argument list.
2751 @return EFI_SUCCESS The printing was successful.
2752 @return EFI_DEVICE_ERROR The console device reported an error.
2757 IN INT32 Col OPTIONAL
,
2758 IN INT32 Row OPTIONAL
,
2759 IN CONST CHAR8
*Language OPTIONAL
,
2760 IN CONST EFI_STRING_ID HiiFormatStringId
,
2761 IN CONST EFI_HANDLE HiiFormatHandle
,
2766 CHAR16
*HiiFormatString
;
2769 VA_START (Marker
, HiiFormatHandle
);
2770 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2771 ASSERT(HiiFormatString
!= NULL
);
2773 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2775 SHELL_FREE_NON_NULL(HiiFormatString
);
2782 Function to determine if a given filename represents a file or a directory.
2784 @param[in] DirName Path to directory to test.
2786 @retval EFI_SUCCESS The Path represents a directory
2787 @retval EFI_NOT_FOUND The Path does not represent a directory
2788 @return other The path failed to open
2793 IN CONST CHAR16
*DirName
2797 SHELL_FILE_HANDLE Handle
;
2798 CHAR16
*TempLocation
;
2799 CHAR16
*TempLocation2
;
2801 ASSERT(DirName
!= NULL
);
2804 TempLocation
= NULL
;
2806 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
2807 if (EFI_ERROR(Status
)) {
2809 // try good logic first.
2811 if (mEfiShellProtocol
!= NULL
) {
2812 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
2813 TempLocation2
= StrStr(TempLocation
, L
":");
2814 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
2815 *(TempLocation2
+1) = CHAR_NULL
;
2817 if (mEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
2818 FreePool(TempLocation
);
2819 return (EFI_SUCCESS
);
2821 FreePool(TempLocation
);
2824 // probably a map name?!?!!?
2826 TempLocation
= StrStr(DirName
, L
"\\");
2827 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
2828 return (EFI_SUCCESS
);
2834 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
2835 ShellCloseFile(&Handle
);
2836 return (EFI_SUCCESS
);
2838 ShellCloseFile(&Handle
);
2839 return (EFI_NOT_FOUND
);
2843 Function to determine if a given filename represents a file.
2845 @param[in] Name Path to file to test.
2847 @retval EFI_SUCCESS The Path represents a file.
2848 @retval EFI_NOT_FOUND The Path does not represent a file.
2849 @retval other The path failed to open.
2854 IN CONST CHAR16
*Name
2858 SHELL_FILE_HANDLE Handle
;
2860 ASSERT(Name
!= NULL
);
2864 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
2865 if (EFI_ERROR(Status
)) {
2869 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
2870 ShellCloseFile(&Handle
);
2871 return (EFI_SUCCESS
);
2873 ShellCloseFile(&Handle
);
2874 return (EFI_NOT_FOUND
);
2878 Function to determine if a given filename represents a file.
2880 This will search the CWD and then the Path.
2882 If Name is NULL, then ASSERT.
2884 @param[in] Name Path to file to test.
2886 @retval EFI_SUCCESS The Path represents a file.
2887 @retval EFI_NOT_FOUND The Path does not represent a file.
2888 @retval other The path failed to open.
2893 IN CONST CHAR16
*Name
2899 if (!EFI_ERROR(ShellIsFile(Name
))) {
2900 return (EFI_SUCCESS
);
2903 NewName
= ShellFindFilePath(Name
);
2904 if (NewName
== NULL
) {
2905 return (EFI_NOT_FOUND
);
2907 Status
= ShellIsFile(NewName
);
2912 Function to determine whether a string is decimal or hex representation of a number
2913 and return the number converted from the string.
2915 @param[in] String String representation of a number
2917 @retval all the number
2922 IN CONST CHAR16
*String
2925 CONST CHAR16
*Walker
;
2926 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
2927 if (Walker
== NULL
|| *Walker
== CHAR_NULL
) {
2929 return ((UINTN
)(-1));
2931 if (StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
2932 return (StrHexToUintn(Walker
));
2934 return (StrDecimalToUintn(Walker
));
2939 Safely append with automatic string resizing given length of Destination and
2940 desired length of copy from Source.
2942 append the first D characters of Source to the end of Destination, where D is
2943 the lesser of Count and the StrLen() of Source. If appending those D characters
2944 will fit within Destination (whose Size is given as CurrentSize) and
2945 still leave room for a NULL terminator, then those characters are appended,
2946 starting at the original terminating NULL of Destination, and a new terminating
2949 If appending D characters onto Destination will result in a overflow of the size
2950 given in CurrentSize the string will be grown such that the copy can be performed
2951 and CurrentSize will be updated to the new size.
2953 If Source is NULL, there is nothing to append, just return the current buffer in
2956 if Destination is NULL, then ASSERT()
2957 if Destination's current length (including NULL terminator) is already more then
2958 CurrentSize, then ASSERT()
2960 @param[in,out] Destination The String to append onto
2961 @param[in,out] CurrentSize on call the number of bytes in Destination. On
2962 return possibly the new size (still in bytes). if NULL
2963 then allocate whatever is needed.
2964 @param[in] Source The String to append from
2965 @param[in] Count Maximum number of characters to append. if 0 then
2968 @return Destination return the resultant string.
2973 IN OUT CHAR16
**Destination
,
2974 IN OUT UINTN
*CurrentSize
,
2975 IN CONST CHAR16
*Source
,
2979 UINTN DestinationStartSize
;
2985 ASSERT(Destination
!= NULL
);
2988 // If there's nothing to do then just return Destination
2990 if (Source
== NULL
) {
2991 return (*Destination
);
2995 // allow for un-initialized pointers, based on size being 0
2997 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
2998 *Destination
= NULL
;
3002 // allow for NULL pointers address as Destination
3004 if (*Destination
!= NULL
) {
3005 ASSERT(CurrentSize
!= 0);
3006 DestinationStartSize
= StrSize(*Destination
);
3007 ASSERT(DestinationStartSize
<= *CurrentSize
);
3009 DestinationStartSize
= 0;
3010 // ASSERT(*CurrentSize == 0);
3014 // Append all of Source?
3017 Count
= StrLen(Source
);
3021 // Test and grow if required
3023 if (CurrentSize
!= NULL
) {
3024 NewSize
= *CurrentSize
;
3025 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3026 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3028 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3029 ASSERT(*Destination
!= NULL
);
3030 *CurrentSize
= NewSize
;
3032 *Destination
= AllocateZeroPool((Count
+1)*sizeof(CHAR16
));
3033 ASSERT(*Destination
!= NULL
);
3037 // Now use standard StrnCat on a big enough buffer
3039 if (*Destination
== NULL
) {
3042 return StrnCat(*Destination
, Source
, Count
);
3046 Prompt the user and return the resultant answer to the requestor.
3048 This function will display the requested question on the shell prompt and then
3049 wait for an apropriate answer to be input from the console.
3051 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3052 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3054 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3057 In either case *Response must be callee freed if Response was not NULL;
3059 @param Type What type of question is asked. This is used to filter the input
3060 to prevent invalid answers to question.
3061 @param Prompt Pointer to string prompt to use to request input.
3062 @param Response Pointer to Response which will be populated upon return.
3064 @retval EFI_SUCCESS The operation was sucessful.
3065 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3066 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3067 @return other The operation failed.
3071 ShellPromptForResponse (
3072 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3073 IN CHAR16
*Prompt OPTIONAL
,
3074 IN OUT VOID
**Response OPTIONAL
3080 SHELL_PROMPT_RESPONSE
*Resp
;
3084 Status
= EFI_UNSUPPORTED
;
3088 if (Type
!= ShellPromptResponseTypeFreeform
) {
3089 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocatePool(sizeof(SHELL_PROMPT_RESPONSE
));
3091 return (EFI_OUT_OF_RESOURCES
);
3096 case ShellPromptResponseTypeQuitContinue
:
3097 if (Prompt
!= NULL
) {
3098 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3101 // wait for valid response
3103 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3104 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3105 ASSERT_EFI_ERROR(Status
);
3106 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3107 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3108 *Resp
= ShellPromptResponseQuit
;
3110 *Resp
= ShellPromptResponseContinue
;
3113 case ShellPromptResponseTypeYesNoCancel
:
3114 if (Prompt
!= NULL
) {
3115 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3118 // wait for valid response
3120 *Resp
= ShellPromptResponseMax
;
3121 while (*Resp
== ShellPromptResponseMax
) {
3122 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3123 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3124 ASSERT_EFI_ERROR(Status
);
3125 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3126 switch (Key
.UnicodeChar
) {
3129 *Resp
= ShellPromptResponseYes
;
3133 *Resp
= ShellPromptResponseNo
;
3137 *Resp
= ShellPromptResponseCancel
;
3141 break; case ShellPromptResponseTypeYesNoAllCancel
:
3142 if (Prompt
!= NULL
) {
3143 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3146 // wait for valid response
3148 *Resp
= ShellPromptResponseMax
;
3149 while (*Resp
== ShellPromptResponseMax
) {
3150 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3151 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3152 ASSERT_EFI_ERROR(Status
);
3153 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3154 switch (Key
.UnicodeChar
) {
3157 *Resp
= ShellPromptResponseYes
;
3161 *Resp
= ShellPromptResponseNo
;
3165 *Resp
= ShellPromptResponseAll
;
3169 *Resp
= ShellPromptResponseCancel
;
3174 case ShellPromptResponseTypeEnterContinue
:
3175 case ShellPromptResponseTypeAnyKeyContinue
:
3176 if (Prompt
!= NULL
) {
3177 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3180 // wait for valid response
3182 *Resp
= ShellPromptResponseMax
;
3183 while (*Resp
== ShellPromptResponseMax
) {
3184 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3185 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3186 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3187 ASSERT_EFI_ERROR(Status
);
3188 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3189 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3190 *Resp
= ShellPromptResponseContinue
;
3194 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3195 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3196 ASSERT_EFI_ERROR(Status
);
3197 *Resp
= ShellPromptResponseContinue
;
3202 case ShellPromptResponseTypeYesNo
:
3203 if (Prompt
!= NULL
) {
3204 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3207 // wait for valid response
3209 *Resp
= ShellPromptResponseMax
;
3210 while (*Resp
== ShellPromptResponseMax
) {
3211 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3212 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3213 ASSERT_EFI_ERROR(Status
);
3214 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3215 switch (Key
.UnicodeChar
) {
3218 *Resp
= ShellPromptResponseYes
;
3222 *Resp
= ShellPromptResponseNo
;
3227 case ShellPromptResponseTypeFreeform
:
3228 if (Prompt
!= NULL
) {
3229 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3232 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3233 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3234 ASSERT_EFI_ERROR(Status
);
3235 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3236 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3239 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3240 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3244 // This is the location to add new prompt types.
3250 if (Response
!= NULL
) {
3253 } else if (Buffer
!= NULL
) {
3260 if (Buffer
!= NULL
) {
3265 ShellPrintEx(-1, -1, L
"\r\n");
3270 Prompt the user and return the resultant answer to the requestor.
3272 This function is the same as ShellPromptForResponse, except that the prompt is
3273 automatically pulled from HII.
3275 @param Type What type of question is asked. This is used to filter the input
3276 to prevent invalid answers to question.
3277 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3278 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3279 @param Response Pointer to Response which will be populated upon return.
3281 @retval EFI_SUCCESS the operation was sucessful.
3282 @return other the operation failed.
3284 @sa ShellPromptForResponse
3288 ShellPromptForResponseHii (
3289 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3290 IN CONST EFI_STRING_ID HiiFormatStringId
,
3291 IN CONST EFI_HANDLE HiiFormatHandle
,
3292 IN OUT VOID
**Response
3298 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3299 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3305 Function to determin if an entire string is a valid number.
3307 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3309 @param[in] String The string to evaluate.
3310 @param[in] ForceHex TRUE - always assume hex.
3311 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3313 @retval TRUE It is all numeric (dec/hex) characters.
3314 @retval FALSE There is a non-numeric character.
3318 ShellIsHexOrDecimalNumber (
3319 IN CONST CHAR16
*String
,
3320 IN CONST BOOLEAN ForceHex
,
3321 IN CONST BOOLEAN StopAtSpace
3327 // chop off a single negative sign
3329 if (String
!= NULL
&& *String
== L
'-') {
3333 if (String
== NULL
) {
3338 // chop leading zeroes
3340 while(String
!= NULL
&& *String
== L
'0'){
3344 // allow '0x' or '0X', but not 'x' or 'X'
3346 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3347 if (*(String
-1) != L
'0') {
3349 // we got an x without a preceeding 0
3355 } else if (ForceHex
) {
3362 // loop through the remaining characters and use the lib function
3364 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3366 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3370 if (!ShellIsDecimalDigitCharacter(*String
)) {
3379 Function to determine if a given filename exists.
3381 @param[in] Name Path to test.
3383 @retval EFI_SUCCESS The Path represents a file.
3384 @retval EFI_NOT_FOUND The Path does not represent a file.
3385 @retval other The path failed to open.
3390 IN CONST CHAR16
*Name
3394 EFI_SHELL_FILE_INFO
*List
;
3396 ASSERT(Name
!= NULL
);
3399 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3400 if (EFI_ERROR(Status
)) {
3404 ShellCloseFileMetaArg(&List
);
3406 return (EFI_SUCCESS
);