sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fixed license header / copyright date on all files.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9810 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jcarsey
2010-01-25 20:05:08 +00:00
parent b4d856a6b5
commit 1e6e84c7af
29 changed files with 865 additions and 866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

270
ShellPkg/Include/Protocol/EfiShellEnvironment2.h
View File

@ -1,8 +1,8 @@
/** @file
Defines for EFI shell environment 2 ported to EDK II build environment. (no spec)
Copyright (c) 2005 - 2010, Intel Corporation<BR>
All rights reserved. This program and the accompanying materials
Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>
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
@ -12,7 +12,7 @@
**/
#if !defined (_SHELL_ENVIRONMENT_2_PROTOCOL_H_)
#define _SHELL_ENVIRONMENT_2_PROTOCOL_H_
@ -20,8 +20,8 @@
#define DEFAULT_AUTO_LF FALSE
/**
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
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.
@param Handle The handle the protocol is on.
@ -36,16 +36,16 @@ VOID
);
/**
This function is a prototype for each command internal to the EFI shell
implementation. The specific command depends on the implementation. This is
This function is a prototype for each command internal to the EFI shell
implementation. The specific command depends on the implementation. This is
used when programatically adding shell commands.
@param ImageHandle The handle to the binary shell.
@param SystemTable Pointer to the system table.
@retval EFI_SUCCESS The command ran to completion
@retval other An error ocurred. Any error is possible
depending on the implementation of the shell
@retval other An error ocurred. Any error is possible
depending on the implementation of the shell
command.
**/
@ -57,8 +57,8 @@ EFI_STATUS
);
/**
This function is a prototype for one that gets a help string for a given command.
This is used when programatically adding shell commands. Upon successful return
This function is a prototype for one that gets a help string for a given command.
This is used when programatically adding shell commands. Upon successful return
the memory allocated is up to the caller to free.
@param Str Pointer to pointer to string to display for help.
@ -76,24 +76,24 @@ EFI_STATUS
Structure returned from functions that open multiple files.
**/
typedef struct {
UINT32 Signature; ///< SHELL_FILE_ARG_SIGNATURE
LIST_ENTRY Link; ///< Linked list helper
EFI_STATUS Status; ///< File's status
UINT32 Signature; ///< SHELL_FILE_ARG_SIGNATURE.
LIST_ENTRY Link; ///< Linked list helper.
EFI_STATUS Status; ///< File's status.
EFI_FILE_HANDLE Parent; ///< What is the Parent file of this file
UINT64 OpenMode; ///< How was the file opened
CHAR16 *ParentName; ///< String representation of parent
EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; ///< DevicePath for Parent
EFI_FILE_HANDLE Parent; ///< What is the Parent file of this file.
UINT64 OpenMode; ///< How was the file opened.
CHAR16 *ParentName; ///< String representation of parent.
EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; ///< DevicePath for Parent.
CHAR16 *FullName; ///< Path and file name for this file
CHAR16 *FileName; ///< File name for this file
CHAR16 *FullName; ///< Path and file name for this file.
CHAR16 *FileName; ///< File name for this file.
EFI_FILE_HANDLE Handle; ///< Handle to this file
EFI_FILE_INFO *Info; ///< Pointer to file info for this file
EFI_FILE_HANDLE Handle; ///< Handle to this file.
EFI_FILE_INFO *Info; ///< Pointer to file info for this file.
} SHELL_FILE_ARG;
/// Signature for SHELL_FILE_ARG
#define SHELL_FILE_ARG_SIGNATURE SIGNATURE_32 ('g', 'r', 'a', 'f')
/// Signature for SHELL_FILE_ARG.
#define SHELL_FILE_ARG_SIGNATURE SIGNATURE_32 ('g', 'r', 'a', 'f')
/**
GUID for the shell environment2 and shell environment.
@ -115,12 +115,12 @@ GUID for the shell environment2 extension (main GUID above).
#define EFI_SHELL_MINOR_VER 0x00000000 ///< Minor version of the EFI_SHELL_ENVIRONMENT2
/**
Execute a command line
Execute a command line.
This function will run the CommandLine. This includes loading any required images,
parsing any requires scripts, and it DebugOutput is TRUE printing errors
This function will run the CommandLine. This includes loading any required images,
parsing any requires scripts, and if DebugOutput is TRUE printing errors
encountered directly to the screen.
@param ParentImageHandle Handle of image executing this operation.
@param CommandLine The string command line to execute.
@param DebugOutput TRUE indicates that errors should be printed directly.
@ -144,15 +144,15 @@ EFI_STATUS
/**
This function returns a shell environment variable value.
@param Name Pointer to the string with the shell environment
@param Name Pointer to the string with the shell environment
variable name.
@retval NULL The shell environment variable's value could not be found.
@retval !NULL The value of the shell environment variable Name.
@retval !=NULL The value of the shell environment variable Name.
**/
typedef
CHAR16 *
typedef
CHAR16 *
(EFIAPI *SHELLENV_GET_ENV) (
IN CHAR16 *Name
);
@ -160,15 +160,15 @@ CHAR16 *
/**
This function returns a shell environment map value.
@param Name Pointer to the string with the shell environment
@param Name Pointer to the string with the shell environment
map name.
@retval NULL The shell environment map's value could not be found.
@retval !NULL The value of the shell environment map Name.
@retval !=NULL The value of the shell environment map Name.
**/
typedef
CHAR16 *
typedef
CHAR16 *
(EFIAPI *SHELLENV_GET_MAP) (
IN CHAR16 *Name
);
@ -180,7 +180,7 @@ CHAR16 *
list in the correct location.
@param Handler The handler function to call when the command gets called.
@param CmdStr The command name.
@param Cmd The command name.
@param GetLineHelp Function to call of get help for this command.
@retval EFI_SUCCESS The command is now part of the command list.
@ -203,11 +203,10 @@ EFI_STATUS
This will get the current protocol info and add the new info or update existing info
and then resave the info.
@param SaveId Save this change as an EFI variable.
@param Protocol The protocol's GUID.
@param DumpToken The function pointer to dump token function or
@param Protocol Pointer to the protocol's GUID.
@param DumpToken The function pointer to dump token function or
NULL.
@param DumpInfo The function pointer to dump infomation function
@param DumpInfo The function pointer to dump infomation function
or NULL.
@param IdString The english name of the protocol.
**/
@ -221,10 +220,10 @@ VOID
);
/**
This function finds a protocol handle by a GUID.
This function finds a protocol handle by a GUID.
This function will check for already known protocols by GUID and if one is
found it will return the name of that protocol. If no name is found and
This function will check for already known protocols by GUID and if one is
found it will return the name of that protocol. If no name is found and
GenId is TRUE it will generate ths string.
@param Protocol The GUID of the protocol to look for.
@ -233,45 +232,46 @@ VOID
@return !NULL The Name of the protocol.
@retval NULL The Name was not found and GenId was not TRUE.
**/
typedef
typedef
CHAR16*
(EFIAPI *SHELLENV_GET_PROT) (
IN EFI_GUID *Protocol,
IN EFI_GUID *Protocol,
IN BOOLEAN GenId
);
/**
This function returns the current directory on a given device.
This function returns a string array containing the current directory on
a given device.
If DeviceName is specified, then return the current shell directory on that
device. If DeviceName is NULL, then return the current directory on the
If DeviceName is specified, then return the current shell directory on that
device. If DeviceName is NULL, then return the current directory on the
current device. The caller us responsible to free the returned string when
no londer required.
@param DeviceName The name of the device to get the current
@param DeviceName The name of the device to get the current
directory on or NULL for current device.
@return The current directory on the current or specified device.
@return String array with the current directory on the current or specified device.
**/
typedef
typedef
CHAR16*
(EFIAPI *SHELLENV_CUR_DIR) (
IN CHAR16 *DeviceName OPTIONAL
);
/**
This function will open a group of files that match the Arg path, including
support for wildcard characters ('?' and '*') in the Arg path. If there are
This function will open a group of files that match the Arg path, including
support for wildcard characters ('?' and '*') in the Arg path. If there are
any wildcard characters in the path this function will find any and all files
that match the wildcards. The return is a double linked list based on the
LIST_ENTRY linked list structure. Use this in conjunction with the
that match the wildcards. It returns a double linked list based on the
LIST_ENTRY linked list structure. Use this in conjunction with the
SHELL_FILE_ARG_SIGNATURE to get the SHELL_FILE_ARG structures that are returned.
The memory allocated by the callee for this list is freed by making a call to
The memory allocated by the callee for this list is freed by making a call to
SHELLENV_FREE_FILE_LIST.
@param Arg Pointer Path to files to open.
@param ListHead Pointer to allocated and initialized list head
@param ListHead Pointer to allocated and initialized list head
upon which to append all the opened file structures.
@retval EFI_SUCCESS 1 or more files was opened and a struct of each file's
@ -291,7 +291,7 @@ EFI_STATUS
@param ListHead Pointer to list to free all nodes of.
@retval EFI_SUCCESS always returned.
@retval EFI_SUCCESS Always returned.
**/
typedef
EFI_STATUS
@ -300,21 +300,21 @@ EFI_STATUS
);
/**
This function creates a new instance of the ShellInterface protocol for use on
This function creates a new instance of the ShellInterface protocol for use on
the ImageHandle.
This function is for internal shell usage. This will allocate and then populate
EFI_SHELL_INTERFACE protocol. It is the caller's responsibility to free the
This function is for internal shell usage. This will allocate and then populate
EFI_SHELL_INTERFACE protocol. It is the caller's responsibility to free the
memory.
@param ImageHandle The handle which will use the new ShellInterface
@param ImageHandle The handle which will use the new ShellInterface
protocol.
@return the newly allocated shell interface protocol.
**/
typedef
EFI_SHELL_INTERFACE*
typedef
EFI_SHELL_INTERFACE*
(EFIAPI *SHELLENV_NEW_SHELL) (
IN EFI_HANDLE ImageHandle
);
@ -322,8 +322,8 @@ EFI_SHELL_INTERFACE*
/**
This function determins whether a script file is currently being processed.
A script file (.nsh file) can contain a series of commands and this is useful to
know for some shell commands whether they are being run manually or as part of a
A script file (.nsh file) can contain a series of commands and this is useful to
know for some shell commands whether they are being run manually or as part of a
script.
@retval TRUE A script file is being processed.
@ -336,7 +336,7 @@ BOOLEAN
);
/**
This is an internal shell function to free any and all allocated resources.
This is an internal shell function to free any and all allocated resources.
This should be called just closing the shell.
**/
typedef
@ -348,9 +348,9 @@ VOID
/**
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
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.
@param StartRow The row number to start this on.
@ -366,7 +366,7 @@ VOID
/**
This function disables the page break mode.
Tisabling this causes the output to print out exactly as coded with no breaks
Tisabling this causes the output to print out exactly as coded with no breaks
for readability.
**/
typedef
@ -388,7 +388,7 @@ BOOLEAN
);
/**
This function sets the keys to filter for for the console in. The valid
This function sets the keys to filter for for the console in. The valid
values to set are:
#define EFI_OUTPUT_SCROLL 0x00000001
@ -404,7 +404,7 @@ VOID
);
/**
This function gets the keys to filter for for the console in.
This function gets the keys to filter for for the console in.
The valid values to get are:
#define EFI_OUTPUT_SCROLL 0x00000001
@ -422,10 +422,10 @@ UINT32
/**
This function determins if the shell application should break.
This is used to inform a shell application that a break condition has been
This is used to inform a shell application that a break condition has been
initiated. Long loops should check this to prevent delays to the break.
@retval TRUE A break has been signaled. the application
@retval TRUE A break has been signaled. the application
should exit with EFI_ABORTED as soon as possible.
@retval FALSE Continue as normal.
**/
@ -470,14 +470,14 @@ BOOLEAN
/**
Close the console proxy to restore the original console.
This is an internal shell function to handle shell cascading. It restores the
This is an internal shell function to handle shell cascading. It restores the
original set of console protocols.
@param ConInHandle The handle of ConIn.
@param ConIn Pointer to the location to return the pointer to
@param ConIn Pointer to the location to return the pointer to
the original console input.
@param ConOutHandle The handle of ConOut
@param ConOut Pointer to the location to return the pointer to
@param ConOut Pointer to the location to return the pointer to
the original console output.
**/
typedef
@ -494,7 +494,7 @@ VOID
//
/**
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
This is only done on request for various internal commands and the references
are immediately freed when the internal command completes.
**/
typedef
@ -506,8 +506,8 @@ VOID
/**
This is an internal shell function to enumerate the handle database.
This function gets the next handle in the handle database. If no handles are
found EFI_NOT_FOUND is returned. If the previous Handle was the last handle
This function gets the next handle in the handle database. If no handles are
found EFI_NOT_FOUND is returned. If the previous Handle was the last handle
it is set to NULL before returning.
This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
@ -527,8 +527,8 @@ EFI_STATUS
/**
This is an internal shell function to enumerate the handle database.
This function skips the next SkipNum handles in the handle database. If there
are not enough handles left to skip that many EFI_ACCESS_DENIED is returned and
This function skips the next SkipNum handles in the handle database. If there
are not enough handles left to skip that many EFI_ACCESS_DENIED is returned and
no skip is performed.
This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
@ -547,9 +547,9 @@ EFI_STATUS
/**
This is an internal shell function to enumerate the handle database.
This function resets the the handle database so that NEXT_HANDLE and SKIP_HANDLE
will start from EnumIndex on the next call.
This function resets the the handle database so that NEXT_HANDLE and SKIP_HANDLE
will start from EnumIndex on the next call.
This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
@param EnumIndex Where to start.
@ -564,11 +564,11 @@ UINTN
/**
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.
Tfter this no other handle enumerator functions except INIT_HANDLE_ENUMERATOR will
Tfter this no other handle enumerator functions except INIT_HANDLE_ENUMERATOR will
function properly.
**/
typedef
@ -581,7 +581,7 @@ VOID
This is an internal shell function to enumerate the handle database.
This function returns the number of handles in the handle database.
This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
@return the number of handles in the handle database.
@ -636,7 +636,7 @@ typedef struct {
/**
This is an internal shell function to initialize the protocol enumerator.
This must be called before NEXT_PROTOCOL_INFO, SKIP_PROTOCOL_INFO,
This must be called before NEXT_PROTOCOL_INFO, SKIP_PROTOCOL_INFO,
RESET_PROTOCOL_INFO_ENUMERATOR, and CLOSE_PROTOCOL_INFO_ENUMERATOR are
called.
**/
@ -647,13 +647,13 @@ VOID
);
/**
This function is an internal shell function for enumeration of protocols.
This function is an internal shell function for enumeration of protocols.
This functiol will return the next protocol in the list. If this is called
This functiol will return the next protocol in the list. If this is called
immediately after initialization it will return the first. If this is called
immediately after reset it will return the protocol first again.
This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
called after INIT_PROTOCOL_INFO_ENUMERATOR.
@param ProtocolInfo Pointer to pointer to protocol information structure.
@ -668,9 +668,9 @@ EFI_STATUS
);
/**
This function is an internal shell function for enumeration of protocols.
This function is an internal shell function for enumeration of protocols.
This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
called after INIT_PROTOCOL_INFO_ENUMERATOR.
This function does nothing and always returns EFI_SUCCESS.
@ -684,12 +684,12 @@ EFI_STATUS
);
/**
This function is an internal shell function for enumeration of protocols.
This function is an internal shell function for enumeration of protocols.
This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
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
This function resets the list of protocols such that the next one in the
list is the begining of the list.
**/
typedef
@ -700,7 +700,7 @@ VOID
/**
This function is an internal shell function for enumeration of protocols.
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.
@ -726,22 +726,22 @@ typedef struct {
} PROTOCOL_INFO_ENUMERATOR;
/**
This function is used to retrieve a user-friendly display name for a handle.
This function is used to retrieve a user-friendly display name for a handle.
If UseComponentName is TRUE then the component name protocol for this device
or it's parent device (if required) will be used to obtain the name of the
If UseComponentName is TRUE then the component name protocol for this device
or it's parent device (if required) will be used to obtain the name of the
device. If UseDevicePath is TRUE it will get the human readable device path
and return that. If both are TRUE it will try to use component name first
and device path if that fails.
and device path if that fails.
It will use either ComponentName or ComponentName2 protocol, depending on
It will use either ComponentName or ComponentName2 protocol, depending on
what is present.
This function will furthur verify whether the handle in question produced either
EFI_DRIVER_CONFIGRATION_PROTOCOL or EFI_DRIVER_CONFIGURATION2_PROTOCOL and also
whether the handle in question produced either EFI_DRIVER_DIAGNOSTICS_PROTOCOL or
EFI_DRIVER_CONFIGRATION_PROTOCOL or EFI_DRIVER_CONFIGURATION2_PROTOCOL and also
whether the handle in question produced either EFI_DRIVER_DIAGNOSTICS_PROTOCOL or
EFI_DRIVER_DIAGNOSTICS2_PROTOCOL.
Upon sucessful return the memory for *BestDeviceName is up to the caller to free.
@param DeviceHandle The device handle whose name is desired.
@ -774,10 +774,10 @@ EFI_STATUS
#define EFI_SHELL_ENHANCED_MODE_VER L"1.1.2" ///< string for highest version this shell supports
/**
This function gets the shell mode as stored in the shell environment
This function gets the shell mode as stored in the shell environment
"efishellmode". It will not fail.
@param Mode Returns a string representing one of the
@param Mode Returns a string representing one of the
2 supported modes of the shell.
@retval EFI_SUCCESS This function always returns success.
@ -792,17 +792,17 @@ EFI_STATUS
Convert a file system style name to a device path.
This function will convert a shell path name to a Device Path Protocol path.
This function will allocate any required memory for this operation and it
This function will allocate any required memory for this operation and it
is the responsibility of the caller to free that memory when no longer required.
If anything prevents the complete conversion free any allocated memory and
If anything prevents the complete conversion free any allocated memory and
return NULL.
@retval !NULL A pointer to the callee allocated Device Path.
@retval NULL The operation could not be completed.
**/
typedef
EFI_DEVICE_PATH_PROTOCOL*
typedef
EFI_DEVICE_PATH_PROTOCOL*
(EFIAPI *SHELLENV_NAME_TO_PATH) (
IN CHAR16 *Path
);
@ -813,19 +813,19 @@ EFI_DEVICE_PATH_PROTOCOL*
If DevPath is NULL, then ASSERT.
This function looks through the shell environment map for a map whose device
path matches the DevPath parameter. If one is found the Name is returned via
path matches the DevPath parameter. If one is found the Name is returned via
Name parameter. If sucessful the caller must free the memory allocated for
Name.
This function will use the internal lock to prevent changes to the map during
This function will use the internal lock to prevent changes to the map during
the lookup operation.
@param DevPath The device path to search for a name for.
@param ConsistMapping What state to verify map flag VAR_ID_CONSIST.
@param Name On sucessful return the name of that device path.
@retval EFI_SUCCESS The DevPath was found and the name returned
in Name.
in Name.
@retval EFI_OUT_OF_RESOURCES A required memory allocation failed.
@retval EFI_UNSUPPORTED The DevPath was not found in the map.
**/
@ -838,17 +838,17 @@ EFI_STATUS
);
/**
This function will open a group of files that match the Arg path, but will not
support the wildcard characters ('?' and '*') in the Arg path. If there are
any wildcard characters in the path this function will return
EFI_INVALID_PARAMETER. The return is a double linked list based on the
LIST_ENTRY linked list structure. Use this in conjunction with the
This function will open a group of files that match the Arg path, but will not
support the wildcard characters ('?' and '*') in the Arg path. If there are
any wildcard characters in the path this function will return
EFI_INVALID_PARAMETER. The return is a double linked list based on the
LIST_ENTRY linked list structure. Use this in conjunction with the
SHELL_FILE_ARG_SIGNATURE to get the SHELL_FILE_ARG structures that are returned.
The memory allocated by the callee for this list is freed by making a call to
The memory allocated by the callee for this list is freed by making a call to
SHELLENV_FREE_FILE_LIST.
@param Arg Pointer Path to files to open.
@param ListHead Pointer to allocated and initialized list head
@param ListHead Pointer to allocated and initialized list head
upon which to append all the opened file structures.
@retval EFI_SUCCESS 1 or more files was opened and a struct of each file's
@ -867,12 +867,12 @@ EFI_STATUS
/**
This function removes duplicate file listings from lists.
This is a function for use with SHELLENV_FILE_META_ARG_NO_WILDCARD and
This is a function for use with SHELLENV_FILE_META_ARG_NO_WILDCARD and
SHELLENV_FILE_META_ARG. This function will verify that there are no duplicate
files in the list of returned files. Any file listed twice will have one of its
instances removed.
@param ListHead Pointer to linked list head that was returned from
@param ListHead Pointer to linked list head that was returned from
SHELLENV_FILE_META_ARG_NO_WILDCARD or
SHELLENV_FILE_META_ARG.
@ -890,20 +890,20 @@ EFI_STATUS
if DevPath is NULL, then ASSERT().
This function looks through the shell environment map for a map whose Name
matches the Name parameter. If one is found the device path pointer is
updated to point to that file systems device path. The caller should not
This function looks through the shell environment map for a map whose Name
matches the Name parameter. If one is found the device path pointer is
updated to point to that file systems device path. The caller should not
free the memory from that device path.
This function will use the internal lock to prevent changes to the map during
This function will use the internal lock to prevent changes to the map during
the lookup operation.
@param Name Pointer to NULL terminated UNICODE string of the
@param Name Pointer to NULL terminated UNICODE string of the
file system name.
@param DevPath Pointer to pointer to DevicePath. only valid on
@param DevPath Pointer to pointer to DevicePath. only valid on
OUT if sucessful.
@retval EFI_SUCCESS The conversion was successful and the device
@retval EFI_SUCCESS The conversion was successful and the device
path was returned.
@retval EFI_NOT_FOUND The file system could not be found in the map.
**/