Added/modified utility usage and version display.
[people/mcb30/edk2.git] / edk2 / Tools / CCode / Source / PeiRebase / PeiRebaseExe.h
1 /*++\r
2 \r
3 Copyright (c)  1999-2006 Intel Corporation. All rights reserved\r
4 This program and the accompanying materials are licensed and made available\r
5 under the terms and conditions of the BSD License which accompanies this\r
6 distribution.  The full text of the license may be found at\r
7 http://opensource.org/licenses/bsd-license.php\r
8 \r
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11 \r
12 \r
13 Module Name:\r
14 \r
15   PeiRebaseExe.h\r
16 \r
17 Abstract:\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
26 #include <Common/FirmwareVolumeImageFormat.h>\r
27 #include <Common/FirmwareFileSystem.h>\r
28 #include <Common/FirmwareVolumeHeader.h>\r
29 #include <Common/MultiPhase.h>\r
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
46 #define MAX_ARGS  7\r
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
56 VOID\r
57 Version (\r
58   VOID\r
59   )\r
60 /*++\r
61 \r
62 Routine Description:\r
63 \r
64   GC_TODO: Add function description\r
65 \r
66 Arguments:\r
67 \r
68   None\r
69 \r
70 Returns:\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
80 VOID\r
81 Usage (\r
82   VOID\r
83   )\r
84 /*++\r
85 \r
86 Routine Description:\r
87 \r
88   GC_TODO: Add function description\r
89 \r
90 Arguments:\r
91 \r
92   None\r
93 \r
94 Returns:\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
104 EFI_STATUS\r
105 FfsRebaseImageRead (\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
113 Routine Description:\r
114 \r
115   GC_TODO: Add function description\r
116 \r
117 Arguments:\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
124 Returns:\r
125 \r
126   GC_TODO: add return values\r
127 \r
128 --*/\r
129 ;\r
130 \r
131 EFI_STATUS\r
132 FfsRebase (\r
133   IN OUT  EFI_FFS_FILE_HEADER       *FfsFile,\r
134   IN      UINT32                    Flags,\r
135   IN OUT  EFI_PHYSICAL_ADDRESS      XipBase,\r
136   IN OUT  EFI_PHYSICAL_ADDRESS      *BsBase,\r
137   IN OUT  EFI_PHYSICAL_ADDRESS      *RtBase,\r
138   OUT     FILE                      *LogFile\r
139   )\r
140 /*++\r
141 \r
142 Routine Description:\r
143 \r
144   GC_TODO: Add function description\r
145 \r
146 Arguments:\r
147 \r
148   FfsFile     - GC_TODO: add argument description\r
149   BaseAddress - GC_TODO: add argument description\r
150 \r
151 Returns:\r
152 \r
153   GC_TODO: add return values\r
154 \r
155 --*/\r
156 ;\r
157 \r
158 #endif\r