Tools/Source/TianoTools/PeiRebase/PeiRebaseExe.h

   1 /*++
   2
   3 Copyright (c)  1999-2006 Intel Corporation. All rights reserved
   4 This program and the accompanying materials are licensed and made available
   5 under the terms and conditions of the BSD License which accompanies this
   6 distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12
  13 Module Name:
  14
  15   PeiRebaseExe.h
  16
  17 Abstract:
  18
  19   Definitions for the PeiRebase exe utility.
  20
  21 --*/
  22
  23 #ifndef _EFI_PEIM_FIXUP_EXE_H
  24 #define _EFI_PEIM_FIXUP_EXE_H
  25
  26 #include <Common/FirmwareVolumeImageFormat.h>
  27 #include <Common/FirmwareFileSystem.h>
  28 #include <Common/FirmwareVolumeHeader.h>
  29 #include <Common/MultiPhase.h>
  30
  31 //
  32 // Utility Name
  33 //
  34 #define UTILITY_NAME  "PeiRebase"
  35
  36 //
  37 // Utility version information
  38 //
  39 #define UTILITY_MAJOR_VERSION 0
  40 #define UTILITY_MINOR_VERSION 1
  41 #define UTILITY_DATE          __DATE__
  42
  43 //
  44 // The maximum number of arguments accepted from the command line.
  45 //
  46 #define MAX_ARGS  9
  47
  48 //
  49 // The file copy buffer size
  50 //
  51 #define FILE_COPY_BUFFER_SIZE 512
  52
  53 //
  54 // The function that displays general utility information
  55 //
  56 VOID
  57 PrintUtilityInfo (
  58   VOID
  59   )
  60 /*++
  61
  62 Routine Description:
  63
  64   GC_TODO: Add function description
  65
  66 Arguments:
  67
  68   None
  69
  70 Returns:
  71
  72   GC_TODO: add return values
  73
  74 --*/
  75 ;
  76
  77 //
  78 // The function that displays the utility usage message.
  79 //
  80 VOID
  81 PrintUsage (
  82   VOID
  83   )
  84 /*++
  85
  86 Routine Description:
  87
  88   GC_TODO: Add function description
  89
  90 Arguments:
  91
  92   None
  93
  94 Returns:
  95
  96   GC_TODO: add return values
  97
  98 --*/
  99 ;
 100
 101 //
 102 // Internal function declarations
 103 //
 104 EFI_STATUS
 105 FfsRebaseImageRead (
 106   IN     VOID    *FileHandle,
 107   IN     UINTN   FileOffset,
 108   IN OUT UINT32  *ReadSize,
 109   OUT    VOID    *Buffer
 110   )
 111 /*++
 112
 113 Routine Description:
 114
 115   GC_TODO: Add function description
 116
 117 Arguments:
 118
 119   FileHandle  - GC_TODO: add argument description
 120   FileOffset  - GC_TODO: add argument description
 121   ReadSize    - GC_TODO: add argument description
 122   Buffer      - GC_TODO: add argument description
 123
 124 Returns:
 125
 126   GC_TODO: add return values
 127
 128 --*/
 129 ;
 130
 131 EFI_STATUS
 132 FfsRebase (
 133   IN OUT EFI_FFS_FILE_HEADER    *FfsFile,
 134   IN EFI_PHYSICAL_ADDRESS       BaseAddress,
 135   IN FILE                       *MapFile      OPTIONAL
 136   )
 137 /*++
 138
 139 Routine Description:
 140
 141   GC_TODO: Add function description
 142
 143 Arguments:
 144
 145   FfsFile     - GC_TODO: add argument description
 146   BaseAddress - GC_TODO: add argument description
 147
 148 Returns:
 149
 150   GC_TODO: add return values
 151
 152 --*/
 153 ;
 154
 155 #endif