e2dd851c4f022dbe87c64c605acbf39403098246
[keystone-rtos/rm-lld.git] / package.bld
1 /******************************************************************************\r
2  * FILE PURPOSE: Build description for the RM LLD Package\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 RM LLD\r
8  *  \r
9  *  The file takes the following parameters from the command line through the\r
10  *  XDCARGS variable.\r
11  *      XDCARGS[0] = RM LLD 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) 2012, Texas Instruments, Inc.\r
19  *****************************************************************************/\r
20 \r
21 /* Determine if we need to create the InstallJammer Application or not? \r
22  * RM LLD Deliverables be either of the following formats:\r
23  *  - TAR Ball Package\r
24  *  - Setup Executable \r
25  * DEFAULT is a TAR Executable. */\r
26 \r
27 if ((arguments[0] != "TAR") && (arguments[0] != "SETUP"))\r
28     lldInstallType = "TAR";\r
29 else\r
30     lldInstallType = arguments[0];\r
31 \r
32 /* Irrespective of the InstallType we always create a TAR Ball Package as a part\r
33  * of the RTSC Build. Here we determine the name of the TAR Ball Package\r
34  *  Format is as follows:\r
35  *      lld_<version> */\r
36 var lldRTSCFileName = "rmlld" + "_" + lldPartNumber + "_" +\r
37                       lldReleaseVersion[0] + "_" +  lldReleaseVersion[1] + "_" + \r
38                       lldReleaseVersion[2]  + "_" + lldReleaseVersion[3];\r
39 \r
40 /******************************************************************\r
41  ************************ Release Banner **************************\r
42  ******************************************************************/\r
43 \r
44 print ("*************** RM LLD Build Information ****************");\r
45 print ("RM LLD Install           : " + lldInstallType);\r
46 print ("RM LLD Version           : " + lldReleaseVersion);\r
47 print ("Tools Directory            : " + toolsBaseDir);\r
48 print ("RTSC File Name             : " + lldRTSCFileName);\r
49 print ("RM LLD Path              : " + lldPath);\r
50 print ("Coverity Analysis          : " + (coverityAnalysis == "ON" ? "ON" : "OFF"));\r
51 print ("CC LE opts                 : " + C66LE.ccOpts.prefix);\r
52 print ("CC BE opts                 : " + C66BE.ccOpts.prefix);\r
53 print ("***********************************************************");\r
54 \r
55 /* Create the release package for the RM LLD */\r
56 Pkg.defaultRelease = Pkg.addRelease (lldRTSCFileName, {prefix: "./packages/"});\r
57 \r
58 /* Moving forward we need to set the Archiver of the package to be ZIP. This is currently\r
59  * not supported in the XDC tools being used. Currenly builds need to be done with the \r
60  * following options:-\r
61  *   xdc MK_FIXLISTOPTS=-t release \r
62  * ZIP is a better option as it works natively with INSTALL Jammer and we can remove the\r
63  * uncompression into a temporary directory. XDC Tools with xdc-rXX support the ZIP archiver. */\r
64 //Pkg.attrs = {archiver : "zip"};\r
65 \r
66 \r
67 /* Package the remaining files */\r
68 Pkg.otherFiles[Pkg.otherFiles.length++] = "config.bld";\r
69 Pkg.otherFiles[Pkg.otherFiles.length++] = "package.bld";\r
70 Pkg.otherFiles[Pkg.otherFiles.length++] = "package.xdc";\r
71 Pkg.otherFiles[Pkg.otherFiles.length++] = "Settings.xdc";\r
72 Pkg.otherFiles[Pkg.otherFiles.length++] = "Settings.xdc.xdt";\r
73 Pkg.otherFiles[Pkg.otherFiles.length++] = "rm_public_lld.h";\r
74 Pkg.otherFiles[Pkg.otherFiles.length++] = "rmver.h";\r
75 Pkg.otherFiles[Pkg.otherFiles.length++] = "rmver.h.xdt";\r
76 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/Doxyfile";\r
77 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/doxyfile.xdt";\r
78 Pkg.otherFiles[Pkg.otherFiles.length++] = "build/buildlib.xs";\r
79 \r
80 /* Generate Users Manual Doxyfile */\r
81 var tplt = xdc.loadTemplate("./docs/doxyfile.xdt");\r
82 tplt.genFile("./docs/Doxyfile",lldReleaseVersion); \r
83 \r
84 /* Generate Settings.xdc */\r
85 var tplt = xdc.loadTemplate("./Settings.xdc.xdt");\r
86 tplt.genFile("./Settings.xdc",lldReleaseVersion); \r
87 \r
88 /* Generate paver.h */\r
89 var tplt = xdc.loadTemplate("./rmver.h.xdt");\r
90 tplt.genFile("./rmver.h",lldReleaseVersion);      \r
91 \r
92 /* Check if we need to create the mini package? */\r
93 var miniBuild = java.lang.System.getenv("MINI_PACKAGE");\r
94 \r
95 if (miniBuild == "ON")\r
96 {\r
97     /***************************************************************************\r
98      ********************************* MINI Package ****************************\r
99      ***************************************************************************/\r
100     /* Create the MINI RTSC Package */\r
101     var libUtility = xdc.loadCapsule ("build/buildlib.xs");\r
102     libUtility.createMiniPkg(lldRTSCFileName);\r
103 }\r
104 \r
105 /********************************************************************* \r
106  *********************** INSTALL-JAMMER Support **********************\r
107  * In order to create the InstallJammer Application; we need to UNTAR\r
108  * the package into a temporary directory. This is required because \r
109  * currently the InstallJammer does not support the TAR Files and thus\r
110  * creating an UNTAR of the file. So to work-around the problem we will\r
111  * do the following in the EPILOGUE Section:-\r
112  *  (a) Create a temporary directory called 'tmp'\r
113  *  (b) UNTAR the package into 'tmp'\r
114  *  (c) Run the INSTALL Jammer on 'tmp'\r
115  *  (d) Remove the 'tmp' directory.\r
116  *\r
117  * This can be done only after the 'release' package has been created.\r
118  * Thus all of this work is being done in the EPILOGUE.\r
119  *********************************************************************/\r
120 if (lldInstallType == "SETUP")\r
121 {\r
122     /* Create the Install Jammer Version Variable. This is used inside the \r
123      * MPI File to create the Final executable. \r
124      *  The format supported is as follows:-\r
125      *   - setupwin32_rmlld_<part_number>_<version>.exe \r
126      *      This is for RM LLD Libraries and Header files\r
127      */\r
128     var InstallJammerVersion = "-DVersion " + lldPartNumber + "_" + lldReleaseVersion[0] + "_" +\r
129                                lldReleaseVersion[1] + "_" +  lldReleaseVersion[2]  + "_" + lldReleaseVersion[3];\r
130 \r
131     /* This is the location where the tmp directory is located; this is used as \r
132      * the input directory for the Install Jammer. */ \r
133     var PackageBaseDir = " -DPackageBaseDir " + lldPath + "./tmp";\r
134 \r
135     /* This is the location where the RM LLD will be installed by default. */\r
136     var WinInstallDir = " -DWinInstallDir C:/Program Files/Texas Instruments/rmlld" + "_" + \r
137                             lldPartNumber + "_" + \r
138                             lldReleaseVersion[0] + "_" +  lldReleaseVersion[1] + "_" +  \r
139                             lldReleaseVersion[2]  + "_" + lldReleaseVersion[3];\r
140 \r
141     /* Create the actual EPILOGUE Section for the INSTALLER */\r
142     Pkg.makeEpilogue += "release: install_application\n";\r
143     Pkg.makeEpilogue += "install_application:\n";\r
144     Pkg.makeEpilogue += "\t @echo -------------------------------------------------------\n";\r
145     Pkg.makeEpilogue += "\t @echo Creating the Install\n";\r
146     Pkg.makeEpilogue += "\t @echo -------------------------------------------------------\n";\r
147     Pkg.makeEpilogue += "\t -$(MKDIR) tmp\n";\r
148     Pkg.makeEpilogue += "\t -$(MKDIR) tmp/packages\n";\r
149     Pkg.makeEpilogue += "\t -$(MKDIR) tmp/eclipse\n";\r
150     Pkg.makeEpilogue += "\t -$(CP) -R eclipse tmp\n";\r
151     Pkg.makeEpilogue += "\t tar -xf ./packages/" + lldRTSCFileName + ".tar" + " -Ctmp/packages \n";\r
152     Pkg.makeEpilogue += "\t installjammer " + InstallJammerVersion + PackageBaseDir + WinInstallDir + \r
153                         " --output-dir packages/ --build install/rmlld.mpi\n";\r
154     Pkg.makeEpilogue += "\t -$(RMDIR) /S /Q tmp\n\n";\r
155 \r
156     /* We need to clean after ourselves; extend the 'clean' target to take care of this. */\r
157     Pkg.makeEpilogue += "clean::\n";\r
158     Pkg.makeEpilogue += "\t $(RM) packages/*.exe\n";\r
159     Pkg.makeEpilogue += "\t $(RM) packages/*.bin\n";\r
160 }\r
161     \r