/** @file\r
GUID for EFI shell Environment2 Extension\r
\r
- Copyright (c) 2009, Intel Corporation\r
+ Copyright (c) 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
GUID for ShellPkg PCD Token Space.\r
\r
- Copyright (c) 2009, Intel Corporation\r
+ Copyright (c) 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
Provides interface to EFI_FILE_HANDLE functionality.\r
\r
-Copyright (c) 2009, Intel Corporation\r
+Copyright (c) 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
EFI_FILE_INFO is the structure returned as the directory entry.\r
\r
@param FileHandle The opened file handle.\r
- @param BufferSize On input the size of buffer in bytes. on return \r
+ @param BufferSize On input the size of buffer in bytes. On return \r
the number of bytes written.\r
@param Buffer The buffer to put read data into.\r
\r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
- @param FileHandle The opened file for writing\r
- @param BufferSize On input the number of bytes in Buffer. On output\r
- the number of bytes written.\r
- @param Buffer The buffer containing data to write is stored.\r
+ @param FileHandle The opened file for writing\r
+ @param BufferSize On input the number of bytes in Buffer. On output\r
+ the number of bytes written.\r
+ @param Buffer The buffer containing data to write is stored.\r
\r
- @retval EFI_SUCCESS Data was written.\r
- @retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r
+ @retval EFI_SUCCESS Data was written.\r
+ @retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r
@retval EFI_NO_MEDIA The device has no media.\r
@retval EFI_DEVICE_ERROR The device reported an error.\r
@retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
- @retval EFI_WRITE_PROTECTED The device is write-protected.\r
- @retval EFI_ACCESS_DENIED The file was open for read only.\r
- @retval EFI_VOLUME_FULL The volume is full.\r
+ @retval EFI_WRITE_PROTECTED The device is write-protected.\r
+ @retval EFI_ACCESS_DENIED The file was open for read only.\r
+ @retval EFI_VOLUME_FULL The volume is full.\r
**/\r
EFI_STATUS\r
EFIAPI\r
/** @file\r
Provides application point extension for "C" style main funciton \r
\r
-Copyright (c) 2006 - 2009, Intel Corporation\r
+Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
Provides interface to shell functionality for shell commands and applications.\r
\r
-Copyright (c) 2006 - 2009, Intel Corporation\r
+Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
@param Size Pointer to size.\r
\r
@retval EFI_SUCCESS The operation was completed sucessfully.\r
- @retval EFI_DEVICE_ERROR cannot access the file.\r
+ @retval EFI_DEVICE_ERROR Cannot access the file.\r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
@param EnvKey The key name of the environment variable.\r
\r
- @retval NULL the named environment variable does not exist.\r
+ @retval NULL The named environment variable does not exist.\r
@return != NULL pointer to the value of the environment variable.\r
**/\r
CONST CHAR16*\r
EnvironmentVariables and Status are only supported for UEFI Shell 2.0.\r
Output is only supported for pre-UEFI Shell 2.0\r
\r
- @param ImageHandle Parent image that is starting the operation\r
- @param CommandLine pointer to null terminated command line.\r
- @param Output true to display debug output. false to hide it.\r
- @param EnvironmentVariables optional pointer to array of environment variables\r
- in the form "x=y". if NULL current set is used.\r
- @param Status the status of the run command line.\r
+ @param ImageHandle Parent image that is starting the operation.\r
+ @param CommandLine Pointer to null terminated command line.\r
+ @param Output True to display debug output. false to hide it.\r
+ @param EnvironmentVariables Optional pointer to array of environment variables\r
+ in the form "x=y". If NULL current set is used.\r
+ @param Status The status of the run command line.\r
\r
- @retval EFI_SUCCESS the operation completed sucessfully. Status\r
+ @retval EFI_SUCCESS The operation completed sucessfully. Status\r
contains the status code returned.\r
- @retval EFI_INVALID_PARAMETER a parameter contains an invalid value\r
- @retval EFI_OUT_OF_RESOURCES out of resources\r
- @retval EFI_UNSUPPORTED the operation is not allowed.\r
+ @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.\r
+ @retval EFI_OUT_OF_RESOURCES Out of resources.\r
+ @retval EFI_UNSUPPORTED The operation is not allowed.\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- Retreives the current directory path\r
+ Retreives the current directory path.\r
\r
If the DeviceName is NULL, it returns the current device's current directory \r
name. If the DeviceName is not NULL, it returns the current directory name \r
on specified drive.\r
\r
- @param DeviceName the name of the drive to get directory on\r
+ @param DeviceName The name of the file system to get directory on.\r
\r
- @retval NULL the directory does not exist\r
- @return != NULL the directory\r
+ @retval NULL The directory does not exist.\r
+ @return != NULL The directory.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
When page break mode is enabled the screen will stop scrolling \r
and wait for operator input before scrolling a subsequent screen.\r
\r
- @param CurrentState TRUE to enable and FALSE to disable\r
+ @param CurrentState TRUE to enable and FALSE to disable.\r
**/\r
VOID \r
EFIAPI\r
\r
@retval EFI_SUCCESS The operation was sucessful and the list head \r
contains the list of opened files.\r
- @return != EFI_SUCCESS The operation failed.\r
+ @retval != EFI_SUCCESS The operation failed.\r
\r
@sa InternalShellConvertFileListType\r
**/\r
);\r
\r
/**\r
- Free the linked list returned from ShellOpenFileMetaArg\r
+ Free the linked list returned from ShellOpenFileMetaArg.\r
\r
- @param ListHead the pointer to free\r
+ @param ListHead The pointer to free.\r
\r
- @retval EFI_SUCCESS the operation was sucessful\r
- @retval EFI_INVALID_PARAMETER A parameter was invalid\r
+ @retval EFI_SUCCESS The operation was sucessful.\r
+ @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
**/\r
EFI_STATUS\r
EFIAPI\r
/**\r
Find a file by searching the CWD and then the path.\r
\r
- if FileName is NULL then ASSERT.\r
+ If FileName is NULL, then ASSERT.\r
\r
- if the return value is not NULL then the memory must be caller freed.\r
+ If the return value is not NULL then the memory must be caller freed.\r
\r
@param FileName Filename string.\r
\r
- @retval NULL the file was not found\r
- @return !NULL the path to the file.\r
+ @retval NULL The file was not found.\r
+ @return !NULL The path to the file.\r
**/\r
CHAR16 *\r
EFIAPI\r
);\r
\r
typedef enum {\r
- TypeFlag = 0, /// a flag that is present or not present only. (IE "-a")\r
- TypeValue, /// a flag that has some data following it with a space (IE "-a 1")\r
- TypePosition, /// some data that did not follow a parameter (IE "filename.txt")\r
- TypeStart, /// a flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...\r
- TypeDoubleValue, /// a flag that has 2 space seperated value data following it. (IE "-a 1 2")\r
- TypeMaxValue, /// a flag followed by all the command line data before the next flag.\r
+ TypeFlag = 0, ///< a flag that is present or not present only (IE "-a").\r
+ TypeValue, ///< a flag that has some data following it with a space (IE "-a 1").\r
+ TypePosition, ///< some data that did not follow a parameter (IE "filename.txt").\r
+ TypeStart, ///< a flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...).\r
+ TypeDoubleValue, ///< a flag that has 2 space seperated value data following it (IE "-a 1 2").\r
+ TypeMaxValue, ///< a flag followed by all the command line data before the next flag.\r
TypeMax,\r
} ParamType;\r
\r
\r
@param CheckList Pointer to list of parameters to check.\r
@param CheckPackage Package of checked values.\r
- @param ProblemParam Pptional pointer to pointer to unicode string for \r
+ @param ProblemParam Optional pointer to pointer to unicode string for \r
the paramater that caused failure.\r
@param AutoPageBreak Will automatically set PageBreakEnabled.\r
\r
@retval EFI_SUCCESS The operation completed sucessfully.\r
- @retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
- @retval EFI_INVALID_PARAMETER A parameter was invalid\r
- @retval EFI_VOLUME_CORRUPTED the command line was corrupt. an argument was \r
- duplicated. the duplicated command line argument \r
+ @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
+ @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
+ @retval EFI_VOLUME_CORRUPTED The command line was corrupt. an argument was \r
+ duplicated. The duplicated command line argument \r
was returned in ProblemParam if provided.\r
- @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. one\r
+ @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One\r
of the command line arguments was returned in \r
ProblemParam if provided.\r
@retval EFI_NOT_FOUND A argument required a value that was missing. \r
- the invalid command line argument was returned in\r
+ The invalid command line argument was returned in\r
ProblemParam if provided.\r
**/\r
EFI_STATUS\r
IN BOOLEAN AlwaysAllowNumbers\r
);\r
\r
-// make it easy to upgrade from older versions of the shell library.\r
+/// make it easy to upgrade from older versions of the shell library.\r
#define ShellCommandLineParse(CheckList,CheckPackage,ProblemParam,AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)\r
\r
/**\r
This function will free all the memory that was used for the CheckPackage\r
list of postprocessed shell arguments.\r
\r
- this function has no return value.\r
+ If CheckPackage is NULL, then return.\r
\r
- if CheckPackage is NULL, then return\r
-\r
- @param CheckPackage the list to de-allocate\r
+ @param CheckPackage The list to de-allocate.\r
**/\r
VOID\r
EFIAPI\r
);\r
\r
/**\r
- Checks for presence of a flag parameter\r
+ Checks for presence of a flag parameter.\r
\r
flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key\r
\r
if CheckPackage is NULL then return FALSE.\r
- if KeyString is NULL then ASSERT()\r
+ if KeyString is NULL then ASSERT().\r
\r
- @param CheckPackage The package of parsed command line arguments\r
- @param KeyString the Key of the command line argument to check for\r
+ @param CheckPackage The package of parsed command line arguments.\r
+ @param KeyString The Key of the command line argument to check for.\r
\r
- @retval TRUE the flag is on the command line\r
- @retval FALSE the flag is not on the command line\r
+ @retval TRUE The flag is on the command line.\r
+ @retval FALSE The flag is not on the command line.\r
**/\r
BOOLEAN\r
EFIAPI\r
);\r
\r
/**\r
- returns value from command line argument\r
+ Returns value from command line argument.\r
\r
- value parameters are in the form of "-<Key> value" or "/<Key> value"\r
+ Value parameters are in the form of "-<Key> value" or "/<Key> value"\r
\r
- if CheckPackage is NULL, then return NULL;\r
+ If CheckPackage is NULL, then return NULL.\r
\r
- @param CheckPackage The package of parsed command line arguments\r
- @param KeyString the Key of the command line argument to check for\r
+ @param CheckPackage The package of parsed command line arguments.\r
+ @param KeyString The Key of the command line argument to check for.\r
\r
- @retval NULL the flag is not on the command line\r
- @return !=NULL pointer to unicode string of the value\r
+ @retval NULL The flag is not on the command line.\r
+ @retval !=NULL Pointer to unicode string of the value.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
);\r
\r
/**\r
- returns raw value from command line argument\r
+ Returns raw value from command line argument.\r
\r
- raw value parameters are in the form of "value" in a specific position in the list\r
+ Raw value parameters are in the form of "value" in a specific position in the list.\r
\r
- if CheckPackage is NULL, then return NULL;\r
+ If CheckPackage is NULL, then return NULL;\r
\r
- @param CheckPackage The package of parsed command line arguments\r
- @param Position the position of the value \r
+ @param CheckPackage The package of parsed command line arguments.\r
+ @param Position The position of the value.\r
\r
- @retval NULL the flag is not on the command line\r
- @return !=NULL pointer to unicode string of the value\r
+ @retval NULL The flag is not on the command line.\r
+ @retval !=NULL Pointer to unicode string of the value.\r
**/\r
CONST CHAR16*\r
EFIAPI\r
);\r
\r
/**\r
- returns the number of command line value parameters that were parsed. \r
+ Returns the number of command line value parameters that were parsed. \r
\r
- this will not include flags.\r
+ This will not include flags.\r
\r
@retval (UINTN)-1 No parsing has ocurred\r
- @return other The number of value parameters found\r
+ @return The number of value parameters found\r
**/\r
UINTN\r
EFIAPI\r
Print at a specific location on the screen.\r
\r
This function will move the cursor to a given screen location, print the specified string, \r
- and return the cursor to the original locaiton. \r
+ and return the cursor to the original location. \r
\r
If -1 is specified for either the Row or Col the current screen location for BOTH \r
will be used and the cursor's position will not be moved back to an original location.\r
\r
- if either Row or Col is out of range for the current console, then ASSERT\r
- if Format is NULL, then ASSERT\r
+ If either Row or Col is out of range for the current console, then ASSERT.\r
+ If Format is NULL, then ASSERT.\r
\r
In addition to the standard %-based flags as supported by UefiLib Print() this supports \r
the following additional flags:\r
);\r
\r
/**\r
- Function to determine if a given filename represents a file or a directory.\r
+ Function to determine if a given filename represents a directory.\r
\r
@param[in] DirName Path to directory to test.\r
\r
- @retval EFI_SUCCESS The Path represents a directory\r
- @retval EFI_NOT_FOUND The Path does not represent a directory\r
- @return other The path failed to open\r
+ @retval EFI_SUCCESS The Path represents a directory.\r
+ @retval EFI_NOT_FOUND The Path does not represent a directory.\r
+ @retval other The path failed to open.\r
**/\r
EFI_STATUS\r
EFIAPI\r
IN CONST CHAR16 *DirName\r
);\r
\r
+/**\r
+ Function to determine if a given filename represents a file.\r
+\r
+ @param[in] Name Path to file to test.\r
+\r
+ @retval EFI_SUCCESS The Path represents a file.\r
+ @retval EFI_NOT_FOUND The Path does not represent a file.\r
+ @retval other The path failed to open.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ShellIsFile(\r
+ IN CONST CHAR16 *Name\r
+ );\r
+\r
/**\r
Function to determine whether a string is decimal or hex representation of a number \r
and return the number converted from the string.\r
\r
@param[in] String String representation of a number\r
\r
- @retval all the number\r
+ @return The unsigned integer result of the conversion.\r
**/\r
UINTN\r
EFIAPI\r
Safely append with automatic string resizing given length of Destination and \r
desired length of copy from Source.\r
\r
- append the first D characters of Source to the end of Destination, where D is \r
+ Append the first D characters of Source to the end of Destination, where D is \r
the lesser of Count and the StrLen() of Source. If appending those D characters \r
will fit within Destination (whose Size is given as CurrentSize) and \r
still leave room for a null terminator, then those characters are appended, \r
If Source is NULL, there is nothing to append, just return the current buffer in \r
Destination.\r
\r
- if Destination is NULL, then ASSERT()\r
+ if Destination is NULL, then ASSERT().\r
if Destination's current length (including NULL terminator) is already more then \r
- CurrentSize, then ASSERT()\r
+ CurrentSize, then ASSERT().\r
\r
- @param[in,out] Destination The String to append onto\r
- @param[in,out] CurrentSize on call the number of bytes in Destination. On \r
+ @param[in,out] Destination The String to append onto.\r
+ @param[in,out] CurrentSize On call the number of bytes in Destination. On \r
return possibly the new size (still in bytes). if NULL\r
then allocate whatever is needed.\r
- @param[in] Source The String to append from\r
- @param[in] Count Maximum number of characters to append. if 0 then \r
+ @param[in] Source The String to append from.\r
+ @param[in] Count Maximum number of characters to append. If 0 then \r
all are appended.\r
\r
- @return Destination return the resultant string.\r
+ @return the Destination after apending the Source.\r
**/\r
CHAR16* \r
EFIAPI\r
/** @file\r
Library used for sorting and comparison routines.\r
\r
-Copyright (c) 2009, Intel Corporation\r
+Copyright (c) 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/**\r
Prototype for comparison function for any 2 element types.\r
\r
- @param[in] Buffer1 pointer to first buffer\r
- @param[in] Buffer2 pointer to second buffer \r
+ @param[in] Buffer1 Pointer to first buffer.\r
+ @param[in] Buffer2 Pointer to second buffer.\r
\r
- @retval 0 Buffer1 equal to Buffer2\r
- @return < 0 Buffer1 is less than Buffer2\r
- @return > 0 Buffer1 is greater than Buffer2\r
+ @retval 0 Buffer1 equal to Buffer2.\r
+ @return < 0 Buffer1 is less than Buffer2.\r
+ @return > 0 Buffer1 is greater than Buffer2.\r
**/\r
typedef\r
INTN\r
\r
Each element must be equally sized.\r
\r
- if BufferToSort is NULL, then ASSERT.\r
- if CompareFunction is NULL, then ASSERT.\r
+ If BufferToSort is NULL, then ASSERT.\r
+ If CompareFunction is NULL, then ASSERT.\r
\r
- if Count is < 2 then perform no action.\r
- if Size is < 1 then perform no action.\r
+ If Count is < 2 then perform no action.\r
+ If Size is < 1 then perform no action.\r
\r
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements\r
- on return a buffer of sorted elements\r
- @param[in] Count the number of elements in the buffer to sort\r
- @param[in] ElementSize Size of an element in bytes\r
+ @param[in,out] BufferToSort On call a Buffer of (possibly sorted) elements\r
+ on return a buffer of sorted elements.\r
+ @param[in] Count The number of elements in the buffer to sort\r
+ @param[in] ElementSize Size of an element in bytes.\r
@param[in] CompareFunction The function to call to perform the comparison \r
- of any 2 elements\r
+ of any 2 elements.\r
**/\r
VOID\r
EFIAPI\r
// replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.\r
// they are identical outside of the name.\r
typedef struct {\r
- LIST_ENTRY Link; ///< Linked list members\r
- EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.\r
- CONST CHAR16 *FullName; ///< Fully qualified filename.\r
- CONST CHAR16 *FileName; ///< name of this file.\r
- EFI_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.\r
- EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.\r
+ LIST_ENTRY Link; ///< Linked list members.\r
+ EFI_STATUS Status; ///< Status of opening the file. Valid only if Handle != NULL.\r
+ CONST CHAR16 *FullName; ///< Fully qualified filename.\r
+ CONST CHAR16 *FileName; ///< name of this file.\r
+ EFI_FILE_HANDLE Handle; ///< Handle for interacting with the opened file or NULL if closed.\r
+ EFI_FILE_INFO *Info; ///< Pointer to the FileInfo struct for this file or NULL.\r
} EFI_SHELL_FILE_INFO;\r
+\r
/**\r
Returns whether any script files are currently being processed.\r
\r
flushed to the device, and the file is closed. In all cases, the handle is \r
closed.\r
\r
- @param[in] FileHandle The file handle to be closed\r
+ @param[in] FileHandle The file handle to be closed\r
\r
- @retval EFI_SUCCESS the file closed sucessfully\r
+ @retval EFI_SUCCESS The file closed sucessfully.\r
**/\r
typedef\r
EFI_STATUS\r
shell environment variable with the specified name. If the shell environment variable\r
already exists and is non-volatile then EFI_INVALID_PARAMETER is returned.\r
\r
- @param[in] FileName Pointer to null-terminated file path\r
- @param[in] FileAttribs The new file's attrbiutes. the different attributes are\r
- described in EFI_FILE_PROTOCOL.Open().\r
- @param[out] FileHandle On return, points to the created file handle or directory's handle\r
+ @param[in] FileName Pointer to null-terminated file path.\r
+ @param[in] FileAttribs The new file's attrbiutes. the different attributes are\r
+ described in EFI_FILE_PROTOCOL.Open().\r
+ @param[out] FileHandle On return, points to the created file handle or directory's handle\r
\r
- @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.\r
+ @retval EFI_SUCCESS The file was opened. FileHandle points to the new file's handle.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
- @retval EFI_UNSUPPORTED could not open the file path\r
- @retval EFI_NOT_FOUND The specified file could not be found on the device, or could not\r
- file the file system on the device.\r
- @retval EFI_NO_MEDIA the device has no medium.\r
- @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r
- longer supported.\r
- @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according\r
- the DirName.\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
- @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write\r
- when the media is write-protected.\r
- @retval EFI_ACCESS_DENIED The service denied access to the file.\r
- @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.\r
- @retval EFI_VOLUME_FULL The volume is full.\r
+ @retval EFI_UNSUPPORTED could not open the file path\r
+ @retval EFI_NOT_FOUND The specified file could not be found on the device, or could not\r
+ file the file system on the device.\r
+ @retval EFI_NO_MEDIA The device has no medium.\r
+ @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r
+ longer supported.\r
+ @retval EFI_DEVICE_ERROR The device reported an error or can't get the file path according\r
+ the DirName.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_WRITE_PROTECTED An attempt was made to create a file, or open a file for write\r
+ when the media is write-protected.\r
+ @retval EFI_ACCESS_DENIED The service denied access to the file.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the file.\r
+ @retval EFI_VOLUME_FULL The volume is full.\r
**/\r
typedef\r
EFI_STATUS\r
\r
@param[in] FileHandle The file handle to delete.\r
\r
- @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.\r
+ @retval EFI_SUCCESS The file was closed and deleted, and the handle was closed.\r
@retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.\r
**/\r
typedef\r
\r
@retval EFI_SUCCESS Files found.\r
@retval EFI_NOT_FOUND No files found.\r
- @retval EFI_NO_MEDIA The device has no media\r
- @retval EFI_DEVICE_ERROR The device reported an error\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
**/\r
typedef\r
EFI_STATUS\r
);\r
\r
/**\r
- Flushes data back to a device\r
+ Flushes data back to a device.\r
\r
This function flushes all modified data associated with a file to a device.\r
\r
- @param[in] FileHandle The handle of the file to flush\r
+ @param[in] FileHandle The handle of the file to flush\r
\r
@retval EFI_SUCCESS The data was flushed.\r
@retval EFI_NO_MEDIA The device has no medium.\r
This function cleans up the file list and any related data structures. It has no\r
impact on the files themselves.\r
\r
- @param[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is \r
+ @param[in] FileList The file list to free. Type EFI_SHELL_FILE_INFO is \r
defined in OpenFileList()\r
\r
@retval EFI_SUCCESS Free the file list successfully.\r
FileSystemMapping. In both cases, the returned name includes the file system\r
mapping (i.e. fs0:\current-dir).\r
\r
- @param[in] FileSystemMapping A pointer to the file system mapping. If NULL, \r
+ @param[in] FileSystemMapping A pointer to the file system mapping. If NULL, \r
then the current working directory is returned.\r
\r
@retval !=NULL The current directory.\r
typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS;\r
#define EFI_DEVICE_NAME_USE_COMPONENT_NAME 0x00000001\r
#define EFI_DEVICE_NAME_USE_DEVICE_PATH 0x00000002\r
+\r
/**\r
Gets the name of the device specified by the device handle.\r
\r
@param[in] Flags Determines the possible sources of component names. \r
@param[in] Language A pointer to the language specified for the device \r
name, in the same format as described in the UEFI \r
- specification, Appendix M \r
+ specification, Appendix M.\r
@param[out] BestDeviceName On return, points to the callee-allocated null-\r
terminated name of the device. If no device name \r
could be found, points to NULL. The name must be \r
This function converts a file system style name to a device path, by replacing any\r
mapping references to the associated device path.\r
\r
- @param[in] Path the pointer to the path\r
+ @param[in] Path The pointer to the path.\r
\r
- @return all The pointer of the file path. The file path is callee \r
+ @return The pointer of the file path. The file path is callee \r
allocated and should be freed by the caller.\r
**/\r
typedef\r
If Name is NULL than a list of all environment variable names is returned. Each a \r
NULL terminated string with a double NULL terminating the list.\r
\r
- @param[in] Name A pointer to the environment variable name. If \r
+ @param[in] Name A pointer to the environment variable name. If \r
Name is NULL, then the function will return all \r
of the defined shell environment variables. In \r
the case where multiple environment variables are \r
This function allocates a buffer to store the file's information. It's the caller's\r
responsibility to free the buffer.\r
\r
- @param[in] FileHandle A File Handle\r
+ @param[in] FileHandle A File Handle.\r
\r
@return !=NULL Cannot get the file info.\r
@return NULL A pointer to a buffer with file information.\r
the device path with the file-system mapping. If there are more than one application\r
file system mappings, the one that most closely matches Path will be used.\r
\r
- @param[in] Path The pointer to the device path\r
+ @param[in] Path The pointer to the device path\r
\r
@return all The pointer of the null-terminated file path. The path \r
is callee-allocated and should be freed by the caller.\r
);\r
\r
/**\r
- Gets a file's current position\r
+ Gets a file's current position.\r
\r
This function returns the current file position for the file handle. For directories, the\r
current file position has no meaning outside of the file system driver and as such, the\r
operation is not supported.\r
\r
@param[in] FileHandle The file handle on which to get the current position.\r
- @paramp[out] Position Byte position from the start of the file\r
+ @paramp[out] Position Byte position from the start of the file.\r
\r
@retval EFI_SUCCESS Data was accessed.\r
@retval EFI_UNSUPPORTED The request is not valid on open directories.\r
@retval EFI_SUCCESS The help text was returned.\r
@retval EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the \r
returned help text.\r
- @retval EFI_INVALID_PARAMETER HelpText is NULL\r
+ @retval EFI_INVALID_PARAMETER HelpText is NULL.\r
@retval EFI_NOT_FOUND There is no help text available for Command.\r
**/\r
typedef\r
portion of the device path after the mapping.\r
\r
@retval NULL No mapping was found.\r
- @return !=NULL Pointer to null-terminated mapping. The buffer \r
+ @retval !=NULL Pointer to null-terminated mapping. The buffer \r
is callee allocated and should be freed by the caller.\r
**/\r
typedef\r
\r
User can use this function to determine current page break mode.\r
\r
- @retval TRUE The page break output mode is enabled\r
- @retval FALSE The page break output mode is disabled\r
+ @retval TRUE The page break output mode is enabled.\r
+ @retval FALSE The page break output mode is disabled.\r
**/\r
typedef\r
BOOLEAN\r
@param[in,out] FileList Points to the start of a list of files opened.\r
\r
@retval EFI_SUCCESS Create the file list successfully.\r
- @return Others Can't create the file list.\r
+ @return Can't create the file list.\r
**/\r
typedef\r
EFI_STATUS\r
@retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory\r
could not be opened.\r
@retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.\r
- @retval EFI_DEVICE_ERROR The device had an error\r
+ @retval EFI_DEVICE_ERROR The device had an error.\r
**/\r
typedef\r
EFI_STATUS\r
);\r
\r
/**\r
- Opens the root directory of a device on a handle\r
+ Opens the root directory of a device on a handle.\r
\r
This function opens the root directory of a device and returns a file handle to it.\r
\r
@retval EFI_NOT_FOUND EFI_SIMPLE_FILE_SYSTEM could not be found or the root directory\r
could not be opened.\r
@retval EFI_VOLUME_CORRUPTED The data structures in the volume were corrupted.\r
- @retval EFI_DEVICE_ERROR The device had an error\r
+ @retval EFI_DEVICE_ERROR The device had an error.\r
**/\r
typedef\r
EFI_STATUS\r
current position is increased by the number of bytes returned.\r
If FileHandle is a directory, then an error is returned.\r
\r
- @param[in] FileHandle The opened file handle for read\r
+ @param[in] FileHandle The opened file handle for read.\r
@param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.\r
@param[in,out] Buffer The buffer in which data is read.\r
\r
@retval EFI_SUCCESS Data was read.\r
- @retval EFI_NO_MEDIA The device has no media\r
- @retval EFI_DEVICE_ERROR The device reported an error\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required size\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required size.\r
**/\r
typedef\r
EFI_STATUS\r
/**\r
Deletes the duplicate file names files in the given file list.\r
\r
- This function deletes the reduplicate files in the given file list.\r
-\r
@param[in] FileList A pointer to the first entry in the file list.\r
\r
@retval EFI_SUCCESS Always success.\r
@param[in] Alias Points to the null-terminated shell alias. \r
If this parameter is NULL, then all \r
aliases will be returned in ReturnedData.\r
- @param[out] Volatile upon return of a single command if TRUE indicates\r
+ @param[out] Volatile Upon return of a single command if TRUE indicates\r
this is stored in a volatile fashion. FALSE otherwise.\r
@return If Alias is not NULL, it will return a pointer to \r
the null-terminated command for that alias. \r
If Alias is NULL, ReturnedData points to a \91;\92 \r
delimited list of alias (e.g. \r
ReturnedData = \93dir;del;copy;mfp\94) that is null-terminated. \r
- @retval NULL an error ocurred\r
- @retval NULL Alias was not a valid Alias\r
+ @retval NULL an error ocurred.\r
+ @retval NULL Alias was not a valid Alias.\r
**/\r
typedef \r
CONST CHAR16 *\r
\r
This function changes file information.\r
\r
- @param[in] FileHandle A file handle\r
- @param[in] FileInfo Points to new file information.\r
+ @param[in] FileHandle A file handle\r
+ @param[in] FileInfo Points to new file information.\r
\r
@retval EFI_SUCCESS The information was set.\r
@retval EFI_NO_MEDIA The device has no medium.\r
);\r
\r
/**\r
- Sets a file's current position\r
+ Sets a file's current position.\r
\r
This function sets the current file position for the handle to the position supplied. With\r
the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only absolute positioning is\r
grow the file). Seeking to position 0xFFFFFFFFFFFFFFFF causes the current position\r
to be set to the end of the file.\r
\r
- @param[in] FileHandle The file handle on which requested position will be set.\r
- @param[in] Position Byte position from the start of the file\r
+ @param[in] FileHandle The file handle on which requested position will be set.\r
+ @param[in] Position Byte position from the start of the file.\r
\r
@retval EFI_SUCCESS Data was written.\r
@retval EFI_UNSUPPORTED The seek request for nonzero is not valid on open directories.\r
/**\r
This function creates a mapping for a device path.\r
\r
- @param[in] DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,\r
+ @param[in] DevicePath Points to the device path. If this is NULL and Mapping points to a valid mapping,\r
then the mapping will be deleted.\r
- @param[in] Mapping Points to the null-terminated mapping for the device path.\r
+ @param[in] Mapping Points to the null-terminated mapping for the device path.\r
\r
@retval EFI_SUCCESS Mapping created or deleted successfully.\r
@retval EFI_NO_MAPPING There is no handle that corresponds exactly to DevicePath. See the\r
@param[in,out] BufferSize On input, size of Buffer.\r
@param[in] Buffer The buffer in which data to write.\r
\r
- @retval EFI_SUCCESS Data was written.\r
- @retval EFI_UNSUPPORTED Writes to open directory are not supported\r
- @retval EFI_NO_MEDIA The device has no media\r
- @retval EFI_DEVICE_ERROR The device reported an error\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_WRITE_PROTECTED The device is write-protected\r
- @retval EFI_ACCESS_DENIED The file was open for read only\r
- @retval EFI_VOLUME_FULL The volume is full\r
+ @retval EFI_SUCCESS Data was written.\r
+ @retval EFI_UNSUPPORTED Writes to open directory are not supported.\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_WRITE_PROTECTED The device is write-protected.\r
+ @retval EFI_ACCESS_DENIED The file was open for read only.\r
+ @retval EFI_VOLUME_FULL The volume is full.\r
**/\r
typedef\r
EFI_STATUS\r
/** @file\r
Defines for EFI shell environment 2 ported to EDK II build environment. (no spec)\r
\r
-Copyright (c) 2005 - 2009, Intel Corporation\r
+Copyright (c) 2005 - 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
\r
/**\r
- this function is a prototype for a function that dumps information on a protocol \r
- to a given location. the location is dependant on the implementation. This is \r
+ This function is a prototype for a function that dumps information on a protocol \r
+ to a given location. The location is dependant on the implementation. This is \r
used when programatically adding shell commands.\r
\r
@param Handle the handle the protocol is on\r
);\r
\r
/**\r
- this function is a prototype foe each command internal to the EFI shell \r
- implementation. the specific command depends on the implementation. This is \r
+ This function is a prototype for each command internal to the EFI shell \r
+ implementation. The specific command depends on the implementation. This is \r
used when programatically adding shell commands.\r
\r
- @param ImageHandle The handle to the binary shell\r
- @param SystemTable pointer to the system table.\r
+ @param ImageHandle The handle to the binary shell.\r
+ @param SystemTable Pointer to the system table.\r
\r
- @retval EFI_SUCCESS the command ran to completion\r
- @return other an error ocurred. any error is possible \r
+ @retval EFI_SUCCESS The command ran to completion\r
+ @retval other An error ocurred. Any error is possible \r
depending on the implementation of the shell \r
command.\r
\r
This is used when programatically adding shell commands. Upon successful return \r
the memory allocated is up to the caller to free.\r
\r
- @param Str pointer to pointer to string to display for help.\r
+ @param Str Pointer to pointer to string to display for help.\r
\r
- @retval EFI_SUCCESS the help string is in the parameter Str.\r
+ @retval EFI_SUCCESS Phe help string is in the parameter Str.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
-* Structure returned from functions that open multiple files\r
+Structure returned from functions that open multiple files.\r
**/\r
typedef struct {\r
UINT32 Signature; ///< SHELL_FILE_ARG_SIGNATURE\r
- LIST_ENTRY Link; ///< linked list helper\r
+ LIST_ENTRY Link; ///< Linked list helper\r
EFI_STATUS Status; ///< File's status\r
\r
- EFI_FILE_HANDLE Parent; ///< what is the Parent file of this file\r
- UINT64 OpenMode; ///< how was the file opened\r
- CHAR16 *ParentName; ///< string representation of parent\r
+ EFI_FILE_HANDLE Parent; ///< What is the Parent file of this file\r
+ UINT64 OpenMode; ///< How was the file opened\r
+ CHAR16 *ParentName; ///< String representation of parent\r
EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; ///< DevicePath for Parent\r
\r
- CHAR16 *FullName; ///< path and file name for this file\r
- CHAR16 *FileName; ///< file name for this file\r
+ CHAR16 *FullName; ///< Path and file name for this file\r
+ CHAR16 *FileName; ///< File name for this file\r
\r
- EFI_FILE_HANDLE Handle; ///< handle to this file\r
- EFI_FILE_INFO *Info; ///< pointer to file info for this file\r
+ EFI_FILE_HANDLE Handle; ///< Handle to this file\r
+ EFI_FILE_INFO *Info; ///< Pointer to file info for this file\r
} SHELL_FILE_ARG;\r
\r
-/// signature for SHELL_FILE_ARG\r
+/// Signature for SHELL_FILE_ARG\r
#define SHELL_FILE_ARG_SIGNATURE SIGNATURE_32 ('g', 'r', 'a', 'f') \r
\r
/**\r
}\r
\r
/**\r
-* GUID for the shell environment2 extension (main GUID same as shell environment)\r
+* GUID for the shell environment2 extension (main GUID same as shell environment).\r
**/\r
#define EFI_SE_EXT_SIGNATURE_GUID \\r
{ \\r
#define EFI_SHELL_MINOR_VER 0x00000000 ///< Minor version of the EFI_SHELL_ENVIRONMENT2\r
\r
/**\r
- execute a command line\r
+ Execute a command line\r
\r
- this function will run the CommandLine. This includes loading any required images, \r
+ This function will run the CommandLine. This includes loading any required images, \r
parsing any requires scripts, and it DebugOutput is TRUE printing errors \r
encountered directly to the screen.\r
\r
- @param ParentImageHandle Handle of image executing this operation\r
- @param CommandLine string command line to execute\r
+ @param ParentImageHandle Handle of image executing this operation.\r
+ @param CommandLine string command line to execute.\r
@param DebugOutput TRUE indicates that errors should be printed directly.\r
FALSE supresses error messages.\r
\r
- @retval EFI_SUCCESS the command line executed and completed.\r
- @retval EFI_ABORTED the operation did not complete due to abort.\r
+ @retval EFI_SUCCESS The command line executed and completed.\r
+ @retval EFI_ABORTED The operation did not complete due to abort.\r
@retval EFI_INVALID_PARAMETER A parameter did not have a valid value.\r
@retval EFI_OUT_OF_RESOURCES A required memory allocation failed.\r
\r
/** @file\r
Provides interface to EFI_FILE_HANDLE functionality.\r
\r
-Copyright (c) 2006 - 2009, Intel Corporation\r
+Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
Library used for sorting routines.\r
\r
-Copyright (c) 2009, Intel Corporation\r
+Copyright (c) 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
Provides application point extension for "C" style main funciton \r
\r
-Copyright (c) 2009, Intel Corporation\r
+Copyright (c) 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
Provides interface to shell functionality for shell commands and applications.\r
\r
-Copyright (c) 2006 - 2009, Intel Corporation\r
+Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
Provides interface to shell functionality for shell commands and applications.\r
\r
-Copyright (c) 2006 - 2009, Intel Corporation\r
+Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
/** @file\r
Library used for sorting routines.\r
\r
-Copyright (c) 2009, Intel Corporation\r
+Copyright (c) 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
projects / mirror_edk2.git / commitdiff