blob: 61fbb440449ca00d9e422966257ebbe5d9cbf434 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Masahiro Yamada34d2e452015-05-26 13:28:48 +090015#include <linux/serial_reg.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010016#include <linux/platform_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Russell Kingbc49a662005-09-01 15:56:26 +010018/*
19 * This is the platform device platform_data structure
20 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070021struct plat_serial8250_port {
22 unsigned long iobase; /* io base address */
23 void __iomem *membase; /* ioremap cookie or NULL */
Josh Boyer4f640ef2007-07-23 18:43:44 -070024 resource_size_t mapbase; /* resource base */
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 unsigned int irq; /* interrupt number */
Vikram Pandita1c2f0492009-09-19 13:13:19 -070026 unsigned long irqflags; /* request_irq flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 unsigned int uartclk; /* UART clock rate */
Will Newton74a197412008-02-04 22:27:50 -080028 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 unsigned char regshift; /* register shift */
30 unsigned char iotype; /* UPIO_* */
Russell Kingec9f47c2005-06-27 11:12:54 +010031 unsigned char hub6;
Russell King0077d452006-01-21 23:03:28 +000032 upf_t flags; /* UPF_* flags */
David Daney8e23fcc2009-01-02 13:49:54 +000033 unsigned int type; /* If UPF_FIXED_TYPE */
David Daney7d6a07d2009-01-02 13:49:47 +000034 unsigned int (*serial_in)(struct uart_port *, int);
35 void (*serial_out)(struct uart_port *, int, int);
Philippe Langlais235dae52010-07-29 17:13:57 +020036 void (*set_termios)(struct uart_port *,
37 struct ktermios *new,
38 struct ktermios *old);
Ed Blakedb405a82016-11-10 18:07:55 +000039 void (*set_ldisc)(struct uart_port *,
40 struct ktermios *);
Wan Ahmad Zainie144ef5c22016-04-06 12:06:51 +080041 unsigned int (*get_mctrl)(struct uart_port *);
Jamie Iles583d28e2011-08-15 10:17:52 +010042 int (*handle_irq)(struct uart_port *);
Manuel Laussc161afe2010-09-25 15:13:45 +020043 void (*pm)(struct uart_port *, unsigned int state,
44 unsigned old);
Dan Williamsbf03f652012-04-10 14:10:53 -070045 void (*handle_break)(struct uart_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046};
47
Russell Kingbc49a662005-09-01 15:56:26 +010048/*
Russell King6df29de2005-09-08 16:04:41 +010049 * Allocate 8250 platform device IDs. Nothing is implied by
50 * the numbering here, except for the legacy entry being -1.
51 */
52enum {
53 PLAT8250_DEV_LEGACY = -1,
54 PLAT8250_DEV_PLATFORM,
55 PLAT8250_DEV_PLATFORM1,
Lennert Buytenhek104c7b032006-03-25 23:03:13 +000056 PLAT8250_DEV_PLATFORM2,
Russell King6df29de2005-09-08 16:04:41 +010057 PLAT8250_DEV_FOURPORT,
58 PLAT8250_DEV_ACCENT,
59 PLAT8250_DEV_BOCA,
Paul B Schroedere0980da2006-12-06 20:37:03 -080060 PLAT8250_DEV_EXAR_ST16C554,
Russell King6df29de2005-09-08 16:04:41 +010061 PLAT8250_DEV_HUB6,
Pantelis Antoniou21c614a2005-11-06 09:07:03 +000062 PLAT8250_DEV_AU1X00,
Magnus Damm61711f82008-04-28 02:14:22 -070063 PLAT8250_DEV_SM501,
Russell King6df29de2005-09-08 16:04:41 +010064};
65
Heikki Krogerus9ee4b832013-01-10 11:25:11 +020066struct uart_8250_dma;
Peter Hurleya4416cd2015-02-24 14:25:07 -050067struct uart_8250_port;
68
69/**
70 * 8250 core driver operations
71 *
72 * @setup_irq() Setup irq handling. The universal 8250 driver links this
73 * port to the irq chain. Other drivers may @request_irq().
74 * @release_irq() Undo irq handling. The universal 8250 driver unlinks
75 * the port from the irq chain.
76 */
77struct uart_8250_ops {
78 int (*setup_irq)(struct uart_8250_port *);
79 void (*release_irq)(struct uart_8250_port *);
80};
Heikki Krogerus9ee4b832013-01-10 11:25:11 +020081
Matwey V. Kornilove490c912016-02-01 21:09:21 +030082struct uart_8250_em485 {
83 struct timer_list start_tx_timer; /* "rs485 start tx" timer */
84 struct timer_list stop_tx_timer; /* "rs485 stop tx" timer */
85 struct timer_list *active_timer; /* pointer to active timer */
86};
87
Russell King6df29de2005-09-08 16:04:41 +010088/*
Russell Kingbc49a662005-09-01 15:56:26 +010089 * 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 */
Alan Coxce7240e2012-07-17 17:06:20 +010094
95struct 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 */
Ed Blake98838d92016-11-10 18:07:54 +000099 u32 capabilities; /* port capabilities */
Alan Coxce7240e2012-07-17 17:06:20 +0100100 unsigned short bugs; /* port bugs */
Yoshihiro YUNOMAEaef9a7b2014-07-16 01:19:36 +0000101 bool fifo_bug; /* min RX trigger if enabled */
Alan Coxce7240e2012-07-17 17:06:20 +0100102 unsigned int tx_loadsz; /* transmit fifo load size */
103 unsigned char acr;
Yoshihiro YUNOMAEaef9a7b2014-07-16 01:19:36 +0000104 unsigned char fcr;
Alan Coxce7240e2012-07-17 17:06:20 +0100105 unsigned char ier;
106 unsigned char lcr;
107 unsigned char mcr;
108 unsigned char mcr_mask; /* mask of user bits */
109 unsigned char mcr_force; /* mask of forced bits */
110 unsigned char cur_iotype; /* Running I/O type */
Sebastian Andrzej Siewiorbaeb7ef2014-09-29 10:21:03 +0200111 unsigned int rpm_tx_active;
Peter Hurley4516d502015-01-22 12:24:30 -0500112 unsigned char canary; /* non-zero during system sleep
113 * if no_console_suspend
114 */
Peter Hurley40375392015-02-24 14:25:14 -0500115 unsigned char probe;
116#define UART_PROBE_RSA (1 << 0)
Alan Coxce7240e2012-07-17 17:06:20 +0100117
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
Heikki Krogerus9ee4b832013-01-10 11:25:11 +0200128 struct uart_8250_dma *dma;
Peter Hurleya4416cd2015-02-24 14:25:07 -0500129 const struct uart_8250_ops *ops;
Heikki Krogerus9ee4b832013-01-10 11:25:11 +0200130
Alan Coxce7240e2012-07-17 17:06:20 +0100131 /* 8250 specific callbacks */
132 int (*dl_read)(struct uart_8250_port *);
133 void (*dl_write)(struct uart_8250_port *, int);
Matwey V. Kornilove490c912016-02-01 21:09:21 +0300134
135 struct uart_8250_em485 *em485;
Alan Coxce7240e2012-07-17 17:06:20 +0100136};
Russell Kingbc49a662005-09-01 15:56:26 +0100137
Andy Shevchenkob1261c82014-07-14 14:26:14 +0300138static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up)
139{
140 return container_of(up, struct uart_8250_port, port);
141}
142
Magnus Dammf73fa052012-05-02 21:47:27 +0900143int serial8250_register_8250_port(struct uart_8250_port *);
Russell Kingbc49a662005-09-01 15:56:26 +0100144void serial8250_unregister_port(int line);
145void serial8250_suspend_port(int line);
146void serial8250_resume_port(int line);
147
Yinghai Lub187f182007-07-18 00:49:10 -0700148extern int early_serial_setup(struct uart_port *port);
149
Eddie Huang1c5841e2015-04-28 21:40:32 +0800150extern int early_serial8250_setup(struct earlycon_device *device,
151 const char *options);
Philippe Langlais235dae52010-07-29 17:13:57 +0200152extern void serial8250_do_set_termios(struct uart_port *port,
153 struct ktermios *termios, struct ktermios *old);
Ed Blakedb405a82016-11-10 18:07:55 +0000154extern void serial8250_do_set_ldisc(struct uart_port *port,
155 struct ktermios *termios);
Wan Ahmad Zainie144ef5c22016-04-06 12:06:51 +0800156extern unsigned int serial8250_do_get_mctrl(struct uart_port *port);
Sebastian Andrzej Siewiorb99b1212014-09-05 21:02:37 +0200157extern int serial8250_do_startup(struct uart_port *port);
158extern void serial8250_do_shutdown(struct uart_port *port);
Manuel Laussc161afe2010-09-25 15:13:45 +0200159extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
160 unsigned int oldstate);
Peter Hurley4bf4ea92014-12-30 20:28:15 -0500161extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
Paul Gortmaker9deaa532011-12-04 18:42:23 -0500162extern int fsl8250_handle_irq(struct uart_port *port);
Jamie Iles583d28e2011-08-15 10:17:52 +0100163int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
Paul Gortmaker3986fb22011-12-04 18:42:20 -0500164unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
165void serial8250_tx_chars(struct uart_8250_port *up);
166unsigned int serial8250_modem_status(struct uart_8250_port *up);
Peter Hurleyb6830f62015-06-27 09:19:00 -0400167void serial8250_init_port(struct uart_8250_port *up);
168void serial8250_set_defaults(struct uart_8250_port *up);
169void serial8250_console_write(struct uart_8250_port *up, const char *s,
170 unsigned int count);
171int serial8250_console_setup(struct uart_port *port, char *options, bool probe);
Yinghai Lu18a8bd92007-07-15 23:37:59 -0700172
Alan Coxaf7f3742010-10-18 11:38:02 -0700173extern void serial8250_set_isa_configurator(void (*v)
174 (int port, struct uart_port *up,
Ed Blake98838d92016-11-10 18:07:54 +0000175 u32 *capabilities));
Alan Coxaf7f3742010-10-18 11:38:02 -0700176
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177#endif