ixdp2400sio.h

ixp2400 bsp for vxworks

/* ixdp2400sio.h - ixp2400 uart header file */

/* Copyright 2001 Wind River Systems, Inc. */

/*
modification history
--------------------
01a,22aug03,scm  bspcheck release test modifications...
30may02, vgd, created from ns16552.h for ixdp2400
*/

#ifndef __INCixdp2400Sioh 
#define __INCixdp2400Sioh 

#ifdef __cplusplus
extern "C" {
#endif

/******************************************************************************
 *
 * REGISTER DESCRIPTION OF IXP2400 UART
 *
 *******************************************************************************/

#ifndef _ASMLANGUAGE

#include "sioLib.h"

#define IXP2400


/* Register offsets from base address */
#if defined(IXP2400)
#define RBR		0x00	/* receiver buffer register (Divisor Latch access bit)DLAB=0 */
#define THR		0x00	/* transmit holding register DLAB=0 */
#define DLL		0x00	/* divisor latch DLAB=1*/
#define IER		0x04	/* interrupt enable register DLAB=0 */
#define DLM		0x04	/* divisor latch(MS) DLAB=1 */
#define IIR		0x08	/* interrupt identification register */
#define FCR		0x08	/* FIFO control register */
#define LCR		0x0C	/* line control register */
#define LSR		0x14	/* line status register */
#define SCR		0x1C	/* scratch register ?should name it SPR*/
#else
#define RBR		0x00	/* receiver buffer register */
#define THR		0x00	/* transmit holding register */
#define DLL		0x00	/* divisor latch */
#define IER		0x01	/* interrupt enable register */
#define DLM		0x01	/* divisor latch(MS) */
#define IIR		0x02	/* interrupt identification register */
#define FCR		0x02	/* FIFO control register */
#define LCR		0x03	/* line control register */
#define MCR		0x04 	/* modem control register */
#define LSR		0x05	/* line status register */
#define MSR		0x06	/* modem status register */
#define SCR		0x07	/* scratch register */
#endif

#define BAUD_LO(baud)  ((XTAL / (16 * baud)) & 0xff)
#define BAUD_HI(baud)  (((XTAL / (16 * baud)) & 0xff00) >> 8)


/* Line Control Register */

#define CHAR_LEN_5	0x00	/* 5bits data size */
#define CHAR_LEN_6	0x01	/* 6bits data size */
#define CHAR_LEN_7	0x02	/* 7bits data size */
#define CHAR_LEN_8	0x03	/* 8bits data size */
#define LCR_STB		0x04	/* 2 stop bits */
#define ONE_STOP	0x00	/* one stop bit */
#define LCR_PEN		0x08	/* parity enable */
#define PARITY_NONE	0x00	/* parity disable */
#define LCR_EPS		0x10	/* even parity select */
#define LCR_SP		0x20	/* stick parity select */
#define LCR_SBRK	0x40	/* break control bit */
#define LCR_DLAB	0x80	/* divisor latch access enable */
#define DLAB		LCR_DLAB

/* Line Status Register */

#define LSR_DR		    0x01	/* data ready */
#define RxCHAR_AVAIL	LSR_DR	/* data ready */
#define LSR_OE		    0x02	/* overrun error */
#define LSR_PE		    0x04	/* parity error */
#define LSR_FE		    0x08	/* framing error */
#define LSR_BI		    0x10	/* break interrupt */
#define LSR_THRE	    0x20	/* transmit holding register empty */
#define LSR_TEMT	    0x40	/* transmitter empty */
#define LSR_FERR	    0x80	/* in fifo mode, set when PE,FE or BI error */

/* Interrupt Identification Register */

#define IIR_IP		0x01
#define IIR_ID		0x0e
#define IIR_RLS		0x06	/* received line status */
#define Rx_INT		IIR_RLS /* received line status */
#define IIR_RDA		0x04	/* received data available */
#define RxFIFO_INT	IIR_RDA /* received data available */
#define IIR_THRE	0x02	/* transmit holding register empty */
#define TxFIFO_INT	IIR_THRE 
#if defined(IXP2400)
#define IIR_TIMEOUT 0x08    /* char receiv tiemout */
#else
#define IIR_TIMEOUT	0x0c	/* char receiv tiemout */
#endif

/* Interrupt Enable Register */

#define IER_ERDAI	0x01	/* received data avail. & timeout int */
#define RxFIFO_BIT	IER_ERDAI
#define IER_ETHREI	0x02	/* transmitter holding register empty int */
#define TxFIFO_BIT	IER_ETHREI
#define IER_ELSI	0x04	/* receiver line status int enable */
#define Rx_RLS		IER_ELSI
#define IER_RTOIE   0x10    /*Time out*/
#define Rx_TIMEOUT   IER_RTOIE 

#if defined(IXP2400)
#define IER_RTOIE   0x10    /*Time out*/
#define Rx_TIMEOUT   IER_RTOIE
#else
#endif

/* Modem Control Register */

#define MCR_DTR		0x01	/* dtr output */
#define DTR		MCR_DTR
#define MCR_RTS		0x02	/* rts output */
#define MCR_OUT1	0x04	/* output #1 */
#define MCR_OUT2	0x08	/* output #2 */
#define MCR_LOOP	0x10	/* loopback enable */

/* Modem Status Register */

#define MSR_DCTS	0x01	/* cts change */
#define MSR_DDSR	0x02	/* dsr change */
#define MSR_TERI	0x04	/* ring indicator change */
#define MSR_DDCD	0x08	/* data carrier indicator change */
#define MSR_CTS		0x10	/* complement of cts */
#define MSR_DSR		0x20	/* complement of dsr */
#define MSR_RI		0x40	/* complement of ring signal */
#define MSR_DCD		0x80	/* complement of dcd */ 


/* FIFO Control Register */

#define FCR_EN		    0x01	/* enable xmit and rcvr */
#define FIFO_ENABLE	    FCR_EN
#define FCR_RXCLR	    0x02	/* clears rcvr fifo */
#define RxCLEAR		    FCR_RXCLR
#define FCR_TXCLR	    0x04	/* clears xmit fifo */
#define TxCLEAR		    FCR_TXCLR
#if defined(IXP2400)
#define FCR_ITL                 0xC0
#else
#endif


typedef  struct 	/* IXP2400_CHAN * */
    {
    /* always goes first */

    SIO_DRV_FUNCS *     pDrvFuncs;      /* driver functions */

    /* callbacks */

    STATUS      (*getTxChar) ();  /* pointer to xmitr function */	
    STATUS      (*putRcvChar) (); /* pointer to rcvr function */
    void *      getTxArg;
    void *      putRcvArg;

    UINT8 	*regs;		/* UART registers */
    UINT8 	level;		/* interrupt level for this device */
    UINT8 	ier;		/* copy of ier */
    UINT8 	lcr;		/* copy of lcr, not used by ns16552 driver */
#if defined(IXP2400)
#else
    UINT8 	mcr;		/* copy of modem control register */
#endif    
    UINT8 	pad1;

    UINT16      channelMode;	/* such as INT, POLL modes */
    UINT16      regDelta;	    /* register address spacing */
    int         baudRate;
    UINT32      xtal;		    /* UART clock frequency     */     
    UINT32	options;	        /* hardware setup options */

    } IXP2400_CHAN;

/* function declarations */

#if defined(__STDC__) || defined(__cplusplus)

extern void ixp2400Int (IXP2400_CHAN *);
extern void ixp2400DevInit (IXP2400_CHAN *);

#else

extern void ns16550Int ();
extern void ns16550DevInit ();

#endif  /* __STDC__ */

#endif	/* _ASMLANGUAGE */

#ifdef __cplusplus
}
#endif
 
#endif /* __INCixdp2400Sioh */