- Fixed PVCS tracker 484 by merging the GenDll and GenEfi macro in BuildMacro.xml...
[mirror_edk2.git] / Tools / Java / Source / GenBuild / org / tianocore / build / autogen / AutoGen.java
CommitLineData
878ddf1f 1/** @file\r
2 AutoGen class.\r
3\r
4 This class is to generate Autogen.h and Autogen.c according to module surface area\r
5 or library surface area.\r
ff225cbb 6\r
878ddf1f 7 Copyright (c) 2006, Intel Corporation\r
8 All rights reserved. This program and the accompanying materials\r
9 are licensed and made available under the terms and conditions of the BSD License\r
10 which accompanies this distribution. The full text of the license may be found at\r
11 http://opensource.org/licenses/bsd-license.php\r
ff225cbb 12\r
878ddf1f 13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
15\r
16 **/\r
17\r
18package org.tianocore.build.autogen;\r
19\r
878ddf1f 20import java.io.File;\r
73b4e31a 21import java.io.FileInputStream;\r
22import java.io.FileOutputStream;\r
878ddf1f 23import java.io.FileReader;\r
24import java.io.FileWriter;\r
cb4d97bd 25import java.io.IOException;\r
878ddf1f 26import java.util.ArrayList;\r
a29c47e0 27import java.util.HashSet;\r
28import java.util.Iterator;\r
893cea14 29import java.util.LinkedHashSet;\r
136adffc 30import java.util.LinkedList;\r
878ddf1f 31import java.util.List;\r
32import java.util.Map;\r
a29c47e0 33import java.util.Set;\r
878ddf1f 34\r
73b4e31a 35import org.apache.tools.ant.BuildException;\r
36import org.apache.xmlbeans.XmlObject;\r
d3945b9d 37import org.tianocore.build.exception.AutoGenException;\r
73b4e31a 38import org.tianocore.build.global.GlobalData;\r
73b4e31a 39import org.tianocore.build.global.SurfaceAreaQuery;\r
40import org.tianocore.build.id.ModuleIdentification;\r
41import org.tianocore.build.id.PackageIdentification;\r
42import org.tianocore.build.pcd.action.PCDAutoGenAction;\r
cb4d97bd 43import org.tianocore.common.definitions.ToolDefinitions;\r
4353d8e1 44import org.tianocore.common.definitions.EdkDefinitions;\r
892b0e7a 45import org.tianocore.common.exception.EdkException;\r
d3945b9d 46import org.tianocore.common.logger.EdkLog;\r
73b4e31a 47\r
878ddf1f 48/**\r
cb4d97bd 49 This class is to generate Autogen.h and Autogen.c according to module surface\r
50 area or library surface area.\r
51**/\r
878ddf1f 52public class AutoGen {\r
5f907e4a 53 ///\r
54 /// The output path of Autogen.h and Autogen.c\r
55 ///\r
56 private String outputPath;\r
57\r
ff225cbb 58 ///\r
59 /// The name of FV directory\r
60 ///\r
73b4e31a 61 private String fvDir;\r
5f907e4a 62\r
63 ///\r
64 /// The base name of module or library.\r
65 ///\r
66 private ModuleIdentification moduleId;\r
67\r
68 ///\r
69 /// The build architecture\r
70 ///\r
71 private String arch;\r
72\r
73 ///\r
74 /// PcdAutogen instance which is used to manage how to generate the PCD\r
75 /// information.\r
76 ///\r
77 private PCDAutoGenAction myPcdAutogen;\r
78\r
79 ///\r
80 /// the one of type : NOT_PCD_DRIVER, PEI_PCD_DRIVER, DXE_PCD_DRIVER\r
81 /// \r
82 private CommonDefinition.PCD_DRIVER_TYPE pcdDriverType;\r
83\r
84 ///\r
85 /// The protocl list which records in module or library surface area and\r
86 /// it's dependence on library instance surface area.\r
87 ///\r
88 private Set<String> mProtocolList = new HashSet<String>();\r
89\r
90 ///\r
91 /// The Ppi list which recorded in module or library surface area and its\r
92 /// dependency on library instance surface area.\r
93 ///\r
94 private Set<String> mPpiList = new HashSet<String>();\r
95\r
96 ///\r
97 /// The Guid list which recoreded in module or library surface area and it's\r
98 /// dependence on library instance surface area.\r
99 ///\r
100 private Set<String> mGuidList = new HashSet<String>();\r
ff225cbb 101\r
cb4d97bd 102 ///\r
103 /// The dependence package list which recoreded in module or library surface\r
104 /// area and it's dependence on library instance surface area.\r
105 ///\r
136adffc 106 private List<PackageIdentification> mDepPkgList = new LinkedList<PackageIdentification>();\r
2336382f 107\r
cb4d97bd 108 ///\r
109 /// For non library module, add its library instance's construct and destructor to\r
4353d8e1 110 /// list. String[0] recode LibConstructor name, String[1] recode Lib instance \r
e425f073 111 /// module type.\r
cb4d97bd 112 ///\r
4353d8e1 113 private List<String[]> libConstructList = new ArrayList<String[]>();\r
114 private List<String[]> libDestructList = new ArrayList<String[]>();\r
5f907e4a 115\r
cb4d97bd 116 ///\r
117 /// List to store SetVirtalAddressMapCallBack, ExitBootServiceCallBack\r
118 ///\r
5f907e4a 119 private List<String> setVirtalAddList = new ArrayList<String>();\r
120 private List<String> exitBootServiceList = new ArrayList<String>();\r
121\r
aacce761 122 private StringBuffer functionDeclarations = new StringBuffer(10240);\r
2c9b03f2 123 private StringBuffer globalDeclarations = new StringBuffer(10240);\r
aacce761 124\r
e425f073 125 //\r
126 // flag of PcdComponentNameDisable, PcdDriverDiagnosticDisable \r
127 //\r
128 private boolean componentNamePcd = false;\r
129 private boolean driverDiagnostPcd = false;\r
a387de3b 130\r
e425f073 131 //\r
132 // Instance of SurfaceAreaQuery\r
133 //\r
83fba802 134 private SurfaceAreaQuery saq = null;\r
a387de3b 135\r
2eb7d78d 136 private ModuleIdentification parentId = null;\r
5f907e4a 137\r
138 /**\r
cb4d97bd 139 Construct function\r
140 \r
141 This function mainly initialize some member variable.\r
142 \r
143 @param fvDir\r
144 Absolute path of FV directory.\r
145 @param outputPath\r
146 Output path of AutoGen file.\r
147 @param moduleId\r
148 Module identification.\r
149 @param arch\r
150 Target architecture.\r
151 **/\r
2eb7d78d 152 public AutoGen(String fvDir, String outputPath, ModuleIdentification moduleId, String arch, SurfaceAreaQuery saq, ModuleIdentification parentId) {\r
5f907e4a 153 this.outputPath = outputPath;\r
154 this.moduleId = moduleId;\r
155 this.arch = arch;\r
73b4e31a 156 this.fvDir = fvDir;\r
83fba802 157 this.saq = saq;\r
2eb7d78d 158 this.parentId = parentId;\r
5f907e4a 159 }\r
160\r
161 /**\r
cb4d97bd 162 saveFile function\r
163 \r
164 This function save the content in stringBuffer to file.\r
165 \r
166 @param fileName\r
167 The name of file.\r
168 @param fileBuffer\r
169 The content of AutoGen file in buffer.\r
170 @return boolean \r
171 "true" successful\r
172 "false" failed\r
173 **/\r
5f907e4a 174 private boolean saveFile(String fileName, StringBuffer fileBuffer) {\r
a387de3b 175\r
cb4d97bd 176 File autoGenH = new File(fileName);\r
5f907e4a 177\r
e425f073 178 //\r
179 // if the file exists, compare their content\r
180 //\r
cb4d97bd 181 if (autoGenH.exists()) {\r
182 char[] oldFileBuffer = new char[(int) autoGenH.length()];\r
e425f073 183 try {\r
184 FileReader fIn = new FileReader(autoGenH);\r
185 fIn.read(oldFileBuffer, 0, (int) autoGenH.length());\r
5f907e4a 186 fIn.close();\r
e425f073 187 } catch (IOException e) {\r
188 EdkLog.log(EdkLog.EDK_INFO, this.moduleId.getName() \r
a387de3b 189 + "'s " \r
190 + fileName \r
191 + " is exist, but can't be open!!");\r
e425f073 192 return false;\r
193 }\r
5f907e4a 194\r
cb4d97bd 195 //\r
196 // if we got the same file, don't re-generate it to prevent\r
197 // sources depending on it from re-building\r
198 //\r
199 if (fileBuffer.toString().compareTo(new String(oldFileBuffer)) == 0) {\r
200 return true;\r
5f907e4a 201 }\r
cb4d97bd 202 }\r
a387de3b 203\r
e425f073 204 try {\r
205 FileWriter fOut = new FileWriter(autoGenH);\r
5f907e4a 206 fOut.write(fileBuffer.toString());\r
e425f073 207 fOut.flush();\r
5f907e4a 208 fOut.close();\r
e425f073 209 } catch (IOException e) {\r
210 EdkLog.log(EdkLog.EDK_INFO, this.moduleId.getName() \r
a387de3b 211 + "'s " \r
212 + fileName \r
213 + " can't be create!!");\r
e425f073 214 return false;\r
a387de3b 215 }\r
5f907e4a 216 return true;\r
217 }\r
218\r
219 /**\r
cb4d97bd 220 genAutogen function\r
221 \r
222 This function call libGenAutoGen or moduleGenAutogen function, which\r
223 dependence on generate library autogen or module autogen.\r
224 \r
225 @throws BuildException\r
226 Failed to creat AutoGen.c & AutoGen.h.\r
227 **/\r
61528a1b 228 public void genAutogen() throws EdkException {\r
192a42b4 229 //\r
230 // If outputPath do not exist, create it.\r
231 //\r
232 File path = new File(outputPath);\r
233 path.mkdirs();\r
a387de3b 234\r
e425f073 235 //\r
236 // Check current is library or not, then call the corresponding\r
237 // function.\r
238 //\r
239 if (this.moduleId.isLibrary()) {\r
240 libGenAutogen();\r
241 } else {\r
242 moduleGenAutogen();\r
243 }\r
5f907e4a 244 }\r
245\r
246 /**\r
cb4d97bd 247 moduleGenAutogen function\r
248 \r
249 This function generates AutoGen.c & AutoGen.h for module.\r
250 \r
251 @throws BuildException\r
252 Faile to create module AutoGen.c & AutoGen.h.\r
253 **/\r
61528a1b 254 void moduleGenAutogen() throws EdkException {\r
a387de3b 255 setPcdComponentName();\r
256 setPcdDriverDiagnostic();\r
e425f073 257 collectLibInstanceInfo();\r
258 moduleGenAutogenC();\r
259 moduleGenAutogenH();\r
5f907e4a 260 }\r
261\r
262 /**\r
cb4d97bd 263 libGenAutogen function\r
264 \r
265 This function generates AutoGen.c & AutoGen.h for library.\r
266 \r
267 @throws BuildException\r
268 Faile to create library AutoGen.c & AutoGen.h\r
269 **/\r
61528a1b 270 void libGenAutogen() throws EdkException {\r
e425f073 271 libGenAutogenC();\r
272 libGenAutogenH();\r
5f907e4a 273 }\r
274\r
275 /**\r
cb4d97bd 276 moduleGenAutogenH\r
277 \r
278 This function generates AutoGen.h for module.\r
279 \r
280 @throws BuildException\r
281 Failed to generate AutoGen.h.\r
282 **/\r
61528a1b 283 void moduleGenAutogenH() throws EdkException {\r
5f907e4a 284\r
285 Set<String> libClassIncludeH;\r
286 String moduleType;\r
287 // List<String> headerFileList;\r
288 List<String> headerFileList;\r
289 Iterator item;\r
290 StringBuffer fileBuffer = new StringBuffer(8192);\r
291\r
292 //\r
293 // Write Autogen.h header notation\r
294 //\r
cb4d97bd 295 fileBuffer.append(CommonDefinition.AUTOGENHNOTATION);\r
5f907e4a 296\r
297 //\r
298 // Add #ifndef ${BaseName}_AUTOGENH\r
299 // #def ${BseeName}_AUTOGENH\r
300 //\r
cb4d97bd 301 fileBuffer.append(CommonDefinition.IFNDEF \r
a387de3b 302 + CommonDefinition.AUTOGENH\r
303 + this.moduleId.getGuid().replaceAll("-", "_") \r
304 + ToolDefinitions.LINE_SEPARATOR);\r
cb4d97bd 305 fileBuffer.append(CommonDefinition.DEFINE \r
a387de3b 306 + CommonDefinition.AUTOGENH\r
307 + this.moduleId.getGuid().replaceAll("-", "_") \r
308 + ToolDefinitions.LINE_SEPARATOR \r
309 + ToolDefinitions.LINE_SEPARATOR);\r
5f907e4a 310\r
311 //\r
312 // Write the specification version and release version at the begine\r
313 // of autogen.h file.\r
314 // Note: the specification version and release version should\r
315 // be got from module surface area instead of hard code by it's\r
316 // moduleType.\r
317 //\r
83fba802 318 moduleType = saq.getModuleType();\r
5f907e4a 319\r
320 //\r
321 // Add "extern int __make_me_compile_correctly;" at begin of\r
322 // AutoGen.h.\r
323 //\r
cb4d97bd 324 fileBuffer.append(CommonDefinition.AUTOGENHBEGIN);\r
136adffc 325\r
326 //\r
327 // Put EFI_SPECIFICATION_VERSION, and EDK_RELEASE_VERSION.\r
878ddf1f 328 //\r
83fba802 329 String[] specList = saq.getExternSpecificaiton();\r
136adffc 330 for (int i = 0; i < specList.length; i++) {\r
cb4d97bd 331 fileBuffer.append(CommonDefinition.DEFINE + specList[i]\r
aacce761 332 + "\r\n");\r
5f907e4a 333 }\r
334 //\r
335 // Write consumed package's mdouleInfo related .h file to autogen.h\r
336 //\r
337 // PackageIdentification[] consumedPkgIdList = SurfaceAreaQuery\r
338 // .getDependencePkg(this.arch);\r
83fba802 339 PackageIdentification[] consumedPkgIdList = saq.getDependencePkg(this.arch);\r
5f907e4a 340 if (consumedPkgIdList != null) {\r
341 headerFileList = depPkgToAutogenH(consumedPkgIdList, moduleType);\r
342 item = headerFileList.iterator();\r
343 while (item.hasNext()) {\r
344 fileBuffer.append(item.next().toString());\r
345 }\r
346 }\r
347\r
348 //\r
349 // Write library class's related *.h file to autogen.h.\r
350 //\r
700279a9 351 String[] libClassList = saq.getLibraryClasses(CommonDefinition.ALWAYSCONSUMED, this.arch, null);\r
352 if (libClassList.length > 0) {\r
5f907e4a 353 libClassIncludeH = LibraryClassToAutogenH(libClassList);\r
354 item = libClassIncludeH.iterator();\r
355 while (item.hasNext()) {\r
356 fileBuffer.append(item.next().toString());\r
357 }\r
878ddf1f 358 }\r
5f907e4a 359\r
700279a9 360 libClassList = saq.getLibraryClasses(CommonDefinition.ALWAYSPRODUCED, this.arch, null);\r
361 if (libClassList.length > 0) {\r
5f907e4a 362 libClassIncludeH = LibraryClassToAutogenH(libClassList);\r
363 item = libClassIncludeH.iterator();\r
364 while (item.hasNext()) {\r
365 fileBuffer.append(item.next().toString());\r
366 }\r
367 }\r
aacce761 368 fileBuffer.append("\r\n");\r
136adffc 369\r
73b4e31a 370 //\r
ff225cbb 371 // If is TianoR8FlashMap, copy {Fv_DIR}/FlashMap.h to\r
73b4e31a 372 // {DEST_DIR_DRBUG}/FlashMap.h\r
ff225cbb 373 //\r
83fba802 374 if (saq.isHaveTianoR8FlashMap()) {\r
cb4d97bd 375 fileBuffer.append(CommonDefinition.INCLUDE);\r
73b4e31a 376 fileBuffer.append(" <");\r
aacce761 377 fileBuffer.append(CommonDefinition.TIANOR8PLASHMAPH + ">\r\n");\r
73b4e31a 378 copyFlashMapHToDebugDir();\r
379 }\r
380\r
5f907e4a 381 // Write PCD autogen information to AutoGen.h.\r
382 //\r
383 if (this.myPcdAutogen != null) {\r
aacce761 384 fileBuffer.append("\r\n");\r
11eb278a 385 fileBuffer.append(this.myPcdAutogen.getHAutoGenString());\r
5f907e4a 386 }\r
387\r
2c9b03f2 388 fileBuffer.append(globalDeclarations);\r
aacce761 389 fileBuffer.append(functionDeclarations);\r
5f907e4a 390 //\r
391 // Append the #endif at AutoGen.h\r
392 //\r
aacce761 393 fileBuffer.append("#endif\r\n");\r
5f907e4a 394\r
395 //\r
396 // Save string buffer content in AutoGen.h.\r
397 //\r
398 if (!saveFile(outputPath + File.separatorChar + "AutoGen.h", fileBuffer)) {\r
61528a1b 399 throw new AutoGenException("Failed to generate AutoGen.h !!!");\r
5f907e4a 400 }\r
401 }\r
402\r
403 /**\r
cb4d97bd 404 moduleGenAutogenC\r
405 \r
406 This function generates AutoGen.c for module.\r
407 \r
408 @throws BuildException\r
409 Failed to generate AutoGen.c.\r
410 **/\r
61528a1b 411 void moduleGenAutogenC() throws EdkException {\r
5f907e4a 412\r
413 StringBuffer fileBuffer = new StringBuffer(8192);\r
414 //\r
415 // Write Autogen.c header notation\r
416 //\r
cb4d97bd 417 fileBuffer.append(CommonDefinition.AUTOGENCNOTATION);\r
5f907e4a 418\r
5f907e4a 419 //\r
420 // Get the native MSA file infomation. Since before call autogen,\r
421 // the MSA native <Externs> information were overrided. So before\r
422 // process <Externs> it should be set the DOC as the Native MSA info.\r
423 //\r
424 Map<String, XmlObject> doc = GlobalData.getNativeMsa(this.moduleId);\r
83fba802 425 saq.push(doc);\r
5f907e4a 426 //\r
427 // Write <Extern>\r
428 // DriverBinding/ComponentName/DriverConfiguration/DriverDialog\r
429 // to AutoGen.c\r
430 //\r
431\r
432 ExternsDriverBindingToAutoGenC(fileBuffer);\r
433\r
434 //\r
435 // Write DriverExitBootServicesEvent/DriverSetVirtualAddressMapEvent\r
436 // to Autogen.c\r
437 //\r
438 ExternCallBackToAutoGenC(fileBuffer);\r
439\r
440 //\r
441 // Write EntryPoint to autgoGen.c\r
442 //\r
83fba802 443 String[] entryPointList = saq.getModuleEntryPointArray();\r
e425f073 444 String[] unloadImageList = saq.getModuleUnloadImageArray();\r
cb4d97bd 445 EntryPointToAutoGen(CommonDefinition.remDupString(entryPointList), \r
a387de3b 446 CommonDefinition.remDupString(unloadImageList),\r
447 fileBuffer);\r
5f907e4a 448\r
83fba802 449 pcdDriverType = saq.getPcdDriverType();\r
5f907e4a 450\r
451 //\r
452 // Restore the DOC which include the FPD module info.\r
453 //\r
83fba802 454 saq.pop();\r
5f907e4a 455\r
456 //\r
457 // Write Guid to autogen.c\r
458 //\r
83fba802 459 String guid = CommonDefinition.formatGuidName(saq.getModuleGuid());\r
2f403520 460 if (this.moduleId.getModuleType().equalsIgnoreCase(EdkDefinitions.MODULE_TYPE_BASE)) {\r
a387de3b 461 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = {");\r
462 } else {\r
463 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID gEfiCallerIdGuid = {");\r
464 }\r
465\r
5f907e4a 466 if (guid == null) {\r
467 throw new AutoGenException("Guid value must set!\n");\r
468 }\r
469\r
470 //\r
471 // Formate Guid as ANSI c form.Example:\r
472 // {0xd2b2b828, 0x826, 0x48a7,{0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24,\r
473 // 0xf0}}\r
474 //\r
475\r
476 fileBuffer.append(guid);\r
aacce761 477 fileBuffer.append("};\r\n");\r
5f907e4a 478\r
479 //\r
480 // Generate library instance consumed protocol, guid, ppi, pcd list.\r
481 // Save those to this.protocolList, this.ppiList, this.pcdList,\r
482 // this.guidList. Write Consumed library constructor and desconstuct to\r
483 // autogen.c\r
484 //\r
136adffc 485 LibInstanceToAutogenC(fileBuffer);\r
ff225cbb 486\r
878ddf1f 487 //\r
136adffc 488 // Get module dependent Package identification.\r
878ddf1f 489 //\r
83fba802 490 PackageIdentification[] packages = saq.getDependencePkg(this.arch);\r
5f907e4a 491 for (int i = 0; i < packages.length; i++) {\r
492 if (!this.mDepPkgList.contains(packages[i])) {\r
136adffc 493 this.mDepPkgList.add(packages[i]);\r
878ddf1f 494 }\r
ff225cbb 495\r
136adffc 496 }\r
ff225cbb 497\r
5f907e4a 498 //\r
499 // Write consumed ppi, guid, protocol to autogen.c\r
500 //\r
501 ProtocolGuidToAutogenC(fileBuffer);\r
502 PpiGuidToAutogenC(fileBuffer);\r
503 GuidGuidToAutogenC(fileBuffer);\r
ff225cbb 504\r
5f907e4a 505 //\r
506 // Call pcd autogen.\r
507 //\r
508 this.myPcdAutogen = new PCDAutoGenAction(moduleId, \r
509 arch, \r
510 false, \r
511 null,\r
2eb7d78d 512 pcdDriverType, \r
513 parentId);\r
a387de3b 514\r
61528a1b 515 this.myPcdAutogen.execute();\r
5f907e4a 516 if (this.myPcdAutogen != null) {\r
aacce761 517 fileBuffer.append("\r\n");\r
11eb278a 518 fileBuffer.append(this.myPcdAutogen.getCAutoGenString());\r
5f907e4a 519 }\r
520\r
521 if (!saveFile(outputPath + File.separatorChar + "AutoGen.c", fileBuffer)) {\r
61528a1b 522 throw new AutoGenException("Failed to generate AutoGen.c !!!");\r
5f907e4a 523 }\r
524\r
525 }\r
526\r
527 /**\r
cb4d97bd 528 libGenAutogenH\r
529 \r
530 This function generates AutoGen.h for library.\r
531 \r
532 @throws BuildException\r
533 Failed to generate AutoGen.c.\r
534 **/\r
61528a1b 535 void libGenAutogenH() throws EdkException {\r
5f907e4a 536\r
537 Set<String> libClassIncludeH;\r
538 String moduleType;\r
539 List<String> headerFileList;\r
540 Iterator item;\r
541 StringBuffer fileBuffer = new StringBuffer(10240);\r
542\r
543 //\r
544 // Write Autogen.h header notation\r
545 //\r
cb4d97bd 546 fileBuffer.append(CommonDefinition.AUTOGENHNOTATION);\r
5f907e4a 547\r
548 //\r
549 // Add #ifndef ${BaseName}_AUTOGENH\r
550 // #def ${BseeName}_AUTOGENH\r
551 //\r
cb4d97bd 552 fileBuffer.append(CommonDefinition.IFNDEF \r
a387de3b 553 + CommonDefinition.AUTOGENH\r
554 + this.moduleId.getGuid().replaceAll("-", "_") \r
555 + ToolDefinitions.LINE_SEPARATOR);\r
cb4d97bd 556 fileBuffer.append(CommonDefinition.DEFINE \r
a387de3b 557 + CommonDefinition.AUTOGENH\r
558 + this.moduleId.getGuid().replaceAll("-", "_") \r
559 + ToolDefinitions.LINE_SEPARATOR \r
560 + ToolDefinitions.LINE_SEPARATOR);\r
5f907e4a 561\r
562 //\r
563 // Write EFI_SPECIFICATION_VERSION and EDK_RELEASE_VERSION\r
564 // to autogen.h file.\r
565 // Note: the specification version and release version should\r
566 // be get from module surface area instead of hard code.\r
567 //\r
cb4d97bd 568 fileBuffer.append(CommonDefinition.AUTOGENHBEGIN);\r
83fba802 569 String[] specList = saq.getExternSpecificaiton();\r
5f907e4a 570 for (int i = 0; i < specList.length; i++) {\r
aacce761 571 fileBuffer.append(CommonDefinition.DEFINE + specList[i] + "\r\n");\r
5f907e4a 572 }\r
573 // fileBuffer.append(CommonDefinition.autoGenHLine1);\r
574 // fileBuffer.append(CommonDefinition.autoGenHLine2);\r
575\r
576 //\r
577 // Write consumed package's mdouleInfo related *.h file to autogen.h.\r
578 //\r
83fba802 579 moduleType = saq.getModuleType();\r
aacce761 580 PackageIdentification[] cosumedPkglist = saq.getDependencePkg(this.arch);\r
5f907e4a 581 headerFileList = depPkgToAutogenH(cosumedPkglist, moduleType);\r
582 item = headerFileList.iterator();\r
583 while (item.hasNext()) {\r
584 fileBuffer.append(item.next().toString());\r
585 }\r
586 //\r
587 // Write library class's related *.h file to autogen.h\r
588 //\r
700279a9 589 String[] libClassList = saq.getLibraryClasses(CommonDefinition.ALWAYSCONSUMED, this.arch, null);\r
5f907e4a 590 if (libClassList != null) {\r
591 libClassIncludeH = LibraryClassToAutogenH(libClassList);\r
592 item = libClassIncludeH.iterator();\r
593 while (item.hasNext()) {\r
594 fileBuffer.append(item.next().toString());\r
595 }\r
596 }\r
597\r
700279a9 598 libClassList = saq.getLibraryClasses(CommonDefinition.ALWAYSPRODUCED, this.arch, null);\r
5f907e4a 599 if (libClassList != null) {\r
600 libClassIncludeH = LibraryClassToAutogenH(libClassList);\r
601 item = libClassIncludeH.iterator();\r
602 while (item.hasNext()) {\r
603 fileBuffer.append(item.next().toString());\r
604 }\r
605 }\r
cb4d97bd 606 fileBuffer.append(ToolDefinitions.LINE_SEPARATOR);\r
136adffc 607\r
73b4e31a 608 //\r
ff225cbb 609 // If is TianoR8FlashMap, copy {Fv_DIR}/FlashMap.h to\r
73b4e31a 610 // {DEST_DIR_DRBUG}/FlashMap.h\r
ff225cbb 611 //\r
83fba802 612 if (saq.isHaveTianoR8FlashMap()) {\r
cb4d97bd 613 fileBuffer.append(CommonDefinition.INCLUDE);\r
73b4e31a 614 fileBuffer.append(" <");\r
aacce761 615 fileBuffer.append(CommonDefinition.TIANOR8PLASHMAPH + ">\r\n");\r
73b4e31a 616 copyFlashMapHToDebugDir();\r
617 }\r
618\r
5f907e4a 619 //\r
620 // Write PCD information to library AutoGen.h.\r
621 //\r
622 if (this.myPcdAutogen != null) {\r
aacce761 623 fileBuffer.append("\r\n");\r
11eb278a 624 fileBuffer.append(this.myPcdAutogen.getHAutoGenString());\r
5f907e4a 625 }\r
f9081b64 626 //\r
627 // generate function prototype for constructor and destructor\r
628 // \r
aacce761 629 LibConstructorToAutogenH(moduleType);\r
630 LibDestructorToAutogenH(moduleType);\r
631 ExternCallBackToAutoGenH(moduleType);\r
632 fileBuffer.append(functionDeclarations);\r
5f907e4a 633 //\r
634 // Append the #endif at AutoGen.h\r
635 //\r
aacce761 636 fileBuffer.append("#endif\r\n");\r
5f907e4a 637 //\r
638 // Save content of string buffer to AutoGen.h file.\r
639 //\r
640 if (!saveFile(outputPath + File.separatorChar + "AutoGen.h", fileBuffer)) {\r
61528a1b 641 throw new AutoGenException("Failed to generate AutoGen.h !!!");\r
5f907e4a 642 }\r
643 }\r
644\r
645 /**\r
cb4d97bd 646 libGenAutogenC\r
647 \r
648 This function generates AutoGen.h for library.\r
649 \r
650 @throws BuildException\r
651 Failed to generate AutoGen.c.\r
652 **/\r
61528a1b 653 void libGenAutogenC() throws EdkException {\r
5f907e4a 654 StringBuffer fileBuffer = new StringBuffer(10240);\r
655\r
656 //\r
657 // Write Autogen.c header notation\r
658 //\r
cb4d97bd 659 fileBuffer.append(CommonDefinition.AUTOGENCNOTATION);\r
5f907e4a 660\r
cb4d97bd 661 fileBuffer.append(ToolDefinitions.LINE_SEPARATOR);\r
662 fileBuffer.append(ToolDefinitions.LINE_SEPARATOR);\r
5f907e4a 663\r
664 //\r
665 // Call pcd autogen.\r
666 //\r
667 this.myPcdAutogen = new PCDAutoGenAction(moduleId,\r
668 arch,\r
669 true,\r
7432a214 670 saq.getModulePcdEntryNameArray(this.arch),\r
2eb7d78d 671 pcdDriverType, \r
672 parentId);\r
61528a1b 673 this.myPcdAutogen.execute();\r
5f907e4a 674 if (this.myPcdAutogen != null) {\r
cb4d97bd 675 fileBuffer.append(ToolDefinitions.LINE_SEPARATOR);\r
11eb278a 676 fileBuffer.append(this.myPcdAutogen.getCAutoGenString());\r
5f907e4a 677 }\r
5f907e4a 678 }\r
679\r
680 /**\r
cb4d97bd 681 LibraryClassToAutogenH\r
682 \r
683 This function returns *.h files declared by library classes which are\r
684 consumed or produced by current build module or library.\r
685 \r
686 @param libClassList\r
687 List of library class which consumed or produce by current\r
688 build module or library.\r
689 @return includeStrList List of *.h file.\r
690 **/\r
5f907e4a 691 Set<String> LibraryClassToAutogenH(String[] libClassList)\r
61528a1b 692 throws EdkException {\r
cb4d97bd 693 Set<String> includeStrList = new LinkedHashSet<String>();\r
694 String includeName[];\r
5f907e4a 695 String str = "";\r
696\r
697 //\r
698 // Get include file from GlobalData's SPDTable according to\r
699 // library class name.\r
700 //\r
5f907e4a 701 for (int i = 0; i < libClassList.length; i++) {\r
cb4d97bd 702 includeName = GlobalData.getLibraryClassHeaderFiles(\r
a387de3b 703 saq.getDependencePkg(this.arch),\r
704 libClassList[i]);\r
705 if (includeName == null) {\r
706 throw new AutoGenException("Can not find library class ["\r
5f907e4a 707 + libClassList[i] + "] declaration in any SPD package. ");\r
708 }\r
cb4d97bd 709 for (int j = 0; j < includeName.length; j++) {\r
710 String includeNameStr = includeName[j];\r
5f907e4a 711 if (includeNameStr != null) {\r
cb4d97bd 712 str = CommonDefinition.INCLUDE + " " + "<";\r
aacce761 713 str = str + includeNameStr + ">\r\n";\r
cb4d97bd 714 includeStrList.add(str);\r
5f907e4a 715 includeNameStr = null;\r
878ddf1f 716 }\r
5f907e4a 717 }\r
718 }\r
cb4d97bd 719 return includeStrList;\r
5f907e4a 720 }\r
721\r
722 /**\r
cb4d97bd 723 IncludesToAutogenH\r
724 \r
725 This function add include file in AutoGen.h file.\r
726 \r
727 @param packageNameList\r
728 List of module depended package.\r
729 @param moduleType\r
730 Module type.\r
731 @return\r
732 **/\r
5f907e4a 733 List<String> depPkgToAutogenH(PackageIdentification[] packageNameList,\r
734 String moduleType) throws AutoGenException {\r
735\r
736 List<String> includeStrList = new LinkedList<String>();\r
737 String pkgHeader;\r
738 String includeStr = "";\r
739\r
740 //\r
741 // Get include file from moduleInfo file\r
742 //\r
743 for (int i = 0; i < packageNameList.length; i++) {\r
744 pkgHeader = GlobalData.getPackageHeaderFiles(packageNameList[i],\r
745 moduleType);\r
746 if (pkgHeader == null) {\r
747 throw new AutoGenException("Can not find package ["\r
748 + packageNameList[i]\r
749 + "] declaration in any SPD package. ");\r
750 } else if (!pkgHeader.equalsIgnoreCase("")) {\r
aacce761 751 includeStr = CommonDefinition.INCLUDE + " <" + pkgHeader + ">\r\n";\r
5f907e4a 752 includeStrList.add(includeStr);\r
753 }\r
754 }\r
755\r
756 return includeStrList;\r
757 }\r
758\r
759 /**\r
cb4d97bd 760 EntryPointToAutoGen\r
761 \r
762 This function convert <ModuleEntryPoint> & <ModuleUnloadImage>\r
763 information in mas to AutoGen.c\r
764 \r
765 @param entryPointList\r
766 List of entry point.\r
767 @param fileBuffer\r
768 String buffer fo AutoGen.c.\r
769 @throws Exception\r
770 **/\r
771 void EntryPointToAutoGen(String[] entryPointList, String[] unloadImageList, StringBuffer fileBuffer)\r
61528a1b 772 throws EdkException {\r
5f907e4a 773\r
83fba802 774 String typeStr = saq.getModuleType();\r
aacce761 775 String debugStr = "DEBUG ((EFI_D_INFO | EFI_D_LOAD, \"Module Entry Point (%s) 0x%%p\\n\", (VOID *)(UINTN)%s));\r\n";\r
a387de3b 776 int unloadImageCount = 0;\r
cb4d97bd 777 int entryPointCount = 0;\r
5f907e4a 778\r
779 //\r
780 // The parameters and return value of entryPoint is difference\r
781 // for difference module type.\r
782 //\r
783 switch (CommonDefinition.getModuleType(typeStr)) {\r
784 \r
785 case CommonDefinition.ModuleTypePeiCore:\r
786 if (entryPointList == null ||entryPointList.length != 1 ) {\r
aacce761 787 throw new AutoGenException("Module type = 'PEI_CORE', can have only one module entry point!");\r
5f907e4a 788 } else {\r
149127db 789 functionDeclarations.append("EFI_STATUS\r\n");\r
790 functionDeclarations.append("EFIAPI\r\n");\r
791 functionDeclarations.append(entryPointList[0]);\r
792 functionDeclarations.append(" (\r\n");\r
793 functionDeclarations.append(" IN EFI_PEI_STARTUP_DESCRIPTOR *PeiStartupDescriptor,\r\n");\r
794 functionDeclarations.append(" IN VOID *OldCoreData\r\n");\r
795 functionDeclarations.append(" );\r\n\r\n");\r
aacce761 796\r
797 fileBuffer.append("EFI_STATUS\r\n");\r
798 fileBuffer.append("EFIAPI\r\n");\r
799 fileBuffer.append("ProcessModuleEntryPointList (\r\n");\r
800 fileBuffer.append(" IN EFI_PEI_STARTUP_DESCRIPTOR *PeiStartupDescriptor,\r\n");\r
801 fileBuffer.append(" IN VOID *OldCoreData\r\n");\r
802 fileBuffer.append(" )\r\n\r\n");\r
803 fileBuffer.append("{\r\n");\r
5f907e4a 804 fileBuffer.append(" return ");\r
805 fileBuffer.append(entryPointList[0]);\r
aacce761 806 fileBuffer.append(" (PeiStartupDescriptor, OldCoreData);\r\n");\r
807 fileBuffer.append("}\r\n\r\n");\r
5f907e4a 808 }\r
809 break;\r
878ddf1f 810\r
5f907e4a 811 case CommonDefinition.ModuleTypeDxeCore:\r
aacce761 812 fileBuffer.append("const UINT32 _gUefiDriverRevision = 0;\r\n");\r
5f907e4a 813 if (entryPointList == null || entryPointList.length != 1) {\r
a387de3b 814 throw new AutoGenException("Module type = 'DXE_CORE', can have only one module entry point!");\r
5f907e4a 815 } else {\r
149127db 816 functionDeclarations.append("VOID\r\n");\r
817 functionDeclarations.append("EFIAPI\r\n");\r
818 functionDeclarations.append(entryPointList[0]);\r
819 functionDeclarations.append(" (\r\n");\r
820 functionDeclarations.append(" IN VOID *HobStart\r\n");\r
821 functionDeclarations.append(" );\r\n\r\n");\r
aacce761 822\r
823 fileBuffer.append("VOID\r\n");\r
824 fileBuffer.append("EFIAPI\r\n");\r
825 fileBuffer.append("ProcessModuleEntryPointList (\r\n");\r
826 fileBuffer.append(" IN VOID *HobStart\r\n");\r
827 fileBuffer.append(" )\r\n\r\n");\r
828 fileBuffer.append("{\r\n");\r
5f907e4a 829 fileBuffer.append(" ");\r
830 fileBuffer.append(entryPointList[0]);\r
aacce761 831 fileBuffer.append(" (HobStart);\r\n");\r
832 fileBuffer.append("}\r\n\r\n");\r
5f907e4a 833 }\r
834 break;\r
835\r
836 case CommonDefinition.ModuleTypePeim:\r
cb4d97bd 837 entryPointCount = 0;\r
aacce761 838 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = 0;\r\n");\r
5f907e4a 839 if (entryPointList == null || entryPointList.length == 0) {\r
aacce761 840 fileBuffer.append("EFI_STATUS\r\n");\r
841 fileBuffer.append("EFIAPI\r\n");\r
842 fileBuffer.append("ProcessModuleEntryPointList (\r\n");\r
843 fileBuffer.append(" IN EFI_FFS_FILE_HEADER *FfsHeader,\r\n");\r
844 fileBuffer.append(" IN EFI_PEI_SERVICES **PeiServices\r\n");\r
845 fileBuffer.append(" )\r\n\r\n");\r
846 fileBuffer.append("{\r\n");\r
847 fileBuffer.append(" return EFI_SUCCESS;\r\n");\r
848 fileBuffer.append("}\r\n\r\n");\r
5f907e4a 849 break;\r
850 }\r
851 for (int i = 0; i < entryPointList.length; i++) {\r
149127db 852 functionDeclarations.append("EFI_STATUS\r\n");\r
853 functionDeclarations.append("EFIAPI\r\n");\r
854 functionDeclarations.append(entryPointList[i]);\r
855 functionDeclarations.append(" (\r\n");\r
856 functionDeclarations.append(" IN EFI_FFS_FILE_HEADER *FfsHeader,\r\n");\r
857 functionDeclarations.append(" IN EFI_PEI_SERVICES **PeiServices\r\n");\r
858 functionDeclarations.append(" );\r\n");\r
5f907e4a 859 entryPointCount++;\r
5f907e4a 860 }\r
861\r
aacce761 862 fileBuffer.append("EFI_STATUS\r\n");\r
863 fileBuffer.append("EFIAPI\r\n");\r
864 fileBuffer.append("ProcessModuleEntryPointList (\r\n");\r
865 fileBuffer.append(" IN EFI_FFS_FILE_HEADER *FfsHeader,\r\n");\r
866 fileBuffer.append(" IN EFI_PEI_SERVICES **PeiServices\r\n");\r
867 fileBuffer.append(" )\r\n\r\n");\r
868 fileBuffer.append("{\r\n");\r
5f907e4a 869 if (entryPointCount == 1) {\r
a387de3b 870 fileBuffer.append(String.format(" " + debugStr, entryPointList[0], entryPointList[0]));\r
5f907e4a 871 fileBuffer.append(" return ");\r
872 fileBuffer.append(entryPointList[0]);\r
aacce761 873 fileBuffer.append(" (FfsHeader, PeiServices);\r\n");\r
5f907e4a 874 } else {\r
aacce761 875 fileBuffer.append(" EFI_STATUS Status;\r\n");\r
876 fileBuffer.append(" EFI_STATUS CombinedStatus;\r\n\r\n");\r
877 fileBuffer.append(" CombinedStatus = EFI_LOAD_ERROR;\r\n\r\n");\r
5f907e4a 878 for (int i = 0; i < entryPointList.length; i++) {\r
879 if (!entryPointList[i].equals("")) {\r
a387de3b 880 fileBuffer.append(String.format(" " + debugStr, entryPointList[i], entryPointList[i]));\r
5f907e4a 881 fileBuffer.append(" Status = ");\r
882 fileBuffer.append(entryPointList[i]);\r
aacce761 883 fileBuffer.append(" (FfsHeader, PeiServices);\r\n");\r
884 fileBuffer.append(" if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {\r\n");\r
885 fileBuffer.append(" CombinedStatus = Status;\r\n");\r
886 fileBuffer.append(" }\r\n\r\n");\r
5f907e4a 887 } else {\r
888 break;\r
889 }\r
890 }\r
aacce761 891 fileBuffer.append(" return CombinedStatus;\r\n");\r
5f907e4a 892 }\r
aacce761 893 fileBuffer.append("}\r\n\r\n");\r
5f907e4a 894 break;\r
895\r
896 case CommonDefinition.ModuleTypeDxeSmmDriver:\r
897 entryPointCount = 0;\r
898 //\r
899 // If entryPoint is null, create an empty ProcessModuleEntryPointList\r
900 // function.\r
901 //\r
902 if (entryPointList == null || entryPointList.length == 0) {\r
a387de3b 903 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverEntryPointCount = ");\r
5f907e4a 904 fileBuffer.append(Integer.toString(entryPointCount));\r
aacce761 905 fileBuffer.append(";\r\n");\r
906 fileBuffer.append("EFI_STATUS\r\n");\r
907 fileBuffer.append("EFIAPI\r\n");\r
908 fileBuffer.append("ProcessModuleEntryPointList (\r\n");\r
909 fileBuffer.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
910 fileBuffer.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
911 fileBuffer.append(" )\r\n\r\n");\r
912 fileBuffer.append("{\r\n");\r
913 fileBuffer.append(" return EFI_SUCCESS;\r\n");\r
914 fileBuffer.append("}\r\n\r\n");\r
5f907e4a 915\r
916 } else {\r
917 for (int i = 0; i < entryPointList.length; i++) {\r
149127db 918 functionDeclarations.append("EFI_STATUS\r\n");\r
919 functionDeclarations.append("EFIAPI\r\n");\r
920 functionDeclarations.append(entryPointList[i]);\r
921 functionDeclarations.append(" (\r\n");\r
922 functionDeclarations.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
923 functionDeclarations.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
924 functionDeclarations.append(" );\r\n");\r
5f907e4a 925 entryPointCount++;\r
926 }\r
a387de3b 927 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverEntryPointCount = ");\r
5f907e4a 928 fileBuffer.append(Integer.toString(entryPointCount));\r
aacce761 929 fileBuffer.append(";\r\n");\r
930 fileBuffer.append("static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r\n");\r
931 fileBuffer.append("static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;\r\n\r\n");\r
932\r
933 fileBuffer.append("EFI_STATUS\r\n");\r
934 fileBuffer.append("EFIAPI\r\n");\r
935 fileBuffer.append("ProcessModuleEntryPointList (\r\n");\r
936 fileBuffer.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
937 fileBuffer.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
938 fileBuffer.append(" )\r\n\r\n");\r
939 fileBuffer.append("{\r\n");\r
5f907e4a 940\r
5f907e4a 941 for (int i = 0; i < entryPointList.length; i++) {\r
aacce761 942 fileBuffer.append(" if (SetJump (&mJumpContext) == 0) {\r\n");\r
a387de3b 943 fileBuffer.append(String.format(" " + debugStr, entryPointList[i], entryPointList[i]));\r
5f907e4a 944 fileBuffer.append(" ExitDriver (");\r
945 fileBuffer.append(entryPointList[i]);\r
aacce761 946 fileBuffer.append(" (ImageHandle, SystemTable));\r\n");\r
947 fileBuffer.append(" ASSERT (FALSE);\r\n");\r
948 fileBuffer.append(" }\r\n");\r
136adffc 949 }\r
aacce761 950 fileBuffer.append(" return mDriverEntryPointStatus;\r\n");\r
951 fileBuffer.append("}\r\n\r\n");\r
952\r
953 fileBuffer.append("VOID\r\n");\r
954 fileBuffer.append("EFIAPI\r\n");\r
955 fileBuffer.append("ExitDriver (\r\n");\r
956 fileBuffer.append(" IN EFI_STATUS Status\r\n");\r
957 fileBuffer.append(" )\r\n\r\n");\r
958 fileBuffer.append("{\r\n");\r
959 fileBuffer.append(" if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r\n");\r
960 fileBuffer.append(" mDriverEntryPointStatus = Status;\r\n");\r
961 fileBuffer.append(" }\r\n");\r
962 fileBuffer.append(" LongJump (&mJumpContext, (UINTN)-1);\r\n");\r
963 fileBuffer.append(" ASSERT (FALSE);\r\n");\r
964 fileBuffer.append("}\r\n\r\n");\r
136adffc 965 }\r
ff225cbb 966\r
967\r
5f907e4a 968 //\r
969 // Add "ModuleUnloadImage" for DxeSmmDriver module type;\r
970 //\r
136adffc 971\r
a387de3b 972 unloadImageCount = 0;\r
cb4d97bd 973 if (unloadImageList != null) {\r
974 for (int i = 0; i < unloadImageList.length; i++) {\r
149127db 975 functionDeclarations.append("EFI_STATUS\r\n");\r
976 functionDeclarations.append(unloadImageList[i]);\r
977 functionDeclarations.append(" (\r\n");\r
978 functionDeclarations.append(" IN EFI_HANDLE ImageHandle\r\n");\r
979 functionDeclarations.append(" );\r\n");\r
cb4d97bd 980 unloadImageCount++;\r
a84091c4 981 }\r
5f907e4a 982 }\r
136adffc 983\r
a387de3b 984 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ");\r
cb4d97bd 985 fileBuffer.append(Integer.toString(unloadImageCount));\r
aacce761 986 fileBuffer.append(";\r\n\r\n");\r
5f907e4a 987\r
aacce761 988 fileBuffer.append("EFI_STATUS\r\n");\r
989 fileBuffer.append("EFIAPI\r\n");\r
990 fileBuffer.append("ProcessModuleUnloadList (\r\n");\r
991 fileBuffer.append(" IN EFI_HANDLE ImageHandle\r\n");\r
992 fileBuffer.append(" )\r\n");\r
993 fileBuffer.append("{\r\n");\r
5f907e4a 994\r
cb4d97bd 995 if (unloadImageCount == 0) {\r
aacce761 996 fileBuffer.append(" return EFI_SUCCESS;\r\n");\r
cb4d97bd 997 } else if (unloadImageCount == 1) {\r
5f907e4a 998 fileBuffer.append(" return ");\r
cb4d97bd 999 fileBuffer.append(unloadImageList[0]);\r
aacce761 1000 fileBuffer.append("(ImageHandle);\r\n");\r
5f907e4a 1001 } else {\r
aacce761 1002 fileBuffer.append(" EFI_STATUS Status;\r\n\r\n");\r
1003 fileBuffer.append(" Status = EFI_SUCCESS;\r\n\r\n");\r
cb4d97bd 1004 for (int i = 0; i < unloadImageList.length; i++) {\r
5f907e4a 1005 if (i == 0) {\r
136adffc 1006 fileBuffer.append(" Status = ");\r
cb4d97bd 1007 fileBuffer.append(unloadImageList[i]);\r
aacce761 1008 fileBuffer.append("(ImageHandle);\r\n");\r
5f907e4a 1009 } else {\r
aacce761 1010 fileBuffer.append(" if (EFI_ERROR (Status)) {\r\n");\r
878ddf1f 1011 fileBuffer.append(" ");\r
cb4d97bd 1012 fileBuffer.append(unloadImageList[i]);\r
aacce761 1013 fileBuffer.append("(ImageHandle);\r\n");\r
1014 fileBuffer.append(" } else {\r\n");\r
878ddf1f 1015 fileBuffer.append(" Status = ");\r
cb4d97bd 1016 fileBuffer.append(unloadImageList[i]);\r
aacce761 1017 fileBuffer.append("(ImageHandle);\r\n");\r
1018 fileBuffer.append(" }\r\n");\r
878ddf1f 1019 }\r
5f907e4a 1020 }\r
aacce761 1021 fileBuffer.append(" return Status;\r\n");\r
5f907e4a 1022 }\r
aacce761 1023 fileBuffer.append("}\r\n\r\n");\r
5f907e4a 1024 break;\r
1025\r
1026 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1027 case CommonDefinition.ModuleTypeDxeDriver:\r
1028 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1029 case CommonDefinition.ModuleTypeUefiDriver:\r
1030 case CommonDefinition.ModuleTypeUefiApplication:\r
1031 entryPointCount = 0;\r
aacce761 1032 fileBuffer.append("const UINT32 _gUefiDriverRevision = 0;\r\n");\r
136adffc 1033 //\r
1034 // If entry point is null, create a empty ProcessModuleEntryPointList function.\r
1035 //\r
5f907e4a 1036 if (entryPointList == null || entryPointList.length == 0) {\r
aacce761 1037 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverEntryPointCount = 0;\r\n");\r
1038 fileBuffer.append("EFI_STATUS\r\n");\r
1039 fileBuffer.append("EFIAPI\r\n");\r
1040 fileBuffer.append("ProcessModuleEntryPointList (\r\n");\r
1041 fileBuffer.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1042 fileBuffer.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
1043 fileBuffer.append(" )\r\n\r\n");\r
1044 fileBuffer.append("{\r\n");\r
1045 fileBuffer.append(" return EFI_SUCCESS;\r\n");\r
1046 fileBuffer.append("}\r\n");\r
5f907e4a 1047\r
1048 } else {\r
136adffc 1049 for (int i = 0; i < entryPointList.length; i++) {\r
149127db 1050 functionDeclarations.append("EFI_STATUS\r\n");\r
1051 functionDeclarations.append("EFIAPI\r\n");\r
1052 functionDeclarations.append(entryPointList[i]);\r
1053 functionDeclarations.append(" (\r\n");\r
1054 functionDeclarations.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1055 functionDeclarations.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
1056 functionDeclarations.append(" );\r\n");\r
136adffc 1057 entryPointCount++;\r
878ddf1f 1058 }\r
1059\r
a387de3b 1060 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverEntryPointCount = ");\r
136adffc 1061 fileBuffer.append(Integer.toString(entryPointCount));\r
aacce761 1062 fileBuffer.append(";\r\n");\r
136adffc 1063 if (entryPointCount > 1) {\r
aacce761 1064 fileBuffer.append("static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r\n");\r
1065 fileBuffer.append("static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;\r\n");\r
136adffc 1066 }\r
aacce761 1067 fileBuffer.append("\r\n");\r
878ddf1f 1068\r
aacce761 1069 fileBuffer.append("EFI_STATUS\r\n");\r
1070 fileBuffer.append("EFIAPI\r\n");\r
1071 fileBuffer.append("ProcessModuleEntryPointList (\r\n");\r
1072 fileBuffer.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1073 fileBuffer.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
1074 fileBuffer.append(" )\r\n\r\n");\r
1075 fileBuffer.append("{\r\n");\r
878ddf1f 1076\r
136adffc 1077 if (entryPointCount == 1) {\r
a387de3b 1078 fileBuffer.append(String.format(" " + debugStr, entryPointList[0], entryPointList[0]));\r
1079 fileBuffer.append(" return ");\r
136adffc 1080 fileBuffer.append(entryPointList[0]);\r
aacce761 1081 fileBuffer.append(" (ImageHandle, SystemTable);\r\n");\r
136adffc 1082 } else {\r
1083 for (int i = 0; i < entryPointList.length; i++) {\r
1084 if (!entryPointList[i].equals("")) {\r
aacce761 1085 fileBuffer.append(" if (SetJump (&mJumpContext) == 0) {\r\n");\r
a387de3b 1086 fileBuffer.append(String.format(" " + debugStr, entryPointList[i], entryPointList[i]));\r
136adffc 1087 fileBuffer.append(" ExitDriver (");\r
1088 fileBuffer.append(entryPointList[i]);\r
aacce761 1089 fileBuffer.append(" (ImageHandle, SystemTable));\r\n");\r
1090 fileBuffer.append(" ASSERT (FALSE);\r\n");\r
1091 fileBuffer.append(" }\r\n");\r
136adffc 1092 } else {\r
1093 break;\r
1094 }\r
878ddf1f 1095 }\r
aacce761 1096 fileBuffer.append(" return mDriverEntryPointStatus;\r\n");\r
878ddf1f 1097 }\r
aacce761 1098 fileBuffer.append("}\r\n\r\n");\r
1099\r
1100 fileBuffer.append("VOID\r\n");\r
1101 fileBuffer.append("EFIAPI\r\n");\r
1102 fileBuffer.append("ExitDriver (\r\n");\r
1103 fileBuffer.append(" IN EFI_STATUS Status\r\n");\r
1104 fileBuffer.append(" )\r\n\r\n");\r
1105 fileBuffer.append("{\r\n");\r
136adffc 1106 if (entryPointCount <= 1) {\r
aacce761 1107 fileBuffer.append(" if (EFI_ERROR (Status)) {\r\n");\r
1108 fileBuffer.append(" ProcessLibraryDestructorList (gImageHandle, gST);\r\n");\r
1109 fileBuffer.append(" }\r\n");\r
a30ae9fa 1110 fileBuffer.append(" gBS->Exit (gImageHandle, Status, 0, NULL);\r\n");\r
878ddf1f 1111 } else {\r
aacce761 1112 fileBuffer.append(" if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r\n");\r
1113 fileBuffer.append(" mDriverEntryPointStatus = Status;\r\n");\r
1114 fileBuffer.append(" }\r\n");\r
1115 fileBuffer.append(" LongJump (&mJumpContext, (UINTN)-1);\r\n");\r
1116 fileBuffer.append(" ASSERT (FALSE);\r\n");\r
878ddf1f 1117 }\r
aacce761 1118 fileBuffer.append("}\r\n\r\n");\r
878ddf1f 1119 }\r
ff225cbb 1120\r
5f907e4a 1121 //\r
1122 // Add ModuleUnloadImage for DxeDriver and UefiDriver module type.\r
1123 //\r
d8f1335e 1124 //entryPointList = SurfaceAreaQuery.getModuleUnloadImageArray();\r
1125 //\r
1126 // Remover duplicate unload entry point.\r
1127 //\r
1128 //entryPointList = CommonDefinition.remDupString(entryPointList);\r
1129 //entryPointCount = 0;\r
a387de3b 1130 unloadImageCount = 0;\r
cb4d97bd 1131 if (unloadImageList != null) {\r
1132 for (int i = 0; i < unloadImageList.length; i++) {\r
149127db 1133 functionDeclarations.append("EFI_STATUS\r\n");\r
1134 functionDeclarations.append("EFIAPI\r\n");\r
1135 functionDeclarations.append(unloadImageList[i]);\r
1136 functionDeclarations.append(" (\r\n");\r
1137 functionDeclarations.append(" IN EFI_HANDLE ImageHandle\r\n");\r
1138 functionDeclarations.append(" );\r\n");\r
cb4d97bd 1139 unloadImageCount++;\r
5f907e4a 1140 }\r
1141 }\r
1142\r
a387de3b 1143 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ");\r
cb4d97bd 1144 fileBuffer.append(Integer.toString(unloadImageCount));\r
aacce761 1145 fileBuffer.append(";\r\n\r\n");\r
5f907e4a 1146\r
aacce761 1147 fileBuffer.append("EFI_STATUS\r\n");\r
1148 fileBuffer.append("EFIAPI\r\n");\r
1149 fileBuffer.append("ProcessModuleUnloadList (\r\n");\r
1150 fileBuffer.append(" IN EFI_HANDLE ImageHandle\r\n");\r
1151 fileBuffer.append(" )\r\n");\r
1152 fileBuffer.append("{\r\n");\r
5f907e4a 1153\r
cb4d97bd 1154 if (unloadImageCount == 0) {\r
aacce761 1155 fileBuffer.append(" return EFI_SUCCESS;\r\n");\r
cb4d97bd 1156 } else if (unloadImageCount == 1) {\r
5f907e4a 1157 fileBuffer.append(" return ");\r
cb4d97bd 1158 fileBuffer.append(unloadImageList[0]);\r
aacce761 1159 fileBuffer.append("(ImageHandle);\r\n");\r
5f907e4a 1160 } else {\r
aacce761 1161 fileBuffer.append(" EFI_STATUS Status;\r\n\r\n");\r
1162 fileBuffer.append(" Status = EFI_SUCCESS;\r\n\r\n");\r
cb4d97bd 1163 for (int i = 0; i < unloadImageList.length; i++) {\r
25832ed3 1164 if (i == 0) {\r
1165 fileBuffer.append(" Status = ");\r
cb4d97bd 1166 fileBuffer.append(unloadImageList[i]);\r
aacce761 1167 fileBuffer.append("(ImageHandle);\r\n");\r
5f907e4a 1168 } else {\r
aacce761 1169 fileBuffer.append(" if (EFI_ERROR (Status)) {\r\n");\r
5f907e4a 1170 fileBuffer.append(" ");\r
cb4d97bd 1171 fileBuffer.append(unloadImageList[i]);\r
aacce761 1172 fileBuffer.append("(ImageHandle);\r\n");\r
1173 fileBuffer.append(" } else {\r\n");\r
5f907e4a 1174 fileBuffer.append(" Status = ");\r
cb4d97bd 1175 fileBuffer.append(unloadImageList[i]);\r
aacce761 1176 fileBuffer.append("(ImageHandle);\r\n");\r
1177 fileBuffer.append(" }\r\n");\r
25832ed3 1178 }\r
5f907e4a 1179 }\r
aacce761 1180 fileBuffer.append(" return Status;\r\n");\r
5f907e4a 1181 }\r
aacce761 1182 fileBuffer.append("}\r\n\r\n");\r
5f907e4a 1183 break;\r
1184 }\r
1185 }\r
1186\r
1187 /**\r
cb4d97bd 1188 PpiGuidToAutogenc\r
1189 \r
1190 This function gets GUIDs from SPD file accrodeing to <PPIs> information\r
1191 and write those GUIDs to AutoGen.c.\r
1192 \r
1193 @param fileBuffer\r
1194 String Buffer for Autogen.c file.\r
1195 @throws BuildException\r
1196 Guid must set value!\r
1197 **/\r
5f907e4a 1198 void PpiGuidToAutogenC(StringBuffer fileBuffer) throws AutoGenException {\r
1199 String[] cNameGuid = null;\r
1200\r
1201 //\r
1202 // Get the all PPI adn PPI Notify from MSA file,\r
1203 // then add those PPI ,and PPI Notify name to list.\r
1204 //\r
1205\r
83fba802 1206 String[] ppiList = saq.getPpiArray(this.arch);\r
5f907e4a 1207 for (int i = 0; i < ppiList.length; i++) {\r
1208 this.mPpiList.add(ppiList[i]);\r
1209 }\r
1210\r
83fba802 1211 String[] ppiNotifyList = saq.getPpiNotifyArray(this.arch);\r
5f907e4a 1212 for (int i = 0; i < ppiNotifyList.length; i++) {\r
1213 this.mPpiList.add(ppiNotifyList[i]);\r
1214 }\r
1215\r
1216 //\r
1217 // Find CNAME and GUID from dependence SPD file and write to Autogen.c\r
1218 //\r
1219 Iterator ppiIterator = this.mPpiList.iterator();\r
1220 String ppiKeyWord = null;\r
1221 while (ppiIterator.hasNext()) {\r
1222 ppiKeyWord = ppiIterator.next().toString();\r
1223 cNameGuid = GlobalData.getPpiGuid(this.mDepPkgList, ppiKeyWord);\r
1224 if (cNameGuid != null) {\r
aacce761 1225 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID ");\r
5f907e4a 1226 fileBuffer.append(cNameGuid[0]);\r
1227 fileBuffer.append(" = { ");\r
1228 fileBuffer.append(CommonDefinition.formatGuidName(cNameGuid[1]));\r
1229 fileBuffer.append(" } ;");\r
1230 } else {\r
1231 //\r
1232 // If can't find Ppi GUID declaration in every package\r
1233 //\r
1234 throw new AutoGenException("Can not find Ppi GUID ["\r
1235 + ppiKeyWord + "] declaration in any SPD package!");\r
1236 }\r
1237 }\r
1238 }\r
1239\r
1240 /**\r
cb4d97bd 1241 ProtocolGuidToAutogenc\r
1242 \r
1243 This function gets GUIDs from SPD file accrodeing to <Protocol>\r
1244 information and write those GUIDs to AutoGen.c.\r
1245 \r
1246 @param fileBuffer\r
1247 String Buffer for Autogen.c file.\r
1248 @throws BuildException\r
1249 Protocol name must set.\r
1250 **/\r
61528a1b 1251 void ProtocolGuidToAutogenC(StringBuffer fileBuffer) throws EdkException {\r
5f907e4a 1252 String[] cNameGuid = null;\r
1253\r
83fba802 1254 String[] protocolList = saq.getProtocolArray(this.arch);\r
5f907e4a 1255\r
1256 //\r
1257 // Add result to Autogen global list.\r
1258 //\r
1259 for (int i = 0; i < protocolList.length; i++) {\r
1260 this.mProtocolList.add(protocolList[i]);\r
1261 }\r
1262\r
a387de3b 1263 String[] protocolNotifyList = saq.getProtocolNotifyArray(this.arch);\r
5f907e4a 1264\r
1265 for (int i = 0; i < protocolNotifyList.length; i++) {\r
1266 this.mProtocolList.add(protocolNotifyList[i]);\r
1267 }\r
1268\r
1269 //\r
1270 // Get the NAME and GUID from dependence SPD and write to Autogen.c\r
1271 //\r
1272 Iterator protocolIterator = this.mProtocolList.iterator();\r
1273 String protocolKeyWord = null;\r
1274\r
1275\r
1276 while (protocolIterator.hasNext()) {\r
1277 protocolKeyWord = protocolIterator.next().toString();\r
1278 cNameGuid = GlobalData.getProtocolGuid(this.mDepPkgList, protocolKeyWord);\r
1279 if (cNameGuid != null) {\r
aacce761 1280 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID ");\r
5f907e4a 1281 fileBuffer.append(cNameGuid[0]);\r
1282 fileBuffer.append(" = { ");\r
1283 fileBuffer.append(CommonDefinition.formatGuidName(cNameGuid[1]));\r
1284 fileBuffer.append(" } ;");\r
1285 } else {\r
1286 //\r
1287 // If can't find protocol GUID declaration in every package\r
1288 //\r
61528a1b 1289 throw new AutoGenException("Can not find protocol Guid ["\r
a387de3b 1290 + protocolKeyWord + "] declaration in any SPD package!");\r
5f907e4a 1291 }\r
1292 }\r
1293 }\r
1294\r
1295 /**\r
cb4d97bd 1296 GuidGuidToAutogenc\r
1297 \r
1298 This function gets GUIDs from SPD file accrodeing to <Guids> information\r
1299 and write those GUIDs to AutoGen.c.\r
1300 \r
1301 @param fileBuffer\r
1302 String Buffer for Autogen.c file.\r
1303 \r
1304 **/\r
5f907e4a 1305 void GuidGuidToAutogenC(StringBuffer fileBuffer) throws AutoGenException {\r
1306 String[] cNameGuid = null;\r
1307 String guidKeyWord = null;\r
1308\r
83fba802 1309 String[] guidList = saq.getGuidEntryArray(this.arch);\r
5f907e4a 1310\r
1311 for (int i = 0; i < guidList.length; i++) {\r
1312 this.mGuidList.add(guidList[i]);\r
1313 }\r
1314\r
1315\r
1316 Iterator guidIterator = this.mGuidList.iterator();\r
1317 while (guidIterator.hasNext()) {\r
1318 guidKeyWord = guidIterator.next().toString();\r
1319 cNameGuid = GlobalData.getGuid(this.mDepPkgList, guidKeyWord);\r
1320\r
1321 if (cNameGuid != null) {\r
aacce761 1322 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID ");\r
5f907e4a 1323 fileBuffer.append(cNameGuid[0]);\r
1324 fileBuffer.append(" = { ");\r
1325 fileBuffer.append(CommonDefinition.formatGuidName(cNameGuid[1]));\r
1326 fileBuffer.append("} ;");\r
1327 } else {\r
1328 //\r
1329 // If can't find GUID declaration in every package\r
1330 //\r
1331 throw new AutoGenException("Can not find Guid [" + guidKeyWord\r
1332 + "] declaration in any SPD package. ");\r
1333 }\r
1334\r
1335 }\r
1336 }\r
1337\r
1338 /**\r
cb4d97bd 1339 LibInstanceToAutogenC\r
1340 \r
1341 This function adds dependent library instance to autogen.c,which\r
1342 includeing library's constructor, destructor, and library dependent ppi,\r
1343 protocol, guid, pcd information.\r
1344 \r
1345 @param fileBuffer\r
1346 String buffer for AutoGen.c\r
1347 @throws BuildException\r
1348 **/\r
61528a1b 1349 void LibInstanceToAutogenC(StringBuffer fileBuffer) throws EdkException {\r
a387de3b 1350 String moduleType = this.moduleId.getModuleType();\r
1351 //\r
1352 // Add library constructor to AutoGen.c\r
1353 //\r
700279a9 1354 LibConstructorToAutogenC(libConstructList, moduleType, fileBuffer);\r
a387de3b 1355 //\r
1356 // Add library destructor to AutoGen.c\r
1357 //\r
700279a9 1358 LibDestructorToAutogenC(libDestructList, moduleType, fileBuffer);\r
5f907e4a 1359 }\r
1360\r
f9081b64 1361 /**\r
1362 LibConstructorToAutogenH\r
1363 \r
1364 This function writes library constructor declarations AutoGen.h. The library\r
1365 constructor's parameter and return value depend on module type.\r
1366 \r
1367 @param libInstanceList\r
1368 List of library construct name.\r
1369 @param moduleType\r
1370 Module type.\r
1371 @param fileBuffer\r
1372 String buffer for AutoGen.c\r
1373 @throws Exception\r
1374 **/\r
aacce761 1375 void LibConstructorToAutogenH(String moduleType) throws EdkException {\r
f9081b64 1376 boolean isFirst = true;\r
1377\r
1378 //\r
1379 // If not yet parse this library instance's constructor\r
1380 // element,parse it.\r
1381 //\r
1382 String libConstructName = saq.getLibConstructorName();\r
1383 if (libConstructName == null) {\r
1384 return;\r
1385 }\r
1386\r
1387 //\r
1388 // The library constructor's parameter and return value depend on\r
1389 // module type.\r
1390 //\r
1391 if (moduleType.equalsIgnoreCase(EdkDefinitions.MODULE_TYPE_BASE)) {\r
aacce761 1392 functionDeclarations.append("RETURN_STATUS\r\n");\r
1393 functionDeclarations.append("EFIAPI\r\n");\r
1394 functionDeclarations.append(libConstructName);\r
1395 functionDeclarations.append(" (\r\n");\r
1396 functionDeclarations.append(" VOID\r\n");\r
1397 functionDeclarations.append(" );\r\n");\r
f9081b64 1398 } else {\r
1399 switch (CommonDefinition.getModuleType(moduleType)) {\r
1400 case CommonDefinition.ModuleTypeBase:\r
aacce761 1401 functionDeclarations.append("RETURN_STATUS\r\n");\r
1402 functionDeclarations.append("EFIAPI\r\n");\r
1403 functionDeclarations.append(libConstructName);\r
1404 functionDeclarations.append(" (\r\n");\r
1405 functionDeclarations.append(" VOID\r\n");\r
1406 functionDeclarations.append(" );\r\n");\r
f9081b64 1407 break;\r
1408\r
1409 case CommonDefinition.ModuleTypePeiCore:\r
1410 case CommonDefinition.ModuleTypePeim:\r
aacce761 1411 functionDeclarations.append("EFI_STATUS\r\n");\r
1412 functionDeclarations.append("EFIAPI\r\n");\r
1413 functionDeclarations.append(libConstructName);\r
1414 functionDeclarations.append(" (\r\n");\r
1415 functionDeclarations.append(" IN EFI_FFS_FILE_HEADER *FfsHeader,\r\n");\r
1416 functionDeclarations.append(" IN EFI_PEI_SERVICES **PeiServices\r\n");\r
1417 functionDeclarations.append(" );\r\n");\r
f9081b64 1418 break;\r
1419\r
1420 case CommonDefinition.ModuleTypeDxeCore:\r
1421 case CommonDefinition.ModuleTypeDxeDriver:\r
1422 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1423 case CommonDefinition.ModuleTypeDxeSmmDriver:\r
1424 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1425 case CommonDefinition.ModuleTypeUefiDriver:\r
1426 case CommonDefinition.ModuleTypeUefiApplication:\r
aacce761 1427 functionDeclarations.append("EFI_STATUS\r\n");\r
1428 functionDeclarations.append("EFIAPI\r\n");\r
1429 functionDeclarations.append(libConstructName);\r
1430 functionDeclarations.append(" (\r\n");\r
1431 functionDeclarations.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1432 functionDeclarations.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
1433 functionDeclarations.append(" );\r\n");\r
f9081b64 1434 break;\r
1435\r
1436 }\r
1437 }\r
1438 }\r
1439\r
1440 /**\r
1441 LibDestructorToAutogenH\r
1442 \r
1443 This function writes library destructor declarations AutoGen.h. The library\r
1444 destructor's parameter and return value depend on module type.\r
1445 \r
1446 @param libInstanceList\r
1447 List of library destructor name.\r
1448 @param moduleType\r
1449 Module type.\r
1450 @param fileBuffer\r
1451 String buffer for AutoGen.c\r
1452 @throws Exception\r
1453 **/\r
aacce761 1454 void LibDestructorToAutogenH(String moduleType) throws EdkException {\r
f9081b64 1455 boolean isFirst = true;\r
1456 String libDestructName = saq.getLibDestructorName();\r
1457 if (libDestructName == null) {\r
1458 return;\r
1459 }\r
1460\r
1461 if (moduleType.equalsIgnoreCase(EdkDefinitions.MODULE_TYPE_BASE)) {\r
aacce761 1462 functionDeclarations.append("RETURN_STATUS\r\n");\r
1463 functionDeclarations.append("EFIAPI\r\n");\r
1464 functionDeclarations.append(libDestructName);\r
1465 functionDeclarations.append(" (\r\n");\r
1466 functionDeclarations.append(" VOID\r\n");\r
1467 functionDeclarations.append(" );\r\n");\r
f9081b64 1468 } else {\r
1469 switch (CommonDefinition.getModuleType(moduleType)) {\r
1470 case CommonDefinition.ModuleTypeBase:\r
aacce761 1471 functionDeclarations.append("RETURN_STATUS\r\n");\r
1472 functionDeclarations.append("EFIAPI\r\n");\r
1473 functionDeclarations.append(libDestructName);\r
1474 functionDeclarations.append(" (\r\n");\r
1475 functionDeclarations.append(" VOID\r\n");\r
1476 functionDeclarations.append(" );\r\n");\r
f9081b64 1477 break;\r
1478 case CommonDefinition.ModuleTypePeiCore:\r
1479 case CommonDefinition.ModuleTypePeim:\r
aacce761 1480 functionDeclarations.append("EFI_STATUS\r\n");\r
1481 functionDeclarations.append("EFIAPI\r\n");\r
1482 functionDeclarations.append(libDestructName);\r
1483 functionDeclarations.append(" (\r\n");\r
1484 functionDeclarations.append(" IN EFI_FFS_FILE_HEADER *FfsHeader,\r\n");\r
1485 functionDeclarations.append(" IN EFI_PEI_SERVICES **PeiServices\r\n");\r
1486 functionDeclarations.append(" );\r\n");\r
f9081b64 1487 break;\r
1488 case CommonDefinition.ModuleTypeDxeCore:\r
1489 case CommonDefinition.ModuleTypeDxeDriver:\r
1490 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1491 case CommonDefinition.ModuleTypeDxeSmmDriver:\r
1492 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1493 case CommonDefinition.ModuleTypeUefiDriver:\r
1494 case CommonDefinition.ModuleTypeUefiApplication:\r
aacce761 1495 functionDeclarations.append("EFI_STATUS\r\n");\r
1496 functionDeclarations.append("EFIAPI\r\n");\r
1497 functionDeclarations.append(libDestructName);\r
1498 functionDeclarations.append(" (\r\n");\r
1499 functionDeclarations.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1500 functionDeclarations.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
1501 functionDeclarations.append(" );\r\n");\r
f9081b64 1502 break;\r
1503 }\r
1504 }\r
1505 }\r
1506\r
5f907e4a 1507 /**\r
cb4d97bd 1508 LibConstructorToAutogenc\r
1509 \r
1510 This function writes library constructor list to AutoGen.c. The library\r
1511 constructor's parameter and return value depend on module type.\r
1512 \r
1513 @param libInstanceList\r
1514 List of library construct name.\r
1515 @param moduleType\r
1516 Module type.\r
1517 @param fileBuffer\r
1518 String buffer for AutoGen.c\r
1519 @throws Exception\r
1520 **/\r
4353d8e1 1521 void LibConstructorToAutogenC(List<String[]> libInstanceList,\r
61528a1b 1522 String moduleType, StringBuffer fileBuffer) throws EdkException {\r
5f907e4a 1523 boolean isFirst = true;\r
1524\r
1525 //\r
1526 // The library constructor's parameter and return value depend on\r
1527 // module type.\r
1528 //\r
1529 for (int i = 0; i < libInstanceList.size(); i++) {\r
a387de3b 1530 if (libInstanceList.get(i)[1].equalsIgnoreCase(EdkDefinitions.MODULE_TYPE_BASE)) {\r
aacce761 1531 functionDeclarations.append("RETURN_STATUS\r\n");\r
1532 functionDeclarations.append("EFIAPI\r\n");\r
1533 functionDeclarations.append(libInstanceList.get(i)[0]);\r
1534 functionDeclarations.append(" (\r\n");\r
1535 functionDeclarations.append(" VOID\r\n");\r
1536 functionDeclarations.append(" );\r\n");\r
a387de3b 1537 } else {\r
1538 switch (CommonDefinition.getModuleType(moduleType)) {\r
4353d8e1 1539 case CommonDefinition.ModuleTypeBase:\r
aacce761 1540 functionDeclarations.append("RETURN_STATUS\r\n");\r
1541 functionDeclarations.append("EFIAPI\r\n");\r
1542 functionDeclarations.append(libInstanceList.get(i)[0]);\r
1543 functionDeclarations.append(" (\r\n");\r
1544 functionDeclarations.append(" VOID\r\n");\r
1545 functionDeclarations.append(" );\r\n");\r
4353d8e1 1546 break;\r
1547\r
1548 case CommonDefinition.ModuleTypePeiCore:\r
1549 case CommonDefinition.ModuleTypePeim:\r
aacce761 1550 functionDeclarations.append("EFI_STATUS\r\n");\r
1551 functionDeclarations.append("EFIAPI\r\n");\r
1552 functionDeclarations.append(libInstanceList.get(i)[0]);\r
1553 functionDeclarations.append(" (\r\n");\r
1554 functionDeclarations.append(" IN EFI_FFS_FILE_HEADER *FfsHeader,\r\n");\r
1555 functionDeclarations.append(" IN EFI_PEI_SERVICES **PeiServices\r\n");\r
1556 functionDeclarations.append(" );\r\n");\r
a387de3b 1557 break;\r
1558\r
1559 case CommonDefinition.ModuleTypeDxeCore:\r
1560 case CommonDefinition.ModuleTypeDxeDriver:\r
1561 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1562 case CommonDefinition.ModuleTypeDxeSmmDriver:\r
1563 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1564 case CommonDefinition.ModuleTypeUefiDriver:\r
1565 case CommonDefinition.ModuleTypeUefiApplication:\r
aacce761 1566 functionDeclarations.append("EFI_STATUS\r\n");\r
1567 functionDeclarations.append("EFIAPI\r\n");\r
1568 functionDeclarations.append(libInstanceList.get(i)[0]);\r
1569 functionDeclarations.append(" (\r\n");\r
1570 functionDeclarations.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1571 functionDeclarations.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
1572 functionDeclarations.append(" );\r\n");\r
a387de3b 1573 break;\r
1574\r
1575 }\r
5f907e4a 1576 }\r
1577 }\r
1578\r
1579 //\r
1580 // Add ProcessLibraryConstructorList in AutoGen.c\r
1581 //\r
aacce761 1582 fileBuffer.append("VOID\r\n");\r
1583 fileBuffer.append("EFIAPI\r\n");\r
1584 fileBuffer.append("ProcessLibraryConstructorList (\r\n");\r
5f907e4a 1585 switch (CommonDefinition.getModuleType(moduleType)) {\r
1586 case CommonDefinition.ModuleTypeBase:\r
aacce761 1587 fileBuffer.append(" VOID\r\n");\r
5f907e4a 1588 break;\r
1589\r
1590 case CommonDefinition.ModuleTypePeiCore:\r
1591 case CommonDefinition.ModuleTypePeim:\r
aacce761 1592 fileBuffer.append(" IN EFI_FFS_FILE_HEADER *FfsHeader,\r\n");\r
a30ae9fa 1593 fileBuffer.append(" IN EFI_PEI_SERVICES **PeiServices\r\n");\r
5f907e4a 1594 break;\r
1595\r
1596 case CommonDefinition.ModuleTypeDxeCore:\r
1597 case CommonDefinition.ModuleTypeDxeDriver:\r
1598 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1599 case CommonDefinition.ModuleTypeDxeSmmDriver:\r
1600 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1601 case CommonDefinition.ModuleTypeUefiDriver:\r
1602 case CommonDefinition.ModuleTypeUefiApplication:\r
aacce761 1603 fileBuffer.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1604 fileBuffer.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
5f907e4a 1605 break;\r
1606 }\r
1607\r
aacce761 1608 fileBuffer.append(" )\r\n");\r
1609 fileBuffer.append("{\r\n");\r
136adffc 1610 //\r
1611 // If no constructor function, return EFI_SUCCESS.\r
1612 //\r
5f907e4a 1613 for (int i = 0; i < libInstanceList.size(); i++) {\r
1614 if (isFirst) {\r
aacce761 1615 fileBuffer.append(" EFI_STATUS Status;\r\n");\r
1616 fileBuffer.append(" Status = EFI_SUCCESS;\r\n");\r
1617 fileBuffer.append("\r\n");\r
5f907e4a 1618 isFirst = false;\r
1619 }\r
a387de3b 1620 if (libInstanceList.get(i)[1].equalsIgnoreCase(EdkDefinitions.MODULE_TYPE_BASE)) {\r
5f907e4a 1621 fileBuffer.append(" Status = ");\r
4353d8e1 1622 fileBuffer.append(libInstanceList.get(i)[0]);\r
aacce761 1623 fileBuffer.append("();\r\n");\r
a387de3b 1624 } else {\r
1625 switch (CommonDefinition.getModuleType(moduleType)) {\r
1626 case CommonDefinition.ModuleTypeBase:\r
1627 fileBuffer.append(" Status = ");\r
1628 fileBuffer.append(libInstanceList.get(i)[0]);\r
aacce761 1629 fileBuffer.append("();\r\n");\r
a387de3b 1630 break;\r
1631 case CommonDefinition.ModuleTypePeiCore:\r
1632 case CommonDefinition.ModuleTypePeim:\r
1633 fileBuffer.append(" Status = ");\r
1634 fileBuffer.append(libInstanceList.get(i)[0]);\r
aacce761 1635 fileBuffer.append(" (FfsHeader, PeiServices);\r\n");\r
a387de3b 1636 break;\r
1637 case CommonDefinition.ModuleTypeDxeCore:\r
1638 case CommonDefinition.ModuleTypeDxeDriver:\r
1639 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1640 case CommonDefinition.ModuleTypeDxeSmmDriver:\r
1641 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1642 case CommonDefinition.ModuleTypeUefiDriver:\r
1643 case CommonDefinition.ModuleTypeUefiApplication:\r
1644 fileBuffer.append(" Status = ");\r
1645 fileBuffer.append(libInstanceList.get(i)[0]);\r
aacce761 1646 fileBuffer.append(" (ImageHandle, SystemTable);\r\n");\r
a387de3b 1647 break;\r
1648 default:\r
1649 EdkLog.log(EdkLog.EDK_INFO,"Autogen doesn't know how to deal with module type - " + moduleType + "!");\r
1650 }\r
1651\r
5f907e4a 1652 }\r
aacce761 1653 fileBuffer.append(" ASSERT_EFI_ERROR (Status);\r\n");\r
5f907e4a 1654 }\r
aacce761 1655 fileBuffer.append("}\r\n");\r
5f907e4a 1656 }\r
1657\r
1658 /**\r
cb4d97bd 1659 LibDestructorToAutogenc\r
1660 \r
1661 This function writes library destructor list to AutoGen.c. The library\r
1662 destructor's parameter and return value depend on module type.\r
1663 \r
1664 @param libInstanceList\r
1665 List of library destructor name.\r
1666 @param moduleType\r
1667 Module type.\r
1668 @param fileBuffer\r
1669 String buffer for AutoGen.c\r
1670 @throws Exception\r
1671 **/\r
4353d8e1 1672 void LibDestructorToAutogenC(List<String[]> libInstanceList,\r
61528a1b 1673 String moduleType, StringBuffer fileBuffer) throws EdkException {\r
5f907e4a 1674 boolean isFirst = true;\r
1675 for (int i = 0; i < libInstanceList.size(); i++) {\r
a387de3b 1676 if (libInstanceList.get(i)[1].equalsIgnoreCase(EdkDefinitions.MODULE_TYPE_BASE)) {\r
aacce761 1677 functionDeclarations.append("RETURN_STATUS\r\n");\r
1678 functionDeclarations.append("EFIAPI\r\n");\r
1679 functionDeclarations.append(libInstanceList.get(i)[0]);\r
1680 functionDeclarations.append(" (\r\n");\r
1681 functionDeclarations.append(" VOID\r\n");\r
1682 functionDeclarations.append(" );\r\n");\r
a387de3b 1683 } else {\r
1684 switch (CommonDefinition.getModuleType(moduleType)) {\r
1685 case CommonDefinition.ModuleTypeBase:\r
aacce761 1686 functionDeclarations.append("RETURN_STATUS\r\n");\r
1687 functionDeclarations.append("EFIAPI\r\n");\r
1688 functionDeclarations.append(libInstanceList.get(i)[0]);\r
1689 functionDeclarations.append(" (\r\n");\r
1690 functionDeclarations.append(" VOID\r\n");\r
1691 functionDeclarations.append(" );\r\n");\r
a387de3b 1692 break;\r
1693 case CommonDefinition.ModuleTypePeiCore:\r
1694 case CommonDefinition.ModuleTypePeim:\r
aacce761 1695 functionDeclarations.append("EFI_STATUS\r\n");\r
1696 functionDeclarations.append("EFIAPI\r\n");\r
1697 functionDeclarations.append(libInstanceList.get(i)[0]);\r
1698 functionDeclarations.append(" (\r\n");\r
1699 functionDeclarations.append(" IN EFI_FFS_FILE_HEADER *FfsHeader,\r\n");\r
1700 functionDeclarations.append(" IN EFI_PEI_SERVICES **PeiServices\r\n");\r
1701 functionDeclarations.append(" );\r\n");\r
a387de3b 1702 break;\r
1703 case CommonDefinition.ModuleTypeDxeCore:\r
1704 case CommonDefinition.ModuleTypeDxeDriver:\r
1705 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1706 case CommonDefinition.ModuleTypeDxeSmmDriver:\r
1707 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1708 case CommonDefinition.ModuleTypeUefiDriver:\r
1709 case CommonDefinition.ModuleTypeUefiApplication:\r
aacce761 1710 functionDeclarations.append("EFI_STATUS\r\n");\r
1711 functionDeclarations.append("EFIAPI\r\n");\r
1712 functionDeclarations.append(libInstanceList.get(i)[0]);\r
1713 functionDeclarations.append(" (\r\n");\r
1714 functionDeclarations.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1715 functionDeclarations.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
1716 functionDeclarations.append(" );\r\n");\r
a387de3b 1717 break;\r
1718 }\r
5f907e4a 1719 }\r
1720 }\r
1721\r
1722 //\r
1723 // Write ProcessLibraryDestructor list to autogen.c\r
1724 //\r
1725 switch (CommonDefinition.getModuleType(moduleType)) {\r
1726 case CommonDefinition.ModuleTypeBase:\r
1727 case CommonDefinition.ModuleTypePeiCore:\r
1728 case CommonDefinition.ModuleTypePeim:\r
1729 break;\r
1730 case CommonDefinition.ModuleTypeDxeCore:\r
1731 case CommonDefinition.ModuleTypeDxeDriver:\r
1732 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1733 case CommonDefinition.ModuleTypeDxeSmmDriver:\r
1734 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1735 case CommonDefinition.ModuleTypeUefiDriver:\r
1736 case CommonDefinition.ModuleTypeUefiApplication:\r
aacce761 1737 fileBuffer.append("VOID\r\n");\r
1738 fileBuffer.append("EFIAPI\r\n");\r
1739 fileBuffer.append("ProcessLibraryDestructorList (\r\n");\r
1740 fileBuffer.append(" IN EFI_HANDLE ImageHandle,\r\n");\r
1741 fileBuffer.append(" IN EFI_SYSTEM_TABLE *SystemTable\r\n");\r
1742 fileBuffer.append(" )\r\n");\r
1743 fileBuffer.append("{\r\n");\r
878ddf1f 1744 //\r
136adffc 1745 // If no library destructor function, return EFI_SUCCESS.\r
878ddf1f 1746 //\r
ff225cbb 1747\r
5f907e4a 1748 for (int i = 0; i < libInstanceList.size(); i++) {\r
1749 if (isFirst) {\r
aacce761 1750 fileBuffer.append(" EFI_STATUS Status;\r\n");\r
1751 fileBuffer.append(" Status = EFI_SUCCESS;\r\n");\r
1752 fileBuffer.append("\r\n");\r
5f907e4a 1753 isFirst = false;\r
1754 }\r
a387de3b 1755 if (libInstanceList.get(i)[1].equalsIgnoreCase(EdkDefinitions.MODULE_TYPE_BASE)) {\r
4353d8e1 1756 fileBuffer.append(" Status = ");\r
1757 fileBuffer.append(libInstanceList.get(i)[0]);\r
aacce761 1758 fileBuffer.append("();\r\n");\r
1759 fileBuffer.append(" VOID\r\n");\r
a387de3b 1760 } else {\r
1761 fileBuffer.append(" Status = ");\r
1762 fileBuffer.append(libInstanceList.get(i)[0]);\r
aacce761 1763 fileBuffer.append("(ImageHandle, SystemTable);\r\n");\r
1764 fileBuffer.append(" ASSERT_EFI_ERROR (Status);\r\n");\r
a387de3b 1765 }\r
5f907e4a 1766 }\r
aacce761 1767 fileBuffer.append("}\r\n");\r
5f907e4a 1768 break;\r
1769 }\r
1770 }\r
1771\r
1772 /**\r
cb4d97bd 1773 ExternsDriverBindingToAutoGenC\r
1774 \r
1775 This function is to write DRIVER_BINDING, COMPONENT_NAME,\r
1776 DRIVER_CONFIGURATION, DRIVER_DIAGNOSTIC in AutoGen.c.\r
1777 \r
1778 @param fileBuffer\r
1779 String buffer for AutoGen.c\r
1780 **/\r
5f907e4a 1781 void ExternsDriverBindingToAutoGenC(StringBuffer fileBuffer)\r
61528a1b 1782 throws EdkException {\r
5f907e4a 1783 //\r
d8f1335e 1784 // Get the arry of extern. The driverBindingGroup is a 2 dimension array.\r
e425f073 1785 // The second dimension is include following element: DriverBinding, \r
1786 // ComponentName, DriverConfiguration, DriverDiag;\r
1787 // \r
d8f1335e 1788 String[][] driverBindingGroup = this.saq.getExternProtocolGroup();\r
5f907e4a 1789\r
e87022aa 1790\r
a387de3b 1791 //\r
1792 // inital BitMask;\r
1793 // \r
1794 int BitMask = 0;\r
5f907e4a 1795\r
1796 //\r
1797 // Write driver binding protocol extern to autogen.c\r
1798 //\r
d8f1335e 1799 for (int i = 0; i < driverBindingGroup.length; i++) {\r
e425f073 1800 if (driverBindingGroup[i][0] != null) {\r
2c9b03f2 1801 globalDeclarations.append("extern EFI_DRIVER_BINDING_PROTOCOL ");\r
1802 globalDeclarations.append(driverBindingGroup[i][0]);\r
1803 globalDeclarations.append(";\r\n");\r
a387de3b 1804 }\r
5f907e4a 1805 }\r
1806\r
1807 //\r
1808 // Write component name protocol extern to autogen.c\r
1809 //\r
e425f073 1810 if (!componentNamePcd) {\r
1811 for (int i = 0; i < driverBindingGroup.length; i++) {\r
1812 if (driverBindingGroup[i][1]!= null) {\r
1813 if (driverBindingGroup[i][0] != null) {\r
1814 BitMask |= 0x01;\r
2c9b03f2 1815 globalDeclarations.append("extern EFI_COMPONENT_NAME_PROTOCOL ");\r
1816 globalDeclarations.append(driverBindingGroup[i][1]);\r
1817 globalDeclarations.append(";\r\n");\r
e425f073 1818 } else {\r
e87022aa 1819 throw new AutoGenException("DriverBinding can't be empty!!");\r
e425f073 1820 }\r
a387de3b 1821 }\r
1822 }\r
1823 }\r
1824\r
5f907e4a 1825 //\r
1826 // Write driver configration protocol extern to autogen.c\r
1827 //\r
e425f073 1828 for (int i = 0; i < driverBindingGroup.length; i++) {\r
1829 if (driverBindingGroup[i][2] != null) {\r
1830 if (driverBindingGroup[i][0] != null) {\r
d8f1335e 1831 BitMask |= 0x02;\r
2c9b03f2 1832 globalDeclarations.append("extern EFI_DRIVER_CONFIGURATION_PROTOCOL ");\r
1833 globalDeclarations.append(driverBindingGroup[i][2]);\r
1834 globalDeclarations.append(";\r\n");\r
e425f073 1835 } else {\r
d8f1335e 1836 throw new AutoGenException("DriverBinding can't be empty!!");\r
e425f073 1837 }\r
1838 }\r
1839 }\r
a387de3b 1840\r
5f907e4a 1841 //\r
1842 // Write driver dignastic protocol extern to autogen.c\r
1843 //\r
e425f073 1844 if (!driverDiagnostPcd) {\r
1845 for (int i = 0; i < driverBindingGroup.length; i++) {\r
1846 if (driverBindingGroup[i][3] != null) {\r
1847 if (driverBindingGroup[i][0] != null) {\r
e87022aa 1848 BitMask |= 0x04;\r
2c9b03f2 1849 globalDeclarations.append("extern EFI_DRIVER_DIAGNOSTICS_PROTOCOL ");\r
1850 globalDeclarations.append(driverBindingGroup[i][3]);\r
1851 globalDeclarations.append(";\r\n");\r
e425f073 1852 } else {\r
e87022aa 1853 throw new AutoGenException("DriverBinding can't be empty!!");\r
e425f073 1854 }\r
1855 }\r
1856 }\r
1857 }\r
a387de3b 1858\r
1859\r
5f907e4a 1860 //\r
1861 // Write driver module protocol bitmask.\r
1862 //\r
a387de3b 1863 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverModelProtocolBitmask = ");\r
5f907e4a 1864 fileBuffer.append(Integer.toString(BitMask));\r
aacce761 1865 fileBuffer.append(";\r\n");\r
5f907e4a 1866\r
1867 //\r
1868 // Write driver module protocol list entry\r
1869 //\r
a387de3b 1870 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const UINTN _gDriverModelProtocolListEntries = ");\r
5f907e4a 1871\r
d8f1335e 1872 fileBuffer.append(Integer.toString(driverBindingGroup.length));\r
aacce761 1873 fileBuffer.append(";\r\n");\r
5f907e4a 1874\r
1875 //\r
1876 // Write drive module protocol list to autogen.c\r
1877 //\r
e425f073 1878 if (driverBindingGroup.length > 0) {\r
a387de3b 1879 fileBuffer.append("GLOBAL_REMOVE_IF_UNREFERENCED const EFI_DRIVER_MODEL_PROTOCOL_LIST _gDriverModelProtocolList[] = {");\r
1880 }\r
1881\r
1882\r
d8f1335e 1883 for (int i = 0; i < driverBindingGroup.length; i++) {\r
5f907e4a 1884 if (i != 0) {\r
1885 fileBuffer.append(",");\r
1886 }\r
e425f073 1887 //\r
1888 // DriverBinding\r
1889 // \r
aacce761 1890 fileBuffer.append("\r\n {\r\n");\r
5f907e4a 1891 fileBuffer.append(" &");\r
d8f1335e 1892 fileBuffer.append(driverBindingGroup[i][0]);\r
aacce761 1893 fileBuffer.append(", \r\n");\r
a387de3b 1894\r
e87022aa 1895 //\r
e425f073 1896 // ComponentName\r
1897 // \r
1898 if (driverBindingGroup[i][1] != null && componentNamePcd != true) {\r
5f907e4a 1899 fileBuffer.append(" &");\r
d8f1335e 1900 fileBuffer.append(driverBindingGroup[i][1]);\r
aacce761 1901 fileBuffer.append(", \r\n");\r
5f907e4a 1902 } else {\r
aacce761 1903 fileBuffer.append(" NULL, \r\n");\r
5f907e4a 1904 }\r
1905\r
e425f073 1906 //\r
1907 // DriverConfiguration\r
1908 // \r
d8f1335e 1909 if (driverBindingGroup[i][2] != null) {\r
5f907e4a 1910 fileBuffer.append(" &");\r
d8f1335e 1911 fileBuffer.append(driverBindingGroup[i][2]);\r
aacce761 1912 fileBuffer.append(", \r\n");\r
5f907e4a 1913 } else {\r
aacce761 1914 fileBuffer.append(" NULL, \r\n");\r
5f907e4a 1915 }\r
1916\r
e425f073 1917 //\r
1918 // DriverDiagnostic\r
1919 // \r
1920 if (driverBindingGroup[i][3] != null && driverDiagnostPcd != true) {\r
5f907e4a 1921 fileBuffer.append(" &");\r
d8f1335e 1922 fileBuffer.append(driverBindingGroup[i][3]);\r
aacce761 1923 fileBuffer.append(", \r\n");\r
5f907e4a 1924 } else {\r
aacce761 1925 fileBuffer.append(" NULL, \r\n");\r
5f907e4a 1926 }\r
1927 fileBuffer.append(" }");\r
1928 }\r
d8f1335e 1929\r
e425f073 1930 if (driverBindingGroup.length > 0) {\r
aacce761 1931 fileBuffer.append("\r\n};\r\n");\r
1932 }\r
1933 }\r
1934\r
1935 /**\r
1936 ExternCallBackToAutoGenC\r
1937 \r
1938 This function adds <SetVirtualAddressMapCallBack> and\r
1939 <ExitBootServicesCallBack> infomation to AutoGen.c\r
1940 \r
1941 @param fileBuffer\r
1942 String buffer for AutoGen.c\r
1943 @throws BuildException\r
1944 **/\r
1945 void ExternCallBackToAutoGenH(String moduleType)\r
1946 throws EdkException {\r
1947 //\r
1948 // Collect module's <SetVirtualAddressMapCallBack> and\r
1949 // <ExitBootServiceCallBack> and add to setVirtualAddList\r
1950 // exitBootServiceList.\r
1951 //\r
1952 String[] setVirtuals = saq.getSetVirtualAddressMapCallBackArray();\r
1953 String[] exitBoots = saq.getExitBootServicesCallBackArray();\r
1954 //\r
1955 // Add c code in autogen.c which relate to <SetVirtualAddressMapCallBack>\r
1956 // and <ExitBootServicesCallBack>\r
1957 //\r
1958 switch (CommonDefinition.getModuleType(moduleType)) {\r
1959 case CommonDefinition.ModuleTypeDxeDriver:\r
1960 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
1961 case CommonDefinition.ModuleTypeDxeSalDriver:\r
1962 case CommonDefinition.ModuleTypeUefiDriver:\r
1963 case CommonDefinition.ModuleTypeUefiApplication:\r
1964 //\r
1965 // Write SetVirtualAddressMap function definition.\r
1966 //\r
1967 for (int i = 0; setVirtuals != null && i < setVirtuals.length; i++) {\r
1968 if (setVirtuals[i].equalsIgnoreCase("")) {\r
1969 continue;\r
1970 }\r
1971 functionDeclarations.append("VOID\r\n");\r
1972 functionDeclarations.append("EFIAPI\r\n");\r
1973 functionDeclarations.append(setVirtuals[i]);\r
1974 functionDeclarations.append(" (\r\n");\r
1975 functionDeclarations.append(" IN EFI_EVENT Event,\r\n");\r
1976 functionDeclarations.append(" IN VOID *Context\r\n");\r
1977 functionDeclarations.append(" );\r\n\r\n");\r
1978 }\r
1979\r
1980 //\r
1981 // Write DriverExitBootServices function definition.\r
1982 //\r
1983 for (int i = 0; exitBoots != null && i < exitBoots.length; i++) {\r
1984 if (exitBoots[i].equalsIgnoreCase("")) {\r
1985 continue;\r
1986 }\r
1987\r
1988 functionDeclarations.append("VOID\r\n");\r
1989 functionDeclarations.append("EFIAPI\r\n");\r
1990 functionDeclarations.append(exitBoots[i]);\r
1991 functionDeclarations.append(" (\r\n");\r
1992 functionDeclarations.append(" IN EFI_EVENT Event,\r\n");\r
1993 functionDeclarations.append(" IN VOID *Context\r\n");\r
1994 functionDeclarations.append(" );\r\n\r\n");\r
1995 }\r
1996 break;\r
1997 default:\r
1998 break;\r
e425f073 1999 }\r
5f907e4a 2000 }\r
2001\r
2002 /**\r
cb4d97bd 2003 ExternCallBackToAutoGenC\r
2004 \r
2005 This function adds <SetVirtualAddressMapCallBack> and\r
2006 <ExitBootServicesCallBack> infomation to AutoGen.c\r
2007 \r
2008 @param fileBuffer\r
2009 String buffer for AutoGen.c\r
2010 @throws BuildException\r
2011 **/\r
5f907e4a 2012 void ExternCallBackToAutoGenC(StringBuffer fileBuffer)\r
61528a1b 2013 throws EdkException {\r
5f907e4a 2014 //\r
2015 // Collect module's <SetVirtualAddressMapCallBack> and\r
2016 // <ExitBootServiceCallBack> and add to setVirtualAddList\r
2017 // exitBootServiceList.\r
2018 //\r
83fba802 2019 String[] setVirtuals = saq.getSetVirtualAddressMapCallBackArray();\r
2020 String[] exitBoots = saq.getExitBootServicesCallBackArray();\r
a2733a33 2021 if (setVirtuals != null) {\r
2022 for (int j = 0; j < setVirtuals.length; j++) {\r
5f907e4a 2023 this.setVirtalAddList.add(setVirtuals[j]);\r
2024 }\r
2025 }\r
2026 if (exitBoots != null) {\r
2027 for (int k = 0; k < exitBoots.length; k++) {\r
2028 this.exitBootServiceList.add(exitBoots[k]);\r
2029 }\r
2030 }\r
2031 //\r
2032 // Add c code in autogen.c which relate to <SetVirtualAddressMapCallBack>\r
2033 // and <ExitBootServicesCallBack>\r
2034 //\r
2035 String moduleType = this.moduleId.getModuleType();\r
5f907e4a 2036 switch (CommonDefinition.getModuleType(moduleType)) {\r
2037 case CommonDefinition.ModuleTypeDxeDriver:\r
2038 case CommonDefinition.ModuleTypeDxeRuntimeDriver:\r
2039 case CommonDefinition.ModuleTypeDxeSalDriver:\r
2040 case CommonDefinition.ModuleTypeUefiDriver:\r
e425f073 2041 case CommonDefinition.ModuleTypeUefiApplication:\r
2042 //\r
2043 // If moduleType is one of above, call setVirtualAddressToAutogenC,\r
2044 // and setExitBootServiceToAutogenC.\r
2045 // \r
c60019f6 2046 setVirtualAddressToAutogenC(fileBuffer);\r
e425f073 2047 setExitBootServiceToAutogenC(fileBuffer);\r
5f907e4a 2048 break;\r
2049 default:\r
2050 break;\r
2051 }\r
5f907e4a 2052 }\r
878ddf1f 2053\r
cb4d97bd 2054 /**\r
2055 copyFlashMapHToDebugDir\r
2056 \r
2057 This function is to copy the falshmap.h to debug directory and change \r
2058 its name to TianoR8FlashMap.h\r
2059 \r
2060 @param \r
2061 @return\r
2062 **/\r
73b4e31a 2063 private void copyFlashMapHToDebugDir() throws AutoGenException{\r
ff225cbb 2064\r
cb4d97bd 2065 File inFile = new File(fvDir + File.separatorChar + CommonDefinition.FLASHMAPH);\r
73b4e31a 2066 int size = (int)inFile.length();\r
2067 byte[] buffer = new byte[size];\r
cb4d97bd 2068 File outFile = new File (this.outputPath + File.separatorChar + CommonDefinition.TIANOR8PLASHMAPH);\r
5f907e4a 2069 //\r
2070 // If TianoR8FlashMap.h existed and the flashMap.h don't change,\r
2071 // do nothing.\r
2072 //\r
31a9215c 2073 if ((!outFile.exists()) ||(inFile.lastModified() - outFile.lastModified()) >= 0) {\r
e425f073 2074 if (inFile.exists()) {\r
a387de3b 2075 try {\r
e425f073 2076 FileInputStream fis = new FileInputStream (inFile);\r
2077 fis.read(buffer);\r
2078 FileOutputStream fos = new FileOutputStream(outFile);\r
2079 fos.write(buffer);\r
2080 fis.close();\r
2081 fos.close();\r
a387de3b 2082 } catch (IOException e) {\r
61528a1b 2083 throw new AutoGenException("The file, flashMap.h can't be open!");\r
e425f073 2084 }\r
a387de3b 2085\r
e425f073 2086 } else {\r
2087 throw new AutoGenException("The file, flashMap.h doesn't exist!");\r
2088 }\r
5f907e4a 2089 }\r
73b4e31a 2090 }\r
ff225cbb 2091\r
2336382f 2092 /**\r
cb4d97bd 2093 This function first order the library instances, then collect\r
2094 library instance 's PPI, Protocol, GUID,\r
2095 SetVirtalAddressMapCallBack, ExitBootServiceCallBack, and\r
2096 Destructor, Constructor.\r
2097 \r
2098 @param\r
2099 @return \r
5f907e4a 2100 **/\r
892b0e7a 2101 private void collectLibInstanceInfo() throws EdkException{\r
5f907e4a 2102 int index;\r
2103\r
700279a9 2104 String moduleType = moduleId.getModuleType();\r
5f907e4a 2105 String libConstructName = null;\r
2106 String libDestructName = null;\r
a387de3b 2107 String libModuleType = null;\r
5f907e4a 2108 String[] setVirtuals = null;\r
2109 String[] exitBoots = null;\r
2110\r
83fba802 2111 ModuleIdentification[] libraryIdList = saq.getLibraryInstance(this.arch);\r
700279a9 2112 if (libraryIdList.length <= 0) {\r
2113 return;\r
2114 }\r
2115 //\r
2116 // Reorder library instance sequence.\r
2117 //\r
2118 AutogenLibOrder libOrder = new AutogenLibOrder(libraryIdList, this.arch);\r
2119 List<ModuleIdentification> orderList = libOrder.orderLibInstance();\r
2120 //\r
2121 // Process library instance one by one.\r
2122 //\r
2123 for (int i = 0; i < orderList.size(); i++) {\r
2124 //\r
2125 // Get library instance basename.\r
2126 //\r
2127 ModuleIdentification libInstanceId = orderList.get(i);\r
5f907e4a 2128\r
a387de3b 2129 //\r
700279a9 2130 // Get override map\r
a387de3b 2131 //\r
a387de3b 2132\r
700279a9 2133 Map<String, XmlObject> libDoc = GlobalData.getDoc(libInstanceId, this.arch);\r
2134 saq.push(libDoc);\r
2135 //\r
2136 // check if the library instance support current module\r
2137 // \r
2138 String[] libraryClassList = saq.getLibraryClasses(CommonDefinition.ALWAYSPRODUCED,\r
2139 this.arch,\r
2140 moduleType\r
2141 );\r
2142 if (libraryClassList.length <= 0) {\r
2143 throw new EdkException("Library instance " + libInstanceId.getName() \r
2144 + " doesn't support module type " + moduleType);\r
2145 }\r
2146 //\r
2147 // Get <PPis>, <Protocols>, <Guids> list of this library\r
2148 // instance.\r
2149 //\r
2150 String[] ppiList = saq.getPpiArray(this.arch);\r
2151 String[] ppiNotifyList = saq.getPpiNotifyArray(this.arch);\r
2152 String[] protocolList = saq.getProtocolArray(this.arch);\r
2153 String[] protocolNotifyList = saq.getProtocolNotifyArray(this.arch);\r
2154 String[] guidList = saq.getGuidEntryArray(this.arch);\r
2155 PackageIdentification[] pkgList = saq.getDependencePkg(this.arch);\r
a387de3b 2156\r
700279a9 2157 //\r
2158 // Add those ppi, protocol, guid in global ppi,\r
2159 // protocol, guid\r
2160 // list.\r
2161 //\r
2162 for (index = 0; index < ppiList.length; index++) {\r
2163 this.mPpiList.add(ppiList[index]);\r
2164 }\r
a387de3b 2165\r
700279a9 2166 for (index = 0; index < ppiNotifyList.length; index++) {\r
2167 this.mPpiList.add(ppiNotifyList[index]);\r
2168 }\r
a387de3b 2169\r
700279a9 2170 for (index = 0; index < protocolList.length; index++) {\r
2171 this.mProtocolList.add(protocolList[index]);\r
2172 }\r
a387de3b 2173\r
700279a9 2174 for (index = 0; index < protocolNotifyList.length; index++) {\r
2175 this.mProtocolList.add(protocolNotifyList[index]);\r
2176 }\r
a387de3b 2177\r
700279a9 2178 for (index = 0; index < guidList.length; index++) {\r
2179 this.mGuidList.add(guidList[index]);\r
2180 }\r
2181 for (index = 0; index < pkgList.length; index++) {\r
2182 if (!this.mDepPkgList.contains(pkgList[index])) {\r
2183 this.mDepPkgList.add(pkgList[index]);\r
2184 }\r
2185 }\r
2186\r
2187 //\r
2188 // If not yet parse this library instance's constructor\r
2189 // element,parse it.\r
2190 //\r
2191 libConstructName = saq.getLibConstructorName();\r
2192 libDestructName = saq.getLibDestructorName();\r
2193 libModuleType = saq.getModuleType();\r
2194\r
2195 //\r
2196 // Collect SetVirtualAddressMapCallBack and\r
2197 // ExitBootServiceCallBack.\r
2198 //\r
2199 setVirtuals = saq.getSetVirtualAddressMapCallBackArray();\r
2200 exitBoots = saq.getExitBootServicesCallBackArray();\r
2201 if (setVirtuals != null) {\r
2202 for (int j = 0; j < setVirtuals.length; j++) {\r
2203 this.setVirtalAddList.add(setVirtuals[j]);\r
2204 }\r
2205 }\r
2206 if (exitBoots != null) {\r
2207 for (int k = 0; k < exitBoots.length; k++) {\r
2208 this.exitBootServiceList.add(exitBoots[k]);\r
a387de3b 2209 }\r
2210 }\r
700279a9 2211 saq.pop();\r
2212 //\r
2213 // Add dependent library instance constructor function.\r
2214 //\r
2215 if (libConstructName != null) {\r
2216 this.libConstructList.add(new String[] {libConstructName, libModuleType});\r
2217 }\r
2218 //\r
2219 // Add dependent library instance destructor fuction.\r
2220 //\r
2221 if (libDestructName != null) {\r
2222 this.libDestructList.add(new String[] {libDestructName, libModuleType});\r
2223 }\r
a387de3b 2224 }\r
5f907e4a 2225 }\r
aacce761 2226\r
e425f073 2227 private void setVirtualAddressToAutogenC(StringBuffer fileBuffer){\r
c60019f6 2228 //\r
2229 // Entry point lib for these module types needs to know the count\r
2230 // of entryPoint.\r
2231 //\r
aacce761 2232 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED const UINTN _gDriverSetVirtualAddressMapEventCount = ");\r
a387de3b 2233\r
2234 //\r
2235 // If the list is not valid or has no entries set count to zero else\r
2236 // set count to the number of valid entries\r
2237 //\r
2238 int Count = 0;\r
2239 int i = 0;\r
2240 if (this.setVirtalAddList != null) {\r
2241 for (i = 0; i < this.setVirtalAddList.size(); i++) {\r
2242 if (this.setVirtalAddList.get(i).equalsIgnoreCase("")) {\r
2243 break;\r
2244 }\r
2245 }\r
2246 Count = i;\r
2247 }\r
2248\r
2249 fileBuffer.append(Integer.toString(Count));\r
aacce761 2250 fileBuffer.append(";\r\n\r\n");\r
a387de3b 2251 if (this.setVirtalAddList == null || this.setVirtalAddList.size() == 0) {\r
2252 //\r
2253 // No data so make a NULL list\r
2254 //\r
aacce761 2255 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[] = {\r\n");\r
2256 fileBuffer.append(" NULL\r\n");\r
2257 fileBuffer.append("};\r\n\r\n");\r
a387de3b 2258 } else {\r
2259 //\r
2260 // Write SetVirtualAddressMap function definition.\r
2261 //\r
2262 for (i = 0; i < this.setVirtalAddList.size(); i++) {\r
2263 if (this.setVirtalAddList.get(i).equalsIgnoreCase("")) {\r
2264 break;\r
2265 }\r
aacce761 2266 functionDeclarations.append("VOID\r\n");\r
2267 functionDeclarations.append("EFIAPI\r\n");\r
2268 functionDeclarations.append(this.setVirtalAddList.get(i));\r
2269 functionDeclarations.append(" (\r\n");\r
2270 functionDeclarations.append(" IN EFI_EVENT Event,\r\n");\r
2271 functionDeclarations.append(" IN VOID *Context\r\n");\r
2272 functionDeclarations.append(" );\r\n\r\n");\r
a387de3b 2273 }\r
2274\r
2275 //\r
2276 // Write SetVirtualAddressMap entry point array.\r
2277 //\r
aacce761 2278 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[] = {");\r
a387de3b 2279 for (i = 0; i < this.setVirtalAddList.size(); i++) {\r
2280 if (this.setVirtalAddList.get(i).equalsIgnoreCase("")) {\r
2281 break;\r
2282 }\r
2283\r
2284 if (i == 0) {\r
aacce761 2285 fileBuffer.append("\r\n ");\r
a387de3b 2286 } else {\r
aacce761 2287 fileBuffer.append(",\r\n ");\r
a387de3b 2288 }\r
2289\r
2290 fileBuffer.append(this.setVirtalAddList.get(i));\r
2291 }\r
2292 //\r
2293 // add the NULL at the end of _gDriverSetVirtualAddressMapEvent list.\r
2294 //\r
aacce761 2295 fileBuffer.append(",\r\n NULL");\r
2296 fileBuffer.append("\r\n};\r\n\r\n");\r
a387de3b 2297 }\r
2298 }\r
2299\r
2300\r
2301 private void setExitBootServiceToAutogenC(StringBuffer fileBuffer){\r
2302 //\r
2303 // Entry point lib for these module types needs to know the count.\r
2304 //\r
aacce761 2305 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED const UINTN _gDriverExitBootServicesEventCount = ");\r
a387de3b 2306\r
2307 //\r
2308 // If the list is not valid or has no entries set count to zero else\r
2309 // set count to the number of valid entries.\r
2310 //\r
2311 int Count = 0;\r
2312 int i = 0; \r
2313 if (this.exitBootServiceList != null) {\r
2314 for (i = 0; i < this.exitBootServiceList.size(); i++) {\r
2315 if (this.exitBootServiceList.get(i).equalsIgnoreCase("")) {\r
2316 break;\r
2317 }\r
2318 }\r
2319 Count = i;\r
2320 }\r
2321 fileBuffer.append(Integer.toString(Count));\r
aacce761 2322 fileBuffer.append(";\r\n\r\n");\r
a387de3b 2323\r
2324 if (this.exitBootServiceList == null || this.exitBootServiceList.size() == 0) {\r
2325 // \r
2326 // No data so make a NULL list.\r
2327 //\r
aacce761 2328 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[] = {\r\n");\r
2329 fileBuffer.append(" NULL\r\n");\r
2330 fileBuffer.append("};\r\n\r\n");\r
a387de3b 2331 } else {\r
2332 //\r
2333 // Write DriverExitBootServices function definition.\r
2334 //\r
2335 for (i = 0; i < this.exitBootServiceList.size(); i++) {\r
2336 if (this.exitBootServiceList.get(i).equalsIgnoreCase("")) {\r
2337 break;\r
2338 }\r
2339\r
aacce761 2340 functionDeclarations.append("VOID\r\n");\r
2341 functionDeclarations.append("EFIAPI\r\n");\r
2342 functionDeclarations.append(this.exitBootServiceList.get(i));\r
2343 functionDeclarations.append(" (\r\n");\r
2344 functionDeclarations.append(" IN EFI_EVENT Event,\r\n");\r
2345 functionDeclarations.append(" IN VOID *Context\r\n");\r
2346 functionDeclarations.append(" );\r\n\r\n");\r
a387de3b 2347 }\r
2348\r
2349 //\r
2350 // Write DriverExitBootServices entry point array.\r
2351 //\r
aacce761 2352 fileBuffer.append("\r\nGLOBAL_REMOVE_IF_UNREFERENCED const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[] = {");\r
a387de3b 2353 for (i = 0; i < this.exitBootServiceList.size(); i++) {\r
2354 if (this.exitBootServiceList.get(i).equalsIgnoreCase("")) {\r
2355 break;\r
2356 }\r
2357\r
2358 if (i == 0) {\r
aacce761 2359 fileBuffer.append("\r\n ");\r
a387de3b 2360 } else {\r
aacce761 2361 fileBuffer.append(",\r\n ");\r
a387de3b 2362 }\r
2363 fileBuffer.append(this.exitBootServiceList.get(i));\r
2364 }\r
2365\r
aacce761 2366 fileBuffer.append(",\r\n NULL");\r
2367 fileBuffer.append("\r\n};\r\n\r\n");\r
a387de3b 2368 } \r
e425f073 2369 }\r
2370 /**\r
2371 setPcdComponentName\r
2372 \r
2373 Get the Pcd Value of ComponentName to \r
2374 decide whether need to disable the componentName. \r
2375 \r
2376 **/\r
2377 public void setPcdComponentName (){\r
a387de3b 2378 String pcdValue = null;\r
2379 pcdValue = saq.getPcdValueBycName("PcdComponentNameDisable");\r
2380 if (pcdValue != null && pcdValue.equalsIgnoreCase("true")) {\r
e425f073 2381 this.componentNamePcd = true;\r
a387de3b 2382 }\r
e425f073 2383 }\r
a387de3b 2384\r
e425f073 2385 /**\r
2386 setPcdDriverDiagnostic \r
2387 \r
2388 Get the Pcd Value of DriverDiagnostic to \r
2389 decide whether need to disable DriverDiagnostic.\r
2390 \r
2391 **/\r
2392 public void setPcdDriverDiagnostic (){\r
a387de3b 2393 String pcdValue = null;\r
e425f073 2394 pcdValue = saq.getPcdValueBycName("PcdDriverDiagnosticsDisable");\r
a387de3b 2395 if (pcdValue != null && pcdValue.equalsIgnoreCase("true")) {\r
e425f073 2396 this.driverDiagnostPcd = true;\r
a387de3b 2397 }\r
e425f073 2398 } \r
a387de3b 2399\r
2336382f 2400}\r