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