ipc_3_43_00_00_eng/docs/relnotes_archive/ipc_1_00_02_51_release_notes.html

   1 <!-- --COPYRIGHT--,BSD
   2  *  Copyright (c) $(CPYYEAR), Texas Instruments Incorporated
   3  *  All rights reserved.
   4  *
   5  *  Redistribution and use in source and binary forms, with or without
   6  *  modification, are permitted provided that the following conditions
   7  *  are met:
   8  *
   9  *  *  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  *
  12  *  *  Redistributions in binary form must reproduce the above copyright
  13  *     notice, this list of conditions and the following disclaimer in the
  14  *     documentation and/or other materials provided with the distribution.
  15  *
  16  *  *  Neither the name of Texas Instruments Incorporated nor the names of
  17  *     its contributors may be used to endorse or promote products derived
  18  *     from this software without specific prior written permission.
  19  *
  20  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  27  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  28  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  * --/COPYRIGHT-- -->
  32 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  33 <html><head><!-- saved from url=(0120)http://wiki.sanb.design.ti.com/twiki/bin/viewfile/Process/ReleaseNotesTemplate?rev=1;filename=example_release_notes.html --><!-- saved from url=(0113)file://C:\Documents and Settings\a0323759\Local Settings\Temporary Internet Files\OLKC\example_release_notes.html --><!-- /* * Copyright 2007 by Texas Instruments Incorporated . * * All rights reserved. Property of Texas Instruments Incorporated. * Restricted rights to use, duplicate or disclose this code are * granted through contract. * */ -->
  34
  35
  36 <title>IPC 1.00 Release Notes</title><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><!-- For now, we use the doxygen style sheet -->
  37
  38 <link href="release_notes_template_files/css.htm" type="text/css" rel="stylesheet">
  39 <meta content="MSHTML 6.00.2900.3395" name="GENERATOR"></head>
  40 <body>
  41 <table width="100%">
  42 <tbody>
  43 <tr>
  44 <td bgcolor="black" width="1"><a href="http://www.ti.com/"><img style="border: 0px solid ; width: 222px; height: 54px;" alt="Texas Instruments" src="docs/tilogo.gif"> </a></td>
  45 <td bgcolor="red"><img style="width: 314px; height: 26px;" alt="Technology for Innovators(tm)" src="docs/titagline.gif">
  46 </td>
  47 </tr>
  48 </tbody>
  49 </table>
  50 <h1 style="text-align: left;">IPC 1.00.02.51 GA
  51 Build Release Notes</h1>
  52 This release note is divided into the following sections:<br>
  53 <br>
  54 <a href="#General_Info">Introduction</a>,
  55 <a href="#Documentation">Documentation</a>, <a href="#Whats_New">What's New</a>, <a href="#Compatibility">Upgrade &amp; Compatibility
  56 Information</a>, <a href="#Host_Support">Host
  57 Support</a>, <a href="#Dependencies">Dependencies</a>,
  58 <a href="#Device_Support">Device Support</a>, <a href="#Validation">Validation Info</a>, <a href="#Known_Issues">Known Issues</a>, <a href="#Examples">Examples</a>, <a href="#Version">Version
  59 Information</a>, <a href="#Support">Technical
  60 Support</a>.
  61 <hr>
  62 <h2><a name="General_Info">Introduction</a></h2>
  63 <p>This is the production (GA) release of IPC 1.00.02.51*&nbsp;</p>
  64 <p>Interprocess communication mechanisms including message
  65 passing,
  66 streams, and linked lists, which work transparently in both
  67 uniprocessor and muiltiprocessor configurations.</p>
  68 <p>The IPC product is comprised of three main packages</p>
  69 <ul>
  70 <li><span style="font-weight: bold;">ti.sdo.io</span>:
  71 &nbsp; &nbsp; Contains I/O modules &nbsp;(e.g. Stream,
  72 IDriver interface, etc.) <span style="font-style: italic;"></span></li>
  73 <li><span style="font-weight: bold;">ti.sdo</span><span style="font-weight: bold;">.utils</span>: Contains
  74 helper modules (e.g. MultiProc, List and NameServer)</li>
  75 <li><span style="font-weight: bold;">ti.sdo.</span><span style="font-weight: bold;">ipc</span>: &nbsp;
  76 Contains multicore modules (e.g. MessageQ, Notify, ListMP, etc.) </li>
  77 </ul>
  78 These packages are provided as source code and prebuilt
  79 libraries. <br>
  80 <br>
  81 *The "ti.sdo.ipc" package is an EA (Early Adopter) release,&nbsp;so
  82 minor changes may occur in the next release.<br>
  83 <hr>
  84 <h2><a name="Documentation">Documentation</a></h2>
  85 <p>The following documentation is available:</p>
  86 <ul>
  87 <li><a href="docs/User_install.pdf">User
  88 Install&nbsp;Guide</a></li>
  89 <li><a href="docs/sprugo6.pdf">User Guide (SPRUO6)</a></li>
  90 </ul>
  91 <p>Release notes from previous releases are also available in the
  92 <a href="docs/relnotes_archive">relnotes_archive</a>
  93 directory. </p>
  94 <hr>
  95 <h2><a name="Whats_New">What's New</a></h2>
  96 <p><b>1.00.02.51 GA Build</b> <b>Release
  97 (this release)</b><big><span class="011215021-21062007"><font size="2"><big>.</big></font></span></big>
  98 </p>
  99 <p><span style="font-weight: bold;">Bug Fixes and
 100 Minor Enhancements:</span> See the list below for abbreviated
 101 list of bug fixes and enhancements. <br>
 102 <span style="font-weight: bold;"></span></p><ul><li>
 103 The following issues were resolved/verified for this release.
 104 </li></ul><table style="width: 1181px; margin-left: 29px;" width="100%">
 105 <colgroup width="15%"></colgroup><tbody>
 106 <tr>
 107 <td style="width: 147px;"><b>ID</b></td>
 108 <td style="width: 986px;"><b>Headline</b></td>
 109 </tr>
 110 <tr><td style="width: 147px;">SDOCM00059737&nbsp;</td><td style="width: 986px;">Remote name lookups fail if name is shorter than previous</td></tr><tr>
 111 <td style="width: 147px;">SDOCM00059628&nbsp;</td>
 112 <td style="width: 986px;">Bug with Interrupt modules for c64p devices</td>
 113 </tr>
 114 <tr>
 115 <td style="width: 147px;">SDOCM00059624&nbsp;</td>
 116 <td style="width: 986px;">Incorrect order when updating attrs in MessageQTransportShm_Instance_init</td>
 117 </tr>
 118 <tr><td style="width: 147px;">SDOCM00059623&nbsp;</td><td style="width: 986px;">IPC files need updated license banner and move version history</td></tr><tr>
 119 <td style="width: 147px;">SDOCM00059620&nbsp;</td>
 120 <td style="width: 986px;">NotifyDriverLoopback should set the 'maxEvents' field in the driver 'procInfo' struct</td>
 121 </tr>
 122 <tr>
 123 <td style="width: 147px;">SDOCM00059619&nbsp;</td>
 124 <td style="width: 986px;">GatePeterson.xdc is missing a @ModuleStartup tag</td>
 125 </tr>
 126 <tr>
 127 <td style="width: 147px;">SDOCM00059334&nbsp;</td>
 128 <td style="width: 986px;">Issues in ListMPSharedMemory and ListMP</td>
 129 </tr>
 130 </tbody>
 131 </table><div class="memitem"><ul></ul>
 132 </div>
 133 For information on enhancements and defect fixes in earlier releases,
 134 please refer to the release notes from previous releases that are
 135 available in the <a href="docs/relnotes_archive">relnotes_archive</a>
 136 directory.&nbsp;
 137 <hr>
 138 <h2><a name="Compatibility">Upgrade and
 139 Compatibility Information</a></h2>
 140 <p><span style="font-weight: bold;">Interface/API
 141 changes:</span> This release in not backward compatible with
 142 &nbsp;IPC 1.00.00.40 in the following areas:</p>
 143 <ul>
 144 <li>INameServerRemote_get prototype changed: It now matches the
 145 NameServer_get prototype.</li>
 146 <li>SharedRegion: A few API's prototypes and constants that
 147 were Int or UInt&nbsp;changed to UInt32.</li>
 148 <li>ListMP: Addeda constant ALLOWGROWTH. This is the default
 149 for maxRuntimeEntries instead of NameServer.ALLOWGROWTH.</li>
 150 <li>HeapMultiBuf Added&nbsp;constant ALLOWGROWTH. This is
 151 the default for maxRuntimeEntries instead of NameServer.ALLOWGROWTH.</li>
 152 <li>ti.sdo.ipc.GateXXX
 153 modules: The open() now returns an Int instead of a Status. The return
 154 values are the same, just the type changed.</li>
 155 <li>GateHWSem: Added local protection similar to GatePeterson.
 156 This change is backward compatible.</li>
 157 </ul>
 158 <ul>
 159 </ul>
 160 <hr>
 161 <h2><a name="Host_Support">Host Support</a></h2>
 162 <p>This release supports the following hosts:</p>
 163 <p>Windows XP SP2/SP3</p>
 164 <p>Windows Vista</p>
 165 <p>Linux (Redhat 4 and 5)</p>
 166 <p class="MsoPlainText" style="margin-left: 0.5in; text-indent: -0.25in;"><span style="font-size: 12pt; font-family: &quot;Times New Roman&quot;;"><o:p></o:p></span></p>
 167 <hr>
 168 <h2><a name="Dependencies">Dependencies</a>
 169 </h2>
 170 <p>This release requires the following other software components
 171 and tools versions to successfully function: </p>
 172 <ul>
 173 <li>DSP/BIOS 6.20.01.41</li>
 174 <li> XDCtools 3.15.02.62<br>
 175 </li>
 176 </ul>
 177 <hr>
 178 <h2><a name="Device_Support">Device Support</a></h2>
 179 Same devices&nbsp;as supported in DSP/BIOS 6.20.01.
 180 <hr>
 181 <h2><a name="Validation">Validation Information</a></h2>
 182 This release was validated using the following components:
 183 <ul>
 184 <li>CCS 4.0</li>
 185 <li>DSP/BIOS&nbsp;6.20.01.41</li>
 186 <li> XDCtools&nbsp;3.15.01.59</li>
 187 </ul>
 188 <hr>
 189 <h2><a name="Known_Issues">Known Issues</a></h2>
 190 There are several know issues with this release, primarily in the
 191 ti\sdo\ipc package (which is at EA status)<br>
 192 <br>
 193 <table width="100%">
 194 <colgroup width="15%"></colgroup><tbody>
 195 <tr>
 196 <td><b>ID</b></td>
 197 <td><b>Headline</b></td>
 198 </tr>
 199 <tr><td>SDOCM00059837&nbsp;</td><td>NotifyDriverShm should use Ipc module for obtaining cache line size</td></tr><tr><td>SDOCM00059824&nbsp;</td><td>HeapBuf's exact config parameter is ignored&nbsp;</td></tr><tr><td>SDOCM00059682&nbsp;</td><td>Remove System_printf() in MessageQTransportShm_Instance_init()</td></tr><tr>
 200 <td>SDOCM00058906&nbsp;</td>
 201 <td>Remote NameServer_get hangs if dest. not up&nbsp;</td>
 202 </tr>
 203 <tr>
 204 <td>SDOCM00058860&nbsp;</td>
 205 <td>HeapBuf_sharedMemReq should return UInt32 not
 206 Int&nbsp;</td>
 207 </tr>
 208 <tr>
 209 <td>SDOCM00058783&nbsp;</td>
 210 <td>Shared memory modules must check for correct memory
 211 alignment</td>
 212 </tr>
 213 <tr>
 214 <td>SDOCM00058782&nbsp;</td>
 215 <td>Need to resolve reserved events config in Notify/Notify
 216 Driver</td>
 217 </tr>
 218 <tr>
 219 <td>SDOCM00058747</td>
 220 <td>NotifyDriverLoopback should support static creation</td>
 221 </tr>
 222 <tr>
 223 <td>SDOCM00057295&nbsp;</td>
 224 <td>IPC: documention issue</td>
 225 </tr>
 226 <tr>
 227 <td>SDOCM00057277</td>
 228 <td>NameServer: ROV should show ALLOWGROWTH instead of
 229 0xffffffff for numDynamic</td>
 230 </tr>
 231 <tr>
 232 <td>SDOCM00057275</td>
 233 <td>ipc modules do not handle when MultiProc.Id = INVALIDID</td>
 234 </tr>
 235 <tr>
 236 <td>SDOCM00057267</td>
 237 <td>IPC modules with shared memory need to use BitsXX
 238 instead of UIntXX</td>
 239 </tr>
 240 <tr>
 241 <td>SDOCM00057265</td>
 242 <td>IPC/NameServer needs asynchronous support&nbsp;</td>
 243 </tr>
 244 <tr>
 245 <td>SDOCM00057260</td>
 246 <td>ipc/family needs code review and full regression tests</td>
 247 </tr>
 248 <tr>
 249 <td>SDOCM00057259&nbsp;</td>
 250 <td>IPC Benchmarks need be examined&nbsp;</td>
 251 </tr>
 252 <tr>
 253 <td>SDOCM00057258</td>
 254 <td>IPC portion of User Guide needs updating&nbsp;</td>
 255 </tr>
 256 <tr>
 257 <td>SDOCM00057257</td>
 258 <td>All IPC modules should support cacheFlag for better
 259 performance</td>
 260 </tr>
 261 <tr>
 262 <td>SDOCM00057255</td>
 263 <td>xGConf Product View for IPC needs to be
 264 refined.&nbsp;</td>
 265 </tr>
 266 <tr>
 267 <td>SDOCM00057254</td>
 268 <td>gates (Peterson and HWSem) needs code review and full
 269 regression tests</td>
 270 </tr>
 271 <tr>
 272 <td>SDOCM00057253</td>
 273 <td>NameServerRemoteNotify needs code review and full
 274 regression tests</td>
 275 </tr>
 276 <tr>
 277 <td>SDOCM00057251</td>
 278 <td>Notify needs code review and full regression
 279 tests&nbsp;</td>
 280 </tr>
 281 <tr>
 282 <td>SDOCM00057250</td>
 283 <td>ListMP needs code review and full regression
 284 tests&nbsp;</td>
 285 </tr>
 286 <tr>
 287 <td>SDOCM00057249</td>
 288 <td>SharedRegion needs code review and full regression tests</td>
 289 </tr>
 290 <tr>
 291 <td>SDOCM00057248</td>
 292 <td>MessageQTransportShm needs code review and full
 293 regression tests</td>
 294 </tr>
 295 <tr>
 296 <td>SDOCM00057247</td>
 297 <td>HeapMultiBuf needs code review and full regression tests</td>
 298 </tr>
 299 <tr>
 300 <td>SDOCM00057246</td>
 301 <td>HeapBuf needs code review and full
 302 reSDOCM00057242gression tests</td>
 303 </tr>
 304 <tr>
 305 <td>SDOCM00057245</td>
 306 <td>MessageQ needs code review and full regression tests</td>
 307 </tr>
 308 <tr>
 309 <td>SDOCM00057244</td>
 310 <td>HeapBuf's trackMaxAllocs does not work properly</td>
 311 </tr>
 312 <tr>
 313 <td>SDOCM00057243</td>
 314 <td>MessageQ heap management needs investigation [might
 315 require design change]</td>
 316 </tr>
 317 <tr>
 318 <td>SDOCM00057242</td>
 319 <td>HeapMultiBuf does not work&nbsp;</td>
 320 </tr>
 321 <tr>
 322 <td>SDOCM00057241</td>
 323 <td>Notify/notifyDrivers does not support static instance
 324 creation</td>
 325 </tr>
 326 <tr>
 327 <td>SDOCM00057239</td>
 328 <td>HeapBuf does not support static instance creation</td>
 329 </tr>
 330 <tr>
 331 <td>SDOCM00057238</td>
 332 <td>NameServerRemoteNotify does not support static instance
 333 creation</td>
 334 </tr>
 335 <tr>
 336 <td>SDOCM00057236</td>
 337 <td>MessageQTransportShm does not support static instance
 338 creation</td>
 339 </tr>
 340 <tr>
 341 <td>SDOCM00057049</td>
 342 <td>GatePeterson should support max protection
 343 configuration for optimization</td>
 344 </tr>
 345 <tr>
 346 <td>SDOCM00057006</td>
 347 <td>ROV views needed for GatePeterson and
 348 GateHWSem&nbsp;</td>
 349 </tr>
 350 <tr>
 351 <td>SDOCM00057005</td>
 352 <td>NotifyDriverShm should support static creation&nbsp;</td>
 353 </tr>
 354 <tr>
 355 <td>SDOCM00047848</td>
 356 <td>MSGQ needs sequence # and RTA hooks&nbsp;</td>
 357 </tr>
 358 <tr>
 359 <td>SDOCM00047053</td>
 360 <td>MessageQ_delete does not free memory back to user
 361 created heapMem</td>
 362 </tr>
 363 </tbody>
 364 </table>
 365 <br>
 366 <hr>
 367 <h2><a name="Examples">Examples</a></h2>
 368 The IPC product ships with several examples. The following is an
 369 explaination of each one. Refer to the&nbsp;<a href="docs/User_install.pdf"><span style="text-decoration: underline;"></span></a><a href="docs/User_install.pdf">User Install&nbsp;Guide</a>
 370 for details on building.<br>
 371 <big><span style="font-weight: bold;">io\examples</span></big><br>
 372 <div style="margin-left: 40px;">- <span style="font-weight: bold;">stream</span>: This example
 373 shows the use of ti.sysbios.io.Stream module to demonstrate IO
 374 streaming using a driver.<br>
 375 <br>
 376 </div>
 377 <big><span style="font-weight: bold;">utils\examples</span></big><br>
 378 <div style="margin-left: 40px;">- <span style="font-weight: bold;">list</span>:&nbsp;The
 379 list example shows how to use the basical functionality of the
 380 ti.sdo.utils.List module<br>
 381 - <span style="font-weight: bold;">multiProc</span>:
 382 The multiProc example shows how to use the basical functionality of the
 383 ti.sdo.utils.MultiProc module<br>
 384 - <span style="font-weight: bold;">multiProcSingleImage</span>:
 385 The multiProcSingleImage example shows how to configure an image to be
 386 able to run on multiple cores.<br>
 387 <br>
 388 </div>
 389 <big><span style="font-weight: bold;">ipc\examples\singlecore</span></big><br>
 390 <div style="margin-left: 40px;">- <span style="font-weight: bold;">notify_loopback</span>:
 391 This example shows how to use the Notify module. The driver is the
 392 NotifyDriverLoopback, so it can be run on a single processor.<br>
 393 <br>
 394 </div>
 395 <big style="font-weight: bold;">ipc\examples\multicore<br>
 396 </big>Please refer to the readme.txt in the multicore platform
 397 specific directories for details on how to run.<big style="font-weight: bold;"><br>
 398 </big>
 399 <div style="margin-left: 40px;">- <span style="font-weight: bold;">message</span>: This
 400 example shows messageQ on a multiprocessor system. <span style="font-style: italic;"></span><br>
 401 - <span style="font-weight: bold;">notify</span>:
 402 This example shows how to run the Notify module only on a
 403 multiprocessor system.&nbsp;<span style="font-style: italic;"></span><br>
 404 </div>
 405 <h2><a name="Version">Version Information</a></h2>
 406 <p>All releases&nbsp;have 4 digits (<b>M.mm.pp.bb</b>).
 407 This includes GA and pre-releases (engineering, EA, beta, etc.).
 408 Pre-releases are denoted with a&nbsp;suffix (e.g. 1.01.00.15_eng or
 409 1.01.00.21-beta). </p>
 410 <p>This product's version follows a version format, <b>M.mm.pp.bb</b>,
 411 where <b>M</b> is a single digit Major number, <b>mm</b>
 412 is 2 digit minor number, <b>pp</b> is a 2 digit patch
 413 number, and <b>b</b> is an unrestricted set of digits used
 414 as an incrementing build counter. </p>
 415 <p>To support multiple side-by-side installations of the product,
 416 the product version is encoded in the top level directory, ex. <b>ipc_1_00_00_40</b>.
 417 </p>
 418 <p>Subsequent releases of patch upgrades will be identified by
 419 the patch number, ex. IPC 1.00.01.41 with directory&nbsp;<b>ipc_1_00_01_41</b>.
 420 Typically, these patches only include critical bug fixes. </p>
 421 <p>Please note that version numbers and compatibility keys are
 422 NOT the same. For an explanation of compatibility keys, please refer to
 423 the 'Upgrade and Compatibility Information' section. </p>
 424 <hr>
 425 <h2><a name="Support">Technical Support</a></h2>
 426 <p>For technical support, contact <a href="https://www-a.ti.com/downloads/sds_support/targetcontent/FC/index.html">softwaresupport@ti.com<br>
 427 </a> </p>
 428 <hr>
 429 <p>Last updated: July 10, 2009 </p>
 430 </body></html>