767cae9984333811810e7481d8d7e3e2e2608095
[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 //\r
44 // Different file separater for Linux and Windows\r
45 //\r
46 #ifdef __GNUC__\r
47 #define FILE_SEP_CHAR '/'\r
48 #define FILE_SEP_STRING "/"\r
49 #else\r
50 #define FILE_SEP_CHAR '\\'\r
51 #define FILE_SEP_STRING "\\"\r
52 #endif\r
53 \r
54 //\r
55 // The maximum number of Pad file guid entries.\r
56 //\r
57 #define MAX_NUMBER_OF_PAD_FILE_GUIDS    1024\r
58 \r
59 //\r
60 // The maximum number of block map entries supported by the library\r
61 //\r
62 #define MAX_NUMBER_OF_FV_BLOCKS         100\r
63 \r
64 //\r
65 // The maximum number of files in the FV supported by the library\r
66 //\r
67 #define MAX_NUMBER_OF_FILES_IN_FV       1000\r
68 #define MAX_NUMBER_OF_FILES_IN_CAP      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 #define EFI_CAPSULE_GUID_STRING           "EFI_CAPSULE_GUID"\r
87 #define EFI_CAPSULE_HEADER_SIZE_STRING    "EFI_CAPSULE_HEADER_SIZE"\r
88 #define EFI_CAPSULE_FLAGS_STRING          "EFI_CAPSULE_FLAGS"\r
89 #define EFI_CAPSULE_VERSION_STRING        "EFI_CAPSULE_VERSION"\r
90 #define EFI_FV_BOOT_DRIVER_BASE_ADDRESS_STRING    "EFI_BOOT_DRIVER_BASE_ADDRESS"\r
91 #define EFI_FV_RUNTIME_DRIVER_BASE_ADDRESS_STRING "EFI_RUNTIME_DRIVER_BASE_ADDRESS"\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 //\r
250 // Local function prototypes\r
251 //\r
252 EFI_STATUS\r
253 ParseFvInf (\r
254   IN  MEMORY_FILE  *InfFile,\r
255   OUT FV_INFO      *FvInfo\r
256   )\r
257 ;\r
258 \r
259 EFI_STATUS\r
260 UpdatePeiCoreEntryInFit (\r
261   IN FIT_TABLE     *FitTablePtr,\r
262   IN UINT64        PeiCorePhysicalAddress\r
263   )\r
264 /*++\r
265 \r
266 Routine Description:\r
267 \r
268   This function is used to update the Pei Core address in FIT, this can be used by Sec core to pass control from\r
269   Sec to Pei Core\r
270 \r
271 Arguments:\r
272 \r
273   FitTablePtr             - The pointer of FIT_TABLE.\r
274   PeiCorePhysicalAddress  - The address of Pei Core entry.\r
275 \r
276 Returns:\r
277 \r
278   EFI_SUCCESS             - The PEI_CORE FIT entry was updated successfully.\r
279   EFI_NOT_FOUND           - Not found the PEI_CORE FIT entry.\r
280 \r
281 --*/\r
282 ;\r
283 \r
284 VOID\r
285 UpdateFitCheckSum (\r
286   IN FIT_TABLE   *FitTablePtr\r
287   )\r
288 /*++\r
289 \r
290 Routine Description:\r
291 \r
292   This function is used to update the checksum for FIT.\r
293 \r
294 \r
295 Arguments:\r
296 \r
297   FitTablePtr             - The pointer of FIT_TABLE.\r
298 \r
299 Returns:\r
300 \r
301   None.\r
302 \r
303 --*/\r
304 ;\r
305 \r
306 EFI_STATUS\r
307 GetPe32Info (\r
308   IN UINT8                  *Pe32,\r
309   OUT UINT32                *EntryPoint,\r
310   OUT UINT32                *BaseOfCode,\r
311   OUT UINT16                *MachineType\r
312   );\r
313 \r
314 EFI_STATUS\r
315 ParseCapInf (\r
316   IN  MEMORY_FILE  *InfFile,\r
317   OUT CAP_INFO     *CapInfo\r
318   );\r
319 \r
320 EFI_STATUS\r
321 FindApResetVectorPosition (\r
322   IN  MEMORY_FILE  *FvImage,\r
323   OUT UINT8        **Pointer\r
324   ); \r
325 \r
326 EFI_STATUS\r
327 CalculateFvSize (\r
328   FV_INFO *FvInfoPtr\r
329   );\r
330 \r
331 EFI_STATUS\r
332 FfsRebase ( \r
333   IN OUT  FV_INFO               *FvInfo, \r
334   IN      CHAR8                 *FileName,           \r
335   IN OUT  EFI_FFS_FILE_HEADER   *FfsFile,\r
336   IN      UINTN                 XipOffset,\r
337   IN      FILE                  *FvMapFile\r
338   );\r
339 \r
340 //\r
341 // Exported function prototypes\r
342 //\r
343 EFI_STATUS\r
344 GenerateCapImage (\r
345   IN CHAR8                *InfFileImage,\r
346   IN UINTN                InfFileSize,\r
347   IN CHAR8                *CapFileName\r
348   )\r
349 /*++\r
350 \r
351 Routine Description:\r
352 \r
353   This is the main function which will be called from application to \r
354   generate UEFI Capsule image.\r
355 \r
356 Arguments:\r
357 \r
358   InfFileImage   Buffer containing the INF file contents.\r
359   InfFileSize    Size of the contents of the InfFileImage buffer.\r
360   CapFileName    Requested name for the Cap file.\r
361 \r
362 Returns:\r
363 \r
364   EFI_SUCCESS             Function completed successfully.\r
365   EFI_OUT_OF_RESOURCES    Could not allocate required resources.\r
366   EFI_ABORTED             Error encountered.\r
367   EFI_INVALID_PARAMETER   A required parameter was NULL.\r
368 \r
369 --*/\r
370 ;\r
371 \r
372 EFI_STATUS\r
373 GenerateFvImage (\r
374   IN CHAR8                *InfFileImage,\r
375   IN UINTN                InfFileSize,\r
376   IN CHAR8                *FvFileName,  \r
377   IN CHAR8                *MapFileName,\r
378   IN EFI_PHYSICAL_ADDRESS XipBaseAddress,\r
379   IN EFI_PHYSICAL_ADDRESS *BtBaseAddress,\r
380   IN EFI_PHYSICAL_ADDRESS *RtBaseAddress\r
381   )\r
382 /*++\r
383 \r
384 Routine Description:\r
385 \r
386   This is the main function which will be called from application to \r
387   generate Firmware Image conforms to PI spec.\r
388 \r
389 Arguments:\r
390 \r
391   InfFileImage   Buffer containing the INF file contents.\r
392   InfFileSize    Size of the contents of the InfFileImage buffer.\r
393   FvFileName     Requested name for the FV file.\r
394   MapFileName    Fv map file to log fv driver information.\r
395   XipBaseAddress BaseAddress is to be rebased.\r
396   BtBaseAddress  Pointer to BaseAddress is to set the prefer loaded image start address for boot drivers.\r
397   RtBaseAddress  Pointer to BaseAddress is to set the prefer loaded image start address for runtime drivers.\r
398     \r
399 Returns:\r
400  \r
401   EFI_SUCCESS             Function completed successfully.\r
402   EFI_OUT_OF_RESOURCES    Could not allocate required resources.\r
403   EFI_ABORTED             Error encountered.\r
404   EFI_INVALID_PARAMETER   A required parameter was NULL.\r
405 \r
406 --*/\r
407 ;\r
408 \r
409 #endif\r