Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
1da177e4 LT |
2 | /* |
3 | * linux/drivers/char/serial_core.h | |
4 | * | |
5 | * Copyright (C) 2000 Deep Blue Solutions Ltd. | |
1da177e4 LT |
6 | */ |
7 | #ifndef LINUX_SERIAL_CORE_H | |
8 | #define LINUX_SERIAL_CORE_H | |
9 | ||
c7ac15ce | 10 | #include <linux/bitops.h> |
661f83a6 | 11 | #include <linux/compiler.h> |
3e6f8806 | 12 | #include <linux/console.h> |
1da177e4 LT |
13 | #include <linux/interrupt.h> |
14 | #include <linux/circ_buf.h> | |
15 | #include <linux/spinlock.h> | |
16 | #include <linux/sched.h> | |
17 | #include <linux/tty.h> | |
e2862f6a | 18 | #include <linux/mutex.h> |
b11115c1 | 19 | #include <linux/sysrq.h> |
607ca46e | 20 | #include <uapi/linux/serial_core.h> |
1da177e4 | 21 | |
cf0ebee0 SP |
22 | #ifdef CONFIG_SERIAL_CORE_CONSOLE |
23 | #define uart_console(port) \ | |
24 | ((port)->cons && (port)->cons->index == (port)->line) | |
25 | #else | |
6b3cddcc | 26 | #define uart_console(port) ({ (void)port; 0; }) |
cf0ebee0 SP |
27 | #endif |
28 | ||
1da177e4 | 29 | struct uart_port; |
1da177e4 LT |
30 | struct serial_struct; |
31 | struct device; | |
167cbce2 | 32 | struct gpio_desc; |
1da177e4 LT |
33 | |
34 | /* | |
e759d7c5 | 35 | * This structure describes all the operations that can be done on the |
65388dad | 36 | * physical hardware. See Documentation/driver-api/serial/driver.rst for details. |
1da177e4 LT |
37 | */ |
38 | struct uart_ops { | |
39 | unsigned int (*tx_empty)(struct uart_port *); | |
40 | void (*set_mctrl)(struct uart_port *, unsigned int mctrl); | |
41 | unsigned int (*get_mctrl)(struct uart_port *); | |
b129a8cc RK |
42 | void (*stop_tx)(struct uart_port *); |
43 | void (*start_tx)(struct uart_port *); | |
9aba8d5b RK |
44 | void (*throttle)(struct uart_port *); |
45 | void (*unthrottle)(struct uart_port *); | |
1da177e4 LT |
46 | void (*send_xchar)(struct uart_port *, char ch); |
47 | void (*stop_rx)(struct uart_port *); | |
cfab87c2 | 48 | void (*start_rx)(struct uart_port *); |
1da177e4 LT |
49 | void (*enable_ms)(struct uart_port *); |
50 | void (*break_ctl)(struct uart_port *, int ctl); | |
51 | int (*startup)(struct uart_port *); | |
52 | void (*shutdown)(struct uart_port *); | |
6bb0e3a5 | 53 | void (*flush_buffer)(struct uart_port *); |
606d099c AC |
54 | void (*set_termios)(struct uart_port *, struct ktermios *new, |
55 | struct ktermios *old); | |
732a84a0 | 56 | void (*set_ldisc)(struct uart_port *, struct ktermios *); |
1da177e4 LT |
57 | void (*pm)(struct uart_port *, unsigned int state, |
58 | unsigned int oldstate); | |
1da177e4 LT |
59 | |
60 | /* | |
61 | * Return a string describing the type of the port | |
62 | */ | |
e759d7c5 | 63 | const char *(*type)(struct uart_port *); |
1da177e4 LT |
64 | |
65 | /* | |
66 | * Release IO and memory resources used by the port. | |
67 | * This includes iounmap if necessary. | |
68 | */ | |
69 | void (*release_port)(struct uart_port *); | |
70 | ||
71 | /* | |
72 | * Request IO and memory resources used by the port. | |
73 | * This includes iomapping the port if necessary. | |
74 | */ | |
75 | int (*request_port)(struct uart_port *); | |
76 | void (*config_port)(struct uart_port *, int); | |
77 | int (*verify_port)(struct uart_port *, struct serial_struct *); | |
78 | int (*ioctl)(struct uart_port *, unsigned int, unsigned long); | |
f2d937f3 | 79 | #ifdef CONFIG_CONSOLE_POLL |
c7f3e708 | 80 | int (*poll_init)(struct uart_port *); |
e759d7c5 | 81 | void (*poll_put_char)(struct uart_port *, unsigned char); |
f2d937f3 JW |
82 | int (*poll_get_char)(struct uart_port *); |
83 | #endif | |
1da177e4 LT |
84 | }; |
85 | ||
f5316b4a | 86 | #define NO_POLL_CHAR 0x00ff0000 |
1da177e4 LT |
87 | #define UART_CONFIG_TYPE (1 << 0) |
88 | #define UART_CONFIG_IRQ (1 << 1) | |
89 | ||
90 | struct uart_icount { | |
91 | __u32 cts; | |
92 | __u32 dsr; | |
93 | __u32 rng; | |
94 | __u32 dcd; | |
95 | __u32 rx; | |
96 | __u32 tx; | |
97 | __u32 frame; | |
98 | __u32 overrun; | |
99 | __u32 parity; | |
100 | __u32 brk; | |
101 | __u32 buf_overrun; | |
102 | }; | |
103 | ||
9efeccac MT |
104 | typedef unsigned int __bitwise upf_t; |
105 | typedef unsigned int __bitwise upstat_t; | |
0077d45e | 106 | |
1da177e4 LT |
107 | struct uart_port { |
108 | spinlock_t lock; /* port lock */ | |
0c8946d9 | 109 | unsigned long iobase; /* in/out[bwl] */ |
1da177e4 | 110 | unsigned char __iomem *membase; /* read/write[bwl] */ |
7d6a07d1 DD |
111 | unsigned int (*serial_in)(struct uart_port *, int); |
112 | void (*serial_out)(struct uart_port *, int, int); | |
235dae5d PL |
113 | void (*set_termios)(struct uart_port *, |
114 | struct ktermios *new, | |
115 | struct ktermios *old); | |
db405a8f EB |
116 | void (*set_ldisc)(struct uart_port *, |
117 | struct ktermios *); | |
144ef5c2 | 118 | unsigned int (*get_mctrl)(struct uart_port *); |
4bf4ea9d | 119 | void (*set_mctrl)(struct uart_port *, unsigned int); |
0238d2b4 JZ |
120 | unsigned int (*get_divisor)(struct uart_port *, |
121 | unsigned int baud, | |
122 | unsigned int *frac); | |
123 | void (*set_divisor)(struct uart_port *, | |
124 | unsigned int baud, | |
125 | unsigned int quot, | |
126 | unsigned int quot_frac); | |
b99b121b SAS |
127 | int (*startup)(struct uart_port *port); |
128 | void (*shutdown)(struct uart_port *port); | |
234abab1 SAS |
129 | void (*throttle)(struct uart_port *port); |
130 | void (*unthrottle)(struct uart_port *port); | |
a74036f5 | 131 | int (*handle_irq)(struct uart_port *); |
c161afe9 ML |
132 | void (*pm)(struct uart_port *, unsigned int state, |
133 | unsigned int old); | |
bf03f65b | 134 | void (*handle_break)(struct uart_port *); |
a5f276f1 RRD |
135 | int (*rs485_config)(struct uart_port *, |
136 | struct serial_rs485 *rs485); | |
ad8c0eaa NF |
137 | int (*iso7816_config)(struct uart_port *, |
138 | struct serial_iso7816 *iso7816); | |
1da177e4 | 139 | unsigned int irq; /* irq number */ |
1c2f0493 | 140 | unsigned long irqflags; /* irq flags */ |
1da177e4 | 141 | unsigned int uartclk; /* base uart clock */ |
947deee8 | 142 | unsigned int fifosize; /* tx fifo size */ |
1da177e4 LT |
143 | unsigned char x_char; /* xon/xoff char */ |
144 | unsigned char regshift; /* reg offset shift */ | |
145 | unsigned char iotype; /* io access style */ | |
c7ac15ce | 146 | unsigned char quirks; /* internal quirks */ |
1da177e4 | 147 | |
647f162b PH |
148 | #define UPIO_PORT (SERIAL_IO_PORT) /* 8b I/O port access */ |
149 | #define UPIO_HUB6 (SERIAL_IO_HUB6) /* Hub6 ISA card */ | |
858965d9 | 150 | #define UPIO_MEM (SERIAL_IO_MEM) /* driver-specific */ |
647f162b PH |
151 | #define UPIO_MEM32 (SERIAL_IO_MEM32) /* 32b little endian */ |
152 | #define UPIO_AU (SERIAL_IO_AU) /* Au1x00 and RT288x type IO */ | |
153 | #define UPIO_TSI (SERIAL_IO_TSI) /* Tsi108/109 type IO */ | |
154 | #define UPIO_MEM32BE (SERIAL_IO_MEM32BE) /* 32b big endian */ | |
bd94c407 | 155 | #define UPIO_MEM16 (SERIAL_IO_MEM16) /* 16b little endian */ |
1da177e4 | 156 | |
c7ac15ce AS |
157 | /* quirks must be updated while holding port mutex */ |
158 | #define UPQ_NO_TXEN_TEST BIT(0) | |
159 | ||
1da177e4 LT |
160 | unsigned int read_status_mask; /* driver specific */ |
161 | unsigned int ignore_status_mask; /* driver specific */ | |
ebd2c8f6 | 162 | struct uart_state *state; /* pointer to parent state */ |
1da177e4 LT |
163 | struct uart_icount icount; /* statistics */ |
164 | ||
165 | struct console *cons; /* struct console, if any */ | |
8a949b07 | 166 | /* flags must be updated while holding port mutex */ |
0077d45e RK |
167 | upf_t flags; |
168 | ||
904326ec PH |
169 | /* |
170 | * These flags must be equivalent to the flags defined in | |
171 | * include/uapi/linux/tty_flags.h which are the userspace definitions | |
172 | * assigned from the serial_struct flags in uart_set_info() | |
173 | * [for bit definitions in the UPF_CHANGE_MASK] | |
174 | * | |
916acbf6 | 175 | * Bits [0..ASYNCB_LAST_USER] are userspace defined/visible/changeable |
904326ec PH |
176 | * The remaining bits are serial-core specific and not modifiable by |
177 | * userspace. | |
178 | */ | |
179 | #define UPF_FOURPORT ((__force upf_t) ASYNC_FOURPORT /* 1 */ ) | |
180 | #define UPF_SAK ((__force upf_t) ASYNC_SAK /* 2 */ ) | |
181 | #define UPF_SPD_HI ((__force upf_t) ASYNC_SPD_HI /* 4 */ ) | |
182 | #define UPF_SPD_VHI ((__force upf_t) ASYNC_SPD_VHI /* 5 */ ) | |
183 | #define UPF_SPD_CUST ((__force upf_t) ASYNC_SPD_CUST /* 0x0030 */ ) | |
184 | #define UPF_SPD_WARP ((__force upf_t) ASYNC_SPD_WARP /* 0x1010 */ ) | |
185 | #define UPF_SPD_MASK ((__force upf_t) ASYNC_SPD_MASK /* 0x1030 */ ) | |
186 | #define UPF_SKIP_TEST ((__force upf_t) ASYNC_SKIP_TEST /* 6 */ ) | |
187 | #define UPF_AUTO_IRQ ((__force upf_t) ASYNC_AUTO_IRQ /* 7 */ ) | |
188 | #define UPF_HARDPPS_CD ((__force upf_t) ASYNC_HARDPPS_CD /* 11 */ ) | |
189 | #define UPF_SPD_SHI ((__force upf_t) ASYNC_SPD_SHI /* 12 */ ) | |
190 | #define UPF_LOW_LATENCY ((__force upf_t) ASYNC_LOW_LATENCY /* 13 */ ) | |
191 | #define UPF_BUGGY_UART ((__force upf_t) ASYNC_BUGGY_UART /* 14 */ ) | |
904326ec PH |
192 | #define UPF_MAGIC_MULTIPLIER ((__force upf_t) ASYNC_MAGIC_MULTIPLIER /* 16 */ ) |
193 | ||
ea5244e2 | 194 | #define UPF_NO_THRE_TEST ((__force upf_t) (1 << 19)) |
391f93f2 PH |
195 | /* Port has hardware-assisted h/w flow control */ |
196 | #define UPF_AUTO_CTS ((__force upf_t) (1 << 20)) | |
197 | #define UPF_AUTO_RTS ((__force upf_t) (1 << 21)) | |
198 | #define UPF_HARD_FLOW ((__force upf_t) (UPF_AUTO_CTS | UPF_AUTO_RTS)) | |
2cbacafd RK |
199 | /* Port has hardware-assisted s/w flow control */ |
200 | #define UPF_SOFT_FLOW ((__force upf_t) (1 << 22)) | |
0077d45e RK |
201 | #define UPF_CONS_FLOW ((__force upf_t) (1 << 23)) |
202 | #define UPF_SHARE_IRQ ((__force upf_t) (1 << 24)) | |
06315348 | 203 | #define UPF_EXAR_EFR ((__force upf_t) (1 << 25)) |
bc02d15a | 204 | #define UPF_BUG_THRE ((__force upf_t) (1 << 26)) |
8e23fcc8 DD |
205 | /* The exact UART type is known and should not be probed. */ |
206 | #define UPF_FIXED_TYPE ((__force upf_t) (1 << 27)) | |
0077d45e | 207 | #define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28)) |
abb4a239 | 208 | #define UPF_FIXED_PORT ((__force upf_t) (1 << 29)) |
68ac64cd | 209 | #define UPF_DEAD ((__force upf_t) (1 << 30)) |
0077d45e RK |
210 | #define UPF_IOREMAP ((__force upf_t) (1 << 31)) |
211 | ||
904326ec PH |
212 | #define __UPF_CHANGE_MASK 0x17fff |
213 | #define UPF_CHANGE_MASK ((__force upf_t) __UPF_CHANGE_MASK) | |
0077d45e | 214 | #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY)) |
1da177e4 | 215 | |
904326ec PH |
216 | #if __UPF_CHANGE_MASK > ASYNC_FLAGS |
217 | #error Change mask not equivalent to userspace-visible bit defines | |
218 | #endif | |
219 | ||
391f93f2 PH |
220 | /* |
221 | * Must hold termios_rwsem, port mutex and port lock to change; | |
222 | * can hold any one lock to read. | |
223 | */ | |
299245a1 PH |
224 | upstat_t status; |
225 | ||
226 | #define UPSTAT_CTS_ENABLE ((__force upstat_t) (1 << 0)) | |
227 | #define UPSTAT_DCD_ENABLE ((__force upstat_t) (1 << 1)) | |
391f93f2 PH |
228 | #define UPSTAT_AUTORTS ((__force upstat_t) (1 << 2)) |
229 | #define UPSTAT_AUTOCTS ((__force upstat_t) (1 << 3)) | |
230 | #define UPSTAT_AUTOXOFF ((__force upstat_t) (1 << 4)) | |
c5f78b1f | 231 | #define UPSTAT_SYNC_FIFO ((__force upstat_t) (1 << 5)) |
299245a1 | 232 | |
d01f4d18 | 233 | int hw_stopped; /* sw-assisted CTS flow state */ |
1da177e4 LT |
234 | unsigned int mctrl; /* current modem ctrl settings */ |
235 | unsigned int timeout; /* character-based timeout */ | |
31f6bd7f | 236 | unsigned int frame_time; /* frame timing in ns */ |
1da177e4 | 237 | unsigned int type; /* port type */ |
ba899dbc | 238 | const struct uart_ops *ops; |
1da177e4 LT |
239 | unsigned int custom_divisor; |
240 | unsigned int line; /* port index */ | |
959801fe | 241 | unsigned int minor; |
4f640efb | 242 | resource_size_t mapbase; /* for ioremap */ |
ee97d0e3 | 243 | resource_size_t mapsize; |
1da177e4 | 244 | struct device *dev; /* parent device */ |
7e5ed9f5 | 245 | |
7e5ed9f5 DS |
246 | unsigned long sysrq; /* sysrq timeout */ |
247 | unsigned int sysrq_ch; /* char for sysrq */ | |
1997e9df | 248 | unsigned char has_sysrq; |
68af4317 | 249 | unsigned char sysrq_seq; /* index in sysrq_toggle_seq */ |
7e5ed9f5 | 250 | |
1da177e4 | 251 | unsigned char hub6; /* this should be in the 8250 driver */ |
b3b708fa | 252 | unsigned char suspended; |
e0830dbf | 253 | unsigned char console_reinit; |
2e94d5ae | 254 | const char *name; /* port name */ |
266dcff0 GKH |
255 | struct attribute_group *attr_group; /* port specific attributes */ |
256 | const struct attribute_group **tty_groups; /* all attributes (serial core use only) */ | |
a5f276f1 | 257 | struct serial_rs485 rs485; |
d58a2df3 | 258 | struct gpio_desc *rs485_term_gpio; /* enable RS485 bus termination */ |
ad8c0eaa | 259 | struct serial_iso7816 iso7816; |
beab697a | 260 | void *private_data; /* generic platform data pointer */ |
1da177e4 LT |
261 | }; |
262 | ||
927353a7 PG |
263 | static inline int serial_port_in(struct uart_port *up, int offset) |
264 | { | |
265 | return up->serial_in(up, offset); | |
266 | } | |
267 | ||
268 | static inline void serial_port_out(struct uart_port *up, int offset, int value) | |
269 | { | |
270 | up->serial_out(up, offset, value); | |
271 | } | |
272 | ||
6f538fe3 LW |
273 | /** |
274 | * enum uart_pm_state - power states for UARTs | |
275 | * @UART_PM_STATE_ON: UART is powered, up and operational | |
276 | * @UART_PM_STATE_OFF: UART is powered off | |
277 | * @UART_PM_STATE_UNDEFINED: sentinel | |
278 | */ | |
279 | enum uart_pm_state { | |
280 | UART_PM_STATE_ON = 0, | |
281 | UART_PM_STATE_OFF = 3, /* number taken from ACPI */ | |
282 | UART_PM_STATE_UNDEFINED, | |
283 | }; | |
284 | ||
ebd2c8f6 AC |
285 | /* |
286 | * This is the state information which is persistent across opens. | |
ebd2c8f6 AC |
287 | */ |
288 | struct uart_state { | |
df4f4dd4 | 289 | struct tty_port port; |
ebd2c8f6 | 290 | |
6f538fe3 | 291 | enum uart_pm_state pm_state; |
1da177e4 | 292 | struct circ_buf xmit; |
1da177e4 | 293 | |
9ed19428 PH |
294 | atomic_t refcount; |
295 | wait_queue_head_t remove_wait; | |
ebd2c8f6 | 296 | struct uart_port *uart_port; |
f751928e AC |
297 | }; |
298 | ||
299 | #define UART_XMIT_SIZE PAGE_SIZE | |
300 | ||
301 | ||
1da177e4 LT |
302 | /* number of characters left in xmit buffer before we ask for more */ |
303 | #define WAKEUP_CHARS 256 | |
304 | ||
305 | struct module; | |
306 | struct tty_driver; | |
307 | ||
308 | struct uart_driver { | |
309 | struct module *owner; | |
310 | const char *driver_name; | |
311 | const char *dev_name; | |
1da177e4 LT |
312 | int major; |
313 | int minor; | |
314 | int nr; | |
315 | struct console *cons; | |
316 | ||
317 | /* | |
318 | * these are private; the low level driver should not | |
319 | * touch these; they should be initialised to NULL | |
320 | */ | |
321 | struct uart_state *state; | |
322 | struct tty_driver *tty_driver; | |
323 | }; | |
324 | ||
325 | void uart_write_wakeup(struct uart_port *port); | |
326 | ||
327 | /* | |
328 | * Baud rate helpers. | |
329 | */ | |
330 | void uart_update_timeout(struct uart_port *port, unsigned int cflag, | |
331 | unsigned int baud); | |
606d099c AC |
332 | unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios, |
333 | struct ktermios *old, unsigned int min, | |
1da177e4 LT |
334 | unsigned int max); |
335 | unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud); | |
336 | ||
54381067 AV |
337 | /* Base timer interval for polling */ |
338 | static inline int uart_poll_timeout(struct uart_port *port) | |
339 | { | |
340 | int timeout = port->timeout; | |
341 | ||
342 | return timeout > 6 ? (timeout / 2 - 2) : 1; | |
343 | } | |
344 | ||
1da177e4 LT |
345 | /* |
346 | * Console helpers. | |
347 | */ | |
9aac5887 RH |
348 | struct earlycon_device { |
349 | struct console *con; | |
350 | struct uart_port port; | |
351 | char options[16]; /* e.g., 115200n8 */ | |
352 | unsigned int baud; | |
353 | }; | |
9aac5887 | 354 | |
470ca0de | 355 | struct earlycon_id { |
c1c734cb DA |
356 | char name[15]; |
357 | char name_term; /* In case compiler didn't '\0' term name */ | |
2eaa7909 | 358 | char compatible[128]; |
470ca0de | 359 | int (*setup)(struct earlycon_device *, const char *options); |
dd709e72 | 360 | }; |
470ca0de | 361 | |
62dcd9c5 JH |
362 | extern const struct earlycon_id __earlycon_table[]; |
363 | extern const struct earlycon_id __earlycon_table_end[]; | |
2eaa7909 | 364 | |
f8ba3647 MY |
365 | #if defined(CONFIG_SERIAL_EARLYCON) && !defined(MODULE) |
366 | #define EARLYCON_USED_OR_UNUSED __used | |
367 | #else | |
368 | #define EARLYCON_USED_OR_UNUSED __maybe_unused | |
369 | #endif | |
370 | ||
62dcd9c5 JH |
371 | #define OF_EARLYCON_DECLARE(_name, compat, fn) \ |
372 | static const struct earlycon_id __UNIQUE_ID(__earlycon_##_name) \ | |
373 | EARLYCON_USED_OR_UNUSED __section("__earlycon_table") \ | |
374 | __aligned(__alignof__(struct earlycon_id)) \ | |
2eaa7909 PH |
375 | = { .name = __stringify(_name), \ |
376 | .compatible = compat, \ | |
76437b34 | 377 | .setup = fn } |
2eaa7909 PH |
378 | |
379 | #define EARLYCON_DECLARE(_name, fn) OF_EARLYCON_DECLARE(_name, "", fn) | |
380 | ||
c90fe9c0 | 381 | extern int of_setup_earlycon(const struct earlycon_id *match, |
088da2a1 | 382 | unsigned long node, |
4d118c9a | 383 | const char *options); |
b0b6abd3 | 384 | |
ad1696f6 | 385 | #ifdef CONFIG_SERIAL_EARLYCON |
0231d000 | 386 | extern bool earlycon_acpi_spcr_enable __initdata; |
ad1696f6 AM |
387 | int setup_earlycon(char *buf); |
388 | #else | |
219c7b06 | 389 | static const bool earlycon_acpi_spcr_enable EARLYCON_USED_OR_UNUSED; |
ad1696f6 AM |
390 | static inline int setup_earlycon(char *buf) { return 0; } |
391 | #endif | |
392 | ||
f9b11229 IJ |
393 | static inline bool uart_console_enabled(struct uart_port *port) |
394 | { | |
395 | return uart_console(port) && (port->cons->flags & CON_ENABLED); | |
396 | } | |
397 | ||
1da177e4 LT |
398 | struct uart_port *uart_get_console(struct uart_port *ports, int nr, |
399 | struct console *c); | |
46e36683 | 400 | int uart_parse_earlycon(char *p, unsigned char *iotype, resource_size_t *addr, |
73abaf87 | 401 | char **options); |
0f646b63 | 402 | void uart_parse_options(const char *options, int *baud, int *parity, int *bits, |
1da177e4 LT |
403 | int *flow); |
404 | int uart_set_options(struct uart_port *port, struct console *co, int baud, | |
405 | int parity, int bits, int flow); | |
406 | struct tty_driver *uart_console_device(struct console *co, int *index); | |
d358788f RK |
407 | void uart_console_write(struct uart_port *port, const char *s, |
408 | unsigned int count, | |
3f8bab17 | 409 | void (*putchar)(struct uart_port *, unsigned char)); |
1da177e4 LT |
410 | |
411 | /* | |
412 | * Port/driver registration/removal | |
413 | */ | |
414 | int uart_register_driver(struct uart_driver *uart); | |
415 | void uart_unregister_driver(struct uart_driver *uart); | |
1da177e4 LT |
416 | int uart_add_one_port(struct uart_driver *reg, struct uart_port *port); |
417 | int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port); | |
b8be5db5 JS |
418 | bool uart_match_port(const struct uart_port *port1, |
419 | const struct uart_port *port2); | |
1da177e4 LT |
420 | |
421 | /* | |
422 | * Power Management | |
423 | */ | |
424 | int uart_suspend_port(struct uart_driver *reg, struct uart_port *port); | |
425 | int uart_resume_port(struct uart_driver *reg, struct uart_port *port); | |
426 | ||
427 | #define uart_circ_empty(circ) ((circ)->head == (circ)->tail) | |
428 | #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0) | |
429 | ||
430 | #define uart_circ_chars_pending(circ) \ | |
431 | (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE)) | |
432 | ||
433 | #define uart_circ_chars_free(circ) \ | |
434 | (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE)) | |
435 | ||
f751928e AC |
436 | static inline int uart_tx_stopped(struct uart_port *port) |
437 | { | |
ebd2c8f6 | 438 | struct tty_struct *tty = port->state->port.tty; |
6e94dbc7 | 439 | if ((tty && tty->flow.stopped) || port->hw_stopped) |
f751928e AC |
440 | return 1; |
441 | return 0; | |
442 | } | |
1da177e4 | 443 | |
299245a1 PH |
444 | static inline bool uart_cts_enabled(struct uart_port *uport) |
445 | { | |
d4260b51 | 446 | return !!(uport->status & UPSTAT_CTS_ENABLE); |
299245a1 PH |
447 | } |
448 | ||
391f93f2 PH |
449 | static inline bool uart_softcts_mode(struct uart_port *uport) |
450 | { | |
451 | upstat_t mask = UPSTAT_CTS_ENABLE | UPSTAT_AUTOCTS; | |
452 | ||
453 | return ((uport->status & mask) == UPSTAT_CTS_ENABLE); | |
454 | } | |
455 | ||
1da177e4 LT |
456 | /* |
457 | * The following are helper functions for the low level drivers. | |
458 | */ | |
027d7dac JS |
459 | |
460 | extern void uart_handle_dcd_change(struct uart_port *uport, | |
461 | unsigned int status); | |
462 | extern void uart_handle_cts_change(struct uart_port *uport, | |
463 | unsigned int status); | |
464 | ||
465 | extern void uart_insert_char(struct uart_port *port, unsigned int status, | |
466 | unsigned int overrun, unsigned int ch, unsigned int flag); | |
467 | ||
f58c252e IJ |
468 | void uart_xchar_out(struct uart_port *uport, int offset); |
469 | ||
08d54703 JH |
470 | #ifdef CONFIG_MAGIC_SYSRQ_SERIAL |
471 | #define SYSRQ_TIMEOUT (HZ * 5) | |
472 | ||
473 | bool uart_try_toggle_sysrq(struct uart_port *port, unsigned int ch); | |
474 | ||
475 | static inline int uart_handle_sysrq_char(struct uart_port *port, unsigned int ch) | |
476 | { | |
22538565 | 477 | if (!port->sysrq) |
08d54703 JH |
478 | return 0; |
479 | ||
480 | if (ch && time_before(jiffies, port->sysrq)) { | |
481 | if (sysrq_mask()) { | |
482 | handle_sysrq(ch); | |
483 | port->sysrq = 0; | |
484 | return 1; | |
485 | } | |
486 | if (uart_try_toggle_sysrq(port, ch)) | |
487 | return 1; | |
488 | } | |
489 | port->sysrq = 0; | |
490 | ||
491 | return 0; | |
492 | } | |
493 | ||
494 | static inline int uart_prepare_sysrq_char(struct uart_port *port, unsigned int ch) | |
495 | { | |
22538565 | 496 | if (!port->sysrq) |
08d54703 JH |
497 | return 0; |
498 | ||
499 | if (ch && time_before(jiffies, port->sysrq)) { | |
500 | if (sysrq_mask()) { | |
501 | port->sysrq_ch = ch; | |
502 | port->sysrq = 0; | |
503 | return 1; | |
504 | } | |
505 | if (uart_try_toggle_sysrq(port, ch)) | |
506 | return 1; | |
507 | } | |
508 | port->sysrq = 0; | |
509 | ||
510 | return 0; | |
511 | } | |
512 | ||
75f4e830 | 513 | static inline void uart_unlock_and_check_sysrq(struct uart_port *port) |
08d54703 JH |
514 | { |
515 | int sysrq_ch; | |
516 | ||
517 | if (!port->has_sysrq) { | |
75f4e830 | 518 | spin_unlock(&port->lock); |
08d54703 JH |
519 | return; |
520 | } | |
521 | ||
522 | sysrq_ch = port->sysrq_ch; | |
523 | port->sysrq_ch = 0; | |
524 | ||
75f4e830 | 525 | spin_unlock(&port->lock); |
08d54703 JH |
526 | |
527 | if (sysrq_ch) | |
528 | handle_sysrq(sysrq_ch); | |
529 | } | |
853a9ae2 JH |
530 | |
531 | static inline void uart_unlock_and_check_sysrq_irqrestore(struct uart_port *port, | |
532 | unsigned long flags) | |
533 | { | |
534 | int sysrq_ch; | |
535 | ||
536 | if (!port->has_sysrq) { | |
537 | spin_unlock_irqrestore(&port->lock, flags); | |
538 | return; | |
539 | } | |
540 | ||
541 | sysrq_ch = port->sysrq_ch; | |
542 | port->sysrq_ch = 0; | |
543 | ||
544 | spin_unlock_irqrestore(&port->lock, flags); | |
545 | ||
546 | if (sysrq_ch) | |
547 | handle_sysrq(sysrq_ch); | |
548 | } | |
08d54703 JH |
549 | #else /* CONFIG_MAGIC_SYSRQ_SERIAL */ |
550 | static inline int uart_handle_sysrq_char(struct uart_port *port, unsigned int ch) | |
551 | { | |
552 | return 0; | |
553 | } | |
554 | static inline int uart_prepare_sysrq_char(struct uart_port *port, unsigned int ch) | |
555 | { | |
556 | return 0; | |
557 | } | |
75f4e830 | 558 | static inline void uart_unlock_and_check_sysrq(struct uart_port *port) |
08d54703 | 559 | { |
75f4e830 | 560 | spin_unlock(&port->lock); |
08d54703 | 561 | } |
853a9ae2 JH |
562 | static inline void uart_unlock_and_check_sysrq_irqrestore(struct uart_port *port, |
563 | unsigned long flags) | |
564 | { | |
565 | spin_unlock_irqrestore(&port->lock, flags); | |
566 | } | |
08d54703 JH |
567 | #endif /* CONFIG_MAGIC_SYSRQ_SERIAL */ |
568 | ||
569 | /* | |
570 | * We do the SysRQ and SAK checking like this... | |
571 | */ | |
572 | static inline int uart_handle_break(struct uart_port *port) | |
573 | { | |
574 | struct uart_state *state = port->state; | |
575 | ||
576 | if (port->handle_break) | |
577 | port->handle_break(port); | |
578 | ||
579 | #ifdef CONFIG_MAGIC_SYSRQ_SERIAL | |
580 | if (port->has_sysrq && uart_console(port)) { | |
581 | if (!port->sysrq) { | |
582 | port->sysrq = jiffies + SYSRQ_TIMEOUT; | |
583 | return 1; | |
584 | } | |
585 | port->sysrq = 0; | |
586 | } | |
587 | #endif | |
588 | if (port->flags & UPF_SAK) | |
589 | do_SAK(state->port.tty); | |
590 | return 0; | |
591 | } | |
1da177e4 | 592 | |
1da177e4 LT |
593 | /* |
594 | * UART_ENABLE_MS - determine if port should enable modem status irqs | |
595 | */ | |
596 | #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \ | |
597 | (cflag) & CRTSCTS || \ | |
598 | !((cflag) & CLOCAL)) | |
599 | ||
c150c0f3 | 600 | int uart_get_rs485_mode(struct uart_port *port); |
1da177e4 | 601 | #endif /* LINUX_SERIAL_CORE_H */ |