MdePkg/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
   7   All rights reserved. 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   Module 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
  27 #define MEMORY_FENCE()  MemoryFence ()
  28 #define BREAKPOINT()    CpuBreakpoint ()
  29 #define DEADLOOP()      CpuDeadLoop ()
  30
  31 typedef struct {
  32   UINT32  Data1;
  33   UINT16  Data2;
  34   UINT16  Data3;
  35   UINT8   Data4[8];
  36 } GUID;
  37
  38
  39 //
  40 // Modifiers to absract standard types to aid in debug of problems
  41 //
  42 #define CONST     const
  43 #define STATIC    static
  44 #define VOID      void
  45
  46 //
  47 // Modifiers for Data Types used to self document code.
  48 // This concept is borrowed for UEFI specification.
  49 //
  50 #ifndef IN
  51 //
  52 // Some other envirnments use this construct, so #ifndef to prevent
  53 // mulitple definition.
  54 //
  55 #define IN
  56 #define OUT
  57 #define OPTIONAL
  58 #endif
  59
  60 //
  61 // Constants. They may exist in other build structures, so #ifndef them.
  62 //
  63 #ifndef TRUE
  64 //
  65 // BugBug: UEFI specification claims 1 and 0. We are concerned about the
  66 //  complier portability so we did it this way.
  67 //
  68 #define TRUE  ((BOOLEAN)(1==1))
  69 #endif
  70
  71 #ifndef FALSE
  72 #define FALSE ((BOOLEAN)(0==1))
  73 #endif
  74
  75 #ifndef NULL
  76 #define NULL  ((VOID *) 0)
  77 #endif
  78
  79 //
  80 //  Support for variable length argument lists using the ANSI standard.
  81 //
  82 //  Since we are using the ANSI standard we used the standard nameing and
  83 //  did not folow the coding convention
  84 //
  85 //  VA_LIST  - typedef for argument list.
  86 //  VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
  87 //  VA_END (VA_LIST Marker) - Clear Marker
  88 //  VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argumnet from
  89 //    the ... list. You must know the size and pass it in this macro.
  90 //
  91 //  example:
  92 //
  93 //  UINTN
  94 //  ExampleVarArg (
  95 //    IN UINTN  NumberOfArgs,
  96 //    ...
  97 //    )
  98 //  {
  99 //    VA_LIST Marker;
 100 //    UINTN   Index;
 101 //    UINTN   Result;
 102 //
 103 //    //
 104 //    // Initialize the Marker
 105 //    //
 106 //    VA_START (Marker, NumberOfArgs);
 107 //    for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
 108 //      //
 109 //      // The ... list is a series of UINTN values, so average them up.
 110 //      //
 111 //      Result += VA_ARG (Marker, UINTN);
 112 //    }
 113 //
 114 //    VA_END (Marker);
 115 //    return Result
 116 //  }
 117 //
 118
 119 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
 120
 121 //
 122 // Also support coding convention rules for var arg macros
 123 //
 124 #ifndef VA_START
 125
 126 typedef CHAR8 *VA_LIST;
 127 #define VA_START(ap, v) (ap = (VA_LIST) & (v) + _INT_SIZE_OF (v))
 128 #define VA_ARG(ap, t)   (*(t *) ((ap += _INT_SIZE_OF (t)) - _INT_SIZE_OF (t)))
 129 #define VA_END(ap)      (ap = (VA_LIST) 0)
 130
 131 #endif
 132
 133 ///
 134 ///  CONTAINING_RECORD - returns a pointer to the structure
 135 ///      from one of it's elements.
 136 ///
 137 #define _CR(Record, TYPE, Field)  ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
 138
 139 ///
 140 ///  ALIGN_POINTER - aligns a pointer to the lowest boundry
 141 ///
 142 #define ALIGN_POINTER(p, s) ((VOID *) ((p) + (((s) - ((UINTN) (p))) & ((s) - 1))))
 143
 144 ///
 145 ///  ALIGN_VARIABLE - aligns a variable up to the next natural boundry for int size of a processor
 146 ///
 147 #define ALIGN_VARIABLE(Value, Adjustment) \
 148   Adjustment = 0U; \
 149   if ((UINTN) (Value) % sizeof (UINTN)) { \
 150     (Adjustment) = (UINTN)(sizeof (UINTN) - ((UINTN) (Value) % sizeof (UINTN))); \
 151   } \
 152   (Value) = (UINTN)((UINTN) (Value) + (UINTN) (Adjustment))
 153
 154 //
 155 // EFI Error Codes common to all execution phases
 156 //
 157
 158 typedef INTN RETURN_STATUS;
 159
 160 ///
 161 /// Set the upper bit to indicate EFI Error.
 162 ///
 163 #define ENCODE_ERROR(a)              (MAX_BIT | (a))
 164
 165 #define ENCODE_WARNING(a)            (a)
 166 #define RETURN_ERROR(a)              ((a) < 0)
 167
 168 #define RETURN_SUCCESS               0
 169 #define RETURN_LOAD_ERROR            ENCODE_ERROR (1)
 170 #define RETURN_INVALID_PARAMETER     ENCODE_ERROR (2)
 171 #define RETURN_UNSUPPORTED           ENCODE_ERROR (3)
 172 #define RETURN_BAD_BUFFER_SIZE       ENCODE_ERROR (4)
 173 #define RETURN_BUFFER_TOO_SMALL      ENCODE_ERROR (5)
 174 #define RETURN_NOT_READY             ENCODE_ERROR (6)
 175 #define RETURN_DEVICE_ERROR          ENCODE_ERROR (7)
 176 #define RETURN_WRITE_PROTECTED       ENCODE_ERROR (8)
 177 #define RETURN_OUT_OF_RESOURCES      ENCODE_ERROR (9)
 178 #define RETURN_VOLUME_CORRUPTED      ENCODE_ERROR (10)
 179 #define RETURN_VOLUME_FULL           ENCODE_ERROR (11)
 180 #define RETURN_NO_MEDIA              ENCODE_ERROR (12)
 181 #define RETURN_MEDIA_CHANGED         ENCODE_ERROR (13)
 182 #define RETURN_NOT_FOUND             ENCODE_ERROR (14)
 183 #define RETURN_ACCESS_DENIED         ENCODE_ERROR (15)
 184 #define RETURN_NO_RESPONSE           ENCODE_ERROR (16)
 185 #define RETURN_NO_MAPPING            ENCODE_ERROR (17)
 186 #define RETURN_TIMEOUT               ENCODE_ERROR (18)
 187 #define RETURN_NOT_STARTED           ENCODE_ERROR (19)
 188 #define RETURN_ALREADY_STARTED       ENCODE_ERROR (20)
 189 #define RETURN_ABORTED               ENCODE_ERROR (21)
 190 #define RETURN_ICMP_ERROR            ENCODE_ERROR (22)
 191 #define RETURN_TFTP_ERROR            ENCODE_ERROR (23)
 192 #define RETURN_PROTOCOL_ERROR        ENCODE_ERROR (24)
 193 #define RETURN_INCOMPATIBLE_VERSION  ENCODE_ERROR (25)
 194 #define RETURN_SECURITY_VIOLATION    ENCODE_ERROR (26)
 195 #define RETURN_CRC_ERROR             ENCODE_ERROR (27)
 196 #define RETURN_END_OF_MEDIA          ENCODE_ERROR (28)
 197 #define RETURN_END_OF_FILE           ENCODE_ERROR (31)
 198
 199 #define RETURN_WARN_UNKNOWN_GLYPH    ENCODE_WARNING (1)
 200 #define RETURN_WARN_DELETE_FAILURE   ENCODE_WARNING (2)
 201 #define RETURN_WARN_WRITE_FAILURE    ENCODE_WARNING (3)
 202 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
 203
 204 typedef UINT64 PHYSICAL_ADDRESS;
 205
 206 #endif