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