1) Add descriptions for the enum values or struc members for the following types:

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

diff --git a/MdePkg/Include/Ia32/ProcessorBind.h b/MdePkg/Include/Ia32/ProcessorBind.h
index b23b7a86f8bf95a67255d3cbb1cecbf2c60988e6..3f3fae73cf0e7c662494a1034f524bd7ca9a664f 100644 (file)
--- a/MdePkg/Include/Ia32/ProcessorBind.h
+++ b/MdePkg/Include/Ia32/ProcessorBind.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Processor or Compiler specific defines and types for x64.\r
+  Processor or Compiler specific defines and types for Ia32 architecture.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006, Intel Corporation<BR>                                                         \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
@@ -15,26 +15,31 @@
 #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
+///\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
 #endif\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
 //\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
@@ -78,7 +83,7 @@
 #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
@@ -91,7 +96,7 @@
   //\r
  \r
   #if _MSC_EXTENSIONS \r
-    \r
+\r
     //\r
     // use Microsoft* C complier dependent interger width types \r
     //\r
@@ -150,36 +155,36 @@ typedef UINT32  UINTN;
 typedef INT32   INTN;\r
 \r
 \r
-//\r
-// Processor specific defines\r
-//\r
+///\r
+/// Processor specific defines\r
+///\r
 #define MAX_BIT     0x80000000\r
 #define MAX_2_BITS  0xC0000000\r
 \r
-//\r
-// Maximum legal IA-32 address\r
-//\r
+///\r
+/// Maximum legal IA-32 address\r
+///\r
 #define MAX_ADDRESS   0xFFFFFFFF\r
 \r
-//\r
-// The stack alignment required for IA-32\r
-//\r
+///\r
+/// The stack alignment required for IA-32\r
+///\r
 #define CPU_STACK_ALIGNMENT   sizeof(UINTN)\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
+  ///\r
+  /// Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.\r
+  /// \r
   #define EFIAPI __cdecl  \r
-#endif\r
-\r
-#if __GNUC__\r
-  #define EFIAPI __attribute__((cdecl))    \r
+#else\r
+  #if __GNUC__\r
+    #define EFIAPI __attribute__((cdecl))  \r
+  #endif  \r
 #endif\r
 \r
 //\r
@@ -197,10 +202,24 @@ typedef INT32   INTN;
 // For symbol name in GNU assembly code, an extra "_" is necessary\r
 //\r
 #if __GNUC__\r
-  #define ASM_PFX(name) _##name    \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
+  Return the pointer to the first instruction of a function given a function pointer.\r
+  On IA32 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
 #endif\r
 \r