]>
Commit | Line | Data |
---|---|---|
f51461c8 LG |
1 | ## @file\r |
2 | # Routines for generating AutoGen.h and AutoGen.c\r | |
3 | #\r | |
eca980c0 | 4 | # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r |
f51461c8 LG |
5 | # This program and the accompanying materials\r |
6 | # are licensed and made available under the terms and conditions of the BSD License\r | |
7 | # which accompanies this distribution. The full text of the license may be found at\r | |
8 | # http://opensource.org/licenses/bsd-license.php\r | |
9 | #\r | |
10 | # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | #\r | |
13 | \r | |
14 | ## Import Modules\r | |
15 | #\r | |
1ccc4d89 | 16 | from __future__ import absolute_import\r |
f51461c8 | 17 | import string\r |
333ba578 YZ |
18 | import collections\r |
19 | import struct\r | |
f51461c8 | 20 | from Common import EdkLogger\r |
938cf4c3 | 21 | from Common import GlobalData\r |
f51461c8 LG |
22 | from Common.BuildToolError import *\r |
23 | from Common.DataType import *\r | |
24 | from Common.Misc import *\r | |
5a57246e | 25 | from Common.StringUtils import StringToArray\r |
0ff3b52e GL |
26 | from .StrGather import *\r |
27 | from .GenPcdDb import CreatePcdDatabaseCode\r | |
28 | from .IdfClassObject import *\r | |
f51461c8 LG |
29 | \r |
30 | ## PCD type string\r | |
31 | gItemTypeStringDatabase = {\r | |
be409b67 CJ |
32 | TAB_PCDS_FEATURE_FLAG : TAB_PCDS_FIXED_AT_BUILD,\r |
33 | TAB_PCDS_FIXED_AT_BUILD : TAB_PCDS_FIXED_AT_BUILD,\r | |
f51461c8 LG |
34 | TAB_PCDS_PATCHABLE_IN_MODULE: 'BinaryPatch',\r |
35 | TAB_PCDS_DYNAMIC : '',\r | |
36 | TAB_PCDS_DYNAMIC_DEFAULT : '',\r | |
37 | TAB_PCDS_DYNAMIC_VPD : '',\r | |
38 | TAB_PCDS_DYNAMIC_HII : '',\r | |
39 | TAB_PCDS_DYNAMIC_EX : '',\r | |
40 | TAB_PCDS_DYNAMIC_EX_DEFAULT : '',\r | |
41 | TAB_PCDS_DYNAMIC_EX_VPD : '',\r | |
42 | TAB_PCDS_DYNAMIC_EX_HII : '',\r | |
43 | }\r | |
44 | \r | |
f51461c8 LG |
45 | \r |
46 | ## Datum size\r | |
656d2539 CJ |
47 | gDatumSizeStringDatabase = {TAB_UINT8:'8',TAB_UINT16:'16',TAB_UINT32:'32',TAB_UINT64:'64','BOOLEAN':'BOOLEAN',TAB_VOID:'8'}\r |
48 | gDatumSizeStringDatabaseH = {TAB_UINT8:'8',TAB_UINT16:'16',TAB_UINT32:'32',TAB_UINT64:'64','BOOLEAN':'BOOL',TAB_VOID:'PTR'}\r | |
49 | gDatumSizeStringDatabaseLib = {TAB_UINT8:'8',TAB_UINT16:'16',TAB_UINT32:'32',TAB_UINT64:'64','BOOLEAN':'Bool',TAB_VOID:'Ptr'}\r | |
f51461c8 LG |
50 | \r |
51 | ## AutoGen File Header Templates\r | |
52 | gAutoGenHeaderString = TemplateString("""\\r | |
53 | /**\r | |
54 | DO NOT EDIT\r | |
55 | FILE auto-generated\r | |
56 | Module name:\r | |
57 | ${FileName}\r | |
58 | Abstract: Auto-generated ${FileName} for building module or library.\r | |
59 | **/\r | |
60 | """)\r | |
61 | \r | |
62 | gAutoGenHPrologueString = TemplateString("""\r | |
63 | #ifndef _${File}_${Guid}\r | |
64 | #define _${File}_${Guid}\r | |
65 | \r | |
66 | """)\r | |
67 | \r | |
68 | gAutoGenHCppPrologueString = """\\r | |
69 | #ifdef __cplusplus\r | |
70 | extern "C" {\r | |
71 | #endif\r | |
72 | \r | |
73 | """\r | |
74 | \r | |
75 | gAutoGenHEpilogueString = """\r | |
76 | \r | |
77 | #ifdef __cplusplus\r | |
78 | }\r | |
79 | #endif\r | |
80 | \r | |
81 | #endif\r | |
82 | """\r | |
83 | \r | |
84 | ## PEI Core Entry Point Templates\r | |
85 | gPeiCoreEntryPointPrototype = TemplateString("""\r | |
86 | ${BEGIN}\r | |
87 | VOID\r | |
88 | EFIAPI\r | |
89 | ${Function} (\r | |
90 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r | |
91 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r | |
92 | IN VOID *Context\r | |
93 | );\r | |
94 | ${END}\r | |
95 | """)\r | |
96 | \r | |
97 | gPeiCoreEntryPointString = TemplateString("""\r | |
98 | ${BEGIN}\r | |
99 | VOID\r | |
100 | EFIAPI\r | |
101 | ProcessModuleEntryPointList (\r | |
102 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r | |
103 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r | |
104 | IN VOID *Context\r | |
105 | )\r | |
106 | \r | |
107 | {\r | |
108 | ${Function} (SecCoreData, PpiList, Context);\r | |
109 | }\r | |
110 | ${END}\r | |
111 | """)\r | |
112 | \r | |
113 | \r | |
114 | ## DXE Core Entry Point Templates\r | |
115 | gDxeCoreEntryPointPrototype = TemplateString("""\r | |
116 | ${BEGIN}\r | |
117 | VOID\r | |
118 | EFIAPI\r | |
119 | ${Function} (\r | |
120 | IN VOID *HobStart\r | |
121 | );\r | |
122 | ${END}\r | |
123 | """)\r | |
124 | \r | |
125 | gDxeCoreEntryPointString = TemplateString("""\r | |
126 | ${BEGIN}\r | |
127 | VOID\r | |
128 | EFIAPI\r | |
129 | ProcessModuleEntryPointList (\r | |
130 | IN VOID *HobStart\r | |
131 | )\r | |
132 | \r | |
133 | {\r | |
134 | ${Function} (HobStart);\r | |
135 | }\r | |
136 | ${END}\r | |
137 | """)\r | |
138 | \r | |
139 | ## PEIM Entry Point Templates\r | |
140 | gPeimEntryPointPrototype = TemplateString("""\r | |
141 | ${BEGIN}\r | |
142 | EFI_STATUS\r | |
143 | EFIAPI\r | |
144 | ${Function} (\r | |
145 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
146 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
147 | );\r | |
148 | ${END}\r | |
149 | """)\r | |
150 | \r | |
151 | gPeimEntryPointString = [\r | |
152 | TemplateString("""\r | |
153 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r | |
154 | \r | |
155 | EFI_STATUS\r | |
156 | EFIAPI\r | |
157 | ProcessModuleEntryPointList (\r | |
158 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
159 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
160 | )\r | |
161 | \r | |
162 | {\r | |
163 | return EFI_SUCCESS;\r | |
164 | }\r | |
165 | """),\r | |
166 | TemplateString("""\r | |
167 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r | |
168 | ${BEGIN}\r | |
169 | EFI_STATUS\r | |
170 | EFIAPI\r | |
171 | ProcessModuleEntryPointList (\r | |
172 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
173 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
174 | )\r | |
175 | \r | |
176 | {\r | |
177 | return ${Function} (FileHandle, PeiServices);\r | |
178 | }\r | |
179 | ${END}\r | |
180 | """),\r | |
181 | TemplateString("""\r | |
182 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r | |
183 | \r | |
184 | EFI_STATUS\r | |
185 | EFIAPI\r | |
186 | ProcessModuleEntryPointList (\r | |
187 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
188 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
189 | )\r | |
190 | \r | |
191 | {\r | |
192 | EFI_STATUS Status;\r | |
193 | EFI_STATUS CombinedStatus;\r | |
194 | \r | |
195 | CombinedStatus = EFI_LOAD_ERROR;\r | |
196 | ${BEGIN}\r | |
197 | Status = ${Function} (FileHandle, PeiServices);\r | |
198 | if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {\r | |
199 | CombinedStatus = Status;\r | |
200 | }\r | |
201 | ${END}\r | |
202 | return CombinedStatus;\r | |
203 | }\r | |
204 | """)\r | |
205 | ]\r | |
206 | \r | |
207 | ## SMM_CORE Entry Point Templates\r | |
208 | gSmmCoreEntryPointPrototype = TemplateString("""\r | |
209 | ${BEGIN}\r | |
210 | EFI_STATUS\r | |
211 | EFIAPI\r | |
212 | ${Function} (\r | |
213 | IN EFI_HANDLE ImageHandle,\r | |
214 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
215 | );\r | |
216 | ${END}\r | |
217 | """)\r | |
218 | \r | |
219 | gSmmCoreEntryPointString = TemplateString("""\r | |
220 | ${BEGIN}\r | |
221 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
222 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
223 | \r | |
224 | EFI_STATUS\r | |
225 | EFIAPI\r | |
226 | ProcessModuleEntryPointList (\r | |
227 | IN EFI_HANDLE ImageHandle,\r | |
228 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
229 | )\r | |
230 | {\r | |
231 | return ${Function} (ImageHandle, SystemTable);\r | |
232 | }\r | |
233 | ${END}\r | |
234 | """)\r | |
235 | \r | |
5a9c3e3e SV |
236 | ## MM_CORE_STANDALONE Entry Point Templates\r |
237 | gMmCoreStandaloneEntryPointPrototype = TemplateString("""\r | |
238 | ${BEGIN}\r | |
239 | EFI_STATUS\r | |
240 | EFIAPI\r | |
241 | ${Function} (\r | |
242 | IN VOID *HobStart\r | |
243 | );\r | |
244 | ${END}\r | |
245 | """)\r | |
246 | \r | |
247 | gMmCoreStandaloneEntryPointString = TemplateString("""\r | |
248 | ${BEGIN}\r | |
249 | const UINT32 _gMmRevision = ${PiSpecVersion};\r | |
250 | \r | |
251 | VOID\r | |
252 | EFIAPI\r | |
253 | ProcessModuleEntryPointList (\r | |
254 | IN VOID *HobStart\r | |
255 | )\r | |
256 | {\r | |
257 | ${Function} (HobStart);\r | |
258 | }\r | |
259 | ${END}\r | |
260 | """)\r | |
261 | \r | |
262 | ## MM_STANDALONE Entry Point Templates\r | |
263 | gMmStandaloneEntryPointPrototype = TemplateString("""\r | |
264 | ${BEGIN}\r | |
265 | EFI_STATUS\r | |
266 | EFIAPI\r | |
267 | ${Function} (\r | |
268 | IN EFI_HANDLE ImageHandle,\r | |
549ae85c | 269 | IN EFI_MM_SYSTEM_TABLE *MmSystemTable\r |
5a9c3e3e SV |
270 | );\r |
271 | ${END}\r | |
272 | """)\r | |
273 | \r | |
274 | gMmStandaloneEntryPointString = [\r | |
275 | TemplateString("""\r | |
276 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r | |
277 | \r | |
278 | EFI_STATUS\r | |
279 | EFIAPI\r | |
280 | ProcessModuleEntryPointList (\r | |
281 | IN EFI_HANDLE ImageHandle,\r | |
549ae85c | 282 | IN EFI_MM_SYSTEM_TABLE *MmSystemTable\r |
5a9c3e3e SV |
283 | )\r |
284 | \r | |
285 | {\r | |
286 | return EFI_SUCCESS;\r | |
287 | }\r | |
288 | """),\r | |
289 | TemplateString("""\r | |
290 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r | |
291 | ${BEGIN}\r | |
292 | EFI_STATUS\r | |
293 | EFIAPI\r | |
294 | ProcessModuleEntryPointList (\r | |
295 | IN EFI_HANDLE ImageHandle,\r | |
549ae85c | 296 | IN EFI_MM_SYSTEM_TABLE *MmSystemTable\r |
5a9c3e3e SV |
297 | )\r |
298 | \r | |
299 | {\r | |
300 | return ${Function} (ImageHandle, MmSystemTable);\r | |
301 | }\r | |
302 | ${END}\r | |
303 | """),\r | |
304 | TemplateString("""\r | |
305 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r | |
306 | \r | |
307 | EFI_STATUS\r | |
308 | EFIAPI\r | |
309 | ProcessModuleEntryPointList (\r | |
310 | IN EFI_HANDLE ImageHandle,\r | |
549ae85c | 311 | IN EFI_MM_SYSTEM_TABLE *MmSystemTable\r |
5a9c3e3e SV |
312 | )\r |
313 | \r | |
314 | {\r | |
315 | EFI_STATUS Status;\r | |
316 | EFI_STATUS CombinedStatus;\r | |
317 | \r | |
318 | CombinedStatus = EFI_LOAD_ERROR;\r | |
319 | ${BEGIN}\r | |
320 | Status = ${Function} (ImageHandle, MmSystemTable);\r | |
321 | if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {\r | |
322 | CombinedStatus = Status;\r | |
323 | }\r | |
324 | ${END}\r | |
325 | return CombinedStatus;\r | |
326 | }\r | |
327 | """)\r | |
328 | ]\r | |
329 | \r | |
f51461c8 LG |
330 | ## DXE SMM Entry Point Templates\r |
331 | gDxeSmmEntryPointPrototype = TemplateString("""\r | |
332 | ${BEGIN}\r | |
333 | EFI_STATUS\r | |
334 | EFIAPI\r | |
335 | ${Function} (\r | |
336 | IN EFI_HANDLE ImageHandle,\r | |
337 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
338 | );\r | |
339 | ${END}\r | |
340 | """)\r | |
341 | \r | |
342 | gDxeSmmEntryPointString = [\r | |
343 | TemplateString("""\r | |
344 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
345 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
346 | \r | |
347 | EFI_STATUS\r | |
348 | EFIAPI\r | |
349 | ProcessModuleEntryPointList (\r | |
350 | IN EFI_HANDLE ImageHandle,\r | |
351 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
352 | )\r | |
353 | \r | |
354 | {\r | |
355 | return EFI_SUCCESS;\r | |
356 | }\r | |
357 | """),\r | |
358 | TemplateString("""\r | |
359 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
360 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
361 | \r | |
362 | static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r | |
363 | static EFI_STATUS mDriverEntryPointStatus;\r | |
364 | \r | |
365 | VOID\r | |
366 | EFIAPI\r | |
367 | ExitDriver (\r | |
368 | IN EFI_STATUS Status\r | |
369 | )\r | |
370 | {\r | |
371 | if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r | |
372 | mDriverEntryPointStatus = Status;\r | |
373 | }\r | |
374 | LongJump (&mJumpContext, (UINTN)-1);\r | |
375 | ASSERT (FALSE);\r | |
376 | }\r | |
377 | \r | |
378 | EFI_STATUS\r | |
379 | EFIAPI\r | |
380 | ProcessModuleEntryPointList (\r | |
381 | IN EFI_HANDLE ImageHandle,\r | |
382 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
383 | )\r | |
384 | {\r | |
385 | mDriverEntryPointStatus = EFI_LOAD_ERROR;\r | |
386 | \r | |
387 | ${BEGIN}\r | |
388 | if (SetJump (&mJumpContext) == 0) {\r | |
389 | ExitDriver (${Function} (ImageHandle, SystemTable));\r | |
390 | ASSERT (FALSE);\r | |
391 | }\r | |
392 | ${END}\r | |
393 | \r | |
394 | return mDriverEntryPointStatus;\r | |
395 | }\r | |
396 | """)\r | |
397 | ]\r | |
398 | \r | |
399 | ## UEFI Driver Entry Point Templates\r | |
400 | gUefiDriverEntryPointPrototype = TemplateString("""\r | |
401 | ${BEGIN}\r | |
402 | EFI_STATUS\r | |
403 | EFIAPI\r | |
404 | ${Function} (\r | |
405 | IN EFI_HANDLE ImageHandle,\r | |
406 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
407 | );\r | |
408 | ${END}\r | |
409 | """)\r | |
410 | \r | |
411 | gUefiDriverEntryPointString = [\r | |
412 | TemplateString("""\r | |
413 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
414 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
415 | \r | |
416 | EFI_STATUS\r | |
417 | EFIAPI\r | |
418 | ProcessModuleEntryPointList (\r | |
419 | IN EFI_HANDLE ImageHandle,\r | |
420 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
421 | )\r | |
422 | {\r | |
423 | return EFI_SUCCESS;\r | |
424 | }\r | |
425 | """),\r | |
426 | TemplateString("""\r | |
427 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
428 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
429 | \r | |
430 | ${BEGIN}\r | |
431 | EFI_STATUS\r | |
432 | EFIAPI\r | |
433 | ProcessModuleEntryPointList (\r | |
434 | IN EFI_HANDLE ImageHandle,\r | |
435 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
436 | )\r | |
437 | \r | |
438 | {\r | |
439 | return ${Function} (ImageHandle, SystemTable);\r | |
440 | }\r | |
441 | ${END}\r | |
442 | VOID\r | |
443 | EFIAPI\r | |
444 | ExitDriver (\r | |
445 | IN EFI_STATUS Status\r | |
446 | )\r | |
447 | {\r | |
448 | if (EFI_ERROR (Status)) {\r | |
449 | ProcessLibraryDestructorList (gImageHandle, gST);\r | |
450 | }\r | |
451 | gBS->Exit (gImageHandle, Status, 0, NULL);\r | |
452 | }\r | |
453 | """),\r | |
454 | TemplateString("""\r | |
455 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
456 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
457 | \r | |
458 | static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r | |
459 | static EFI_STATUS mDriverEntryPointStatus;\r | |
460 | \r | |
461 | EFI_STATUS\r | |
462 | EFIAPI\r | |
463 | ProcessModuleEntryPointList (\r | |
464 | IN EFI_HANDLE ImageHandle,\r | |
465 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
466 | )\r | |
467 | {\r | |
468 | mDriverEntryPointStatus = EFI_LOAD_ERROR;\r | |
469 | ${BEGIN}\r | |
470 | if (SetJump (&mJumpContext) == 0) {\r | |
471 | ExitDriver (${Function} (ImageHandle, SystemTable));\r | |
472 | ASSERT (FALSE);\r | |
473 | }\r | |
474 | ${END}\r | |
475 | return mDriverEntryPointStatus;\r | |
476 | }\r | |
477 | \r | |
478 | VOID\r | |
479 | EFIAPI\r | |
480 | ExitDriver (\r | |
481 | IN EFI_STATUS Status\r | |
482 | )\r | |
483 | {\r | |
484 | if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r | |
485 | mDriverEntryPointStatus = Status;\r | |
486 | }\r | |
487 | LongJump (&mJumpContext, (UINTN)-1);\r | |
488 | ASSERT (FALSE);\r | |
489 | }\r | |
490 | """)\r | |
491 | ]\r | |
492 | \r | |
493 | \r | |
494 | ## UEFI Application Entry Point Templates\r | |
495 | gUefiApplicationEntryPointPrototype = TemplateString("""\r | |
496 | ${BEGIN}\r | |
497 | EFI_STATUS\r | |
498 | EFIAPI\r | |
499 | ${Function} (\r | |
500 | IN EFI_HANDLE ImageHandle,\r | |
501 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
502 | );\r | |
503 | ${END}\r | |
504 | """)\r | |
505 | \r | |
506 | gUefiApplicationEntryPointString = [\r | |
507 | TemplateString("""\r | |
508 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
509 | \r | |
510 | EFI_STATUS\r | |
511 | EFIAPI\r | |
512 | ProcessModuleEntryPointList (\r | |
513 | IN EFI_HANDLE ImageHandle,\r | |
514 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
515 | )\r | |
516 | {\r | |
517 | return EFI_SUCCESS;\r | |
518 | }\r | |
519 | """),\r | |
520 | TemplateString("""\r | |
521 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
522 | \r | |
523 | ${BEGIN}\r | |
524 | EFI_STATUS\r | |
525 | EFIAPI\r | |
526 | ProcessModuleEntryPointList (\r | |
527 | IN EFI_HANDLE ImageHandle,\r | |
528 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
529 | )\r | |
530 | \r | |
531 | {\r | |
532 | return ${Function} (ImageHandle, SystemTable);\r | |
533 | }\r | |
534 | ${END}\r | |
535 | VOID\r | |
536 | EFIAPI\r | |
537 | ExitDriver (\r | |
538 | IN EFI_STATUS Status\r | |
539 | )\r | |
540 | {\r | |
541 | if (EFI_ERROR (Status)) {\r | |
542 | ProcessLibraryDestructorList (gImageHandle, gST);\r | |
543 | }\r | |
544 | gBS->Exit (gImageHandle, Status, 0, NULL);\r | |
545 | }\r | |
546 | """),\r | |
547 | TemplateString("""\r | |
548 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
549 | \r | |
550 | EFI_STATUS\r | |
551 | EFIAPI\r | |
552 | ProcessModuleEntryPointList (\r | |
553 | IN EFI_HANDLE ImageHandle,\r | |
554 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
555 | )\r | |
556 | \r | |
557 | {\r | |
558 | ${BEGIN}\r | |
559 | if (SetJump (&mJumpContext) == 0) {\r | |
560 | ExitDriver (${Function} (ImageHandle, SystemTable));\r | |
561 | ASSERT (FALSE);\r | |
562 | }\r | |
563 | ${END}\r | |
564 | return mDriverEntryPointStatus;\r | |
565 | }\r | |
566 | \r | |
567 | static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r | |
568 | static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;\r | |
569 | \r | |
570 | VOID\r | |
571 | EFIAPI\r | |
572 | ExitDriver (\r | |
573 | IN EFI_STATUS Status\r | |
574 | )\r | |
575 | {\r | |
576 | if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r | |
577 | mDriverEntryPointStatus = Status;\r | |
578 | }\r | |
579 | LongJump (&mJumpContext, (UINTN)-1);\r | |
580 | ASSERT (FALSE);\r | |
581 | }\r | |
582 | """)\r | |
583 | ]\r | |
584 | \r | |
585 | ## UEFI Unload Image Templates\r | |
586 | gUefiUnloadImagePrototype = TemplateString("""\r | |
587 | ${BEGIN}\r | |
588 | EFI_STATUS\r | |
589 | EFIAPI\r | |
590 | ${Function} (\r | |
591 | IN EFI_HANDLE ImageHandle\r | |
592 | );\r | |
593 | ${END}\r | |
594 | """)\r | |
595 | \r | |
596 | gUefiUnloadImageString = [\r | |
597 | TemplateString("""\r | |
598 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r | |
599 | \r | |
600 | EFI_STATUS\r | |
601 | EFIAPI\r | |
602 | ProcessModuleUnloadList (\r | |
603 | IN EFI_HANDLE ImageHandle\r | |
604 | )\r | |
605 | {\r | |
606 | return EFI_SUCCESS;\r | |
607 | }\r | |
608 | """),\r | |
609 | TemplateString("""\r | |
610 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r | |
611 | \r | |
612 | ${BEGIN}\r | |
613 | EFI_STATUS\r | |
614 | EFIAPI\r | |
615 | ProcessModuleUnloadList (\r | |
616 | IN EFI_HANDLE ImageHandle\r | |
617 | )\r | |
618 | {\r | |
619 | return ${Function} (ImageHandle);\r | |
620 | }\r | |
621 | ${END}\r | |
622 | """),\r | |
623 | TemplateString("""\r | |
624 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r | |
625 | \r | |
626 | EFI_STATUS\r | |
627 | EFIAPI\r | |
628 | ProcessModuleUnloadList (\r | |
629 | IN EFI_HANDLE ImageHandle\r | |
630 | )\r | |
631 | {\r | |
632 | EFI_STATUS Status;\r | |
633 | \r | |
634 | Status = EFI_SUCCESS;\r | |
635 | ${BEGIN}\r | |
636 | if (EFI_ERROR (Status)) {\r | |
637 | ${Function} (ImageHandle);\r | |
638 | } else {\r | |
639 | Status = ${Function} (ImageHandle);\r | |
640 | }\r | |
641 | ${END}\r | |
642 | return Status;\r | |
643 | }\r | |
644 | """)\r | |
645 | ]\r | |
646 | \r | |
647 | gLibraryStructorPrototype = {\r | |
8bb63e37 | 648 | SUP_MODULE_BASE : TemplateString("""${BEGIN}\r |
f51461c8 LG |
649 | RETURN_STATUS\r |
650 | EFIAPI\r | |
651 | ${Function} (\r | |
652 | VOID\r | |
653 | );${END}\r | |
654 | """),\r | |
655 | \r | |
656 | 'PEI' : TemplateString("""${BEGIN}\r | |
657 | EFI_STATUS\r | |
658 | EFIAPI\r | |
659 | ${Function} (\r | |
660 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
661 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
662 | );${END}\r | |
663 | """),\r | |
664 | \r | |
665 | 'DXE' : TemplateString("""${BEGIN}\r | |
666 | EFI_STATUS\r | |
667 | EFIAPI\r | |
668 | ${Function} (\r | |
669 | IN EFI_HANDLE ImageHandle,\r | |
670 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
671 | );${END}\r | |
672 | """),\r | |
5a9c3e3e SV |
673 | \r |
674 | 'MM' : TemplateString("""${BEGIN}\r | |
675 | EFI_STATUS\r | |
676 | EFIAPI\r | |
677 | ${Function} (\r | |
678 | IN EFI_HANDLE ImageHandle,\r | |
549ae85c | 679 | IN EFI_MM_SYSTEM_TABLE *MmSystemTable\r |
5a9c3e3e SV |
680 | );${END}\r |
681 | """),\r | |
f51461c8 LG |
682 | }\r |
683 | \r | |
684 | gLibraryStructorCall = {\r | |
8bb63e37 | 685 | SUP_MODULE_BASE : TemplateString("""${BEGIN}\r |
f51461c8 LG |
686 | Status = ${Function} ();\r |
687 | ASSERT_EFI_ERROR (Status);${END}\r | |
688 | """),\r | |
689 | \r | |
690 | 'PEI' : TemplateString("""${BEGIN}\r | |
691 | Status = ${Function} (FileHandle, PeiServices);\r | |
692 | ASSERT_EFI_ERROR (Status);${END}\r | |
693 | """),\r | |
694 | \r | |
695 | 'DXE' : TemplateString("""${BEGIN}\r | |
696 | Status = ${Function} (ImageHandle, SystemTable);\r | |
697 | ASSERT_EFI_ERROR (Status);${END}\r | |
698 | """),\r | |
5a9c3e3e SV |
699 | \r |
700 | 'MM' : TemplateString("""${BEGIN}\r | |
701 | Status = ${Function} (ImageHandle, MmSystemTable);\r | |
702 | ASSERT_EFI_ERROR (Status);${END}\r | |
703 | """),\r | |
f51461c8 LG |
704 | }\r |
705 | \r | |
706 | ## Library Constructor and Destructor Templates\r | |
707 | gLibraryString = {\r | |
8bb63e37 | 708 | SUP_MODULE_BASE : TemplateString("""\r |
f51461c8 LG |
709 | ${BEGIN}${FunctionPrototype}${END}\r |
710 | \r | |
711 | VOID\r | |
712 | EFIAPI\r | |
713 | ProcessLibrary${Type}List (\r | |
714 | VOID\r | |
715 | )\r | |
716 | {\r | |
717 | ${BEGIN} EFI_STATUS Status;\r | |
718 | ${FunctionCall}${END}\r | |
719 | }\r | |
720 | """),\r | |
721 | \r | |
722 | 'PEI' : TemplateString("""\r | |
723 | ${BEGIN}${FunctionPrototype}${END}\r | |
724 | \r | |
725 | VOID\r | |
726 | EFIAPI\r | |
727 | ProcessLibrary${Type}List (\r | |
728 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
729 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
730 | )\r | |
731 | {\r | |
732 | ${BEGIN} EFI_STATUS Status;\r | |
733 | ${FunctionCall}${END}\r | |
734 | }\r | |
735 | """),\r | |
736 | \r | |
737 | 'DXE' : TemplateString("""\r | |
738 | ${BEGIN}${FunctionPrototype}${END}\r | |
739 | \r | |
740 | VOID\r | |
741 | EFIAPI\r | |
742 | ProcessLibrary${Type}List (\r | |
743 | IN EFI_HANDLE ImageHandle,\r | |
744 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
745 | )\r | |
746 | {\r | |
747 | ${BEGIN} EFI_STATUS Status;\r | |
748 | ${FunctionCall}${END}\r | |
749 | }\r | |
750 | """),\r | |
5a9c3e3e SV |
751 | \r |
752 | 'MM' : TemplateString("""\r | |
753 | ${BEGIN}${FunctionPrototype}${END}\r | |
754 | \r | |
755 | VOID\r | |
756 | EFIAPI\r | |
757 | ProcessLibrary${Type}List (\r | |
758 | IN EFI_HANDLE ImageHandle,\r | |
549ae85c | 759 | IN EFI_MM_SYSTEM_TABLE *MmSystemTable\r |
5a9c3e3e SV |
760 | )\r |
761 | {\r | |
762 | ${BEGIN} EFI_STATUS Status;\r | |
763 | ${FunctionCall}${END}\r | |
764 | }\r | |
765 | """),\r | |
f51461c8 LG |
766 | }\r |
767 | \r | |
768 | gBasicHeaderFile = "Base.h"\r | |
769 | \r | |
770 | gModuleTypeHeaderFile = {\r | |
8bb63e37 CJ |
771 | SUP_MODULE_BASE : [gBasicHeaderFile],\r |
772 | SUP_MODULE_SEC : ["PiPei.h", "Library/DebugLib.h"],\r | |
773 | SUP_MODULE_PEI_CORE : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],\r | |
774 | SUP_MODULE_PEIM : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],\r | |
775 | SUP_MODULE_DXE_CORE : ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],\r | |
776 | SUP_MODULE_DXE_DRIVER : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
777 | SUP_MODULE_DXE_SMM_DRIVER : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
778 | SUP_MODULE_DXE_RUNTIME_DRIVER: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
779 | SUP_MODULE_DXE_SAL_DRIVER : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
780 | SUP_MODULE_UEFI_DRIVER : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
781 | SUP_MODULE_UEFI_APPLICATION : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],\r | |
782 | SUP_MODULE_SMM_CORE : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
549ae85c SV |
783 | SUP_MODULE_MM_STANDALONE : ["PiMm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/StandaloneMmDriverEntryPoint.h"],\r |
784 | SUP_MODULE_MM_CORE_STANDALONE : ["PiMm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/StandaloneMmCoreEntryPoint.h"],\r | |
8bb63e37 | 785 | SUP_MODULE_USER_DEFINED : [gBasicHeaderFile]\r |
f51461c8 LG |
786 | }\r |
787 | \r | |
f7496d71 | 788 | ## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName\r |
f51461c8 LG |
789 | # the TokenName and Guid comparison to avoid define name collisions.\r |
790 | #\r | |
791 | # @param Info The ModuleAutoGen object\r | |
792 | # @param AutoGenH The TemplateString object for header file\r | |
793 | #\r | |
794 | #\r | |
795 | def DynExPcdTokenNumberMapping(Info, AutoGenH):\r | |
796 | ExTokenCNameList = []\r | |
797 | PcdExList = []\r | |
d590cce5 YZ |
798 | # Even it is the Library, the PCD is saved in the ModulePcdList\r |
799 | PcdList = Info.ModulePcdList\r | |
f51461c8 | 800 | for Pcd in PcdList:\r |
eece4292 | 801 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r |
f51461c8 LG |
802 | ExTokenCNameList.append(Pcd.TokenCName)\r |
803 | PcdExList.append(Pcd)\r | |
804 | if len(ExTokenCNameList) == 0:\r | |
805 | return\r | |
806 | AutoGenH.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')\r | |
807 | # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.\r | |
f7496d71 | 808 | # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter.\r |
f51461c8 | 809 | # Use the Guid pointer to see if it matches any of the token space GUIDs.\r |
72fbe88d | 810 | TokenCNameList = set()\r |
f51461c8 LG |
811 | for TokenCName in ExTokenCNameList:\r |
812 | if TokenCName in TokenCNameList:\r | |
813 | continue\r | |
814 | Index = 0\r | |
815 | Count = ExTokenCNameList.count(TokenCName)\r | |
816 | for Pcd in PcdExList:\r | |
2a29017e YZ |
817 | RealTokenCName = Pcd.TokenCName\r |
818 | for PcdItem in GlobalData.MixedPcd:\r | |
819 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
820 | RealTokenCName = PcdItem[0]\r | |
821 | break\r | |
f51461c8 LG |
822 | if Pcd.TokenCName == TokenCName:\r |
823 | Index = Index + 1\r | |
824 | if Index == 1:\r | |
2a29017e | 825 | AutoGenH.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (RealTokenCName))\r |
f7496d71 | 826 | AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'\r |
2a29017e | 827 | % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r |
f51461c8 | 828 | else:\r |
f7496d71 | 829 | AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'\r |
2a29017e | 830 | % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r |
f51461c8 LG |
831 | if Index == Count:\r |
832 | AutoGenH.Append('0 \\\n )\n')\r | |
72fbe88d | 833 | TokenCNameList.add(TokenCName)\r |
f7496d71 | 834 | \r |
72fbe88d | 835 | TokenCNameList = set()\r |
f51461c8 LG |
836 | for TokenCName in ExTokenCNameList:\r |
837 | if TokenCName in TokenCNameList:\r | |
838 | continue\r | |
839 | Index = 0\r | |
840 | Count = ExTokenCNameList.count(TokenCName)\r | |
841 | for Pcd in PcdExList:\r | |
2a29017e YZ |
842 | RealTokenCName = Pcd.TokenCName\r |
843 | for PcdItem in GlobalData.MixedPcd:\r | |
844 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
845 | RealTokenCName = PcdItem[0]\r | |
846 | break\r | |
eece4292 | 847 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == TokenCName:\r |
f51461c8 LG |
848 | Index = Index + 1\r |
849 | if Index == 1:\r | |
2a29017e | 850 | AutoGenH.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr) (' % (RealTokenCName))\r |
9023704f | 851 | AutoGenH.Append('\\\n (GuidPtr == NULL) ? 0:')\r |
f7496d71 | 852 | AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'\r |
2a29017e | 853 | % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r |
f51461c8 | 854 | else:\r |
f7496d71 | 855 | AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'\r |
2a29017e | 856 | % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r |
f51461c8 LG |
857 | if Index == Count:\r |
858 | AutoGenH.Append('0 \\\n )\n')\r | |
f7496d71 | 859 | # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID.\r |
f51461c8 LG |
860 | # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler\r |
861 | # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().\r | |
862 | # COMPAREGUID() will only be used if the Guid passed in is local to the module.\r | |
863 | AutoGenH.Append('#define _PCD_TOKEN_EX_%s(GuidPtr) __PCD_%s_ADDR_CMP(GuidPtr) ? __PCD_%s_ADDR_CMP(GuidPtr) : __PCD_%s_VAL_CMP(GuidPtr) \n'\r | |
2a29017e | 864 | % (RealTokenCName, RealTokenCName, RealTokenCName, RealTokenCName))\r |
72fbe88d | 865 | TokenCNameList.add(TokenCName)\r |
f51461c8 LG |
866 | \r |
867 | ## Create code for module PCDs\r | |
868 | #\r | |
869 | # @param Info The ModuleAutoGen object\r | |
870 | # @param AutoGenC The TemplateString object for C code\r | |
871 | # @param AutoGenH The TemplateString object for header file\r | |
872 | # @param Pcd The PCD object\r | |
873 | #\r | |
874 | def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):\r | |
875 | TokenSpaceGuidValue = Pcd.TokenSpaceGuidValue #Info.GuidList[Pcd.TokenSpaceGuidCName]\r | |
876 | PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r | |
2a29017e YZ |
877 | #\r |
878 | # Write PCDs\r | |
879 | #\r | |
880 | TokenCName = Pcd.TokenCName\r | |
881 | for PcdItem in GlobalData.MixedPcd:\r | |
882 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
883 | TokenCName = PcdItem[0]\r | |
884 | break\r | |
885 | PcdTokenName = '_PCD_TOKEN_' + TokenCName\r | |
886 | PatchPcdSizeTokenName = '_PCD_PATCHABLE_' + TokenCName +'_SIZE'\r | |
887 | PatchPcdSizeVariableName = '_gPcd_BinaryPatch_Size_' + TokenCName\r | |
f7b31aa5 | 888 | PatchPcdMaxSizeVariable = '_gPcd_BinaryPatch_MaxSize_' + TokenCName\r |
2a29017e | 889 | FixPcdSizeTokenName = '_PCD_SIZE_' + TokenCName\r |
1bfcf64f | 890 | FixedPcdSizeVariableName = '_gPcd_FixedAtBuild_Size_' + TokenCName\r |
763e8edf | 891 | \r |
0f228f19 B |
892 | if Pcd.PcdValueFromComm:\r |
893 | Pcd.DefaultValue = Pcd.PcdValueFromComm\r | |
543f5ac3 B |
894 | elif Pcd.PcdValueFromFdf:\r |
895 | Pcd.DefaultValue = Pcd.PcdValueFromFdf\r | |
f7496d71 | 896 | \r |
eece4292 | 897 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r |
f51461c8 | 898 | TokenNumber = int(Pcd.TokenValue, 0)\r |
f7496d71 | 899 | # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with\r |
f51461c8 | 900 | # different Guids but same TokenCName\r |
2a29017e | 901 | PcdExTokenName = '_PCD_TOKEN_' + Pcd.TokenSpaceGuidCName + '_' + TokenCName\r |
f51461c8 LG |
902 | AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r |
903 | else:\r | |
904 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r | |
f7496d71 LG |
905 | # If one of the Source built modules listed in the DSC is not listed in FDF modules,\r |
906 | # and the INF lists a PCD can only use the PcdsDynamic access method (it is only\r | |
907 | # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will\r | |
908 | # report warning message notify the PI that they are attempting to build a module\r | |
909 | # that must be included in a flash image in order to be functional. These Dynamic PCD\r | |
910 | # will not be added into the Database unless it is used by other modules that are\r | |
911 | # included in the FDF file.\r | |
f51461c8 | 912 | # In this case, just assign an invalid token number to make it pass build.\r |
eece4292 | 913 | if Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r |
f51461c8 LG |
914 | TokenNumber = 0\r |
915 | else:\r | |
916 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 917 | "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
918 | ExtraData="[%s]" % str(Info))\r |
919 | else:\r | |
920 | TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r | |
921 | AutoGenH.Append('\n#define %s %dU\n' % (PcdTokenName, TokenNumber))\r | |
922 | \r | |
2a29017e | 923 | EdkLogger.debug(EdkLogger.DEBUG_3, "Creating code for " + TokenCName + "." + Pcd.TokenSpaceGuidCName)\r |
f51461c8 LG |
924 | if Pcd.Type not in gItemTypeStringDatabase:\r |
925 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 926 | "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 | 927 | ExtraData="[%s]" % str(Info))\r |
f51461c8 | 928 | \r |
656d2539 CJ |
929 | DatumSize = gDatumSizeStringDatabase[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabase else gDatumSizeStringDatabase[TAB_VOID]\r |
930 | DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabaseLib else gDatumSizeStringDatabaseLib[TAB_VOID]\r | |
931 | GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_' + TokenCName\r | |
932 | SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_' + TokenCName\r | |
933 | SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_S_' + TokenCName\r | |
2a29017e | 934 | GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r |
f7496d71 | 935 | \r |
eece4292 | 936 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r |
f51461c8 LG |
937 | if Info.IsLibrary:\r |
938 | PcdList = Info.LibraryPcdList\r | |
939 | else:\r | |
1ccc4d89 | 940 | PcdList = Info.ModulePcdList + Info.LibraryPcdList\r |
72fbe88d | 941 | PcdExCNameTest = 0\r |
f51461c8 | 942 | for PcdModule in PcdList:\r |
eece4292 | 943 | if PcdModule.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r |
72fbe88d CJ |
944 | PcdExCNameTest += 1\r |
945 | # get out early once we found > 1...\r | |
946 | if PcdExCNameTest > 1:\r | |
947 | break\r | |
f51461c8 LG |
948 | # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.\r |
949 | # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r | |
950 | # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r | |
72fbe88d | 951 | if PcdExCNameTest > 1:\r |
f51461c8 LG |
952 | AutoGenH.Append('// Disabled the macros, as PcdToken and PcdGet/Set are not allowed in the case that more than one DynamicEx Pcds are different Guids but same CName.\n')\r |
953 | AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r | |
954 | AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
ccaa7754 | 955 | AutoGenH.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
656d2539 | 956 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 | 957 | AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
82a6a960 | 958 | AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
959 | else:\r |
960 | AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
82a6a960 | 961 | AutoGenH.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
962 | else:\r |
963 | AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r | |
964 | AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
ccaa7754 | 965 | AutoGenH.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
656d2539 | 966 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 | 967 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
82a6a960 | 968 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
969 | else:\r |
970 | AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
82a6a960 | 971 | AutoGenH.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
eece4292 | 972 | elif Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r |
72fbe88d | 973 | PcdCNameTest = 0\r |
1ccc4d89 | 974 | for PcdModule in Info.LibraryPcdList + Info.ModulePcdList:\r |
eece4292 | 975 | if PcdModule.Type in PCD_DYNAMIC_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r |
72fbe88d CJ |
976 | PcdCNameTest += 1\r |
977 | # get out early once we found > 1...\r | |
978 | if PcdCNameTest > 1:\r | |
979 | break\r | |
980 | if PcdCNameTest > 1:\r | |
2a29017e | 981 | EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName. They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r |
f51461c8 | 982 | else:\r |
38b986e3 YZ |
983 | AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r |
984 | AutoGenH.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName, PcdTokenName))\r | |
656d2539 | 985 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
38b986e3 YZ |
986 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r |
987 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r | |
988 | else:\r | |
989 | AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r | |
990 | AutoGenH.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r | |
f51461c8 | 991 | else:\r |
2a29017e | 992 | PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + TokenCName\r |
f51461c8 LG |
993 | Const = 'const'\r |
994 | if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r | |
995 | Const = ''\r | |
996 | Type = ''\r | |
997 | Array = ''\r | |
998 | Value = Pcd.DefaultValue\r | |
999 | Unicode = False\r | |
1000 | ValueNumber = 0\r | |
1001 | \r | |
1002 | if Pcd.DatumType == 'BOOLEAN':\r | |
1003 | BoolValue = Value.upper()\r | |
1004 | if BoolValue == 'TRUE' or BoolValue == '1':\r | |
1005 | Value = '1U'\r | |
1006 | elif BoolValue == 'FALSE' or BoolValue == '0':\r | |
1007 | Value = '0U'\r | |
1008 | \r | |
656d2539 | 1009 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
f51461c8 | 1010 | try:\r |
726c501c YZ |
1011 | if Value.upper().endswith('L'):\r |
1012 | Value = Value[:-1]\r | |
94c91295 | 1013 | if Value.startswith('0') and not Value.lower().startswith('0x') and len(Value) > 1 and Value.lstrip('0'):\r |
1590d123 | 1014 | Value = Value.lstrip('0')\r |
0944818a | 1015 | ValueNumber = int (Value, 0)\r |
f51461c8 | 1016 | except:\r |
1ccc4d89 | 1017 | EdkLogger.error("build", AUTOGEN_ERROR,\r |
2a29017e | 1018 | "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 | 1019 | ExtraData="[%s]" % str(Info))\r |
c526dcd4 | 1020 | if ValueNumber < 0:\r |
1021 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
1022 | "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r | |
1023 | ExtraData="[%s]" % str(Info))\r | |
1024 | elif ValueNumber > MAX_VAL_TYPE[Pcd.DatumType]:\r | |
1025 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
1026 | "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r | |
1027 | ExtraData="[%s]" % str(Info))\r | |
1028 | if Pcd.DatumType == TAB_UINT64 and not Value.endswith('ULL'):\r | |
1029 | Value += 'ULL'\r | |
1030 | elif Pcd.DatumType != TAB_UINT64 and not Value.endswith('U'):\r | |
1031 | Value += 'U'\r | |
1032 | \r | |
656d2539 | 1033 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
6b285ca3 | 1034 | if not Pcd.MaxDatumSize:\r |
f51461c8 | 1035 | EdkLogger.error("build", AUTOGEN_ERROR,\r |
2a29017e | 1036 | "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1037 | ExtraData="[%s]" % str(Info))\r |
1038 | \r | |
1039 | ArraySize = int(Pcd.MaxDatumSize, 0)\r | |
1040 | if Value[0] == '{':\r | |
1041 | Type = '(VOID *)'\r | |
6b285ca3 | 1042 | ValueSize = len(Value.split(','))\r |
f51461c8 LG |
1043 | else:\r |
1044 | if Value[0] == 'L':\r | |
1045 | Unicode = True\r | |
1046 | Value = Value.lstrip('L') #.strip('"')\r | |
1047 | Value = eval(Value) # translate escape character\r | |
6b285ca3 | 1048 | ValueSize = len(Value) + 1\r |
f51461c8 | 1049 | NewValue = '{'\r |
ccaa7754 | 1050 | for Index in range(0, len(Value)):\r |
f51461c8 LG |
1051 | if Unicode:\r |
1052 | NewValue = NewValue + str(ord(Value[Index]) % 0x10000) + ', '\r | |
1053 | else:\r | |
1054 | NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ', '\r | |
1055 | if Unicode:\r | |
b3e94a06 | 1056 | ArraySize = ArraySize // 2\r |
f51461c8 | 1057 | Value = NewValue + '0 }'\r |
6b285ca3 YF |
1058 | if ArraySize < ValueSize:\r |
1059 | if Pcd.MaxSizeUserSet:\r | |
1060 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
1061 | "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName),\r | |
1062 | ExtraData="[%s]" % str(Info))\r | |
1063 | else:\r | |
1064 | ArraySize = Pcd.GetPcdSize()\r | |
1065 | if Unicode:\r | |
b3e94a06 | 1066 | ArraySize = ArraySize // 2\r |
f51461c8 LG |
1067 | Array = '[%d]' % ArraySize\r |
1068 | #\r | |
1069 | # skip casting for fixed at build since it breaks ARM assembly.\r | |
1070 | # Long term we need PCD macros that work in assembly\r | |
1071 | #\r | |
656d2539 | 1072 | elif Pcd.Type != TAB_PCDS_FIXED_AT_BUILD and Pcd.DatumType in TAB_PCD_NUMERIC_TYPES_VOID:\r |
f51461c8 LG |
1073 | Value = "((%s)%s)" % (Pcd.DatumType, Value)\r |
1074 | \r | |
1075 | if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r | |
2a29017e | 1076 | PcdValueName = '_PCD_PATCHABLE_VALUE_' + TokenCName\r |
f51461c8 | 1077 | else:\r |
2a29017e | 1078 | PcdValueName = '_PCD_VALUE_' + TokenCName\r |
f7496d71 | 1079 | \r |
656d2539 | 1080 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 LG |
1081 | #\r |
1082 | # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.\r | |
1083 | #\r | |
674e2014 | 1084 | AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))\r |
f51461c8 | 1085 | if Unicode:\r |
f51461c8 LG |
1086 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r |
1087 | AutoGenH.Append('extern %s UINT16 %s%s;\n' %(Const, PcdVariableName, Array))\r | |
f51461c8 | 1088 | else:\r |
f51461c8 LG |
1089 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r |
1090 | AutoGenH.Append('extern %s UINT8 %s%s;\n' %(Const, PcdVariableName, Array))\r | |
674e2014 | 1091 | AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))\r |
f7496d71 | 1092 | \r |
5565a8c4 | 1093 | PcdDataSize = Pcd.GetPcdSize()\r |
2f5acc3b BF |
1094 | if Pcd.Type == TAB_PCDS_FIXED_AT_BUILD:\r |
1095 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r | |
ccaa7754 GL |
1096 | AutoGenH.Append('#define %s %s \n' % (GetModeSizeName, FixPcdSizeTokenName))\r |
1097 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (FixedPcdSizeVariableName, PcdDataSize))\r | |
2f5acc3b BF |
1098 | if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r |
1099 | AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, Pcd.MaxDatumSize))\r | |
ccaa7754 | 1100 | AutoGenH.Append('#define %s %s \n' % (GetModeSizeName, PatchPcdSizeVariableName))\r |
2f5acc3b | 1101 | AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r |
ccaa7754 GL |
1102 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName, PcdDataSize))\r |
1103 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (PatchPcdMaxSizeVariable, Pcd.MaxDatumSize))\r | |
f51461c8 LG |
1104 | elif Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r |
1105 | AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r | |
1106 | AutoGenC.Append('volatile %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r | |
1107 | AutoGenH.Append('extern volatile %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r | |
1108 | AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r | |
f7496d71 | 1109 | \r |
5565a8c4 | 1110 | PcdDataSize = Pcd.GetPcdSize()\r |
2f5acc3b | 1111 | AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r |
f7496d71 | 1112 | \r |
ccaa7754 | 1113 | AutoGenH.Append('#define %s %s \n' % (GetModeSizeName, PatchPcdSizeVariableName))\r |
2f5acc3b | 1114 | AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r |
ccaa7754 | 1115 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName, PcdDataSize))\r |
f51461c8 | 1116 | else:\r |
5565a8c4 | 1117 | PcdDataSize = Pcd.GetPcdSize()\r |
2f5acc3b | 1118 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r |
ccaa7754 | 1119 | AutoGenH.Append('#define %s %s \n' % (GetModeSizeName, FixPcdSizeTokenName))\r |
f7496d71 | 1120 | \r |
f51461c8 LG |
1121 | AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r |
1122 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r | |
1123 | AutoGenH.Append('extern %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r | |
1124 | AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r | |
1125 | \r | |
1126 | if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r | |
656d2539 | 1127 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
e70504cd LG |
1128 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r |
1129 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r | |
f51461c8 LG |
1130 | else:\r |
1131 | AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r | |
82a6a960 | 1132 | AutoGenH.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName, PcdVariableName))\r |
f51461c8 LG |
1133 | else:\r |
1134 | AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r | |
1135 | \r | |
1136 | ## Create code for library module PCDs\r | |
1137 | #\r | |
1138 | # @param Info The ModuleAutoGen object\r | |
1139 | # @param AutoGenC The TemplateString object for C code\r | |
1140 | # @param AutoGenH The TemplateString object for header file\r | |
1141 | # @param Pcd The PCD object\r | |
1142 | #\r | |
1143 | def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):\r | |
1144 | PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r | |
1145 | TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName\r | |
1146 | TokenCName = Pcd.TokenCName\r | |
2a29017e YZ |
1147 | for PcdItem in GlobalData.MixedPcd:\r |
1148 | if (TokenCName, TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
1149 | TokenCName = PcdItem[0]\r | |
1150 | break\r | |
f51461c8 | 1151 | PcdTokenName = '_PCD_TOKEN_' + TokenCName\r |
2a29017e YZ |
1152 | FixPcdSizeTokenName = '_PCD_SIZE_' + TokenCName\r |
1153 | PatchPcdSizeTokenName = '_PCD_PATCHABLE_' + TokenCName +'_SIZE'\r | |
1154 | PatchPcdSizeVariableName = '_gPcd_BinaryPatch_Size_' + TokenCName\r | |
f7b31aa5 | 1155 | PatchPcdMaxSizeVariable = '_gPcd_BinaryPatch_MaxSize_' + TokenCName\r |
1bfcf64f | 1156 | FixedPcdSizeVariableName = '_gPcd_FixedAtBuild_Size_' + TokenCName\r |
763e8edf | 1157 | \r |
0f228f19 B |
1158 | if Pcd.PcdValueFromComm:\r |
1159 | Pcd.DefaultValue = Pcd.PcdValueFromComm\r | |
543f5ac3 B |
1160 | elif Pcd.PcdValueFromFdf:\r |
1161 | Pcd.DefaultValue = Pcd.PcdValueFromFdf\r | |
f51461c8 LG |
1162 | #\r |
1163 | # Write PCDs\r | |
1164 | #\r | |
eece4292 | 1165 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r |
f51461c8 LG |
1166 | TokenNumber = int(Pcd.TokenValue, 0)\r |
1167 | else:\r | |
1168 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r | |
f7496d71 LG |
1169 | # If one of the Source built modules listed in the DSC is not listed in FDF modules,\r |
1170 | # and the INF lists a PCD can only use the PcdsDynamic access method (it is only\r | |
1171 | # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will\r | |
1172 | # report warning message notify the PI that they are attempting to build a module\r | |
1173 | # that must be included in a flash image in order to be functional. These Dynamic PCD\r | |
1174 | # will not be added into the Database unless it is used by other modules that are\r | |
1175 | # included in the FDF file.\r | |
f51461c8 | 1176 | # In this case, just assign an invalid token number to make it pass build.\r |
eece4292 | 1177 | if Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r |
f51461c8 LG |
1178 | TokenNumber = 0\r |
1179 | else:\r | |
1180 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1181 | "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1182 | ExtraData="[%s]" % str(Info))\r |
1183 | else:\r | |
1184 | TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r | |
1185 | \r | |
1186 | if Pcd.Type not in gItemTypeStringDatabase:\r | |
1187 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1188 | "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 | 1189 | ExtraData="[%s]" % str(Info))\r |
f51461c8 LG |
1190 | \r |
1191 | DatumType = Pcd.DatumType\r | |
656d2539 CJ |
1192 | DatumSize = gDatumSizeStringDatabase[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabase else gDatumSizeStringDatabase[TAB_VOID]\r |
1193 | DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabaseLib else gDatumSizeStringDatabaseLib[TAB_VOID]\r | |
1194 | GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_' + TokenCName\r | |
1195 | SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_' + TokenCName\r | |
1196 | SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_S_' + TokenCName\r | |
2a29017e | 1197 | GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r |
f51461c8 LG |
1198 | \r |
1199 | Type = ''\r | |
1200 | Array = ''\r | |
656d2539 | 1201 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
d66670f9 YZ |
1202 | if Pcd.DefaultValue[0]== '{':\r |
1203 | Type = '(VOID *)'\r | |
f51461c8 LG |
1204 | Array = '[]'\r |
1205 | PcdItemType = Pcd.Type\r | |
eece4292 | 1206 | if PcdItemType in PCD_DYNAMIC_EX_TYPE_SET:\r |
2a29017e | 1207 | PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + TokenCName\r |
f51461c8 | 1208 | AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r |
f7496d71 | 1209 | \r |
f51461c8 LG |
1210 | if Info.IsLibrary:\r |
1211 | PcdList = Info.LibraryPcdList\r | |
1212 | else:\r | |
1213 | PcdList = Info.ModulePcdList\r | |
72fbe88d | 1214 | PcdExCNameTest = 0\r |
f51461c8 | 1215 | for PcdModule in PcdList:\r |
eece4292 | 1216 | if PcdModule.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r |
72fbe88d CJ |
1217 | PcdExCNameTest += 1\r |
1218 | # get out early once we found > 1...\r | |
1219 | if PcdExCNameTest > 1:\r | |
1220 | break\r | |
f51461c8 LG |
1221 | # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.\r |
1222 | # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r | |
1223 | # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r | |
72fbe88d | 1224 | if PcdExCNameTest > 1:\r |
f51461c8 LG |
1225 | AutoGenH.Append('// Disabled the macros, as PcdToken and PcdGet/Set are not allowed in the case that more than one DynamicEx Pcds are different Guids but same CName.\n')\r |
1226 | AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r | |
1227 | AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
ccaa7754 | 1228 | AutoGenH.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
656d2539 | 1229 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 | 1230 | AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
82a6a960 | 1231 | AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
1232 | else:\r |
1233 | AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
82a6a960 | 1234 | AutoGenH.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
1235 | else:\r |
1236 | AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r | |
1237 | AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
ccaa7754 | 1238 | AutoGenH.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
656d2539 | 1239 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 | 1240 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
82a6a960 | 1241 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
1242 | else:\r |
1243 | AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
82a6a960 | 1244 | AutoGenH.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
1245 | else:\r |
1246 | AutoGenH.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName, TokenNumber))\r | |
eece4292 | 1247 | if PcdItemType in PCD_DYNAMIC_TYPE_SET:\r |
38b986e3 YZ |
1248 | PcdList = []\r |
1249 | PcdCNameList = []\r | |
1250 | PcdList.extend(Info.LibraryPcdList)\r | |
1251 | PcdList.extend(Info.ModulePcdList)\r | |
1252 | for PcdModule in PcdList:\r | |
eece4292 | 1253 | if PcdModule.Type in PCD_DYNAMIC_TYPE_SET:\r |
38b986e3 YZ |
1254 | PcdCNameList.append(PcdModule.TokenCName)\r |
1255 | if PcdCNameList.count(Pcd.TokenCName) > 1:\r | |
2a29017e | 1256 | EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName.They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r |
f51461c8 | 1257 | else:\r |
38b986e3 YZ |
1258 | AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r |
1259 | AutoGenH.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName, PcdTokenName))\r | |
656d2539 | 1260 | if DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
38b986e3 YZ |
1261 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r |
1262 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r | |
1263 | else:\r | |
1264 | AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r | |
1265 | AutoGenH.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r | |
f51461c8 LG |
1266 | if PcdItemType == TAB_PCDS_PATCHABLE_IN_MODULE:\r |
1267 | PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[TAB_PCDS_PATCHABLE_IN_MODULE] + '_' + TokenCName\r | |
656d2539 CJ |
1268 | if DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
1269 | if DatumType == TAB_VOID and Array == '[]':\r | |
1270 | DatumType = [TAB_UINT8, TAB_UINT16][Pcd.DefaultValue[0] == 'L']\r | |
f7b31aa5 | 1271 | else:\r |
656d2539 | 1272 | DatumType = TAB_UINT8\r |
d66670f9 YZ |
1273 | AutoGenH.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType, TokenCName, Array))\r |
1274 | else:\r | |
1275 | AutoGenH.Append('extern volatile %s %s%s;\n' % (DatumType, PcdVariableName, Array))\r | |
f51461c8 | 1276 | AutoGenH.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))\r |
5565a8c4 | 1277 | PcdDataSize = Pcd.GetPcdSize()\r |
656d2539 | 1278 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f7b31aa5 YZ |
1279 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, TokenCName, PatchPcdSizeVariableName, PatchPcdMaxSizeVariable))\r |
1280 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, TokenCName, PatchPcdSizeVariableName, PatchPcdMaxSizeVariable))\r | |
bfa7eeb6 | 1281 | AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PatchPcdMaxSizeVariable))\r |
f7b31aa5 | 1282 | AutoGenH.Append('extern const UINTN %s; \n' % PatchPcdMaxSizeVariable)\r |
27187d24 LG |
1283 | else:\r |
1284 | AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r | |
1285 | AutoGenH.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName, PcdVariableName))\r | |
a6c31c6d YZ |
1286 | AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r |
1287 | \r | |
ccaa7754 | 1288 | AutoGenH.Append('#define %s %s\n' % (GetModeSizeName, PatchPcdSizeVariableName))\r |
2f5acc3b | 1289 | AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r |
f7496d71 | 1290 | \r |
f51461c8 | 1291 | if PcdItemType == TAB_PCDS_FIXED_AT_BUILD or PcdItemType == TAB_PCDS_FEATURE_FLAG:\r |
ccaa7754 | 1292 | key = ".".join((Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r |
7256bd55 | 1293 | PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + TokenCName\r |
656d2539 CJ |
1294 | if DatumType == TAB_VOID and Array == '[]':\r |
1295 | DatumType = [TAB_UINT8, TAB_UINT16][Pcd.DefaultValue[0] == 'L']\r | |
1296 | if DatumType not in TAB_PCD_NUMERIC_TYPES_VOID:\r | |
1297 | DatumType = TAB_UINT8\r | |
f51461c8 LG |
1298 | AutoGenH.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType, TokenCName, Array))\r |
1299 | AutoGenH.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName, Type, TokenCName))\r | |
1300 | AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r | |
f7496d71 | 1301 | \r |
1bfcf64f | 1302 | ConstFixedPcd = False\r |
b23414f6 | 1303 | if PcdItemType == TAB_PCDS_FIXED_AT_BUILD and (key in Info.ConstPcd or (Info.IsLibrary and not Info.ReferenceModules)):\r |
1bfcf64f | 1304 | ConstFixedPcd = True\r |
eca980c0 YZ |
1305 | if key in Info.ConstPcd:\r |
1306 | Pcd.DefaultValue = Info.ConstPcd[key]\r | |
656d2539 | 1307 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
7256bd55 YZ |
1308 | AutoGenH.Append('#define _PCD_VALUE_%s %s%s\n' %(TokenCName, Type, PcdVariableName))\r |
1309 | else:\r | |
1310 | AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))\r | |
5565a8c4 | 1311 | PcdDataSize = Pcd.GetPcdSize()\r |
2f5acc3b | 1312 | if PcdItemType == TAB_PCDS_FIXED_AT_BUILD:\r |
656d2539 | 1313 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
1bfcf64f YZ |
1314 | if ConstFixedPcd:\r |
1315 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r | |
ccaa7754 | 1316 | AutoGenH.Append('#define %s %s\n' % (GetModeSizeName, FixPcdSizeTokenName))\r |
1bfcf64f | 1317 | else:\r |
ccaa7754 GL |
1318 | AutoGenH.Append('#define %s %s\n' % (GetModeSizeName, FixedPcdSizeVariableName))\r |
1319 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, FixedPcdSizeVariableName))\r | |
1bfcf64f YZ |
1320 | AutoGenH.Append('extern const UINTN %s; \n' % FixedPcdSizeVariableName)\r |
1321 | else:\r | |
1322 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r | |
ccaa7754 | 1323 | AutoGenH.Append('#define %s %s\n' % (GetModeSizeName, FixPcdSizeTokenName))\r |
f51461c8 LG |
1324 | \r |
1325 | ## Create code for library constructor\r | |
1326 | #\r | |
1327 | # @param Info The ModuleAutoGen object\r | |
1328 | # @param AutoGenC The TemplateString object for C code\r | |
1329 | # @param AutoGenH The TemplateString object for header file\r | |
1330 | #\r | |
1331 | def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):\r | |
1332 | #\r | |
1333 | # Library Constructors\r | |
1334 | #\r | |
1335 | ConstructorPrototypeString = TemplateString()\r | |
1336 | ConstructorCallingString = TemplateString()\r | |
1337 | if Info.IsLibrary:\r | |
1338 | DependentLibraryList = [Info.Module]\r | |
1339 | else:\r | |
1340 | DependentLibraryList = Info.DependentLibraryList\r | |
1341 | for Lib in DependentLibraryList:\r | |
1342 | if len(Lib.ConstructorList) <= 0:\r | |
1343 | continue\r | |
1344 | Dict = {'Function':Lib.ConstructorList}\r | |
8bb63e37 CJ |
1345 | if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r |
1346 | ConstructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))\r | |
1347 | ConstructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))\r | |
88c6c1b6 | 1348 | elif Lib.ModuleType in SUP_MODULE_SET_PEI:\r |
f51461c8 LG |
1349 | ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r |
1350 | ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r | |
ccaa7754 GL |
1351 | elif Lib.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,\r |
1352 | SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r | |
f51461c8 LG |
1353 | ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r |
1354 | ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r | |
ccaa7754 | 1355 | elif Lib.ModuleType in [SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]:\r |
5a9c3e3e SV |
1356 | ConstructorPrototypeString.Append(gLibraryStructorPrototype['MM'].Replace(Dict))\r |
1357 | ConstructorCallingString.Append(gLibraryStructorCall['MM'].Replace(Dict))\r | |
f51461c8 LG |
1358 | \r |
1359 | if str(ConstructorPrototypeString) == '':\r | |
1360 | ConstructorPrototypeList = []\r | |
1361 | else:\r | |
1362 | ConstructorPrototypeList = [str(ConstructorPrototypeString)]\r | |
1363 | if str(ConstructorCallingString) == '':\r | |
1364 | ConstructorCallingList = []\r | |
1365 | else:\r | |
1366 | ConstructorCallingList = [str(ConstructorCallingString)]\r | |
1367 | \r | |
1368 | Dict = {\r | |
1369 | 'Type' : 'Constructor',\r | |
1370 | 'FunctionPrototype' : ConstructorPrototypeList,\r | |
1371 | 'FunctionCall' : ConstructorCallingList\r | |
1372 | }\r | |
1373 | if Info.IsLibrary:\r | |
1374 | AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r | |
1375 | else:\r | |
8bb63e37 CJ |
1376 | if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r |
1377 | AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))\r | |
88c6c1b6 | 1378 | elif Info.ModuleType in SUP_MODULE_SET_PEI:\r |
f51461c8 | 1379 | AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r |
ccaa7754 GL |
1380 | elif Info.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,\r |
1381 | SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r | |
f51461c8 | 1382 | AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r |
ccaa7754 | 1383 | elif Info.ModuleType in [SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]:\r |
5a9c3e3e | 1384 | AutoGenC.Append(gLibraryString['MM'].Replace(Dict))\r |
f51461c8 LG |
1385 | \r |
1386 | ## Create code for library destructor\r | |
1387 | #\r | |
1388 | # @param Info The ModuleAutoGen object\r | |
1389 | # @param AutoGenC The TemplateString object for C code\r | |
1390 | # @param AutoGenH The TemplateString object for header file\r | |
1391 | #\r | |
1392 | def CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH):\r | |
1393 | #\r | |
1394 | # Library Destructors\r | |
1395 | #\r | |
1396 | DestructorPrototypeString = TemplateString()\r | |
1397 | DestructorCallingString = TemplateString()\r | |
1398 | if Info.IsLibrary:\r | |
1399 | DependentLibraryList = [Info.Module]\r | |
1400 | else:\r | |
1401 | DependentLibraryList = Info.DependentLibraryList\r | |
1402 | for Index in range(len(DependentLibraryList)-1, -1, -1):\r | |
1403 | Lib = DependentLibraryList[Index]\r | |
1404 | if len(Lib.DestructorList) <= 0:\r | |
1405 | continue\r | |
1406 | Dict = {'Function':Lib.DestructorList}\r | |
8bb63e37 CJ |
1407 | if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r |
1408 | DestructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))\r | |
1409 | DestructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))\r | |
88c6c1b6 | 1410 | elif Lib.ModuleType in SUP_MODULE_SET_PEI:\r |
f51461c8 LG |
1411 | DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r |
1412 | DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r | |
ccaa7754 GL |
1413 | elif Lib.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,\r |
1414 | SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r | |
f51461c8 LG |
1415 | DestructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r |
1416 | DestructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r | |
ccaa7754 | 1417 | elif Lib.ModuleType in [SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]:\r |
5a9c3e3e SV |
1418 | DestructorPrototypeString.Append(gLibraryStructorPrototype['MM'].Replace(Dict))\r |
1419 | DestructorCallingString.Append(gLibraryStructorCall['MM'].Replace(Dict))\r | |
f51461c8 LG |
1420 | \r |
1421 | if str(DestructorPrototypeString) == '':\r | |
1422 | DestructorPrototypeList = []\r | |
1423 | else:\r | |
1424 | DestructorPrototypeList = [str(DestructorPrototypeString)]\r | |
1425 | if str(DestructorCallingString) == '':\r | |
1426 | DestructorCallingList = []\r | |
1427 | else:\r | |
1428 | DestructorCallingList = [str(DestructorCallingString)]\r | |
1429 | \r | |
1430 | Dict = {\r | |
1431 | 'Type' : 'Destructor',\r | |
1432 | 'FunctionPrototype' : DestructorPrototypeList,\r | |
1433 | 'FunctionCall' : DestructorCallingList\r | |
1434 | }\r | |
1435 | if Info.IsLibrary:\r | |
1436 | AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r | |
1437 | else:\r | |
8bb63e37 CJ |
1438 | if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r |
1439 | AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))\r | |
88c6c1b6 | 1440 | elif Info.ModuleType in SUP_MODULE_SET_PEI:\r |
f51461c8 | 1441 | AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r |
ccaa7754 GL |
1442 | elif Info.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,\r |
1443 | SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r | |
f51461c8 | 1444 | AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r |
ccaa7754 | 1445 | elif Info.ModuleType in [SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]:\r |
5a9c3e3e | 1446 | AutoGenC.Append(gLibraryString['MM'].Replace(Dict))\r |
f51461c8 LG |
1447 | \r |
1448 | \r | |
1449 | ## Create code for ModuleEntryPoint\r | |
1450 | #\r | |
1451 | # @param Info The ModuleAutoGen object\r | |
1452 | # @param AutoGenC The TemplateString object for C code\r | |
1453 | # @param AutoGenH The TemplateString object for header file\r | |
1454 | #\r | |
1455 | def CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1456 | if Info.IsLibrary or Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_SEC]:\r |
f51461c8 | 1457 | return\r |
838bc257 FZ |
1458 | ModuleEntryPointList = []\r |
1459 | for Lib in Info.DependentLibraryList:\r | |
1460 | if len(Lib.ModuleEntryPointList) > 0:\r | |
1461 | if Lib.ModuleType == Info.ModuleType:\r | |
1462 | ModuleEntryPointList = ModuleEntryPointList + Lib.ModuleEntryPointList\r | |
1463 | else:\r | |
1464 | EdkLogger.error(\r | |
1465 | "build",\r | |
1466 | PREBUILD_ERROR,\r | |
1467 | "Driver's ModuleType must be consistent [%s]"%(str(Lib)),\r | |
1468 | File=str(Info.PlatformInfo),\r | |
1469 | ExtraData="consumed by [%s]" % str(Info.MetaFile)\r | |
1470 | )\r | |
1471 | ModuleEntryPointList = ModuleEntryPointList + Info.Module.ModuleEntryPointList\r | |
1472 | \r | |
f51461c8 LG |
1473 | #\r |
1474 | # Module Entry Points\r | |
1475 | #\r | |
838bc257 | 1476 | NumEntryPoints = len(ModuleEntryPointList)\r |
f51461c8 LG |
1477 | if 'PI_SPECIFICATION_VERSION' in Info.Module.Specification:\r |
1478 | PiSpecVersion = Info.Module.Specification['PI_SPECIFICATION_VERSION']\r | |
1479 | else:\r | |
1480 | PiSpecVersion = '0x00000000'\r | |
1481 | if 'UEFI_SPECIFICATION_VERSION' in Info.Module.Specification:\r | |
1482 | UefiSpecVersion = Info.Module.Specification['UEFI_SPECIFICATION_VERSION']\r | |
1483 | else:\r | |
1484 | UefiSpecVersion = '0x00000000'\r | |
1485 | Dict = {\r | |
838bc257 | 1486 | 'Function' : ModuleEntryPointList,\r |
f51461c8 LG |
1487 | 'PiSpecVersion' : PiSpecVersion + 'U',\r |
1488 | 'UefiSpecVersion': UefiSpecVersion + 'U'\r | |
1489 | }\r | |
1490 | \r | |
8bb63e37 | 1491 | if Info.ModuleType in [SUP_MODULE_PEI_CORE, SUP_MODULE_DXE_CORE, SUP_MODULE_SMM_CORE, SUP_MODULE_MM_CORE_STANDALONE]:\r |
128d435f | 1492 | if Info.SourceFileList:\r |
f51461c8 LG |
1493 | if NumEntryPoints != 1:\r |
1494 | EdkLogger.error(\r | |
1495 | "build",\r | |
1496 | AUTOGEN_ERROR,\r | |
1497 | '%s must have exactly one entry point' % Info.ModuleType,\r | |
1498 | File=str(Info),\r | |
838bc257 | 1499 | ExtraData= ", ".join(ModuleEntryPointList)\r |
f51461c8 | 1500 | )\r |
8bb63e37 | 1501 | if Info.ModuleType == SUP_MODULE_PEI_CORE:\r |
f51461c8 LG |
1502 | AutoGenC.Append(gPeiCoreEntryPointString.Replace(Dict))\r |
1503 | AutoGenH.Append(gPeiCoreEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1504 | elif Info.ModuleType == SUP_MODULE_DXE_CORE:\r |
f51461c8 LG |
1505 | AutoGenC.Append(gDxeCoreEntryPointString.Replace(Dict))\r |
1506 | AutoGenH.Append(gDxeCoreEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1507 | elif Info.ModuleType == SUP_MODULE_SMM_CORE:\r |
f51461c8 LG |
1508 | AutoGenC.Append(gSmmCoreEntryPointString.Replace(Dict))\r |
1509 | AutoGenH.Append(gSmmCoreEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1510 | elif Info.ModuleType == SUP_MODULE_MM_CORE_STANDALONE:\r |
5a9c3e3e SV |
1511 | AutoGenC.Append(gMmCoreStandaloneEntryPointString.Replace(Dict))\r |
1512 | AutoGenH.Append(gMmCoreStandaloneEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1513 | elif Info.ModuleType == SUP_MODULE_PEIM:\r |
f51461c8 LG |
1514 | if NumEntryPoints < 2:\r |
1515 | AutoGenC.Append(gPeimEntryPointString[NumEntryPoints].Replace(Dict))\r | |
1516 | else:\r | |
1517 | AutoGenC.Append(gPeimEntryPointString[2].Replace(Dict))\r | |
1518 | AutoGenH.Append(gPeimEntryPointPrototype.Replace(Dict))\r | |
ccaa7754 | 1519 | elif Info.ModuleType in [SUP_MODULE_DXE_RUNTIME_DRIVER, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER]:\r |
f51461c8 LG |
1520 | if NumEntryPoints < 2:\r |
1521 | AutoGenC.Append(gUefiDriverEntryPointString[NumEntryPoints].Replace(Dict))\r | |
1522 | else:\r | |
1523 | AutoGenC.Append(gUefiDriverEntryPointString[2].Replace(Dict))\r | |
1524 | AutoGenH.Append(gUefiDriverEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1525 | elif Info.ModuleType == SUP_MODULE_DXE_SMM_DRIVER:\r |
f51461c8 LG |
1526 | if NumEntryPoints == 0:\r |
1527 | AutoGenC.Append(gDxeSmmEntryPointString[0].Replace(Dict))\r | |
1528 | else:\r | |
1529 | AutoGenC.Append(gDxeSmmEntryPointString[1].Replace(Dict))\r | |
5a9c3e3e | 1530 | AutoGenH.Append(gDxeSmmEntryPointPrototype.Replace(Dict))\r |
8bb63e37 | 1531 | elif Info.ModuleType == SUP_MODULE_MM_STANDALONE:\r |
5a9c3e3e SV |
1532 | if NumEntryPoints < 2:\r |
1533 | AutoGenC.Append(gMmStandaloneEntryPointString[NumEntryPoints].Replace(Dict))\r | |
1534 | else:\r | |
1535 | AutoGenC.Append(gMmStandaloneEntryPointString[2].Replace(Dict))\r | |
1536 | AutoGenH.Append(gMmStandaloneEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1537 | elif Info.ModuleType == SUP_MODULE_UEFI_APPLICATION:\r |
f51461c8 LG |
1538 | if NumEntryPoints < 2:\r |
1539 | AutoGenC.Append(gUefiApplicationEntryPointString[NumEntryPoints].Replace(Dict))\r | |
1540 | else:\r | |
1541 | AutoGenC.Append(gUefiApplicationEntryPointString[2].Replace(Dict))\r | |
1542 | AutoGenH.Append(gUefiApplicationEntryPointPrototype.Replace(Dict))\r | |
1543 | \r | |
1544 | ## Create code for ModuleUnloadImage\r | |
1545 | #\r | |
1546 | # @param Info The ModuleAutoGen object\r | |
1547 | # @param AutoGenC The TemplateString object for C code\r | |
1548 | # @param AutoGenH The TemplateString object for header file\r | |
1549 | #\r | |
1550 | def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1551 | if Info.IsLibrary or Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_SEC]:\r |
f51461c8 | 1552 | return\r |
838bc257 FZ |
1553 | \r |
1554 | ModuleUnloadImageList = []\r | |
1555 | for Lib in Info.DependentLibraryList:\r | |
1556 | if len(Lib.ModuleUnloadImageList) > 0:\r | |
1557 | ModuleUnloadImageList = ModuleUnloadImageList + Lib.ModuleUnloadImageList\r | |
1558 | ModuleUnloadImageList = ModuleUnloadImageList + Info.Module.ModuleUnloadImageList\r | |
1559 | \r | |
f51461c8 LG |
1560 | #\r |
1561 | # Unload Image Handlers\r | |
1562 | #\r | |
838bc257 FZ |
1563 | NumUnloadImage = len(ModuleUnloadImageList)\r |
1564 | Dict = {'Count':str(NumUnloadImage) + 'U', 'Function':ModuleUnloadImageList}\r | |
f51461c8 LG |
1565 | if NumUnloadImage < 2:\r |
1566 | AutoGenC.Append(gUefiUnloadImageString[NumUnloadImage].Replace(Dict))\r | |
1567 | else:\r | |
1568 | AutoGenC.Append(gUefiUnloadImageString[2].Replace(Dict))\r | |
1569 | AutoGenH.Append(gUefiUnloadImagePrototype.Replace(Dict))\r | |
1570 | \r | |
1571 | ## Create code for GUID\r | |
1572 | #\r | |
1573 | # @param Info The ModuleAutoGen object\r | |
1574 | # @param AutoGenC The TemplateString object for C code\r | |
1575 | # @param AutoGenH The TemplateString object for header file\r | |
1576 | #\r | |
1577 | def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1578 | if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r |
91fa33ee | 1579 | GuidType = TAB_GUID\r |
f51461c8 LG |
1580 | else:\r |
1581 | GuidType = "EFI_GUID"\r | |
1582 | \r | |
1583 | if Info.GuidList:\r | |
7beed8a3 YZ |
1584 | if not Info.IsLibrary:\r |
1585 | AutoGenC.Append("\n// Guids\n")\r | |
8262037f | 1586 | AutoGenH.Append("\n// Guids\n")\r |
f51461c8 LG |
1587 | #\r |
1588 | # GUIDs\r | |
1589 | #\r | |
1590 | for Key in Info.GuidList:\r | |
7beed8a3 YZ |
1591 | if not Info.IsLibrary:\r |
1592 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.GuidList[Key]))\r | |
8262037f | 1593 | AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r |
f51461c8 LG |
1594 | \r |
1595 | ## Create code for protocol\r | |
1596 | #\r | |
1597 | # @param Info The ModuleAutoGen object\r | |
1598 | # @param AutoGenC The TemplateString object for C code\r | |
1599 | # @param AutoGenH The TemplateString object for header file\r | |
1600 | #\r | |
1601 | def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1602 | if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r |
91fa33ee | 1603 | GuidType = TAB_GUID\r |
f51461c8 LG |
1604 | else:\r |
1605 | GuidType = "EFI_GUID"\r | |
1606 | \r | |
1607 | if Info.ProtocolList:\r | |
7beed8a3 YZ |
1608 | if not Info.IsLibrary:\r |
1609 | AutoGenC.Append("\n// Protocols\n")\r | |
8262037f | 1610 | AutoGenH.Append("\n// Protocols\n")\r |
f51461c8 LG |
1611 | #\r |
1612 | # Protocol GUIDs\r | |
1613 | #\r | |
1614 | for Key in Info.ProtocolList:\r | |
7beed8a3 YZ |
1615 | if not Info.IsLibrary:\r |
1616 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.ProtocolList[Key]))\r | |
8262037f | 1617 | AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r |
f51461c8 LG |
1618 | \r |
1619 | ## Create code for PPI\r | |
1620 | #\r | |
1621 | # @param Info The ModuleAutoGen object\r | |
1622 | # @param AutoGenC The TemplateString object for C code\r | |
1623 | # @param AutoGenH The TemplateString object for header file\r | |
1624 | #\r | |
1625 | def CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1626 | if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r |
91fa33ee | 1627 | GuidType = TAB_GUID\r |
f51461c8 LG |
1628 | else:\r |
1629 | GuidType = "EFI_GUID"\r | |
1630 | \r | |
1631 | if Info.PpiList:\r | |
7beed8a3 YZ |
1632 | if not Info.IsLibrary:\r |
1633 | AutoGenC.Append("\n// PPIs\n")\r | |
8262037f | 1634 | AutoGenH.Append("\n// PPIs\n")\r |
f51461c8 LG |
1635 | #\r |
1636 | # PPI GUIDs\r | |
1637 | #\r | |
1638 | for Key in Info.PpiList:\r | |
7beed8a3 YZ |
1639 | if not Info.IsLibrary:\r |
1640 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.PpiList[Key]))\r | |
8262037f | 1641 | AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r |
f51461c8 LG |
1642 | \r |
1643 | ## Create code for PCD\r | |
1644 | #\r | |
1645 | # @param Info The ModuleAutoGen object\r | |
1646 | # @param AutoGenC The TemplateString object for C code\r | |
1647 | # @param AutoGenH The TemplateString object for header file\r | |
1648 | #\r | |
1649 | def CreatePcdCode(Info, AutoGenC, AutoGenH):\r | |
1650 | \r | |
1651 | # Collect Token Space GUIDs used by DynamicEc PCDs\r | |
1652 | TokenSpaceList = []\r | |
1653 | for Pcd in Info.ModulePcdList:\r | |
eece4292 | 1654 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenSpaceGuidCName not in TokenSpaceList:\r |
caf74495 | 1655 | TokenSpaceList.append(Pcd.TokenSpaceGuidCName)\r |
f7496d71 | 1656 | \r |
8518bf0b LG |
1657 | SkuMgr = Info.Workspace.Platform.SkuIdMgr\r |
1658 | AutoGenH.Append("\n// Definition of SkuId Array\n")\r | |
1659 | AutoGenH.Append("extern UINT64 _gPcd_SkuId_Array[];\n")\r | |
f51461c8 | 1660 | # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found\r |
72fbe88d | 1661 | if TokenSpaceList:\r |
f51461c8 | 1662 | AutoGenH.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")\r |
8bb63e37 | 1663 | if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r |
91fa33ee | 1664 | GuidType = TAB_GUID\r |
f51461c8 | 1665 | else:\r |
f7496d71 | 1666 | GuidType = "EFI_GUID"\r |
f51461c8 LG |
1667 | for Item in TokenSpaceList:\r |
1668 | AutoGenH.Append('extern %s %s;\n' % (GuidType, Item))\r | |
1669 | \r | |
1670 | if Info.IsLibrary:\r | |
1671 | if Info.ModulePcdList:\r | |
1672 | AutoGenH.Append("\n// PCD definitions\n")\r | |
1673 | for Pcd in Info.ModulePcdList:\r | |
1674 | CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd)\r | |
1675 | DynExPcdTokenNumberMapping (Info, AutoGenH)\r | |
1676 | else:\r | |
8518bf0b LG |
1677 | AutoGenC.Append("\n// Definition of SkuId Array\n")\r |
1678 | AutoGenC.Append("GLOBAL_REMOVE_IF_UNREFERENCED UINT64 _gPcd_SkuId_Array[] = %s;\n" % SkuMgr.DumpSkuIdArrary())\r | |
f51461c8 LG |
1679 | if Info.ModulePcdList:\r |
1680 | AutoGenH.Append("\n// Definition of PCDs used in this module\n")\r | |
1681 | AutoGenC.Append("\n// Definition of PCDs used in this module\n")\r | |
1682 | for Pcd in Info.ModulePcdList:\r | |
1683 | CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd)\r | |
1684 | DynExPcdTokenNumberMapping (Info, AutoGenH)\r | |
1685 | if Info.LibraryPcdList:\r | |
1686 | AutoGenH.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")\r | |
1687 | AutoGenC.Append("\n// Definition of PCDs used in libraries\n")\r | |
1688 | for Pcd in Info.LibraryPcdList:\r | |
1689 | CreateModulePcdCode(Info, AutoGenC, AutoGenC, Pcd)\r | |
1690 | CreatePcdDatabaseCode(Info, AutoGenC, AutoGenH)\r | |
1691 | \r | |
1692 | ## Create code for unicode string definition\r | |
1693 | #\r | |
1694 | # @param Info The ModuleAutoGen object\r | |
1695 | # @param AutoGenC The TemplateString object for C code\r | |
1696 | # @param AutoGenH The TemplateString object for header file\r | |
1697 | # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r | |
1698 | # @param UniGenBinBuffer Buffer to store uni string package data\r | |
1699 | #\r | |
1700 | def CreateUnicodeStringCode(Info, AutoGenC, AutoGenH, UniGenCFlag, UniGenBinBuffer):\r | |
1701 | WorkingDir = os.getcwd()\r | |
1702 | os.chdir(Info.WorkspaceDir)\r | |
1703 | \r | |
1704 | IncList = [Info.MetaFile.Dir]\r | |
1705 | # Get all files under [Sources] section in inf file for EDK-II module\r | |
1706 | EDK2Module = True\r | |
1707 | SrcList = [F for F in Info.SourceFileList]\r | |
f51461c8 LG |
1708 | \r |
1709 | if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-c') > -1:\r | |
1710 | CompatibleMode = True\r | |
1711 | else:\r | |
1712 | CompatibleMode = False\r | |
1713 | \r | |
1714 | #\r | |
1715 | # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2\r | |
1716 | #\r | |
1717 | if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-s') > -1:\r | |
1718 | if CompatibleMode:\r | |
1719 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
1720 | "-c and -s build options should be used exclusively",\r | |
1721 | ExtraData="[%s]" % str(Info))\r | |
1722 | ShellMode = True\r | |
1723 | else:\r | |
1724 | ShellMode = False\r | |
1725 | \r | |
1726 | #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules\r | |
1727 | if EDK2Module:\r | |
1728 | FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.RFCLanguages]\r | |
1729 | else:\r | |
1730 | FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.ISOLanguages]\r | |
1731 | Header, Code = GetStringFiles(Info.UnicodeFileList, SrcList, IncList, Info.IncludePathList, ['.uni', '.inf'], Info.Name, CompatibleMode, ShellMode, UniGenCFlag, UniGenBinBuffer, FilterInfo)\r | |
1732 | if CompatibleMode or UniGenCFlag:\r | |
1733 | AutoGenC.Append("\n//\n//Unicode String Pack Definition\n//\n")\r | |
1734 | AutoGenC.Append(Code)\r | |
1735 | AutoGenC.Append("\n")\r | |
1736 | AutoGenH.Append("\n//\n//Unicode String ID\n//\n")\r | |
1737 | AutoGenH.Append(Header)\r | |
1738 | if CompatibleMode or UniGenCFlag:\r | |
1739 | AutoGenH.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info.Name)\r | |
1740 | os.chdir(WorkingDir)\r | |
1741 | \r | |
333ba578 YZ |
1742 | def CreateIdfFileCode(Info, AutoGenC, StringH, IdfGenCFlag, IdfGenBinBuffer):\r |
1743 | if len(Info.IdfFileList) > 0:\r | |
1744 | ImageFiles = IdfFileClassObject(sorted (Info.IdfFileList))\r | |
1745 | if ImageFiles.ImageFilesDict:\r | |
1746 | Index = 1\r | |
1747 | PaletteIndex = 1\r | |
1748 | IncList = [Info.MetaFile.Dir]\r | |
1749 | SrcList = [F for F in Info.SourceFileList]\r | |
1750 | SkipList = ['.jpg', '.png', '.bmp', '.inf', '.idf']\r | |
1751 | FileList = GetFileList(SrcList, IncList, SkipList)\r | |
1752 | ValueStartPtr = 60\r | |
1753 | StringH.Append("\n//\n//Image ID\n//\n")\r | |
1754 | ImageInfoOffset = 0\r | |
1755 | PaletteInfoOffset = 0\r | |
1756 | ImageBuffer = pack('x')\r | |
1757 | PaletteBuffer = pack('x')\r | |
1758 | BufferStr = ''\r | |
1759 | PaletteStr = ''\r | |
6d034a2a | 1760 | FileDict = {}\r |
333ba578 YZ |
1761 | for Idf in ImageFiles.ImageFilesDict:\r |
1762 | if ImageFiles.ImageFilesDict[Idf]:\r | |
1763 | for FileObj in ImageFiles.ImageFilesDict[Idf]:\r | |
1764 | for sourcefile in Info.SourceFileList:\r | |
1765 | if FileObj.FileName == sourcefile.File:\r | |
1766 | if not sourcefile.Ext.upper() in ['.PNG', '.BMP', '.JPG']:\r | |
1767 | EdkLogger.error("build", AUTOGEN_ERROR, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj.FileName), ExtraData="[%s]" % str(Info))\r | |
1768 | FileObj.File = sourcefile\r | |
1769 | break\r | |
1770 | else:\r | |
1771 | EdkLogger.error("build", AUTOGEN_ERROR, "The %s in %s is not defined in the driver's [Sources] section" % (FileObj.FileName, Idf), ExtraData="[%s]" % str(Info))\r | |
1772 | \r | |
1773 | for FileObj in ImageFiles.ImageFilesDict[Idf]:\r | |
1774 | ID = FileObj.ImageID\r | |
1775 | File = FileObj.File\r | |
1776 | if not os.path.exists(File.Path) or not os.path.isfile(File.Path):\r | |
1777 | EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=File.Path)\r | |
1778 | SearchImageID (FileObj, FileList)\r | |
1779 | if FileObj.Referenced:\r | |
1780 | if (ValueStartPtr - len(DEFINE_STR + ID)) <= 0:\r | |
1781 | Line = DEFINE_STR + ' ' + ID + ' ' + DecToHexStr(Index, 4) + '\n'\r | |
1782 | else:\r | |
1783 | Line = DEFINE_STR + ' ' + ID + ' ' * (ValueStartPtr - len(DEFINE_STR + ID)) + DecToHexStr(Index, 4) + '\n'\r | |
1784 | \r | |
6d034a2a YZ |
1785 | if File not in FileDict:\r |
1786 | FileDict[File] = Index\r | |
1787 | else:\r | |
1788 | DuplicateBlock = pack('B', EFI_HII_IIBT_DUPLICATE)\r | |
1789 | DuplicateBlock += pack('H', FileDict[File])\r | |
1790 | ImageBuffer += DuplicateBlock\r | |
1791 | BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r | |
1792 | TempBufferList = AscToHexList(DuplicateBlock)\r | |
1793 | BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r | |
1794 | StringH.Append(Line)\r | |
1795 | Index += 1\r | |
1796 | continue\r | |
1797 | \r | |
333ba578 YZ |
1798 | TmpFile = open(File.Path, 'rb')\r |
1799 | Buffer = TmpFile.read()\r | |
1800 | TmpFile.close()\r | |
1801 | if File.Ext.upper() == '.PNG':\r | |
1802 | TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_PNG)\r | |
1803 | TempBuffer += pack('I', len(Buffer))\r | |
1804 | TempBuffer += Buffer\r | |
1805 | elif File.Ext.upper() == '.JPG':\r | |
1806 | ImageType, = struct.unpack('4s', Buffer[6:10])\r | |
d943b0c3 | 1807 | if ImageType != b'JFIF':\r |
333ba578 YZ |
1808 | EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard JPG file." % File.Path)\r |
1809 | TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_JPEG)\r | |
1810 | TempBuffer += pack('I', len(Buffer))\r | |
1811 | TempBuffer += Buffer\r | |
1812 | elif File.Ext.upper() == '.BMP':\r | |
1813 | TempBuffer, TempPalette = BmpImageDecoder(File, Buffer, PaletteIndex, FileObj.TransParent)\r | |
1814 | if len(TempPalette) > 1:\r | |
1815 | PaletteIndex += 1\r | |
e148e6e9 YZ |
1816 | NewPalette = pack('H', len(TempPalette))\r |
1817 | NewPalette += TempPalette\r | |
1818 | PaletteBuffer += NewPalette\r | |
333ba578 | 1819 | PaletteStr = WriteLine(PaletteStr, '// %s: %s: %s' % (DecToHexStr(PaletteIndex - 1, 4), ID, DecToHexStr(PaletteIndex - 1, 4)))\r |
e148e6e9 | 1820 | TempPaletteList = AscToHexList(NewPalette)\r |
333ba578 YZ |
1821 | PaletteStr = WriteLine(PaletteStr, CreateArrayItem(TempPaletteList, 16) + '\n')\r |
1822 | ImageBuffer += TempBuffer\r | |
1823 | BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r | |
1824 | TempBufferList = AscToHexList(TempBuffer)\r | |
1825 | BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r | |
1826 | \r | |
1827 | StringH.Append(Line)\r | |
1828 | Index += 1\r | |
1829 | \r | |
1830 | BufferStr = WriteLine(BufferStr, '// End of the Image Info')\r | |
1831 | BufferStr = WriteLine(BufferStr, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END, 2)) + '\n')\r | |
1832 | ImageEnd = pack('B', EFI_HII_IIBT_END)\r | |
1833 | ImageBuffer += ImageEnd\r | |
1834 | \r | |
1835 | if len(ImageBuffer) > 1:\r | |
1836 | ImageInfoOffset = 12\r | |
1837 | if len(PaletteBuffer) > 1:\r | |
1838 | PaletteInfoOffset = 12 + len(ImageBuffer) - 1 # -1 is for the first empty pad byte of ImageBuffer\r | |
1839 | \r | |
1840 | IMAGE_PACKAGE_HDR = pack('=II', ImageInfoOffset, PaletteInfoOffset)\r | |
1841 | # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length\r | |
1842 | if len(PaletteBuffer) > 1:\r | |
1843 | PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1 + 2 + len(PaletteBuffer) - 1\r | |
1844 | else:\r | |
1845 | PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1\r | |
1846 | if PaletteIndex > 1:\r | |
1847 | PALETTE_INFO_HEADER = pack('H', PaletteIndex - 1)\r | |
1848 | # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF\r | |
1849 | Hex_Length = '%06X' % PACKAGE_HEADER_Length\r | |
1850 | if PACKAGE_HEADER_Length > 0xFFFFFF:\r | |
1851 | EdkLogger.error("build", AUTOGEN_ERROR, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData="[%s]" % str(Info))\r | |
1852 | PACKAGE_HEADER = pack('=HBB', int('0x' + Hex_Length[2:], 16), int('0x' + Hex_Length[0:2], 16), EFI_HII_PACKAGE_IMAGES)\r | |
1853 | \r | |
1854 | IdfGenBinBuffer.write(PACKAGE_HEADER)\r | |
1855 | IdfGenBinBuffer.write(IMAGE_PACKAGE_HDR)\r | |
1856 | if len(ImageBuffer) > 1 :\r | |
1857 | IdfGenBinBuffer.write(ImageBuffer[1:])\r | |
1858 | if PaletteIndex > 1:\r | |
1859 | IdfGenBinBuffer.write(PALETTE_INFO_HEADER)\r | |
1860 | if len(PaletteBuffer) > 1:\r | |
1861 | IdfGenBinBuffer.write(PaletteBuffer[1:])\r | |
1862 | \r | |
1863 | if IdfGenCFlag:\r | |
1864 | TotalLength = EFI_HII_ARRAY_SIZE_LENGTH + PACKAGE_HEADER_Length\r | |
1865 | AutoGenC.Append("\n//\n//Image Pack Definition\n//\n")\r | |
1866 | AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + Info.Module.BaseName + 'Images' + '[] = {\n')\r | |
1867 | AllStr = WriteLine(AllStr, '// STRGATHER_OUTPUT_HEADER')\r | |
1868 | AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength)) + '\n')\r | |
1869 | AllStr = WriteLine(AllStr, '// Image PACKAGE HEADER\n')\r | |
1870 | IMAGE_PACKAGE_HDR_List = AscToHexList(PACKAGE_HEADER)\r | |
1871 | IMAGE_PACKAGE_HDR_List += AscToHexList(IMAGE_PACKAGE_HDR)\r | |
1872 | AllStr = WriteLine(AllStr, CreateArrayItem(IMAGE_PACKAGE_HDR_List, 16) + '\n')\r | |
1873 | AllStr = WriteLine(AllStr, '// Image DATA\n')\r | |
1874 | if BufferStr:\r | |
1875 | AllStr = WriteLine(AllStr, BufferStr)\r | |
1876 | if PaletteStr:\r | |
1877 | AllStr = WriteLine(AllStr, '// Palette Header\n')\r | |
1878 | PALETTE_INFO_HEADER_List = AscToHexList(PALETTE_INFO_HEADER)\r | |
1879 | AllStr = WriteLine(AllStr, CreateArrayItem(PALETTE_INFO_HEADER_List, 16) + '\n')\r | |
1880 | AllStr = WriteLine(AllStr, '// Palette Data\n')\r | |
1881 | AllStr = WriteLine(AllStr, PaletteStr)\r | |
1882 | AllStr = WriteLine(AllStr, '};')\r | |
1883 | AutoGenC.Append(AllStr)\r | |
1884 | AutoGenC.Append("\n")\r | |
1885 | StringH.Append('\nextern unsigned char ' + Info.Module.BaseName + 'Images[];\n')\r | |
1886 | StringH.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info.Module.BaseName)\r | |
1887 | \r | |
1888 | # typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r | |
1889 | # EFI_HII_PACKAGE_HEADER Header; # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES\r | |
1890 | # UINT32 ImageInfoOffset;\r | |
1891 | # UINT32 PaletteInfoOffset;\r | |
1892 | # } EFI_HII_IMAGE_PACKAGE_HDR;\r | |
1893 | \r | |
1894 | # typedef struct {\r | |
1895 | # UINT32 Length:24;\r | |
1896 | # UINT32 Type:8;\r | |
1897 | # UINT8 Data[];\r | |
1898 | # } EFI_HII_PACKAGE_HEADER;\r | |
1899 | \r | |
1900 | # typedef struct _EFI_HII_IMAGE_BLOCK {\r | |
1901 | # UINT8 BlockType;\r | |
1902 | # UINT8 BlockBody[];\r | |
1903 | # } EFI_HII_IMAGE_BLOCK;\r | |
1904 | \r | |
1905 | def BmpImageDecoder(File, Buffer, PaletteIndex, TransParent):\r | |
1906 | ImageType, = struct.unpack('2s', Buffer[0:2])\r | |
d943b0c3 | 1907 | if ImageType!= b'BM': # BMP file type is 'BM'\r |
333ba578 | 1908 | EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard BMP file." % File.Path)\r |
ccaa7754 | 1909 | BMP_IMAGE_HEADER = collections.namedtuple('BMP_IMAGE_HEADER', ['bfSize', 'bfReserved1', 'bfReserved2', 'bfOffBits', 'biSize', 'biWidth', 'biHeight', 'biPlanes', 'biBitCount', 'biCompression', 'biSizeImage', 'biXPelsPerMeter', 'biYPelsPerMeter', 'biClrUsed', 'biClrImportant'])\r |
333ba578 YZ |
1910 | BMP_IMAGE_HEADER_STRUCT = struct.Struct('IHHIIIIHHIIIIII')\r |
1911 | BmpHeader = BMP_IMAGE_HEADER._make(BMP_IMAGE_HEADER_STRUCT.unpack_from(Buffer[2:]))\r | |
1912 | #\r | |
1913 | # Doesn't support compress.\r | |
1914 | #\r | |
1915 | if BmpHeader.biCompression != 0:\r | |
1916 | EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The compress BMP file %s is not support." % File.Path)\r | |
1917 | \r | |
1918 | # The Width and Height is UINT16 type in Image Package\r | |
1919 | if BmpHeader.biWidth > 0xFFFF:\r | |
1920 | EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Width is exceed 0xFFFF." % File.Path)\r | |
1921 | if BmpHeader.biHeight > 0xFFFF:\r | |
1922 | EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Height is exceed 0xFFFF." % File.Path)\r | |
1923 | \r | |
1924 | PaletteBuffer = pack('x')\r | |
1925 | if BmpHeader.biBitCount == 1:\r | |
1926 | if TransParent:\r | |
1927 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS)\r | |
1928 | else:\r | |
1929 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT)\r | |
1930 | ImageBuffer += pack('B', PaletteIndex)\r | |
b3e94a06 | 1931 | Width = (BmpHeader.biWidth + 7)//8\r |
333ba578 YZ |
1932 | if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r |
1933 | PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r | |
1934 | elif BmpHeader.biBitCount == 4:\r | |
1935 | if TransParent:\r | |
1936 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS)\r | |
1937 | else:\r | |
1938 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT)\r | |
1939 | ImageBuffer += pack('B', PaletteIndex)\r | |
b3e94a06 | 1940 | Width = (BmpHeader.biWidth + 1)//2\r |
333ba578 YZ |
1941 | if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r |
1942 | PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r | |
1943 | elif BmpHeader.biBitCount == 8:\r | |
1944 | if TransParent:\r | |
1945 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS)\r | |
1946 | else:\r | |
1947 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT)\r | |
1948 | ImageBuffer += pack('B', PaletteIndex)\r | |
1949 | Width = BmpHeader.biWidth\r | |
1950 | if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r | |
1951 | PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r | |
1952 | elif BmpHeader.biBitCount == 24:\r | |
1953 | if TransParent:\r | |
1954 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS)\r | |
1955 | else:\r | |
1956 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT)\r | |
1957 | Width = BmpHeader.biWidth * 3\r | |
1958 | else:\r | |
1959 | EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData="[%s]" % str(File.Path))\r | |
1960 | \r | |
1961 | ImageBuffer += pack('H', BmpHeader.biWidth)\r | |
1962 | ImageBuffer += pack('H', BmpHeader.biHeight)\r | |
1963 | Start = BmpHeader.bfOffBits\r | |
1964 | End = BmpHeader.bfSize - 1\r | |
1965 | for Height in range(0, BmpHeader.biHeight):\r | |
1966 | if Width % 4 != 0:\r | |
1967 | Start = End + (Width % 4) - 4 - Width\r | |
1968 | else:\r | |
1969 | Start = End - Width\r | |
1970 | ImageBuffer += Buffer[Start + 1 : Start + Width + 1]\r | |
1971 | End = Start\r | |
1972 | \r | |
1973 | # handle the Palette info, BMP use 4 bytes for R, G, B and Reserved info while EFI_HII_RGB_PIXEL only have the R, G, B info\r | |
1974 | if PaletteBuffer and len(PaletteBuffer) > 1:\r | |
1975 | PaletteTemp = pack('x')\r | |
1976 | for Index in range(0, len(PaletteBuffer)):\r | |
1977 | if Index % 4 == 3:\r | |
1978 | continue\r | |
d943b0c3 | 1979 | PaletteTemp += PaletteBuffer[Index:Index+1]\r |
333ba578 YZ |
1980 | PaletteBuffer = PaletteTemp[1:]\r |
1981 | return ImageBuffer, PaletteBuffer\r | |
1982 | \r | |
f51461c8 LG |
1983 | ## Create common code\r |
1984 | #\r | |
1985 | # @param Info The ModuleAutoGen object\r | |
1986 | # @param AutoGenC The TemplateString object for C code\r | |
1987 | # @param AutoGenH The TemplateString object for header file\r | |
1988 | #\r | |
1989 | def CreateHeaderCode(Info, AutoGenC, AutoGenH):\r | |
1990 | # file header\r | |
1991 | AutoGenH.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.h'}))\r | |
1992 | # header file Prologue\r | |
ccaa7754 | 1993 | AutoGenH.Append(gAutoGenHPrologueString.Replace({'File':'AUTOGENH','Guid':Info.Guid.replace('-', '_')}))\r |
f51461c8 | 1994 | AutoGenH.Append(gAutoGenHCppPrologueString)\r |
f51461c8 | 1995 | \r |
82292501 FB |
1996 | # header files includes\r |
1997 | if Info.ModuleType in gModuleTypeHeaderFile:\r | |
1998 | AutoGenH.Append("#include <%s>\n" % gModuleTypeHeaderFile[Info.ModuleType][0])\r | |
1999 | #\r | |
2000 | # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h\r | |
2001 | # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.\r | |
2002 | #\r | |
2003 | if 'PcdLib' in Info.Module.LibraryClasses or Info.Module.Pcds:\r | |
2004 | AutoGenH.Append("#include <Library/PcdLib.h>\n")\r | |
2005 | \r | |
2006 | AutoGenH.Append('\nextern GUID gEfiCallerIdGuid;')\r | |
2007 | AutoGenH.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')\r | |
f51461c8 | 2008 | \r |
82292501 FB |
2009 | if Info.IsLibrary:\r |
2010 | return\r | |
f51461c8 | 2011 | \r |
82292501 | 2012 | AutoGenH.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info.Guid))\r |
f51461c8 LG |
2013 | \r |
2014 | if Info.IsLibrary:\r | |
2015 | return\r | |
2016 | # C file header\r | |
2017 | AutoGenC.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.c'}))\r | |
82292501 FB |
2018 | # C file header files includes\r |
2019 | if Info.ModuleType in gModuleTypeHeaderFile:\r | |
2020 | for Inc in gModuleTypeHeaderFile[Info.ModuleType]:\r | |
2021 | AutoGenC.Append("#include <%s>\n" % Inc)\r | |
2022 | else:\r | |
2023 | AutoGenC.Append("#include <%s>\n" % gBasicHeaderFile)\r | |
f51461c8 | 2024 | \r |
82292501 FB |
2025 | #\r |
2026 | # Publish the CallerId Guid\r | |
2027 | #\r | |
2028 | AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info.Guid))\r | |
2029 | AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info.Name)\r | |
f51461c8 LG |
2030 | \r |
2031 | ## Create common code for header file\r | |
2032 | #\r | |
2033 | # @param Info The ModuleAutoGen object\r | |
2034 | # @param AutoGenC The TemplateString object for C code\r | |
2035 | # @param AutoGenH The TemplateString object for header file\r | |
2036 | #\r | |
2037 | def CreateFooterCode(Info, AutoGenC, AutoGenH):\r | |
2038 | AutoGenH.Append(gAutoGenHEpilogueString)\r | |
2039 | \r | |
2040 | ## Create code for a module\r | |
2041 | #\r | |
2042 | # @param Info The ModuleAutoGen object\r | |
2043 | # @param AutoGenC The TemplateString object for C code\r | |
2044 | # @param AutoGenH The TemplateString object for header file\r | |
333ba578 | 2045 | # @param StringH The TemplateString object for header file\r |
f51461c8 LG |
2046 | # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r |
2047 | # @param UniGenBinBuffer Buffer to store uni string package data\r | |
333ba578 YZ |
2048 | # @param StringIdf The TemplateString object for header file\r |
2049 | # @param IdfGenCFlag IdfString is generated into AutoGen C file when it is set to True\r | |
2050 | # @param IdfGenBinBuffer Buffer to store Idf string package data\r | |
f51461c8 | 2051 | #\r |
333ba578 | 2052 | def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer, StringIdf, IdfGenCFlag, IdfGenBinBuffer):\r |
f51461c8 LG |
2053 | CreateHeaderCode(Info, AutoGenC, AutoGenH)\r |
2054 | \r | |
82292501 FB |
2055 | CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH)\r |
2056 | CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH)\r | |
2057 | CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH)\r | |
2058 | CreatePcdCode(Info, AutoGenC, AutoGenH)\r | |
2059 | CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH)\r | |
2060 | CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH)\r | |
2061 | CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH)\r | |
2062 | CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH)\r | |
f51461c8 LG |
2063 | \r |
2064 | if Info.UnicodeFileList:\r | |
2065 | FileName = "%sStrDefs.h" % Info.Name\r | |
2066 | StringH.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r | |
ccaa7754 | 2067 | StringH.Append(gAutoGenHPrologueString.Replace({'File':'STRDEFS', 'Guid':Info.Guid.replace('-', '_')}))\r |
f51461c8 | 2068 | CreateUnicodeStringCode(Info, AutoGenC, StringH, UniGenCFlag, UniGenBinBuffer)\r |
8200fcfe YL |
2069 | \r |
2070 | GuidMacros = []\r | |
2071 | for Guid in Info.Module.Guids:\r | |
2072 | if Guid in Info.Module.GetGuidsUsedByPcd():\r | |
2073 | continue\r | |
2074 | GuidMacros.append('#define %s %s' % (Guid, Info.Module.Guids[Guid]))\r | |
f8d11e5a | 2075 | for Guid, Value in list(Info.Module.Protocols.items()) + list(Info.Module.Ppis.items()):\r |
8200fcfe | 2076 | GuidMacros.append('#define %s %s' % (Guid, Value))\r |
58cf30f7 | 2077 | # supports FixedAtBuild and FeaturePcd usage in VFR file\r |
5b97eb4c YZ |
2078 | if Info.VfrFileList and Info.ModulePcdList:\r |
2079 | GuidMacros.append('#define %s %s' % ('FixedPcdGetBool(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2080 | GuidMacros.append('#define %s %s' % ('FixedPcdGet8(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2081 | GuidMacros.append('#define %s %s' % ('FixedPcdGet16(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2082 | GuidMacros.append('#define %s %s' % ('FixedPcdGet32(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2083 | GuidMacros.append('#define %s %s' % ('FixedPcdGet64(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
58cf30f7 | 2084 | GuidMacros.append('#define %s %s' % ('FeaturePcdGet(TokenName)', '_PCD_VALUE_##TokenName'))\r |
5b97eb4c | 2085 | for Pcd in Info.ModulePcdList:\r |
58cf30f7 | 2086 | if Pcd.Type in [TAB_PCDS_FIXED_AT_BUILD, TAB_PCDS_FEATURE_FLAG]:\r |
5b97eb4c YZ |
2087 | TokenCName = Pcd.TokenCName\r |
2088 | Value = Pcd.DefaultValue\r | |
2089 | if Pcd.DatumType == 'BOOLEAN':\r | |
2090 | BoolValue = Value.upper()\r | |
2091 | if BoolValue == 'TRUE':\r | |
2092 | Value = '1'\r | |
2093 | elif BoolValue == 'FALSE':\r | |
2094 | Value = '0'\r | |
2095 | for PcdItem in GlobalData.MixedPcd:\r | |
2096 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
2097 | TokenCName = PcdItem[0]\r | |
2098 | break\r | |
2099 | GuidMacros.append('#define %s %s' % ('_PCD_VALUE_'+TokenCName, Value))\r | |
2100 | \r | |
bc7d95c0 YZ |
2101 | if Info.IdfFileList:\r |
2102 | GuidMacros.append('#include "%sImgDefs.h"' % Info.Name)\r | |
2103 | \r | |
8200fcfe YL |
2104 | if GuidMacros:\r |
2105 | StringH.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros))\r | |
2106 | \r | |
f51461c8 LG |
2107 | StringH.Append("\n#endif\n")\r |
2108 | AutoGenH.Append('#include "%s"\n' % FileName)\r | |
2109 | \r | |
333ba578 YZ |
2110 | if Info.IdfFileList:\r |
2111 | FileName = "%sImgDefs.h" % Info.Name\r | |
2112 | StringIdf.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r | |
ccaa7754 | 2113 | StringIdf.Append(gAutoGenHPrologueString.Replace({'File':'IMAGEDEFS', 'Guid':Info.Guid.replace('-', '_')}))\r |
333ba578 YZ |
2114 | CreateIdfFileCode(Info, AutoGenC, StringIdf, IdfGenCFlag, IdfGenBinBuffer)\r |
2115 | \r | |
2116 | StringIdf.Append("\n#endif\n")\r | |
2117 | AutoGenH.Append('#include "%s"\n' % FileName)\r | |
2118 | \r | |
f51461c8 LG |
2119 | CreateFooterCode(Info, AutoGenC, AutoGenH)\r |
2120 | \r | |
f51461c8 LG |
2121 | ## Create the code file\r |
2122 | #\r | |
2123 | # @param FilePath The path of code file\r | |
2124 | # @param Content The content of code file\r | |
2125 | # @param IsBinaryFile The flag indicating if the file is binary file or not\r | |
2126 | #\r | |
2127 | # @retval True If file content is changed or file doesn't exist\r | |
2128 | # @retval False If the file exists and the content is not changed\r | |
2129 | #\r | |
2130 | def Generate(FilePath, Content, IsBinaryFile):\r | |
2131 | return SaveFileOnChange(FilePath, Content, IsBinaryFile)\r | |
2132 | \r |