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