ArmPkg/ArmLib.h: Fixed name of the argument

[mirror_edk2.git] / ArmPkg / Library / BasePeCoffLib / AArch64 / PeCoffLoaderEx.c

/** @file\r
  Specific relocation fixups for ARM architecture.\r
\r
  Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
  Portions copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
  Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>\r
\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
**/\r
\r
#include "BasePeCoffLibInternals.h"\r
#include <Library/BaseLib.h>\r
\r
//\r
// Note: Currently only large memory model is supported by UEFI relocation code.\r
//\r
\r
/**\r
  Performs an AARCH64-based specific relocation fixup and is a no-op on other\r
  instruction sets.\r
\r
  @param  Reloc       The pointer to the relocation record.\r
  @param  Fixup       The pointer to the address to fix up.\r
  @param  FixupData   The pointer to a buffer to log the fixups.\r
  @param  Adjust      The offset to adjust the fixup.\r
\r
  @return Status code.\r
\r
**/\r
RETURN_STATUS\r
PeCoffLoaderRelocateImageEx (\r
  IN UINT16      **Reloc,\r
  IN OUT CHAR8   *Fixup,\r
  IN OUT CHAR8   **FixupData,\r
  IN UINT64      Adjust\r
  )\r
{\r
  UINT64      *F64;\r
\r
  switch ((**Reloc) >> 12) {\r
\r
    case EFI_IMAGE_REL_BASED_DIR64:\r
      F64 = (UINT64 *) Fixup;\r
      *F64 = *F64 + (UINT64) Adjust;\r
      if (*FixupData != NULL) {\r
        *FixupData = ALIGN_POINTER(*FixupData, sizeof(UINT64));\r
        *(UINT64 *)(*FixupData) = *F64;\r
        *FixupData = *FixupData + sizeof(UINT64);\r
      }\r
      break;\r
\r
    default:\r
      return RETURN_UNSUPPORTED;\r
  }\r
\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  Returns TRUE if the machine type of PE/COFF image is supported. Supported\r
  does not mean the image can be executed it means the PE/COFF loader supports\r
  loading and relocating of the image type. It's up to the caller to support\r
  the entry point.\r
\r
  @param  Machine   Machine type from the PE Header.\r
\r
  @return TRUE if this PE/COFF loader can load the image\r
\r
**/\r
BOOLEAN\r
PeCoffLoaderImageFormatSupported (\r
  IN  UINT16  Machine\r
  )\r
{\r
  if ((Machine == IMAGE_FILE_MACHINE_ARM64) || (Machine ==  IMAGE_FILE_MACHINE_EBC)) {\r
    return TRUE;\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  Performs an ARM-based specific re-relocation fixup and is a no-op on other\r
  instruction sets. This is used to re-relocated the image into the EFI virtual\r
  space for runtime calls.\r
\r
  @param  Reloc       The pointer to the relocation record.\r
  @param  Fixup       The pointer to the address to fix up.\r
  @param  FixupData   The pointer to a buffer to log the fixups.\r
  @param  Adjust      The offset to adjust the fixup.\r
\r
  @return Status code.\r
\r
**/\r
RETURN_STATUS\r
PeHotRelocateImageEx (\r
  IN UINT16      **Reloc,\r
  IN OUT CHAR8   *Fixup,\r
  IN OUT CHAR8   **FixupData,\r
  IN UINT64      Adjust\r
  )\r
{\r
  UINT64  *Fixup64;\r
\r
  switch ((**Reloc) >> 12) {\r
  case EFI_IMAGE_REL_BASED_DIR64:\r
    Fixup64     = (UINT64 *) Fixup;\r
    *FixupData  = ALIGN_POINTER (*FixupData, sizeof (UINT64));\r
    if (*(UINT64 *) (*FixupData) == *Fixup64) {\r
      *Fixup64 = *Fixup64 + (UINT64) Adjust;\r
    }\r
\r
    *FixupData = *FixupData + sizeof (UINT64);\r
    break;\r
\r
  default:\r
    DEBUG ((EFI_D_ERROR, "PeHotRelocateEx:unknown fixed type\n"));\r
    return RETURN_UNSUPPORTED;\r
  }\r
\r
  return RETURN_SUCCESS;\r
}\r