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 */ |
85bce38a | 21 | unsigned int uartclk; /* UART clock rate */ |
1da177e4 | 22 | unsigned int irq; /* interrupt number */ |
1c2f0493 | 23 | unsigned long irqflags; /* request_irq flags */ |
74a19741 | 24 | void *private_data; |
1da177e4 LT |
25 | unsigned char regshift; /* register shift */ |
26 | unsigned char iotype; /* UPIO_* */ | |
ec9f47cd | 27 | unsigned char hub6; |
d68fefdd | 28 | unsigned char has_sysrq; /* supports magic SysRq */ |
8e23fcc8 | 29 | unsigned int type; /* If UPF_FIXED_TYPE */ |
85bce38a | 30 | upf_t flags; /* UPF_* flags */ |
7d6a07d1 DD |
31 | unsigned int (*serial_in)(struct uart_port *, int); |
32 | void (*serial_out)(struct uart_port *, int, int); | |
235dae5d PL |
33 | void (*set_termios)(struct uart_port *, |
34 | struct ktermios *new, | |
bec5b814 | 35 | const struct ktermios *old); |
db405a8f EB |
36 | void (*set_ldisc)(struct uart_port *, |
37 | struct ktermios *); | |
144ef5c2 | 38 | unsigned int (*get_mctrl)(struct uart_port *); |
583d28e9 | 39 | int (*handle_irq)(struct uart_port *); |
c161afe9 ML |
40 | void (*pm)(struct uart_port *, unsigned int state, |
41 | unsigned old); | |
bf03f65b | 42 | void (*handle_break)(struct uart_port *); |
1da177e4 LT |
43 | }; |
44 | ||
6df29deb RK |
45 | /* |
46 | * Allocate 8250 platform device IDs. Nothing is implied by | |
47 | * the numbering here, except for the legacy entry being -1. | |
48 | */ | |
49 | enum { | |
50 | PLAT8250_DEV_LEGACY = -1, | |
51 | PLAT8250_DEV_PLATFORM, | |
52 | PLAT8250_DEV_PLATFORM1, | |
104c7b03 | 53 | PLAT8250_DEV_PLATFORM2, |
6df29deb RK |
54 | PLAT8250_DEV_FOURPORT, |
55 | PLAT8250_DEV_ACCENT, | |
56 | PLAT8250_DEV_BOCA, | |
e0980daf | 57 | PLAT8250_DEV_EXAR_ST16C554, |
6df29deb | 58 | PLAT8250_DEV_HUB6, |
21c614a7 | 59 | PLAT8250_DEV_AU1X00, |
61711f8f | 60 | PLAT8250_DEV_SM501, |
6df29deb RK |
61 | }; |
62 | ||
9ee4b83e | 63 | struct uart_8250_dma; |
a4416cd1 PH |
64 | struct uart_8250_port; |
65 | ||
66 | /** | |
67 | * 8250 core driver operations | |
68 | * | |
69 | * @setup_irq() Setup irq handling. The universal 8250 driver links this | |
70 | * port to the irq chain. Other drivers may @request_irq(). | |
71 | * @release_irq() Undo irq handling. The universal 8250 driver unlinks | |
72 | * the port from the irq chain. | |
73 | */ | |
74 | struct uart_8250_ops { | |
75 | int (*setup_irq)(struct uart_8250_port *); | |
76 | void (*release_irq)(struct uart_8250_port *); | |
039d4926 | 77 | void (*setup_timer)(struct uart_8250_port *); |
a4416cd1 | 78 | }; |
9ee4b83e | 79 | |
e490c914 | 80 | struct uart_8250_em485 { |
6e0a5de2 RG |
81 | struct hrtimer start_tx_timer; /* "rs485 start tx" timer */ |
82 | struct hrtimer stop_tx_timer; /* "rs485 stop tx" timer */ | |
83 | struct hrtimer *active_timer; /* pointer to active timer */ | |
84 | struct uart_8250_port *port; /* for hrtimer callbacks */ | |
058bc104 | 85 | unsigned int tx_stopped:1; /* tx is currently stopped */ |
e490c914 MK |
86 | }; |
87 | ||
bc49a661 RK |
88 | /* |
89 | * This should be used by drivers which want to register | |
90 | * their own 8250 ports without registering their own | |
91 | * platform device. Using these will make your driver | |
92 | * dependent on the 8250 driver. | |
93 | */ | |
ce7240e4 AC |
94 | |
95 | struct uart_8250_port { | |
96 | struct uart_port port; | |
97 | struct timer_list timer; /* "no irq" timer */ | |
98 | struct list_head list; /* ports on this IRQ */ | |
98838d95 | 99 | u32 capabilities; /* port capabilities */ |
ce7240e4 | 100 | unsigned short bugs; /* port bugs */ |
aef9a7bd | 101 | bool fifo_bug; /* min RX trigger if enabled */ |
ce7240e4 AC |
102 | unsigned int tx_loadsz; /* transmit fifo load size */ |
103 | unsigned char acr; | |
aef9a7bd | 104 | unsigned char fcr; |
ce7240e4 AC |
105 | unsigned char ier; |
106 | unsigned char lcr; | |
107 | unsigned char mcr; | |
ce7240e4 | 108 | unsigned char cur_iotype; /* Running I/O type */ |
baeb7ef3 | 109 | unsigned int rpm_tx_active; |
4516d50a PH |
110 | unsigned char canary; /* non-zero during system sleep |
111 | * if no_console_suspend | |
112 | */ | |
40375393 | 113 | unsigned char probe; |
4a96895f | 114 | struct mctrl_gpios *gpios; |
40375393 | 115 | #define UART_PROBE_RSA (1 << 0) |
ce7240e4 AC |
116 | |
117 | /* | |
118 | * Some bits in registers are cleared on a read, so they must | |
119 | * be saved whenever the register is read but the bits will not | |
120 | * be immediately processed. | |
121 | */ | |
122 | #define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS | |
f8ba5680 | 123 | u16 lsr_saved_flags; |
507bd6fb | 124 | u16 lsr_save_mask; |
ce7240e4 AC |
125 | #define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA |
126 | unsigned char msr_saved_flags; | |
127 | ||
9ee4b83e | 128 | struct uart_8250_dma *dma; |
a4416cd1 | 129 | const struct uart_8250_ops *ops; |
9ee4b83e | 130 | |
ce7240e4 AC |
131 | /* 8250 specific callbacks */ |
132 | int (*dl_read)(struct uart_8250_port *); | |
133 | void (*dl_write)(struct uart_8250_port *, int); | |
e490c914 MK |
134 | |
135 | struct uart_8250_em485 *em485; | |
058bc104 LW |
136 | void (*rs485_start_tx)(struct uart_8250_port *); |
137 | void (*rs485_stop_tx)(struct uart_8250_port *); | |
6d7f677a DD |
138 | |
139 | /* Serial port overrun backoff */ | |
140 | struct delayed_work overrun_backoff; | |
141 | u32 overrun_backoff_time_ms; | |
ce7240e4 | 142 | }; |
bc49a661 | 143 | |
b1261c86 AS |
144 | static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up) |
145 | { | |
146 | return container_of(up, struct uart_8250_port, port); | |
147 | } | |
148 | ||
cd256b06 | 149 | int serial8250_register_8250_port(const struct uart_8250_port *); |
bc49a661 RK |
150 | void serial8250_unregister_port(int line); |
151 | void serial8250_suspend_port(int line); | |
152 | void serial8250_resume_port(int line); | |
153 | ||
6229ad99 IJ |
154 | int early_serial_setup(struct uart_port *port); |
155 | int early_serial8250_setup(struct earlycon_device *device, const char *options); | |
156 | ||
157 | void serial8250_update_uartclk(struct uart_port *port, unsigned int uartclk); | |
158 | void serial8250_do_set_termios(struct uart_port *port, struct ktermios *termios, | |
159 | const struct ktermios *old); | |
160 | void serial8250_do_set_ldisc(struct uart_port *port, struct ktermios *termios); | |
161 | unsigned int serial8250_do_get_mctrl(struct uart_port *port); | |
162 | int serial8250_do_startup(struct uart_port *port); | |
163 | void serial8250_do_shutdown(struct uart_port *port); | |
164 | void serial8250_do_pm(struct uart_port *port, unsigned int state, | |
165 | unsigned int oldstate); | |
166 | void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl); | |
167 | void serial8250_do_set_divisor(struct uart_port *port, unsigned int baud, | |
168 | unsigned int quot, unsigned int quot_frac); | |
169 | int fsl8250_handle_irq(struct uart_port *port); | |
583d28e9 | 170 | int serial8250_handle_irq(struct uart_port *port, unsigned int iir); |
f8ba5680 IJ |
171 | u16 serial8250_rx_chars(struct uart_8250_port *up, u16 lsr); |
172 | void serial8250_read_char(struct uart_8250_port *up, u16 lsr); | |
3986fb2b PG |
173 | void serial8250_tx_chars(struct uart_8250_port *up); |
174 | unsigned int serial8250_modem_status(struct uart_8250_port *up); | |
b6830f6d PH |
175 | void serial8250_init_port(struct uart_8250_port *up); |
176 | void serial8250_set_defaults(struct uart_8250_port *up); | |
177 | void serial8250_console_write(struct uart_8250_port *up, const char *s, | |
178 | unsigned int count); | |
179 | int serial8250_console_setup(struct uart_port *port, char *options, bool probe); | |
bedb404e | 180 | int serial8250_console_exit(struct uart_port *port); |
18a8bd94 | 181 | |
6229ad99 IJ |
182 | void serial8250_set_isa_configurator(void (*v)(int port, struct uart_port *up, |
183 | u32 *capabilities)); | |
af7f3743 | 184 | |
a609c580 LJ |
185 | #ifdef CONFIG_SERIAL_8250_RT288X |
186 | unsigned int au_serial_in(struct uart_port *p, int offset); | |
187 | void au_serial_out(struct uart_port *p, int offset, int value); | |
188 | #endif | |
189 | ||
1da177e4 | 190 | #endif |