]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
2 | \r | |
3 | Root include file for Mde Package Base type modules\r | |
4 | \r | |
5 | This is the include file for any module of type base. Base modules only use \r | |
6 | types defined via this include file and can be ported easily to any \r | |
7 | environment. There are a set of base libraries in the Mde Package that can\r | |
8 | be used to implement base modules.\r | |
9 | \r | |
10 | Copyright (c) 2006 - 2007, Intel Corporation\r | |
11 | All rights reserved. This program and the accompanying materials\r | |
12 | are licensed and made available under the terms and conditions of the BSD License\r | |
13 | which accompanies this distribution. The full text of the license may be found at\r | |
14 | http://opensource.org/licenses/bsd-license.php\r | |
15 | \r | |
16 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
17 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
18 | \r | |
19 | **/\r | |
20 | \r | |
21 | \r | |
22 | #ifndef __BASE_H__\r | |
23 | #define __BASE_H__\r | |
24 | \r | |
25 | //\r | |
26 | // Include processor specific binding\r | |
27 | //\r | |
28 | #include <ProcessorBind.h>\r | |
29 | \r | |
30 | typedef struct {\r | |
31 | UINT32 Data1;\r | |
32 | UINT16 Data2;\r | |
33 | UINT16 Data3;\r | |
34 | UINT8 Data4[8];\r | |
35 | } GUID;\r | |
36 | \r | |
37 | typedef UINT64 PHYSICAL_ADDRESS;\r | |
38 | \r | |
39 | //\r | |
40 | // LIST_ENTRY definition\r | |
41 | //\r | |
42 | typedef struct _LIST_ENTRY LIST_ENTRY;\r | |
43 | \r | |
44 | struct _LIST_ENTRY {\r | |
45 | LIST_ENTRY *ForwardLink;\r | |
46 | LIST_ENTRY *BackLink;\r | |
47 | };\r | |
48 | \r | |
49 | //\r | |
50 | // Modifiers to absract standard types to aid in debug of problems\r | |
51 | //\r | |
52 | #define CONST const\r | |
53 | #define STATIC static\r | |
54 | #define VOID void\r | |
55 | \r | |
56 | //\r | |
57 | // Modifiers for Data Types used to self document code.\r | |
58 | // This concept is borrowed for UEFI specification.\r | |
59 | //\r | |
60 | #ifndef IN\r | |
61 | //\r | |
62 | // Some other envirnments use this construct, so #ifndef to prevent\r | |
63 | // mulitple definition.\r | |
64 | //\r | |
65 | #define IN\r | |
66 | #define OUT\r | |
67 | #define OPTIONAL\r | |
68 | #endif\r | |
69 | \r | |
70 | //\r | |
71 | // Constants. They may exist in other build structures, so #ifndef them.\r | |
72 | //\r | |
73 | #ifndef TRUE\r | |
74 | //\r | |
75 | // UEFI specification claims 1 and 0. We are concerned about the \r | |
76 | // complier portability so we did it this way.\r | |
77 | //\r | |
78 | #define TRUE ((BOOLEAN)(1==1))\r | |
79 | #endif\r | |
80 | \r | |
81 | #ifndef FALSE\r | |
82 | #define FALSE ((BOOLEAN)(0==1))\r | |
83 | #endif\r | |
84 | \r | |
85 | #ifndef NULL\r | |
86 | #define NULL ((VOID *) 0)\r | |
87 | #endif\r | |
88 | \r | |
89 | #define BIT0 0x00000001\r | |
90 | #define BIT1 0x00000002\r | |
91 | #define BIT2 0x00000004\r | |
92 | #define BIT3 0x00000008\r | |
93 | #define BIT4 0x00000010\r | |
94 | #define BIT5 0x00000020\r | |
95 | #define BIT6 0x00000040\r | |
96 | #define BIT7 0x00000080\r | |
97 | #define BIT8 0x00000100\r | |
98 | #define BIT9 0x00000200\r | |
99 | #define BIT10 0x00000400\r | |
100 | #define BIT11 0x00000800\r | |
101 | #define BIT12 0x00001000\r | |
102 | #define BIT13 0x00002000\r | |
103 | #define BIT14 0x00004000\r | |
104 | #define BIT15 0x00008000\r | |
105 | #define BIT16 0x00010000\r | |
106 | #define BIT17 0x00020000\r | |
107 | #define BIT18 0x00040000\r | |
108 | #define BIT19 0x00080000\r | |
109 | #define BIT20 0x00100000\r | |
110 | #define BIT21 0x00200000\r | |
111 | #define BIT22 0x00400000\r | |
112 | #define BIT23 0x00800000\r | |
113 | #define BIT24 0x01000000\r | |
114 | #define BIT25 0x02000000\r | |
115 | #define BIT26 0x04000000\r | |
116 | #define BIT27 0x08000000\r | |
117 | #define BIT28 0x10000000\r | |
118 | #define BIT29 0x20000000\r | |
119 | #define BIT30 0x40000000\r | |
120 | #define BIT31 0x80000000\r | |
121 | #define BIT32 0x0000000100000000UL\r | |
122 | #define BIT33 0x0000000200000000UL\r | |
123 | #define BIT34 0x0000000400000000UL\r | |
124 | #define BIT35 0x0000000800000000UL\r | |
125 | #define BIT36 0x0000001000000000UL\r | |
126 | #define BIT37 0x0000002000000000UL\r | |
127 | #define BIT38 0x0000004000000000UL\r | |
128 | #define BIT39 0x0000008000000000UL\r | |
129 | #define BIT40 0x0000010000000000UL\r | |
130 | #define BIT41 0x0000020000000000UL\r | |
131 | #define BIT42 0x0000040000000000UL\r | |
132 | #define BIT43 0x0000080000000000UL\r | |
133 | #define BIT44 0x0000100000000000UL\r | |
134 | #define BIT45 0x0000200000000000UL\r | |
135 | #define BIT46 0x0000400000000000UL\r | |
136 | #define BIT47 0x0000800000000000UL\r | |
137 | #define BIT48 0x0001000000000000UL\r | |
138 | #define BIT49 0x0002000000000000UL\r | |
139 | #define BIT50 0x0004000000000000UL\r | |
140 | #define BIT51 0x0008000000000000UL\r | |
141 | #define BIT52 0x0010000000000000UL\r | |
142 | #define BIT53 0x0020000000000000UL\r | |
143 | #define BIT54 0x0040000000000000UL\r | |
144 | #define BIT55 0x0080000000000000UL\r | |
145 | #define BIT56 0x0100000000000000UL\r | |
146 | #define BIT57 0x0200000000000000UL\r | |
147 | #define BIT58 0x0400000000000000UL\r | |
148 | #define BIT59 0x0800000000000000UL\r | |
149 | #define BIT60 0x1000000000000000UL\r | |
150 | #define BIT61 0x2000000000000000UL\r | |
151 | #define BIT62 0x4000000000000000UL\r | |
152 | #define BIT63 0x8000000000000000UL\r | |
153 | \r | |
154 | //\r | |
155 | // Support for variable length argument lists using the ANSI standard.\r | |
156 | // \r | |
157 | // Since we are using the ANSI standard we used the standard nameing and\r | |
158 | // did not folow the coding convention\r | |
159 | //\r | |
160 | // VA_LIST - typedef for argument list.\r | |
161 | // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r | |
162 | // VA_END (VA_LIST Marker) - Clear Marker\r | |
163 | // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from\r | |
164 | // the ... list. You must know the size and pass it in this macro.\r | |
165 | //\r | |
166 | // example:\r | |
167 | //\r | |
168 | // UINTN\r | |
169 | // ExampleVarArg (\r | |
170 | // IN UINTN NumberOfArgs,\r | |
171 | // ...\r | |
172 | // )\r | |
173 | // {\r | |
174 | // VA_LIST Marker;\r | |
175 | // UINTN Index;\r | |
176 | // UINTN Result;\r | |
177 | //\r | |
178 | // //\r | |
179 | // // Initialize the Marker\r | |
180 | // //\r | |
181 | // VA_START (Marker, NumberOfArgs);\r | |
182 | // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r | |
183 | // //\r | |
184 | // // The ... list is a series of UINTN values, so average them up.\r | |
185 | // //\r | |
186 | // Result += VA_ARG (Marker, UINTN);\r | |
187 | // }\r | |
188 | //\r | |
189 | // VA_END (Marker);\r | |
190 | // return Result\r | |
191 | // }\r | |
192 | //\r | |
193 | \r | |
194 | #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r | |
195 | \r | |
196 | //\r | |
197 | // Also support coding convention rules for var arg macros\r | |
198 | //\r | |
199 | #ifndef VA_START\r | |
200 | \r | |
201 | typedef CHAR8 *VA_LIST;\r | |
202 | #define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))\r | |
203 | #define VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))\r | |
204 | #define VA_END(ap) (ap = (VA_LIST) 0)\r | |
205 | \r | |
206 | #endif\r | |
207 | \r | |
208 | //\r | |
209 | // Macro that returns the byte offset of a field in a data structure. \r | |
210 | //\r | |
211 | #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r | |
212 | \r | |
213 | ///\r | |
214 | /// CONTAINING_RECORD - returns a pointer to the structure\r | |
215 | /// from one of it's elements.\r | |
216 | ///\r | |
217 | #define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r | |
218 | \r | |
219 | ///\r | |
220 | /// ALIGN_POINTER - aligns a pointer to the lowest boundry\r | |
221 | ///\r | |
222 | #define ALIGN_POINTER(p, s) ((VOID *) ((UINTN)(p) + (((s) - ((UINTN) (p))) & ((s) - 1))))\r | |
223 | \r | |
224 | ///\r | |
225 | /// ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor\r | |
226 | ///\r | |
227 | #define ALIGN_VARIABLE(Value, Adjustment) \\r | |
228 | Adjustment = 0U; \\r | |
229 | if ((UINTN) (Value) % sizeof (UINTN)) { \\r | |
230 | (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \\r | |
231 | } \\r | |
232 | (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))\r | |
233 | \r | |
234 | //\r | |
235 | // Return the maximum of two operands. \r | |
236 | // This macro returns the maximum of two operand specified by a and b. \r | |
237 | // Both a and b must be the same numerical types, signed or unsigned.\r | |
238 | //\r | |
239 | #define MAX(a, b) \\r | |
240 | (((a) > (b)) ? (a) : (b))\r | |
241 | \r | |
242 | \r | |
243 | //\r | |
244 | // Return the minimum of two operands. \r | |
245 | // This macro returns the minimal of two operand specified by a and b. \r | |
246 | // Both a and b must be the same numerical types, signed or unsigned.\r | |
247 | //\r | |
248 | #define MIN(a, b) \\r | |
249 | (((a) < (b)) ? (a) : (b))\r | |
250 | \r | |
251 | \r | |
252 | //\r | |
253 | // EFI Error Codes common to all execution phases\r | |
254 | //\r | |
255 | \r | |
256 | typedef INTN RETURN_STATUS;\r | |
257 | \r | |
258 | ///\r | |
259 | /// Set the upper bit to indicate EFI Error.\r | |
260 | ///\r | |
261 | #define ENCODE_ERROR(a) (MAX_BIT | (a))\r | |
262 | \r | |
263 | #define ENCODE_WARNING(a) (a)\r | |
cdebf6c6 | 264 | #define RETURN_ERROR(a) ((INTN) (a) < 0)\r |
959ccb23 | 265 | \r |
266 | #define RETURN_SUCCESS 0\r | |
267 | #define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r | |
268 | #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r | |
269 | #define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r | |
270 | #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r | |
271 | #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r | |
272 | #define RETURN_NOT_READY ENCODE_ERROR (6)\r | |
273 | #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r | |
274 | #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r | |
275 | #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r | |
276 | #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r | |
277 | #define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r | |
278 | #define RETURN_NO_MEDIA ENCODE_ERROR (12)\r | |
279 | #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r | |
280 | #define RETURN_NOT_FOUND ENCODE_ERROR (14)\r | |
281 | #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r | |
282 | #define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r | |
283 | #define RETURN_NO_MAPPING ENCODE_ERROR (17)\r | |
284 | #define RETURN_TIMEOUT ENCODE_ERROR (18)\r | |
285 | #define RETURN_NOT_STARTED ENCODE_ERROR (19)\r | |
286 | #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r | |
287 | #define RETURN_ABORTED ENCODE_ERROR (21)\r | |
288 | #define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r | |
289 | #define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r | |
290 | #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r | |
291 | #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r | |
292 | #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r | |
293 | #define RETURN_CRC_ERROR ENCODE_ERROR (27)\r | |
294 | #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r | |
295 | #define RETURN_END_OF_FILE ENCODE_ERROR (31)\r | |
296 | \r | |
297 | #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r | |
298 | #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r | |
299 | #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r | |
300 | #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r | |
301 | \r | |
302 | #endif\r | |
303 | \r |