public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Ruiyu Ni <ruiyu.ni@intel.com>
To: edk2-devel@lists.01.org
Cc: Liming Gao <liming.gao@intel.com>
Subject: [PATCH v2 4/8] MdePkg: Merge ShellBase.h and remove Efi prefix from header files
Date: Tue, 18 Oct 2016 16:46:09 +0800	[thread overview]
Message-ID: <20161018084613.58420-5-ruiyu.ni@intel.com> (raw)
In-Reply-To: <20161018084613.58420-1-ruiyu.ni@intel.com>

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
---
 MdePkg/Include/Protocol/{EfiShell.h => Shell.h}    | 138 ++++++++++++++++++-
 ...ShellDynamicCommand.h => ShellDynamicCommand.h} |  11 +-
 .../{EfiShellParameters.h => ShellParameters.h}    |   8 +-
 MdePkg/Include/ShellBase.h                         | 149 ---------------------
 4 files changed, 143 insertions(+), 163 deletions(-)
 rename MdePkg/Include/Protocol/{EfiShell.h => Shell.h} (91%)
 rename MdePkg/Include/Protocol/{EfiShellDynamicCommand.h => ShellDynamicCommand.h} (89%)
 rename MdePkg/Include/Protocol/{EfiShellParameters.h => ShellParameters.h} (87%)
 delete mode 100644 MdePkg/Include/ShellBase.h

diff --git a/MdePkg/Include/Protocol/EfiShell.h b/MdePkg/Include/Protocol/Shell.h
similarity index 91%
rename from MdePkg/Include/Protocol/EfiShell.h
rename to MdePkg/Include/Protocol/Shell.h
index 5c7f4f6..b4bf2f4 100644
--- a/MdePkg/Include/Protocol/EfiShell.h
+++ b/MdePkg/Include/Protocol/Shell.h
@@ -2,7 +2,7 @@
   EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.
 
   (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
-  Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2006 - 2016, 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
@@ -13,16 +13,146 @@
 
 **/
 
-#ifndef __EFI_SHELL_PROTOCOL__
-#define __EFI_SHELL_PROTOCOL__
+#ifndef __EFI_SHELL_PROTOCOL_H__
+#define __EFI_SHELL_PROTOCOL_H__
 
-#include <ShellBase.h>
 #include <Guid/FileInfo.h>
 
 #define EFI_SHELL_PROTOCOL_GUID \
   { \
   0x6302d008, 0x7f9b, 0x4f30, { 0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e } \
   }
+typedef VOID *SHELL_FILE_HANDLE;
+
+typedef enum {
+  ///
+  /// The operation completed successfully.
+  ///
+  SHELL_SUCCESS               = 0,
+
+  ///
+  /// The image failed to load.
+  ///
+  SHELL_LOAD_ERROR            = 1,
+
+  ///
+  /// The parameter was incorrect.
+  ///
+  SHELL_INVALID_PARAMETER     = 2,
+
+  ///
+  /// The operation is not supported.
+  ///
+  SHELL_UNSUPPORTED           = 3,
+
+  ///
+  /// The buffer was not the proper size for the request.
+  ///
+  SHELL_BAD_BUFFER_SIZE       = 4,
+
+  ///
+  /// The buffer was not large enough to hold the requested data.
+  /// The required buffer size is returned in the appropriate
+  /// parameter when this error occurs.
+  ///
+  SHELL_BUFFER_TOO_SMALL      = 5,
+
+  ///
+  /// There is no data pending upon return.
+  ///
+  SHELL_NOT_READY             = 6,
+
+  ///
+  /// The physical device reported an error while attempting the
+  /// operation.
+  ///
+  SHELL_DEVICE_ERROR          = 7,
+
+  ///
+  /// The device cannot be written to.
+  ///
+  SHELL_WRITE_PROTECTED       = 8,
+
+  ///
+  /// The resource has run out.
+  ///
+  SHELL_OUT_OF_RESOURCES      = 9,
+
+  ///
+  /// An inconsistency was detected on the file system causing the
+  /// operation to fail.
+  ///
+  SHELL_VOLUME_CORRUPTED      = 10,
+
+  ///
+  /// There is no more space on the file system.
+  ///
+  SHELL_VOLUME_FULL           = 11,
+
+  ///
+  /// The device does not contain any medium to perform the
+  /// operation.
+  ///
+  SHELL_NO_MEDIA              = 12,
+
+  ///
+  /// The medium in the device has changed since the last
+  /// access.
+  ///
+  SHELL_MEDIA_CHANGED         = 13,
+
+  ///
+  /// The item was not found.
+  ///
+  SHELL_NOT_FOUND             = 14,
+
+  ///
+  /// Access was denied.
+  ///
+  SHELL_ACCESS_DENIED         = 15,
+
+  // note the skipping of 16 and 17
+
+  ///
+  /// A timeout time expired.
+  ///
+  SHELL_TIMEOUT               = 18,
+
+  ///
+  /// The protocol has not been started.
+  ///
+  SHELL_NOT_STARTED           = 19,
+
+  ///
+  /// The protocol has already been started.
+  ///
+  SHELL_ALREADY_STARTED       = 20,
+
+  ///
+  /// The operation was aborted.
+  ///
+  SHELL_ABORTED               = 21,
+
+  // note the skipping of 22, 23, and 24
+
+  ///
+  /// A function encountered an internal version that was
+  /// incompatible with a version requested by the caller.
+  ///
+  SHELL_INCOMPATIBLE_VERSION  = 25,
+
+  ///
+  /// The function was not performed due to a security violation.
+  ///
+  SHELL_SECURITY_VIOLATION    = 26,
+
+  ///
+  /// The function was performed and resulted in an unequal
+  /// comparison..
+  ///
+  SHELL_NOT_EQUAL             = 27
+} SHELL_STATUS;
+
 
 // replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.
 // they are identical outside of the name.
diff --git a/MdePkg/Include/Protocol/EfiShellDynamicCommand.h b/MdePkg/Include/Protocol/ShellDynamicCommand.h
similarity index 89%
rename from MdePkg/Include/Protocol/EfiShellDynamicCommand.h
rename to MdePkg/Include/Protocol/ShellDynamicCommand.h
index 27e384c..e949878 100644
--- a/MdePkg/Include/Protocol/EfiShellDynamicCommand.h
+++ b/MdePkg/Include/Protocol/ShellDynamicCommand.h
@@ -2,6 +2,7 @@
   EFI Shell Dynamic Command registration protocol
 
   (C) Copyright 2012-2014 Hewlett-Packard Development Company, L.P.<BR>
+  Copyright (c) 2016, 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
@@ -12,13 +13,11 @@
 
 **/
 
-#ifndef __EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL__
-#define __EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL__
-
-#include <ShellBase.h>
-#include <Protocol/EfiShellParameters.h>
-#include <Protocol/EfiShell.h>
+#ifndef __EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL_H__
+#define __EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL_H__
 
+#include <Protocol/Shell.h>
+#include <Protocol/ShellParameters.h>
 
 // {3C7200E9-005F-4EA4-87DE-A3DFAC8A27C3}
 #define EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL_GUID \
diff --git a/MdePkg/Include/Protocol/EfiShellParameters.h b/MdePkg/Include/Protocol/ShellParameters.h
similarity index 87%
rename from MdePkg/Include/Protocol/EfiShellParameters.h
rename to MdePkg/Include/Protocol/ShellParameters.h
index e52328b..5679249 100644
--- a/MdePkg/Include/Protocol/EfiShellParameters.h
+++ b/MdePkg/Include/Protocol/ShellParameters.h
@@ -1,7 +1,7 @@
 /** @file
   EFI Shell protocol as defined in the UEFI Shell 2.0 specification.
 
-  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
+  Copyright (c) 2006 - 2016, 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
@@ -12,10 +12,10 @@
 
 **/
 
-#ifndef __EFI_SHELL_PARAMETERS_PROTOCOL__
-#define __EFI_SHELL_PARAMETERS_PROTOCOL__
+#ifndef __EFI_SHELL_PARAMETERS_PROTOCOL_H__
+#define __EFI_SHELL_PARAMETERS_PROTOCOL_H__
 
-#include <ShellBase.h>
+#include <Protocol/Shell.h>
 
 #define EFI_SHELL_PARAMETERS_PROTOCOL_GUID \
   { \
diff --git a/MdePkg/Include/ShellBase.h b/MdePkg/Include/ShellBase.h
deleted file mode 100644
index 4b7a3d1..0000000
--- a/MdePkg/Include/ShellBase.h
+++ /dev/null
@@ -1,149 +0,0 @@
-/** @file
-  Root include file for Shell Package modules that utilize the SHELL_RETURN type
-
-  Copyright (c) 2009 - 2016, 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
-
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#ifndef _SHELL_BASE_
-#define _SHELL_BASE_
-
-typedef VOID *SHELL_FILE_HANDLE;
-
-typedef enum {
-///
-/// The operation completed successfully.
-///
-SHELL_SUCCESS               = 0,
-
-///
-/// The image failed to load.
-///
-SHELL_LOAD_ERROR            = 1,
-
-///
-/// The parameter was incorrect.
-///
-SHELL_INVALID_PARAMETER     = 2,
-
-///
-/// The operation is not supported.
-///
-SHELL_UNSUPPORTED           = 3,
-
-///
-/// The buffer was not the proper size for the request.
-///
-SHELL_BAD_BUFFER_SIZE       = 4,
-
-///
-/// The buffer was not large enough to hold the requested data.
-/// The required buffer size is returned in the appropriate
-/// parameter when this error occurs.
-///
-SHELL_BUFFER_TOO_SMALL      = 5,
-
-///
-/// There is no data pending upon return.
-///
-SHELL_NOT_READY             = 6,
-
-///
-/// The physical device reported an error while attempting the
-/// operation.
-///
-SHELL_DEVICE_ERROR          = 7,
-
-///
-/// The device cannot be written to.
-///
-SHELL_WRITE_PROTECTED       = 8,
-
-///
-/// The resource has run out.
-///
-SHELL_OUT_OF_RESOURCES      = 9,
-
-///
-/// An inconsistency was detected on the file system causing the
-/// operation to fail.
-///
-SHELL_VOLUME_CORRUPTED      = 10,
-
-///
-/// There is no more space on the file system.
-///
-SHELL_VOLUME_FULL           = 11,
-
-///
-/// The device does not contain any medium to perform the
-/// operation.
-///
-SHELL_NO_MEDIA              = 12,
-
-///
-/// The medium in the device has changed since the last
-/// access.
-///
-SHELL_MEDIA_CHANGED         = 13,
-
-///
-/// The item was not found.
-///
-SHELL_NOT_FOUND             = 14,
-
-///
-/// Access was denied.
-///
-SHELL_ACCESS_DENIED         = 15,
-
-// note the skipping of 16 and 17
-
-///
-/// A timeout time expired.
-///
-SHELL_TIMEOUT               = 18,
-
-///
-/// The protocol has not been started.
-///
-SHELL_NOT_STARTED           = 19,
-
-///
-/// The protocol has already been started.
-///
-SHELL_ALREADY_STARTED       = 20,
-
-///
-/// The operation was aborted.
-///
-SHELL_ABORTED               = 21,
-
-// note the skipping of 22, 23, and 24
-
-///
-/// A function encountered an internal version that was
-/// incompatible with a version requested by the caller.
-///
-SHELL_INCOMPATIBLE_VERSION  = 25,
-
-///
-/// The function was not performed due to a security violation.
-///
-SHELL_SECURITY_VIOLATION    = 26,
-
-///
-/// The function was performed and resulted in an unequal
-/// comparison..
-///
-SHELL_NOT_EQUAL             = 27
-}SHELL_STATUS;
-
-#endif //__SHELL_BASE_
-- 
2.9.0.windows.1



  parent reply	other threads:[~2016-10-18  8:46 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-18  8:46 [PATCH v2 0/8] Move Shell protocols definition to MdePkg Ruiyu Ni
2016-10-18  8:46 ` [PATCH v2 1/8] ShellPkg: Move SHELL_FREE_NON_NULL from ShellBase.h to ShellLib.h Ruiyu Ni
2016-10-18  8:46 ` [PATCH v2 2/8] MdePkg: Include Shell/ShellDynamicCommand/ShellParameters definitions Ruiyu Ni
2016-10-18  8:46 ` [PATCH v2 3/8] ShellPkg: Update header files to reference MdePkg protocol definition Ruiyu Ni
2016-10-18  8:46 ` Ruiyu Ni [this message]
2016-10-18  8:46 ` [PATCH v2 5/8] ArmPkg/LinuxLoader: Reference Shell protocols in MdePkg Ruiyu Ni
2016-10-18  8:46 ` [PATCH v2 6/8] EmbeddedPkg/FdtPlatformDxe: " Ruiyu Ni
2016-10-18  8:46 ` [PATCH v2 7/8] ShellPkg: Update sources to include MdePkg protocol definitions Ruiyu Ni
2016-10-18  8:46 ` [PATCH v2 8/8] ArmPlatformPkg/ArmShellCmdRunAxf: Reference MdePkg protocol definition Ruiyu Ni
2016-10-18 10:00   ` Ard Biesheuvel
2016-10-18 14:53 ` [PATCH v2 0/8] Move Shell protocols definition to MdePkg Carsey, Jaben

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20161018084613.58420-5-ruiyu.ni@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox