]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Include/Protocol/EfiShellInterface.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / ShellPkg / Include / Protocol / EfiShellInterface.h
index b5a514d60e104afd9c6809d8d6ab76f988480b7a..136e0590971b9d7c758cfad60d34a720f9dd1580 100644 (file)
@@ -4,35 +4,29 @@
   Shell Interface - additional information (over image_info) provided\r
   to an application started by the shell.\r
 \r
-  ConIo - provides a file style interface to the console.  Note that the\r
-  ConOut & ConIn interfaces in the system table will work as well, and both\r
-  all will be redirected to a file if needed on a command line\r
+  ConIo provides a file-style interface to the console.\r
 \r
   The shell interface's and data (including ConIo) are only valid during\r
   the applications Entry Point.  Once the application returns from it's\r
   entry point the data is freed by the invoking shell.\r
-  \r
-  Copyright (c) 2006 - 2009, Intel Corporation                                                         \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
-  http://opensource.org/licenses/bsd-license.php                                            \r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-#if !defined(_SHELLINTERFACE_H_)\r
+#ifndef _SHELLINTERFACE_H_\r
 #define _SHELLINTERFACE_H_\r
 \r
+#include <Protocol/SimpleFileSystem.h>\r
+\r
 #define SHELL_INTERFACE_PROTOCOL_GUID \\r
   { \\r
     0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} \\r
   }\r
 \r
 ///\r
-/// bit definitions for EFI_SHELL_ARG_INFO\r
+/// Bit definitions for EFI_SHELL_ARG_INFO\r
 ///\r
 typedef enum {\r
   ARG_NO_ATTRIB         = 0x0,\r
@@ -43,52 +37,52 @@ typedef enum {
 } EFI_SHELL_ARG_INFO_TYPES;\r
 \r
 ///\r
-/// attributes for an argument.\r
+/// Attributes for an argument.\r
 ///\r
 typedef struct _EFI_SHELL_ARG_INFO {\r
-  UINT32  Attributes;\r
+  UINT32    Attributes;\r
 } EFI_SHELL_ARG_INFO;\r
 \r
 ///\r
-/// This protocol provides access to additional information about a shell app.\r
+/// This protocol provides access to additional information about a shell application.\r
 ///\r
 typedef struct {\r
   ///\r
-  /// Handle back to original image handle & image info\r
+  /// Handle back to original image handle & image information.\r
   ///\r
-  EFI_HANDLE                ImageHandle;\r
-  EFI_LOADED_IMAGE_PROTOCOL *Info;\r
+  EFI_HANDLE                   ImageHandle;\r
+  EFI_LOADED_IMAGE_PROTOCOL    *Info;\r
 \r
   ///\r
-  /// Parsed arg list converted more C like format\r
+  /// Parsed arg list converted more C-like format.\r
   ///\r
-  CHAR16                    **Argv;\r
-  UINTN                     Argc;\r
+  CHAR16                       **Argv;\r
+  UINTN                        Argc;\r
 \r
   ///\r
-  /// Storage for file redirection args after parsing\r
+  /// Storage for file redirection args after parsing.\r
   ///\r
-  CHAR16                    **RedirArgv;\r
-  UINTN                     RedirArgc;\r
+  CHAR16                       **RedirArgv;\r
+  UINTN                        RedirArgc;\r
 \r
   ///\r
-  /// A file style handle for console io\r
+  /// A file style handle for console io.\r
   ///\r
-  EFI_FILE_HANDLE           StdIn;\r
-  EFI_FILE_HANDLE           StdOut;\r
-  EFI_FILE_HANDLE           StdErr;\r
+  EFI_FILE_PROTOCOL            *StdIn;\r
+  EFI_FILE_PROTOCOL            *StdOut;\r
+  EFI_FILE_PROTOCOL            *StdErr;\r
 \r
   ///\r
-  /// list of attributes for each argument\r
+  /// List of attributes for each argument.\r
   ///\r
-  EFI_SHELL_ARG_INFO        *ArgInfo;\r
+  EFI_SHELL_ARG_INFO           *ArgInfo;\r
 \r
   ///\r
-  /// whether we are echoing\r
+  /// Whether we are echoing.\r
   ///\r
-  BOOLEAN                   EchoOn;\r
+  BOOLEAN                      EchoOn;\r
 } EFI_SHELL_INTERFACE;\r
 \r
-extern EFI_GUID gEfiShellInterfaceGuid;\r
+extern EFI_GUID  gEfiShellInterfaceGuid;\r
 \r
 #endif\r