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

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

/** @file\r
  Processor or Compiler specific defines and types for Intel Itanium(TM).\r
\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
  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
///\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 using the correct packing rules per EFI specification\r
//\r
#pragma pack()\r
\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
// 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
#endif\r
\r
\r
#if _MSC_EXTENSIONS\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
// Disable warning on conversion from function pointer to a data pointer\r
//\r
#pragma warning ( disable : 4054 )\r
\r
//\r
// ASSERT(FALSE) or while (TRUE) are legal constructes so supress 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
//\r
#pragma warning ( disable : 4514 )\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
#endif\r
\r
\r
#if (__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
    // use Microsoft C complier dependent integer 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 - pointers being 64-bit and longs and ints 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
#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
#endif\r
\r
typedef UINT64  UINTN;\r
typedef INT64   INTN;\r
\r
\r
//\r
// Processor specific defines\r
//\r
#define MAX_BIT     0x8000000000000000ULL\r
#define MAX_2_BITS  0xC000000000000000ULL\r
\r
//\r
// 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
#define CPU_STACK_ALIGNMENT   16\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
#if _MSC_EXTENSIONS\r
  //\r
  // Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.\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
/// 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
typedef struct {\r
  UINT64                    Status;\r
  UINT64                    r9;\r
  UINT64                    r10;\r
  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 CPUs, 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
#endif\r
\r