MdePkg/Include/Ipf/ProcessorBind.h

   1 /** @file
   2   Processor or Compiler specific defines and types for Intel Itanium(TM).
   3
   4   Copyright (c) 2006, Intel Corporation<BR>
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __PROCESSOR_BIND_H__
  16 #define __PROCESSOR_BIND_H__
  17
  18
  19 ///
  20 /// Define the processor type so other code can make processor based choices
  21 ///
  22 #define MDE_CPU_IPF
  23
  24
  25 //
  26 // Make sure we are using the correct packing rules per EFI specification
  27 //
  28 #pragma pack()
  29
  30
  31 #if __INTEL_COMPILER
  32 //
  33 // Disable ICC's remark #869: "Parameter" was never referenced warning.
  34 // This is legal ANSI C code so we disable the remark that is turned on with -Wall
  35 //
  36 #pragma warning ( disable : 869 )
  37
  38 //
  39 // Disable ICC's remark #1418: external function definition with no prior declaration.
  40 // This is legal ANSI C code so we disable the remark that is turned on with /W4
  41 //
  42 #pragma warning ( disable : 1418 )
  43
  44 //
  45 // Disable ICC's remark #1419: external declaration in primary source file
  46 // This is legal ANSI C code so we disable the remark that is turned on with /W4
  47 //
  48 #pragma warning ( disable : 1419 )
  49
  50 #endif
  51
  52
  53 #if _MSC_EXTENSIONS
  54 //
  55 // Disable warning that make it impossible to compile at /W4
  56 // This only works for Microsoft tools.
  57 //
  58
  59 //
  60 // Disabling bitfield type checking warnings.
  61 //
  62 #pragma warning ( disable : 4214 )
  63
  64
  65 // Disabling the unreferenced formal parameter warnings.
  66 //
  67 #pragma warning ( disable : 4100 )
  68
  69 //
  70 // Disable slightly different base types warning as CHAR8 * can not be set
  71 // to a constant string.
  72 //
  73 #pragma warning ( disable : 4057 )
  74
  75 //
  76 // Disable warning on conversion from function pointer to a data pointer
  77 //
  78 #pragma warning ( disable : 4054 )
  79
  80 //
  81 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
  82 //
  83 #pragma warning ( disable : 4127 )
  84
  85 //
  86 // Can not cast a function pointer to a data pointer. We need to do this on
  87 // IPF to get access to the PLABEL.
  88 //
  89 #pragma warning ( disable : 4514 )
  90
  91 //
  92 // This warning is caused by functions defined but not used. For precompiled header only.
  93 //
  94 #pragma warning ( disable : 4505 )
  95
  96 //
  97 // This warning is caused by empty (after preprocessing) source file. For precompiled header only.
  98 //
  99 #pragma warning ( disable : 4206 )
 100
 101 #endif
 102
 103
 104 #if (__STDC_VERSION__ < 199901L)
 105   //
 106   // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
 107   //
 108
 109   #if _MSC_EXTENSIONS
 110     //
 111     // use Microsoft C complier dependent integer width types
 112     //
 113     typedef unsigned __int64    UINT64;
 114     typedef __int64             INT64;
 115     typedef unsigned __int32    UINT32;
 116     typedef __int32             INT32;
 117     typedef unsigned short      UINT16;
 118     typedef unsigned short      CHAR16;
 119     typedef short               INT16;
 120     typedef unsigned char       BOOLEAN;
 121     typedef unsigned char       UINT8;
 122     typedef char                CHAR8;
 123     typedef char                INT8;
 124   #else
 125     #ifdef _EFI_P64
 126       //
 127       // P64 - pointers being 64-bit and longs and ints are 32-bits.
 128       //
 129       typedef unsigned long long  UINT64;
 130       typedef long long           INT64;
 131       typedef unsigned int        UINT32;
 132       typedef int                 INT32;
 133       typedef unsigned short      CHAR16;
 134       typedef unsigned short      UINT16;
 135       typedef short               INT16;
 136       typedef unsigned char       BOOLEAN;
 137       typedef unsigned char       UINT8;
 138       typedef char                CHAR8;
 139       typedef char                INT8;
 140     #else
 141       //
 142       // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.
 143       //
 144       typedef unsigned long   UINT64;
 145       typedef long            INT64;
 146       typedef unsigned int    UINT32;
 147       typedef int             INT32;
 148       typedef unsigned short  UINT16;
 149       typedef unsigned short  CHAR16;
 150       typedef short           INT16;
 151       typedef unsigned char   BOOLEAN;
 152       typedef unsigned char   UINT8;
 153       typedef char            CHAR8;
 154       typedef char            INT8;
 155     #endif
 156   #endif
 157
 158   #define UINT8_MAX 0xff
 159
 160 #else
 161   //
 162   // Use ANSI C 2000 stdint.h integer width declarations
 163   //
 164   #include <stdint.h>
 165   typedef uint8_t   BOOLEAN;
 166   typedef int8_t    INT8;
 167   typedef uint8_t   UINT8;
 168   typedef int16_t   INT16;
 169   typedef uint16_t  UINT16;
 170   typedef int32_t   INT32;
 171   typedef uint32_t  UINT32;
 172   typedef int64_t   INT64;
 173   typedef uint64_t  UINT64;
 174   typedef char      CHAR8;
 175   typedef uint16_t  CHAR16;
 176
 177 #endif
 178
 179 typedef UINT64  UINTN;
 180 typedef INT64   INTN;
 181
 182
 183 //
 184 // Processor specific defines
 185 //
 186 #define MAX_BIT     0x8000000000000000ULL
 187 #define MAX_2_BITS  0xC000000000000000ULL
 188
 189 //
 190 // Maximum legal Itanium-based address
 191 //
 192 #define MAX_ADDRESS   0xFFFFFFFFFFFFFFFFULL
 193
 194 //
 195 // Per the Itanium Software Conventions and Runtime Architecture Guide,
 196 // section 3.3.4, IPF stack must always be 16-byte aligned.
 197 //
 198 #define CPU_STACK_ALIGNMENT   16
 199
 200 //
 201 // Modifier to ensure that all protocol member functions and EFI intrinsics
 202 // use the correct C calling convention. All protocol member functions and
 203 // EFI intrinsics are required to modify their member functions with EFIAPI.
 204 //
 205 #if _MSC_EXTENSIONS
 206   //
 207   // Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.
 208   //
 209   #define EFIAPI __cdecl
 210 #else
 211   #define EFIAPI
 212 #endif
 213
 214 //
 215 // The Microsoft* C compiler can removed references to unreferenced data items
 216 //  if the /OPT:REF linker option is used. We defined a macro as this is a
 217 //  a non standard extension
 218 //
 219 #if _MSC_EXTENSIONS
 220   #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
 221 #else
 222   #define GLOBAL_REMOVE_IF_UNREFERENCED
 223 #endif
 224
 225 ///
 226 /// A pointer to a function in IPF points to a plabel.
 227 ///
 228 typedef struct {
 229   UINT64  EntryPoint;
 230   UINT64  GP;
 231 } EFI_PLABEL;
 232
 233 typedef struct {
 234   UINT64                    Status;
 235   UINT64                    r9;
 236   UINT64                    r10;
 237   UINT64                    r11;
 238 } PAL_CALL_RETURN;
 239
 240 /**
 241   Return the pointer to the first instruction of a function given a function pointer.
 242   For Itanium CPUs, all function calls are made through a PLABEL, so a pointer to a function
 243   is actually a pointer to a PLABEL.  The pointer to the first instruction of the function
 244   is contained within the PLABEL.  This macro may be used to retrieve a pointer to the first
 245   instruction of a function independent of the CPU architecture being used.  This is very
 246   useful when printing function addresses through DEBUG() macros.
 247
 248   @param  FunctionPointer   A pointer to a function.
 249
 250   @return The pointer to the first instruction of a function given a function pointer.
 251
 252 **/
 253 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(((EFI_PLABEL *)(FunctionPointer))->EntryPoint)
 254
 255 #endif
 256