[mirror_ubuntu-bionic-kernel.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


#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>
#include <uapi/linux/serial_core.h>

#ifdef CONFIG_SERIAL_CORE_CONSOLE
#define uart_console(port) \
	((port)->cons && (port)->cons->index == (port)->line)
#else
#define uart_console(port)      (0)
#endif

struct uart_port;
struct serial_struct;
struct device;

/*
 * This structure describes all the operations that can be done on the
 * physical hardware.  See Documentation/serial/driver for details.
 */
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		(*throttle)(struct uart_port *);
	void		(*unthrottle)(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 *, int new);
	void		(*pm)(struct uart_port *, unsigned int state,
			      unsigned int oldstate);

	/*
	 * 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
	int		(*poll_init)(struct uart_port *);
	void		(*poll_put_char)(struct uart_port *, unsigned char);
	int		(*poll_get_char)(struct uart_port *);
#endif
};

#define NO_POLL_CHAR		0x00ff0000
#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;
typedef unsigned int __bitwise__ upstat_t;

struct uart_port {
	spinlock_t		lock;			/* port lock */
	unsigned long		iobase;			/* in/out[bwl] */
	unsigned char __iomem	*membase;		/* read/write[bwl] */
	unsigned int		(*serial_in)(struct uart_port *, int);
	void			(*serial_out)(struct uart_port *, int, int);
	void			(*set_termios)(struct uart_port *,
				               struct ktermios *new,
				               struct ktermios *old);
	int			(*startup)(struct uart_port *port);
	void			(*shutdown)(struct uart_port *port);
	void			(*throttle)(struct uart_port *port);
	void			(*unthrottle)(struct uart_port *port);
	int			(*handle_irq)(struct uart_port *);
	void			(*pm)(struct uart_port *, unsigned int state,
				      unsigned int old);
	void			(*handle_break)(struct uart_port *);
	unsigned int		irq;			/* irq number */
	unsigned long		irqflags;		/* irq flags  */
	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 and RT288x type IO */
#define UPIO_TSI		(5)			/* Tsi108/109 type IO */

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

	struct console		*cons;			/* struct console, if any */
#if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
	unsigned long		sysrq;			/* sysrq timeout */
#endif

	/* flags must be updated while holding port mutex */
	upf_t			flags;

	/*
	 * These flags must be equivalent to the flags defined in
	 * include/uapi/linux/tty_flags.h which are the userspace definitions
	 * assigned from the serial_struct flags in uart_set_info()
	 * [for bit definitions in the UPF_CHANGE_MASK]
	 *
	 * Bits [0..UPF_LAST_USER] are userspace defined/visible/changeable
	 * except bit 15 (UPF_NO_TXEN_TEST) which is masked off.
	 * The remaining bits are serial-core specific and not modifiable by
	 * userspace.
	 */
#define UPF_FOURPORT		((__force upf_t) ASYNC_FOURPORT       /* 1  */ )
#define UPF_SAK			((__force upf_t) ASYNC_SAK            /* 2  */ )
#define UPF_SPD_HI		((__force upf_t) ASYNC_SPD_HI         /* 4  */ )
#define UPF_SPD_VHI		((__force upf_t) ASYNC_SPD_VHI        /* 5  */ )
#define UPF_SPD_CUST		((__force upf_t) ASYNC_SPD_CUST   /* 0x0030 */ )
#define UPF_SPD_WARP		((__force upf_t) ASYNC_SPD_WARP   /* 0x1010 */ )
#define UPF_SPD_MASK		((__force upf_t) ASYNC_SPD_MASK   /* 0x1030 */ )
#define UPF_SKIP_TEST		((__force upf_t) ASYNC_SKIP_TEST      /* 6  */ )
#define UPF_AUTO_IRQ		((__force upf_t) ASYNC_AUTO_IRQ       /* 7  */ )
#define UPF_HARDPPS_CD		((__force upf_t) ASYNC_HARDPPS_CD     /* 11 */ )
#define UPF_SPD_SHI		((__force upf_t) ASYNC_SPD_SHI        /* 12 */ )
#define UPF_LOW_LATENCY		((__force upf_t) ASYNC_LOW_LATENCY    /* 13 */ )
#define UPF_BUGGY_UART		((__force upf_t) ASYNC_BUGGY_UART     /* 14 */ )
#define UPF_NO_TXEN_TEST	((__force upf_t) (1 << 15))
#define UPF_MAGIC_MULTIPLIER	((__force upf_t) ASYNC_MAGIC_MULTIPLIER /* 16 */ )

/* Port has hardware-assisted h/w flow control (iow, auto-RTS *not* auto-CTS) */
#define UPF_HARD_FLOW		((__force upf_t) (1 << 21))
/* Port has hardware-assisted s/w flow control */
#define UPF_SOFT_FLOW		((__force upf_t) (1 << 22))
#define UPF_CONS_FLOW		((__force upf_t) (1 << 23))
#define UPF_SHARE_IRQ		((__force upf_t) (1 << 24))
#define UPF_EXAR_EFR		((__force upf_t) (1 << 25))
#define UPF_BUG_THRE		((__force upf_t) (1 << 26))
/* The exact UART type is known and should not be probed.  */
#define UPF_FIXED_TYPE		((__force upf_t) (1 << 27))
#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	0x17fff
#define UPF_CHANGE_MASK		((__force upf_t) __UPF_CHANGE_MASK)
#define UPF_USR_MASK		((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))

#if __UPF_CHANGE_MASK > ASYNC_FLAGS
#error Change mask not equivalent to userspace-visible bit defines
#endif

	/* status must be updated while holding port lock */
	upstat_t		status;

#define UPSTAT_CTS_ENABLE	((__force upstat_t) (1 << 0))
#define UPSTAT_DCD_ENABLE	((__force upstat_t) (1 << 1))

	int			hw_stopped;		/* sw-assisted CTS flow state */
	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		irq_wake;
	unsigned char		unused[2];
	struct attribute_group	*attr_group;		/* port specific attributes */
	const struct attribute_group **tty_groups;	/* all attributes (serial core use only) */
	void			*private_data;		/* generic platform data pointer */
};

static inline int serial_port_in(struct uart_port *up, int offset)
{
	return up->serial_in(up, offset);
}

static inline void serial_port_out(struct uart_port *up, int offset, int value)
{
	up->serial_out(up, offset, value);
}

/**
 * enum uart_pm_state - power states for UARTs
 * @UART_PM_STATE_ON: UART is powered, up and operational
 * @UART_PM_STATE_OFF: UART is powered off
 * @UART_PM_STATE_UNDEFINED: sentinel
 */
enum uart_pm_state {
	UART_PM_STATE_ON = 0,
	UART_PM_STATE_OFF = 3, /* number taken from ACPI */
	UART_PM_STATE_UNDEFINED,
};

/*
 * This is the state information which is persistent across opens.
 */
struct uart_state {
	struct tty_port		port;

	enum uart_pm_state	pm_state;
	struct circ_buf		xmit;

	struct uart_port	*uart_port;
};

#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);

/* Base timer interval for polling */
static inline int uart_poll_timeout(struct uart_port *port)
{
	int timeout = port->timeout;

	return timeout > 6 ? (timeout / 2 - 2) : 1;
}

/*
 * Console helpers.
 */
struct earlycon_device {
	struct console *con;
	struct uart_port port;
	char options[16];		/* e.g., 115200n8 */
	unsigned int baud;
};
int setup_earlycon(char *buf, const char *match,
		   int (*setup)(struct earlycon_device *, const char *));

extern int of_setup_earlycon(unsigned long addr,
			     int (*setup)(struct earlycon_device *, const char *));

#define EARLYCON_DECLARE(name, func) \
static int __init name ## _setup_earlycon(char *buf) \
{ \
	return setup_earlycon(buf, __stringify(name), func); \
} \
early_param("earlycon", name ## _setup_earlycon);

#define OF_EARLYCON_DECLARE(name, compat, fn)				\
	_OF_DECLARE(earlycon, name, compat, fn, void *)

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->state->port.tty;
	if (tty->stopped || port->hw_stopped)
		return 1;
	return 0;
}

static inline bool uart_cts_enabled(struct uart_port *uport)
{
	return !!(uport->status & UPSTAT_CTS_ENABLE);
}

/*
 * The following are helper functions for the low level drivers.
 */

extern void uart_handle_dcd_change(struct uart_port *uport,
		unsigned int status);
extern void uart_handle_cts_change(struct uart_port *uport,
		unsigned int status);

extern void uart_insert_char(struct uart_port *port, unsigned int status,
		 unsigned int overrun, unsigned int ch, unsigned int flag);

#ifdef SUPPORT_SYSRQ
static inline int
uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
{
	if (port->sysrq) {
		if (ch && time_before(jiffies, port->sysrq)) {
			handle_sysrq(ch);
			port->sysrq = 0;
			return 1;
		}
		port->sysrq = 0;
	}
	return 0;
}
#else
#define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
#endif

/*
 * We do the SysRQ and SAK checking like this...
 */
static inline int uart_handle_break(struct uart_port *port)
{
	struct uart_state *state = port->state;

	if (port->handle_break)
		port->handle_break(port);

#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(state->port.tty);
	return 0;
}

/*
 *	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 /* 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
1da177e4	23
661f83a6	24	#include <linux/compiler.h>
1da177e4 LT	25	#include <linux/interrupt.h>
	26	#include <linux/circ_buf.h>
	27	#include <linux/spinlock.h>
	28	#include <linux/sched.h>
	29	#include <linux/tty.h>
e2862f6a	30	#include <linux/mutex.h>
b11115c1	31	#include <linux/sysrq.h>
607ca46e	32	#include <uapi/linux/serial_core.h>
1da177e4	33
cf0ebee0 SP	34	#ifdef CONFIG_SERIAL_CORE_CONSOLE
	35	#define uart_console(port) \
	36	((port)->cons && (port)->cons->index == (port)->line)
	37	#else
	38	#define uart_console(port) (0)
	39	#endif
	40
1da177e4	41	struct uart_port;
1da177e4 LT	42	struct serial_struct;
	43	struct device;
	44
	45	/*
e759d7c5 KC	46	* This structure describes all the operations that can be done on the
e759d7c5 KC	47	* physical hardware. See Documentation/serial/driver for details.
1da177e4 LT	48	*/
	49	struct uart_ops {
	50	unsigned int (tx_empty)(struct uart_port );
	51	void (set_mctrl)(struct uart_port , unsigned int mctrl);
	52	unsigned int (get_mctrl)(struct uart_port );
b129a8cc RK	53	void (stop_tx)(struct uart_port );
b129a8cc RK	54	void (start_tx)(struct uart_port );
9aba8d5b RK	55	void (throttle)(struct uart_port );
9aba8d5b RK	56	void (unthrottle)(struct uart_port );
1da177e4 LT	57	void (send_xchar)(struct uart_port , char ch);
	58	void (stop_rx)(struct uart_port );
	59	void (enable_ms)(struct uart_port );
	60	void (break_ctl)(struct uart_port , int ctl);
	61	int (startup)(struct uart_port );
	62	void (shutdown)(struct uart_port );
6bb0e3a5	63	void (flush_buffer)(struct uart_port );
606d099c AC	64	void (set_termios)(struct uart_port , struct ktermios *new,
606d099c AC	65	struct ktermios *old);
d87d9b7d	66	void (set_ldisc)(struct uart_port , int new);
1da177e4 LT	67	void (pm)(struct uart_port , unsigned int state,
1da177e4 LT	68	unsigned int oldstate);
1da177e4 LT	69
	70	/*
	71	* Return a string describing the type of the port
	72	*/
e759d7c5	73	const char (type)(struct uart_port *);
1da177e4 LT	74
	75	/*
	76	* Release IO and memory resources used by the port.
	77	* This includes iounmap if necessary.
	78	*/
	79	void (release_port)(struct uart_port );
	80
	81	/*
	82	* Request IO and memory resources used by the port.
	83	* This includes iomapping the port if necessary.
	84	*/
	85	int (request_port)(struct uart_port );
	86	void (config_port)(struct uart_port , int);
	87	int (verify_port)(struct uart_port , struct serial_struct *);
	88	int (ioctl)(struct uart_port , unsigned int, unsigned long);
f2d937f3	89	#ifdef CONFIG_CONSOLE_POLL
c7f3e708	90	int (poll_init)(struct uart_port );
e759d7c5	91	void (poll_put_char)(struct uart_port , unsigned char);
f2d937f3 JW	92	int (poll_get_char)(struct uart_port );
f2d937f3 JW	93	#endif
1da177e4 LT	94	};
1da177e4 LT	95
f5316b4a	96	#define NO_POLL_CHAR 0x00ff0000
1da177e4 LT	97	#define UART_CONFIG_TYPE (1 << 0)
	98	#define UART_CONFIG_IRQ (1 << 1)
	99
	100	struct uart_icount {
	101	__u32 cts;
	102	__u32 dsr;
	103	__u32 rng;
	104	__u32 dcd;
	105	__u32 rx;
	106	__u32 tx;
	107	__u32 frame;
	108	__u32 overrun;
	109	__u32 parity;
	110	__u32 brk;
	111	__u32 buf_overrun;
	112	};
	113
0077d45e	114	typedef unsigned int __bitwise__ upf_t;
299245a1	115	typedef unsigned int __bitwise__ upstat_t;
0077d45e	116
1da177e4 LT	117	struct uart_port {
1da177e4 LT	118	spinlock_t lock; /* port lock */
0c8946d9	119	unsigned long iobase; /* in/out[bwl] */
1da177e4	120	unsigned char __iomem membase; / read/write[bwl] */
7d6a07d1 DD	121	unsigned int (serial_in)(struct uart_port , int);
7d6a07d1 DD	122	void (serial_out)(struct uart_port , int, int);
235dae5d PL	123	void (set_termios)(struct uart_port ,
	124	struct ktermios *new,
	125	struct ktermios *old);
b99b121b SAS	126	int (startup)(struct uart_port port);
b99b121b SAS	127	void (shutdown)(struct uart_port port);
234abab1 SAS	128	void (throttle)(struct uart_port port);
234abab1 SAS	129	void (unthrottle)(struct uart_port port);
a74036f5	130	int (handle_irq)(struct uart_port );
c161afe9 ML	131	void (pm)(struct uart_port , unsigned int state,
c161afe9 ML	132	unsigned int old);
bf03f65b	133	void (handle_break)(struct uart_port );
1da177e4	134	unsigned int irq; /* irq number */
1c2f0493	135	unsigned long irqflags; /* irq flags */
1da177e4	136	unsigned int uartclk; /* base uart clock */
947deee8	137	unsigned int fifosize; /* tx fifo size */
1da177e4 LT	138	unsigned char x_char; /* xon/xoff char */
	139	unsigned char regshift; /* reg offset shift */
	140	unsigned char iotype; /* io access style */
947deee8	141	unsigned char unused1;
1da177e4 LT	142
	143	#define UPIO_PORT (0)
	144	#define UPIO_HUB6 (1)
	145	#define UPIO_MEM (2)
	146	#define UPIO_MEM32 (3)
c420811f	147	#define UPIO_AU (4) /* Au1x00 and RT288x type IO */
3be91ec7	148	#define UPIO_TSI (5) /* Tsi108/109 type IO */
1da177e4 LT	149
	150	unsigned int read_status_mask; /* driver specific */
	151	unsigned int ignore_status_mask; /* driver specific */
ebd2c8f6	152	struct uart_state state; / pointer to parent state */
1da177e4 LT	153	struct uart_icount icount; /* statistics */
	154
	155	struct console cons; / struct console, if any */
06e82df0	156	#if defined(CONFIG_SERIAL_CORE_CONSOLE) \|\| defined(SUPPORT_SYSRQ)
1da177e4 LT	157	unsigned long sysrq; /* sysrq timeout */
	158	#endif
	159
8a949b07	160	/* flags must be updated while holding port mutex */
0077d45e RK	161	upf_t flags;
0077d45e RK	162
904326ec PH	163	/*
	164	* These flags must be equivalent to the flags defined in
	165	* include/uapi/linux/tty_flags.h which are the userspace definitions
	166	* assigned from the serial_struct flags in uart_set_info()
	167	* [for bit definitions in the UPF_CHANGE_MASK]
	168	*
	169	* Bits [0..UPF_LAST_USER] are userspace defined/visible/changeable
	170	* except bit 15 (UPF_NO_TXEN_TEST) which is masked off.
	171	* The remaining bits are serial-core specific and not modifiable by
	172	* userspace.
	173	*/
	174	#define UPF_FOURPORT ((__force upf_t) ASYNC_FOURPORT /* 1 */ )
	175	#define UPF_SAK ((__force upf_t) ASYNC_SAK /* 2 */ )
	176	#define UPF_SPD_HI ((__force upf_t) ASYNC_SPD_HI /* 4 */ )
	177	#define UPF_SPD_VHI ((__force upf_t) ASYNC_SPD_VHI /* 5 */ )
	178	#define UPF_SPD_CUST ((__force upf_t) ASYNC_SPD_CUST /* 0x0030 */ )
	179	#define UPF_SPD_WARP ((__force upf_t) ASYNC_SPD_WARP /* 0x1010 */ )
	180	#define UPF_SPD_MASK ((__force upf_t) ASYNC_SPD_MASK /* 0x1030 */ )
	181	#define UPF_SKIP_TEST ((__force upf_t) ASYNC_SKIP_TEST /* 6 */ )
	182	#define UPF_AUTO_IRQ ((__force upf_t) ASYNC_AUTO_IRQ /* 7 */ )
	183	#define UPF_HARDPPS_CD ((__force upf_t) ASYNC_HARDPPS_CD /* 11 */ )
	184	#define UPF_SPD_SHI ((__force upf_t) ASYNC_SPD_SHI /* 12 */ )
	185	#define UPF_LOW_LATENCY ((__force upf_t) ASYNC_LOW_LATENCY /* 13 */ )
	186	#define UPF_BUGGY_UART ((__force upf_t) ASYNC_BUGGY_UART /* 14 */ )
b6adea33	187	#define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15))
904326ec PH	188	#define UPF_MAGIC_MULTIPLIER ((__force upf_t) ASYNC_MAGIC_MULTIPLIER /* 16 */ )
904326ec PH	189
dba05832 RK	190	/* Port has hardware-assisted h/w flow control (iow, auto-RTS not auto-CTS) */
dba05832 RK	191	#define UPF_HARD_FLOW ((__force upf_t) (1 << 21))
2cbacafd RK	192	/* Port has hardware-assisted s/w flow control */
2cbacafd RK	193	#define UPF_SOFT_FLOW ((__force upf_t) (1 << 22))
0077d45e RK	194	#define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
0077d45e RK	195	#define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
06315348	196	#define UPF_EXAR_EFR ((__force upf_t) (1 << 25))
bc02d15a	197	#define UPF_BUG_THRE ((__force upf_t) (1 << 26))
8e23fcc8 DD	198	/* The exact UART type is known and should not be probed. */
8e23fcc8 DD	199	#define UPF_FIXED_TYPE ((__force upf_t) (1 << 27))
0077d45e	200	#define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
abb4a239	201	#define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
68ac64cd	202	#define UPF_DEAD ((__force upf_t) (1 << 30))
0077d45e RK	203	#define UPF_IOREMAP ((__force upf_t) (1 << 31))
0077d45e RK	204
904326ec PH	205	#define __UPF_CHANGE_MASK 0x17fff
904326ec PH	206	#define UPF_CHANGE_MASK ((__force upf_t) __UPF_CHANGE_MASK)
0077d45e	207	#define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK\|UPF_LOW_LATENCY))
1da177e4	208
904326ec PH	209	#if __UPF_CHANGE_MASK > ASYNC_FLAGS
	210	#error Change mask not equivalent to userspace-visible bit defines
	211	#endif
	212
299245a1 PH	213	/* status must be updated while holding port lock */
	214	upstat_t status;
	215
	216	#define UPSTAT_CTS_ENABLE ((__force upstat_t) (1 << 0))
	217	#define UPSTAT_DCD_ENABLE ((__force upstat_t) (1 << 1))
	218
d01f4d18	219	int hw_stopped; /* sw-assisted CTS flow state */
1da177e4 LT	220	unsigned int mctrl; /* current modem ctrl settings */
	221	unsigned int timeout; /* character-based timeout */
	222	unsigned int type; /* port type */
ba899dbc	223	const struct uart_ops *ops;
1da177e4 LT	224	unsigned int custom_divisor;
1da177e4 LT	225	unsigned int line; /* port index */
4f640efb	226	resource_size_t mapbase; /* for ioremap */
1da177e4 LT	227	struct device dev; / parent device */
1da177e4 LT	228	unsigned char hub6; /* this should be in the 8250 driver */
b3b708fa	229	unsigned char suspended;
3f960dbb	230	unsigned char irq_wake;
b3b708fa	231	unsigned char unused[2];
266dcff0 GKH	232	struct attribute_group attr_group; / port specific attributes */
266dcff0 GKH	233	const struct attribute_group *tty_groups; / all attributes (serial core use only) */
beab697a	234	void private_data; / generic platform data pointer */
1da177e4 LT	235	};
1da177e4 LT	236
927353a7 PG	237	static inline int serial_port_in(struct uart_port *up, int offset)
	238	{
	239	return up->serial_in(up, offset);
	240	}
	241
	242	static inline void serial_port_out(struct uart_port *up, int offset, int value)
	243	{
	244	up->serial_out(up, offset, value);
	245	}
	246
6f538fe3 LW	247	/**
	248	* enum uart_pm_state - power states for UARTs
	249	* @UART_PM_STATE_ON: UART is powered, up and operational
	250	* @UART_PM_STATE_OFF: UART is powered off
	251	* @UART_PM_STATE_UNDEFINED: sentinel
	252	*/
	253	enum uart_pm_state {
	254	UART_PM_STATE_ON = 0,
	255	UART_PM_STATE_OFF = 3, /* number taken from ACPI */
	256	UART_PM_STATE_UNDEFINED,
	257	};
	258
ebd2c8f6 AC	259	/*
ebd2c8f6 AC	260	* This is the state information which is persistent across opens.
ebd2c8f6 AC	261	*/
ebd2c8f6 AC	262	struct uart_state {
df4f4dd4	263	struct tty_port port;
ebd2c8f6	264
6f538fe3	265	enum uart_pm_state pm_state;
1da177e4	266	struct circ_buf xmit;
1da177e4	267
ebd2c8f6	268	struct uart_port *uart_port;
f751928e AC	269	};
	270
	271	#define UART_XMIT_SIZE PAGE_SIZE
	272
	273
1da177e4 LT	274	/* number of characters left in xmit buffer before we ask for more */
	275	#define WAKEUP_CHARS 256
	276
	277	struct module;
	278	struct tty_driver;
	279
	280	struct uart_driver {
	281	struct module *owner;
	282	const char *driver_name;
	283	const char *dev_name;
1da177e4 LT	284	int major;
	285	int minor;
	286	int nr;
	287	struct console *cons;
	288
	289	/*
	290	* these are private; the low level driver should not
	291	* touch these; they should be initialised to NULL
	292	*/
	293	struct uart_state *state;
	294	struct tty_driver *tty_driver;
	295	};
	296
	297	void uart_write_wakeup(struct uart_port *port);
	298
	299	/*
	300	* Baud rate helpers.
	301	*/
	302	void uart_update_timeout(struct uart_port *port, unsigned int cflag,
	303	unsigned int baud);
606d099c AC	304	unsigned int uart_get_baud_rate(struct uart_port port, struct ktermios termios,
606d099c AC	305	struct ktermios *old, unsigned int min,
1da177e4 LT	306	unsigned int max);
	307	unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
	308
54381067 AV	309	/* Base timer interval for polling */
	310	static inline int uart_poll_timeout(struct uart_port *port)
	311	{
	312	int timeout = port->timeout;
	313
	314	return timeout > 6 ? (timeout / 2 - 2) : 1;
	315	}
	316
1da177e4 LT	317	/*
	318	* Console helpers.
	319	*/
9aac5887 RH	320	struct earlycon_device {
	321	struct console *con;
	322	struct uart_port port;
	323	char options[16]; /* e.g., 115200n8 */
	324	unsigned int baud;
	325	};
	326	int setup_earlycon(char buf, const char match,
	327	int (setup)(struct earlycon_device , const char *));
	328
b0b6abd3 RH	329	extern int of_setup_earlycon(unsigned long addr,
	330	int (setup)(struct earlycon_device , const char *));
	331
9aac5887 RH	332	#define EARLYCON_DECLARE(name, func) \
	333	static int __init name ## _setup_earlycon(char *buf) \
	334	{ \
	335	return setup_earlycon(buf, __stringify(name), func); \
	336	} \
	337	early_param("earlycon", name ## _setup_earlycon);
	338
b0b6abd3 RH	339	#define OF_EARLYCON_DECLARE(name, compat, fn) \
	340	_OF_DECLARE(earlycon, name, compat, fn, void *)
	341
1da177e4 LT	342	struct uart_port uart_get_console(struct uart_port ports, int nr,
	343	struct console *c);
	344	void uart_parse_options(char options, int baud, int parity, int bits,
	345	int *flow);
	346	int uart_set_options(struct uart_port port, struct console co, int baud,
	347	int parity, int bits, int flow);
	348	struct tty_driver uart_console_device(struct console co, int *index);
d358788f RK	349	void uart_console_write(struct uart_port port, const char s,
	350	unsigned int count,
	351	void (putchar)(struct uart_port , int));
1da177e4 LT	352
	353	/*
	354	* Port/driver registration/removal
	355	*/
	356	int uart_register_driver(struct uart_driver *uart);
	357	void uart_unregister_driver(struct uart_driver *uart);
1da177e4 LT	358	int uart_add_one_port(struct uart_driver reg, struct uart_port port);
	359	int uart_remove_one_port(struct uart_driver reg, struct uart_port port);
	360	int uart_match_port(struct uart_port port1, struct uart_port port2);
	361
	362	/*
	363	* Power Management
	364	*/
	365	int uart_suspend_port(struct uart_driver reg, struct uart_port port);
	366	int uart_resume_port(struct uart_driver reg, struct uart_port port);
	367
	368	#define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
	369	#define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
	370
	371	#define uart_circ_chars_pending(circ) \
	372	(CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
	373
	374	#define uart_circ_chars_free(circ) \
	375	(CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
	376
f751928e AC	377	static inline int uart_tx_stopped(struct uart_port *port)
f751928e AC	378	{
ebd2c8f6	379	struct tty_struct *tty = port->state->port.tty;
d01f4d18	380	if (tty->stopped \|\| port->hw_stopped)
f751928e AC	381	return 1;
	382	return 0;
	383	}
1da177e4	384
299245a1 PH	385	static inline bool uart_cts_enabled(struct uart_port *uport)
299245a1 PH	386	{
d4260b51	387	return !!(uport->status & UPSTAT_CTS_ENABLE);
299245a1 PH	388	}
299245a1 PH	389
1da177e4 LT	390	/*
	391	* The following are helper functions for the low level drivers.
	392	*/
027d7dac JS	393
	394	extern void uart_handle_dcd_change(struct uart_port *uport,
	395	unsigned int status);
	396	extern void uart_handle_cts_change(struct uart_port *uport,
	397	unsigned int status);
	398
	399	extern void uart_insert_char(struct uart_port *port, unsigned int status,
	400	unsigned int overrun, unsigned int ch, unsigned int flag);
	401
	402	#ifdef SUPPORT_SYSRQ
1da177e4	403	static inline int
7d12e780	404	uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
1da177e4 LT	405	{
	406	if (port->sysrq) {
	407	if (ch && time_before(jiffies, port->sysrq)) {
f335397d	408	handle_sysrq(ch);
1da177e4 LT	409	port->sysrq = 0;
	410	return 1;
	411	}
	412	port->sysrq = 0;
	413	}
	414	return 0;
	415	}
027d7dac JS	416	#else
027d7dac JS	417	#define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
4e149184	418	#endif
1da177e4 LT	419
	420	/*
	421	* We do the SysRQ and SAK checking like this...
	422	*/
	423	static inline int uart_handle_break(struct uart_port *port)
	424	{
ebd2c8f6	425	struct uart_state *state = port->state;
bf03f65b DW	426
	427	if (port->handle_break)
	428	port->handle_break(port);
	429
1da177e4 LT	430	#ifdef SUPPORT_SYSRQ
	431	if (port->cons && port->cons->index == port->line) {
	432	if (!port->sysrq) {
	433	port->sysrq = jiffies + HZ*5;
	434	return 1;
	435	}
	436	port->sysrq = 0;
	437	}
	438	#endif
27ae7a74	439	if (port->flags & UPF_SAK)
ebd2c8f6	440	do_SAK(state->port.tty);
1da177e4 LT	441	return 0;
	442	}
	443
1da177e4 LT	444	/*
	445	* UART_ENABLE_MS - determine if port should enable modem status irqs
	446	*/
	447	#define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD \|\| \
	448	(cflag) & CRTSCTS \|\| \
	449	!((cflag) & CLOCAL))
	450
1da177e4	451	#endif /* LINUX_SERIAL_CORE_H */