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