[linux.git] / include / linux / serial_core.h

/*
 *  linux/drivers/char/serial_core.h
 *
 *  Copyright (C) 2000 Deep Blue Solutions Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef LINUX_SERIAL_CORE_H
#define LINUX_SERIAL_CORE_H

/*
 * The type definitions.  These are from Ted Ts'o's serial.h
 */
#define PORT_UNKNOWN	0
#define PORT_8250	1
#define PORT_16450	2
#define PORT_16550	3
#define PORT_16550A	4
#define PORT_CIRRUS	5
#define PORT_16650	6
#define PORT_16650V2	7
#define PORT_16750	8
#define PORT_STARTECH	9
#define PORT_16C950	10
#define PORT_16654	11
#define PORT_16850	12
#define PORT_RSA	13
#define PORT_NS16550A	14
#define PORT_XSCALE	15
#define PORT_RM9000	16	/* PMC-Sierra RM9xxx internal UART */
#define PORT_MAX_8250	16	/* max port ID */

/*
 * ARM specific type numbers.  These are not currently guaranteed
 * to be implemented, and will change in the future.  These are
 * separate so any additions to the old serial.c that occur before
 * we are merged can be easily merged here.
 */
#define PORT_PXA	31
#define PORT_AMBA	32
#define PORT_CLPS711X	33
#define PORT_SA1100	34
#define PORT_UART00	35
#define PORT_21285	37

/* Sparc type numbers.  */
#define PORT_SUNZILOG	38
#define PORT_SUNSAB	39

/* DEC */
#define PORT_DZ		46
#define PORT_ZS		47

/* Parisc type numbers. */
#define PORT_MUX	48

/* Atmel AT91 / AT32 SoC */
#define PORT_ATMEL	49

/* Macintosh Zilog type numbers */
#define PORT_MAC_ZILOG	50	/* m68k : not yet implemented */
#define PORT_PMAC_ZILOG	51

/* SH-SCI */
#define PORT_SCI	52
#define PORT_SCIF	53
#define PORT_IRDA	54

/* Samsung S3C2410 SoC and derivatives thereof */
#define PORT_S3C2410    55

/* SGI IP22 aka Indy / Challenge S / Indigo 2 */
#define PORT_IP22ZILOG	56

/* Sharp LH7a40x -- an ARM9 SoC series */
#define PORT_LH7A40X	57

/* PPC CPM type number */
#define PORT_CPM        58

/* MPC52xx type numbers */
#define PORT_MPC52xx	59

/* IBM icom */
#define PORT_ICOM	60

/* Samsung S3C2440 SoC */
#define PORT_S3C2440	61

/* Motorola i.MX SoC */
#define PORT_IMX	62

/* Marvell MPSC */
#define PORT_MPSC	63

/* TXX9 type number */
#define PORT_TXX9	64

/* NEC VR4100 series SIU/DSIU */
#define PORT_VR41XX_SIU		65
#define PORT_VR41XX_DSIU	66

/* Samsung S3C2400 SoC */
#define PORT_S3C2400	67

/* M32R SIO */
#define PORT_M32R_SIO	68

/*Digi jsm */
#define PORT_JSM        69

#define PORT_PNX8XXX	70

/* Hilscher netx */
#define PORT_NETX	71

/* SUN4V Hypervisor Console */
#define PORT_SUNHV	72

#define PORT_S3C2412	73

/* Xilinx uartlite */
#define PORT_UARTLITE	74

/* Blackfin bf5xx */
#define PORT_BFIN	75

/* Micrel KS8695 */
#define PORT_KS8695	76

/* Broadcom SB1250, etc. SOC */
#define PORT_SB1250_DUART	77

/* Freescale ColdFire */
#define PORT_MCF	78

/* Blackfin SPORT */
#define PORT_BFIN_SPORT		79

/* MN10300 on-chip UART numbers */
#define PORT_MN10300		80
#define PORT_MN10300_CTS	81

#define PORT_SC26XX	82

/* SH-SCI */
#define PORT_SCIFA	83

#define PORT_S3C6400	84

#ifdef __KERNEL__

#include <linux/compiler.h>
#include <linux/interrupt.h>
#include <linux/circ_buf.h>
#include <linux/spinlock.h>
#include <linux/sched.h>
#include <linux/tty.h>
#include <linux/mutex.h>
#include <linux/sysrq.h>

struct uart_port;
struct uart_info;
struct serial_struct;
struct device;

/*
 * This structure describes all the operations that can be
 * done on the physical hardware.
 */
struct uart_ops {
	unsigned int	(*tx_empty)(struct uart_port *);
	void		(*set_mctrl)(struct uart_port *, unsigned int mctrl);
	unsigned int	(*get_mctrl)(struct uart_port *);
	void		(*stop_tx)(struct uart_port *);
	void		(*start_tx)(struct uart_port *);
	void		(*send_xchar)(struct uart_port *, char ch);
	void		(*stop_rx)(struct uart_port *);
	void		(*enable_ms)(struct uart_port *);
	void		(*break_ctl)(struct uart_port *, int ctl);
	int		(*startup)(struct uart_port *);
	void		(*shutdown)(struct uart_port *);
	void		(*flush_buffer)(struct uart_port *);
	void		(*set_termios)(struct uart_port *, struct ktermios *new,
				       struct ktermios *old);
	void		(*set_ldisc)(struct uart_port *);
	void		(*pm)(struct uart_port *, unsigned int state,
			      unsigned int oldstate);
	int		(*set_wake)(struct uart_port *, unsigned int state);

	/*
	 * Return a string describing the type of the port
	 */
	const char *(*type)(struct uart_port *);

	/*
	 * Release IO and memory resources used by the port.
	 * This includes iounmap if necessary.
	 */
	void		(*release_port)(struct uart_port *);

	/*
	 * Request IO and memory resources used by the port.
	 * This includes iomapping the port if necessary.
	 */
	int		(*request_port)(struct uart_port *);
	void		(*config_port)(struct uart_port *, int);
	int		(*verify_port)(struct uart_port *, struct serial_struct *);
	int		(*ioctl)(struct uart_port *, unsigned int, unsigned long);
#ifdef CONFIG_CONSOLE_POLL
	void	(*poll_put_char)(struct uart_port *, unsigned char);
	int		(*poll_get_char)(struct uart_port *);
#endif
};

#define UART_CONFIG_TYPE	(1 << 0)
#define UART_CONFIG_IRQ		(1 << 1)

struct uart_icount {
	__u32	cts;
	__u32	dsr;
	__u32	rng;
	__u32	dcd;
	__u32	rx;
	__u32	tx;
	__u32	frame;
	__u32	overrun;
	__u32	parity;
	__u32	brk;
	__u32	buf_overrun;
};

typedef unsigned int __bitwise__ upf_t;

struct uart_port {
	spinlock_t		lock;			/* port lock */
	unsigned long		iobase;			/* in/out[bwl] */
	unsigned char __iomem	*membase;		/* read/write[bwl] */
	unsigned int		irq;			/* irq number */
	unsigned int		uartclk;		/* base uart clock */
	unsigned int		fifosize;		/* tx fifo size */
	unsigned char		x_char;			/* xon/xoff char */
	unsigned char		regshift;		/* reg offset shift */
	unsigned char		iotype;			/* io access style */
	unsigned char		unused1;

#define UPIO_PORT		(0)
#define UPIO_HUB6		(1)
#define UPIO_MEM		(2)
#define UPIO_MEM32		(3)
#define UPIO_AU			(4)			/* Au1x00 type IO */
#define UPIO_TSI		(5)			/* Tsi108/109 type IO */
#define UPIO_DWAPB		(6)			/* DesignWare APB UART */
#define UPIO_RM9000		(7)			/* RM9000 type IO */

	unsigned int		read_status_mask;	/* driver specific */
	unsigned int		ignore_status_mask;	/* driver specific */
	struct uart_info	*info;			/* pointer to parent info */
	struct uart_icount	icount;			/* statistics */

	struct console		*cons;			/* struct console, if any */
#ifdef CONFIG_SERIAL_CORE_CONSOLE
	unsigned long		sysrq;			/* sysrq timeout */
#endif

	upf_t			flags;

#define UPF_FOURPORT		((__force upf_t) (1 << 1))
#define UPF_SAK			((__force upf_t) (1 << 2))
#define UPF_SPD_MASK		((__force upf_t) (0x1030))
#define UPF_SPD_HI		((__force upf_t) (0x0010))
#define UPF_SPD_VHI		((__force upf_t) (0x0020))
#define UPF_SPD_CUST		((__force upf_t) (0x0030))
#define UPF_SPD_SHI		((__force upf_t) (0x1000))
#define UPF_SPD_WARP		((__force upf_t) (0x1010))
#define UPF_SKIP_TEST		((__force upf_t) (1 << 6))
#define UPF_AUTO_IRQ		((__force upf_t) (1 << 7))
#define UPF_HARDPPS_CD		((__force upf_t) (1 << 11))
#define UPF_LOW_LATENCY		((__force upf_t) (1 << 13))
#define UPF_BUGGY_UART		((__force upf_t) (1 << 14))
#define UPF_MAGIC_MULTIPLIER	((__force upf_t) (1 << 16))
#define UPF_CONS_FLOW		((__force upf_t) (1 << 23))
#define UPF_SHARE_IRQ		((__force upf_t) (1 << 24))
#define UPF_BOOT_AUTOCONF	((__force upf_t) (1 << 28))
#define UPF_FIXED_PORT		((__force upf_t) (1 << 29))
#define UPF_DEAD		((__force upf_t) (1 << 30))
#define UPF_IOREMAP		((__force upf_t) (1 << 31))

#define UPF_CHANGE_MASK		((__force upf_t) (0x17fff))
#define UPF_USR_MASK		((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))

	unsigned int		mctrl;			/* current modem ctrl settings */
	unsigned int		timeout;		/* character-based timeout */
	unsigned int		type;			/* port type */
	const struct uart_ops	*ops;
	unsigned int		custom_divisor;
	unsigned int		line;			/* port index */
	resource_size_t		mapbase;		/* for ioremap */
	struct device		*dev;			/* parent device */
	unsigned char		hub6;			/* this should be in the 8250 driver */
	unsigned char		suspended;
	unsigned char		unused[2];
	void			*private_data;		/* generic platform data pointer */
};

/*
 * This is the state information which is only valid when the port
 * is open; it may be cleared the core driver once the device has
 * been closed.  Either the low level driver or the core can modify
 * stuff here.
 */
typedef unsigned int __bitwise__ uif_t;

struct uart_info {
	struct tty_port		port;
	struct circ_buf		xmit;
	uif_t			flags;

/*
 * Definitions for info->flags.  These are _private_ to serial_core, and
 * are specific to this structure.  They may be queried by low level drivers.
 *
 * FIXME: use the ASY_ definitions
 */
#define UIF_CHECK_CD		((__force uif_t) (1 << 25))
#define UIF_CTS_FLOW		((__force uif_t) (1 << 26))
#define UIF_NORMAL_ACTIVE	((__force uif_t) (1 << 29))
#define UIF_INITIALIZED		((__force uif_t) (1 << 31))
#define UIF_SUSPENDED		((__force uif_t) (1 << 30))

	struct tasklet_struct	tlet;
	wait_queue_head_t	delta_msr_wait;
};

/*
 * This is the state information which is persistent across opens.
 * The low level driver must not to touch any elements contained
 * within.
 */
struct uart_state {
	unsigned int		close_delay;		/* msec */
	unsigned int		closing_wait;		/* msec */

#define USF_CLOSING_WAIT_INF	(0)
#define USF_CLOSING_WAIT_NONE	(~0U)

	int			count;
	int			pm_state;
	struct uart_info	info;
	struct uart_port	*port;

	struct mutex		mutex;
};

#define UART_XMIT_SIZE	PAGE_SIZE


/* number of characters left in xmit buffer before we ask for more */
#define WAKEUP_CHARS		256

struct module;
struct tty_driver;

struct uart_driver {
	struct module		*owner;
	const char		*driver_name;
	const char		*dev_name;
	int			 major;
	int			 minor;
	int			 nr;
	struct console		*cons;

	/*
	 * these are private; the low level driver should not
	 * touch these; they should be initialised to NULL
	 */
	struct uart_state	*state;
	struct tty_driver	*tty_driver;
};

void uart_write_wakeup(struct uart_port *port);

/*
 * Baud rate helpers.
 */
void uart_update_timeout(struct uart_port *port, unsigned int cflag,
			 unsigned int baud);
unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
				struct ktermios *old, unsigned int min,
				unsigned int max);
unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);

/*
 * Console helpers.
 */
struct uart_port *uart_get_console(struct uart_port *ports, int nr,
				   struct console *c);
void uart_parse_options(char *options, int *baud, int *parity, int *bits,
			int *flow);
int uart_set_options(struct uart_port *port, struct console *co, int baud,
		     int parity, int bits, int flow);
struct tty_driver *uart_console_device(struct console *co, int *index);
void uart_console_write(struct uart_port *port, const char *s,
			unsigned int count,
			void (*putchar)(struct uart_port *, int));

/*
 * Port/driver registration/removal
 */
int uart_register_driver(struct uart_driver *uart);
void uart_unregister_driver(struct uart_driver *uart);
int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
int uart_match_port(struct uart_port *port1, struct uart_port *port2);

/*
 * Power Management
 */
int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
int uart_resume_port(struct uart_driver *reg, struct uart_port *port);

#define uart_circ_empty(circ)		((circ)->head == (circ)->tail)
#define uart_circ_clear(circ)		((circ)->head = (circ)->tail = 0)

#define uart_circ_chars_pending(circ)	\
	(CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))

#define uart_circ_chars_free(circ)	\
	(CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))

static inline int uart_tx_stopped(struct uart_port *port)
{
	struct tty_struct *tty = port->info->port.tty;
	if(tty->stopped || tty->hw_stopped)
		return 1;
	return 0;
}

/*
 * The following are helper functions for the low level drivers.
 */
static inline int
uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
{
#ifdef SUPPORT_SYSRQ
	if (port->sysrq) {
		if (ch && time_before(jiffies, port->sysrq)) {
			handle_sysrq(ch, port->info->port.tty);
			port->sysrq = 0;
			return 1;
		}
		port->sysrq = 0;
	}
#endif
	return 0;
}
#ifndef SUPPORT_SYSRQ
#define uart_handle_sysrq_char(port,ch) uart_handle_sysrq_char(port, 0)
#endif

/*
 * We do the SysRQ and SAK checking like this...
 */
static inline int uart_handle_break(struct uart_port *port)
{
	struct uart_info *info = port->info;
#ifdef SUPPORT_SYSRQ
	if (port->cons && port->cons->index == port->line) {
		if (!port->sysrq) {
			port->sysrq = jiffies + HZ*5;
			return 1;
		}
		port->sysrq = 0;
	}
#endif
	if (port->flags & UPF_SAK)
		do_SAK(info->port.tty);
	return 0;
}

/**
 *	uart_handle_dcd_change - handle a change of carrier detect state
 *	@port: uart_port structure for the open port
 *	@status: new carrier detect status, nonzero if active
 */
static inline void
uart_handle_dcd_change(struct uart_port *port, unsigned int status)
{
	struct uart_info *info = port->info;

	port->icount.dcd++;

#ifdef CONFIG_HARD_PPS
	if ((port->flags & UPF_HARDPPS_CD) && status)
		hardpps();
#endif

	if (info->flags & UIF_CHECK_CD) {
		if (status)
			wake_up_interruptible(&info->port.open_wait);
		else if (info->port.tty)
			tty_hangup(info->port.tty);
	}
}

/**
 *	uart_handle_cts_change - handle a change of clear-to-send state
 *	@port: uart_port structure for the open port
 *	@status: new clear to send status, nonzero if active
 */
static inline void
uart_handle_cts_change(struct uart_port *port, unsigned int status)
{
	struct uart_info *info = port->info;
	struct tty_struct *tty = info->port.tty;

	port->icount.cts++;

	if (info->flags & UIF_CTS_FLOW) {
		if (tty->hw_stopped) {
			if (status) {
				tty->hw_stopped = 0;
				port->ops->start_tx(port);
				uart_write_wakeup(port);
			}
		} else {
			if (!status) {
				tty->hw_stopped = 1;
				port->ops->stop_tx(port);
			}
		}
	}
}

#include <linux/tty_flip.h>

static inline void
uart_insert_char(struct uart_port *port, unsigned int status,
		 unsigned int overrun, unsigned int ch, unsigned int flag)
{
	struct tty_struct *tty = port->info->port.tty;

	if ((status & port->ignore_status_mask & ~overrun) == 0)
		tty_insert_flip_char(tty, ch, flag);

	/*
	 * Overrun is special.  Since it's reported immediately,
	 * it doesn't affect the current character.
	 */
	if (status & ~port->ignore_status_mask & overrun)
		tty_insert_flip_char(tty, 0, TTY_OVERRUN);
}

/*
 *	UART_ENABLE_MS - determine if port should enable modem status irqs
 */
#define UART_ENABLE_MS(port,cflag)	((port)->flags & UPF_HARDPPS_CD || \
					 (cflag) & CRTSCTS || \
					 !((cflag) & CLOCAL))

#endif

#endif /* LINUX_SERIAL_CORE_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/drivers/char/serial_core.h
	3	*
	4	* Copyright (C) 2000 Deep Blue Solutions Ltd.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*/
	20	#ifndef LINUX_SERIAL_CORE_H
	21	#define LINUX_SERIAL_CORE_H
	22
	23	/*
	24	* The type definitions. These are from Ted Ts'o's serial.h
	25	*/
	26	#define PORT_UNKNOWN 0
	27	#define PORT_8250 1
	28	#define PORT_16450 2
	29	#define PORT_16550 3
	30	#define PORT_16550A 4
	31	#define PORT_CIRRUS 5
	32	#define PORT_16650 6
	33	#define PORT_16650V2 7
	34	#define PORT_16750 8
	35	#define PORT_STARTECH 9
	36	#define PORT_16C950 10
	37	#define PORT_16654 11
	38	#define PORT_16850 12
	39	#define PORT_RSA 13
	40	#define PORT_NS16550A 14
	41	#define PORT_XSCALE 15
bd71c182 TK	42	#define PORT_RM9000 16 /* PMC-Sierra RM9xxx internal UART */
bd71c182 TK	43	#define PORT_MAX_8250 16 /* max port ID */
1da177e4 LT	44
	45	/*
	46	* ARM specific type numbers. These are not currently guaranteed
	47	* to be implemented, and will change in the future. These are
	48	* separate so any additions to the old serial.c that occur before
	49	* we are merged can be easily merged here.
	50	*/
	51	#define PORT_PXA 31
	52	#define PORT_AMBA 32
	53	#define PORT_CLPS711X 33
	54	#define PORT_SA1100 34
	55	#define PORT_UART00 35
	56	#define PORT_21285 37
	57
	58	/* Sparc type numbers. */
	59	#define PORT_SUNZILOG 38
	60	#define PORT_SUNSAB 39
	61
8b4a4080 MR	62	/* DEC */
	63	#define PORT_DZ 46
	64	#define PORT_ZS 47
1da177e4 LT	65
	66	/* Parisc type numbers. */
	67	#define PORT_MUX 48
	68
9ab4f88b HS	69	/* Atmel AT91 / AT32 SoC */
9ab4f88b HS	70	#define PORT_ATMEL 49
1e6c9c28	71
1da177e4 LT	72	/* Macintosh Zilog type numbers */
	73	#define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
	74	#define PORT_PMAC_ZILOG 51
	75
	76	/* SH-SCI */
	77	#define PORT_SCI 52
	78	#define PORT_SCIF 53
	79	#define PORT_IRDA 54
	80
	81	/* Samsung S3C2410 SoC and derivatives thereof */
	82	#define PORT_S3C2410 55
	83
	84	/* SGI IP22 aka Indy / Challenge S / Indigo 2 */
	85	#define PORT_IP22ZILOG 56
	86
	87	/* Sharp LH7a40x -- an ARM9 SoC series */
	88	#define PORT_LH7A40X 57
	89
	90	/* PPC CPM type number */
	91	#define PORT_CPM 58
	92
	93	/* MPC52xx type numbers */
	94	#define PORT_MPC52xx 59
	95
	96	/* IBM icom */
	97	#define PORT_ICOM 60
	98
	99	/* Samsung S3C2440 SoC */
	100	#define PORT_S3C2440 61
	101
	102	/* Motorola i.MX SoC */
	103	#define PORT_IMX 62
	104
	105	/* Marvell MPSC */
	106	#define PORT_MPSC 63
	107
	108	/* TXX9 type number */
e5c2d749	109	#define PORT_TXX9 64
1da177e4 LT	110
	111	/* NEC VR4100 series SIU/DSIU */
	112	#define PORT_VR41XX_SIU 65
	113	#define PORT_VR41XX_DSIU 66
	114
	115	/* Samsung S3C2400 SoC */
	116	#define PORT_S3C2400 67
	117
	118	/* M32R SIO */
	119	#define PORT_M32R_SIO 68
	120
	121	/Digi jsm /
913ade51 RK	122	#define PORT_JSM 69
913ade51 RK	123
e6fa0ba3	124	#define PORT_PNX8XXX 70
1da177e4	125
f5417612 SH	126	/* Hilscher netx */
	127	#define PORT_NETX 71
	128
02fd473b DM	129	/* SUN4V Hypervisor Console */
	130	#define PORT_SUNHV 72
	131
73e55cb3 BD	132	#define PORT_S3C2412 73
73e55cb3 BD	133
238b8721 PK	134	/* Xilinx uartlite */
238b8721 PK	135	#define PORT_UARTLITE 74
73e55cb3	136
194de561 BW	137	/* Blackfin bf5xx */
	138	#define PORT_BFIN 75
	139
2c7ee6ab AV	140	/* Micrel KS8695 */
	141	#define PORT_KS8695 76
	142
b45d5279 MR	143	/* Broadcom SB1250, etc. SOC */
	144	#define PORT_SB1250_DUART 77
	145
f0c15f48 GU	146	/* Freescale ColdFire */
	147	#define PORT_MCF 78
	148
2f351741 BW	149	/* Blackfin SPORT */
2f351741 BW	150	#define PORT_BFIN_SPORT 79
2c7ee6ab	151
ef3d5347 DH	152	/* MN10300 on-chip UART numbers */
	153	#define PORT_MN10300 80
	154	#define PORT_MN10300_CTS 81
	155
2f351741 BW	156	#define PORT_SC26XX 82
2f351741 BW	157
1a22f08d YS	158	/* SH-SCI */
	159	#define PORT_SCIFA 83
	160
b690ace5 BD	161	#define PORT_S3C6400 84
b690ace5 BD	162
1da177e4 LT	163	#ifdef __KERNEL__
1da177e4 LT	164
661f83a6	165	#include <linux/compiler.h>
1da177e4 LT	166	#include <linux/interrupt.h>
	167	#include <linux/circ_buf.h>
	168	#include <linux/spinlock.h>
	169	#include <linux/sched.h>
	170	#include <linux/tty.h>
e2862f6a	171	#include <linux/mutex.h>
b11115c1	172	#include <linux/sysrq.h>
1da177e4 LT	173
	174	struct uart_port;
	175	struct uart_info;
	176	struct serial_struct;
	177	struct device;
	178
	179	/*
	180	* This structure describes all the operations that can be
	181	* done on the physical hardware.
	182	*/
	183	struct uart_ops {
	184	unsigned int (tx_empty)(struct uart_port );
	185	void (set_mctrl)(struct uart_port , unsigned int mctrl);
	186	unsigned int (get_mctrl)(struct uart_port );
b129a8cc RK	187	void (stop_tx)(struct uart_port );
b129a8cc RK	188	void (start_tx)(struct uart_port );
1da177e4 LT	189	void (send_xchar)(struct uart_port , char ch);
	190	void (stop_rx)(struct uart_port );
	191	void (enable_ms)(struct uart_port );
	192	void (break_ctl)(struct uart_port , int ctl);
	193	int (startup)(struct uart_port );
	194	void (shutdown)(struct uart_port );
6bb0e3a5	195	void (flush_buffer)(struct uart_port );
606d099c AC	196	void (set_termios)(struct uart_port , struct ktermios *new,
606d099c AC	197	struct ktermios *old);
64e9159f	198	void (set_ldisc)(struct uart_port );
1da177e4 LT	199	void (pm)(struct uart_port , unsigned int state,
	200	unsigned int oldstate);
	201	int (set_wake)(struct uart_port , unsigned int state);
	202
	203	/*
	204	* Return a string describing the type of the port
	205	*/
	206	const char (type)(struct uart_port *);
	207
	208	/*
	209	* Release IO and memory resources used by the port.
	210	* This includes iounmap if necessary.
	211	*/
	212	void (release_port)(struct uart_port );
	213
	214	/*
	215	* Request IO and memory resources used by the port.
	216	* This includes iomapping the port if necessary.
	217	*/
	218	int (request_port)(struct uart_port );
	219	void (config_port)(struct uart_port , int);
	220	int (verify_port)(struct uart_port , struct serial_struct *);
	221	int (ioctl)(struct uart_port , unsigned int, unsigned long);
f2d937f3 JW	222	#ifdef CONFIG_CONSOLE_POLL
	223	void (poll_put_char)(struct uart_port , unsigned char);
	224	int (poll_get_char)(struct uart_port );
	225	#endif
1da177e4 LT	226	};
	227
	228	#define UART_CONFIG_TYPE (1 << 0)
	229	#define UART_CONFIG_IRQ (1 << 1)
	230
	231	struct uart_icount {
	232	__u32 cts;
	233	__u32 dsr;
	234	__u32 rng;
	235	__u32 dcd;
	236	__u32 rx;
	237	__u32 tx;
	238	__u32 frame;
	239	__u32 overrun;
	240	__u32 parity;
	241	__u32 brk;
	242	__u32 buf_overrun;
	243	};
	244
0077d45e RK	245	typedef unsigned int __bitwise__ upf_t;
0077d45e RK	246
1da177e4 LT	247	struct uart_port {
1da177e4 LT	248	spinlock_t lock; /* port lock */
0c8946d9	249	unsigned long iobase; /* in/out[bwl] */
1da177e4 LT	250	unsigned char __iomem membase; / read/write[bwl] */
	251	unsigned int irq; /* irq number */
	252	unsigned int uartclk; /* base uart clock */
947deee8	253	unsigned int fifosize; /* tx fifo size */
1da177e4 LT	254	unsigned char x_char; /* xon/xoff char */
	255	unsigned char regshift; /* reg offset shift */
	256	unsigned char iotype; /* io access style */
947deee8	257	unsigned char unused1;
1da177e4 LT	258
	259	#define UPIO_PORT (0)
	260	#define UPIO_HUB6 (1)
	261	#define UPIO_MEM (2)
	262	#define UPIO_MEM32 (3)
21c614a7	263	#define UPIO_AU (4) /* Au1x00 type IO */
3be91ec7	264	#define UPIO_TSI (5) /* Tsi108/109 type IO */
beab697a	265	#define UPIO_DWAPB (6) /* DesignWare APB UART */
bd71c182	266	#define UPIO_RM9000 (7) /* RM9000 type IO */
1da177e4 LT	267
	268	unsigned int read_status_mask; /* driver specific */
	269	unsigned int ignore_status_mask; /* driver specific */
	270	struct uart_info info; / pointer to parent info */
	271	struct uart_icount icount; /* statistics */
	272
	273	struct console cons; / struct console, if any */
	274	#ifdef CONFIG_SERIAL_CORE_CONSOLE
	275	unsigned long sysrq; /* sysrq timeout */
	276	#endif
	277
0077d45e RK	278	upf_t flags;
	279
	280	#define UPF_FOURPORT ((__force upf_t) (1 << 1))
	281	#define UPF_SAK ((__force upf_t) (1 << 2))
	282	#define UPF_SPD_MASK ((__force upf_t) (0x1030))
	283	#define UPF_SPD_HI ((__force upf_t) (0x0010))
	284	#define UPF_SPD_VHI ((__force upf_t) (0x0020))
	285	#define UPF_SPD_CUST ((__force upf_t) (0x0030))
	286	#define UPF_SPD_SHI ((__force upf_t) (0x1000))
	287	#define UPF_SPD_WARP ((__force upf_t) (0x1010))
	288	#define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
	289	#define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
	290	#define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
	291	#define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
	292	#define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
	293	#define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
	294	#define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
	295	#define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
	296	#define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
abb4a239	297	#define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
68ac64cd	298	#define UPF_DEAD ((__force upf_t) (1 << 30))
0077d45e RK	299	#define UPF_IOREMAP ((__force upf_t) (1 << 31))
	300
	301	#define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
	302	#define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK\|UPF_LOW_LATENCY))
1da177e4 LT	303
	304	unsigned int mctrl; /* current modem ctrl settings */
	305	unsigned int timeout; /* character-based timeout */
	306	unsigned int type; /* port type */
ba899dbc	307	const struct uart_ops *ops;
1da177e4 LT	308	unsigned int custom_divisor;
1da177e4 LT	309	unsigned int line; /* port index */
4f640efb	310	resource_size_t mapbase; /* for ioremap */
1da177e4 LT	311	struct device dev; / parent device */
1da177e4 LT	312	unsigned char hub6; /* this should be in the 8250 driver */
b3b708fa GL	313	unsigned char suspended;
b3b708fa GL	314	unsigned char unused[2];
beab697a	315	void private_data; / generic platform data pointer */
1da177e4 LT	316	};
1da177e4 LT	317
1da177e4 LT	318	/*
1da177e4 LT	319	* This is the state information which is only valid when the port
f751928e	320	* is open; it may be cleared the core driver once the device has
1da177e4 LT	321	* been closed. Either the low level driver or the core can modify
	322	* stuff here.
	323	*/
f751928e AC	324	typedef unsigned int __bitwise__ uif_t;
f751928e AC	325
1da177e4	326	struct uart_info {
df4f4dd4	327	struct tty_port port;
1da177e4	328	struct circ_buf xmit;
747c8a55	329	uif_t flags;
1da177e4 LT	330
1da177e4 LT	331	/*
747c8a55 RK	332	* Definitions for info->flags. These are _private_ to serial_core, and
747c8a55 RK	333	* are specific to this structure. They may be queried by low level drivers.
df4f4dd4 AC	334	*
df4f4dd4 AC	335	* FIXME: use the ASY_ definitions
1da177e4	336	*/
747c8a55 RK	337	#define UIF_CHECK_CD ((__force uif_t) (1 << 25))
	338	#define UIF_CTS_FLOW ((__force uif_t) (1 << 26))
	339	#define UIF_NORMAL_ACTIVE ((__force uif_t) (1 << 29))
	340	#define UIF_INITIALIZED ((__force uif_t) (1 << 31))
a6b93a90	341	#define UIF_SUSPENDED ((__force uif_t) (1 << 30))
1da177e4	342
1da177e4	343	struct tasklet_struct tlet;
1da177e4 LT	344	wait_queue_head_t delta_msr_wait;
	345	};
	346
f751928e AC	347	/*
	348	* This is the state information which is persistent across opens.
	349	* The low level driver must not to touch any elements contained
	350	* within.
	351	*/
	352	struct uart_state {
	353	unsigned int close_delay; /* msec */
	354	unsigned int closing_wait; /* msec */
	355
	356	#define USF_CLOSING_WAIT_INF (0)
	357	#define USF_CLOSING_WAIT_NONE (~0U)
	358
	359	int count;
	360	int pm_state;
	361	struct uart_info info;
	362	struct uart_port *port;
	363
	364	struct mutex mutex;
	365	};
	366
	367	#define UART_XMIT_SIZE PAGE_SIZE
	368
	369
1da177e4 LT	370	/* number of characters left in xmit buffer before we ask for more */
	371	#define WAKEUP_CHARS 256
	372
	373	struct module;
	374	struct tty_driver;
	375
	376	struct uart_driver {
	377	struct module *owner;
	378	const char *driver_name;
	379	const char *dev_name;
1da177e4 LT	380	int major;
	381	int minor;
	382	int nr;
	383	struct console *cons;
	384
	385	/*
	386	* these are private; the low level driver should not
	387	* touch these; they should be initialised to NULL
	388	*/
	389	struct uart_state *state;
	390	struct tty_driver *tty_driver;
	391	};
	392
	393	void uart_write_wakeup(struct uart_port *port);
	394
	395	/*
	396	* Baud rate helpers.
	397	*/
	398	void uart_update_timeout(struct uart_port *port, unsigned int cflag,
	399	unsigned int baud);
606d099c AC	400	unsigned int uart_get_baud_rate(struct uart_port port, struct ktermios termios,
606d099c AC	401	struct ktermios *old, unsigned int min,
1da177e4 LT	402	unsigned int max);
	403	unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
	404
	405	/*
	406	* Console helpers.
	407	*/
	408	struct uart_port uart_get_console(struct uart_port ports, int nr,
	409	struct console *c);
	410	void uart_parse_options(char options, int baud, int parity, int bits,
	411	int *flow);
	412	int uart_set_options(struct uart_port port, struct console co, int baud,
	413	int parity, int bits, int flow);
	414	struct tty_driver uart_console_device(struct console co, int *index);
d358788f RK	415	void uart_console_write(struct uart_port port, const char s,
	416	unsigned int count,
	417	void (putchar)(struct uart_port , int));
1da177e4 LT	418
	419	/*
	420	* Port/driver registration/removal
	421	*/
	422	int uart_register_driver(struct uart_driver *uart);
	423	void uart_unregister_driver(struct uart_driver *uart);
1da177e4 LT	424	int uart_add_one_port(struct uart_driver reg, struct uart_port port);
	425	int uart_remove_one_port(struct uart_driver reg, struct uart_port port);
	426	int uart_match_port(struct uart_port port1, struct uart_port port2);
	427
	428	/*
	429	* Power Management
	430	*/
	431	int uart_suspend_port(struct uart_driver reg, struct uart_port port);
	432	int uart_resume_port(struct uart_driver reg, struct uart_port port);
	433
	434	#define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
	435	#define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
	436
	437	#define uart_circ_chars_pending(circ) \
	438	(CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
	439
	440	#define uart_circ_chars_free(circ) \
	441	(CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
	442
f751928e AC	443	static inline int uart_tx_stopped(struct uart_port *port)
	444	{
	445	struct tty_struct *tty = port->info->port.tty;
	446	if(tty->stopped \|\| tty->hw_stopped)
	447	return 1;
	448	return 0;
	449	}
1da177e4 LT	450
	451	/*
	452	* The following are helper functions for the low level drivers.
	453	*/
1da177e4	454	static inline int
7d12e780	455	uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
1da177e4	456	{
93c37f29	457	#ifdef SUPPORT_SYSRQ
1da177e4 LT	458	if (port->sysrq) {
1da177e4 LT	459	if (ch && time_before(jiffies, port->sysrq)) {
f751928e	460	handle_sysrq(ch, port->info->port.tty);
1da177e4 LT	461	port->sysrq = 0;
	462	return 1;
	463	}
	464	port->sysrq = 0;
	465	}
93c37f29	466	#endif
1da177e4 LT	467	return 0;
1da177e4 LT	468	}
4e149184	469	#ifndef SUPPORT_SYSRQ
7d12e780	470	#define uart_handle_sysrq_char(port,ch) uart_handle_sysrq_char(port, 0)
4e149184	471	#endif
1da177e4 LT	472
	473	/*
	474	* We do the SysRQ and SAK checking like this...
	475	*/
	476	static inline int uart_handle_break(struct uart_port *port)
	477	{
	478	struct uart_info *info = port->info;
	479	#ifdef SUPPORT_SYSRQ
	480	if (port->cons && port->cons->index == port->line) {
	481	if (!port->sysrq) {
	482	port->sysrq = jiffies + HZ*5;
	483	return 1;
	484	}
	485	port->sysrq = 0;
	486	}
	487	#endif
27ae7a74	488	if (port->flags & UPF_SAK)
df4f4dd4	489	do_SAK(info->port.tty);
1da177e4 LT	490	return 0;
	491	}
	492
	493	/**
	494	* uart_handle_dcd_change - handle a change of carrier detect state
	495	* @port: uart_port structure for the open port
	496	* @status: new carrier detect status, nonzero if active
	497	*/
	498	static inline void
	499	uart_handle_dcd_change(struct uart_port *port, unsigned int status)
	500	{
	501	struct uart_info *info = port->info;
	502
	503	port->icount.dcd++;
	504
	505	#ifdef CONFIG_HARD_PPS
	506	if ((port->flags & UPF_HARDPPS_CD) && status)
	507	hardpps();
	508	#endif
	509
	510	if (info->flags & UIF_CHECK_CD) {
	511	if (status)
df4f4dd4 AC	512	wake_up_interruptible(&info->port.open_wait);
	513	else if (info->port.tty)
	514	tty_hangup(info->port.tty);
1da177e4 LT	515	}
	516	}
	517
	518	/**
	519	* uart_handle_cts_change - handle a change of clear-to-send state
	520	* @port: uart_port structure for the open port
	521	* @status: new clear to send status, nonzero if active
	522	*/
	523	static inline void
	524	uart_handle_cts_change(struct uart_port *port, unsigned int status)
	525	{
	526	struct uart_info *info = port->info;
df4f4dd4	527	struct tty_struct *tty = info->port.tty;
1da177e4 LT	528
	529	port->icount.cts++;
	530
	531	if (info->flags & UIF_CTS_FLOW) {
	532	if (tty->hw_stopped) {
	533	if (status) {
	534	tty->hw_stopped = 0;
b129a8cc	535	port->ops->start_tx(port);
1da177e4 LT	536	uart_write_wakeup(port);
	537	}
	538	} else {
	539	if (!status) {
	540	tty->hw_stopped = 1;
b129a8cc	541	port->ops->stop_tx(port);
1da177e4 LT	542	}
	543	}
	544	}
	545	}
	546
05ab3014 RK	547	#include <linux/tty_flip.h>
	548
	549	static inline void
	550	uart_insert_char(struct uart_port *port, unsigned int status,
	551	unsigned int overrun, unsigned int ch, unsigned int flag)
	552	{
df4f4dd4	553	struct tty_struct *tty = port->info->port.tty;
05ab3014 RK	554
	555	if ((status & port->ignore_status_mask & ~overrun) == 0)
	556	tty_insert_flip_char(tty, ch, flag);
	557
	558	/*
	559	* Overrun is special. Since it's reported immediately,
	560	* it doesn't affect the current character.
	561	*/
	562	if (status & ~port->ignore_status_mask & overrun)
	563	tty_insert_flip_char(tty, 0, TTY_OVERRUN);
	564	}
	565
1da177e4 LT	566	/*
	567	* UART_ENABLE_MS - determine if port should enable modem status irqs
	568	*/
	569	#define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD \|\| \
	570	(cflag) & CRTSCTS \|\| \
	571	!((cflag) & CLOCAL))
	572
	573	#endif
	574
	575	#endif /* LINUX_SERIAL_CORE_H */