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