Updated the data sheet for the memory usage statistics
[keystone-rtos/edma3_lld.git] / release_notes_edma3_lld_02_10_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.10.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.10.01 Release Notes</h1>\r
79 <h2 class="title">Apr 09, 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,OMAPL138 &amp; TCI6498 platforms, on\r
86 DSP/BIOS 6 side. Porting instructions\r
87 are also provided to use the package for different platforms and\r
88 Operating\r
89 Systems.\r
90 </p>\r
91 <p>\r
92 <a href="#Introduction">Introduction</a>,\r
93 <a href="#Documentation">Documentation</a>,\r
94 <a href="#Whats_New">What's New</a>,\r
95 <a href="#Upgrade_Info">Upgrade Info</a>,\r
96 <a href="#Device_Support">Device Support</a>,\r
97 <a href="#Compatibility">Compatibility Information</a>,\r
98 <a href="#Validation">Validation Info</a>,\r
99 <a href="#Known_Issues">Known Issues</a>,\r
100 <a href="#Examples">Examples</a>,\r
101 <a href="#Version">Version Information</a>,\r
102 <a href="#Support">Technical Support</a>\r
103 </p>\r
104 <hr>\r
105 <a name="Introduction"></a>\r
106 <h2><a name="Introduction">Introduction</a></h2>\r
107 <p>\r
108 EDMA3 LLD is a single product package containing the following\r
109 stand-alone\r
110 software components:\r
111 </p>\r
112 <ul type="disc">\r
113   <a name="Introduction"> <li> <b>EDMA3 Resource Manager</b> - TI\r
114 mandated library for all EDMA3 peripheral users to acquire and\r
115 configure EDMA3 hardware resources (DMA/QDMA channels, PaRAM Sets, TCCs\r
116 etc.) and DMA Interrupt Service Routines. </li>\r
117   <li> <b>EDMA3 Driver</b> - Functional library providing APIs for\r
118 programming, scheduling and synchronizing with EDMA transfers and many\r
119 more. </li>\r
120   </a>\r
121 </ul>\r
122 <p>\r
123 EDMA3 Resource Manager can be used independently whereas the EDMA3\r
124 Driver requires\r
125 the Resource Manager services internally.\r
126 </p>\r
127 <p>\r
128 EDMA3 LLD (both Resource Manager and the Driver) is a platform\r
129 independent package.\r
130 Hence it can be used across multiple platforms. Porting instructions\r
131 are provided for both the components to do the same.\r
132 </p>\r
133 <p>\r
134 It is also an OS-agnostic package and thus can be used across multiple\r
135 operating\r
136 systems. OS-adaptation layer needs to be provided by the user (in case\r
137 it is needed)\r
138 for OS customization. Instructions to do the same are also provided\r
139 along with\r
140 the package.\r
141 </p>\r
142 <p>\r
143 The Low Level Driver has already been ported (DSP/BIOS Operating\r
144 Systems)\r
145 and tested on various platforms mentioned below. Sample initialization\r
146 libraries,\r
147 which configure the EDMA3 hardware and provide the necessary OS\r
148 abstraction layer,\r
149 are also a part of the package. These libraries are available both for\r
150 the EDMA3\r
151 Resource Manager and EDMA3 Driver. These could be used for proper\r
152 initialization of the software component(s) along with the OS\r
153 adaptation layer\r
154 for the same.\r
155 </p>\r
156 <p>\r
157 The Low Level Driver consists of the following packages:\r
158 </p>\r
159 <ul type="disc">\r
160   <a name="Introduction"> <li> <tt><b>ti.sdo.edma3.rm</b></tt> -\r
161 EDMA3 Resource Manager. </li>\r
162   <li> <tt><b>ti.sdo.edma3.rm.sample</b></tt> - Sample initialization\r
163 library / OS abstraction layer for the Resource Manager. </li>\r
164   <li> <tt><b>ti.sdo.edma3.drv</b></tt> - EDMA3 Driver. </li>\r
165   <li> <tt><b>ti.sdo.edma3.drv.sample</b></tt> - Sample initialization\r
166 library / OS abstraction layer for the Driver. </li>\r
167   </a>\r
168 </ul>\r
169 <a name="Documentation">\r
170 </a>\r
171 <h2><a name="Documentation">Documentation</a></h2>\r
172 <p>The following documentation is available:\r
173 </p>\r
174 <ul type="disc">\r
175   <li><a href="docs/EDMA3_RM_Release_Notes.pdf">EDMA3 Resource Manager\r
176 Release Notes</a></li>\r
177   <li> <a href="packages/ti/sdo/edma3/rm/docs/EDMA3_RM_User_Guide.pdf">EDMA3\r
178 Resource Manager User's Guide</a> </li>\r
179   <li> <a href="docs/EDMA3_Driver_Release_Notes.pdf">EDMA3 Driver\r
180 Release Notes</a> </li>\r
181   <li> <a\r
182  href="packages/ti/sdo/edma3/drv/docs/EDMA3_Driver_User_Guide.pdf">EDMA3\r
183 Driver User's Guide</a> </li>\r
184   <li> EDMA3 Resource Manager Application Programming Interface (API)\r
185 Reference Guide (<a href="packages/ti/sdo/edma3/rm/docs/html/index.html">HTML</a>\r
186 | <a href="packages/ti/sdo/edma3/rm/docs/EDMA3_Resource_Manager.chm">CHM</a>)\r
187   </li>\r
188   <li> EDMA3 Driver Application Programming Interface Reference Guide (<a\r
189  href="packages/ti/sdo/edma3/drv/docs/html/index.html">HTML</a> | <a\r
190  href="packages/ti/sdo/edma3/drv/docs/EDMA3_Driver.chm">CHM</a>) </li>\r
191   <li> <a href="examples/CSL2_DAT_DEMO/docs/CSL_DAT_Adapter.ppt">CSL\r
192 2.x DAT Reference Implementation on EDMA3 Hardware using EDMA3 LLD</a> </li>\r
193 </ul>\r
194 <hr>\r
195 <a name="Whats_New"></a>\r
196 <h2><a name="Whats_New">What's New</a></h2>\r
197 <p>02.10.01 - In this release the following ECNs are implemented:\r
198 </p>\r
199 <table width="100%">\r
200   <tbody>\r
201     <tr>\r
202       <th>ID</th>\r
203       <th>Headline</th>\r
204     </tr>\r
205     <tr>\r
206       <td width="200">TIDSP00012302<span\r
207  style="font-size: 11pt; font-family: &quot;Calibri&quot;,&quot;sans-serif&quot;;"></span></td>\r
208       <td>&nbsp;Adding support for&nbsp;OMAPL138 platform for EDMA LLD\r
209 for BIOS6</td>\r
210     </tr>\r
211     <tr>\r
212       <td>TIDSP00012307</td>\r
213       <td>&nbsp;Adding support for C6748 platform for EDMA LLD for BIOS6</td>\r
214     </tr>\r
215   </tbody>\r
216 </table>\r
217 <p>\r
218 The following IRs are closed:\r
219 </p>\r
220 <table width="100%">\r
221   <tbody>\r
222     <tr>\r
223       <th>ID</th>\r
224       <th>Headline</th>\r
225     </tr>\r
226     <tr>\r
227       <td width="200">SDOCM00068784</td>\r
228       <td>The package.xs files should get the library extension from\r
229 the xdc variable and should not be hard coded.<br>\r
230       </td>\r
231     </tr>\r
232   </tbody>\r
233 </table>\r
234 <hr>\r
235 <a name="Upgrade_Info"></a>\r
236 <h2><a name="Upgrade_Info">Upgrade Information</a></h2>\r
237 <p>\r
238 The EDMA3 LLD packages are available in the "packages/" subdirectory of\r
239 the product.\r
240 If you have a previous release of the EDMA3 LLD product, you can\r
241 install this\r
242 release next to it, and modify your application and/or server builds to\r
243 use this\r
244 newer release.\r
245 </p>\r
246 <hr>\r
247 <a name="Device_Support"></a>\r
248 <h2><a name="Device_Support">Device Support</a></h2>\r
249 <p>\r
250 This release supports and has been tested on the following devices:\r
251 </p>\r
252 <ul>\r
253   <a name="Device_Support"> <li>DA830 EVM:\r
254     <ul type="circle">\r
255       <li>C67x DSP/BIOS</li>\r
256     </ul>\r
257   </li>\r
258   <li>TCI6498 Simulator:</li>\r
259   </a>\r
260   <ul>\r
261     <li>C64X+ DSP/BIOS</li>\r
262   </ul>\r
263   <li>C6748 EVM:</li>\r
264   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
265   <li type="disc">OMAPL138 EVM</li>\r
266   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS </li>\r
267 </ul>\r
268 <hr>\r
269 <a name="Compatibility"></a>\r
270 <h2><a name="Compatibility">Compatibility Information</a></h2>\r
271 <h3><a name="Compatibility">Compatibility Key Definitions</a></h3>\r
272 <p>\r
273 Compatibility keys are intentionally independent of Marketing product\r
274 numbers\r
275 and are intended to:\r
276 </p>\r
277 <ol start="1" type="1">\r
278   <a name="Compatibility"> <li> Enable tooling to identify\r
279 incompatibilities between components, and </li>\r
280   <li> Convey a level of compatibility between different releases to\r
281 set end user expectations. </li>\r
282   </a>\r
283 </ol>\r
284 <p>\r
285 Compatibility keys are composed of 3 comma-delimited numbers - M, S, R\r
286 - where:\r
287 </p>\r
288 <ul type="disc">\r
289   <a name="Compatibility"> <li> <b>M = Major</b>. A difference in M\r
290 indicates a break in compatibility. </li>\r
291   <li> <b>S = Source</b>. A difference in S indicates source\r
292 compatibility. That is, the user's source doesn't require change, but <i>does</i>\r
293 require rebuilding. </li>\r
294   <li> <b>R = Radix</b>. A difference in R indicates an introduction\r
295 of new features, but compatibility with previous interfaces has not\r
296 broken. If libraries are provided by the package, an application must\r
297 re-link with the new libraries, but not rebuild from source. </li>\r
298   </a>\r
299 </ul>\r
300 <hr>\r
301 <a name="Validation"></a>\r
302 <h2><a name="Validation">Validation</a></h2>\r
303 <p>\r
304 This release was built and validated against using the following\r
305 components:\r
306 </p>\r
307 <ul type="disc">\r
308   <a name="Validation"> <li>CCS 4.1.1.00014</li>\r
309   <li>C6x Code Generation Tools version 6.1.12</li>\r
310   <li>DSP/BIOS 6.21.02.19</li>\r
311   <li>XDC Tools 3.15.03.36</li>\r
312   <li>TCI6498 Simulator 0.6.5</li>\r
313   </a>\r
314 </ul>\r
315 <p>\r
316 This release was validated in the following configurations:\r
317 </p>\r
318 <ul>\r
319   <li> DA830 EVM:\r
320     <ul type="circle">\r
321       <li>C67x DSP/BIOS</li>\r
322     </ul>\r
323   </li>\r
324   <li> TCI6498 Simulator:\r
325     <ul type="circle">\r
326       <li>C64X+ DSP/BIOS</li>\r
327     </ul>\r
328   </li>\r
329   <li>C6748 EVM:</li>\r
330   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
331   <li>OMAPL138 EVM:</li>\r
332   <ul>\r
333     <li>C67x DSP/BIOS</li>\r
334   </ul>\r
335 </ul>\r
336 <hr><a name="Known_Issues">\r
337 </a>\r
338 <h2><a name="Known_Issues">Known Issues</a></h2>\r
339 <p>\r
340 The following are known issues with the current EDMA3 LLD release:\r
341 </p>\r
342 <h4><a name="Known_Issues">Pre-built instrumented libraries for DA830\r
343 not provided initially.</a></h4>\r
344 <p>Pre-built instrumented EDMA3 libraries for DA830 will not be\r
345 provided\r
346 initially. XDC does not support the same and hence the limitation. See\r
347 IR#\r
348 SDOCM00036738 for more details.\r
349 </p>\r
350 <h4><a name="Known_Issues">EDMA3 hardware does not work properly in\r
351 FIFO mode with all the controllers.</a></h4>\r
352 <p>Very few peripherals support EDMA3 FIFO mode. EMIF controller\r
353 doesn't support\r
354 the same. So EDMA3 CANNOT be used in FIFO mode for doing a\r
355 memory-to-memory data\r
356 transfers, EDMA3 being configured in the FIFO mode. Applications trying\r
357 to use\r
358 EDMA3 in FIFO mode should first check their respective\r
359 peripheral-controller\r
360 document for this mode support.\r
361 </p>\r
362 <h4><a name="Known_Issues">PingPong Example Fails for certain EDMA\r
363 instances for some DSP cores in Release mode only.</a></h4>\r
364 <p>The PingPong example in the package fails for certain EDMA Instances\r
365 for some DSP cores in Release mode only. It passes for Debug mode. See\r
366 IR#\r
367 SDOCM00064758 for more details.\r
368 </p>\r
369 <hr>\r
370 <a name="Examples"></a>\r
371 <h2><a name="Examples">Examples</a></h2>\r
372 <p>\r
373 EDMA3 LLD sample initialization libraries / OS abstraction layers (for\r
374 different\r
375 platforms) are located in:\r
376 </p>\r
377 <ul type="disc">\r
378   <a name="Examples"> <li> For Resource Manager: They could be located\r
379 in <tt>edma3_lld_02_10_01_XX\packages\ti\sdo\edma3\rm\sample\lib</tt>\r
380 folder. </li>\r
381   <li> For EDMA3 Driver: They could be located in <tt>edma3_lld_02_10_01_XX\packages\ti\sdo\edma3\drv\sample\lib</tt>\r
382 folder. </li>\r
383   </a>\r
384 </ul>\r
385 <p>\r
386 EDMA3 LLD stand-alone applications (for different platforms) are\r
387 located in:\r
388 </p>\r
389 <ul type="disc">\r
390   <a name="Examples"> <li> EDMA3 Driver: They could be located in <tt>edma3_lld_02_10_01_XX\examples\edma3_driver\</tt>\r
391 folder. </li>\r
392   </a>\r
393 </ul>\r
394 <ul type="disc">\r
395   <a name="Examples"> <li> CSL2.x DAT Reference Implementation: It\r
396 could be located in <tt>edma3_lld_02_10_01_XX\examples\CSL2_DAT_DEMO\</tt>\r
397 folder. </li>\r
398   </a>\r
399 </ul>\r
400 <hr>\r
401 <a name="Version"></a>\r
402 <h2><a name="Version">Version Information</a></h2>\r
403 <p>\r
404 This product's version follows a version format, <b>M.mm.pp.bb</b>,\r
405 where\r
406 <b>M</b> is a 2 digit major number,\r
407 <b>mm</b> is 2 digit minor number,\r
408 <b>pp</b> is a 2 digit patch number, and\r
409 <b>b</b> is an unrestricted set of digits used as an incrementing build\r
410 counter.\r
411 </p>\r
412 <p>\r
413 To support multiple side-by-side installations of the product, the\r
414 product\r
415 version is encoded in the top level directory, ex. <b>edma3_lld_02_10_02_XX</b>.\r
416 </p>\r
417 <p>Subsequent releases of patch upgrades will be identified by the\r
418 patch number,\r
419 ex. EDMA3 LLD 02.10.01 with directory <b>edma3_lld_02_10_02_YY</b>.\r
420 Typically, these\r
421 patches only include critical bug fixes.\r
422 </p>\r
423 <hr>\r
424 <a name="Support"></a>\r
425 <h2><a name="Support">Technical Support</a></h2>\r
426 <p>\r
427 For technical support, contact <a href="mailto:softwaresupport@ti.com">softwaresupport@ti.com</a>\r
428 </p>\r
429 <hr>\r
430 <p>Last updated: Apr 09, 2010\r
431 </p>\r
432 </body>\r
433 </html>\r