Added readme.txt on how to build DSPLIB from git.ti.com source
[ep-processor-libraries/dsplib.git] / ti / dsplib / docs / bundle / doxygen / release.h.xdt
1 %%{ 
2         var target = $args[1];
4   /* Versioning */
5   var quality = ["_pre-alpha","_alpha","_beta",""];
6   var ver = this.version;
7   var ver_string = ver[0] + "_" + ver[1] + "_" + ver[2] + "_" + ver[3] + quality[ver[4]];
9   /* Get UPPER and lower case bundle name */
10   var packageL = this.bundlename;
11   var packageU = this.bundlename.toUpperCase();
13   /* Create documentation names */
14   var userManualHtml = packageU + "_Users_Manual.html";
15   var userManualChm  = packageU + "_Users_Manual.chm";
16   var swManifest     = packageU + "_Software_Manifest.html";
17   switch(target)
18   {
19     case "c66x":
20       var testReport = "DSPLIB_C66x_TestReport.html";
21    break;
22     case "c64Px":
23       var testReport = "DSPLIB_C64Px_TestReport.html";
24    break; 
25     case "c674x":
26       var testReport = "DSPLIB_C674x_TestReport.html";
27    break; 
28   }
29   var releaseNotes   = packageL + "_" + ver_string + "_release_notes.html";
31   /* Create table of supported devices */
32   var TRGCNT  = this.targs.length; 
33   var DEVICES = [];
34   var ENDIANS = [];
35   var FORMATS = [];
36   for (var k=0; k<this.targs.length; k++) {
37     var local_target = String(this.targs[k]).slice(11);
38     /* Get device name */
39     DEVICES[k] = target.replace("c","C");
40     DEVICES[k] = DEVICES[k].replace("Px","x+");
41     /* Get device object file format */
42     FORMATS[k] = "COFF";
43     if (local_target.match("elf")) {
44       FORMATS[k] = "ELF";
45     }
46     /* Get device endian-ness */
47     ENDIANS[k] = "Little-Endian";
48     if (local_target.match("big_endian")) {
49       ENDIANS[k] = "Big-Endian";
50     }
51   }
53   /* Get tool versions */
54   var CGTVER = "8.2.2";
55   var CCSVER = "8.1";
56   var XDCVER = "3.50.05.12";
57 %%}
59 /* ======================================================================== *
60  * DSPLIB -- Doxygen generation header file                                 *
61  *                                                                          *
62  * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/   *
63  *                                                                          *
64  *                                                                          *
65  *  Redistribution and use in source and binary forms, with or without      *
66  *  modification, are permitted provided that the following conditions      *
67  *  are met:                                                                *
68  *                                                                          *
69  *    Redistributions of source code must retain the above copyright        *
70  *    notice, this list of conditions and the following disclaimer.         *
71  *                                                                          *
72  *    Redistributions in binary form must reproduce the above copyright     *
73  *    notice, this list of conditions and the following disclaimer in the   *
74  *    documentation and/or other materials provided with the                *
75  *    distribution.                                                         *
76  *                                                                          *
77  *    Neither the name of Texas Instruments Incorporated nor the names of   *
78  *    its contributors may be used to endorse or promote products derived   *
79  *    from this software without specific prior written permission.         *
80  *                                                                          *
81  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS     *
82  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT       *
83  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR   *
84  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT    *
85  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,   *
86  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT        *
87  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,   *
88  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY   *
89  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT     *
90  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE   *
91  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.    *
92  * ======================================================================== */
94 /**
95  * @mainpage `packageU` Release Notes
96  *
97  * <hr size="2" width="50%" align="left">
98  *
99  * <h2><a name="Contents">Contents</a></h2>
100  *  
101  *  <ol>
102  *    <li> <a href="#Introduction">Introduction</a>
103  *    <li> <a href="#Starting">Getting Started</a>
104  *    <li> <a href="#Documentation">Documentation</a>                          <br>
105  *    <li> <a href="#Whats_New">What's New</a>                                 <br>
106  *    <li> <a href="#Bugs_Fixed">Fixed Bugs</a>                            <br>
107  *    <li> <a href="#Compatibility">Upgrade and Compatibility Information</a>  <br>
108  *    <li> <a href="#Device_Support">Device Support</a>                        <br>
109  *    <li> <a href="#Validation">Validation Information</a>                    <br>
110  *    <li> <a href="#Known_Issues">Known Issues</a>                            <br>
111  *    <li> <a href="#Support">Technical Support</a>                            <br>
112  *  </ol>
113  *  
114  *  
115  * <hr size="2" width="50%" align="left">
116  *
117  * <h2><a name="Introduction">Introduction</a></h2>
118  *
119  *  The TI C6000 DSPLIB is an optimized DSP Function Library for C programmers. It includes many
120  *  C-callable, optimized, general-purpose signal-processing routines. These routines are typically 
121  *  used in computationally-intensive real-time applications where optimal execution speed is critical.
122  *
123  * <hr size="2" width="50%" align="left">
124  *
125  * <h2><a name="Starting">Getting Started</a></h2>
126  *
127  *  The <a href="./docs/DSPLIB_Users_Manual.html">DSPLIB User's Manual</a> provides 
128  *  the documentation and references necessary to integrate DSPLIB Library routines 
129  *  into a development platform.
130  * 
131  *
132  * <hr size="2" width="50%" align="left">
133  *
134  * <h2><a name="Documentation">Documentation</a></h2>
135  *
136  *  The following documentation is available:
137  *
138  *  <table frame="box" rules="all" cellspacing="0" width="50%">
139  *    <tr>
140  *      <td valign="top"><b>User's Manual</b></td>
141  *      <td align="center"><a href="./docs/`userManualHtml`">[HTML]</a><br>
142  *      </td>
143  *    </tr>
144  *    <tr>
145  *      <td valign="top"><b>Test Report</b></td>
146  *      <td align="center"><a href="./docs/`testReport`">[HTML]</a><br>
147  *      </td>
148  *    </tr>
149  *    <tr>
150  *      <td valign="top"><b>Software Manifest</b></td>
151  *      <td align="center"><a href="./docs/`swManifest`">[HTML]</a><br>
152  *      </td>
153  *    </tr>
154  *    <tr>
155  *      <td valign="top"><b>Release Notes Archive</b></td>
156  *      <td align="center"><a href="./docs/relnotes_archive">[LINK]</a>
157  *      </td>
158  *    </tr>
159  *  </table>
160  *
161  * <hr size="2" width="50%" align="left">
162  *
163  * <h2><a name="Dependency">Dependencies</a></h2>
164  *  
165  *  This release of DSPLIB depends on the following libraries:
166  *  <ol>
167  *    <li>  MATHLIB 
168  *  </ol>
169  *
170  *
171  * <hr size="2" width="50%" align="left">
172  *
173  * <h2><a name="Whats_New">What's New</a></h2>
174  *  
175  * This release makes DSPLIB compilation part of Processor SDK RTOS build.
176  *
177  *  
178  * <hr size="2" width="50%" align="left">
179  *
180  * <h2><a name="Bugs_Fixed">Fixed Bugs</a></h2>
181  *  No bugs were fixed in this release.
182  *
183  *
184  * <hr size="2" width="50%" align="left">
185  *
186  * <h2><a name="Compatibility">Upgrade and Compatibility Information</a></h2>
187  *
188  *  This version of <b>`packageU`</b> is compatible with the last released 
189  *  version: 
190  *
191  *  <table rules="all" frame="box" cellspacing="2" cellpadding="2" frame="void" width="10%">
192  *    <tr>
193  *      <th bgcolor="#cccccc">YES</th>
194  *      <td align="center"> <b>X</b> </td>
195  *    </tr>
196  *    <tr>
197  *      <th bgcolor="#cccccc">NO</th>
198  *      <td align="center"> <b></b> </td>
199  *    </tr>
200  *  </table>
201  * 
202  *  <table bgcolor="#ffff99" frame="box" rules="none" cellspacing="0" width="80%">
203  *    <tr>
204  *      <td valign="top"><b>Note:</b></td>
205  *      <td>
206  *        <ol>
207  *          <li> Package compatibility keys are independent of component release 
208  *               versions. For more information visit: 
209  *               <a href="#VersionCompat">Package Versioning and Compatibility</a>
210  *        </ol>
211  *      </td>
212  *    </tr>
213  *  </table>
214  *        
215  * 
216  * <hr size="2" width="50%" align="left">
217  *
218  * <h2><a name="Device_Support">Device Support</a></h2>
219  *
220  *  This release supports the following device families: 
221  *
222  *  <ul>
223 %for (var i=0; i<TRGCNT; i++) {
224  *    <li> `DEVICES[i]` DSP (`FORMATS[i]`, `ENDIANS[i]` format)
225 %}
226  *  </ul>
227  *
228  *
229  * <hr size="2" width="50%" align="left">
230  *
231  * <h2><a name="Validation">Validation Information</a></h2>
232  *
233  *  This release was built and validated using the following tools:
234  *
235  *  <ul>
236  *    <li> XDC Tools version:  `XDCVER`
237  *    <li> RTSC Packaging Standard version:  `this.pkgStdVer`
238  *    <li> C6000 Code Generation Tools version:  `CGTVER`
239  *    <li> Code Composer Studio version:  `CCSVER`
240  *  </ul>
241  *
242  * <b> Please note that the Test Report was still based on Code Generation Tools 7.4.2. The kernel cycle numbers 
243  *     were not measured in this release and may be different from prior releases.</b> 
244  *
245  * <hr size="2" width="50%" align="left">
246  *
247  * <h2><a name="Known_Issues">Known Issues</a></h2>
248  *
249  *
250  * <hr size="2" width="50%" align="left">
251  *
252  * <h2><a name="Support">Technical Support</a></h2>
253  *
254  *  Questions regarding the `packageU` library should be directed to one of the following forums based on 
255  *  the device that this library is used for:
256  *  - <a href="http://e2e.ti.com/support/arm/sitara_arm/f/791.aspx">E2E Support Forums for AM335x, AM437x, and AM57xx</a>
257  *  - <a href="http://e2e.ti.com/support/dsp/c6000_multi-core_dsps/f/639">E2E Support Forums for K2H, K2K, K2E, K2L, K2G, C665x, and C667x</a>
258  *  - <a href="http://e2e.ti.com/support/dsp/omap_applications_processors/f/42">E2E Support Forums for OMAP-L13x and C674x</a>
259  *
260  *  Please include the text "`packageU`" in the title and add "C66x" or "C674x" or "C64x+" tags to your post.
261  *
262  * <hr size="2" width="50%" align="left">
263  *
264  * <h2><a name="VersionCompat">Package Versioning and Compatibility</a></h2>
265  *
266  * <h3>Compatibility Keys</h3>
267  *  
268  *  Compatibility keys serve two primary purposes: 
269  *   
270  *  <ol>
271  *    <li> Enable tooling to identify incompatibilities between components
272  *    <li> Convey a level of compatibility between different releases to set 
273  *         end user expectations. 
274  *  </ol>
275  * 
276  *  Each compatibility key is composed of 4 comma-delimited numbers - represented here 
277  *  by the letters M, S, R and P <kbd><b>[M,S,R,P]</b></kbd>.  The table below provides a descriptive reference for 
278  *  compatibility key intention.
279  *
280  *  <table rules="all" frame="box" cellspacing="2" cellpadding="2" frame="void" width="80%">
281  *    <caption align="bottom">Compatibility Key Reference</caption>
282  *    <tr valign="top" bgcolor="#cccccc">
283  *      <th width="10%"> Key </th>
284  *      <th width="20%"> Meaning </th>
285  *      <th width="70%"> Description </th>
286  *    </tr>
287  *    <tr valign="top">
288  *      <td>1&nbsp;(<b>M</b>=Major)</td>
289  *      <td>Break in compatibility</td>
290  *      <td>The package consumer is required to re-write the calling source code to use the package</td>
291  *    </tr>
292  *    <tr valign="top">
293  *      <td>2&nbsp;(<b>S</b>=Source)</td>
294  *      <td>Source compatibility</td>
295  *      <td>The package consumer\92s source code doesn't require change, but does require a recompile</td>
296  *    </tr>
297  *    <tr valign="top">
298  *      <td>3&nbsp;(<b>R</b>=Radix)</td>
299  *      <td>Introduction of new features</td>
300  *      <td>Compatibility with previous interfaces is not broken. If libraries are provided by the package, 
301  *          an application must re-link with the new libraries, but is not required to recompile its source</td>
302  *    </tr>
303  *    <tr valign="top">
304  *      <td>4&nbsp;(<b>P</b>=Patch)</td>
305  *      <td>Bug fixes only</td>
306  *      <td>If libraries are provided by the package, an application must re-link with the new libraries, 
307  *          but is not required to recompile its source. </td>
308  *    </tr>
309  *  </table>
310  *
311  *
312  * <hr size="2" width="50%" align="left">
313  *
314  *
315  * <h3>Versioning</h3>
316  *  
317  *  Each package version is composed of 4 period-delimited numbers - represented here 
318  *  by the letters M, m, p and b <kbd><b>[M.m.p.b]</b></kbd>.  The table below provides a descriptive 
319  *  reference regarding package version numbering.
320  *
321  *  <table rules="all" frame="box" cellspacing="4" cellpadding="4" frame="void" width="80%">
322  *    <caption align="bottom">Package Version Reference</caption>
323  *    <tr valign="top" bgcolor="#cccccc">
324  *      <th width="10%"> Digit </th>
325  *      <th width="20%"> Meaning </th>
326  *      <th width="70%"> Description </th>
327  *    </tr>
328  *    <tr valign="top">
329  *      <td>1&nbsp;(<b>M</b>=Major)</td>
330  *      <td>Major revision</td>
331  *      <td>Incremented when the new version is substantially different from the previous  
332  *          For example, a new module added or an existing module's algorithm significantly 
333  *          altered. </td>
334  *    </tr>
335  *    <tr valign="top">
336  *      <td>2&nbsp;(<b>m</b>=minor)</td>
337  *      <td>Minor revision</td>
338  *      <td>Incremented when the new version has changed but not in a major way. For example, 
339  *          some minor changes in the API or feature set. </td>
340  *    </tr>
341  *    <tr valign="top">
342  *      <td>3&nbsp;(<b>p</b>=patch)</td>
343  *      <td>Patch number</td>
344  *      <td>Incremented for all other source code changes. This include any packaging support 
345  *          code. </td>
346  *    </tr>
347  *    <tr valign="top">
348  *      <td>4&nbsp;(<b>b</b>=build)</td>
349  *      <td>Build number</td>
350  *      <td>Incremented for each release delivery to CM. Reset for any change to M, m or p</td>
351  *    </tr>
352  *  </table>
353  *
354  */