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