1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20#ifndef LINUX_SERIAL_CORE_H
21#define LINUX_SERIAL_CORE_H
22
23
24#include <linux/compiler.h>
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>
30#include <linux/mutex.h>
31#include <linux/sysrq.h>
32#include <uapi/linux/serial_core.h>
33
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) ({ (void)port; 0; })
39#endif
40
41struct uart_port;
42struct serial_struct;
43struct device;
44
45
46
47
48
49struct 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 *);
53 void (*stop_tx)(struct uart_port *);
54 void (*start_tx)(struct uart_port *);
55 void (*throttle)(struct uart_port *);
56 void (*unthrottle)(struct uart_port *);
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 *);
63 void (*flush_buffer)(struct uart_port *);
64 void (*set_termios)(struct uart_port *, struct ktermios *new,
65 struct ktermios *old);
66 void (*set_ldisc)(struct uart_port *, struct ktermios *);
67 void (*pm)(struct uart_port *, unsigned int state,
68 unsigned int oldstate);
69
70
71
72
73 const char *(*type)(struct uart_port *);
74
75
76
77
78
79 void (*release_port)(struct uart_port *);
80
81
82
83
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);
89#ifdef CONFIG_CONSOLE_POLL
90 int (*poll_init)(struct uart_port *);
91 void (*poll_put_char)(struct uart_port *, unsigned char);
92 int (*poll_get_char)(struct uart_port *);
93#endif
94};
95
96#define NO_POLL_CHAR 0x00ff0000
97#define UART_CONFIG_TYPE (1 << 0)
98#define UART_CONFIG_IRQ (1 << 1)
99
100struct 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
114typedef unsigned int __bitwise__ upf_t;
115typedef unsigned int __bitwise__ upstat_t;
116
117struct uart_port {
118 spinlock_t lock;
119 unsigned long iobase;
120 unsigned char __iomem *membase;
121 unsigned int (*serial_in)(struct uart_port *, int);
122 void (*serial_out)(struct uart_port *, int, int);
123 void (*set_termios)(struct uart_port *,
124 struct ktermios *new,
125 struct ktermios *old);
126 unsigned int (*get_mctrl)(struct uart_port *);
127 void (*set_mctrl)(struct uart_port *, unsigned int);
128 int (*startup)(struct uart_port *port);
129 void (*shutdown)(struct uart_port *port);
130 void (*throttle)(struct uart_port *port);
131 void (*unthrottle)(struct uart_port *port);
132 int (*handle_irq)(struct uart_port *);
133 void (*pm)(struct uart_port *, unsigned int state,
134 unsigned int old);
135 void (*handle_break)(struct uart_port *);
136 int (*rs485_config)(struct uart_port *,
137 struct serial_rs485 *rs485);
138 unsigned int irq;
139 unsigned long irqflags;
140 unsigned int uartclk;
141 unsigned int fifosize;
142 unsigned char x_char;
143 unsigned char regshift;
144 unsigned char iotype;
145 unsigned char unused1;
146
147#define UPIO_PORT (SERIAL_IO_PORT)
148#define UPIO_HUB6 (SERIAL_IO_HUB6)
149#define UPIO_MEM (SERIAL_IO_MEM)
150#define UPIO_MEM32 (SERIAL_IO_MEM32)
151#define UPIO_AU (SERIAL_IO_AU)
152#define UPIO_TSI (SERIAL_IO_TSI)
153#define UPIO_MEM32BE (SERIAL_IO_MEM32BE)
154#define UPIO_MEM16 (SERIAL_IO_MEM16)
155
156 unsigned int read_status_mask;
157 unsigned int ignore_status_mask;
158 struct uart_state *state;
159 struct uart_icount icount;
160
161 struct console *cons;
162#if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
163 unsigned long sysrq;
164#endif
165
166
167 upf_t flags;
168
169
170
171
172
173
174
175
176
177
178
179
180#define UPF_FOURPORT ((__force upf_t) ASYNC_FOURPORT )
181#define UPF_SAK ((__force upf_t) ASYNC_SAK )
182#define UPF_SPD_HI ((__force upf_t) ASYNC_SPD_HI )
183#define UPF_SPD_VHI ((__force upf_t) ASYNC_SPD_VHI )
184#define UPF_SPD_CUST ((__force upf_t) ASYNC_SPD_CUST )
185#define UPF_SPD_WARP ((__force upf_t) ASYNC_SPD_WARP )
186#define UPF_SPD_MASK ((__force upf_t) ASYNC_SPD_MASK )
187#define UPF_SKIP_TEST ((__force upf_t) ASYNC_SKIP_TEST )
188#define UPF_AUTO_IRQ ((__force upf_t) ASYNC_AUTO_IRQ )
189#define UPF_HARDPPS_CD ((__force upf_t) ASYNC_HARDPPS_CD )
190#define UPF_SPD_SHI ((__force upf_t) ASYNC_SPD_SHI )
191#define UPF_LOW_LATENCY ((__force upf_t) ASYNC_LOW_LATENCY )
192#define UPF_BUGGY_UART ((__force upf_t) ASYNC_BUGGY_UART )
193#define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15))
194#define UPF_MAGIC_MULTIPLIER ((__force upf_t) ASYNC_MAGIC_MULTIPLIER )
195
196
197#define UPF_AUTO_CTS ((__force upf_t) (1 << 20))
198#define UPF_AUTO_RTS ((__force upf_t) (1 << 21))
199#define UPF_HARD_FLOW ((__force upf_t) (UPF_AUTO_CTS | UPF_AUTO_RTS))
200
201#define UPF_SOFT_FLOW ((__force upf_t) (1 << 22))
202#define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
203#define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
204#define UPF_EXAR_EFR ((__force upf_t) (1 << 25))
205#define UPF_BUG_THRE ((__force upf_t) (1 << 26))
206
207#define UPF_FIXED_TYPE ((__force upf_t) (1 << 27))
208#define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
209#define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
210#define UPF_DEAD ((__force upf_t) (1 << 30))
211#define UPF_IOREMAP ((__force upf_t) (1 << 31))
212
213#define __UPF_CHANGE_MASK 0x17fff
214#define UPF_CHANGE_MASK ((__force upf_t) __UPF_CHANGE_MASK)
215#define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
216
217#if __UPF_CHANGE_MASK > ASYNC_FLAGS
218#error Change mask not equivalent to userspace-visible bit defines
219#endif
220
221
222
223
224
225 upstat_t status;
226
227#define UPSTAT_CTS_ENABLE ((__force upstat_t) (1 << 0))
228#define UPSTAT_DCD_ENABLE ((__force upstat_t) (1 << 1))
229#define UPSTAT_AUTORTS ((__force upstat_t) (1 << 2))
230#define UPSTAT_AUTOCTS ((__force upstat_t) (1 << 3))
231#define UPSTAT_AUTOXOFF ((__force upstat_t) (1 << 4))
232
233 int hw_stopped;
234 unsigned int mctrl;
235 unsigned int timeout;
236 unsigned int type;
237 const struct uart_ops *ops;
238 unsigned int custom_divisor;
239 unsigned int line;
240 unsigned int minor;
241 resource_size_t mapbase;
242 resource_size_t mapsize;
243 struct device *dev;
244 unsigned char hub6;
245 unsigned char suspended;
246 unsigned char irq_wake;
247 unsigned char unused[2];
248 struct attribute_group *attr_group;
249 const struct attribute_group **tty_groups;
250 struct serial_rs485 rs485;
251 void *private_data;
252};
253
254static inline int serial_port_in(struct uart_port *up, int offset)
255{
256 return up->serial_in(up, offset);
257}
258
259static inline void serial_port_out(struct uart_port *up, int offset, int value)
260{
261 up->serial_out(up, offset, value);
262}
263
264
265
266
267
268
269
270enum uart_pm_state {
271 UART_PM_STATE_ON = 0,
272 UART_PM_STATE_OFF = 3,
273 UART_PM_STATE_UNDEFINED,
274};
275
276
277
278
279struct uart_state {
280 struct tty_port port;
281
282 enum uart_pm_state pm_state;
283 struct circ_buf xmit;
284
285 atomic_t refcount;
286 wait_queue_head_t remove_wait;
287 struct uart_port *uart_port;
288};
289
290#define UART_XMIT_SIZE PAGE_SIZE
291
292
293
294#define WAKEUP_CHARS 256
295
296struct module;
297struct tty_driver;
298
299struct uart_driver {
300 struct module *owner;
301 const char *driver_name;
302 const char *dev_name;
303 int major;
304 int minor;
305 int nr;
306 struct console *cons;
307
308
309
310
311
312 struct uart_state *state;
313 struct tty_driver *tty_driver;
314};
315
316void uart_write_wakeup(struct uart_port *port);
317
318
319
320
321void uart_update_timeout(struct uart_port *port, unsigned int cflag,
322 unsigned int baud);
323unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
324 struct ktermios *old, unsigned int min,
325 unsigned int max);
326unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
327
328
329static inline int uart_poll_timeout(struct uart_port *port)
330{
331 int timeout = port->timeout;
332
333 return timeout > 6 ? (timeout / 2 - 2) : 1;
334}
335
336
337
338
339struct earlycon_device {
340 struct console *con;
341 struct uart_port port;
342 char options[16];
343 unsigned int baud;
344};
345
346struct earlycon_id {
347 char name[16];
348 char compatible[128];
349 int (*setup)(struct earlycon_device *, const char *options);
350} __aligned(32);
351
352extern const struct earlycon_id __earlycon_table[];
353extern const struct earlycon_id __earlycon_table_end[];
354
355#if defined(CONFIG_SERIAL_EARLYCON) && !defined(MODULE)
356#define EARLYCON_USED_OR_UNUSED __used
357#else
358#define EARLYCON_USED_OR_UNUSED __maybe_unused
359#endif
360
361#define OF_EARLYCON_DECLARE(_name, compat, fn) \
362 static const struct earlycon_id __UNIQUE_ID(__earlycon_##_name) \
363 EARLYCON_USED_OR_UNUSED __section(__earlycon_table) \
364 = { .name = __stringify(_name), \
365 .compatible = compat, \
366 .setup = fn }
367
368#define EARLYCON_DECLARE(_name, fn) OF_EARLYCON_DECLARE(_name, "", fn)
369
370extern int setup_earlycon(char *buf);
371extern int of_setup_earlycon(const struct earlycon_id *match,
372 unsigned long node,
373 const char *options);
374
375struct uart_port *uart_get_console(struct uart_port *ports, int nr,
376 struct console *c);
377int uart_parse_earlycon(char *p, unsigned char *iotype, unsigned long *addr,
378 char **options);
379void uart_parse_options(char *options, int *baud, int *parity, int *bits,
380 int *flow);
381int uart_set_options(struct uart_port *port, struct console *co, int baud,
382 int parity, int bits, int flow);
383struct tty_driver *uart_console_device(struct console *co, int *index);
384void uart_console_write(struct uart_port *port, const char *s,
385 unsigned int count,
386 void (*putchar)(struct uart_port *, int));
387
388
389
390
391int uart_register_driver(struct uart_driver *uart);
392void uart_unregister_driver(struct uart_driver *uart);
393int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
394int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
395int uart_match_port(struct uart_port *port1, struct uart_port *port2);
396
397
398
399
400int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
401int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
402
403#define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
404#define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
405
406#define uart_circ_chars_pending(circ) \
407 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
408
409#define uart_circ_chars_free(circ) \
410 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
411
412static inline int uart_tx_stopped(struct uart_port *port)
413{
414 struct tty_struct *tty = port->state->port.tty;
415 if (tty->stopped || port->hw_stopped)
416 return 1;
417 return 0;
418}
419
420static inline bool uart_cts_enabled(struct uart_port *uport)
421{
422 return !!(uport->status & UPSTAT_CTS_ENABLE);
423}
424
425static inline bool uart_softcts_mode(struct uart_port *uport)
426{
427 upstat_t mask = UPSTAT_CTS_ENABLE | UPSTAT_AUTOCTS;
428
429 return ((uport->status & mask) == UPSTAT_CTS_ENABLE);
430}
431
432
433
434
435
436extern void uart_handle_dcd_change(struct uart_port *uport,
437 unsigned int status);
438extern void uart_handle_cts_change(struct uart_port *uport,
439 unsigned int status);
440
441extern void uart_insert_char(struct uart_port *port, unsigned int status,
442 unsigned int overrun, unsigned int ch, unsigned int flag);
443
444#ifdef SUPPORT_SYSRQ
445static inline int
446uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
447{
448 if (port->sysrq) {
449 if (ch && time_before(jiffies, port->sysrq)) {
450 handle_sysrq(ch);
451 port->sysrq = 0;
452 return 1;
453 }
454 port->sysrq = 0;
455 }
456 return 0;
457}
458#else
459#define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
460#endif
461
462
463
464
465static inline int uart_handle_break(struct uart_port *port)
466{
467 struct uart_state *state = port->state;
468
469 if (port->handle_break)
470 port->handle_break(port);
471
472#ifdef SUPPORT_SYSRQ
473 if (port->cons && port->cons->index == port->line) {
474 if (!port->sysrq) {
475 port->sysrq = jiffies + HZ*5;
476 return 1;
477 }
478 port->sysrq = 0;
479 }
480#endif
481 if (port->flags & UPF_SAK)
482 do_SAK(state->port.tty);
483 return 0;
484}
485
486
487
488
489#define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
490 (cflag) & CRTSCTS || \
491 !((cflag) & CLOCAL))
492
493#endif
494