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