MdePkg/Library/BasePeCoffLib/x64/PeCoffLoaderEx.c

   1 /** @file
   2   x64 Specific relocation fixups.
   3
   4 Copyright (c) 2005 - 2006 Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 //
  16 // Include common header file for this module.
  17 //
  18 #include "CommonHeader.h"
  19
  20 /**
  21   Performs an x64 specific relocation fixup.
  22
  23   @param  Reloc       Pointer to the relocation record
  24   @param  Fixup       Pointer to the address to fix up
  25   @param  FixupData   Pointer to a buffer to log the fixups
  26   @param  Adjust      The offset to adjust the fixup
  27
  28   @retval RETURN_SUCCESS      Success to perform relocation
  29   @retval RETURN_UNSUPPORTED  Unsupported.
  30 **/
  31 RETURN_STATUS
  32 PeCoffLoaderRelocateImageEx (
  33   IN     UINT16       *Reloc,
  34   IN OUT CHAR8        *Fixup,
  35   IN OUT CHAR8        **FixupData,
  36   IN     UINT64       Adjust
  37   )
  38 {
  39   return RETURN_UNSUPPORTED;
  40 }
  41
  42 /**
  43   Returns TRUE if the machine type of PE/COFF image is supported. Supported
  44   does not mean the image can be executed it means the PE/COFF loader supports
  45   loading and relocating of the image type. It's up to the caller to support
  46   the entry point.
  47
  48   This function implies the basic PE/COFF loader/relocator supports IA32, EBC,
  49   & X64 images. Calling the entry point in a correct mannor is up to the
  50   consumer of this library.
  51
  52   @param  Machine   Machine type from the PE Header.
  53
  54   @return TRUE if this PE/COFF loader can load the image
  55
  56 **/
  57 BOOLEAN
  58 PeCoffLoaderImageFormatSupported (
  59   IN  UINT16  Machine
  60   )
  61 {
  62   if ((Machine == EFI_IMAGE_MACHINE_IA32) || (Machine == EFI_IMAGE_MACHINE_X64) ||
  63       (Machine ==  EFI_IMAGE_MACHINE_EBC)) {
  64     return TRUE;
  65   }
  66
  67   return FALSE;
  68 }
  69
  70
  71 /**
  72   Performs an X64 specific re-relocation fixup and is a no-op on other
  73   instruction sets. This is used to re-relocated the image into the EFI virtual
  74   space for runtime calls.
  75
  76   @param  Reloc       Pointer to the relocation record.
  77   @param  Fixup       Pointer to the address to fix up.
  78   @param  FixupData   Pointer to a buffer to log the fixups.
  79   @param  Adjust      The offset to adjust the fixup.
  80
  81   @return Status code.
  82
  83 **/
  84 RETURN_STATUS
  85 PeHotRelocateImageEx (
  86   IN UINT16      *Reloc,
  87   IN OUT CHAR8   *Fixup,
  88   IN OUT CHAR8   **FixupData,
  89   IN UINT64      Adjust
  90   )
  91 {
  92   return RETURN_UNSUPPORTED;
  93 }