Enhance GenFv tool to print Fv Size and Length, and Get module map by module pdb...
[people/mcb30/basetools.git] / Source / C / GenFv / GenFvInternalLib.h
1 /** @file\r
2 \r
3 Copyright (c) 2004 - 2008, 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/UefiCapsule.h>\r
33 \r
34 #include <Common/PiFirmwareFile.h>\r
35 #include <Common/PiFirmwareVolume.h>\r
36 #include <Guid/PiFirmwareFileSystem.h>\r
37 #include <IndustryStandard/PeImage.h>\r
38 \r
39 #include "CommonLib.h"\r
40 #include "ParseInf.h"\r
41 #include "EfiUtilityMsgs.h"\r
42 \r
43 extern UINT32 mFvTotalSize;\r
44 extern UINT32 mFvTakenSize;\r
45 //\r
46 // Different file separater for Linux and Windows\r
47 //\r
48 #define FILE_SEP_CHAR '/'\r
49 \r
50 //\r
51 // The maximum number of Pad file guid entries.\r
52 //\r
53 #define MAX_NUMBER_OF_PAD_FILE_GUIDS    1024\r
54 \r
55 //\r
56 // The maximum number of block map entries supported by the library\r
57 //\r
58 #define MAX_NUMBER_OF_FV_BLOCKS         100\r
59 \r
60 //\r
61 // The maximum number of files in the FV supported by the library\r
62 //\r
63 #define MAX_NUMBER_OF_FILES_IN_FV       1000\r
64 #define MAX_NUMBER_OF_FILES_IN_CAP      1000\r
65 #define EFI_FFS_FILE_HEADER_ALIGNMENT   8\r
66 \r
67 //\r
68 // INF file strings\r
69 //\r
70 #define OPTIONS_SECTION_STRING            "[options]"\r
71 #define ATTRIBUTES_SECTION_STRING         "[attributes]"\r
72 #define FILES_SECTION_STRING              "[files]"\r
73 \r
74 //\r
75 // Options section\r
76 //\r
77 #define EFI_FV_BASE_ADDRESS_STRING        "EFI_BASE_ADDRESS"\r
78 #define EFI_FV_FILE_NAME_STRING           "EFI_FILE_NAME"\r
79 #define EFI_NUM_BLOCKS_STRING             "EFI_NUM_BLOCKS"\r
80 #define EFI_BLOCK_SIZE_STRING             "EFI_BLOCK_SIZE"\r
81 #define EFI_FV_GUID_STRING                "EFI_FV_GUID"\r
82 #define EFI_CAPSULE_GUID_STRING           "EFI_CAPSULE_GUID"\r
83 #define EFI_CAPSULE_HEADER_SIZE_STRING    "EFI_CAPSULE_HEADER_SIZE"\r
84 #define EFI_CAPSULE_FLAGS_STRING          "EFI_CAPSULE_FLAGS"\r
85 #define EFI_CAPSULE_VERSION_STRING        "EFI_CAPSULE_VERSION"\r
86 #define EFI_FV_BOOT_DRIVER_BASE_ADDRESS_STRING    "EFI_BOOT_DRIVER_BASE_ADDRESS"\r
87 #define EFI_FV_RUNTIME_DRIVER_BASE_ADDRESS_STRING "EFI_RUNTIME_DRIVER_BASE_ADDRESS"\r
88 \r
89 #define EFI_FV_TOTAL_SIZE_STRING    "EFI_FV_TOTAL_SIZE"\r
90 #define EFI_FV_TAKEN_SIZE_STRING    "EFI_FV_TAKEN_SIZE"\r
91 #define EFI_FV_SPACE_SIZE_STRING    "EFI_FV_SPACE_SIZE"\r
92 \r
93 //\r
94 // Attributes section\r
95 //\r
96 #define EFI_FVB2_READ_DISABLED_CAP_STRING  "EFI_READ_DISABLED_CAP"\r
97 #define EFI_FVB2_READ_ENABLED_CAP_STRING   "EFI_READ_ENABLED_CAP"\r
98 #define EFI_FVB2_READ_STATUS_STRING        "EFI_READ_STATUS"\r
99 \r
100 #define EFI_FVB2_WRITE_DISABLED_CAP_STRING "EFI_WRITE_DISABLED_CAP"\r
101 #define EFI_FVB2_WRITE_ENABLED_CAP_STRING  "EFI_WRITE_ENABLED_CAP"\r
102 #define EFI_FVB2_WRITE_STATUS_STRING       "EFI_WRITE_STATUS"\r
103 \r
104 #define EFI_FVB2_LOCK_CAP_STRING           "EFI_LOCK_CAP"\r
105 #define EFI_FVB2_LOCK_STATUS_STRING        "EFI_LOCK_STATUS"\r
106 \r
107 #define EFI_FVB2_STICKY_WRITE_STRING       "EFI_STICKY_WRITE"\r
108 #define EFI_FVB2_MEMORY_MAPPED_STRING      "EFI_MEMORY_MAPPED"\r
109 #define EFI_FVB2_ERASE_POLARITY_STRING     "EFI_ERASE_POLARITY"\r
110 \r
111 #define EFI_FVB2_READ_LOCK_CAP_STRING      "EFI_READ_LOCK_CAP"\r
112 #define EFI_FVB2_READ_LOCK_STATUS_STRING   "EFI_READ_LOCK_STATUS"\r
113 #define EFI_FVB2_WRITE_LOCK_CAP_STRING     "EFI_WRITE_LOCK_CAP"\r
114 #define EFI_FVB2_WRITE_LOCK_STATUS_STRING  "EFI_WRITE_LOCK_STATUS"\r
115 \r
116 #define EFI_FVB2_ALIGNMENT_1_STRING       "EFI_FVB2_ALIGNMENT_1"   \r
117 #define EFI_FVB2_ALIGNMENT_2_STRING       "EFI_FVB2_ALIGNMENT_2"   \r
118 #define EFI_FVB2_ALIGNMENT_4_STRING       "EFI_FVB2_ALIGNMENT_4"   \r
119 #define EFI_FVB2_ALIGNMENT_8_STRING       "EFI_FVB2_ALIGNMENT_8"   \r
120 #define EFI_FVB2_ALIGNMENT_16_STRING      "EFI_FVB2_ALIGNMENT_16"  \r
121 #define EFI_FVB2_ALIGNMENT_32_STRING      "EFI_FVB2_ALIGNMENT_32"  \r
122 #define EFI_FVB2_ALIGNMENT_64_STRING      "EFI_FVB2_ALIGNMENT_64"  \r
123 #define EFI_FVB2_ALIGNMENT_128_STRING     "EFI_FVB2_ALIGNMENT_128" \r
124 #define EFI_FVB2_ALIGNMENT_256_STRING     "EFI_FVB2_ALIGNMENT_256" \r
125 #define EFI_FVB2_ALIGNMENT_512_STRING     "EFI_FVB2_ALIGNMENT_512" \r
126 #define EFI_FVB2_ALIGNMENT_1K_STRING      "EFI_FVB2_ALIGNMENT_1K"  \r
127 #define EFI_FVB2_ALIGNMENT_2K_STRING      "EFI_FVB2_ALIGNMENT_2K"  \r
128 #define EFI_FVB2_ALIGNMENT_4K_STRING      "EFI_FVB2_ALIGNMENT_4K"  \r
129 #define EFI_FVB2_ALIGNMENT_8K_STRING      "EFI_FVB2_ALIGNMENT_8K"  \r
130 #define EFI_FVB2_ALIGNMENT_16K_STRING     "EFI_FVB2_ALIGNMENT_16K" \r
131 #define EFI_FVB2_ALIGNMENT_32K_STRING     "EFI_FVB2_ALIGNMENT_32K" \r
132 #define EFI_FVB2_ALIGNMENT_64K_STRING     "EFI_FVB2_ALIGNMENT_64K" \r
133 #define EFI_FVB2_ALIGNMENT_128K_STRING    "EFI_FVB2_ALIGNMENT_128K"\r
134 #define EFI_FVB2_ALIGNMENT_256K_STRING    "EFI_FVB2_ALIGNMENT_256K"\r
135 #define EFI_FVB2_ALIGNMNET_512K_STRING    "EFI_FVB2_ALIGNMENT_512K"\r
136 #define EFI_FVB2_ALIGNMENT_1M_STRING      "EFI_FVB2_ALIGNMENT_1M"  \r
137 #define EFI_FVB2_ALIGNMENT_2M_STRING      "EFI_FVB2_ALIGNMENT_2M"  \r
138 #define EFI_FVB2_ALIGNMENT_4M_STRING      "EFI_FVB2_ALIGNMENT_4M"  \r
139 #define EFI_FVB2_ALIGNMENT_8M_STRING      "EFI_FVB2_ALIGNMENT_8M"  \r
140 #define EFI_FVB2_ALIGNMENT_16M_STRING     "EFI_FVB2_ALIGNMENT_16M" \r
141 #define EFI_FVB2_ALIGNMENT_32M_STRING     "EFI_FVB2_ALIGNMENT_32M" \r
142 #define EFI_FVB2_ALIGNMENT_64M_STRING     "EFI_FVB2_ALIGNMENT_64M" \r
143 #define EFI_FVB2_ALIGNMENT_128M_STRING    "EFI_FVB2_ALIGNMENT_128M"\r
144 #define EFI_FVB2_ALIGNMENT_256M_STRING    "EFI_FVB2_ALIGNMENT_256M"\r
145 #define EFI_FVB2_ALIGNMENT_512M_STRING    "EFI_FVB2_ALIGNMENT_512M"\r
146 #define EFI_FVB2_ALIGNMENT_1G_STRING      "EFI_FVB2_ALIGNMENT_1G"  \r
147 #define EFI_FVB2_ALIGNMENT_2G_STRING      "EFI_FVB2_ALIGNMENT_2G"  \r
148 \r
149 //\r
150 // File sections\r
151 //\r
152 #define EFI_FILE_NAME_STRING      "EFI_FILE_NAME"\r
153 \r
154 #define ONE_STRING                "1"\r
155 #define ZERO_STRING               "0"\r
156 #define TRUE_STRING               "TRUE"\r
157 #define FALSE_STRING              "FALSE"\r
158 #define NULL_STRING               "NULL"\r
159 \r
160 //\r
161 // Defines to calculate the offset for PEI CORE entry points\r
162 //\r
163 #define IA32_PEI_CORE_ENTRY_OFFSET    0x20\r
164 \r
165 //\r
166 // Defines to calculate the offset for IA32 SEC CORE entry point\r
167 //\r
168 #define IA32_SEC_CORE_ENTRY_OFFSET     0xD\r
169 \r
170 //\r
171 // Defines to calculate the FIT table\r
172 //\r
173 #define IPF_FIT_ADDRESS_OFFSET        0x20\r
174 \r
175 //\r
176 // Defines to calculate the offset for SALE_ENTRY\r
177 //\r
178 #define IPF_SALE_ENTRY_ADDRESS_OFFSET 0x18\r
179 \r
180 //\r
181 // Symbol file definitions, current max size if 512K\r
182 //\r
183 #define SYMBOL_FILE_SIZE              0x80000\r
184 \r
185 #define FV_IMAGES_TOP_ADDRESS         0x100000000ULL\r
186 \r
187 //\r
188 // Following definition is used for FIT in IPF\r
189 //\r
190 #define COMP_TYPE_FIT_PEICORE 0x10\r
191 #define COMP_TYPE_FIT_UNUSED  0x7F\r
192 \r
193 #define FIT_TYPE_MASK         0x7F\r
194 #define CHECKSUM_BIT_MASK     0x80\r
195 \r
196 //\r
197 // Rebase File type\r
198 //\r
199 #define REBASE_XIP_FILE       0x1\r
200 #define REBASE_BOOTTIME_FILE  0x2\r
201 #define REBASE_RUNTIME_FILE   0x4\r
202 \r
203 //\r
204 // Private data types\r
205 //\r
206 //\r
207 // Component information\r
208 //\r
209 typedef struct {\r
210   UINTN Size;\r
211   CHAR8 ComponentName[_MAX_PATH];\r
212 } COMPONENT_INFO;\r
213 \r
214 //\r
215 // FV and capsule information holder\r
216 //\r
217 typedef struct {\r
218   EFI_PHYSICAL_ADDRESS    BaseAddress;\r
219   EFI_PHYSICAL_ADDRESS    BootBaseAddress;\r
220   EFI_PHYSICAL_ADDRESS    RuntimeBaseAddress;  \r
221   EFI_GUID                FvGuid;\r
222   UINTN                   Size;\r
223   CHAR8                   FvName[_MAX_PATH];\r
224   EFI_FV_BLOCK_MAP_ENTRY  FvBlocks[MAX_NUMBER_OF_FV_BLOCKS];\r
225   EFI_FVB_ATTRIBUTES      FvAttributes;\r
226   CHAR8                   FvFiles[MAX_NUMBER_OF_FILES_IN_FV][_MAX_PATH];\r
227 } FV_INFO;\r
228 \r
229 typedef struct {\r
230   EFI_GUID                CapGuid;\r
231   UINT32                  HeaderSize;\r
232   UINT32                  Flags;\r
233   CHAR8                   CapName[_MAX_PATH];\r
234   CHAR8                   CapFiles[MAX_NUMBER_OF_FILES_IN_CAP][_MAX_PATH];\r
235 } CAP_INFO;\r
236 \r
237 #pragma pack(1)\r
238 \r
239 typedef struct {\r
240   UINT64  CompAddress;\r
241   UINT32  CompSize;\r
242   UINT16  CompVersion;\r
243   UINT8   CvAndType;\r
244   UINT8   CheckSum;\r
245 } FIT_TABLE;\r
246 \r
247 #pragma pack()\r
248 \r
249 #define FV_DEFAULT_ATTRIBUTE  0x0004FEFF\r
250 extern FV_INFO    gFvDataInfo;\r
251 extern CAP_INFO   gCapDataInfo;\r
252 //\r
253 // Local function prototypes\r
254 //\r
255 EFI_STATUS\r
256 ParseFvInf (\r
257   IN  MEMORY_FILE  *InfFile,\r
258   OUT FV_INFO      *FvInfo\r
259   )\r
260 ;\r
261 \r
262 EFI_STATUS\r
263 UpdatePeiCoreEntryInFit (\r
264   IN FIT_TABLE     *FitTablePtr,\r
265   IN UINT64        PeiCorePhysicalAddress\r
266   )\r
267 /*++\r
268 \r
269 Routine Description:\r
270 \r
271   This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from\r
272   Sec to Pei Core\r
273 \r
274 Arguments:\r
275 \r
276   FitTablePtr             - The pointer of FIT_TABLE.\r
277   PeiCorePhysicalAddress  - The address of Pei Core entry.\r
278 \r
279 Returns:\r
280 \r
281   EFI_SUCCESS             - The PEI_CORE FIT entry was updated successfully.\r
282   EFI_NOT_FOUND           - Not found the PEI_CORE FIT entry.\r
283 \r
284 --*/\r
285 ;\r
286 \r
287 VOID\r
288 UpdateFitCheckSum (\r
289   IN FIT_TABLE   *FitTablePtr\r
290   )\r
291 /*++\r
292 \r
293 Routine Description:\r
294 \r
295   This function is used to update the checksum for FIT.\r
296 \r
297 \r
298 Arguments:\r
299 \r
300   FitTablePtr             - The pointer of FIT_TABLE.\r
301 \r
302 Returns:\r
303 \r
304   None.\r
305 \r
306 --*/\r
307 ;\r
308 \r
309 EFI_STATUS\r
310 GetPe32Info (\r
311   IN UINT8                  *Pe32,\r
312   OUT UINT32                *EntryPoint,\r
313   OUT UINT32                *BaseOfCode,\r
314   OUT UINT16                *MachineType\r
315   );\r
316 \r
317 EFI_STATUS\r
318 ParseCapInf (\r
319   IN  MEMORY_FILE  *InfFile,\r
320   OUT CAP_INFO     *CapInfo\r
321   );\r
322 \r
323 EFI_STATUS\r
324 FindApResetVectorPosition (\r
325   IN  MEMORY_FILE  *FvImage,\r
326   OUT UINT8        **Pointer\r
327   ); \r
328 \r
329 EFI_STATUS\r
330 CalculateFvSize (\r
331   FV_INFO *FvInfoPtr\r
332   );\r
333 \r
334 EFI_STATUS\r
335 FfsRebase ( \r
336   IN OUT  FV_INFO               *FvInfo, \r
337   IN      CHAR8                 *FileName,           \r
338   IN OUT  EFI_FFS_FILE_HEADER   *FfsFile,\r
339   IN      UINTN                 XipOffset,\r
340   IN      FILE                  *FvMapFile\r
341   );\r
342 \r
343 //\r
344 // Exported function prototypes\r
345 //\r
346 EFI_STATUS\r
347 GenerateCapImage (\r
348   IN CHAR8                *InfFileImage,\r
349   IN UINTN                InfFileSize,\r
350   IN CHAR8                *CapFileName\r
351   )\r
352 /*++\r
353 \r
354 Routine Description:\r
355 \r
356   This is the main function which will be called from application to \r
357   generate UEFI Capsule image.\r
358 \r
359 Arguments:\r
360 \r
361   InfFileImage   Buffer containing the INF file contents.\r
362   InfFileSize    Size of the contents of the InfFileImage buffer.\r
363   CapFileName    Requested name for the Cap file.\r
364 \r
365 Returns:\r
366 \r
367   EFI_SUCCESS             Function completed successfully.\r
368   EFI_OUT_OF_RESOURCES    Could not allocate required resources.\r
369   EFI_ABORTED             Error encountered.\r
370   EFI_INVALID_PARAMETER   A required parameter was NULL.\r
371 \r
372 --*/\r
373 ;\r
374 \r
375 EFI_STATUS\r
376 GenerateFvImage (\r
377   IN CHAR8                *InfFileImage,\r
378   IN UINTN                InfFileSize,\r
379   IN CHAR8                *FvFileName,  \r
380   IN CHAR8                *MapFileName,\r
381   IN EFI_PHYSICAL_ADDRESS XipBaseAddress,\r
382   IN EFI_PHYSICAL_ADDRESS *BtBaseAddress,\r
383   IN EFI_PHYSICAL_ADDRESS *RtBaseAddress\r
384   )\r
385 /*++\r
386 \r
387 Routine Description:\r
388 \r
389   This is the main function which will be called from application to \r
390   generate Firmware Image conforms to PI spec.\r
391 \r
392 Arguments:\r
393 \r
394   InfFileImage   Buffer containing the INF file contents.\r
395   InfFileSize    Size of the contents of the InfFileImage buffer.\r
396   FvFileName     Requested name for the FV file.\r
397   MapFileName    Fv map file to log fv driver information.\r
398   XipBaseAddress BaseAddress is to be rebased.\r
399   BtBaseAddress  Pointer to BaseAddress is to set the prefer loaded image start address for boot drivers.\r
400   RtBaseAddress  Pointer to BaseAddress is to set the prefer loaded image start address for runtime drivers.\r
401     \r
402 Returns:\r
403  \r
404   EFI_SUCCESS             Function completed successfully.\r
405   EFI_OUT_OF_RESOURCES    Could not allocate required resources.\r
406   EFI_ABORTED             Error encountered.\r
407   EFI_INVALID_PARAMETER   A required parameter was NULL.\r
408 \r
409 --*/\r
410 ;\r
411 \r
412 EFI_STATUS\r
413 WriteMapFile (\r
414   IN OUT FILE                  *FvMapFile,\r
415   IN     CHAR8                 *FileName,\r
416   IN     EFI_GUID              *FileGuidPtr, \r
417   IN     EFI_PHYSICAL_ADDRESS  ImageBaseAddress,\r
418   IN     UINT32                AddressOfEntryPoint,\r
419   IN     UINT32                Offset\r
420   );\r
421 #endif\r