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
;
1497 CHAR16
*CleanFilePathStr
;
1500 // ASSERT that Arg and ListHead are not NULL
1502 ASSERT(Arg
!= NULL
);
1503 ASSERT(ListHead
!= NULL
);
1505 Status
= InternalShellStripQuotes (Arg
, &CleanFilePathStr
);
1506 if (EFI_ERROR (Status
)) {
1511 // Check for UEFI Shell 2.0 protocols
1513 if (gEfiShellProtocol
!= NULL
) {
1514 if (*ListHead
== NULL
) {
1515 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1516 if (*ListHead
== NULL
) {
1517 FreePool(CleanFilePathStr
);
1518 return (EFI_OUT_OF_RESOURCES
);
1520 InitializeListHead(&((*ListHead
)->Link
));
1522 Status
= gEfiShellProtocol
->OpenFileList(CleanFilePathStr
,
1525 if (EFI_ERROR(Status
)) {
1526 gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1528 Status
= gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1530 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1531 FreePool(*ListHead
);
1532 FreePool(CleanFilePathStr
);
1534 return (EFI_NOT_FOUND
);
1536 FreePool(CleanFilePathStr
);
1541 // Check for EFI shell
1543 if (mEfiShellEnvironment2
!= NULL
) {
1545 // make sure the list head is initialized
1547 InitializeListHead(&mOldStyleFileList
);
1550 // Get the EFI Shell list of files
1552 Status
= mEfiShellEnvironment2
->FileMetaArg(CleanFilePathStr
, &mOldStyleFileList
);
1553 if (EFI_ERROR(Status
)) {
1555 FreePool(CleanFilePathStr
);
1559 if (*ListHead
== NULL
) {
1560 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1561 if (*ListHead
== NULL
) {
1562 FreePool(CleanFilePathStr
);
1563 return (EFI_OUT_OF_RESOURCES
);
1565 InitializeListHead(&((*ListHead
)->Link
));
1569 // Convert that to equivalent of UEFI Shell 2.0 structure
1571 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1574 // Free the EFI Shell version that was converted.
1576 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1578 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1579 FreePool(*ListHead
);
1581 Status
= EFI_NOT_FOUND
;
1583 FreePool(CleanFilePathStr
);
1587 FreePool(CleanFilePathStr
);
1588 return (EFI_UNSUPPORTED
);
1591 Free the linked list returned from ShellOpenFileMetaArg.
1593 if ListHead is NULL then ASSERT().
1595 @param ListHead the pointer to free.
1597 @retval EFI_SUCCESS the operation was sucessful.
1601 ShellCloseFileMetaArg (
1602 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1608 // ASSERT that ListHead is not NULL
1610 ASSERT(ListHead
!= NULL
);
1613 // Check for UEFI Shell 2.0 protocols
1615 if (gEfiShellProtocol
!= NULL
) {
1616 return (gEfiShellProtocol
->FreeFileList(ListHead
));
1617 } else if (mEfiShellEnvironment2
!= NULL
) {
1619 // Since this is EFI Shell version we need to free our internally made copy
1622 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1623 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1624 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1625 RemoveEntryList(Node
);
1626 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1627 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1628 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1629 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1630 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1632 SHELL_FREE_NON_NULL(*ListHead
);
1636 return (EFI_UNSUPPORTED
);
1640 Find a file by searching the CWD and then the path.
1642 If FileName is NULL then ASSERT.
1644 If the return value is not NULL then the memory must be caller freed.
1646 @param FileName Filename string.
1648 @retval NULL the file was not found
1649 @return !NULL the full path to the file.
1654 IN CONST CHAR16
*FileName
1658 SHELL_FILE_HANDLE Handle
;
1662 CONST CHAR16
*Walker
;
1669 // First make sure its not an absolute path.
1671 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1672 if (!EFI_ERROR(Status
)){
1673 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1674 ASSERT(RetVal
== NULL
);
1675 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1676 ShellCloseFile(&Handle
);
1679 ShellCloseFile(&Handle
);
1683 Path
= ShellGetEnvironmentVariable(L
"cwd");
1685 Size
= StrSize(Path
);
1686 Size
+= StrSize(FileName
);
1687 TestPath
= AllocateZeroPool(Size
);
1688 if (TestPath
== NULL
) {
1691 StrnCpy(TestPath
, Path
, Size
/sizeof(CHAR16
) - 1);
1692 StrnCat(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1693 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1694 if (!EFI_ERROR(Status
)){
1695 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1696 ASSERT(RetVal
== NULL
);
1697 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1698 ShellCloseFile(&Handle
);
1702 ShellCloseFile(&Handle
);
1707 Path
= ShellGetEnvironmentVariable(L
"path");
1709 Size
= StrSize(Path
)+sizeof(CHAR16
);
1710 Size
+= StrSize(FileName
);
1711 TestPath
= AllocateZeroPool(Size
);
1712 if (TestPath
== NULL
) {
1715 Walker
= (CHAR16
*)Path
;
1717 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1718 if (TestPath
!= NULL
) {
1719 TempChar
= StrStr(TestPath
, L
";");
1720 if (TempChar
!= NULL
) {
1721 *TempChar
= CHAR_NULL
;
1723 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1724 StrnCat(TestPath
, L
"\\", Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1726 if (FileName
[0] == L
'\\') {
1729 StrnCat(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1730 if (StrStr(Walker
, L
";") != NULL
) {
1731 Walker
= StrStr(Walker
, L
";") + 1;
1735 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1736 if (!EFI_ERROR(Status
)){
1737 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1738 ASSERT(RetVal
== NULL
);
1739 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1740 ShellCloseFile(&Handle
);
1743 ShellCloseFile(&Handle
);
1747 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1754 Find a file by searching the CWD and then the path with a variable set of file
1755 extensions. If the file is not found it will append each extension in the list
1756 in the order provided and return the first one that is successful.
1758 If FileName is NULL, then ASSERT.
1759 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1761 If the return value is not NULL then the memory must be caller freed.
1763 @param[in] FileName Filename string.
1764 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1766 @retval NULL The file was not found.
1767 @retval !NULL The path to the file.
1771 ShellFindFilePathEx (
1772 IN CONST CHAR16
*FileName
,
1773 IN CONST CHAR16
*FileExtension
1778 CONST CHAR16
*ExtensionWalker
;
1783 ASSERT(FileName
!= NULL
);
1784 if (FileExtension
== NULL
) {
1785 return (ShellFindFilePath(FileName
));
1787 RetVal
= ShellFindFilePath(FileName
);
1788 if (RetVal
!= NULL
) {
1791 Size
= StrSize(FileName
);
1792 Size
+= StrSize(FileExtension
);
1793 TestPath
= AllocateZeroPool(Size
);
1794 if (TestPath
== NULL
) {
1797 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1798 StrnCpy(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1);
1799 if (ExtensionWalker
!= NULL
) {
1800 StrnCat(TestPath
, ExtensionWalker
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1802 TempChar
= StrStr(TestPath
, L
";");
1803 if (TempChar
!= NULL
) {
1804 *TempChar
= CHAR_NULL
;
1806 RetVal
= ShellFindFilePath(TestPath
);
1807 if (RetVal
!= NULL
) {
1810 ASSERT(ExtensionWalker
!= NULL
);
1811 TempChar2
= StrStr(ExtensionWalker
, L
";");
1820 SHELL_PARAM_TYPE Type
;
1822 UINTN OriginalPosition
;
1823 } SHELL_PARAM_PACKAGE
;
1826 Checks the list of valid arguments and returns TRUE if the item was found. If the
1827 return value is TRUE then the type parameter is set also.
1829 if CheckList is NULL then ASSERT();
1830 if Name is NULL then ASSERT();
1831 if Type is NULL then ASSERT();
1833 @param Name pointer to Name of parameter found
1834 @param CheckList List to check against
1835 @param Type pointer to type of parameter if it was found
1837 @retval TRUE the Parameter was found. Type is valid.
1838 @retval FALSE the Parameter was not found. Type is not valid.
1842 InternalIsOnCheckList (
1843 IN CONST CHAR16
*Name
,
1844 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1845 OUT SHELL_PARAM_TYPE
*Type
1848 SHELL_PARAM_ITEM
*TempListItem
;
1852 // ASSERT that all 3 pointer parameters aren't NULL
1854 ASSERT(CheckList
!= NULL
);
1855 ASSERT(Type
!= NULL
);
1856 ASSERT(Name
!= NULL
);
1859 // question mark and page break mode are always supported
1861 if ((StrCmp(Name
, L
"-?") == 0) ||
1862 (StrCmp(Name
, L
"-b") == 0)
1869 // Enumerate through the list
1871 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1873 // If the Type is TypeStart only check the first characters of the passed in param
1874 // If it matches set the type and return TRUE
1876 if (TempListItem
->Type
== TypeStart
) {
1877 if (StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1878 *Type
= TempListItem
->Type
;
1882 TempString
= StrnCatGrow(&TempString
, NULL
, Name
, StrLen(TempListItem
->Name
));
1883 if (TempString
!= NULL
) {
1884 if (StringNoCaseCompare(&TempString
, &TempListItem
->Name
) == 0) {
1885 *Type
= TempListItem
->Type
;
1886 FreePool(TempString
);
1889 FreePool(TempString
);
1891 } else if (StringNoCaseCompare(&Name
, &TempListItem
->Name
) == 0) {
1892 *Type
= TempListItem
->Type
;
1900 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1902 @param[in] Name pointer to Name of parameter found
1903 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1905 @retval TRUE the Parameter is a flag.
1906 @retval FALSE the Parameter not a flag.
1911 IN CONST CHAR16
*Name
,
1912 IN BOOLEAN AlwaysAllowNumbers
1916 // ASSERT that Name isn't NULL
1918 ASSERT(Name
!= NULL
);
1921 // If we accept numbers then dont return TRUE. (they will be values)
1923 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && InternalShellIsHexOrDecimalNumber(Name
+1, FALSE
, FALSE
)) && AlwaysAllowNumbers
) {
1928 // If the Name has a /, +, or - as the first character return TRUE
1930 if ((Name
[0] == L
'/') ||
1931 (Name
[0] == L
'-') ||
1940 Checks the command line arguments passed against the list of valid ones.
1942 If no initialization is required, then return RETURN_SUCCESS.
1944 @param[in] CheckList pointer to list of parameters to check
1945 @param[out] CheckPackage pointer to pointer to list checked values
1946 @param[out] ProblemParam optional pointer to pointer to unicode string for
1947 the paramater that caused failure. If used then the
1948 caller is responsible for freeing the memory.
1949 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1950 @param[in] Argv pointer to array of parameters
1951 @param[in] Argc Count of parameters in Argv
1952 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1954 @retval EFI_SUCCESS The operation completed sucessfully.
1955 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1956 @retval EFI_INVALID_PARAMETER A parameter was invalid
1957 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1958 duplicated. the duplicated command line argument
1959 was returned in ProblemParam if provided.
1960 @retval EFI_NOT_FOUND a argument required a value that was missing.
1961 the invalid command line argument was returned in
1962 ProblemParam if provided.
1966 InternalCommandLineParse (
1967 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1968 OUT LIST_ENTRY
**CheckPackage
,
1969 OUT CHAR16
**ProblemParam OPTIONAL
,
1970 IN BOOLEAN AutoPageBreak
,
1971 IN CONST CHAR16
**Argv
,
1973 IN BOOLEAN AlwaysAllowNumbers
1977 SHELL_PARAM_TYPE CurrentItemType
;
1978 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
1982 CONST CHAR16
*TempPointer
;
1983 UINTN CurrentValueSize
;
1985 CurrentItemPackage
= NULL
;
1991 // If there is only 1 item we dont need to do anything
1994 *CheckPackage
= NULL
;
1995 return (EFI_SUCCESS
);
2001 ASSERT(CheckList
!= NULL
);
2002 ASSERT(Argv
!= NULL
);
2005 // initialize the linked list
2007 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
2008 if (*CheckPackage
== NULL
) {
2009 return (EFI_OUT_OF_RESOURCES
);
2012 InitializeListHead(*CheckPackage
);
2015 // loop through each of the arguments
2017 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
2018 if (Argv
[LoopCounter
] == NULL
) {
2020 // do nothing for NULL argv
2022 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
2024 // We might have leftover if last parameter didnt have optional value
2026 if (GetItemValue
!= 0) {
2028 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2033 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2034 if (CurrentItemPackage
== NULL
) {
2035 ShellCommandLineFreeVarList(*CheckPackage
);
2036 *CheckPackage
= NULL
;
2037 return (EFI_OUT_OF_RESOURCES
);
2039 CurrentItemPackage
->Name
= AllocateCopyPool(StrSize(Argv
[LoopCounter
]), Argv
[LoopCounter
]);
2040 if (CurrentItemPackage
->Name
== NULL
) {
2041 ShellCommandLineFreeVarList(*CheckPackage
);
2042 *CheckPackage
= NULL
;
2043 return (EFI_OUT_OF_RESOURCES
);
2045 CurrentItemPackage
->Type
= CurrentItemType
;
2046 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
2047 CurrentItemPackage
->Value
= NULL
;
2050 // Does this flag require a value
2052 switch (CurrentItemPackage
->Type
) {
2054 // possibly trigger the next loop(s) to populate the value of this item
2060 case TypeDoubleValue
:
2065 GetItemValue
= (UINTN
)(-1);
2070 // this item has no value expected; we are done
2072 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2073 ASSERT(GetItemValue
== 0);
2076 } else if (GetItemValue
!= 0 && !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
)) {
2077 ASSERT(CurrentItemPackage
!= NULL
);
2079 // get the item VALUE for a previous flag
2081 if (StrStr(Argv
[LoopCounter
], L
" ") == NULL
) {
2082 CurrentValueSize
= ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2083 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, CurrentValueSize
, CurrentItemPackage
->Value
);
2084 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2085 if (ValueSize
== 0) {
2086 StrnCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1);
2088 StrnCat(CurrentItemPackage
->Value
, L
" ", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2089 StrnCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2091 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2094 // the parameter has spaces. must be quoted.
2096 CurrentValueSize
= ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
) + sizeof(CHAR16
) + sizeof(CHAR16
);
2097 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, CurrentValueSize
, CurrentItemPackage
->Value
);
2098 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2099 if (ValueSize
== 0) {
2100 StrnCpy(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1);
2101 StrnCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2102 StrnCat(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2104 StrnCat(CurrentItemPackage
->Value
, L
" ", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2105 StrnCat(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2106 StrnCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2107 StrnCat(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2109 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2112 if (GetItemValue
== 0) {
2113 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2115 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
) ){ //|| ProblemParam == NULL) {
2117 // add this one as a non-flag
2120 TempPointer
= Argv
[LoopCounter
];
2121 if ((*TempPointer
== L
'^' && *(TempPointer
+1) == L
'-')
2122 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'/')
2123 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'+')
2127 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2128 if (CurrentItemPackage
== NULL
) {
2129 ShellCommandLineFreeVarList(*CheckPackage
);
2130 *CheckPackage
= NULL
;
2131 return (EFI_OUT_OF_RESOURCES
);
2133 CurrentItemPackage
->Name
= NULL
;
2134 CurrentItemPackage
->Type
= TypePosition
;
2135 CurrentItemPackage
->Value
= AllocateCopyPool(StrSize(TempPointer
), TempPointer
);
2136 if (CurrentItemPackage
->Value
== NULL
) {
2137 ShellCommandLineFreeVarList(*CheckPackage
);
2138 *CheckPackage
= NULL
;
2139 return (EFI_OUT_OF_RESOURCES
);
2141 CurrentItemPackage
->OriginalPosition
= Count
++;
2142 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2145 // this was a non-recognised flag... error!
2147 if (ProblemParam
!= NULL
) {
2148 *ProblemParam
= AllocateCopyPool(StrSize(Argv
[LoopCounter
]), Argv
[LoopCounter
]);
2150 ShellCommandLineFreeVarList(*CheckPackage
);
2151 *CheckPackage
= NULL
;
2152 return (EFI_VOLUME_CORRUPTED
);
2155 if (GetItemValue
!= 0) {
2157 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2160 // support for AutoPageBreak
2162 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2163 ShellSetPageBreakMode(TRUE
);
2165 return (EFI_SUCCESS
);
2169 Checks the command line arguments passed against the list of valid ones.
2170 Optionally removes NULL values first.
2172 If no initialization is required, then return RETURN_SUCCESS.
2174 @param[in] CheckList The pointer to list of parameters to check.
2175 @param[out] CheckPackage The package of checked values.
2176 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2177 the paramater that caused failure.
2178 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2179 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2181 @retval EFI_SUCCESS The operation completed sucessfully.
2182 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2183 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2184 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2185 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2186 of the command line arguments was returned in
2187 ProblemParam if provided.
2188 @retval EFI_NOT_FOUND A argument required a value that was missing.
2189 The invalid command line argument was returned in
2190 ProblemParam if provided.
2194 ShellCommandLineParseEx (
2195 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2196 OUT LIST_ENTRY
**CheckPackage
,
2197 OUT CHAR16
**ProblemParam OPTIONAL
,
2198 IN BOOLEAN AutoPageBreak
,
2199 IN BOOLEAN AlwaysAllowNumbers
2203 // ASSERT that CheckList and CheckPackage aren't NULL
2205 ASSERT(CheckList
!= NULL
);
2206 ASSERT(CheckPackage
!= NULL
);
2209 // Check for UEFI Shell 2.0 protocols
2211 if (gEfiShellParametersProtocol
!= NULL
) {
2212 return (InternalCommandLineParse(CheckList
,
2216 (CONST CHAR16
**) gEfiShellParametersProtocol
->Argv
,
2217 gEfiShellParametersProtocol
->Argc
,
2218 AlwaysAllowNumbers
));
2222 // ASSERT That EFI Shell is not required
2224 ASSERT (mEfiShellInterface
!= NULL
);
2225 return (InternalCommandLineParse(CheckList
,
2229 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2230 mEfiShellInterface
->Argc
,
2231 AlwaysAllowNumbers
));
2235 Frees shell variable list that was returned from ShellCommandLineParse.
2237 This function will free all the memory that was used for the CheckPackage
2238 list of postprocessed shell arguments.
2240 this function has no return value.
2242 if CheckPackage is NULL, then return
2244 @param CheckPackage the list to de-allocate
2248 ShellCommandLineFreeVarList (
2249 IN LIST_ENTRY
*CheckPackage
2255 // check for CheckPackage == NULL
2257 if (CheckPackage
== NULL
) {
2262 // for each node in the list
2264 for ( Node
= GetFirstNode(CheckPackage
)
2265 ; !IsListEmpty(CheckPackage
)
2266 ; Node
= GetFirstNode(CheckPackage
)
2269 // Remove it from the list
2271 RemoveEntryList(Node
);
2274 // if it has a name free the name
2276 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2277 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2281 // if it has a value free the value
2283 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2284 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2288 // free the node structure
2290 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2293 // free the list head node
2295 FreePool(CheckPackage
);
2298 Checks for presence of a flag parameter
2300 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2302 if CheckPackage is NULL then return FALSE.
2303 if KeyString is NULL then ASSERT()
2305 @param CheckPackage The package of parsed command line arguments
2306 @param KeyString the Key of the command line argument to check for
2308 @retval TRUE the flag is on the command line
2309 @retval FALSE the flag is not on the command line
2313 ShellCommandLineGetFlag (
2314 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2315 IN CONST CHAR16
* CONST KeyString
2322 // return FALSE for no package or KeyString is NULL
2324 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2329 // enumerate through the list of parametrs
2331 for ( Node
= GetFirstNode(CheckPackage
)
2332 ; !IsNull (CheckPackage
, Node
)
2333 ; Node
= GetNextNode(CheckPackage
, Node
)
2336 // If the Name matches, return TRUE (and there may be NULL name)
2338 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2340 // If Type is TypeStart then only compare the begining of the strings
2342 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2343 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2347 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2348 if (TempString
!= NULL
) {
2349 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2350 FreePool(TempString
);
2353 FreePool(TempString
);
2355 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2363 Returns value from command line argument.
2365 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2367 If CheckPackage is NULL, then return NULL.
2369 @param[in] CheckPackage The package of parsed command line arguments.
2370 @param[in] KeyString The Key of the command line argument to check for.
2372 @retval NULL The flag is not on the command line.
2373 @retval !=NULL The pointer to unicode string of the value.
2377 ShellCommandLineGetValue (
2378 IN CONST LIST_ENTRY
*CheckPackage
,
2379 IN CHAR16
*KeyString
2386 // return NULL for no package or KeyString is NULL
2388 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2393 // enumerate through the list of parametrs
2395 for ( Node
= GetFirstNode(CheckPackage
)
2396 ; !IsNull (CheckPackage
, Node
)
2397 ; Node
= GetNextNode(CheckPackage
, Node
)
2400 // If the Name matches, return TRUE (and there may be NULL name)
2402 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2404 // If Type is TypeStart then only compare the begining of the strings
2406 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2407 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2408 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2411 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2412 if (TempString
!= NULL
) {
2413 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2414 FreePool(TempString
);
2415 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2417 FreePool(TempString
);
2419 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2420 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2428 Returns raw value from command line argument.
2430 Raw value parameters are in the form of "value" in a specific position in the list.
2432 If CheckPackage is NULL, then return NULL.
2434 @param[in] CheckPackage The package of parsed command line arguments.
2435 @param[in] Position The position of the value.
2437 @retval NULL The flag is not on the command line.
2438 @retval !=NULL The pointer to unicode string of the value.
2442 ShellCommandLineGetRawValue (
2443 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2450 // check for CheckPackage == NULL
2452 if (CheckPackage
== NULL
) {
2457 // enumerate through the list of parametrs
2459 for ( Node
= GetFirstNode(CheckPackage
)
2460 ; !IsNull (CheckPackage
, Node
)
2461 ; Node
= GetNextNode(CheckPackage
, Node
)
2464 // If the position matches, return the value
2466 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2467 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2474 returns the number of command line value parameters that were parsed.
2476 this will not include flags.
2478 @param[in] CheckPackage The package of parsed command line arguments.
2480 @retval (UINTN)-1 No parsing has ocurred
2481 @return other The number of value parameters found
2485 ShellCommandLineGetCount(
2486 IN CONST LIST_ENTRY
*CheckPackage
2492 if (CheckPackage
== NULL
) {
2495 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2496 ; !IsNull (CheckPackage
, Node1
)
2497 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2499 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2507 Determins if a parameter is duplicated.
2509 If Param is not NULL then it will point to a callee allocated string buffer
2510 with the parameter value if a duplicate is found.
2512 If CheckPackage is NULL, then ASSERT.
2514 @param[in] CheckPackage The package of parsed command line arguments.
2515 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2517 @retval EFI_SUCCESS No parameters were duplicated.
2518 @retval EFI_DEVICE_ERROR A duplicate was found.
2522 ShellCommandLineCheckDuplicate (
2523 IN CONST LIST_ENTRY
*CheckPackage
,
2530 ASSERT(CheckPackage
!= NULL
);
2532 for ( Node1
= GetFirstNode(CheckPackage
)
2533 ; !IsNull (CheckPackage
, Node1
)
2534 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2536 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2537 ; !IsNull (CheckPackage
, Node2
)
2538 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2540 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) {
2541 if (Param
!= NULL
) {
2543 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2545 return (EFI_DEVICE_ERROR
);
2549 return (EFI_SUCCESS
);
2553 This is a find and replace function. Upon successful return the NewString is a copy of
2554 SourceString with each instance of FindTarget replaced with ReplaceWith.
2556 If SourceString and NewString overlap the behavior is undefined.
2558 If the string would grow bigger than NewSize it will halt and return error.
2560 @param[in] SourceString The string with source buffer.
2561 @param[in, out] NewString The string with resultant buffer.
2562 @param[in] NewSize The size in bytes of NewString.
2563 @param[in] FindTarget The string to look for.
2564 @param[in] ReplaceWith The string to replace FindTarget with.
2565 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2566 immediately before it.
2567 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2569 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2570 @retval EFI_INVALID_PARAMETER NewString was NULL.
2571 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2572 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2573 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2574 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2575 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2576 the new string (truncation occurred).
2577 @retval EFI_SUCCESS The string was successfully copied with replacement.
2581 ShellCopySearchAndReplace(
2582 IN CHAR16 CONST
*SourceString
,
2583 IN OUT CHAR16
*NewString
,
2585 IN CONST CHAR16
*FindTarget
,
2586 IN CONST CHAR16
*ReplaceWith
,
2587 IN CONST BOOLEAN SkipPreCarrot
,
2588 IN CONST BOOLEAN ParameterReplacing
2594 if ( (SourceString
== NULL
)
2595 || (NewString
== NULL
)
2596 || (FindTarget
== NULL
)
2597 || (ReplaceWith
== NULL
)
2598 || (StrLen(FindTarget
) < 1)
2599 || (StrLen(SourceString
) < 1)
2601 return (EFI_INVALID_PARAMETER
);
2604 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2605 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2607 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2608 if (Replace
!= NULL
) {
2609 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2612 if (Replace
== NULL
) {
2613 return (EFI_OUT_OF_RESOURCES
);
2615 NewString
= ZeroMem(NewString
, NewSize
);
2616 while (*SourceString
!= CHAR_NULL
) {
2618 // if we find the FindTarget and either Skip == FALSE or Skip and we
2619 // dont have a carrot do a replace...
2621 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2622 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2624 SourceString
+= StrLen(FindTarget
);
2625 Size
= StrSize(NewString
);
2626 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2628 return (EFI_BUFFER_TOO_SMALL
);
2630 StrnCat(NewString
, Replace
, NewSize
/sizeof(CHAR16
) - 1 - StrLen(NewString
));
2632 Size
= StrSize(NewString
);
2633 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2635 return (EFI_BUFFER_TOO_SMALL
);
2637 StrnCat(NewString
, SourceString
, 1);
2642 return (EFI_SUCCESS
);
2646 Internal worker function to output a string.
2648 This function will output a string to the correct StdOut.
2650 @param[in] String The string to print out.
2652 @retval EFI_SUCCESS The operation was sucessful.
2653 @retval !EFI_SUCCESS The operation failed.
2658 IN CONST CHAR16
*String
2662 Size
= StrSize(String
) - sizeof(CHAR16
);
2664 return (EFI_SUCCESS
);
2666 if (gEfiShellParametersProtocol
!= NULL
) {
2667 return (gEfiShellProtocol
->WriteFile(gEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2669 if (mEfiShellInterface
!= NULL
) {
2670 if (mEfiShellInterface
->RedirArgc
== 0) {
2672 // Divide in half for old shell. Must be string length not size.
2674 Size
/=2; // Divide in half only when no redirection.
2676 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2679 return (EFI_UNSUPPORTED
);
2683 Print at a specific location on the screen.
2685 This function will move the cursor to a given screen location and print the specified string
2687 If -1 is specified for either the Row or Col the current screen location for BOTH
2690 if either Row or Col is out of range for the current console, then ASSERT
2691 if Format is NULL, then ASSERT
2693 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2694 the following additional flags:
2695 %N - Set output attribute to normal
2696 %H - Set output attribute to highlight
2697 %E - Set output attribute to error
2698 %B - Set output attribute to blue color
2699 %V - Set output attribute to green color
2701 Note: The background color is controlled by the shell command cls.
2703 @param[in] Col the column to print at
2704 @param[in] Row the row to print at
2705 @param[in] Format the format string
2706 @param[in] Marker the marker for the variable argument list
2708 @return EFI_SUCCESS The operation was successful.
2709 @return EFI_DEVICE_ERROR The console device reported an error.
2713 InternalShellPrintWorker(
2714 IN INT32 Col OPTIONAL
,
2715 IN INT32 Row OPTIONAL
,
2716 IN CONST CHAR16
*Format
,
2721 CHAR16
*ResumeLocation
;
2722 CHAR16
*FormatWalker
;
2723 UINTN OriginalAttribute
;
2724 CHAR16
*mPostReplaceFormat
;
2725 CHAR16
*mPostReplaceFormat2
;
2727 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2728 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2730 if (mPostReplaceFormat
== NULL
|| mPostReplaceFormat2
== NULL
) {
2731 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2732 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2733 return (EFI_OUT_OF_RESOURCES
);
2736 Status
= EFI_SUCCESS
;
2737 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2740 // Back and forth each time fixing up 1 of our flags...
2742 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2743 ASSERT_EFI_ERROR(Status
);
2744 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2745 ASSERT_EFI_ERROR(Status
);
2746 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2747 ASSERT_EFI_ERROR(Status
);
2748 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2749 ASSERT_EFI_ERROR(Status
);
2750 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2751 ASSERT_EFI_ERROR(Status
);
2754 // Use the last buffer from replacing to print from...
2756 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2758 if (Col
!= -1 && Row
!= -1) {
2759 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2762 FormatWalker
= mPostReplaceFormat2
;
2763 while (*FormatWalker
!= CHAR_NULL
) {
2765 // Find the next attribute change request
2767 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2768 if (ResumeLocation
!= NULL
) {
2769 *ResumeLocation
= CHAR_NULL
;
2772 // print the current FormatWalker string
2774 if (StrLen(FormatWalker
)>0) {
2775 Status
= InternalPrintTo(FormatWalker
);
2776 if (EFI_ERROR(Status
)) {
2782 // update the attribute
2784 if (ResumeLocation
!= NULL
) {
2785 if (*(ResumeLocation
-1) == L
'^') {
2787 // Move cursor back 1 position to overwrite the ^
2789 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gST
->ConOut
->Mode
->CursorColumn
- 1, gST
->ConOut
->Mode
->CursorRow
);
2792 // Print a simple '%' symbol
2794 Status
= InternalPrintTo(L
"%");
2795 ResumeLocation
= ResumeLocation
- 1;
2797 switch (*(ResumeLocation
+1)) {
2799 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2802 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2805 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2808 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2811 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2815 // Print a simple '%' symbol
2817 Status
= InternalPrintTo(L
"%");
2818 if (EFI_ERROR(Status
)) {
2821 ResumeLocation
= ResumeLocation
- 1;
2827 // reset to normal now...
2833 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2835 FormatWalker
= ResumeLocation
+ 2;
2838 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2840 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2841 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2846 Print at a specific location on the screen.
2848 This function will move the cursor to a given screen location and print the specified string.
2850 If -1 is specified for either the Row or Col the current screen location for BOTH
2853 If either Row or Col is out of range for the current console, then ASSERT.
2854 If Format is NULL, then ASSERT.
2856 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2857 the following additional flags:
2858 %N - Set output attribute to normal
2859 %H - Set output attribute to highlight
2860 %E - Set output attribute to error
2861 %B - Set output attribute to blue color
2862 %V - Set output attribute to green color
2864 Note: The background color is controlled by the shell command cls.
2866 @param[in] Col the column to print at
2867 @param[in] Row the row to print at
2868 @param[in] Format the format string
2869 @param[in] ... The variable argument list.
2871 @return EFI_SUCCESS The printing was successful.
2872 @return EFI_DEVICE_ERROR The console device reported an error.
2877 IN INT32 Col OPTIONAL
,
2878 IN INT32 Row OPTIONAL
,
2879 IN CONST CHAR16
*Format
,
2885 if (Format
== NULL
) {
2886 return (EFI_INVALID_PARAMETER
);
2888 VA_START (Marker
, Format
);
2889 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2895 Print at a specific location on the screen.
2897 This function will move the cursor to a given screen location and print the specified string.
2899 If -1 is specified for either the Row or Col the current screen location for BOTH
2902 If either Row or Col is out of range for the current console, then ASSERT.
2903 If Format is NULL, then ASSERT.
2905 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2906 the following additional flags:
2907 %N - Set output attribute to normal.
2908 %H - Set output attribute to highlight.
2909 %E - Set output attribute to error.
2910 %B - Set output attribute to blue color.
2911 %V - Set output attribute to green color.
2913 Note: The background color is controlled by the shell command cls.
2915 @param[in] Col The column to print at.
2916 @param[in] Row The row to print at.
2917 @param[in] Language The language of the string to retrieve. If this parameter
2918 is NULL, then the current platform language is used.
2919 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2920 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2921 @param[in] ... The variable argument list.
2923 @return EFI_SUCCESS The printing was successful.
2924 @return EFI_DEVICE_ERROR The console device reported an error.
2929 IN INT32 Col OPTIONAL
,
2930 IN INT32 Row OPTIONAL
,
2931 IN CONST CHAR8
*Language OPTIONAL
,
2932 IN CONST EFI_STRING_ID HiiFormatStringId
,
2933 IN CONST EFI_HANDLE HiiFormatHandle
,
2938 CHAR16
*HiiFormatString
;
2941 VA_START (Marker
, HiiFormatHandle
);
2942 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2943 ASSERT(HiiFormatString
!= NULL
);
2945 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2947 SHELL_FREE_NON_NULL(HiiFormatString
);
2954 Function to determine if a given filename represents a file or a directory.
2956 @param[in] DirName Path to directory to test.
2958 @retval EFI_SUCCESS The Path represents a directory
2959 @retval EFI_NOT_FOUND The Path does not represent a directory
2960 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2961 @return The path failed to open
2966 IN CONST CHAR16
*DirName
2970 SHELL_FILE_HANDLE Handle
;
2971 CHAR16
*TempLocation
;
2972 CHAR16
*TempLocation2
;
2974 ASSERT(DirName
!= NULL
);
2977 TempLocation
= NULL
;
2979 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
2980 if (EFI_ERROR(Status
)) {
2982 // try good logic first.
2984 if (gEfiShellProtocol
!= NULL
) {
2985 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
2986 if (TempLocation
== NULL
) {
2987 ShellCloseFile(&Handle
);
2988 return (EFI_OUT_OF_RESOURCES
);
2990 TempLocation2
= StrStr(TempLocation
, L
":");
2991 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
2992 *(TempLocation2
+1) = CHAR_NULL
;
2994 if (gEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
2995 FreePool(TempLocation
);
2996 return (EFI_SUCCESS
);
2998 FreePool(TempLocation
);
3001 // probably a map name?!?!!?
3003 TempLocation
= StrStr(DirName
, L
"\\");
3004 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
3005 return (EFI_SUCCESS
);
3011 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
3012 ShellCloseFile(&Handle
);
3013 return (EFI_SUCCESS
);
3015 ShellCloseFile(&Handle
);
3016 return (EFI_NOT_FOUND
);
3020 Function to determine if a given filename represents a file.
3022 @param[in] Name Path to file to test.
3024 @retval EFI_SUCCESS The Path represents a file.
3025 @retval EFI_NOT_FOUND The Path does not represent a file.
3026 @retval other The path failed to open.
3031 IN CONST CHAR16
*Name
3035 SHELL_FILE_HANDLE Handle
;
3037 ASSERT(Name
!= NULL
);
3041 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
3042 if (EFI_ERROR(Status
)) {
3046 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
3047 ShellCloseFile(&Handle
);
3048 return (EFI_SUCCESS
);
3050 ShellCloseFile(&Handle
);
3051 return (EFI_NOT_FOUND
);
3055 Function to determine if a given filename represents a file.
3057 This will search the CWD and then the Path.
3059 If Name is NULL, then ASSERT.
3061 @param[in] Name Path to file to test.
3063 @retval EFI_SUCCESS The Path represents a file.
3064 @retval EFI_NOT_FOUND The Path does not represent a file.
3065 @retval other The path failed to open.
3070 IN CONST CHAR16
*Name
3076 if (!EFI_ERROR(ShellIsFile(Name
))) {
3077 return (EFI_SUCCESS
);
3080 NewName
= ShellFindFilePath(Name
);
3081 if (NewName
== NULL
) {
3082 return (EFI_NOT_FOUND
);
3084 Status
= ShellIsFile(NewName
);
3090 Function return the number converted from a hex representation of a number.
3092 Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid
3093 result. Use ShellConvertStringToUint64 instead.
3095 @param[in] String String representation of a number.
3097 @return The unsigned integer result of the conversion.
3098 @retval (UINTN)(-1) An error occured.
3103 IN CONST CHAR16
*String
3108 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, TRUE
, TRUE
))) {
3109 return ((UINTN
)RetVal
);
3112 return ((UINTN
)(-1));
3116 Function to determine whether a string is decimal or hex representation of a number
3117 and return the number converted from the string. Spaces are always skipped.
3119 @param[in] String String representation of a number
3122 @retval (UINTN)(-1) An error ocurred.
3127 IN CONST CHAR16
*String
3135 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, TRUE
)) {
3139 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, Hex
, TRUE
))) {
3140 return ((UINTN
)RetVal
);
3142 return ((UINTN
)(-1));
3146 Safely append with automatic string resizing given length of Destination and
3147 desired length of copy from Source.
3149 append the first D characters of Source to the end of Destination, where D is
3150 the lesser of Count and the StrLen() of Source. If appending those D characters
3151 will fit within Destination (whose Size is given as CurrentSize) and
3152 still leave room for a NULL terminator, then those characters are appended,
3153 starting at the original terminating NULL of Destination, and a new terminating
3156 If appending D characters onto Destination will result in a overflow of the size
3157 given in CurrentSize the string will be grown such that the copy can be performed
3158 and CurrentSize will be updated to the new size.
3160 If Source is NULL, there is nothing to append, just return the current buffer in
3163 if Destination is NULL, then ASSERT()
3164 if Destination's current length (including NULL terminator) is already more then
3165 CurrentSize, then ASSERT()
3167 @param[in, out] Destination The String to append onto
3168 @param[in, out] CurrentSize on call the number of bytes in Destination. On
3169 return possibly the new size (still in bytes). if NULL
3170 then allocate whatever is needed.
3171 @param[in] Source The String to append from
3172 @param[in] Count Maximum number of characters to append. if 0 then
3175 @return Destination return the resultant string.
3180 IN OUT CHAR16
**Destination
,
3181 IN OUT UINTN
*CurrentSize
,
3182 IN CONST CHAR16
*Source
,
3186 UINTN DestinationStartSize
;
3192 ASSERT(Destination
!= NULL
);
3195 // If there's nothing to do then just return Destination
3197 if (Source
== NULL
) {
3198 return (*Destination
);
3202 // allow for un-initialized pointers, based on size being 0
3204 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
3205 *Destination
= NULL
;
3209 // allow for NULL pointers address as Destination
3211 if (*Destination
!= NULL
) {
3212 ASSERT(CurrentSize
!= 0);
3213 DestinationStartSize
= StrSize(*Destination
);
3214 ASSERT(DestinationStartSize
<= *CurrentSize
);
3216 DestinationStartSize
= 0;
3217 // ASSERT(*CurrentSize == 0);
3221 // Append all of Source?
3224 Count
= StrLen(Source
);
3228 // Test and grow if required
3230 if (CurrentSize
!= NULL
) {
3231 NewSize
= *CurrentSize
;
3232 if (NewSize
< DestinationStartSize
+ (Count
* sizeof(CHAR16
))) {
3233 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3234 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3236 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3237 *CurrentSize
= NewSize
;
3240 *Destination
= AllocateZeroPool((Count
+1)*sizeof(CHAR16
));
3244 // Now use standard StrnCat on a big enough buffer
3246 if (*Destination
== NULL
) {
3249 return StrnCat(*Destination
, Source
, Count
);
3253 Prompt the user and return the resultant answer to the requestor.
3255 This function will display the requested question on the shell prompt and then
3256 wait for an apropriate answer to be input from the console.
3258 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3259 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3261 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3264 In either case *Response must be callee freed if Response was not NULL;
3266 @param Type What type of question is asked. This is used to filter the input
3267 to prevent invalid answers to question.
3268 @param Prompt Pointer to string prompt to use to request input.
3269 @param Response Pointer to Response which will be populated upon return.
3271 @retval EFI_SUCCESS The operation was sucessful.
3272 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3273 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3274 @return other The operation failed.
3278 ShellPromptForResponse (
3279 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3280 IN CHAR16
*Prompt OPTIONAL
,
3281 IN OUT VOID
**Response OPTIONAL
3287 SHELL_PROMPT_RESPONSE
*Resp
;
3291 Status
= EFI_UNSUPPORTED
;
3295 if (Type
!= ShellPromptResponseTypeFreeform
) {
3296 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE
));
3298 return (EFI_OUT_OF_RESOURCES
);
3303 case ShellPromptResponseTypeQuitContinue
:
3304 if (Prompt
!= NULL
) {
3305 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3308 // wait for valid response
3310 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3311 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3312 if (EFI_ERROR(Status
)) {
3315 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3316 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3317 *Resp
= ShellPromptResponseQuit
;
3319 *Resp
= ShellPromptResponseContinue
;
3322 case ShellPromptResponseTypeYesNoCancel
:
3323 if (Prompt
!= NULL
) {
3324 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3327 // wait for valid response
3329 *Resp
= ShellPromptResponseMax
;
3330 while (*Resp
== ShellPromptResponseMax
) {
3331 if (ShellGetExecutionBreakFlag()) {
3332 Status
= EFI_ABORTED
;
3335 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3336 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3337 if (EFI_ERROR(Status
)) {
3340 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3341 switch (Key
.UnicodeChar
) {
3344 *Resp
= ShellPromptResponseYes
;
3348 *Resp
= ShellPromptResponseNo
;
3352 *Resp
= ShellPromptResponseCancel
;
3356 break; case ShellPromptResponseTypeYesNoAllCancel
:
3357 if (Prompt
!= NULL
) {
3358 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3361 // wait for valid response
3363 *Resp
= ShellPromptResponseMax
;
3364 while (*Resp
== ShellPromptResponseMax
) {
3365 if (ShellGetExecutionBreakFlag()) {
3366 Status
= EFI_ABORTED
;
3369 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3370 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3371 if (EFI_ERROR(Status
)) {
3374 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3375 switch (Key
.UnicodeChar
) {
3378 *Resp
= ShellPromptResponseYes
;
3382 *Resp
= ShellPromptResponseNo
;
3386 *Resp
= ShellPromptResponseAll
;
3390 *Resp
= ShellPromptResponseCancel
;
3395 case ShellPromptResponseTypeEnterContinue
:
3396 case ShellPromptResponseTypeAnyKeyContinue
:
3397 if (Prompt
!= NULL
) {
3398 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3401 // wait for valid response
3403 *Resp
= ShellPromptResponseMax
;
3404 while (*Resp
== ShellPromptResponseMax
) {
3405 if (ShellGetExecutionBreakFlag()) {
3406 Status
= EFI_ABORTED
;
3409 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3410 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3411 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3412 if (EFI_ERROR(Status
)) {
3415 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3416 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3417 *Resp
= ShellPromptResponseContinue
;
3421 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3422 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3423 ASSERT_EFI_ERROR(Status
);
3424 *Resp
= ShellPromptResponseContinue
;
3429 case ShellPromptResponseTypeYesNo
:
3430 if (Prompt
!= NULL
) {
3431 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3434 // wait for valid response
3436 *Resp
= ShellPromptResponseMax
;
3437 while (*Resp
== ShellPromptResponseMax
) {
3438 if (ShellGetExecutionBreakFlag()) {
3439 Status
= EFI_ABORTED
;
3442 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3443 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3444 if (EFI_ERROR(Status
)) {
3447 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3448 switch (Key
.UnicodeChar
) {
3451 *Resp
= ShellPromptResponseYes
;
3455 *Resp
= ShellPromptResponseNo
;
3460 case ShellPromptResponseTypeFreeform
:
3461 if (Prompt
!= NULL
) {
3462 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3465 if (ShellGetExecutionBreakFlag()) {
3466 Status
= EFI_ABORTED
;
3469 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3470 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3471 if (EFI_ERROR(Status
)) {
3474 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3475 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3478 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3479 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3483 // This is the location to add new prompt types.
3484 // If your new type loops remember to add ExecutionBreak support.
3490 if (Response
!= NULL
) {
3493 } else if (Buffer
!= NULL
) {
3500 if (Buffer
!= NULL
) {
3505 ShellPrintEx(-1, -1, L
"\r\n");
3510 Prompt the user and return the resultant answer to the requestor.
3512 This function is the same as ShellPromptForResponse, except that the prompt is
3513 automatically pulled from HII.
3515 @param Type What type of question is asked. This is used to filter the input
3516 to prevent invalid answers to question.
3517 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3518 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3519 @param Response Pointer to Response which will be populated upon return.
3521 @retval EFI_SUCCESS the operation was sucessful.
3522 @return other the operation failed.
3524 @sa ShellPromptForResponse
3528 ShellPromptForResponseHii (
3529 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3530 IN CONST EFI_STRING_ID HiiFormatStringId
,
3531 IN CONST EFI_HANDLE HiiFormatHandle
,
3532 IN OUT VOID
**Response
3538 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3539 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3545 Function to determin if an entire string is a valid number.
3547 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3549 @param[in] String The string to evaluate.
3550 @param[in] ForceHex TRUE - always assume hex.
3551 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3553 @retval TRUE It is all numeric (dec/hex) characters.
3554 @retval FALSE There is a non-numeric character.
3558 InternalShellIsHexOrDecimalNumber (
3559 IN CONST CHAR16
*String
,
3560 IN CONST BOOLEAN ForceHex
,
3561 IN CONST BOOLEAN StopAtSpace
3567 // chop off a single negative sign
3569 if (String
!= NULL
&& *String
== L
'-') {
3573 if (String
== NULL
) {
3578 // chop leading zeroes
3580 while(String
!= NULL
&& *String
== L
'0'){
3584 // allow '0x' or '0X', but not 'x' or 'X'
3586 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3587 if (*(String
-1) != L
'0') {
3589 // we got an x without a preceeding 0
3595 } else if (ForceHex
) {
3602 // loop through the remaining characters and use the lib function
3604 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3606 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3610 if (!ShellIsDecimalDigitCharacter(*String
)) {
3620 Function to determine if a given filename exists.
3622 @param[in] Name Path to test.
3624 @retval EFI_SUCCESS The Path represents a file.
3625 @retval EFI_NOT_FOUND The Path does not represent a file.
3626 @retval other The path failed to open.
3631 IN CONST CHAR16
*Name
3635 EFI_SHELL_FILE_INFO
*List
;
3637 ASSERT(Name
!= NULL
);
3640 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3641 if (EFI_ERROR(Status
)) {
3645 ShellCloseFileMetaArg(&List
);
3647 return (EFI_SUCCESS
);
3651 Convert a Unicode character to upper case only if
3652 it maps to a valid small-case ASCII character.
3654 This internal function only deal with Unicode character
3655 which maps to a valid small-case ASCII character, i.e.
3656 L'a' to L'z'. For other Unicode character, the input character
3657 is returned directly.
3659 @param Char The character to convert.
3661 @retval LowerCharacter If the Char is with range L'a' to L'z'.
3662 @retval Unchanged Otherwise.
3667 InternalShellCharToUpper (
3671 if (Char
>= L
'a' && Char
<= L
'z') {
3672 return (CHAR16
) (Char
- (L
'a' - L
'A'));
3679 Convert a Unicode character to numerical value.
3681 This internal function only deal with Unicode character
3682 which maps to a valid hexadecimal ASII character, i.e.
3683 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
3684 Unicode character, the value returned does not make sense.
3686 @param Char The character to convert.
3688 @return The numerical value converted.
3693 InternalShellHexCharToUintn (
3697 if (ShellIsDecimalDigitCharacter (Char
)) {
3701 return (UINTN
) (10 + InternalShellCharToUpper (Char
) - L
'A');
3705 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
3707 This function returns a value of type UINTN by interpreting the contents
3708 of the Unicode string specified by String as a hexadecimal number.
3709 The format of the input Unicode string String is:
3711 [spaces][zeros][x][hexadecimal digits].
3713 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
3714 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
3715 If "x" appears in the input string, it must be prefixed with at least one 0.
3716 The function will ignore the pad space, which includes spaces or tab characters,
3717 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
3718 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
3719 first valid hexadecimal digit. Then, the function stops at the first character that is
3720 a not a valid hexadecimal character or NULL, whichever one comes first.
3722 If String has only pad spaces, then zero is returned.
3723 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
3724 then zero is returned.
3726 @param[in] String A pointer to a Null-terminated Unicode string.
3727 @param[out] Value Upon a successful return the value of the conversion.
3728 @param[in] StopAtSpace FALSE to skip spaces.
3730 @retval EFI_SUCCESS The conversion was successful.
3731 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3732 @retval EFI_DEVICE_ERROR An overflow occured.
3736 InternalShellStrHexToUint64 (
3737 IN CONST CHAR16
*String
,
3739 IN CONST BOOLEAN StopAtSpace
3744 if (String
== NULL
|| StrSize(String
) == 0 || Value
== NULL
) {
3745 return (EFI_INVALID_PARAMETER
);
3749 // Ignore the pad spaces (space or tab)
3751 while ((*String
== L
' ') || (*String
== L
'\t')) {
3756 // Ignore leading Zeros after the spaces
3758 while (*String
== L
'0') {
3762 if (InternalShellCharToUpper (*String
) == L
'X') {
3763 if (*(String
- 1) != L
'0') {
3775 // Skip spaces if requested
3777 while (StopAtSpace
&& *String
== L
' ') {
3781 while (ShellIsHexaDecimalDigitCharacter (*String
)) {
3783 // If the Hex Number represented by String overflows according
3784 // to the range defined by UINTN, then ASSERT().
3786 if (!(Result
<= (RShiftU64((((UINT64
) ~0) - InternalShellHexCharToUintn (*String
)), 4)))) {
3787 // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {
3788 return (EFI_DEVICE_ERROR
);
3791 Result
= (LShiftU64(Result
, 4));
3792 Result
+= InternalShellHexCharToUintn (*String
);
3796 // stop at spaces if requested
3798 if (StopAtSpace
&& *String
== L
' ') {
3804 return (EFI_SUCCESS
);
3808 Convert a Null-terminated Unicode decimal string to a value of
3811 This function returns a value of type UINT64 by interpreting the contents
3812 of the Unicode string specified by String as a decimal number. The format
3813 of the input Unicode string String is:
3815 [spaces] [decimal digits].
3817 The valid decimal digit character is in the range [0-9]. The
3818 function will ignore the pad space, which includes spaces or
3819 tab characters, before [decimal digits]. The running zero in the
3820 beginning of [decimal digits] will be ignored. Then, the function
3821 stops at the first character that is a not a valid decimal character
3822 or a Null-terminator, whichever one comes first.
3824 If String has only pad spaces, then 0 is returned.
3825 If String has no pad spaces or valid decimal digits,
3828 @param[in] String A pointer to a Null-terminated Unicode string.
3829 @param[out] Value Upon a successful return the value of the conversion.
3830 @param[in] StopAtSpace FALSE to skip spaces.
3832 @retval EFI_SUCCESS The conversion was successful.
3833 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3834 @retval EFI_DEVICE_ERROR An overflow occured.
3838 InternalShellStrDecimalToUint64 (
3839 IN CONST CHAR16
*String
,
3841 IN CONST BOOLEAN StopAtSpace
3846 if (String
== NULL
|| StrSize (String
) == 0 || Value
== NULL
) {
3847 return (EFI_INVALID_PARAMETER
);
3851 // Ignore the pad spaces (space or tab)
3853 while ((*String
== L
' ') || (*String
== L
'\t')) {
3858 // Ignore leading Zeros after the spaces
3860 while (*String
== L
'0') {
3867 // Skip spaces if requested
3869 while (StopAtSpace
&& *String
== L
' ') {
3872 while (ShellIsDecimalDigitCharacter (*String
)) {
3874 // If the number represented by String overflows according
3875 // to the range defined by UINT64, then ASSERT().
3878 if (!(Result
<= (DivU64x32((((UINT64
) ~0) - (*String
- L
'0')),10)))) {
3879 return (EFI_DEVICE_ERROR
);
3882 Result
= MultU64x32(Result
, 10) + (*String
- L
'0');
3886 // Stop at spaces if requested
3888 if (StopAtSpace
&& *String
== L
' ') {
3895 return (EFI_SUCCESS
);
3899 Function to verify and convert a string to its numerical value.
3901 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
3903 @param[in] String The string to evaluate.
3904 @param[out] Value Upon a successful return the value of the conversion.
3905 @param[in] ForceHex TRUE - always assume hex.
3906 @param[in] StopAtSpace FALSE to skip spaces.
3908 @retval EFI_SUCCESS The conversion was successful.
3909 @retval EFI_INVALID_PARAMETER String contained an invalid character.
3910 @retval EFI_NOT_FOUND String was a number, but Value was NULL.
3914 ShellConvertStringToUint64(
3915 IN CONST CHAR16
*String
,
3917 IN CONST BOOLEAN ForceHex
,
3918 IN CONST BOOLEAN StopAtSpace
3922 CONST CHAR16
*Walker
;
3928 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3931 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3932 return (EFI_INVALID_PARAMETER
);
3935 return (EFI_INVALID_PARAMETER
);
3940 // Chop off leading spaces
3942 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
3945 // make sure we have something left that is numeric.
3947 if (Walker
== NULL
|| *Walker
== CHAR_NULL
|| !InternalShellIsHexOrDecimalNumber(Walker
, Hex
, StopAtSpace
)) {
3948 return (EFI_INVALID_PARAMETER
);
3952 // do the conversion.
3954 if (Hex
|| StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
3955 Status
= InternalShellStrHexToUint64(Walker
, &RetVal
, StopAtSpace
);
3957 Status
= InternalShellStrDecimalToUint64(Walker
, &RetVal
, StopAtSpace
);
3960 if (Value
== NULL
&& !EFI_ERROR(Status
)) {
3961 return (EFI_NOT_FOUND
);
3964 if (Value
!= NULL
) {
3972 Function to determin if an entire string is a valid number.
3974 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3976 @param[in] String The string to evaluate.
3977 @param[in] ForceHex TRUE - always assume hex.
3978 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3980 @retval TRUE It is all numeric (dec/hex) characters.
3981 @retval FALSE There is a non-numeric character.
3985 ShellIsHexOrDecimalNumber (
3986 IN CONST CHAR16
*String
,
3987 IN CONST BOOLEAN ForceHex
,
3988 IN CONST BOOLEAN StopAtSpace
3991 if (ShellConvertStringToUint64(String
, NULL
, ForceHex
, StopAtSpace
) == EFI_NOT_FOUND
) {
3998 Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned
3999 buffer. The returned buffer must be callee freed.
4001 If the position upon start is 0, then the Ascii Boolean will be set. This should be
4002 maintained and not changed for all operations with the same file.
4004 @param[in] Handle SHELL_FILE_HANDLE to read from.
4005 @param[in, out] Ascii Boolean value for indicating whether the file is
4006 Ascii (TRUE) or UCS2 (FALSE).
4008 @return The line of text from the file.
4009 @retval NULL There was not enough memory available.
4011 @sa ShellFileHandleReadLine
4015 ShellFileHandleReturnLine(
4016 IN SHELL_FILE_HANDLE Handle
,
4017 IN OUT BOOLEAN
*Ascii
4027 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
4028 if (Status
== EFI_BUFFER_TOO_SMALL
) {
4029 RetVal
= AllocateZeroPool(Size
);
4030 if (RetVal
== NULL
) {
4033 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
4036 if (EFI_ERROR(Status
) && (RetVal
!= NULL
)) {
4044 Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.
4046 If the position upon start is 0, then the Ascii Boolean will be set. This should be
4047 maintained and not changed for all operations with the same file.
4049 @param[in] Handle SHELL_FILE_HANDLE to read from.
4050 @param[in, out] Buffer The pointer to buffer to read into.
4051 @param[in, out] Size The pointer to number of bytes in Buffer.
4052 @param[in] Truncate If the buffer is large enough, this has no effect.
4053 If the buffer is is too small and Truncate is TRUE,
4054 the line will be truncated.
4055 If the buffer is is too small and Truncate is FALSE,
4056 then no read will occur.
4058 @param[in, out] Ascii Boolean value for indicating whether the file is
4059 Ascii (TRUE) or UCS2 (FALSE).
4061 @retval EFI_SUCCESS The operation was successful. The line is stored in
4063 @retval EFI_INVALID_PARAMETER Handle was NULL.
4064 @retval EFI_INVALID_PARAMETER Size was NULL.
4065 @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.
4066 Size was updated to the minimum space required.
4070 ShellFileHandleReadLine(
4071 IN SHELL_FILE_HANDLE Handle
,
4072 IN OUT CHAR16
*Buffer
,
4074 IN BOOLEAN Truncate
,
4075 IN OUT BOOLEAN
*Ascii
4082 UINT64 OriginalFilePosition
;
4088 return (EFI_INVALID_PARAMETER
);
4090 if (Buffer
== NULL
) {
4093 *Buffer
= CHAR_NULL
;
4095 gEfiShellProtocol
->GetFilePosition(Handle
, &OriginalFilePosition
);
4096 if (OriginalFilePosition
== 0) {
4097 CharSize
= sizeof(CHAR16
);
4098 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4099 ASSERT_EFI_ERROR(Status
);
4100 if (CharBuffer
== gUnicodeFileTag
) {
4104 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4108 for (CountSoFar
= 0;;CountSoFar
++){
4111 CharSize
= sizeof(CHAR8
);
4113 CharSize
= sizeof(CHAR16
);
4115 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4116 if ( EFI_ERROR(Status
)
4118 || (CharBuffer
== L
'\n' && !(*Ascii
))
4119 || (CharBuffer
== '\n' && *Ascii
)
4124 // if we have space save it...
4126 if ((CountSoFar
+1)*sizeof(CHAR16
) < *Size
){
4127 ASSERT(Buffer
!= NULL
);
4128 ((CHAR16
*)Buffer
)[CountSoFar
] = CharBuffer
;
4129 ((CHAR16
*)Buffer
)[CountSoFar
+1] = CHAR_NULL
;
4134 // if we ran out of space tell when...
4136 if ((CountSoFar
+1)*sizeof(CHAR16
) > *Size
){
4137 *Size
= (CountSoFar
+1)*sizeof(CHAR16
);
4139 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4141 DEBUG((DEBUG_WARN
, "The line was truncated in ShellFileHandleReadLine"));
4143 return (EFI_BUFFER_TOO_SMALL
);
4145 while(Buffer
[StrLen(Buffer
)-1] == L
'\r') {
4146 Buffer
[StrLen(Buffer
)-1] = CHAR_NULL
;
4153 Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
4155 @param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.
4156 @param[in] SectionToGetHelpOn Pointer to the section specifier(s).
4157 @param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints
4158 the help content only.
4159 @retval EFI_DEVICE_ERROR The help data format was incorrect.
4160 @retval EFI_NOT_FOUND The help data could not be found.
4161 @retval EFI_SUCCESS The operation was successful.
4166 IN CONST CHAR16
*CommandToGetHelpOn
,
4167 IN CONST CHAR16
*SectionToGetHelpOn
,
4168 IN BOOLEAN PrintCommandText
4177 // Get the string to print based
4179 Status
= gEfiShellProtocol
->GetHelpText (CommandToGetHelpOn
, SectionToGetHelpOn
, &OutText
);
4182 // make sure we got a valid string
4184 if (EFI_ERROR(Status
)){
4187 if (OutText
== NULL
|| StrLen(OutText
) == 0) {
4188 return EFI_NOT_FOUND
;
4192 // Chop off trailing stuff we dont need
4194 while (OutText
[StrLen(OutText
)-1] == L
'\r' || OutText
[StrLen(OutText
)-1] == L
'\n' || OutText
[StrLen(OutText
)-1] == L
' ') {
4195 OutText
[StrLen(OutText
)-1] = CHAR_NULL
;
4199 // Print this out to the console
4201 if (PrintCommandText
) {
4202 ShellPrintEx(-1, -1, L
"%H%-14s%N- %s\r\n", CommandToGetHelpOn
, OutText
);
4204 ShellPrintEx(-1, -1, L
"%N%s\r\n", OutText
);
4207 SHELL_FREE_NON_NULL(OutText
);
4213 Function to delete a file by name
4215 @param[in] FileName Pointer to file name to delete.
4217 @retval EFI_SUCCESS the file was deleted sucessfully
4218 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
4220 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
4221 @retval EFI_NOT_FOUND The specified file could not be found on the
4222 device or the file system could not be found
4224 @retval EFI_NO_MEDIA The device has no medium.
4225 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
4226 medium is no longer supported.
4227 @retval EFI_DEVICE_ERROR The device reported an error.
4228 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4229 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
4230 @retval EFI_ACCESS_DENIED The file was opened read only.
4231 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
4233 @retval other The file failed to open
4237 ShellDeleteFileByName(
4238 IN CONST CHAR16
*FileName
4242 SHELL_FILE_HANDLE FileHandle
;
4244 Status
= ShellFileExists(FileName
);
4246 if (Status
== EFI_SUCCESS
){
4247 Status
= ShellOpenFileByName(FileName
, &FileHandle
, EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
, 0x0);
4248 if (Status
== EFI_SUCCESS
){
4249 Status
= ShellDeleteFile(&FileHandle
);
4258 Cleans off all the quotes in the string.
4260 @param[in] OriginalString pointer to the string to be cleaned.
4261 @param[out] CleanString The new string with all quotes removed.
4262 Memory allocated in the function and free
4265 @retval EFI_SUCCESS The operation was successful.
4269 InternalShellStripQuotes (
4270 IN CONST CHAR16
*OriginalString
,
4271 OUT CHAR16
**CleanString
4276 if (OriginalString
== NULL
|| CleanString
== NULL
) {
4277 return EFI_INVALID_PARAMETER
;
4280 *CleanString
= AllocateCopyPool (StrSize (OriginalString
), OriginalString
);
4281 if (*CleanString
== NULL
) {
4282 return EFI_OUT_OF_RESOURCES
;
4285 for (Walker
= *CleanString
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
4286 if (*Walker
== L
'\"') {
4287 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));