2 Provides interface to shell functionality for shell commands and applications.
4 Copyright (c) 2006 - 2013, 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 and Status parameters are 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
1207 // Check for UEFI Shell 2.0 protocols
1209 if (gEfiShellProtocol
!= NULL
) {
1211 // Call UEFI Shell 2.0 version (not using Output parameter)
1213 return (gEfiShellProtocol
->Execute(ParentHandle
,
1215 EnvironmentVariables
,
1220 // Check for EFI shell
1222 if (mEfiShellEnvironment2
!= NULL
) {
1224 // Call EFI Shell version (not using EnvironmentVariables or Status parameters)
1225 // Due to oddity in the EFI shell we want to dereference the ParentHandle here
1227 return (mEfiShellEnvironment2
->Execute(*ParentHandle
,
1232 return (EFI_UNSUPPORTED
);
1235 Retreives the current directory path
1237 If the DeviceName is NULL, it returns the current device's current directory
1238 name. If the DeviceName is not NULL, it returns the current directory name
1241 @param DeviceName the name of the drive to get directory on
1243 @retval NULL the directory does not exist
1244 @return != NULL the directory
1248 ShellGetCurrentDir (
1249 IN CHAR16
* CONST DeviceName OPTIONAL
1253 // Check for UEFI Shell 2.0 protocols
1255 if (gEfiShellProtocol
!= NULL
) {
1256 return (gEfiShellProtocol
->GetCurDir(DeviceName
));
1260 // Check for EFI shell
1262 if (mEfiShellEnvironment2
!= NULL
) {
1263 return (mEfiShellEnvironment2
->CurDir(DeviceName
));
1269 sets (enabled or disabled) the page break mode
1271 when page break mode is enabled the screen will stop scrolling
1272 and wait for operator input before scrolling a subsequent screen.
1274 @param CurrentState TRUE to enable and FALSE to disable
1278 ShellSetPageBreakMode (
1279 IN BOOLEAN CurrentState
1283 // check for enabling
1285 if (CurrentState
!= 0x00) {
1287 // check for UEFI Shell 2.0
1289 if (gEfiShellProtocol
!= NULL
) {
1291 // Enable with UEFI 2.0 Shell
1293 gEfiShellProtocol
->EnablePageBreak();
1297 // Check for EFI shell
1299 if (mEfiShellEnvironment2
!= NULL
) {
1301 // Enable with EFI Shell
1303 mEfiShellEnvironment2
->EnablePageBreak (DEFAULT_INIT_ROW
, DEFAULT_AUTO_LF
);
1309 // check for UEFI Shell 2.0
1311 if (gEfiShellProtocol
!= NULL
) {
1313 // Disable with UEFI 2.0 Shell
1315 gEfiShellProtocol
->DisablePageBreak();
1319 // Check for EFI shell
1321 if (mEfiShellEnvironment2
!= NULL
) {
1323 // Disable with EFI Shell
1325 mEfiShellEnvironment2
->DisablePageBreak ();
1333 /// version of EFI_SHELL_FILE_INFO struct, except has no CONST pointers.
1334 /// This allows for the struct to be populated.
1341 SHELL_FILE_HANDLE Handle
;
1342 EFI_FILE_INFO
*Info
;
1343 } EFI_SHELL_FILE_INFO_NO_CONST
;
1346 Converts a EFI shell list of structures to the coresponding UEFI Shell 2.0 type of list.
1348 if OldStyleFileList is NULL then ASSERT()
1350 this function will convert a SHELL_FILE_ARG based list into a callee allocated
1351 EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
1352 the ShellCloseFileMetaArg function.
1354 @param[in] FileList the EFI shell list type
1355 @param[in, out] ListHead the list to add to
1357 @retval the resultant head of the double linked new format list;
1361 InternalShellConvertFileListType (
1362 IN LIST_ENTRY
*FileList
,
1363 IN OUT LIST_ENTRY
*ListHead
1366 SHELL_FILE_ARG
*OldInfo
;
1368 EFI_SHELL_FILE_INFO_NO_CONST
*NewInfo
;
1373 ASSERT(FileList
!= NULL
);
1374 ASSERT(ListHead
!= NULL
);
1377 // enumerate through each member of the old list and copy
1379 for (Link
= FileList
->ForwardLink
; Link
!= FileList
; Link
= Link
->ForwardLink
) {
1380 OldInfo
= CR (Link
, SHELL_FILE_ARG
, Link
, SHELL_FILE_ARG_SIGNATURE
);
1381 ASSERT(OldInfo
!= NULL
);
1384 // Skip ones that failed to open...
1386 if (OldInfo
->Status
!= EFI_SUCCESS
) {
1391 // make sure the old list was valid
1393 ASSERT(OldInfo
->Info
!= NULL
);
1394 ASSERT(OldInfo
->FullName
!= NULL
);
1395 ASSERT(OldInfo
->FileName
!= NULL
);
1398 // allocate a new EFI_SHELL_FILE_INFO object
1400 NewInfo
= AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1401 if (NewInfo
== NULL
) {
1402 ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO
**)(&ListHead
));
1408 // copy the simple items
1410 NewInfo
->Handle
= OldInfo
->Handle
;
1411 NewInfo
->Status
= OldInfo
->Status
;
1413 // old shell checks for 0 not NULL
1414 OldInfo
->Handle
= 0;
1417 // allocate new space to copy strings and structure
1419 NewInfo
->FullName
= AllocateZeroPool(StrSize(OldInfo
->FullName
));
1420 NewInfo
->FileName
= AllocateZeroPool(StrSize(OldInfo
->FileName
));
1421 NewInfo
->Info
= AllocateZeroPool((UINTN
)OldInfo
->Info
->Size
);
1424 // make sure all the memory allocations were sucessful
1426 if (NULL
== NewInfo
->FullName
|| NewInfo
->FileName
== NULL
|| NewInfo
->Info
== NULL
) {
1427 ShellCloseFileMetaArg((EFI_SHELL_FILE_INFO
**)(&ListHead
));
1433 // Copt the strings and structure
1435 StrCpy(NewInfo
->FullName
, OldInfo
->FullName
);
1436 StrCpy(NewInfo
->FileName
, OldInfo
->FileName
);
1437 gBS
->CopyMem (NewInfo
->Info
, OldInfo
->Info
, (UINTN
)OldInfo
->Info
->Size
);
1440 // add that to the list
1442 InsertTailList(ListHead
, &NewInfo
->Link
);
1447 Opens a group of files based on a path.
1449 This function uses the Arg to open all the matching files. Each matched
1450 file has a SHELL_FILE_ARG structure to record the file information. These
1451 structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG
1452 structures from ListHead to access each file. This function supports wildcards
1453 and will process '?' and '*' as such. the list must be freed with a call to
1454 ShellCloseFileMetaArg().
1456 If you are NOT appending to an existing list *ListHead must be NULL. If
1457 *ListHead is NULL then it must be callee freed.
1459 @param Arg pointer to path string
1460 @param OpenMode mode to open files with
1461 @param ListHead head of linked list of results
1463 @retval EFI_SUCCESS the operation was sucessful and the list head
1464 contains the list of opened files
1465 @return != EFI_SUCCESS the operation failed
1467 @sa InternalShellConvertFileListType
1471 ShellOpenFileMetaArg (
1474 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1478 LIST_ENTRY mOldStyleFileList
;
1481 // ASSERT that Arg and ListHead are not NULL
1483 ASSERT(Arg
!= NULL
);
1484 ASSERT(ListHead
!= NULL
);
1487 // Check for UEFI Shell 2.0 protocols
1489 if (gEfiShellProtocol
!= NULL
) {
1490 if (*ListHead
== NULL
) {
1491 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1492 if (*ListHead
== NULL
) {
1493 return (EFI_OUT_OF_RESOURCES
);
1495 InitializeListHead(&((*ListHead
)->Link
));
1497 Status
= gEfiShellProtocol
->OpenFileList(Arg
,
1500 if (EFI_ERROR(Status
)) {
1501 gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1503 Status
= gEfiShellProtocol
->RemoveDupInFileList(ListHead
);
1505 if (*ListHead
!= NULL
&& IsListEmpty(&(*ListHead
)->Link
)) {
1506 FreePool(*ListHead
);
1508 return (EFI_NOT_FOUND
);
1514 // Check for EFI shell
1516 if (mEfiShellEnvironment2
!= NULL
) {
1518 // make sure the list head is initialized
1520 InitializeListHead(&mOldStyleFileList
);
1523 // Get the EFI Shell list of files
1525 Status
= mEfiShellEnvironment2
->FileMetaArg(Arg
, &mOldStyleFileList
);
1526 if (EFI_ERROR(Status
)) {
1531 if (*ListHead
== NULL
) {
1532 *ListHead
= (EFI_SHELL_FILE_INFO
*)AllocateZeroPool(sizeof(EFI_SHELL_FILE_INFO
));
1533 if (*ListHead
== NULL
) {
1534 return (EFI_OUT_OF_RESOURCES
);
1536 InitializeListHead(&((*ListHead
)->Link
));
1540 // Convert that to equivalent of UEFI Shell 2.0 structure
1542 InternalShellConvertFileListType(&mOldStyleFileList
, &(*ListHead
)->Link
);
1545 // Free the EFI Shell version that was converted.
1547 mEfiShellEnvironment2
->FreeFileList(&mOldStyleFileList
);
1549 if ((*ListHead
)->Link
.ForwardLink
== (*ListHead
)->Link
.BackLink
&& (*ListHead
)->Link
.BackLink
== &((*ListHead
)->Link
)) {
1550 FreePool(*ListHead
);
1552 Status
= EFI_NOT_FOUND
;
1557 return (EFI_UNSUPPORTED
);
1560 Free the linked list returned from ShellOpenFileMetaArg.
1562 if ListHead is NULL then ASSERT().
1564 @param ListHead the pointer to free.
1566 @retval EFI_SUCCESS the operation was sucessful.
1570 ShellCloseFileMetaArg (
1571 IN OUT EFI_SHELL_FILE_INFO
**ListHead
1577 // ASSERT that ListHead is not NULL
1579 ASSERT(ListHead
!= NULL
);
1582 // Check for UEFI Shell 2.0 protocols
1584 if (gEfiShellProtocol
!= NULL
) {
1585 return (gEfiShellProtocol
->FreeFileList(ListHead
));
1586 } else if (mEfiShellEnvironment2
!= NULL
) {
1588 // Since this is EFI Shell version we need to free our internally made copy
1591 for ( Node
= GetFirstNode(&(*ListHead
)->Link
)
1592 ; *ListHead
!= NULL
&& !IsListEmpty(&(*ListHead
)->Link
)
1593 ; Node
= GetFirstNode(&(*ListHead
)->Link
)) {
1594 RemoveEntryList(Node
);
1595 ((EFI_FILE_PROTOCOL
*)((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
)->Close(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Handle
);
1596 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FullName
);
1597 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->FileName
);
1598 FreePool(((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
)->Info
);
1599 FreePool((EFI_SHELL_FILE_INFO_NO_CONST
*)Node
);
1604 return (EFI_UNSUPPORTED
);
1608 Find a file by searching the CWD and then the path.
1610 If FileName is NULL then ASSERT.
1612 If the return value is not NULL then the memory must be caller freed.
1614 @param FileName Filename string.
1616 @retval NULL the file was not found
1617 @return !NULL the full path to the file.
1622 IN CONST CHAR16
*FileName
1626 SHELL_FILE_HANDLE Handle
;
1630 CONST CHAR16
*Walker
;
1637 // First make sure its not an absolute path.
1639 Status
= ShellOpenFileByName(FileName
, &Handle
, EFI_FILE_MODE_READ
, 0);
1640 if (!EFI_ERROR(Status
)){
1641 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1642 ASSERT(RetVal
== NULL
);
1643 RetVal
= StrnCatGrow(&RetVal
, NULL
, FileName
, 0);
1644 ShellCloseFile(&Handle
);
1647 ShellCloseFile(&Handle
);
1651 Path
= ShellGetEnvironmentVariable(L
"cwd");
1653 Size
= StrSize(Path
);
1654 Size
+= StrSize(FileName
);
1655 TestPath
= AllocateZeroPool(Size
);
1656 if (TestPath
== NULL
) {
1659 StrCpy(TestPath
, Path
);
1660 StrCat(TestPath
, FileName
);
1661 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1662 if (!EFI_ERROR(Status
)){
1663 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1664 ASSERT(RetVal
== NULL
);
1665 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1666 ShellCloseFile(&Handle
);
1670 ShellCloseFile(&Handle
);
1675 Path
= ShellGetEnvironmentVariable(L
"path");
1677 Size
= StrSize(Path
)+sizeof(CHAR16
);
1678 Size
+= StrSize(FileName
);
1679 TestPath
= AllocateZeroPool(Size
);
1680 if (TestPath
== NULL
) {
1683 Walker
= (CHAR16
*)Path
;
1685 CopyMem(TestPath
, Walker
, StrSize(Walker
));
1686 if (TestPath
!= NULL
) {
1687 TempChar
= StrStr(TestPath
, L
";");
1688 if (TempChar
!= NULL
) {
1689 *TempChar
= CHAR_NULL
;
1691 if (TestPath
[StrLen(TestPath
)-1] != L
'\\') {
1692 StrCat(TestPath
, L
"\\");
1694 if (FileName
[0] == L
'\\') {
1697 StrCat(TestPath
, FileName
);
1698 if (StrStr(Walker
, L
";") != NULL
) {
1699 Walker
= StrStr(Walker
, L
";") + 1;
1703 Status
= ShellOpenFileByName(TestPath
, &Handle
, EFI_FILE_MODE_READ
, 0);
1704 if (!EFI_ERROR(Status
)){
1705 if (FileHandleIsDirectory(Handle
) != EFI_SUCCESS
) {
1706 ASSERT(RetVal
== NULL
);
1707 RetVal
= StrnCatGrow(&RetVal
, NULL
, TestPath
, 0);
1708 ShellCloseFile(&Handle
);
1711 ShellCloseFile(&Handle
);
1715 } while (Walker
!= NULL
&& Walker
[0] != CHAR_NULL
);
1722 Find a file by searching the CWD and then the path with a variable set of file
1723 extensions. If the file is not found it will append each extension in the list
1724 in the order provided and return the first one that is successful.
1726 If FileName is NULL, then ASSERT.
1727 If FileExtension is NULL, then behavior is identical to ShellFindFilePath.
1729 If the return value is not NULL then the memory must be caller freed.
1731 @param[in] FileName Filename string.
1732 @param[in] FileExtension Semi-colon delimeted list of possible extensions.
1734 @retval NULL The file was not found.
1735 @retval !NULL The path to the file.
1739 ShellFindFilePathEx (
1740 IN CONST CHAR16
*FileName
,
1741 IN CONST CHAR16
*FileExtension
1746 CONST CHAR16
*ExtensionWalker
;
1751 ASSERT(FileName
!= NULL
);
1752 if (FileExtension
== NULL
) {
1753 return (ShellFindFilePath(FileName
));
1755 RetVal
= ShellFindFilePath(FileName
);
1756 if (RetVal
!= NULL
) {
1759 Size
= StrSize(FileName
);
1760 Size
+= StrSize(FileExtension
);
1761 TestPath
= AllocateZeroPool(Size
);
1762 if (TestPath
== NULL
) {
1765 for (ExtensionWalker
= FileExtension
, TempChar2
= (CHAR16
*)FileExtension
; TempChar2
!= NULL
; ExtensionWalker
= TempChar2
+ 1){
1766 StrCpy(TestPath
, FileName
);
1767 if (ExtensionWalker
!= NULL
) {
1768 StrCat(TestPath
, ExtensionWalker
);
1770 TempChar
= StrStr(TestPath
, L
";");
1771 if (TempChar
!= NULL
) {
1772 *TempChar
= CHAR_NULL
;
1774 RetVal
= ShellFindFilePath(TestPath
);
1775 if (RetVal
!= NULL
) {
1778 ASSERT(ExtensionWalker
!= NULL
);
1779 TempChar2
= StrStr(ExtensionWalker
, L
";");
1788 SHELL_PARAM_TYPE Type
;
1790 UINTN OriginalPosition
;
1791 } SHELL_PARAM_PACKAGE
;
1794 Checks the list of valid arguments and returns TRUE if the item was found. If the
1795 return value is TRUE then the type parameter is set also.
1797 if CheckList is NULL then ASSERT();
1798 if Name is NULL then ASSERT();
1799 if Type is NULL then ASSERT();
1801 @param Name pointer to Name of parameter found
1802 @param CheckList List to check against
1803 @param Type pointer to type of parameter if it was found
1805 @retval TRUE the Parameter was found. Type is valid.
1806 @retval FALSE the Parameter was not found. Type is not valid.
1810 InternalIsOnCheckList (
1811 IN CONST CHAR16
*Name
,
1812 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1813 OUT SHELL_PARAM_TYPE
*Type
1816 SHELL_PARAM_ITEM
*TempListItem
;
1820 // ASSERT that all 3 pointer parameters aren't NULL
1822 ASSERT(CheckList
!= NULL
);
1823 ASSERT(Type
!= NULL
);
1824 ASSERT(Name
!= NULL
);
1827 // question mark and page break mode are always supported
1829 if ((StrCmp(Name
, L
"-?") == 0) ||
1830 (StrCmp(Name
, L
"-b") == 0)
1837 // Enumerate through the list
1839 for (TempListItem
= (SHELL_PARAM_ITEM
*)CheckList
; TempListItem
->Name
!= NULL
; TempListItem
++) {
1841 // If the Type is TypeStart only check the first characters of the passed in param
1842 // If it matches set the type and return TRUE
1844 if (TempListItem
->Type
== TypeStart
) {
1845 if (StrnCmp(Name
, TempListItem
->Name
, StrLen(TempListItem
->Name
)) == 0) {
1846 *Type
= TempListItem
->Type
;
1850 TempString
= StrnCatGrow(&TempString
, NULL
, Name
, StrLen(TempListItem
->Name
));
1851 if (TempString
!= NULL
) {
1852 if (StringNoCaseCompare(&TempString
, &TempListItem
->Name
) == 0) {
1853 *Type
= TempListItem
->Type
;
1854 FreePool(TempString
);
1857 FreePool(TempString
);
1859 } else if (StringNoCaseCompare(&Name
, &TempListItem
->Name
) == 0) {
1860 *Type
= TempListItem
->Type
;
1868 Checks the string for indicators of "flag" status. this is a leading '/', '-', or '+'
1870 @param[in] Name pointer to Name of parameter found
1871 @param[in] AlwaysAllowNumbers TRUE to allow numbers, FALSE to not.
1873 @retval TRUE the Parameter is a flag.
1874 @retval FALSE the Parameter not a flag.
1879 IN CONST CHAR16
*Name
,
1880 IN BOOLEAN AlwaysAllowNumbers
1884 // ASSERT that Name isn't NULL
1886 ASSERT(Name
!= NULL
);
1889 // If we accept numbers then dont return TRUE. (they will be values)
1891 if (((Name
[0] == L
'-' || Name
[0] == L
'+') && ShellIsHexaDecimalDigitCharacter(Name
[1])) && AlwaysAllowNumbers
) {
1896 // If the Name has a /, +, or - as the first character return TRUE
1898 if ((Name
[0] == L
'/') ||
1899 (Name
[0] == L
'-') ||
1908 Checks the command line arguments passed against the list of valid ones.
1910 If no initialization is required, then return RETURN_SUCCESS.
1912 @param[in] CheckList pointer to list of parameters to check
1913 @param[out] CheckPackage pointer to pointer to list checked values
1914 @param[out] ProblemParam optional pointer to pointer to unicode string for
1915 the paramater that caused failure. If used then the
1916 caller is responsible for freeing the memory.
1917 @param[in] AutoPageBreak will automatically set PageBreakEnabled for "b" parameter
1918 @param[in] Argv pointer to array of parameters
1919 @param[in] Argc Count of parameters in Argv
1920 @param[in] AlwaysAllowNumbers TRUE to allow numbers always, FALSE otherwise.
1922 @retval EFI_SUCCESS The operation completed sucessfully.
1923 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1924 @retval EFI_INVALID_PARAMETER A parameter was invalid
1925 @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was
1926 duplicated. the duplicated command line argument
1927 was returned in ProblemParam if provided.
1928 @retval EFI_NOT_FOUND a argument required a value that was missing.
1929 the invalid command line argument was returned in
1930 ProblemParam if provided.
1934 InternalCommandLineParse (
1935 IN CONST SHELL_PARAM_ITEM
*CheckList
,
1936 OUT LIST_ENTRY
**CheckPackage
,
1937 OUT CHAR16
**ProblemParam OPTIONAL
,
1938 IN BOOLEAN AutoPageBreak
,
1939 IN CONST CHAR16
**Argv
,
1941 IN BOOLEAN AlwaysAllowNumbers
1945 SHELL_PARAM_TYPE CurrentItemType
;
1946 SHELL_PARAM_PACKAGE
*CurrentItemPackage
;
1950 CONST CHAR16
*TempPointer
;
1952 CurrentItemPackage
= NULL
;
1958 // If there is only 1 item we dont need to do anything
1961 *CheckPackage
= NULL
;
1962 return (EFI_SUCCESS
);
1968 ASSERT(CheckList
!= NULL
);
1969 ASSERT(Argv
!= NULL
);
1972 // initialize the linked list
1974 *CheckPackage
= (LIST_ENTRY
*)AllocateZeroPool(sizeof(LIST_ENTRY
));
1975 if (*CheckPackage
== NULL
) {
1976 return (EFI_OUT_OF_RESOURCES
);
1979 InitializeListHead(*CheckPackage
);
1982 // loop through each of the arguments
1984 for (LoopCounter
= 0 ; LoopCounter
< Argc
; ++LoopCounter
) {
1985 if (Argv
[LoopCounter
] == NULL
) {
1987 // do nothing for NULL argv
1989 } else if (InternalIsOnCheckList(Argv
[LoopCounter
], CheckList
, &CurrentItemType
)) {
1991 // We might have leftover if last parameter didnt have optional value
1993 if (GetItemValue
!= 0) {
1995 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2000 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2001 if (CurrentItemPackage
== NULL
) {
2002 ShellCommandLineFreeVarList(*CheckPackage
);
2003 *CheckPackage
= NULL
;
2004 return (EFI_OUT_OF_RESOURCES
);
2006 CurrentItemPackage
->Name
= AllocateZeroPool(StrSize(Argv
[LoopCounter
]));
2007 if (CurrentItemPackage
->Name
== NULL
) {
2008 ShellCommandLineFreeVarList(*CheckPackage
);
2009 *CheckPackage
= NULL
;
2010 return (EFI_OUT_OF_RESOURCES
);
2012 StrCpy(CurrentItemPackage
->Name
, Argv
[LoopCounter
]);
2013 CurrentItemPackage
->Type
= CurrentItemType
;
2014 CurrentItemPackage
->OriginalPosition
= (UINTN
)(-1);
2015 CurrentItemPackage
->Value
= NULL
;
2018 // Does this flag require a value
2020 switch (CurrentItemPackage
->Type
) {
2022 // possibly trigger the next loop(s) to populate the value of this item
2028 case TypeDoubleValue
:
2033 GetItemValue
= (UINTN
)(-1);
2038 // this item has no value expected; we are done
2040 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2041 ASSERT(GetItemValue
== 0);
2044 } else if (GetItemValue
!= 0 && !InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
)) {
2045 ASSERT(CurrentItemPackage
!= NULL
);
2047 // get the item VALUE for a previous flag
2049 if (StrStr(Argv
[LoopCounter
], L
" ") == NULL
) {
2050 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
), CurrentItemPackage
->Value
);
2051 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2052 if (ValueSize
== 0) {
2053 StrCpy(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
2055 StrCat(CurrentItemPackage
->Value
, L
" ");
2056 StrCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
2058 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2061 // the parameter has spaces. must be quoted.
2063 CurrentItemPackage
->Value
= ReallocatePool(ValueSize
, ValueSize
+ StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
) + sizeof(CHAR16
) + sizeof(CHAR16
), CurrentItemPackage
->Value
);
2064 ASSERT(CurrentItemPackage
->Value
!= NULL
);
2065 if (ValueSize
== 0) {
2066 StrCpy(CurrentItemPackage
->Value
, L
"\"");
2067 StrCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
2068 StrCat(CurrentItemPackage
->Value
, L
"\"");
2070 StrCat(CurrentItemPackage
->Value
, L
" ");
2071 StrCat(CurrentItemPackage
->Value
, L
"\"");
2072 StrCat(CurrentItemPackage
->Value
, Argv
[LoopCounter
]);
2073 StrCat(CurrentItemPackage
->Value
, L
"\"");
2075 ValueSize
+= StrSize(Argv
[LoopCounter
]) + sizeof(CHAR16
);
2078 if (GetItemValue
== 0) {
2079 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2081 } else if (!InternalIsFlag(Argv
[LoopCounter
], AlwaysAllowNumbers
) ){ //|| ProblemParam == NULL) {
2083 // add this one as a non-flag
2086 TempPointer
= Argv
[LoopCounter
];
2087 if ((*TempPointer
== L
'^' && *(TempPointer
+1) == L
'-')
2088 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'/')
2089 || (*TempPointer
== L
'^' && *(TempPointer
+1) == L
'+')
2093 CurrentItemPackage
= AllocateZeroPool(sizeof(SHELL_PARAM_PACKAGE
));
2094 if (CurrentItemPackage
== NULL
) {
2095 ShellCommandLineFreeVarList(*CheckPackage
);
2096 *CheckPackage
= NULL
;
2097 return (EFI_OUT_OF_RESOURCES
);
2099 CurrentItemPackage
->Name
= NULL
;
2100 CurrentItemPackage
->Type
= TypePosition
;
2101 CurrentItemPackage
->Value
= AllocateZeroPool(StrSize(TempPointer
));
2102 if (CurrentItemPackage
->Value
== NULL
) {
2103 ShellCommandLineFreeVarList(*CheckPackage
);
2104 *CheckPackage
= NULL
;
2105 return (EFI_OUT_OF_RESOURCES
);
2107 StrCpy(CurrentItemPackage
->Value
, TempPointer
);
2108 CurrentItemPackage
->OriginalPosition
= Count
++;
2109 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2112 // this was a non-recognised flag... error!
2114 if (ProblemParam
!= NULL
) {
2115 *ProblemParam
= AllocateZeroPool(StrSize(Argv
[LoopCounter
]));
2116 if (*ProblemParam
!= NULL
) {
2117 StrCpy(*ProblemParam
, Argv
[LoopCounter
]);
2120 ShellCommandLineFreeVarList(*CheckPackage
);
2121 *CheckPackage
= NULL
;
2122 return (EFI_VOLUME_CORRUPTED
);
2125 if (GetItemValue
!= 0) {
2127 InsertHeadList(*CheckPackage
, &CurrentItemPackage
->Link
);
2130 // support for AutoPageBreak
2132 if (AutoPageBreak
&& ShellCommandLineGetFlag(*CheckPackage
, L
"-b")) {
2133 ShellSetPageBreakMode(TRUE
);
2135 return (EFI_SUCCESS
);
2139 Checks the command line arguments passed against the list of valid ones.
2140 Optionally removes NULL values first.
2142 If no initialization is required, then return RETURN_SUCCESS.
2144 @param[in] CheckList The pointer to list of parameters to check.
2145 @param[out] CheckPackage The package of checked values.
2146 @param[out] ProblemParam Optional pointer to pointer to unicode string for
2147 the paramater that caused failure.
2148 @param[in] AutoPageBreak Will automatically set PageBreakEnabled.
2149 @param[in] AlwaysAllowNumbers Will never fail for number based flags.
2151 @retval EFI_SUCCESS The operation completed sucessfully.
2152 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2153 @retval EFI_INVALID_PARAMETER A parameter was invalid.
2154 @retval EFI_VOLUME_CORRUPTED The command line was corrupt.
2155 @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One
2156 of the command line arguments was returned in
2157 ProblemParam if provided.
2158 @retval EFI_NOT_FOUND A argument required a value that was missing.
2159 The invalid command line argument was returned in
2160 ProblemParam if provided.
2164 ShellCommandLineParseEx (
2165 IN CONST SHELL_PARAM_ITEM
*CheckList
,
2166 OUT LIST_ENTRY
**CheckPackage
,
2167 OUT CHAR16
**ProblemParam OPTIONAL
,
2168 IN BOOLEAN AutoPageBreak
,
2169 IN BOOLEAN AlwaysAllowNumbers
2173 // ASSERT that CheckList and CheckPackage aren't NULL
2175 ASSERT(CheckList
!= NULL
);
2176 ASSERT(CheckPackage
!= NULL
);
2179 // Check for UEFI Shell 2.0 protocols
2181 if (gEfiShellParametersProtocol
!= NULL
) {
2182 return (InternalCommandLineParse(CheckList
,
2186 (CONST CHAR16
**) gEfiShellParametersProtocol
->Argv
,
2187 gEfiShellParametersProtocol
->Argc
,
2188 AlwaysAllowNumbers
));
2192 // ASSERT That EFI Shell is not required
2194 ASSERT (mEfiShellInterface
!= NULL
);
2195 return (InternalCommandLineParse(CheckList
,
2199 (CONST CHAR16
**) mEfiShellInterface
->Argv
,
2200 mEfiShellInterface
->Argc
,
2201 AlwaysAllowNumbers
));
2205 Frees shell variable list that was returned from ShellCommandLineParse.
2207 This function will free all the memory that was used for the CheckPackage
2208 list of postprocessed shell arguments.
2210 this function has no return value.
2212 if CheckPackage is NULL, then return
2214 @param CheckPackage the list to de-allocate
2218 ShellCommandLineFreeVarList (
2219 IN LIST_ENTRY
*CheckPackage
2225 // check for CheckPackage == NULL
2227 if (CheckPackage
== NULL
) {
2232 // for each node in the list
2234 for ( Node
= GetFirstNode(CheckPackage
)
2235 ; !IsListEmpty(CheckPackage
)
2236 ; Node
= GetFirstNode(CheckPackage
)
2239 // Remove it from the list
2241 RemoveEntryList(Node
);
2244 // if it has a name free the name
2246 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2247 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Name
);
2251 // if it has a value free the value
2253 if (((SHELL_PARAM_PACKAGE
*)Node
)->Value
!= NULL
) {
2254 FreePool(((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2258 // free the node structure
2260 FreePool((SHELL_PARAM_PACKAGE
*)Node
);
2263 // free the list head node
2265 FreePool(CheckPackage
);
2268 Checks for presence of a flag parameter
2270 flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key
2272 if CheckPackage is NULL then return FALSE.
2273 if KeyString is NULL then ASSERT()
2275 @param CheckPackage The package of parsed command line arguments
2276 @param KeyString the Key of the command line argument to check for
2278 @retval TRUE the flag is on the command line
2279 @retval FALSE the flag is not on the command line
2283 ShellCommandLineGetFlag (
2284 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2285 IN CONST CHAR16
* CONST KeyString
2292 // return FALSE for no package or KeyString is NULL
2294 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2299 // enumerate through the list of parametrs
2301 for ( Node
= GetFirstNode(CheckPackage
)
2302 ; !IsNull (CheckPackage
, Node
)
2303 ; Node
= GetNextNode(CheckPackage
, Node
)
2306 // If the Name matches, return TRUE (and there may be NULL name)
2308 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2310 // If Type is TypeStart then only compare the begining of the strings
2312 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2313 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2317 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2318 if (TempString
!= NULL
) {
2319 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2320 FreePool(TempString
);
2323 FreePool(TempString
);
2325 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2333 Returns value from command line argument.
2335 Value parameters are in the form of "-<Key> value" or "/<Key> value".
2337 If CheckPackage is NULL, then return NULL.
2339 @param[in] CheckPackage The package of parsed command line arguments.
2340 @param[in] KeyString The Key of the command line argument to check for.
2342 @retval NULL The flag is not on the command line.
2343 @retval !=NULL The pointer to unicode string of the value.
2347 ShellCommandLineGetValue (
2348 IN CONST LIST_ENTRY
*CheckPackage
,
2349 IN CHAR16
*KeyString
2356 // return NULL for no package or KeyString is NULL
2358 if (CheckPackage
== NULL
|| KeyString
== NULL
) {
2363 // enumerate through the list of parametrs
2365 for ( Node
= GetFirstNode(CheckPackage
)
2366 ; !IsNull (CheckPackage
, Node
)
2367 ; Node
= GetNextNode(CheckPackage
, Node
)
2370 // If the Name matches, return TRUE (and there may be NULL name)
2372 if (((SHELL_PARAM_PACKAGE
*)Node
)->Name
!= NULL
) {
2374 // If Type is TypeStart then only compare the begining of the strings
2376 if (((SHELL_PARAM_PACKAGE
*)Node
)->Type
== TypeStart
) {
2377 if (StrnCmp(KeyString
, ((SHELL_PARAM_PACKAGE
*)Node
)->Name
, StrLen(KeyString
)) == 0) {
2378 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2381 TempString
= StrnCatGrow(&TempString
, NULL
, KeyString
, StrLen(((SHELL_PARAM_PACKAGE
*)Node
)->Name
));
2382 if (TempString
!= NULL
) {
2383 if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2384 FreePool(TempString
);
2385 return (((SHELL_PARAM_PACKAGE
*)Node
)->Name
+ StrLen(KeyString
));
2387 FreePool(TempString
);
2389 } else if (StringNoCaseCompare(&KeyString
, &((SHELL_PARAM_PACKAGE
*)Node
)->Name
) == 0) {
2390 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2398 Returns raw value from command line argument.
2400 Raw value parameters are in the form of "value" in a specific position in the list.
2402 If CheckPackage is NULL, then return NULL.
2404 @param[in] CheckPackage The package of parsed command line arguments.
2405 @param[in] Position The position of the value.
2407 @retval NULL The flag is not on the command line.
2408 @retval !=NULL The pointer to unicode string of the value.
2412 ShellCommandLineGetRawValue (
2413 IN CONST LIST_ENTRY
* CONST CheckPackage
,
2420 // check for CheckPackage == NULL
2422 if (CheckPackage
== NULL
) {
2427 // enumerate through the list of parametrs
2429 for ( Node
= GetFirstNode(CheckPackage
)
2430 ; !IsNull (CheckPackage
, Node
)
2431 ; Node
= GetNextNode(CheckPackage
, Node
)
2434 // If the position matches, return the value
2436 if (((SHELL_PARAM_PACKAGE
*)Node
)->OriginalPosition
== Position
) {
2437 return (((SHELL_PARAM_PACKAGE
*)Node
)->Value
);
2444 returns the number of command line value parameters that were parsed.
2446 this will not include flags.
2448 @param[in] CheckPackage The package of parsed command line arguments.
2450 @retval (UINTN)-1 No parsing has ocurred
2451 @return other The number of value parameters found
2455 ShellCommandLineGetCount(
2456 IN CONST LIST_ENTRY
*CheckPackage
2462 if (CheckPackage
== NULL
) {
2465 for ( Node1
= GetFirstNode(CheckPackage
), Count
= 0
2466 ; !IsNull (CheckPackage
, Node1
)
2467 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2469 if (((SHELL_PARAM_PACKAGE
*)Node1
)->Name
== NULL
) {
2477 Determins if a parameter is duplicated.
2479 If Param is not NULL then it will point to a callee allocated string buffer
2480 with the parameter value if a duplicate is found.
2482 If CheckPackage is NULL, then ASSERT.
2484 @param[in] CheckPackage The package of parsed command line arguments.
2485 @param[out] Param Upon finding one, a pointer to the duplicated parameter.
2487 @retval EFI_SUCCESS No parameters were duplicated.
2488 @retval EFI_DEVICE_ERROR A duplicate was found.
2492 ShellCommandLineCheckDuplicate (
2493 IN CONST LIST_ENTRY
*CheckPackage
,
2500 ASSERT(CheckPackage
!= NULL
);
2502 for ( Node1
= GetFirstNode(CheckPackage
)
2503 ; !IsNull (CheckPackage
, Node1
)
2504 ; Node1
= GetNextNode(CheckPackage
, Node1
)
2506 for ( Node2
= GetNextNode(CheckPackage
, Node1
)
2507 ; !IsNull (CheckPackage
, Node2
)
2508 ; Node2
= GetNextNode(CheckPackage
, Node2
)
2510 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) {
2511 if (Param
!= NULL
) {
2513 *Param
= StrnCatGrow(Param
, NULL
, ((SHELL_PARAM_PACKAGE
*)Node1
)->Name
, 0);
2515 return (EFI_DEVICE_ERROR
);
2519 return (EFI_SUCCESS
);
2523 This is a find and replace function. Upon successful return the NewString is a copy of
2524 SourceString with each instance of FindTarget replaced with ReplaceWith.
2526 If SourceString and NewString overlap the behavior is undefined.
2528 If the string would grow bigger than NewSize it will halt and return error.
2530 @param[in] SourceString The string with source buffer.
2531 @param[in, out] NewString The string with resultant buffer.
2532 @param[in] NewSize The size in bytes of NewString.
2533 @param[in] FindTarget The string to look for.
2534 @param[in] ReplaceWith The string to replace FindTarget with.
2535 @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
2536 immediately before it.
2537 @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
2539 @retval EFI_INVALID_PARAMETER SourceString was NULL.
2540 @retval EFI_INVALID_PARAMETER NewString was NULL.
2541 @retval EFI_INVALID_PARAMETER FindTarget was NULL.
2542 @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.
2543 @retval EFI_INVALID_PARAMETER FindTarget had length < 1.
2544 @retval EFI_INVALID_PARAMETER SourceString had length < 1.
2545 @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold
2546 the new string (truncation occurred).
2547 @retval EFI_SUCCESS The string was successfully copied with replacement.
2551 ShellCopySearchAndReplace(
2552 IN CHAR16 CONST
*SourceString
,
2553 IN OUT CHAR16
*NewString
,
2555 IN CONST CHAR16
*FindTarget
,
2556 IN CONST CHAR16
*ReplaceWith
,
2557 IN CONST BOOLEAN SkipPreCarrot
,
2558 IN CONST BOOLEAN ParameterReplacing
2564 if ( (SourceString
== NULL
)
2565 || (NewString
== NULL
)
2566 || (FindTarget
== NULL
)
2567 || (ReplaceWith
== NULL
)
2568 || (StrLen(FindTarget
) < 1)
2569 || (StrLen(SourceString
) < 1)
2571 return (EFI_INVALID_PARAMETER
);
2574 if (StrStr(ReplaceWith
, L
" ") == NULL
|| !ParameterReplacing
) {
2575 Replace
= StrnCatGrow(&Replace
, NULL
, ReplaceWith
, 0);
2577 Replace
= AllocateZeroPool(StrSize(ReplaceWith
) + 2*sizeof(CHAR16
));
2578 if (Replace
!= NULL
) {
2579 UnicodeSPrint(Replace
, StrSize(ReplaceWith
) + 2*sizeof(CHAR16
), L
"\"%s\"", ReplaceWith
);
2582 if (Replace
== NULL
) {
2583 return (EFI_OUT_OF_RESOURCES
);
2585 NewString
= SetMem16(NewString
, NewSize
, CHAR_NULL
);
2586 while (*SourceString
!= CHAR_NULL
) {
2588 // if we find the FindTarget and either Skip == FALSE or Skip and we
2589 // dont have a carrot do a replace...
2591 if (StrnCmp(SourceString
, FindTarget
, StrLen(FindTarget
)) == 0
2592 && ((SkipPreCarrot
&& *(SourceString
-1) != L
'^') || !SkipPreCarrot
)
2594 SourceString
+= StrLen(FindTarget
);
2595 Size
= StrSize(NewString
);
2596 if ((Size
+ (StrLen(Replace
)*sizeof(CHAR16
))) > NewSize
) {
2598 return (EFI_BUFFER_TOO_SMALL
);
2600 StrCat(NewString
, Replace
);
2602 Size
= StrSize(NewString
);
2603 if (Size
+ sizeof(CHAR16
) > NewSize
) {
2605 return (EFI_BUFFER_TOO_SMALL
);
2607 StrnCat(NewString
, SourceString
, 1);
2612 return (EFI_SUCCESS
);
2616 Internal worker function to output a string.
2618 This function will output a string to the correct StdOut.
2620 @param[in] String The string to print out.
2622 @retval EFI_SUCCESS The operation was sucessful.
2623 @retval !EFI_SUCCESS The operation failed.
2628 IN CONST CHAR16
*String
2632 Size
= StrSize(String
) - sizeof(CHAR16
);
2634 return (EFI_SUCCESS
);
2636 if (gEfiShellParametersProtocol
!= NULL
) {
2637 return (gEfiShellProtocol
->WriteFile(gEfiShellParametersProtocol
->StdOut
, &Size
, (VOID
*)String
));
2639 if (mEfiShellInterface
!= NULL
) {
2640 if (mEfiShellInterface
->RedirArgc
== 0) {
2642 // Divide in half for old shell. Must be string length not size.
2644 Size
/=2; // Divide in half only when no redirection.
2646 return (mEfiShellInterface
->StdOut
->Write(mEfiShellInterface
->StdOut
, &Size
, (VOID
*)String
));
2649 return (EFI_UNSUPPORTED
);
2653 Print at a specific location on the screen.
2655 This function will move the cursor to a given screen location and print the specified string
2657 If -1 is specified for either the Row or Col the current screen location for BOTH
2660 if either Row or Col is out of range for the current console, then ASSERT
2661 if Format is NULL, then ASSERT
2663 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2664 the following additional flags:
2665 %N - Set output attribute to normal
2666 %H - Set output attribute to highlight
2667 %E - Set output attribute to error
2668 %B - Set output attribute to blue color
2669 %V - Set output attribute to green color
2671 Note: The background color is controlled by the shell command cls.
2673 @param[in] Col the column to print at
2674 @param[in] Row the row to print at
2675 @param[in] Format the format string
2676 @param[in] Marker the marker for the variable argument list
2678 @return EFI_SUCCESS The operation was successful.
2679 @return EFI_DEVICE_ERROR The console device reported an error.
2683 InternalShellPrintWorker(
2684 IN INT32 Col OPTIONAL
,
2685 IN INT32 Row OPTIONAL
,
2686 IN CONST CHAR16
*Format
,
2691 CHAR16
*ResumeLocation
;
2692 CHAR16
*FormatWalker
;
2693 UINTN OriginalAttribute
;
2694 CHAR16
*mPostReplaceFormat
;
2695 CHAR16
*mPostReplaceFormat2
;
2697 mPostReplaceFormat
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2698 mPostReplaceFormat2
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
2700 if (mPostReplaceFormat
== NULL
|| mPostReplaceFormat2
== NULL
) {
2701 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2702 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2703 return (EFI_OUT_OF_RESOURCES
);
2706 Status
= EFI_SUCCESS
;
2707 OriginalAttribute
= gST
->ConOut
->Mode
->Attribute
;
2710 // Back and forth each time fixing up 1 of our flags...
2712 Status
= ShellCopySearchAndReplace(Format
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%N", L
"%%N", FALSE
, FALSE
);
2713 ASSERT_EFI_ERROR(Status
);
2714 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%E", L
"%%E", FALSE
, FALSE
);
2715 ASSERT_EFI_ERROR(Status
);
2716 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%H", L
"%%H", FALSE
, FALSE
);
2717 ASSERT_EFI_ERROR(Status
);
2718 Status
= ShellCopySearchAndReplace(mPostReplaceFormat
, mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), L
"%B", L
"%%B", FALSE
, FALSE
);
2719 ASSERT_EFI_ERROR(Status
);
2720 Status
= ShellCopySearchAndReplace(mPostReplaceFormat2
, mPostReplaceFormat
, PcdGet16 (PcdShellPrintBufferSize
), L
"%V", L
"%%V", FALSE
, FALSE
);
2721 ASSERT_EFI_ERROR(Status
);
2724 // Use the last buffer from replacing to print from...
2726 UnicodeVSPrint (mPostReplaceFormat2
, PcdGet16 (PcdShellPrintBufferSize
), mPostReplaceFormat
, Marker
);
2728 if (Col
!= -1 && Row
!= -1) {
2729 Status
= gST
->ConOut
->SetCursorPosition(gST
->ConOut
, Col
, Row
);
2732 FormatWalker
= mPostReplaceFormat2
;
2733 while (*FormatWalker
!= CHAR_NULL
) {
2735 // Find the next attribute change request
2737 ResumeLocation
= StrStr(FormatWalker
, L
"%");
2738 if (ResumeLocation
!= NULL
) {
2739 *ResumeLocation
= CHAR_NULL
;
2742 // print the current FormatWalker string
2744 if (StrLen(FormatWalker
)>0) {
2745 Status
= InternalPrintTo(FormatWalker
);
2746 if (EFI_ERROR(Status
)) {
2752 // update the attribute
2754 if (ResumeLocation
!= NULL
) {
2755 if (*(ResumeLocation
-1) == L
'^') {
2757 // Move cursor back 1 position to overwrite the ^
2759 gST
->ConOut
->SetCursorPosition(gST
->ConOut
, gST
->ConOut
->Mode
->CursorColumn
- 1, gST
->ConOut
->Mode
->CursorRow
);
2762 // Print a simple '%' symbol
2764 Status
= InternalPrintTo(L
"%");
2765 ResumeLocation
= ResumeLocation
- 1;
2767 switch (*(ResumeLocation
+1)) {
2769 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2772 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_YELLOW
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2775 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_WHITE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2778 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_BLUE
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2781 gST
->ConOut
->SetAttribute(gST
->ConOut
, EFI_TEXT_ATTR(EFI_GREEN
, ((OriginalAttribute
&(BIT4
|BIT5
|BIT6
))>>4)));
2785 // Print a simple '%' symbol
2787 Status
= InternalPrintTo(L
"%");
2788 if (EFI_ERROR(Status
)) {
2791 ResumeLocation
= ResumeLocation
- 1;
2797 // reset to normal now...
2803 // update FormatWalker to Resume + 2 (skip the % and the indicator)
2805 FormatWalker
= ResumeLocation
+ 2;
2808 gST
->ConOut
->SetAttribute(gST
->ConOut
, OriginalAttribute
);
2810 SHELL_FREE_NON_NULL(mPostReplaceFormat
);
2811 SHELL_FREE_NON_NULL(mPostReplaceFormat2
);
2816 Print at a specific location on the screen.
2818 This function will move the cursor to a given screen location and print the specified string.
2820 If -1 is specified for either the Row or Col the current screen location for BOTH
2823 If either Row or Col is out of range for the current console, then ASSERT.
2824 If Format is NULL, then ASSERT.
2826 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2827 the following additional flags:
2828 %N - Set output attribute to normal
2829 %H - Set output attribute to highlight
2830 %E - Set output attribute to error
2831 %B - Set output attribute to blue color
2832 %V - Set output attribute to green color
2834 Note: The background color is controlled by the shell command cls.
2836 @param[in] Col the column to print at
2837 @param[in] Row the row to print at
2838 @param[in] Format the format string
2839 @param[in] ... The variable argument list.
2841 @return EFI_SUCCESS The printing was successful.
2842 @return EFI_DEVICE_ERROR The console device reported an error.
2847 IN INT32 Col OPTIONAL
,
2848 IN INT32 Row OPTIONAL
,
2849 IN CONST CHAR16
*Format
,
2855 if (Format
== NULL
) {
2856 return (EFI_INVALID_PARAMETER
);
2858 VA_START (Marker
, Format
);
2859 RetVal
= InternalShellPrintWorker(Col
, Row
, Format
, Marker
);
2865 Print at a specific location on the screen.
2867 This function will move the cursor to a given screen location and print the specified string.
2869 If -1 is specified for either the Row or Col the current screen location for BOTH
2872 If either Row or Col is out of range for the current console, then ASSERT.
2873 If Format is NULL, then ASSERT.
2875 In addition to the standard %-based flags as supported by UefiLib Print() this supports
2876 the following additional flags:
2877 %N - Set output attribute to normal.
2878 %H - Set output attribute to highlight.
2879 %E - Set output attribute to error.
2880 %B - Set output attribute to blue color.
2881 %V - Set output attribute to green color.
2883 Note: The background color is controlled by the shell command cls.
2885 @param[in] Col The column to print at.
2886 @param[in] Row The row to print at.
2887 @param[in] Language The language of the string to retrieve. If this parameter
2888 is NULL, then the current platform language is used.
2889 @param[in] HiiFormatStringId The format string Id for getting from Hii.
2890 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
2891 @param[in] ... The variable argument list.
2893 @return EFI_SUCCESS The printing was successful.
2894 @return EFI_DEVICE_ERROR The console device reported an error.
2899 IN INT32 Col OPTIONAL
,
2900 IN INT32 Row OPTIONAL
,
2901 IN CONST CHAR8
*Language OPTIONAL
,
2902 IN CONST EFI_STRING_ID HiiFormatStringId
,
2903 IN CONST EFI_HANDLE HiiFormatHandle
,
2908 CHAR16
*HiiFormatString
;
2911 VA_START (Marker
, HiiFormatHandle
);
2912 HiiFormatString
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, Language
);
2913 ASSERT(HiiFormatString
!= NULL
);
2915 RetVal
= InternalShellPrintWorker(Col
, Row
, HiiFormatString
, Marker
);
2917 SHELL_FREE_NON_NULL(HiiFormatString
);
2924 Function to determine if a given filename represents a file or a directory.
2926 @param[in] DirName Path to directory to test.
2928 @retval EFI_SUCCESS The Path represents a directory
2929 @retval EFI_NOT_FOUND The Path does not represent a directory
2930 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
2931 @return The path failed to open
2936 IN CONST CHAR16
*DirName
2940 SHELL_FILE_HANDLE Handle
;
2941 CHAR16
*TempLocation
;
2942 CHAR16
*TempLocation2
;
2944 ASSERT(DirName
!= NULL
);
2947 TempLocation
= NULL
;
2949 Status
= ShellOpenFileByName(DirName
, &Handle
, EFI_FILE_MODE_READ
, 0);
2950 if (EFI_ERROR(Status
)) {
2952 // try good logic first.
2954 if (gEfiShellProtocol
!= NULL
) {
2955 TempLocation
= StrnCatGrow(&TempLocation
, NULL
, DirName
, 0);
2956 if (TempLocation
== NULL
) {
2957 ShellCloseFile(&Handle
);
2958 return (EFI_OUT_OF_RESOURCES
);
2960 TempLocation2
= StrStr(TempLocation
, L
":");
2961 if (TempLocation2
!= NULL
&& StrLen(StrStr(TempLocation
, L
":")) == 2) {
2962 *(TempLocation2
+1) = CHAR_NULL
;
2964 if (gEfiShellProtocol
->GetDevicePathFromMap(TempLocation
) != NULL
) {
2965 FreePool(TempLocation
);
2966 return (EFI_SUCCESS
);
2968 FreePool(TempLocation
);
2971 // probably a map name?!?!!?
2973 TempLocation
= StrStr(DirName
, L
"\\");
2974 if (TempLocation
!= NULL
&& *(TempLocation
+1) == CHAR_NULL
) {
2975 return (EFI_SUCCESS
);
2981 if (FileHandleIsDirectory(Handle
) == EFI_SUCCESS
) {
2982 ShellCloseFile(&Handle
);
2983 return (EFI_SUCCESS
);
2985 ShellCloseFile(&Handle
);
2986 return (EFI_NOT_FOUND
);
2990 Function to determine if a given filename represents a file.
2992 @param[in] Name Path to file to test.
2994 @retval EFI_SUCCESS The Path represents a file.
2995 @retval EFI_NOT_FOUND The Path does not represent a file.
2996 @retval other The path failed to open.
3001 IN CONST CHAR16
*Name
3005 SHELL_FILE_HANDLE Handle
;
3007 ASSERT(Name
!= NULL
);
3011 Status
= ShellOpenFileByName(Name
, &Handle
, EFI_FILE_MODE_READ
, 0);
3012 if (EFI_ERROR(Status
)) {
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 This will search the CWD and then the Path.
3029 If Name is NULL, then ASSERT.
3031 @param[in] Name Path to file to test.
3033 @retval EFI_SUCCESS The Path represents a file.
3034 @retval EFI_NOT_FOUND The Path does not represent a file.
3035 @retval other The path failed to open.
3040 IN CONST CHAR16
*Name
3046 if (!EFI_ERROR(ShellIsFile(Name
))) {
3047 return (EFI_SUCCESS
);
3050 NewName
= ShellFindFilePath(Name
);
3051 if (NewName
== NULL
) {
3052 return (EFI_NOT_FOUND
);
3054 Status
= ShellIsFile(NewName
);
3060 Function return the number converted from a hex representation of a number.
3062 Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid
3063 result. Use ShellConvertStringToUint64 instead.
3065 @param[in] String String representation of a number.
3067 @return The unsigned integer result of the conversion.
3068 @retval (UINTN)(-1) An error occured.
3073 IN CONST CHAR16
*String
3078 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, TRUE
, TRUE
))) {
3079 return ((UINTN
)RetVal
);
3082 return ((UINTN
)(-1));
3086 Function to determine whether a string is decimal or hex representation of a number
3087 and return the number converted from the string. Spaces are always skipped.
3089 @param[in] String String representation of a number
3092 @retval (UINTN)(-1) An error ocurred.
3097 IN CONST CHAR16
*String
3105 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, TRUE
)) {
3109 if (!EFI_ERROR(ShellConvertStringToUint64(String
, &RetVal
, Hex
, TRUE
))) {
3110 return ((UINTN
)RetVal
);
3112 return ((UINTN
)(-1));
3116 Safely append with automatic string resizing given length of Destination and
3117 desired length of copy from Source.
3119 append the first D characters of Source to the end of Destination, where D is
3120 the lesser of Count and the StrLen() of Source. If appending those D characters
3121 will fit within Destination (whose Size is given as CurrentSize) and
3122 still leave room for a NULL terminator, then those characters are appended,
3123 starting at the original terminating NULL of Destination, and a new terminating
3126 If appending D characters onto Destination will result in a overflow of the size
3127 given in CurrentSize the string will be grown such that the copy can be performed
3128 and CurrentSize will be updated to the new size.
3130 If Source is NULL, there is nothing to append, just return the current buffer in
3133 if Destination is NULL, then ASSERT()
3134 if Destination's current length (including NULL terminator) is already more then
3135 CurrentSize, then ASSERT()
3137 @param[in, out] Destination The String to append onto
3138 @param[in, out] CurrentSize on call the number of bytes in Destination. On
3139 return possibly the new size (still in bytes). if NULL
3140 then allocate whatever is needed.
3141 @param[in] Source The String to append from
3142 @param[in] Count Maximum number of characters to append. if 0 then
3145 @return Destination return the resultant string.
3150 IN OUT CHAR16
**Destination
,
3151 IN OUT UINTN
*CurrentSize
,
3152 IN CONST CHAR16
*Source
,
3156 UINTN DestinationStartSize
;
3162 ASSERT(Destination
!= NULL
);
3165 // If there's nothing to do then just return Destination
3167 if (Source
== NULL
) {
3168 return (*Destination
);
3172 // allow for un-initialized pointers, based on size being 0
3174 if (CurrentSize
!= NULL
&& *CurrentSize
== 0) {
3175 *Destination
= NULL
;
3179 // allow for NULL pointers address as Destination
3181 if (*Destination
!= NULL
) {
3182 ASSERT(CurrentSize
!= 0);
3183 DestinationStartSize
= StrSize(*Destination
);
3184 ASSERT(DestinationStartSize
<= *CurrentSize
);
3186 DestinationStartSize
= 0;
3187 // ASSERT(*CurrentSize == 0);
3191 // Append all of Source?
3194 Count
= StrLen(Source
);
3198 // Test and grow if required
3200 if (CurrentSize
!= NULL
) {
3201 NewSize
= *CurrentSize
;
3202 if (NewSize
< DestinationStartSize
+ (Count
* sizeof(CHAR16
))) {
3203 while (NewSize
< (DestinationStartSize
+ (Count
*sizeof(CHAR16
)))) {
3204 NewSize
+= 2 * Count
* sizeof(CHAR16
);
3206 *Destination
= ReallocatePool(*CurrentSize
, NewSize
, *Destination
);
3207 *CurrentSize
= NewSize
;
3210 *Destination
= AllocateZeroPool((Count
+1)*sizeof(CHAR16
));
3214 // Now use standard StrnCat on a big enough buffer
3216 if (*Destination
== NULL
) {
3219 return StrnCat(*Destination
, Source
, Count
);
3223 Prompt the user and return the resultant answer to the requestor.
3225 This function will display the requested question on the shell prompt and then
3226 wait for an apropriate answer to be input from the console.
3228 if the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue
3229 or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.
3231 if the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type
3234 In either case *Response must be callee freed if Response was not NULL;
3236 @param Type What type of question is asked. This is used to filter the input
3237 to prevent invalid answers to question.
3238 @param Prompt Pointer to string prompt to use to request input.
3239 @param Response Pointer to Response which will be populated upon return.
3241 @retval EFI_SUCCESS The operation was sucessful.
3242 @retval EFI_UNSUPPORTED The operation is not supported as requested.
3243 @retval EFI_INVALID_PARAMETER A parameter was invalid.
3244 @return other The operation failed.
3248 ShellPromptForResponse (
3249 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3250 IN CHAR16
*Prompt OPTIONAL
,
3251 IN OUT VOID
**Response OPTIONAL
3257 SHELL_PROMPT_RESPONSE
*Resp
;
3261 Status
= EFI_UNSUPPORTED
;
3265 if (Type
!= ShellPromptResponseTypeFreeform
) {
3266 Resp
= (SHELL_PROMPT_RESPONSE
*)AllocateZeroPool(sizeof(SHELL_PROMPT_RESPONSE
));
3268 return (EFI_OUT_OF_RESOURCES
);
3273 case ShellPromptResponseTypeQuitContinue
:
3274 if (Prompt
!= NULL
) {
3275 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3278 // wait for valid response
3280 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3281 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3282 ASSERT_EFI_ERROR(Status
);
3283 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3284 if (Key
.UnicodeChar
== L
'Q' || Key
.UnicodeChar
==L
'q') {
3285 *Resp
= ShellPromptResponseQuit
;
3287 *Resp
= ShellPromptResponseContinue
;
3290 case ShellPromptResponseTypeYesNoCancel
:
3291 if (Prompt
!= NULL
) {
3292 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3295 // wait for valid response
3297 *Resp
= ShellPromptResponseMax
;
3298 while (*Resp
== ShellPromptResponseMax
) {
3299 if (ShellGetExecutionBreakFlag()) {
3300 Status
= EFI_ABORTED
;
3303 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3304 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3305 ASSERT_EFI_ERROR(Status
);
3306 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3307 switch (Key
.UnicodeChar
) {
3310 *Resp
= ShellPromptResponseYes
;
3314 *Resp
= ShellPromptResponseNo
;
3318 *Resp
= ShellPromptResponseCancel
;
3322 break; case ShellPromptResponseTypeYesNoAllCancel
:
3323 if (Prompt
!= NULL
) {
3324 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3327 // wait for valid response
3329 *Resp
= ShellPromptResponseMax
;
3330 while (*Resp
== ShellPromptResponseMax
) {
3331 if (ShellGetExecutionBreakFlag()) {
3332 Status
= EFI_ABORTED
;
3335 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3336 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3337 ASSERT_EFI_ERROR(Status
);
3338 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3339 switch (Key
.UnicodeChar
) {
3342 *Resp
= ShellPromptResponseYes
;
3346 *Resp
= ShellPromptResponseNo
;
3350 *Resp
= ShellPromptResponseAll
;
3354 *Resp
= ShellPromptResponseCancel
;
3359 case ShellPromptResponseTypeEnterContinue
:
3360 case ShellPromptResponseTypeAnyKeyContinue
:
3361 if (Prompt
!= NULL
) {
3362 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3365 // wait for valid response
3367 *Resp
= ShellPromptResponseMax
;
3368 while (*Resp
== ShellPromptResponseMax
) {
3369 if (ShellGetExecutionBreakFlag()) {
3370 Status
= EFI_ABORTED
;
3373 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3374 if (Type
== ShellPromptResponseTypeEnterContinue
) {
3375 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3376 ASSERT_EFI_ERROR(Status
);
3377 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3378 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3379 *Resp
= ShellPromptResponseContinue
;
3383 if (Type
== ShellPromptResponseTypeAnyKeyContinue
) {
3384 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3385 ASSERT_EFI_ERROR(Status
);
3386 *Resp
= ShellPromptResponseContinue
;
3391 case ShellPromptResponseTypeYesNo
:
3392 if (Prompt
!= NULL
) {
3393 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3396 // wait for valid response
3398 *Resp
= ShellPromptResponseMax
;
3399 while (*Resp
== ShellPromptResponseMax
) {
3400 if (ShellGetExecutionBreakFlag()) {
3401 Status
= EFI_ABORTED
;
3404 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3405 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3406 ASSERT_EFI_ERROR(Status
);
3407 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3408 switch (Key
.UnicodeChar
) {
3411 *Resp
= ShellPromptResponseYes
;
3415 *Resp
= ShellPromptResponseNo
;
3420 case ShellPromptResponseTypeFreeform
:
3421 if (Prompt
!= NULL
) {
3422 ShellPrintEx(-1, -1, L
"%s", Prompt
);
3425 if (ShellGetExecutionBreakFlag()) {
3426 Status
= EFI_ABORTED
;
3429 gBS
->WaitForEvent (1, &gST
->ConIn
->WaitForKey
, &EventIndex
);
3430 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
3431 ASSERT_EFI_ERROR(Status
);
3432 ShellPrintEx(-1, -1, L
"%c", Key
.UnicodeChar
);
3433 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
3436 ASSERT((Buffer
== NULL
&& Size
== 0) || (Buffer
!= NULL
));
3437 StrnCatGrow(&Buffer
, &Size
, &Key
.UnicodeChar
, 1);
3441 // This is the location to add new prompt types.
3442 // If your new type loops remember to add ExecutionBreak support.
3448 if (Response
!= NULL
) {
3451 } else if (Buffer
!= NULL
) {
3458 if (Buffer
!= NULL
) {
3463 ShellPrintEx(-1, -1, L
"\r\n");
3468 Prompt the user and return the resultant answer to the requestor.
3470 This function is the same as ShellPromptForResponse, except that the prompt is
3471 automatically pulled from HII.
3473 @param Type What type of question is asked. This is used to filter the input
3474 to prevent invalid answers to question.
3475 @param[in] HiiFormatStringId The format string Id for getting from Hii.
3476 @param[in] HiiFormatHandle The format string Handle for getting from Hii.
3477 @param Response Pointer to Response which will be populated upon return.
3479 @retval EFI_SUCCESS the operation was sucessful.
3480 @return other the operation failed.
3482 @sa ShellPromptForResponse
3486 ShellPromptForResponseHii (
3487 IN SHELL_PROMPT_REQUEST_TYPE Type
,
3488 IN CONST EFI_STRING_ID HiiFormatStringId
,
3489 IN CONST EFI_HANDLE HiiFormatHandle
,
3490 IN OUT VOID
**Response
3496 Prompt
= HiiGetString(HiiFormatHandle
, HiiFormatStringId
, NULL
);
3497 Status
= ShellPromptForResponse(Type
, Prompt
, Response
);
3503 Function to determin if an entire string is a valid number.
3505 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3507 @param[in] String The string to evaluate.
3508 @param[in] ForceHex TRUE - always assume hex.
3509 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3511 @retval TRUE It is all numeric (dec/hex) characters.
3512 @retval FALSE There is a non-numeric character.
3516 InternalShellIsHexOrDecimalNumber (
3517 IN CONST CHAR16
*String
,
3518 IN CONST BOOLEAN ForceHex
,
3519 IN CONST BOOLEAN StopAtSpace
3525 // chop off a single negative sign
3527 if (String
!= NULL
&& *String
== L
'-') {
3531 if (String
== NULL
) {
3536 // chop leading zeroes
3538 while(String
!= NULL
&& *String
== L
'0'){
3542 // allow '0x' or '0X', but not 'x' or 'X'
3544 if (String
!= NULL
&& (*String
== L
'x' || *String
== L
'X')) {
3545 if (*(String
-1) != L
'0') {
3547 // we got an x without a preceeding 0
3553 } else if (ForceHex
) {
3560 // loop through the remaining characters and use the lib function
3562 for ( ; String
!= NULL
&& *String
!= CHAR_NULL
&& !(StopAtSpace
&& *String
== L
' ') ; String
++){
3564 if (!ShellIsHexaDecimalDigitCharacter(*String
)) {
3568 if (!ShellIsDecimalDigitCharacter(*String
)) {
3578 Function to determine if a given filename exists.
3580 @param[in] Name Path to test.
3582 @retval EFI_SUCCESS The Path represents a file.
3583 @retval EFI_NOT_FOUND The Path does not represent a file.
3584 @retval other The path failed to open.
3589 IN CONST CHAR16
*Name
3593 EFI_SHELL_FILE_INFO
*List
;
3595 ASSERT(Name
!= NULL
);
3598 Status
= ShellOpenFileMetaArg((CHAR16
*)Name
, EFI_FILE_MODE_READ
, &List
);
3599 if (EFI_ERROR(Status
)) {
3603 ShellCloseFileMetaArg(&List
);
3605 return (EFI_SUCCESS
);
3609 Convert a Unicode character to upper case only if
3610 it maps to a valid small-case ASCII character.
3612 This internal function only deal with Unicode character
3613 which maps to a valid small-case ASCII character, i.e.
3614 L'a' to L'z'. For other Unicode character, the input character
3615 is returned directly.
3617 @param Char The character to convert.
3619 @retval LowerCharacter If the Char is with range L'a' to L'z'.
3620 @retval Unchanged Otherwise.
3625 InternalShellCharToUpper (
3629 if (Char
>= L
'a' && Char
<= L
'z') {
3630 return (CHAR16
) (Char
- (L
'a' - L
'A'));
3637 Convert a Unicode character to numerical value.
3639 This internal function only deal with Unicode character
3640 which maps to a valid hexadecimal ASII character, i.e.
3641 L'0' to L'9', L'a' to L'f' or L'A' to L'F'. For other
3642 Unicode character, the value returned does not make sense.
3644 @param Char The character to convert.
3646 @return The numerical value converted.
3651 InternalShellHexCharToUintn (
3655 if (ShellIsDecimalDigitCharacter (Char
)) {
3659 return (UINTN
) (10 + InternalShellCharToUpper (Char
) - L
'A');
3663 Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.
3665 This function returns a value of type UINTN by interpreting the contents
3666 of the Unicode string specified by String as a hexadecimal number.
3667 The format of the input Unicode string String is:
3669 [spaces][zeros][x][hexadecimal digits].
3671 The valid hexadecimal digit character is in the range [0-9], [a-f] and [A-F].
3672 The prefix "0x" is optional. Both "x" and "X" is allowed in "0x" prefix.
3673 If "x" appears in the input string, it must be prefixed with at least one 0.
3674 The function will ignore the pad space, which includes spaces or tab characters,
3675 before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or
3676 [hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the
3677 first valid hexadecimal digit. Then, the function stops at the first character that is
3678 a not a valid hexadecimal character or NULL, whichever one comes first.
3680 If String has only pad spaces, then zero is returned.
3681 If String has no leading pad spaces, leading zeros or valid hexadecimal digits,
3682 then zero is returned.
3684 @param[in] String A pointer to a Null-terminated Unicode string.
3685 @param[out] Value Upon a successful return the value of the conversion.
3686 @param[in] StopAtSpace FALSE to skip spaces.
3688 @retval EFI_SUCCESS The conversion was successful.
3689 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3690 @retval EFI_DEVICE_ERROR An overflow occured.
3694 InternalShellStrHexToUint64 (
3695 IN CONST CHAR16
*String
,
3697 IN CONST BOOLEAN StopAtSpace
3702 if (String
== NULL
|| StrSize(String
) == 0 || Value
== NULL
) {
3703 return (EFI_INVALID_PARAMETER
);
3707 // Ignore the pad spaces (space or tab)
3709 while ((*String
== L
' ') || (*String
== L
'\t')) {
3714 // Ignore leading Zeros after the spaces
3716 while (*String
== L
'0') {
3720 if (InternalShellCharToUpper (*String
) == L
'X') {
3721 if (*(String
- 1) != L
'0') {
3733 // Skip spaces if requested
3735 while (StopAtSpace
&& *String
== L
' ') {
3739 while (ShellIsHexaDecimalDigitCharacter (*String
)) {
3741 // If the Hex Number represented by String overflows according
3742 // to the range defined by UINTN, then ASSERT().
3744 if (!(Result
<= (RShiftU64((((UINT64
) ~0) - InternalShellHexCharToUintn (*String
)), 4)))) {
3745 // if (!(Result <= ((((UINT64) ~0) - InternalShellHexCharToUintn (*String)) >> 4))) {
3746 return (EFI_DEVICE_ERROR
);
3749 Result
= (LShiftU64(Result
, 4));
3750 Result
+= InternalShellHexCharToUintn (*String
);
3754 // stop at spaces if requested
3756 if (StopAtSpace
&& *String
== L
' ') {
3762 return (EFI_SUCCESS
);
3766 Convert a Null-terminated Unicode decimal string to a value of
3769 This function returns a value of type UINT64 by interpreting the contents
3770 of the Unicode string specified by String as a decimal number. The format
3771 of the input Unicode string String is:
3773 [spaces] [decimal digits].
3775 The valid decimal digit character is in the range [0-9]. The
3776 function will ignore the pad space, which includes spaces or
3777 tab characters, before [decimal digits]. The running zero in the
3778 beginning of [decimal digits] will be ignored. Then, the function
3779 stops at the first character that is a not a valid decimal character
3780 or a Null-terminator, whichever one comes first.
3782 If String has only pad spaces, then 0 is returned.
3783 If String has no pad spaces or valid decimal digits,
3786 @param[in] String A pointer to a Null-terminated Unicode string.
3787 @param[out] Value Upon a successful return the value of the conversion.
3788 @param[in] StopAtSpace FALSE to skip spaces.
3790 @retval EFI_SUCCESS The conversion was successful.
3791 @retval EFI_INVALID_PARAMETER A parameter was NULL or invalid.
3792 @retval EFI_DEVICE_ERROR An overflow occured.
3796 InternalShellStrDecimalToUint64 (
3797 IN CONST CHAR16
*String
,
3799 IN CONST BOOLEAN StopAtSpace
3804 if (String
== NULL
|| StrSize (String
) == 0 || Value
== NULL
) {
3805 return (EFI_INVALID_PARAMETER
);
3809 // Ignore the pad spaces (space or tab)
3811 while ((*String
== L
' ') || (*String
== L
'\t')) {
3816 // Ignore leading Zeros after the spaces
3818 while (*String
== L
'0') {
3825 // Skip spaces if requested
3827 while (StopAtSpace
&& *String
== L
' ') {
3830 while (ShellIsDecimalDigitCharacter (*String
)) {
3832 // If the number represented by String overflows according
3833 // to the range defined by UINT64, then ASSERT().
3836 if (!(Result
<= (DivU64x32((((UINT64
) ~0) - (*String
- L
'0')),10)))) {
3837 return (EFI_DEVICE_ERROR
);
3840 Result
= MultU64x32(Result
, 10) + (*String
- L
'0');
3844 // Stop at spaces if requested
3846 if (StopAtSpace
&& *String
== L
' ') {
3853 return (EFI_SUCCESS
);
3857 Function to verify and convert a string to its numerical value.
3859 If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.
3861 @param[in] String The string to evaluate.
3862 @param[out] Value Upon a successful return the value of the conversion.
3863 @param[in] ForceHex TRUE - always assume hex.
3864 @param[in] StopAtSpace FALSE to skip spaces.
3866 @retval EFI_SUCCESS The conversion was successful.
3867 @retval EFI_INVALID_PARAMETER String contained an invalid character.
3868 @retval EFI_NOT_FOUND String was a number, but Value was NULL.
3872 ShellConvertStringToUint64(
3873 IN CONST CHAR16
*String
,
3875 IN CONST BOOLEAN ForceHex
,
3876 IN CONST BOOLEAN StopAtSpace
3880 CONST CHAR16
*Walker
;
3886 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3889 if (!InternalShellIsHexOrDecimalNumber(String
, Hex
, StopAtSpace
)) {
3890 return (EFI_INVALID_PARAMETER
);
3893 return (EFI_INVALID_PARAMETER
);
3898 // Chop off leading spaces
3900 for (Walker
= String
; Walker
!= NULL
&& *Walker
!= CHAR_NULL
&& *Walker
== L
' '; Walker
++);
3903 // make sure we have something left that is numeric.
3905 if (Walker
== NULL
|| *Walker
== CHAR_NULL
|| !InternalShellIsHexOrDecimalNumber(Walker
, Hex
, StopAtSpace
)) {
3906 return (EFI_INVALID_PARAMETER
);
3910 // do the conversion.
3912 if (Hex
|| StrnCmp(Walker
, L
"0x", 2) == 0 || StrnCmp(Walker
, L
"0X", 2) == 0){
3913 Status
= InternalShellStrHexToUint64(Walker
, &RetVal
, StopAtSpace
);
3915 Status
= InternalShellStrDecimalToUint64(Walker
, &RetVal
, StopAtSpace
);
3918 if (Value
== NULL
&& !EFI_ERROR(Status
)) {
3919 return (EFI_NOT_FOUND
);
3922 if (Value
!= NULL
) {
3930 Function to determin if an entire string is a valid number.
3932 If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.
3934 @param[in] String The string to evaluate.
3935 @param[in] ForceHex TRUE - always assume hex.
3936 @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.
3938 @retval TRUE It is all numeric (dec/hex) characters.
3939 @retval FALSE There is a non-numeric character.
3943 ShellIsHexOrDecimalNumber (
3944 IN CONST CHAR16
*String
,
3945 IN CONST BOOLEAN ForceHex
,
3946 IN CONST BOOLEAN StopAtSpace
3949 if (ShellConvertStringToUint64(String
, NULL
, ForceHex
, StopAtSpace
) == EFI_NOT_FOUND
) {
3956 Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned
3957 buffer. The returned buffer must be callee freed.
3959 If the position upon start is 0, then the Ascii Boolean will be set. This should be
3960 maintained and not changed for all operations with the same file.
3962 @param[in] Handle SHELL_FILE_HANDLE to read from.
3963 @param[in, out] Ascii Boolean value for indicating whether the file is
3964 Ascii (TRUE) or UCS2 (FALSE).
3966 @return The line of text from the file.
3967 @retval NULL There was not enough memory available.
3969 @sa ShellFileHandleReadLine
3973 ShellFileHandleReturnLine(
3974 IN SHELL_FILE_HANDLE Handle
,
3975 IN OUT BOOLEAN
*Ascii
3985 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
3986 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3987 RetVal
= AllocateZeroPool(Size
);
3988 if (RetVal
== NULL
) {
3991 Status
= ShellFileHandleReadLine(Handle
, RetVal
, &Size
, FALSE
, Ascii
);
3994 if (EFI_ERROR(Status
) && (RetVal
!= NULL
)) {
4002 Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.
4004 If the position upon start is 0, then the Ascii Boolean will be set. This should be
4005 maintained and not changed for all operations with the same file.
4007 @param[in] Handle SHELL_FILE_HANDLE to read from.
4008 @param[in, out] Buffer The pointer to buffer to read into.
4009 @param[in, out] Size The pointer to number of bytes in Buffer.
4010 @param[in] Truncate If the buffer is large enough, this has no effect.
4011 If the buffer is is too small and Truncate is TRUE,
4012 the line will be truncated.
4013 If the buffer is is too small and Truncate is FALSE,
4014 then no read will occur.
4016 @param[in, out] Ascii Boolean value for indicating whether the file is
4017 Ascii (TRUE) or UCS2 (FALSE).
4019 @retval EFI_SUCCESS The operation was successful. The line is stored in
4021 @retval EFI_INVALID_PARAMETER Handle was NULL.
4022 @retval EFI_INVALID_PARAMETER Size was NULL.
4023 @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.
4024 Size was updated to the minimum space required.
4028 ShellFileHandleReadLine(
4029 IN SHELL_FILE_HANDLE Handle
,
4030 IN OUT CHAR16
*Buffer
,
4032 IN BOOLEAN Truncate
,
4033 IN OUT BOOLEAN
*Ascii
4040 UINT64 OriginalFilePosition
;
4046 return (EFI_INVALID_PARAMETER
);
4048 if (Buffer
== NULL
) {
4051 *Buffer
= CHAR_NULL
;
4053 gEfiShellProtocol
->GetFilePosition(Handle
, &OriginalFilePosition
);
4054 if (OriginalFilePosition
== 0) {
4055 CharSize
= sizeof(CHAR16
);
4056 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4057 ASSERT_EFI_ERROR(Status
);
4058 if (CharBuffer
== gUnicodeFileTag
) {
4062 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4066 for (CountSoFar
= 0;;CountSoFar
++){
4069 CharSize
= sizeof(CHAR8
);
4071 CharSize
= sizeof(CHAR16
);
4073 Status
= gEfiShellProtocol
->ReadFile(Handle
, &CharSize
, &CharBuffer
);
4074 if ( EFI_ERROR(Status
)
4076 || (CharBuffer
== L
'\n' && !(*Ascii
))
4077 || (CharBuffer
== '\n' && *Ascii
)
4082 // if we have space save it...
4084 if ((CountSoFar
+1)*sizeof(CHAR16
) < *Size
){
4085 ASSERT(Buffer
!= NULL
);
4086 ((CHAR16
*)Buffer
)[CountSoFar
] = CharBuffer
;
4087 ((CHAR16
*)Buffer
)[CountSoFar
+1] = CHAR_NULL
;
4092 // if we ran out of space tell when...
4094 if ((CountSoFar
+1)*sizeof(CHAR16
) > *Size
){
4095 *Size
= (CountSoFar
+1)*sizeof(CHAR16
);
4097 gEfiShellProtocol
->SetFilePosition(Handle
, OriginalFilePosition
);
4099 DEBUG((DEBUG_WARN
, "The line was truncated in ShellFileHandleReadLine"));
4101 return (EFI_BUFFER_TOO_SMALL
);
4103 while(Buffer
[StrLen(Buffer
)-1] == L
'\r') {
4104 Buffer
[StrLen(Buffer
)-1] = CHAR_NULL
;
4111 Function to print help file / man page content in the spec from the UEFI Shell protocol GetHelpText function.
4113 @param[in] CommandToGetHelpOn Pointer to a string containing the command name of help file to be printed.
4114 @param[in] SectionToGetHelpOn Pointer to the section specifier(s).
4115 @param[in] PrintCommandText If TRUE, prints the command followed by the help content, otherwise prints
4116 the help content only.
4117 @retval EFI_DEVICE_ERROR The help data format was incorrect.
4118 @retval EFI_NOT_FOUND The help data could not be found.
4119 @retval EFI_SUCCESS The operation was successful.
4124 IN CONST CHAR16
*CommandToGetHelpOn
,
4125 IN CONST CHAR16
*SectionToGetHelpOn
,
4126 IN BOOLEAN PrintCommandText
4135 // Get the string to print based
4137 Status
= gEfiShellProtocol
->GetHelpText (CommandToGetHelpOn
, SectionToGetHelpOn
, &OutText
);
4140 // make sure we got a valid string
4142 if (EFI_ERROR(Status
)){
4145 if (OutText
== NULL
|| StrLen(OutText
) == 0) {
4146 return EFI_NOT_FOUND
;
4150 // Chop off trailing stuff we dont need
4152 while (OutText
[StrLen(OutText
)-1] == L
'\r' || OutText
[StrLen(OutText
)-1] == L
'\n' || OutText
[StrLen(OutText
)-1] == L
' ') {
4153 OutText
[StrLen(OutText
)-1] = CHAR_NULL
;
4157 // Print this out to the console
4159 if (PrintCommandText
) {
4160 ShellPrintEx(-1, -1, L
"%H%-14s%N- %s\r\n", CommandToGetHelpOn
, OutText
);
4162 ShellPrintEx(-1, -1, L
"%N%s\r\n", OutText
);
4165 SHELL_FREE_NON_NULL(OutText
);
4171 Function to delete a file by name
4173 @param[in] FileName Pointer to file name to delete.
4175 @retval EFI_SUCCESS the file was deleted sucessfully
4176 @retval EFI_WARN_DELETE_FAILURE the handle was closed, but the file was not
4178 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
4179 @retval EFI_NOT_FOUND The specified file could not be found on the
4180 device or the file system could not be found
4182 @retval EFI_NO_MEDIA The device has no medium.
4183 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the
4184 medium is no longer supported.
4185 @retval EFI_DEVICE_ERROR The device reported an error.
4186 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4187 @retval EFI_WRITE_PROTECTED The file or medium is write protected.
4188 @retval EFI_ACCESS_DENIED The file was opened read only.
4189 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the
4191 @retval other The file failed to open
4195 ShellDeleteFileByName(
4196 IN CONST CHAR16
*FileName
4200 SHELL_FILE_HANDLE FileHandle
;
4202 Status
= ShellFileExists(FileName
);
4204 if (Status
== EFI_SUCCESS
){
4205 Status
= ShellOpenFileByName(FileName
, &FileHandle
, EFI_FILE_MODE_READ
| EFI_FILE_MODE_WRITE
| EFI_FILE_MODE_CREATE
, 0x0);
4206 if (Status
== EFI_SUCCESS
){
4207 Status
= ShellDeleteFile(&FileHandle
);