summaryrefslogtreecommitdiff
path: root/Tools/Java/Source/FrameworkTasks/org/tianocore/framework/tasks/FwImageTask.java
blob: 78d9cbeb18a6c5ffe01d911b2eb62cfdfa6a2e14 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/** @file
 FwImageTask class.

 FwImageTask is used to call FwImage.ext to generate the FwImage.


 Copyright (c) 2006, Intel Corporation
 All rights reserved. This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
 http://opensource.org/licenses/bsd-license.php

 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 **/
package org.tianocore.framework.tasks;

import java.io.File;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.Execute;
import org.apache.tools.ant.taskdefs.LogStreamHandler;
import org.apache.tools.ant.types.Commandline;

import org.tianocore.common.logger.EdkLog;

/**
  FwImageTask class.

  FwImageTask is used to call FwImage.ext to generate the FwImage.
**/
public class FwImageTask extends Task implements EfiDefine {
    //
    // fwimage tool name
    // 
    private static String toolName = "FwImage";
    //
    // time&data
    //
    private ToolArg time = new ToolArg();
    //
    // input PE image
    //
    private FileArg peImage = new FileArg();
    //
    // output EFI image
    //
    private FileArg outImage = new FileArg();
    //
    // component type
    //
    private ToolArg componentType = new ToolArg();

    /**
      execute

      FwimageTask execute function is to assemble tool command line & execute
      tool command line

      @throws BuidException
    **/
    public void execute() throws BuildException {

        Project project = this.getOwningTarget().getProject();
        //
        // absolute path of efi tools
        //
        String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");
        String command;
        if (path == null) {
            command = toolName;
        } else {
            command = path + File.separator + toolName;
        }
        //
        // argument of tools
        //
        String argument = "" + time + componentType + peImage + outImage;
        //
        // return value of fwimage execution
        //
        int revl = -1;

        try {
            Commandline cmdline = new Commandline();
            cmdline.setExecutable(command);
            cmdline.createArgument().setLine(argument);

            LogStreamHandler streamHandler = new LogStreamHandler(this,
                    Project.MSG_INFO, Project.MSG_WARN);
            Execute runner = new Execute(streamHandler, null);

            runner.setAntRun(project);
            runner.setCommandline(cmdline.getCommandline());

            EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));
            EdkLog.log(this, peImage.toFileList() + " => " + outImage.toFileList());

            revl = runner.execute();
            if (EFI_SUCCESS == revl) {
                EdkLog.log(this, EdkLog.EDK_VERBOSE, "FwImage succeeded!");
            } else {
                //
                // command execution fail
                //
                EdkLog.log(this, "ERROR = " + Integer.toHexString(revl));
                throw new BuildException("FwImage failed!");
            }
        } catch (Exception e) {
            throw new BuildException(e.getMessage());
        }
    }

    /**
      setTime

      This function is to set operation of class member "time".

      @param time            string of time
    **/
    public void setTime(String time) {
        this.time.setArg(" -t ", time);
    }

    /**
      getTime

      This function is to get class member "time"
      @return time          string of time
    **/
    public String getTime() {
        return this.time.getValue();
    }

    /**
      getPeImage

      This function is to get class member "peImage".
      @return                name of PE image
    **/
    public String getPeImage() {
        return this.peImage.getValue();
    }

    /**
      setPeImage

      This function is to set class member "peImage"
      @param  peImage        name of PE image
    **/
    public void setPeImage(String peImage) {
        this.peImage.setArg(" ", peImage);
    }

    /**
      getOutImage

      This function is to get class member "outImage".
      @return                 name of output EFI image
    **/
    public String getOutImage() {
        return this.outImage.getValue();
    }

    /**
      setOutImage

      This function is to set class member "outImage".
      @param outImage         name of output EFI image
    **/
    public void setOutImage(String outImage) {
        this.outImage.setArg(" ", outImage);
    }

    /**
      getComponentType

      This function is to get class member "componentType".

      @return                 string of componentType
    **/
    public String getComponentType() {
        return this.componentType.getValue();
    }

    /**
      setComponentType

      This function is to set class member "componentType".
      @param  componentType   string of component type
    **/
    public void setComponentType(String componentType) {
        this.componentType.setArg(" ", componentType);
    }
}