#include <Uefi.h>
#include <Protocol/Shell.h>
#include <Protocol/ShellParameters.h>
#include <Protocol/UnicodeCollation.h>
#include <Protocol/SimpleFileSystem.h>
#include <Library/UefiBootServicesTableLib.h>

Data Structures
struct	SHELL_MAP_LIST

struct	COMMAND_LIST

struct	ALIAS_LIST

struct	SCRIPT_COMMAND_LIST

struct	SCRIPT_FILE

struct	BUFFER_LIST

Typedefs
typedef CONST CHAR16 (EFIAPI	SHELL_GET_MAN_FILENAME) (VOID)

typedef SHELL_STATUS(EFIAPI *	SHELL_RUN_COMMAND) (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Enumerations
enum	SHELL_MAPPING_TYPE { MappingTypeFileSystem , MappingTypeBlockIo , MappingTypeMax }

enum	SHELL_SORT_FILE_LIST { ShellSortFileListByFileName , ShellSortFileListByFullName , ShellSortFileListMax }

Functions
RETURN_STATUS EFIAPI	ShellCommandRegisterCommandName (IN CONST CHAR16 CommandString, IN SHELL_RUN_COMMAND CommandHandler, IN SHELL_GET_MAN_FILENAME GetManFileName, IN UINT32 ShellMinSupportLevel, IN CONST CHAR16 ProfileName, IN CONST BOOLEAN CanAffectLE, IN CONST EFI_HII_HANDLE HiiHandle, IN CONST EFI_STRING_ID ManFormatHelp)

RETURN_STATUS EFIAPI	ShellCommandRunCommandHandler (IN CONST CHAR16 CommandString, IN OUT SHELL_STATUS RetVal, IN OUT BOOLEAN *CanAffectLE OPTIONAL)

CONST CHAR16 *EFIAPI	ShellCommandGetManFileNameHandler (IN CONST CHAR16 *CommandString)

CONST COMMAND_LIST *EFIAPI	ShellCommandGetCommandList (IN CONST BOOLEAN Sort)

RETURN_STATUS EFIAPI	ShellCommandRegisterAlias (IN CONST CHAR16 Command, IN CONST CHAR16 Alias)

CONST ALIAS_LIST *EFIAPI	ShellCommandGetInitAliasList (VOID)

BOOLEAN EFIAPI	ShellCommandIsOnAliasList (IN CONST CHAR16 *Alias)

BOOLEAN EFIAPI	ShellCommandIsCommandOnList (IN CONST CHAR16 *CommandString)

CHAR16 *EFIAPI	ShellCommandGetCommandHelp (IN CONST CHAR16 *CommandString)

EFI_STATUS EFIAPI	CommandInit (VOID)

BOOLEAN EFIAPI	ShellCommandGetEchoState (VOID)

VOID EFIAPI	ShellCommandSetEchoState (IN BOOLEAN State)

VOID EFIAPI	ShellCommandRegisterExit (IN BOOLEAN ScriptOnly, IN CONST UINT64 ErrorCode)

UINT64 EFIAPI	ShellCommandGetExitCode (VOID)

BOOLEAN EFIAPI	ShellCommandGetExit (VOID)

BOOLEAN EFIAPI	ShellCommandGetScriptExit (VOID)

SCRIPT_FILE *EFIAPI	ShellCommandGetCurrentScriptFile (VOID)

SCRIPT_FILE *EFIAPI	ShellCommandSetNewScript (IN SCRIPT_FILE *Script OPTIONAL)

VOID EFIAPI	DeleteScriptFileStruct (IN SCRIPT_FILE *Script)

CONST CHAR16 *EFIAPI	ShellCommandGetProfileList (VOID)

CHAR16 *EFIAPI	ShellCommandCreateNewMappingName (IN CONST SHELL_MAPPING_TYPE Type)

EFI_STATUS EFIAPI	ShellCommandConsistMappingInitialize (EFI_DEVICE_PATH_PROTOCOL ***Table)

EFI_STATUS EFIAPI	ShellCommandConsistMappingUnInitialize (EFI_DEVICE_PATH_PROTOCOL **Table)

CHAR16 *EFIAPI	ShellCommandConsistMappingGenMappingName (IN EFI_DEVICE_PATH_PROTOCOL DevicePath, IN EFI_DEVICE_PATH_PROTOCOL *Table)

SHELL_MAP_LIST *EFIAPI	ShellCommandFindMapItem (IN CONST CHAR16 *MapKey)

EFI_STATUS EFIAPI	ShellCommandAddMapItemAndUpdatePath (IN CONST CHAR16 Name, IN CONST EFI_DEVICE_PATH_PROTOCOL DevicePath, IN CONST UINT64 Flags, IN CONST BOOLEAN Path)

EFI_STATUS EFIAPI	ShellCommandCreateInitialMappingsAndPaths (VOID)

EFI_STATUS EFIAPI	ShellCommandUpdateMapping (VOID)

EFI_FILE_PROTOCOL *EFIAPI	ConvertShellHandleToEfiFileProtocol (IN CONST SHELL_FILE_HANDLE Handle)

BOOLEAN EFIAPI	ShellFileHandleRemove (IN CONST SHELL_FILE_HANDLE Handle)

SHELL_FILE_HANDLE EFIAPI	ConvertEfiFileProtocolToShellHandle (IN CONST EFI_FILE_PROTOCOL Handle, IN CONST CHAR16 Path)

CONST CHAR16 *EFIAPI	ShellFileHandleGetPath (IN CONST SHELL_FILE_HANDLE Handle)

BOOLEAN EFIAPI	ShellFileHandleEof (IN SHELL_FILE_HANDLE Handle)

VOID EFIAPI	FreeBufferList (IN BUFFER_LIST *List)

VOID EFIAPI	DumpHex (IN UINTN Indent, IN UINTN Offset, IN UINTN DataSize, IN VOID *UserData)

CHAR16 *EFIAPI	CatSDumpHex (IN CHAR16 Buffer, IN UINTN Indent, IN UINTN Offset, IN UINTN DataSize, IN VOID UserData)

EFI_STATUS EFIAPI	ShellSortFileList (IN OUT EFI_SHELL_FILE_INFO FileList, OUT EFI_SHELL_FILE_INFO Duplicates OPTIONAL, IN SHELL_SORT_FILE_LIST Order)

Variables
EFI_UNICODE_COLLATION_PROTOCOL *	gUnicodeCollation

CONST CHAR16 *	SupportLevel []

SHELL_MAP_LIST	gShellMapList
	List of Mappings - DeviceName and Drive Letter(ism).

SHELL_MAP_LIST *	gShellCurMapping
	Pointer to node of current directory in the mMapList.

Detailed Description

Provides interface to shell internal functions for shell commands.

This library is for use ONLY by shell commands linked into the shell application. This library will not function if it is used for UEFI Shell 2.0 Applications.

Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2016 Hewlett Packard Enterprise Development LP
(C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ShellCommandLib.h.

Typedef Documentation

◆ SHELL_GET_MAN_FILENAME

typedef CONST CHAR16 *(EFIAPI * SHELL_GET_MAN_FILENAME) (VOID)

Returns the help MAN fileName for a given shell command.

Return values

!NULL	The unicode string of the MAN filename.
NULL	An error ocurred.

Definition at line 55 of file ShellCommandLib.h.

◆ SHELL_RUN_COMMAND

typedef SHELL_STATUS(EFIAPI * SHELL_RUN_COMMAND) (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Runs a shell command on a given command line.

The specific operation of a given shell command is specified in the UEFI Shell Specification 2.0, or in the source of the given command.

Upon completion of the command run the shell protocol and environment variables may have been updated due to the operation.

Parameters

[in]	ImageHandle	The ImageHandle to the app, or NULL if the command built into shell.
[in]	SystemTable	The pointer to the system table.

Return values

RETURN_SUCCESS	The shell command was successful.
RETURN_UNSUPPORTED	The command is not supported.

Definition at line 77 of file ShellCommandLib.h.

Enumeration Type Documentation

◆ SHELL_MAPPING_TYPE

enum SHELL_MAPPING_TYPE

Definition at line 450 of file ShellCommandLib.h.

◆ SHELL_SORT_FILE_LIST

enum SHELL_SORT_FILE_LIST

Definition at line 717 of file ShellCommandLib.h.

Function Documentation

◆ CatSDumpHex()

CHAR16 *EFIAPI CatSDumpHex	(	IN CHAR16 *	Buffer,
		IN UINTN	Indent,
		IN UINTN	Offset,
		IN UINTN	DataSize,
		IN VOID *	UserData
	)

Dump HEX data into buffer.

Parameters

[in]	Buffer	HEX data to be dumped in Buffer.
[in]	Indent	How many spaces to indent the output.
[in]	Offset	The offset of the printing.
[in]	DataSize	The size in bytes of UserData.
[in]	UserData	The data to print out.

Definition at line 1982 of file UefiShellCommandLib.c.

◆ CommandInit()

EFI_STATUS EFIAPI CommandInit ( VOID )

Function to make sure that the above pointers are valid.

Function to make sure that the global protocol pointers are valid. must be called after constructor before accessing the pointers.

Definition at line 65 of file UefiShellCommandLib.c.

◆ ConvertEfiFileProtocolToShellHandle()

SHELL_FILE_HANDLE EFIAPI ConvertEfiFileProtocolToShellHandle	(	IN CONST EFI_FILE_PROTOCOL *	Handle,
		IN CONST CHAR16 *	Path
	)

Converts a EFI_FILE_PROTOCOL* to an SHELL_FILE_HANDLE.

Parameters

[in]	Handle	The pointer to EFI_FILE_PROTOCOL to convert.
[in]	Path	The path to the file for verification.

Returns: a SHELL_FILE_HANDLE representing the same file.

Converts a EFI_FILE_PROTOCOL* to an SHELL_FILE_HANDLE.

Parameters

[in]	Handle	The pointer to EFI_FILE_PROTOCOL to convert.
[in]	Path	The path to the file for verification.

Returns: A SHELL_FILE_HANDLE representing the same file.

Return values

NULL	There was not enough memory.

Definition at line 1742 of file UefiShellCommandLib.c.

◆ ConvertShellHandleToEfiFileProtocol()

EFI_FILE_PROTOCOL *EFIAPI ConvertShellHandleToEfiFileProtocol ( IN CONST SHELL_FILE_HANDLE Handle )

Converts a SHELL_FILE_HANDLE to an EFI_FILE_PROTOCOL*.

Parameters

[in] Handle The SHELL_FILE_HANDLE to convert.

Returns: a EFI_FILE_PROTOCOL* representing the same file.

Definition at line 1724 of file UefiShellCommandLib.c.

◆ DeleteScriptFileStruct()

VOID EFIAPI DeleteScriptFileStruct ( IN SCRIPT_FILE * Script )

Function to cleanup all memory from a SCRIPT_FILE structure.

Parameters

[in] Script The pointer to the structure to cleanup.

Definition at line 1141 of file UefiShellCommandLib.c.

◆ DumpHex()

VOID EFIAPI DumpHex	(	IN UINTN	Indent,
		IN UINTN	Offset,
		IN UINTN	DataSize,
		IN VOID *	UserData
	)

Function printing hex output to the console.

Parameters

[in]	Indent	Number of spaces to indent.
[in]	Offset	Offset to start with.
[in]	DataSize	Length of data.
[in]	UserData	Pointer to some data.

Dump some hexadecimal data to the screen.

Parameters

[in]	Indent	How many spaces to indent the output.
[in]	Offset	The offset of the printing.
[in]	DataSize	The size in bytes of UserData.
[in]	UserData	The data to print out.

Definition at line 1929 of file UefiShellCommandLib.c.

◆ FreeBufferList()

VOID EFIAPI FreeBufferList ( IN BUFFER_LIST * List )

Frees any BUFFER_LIST defined type.

Parameters

[in] List The pointer to the list head.

Frees any BUFFER_LIST defined type.

Parameters

[in] List The BUFFER_LIST object to free.

Definition at line 1892 of file UefiShellCommandLib.c.

◆ ShellCommandAddMapItemAndUpdatePath()

EFI_STATUS EFIAPI ShellCommandAddMapItemAndUpdatePath	(	IN CONST CHAR16 *	Name,
		IN CONST EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		IN CONST UINT64	Flags,
		IN CONST BOOLEAN	Path
	)

Function to add a map node to the list of map items and update the "path" environment variable (optionally).

If Path is TRUE (during initialization only), the path environment variable will also be updated to include default paths on the new map name...

Path should be FALSE when this function is called from the protocol SetMap function.

Parameters

[in]	Name	The human readable mapped name.
[in]	DevicePath	The Device Path for this map.
[in]	Flags	The Flags attribute for this map item.
[in]	Path	TRUE to update path, FALSE to skip this step (should only be TRUE during initialization).

Return values

EFI_SUCCESS	The addition was successful.
EFI_OUT_OF_RESOURCES	A memory allocation failed.
EFI_INVALID_PARAMETER	A parameter was invalid.

Definition at line 1299 of file UefiShellCommandLib.c.

◆ ShellCommandConsistMappingGenMappingName()

CHAR16 *EFIAPI ShellCommandConsistMappingGenMappingName	(	IN EFI_DEVICE_PATH_PROTOCOL *	DevicePath,
		IN EFI_DEVICE_PATH_PROTOCOL **	Table
	)

Create a consistent mapped name for the device specified by DevicePath based on the Table.

This must be called after ShellCommandConsistMappingInitialize() and before ShellCommandConsistMappingUnInitialize() is called.

Parameters

[in]	DevicePath	The pointer to the dev path for the device.
[in]	Table	The Table of mapping information.

Return values

NULL	A consistent mapped name could not be created.

Returns: A pointer to a string allocated from pool with the device name.

Definition at line 1632 of file ConsistMapping.c.

◆ ShellCommandConsistMappingInitialize()

EFI_STATUS EFIAPI ShellCommandConsistMappingInitialize ( EFI_DEVICE_PATH_PROTOCOL *** Table )

Function to initialize the table for creating consistent map names.

Parameters

[out] Table The pointer to pointer to pointer to DevicePathProtocol object.

Return values

EFI_SUCCESS The table was created successfully.

◆ ShellCommandConsistMappingUnInitialize()

EFI_STATUS EFIAPI ShellCommandConsistMappingUnInitialize ( EFI_DEVICE_PATH_PROTOCOL ** Table )

Function to uninitialize the table for creating consistent map names.

The parameter must have been received from ShellCommandConsistMappingInitialize.

Parameters

[out] Table The pointer to pointer to DevicePathProtocol object.

Return values

EFI_SUCCESS The table was deleted successfully.

Definition at line 1601 of file ConsistMapping.c.

◆ ShellCommandCreateInitialMappingsAndPaths()

EFI_STATUS EFIAPI ShellCommandCreateInitialMappingsAndPaths ( VOID )

Creates the default map names for each device path in the system with a protocol depending on the Type.

Also sets up the default path environment variable if Type is FileSystem.

Return values

EFI_SUCCESS	All map names were created successfully.
EFI_NOT_FOUND	No protocols were found in the system.

Returns: Error returned from gBS->LocateHandle().

See also: LocateHandle

Creates the default map names for each device path in the system with a protocol depending on the Type.

Creates the consistent map names for each device path in the system with a protocol depending on the Type.

Note: This will reset all mappings in the system("map -r").

Also sets up the default path environment variable if Type is FileSystem.

Return values

EFI_SUCCESS	All map names were created successfully.
EFI_NOT_FOUND	No protocols were found in the system.

Returns: Error returned from gBS->LocateHandle().

See also: LocateHandle

Definition at line 1389 of file UefiShellCommandLib.c.

◆ ShellCommandCreateNewMappingName()

CHAR16 *EFIAPI ShellCommandCreateNewMappingName ( IN CONST SHELL_MAPPING_TYPE Type )

Function to generate the next default mapping name.

If the return value is not NULL then it must be callee freed.

Parameters

Type	What kind of mapping name to make.

Return values

NULL	a memory allocation failed.

Returns: a new map name string

Definition at line 1255 of file UefiShellCommandLib.c.

◆ ShellCommandFindMapItem()

SHELL_MAP_LIST *EFIAPI ShellCommandFindMapItem ( IN CONST CHAR16 * MapKey )

Function to search the list of mappings for the first matching node on the list based on the MapKey.

Parameters

[in] MapKey The pointer to the string key to search for in the map.

Returns: the node on the list.

Function to search the list of mappings for the node on the list based on the key.

Parameters

[in] MapKey String Key to search for on the map

Returns: the node on the list.

Definition at line 1712 of file ConsistMapping.c.

◆ ShellCommandGetCommandHelp()

CHAR16 *EFIAPI ShellCommandGetCommandHelp ( IN CONST CHAR16 * CommandString )

Get the help text for a command.

Parameters

[in] CommandString The command name.

Return values

NULL	No help text was found.

Returns: The string of the help text. The caller required to free.

Get the help text for a command.

Parameters

[in] CommandString The command name.

Return values

NULL	No help text was found.

Returns: String of help text.Caller reuiqred to free.

Definition at line 513 of file UefiShellCommandLib.c.

◆ ShellCommandGetCommandList()

CONST COMMAND_LIST *EFIAPI ShellCommandGetCommandList ( IN CONST BOOLEAN Sort )

Get the list of all available shell internal commands. This is a linked list, via the LIST_ENTRY structure. Enumerate through it using the BaseLib linked list functions. Do not modify the values.

Parameters

[in] Sort TRUE to alphabetically sort the values first. FALSE otherwise.

Returns: A linked list of all available shell commands.

Get the list of all available shell internal commands. This is a linked list (via LIST_ENTRY structure). enumerate through it using the BaseLib linked list functions. do not modify the values.

Parameters

[in] Sort TRUE to alphabetically sort the values first. FALSE otherwise.

Returns: a Linked list of all available shell commands.

Definition at line 860 of file UefiShellCommandLib.c.

◆ ShellCommandGetCurrentScriptFile()

SCRIPT_FILE *EFIAPI ShellCommandGetCurrentScriptFile ( VOID )

Function to return a pointer to the currently running script file object.

Return values

NULL	A script file is not currently running.

Returns: A pointer to the current script file object.

Definition at line 1188 of file UefiShellCommandLib.c.

◆ ShellCommandGetEchoState()

BOOLEAN EFIAPI ShellCommandGetEchoState ( VOID )

Function to determine current state of ECHO. Echo determines if lines from scripts and ECHO commands are enabled.

Return values

TRUE	Echo is currently enabled.
FALSE	Echo is currently disabled.

Function to determine current state of ECHO. Echo determines if lines from scripts and ECHO commands are enabled.

Return values

TRUE	Echo is currently enabled
FALSE	Echo is currently disabled

Definition at line 1038 of file UefiShellCommandLib.c.

◆ ShellCommandGetExit()

BOOLEAN EFIAPI ShellCommandGetExit ( VOID )

Retrieve the Exit indicator.

Return values

TRUE	Exit was indicated.
FALSE	Exit was not indicated.

Retrieve the Exit indicator.

Return values

TRUE	Exit was indicated.
FALSE	Exis was not indicated.

Definition at line 1094 of file UefiShellCommandLib.c.

◆ ShellCommandGetExitCode()

UINT64 EFIAPI ShellCommandGetExitCode ( VOID )

Retrieve the Exit code.

Returns: the value passed into RegisterExit.

Retrieve the Exit code.

If ShellCommandGetExit returns FALSE than the return from this is undefined.

Returns: the value passed into RegisterExit.

Definition at line 1110 of file UefiShellCommandLib.c.

◆ ShellCommandGetInitAliasList()

CONST ALIAS_LIST *EFIAPI ShellCommandGetInitAliasList ( VOID )

Get the list of all shell alias commands. This is a linked list, via LIST_ENTRY structure. Enumerate through it using the BaseLib linked list functions. Do not modify the values.

Returns: A linked list of all requested shell aliases.

Get the list of all shell alias commands. This is a linked list (via LIST_ENTRY structure). enumerate through it using the BaseLib linked list functions. do not modify the values.

Returns: a Linked list of all requested shell alias'.

Definition at line 967 of file UefiShellCommandLib.c.

◆ ShellCommandGetManFileNameHandler()

CONST CHAR16 *EFIAPI ShellCommandGetManFileNameHandler ( IN CONST CHAR16 * CommandString )

Checks if a command string has been registered for CommandString, and if so, it returns the MAN filename specified for that command.

If CommandString is NULL, then ASSERT().

Parameters

[in] CommandString The pointer to the command name. This is the name found on the command line in the shell.

Return values

NULL	The CommandString was not a registered command.
other	The name of the MAN file.

See also: SHELL_GET_MAN_FILENAME

Checks if a command string has been registered for CommandString and if so it returns the MAN filename specified for that command.

If CommandString is NULL, then ASSERT().

Parameters

[in] CommandString Pointer to the command name. This is the name found on the command line in the shell.\

Return values

NULL	the commandString was not a registered command.

Returns: other the name of the MAN file.

See also: SHELL_GET_MAN_FILENAME

Definition at line 815 of file UefiShellCommandLib.c.

◆ ShellCommandGetProfileList()

CONST CHAR16 *EFIAPI ShellCommandGetProfileList ( VOID )

Function to get the current Profile string.

This is used to retrieve what profiles were installed.

Return values

NULL	There are no installed profiles.

Returns: A semicolon-delimited list of profiles.

Function to get the current Profile string.

Return values

NULL	There are no installed profiles.

Returns: A semi-colon delimited list of profiles.

Definition at line 706 of file UefiShellCommandLib.c.

◆ ShellCommandGetScriptExit()

BOOLEAN EFIAPI ShellCommandGetScriptExit ( VOID )

Retrieve the Exit script indicator.

If ShellCommandGetExit returns FALSE, then the return from this is undefined.

Return values

TRUE	ScriptOnly was indicated.
FALSE	ScriptOnly was not indicated.

Retrieve the Exit script indicator.

If ShellCommandGetExit returns FALSE than the return from this is undefined.

Return values

TRUE	ScriptOnly was indicated.
FALSE	ScriptOnly was not indicated.

Definition at line 1127 of file UefiShellCommandLib.c.

◆ ShellCommandIsCommandOnList()

BOOLEAN EFIAPI ShellCommandIsCommandOnList ( IN CONST CHAR16 * CommandString )

Checks if a command is already on the list.

Parameters

[in] CommandString The command string to check for on the list.

Return values

TRUE	CommandString represents a registered command.
FALSE	CommandString does not represent a registered command.

Checks if a command exists, either internally or through the dynamic command protocol.

Parameters

[in] CommandString The command string to check for on the list.

Definition at line 423 of file UefiShellCommandLib.c.

◆ ShellCommandIsOnAliasList()

BOOLEAN EFIAPI ShellCommandIsOnAliasList ( IN CONST CHAR16 * Alias )

Determine if a given alias is on the list of built in aliases.

Parameters

[in] Alias The alias to test for.

Return values

TRUE	The alias is a built in alias.
FALSE	The alias is not a built in alias.

Determine if a given alias is on the list of built in alias'.

Parameters

[in] Alias The alias to test for

Return values

TRUE	The alias is a built in alias
FALSE	The alias is not a built in alias

Definition at line 984 of file UefiShellCommandLib.c.

◆ ShellCommandRegisterAlias()

RETURN_STATUS EFIAPI ShellCommandRegisterAlias	(	IN CONST CHAR16 *	Command,
		IN CONST CHAR16 *	Alias
	)

Registers aliases to be set as part of the initialization of the shell application.

If Command is NULL, then ASSERT(). If Alias is NULL, then ASSERT().

Parameters

[in]	Command	The pointer to the Command.
[in]	Alias	The pointer to Alias.

Return values

RETURN_SUCCESS	The handlers were registered.
RETURN_OUT_OF_RESOURCES	There are not enough resources available to register the shell command.

Registers aliases to be set as part of the initialization of the shell application.

If Command is NULL, then ASSERT(). If Alias is NULL, then ASSERT().

Parameters

[in]	Command	Pointer to the Command
[in]	Alias	Pointer to Alias

Return values

RETURN_SUCCESS	The handlers were registered.
RETURN_OUT_OF_RESOURCES	There are not enough resources available to register the shell command.

Definition at line 885 of file UefiShellCommandLib.c.

◆ ShellCommandRegisterCommandName()

RETURN_STATUS EFIAPI ShellCommandRegisterCommandName	(	IN CONST CHAR16 *	CommandString,
		IN SHELL_RUN_COMMAND	CommandHandler,
		IN SHELL_GET_MAN_FILENAME	GetManFileName,
		IN UINT32	ShellMinSupportLevel,
		IN CONST CHAR16 *	ProfileName,
		IN CONST BOOLEAN	CanAffectLE,
		IN CONST EFI_HII_HANDLE	HiiHandle,
		IN CONST EFI_STRING_ID	ManFormatHelp
	)

Registers the handlers of type SHELL_RUN_COMMAND and SHELL_GET_MAN_FILENAME for each shell command.

If the ShellSupportLevel is greater than the value of PcdShellSupportLevel, then return RETURN_UNSUPPORTED.

Registers the the handlers specified by GetHelpInfoHandler and CommandHandler with the command specified by CommandString. If the command named by CommandString has already been registered, then return RETURN_ALREADY_STARTED.

If there are not enough resources available to register the handlers, then RETURN_OUT_OF_RESOURCES is returned.

If CommandString is NULL, then ASSERT(). If GetHelpInfoHandler is NULL, then ASSERT(). If CommandHandler is NULL, then ASSERT(). If ProfileName is NULL, then ASSERT().

Parameters

[in]	CommandString	The pointer to the command name. This is the name to look for on the command line in the shell.
[in]	CommandHandler	The pointer to a function that runs the specified command.
[in]	GetManFileName	The pointer to a function that provides man filename.
[in]	ShellMinSupportLevel	The minimum Shell Support Level which has this function.
[in]	ProfileName	The profile name to require for support of this function.
[in]	CanAffectLE	Indicates whether this command's return value can change the LASTERROR environment variable.
[in]	HiiHandle	The handle of this command's HII entry.
[in]	ManFormatHelp	The HII locator for the help text.

Return values

RETURN_SUCCESS	The handlers were registered.
RETURN_OUT_OF_RESOURCES	There are not enough resources available to register the shell command.
RETURN_UNSUPPORTED	The ShellMinSupportLevel was higher than the currently allowed support level.
RETURN_ALREADY_STARTED	The CommandString represents a command that is already registered. Only one handler set for a given command is allowed.

See also: SHELL_GET_MAN_FILENAME; SHELL_RUN_COMMAND

Registers handlers of type SHELL_RUN_COMMAND and SHELL_GET_MAN_FILENAME for each shell command.

If the ShellSupportLevel is greater than the value of the PcdShellSupportLevel then return RETURN_UNSUPPORTED.

Registers the handlers specified by GetHelpInfoHandler and CommandHandler with the command specified by CommandString. If the command named by CommandString has already been registered, then return RETURN_ALREADY_STARTED.

If there are not enough resources available to register the handlers then RETURN_OUT_OF_RESOURCES is returned.

If CommandString is NULL, then ASSERT(). If GetHelpInfoHandler is NULL, then ASSERT(). If CommandHandler is NULL, then ASSERT(). If ProfileName is NULL, then ASSERT().

Parameters

[in]	CommandString	Pointer to the command name. This is the name to look for on the command line in the shell.
[in]	CommandHandler	Pointer to a function that runs the specified command.
[in]	GetManFileName	Pointer to a function that provides man filename.
[in]	ShellMinSupportLevel	minimum Shell Support Level which has this function.
[in]	ProfileName	profile name to require for support of this function.
[in]	CanAffectLE	indicates whether this command's return value can change the LASTERROR environment variable.
[in]	HiiHandle	Handle of this command's HII entry.
[in]	ManFormatHelp	HII locator for the help text.

Return values

RETURN_SUCCESS	The handlers were registered.
RETURN_OUT_OF_RESOURCES	There are not enough resources available to register the shell command.
RETURN_UNSUPPORTED	the ShellMinSupportLevel was higher than the currently allowed support level.
RETURN_ALREADY_STARTED	The CommandString represents a command that is already registered. Only 1 handler set for a given command is allowed.

See also: SHELL_GET_MAN_FILENAME; SHELL_RUN_COMMAND

Definition at line 577 of file UefiShellCommandLib.c.

◆ ShellCommandRegisterExit()

VOID EFIAPI ShellCommandRegisterExit	(	IN BOOLEAN	ScriptOnly,
		IN CONST UINT64	ErrorCode
	)

Indicate that the current shell or script should exit.

Parameters

[in]	ScriptOnly	TRUE if exiting a script; FALSE otherwise.
[in]	ErrorCode	The 64 bit error code to return.

Definition at line 1071 of file UefiShellCommandLib.c.

◆ ShellCommandRunCommandHandler()

RETURN_STATUS EFIAPI ShellCommandRunCommandHandler	(	IN CONST CHAR16 *	CommandString,
		IN OUT SHELL_STATUS *	RetVal,
		IN OUT BOOLEAN *CanAffectLE	OPTIONAL
	)

Checks if a command string has been registered for CommandString, and if so, it runs the previously registered handler for that command with the command line.

If CommandString is NULL, then ASSERT().

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

Parameters

[in]	CommandString	The pointer to the command name. This is the name found on the command line in the shell.
[in,out]	RetVal	The pointer to the return value from the command handler.
[in,out]	CanAffectLE	Indicates whether this command's return value needs to be placed into LASTERROR environment variable.

Return values

RETURN_SUCCESS	The handler was run.
RETURN_NOT_FOUND	The CommandString did not match a registered command name.

See also: SHELL_RUN_COMMAND

Checks if a command string has been registered for CommandString and if so it runs the previously registered handler for that command with the command line.

If CommandString is NULL, then ASSERT().

If Sections is specified, then each section name listed will be compared in a casesensitive manner, to the section names described in Appendix B UEFI Shell 2.0 spec. 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]	CommandString	Pointer to the command name. This is the name found on the command line in the shell.
[in,out]	RetVal	Pointer to the return vaule from the command handler.
[in,out]	CanAffectLE	indicates whether this command's return value needs to be placed into LASTERROR environment variable.

Return values

RETURN_SUCCESS	The handler was run.
RETURN_NOT_FOUND	The CommandString did not match a registered command name.

See also: SHELL_RUN_COMMAND

Definition at line 739 of file UefiShellCommandLib.c.

◆ ShellCommandSetEchoState()

VOID EFIAPI ShellCommandSetEchoState ( IN BOOLEAN State )

Function to set current state of ECHO. Echo determines if lines from scripts and ECHO commands are enabled.

Parameters

[in] State TRUE to enable Echo, FALSE otherwise.

Function to set current state of ECHO. Echo determines if lines from scripts and ECHO commands are enabled.

If State is TRUE, Echo will be enabled. If State is FALSE, Echo will be disabled.

Parameters

[in] State How to set echo.

Definition at line 1056 of file UefiShellCommandLib.c.

◆ ShellCommandSetNewScript()

SCRIPT_FILE *EFIAPI ShellCommandSetNewScript ( IN SCRIPT_FILE *Script OPTIONAL )

Function to set a new script as the currently running one.

This function will correctly stack and unstack nested scripts.

Parameters

[in] Script The pointer to new script information structure. If NULL, it removes and de-allocates the topmost Script structure.

Returns: A pointer to the current running script file after this change. It is NULL if removing the final script.

Function to set a new script as the currently running one.

This function will correctly stack and unstack nested scripts.

Parameters

[in] Script Pointer to new script information structure. if NULL will remove and de-allocate the top-most Script structure.

Returns: A pointer to the current running script file after this change. NULL if removing the final script.

Definition at line 1215 of file UefiShellCommandLib.c.

◆ ShellCommandUpdateMapping()

EFI_STATUS EFIAPI ShellCommandUpdateMapping ( VOID )

Add mappings for any devices without one. Do not change any existing maps.

Return values

EFI_SUCCESS The operation was successful.

Definition at line 1606 of file UefiShellCommandLib.c.

◆ ShellFileHandleEof()

BOOLEAN EFIAPI ShellFileHandleEof ( IN SHELL_FILE_HANDLE Handle )

Function to determine if a SHELL_FILE_HANDLE is at the end of the file.

This will NOT work on directories.

If Handle is NULL, then ASSERT.

Parameters

[in] Handle the file handle

Return values

TRUE	the position is at the end of the file
FALSE	the position is not at the end of the file

Definition at line 1853 of file UefiShellCommandLib.c.

◆ ShellFileHandleGetPath()

CONST CHAR16 *EFIAPI ShellFileHandleGetPath ( IN CONST SHELL_FILE_HANDLE Handle )

Find the path that was logged with the specified SHELL_FILE_HANDLE.

Parameters

[in] Handle The SHELL_FILE_HANDLE to query on.

Returns: A pointer to the path for the file.

Definition at line 1787 of file UefiShellCommandLib.c.

◆ ShellFileHandleRemove()

BOOLEAN EFIAPI ShellFileHandleRemove ( IN CONST SHELL_FILE_HANDLE Handle )

Remove a SHELL_FILE_HANDLE frmo the list of SHELL_FILE_HANDLES.

Parameters

[in] Handle The SHELL_FILE_HANDLE to remove.

Return values

TRUE	The item was removed.
FALSE	The item was not found.

Remove a SHELL_FILE_HANDLE from the list of SHELL_FILE_HANDLES.

Parameters

[in] Handle The SHELL_FILE_HANDLE to remove.

Return values

TRUE	The item was removed.
FALSE	The item was not found.

Definition at line 1816 of file UefiShellCommandLib.c.

◆ ShellSortFileList()

EFI_STATUS EFIAPI ShellSortFileList	(	IN OUT EFI_SHELL_FILE_INFO **	FileList,
		OUT EFI_SHELL_FILE_INFO **Duplicates	OPTIONAL,
		IN SHELL_SORT_FILE_LIST	Order
	)

Sort an EFI_SHELL_FILE_INFO list, optionally moving duplicates to a separate list.

Parameters

[in,out]

FileList

The list of EFI_SHELL_FILE_INFO objects to sort.

                     If FileList is NULL on input, then FileList is
                     considered an empty, hence already sorted, list.

                     Otherwise, if (*FileList) is NULL on input, then
                     EFI_INVALID_PARAMETER is returned.

                     Otherwise, the caller is responsible for having
                     initialized (*FileList)->Link with
                     InitializeListHead(). No other fields in the
                     (**FileList) head element are accessed by this
                     function.

                     On output, (*FileList) is sorted according to Order.
                     If Duplicates is NULL on input, then duplicate
                     elements are preserved, sorted stably, on
                     (*FileList). If Duplicates is not NULL on input,
                     then duplicates are moved (stably sorted) to the
                     new, dynamically allocated (*Duplicates) list.

[out] Duplicates If Duplicates is NULL on input, (*FileList) will be a monotonically ordered list on output, with duplicates stably sorted.

If Duplicates is not NULL on input, (*FileList) will be a strictly monotonically oredered list on output, with duplicates separated (stably sorted) to (*Duplicates). All fields except Link will be zero-initialized in the (**Duplicates) head element. If no duplicates exist, then (*Duplicates) is set to NULL on output.

Parameters

[in] Order Determines the comparison operation between EFI_SHELL_FILE_INFO objects.

Return values

EFI_INVALID_PARAMETER	(UINTN)Order is greater than or equal to (UINTN)ShellSortFileListMax. Neither the (FileList) nor the (Duplicates) list has been modified.
EFI_INVALID_PARAMETER	(FileList) was NULL on input. Neither the (FileList) nor the (*Duplicates) list has been modified.
EFI_OUT_OF_RESOURCES	Memory allocation failed. Neither the (FileList) nor the (Duplicates) list has been modified.
EFI_SUCCESS	Sorting successful, including the case when FileList is NULL on input.

Definition at line 2165 of file UefiShellCommandLib.c.

Variable Documentation

◆ gShellCurMapping

SHELL_MAP_LIST* gShellCurMapping

extern

Pointer to node of current directory in the mMapList.

Definition at line 50 of file UefiShellCommandLib.c.

◆ gShellMapList

SHELL_MAP_LIST gShellMapList

extern

List of Mappings - DeviceName and Drive Letter(ism).

Definition at line 49 of file UefiShellCommandLib.c.

◆ gUnicodeCollation

EFI_UNICODE_COLLATION_PROTOCOL* gUnicodeCollation

extern

Definition at line 48 of file UefiShellCommandLib.c.

◆ SupportLevel

CONST CHAR16* SupportLevel[]

extern

Definition at line 52 of file UefiShellCommandLib.c.

Data Structures

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ SHELL_GET_MAN_FILENAME

◆ SHELL_RUN_COMMAND

Enumeration Type Documentation

◆ SHELL_MAPPING_TYPE

◆ SHELL_SORT_FILE_LIST

Function Documentation

◆ CatSDumpHex()

◆ CommandInit()

◆ ConvertEfiFileProtocolToShellHandle()

◆ ConvertShellHandleToEfiFileProtocol()

◆ DeleteScriptFileStruct()

◆ DumpHex()

◆ FreeBufferList()

◆ ShellCommandAddMapItemAndUpdatePath()

◆ ShellCommandConsistMappingGenMappingName()

◆ ShellCommandConsistMappingInitialize()

◆ ShellCommandConsistMappingUnInitialize()

◆ ShellCommandCreateInitialMappingsAndPaths()

◆ ShellCommandCreateNewMappingName()

◆ ShellCommandFindMapItem()

◆ ShellCommandGetCommandHelp()

◆ ShellCommandGetCommandList()

◆ ShellCommandGetCurrentScriptFile()

◆ ShellCommandGetEchoState()

◆ ShellCommandGetExit()

◆ ShellCommandGetExitCode()

◆ ShellCommandGetInitAliasList()

◆ ShellCommandGetManFileNameHandler()

◆ ShellCommandGetProfileList()

◆ ShellCommandGetScriptExit()

◆ ShellCommandIsCommandOnList()

◆ ShellCommandIsOnAliasList()

◆ ShellCommandRegisterAlias()

◆ ShellCommandRegisterCommandName()

◆ ShellCommandRegisterExit()

◆ ShellCommandRunCommandHandler()

◆ ShellCommandSetEchoState()

◆ ShellCommandSetNewScript()

◆ ShellCommandUpdateMapping()

◆ ShellFileHandleEof()

◆ ShellFileHandleGetPath()

◆ ShellFileHandleRemove()

◆ ShellSortFileList()

Variable Documentation

◆ gShellCurMapping

◆ gShellMapList

◆ gUnicodeCollation

◆ SupportLevel