MdePkg/Include/Base.h

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