]>
Commit | Line | Data |
---|---|---|
a15bb0d3 | 1 | /** @file\r |
2 | GenCapsuleHdrTask class.\r | |
3 | \r | |
4 | GenCapsuleHdrTask is used to call GenCapsuleHdr.exe to generate capsule.\r | |
5 | \r | |
6 | \r | |
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 | |
12 | \r | |
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 | \r | |
21 | import org.apache.tools.ant.Task;\r | |
22 | import org.apache.tools.ant.Project;\r | |
23 | import org.apache.tools.ant.BuildException;\r | |
24 | import org.apache.tools.ant.taskdefs.Execute;\r | |
25 | import org.apache.tools.ant.taskdefs.LogStreamHandler;\r | |
26 | import org.apache.tools.ant.types.Commandline;\r | |
27 | import org.tianocore.logger.EdkLog;\r | |
28 | \r | |
29 | /**\r | |
30 | GenCapsuleHdrTask class.\r | |
31 | \r | |
32 | GenCapsuleHdrTask is used to call GenCapsuleHdr.exe to generate capsule.\r | |
33 | **/\r | |
34 | public class GenCapsuleHdrTask extends Task implements EfiDefine {\r | |
35 | ///\r | |
36 | /// tool name\r | |
37 | ///\r | |
38 | private String toolName = "GenCapsuleHdr";\r | |
39 | \r | |
40 | ///\r | |
41 | /// script file\r | |
42 | ///\r | |
43 | private String scriptFile = "";\r | |
44 | \r | |
45 | ///\r | |
46 | /// output file\r | |
47 | ///\r | |
48 | private String outputFile = "";\r | |
49 | \r | |
50 | ///\r | |
51 | /// output directory, this variable is added by jave wrap\r | |
52 | ///\r | |
53 | private String outputDir = "";\r | |
54 | \r | |
55 | ///\r | |
56 | /// Verbose flag\r | |
57 | ///\r | |
58 | private String verbose = "";\r | |
59 | \r | |
60 | ///\r | |
61 | /// Dump flag\r | |
62 | ///\r | |
63 | private String dump = "";\r | |
64 | \r | |
65 | ///\r | |
66 | /// Split size\r | |
67 | ///\r | |
68 | private String size = "";\r | |
69 | \r | |
70 | ///\r | |
71 | /// capsule into one image flag\r | |
72 | ///\r | |
73 | private String joinFlag = "";\r | |
74 | \r | |
75 | ///\r | |
76 | /// capsule file\r | |
77 | ///\r | |
78 | private String capsuleFile = "";\r | |
79 | \r | |
80 | \r | |
81 | /**\r | |
82 | * execute\r | |
83 | * \r | |
84 | * GenCapsuleHdrTask execute function is to assemble tool command line & execute\r | |
85 | * tool command line\r | |
86 | * \r | |
87 | * @throws BuidException\r | |
88 | */\r | |
89 | public void execute() throws BuildException {\r | |
90 | \r | |
91 | Project project = this.getOwningTarget().getProject();\r | |
92 | //\r | |
93 | // set Logger\r | |
94 | //\r | |
95 | FrameworkLogger logger = new FrameworkLogger(project, "gencapsulehdr");\r | |
96 | EdkLog.setLogLevel(project.getProperty("env.LOGLEVEL"));\r | |
97 | EdkLog.setLogger(logger);\r | |
98 | //\r | |
99 | // absolute path of efi tools\r | |
100 | //\r | |
101 | String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r | |
102 | String command;\r | |
103 | String argument;\r | |
104 | if (path == null) {\r | |
105 | command = toolName;\r | |
106 | } else {\r | |
107 | command = path + File.separatorChar + toolName;\r | |
108 | }\r | |
109 | //\r | |
110 | // argument of tools\r | |
111 | //\r | |
112 | File file = new File(outputFile);\r | |
113 | if (!file.isAbsolute() && (!this.outputDir.equalsIgnoreCase(""))) {\r | |
114 | argument = this.verbose + this.dump + "-o " +this.outputDir\r | |
115 | + File.separatorChar + this.outputFile + " "\r | |
116 | + this.scriptFile + " " + this.size + " " + this.joinFlag + this.capsuleFile;\r | |
117 | } else {\r | |
118 | argument = this.verbose + this.dump + "-o " + this.outputFile\r | |
119 | + " " + this.scriptFile + " " + this.size + " " + this.joinFlag + this.capsuleFile;\r | |
120 | }\r | |
121 | //\r | |
122 | // return value of fwimage execution\r | |
123 | //\r | |
124 | int revl = -1;\r | |
125 | \r | |
126 | try {\r | |
127 | Commandline cmdline = new Commandline();\r | |
128 | cmdline.setExecutable(command);\r | |
129 | cmdline.createArgument().setLine(argument);\r | |
130 | \r | |
131 | LogStreamHandler streamHandler = new LogStreamHandler(this,\r | |
132 | Project.MSG_INFO, Project.MSG_WARN);\r | |
133 | Execute runner = new Execute(streamHandler, null);\r | |
134 | \r | |
135 | runner.setAntRun(project);\r | |
136 | runner.setCommandline(cmdline.getCommandline());\r | |
137 | //\r | |
138 | // Set debug log information.\r | |
139 | //\r | |
219e2247 | 140 | EdkLog.log(EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));\r |
141 | EdkLog.log(EdkLog.EDK_INFO, (new File(scriptFile)).getName());\r | |
a15bb0d3 | 142 | revl = runner.execute();\r |
143 | \r | |
144 | if (EFI_SUCCESS == revl) {\r | |
145 | //\r | |
146 | // command execution success\r | |
147 | //\r | |
219e2247 | 148 | EdkLog.log(EdkLog.EDK_VERBOSE, "GenCapsuleHdr succeeded!");\r |
a15bb0d3 | 149 | } else {\r |
150 | //\r | |
151 | // command execution fail\r | |
152 | //\r | |
219e2247 | 153 | EdkLog.log(EdkLog.EDK_ERROR, "ERROR = " + Integer.toHexString(revl));\r |
154 | throw new BuildException("GenCapsuleHdr failed!");\r | |
a15bb0d3 | 155 | }\r |
156 | } catch (Exception e) {\r | |
157 | throw new BuildException(e.getMessage());\r | |
158 | }\r | |
159 | }\r | |
160 | \r | |
161 | /**\r | |
162 | * getInputFile\r | |
163 | * \r | |
164 | * This function is to get class member "scriptFile".\r | |
165 | * \r | |
166 | * @return string of input file name.\r | |
167 | */\r | |
168 | public String getScriptFile() {\r | |
169 | return this.scriptFile;\r | |
170 | }\r | |
171 | \r | |
172 | /**\r | |
173 | * setComponentType\r | |
174 | * \r | |
175 | * This function is to set class member "inputFile".\r | |
176 | * \r | |
177 | * @param inputFile\r | |
178 | * string of input file name.\r | |
179 | */\r | |
180 | public void setScriptFile(String scriptFile) {\r | |
181 | this.scriptFile = "-script " + scriptFile;\r | |
182 | }\r | |
183 | \r | |
184 | /**\r | |
185 | * getOutputFile\r | |
186 | * \r | |
187 | * This function is to get class member "outputFile"\r | |
188 | * \r | |
189 | * @return outputFile string of output file name.\r | |
190 | */\r | |
191 | public String getOutputFile() {\r | |
192 | return outputFile;\r | |
193 | }\r | |
194 | \r | |
195 | /**\r | |
196 | * setOutputFile\r | |
197 | * \r | |
198 | * This function is to set class member "outputFile"\r | |
199 | * \r | |
200 | * @param outputFile\r | |
201 | * string of output file name.\r | |
202 | */\r | |
203 | public void setOutputFile(String outputFile) {\r | |
204 | this.outputFile = outputFile + " ";\r | |
205 | }\r | |
206 | \r | |
207 | /**\r | |
208 | * getOutputDir\r | |
209 | * \r | |
210 | * This function is to get class member "outputDir"\r | |
211 | * \r | |
212 | * @return outputDir string of output directory.\r | |
213 | */\r | |
214 | public String getOutputDir() {\r | |
215 | return outputDir;\r | |
216 | }\r | |
217 | \r | |
218 | /**\r | |
219 | * setOutputDir\r | |
220 | * \r | |
221 | * This function is to set class member "outputDir"\r | |
222 | * \r | |
223 | * @param outputDir\r | |
224 | * string of output directory.\r | |
225 | */\r | |
226 | public void setOutputDir(String outputDir) {\r | |
227 | this.outputDir = outputDir;\r | |
228 | }\r | |
229 | \r | |
230 | /**\r | |
231 | * getVerbose\r | |
232 | * \r | |
233 | * This function is to get class member "verbose"\r | |
234 | * \r | |
235 | * @return verbose the flag of verbose.\r | |
236 | */\r | |
237 | public String getVerbose() {\r | |
238 | return this.verbose;\r | |
239 | }\r | |
240 | \r | |
241 | /**\r | |
242 | * setVerbose\r | |
243 | * \r | |
244 | * This function is to set class member "verbose"\r | |
245 | * \r | |
246 | * @param verbose\r | |
247 | * True or False.\r | |
248 | */\r | |
249 | public void setVerbose(boolean verbose) {\r | |
250 | if (verbose) {\r | |
251 | this.verbose = "-v ";\r | |
252 | }\r | |
253 | }\r | |
254 | \r | |
255 | /**\r | |
256 | * getDump\r | |
257 | * \r | |
258 | * This function is to get class member "dump"\r | |
259 | * \r | |
260 | * @return verbose the flag of dump.\r | |
261 | */\r | |
262 | public String getDump() {\r | |
263 | return dump;\r | |
264 | }\r | |
265 | \r | |
266 | /**\r | |
267 | * setDump\r | |
268 | * \r | |
269 | * This function is to set class member "dump".\r | |
270 | * \r | |
271 | * @param dump\r | |
272 | * True or False.\r | |
273 | */\r | |
274 | public void setDump(boolean dump) {\r | |
275 | if (dump) {\r | |
276 | this.dump = "-dump ";\r | |
277 | }\r | |
278 | }\r | |
279 | \r | |
280 | /**\r | |
281 | * getSize\r | |
282 | * \r | |
283 | * This function is to set class member "size".\r | |
284 | * \r | |
285 | * @return size string of size value\r | |
286 | */\r | |
287 | public String getSize() {\r | |
288 | return size;\r | |
289 | }\r | |
290 | \r | |
291 | /**\r | |
292 | * setSize\r | |
293 | * \r | |
294 | * This function is to set class member "size".\r | |
295 | * \r | |
296 | * @param size string of size value.\r | |
297 | */\r | |
298 | public void setSize(String size) {\r | |
299 | this.size = "-split " + size;\r | |
300 | }\r | |
301 | \r | |
302 | /**\r | |
303 | * getCapsuleFile\r | |
304 | * \r | |
305 | * This function is to get class member "capsuleFile"\r | |
306 | * \r | |
307 | * @return capsuleFile capsule file name\r | |
308 | */\r | |
309 | public String getCapsuleFile() {\r | |
310 | return capsuleFile;\r | |
311 | }\r | |
312 | \r | |
313 | /**\r | |
314 | * setCapsuleFile\r | |
315 | * \r | |
316 | * This function is to set class member "capsuleFile"\r | |
317 | * \r | |
318 | * @param capsuleFile capsule file name\r | |
319 | */\r | |
320 | public void setCapsuleFile(String capsuleFile) {\r | |
321 | this.capsuleFile = capsuleFile;\r | |
322 | }\r | |
323 | \r | |
324 | /**\r | |
325 | * isJoinFlag\r | |
326 | * \r | |
327 | * This function is to get class member "joinFlag"\r | |
328 | * \r | |
329 | * @return joinFlag flag of if need to join split capsule images into \r | |
330 | * a single image.\r | |
331 | */\r | |
332 | public String getJoinFlag() {\r | |
333 | return joinFlag;\r | |
334 | }\r | |
335 | \r | |
336 | /**\r | |
337 | * setJoinFlag\r | |
338 | * \r | |
339 | * This function is to set class member "joinFlag"\r | |
340 | * \r | |
341 | * @param joinFlag flag of if need to join split capsule images into \r | |
342 | * a single image. \r | |
343 | */\r | |
344 | public void setJoinFlag(boolean joinFlag) {\r | |
345 | if (joinFlag){\r | |
346 | this.joinFlag = "-j "; \r | |
347 | }\r | |
348 | \r | |
349 | }\r | |
350 | }\r |