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