Merge pull request #3 in PROCESSOR-SDK/traceframework from CATREQ-2702 to master
[keystone-rtos/traceframework.git] / package.bld
1 /******************************************************************************\r
2  * FILE PURPOSE: Build description for the TraceFramework Driver\r
3  ******************************************************************************\r
4  * FILE NAME: package.bld\r
5  *\r
6  * DESCRIPTION: \r
7  *  This file contains the build specification and description for the TraceFramework driver\r
8  *  \r
9  *  The file takes the following parameters from the command line through the\r
10  *  XDCARGS variable.\r
11  *      XDCARGS[0] = TraceFramework Driver Install Type \r
12  *      Valid Values are "TAR" or "SETUP"\r
13  *      DEFAULT is "SETUP"\r
14  *\r
15  *  Example for a valid command:\r
16  *      xdc XDCARGS="SETUP" release   \r
17  *\r
18  * Copyright (C) 2009, Texas Instruments, Inc.\r
19  *****************************************************************************/\r
20 \r
21 /* List of all subdirectories that combine to make the TraceFramework Driver Package. */\r
22 /* var subDirectories = [ "src", "docs", "include", "test", "example" ]; */\r
23 var subDirectories = [ "src", "docs", "test"];\r
24 \r
25 var tfDriverInstallType;\r
26 \r
27 /* Determine if we need to create the InstallJammer Application or not? \r
28  * TraceFramework LLD Deliverables be either of the following formats:\r
29  *  - TAR Ball Package\r
30  *  - Setup Executable \r
31  * DEFAULT is a SETUP Executable. */\r
32 \r
33 if ((arguments[0] != "TAR") && (arguments[0] != "SETUP"))\r
34     tfDriverInstallType = "TAR";\r
35 else\r
36     tfDriverInstallType = arguments[0];\r
37 \r
38 /* Irrespective of the InstallType we always create a TAR Ball Package as a part\r
39  * of the RTSC Build. Here we determine the name of the TAR Ball Package\r
40  *  Format is as follows:\r
41  *      tf_<version> */\r
42 var tfRTSCFileName = "tf" + "_" + tfLLDPartNumber + "_" + \r
43                       tfDriverReleaseVersion[0] + "_" +  tfDriverReleaseVersion[1] + "_" + \r
44                       tfDriverReleaseVersion[2]  + "_" + tfDriverReleaseVersion[3];\r
45 \r
46 /******************************************************************\r
47  ************************ Release Banner **************************\r
48  ******************************************************************/\r
49 \r
50 print ("************* TraceFramework  Driver Build Information *************");\r
51 print ("TraceFramework Driver Install      : " + tfDriverInstallType);\r
52 print ("TraceFramework Driver LLD Version  : " + tfDriverReleaseVersion);\r
53 print ("Tools Directory                 : " + toolsBaseDir);\r
54 print ("RTSC File Name                  : " + tfRTSCFileName);\r
55 print ("TraceFramework Driver LLD Path     : " + tfDriverPath);\r
56 print ("Coverity Analysis               : " + (coverityAnalysis == "ON" ? "ON" : "OFF"));\r
57 print ("CC LE opts                      : " + C66LE.ccOpts.prefix);\r
58 print ("****************************************************************");\r
59 \r
60 /* Create the release package for the TraceFramework LLD */\r
61 Pkg.defaultRelease = Pkg.addRelease (tfRTSCFileName, {prefix: "./packages/"});\r
62 \r
63 /* If need to debug TraceFramework LLD, set profile to debug */\r
64 /* Pkg.attrs.profile = 'debug'; */\r
65 \r
66 /* Moving forward we need to set the Archiver of the package to be ZIP. This is currently\r
67  * not supported in the XDC tools being used. Currenly builds need to be done with the \r
68  * following options:-\r
69  *   xdc MK_FIXLISTOPTS=-t release \r
70  * ZIP is a better option as it works natively with INSTALL Jammer and we can remove the\r
71  * uncompression into a temporary directory. XDC Tools with xdc-rXX support the ZIP archiver. */\r
72 //Pkg.attrs = {archiver : "zip"};\r
73 \r
74 /* Cycle through all the sub-directories and build all the files */\r
75 for (var i = 0; i < subDirectories.length; i++) \r
76 {\r
77     /* Load the capsule in the sub directory. */\r
78     var caps = xdc.loadCapsule (subDirectories[i]+"/Module.xs");\r
79 \r
80     print ("Building directory " + subDirectories[i]);\r
81 \r
82     /* Build the capsule. */\r
83     caps.modBuild();\r
84 \r
85     /* Package the module.xs files for building via package */\r
86     Pkg.otherFiles[Pkg.otherFiles.length++] = subDirectories[i]+"/Module.xs";\r
87 }\r
88 \r
89 /* Package the remaining files */\r
90 Pkg.otherFiles[Pkg.otherFiles.length++] = "config.bld";\r
91 Pkg.otherFiles[Pkg.otherFiles.length++] = "package.bld";\r
92 Pkg.otherFiles[Pkg.otherFiles.length++] = "package.xdc";\r
93 Pkg.otherFiles[Pkg.otherFiles.length++] = "package.xs";\r
94 Pkg.otherFiles[Pkg.otherFiles.length++] = "Settings.xdc";\r
95 Pkg.otherFiles[Pkg.otherFiles.length++] = "Settings.xdc.xdt";\r
96 Pkg.otherFiles[Pkg.otherFiles.length++] = "traceframework.h";\r
97 Pkg.otherFiles[Pkg.otherFiles.length++] = "makefile_armv7";\r
98 Pkg.otherFiles[Pkg.otherFiles.length++] = "trace_contract.h";\r
99 Pkg.otherFiles[Pkg.otherFiles.length++] = "contract_osal.h";\r
100 Pkg.otherFiles[Pkg.otherFiles.length++] = "consumer_osal.h";\r
101 Pkg.otherFiles[Pkg.otherFiles.length++] = "producer_osal.h";\r
102 Pkg.otherFiles[Pkg.otherFiles.length++] = "producer.h";\r
103 Pkg.otherFiles[Pkg.otherFiles.length++] = "consumer.h";\r
104 Pkg.otherFiles[Pkg.otherFiles.length++] = "tf_types.h";\r
105 Pkg.otherFiles[Pkg.otherFiles.length++] = "tfver.h";\r
106 Pkg.otherFiles[Pkg.otherFiles.length++] = "tfver.h.xdt";\r
107 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/Doxyfile";\r
108 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/doxyfile.xdt";\r
109 Pkg.otherFiles[Pkg.otherFiles.length++] = "build/buildlib.xs";\r
110 Pkg.otherFiles[Pkg.otherFiles.length++] = "build/armv7/libtf_aearmv7.mk";\r
111 Pkg.otherFiles[Pkg.otherFiles.length++] = "test/TFUnitTest/src/c66x/bios/c66xelflinkcmd.xdt";\r
112 Pkg.otherFiles[Pkg.otherFiles.length++] = "metadata/cuia.rta.xml";\r
113 Pkg.otherFiles[Pkg.otherFiles.length++] = "metadata/cuia.uia.xml";\r
114 Pkg.otherFiles[Pkg.otherFiles.length++] = "makefile";\r
115 \r
116 /* Generate Users Manual Doxyfile */\r
117 var tplt = xdc.loadTemplate("./docs/doxyfile.xdt");\r
118 tplt.genFile("./docs/Doxyfile",tfDriverReleaseVersion); \r
119 \r
120 /* Generate Settings.xdc */\r
121 var tplt = xdc.loadTemplate("./Settings.xdc.xdt");\r
122 tplt.genFile("./Settings.xdc",tfDriverReleaseVersion); \r
123 \r
124 /* Generate paver.h */\r
125 var tplt = xdc.loadTemplate("./tfver.h.xdt");\r
126 tplt.genFile("./tfver.h",tfDriverReleaseVersion);      \r
127 \r
128 /* Check if we need to create the mini package? */\r
129 var miniBuild = java.lang.System.getenv("MINI_PACKAGE");\r
130 \r
131 if (miniBuild == "ON")\r
132 {\r
133     /***************************************************************************\r
134      ********************************* MINI Package ****************************\r
135      ***************************************************************************/\r
136     /* Create the MINI RTSC Package */\r
137     var libUtility = xdc.loadCapsule ("build/buildlib.xs");\r
138     libUtility.createMiniPkg(tfRTSCFileName);\r
139 }\r
140 \r
141 /********************************************************************* \r
142  *********************** INSTALL-JAMMER Support **********************\r
143  * In order to create the InstallJammer Application; we need to UNTAR\r
144  * the package into a temporary directory. This is required because \r
145  * currently the InstallJammer does not support the TAR Files and thus\r
146  * creating an UNTAR of the file. So to work-around the problem we will\r
147  * do the following in the EPILOGUE Section:-\r
148  *  (a) Create a temporary directory called 'tmp'\r
149  *  (b) UNTAR the package into 'tmp'\r
150  *  (c) Run the INSTALL Jammer on 'tmp'\r
151  *  (d) Remove the 'tmp' directory.\r
152  *\r
153  * This can be done only after the 'release' package has been created.\r
154  * Thus all of this work is being done in the EPILOGUE.\r
155  *********************************************************************/\r
156 if (tfDriverInstallType == "SETUP")\r
157 {\r
158     /* Create the Install Jammer Version Variable. This is used inside the \r
159      * MPI File to create the Final executable. \r
160      *  The format supported is as follows:-\r
161      *   - setupwin32_tf_<device>_<version>.exe \r
162      */\r
163     var InstallJammerVersion = "-DVersion " + tfLLDPartNumber + "_" + \r
164                                tfDriverReleaseVersion[0] + "_" + tfDriverReleaseVersion[1] + "_" +  \r
165                                tfDriverReleaseVersion[2] + "_" + tfDriverReleaseVersion[3];\r
166 \r
167     /* This is the location where the tmp directory is located; this is used as \r
168      * the input directory for the Install Jammer. */ \r
169     var PackageBaseDir = " -DPackageBaseDir " + tfDriverPath + "./tmp";\r
170 \r
171     /* This is the location where the TraceFramework LLD will be installed by default. */\r
172     var WinInstallDir = " -DWinInstallDir C:/Program Files/Texas Instruments/tf" + "_" + \r
173                             tfLLDPartNumber + "_" + \r
174                             tfDriverReleaseVersion[0] + "_" +  tfDriverReleaseVersion[1] + "_" +  \r
175                             tfDriverReleaseVersion[2]  + "_" + tfDriverReleaseVersion[3];\r
176 \r
177     /* Create the actual EPILOGUE Section for the INSTALLER */\r
178     Pkg.makeEpilogue += "release: install_application\n";\r
179     Pkg.makeEpilogue += "install_application:\n";\r
180     Pkg.makeEpilogue += "\t @echo -------------------------------------------------------\n";\r
181     Pkg.makeEpilogue += "\t @echo Creating the Install\n";\r
182     Pkg.makeEpilogue += "\t @echo -------------------------------------------------------\n";\r
183     Pkg.makeEpilogue += "\t -$(MKDIR) tmp\n";\r
184     Pkg.makeEpilogue += "\t -$(MKDIR) tmp/packages\n";\r
185     Pkg.makeEpilogue += "\t -$(MKDIR) tmp/eclipse\n";\r
186     Pkg.makeEpilogue += "\t -$(CP) -R eclipse tmp\n";\r
187     Pkg.makeEpilogue += "\t tar -xf ./packages/" + tfRTSCFileName + ".tar" + " -Ctmp/packages \n";\r
188     Pkg.makeEpilogue += "\t installjammer " + InstallJammerVersion + PackageBaseDir + WinInstallDir + \r
189                         " --output-dir packages/ --build install/tflld.mpi\n";\r
190     Pkg.makeEpilogue += "\t -$(RMDIR) /S /Q tmp\n\n";\r
191 \r
192     /* We need to clean after ourselves; extend the 'clean' target to take care of this. */\r
193     Pkg.makeEpilogue += "clean::\n";\r
194     Pkg.makeEpilogue += "\t -$(RM) docs/Doxyfile Settings.xdc tfver.h\n";\r
195     Pkg.makeEpilogue += "\t -$(RM) makefile\n";\r
196     Pkg.makeEpilogue += "\t -$(RMDIR) docs/doxygen\n";\r
197     Pkg.makeEpilogue += "\t $(RM) packages/*.exe\n";\r
198     Pkg.makeEpilogue += "\t $(RM) packages/*.bin\n";\r
199 }\r
200     \r