[processor-sdk/performance-audio-sr.git] / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / utils / Build-src.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html><head><title>module ti.sdo.utils.Build</title>
3 <meta name="googlebot" content="noindex,nofollow">
4 <link rel="stylesheet" type="text/css" href="../../../src.css"/>
5 </head>
6 <body>
7 <pre class=src>
8 1 <span class="comment">/*
9 </span> 2 <span class="comment"> * Copyright (c) 2012-2013, Texas Instruments Incorporated
10 </span> 3 <span class="comment"> * All rights reserved.
11 </span> 4 <span class="comment"> *
12 </span> 5 <span class="comment"> * Redistribution and use in source and binary forms, with or without
13 </span> 6 <span class="comment"> * modification, are permitted provided that the following conditions
14 </span> 7 <span class="comment"> * are met:
15 </span> 8 <span class="comment"> *
16 </span> 9 <span class="comment"> * * Redistributions of source code must retain the above copyright
17 </span> 10 <span class="comment"> * notice, this list of conditions and the following disclaimer.
18 </span> 11 <span class="comment"> *
19 </span> 12 <span class="comment"> * * Redistributions in binary form must reproduce the above copyright
20 </span> 13 <span class="comment"> * notice, this list of conditions and the following disclaimer in the
21 </span> 14 <span class="comment"> * documentation and/or other materials provided with the distribution.
22 </span> 15 <span class="comment"> *
23 </span> 16 <span class="comment"> * * Neither the name of Texas Instruments Incorporated nor the names of
24 </span> 17 <span class="comment"> * its contributors may be used to endorse or promote products derived
25 </span> 18 <span class="comment"> * from this software without specific prior written permission.
26 </span> 19 <span class="comment"> *
27 </span> 20 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28 </span> 21 <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29 </span> 22 <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 </span> 23 <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31 </span> 24 <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 </span> 25 <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 </span> 26 <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
34 </span> 27 <span class="comment"> * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
35 </span> 28 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
36 </span> 29 <span class="comment"> * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
37 </span> 30 <span class="comment"> * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 </span> 31 <span class="comment"> */</span>
39 32
40 33 <span class="comment">/*
41 </span> 34 <span class="comment"> * ======== Build.xdc ========
42 </span> 35 <span class="comment"> * @_nodoc
43 </span> 36 <span class="comment"> * metaonly module to support building various package/product libraries
44 </span> 37 <span class="comment"> *
45 </span> 38 <span class="comment"> */</span>
46 39
47 40 <span class="xdoc">/*!
48 </span> 41 <span class="xdoc"> * ======== Build ========
49 </span> 42 <span class="xdoc"> */</span>
50 43
51 44 @Template(<span class="string">"./Build.xdt"</span>)
52 45 <span class=key>metaonly</span> <span class=key>module</span> Build
53 46 {
54 47
55 48 <span class="xdoc">/*!
56 </span> 49 <span class="xdoc"> * ======== doBuild ========
57 </span> 50 <span class="xdoc"> */</span>
58 51 <span class=key>config</span> Bool doBuild = <span class=key>true</span>;
59 52
60 53 <span class="xdoc">/*!
61 </span> 54 <span class="xdoc"> * ======== libDir ========
62 </span> 55 <span class="xdoc"> */</span>
63 56 <span class=key>config</span> String libDir = <span class=key>null</span>;
64 57
65 58 <span class="xdoc">/*!
66 </span> 59 <span class="xdoc"> * ======== getDefaultCustomCCOpts ========
67 </span> 60 <span class="xdoc"> */</span>
68 61 String getDefaultCustomCCOpts();
69 62
70 63 <span class="xdoc">/*!
71 </span> 64 <span class="xdoc"> * ======== getDefs ========
72 </span> 65 <span class="xdoc"> * Get the compiler -D options necessary to build
73 </span> 66 <span class="xdoc"> */</span>
74 67 String getDefs();
75 68
76 69 <span class="xdoc">/*!
77 </span> 70 <span class="xdoc"> * ======== getCFiles ========
78 </span> 71 <span class="xdoc"> * Get the library C source files.
79 </span> 72 <span class="xdoc"> */</span>
80 73 String getCFiles(String target);
81 74
82 75 <span class="xdoc">/*!
83 </span> 76 <span class="xdoc"> * ======== getAsmFiles ========
84 </span> 77 <span class="xdoc"> * Get the library Asm source files.
85 </span> 78 <span class="xdoc"> */</span>
86 79 Any getAsmFiles(String target);
87 80
88 81 <span class="comment">/*
89 </span> 82 <span class="comment"> * ======== buildLibs ========
90 </span> 83 <span class="comment"> * This function generates the makefile goals for the libraries
91 </span> 84 <span class="comment"> * produced by a ti.sysbios package.
92 </span> 85 <span class="comment"> */</span>
93 86 <span class=key>function</span> buildLibs(objList, relList, filter, xdcArgs);
94 87
95 88 <span class="xdoc">/*!
96 </span> 89 <span class="xdoc"> * ======== getLibs ========
97 </span> 90 <span class="xdoc"> * Common getLibs() for all ipc packages.
98 </span> 91 <span class="xdoc"> */</span>
99 92 <span class=key>function</span> getLibs(pkg);
100 93 }
101 </pre>
102 </body></html>