Commit | Line | Data |
---|---|---|
2874c5fd | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
1da177e4 LT |
2 | /* |
3 | * linux/include/linux/serial_8250.h | |
4 | * | |
5 | * Copyright (C) 2004 Russell King | |
1da177e4 LT |
6 | */ |
7 | #ifndef _LINUX_SERIAL_8250_H | |
8 | #define _LINUX_SERIAL_8250_H | |
9 | ||
10 | #include <linux/serial_core.h> | |
34d2e458 | 11 | #include <linux/serial_reg.h> |
d052d1be | 12 | #include <linux/platform_device.h> |
1da177e4 | 13 | |
bc49a661 RK |
14 | /* |
15 | * This is the platform device platform_data structure | |
16 | */ | |
1da177e4 LT |
17 | struct plat_serial8250_port { |
18 | unsigned long iobase; /* io base address */ | |
19 | void __iomem *membase; /* ioremap cookie or NULL */ | |
4f640efb | 20 | resource_size_t mapbase; /* resource base */ |
1da177e4 | 21 | unsigned int irq; /* interrupt number */ |
1c2f0493 | 22 | unsigned long irqflags; /* request_irq flags */ |
1da177e4 | 23 | unsigned int uartclk; /* UART clock rate */ |
74a19741 | 24 | void *private_data; |
1da177e4 LT |
25 | unsigned char regshift; /* register shift */ |
26 | unsigned char iotype; /* UPIO_* */ | |
ec9f47cd | 27 | unsigned char hub6; |
0077d45e | 28 | upf_t flags; /* UPF_* flags */ |
8e23fcc8 | 29 | unsigned int type; /* If UPF_FIXED_TYPE */ |
7d6a07d1 DD |
30 | unsigned int (*serial_in)(struct uart_port *, int); |
31 | void (*serial_out)(struct uart_port *, int, int); | |
235dae5d PL |
32 | void (*set_termios)(struct uart_port *, |
33 | struct ktermios *new, | |
34 | struct ktermios *old); | |
db405a8f EB |
35 | void (*set_ldisc)(struct uart_port *, |
36 | struct ktermios *); | |
144ef5c2 | 37 | unsigned int (*get_mctrl)(struct uart_port *); |
583d28e9 | 38 | int (*handle_irq)(struct uart_port *); |
c161afe9 ML |
39 | void (*pm)(struct uart_port *, unsigned int state, |
40 | unsigned old); | |
bf03f65b | 41 | void (*handle_break)(struct uart_port *); |
1da177e4 LT |
42 | }; |
43 | ||
6df29deb RK |
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, | |
104c7b03 | 52 | PLAT8250_DEV_PLATFORM2, |
6df29deb RK |
53 | PLAT8250_DEV_FOURPORT, |
54 | PLAT8250_DEV_ACCENT, | |
55 | PLAT8250_DEV_BOCA, | |
e0980daf | 56 | PLAT8250_DEV_EXAR_ST16C554, |
6df29deb | 57 | PLAT8250_DEV_HUB6, |
21c614a7 | 58 | PLAT8250_DEV_AU1X00, |
61711f8f | 59 | PLAT8250_DEV_SM501, |
6df29deb RK |
60 | }; |
61 | ||
9ee4b83e | 62 | struct uart_8250_dma; |
a4416cd1 PH |
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 | }; | |
9ee4b83e | 77 | |
e490c914 | 78 | struct uart_8250_em485 { |
6e0a5de2 RG |
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 */ | |
e490c914 MK |
83 | }; |
84 | ||
bc49a661 RK |
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 | */ | |
ce7240e4 AC |
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 */ | |
98838d95 | 96 | u32 capabilities; /* port capabilities */ |
ce7240e4 | 97 | unsigned short bugs; /* port bugs */ |
aef9a7bd | 98 | bool fifo_bug; /* min RX trigger if enabled */ |
ce7240e4 AC |
99 | unsigned int tx_loadsz; /* transmit fifo load size */ |
100 | unsigned char acr; | |
aef9a7bd | 101 | unsigned char fcr; |
ce7240e4 AC |
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 */ | |
baeb7ef3 | 108 | unsigned int rpm_tx_active; |
4516d50a PH |
109 | unsigned char canary; /* non-zero during system sleep |
110 | * if no_console_suspend | |
111 | */ | |
40375393 PH |
112 | unsigned char probe; |
113 | #define UART_PROBE_RSA (1 << 0) | |
ce7240e4 AC |
114 | |
115 | /* | |
116 | * Some bits in registers are cleared on a read, so they must | |
117 | * be saved whenever the register is read but the bits will not | |
118 | * be immediately processed. | |
119 | */ | |
120 | #define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS | |
121 | unsigned char lsr_saved_flags; | |
122 | #define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA | |
123 | unsigned char msr_saved_flags; | |
124 | ||
9ee4b83e | 125 | struct uart_8250_dma *dma; |
a4416cd1 | 126 | const struct uart_8250_ops *ops; |
9ee4b83e | 127 | |
ce7240e4 AC |
128 | /* 8250 specific callbacks */ |
129 | int (*dl_read)(struct uart_8250_port *); | |
130 | void (*dl_write)(struct uart_8250_port *, int); | |
e490c914 MK |
131 | |
132 | struct uart_8250_em485 *em485; | |
6d7f677a DD |
133 | |
134 | /* Serial port overrun backoff */ | |
135 | struct delayed_work overrun_backoff; | |
136 | u32 overrun_backoff_time_ms; | |
ce7240e4 | 137 | }; |
bc49a661 | 138 | |
b1261c86 AS |
139 | static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up) |
140 | { | |
141 | return container_of(up, struct uart_8250_port, port); | |
142 | } | |
143 | ||
f73fa05b | 144 | int serial8250_register_8250_port(struct uart_8250_port *); |
bc49a661 RK |
145 | void serial8250_unregister_port(int line); |
146 | void serial8250_suspend_port(int line); | |
147 | void serial8250_resume_port(int line); | |
148 | ||
b187f180 YL |
149 | extern int early_serial_setup(struct uart_port *port); |
150 | ||
1c5841e8 EH |
151 | extern int early_serial8250_setup(struct earlycon_device *device, |
152 | const char *options); | |
235dae5d PL |
153 | extern void serial8250_do_set_termios(struct uart_port *port, |
154 | struct ktermios *termios, struct ktermios *old); | |
db405a8f EB |
155 | extern void serial8250_do_set_ldisc(struct uart_port *port, |
156 | struct ktermios *termios); | |
144ef5c2 | 157 | extern unsigned int serial8250_do_get_mctrl(struct uart_port *port); |
b99b121b SAS |
158 | extern int serial8250_do_startup(struct uart_port *port); |
159 | extern void serial8250_do_shutdown(struct uart_port *port); | |
c161afe9 ML |
160 | extern void serial8250_do_pm(struct uart_port *port, unsigned int state, |
161 | unsigned int oldstate); | |
4bf4ea9d | 162 | extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl); |
6226e5f3 JZ |
163 | extern void serial8250_do_set_divisor(struct uart_port *port, unsigned int baud, |
164 | unsigned int quot, | |
165 | unsigned int quot_frac); | |
9deaa53a | 166 | extern int fsl8250_handle_irq(struct uart_port *port); |
583d28e9 | 167 | int serial8250_handle_irq(struct uart_port *port, unsigned int iir); |
3986fb2b | 168 | unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr); |
ebbaf9ab | 169 | void serial8250_read_char(struct uart_8250_port *up, unsigned char lsr); |
3986fb2b PG |
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) |
179 | (int port, struct uart_port *up, | |
98838d95 | 180 | u32 *capabilities)); |
af7f3743 | 181 | |
1da177e4 | 182 | #endif |