606e147f0798adeb1d913518bd1bf41cc73f4e12
[people/mcb30/basetools.git] / Source / C / GenFv / GenFvInternalLib.h
1 /*++\r
2 \r
3 Copyright (c) 2004, Intel Corporation                                                         \r
4 All rights reserved. This program and the accompanying materials                          \r
5 are licensed and made available under the terms and conditions of the BSD License         \r
6 which accompanies this 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 Module Name:\r
13   \r
14   GenFvInternalLib.h\r
15 \r
16 Abstract:\r
17 \r
18   This file contains describes the public interfaces to the GenFvImage Library.\r
19   The basic purpose of the library is to create Firmware Volume images.\r
20 \r
21 --*/\r
22 \r
23 #ifndef _EFI_GEN_FV_INTERNAL_LIB_H\r
24 #define _EFI_GEN_FV_INTERNAL_LIB_H\r
25 \r
26 //\r
27 // Include files\r
28 //\r
29 #include <stdlib.h>\r
30 \r
31 #include <Common/UefiBaseTypes.h>\r
32 #include <Common/MultiPhase.h>\r
33 \r
34 #include <Common/FirmwareVolumeImageFormat.h>\r
35 #include <Common/PiFirmwareVolumeHeader.h>\r
36 #include <Common/PiFirmwareFileSystem.h>\r
37 #include <Guid/PiFirmwareFileSystem.h>\r
38 \r
39 #include <Common/EfiImage.h>\r
40 #include <Library/PeCoffLib.h>\r
41 \r
42 #include "CommonLib.h"\r
43 #include "ParseInf.h"\r
44 \r
45 //\r
46 // Private data declarations\r
47 //\r
48 \r
49 //\r
50 // Different file separater for Linux and Windows\r
51 //\r
52 #ifdef __GNUC__\r
53 #define FILE_SEP_CHAR '/'\r
54 #define FILE_SEP_STRING "/"\r
55 #else\r
56 #define FILE_SEP_CHAR '\\'\r
57 #define FILE_SEP_STRING "\\"\r
58 #endif\r
59 \r
60 //\r
61 // The maximum number of block map entries supported by the library\r
62 //\r
63 #define MAX_NUMBER_OF_FV_BLOCKS         100\r
64 \r
65 //\r
66 // The maximum number of files in the FV supported by the library\r
67 //\r
68 #define MAX_NUMBER_OF_FILES_IN_FV       1000\r
69 #define EFI_FFS_FILE_HEADER_ALIGNMENT   8\r
70 \r
71 //\r
72 // INF file strings\r
73 //\r
74 #define OPTIONS_SECTION_STRING            "[options]"\r
75 #define ATTRIBUTES_SECTION_STRING         "[attributes]"\r
76 #define FILES_SECTION_STRING              "[files]"\r
77 \r
78 //\r
79 // Options section\r
80 //\r
81 #define EFI_FV_BASE_ADDRESS_STRING        "EFI_BASE_ADDRESS"\r
82 #define EFI_FV_FILE_NAME_STRING           "EFI_FILE_NAME"\r
83 #define EFI_NUM_BLOCKS_STRING             "EFI_NUM_BLOCKS"\r
84 #define EFI_BLOCK_SIZE_STRING             "EFI_BLOCK_SIZE"\r
85 #define EFI_FV_GUID_STRING                "EFI_FV_GUID"\r
86 \r
87 //\r
88 // Attributes section\r
89 //\r
90 #define EFI_FVB2_READ_DISABLED_CAP_STRING  "EFI_READ_DISABLED_CAP"\r
91 #define EFI_FVB2_READ_ENABLED_CAP_STRING   "EFI_READ_ENABLED_CAP"\r
92 #define EFI_FVB2_READ_STATUS_STRING        "EFI_READ_STATUS"\r
93 \r
94 #define EFI_FVB2_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP"\r
95 #define EFI_FVB2_WRITE_ENABLED_CAP_STRING  "EFI_WRITE_ENABLED_CAP"\r
96 #define EFI_FVB2_WRITE_STATUS_STRING       "EFI_WRITE_STATUS"\r
97 \r
98 #define EFI_FVB2_LOCK_CAP_STRING           "EFI_LOCK_CAP"\r
99 #define EFI_FVB2_LOCK_STATUS_STRING        "EFI_LOCK_STATUS"\r
100 \r
101 #define EFI_FVB2_STICKY_WRITE_STRING       "EFI_STICKY_WRITE"\r
102 #define EFI_FVB2_MEMORY_MAPPED_STRING      "EFI_MEMORY_MAPPED"\r
103 #define EFI_FVB2_ERASE_POLARITY_STRING     "EFI_ERASE_POLARITY"\r
104 \r
105 #define EFI_FVB2_READ_LOCK_CAP_STRING      "EFI_READ_LOCK_CAP"\r
106 #define EFI_FVB2_READ_LOCK_STATUS_STRING   "EFI_READ_LOCK_STATUS"\r
107 #define EFI_FVB2_WRITE_LOCK_CAP_STRING     "EFI_WRITE_LOCK_CAP"\r
108 #define EFI_FVB2_WRITE_LOCK_STATUS_STRING  "EFI_WRITE_LOCK_STATUS"\r
109 \r
110 #define EFI_FVB2_ALIGNMENT_1_STRING       "EFI_FVB2_ALIGNMENT_1"   \r
111 #define EFI_FVB2_ALIGNMENT_2_STRING       "EFI_FVB2_ALIGNMENT_2"   \r
112 #define EFI_FVB2_ALIGNMENT_4_STRING       "EFI_FVB2_ALIGNMENT_4"   \r
113 #define EFI_FVB2_ALIGNMENT_8_STRING       "EFI_FVB2_ALIGNMENT_8"   \r
114 #define EFI_FVB2_ALIGNMENT_16_STRING      "EFI_FVB2_ALIGNMENT_16"  \r
115 #define EFI_FVB2_ALIGNMENT_32_STRING      "EFI_FVB2_ALIGNMENT_32"  \r
116 #define EFI_FVB2_ALIGNMENT_64_STRING      "EFI_FVB2_ALIGNMENT_64"  \r
117 #define EFI_FVB2_ALIGNMENT_128_STRING     "EFI_FVB2_ALIGNMENT_128" \r
118 #define EFI_FVB2_ALIGNMENT_256_STRING     "EFI_FVB2_ALIGNMENT_256" \r
119 #define EFI_FVB2_ALIGNMENT_512_STRING     "EFI_FVB2_ALIGNMENT_512" \r
120 #define EFI_FVB2_ALIGNMENT_1K_STRING      "EFI_FVB2_ALIGNMENT_1K"  \r
121 #define EFI_FVB2_ALIGNMENT_2K_STRING      "EFI_FVB2_ALIGNMENT_2K"  \r
122 #define EFI_FVB2_ALIGNMENT_4K_STRING      "EFI_FVB2_ALIGNMENT_4K"  \r
123 #define EFI_FVB2_ALIGNMENT_8K_STRING      "EFI_FVB2_ALIGNMENT_8K"  \r
124 #define EFI_FVB2_ALIGNMENT_16K_STRING     "EFI_FVB2_ALIGNMENT_16K" \r
125 #define EFI_FVB2_ALIGNMENT_32K_STRING     "EFI_FVB2_ALIGNMENT_32K" \r
126 #define EFI_FVB2_ALIGNMENT_64K_STRING     "EFI_FVB2_ALIGNMENT_64K" \r
127 #define EFI_FVB2_ALIGNMENT_128K_STRING    "EFI_FVB2_ALIGNMENT_128K"\r
128 #define EFI_FVB2_ALIGNMENT_256K_STRING    "EFI_FVB2_ALIGNMENT_256K"\r
129 #define EFI_FVB2_ALIGNMNET_512K_STRING    "EFI_FVB2_ALIGNMENT_512K"\r
130 #define EFI_FVB2_ALIGNMENT_1M_STRING      "EFI_FVB2_ALIGNMENT_1M"  \r
131 #define EFI_FVB2_ALIGNMENT_2M_STRING      "EFI_FVB2_ALIGNMENT_2M"  \r
132 #define EFI_FVB2_ALIGNMENT_4M_STRING      "EFI_FVB2_ALIGNMENT_4M"  \r
133 #define EFI_FVB2_ALIGNMENT_8M_STRING      "EFI_FVB2_ALIGNMENT_8M"  \r
134 #define EFI_FVB2_ALIGNMENT_16M_STRING     "EFI_FVB2_ALIGNMENT_16M" \r
135 #define EFI_FVB2_ALIGNMENT_32M_STRING     "EFI_FVB2_ALIGNMENT_32M" \r
136 #define EFI_FVB2_ALIGNMENT_64M_STRING     "EFI_FVB2_ALIGNMENT_64M" \r
137 #define EFI_FVB2_ALIGNMENT_128M_STRING    "EFI_FVB2_ALIGNMENT_128M"\r
138 #define EFI_FVB2_ALIGNMENT_256M_STRING    "EFI_FVB2_ALIGNMENT_256M"\r
139 #define EFI_FVB2_ALIGNMENT_512M_STRING    "EFI_FVB2_ALIGNMENT_512M"\r
140 #define EFI_FVB2_ALIGNMENT_1G_STRING      "EFI_FVB2_ALIGNMENT_1G"  \r
141 #define EFI_FVB2_ALIGNMENT_2G_STRING      "EFI_FVB2_ALIGNMENT_2G"  \r
142 \r
143 //\r
144 // File sections\r
145 //\r
146 #define EFI_FILE_NAME_STRING      "EFI_FILE_NAME"\r
147 \r
148 #define ONE_STRING                "1"\r
149 #define ZERO_STRING               "0"\r
150 #define TRUE_STRING               "TRUE"\r
151 #define FALSE_STRING              "FALSE"\r
152 #define NULL_STRING               "NULL"\r
153 \r
154 //\r
155 // Defines to calculate the offset for PEI CORE entry points\r
156 //\r
157 #define IA32_PEI_CORE_ENTRY_OFFSET    0x20\r
158 \r
159 //\r
160 // Defines to calculate the FIT table\r
161 //\r
162 #define IPF_FIT_ADDRESS_OFFSET        0x20\r
163 \r
164 //\r
165 // Defines to calculate the offset for SALE_ENTRY\r
166 //\r
167 #define IPF_SALE_ENTRY_ADDRESS_OFFSET 0x18\r
168 \r
169 //\r
170 // Symbol file definitions, current max size if 512K\r
171 //\r
172 #define SYMBOL_FILE_SIZE              0x80000\r
173 \r
174 #define FV_IMAGES_TOP_ADDRESS         0x100000000ULL\r
175 \r
176 //\r
177 // Following definition is used for FIT in IPF\r
178 //\r
179 #define COMP_TYPE_FIT_PEICORE 0x10\r
180 #define COMP_TYPE_FIT_UNUSED  0x7F\r
181 \r
182 #define FIT_TYPE_MASK         0x7F\r
183 #define CHECKSUM_BIT_MASK     0x80\r
184 \r
185 //\r
186 // Rebase File type\r
187 //\r
188 #define REBASE_XIP_FILE       0x1\r
189 #define REBASE_BOOTTIME_FILE  0x2\r
190 #define REBASE_RUNTIME_FILE   0x4\r
191 \r
192 //\r
193 // Private data types\r
194 //\r
195 //\r
196 // Component information\r
197 //\r
198 typedef struct {\r
199   UINTN Size;\r
200   CHAR8 ComponentName[_MAX_PATH];\r
201 } COMPONENT_INFO;\r
202 \r
203 //\r
204 // FV information holder\r
205 //\r
206 typedef struct {\r
207   EFI_PHYSICAL_ADDRESS    BaseAddress;\r
208   EFI_PHYSICAL_ADDRESS    BootBaseAddress;\r
209   EFI_PHYSICAL_ADDRESS    RuntimeBaseAddress;  \r
210   EFI_GUID                FvGuid;\r
211   UINTN                   Size;\r
212   CHAR8                   FvName[_MAX_PATH];\r
213   EFI_FV_BLOCK_MAP_ENTRY  FvBlocks[MAX_NUMBER_OF_FV_BLOCKS];\r
214   EFI_FVB_ATTRIBUTES      FvAttributes;\r
215   CHAR8                   FvFiles[MAX_NUMBER_OF_FILES_IN_FV][_MAX_PATH];\r
216 } FV_INFO;\r
217 \r
218 #pragma pack(1)\r
219 \r
220 typedef struct {\r
221   UINT64  CompAddress;\r
222   UINT32  CompSize;\r
223   UINT16  CompVersion;\r
224   UINT8   CvAndType;\r
225   UINT8   CheckSum;\r
226 } FIT_TABLE;\r
227 \r
228 #pragma pack()\r
229 \r
230 //\r
231 // Local function prototypes\r
232 //\r
233 EFI_STATUS\r
234 ParseFvInf (\r
235   IN  MEMORY_FILE  *InfFile,\r
236   OUT FV_INFO      *FvInfo\r
237   )\r
238 ;\r
239 \r
240 EFI_STATUS\r
241 UpdatePeiCoreEntryInFit (\r
242   IN FIT_TABLE     *FitTablePtr,\r
243   IN UINT64        PeiCorePhysicalAddress\r
244   )\r
245 /*++\r
246 \r
247 Routine Description:\r
248 \r
249   This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from\r
250   Sec to Pei Core\r
251 \r
252 Arguments:\r
253 \r
254   FitTablePtr             - The pointer of FIT_TABLE.\r
255   PeiCorePhysicalAddress  - The address of Pei Core entry.\r
256 \r
257 Returns:\r
258 \r
259   EFI_SUCCESS             - The PEI_CORE FIT entry was updated successfully.\r
260   EFI_NOT_FOUND           - Not found the PEI_CORE FIT entry.\r
261 \r
262 --*/\r
263 ;\r
264 \r
265 VOID\r
266 UpdateFitCheckSum (\r
267   IN FIT_TABLE   *FitTablePtr\r
268   )\r
269 /*++\r
270 \r
271 Routine Description:\r
272 \r
273   This function is used to update the checksum for FIT.\r
274 \r
275 \r
276 Arguments:\r
277 \r
278   FitTablePtr             - The pointer of FIT_TABLE.\r
279 \r
280 Returns:\r
281 \r
282   None.\r
283 \r
284 --*/\r
285 ;\r
286 \r
287 EFI_STATUS\r
288 GetPe32Info (\r
289   IN UINT8                  *Pe32,\r
290   OUT UINT32                *EntryPoint,\r
291   OUT UINT32                *BaseOfCode,\r
292   OUT UINT16                *MachineType\r
293   );\r
294 \r
295 //\r
296 // Exported function prototypes\r
297 //\r
298 EFI_STATUS\r
299 GenerateFvImage (\r
300   IN CHAR8                *InfFileImage,\r
301   IN UINTN                InfFileSize,\r
302   IN CHAR8                *FvFileName,  \r
303   IN EFI_PHYSICAL_ADDRESS XipBaseAddress\r
304   )\r
305 /*++\r
306 \r
307 Routine Description:\r
308 \r
309   This is the main function which will be called from application.\r
310 \r
311 Arguments:\r
312 \r
313   InfFileImage   Buffer containing the INF file contents.\r
314   InfFileSize    Size of the contents of the InfFileImage buffer.\r
315   FvFileName     Requested name for the FV file.\r
316   XipBaseAddress BaseAddress is to be rebased.\r
317     \r
318 Returns:\r
319  \r
320   EFI_SUCCESS             Function completed successfully.\r
321   EFI_OUT_OF_RESOURCES    Could not allocate required resources.\r
322   EFI_ABORTED             Error encountered.\r
323   EFI_INVALID_PARAMETER   A required parameter was NULL.\r
324 \r
325 --*/\r
326 ;\r
327 \r
328 #endif\r