| | 1 | /** @file\r |
| | 2 | Root include file for Mde Package Base type modules\r |
| | 3 | \r |
| | 4 | This is the include file for any module of type base. Base modules only use\r |
| | 5 | types defined via this include file and can be ported easily to any\r |
| | 6 | environment. There are a set of base libraries in the Mde Package that can\r |
| | 7 | be used to implement base modules.\r |
| | 8 | \r |
| | 9 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
| | 10 | Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r |
| | 11 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| | 12 | \r |
| | 13 | **/\r |
| | 14 | \r |
| | 15 | \r |
| | 16 | #ifndef __BASE_H__\r |
| | 17 | #define __BASE_H__\r |
| | 18 | \r |
| | 19 | //\r |
| | 20 | // Include processor specific binding\r |
| | 21 | //\r |
| | 22 | #include <ProcessorBind.h>\r |
| | 23 | \r |
| | 24 | #if defined(_MSC_EXTENSIONS)\r |
| | 25 | //\r |
| | 26 | // Disable warning when last field of data structure is a zero sized array.\r |
| | 27 | //\r |
| | 28 | #pragma warning ( disable : 4200 )\r |
| | 29 | #endif\r |
| | 30 | \r |
| | 31 | //\r |
| | 32 | // The Microsoft* C compiler can removed references to unreferenced data items\r |
| | 33 | // if the /OPT:REF linker option is used. We defined a macro as this is a\r |
| | 34 | // a non standard extension\r |
| | 35 | //\r |
| | 36 | #if defined(_MSC_EXTENSIONS) && _MSC_VER < 1800 && !defined (MDE_CPU_EBC)\r |
| | 37 | ///\r |
| | 38 | /// Remove global variable from the linked image if there are no references to\r |
| | 39 | /// it after all compiler and linker optimizations have been performed.\r |
| | 40 | ///\r |
| | 41 | ///\r |
| | 42 | #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r |
| | 43 | #else\r |
| | 44 | ///\r |
| | 45 | /// Remove the global variable from the linked image if there are no references\r |
| | 46 | /// to it after all compiler and linker optimizations have been performed.\r |
| | 47 | ///\r |
| | 48 | ///\r |
| | 49 | #define GLOBAL_REMOVE_IF_UNREFERENCED\r |
| | 50 | #endif\r |
| | 51 | \r |
| | 52 | //\r |
| | 53 | // Should be used in combination with NORETURN to avoid 'noreturn' returns\r |
| | 54 | // warnings.\r |
| | 55 | //\r |
| | 56 | #ifndef UNREACHABLE\r |
| | 57 | #ifdef __GNUC__\r |
| | 58 | ///\r |
| | 59 | /// Signal compilers and analyzers that this call is not reachable. It is\r |
| | 60 | /// up to the compiler to remove any code past that point.\r |
| | 61 | ///\r |
| | 62 | #define UNREACHABLE() __builtin_unreachable ()\r |
| | 63 | #elif defined (__has_feature)\r |
| | 64 | #if __has_builtin (__builtin_unreachable)\r |
| | 65 | ///\r |
| | 66 | /// Signal compilers and analyzers that this call is not reachable. It is\r |
| | 67 | /// up to the compiler to remove any code past that point.\r |
| | 68 | ///\r |
| | 69 | #define UNREACHABLE() __builtin_unreachable ()\r |
| | 70 | #endif\r |
| | 71 | #endif\r |
| | 72 | \r |
| | 73 | #ifndef UNREACHABLE\r |
| | 74 | ///\r |
| | 75 | /// Signal compilers and analyzers that this call is not reachable. It is\r |
| | 76 | /// up to the compiler to remove any code past that point.\r |
| | 77 | ///\r |
| | 78 | #define UNREACHABLE()\r |
| | 79 | #endif\r |
| | 80 | #endif\r |
| | 81 | \r |
| | 82 | //\r |
| | 83 | // Signaling compilers and analyzers that a certain function cannot return may\r |
| | 84 | // remove all following code and thus lead to better optimization and less\r |
| | 85 | // false positives.\r |
| | 86 | //\r |
| | 87 | #ifndef NORETURN\r |
| | 88 | #if defined (__GNUC__) || defined (__clang__)\r |
| | 89 | ///\r |
| | 90 | /// Signal compilers and analyzers that the function cannot return.\r |
| | 91 | /// It is up to the compiler to remove any code past a call to functions\r |
| | 92 | /// flagged with this attribute.\r |
| | 93 | ///\r |
| | 94 | #define NORETURN __attribute__((noreturn))\r |
| | 95 | #elif defined(_MSC_EXTENSIONS) && !defined(MDE_CPU_EBC)\r |
| | 96 | ///\r |
| | 97 | /// Signal compilers and analyzers that the function cannot return.\r |
| | 98 | /// It is up to the compiler to remove any code past a call to functions\r |
| | 99 | /// flagged with this attribute.\r |
| | 100 | ///\r |
| | 101 | #define NORETURN __declspec(noreturn)\r |
| | 102 | #else\r |
| | 103 | ///\r |
| | 104 | /// Signal compilers and analyzers that the function cannot return.\r |
| | 105 | /// It is up to the compiler to remove any code past a call to functions\r |
| | 106 | /// flagged with this attribute.\r |
| | 107 | ///\r |
| | 108 | #define NORETURN\r |
| | 109 | #endif\r |
| | 110 | #endif\r |
| | 111 | \r |
| | 112 | //\r |
| | 113 | // Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'\r |
| | 114 | // returns warnings.\r |
| | 115 | //\r |
| | 116 | #ifndef ANALYZER_UNREACHABLE\r |
| | 117 | #ifdef __clang_analyzer__\r |
| | 118 | #if __has_builtin (__builtin_unreachable)\r |
| | 119 | ///\r |
| | 120 | /// Signal the analyzer that this call is not reachable.\r |
| | 121 | /// This excludes compilers.\r |
| | 122 | ///\r |
| | 123 | #define ANALYZER_UNREACHABLE() __builtin_unreachable ()\r |
| | 124 | #endif\r |
| | 125 | #endif\r |
| | 126 | \r |
| | 127 | #ifndef ANALYZER_UNREACHABLE\r |
| | 128 | ///\r |
| | 129 | /// Signal the analyzer that this call is not reachable.\r |
| | 130 | /// This excludes compilers.\r |
| | 131 | ///\r |
| | 132 | #define ANALYZER_UNREACHABLE()\r |
| | 133 | #endif\r |
| | 134 | #endif\r |
| | 135 | \r |
| | 136 | //\r |
| | 137 | // Static Analyzers may issue errors about potential NULL-dereferences when\r |
| | 138 | // dereferencing a pointer, that has been checked before, outside of a\r |
| | 139 | // NULL-check. This may lead to false positives, such as when using ASSERT()\r |
| | 140 | // for verification.\r |
| | 141 | //\r |
| | 142 | #ifndef ANALYZER_NORETURN\r |
| | 143 | #ifdef __has_feature\r |
| | 144 | #if __has_feature (attribute_analyzer_noreturn)\r |
| | 145 | ///\r |
| | 146 | /// Signal analyzers that the function cannot return.\r |
| | 147 | /// This excludes compilers.\r |
| | 148 | ///\r |
| | 149 | #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))\r |
| | 150 | #endif\r |
| | 151 | #endif\r |
| | 152 | \r |
| | 153 | #ifndef ANALYZER_NORETURN\r |
| | 154 | ///\r |
| | 155 | /// Signal the analyzer that the function cannot return.\r |
| | 156 | /// This excludes compilers.\r |
| | 157 | ///\r |
| | 158 | #define ANALYZER_NORETURN\r |
| | 159 | #endif\r |
| | 160 | #endif\r |
| | 161 | \r |
| | 162 | ///\r |
| | 163 | /// Tell the code optimizer that the function will return twice.\r |
| | 164 | /// This prevents wrong optimizations which can cause bugs.\r |
| | 165 | ///\r |
| | 166 | #ifndef RETURNS_TWICE\r |
| | 167 | #if defined (__GNUC__) || defined (__clang__)\r |
| | 168 | ///\r |
| | 169 | /// Tell the code optimizer that the function will return twice.\r |
| | 170 | /// This prevents wrong optimizations which can cause bugs.\r |
| | 171 | ///\r |
| | 172 | #define RETURNS_TWICE __attribute__((returns_twice))\r |
| | 173 | #else\r |
| | 174 | ///\r |
| | 175 | /// Tell the code optimizer that the function will return twice.\r |
| | 176 | /// This prevents wrong optimizations which can cause bugs.\r |
| | 177 | ///\r |
| | 178 | #define RETURNS_TWICE\r |
| | 179 | #endif\r |
| | 180 | #endif\r |
| | 181 | \r |
| | 182 | //\r |
| | 183 | // For symbol name in assembly code, an extra "_" is sometimes necessary\r |
| | 184 | //\r |
| | 185 | \r |
| | 186 | ///\r |
| | 187 | /// Private worker functions for ASM_PFX()\r |
| | 188 | ///\r |
| | 189 | #define _CONCATENATE(a, b) __CONCATENATE(a, b)\r |
| | 190 | #define __CONCATENATE(a, b) a ## b\r |
| | 191 | \r |
| | 192 | ///\r |
| | 193 | /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix\r |
| | 194 | /// on symbols in assembly language.\r |
| | 195 | ///\r |
| | 196 | #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)\r |
| | 197 | \r |
| | 198 | #if __APPLE__\r |
| | 199 | //\r |
| | 200 | // Apple extension that is used by the linker to optimize code size\r |
| | 201 | // with assembly functions. Put at the end of your .S files\r |
| | 202 | //\r |
| | 203 | #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols\r |
| | 204 | #else\r |
| | 205 | #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED\r |
| | 206 | #endif\r |
| | 207 | \r |
| | 208 | #ifdef __CC_ARM\r |
| | 209 | //\r |
| | 210 | // Older RVCT ARM compilers don't fully support #pragma pack and require __packed\r |
| | 211 | // as a prefix for the structure.\r |
| | 212 | //\r |
| | 213 | #define PACKED __packed\r |
| | 214 | #else\r |
| | 215 | #define PACKED\r |
| | 216 | #endif\r |
| | 217 | \r |
| | 218 | ///\r |
| | 219 | /// 128 bit buffer containing a unique identifier value.\r |
| | 220 | /// Unless otherwise specified, aligned on a 64 bit boundary.\r |
| | 221 | ///\r |
| | 222 | typedef struct {\r |
| | 223 | UINT32 Data1;\r |
| | 224 | UINT16 Data2;\r |
| | 225 | UINT16 Data3;\r |
| | 226 | UINT8 Data4[8];\r |
| | 227 | } GUID;\r |
| | 228 | \r |
| | 229 | ///\r |
| | 230 | /// 4-byte buffer. An IPv4 internet protocol address.\r |
| | 231 | ///\r |
| | 232 | typedef struct {\r |
| | 233 | UINT8 Addr[4];\r |
| | 234 | } IPv4_ADDRESS;\r |
| | 235 | \r |
| | 236 | ///\r |
| | 237 | /// 16-byte buffer. An IPv6 internet protocol address.\r |
| | 238 | ///\r |
| | 239 | typedef struct {\r |
| | 240 | UINT8 Addr[16];\r |
| | 241 | } IPv6_ADDRESS;\r |
| | 242 | \r |
| | 243 | //\r |
| | 244 | // 8-bytes unsigned value that represents a physical system address.\r |
| | 245 | //\r |
| | 246 | typedef UINT64 PHYSICAL_ADDRESS;\r |
| | 247 | \r |
| | 248 | ///\r |
| | 249 | /// LIST_ENTRY structure definition.\r |
| | 250 | ///\r |
| | 251 | typedef struct _LIST_ENTRY LIST_ENTRY;\r |
| | 252 | \r |
| | 253 | ///\r |
| | 254 | /// _LIST_ENTRY structure definition.\r |
| | 255 | ///\r |
| | 256 | struct _LIST_ENTRY {\r |
| | 257 | LIST_ENTRY *ForwardLink;\r |
| | 258 | LIST_ENTRY *BackLink;\r |
| | 259 | };\r |
| | 260 | \r |
| | 261 | //\r |
| | 262 | // Modifiers to abstract standard types to aid in debug of problems\r |
| | 263 | //\r |
| | 264 | \r |
| | 265 | ///\r |
| | 266 | /// Datum is read-only.\r |
| | 267 | ///\r |
| | 268 | #define CONST const\r |
| | 269 | \r |
| | 270 | ///\r |
| | 271 | /// Datum is scoped to the current file or function.\r |
| | 272 | ///\r |
| | 273 | #define STATIC static\r |
| | 274 | \r |
| | 275 | ///\r |
| | 276 | /// Undeclared type.\r |
| | 277 | ///\r |
| | 278 | #define VOID void\r |
| | 279 | \r |
| | 280 | //\r |
| | 281 | // Modifiers for Data Types used to self document code.\r |
| | 282 | // This concept is borrowed for UEFI specification.\r |
| | 283 | //\r |
| | 284 | \r |
| | 285 | ///\r |
| | 286 | /// Datum is passed to the function.\r |
| | 287 | ///\r |
| | 288 | #define IN\r |
| | 289 | \r |
| | 290 | ///\r |
| | 291 | /// Datum is returned from the function.\r |
| | 292 | ///\r |
| | 293 | #define OUT\r |
| | 294 | \r |
| | 295 | ///\r |
| | 296 | /// Passing the datum to the function is optional, and a NULL\r |
| | 297 | /// is passed if the value is not supplied.\r |
| | 298 | ///\r |
| | 299 | #define OPTIONAL\r |
| | 300 | \r |
| | 301 | //\r |
| | 302 | // UEFI specification claims 1 and 0. We are concerned about the\r |
| | 303 | // compiler portability so we did it this way.\r |
| | 304 | //\r |
| | 305 | \r |
| | 306 | ///\r |
| | 307 | /// Boolean true value. UEFI Specification defines this value to be 1,\r |
| | 308 | /// but this form is more portable.\r |
| | 309 | ///\r |
| | 310 | #define TRUE ((BOOLEAN)(1==1))\r |
| | 311 | \r |
| | 312 | ///\r |
| | 313 | /// Boolean false value. UEFI Specification defines this value to be 0,\r |
| | 314 | /// but this form is more portable.\r |
| | 315 | ///\r |
| | 316 | #define FALSE ((BOOLEAN)(0==1))\r |
| | 317 | \r |
| | 318 | ///\r |
| | 319 | /// NULL pointer (VOID *)\r |
| | 320 | ///\r |
| | 321 | #define NULL ((VOID *) 0)\r |
| | 322 | \r |
| | 323 | //\r |
| | 324 | // Null character\r |
| | 325 | //\r |
| | 326 | #define CHAR_NULL 0x0000\r |
| | 327 | \r |
| | 328 | ///\r |
| | 329 | /// Maximum values for common UEFI Data Types\r |
| | 330 | ///\r |
| | 331 | #define MAX_INT8 ((INT8)0x7F)\r |
| | 332 | #define MAX_UINT8 ((UINT8)0xFF)\r |
| | 333 | #define MAX_INT16 ((INT16)0x7FFF)\r |
| | 334 | #define MAX_UINT16 ((UINT16)0xFFFF)\r |
| | 335 | #define MAX_INT32 ((INT32)0x7FFFFFFF)\r |
| | 336 | #define MAX_UINT32 ((UINT32)0xFFFFFFFF)\r |
| | 337 | #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)\r |
| | 338 | #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)\r |
| | 339 | \r |
| | 340 | ///\r |
| | 341 | /// Minimum values for the signed UEFI Data Types\r |
| | 342 | ///\r |
| | 343 | #define MIN_INT8 (((INT8) -127) - 1)\r |
| | 344 | #define MIN_INT16 (((INT16) -32767) - 1)\r |
| | 345 | #define MIN_INT32 (((INT32) -2147483647) - 1)\r |
| | 346 | #define MIN_INT64 (((INT64) -9223372036854775807LL) - 1)\r |
| | 347 | \r |
| | 348 | #define BIT0 0x00000001\r |
| | 349 | #define BIT1 0x00000002\r |
| | 350 | #define BIT2 0x00000004\r |
| | 351 | #define BIT3 0x00000008\r |
| | 352 | #define BIT4 0x00000010\r |
| | 353 | #define BIT5 0x00000020\r |
| | 354 | #define BIT6 0x00000040\r |
| | 355 | #define BIT7 0x00000080\r |
| | 356 | #define BIT8 0x00000100\r |
| | 357 | #define BIT9 0x00000200\r |
| | 358 | #define BIT10 0x00000400\r |
| | 359 | #define BIT11 0x00000800\r |
| | 360 | #define BIT12 0x00001000\r |
| | 361 | #define BIT13 0x00002000\r |
| | 362 | #define BIT14 0x00004000\r |
| | 363 | #define BIT15 0x00008000\r |
| | 364 | #define BIT16 0x00010000\r |
| | 365 | #define BIT17 0x00020000\r |
| | 366 | #define BIT18 0x00040000\r |
| | 367 | #define BIT19 0x00080000\r |
| | 368 | #define BIT20 0x00100000\r |
| | 369 | #define BIT21 0x00200000\r |
| | 370 | #define BIT22 0x00400000\r |
| | 371 | #define BIT23 0x00800000\r |
| | 372 | #define BIT24 0x01000000\r |
| | 373 | #define BIT25 0x02000000\r |
| | 374 | #define BIT26 0x04000000\r |
| | 375 | #define BIT27 0x08000000\r |
| | 376 | #define BIT28 0x10000000\r |
| | 377 | #define BIT29 0x20000000\r |
| | 378 | #define BIT30 0x40000000\r |
| | 379 | #define BIT31 0x80000000\r |
| | 380 | #define BIT32 0x0000000100000000ULL\r |
| | 381 | #define BIT33 0x0000000200000000ULL\r |
| | 382 | #define BIT34 0x0000000400000000ULL\r |
| | 383 | #define BIT35 0x0000000800000000ULL\r |
| | 384 | #define BIT36 0x0000001000000000ULL\r |
| | 385 | #define BIT37 0x0000002000000000ULL\r |
| | 386 | #define BIT38 0x0000004000000000ULL\r |
| | 387 | #define BIT39 0x0000008000000000ULL\r |
| | 388 | #define BIT40 0x0000010000000000ULL\r |
| | 389 | #define BIT41 0x0000020000000000ULL\r |
| | 390 | #define BIT42 0x0000040000000000ULL\r |
| | 391 | #define BIT43 0x0000080000000000ULL\r |
| | 392 | #define BIT44 0x0000100000000000ULL\r |
| | 393 | #define BIT45 0x0000200000000000ULL\r |
| | 394 | #define BIT46 0x0000400000000000ULL\r |
| | 395 | #define BIT47 0x0000800000000000ULL\r |
| | 396 | #define BIT48 0x0001000000000000ULL\r |
| | 397 | #define BIT49 0x0002000000000000ULL\r |
| | 398 | #define BIT50 0x0004000000000000ULL\r |
| | 399 | #define BIT51 0x0008000000000000ULL\r |
| | 400 | #define BIT52 0x0010000000000000ULL\r |
| | 401 | #define BIT53 0x0020000000000000ULL\r |
| | 402 | #define BIT54 0x0040000000000000ULL\r |
| | 403 | #define BIT55 0x0080000000000000ULL\r |
| | 404 | #define BIT56 0x0100000000000000ULL\r |
| | 405 | #define BIT57 0x0200000000000000ULL\r |
| | 406 | #define BIT58 0x0400000000000000ULL\r |
| | 407 | #define BIT59 0x0800000000000000ULL\r |
| | 408 | #define BIT60 0x1000000000000000ULL\r |
| | 409 | #define BIT61 0x2000000000000000ULL\r |
| | 410 | #define BIT62 0x4000000000000000ULL\r |
| | 411 | #define BIT63 0x8000000000000000ULL\r |
| | 412 | \r |
| | 413 | #define SIZE_1KB 0x00000400\r |
| | 414 | #define SIZE_2KB 0x00000800\r |
| | 415 | #define SIZE_4KB 0x00001000\r |
| | 416 | #define SIZE_8KB 0x00002000\r |
| | 417 | #define SIZE_16KB 0x00004000\r |
| | 418 | #define SIZE_32KB 0x00008000\r |
| | 419 | #define SIZE_64KB 0x00010000\r |
| | 420 | #define SIZE_128KB 0x00020000\r |
| | 421 | #define SIZE_256KB 0x00040000\r |
| | 422 | #define SIZE_512KB 0x00080000\r |
| | 423 | #define SIZE_1MB 0x00100000\r |
| | 424 | #define SIZE_2MB 0x00200000\r |
| | 425 | #define SIZE_4MB 0x00400000\r |
| | 426 | #define SIZE_8MB 0x00800000\r |
| | 427 | #define SIZE_16MB 0x01000000\r |
| | 428 | #define SIZE_32MB 0x02000000\r |
| | 429 | #define SIZE_64MB 0x04000000\r |
| | 430 | #define SIZE_128MB 0x08000000\r |
| | 431 | #define SIZE_256MB 0x10000000\r |
| | 432 | #define SIZE_512MB 0x20000000\r |
| | 433 | #define SIZE_1GB 0x40000000\r |
| | 434 | #define SIZE_2GB 0x80000000\r |
| | 435 | #define SIZE_4GB 0x0000000100000000ULL\r |
| | 436 | #define SIZE_8GB 0x0000000200000000ULL\r |
| | 437 | #define SIZE_16GB 0x0000000400000000ULL\r |
| | 438 | #define SIZE_32GB 0x0000000800000000ULL\r |
| | 439 | #define SIZE_64GB 0x0000001000000000ULL\r |
| | 440 | #define SIZE_128GB 0x0000002000000000ULL\r |
| | 441 | #define SIZE_256GB 0x0000004000000000ULL\r |
| | 442 | #define SIZE_512GB 0x0000008000000000ULL\r |
| | 443 | #define SIZE_1TB 0x0000010000000000ULL\r |
| | 444 | #define SIZE_2TB 0x0000020000000000ULL\r |
| | 445 | #define SIZE_4TB 0x0000040000000000ULL\r |
| | 446 | #define SIZE_8TB 0x0000080000000000ULL\r |
| | 447 | #define SIZE_16TB 0x0000100000000000ULL\r |
| | 448 | #define SIZE_32TB 0x0000200000000000ULL\r |
| | 449 | #define SIZE_64TB 0x0000400000000000ULL\r |
| | 450 | #define SIZE_128TB 0x0000800000000000ULL\r |
| | 451 | #define SIZE_256TB 0x0001000000000000ULL\r |
| | 452 | #define SIZE_512TB 0x0002000000000000ULL\r |
| | 453 | #define SIZE_1PB 0x0004000000000000ULL\r |
| | 454 | #define SIZE_2PB 0x0008000000000000ULL\r |
| | 455 | #define SIZE_4PB 0x0010000000000000ULL\r |
| | 456 | #define SIZE_8PB 0x0020000000000000ULL\r |
| | 457 | #define SIZE_16PB 0x0040000000000000ULL\r |
| | 458 | #define SIZE_32PB 0x0080000000000000ULL\r |
| | 459 | #define SIZE_64PB 0x0100000000000000ULL\r |
| | 460 | #define SIZE_128PB 0x0200000000000000ULL\r |
| | 461 | #define SIZE_256PB 0x0400000000000000ULL\r |
| | 462 | #define SIZE_512PB 0x0800000000000000ULL\r |
| | 463 | #define SIZE_1EB 0x1000000000000000ULL\r |
| | 464 | #define SIZE_2EB 0x2000000000000000ULL\r |
| | 465 | #define SIZE_4EB 0x4000000000000000ULL\r |
| | 466 | #define SIZE_8EB 0x8000000000000000ULL\r |
| | 467 | \r |
| | 468 | #define BASE_1KB 0x00000400\r |
| | 469 | #define BASE_2KB 0x00000800\r |
| | 470 | #define BASE_4KB 0x00001000\r |
| | 471 | #define BASE_8KB 0x00002000\r |
| | 472 | #define BASE_16KB 0x00004000\r |
| | 473 | #define BASE_32KB 0x00008000\r |
| | 474 | #define BASE_64KB 0x00010000\r |
| | 475 | #define BASE_128KB 0x00020000\r |
| | 476 | #define BASE_256KB 0x00040000\r |
| | 477 | #define BASE_512KB 0x00080000\r |
| | 478 | #define BASE_1MB 0x00100000\r |
| | 479 | #define BASE_2MB 0x00200000\r |
| | 480 | #define BASE_4MB 0x00400000\r |
| | 481 | #define BASE_8MB 0x00800000\r |
| | 482 | #define BASE_16MB 0x01000000\r |
| | 483 | #define BASE_32MB 0x02000000\r |
| | 484 | #define BASE_64MB 0x04000000\r |
| | 485 | #define BASE_128MB 0x08000000\r |
| | 486 | #define BASE_256MB 0x10000000\r |
| | 487 | #define BASE_512MB 0x20000000\r |
| | 488 | #define BASE_1GB 0x40000000\r |
| | 489 | #define BASE_2GB 0x80000000\r |
| | 490 | #define BASE_4GB 0x0000000100000000ULL\r |
| | 491 | #define BASE_8GB 0x0000000200000000ULL\r |
| | 492 | #define BASE_16GB 0x0000000400000000ULL\r |
| | 493 | #define BASE_32GB 0x0000000800000000ULL\r |
| | 494 | #define BASE_64GB 0x0000001000000000ULL\r |
| | 495 | #define BASE_128GB 0x0000002000000000ULL\r |
| | 496 | #define BASE_256GB 0x0000004000000000ULL\r |
| | 497 | #define BASE_512GB 0x0000008000000000ULL\r |
| | 498 | #define BASE_1TB 0x0000010000000000ULL\r |
| | 499 | #define BASE_2TB 0x0000020000000000ULL\r |
| | 500 | #define BASE_4TB 0x0000040000000000ULL\r |
| | 501 | #define BASE_8TB 0x0000080000000000ULL\r |
| | 502 | #define BASE_16TB 0x0000100000000000ULL\r |
| | 503 | #define BASE_32TB 0x0000200000000000ULL\r |
| | 504 | #define BASE_64TB 0x0000400000000000ULL\r |
| | 505 | #define BASE_128TB 0x0000800000000000ULL\r |
| | 506 | #define BASE_256TB 0x0001000000000000ULL\r |
| | 507 | #define BASE_512TB 0x0002000000000000ULL\r |
| | 508 | #define BASE_1PB 0x0004000000000000ULL\r |
| | 509 | #define BASE_2PB 0x0008000000000000ULL\r |
| | 510 | #define BASE_4PB 0x0010000000000000ULL\r |
| | 511 | #define BASE_8PB 0x0020000000000000ULL\r |
| | 512 | #define BASE_16PB 0x0040000000000000ULL\r |
| | 513 | #define BASE_32PB 0x0080000000000000ULL\r |
| | 514 | #define BASE_64PB 0x0100000000000000ULL\r |
| | 515 | #define BASE_128PB 0x0200000000000000ULL\r |
| | 516 | #define BASE_256PB 0x0400000000000000ULL\r |
| | 517 | #define BASE_512PB 0x0800000000000000ULL\r |
| | 518 | #define BASE_1EB 0x1000000000000000ULL\r |
| | 519 | #define BASE_2EB 0x2000000000000000ULL\r |
| | 520 | #define BASE_4EB 0x4000000000000000ULL\r |
| | 521 | #define BASE_8EB 0x8000000000000000ULL\r |
| | 522 | \r |
| | 523 | //\r |
| | 524 | // Support for variable argument lists in freestanding edk2 modules.\r |
| | 525 | //\r |
| | 526 | // For modules that use the ISO C library interfaces for variable\r |
| | 527 | // argument lists, refer to "StdLib/Include/stdarg.h".\r |
| | 528 | //\r |
| | 529 | // VA_LIST - typedef for argument list.\r |
| | 530 | // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r |
| | 531 | // VA_END (VA_LIST Marker) - Clear Marker\r |
| | 532 | // VA_ARG (VA_LIST Marker, var arg type) - Use Marker to get an argument from\r |
| | 533 | // the ... list. You must know the type and pass it in this macro. Type\r |
| | 534 | // must be compatible with the type of the actual next argument (as promoted\r |
| | 535 | // according to the default argument promotions.)\r |
| | 536 | // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.\r |
| | 537 | //\r |
| | 538 | // Example:\r |
| | 539 | //\r |
| | 540 | // UINTN\r |
| | 541 | // EFIAPI\r |
| | 542 | // ExampleVarArg (\r |
| | 543 | // IN UINTN NumberOfArgs,\r |
| | 544 | // ...\r |
| | 545 | // )\r |
| | 546 | // {\r |
| | 547 | // VA_LIST Marker;\r |
| | 548 | // UINTN Index;\r |
| | 549 | // UINTN Result;\r |
| | 550 | //\r |
| | 551 | // //\r |
| | 552 | // // Initialize the Marker\r |
| | 553 | // //\r |
| | 554 | // VA_START (Marker, NumberOfArgs);\r |
| | 555 | // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r |
| | 556 | // //\r |
| | 557 | // // The ... list is a series of UINTN values, so sum them up.\r |
| | 558 | // //\r |
| | 559 | // Result += VA_ARG (Marker, UINTN);\r |
| | 560 | // }\r |
| | 561 | //\r |
| | 562 | // VA_END (Marker);\r |
| | 563 | // return Result;\r |
| | 564 | // }\r |
| | 565 | //\r |
| | 566 | // Notes:\r |
| | 567 | // - Functions that call VA_START() / VA_END() must have a variable\r |
| | 568 | // argument list and must be declared EFIAPI.\r |
| | 569 | // - Functions that call VA_COPY() / VA_END() must be declared EFIAPI.\r |
| | 570 | // - Functions that only use VA_LIST and VA_ARG() need not be EFIAPI.\r |
| | 571 | //\r |
| | 572 | \r |
| | 573 | /**\r |
| | 574 | Return the size of argument that has been aligned to sizeof (UINTN).\r |
| | 575 | \r |
| | 576 | @param n The parameter size to be aligned.\r |
| | 577 | \r |
| | 578 | @return The aligned size.\r |
| | 579 | **/\r |
| | 580 | #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r |
| | 581 | \r |
| | 582 | #if defined(__CC_ARM)\r |
| | 583 | //\r |
| | 584 | // RVCT ARM variable argument list support.\r |
| | 585 | //\r |
| | 586 | \r |
| | 587 | ///\r |
| | 588 | /// Variable used to traverse the list of arguments. This type can vary by\r |
| | 589 | /// implementation and could be an array or structure.\r |
| | 590 | ///\r |
| | 591 | #ifdef __APCS_ADSABI\r |
| | 592 | typedef int *va_list[1];\r |
| | 593 | #define VA_LIST va_list\r |
| | 594 | #else\r |
| | 595 | typedef struct __va_list { void *__ap; } va_list;\r |
| | 596 | #define VA_LIST va_list\r |
| | 597 | #endif\r |
| | 598 | \r |
| | 599 | #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)\r |
| | 600 | \r |
| | 601 | #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)\r |
| | 602 | \r |
| | 603 | #define VA_END(Marker) ((void)0)\r |
| | 604 | \r |
| | 605 | // For some ARM RVCT compilers, __va_copy is not defined\r |
| | 606 | #ifndef __va_copy\r |
| | 607 | #define __va_copy(dest, src) ((void)((dest) = (src)))\r |
| | 608 | #endif\r |
| | 609 | \r |
| | 610 | #define VA_COPY(Dest, Start) __va_copy (Dest, Start)\r |
| | 611 | \r |
| | 612 | #elif defined(_M_ARM) || defined(_M_ARM64)\r |
| | 613 | //\r |
| | 614 | // MSFT ARM variable argument list support.\r |
| | 615 | //\r |
| | 616 | \r |
| | 617 | typedef char* VA_LIST;\r |
| | 618 | \r |
| | 619 | #define VA_START(Marker, Parameter) __va_start (&Marker, &Parameter, _INT_SIZE_OF (Parameter), __alignof(Parameter), &Parameter)\r |
| | 620 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE) + ((-(INTN)Marker) & (sizeof(TYPE) - 1))) - _INT_SIZE_OF (TYPE)))\r |
| | 621 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r |
| | 622 | #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))\r |
| | 623 | \r |
| | 624 | #elif defined(__GNUC__) || defined(__clang__)\r |
| | 625 | \r |
| | 626 | #if defined(MDE_CPU_X64) && !defined(NO_MSABI_VA_FUNCS) && !defined(__clang__)\r |
| | 627 | //\r |
| | 628 | // X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.\r |
| | 629 | //\r |
| | 630 | ///\r |
| | 631 | /// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI\r |
| | 632 | ///\r |
| | 633 | \r |
| | 634 | ///\r |
| | 635 | /// Variable used to traverse the list of arguments. This type can vary by\r |
| | 636 | /// implementation and could be an array or structure.\r |
| | 637 | ///\r |
| | 638 | typedef __builtin_ms_va_list VA_LIST;\r |
| | 639 | \r |
| | 640 | #define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)\r |
| | 641 | \r |
| | 642 | #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r |
| | 643 | \r |
| | 644 | #define VA_END(Marker) __builtin_ms_va_end (Marker)\r |
| | 645 | \r |
| | 646 | #define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)\r |
| | 647 | \r |
| | 648 | #else\r |
| | 649 | //\r |
| | 650 | // Use GCC built-in macros for variable argument lists.\r |
| | 651 | //\r |
| | 652 | \r |
| | 653 | ///\r |
| | 654 | /// Variable used to traverse the list of arguments. This type can vary by\r |
| | 655 | /// implementation and could be an array or structure.\r |
| | 656 | ///\r |
| | 657 | typedef __builtin_va_list VA_LIST;\r |
| | 658 | \r |
| | 659 | #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)\r |
| | 660 | \r |
| | 661 | #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r |
| | 662 | \r |
| | 663 | #define VA_END(Marker) __builtin_va_end (Marker)\r |
| | 664 | \r |
| | 665 | #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)\r |
| | 666 | \r |
| | 667 | #endif\r |
| | 668 | \r |
| | 669 | #else\r |
| | 670 | ///\r |
| | 671 | /// Variable used to traverse the list of arguments. This type can vary by\r |
| | 672 | /// implementation and could be an array or structure.\r |
| | 673 | ///\r |
| | 674 | typedef CHAR8 *VA_LIST;\r |
| | 675 | \r |
| | 676 | /**\r |
| | 677 | Retrieves a pointer to the beginning of a variable argument list, based on\r |
| | 678 | the name of the parameter that immediately precedes the variable argument list.\r |
| | 679 | \r |
| | 680 | This function initializes Marker to point to the beginning of the variable\r |
| | 681 | argument list that immediately follows Parameter. The method for computing the\r |
| | 682 | pointer to the next argument in the argument list is CPU-specific following the\r |
| | 683 | EFIAPI ABI.\r |
| | 684 | \r |
| | 685 | @param Marker The VA_LIST used to traverse the list of arguments.\r |
| | 686 | @param Parameter The name of the parameter that immediately precedes\r |
| | 687 | the variable argument list.\r |
| | 688 | \r |
| | 689 | @return A pointer to the beginning of a variable argument list.\r |
| | 690 | \r |
| | 691 | **/\r |
| | 692 | #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))\r |
| | 693 | \r |
| | 694 | /**\r |
| | 695 | Returns an argument of a specified type from a variable argument list and updates\r |
| | 696 | the pointer to the variable argument list to point to the next argument.\r |
| | 697 | \r |
| | 698 | This function returns an argument of the type specified by TYPE from the beginning\r |
| | 699 | of the variable argument list specified by Marker. Marker is then updated to point\r |
| | 700 | to the next argument in the variable argument list. The method for computing the\r |
| | 701 | pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r |
| | 702 | \r |
| | 703 | @param Marker VA_LIST used to traverse the list of arguments.\r |
| | 704 | @param TYPE The type of argument to retrieve from the beginning\r |
| | 705 | of the variable argument list.\r |
| | 706 | \r |
| | 707 | @return An argument of the type specified by TYPE.\r |
| | 708 | \r |
| | 709 | **/\r |
| | 710 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r |
| | 711 | \r |
| | 712 | /**\r |
| | 713 | Terminates the use of a variable argument list.\r |
| | 714 | \r |
| | 715 | This function initializes Marker so it can no longer be used with VA_ARG().\r |
| | 716 | After this macro is used, the only way to access the variable argument list is\r |
| | 717 | by using VA_START() again.\r |
| | 718 | \r |
| | 719 | @param Marker VA_LIST used to traverse the list of arguments.\r |
| | 720 | \r |
| | 721 | **/\r |
| | 722 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r |
| | 723 | \r |
| | 724 | /**\r |
| | 725 | Initializes a VA_LIST as a copy of an existing VA_LIST.\r |
| | 726 | \r |
| | 727 | This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest\r |
| | 728 | followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach\r |
| | 729 | the present state of Start.\r |
| | 730 | \r |
| | 731 | @param Dest VA_LIST used to traverse the list of arguments.\r |
| | 732 | @param Start VA_LIST used to traverse the list of arguments.\r |
| | 733 | \r |
| | 734 | **/\r |
| | 735 | #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))\r |
| | 736 | \r |
| | 737 | #endif\r |
| | 738 | \r |
| | 739 | ///\r |
| | 740 | /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.\r |
| | 741 | ///\r |
| | 742 | typedef UINTN *BASE_LIST;\r |
| | 743 | \r |
| | 744 | /**\r |
| | 745 | Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.\r |
| | 746 | \r |
| | 747 | @param TYPE The date type to determine the size of.\r |
| | 748 | \r |
| | 749 | @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.\r |
| | 750 | **/\r |
| | 751 | #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))\r |
| | 752 | \r |
| | 753 | /**\r |
| | 754 | Returns an argument of a specified type from a variable argument list and updates\r |
| | 755 | the pointer to the variable argument list to point to the next argument.\r |
| | 756 | \r |
| | 757 | This function returns an argument of the type specified by TYPE from the beginning\r |
| | 758 | of the variable argument list specified by Marker. Marker is then updated to point\r |
| | 759 | to the next argument in the variable argument list. The method for computing the\r |
| | 760 | pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r |
| | 761 | \r |
| | 762 | @param Marker The pointer to the beginning of a variable argument list.\r |
| | 763 | @param TYPE The type of argument to retrieve from the beginning\r |
| | 764 | of the variable argument list.\r |
| | 765 | \r |
| | 766 | @return An argument of the type specified by TYPE.\r |
| | 767 | \r |
| | 768 | **/\r |
| | 769 | #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))\r |
| | 770 | \r |
| | 771 | /**\r |
| | 772 | The macro that returns the byte offset of a field in a data structure.\r |
| | 773 | \r |
| | 774 | This function returns the offset, in bytes, of field specified by Field from the\r |
| | 775 | beginning of the data structure specified by TYPE. If TYPE does not contain Field,\r |
| | 776 | the module will not compile.\r |
| | 777 | \r |
| | 778 | @param TYPE The name of the data structure that contains the field specified by Field.\r |
| | 779 | @param Field The name of the field in the data structure.\r |
| | 780 | \r |
| | 781 | @return Offset, in bytes, of field.\r |
| | 782 | \r |
| | 783 | **/\r |
| | 784 | #ifdef __GNUC__\r |
| | 785 | #if __GNUC__ >= 4\r |
| | 786 | #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))\r |
| | 787 | #endif\r |
| | 788 | #endif\r |
| | 789 | \r |
| | 790 | #ifndef OFFSET_OF\r |
| | 791 | #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r |
| | 792 | #endif\r |
| | 793 | \r |
| | 794 | /**\r |
| | 795 | Portable definition for compile time assertions.\r |
| | 796 | Equivalent to C11 static_assert macro from assert.h.\r |
| | 797 | \r |
| | 798 | @param Expression Boolean expression.\r |
| | 799 | @param Message Raised compiler diagnostic message when expression is false.\r |
| | 800 | \r |
| | 801 | **/\r |
| | 802 | #ifdef MDE_CPU_EBC\r |
| | 803 | #define STATIC_ASSERT(Expression, Message)\r |
| | 804 | #elif _MSC_EXTENSIONS\r |
| | 805 | #define STATIC_ASSERT static_assert\r |
| | 806 | #else\r |
| | 807 | #define STATIC_ASSERT _Static_assert\r |
| | 808 | #endif\r |
| | 809 | \r |
| | 810 | //\r |
| | 811 | // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with\r |
| | 812 | // Section 2.3.1 of the UEFI 2.3 Specification.\r |
| | 813 | //\r |
| | 814 | \r |
| | 815 | STATIC_ASSERT (sizeof (BOOLEAN) == 1, "sizeof (BOOLEAN) does not meet UEFI Specification Data Type requirements");\r |
| | 816 | STATIC_ASSERT (sizeof (INT8) == 1, "sizeof (INT8) does not meet UEFI Specification Data Type requirements");\r |
| | 817 | STATIC_ASSERT (sizeof (UINT8) == 1, "sizeof (UINT8) does not meet UEFI Specification Data Type requirements");\r |
| | 818 | STATIC_ASSERT (sizeof (INT16) == 2, "sizeof (INT16) does not meet UEFI Specification Data Type requirements");\r |
| | 819 | STATIC_ASSERT (sizeof (UINT16) == 2, "sizeof (UINT16) does not meet UEFI Specification Data Type requirements");\r |
| | 820 | STATIC_ASSERT (sizeof (INT32) == 4, "sizeof (INT32) does not meet UEFI Specification Data Type requirements");\r |
| | 821 | STATIC_ASSERT (sizeof (UINT32) == 4, "sizeof (UINT32) does not meet UEFI Specification Data Type requirements");\r |
| | 822 | STATIC_ASSERT (sizeof (INT64) == 8, "sizeof (INT64) does not meet UEFI Specification Data Type requirements");\r |
| | 823 | STATIC_ASSERT (sizeof (UINT64) == 8, "sizeof (UINT64) does not meet UEFI Specification Data Type requirements");\r |
| | 824 | STATIC_ASSERT (sizeof (CHAR8) == 1, "sizeof (CHAR8) does not meet UEFI Specification Data Type requirements");\r |
| | 825 | STATIC_ASSERT (sizeof (CHAR16) == 2, "sizeof (CHAR16) does not meet UEFI Specification Data Type requirements");\r |
| | 826 | \r |
| | 827 | //\r |
| | 828 | // The following three enum types are used to verify that the compiler\r |
| | 829 | // configuration for enum types is compliant with Section 2.3.1 of the\r |
| | 830 | // UEFI 2.3 Specification. These enum types and enum values are not\r |
| | 831 | // intended to be used. A prefix of '__' is used avoid conflicts with\r |
| | 832 | // other types.\r |
| | 833 | //\r |
| | 834 | typedef enum {\r |
| | 835 | __VerifyUint8EnumValue = 0xff\r |
| | 836 | } __VERIFY_UINT8_ENUM_SIZE;\r |
| | 837 | \r |
| | 838 | typedef enum {\r |
| | 839 | __VerifyUint16EnumValue = 0xffff\r |
| | 840 | } __VERIFY_UINT16_ENUM_SIZE;\r |
| | 841 | \r |
| | 842 | typedef enum {\r |
| | 843 | __VerifyUint32EnumValue = 0xffffffff\r |
| | 844 | } __VERIFY_UINT32_ENUM_SIZE;\r |
| | 845 | \r |
| | 846 | STATIC_ASSERT (sizeof (__VERIFY_UINT8_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\r |
| | 847 | STATIC_ASSERT (sizeof (__VERIFY_UINT16_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\r |
| | 848 | STATIC_ASSERT (sizeof (__VERIFY_UINT32_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");\r |
| | 849 | \r |
| | 850 | /**\r |
| | 851 | Macro that returns a pointer to the data structure that contains a specified field of\r |
| | 852 | that data structure. This is a lightweight method to hide information by placing a\r |
| | 853 | public data structure inside a larger private data structure and using a pointer to\r |
| | 854 | the public data structure to retrieve a pointer to the private data structure.\r |
| | 855 | \r |
| | 856 | This function computes the offset, in bytes, of field specified by Field from the beginning\r |
| | 857 | of the data structure specified by TYPE. This offset is subtracted from Record, and is\r |
| | 858 | used to return a pointer to a data structure of the type specified by TYPE. If the data type\r |
| | 859 | specified by TYPE does not contain the field specified by Field, then the module will not compile.\r |
| | 860 | \r |
| | 861 | @param Record Pointer to the field specified by Field within a data structure of type TYPE.\r |
| | 862 | @param TYPE The name of the data structure type to return. This data structure must\r |
| | 863 | contain the field specified by Field.\r |
| | 864 | @param Field The name of the field in the data structure specified by TYPE to which Record points.\r |
| | 865 | \r |
| | 866 | @return A pointer to the structure from one of it's elements.\r |
| | 867 | \r |
| | 868 | **/\r |
| | 869 | #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - OFFSET_OF (TYPE, Field)))\r |
| | 870 | \r |
| | 871 | /**\r |
| | 872 | Rounds a value up to the next boundary using a specified alignment.\r |
| | 873 | \r |
| | 874 | This function rounds Value up to the next boundary using the specified Alignment.\r |
| | 875 | This aligned value is returned.\r |
| | 876 | \r |
| | 877 | @param Value The value to round up.\r |
| | 878 | @param Alignment The alignment boundary used to return the aligned value.\r |
| | 879 | \r |
| | 880 | @return A value up to the next boundary.\r |
| | 881 | \r |
| | 882 | **/\r |
| | 883 | #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r |
| | 884 | \r |
| | 885 | /**\r |
| | 886 | Adjust a pointer by adding the minimum offset required for it to be aligned on\r |
| | 887 | a specified alignment boundary.\r |
| | 888 | \r |
| | 889 | This function rounds the pointer specified by Pointer to the next alignment boundary\r |
| | 890 | specified by Alignment. The pointer to the aligned address is returned.\r |
| | 891 | \r |
| | 892 | @param Pointer The pointer to round up.\r |
| | 893 | @param Alignment The alignment boundary to use to return an aligned pointer.\r |
| | 894 | \r |
| | 895 | @return Pointer to the aligned address.\r |
| | 896 | \r |
| | 897 | **/\r |
| | 898 | #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r |
| | 899 | \r |
| | 900 | /**\r |
| | 901 | Rounds a value up to the next natural boundary for the current CPU.\r |
| | 902 | This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.\r |
| | 903 | \r |
| | 904 | This function rounds the value specified by Value up to the next natural boundary for the\r |
| | 905 | current CPU. This rounded value is returned.\r |
| | 906 | \r |
| | 907 | @param Value The value to round up.\r |
| | 908 | \r |
| | 909 | @return Rounded value specified by Value.\r |
| | 910 | \r |
| | 911 | **/\r |
| | 912 | #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))\r |
| | 913 | \r |
| | 914 | \r |
| | 915 | /**\r |
| | 916 | Return the maximum of two operands.\r |
| | 917 | \r |
| | 918 | This macro returns the maximum of two operand specified by a and b.\r |
| | 919 | Both a and b must be the same numerical types, signed or unsigned.\r |
| | 920 | \r |
| | 921 | @param a The first operand with any numerical type.\r |
| | 922 | @param b The second operand. Can be any numerical type as long as is\r |
| | 923 | the same type as a.\r |
| | 924 | \r |
| | 925 | @return Maximum of two operands.\r |
| | 926 | \r |
| | 927 | **/\r |
| | 928 | #define MAX(a, b) \\r |
| | 929 | (((a) > (b)) ? (a) : (b))\r |
| | 930 | \r |
| | 931 | /**\r |
| | 932 | Return the minimum of two operands.\r |
| | 933 | \r |
| | 934 | This macro returns the minimal of two operand specified by a and b.\r |
| | 935 | Both a and b must be the same numerical types, signed or unsigned.\r |
| | 936 | \r |
| | 937 | @param a The first operand with any numerical type.\r |
| | 938 | @param b The second operand. It should be the same any numerical type with a.\r |
| | 939 | \r |
| | 940 | @return Minimum of two operands.\r |
| | 941 | \r |
| | 942 | **/\r |
| | 943 | #define MIN(a, b) \\r |
| | 944 | (((a) < (b)) ? (a) : (b))\r |
| | 945 | \r |
| | 946 | /**\r |
| | 947 | Return the absolute value of a signed operand.\r |
| | 948 | \r |
| | 949 | This macro returns the absolute value of the signed operand specified by a.\r |
| | 950 | \r |
| | 951 | @param a The signed operand.\r |
| | 952 | \r |
| | 953 | @return The absolute value of the signed operand.\r |
| | 954 | \r |
| | 955 | **/\r |
| | 956 | #define ABS(a) \\r |
| | 957 | (((a) < 0) ? (-(a)) : (a))\r |
| | 958 | \r |
| | 959 | //\r |
| | 960 | // Status codes common to all execution phases\r |
| | 961 | //\r |
| | 962 | typedef UINTN RETURN_STATUS;\r |
| | 963 | \r |
| | 964 | /**\r |
| | 965 | Produces a RETURN_STATUS code with the highest bit set.\r |
| | 966 | \r |
| | 967 | @param StatusCode The status code value to convert into a warning code.\r |
| | 968 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
| | 969 | \r |
| | 970 | @return The value specified by StatusCode with the highest bit set.\r |
| | 971 | \r |
| | 972 | **/\r |
| | 973 | #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))\r |
| | 974 | \r |
| | 975 | /**\r |
| | 976 | Produces a RETURN_STATUS code with the highest bit clear.\r |
| | 977 | \r |
| | 978 | @param StatusCode The status code value to convert into a warning code.\r |
| | 979 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
| | 980 | \r |
| | 981 | @return The value specified by StatusCode with the highest bit clear.\r |
| | 982 | \r |
| | 983 | **/\r |
| | 984 | #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))\r |
| | 985 | \r |
| | 986 | /**\r |
| | 987 | Returns TRUE if a specified RETURN_STATUS code is an error code.\r |
| | 988 | \r |
| | 989 | This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.\r |
| | 990 | \r |
| | 991 | @param StatusCode The status code value to evaluate.\r |
| | 992 | \r |
| | 993 | @retval TRUE The high bit of StatusCode is set.\r |
| | 994 | @retval FALSE The high bit of StatusCode is clear.\r |
| | 995 | \r |
| | 996 | **/\r |
| | 997 | #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)\r |
| | 998 | \r |
| | 999 | ///\r |
| | 1000 | /// The operation completed successfully.\r |
| | 1001 | ///\r |
| | 1002 | #define RETURN_SUCCESS 0\r |
| | 1003 | \r |
| | 1004 | ///\r |
| | 1005 | /// The image failed to load.\r |
| | 1006 | ///\r |
| | 1007 | #define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r |
| | 1008 | \r |
| | 1009 | ///\r |
| | 1010 | /// The parameter was incorrect.\r |
| | 1011 | ///\r |
| | 1012 | #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r |
| | 1013 | \r |
| | 1014 | ///\r |
| | 1015 | /// The operation is not supported.\r |
| | 1016 | ///\r |
| | 1017 | #define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r |
| | 1018 | \r |
| | 1019 | ///\r |
| | 1020 | /// The buffer was not the proper size for the request.\r |
| | 1021 | ///\r |
| | 1022 | #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r |
| | 1023 | \r |
| | 1024 | ///\r |
| | 1025 | /// The buffer was not large enough to hold the requested data.\r |
| | 1026 | /// The required buffer size is returned in the appropriate\r |
| | 1027 | /// parameter when this error occurs.\r |
| | 1028 | ///\r |
| | 1029 | #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r |
| | 1030 | \r |
| | 1031 | ///\r |
| | 1032 | /// There is no data pending upon return.\r |
| | 1033 | ///\r |
| | 1034 | #define RETURN_NOT_READY ENCODE_ERROR (6)\r |
| | 1035 | \r |
| | 1036 | ///\r |
| | 1037 | /// The physical device reported an error while attempting the\r |
| | 1038 | /// operation.\r |
| | 1039 | ///\r |
| | 1040 | #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r |
| | 1041 | \r |
| | 1042 | ///\r |
| | 1043 | /// The device can not be written to.\r |
| | 1044 | ///\r |
| | 1045 | #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r |
| | 1046 | \r |
| | 1047 | ///\r |
| | 1048 | /// The resource has run out.\r |
| | 1049 | ///\r |
| | 1050 | #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r |
| | 1051 | \r |
| | 1052 | ///\r |
| | 1053 | /// An inconsistency was detected on the file system causing the\r |
| | 1054 | /// operation to fail.\r |
| | 1055 | ///\r |
| | 1056 | #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r |
| | 1057 | \r |
| | 1058 | ///\r |
| | 1059 | /// There is no more space on the file system.\r |
| | 1060 | ///\r |
| | 1061 | #define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r |
| | 1062 | \r |
| | 1063 | ///\r |
| | 1064 | /// The device does not contain any medium to perform the\r |
| | 1065 | /// operation.\r |
| | 1066 | ///\r |
| | 1067 | #define RETURN_NO_MEDIA ENCODE_ERROR (12)\r |
| | 1068 | \r |
| | 1069 | ///\r |
| | 1070 | /// The medium in the device has changed since the last\r |
| | 1071 | /// access.\r |
| | 1072 | ///\r |
| | 1073 | #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r |
| | 1074 | \r |
| | 1075 | ///\r |
| | 1076 | /// The item was not found.\r |
| | 1077 | ///\r |
| | 1078 | #define RETURN_NOT_FOUND ENCODE_ERROR (14)\r |
| | 1079 | \r |
| | 1080 | ///\r |
| | 1081 | /// Access was denied.\r |
| | 1082 | ///\r |
| | 1083 | #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r |
| | 1084 | \r |
| | 1085 | ///\r |
| | 1086 | /// The server was not found or did not respond to the request.\r |
| | 1087 | ///\r |
| | 1088 | #define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r |
| | 1089 | \r |
| | 1090 | ///\r |
| | 1091 | /// A mapping to the device does not exist.\r |
| | 1092 | ///\r |
| | 1093 | #define RETURN_NO_MAPPING ENCODE_ERROR (17)\r |
| | 1094 | \r |
| | 1095 | ///\r |
| | 1096 | /// A timeout time expired.\r |
| | 1097 | ///\r |
| | 1098 | #define RETURN_TIMEOUT ENCODE_ERROR (18)\r |
| | 1099 | \r |
| | 1100 | ///\r |
| | 1101 | /// The protocol has not been started.\r |
| | 1102 | ///\r |
| | 1103 | #define RETURN_NOT_STARTED ENCODE_ERROR (19)\r |
| | 1104 | \r |
| | 1105 | ///\r |
| | 1106 | /// The protocol has already been started.\r |
| | 1107 | ///\r |
| | 1108 | #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r |
| | 1109 | \r |
| | 1110 | ///\r |
| | 1111 | /// The operation was aborted.\r |
| | 1112 | ///\r |
| | 1113 | #define RETURN_ABORTED ENCODE_ERROR (21)\r |
| | 1114 | \r |
| | 1115 | ///\r |
| | 1116 | /// An ICMP error occurred during the network operation.\r |
| | 1117 | ///\r |
| | 1118 | #define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r |
| | 1119 | \r |
| | 1120 | ///\r |
| | 1121 | /// A TFTP error occurred during the network operation.\r |
| | 1122 | ///\r |
| | 1123 | #define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r |
| | 1124 | \r |
| | 1125 | ///\r |
| | 1126 | /// A protocol error occurred during the network operation.\r |
| | 1127 | ///\r |
| | 1128 | #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r |
| | 1129 | \r |
| | 1130 | ///\r |
| | 1131 | /// A function encountered an internal version that was\r |
| | 1132 | /// incompatible with a version requested by the caller.\r |
| | 1133 | ///\r |
| | 1134 | #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r |
| | 1135 | \r |
| | 1136 | ///\r |
| | 1137 | /// The function was not performed due to a security violation.\r |
| | 1138 | ///\r |
| | 1139 | #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r |
| | 1140 | \r |
| | 1141 | ///\r |
| | 1142 | /// A CRC error was detected.\r |
| | 1143 | ///\r |
| | 1144 | #define RETURN_CRC_ERROR ENCODE_ERROR (27)\r |
| | 1145 | \r |
| | 1146 | ///\r |
| | 1147 | /// The beginning or end of media was reached.\r |
| | 1148 | ///\r |
| | 1149 | #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r |
| | 1150 | \r |
| | 1151 | ///\r |
| | 1152 | /// The end of the file was reached.\r |
| | 1153 | ///\r |
| | 1154 | #define RETURN_END_OF_FILE ENCODE_ERROR (31)\r |
| | 1155 | \r |
| | 1156 | ///\r |
| | 1157 | /// The language specified was invalid.\r |
| | 1158 | ///\r |
| | 1159 | #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r |
| | 1160 | \r |
| | 1161 | ///\r |
| | 1162 | /// The security status of the data is unknown or compromised\r |
| | 1163 | /// and the data must be updated or replaced to restore a valid\r |
| | 1164 | /// security status.\r |
| | 1165 | ///\r |
| | 1166 | #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)\r |
| | 1167 | \r |
| | 1168 | ///\r |
| | 1169 | /// A HTTP error occurred during the network operation.\r |
| | 1170 | ///\r |
| | 1171 | #define RETURN_HTTP_ERROR ENCODE_ERROR (35)\r |
| | 1172 | \r |
| | 1173 | ///\r |
| | 1174 | /// The string contained one or more characters that\r |
| | 1175 | /// the device could not render and were skipped.\r |
| | 1176 | ///\r |
| | 1177 | #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r |
| | 1178 | \r |
| | 1179 | ///\r |
| | 1180 | /// The handle was closed, but the file was not deleted.\r |
| | 1181 | ///\r |
| | 1182 | #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r |
| | 1183 | \r |
| | 1184 | ///\r |
| | 1185 | /// The handle was closed, but the data to the file was not\r |
| | 1186 | /// flushed properly.\r |
| | 1187 | ///\r |
| | 1188 | #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r |
| | 1189 | \r |
| | 1190 | ///\r |
| | 1191 | /// The resulting buffer was too small, and the data was\r |
| | 1192 | /// truncated to the buffer size.\r |
| | 1193 | ///\r |
| | 1194 | #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r |
| | 1195 | \r |
| | 1196 | ///\r |
| | 1197 | /// The data has not been updated within the timeframe set by\r |
| | 1198 | /// local policy for this type of data.\r |
| | 1199 | ///\r |
| | 1200 | #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)\r |
| | 1201 | \r |
| | 1202 | ///\r |
| | 1203 | /// The resulting buffer contains UEFI-compliant file system.\r |
| | 1204 | ///\r |
| | 1205 | #define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)\r |
| | 1206 | \r |
| | 1207 | \r |
| | 1208 | /**\r |
| | 1209 | Returns a 16-bit signature built from 2 ASCII characters.\r |
| | 1210 | \r |
| | 1211 | This macro returns a 16-bit value built from the two ASCII characters specified\r |
| | 1212 | by A and B.\r |
| | 1213 | \r |
| | 1214 | @param A The first ASCII character.\r |
| | 1215 | @param B The second ASCII character.\r |
| | 1216 | \r |
| | 1217 | @return A 16-bit value built from the two ASCII characters specified by A and B.\r |
| | 1218 | \r |
| | 1219 | **/\r |
| | 1220 | #define SIGNATURE_16(A, B) ((A) | (B << 8))\r |
| | 1221 | \r |
| | 1222 | /**\r |
| | 1223 | Returns a 32-bit signature built from 4 ASCII characters.\r |
| | 1224 | \r |
| | 1225 | This macro returns a 32-bit value built from the four ASCII characters specified\r |
| | 1226 | by A, B, C, and D.\r |
| | 1227 | \r |
| | 1228 | @param A The first ASCII character.\r |
| | 1229 | @param B The second ASCII character.\r |
| | 1230 | @param C The third ASCII character.\r |
| | 1231 | @param D The fourth ASCII character.\r |
| | 1232 | \r |
| | 1233 | @return A 32-bit value built from the two ASCII characters specified by A, B,\r |
| | 1234 | C and D.\r |
| | 1235 | \r |
| | 1236 | **/\r |
| | 1237 | #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))\r |
| | 1238 | \r |
| | 1239 | /**\r |
| | 1240 | Returns a 64-bit signature built from 8 ASCII characters.\r |
| | 1241 | \r |
| | 1242 | This macro returns a 64-bit value built from the eight ASCII characters specified\r |
| | 1243 | by A, B, C, D, E, F, G,and H.\r |
| | 1244 | \r |
| | 1245 | @param A The first ASCII character.\r |
| | 1246 | @param B The second ASCII character.\r |
| | 1247 | @param C The third ASCII character.\r |
| | 1248 | @param D The fourth ASCII character.\r |
| | 1249 | @param E The fifth ASCII character.\r |
| | 1250 | @param F The sixth ASCII character.\r |
| | 1251 | @param G The seventh ASCII character.\r |
| | 1252 | @param H The eighth ASCII character.\r |
| | 1253 | \r |
| | 1254 | @return A 64-bit value built from the two ASCII characters specified by A, B,\r |
| | 1255 | C, D, E, F, G and H.\r |
| | 1256 | \r |
| | 1257 | **/\r |
| | 1258 | #define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r |
| | 1259 | (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r |
| | 1260 | \r |
| | 1261 | #if defined(_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)\r |
| | 1262 | void * _ReturnAddress(void);\r |
| | 1263 | #pragma intrinsic(_ReturnAddress)\r |
| | 1264 | /**\r |
| | 1265 | Get the return address of the calling function.\r |
| | 1266 | \r |
| | 1267 | Based on intrinsic function _ReturnAddress that provides the address of\r |
| | 1268 | the instruction in the calling function that will be executed after\r |
| | 1269 | control returns to the caller.\r |
| | 1270 | \r |
| | 1271 | @param L Return Level.\r |
| | 1272 | \r |
| | 1273 | @return The return address of the calling function or 0 if L != 0.\r |
| | 1274 | \r |
| | 1275 | **/\r |
| | 1276 | #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)\r |
| | 1277 | #elif defined (__GNUC__) || defined (__clang__)\r |
| | 1278 | void * __builtin_return_address (unsigned int level);\r |
| | 1279 | /**\r |
| | 1280 | Get the return address of the calling function.\r |
| | 1281 | \r |
| | 1282 | Based on built-in Function __builtin_return_address that returns\r |
| | 1283 | the return address of the current function, or of one of its callers.\r |
| | 1284 | \r |
| | 1285 | @param L Return Level.\r |
| | 1286 | \r |
| | 1287 | @return The return address of the calling function.\r |
| | 1288 | \r |
| | 1289 | **/\r |
| | 1290 | #define RETURN_ADDRESS(L) __builtin_return_address (L)\r |
| | 1291 | #else\r |
| | 1292 | /**\r |
| | 1293 | Get the return address of the calling function.\r |
| | 1294 | \r |
| | 1295 | @param L Return Level.\r |
| | 1296 | \r |
| | 1297 | @return 0 as compilers don't support this feature.\r |
| | 1298 | \r |
| | 1299 | **/\r |
| | 1300 | #define RETURN_ADDRESS(L) ((VOID *) 0)\r |
| | 1301 | #endif\r |
| | 1302 | \r |
| | 1303 | /**\r |
| | 1304 | Return the number of elements in an array.\r |
| | 1305 | \r |
| | 1306 | @param Array An object of array type. Array is only used as an argument to\r |
| | 1307 | the sizeof operator, therefore Array is never evaluated. The\r |
| | 1308 | caller is responsible for ensuring that Array's type is not\r |
| | 1309 | incomplete; that is, Array must have known constant size.\r |
| | 1310 | \r |
| | 1311 | @return The number of elements in Array. The result has type UINTN.\r |
| | 1312 | \r |
| | 1313 | **/\r |
| | 1314 | #define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))\r |
| | 1315 | \r |
| | 1316 | #endif\r |
| | 1317 | \r |
projects / mirror_edk2.git / blame_incremental