xref: /openbmc/linux/drivers/tty/serial/8250/8250.h (revision fa0a497b)
1 /*
2  *  Driver for 8250/16550-type serial ports
3  *
4  *  Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
5  *
6  *  Copyright (C) 2001 Russell King.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  */
13 
14 #include <linux/serial_8250.h>
15 #include <linux/serial_reg.h>
16 #include <linux/dmaengine.h>
17 
18 struct uart_8250_dma {
19 	int (*tx_dma)(struct uart_8250_port *p);
20 	int (*rx_dma)(struct uart_8250_port *p, unsigned int iir);
21 
22 	/* Filter function */
23 	dma_filter_fn		fn;
24 	/* Parameter to the filter function */
25 	void			*rx_param;
26 	void			*tx_param;
27 
28 	struct dma_slave_config	rxconf;
29 	struct dma_slave_config	txconf;
30 
31 	struct dma_chan		*rxchan;
32 	struct dma_chan		*txchan;
33 
34 	dma_addr_t		rx_addr;
35 	dma_addr_t		tx_addr;
36 
37 	dma_cookie_t		rx_cookie;
38 	dma_cookie_t		tx_cookie;
39 
40 	void			*rx_buf;
41 
42 	size_t			rx_size;
43 	size_t			tx_size;
44 
45 	unsigned char		tx_running;
46 	unsigned char		tx_err;
47 	unsigned char		rx_running;
48 };
49 
50 struct old_serial_port {
51 	unsigned int uart;
52 	unsigned int baud_base;
53 	unsigned int port;
54 	unsigned int irq;
55 	upf_t        flags;
56 	unsigned char hub6;
57 	unsigned char io_type;
58 	unsigned char __iomem *iomem_base;
59 	unsigned short iomem_reg_shift;
60 	unsigned long irqflags;
61 };
62 
63 struct serial8250_config {
64 	const char	*name;
65 	unsigned short	fifo_size;
66 	unsigned short	tx_loadsz;
67 	unsigned char	fcr;
68 	unsigned char	rxtrig_bytes[UART_FCR_R_TRIG_MAX_STATE];
69 	unsigned int	flags;
70 };
71 
72 #define UART_CAP_FIFO	(1 << 8)	/* UART has FIFO */
73 #define UART_CAP_EFR	(1 << 9)	/* UART has EFR */
74 #define UART_CAP_SLEEP	(1 << 10)	/* UART has IER sleep */
75 #define UART_CAP_AFE	(1 << 11)	/* MCR-based hw flow control */
76 #define UART_CAP_UUE	(1 << 12)	/* UART needs IER bit 6 set (Xscale) */
77 #define UART_CAP_RTOIE	(1 << 13)	/* UART needs IER bit 4 set (Xscale, Tegra) */
78 #define UART_CAP_HFIFO	(1 << 14)	/* UART has a "hidden" FIFO */
79 #define UART_CAP_RPM	(1 << 15)	/* Runtime PM is active while idle */
80 
81 #define UART_BUG_QUOT	(1 << 0)	/* UART has buggy quot LSB */
82 #define UART_BUG_TXEN	(1 << 1)	/* UART has buggy TX IIR status */
83 #define UART_BUG_NOMSR	(1 << 2)	/* UART has buggy MSR status bits (Au1x00) */
84 #define UART_BUG_THRE	(1 << 3)	/* UART has buggy THRE reassertion */
85 #define UART_BUG_PARITY	(1 << 4)	/* UART mishandles parity if FIFO enabled */
86 
87 #define HIGH_BITS_OFFSET ((sizeof(long)-sizeof(int))*8)
88 
89 #ifdef CONFIG_SERIAL_8250_SHARE_IRQ
90 #define SERIAL8250_SHARE_IRQS 1
91 #else
92 #define SERIAL8250_SHARE_IRQS 0
93 #endif
94 
95 #define SERIAL8250_PORT_FLAGS(_base, _irq, _flags)		\
96 	{							\
97 		.iobase		= _base,			\
98 		.irq		= _irq,				\
99 		.uartclk	= 1843200,			\
100 		.iotype		= UPIO_PORT,			\
101 		.flags		= UPF_BOOT_AUTOCONF | (_flags),	\
102 	}
103 
104 #define SERIAL8250_PORT(_base, _irq) SERIAL8250_PORT_FLAGS(_base, _irq, 0)
105 
106 
107 static inline int serial_in(struct uart_8250_port *up, int offset)
108 {
109 	return up->port.serial_in(&up->port, offset);
110 }
111 
112 static inline void serial_out(struct uart_8250_port *up, int offset, int value)
113 {
114 	up->port.serial_out(&up->port, offset, value);
115 }
116 
117 void serial8250_clear_and_reinit_fifos(struct uart_8250_port *p);
118 
119 static inline int serial_dl_read(struct uart_8250_port *up)
120 {
121 	return up->dl_read(up);
122 }
123 
124 static inline void serial_dl_write(struct uart_8250_port *up, int value)
125 {
126 	up->dl_write(up, value);
127 }
128 
129 struct uart_8250_port *serial8250_get_port(int line);
130 void serial8250_rpm_get(struct uart_8250_port *p);
131 void serial8250_rpm_put(struct uart_8250_port *p);
132 int serial8250_em485_init(struct uart_8250_port *p);
133 void serial8250_em485_destroy(struct uart_8250_port *p);
134 
135 #if defined(__alpha__) && !defined(CONFIG_PCI)
136 /*
137  * Digital did something really horribly wrong with the OUT1 and OUT2
138  * lines on at least some ALPHA's.  The failure mode is that if either
139  * is cleared, the machine locks up with endless interrupts.
140  */
141 #define ALPHA_KLUDGE_MCR  (UART_MCR_OUT2 | UART_MCR_OUT1)
142 #else
143 #define ALPHA_KLUDGE_MCR 0
144 #endif
145 
146 #ifdef CONFIG_SERIAL_8250_PNP
147 int serial8250_pnp_init(void);
148 void serial8250_pnp_exit(void);
149 #else
150 static inline int serial8250_pnp_init(void) { return 0; }
151 static inline void serial8250_pnp_exit(void) { }
152 #endif
153 
154 #ifdef CONFIG_ARCH_OMAP1
155 static inline int is_omap1_8250(struct uart_8250_port *pt)
156 {
157 	int res;
158 
159 	switch (pt->port.mapbase) {
160 	case OMAP1_UART1_BASE:
161 	case OMAP1_UART2_BASE:
162 	case OMAP1_UART3_BASE:
163 		res = 1;
164 		break;
165 	default:
166 		res = 0;
167 		break;
168 	}
169 
170 	return res;
171 }
172 
173 static inline int is_omap1510_8250(struct uart_8250_port *pt)
174 {
175 	if (!cpu_is_omap1510())
176 		return 0;
177 
178 	return is_omap1_8250(pt);
179 }
180 #else
181 static inline int is_omap1_8250(struct uart_8250_port *pt)
182 {
183 	return 0;
184 }
185 static inline int is_omap1510_8250(struct uart_8250_port *pt)
186 {
187 	return 0;
188 }
189 #endif
190 
191 #ifdef CONFIG_SERIAL_8250_DMA
192 extern int serial8250_tx_dma(struct uart_8250_port *);
193 extern int serial8250_rx_dma(struct uart_8250_port *, unsigned int iir);
194 extern int serial8250_request_dma(struct uart_8250_port *);
195 extern void serial8250_release_dma(struct uart_8250_port *);
196 #else
197 static inline int serial8250_tx_dma(struct uart_8250_port *p)
198 {
199 	return -1;
200 }
201 static inline int serial8250_rx_dma(struct uart_8250_port *p, unsigned int iir)
202 {
203 	return -1;
204 }
205 static inline int serial8250_request_dma(struct uart_8250_port *p)
206 {
207 	return -1;
208 }
209 static inline void serial8250_release_dma(struct uart_8250_port *p) { }
210 #endif
211 
212 static inline int ns16550a_goto_highspeed(struct uart_8250_port *up)
213 {
214 	unsigned char status;
215 
216 	status = serial_in(up, 0x04); /* EXCR2 */
217 #define PRESL(x) ((x) & 0x30)
218 	if (PRESL(status) == 0x10) {
219 		/* already in high speed mode */
220 		return 0;
221 	} else {
222 		status &= ~0xB0; /* Disable LOCK, mask out PRESL[01] */
223 		status |= 0x10;  /* 1.625 divisor for baud_base --> 921600 */
224 		serial_out(up, 0x04, status);
225 	}
226 	return 1;
227 }
228 
229 static inline int serial_index(struct uart_port *port)
230 {
231 	return port->minor - 64;
232 }
233 
234 #if 0
235 #define DEBUG_INTR(fmt...)	printk(fmt)
236 #else
237 #define DEBUG_INTR(fmt...)	do { } while (0)
238 #endif
239