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 CleanFilePathStr
= NULL
;
1507 Status
= InternalShellStripQuotes (Arg
, &CleanFilePathStr
);
1508 if (EFI_ERROR (Status
)) {
1513 // Check for UEFI Shell 2.0 protocols
1515 if (gEfiShellProtocol
!= NULL
) {
1516 if (*ListHead
== NULL
) {
1517 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1518 if (*ListHead
== NULL
) {
1519 FreePool(CleanFilePathStr
);
1520 return (EFI_OUT_OF_RESOURCES
);
1522 InitializeListHead(&((*ListHead
)->Link
));
1524 Status
= gEfiShellProtocol
->OpenFileList(CleanFilePathStr
,
1527 if (EFI_ERROR(Status
)) {
1528 gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1530 Status
= gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1532 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1533 FreePool(*ListHead
);
1534 FreePool(CleanFilePathStr
);
1536 return (EFI_NOT_FOUND
);
1538 FreePool(CleanFilePathStr
);
1543 // Check for EFI shell
1545 if (mEfiShellEnvironment2
!= NULL
) {
1547 // make sure the list head is initialized
1549 InitializeListHead(&mOldStyleFileList
);
1552 // Get the EFI Shell list of files
1554 Status
= mEfiShellEnvironment2
->FileMetaArg(CleanFilePathStr
, &mOldStyleFileList
);
1555 if (EFI_ERROR(Status
)) {
1557 FreePool(CleanFilePathStr
);
1561 if (*ListHead
== NULL
) {
1562 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1563 if (*ListHead
== NULL
) {
1564 FreePool(CleanFilePathStr
);
1565 return (EFI_OUT_OF_RESOURCES
);
1567 InitializeListHead(&((*ListHead
)->Link
));
1571 // Convert that to equivalent of UEFI Shell 2.0 structure
1573 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1576 // Free the EFI Shell version that was converted.
1578 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1580 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1581 FreePool(*ListHead
);
1583 Status
= EFI_NOT_FOUND
;
1585 FreePool(CleanFilePathStr
);
1589 FreePool(CleanFilePathStr
);
1590 return (EFI_UNSUPPORTED
);
1593 Free the linked list returned from ShellOpenFileMetaArg.
1595 if ListHead is NULL then ASSERT().
1597 @param ListHead the pointer to free.
1599 @retval EFI_SUCCESS the operation was sucessful.
1603 ShellCloseFileMetaArg (
1604 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1610 // ASSERT that ListHead is not NULL
1612 ASSERT(ListHead
!= NULL
);
1615 // Check for UEFI Shell 2.0 protocols
1617 if (gEfiShellProtocol
!= NULL
) {
1618 return (gEfiShellProtocol
->FreeFileList(ListHead
));
1619 } else if (mEfiShellEnvironment2
!= NULL
) {
1621 // Since this is EFI Shell version we need to free our internally made copy
1624 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1625 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1626 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1627 RemoveEntryList(Node
);
1628 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1629 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1630 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1631 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1632 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1634 SHELL_FREE_NON_NULL(*ListHead
);
1638 return (EFI_UNSUPPORTED
);
1642 Find a file by searching the CWD and then the path.
1644 If FileName is NULL then ASSERT.
1646 If the return value is not NULL then the memory must be caller freed.
1648 @param FileName Filename string.
1650 @retval NULL the file was not found
1651 @return !NULL the full path to the file.
1656 IN CONST CHAR16
*FileName
1660 SHELL_FILE_HANDLE Handle
;
1664 CONST CHAR16
*Walker
;
1671 // First make sure its not an absolute path.
1673 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1674 if (!EFI_ERROR(Status
)){
1675 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1676 ASSERT(RetVal
== NULL
);
1677 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1678 ShellCloseFile(&Handle
);
1681 ShellCloseFile(&Handle
);
1685 Path
= ShellGetEnvironmentVariable(L
"cwd");
1687 Size
= StrSize(Path
);
1688 Size
+= StrSize(FileName
);
1689 TestPath
= AllocateZeroPool(Size
);
1690 if (TestPath
== NULL
) {
1693 StrnCpy(TestPath
, Path
, Size
/sizeof(CHAR16
) - 1);
1694 StrnCat(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1695 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1696 if (!EFI_ERROR(Status
)){
1697 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1698 ASSERT(RetVal
== NULL
);
1699 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1700 ShellCloseFile(&Handle
);
1704 ShellCloseFile(&Handle
);
1709 Path
= ShellGetEnvironmentVariable(L
"path");
1711 Size
= StrSize(Path
)+sizeof(CHAR16
);
1712 Size
+= StrSize(FileName
);
1713 TestPath
= AllocateZeroPool(Size
);
1714 if (TestPath
== NULL
) {
1717 Walker
= (CHAR16
*)Path
;
1719 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1720 if (TestPath
!= NULL
) {
1721 TempChar
= StrStr(TestPath
, L
";");
1722 if (TempChar
!= NULL
) {
1723 *TempChar
= CHAR_NULL
;
1725 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1726 StrnCat(TestPath
, L
"\\", Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1728 if (FileName
[0] == L
'\\') {
1731 StrnCat(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1732 if (StrStr(Walker
, L
";") != NULL
) {
1733 Walker
= StrStr(Walker
, L
";") + 1;
1737 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1738 if (!EFI_ERROR(Status
)){
1739 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1740 ASSERT(RetVal
== NULL
);
1741 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1742 ShellCloseFile(&Handle
);
1745 ShellCloseFile(&Handle
);
1749 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1756 Find a file by searching the CWD and then the path with a variable set of file
1757 extensions. If the file is not found it will append each extension in the list
1758 in the order provided and return the first one that is successful.
1760 If FileName is NULL, then ASSERT.
1761 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1763 If the return value is not NULL then the memory must be caller freed.
1765 @param[in] FileName Filename string.
1766 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1768 @retval NULL The file was not found.
1769 @retval !NULL The path to the file.
1773 ShellFindFilePathEx (
1774 IN CONST CHAR16
*FileName
,
1775 IN CONST CHAR16
*FileExtension
1780 CONST CHAR16
*ExtensionWalker
;
1785 ASSERT(FileName
!= NULL
);
1786 if (FileExtension
== NULL
) {
1787 return (ShellFindFilePath(FileName
));
1789 RetVal
= ShellFindFilePath(FileName
);
1790 if (RetVal
!= NULL
) {
1793 Size
= StrSize(FileName
);
1794 Size
+= StrSize(FileExtension
);
1795 TestPath
= AllocateZeroPool(Size
);
1796 if (TestPath
== NULL
) {
1799 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1800 StrnCpy(TestPath
, FileName
, Size
/sizeof(CHAR16
) - 1);
1801 if (ExtensionWalker
!= NULL
) {
1802 StrnCat(TestPath
, ExtensionWalker
, Size
/sizeof(CHAR16
) - 1 - StrLen(TestPath
));
1804 TempChar
= StrStr(TestPath
, L
";");
1805 if (TempChar
!= NULL
) {
1806 *TempChar
= CHAR_NULL
;
1808 RetVal
= ShellFindFilePath(TestPath
);
1809 if (RetVal
!= NULL
) {
1812 ASSERT(ExtensionWalker
!= NULL
);
1813 TempChar2
= StrStr(ExtensionWalker
, L
";");
1822 SHELL_PARAM_TYPE Type
;
1824 UINTN OriginalPosition
;
1825 } SHELL_PARAM_PACKAGE
;
1828 Checks the list of valid arguments and returns TRUE if the item was found. If the
1829 return value is TRUE then the type parameter is set also.
1831 if CheckList is NULL then ASSERT();
1832 if Name is NULL then ASSERT();
1833 if Type is NULL then ASSERT();
1835 @param Name pointer to Name of parameter found
1836 @param CheckList List to check against
1837 @param Type pointer to type of parameter if it was found
1839 @retval TRUE the Parameter was found. Type is valid.
1840 @retval FALSE the Parameter was not found. Type is not valid.
1844 InternalIsOnCheckList (
1845 IN CONST CHAR16
*Name
,
1846 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1847 OUT SHELL_PARAM_TYPE
*Type
1850 SHELL_PARAM_ITEM
*TempListItem
;
1854 // ASSERT that all 3 pointer parameters aren't NULL
1856 ASSERT(CheckList
!= NULL
);
1857 ASSERT(Type
!= NULL
);
1858 ASSERT(Name
!= NULL
);
1861 // question mark and page break mode are always supported
1863 if ((StrCmp(Name
, L
"-?") == 0) ||
1864 (StrCmp(Name
, L
"-b") == 0)
1871 // Enumerate through the list
1873 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1875 // If the Type is TypeStart only check the first characters of the passed in param
1876 // If it matches set the type and return TRUE
1878 if (TempListItem
->Type
== TypeStart
) {
1879 if (StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1880 *Type
= TempListItem
->Type
;
1884 TempString
= StrnCatGrow(&TempString
, NULL
, Name
, StrLen(TempListItem
->Name
));
1885 if (TempString
!= NULL
) {
1886 if (StringNoCaseCompare(&TempString
, &TempListItem
->Name
) == 0) {
1887 *Type
= TempListItem
->Type
;
1888 FreePool(TempString
);
1891 FreePool(TempString
);
1893 } else if (StringNoCaseCompare(&Name
, &TempListItem
->Name
) == 0) {
1894 *Type
= TempListItem
->Type
;
1902 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1904 @param[in] Name pointer to Name of parameter found
1905 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1906 @param[in] TimeNumbers TRUE to allow numbers with ":", FALSE otherwise.
1908 @retval TRUE the Parameter is a flag.
1909 @retval FALSE the Parameter not a flag.
1914 IN CONST CHAR16
*Name
,
1915 IN CONST BOOLEAN AlwaysAllowNumbers
,
1916 IN CONST BOOLEAN TimeNumbers
1920 // ASSERT that Name isn't NULL
1922 ASSERT(Name
!= NULL
);
1925 // If we accept numbers then dont return TRUE. (they will be values)
1927 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && InternalShellIsHexOrDecimalNumber(Name
+1, FALSE
, FALSE
, TimeNumbers
)) && AlwaysAllowNumbers
) {
1932 // If the Name has a /, +, or - as the first character return TRUE
1934 if ((Name
[0] == L
'/') ||
1935 (Name
[0] == L
'-') ||
1944 Checks the command line arguments passed against the list of valid ones.
1946 If no initialization is required, then return RETURN_SUCCESS.
1948 @param[in] CheckList pointer to list of parameters to check
1949 @param[out] CheckPackage pointer to pointer to list checked values
1950 @param[out] ProblemParam optional pointer to pointer to unicode string for
1951 the paramater that caused failure. If used then the
1952 caller is responsible for freeing the memory.
1953 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1954 @param[in] Argv pointer to array of parameters
1955 @param[in] Argc Count of parameters in Argv
1956 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1958 @retval EFI_SUCCESS The operation completed sucessfully.
1959 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1960 @retval EFI_INVALID_PARAMETER A parameter was invalid
1961 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1962 duplicated. the duplicated command line argument
1963 was returned in ProblemParam if provided.
1964 @retval EFI_NOT_FOUND a argument required a value that was missing.
1965 the invalid command line argument was returned in
1966 ProblemParam if provided.
1970 InternalCommandLineParse (
1971 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1972 OUT LIST_ENTRY
**CheckPackage
,
1973 OUT CHAR16
**ProblemParam OPTIONAL
,
1974 IN BOOLEAN AutoPageBreak
,
1975 IN CONST CHAR16
**Argv
,
1977 IN BOOLEAN AlwaysAllowNumbers
1981 SHELL_PARAM_TYPE CurrentItemType
;
1982 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
1986 CONST CHAR16
*TempPointer
;
1987 UINTN CurrentValueSize
;
1989 CurrentItemPackage
= NULL
;
1995 // If there is only 1 item we dont need to do anything
1998 *CheckPackage
= NULL
;
1999 return (EFI_SUCCESS
);
2005 ASSERT(CheckList
!= NULL
);
2006 ASSERT(Argv
!= NULL
);
2009 // initialize the linked list
2011 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
2012 if (*CheckPackage
== NULL
) {
2013 return (EFI_OUT_OF_RESOURCES
);
2016 InitializeListHead(*CheckPackage
);
2019 // loop through each of the arguments
2021 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
2022 if (Argv
[LoopCounter
] == NULL
) {
2024 // do nothing for NULL argv
2026 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
2028 // We might have leftover if last parameter didnt have optional value
2030 if (GetItemValue
!= 0) {
2032 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2037 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2038 if (CurrentItemPackage
== NULL
) {
2039 ShellCommandLineFreeVarList(*CheckPackage
);
2040 *CheckPackage
= NULL
;
2041 return (EFI_OUT_OF_RESOURCES
);
2043 CurrentItemPackage
->Name
= AllocateCopyPool(StrSize(Argv
[LoopCounter
]), Argv
[LoopCounter
]);
2044 if (CurrentItemPackage
->Name
== NULL
) {
2045 ShellCommandLineFreeVarList(*CheckPackage
);
2046 *CheckPackage
= NULL
;
2047 return (EFI_OUT_OF_RESOURCES
);
2049 CurrentItemPackage
->Type
= CurrentItemType
;
2050 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
2051 CurrentItemPackage
->Value
= NULL
;
2054 // Does this flag require a value
2056 switch (CurrentItemPackage
->Type
) {
2058 // possibly trigger the next loop(s) to populate the value of this item
2065 case TypeDoubleValue
:
2070 GetItemValue
= (UINTN
)(-1);
2075 // this item has no value expected; we are done
2077 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2078 ASSERT(GetItemValue
== 0);
2081 } else if (GetItemValue
!= 0 && CurrentItemPackage
!= NULL
&& !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
, (CONST BOOLEAN
)(CurrentItemPackage
->Type
== TypeTimeValue
))) {
2082 ASSERT(CurrentItemPackage
!= NULL
);
2084 // get the item VALUE for a previous flag
2086 if (StrStr(Argv
[LoopCounter
], L
" ") == NULL
) {
2087 CurrentValueSize
= ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2088 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, CurrentValueSize
, CurrentItemPackage
->Value
);
2089 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2090 if (ValueSize
== 0) {
2091 StrnCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1);
2093 StrnCat(CurrentItemPackage
->Value
, L
" ", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2094 StrnCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2096 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2099 // the parameter has spaces. must be quoted.
2101 CurrentValueSize
= ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
) + sizeof(CHAR16
) + sizeof(CHAR16
);
2102 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, CurrentValueSize
, CurrentItemPackage
->Value
);
2103 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2104 if (ValueSize
== 0) {
2105 StrnCpy(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1);
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 StrnCat(CurrentItemPackage
->Value
, L
" ", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2110 StrnCat(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2111 StrnCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
], CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2112 StrnCat(CurrentItemPackage
->Value
, L
"\"", CurrentValueSize
/sizeof(CHAR16
) - 1 - StrLen(CurrentItemPackage
->Value
));
2114 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2117 if (GetItemValue
== 0) {
2118 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2120 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
, FALSE
)){
2122 // add this one as a non-flag
2125 TempPointer
= Argv
[LoopCounter
];
2126 if ((*TempPointer
== L
'^' && *(TempPointer
+1) == L
'-')
2127 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'/')
2128 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'+')
2132 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2133 if (CurrentItemPackage
== NULL
) {
2134 ShellCommandLineFreeVarList(*CheckPackage
);
2135 *CheckPackage
= NULL
;
2136 return (EFI_OUT_OF_RESOURCES
);
2138 CurrentItemPackage
->Name
= NULL
;
2139 CurrentItemPackage
->Type
= TypePosition
;
2140 CurrentItemPackage
->Value
= AllocateCopyPool(StrSize(TempPointer
), TempPointer
);
2141 if (CurrentItemPackage
->Value
== NULL
) {
2142 ShellCommandLineFreeVarList(*CheckPackage
);
2143 *CheckPackage
= NULL
;
2144 return (EFI_OUT_OF_RESOURCES
);
2146 CurrentItemPackage
->OriginalPosition
= Count
++;
2147 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2150 // this was a non-recognised flag... error!
2152 if (ProblemParam
!= NULL
) {
2153 *ProblemParam
= AllocateCopyPool(StrSize(Argv
[LoopCounter
]), Argv
[LoopCounter
]);
2155 ShellCommandLineFreeVarList(*CheckPackage
);
2156 *CheckPackage
= NULL
;
2157 return (EFI_VOLUME_CORRUPTED
);
2160 if (GetItemValue
!= 0) {
2162 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2165 // support for AutoPageBreak
2167 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2168 ShellSetPageBreakMode(TRUE
);
2170 return (EFI_SUCCESS
);
2174 Checks the command line arguments passed against the list of valid ones.
2175 Optionally removes NULL values first.
2177 If no initialization is required, then return RETURN_SUCCESS.
2179 @param[in] CheckList The pointer to list of parameters to check.
2180 @param[out] CheckPackage The package of checked values.
2181 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2182 the paramater that caused failure.
2183 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2184 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2186 @retval EFI_SUCCESS The operation completed sucessfully.
2187 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2188 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2189 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2190 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2191 of the command line arguments was returned in
2192 ProblemParam if provided.
2193 @retval EFI_NOT_FOUND A argument required a value that was missing.
2194 The invalid command line argument was returned in
2195 ProblemParam if provided.
2199 ShellCommandLineParseEx (
2200 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2201 OUT LIST_ENTRY
**CheckPackage
,
2202 OUT CHAR16
**ProblemParam OPTIONAL
,
2203 IN BOOLEAN AutoPageBreak
,
2204 IN BOOLEAN AlwaysAllowNumbers
2208 // ASSERT that CheckList and CheckPackage aren't NULL
2210 ASSERT(CheckList
!= NULL
);
2211 ASSERT(CheckPackage
!= NULL
);
2214 // Check for UEFI Shell 2.0 protocols
2216 if (gEfiShellParametersProtocol
!= NULL
) {
2217 return (InternalCommandLineParse(CheckList
,
2221 (CONST CHAR16
**) gEfiShellParametersProtocol
->Argv
,
2222 gEfiShellParametersProtocol
->Argc
,
2223 AlwaysAllowNumbers
));
2227 // ASSERT That EFI Shell is not required
2229 ASSERT (mEfiShellInterface
!= NULL
);
2230 return (InternalCommandLineParse(CheckList
,
2234 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2235 mEfiShellInterface
->Argc
,
2236 AlwaysAllowNumbers
));
2240 Frees shell variable list that was returned from ShellCommandLineParse.
2242 This function will free all the memory that was used for the CheckPackage
2243 list of postprocessed shell arguments.
2245 this function has no return value.
2247 if CheckPackage is NULL, then return
2249 @param CheckPackage the list to de-allocate
2253 ShellCommandLineFreeVarList (
2254 IN LIST_ENTRY
*CheckPackage
2260 // check for CheckPackage == NULL
2262 if (CheckPackage
== NULL
) {
2267 // for each node in the list
2269 for ( Node
= GetFirstNode(CheckPackage
)
2270 ; !IsListEmpty(CheckPackage
)
2271 ; Node
= GetFirstNode(CheckPackage
)
2274 // Remove it from the list
2276 RemoveEntryList(Node
);
2279 // if it has a name free the name
2281 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2282 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2286 // if it has a value free the value
2288 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2289 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2293 // free the node structure
2295 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2298 // free the list head node
2300 FreePool(CheckPackage
);
2303 Checks for presence of a flag parameter
2305 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2307 if CheckPackage is NULL then return FALSE.
2308 if KeyString is NULL then ASSERT()
2310 @param CheckPackage The package of parsed command line arguments
2311 @param KeyString the Key of the command line argument to check for
2313 @retval TRUE the flag is on the command line
2314 @retval FALSE the flag is not on the command line
2318 ShellCommandLineGetFlag (
2319 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2320 IN CONST CHAR16
* CONST KeyString
2327 // return FALSE for no package or KeyString is NULL
2329 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2334 // enumerate through the list of parametrs
2336 for ( Node
= GetFirstNode(CheckPackage
)
2337 ; !IsNull (CheckPackage
, Node
)
2338 ; Node
= GetNextNode(CheckPackage
, Node
)
2341 // If the Name matches, return TRUE (and there may be NULL name)
2343 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2345 // If Type is TypeStart then only compare the begining of the strings
2347 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2348 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2352 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2353 if (TempString
!= NULL
) {
2354 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2355 FreePool(TempString
);
2358 FreePool(TempString
);
2360 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2368 Returns value from command line argument.
2370 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2372 If CheckPackage is NULL, then return NULL.
2374 @param[in] CheckPackage The package of parsed command line arguments.
2375 @param[in] KeyString The Key of the command line argument to check for.
2377 @retval NULL The flag is not on the command line.
2378 @retval !=NULL The pointer to unicode string of the value.
2382 ShellCommandLineGetValue (
2383 IN CONST LIST_ENTRY
*CheckPackage
,
2384 IN CHAR16
*KeyString
2391 // return NULL for no package or KeyString is NULL
2393 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2398 // enumerate through the list of parametrs
2400 for ( Node
= GetFirstNode(CheckPackage
)
2401 ; !IsNull (CheckPackage
, Node
)
2402 ; Node
= GetNextNode(CheckPackage
, Node
)
2405 // If the Name matches, return TRUE (and there may be NULL name)
2407 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2409 // If Type is TypeStart then only compare the begining of the strings
2411 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2412 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2413 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2416 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2417 if (TempString
!= NULL
) {
2418 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2419 FreePool(TempString
);
2420 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2422 FreePool(TempString
);
2424 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2425 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2433 Returns raw value from command line argument.
2435 Raw value parameters are in the form of "value" in a specific position in the list.
2437 If CheckPackage is NULL, then return NULL.
2439 @param[in] CheckPackage The package of parsed command line arguments.
2440 @param[in] Position The position of the value.
2442 @retval NULL The flag is not on the command line.
2443 @retval !=NULL The pointer to unicode string of the value.
2447 ShellCommandLineGetRawValue (
2448 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2455 // check for CheckPackage == NULL
2457 if (CheckPackage
== NULL
) {
2462 // enumerate through the list of parametrs
2464 for ( Node
= GetFirstNode(CheckPackage
)
2465 ; !IsNull (CheckPackage
, Node
)
2466 ; Node
= GetNextNode(CheckPackage
, Node
)
2469 // If the position matches, return the value
2471 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2472 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2479 returns the number of command line value parameters that were parsed.
2481 this will not include flags.
2483 @param[in] CheckPackage The package of parsed command line arguments.
2485 @retval (UINTN)-1 No parsing has ocurred
2486 @return other The number of value parameters found
2490 ShellCommandLineGetCount(
2491 IN CONST LIST_ENTRY
*CheckPackage
2497 if (CheckPackage
== NULL
) {
2500 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2501 ; !IsNull (CheckPackage
, Node1
)
2502 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2504 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2512 Determins if a parameter is duplicated.
2514 If Param is not NULL then it will point to a callee allocated string buffer
2515 with the parameter value if a duplicate is found.
2517 If CheckPackage is NULL, then ASSERT.
2519 @param[in] CheckPackage The package of parsed command line arguments.
2520 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2522 @retval EFI_SUCCESS No parameters were duplicated.
2523 @retval EFI_DEVICE_ERROR A duplicate was found.
2527 ShellCommandLineCheckDuplicate (
2528 IN CONST LIST_ENTRY
*CheckPackage
,
2535 ASSERT(CheckPackage
!= NULL
);
2537 for ( Node1
= GetFirstNode(CheckPackage
)
2538 ; !IsNull (CheckPackage
, Node1
)
2539 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2541 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2542 ; !IsNull (CheckPackage
, Node2
)
2543 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2545 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) {
2546 if (Param
!= NULL
) {
2548 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2550 return (EFI_DEVICE_ERROR
);
2554 return (EFI_SUCCESS
);
2558 This is a find and replace function. Upon successful return the NewString is a copy of
2559 SourceString with each instance of FindTarget replaced with ReplaceWith.
2561 If SourceString and NewString overlap the behavior is undefined.
2563 If the string would grow bigger than NewSize it will halt and return error.
2565 @param[in] SourceString The string with source buffer.
2566 @param[in, out] NewString The string with resultant buffer.
2567 @param[in] NewSize The size in bytes of NewString.
2568 @param[in] FindTarget The string to look for.
2569 @param[in] ReplaceWith The string to replace FindTarget with.
2570 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2571 immediately before it.
2572 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2574 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2575 @retval EFI_INVALID_PARAMETER NewString was NULL.
2576 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2577 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2578 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2579 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2580 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2581 the new string (truncation occurred).
2582 @retval EFI_SUCCESS The string was successfully copied with replacement.
2586 ShellCopySearchAndReplace(
2587 IN CHAR16 CONST
*SourceString
,
2588 IN OUT CHAR16
*NewString
,
2590 IN CONST CHAR16
*FindTarget
,
2591 IN CONST CHAR16
*ReplaceWith
,
2592 IN CONST BOOLEAN SkipPreCarrot
,
2593 IN CONST BOOLEAN ParameterReplacing
2599 if ( (SourceString
== NULL
)
2600 || (NewString
== NULL
)
2601 || (FindTarget
== NULL
)
2602 || (ReplaceWith
== NULL
)
2603 || (StrLen(FindTarget
) < 1)
2604 || (StrLen(SourceString
) < 1)
2606 return (EFI_INVALID_PARAMETER
);
2609 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2610 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2612 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2613 if (Replace
!= NULL
) {
2614 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2617 if (Replace
== NULL
) {
2618 return (EFI_OUT_OF_RESOURCES
);
2620 NewString
= ZeroMem(NewString
, NewSize
);
2621 while (*SourceString
!= CHAR_NULL
) {
2623 // if we find the FindTarget and either Skip == FALSE or Skip and we
2624 // dont have a carrot do a replace...
2626 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2627 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2629 SourceString
+= StrLen(FindTarget
);
2630 Size
= StrSize(NewString
);
2631 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2633 return (EFI_BUFFER_TOO_SMALL
);
2635 StrnCat(NewString
, Replace
, NewSize
/sizeof(CHAR16
) - 1 - StrLen(NewString
));
2637 Size
= StrSize(NewString
);
2638 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2640 return (EFI_BUFFER_TOO_SMALL
);
2642 StrnCat(NewString
, SourceString
, 1);
2647 return (EFI_SUCCESS
);
2651 Internal worker function to output a string.
2653 This function will output a string to the correct StdOut.
2655 @param[in] String The string to print out.
2657 @retval EFI_SUCCESS The operation was sucessful.
2658 @retval !EFI_SUCCESS The operation failed.
2663 IN CONST CHAR16
*String
2667 Size
= StrSize(String
) - sizeof(CHAR16
);
2669 return (EFI_SUCCESS
);
2671 if (gEfiShellParametersProtocol
!= NULL
) {
2672 return (gEfiShellProtocol
->WriteFile(gEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2674 if (mEfiShellInterface
!= NULL
) {
2675 if (mEfiShellInterface
->RedirArgc
== 0) {
2677 // Divide in half for old shell. Must be string length not size.
2679 Size
/=2; // Divide in half only when no redirection.
2681 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2684 return (EFI_UNSUPPORTED
);
2688 Print at a specific location on the screen.
2690 This function will move the cursor to a given screen location and print the specified string
2692 If -1 is specified for either the Row or Col the current screen location for BOTH
2695 if either Row or Col is out of range for the current console, then ASSERT
2696 if Format is NULL, then ASSERT
2698 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2699 the following additional flags:
2700 %N - Set output attribute to normal
2701 %H - Set output attribute to highlight
2702 %E - Set output attribute to error
2703 %B - Set output attribute to blue color
2704 %V - Set output attribute to green color
2706 Note: The background color is controlled by the shell command cls.
2708 @param[in] Col the column to print at
2709 @param[in] Row the row to print at
2710 @param[in] Format the format string
2711 @param[in] Marker the marker for the variable argument list
2713 @return EFI_SUCCESS The operation was successful.
2714 @return EFI_DEVICE_ERROR The console device reported an error.
2718 InternalShellPrintWorker(
2719 IN INT32 Col OPTIONAL
,
2720 IN INT32 Row OPTIONAL
,
2721 IN CONST CHAR16
*Format
,
2726 CHAR16
*ResumeLocation
;
2727 CHAR16
*FormatWalker
;
2728 UINTN OriginalAttribute
;
2729 CHAR16
*mPostReplaceFormat
;
2730 CHAR16
*mPostReplaceFormat2
;
2732 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2733 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2735 if (mPostReplaceFormat
== NULL
|| mPostReplaceFormat2
== NULL
) {
2736 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2737 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2738 return (EFI_OUT_OF_RESOURCES
);
2741 Status
= EFI_SUCCESS
;
2742 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2745 // Back and forth each time fixing up 1 of our flags...
2747 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2748 ASSERT_EFI_ERROR(Status
);
2749 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2750 ASSERT_EFI_ERROR(Status
);
2751 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2752 ASSERT_EFI_ERROR(Status
);
2753 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2754 ASSERT_EFI_ERROR(Status
);
2755 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2756 ASSERT_EFI_ERROR(Status
);
2759 // Use the last buffer from replacing to print from...
2761 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2763 if (Col
!= -1 && Row
!= -1) {
2764 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2767 FormatWalker
= mPostReplaceFormat2
;
2768 while (*FormatWalker
!= CHAR_NULL
) {
2770 // Find the next attribute change request
2772 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2773 if (ResumeLocation
!= NULL
) {
2774 *ResumeLocation
= CHAR_NULL
;
2777 // print the current FormatWalker string
2779 if (StrLen(FormatWalker
)>0) {
2780 Status
= InternalPrintTo(FormatWalker
);
2781 if (EFI_ERROR(Status
)) {
2787 // update the attribute
2789 if (ResumeLocation
!= NULL
) {
2790 if (*(ResumeLocation
-1) == L
'^') {
2792 // Move cursor back 1 position to overwrite the ^
2794 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gST
->ConOut
->Mode
->CursorColumn
- 1, gST
->ConOut
->Mode
->CursorRow
);
2797 // Print a simple '%' symbol
2799 Status
= InternalPrintTo(L
"%");
2800 ResumeLocation
= ResumeLocation
- 1;
2802 switch (*(ResumeLocation
+1)) {
2804 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2807 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2810 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2813 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2816 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2820 // Print a simple '%' symbol
2822 Status
= InternalPrintTo(L
"%");
2823 if (EFI_ERROR(Status
)) {
2826 ResumeLocation
= ResumeLocation
- 1;
2832 // reset to normal now...
2838 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2840 FormatWalker
= ResumeLocation
+ 2;
2843 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2845 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2846 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2851 Print at a specific location on the screen.
2853 This function will move the cursor to a given screen location and print the specified string.
2855 If -1 is specified for either the Row or Col the current screen location for BOTH
2858 If either Row or Col is out of range for the current console, then ASSERT.
2859 If Format is NULL, then ASSERT.
2861 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2862 the following additional flags:
2863 %N - Set output attribute to normal
2864 %H - Set output attribute to highlight
2865 %E - Set output attribute to error
2866 %B - Set output attribute to blue color
2867 %V - Set output attribute to green color
2869 Note: The background color is controlled by the shell command cls.
2871 @param[in] Col the column to print at
2872 @param[in] Row the row to print at
2873 @param[in] Format the format string
2874 @param[in] ... The variable argument list.
2876 @return EFI_SUCCESS The printing was successful.
2877 @return EFI_DEVICE_ERROR The console device reported an error.
2882 IN INT32 Col OPTIONAL
,
2883 IN INT32 Row OPTIONAL
,
2884 IN CONST CHAR16
*Format
,
2890 if (Format
== NULL
) {
2891 return (EFI_INVALID_PARAMETER
);
2893 VA_START (Marker
, Format
);
2894 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2900 Print at a specific location on the screen.
2902 This function will move the cursor to a given screen location and print the specified string.
2904 If -1 is specified for either the Row or Col the current screen location for BOTH
2907 If either Row or Col is out of range for the current console, then ASSERT.
2908 If Format is NULL, then ASSERT.
2910 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2911 the following additional flags:
2912 %N - Set output attribute to normal.
2913 %H - Set output attribute to highlight.
2914 %E - Set output attribute to error.
2915 %B - Set output attribute to blue color.
2916 %V - Set output attribute to green color.
2918 Note: The background color is controlled by the shell command cls.
2920 @param[in] Col The column to print at.
2921 @param[in] Row The row to print at.
2922 @param[in] Language The language of the string to retrieve. If this parameter
2923 is NULL, then the current platform language is used.
2924 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2925 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2926 @param[in] ... The variable argument list.
2928 @return EFI_SUCCESS The printing was successful.
2929 @return EFI_DEVICE_ERROR The console device reported an error.
2934 IN INT32 Col OPTIONAL
,
2935 IN INT32 Row OPTIONAL
,
2936 IN CONST CHAR8
*Language OPTIONAL
,
2937 IN CONST EFI_STRING_ID HiiFormatStringId
,
2938 IN CONST EFI_HANDLE HiiFormatHandle
,
2943 CHAR16
*HiiFormatString
;
2946 VA_START (Marker
, HiiFormatHandle
);
2947 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2948 ASSERT(HiiFormatString
!= NULL
);
2950 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2952 SHELL_FREE_NON_NULL(HiiFormatString
);
2959 Function to determine if a given filename represents a file or a directory.
2961 @param[in] DirName Path to directory to test.
2963 @retval EFI_SUCCESS The Path represents a directory
2964 @retval EFI_NOT_FOUND The Path does not represent a directory
2965 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2966 @return The path failed to open
2971 IN CONST CHAR16
*DirName
2975 SHELL_FILE_HANDLE Handle
;
2976 CHAR16
*TempLocation
;
2977 CHAR16
*TempLocation2
;
2979 ASSERT(DirName
!= NULL
);
2982 TempLocation
= NULL
;
2984 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
2985 if (EFI_ERROR(Status
)) {
2987 // try good logic first.
2989 if (gEfiShellProtocol
!= NULL
) {
2990 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
2991 if (TempLocation
== NULL
) {
2992 ShellCloseFile(&Handle
);
2993 return (EFI_OUT_OF_RESOURCES
);
2995 TempLocation2
= StrStr(TempLocation
, L
":");
2996 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
2997 *(TempLocation2
+1) = CHAR_NULL
;
2999 if (gEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
3000 FreePool(TempLocation
);
3001 return (EFI_SUCCESS
);
3003 FreePool(TempLocation
);
3006 // probably a map name?!?!!?
3008 TempLocation
= StrStr(DirName
, L
"\\");
3009 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
3010 return (EFI_SUCCESS
);
3016 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
3017 ShellCloseFile(&Handle
);
3018 return (EFI_SUCCESS
);
3020 ShellCloseFile(&Handle
);
3021 return (EFI_NOT_FOUND
);
3025 Function to determine if a given filename represents a file.
3027 @param[in] Name Path to file to test.
3029 @retval EFI_SUCCESS The Path represents a file.
3030 @retval EFI_NOT_FOUND The Path does not represent a file.
3031 @retval other The path failed to open.
3036 IN CONST CHAR16
*Name
3040 SHELL_FILE_HANDLE Handle
;
3042 ASSERT(Name
!= NULL
);
3046 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
3047 if (EFI_ERROR(Status
)) {
3051 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
3052 ShellCloseFile(&Handle
);
3053 return (EFI_SUCCESS
);
3055 ShellCloseFile(&Handle
);
3056 return (EFI_NOT_FOUND
);
3060 Function to determine if a given filename represents a file.
3062 This will search the CWD and then the Path.
3064 If Name is NULL, then ASSERT.
3066 @param[in] Name Path to file to test.
3068 @retval EFI_SUCCESS The Path represents a file.
3069 @retval EFI_NOT_FOUND The Path does not represent a file.
3070 @retval other The path failed to open.
3075 IN CONST CHAR16
*Name
3081 if (!EFI_ERROR(ShellIsFile(Name
))) {
3082 return (EFI_SUCCESS
);
3085 NewName
= ShellFindFilePath(Name
);
3086 if (NewName
== NULL
) {
3087 return (EFI_NOT_FOUND
);
3089 Status
= ShellIsFile(NewName
);
3095 Function return the number converted from a hex representation of a number.
3097 Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid
3098 result. Use ShellConvertStringToUint64 instead.
3100 @param[in] String String representation of a number.
3102 @return The unsigned integer result of the conversion.
3103 @retval (UINTN)(-1) An error occured.
3108 IN CONST CHAR16
*String
3113 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, TRUE
, TRUE
))) {
3114 return ((UINTN
)RetVal
);
3117 return ((UINTN
)(-1));
3121 Function to determine whether a string is decimal or hex representation of a number
3122 and return the number converted from the string. Spaces are always skipped.
3124 @param[in] String String representation of a number
3127 @retval (UINTN)(-1) An error ocurred.
3132 IN CONST CHAR16
*String
3140 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, TRUE
, FALSE
)) {
3144 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, Hex
, TRUE
))) {
3145 return ((UINTN
)RetVal
);
3147 return ((UINTN
)(-1));
3151 Safely append with automatic string resizing given length of Destination and
3152 desired length of copy from Source.
3154 append the first D characters of Source to the end of Destination, where D is
3155 the lesser of Count and the StrLen() of Source. If appending those D characters
3156 will fit within Destination (whose Size is given as CurrentSize) and
3157 still leave room for a NULL terminator, then those characters are appended,
3158 starting at the original terminating NULL of Destination, and a new terminating
3161 If appending D characters onto Destination will result in a overflow of the size
3162 given in CurrentSize the string will be grown such that the copy can be performed
3163 and CurrentSize will be updated to the new size.
3165 If Source is NULL, there is nothing to append, just return the current buffer in
3168 if Destination is NULL, then ASSERT()
3169 if Destination's current length (including NULL terminator) is already more then
3170 CurrentSize, then ASSERT()
3172 @param[in, out] Destination The String to append onto
3173 @param[in, out] CurrentSize on call the number of bytes in Destination. On
3174 return possibly the new size (still in bytes). if NULL
3175 then allocate whatever is needed.
3176 @param[in] Source The String to append from
3177 @param[in] Count Maximum number of characters to append. if 0 then
3180 @return Destination return the resultant string.
3185 IN OUT CHAR16
**Destination
,
3186 IN OUT UINTN
*CurrentSize
,
3187 IN CONST CHAR16
*Source
,
3191 UINTN DestinationStartSize
;
3197 ASSERT(Destination
!= NULL
);
3200 // If there's nothing to do then just return Destination
3202 if (Source
== NULL
) {
3203 return (*Destination
);
3207 // allow for un-initialized pointers, based on size being 0
3209 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
3210 *Destination
= NULL
;
3214 // allow for NULL pointers address as Destination
3216 if (*Destination
!= NULL
) {
3217 ASSERT(CurrentSize
!= 0);
3218 DestinationStartSize
= StrSize(*Destination
);
3219 ASSERT(DestinationStartSize
<= *CurrentSize
);
3221 DestinationStartSize
= 0;
3222 // ASSERT(*CurrentSize == 0);
3226 // Append all of Source?
3229 Count
= StrLen(Source
);
3233 // Test and grow if required
3235 if (CurrentSize
!= NULL
) {
3236 NewSize
= *CurrentSize
;
3237 if (NewSize
< DestinationStartSize
+ (Count
* sizeof(CHAR16
))) {
3238 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3239 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3241 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3242 *CurrentSize
= NewSize
;
3245 *Destination
= AllocateZeroPool((Count
+1)*sizeof(CHAR16
));
3249 // Now use standard StrnCat on a big enough buffer
3251 if (*Destination
== NULL
) {
3254 return StrnCat(*Destination
, Source
, Count
);
3258 Prompt the user and return the resultant answer to the requestor.
3260 This function will display the requested question on the shell prompt and then
3261 wait for an apropriate answer to be input from the console.
3263 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3264 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3266 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3269 In either case *Response must be callee freed if Response was not NULL;
3271 @param Type What type of question is asked. This is used to filter the input
3272 to prevent invalid answers to question.
3273 @param Prompt Pointer to string prompt to use to request input.
3274 @param Response Pointer to Response which will be populated upon return.
3276 @retval EFI_SUCCESS The operation was sucessful.
3277 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3278 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3279 @return other The operation failed.
3283 ShellPromptForResponse (
3284 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3285 IN CHAR16
*Prompt OPTIONAL
,
3286 IN OUT VOID
**Response OPTIONAL
3292 SHELL_PROMPT_RESPONSE
*Resp
;
3296 Status
= EFI_UNSUPPORTED
;
3300 if (Type
!= ShellPromptResponseTypeFreeform
) {
3301 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE
));
3303 return (EFI_OUT_OF_RESOURCES
);
3308 case ShellPromptResponseTypeQuitContinue
:
3309 if (Prompt
!= NULL
) {
3310 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3313 // wait for valid response
3315 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3316 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3317 if (EFI_ERROR(Status
)) {
3320 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3321 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3322 *Resp
= ShellPromptResponseQuit
;
3324 *Resp
= ShellPromptResponseContinue
;
3327 case ShellPromptResponseTypeYesNoCancel
:
3328 if (Prompt
!= NULL
) {
3329 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3332 // wait for valid response
3334 *Resp
= ShellPromptResponseMax
;
3335 while (*Resp
== ShellPromptResponseMax
) {
3336 if (ShellGetExecutionBreakFlag()) {
3337 Status
= EFI_ABORTED
;
3340 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3341 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3342 if (EFI_ERROR(Status
)) {
3345 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3346 switch (Key
.UnicodeChar
) {
3349 *Resp
= ShellPromptResponseYes
;
3353 *Resp
= ShellPromptResponseNo
;
3357 *Resp
= ShellPromptResponseCancel
;
3361 break; case ShellPromptResponseTypeYesNoAllCancel
:
3362 if (Prompt
!= NULL
) {
3363 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3366 // wait for valid response
3368 *Resp
= ShellPromptResponseMax
;
3369 while (*Resp
== ShellPromptResponseMax
) {
3370 if (ShellGetExecutionBreakFlag()) {
3371 Status
= EFI_ABORTED
;
3374 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3375 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3376 if (EFI_ERROR(Status
)) {
3379 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3380 switch (Key
.UnicodeChar
) {
3383 *Resp
= ShellPromptResponseYes
;
3387 *Resp
= ShellPromptResponseNo
;
3391 *Resp
= ShellPromptResponseAll
;
3395 *Resp
= ShellPromptResponseCancel
;
3400 case ShellPromptResponseTypeEnterContinue
:
3401 case ShellPromptResponseTypeAnyKeyContinue
:
3402 if (Prompt
!= NULL
) {
3403 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3406 // wait for valid response
3408 *Resp
= ShellPromptResponseMax
;
3409 while (*Resp
== ShellPromptResponseMax
) {
3410 if (ShellGetExecutionBreakFlag()) {
3411 Status
= EFI_ABORTED
;
3414 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3415 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3416 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3417 if (EFI_ERROR(Status
)) {
3420 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3421 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3422 *Resp
= ShellPromptResponseContinue
;
3426 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3427 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3428 ASSERT_EFI_ERROR(Status
);
3429 *Resp
= ShellPromptResponseContinue
;
3434 case ShellPromptResponseTypeYesNo
:
3435 if (Prompt
!= NULL
) {
3436 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3439 // wait for valid response
3441 *Resp
= ShellPromptResponseMax
;
3442 while (*Resp
== ShellPromptResponseMax
) {
3443 if (ShellGetExecutionBreakFlag()) {
3444 Status
= EFI_ABORTED
;
3447 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3448 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3449 if (EFI_ERROR(Status
)) {
3452 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3453 switch (Key
.UnicodeChar
) {
3456 *Resp
= ShellPromptResponseYes
;
3460 *Resp
= ShellPromptResponseNo
;
3465 case ShellPromptResponseTypeFreeform
:
3466 if (Prompt
!= NULL
) {
3467 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3470 if (ShellGetExecutionBreakFlag()) {
3471 Status
= EFI_ABORTED
;
3474 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3475 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3476 if (EFI_ERROR(Status
)) {
3479 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3480 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3483 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3484 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3488 // This is the location to add new prompt types.
3489 // If your new type loops remember to add ExecutionBreak support.
3495 if (Response
!= NULL
) {
3498 } else if (Buffer
!= NULL
) {
3505 if (Buffer
!= NULL
) {
3510 ShellPrintEx(-1, -1, L
"\r\n");
3515 Prompt the user and return the resultant answer to the requestor.
3517 This function is the same as ShellPromptForResponse, except that the prompt is
3518 automatically pulled from HII.
3520 @param Type What type of question is asked. This is used to filter the input
3521 to prevent invalid answers to question.
3522 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3523 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3524 @param Response Pointer to Response which will be populated upon return.
3526 @retval EFI_SUCCESS the operation was sucessful.
3527 @return other the operation failed.
3529 @sa ShellPromptForResponse
3533 ShellPromptForResponseHii (
3534 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3535 IN CONST EFI_STRING_ID HiiFormatStringId
,
3536 IN CONST EFI_HANDLE HiiFormatHandle
,
3537 IN OUT VOID
**Response
3543 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3544 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3550 Function to determin if an entire string is a valid number.
3552 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3554 @param[in] String The string to evaluate.
3555 @param[in] ForceHex TRUE - always assume hex.
3556 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3557 @param[in] TimeNumbers TRUE to allow numbers with ":", FALSE otherwise.
3559 @retval TRUE It is all numeric (dec/hex) characters.
3560 @retval FALSE There is a non-numeric character.
3564 InternalShellIsHexOrDecimalNumber (
3565 IN CONST CHAR16
*String
,
3566 IN CONST BOOLEAN ForceHex
,
3567 IN CONST BOOLEAN StopAtSpace
,
3568 IN CONST BOOLEAN TimeNumbers
3574 // chop off a single negative sign
3576 if (String
!= NULL
&& *String
== L
'-') {
3580 if (String
== NULL
) {
3585 // chop leading zeroes
3587 while(String
!= NULL
&& *String
== L
'0'){
3591 // allow '0x' or '0X', but not 'x' or 'X'
3593 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3594 if (*(String
-1) != L
'0') {
3596 // we got an x without a preceeding 0
3602 } else if (ForceHex
) {
3609 // loop through the remaining characters and use the lib function
3611 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3612 if (TimeNumbers
&& (String
[0] == L
':')) {
3616 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3620 if (!ShellIsDecimalDigitCharacter(*String
)) {
3630 Function to determine if a given filename exists.
3632 @param[in] Name Path to test.
3634 @retval EFI_SUCCESS The Path represents a file.
3635 @retval EFI_NOT_FOUND The Path does not represent a file.
3636 @retval other The path failed to open.
3641 IN CONST CHAR16
*Name
3645 EFI_SHELL_FILE_INFO
*List
;
3647 ASSERT(Name
!= NULL
);
3650 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3651 if (EFI_ERROR(Status
)) {
3655 ShellCloseFileMetaArg(&List
);
3657 return (EFI_SUCCESS
);
3661 Convert a Unicode character to upper case only if
3662 it maps to a valid small-case ASCII character.
3664 This internal function only deal with Unicode character
3665 which maps to a valid small-case ASCII character, i.e.
3666 L'a' to L'z'. For other Unicode character, the input character
3667 is returned directly.
3669 @param Char The character to convert.
3671 @retval LowerCharacter If the Char is with range L'a' to L'z'.
3672 @retval Unchanged Otherwise.
3677 InternalShellCharToUpper (
3681 if (Char
>= L
'a' && Char
<= L
'z') {
3682 return (CHAR16
) (Char
- (L
'a' - L
'A'));
3689 Convert a Unicode character to numerical value.
3691 This internal function only deal with Unicode character
3692 which maps to a valid hexadecimal ASII character, i.e.
3693 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
3694 Unicode character, the value returned does not make sense.
3696 @param Char The character to convert.
3698 @return The numerical value converted.
3703 InternalShellHexCharToUintn (
3707 if (ShellIsDecimalDigitCharacter (Char
)) {
3711 return (UINTN
) (10 + InternalShellCharToUpper (Char
) - L
'A');
3715 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
3717 This function returns a value of type UINTN by interpreting the contents
3718 of the Unicode string specified by String as a hexadecimal number.
3719 The format of the input Unicode string String is:
3721 [spaces][zeros][x][hexadecimal digits].
3723 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
3724 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
3725 If "x" appears in the input string, it must be prefixed with at least one 0.
3726 The function will ignore the pad space, which includes spaces or tab characters,
3727 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
3728 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
3729 first valid hexadecimal digit. Then, the function stops at the first character that is
3730 a not a valid hexadecimal character or NULL, whichever one comes first.
3732 If String has only pad spaces, then zero is returned.
3733 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
3734 then zero is returned.
3736 @param[in] String A pointer to a Null-terminated Unicode string.
3737 @param[out] Value Upon a successful return the value of the conversion.
3738 @param[in] StopAtSpace FALSE to skip spaces.
3740 @retval EFI_SUCCESS The conversion was successful.
3741 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3742 @retval EFI_DEVICE_ERROR An overflow occured.
3746 InternalShellStrHexToUint64 (
3747 IN CONST CHAR16
*String
,
3749 IN CONST BOOLEAN StopAtSpace
3754 if (String
== NULL
|| StrSize(String
) == 0 || Value
== NULL
) {
3755 return (EFI_INVALID_PARAMETER
);
3759 // Ignore the pad spaces (space or tab)
3761 while ((*String
== L
' ') || (*String
== L
'\t')) {
3766 // Ignore leading Zeros after the spaces
3768 while (*String
== L
'0') {
3772 if (InternalShellCharToUpper (*String
) == L
'X') {
3773 if (*(String
- 1) != L
'0') {
3785 // Skip spaces if requested
3787 while (StopAtSpace
&& *String
== L
' ') {
3791 while (ShellIsHexaDecimalDigitCharacter (*String
)) {
3793 // If the Hex Number represented by String overflows according
3794 // to the range defined by UINTN, then ASSERT().
3796 if (!(Result
<= (RShiftU64((((UINT64
) ~0) - InternalShellHexCharToUintn (*String
)), 4)))) {
3797 // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {
3798 return (EFI_DEVICE_ERROR
);
3801 Result
= (LShiftU64(Result
, 4));
3802 Result
+= InternalShellHexCharToUintn (*String
);
3806 // stop at spaces if requested
3808 if (StopAtSpace
&& *String
== L
' ') {
3814 return (EFI_SUCCESS
);
3818 Convert a Null-terminated Unicode decimal string to a value of
3821 This function returns a value of type UINT64 by interpreting the contents
3822 of the Unicode string specified by String as a decimal number. The format
3823 of the input Unicode string String is:
3825 [spaces] [decimal digits].
3827 The valid decimal digit character is in the range [0-9]. The
3828 function will ignore the pad space, which includes spaces or
3829 tab characters, before [decimal digits]. The running zero in the
3830 beginning of [decimal digits] will be ignored. Then, the function
3831 stops at the first character that is a not a valid decimal character
3832 or a Null-terminator, whichever one comes first.
3834 If String has only pad spaces, then 0 is returned.
3835 If String has no pad spaces or valid decimal digits,
3838 @param[in] String A pointer to a Null-terminated Unicode string.
3839 @param[out] Value Upon a successful return the value of the conversion.
3840 @param[in] StopAtSpace FALSE to skip spaces.
3842 @retval EFI_SUCCESS The conversion was successful.
3843 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3844 @retval EFI_DEVICE_ERROR An overflow occured.
3848 InternalShellStrDecimalToUint64 (
3849 IN CONST CHAR16
*String
,
3851 IN CONST BOOLEAN StopAtSpace
3856 if (String
== NULL
|| StrSize (String
) == 0 || Value
== NULL
) {
3857 return (EFI_INVALID_PARAMETER
);
3861 // Ignore the pad spaces (space or tab)
3863 while ((*String
== L
' ') || (*String
== L
'\t')) {
3868 // Ignore leading Zeros after the spaces
3870 while (*String
== L
'0') {
3877 // Skip spaces if requested
3879 while (StopAtSpace
&& *String
== L
' ') {
3882 while (ShellIsDecimalDigitCharacter (*String
)) {
3884 // If the number represented by String overflows according
3885 // to the range defined by UINT64, then ASSERT().
3888 if (!(Result
<= (DivU64x32((((UINT64
) ~0) - (*String
- L
'0')),10)))) {
3889 return (EFI_DEVICE_ERROR
);
3892 Result
= MultU64x32(Result
, 10) + (*String
- L
'0');
3896 // Stop at spaces if requested
3898 if (StopAtSpace
&& *String
== L
' ') {
3905 return (EFI_SUCCESS
);
3909 Function to verify and convert a string to its numerical value.
3911 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
3913 @param[in] String The string to evaluate.
3914 @param[out] Value Upon a successful return the value of the conversion.
3915 @param[in] ForceHex TRUE - always assume hex.
3916 @param[in] StopAtSpace FALSE to skip spaces.
3918 @retval EFI_SUCCESS The conversion was successful.
3919 @retval EFI_INVALID_PARAMETER String contained an invalid character.
3920 @retval EFI_NOT_FOUND String was a number, but Value was NULL.
3924 ShellConvertStringToUint64(
3925 IN CONST CHAR16
*String
,
3927 IN CONST BOOLEAN ForceHex
,
3928 IN CONST BOOLEAN StopAtSpace
3932 CONST CHAR16
*Walker
;
3938 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
, FALSE
)) {
3941 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
, FALSE
)) {
3942 return (EFI_INVALID_PARAMETER
);
3945 return (EFI_INVALID_PARAMETER
);
3950 // Chop off leading spaces
3952 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
3955 // make sure we have something left that is numeric.
3957 if (Walker
== NULL
|| *Walker
== CHAR_NULL
|| !InternalShellIsHexOrDecimalNumber(Walker
, Hex
, StopAtSpace
, FALSE
)) {
3958 return (EFI_INVALID_PARAMETER
);
3962 // do the conversion.
3964 if (Hex
|| StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
3965 Status
= InternalShellStrHexToUint64(Walker
, &RetVal
, StopAtSpace
);
3967 Status
= InternalShellStrDecimalToUint64(Walker
, &RetVal
, StopAtSpace
);
3970 if (Value
== NULL
&& !EFI_ERROR(Status
)) {
3971 return (EFI_NOT_FOUND
);
3974 if (Value
!= NULL
) {
3982 Function to determin if an entire string is a valid number.
3984 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3986 @param[in] String The string to evaluate.
3987 @param[in] ForceHex TRUE - always assume hex.
3988 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3990 @retval TRUE It is all numeric (dec/hex) characters.
3991 @retval FALSE There is a non-numeric character.
3995 ShellIsHexOrDecimalNumber (
3996 IN CONST CHAR16
*String
,
3997 IN CONST BOOLEAN ForceHex
,
3998 IN CONST BOOLEAN StopAtSpace
4001 if (ShellConvertStringToUint64(String
, NULL
, ForceHex
, StopAtSpace
) == EFI_NOT_FOUND
) {
4008 Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned
4009 buffer. The returned buffer must be callee freed.
4011 If the position upon start is 0, then the Ascii Boolean will be set. This should be
4012 maintained and not changed for all operations with the same file.
4014 @param[in] Handle SHELL_FILE_HANDLE to read from.
4015 @param[in, out] Ascii Boolean value for indicating whether the file is
4016 Ascii (TRUE) or UCS2 (FALSE).
4018 @return The line of text from the file.
4019 @retval NULL There was not enough memory available.
4021 @sa ShellFileHandleReadLine
4025 ShellFileHandleReturnLine(
4026 IN SHELL_FILE_HANDLE Handle
,
4027 IN OUT BOOLEAN
*Ascii
4037 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
4038 if (Status
== EFI_BUFFER_TOO_SMALL
) {
4039 RetVal
= AllocateZeroPool(Size
);
4040 if (RetVal
== NULL
) {
4043 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
4046 if (EFI_ERROR(Status
) && (RetVal
!= NULL
)) {
4054 Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.
4056 If the position upon start is 0, then the Ascii Boolean will be set. This should be
4057 maintained and not changed for all operations with the same file.
4059 @param[in] Handle SHELL_FILE_HANDLE to read from.
4060 @param[in, out] Buffer The pointer to buffer to read into.
4061 @param[in, out] Size The pointer to number of bytes in Buffer.
4062 @param[in] Truncate If the buffer is large enough, this has no effect.
4063 If the buffer is is too small and Truncate is TRUE,
4064 the line will be truncated.
4065 If the buffer is is too small and Truncate is FALSE,
4066 then no read will occur.
4068 @param[in, out] Ascii Boolean value for indicating whether the file is
4069 Ascii (TRUE) or UCS2 (FALSE).
4071 @retval EFI_SUCCESS The operation was successful. The line is stored in
4073 @retval EFI_INVALID_PARAMETER Handle was NULL.
4074 @retval EFI_INVALID_PARAMETER Size was NULL.
4075 @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.
4076 Size was updated to the minimum space required.
4080 ShellFileHandleReadLine(
4081 IN SHELL_FILE_HANDLE Handle
,
4082 IN OUT CHAR16
*Buffer
,
4084 IN BOOLEAN Truncate
,
4085 IN OUT BOOLEAN
*Ascii
4092 UINT64 OriginalFilePosition
;
4098 return (EFI_INVALID_PARAMETER
);
4100 if (Buffer
== NULL
) {
4103 *Buffer
= CHAR_NULL
;
4105 gEfiShellProtocol
->GetFilePosition(Handle
, &OriginalFilePosition
);
4106 if (OriginalFilePosition
== 0) {
4107 CharSize
= sizeof(CHAR16
);
4108 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4109 ASSERT_EFI_ERROR(Status
);
4110 if (CharBuffer
== gUnicodeFileTag
) {
4114 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4118 for (CountSoFar
= 0;;CountSoFar
++){
4121 CharSize
= sizeof(CHAR8
);
4123 CharSize
= sizeof(CHAR16
);
4125 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4126 if ( EFI_ERROR(Status
)
4128 || (CharBuffer
== L
'\n' && !(*Ascii
))
4129 || (CharBuffer
== '\n' && *Ascii
)
4134 // if we have space save it...
4136 if ((CountSoFar
+1)*sizeof(CHAR16
) < *Size
){
4137 ASSERT(Buffer
!= NULL
);
4138 ((CHAR16
*)Buffer
)[CountSoFar
] = CharBuffer
;
4139 ((CHAR16
*)Buffer
)[CountSoFar
+1] = CHAR_NULL
;
4144 // if we ran out of space tell when...
4146 if ((CountSoFar
+1)*sizeof(CHAR16
) > *Size
){
4147 *Size
= (CountSoFar
+1)*sizeof(CHAR16
);
4149 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4151 DEBUG((DEBUG_WARN
, "The line was truncated in ShellFileHandleReadLine"));
4153 return (EFI_BUFFER_TOO_SMALL
);
4155 while(Buffer
[StrLen(Buffer
)-1] == L
'\r') {
4156 Buffer
[StrLen(Buffer
)-1] = CHAR_NULL
;
4163 Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
4165 @param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.
4166 @param[in] SectionToGetHelpOn Pointer to the section specifier(s).
4167 @param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints
4168 the help content only.
4169 @retval EFI_DEVICE_ERROR The help data format was incorrect.
4170 @retval EFI_NOT_FOUND The help data could not be found.
4171 @retval EFI_SUCCESS The operation was successful.
4176 IN CONST CHAR16
*CommandToGetHelpOn
,
4177 IN CONST CHAR16
*SectionToGetHelpOn
,
4178 IN BOOLEAN PrintCommandText
4187 // Get the string to print based
4189 Status
= gEfiShellProtocol
->GetHelpText (CommandToGetHelpOn
, SectionToGetHelpOn
, &OutText
);
4192 // make sure we got a valid string
4194 if (EFI_ERROR(Status
)){
4197 if (OutText
== NULL
|| StrLen(OutText
) == 0) {
4198 return EFI_NOT_FOUND
;
4202 // Chop off trailing stuff we dont need
4204 while (OutText
[StrLen(OutText
)-1] == L
'\r' || OutText
[StrLen(OutText
)-1] == L
'\n' || OutText
[StrLen(OutText
)-1] == L
' ') {
4205 OutText
[StrLen(OutText
)-1] = CHAR_NULL
;
4209 // Print this out to the console
4211 if (PrintCommandText
) {
4212 ShellPrintEx(-1, -1, L
"%H%-14s%N- %s\r\n", CommandToGetHelpOn
, OutText
);
4214 ShellPrintEx(-1, -1, L
"%N%s\r\n", OutText
);
4217 SHELL_FREE_NON_NULL(OutText
);
4223 Function to delete a file by name
4225 @param[in] FileName Pointer to file name to delete.
4227 @retval EFI_SUCCESS the file was deleted sucessfully
4228 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
4230 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
4231 @retval EFI_NOT_FOUND The specified file could not be found on the
4232 device or the file system could not be found
4234 @retval EFI_NO_MEDIA The device has no medium.
4235 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
4236 medium is no longer supported.
4237 @retval EFI_DEVICE_ERROR The device reported an error.
4238 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4239 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
4240 @retval EFI_ACCESS_DENIED The file was opened read only.
4241 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
4243 @retval other The file failed to open
4247 ShellDeleteFileByName(
4248 IN CONST CHAR16
*FileName
4252 SHELL_FILE_HANDLE FileHandle
;
4254 Status
= ShellFileExists(FileName
);
4256 if (Status
== EFI_SUCCESS
){
4257 Status
= ShellOpenFileByName(FileName
, &FileHandle
, EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
, 0x0);
4258 if (Status
== EFI_SUCCESS
){
4259 Status
= ShellDeleteFile(&FileHandle
);
4268 Cleans off all the quotes in the string.
4270 @param[in] OriginalString pointer to the string to be cleaned.
4271 @param[out] CleanString The new string with all quotes removed.
4272 Memory allocated in the function and free
4275 @retval EFI_SUCCESS The operation was successful.
4279 InternalShellStripQuotes (
4280 IN CONST CHAR16
*OriginalString
,
4281 OUT CHAR16
**CleanString
4286 if (OriginalString
== NULL
|| CleanString
== NULL
) {
4287 return EFI_INVALID_PARAMETER
;
4290 *CleanString
= AllocateCopyPool (StrSize (OriginalString
), OriginalString
);
4291 if (*CleanString
== NULL
) {
4292 return EFI_OUT_OF_RESOURCES
;
4295 for (Walker
= *CleanString
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
; Walker
++) {
4296 if (*Walker
== L
'\"') {
4297 CopyMem(Walker
, Walker
+1, StrSize(Walker
) - sizeof(Walker
[0]));