Tools/Source/TianoTools/PeiRebase/PeiRebaseExe.h

   1 /*++
   2
   3 Copyright (c)  1999 - 2002 Intel Corporation. All rights reserved
   4 This software and associated documentation (if any) is furnished
   5 under a license and may only be used or copied in accordance
   6 with the terms of the license. Except as permitted by such
   7 license, no part of this software or documentation may be
   8 reproduced, stored in a retrieval system, or transmitted in any
   9 form or by any means without the express written consent of
  10 Intel Corporation.
  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 "Efi2WinNt.h"
  27 #include "EfiFirmwareFileSystem.h"
  28 #include "EfiFirmwareVolumeHeader.h"
  29
  30 //
  31 // Utility Name
  32 //
  33 #define UTILITY_NAME  "PeiRebase"
  34
  35 //
  36 // Utility version information
  37 //
  38 #define UTILITY_MAJOR_VERSION 0
  39 #define UTILITY_MINOR_VERSION 1
  40 #define UTILITY_DATE          __DATE__
  41
  42 //
  43 // The maximum number of arguments accepted from the command line.
  44 //
  45 #define MAX_ARGS  7
  46
  47 //
  48 // The file copy buffer size
  49 //
  50 #define FILE_COPY_BUFFER_SIZE 512
  51
  52 //
  53 // The function that displays general utility information
  54 //
  55 VOID
  56 PrintUtilityInfo (
  57   VOID
  58   )
  59 /*++
  60
  61 Routine Description:
  62
  63   GC_TODO: Add function description
  64
  65 Arguments:
  66
  67   None
  68
  69 Returns:
  70
  71   GC_TODO: add return values
  72
  73 --*/
  74 ;
  75
  76 //
  77 // The function that displays the utility usage message.
  78 //
  79 VOID
  80 PrintUsage (
  81   VOID
  82   )
  83 /*++
  84
  85 Routine Description:
  86
  87   GC_TODO: Add function description
  88
  89 Arguments:
  90
  91   None
  92
  93 Returns:
  94
  95   GC_TODO: add return values
  96
  97 --*/
  98 ;
  99
 100 //
 101 // Internal function declarations
 102 //
 103 EFI_STATUS
 104 FfsRebaseImageRead (
 105   IN     VOID    *FileHandle,
 106   IN     UINTN   FileOffset,
 107   IN OUT UINT32  *ReadSize,
 108   OUT    VOID    *Buffer
 109   )
 110 /*++
 111
 112 Routine Description:
 113
 114   GC_TODO: Add function description
 115
 116 Arguments:
 117
 118   FileHandle  - GC_TODO: add argument description
 119   FileOffset  - GC_TODO: add argument description
 120   ReadSize    - GC_TODO: add argument description
 121   Buffer      - GC_TODO: add argument description
 122
 123 Returns:
 124
 125   GC_TODO: add return values
 126
 127 --*/
 128 ;
 129
 130 EFI_STATUS
 131 FfsRebase (
 132   IN OUT EFI_FFS_FILE_HEADER    *FfsFile,
 133   IN EFI_PHYSICAL_ADDRESS       BaseAddress
 134   )
 135 /*++
 136
 137 Routine Description:
 138
 139   GC_TODO: Add function description
 140
 141 Arguments:
 142
 143   FfsFile     - GC_TODO: add argument description
 144   BaseAddress - GC_TODO: add argument description
 145
 146 Returns:
 147
 148   GC_TODO: add return values
 149
 150 --*/
 151 ;
 152
 153 #endif