Fix ALIGN_POINTER() macro. The pointer (p) passed in must always be converted to...
[mirror_edk2.git] / MdePkg / Include / Common / BaseTypes.h
CommitLineData
878ddf1f 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 Module 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\r
27#define MEMORY_FENCE() MemoryFence ()\r
28#define BREAKPOINT() CpuBreakpoint ()\r
29#define DEADLOOP() CpuDeadLoop ()\r
30\r
31typedef struct {\r
32 UINT32 Data1;\r
33 UINT16 Data2;\r
34 UINT16 Data3;\r
35 UINT8 Data4[8];\r
36} GUID;\r
37\r
38\r
39//\r
40// Modifiers to absract standard types to aid in debug of problems\r
41//\r
42#define CONST const\r
43#define STATIC static\r
44#define VOID void\r
45\r
46//\r
47// Modifiers for Data Types used to self document code.\r
48// This concept is borrowed for UEFI specification.\r
49//\r
50#ifndef IN\r
51//\r
52// Some other envirnments use this construct, so #ifndef to prevent\r
53// mulitple definition.\r
54//\r
55#define IN\r
56#define OUT\r
57#define OPTIONAL\r
58#endif\r
59\r
60//\r
61// Constants. They may exist in other build structures, so #ifndef them.\r
62//\r
63#ifndef TRUE\r
64//\r
0647c9ad 65// UEFI specification claims 1 and 0. We are concerned about the \r
878ddf1f 66// complier portability so we did it this way.\r
67//\r
68#define TRUE ((BOOLEAN)(1==1))\r
69#endif\r
70\r
71#ifndef FALSE\r
72#define FALSE ((BOOLEAN)(0==1))\r
73#endif\r
74\r
75#ifndef NULL\r
76#define NULL ((VOID *) 0)\r
77#endif\r
78\r
79//\r
80// Support for variable length argument lists using the ANSI standard.\r
81// \r
82// Since we are using the ANSI standard we used the standard nameing and\r
83// did not folow the coding convention\r
84//\r
85// VA_LIST - typedef for argument list.\r
86// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r
87// VA_END (VA_LIST Marker) - Clear Marker\r
88// VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from\r
89// the ... list. You must know the size and pass it in this macro.\r
90//\r
91// example:\r
92//\r
93// UINTN\r
94// ExampleVarArg (\r
95// IN UINTN NumberOfArgs,\r
96// ...\r
97// )\r
98// {\r
99// VA_LIST Marker;\r
100// UINTN Index;\r
101// UINTN Result;\r
102//\r
103// //\r
104// // Initialize the Marker\r
105// //\r
106// VA_START (Marker, NumberOfArgs);\r
107// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r
108// //\r
109// // The ... list is a series of UINTN values, so average them up.\r
110// //\r
111// Result += VA_ARG (Marker, UINTN);\r
112// }\r
113//\r
114// VA_END (Marker);\r
115// return Result\r
116// }\r
117//\r
118\r
119#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
120\r
121//\r
122// Also support coding convention rules for var arg macros\r
123//\r
124#ifndef VA_START\r
125\r
126typedef CHAR8 *VA_LIST;\r
127#define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))\r
128#define VA_ARG(ap, t) (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))\r
129#define VA_END(ap) (ap = (VA_LIST) 0)\r
130\r
131#endif\r
132\r
133///\r
134/// CONTAINING_RECORD - returns a pointer to the structure\r
135/// from one of it's elements.\r
136///\r
137#define _CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
138\r
139///\r
140/// ALIGN_POINTER - aligns a pointer to the lowest boundry\r
141///\r
b5b60e8b 142#define ALIGN_POINTER(p, s) ((VOID *) ((UINTN)(p) + (((s) - ((UINTN) (p))) & ((s) - 1))))\r
878ddf1f 143\r
144///\r
145/// ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor\r
146///\r
147#define ALIGN_VARIABLE(Value, Adjustment) \\r
148 Adjustment = 0U; \\r
149 if ((UINTN) (Value) % sizeof (UINTN)) { \\r
150 (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \\r
151 } \\r
152 (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))\r
153\r
154//\r
155// EFI Error Codes common to all execution phases\r
156//\r
157\r
158typedef INTN RETURN_STATUS;\r
159\r
160///\r
161/// Set the upper bit to indicate EFI Error.\r
162///\r
163#define ENCODE_ERROR(a) (MAX_BIT | (a))\r
164\r
165#define ENCODE_WARNING(a) (a)\r
166#define RETURN_ERROR(a) ((a) < 0)\r
167\r
168#define RETURN_SUCCESS 0\r
169#define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r
170#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r
171#define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r
172#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r
173#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r
174#define RETURN_NOT_READY ENCODE_ERROR (6)\r
175#define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r
176#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r
177#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r
178#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r
179#define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r
180#define RETURN_NO_MEDIA ENCODE_ERROR (12)\r
181#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r
182#define RETURN_NOT_FOUND ENCODE_ERROR (14)\r
183#define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r
184#define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r
185#define RETURN_NO_MAPPING ENCODE_ERROR (17)\r
186#define RETURN_TIMEOUT ENCODE_ERROR (18)\r
187#define RETURN_NOT_STARTED ENCODE_ERROR (19)\r
188#define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r
189#define RETURN_ABORTED ENCODE_ERROR (21)\r
190#define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r
191#define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r
192#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r
193#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r
194#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r
195#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
196#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
197#define RETURN_END_OF_FILE ENCODE_ERROR (31)\r
198\r
199#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r
200#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r
201#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r
202#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
203\r
204typedef UINT64 PHYSICAL_ADDRESS;\r
205\r
206#endif\r