[mirror_edk2.git] / MdePkg / Include / Ipf / ProcessorBind.h

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