2d0555c0a7eb23a2e0bf998fc654fef084ed5f6d
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 * - DSPLIB test report including benchmarking is based on C6000 Compiler 8.3.2.
177 * - DSPLIB compilation and build is now part of Proc-SDK build process.
178 * - TIREX .json metadata is included in the package. It enables CCS v7 and newer to detect
179 * and install DSPLIB without going through pop-up installation window
180 * and restarting CCS. The installation folder path is COM_TI_MAS_DSPLIB_<target>_INSTALL_DIR,
181 * where target is C64PX, C674X, or C66X.
182 *
183 * <hr size="2" width="50%" align="left">
184 *
185 * <h2><a name="Bugs_Fixed">Fixed Bugs</a></h2>
186 * Version 3.4.0.4:
187 * <ul>
188 * <li> PRSDK-5635: fix kernels that failed when compiled with C6000 8.3.x compiler
189 * </ul>
190 *
191 * Version 3.4.0.3:
192 * <ul>
193 * <li> PROC_LIBS-282: Incorrect indexing in the DSPF_sp_fircirc
194 * <li> PROC_LIBS-222: Example fft_sp_ex in dsplib_c66x_3_4_0_0 does not give correct results
195 * <li> PRSDK-5250: Missing DSPF_sp_fftSPxSP_r2c result in DSPLIB test report
196 * </ul>
197 *
198 *
199 * <hr size="2" width="50%" align="left">
200 *
201 * <h2><a name="Compatibility">Upgrade and Compatibility Information</a></h2>
202 *
203 * This version of <b>`packageU`</b> is compatible with the last released
204 * version:
205 *
206 * <table rules="all" frame="box" cellspacing="2" cellpadding="2" frame="void" width="10%">
207 * <tr>
208 * <th bgcolor="#cccccc">YES</th>
209 * <td align="center"> <b>X</b> </td>
210 * </tr>
211 * <tr>
212 * <th bgcolor="#cccccc">NO</th>
213 * <td align="center"> <b></b> </td>
214 * </tr>
215 * </table>
216 *
217 * <table bgcolor="#ffff99" frame="box" rules="none" cellspacing="0" width="80%">
218 * <tr>
219 * <td valign="top"><b>Note:</b></td>
220 * <td>
221 * <ol>
222 * <li> Package compatibility keys are independent of component release
223 * versions. For more information visit:
224 * <a href="#VersionCompat">Package Versioning and Compatibility</a>
225 * </ol>
226 * </td>
227 * </tr>
228 * </table>
229 *
230 *
231 * <hr size="2" width="50%" align="left">
232 *
233 * <h2><a name="Device_Support">Device Support</a></h2>
234 *
235 * This release supports the following device families:
236 *
237 * <ul>
238 %for (var i=0; i<TRGCNT; i++) {
239 * <li> `DEVICES[i]` DSP (`FORMATS[i]`, `ENDIANS[i]` format)
240 %}
241 * </ul>
242 *
243 *
244 * <hr size="2" width="50%" align="left">
245 *
246 * <h2><a name="Validation">Validation Information</a></h2>
247 *
248 * This release was built and validated using the following tools:
249 *
250 * <ul>
251 * <li> XDC Tools version: `XDCVER`
252 * <li> RTSC Packaging Standard version: `this.pkgStdVer`
253 * <li> C6000 Code Generation Tools version: `CGTVER`
254 * <li> Code Composer Studio version: `CCSVER`
255 * </ul>
256 *
257 * <b> Please note that the Test Report was still based on Code Generation Tools 7.4.2. The kernel cycle numbers
258 * were not measured in this release and may be different from prior releases.</b>
259 *
260 * <hr size="2" width="50%" align="left">
261 *
262 * <h2><a name="Rebuilding_DSPLIB">Rebuilding DSPLIB</a></h2>
263 * To rebuild DSPLIB, clone the git repo at https://git.ti.com/ep-processor-libraries/dsplib and follow
264 * build instructions in readme.txt in root folder.
265 * <hr size="2" width="50%" align="left">
266 *
267 * <h2><a name="Known_Issues">Known Issues</a></h2>
268 *
269 *
270 * <hr size="2" width="50%" align="left">
271 *
272 * <h2><a name="Support">Technical Support</a></h2>
273 *
274 * Questions regarding the `packageU` library should be directed to one of the following forums based on
275 * the device that this library is used for:
276 * - <a href="http://e2e.ti.com/support/arm/sitara_arm/f/791.aspx">E2E Support Forums for AM335x, AM437x, and AM57xx</a>
277 * - <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>
278 * - <a href="http://e2e.ti.com/support/dsp/omap_applications_processors/f/42">E2E Support Forums for OMAP-L13x and C674x</a>
279 *
280 * Please include the text "`packageU`" in the title and add "C66x" or "C674x" or "C64x+" tags to your post.
281 *
282 * <hr size="2" width="50%" align="left">
283 *
284 * <h2><a name="VersionCompat">Package Versioning and Compatibility</a></h2>
285 *
286 * <h3>Compatibility Keys</h3>
287 *
288 * Compatibility keys serve two primary purposes:
289 *
290 * <ol>
291 * <li> Enable tooling to identify incompatibilities between components
292 * <li> Convey a level of compatibility between different releases to set
293 * end user expectations.
294 * </ol>
295 *
296 * Each compatibility key is composed of 4 comma-delimited numbers - represented here
297 * by the letters M, S, R and P <kbd><b>[M,S,R,P]</b></kbd>. The table below provides a descriptive reference for
298 * compatibility key intention.
299 *
300 * <table rules="all" frame="box" cellspacing="2" cellpadding="2" frame="void" width="80%">
301 * <caption align="bottom">Compatibility Key Reference</caption>
302 * <tr valign="top" bgcolor="#cccccc">
303 * <th width="10%"> Key </th>
304 * <th width="20%"> Meaning </th>
305 * <th width="70%"> Description </th>
306 * </tr>
307 * <tr valign="top">
308 * <td>1 (<b>M</b>=Major)</td>
309 * <td>Break in compatibility</td>
310 * <td>The package consumer is required to re-write the calling source code to use the package</td>
311 * </tr>
312 * <tr valign="top">
313 * <td>2 (<b>S</b>=Source)</td>
314 * <td>Source compatibility</td>
315 * <td>The package consumer\92s source code doesn't require change, but does require a recompile</td>
316 * </tr>
317 * <tr valign="top">
318 * <td>3 (<b>R</b>=Radix)</td>
319 * <td>Introduction of new features</td>
320 * <td>Compatibility with previous interfaces is not broken. If libraries are provided by the package,
321 * an application must re-link with the new libraries, but is not required to recompile its source</td>
322 * </tr>
323 * <tr valign="top">
324 * <td>4 (<b>P</b>=Patch)</td>
325 * <td>Bug fixes only</td>
326 * <td>If libraries are provided by the package, an application must re-link with the new libraries,
327 * but is not required to recompile its source. </td>
328 * </tr>
329 * </table>
330 *
331 *
332 * <hr size="2" width="50%" align="left">
333 *
334 *
335 * <h3>Versioning</h3>
336 *
337 * Each package version is composed of 4 period-delimited numbers - represented here
338 * by the letters M, m, p and b <kbd><b>[M.m.p.b]</b></kbd>. The table below provides a descriptive
339 * reference regarding package version numbering.
340 *
341 * <table rules="all" frame="box" cellspacing="4" cellpadding="4" frame="void" width="80%">
342 * <caption align="bottom">Package Version Reference</caption>
343 * <tr valign="top" bgcolor="#cccccc">
344 * <th width="10%"> Digit </th>
345 * <th width="20%"> Meaning </th>
346 * <th width="70%"> Description </th>
347 * </tr>
348 * <tr valign="top">
349 * <td>1 (<b>M</b>=Major)</td>
350 * <td>Major revision</td>
351 * <td>Incremented when the new version is substantially different from the previous
352 * For example, a new module added or an existing module's algorithm significantly
353 * altered. </td>
354 * </tr>
355 * <tr valign="top">
356 * <td>2 (<b>m</b>=minor)</td>
357 * <td>Minor revision</td>
358 * <td>Incremented when the new version has changed but not in a major way. For example,
359 * some minor changes in the API or feature set. </td>
360 * </tr>
361 * <tr valign="top">
362 * <td>3 (<b>p</b>=patch)</td>
363 * <td>Patch number</td>
364 * <td>Incremented for all other source code changes. This include any packaging support
365 * code. </td>
366 * </tr>
367 * <tr valign="top">
368 * <td>4 (<b>b</b>=build)</td>
369 * <td>Build number</td>
370 * <td>Incremented for each release delivery to CM. Reset for any change to M, m or p</td>
371 * </tr>
372 * </table>
373 *
374 */