e056e68c874c47692d3585f0f64bb942005c3221
[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="#Rebuilding_DSPLIB">Rebuilding DSPLIB</a>                  <br>
111  *    <li> <a href="#Known_Issues">Known Issues</a>                            <br>
112  *    <li> <a href="#Support">Technical Support</a>                            <br>
113  *  </ol>
114  *  
115  *  
116  * <hr size="2" width="50%" align="left">
117  *
118  * <h2><a name="Introduction">Introduction</a></h2>
119  *
120  *  The TI C6000 DSPLIB is an optimized DSP Function Library for C programmers. It includes many
121  *  C-callable, optimized, general-purpose signal-processing routines. These routines are typically 
122  *  used in computationally-intensive real-time applications where optimal execution speed is critical.
123  *
124  * <hr size="2" width="50%" align="left">
125  *
126  * <h2><a name="Starting">Getting Started</a></h2>
127  *
128  *  The <a href="./docs/DSPLIB_Users_Manual.html">DSPLIB User's Manual</a> provides 
129  *  the documentation and references necessary to integrate DSPLIB Library routines 
130  *  into a development platform.
131  * 
132  *
133  * <hr size="2" width="50%" align="left">
134  *
135  * <h2><a name="Documentation">Documentation</a></h2>
136  *
137  *  The following documentation is available:
138  *
139  *  <table frame="box" rules="all" cellspacing="0" width="50%">
140  *    <tr>
141  *      <td valign="top"><b>User's Manual</b></td>
142  *      <td align="center"><a href="./docs/`userManualHtml`">[HTML]</a><br>
143  *      </td>
144  *    </tr>
145  *    <tr>
146  *      <td valign="top"><b>Test Report</b></td>
147  *      <td align="center"><a href="./docs/`testReport`">[HTML]</a><br>
148  *      </td>
149  *    </tr>
150  *    <tr>
151  *      <td valign="top"><b>Software Manifest</b></td>
152  *      <td align="center"><a href="./docs/`swManifest`">[HTML]</a><br>
153  *      </td>
154  *    </tr>
155  *    <tr>
156  *      <td valign="top"><b>Release Notes Archive</b></td>
157  *      <td align="center"><a href="./docs/relnotes_archive">[LINK]</a>
158  *      </td>
159  *    </tr>
160  *  </table>
161  *
162  * <hr size="2" width="50%" align="left">
163  *
164  * <h2><a name="Dependency">Dependencies</a></h2>
165  *  
166  *  This release of DSPLIB depends on the following libraries:
167  *  <ol>
168  *    <li>  MATHLIB 
169  *  </ol>
170  *
171  *
172  * <hr size="2" width="50%" align="left">
173  *
174  * <h2><a name="Whats_New">What's New</a></h2>
175  *  
176  * This release makes DSPLIB compilation part of Processor SDK RTOS build.
177  *
178  *  
179  * <hr size="2" width="50%" align="left">
180  *
181  * <h2><a name="Bugs_Fixed">Fixed Bugs</a></h2>
182  *  No bugs were fixed in this release.
183  *
184  *
185  * <hr size="2" width="50%" align="left">
186  *
187  * <h2><a name="Compatibility">Upgrade and Compatibility Information</a></h2>
188  *
189  *  This version of <b>`packageU`</b> is compatible with the last released 
190  *  version: 
191  *
192  *  <table rules="all" frame="box" cellspacing="2" cellpadding="2" frame="void" width="10%">
193  *    <tr>
194  *      <th bgcolor="#cccccc">YES</th>
195  *      <td align="center"> <b>X</b> </td>
196  *    </tr>
197  *    <tr>
198  *      <th bgcolor="#cccccc">NO</th>
199  *      <td align="center"> <b></b> </td>
200  *    </tr>
201  *  </table>
202  * 
203  *  <table bgcolor="#ffff99" frame="box" rules="none" cellspacing="0" width="80%">
204  *    <tr>
205  *      <td valign="top"><b>Note:</b></td>
206  *      <td>
207  *        <ol>
208  *          <li> Package compatibility keys are independent of component release 
209  *               versions. For more information visit: 
210  *               <a href="#VersionCompat">Package Versioning and Compatibility</a>
211  *        </ol>
212  *      </td>
213  *    </tr>
214  *  </table>
215  *        
216  * 
217  * <hr size="2" width="50%" align="left">
218  *
219  * <h2><a name="Device_Support">Device Support</a></h2>
220  *
221  *  This release supports the following device families: 
222  *
223  *  <ul>
224 %for (var i=0; i<TRGCNT; i++) {
225  *    <li> `DEVICES[i]` DSP (`FORMATS[i]`, `ENDIANS[i]` format)
226 %}
227  *  </ul>
228  *
229  *
230  * <hr size="2" width="50%" align="left">
231  *
232  * <h2><a name="Validation">Validation Information</a></h2>
233  *
234  *  This release was built and validated using the following tools:
235  *
236  *  <ul>
237  *    <li> XDC Tools version:  `XDCVER`
238  *    <li> RTSC Packaging Standard version:  `this.pkgStdVer`
239  *    <li> C6000 Code Generation Tools version:  `CGTVER`
240  *    <li> Code Composer Studio version:  `CCSVER`
241  *  </ul>
242  *
243  * <b> Please note that the Test Report was still based on Code Generation Tools 7.4.2. The kernel cycle numbers 
244  *     were not measured in this release and may be different from prior releases.</b> 
245  *
246  * <hr size="2" width="50%" align="left">
247  *
248  * <h2><a name="Rebuilding_DSPLIB">Rebuilding DSPLIB</a></h2>
249  *  To rebuild DSPLIB, clone the git repo at https://git.ti.com/ep-processor-libraries/dsplib and follow
250  *  build instructions in readme.txt in root folder.
251  * <hr size="2" width="50%" align="left">
252  *
253  * <h2><a name="Known_Issues">Known Issues</a></h2>
254  *
255  *
256  * <hr size="2" width="50%" align="left">
257  *
258  * <h2><a name="Support">Technical Support</a></h2>
259  *
260  *  Questions regarding the `packageU` library should be directed to one of the following forums based on 
261  *  the device that this library is used for:
262  *  - <a href="http://e2e.ti.com/support/arm/sitara_arm/f/791.aspx">E2E Support Forums for AM335x, AM437x, and AM57xx</a>
263  *  - <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>
264  *  - <a href="http://e2e.ti.com/support/dsp/omap_applications_processors/f/42">E2E Support Forums for OMAP-L13x and C674x</a>
265  *
266  *  Please include the text "`packageU`" in the title and add "C66x" or "C674x" or "C64x+" tags to your post.
267  *
268  * <hr size="2" width="50%" align="left">
269  *
270  * <h2><a name="VersionCompat">Package Versioning and Compatibility</a></h2>
271  *
272  * <h3>Compatibility Keys</h3>
273  *  
274  *  Compatibility keys serve two primary purposes: 
275  *   
276  *  <ol>
277  *    <li> Enable tooling to identify incompatibilities between components
278  *    <li> Convey a level of compatibility between different releases to set 
279  *         end user expectations. 
280  *  </ol>
281  * 
282  *  Each compatibility key is composed of 4 comma-delimited numbers - represented here 
283  *  by the letters M, S, R and P <kbd><b>[M,S,R,P]</b></kbd>.  The table below provides a descriptive reference for 
284  *  compatibility key intention.
285  *
286  *  <table rules="all" frame="box" cellspacing="2" cellpadding="2" frame="void" width="80%">
287  *    <caption align="bottom">Compatibility Key Reference</caption>
288  *    <tr valign="top" bgcolor="#cccccc">
289  *      <th width="10%"> Key </th>
290  *      <th width="20%"> Meaning </th>
291  *      <th width="70%"> Description </th>
292  *    </tr>
293  *    <tr valign="top">
294  *      <td>1&nbsp;(<b>M</b>=Major)</td>
295  *      <td>Break in compatibility</td>
296  *      <td>The package consumer is required to re-write the calling source code to use the package</td>
297  *    </tr>
298  *    <tr valign="top">
299  *      <td>2&nbsp;(<b>S</b>=Source)</td>
300  *      <td>Source compatibility</td>
301  *      <td>The package consumer\92s source code doesn't require change, but does require a recompile</td>
302  *    </tr>
303  *    <tr valign="top">
304  *      <td>3&nbsp;(<b>R</b>=Radix)</td>
305  *      <td>Introduction of new features</td>
306  *      <td>Compatibility with previous interfaces is not broken. If libraries are provided by the package, 
307  *          an application must re-link with the new libraries, but is not required to recompile its source</td>
308  *    </tr>
309  *    <tr valign="top">
310  *      <td>4&nbsp;(<b>P</b>=Patch)</td>
311  *      <td>Bug fixes only</td>
312  *      <td>If libraries are provided by the package, an application must re-link with the new libraries, 
313  *          but is not required to recompile its source. </td>
314  *    </tr>
315  *  </table>
316  *
317  *
318  * <hr size="2" width="50%" align="left">
319  *
320  *
321  * <h3>Versioning</h3>
322  *  
323  *  Each package version is composed of 4 period-delimited numbers - represented here 
324  *  by the letters M, m, p and b <kbd><b>[M.m.p.b]</b></kbd>.  The table below provides a descriptive 
325  *  reference regarding package version numbering.
326  *
327  *  <table rules="all" frame="box" cellspacing="4" cellpadding="4" frame="void" width="80%">
328  *    <caption align="bottom">Package Version Reference</caption>
329  *    <tr valign="top" bgcolor="#cccccc">
330  *      <th width="10%"> Digit </th>
331  *      <th width="20%"> Meaning </th>
332  *      <th width="70%"> Description </th>
333  *    </tr>
334  *    <tr valign="top">
335  *      <td>1&nbsp;(<b>M</b>=Major)</td>
336  *      <td>Major revision</td>
337  *      <td>Incremented when the new version is substantially different from the previous  
338  *          For example, a new module added or an existing module's algorithm significantly 
339  *          altered. </td>
340  *    </tr>
341  *    <tr valign="top">
342  *      <td>2&nbsp;(<b>m</b>=minor)</td>
343  *      <td>Minor revision</td>
344  *      <td>Incremented when the new version has changed but not in a major way. For example, 
345  *          some minor changes in the API or feature set. </td>
346  *    </tr>
347  *    <tr valign="top">
348  *      <td>3&nbsp;(<b>p</b>=patch)</td>
349  *      <td>Patch number</td>
350  *      <td>Incremented for all other source code changes. This include any packaging support 
351  *          code. </td>
352  *    </tr>
353  *    <tr valign="top">
354  *      <td>4&nbsp;(<b>b</b>=build)</td>
355  *      <td>Build number</td>
356  *      <td>Incremented for each release delivery to CM. Reset for any change to M, m or p</td>
357  *    </tr>
358  *  </table>
359  *
360  */