2 Member functions of EFI_SHELL_PROTOCOL and functions for creation,
3 manipulation, and initialization of EFI_SHELL_PROTOCOL.
5 Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef _SHELL_PROTOCOL_HEADER_
17 #define _SHELL_PROTOCOL_HEADER_
20 #include <ShellBase.h>
22 #include <Guid/ShellVariableGuid.h>
23 #include <Guid/ShellMapGuid.h>
24 #include <Guid/ShellAliasGuid.h>
26 #include <Protocol/EfiShell.h>
27 #include <Protocol/EfiShellParameters.h>
28 #include <Protocol/SimpleFileSystem.h>
29 #include <Protocol/DevicePathToText.h>
30 #include <Protocol/ComponentName2.h>
31 #include <Protocol/LoadedImage.h>
32 #include <Protocol/UnicodeCollation.h>
33 #include <Protocol/DevicePath.h>
34 #include <Protocol/SimpleTextInEx.h>
36 #include <Library/UefiBootServicesTableLib.h>
37 #include <Library/BaseLib.h>
38 #include <Library/ShellCommandLib.h>
39 #include <Library/PrintLib.h>
40 #include <Library/DevicePathLib.h>
41 #include <Library/UefiRuntimeServicesTableLib.h>
42 #include <Library/DebugLib.h>
43 #include <Library/MemoryAllocationLib.h>
44 #include <Library/BaseMemoryLib.h>
45 #include <Library/UefiLib.h>
46 #include <Library/SortLib.h>
47 #include <Library/PcdLib.h>
48 #include <Library/ShellLib.h>
50 #include "FileHandleWrappers.h"
51 #include "ShellEnvVar.h"
52 #include "ShellManParser.h"
56 EFI_SHELL_PROTOCOL
*Interface
;
58 } SHELL_PROTOCOL_HANDLE_LIST
;
61 #define SHELL_MAP_FLAGS_CONSIST BIT1
64 Function to create and install on the current handle.
66 Will overwrite any existing ShellProtocols in the system to be sure that
67 the current shell is in control.
69 This must be removed via calling CleanUpShellProtocol().
71 @param[in,out] NewShell The pointer to the pointer to the structure
74 @retval EFI_SUCCESS The operation was successful.
75 @return An error from LocateHandle, CreateEvent, or other core function.
79 CreatePopulateInstallShellProtocol (
80 IN OUT EFI_SHELL_PROTOCOL
**NewShell
84 Opposite of CreatePopulateInstallShellProtocol.
86 Free all memory and restore the system to the state it was in before calling
87 CreatePopulateInstallShellProtocol.
89 @param[in,out] NewShell The pointer to the new shell protocol structure.
91 @retval EFI_SUCCESS The operation was successful.
95 CleanUpShellProtocol (
96 IN OUT EFI_SHELL_PROTOCOL
*NewShell
100 This function creates a mapping for a device path.
102 @param DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,
103 then the mapping will be deleted.
104 @param Mapping Points to the NULL-terminated mapping for the device path. Must end with a ':'
106 @retval EFI_SUCCESS Mapping created or deleted successfully.
107 @retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the
108 boot service function LocateDevicePath().
109 @retval EFI_ACCESS_DENIED The mapping is a built-in alias.
110 @retval EFI_INVALID_PARAMETER Mapping was NULL
111 @retval EFI_INVALID_PARAMETER Mapping did not end with a ':'
112 @retval EFI_INVALID_PARAMETER DevicePath was not pointing at a device that had a SIMPLE_FILE_SYSTEM_PROTOCOL installed.
113 @retval EFI_NOT_FOUND There was no mapping found to delete
114 @retval EFI_OUT_OF_RESOURCES Memory allocation failed
119 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath OPTIONAL
,
120 IN CONST CHAR16
*Mapping
124 Gets the device path from the mapping.
126 This function gets the device path associated with a mapping.
128 @param Mapping A pointer to the mapping
130 @retval !=NULL Pointer to the device path that corresponds to the
131 device mapping. The returned pointer does not need
133 @retval NULL There is no device path associated with the
136 CONST EFI_DEVICE_PATH_PROTOCOL
*
138 EfiShellGetDevicePathFromMap(
139 IN CONST CHAR16
*Mapping
143 Gets the mapping that most closely matches the device path.
145 This function gets the mapping which corresponds to the device path *DevicePath. If
146 there is no exact match, then the mapping which most closely matches *DevicePath
147 is returned, and *DevicePath is updated to point to the remaining portion of the
148 device path. If there is an exact match, the mapping is returned and *DevicePath
149 points to the end-of-device-path node.
151 @param DevicePath On entry, points to a device path pointer. On
152 exit, updates the pointer to point to the
153 portion of the device path after the mapping.
155 @retval NULL No mapping was found.
156 @return !=NULL Pointer to NULL-terminated mapping. The buffer
157 is callee allocated and should be freed by the caller.
161 EfiShellGetMapFromDevicePath(
162 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
166 Converts a device path to a file system-style path.
168 This function converts a device path to a file system path by replacing part, or all, of
169 the device path with the file-system mapping. If there are more than one application
170 file system mappings, the one that most closely matches Path will be used.
172 @param Path The pointer to the device path
174 @retval NULL the device path could not be found.
175 @return all The pointer of the NULL-terminated file path. The path
176 is callee-allocated and should be freed by the caller.
180 EfiShellGetFilePathFromDevicePath(
181 IN CONST EFI_DEVICE_PATH_PROTOCOL
*Path
185 Converts a file system style name to a device path.
187 This function converts a file system style name to a device path, by replacing any
188 mapping references to the associated device path.
190 @param Path the pointer to the path
192 @return all The pointer of the file path. The file path is callee
193 allocated and should be freed by the caller.
195 EFI_DEVICE_PATH_PROTOCOL
*
197 EfiShellGetDevicePathFromFilePath(
198 IN CONST CHAR16
*Path
202 Gets the name of the device specified by the device handle.
204 This function gets the user-readable name of the device specified by the device
205 handle. If no user-readable name could be generated, then *BestDeviceName will be
206 NULL and EFI_NOT_FOUND will be returned.
208 If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the
209 device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on
212 If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the
213 device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.
214 If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and
215 EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then
216 EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.
218 @param DeviceHandle The handle of the device.
219 @param Flags Determines the possible sources of component names.
221 EFI_DEVICE_NAME_USE_COMPONENT_NAME
222 EFI_DEVICE_NAME_USE_DEVICE_PATH
223 @param Language A pointer to the language specified for the device
224 name, in the same format as described in the UEFI
225 specification, Appendix M
226 @param BestDeviceName On return, points to the callee-allocated NULL-
227 terminated name of the device. If no device name
228 could be found, points to NULL. The name must be
229 freed by the caller...
231 @retval EFI_SUCCESS Get the name successfully.
232 @retval EFI_NOT_FOUND Fail to get the device name.
233 @retval EFI_INVALID_PARAMETER Flags did not have a valid bit set.
234 @retval EFI_INVALID_PARAMETER BestDeviceName was NULL
235 @retval EFI_INVALID_PARAMETER DeviceHandle was NULL
239 EfiShellGetDeviceName(
240 IN EFI_HANDLE DeviceHandle
,
241 IN EFI_SHELL_DEVICE_NAME_FLAGS Flags
,
243 OUT CHAR16
**BestDeviceName
247 Opens the root directory of a device on a handle
249 This function opens the root directory of a device and returns a file handle to it.
251 @param DeviceHandle The handle of the device that contains the volume.
252 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
255 @retval EFI_SUCCESS Root opened successfully.
256 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
258 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
259 @retval EFI_DEVICE_ERROR The device had an error
263 EfiShellOpenRootByHandle(
264 IN EFI_HANDLE DeviceHandle
,
265 OUT SHELL_FILE_HANDLE
*FileHandle
269 Opens the root directory of a device.
271 This function opens the root directory of a device and returns a file handle to it.
273 @param DevicePath Points to the device path corresponding to the device where the
274 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
275 @param FileHandle On exit, points to the file handle corresponding to the root directory on the
278 @retval EFI_SUCCESS Root opened successfully.
279 @retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory
281 @retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.
282 @retval EFI_DEVICE_ERROR The device had an error
287 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
288 OUT SHELL_FILE_HANDLE
*FileHandle
292 Returns whether any script files are currently being processed.
294 @retval TRUE There is at least one script file active.
295 @retval FALSE No script files are active now.
300 EfiShellBatchIsActive (
305 Worker function to open a file based on a device path. this will open the root
306 of the volume and then traverse down to the file itself.
308 @param DevicePath2 Device Path of the file
309 @param FileHandle Pointer to the file upon a successful return
310 @param OpenMode mode to open file in.
311 @param Attributes the File Attributes to use when creating a new file
313 @retval EFI_SUCCESS the file is open and FileHandle is valid
314 @retval EFI_UNSUPPORTED the device path cotained non-path elements
315 @retval other an error ocurred.
319 InternalOpenFileDevicePath(
320 IN OUT EFI_DEVICE_PATH_PROTOCOL
*DevicePath2
,
321 OUT SHELL_FILE_HANDLE
*FileHandle
,
323 IN UINT64 Attributes OPTIONAL
327 Creates a file or directory by name.
329 This function creates an empty new file or directory with the specified attributes and
330 returns the new file's handle. If the file already exists and is read-only, then
331 EFI_INVALID_PARAMETER will be returned.
333 If the file already existed, it is truncated and its attributes updated. If the file is
334 created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.
336 If the file name begins with >v, then the file handle which is returned refers to the
337 shell environment variable with the specified name. If the shell environment variable
338 already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.
340 @param FileName Pointer to NULL-terminated file path
341 @param FileAttribs The new file's attrbiutes. the different attributes are
342 described in EFI_FILE_PROTOCOL.Open().
343 @param FileHandle On return, points to the created file handle or directory's handle
345 @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.
346 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
347 @retval EFI_UNSUPPORTED could not open the file path
348 @retval EFI_NOT_FOUND the specified file could not be found on the devide, or could not
349 file the file system on the device.
350 @retval EFI_NO_MEDIA the device has no medium.
351 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
353 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
355 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
356 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
357 when the media is write-protected.
358 @retval EFI_ACCESS_DENIED The service denied access to the file.
359 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.
360 @retval EFI_VOLUME_FULL The volume is full.
365 IN CONST CHAR16
*FileName
,
366 IN UINT64 FileAttribs
,
367 OUT SHELL_FILE_HANDLE
*FileHandle
371 Opens a file or a directory by file name.
373 This function opens the specified file in the specified OpenMode and returns a file
375 If the file name begins with >v, then the file handle which is returned refers to the
376 shell environment variable with the specified name. If the shell environment variable
377 exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then
378 EFI_INVALID_PARAMETER is returned.
380 If the file name is >i, then the file handle which is returned refers to the standard
381 input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER
384 If the file name is >o, then the file handle which is returned refers to the standard
385 output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
388 If the file name is >e, then the file handle which is returned refers to the standard
389 error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER
392 If the file name is NUL, then the file handle that is returned refers to the standard NUL
393 file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is
396 If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the
399 @param FileName Points to the NULL-terminated UCS-2 encoded file name.
400 @param FileHandle On return, points to the file handle.
401 @param OpenMode File open mode. Either EFI_FILE_MODE_READ or
402 EFI_FILE_MODE_WRITE from section 12.4 of the UEFI
404 @retval EFI_SUCCESS The file was opened. FileHandle has the opened file's handle.
405 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value. FileHandle is NULL.
406 @retval EFI_UNSUPPORTED Could not open the file path. FileHandle is NULL.
407 @retval EFI_NOT_FOUND The specified file could not be found on the device or the file
408 system could not be found on the device. FileHandle is NULL.
409 @retval EFI_NO_MEDIA The device has no medium. FileHandle is NULL.
410 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
411 longer supported. FileHandle is NULL.
412 @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according
413 the FileName. FileHandle is NULL.
414 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted. FileHandle is NULL.
415 @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write
416 when the media is write-protected. FileHandle is NULL.
417 @retval EFI_ACCESS_DENIED The service denied access to the file. FileHandle is NULL.
418 @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file. FileHandle
420 @retval EFI_VOLUME_FULL The volume is full. FileHandle is NULL.
424 EfiShellOpenFileByName(
425 IN CONST CHAR16
*FileName
,
426 OUT SHELL_FILE_HANDLE
*FileHandle
,
431 Deletes the file specified by the file name.
433 This function deletes a file.
435 @param FileName Points to the NULL-terminated file name.
437 @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.
438 @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.
439 @sa EfiShellCreateFile
444 EfiShellDeleteFileByName(
445 IN CONST CHAR16
*FileName
449 Disables the page break output mode.
453 EfiShellDisablePageBreak (
458 Enables the page break output mode.
462 EfiShellEnablePageBreak (
467 internal worker function to run a command via Device Path
469 @param ParentImageHandle A handle of the image that is executing the specified
471 @param DevicePath device path of the file to execute
472 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
473 containing the command line. If NULL then the command-
475 @param Environment Points to a NULL-terminated array of environment
476 variables with the format 'x=y', where x is the
477 environment variable name and y is the value. If this
478 is NULL, then the current shell environment is used.
479 @param StatusCode Points to the status code returned by the command.
481 @retval EFI_SUCCESS The command executed successfully. The status code
482 returned by the command is pointed to by StatusCode.
483 @retval EFI_INVALID_PARAMETER The parameters are invalid.
484 @retval EFI_OUT_OF_RESOURCES Out of resources.
485 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
489 InternalShellExecuteDevicePath(
490 IN CONST EFI_HANDLE
*ParentImageHandle
,
491 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
492 IN CONST CHAR16
*CommandLine OPTIONAL
,
493 IN CONST CHAR16
**Environment OPTIONAL
,
494 OUT EFI_STATUS
*StatusCode OPTIONAL
498 Execute the command line.
500 This function creates a nested instance of the shell and executes the specified
501 command (CommandLine) with the specified environment (Environment). Upon return,
502 the status code returned by the specified command is placed in StatusCode.
504 If Environment is NULL, then the current environment is used and all changes made
505 by the commands executed will be reflected in the current environment. If the
506 Environment is non-NULL, then the changes made will be discarded.
508 The CommandLine is executed from the current working directory on the current
511 @param ParentImageHandle A handle of the image that is executing the specified
513 @param CommandLine Points to the NULL-terminated UCS-2 encoded string
514 containing the command line. If NULL then the command-
516 @param Environment Points to a NULL-terminated array of environment
517 variables with the format 'x=y', where x is the
518 environment variable name and y is the value. If this
519 is NULL, then the current shell environment is used.
520 @param StatusCode Points to the status code returned by the command.
522 @retval EFI_SUCCESS The command executed successfully. The status code
523 returned by the command is pointed to by StatusCode.
524 @retval EFI_INVALID_PARAMETER The parameters are invalid.
525 @retval EFI_OUT_OF_RESOURCES Out of resources.
526 @retval EFI_UNSUPPORTED Nested shell invocations are not allowed.
531 IN EFI_HANDLE
*ParentImageHandle
,
532 IN CHAR16
*CommandLine OPTIONAL
,
533 IN CHAR16
**Environment OPTIONAL
,
534 OUT EFI_STATUS
*StatusCode OPTIONAL
538 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
540 1) frees all pointers (non-NULL)
541 2) Closes the SHELL_FILE_HANDLE
543 @param FileListNode pointer to the list node to free
547 FreeShellFileInfoNode(
548 IN EFI_SHELL_FILE_INFO
*FileListNode
554 This function cleans up the file list and any related data structures. It has no
555 impact on the files themselves.
557 @param FileList The file list to free. Type EFI_SHELL_FILE_INFO is
558 defined in OpenFileList()
560 @retval EFI_SUCCESS Free the file list successfully.
561 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
565 EfiShellFreeFileList(
566 IN EFI_SHELL_FILE_INFO
**FileList
570 Deletes the duplicate file names files in the given file list.
572 This function deletes the reduplicate files in the given file list.
574 @param FileList A pointer to the first entry in the file list.
576 @retval EFI_SUCCESS Always success.
577 @retval EFI_INVALID_PARAMETER FileList was NULL or *FileList was NULL;
581 EfiShellRemoveDupInFileList(
582 IN EFI_SHELL_FILE_INFO
**FileList
586 Allocates and populates a EFI_SHELL_FILE_INFO structure. if any memory operation
587 failed it will return NULL.
589 @param[in] BasePath the Path to prepend onto filename for FullPath
590 @param[in] Status Status member initial value.
591 @param[in] FullName FullName member initial value.
592 @param[in] FileName FileName member initial value.
593 @param[in] Handle Handle member initial value.
594 @param[in] Info Info struct to copy.
597 EFI_SHELL_FILE_INFO
*
599 CreateAndPopulateShellFileInfo(
600 IN CONST CHAR16
*BasePath
,
601 IN CONST EFI_STATUS Status
,
602 IN CONST CHAR16
*FullName
,
603 IN CONST CHAR16
*FileName
,
604 IN CONST SHELL_FILE_HANDLE Handle
,
605 IN CONST EFI_FILE_INFO
*Info
609 Find all files in a specified directory.
611 @param FileDirHandle Handle of the directory to search.
612 @param FileList On return, points to the list of files in the directory
613 or NULL if there are no files in the directory.
615 @retval EFI_SUCCESS File information was returned successfully.
616 @retval EFI_VOLUME_CORRUPTED The file system structures have been corrupted.
617 @retval EFI_DEVICE_ERROR The device reported an error.
618 @retval EFI_NO_MEDIA The device media is not present.
619 @retval EFI_INVALID_PARAMETER The FileDirHandle was not a directory.
623 EfiShellFindFilesInDir(
624 IN SHELL_FILE_HANDLE FileDirHandle
,
625 OUT EFI_SHELL_FILE_INFO
**FileList
629 Find files that match a specified pattern.
631 This function searches for all files and directories that match the specified
632 FilePattern. The FilePattern can contain wild-card characters. The resulting file
633 information is placed in the file list FileList.
635 Wildcards are processed
636 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1.
638 The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo
639 field is set to NULL.
641 if *FileList is not NULL then it must be a pre-existing and properly initialized list.
643 @param FilePattern Points to a NULL-terminated shell file path, including wildcards.
644 @param FileList On return, points to the start of a file list containing the names
645 of all matching files or else points to NULL if no matching files
646 were found. only on a EFI_SUCCESS return will; this be non-NULL.
648 @retval EFI_SUCCESS Files found. FileList is a valid list.
649 @retval EFI_NOT_FOUND No files found.
650 @retval EFI_NO_MEDIA The device has no media
651 @retval EFI_DEVICE_ERROR The device reported an error
652 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted
657 IN CONST CHAR16
*FilePattern
,
658 OUT EFI_SHELL_FILE_INFO
**FileList
662 Opens the files that match the path specified.
664 This function opens all of the files specified by Path. Wildcards are processed
665 according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
666 matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
668 @param Path A pointer to the path string.
669 @param OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
671 @param FileList Points to the start of a list of files opened.
673 @retval EFI_SUCCESS Create the file list successfully.
674 @return Others Can't create the file list.
678 EfiShellOpenFileList(
681 IN OUT EFI_SHELL_FILE_INFO
**FileList
685 Gets the environment variable.
687 This function returns the current value of the specified environment variable.
689 @param Name A pointer to the environment variable name
691 @return !=NULL The environment variable's value. The returned
692 pointer does not need to be freed by the caller.
693 @retval NULL The environment variable doesn't exist.
698 IN CONST CHAR16
*Name
702 Sets the environment variable.
704 This function changes the current value of the specified environment variable. If the
705 environment variable exists and the Value is an empty string, then the environment
706 variable is deleted. If the environment variable exists and the Value is not an empty
707 string, then the value of the environment variable is changed. If the environment
708 variable does not exist and the Value is an empty string, there is no action. If the
709 environment variable does not exist and the Value is a non-empty string, then the
710 environment variable is created and assigned the specified value.
712 For a description of volatile and non-volatile environment variables, see UEFI Shell
713 2.0 specification section 3.6.1.
715 @param Name Points to the NULL-terminated environment variable name.
716 @param Value Points to the NULL-terminated environment variable value. If the value is an
717 empty string then the environment variable is deleted.
718 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
720 @retval EFI_SUCCESS The environment variable was successfully updated.
725 IN CONST CHAR16
*Name
,
726 IN CONST CHAR16
*Value
,
731 Returns the current directory on the specified device.
733 If FileSystemMapping is NULL, it returns the current working directory. If the
734 FileSystemMapping is not NULL, it returns the current directory associated with the
735 FileSystemMapping. In both cases, the returned name includes the file system
736 mapping (i.e. fs0:\current-dir).
738 @param FileSystemMapping A pointer to the file system mapping. If NULL,
739 then the current working directory is returned.
741 @retval !=NULL The current directory.
742 @retval NULL Current directory does not exist.
747 IN CONST CHAR16
*FileSystemMapping OPTIONAL
751 Changes the current directory on the specified device.
753 If the FileSystem is NULL, and the directory Dir does not contain a file system's
754 mapped name, this function changes the current working directory. If FileSystem is
755 NULL and the directory Dir contains a mapped name, then the current file system and
756 the current directory on that file system are changed.
758 If FileSystem is not NULL, and Dir is NULL, then this changes the current working file
761 If FileSystem is not NULL and Dir is not NULL, then this function changes the current
762 directory on the specified file system.
764 If the current working directory or the current working file system is changed then the
765 %cwd% environment variable will be updated
767 @param FileSystem A pointer to the file system's mapped name. If NULL, then the current working
768 directory is changed.
769 @param Dir Points to the NULL-terminated directory on the device specified by FileSystem.
771 @retval EFI_SUCCESS The operation was sucessful
776 IN CONST CHAR16
*FileSystem OPTIONAL
,
781 Return help information about a specific command.
783 This function returns the help information for the specified command. The help text
784 can be internal to the shell or can be from a UEFI Shell manual page.
786 If Sections is specified, then each section name listed will be compared in a casesensitive
787 manner, to the section names described in Appendix B. If the section exists,
788 it will be appended to the returned help text. If the section does not exist, no
789 information will be returned. If Sections is NULL, then all help text information
790 available will be returned.
792 @param Command Points to the NULL-terminated UEFI Shell command name.
793 @param Sections Points to the NULL-terminated comma-delimited
794 section names to return. If NULL, then all
795 sections will be returned.
796 @param HelpText On return, points to a callee-allocated buffer
797 containing all specified help text.
799 @retval EFI_SUCCESS The help text was returned.
800 @retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the
802 @retval EFI_INVALID_PARAMETER HelpText is NULL
803 @retval EFI_NOT_FOUND There is no help text available for Command.
808 IN CONST CHAR16
*Command
,
809 IN CONST CHAR16
*Sections OPTIONAL
,
810 OUT CHAR16
**HelpText
814 Gets the enable status of the page break output mode.
816 User can use this function to determine current page break mode.
818 @retval TRUE The page break output mode is enabled
819 @retval FALSE The page break output mode is disabled
823 EfiShellGetPageBreak(
828 Judges whether the active shell is the root shell.
830 This function makes the user to know that whether the active Shell is the root shell.
832 @retval TRUE The active Shell is the root Shell.
833 @retval FALSE The active Shell is NOT the root Shell.
842 This function returns the command associated with a alias or a list of all
845 @param[in] Command Points to the NULL-terminated shell alias.
846 If this parameter is NULL, then all
847 aliases will be returned in ReturnedData.
848 @param[out] Volatile upon return of a single command if TRUE indicates
849 this is stored in a volatile fashion. FALSE otherwise.
850 @return If Alias is not NULL, it will return a pointer to
851 the NULL-terminated command for that alias.
852 If Alias is NULL, ReturnedData points to a ';'
853 delimited list of alias (e.g.
854 ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
855 @retval NULL an error ocurred
856 @retval NULL Alias was not a valid Alias
861 IN CONST CHAR16
*Command
,
862 OUT BOOLEAN
*Volatile OPTIONAL
866 Changes a shell command alias.
868 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
870 this function does not check for built in alias'.
872 @param[in] Command Points to the NULL-terminated shell command or existing alias.
873 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
874 Command refers to an alias, that alias will be deleted.
875 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
876 Alias being set will be stored in a non-volatile fashion.
878 @retval EFI_SUCCESS Alias created or deleted successfully.
879 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
884 IN CONST CHAR16
*Command
,
885 IN CONST CHAR16
*Alias OPTIONAL
,
890 Changes a shell command alias.
892 This function creates an alias for a shell command or if Alias is NULL it will delete an existing alias.
895 @param[in] Command Points to the NULL-terminated shell command or existing alias.
896 @param[in] Alias Points to the NULL-terminated alias for the shell command. If this is NULL, and
897 Command refers to an alias, that alias will be deleted.
898 @param[in] Replace If TRUE and the alias already exists, then the existing alias will be replaced. If
899 FALSE and the alias already exists, then the existing alias is unchanged and
900 EFI_ACCESS_DENIED is returned.
901 @param[in] Volatile if TRUE the Alias being set will be stored in a volatile fashion. if FALSE the
902 Alias being set will be stored in a non-volatile fashion.
904 @retval EFI_SUCCESS Alias created or deleted successfully.
905 @retval EFI_NOT_FOUND the Alias intended to be deleted was not found
906 @retval EFI_ACCESS_DENIED The alias is a built-in alias or already existed and Replace was set to
912 IN CONST CHAR16
*Command
,
913 IN CONST CHAR16
*Alias OPTIONAL
,
919 Utility cleanup function for EFI_SHELL_FILE_INFO objects.
921 1) frees all pointers (non-NULL)
922 2) Closes the SHELL_FILE_HANDLE
924 @param FileListNode pointer to the list node to free
928 InternalFreeShellFileInfoNode(
929 IN EFI_SHELL_FILE_INFO
*FileListNode
933 Internal variable setting function. Allows for setting of the read only variables.
935 @param Name Points to the NULL-terminated environment variable name.
936 @param Value Points to the NULL-terminated environment variable value. If the value is an
937 empty string then the environment variable is deleted.
938 @param Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
940 @retval EFI_SUCCESS The environment variable was successfully updated.
944 InternalEfiShellSetEnv(
945 IN CONST CHAR16
*Name
,
946 IN CONST CHAR16
*Value
,
951 Function to start monitoring for CTRL-C using SimpleTextInputEx. This
952 feature's enabled state was not known when the shell initially launched.
954 @retval EFI_SUCCESS The feature is enabled.
955 @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.
959 InernalEfiShellStartMonitor(
964 Notification function for keystrokes.
966 @param[in] KeyData The key that was pressed.
968 @retval EFI_SUCCESS The operation was successful.
972 NotificationFunction(
973 IN EFI_KEY_DATA
*KeyData
975 #endif //_SHELL_PROTOCOL_HEADER_