Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Include / Ipf / EfiBind.h

/*++\r
\r
Copyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>\r
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
Module Name:\r
\r
  EfiBind.h\r
\r
Abstract:\r
\r
  Processor or Compiler specific defines and types for Intel Itanium(TM).\r
  We are using the ANSI C 2000 _t type definitions for basic types.\r
  This it technically a violation of the coding standard, but they\r
  are used to make EfiTypes.h portable. Code other than EfiTypes.h\r
  should never use any ANSI C 2000 _t integer types.\r
\r
--*/\r
\r
#ifndef _EFI_BIND_H_\r
#define _EFI_BIND_H_\r
\r
\r
#define EFI_DRIVER_ENTRY_POINT(InitFunction)                 \r
\r
#define EFI_APPLICATION_ENTRY_POINT EFI_DRIVER_ENTRY_POINT\r
\r
#define ECP_CPU_IPF\r
\r
\r
//\r
// Make sure we are useing the correct packing rules per EFI specification\r
//\r
#pragma pack()\r
\r
\r
#if _MSC_EXTENSIONS \r
\r
#if __INTEL_COMPILER\r
\r
//\r
// Disable the extra ";" warning;\r
// All places referencing EFI_GUID_STRING MACRO will generate this error.\r
//\r
#pragma warning ( disable : 424 )\r
\r
//\r
// error #593: variable "Status" was set but never used\r
// This error may be flagged if a function only do ASSERT on return status when \r
// EFI_DEBUG is not defined (EDK's ASSERT will be defined as empty statement).\r
// To make EdkCompatibilityPkg buildable by ICC with EFI_DEBUG undefined, disable\r
// this warning.\r
//\r
#pragma warning ( disable : 593 )\r
\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 #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
#endif\r
\r
\r
    \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
//\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
// 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
// Int64ShllMod32 unreferenced inline function\r
//\r
#pragma warning ( disable : 4054 )\r
\r
//\r
// Unreferenced formal parameter - We are object oriented, so we pass This even\r
//  if we  don't need them.\r
//\r
#pragma warning ( disable : 4100 )\r
\r
//\r
// This warning is caused by empty (after preprocessing) souce file.\r
//\r
#pragma warning ( disable : 4206 )\r
\r
//\r
// Warning: The result of the unary '&' operator may be unaligned. Ignore it.\r
//\r
#pragma warning ( disable : 4366 )\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
\r
    //\r
    // use Microsoft C complier dependent interger width types \r
    //\r
    typedef unsigned __int64    uint64_t;\r
    typedef __int64             int64_t;\r
    typedef unsigned __int32    uint32_t;\r
    typedef __int32             int32_t;\r
    typedef unsigned short      uint16_t;\r
    typedef short               int16_t;\r
    typedef unsigned char       uint8_t;\r
    typedef char                int8_t;\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_t;\r
      typedef long long           int64_t;\r
      typedef unsigned int        uint32_t;\r
      typedef int                 int32_t;\r
      typedef unsigned short      uint16_t;\r
      typedef short               int16_t;\r
      typedef unsigned char       uint8_t;\r
      typedef char                int8_t;\r
    #else\r
      //\r
      // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.\r
      //\r
      typedef unsigned long   uint64_t;\r
      typedef long            int64_t;\r
      typedef unsigned int    uint32_t;\r
      typedef int             int32_t;\r
      typedef unsigned short  uint16_t;\r
      typedef short           int16_t;\r
      typedef unsigned char   uint8_t;\r
      typedef char            int8_t;\r
    #endif\r
  #endif\r
#else\r
  //\r
  // Use ANSI C 2000 stdint.h integer width declarations\r
  //\r
  #include "stdint.h"\r
#endif\r
\r
//\r
// Native integer size in stdint.h\r
//\r
typedef uint64_t  uintn_t;\r
typedef int64_t   intn_t;\r
\r
//\r
// Processor specific defines\r
//\r
#define EFI_MAX_BIT  0x8000000000000000\r
#define MAX_2_BITS   0xC000000000000000\r
\r
//\r
// Maximum legal Itanium-based address\r
//\r
#define EFI_MAX_ADDRESS   0xFFFFFFFFFFFFFFFF\r
\r
//\r
//  Bad pointer value to use in check builds.\r
//  if you see this value you are using uninitialized or free'ed data\r
//\r
#define EFI_BAD_POINTER          0xAFAFAFAFAFAFAFAF\r
#define EFI_BAD_POINTER_AS_BYTE  0xAF\r
\r
#define EFI_DEADLOOP()    while(TRUE)\r
\r
#ifdef __GNUC__\r
#define EFI_BREAKPOINT  EcpEfiBreakPoint\r
#define MEMORY_FENCE    EcpMemoryFence\r
#else\r
//\r
// Inject a break point in the code to assist debugging.\r
//\r
#pragma intrinsic (__break)  \r
#define EFI_BREAKPOINT()  __break(0)\r
#define EFI_DEADLOOP()    while(TRUE)\r
\r
//\r
// Memory Fence forces serialization, and is needed to support out of order\r
//  memory transactions. The Memory Fence is mainly used to make sure IO\r
//  transactions complete in a deterministic sequence, and to syncronize locks\r
//  an other MP code. Intel Itanium(TM) processors require explicit memory fence instructions\r
//  after every IO. Need to find a way of doing that in the function _mf.\r
//\r
void __mfa (void);                       \r
#pragma intrinsic (__mfa)  \r
#define MEMORY_FENCE()  __mfa()\r
#endif\r
\r
\r
//\r
// Some compilers don't support the forward reference construct:\r
//  typedef struct XXXXX. The forward reference is required for \r
//  ANSI compatibility.\r
//\r
// The following macro provide a workaround for such cases.\r
//\r
\r
\r
#ifdef EFI_NO_INTERFACE_DECL\r
  #define EFI_FORWARD_DECLARATION(x)\r
#else\r
  #define EFI_FORWARD_DECLARATION(x) typedef struct _##x x\r
#endif\r
\r
//\r
// Some C compilers optimize the calling conventions to increase performance.\r
// _EFIAPI is used to make all public APIs follow the standard C calling \r
// convention.\r
//\r
\r
#if _MSC_EXTENSIONS \r
  #define _EFIAPI __cdecl  \r
#else\r
  #define _EFIAPI       \r
#endif\r
\r
\r
#ifdef _EFI_WINNT\r
\r
  #define EFI_SUPPRESS_BENIGN_REDEFINITION_OF_TYPE_WARNING()  \\r
           warning ( disable : 4142 )\r
\r
  #define EFI_DEFAULT_BENIGN_REDEFINITION_OF_TYPE_WARNING()  \\r
           warning ( default : 4142 )\r
#else\r
\r
  #define EFI_SUPPRESS_BENIGN_REDEFINITION_OF_TYPE_WARNING()  \\r
           warning ( disable : 4068 )\r
\r
  #define EFI_DEFAULT_BENIGN_REDEFINITION_OF_TYPE_WARNING()  \\r
           warning ( default : 4068 )\r
\r
\r
#endif\r
\r
\r
#endif\r
\r