[deliverable/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

/* NEC v850.  */
#define PORT_V850E_UART	40

/* 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


#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		(*set_termios)(struct uart_port *, struct ktermios *new,
				       struct ktermios *old);
	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);
};

#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 int		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		unused[3];
	void			*private_data;		/* generic platform data pointer */
};

/*
 * 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

typedef unsigned int __bitwise__ uif_t;

/*
 * This is the state information which is only valid when the port
 * is open; it may be freed by the core driver once the device has
 * been closed.  Either the low level driver or the core can modify
 * stuff here.
 */
struct uart_info {
	struct tty_struct	*tty;
	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.
 */
#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))

	int			blocked_open;

	struct tasklet_struct	tlet;

	wait_queue_head_t	open_wait;
	wait_queue_head_t	delta_msr_wait;
};

/* 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))

#define uart_tx_stopped(port)		\
	((port)->info->tty->stopped || (port)->info->tty->hw_stopped)

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