Updated PeiRebase to produce a map file of the relocations done by this tool. This...

[mirror_edk2.git] / Tools / Source / FrameworkTasks / org / tianocore / framework / tasks / EfiRomTask.java

/** @file\r
 EfiRomTask class.\r
\r
 EfiRomTask is used to call FlashMap.exe to lay out the flash.\r
 \r
 \r
 Copyright (c) 2006, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
 **/\r
package org.tianocore.framework.tasks;\r
\r
import java.io.File;\r
import java.io.InputStreamReader;\r
import java.util.ArrayList;\r
import java.util.Iterator;\r
import java.util.LinkedList;\r
import java.util.List;\r
\r
import org.apache.tools.ant.Task;\r
import org.apache.tools.ant.Project;\r
import org.apache.tools.ant.BuildException;\r
import org.tianocore.logger.EdkLog;\r
\r
/**\r
 * SecFixupTask class.\r
 * \r
 * SecFixupTask is used to call SecFixup.exe to fix up sec image.\r
 */\r
public class EfiRomTask extends Task implements EfiDefine {\r
    ///\r
    /// tool name\r
    ///\r
    private final String toolName = "EfiRom";\r
    \r
    ///\r
    /// Flash default file\r
    ///\r
    private String verbose = "";\r
\r
    ///\r
    /// Flash device\r
    ///\r
    private String venderId = "";\r
\r
    ///\r
    /// Flash device Image\r
    ///\r
    private String deviceId = "";\r
    \r
    ///\r
    /// MCI file\r
    ///\r
    private String outputFile = "";\r
    \r
    ///\r
    /// MCO file\r
    ///\r
    private List<Input> binaryFileList = new ArrayList<Input>();\r
    \r
    ///\r
    /// Efi PE32 image file\r
    ///\r
    private List<Input> pe32FileList = new ArrayList<Input>();\r
    \r
    ///\r
    /// Compress efi PE32 image file\r
    ///\r
    private List<Input> pe32ComprFileList = new ArrayList<Input>();\r
    \r
    ///\r
    /// Hex class code in the PCI data strutor header\r
    ///\r
    private String classCode = "";\r
    \r
    ///\r
    /// Hex revision in the PCI data header.\r
    ///\r
    private String revision = "";\r
    \r
    ///\r
    /// Dump the headers of an existing option rom image.\r
    ///\r
    private String dump = "";\r
    \r
    \r
    ///\r
    /// output directory\r
    ///\r
    private String outputDir = ".";\r
 \r
    \r
    ///\r
    /// command and argument list\r
    ///\r
    LinkedList<String> argList = new LinkedList<String>();\r
    /**\r
     * execute\r
     * \r
     * EfiRomTask execute function is to assemble tool command line & execute\r
     * tool command line\r
     * \r
     * @throws BuidException\r
     */\r
    public void execute() throws BuildException {\r
\r
        Project project = this.getOwningTarget().getProject();\r
        //\r
        // set Logger\r
        //\r
        FrameworkLogger logger = new FrameworkLogger(project, "efirom");\r
        EdkLog.setLogLevel(project.getProperty("env.LOGLEVEL"));\r
        EdkLog.setLogger(logger);\r
        //\r
        // absolute path of efi tools\r
        //\r
        String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");\r
        String command;\r
        if (path == null) {\r
            command = toolName;\r
        } else {\r
            command = path + File.separatorChar + toolName;\r
        }\r
        argList.addFirst(command);\r
                 \r
        //\r
        // add microcode binary files\r
        //\r
        if (this.binaryFileList.size() > 0){\r
            argList.add("-b");\r
            Iterator binList = this.binaryFileList.iterator();\r
            while (binList.hasNext()){\r
                argList.add(((Input)binList.next()).getFile());\r
            }\r
        }\r
        \r
        //\r
        // add pe32 file\r
        //\r
        if (this.pe32FileList.size() > 0){\r
            argList.add("-e");\r
            Iterator pe32List = this.pe32FileList.iterator();\r
            while (pe32List.hasNext()){\r
                argList.add(((Input)pe32List.next()).getFile());\r
            }\r
        }\r
        \r
        //\r
        // add compressed pe32 file\r
        //\r
        if (this.pe32ComprFileList.size() > 0){\r
            argList.add("-ec");\r
            Iterator pe32ComprList = this.pe32ComprFileList.iterator();\r
            while (pe32ComprList.hasNext()){\r
                argList.add(((Input)pe32ComprList.next()).getFile());\r
            }\r
        }\r
\r
        EdkLog.log(EdkLog.EDK_VERBOSE, argList.toString().replaceAll(",",""));\r
        EdkLog.log(EdkLog.EDK_INFO, " ");\r
\r
        //\r
        // lauch the program\r
        //\r
        ProcessBuilder pb = new ProcessBuilder(argList);\r
        pb.directory(new File(outputDir));\r
        int exitCode = 0;\r
        try {\r
            Process cmdProc = pb.start();\r
            InputStreamReader cmdOut = new InputStreamReader(cmdProc.getInputStream());\r
            char[] buf = new char[1024];\r
\r
            exitCode = cmdProc.waitFor();\r
            if (exitCode != 0) {\r
                int len = cmdOut.read(buf, 0, 1024);\r
                EdkLog.log(EdkLog.EDK_INFO, new String(buf, 0, len));\r
            } else {\r
                EdkLog.log(EdkLog.EDK_VERBOSE, "EfiRom succeeded!");\r
            }\r
        } catch (Exception e) {\r
            throw new BuildException(e.getMessage());\r
        } finally {\r
            if (exitCode != 0) {\r
                throw new BuildException("EfiRom failed!");\r
            }\r
        }\r
    }\r
    \r
    /**\r
     * getVerbose\r
     * \r
     * This function is to get class member "verbose"\r
     * \r
     * @return verbose   for verbose output.\r
     */\r
    public String getVerbose() {\r
        return verbose;\r
    }\r
    \r
    /**\r
     * setVerbose\r
     * \r
     * This function is to set class member "verbose"\r
     * \r
     * @param verbose    for verbose output.\r
     */\r
    public void setVerbose(boolean verbose) {\r
        if (verbose){\r
            this.verbose = "-p";\r
            argList.add(this.verbose);  \r
        }\r
    }\r
    \r
    /**\r
     * getVenderId\r
     * \r
     * This function is to get class member "venderId"\r
     * \r
     * @return venderId     String of venderId.\r
     */\r
    public String getVenderId() {\r
        return venderId;\r
    }\r
    \r
    /**\r
     * setVenderId\r
     * \r
     * This function is to set class member "venderId"\r
     * \r
     * @param venderId      String of venderId.\r
     */\r
    public void setVenderId(String VenderId) {\r
        this.venderId = VenderId;\r
        argList.add("-v");\r
        argList.add(this.venderId);\r
    }\r
    \r
    /**\r
     * getDeviceId\r
     * \r
     * This function is to get class member "deviceId"\r
     * \r
     * @return deviceId   String of device ID.\r
     */\r
    public String getDeviceId() {\r
        return this.deviceId;\r
    }\r
    \r
    /**\r
     * setDeviceId\r
     * \r
     * This function is to set class member "deviceId"\r
     * \r
     * @param deviceId   String of device ID.\r
     */\r
    public void setDeviceId(String deviceId) {\r
        this.deviceId = deviceId;\r
        argList.add("-d");\r
        argList.add(this.deviceId);\r
    }\r
\r
    \r
    /**\r
     * getOutputFile\r
     * \r
     * This function is to get class member "outputFile"\r
     * \r
     * @return outputFile     name of output directory.\r
     */\r
    public String getOutputFile() {\r
        return outputFile;\r
    }\r
    \r
    /**\r
     * setOutputFile\r
     * \r
     * This function is to set class member "dscFile"\r
     * \r
     * @param outputFile      name of DSC file\r
     */\r
    public void setOutputFile(String outputFile) {\r
        this.outputFile = outputFile;\r
        \r
    }\r
    \r
    /**\r
     * getClassCode\r
     * \r
     * This function is to get class member "classCode"\r
     * \r
     * @return fdImage       name of class code file.\r
     */\r
    public String getClassCode() {\r
        return classCode;\r
    }\r
    \r
    /**\r
     * setclassCode\r
     * \r
     * This function is to set class member "classCode"\r
     * \r
     * @param fdImage        name of class code file.\r
     */\r
    public void setclassCode(String classCode) {\r
        this.classCode = classCode;\r
        argList.add("-cc");\r
        argList.add(this.classCode);\r
    }\r
    \r
    /**\r
     * getRevision\r
     * \r
     * This function is to get class member "revision".\r
     * \r
     * @return revision     hex revision in the PDI data header.\r
     */\r
    public String getRevision() {\r
        return revision;\r
    }\r
    \r
    /**\r
     * setRevision\r
     * \r
     * This function is to set class member "revision"\r
     * \r
     * @param revision     hex revision in the PDI data header.\r
     */\r
    public void setRevision(String revision) {\r
        this.revision = revision;\r
        argList.add("-rev");\r
        argList.add(this.revision);\r
    }\r
    \r
    /**\r
     * getFlashDeviceImage\r
     * \r
     * This function is to get class member "dump"\r
     * \r
     * @return flashDeviceImage      name of flash device image\r
     */\r
    public String getDump() {\r
        return dump;\r
    }\r
    \r
    /**\r
     * setFlashDeviceImage\r
     * \r
     * This function is to set class member "dump"\r
     * \r
     * @param flashDeviceImage        name of flash device image\r
     */\r
    public void setDump(boolean dump) {\r
        if (dump){\r
            this.dump = "-dump";\r
            argList.add(this.dump);\r
        }\r
    }\r
\r
    /**\r
     * getOutputDir\r
     * \r
     * This function is to get class member "outputDir"\r
     * \r
     * @return outputDir       string of output directory \r
     */\r
    public String getOutputDir() {\r
        return outputDir;\r
    }\r
    \r
    /**\r
     * setOutputDir\r
     * \r
     * This function is to set class member "outputDir"\r
     * \r
     * @param outputDir         string of output directory\r
     */\r
    public void setOutputDir(String outputDir) {\r
        this.outputDir = outputDir;\r
    }\r
    /**\r
     * addBinaryFile\r
     * \r
     * This function is to add binary file to binaryFile list.\r
     * \r
     * @param binaryFile         name of binary file.\r
     */\r
    public void addBinaryFile(Input binaryFile){\r
        this.binaryFileList.add(binaryFile);\r
    }\r
    \r
    /**\r
     * addPe32File\r
     * \r
     * This function is to add pe32 file to pe32File list. \r
     * \r
     * @param pe32File            name of pe32 file.\r
     */\r
    public void addPe32File(Input pe32File){\r
        this.pe32FileList.add(pe32File);\r
    }\r
    \r
    /**\r
     * addPe32ComprFile\r
     * \r
     * This function os to add compressed pe32 file to pe32ComprFile list.\r
     * \r
     * @param pe32ComprFile        name of compressed pe32 file.\r
     */\r
    public void addPe32ComprFile(Input pe32ComprFile){\r
        this.pe32ComprFileList.add(pe32ComprFile);\r
    }\r
}\r