;* ======================================================================== *;
;*  TEXAS INSTRUMENTS, INC.                                                 *;
;*                                                                          *;
;*  C67x DSP Library                                                        *;
;*                                                                          *;
;*      Release:        Version 1.00                                        *;
;*      Snapshot date:  17-Feb-2003                                         *;
;*                                                                          *;
;*  This library contains proprietary intellectual property of Texas        *;
;*  Instruments, Inc.  The library and its source code are protected by     *;
;*  various copyrights, and portions may also be protected by patents or    *;
;*  other legal protections.                                                *;
;*                                                                          *;
;*  This software is licensed for use with Texas Instruments TMS320         *;
;*  family DSPs.  This license was provided to you prior to installing      *;
;*  the software.  You may review this license by consulting the file       *;
;*  TI_license.PDF which accompanies the files in this library.             *;
;* ------------------------------------------------------------------------ *;
;*          Copyright (C) 2003 Texas Instruments, Incorporated.             *;
;*                          All Rights Reserved.                            *;
;* ======================================================================== *;

This file contains a brief description of the C67x DSP Library and how
to use it.

Other Related Documentation Located in DOCS folder:
    
    spru657.pdf - TMS320C67x DSP Library Programmer's Reference

Currently, the DSP Library is provided as a source archive, as well
as a Little Endian C67x object library with header files.

--------------------------------------------------------------------------------
Release Directory Structure

-----+-----lib
     |
     +-----include
     |
     +-----bin
     |
     +-----support
     |
     +-----docs*

lib      - contains the library files (.lib) and the source code (.src)
include  - contains all of the library header files
bin      - executable files
support  - support files
docs     - various documentation 
	* Note this content will be placed in the CCS docs directory

--------------------------------------------------------------------------------
Using the DSP Library

There are really two ways the DSP Library can be used, one is from
within Code Composer Studio and the other is by using the command line
tools. In both cases, it's a matter of including the library header
file, linking to the correct build of the library, and calling the
APIs.

-------------------------------------------------
Using the DSP Library in Code Composer Studio

1. First you have to specify to the linker to link the DSP Library
   into your application.  You do this by going to
   "Project->Options->Linker->Include Libraries" and then specify the
   DSP Library, dsp67x.lib.

2. For each of your C files that you plan to use an DSP Library
   kernel in, you must include the appropriate header file for each
   kernel.  For instance, to use the kernel "DSPF_sp_lms()", you must
   #include <dspf_sp_lms.h> in that file.

3. Now you may use the DSP Library API at will.


-----------------------------------------------------
Using the DSP Library with the Command Line Tools

1. You have to tell the linker to link your application with the
   DSP library.  You can do this by using the linker -l option in
   your linker command file or at the linker command line, i.e
   -ldsp67x.lib

2. For each of your C files that you plan to use an DSP Library
   kernel in, you must include the appropriate header file for each
   kernel.  For instance, to use the kernel "DSPF_sp_lms()", you must
   #include <dspf_sp_lms.h> in that file.


--------------------------------------------------------------------------------
How do I Re-Build the Library?

All of the DSP Library assembly source code is archived in the file dsp67x.src
located in the LIB folder.  This source archive may be rebuilt using
mk6x as follows:

    mk6x dsp67x.src -mv6700 -l dsp67x.lib

********************************************************************************
* End of README67x.TXT
********************************************************************************