--- /dev/null
+/** @file\r
+ FlashMapTask class.\r
+\r
+ FlashMapTask 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 FlashMapTask extends Task implements EfiDefine {\r
+ // /\r
+ // / tool name\r
+ // /\r
+ private final String toolName = "FlashMap";\r
+\r
+ // /\r
+ // / Flash default file\r
+ // /\r
+ private String flashDefFile = "";\r
+\r
+ // /\r
+ // / Flash device\r
+ // /\r
+ private String flashDevice = "";\r
+\r
+ // /\r
+ // / Flash device Image\r
+ // /\r
+ private String flashDeviceImage = "";\r
+\r
+ // /\r
+ // / MCI file\r
+ // /\r
+ private String mciFile = "";\r
+\r
+ // /\r
+ // / MCO file\r
+ // /\r
+ private String mcoFile = "";\r
+\r
+ // /\r
+ // / Discover FD image\r
+ // /\r
+ private String fdImage = "";\r
+\r
+ // /\r
+ // / Dsc file\r
+ // /\r
+ private String dscFile = "";\r
+\r
+ // /\r
+ // / Asm INC file\r
+ // /\r
+ private String asmIncFile = "";\r
+\r
+ // /\r
+ // / Image out file\r
+ // /\r
+ private String imageOutFile = "";\r
+\r
+ // /\r
+ // / Header file\r
+ // /\r
+ private String headerFile = "";\r
+\r
+ // /\r
+ // / Input string file\r
+ // /\r
+ private String inStrFile = "";\r
+\r
+ // /\r
+ // / Output string file\r
+ // /\r
+ private String outStrFile = "";\r
+\r
+ // /\r
+ // / Base address\r
+ // /\r
+ private String baseAddr = "";\r
+\r
+ // /\r
+ // / Aligment\r
+ // /\r
+ private String aligment = "";\r
+\r
+ // /\r
+ // / Padding value\r
+ // /\r
+ private String padValue = "";\r
+\r
+ // /\r
+ // / output directory\r
+ // /\r
+ private String outputDir = "";\r
+\r
+ // /\r
+ // / MCI file array\r
+ // /\r
+ List<Input> mciFileArray = new ArrayList<Input>();\r
+\r
+ // /\r
+ // / command and argument list\r
+ // /\r
+ LinkedList<String> argList = new LinkedList<String>();\r
+\r
+ /**\r
+ * execute\r
+ * \r
+ * FlashMapTask 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, "flashmap");\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 substituted input file and output file\r
+ //\r
+ if (this.inStrFile != null && this.outStrFile != null\r
+ && !this.inStrFile.equalsIgnoreCase("")\r
+ && !this.inStrFile.equalsIgnoreCase("")) {\r
+ argList.add("-strsub");\r
+ argList.add(this.inStrFile);\r
+ argList.add(this.outStrFile);\r
+ }\r
+ \r
+ \r
+ //\r
+ // add microcode binary files\r
+ //\r
+ if (mciFileArray.size() > 0) {\r
+ argList.add("-mcmerge");\r
+ Iterator mciList = mciFileArray.iterator();\r
+ while (mciList.hasNext()) {\r
+ argList.add(((Input) mciList.next()).getFile());\r
+ }\r
+ }\r
+\r
+ EdkLog.log(EdkLog.EDK_INFO, argList.toString().replace(",",""));\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\r
+ .getInputStream());\r
+ char[] buf = new char[1024];\r
+\r
+ exitCode = cmdProc.waitFor();\r
+ //\r
+ // log command line string.\r
+ //\r
+ EdkLog.log(EdkLog.EDK_INFO, cmdProc.getOutputStream().toString());\r
+ if (exitCode != 0) {\r
+ int len = cmdOut.read(buf, 0, 1024);\r
+ EdkLog.log(EdkLog.EDK_ERROR, new String(buf, 0, len));\r
+ } else {\r
+ EdkLog.log(EdkLog.EDK_INFO, "FlashMap succeed!");\r
+ }\r
+ } catch (Exception e) {\r
+ throw new BuildException(e.getMessage());\r
+ } finally {\r
+ if (exitCode != 0) {\r
+ // throw new BuildException("GenFvImage: failed to generate FV\r
+ // file!");\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * getFlashDefFile\r
+ * \r
+ * This function is to get class member "flashDefFile"\r
+ * \r
+ * @return flashDeFile Name of flash definition file.\r
+ */\r
+ public String getFlashDefFile() {\r
+ return flashDefFile;\r
+ }\r
+\r
+ /**\r
+ * setFlashDefFile\r
+ * \r
+ * This function is to set class member "flashDefFile"\r
+ * \r
+ * @param flashDefFile\r
+ * Name of flash definition file.\r
+ */\r
+ public void setFlashDefFile(String flashDefFile) {\r
+ this.flashDefFile = flashDefFile;\r
+ argList.add("-fdf");\r
+ argList.add(this.flashDefFile);\r
+ }\r
+\r
+ /**\r
+ * getAligment\r
+ * \r
+ * This function is to get class member "aligment"\r
+ * \r
+ * @return aligment String of aligment value.\r
+ */\r
+ public String getAligment() {\r
+ return aligment;\r
+ }\r
+\r
+ /**\r
+ * setAligment\r
+ * \r
+ * This function is to set class member "aligment"\r
+ * \r
+ * @param aligment\r
+ * String of aligment value.\r
+ */\r
+ public void setAligment(String aligment) {\r
+ this.aligment = aligment;\r
+ argList.add("-align");\r
+ argList.add(this.aligment);\r
+ }\r
+\r
+ /**\r
+ * getAsmIncFile\r
+ * \r
+ * This function is to get class member "asmIncFile"\r
+ * \r
+ * @return asmIncFile String of ASM include file.\r
+ */\r
+ public String getAsmIncFile() {\r
+ return asmIncFile;\r
+ }\r
+\r
+ /**\r
+ * setAsmIncFile\r
+ * \r
+ * This function is to set class member "asmIncFile"\r
+ * \r
+ * @param asmIncFile\r
+ * String of ASM include file.\r
+ */\r
+ public void setAsmIncFile(String asmIncFile) {\r
+ this.asmIncFile = asmIncFile;\r
+ argList.add("-asmincfile");\r
+ argList.add(this.asmIncFile);\r
+ }\r
+\r
+ /**\r
+ * getBaseAddr\r
+ * \r
+ * This function is to get class member "baseAddr"\r
+ * \r
+ * @return baseAddr String of base address value.\r
+ */\r
+ public String getBaseAddr() {\r
+ return baseAddr;\r
+ }\r
+\r
+ /**\r
+ * setBaseAddr\r
+ * \r
+ * This function is to set class member "baseAddr"\r
+ * \r
+ * @param baseAddr\r
+ * String of base address value.\r
+ */\r
+ public void setBaseAddr(String baseAddr) {\r
+ this.baseAddr = baseAddr;\r
+ argList.add("-baseaddr");\r
+ argList.add(this.baseAddr);\r
+ }\r
+\r
+ /**\r
+ * getDscFile\r
+ * \r
+ * This function is to get class member "dscFile"\r
+ * \r
+ * @return dscFile name of DSC file\r
+ */\r
+ public String getDscFile() {\r
+ return dscFile;\r
+ }\r
+\r
+ /**\r
+ * setDscFile\r
+ * \r
+ * This function is to set class member "dscFile"\r
+ * \r
+ * @param dscFile\r
+ * name of DSC file\r
+ */\r
+ public void setDscFile(String dscFile) {\r
+ this.dscFile = dscFile;\r
+ argList.add("-dsc");\r
+ argList.add(this.dscFile);\r
+ }\r
+\r
+ /**\r
+ * getFdImage\r
+ * \r
+ * This function is to get class member "fdImage"\r
+ * \r
+ * @return fdImage name of input FDI image file.\r
+ */\r
+ public String getFdImage() {\r
+ return fdImage;\r
+ }\r
+\r
+ /**\r
+ * setFdImage\r
+ * \r
+ * This function is to set class member "fdImage"\r
+ * \r
+ * @param fdImage\r
+ * name of input FDI image file.\r
+ */\r
+ public void setFdImage(String fdImage) {\r
+ this.fdImage = fdImage;\r
+ argList.add("-discover");\r
+ argList.add(this.fdImage);\r
+ }\r
+\r
+ /**\r
+ * getFlashDevice\r
+ * \r
+ * This function is to get class member "flashDevice".\r
+ * \r
+ * @return flashDevice name of flash device.\r
+ */\r
+ public String getFlashDevice() {\r
+ return flashDevice;\r
+ }\r
+\r
+ /**\r
+ * setFlashDevice\r
+ * \r
+ * This function is to set class member "flashDevice"\r
+ * \r
+ * @param flashDevice\r
+ * name of flash device.\r
+ */\r
+ public void setFlashDevice(String flashDevice) {\r
+ this.flashDevice = flashDevice;\r
+ argList.add("-flashdevice");\r
+ argList.add(this.flashDevice);\r
+ }\r
+\r
+ /**\r
+ * getFlashDeviceImage\r
+ * \r
+ * This function is to get class member "flashDeviceImage"\r
+ * \r
+ * @return flashDeviceImage name of flash device image\r
+ */\r
+ public String getFlashDeviceImage() {\r
+ return flashDeviceImage;\r
+ }\r
+\r
+ /**\r
+ * setFlashDeviceImage\r
+ * \r
+ * This function is to set class member "flashDeviceImage"\r
+ * \r
+ * @param flashDeviceImage\r
+ * name of flash device image\r
+ */\r
+ public void setFlashDeviceImage(String flashDeviceImage) {\r
+ this.flashDeviceImage = flashDeviceImage;\r
+ argList.add("-flashdeviceimage");\r
+ argList.add(this.flashDeviceImage);\r
+\r
+ }\r
+\r
+ /**\r
+ * getHeaderFile\r
+ * \r
+ * This function is to get class member "headerFile"\r
+ * \r
+ * @return headerFile name of include file\r
+ */\r
+ public String getHeaderFile() {\r
+ return headerFile;\r
+ }\r
+\r
+ /**\r
+ * setHeaderFile\r
+ * \r
+ * This function is to set class member "headerFile"\r
+ * \r
+ * @param headerFile\r
+ * name of include file\r
+ */\r
+ public void setHeaderFile(String headerFile) {\r
+ this.headerFile = headerFile;\r
+ argList.add("-hfile");\r
+ argList.add(this.headerFile);\r
+ }\r
+\r
+ /**\r
+ * getImageOutFile\r
+ * \r
+ * This function is to get class member "imageOutFile"\r
+ * \r
+ * @return imageOutFile name of output image file\r
+ */\r
+ public String getImageOutFile() {\r
+ return imageOutFile;\r
+ }\r
+\r
+ /**\r
+ * setImageOutFile\r
+ * \r
+ * This function is to set class member "ImageOutFile"\r
+ * \r
+ * @param imageOutFile\r
+ * name of output image file\r
+ */\r
+ public void setImageOutFile(String imageOutFile) {\r
+ this.imageOutFile = imageOutFile;\r
+ argList.add("-imageout");\r
+ argList.add(this.imageOutFile);\r
+ }\r
+\r
+ /**\r
+ * getInStrFile\r
+ * \r
+ * This function is to get class member "inStrFile"\r
+ * \r
+ * @return inStrFile name of input file which used to replace symbol names.\r
+ */\r
+ public String getInStrFile() {\r
+ return inStrFile;\r
+ }\r
+\r
+ /**\r
+ * setInStrFile\r
+ * \r
+ * This function is to set class member "inStrFile"\r
+ * \r
+ * @param inStrFile\r
+ * name of input file which used to replace symbol names.\r
+ */\r
+ public void setInStrFile(String inStrFile) {\r
+ this.inStrFile = inStrFile;\r
+ }\r
+\r
+ /**\r
+ * getMciFile\r
+ * \r
+ * This function is to get class member "mciFile"\r
+ * \r
+ * @return mciFile name of input microcode file\r
+ */\r
+ public String getMciFile() {\r
+ return mciFile;\r
+ }\r
+\r
+ /**\r
+ * setMciFile\r
+ * \r
+ * This function is to set class member "mciFile"\r
+ * \r
+ * @param mciFile\r
+ * name of input microcode file\r
+ */\r
+ public void setMciFile(String mciFile) {\r
+ this.mciFile = mciFile;\r
+ argList.add("-mci");\r
+ argList.add(this.mciFile);\r
+ }\r
+\r
+ /**\r
+ * getMcoFile\r
+ * \r
+ * This function is to get class member "mcoFile"\r
+ * \r
+ * @return mcoFile name of output binary microcode image\r
+ */\r
+ public String getMcoFile() {\r
+ return mcoFile;\r
+ }\r
+\r
+ /**\r
+ * setMcoFile\r
+ * \r
+ * This function is to set class member "mcoFile"\r
+ * \r
+ * @param mcoFile\r
+ * name of output binary microcode image\r
+ */\r
+ public void setMcoFile(String mcoFile) {\r
+ this.mcoFile = mcoFile;\r
+ argList.add("-mco");\r
+ argList.add(this.mcoFile);\r
+ }\r
+\r
+ /**\r
+ * getOutStrFile\r
+ * \r
+ * This function is to get class member "outStrFile"\r
+ * \r
+ * @return outStrFile name of output string substitution file\r
+ */\r
+ public String getOutStrFile() {\r
+ return outStrFile;\r
+ }\r
+\r
+ /**\r
+ * setOutStrFile\r
+ * \r
+ * This function is to set class member "outStrFile"\r
+ * \r
+ * @param outStrFile\r
+ * name of output string substitution file\r
+ */\r
+ public void setOutStrFile(String outStrFile) {\r
+ this.outStrFile = outStrFile;\r
+ }\r
+\r
+ /**\r
+ * getPadValue\r
+ * \r
+ * This function is to get class member "padValue"\r
+ * \r
+ * @return padValue string of byte value to use as padding\r
+ */\r
+ public String getPadValue() {\r
+ return padValue;\r
+ }\r
+\r
+ /**\r
+ * setPadValue\r
+ * \r
+ * This function is to set class member "padValue"\r
+ * \r
+ * @param padValue\r
+ * string of byte value to use as padding\r
+ */\r
+ public void setPadValue(String padValue) {\r
+ this.padValue = padValue;\r
+ argList.add("-padvalue");\r
+ argList.add(this.padValue);\r
+ }\r
+\r
+ /**\r
+ * addMciFile\r
+ * \r
+ * This function is to add Microcode binary file\r
+ * \r
+ * @param mciFile\r
+ * instance of input class\r
+ */\r
+ public void addMciFile(Input mciFile) {\r
+ this.mciFileArray.add(mciFile);\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\r
+ * string of output directory\r
+ */\r
+ public void setOutputDir(String outputDir) {\r
+ this.outputDir = outputDir;\r
+ }\r
+}\r
projects / mirror_edk2.git / blobdiff