]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Ebc/ProcessorBind.h
MdePkg/ProcessorBind: add defines for page allocation granularity
[mirror_edk2.git] / MdePkg / Include / Ebc / ProcessorBind.h
index 2e254ffb04ab609101fbffdf4a65c863fe45156b..da8b1a6d802a995420fd833e8cb69c1f0c1af59b 100644 (file)
@@ -1,17 +1,17 @@
 /** @file\r
   Processor or compiler specific defines and types for EBC.\r
 \r
-  We currently only have one EBC complier so there may be some Intel compiler\r
+  We currently only have one EBC compiler so there may be some Intel compiler\r
   specific functions in this file.\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 - 2013, 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
 //\r
 // Native integer types\r
 //\r
-typedef char                  INT8;\r
+\r
+///\r
+/// 1-byte signed value\r
+///\r
+typedef signed char           INT8;\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
+///\r
+/// 2-byte signed value.\r
+///\r
 typedef short                 INT16;\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
+///\r
+/// 4-byte signed value.\r
+///\r
 typedef int                   INT32;\r
+///\r
+/// 4-byte unsigned value.\r
+///\r
 typedef unsigned int          UINT32;\r
-\r
+///\r
+/// 8-byte signed value.\r
+///\r
 typedef __int64               INT64;\r
+///\r
+/// 8-byte unsigned value.\r
+///\r
 typedef unsigned __int64      UINT64;\r
 \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
 /// "long" type scales to the processor native size with EBC compiler\r
 ///\r
 typedef long                  INTN;\r
+///\r
+/// The unsigned value of native width.  (4 bytes on supported 32-bit processor instructions;\r
+/// 8 bytes on supported 64-bit processor instructions)\r
+/// "long" type scales to the processor native size with the EBC compiler.\r
+///\r
 typedef unsigned long         UINTN;\r
 \r
-#define UINT8_MAX 0xff\r
-\r
 ///\r
-/// Scalable macro to set the most significant bit in a natural number\r
+/// A value of native width with the highest bit set.\r
+/// Scalable macro to set the most significant bit in a natural number.\r
 ///\r
 #define MAX_BIT     (1ULL << (sizeof (INTN) * 8 - 1)) \r
+///\r
+/// A value of native width with the two highest bits set.\r
+/// Scalable macro to set the most 2 significant bits in a natural number.\r
+///\r
 #define MAX_2_BITS  (3ULL << (sizeof (INTN) * 8 - 2))\r
 \r
 ///\r
@@ -60,26 +103,50 @@ typedef unsigned long         UINTN;
 ///\r
 #define MAX_ADDRESS   ((UINTN) ~0)\r
 \r
+///\r
+/// Maximum legal EBC INTN and UINTN values.\r
+///\r
+#define MAX_UINTN  ((UINTN) ~0)\r
+#define MAX_INTN   ((INTN)~MAX_BIT)\r
+\r
 ///\r
 /// The stack alignment required for EBC\r
 ///\r
 #define CPU_STACK_ALIGNMENT   sizeof(UINTN)\r
 \r
+///\r
+/// Page allocation granularity for EBC\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 thier member functions with EFIAPI.\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
+#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. Currently not supported by the EBC compiler\r
-///\r
-#define GLOBAL_REMOVE_IF_UNREFERENCED\r
+/**\r
+  Return the pointer to the first instruction of a function given a function pointer.\r
+  On EBC 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
+#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
 \r
-#define FUNCTION_ENTRY_POINT(p) (p)\r
+#ifndef __USER_LABEL_PREFIX__\r
+#define __USER_LABEL_PREFIX__\r
+#endif\r
 \r
 #endif \r
 \r