]>
Commit | Line | Data |
---|---|---|
a15bb0d3 | 1 | /** @file\r |
2 | EfiRomTask class.\r | |
3 | \r | |
4 | EfiRomTask is used to call FlashMap.exe to lay out the flash.\r | |
ff225cbb | 5 | \r |
6 | \r | |
a15bb0d3 | 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 |
a15bb0d3 | 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 | package org.tianocore.framework.tasks;\r | |
18 | \r | |
19 | import java.io.File;\r | |
20 | import java.io.InputStreamReader;\r | |
21 | import java.util.ArrayList;\r | |
22 | import java.util.Iterator;\r | |
23 | import java.util.LinkedList;\r | |
24 | import java.util.List;\r | |
25 | \r | |
26 | import org.apache.tools.ant.Task;\r | |
27 | import org.apache.tools.ant.Project;\r | |
28 | import org.apache.tools.ant.BuildException;\r | |
ff225cbb | 29 | \r |
30 | import org.tianocore.common.logger.EdkLog;\r | |
a15bb0d3 | 31 | \r |
32 | /**\r | |
33 | * SecFixupTask class.\r | |
ff225cbb | 34 | *\r |
a15bb0d3 | 35 | * SecFixupTask is used to call SecFixup.exe to fix up sec image.\r |
36 | */\r | |
37 | public class EfiRomTask extends Task implements EfiDefine {\r | |
38 | ///\r | |
39 | /// tool name\r | |
40 | ///\r | |
41 | private final String toolName = "EfiRom";\r | |
ff225cbb | 42 | \r |
a15bb0d3 | 43 | ///\r |
44 | /// Flash default file\r | |
45 | ///\r | |
46 | private String verbose = "";\r | |
47 | \r | |
48 | ///\r | |
49 | /// Flash device\r | |
50 | ///\r | |
51 | private String venderId = "";\r | |
52 | \r | |
53 | ///\r | |
54 | /// Flash device Image\r | |
55 | ///\r | |
56 | private String deviceId = "";\r | |
ff225cbb | 57 | \r |
a15bb0d3 | 58 | ///\r |
59 | /// MCI file\r | |
60 | ///\r | |
61 | private String outputFile = "";\r | |
ff225cbb | 62 | \r |
a15bb0d3 | 63 | ///\r |
64 | /// MCO file\r | |
65 | ///\r | |
66 | private List<Input> binaryFileList = new ArrayList<Input>();\r | |
ff225cbb | 67 | \r |
a15bb0d3 | 68 | ///\r |
69 | /// Efi PE32 image file\r | |
70 | ///\r | |
71 | private List<Input> pe32FileList = new ArrayList<Input>();\r | |
ff225cbb | 72 | \r |
a15bb0d3 | 73 | ///\r |
74 | /// Compress efi PE32 image file\r | |
75 | ///\r | |
76 | private List<Input> pe32ComprFileList = new ArrayList<Input>();\r | |
ff225cbb | 77 | \r |
a15bb0d3 | 78 | ///\r |
79 | /// Hex class code in the PCI data strutor header\r | |
80 | ///\r | |
81 | private String classCode = "";\r | |
ff225cbb | 82 | \r |
a15bb0d3 | 83 | ///\r |
84 | /// Hex revision in the PCI data header.\r | |
85 | ///\r | |
86 | private String revision = "";\r | |
ff225cbb | 87 | \r |
a15bb0d3 | 88 | ///\r |
89 | /// Dump the headers of an existing option rom image.\r | |
90 | ///\r | |
91 | private String dump = "";\r | |
ff225cbb | 92 | \r |
93 | \r | |
a15bb0d3 | 94 | ///\r |
95 | /// output directory\r | |
96 | ///\r | |
57cc2ee7 | 97 | private String outputDir = ".";\r |
ff225cbb | 98 | \r |
99 | \r | |
a15bb0d3 | 100 | ///\r |
101 | /// command and argument list\r | |
102 | ///\r | |
103 | LinkedList<String> argList = new LinkedList<String>();\r | |
104 | /**\r | |
105 | * execute\r | |
ff225cbb | 106 | *\r |
a15bb0d3 | 107 | * EfiRomTask execute function is to assemble tool command line & execute\r |
108 | * tool command line\r | |
ff225cbb | 109 | *\r |
a15bb0d3 | 110 | * @throws BuidException\r |
111 | */\r | |
112 | public void execute() throws BuildException {\r | |
113 | \r | |
114 | Project project = this.getOwningTarget().getProject();\r | |
115 | //\r | |
116 | // set Logger\r | |
117 | //\r | |
118 | FrameworkLogger logger = new FrameworkLogger(project, "efirom");\r | |
119 | EdkLog.setLogLevel(project.getProperty("env.LOGLEVEL"));\r | |
120 | EdkLog.setLogger(logger);\r | |
121 | //\r | |
122 | // absolute path of efi tools\r | |
123 | //\r | |
124 | String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r | |
125 | String command;\r | |
126 | if (path == null) {\r | |
127 | command = toolName;\r | |
128 | } else {\r | |
129 | command = path + File.separatorChar + toolName;\r | |
130 | }\r | |
131 | argList.addFirst(command);\r | |
ff225cbb | 132 | \r |
a15bb0d3 | 133 | //\r |
134 | // add microcode binary files\r | |
135 | //\r | |
136 | if (this.binaryFileList.size() > 0){\r | |
137 | argList.add("-b");\r | |
138 | Iterator binList = this.binaryFileList.iterator();\r | |
139 | while (binList.hasNext()){\r | |
82810f3b | 140 | argList.addAll(((Input)binList.next()).getNameList());\r |
a15bb0d3 | 141 | }\r |
142 | }\r | |
ff225cbb | 143 | \r |
a15bb0d3 | 144 | //\r |
145 | // add pe32 file\r | |
146 | //\r | |
147 | if (this.pe32FileList.size() > 0){\r | |
148 | argList.add("-e");\r | |
149 | Iterator pe32List = this.pe32FileList.iterator();\r | |
150 | while (pe32List.hasNext()){\r | |
82810f3b | 151 | argList.addAll(((Input)pe32List.next()).getNameList());\r |
a15bb0d3 | 152 | }\r |
153 | }\r | |
ff225cbb | 154 | \r |
a15bb0d3 | 155 | //\r |
156 | // add compressed pe32 file\r | |
157 | //\r | |
158 | if (this.pe32ComprFileList.size() > 0){\r | |
159 | argList.add("-ec");\r | |
160 | Iterator pe32ComprList = this.pe32ComprFileList.iterator();\r | |
161 | while (pe32ComprList.hasNext()){\r | |
82810f3b | 162 | argList.addAll(((Input)pe32ComprList.next()).getNameList());\r |
a15bb0d3 | 163 | }\r |
164 | }\r | |
219e2247 | 165 | \r |
166 | EdkLog.log(EdkLog.EDK_VERBOSE, argList.toString().replaceAll(",",""));\r | |
167 | EdkLog.log(EdkLog.EDK_INFO, " ");\r | |
168 | \r | |
a15bb0d3 | 169 | //\r |
170 | // lauch the program\r | |
171 | //\r | |
172 | ProcessBuilder pb = new ProcessBuilder(argList);\r | |
173 | pb.directory(new File(outputDir));\r | |
174 | int exitCode = 0;\r | |
175 | try {\r | |
176 | Process cmdProc = pb.start();\r | |
177 | InputStreamReader cmdOut = new InputStreamReader(cmdProc.getInputStream());\r | |
178 | char[] buf = new char[1024];\r | |
179 | \r | |
180 | exitCode = cmdProc.waitFor();\r | |
181 | if (exitCode != 0) {\r | |
182 | int len = cmdOut.read(buf, 0, 1024);\r | |
219e2247 | 183 | EdkLog.log(EdkLog.EDK_INFO, new String(buf, 0, len));\r |
a15bb0d3 | 184 | } else {\r |
219e2247 | 185 | EdkLog.log(EdkLog.EDK_VERBOSE, "EfiRom succeeded!");\r |
a15bb0d3 | 186 | }\r |
187 | } catch (Exception e) {\r | |
188 | throw new BuildException(e.getMessage());\r | |
189 | } finally {\r | |
190 | if (exitCode != 0) {\r | |
219e2247 | 191 | throw new BuildException("EfiRom failed!");\r |
a15bb0d3 | 192 | }\r |
193 | }\r | |
194 | }\r | |
ff225cbb | 195 | \r |
a15bb0d3 | 196 | /**\r |
197 | * getVerbose\r | |
ff225cbb | 198 | *\r |
a15bb0d3 | 199 | * This function is to get class member "verbose"\r |
ff225cbb | 200 | *\r |
a15bb0d3 | 201 | * @return verbose for verbose output.\r |
202 | */\r | |
203 | public String getVerbose() {\r | |
204 | return verbose;\r | |
205 | }\r | |
ff225cbb | 206 | \r |
a15bb0d3 | 207 | /**\r |
208 | * setVerbose\r | |
ff225cbb | 209 | *\r |
a15bb0d3 | 210 | * This function is to set class member "verbose"\r |
ff225cbb | 211 | *\r |
a15bb0d3 | 212 | * @param verbose for verbose output.\r |
213 | */\r | |
214 | public void setVerbose(boolean verbose) {\r | |
215 | if (verbose){\r | |
216 | this.verbose = "-p";\r | |
ff225cbb | 217 | argList.add(this.verbose);\r |
a15bb0d3 | 218 | }\r |
219 | }\r | |
ff225cbb | 220 | \r |
a15bb0d3 | 221 | /**\r |
222 | * getVenderId\r | |
ff225cbb | 223 | *\r |
a15bb0d3 | 224 | * This function is to get class member "venderId"\r |
ff225cbb | 225 | *\r |
a15bb0d3 | 226 | * @return venderId String of venderId.\r |
227 | */\r | |
228 | public String getVenderId() {\r | |
229 | return venderId;\r | |
230 | }\r | |
ff225cbb | 231 | \r |
a15bb0d3 | 232 | /**\r |
233 | * setVenderId\r | |
ff225cbb | 234 | *\r |
a15bb0d3 | 235 | * This function is to set class member "venderId"\r |
ff225cbb | 236 | *\r |
a15bb0d3 | 237 | * @param venderId String of venderId.\r |
238 | */\r | |
239 | public void setVenderId(String VenderId) {\r | |
240 | this.venderId = VenderId;\r | |
241 | argList.add("-v");\r | |
242 | argList.add(this.venderId);\r | |
243 | }\r | |
ff225cbb | 244 | \r |
a15bb0d3 | 245 | /**\r |
246 | * getDeviceId\r | |
ff225cbb | 247 | *\r |
a15bb0d3 | 248 | * This function is to get class member "deviceId"\r |
ff225cbb | 249 | *\r |
a15bb0d3 | 250 | * @return deviceId String of device ID.\r |
251 | */\r | |
252 | public String getDeviceId() {\r | |
253 | return this.deviceId;\r | |
254 | }\r | |
ff225cbb | 255 | \r |
a15bb0d3 | 256 | /**\r |
257 | * setDeviceId\r | |
ff225cbb | 258 | *\r |
a15bb0d3 | 259 | * This function is to set class member "deviceId"\r |
ff225cbb | 260 | *\r |
a15bb0d3 | 261 | * @param deviceId String of device ID.\r |
262 | */\r | |
263 | public void setDeviceId(String deviceId) {\r | |
264 | this.deviceId = deviceId;\r | |
265 | argList.add("-d");\r | |
266 | argList.add(this.deviceId);\r | |
267 | }\r | |
268 | \r | |
ff225cbb | 269 | \r |
a15bb0d3 | 270 | /**\r |
271 | * getOutputFile\r | |
ff225cbb | 272 | *\r |
a15bb0d3 | 273 | * This function is to get class member "outputFile"\r |
ff225cbb | 274 | *\r |
a15bb0d3 | 275 | * @return outputFile name of output directory.\r |
276 | */\r | |
277 | public String getOutputFile() {\r | |
278 | return outputFile;\r | |
279 | }\r | |
ff225cbb | 280 | \r |
a15bb0d3 | 281 | /**\r |
282 | * setOutputFile\r | |
ff225cbb | 283 | *\r |
a15bb0d3 | 284 | * This function is to set class member "dscFile"\r |
ff225cbb | 285 | *\r |
a15bb0d3 | 286 | * @param outputFile name of DSC file\r |
287 | */\r | |
288 | public void setOutputFile(String outputFile) {\r | |
289 | this.outputFile = outputFile;\r | |
ff225cbb | 290 | \r |
a15bb0d3 | 291 | }\r |
ff225cbb | 292 | \r |
a15bb0d3 | 293 | /**\r |
294 | * getClassCode\r | |
ff225cbb | 295 | *\r |
a15bb0d3 | 296 | * This function is to get class member "classCode"\r |
ff225cbb | 297 | *\r |
a15bb0d3 | 298 | * @return fdImage name of class code file.\r |
299 | */\r | |
300 | public String getClassCode() {\r | |
301 | return classCode;\r | |
302 | }\r | |
ff225cbb | 303 | \r |
a15bb0d3 | 304 | /**\r |
305 | * setclassCode\r | |
ff225cbb | 306 | *\r |
47f2f011 | 307 | * This function is to set class member "classCode"\r |
ff225cbb | 308 | *\r |
a15bb0d3 | 309 | * @param fdImage name of class code file.\r |
310 | */\r | |
311 | public void setclassCode(String classCode) {\r | |
312 | this.classCode = classCode;\r | |
313 | argList.add("-cc");\r | |
314 | argList.add(this.classCode);\r | |
315 | }\r | |
ff225cbb | 316 | \r |
a15bb0d3 | 317 | /**\r |
318 | * getRevision\r | |
ff225cbb | 319 | *\r |
a15bb0d3 | 320 | * This function is to get class member "revision".\r |
ff225cbb | 321 | *\r |
a15bb0d3 | 322 | * @return revision hex revision in the PDI data header.\r |
323 | */\r | |
324 | public String getRevision() {\r | |
325 | return revision;\r | |
326 | }\r | |
ff225cbb | 327 | \r |
a15bb0d3 | 328 | /**\r |
329 | * setRevision\r | |
ff225cbb | 330 | *\r |
a15bb0d3 | 331 | * This function is to set class member "revision"\r |
ff225cbb | 332 | *\r |
a15bb0d3 | 333 | * @param revision hex revision in the PDI data header.\r |
334 | */\r | |
335 | public void setRevision(String revision) {\r | |
336 | this.revision = revision;\r | |
337 | argList.add("-rev");\r | |
338 | argList.add(this.revision);\r | |
339 | }\r | |
ff225cbb | 340 | \r |
a15bb0d3 | 341 | /**\r |
342 | * getFlashDeviceImage\r | |
ff225cbb | 343 | *\r |
47f2f011 | 344 | * This function is to get class member "dump"\r |
ff225cbb | 345 | *\r |
a15bb0d3 | 346 | * @return flashDeviceImage name of flash device image\r |
347 | */\r | |
348 | public String getDump() {\r | |
349 | return dump;\r | |
350 | }\r | |
ff225cbb | 351 | \r |
a15bb0d3 | 352 | /**\r |
353 | * setFlashDeviceImage\r | |
ff225cbb | 354 | *\r |
47f2f011 | 355 | * This function is to set class member "dump"\r |
ff225cbb | 356 | *\r |
a15bb0d3 | 357 | * @param flashDeviceImage name of flash device image\r |
358 | */\r | |
359 | public void setDump(boolean dump) {\r | |
360 | if (dump){\r | |
361 | this.dump = "-dump";\r | |
362 | argList.add(this.dump);\r | |
363 | }\r | |
364 | }\r | |
365 | \r | |
366 | /**\r | |
367 | * getOutputDir\r | |
ff225cbb | 368 | *\r |
a15bb0d3 | 369 | * This function is to get class member "outputDir"\r |
ff225cbb | 370 | *\r |
371 | * @return outputDir string of output directory\r | |
a15bb0d3 | 372 | */\r |
373 | public String getOutputDir() {\r | |
374 | return outputDir;\r | |
375 | }\r | |
ff225cbb | 376 | \r |
a15bb0d3 | 377 | /**\r |
378 | * setOutputDir\r | |
ff225cbb | 379 | *\r |
a15bb0d3 | 380 | * This function is to set class member "outputDir"\r |
ff225cbb | 381 | *\r |
a15bb0d3 | 382 | * @param outputDir string of output directory\r |
383 | */\r | |
384 | public void setOutputDir(String outputDir) {\r | |
385 | this.outputDir = outputDir;\r | |
386 | }\r | |
387 | /**\r | |
388 | * addBinaryFile\r | |
ff225cbb | 389 | *\r |
a15bb0d3 | 390 | * This function is to add binary file to binaryFile list.\r |
ff225cbb | 391 | *\r |
a15bb0d3 | 392 | * @param binaryFile name of binary file.\r |
393 | */\r | |
394 | public void addBinaryFile(Input binaryFile){\r | |
395 | this.binaryFileList.add(binaryFile);\r | |
396 | }\r | |
ff225cbb | 397 | \r |
a15bb0d3 | 398 | /**\r |
399 | * addPe32File\r | |
ff225cbb | 400 | *\r |
401 | * This function is to add pe32 file to pe32File list.\r | |
402 | *\r | |
a15bb0d3 | 403 | * @param pe32File name of pe32 file.\r |
404 | */\r | |
405 | public void addPe32File(Input pe32File){\r | |
406 | this.pe32FileList.add(pe32File);\r | |
407 | }\r | |
ff225cbb | 408 | \r |
a15bb0d3 | 409 | /**\r |
410 | * addPe32ComprFile\r | |
ff225cbb | 411 | *\r |
a15bb0d3 | 412 | * This function os to add compressed pe32 file to pe32ComprFile list.\r |
ff225cbb | 413 | *\r |
a15bb0d3 | 414 | * @param pe32ComprFile name of compressed pe32 file.\r |
415 | */\r | |
416 | public void addPe32ComprFile(Input pe32ComprFile){\r | |
417 | this.pe32ComprFileList.add(pe32ComprFile);\r | |
418 | }\r | |
419 | }\r |