/** @file\r
- Processor or Compiler specific defines and types for Ia32 architecture.\r
+ Processor or Compiler specific defines and types for IA-32 architecture.\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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#define __PROCESSOR_BIND_H__\r
\r
///\r
-/// Define the processor type so other code can make processor based choices\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 useing the correct packing rules per EFI specification\r
+// Make sure we are using the correct packing rules per EFI specification\r
//\r
-#ifndef __GNUC__\r
-#pragma pack()\r
+#if !defined (__GNUC__)\r
+ #pragma pack()\r
#endif\r
\r
-#if __INTEL_COMPILER\r
-//\r
-// Disable ICC's remark #593: "LocalVariable" was set but never used\r
-// This is legal ANSI C code so we disable the remark that is turned on with -Wall\r
-//\r
-#pragma warning ( disable : 593 )\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
+ #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
+ #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
+ #pragma warning ( disable : 1419 )\r
\r
-#endif\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
-#if _MSC_EXTENSIONS\r
+#if defined (_MSC_EXTENSIONS)\r
\r
//\r
// Disable warning that make it impossible to compile at /W4\r
//\r
// Disabling bitfield type checking warnings.\r
//\r
-#pragma warning ( disable : 4214 )\r
+ #pragma warning ( disable : 4214 )\r
\r
//\r
// Disabling the unreferenced formal parameter warnings.\r
//\r
-#pragma warning ( disable : 4100 )\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
+ #pragma warning ( disable : 4057 )\r
\r
//\r
-// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
+// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning\r
//\r
-#pragma warning ( disable : 4127 )\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
+ #pragma warning ( disable : 4505 )\r
\r
//\r
-// This warning is caused by empty (after preprocessing) souce file. For precompiled header only.\r
+// This warning is caused by empty (after preprocessing) source file. For precompiled header only.\r
//\r
-#pragma warning ( disable : 4206 )\r
+ #pragma warning ( disable : 4206 )\r
\r
-#endif\r
+ #if defined (_MSC_VER) && _MSC_VER >= 1800\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
-#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
- //\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
-\r
- //\r
- // Assume standard IA-32 alignment. \r
- // Need to check portability of long long\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 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
\r
- #define UINT8_MAX 0xff\r
+#endif\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
+#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
-typedef UINT32 UINTN;\r
-typedef INT32 INTN;\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
-/// Processor specific defines\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_BIT 0x80000000\r
#define MAX_2_BITS 0xC0000000\r
\r
///\r
-/// Maximum legal IA-32 address\r
+/// Maximum legal IA-32 address.\r
+///\r
+#define MAX_ADDRESS 0xFFFFFFFF\r
+\r
+///\r
+/// Maximum usable address at boot time\r
+///\r
+#define MAX_ALLOC_ADDRESS MAX_ADDRESS\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
+/// Minimum legal IA-32 INTN value.\r
+///\r
+#define MIN_INTN (((INTN)-2147483647) - 1)\r
+\r
+///\r
+/// The stack alignment required for IA-32.\r
///\r
-#define MAX_ADDRESS 0xFFFFFFFF\r
+#define CPU_STACK_ALIGNMENT sizeof(UINTN)\r
\r
///\r
-/// The stack alignment required for IA-32\r
+/// Page allocation granularity for IA-32.\r
///\r
-#define CPU_STACK_ALIGNMENT sizeof(UINTN)\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 thier member functions with EFIAPI.\r
+// EFI intrinsics are required to modify their 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
+#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__) || defined (__clang__)\r
+///\r
+/// GCC specific method for EFIAPI calling convention.\r
+///\r
+#define EFIAPI __attribute__((cdecl))\r
#else\r
- #if __GNUC__\r
- #define EFIAPI __attribute__((cdecl)) \r
- #endif \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
+#if defined (__GNUC__) || defined (__clang__)\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
-// 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
+ 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
-#define FUNCTION_ENTRY_POINT(p) (p)\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