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 - 2012, 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 // 26 // Include processor specific binding 27 // 28 #include <ProcessorBind.h> 29 30 /** 31 Verifies the storage size of a given data type. 32 33 This macro generates a divide by zero error or a zero size array declaration in 34 the preprocessor if the size is incorrect. These are declared as "extern" so 35 the space for these arrays will not be in the modules. 36 37 @param TYPE The date type to determine the size of. 38 @param Size The expected size for the TYPE. 39 40 **/ 41 #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))] 42 43 // 44 // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with 45 // Section 2.3.1 of the UEFI 2.3 Specification. 46 // 47 VERIFY_SIZE_OF(BOOLEAN, 1); 48 VERIFY_SIZE_OF(INT8, 1); 49 VERIFY_SIZE_OF(UINT8, 1); 50 VERIFY_SIZE_OF(INT16, 2); 51 VERIFY_SIZE_OF(UINT16, 2); 52 VERIFY_SIZE_OF(INT32, 4); 53 VERIFY_SIZE_OF(UINT32, 4); 54 VERIFY_SIZE_OF(INT64, 8); 55 VERIFY_SIZE_OF(UINT64, 8); 56 VERIFY_SIZE_OF(CHAR8, 1); 57 VERIFY_SIZE_OF(CHAR16, 2); 58 59 // 60 // The Microsoft* C compiler can removed references to unreferenced data items 61 // if the /OPT:REF linker option is used. We defined a macro as this is a 62 // a non standard extension 63 // 64 #if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC) 65 /// 66 /// Remove global variable from the linked image if there are no references to 67 /// it after all compiler and linker optimizations have been performed. 68 /// 69 /// 70 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany) 71 #else 72 /// 73 /// Remove the global variable from the linked image if there are no references 74 /// to it after all compiler and linker optimizations have been performed. 75 /// 76 /// 77 #define GLOBAL_REMOVE_IF_UNREFERENCED 78 #endif 79 80 // 81 // For symbol name in GNU assembly code, an extra "_" is necessary 82 // 83 #if defined(__GNUC__) 84 /// 85 /// Private worker functions for ASM_PFX() 86 /// 87 #define _CONCATENATE(a, b) __CONCATENATE(a, b) 88 #define __CONCATENATE(a, b) a ## b 89 90 /// 91 /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix 92 /// on symbols in assembly language. 93 /// 94 #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name) 95 #endif 96 97 #if __APPLE__ 98 // 99 // Apple extension that is used by the linker to optimize code size 100 // with assembly functions. Put at the end of your .S files 101 // 102 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols 103 #else 104 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED 105 #endif 106 107 #ifdef __CC_ARM 108 // 109 // Older RVCT ARM compilers don't fully support #pragma pack and require __packed 110 // as a prefix for the structure. 111 // 112 #define PACKED __packed 113 #else 114 #define PACKED 115 #endif 116 117 #if 0 118 /// 119 /// 128 bit buffer containing a unique identifier value. 120 /// Unless otherwise specified, aligned on a 64 bit boundary. 121 /// 122 typedef struct { 123 UINT32 Data1; 124 UINT16 Data2; 125 UINT16 Data3; 126 UINT8 Data4[8]; 127 } GUID; 128 129 // 130 // 8-bytes unsigned value that represents a physical system address. 131 // 132 typedef UINT64 PHYSICAL_ADDRESS; 133 134 /// 135 /// LIST_ENTRY structure definition. 136 /// 137 typedef struct _LIST_ENTRY LIST_ENTRY; 138 139 /// 140 /// _LIST_ENTRY structure definition. 141 /// 142 struct _LIST_ENTRY { 143 LIST_ENTRY *ForwardLink; 144 LIST_ENTRY *BackLink; 145 }; 146 147 // 148 // Modifiers to abstract standard types to aid in debug of problems 149 // 150 151 /// 152 /// Datum is read-only. 153 /// 154 #define CONST const 155 156 /// 157 /// Datum is scoped to the current file or function. 158 /// 159 #define STATIC static 160 161 /// 162 /// Undeclared type. 163 /// 164 #define VOID void 165 166 // 167 // Modifiers for Data Types used to self document code. 168 // This concept is borrowed for UEFI specification. 169 // 170 171 /// 172 /// Datum is passed to the function. 173 /// 174 #define IN 175 176 /// 177 /// Datum is returned from the function. 178 /// 179 #define OUT 180 181 /// 182 /// Passing the datum to the function is optional, and a NULL 183 /// is passed if the value is not supplied. 184 /// 185 #define OPTIONAL 186 187 // 188 // UEFI specification claims 1 and 0. We are concerned about the 189 // complier portability so we did it this way. 190 // 191 192 /// 193 /// Boolean true value. UEFI Specification defines this value to be 1, 194 /// but this form is more portable. 195 /// 196 #define TRUE ((BOOLEAN)(1==1)) 197 198 /// 199 /// Boolean false value. UEFI Specification defines this value to be 0, 200 /// but this form is more portable. 201 /// 202 #define FALSE ((BOOLEAN)(0==1)) 203 204 /// 205 /// NULL pointer (VOID *) 206 /// 207 #define NULL ((VOID *) 0) 208 #endif 209 210 #define BIT0 0x00000001 211 #define BIT1 0x00000002 212 #define BIT2 0x00000004 213 #define BIT3 0x00000008 214 #define BIT4 0x00000010 215 #define BIT5 0x00000020 216 #define BIT6 0x00000040 217 #define BIT7 0x00000080 218 #define BIT8 0x00000100 219 #define BIT9 0x00000200 220 #define BIT10 0x00000400 221 #define BIT11 0x00000800 222 #define BIT12 0x00001000 223 #define BIT13 0x00002000 224 #define BIT14 0x00004000 225 #define BIT15 0x00008000 226 #define BIT16 0x00010000 227 #define BIT17 0x00020000 228 #define BIT18 0x00040000 229 #define BIT19 0x00080000 230 #define BIT20 0x00100000 231 #define BIT21 0x00200000 232 #define BIT22 0x00400000 233 #define BIT23 0x00800000 234 #define BIT24 0x01000000 235 #define BIT25 0x02000000 236 #define BIT26 0x04000000 237 #define BIT27 0x08000000 238 #define BIT28 0x10000000 239 #define BIT29 0x20000000 240 #define BIT30 0x40000000 241 #define BIT31 0x80000000 242 #define BIT32 0x0000000100000000ULL 243 #define BIT33 0x0000000200000000ULL 244 #define BIT34 0x0000000400000000ULL 245 #define BIT35 0x0000000800000000ULL 246 #define BIT36 0x0000001000000000ULL 247 #define BIT37 0x0000002000000000ULL 248 #define BIT38 0x0000004000000000ULL 249 #define BIT39 0x0000008000000000ULL 250 #define BIT40 0x0000010000000000ULL 251 #define BIT41 0x0000020000000000ULL 252 #define BIT42 0x0000040000000000ULL 253 #define BIT43 0x0000080000000000ULL 254 #define BIT44 0x0000100000000000ULL 255 #define BIT45 0x0000200000000000ULL 256 #define BIT46 0x0000400000000000ULL 257 #define BIT47 0x0000800000000000ULL 258 #define BIT48 0x0001000000000000ULL 259 #define BIT49 0x0002000000000000ULL 260 #define BIT50 0x0004000000000000ULL 261 #define BIT51 0x0008000000000000ULL 262 #define BIT52 0x0010000000000000ULL 263 #define BIT53 0x0020000000000000ULL 264 #define BIT54 0x0040000000000000ULL 265 #define BIT55 0x0080000000000000ULL 266 #define BIT56 0x0100000000000000ULL 267 #define BIT57 0x0200000000000000ULL 268 #define BIT58 0x0400000000000000ULL 269 #define BIT59 0x0800000000000000ULL 270 #define BIT60 0x1000000000000000ULL 271 #define BIT61 0x2000000000000000ULL 272 #define BIT62 0x4000000000000000ULL 273 #define BIT63 0x8000000000000000ULL 274 275 #define SIZE_1KB 0x00000400 276 #define SIZE_2KB 0x00000800 277 #define SIZE_4KB 0x00001000 278 #define SIZE_8KB 0x00002000 279 #define SIZE_16KB 0x00004000 280 #define SIZE_32KB 0x00008000 281 #define SIZE_64KB 0x00010000 282 #define SIZE_128KB 0x00020000 283 #define SIZE_256KB 0x00040000 284 #define SIZE_512KB 0x00080000 285 #define SIZE_1MB 0x00100000 286 #define SIZE_2MB 0x00200000 287 #define SIZE_4MB 0x00400000 288 #define SIZE_8MB 0x00800000 289 #define SIZE_16MB 0x01000000 290 #define SIZE_32MB 0x02000000 291 #define SIZE_64MB 0x04000000 292 #define SIZE_128MB 0x08000000 293 #define SIZE_256MB 0x10000000 294 #define SIZE_512MB 0x20000000 295 #define SIZE_1GB 0x40000000 296 #define SIZE_2GB 0x80000000 297 #define SIZE_4GB 0x0000000100000000ULL 298 #define SIZE_8GB 0x0000000200000000ULL 299 #define SIZE_16GB 0x0000000400000000ULL 300 #define SIZE_32GB 0x0000000800000000ULL 301 #define SIZE_64GB 0x0000001000000000ULL 302 #define SIZE_128GB 0x0000002000000000ULL 303 #define SIZE_256GB 0x0000004000000000ULL 304 #define SIZE_512GB 0x0000008000000000ULL 305 #define SIZE_1TB 0x0000010000000000ULL 306 #define SIZE_2TB 0x0000020000000000ULL 307 #define SIZE_4TB 0x0000040000000000ULL 308 #define SIZE_8TB 0x0000080000000000ULL 309 #define SIZE_16TB 0x0000100000000000ULL 310 #define SIZE_32TB 0x0000200000000000ULL 311 #define SIZE_64TB 0x0000400000000000ULL 312 #define SIZE_128TB 0x0000800000000000ULL 313 #define SIZE_256TB 0x0001000000000000ULL 314 #define SIZE_512TB 0x0002000000000000ULL 315 #define SIZE_1PB 0x0004000000000000ULL 316 #define SIZE_2PB 0x0008000000000000ULL 317 #define SIZE_4PB 0x0010000000000000ULL 318 #define SIZE_8PB 0x0020000000000000ULL 319 #define SIZE_16PB 0x0040000000000000ULL 320 #define SIZE_32PB 0x0080000000000000ULL 321 #define SIZE_64PB 0x0100000000000000ULL 322 #define SIZE_128PB 0x0200000000000000ULL 323 #define SIZE_256PB 0x0400000000000000ULL 324 #define SIZE_512PB 0x0800000000000000ULL 325 #define SIZE_1EB 0x1000000000000000ULL 326 #define SIZE_2EB 0x2000000000000000ULL 327 #define SIZE_4EB 0x4000000000000000ULL 328 #define SIZE_8EB 0x8000000000000000ULL 329 330 #define BASE_1KB 0x00000400 331 #define BASE_2KB 0x00000800 332 #define BASE_4KB 0x00001000 333 #define BASE_8KB 0x00002000 334 #define BASE_16KB 0x00004000 335 #define BASE_32KB 0x00008000 336 #define BASE_64KB 0x00010000 337 #define BASE_128KB 0x00020000 338 #define BASE_256KB 0x00040000 339 #define BASE_512KB 0x00080000 340 #define BASE_1MB 0x00100000 341 #define BASE_2MB 0x00200000 342 #define BASE_4MB 0x00400000 343 #define BASE_8MB 0x00800000 344 #define BASE_16MB 0x01000000 345 #define BASE_32MB 0x02000000 346 #define BASE_64MB 0x04000000 347 #define BASE_128MB 0x08000000 348 #define BASE_256MB 0x10000000 349 #define BASE_512MB 0x20000000 350 #define BASE_1GB 0x40000000 351 #define BASE_2GB 0x80000000 352 #define BASE_4GB 0x0000000100000000ULL 353 #define BASE_8GB 0x0000000200000000ULL 354 #define BASE_16GB 0x0000000400000000ULL 355 #define BASE_32GB 0x0000000800000000ULL 356 #define BASE_64GB 0x0000001000000000ULL 357 #define BASE_128GB 0x0000002000000000ULL 358 #define BASE_256GB 0x0000004000000000ULL 359 #define BASE_512GB 0x0000008000000000ULL 360 #define BASE_1TB 0x0000010000000000ULL 361 #define BASE_2TB 0x0000020000000000ULL 362 #define BASE_4TB 0x0000040000000000ULL 363 #define BASE_8TB 0x0000080000000000ULL 364 #define BASE_16TB 0x0000100000000000ULL 365 #define BASE_32TB 0x0000200000000000ULL 366 #define BASE_64TB 0x0000400000000000ULL 367 #define BASE_128TB 0x0000800000000000ULL 368 #define BASE_256TB 0x0001000000000000ULL 369 #define BASE_512TB 0x0002000000000000ULL 370 #define BASE_1PB 0x0004000000000000ULL 371 #define BASE_2PB 0x0008000000000000ULL 372 #define BASE_4PB 0x0010000000000000ULL 373 #define BASE_8PB 0x0020000000000000ULL 374 #define BASE_16PB 0x0040000000000000ULL 375 #define BASE_32PB 0x0080000000000000ULL 376 #define BASE_64PB 0x0100000000000000ULL 377 #define BASE_128PB 0x0200000000000000ULL 378 #define BASE_256PB 0x0400000000000000ULL 379 #define BASE_512PB 0x0800000000000000ULL 380 #define BASE_1EB 0x1000000000000000ULL 381 #define BASE_2EB 0x2000000000000000ULL 382 #define BASE_4EB 0x4000000000000000ULL 383 #define BASE_8EB 0x8000000000000000ULL 384 385 // 386 // Support for variable length argument lists using the ANSI standard. 387 // 388 // Since we are using the ANSI standard we used the standard naming and 389 // did not follow the coding convention 390 // 391 // VA_LIST - typedef for argument list. 392 // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use. 393 // VA_END (VA_LIST Marker) - Clear Marker 394 // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from 395 // the ... list. You must know the size and pass it in this macro. 396 // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start. 397 // 398 // example: 399 // 400 // UINTN 401 // ExampleVarArg ( 402 // IN UINTN NumberOfArgs, 403 // ... 404 // ) 405 // { 406 // VA_LIST Marker; 407 // UINTN Index; 408 // UINTN Result; 409 // 410 // // 411 // // Initialize the Marker 412 // // 413 // VA_START (Marker, NumberOfArgs); 414 // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) { 415 // // 416 // // The ... list is a series of UINTN values, so average them up. 417 // // 418 // Result += VA_ARG (Marker, UINTN); 419 // } 420 // 421 // VA_END (Marker); 422 // return Result 423 // } 424 // 425 426 /** 427 Return the size of argument that has been aligned to sizeof (UINTN). 428 429 @param n The parameter size to be aligned. 430 431 @return The aligned size. 432 **/ 433 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1)) 434 435 #if defined(__CC_ARM) 436 // 437 // RVCT ARM variable argument list support. 438 // 439 440 /// 441 /// Variable used to traverse the list of arguments. This type can vary by 442 /// implementation and could be an array or structure. 443 /// 444 #ifdef __APCS_ADSABI 445 typedef int *va_list[1]; 446 #define VA_LIST va_list 447 #else 448 typedef struct __va_list { void *__ap; } va_list; 449 #define VA_LIST va_list 450 #endif 451 452 #define VA_START(Marker, Parameter) __va_start(Marker, Parameter) 453 454 #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE) 455 456 #define VA_END(Marker) ((void)0) 457 458 #define VA_COPY(Dest, Start) __va_copy (Dest, Start) 459 460 #elif defined(__GNUC__) && !defined(NO_BUILTIN_VA_FUNCS) 461 // 462 // Use GCC built-in macros for variable argument lists. 463 // 464 465 /// 466 /// Variable used to traverse the list of arguments. This type can vary by 467 /// implementation and could be an array or structure. 468 /// 469 typedef __builtin_va_list VA_LIST; 470 471 #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter) 472 473 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE))) 474 475 #define VA_END(Marker) __builtin_va_end (Marker) 476 477 #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start) 478 479 #else 480 /// 481 /// Variable used to traverse the list of arguments. This type can vary by 482 /// implementation and could be an array or structure. 483 /// 484 typedef CHAR8 *VA_LIST; 485 486 /** 487 Retrieves a pointer to the beginning of a variable argument list, based on 488 the name of the parameter that immediately precedes the variable argument list. 489 490 This function initializes Marker to point to the beginning of the variable 491 argument list that immediately follows Parameter. The method for computing the 492 pointer to the next argument in the argument list is CPU-specific following the 493 EFIAPI ABI. 494 495 @param Marker The VA_LIST used to traverse the list of arguments. 496 @param Parameter The name of the parameter that immediately precedes 497 the variable argument list. 498 499 @return A pointer to the beginning of a variable argument list. 500 501 **/ 502 #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter))) 503 504 /** 505 Returns an argument of a specified type from a variable argument list and updates 506 the pointer to the variable argument list to point to the next argument. 507 508 This function returns an argument of the type specified by TYPE from the beginning 509 of the variable argument list specified by Marker. Marker is then updated to point 510 to the next argument in the variable argument list. The method for computing the 511 pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI. 512 513 @param Marker VA_LIST used to traverse the list of arguments. 514 @param TYPE The type of argument to retrieve from the beginning 515 of the variable argument list. 516 517 @return An argument of the type specified by TYPE. 518 519 **/ 520 #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE))) 521 522 /** 523 Terminates the use of a variable argument list. 524 525 This function initializes Marker so it can no longer be used with VA_ARG(). 526 After this macro is used, the only way to access the variable argument list is 527 by using VA_START() again. 528 529 @param Marker VA_LIST used to traverse the list of arguments. 530 531 **/ 532 #define VA_END(Marker) (Marker = (VA_LIST) 0) 533 534 /** 535 Initializes a VA_LIST as a copy of an existing VA_LIST. 536 537 This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest 538 followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach 539 the present state of Start. 540 541 @param Dest VA_LIST used to traverse the list of arguments. 542 @param Start VA_LIST used to traverse the list of arguments. 543 544 **/ 545 #define VA_COPY(Dest, Start) ((void)((Dest) = (Start))) 546 547 #endif 548 549 /// 550 /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *. 551 /// 552 typedef UINTN *BASE_LIST; 553 554 /** 555 Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary. 556 557 @param TYPE The date type to determine the size of. 558 559 @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary. 560 **/ 561 #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN)) 562 563 /** 564 Returns an argument of a specified type from a variable argument list and updates 565 the pointer to the variable argument list to point to the next argument. 566 567 This function returns an argument of the type specified by TYPE from the beginning 568 of the variable argument list specified by Marker. Marker is then updated to point 569 to the next argument in the variable argument list. The method for computing the 570 pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI. 571 572 @param Marker The pointer to the beginning of a variable argument list. 573 @param TYPE The type of argument to retrieve from the beginning 574 of the variable argument list. 575 576 @return An argument of the type specified by TYPE. 577 578 **/ 579 #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE))) 580 581 /** 582 The macro that returns the byte offset of a field in a data structure. 583 584 This function returns the offset, in bytes, of field specified by Field from the 585 beginning of the data structure specified by TYPE. If TYPE does not contain Field, 586 the module will not compile. 587 588 @param TYPE The name of the data structure that contains the field specified by Field. 589 @param Field The name of the field in the data structure. 590 591 @return Offset, in bytes, of field. 592 593 **/ 594 #ifdef __GNUC__ 595 #if __GNUC__ >= 4 596 #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field)) 597 #endif 598 #endif 599 600 #ifndef OFFSET_OF 601 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field)) 602 #endif 603 604 /** 605 Macro that returns a pointer to the data structure that contains a specified field of 606 that data structure. This is a lightweight method to hide information by placing a 607 public data structure inside a larger private data structure and using a pointer to 608 the public data structure to retrieve a pointer to the private data structure. 609 610 This function computes the offset, in bytes, of field specified by Field from the beginning 611 of the data structure specified by TYPE. This offset is subtracted from Record, and is 612 used to return a pointer to a data structure of the type specified by TYPE. If the data type 613 specified by TYPE does not contain the field specified by Field, then the module will not compile. 614 615 @param Record Pointer to the field specified by Field within a data structure of type TYPE. 616 @param TYPE The name of the data structure type to return. This data structure must 617 contain the field specified by Field. 618 @param Field The name of the field in the data structure specified by TYPE to which Record points. 619 620 @return A pointer to the structure from one of it's elements. 621 622 **/ 623 #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field))) 624 625 /** 626 Rounds a value up to the next boundary using a specified alignment. 627 628 This function rounds Value up to the next boundary using the specified Alignment. 629 This aligned value is returned. 630 631 @param Value The value to round up. 632 @param Alignment The alignment boundary used to return the aligned value. 633 634 @return A value up to the next boundary. 635 636 **/ 637 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1))) 638 639 /** 640 Adjust a pointer by adding the minimum offset required for it to be aligned on 641 a specified alignment boundary. 642 643 This function rounds the pointer specified by Pointer to the next alignment boundary 644 specified by Alignment. The pointer to the aligned address is returned. 645 646 @param Pointer The pointer to round up. 647 @param Alignment The alignment boundary to use to return an aligned pointer. 648 649 @return Pointer to the aligned address. 650 651 **/ 652 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment)))) 653 654 /** 655 Rounds a value up to the next natural boundary for the current CPU. 656 This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs. 657 658 This function rounds the value specified by Value up to the next natural boundary for the 659 current CPU. This rounded value is returned. 660 661 @param Value The value to round up. 662 663 @return Rounded value specified by Value. 664 665 **/ 666 #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN)) 667 668 669 /** 670 Return the maximum of two operands. 671 672 This macro returns the maximum of two operand specified by a and b. 673 Both a and b must be the same numerical types, signed or unsigned. 674 675 @param a The first operand with any numerical type. 676 @param b The second operand. Can be any numerical type as long as is 677 the same type as a. 678 679 @return Maximum of two operands. 680 681 **/ 682 #define MAX(a, b) \ 683 (((a) > (b)) ? (a) : (b)) 684 685 /** 686 Return the minimum of two operands. 687 688 This macro returns the minimal of two operand specified by a and b. 689 Both a and b must be the same numerical types, signed or unsigned. 690 691 @param a The first operand with any numerical type. 692 @param b The second operand. It should be the same any numerical type with a. 693 694 @return Minimum of two operands. 695 696 **/ 697 #define MIN(a, b) \ 698 (((a) < (b)) ? (a) : (b)) 699 700 /** 701 Return the absolute value of a signed operand. 702 703 This macro returns the absolute value of the signed operand specified by a. 704 705 @param a The signed operand. 706 707 @return The absolute value of the signed operand. 708 709 **/ 710 #define ABS(a) \ 711 (((a) < 0) ? (-(a)) : (a)) 712 713 // 714 // Status codes common to all execution phases 715 // 716 typedef UINTN RETURN_STATUS; 717 718 /** 719 Produces a RETURN_STATUS code with the highest bit set. 720 721 @param StatusCode The status code value to convert into a warning code. 722 StatusCode must be in the range 0x00000000..0x7FFFFFFF. 723 724 @return The value specified by StatusCode with the highest bit set. 725 726 **/ 727 #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode))) 728 729 /** 730 Produces a RETURN_STATUS code with the highest bit clear. 731 732 @param StatusCode The status code value to convert into a warning code. 733 StatusCode must be in the range 0x00000000..0x7FFFFFFF. 734 735 @return The value specified by StatusCode with the highest bit clear. 736 737 **/ 738 #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode)) 739 740 /** 741 Returns TRUE if a specified RETURN_STATUS code is an error code. 742 743 This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned. 744 745 @param StatusCode The status code value to evaluate. 746 747 @retval TRUE The high bit of StatusCode is set. 748 @retval FALSE The high bit of StatusCode is clear. 749 750 **/ 751 #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0) 752 753 /// 754 /// The operation completed successfully. 755 /// 756 #define RETURN_SUCCESS 0 757 758 /// 759 /// The image failed to load. 760 /// 761 #define RETURN_LOAD_ERROR ENCODE_ERROR (1) 762 763 /// 764 /// The parameter was incorrect. 765 /// 766 #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2) 767 768 /// 769 /// The operation is not supported. 770 /// 771 #define RETURN_UNSUPPORTED ENCODE_ERROR (3) 772 773 /// 774 /// The buffer was not the proper size for the request. 775 /// 776 #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4) 777 778 /// 779 /// The buffer was not large enough to hold the requested data. 780 /// The required buffer size is returned in the appropriate 781 /// parameter when this error occurs. 782 /// 783 #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5) 784 785 /// 786 /// There is no data pending upon return. 787 /// 788 #define RETURN_NOT_READY ENCODE_ERROR (6) 789 790 /// 791 /// The physical device reported an error while attempting the 792 /// operation. 793 /// 794 #define RETURN_DEVICE_ERROR ENCODE_ERROR (7) 795 796 /// 797 /// The device can not be written to. 798 /// 799 #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8) 800 801 /// 802 /// The resource has run out. 803 /// 804 #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9) 805 806 /// 807 /// An inconsistency was detected on the file system causing the 808 /// operation to fail. 809 /// 810 #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10) 811 812 /// 813 /// There is no more space on the file system. 814 /// 815 #define RETURN_VOLUME_FULL ENCODE_ERROR (11) 816 817 /// 818 /// The device does not contain any medium to perform the 819 /// operation. 820 /// 821 #define RETURN_NO_MEDIA ENCODE_ERROR (12) 822 823 /// 824 /// The medium in the device has changed since the last 825 /// access. 826 /// 827 #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13) 828 829 /// 830 /// The item was not found. 831 /// 832 #define RETURN_NOT_FOUND ENCODE_ERROR (14) 833 834 /// 835 /// Access was denied. 836 /// 837 #define RETURN_ACCESS_DENIED ENCODE_ERROR (15) 838 839 /// 840 /// The server was not found or did not respond to the request. 841 /// 842 #define RETURN_NO_RESPONSE ENCODE_ERROR (16) 843 844 /// 845 /// A mapping to the device does not exist. 846 /// 847 #define RETURN_NO_MAPPING ENCODE_ERROR (17) 848 849 /// 850 /// A timeout time expired. 851 /// 852 #define RETURN_TIMEOUT ENCODE_ERROR (18) 853 854 /// 855 /// The protocol has not been started. 856 /// 857 #define RETURN_NOT_STARTED ENCODE_ERROR (19) 858 859 /// 860 /// The protocol has already been started. 861 /// 862 #define RETURN_ALREADY_STARTED ENCODE_ERROR (20) 863 864 /// 865 /// The operation was aborted. 866 /// 867 #define RETURN_ABORTED ENCODE_ERROR (21) 868 869 /// 870 /// An ICMP error occurred during the network operation. 871 /// 872 #define RETURN_ICMP_ERROR ENCODE_ERROR (22) 873 874 /// 875 /// A TFTP error occurred during the network operation. 876 /// 877 #define RETURN_TFTP_ERROR ENCODE_ERROR (23) 878 879 /// 880 /// A protocol error occurred during the network operation. 881 /// 882 #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24) 883 884 /// 885 /// A function encountered an internal version that was 886 /// incompatible with a version requested by the caller. 887 /// 888 #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25) 889 890 /// 891 /// The function was not performed due to a security violation. 892 /// 893 #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26) 894 895 /// 896 /// A CRC error was detected. 897 /// 898 #define RETURN_CRC_ERROR ENCODE_ERROR (27) 899 900 /// 901 /// The beginning or end of media was reached. 902 /// 903 #define RETURN_END_OF_MEDIA ENCODE_ERROR (28) 904 905 /// 906 /// The end of the file was reached. 907 /// 908 #define RETURN_END_OF_FILE ENCODE_ERROR (31) 909 910 /// 911 /// The language specified was invalid. 912 /// 913 #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32) 914 915 /// 916 /// The security status of the data is unknown or compromised 917 /// and the data must be updated or replaced to restore a valid 918 /// security status. 919 /// 920 #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33) 921 922 /// 923 /// The string contained one or more characters that 924 /// the device could not render and were skipped. 925 /// 926 #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1) 927 928 /// 929 /// The handle was closed, but the file was not deleted. 930 /// 931 #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2) 932 933 /// 934 /// The handle was closed, but the data to the file was not 935 /// flushed properly. 936 /// 937 #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3) 938 939 /// 940 /// The resulting buffer was too small, and the data was 941 /// truncated to the buffer size. 942 /// 943 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4) 944 945 /// 946 /// The data has not been updated within the timeframe set by 947 /// local policy for this type of data. 948 /// 949 #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5) 950 951 /** 952 Returns a 16-bit signature built from 2 ASCII characters. 953 954 This macro returns a 16-bit value built from the two ASCII characters specified 955 by A and B. 956 957 @param A The first ASCII character. 958 @param B The second ASCII character. 959 960 @return A 16-bit value built from the two ASCII characters specified by A and B. 961 962 **/ 963 #define SIGNATURE_16(A, B) ((A) | (B << 8)) 964 965 /** 966 Returns a 32-bit signature built from 4 ASCII characters. 967 968 This macro returns a 32-bit value built from the four ASCII characters specified 969 by A, B, C, and D. 970 971 @param A The first ASCII character. 972 @param B The second ASCII character. 973 @param C The third ASCII character. 974 @param D The fourth ASCII character. 975 976 @return A 32-bit value built from the two ASCII characters specified by A, B, 977 C and D. 978 979 **/ 980 #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16)) 981 982 /** 983 Returns a 64-bit signature built from 8 ASCII characters. 984 985 This macro returns a 64-bit value built from the eight ASCII characters specified 986 by A, B, C, D, E, F, G,and H. 987 988 @param A The first ASCII character. 989 @param B The second ASCII character. 990 @param C The third ASCII character. 991 @param D The fourth ASCII character. 992 @param E The fifth ASCII character. 993 @param F The sixth ASCII character. 994 @param G The seventh ASCII character. 995 @param H The eighth ASCII character. 996 997 @return A 64-bit value built from the two ASCII characters specified by A, B, 998 C, D, E, F, G and H. 999 1000 **/ 1001 #define SIGNATURE_64(A, B, C, D, E, F, G, H) \ 1002 (SIGNATURE_32(A, B, C, D) | ((UINT64) (SIGNATURE_32(E, F, G, H)) << 32)) 1003 1004 #endif 1005 1006