import org.apache.tools.ant.BuildException;\r
import org.apache.tools.ant.Project;\r
import org.apache.tools.ant.Task;\r
+import org.tianocore.common.logger.EdkLog;\r
\r
/**\r
GenFfsFileTask\r
///\r
boolean ffsAttribRecovery = false;\r
///\r
- /// ffsAligenment value is used to set the corresponding bit in the output \r
+ /// ffsAttribDataAlignment value is used to set the corresponding bit in the output \r
/// FFS file header.The specified FFS alignment must be a value between 0 \r
/// and 7 inclusive\r
///\r
- int ffsAlignment = 0;\r
+ int ffsAttribDataAlignment = 0;\r
///\r
/// ffsAttribChecksum value is used to set the corresponding bit in the \r
/// output FFS file header\r
/// The path of Framewor_Tools_Paht.\r
///\r
static String path = ""; \r
-\r
+ \r
/**\r
execute\r
\r
dscriptive information.\r
**/\r
public void execute() throws BuildException {\r
- Section sect;\r
- int fileSize;\r
- int orgFileSize;\r
- int fileDataSize;\r
- int orgFileDataSize;\r
- File ffsFile;\r
- File ffsOrgFile;\r
- FfsHeader ffsHeader = new FfsHeader(); \r
- FfsHeader orgFfsHeader = new FfsHeader();\r
+\r
String ffsSuffix = "";\r
String outputPath = "";\r
-\r
+ Project project = this.getOwningTarget().getProject();\r
+ //\r
+ // set Logger\r
+ //\r
+ FrameworkLogger logger = new FrameworkLogger(project, "genFfs");\r
+ EdkLog.setLogLevel(project.getProperty("env.LOGLEVEL"));\r
+ EdkLog.setLogger(logger);\r
+ \r
//\r
// Get Fraemwork_Tools_Path\r
//\r
// Check does the BaseName, Guid, FileType set value.\r
//\r
if (this.baseName.equals("")) {\r
- throw new BuildException ("Must set BaseName!\n");\r
+ throw new BuildException ("Must set OutputFileBasename!\n");\r
}\r
\r
if (this.ffsFileGuid.equals("")) {\r
\r
}\r
\r
- ffsFile = new File (outputPath + this.ffsFileGuid + '-' + this.baseName + ffsSuffix); \r
- System.out.print("General Ffs file: file name is:\n");\r
- System.out.print(outputPath + this.ffsFileGuid + '-' + this.baseName + ffsSuffix);\r
- System.out.print("\n");\r
- \r
- //\r
- // Create ffs ORG file. fileName = FfsFileGuid + BaseName + ffsSuffix +\r
- // ".org".\r
- //\r
- ffsOrgFile = new File(outputPath + this.ffsFileGuid + '-' + this.baseName + ffsSuffix + ".org");\r
- \r
- try {\r
- //\r
- // Create file output stream -- dataBuffer.\r
- //\r
- FileOutputStream dataFs = new FileOutputStream (ffsFile.getAbsolutePath());\r
- DataOutputStream dataBuffer = new DataOutputStream (dataFs);\r
- \r
- //\r
- // Create org file output stream -- orgDataBuffer\r
- //\r
- FileOutputStream orgDataFs = new FileOutputStream (ffsOrgFile.getAbsolutePath());\r
- DataOutputStream orgDataBuffer = new DataOutputStream (orgDataFs);\r
- \r
- //\r
- // Search SectionList find earch section and call it's \r
- // ToBuffer function.\r
- //\r
- Iterator sectionIter = this.sectionList.iterator();\r
- while (sectionIter.hasNext()) {\r
- sect = (Section)sectionIter.next(); \r
-\r
- try {\r
- //\r
- // The last section don't need 4 byte ffsAligment.\r
- //\r
- sect.toBuffer((DataOutputStream)dataBuffer, (DataOutputStream) orgDataBuffer);\r
- } catch (Exception e) {\r
- throw new BuildException (e.getMessage());\r
- }\r
- }\r
- dataBuffer.close();\r
- orgDataBuffer.close();\r
- } catch (Exception e) {\r
- throw new BuildException (e.getMessage());\r
- }\r
-\r
- //\r
- // Creat Ffs file header\r
- //\r
- try {\r
-\r
- //\r
- // create input stream to read file data\r
- //\r
- byte[] fileBuffer = new byte[(int)ffsFile.length()];\r
- FileInputStream fi = new FileInputStream (ffsFile.getAbsolutePath());\r
- DataInputStream di = new DataInputStream (fi);\r
- di.read(fileBuffer);\r
- di.close();\r
- \r
- //\r
- // create input org stream to read file data\r
- //\r
- byte[] orgFileBuffer = new byte[(int)ffsOrgFile.length()];\r
- FileInputStream ofi = new FileInputStream (ffsOrgFile.getAbsolutePath());\r
- DataInputStream odi = new DataInputStream (ofi);\r
- odi.read(orgFileBuffer);\r
- odi.close();\r
-\r
- //\r
- // Add GUID to header struct\r
- //\r
- if (this.ffsFileGuid != null) {\r
- stringToGuid (this.ffsFileGuid, ffsHeader.name);\r
- //\r
- // Add Guid to org header struct\r
- //\r
- stringToGuid (this.ffsFileGuid, orgFfsHeader.name);\r
- }\r
-\r
- ffsHeader.ffsAttributes = this.attributes;\r
- if ((ffsHeader.fileType = stringToType(this.ffsFileType))== -1) {\r
- throw new BuildException ("FFS_FILE_TYPE unknow!\n");\r
- }\r
- \r
- //\r
- // Copy ffsHeader.ffsAttribute and fileType to orgFfsHeader.ffsAttribute\r
- // and fileType\r
- // \r
- orgFfsHeader.ffsAttributes = ffsHeader.ffsAttributes;\r
- orgFfsHeader.fileType = ffsHeader.fileType;\r
- \r
- //\r
- // Adjust file size. The function is used to tripe the last \r
- // section padding of 4 binary boundary. \r
- // \r
- //\r
- if (ffsHeader.fileType != EFI_FV_FILETYPE_RAW) {\r
-\r
- fileDataSize = adjustFileSize (fileBuffer);\r
- orgFileDataSize = adjustFileSize (orgFileBuffer);\r
-\r
- } else {\r
- fileDataSize = fileBuffer.length;\r
- orgFileDataSize = orgFileBuffer.length;\r
- }\r
-\r
- //\r
- // 1. add header size to file size\r
- //\r
- fileSize = fileDataSize + ffsHeader.getSize();\r
- //\r
- // add header size to org file size\r
- //\r
- orgFileSize = orgFileDataSize + ffsHeader.getSize();\r
-\r
- if ((ffsHeader.ffsAttributes & FFS_ATTRIB_TAIL_PRESENT) != 0) {\r
- if (ffsHeader.fileType == EFI_FV_FILETYPE_FFS_PAD) {\r
-\r
- throw new BuildException (\r
- "FFS_ATTRIB_TAIL_PRESENT=TRUE is " +\r
- "invalid for PAD files"\r
- );\r
- }\r
- if (fileSize == ffsHeader.getSize()) {\r
- throw new BuildException (\r
- "FFS_ATTRIB_TAIL_PRESENT=TRUE is " +\r
- "invalid for 0-length files"\r
- ); \r
- }\r
- fileSize = fileSize + 2;\r
- orgFileSize = orgFileSize + 2;\r
- }\r
-\r
- //\r
- // 2. set file size to header struct\r
- //\r
- ffsHeader.ffsFileSize[0] = (byte)(fileSize & 0x00FF);\r
- ffsHeader.ffsFileSize[1] = (byte)((fileSize & 0x00FF00)>>8);\r
- ffsHeader.ffsFileSize[2] = (byte)(((int)fileSize & 0xFF0000)>>16);\r
- \r
- //\r
- // set file size to org header struct\r
- //\r
- orgFfsHeader.ffsFileSize[0] = (byte)(orgFileSize & 0x00FF);\r
- orgFfsHeader.ffsFileSize[1] = (byte)((orgFileSize & 0x00FF00)>>8);\r
- orgFfsHeader.ffsFileSize[2] = (byte)(((int)orgFileSize & 0xFF0000)>>16);\r
- \r
- //\r
- // Fill in checksums and state, these must be zero for checksumming\r
- //\r
- ffsHeader.integrityCheck.header = calculateChecksum8 (\r
- ffsHeader.structToBuffer(),\r
- ffsHeader.getSize()\r
- );\r
- //\r
- // Fill in org file's header check sum and state\r
- //\r
- orgFfsHeader.integrityCheck.header = calculateChecksum8 (\r
- orgFfsHeader.structToBuffer(),\r
- orgFfsHeader.getSize()\r
- );\r
- \r
- if ((this.attributes & FFS_ATTRIB_CHECKSUM) != 0) {\r
- if ((this.attributes & FFS_ATTRIB_TAIL_PRESENT) != 0) {\r
- ffsHeader.integrityCheck.file = calculateChecksum8 (\r
- fileBuffer, \r
- fileDataSize\r
- );\r
- //\r
- // Add org file header\r
- //\r
- orgFfsHeader.integrityCheck.file = calculateChecksum8 (\r
- orgFileBuffer,\r
- orgFileDataSize\r
- );\r
- } else {\r
- ffsHeader.integrityCheck.file = calculateChecksum8 (\r
- fileBuffer,\r
- fileDataSize\r
- );\r
- //\r
- // Add org file header\r
- //\r
- orgFfsHeader.integrityCheck.file = calculateChecksum8 (\r
- orgFileBuffer,\r
- orgFileDataSize\r
- );\r
- }\r
- } else {\r
- ffsHeader.integrityCheck.file = FFS_FIXED_CHECKSUM;\r
- orgFfsHeader.integrityCheck.file = FFS_FIXED_CHECKSUM;\r
- }\r
-\r
- //\r
- // Set the state now. Spec says the checksum assumes the state is 0.\r
- //\r
- ffsHeader.ffsState = EFI_FILE_HEADER_CONSTRUCTION | \r
- EFI_FILE_HEADER_VALID | \r
- EFI_FILE_DATA_VALID;\r
- orgFfsHeader.ffsState = ffsHeader.ffsState;\r
- \r
- //\r
- // create output stream to first write header data in file, then write sect data in file.\r
- //\r
- FileOutputStream headerFfs = new FileOutputStream (ffsFile.getAbsolutePath());\r
- DataOutputStream ffsBuffer = new DataOutputStream (headerFfs);\r
- \r
- FileOutputStream orgHeaderFfs = new FileOutputStream (ffsOrgFile.getAbsolutePath());\r
- DataOutputStream orgFfsBuffer = new DataOutputStream (orgHeaderFfs);\r
- \r
- //\r
- // Add header struct and file data to FFS file\r
- //\r
- ffsBuffer.write(ffsHeader.structToBuffer());\r
- orgFfsBuffer.write(orgFfsHeader.structToBuffer());\r
- \r
- for (int i = 0; i< fileDataSize; i++) {\r
- ffsBuffer.write(fileBuffer[i]);\r
- }\r
- \r
- for (int i = 0; i < orgFileDataSize; i++){\r
- orgFfsBuffer.write(orgFileBuffer[i]);\r
- }\r
-\r
- //\r
- // If there is a tail, then set it\r
- //\r
- if ((this.attributes & FFS_ATTRIB_TAIL_PRESENT) != 0) {\r
- short tailValue ;\r
- byte [] tailByte = new byte[2];\r
-\r
- //\r
- // reverse tailvalue , integritycheck.file as hight byte, and \r
- // integritycheck.header as low byte.\r
- //\r
- tailValue = (short)(ffsHeader.integrityCheck.header & 0xff);\r
- tailValue = (short)((tailValue) | ((ffsHeader.integrityCheck.file << 8) & 0xff00)); \r
- tailValue = (short)~tailValue;\r
-\r
- //\r
- // Change short to byte[2]\r
- //\r
- tailByte[0] = (byte)(tailValue & 0xff);\r
- tailByte[1] = (byte)((tailValue & 0xff00)>>8); \r
- ffsBuffer.write(tailByte[0]);\r
- ffsBuffer.write(tailByte[1]);\r
- \r
- orgFfsBuffer.write(tailByte[0]);\r
- orgFfsBuffer.write(tailByte[1]);\r
- }\r
-\r
- //\r
- // close output stream. Note if don't close output stream \r
- // the buffer can't be rewritten to file. \r
- //\r
- ffsBuffer.close();\r
- orgFfsBuffer.close();\r
- System.out.print ("Successful create ffs file!\n");\r
- } catch (Exception e) {\r
- throw new BuildException (e.getMessage());\r
- }\r
+ String ffsFilePath = outputPath + this.ffsFileGuid + '-' + this.baseName + ffsSuffix;\r
+ File ffsFile = new File (ffsFilePath);\r
+ genFfs(ffsFile);\r
} \r
\r
/**\r
This function is to get the ffsAligment\r
@return The value of ffsAligment.\r
**/\r
- public int getFfsAligment() {\r
- return this.ffsAlignment;\r
+ public int getFfsAttribDataAlignment() {\r
+ return this.ffsAttribDataAlignment;\r
}\r
\r
/**\r
This function is to set ffsAligment \r
@param ffsAligment The value of ffsAligment.\r
**/\r
- public void setFfsAligment(int ffsAligment) {\r
- this.ffsAlignment = ffsAligment;\r
- if (this.ffsAlignment > 7) {\r
- throw new BuildException ("FFS_ALIGMENT Scope is 0-7");\r
+ public void setFfsAttribDataAlignment(String ffsAligment) {\r
+ this.ffsAttribDataAlignment = stringToInt(ffsAligment.replaceAll(" ", "").toLowerCase());\r
+ if (this.ffsAttribDataAlignment < 0 || this.ffsAttribDataAlignment > 7) {\r
+ throw new BuildException ("FFS_ATTRIB_DATA_ALIGMENT must be an integer value from 0 through 7, inclusive");\r
} else {\r
- attributes |= (((byte)this.ffsAlignment) << 3);\r
+ attributes |= (((byte)this.ffsAttribDataAlignment) << 3);\r
}\r
}\r
\r
\r
byte[] buffer = new byte[16];\r
if (GuidStr.length()!=36) {\r
- throw new BuildException ("Guid length is not correct!");\r
+ throw new BuildException ("The GUID length [" + GuidStr.length() + "] is not correct!");\r
}\r
\r
\r
SplitStr = GuidStr.split("-");\r
if (SplitStr.length != 5) {\r
- throw new BuildException ("Guid type is not correct!");\r
+ throw new BuildException ("The GUID format is not correct!");\r
}\r
\r
\r
this.outputDir = outputDir;\r
}\r
\r
+ /**\r
+ getModuleTyp\r
+ \r
+ This function is to get string of module type.\r
+ \r
+ @return moduleType The string of module type.\r
+ **/\r
public String getModuleType() {\r
return this.moduleType;\r
}\r
\r
+ /**\r
+ setModuleType\r
+ \r
+ This function is to set moduleType.\r
+ \r
+ @param moduleType The string of module type.\r
+ **/\r
public void setModuleType(String moduleType) {\r
this.moduleType = moduleType;\r
}\r
+ \r
+ /**\r
+ Convert a string to a integer.\r
+ \r
+ @param intString The string representing a integer\r
+ \r
+ @retval int The value of integer represented by the\r
+ given string; -1 is returned if the format\r
+ of the string is wrong.\r
+ **/\r
+ private int stringToInt(String intString) {\r
+ int value;\r
+ int hexPrefixPos = intString.indexOf("0x");\r
+ int radix = 10;\r
+ String intStringNoPrefix;\r
+\r
+ if (hexPrefixPos >= 0) {\r
+ radix = 16;\r
+ intStringNoPrefix = intString.substring(hexPrefixPos + 2, intString.length());\r
+ } else {\r
+ intStringNoPrefix = intString;\r
+ }\r
+\r
+ try {\r
+ value = Integer.parseInt(intStringNoPrefix, radix);\r
+ } catch (NumberFormatException e) {\r
+ log("Incorrect format of int [" + intString + "]. -1 is assumed");\r
+ return -1;\r
+ }\r
+\r
+ return value;\r
+ }\r
+ \r
+ /**\r
+ genFfs\r
+ \r
+ This function is to generate FFS file.\r
+ \r
+ @param ffsFile Name of FFS file.\r
+ @param isOrg Flag to indicate generate ORG ffs file or not.\r
+ **/\r
+ private void genFfs(File ffsFile) {\r
+ Section sect;\r
+ int fileSize;\r
+ int fileDataSize;\r
+ FfsHeader ffsHeader = new FfsHeader(); \r
+ FfsHeader orgFfsHeader = new FfsHeader();\r
+ \r
+ EdkLog.log(EdkLog.EDK_INFO, ffsFile.getName());\r
+ \r
+ try {\r
+ //\r
+ // Create file output stream -- dataBuffer.\r
+ //\r
+ FileOutputStream dataFs = new FileOutputStream (ffsFile.getAbsolutePath());\r
+ DataOutputStream dataBuffer = new DataOutputStream (dataFs);\r
+ \r
+ //\r
+ // Search SectionList find earch section and call it's \r
+ // ToBuffer function.\r
+ //\r
+ Iterator sectionIter = this.sectionList.iterator();\r
+ while (sectionIter.hasNext()) {\r
+ sect = (Section)sectionIter.next(); \r
+\r
+ try {\r
+ //\r
+ // The last section don't need 4 byte ffsAligment.\r
+ //\r
+ sect.toBuffer((DataOutputStream)dataBuffer);\r
+ } catch (Exception e) {\r
+ throw new BuildException (e.getMessage());\r
+ }\r
+ }\r
+ dataBuffer.close();\r
+ } catch (Exception e) {\r
+ throw new BuildException (e.getMessage());\r
+ }\r
+\r
+ //\r
+ // Creat Ffs file header\r
+ //\r
+ try {\r
+\r
+ //\r
+ // create input stream to read file data\r
+ //\r
+ byte[] fileBuffer = new byte[(int)ffsFile.length()];\r
+ FileInputStream fi = new FileInputStream (ffsFile.getAbsolutePath());\r
+ DataInputStream di = new DataInputStream (fi);\r
+ di.read(fileBuffer);\r
+ di.close();\r
+ \r
+ //\r
+ // Add GUID to header struct\r
+ //\r
+ if (this.ffsFileGuid != null) {\r
+ stringToGuid (this.ffsFileGuid, ffsHeader.name);\r
+ }\r
+\r
+ ffsHeader.ffsAttributes = this.attributes;\r
+ if ((ffsHeader.fileType = stringToType(this.ffsFileType))== -1) {\r
+ throw new BuildException ("FFS_FILE_TYPE unknow!\n");\r
+ }\r
+ \r
+ //\r
+ // Copy ffsHeader.ffsAttribute and fileType to orgFfsHeader.ffsAttribute\r
+ // and fileType\r
+ // \r
+ orgFfsHeader.ffsAttributes = ffsHeader.ffsAttributes;\r
+ orgFfsHeader.fileType = ffsHeader.fileType;\r
+ \r
+ //\r
+ // Adjust file size. The function is used to tripe the last \r
+ // section padding of 4 binary boundary. \r
+ // \r
+ //\r
+ if (ffsHeader.fileType != EFI_FV_FILETYPE_RAW) {\r
+\r
+ fileDataSize = adjustFileSize (fileBuffer);\r
+ } else {\r
+ fileDataSize = fileBuffer.length;\r
+ }\r
+\r
+ //\r
+ // 1. add header size to file size\r
+ //\r
+ fileSize = fileDataSize + ffsHeader.getSize();\r
+\r
+ if ((ffsHeader.ffsAttributes & FFS_ATTRIB_TAIL_PRESENT) != 0) {\r
+ if (ffsHeader.fileType == EFI_FV_FILETYPE_FFS_PAD) {\r
+\r
+ throw new BuildException (\r
+ "FFS_ATTRIB_TAIL_PRESENT=TRUE is " +\r
+ "invalid for PAD files"\r
+ );\r
+ }\r
+ if (fileSize == ffsHeader.getSize()) {\r
+ throw new BuildException (\r
+ "FFS_ATTRIB_TAIL_PRESENT=TRUE is " +\r
+ "invalid for 0-length files"\r
+ ); \r
+ }\r
+ fileSize = fileSize + 2;\r
+ }\r
+\r
+ //\r
+ // 2. set file size to header struct\r
+ //\r
+ ffsHeader.ffsFileSize[0] = (byte)(fileSize & 0x00FF);\r
+ ffsHeader.ffsFileSize[1] = (byte)((fileSize & 0x00FF00)>>8);\r
+ ffsHeader.ffsFileSize[2] = (byte)(((int)fileSize & 0xFF0000)>>16);\r
+ \r
+ //\r
+ // Fill in checksums and state, these must be zero for checksumming\r
+ //\r
+ ffsHeader.integrityCheck.header = calculateChecksum8 (\r
+ ffsHeader.structToBuffer(),\r
+ ffsHeader.getSize()\r
+ );\r
+ \r
+ if ((this.attributes & FFS_ATTRIB_CHECKSUM) != 0) {\r
+ if ((this.attributes & FFS_ATTRIB_TAIL_PRESENT) != 0) {\r
+ ffsHeader.integrityCheck.file = calculateChecksum8 (\r
+ fileBuffer, \r
+ fileDataSize\r
+ );\r
+ } else {\r
+ ffsHeader.integrityCheck.file = calculateChecksum8 (\r
+ fileBuffer,\r
+ fileDataSize\r
+ );\r
+ }\r
+ } else {\r
+ ffsHeader.integrityCheck.file = FFS_FIXED_CHECKSUM;\r
+ orgFfsHeader.integrityCheck.file = FFS_FIXED_CHECKSUM;\r
+ }\r
+\r
+ //\r
+ // Set the state now. Spec says the checksum assumes the state is 0.\r
+ //\r
+ ffsHeader.ffsState = EFI_FILE_HEADER_CONSTRUCTION | \r
+ EFI_FILE_HEADER_VALID | \r
+ EFI_FILE_DATA_VALID;\r
+ \r
+ //\r
+ // create output stream to first write header data in file, then write sect data in file.\r
+ //\r
+ FileOutputStream headerFfs = new FileOutputStream (ffsFile.getAbsolutePath());\r
+ DataOutputStream ffsBuffer = new DataOutputStream (headerFfs);\r
+ \r
+ //\r
+ // Add header struct and file data to FFS file\r
+ //\r
+ ffsBuffer.write(ffsHeader.structToBuffer());\r
+ ffsBuffer.write(fileBuffer, 0, fileDataSize);\r
+ \r
+\r
+\r
+ //\r
+ // If there is a tail, then set it\r
+ //\r
+ if ((this.attributes & FFS_ATTRIB_TAIL_PRESENT) != 0) {\r
+ short tailValue ;\r
+ byte [] tailByte = new byte[2];\r
+\r
+ //\r
+ // reverse tailvalue , integritycheck.file as hight byte, and \r
+ // integritycheck.header as low byte.\r
+ //\r
+ tailValue = (short)(ffsHeader.integrityCheck.header & 0xff);\r
+ tailValue = (short)((tailValue) | ((ffsHeader.integrityCheck.file << 8) & 0xff00)); \r
+ tailValue = (short)~tailValue;\r
+\r
+ //\r
+ // Change short to byte[2]\r
+ //\r
+ tailByte[0] = (byte)(tailValue & 0xff);\r
+ tailByte[1] = (byte)((tailValue & 0xff00)>>8); \r
+ ffsBuffer.write(tailByte[0]);\r
+ ffsBuffer.write(tailByte[1]);\r
+\r
+ }\r
+\r
+ //\r
+ // close output stream. Note if don't close output stream \r
+ // the buffer can't be rewritten to file. \r
+ //\r
+ ffsBuffer.close();\r
+ } catch (Exception e) {\r
+ log("genffsfile failed!");\r
+ throw new BuildException (e.getMessage());\r
+ }\r
+\r
+ }\r
}\r
projects / mirror_edk2.git / blobdiff