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

/** @file\r
  Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).\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
/// Define the processor type so other code can make processor based choices\r
///\r
#define MDE_CPU_X64\r
\r
\r
//\r
// Make sure we are useing the correct packing rules per EFI specification\r
//\r
#ifndef __GNUC__\r
#pragma pack()\r
#endif\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
//\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
// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
//\r
#pragma warning ( disable : 4127 )\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 !defined(__GNUC__) && (__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
    // 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 - pointers being 64-bit and longs and ints 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 X64 address\r
//\r
#define MAX_ADDRESS   0xFFFFFFFFFFFFFFFFULL\r
\r
//\r
// The stack alignment required for X64\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
  /// Define the standard calling convention reguardless of optimization level.\r
  /// __cdecl is Microsoft* specific C extension.\r
  /// \r
  #define EFIAPI __cdecl  \r
#elif __GNUC__\r
  ///\r
  /// Define the standard calling convention reguardless of optimization level.\r
  /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI\r
  /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64) \r
  /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for \r
  /// x64. Warning the assembly code in the MDE x64 does not follow the correct \r
  /// ABI for the standard x64 (x86-64) GCC.\r
  ///\r
  #define EFIAPI \r
#else\r
  ///\r
  /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI\r
  /// is the standard. \r
  ///\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
// For symbol name in GNU assembly code, an extra "_" is necessary\r
//\r
#if __GNUC__\r
  #if defined(linux)\r
    #define ASM_PFX(name) name\r
  #else\r
    #define ASM_PFX(name) _##name\r
  #endif  \r
#endif\r
\r
#define FUNCTION_ENTRY_POINT(p) (p)\r
\r
#endif\r
\r
Commit	Line	Data
959ccb23	1	/** @file\r
	2	Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).\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
959ccb23	13	**/\r
	14	\r
	15	#ifndef __PROCESSOR_BIND_H__\r
	16	#define __PROCESSOR_BIND_H__\r
	17	\r
fb5148a0	18	///\r
	19	/// Define the processor type so other code can make processor based choices\r
	20	///\r
959ccb23	21	#define MDE_CPU_X64\r
	22	\r
	23	\r
	24	//\r
	25	// Make sure we are useing the correct packing rules per EFI specification\r
	26	//\r
	27	#ifndef __GNUC__\r
	28	#pragma pack()\r
	29	#endif\r
	30	\r
b483e395 A	31	\r
b483e395 A	32	#if __INTEL_COMPILER\r
1fb24cc4	33	//\r
	34	// Disable ICC's remark #869: "Parameter" was never referenced warning.\r
	35	// This is legal ANSI C code so we disable the remark that is turned on with -Wall\r
	36	//\r
	37	#pragma warning ( disable : 869 )\r
	38	\r
b483e395 A	39	//\r
	40	// Disable ICC's remark #1418: external function definition with no prior declaration.\r
	41	// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
	42	//\r
	43	#pragma warning ( disable : 1418 )\r
	44	\r
b483e395 A	45	//\r
	46	// Disable ICC's remark #1419: external declaration in primary source file\r
	47	// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
	48	//\r
	49	#pragma warning ( disable : 1419 )\r
	50	\r
	51	#endif\r
	52	\r
	53	\r
1fb24cc4	54	#if _MSC_EXTENSIONS\r
1fb24cc4	55	\r
959ccb23	56	//\r
	57	// Disable warning that make it impossible to compile at /W4\r
	58	// This only works for Microsoft* tools\r
	59	//\r
	60	\r
	61	//\r
	62	// Disabling bitfield type checking warnings.\r
	63	//\r
	64	#pragma warning ( disable : 4214 )\r
	65	\r
	66	//\r
	67	// Disabling the unreferenced formal parameter warnings.\r
	68	//\r
	69	#pragma warning ( disable : 4100 )\r
	70	\r
	71	//\r
	72	// Disable slightly different base types warning as CHAR8 * can not be set\r
	73	// to a constant string.\r
	74	//\r
	75	#pragma warning ( disable : 4057 )\r
	76	\r
	77	//\r
	78	// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
	79	//\r
	80	#pragma warning ( disable : 4127 )\r
	81	\r
	82	//\r
	83	// This warning is caused by functions defined but not used. For precompiled header only.\r
	84	//\r
	85	#pragma warning ( disable : 4505 )\r
	86	\r
	87	//\r
	88	// This warning is caused by empty (after preprocessing) souce file. For precompiled header only.\r
	89	//\r
	90	#pragma warning ( disable : 4206 )\r
	91	\r
	92	#endif\r
	93	\r
	94	\r
	95	#if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)\r
	96	//\r
	97	// No ANSI C 2000 stdint.h integer width declarations, so define equivalents\r
	98	//\r
	99	\r
	100	#if _MSC_EXTENSIONS \r
959ccb23	101	//\r
	102	// use Microsoft C complier dependent interger width types \r
	103	//\r
	104	typedef unsigned __int64 UINT64;\r
	105	typedef __int64 INT64;\r
	106	typedef unsigned __int32 UINT32;\r
	107	typedef __int32 INT32;\r
	108	typedef unsigned short UINT16;\r
	109	typedef unsigned short CHAR16;\r
	110	typedef short INT16;\r
	111	typedef unsigned char BOOLEAN;\r
	112	typedef unsigned char UINT8;\r
	113	typedef char CHAR8;\r
	114	typedef char INT8;\r
	115	#else\r
	116	#ifdef _EFI_P64 \r
	117	//\r
9510db65	118	// P64 - pointers being 64-bit and longs and ints are 32-bits.\r
959ccb23	119	//\r
	120	typedef unsigned long long UINT64;\r
	121	typedef long long INT64;\r
	122	typedef unsigned int UINT32;\r
	123	typedef int INT32;\r
	124	typedef unsigned short CHAR16;\r
	125	typedef unsigned short UINT16;\r
	126	typedef short INT16;\r
	127	typedef unsigned char BOOLEAN;\r
	128	typedef unsigned char UINT8;\r
	129	typedef char CHAR8;\r
	130	typedef char INT8;\r
	131	#else\r
	132	//\r
	133	// Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.\r
	134	//\r
	135	typedef unsigned long UINT64;\r
	136	typedef long INT64;\r
	137	typedef unsigned int UINT32;\r
	138	typedef int INT32;\r
	139	typedef unsigned short UINT16;\r
	140	typedef unsigned short CHAR16;\r
	141	typedef short INT16;\r
	142	typedef unsigned char BOOLEAN;\r
	143	typedef unsigned char UINT8;\r
	144	typedef char CHAR8;\r
	145	typedef char INT8;\r
	146	#endif\r
	147	#endif\r
	148	\r
	149	#define UINT8_MAX 0xff\r
	150	\r
	151	#else\r
	152	//\r
	153	// Use ANSI C 2000 stdint.h integer width declarations\r
	154	//\r
	155	#include <stdint.h>\r
	156	typedef uint8_t BOOLEAN;\r
	157	typedef int8_t INT8;\r
	158	typedef uint8_t UINT8;\r
	159	typedef int16_t INT16;\r
	160	typedef uint16_t UINT16;\r
	161	typedef int32_t INT32;\r
	162	typedef uint32_t UINT32;\r
	163	typedef int64_t INT64;\r
	164	typedef uint64_t UINT64;\r
	165	typedef char CHAR8;\r
	166	typedef uint16_t CHAR16;\r
	167	\r
	168	#endif\r
	169	\r
	170	typedef UINT64 UINTN;\r
	171	typedef INT64 INTN;\r
	172	\r
	173	\r
	174	//\r
	175	// Processor specific defines\r
	176	//\r
	177	#define MAX_BIT 0x8000000000000000ULL\r
	178	#define MAX_2_BITS 0xC000000000000000ULL\r
	179	\r
	180	//\r
	181	// Maximum legal X64 address\r
	182	//\r
183	#define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL\r
184	\r
185	//\r
186	// The stack alignment required for X64\r
187	//\r
188	#define CPU_STACK_ALIGNMENT 16\r
189	\r
190	//\r
191	// Modifier to ensure that all protocol member functions and EFI intrinsics\r
192	// use the correct C calling convention. All protocol member functions and\r
193	// EFI intrinsics are required to modify thier member functions with EFIAPI.\r
194	//\r
195	#if _MSC_EXTENSIONS \r
196	///\r
197	/// Define the standard calling convention reguardless of optimization level.\r
198	/// __cdecl is Microsoft* specific C extension.\r
199	/// \r
200	#define EFIAPI __cdecl \r
201	#elif __GNUC__\r
202	///\r
203	/// Define the standard calling convention reguardless of optimization level.\r
204	/// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI\r
205	/// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64) \r
206	/// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for \r
207	/// x64. Warning the assembly code in the MDE x64 does not follow the correct \r
208	/// ABI for the standard x64 (x86-64) GCC.\r
209	///\r
210	#define EFIAPI \r
211	#else\r
212	///\r
213	/// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI\r
214	/// is the standard. \r
215	///\r
216	#define EFIAPI \r
217	#endif\r
218	\r
219	//\r
220	// The Microsoft* C compiler can removed references to unreferenced data items\r
221	// if the /OPT:REF linker option is used. We defined a macro as this is a \r
222	// a non standard extension\r
223	//\r
224	#if _MSC_EXTENSIONS\r
225	#define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
226	#else\r
227	#define GLOBAL_REMOVE_IF_UNREFERENCED\r
228	#endif\r
229	\r
27af6b87	230	//\r
	231	// For symbol name in GNU assembly code, an extra "_" is necessary\r
	232	//\r
	233	#if __GNUC__\r
6b3a2ca0	234	#if defined(linux)\r
	235	#define ASM_PFX(name) name\r
	236	#else\r
	237	#define ASM_PFX(name) _##name\r
	238	#endif \r
27af6b87	239	#endif\r
27af6b87	240	\r
24a7505c	241	#define FUNCTION_ENTRY_POINT(p) (p)\r
24a7505c	242	\r
959ccb23	243	#endif\r
959ccb23	244	\r