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