3e6371ae86ffad5af22e84c06af9eb3af865e37f
[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">TIDSP00000000</td>\r
207       <td>&nbsp;Support for the C6748 and OMAPL138 platforms</td>\r
208     </tr>\r
209   </tbody>\r
210 </table>\r
211 <p>\r
212 The following IRs are closed:\r
213 </p>\r
214 <table width="100%">\r
215   <tbody>\r
216     <tr>\r
217       <th>ID</th>\r
218       <th>Headline</th>\r
219     </tr>\r
220     <tr>\r
221       <td width="200">SDOCM00068784</td>\r
222       <td>The package.xs files should get the library extension from\r
223 the xdc variable and should not be hard coded.<br>\r
224       </td>\r
225     </tr>\r
226   </tbody>\r
227 </table>\r
228 <hr>\r
229 <a name="Upgrade_Info"></a>\r
230 <h2><a name="Upgrade_Info">Upgrade Information</a></h2>\r
231 <p>\r
232 The EDMA3 LLD packages are available in the "packages/" subdirectory of\r
233 the product.\r
234 If you have a previous release of the EDMA3 LLD product, you can\r
235 install this\r
236 release next to it, and modify your application and/or server builds to\r
237 use this\r
238 newer release.\r
239 </p>\r
240 <hr>\r
241 <a name="Device_Support"></a>\r
242 <h2><a name="Device_Support">Device Support</a></h2>\r
243 <p>\r
244 This release supports and has been tested on the following devices:\r
245 </p>\r
246 <ul>\r
247   <a name="Device_Support"> <li>DA830 EVM:\r
248     <ul type="circle">\r
249       <li>C67x DSP/BIOS</li>\r
250     </ul>\r
251   </li>\r
252   <li>TCI6498 Simulator:</li>\r
253   </a>\r
254   <ul>\r
255     <li>C64X+ DSP/BIOS</li>\r
256   </ul>\r
257   <li>C6748 EVM:</li>\r
258   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
259   <li type="disc">OMAPL138 EVM</li>\r
260   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS </li>\r
261 </ul>\r
262 <hr>\r
263 <a name="Compatibility"></a>\r
264 <h2><a name="Compatibility">Compatibility Information</a></h2>\r
265 <h3><a name="Compatibility">Compatibility Key Definitions</a></h3>\r
266 <p>\r
267 Compatibility keys are intentionally independent of Marketing product\r
268 numbers\r
269 and are intended to:\r
270 </p>\r
271 <ol start="1" type="1">\r
272   <a name="Compatibility"> <li> Enable tooling to identify\r
273 incompatibilities between components, and </li>\r
274   <li> Convey a level of compatibility between different releases to\r
275 set end user expectations. </li>\r
276   </a>\r
277 </ol>\r
278 <p>\r
279 Compatibility keys are composed of 3 comma-delimited numbers - M, S, R\r
280 - where:\r
281 </p>\r
282 <ul type="disc">\r
283   <a name="Compatibility"> <li> <b>M = Major</b>. A difference in M\r
284 indicates a break in compatibility. </li>\r
285   <li> <b>S = Source</b>. A difference in S indicates source\r
286 compatibility. That is, the user's source doesn't require change, but <i>does</i>\r
287 require rebuilding. </li>\r
288   <li> <b>R = Radix</b>. A difference in R indicates an introduction\r
289 of new features, but compatibility with previous interfaces has not\r
290 broken. If libraries are provided by the package, an application must\r
291 re-link with the new libraries, but not rebuild from source. </li>\r
292   </a>\r
293 </ul>\r
294 <hr>\r
295 <a name="Validation"></a>\r
296 <h2><a name="Validation">Validation</a></h2>\r
297 <p>\r
298 This release was built and validated against using the following\r
299 components:\r
300 </p>\r
301 <ul type="disc">\r
302   <a name="Validation"> <li>CCS 4.1.1.00014</li>\r
303   <li>C6x Code Generation Tools version 6.1.12</li>\r
304   <li>DSP/BIOS 6.21.02.19</li>\r
305   <li>XDC Tools 3.15.03.36</li>\r
306   <li>TCI6498 Simulator 0.6.5</li>\r
307   </a>\r
308 </ul>\r
309 <p>\r
310 This release was validated in the following configurations:\r
311 </p>\r
312 <ul>\r
313   <li> DA830 EVM:\r
314     <ul type="circle">\r
315       <li>C67x DSP/BIOS</li>\r
316     </ul>\r
317   </li>\r
318   <li> TCI6498 Simulator:\r
319     <ul type="circle">\r
320       <li>C64X+ DSP/BIOS</li>\r
321     </ul>\r
322   </li>\r
323   <li>C6748 EVM:</li>\r
324   <li style="margin-left: 40px;" type="circle">C67x DSP/BIOS</li>\r
325   <li>OMAPL138 EVM:</li>\r
326   <ul>\r
327     <li>C67x DSP/BIOS</li>\r
328   </ul>\r
329 </ul>\r
330 <hr><a name="Known_Issues">\r
331 </a>\r
332 <h2><a name="Known_Issues">Known Issues</a></h2>\r
333 <p>\r
334 The following are known issues with the current EDMA3 LLD release:\r
335 </p>\r
336 <h4><a name="Known_Issues">Pre-built instrumented libraries for DA830\r
337 not provided initially.</a></h4>\r
338 <p>Pre-built instrumented EDMA3 libraries for DA830 will not be\r
339 provided\r
340 initially. XDC does not support the same and hence the limitation. See\r
341 IR#\r
342 SDOCM00036738 for more details.\r
343 </p>\r
344 <h4><a name="Known_Issues">EDMA3 hardware does not work properly in\r
345 FIFO mode with all the controllers.</a></h4>\r
346 <p>Very few peripherals support EDMA3 FIFO mode. EMIF controller\r
347 doesn't support\r
348 the same. So EDMA3 CANNOT be used in FIFO mode for doing a\r
349 memory-to-memory data\r
350 transfers, EDMA3 being configured in the FIFO mode. Applications trying\r
351 to use\r
352 EDMA3 in FIFO mode should first check their respective\r
353 peripheral-controller\r
354 document for this mode support.\r
355 </p>\r
356 <h4><a name="Known_Issues">PingPong Example Fails for certain EDMA\r
357 instances for some DSP cores in Release mode only.</a></h4>\r
358 <p>The PingPong example in the package fails for certain EDMA Instances\r
359 for some DSP cores in Release mode only. It passes for Debug mode. See\r
360 IR#\r
361 SDOCM00064758 for more details.\r
362 </p>\r
363 <hr>\r
364 <a name="Examples"></a>\r
365 <h2><a name="Examples">Examples</a></h2>\r
366 <p>\r
367 EDMA3 LLD sample initialization libraries / OS abstraction layers (for\r
368 different\r
369 platforms) are located in:\r
370 </p>\r
371 <ul type="disc">\r
372   <a name="Examples"> <li> For Resource Manager: They could be located\r
373 in <tt>edma3_lld_02_10_01_XX\packages\ti\sdo\edma3\rm\sample\lib</tt>\r
374 folder. </li>\r
375   <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
376 folder. </li>\r
377   </a>\r
378 </ul>\r
379 <p>\r
380 EDMA3 LLD stand-alone applications (for different platforms) are\r
381 located in:\r
382 </p>\r
383 <ul type="disc">\r
384   <a name="Examples"> <li> EDMA3 Driver: They could be located in <tt>edma3_lld_02_10_01_XX\examples\edma3_driver\</tt>\r
385 folder. </li>\r
386   </a>\r
387 </ul>\r
388 <ul type="disc">\r
389   <a name="Examples"> <li> CSL2.x DAT Reference Implementation: It\r
390 could be located in <tt>edma3_lld_02_10_01_XX\examples\CSL2_DAT_DEMO\</tt>\r
391 folder. </li>\r
392   </a>\r
393 </ul>\r
394 <hr>\r
395 <a name="Version"></a>\r
396 <h2><a name="Version">Version Information</a></h2>\r
397 <p>\r
398 This product's version follows a version format, <b>M.mm.pp.bb</b>,\r
399 where\r
400 <b>M</b> is a 2 digit major number,\r
401 <b>mm</b> is 2 digit minor number,\r
402 <b>pp</b> is a 2 digit patch number, and\r
403 <b>b</b> is an unrestricted set of digits used as an incrementing build\r
404 counter.\r
405 </p>\r
406 <p>\r
407 To support multiple side-by-side installations of the product, the\r
408 product\r
409 version is encoded in the top level directory, ex. <b>edma3_lld_02_10_02_XX</b>.\r
410 </p>\r
411 <p>Subsequent releases of patch upgrades will be identified by the\r
412 patch number,\r
413 ex. EDMA3 LLD 02.10.01 with directory <b>edma3_lld_02_10_02_YY</b>.\r
414 Typically, these\r
415 patches only include critical bug fixes.\r
416 </p>\r
417 <hr>\r
418 <a name="Support"></a>\r
419 <h2><a name="Support">Technical Support</a></h2>\r
420 <p>\r
421 For technical support, contact <a href="mailto:softwaresupport@ti.com">softwaresupport@ti.com</a>\r
422 </p>\r
423 <hr>\r
424 <p>Last updated: Apr 09, 2010\r
425 </p>\r
426 </body>\r
427 </html>\r