]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
959ccb23 | 2 | Root include file for Mde Package Base type modules\r |
3 | \r | |
4 | This is the include file for any module of type base. Base modules only use \r | |
5 | types defined via this include file and can be ported easily to any \r | |
6 | environment. There are a set of base libraries in the Mde Package that can\r | |
7 | be used to implement base modules.\r | |
8 | \r | |
3963c4bf | 9 | Copyright (c) 2006 - 2008, Intel Corporation<BR>\r |
959ccb23 | 10 | All rights reserved. This program and the accompanying materials\r |
11 | are licensed and made available under the terms and conditions of the BSD License\r | |
12 | which accompanies this distribution. The full text of the license may be found at\r | |
13 | http://opensource.org/licenses/bsd-license.php\r | |
14 | \r | |
15 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
16 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
17 | \r | |
18 | **/\r | |
19 | \r | |
20 | \r | |
21 | #ifndef __BASE_H__\r | |
22 | #define __BASE_H__\r | |
23 | \r | |
24 | //\r | |
25 | // Include processor specific binding\r | |
26 | //\r | |
27 | #include <ProcessorBind.h>\r | |
28 | \r | |
f4ec40ab | 29 | ///\r |
30 | /// 128 bit buffer containing a unique identifier value. \r | |
31 | /// Unless otherwise specified, aligned on a 64 bit boundary.\r | |
32 | ///\r | |
959ccb23 | 33 | typedef struct {\r |
34 | UINT32 Data1;\r | |
35 | UINT16 Data2;\r | |
36 | UINT16 Data3;\r | |
37 | UINT8 Data4[8];\r | |
38 | } GUID;\r | |
39 | \r | |
3963c4bf | 40 | //\r |
41 | // 8-bytes unsigned value that represents a physical system address.\r | |
42 | //\r | |
959ccb23 | 43 | typedef UINT64 PHYSICAL_ADDRESS;\r |
44 | \r | |
62991af2 | 45 | ///\r |
f4ec40ab | 46 | /// LIST_ENTRY structure definition.\r |
62991af2 | 47 | ///\r |
959ccb23 | 48 | typedef struct _LIST_ENTRY LIST_ENTRY;\r |
49 | \r | |
f4ec40ab | 50 | ///\r |
51 | /// _LIST_ENTRY structure definition.\r | |
52 | ///\r | |
959ccb23 | 53 | struct _LIST_ENTRY {\r |
54 | LIST_ENTRY *ForwardLink;\r | |
55 | LIST_ENTRY *BackLink;\r | |
56 | };\r | |
57 | \r | |
58 | //\r | |
3963c4bf | 59 | // Modifiers to abstract standard types to aid in debug of problems\r |
959ccb23 | 60 | //\r |
f4ec40ab | 61 | \r |
62 | ///\r | |
63 | /// Datum is read-only\r | |
64 | ///\r | |
959ccb23 | 65 | #define CONST const\r |
f4ec40ab | 66 | \r |
67 | ///\r | |
68 | /// Datum is scoped to the current file or function\r | |
69 | ///\r | |
959ccb23 | 70 | #define STATIC static\r |
f4ec40ab | 71 | \r |
72 | ///\r | |
f7e994ab | 73 | /// Undeclared type\r |
f4ec40ab | 74 | ///\r |
959ccb23 | 75 | #define VOID void\r |
76 | \r | |
77 | //\r | |
78 | // Modifiers for Data Types used to self document code.\r | |
79 | // This concept is borrowed for UEFI specification.\r | |
80 | //\r | |
f4ec40ab | 81 | \r |
82 | ///\r | |
83 | /// Datum is passed to the function\r | |
84 | ///\r | |
959ccb23 | 85 | #define IN\r |
f4ec40ab | 86 | \r |
87 | ///\r | |
88 | /// Datum is returned from the function\r | |
89 | ///\r | |
959ccb23 | 90 | #define OUT\r |
f4ec40ab | 91 | \r |
92 | ///\r | |
93 | /// Passing the datum to the function is optional, and a NULL\r | |
94 | /// be passed if the value is not supplied.\r | |
95 | ///\r | |
959ccb23 | 96 | #define OPTIONAL\r |
959ccb23 | 97 | \r |
959ccb23 | 98 | //\r |
99 | // UEFI specification claims 1 and 0. We are concerned about the \r | |
100 | // complier portability so we did it this way.\r | |
101 | //\r | |
f4ec40ab | 102 | \r |
103 | ///\r | |
104 | /// Boolean true value. UEFI Specification defines this value to be 1,\r | |
105 | /// but this form is more portable.\r | |
106 | ///\r | |
959ccb23 | 107 | #define TRUE ((BOOLEAN)(1==1))\r |
f4ec40ab | 108 | \r |
109 | ///\r | |
110 | /// Boolean false value. UEFI Specification defines this value to be 0,\r | |
111 | /// but this form is more portable.\r | |
112 | ///\r | |
959ccb23 | 113 | #define FALSE ((BOOLEAN)(0==1))\r |
959ccb23 | 114 | \r |
f4ec40ab | 115 | ///\r |
116 | /// NULL pointer (VOID *)\r | |
117 | ///\r | |
959ccb23 | 118 | #define NULL ((VOID *) 0)\r |
959ccb23 | 119 | \r |
3963c4bf | 120 | \r |
959ccb23 | 121 | #define BIT0 0x00000001\r |
122 | #define BIT1 0x00000002\r | |
123 | #define BIT2 0x00000004\r | |
124 | #define BIT3 0x00000008\r | |
125 | #define BIT4 0x00000010\r | |
126 | #define BIT5 0x00000020\r | |
127 | #define BIT6 0x00000040\r | |
128 | #define BIT7 0x00000080\r | |
129 | #define BIT8 0x00000100\r | |
130 | #define BIT9 0x00000200\r | |
131 | #define BIT10 0x00000400\r | |
132 | #define BIT11 0x00000800\r | |
133 | #define BIT12 0x00001000\r | |
134 | #define BIT13 0x00002000\r | |
135 | #define BIT14 0x00004000\r | |
136 | #define BIT15 0x00008000\r | |
137 | #define BIT16 0x00010000\r | |
138 | #define BIT17 0x00020000\r | |
139 | #define BIT18 0x00040000\r | |
140 | #define BIT19 0x00080000\r | |
141 | #define BIT20 0x00100000\r | |
142 | #define BIT21 0x00200000\r | |
143 | #define BIT22 0x00400000\r | |
144 | #define BIT23 0x00800000\r | |
145 | #define BIT24 0x01000000\r | |
146 | #define BIT25 0x02000000\r | |
147 | #define BIT26 0x04000000\r | |
148 | #define BIT27 0x08000000\r | |
149 | #define BIT28 0x10000000\r | |
150 | #define BIT29 0x20000000\r | |
151 | #define BIT30 0x40000000\r | |
152 | #define BIT31 0x80000000\r | |
4d24730c | 153 | #define BIT32 0x0000000100000000ULL\r |
154 | #define BIT33 0x0000000200000000ULL\r | |
155 | #define BIT34 0x0000000400000000ULL\r | |
156 | #define BIT35 0x0000000800000000ULL\r | |
157 | #define BIT36 0x0000001000000000ULL\r | |
158 | #define BIT37 0x0000002000000000ULL\r | |
159 | #define BIT38 0x0000004000000000ULL\r | |
160 | #define BIT39 0x0000008000000000ULL\r | |
161 | #define BIT40 0x0000010000000000ULL\r | |
162 | #define BIT41 0x0000020000000000ULL\r | |
163 | #define BIT42 0x0000040000000000ULL\r | |
164 | #define BIT43 0x0000080000000000ULL\r | |
165 | #define BIT44 0x0000100000000000ULL\r | |
166 | #define BIT45 0x0000200000000000ULL\r | |
167 | #define BIT46 0x0000400000000000ULL\r | |
168 | #define BIT47 0x0000800000000000ULL\r | |
169 | #define BIT48 0x0001000000000000ULL\r | |
170 | #define BIT49 0x0002000000000000ULL\r | |
171 | #define BIT50 0x0004000000000000ULL\r | |
172 | #define BIT51 0x0008000000000000ULL\r | |
173 | #define BIT52 0x0010000000000000ULL\r | |
174 | #define BIT53 0x0020000000000000ULL\r | |
175 | #define BIT54 0x0040000000000000ULL\r | |
176 | #define BIT55 0x0080000000000000ULL\r | |
177 | #define BIT56 0x0100000000000000ULL\r | |
178 | #define BIT57 0x0200000000000000ULL\r | |
179 | #define BIT58 0x0400000000000000ULL\r | |
180 | #define BIT59 0x0800000000000000ULL\r | |
181 | #define BIT60 0x1000000000000000ULL\r | |
182 | #define BIT61 0x2000000000000000ULL\r | |
183 | #define BIT62 0x4000000000000000ULL\r | |
184 | #define BIT63 0x8000000000000000ULL\r | |
959ccb23 | 185 | \r |
2e121e9a | 186 | #define SIZE_1KB 0x00000400\r |
187 | #define SIZE_2KB 0x00000800\r | |
188 | #define SIZE_4KB 0x00001000\r | |
189 | #define SIZE_8KB 0x00002000\r | |
190 | #define SIZE_16KB 0x00004000\r | |
191 | #define SIZE_32KB 0x00008000\r | |
192 | #define SIZE_64KB 0x00010000\r | |
193 | #define SIZE_128KB 0x00020000\r | |
194 | #define SIZE_256KB 0x00040000\r | |
195 | #define SIZE_512KB 0x00080000\r | |
196 | #define SIZE_1MB 0x00100000\r | |
197 | #define SIZE_2MB 0x00200000\r | |
198 | #define SIZE_4MB 0x00400000\r | |
199 | #define SIZE_8MB 0x00800000\r | |
200 | #define SIZE_16MB 0x01000000\r | |
201 | #define SIZE_32MB 0x02000000\r | |
202 | #define SIZE_64MB 0x04000000\r | |
203 | #define SIZE_128MB 0x08000000\r | |
204 | #define SIZE_256MB 0x10000000\r | |
205 | #define SIZE_512MB 0x20000000\r | |
206 | #define SIZE_1GB 0x40000000\r | |
207 | #define SIZE_2GB 0x80000000\r | |
208 | #define SIZE_4GB 0x0000000100000000ULL\r | |
209 | #define SIZE_8GB 0x0000000200000000ULL\r | |
210 | #define SIZE_16GB 0x0000000400000000ULL\r | |
211 | #define SIZE_32GB 0x0000000800000000ULL\r | |
212 | #define SIZE_64GB 0x0000001000000000ULL\r | |
213 | #define SIZE_128GB 0x0000002000000000ULL\r | |
214 | #define SIZE_256GB 0x0000004000000000ULL\r | |
215 | #define SIZE_512GB 0x0000008000000000ULL\r | |
216 | #define SIZE_1TB 0x0000010000000000ULL\r | |
217 | #define SIZE_2TB 0x0000020000000000ULL\r | |
218 | #define SIZE_4TB 0x0000040000000000ULL\r | |
219 | #define SIZE_8TB 0x0000080000000000ULL\r | |
220 | #define SIZE_16TB 0x0000100000000000ULL\r | |
221 | #define SIZE_32TB 0x0000200000000000ULL\r | |
222 | #define SIZE_64TB 0x0000400000000000ULL\r | |
223 | #define SIZE_128TB 0x0000800000000000ULL\r | |
224 | #define SIZE_256TB 0x0001000000000000ULL\r | |
225 | #define SIZE_512TB 0x0002000000000000ULL\r | |
226 | #define SIZE_1PB 0x0004000000000000ULL\r | |
227 | #define SIZE_2PB 0x0008000000000000ULL\r | |
228 | #define SIZE_4PB 0x0010000000000000ULL\r | |
229 | #define SIZE_8PB 0x0020000000000000ULL\r | |
230 | #define SIZE_16PB 0x0040000000000000ULL\r | |
231 | #define SIZE_32PB 0x0080000000000000ULL\r | |
232 | #define SIZE_64PB 0x0100000000000000ULL\r | |
233 | #define SIZE_128PB 0x0200000000000000ULL\r | |
234 | #define SIZE_256PB 0x0400000000000000ULL\r | |
235 | #define SIZE_512PB 0x0800000000000000ULL\r | |
236 | #define SIZE_1EB 0x1000000000000000ULL\r | |
237 | #define SIZE_2EB 0x2000000000000000ULL\r | |
238 | #define SIZE_4EB 0x4000000000000000ULL\r | |
239 | #define SIZE_8EB 0x8000000000000000ULL\r | |
240 | \r | |
241 | #define BASE_1KB 0x00000400\r | |
242 | #define BASE_2KB 0x00000800\r | |
243 | #define BASE_4KB 0x00001000\r | |
244 | #define BASE_8KB 0x00002000\r | |
245 | #define BASE_16KB 0x00004000\r | |
246 | #define BASE_32KB 0x00008000\r | |
247 | #define BASE_64KB 0x00010000\r | |
248 | #define BASE_128KB 0x00020000\r | |
249 | #define BASE_256KB 0x00040000\r | |
250 | #define BASE_512KB 0x00080000\r | |
251 | #define BASE_1MB 0x00100000\r | |
252 | #define BASE_2MB 0x00200000\r | |
253 | #define BASE_4MB 0x00400000\r | |
254 | #define BASE_8MB 0x00800000\r | |
255 | #define BASE_16MB 0x01000000\r | |
256 | #define BASE_32MB 0x02000000\r | |
257 | #define BASE_64MB 0x04000000\r | |
258 | #define BASE_128MB 0x08000000\r | |
259 | #define BASE_256MB 0x10000000\r | |
260 | #define BASE_512MB 0x20000000\r | |
261 | #define BASE_1GB 0x40000000\r | |
262 | #define BASE_2GB 0x80000000\r | |
263 | #define BASE_4GB 0x0000000100000000ULL\r | |
264 | #define BASE_8GB 0x0000000200000000ULL\r | |
265 | #define BASE_16GB 0x0000000400000000ULL\r | |
266 | #define BASE_32GB 0x0000000800000000ULL\r | |
267 | #define BASE_64GB 0x0000001000000000ULL\r | |
268 | #define BASE_128GB 0x0000002000000000ULL\r | |
269 | #define BASE_256GB 0x0000004000000000ULL\r | |
270 | #define BASE_512GB 0x0000008000000000ULL\r | |
271 | #define BASE_1TB 0x0000010000000000ULL\r | |
272 | #define BASE_2TB 0x0000020000000000ULL\r | |
273 | #define BASE_4TB 0x0000040000000000ULL\r | |
274 | #define BASE_8TB 0x0000080000000000ULL\r | |
275 | #define BASE_16TB 0x0000100000000000ULL\r | |
276 | #define BASE_32TB 0x0000200000000000ULL\r | |
277 | #define BASE_64TB 0x0000400000000000ULL\r | |
278 | #define BASE_128TB 0x0000800000000000ULL\r | |
279 | #define BASE_256TB 0x0001000000000000ULL\r | |
280 | #define BASE_512TB 0x0002000000000000ULL\r | |
281 | #define BASE_1PB 0x0004000000000000ULL\r | |
282 | #define BASE_2PB 0x0008000000000000ULL\r | |
283 | #define BASE_4PB 0x0010000000000000ULL\r | |
284 | #define BASE_8PB 0x0020000000000000ULL\r | |
285 | #define BASE_16PB 0x0040000000000000ULL\r | |
286 | #define BASE_32PB 0x0080000000000000ULL\r | |
287 | #define BASE_64PB 0x0100000000000000ULL\r | |
288 | #define BASE_128PB 0x0200000000000000ULL\r | |
289 | #define BASE_256PB 0x0400000000000000ULL\r | |
290 | #define BASE_512PB 0x0800000000000000ULL\r | |
291 | #define BASE_1EB 0x1000000000000000ULL\r | |
292 | #define BASE_2EB 0x2000000000000000ULL\r | |
293 | #define BASE_4EB 0x4000000000000000ULL\r | |
294 | #define BASE_8EB 0x8000000000000000ULL\r | |
295 | \r | |
959ccb23 | 296 | //\r |
297 | // Support for variable length argument lists using the ANSI standard.\r | |
298 | // \r | |
3963c4bf | 299 | // Since we are using the ANSI standard we used the standard naming and\r |
300 | // did not follow the coding convention\r | |
959ccb23 | 301 | //\r |
302 | // VA_LIST - typedef for argument list.\r | |
303 | // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r | |
304 | // VA_END (VA_LIST Marker) - Clear Marker\r | |
3963c4bf | 305 | // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from\r |
959ccb23 | 306 | // the ... list. You must know the size and pass it in this macro.\r |
307 | //\r | |
308 | // example:\r | |
309 | //\r | |
310 | // UINTN\r | |
311 | // ExampleVarArg (\r | |
312 | // IN UINTN NumberOfArgs,\r | |
313 | // ...\r | |
314 | // )\r | |
315 | // {\r | |
316 | // VA_LIST Marker;\r | |
317 | // UINTN Index;\r | |
318 | // UINTN Result;\r | |
319 | //\r | |
320 | // //\r | |
321 | // // Initialize the Marker\r | |
322 | // //\r | |
323 | // VA_START (Marker, NumberOfArgs);\r | |
324 | // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r | |
325 | // //\r | |
326 | // // The ... list is a series of UINTN values, so average them up.\r | |
327 | // //\r | |
328 | // Result += VA_ARG (Marker, UINTN);\r | |
329 | // }\r | |
330 | //\r | |
331 | // VA_END (Marker);\r | |
332 | // return Result\r | |
333 | // }\r | |
334 | //\r | |
335 | \r | |
c3d4e543 LG |
336 | /**\r |
337 | Return the size of argument that has been aligned to sizeof (UINTN).\r | |
338 | \r | |
339 | @param n The parameter size is to be aligned.\r | |
340 | \r | |
341 | @return The aligned size\r | |
342 | **/\r | |
959ccb23 | 343 | #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r |
344 | \r | |
f4ec40ab | 345 | ///\r |
346 | /// Pointer to the start of a variable argument list. Same as CHAR8 *.\r | |
347 | ///\r | |
959ccb23 | 348 | typedef CHAR8 *VA_LIST;\r |
959ccb23 | 349 | \r |
3963c4bf | 350 | /**\r |
351 | Retrieves a pointer to the beginning of a variable argument list based on \r | |
352 | the name of the parameter that immediately precedes the variable argument list. \r | |
353 | \r | |
354 | This function initializes Marker to point to the beginning of the variable argument \r | |
355 | list that immediately follows Parameter. The method for computing the pointer to the \r | |
356 | next argument in the argument list is CPU specific following the EFIAPI ABI.\r | |
357 | \r | |
358 | @param Marker Pointer to the beginning of the variable argument list.\r | |
359 | @param Parameter The name of the parameter that immediately precedes \r | |
360 | the variable argument list.\r | |
361 | \r | |
362 | @return A pointer to the beginning of a variable argument list.\r | |
363 | \r | |
364 | **/\r | |
365 | #define VA_START(Marker, Parameter) (Marker = (VA_LIST) & (Parameter) + _INT_SIZE_OF (Parameter))\r | |
366 | \r | |
367 | /**\r | |
368 | Returns an argument of a specified type from a variable argument list and updates \r | |
369 | the pointer to the variable argument list to point to the next argument. \r | |
370 | \r | |
371 | This function returns an argument of the type specified by TYPE from the beginning \r | |
372 | of the variable argument list specified by Marker. Marker is then updated to point \r | |
373 | to the next argument in the variable argument list. The method for computing the \r | |
374 | pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r | |
375 | \r | |
376 | @param Marker Pointer to the beginning of a variable argument list.\r | |
377 | @param TYPE The type of argument to retrieve from the beginning \r | |
378 | of the variable argument list.\r | |
379 | \r | |
380 | @return An argument of the type specified by TYPE.\r | |
381 | \r | |
382 | **/\r | |
383 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r | |
384 | \r | |
385 | /**\r | |
386 | Terminates the use of a variable argument list.\r | |
387 | \r | |
388 | This function initializes Marker so it can no longer be used with VA_ARG(). \r | |
389 | After this macro is used, the only way to access the variable argument list again is \r | |
390 | by using VA_START() again.\r | |
391 | \r | |
392 | @param Marker The variable to set to the beginning of the variable argument list.\r | |
393 | \r | |
394 | **/\r | |
395 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r | |
396 | \r | |
397 | /**\r | |
398 | Macro that returns the byte offset of a field in a data structure. \r | |
399 | \r | |
400 | This function returns the offset, in bytes, of field specified by Field from the \r | |
401 | beginning of the data structure specified by TYPE. If TYPE does not contain Field, \r | |
402 | the module will not compile. \r | |
403 | \r | |
404 | @param TYPE The name of the data structure that contains the field specified by Field. \r | |
405 | @param Field The name of the field in the data structure.\r | |
406 | \r | |
407 | @return Offset, in bytes, of field.\r | |
408 | \r | |
409 | **/\r | |
959ccb23 | 410 | #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r |
411 | \r | |
3963c4bf | 412 | /**\r |
413 | Macro that returns a pointer to the data structure that contains a specified field of \r | |
414 | that data structure. This is a lightweight method to hide information by placing a \r | |
415 | public data structure inside a larger private data structure and using a pointer to \r | |
416 | the public data structure to retrieve a pointer to the private data structure.\r | |
417 | \r | |
418 | This function computes the offset, in bytes, of field specified by Field from the beginning \r | |
419 | of the data structure specified by TYPE. This offset is subtracted from Record, and is \r | |
420 | used to return a pointer to a data structure of the type specified by TYPE.If the data type \r | |
421 | specified by TYPE does not contain the field specified by Field, then the module will not compile. \r | |
422 | \r | |
423 | @param Record Pointer to the field specified by Field within a data structure of type TYPE. \r | |
424 | @param TYPE The name of the data structure type to return. This data structure must \r | |
425 | contain the field specified by Field. \r | |
426 | @param Field The name of the field in the data structure specified by TYPE to which Record points.\r | |
427 | \r | |
428 | @return A pointer to the structure from one of it's elements.\r | |
429 | \r | |
430 | **/\r | |
22ce9dc5 | 431 | #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r |
959ccb23 | 432 | \r |
3963c4bf | 433 | /**\r |
434 | Rounds a value up to the next boundary using a specified alignment. \r | |
435 | \r | |
436 | This function rounds Value up to the next boundary using the specified Alignment. \r | |
437 | This aligned value is returned. \r | |
438 | \r | |
439 | @param Value The value to round up.\r | |
440 | @param Alignment The alignment boundary used to return the aligned value.\r | |
441 | \r | |
442 | @return A value up to the next boundary.\r | |
443 | \r | |
444 | **/\r | |
3fef0f51 | 445 | #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r |
446 | \r | |
3963c4bf | 447 | /**\r |
448 | Adjust a pointer by adding the minimum offset required for it to be aligned on \r | |
449 | a specified alignment boundary. \r | |
450 | \r | |
451 | This function rounds the pointer specified by Pointer to the next alignment boundary \r | |
452 | specified by Alignment. The pointer to the aligned address is returned. \r | |
453 | \r | |
454 | @param Value The value to round up.\r | |
455 | @param Alignment The alignment boundary to use to return an aligned pointer.\r | |
456 | \r | |
457 | @return Pointer to the aligned address.\r | |
458 | \r | |
459 | **/\r | |
3fef0f51 | 460 | #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r |
959ccb23 | 461 | \r |
3963c4bf | 462 | /**\r |
463 | Rounds a value up to the next natural boundary for the current CPU. \r | |
464 | This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs. \r | |
465 | \r | |
466 | This function rounds the value specified by Value up to the next natural boundary for the \r | |
467 | current CPU. This rounded value is returned. \r | |
468 | \r | |
469 | @param Value The value to round up.\r | |
470 | \r | |
471 | @return Rounded value specified by Value.\r | |
472 | \r | |
473 | **/\r | |
3fef0f51 | 474 | #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))\r |
475 | \r | |
959ccb23 | 476 | \r |
3963c4bf | 477 | /**\r |
478 | Return the maximum of two operands. \r | |
479 | \r | |
480 | This macro returns the maximum of two operand specified by a and b. \r | |
481 | Both a and b must be the same numerical types, signed or unsigned.\r | |
482 | \r | |
483 | @param TYPE Any numerical data types.\r | |
484 | @param a The first operand with any numerical type.\r | |
485 | @param b The second operand. It should be the same any numerical type with a.\r | |
486 | \r | |
487 | @return Maximum of two operands.\r | |
488 | \r | |
489 | **/\r | |
959ccb23 | 490 | #define MAX(a, b) \\r |
491 | (((a) > (b)) ? (a) : (b))\r | |
492 | \r | |
3963c4bf | 493 | /**\r |
494 | Return the minimum of two operands. \r | |
495 | \r | |
496 | This macro returns the minimal of two operand specified by a and b. \r | |
497 | Both a and b must be the same numerical types, signed or unsigned.\r | |
498 | \r | |
499 | @param TYPE Any numerical data types.\r | |
500 | @param a The first operand with any numerical type.\r | |
501 | @param b The second operand. It should be the same any numerical type with a.\r | |
502 | \r | |
503 | @return Minimum of two operands.\r | |
504 | \r | |
505 | **/\r | |
959ccb23 | 506 | \r |
959ccb23 | 507 | #define MIN(a, b) \\r |
508 | (((a) < (b)) ? (a) : (b))\r | |
509 | \r | |
959ccb23 | 510 | //\r |
f4ec40ab | 511 | // Status codes common to all execution phases\r |
959ccb23 | 512 | //\r |
959ccb23 | 513 | typedef INTN RETURN_STATUS;\r |
514 | \r | |
f4ec40ab | 515 | /**\r |
516 | Produces a RETURN_STATUS code with the highest bit set. \r | |
959ccb23 | 517 | \r |
40731047 | 518 | @param StatusCode The status code value to convert into a warning code. \r |
f4ec40ab | 519 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
520 | \r | |
521 | @return The value specified by StatusCode with the highest bit set.\r | |
522 | \r | |
523 | **/\r | |
262ffea8 | 524 | #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))\r |
959ccb23 | 525 | \r |
f4ec40ab | 526 | /**\r |
527 | Produces a RETURN_STATUS code with the highest bit clear. \r | |
528 | \r | |
40731047 | 529 | @param StatusCode The status code value to convert into a warning code. \r |
f4ec40ab | 530 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
531 | \r | |
532 | @return The value specified by StatusCode with the highest bit clear.\r | |
533 | \r | |
534 | **/\r | |
262ffea8 | 535 | #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))\r |
f4ec40ab | 536 | \r |
537 | /**\r | |
538 | Returns TRUE if a specified RETURN_STATUS code is an error code. \r | |
539 | \r | |
540 | This function returns TRUE if StatusCode has the high bit set. Otherwise FALSE is returned. \r | |
541 | \r | |
40731047 | 542 | @param StatusCode The status code value to evaluate.\r |
f4ec40ab | 543 | \r |
544 | @retval TRUE The high bit of StatusCode is set.\r | |
545 | @retval FALSE The high bit of StatusCode is clear.\r | |
546 | \r | |
547 | **/\r | |
262ffea8 | 548 | #define RETURN_ERROR(StatusCode) (((RETURN_STATUS)(StatusCode)) < 0)\r |
f4ec40ab | 549 | \r |
550 | ///\r | |
551 | /// The operation completed successfully.\r | |
552 | ///\r | |
959ccb23 | 553 | #define RETURN_SUCCESS 0\r |
f4ec40ab | 554 | \r |
555 | ///\r | |
556 | /// The image failed to load.\r | |
557 | ///\r | |
959ccb23 | 558 | #define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r |
f4ec40ab | 559 | \r |
560 | ///\r | |
561 | /// The parameter was incorrect.\r | |
562 | ///\r | |
959ccb23 | 563 | #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r |
f4ec40ab | 564 | \r |
565 | ///\r | |
566 | /// The operation is not supported.\r | |
567 | ///\r | |
959ccb23 | 568 | #define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r |
f4ec40ab | 569 | \r |
570 | ///\r | |
571 | /// The buffer was not the proper size for the request.\r | |
572 | ///\r | |
959ccb23 | 573 | #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r |
f4ec40ab | 574 | \r |
575 | ///\r | |
576 | /// The buffer was not large enough to hold the requested data.\r | |
577 | /// The required buffer size is returned in the appropriate\r | |
578 | /// parameter when this error occurs.\r | |
579 | ///\r | |
959ccb23 | 580 | #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r |
f4ec40ab | 581 | \r |
582 | ///\r | |
80619162 | 583 | /// There is no data pending upon return.\r |
f4ec40ab | 584 | ///\r |
959ccb23 | 585 | #define RETURN_NOT_READY ENCODE_ERROR (6)\r |
f4ec40ab | 586 | \r |
587 | ///\r | |
588 | /// The physical device reported an error while attempting the\r | |
589 | /// operation.\r | |
590 | ///\r | |
959ccb23 | 591 | #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r |
f4ec40ab | 592 | \r |
593 | ///\r | |
594 | /// The device can not be written to.\r | |
595 | ///\r | |
959ccb23 | 596 | #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r |
f4ec40ab | 597 | \r |
598 | ///\r | |
599 | /// The resource has run out.\r | |
600 | ///\r | |
959ccb23 | 601 | #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r |
f4ec40ab | 602 | \r |
603 | ///\r | |
80619162 | 604 | /// An inconsistency was detected on the file system causing the \r |
f4ec40ab | 605 | /// operation to fail.\r |
606 | ///\r | |
959ccb23 | 607 | #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r |
f4ec40ab | 608 | \r |
609 | ///\r | |
610 | /// There is no more space on the file system.\r | |
611 | ///\r | |
959ccb23 | 612 | #define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r |
f4ec40ab | 613 | \r |
614 | ///\r | |
615 | /// The device does not contain any medium to perform the \r | |
616 | /// operation.\r | |
617 | ///\r | |
959ccb23 | 618 | #define RETURN_NO_MEDIA ENCODE_ERROR (12)\r |
f4ec40ab | 619 | \r |
620 | ///\r | |
621 | /// The medium in the device has changed since the last\r | |
622 | /// access.\r | |
623 | ///\r | |
959ccb23 | 624 | #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r |
f4ec40ab | 625 | \r |
626 | ///\r | |
627 | /// The item was not found.\r | |
628 | ///\r | |
959ccb23 | 629 | #define RETURN_NOT_FOUND ENCODE_ERROR (14)\r |
f4ec40ab | 630 | \r |
631 | ///\r | |
632 | /// Access was denied.\r | |
633 | ///\r | |
959ccb23 | 634 | #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r |
f4ec40ab | 635 | \r |
636 | ///\r | |
637 | /// The server was not found or did not respond to the request.\r | |
638 | ///\r | |
959ccb23 | 639 | #define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r |
f4ec40ab | 640 | \r |
641 | ///\r | |
642 | /// A mapping to the device does not exist.\r | |
643 | ///\r | |
959ccb23 | 644 | #define RETURN_NO_MAPPING ENCODE_ERROR (17)\r |
f4ec40ab | 645 | \r |
646 | ///\r | |
647 | /// A timeout time expired.\r | |
648 | ///\r | |
959ccb23 | 649 | #define RETURN_TIMEOUT ENCODE_ERROR (18)\r |
f4ec40ab | 650 | \r |
651 | ///\r | |
652 | /// The protocol has not been started.\r | |
653 | ///\r | |
959ccb23 | 654 | #define RETURN_NOT_STARTED ENCODE_ERROR (19)\r |
f4ec40ab | 655 | \r |
656 | ///\r | |
657 | /// The protocol has already been started.\r | |
658 | ///\r | |
959ccb23 | 659 | #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r |
f4ec40ab | 660 | \r |
661 | ///\r | |
662 | /// The operation was aborted.\r | |
663 | ///\r | |
959ccb23 | 664 | #define RETURN_ABORTED ENCODE_ERROR (21)\r |
f4ec40ab | 665 | \r |
666 | ///\r | |
727501bb | 667 | /// An ICMP error occurred during the network operation.\r |
f4ec40ab | 668 | ///\r |
959ccb23 | 669 | #define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r |
f4ec40ab | 670 | \r |
671 | ///\r | |
727501bb | 672 | /// A TFTP error occurred during the network operation.\r |
f4ec40ab | 673 | ///\r |
959ccb23 | 674 | #define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r |
f4ec40ab | 675 | \r |
676 | ///\r | |
727501bb | 677 | /// A protocol error occurred during the network operation.\r |
f4ec40ab | 678 | ///\r |
959ccb23 | 679 | #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r |
f4ec40ab | 680 | \r |
681 | ///\r | |
682 | /// A function encountered an internal version that was\r | |
727501bb | 683 | /// incompatible with a version requested by the caller.\r |
f4ec40ab | 684 | ///\r |
959ccb23 | 685 | #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r |
f4ec40ab | 686 | \r |
687 | ///\r | |
688 | /// The function was not performed due to a security violation.\r | |
689 | ///\r | |
959ccb23 | 690 | #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r |
f4ec40ab | 691 | \r |
692 | ///\r | |
693 | /// A CRC error was detected.\r | |
694 | ///\r | |
959ccb23 | 695 | #define RETURN_CRC_ERROR ENCODE_ERROR (27)\r |
f4ec40ab | 696 | \r |
697 | ///\r | |
698 | /// Beginning or end of media was reached.\r | |
699 | ///\r | |
959ccb23 | 700 | #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r |
f4ec40ab | 701 | \r |
702 | ///\r | |
703 | /// The end of the file was reached.\r | |
704 | ///\r | |
959ccb23 | 705 | #define RETURN_END_OF_FILE ENCODE_ERROR (31)\r |
f4ec40ab | 706 | \r |
707 | ///\r | |
708 | /// The language specified was invalid.\r | |
709 | ///\r | |
54cf8780 | 710 | #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r |
711 | \r | |
959ccb23 | 712 | \r |
f4ec40ab | 713 | ///\r |
714 | /// The Unicode string contained one or more characters that\r | |
715 | /// the device could not render and were skipped.\r | |
716 | ///\r | |
959ccb23 | 717 | #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r |
f4ec40ab | 718 | \r |
719 | ///\r | |
720 | /// The handle was closed, but the file was not deleted.\r | |
721 | ///\r | |
959ccb23 | 722 | #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r |
f4ec40ab | 723 | \r |
724 | ///\r | |
725 | /// The handle was closed, but the data to the file was not\r | |
726 | /// flushed properly.\r | |
727 | ///\r | |
959ccb23 | 728 | #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r |
f4ec40ab | 729 | \r |
730 | ///\r | |
731 | /// The resulting buffer was too small, and the data was \r | |
732 | /// truncated to the buffer size.\r | |
733 | ///\r | |
959ccb23 | 734 | #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r |
735 | \r | |
a7cc3d26 | 736 | /**\r |
737 | Returns a 16-bit signature built from 2 ASCII characters.\r | |
738 | \r | |
3963c4bf | 739 | This macro returns a 16-bit value built from the two ASCII characters specified \r |
740 | by A and B.\r | |
741 | \r | |
ee6c452c | 742 | @param A The first ASCII character.\r |
743 | @param B The second ASCII character.\r | |
a7cc3d26 | 744 | \r |
745 | @return A 16-bit value built from the two ASCII characters specified by A and B.\r | |
746 | \r | |
747 | **/\r | |
13c31065 | 748 | #define SIGNATURE_16(A, B) ((A) | (B << 8))\r |
a7cc3d26 | 749 | \r |
750 | /**\r | |
751 | Returns a 32-bit signature built from 4 ASCII characters.\r | |
752 | \r | |
3963c4bf | 753 | This macro returns a 32-bit value built from the four ASCII characters specified \r |
754 | by A, B, C, and D.\r | |
755 | \r | |
ee6c452c | 756 | @param A The first ASCII character.\r |
757 | @param B The second ASCII character.\r | |
758 | @param C The third ASCII character.\r | |
759 | @param D The fourth ASCII character.\r | |
a7cc3d26 | 760 | \r |
761 | @return A 32-bit value built from the two ASCII characters specified by A, B,\r | |
762 | C and D.\r | |
763 | \r | |
764 | **/\r | |
13c31065 | 765 | #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))\r |
a7cc3d26 | 766 | \r |
767 | /**\r | |
768 | Returns a 64-bit signature built from 8 ASCII characters.\r | |
769 | \r | |
3963c4bf | 770 | This macro returns a 64-bit value built from the eight ASCII characters specified \r |
771 | by A, B, C, D, E, F, G,and H.\r | |
772 | \r | |
ee6c452c | 773 | @param A The first ASCII character.\r |
774 | @param B The second ASCII character.\r | |
775 | @param C The third ASCII character.\r | |
776 | @param D The fourth ASCII character.\r | |
777 | @param E The fifth ASCII character.\r | |
778 | @param F The sixth ASCII character.\r | |
779 | @param G The seventh ASCII character.\r | |
780 | @param H The eighth ASCII character.\r | |
a7cc3d26 | 781 | \r |
782 | @return A 64-bit value built from the two ASCII characters specified by A, B,\r | |
783 | C, D, E, F, G and H.\r | |
784 | \r | |
785 | **/\r | |
13c31065 | 786 | #define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r |
787 | (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r | |
788 | \r | |
959ccb23 | 789 | #endif\r |
790 | \r |