[mirror_ubuntu-bionic-kernel.git] / include / linux / serial_8250.h

/*
 *  linux/include/linux/serial_8250.h
 *
 *  Copyright (C) 2004 Russell King
 *
 * 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.
 */
#ifndef _LINUX_SERIAL_8250_H
#define _LINUX_SERIAL_8250_H

#include <linux/serial_core.h>
#include <linux/serial_reg.h>
#include <linux/platform_device.h>

/*
 * This is the platform device platform_data structure
 */
struct plat_serial8250_port {
	unsigned long	iobase;		/* io base address */
	void __iomem	*membase;	/* ioremap cookie or NULL */
	resource_size_t	mapbase;	/* resource base */
	unsigned int	irq;		/* interrupt number */
	unsigned long	irqflags;	/* request_irq flags */
	unsigned int	uartclk;	/* UART clock rate */
	void            *private_data;
	unsigned char	regshift;	/* register shift */
	unsigned char	iotype;		/* UPIO_* */
	unsigned char	hub6;
	upf_t		flags;		/* UPF_* flags */
	unsigned int	type;		/* If UPF_FIXED_TYPE */
	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);
	void		(*set_ldisc)(struct uart_port *,
				     struct ktermios *);
	unsigned int	(*get_mctrl)(struct uart_port *);
	int		(*handle_irq)(struct uart_port *);
	void		(*pm)(struct uart_port *, unsigned int state,
			      unsigned old);
	void		(*handle_break)(struct uart_port *);
};

/*
 * Allocate 8250 platform device IDs.  Nothing is implied by
 * the numbering here, except for the legacy entry being -1.
 */
enum {
	PLAT8250_DEV_LEGACY = -1,
	PLAT8250_DEV_PLATFORM,
	PLAT8250_DEV_PLATFORM1,
	PLAT8250_DEV_PLATFORM2,
	PLAT8250_DEV_FOURPORT,
	PLAT8250_DEV_ACCENT,
	PLAT8250_DEV_BOCA,
	PLAT8250_DEV_EXAR_ST16C554,
	PLAT8250_DEV_HUB6,
	PLAT8250_DEV_AU1X00,
	PLAT8250_DEV_SM501,
};

struct uart_8250_dma;
struct uart_8250_port;

/**
 * 8250 core driver operations
 *
 * @setup_irq()		Setup irq handling. The universal 8250 driver links this
 *			port to the irq chain. Other drivers may @request_irq().
 * @release_irq()	Undo irq handling. The universal 8250 driver unlinks
 *			the port from the irq chain.
 */
struct uart_8250_ops {
	int		(*setup_irq)(struct uart_8250_port *);
	void		(*release_irq)(struct uart_8250_port *);
};

struct uart_8250_em485 {
	struct hrtimer		start_tx_timer; /* "rs485 start tx" timer */
	struct hrtimer		stop_tx_timer;  /* "rs485 stop tx" timer */
	struct hrtimer		*active_timer;  /* pointer to active timer */
	struct uart_8250_port	*port;          /* for hrtimer callbacks */
};

/*
 * This should be used by drivers which want to register
 * their own 8250 ports without registering their own
 * platform device.  Using these will make your driver
 * dependent on the 8250 driver.
 */

struct uart_8250_port {
	struct uart_port	port;
	struct timer_list	timer;		/* "no irq" timer */
	struct list_head	list;		/* ports on this IRQ */
	u32			capabilities;	/* port capabilities */
	unsigned short		bugs;		/* port bugs */
	bool			fifo_bug;	/* min RX trigger if enabled */
	unsigned int		tx_loadsz;	/* transmit fifo load size */
	unsigned char		acr;
	unsigned char		fcr;
	unsigned char		ier;
	unsigned char		lcr;
	unsigned char		mcr;
	unsigned char		mcr_mask;	/* mask of user bits */
	unsigned char		mcr_force;	/* mask of forced bits */
	unsigned char		cur_iotype;	/* Running I/O type */
	unsigned int		rpm_tx_active;
	unsigned char		canary;		/* non-zero during system sleep
						 *   if no_console_suspend
						 */
	unsigned char		probe;
#define UART_PROBE_RSA	(1 << 0)

	/*
	 * Some bits in registers are cleared on a read, so they must
	 * be saved whenever the register is read but the bits will not
	 * be immediately processed.
	 */
#define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
	unsigned char		lsr_saved_flags;
#define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
	unsigned char		msr_saved_flags;

	struct uart_8250_dma	*dma;
	const struct uart_8250_ops *ops;

	/* 8250 specific callbacks */
	int			(*dl_read)(struct uart_8250_port *);
	void			(*dl_write)(struct uart_8250_port *, int);

	struct uart_8250_em485 *em485;

	/* Serial port overrun backoff */
	struct delayed_work overrun_backoff;
	u32 overrun_backoff_time_ms;
};

static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up)
{
	return container_of(up, struct uart_8250_port, port);
}

int serial8250_register_8250_port(struct uart_8250_port *);
void serial8250_unregister_port(int line);
void serial8250_suspend_port(int line);
void serial8250_resume_port(int line);

extern int early_serial_setup(struct uart_port *port);

extern int early_serial8250_setup(struct earlycon_device *device,
					 const char *options);
extern void serial8250_do_set_termios(struct uart_port *port,
		struct ktermios *termios, struct ktermios *old);
extern void serial8250_do_set_ldisc(struct uart_port *port,
				    struct ktermios *termios);
extern unsigned int serial8250_do_get_mctrl(struct uart_port *port);
extern int serial8250_do_startup(struct uart_port *port);
extern void serial8250_do_shutdown(struct uart_port *port);
extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
			     unsigned int oldstate);
extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
extern int fsl8250_handle_irq(struct uart_port *port);
int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
void serial8250_tx_chars(struct uart_8250_port *up);
unsigned int serial8250_modem_status(struct uart_8250_port *up);
void serial8250_init_port(struct uart_8250_port *up);
void serial8250_set_defaults(struct uart_8250_port *up);
void serial8250_console_write(struct uart_8250_port *up, const char *s,
			      unsigned int count);
int serial8250_console_setup(struct uart_port *port, char *options, bool probe);

extern void serial8250_set_isa_configurator(void (*v)
					(int port, struct uart_port *up,
						u32 *capabilities));

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/serial_8250.h
	3	*
	4	* Copyright (C) 2004 Russell King
	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	#ifndef _LINUX_SERIAL_8250_H
	12	#define _LINUX_SERIAL_8250_H
	13
	14	#include <linux/serial_core.h>
34d2e458	15	#include <linux/serial_reg.h>
d052d1be	16	#include <linux/platform_device.h>
1da177e4	17
bc49a661 RK	18	/*
	19	* This is the platform device platform_data structure
	20	*/
1da177e4 LT	21	struct plat_serial8250_port {
	22	unsigned long iobase; /* io base address */
	23	void __iomem membase; / ioremap cookie or NULL */
4f640efb	24	resource_size_t mapbase; /* resource base */
1da177e4	25	unsigned int irq; /* interrupt number */
1c2f0493	26	unsigned long irqflags; /* request_irq flags */
1da177e4	27	unsigned int uartclk; /* UART clock rate */
74a19741	28	void *private_data;
1da177e4 LT	29	unsigned char regshift; /* register shift */
1da177e4 LT	30	unsigned char iotype; /* UPIO_* */
ec9f47cd	31	unsigned char hub6;
0077d45e	32	upf_t flags; /* UPF_* flags */
8e23fcc8	33	unsigned int type; /* If UPF_FIXED_TYPE */
7d6a07d1 DD	34	unsigned int (serial_in)(struct uart_port , int);
7d6a07d1 DD	35	void (serial_out)(struct uart_port , int, int);
235dae5d PL	36	void (set_termios)(struct uart_port ,
	37	struct ktermios *new,
	38	struct ktermios *old);
db405a8f EB	39	void (set_ldisc)(struct uart_port ,
db405a8f EB	40	struct ktermios *);
144ef5c2	41	unsigned int (get_mctrl)(struct uart_port );
583d28e9	42	int (handle_irq)(struct uart_port );
c161afe9 ML	43	void (pm)(struct uart_port , unsigned int state,
c161afe9 ML	44	unsigned old);
bf03f65b	45	void (handle_break)(struct uart_port );
1da177e4 LT	46	};
1da177e4 LT	47
6df29deb RK	48	/*
	49	* Allocate 8250 platform device IDs. Nothing is implied by
	50	* the numbering here, except for the legacy entry being -1.
	51	*/
	52	enum {
	53	PLAT8250_DEV_LEGACY = -1,
	54	PLAT8250_DEV_PLATFORM,
	55	PLAT8250_DEV_PLATFORM1,
104c7b03	56	PLAT8250_DEV_PLATFORM2,
6df29deb RK	57	PLAT8250_DEV_FOURPORT,
	58	PLAT8250_DEV_ACCENT,
	59	PLAT8250_DEV_BOCA,
e0980daf	60	PLAT8250_DEV_EXAR_ST16C554,
6df29deb	61	PLAT8250_DEV_HUB6,
21c614a7	62	PLAT8250_DEV_AU1X00,
61711f8f	63	PLAT8250_DEV_SM501,
6df29deb RK	64	};
6df29deb RK	65
9ee4b83e	66	struct uart_8250_dma;
a4416cd1 PH	67	struct uart_8250_port;
	68
	69	/**
	70	* 8250 core driver operations
	71	*
	72	* @setup_irq() Setup irq handling. The universal 8250 driver links this
	73	* port to the irq chain. Other drivers may @request_irq().
	74	* @release_irq() Undo irq handling. The universal 8250 driver unlinks
	75	* the port from the irq chain.
	76	*/
	77	struct uart_8250_ops {
	78	int (setup_irq)(struct uart_8250_port );
	79	void (release_irq)(struct uart_8250_port );
	80	};
9ee4b83e	81
e490c914	82	struct uart_8250_em485 {
6e0a5de2 RG	83	struct hrtimer start_tx_timer; /* "rs485 start tx" timer */
	84	struct hrtimer stop_tx_timer; /* "rs485 stop tx" timer */
	85	struct hrtimer active_timer; / pointer to active timer */
	86	struct uart_8250_port port; / for hrtimer callbacks */
e490c914 MK	87	};
e490c914 MK	88
bc49a661 RK	89	/*
	90	* This should be used by drivers which want to register
	91	* their own 8250 ports without registering their own
	92	* platform device. Using these will make your driver
	93	* dependent on the 8250 driver.
	94	*/
ce7240e4 AC	95
	96	struct uart_8250_port {
	97	struct uart_port port;
	98	struct timer_list timer; /* "no irq" timer */
	99	struct list_head list; /* ports on this IRQ */
98838d95	100	u32 capabilities; /* port capabilities */
ce7240e4	101	unsigned short bugs; /* port bugs */
aef9a7bd	102	bool fifo_bug; /* min RX trigger if enabled */
ce7240e4 AC	103	unsigned int tx_loadsz; /* transmit fifo load size */
ce7240e4 AC	104	unsigned char acr;
aef9a7bd	105	unsigned char fcr;
ce7240e4 AC	106	unsigned char ier;
	107	unsigned char lcr;
	108	unsigned char mcr;
	109	unsigned char mcr_mask; /* mask of user bits */
	110	unsigned char mcr_force; /* mask of forced bits */
	111	unsigned char cur_iotype; /* Running I/O type */
baeb7ef3	112	unsigned int rpm_tx_active;
4516d50a PH	113	unsigned char canary; /* non-zero during system sleep
	114	* if no_console_suspend
	115	*/
40375393 PH	116	unsigned char probe;
40375393 PH	117	#define UART_PROBE_RSA (1 << 0)
ce7240e4 AC	118
	119	/*
	120	* Some bits in registers are cleared on a read, so they must
	121	* be saved whenever the register is read but the bits will not
	122	* be immediately processed.
	123	*/
	124	#define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
	125	unsigned char lsr_saved_flags;
	126	#define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
	127	unsigned char msr_saved_flags;
	128
9ee4b83e	129	struct uart_8250_dma *dma;
a4416cd1	130	const struct uart_8250_ops *ops;
9ee4b83e	131
ce7240e4 AC	132	/* 8250 specific callbacks */
	133	int (dl_read)(struct uart_8250_port );
	134	void (dl_write)(struct uart_8250_port , int);
e490c914 MK	135
e490c914 MK	136	struct uart_8250_em485 *em485;
886979da DD	137
	138	/* Serial port overrun backoff */
	139	struct delayed_work overrun_backoff;
	140	u32 overrun_backoff_time_ms;
ce7240e4	141	};
bc49a661	142
b1261c86 AS	143	static inline struct uart_8250_port up_to_u8250p(struct uart_port up)
	144	{
	145	return container_of(up, struct uart_8250_port, port);
	146	}
	147
f73fa05b	148	int serial8250_register_8250_port(struct uart_8250_port *);
bc49a661 RK	149	void serial8250_unregister_port(int line);
	150	void serial8250_suspend_port(int line);
	151	void serial8250_resume_port(int line);
	152
b187f180 YL	153	extern int early_serial_setup(struct uart_port *port);
b187f180 YL	154
1c5841e8 EH	155	extern int early_serial8250_setup(struct earlycon_device *device,
1c5841e8 EH	156	const char *options);
235dae5d PL	157	extern void serial8250_do_set_termios(struct uart_port *port,
235dae5d PL	158	struct ktermios termios, struct ktermios old);
db405a8f EB	159	extern void serial8250_do_set_ldisc(struct uart_port *port,
db405a8f EB	160	struct ktermios *termios);
144ef5c2	161	extern unsigned int serial8250_do_get_mctrl(struct uart_port *port);
b99b121b SAS	162	extern int serial8250_do_startup(struct uart_port *port);
b99b121b SAS	163	extern void serial8250_do_shutdown(struct uart_port *port);
c161afe9 ML	164	extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
c161afe9 ML	165	unsigned int oldstate);
4bf4ea9d	166	extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
9deaa53a	167	extern int fsl8250_handle_irq(struct uart_port *port);
583d28e9	168	int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
3986fb2b PG	169	unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
	170	void serial8250_tx_chars(struct uart_8250_port *up);
	171	unsigned int serial8250_modem_status(struct uart_8250_port *up);
b6830f6d PH	172	void serial8250_init_port(struct uart_8250_port *up);
	173	void serial8250_set_defaults(struct uart_8250_port *up);
	174	void serial8250_console_write(struct uart_8250_port up, const char s,
	175	unsigned int count);
	176	int serial8250_console_setup(struct uart_port port, char options, bool probe);
18a8bd94	177
af7f3743 AC	178	extern void serial8250_set_isa_configurator(void (*v)
af7f3743 AC	179	(int port, struct uart_port *up,
98838d95	180	u32 *capabilities));
af7f3743	181
1da177e4	182	#endif