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