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

/** @file\r
  Processor or Compiler specific defines and types for IA-32 architecture.\r
\r
Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
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_IA32\r
\r
//\r
// Make sure we are using the correct packing rules per EFI specification\r
//\r
#if !defined(__GNUC__)\r
#pragma pack()\r
#endif\r
\r
#if defined(__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
//\r
// Disable ICC's remark #593: "Variable" was set but never used.\r
// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
//\r
#pragma warning ( disable : 593 )\r
\r
#endif\r
\r
\r
#if defined(_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 constructs so suppress 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) source file. For precompiled header only.\r
//\r
#pragma warning ( disable : 4206 )\r
\r
#if _MSC_VER == 1800 || _MSC_VER == 1900\r
\r
//\r
// Disable these warnings for VS2013.\r
//\r
\r
//\r
// This warning is for potentially uninitialized local variable, and it may cause false \r
// positive issues in VS2013 and VS2015 build\r
//\r
#pragma warning ( disable : 4701 )\r
  \r
//\r
// This warning is for potentially uninitialized local pointer variable, and it may cause \r
// false positive issues in VS2013 and VS2015 build\r
//\r
#pragma warning ( disable : 4703 )\r
  \r
#endif\r
\r
#endif\r
\r
\r
#if defined(_MSC_EXTENSIONS)\r
\r
  //\r
  // use Microsoft C compiler dependent integer width types\r
  //\r
\r
  ///\r
  /// 8-byte unsigned value.\r
  ///\r
  typedef unsigned __int64    UINT64;\r
  ///\r
  /// 8-byte signed value.\r
  ///\r
  typedef __int64             INT64;\r
  ///\r
  /// 4-byte unsigned value.\r
  ///\r
  typedef unsigned __int32    UINT32;\r
  ///\r
  /// 4-byte signed value.\r
  ///\r
  typedef __int32             INT32;\r
  ///\r
  /// 2-byte unsigned value.\r
  ///\r
  typedef unsigned short      UINT16;\r
  ///\r
  /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
  /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
  ///\r
  typedef unsigned short      CHAR16;\r
  ///\r
  /// 2-byte signed value.\r
  ///\r
  typedef short               INT16;\r
  ///\r
  /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
  /// values are undefined.\r
  ///\r
  typedef unsigned char       BOOLEAN;\r
  ///\r
  /// 1-byte unsigned value.\r
  ///\r
  typedef unsigned char       UINT8;\r
  ///\r
  /// 1-byte Character.\r
  ///\r
  typedef char                CHAR8;\r
  ///\r
  /// 1-byte signed value.\r
  ///\r
  typedef signed char         INT8;\r
#else  \r
  ///\r
  /// 8-byte unsigned value.\r
  ///\r
  typedef unsigned long long  UINT64;\r
  ///\r
  /// 8-byte signed value.\r
  ///\r
  typedef long long           INT64;\r
  ///\r
  /// 4-byte unsigned value.\r
  ///\r
  typedef unsigned int        UINT32;\r
  ///\r
  /// 4-byte signed value.\r
  ///\r
  typedef int                 INT32;\r
  ///\r
  /// 2-byte unsigned value.\r
  ///\r
  typedef unsigned short      UINT16;\r
  ///\r
  /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
  /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
  ///\r
  typedef unsigned short      CHAR16;\r
  ///\r
  /// 2-byte signed value.\r
  ///\r
  typedef short               INT16;\r
  ///\r
  /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
  /// values are undefined.\r
  ///\r
  typedef unsigned char       BOOLEAN;\r
  ///\r
  /// 1-byte unsigned value.\r
  ///\r
  typedef unsigned char       UINT8;\r
  ///\r
  /// 1-byte Character\r
  ///\r
  typedef char                CHAR8;\r
  ///\r
  /// 1-byte signed value\r
  ///\r
  typedef signed char         INT8;\r
#endif\r
\r
///\r
/// Unsigned value of native width.  (4 bytes on supported 32-bit processor instructions;\r
/// 8 bytes on supported 64-bit processor instructions.)\r
///\r
typedef UINT32  UINTN;\r
///\r
/// Signed value of native width.  (4 bytes on supported 32-bit processor instructions;\r
/// 8 bytes on supported 64-bit processor instructions.)\r
///\r
typedef INT32   INTN;\r
\r
//\r
// Processor specific defines\r
//\r
\r
///\r
/// A value of native width with the highest bit set.\r
///\r
#define MAX_BIT     0x80000000\r
///\r
/// A value of native width with the two highest bits set.\r
///\r
#define MAX_2_BITS  0xC0000000\r
\r
///\r
/// Maximum legal IA-32 address.\r
///\r
#define MAX_ADDRESS   0xFFFFFFFF\r
\r
///\r
/// Maximum legal IA-32 INTN and UINTN values.\r
///\r
#define MAX_INTN   ((INTN)0x7FFFFFFF)\r
#define MAX_UINTN  ((UINTN)0xFFFFFFFF)\r
\r
///\r
/// The stack alignment required for IA-32.\r
///\r
#define CPU_STACK_ALIGNMENT   sizeof(UINTN)\r
\r
///\r
/// Page allocation granularity for IA-32.\r
///\r
#define DEFAULT_PAGE_ALLOCATION_GRANULARITY   (0x1000)\r
#define RUNTIME_PAGE_ALLOCATION_GRANULARITY   (0x1000)\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 their member functions with EFIAPI.\r
//\r
#ifdef EFIAPI\r
  ///\r
  /// If EFIAPI is already defined, then we use that definition.\r
  ///\r
#elif defined(_MSC_EXTENSIONS)\r
  ///\r
  /// Microsoft* compiler specific method for EFIAPI calling convention.\r
  /// \r
  #define EFIAPI __cdecl  \r
#elif defined(__GNUC__)\r
  ///\r
  /// GCC specific method for EFIAPI calling convention.\r
  /// \r
  #define EFIAPI __attribute__((cdecl))  \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
#if defined(__GNUC__)\r
  ///\r
  /// For GNU assembly code, .global or .globl can declare global symbols.\r
  /// Define this macro to unify the usage.\r
  ///\r
  #define ASM_GLOBAL .globl\r
#endif\r
\r
/**\r
  Return the pointer to the first instruction of a function given a function pointer.\r
  On IA-32 CPU architectures, these two pointer values are the same, \r
  so the implementation of this macro is very simple.\r
  \r
  @param  FunctionPointer   A pointer to a function.\r
\r
  @return The pointer to the first instruction of a function given a function pointer.\r
  \r
**/\r
#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
\r
#ifndef __USER_LABEL_PREFIX__\r
#define __USER_LABEL_PREFIX__ _\r
#endif\r
\r
#endif\r
\r
Commit	Line	Data
	1	/** @file\r
	2	Processor or Compiler specific defines and types for IA-32 architecture.\r
	3	\r
	4	Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
	5	This program and the accompanying materials are licensed and made available under \r
	6	the terms and conditions of the BSD License that accompanies this distribution. \r
	7	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	**/\r
	14	\r
	15	#ifndef __PROCESSOR_BIND_H__\r
	16	#define __PROCESSOR_BIND_H__\r
	17	\r
	18	///\r
	19	/// Define the processor type so other code can make processor based choices.\r
	20	///\r
	21	#define MDE_CPU_IA32\r
	22	\r
	23	//\r
	24	// Make sure we are using the correct packing rules per EFI specification\r
	25	//\r
	26	#if !defined(__GNUC__)\r
	27	#pragma pack()\r
	28	#endif\r
	29	\r
	30	#if defined(__INTEL_COMPILER)\r
	31	//\r
	32	// Disable ICC's remark #869: "Parameter" was never referenced warning.\r
	33	// This is legal ANSI C code so we disable the remark that is turned on with -Wall\r
	34	//\r
	35	#pragma warning ( disable : 869 )\r
	36	\r
	37	//\r
	38	// Disable ICC's remark #1418: external function definition with no prior declaration.\r
	39	// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
	40	//\r
	41	#pragma warning ( disable : 1418 )\r
	42	\r
	43	//\r
	44	// Disable ICC's remark #1419: external declaration in primary source file\r
	45	// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
	46	//\r
	47	#pragma warning ( disable : 1419 )\r
	48	\r
	49	//\r
	50	// Disable ICC's remark #593: "Variable" was set but never used.\r
	51	// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
	52	//\r
	53	#pragma warning ( disable : 593 )\r
	54	\r
	55	#endif\r
	56	\r
	57	\r
	58	#if defined(_MSC_EXTENSIONS)\r
	59	\r
	60	//\r
	61	// Disable warning that make it impossible to compile at /W4\r
	62	// This only works for Microsoft* tools\r
	63	//\r
	64	\r
	65	//\r
	66	// Disabling bitfield type checking warnings.\r
	67	//\r
	68	#pragma warning ( disable : 4214 )\r
	69	\r
	70	//\r
	71	// Disabling the unreferenced formal parameter warnings.\r
	72	//\r
	73	#pragma warning ( disable : 4100 )\r
	74	\r
	75	//\r
	76	// Disable slightly different base types warning as CHAR8 * can not be set\r
	77	// to a constant string.\r
	78	//\r
	79	#pragma warning ( disable : 4057 )\r
	80	\r
	81	//\r
	82	// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning\r
	83	//\r
	84	#pragma warning ( disable : 4127 )\r
	85	\r
	86	//\r
	87	// This warning is caused by functions defined but not used. For precompiled header only.\r
	88	//\r
	89	#pragma warning ( disable : 4505 )\r
	90	\r
	91	//\r
	92	// This warning is caused by empty (after preprocessing) source file. For precompiled header only.\r
	93	//\r
	94	#pragma warning ( disable : 4206 )\r
	95	\r
	96	#if _MSC_VER == 1800 \|\| _MSC_VER == 1900\r
	97	\r
	98	//\r
	99	// Disable these warnings for VS2013.\r
	100	//\r
	101	\r
	102	//\r
	103	// This warning is for potentially uninitialized local variable, and it may cause false \r
	104	// positive issues in VS2013 and VS2015 build\r
	105	//\r
	106	#pragma warning ( disable : 4701 )\r
	107	\r
	108	//\r
	109	// This warning is for potentially uninitialized local pointer variable, and it may cause \r
	110	// false positive issues in VS2013 and VS2015 build\r
	111	//\r
	112	#pragma warning ( disable : 4703 )\r
	113	\r
	114	#endif\r
	115	\r
	116	#endif\r
	117	\r
	118	\r
	119	#if defined(_MSC_EXTENSIONS)\r
	120	\r
	121	//\r
	122	// use Microsoft C compiler dependent integer width types\r
	123	//\r
	124	\r
	125	///\r
	126	/// 8-byte unsigned value.\r
	127	///\r
	128	typedef unsigned __int64 UINT64;\r
	129	///\r
	130	/// 8-byte signed value.\r
	131	///\r
	132	typedef __int64 INT64;\r
	133	///\r
	134	/// 4-byte unsigned value.\r
	135	///\r
	136	typedef unsigned __int32 UINT32;\r
	137	///\r
	138	/// 4-byte signed value.\r
	139	///\r
	140	typedef __int32 INT32;\r
	141	///\r
	142	/// 2-byte unsigned value.\r
	143	///\r
	144	typedef unsigned short UINT16;\r
	145	///\r
	146	/// 2-byte Character. Unless otherwise specified all strings are stored in the\r
	147	/// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
	148	///\r
	149	typedef unsigned short CHAR16;\r
	150	///\r
	151	/// 2-byte signed value.\r
	152	///\r
	153	typedef short INT16;\r
	154	///\r
	155	/// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
	156	/// values are undefined.\r
	157	///\r
	158	typedef unsigned char BOOLEAN;\r
	159	///\r
	160	/// 1-byte unsigned value.\r
	161	///\r
	162	typedef unsigned char UINT8;\r
	163	///\r
	164	/// 1-byte Character.\r
	165	///\r
	166	typedef char CHAR8;\r
	167	///\r
	168	/// 1-byte signed value.\r
	169	///\r
	170	typedef signed char INT8;\r
	171	#else \r
	172	///\r
	173	/// 8-byte unsigned value.\r
	174	///\r
	175	typedef unsigned long long UINT64;\r
	176	///\r
	177	/// 8-byte signed value.\r
	178	///\r
	179	typedef long long INT64;\r
	180	///\r
	181	/// 4-byte unsigned value.\r
	182	///\r
	183	typedef unsigned int UINT32;\r
	184	///\r
	185	/// 4-byte signed value.\r
	186	///\r
	187	typedef int INT32;\r
	188	///\r
	189	/// 2-byte unsigned value.\r
	190	///\r
	191	typedef unsigned short UINT16;\r
	192	///\r
	193	/// 2-byte Character. Unless otherwise specified all strings are stored in the\r
	194	/// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
	195	///\r
	196	typedef unsigned short CHAR16;\r
	197	///\r
	198	/// 2-byte signed value.\r
	199	///\r
	200	typedef short INT16;\r
	201	///\r
	202	/// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
	203	/// values are undefined.\r
	204	///\r
	205	typedef unsigned char BOOLEAN;\r
	206	///\r
	207	/// 1-byte unsigned value.\r
	208	///\r
	209	typedef unsigned char UINT8;\r
	210	///\r
	211	/// 1-byte Character\r
	212	///\r
	213	typedef char CHAR8;\r
	214	///\r
	215	/// 1-byte signed value\r
	216	///\r
	217	typedef signed char INT8;\r
	218	#endif\r
	219	\r
	220	///\r
	221	/// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions;\r
	222	/// 8 bytes on supported 64-bit processor instructions.)\r
	223	///\r
	224	typedef UINT32 UINTN;\r
	225	///\r
	226	/// Signed value of native width. (4 bytes on supported 32-bit processor instructions;\r
	227	/// 8 bytes on supported 64-bit processor instructions.)\r
	228	///\r
	229	typedef INT32 INTN;\r
	230	\r
	231	//\r
	232	// Processor specific defines\r
	233	//\r
	234	\r
	235	///\r
	236	/// A value of native width with the highest bit set.\r
	237	///\r
	238	#define MAX_BIT 0x80000000\r
	239	///\r
	240	/// A value of native width with the two highest bits set.\r
	241	///\r
	242	#define MAX_2_BITS 0xC0000000\r
	243	\r
	244	///\r
	245	/// Maximum legal IA-32 address.\r
	246	///\r
	247	#define MAX_ADDRESS 0xFFFFFFFF\r
	248	\r
	249	///\r
	250	/// Maximum legal IA-32 INTN and UINTN values.\r
	251	///\r
	252	#define MAX_INTN ((INTN)0x7FFFFFFF)\r
	253	#define MAX_UINTN ((UINTN)0xFFFFFFFF)\r
	254	\r
	255	///\r
	256	/// The stack alignment required for IA-32.\r
	257	///\r
	258	#define CPU_STACK_ALIGNMENT sizeof(UINTN)\r
	259	\r
	260	///\r
	261	/// Page allocation granularity for IA-32.\r
	262	///\r
	263	#define DEFAULT_PAGE_ALLOCATION_GRANULARITY (0x1000)\r
	264	#define RUNTIME_PAGE_ALLOCATION_GRANULARITY (0x1000)\r
	265	\r
	266	//\r
	267	// Modifier to ensure that all protocol member functions and EFI intrinsics\r
	268	// use the correct C calling convention. All protocol member functions and\r
	269	// EFI intrinsics are required to modify their member functions with EFIAPI.\r
	270	//\r
	271	#ifdef EFIAPI\r
	272	///\r
	273	/// If EFIAPI is already defined, then we use that definition.\r
	274	///\r
	275	#elif defined(_MSC_EXTENSIONS)\r
	276	///\r
	277	/// Microsoft* compiler specific method for EFIAPI calling convention.\r
	278	/// \r
	279	#define EFIAPI __cdecl \r
	280	#elif defined(__GNUC__)\r
	281	///\r
	282	/// GCC specific method for EFIAPI calling convention.\r
	283	/// \r
	284	#define EFIAPI __attribute__((cdecl)) \r
	285	#else\r
	286	///\r
	287	/// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI\r
	288	/// is the standard. \r
	289	///\r
	290	#define EFIAPI\r
	291	#endif\r
	292	\r
	293	#if defined(__GNUC__)\r
	294	///\r
	295	/// For GNU assembly code, .global or .globl can declare global symbols.\r
	296	/// Define this macro to unify the usage.\r
	297	///\r
	298	#define ASM_GLOBAL .globl\r
	299	#endif\r
	300	\r
	301	/**\r
	302	Return the pointer to the first instruction of a function given a function pointer.\r
	303	On IA-32 CPU architectures, these two pointer values are the same, \r
	304	so the implementation of this macro is very simple.\r
	305	\r
	306	@param FunctionPointer A pointer to a function.\r
	307	\r
	308	@return The pointer to the first instruction of a function given a function pointer.\r
	309	\r
	310	**/\r
	311	#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
	312	\r
	313	#ifndef __USER_LABEL_PREFIX__\r
	314	#define __USER_LABEL_PREFIX__ _\r
	315	#endif\r
	316	\r
	317	#endif\r
	318	\r