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