MdePkg/Include/Base.h

   1 /** @file
   2
   3   Root include file for Mde Package Base type modules
   4
   5   This is the include file for any module of type base. Base modules only use
   6   types defined via this include file and can be ported easily to any
   7   environment. There are a set of base libraries in the Mde Package that can
   8   be used to implement base modules.
   9
  10 Copyright (c) 2006 - 2007, Intel Corporation
  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 typedef struct {
  31   UINT32  Data1;
  32   UINT16  Data2;
  33   UINT16  Data3;
  34   UINT8   Data4[8];
  35 } GUID;
  36
  37 typedef UINT64 PHYSICAL_ADDRESS;
  38
  39 //
  40 // LIST_ENTRY definition
  41 //
  42 typedef struct _LIST_ENTRY LIST_ENTRY;
  43
  44 struct _LIST_ENTRY {
  45   LIST_ENTRY  *ForwardLink;
  46   LIST_ENTRY  *BackLink;
  47 };
  48
  49 //
  50 // Modifiers to absract standard types to aid in debug of problems
  51 //
  52 #define CONST     const
  53 #define STATIC    static
  54 #define VOID      void
  55
  56 //
  57 // Modifiers for Data Types used to self document code.
  58 // This concept is borrowed for UEFI specification.
  59 //
  60 #ifndef IN
  61 //
  62 // Some other envirnments use this construct, so #ifndef to prevent
  63 // mulitple definition.
  64 //
  65 #define IN
  66 #define OUT
  67 #define OPTIONAL
  68 #endif
  69
  70 //
  71 // Constants. They may exist in other build structures, so #ifndef them.
  72 //
  73 #ifndef TRUE
  74 //
  75 //  UEFI specification claims 1 and 0. We are concerned about the
  76 //  complier portability so we did it this way.
  77 //
  78 #define TRUE  ((BOOLEAN)(1==1))
  79 #endif
  80
  81 #ifndef FALSE
  82 #define FALSE ((BOOLEAN)(0==1))
  83 #endif
  84
  85 #ifndef NULL
  86 #define NULL  ((VOID *) 0)
  87 #endif
  88
  89 #define  BIT0     0x00000001
  90 #define  BIT1     0x00000002
  91 #define  BIT2     0x00000004
  92 #define  BIT3     0x00000008
  93 #define  BIT4     0x00000010
  94 #define  BIT5     0x00000020
  95 #define  BIT6     0x00000040
  96 #define  BIT7     0x00000080
  97 #define  BIT8     0x00000100
  98 #define  BIT9     0x00000200
  99 #define  BIT10    0x00000400
 100 #define  BIT11    0x00000800
 101 #define  BIT12    0x00001000
 102 #define  BIT13    0x00002000
 103 #define  BIT14    0x00004000
 104 #define  BIT15    0x00008000
 105 #define  BIT16    0x00010000
 106 #define  BIT17    0x00020000
 107 #define  BIT18    0x00040000
 108 #define  BIT19    0x00080000
 109 #define  BIT20    0x00100000
 110 #define  BIT21    0x00200000
 111 #define  BIT22    0x00400000
 112 #define  BIT23    0x00800000
 113 #define  BIT24    0x01000000
 114 #define  BIT25    0x02000000
 115 #define  BIT26    0x04000000
 116 #define  BIT27    0x08000000
 117 #define  BIT28    0x10000000
 118 #define  BIT29    0x20000000
 119 #define  BIT30    0x40000000
 120 #define  BIT31    0x80000000
 121 #define  BIT32    0x0000000100000000UL
 122 #define  BIT33    0x0000000200000000UL
 123 #define  BIT34    0x0000000400000000UL
 124 #define  BIT35    0x0000000800000000UL
 125 #define  BIT36    0x0000001000000000UL
 126 #define  BIT37    0x0000002000000000UL
 127 #define  BIT38    0x0000004000000000UL
 128 #define  BIT39    0x0000008000000000UL
 129 #define  BIT40    0x0000010000000000UL
 130 #define  BIT41    0x0000020000000000UL
 131 #define  BIT42    0x0000040000000000UL
 132 #define  BIT43    0x0000080000000000UL
 133 #define  BIT44    0x0000100000000000UL
 134 #define  BIT45    0x0000200000000000UL
 135 #define  BIT46    0x0000400000000000UL
 136 #define  BIT47    0x0000800000000000UL
 137 #define  BIT48    0x0001000000000000UL
 138 #define  BIT49    0x0002000000000000UL
 139 #define  BIT50    0x0004000000000000UL
 140 #define  BIT51    0x0008000000000000UL
 141 #define  BIT52    0x0010000000000000UL
 142 #define  BIT53    0x0020000000000000UL
 143 #define  BIT54    0x0040000000000000UL
 144 #define  BIT55    0x0080000000000000UL
 145 #define  BIT56    0x0100000000000000UL
 146 #define  BIT57    0x0200000000000000UL
 147 #define  BIT58    0x0400000000000000UL
 148 #define  BIT59    0x0800000000000000UL
 149 #define  BIT60    0x1000000000000000UL
 150 #define  BIT61    0x2000000000000000UL
 151 #define  BIT62    0x4000000000000000UL
 152 #define  BIT63    0x8000000000000000UL
 153
 154 //
 155 //  Support for variable length argument lists using the ANSI standard.
 156 //
 157 //  Since we are using the ANSI standard we used the standard nameing and
 158 //  did not folow the coding convention
 159 //
 160 //  VA_LIST  - typedef for argument list.
 161 //  VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
 162 //  VA_END (VA_LIST Marker) - Clear Marker
 163 //  VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from
 164 //    the ... list. You must know the size and pass it in this macro.
 165 //
 166 //  example:
 167 //
 168 //  UINTN
 169 //  ExampleVarArg (
 170 //    IN UINTN  NumberOfArgs,
 171 //    ...
 172 //    )
 173 //  {
 174 //    VA_LIST Marker;
 175 //    UINTN   Index;
 176 //    UINTN   Result;
 177 //
 178 //    //
 179 //    // Initialize the Marker
 180 //    //
 181 //    VA_START (Marker, NumberOfArgs);
 182 //    for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
 183 //      //
 184 //      // The ... list is a series of UINTN values, so average them up.
 185 //      //
 186 //      Result += VA_ARG (Marker, UINTN);
 187 //    }
 188 //
 189 //    VA_END (Marker);
 190 //    return Result
 191 //  }
 192 //
 193
 194 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
 195
 196 //
 197 // Also support coding convention rules for var arg macros
 198 //
 199 #ifndef VA_START
 200
 201 typedef CHAR8 *VA_LIST;
 202 #define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))
 203 #define VA_ARG(ap, t)   (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))
 204 #define VA_END(ap)      (ap = (VA_LIST) 0)
 205
 206 #endif
 207
 208 //
 209 // Macro that returns the byte offset of a field in a data structure.
 210 //
 211 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
 212
 213 ///
 214 ///  CONTAINING_RECORD - returns a pointer to the structure
 215 ///      from one of it's elements.
 216 ///
 217 #define _CR(Record, TYPE, Field)  ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
 218
 219 ///
 220 ///  ALIGN_POINTER - aligns a pointer to the lowest boundry
 221 ///
 222 #define ALIGN_POINTER(p, s) ((VOID *) ((UINTN)(p) + (((s) - ((UINTN) (p))) & ((s) - 1))))
 223
 224 ///
 225 ///  ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor
 226 ///
 227 #define ALIGN_VARIABLE(Value, Adjustment) \
 228   Adjustment = 0U; \
 229   if ((UINTN) (Value) % sizeof (UINTN)) { \
 230     (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \
 231   } \
 232   (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))
 233
 234 //
 235 // Return the maximum of two operands.
 236 // This macro returns the maximum of two operand specified by a and b.
 237 // Both a and b must be the same numerical types, signed or unsigned.
 238 //
 239 #define MAX(a, b)                       \
 240   (((a) > (b)) ? (a) : (b))
 241
 242
 243 //
 244 // Return the minimum of two operands.
 245 // This macro returns the minimal of two operand specified by a and b.
 246 // Both a and b must be the same numerical types, signed or unsigned.
 247 //
 248 #define MIN(a, b)                       \
 249   (((a) < (b)) ? (a) : (b))
 250
 251
 252 //
 253 // EFI Error Codes common to all execution phases
 254 //
 255
 256 typedef INTN RETURN_STATUS;
 257
 258 ///
 259 /// Set the upper bit to indicate EFI Error.
 260 ///
 261 #define ENCODE_ERROR(a)              (MAX_BIT | (a))
 262
 263 #define ENCODE_WARNING(a)            (a)
 264 #define RETURN_ERROR(a)              ((a) < 0)
 265
 266 #define RETURN_SUCCESS               0
 267 #define RETURN_LOAD_ERROR            ENCODE_ERROR (1)
 268 #define RETURN_INVALID_PARAMETER     ENCODE_ERROR (2)
 269 #define RETURN_UNSUPPORTED           ENCODE_ERROR (3)
 270 #define RETURN_BAD_BUFFER_SIZE       ENCODE_ERROR (4)
 271 #define RETURN_BUFFER_TOO_SMALL      ENCODE_ERROR (5)
 272 #define RETURN_NOT_READY             ENCODE_ERROR (6)
 273 #define RETURN_DEVICE_ERROR          ENCODE_ERROR (7)
 274 #define RETURN_WRITE_PROTECTED       ENCODE_ERROR (8)
 275 #define RETURN_OUT_OF_RESOURCES      ENCODE_ERROR (9)
 276 #define RETURN_VOLUME_CORRUPTED      ENCODE_ERROR (10)
 277 #define RETURN_VOLUME_FULL           ENCODE_ERROR (11)
 278 #define RETURN_NO_MEDIA              ENCODE_ERROR (12)
 279 #define RETURN_MEDIA_CHANGED         ENCODE_ERROR (13)
 280 #define RETURN_NOT_FOUND             ENCODE_ERROR (14)
 281 #define RETURN_ACCESS_DENIED         ENCODE_ERROR (15)
 282 #define RETURN_NO_RESPONSE           ENCODE_ERROR (16)
 283 #define RETURN_NO_MAPPING            ENCODE_ERROR (17)
 284 #define RETURN_TIMEOUT               ENCODE_ERROR (18)
 285 #define RETURN_NOT_STARTED           ENCODE_ERROR (19)
 286 #define RETURN_ALREADY_STARTED       ENCODE_ERROR (20)
 287 #define RETURN_ABORTED               ENCODE_ERROR (21)
 288 #define RETURN_ICMP_ERROR            ENCODE_ERROR (22)
 289 #define RETURN_TFTP_ERROR            ENCODE_ERROR (23)
 290 #define RETURN_PROTOCOL_ERROR        ENCODE_ERROR (24)
 291 #define RETURN_INCOMPATIBLE_VERSION  ENCODE_ERROR (25)
 292 #define RETURN_SECURITY_VIOLATION    ENCODE_ERROR (26)
 293 #define RETURN_CRC_ERROR             ENCODE_ERROR (27)
 294 #define RETURN_END_OF_MEDIA          ENCODE_ERROR (28)
 295 #define RETURN_END_OF_FILE           ENCODE_ERROR (31)
 296
 297 #define RETURN_WARN_UNKNOWN_GLYPH    ENCODE_WARNING (1)
 298 #define RETURN_WARN_DELETE_FAILURE   ENCODE_WARNING (2)
 299 #define RETURN_WARN_WRITE_FAILURE    ENCODE_WARNING (3)
 300 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
 301
 302 #endif
 303