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