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