EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Typedefs | Enumerations | Functions | Variables

ShellPkg/Include/Protocol/EfiShell.h File Reference

#include <ShellBase.h>
#include <Guid/FileInfo.h>

Go to the source code of this file.

Data Structures

struct  EFI_SHELL_FILE_INFO
struct  _EFI_SHELL_PROTOCOL

Defines

#define EFI_SHELL_PROTOCOL_GUID
#define EFI_DEVICE_NAME_USE_COMPONENT_NAME   0x00000001
#define EFI_DEVICE_NAME_USE_DEVICE_PATH   0x00000002

Typedefs

typedef EFI_STATUS(EFIAPI * EFI_SHELL_CLOSE_FILE )(IN SHELL_FILE_HANDLE FileHandle)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_CREATE_FILE )(IN CONST CHAR16 *FileName, IN UINT64 FileAttribs, OUT SHELL_FILE_HANDLE *FileHandle)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_DELETE_FILE )(IN SHELL_FILE_HANDLE FileHandle)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_DELETE_FILE_BY_NAME )(IN CONST CHAR16 *FileName)
typedef IN CHAR16 *CommandLine OPTIONAL
typedef EFI_STATUS(EFIAPI * EFI_SHELL_FIND_FILES )(IN CONST CHAR16 *FilePattern, OUT EFI_SHELL_FILE_INFO **FileList)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_FIND_FILES_IN_DIR )(IN SHELL_FILE_HANDLE FileDirHandle, OUT EFI_SHELL_FILE_INFO **FileList)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_FLUSH_FILE )(IN SHELL_FILE_HANDLE FileHandle)
typedef CONST CHAR16 *EFIAPI EFI_SHELL_GET_CUR_DIR (IN CONST CHAR16 *FileSystemMapping OPTIONAL)
typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS
typedef IN
EFI_SHELL_DEVICE_NAME_FLAGS 
Flags
typedef IN
EFI_SHELL_DEVICE_NAME_FLAGS IN
CHAR8
Language
typedef IN
EFI_SHELL_DEVICE_NAME_FLAGS IN
CHAR8 OUT CHAR16 ** 
BestDeviceName
typedef CONST
EFI_DEVICE_PATH_PROTOCOL
*EFIAPI 
EFI_SHELL_GET_DEVICE_PATH_FROM_MAP (IN CONST CHAR16 *Mapping)
typedef
EFI_DEVICE_PATH_PROTOCOL
*EFIAPI 
EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH (IN CONST CHAR16 *Path)
typedef CONST CHAR16 *EFIAPI EFI_SHELL_GET_ENV (IN CONST CHAR16 *Name OPTIONAL)
typedef EFI_FILE_INFO *(EFIAPI * EFI_SHELL_GET_FILE_INFO )(IN SHELL_FILE_HANDLE FileHandle)
typedef CHAR16 *EFIAPI EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH (IN CONST EFI_DEVICE_PATH_PROTOCOL *Path)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_GET_FILE_POSITION )(IN SHELL_FILE_HANDLE FileHandle, OUT UINT64 *Position)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_GET_FILE_SIZE )(IN SHELL_FILE_HANDLE FileHandle, OUT UINT64 *Size)
typedef IN CONST CHAR16
*Sections OUT CHAR16 ** 
HelpText
typedef CONST CHAR16 *EFIAPI EFI_SHELL_GET_MAP_FROM_DEVICE_PATH (IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath)
typedef OUT SHELL_FILE_HANDLEFileHandle
typedef OUT SHELL_FILE_HANDLE
IN UINT64 
OpenMode
typedef IN UINT64 IN OUT
EFI_SHELL_FILE_INFO ** 
FileList
typedef EFI_STATUS(EFIAPI * EFI_SHELL_OPEN_ROOT )(IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, OUT SHELL_FILE_HANDLE *FileHandle)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_OPEN_ROOT_BY_HANDLE )(IN EFI_HANDLE DeviceHandle, OUT SHELL_FILE_HANDLE *FileHandle)
typedef IN OUT UINTNReadSize
typedef IN OUT UINTN IN OUT VOID * Buffer
typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_ALIAS )(IN CONST CHAR16 *Command, IN CONST CHAR16 *Alias, IN BOOLEAN Replace, IN BOOLEAN Volatile)
typedef CONST CHAR16 *(EFIAPI * EFI_SHELL_GET_ALIAS )(IN CONST CHAR16 *Alias, OUT BOOLEAN *Volatile OPTIONAL)
typedef IN CONST CHAR16Dir
typedef IN CONST CHAR16Value
typedef IN CONST CHAR16 IN BOOLEAN Volatile
typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_FILE_INFO )(IN SHELL_FILE_HANDLE FileHandle, IN CONST EFI_FILE_INFO *FileInfo)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_FILE_POSITION )(IN SHELL_FILE_HANDLE FileHandle, IN UINT64 Position)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_MAP )(IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, IN CONST CHAR16 *Mapping)
typedef EFI_STATUS(EFIAPI * EFI_SHELL_WRITE_FILE )(IN SHELL_FILE_HANDLE FileHandle, IN OUT UINTN *BufferSize, IN VOID *Buffer)
typedef struct _EFI_SHELL_PROTOCOL EFI_SHELL_PROTOCOL

Enumerations

enum  ShellVersion { SHELL_MAJOR_VERSION = 2, SHELL_MINOR_VERSION = 0 }

Functions

typedef BOOLEAN (EFIAPI *EFI_SHELL_BATCH_IS_ACTIVE)(VOID)
typedef VOID (EFIAPI *EFI_SHELL_DISABLE_PAGE_BREAK)(VOID)
typedef EFI_STATUS (EFIAPI *EFI_SHELL_EXECUTE)(IN EFI_HANDLE *ParentImageHandle

Variables

EFI_GUID gEfiShellProtocolGuid

Detailed Description

EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file EfiShell.h.


Define Documentation

#define EFI_DEVICE_NAME_USE_COMPONENT_NAME   0x00000001

Definition at line 309 of file EfiShell.h.

#define EFI_DEVICE_NAME_USE_DEVICE_PATH   0x00000002

Definition at line 310 of file EfiShell.h.

#define EFI_SHELL_PROTOCOL_GUID
Value:
{ \
  0x6302d008, 0x7f9b, 0x4f30, { 0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e } \
  }

Definition at line 21 of file EfiShell.h.


Typedef Documentation

Definition at line 346 of file EfiShell.h.

typedef IN OUT UINTN IN OUT VOID* Buffer

Definition at line 727 of file EfiShell.h.

typedef IN CONST CHAR16* Dir

Definition at line 824 of file EfiShell.h.

Closes the file handle.

This function closes a specified file handle. All 'dirty' cached file data is flushed to the device, and the file is closed. In all cases, the handle is closed.

Parameters:
[in]FileHandleThe file handle to be closed.
Return values:
EFI_SUCCESSThe file closed sucessfully.

Definition at line 63 of file EfiShell.h.

typedef EFI_STATUS(EFIAPI * EFI_SHELL_CREATE_FILE)(IN CONST CHAR16 *FileName, IN UINT64 FileAttribs, OUT SHELL_FILE_HANDLE *FileHandle)

Creates a file or directory by name.

This function creates an empty new file or directory with the specified attributes and returns the new file's handle. If the file already exists and is read-only, then EFI_INVALID_PARAMETER will be returned.

If the file already existed, it is truncated and its attributes updated. If the file is created successfully, the FileHandle is the file's handle, else, the FileHandle is NULL.

If the file name begins with >v, then the file handle which is returned refers to the shell environment variable with the specified name. If the shell environment variable already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.

Parameters:
[in]FileNamePointer to NULL-terminated file path.
[in]FileAttribsThe new file's attrbiutes. The different attributes are described in EFI_FILE_PROTOCOL.Open().
[out]FileHandleOn return, points to the created file handle or directory's handle.
Return values:
EFI_SUCCESSThe file was opened. FileHandle points to the new file's handle.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value.
EFI_UNSUPPORTEDThe file path could not be opened.
EFI_NOT_FOUNDThe specified file could not be found on the device, or could not file the file system on the device.
EFI_NO_MEDIAThe device has no medium.
EFI_MEDIA_CHANGEDThe device has a different medium in it or the medium is no longer supported.
EFI_DEVICE_ERRORThe device reported an error or can't get the file path according the DirName.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDAn attempt was made to create a file, or open a file for write when the media is write-protected.
EFI_ACCESS_DENIEDThe service denied access to the file.
EFI_OUT_OF_RESOURCESNot enough resources were available to open the file.
EFI_VOLUME_FULLThe volume is full.

Definition at line 105 of file EfiShell.h.

Deletes the file specified by the file handle.

This function closes and deletes a file. In all cases, the file handle is closed. If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is returned, but the handle is still closed.

Parameters:
[in]FileHandleThe file handle to delete.
Return values:
EFI_SUCCESSThe file was closed and deleted and the handle was closed.
EFI_WARN_DELETE_FAILUREThe handle was closed but the file was not deleted.

Definition at line 125 of file EfiShell.h.

Deletes the file specified by the file name.

This function deletes a file.

Parameters:
[in]FileNamePoints to the NULL-terminated file name.
Return values:
EFI_SUCCESSThe file was deleted.
EFI_WARN_DELETE_FAILUREThe handle was closed but the file was not deleted.

Definition at line 141 of file EfiShell.h.

Definition at line 308 of file EfiShell.h.

typedef EFI_STATUS(EFIAPI * EFI_SHELL_FIND_FILES)(IN CONST CHAR16 *FilePattern, OUT EFI_SHELL_FILE_INFO **FileList)

Find files that match a specified pattern.

This function searches for all files and directories that match the specified FilePattern. The FilePattern can contain wild-card characters. The resulting file information is placed in the file list FileList.

The files in the file list are not opened. The OpenMode field is set to 0 and the FileInfo field is set to NULL.

Parameters:
[in]FilePatternPoints to a NULL-terminated shell file path, including wildcards.
[out]FileListOn return, points to the start of a file list containing the names of all matching files or else points to NULL if no matching files were found.
Return values:
EFI_SUCCESSFiles found.
EFI_NOT_FOUNDNo files found.
EFI_NO_MEDIAThe device has no media.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.

Definition at line 226 of file EfiShell.h.

Find all files in a specified directory.

Parameters:
[in]FileDirHandleHandle of the directory to search.
[out]FileListOn return, points to the list of files in the directory or NULL if there are no files in the directory.
Return values:
EFI_SUCCESSFile information was returned successfully.
EFI_VOLUME_CORRUPTEDThe file system structures have been corrupted.
EFI_DEVICE_ERRORThe device reported an error.
EFI_NO_MEDIAThe device media is not present.

Definition at line 245 of file EfiShell.h.

Flushes data back to a device.

This function flushes all modified data associated with a file to a device.

Parameters:
[in]FileHandleThe handle of the file to flush.
Return values:
EFI_SUCCESSThe data was flushed.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write-protected.
EFI_ACCESS_DENIEDThe file was opened read-only.
EFI_VOLUME_FULLThe volume is full.

Definition at line 267 of file EfiShell.h.

typedef CONST CHAR16*(EFIAPI * EFI_SHELL_GET_ALIAS)(IN CONST CHAR16 *Alias, OUT BOOLEAN *Volatile OPTIONAL)

This function returns the command associated with a alias or a list of all alias'.

Parameters:
[in]AliasPoints to the NULL-terminated shell alias. If this parameter is NULL, then all aliases will be returned in ReturnedData.
[out]VolatileUpon return of a single command if TRUE indicates this is stored in a volatile fashion. FALSE otherwise.
Returns:
If Alias is not NULL, it will return a pointer to the NULL-terminated command for that alias. If Alias is NULL, ReturnedData points to a ';' delimited list of alias (e.g. ReturnedData = "dir;del;copy;mfp") that is NULL-terminated.
Return values:
NULLAn error ocurred.
NULLAlias was not a valid Alias.

Definition at line 790 of file EfiShell.h.

typedef CONST CHAR16* EFIAPI EFI_SHELL_GET_CUR_DIR(IN CONST CHAR16 *FileSystemMapping OPTIONAL)

Returns the current directory on the specified device.

If FileSystemMapping is NULL, it returns the current working directory. If the FileSystemMapping is not NULL, it returns the current directory associated with the FileSystemMapping. In both cases, the returned name includes the file system mapping (i.e. fs0:-dir).

Parameters:
[in]FileSystemMappingA pointer to the file system mapping. If NULL, then the current working directory is returned.
Return values:
!=NULLThe current directory.
NULLCurrent directory does not exist.

Definition at line 304 of file EfiShell.h.

Converts a file system style name to a device path.

This function converts a file system style name to a device path, by replacing any mapping references to the associated device path.

Parameters:
[in]PathThe pointer to the path.
Returns:
The pointer of the file path. The file path is callee allocated and should be freed by the caller.

Definition at line 383 of file EfiShell.h.

Gets the device path from the mapping.

This function gets the device path associated with a mapping.

Parameters:
[in]MappingA pointer to the mapping
Return values:
!=NULLPointer to the device path that corresponds to the device mapping. The returned pointer does not need to be freed.
NULLThere is no device path associated with the specified mapping.

Definition at line 366 of file EfiShell.h.

typedef CONST CHAR16* EFIAPI EFI_SHELL_GET_ENV(IN CONST CHAR16 *Name OPTIONAL)

Gets either a single or list of environment variables.

If name is not NULL then this function returns the current value of the specified environment variable.

If Name is NULL than a list of all environment variable names is returned. Each a NULL terminated string with a double NULL terminating the list.

Parameters:
[in]NameA pointer to the environment variable name. If Name is NULL, then the function will return all of the defined shell environment variables. In the case where multiple environment variables are being returned, each variable will be terminated by a NULL, and the list will be terminated by a double NULL.
Returns:
A pointer to the returned string. The returned pointer does not need to be freed by the caller.
Return values:
NULLThe environment variable doesn't exist or there are no environment variables.

Definition at line 412 of file EfiShell.h.

Gets the file information from an open file handle.

This function allocates a buffer to store the file's information. It's the caller's responsibility to free the buffer.

Parameters:
[in]FileHandleA File Handle.
Return values:
NULLCannot get the file info.
Returns:
A pointer to a buffer with file information.

Definition at line 429 of file EfiShell.h.

Converts a device path to a file system-style path.

This function converts a device path to a file system path by replacing part, or all, of the device path with the file-system mapping. If there are more than one application file system mappings, the one that most closely matches Path will be used.

Parameters:
[in]PathThe pointer to the device path.
Returns:
The pointer of the NULL-terminated file path. The path is callee-allocated and should be freed by the caller.

Definition at line 447 of file EfiShell.h.

Gets a file's current position.

This function returns the current file position for the file handle. For directories, the current file position has no meaning outside of the file system driver and as such, the operation is not supported.

Parameters:
[in]FileHandleThe file handle on which to get the current position.
[out]PositionByte position from the start of the file.
Return values:
EFI_SUCCESSData was accessed.
EFI_UNSUPPORTEDThe request is not valid on open directories.

Definition at line 466 of file EfiShell.h.

Gets the size of a file.

This function returns the size of the file specified by FileHandle.

Parameters:
[in]FileHandleThe handle of the file.
[out]SizeThe size of this file.
Return values:
EFI_SUCCESSGet the file's size.
EFI_DEVICE_ERRORCan't access the file.

Definition at line 484 of file EfiShell.h.

Gets the mapping(s) that most closely matches the device path.

This function gets the mapping which corresponds to the device path *DevicePath. If there is no exact match, then the mapping which most closely matches *DevicePath is returned, and *DevicePath is updated to point to the remaining portion of the device path. If there is an exact match, the mapping is returned and *DevicePath points to the end-of-device-path node.

If there are multiple map names they will be semi-colon seperated in the NULL-terminated string.

Parameters:
[in,out]DevicePathOn entry, points to a device path pointer. On exit, updates the pointer to point to the portion of the device path after the mapping.
Return values:
NULLNo mapping was found.
!=NULLPointer to NULL-terminated mapping. The buffer is callee allocated and should be freed by the caller.

Definition at line 544 of file EfiShell.h.

Opens the root directory of a device.

This function opens the root directory of a device and returns a file handle to it.

Parameters:
[in]DevicePathPoints to the device path corresponding to the device where the EFI_SIMPLE_FILE_SYSTEM_PROTOCOL is installed.
[out]FileHandleOn exit, points to the file handle corresponding to the root directory on the device.
Return values:
EFI_SUCCESSRoot opened successfully.
EFI_NOT_FOUNDEFI_SIMPLE_FILE_SYSTEM could not be found or the root directory could not be opened.
EFI_VOLUME_CORRUPTEDThe data structures in the volume were corrupted.
EFI_DEVICE_ERRORThe device had an error.

Definition at line 677 of file EfiShell.h.

Opens the root directory of a device on a handle.

This function opens the root directory of a device and returns a file handle to it.

Parameters:
[in]DeviceHandleThe handle of the device that contains the volume.
[out]FileHandleOn exit, points to the file handle corresponding to the root directory on the device.
Return values:
EFI_SUCCESSRoot opened successfully.
EFI_NOT_FOUNDEFI_SIMPLE_FILE_SYSTEM could not be found or the root directory could not be opened.
EFI_VOLUME_CORRUPTEDThe data structures in the volume were corrupted.
EFI_DEVICE_ERRORThe device had an error.

Definition at line 699 of file EfiShell.h.

typedef EFI_STATUS(EFIAPI * EFI_SHELL_SET_ALIAS)(IN CONST CHAR16 *Command, IN CONST CHAR16 *Alias, IN BOOLEAN Replace, IN BOOLEAN Volatile)

Changes a shell command alias.

This function creates an alias for a shell command.

Parameters:
[in]CommandPoints to the NULL-terminated shell command or existing alias.
[in]AliasPoints to the NULL-terminated alias for the shell command. If this is NULL, and Command refers to an alias, that alias will be deleted.
[in]ReplaceIf TRUE and the alias already exists, then the existing alias will be replaced. If FALSE and the alias already exists, then the existing alias is unchanged and EFI_ACCESS_DENIED is returned.
[in]Volatileif TRUE the Alias being set will be stored in a volatile fashion. if FALSE the Alias being set will be stored in a non-volatile fashion.
Return values:
EFI_SUCCESSAlias created or deleted successfully.
EFI_ACCESS_DENIEDThe alias is a built-in alias or already existed and Replace was set to FALSE.

Definition at line 764 of file EfiShell.h.

Sets the file information to an opened file handle.

This function changes file information. All file information in the EFI_FILE_INFO struct will be updated to the passed in data.

Parameters:
[in]FileHandleA file handle.
[in]FileInfoPoints to new file information.
Return values:
EFI_SUCCESSThe information was set.
EFI_NO_MEDIAThe device has no medium.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe file or medium is write-protected.
EFI_ACCESS_DENIEDThe file was opened read-only.
EFI_VOLUME_FULLThe volume is full.
EFI_BAD_BUFFER_SIZEBufferSize is smaller than the size of EFI_FILE_INFO.

Definition at line 875 of file EfiShell.h.

Sets a file's current position.

This function sets the current file position for the handle to the position supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only absolute positioning is supported, and seeking past the end of the file is allowed (a subsequent write would grow the file). Seeking to position 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.

Parameters:
[in]FileHandleThe file handle on which requested position will be set.
[in]PositionByte position from the start of the file.
Return values:
EFI_SUCCESSData was written.
EFI_UNSUPPORTEDThe seek request for nonzero is not valid on open directories.

Definition at line 897 of file EfiShell.h.

This function creates a mapping for a device path.

Parameters:
[in]DevicePathPoints to the device path. If this is NULL and Mapping points to a valid mapping, then the mapping will be deleted.
[in]MappingPoints to the NULL-terminated mapping for the device path.
Return values:
EFI_SUCCESSMapping created or deleted successfully.
EFI_NO_MAPPINGThere is no handle that corresponds exactly to DevicePath. See the boot service function LocateDevicePath().
EFI_ACCESS_DENIEDThe mapping is a built-in alias.

Definition at line 916 of file EfiShell.h.

Writes data to the file.

This function writes the specified number of bytes to the file at the current file position. The current file position is advanced the actual number of bytes written, which is returned in BufferSize. Partial writes only occur when there has been a data error during the write attempt (such as "volume space full"). The file automatically grows to hold the data, if required.

Direct writes to opened directories are not supported.

Parameters:
[in]FileHandleThe opened file handle for writing.
[in,out]BufferSizeOn input, size of Buffer.
[in]BufferThe buffer in which data to write.
Return values:
EFI_SUCCESSData was written.
EFI_UNSUPPORTEDWrites to open directory are not supported.
EFI_NO_MEDIAThe device has no media.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_WRITE_PROTECTEDThe device is write-protected.
EFI_ACCESS_DENIEDThe file was open for read only.
EFI_VOLUME_FULLThe volume is full.

Definition at line 947 of file EfiShell.h.

Definition at line 632 of file EfiShell.h.

typedef IN UINT64 IN OUT EFI_SHELL_FILE_INFO** FileList

Definition at line 655 of file EfiShell.h.

Definition at line 346 of file EfiShell.h.

typedef IN CONST CHAR16* Sections OUT CHAR16** HelpText

Definition at line 518 of file EfiShell.h.

Definition at line 346 of file EfiShell.h.

typedef IN UINT64 OpenMode

Definition at line 632 of file EfiShell.h.

typedef IN CONST CHAR16* Sections OPTIONAL

Definition at line 198 of file EfiShell.h.

typedef IN OUT UINTN* ReadSize

Definition at line 727 of file EfiShell.h.

typedef IN CONST CHAR16* Value

Definition at line 851 of file EfiShell.h.

typedef IN CONST CHAR16 IN BOOLEAN Volatile

Definition at line 851 of file EfiShell.h.


Enumeration Type Documentation

Enumerator:
SHELL_MAJOR_VERSION 
SHELL_MINOR_VERSION 

Definition at line 1000 of file EfiShell.h.


Function Documentation

typedef BOOLEAN ( EFIAPI *  UGAIsKeyPressed)

Returns whether any script files are currently being processed.

Return values:
TRUEThere is at least one script file active.
FALSENo script files are active now.

Gets the enable status of the page break output mode.

User can use this function to determine current page break mode.

Return values:
TRUEThe page break output mode is enabled.
FALSEThe page break output mode is disabled.

Judges whether the active shell is the root shell.

This function makes the user to know that whether the active Shell is the root shell.

Return values:
TRUEThe active Shell is the root Shell.
FALSEThe active Shell is NOT the root Shell.

Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for subsequent use.

If Sha256Context is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to SHA-256 Context being initialized.
Return values:
TRUESHA-256 context initialization succeeded.
FALSESHA-256 context initialization failed.

Performs SHA-256 digest on a data buffer of the specified length. This function can be called multiple times to compute the digest of long or discontinuous data streams.

If Sha256Context is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to the SHA-256 context.
[in]DataPointer to the buffer containing the data to be hashed.
[in]DataLengthLength of Data buffer in bytes.
Return values:
TRUESHA-256 data digest succeeded.
FALSEInvalid SHA-256 context. After Sha256Final function has been called, the SHA-256 context cannot be reused.

Completes SHA-256 hash computation and retrieves the digest value into the specified memory. After this function has been called, the SHA-256 context cannot be used again.

If Sha256Context is NULL, then ASSERT(). If HashValue is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to SHA-256 context
[out]HashValuePointer to a buffer that receives the SHA-256 digest value (32 bytes).
Return values:
TRUESHA-256 digest computation succeeded.
FALSESHA-256 digest computation failed.

Sets the tag-designated RSA key component into the established RSA context from the user-specified nonnegative integer (octet string format represented in RSA PKCS#1).

If RsaContext is NULL, then ASSERT().

Parameters:
[in,out]RsaContextPointer to RSA context being set.
[in]KeyTagTag of RSA key component being set.
[in]BigNumberPointer to octet integer buffer.
[in]BnLengthLength of big number buffer in bytes.
Returns:
TRUE RSA key component was set successfully.
FALSE Invalid RSA key component tag.

Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme defined in RSA PKCS#1.

If RsaContext is NULL, then ASSERT(). If MessageHash is NULL, then ASSERT(). If Signature is NULL, then ASSERT(). If HashLength is not equal to the size of MD5, SHA-1 or SHA-256 digest, then ASSERT().

Parameters:
[in]RsaContextPointer to RSA context for signature verification.
[in]MessageHashPointer to octet message hash to be checked.
[in]HashLengthLength of the message hash in bytes.
[in]SignaturePointer to RSA PKCS1-v1_5 signature to be verified.
[in]SigLengthLength of signature in bytes.
Returns:
TRUE Valid signature encoded in PKCS1-v1_5.
FALSE Invalid signature or invalid RSA context.

This routine is used prevent command output data from scrolling off the end of the screen. The global gPageBreak is used to turn on or off this feature. If the CurrentRow is near the end of the screen pause and print out a prompt If the use hits Q to quit return TRUE else for any other key return FALSE. PrefixNewline is used to figure out if a newline is needed before the prompt string. This depends on the last print done before calling this function. CurrentRow is updated by one on a call or set back to zero if a prompt is needed.

Parameters:
CurrentRowUsed to figure out if its the end of the page and updated
PrefixNewlineDid previous print issue a newline
Returns:
TRUE if Q was hit to quit, FALSE in all other cases.

Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for subsequent use.

If Sha256Context is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to SHA-256 Context being initialized.
Return values:
TRUESHA-256 context initialization succeeded.
FALSESHA-256 context initialization failed.

Performs SHA-256 digest on a data buffer of the specified length. This function can be called multiple times to compute the digest of long or discontinuous data streams.

If Sha256Context is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to the SHA-256 context.
[in]DataPointer to the buffer containing the data to be hashed.
[in]DataLengthLength of Data buffer in bytes.
Return values:
TRUESHA-256 data digest succeeded.
FALSEInvalid SHA-256 context. After Sha256Final function has been called, the SHA-256 context cannot be reused.

Completes SHA-256 hash computation and retrieves the digest value into the specified memory. After this function has been called, the SHA-256 context cannot be used again.

If Sha256Context is NULL, then ASSERT(). If HashValue is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to SHA-256 context
[out]HashValuePointer to a buffer that receives the SHA-256 digest value (32 bytes).
Return values:
TRUESHA-256 digest computation succeeded.
FALSESHA-256 digest computation failed.

Sets the tag-designated RSA key component into the established RSA context from the user-specified nonnegative integer (octet string format represented in RSA PKCS#1).

If RsaContext is NULL, then ASSERT().

Parameters:
[in,out]RsaContextPointer to RSA context being set.
[in]KeyTagTag of RSA key component being set.
[in]BigNumberPointer to octet integer buffer.
[in]BnLengthLength of big number buffer in bytes.
Returns:
TRUE RSA key component was set successfully.
FALSE Invalid RSA key component tag.

Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme defined in RSA PKCS#1.

If RsaContext is NULL, then ASSERT(). If MessageHash is NULL, then ASSERT(). If Signature is NULL, then ASSERT(). If HashLength is not equal to the size of MD5, SHA-1 or SHA-256 digest, then ASSERT().

Parameters:
[in]RsaContextPointer to RSA context for signature verification.
[in]MessageHashPointer to octet message hash to be checked.
[in]HashLengthLength of the message hash in bytes.
[in]SignaturePointer to RSA PKCS1-v1_5 signature to be verified.
[in]SigLengthLength of signature in bytes.
Returns:
TRUE Valid signature encoded in PKCS1-v1_5.
FALSE Invalid signature or invalid RSA context.

This routine is used prevent command output data from scrolling off the end of the screen. The global gPageBreak is used to turn on or off this feature. If the CurrentRow is near the end of the screen pause and print out a prompt If the use hits Q to quit return TRUE else for any other key return FALSE. PrefixNewline is used to figure out if a newline is needed before the prompt string. This depends on the last print done before calling this function. CurrentRow is updated by one on a call or set back to zero if a prompt is needed.

Parameters:
CurrentRowUsed to figure out if its the end of the page and updated
PrefixNewlineDid previous print issue a newline
Returns:
TRUE if Q was hit to quit, FALSE in all other cases.

The select function to decide whether to cancel the UDP_TX_TOKEN.

Parameters:
[in]TokenThe UDP_TX_TOKEN to decide whether to cancel.
[in]ContextUser-defined data in UdpIoCancelDgrams().
Return values:
TRUECancel the UDP_TX_TOKEN.
FALSEDo not cancel this UDP_TX_TOKEN.

Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for subsequent use.

If Sha256Context is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to SHA-256 Context being initialized.
Return values:
TRUESHA-256 context initialization succeeded.
FALSESHA-256 context initialization failed.

Performs SHA-256 digest on a data buffer of the specified length. This function can be called multiple times to compute the digest of long or discontinuous data streams.

If Sha256Context is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to the SHA-256 context.
[in]DataPointer to the buffer containing the data to be hashed.
[in]DataLengthLength of Data buffer in bytes.
Return values:
TRUESHA-256 data digest succeeded.
FALSEInvalid SHA-256 context. After Sha256Final function has been called, the SHA-256 context cannot be reused.

Completes SHA-256 hash computation and retrieves the digest value into the specified memory. After this function has been called, the SHA-256 context cannot be used again.

If Sha256Context is NULL, then ASSERT(). If HashValue is NULL, then ASSERT().

Parameters:
[in,out]Sha256ContextPointer to SHA-256 context
[out]HashValuePointer to a buffer that receives the SHA-256 digest value (32 bytes).
Return values:
TRUESHA-256 digest computation succeeded.
FALSESHA-256 digest computation failed.

Sets the tag-designated RSA key component into the established RSA context from the user-specified nonnegative integer (octet string format represented in RSA PKCS#1).

If RsaContext is NULL, then ASSERT().

Parameters:
[in,out]RsaContextPointer to RSA context being set.
[in]KeyTagTag of RSA key component being set.
[in]BigNumberPointer to octet integer buffer.
[in]BnLengthLength of big number buffer in bytes.
Returns:
TRUE RSA key component was set successfully.
FALSE Invalid RSA key component tag.

Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme defined in RSA PKCS#1.

If RsaContext is NULL, then ASSERT(). If MessageHash is NULL, then ASSERT(). If Signature is NULL, then ASSERT(). If HashLength is not equal to the size of MD5, SHA-1 or SHA-256 digest, then ASSERT().

Parameters:
[in]RsaContextPointer to RSA context for signature verification.
[in]MessageHashPointer to octet message hash to be checked.
[in]HashLengthLength of the message hash in bytes.
[in]SignaturePointer to RSA PKCS1-v1_5 signature to be verified.
[in]SigLengthLength of signature in bytes.
Returns:
TRUE Valid signature encoded in PKCS1-v1_5.
FALSE Invalid signature or invalid RSA context.

This routine is used prevent command output data from scrolling off the end of the screen. The global gPageBreak is used to turn on or off this feature. If the CurrentRow is near the end of the screen pause and print out a prompt If the use hits Q to quit return TRUE else for any other key return FALSE. PrefixNewline is used to figure out if a newline is needed before the prompt string. This depends on the last print done before calling this function. CurrentRow is updated by one on a call or set back to zero if a prompt is needed.

Parameters:
CurrentRowUsed to figure out if its the end of the page and updated
PrefixNewlineDid previous print issue a newline
Returns:
TRUE if Q was hit to quit, FALSE in all other cases.

The select function to decide whether to cancel the UDP_TX_TOKEN.

Parameters:
[in]TokenThe UDP_TX_TOKEN to decide whether to cancel.
[in]ContextUser-defined data in UdpIoCancelDgrams().
Return values:
TRUECancel the UDP_TX_TOKEN.
FALSEDo not cancel this UDP_TX_TOKEN.
typedef EFI_STATUS ( EFIAPI *  EFI_SHELL_SET_ENV)

Execute the command line.

This function creates a nested instance of the shell and executes the specified command (CommandLine) with the specified environment (Environment). Upon return, the status code returned by the specified command is placed in StatusCode.

If Environment is NULL, then the current environment is used and all changes made by the commands executed will be reflected in the current environment. If the Environment is non-NULL, then the changes made will be discarded.

The CommandLine is executed from the current working directory on the current device.

Parameters:
[in]ParentImageHandleA handle of the image that is executing the specified command line.
[in]CommandLinePoints to the NULL-terminated UCS-2 encoded string containing the command line. If NULL then the command- line will be empty.
[in]EnvironmentPoints to a NULL-terminated array of environment variables with the format 'x=y', where x is the environment variable name and y is the value. If this is NULL, then the current shell environment is used.
[out]ErrorCodePoints to the status code returned by the command.
Return values:
EFI_SUCCESSThe command executed successfully. The status code returned by the command is pointed to by StatusCode.
EFI_INVALID_PARAMETERThe parameters are invalid.
EFI_OUT_OF_RESOURCESOut of resources.
EFI_UNSUPPORTEDNested shell invocations are not allowed.

Frees the file list.

This function cleans up the file list and any related data structures. It has no impact on the files themselves.

Parameters:
[in]FileListThe file list to free. Type EFI_SHELL_FILE_INFO is defined in OpenFileList().
Return values:
EFI_SUCCESSFree the file list successfully.

Gets the name of the device specified by the device handle.

This function gets the user-readable name of the device specified by the device handle. If no user-readable name could be generated, then *BestDeviceName will be NULL and EFI_NOT_FOUND will be returned.

If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on DeviceHandle.

If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle. If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.

Parameters:
[in]DeviceHandleThe handle of the device.
[in]FlagsDetermines the possible sources of component names.
[in]LanguageA pointer to the language specified for the device name, in the same format as described in the UEFI specification, Appendix M.
[out]BestDeviceNameOn return, points to the callee-allocated NULL- terminated name of the device. If no device name could be found, points to NULL. The name must be freed by the caller...
Return values:
EFI_SUCCESSGet the name successfully.
EFI_NOT_FOUNDFail to get the device name.

Return help information about a specific command.

This function returns the help information for the specified command. The help text can be internal to the shell or can be from a UEFI Shell manual page.

If Sections is specified, then each section name listed will be compared in a casesensitive manner, to the section names described in Appendix B. If the section exists, it will be appended to the returned help text. If the section does not exist, no information will be returned. If Sections is NULL, then all help text information available will be returned.

Parameters:
[in]CommandPoints to the NULL-terminated UEFI Shell command name.
[in]SectionsPoints to the NULL-terminated comma-delimited section names to return. If NULL, then all sections will be returned.
[out]HelpTextOn return, points to a callee-allocated buffer containing all specified help text.
Return values:
EFI_SUCCESSThe help text was returned.
EFI_OUT_OF_RESOURCESThe necessary buffer could not be allocated to hold the returned help text.
EFI_INVALID_PARAMETERHelpText is NULL.
EFI_NOT_FOUNDThere is no help text available for Command.

Opens a file or a directory by file name.

This function opens the specified file in the specified OpenMode and returns a file handle. If the file name begins with '>v', then the file handle which is returned refers to the shell environment variable with the specified name. If the shell environment variable exists, is non-volatile and the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER is returned.

If the file name is '>i', then the file handle which is returned refers to the standard input. If the OpenMode indicates EFI_FILE_MODE_WRITE, then EFI_INVALID_PARAMETER is returned.

If the file name is '>o', then the file handle which is returned refers to the standard output. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is returned.

If the file name is '>e', then the file handle which is returned refers to the standard error. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is returned.

If the file name is 'NUL', then the file handle that is returned refers to the standard NUL file. If the OpenMode indicates EFI_FILE_MODE_READ, then EFI_INVALID_PARAMETER is returned.

If return EFI_SUCCESS, the FileHandle is the opened file's handle, else, the FileHandle is NULL.

Parameters:
[in]FileNamePoints to the NULL-terminated UCS-2 encoded file name.
[out]FileHandleOn return, points to the file handle.
[in]OpenModeFile open mode. Either EFI_FILE_MODE_READ or EFI_FILE_MODE_WRITE from section 12.4 of the UEFI Specification.
Return values:
EFI_SUCCESSThe file was opened. FileHandle has the opened file's handle.
EFI_INVALID_PARAMETEROne of the parameters has an invalid value. FileHandle is NULL.
EFI_UNSUPPORTEDCould not open the file path. FileHandle is NULL.
EFI_NOT_FOUNDThe specified file could not be found on the device or the file system could not be found on the device. FileHandle is NULL.
EFI_NO_MEDIAThe device has no medium. FileHandle is NULL.
EFI_MEDIA_CHANGEDThe device has a different medium in it or the medium is no longer supported. FileHandle is NULL.
EFI_DEVICE_ERRORThe device reported an error or can't get the file path according the FileName. FileHandle is NULL.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted. FileHandle is NULL.
EFI_WRITE_PROTECTEDAn attempt was made to create a file, or open a file for write when the media is write-protected. FileHandle is NULL.
EFI_ACCESS_DENIEDThe service denied access to the file. FileHandle is NULL.
EFI_OUT_OF_RESOURCESNot enough resources were available to open the file. FileHandle is NULL.
EFI_VOLUME_FULLThe volume is full. FileHandle is NULL.

Opens the files that match the path specified.

This function opens all of the files specified by Path. Wildcards are processed according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.

Parameters:
[in]PathA pointer to the path string.
[in]OpenModeSpecifies the mode used to open each file, EFI_FILE_MODE_READ or EFI_FILE_MODE_WRITE.
[in,out]FileListPoints to the start of a list of files opened.
Return values:
EFI_SUCCESSCreate the file list successfully.
Returns:
Can't create the file list.

Reads data from the file.

If FileHandle is not a directory, the function reads the requested number of bytes from the file at the file's current position and returns them in Buffer. If the read goes beyond the end of the file, the read length is truncated to the end of the file. The file's current position is increased by the number of bytes returned. If FileHandle is a directory, then an error is returned.

Parameters:
[in]FileHandleThe opened file handle for read.
[in]ReadSizeOn input, the size of Buffer, in bytes. On output, the amount of data read.
[in,out]BufferThe buffer in which data is read.
Return values:
EFI_SUCCESSData was read.
EFI_NO_MEDIAThe device has no media.
EFI_DEVICE_ERRORThe device reported an error.
EFI_VOLUME_CORRUPTEDThe file system structures are corrupted.
EFI_BUFFER_TO_SMALLBuffer is too small. ReadSize contains required size.

Deletes the duplicate file names files in the given file list.

Parameters:
[in]FileListA pointer to the first entry in the file list.
Return values:
EFI_SUCCESSAlways success.

Changes the current directory on the specified device.

If the FileSystem is NULL, and the directory Dir does not contain a file system's mapped name, this function changes the current working directory. If FileSystem is NULL and the directory Dir contains a mapped name, then the current file system and the current directory on that file system are changed.

If FileSystem is not NULL, and Dir is NULL, then this changes the current working file system.

If FileSystem is not NULL and Dir is not NULL, then this function changes the current directory on the specified file system.

If the current working directory or the current working file system is changed then the cwd% environment variable will be updated.

Parameters:
[in]FileSystemA pointer to the file system's mapped name. If NULL, then the current working directory is changed.
[in]DirPoints to the NULL-terminated directory on the device specified by FileSystem.
Return values:
NULLCurrent directory does not exist.
Returns:
The current directory.

Sets the environment variable.

This function changes the current value of the specified environment variable. If the environment variable exists and the Value is an empty string, then the environment variable is deleted. If the environment variable exists and the Value is not an empty string, then the value of the environment variable is changed. If the environment variable does not exist and the Value is an empty string, there is no action. If the environment variable does not exist and the Value is a non-empty string, then the environment variable is created and assigned the specified value.

For a description of volatile and non-volatile environment variables, see UEFI Shell 2.0 specification section 3.6.1.

Parameters:
[in]NamePoints to the NULL-terminated environment variable name.
[in]ValuePoints to the NULL-terminated environment variable value. If the value is an empty string then the environment variable is deleted.
[in]VolatileIndicates whether the variable is non-volatile (FALSE) or volatile (TRUE).
Return values:
EFI_SUCCESSThe environment variable was successfully updated.
typedef VOID ( EFIAPI *  UGA_REGISTER_KEY_NOTIFY_CALLBACK)

Disables the page break output mode.

Enables the page break output mode.

Release the specified RSA Context.

Parameters:
[in]RsaContextPointer to the RSA context to be released.

C Interrupt Handler calledin the interrupt context when Source interrupt is active.

Parameters:
SourceSource of the interrupt. Hardware routing off a specific platform defines what source means.
SystemContextPointer to system register context. Mostly used by debuggers and will update the system context after the return from the interrupt if modified. Don't change these values unless you know what you are doing

Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI runtime.

This function reapplies relocation fixups to the PE/COFF image specified by ImageBase and ImageSize so the image will execute correctly when the PE/COFF image is mapped to the address specified by VirtualImageBase. RelocationData must be identical to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().

Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.

Parameters:
ImageBaseBase address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage().

Release the specified RSA Context.

Parameters:
[in]RsaContextPointer to the RSA context to be released.

C Interrupt Handler calledin the interrupt context when Source interrupt is active.

Parameters:
SourceSource of the interrupt. Hardware routing off a specific platform defines what source means.
SystemContextPointer to system register context. Mostly used by debuggers and will update the system context after the return from the interrupt if modified. Don't change these values unless you know what you are doing

Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI runtime.

This function reapplies relocation fixups to the PE/COFF image specified by ImageBase and ImageSize so the image will execute correctly when the PE/COFF image is mapped to the address specified by VirtualImageBase. RelocationData must be identical to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().

Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.

Parameters:
ImageBaseBase address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage().

The prototype is called back when an IP packet is received.

Parameters:
[in]StatusThe result of the receive request.
[in]IcmpErrValid when Status is EFI_ICMP_ERROR.
[in]NetSessionThe IP session for the received packet.
[in]PktThe packet received.
[in]ContextThe data provided by the user for the received packet when the callback is registered in IP_IO_OPEN_DATA::RcvdContext.

The prototype is called back when an IP packet is sent.

Parameters:
[in]StatusResult of the IP packet being sent.
[in]ContextThe data provided by user for the received packet when the callback is registered in IP_IO_OPEN_DATA::SndContext.
[in]SenderA Union type to specify a pointer of EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL.
[in]NotifyDataThe Context data specified when calling IpIoSend()

Prototype called when receiving or sending packets to or from a UDP point.

This prototype is used by both receive and sending when calling UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then provided to the callback as a reference.

Parameters:
[in]PacketThe packet received or sent.
[in]EndPointThe UDP address pair corresponds to the UDP IO.
[in]IoStatusThe packet receiving or sending status.
[in]ContextThe user-defined data when calling UdpIoRecvDatagram() or UdpIoSendDatagram().

Given a pointer to a new VM context, debug one or more instructions.

Parameters:
[in]ThisA pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]VmPtrA pointer to a VM context.
Return values:
EFI_UNSUPPORTEDNo support for it.
EFI_SUCCESSDebug one or more instructions.

This function is a prototype for a periodic SMI handler function that may be enabled with PeriodicSmiEnable() and disabled with PeriodicSmiDisable().

Parameters:
[in]ContextContent registered with PeriodicSmiEnable().
[in]ElapsedTimeThe actual time in 100ns units elasped since this function was called. A value of 0 indicates an unknown amount of time.

This function is a prototype for a function that dumps information on a protocol to a given location. The location is dependant on the implementation. This is used when programatically adding shell commands.

Parameters:
[in]HandleThe handle the protocol is on.
[in]InterfaceThe interface to the protocol.

Internal interface to add protocol handlers.

This function is for internal shell use only. This is how protocol handlers are added. This will get the current protocol info and add the new info or update existing info and then resave the info.

Parameters:
[in]ProtocolThe pointer to the protocol's GUID.
[in]DumpTokenThe function pointer to dump token function or NULL.
[in]DumpInfoThe function pointer to dump infomation function or NULL.
[in]IdStringThe English name of the protocol.

This is an internal shell function to free any and all allocated resources. This should be called immediately prior to closing the shell.

This function enables the page break mode.

This mode causes the output to pause after each complete screen to enable a user to more easily read it. If AutoWrap is TRUE, then rows with too many characters will be chopped and divided into 2 rows. If FALSE, then rows with too many characters may not be fully visible to the user on the screen.

Parameters:
[in]StartRowThe row number to start this on.
[in]AutoWrapWhether to auto wrap rows that are too long.

This function disables the page break mode.

Disabling this causes the output to print out exactly as coded, with no breaks for readability.

This function sets the keys to filter for for the console in. The valid values to set are:

#define EFI_OUTPUT_SCROLL 0x00000001 #define EFI_OUTPUT_PAUSE 0x00000002 #define EFI_EXECUTION_BREAK 0x00000004

Parameters:
[in]KeyFilterThe new key filter to use.

This is an internal shell function used to increment the shell nesting level.

This is an internal shell function used to decrement the shell nesting level.

Close the console proxy to restore the original console.

This is an internal shell function to handle shell cascading. It restores the original set of console protocols.

Parameters:
[in]ConInHandleThe handle of ConIn.
[in,out]ConInThe pointer to the location to return the pointer to the original console input.
[in]ConOutHandleThe handle of ConOut
[in,out]ConOutThe pointer to the location to return the pointer to the original console output.

For ease of use the shell maps handle #'s to short numbers. This is only done on request for various internal commands and the references are immediately freed when the internal command completes.

This is an internal shell function to enumerate the handle database.

This must be called after INIT_HANDLE_ENUMERATOR.

This function releases all memory and resources associated with the handle database. After this no other handle enumerator functions except INIT_HANDLE_ENUMERATOR will function properly.

This is an internal shell function to initialize the protocol enumerator.

This must be called before NEXT_PROTOCOL_INFO, SKIP_PROTOCOL_INFO, RESET_PROTOCOL_INFO_ENUMERATOR, and CLOSE_PROTOCOL_INFO_ENUMERATOR are called.

This function is an internal shell function for enumeration of protocols.

This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be called after INIT_PROTOCOL_INFO_ENUMERATOR.

This function resets the list of protocols such that the next one in the list is the begining of the list.

This function is an internal shell function for enumeration of protocols.

This must be called after INIT_PROTOCOL_INFO_ENUMERATOR. After this call no protocol enumerator calls except INIT_PROTOCOL_INFO_ENUMERATOR may be made.

This function frees any memory or resources associated with the protocol enumerator.

a ASM function to transfer control to OS.

Parameters:
S3WakingVectorThe S3 waking up vector saved in ACPI Facs table
AcpiLowMemoryBasea buffer under 1M which could be used during the transfer

Release the specified RSA Context.

Parameters:
[in]RsaContextPointer to the RSA context to be released.

C Interrupt Handler calledin the interrupt context when Source interrupt is active.

Parameters:
SourceSource of the interrupt. Hardware routing off a specific platform defines what source means.
SystemContextPointer to system register context. Mostly used by debuggers and will update the system context after the return from the interrupt if modified. Don't change these values unless you know what you are doing

Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI runtime.

This function reapplies relocation fixups to the PE/COFF image specified by ImageBase and ImageSize so the image will execute correctly when the PE/COFF image is mapped to the address specified by VirtualImageBase. RelocationData must be identical to the FiuxupData buffer from the PE_COFF_LOADER_IMAGE_CONTEXT structure after this PE/COFF image was relocated with PeCoffLoaderRelocateImage().

Note that if the platform does not maintain coherency between the instruction cache(s) and the data cache(s) in hardware, then the caller is responsible for performing cache maintenance operations prior to transferring control to a PE/COFF image that is loaded using this library.

Parameters:
ImageBaseBase address of a PE/COFF image that has been loaded and relocated into system memory.
VirtImageBaseThe request virtual address that the PE/COFF image is to be fixed up for.
ImageSizeThe size, in bytes, of the PE/COFF image.
RelocationDataA pointer to the relocation data that was collected when the PE/COFF image was relocated using PeCoffLoaderRelocateImage().

The prototype is called back when an IP packet is received.

Parameters:
[in]StatusThe result of the receive request.
[in]IcmpErrValid when Status is EFI_ICMP_ERROR.
[in]NetSessionThe IP session for the received packet.
[in]PktThe packet received.
[in]ContextThe data provided by the user for the received packet when the callback is registered in IP_IO_OPEN_DATA::RcvdContext.

The prototype is called back when an IP packet is sent.

Parameters:
[in]StatusResult of the IP packet being sent.
[in]ContextThe data provided by user for the received packet when the callback is registered in IP_IO_OPEN_DATA::SndContext.
[in]SenderA Union type to specify a pointer of EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL.
[in]NotifyDataThe Context data specified when calling IpIoSend()

Prototype called when receiving or sending packets to or from a UDP point.

This prototype is used by both receive and sending when calling UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the UDP access point and released by the user. When sending, the user allocates the the NetBuf, which is then provided to the callback as a reference.

Parameters:
[in]PacketThe packet received or sent.
[in]EndPointThe UDP address pair corresponds to the UDP IO.
[in]IoStatusThe packet receiving or sending status.
[in]ContextThe user-defined data when calling UdpIoRecvDatagram() or UdpIoSendDatagram().

Given a pointer to a new VM context, debug one or more instructions.

Parameters:
[in]ThisA pointer to the EFI_EBC_SIMPLE_DEBUGGER_PROTOCOL structure.
[in]VmPtrA pointer to a VM context.
Return values:
EFI_UNSUPPORTEDNo support for it.
EFI_SUCCESSDebug one or more instructions.

This function is a prototype for a periodic SMI handler function that may be enabled with PeriodicSmiEnable() and disabled with PeriodicSmiDisable().

Parameters:
[in]ContextContent registered with PeriodicSmiEnable().
[in]ElapsedTimeThe actual time in 100ns units elasped since this function was called. A value of 0 indicates an unknown amount of time.

This function is a prototype for a function that dumps information on a protocol to a given location. The location is dependant on the implementation. This is used when programatically adding shell commands.

Parameters:
[in]HandleThe handle the protocol is on.
[in]InterfaceThe interface to the protocol.

Internal interface to add protocol handlers.

This function is for internal shell use only. This is how protocol handlers are added. This will get the current protocol info and add the new info or update existing info and then resave the info.

Parameters:
[in]ProtocolThe pointer to the protocol's GUID.
[in]DumpTokenThe function pointer to dump token function or NULL.
[in]DumpInfoThe function pointer to dump infomation function or NULL.
[in]IdStringThe English name of the protocol.

This is an internal shell function to free any and all allocated resources. This should be called immediately prior to closing the shell.

This function enables the page break mode.

This mode causes the output to pause after each complete screen to enable a user to more easily read it. If AutoWrap is TRUE, then rows with too many characters will be chopped and divided into 2 rows. If FALSE, then rows with too many characters may not be fully visible to the user on the screen.

Parameters:
[in]StartRowThe row number to start this on.
[in]AutoWrapWhether to auto wrap rows that are too long.

This function disables the page break mode.

Disabling this causes the output to print out exactly as coded, with no breaks for readability.

This function sets the keys to filter for for the console in. The valid values to set are:

#define EFI_OUTPUT_SCROLL 0x00000001 #define EFI_OUTPUT_PAUSE 0x00000002 #define EFI_EXECUTION_BREAK 0x00000004

Parameters:
[in]KeyFilterThe new key filter to use.

This is an internal shell function used to increment the shell nesting level.

This is an internal shell function used to decrement the shell nesting level.

Close the console proxy to restore the original console.

This is an internal shell function to handle shell cascading. It restores the original set of console protocols.

Parameters:
[in]ConInHandleThe handle of ConIn.
[in,out]ConInThe pointer to the location to return the pointer to the original console input.
[in]ConOutHandleThe handle of ConOut
[in,out]ConOutThe pointer to the location to return the pointer to the original console output.

For ease of use the shell maps handle #'s to short numbers. This is only done on request for various internal commands and the references are immediately freed when the internal command completes.

This is an internal shell function to enumerate the handle database.

This must be called after INIT_HANDLE_ENUMERATOR.

This function releases all memory and resources associated with the handle database. After this no other handle enumerator functions except INIT_HANDLE_ENUMERATOR will function properly.

This is an internal shell function to initialize the protocol enumerator.

This must be called before NEXT_PROTOCOL_INFO, SKIP_PROTOCOL_INFO, RESET_PROTOCOL_INFO_ENUMERATOR, and CLOSE_PROTOCOL_INFO_ENUMERATOR are called.

This function is an internal shell function for enumeration of protocols.

This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be called after INIT_PROTOCOL_INFO_ENUMERATOR.

This function resets the list of protocols such that the next one in the list is the begining of the list.

This function is an internal shell function for enumeration of protocols.

This must be called after INIT_PROTOCOL_INFO_ENUMERATOR. After this call no protocol enumerator calls except INIT_PROTOCOL_INFO_ENUMERATOR may be made.

This function frees any memory or resources associated with the protocol enumerator.

a ASM function to transfer control to OS.

Parameters:
S3WakingVectorThe S3 waking up vector saved in ACPI Facs table
AcpiLowMemoryBasea buffer under 1M which could be used during the transfer

Variable Documentation

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines