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