Modified XDC related files for the release 02.10.04.01
[keystone-rtos/edma3_lld.git] / release_notes_edma3_lld_02_10_04.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">\r
2 <html xmlns="http://www.w3.org/TR/REC-html40">\r
3 <head>\r
4   <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">\r
5   <meta http-equiv="Content-Type" content="text/html">\r
6   <title>EDMA3 LLD 02.10.03 Release Notes</title>\r
7   <style type="text/css">\r
8 body\r
9 {\r
10     color: #000 ;\r
11     background-color: #fff ;\r
12     margin : 5px 20px 5px 20px;\r
13     font-family: Tahoma, Arial, Helvetica, sans-serif;\r
14     font-size: 10pt ;\r
15 }\r
16 \r
17 a,\r
18 a:link,\r
19 a:visited,\r
20 \r
21 {\r
22     color : #1a41a8 ;\r
23 }\r
24 \r
25 a:hover\r
26 {\r
27     color : #2a3798 ;\r
28 }\r
29 \r
30 img\r
31 {\r
32     text-decoration : none ;\r
33 }\r
34 \r
35 p\r
36 {\r
37     color: #000 ;\r
38 }\r
39 \r
40 table.tagline\r
41 {\r
42     width: 100%;\r
43 }\r
44 \r
45 li\r
46 {\r
47     color : black ;\r
48 }\r
49 \r
50 .title\r
51 {\r
52     text-align : center ;\r
53 }\r
54 \r
55 th\r
56 {\r
57     text-align : left ;\r
58 }\r
59   </style>\r
60 </head>\r
61 <body>\r
62 <table border="0" cellpadding="0" cellspacing="0" width="100%">\r
63   <tbody>\r
64     <tr>\r
65       <td\r
66  style="background: black none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;"\r
67  width="222"> <a href="http://www.ti.com/"><img id="_x0000_i1025"\r
68  src="docs/html/tilogo.gif" alt="Texas Instruments" border="0"\r
69  height="54" width="222"> </a></td>\r
70       <td\r
71  style="background: red none repeat scroll 0% 50%; -moz-background-clip: initial; -moz-background-origin: initial; -moz-background-inline-policy: initial;">\r
72       <img id="_x0000_i1026" src="docs/html/titagline.gif"\r
73  alt="Technology for Innovators(tm)" border="0" height="26" width="314">\r
74       </td>\r
75     </tr>\r
76   </tbody>\r
77 </table>\r
78 <h1 class="title">EDMA3 LLD 02.10.03 Release Notes</h1>\r
79 <h2 class="title">September 8, 2010</h2>\r
80 <p>\r
81 This EDMA3 Low Level Driver Release is targeted to the users (device\r
82 drivers\r
83 and applications) for submitting and synchronizing with EDMA3 based DMA\r
84 transfers.\r
85 This release supports DA830,C6748,TCI6498,TI816X,C6472,TCI6486,TI814X platforms, on\r
86 DSP/BIOS 6 side &amp; OMAPL138 on DSP/BIOS and ARM side. Porting\r
87 instructions\r
88 are also provided to use the package for different platforms and\r
89 Operating\r
90 Systems.\r
91 </p>\r
92 <p>\r
93 <a href="#Introduction">Introduction</a>,\r
94 <a href="#Documentation">Documentation</a>,\r
95 <a href="#Whats_New">What's New</a>,\r
96 <a href="#Upgrade_Info">Upgrade Info</a>,\r
97 <a href="#Device_Support">Device Support</a>,\r
98 <a href="#Compatibility">Compatibility Information</a>,\r
99 <a href="#Validation">Validation Info</a>,\r
100 <a href="#Known_Issues">Known Issues</a>,\r
101 <a href="#Examples">Examples</a>,\r
102 <a href="#Version">Version Information</a>,\r
103 <a href="#Support">Technical Support</a>\r
104 </p>\r
105 <hr>\r
106 <a name="Introduction"></a>\r
107 <h2><a name="Introduction">Introduction</a></h2>\r
108 <p>\r
109 EDMA3 LLD is a single product package containing the following\r
110 stand-alone\r
111 software components:\r
112 </p>\r
113 <ul type="disc">\r
114   <a name="Introduction"> <li> <b>EDMA3 Resource Manager</b> - TI\r
115 mandated library for all EDMA3 peripheral users to acquire and\r
116 configure EDMA3 hardware resources (DMA/QDMA channels, PaRAM Sets, TCCs\r
117 etc.) and DMA Interrupt Service Routines. </li>\r
118   <li> <b>EDMA3 Driver</b> - Functional library providing APIs for\r
119 programming, scheduling and synchronizing with EDMA transfers and many\r
120 more. </li>\r
121   </a>\r
122 </ul>\r
123 <p>\r
124 EDMA3 Resource Manager can be used independently whereas the EDMA3\r
125 Driver requires\r
126 the Resource Manager services internally.\r
127 </p>\r
128 <p>\r
129 EDMA3 LLD (both Resource Manager and the Driver) is a platform\r
130 independent package.\r
131 Hence it can be used across multiple platforms. Porting instructions\r
132 are provided for both the components to do the same.\r
133 </p>\r
134 <p>\r
135 It is also an OS-agnostic package and thus can be used across multiple\r
136 operating\r
137 systems. OS-adaptation layer needs to be provided by the user (in case\r
138 it is needed)\r
139 for OS customization. Instructions to do the same are also provided\r
140 along with\r
141 the package.\r
142 </p>\r
143 <p>\r
144 The Low Level Driver has already been ported (DSP/BIOS Operating\r
145 Systems)\r
146 and tested on various platforms mentioned below. Sample initialization\r
147 libraries,\r
148 which configure the EDMA3 hardware and provide the necessary OS\r
149 abstraction layer,\r
150 are also a part of the package. These libraries are available both for\r
151 the EDMA3\r
152 Resource Manager and EDMA3 Driver. These could be used for proper\r
153 initialization of the software component(s) along with the OS\r
154 adaptation layer\r
155 for the same.\r
156 </p>\r
157 <p>\r
158 The Low Level Driver consists of the following packages:\r
159 </p>\r
160 <ul type="disc">\r
161   <a name="Introduction"> <li> <tt><b>ti.sdo.edma3.rm</b></tt> -\r
162 EDMA3 Resource Manager. </li>\r
163   <li> <tt><b>ti.sdo.edma3.rm.sample</b></tt> - Sample initialization\r
164 library / OS abstraction layer for the Resource Manager. </li>\r
165   <li> <tt><b>ti.sdo.edma3.drv</b></tt> - EDMA3 Driver. </li>\r
166   <li> <tt><b>ti.sdo.edma3.drv.sample</b></tt> - Sample initialization\r
167 library / OS abstraction layer for the Driver. </li>\r
168   </a>\r
169 </ul>\r
170 <a name="Documentation">\r
171 </a>\r
172 <h2><a name="Documentation">Documentation</a></h2>\r
173 <p>The following documentation is available:\r
174 </p>\r
175 <ul type="disc">\r
176   <li><a href="docs/EDMA3_RM_Release_Notes.pdf">EDMA3 Resource Manager\r
177 Release Notes</a></li>\r
178   <li> <a href="packages/ti/sdo/edma3/rm/docs/EDMA3_RM_User_Guide.pdf">EDMA3\r
179 Resource Manager User's Guide</a> </li>\r
180   <li> <a href="docs/EDMA3_Driver_Release_Notes.pdf">EDMA3 Driver\r
181 Release Notes</a> </li>\r
182   <li> <a\r
183  href="packages/ti/sdo/edma3/drv/docs/EDMA3_Driver_User_Guide.pdf">EDMA3\r
184 Driver User's Guide</a> </li>\r
185   <li> EDMA3 Resource Manager Application Programming Interface (API)\r
186 Reference Guide (<a href="packages/ti/sdo/edma3/rm/docs/html/index.html">HTML</a>\r
187 | <a href="packages/ti/sdo/edma3/rm/docs/EDMA3_Resource_Manager.chm">CHM</a>)\r
188   </li>\r
189   <li> EDMA3 Driver Application Programming Interface Reference Guide (<a\r
190  href="packages/ti/sdo/edma3/drv/docs/html/index.html">HTML</a> | <a\r
191  href="packages/ti/sdo/edma3/drv/docs/EDMA3_Driver.chm">CHM</a>) </li>\r
192   <li> <a href="examples/CSL2_DAT_DEMO/docs/CSL_DAT_Adapter.ppt">CSL\r
193 2.x DAT Reference Implementation on EDMA3 Hardware using EDMA3 LLD</a> </li>\r
194 </ul>\r
195 <hr>\r
196 <a name="Whats_New"></a>\r
197 <h2><a name="Whats_New">What's New</a></h2>\r
198 \r
199 <p>\r
200 <a name="Whats_New">The following significant changes have been made since 02.10.03:\r
201 </a></p>\r
202 \r
203 <p><a name="Whats_New">02.10.03 - This release\r
204 </a></p>\r
205 \r
206 <p>\r
207 <a name="Whats_New">The following ECNs are implemented:\r
208 </a></p>\r
209 \r
210 <table width="100%">\r
211   <tbody>\r
212     <tr>\r
213       <th>ID</th>\r
214       <th>Headline</th>\r
215     </tr>\r
216 \r
217     <tr>\r
218       <td width="200">TIDSP00012436</td>\r
219       <td>Support for the TI816X Simulator for BIOS6 has been implemented</td>\r
220     </tr>\r
221 \r
222     <tr>\r
223       <td width="200">TIDSP00012435</td>\r
224       <td>Support for the TI816X platform for BIOS6 has been implemented</td>\r
225     </tr>\r
226 \r
227     <tr>\r
228       <td width="200"> </td>\r
229       <td><FONT COLOR ='RED'>This release is not tested on the TI816X EVM</FONT></td>\r
230     </tr>\r
231 \r
232     <tr>\r
233       <td width="200">TIDSP00012434</td>\r
234       <td>Support for the C6472 & TCI6486 platform for BIOS6 has been implemented.</td>\r
235     </tr>\r
236 \r
237     <tr>\r
238       <td width="200">TIDSP00012437</td>\r
239       <td>Support for a "generic" platform in the Resource Manager for BIOS6 has been implemented</td>\r
240     </tr>\r
241 \r
242         <tr>\r
243       <td width="200">TIDSP00012461</td>\r
244       <td>Support for the TI814X platform for BIOS6 has been implemented</td>\r
245     </tr>\r
246 \r
247     <tr>\r
248       <td width="200"> </td>\r
249       <td><FONT COLOR ='RED'>This release is not tested on the TI814X EVM, it is provided purely for the purpose of integration only</FONT></td>\r
250     </tr>\r
251 \r
252   </tbody>\r
253 </table>\r
254 \r
255 <p>\r
256 <a name="Whats_New">The following IRs are closed:\r
257 </a></p>\r
258 <table width="100%">\r
259   <tbody>\r
260     <tr>\r
261       <th>ID</th>\r
262       <th>Headline</th>\r
263     </tr>\r
264 \r
265     <tr>\r
266       <td width="200">SDOCM00069906</td>\r
267       <td>CSL2_DAT_DEMO hangs in the _getchannel function</td>\r
268     </tr>\r
269 \r
270     <tr>\r
271       <td width="200">SDOCM00074152</td>\r
272       <td>Pulling some Fixes from BIOS5 EDMA3LLD to BIOS6 LLD</td>\r
273     </tr>\r
274 \r
275     <tr>\r
276       <td width="200">SDOCM00074153</td>\r
277       <td>EDMA3LLD libraries for Nyquist are not building with BIOS 6.30.02.42</td>\r
278     </tr>\r
279 \r
280     <tr>\r
281       <td width="200">SDOCM00074184</td>\r
282       <td>Warnings appear while building the libraires and example projects of EDMA3LLD with BIOS 6.30.02.42</td>\r
283     </tr>\r
284 \r
285   </tbody>\r
286 </table>\r
287 \r
288 <br>\r
289 <hr><a name="Upgrade_Info"></a>\r
290 <h2><a name="Upgrade_Info">Upgrade Information</a></h2>\r
291 <p>\r
292 The EDMA3 LLD packages are available in the "packages/" subdirectory of\r
293 the product.\r
294 If you have a previous release of the EDMA3 LLD product, you can\r
295 install this\r
296 release next to it, and modify your application and/or server builds to\r
297 use this\r
298 newer release.\r
299 </p>\r
300 <hr>\r
301 <a name="Device_Support"></a>\r
302 <h2><a name="Device_Support">Device Support</a></h2>\r
303 <p>\r
304 This release supports and has been tested on the following devices:\r
305 </p>\r
306 <ul>\r
307   <a name="Device_Support"> <li>DA830 EVM:\r
308     <ul type="circle">\r
309       <li>C67x DSP/BIOS</li>\r
310     </ul>\r
311   </li>\r
312   <li>TCI6498 Simulator:</li>\r
313   </a>\r
314   <ul>\r
315     <li>C64X+ DSP/BIOS</li>\r
316   </ul>\r
317   <li>C6748 EVM:</li>\r
318   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
319   <li type="disc">OMAPL138 EVM:</li>\r
320   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
321   <li style="margin-left: 40px;" type="circle">ARM 9 SYSBIOS</li>\r
322   <li>TI816X Simulator:</li>\r
323   </a>\r
324   <ul>\r
325     <li>C67X DSP/BIOS</li>\r
326   </ul>\r
327     <li>TI816X EVM:</li>\r
328   </a>\r
329   <ul>\r
330     <li>C67X DSP/BIOS</li>\r
331   </ul>\r
332   <li>C6472 EVM:</li>\r
333   </a>\r
334   <ul>\r
335     <li>C64X+ DSP/BIOS</li>\r
336   </ul>\r
337     <li>TCI6486 EVM:</li>\r
338   </a>\r
339   <ul>\r
340     <li>C64X+ DSP/BIOS</li>\r
341   </ul>\r
342       <li>TI814X EVM:</li>\r
343   </a>\r
344   <ul>\r
345     <li>C67X DSP/BIOS</li>\r
346   </ul>\r
347   </ul>\r
348 <hr>\r
349 <a name="Compatibility"></a>\r
350 <h2><a name="Compatibility">Compatibility Information</a></h2>\r
351 <h3><a name="Compatibility">Compatibility Key Definitions</a></h3>\r
352 <p>\r
353 Compatibility keys are intentionally independent of Marketing product\r
354 numbers\r
355 and are intended to:\r
356 </p>\r
357 <ol start="1" type="1">\r
358   <a name="Compatibility"> <li> Enable tooling to identify\r
359 incompatibilities between components, and </li>\r
360   <li> Convey a level of compatibility between different releases to\r
361 set end user expectations. </li>\r
362   </a>\r
363 </ol>\r
364 <p>\r
365 Compatibility keys are composed of 3 comma-delimited numbers - M, S, R\r
366 - where:\r
367 </p>\r
368 <ul type="disc">\r
369   <a name="Compatibility"> <li> <b>M = Major</b>. A difference in M\r
370 indicates a break in compatibility. </li>\r
371   <li> <b>S = Source</b>. A difference in S indicates source\r
372 compatibility. That is, the user's source doesn't require change, but <i>does</i>\r
373 require rebuilding. </li>\r
374   <li> <b>R = Radix</b>. A difference in R indicates an introduction\r
375 of new features, but compatibility with previous interfaces has not\r
376 broken. If libraries are provided by the package, an application must\r
377 re-link with the new libraries, but not rebuild from source. </li>\r
378   </a>\r
379 </ul>\r
380 <hr>\r
381 <a name="Validation"></a>\r
382 <h2><a name="Validation">Validation</a></h2>\r
383 <p>\r
384 This release was built and validated against using the following\r
385 components:\r
386 </p>\r
387 <ul type="disc">\r
388   <a name="Validation"> <li>CCS 4.2.0.09000</li>\r
389   <li>C6x Code Generation Tools version 7.0.x</li>\r
390   <li>DSP/BIOS 6.32.02.42</li>\r
391   <li>XDC Tools 3.32.02.59</li>\r
392   <li>TCI6498 Simulator 0.7.1</li>\r
393   <li>TI816X Simulator 0.7.1</li>\r
394   </a>\r
395 </ul>\r
396 <p>\r
397 This release was validated in the following configurations:\r
398 </p>\r
399 <ul>\r
400   <li> DA830 EVM:\r
401     <ul type="circle">\r
402       <li>C67x DSP/BIOS</li>\r
403     </ul>\r
404   </li>\r
405   <li> TCI6498 Simulator:\r
406     <ul type="circle">\r
407       <li>C64X+ DSP/BIOS</li>\r
408     </ul>\r
409   </li>\r
410   <li>C6748 EVM:</li>\r
411   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
412   <li>OMAPL138 EVM:</li>\r
413   <ul>\r
414     <li>C67x DSP/BIOS</li>\r
415     <li>ARM 9 SYSBIOS</li>\r
416   </ul>\r
417   <li>TI816X Simulator:</li>\r
418   </a>\r
419   <ul>\r
420     <li>C67X DSP/BIOS</li>\r
421   </ul>\r
422     <li>TI816X EVM:</li>\r
423   </a>\r
424   <ul>\r
425     <li>C67X DSP/BIOS</li>\r
426   </ul>\r
427   <li>C6472 EVM:</li>\r
428   </a>\r
429   <ul>\r
430     <li>C64X+ DSP/BIOS</li>\r
431   </ul>\r
432     <li>TCI6486 EVM:</li>\r
433   </a>\r
434   <ul>\r
435     <li>C64X+ DSP/BIOS</li>\r
436   </ul>\r
437     <li>TI814X EVM:</li>\r
438   </a>\r
439   <ul>\r
440     <li>C67X DSP/BIOS</li>\r
441   </ul>\r
442 </ul>\r
443 <hr><a name="Known_Issues">\r
444 </a>\r
445 <h2><a name="Known_Issues">Known Issues</a></h2>\r
446 <p>\r
447 The following are known issues with the current EDMA3 LLD release:\r
448 </p>\r
449 <h4><a name="Known_Issues">Pre-built instrumented libraries for DA830\r
450 not provided initially.</a></h4>\r
451 <p>Pre-built instrumented EDMA3 libraries for DA830 will not be\r
452 provided\r
453 initially. XDC does not support the same and hence the limitation. See\r
454 IR#\r
455 SDOCM00036738 for more details.\r
456 </p>\r
457 <h4><a name="Known_Issues">EDMA3 hardware does not work properly in\r
458 FIFO mode with all the controllers.</a></h4>\r
459 <p>Very few peripherals support EDMA3 FIFO mode. EMIF controller\r
460 doesn't support\r
461 the same. So EDMA3 CANNOT be used in FIFO mode for doing a\r
462 memory-to-memory data\r
463 transfers, EDMA3 being configured in the FIFO mode. Applications trying\r
464 to use\r
465 EDMA3 in FIFO mode should first check their respective\r
466 peripheral-controller\r
467 document for this mode support.\r
468 </p>\r
469 <h4><a name="Known_Issues">PingPong Example Fails for certain EDMA\r
470 instances for some DSP cores in Release mode only.</a></h4>\r
471 <p>The PingPong example in the package fails for certain EDMA Instances\r
472 for some DSP cores in Release mode only. It passes for Debug mode. See\r
473 IR#\r
474 SDOCM00064758 for more details.\r
475 </p>\r
476 <hr>\r
477 <a name="Examples"></a>\r
478 <h2><a name="Examples">Examples</a></h2>\r
479 <p>\r
480 EDMA3 LLD sample initialization libraries / OS abstraction layers (for\r
481 different\r
482 platforms) are located in:\r
483 </p>\r
484 <ul type="disc">\r
485   <a name="Examples"> <li> For Resource Manager: They could be located\r
486 in <tt>edma3_lld_02_10_03_XX\packages\ti\sdo\edma3\rm\sample\lib</tt>\r
487 folder. </li>\r
488   <li> For EDMA3 Driver: They could be located in <tt>edma3_lld_02_10_03_XX\packages\ti\sdo\edma3\drv\sample\lib</tt>\r
489 folder. </li>\r
490   </a>\r
491 </ul>\r
492 <p>\r
493 EDMA3 LLD stand-alone applications (for different platforms) are\r
494 located in:\r
495 </p>\r
496 <ul type="disc">\r
497   <a name="Examples"> <li> EDMA3 Driver: They could be located in <tt>edma3_lld_02_10_03_XX\examples\edma3_driver\</tt>\r
498 folder. </li>\r
499   </a>\r
500 </ul>\r
501 <ul type="disc">\r
502   <a name="Examples"> <li> CSL2.x DAT Reference Implementation: It\r
503 could be located in <tt>edma3_lld_02_10_03_XX\examples\CSL2_DAT_DEMO\</tt>\r
504 folder. </li>\r
505   </a>\r
506 </ul>\r
507 <hr>\r
508 <a name="Version"></a>\r
509 <h2><a name="Version">Version Information</a></h2>\r
510 <p>\r
511 This product's version follows a version format, <b>M.mm.pp.bb</b>,\r
512 where\r
513 <b>M</b> is a 2 digit major number,\r
514 <b>mm</b> is 2 digit minor number,\r
515 <b>pp</b> is a 2 digit patch number, and\r
516 <b>b</b> is an unrestricted set of digits used as an incrementing build\r
517 counter.\r
518 </p>\r
519 <p>\r
520 To support multiple side-by-side installations of the product, the\r
521 product\r
522 version is encoded in the top level directory, ex. <b>edma3_lld_02_10_03_XX</b>.\r
523 </p>\r
524 <p>Subsequent releases of patch upgrades will be identified by the\r
525 patch number,\r
526 ex. EDMA3 LLD 02.10.03 with directory <b>edma3_lld_02_10_04_YY</b>.\r
527 Typically, these\r
528 patches only include critical bug fixes.\r
529 </p>\r
530 <hr>\r
531 <a name="Support"></a>\r
532 <h2><a name="Support">Technical Support</a></h2>\r
533 <p>\r
534 For technical support, contact <a href="mailto:softwaresupport@ti.com">softwaresupport@ti.com</a>\r
535 </p>\r
536 <hr>\r
537 <p>Last updated: September 8, 2010\r
538 </p>\r
539 </body>\r
540 </html>\r