By 
Alan Kamas, for Sonics, Inc.
Herve Alenxandrian, Sonics, Inc.
Yann Bajot, Prosilog 
Stphane Guntz, Prosilog 
James Aldis, Texas Instruments
and Anssi Haverinen, Nokia, Inc.

09-October-2004

Code Revision 2.0.3

Support
---------------

OCP-IP members may contact techsupport@ocpip.org for any support questions.

Description
---------------

The generic channel, the examples and the underlaying concepts are described in
the (Pdf) document Generic_TL_Channel.pdf.

The OCP specific channels, the examples and the underlaying concepts are
described in the (Pdf) document OCP_TL_Channel.pdf.

Installation
---------------

- Untar the 'tar.gz' archive
- Change directories to 'tl_sc' and run:

    make PREFIX=/path/to/distribution TL2_PACKAGE=performance

or

    make PREFIX=/path/to/distribution TL2_PACKAGE=layered

    where /path/to/distribution represents the full path of the directory 
    where you want to install the package.  Note that some versions of "make"
    will have difficulties if there is a "~" (tilde) or "*" (asterix) in the
    path name.

    TL2_PACKAGE option selects a layered (like in release 2.0.2) or
    performance optimized OCP TL2 channel installation. Since the
    performance channel is not based on the Generic channel, the
    generic TL2 examples are not installed with this option.

Building and running the examples
---------------

Once you have installed the distribution, you can run the different examples:
    * 'examples/ocp_tl1' directory contains OCP TL1 examples coded with the 
      OCP specific TL1 channel 
    * 'examples/ocp_tl2' directory contains OCP TL1 examples coded with the 
      OCP specific TL2 channel 
    * 'examples/generic_tl1' directory contains OCP TL1 examples coded with 
      the generic channel 
    * 'examples/generic_tl2' directory contains OCP TL2 examples coded with 
      the generic channel 
    * 'examples/supplemental' directory contains additional, undocumented
      simple examples for generic and OCP channels
    
Refer to the README files for instructions to build and run the examples.


Notes
---------------
- See KNOWN_ISSUES.TXT for the latest issue reports.
- The performance TL2 channel does not support generic API.
  Generic API calls are being phased out in the future versions.
- The examples run with SystemC 2.0.1 using the compilers supported
  by SystemC 2.0.1.
- The compilers and OS listed in makefiles are the ones used in our tests. 
  SystemC must be compiled with the same compilers. Other OS and compiler 
  versions may work as well.
- The examples may also run with SystemC 2.0 and 2.1 in conjunction with the
  supported compilers

