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