BaseTools/Source/C/Include/Common/BaseTypes.h

   1 /** @file
   2   Processor or Compiler specific defines for all supported processors.
   3
   4   This file is stand alone self consistent set of definitions.
   5
   6   Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>
   7   This program and the accompanying materials
   8   are licensed and made available under the terms and conditions of the BSD License
   9   which accompanies this distribution.  The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15   File Name:  BaseTypes.h
  16
  17 **/
  18
  19 #ifndef __BASE_TYPES_H__
  20 #define __BASE_TYPES_H__
  21
  22 //
  23 // Include processor specific binding
  24 //
  25 #include <ProcessorBind.h>
  26 #include <stdarg.h>
  27
  28 //
  29 // Modifiers to abstract standard types to aid in debug of problems
  30 //
  31 #define CONST     const
  32 #define STATIC    static
  33 #define VOID      void
  34
  35 //
  36 // Modifiers for Data Types used to self document code.
  37 // This concept is borrowed for UEFI specification.
  38 //
  39 #ifndef IN
  40 //
  41 // Some other environments use this construct, so #ifndef to prevent
  42 // multiple definition.
  43 //
  44 #define IN
  45 #define OUT
  46 #define OPTIONAL
  47 #endif
  48
  49 //
  50 // Constants. They may exist in other build structures, so #ifndef them.
  51 //
  52 #ifndef TRUE
  53 //
  54 // BugBug: UEFI specification claims 1 and 0. We are concerned about the
  55 //  complier portability so we did it this way.
  56 //
  57 #define TRUE  ((BOOLEAN)(1==1))
  58 #endif
  59
  60 #ifndef FALSE
  61 #define FALSE ((BOOLEAN)(0==1))
  62 #endif
  63
  64 #ifndef NULL
  65 #define NULL  ((VOID *) 0)
  66 #endif
  67
  68 //
  69 //  Support for variable length argument lists using the ANSI standard.
  70 //
  71 //  Since we are using the ANSI standard we used the standard naming and
  72 //  did not follow the coding convention
  73 //
  74 //  VA_LIST  - typedef for argument list.
  75 //  VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
  76 //  VA_END (VA_LIST Marker) - Clear Marker
  77 //  VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from
  78 //    the ... list. You must know the size and pass it in this macro.
  79 //
  80 //  example:
  81 //
  82 //  UINTN
  83 //  ExampleVarArg (
  84 //    IN UINTN  NumberOfArgs,
  85 //    ...
  86 //    )
  87 //  {
  88 //    VA_LIST Marker;
  89 //    UINTN   Index;
  90 //    UINTN   Result;
  91 //
  92 //    //
  93 //    // Initialize the Marker
  94 //    //
  95 //    VA_START (Marker, NumberOfArgs);
  96 //    for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
  97 //      //
  98 //      // The ... list is a series of UINTN values, so average them up.
  99 //      //
 100 //      Result += VA_ARG (Marker, UINTN);
 101 //    }
 102 //
 103 //    VA_END (Marker);
 104 //    return Result
 105 //  }
 106 //
 107
 108 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
 109
 110 //
 111 // Also support coding convention rules for var arg macros
 112 //
 113 #ifndef VA_START
 114
 115 // typedef CHAR8 *VA_LIST;
 116 // #define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))
 117 // #define VA_ARG(ap, t)   (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))
 118 // #define VA_END(ap)      (ap = (VA_LIST) 0)
 119 // Use the native arguments for tools.
 120 #define VA_START va_start
 121 #define VA_ARG   va_arg
 122 #define VA_END   va_end
 123 #define VA_LIST  va_list
 124
 125 #endif
 126
 127 //
 128 // Macro that returns the byte offset of a field in a data structure.
 129 //
 130 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
 131
 132 ///
 133 ///  _CR - returns a pointer to the structure
 134 ///      from one of it's elements.
 135 ///
 136 #define _CR(Record, TYPE, Field)  ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
 137
 138 ///
 139 ///  ALIGN_POINTER - aligns a pointer to the lowest boundary
 140 ///
 141 #define ALIGN_POINTER(p, s) ((VOID *) ((UINTN)(p) + (((s) - ((UINTN) (p))) & ((s) - 1))))
 142
 143 ///
 144 ///  ALIGN_VARIABLE - aligns a variable up to the next natural boundary for int size of a processor
 145 ///
 146 #define ALIGN_VARIABLE(Value, Adjustment) \
 147   Adjustment = 0U; \
 148   if ((UINTN) (Value) % sizeof (UINTN)) { \
 149     (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \
 150   } \
 151   (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))
 152
 153 //
 154 // Return the maximum of two operands.
 155 // This macro returns the maximum of two operand specified by a and b.
 156 // Both a and b must be the same numerical types, signed or unsigned.
 157 //
 158 #define MAX(a, b)                       \
 159   (((a) > (b)) ? (a) : (b))
 160
 161
 162 //
 163 // Return the minimum of two operands.
 164 // This macro returns the minimal of two operand specified by a and b.
 165 // Both a and b must be the same numerical types, signed or unsigned.
 166 //
 167 #define MIN(a, b)                       \
 168   (((a) < (b)) ? (a) : (b))
 169
 170
 171 //
 172 // EFI Error Codes common to all execution phases
 173 //
 174
 175 typedef INTN RETURN_STATUS;
 176
 177 ///
 178 /// Set the upper bit to indicate EFI Error.
 179 ///
 180 #define ENCODE_ERROR(a)              (MAX_BIT | (a))
 181
 182 #define ENCODE_WARNING(a)            (a)
 183 #define RETURN_ERROR(a)              ((a) < 0)
 184
 185 #define RETURN_SUCCESS               0
 186 #define RETURN_LOAD_ERROR            ENCODE_ERROR (1)
 187 #define RETURN_INVALID_PARAMETER     ENCODE_ERROR (2)
 188 #define RETURN_UNSUPPORTED           ENCODE_ERROR (3)
 189 #define RETURN_BAD_BUFFER_SIZE       ENCODE_ERROR (4)
 190 #define RETURN_BUFFER_TOO_SMALL      ENCODE_ERROR (5)
 191 #define RETURN_NOT_READY             ENCODE_ERROR (6)
 192 #define RETURN_DEVICE_ERROR          ENCODE_ERROR (7)
 193 #define RETURN_WRITE_PROTECTED       ENCODE_ERROR (8)
 194 #define RETURN_OUT_OF_RESOURCES      ENCODE_ERROR (9)
 195 #define RETURN_VOLUME_CORRUPTED      ENCODE_ERROR (10)
 196 #define RETURN_VOLUME_FULL           ENCODE_ERROR (11)
 197 #define RETURN_NO_MEDIA              ENCODE_ERROR (12)
 198 #define RETURN_MEDIA_CHANGED         ENCODE_ERROR (13)
 199 #define RETURN_NOT_FOUND             ENCODE_ERROR (14)
 200 #define RETURN_ACCESS_DENIED         ENCODE_ERROR (15)
 201 #define RETURN_NO_RESPONSE           ENCODE_ERROR (16)
 202 #define RETURN_NO_MAPPING            ENCODE_ERROR (17)
 203 #define RETURN_TIMEOUT               ENCODE_ERROR (18)
 204 #define RETURN_NOT_STARTED           ENCODE_ERROR (19)
 205 #define RETURN_ALREADY_STARTED       ENCODE_ERROR (20)
 206 #define RETURN_ABORTED               ENCODE_ERROR (21)
 207 #define RETURN_ICMP_ERROR            ENCODE_ERROR (22)
 208 #define RETURN_TFTP_ERROR            ENCODE_ERROR (23)
 209 #define RETURN_PROTOCOL_ERROR        ENCODE_ERROR (24)
 210 #define RETURN_INCOMPATIBLE_VERSION  ENCODE_ERROR (25)
 211 #define RETURN_SECURITY_VIOLATION    ENCODE_ERROR (26)
 212 #define RETURN_CRC_ERROR             ENCODE_ERROR (27)
 213 #define RETURN_END_OF_MEDIA          ENCODE_ERROR (28)
 214 #define RETURN_END_OF_FILE           ENCODE_ERROR (31)
 215
 216 #define RETURN_WARN_UNKNOWN_GLYPH    ENCODE_WARNING (1)
 217 #define RETURN_WARN_DELETE_FAILURE   ENCODE_WARNING (2)
 218 #define RETURN_WARN_WRITE_FAILURE    ENCODE_WARNING (3)
 219 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
 220
 221 typedef UINT64 PHYSICAL_ADDRESS;
 222
 223 #define  BIT0     0x00000001
 224 #define  BIT1     0x00000002
 225 #define  BIT2     0x00000004
 226 #define  BIT3     0x00000008
 227 #define  BIT4     0x00000010
 228 #define  BIT5     0x00000020
 229 #define  BIT6     0x00000040
 230 #define  BIT7     0x00000080
 231 #define  BIT8     0x00000100
 232 #define  BIT9     0x00000200
 233 #define  BIT10    0x00000400
 234 #define  BIT11    0x00000800
 235 #define  BIT12    0x00001000
 236 #define  BIT13    0x00002000
 237 #define  BIT14    0x00004000
 238 #define  BIT15    0x00008000
 239 #define  BIT16    0x00010000
 240 #define  BIT17    0x00020000
 241 #define  BIT18    0x00040000
 242 #define  BIT19    0x00080000
 243 #define  BIT20    0x00100000
 244 #define  BIT21    0x00200000
 245 #define  BIT22    0x00400000
 246 #define  BIT23    0x00800000
 247 #define  BIT24    0x01000000
 248 #define  BIT25    0x02000000
 249 #define  BIT26    0x04000000
 250 #define  BIT27    0x08000000
 251 #define  BIT28    0x10000000
 252 #define  BIT29    0x20000000
 253 #define  BIT30    0x40000000
 254 #define  BIT31    0x80000000
 255 #define  BIT32    0x0000000100000000ULL
 256 #define  BIT33    0x0000000200000000ULL
 257 #define  BIT34    0x0000000400000000ULL
 258 #define  BIT35    0x0000000800000000ULL
 259 #define  BIT36    0x0000001000000000ULL
 260 #define  BIT37    0x0000002000000000ULL
 261 #define  BIT38    0x0000004000000000ULL
 262 #define  BIT39    0x0000008000000000ULL
 263 #define  BIT40    0x0000010000000000ULL
 264 #define  BIT41    0x0000020000000000ULL
 265 #define  BIT42    0x0000040000000000ULL
 266 #define  BIT43    0x0000080000000000ULL
 267 #define  BIT44    0x0000100000000000ULL
 268 #define  BIT45    0x0000200000000000ULL
 269 #define  BIT46    0x0000400000000000ULL
 270 #define  BIT47    0x0000800000000000ULL
 271 #define  BIT48    0x0001000000000000ULL
 272 #define  BIT49    0x0002000000000000ULL
 273 #define  BIT50    0x0004000000000000ULL
 274 #define  BIT51    0x0008000000000000ULL
 275 #define  BIT52    0x0010000000000000ULL
 276 #define  BIT53    0x0020000000000000ULL
 277 #define  BIT54    0x0040000000000000ULL
 278 #define  BIT55    0x0080000000000000ULL
 279 #define  BIT56    0x0100000000000000ULL
 280 #define  BIT57    0x0200000000000000ULL
 281 #define  BIT58    0x0400000000000000ULL
 282 #define  BIT59    0x0800000000000000ULL
 283 #define  BIT60    0x1000000000000000ULL
 284 #define  BIT61    0x2000000000000000ULL
 285 #define  BIT62    0x4000000000000000ULL
 286 #define  BIT63    0x8000000000000000ULL
 287
 288 #endif