MdePkg/Include/ShellBase.h

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