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