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