2 Provides interface to shell functionality for shell commands and applications.
4 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "UefiShellLib.h"
16 #include <ShellBase.h>
17 #include <Library/SortLib.h>
19 #define FIND_XXXXX_FILE_BUFFER_SIZE (SIZE_OF_EFI_FILE_INFO + MAX_FILE_NAME_LEN)
24 SHELL_PARAM_ITEM EmptyParamList
[] = {
27 SHELL_PARAM_ITEM SfoParamList
[] = {
31 EFI_SHELL_ENVIRONMENT2
*mEfiShellEnvironment2
;
32 EFI_SHELL_INTERFACE
*mEfiShellInterface
;
33 EFI_SHELL_PROTOCOL
*gEfiShellProtocol
;
34 EFI_SHELL_PARAMETERS_PROTOCOL
*gEfiShellParametersProtocol
;
35 EFI_HANDLE mEfiShellEnvironment2Handle
;
36 FILE_HANDLE_FUNCTION_MAP FileFunctionMap
;
39 Check if a Unicode character is a hexadecimal character.
41 This internal function checks if a Unicode character is a
42 numeric character. The valid hexadecimal characters are
43 L'0' to L'9', L'a' to L'f', or L'A' to L'F'.
45 @param Char The character to check against.
47 @retval TRUE If the Char is a hexadecmial character.
48 @retval FALSE If the Char is not a hexadecmial character.
53 ShellIsHexaDecimalDigitCharacter (
57 return (BOOLEAN
) ((Char
>= L
'0' && Char
<= L
'9') || (Char
>= L
'A' && Char
<= L
'F') || (Char
>= L
'a' && Char
<= L
'f'));
61 Check if a Unicode character is a decimal character.
63 This internal function checks if a Unicode character is a
64 decimal character. The valid characters are
68 @param Char The character to check against.
70 @retval TRUE If the Char is a hexadecmial character.
71 @retval FALSE If the Char is not a hexadecmial character.
76 ShellIsDecimalDigitCharacter (
80 return (BOOLEAN
) (Char
>= L
'0' && Char
<= L
'9');
84 Helper function to find ShellEnvironment2 for constructor.
86 @param[in] ImageHandle A copy of the calling image's handle.
88 @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
93 IN EFI_HANDLE ImageHandle
103 Status
= gBS
->OpenProtocol(ImageHandle
,
104 &gEfiShellEnvironment2Guid
,
105 (VOID
**)&mEfiShellEnvironment2
,
108 EFI_OPEN_PROTOCOL_GET_PROTOCOL
111 // look for the mEfiShellEnvironment2 protocol at a higher level
113 if (EFI_ERROR (Status
) || !(CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
))){
115 // figure out how big of a buffer we need.
117 Status
= gBS
->LocateHandle (ByProtocol
,
118 &gEfiShellEnvironment2Guid
,
119 NULL
, // ignored for ByProtocol
124 // maybe it's not there???
126 if (Status
== EFI_BUFFER_TOO_SMALL
) {
127 Buffer
= (EFI_HANDLE
*)AllocateZeroPool(BufferSize
);
128 if (Buffer
== NULL
) {
129 return (EFI_OUT_OF_RESOURCES
);
131 Status
= gBS
->LocateHandle (ByProtocol
,
132 &gEfiShellEnvironment2Guid
,
133 NULL
, // ignored for ByProtocol
138 if (!EFI_ERROR (Status
) && Buffer
!= NULL
) {
140 // now parse the list of returned handles
142 Status
= EFI_NOT_FOUND
;
143 for (HandleIndex
= 0; HandleIndex
< (BufferSize
/sizeof(Buffer
[0])); HandleIndex
++) {
144 Status
= gBS
->OpenProtocol(Buffer
[HandleIndex
],
145 &gEfiShellEnvironment2Guid
,
146 (VOID
**)&mEfiShellEnvironment2
,
149 EFI_OPEN_PROTOCOL_GET_PROTOCOL
151 if (CompareGuid (&mEfiShellEnvironment2
->SESGuid
, &gEfiShellEnvironment2ExtGuid
)) {
152 mEfiShellEnvironment2Handle
= Buffer
[HandleIndex
];
153 Status
= EFI_SUCCESS
;
159 if (Buffer
!= NULL
) {
166 Function to do most of the work of the constructor. Allows for calling
167 multiple times without complete re-initialization.
169 @param[in] ImageHandle A copy of the ImageHandle.
170 @param[in] SystemTable A pointer to the SystemTable for the application.
172 @retval EFI_SUCCESS The operationw as successful.
176 ShellLibConstructorWorker (
177 IN EFI_HANDLE ImageHandle
,
178 IN EFI_SYSTEM_TABLE
*SystemTable
184 // UEFI 2.0 shell interfaces (used preferentially)
186 Status
= gBS
->OpenProtocol(
188 &gEfiShellProtocolGuid
,
189 (VOID
**)&gEfiShellProtocol
,
192 EFI_OPEN_PROTOCOL_GET_PROTOCOL
194 if (EFI_ERROR(Status
)) {
196 // Search for the shell protocol
198 Status
= gBS
->LocateProtocol(
199 &gEfiShellProtocolGuid
,
201 (VOID
**)&gEfiShellProtocol
203 if (EFI_ERROR(Status
)) {
204 gEfiShellProtocol
= NULL
;
207 Status
= gBS
->OpenProtocol(
209 &gEfiShellParametersProtocolGuid
,
210 (VOID
**)&gEfiShellParametersProtocol
,
213 EFI_OPEN_PROTOCOL_GET_PROTOCOL
215 if (EFI_ERROR(Status
)) {
216 gEfiShellParametersProtocol
= NULL
;
219 if (gEfiShellParametersProtocol
== NULL
|| gEfiShellProtocol
== NULL
) {
221 // Moved to seperate function due to complexity
223 Status
= ShellFindSE2(ImageHandle
);
225 if (EFI_ERROR(Status
)) {
226 DEBUG((DEBUG_ERROR
, "Status: 0x%08x\r\n", Status
));
227 mEfiShellEnvironment2
= NULL
;
229 Status
= gBS
->OpenProtocol(ImageHandle
,
230 &gEfiShellInterfaceGuid
,
231 (VOID
**)&mEfiShellInterface
,
234 EFI_OPEN_PROTOCOL_GET_PROTOCOL
236 if (EFI_ERROR(Status
)) {
237 mEfiShellInterface
= NULL
;
242 // only success getting 2 of either the old or new, but no 1/2 and 1/2
244 if ((mEfiShellEnvironment2
!= NULL
&& mEfiShellInterface
!= NULL
) ||
245 (gEfiShellProtocol
!= NULL
&& gEfiShellParametersProtocol
!= NULL
) ) {
246 if (gEfiShellProtocol
!= NULL
) {
247 FileFunctionMap
.GetFileInfo
= gEfiShellProtocol
->GetFileInfo
;
248 FileFunctionMap
.SetFileInfo
= gEfiShellProtocol
->SetFileInfo
;
249 FileFunctionMap
.ReadFile
= gEfiShellProtocol
->ReadFile
;
250 FileFunctionMap
.WriteFile
= gEfiShellProtocol
->WriteFile
;
251 FileFunctionMap
.CloseFile
= gEfiShellProtocol
->CloseFile
;
252 FileFunctionMap
.DeleteFile
= gEfiShellProtocol
->DeleteFile
;
253 FileFunctionMap
.GetFilePosition
= gEfiShellProtocol
->GetFilePosition
;
254 FileFunctionMap
.SetFilePosition
= gEfiShellProtocol
->SetFilePosition
;
255 FileFunctionMap
.FlushFile
= gEfiShellProtocol
->FlushFile
;
256 FileFunctionMap
.GetFileSize
= gEfiShellProtocol
->GetFileSize
;
258 FileFunctionMap
.GetFileInfo
= (EFI_SHELL_GET_FILE_INFO
)FileHandleGetInfo
;
259 FileFunctionMap
.SetFileInfo
= (EFI_SHELL_SET_FILE_INFO
)FileHandleSetInfo
;
260 FileFunctionMap
.ReadFile
= (EFI_SHELL_READ_FILE
)FileHandleRead
;
261 FileFunctionMap
.WriteFile
= (EFI_SHELL_WRITE_FILE
)FileHandleWrite
;
262 FileFunctionMap
.CloseFile
= (EFI_SHELL_CLOSE_FILE
)FileHandleClose
;
263 FileFunctionMap
.DeleteFile
= (EFI_SHELL_DELETE_FILE
)FileHandleDelete
;
264 FileFunctionMap
.GetFilePosition
= (EFI_SHELL_GET_FILE_POSITION
)FileHandleGetPosition
;
265 FileFunctionMap
.SetFilePosition
= (EFI_SHELL_SET_FILE_POSITION
)FileHandleSetPosition
;
266 FileFunctionMap
.FlushFile
= (EFI_SHELL_FLUSH_FILE
)FileHandleFlush
;
267 FileFunctionMap
.GetFileSize
= (EFI_SHELL_GET_FILE_SIZE
)FileHandleGetSize
;
269 return (EFI_SUCCESS
);
271 return (EFI_NOT_FOUND
);
274 Constructor for the Shell library.
276 Initialize the library and determine if the underlying is a UEFI Shell 2.0 or an EFI shell.
278 @param ImageHandle the image handle of the process
279 @param SystemTable the EFI System Table pointer
281 @retval EFI_SUCCESS the initialization was complete sucessfully
282 @return others an error ocurred during initialization
286 ShellLibConstructor (
287 IN EFI_HANDLE ImageHandle
,
288 IN EFI_SYSTEM_TABLE
*SystemTable
291 mEfiShellEnvironment2
= NULL
;
292 gEfiShellProtocol
= NULL
;
293 gEfiShellParametersProtocol
= NULL
;
294 mEfiShellInterface
= NULL
;
295 mEfiShellEnvironment2Handle
= NULL
;
298 // verify that auto initialize is not set false
300 if (PcdGetBool(PcdShellLibAutoInitialize
) == 0) {
301 return (EFI_SUCCESS
);
304 return (ShellLibConstructorWorker(ImageHandle
, SystemTable
));
308 Destructor for the library. free any resources.
310 @param[in] ImageHandle A copy of the ImageHandle.
311 @param[in] SystemTable A pointer to the SystemTable for the application.
313 @retval EFI_SUCCESS The operation was successful.
314 @return An error from the CloseProtocol function.
319 IN EFI_HANDLE ImageHandle
,
320 IN EFI_SYSTEM_TABLE
*SystemTable
323 if (mEfiShellEnvironment2
!= NULL
) {
324 gBS
->CloseProtocol(mEfiShellEnvironment2Handle
==NULL
?ImageHandle
:mEfiShellEnvironment2Handle
,
325 &gEfiShellEnvironment2Guid
,
328 mEfiShellEnvironment2
= NULL
;
330 if (mEfiShellInterface
!= NULL
) {
331 gBS
->CloseProtocol(ImageHandle
,
332 &gEfiShellInterfaceGuid
,
335 mEfiShellInterface
= NULL
;
337 if (gEfiShellProtocol
!= NULL
) {
338 gBS
->CloseProtocol(ImageHandle
,
339 &gEfiShellProtocolGuid
,
342 gEfiShellProtocol
= NULL
;
344 if (gEfiShellParametersProtocol
!= NULL
) {
345 gBS
->CloseProtocol(ImageHandle
,
346 &gEfiShellParametersProtocolGuid
,
349 gEfiShellParametersProtocol
= NULL
;
351 mEfiShellEnvironment2Handle
= NULL
;
353 return (EFI_SUCCESS
);
357 This function causes the shell library to initialize itself. If the shell library
358 is already initialized it will de-initialize all the current protocol poitners and
359 re-populate them again.
361 When the library is used with PcdShellLibAutoInitialize set to true this function
362 will return EFI_SUCCESS and perform no actions.
364 This function is intended for internal access for shell commands only.
366 @retval EFI_SUCCESS the initialization was complete sucessfully
375 // if auto initialize is not false then skip
377 if (PcdGetBool(PcdShellLibAutoInitialize
) != 0) {
378 return (EFI_SUCCESS
);
382 // deinit the current stuff
384 ASSERT_EFI_ERROR(ShellLibDestructor(gImageHandle
, gST
));
387 // init the new stuff
389 return (ShellLibConstructorWorker(gImageHandle
, gST
));
393 This function will retrieve the information about the file for the handle
394 specified and store it in allocated pool memory.
396 This function allocates a buffer to store the file's information. It is the
397 caller's responsibility to free the buffer
399 @param FileHandle The file handle of the file for which information is
402 @retval NULL information could not be retrieved.
404 @return the information about the file
409 IN SHELL_FILE_HANDLE FileHandle
412 return (FileFunctionMap
.GetFileInfo(FileHandle
));
416 This function sets the information about the file for the opened handle
419 @param[in] FileHandle The file handle of the file for which information
422 @param[in] FileInfo The information to set.
424 @retval EFI_SUCCESS The information was set.
425 @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.
426 @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.
427 @retval EFI_NO_MEDIA The device has no medium.
428 @retval EFI_DEVICE_ERROR The device reported an error.
429 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
430 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
431 @retval EFI_ACCESS_DENIED The file was opened read only.
432 @retval EFI_VOLUME_FULL The volume is full.
437 IN SHELL_FILE_HANDLE FileHandle
,
438 IN EFI_FILE_INFO
*FileInfo
441 return (FileFunctionMap
.SetFileInfo(FileHandle
, FileInfo
));
445 This function will open a file or directory referenced by DevicePath.
447 This function opens a file with the open mode according to the file path. The
448 Attributes is valid only for EFI_FILE_MODE_CREATE.
450 @param FilePath on input the device path to the file. On output
451 the remaining device path.
452 @param DeviceHandle pointer to the system device handle.
453 @param FileHandle pointer to the file handle.
454 @param OpenMode the mode to open the file with.
455 @param Attributes the file's file attributes.
457 @retval EFI_SUCCESS The information was set.
458 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
459 @retval EFI_UNSUPPORTED Could not open the file path.
460 @retval EFI_NOT_FOUND The specified file could not be found on the
461 device or the file system could not be found on
463 @retval EFI_NO_MEDIA The device has no medium.
464 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
465 medium is no longer supported.
466 @retval EFI_DEVICE_ERROR The device reported an error.
467 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
468 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
469 @retval EFI_ACCESS_DENIED The file was opened read only.
470 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
472 @retval EFI_VOLUME_FULL The volume is full.
476 ShellOpenFileByDevicePath(
477 IN OUT EFI_DEVICE_PATH_PROTOCOL
**FilePath
,
478 OUT EFI_HANDLE
*DeviceHandle
,
479 OUT SHELL_FILE_HANDLE
*FileHandle
,
486 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*EfiSimpleFileSystemProtocol
;
487 EFI_FILE_PROTOCOL
*Handle1
;
488 EFI_FILE_PROTOCOL
*Handle2
;
489 CHAR16
*FnafPathName
;
492 if (FilePath
== NULL
|| FileHandle
== NULL
|| DeviceHandle
== NULL
) {
493 return (EFI_INVALID_PARAMETER
);
497 // which shell interface should we use
499 if (gEfiShellProtocol
!= NULL
) {
501 // use UEFI Shell 2.0 method.
503 FileName
= gEfiShellProtocol
->GetFilePathFromDevicePath(*FilePath
);
504 if (FileName
== NULL
) {
505 return (EFI_INVALID_PARAMETER
);
507 Status
= ShellOpenFileByName(FileName
, FileHandle
, OpenMode
, Attributes
);
514 // use old shell method.
516 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
,
519 if (EFI_ERROR (Status
)) {
522 Status
= gBS
->OpenProtocol(*DeviceHandle
,
523 &gEfiSimpleFileSystemProtocolGuid
,
524 (VOID
**)&EfiSimpleFileSystemProtocol
,
527 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
528 if (EFI_ERROR (Status
)) {
531 Status
= EfiSimpleFileSystemProtocol
->OpenVolume(EfiSimpleFileSystemProtocol
, &Handle1
);
532 if (EFI_ERROR (Status
)) {
538 // go down directories one node at a time.
540 while (!IsDevicePathEnd (*FilePath
)) {
542 // For file system access each node should be a file path component
544 if (DevicePathType (*FilePath
) != MEDIA_DEVICE_PATH
||
545 DevicePathSubType (*FilePath
) != MEDIA_FILEPATH_DP
548 return (EFI_INVALID_PARAMETER
);
551 // Open this file path node
557 // File Name Alignment Fix (FNAF)
558 // Handle2->Open may be incapable of handling a unaligned CHAR16 data.
559 // The structure pointed to by FilePath may be not CHAR16 aligned.
560 // This code copies the potentially unaligned PathName data from the
561 // FilePath structure to the aligned FnafPathName for use in the
562 // calls to Handl2->Open.
566 // Determine length of PathName, in bytes.
568 PathLen
= DevicePathNodeLength (*FilePath
) - SIZE_OF_FILEPATH_DEVICE_PATH
;
571 // Allocate memory for the aligned copy of the string Extra allocation is to allow for forced alignment
572 // Copy bytes from possibly unaligned location to aligned location
574 FnafPathName
= AllocateCopyPool(PathLen
, (UINT8
*)((FILEPATH_DEVICE_PATH
*)*FilePath
)->PathName
);
575 if (FnafPathName
== NULL
) {
576 return EFI_OUT_OF_RESOURCES
;
580 // Try to test opening an existing file
582 Status
= Handle2
->Open (
586 OpenMode
&~EFI_FILE_MODE_CREATE
,
591 // see if the error was that it needs to be created
593 if ((EFI_ERROR (Status
)) && (OpenMode
!= (OpenMode
&~EFI_FILE_MODE_CREATE
))) {
594 Status
= Handle2
->Open (
604 // Free the alignment buffer
606 FreePool(FnafPathName
);
609 // Close the last node
611 Handle2
->Close (Handle2
);
613 if (EFI_ERROR(Status
)) {
620 *FilePath
= NextDevicePathNode (*FilePath
);
624 // This is a weak spot since if the undefined SHELL_FILE_HANDLE format changes this must change also!
626 *FileHandle
= (VOID
*)Handle1
;
627 return (EFI_SUCCESS
);
631 This function will open a file or directory referenced by filename.
633 If return is EFI_SUCCESS, the Filehandle is the opened file's handle;
634 otherwise, the Filehandle is NULL. The Attributes is valid only for
635 EFI_FILE_MODE_CREATE.
637 if FileName is NULL then ASSERT()
639 @param FileName pointer to file name
640 @param FileHandle pointer to the file handle.
641 @param OpenMode the mode to open the file with.
642 @param Attributes the file's file attributes.
644 @retval EFI_SUCCESS The information was set.
645 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
646 @retval EFI_UNSUPPORTED Could not open the file path.
647 @retval EFI_NOT_FOUND The specified file could not be found on the
648 device or the file system could not be found
650 @retval EFI_NO_MEDIA The device has no medium.
651 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
652 medium is no longer supported.
653 @retval EFI_DEVICE_ERROR The device reported an error.
654 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
655 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
656 @retval EFI_ACCESS_DENIED The file was opened read only.
657 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
659 @retval EFI_VOLUME_FULL The volume is full.
664 IN CONST CHAR16
*FileName
,
665 OUT SHELL_FILE_HANDLE
*FileHandle
,
670 EFI_HANDLE DeviceHandle
;
671 EFI_DEVICE_PATH_PROTOCOL
*FilePath
;
673 EFI_FILE_INFO
*FileInfo
;
676 // ASSERT if FileName is NULL
678 ASSERT(FileName
!= NULL
);
680 if (FileName
== NULL
) {
681 return (EFI_INVALID_PARAMETER
);
684 if (gEfiShellProtocol
!= NULL
) {
685 if ((OpenMode
& EFI_FILE_MODE_CREATE
) == EFI_FILE_MODE_CREATE
&& (Attributes
& EFI_FILE_DIRECTORY
) == EFI_FILE_DIRECTORY
) {
686 return ShellCreateDirectory(FileName
, FileHandle
);
689 // Use UEFI Shell 2.0 method
691 Status
= gEfiShellProtocol
->OpenFileByName(FileName
,
694 if (StrCmp(FileName
, L
"NUL") != 0 && !EFI_ERROR(Status
) && ((OpenMode
& EFI_FILE_MODE_CREATE
) != 0)){
695 FileInfo
= FileFunctionMap
.GetFileInfo(*FileHandle
);
696 ASSERT(FileInfo
!= NULL
);
697 FileInfo
->Attribute
= Attributes
;
698 Status
= FileFunctionMap
.SetFileInfo(*FileHandle
, FileInfo
);
704 // Using EFI Shell version
705 // this means convert name to path and call that function
706 // since this will use EFI method again that will open it.
708 ASSERT(mEfiShellEnvironment2
!= NULL
);
709 FilePath
= mEfiShellEnvironment2
->NameToPath ((CHAR16
*)FileName
);
710 if (FilePath
!= NULL
) {
711 return (ShellOpenFileByDevicePath(&FilePath
,
717 return (EFI_DEVICE_ERROR
);
720 This function create a directory
722 If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;
723 otherwise, the Filehandle is NULL. If the directory already existed, this
724 function opens the existing directory.
726 @param DirectoryName pointer to directory name
727 @param FileHandle pointer to the file handle.
729 @retval EFI_SUCCESS The information was set.
730 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
731 @retval EFI_UNSUPPORTED Could not open the file path.
732 @retval EFI_NOT_FOUND The specified file could not be found on the
733 device or the file system could not be found
735 @retval EFI_NO_MEDIA The device has no medium.
736 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
737 medium is no longer supported.
738 @retval EFI_DEVICE_ERROR The device reported an error.
739 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
740 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
741 @retval EFI_ACCESS_DENIED The file was opened read only.
742 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
744 @retval EFI_VOLUME_FULL The volume is full.
745 @sa ShellOpenFileByName
749 ShellCreateDirectory(
750 IN CONST CHAR16
*DirectoryName
,
751 OUT SHELL_FILE_HANDLE
*FileHandle
754 if (gEfiShellProtocol
!= NULL
) {
756 // Use UEFI Shell 2.0 method
758 return (gEfiShellProtocol
->CreateFile(DirectoryName
,
763 return (ShellOpenFileByName(DirectoryName
,
765 EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
,
772 This function reads information from an opened file.
774 If FileHandle is not a directory, the function reads the requested number of
775 bytes from the file at the file's current position and returns them in Buffer.
776 If the read goes beyond the end of the file, the read length is truncated to the
777 end of the file. The file's current position is increased by the number of bytes
778 returned. If FileHandle is a directory, the function reads the directory entry
779 at the file's current position and returns the entry in Buffer. If the Buffer
780 is not large enough to hold the current directory entry, then
781 EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
782 BufferSize is set to be the size of the buffer needed to read the entry. On
783 success, the current position is updated to the next directory entry. If there
784 are no more directory entries, the read returns a zero-length buffer.
785 EFI_FILE_INFO is the structure returned as the directory entry.
787 @param FileHandle the opened file handle
788 @param BufferSize on input the size of buffer in bytes. on return
789 the number of bytes written.
790 @param Buffer the buffer to put read data into.
792 @retval EFI_SUCCESS Data was read.
793 @retval EFI_NO_MEDIA The device has no media.
794 @retval EFI_DEVICE_ERROR The device reported an error.
795 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
796 @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
803 IN SHELL_FILE_HANDLE FileHandle
,
804 IN OUT UINTN
*BufferSize
,
808 return (FileFunctionMap
.ReadFile(FileHandle
, BufferSize
, Buffer
));
813 Write data to a file.
815 This function writes the specified number of bytes to the file at the current
816 file position. The current file position is advanced the actual number of bytes
817 written, which is returned in BufferSize. Partial writes only occur when there
818 has been a data error during the write attempt (such as "volume space full").
819 The file is automatically grown to hold the data if required. Direct writes to
820 opened directories are not supported.
822 @param FileHandle The opened file for writing
823 @param BufferSize on input the number of bytes in Buffer. On output
824 the number of bytes written.
825 @param Buffer the buffer containing data to write is stored.
827 @retval EFI_SUCCESS Data was written.
828 @retval EFI_UNSUPPORTED Writes to an open directory are not supported.
829 @retval EFI_NO_MEDIA The device has no media.
830 @retval EFI_DEVICE_ERROR The device reported an error.
831 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
832 @retval EFI_WRITE_PROTECTED The device is write-protected.
833 @retval EFI_ACCESS_DENIED The file was open for read only.
834 @retval EFI_VOLUME_FULL The volume is full.
839 IN SHELL_FILE_HANDLE FileHandle
,
840 IN OUT UINTN
*BufferSize
,
844 return (FileFunctionMap
.WriteFile(FileHandle
, BufferSize
, Buffer
));
848 Close an open file handle.
850 This function closes a specified file handle. All "dirty" cached file data is
851 flushed to the device, and the file is closed. In all cases the handle is
854 @param FileHandle the file handle to close.
856 @retval EFI_SUCCESS the file handle was closed sucessfully.
861 IN SHELL_FILE_HANDLE
*FileHandle
864 return (FileFunctionMap
.CloseFile(*FileHandle
));
868 Delete a file and close the handle
870 This function closes and deletes a file. In all cases the file handle is closed.
871 If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
872 returned, but the handle is still closed.
874 @param FileHandle the file handle to delete
876 @retval EFI_SUCCESS the file was closed sucessfully
877 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
879 @retval INVALID_PARAMETER One of the parameters has an invalid value.
884 IN SHELL_FILE_HANDLE
*FileHandle
887 return (FileFunctionMap
.DeleteFile(*FileHandle
));
891 Set the current position in a file.
893 This function sets the current file position for the handle to the position
894 supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only
895 absolute positioning is supported, and seeking past the end of the file is
896 allowed (a subsequent write would grow the file). Seeking to position
897 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
898 If FileHandle is a directory, the only position that may be set is zero. This
899 has the effect of starting the read process of the directory entries over.
901 @param FileHandle The file handle on which the position is being set
902 @param Position Byte position from begining of file
904 @retval EFI_SUCCESS Operation completed sucessfully.
905 @retval EFI_UNSUPPORTED the seek request for non-zero is not valid on
907 @retval INVALID_PARAMETER One of the parameters has an invalid value.
911 ShellSetFilePosition (
912 IN SHELL_FILE_HANDLE FileHandle
,
916 return (FileFunctionMap
.SetFilePosition(FileHandle
, Position
));
920 Gets a file's current position
922 This function retrieves the current file position for the file handle. For
923 directories, the current file position has no meaning outside of the file
924 system driver and as such the operation is not supported. An error is returned
925 if FileHandle is a directory.
927 @param FileHandle The open file handle on which to get the position.
928 @param Position Byte position from begining of file.
930 @retval EFI_SUCCESS the operation completed sucessfully.
931 @retval INVALID_PARAMETER One of the parameters has an invalid value.
932 @retval EFI_UNSUPPORTED the request is not valid on directories.
936 ShellGetFilePosition (
937 IN SHELL_FILE_HANDLE FileHandle
,
941 return (FileFunctionMap
.GetFilePosition(FileHandle
, Position
));
944 Flushes data on a file
946 This function flushes all modified data associated with a file to a device.
948 @param FileHandle The file handle on which to flush data
950 @retval EFI_SUCCESS The data was flushed.
951 @retval EFI_NO_MEDIA The device has no media.
952 @retval EFI_DEVICE_ERROR The device reported an error.
953 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
954 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
955 @retval EFI_ACCESS_DENIED The file was opened for read only.
960 IN SHELL_FILE_HANDLE FileHandle
963 return (FileFunctionMap
.FlushFile(FileHandle
));
966 /** Retrieve first entry from a directory.
968 This function takes an open directory handle and gets information from the
969 first entry in the directory. A buffer is allocated to contain
970 the information and a pointer to the buffer is returned in *Buffer. The
971 caller can use ShellFindNextFile() to get subsequent directory entries.
973 The buffer will be freed by ShellFindNextFile() when the last directory
974 entry is read. Otherwise, the caller must free the buffer, using FreePool,
975 when finished with it.
977 @param[in] DirHandle The file handle of the directory to search.
978 @param[out] Buffer The pointer to the buffer for the file's information.
980 @retval EFI_SUCCESS Found the first file.
981 @retval EFI_NOT_FOUND Cannot find the directory.
982 @retval EFI_NO_MEDIA The device has no media.
983 @retval EFI_DEVICE_ERROR The device reported an error.
984 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
985 @return Others status of ShellGetFileInfo, ShellSetFilePosition,
991 IN SHELL_FILE_HANDLE DirHandle
,
992 OUT EFI_FILE_INFO
**Buffer
996 // pass to file handle lib
998 return (FileHandleFindFirstFile(DirHandle
, Buffer
));
1000 /** Retrieve next entries from a directory.
1002 To use this function, the caller must first call the ShellFindFirstFile()
1003 function to get the first directory entry. Subsequent directory entries are
1004 retrieved by using the ShellFindNextFile() function. This function can
1005 be called several times to get each entry from the directory. If the call of
1006 ShellFindNextFile() retrieved the last directory entry, the next call of
1007 this function will set *NoFile to TRUE and free the buffer.
1009 @param[in] DirHandle The file handle of the directory.
1010 @param[out] Buffer The pointer to buffer for file's information.
1011 @param[out] NoFile The pointer to boolean when last file is found.
1013 @retval EFI_SUCCESS Found the next file, or reached last file
1014 @retval EFI_NO_MEDIA The device has no media.
1015 @retval EFI_DEVICE_ERROR The device reported an error.
1016 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1021 IN SHELL_FILE_HANDLE DirHandle
,
1022 OUT EFI_FILE_INFO
*Buffer
,
1027 // pass to file handle lib
1029 return (FileHandleFindNextFile(DirHandle
, Buffer
, NoFile
));
1032 Retrieve the size of a file.
1034 if FileHandle is NULL then ASSERT()
1035 if Size is NULL then ASSERT()
1037 This function extracts the file size info from the FileHandle's EFI_FILE_INFO
1040 @param FileHandle file handle from which size is retrieved
1041 @param Size pointer to size
1043 @retval EFI_SUCCESS operation was completed sucessfully
1044 @retval EFI_DEVICE_ERROR cannot access the file
1049 IN SHELL_FILE_HANDLE FileHandle
,
1053 return (FileFunctionMap
.GetFileSize(FileHandle
, Size
));
1056 Retrieves the status of the break execution flag
1058 this function is useful to check whether the application is being asked to halt by the shell.
1060 @retval TRUE the execution break is enabled
1061 @retval FALSE the execution break is not enabled
1065 ShellGetExecutionBreakFlag(
1070 // Check for UEFI Shell 2.0 protocols
1072 if (gEfiShellProtocol
!= NULL
) {
1075 // We are using UEFI Shell 2.0; see if the event has been triggered
1077 if (gBS
->CheckEvent(gEfiShellProtocol
->ExecutionBreak
) != EFI_SUCCESS
) {
1084 // using EFI Shell; call the function to check
1086 if (mEfiShellEnvironment2
!= NULL
) {
1087 return (mEfiShellEnvironment2
->GetExecutionBreak());
1093 return the value of an environment variable
1095 this function gets the value of the environment variable set by the
1096 ShellSetEnvironmentVariable function
1098 @param EnvKey The key name of the environment variable.
1100 @retval NULL the named environment variable does not exist.
1101 @return != NULL pointer to the value of the environment variable
1105 ShellGetEnvironmentVariable (
1106 IN CONST CHAR16
*EnvKey
1110 // Check for UEFI Shell 2.0 protocols
1112 if (gEfiShellProtocol
!= NULL
) {
1113 return (gEfiShellProtocol
->GetEnv(EnvKey
));
1117 // Check for EFI shell
1119 if (mEfiShellEnvironment2
!= NULL
) {
1120 return (mEfiShellEnvironment2
->GetEnv((CHAR16
*)EnvKey
));
1126 set the value of an environment variable
1128 This function changes the current value of the specified environment variable. If the
1129 environment variable exists and the Value is an empty string, then the environment
1130 variable is deleted. If the environment variable exists and the Value is not an empty
1131 string, then the value of the environment variable is changed. If the environment
1132 variable does not exist and the Value is an empty string, there is no action. If the
1133 environment variable does not exist and the Value is a non-empty string, then the
1134 environment variable is created and assigned the specified value.
1136 This is not supported pre-UEFI Shell 2.0.
1138 @param EnvKey The key name of the environment variable.
1139 @param EnvVal The Value of the environment variable
1140 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
1142 @retval EFI_SUCCESS the operation was completed sucessfully
1143 @retval EFI_UNSUPPORTED This operation is not allowed in pre UEFI 2.0 Shell environments
1147 ShellSetEnvironmentVariable (
1148 IN CONST CHAR16
*EnvKey
,
1149 IN CONST CHAR16
*EnvVal
,
1154 // Check for UEFI Shell 2.0 protocols
1156 if (gEfiShellProtocol
!= NULL
) {
1157 return (gEfiShellProtocol
->SetEnv(EnvKey
, EnvVal
, Volatile
));
1161 // This feature does not exist under EFI shell
1163 return (EFI_UNSUPPORTED
);
1167 Cause the shell to parse and execute a command line.
1169 This function creates a nested instance of the shell and executes the specified
1170 command (CommandLine) with the specified environment (Environment). Upon return,
1171 the status code returned by the specified command is placed in StatusCode.
1172 If Environment is NULL, then the current environment is used and all changes made
1173 by the commands executed will be reflected in the current environment. If the
1174 Environment is non-NULL, then the changes made will be discarded.
1175 The CommandLine is executed from the current working directory on the current
1178 The EnvironmentVariables pararemeter is ignored in a pre-UEFI Shell 2.0
1179 environment. The values pointed to by the parameters will be unchanged by the
1180 ShellExecute() function. The Output parameter has no effect in a
1181 UEFI Shell 2.0 environment.
1183 @param[in] ParentHandle The parent image starting the operation.
1184 @param[in] CommandLine The pointer to a NULL terminated command line.
1185 @param[in] Output True to display debug output. False to hide it.
1186 @param[in] EnvironmentVariables Optional pointer to array of environment variables
1187 in the form "x=y". If NULL, the current set is used.
1188 @param[out] Status The status of the run command line.
1190 @retval EFI_SUCCESS The operation completed sucessfully. Status
1191 contains the status code returned.
1192 @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.
1193 @retval EFI_OUT_OF_RESOURCES Out of resources.
1194 @retval EFI_UNSUPPORTED The operation is not allowed.
1199 IN EFI_HANDLE
*ParentHandle
,
1200 IN CHAR16
*CommandLine OPTIONAL
,
1201 IN BOOLEAN Output OPTIONAL
,
1202 IN CHAR16
**EnvironmentVariables OPTIONAL
,
1203 OUT EFI_STATUS
*Status OPTIONAL
1206 EFI_STATUS CmdStatus
;
1208 // Check for UEFI Shell 2.0 protocols
1210 if (gEfiShellProtocol
!= NULL
) {
1212 // Call UEFI Shell 2.0 version (not using Output parameter)
1214 return (gEfiShellProtocol
->Execute(ParentHandle
,
1216 EnvironmentVariables
,
1221 // Check for EFI shell
1223 if (mEfiShellEnvironment2
!= NULL
) {
1225 // Call EFI Shell version.
1226 // Due to oddity in the EFI shell we want to dereference the ParentHandle here
1228 CmdStatus
= (mEfiShellEnvironment2
->Execute(*ParentHandle
,
1232 // No Status output parameter so just use the returned status
1234 if (Status
!= NULL
) {
1235 *Status
= CmdStatus
;
1238 // If there was an error, we can't tell if it was from the command or from
1239 // the Execute() function, so we'll just assume the shell ran successfully
1240 // and the error came from the command.
1245 return (EFI_UNSUPPORTED
);
1249 Retreives the current directory path
1251 If the DeviceName is NULL, it returns the current device's current directory
1252 name. If the DeviceName is not NULL, it returns the current directory name
1255 @param DeviceName the name of the drive to get directory on
1257 @retval NULL the directory does not exist
1258 @return != NULL the directory
1262 ShellGetCurrentDir (
1263 IN CHAR16
* CONST DeviceName OPTIONAL
1267 // Check for UEFI Shell 2.0 protocols
1269 if (gEfiShellProtocol
!= NULL
) {
1270 return (gEfiShellProtocol
->GetCurDir(DeviceName
));
1274 // Check for EFI shell
1276 if (mEfiShellEnvironment2
!= NULL
) {
1277 return (mEfiShellEnvironment2
->CurDir(DeviceName
));
1283 sets (enabled or disabled) the page break mode
1285 when page break mode is enabled the screen will stop scrolling
1286 and wait for operator input before scrolling a subsequent screen.
1288 @param CurrentState TRUE to enable and FALSE to disable
1292 ShellSetPageBreakMode (
1293 IN BOOLEAN CurrentState
1297 // check for enabling
1299 if (CurrentState
!= 0x00) {
1301 // check for UEFI Shell 2.0
1303 if (gEfiShellProtocol
!= NULL
) {
1305 // Enable with UEFI 2.0 Shell
1307 gEfiShellProtocol
->EnablePageBreak();
1311 // Check for EFI shell
1313 if (mEfiShellEnvironment2
!= NULL
) {
1315 // Enable with EFI Shell
1317 mEfiShellEnvironment2
->EnablePageBreak (DEFAULT_INIT_ROW
, DEFAULT_AUTO_LF
);
1323 // check for UEFI Shell 2.0
1325 if (gEfiShellProtocol
!= NULL
) {
1327 // Disable with UEFI 2.0 Shell
1329 gEfiShellProtocol
->DisablePageBreak();
1333 // Check for EFI shell
1335 if (mEfiShellEnvironment2
!= NULL
) {
1337 // Disable with EFI Shell
1339 mEfiShellEnvironment2
->DisablePageBreak ();
1347 /// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.
1348 /// This allows for the struct to be populated.
1355 SHELL_FILE_HANDLE Handle
;
1356 EFI_FILE_INFO
*Info
;
1357 } EFI_SHELL_FILE_INFO_NO_CONST
;
1360 Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.
1362 if OldStyleFileList is NULL then ASSERT()
1364 this function will convert a SHELL_FILE_ARG based list into a callee allocated
1365 EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
1366 the ShellCloseFileMetaArg function.
1368 @param[in] FileList the EFI shell list type
1369 @param[in, out] ListHead the list to add to
1371 @retval the resultant head of the double linked new format list;
1375 InternalShellConvertFileListType (
1376 IN LIST_ENTRY
*FileList
,
1377 IN OUT LIST_ENTRY
*ListHead
1380 SHELL_FILE_ARG
*OldInfo
;
1382 EFI_SHELL_FILE_INFO_NO_CONST
*NewInfo
;
1387 ASSERT(FileList
!= NULL
);
1388 ASSERT(ListHead
!= NULL
);
1391 // enumerate through each member of the old list and copy
1393 for (Link
= FileList
->ForwardLink
; Link
!= FileList
; Link
= Link
->ForwardLink
) {
1394 OldInfo
= CR (Link
, SHELL_FILE_ARG
, Link
, SHELL_FILE_ARG_SIGNATURE
);
1395 ASSERT(OldInfo
!= NULL
);
1398 // Skip ones that failed to open...
1400 if (OldInfo
->Status
!= EFI_SUCCESS
) {
1405 // make sure the old list was valid
1407 ASSERT(OldInfo
->Info
!= NULL
);
1408 ASSERT(OldInfo
->FullName
!= NULL
);
1409 ASSERT(OldInfo
->FileName
!= NULL
);
1412 // allocate a new EFI_SHELL_FILE_INFO object
1414 NewInfo
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1415 if (NewInfo
== NULL
) {
1416 ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO
**)(&ListHead
));
1422 // copy the simple items
1424 NewInfo
->Handle
= OldInfo
->Handle
;
1425 NewInfo
->Status
= OldInfo
->Status
;
1427 // old shell checks for 0 not NULL
1428 OldInfo
->Handle
= 0;
1431 // allocate new space to copy strings and structure
1433 NewInfo
->FullName
= AllocateCopyPool(StrSize(OldInfo
->FullName
), OldInfo
->FullName
);
1434 NewInfo
->FileName
= AllocateCopyPool(StrSize(OldInfo
->FileName
), OldInfo
->FileName
);
1435 NewInfo
->Info
= AllocateCopyPool((UINTN
)OldInfo
->Info
->Size
, OldInfo
->Info
);
1438 // make sure all the memory allocations were sucessful
1440 if (NULL
== NewInfo
->FullName
|| NewInfo
->FileName
== NULL
|| NewInfo
->Info
== NULL
) {
1442 // Free the partially allocated new node
1444 SHELL_FREE_NON_NULL(NewInfo
->FullName
);
1445 SHELL_FREE_NON_NULL(NewInfo
->FileName
);
1446 SHELL_FREE_NON_NULL(NewInfo
->Info
);
1447 SHELL_FREE_NON_NULL(NewInfo
);
1450 // Free the previously converted stuff
1452 ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO
**)(&ListHead
));
1458 // add that to the list
1460 InsertTailList(ListHead
, &NewInfo
->Link
);
1465 Opens a group of files based on a path.
1467 This function uses the Arg to open all the matching files. Each matched
1468 file has a SHELL_FILE_INFO structure to record the file information. These
1469 structures are placed on the list ListHead. Users can get the SHELL_FILE_INFO
1470 structures from ListHead to access each file. This function supports wildcards
1471 and will process '?' and '*' as such. the list must be freed with a call to
1472 ShellCloseFileMetaArg().
1474 If you are NOT appending to an existing list *ListHead must be NULL. If
1475 *ListHead is NULL then it must be callee freed.
1477 @param Arg pointer to path string
1478 @param OpenMode mode to open files with
1479 @param ListHead head of linked list of results
1481 @retval EFI_SUCCESS the operation was sucessful and the list head
1482 contains the list of opened files
1483 @return != EFI_SUCCESS the operation failed
1485 @sa InternalShellConvertFileListType
1489 ShellOpenFileMetaArg (
1492 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1496 LIST_ENTRY mOldStyleFileList
;
1499 // ASSERT that Arg and ListHead are not NULL
1501 ASSERT(Arg
!= NULL
);
1502 ASSERT(ListHead
!= NULL
);
1505 // Check for UEFI Shell 2.0 protocols
1507 if (gEfiShellProtocol
!= NULL
) {
1508 if (*ListHead
== NULL
) {
1509 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1510 if (*ListHead
== NULL
) {
1511 return (EFI_OUT_OF_RESOURCES
);
1513 InitializeListHead(&((*ListHead
)->Link
));
1515 Status
= gEfiShellProtocol
->OpenFileList(Arg
,
1518 if (EFI_ERROR(Status
)) {
1519 gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1521 Status
= gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1523 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1524 FreePool(*ListHead
);
1526 return (EFI_NOT_FOUND
);
1532 // Check for EFI shell
1534 if (mEfiShellEnvironment2
!= NULL
) {
1536 // make sure the list head is initialized
1538 InitializeListHead(&mOldStyleFileList
);
1541 // Get the EFI Shell list of files
1543 Status
= mEfiShellEnvironment2
->FileMetaArg(Arg
, &mOldStyleFileList
);
1544 if (EFI_ERROR(Status
)) {
1549 if (*ListHead
== NULL
) {
1550 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1551 if (*ListHead
== NULL
) {
1552 return (EFI_OUT_OF_RESOURCES
);
1554 InitializeListHead(&((*ListHead
)->Link
));
1558 // Convert that to equivalent of UEFI Shell 2.0 structure
1560 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1563 // Free the EFI Shell version that was converted.
1565 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1567 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1568 FreePool(*ListHead
);
1570 Status
= EFI_NOT_FOUND
;
1575 return (EFI_UNSUPPORTED
);
1578 Free the linked list returned from ShellOpenFileMetaArg.
1580 if ListHead is NULL then ASSERT().
1582 @param ListHead the pointer to free.
1584 @retval EFI_SUCCESS the operation was sucessful.
1588 ShellCloseFileMetaArg (
1589 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1595 // ASSERT that ListHead is not NULL
1597 ASSERT(ListHead
!= NULL
);
1600 // Check for UEFI Shell 2.0 protocols
1602 if (gEfiShellProtocol
!= NULL
) {
1603 return (gEfiShellProtocol
->FreeFileList(ListHead
));
1604 } else if (mEfiShellEnvironment2
!= NULL
) {
1606 // Since this is EFI Shell version we need to free our internally made copy
1609 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1610 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1611 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1612 RemoveEntryList(Node
);
1613 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1614 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1615 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1616 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1617 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1619 SHELL_FREE_NON_NULL(*ListHead
);
1623 return (EFI_UNSUPPORTED
);
1627 Find a file by searching the CWD and then the path.
1629 If FileName is NULL then ASSERT.
1631 If the return value is not NULL then the memory must be caller freed.
1633 @param FileName Filename string.
1635 @retval NULL the file was not found
1636 @return !NULL the full path to the file.
1641 IN CONST CHAR16
*FileName
1645 SHELL_FILE_HANDLE Handle
;
1649 CONST CHAR16
*Walker
;
1656 // First make sure its not an absolute path.
1658 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1659 if (!EFI_ERROR(Status
)){
1660 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1661 ASSERT(RetVal
== NULL
);
1662 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1663 ShellCloseFile(&Handle
);
1666 ShellCloseFile(&Handle
);
1670 Path
= ShellGetEnvironmentVariable(L
"cwd");
1672 Size
= StrSize(Path
);
1673 Size
+= StrSize(FileName
);
1674 TestPath
= AllocateZeroPool(Size
);
1675 if (TestPath
== NULL
) {
1678 StrnCpy(TestPath
, Path
, Size
/sizeof(CHAR16
) - 1);
1679 StrnCat(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1680 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1681 if (!EFI_ERROR(Status
)){
1682 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1683 ASSERT(RetVal
== NULL
);
1684 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1685 ShellCloseFile(&Handle
);
1689 ShellCloseFile(&Handle
);
1694 Path
= ShellGetEnvironmentVariable(L
"path");
1696 Size
= StrSize(Path
)+sizeof(CHAR16
);
1697 Size
+= StrSize(FileName
);
1698 TestPath
= AllocateZeroPool(Size
);
1699 if (TestPath
== NULL
) {
1702 Walker
= (CHAR16
*)Path
;
1704 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1705 if (TestPath
!= NULL
) {
1706 TempChar
= StrStr(TestPath
, L
";");
1707 if (TempChar
!= NULL
) {
1708 *TempChar
= CHAR_NULL
;
1710 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1711 StrnCat(TestPath
, L
"\\", Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1713 if (FileName
[0] == L
'\\') {
1716 StrnCat(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1717 if (StrStr(Walker
, L
";") != NULL
) {
1718 Walker
= StrStr(Walker
, L
";") + 1;
1722 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1723 if (!EFI_ERROR(Status
)){
1724 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1725 ASSERT(RetVal
== NULL
);
1726 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1727 ShellCloseFile(&Handle
);
1730 ShellCloseFile(&Handle
);
1734 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1741 Find a file by searching the CWD and then the path with a variable set of file
1742 extensions. If the file is not found it will append each extension in the list
1743 in the order provided and return the first one that is successful.
1745 If FileName is NULL, then ASSERT.
1746 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1748 If the return value is not NULL then the memory must be caller freed.
1750 @param[in] FileName Filename string.
1751 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1753 @retval NULL The file was not found.
1754 @retval !NULL The path to the file.
1758 ShellFindFilePathEx (
1759 IN CONST CHAR16
*FileName
,
1760 IN CONST CHAR16
*FileExtension
1765 CONST CHAR16
*ExtensionWalker
;
1770 ASSERT(FileName
!= NULL
);
1771 if (FileExtension
== NULL
) {
1772 return (ShellFindFilePath(FileName
));
1774 RetVal
= ShellFindFilePath(FileName
);
1775 if (RetVal
!= NULL
) {
1778 Size
= StrSize(FileName
);
1779 Size
+= StrSize(FileExtension
);
1780 TestPath
= AllocateZeroPool(Size
);
1781 if (TestPath
== NULL
) {
1784 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1785 StrnCpy(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1);
1786 if (ExtensionWalker
!= NULL
) {
1787 StrnCat(TestPath
, ExtensionWalker
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1789 TempChar
= StrStr(TestPath
, L
";");
1790 if (TempChar
!= NULL
) {
1791 *TempChar
= CHAR_NULL
;
1793 RetVal
= ShellFindFilePath(TestPath
);
1794 if (RetVal
!= NULL
) {
1797 ASSERT(ExtensionWalker
!= NULL
);
1798 TempChar2
= StrStr(ExtensionWalker
, L
";");
1807 SHELL_PARAM_TYPE Type
;
1809 UINTN OriginalPosition
;
1810 } SHELL_PARAM_PACKAGE
;
1813 Checks the list of valid arguments and returns TRUE if the item was found. If the
1814 return value is TRUE then the type parameter is set also.
1816 if CheckList is NULL then ASSERT();
1817 if Name is NULL then ASSERT();
1818 if Type is NULL then ASSERT();
1820 @param Name pointer to Name of parameter found
1821 @param CheckList List to check against
1822 @param Type pointer to type of parameter if it was found
1824 @retval TRUE the Parameter was found. Type is valid.
1825 @retval FALSE the Parameter was not found. Type is not valid.
1829 InternalIsOnCheckList (
1830 IN CONST CHAR16
*Name
,
1831 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1832 OUT SHELL_PARAM_TYPE
*Type
1835 SHELL_PARAM_ITEM
*TempListItem
;
1839 // ASSERT that all 3 pointer parameters aren't NULL
1841 ASSERT(CheckList
!= NULL
);
1842 ASSERT(Type
!= NULL
);
1843 ASSERT(Name
!= NULL
);
1846 // question mark and page break mode are always supported
1848 if ((StrCmp(Name
, L
"-?") == 0) ||
1849 (StrCmp(Name
, L
"-b") == 0)
1856 // Enumerate through the list
1858 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1860 // If the Type is TypeStart only check the first characters of the passed in param
1861 // If it matches set the type and return TRUE
1863 if (TempListItem
->Type
== TypeStart
) {
1864 if (StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1865 *Type
= TempListItem
->Type
;
1869 TempString
= StrnCatGrow(&TempString
, NULL
, Name
, StrLen(TempListItem
->Name
));
1870 if (TempString
!= NULL
) {
1871 if (StringNoCaseCompare(&TempString
, &TempListItem
->Name
) == 0) {
1872 *Type
= TempListItem
->Type
;
1873 FreePool(TempString
);
1876 FreePool(TempString
);
1878 } else if (StringNoCaseCompare(&Name
, &TempListItem
->Name
) == 0) {
1879 *Type
= TempListItem
->Type
;
1887 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1889 @param[in] Name pointer to Name of parameter found
1890 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1892 @retval TRUE the Parameter is a flag.
1893 @retval FALSE the Parameter not a flag.
1898 IN CONST CHAR16
*Name
,
1899 IN BOOLEAN AlwaysAllowNumbers
1903 // ASSERT that Name isn't NULL
1905 ASSERT(Name
!= NULL
);
1908 // If we accept numbers then dont return TRUE. (they will be values)
1910 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && InternalShellIsHexOrDecimalNumber(Name
+1, FALSE
, FALSE
)) && AlwaysAllowNumbers
) {
1915 // If the Name has a /, +, or - as the first character return TRUE
1917 if ((Name
[0] == L
'/') ||
1918 (Name
[0] == L
'-') ||
1927 Checks the command line arguments passed against the list of valid ones.
1929 If no initialization is required, then return RETURN_SUCCESS.
1931 @param[in] CheckList pointer to list of parameters to check
1932 @param[out] CheckPackage pointer to pointer to list checked values
1933 @param[out] ProblemParam optional pointer to pointer to unicode string for
1934 the paramater that caused failure. If used then the
1935 caller is responsible for freeing the memory.
1936 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1937 @param[in] Argv pointer to array of parameters
1938 @param[in] Argc Count of parameters in Argv
1939 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1941 @retval EFI_SUCCESS The operation completed sucessfully.
1942 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1943 @retval EFI_INVALID_PARAMETER A parameter was invalid
1944 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1945 duplicated. the duplicated command line argument
1946 was returned in ProblemParam if provided.
1947 @retval EFI_NOT_FOUND a argument required a value that was missing.
1948 the invalid command line argument was returned in
1949 ProblemParam if provided.
1953 InternalCommandLineParse (
1954 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1955 OUT LIST_ENTRY
**CheckPackage
,
1956 OUT CHAR16
**ProblemParam OPTIONAL
,
1957 IN BOOLEAN AutoPageBreak
,
1958 IN CONST CHAR16
**Argv
,
1960 IN BOOLEAN AlwaysAllowNumbers
1964 SHELL_PARAM_TYPE CurrentItemType
;
1965 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
1969 CONST CHAR16
*TempPointer
;
1970 UINTN CurrentValueSize
;
1972 CurrentItemPackage
= NULL
;
1978 // If there is only 1 item we dont need to do anything
1981 *CheckPackage
= NULL
;
1982 return (EFI_SUCCESS
);
1988 ASSERT(CheckList
!= NULL
);
1989 ASSERT(Argv
!= NULL
);
1992 // initialize the linked list
1994 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
1995 if (*CheckPackage
== NULL
) {
1996 return (EFI_OUT_OF_RESOURCES
);
1999 InitializeListHead(*CheckPackage
);
2002 // loop through each of the arguments
2004 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
2005 if (Argv
[LoopCounter
] == NULL
) {
2007 // do nothing for NULL argv
2009 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
2011 // We might have leftover if last parameter didnt have optional value
2013 if (GetItemValue
!= 0) {
2015 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2020 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2021 if (CurrentItemPackage
== NULL
) {
2022 ShellCommandLineFreeVarList(*CheckPackage
);
2023 *CheckPackage
= NULL
;
2024 return (EFI_OUT_OF_RESOURCES
);
2026 CurrentItemPackage
->Name
= AllocateCopyPool(StrSize(Argv
[LoopCounter
]), Argv
[LoopCounter
]);
2027 if (CurrentItemPackage
->Name
== NULL
) {
2028 ShellCommandLineFreeVarList(*CheckPackage
);
2029 *CheckPackage
= NULL
;
2030 return (EFI_OUT_OF_RESOURCES
);
2032 CurrentItemPackage
->Type
= CurrentItemType
;
2033 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
2034 CurrentItemPackage
->Value
= NULL
;
2037 // Does this flag require a value
2039 switch (CurrentItemPackage
->Type
) {
2041 // possibly trigger the next loop(s) to populate the value of this item
2047 case TypeDoubleValue
:
2052 GetItemValue
= (UINTN
)(-1);
2057 // this item has no value expected; we are done
2059 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2060 ASSERT(GetItemValue
== 0);
2063 } else if (GetItemValue
!= 0 && !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
)) {
2064 ASSERT(CurrentItemPackage
!= NULL
);
2066 // get the item VALUE for a previous flag
2068 if (StrStr(Argv
[LoopCounter
], L
" ") == NULL
) {
2069 CurrentValueSize
= ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2070 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, CurrentValueSize
, CurrentItemPackage
->Value
);
2071 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2072 if (ValueSize
== 0) {
2073 StrnCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1);
2075 StrnCat(CurrentItemPackage
->Value
, L
" ", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2076 StrnCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2078 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2081 // the parameter has spaces. must be quoted.
2083 CurrentValueSize
= ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
) + sizeof(CHAR16
) + sizeof(CHAR16
);
2084 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, CurrentValueSize
, CurrentItemPackage
->Value
);
2085 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2086 if (ValueSize
== 0) {
2087 StrnCpy(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1);
2088 StrnCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2089 StrnCat(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2091 StrnCat(CurrentItemPackage
->Value
, L
" ", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2092 StrnCat(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2093 StrnCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2094 StrnCat(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2096 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2099 if (GetItemValue
== 0) {
2100 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2102 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
) ){ //|| ProblemParam == NULL) {
2104 // add this one as a non-flag
2107 TempPointer
= Argv
[LoopCounter
];
2108 if ((*TempPointer
== L
'^' && *(TempPointer
+1) == L
'-')
2109 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'/')
2110 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'+')
2114 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2115 if (CurrentItemPackage
== NULL
) {
2116 ShellCommandLineFreeVarList(*CheckPackage
);
2117 *CheckPackage
= NULL
;
2118 return (EFI_OUT_OF_RESOURCES
);
2120 CurrentItemPackage
->Name
= NULL
;
2121 CurrentItemPackage
->Type
= TypePosition
;
2122 CurrentItemPackage
->Value
= AllocateCopyPool(StrSize(TempPointer
), TempPointer
);
2123 if (CurrentItemPackage
->Value
== NULL
) {
2124 ShellCommandLineFreeVarList(*CheckPackage
);
2125 *CheckPackage
= NULL
;
2126 return (EFI_OUT_OF_RESOURCES
);
2128 CurrentItemPackage
->OriginalPosition
= Count
++;
2129 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2132 // this was a non-recognised flag... error!
2134 if (ProblemParam
!= NULL
) {
2135 *ProblemParam
= AllocateCopyPool(StrSize(Argv
[LoopCounter
]), Argv
[LoopCounter
]);
2137 ShellCommandLineFreeVarList(*CheckPackage
);
2138 *CheckPackage
= NULL
;
2139 return (EFI_VOLUME_CORRUPTED
);
2142 if (GetItemValue
!= 0) {
2144 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2147 // support for AutoPageBreak
2149 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2150 ShellSetPageBreakMode(TRUE
);
2152 return (EFI_SUCCESS
);
2156 Checks the command line arguments passed against the list of valid ones.
2157 Optionally removes NULL values first.
2159 If no initialization is required, then return RETURN_SUCCESS.
2161 @param[in] CheckList The pointer to list of parameters to check.
2162 @param[out] CheckPackage The package of checked values.
2163 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2164 the paramater that caused failure.
2165 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2166 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2168 @retval EFI_SUCCESS The operation completed sucessfully.
2169 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2170 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2171 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2172 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2173 of the command line arguments was returned in
2174 ProblemParam if provided.
2175 @retval EFI_NOT_FOUND A argument required a value that was missing.
2176 The invalid command line argument was returned in
2177 ProblemParam if provided.
2181 ShellCommandLineParseEx (
2182 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2183 OUT LIST_ENTRY
**CheckPackage
,
2184 OUT CHAR16
**ProblemParam OPTIONAL
,
2185 IN BOOLEAN AutoPageBreak
,
2186 IN BOOLEAN AlwaysAllowNumbers
2190 // ASSERT that CheckList and CheckPackage aren't NULL
2192 ASSERT(CheckList
!= NULL
);
2193 ASSERT(CheckPackage
!= NULL
);
2196 // Check for UEFI Shell 2.0 protocols
2198 if (gEfiShellParametersProtocol
!= NULL
) {
2199 return (InternalCommandLineParse(CheckList
,
2203 (CONST CHAR16
**) gEfiShellParametersProtocol
->Argv
,
2204 gEfiShellParametersProtocol
->Argc
,
2205 AlwaysAllowNumbers
));
2209 // ASSERT That EFI Shell is not required
2211 ASSERT (mEfiShellInterface
!= NULL
);
2212 return (InternalCommandLineParse(CheckList
,
2216 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2217 mEfiShellInterface
->Argc
,
2218 AlwaysAllowNumbers
));
2222 Frees shell variable list that was returned from ShellCommandLineParse.
2224 This function will free all the memory that was used for the CheckPackage
2225 list of postprocessed shell arguments.
2227 this function has no return value.
2229 if CheckPackage is NULL, then return
2231 @param CheckPackage the list to de-allocate
2235 ShellCommandLineFreeVarList (
2236 IN LIST_ENTRY
*CheckPackage
2242 // check for CheckPackage == NULL
2244 if (CheckPackage
== NULL
) {
2249 // for each node in the list
2251 for ( Node
= GetFirstNode(CheckPackage
)
2252 ; !IsListEmpty(CheckPackage
)
2253 ; Node
= GetFirstNode(CheckPackage
)
2256 // Remove it from the list
2258 RemoveEntryList(Node
);
2261 // if it has a name free the name
2263 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2264 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2268 // if it has a value free the value
2270 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2271 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2275 // free the node structure
2277 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2280 // free the list head node
2282 FreePool(CheckPackage
);
2285 Checks for presence of a flag parameter
2287 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2289 if CheckPackage is NULL then return FALSE.
2290 if KeyString is NULL then ASSERT()
2292 @param CheckPackage The package of parsed command line arguments
2293 @param KeyString the Key of the command line argument to check for
2295 @retval TRUE the flag is on the command line
2296 @retval FALSE the flag is not on the command line
2300 ShellCommandLineGetFlag (
2301 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2302 IN CONST CHAR16
* CONST KeyString
2309 // return FALSE for no package or KeyString is NULL
2311 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2316 // enumerate through the list of parametrs
2318 for ( Node
= GetFirstNode(CheckPackage
)
2319 ; !IsNull (CheckPackage
, Node
)
2320 ; Node
= GetNextNode(CheckPackage
, Node
)
2323 // If the Name matches, return TRUE (and there may be NULL name)
2325 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2327 // If Type is TypeStart then only compare the begining of the strings
2329 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2330 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2334 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2335 if (TempString
!= NULL
) {
2336 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2337 FreePool(TempString
);
2340 FreePool(TempString
);
2342 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2350 Returns value from command line argument.
2352 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2354 If CheckPackage is NULL, then return NULL.
2356 @param[in] CheckPackage The package of parsed command line arguments.
2357 @param[in] KeyString The Key of the command line argument to check for.
2359 @retval NULL The flag is not on the command line.
2360 @retval !=NULL The pointer to unicode string of the value.
2364 ShellCommandLineGetValue (
2365 IN CONST LIST_ENTRY
*CheckPackage
,
2366 IN CHAR16
*KeyString
2373 // return NULL for no package or KeyString is NULL
2375 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2380 // enumerate through the list of parametrs
2382 for ( Node
= GetFirstNode(CheckPackage
)
2383 ; !IsNull (CheckPackage
, Node
)
2384 ; Node
= GetNextNode(CheckPackage
, Node
)
2387 // If the Name matches, return TRUE (and there may be NULL name)
2389 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2391 // If Type is TypeStart then only compare the begining of the strings
2393 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2394 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2395 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2398 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2399 if (TempString
!= NULL
) {
2400 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2401 FreePool(TempString
);
2402 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2404 FreePool(TempString
);
2406 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2407 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2415 Returns raw value from command line argument.
2417 Raw value parameters are in the form of "value" in a specific position in the list.
2419 If CheckPackage is NULL, then return NULL.
2421 @param[in] CheckPackage The package of parsed command line arguments.
2422 @param[in] Position The position of the value.
2424 @retval NULL The flag is not on the command line.
2425 @retval !=NULL The pointer to unicode string of the value.
2429 ShellCommandLineGetRawValue (
2430 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2437 // check for CheckPackage == NULL
2439 if (CheckPackage
== NULL
) {
2444 // enumerate through the list of parametrs
2446 for ( Node
= GetFirstNode(CheckPackage
)
2447 ; !IsNull (CheckPackage
, Node
)
2448 ; Node
= GetNextNode(CheckPackage
, Node
)
2451 // If the position matches, return the value
2453 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2454 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2461 returns the number of command line value parameters that were parsed.
2463 this will not include flags.
2465 @param[in] CheckPackage The package of parsed command line arguments.
2467 @retval (UINTN)-1 No parsing has ocurred
2468 @return other The number of value parameters found
2472 ShellCommandLineGetCount(
2473 IN CONST LIST_ENTRY
*CheckPackage
2479 if (CheckPackage
== NULL
) {
2482 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2483 ; !IsNull (CheckPackage
, Node1
)
2484 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2486 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2494 Determins if a parameter is duplicated.
2496 If Param is not NULL then it will point to a callee allocated string buffer
2497 with the parameter value if a duplicate is found.
2499 If CheckPackage is NULL, then ASSERT.
2501 @param[in] CheckPackage The package of parsed command line arguments.
2502 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2504 @retval EFI_SUCCESS No parameters were duplicated.
2505 @retval EFI_DEVICE_ERROR A duplicate was found.
2509 ShellCommandLineCheckDuplicate (
2510 IN CONST LIST_ENTRY
*CheckPackage
,
2517 ASSERT(CheckPackage
!= NULL
);
2519 for ( Node1
= GetFirstNode(CheckPackage
)
2520 ; !IsNull (CheckPackage
, Node1
)
2521 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2523 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2524 ; !IsNull (CheckPackage
, Node2
)
2525 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2527 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) {
2528 if (Param
!= NULL
) {
2530 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2532 return (EFI_DEVICE_ERROR
);
2536 return (EFI_SUCCESS
);
2540 This is a find and replace function. Upon successful return the NewString is a copy of
2541 SourceString with each instance of FindTarget replaced with ReplaceWith.
2543 If SourceString and NewString overlap the behavior is undefined.
2545 If the string would grow bigger than NewSize it will halt and return error.
2547 @param[in] SourceString The string with source buffer.
2548 @param[in, out] NewString The string with resultant buffer.
2549 @param[in] NewSize The size in bytes of NewString.
2550 @param[in] FindTarget The string to look for.
2551 @param[in] ReplaceWith The string to replace FindTarget with.
2552 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2553 immediately before it.
2554 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2556 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2557 @retval EFI_INVALID_PARAMETER NewString was NULL.
2558 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2559 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2560 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2561 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2562 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2563 the new string (truncation occurred).
2564 @retval EFI_SUCCESS The string was successfully copied with replacement.
2568 ShellCopySearchAndReplace(
2569 IN CHAR16 CONST
*SourceString
,
2570 IN OUT CHAR16
*NewString
,
2572 IN CONST CHAR16
*FindTarget
,
2573 IN CONST CHAR16
*ReplaceWith
,
2574 IN CONST BOOLEAN SkipPreCarrot
,
2575 IN CONST BOOLEAN ParameterReplacing
2581 if ( (SourceString
== NULL
)
2582 || (NewString
== NULL
)
2583 || (FindTarget
== NULL
)
2584 || (ReplaceWith
== NULL
)
2585 || (StrLen(FindTarget
) < 1)
2586 || (StrLen(SourceString
) < 1)
2588 return (EFI_INVALID_PARAMETER
);
2591 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2592 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2594 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2595 if (Replace
!= NULL
) {
2596 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2599 if (Replace
== NULL
) {
2600 return (EFI_OUT_OF_RESOURCES
);
2602 NewString
= ZeroMem(NewString
, NewSize
);
2603 while (*SourceString
!= CHAR_NULL
) {
2605 // if we find the FindTarget and either Skip == FALSE or Skip and we
2606 // dont have a carrot do a replace...
2608 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2609 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2611 SourceString
+= StrLen(FindTarget
);
2612 Size
= StrSize(NewString
);
2613 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2615 return (EFI_BUFFER_TOO_SMALL
);
2617 StrnCat(NewString
, Replace
, NewSize
/sizeof(CHAR16
) - 1 - StrLen(NewString
));
2619 Size
= StrSize(NewString
);
2620 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2622 return (EFI_BUFFER_TOO_SMALL
);
2624 StrnCat(NewString
, SourceString
, 1);
2629 return (EFI_SUCCESS
);
2633 Internal worker function to output a string.
2635 This function will output a string to the correct StdOut.
2637 @param[in] String The string to print out.
2639 @retval EFI_SUCCESS The operation was sucessful.
2640 @retval !EFI_SUCCESS The operation failed.
2645 IN CONST CHAR16
*String
2649 Size
= StrSize(String
) - sizeof(CHAR16
);
2651 return (EFI_SUCCESS
);
2653 if (gEfiShellParametersProtocol
!= NULL
) {
2654 return (gEfiShellProtocol
->WriteFile(gEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2656 if (mEfiShellInterface
!= NULL
) {
2657 if (mEfiShellInterface
->RedirArgc
== 0) {
2659 // Divide in half for old shell. Must be string length not size.
2661 Size
/=2; // Divide in half only when no redirection.
2663 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2666 return (EFI_UNSUPPORTED
);
2670 Print at a specific location on the screen.
2672 This function will move the cursor to a given screen location and print the specified string
2674 If -1 is specified for either the Row or Col the current screen location for BOTH
2677 if either Row or Col is out of range for the current console, then ASSERT
2678 if Format is NULL, then ASSERT
2680 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2681 the following additional flags:
2682 %N - Set output attribute to normal
2683 %H - Set output attribute to highlight
2684 %E - Set output attribute to error
2685 %B - Set output attribute to blue color
2686 %V - Set output attribute to green color
2688 Note: The background color is controlled by the shell command cls.
2690 @param[in] Col the column to print at
2691 @param[in] Row the row to print at
2692 @param[in] Format the format string
2693 @param[in] Marker the marker for the variable argument list
2695 @return EFI_SUCCESS The operation was successful.
2696 @return EFI_DEVICE_ERROR The console device reported an error.
2700 InternalShellPrintWorker(
2701 IN INT32 Col OPTIONAL
,
2702 IN INT32 Row OPTIONAL
,
2703 IN CONST CHAR16
*Format
,
2708 CHAR16
*ResumeLocation
;
2709 CHAR16
*FormatWalker
;
2710 UINTN OriginalAttribute
;
2711 CHAR16
*mPostReplaceFormat
;
2712 CHAR16
*mPostReplaceFormat2
;
2714 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2715 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2717 if (mPostReplaceFormat
== NULL
|| mPostReplaceFormat2
== NULL
) {
2718 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2719 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2720 return (EFI_OUT_OF_RESOURCES
);
2723 Status
= EFI_SUCCESS
;
2724 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2727 // Back and forth each time fixing up 1 of our flags...
2729 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2730 ASSERT_EFI_ERROR(Status
);
2731 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2732 ASSERT_EFI_ERROR(Status
);
2733 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2734 ASSERT_EFI_ERROR(Status
);
2735 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2736 ASSERT_EFI_ERROR(Status
);
2737 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2738 ASSERT_EFI_ERROR(Status
);
2741 // Use the last buffer from replacing to print from...
2743 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2745 if (Col
!= -1 && Row
!= -1) {
2746 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2749 FormatWalker
= mPostReplaceFormat2
;
2750 while (*FormatWalker
!= CHAR_NULL
) {
2752 // Find the next attribute change request
2754 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2755 if (ResumeLocation
!= NULL
) {
2756 *ResumeLocation
= CHAR_NULL
;
2759 // print the current FormatWalker string
2761 if (StrLen(FormatWalker
)>0) {
2762 Status
= InternalPrintTo(FormatWalker
);
2763 if (EFI_ERROR(Status
)) {
2769 // update the attribute
2771 if (ResumeLocation
!= NULL
) {
2772 if (*(ResumeLocation
-1) == L
'^') {
2774 // Move cursor back 1 position to overwrite the ^
2776 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gST
->ConOut
->Mode
->CursorColumn
- 1, gST
->ConOut
->Mode
->CursorRow
);
2779 // Print a simple '%' symbol
2781 Status
= InternalPrintTo(L
"%");
2782 ResumeLocation
= ResumeLocation
- 1;
2784 switch (*(ResumeLocation
+1)) {
2786 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2789 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2792 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2795 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2798 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2802 // Print a simple '%' symbol
2804 Status
= InternalPrintTo(L
"%");
2805 if (EFI_ERROR(Status
)) {
2808 ResumeLocation
= ResumeLocation
- 1;
2814 // reset to normal now...
2820 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2822 FormatWalker
= ResumeLocation
+ 2;
2825 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2827 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2828 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2833 Print at a specific location on the screen.
2835 This function will move the cursor to a given screen location and print the specified string.
2837 If -1 is specified for either the Row or Col the current screen location for BOTH
2840 If either Row or Col is out of range for the current console, then ASSERT.
2841 If Format is NULL, then ASSERT.
2843 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2844 the following additional flags:
2845 %N - Set output attribute to normal
2846 %H - Set output attribute to highlight
2847 %E - Set output attribute to error
2848 %B - Set output attribute to blue color
2849 %V - Set output attribute to green color
2851 Note: The background color is controlled by the shell command cls.
2853 @param[in] Col the column to print at
2854 @param[in] Row the row to print at
2855 @param[in] Format the format string
2856 @param[in] ... The variable argument list.
2858 @return EFI_SUCCESS The printing was successful.
2859 @return EFI_DEVICE_ERROR The console device reported an error.
2864 IN INT32 Col OPTIONAL
,
2865 IN INT32 Row OPTIONAL
,
2866 IN CONST CHAR16
*Format
,
2872 if (Format
== NULL
) {
2873 return (EFI_INVALID_PARAMETER
);
2875 VA_START (Marker
, Format
);
2876 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2882 Print at a specific location on the screen.
2884 This function will move the cursor to a given screen location and print the specified string.
2886 If -1 is specified for either the Row or Col the current screen location for BOTH
2889 If either Row or Col is out of range for the current console, then ASSERT.
2890 If Format is NULL, then ASSERT.
2892 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2893 the following additional flags:
2894 %N - Set output attribute to normal.
2895 %H - Set output attribute to highlight.
2896 %E - Set output attribute to error.
2897 %B - Set output attribute to blue color.
2898 %V - Set output attribute to green color.
2900 Note: The background color is controlled by the shell command cls.
2902 @param[in] Col The column to print at.
2903 @param[in] Row The row to print at.
2904 @param[in] Language The language of the string to retrieve. If this parameter
2905 is NULL, then the current platform language is used.
2906 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2907 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2908 @param[in] ... The variable argument list.
2910 @return EFI_SUCCESS The printing was successful.
2911 @return EFI_DEVICE_ERROR The console device reported an error.
2916 IN INT32 Col OPTIONAL
,
2917 IN INT32 Row OPTIONAL
,
2918 IN CONST CHAR8
*Language OPTIONAL
,
2919 IN CONST EFI_STRING_ID HiiFormatStringId
,
2920 IN CONST EFI_HANDLE HiiFormatHandle
,
2925 CHAR16
*HiiFormatString
;
2928 VA_START (Marker
, HiiFormatHandle
);
2929 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2930 ASSERT(HiiFormatString
!= NULL
);
2932 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2934 SHELL_FREE_NON_NULL(HiiFormatString
);
2941 Function to determine if a given filename represents a file or a directory.
2943 @param[in] DirName Path to directory to test.
2945 @retval EFI_SUCCESS The Path represents a directory
2946 @retval EFI_NOT_FOUND The Path does not represent a directory
2947 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2948 @return The path failed to open
2953 IN CONST CHAR16
*DirName
2957 SHELL_FILE_HANDLE Handle
;
2958 CHAR16
*TempLocation
;
2959 CHAR16
*TempLocation2
;
2961 ASSERT(DirName
!= NULL
);
2964 TempLocation
= NULL
;
2966 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
2967 if (EFI_ERROR(Status
)) {
2969 // try good logic first.
2971 if (gEfiShellProtocol
!= NULL
) {
2972 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
2973 if (TempLocation
== NULL
) {
2974 ShellCloseFile(&Handle
);
2975 return (EFI_OUT_OF_RESOURCES
);
2977 TempLocation2
= StrStr(TempLocation
, L
":");
2978 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
2979 *(TempLocation2
+1) = CHAR_NULL
;
2981 if (gEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
2982 FreePool(TempLocation
);
2983 return (EFI_SUCCESS
);
2985 FreePool(TempLocation
);
2988 // probably a map name?!?!!?
2990 TempLocation
= StrStr(DirName
, L
"\\");
2991 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
2992 return (EFI_SUCCESS
);
2998 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
2999 ShellCloseFile(&Handle
);
3000 return (EFI_SUCCESS
);
3002 ShellCloseFile(&Handle
);
3003 return (EFI_NOT_FOUND
);
3007 Function to determine if a given filename represents a file.
3009 @param[in] Name Path to file to test.
3011 @retval EFI_SUCCESS The Path represents a file.
3012 @retval EFI_NOT_FOUND The Path does not represent a file.
3013 @retval other The path failed to open.
3018 IN CONST CHAR16
*Name
3022 SHELL_FILE_HANDLE Handle
;
3024 ASSERT(Name
!= NULL
);
3028 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
3029 if (EFI_ERROR(Status
)) {
3033 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
3034 ShellCloseFile(&Handle
);
3035 return (EFI_SUCCESS
);
3037 ShellCloseFile(&Handle
);
3038 return (EFI_NOT_FOUND
);
3042 Function to determine if a given filename represents a file.
3044 This will search the CWD and then the Path.
3046 If Name is NULL, then ASSERT.
3048 @param[in] Name Path to file to test.
3050 @retval EFI_SUCCESS The Path represents a file.
3051 @retval EFI_NOT_FOUND The Path does not represent a file.
3052 @retval other The path failed to open.
3057 IN CONST CHAR16
*Name
3063 if (!EFI_ERROR(ShellIsFile(Name
))) {
3064 return (EFI_SUCCESS
);
3067 NewName
= ShellFindFilePath(Name
);
3068 if (NewName
== NULL
) {
3069 return (EFI_NOT_FOUND
);
3071 Status
= ShellIsFile(NewName
);
3077 Function return the number converted from a hex representation of a number.
3079 Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid
3080 result. Use ShellConvertStringToUint64 instead.
3082 @param[in] String String representation of a number.
3084 @return The unsigned integer result of the conversion.
3085 @retval (UINTN)(-1) An error occured.
3090 IN CONST CHAR16
*String
3095 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, TRUE
, TRUE
))) {
3096 return ((UINTN
)RetVal
);
3099 return ((UINTN
)(-1));
3103 Function to determine whether a string is decimal or hex representation of a number
3104 and return the number converted from the string. Spaces are always skipped.
3106 @param[in] String String representation of a number
3109 @retval (UINTN)(-1) An error ocurred.
3114 IN CONST CHAR16
*String
3122 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, TRUE
)) {
3126 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, Hex
, TRUE
))) {
3127 return ((UINTN
)RetVal
);
3129 return ((UINTN
)(-1));
3133 Safely append with automatic string resizing given length of Destination and
3134 desired length of copy from Source.
3136 append the first D characters of Source to the end of Destination, where D is
3137 the lesser of Count and the StrLen() of Source. If appending those D characters
3138 will fit within Destination (whose Size is given as CurrentSize) and
3139 still leave room for a NULL terminator, then those characters are appended,
3140 starting at the original terminating NULL of Destination, and a new terminating
3143 If appending D characters onto Destination will result in a overflow of the size
3144 given in CurrentSize the string will be grown such that the copy can be performed
3145 and CurrentSize will be updated to the new size.
3147 If Source is NULL, there is nothing to append, just return the current buffer in
3150 if Destination is NULL, then ASSERT()
3151 if Destination's current length (including NULL terminator) is already more then
3152 CurrentSize, then ASSERT()
3154 @param[in, out] Destination The String to append onto
3155 @param[in, out] CurrentSize on call the number of bytes in Destination. On
3156 return possibly the new size (still in bytes). if NULL
3157 then allocate whatever is needed.
3158 @param[in] Source The String to append from
3159 @param[in] Count Maximum number of characters to append. if 0 then
3162 @return Destination return the resultant string.
3167 IN OUT CHAR16
**Destination
,
3168 IN OUT UINTN
*CurrentSize
,
3169 IN CONST CHAR16
*Source
,
3173 UINTN DestinationStartSize
;
3179 ASSERT(Destination
!= NULL
);
3182 // If there's nothing to do then just return Destination
3184 if (Source
== NULL
) {
3185 return (*Destination
);
3189 // allow for un-initialized pointers, based on size being 0
3191 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
3192 *Destination
= NULL
;
3196 // allow for NULL pointers address as Destination
3198 if (*Destination
!= NULL
) {
3199 ASSERT(CurrentSize
!= 0);
3200 DestinationStartSize
= StrSize(*Destination
);
3201 ASSERT(DestinationStartSize
<= *CurrentSize
);
3203 DestinationStartSize
= 0;
3204 // ASSERT(*CurrentSize == 0);
3208 // Append all of Source?
3211 Count
= StrLen(Source
);
3215 // Test and grow if required
3217 if (CurrentSize
!= NULL
) {
3218 NewSize
= *CurrentSize
;
3219 if (NewSize
< DestinationStartSize
+ (Count
* sizeof(CHAR16
))) {
3220 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3221 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3223 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3224 *CurrentSize
= NewSize
;
3227 *Destination
= AllocateZeroPool((Count
+1)*sizeof(CHAR16
));
3231 // Now use standard StrnCat on a big enough buffer
3233 if (*Destination
== NULL
) {
3236 return StrnCat(*Destination
, Source
, Count
);
3240 Prompt the user and return the resultant answer to the requestor.
3242 This function will display the requested question on the shell prompt and then
3243 wait for an apropriate answer to be input from the console.
3245 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3246 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3248 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3251 In either case *Response must be callee freed if Response was not NULL;
3253 @param Type What type of question is asked. This is used to filter the input
3254 to prevent invalid answers to question.
3255 @param Prompt Pointer to string prompt to use to request input.
3256 @param Response Pointer to Response which will be populated upon return.
3258 @retval EFI_SUCCESS The operation was sucessful.
3259 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3260 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3261 @return other The operation failed.
3265 ShellPromptForResponse (
3266 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3267 IN CHAR16
*Prompt OPTIONAL
,
3268 IN OUT VOID
**Response OPTIONAL
3274 SHELL_PROMPT_RESPONSE
*Resp
;
3278 Status
= EFI_UNSUPPORTED
;
3282 if (Type
!= ShellPromptResponseTypeFreeform
) {
3283 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE
));
3285 return (EFI_OUT_OF_RESOURCES
);
3290 case ShellPromptResponseTypeQuitContinue
:
3291 if (Prompt
!= NULL
) {
3292 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3295 // wait for valid response
3297 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3298 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3299 if (EFI_ERROR(Status
)) {
3302 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3303 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3304 *Resp
= ShellPromptResponseQuit
;
3306 *Resp
= ShellPromptResponseContinue
;
3309 case ShellPromptResponseTypeYesNoCancel
:
3310 if (Prompt
!= NULL
) {
3311 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3314 // wait for valid response
3316 *Resp
= ShellPromptResponseMax
;
3317 while (*Resp
== ShellPromptResponseMax
) {
3318 if (ShellGetExecutionBreakFlag()) {
3319 Status
= EFI_ABORTED
;
3322 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3323 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3324 if (EFI_ERROR(Status
)) {
3327 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3328 switch (Key
.UnicodeChar
) {
3331 *Resp
= ShellPromptResponseYes
;
3335 *Resp
= ShellPromptResponseNo
;
3339 *Resp
= ShellPromptResponseCancel
;
3343 break; case ShellPromptResponseTypeYesNoAllCancel
:
3344 if (Prompt
!= NULL
) {
3345 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3348 // wait for valid response
3350 *Resp
= ShellPromptResponseMax
;
3351 while (*Resp
== ShellPromptResponseMax
) {
3352 if (ShellGetExecutionBreakFlag()) {
3353 Status
= EFI_ABORTED
;
3356 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3357 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3358 if (EFI_ERROR(Status
)) {
3361 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3362 switch (Key
.UnicodeChar
) {
3365 *Resp
= ShellPromptResponseYes
;
3369 *Resp
= ShellPromptResponseNo
;
3373 *Resp
= ShellPromptResponseAll
;
3377 *Resp
= ShellPromptResponseCancel
;
3382 case ShellPromptResponseTypeEnterContinue
:
3383 case ShellPromptResponseTypeAnyKeyContinue
:
3384 if (Prompt
!= NULL
) {
3385 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3388 // wait for valid response
3390 *Resp
= ShellPromptResponseMax
;
3391 while (*Resp
== ShellPromptResponseMax
) {
3392 if (ShellGetExecutionBreakFlag()) {
3393 Status
= EFI_ABORTED
;
3396 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3397 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3398 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3399 if (EFI_ERROR(Status
)) {
3402 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3403 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3404 *Resp
= ShellPromptResponseContinue
;
3408 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3409 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3410 ASSERT_EFI_ERROR(Status
);
3411 *Resp
= ShellPromptResponseContinue
;
3416 case ShellPromptResponseTypeYesNo
:
3417 if (Prompt
!= NULL
) {
3418 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3421 // wait for valid response
3423 *Resp
= ShellPromptResponseMax
;
3424 while (*Resp
== ShellPromptResponseMax
) {
3425 if (ShellGetExecutionBreakFlag()) {
3426 Status
= EFI_ABORTED
;
3429 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3430 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3431 if (EFI_ERROR(Status
)) {
3434 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3435 switch (Key
.UnicodeChar
) {
3438 *Resp
= ShellPromptResponseYes
;
3442 *Resp
= ShellPromptResponseNo
;
3447 case ShellPromptResponseTypeFreeform
:
3448 if (Prompt
!= NULL
) {
3449 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3452 if (ShellGetExecutionBreakFlag()) {
3453 Status
= EFI_ABORTED
;
3456 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3457 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3458 if (EFI_ERROR(Status
)) {
3461 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3462 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3465 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3466 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3470 // This is the location to add new prompt types.
3471 // If your new type loops remember to add ExecutionBreak support.
3477 if (Response
!= NULL
) {
3480 } else if (Buffer
!= NULL
) {
3487 if (Buffer
!= NULL
) {
3492 ShellPrintEx(-1, -1, L
"\r\n");
3497 Prompt the user and return the resultant answer to the requestor.
3499 This function is the same as ShellPromptForResponse, except that the prompt is
3500 automatically pulled from HII.
3502 @param Type What type of question is asked. This is used to filter the input
3503 to prevent invalid answers to question.
3504 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3505 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3506 @param Response Pointer to Response which will be populated upon return.
3508 @retval EFI_SUCCESS the operation was sucessful.
3509 @return other the operation failed.
3511 @sa ShellPromptForResponse
3515 ShellPromptForResponseHii (
3516 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3517 IN CONST EFI_STRING_ID HiiFormatStringId
,
3518 IN CONST EFI_HANDLE HiiFormatHandle
,
3519 IN OUT VOID
**Response
3525 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3526 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3532 Function to determin if an entire string is a valid number.
3534 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3536 @param[in] String The string to evaluate.
3537 @param[in] ForceHex TRUE - always assume hex.
3538 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3540 @retval TRUE It is all numeric (dec/hex) characters.
3541 @retval FALSE There is a non-numeric character.
3545 InternalShellIsHexOrDecimalNumber (
3546 IN CONST CHAR16
*String
,
3547 IN CONST BOOLEAN ForceHex
,
3548 IN CONST BOOLEAN StopAtSpace
3554 // chop off a single negative sign
3556 if (String
!= NULL
&& *String
== L
'-') {
3560 if (String
== NULL
) {
3565 // chop leading zeroes
3567 while(String
!= NULL
&& *String
== L
'0'){
3571 // allow '0x' or '0X', but not 'x' or 'X'
3573 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3574 if (*(String
-1) != L
'0') {
3576 // we got an x without a preceeding 0
3582 } else if (ForceHex
) {
3589 // loop through the remaining characters and use the lib function
3591 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3593 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3597 if (!ShellIsDecimalDigitCharacter(*String
)) {
3607 Function to determine if a given filename exists.
3609 @param[in] Name Path to test.
3611 @retval EFI_SUCCESS The Path represents a file.
3612 @retval EFI_NOT_FOUND The Path does not represent a file.
3613 @retval other The path failed to open.
3618 IN CONST CHAR16
*Name
3622 EFI_SHELL_FILE_INFO
*List
;
3624 ASSERT(Name
!= NULL
);
3627 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3628 if (EFI_ERROR(Status
)) {
3632 ShellCloseFileMetaArg(&List
);
3634 return (EFI_SUCCESS
);
3638 Convert a Unicode character to upper case only if
3639 it maps to a valid small-case ASCII character.
3641 This internal function only deal with Unicode character
3642 which maps to a valid small-case ASCII character, i.e.
3643 L'a' to L'z'. For other Unicode character, the input character
3644 is returned directly.
3646 @param Char The character to convert.
3648 @retval LowerCharacter If the Char is with range L'a' to L'z'.
3649 @retval Unchanged Otherwise.
3654 InternalShellCharToUpper (
3658 if (Char
>= L
'a' && Char
<= L
'z') {
3659 return (CHAR16
) (Char
- (L
'a' - L
'A'));
3666 Convert a Unicode character to numerical value.
3668 This internal function only deal with Unicode character
3669 which maps to a valid hexadecimal ASII character, i.e.
3670 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
3671 Unicode character, the value returned does not make sense.
3673 @param Char The character to convert.
3675 @return The numerical value converted.
3680 InternalShellHexCharToUintn (
3684 if (ShellIsDecimalDigitCharacter (Char
)) {
3688 return (UINTN
) (10 + InternalShellCharToUpper (Char
) - L
'A');
3692 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
3694 This function returns a value of type UINTN by interpreting the contents
3695 of the Unicode string specified by String as a hexadecimal number.
3696 The format of the input Unicode string String is:
3698 [spaces][zeros][x][hexadecimal digits].
3700 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
3701 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
3702 If "x" appears in the input string, it must be prefixed with at least one 0.
3703 The function will ignore the pad space, which includes spaces or tab characters,
3704 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
3705 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
3706 first valid hexadecimal digit. Then, the function stops at the first character that is
3707 a not a valid hexadecimal character or NULL, whichever one comes first.
3709 If String has only pad spaces, then zero is returned.
3710 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
3711 then zero is returned.
3713 @param[in] String A pointer to a Null-terminated Unicode string.
3714 @param[out] Value Upon a successful return the value of the conversion.
3715 @param[in] StopAtSpace FALSE to skip spaces.
3717 @retval EFI_SUCCESS The conversion was successful.
3718 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3719 @retval EFI_DEVICE_ERROR An overflow occured.
3723 InternalShellStrHexToUint64 (
3724 IN CONST CHAR16
*String
,
3726 IN CONST BOOLEAN StopAtSpace
3731 if (String
== NULL
|| StrSize(String
) == 0 || Value
== NULL
) {
3732 return (EFI_INVALID_PARAMETER
);
3736 // Ignore the pad spaces (space or tab)
3738 while ((*String
== L
' ') || (*String
== L
'\t')) {
3743 // Ignore leading Zeros after the spaces
3745 while (*String
== L
'0') {
3749 if (InternalShellCharToUpper (*String
) == L
'X') {
3750 if (*(String
- 1) != L
'0') {
3762 // Skip spaces if requested
3764 while (StopAtSpace
&& *String
== L
' ') {
3768 while (ShellIsHexaDecimalDigitCharacter (*String
)) {
3770 // If the Hex Number represented by String overflows according
3771 // to the range defined by UINTN, then ASSERT().
3773 if (!(Result
<= (RShiftU64((((UINT64
) ~0) - InternalShellHexCharToUintn (*String
)), 4)))) {
3774 // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {
3775 return (EFI_DEVICE_ERROR
);
3778 Result
= (LShiftU64(Result
, 4));
3779 Result
+= InternalShellHexCharToUintn (*String
);
3783 // stop at spaces if requested
3785 if (StopAtSpace
&& *String
== L
' ') {
3791 return (EFI_SUCCESS
);
3795 Convert a Null-terminated Unicode decimal string to a value of
3798 This function returns a value of type UINT64 by interpreting the contents
3799 of the Unicode string specified by String as a decimal number. The format
3800 of the input Unicode string String is:
3802 [spaces] [decimal digits].
3804 The valid decimal digit character is in the range [0-9]. The
3805 function will ignore the pad space, which includes spaces or
3806 tab characters, before [decimal digits]. The running zero in the
3807 beginning of [decimal digits] will be ignored. Then, the function
3808 stops at the first character that is a not a valid decimal character
3809 or a Null-terminator, whichever one comes first.
3811 If String has only pad spaces, then 0 is returned.
3812 If String has no pad spaces or valid decimal digits,
3815 @param[in] String A pointer to a Null-terminated Unicode string.
3816 @param[out] Value Upon a successful return the value of the conversion.
3817 @param[in] StopAtSpace FALSE to skip spaces.
3819 @retval EFI_SUCCESS The conversion was successful.
3820 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3821 @retval EFI_DEVICE_ERROR An overflow occured.
3825 InternalShellStrDecimalToUint64 (
3826 IN CONST CHAR16
*String
,
3828 IN CONST BOOLEAN StopAtSpace
3833 if (String
== NULL
|| StrSize (String
) == 0 || Value
== NULL
) {
3834 return (EFI_INVALID_PARAMETER
);
3838 // Ignore the pad spaces (space or tab)
3840 while ((*String
== L
' ') || (*String
== L
'\t')) {
3845 // Ignore leading Zeros after the spaces
3847 while (*String
== L
'0') {
3854 // Skip spaces if requested
3856 while (StopAtSpace
&& *String
== L
' ') {
3859 while (ShellIsDecimalDigitCharacter (*String
)) {
3861 // If the number represented by String overflows according
3862 // to the range defined by UINT64, then ASSERT().
3865 if (!(Result
<= (DivU64x32((((UINT64
) ~0) - (*String
- L
'0')),10)))) {
3866 return (EFI_DEVICE_ERROR
);
3869 Result
= MultU64x32(Result
, 10) + (*String
- L
'0');
3873 // Stop at spaces if requested
3875 if (StopAtSpace
&& *String
== L
' ') {
3882 return (EFI_SUCCESS
);
3886 Function to verify and convert a string to its numerical value.
3888 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
3890 @param[in] String The string to evaluate.
3891 @param[out] Value Upon a successful return the value of the conversion.
3892 @param[in] ForceHex TRUE - always assume hex.
3893 @param[in] StopAtSpace FALSE to skip spaces.
3895 @retval EFI_SUCCESS The conversion was successful.
3896 @retval EFI_INVALID_PARAMETER String contained an invalid character.
3897 @retval EFI_NOT_FOUND String was a number, but Value was NULL.
3901 ShellConvertStringToUint64(
3902 IN CONST CHAR16
*String
,
3904 IN CONST BOOLEAN ForceHex
,
3905 IN CONST BOOLEAN StopAtSpace
3909 CONST CHAR16
*Walker
;
3915 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3918 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3919 return (EFI_INVALID_PARAMETER
);
3922 return (EFI_INVALID_PARAMETER
);
3927 // Chop off leading spaces
3929 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
3932 // make sure we have something left that is numeric.
3934 if (Walker
== NULL
|| *Walker
== CHAR_NULL
|| !InternalShellIsHexOrDecimalNumber(Walker
, Hex
, StopAtSpace
)) {
3935 return (EFI_INVALID_PARAMETER
);
3939 // do the conversion.
3941 if (Hex
|| StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
3942 Status
= InternalShellStrHexToUint64(Walker
, &RetVal
, StopAtSpace
);
3944 Status
= InternalShellStrDecimalToUint64(Walker
, &RetVal
, StopAtSpace
);
3947 if (Value
== NULL
&& !EFI_ERROR(Status
)) {
3948 return (EFI_NOT_FOUND
);
3951 if (Value
!= NULL
) {
3959 Function to determin if an entire string is a valid number.
3961 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3963 @param[in] String The string to evaluate.
3964 @param[in] ForceHex TRUE - always assume hex.
3965 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3967 @retval TRUE It is all numeric (dec/hex) characters.
3968 @retval FALSE There is a non-numeric character.
3972 ShellIsHexOrDecimalNumber (
3973 IN CONST CHAR16
*String
,
3974 IN CONST BOOLEAN ForceHex
,
3975 IN CONST BOOLEAN StopAtSpace
3978 if (ShellConvertStringToUint64(String
, NULL
, ForceHex
, StopAtSpace
) == EFI_NOT_FOUND
) {
3985 Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned
3986 buffer. The returned buffer must be callee freed.
3988 If the position upon start is 0, then the Ascii Boolean will be set. This should be
3989 maintained and not changed for all operations with the same file.
3991 @param[in] Handle SHELL_FILE_HANDLE to read from.
3992 @param[in, out] Ascii Boolean value for indicating whether the file is
3993 Ascii (TRUE) or UCS2 (FALSE).
3995 @return The line of text from the file.
3996 @retval NULL There was not enough memory available.
3998 @sa ShellFileHandleReadLine
4002 ShellFileHandleReturnLine(
4003 IN SHELL_FILE_HANDLE Handle
,
4004 IN OUT BOOLEAN
*Ascii
4014 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
4015 if (Status
== EFI_BUFFER_TOO_SMALL
) {
4016 RetVal
= AllocateZeroPool(Size
);
4017 if (RetVal
== NULL
) {
4020 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
4023 if (EFI_ERROR(Status
) && (RetVal
!= NULL
)) {
4031 Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.
4033 If the position upon start is 0, then the Ascii Boolean will be set. This should be
4034 maintained and not changed for all operations with the same file.
4036 @param[in] Handle SHELL_FILE_HANDLE to read from.
4037 @param[in, out] Buffer The pointer to buffer to read into.
4038 @param[in, out] Size The pointer to number of bytes in Buffer.
4039 @param[in] Truncate If the buffer is large enough, this has no effect.
4040 If the buffer is is too small and Truncate is TRUE,
4041 the line will be truncated.
4042 If the buffer is is too small and Truncate is FALSE,
4043 then no read will occur.
4045 @param[in, out] Ascii Boolean value for indicating whether the file is
4046 Ascii (TRUE) or UCS2 (FALSE).
4048 @retval EFI_SUCCESS The operation was successful. The line is stored in
4050 @retval EFI_INVALID_PARAMETER Handle was NULL.
4051 @retval EFI_INVALID_PARAMETER Size was NULL.
4052 @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.
4053 Size was updated to the minimum space required.
4057 ShellFileHandleReadLine(
4058 IN SHELL_FILE_HANDLE Handle
,
4059 IN OUT CHAR16
*Buffer
,
4061 IN BOOLEAN Truncate
,
4062 IN OUT BOOLEAN
*Ascii
4069 UINT64 OriginalFilePosition
;
4075 return (EFI_INVALID_PARAMETER
);
4077 if (Buffer
== NULL
) {
4080 *Buffer
= CHAR_NULL
;
4082 gEfiShellProtocol
->GetFilePosition(Handle
, &OriginalFilePosition
);
4083 if (OriginalFilePosition
== 0) {
4084 CharSize
= sizeof(CHAR16
);
4085 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4086 ASSERT_EFI_ERROR(Status
);
4087 if (CharBuffer
== gUnicodeFileTag
) {
4091 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4095 for (CountSoFar
= 0;;CountSoFar
++){
4098 CharSize
= sizeof(CHAR8
);
4100 CharSize
= sizeof(CHAR16
);
4102 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4103 if ( EFI_ERROR(Status
)
4105 || (CharBuffer
== L
'\n' && !(*Ascii
))
4106 || (CharBuffer
== '\n' && *Ascii
)
4111 // if we have space save it...
4113 if ((CountSoFar
+1)*sizeof(CHAR16
) < *Size
){
4114 ASSERT(Buffer
!= NULL
);
4115 ((CHAR16
*)Buffer
)[CountSoFar
] = CharBuffer
;
4116 ((CHAR16
*)Buffer
)[CountSoFar
+1] = CHAR_NULL
;
4121 // if we ran out of space tell when...
4123 if ((CountSoFar
+1)*sizeof(CHAR16
) > *Size
){
4124 *Size
= (CountSoFar
+1)*sizeof(CHAR16
);
4126 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4128 DEBUG((DEBUG_WARN
, "The line was truncated in ShellFileHandleReadLine"));
4130 return (EFI_BUFFER_TOO_SMALL
);
4132 while(Buffer
[StrLen(Buffer
)-1] == L
'\r') {
4133 Buffer
[StrLen(Buffer
)-1] = CHAR_NULL
;
4140 Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
4142 @param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.
4143 @param[in] SectionToGetHelpOn Pointer to the section specifier(s).
4144 @param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints
4145 the help content only.
4146 @retval EFI_DEVICE_ERROR The help data format was incorrect.
4147 @retval EFI_NOT_FOUND The help data could not be found.
4148 @retval EFI_SUCCESS The operation was successful.
4153 IN CONST CHAR16
*CommandToGetHelpOn
,
4154 IN CONST CHAR16
*SectionToGetHelpOn
,
4155 IN BOOLEAN PrintCommandText
4164 // Get the string to print based
4166 Status
= gEfiShellProtocol
->GetHelpText (CommandToGetHelpOn
, SectionToGetHelpOn
, &OutText
);
4169 // make sure we got a valid string
4171 if (EFI_ERROR(Status
)){
4174 if (OutText
== NULL
|| StrLen(OutText
) == 0) {
4175 return EFI_NOT_FOUND
;
4179 // Chop off trailing stuff we dont need
4181 while (OutText
[StrLen(OutText
)-1] == L
'\r' || OutText
[StrLen(OutText
)-1] == L
'\n' || OutText
[StrLen(OutText
)-1] == L
' ') {
4182 OutText
[StrLen(OutText
)-1] = CHAR_NULL
;
4186 // Print this out to the console
4188 if (PrintCommandText
) {
4189 ShellPrintEx(-1, -1, L
"%H%-14s%N- %s\r\n", CommandToGetHelpOn
, OutText
);
4191 ShellPrintEx(-1, -1, L
"%N%s\r\n", OutText
);
4194 SHELL_FREE_NON_NULL(OutText
);
4200 Function to delete a file by name
4202 @param[in] FileName Pointer to file name to delete.
4204 @retval EFI_SUCCESS the file was deleted sucessfully
4205 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
4207 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
4208 @retval EFI_NOT_FOUND The specified file could not be found on the
4209 device or the file system could not be found
4211 @retval EFI_NO_MEDIA The device has no medium.
4212 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
4213 medium is no longer supported.
4214 @retval EFI_DEVICE_ERROR The device reported an error.
4215 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4216 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
4217 @retval EFI_ACCESS_DENIED The file was opened read only.
4218 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
4220 @retval other The file failed to open
4224 ShellDeleteFileByName(
4225 IN CONST CHAR16
*FileName
4229 SHELL_FILE_HANDLE FileHandle
;
4231 Status
= ShellFileExists(FileName
);
4233 if (Status
== EFI_SUCCESS
){
4234 Status
= ShellOpenFileByName(FileName
, &FileHandle
, EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
, 0x0);
4235 if (Status
== EFI_SUCCESS
){
4236 Status
= ShellDeleteFile(&FileHandle
);