MdeModulePkg:
[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
4 This file is stand alone self consistent set of definitions. \r
5\r
6 Copyright (c) 2006, Intel Corporation \r
7 All rights reserved. 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 File Name: BaseTypes.h\r
16\r
17**/\r
18\r
19#ifndef __BASE_TYPES_H__\r
20#define __BASE_TYPES_H__\r
21\r
22//\r
23// Include processor specific binding\r
24//\r
25#include <ProcessorBind.h>\r
26#include <stdarg.h>\r
27\r
28//\r
fd171542 29// Modifiers to abstract standard types to aid in debug of problems\r
30fdf114
LG
30//\r
31#define CONST const\r
32#define STATIC static\r
33#define VOID void\r
34\r
35//\r
36// Modifiers for Data Types used to self document code.\r
37// This concept is borrowed for UEFI specification.\r
38//\r
39#ifndef IN\r
40//\r
fd171542 41// Some other environments use this construct, so #ifndef to prevent\r
42// multiple definition.\r
30fdf114
LG
43//\r
44#define IN\r
45#define OUT\r
46#define OPTIONAL\r
47#endif\r
48\r
49//\r
50// Constants. They may exist in other build structures, so #ifndef them.\r
51//\r
52#ifndef TRUE\r
53//\r
54// BugBug: UEFI specification claims 1 and 0. We are concerned about the \r
55// complier portability so we did it this way.\r
56//\r
57#define TRUE ((BOOLEAN)(1==1))\r
58#endif\r
59\r
60#ifndef FALSE\r
61#define FALSE ((BOOLEAN)(0==1))\r
62#endif\r
63\r
64#ifndef NULL\r
65#define NULL ((VOID *) 0)\r
66#endif\r
67\r
68//\r
69// Support for variable length argument lists using the ANSI standard.\r
70// \r
fd171542 71// Since we are using the ANSI standard we used the standard naming and\r
72// did not follow the coding convention\r
30fdf114
LG
73//\r
74// VA_LIST - typedef for argument list.\r
75// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r
76// VA_END (VA_LIST Marker) - Clear Marker\r
fd171542 77// VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from\r
30fdf114
LG
78// the ... list. You must know the size and pass it in this macro.\r
79//\r
80// example:\r
81//\r
82// UINTN\r
83// ExampleVarArg (\r
84// IN UINTN NumberOfArgs,\r
85// ...\r
86// )\r
87// {\r
88// VA_LIST Marker;\r
89// UINTN Index;\r
90// UINTN Result;\r
91//\r
92// //\r
93// // Initialize the Marker\r
94// //\r
95// VA_START (Marker, NumberOfArgs);\r
96// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r
97// //\r
98// // The ... list is a series of UINTN values, so average them up.\r
99// //\r
100// Result += VA_ARG (Marker, UINTN);\r
101// }\r
102//\r
103// VA_END (Marker);\r
104// return Result\r
105// }\r
106//\r
107\r
108#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
109\r
110//\r
111// Also support coding convention rules for var arg macros\r
112//\r
113#ifndef VA_START\r
114\r
115// typedef CHAR8 *VA_LIST;\r
116// #define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))\r
117// #define VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))\r
118// #define VA_END(ap) (ap = (VA_LIST) 0)\r
119// Use the native arguments for tools.\r
120#define VA_START va_start\r
121#define VA_ARG va_arg\r
122#define VA_END va_end\r
123#define VA_LIST va_list\r
124\r
125#endif\r
126\r
127//\r
128// Macro that returns the byte offset of a field in a data structure. \r
129//\r
130#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
131\r
132///\r
133/// _CR - returns a pointer to the structure\r
134/// from one of it's elements.\r
135///\r
136#define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
137\r
138///\r
fd171542 139/// ALIGN_POINTER - aligns a pointer to the lowest boundary\r
30fdf114
LG
140///\r
141#define ALIGN_POINTER(p, s) ((VOID *) ((UINTN)(p) + (((s) - ((UINTN) (p))) & ((s) - 1))))\r
142\r
143///\r
fd171542 144/// ALIGN_VARIABLE - aligns a variable up to the next natural boundary for int size of a processor\r
30fdf114
LG
145///\r
146#define ALIGN_VARIABLE(Value, Adjustment) \\r
147 Adjustment = 0U; \\r
148 if ((UINTN) (Value) % sizeof (UINTN)) { \\r
149 (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \\r
150 } \\r
151 (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))\r
152\r
153//\r
154// Return the maximum of two operands. \r
155// This macro returns the maximum of two operand specified by a and b. \r
156// Both a and b must be the same numerical types, signed or unsigned.\r
157//\r
158#define MAX(a, b) \\r
159 (((a) > (b)) ? (a) : (b))\r
160\r
161\r
162//\r
163// Return the minimum of two operands. \r
164// This macro returns the minimal of two operand specified by a and b. \r
165// Both a and b must be the same numerical types, signed or unsigned.\r
166//\r
167#define MIN(a, b) \\r
168 (((a) < (b)) ? (a) : (b))\r
169\r
170\r
171//\r
172// EFI Error Codes common to all execution phases\r
173//\r
174\r
175typedef INTN RETURN_STATUS;\r
176\r
177///\r
178/// Set the upper bit to indicate EFI Error.\r
179///\r
180#define ENCODE_ERROR(a) (MAX_BIT | (a))\r
181\r
182#define ENCODE_WARNING(a) (a)\r
183#define RETURN_ERROR(a) ((a) < 0)\r
184\r
185#define RETURN_SUCCESS 0\r
186#define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r
187#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r
188#define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r
189#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r
190#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r
191#define RETURN_NOT_READY ENCODE_ERROR (6)\r
192#define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r
193#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r
194#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r
195#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r
196#define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r
197#define RETURN_NO_MEDIA ENCODE_ERROR (12)\r
198#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r
199#define RETURN_NOT_FOUND ENCODE_ERROR (14)\r
200#define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r
201#define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r
202#define RETURN_NO_MAPPING ENCODE_ERROR (17)\r
203#define RETURN_TIMEOUT ENCODE_ERROR (18)\r
204#define RETURN_NOT_STARTED ENCODE_ERROR (19)\r
205#define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r
206#define RETURN_ABORTED ENCODE_ERROR (21)\r
207#define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r
208#define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r
209#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r
210#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r
211#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r
212#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
213#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
214#define RETURN_END_OF_FILE ENCODE_ERROR (31)\r
215\r
216#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r
217#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r
218#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r
219#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
220\r
221typedef UINT64 PHYSICAL_ADDRESS;\r
222\r
223#endif\r