serial: imx: Remove unused platform data support
[linux-2.6-block.git] / include / linux / serial_8250.h
CommitLineData
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
17struct 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;
d68fefdd 28 unsigned char has_sysrq; /* supports magic SysRq */
0077d45e 29 upf_t flags; /* UPF_* flags */
8e23fcc8 30 unsigned int type; /* If UPF_FIXED_TYPE */
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,
35 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 */
49enum {
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 63struct uart_8250_dma;
a4416cd1
PH
64struct 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 */
74struct uart_8250_ops {
75 int (*setup_irq)(struct uart_8250_port *);
76 void (*release_irq)(struct uart_8250_port *);
77};
9ee4b83e 78
e490c914 79struct uart_8250_em485 {
6e0a5de2
RG
80 struct hrtimer start_tx_timer; /* "rs485 start tx" timer */
81 struct hrtimer stop_tx_timer; /* "rs485 stop tx" timer */
82 struct hrtimer *active_timer; /* pointer to active timer */
83 struct uart_8250_port *port; /* for hrtimer callbacks */
058bc104 84 unsigned int tx_stopped:1; /* tx is currently stopped */
e490c914
MK
85};
86
bc49a661
RK
87/*
88 * This should be used by drivers which want to register
89 * their own 8250 ports without registering their own
90 * platform device. Using these will make your driver
91 * dependent on the 8250 driver.
92 */
ce7240e4
AC
93
94struct uart_8250_port {
95 struct uart_port port;
96 struct timer_list timer; /* "no irq" timer */
97 struct list_head list; /* ports on this IRQ */
98838d95 98 u32 capabilities; /* port capabilities */
ce7240e4 99 unsigned short bugs; /* port bugs */
aef9a7bd 100 bool fifo_bug; /* min RX trigger if enabled */
ce7240e4
AC
101 unsigned int tx_loadsz; /* transmit fifo load size */
102 unsigned char acr;
aef9a7bd 103 unsigned char fcr;
ce7240e4
AC
104 unsigned char ier;
105 unsigned char lcr;
106 unsigned char mcr;
107 unsigned char mcr_mask; /* mask of user bits */
108 unsigned char mcr_force; /* mask of forced bits */
109 unsigned char cur_iotype; /* Running I/O type */
baeb7ef3 110 unsigned int rpm_tx_active;
4516d50a
PH
111 unsigned char canary; /* non-zero during system sleep
112 * if no_console_suspend
113 */
40375393 114 unsigned char probe;
4a96895f 115 struct mctrl_gpios *gpios;
40375393 116#define UART_PROBE_RSA (1 << 0)
ce7240e4
AC
117
118 /*
119 * Some bits in registers are cleared on a read, so they must
120 * be saved whenever the register is read but the bits will not
121 * be immediately processed.
122 */
123#define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
124 unsigned char lsr_saved_flags;
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
144static 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
f73fa05b 149int serial8250_register_8250_port(struct uart_8250_port *);
bc49a661
RK
150void serial8250_unregister_port(int line);
151void serial8250_suspend_port(int line);
152void serial8250_resume_port(int line);
153
b187f180
YL
154extern int early_serial_setup(struct uart_port *port);
155
1c5841e8
EH
156extern int early_serial8250_setup(struct earlycon_device *device,
157 const char *options);
868f3ee6
SS
158extern void serial8250_update_uartclk(struct uart_port *port,
159 unsigned int uartclk);
235dae5d
PL
160extern void serial8250_do_set_termios(struct uart_port *port,
161 struct ktermios *termios, struct ktermios *old);
db405a8f
EB
162extern void serial8250_do_set_ldisc(struct uart_port *port,
163 struct ktermios *termios);
144ef5c2 164extern unsigned int serial8250_do_get_mctrl(struct uart_port *port);
b99b121b
SAS
165extern int serial8250_do_startup(struct uart_port *port);
166extern void serial8250_do_shutdown(struct uart_port *port);
c161afe9
ML
167extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
168 unsigned int oldstate);
4bf4ea9d 169extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
6226e5f3
JZ
170extern void serial8250_do_set_divisor(struct uart_port *port, unsigned int baud,
171 unsigned int quot,
172 unsigned int quot_frac);
9deaa53a 173extern int fsl8250_handle_irq(struct uart_port *port);
583d28e9 174int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
3986fb2b 175unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
ebbaf9ab 176void serial8250_read_char(struct uart_8250_port *up, unsigned char lsr);
3986fb2b
PG
177void serial8250_tx_chars(struct uart_8250_port *up);
178unsigned int serial8250_modem_status(struct uart_8250_port *up);
b6830f6d
PH
179void serial8250_init_port(struct uart_8250_port *up);
180void serial8250_set_defaults(struct uart_8250_port *up);
181void serial8250_console_write(struct uart_8250_port *up, const char *s,
182 unsigned int count);
183int serial8250_console_setup(struct uart_port *port, char *options, bool probe);
bedb404e 184int serial8250_console_exit(struct uart_port *port);
18a8bd94 185
af7f3743
AC
186extern void serial8250_set_isa_configurator(void (*v)
187 (int port, struct uart_port *up,
98838d95 188 u32 *capabilities));
af7f3743 189
1da177e4 190#endif