This adds the new APIs for UEFI Shell 2.1 and makes a new structure for shell implementations that are conformant to this new spec. It does not affect existing implementations.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15752 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 156 insertions, 2 deletions

diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h
index d36c1f6..c39843e 100644
--- a/ShellPkg/Include/Protocol/EfiShell.h
+++ b/ShellPkg/Include/Protocol/EfiShell.h
@@ -1,7 +1,7 @@
 /** @file

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

 

-  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+  Copyright (c) 2006 - 2014, 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

@@ -414,6 +414,35 @@ CONST CHAR16 *
   );

 

 /**

+  Gets the environment variable and Attributes, or list of environment variables.  Can be 

+  used instead of GetEnv().

+

+  This function returns the current value of the specified environment variable and

+  the Attributes. If no variable name was specified, then all of the known

+  variables will be returned.

+

+  @param[in] Name               A pointer to the environment variable name. If Name is NULL,

+                                then the function will return all of the defined shell 

+                                environment variables. In the case where multiple environment

+                                variables are being returned, each variable will be terminated 

+                                by a NULL, and the list will be terminated by a double NULL.

+  @param[out] Attributes        If not NULL, a pointer to the returned attributes bitmask for

+                                the environment variable. In the case where Name is NULL, and

+                                multiple environment variables are being returned, Attributes

+                                is undefined.

+

+  @retval NULL                  The environment variable doesn’t exist.  

+  @return                       The environment variable’s value. The returned pointer does not 

+                                need to be freed by the caller.  

+**/

+typedef

+CONST CHAR16 *

+(EFIAPI *EFI_SHELL_GET_ENV_EX) (

+  IN  CONST CHAR16 *Name,

+  OUT       UINT32 *Attributes OPTIONAL

+  );

+

+/**

   Gets the file information from an open file handle.

 

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

@@ -487,6 +516,54 @@ EFI_STATUS
   );

 

 /**

+  Get the GUID value from a human readable name.

+

+  If GuidName is a known GUID name, then update Guid to have the correct value for

+  that GUID.

+

+  This function is only available when the major and minor versions in the

+  EfiShellProtocol are greater than or equal to 2 and 1, respectively.

+

+  @param[in]  GuidName   A pointer to the localized name for the GUID being queried.

+  @param[out] Guid       A pointer to the GUID structure to be filled in.

+

+  @retval EFI_SUCCESS             The operation was successful.

+  @retval EFI_INVALID_PARAMETER   Guid was NULL.

+  @retval EFI_INVALID_PARAMETER   GuidName was NULL.

+  @retval EFI_NOT_FOUND           GuidName is not a known GUID Name.

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_SHELL_GET_GUID_FROM_NAME)(

+  IN  CONST CHAR16   *GuidName,

+  OUT       EFI_GUID *Guid

+  );

+

+/**

+  Get the human readable name for a GUID from the value.

+

+  If Guid is assigned a name, then update *GuidName to point to the name. The callee

+  should not modify the value.

+

+  This function is only available when the major and minor versions in the

+  EfiShellProtocol are greater than or equal to 2 and 1, respectively.

+

+  @param[in]  Guid       A pointer to the GUID being queried.

+  @param[out] GuidName   A pointer to a pointer the localized to name for the GUID being requested

+

+  @retval EFI_SUCCESS             The operation was successful.

+  @retval EFI_INVALID_PARAMETER   Guid was NULL.

+  @retval EFI_INVALID_PARAMETER   GuidName was NULL.

+  @retval EFI_NOT_FOUND           Guid is not assigned a name.

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_SHELL_GET_GUID_NAME)(

+  IN  CONST EFI_GUID *Guid,

+  OUT CONST CHAR16   **GuidName

+  );

+

+/**

   Return help information about a specific command.

 

   This function returns the help information for the specified command. The help text

@@ -729,6 +806,30 @@ EFI_STATUS
   );

 

 /**

+  Register a GUID and a localized human readable name for it.

+

+  If Guid is not assigned a name, then assign GuidName to Guid.  This list of GUID

+  names must be used whenever a shell command outputs GUID information.

+

+  This function is only available when the major and minor versions in the

+  EfiShellProtocol are greater than or equal to 2 and 1, respectively.

+

+  @param[in] Guid       A pointer to the GUID being registered.

+  @param[in] GuidName   A pointer to the localized name for the GUID being registered.

+

+  @retval EFI_SUCCESS             The operation was successful.

+  @retval EFI_INVALID_PARAMETER   Guid was NULL.

+  @retval EFI_INVALID_PARAMETER   GuidName was NULL.

+  @retval EFI_ACCESS_DENIED       Guid already is assigned a name.

+**/

+typedef

+EFI_STATUS

+(EFIAPI *EFI_SHELL_REGISTER_GUID_NAME)(

+  IN CONST EFI_GUID *Guid,

+  IN CONST CHAR16   *GuidName

+  );

+

+/**

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

 

   @param[in] FileList           A pointer to the first entry in the file list.

@@ -995,11 +1096,64 @@ typedef struct _EFI_SHELL_PROTOCOL {
   UINT32                                    MinorVersion;

 } EFI_SHELL_PROTOCOL;

 

+//

+// The new structure with extra functions for UEFI Shell Specification 2.1

+//

+typedef struct _EFI_SHELL_PROTOCOL21 {

+  EFI_SHELL_EXECUTE                         Execute;

+  EFI_SHELL_GET_ENV                         GetEnv;

+  EFI_SHELL_SET_ENV                         SetEnv;

+  EFI_SHELL_GET_ALIAS                       GetAlias;

+  EFI_SHELL_SET_ALIAS                       SetAlias;

+  EFI_SHELL_GET_HELP_TEXT                   GetHelpText;

+  EFI_SHELL_GET_DEVICE_PATH_FROM_MAP        GetDevicePathFromMap;

+  EFI_SHELL_GET_MAP_FROM_DEVICE_PATH        GetMapFromDevicePath;

+  EFI_SHELL_GET_DEVICE_PATH_FROM_FILE_PATH  GetDevicePathFromFilePath;

+  EFI_SHELL_GET_FILE_PATH_FROM_DEVICE_PATH  GetFilePathFromDevicePath;

+  EFI_SHELL_SET_MAP                         SetMap;

+  EFI_SHELL_GET_CUR_DIR                     GetCurDir;

+  EFI_SHELL_SET_CUR_DIR                     SetCurDir;

+  EFI_SHELL_OPEN_FILE_LIST                  OpenFileList;

+  EFI_SHELL_FREE_FILE_LIST                  FreeFileList;

+  EFI_SHELL_REMOVE_DUP_IN_FILE_LIST         RemoveDupInFileList;

+  EFI_SHELL_BATCH_IS_ACTIVE                 BatchIsActive;

+  EFI_SHELL_IS_ROOT_SHELL                   IsRootShell;

+  EFI_SHELL_ENABLE_PAGE_BREAK               EnablePageBreak;

+  EFI_SHELL_DISABLE_PAGE_BREAK              DisablePageBreak;

+  EFI_SHELL_GET_PAGE_BREAK                  GetPageBreak;

+  EFI_SHELL_GET_DEVICE_NAME                 GetDeviceName;

+  EFI_SHELL_GET_FILE_INFO                   GetFileInfo;

+  EFI_SHELL_SET_FILE_INFO                   SetFileInfo;

+  EFI_SHELL_OPEN_FILE_BY_NAME               OpenFileByName;

+  EFI_SHELL_CLOSE_FILE                      CloseFile;

+  EFI_SHELL_CREATE_FILE                     CreateFile;

+  EFI_SHELL_READ_FILE                       ReadFile;

+  EFI_SHELL_WRITE_FILE                      WriteFile;

+  EFI_SHELL_DELETE_FILE                     DeleteFile;

+  EFI_SHELL_DELETE_FILE_BY_NAME             DeleteFileByName;

+  EFI_SHELL_GET_FILE_POSITION               GetFilePosition;

+  EFI_SHELL_SET_FILE_POSITION               SetFilePosition;

+  EFI_SHELL_FLUSH_FILE                      FlushFile;

+  EFI_SHELL_FIND_FILES                      FindFiles;

+  EFI_SHELL_FIND_FILES_IN_DIR               FindFilesInDir;

+  EFI_SHELL_GET_FILE_SIZE                   GetFileSize;

+  EFI_SHELL_OPEN_ROOT                       OpenRoot;

+  EFI_SHELL_OPEN_ROOT_BY_HANDLE             OpenRootByHandle;

+  EFI_EVENT                                 ExecutionBreak;

+  UINT32                                    MajorVersion;

+  UINT32                                    MinorVersion;

+  // Added for Shell 2.1

+  EFI_SHELL_REGISTER_GUID_NAME             RegisterGuidName;

+  EFI_SHELL_GET_GUID_NAME                  GetGuidName;

+  EFI_SHELL_GET_GUID_FROM_NAME             GetGuidFromName;

+  EFI_SHELL_GET_ENV_EX                     GetEnvEx;

+} EFI_SHELL_PROTOCOL21;

+

 extern EFI_GUID gEfiShellProtocolGuid;

 

 enum ShellVersion {

   SHELL_MAJOR_VERSION = 2,

-  SHELL_MINOR_VERSION = 0

+  SHELL_MINOR_VERSION = 1

 };

 

 #endif