]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Ipf/ProcessorBind.h
MdePkg/ProcessorBind: add defines for page allocation granularity
[mirror_edk2.git] / MdePkg / Include / Ipf / ProcessorBind.h
index c184125da19551c9748c7a70161033d81bd83388..51885ca6135941c5e3d45183ed9126fe772ff840 100644 (file)
@@ -1,14 +1,14 @@
 /** @file\r
-  Processor or Compiler specific defines and types for Intel Itanium(TM).\r
+  Processor or Compiler specific defines and types for Intel Itanium(TM) processors.\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
+Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available \r
+under the terms and conditions of the BSD License which accompanies this\r
+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
+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
 #define __PROCESSOR_BIND_H__\r
 \r
 \r
-//\r
-// Define the processor type so other code can make processor based choices\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
+// Make sure we are using the correct packing rules per EFI specification\r
 //\r
 #pragma pack()\r
 \r
 \r
-#if _MSC_EXTENSIONS\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
 // 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
+// This only works for Microsoft* tools\r
 //\r
 \r
 //\r
@@ -41,7 +67,7 @@
 //\r
 #pragma warning ( disable : 4214 )\r
 \r
-\r
+//\r
 // Disabling the unreferenced formal parameter warnings.\r
 //\r
 #pragma warning ( disable : 4100 )\r
 #pragma warning ( disable : 4054 )\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
 \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
+// Itanium processors to get access to the PLABEL.\r
 //\r
 #pragma warning ( disable : 4514 )\r
 \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
 \r
 #endif\r
 \r
-\r
-#if (__STDC_VERSION__ < 199901L)\r
+#if defined(_MSC_EXTENSIONS)\r
   //\r
-  // No ANSI C 2000 stdint.h integer width declarations, so define equivalents\r
+  // use Microsoft C compiler dependent integer width types\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
+  ///\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
-  // 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
+  ///\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 UINT64  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 INT64   INTN;\r
 \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     0x8000000000000000ULL\r
+///\r
+/// A value of native width with the two highest bits set.\r
+///\r
 #define MAX_2_BITS  0xC000000000000000ULL\r
 \r
-//\r
-// Maximum legal Itanium-based address\r
-//\r
+///\r
+/// The 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
+///\r
+/// Maximum legal Itanium-based INTN and UINTN values.\r
+///\r
+#define MAX_INTN   ((INTN)0x7FFFFFFFFFFFFFFFULL)\r
+#define MAX_UINTN  ((UINTN)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
+/// Page allocation granularity for Itanium\r
+///\r
+#define DEFAULT_PAGE_ALLOCATION_GRANULARITY   (0x1000)\r
+#define RUNTIME_PAGE_ALLOCATION_GRANULARITY   (0x2000)\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
+// 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
 #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
-// For IPF boot mode\r
-//\r
-#define RECOVERY_CHECK_CALL 0x3\r
-#define NORMAL_BOOT_CALL    0x0\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
 \r
-//\r
-// A pointer to a function in IPF points to a plabel.\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
+///\r
+/// PAL Call return structure.\r
+///\r
 typedef struct {\r
   UINT64                    Status;\r
   UINT64                    r9;\r
@@ -226,5 +296,24 @@ typedef struct {
   UINT64                    r11;\r
 } PAL_CALL_RETURN;\r
 \r
+/**\r
+  Return the pointer to the first instruction of a function given a function pointer.\r
+  For Itanium processors, all function calls are made through a PLABEL, so a pointer to a function \r
+  is actually a pointer to a PLABEL.  The pointer to the first instruction of the function \r
+  is contained within the PLABEL.  This macro may be used to retrieve a pointer to the first \r
+  instruction of a function independent of the CPU architecture being used.  This is very \r
+  useful when printing function addresses through DEBUG() macros.\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)(((EFI_PLABEL *)(FunctionPointer))->EntryPoint)\r
+\r
+#ifndef __USER_LABEL_PREFIX__\r
+#define __USER_LABEL_PREFIX__\r
+#endif\r
+\r
 #endif\r
 \r