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