3694b1516a378f9fc2165559580bde3361c5b5e3
[people/mcb30/edk2.git] / edk2 / Tools / CCode / Source / SecFixup / SecFixup.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   SecFixup.h\r
16 \r
17 Abstract:\r
18 \r
19   Definitions for the SecFixup utility.\r
20 \r
21 --*/\r
22 \r
23 #ifndef _SEC_FIXUP_H\r
24 #define _SEC_FIXUP_H\r
25 \r
26 //\r
27 // Utility Name\r
28 //\r
29 #define UTILITY_NAME  "SecFixup"\r
30 \r
31 //\r
32 // Utility version information\r
33 //\r
34 #define UTILITY_MAJOR_VERSION 0\r
35 #define UTILITY_MINOR_VERSION 1\r
36 #define UTILITY_DATE          __DATE__\r
37 \r
38 //\r
39 // The maximum number of arguments accepted from the command line.\r
40 //\r
41 #define MAX_ARGS        4\r
42 \r
43 #define DEST_REL_OFFSET 13\r
44 #define BUF_SIZE        (8 * 1024)\r
45 \r
46 //\r
47 // The function that displays general utility information\r
48 //\r
49 VOID\r
50 PrintUtilityInfo (\r
51   VOID\r
52   )\r
53 /*++\r
54 \r
55 Routine Description:\r
56 \r
57   GC_TODO: Add function description\r
58 \r
59 Arguments:\r
60 \r
61   None\r
62 \r
63 Returns:\r
64 \r
65   GC_TODO: add return values\r
66 \r
67 --*/\r
68 ;\r
69 \r
70 //\r
71 // The function that displays the utility usage message.\r
72 //\r
73 VOID\r
74 PrintUsage (\r
75   VOID\r
76   )\r
77 /*++\r
78 \r
79 Routine Description:\r
80 \r
81   GC_TODO: Add function description\r
82 \r
83 Arguments:\r
84 \r
85   None\r
86 \r
87 Returns:\r
88 \r
89   GC_TODO: add return values\r
90 \r
91 --*/\r
92 ;\r
93 \r
94 //\r
95 // The function that gets the entry point of a PE/TE file.\r
96 //\r
97 STATUS\r
98 GetEntryPoint (\r
99   IN  FILE   *ExeFile,\r
100   OUT UINT32 *EntryPoint\r
101   )\r
102 /*++\r
103 \r
104 Routine Description:\r
105 \r
106   GC_TODO: Add function description\r
107 \r
108 Arguments:\r
109 \r
110   ExeFile     - GC_TODO: add argument description\r
111   EntryPoint  - GC_TODO: add argument description\r
112 \r
113 Returns:\r
114 \r
115   GC_TODO: add return values\r
116 \r
117 --*/\r
118 ;\r
119 \r
120 //\r
121 // The function that copies a file.\r
122 //\r
123 STATUS\r
124 CopyFile (\r
125   FILE    *FpIn,\r
126   FILE    *FpOut\r
127   )\r
128 /*++\r
129 \r
130 Routine Description:\r
131 \r
132   GC_TODO: Add function description\r
133 \r
134 Arguments:\r
135 \r
136   FpIn  - GC_TODO: add argument description\r
137   FpOut - GC_TODO: add argument description\r
138 \r
139 Returns:\r
140 \r
141   GC_TODO: add return values\r
142 \r
143 --*/\r
144 ;\r
145 \r
146 #endif\r