BaseTools/Source/C/Include/AArch64/ProcessorBind.h

   1 /** @file
   2   Processor or Compiler specific defines and types for AArch64.
   3
   4   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   5   Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
   6   Portions copyright (c) 2013, ARM Ltd. All rights reserved.<BR>
   7
   8   This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16 **/
  17
  18 #ifndef __PROCESSOR_BIND_H__
  19 #define __PROCESSOR_BIND_H__
  20
  21 ///
  22 /// Define the processor type so other code can make processor based choices
  23 ///
  24 #define MDE_CPU_AARCH64
  25
  26 //
  27 // Make sure we are using the correct packing rules per EFI specification
  28 //
  29 #ifndef __GNUC__
  30 #pragma pack()
  31 #endif
  32
  33 #if _MSC_EXTENSIONS
  34   //
  35   // use Microsoft* C complier dependent integer width types
  36   //
  37   typedef unsigned __int64    UINT64;
  38   typedef __int64             INT64;
  39   typedef unsigned __int32    UINT32;
  40   typedef __int32             INT32;
  41   typedef unsigned short      UINT16;
  42   typedef unsigned short      CHAR16;
  43   typedef short               INT16;
  44   typedef unsigned char       BOOLEAN;
  45   typedef unsigned char       UINT8;
  46   typedef char                CHAR8;
  47   typedef signed char         INT8;
  48 #else
  49   //
  50   // Assume standard AARCH64 alignment.
  51   //
  52   typedef unsigned long long  UINT64;
  53   typedef long long           INT64;
  54   typedef unsigned int        UINT32;
  55   typedef int                 INT32;
  56   typedef unsigned short      UINT16;
  57   typedef unsigned short      CHAR16;
  58   typedef short               INT16;
  59   typedef unsigned char       BOOLEAN;
  60   typedef unsigned char       UINT8;
  61   typedef char                CHAR8;
  62   typedef signed char         INT8;
  63
  64   #define UINT8_MAX 0xff
  65 #endif
  66
  67 ///
  68 /// Unsigned value of native width.  (4 bytes on supported 32-bit processor instructions,
  69 /// 8 bytes on supported 64-bit processor instructions)
  70 ///
  71 typedef UINT64  UINTN;
  72
  73 ///
  74 /// Signed value of native width.  (4 bytes on supported 32-bit processor instructions,
  75 /// 8 bytes on supported 64-bit processor instructions)
  76 ///
  77 typedef INT64   INTN;
  78
  79 //
  80 // Processor specific defines
  81 //
  82
  83 ///
  84 /// A value of native width with the highest bit set.
  85 ///
  86 #define MAX_BIT      0x8000000000000000
  87
  88 ///
  89 /// A value of native width with the two highest bits set.
  90 ///
  91 #define MAX_2_BITS   0xC000000000000000
  92
  93 ///
  94 /// The stack alignment required for AARCH64
  95 ///
  96 #define CPU_STACK_ALIGNMENT  16
  97
  98 //
  99 // Modifier to ensure that all protocol member functions and EFI intrinsics
 100 // use the correct C calling convention. All protocol member functions and
 101 // EFI intrinsics are required to modify their member functions with EFIAPI.
 102 //
 103 #define EFIAPI
 104
 105 #if defined(__GNUC__)
 106   ///
 107   /// For GNU assembly code, .global or .globl can declare global symbols.
 108   /// Define this macro to unify the usage.
 109   ///
 110   #define ASM_GLOBAL .globl
 111
 112   #if !defined(__APPLE__)
 113     ///
 114     /// ARM EABI defines that the linker should not manipulate call relocations
 115     /// (do bl/blx conversion) unless the target symbol has function type.
 116     /// CodeSourcery 2010.09 started requiring the .type to function properly
 117     ///
 118     #define INTERWORK_FUNC(func__)   .type ASM_PFX(func__), %function
 119
 120     #define GCC_ASM_EXPORT(func__)  \
 121              .global  _CONCATENATE (__USER_LABEL_PREFIX__, func__)    ;\
 122              .type ASM_PFX(func__), %function
 123
 124     #define GCC_ASM_IMPORT(func__)  \
 125              .extern  _CONCATENATE (__USER_LABEL_PREFIX__, func__)
 126
 127   #else
 128     //
 129     // .type not supported by Apple Xcode tools
 130     //
 131     #define INTERWORK_FUNC(func__)
 132
 133     #define GCC_ASM_EXPORT(func__)  \
 134              .globl  _CONCATENATE (__USER_LABEL_PREFIX__, func__)    \
 135
 136     #define GCC_ASM_IMPORT(name)
 137
 138   #endif
 139 #endif
 140
 141 /**
 142   Return the pointer to the first instruction of a function given a function pointer.
 143   On ARM CPU architectures, these two pointer values are the same,
 144   so the implementation of this macro is very simple.
 145
 146   @param  FunctionPointer   A pointer to a function.
 147
 148   @return The pointer to the first instruction of a function given a function pointer.
 149
 150 **/
 151 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)
 152
 153 #endif
 154