/* $Id: etrax100ser.h,v 1.8 2000/10/12 09:56:36 pkj Exp $
 *
 * etrax100ser.h: Definitions for the Etrax100 serial driver.
 *
 * Copyright (C) 1998, 1999 Axis Communications AB
 */

#ifndef _ETRAX100_SERIAL_H
#define _ETRAX100_SERIAL_H

#include <linux/config.h>
#include <asm/termios.h>

struct serial_struct {
	int	type;
	int	line;
	int	port;
	int	irq;
	int	flags;
	int	xmit_fifo_size;
	int	custom_divisor;
	int	baud_base;
	unsigned short	close_delay;
	char	reserved_char[2];
	int	hub6;  /* FIXME: We don't have AT&T Hub6 boards! */
	unsigned short	closing_wait; /* time to wait before closing */
	unsigned short	closing_wait2; /* no longer used... */
	int	reserved[4];
};

/*
 * For the close wait times, 0 means wait forever for serial port to
 * flush its output.  65535 means don't wait at all.
 */
#define S_CLOSING_WAIT_INF	0
#define S_CLOSING_WAIT_NONE	65535

/*
 * Definitions for S_struct (and serial_struct) flags field
 */
#define S_HUP_NOTIFY 0x0001 /* Notify getty on hangups and closes 
				   on the callout port */
#define S_FOURPORT  0x0002	/* Set OU1, OUT2 per AST Fourport settings */
#define S_SAK	0x0004	/* Secure Attention Key (Orange book) */
#define S_SPLIT_TERMIOS 0x0008 /* Separate termios for dialin/callout */

#define S_SPD_MASK	0x0030
#define S_SPD_HI	0x0010	/* Use 56000 instead of 38400 bps */

#define S_SPD_VHI	0x0020  /* Use 115200 instead of 38400 bps */
#define S_SPD_CUST	0x0030  /* Use user-specified divisor */

#define S_SKIP_TEST	0x0040 /* Skip UART test during autoconfiguration */
#define S_AUTO_IRQ  0x0080 /* Do automatic IRQ during autoconfiguration */
#define S_SESSION_LOCKOUT 0x0100 /* Lock out cua opens based on session */
#define S_PGRP_LOCKOUT    0x0200 /* Lock out cua opens based on pgrp */
#define S_CALLOUT_NOHUP   0x0400 /* Don't do hangups for cua device */

#define S_FLAGS	0x0FFF	/* Possible legal S flags */
#define S_USR_MASK 0x0430	/* Legal flags that non-privileged
				 * users can set or reset */

/* Internal flags used only by kernel/chr_drv/serial.c */
#define S_INITIALIZED	0x80000000 /* Serial port was initialized */
#define S_CALLOUT_ACTIVE	0x40000000 /* Call out device is active */
#define S_NORMAL_ACTIVE	0x20000000 /* Normal device is active */
#define S_BOOT_AUTOCONF	0x10000000 /* Autoconfigure port on bootup */
#define S_CLOSING		0x08000000 /* Serial port is closing */
#define S_CTS_FLOW		0x04000000 /* Do CTS flow control */
#define S_CHECK_CD		0x02000000 /* i.e., CLOCAL */

/* Software state per channel */

#ifdef __KERNEL__
/*
 * This is our internal structure for each serial port's state.
 * 
 * Many fields are paralleled by the structure used by the serial_struct
 * structure.
 *
 * For definitions of the flags field, see tty.h
 */

#define SERRECBUFSIZE 32

struct e100_serial {
	int                   baud;
	volatile unsigned char *	port; /* R_SERIALx_CTRL */
	unsigned long	        irq;  /* bitnr in R_IRQ_MASK2 for dmaX_descr */

	volatile char *oclrintradr; /* adr to R_DMA_CHx_CLR_INTR, output */
	volatile unsigned long *ofirstadr;   /* adr to R_DMA_CHx_FIRST, output */
	volatile char *ocmdadr;     /* adr to R_DMA_CHx_CMD, output */
	const volatile unsigned short *ostatusadr;  /* adr to R_DMA_CHx_STATUS, output */
	volatile unsigned long  *ohwswadr;    /* adr to R_DMA_CHx_HWSW, output */

	volatile char *iclrintradr; /* adr to R_DMA_CHx_CLR_INTR, input */
	volatile unsigned long *ifirstadr;   /* adr to R_DMA_CHx_FIRST, input */
	volatile char *icmdadr;     /* adr to R_DMA_CHx_CMD, input */
	const volatile unsigned short *istatusadr;  /* adr to R_DMA_CHx_STATUS, input */
	volatile unsigned long  *ihwswadr;    /* adr to R_DMA_CHx_HWSW, input */

	int			flags; 		/* defined in tty.h */

	unsigned char         rx_ctrl; /* shadow for R_SERIALx_REC_CTRL */
	unsigned char         tx_ctrl; /* shadow for R_SERIALx_TR_CTRL */
	unsigned char         iseteop; /* bit number for R_SET_EOP for the input dma */
/* end of fields defined in rs_table[] in .c-file */
	unsigned char         fifo_didmagic; /* a fifo eop has been forced */

	struct etrax_dma_descr tr_descr, rec_descr;
	unsigned char rec_buf[SERRECBUFSIZE];

	int                   fifo_magic; /* fifo amount - bytes left in dma buffer */

	volatile int          tr_running; /* 1 if output is running */

	struct tty_struct 	*tty;
	int			read_status_mask;
	int			ignore_status_mask;
	int			x_char;	/* xon/xoff character */
	int			close_delay;
	unsigned short	closing_wait;
	unsigned short	closing_wait2;
	unsigned long		event;
	unsigned long		last_active;
	int			line;
	int                   type;  /* PORT_ETRAX100 */
	int			count;	    /* # of fd on device */
	int			blocked_open; /* # of blocked opens */
	long			session; /* Session of opening process */
	long			pgrp; /* pgrp of opening process */
	unsigned char 	*xmit_buf; /* circular buffer.. hmm */
	int			xmit_head;
	int			xmit_tail; /* next char which will be sent */
	int			xmit_cnt; /* amount of unsent chars in xmit_buf */
	struct tq_struct	tqueue;
	struct tq_struct	tqueue_hangup;
	struct termios	normal_termios;
	struct termios	callout_termios;
	struct wait_queue	*open_wait;
	struct wait_queue	*close_wait;
#ifdef CONFIG_RS485
	struct rs485_control    rs485;  /* RS-485 support */
#endif
};

/*
 * These are the supported serial types.
 */
#define PORT_UNKNOWN	0
#define PORT_ETRAX100	1
#define PORT_MAX	1

/*
 * The size of the serial xmit buffer is 1 page, or 4096 bytes
 */
#define SERIAL_XMIT_SIZE 4096

/*
 * Events are used to schedule things to happen at timer-interrupt
 * time, instead of at rs interrupt time.
 */
#define RS_EVENT_WRITE_WAKEUP	0

#endif /* __KERNEL__ */

#define VSP(X) (*(volatile unsigned short *)(X))
#define VCP(X) (*(volatile unsigned char *)(X))



#endif /* !(_ETRAX100_SERIAL_H) */
