#
#  Copyright 2003 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.
#  
#
# "@(#) DDK 1.10.00.23 07-02-03 (ddk-b12)"
TITLE
-----
UARTHW_EVMDM642 (Software IOM driver for the DM642 EVM UART) 

DOCUMENTATION
-------------
The documentation for this device driver can be found at:
	/ddk/docs/uart.pdf

USAGE
-----
This device driver is the lower level mini-driver for the hardware uart on
the DM642 EVM.
Because this driver is dependent on the higher level generic UARTMD 
driver, an application must link both the libraries from this driver and from 
the generic driver in order for it to function correctly. These two libraries 
are called uarthw_evmdm642.l64 and uartmd.l64 which are located in 
ddk/lib directory.

DESCRIPTION
-----------
UARTHW_EVMDM642 is an IOM driver for the Spectrum Digital DM642 EVM. This
board has a hardware UART(16c75x). The driver is implemented using this
hardware.

FILES
-----
- uarthw_evmdm642.c lower level hardware uart implementation.
- uarthw_evmdm642.pjt: project file for building the driver library for
	the evmdm642 platform(little endian).
- uarthw_evmdm642hal.h: UART h/w register and bit definitions.
- evmdm642_osd.c: i EVMDM642 interrupt handling routines.
- evmdm642_osd.h: Interface for CPLD (OSD/FPGA) interrupts on the EVMDM642 board.
- ddk/include/uarthw_evmdm642.h: lower level driver interface header file. 
- ddk/include/uarthw.h: upper level generic driver header file.
- readme.txt: this file

NOTES
-----
- Files in the library are compiled with "no optimization switch" turned on, 
  and the same is true for the project files. If you plan to use this module 
  in a project release, you should rebuild the library with optimization 
  turned on.

Constraints
-----------
- None.


Known Problems At Release
-------------------------
- (SDSsq31058) The device parameters for this driver are not documented in
  the current version of the UART document.  These parameters are similar to
  the parameters for the DSK5402 UART (which are documented).

	typedef struct UARTHW_EVMDM642_Params {
	    /* Flow Control Parameters */
	    UARTHW_EVMDM642_FlowControl	flowControl;	 
	
	    /* Communication Parameters */
	    UARTHW_EVMDM642_Parity	parity;
	    UARTHW_EVMDM642_WordLen	wordSize;
	    UARTHW_EVMDM642_StopBits	stopBits;
	    UARTHW_EVMDM642_Baud	baud;
	} UARTHW_EVMDM642_Params;

  Individual values for these fields can be found in the uarthw_evmdm642.h
  file.  The UART example for the EVMDM642 also shows how to configure
  the driver and use non-default device parameters.

  The UART device on the EVMDM642 is a dual UART. This device driver 
  distinguishes these by devid '0' and '1'. The board has an DB9
  connector for the 'devid = 0' UART, and a 10-pin connector for the
  'devid = 1' UART.  You can add both UARTs to your DSP/BIOS configuration
  file by adding 2 UDEV instances (e.g., "/uartA" with devid '0' and
  "/uartB" with devid '1').  You can specify different parameters for
  each of the 2 UARTs or use the same parameter structure to initialize
  both of them with the same settings.


Q&A
---
Q1: Where can I find the documentation for writing IOM drivers?
A2: The literature number is SPRU616, DSP/BIOS Device Driver Developer's Guide.