[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / FfsProcess.java

/** @file\r
  File is FfsProcess class which is used to get the corresponding FFS layout\r
  information for driver module. \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
package org.tianocore.build;\r
\r
import java.io.File;\r
import java.util.Vector;\r
\r
import javax.xml.namespace.QName;\r
\r
import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.Project;\r
import org.apache.xmlbeans.XmlCursor;\r
import org.tianocore.BuildOptionsDocument;\r
import org.tianocore.build.global.GlobalData;\r
import org.tianocore.build.global.SurfaceAreaQuery;\r
import org.tianocore.build.id.FpdModuleIdentification;\r
import org.tianocore.common.definitions.EdkDefinitions;\r
import org.w3c.dom.Document;\r
import org.w3c.dom.Element;\r
\r
/** \r
  <p><code>FfsProcess</code> is a class to find the corresponding FFS layout. </p>\r
  \r
  <p>Property <code>COMMON_FILE</code> specified which file to search. The element\r
  in <code>COMMON_FILE</code> is like following: </p>\r
  \r
  <pre>\r
    &lt;Ffs type="APPLICATION"&gt;\r
      &lt;Attribute Name="FFS_FILETYPE" Value="EFI_FV_FILETYPE_APPLICATION" /&gt;\r
      &lt;Attribute Name="FFS_ATTRIB_CHECKSUM" Value="TRUE" /&gt;\r
      &lt;Sections EncapsulationType="Compress"&gt;\r
        &lt;Sections EncapsulationType="Guid-Defined"&gt;\r
          &lt;Section SectionType="EFI_SECTION_PE32" /&gt; \r
          &lt;Section SectionType="EFI_SECTION_USER_INTERFACE" /&gt;\r
          &lt;Section SectionType="EFI_SECTION_VERSION" /&gt; \r
        &lt;/Sections&gt;\r
      &lt;/Sections&gt;\r
    &lt;/Ffs&gt;\r
  </pre>\r
 \r
  @since GenBuild 1.0\r
**/\r
public class FfsProcess {\r
\r
    private BuildOptionsDocument.BuildOptions.Ffs ffsXmlObject;\r
\r
    ///\r
    /// ANT script to call GenFfs\r
    ///\r
    private Element ffsNode = null;\r
\r
    ///\r
    /// Module base name\r
    ///\r
    private String basename;\r
\r
    ///\r
    /// Sections type: normal\r
    ///\r
    private static int MODE_NONE = 0;\r
\r
    ///\r
    /// Sections type: compress\r
    ///\r
    private static int MODE_COMPRESS = 1;\r
\r
    ///\r
    /// Sections type: guid-define\r
    ///\r
    private static int MODE_GUID_DEFINED = 2;\r
\r
    ///\r
    /// mapping from section type to section output file extension\r
    ///\r
    public static final String[][] sectionExt = EdkDefinitions.SectionTypeExtensions;\r
\r
    /**\r
      search in the type, if componentType is listed in type, return true; \r
      otherwise return false.\r
      \r
      @param type a list supported component type separated by comma\r
      @param componentType current module component type\r
      @return whether componentType is one of type \r
    **/\r
    private boolean isMatch(String type, String componentType) {\r
        String[] items = type.split("[ \t]*,[ \t]*");\r
        for (int i = 0; i < items.length; i++) {\r
            if (items[i].equalsIgnoreCase(componentType)) {\r
                return true;\r
            }\r
        }\r
        return false;\r
    }\r
\r
    /**\r
      Find the corresponding FFS layout in <code>COMMON_FILE</code> if it\r
      does not specify in module's surface area. \r
      \r
      @param buildType Current module's component type\r
      @param project Ant project\r
      @return whether find the corresponding FFS layout\r
      @throws BuildException\r
              If specified COMMON_FILE XML file is not valide.\r
    **/\r
    public boolean initSections(String buildType, Project project, FpdModuleIdentification fpdModuleId) throws BuildException {\r
        //\r
        // Try to find Ffs layout from FPD file\r
        //\r
        SurfaceAreaQuery.push(GlobalData.getFpdBuildOptions());\r
        BuildOptionsDocument.BuildOptions.Ffs[] ffsArray = SurfaceAreaQuery.getFpdFfs();\r
        SurfaceAreaQuery.pop();\r
        for (int i = 0; i < ffsArray.length; i++) {\r
            if (isMatch(ffsArray[i].getFfsKey(), buildType)) {\r
                ffsXmlObject = ffsArray[i];\r
                return true;\r
            }\r
        }\r
        \r
        //\r
        // If FfsFormatKey is not null, report exception and fail build\r
        // Otherwise report warning message\r
        //\r
        if (buildType == null) {\r
            System.out.println("Warning: this module doesn't specify a FfsFormatKey. ");\r
        } else {\r
            throw new BuildException("Can't find the FfsFormatKey [" + buildType + "] attribute in the FPD file!");            \r
        }\r
\r
        return false;\r
    }\r
    \r
    /**\r
      Recursive parse the FFS layout. Find out all section type here used. \r
      \r
      @param document BaseName_build.xml Xml document\r
      @param basename Module's base name\r
      @param guid Module's GUID\r
      @param targetFilename Module's final file name (GUID-BaseName.APP)\r
      @return List of section type\r
    **/\r
    public String[] getGenSectionElements(Document document, String basename, String guid, String targetFilename) {\r
        this.basename = basename;\r
        if (ffsXmlObject == null) {\r
            return new String[0];\r
        }\r
        Vector<String> sectionList = new Vector<String>();\r
        XmlCursor cursor = null;\r
        try {\r
            cursor = ffsXmlObject.newCursor();\r
        } catch (Exception e) {\r
            return null;\r
        }\r
        int mode = MODE_NONE;\r
        Element genffsfileEle = document.createElement("genffsfile");\r
        genffsfileEle.setAttribute("outputDir", "${BIN_DIR}");\r
        genffsfileEle.setAttribute("moduleType", "${MODULE_TYPE}");\r
        genffsfileEle.setAttribute("BaseName", basename);\r
        genffsfileEle.setAttribute("fileGuid", guid);\r
\r
        if (cursor.toFirstChild()) {\r
            do {\r
                if (cursor.getName().getLocalPart().equalsIgnoreCase("Attribute")) {\r
                    String name = cursor.getAttributeText(new QName("Name"));\r
                    String value = cursor.getAttributeText(new QName("Value"));\r
                    genffsfileEle.setAttribute(changeAttributeName(name), value);\r
                } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
                    cursor.push();\r
                    dealSection(mode, document, genffsfileEle, cursor, sectionList);\r
                    cursor.pop();\r
                } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
                    cursor.push();\r
                    dealSections(mode, document, genffsfileEle, cursor, sectionList);\r
                    cursor.pop();\r
                }\r
            } while (cursor.toNextSibling());\r
        }\r
        //\r
        // Check dependency \r
        //\r
        Element outofdateEle = document.createElement("OnDependency");\r
        Element sourceEle = document.createElement("sourcefiles");\r
        String[] result = new String[sectionList.size()];\r
        for (int i = 0; i < sectionList.size(); i++) {\r
            result[i] = (String) sectionList.get(i);\r
            Element pathEle = document.createElement("file");\r
            pathEle.setAttribute("name", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename\r
                                         + getSectionExt(result[i]));\r
            sourceEle.appendChild(pathEle);\r
        }\r
        outofdateEle.appendChild(sourceEle);\r
        Element targetEle = document.createElement("targetfiles");\r
        Element fileEle = document.createElement("file");\r
        fileEle.setAttribute("name", "${BIN_DIR}" + File.separatorChar + targetFilename);\r
        targetEle.appendChild(fileEle);\r
        outofdateEle.appendChild(targetEle);\r
        Element sequentialEle = document.createElement("sequential");\r
        sequentialEle.appendChild(genffsfileEle);\r
        outofdateEle.appendChild(sequentialEle);\r
        ffsNode = outofdateEle;\r
        return result;\r
    }\r
\r
    /**\r
      Change the attribute name. For example: \r
      \r
      <pre>\r
          Before change: FFS_ATTRIB_CHECKSUM \r
          After  change: ffsATTRIBCHECKSUM\r
      </pre>\r
      \r
      @param name Original attribute name\r
      @return Changed attribute name\r
    **/\r
    private String changeAttributeName(String name) {\r
        String[] strs = name.split("_");\r
        String str = strs[0].toLowerCase();\r
        for (int j = 1; j < strs.length; j++) {\r
            str += strs[j];\r
        }\r
        return str;\r
    }\r
\r
    /**\r
      Recursively deal with Sections. If sections does not specify a type, then omit it.\r
      \r
      @param mode Current node mode (MODE_NONE | MODE_COMPREE | MODE_GUID_DEFINED)\r
      @param doc Xml Document\r
      @param root Root Node\r
      @param cursor Current FFS layout cursor\r
      @param list List of section type here used\r
    **/\r
    private void dealSections(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r
        String type = cursor.getAttributeText(new QName("EncapsulationType"));\r
        if (type == null) {\r
            if (cursor.toFirstChild()) {\r
                do {\r
                    if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
                        cursor.push();\r
                        dealSection(mode, doc, root, cursor, list);\r
                        cursor.pop();\r
                    } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
                        cursor.push();\r
                        dealSections(mode, doc, root, cursor, list);\r
                        cursor.pop();\r
                    }\r
                } while (cursor.toNextSibling());\r
            }\r
            return;\r
        }\r
        Element ele;\r
        if (type.equalsIgnoreCase("COMPRESS")) {\r
            mode = MODE_COMPRESS;\r
            //\r
            // <compress compressName = "dummy">\r
            //\r
            ele = doc.createElement("compress");\r
            ele.setAttribute("compressName", "dummy");\r
        } else {\r
            mode = MODE_GUID_DEFINED;\r
            //\r
            // <tool toolName="${OEMTOOLPATH}\toolname"\r
            // outputPath = "${DEST_DIR_OUTPUT}">\r
            //\r
            ele = doc.createElement("tool");\r
            ele.setAttribute("toolName", "${WORKSPACE_DIR}" + File.separatorChar + "Tools" + File.separatorChar + "bin"\r
                                         + File.separatorChar + "GenCRC32Section");\r
            ele.setAttribute("outputPath", "${DEST_DIR_OUTPUT}");\r
        }\r
        if (cursor.toFirstChild()) {\r
            do {\r
                if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
                    cursor.push();\r
                    dealSection(mode, doc, ele, cursor, list);\r
                    cursor.pop();\r
                } else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
                    cursor.push();\r
                    dealSections(mode, doc, ele, cursor, list);\r
                    cursor.pop();\r
                }\r
            } while (cursor.toNextSibling());\r
        }\r
        root.appendChild(ele);\r
    }\r
    \r
    /**\r
      Recursively deal with section.\r
      \r
      @param mode Current node mode (MODE_NONE | MODE_COMPREE | MODE_GUID_DEFINED)\r
      @param doc Xml Document\r
      @param root Root Node\r
      @param cursor Current FFS layout cursor\r
      @param list List of section type here used\r
    **/\r
    private void dealSection(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r
        String type = cursor.getAttributeText(new QName("SectionType"));\r
        \r
        //\r
        // Judge if file is specified? Yes, just use the file, else call Build Macro\r
        // If fileName is null, means without FileNames specify in FPD file\r
        //\r
        String fileName = null;\r
        cursor.push();\r
        if (cursor.toFirstChild()) {\r
            do {\r
                if (cursor.getName().getLocalPart().equalsIgnoreCase("Filenames")) {\r
                    cursor.push();\r
                    if (cursor.toFirstChild()) {\r
                        do {\r
                            if (cursor.getName().getLocalPart().equalsIgnoreCase("Filename")) {\r
                                fileName = cursor.getTextValue();\r
                            }\r
                        } while (cursor.toNextSibling());\r
                    }\r
                    cursor.pop();\r
                }\r
            } while (cursor.toNextSibling());\r
        }\r
\r
        cursor.pop();\r
        \r
        if (fileName == null) {\r
            list.addElement(type);\r
        }\r
        if (mode == MODE_GUID_DEFINED) {\r
            //\r
            // <input file="${DEST_DIR_OUTPUT}\Bds.pe32"/>\r
            //\r
            Element ele = doc.createElement("input");\r
            if (fileName == null) {\r
                ele.setAttribute("file", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + getSectionExt(type));\r
            } else {\r
                ele.setAttribute("file", "${PLATFORM_DIR}" + File.separatorChar + fileName);\r
            }\r
            root.appendChild(ele);\r
        } else {\r
            //\r
            // <sectFile fileName= "..."/>\r
            //\r
            Element ele = doc.createElement("sectFile");\r
            if (fileName == null) {\r
                ele.setAttribute("fileName", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + getSectionExt(type));\r
            } else {\r
                ele.setAttribute("fileName", "${PLATFORM_DIR}" + File.separatorChar + fileName);\r
            }\r
            root.appendChild(ele);\r
        }\r
    }\r
\r
    /**\r
      Get the corresponding section file suffix.\r
       \r
      @param type Section type\r
      @return Corresponding section file extension\r
    **/\r
    private String getSectionExt(String type) {\r
        for (int i = 0; i < sectionExt.length; i++) {\r
            if (sectionExt[i][0].equalsIgnoreCase(type)) {\r
                return sectionExt[i][1];\r
            }\r
        }\r
        return ".sec";\r
    }\r
\r
    /**\r
      Return the ANT script to call GenFfs Tool.\r
      \r
      @return ANT script to call GenFfs Tool\r
    **/\r
    public Element getFfsNode() {\r
        return ffsNode;\r
    }\r
}\r
Commit	Line	Data
878ddf1f	1	/** @file\r
	2	File is FfsProcess class which is used to get the corresponding FFS layout\r
	3	information for driver module. \r
	4	\r
	5	Copyright (c) 2006, Intel Corporation\r
	6	All rights reserved. This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	**/\r
	14	package org.tianocore.build;\r
	15	\r
	16	import java.io.File;\r
878ddf1f	17	import java.util.Vector;\r
	18	\r
	19	import javax.xml.namespace.QName;\r
878ddf1f	20	\r
	21	import org.apache.tools.ant.BuildException;\r
	22	import org.apache.tools.ant.Project;\r
	23	import org.apache.xmlbeans.XmlCursor;\r
a29c47e0	24	import org.tianocore.BuildOptionsDocument;\r
	25	import org.tianocore.build.global.GlobalData;\r
	26	import org.tianocore.build.global.SurfaceAreaQuery;\r
	27	import org.tianocore.build.id.FpdModuleIdentification;\r
4a6a5026	28	import org.tianocore.common.definitions.EdkDefinitions;\r
878ddf1f	29	import org.w3c.dom.Document;\r
878ddf1f	30	import org.w3c.dom.Element;\r
878ddf1f	31	\r
	32	/** \r
	33	<p><code>FfsProcess</code> is a class to find the corresponding FFS layout. </p>\r
	34	\r
	35	<p>Property <code>COMMON_FILE</code> specified which file to search. The element\r
	36	in <code>COMMON_FILE</code> is like following: </p>\r
	37	\r
	38	<pre>\r
	39	<Ffs type="APPLICATION">\r
	40	<Attribute Name="FFS_FILETYPE" Value="EFI_FV_FILETYPE_APPLICATION" />\r
	41	<Attribute Name="FFS_ATTRIB_CHECKSUM" Value="TRUE" />\r
	42	<Sections EncapsulationType="Compress">\r
	43	<Sections EncapsulationType="Guid-Defined">\r
	44	<Section SectionType="EFI_SECTION_PE32" /> \r
	45	<Section SectionType="EFI_SECTION_USER_INTERFACE" />\r
	46	<Section SectionType="EFI_SECTION_VERSION" /> \r
	47	</Sections>\r
	48	</Sections>\r
	49	</Ffs>\r
	50	</pre>\r
	51	\r
	52	@since GenBuild 1.0\r
	53	**/\r
	54	public class FfsProcess {\r
	55	\r
a29c47e0	56	private BuildOptionsDocument.BuildOptions.Ffs ffsXmlObject;\r
878ddf1f	57	\r
	58	///\r
	59	/// ANT script to call GenFfs\r
	60	///\r
	61	private Element ffsNode = null;\r
	62	\r
	63	///\r
	64	/// Module base name\r
	65	///\r
	66	private String basename;\r
	67	\r
	68	///\r
	69	/// Sections type: normal\r
	70	///\r
	71	private static int MODE_NONE = 0;\r
	72	\r
	73	///\r
	74	/// Sections type: compress\r
	75	///\r
	76	private static int MODE_COMPRESS = 1;\r
	77	\r
	78	///\r
	79	/// Sections type: guid-define\r
	80	///\r
	81	private static int MODE_GUID_DEFINED = 2;\r
	82	\r
	83	///\r
	84	/// mapping from section type to section output file extension\r
	85	///\r
4a6a5026	86	public static final String[][] sectionExt = EdkDefinitions.SectionTypeExtensions;\r
878ddf1f	87	\r
	88	/**\r
	89	search in the type, if componentType is listed in type, return true; \r
	90	otherwise return false.\r
	91	\r
	92	@param type a list supported component type separated by comma\r
	93	@param componentType current module component type\r
	94	@return whether componentType is one of type \r
	95	**/\r
	96	private boolean isMatch(String type, String componentType) {\r
	97	String[] items = type.split("[ \t],[ \t]");\r
	98	for (int i = 0; i < items.length; i++) {\r
	99	if (items[i].equalsIgnoreCase(componentType)) {\r
	100	return true;\r
	101	}\r
	102	}\r
	103	return false;\r
	104	}\r
	105	\r
	106	/**\r
	107	Find the corresponding FFS layout in <code>COMMON_FILE</code> if it\r
	108	does not specify in module's surface area. \r
	109	\r
	110	@param buildType Current module's component type\r
	111	@param project Ant project\r
	112	@return whether find the corresponding FFS layout\r
	113	@throws BuildException\r
	114	If specified COMMON_FILE XML file is not valide.\r
	115	**/\r
a29c47e0	116	public boolean initSections(String buildType, Project project, FpdModuleIdentification fpdModuleId) throws BuildException {\r
878ddf1f	117	//\r
82516887	118	// Try to find Ffs layout from FPD file\r
a29c47e0	119	//\r
	120	SurfaceAreaQuery.push(GlobalData.getFpdBuildOptions());\r
	121	BuildOptionsDocument.BuildOptions.Ffs[] ffsArray = SurfaceAreaQuery.getFpdFfs();\r
	122	SurfaceAreaQuery.pop();\r
	123	for (int i = 0; i < ffsArray.length; i++) {\r
	124	if (isMatch(ffsArray[i].getFfsKey(), buildType)) {\r
	125	ffsXmlObject = ffsArray[i];\r
	126	return true;\r
	127	}\r
	128	}\r
	129	\r
878ddf1f	130	//\r
e64c74dd	131	// If FfsFormatKey is not null, report exception and fail build\r
e64c74dd	132	// Otherwise report warning message\r
878ddf1f	133	//\r
e64c74dd	134	if (buildType == null) {\r
e64c74dd	135	System.out.println("Warning: this module doesn't specify a FfsFormatKey. ");\r
82516887	136	} else {\r
391dbbb1	137	throw new BuildException("Can't find the FfsFormatKey [" + buildType + "] attribute in the FPD file!"); \r
878ddf1f	138	}\r
e64c74dd	139	\r
82516887	140	return false;\r
878ddf1f	141	}\r
	142	\r
	143	/**\r
	144	Recursive parse the FFS layout. Find out all section type here used. \r
	145	\r
	146	@param document BaseName_build.xml Xml document\r
	147	@param basename Module's base name\r
	148	@param guid Module's GUID\r
	149	@param targetFilename Module's final file name (GUID-BaseName.APP)\r
	150	@return List of section type\r
	151	**/\r
	152	public String[] getGenSectionElements(Document document, String basename, String guid, String targetFilename) {\r
	153	this.basename = basename;\r
82516887	154	if (ffsXmlObject == null) {\r
878ddf1f	155	return new String[0];\r
	156	}\r
	157	Vector<String> sectionList = new Vector<String>();\r
	158	XmlCursor cursor = null;\r
	159	try {\r
82516887	160	cursor = ffsXmlObject.newCursor();\r
878ddf1f	161	} catch (Exception e) {\r
	162	return null;\r
	163	}\r
	164	int mode = MODE_NONE;\r
82516887	165	Element genffsfileEle = document.createElement("genffsfile");\r
	166	genffsfileEle.setAttribute("outputDir", "${BIN_DIR}");\r
	167	genffsfileEle.setAttribute("moduleType", "${MODULE_TYPE}");\r
	168	genffsfileEle.setAttribute("BaseName", basename);\r
	169	genffsfileEle.setAttribute("fileGuid", guid);\r
	170	\r
878ddf1f	171	if (cursor.toFirstChild()) {\r
	172	do {\r
	173	if (cursor.getName().getLocalPart().equalsIgnoreCase("Attribute")) {\r
	174	String name = cursor.getAttributeText(new QName("Name"));\r
	175	String value = cursor.getAttributeText(new QName("Value"));\r
82516887	176	genffsfileEle.setAttribute(changeAttributeName(name), value);\r
878ddf1f	177	} else if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
878ddf1f	178	cursor.push();\r
82516887	179	dealSection(mode, document, genffsfileEle, cursor, sectionList);\r
878ddf1f	180	cursor.pop();\r
	181	} else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
	182	cursor.push();\r
82516887	183	dealSections(mode, document, genffsfileEle, cursor, sectionList);\r
878ddf1f	184	cursor.pop();\r
	185	}\r
	186	} while (cursor.toNextSibling());\r
	187	}\r
	188	//\r
	189	// Check dependency \r
	190	//\r
	191	Element outofdateEle = document.createElement("OnDependency");\r
	192	Element sourceEle = document.createElement("sourcefiles");\r
	193	String[] result = new String[sectionList.size()];\r
	194	for (int i = 0; i < sectionList.size(); i++) {\r
	195	result[i] = (String) sectionList.get(i);\r
	196	Element pathEle = document.createElement("file");\r
	197	pathEle.setAttribute("name", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename\r
	198	+ getSectionExt(result[i]));\r
	199	sourceEle.appendChild(pathEle);\r
	200	}\r
	201	outofdateEle.appendChild(sourceEle);\r
	202	Element targetEle = document.createElement("targetfiles");\r
	203	Element fileEle = document.createElement("file");\r
52cbbdbc	204	fileEle.setAttribute("name", "${BIN_DIR}" + File.separatorChar + targetFilename);\r
878ddf1f	205	targetEle.appendChild(fileEle);\r
	206	outofdateEle.appendChild(targetEle);\r
	207	Element sequentialEle = document.createElement("sequential");\r
82516887	208	sequentialEle.appendChild(genffsfileEle);\r
878ddf1f	209	outofdateEle.appendChild(sequentialEle);\r
	210	ffsNode = outofdateEle;\r
	211	return result;\r
	212	}\r
	213	\r
	214	/**\r
	215	Change the attribute name. For example: \r
	216	\r
	217	<pre>\r
	218	Before change: FFS_ATTRIB_CHECKSUM \r
	219	After change: ffsATTRIBCHECKSUM\r
	220	</pre>\r
	221	\r
	222	@param name Original attribute name\r
	223	@return Changed attribute name\r
	224	**/\r
	225	private String changeAttributeName(String name) {\r
	226	String[] strs = name.split("_");\r
	227	String str = strs[0].toLowerCase();\r
	228	for (int j = 1; j < strs.length; j++) {\r
	229	str += strs[j];\r
	230	}\r
	231	return str;\r
	232	}\r
	233	\r
	234	/**\r
	235	Recursively deal with Sections. If sections does not specify a type, then omit it.\r
	236	\r
	237	@param mode Current node mode (MODE_NONE \| MODE_COMPREE \| MODE_GUID_DEFINED)\r
	238	@param doc Xml Document\r
	239	@param root Root Node\r
	240	@param cursor Current FFS layout cursor\r
	241	@param list List of section type here used\r
	242	**/\r
	243	private void dealSections(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r
	244	String type = cursor.getAttributeText(new QName("EncapsulationType"));\r
	245	if (type == null) {\r
	246	if (cursor.toFirstChild()) {\r
	247	do {\r
	248	if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
	249	cursor.push();\r
	250	dealSection(mode, doc, root, cursor, list);\r
	251	cursor.pop();\r
	252	} else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
	253	cursor.push();\r
	254	dealSections(mode, doc, root, cursor, list);\r
	255	cursor.pop();\r
	256	}\r
	257	} while (cursor.toNextSibling());\r
	258	}\r
	259	return;\r
	260	}\r
	261	Element ele;\r
	262	if (type.equalsIgnoreCase("COMPRESS")) {\r
	263	mode = MODE_COMPRESS;\r
	264	//\r
	265	// <compress compressName = "dummy">\r
	266	//\r
	267	ele = doc.createElement("compress");\r
	268	ele.setAttribute("compressName", "dummy");\r
	269	} else {\r
	270	mode = MODE_GUID_DEFINED;\r
	271	//\r
	272	// <tool toolName="${OEMTOOLPATH}\toolname"\r
273	// outputPath = "${DEST_DIR_OUTPUT}">\r
274	//\r
275	ele = doc.createElement("tool");\r
a33f3dd1	276	ele.setAttribute("toolName", "${WORKSPACE_DIR}" + File.separatorChar + "Tools" + File.separatorChar + "bin"\r
878ddf1f	277	+ File.separatorChar + "GenCRC32Section");\r
	278	ele.setAttribute("outputPath", "${DEST_DIR_OUTPUT}");\r
	279	}\r
	280	if (cursor.toFirstChild()) {\r
	281	do {\r
	282	if (cursor.getName().getLocalPart().equalsIgnoreCase("Section")) {\r
	283	cursor.push();\r
	284	dealSection(mode, doc, ele, cursor, list);\r
	285	cursor.pop();\r
	286	} else if (cursor.getName().getLocalPart().equalsIgnoreCase("Sections")) {\r
	287	cursor.push();\r
	288	dealSections(mode, doc, ele, cursor, list);\r
	289	cursor.pop();\r
	290	}\r
	291	} while (cursor.toNextSibling());\r
	292	}\r
	293	root.appendChild(ele);\r
	294	}\r
	295	\r
	296	/**\r
	297	Recursively deal with section.\r
	298	\r
	299	@param mode Current node mode (MODE_NONE \| MODE_COMPREE \| MODE_GUID_DEFINED)\r
	300	@param doc Xml Document\r
	301	@param root Root Node\r
	302	@param cursor Current FFS layout cursor\r
	303	@param list List of section type here used\r
	304	**/\r
	305	private void dealSection(int mode, Document doc, Element root, XmlCursor cursor, Vector<String> list) {\r
	306	String type = cursor.getAttributeText(new QName("SectionType"));\r
8a9783c1	307	\r
	308	//\r
	309	// Judge if file is specified? Yes, just use the file, else call Build Macro\r
	310	// If fileName is null, means without FileNames specify in FPD file\r
	311	//\r
	312	String fileName = null;\r
	313	cursor.push();\r
	314	if (cursor.toFirstChild()) {\r
	315	do {\r
	316	if (cursor.getName().getLocalPart().equalsIgnoreCase("Filenames")) {\r
	317	cursor.push();\r
	318	if (cursor.toFirstChild()) {\r
	319	do {\r
	320	if (cursor.getName().getLocalPart().equalsIgnoreCase("Filename")) {\r
	321	fileName = cursor.getTextValue();\r
	322	}\r
	323	} while (cursor.toNextSibling());\r
	324	}\r
	325	cursor.pop();\r
	326	}\r
	327	} while (cursor.toNextSibling());\r
	328	}\r
	329	\r
	330	cursor.pop();\r
	331	\r
	332	if (fileName == null) {\r
	333	list.addElement(type);\r
	334	}\r
878ddf1f	335	if (mode == MODE_GUID_DEFINED) {\r
	336	//\r
	337	// <input file="${DEST_DIR_OUTPUT}\Bds.pe32"/>\r
	338	//\r
	339	Element ele = doc.createElement("input");\r
8a9783c1	340	if (fileName == null) {\r
	341	ele.setAttribute("file", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + getSectionExt(type));\r
	342	} else {\r
	343	ele.setAttribute("file", "${PLATFORM_DIR}" + File.separatorChar + fileName);\r
	344	}\r
878ddf1f	345	root.appendChild(ele);\r
	346	} else {\r
	347	//\r
	348	// <sectFile fileName= "..."/>\r
	349	//\r
	350	Element ele = doc.createElement("sectFile");\r
8a9783c1	351	if (fileName == null) {\r
	352	ele.setAttribute("fileName", "${DEST_DIR_OUTPUT}" + File.separatorChar + basename + getSectionExt(type));\r
	353	} else {\r
	354	ele.setAttribute("fileName", "${PLATFORM_DIR}" + File.separatorChar + fileName);\r
	355	}\r
878ddf1f	356	root.appendChild(ele);\r
	357	}\r
	358	}\r
	359	\r
	360	/**\r
a29c47e0	361	Get the corresponding section file suffix.\r
878ddf1f	362	\r
	363	@param type Section type\r
	364	@return Corresponding section file extension\r
	365	**/\r
	366	private String getSectionExt(String type) {\r
	367	for (int i = 0; i < sectionExt.length; i++) {\r
	368	if (sectionExt[i][0].equalsIgnoreCase(type)) {\r
	369	return sectionExt[i][1];\r
	370	}\r
	371	}\r
	372	return ".sec";\r
	373	}\r
	374	\r
	375	/**\r
	376	Return the ANT script to call GenFfs Tool.\r
	377	\r
	378	@return ANT script to call GenFfs Tool\r
	379	**/\r
	380	public Element getFfsNode() {\r
	381	return ffsNode;\r
	382	}\r
	383	}\r