ShellPkg/Include/ShellBase.h

   1 /** @file
   2   Root include file for Shell Package modules that utilize the SHELL_RETURN type
   3
   4   Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #if !defined(__SHELL_BASE__)
  16 #define __SHELL_BASE__
  17
  18 typedef enum {
  19 ///
  20 /// The operation completed successfully.
  21 ///
  22 SHELL_SUCCESS               = 0,
  23
  24 ///
  25 /// The image failed to load.
  26 ///
  27 SHELL_LOAD_ERROR            = 1,
  28
  29 ///
  30 /// The parameter was incorrect.
  31 ///
  32 SHELL_INVALID_PARAMETER     = 2,
  33
  34 ///
  35 /// The operation is not supported.
  36 ///
  37 SHELL_UNSUPPORTED           = 3,
  38
  39 ///
  40 /// The buffer was not the proper size for the request.
  41 ///
  42 SHELL_BAD_BUFFER_SIZE       = 4,
  43
  44 ///
  45 /// The buffer was not large enough to hold the requested data.
  46 /// The required buffer size is returned in the appropriate
  47 /// parameter when this error occurs.
  48 ///
  49 SHELL_BUFFER_TOO_SMALL      = 5,
  50
  51 ///
  52 /// There is no data pending upon return.
  53 ///
  54 SHELL_NOT_READY             = 6,
  55
  56 ///
  57 /// The physical device reported an error while attempting the
  58 /// operation.
  59 ///
  60 SHELL_DEVICE_ERROR          = 7,
  61
  62 ///
  63 /// The device can not be written to.
  64 ///
  65 SHELL_WRITE_PROTECTED       = 8,
  66
  67 ///
  68 /// The resource has run out.
  69 ///
  70 SHELL_OUT_OF_RESOURCES      = 9,
  71
  72 ///
  73 /// An inconsistency was detected on the file system causing the
  74 /// operation to fail.
  75 ///
  76 SHELL_VOLUME_CORRUPTED      = 10,
  77
  78 ///
  79 /// There is no more space on the file system.
  80 ///
  81 SHELL_VOLUME_FULL           = 11,
  82
  83 ///
  84 /// The device does not contain any medium to perform the
  85 /// operation.
  86 ///
  87 SHELL_NO_MEDIA              = 12,
  88
  89 ///
  90 /// The medium in the device has changed since the last
  91 /// access.
  92 ///
  93 SHELL_MEDIA_CHANGED         = 13,
  94
  95 ///
  96 /// The item was not found.
  97 ///
  98 SHELL_NOT_FOUND             = 14,
  99
 100 ///
 101 /// Access was denied.
 102 ///
 103 SHELL_ACCESS_DENIED         = 15,
 104
 105 // note the skipping of 16 and 17
 106
 107 ///
 108 /// A timeout time expired.
 109 ///
 110 SHELL_TIMEOUT               = 18,
 111
 112 ///
 113 /// The protocol has not been started.
 114 ///
 115 SHELL_NOT_STARTED           = 19,
 116
 117 ///
 118 /// The protocol has already been started.
 119 ///
 120 SHELL_ALREADY_STARTED       = 20,
 121
 122 ///
 123 /// The operation was aborted.
 124 ///
 125 SHELL_ABORTED               = 21,
 126
 127 // note the skipping of 22, 23, and 24
 128
 129 ///
 130 /// A function encountered an internal version that was
 131 /// incompatible with a version requested by the caller.
 132 ///
 133 SHELL_INCOMPATIBLE_VERSION  = 25,
 134
 135 ///
 136 /// The function was not performed due to a security violation.
 137 ///
 138 SHELL_SECURITY_VIOLATION    = 26,
 139
 140 ///
 141 /// The function was performed and resulted in an unequal
 142 /// comparison..
 143 ///
 144 SHELL_NOT_EQUAL             = 27
 145 }SHELL_STATUS;
 146
 147 #endif //__SHELL_BASE__