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