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