UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

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

/** @file\r
  Processor or Compiler specific defines and types for ARM.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#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
#define MDE_CPU_ARM\r
\r
//\r
// Make sure we are using the correct packing rules per EFI specification\r
//\r
#if !defined (__GNUC__) && !defined (__ASSEMBLER__)\r
  #pragma pack()\r
#endif\r
\r
#if defined (_MSC_EXTENSIONS)\r
\r
//\r
// Disable some level 4 compilation warnings (same as IA32 and X64)\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 constructs so suppress this warning\r
//\r
  #pragma warning ( disable : 4127 )\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
//\r
// Disable 'potentially uninitialized local variable X used' warnings\r
//\r
  #pragma warning ( disable : 4701 )\r
\r
//\r
// Disable 'potentially uninitialized local pointer variable X used' warnings\r
//\r
  #pragma warning ( disable : 4703 )\r
\r
#endif\r
\r
//\r
// MSFT doesn't support the __builtin_unreachable() macro\r
//\r
#if defined (_MSC_EXTENSIONS)\r
#define UNREACHABLE()\r
#endif\r
\r
#if defined (_MSC_EXTENSIONS)\r
//\r
// use Microsoft* C compiler 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 signed char       INT8;\r
#else\r
//\r
// Assume standard ARM alignment.\r
// Need to check portability of long long\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      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 signed char         INT8;\r
#endif\r
\r
///\r
/// Unsigned value of native width.  (4 bytes on supported 32-bit processor instructions,\r
/// 8 bytes on supported 64-bit processor instructions)\r
///\r
typedef UINT32 UINTN;\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
///\r
typedef INT32 INTN;\r
\r
//\r
// Processor specific defines\r
//\r
\r
///\r
/// A value of native width with the highest bit set.\r
///\r
#define MAX_BIT  0x80000000\r
\r
///\r
/// A value of native width with the two highest bits set.\r
///\r
#define MAX_2_BITS  0xC0000000\r
\r
///\r
/// Maximum legal ARM address\r
///\r
#define MAX_ADDRESS  0xFFFFFFFF\r
\r
///\r
/// Maximum usable address at boot time\r
///\r
#define MAX_ALLOC_ADDRESS  MAX_ADDRESS\r
\r
///\r
/// Maximum legal ARM INTN and UINTN values.\r
///\r
#define MAX_INTN   ((INTN)0x7FFFFFFF)\r
#define MAX_UINTN  ((UINTN)0xFFFFFFFF)\r
\r
///\r
/// Minimum legal ARM INTN value.\r
///\r
#define MIN_INTN  (((INTN)-2147483647) - 1)\r
\r
///\r
/// The stack alignment required for ARM\r
///\r
#define CPU_STACK_ALIGNMENT  sizeof(UINT64)\r
\r
///\r
/// Page allocation granularity for ARM\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 their member functions with EFIAPI.\r
//\r
#define EFIAPI\r
\r
// When compiling with Clang, we still use GNU as for the assembler, so we still\r
// need to define the GCC_ASM* macros.\r
#if defined (__GNUC__) || defined (__clang__)\r
///\r
/// For GNU assembly code, .global or .globl can declare global symbols.\r
/// Define this macro to unify the usage.\r
///\r
#define ASM_GLOBAL  .globl\r
\r
  #if !defined (__APPLE__)\r
///\r
/// ARM EABI defines that the linker should not manipulate call relocations\r
/// (do bl/blx conversion) unless the target symbol has function type.\r
/// CodeSourcery 2010.09 started requiring the .type to function properly\r
///\r
#define INTERWORK_FUNC(func__)  .type ASM_PFX(func__), %function\r
\r
#define GCC_ASM_EXPORT(func__)  \\r
             .global  _CONCATENATE (__USER_LABEL_PREFIX__, func__)    ;\\r
             .type ASM_PFX(func__), %function\r
\r
#define GCC_ASM_IMPORT(func__)  \\r
             .extern  _CONCATENATE (__USER_LABEL_PREFIX__, func__)\r
\r
  #else\r
//\r
// .type not supported by Apple Xcode tools\r
//\r
#define INTERWORK_FUNC(func__)\r
\r
#define GCC_ASM_EXPORT(func__)  \\r
             .globl  _CONCATENATE (__USER_LABEL_PREFIX__, func__)    \\r
\r
#define GCC_ASM_IMPORT(name)\r
\r
  #endif\r
#elif defined (_MSC_EXTENSIONS)\r
//\r
// PRESERVE8 is not supported by the MSFT assembler.\r
//\r
#define PRESERVE8\r
#endif\r
\r
/**\r
  Return the pointer to the first instruction of a function given a function pointer.\r
  On ARM 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
#ifndef __USER_LABEL_PREFIX__\r
#define __USER_LABEL_PREFIX__\r
#endif\r
\r
#endif\r