Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * linux/include/linux/serial_8250.h
3 *
4 * Copyright (C) 2004 Russell King
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 */
11#ifndef _LINUX_SERIAL_8250_H
12#define _LINUX_SERIAL_8250_H
13
14#include <linux/serial_core.h>
15#include <linux/serial_reg.h>
16#include <linux/platform_device.h>
17
18/*
19 * This is the platform device platform_data structure
20 */
21struct plat_serial8250_port {
22 unsigned long iobase; /* io base address */
23 void __iomem *membase; /* ioremap cookie or NULL */
24 resource_size_t mapbase; /* resource base */
25 unsigned int irq; /* interrupt number */
26 unsigned long irqflags; /* request_irq flags */
27 unsigned int uartclk; /* UART clock rate */
28 void *private_data;
29 unsigned char regshift; /* register shift */
30 unsigned char iotype; /* UPIO_* */
31 unsigned char hub6;
32 upf_t flags; /* UPF_* flags */
33 unsigned int type; /* If UPF_FIXED_TYPE */
34 unsigned int (*serial_in)(struct uart_port *, int);
35 void (*serial_out)(struct uart_port *, int, int);
36 void (*set_termios)(struct uart_port *,
37 struct ktermios *new,
38 struct ktermios *old);
39 unsigned int (*get_mctrl)(struct uart_port *);
40 int (*handle_irq)(struct uart_port *);
41 void (*pm)(struct uart_port *, unsigned int state,
42 unsigned old);
43 void (*handle_break)(struct uart_port *);
44};
45
46/*
47 * Allocate 8250 platform device IDs. Nothing is implied by
48 * the numbering here, except for the legacy entry being -1.
49 */
50enum {
51 PLAT8250_DEV_LEGACY = -1,
52 PLAT8250_DEV_PLATFORM,
53 PLAT8250_DEV_PLATFORM1,
54 PLAT8250_DEV_PLATFORM2,
55 PLAT8250_DEV_FOURPORT,
56 PLAT8250_DEV_ACCENT,
57 PLAT8250_DEV_BOCA,
58 PLAT8250_DEV_EXAR_ST16C554,
59 PLAT8250_DEV_HUB6,
60 PLAT8250_DEV_AU1X00,
61 PLAT8250_DEV_SM501,
62};
63
64struct uart_8250_dma;
65struct uart_8250_port;
66
67/**
68 * 8250 core driver operations
69 *
70 * @setup_irq() Setup irq handling. The universal 8250 driver links this
71 * port to the irq chain. Other drivers may @request_irq().
72 * @release_irq() Undo irq handling. The universal 8250 driver unlinks
73 * the port from the irq chain.
74 */
75struct uart_8250_ops {
76 int (*setup_irq)(struct uart_8250_port *);
77 void (*release_irq)(struct uart_8250_port *);
78};
79
80struct uart_8250_em485 {
81 struct timer_list start_tx_timer; /* "rs485 start tx" timer */
82 struct timer_list stop_tx_timer; /* "rs485 stop tx" timer */
83 struct timer_list *active_timer; /* pointer to active timer */
84};
85
86/*
87 * This should be used by drivers which want to register
88 * their own 8250 ports without registering their own
89 * platform device. Using these will make your driver
90 * dependent on the 8250 driver.
91 */
92
93struct uart_8250_port {
94 struct uart_port port;
95 struct timer_list timer; /* "no irq" timer */
96 struct list_head list; /* ports on this IRQ */
97 unsigned short capabilities; /* port capabilities */
98 unsigned short bugs; /* port bugs */
99 bool fifo_bug; /* min RX trigger if enabled */
100 unsigned int tx_loadsz; /* transmit fifo load size */
101 unsigned char acr;
102 unsigned char fcr;
103 unsigned char ier;
104 unsigned char lcr;
105 unsigned char mcr;
106 unsigned char mcr_mask; /* mask of user bits */
107 unsigned char mcr_force; /* mask of forced bits */
108 unsigned char cur_iotype; /* Running I/O type */
109 unsigned int rpm_tx_active;
110 unsigned char canary; /* non-zero during system sleep
111 * if no_console_suspend
112 */
113 unsigned char probe;
114#define UART_PROBE_RSA (1 << 0)
115
116 /*
117 * Some bits in registers are cleared on a read, so they must
118 * be saved whenever the register is read but the bits will not
119 * be immediately processed.
120 */
121#define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
122 unsigned char lsr_saved_flags;
123#define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
124 unsigned char msr_saved_flags;
125
126 struct uart_8250_dma *dma;
127 const struct uart_8250_ops *ops;
128
129 /* 8250 specific callbacks */
130 int (*dl_read)(struct uart_8250_port *);
131 void (*dl_write)(struct uart_8250_port *, int);
132
133 struct uart_8250_em485 *em485;
134};
135
136static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up)
137{
138 return container_of(up, struct uart_8250_port, port);
139}
140
141int serial8250_register_8250_port(struct uart_8250_port *);
142void serial8250_unregister_port(int line);
143void serial8250_suspend_port(int line);
144void serial8250_resume_port(int line);
145
146extern int early_serial_setup(struct uart_port *port);
147
148extern int early_serial8250_setup(struct earlycon_device *device,
149 const char *options);
150extern void serial8250_do_set_termios(struct uart_port *port,
151 struct ktermios *termios, struct ktermios *old);
152extern unsigned int serial8250_do_get_mctrl(struct uart_port *port);
153extern int serial8250_do_startup(struct uart_port *port);
154extern void serial8250_do_shutdown(struct uart_port *port);
155extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
156 unsigned int oldstate);
157extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
158extern int fsl8250_handle_irq(struct uart_port *port);
159int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
160unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
161void serial8250_tx_chars(struct uart_8250_port *up);
162unsigned int serial8250_modem_status(struct uart_8250_port *up);
163void serial8250_init_port(struct uart_8250_port *up);
164void serial8250_set_defaults(struct uart_8250_port *up);
165void serial8250_console_write(struct uart_8250_port *up, const char *s,
166 unsigned int count);
167int serial8250_console_setup(struct uart_port *port, char *options, bool probe);
168
169extern void serial8250_set_isa_configurator(void (*v)
170 (int port, struct uart_port *up,
171 unsigned short *capabilities));
172
173#endif