config files and examples added for supporting m3 video/vpss of netra
[keystone-rtos/edma3_lld.git] / release_notes_edma3_lld_02_11_01.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.11.01 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.11.01 Release Notes</h1>\r
79 <h2 class="title">February 15, 2011</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,TCI6608,TCI6616,C6670,C6678 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.11.00:\r
201 </a></p>\r
202 \r
203 <p><a name="Whats_New">02.11.01 - 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">TIDSP00012604</td>\r
219       <td>Addition of C66x targets and platforms to EDMA3LLD</td>\r
220     </tr>\r
221 \r
222     <tr>\r
223       <td width="200"> </td>\r
224       <td><FONT COLOR ='RED'>This release uses 2 CGTOOLS - C6000 Code Generation Tools 7.2.0 GA for the ELF libraries and C6000 Code Generation Tools 7.0.4 for the COFF libraries</FONT><br>\r
225     </tr>\r
226 \r
227   </tbody>\r
228 </table>\r
229 \r
230 <p>\r
231 <a name="Whats_New">The following IRs are closed:\r
232 </a></p>\r
233 <table width="100%">\r
234   <tbody>\r
235     <tr>\r
236       <th>ID</th>\r
237       <th>Headline</th>\r
238     </tr>\r
239 \r
240     <tr>\r
241       <td width="200">SDOCM00078641</td>\r
242       <td>C66x support for generic RM library for Make based build of EDMA3LLD</td>\r
243     </tr>\r
244 \r
245     <tr>\r
246       <td width="200">SDOCM00078808</td>\r
247       <td>EDMA LLD example fails for multi core  run for TCI6486 target</td>\r
248     </tr>\r
249 \r
250     <tr>\r
251       <td width="200">SDOCM00078797</td>\r
252       <td>Problems with using Generic RM library on EDMA3LLD</td>\r
253     </tr>\r
254 \r
255   </tbody>\r
256 </table>\r
257 \r
258 <p>\r
259 <a name="Whats_New"><FONT COLOR ='RED'>The following IRs are raised on this release:<b>Known Issues</b></FONT>\r
260 </a></p>\r
261 <table width="100%">\r
262   <tbody>\r
263     <tr>\r
264       <th>ID</th>\r
265       <th>Headline</th>\r
266     </tr>\r
267 \r
268     <tr>\r
269       <td width="200"><FONT COLOR ='RED'>SDOCM00078640</FONT></td>\r
270       <td><FONT COLOR ='RED'>ARM 9 support for OMAPL138 is not available on Make based build of EDMA3LLD</FONT></td>\r
271     </tr>\r
272 \r
273     <tr>\r
274       <td width="200"><FONT COLOR ='RED'>SDSCM00039169</FONT></td>\r
275       <td><FONT COLOR ='RED'>EDMA3 Example fails for following Big Endian Simulators targets tci6608-sim/tci6616-sim</FONT></td>\r
276     </tr>\r
277 \r
278   </tbody>\r
279 </table>\r
280 \r
281 <br>\r
282 <hr><a name="Upgrade_Info"></a>\r
283 <h2><a name="Upgrade_Info">Upgrade Information</a></h2>\r
284 <p>\r
285 The EDMA3 LLD packages are available in the "packages/" subdirectory of\r
286 the product.\r
287 If you have a previous release of the EDMA3 LLD product, you can\r
288 install this\r
289 release next to it, and modify your application and/or server builds to\r
290 use this\r
291 newer release.\r
292 </p>\r
293 <hr>\r
294 <a name="Device_Support"></a>\r
295 <h2><a name="Device_Support">Device Support</a></h2>\r
296 <p>\r
297 This release supports and has been tested on the following devices:\r
298 </p>\r
299 <ul>\r
300   <a name="Device_Support"> <li>DA830 EVM:\r
301     <ul type="circle">\r
302       <li>C67x DSP/BIOS</li>\r
303     </ul>\r
304   </li>\r
305   <li>TCI6498 Simulator:</li>\r
306   </a>\r
307   <ul>\r
308     <li>C64X+ DSP/BIOS</li>\r
309   </ul>\r
310   <li>C6748 EVM:</li>\r
311   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
312   <li type="disc">OMAPL138 EVM:</li>\r
313   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
314   <li style="margin-left: 40px;" type="circle">ARM 9 SYSBIOS</li>\r
315   <li>TI816X Simulator:</li>\r
316   </a>\r
317   <ul>\r
318     <li>C67X DSP/BIOS</li>\r
319   </ul>\r
320     <li>TI816X EVM:</li>\r
321   </a>\r
322   <ul>\r
323     <li>C67X DSP/BIOS</li>\r
324   </ul>\r
325   <li>C6472 EVM:</li>\r
326   </a>\r
327   <ul>\r
328     <li>C64X+ DSP/BIOS</li>\r
329   </ul>\r
330     <li>TCI6486 EVM:</li>\r
331   </a>\r
332   <ul>\r
333     <li>C64X+ DSP/BIOS</li>\r
334   </ul>\r
335       <li>TI814X EVM:</li>\r
336   </a>\r
337   <ul>\r
338     <li>C67X DSP/BIOS</li>\r
339   </ul>\r
340       <li>C6670 EVM:</li>\r
341   </a>\r
342   <ul>\r
343     <li>C66X DSP/BIOS</li>\r
344   </ul>      \r
345   <li>C6678 EVM:</li>\r
346   </a>\r
347   <ul>\r
348     <li>C66X DSP/BIOS</li>\r
349   </ul>      \r
350   <li>TCI6608 Simulator:</li>\r
351   </a>\r
352   <ul>\r
353     <li>C66X DSP/BIOS</li>\r
354   </ul>      \r
355   <li>TCI6616 Simulator:</li>\r
356   </a>\r
357   <ul>\r
358     <li>C66X DSP/BIOS</li>\r
359   </ul>\r
360     </ul>\r
361 <hr>\r
362 <a name="Compatibility"></a>\r
363 <h2><a name="Compatibility">Compatibility Information</a></h2>\r
364 <h3><a name="Compatibility">Compatibility Key Definitions</a></h3>\r
365 <p>\r
366 Compatibility keys are intentionally independent of Marketing product\r
367 numbers\r
368 and are intended to:\r
369 </p>\r
370 <ol start="1" type="1">\r
371   <a name="Compatibility"> <li> Enable tooling to identify\r
372 incompatibilities between components, and </li>\r
373   <li> Convey a level of compatibility between different releases to\r
374 set end user expectations. </li>\r
375   </a>\r
376 </ol>\r
377 <p>\r
378 Compatibility keys are composed of 3 comma-delimited numbers - M, S, R\r
379 - where:\r
380 </p>\r
381 <ul type="disc">\r
382   <a name="Compatibility"> <li> <b>M = Major</b>. A difference in M\r
383 indicates a break in compatibility. </li>\r
384   <li> <b>S = Source</b>. A difference in S indicates source\r
385 compatibility. That is, the user's source doesn't require change, but <i>does</i>\r
386 require rebuilding. </li>\r
387   <li> <b>R = Radix</b>. A difference in R indicates an introduction\r
388 of new features, but compatibility with previous interfaces has not\r
389 broken. If libraries are provided by the package, an application must\r
390 re-link with the new libraries, but not rebuild from source. </li>\r
391   </a>\r
392 </ul>\r
393 <hr>\r
394 <a name="Validation"></a>\r
395 <h2><a name="Validation">Validation</a></h2>\r
396 <p>\r
397 This release was built and validated against using the following\r
398 components:\r
399 </p>\r
400 <ul type="disc">\r
401   <a name="Validation"> <li>CCS 4.2.0.09000</li>\r
402   <li>C6x Code Generation Tools version 7.0.4</li>\r
403   <li>C6x Code Generation Tools version 7.2.0 GA</li>\r
404   <li>TMS470 Code Generation Tools 4.6.3</li>\r
405   <li>DSP/BIOS 6.31.04.27</li>\r
406   <li>XDC Tools 3.20.07.86</li>\r
407   <li>TCI6498 Simulator 0.7.1</li>\r
408   <li>TI816X Simulator 0.7.1</li>\r
409   </a>\r
410 </ul>\r
411 <p>\r
412 This release was validated in the following configurations:\r
413 </p>\r
414 <ul>\r
415   <li> DA830 EVM:\r
416     <ul type="circle">\r
417       <li>C67x DSP/BIOS</li>\r
418     </ul>\r
419   </li>\r
420   <li> TCI6498 Simulator:\r
421     <ul type="circle">\r
422       <li>C64X+ DSP/BIOS</li>\r
423     </ul>\r
424   </li>\r
425   <li>C6748 EVM:</li>\r
426   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
427   <li>OMAPL138 EVM:</li>\r
428   <ul>\r
429     <li>C67x DSP/BIOS</li>\r
430     <li>ARM 9 SYSBIOS</li>\r
431   </ul>\r
432   <li>TI816X Simulator:</li>\r
433   </a>\r
434   <ul>\r
435     <li>C67X DSP/BIOS</li>\r
436   </ul>\r
437     <li>TI816X EVM:</li>\r
438   </a>\r
439   <ul>\r
440     <li>C67X DSP/BIOS</li>\r
441   </ul>\r
442   <li>C6472 EVM:</li>\r
443   </a>\r
444   <ul>\r
445     <li>C64X+ DSP/BIOS</li>\r
446   </ul>\r
447     <li>TCI6486 EVM:</li>\r
448   </a>\r
449   <ul>\r
450     <li>C64X+ DSP/BIOS</li>\r
451   </ul>\r
452     <li>TI814X EVM:</li>\r
453   </a>\r
454   <ul>\r
455     <li>C67X DSP/BIOS</li>\r
456   </ul>\r
457       <li>C6670 EVM:</li>\r
458   </a>\r
459   <ul>\r
460     <li>C66X DSP/BIOS</li>\r
461   </ul>      \r
462   <li>C6678 EVM:</li>\r
463   </a>\r
464   <ul>\r
465     <li>C66X DSP/BIOS</li>\r
466   </ul>      \r
467   <li>TCI6608 Simulator:</li>\r
468   </a>\r
469   <ul>\r
470     <li>C66X DSP/BIOS</li>\r
471   </ul>      \r
472   <li>TCI6616 Simulator:</li>\r
473   </a>\r
474   <ul>\r
475     <li>C66X DSP/BIOS</li>\r
476   </ul>\r
477   </ul>\r
478 <hr><a name="Known_Issues">\r
479 </a>\r
480 <h2><a name="Known_Issues">Known Issues</a></h2>\r
481 <p>\r
482 The following are known issues with the current EDMA3 LLD release:\r
483 </p>\r
484 <h4><a name="Known_Issues">Pre-built instrumented libraries for DA830\r
485 not provided initially.</a></h4>\r
486 <p>Pre-built instrumented EDMA3 libraries for DA830 will not be\r
487 provided\r
488 initially. XDC does not support the same and hence the limitation. See\r
489 IR#\r
490 SDOCM00036738 for more details.\r
491 </p>\r
492 <h4><a name="Known_Issues">EDMA3 hardware does not work properly in\r
493 FIFO mode with all the controllers.</a></h4>\r
494 <p>Very few peripherals support EDMA3 FIFO mode. EMIF controller\r
495 doesn't support\r
496 the same. So EDMA3 CANNOT be used in FIFO mode for doing a\r
497 memory-to-memory data\r
498 transfers, EDMA3 being configured in the FIFO mode. Applications trying\r
499 to use\r
500 EDMA3 in FIFO mode should first check their respective\r
501 peripheral-controller\r
502 document for this mode support.\r
503 </p>\r
504 <h4><a name="Known_Issues">PingPong Example Fails for certain EDMA\r
505 instances for some DSP cores in Release mode only.</a></h4>\r
506 <p>The PingPong example in the package fails for certain EDMA Instances\r
507 for some DSP cores in Release mode only. It passes for Debug mode. See\r
508 IR#\r
509 SDOCM00064758 for more details.\r
510 </p>\r
511 <hr>\r
512 <a name="Examples"></a>\r
513 <h2><a name="Examples">Examples</a></h2>\r
514 <p>\r
515 EDMA3 LLD sample initialization libraries / OS abstraction layers (for\r
516 different\r
517 platforms) are located in:\r
518 </p>\r
519 <ul type="disc">\r
520   <a name="Examples"> <li> For Resource Manager: They could be located\r
521 in <tt>edma3_lld_02_11_01_XX\packages\ti\sdo\edma3\rm\sample\lib</tt>\r
522 folder. </li>\r
523   <li> For EDMA3 Driver: They could be located in <tt>edma3_lld_02_11_01_XX\packages\ti\sdo\edma3\drv\sample\lib</tt>\r
524 folder. </li>\r
525   </a>\r
526 </ul>\r
527 <p>\r
528 EDMA3 LLD stand-alone applications (for different platforms) are\r
529 located in:\r
530 </p>\r
531 <ul type="disc">\r
532   <a name="Examples"> <li> EDMA3 Driver: They could be located in <tt>edma3_lld_02_11_01_XX\examples\edma3_driver\</tt>\r
533 folder. </li>\r
534   </a>\r
535 </ul>\r
536 <ul type="disc">\r
537   <a name="Examples"> <li> CSL2.x DAT Reference Implementation: It\r
538 could be located in <tt>edma3_lld_02_11_01_XX\examples\CSL2_DAT_DEMO\</tt>\r
539 folder. </li>\r
540   </a>\r
541 </ul>\r
542 <hr>\r
543 <a name="Version"></a>\r
544 <h2><a name="Version">Version Information</a></h2>\r
545 <p>\r
546 This product's version follows a version format, <b>M.mm.pp.bb</b>,\r
547 where\r
548 <b>M</b> is a 2 digit major number,\r
549 <b>mm</b> is 2 digit minor number,\r
550 <b>pp</b> is a 2 digit patch number, and\r
551 <b>b</b> is an unrestricted set of digits used as an incrementing build\r
552 counter.\r
553 </p>\r
554 <p>\r
555 To support multiple side-by-side installations of the product, the\r
556 product\r
557 version is encoded in the top level directory, ex. <b>edma3_lld_02_11_01_XX</b>.\r
558 </p>\r
559 <p>Subsequent releases of patch upgrades will be identified by the\r
560 patch number,\r
561 ex. EDMA3 LLD 02.11.01 with directory <b>edma3_lld_02_11_02_YY</b>.\r
562 Typically, these\r
563 patches only include critical bug fixes.\r
564 </p>\r
565 <hr>\r
566 <a name="Support"></a>\r
567 <h2><a name="Support">Technical Support</a></h2>\r
568 <p>\r
569 For technical support, contact <a href="mailto:softwaresupport@ti.com">softwaresupport@ti.com</a>\r
570 </p>\r
571 <hr>\r
572 <p>Last updated: February 15, 2011\r
573 </p>\r
574 </body>\r
575 </html>\r