blob: 5bbb809ee1978289ac384bae2418e229edc07d37 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/char/serial_core.h
3 *
4 * Copyright (C) 2000 Deep Blue Solutions Ltd.
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 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20#ifndef LINUX_SERIAL_CORE_H
21#define LINUX_SERIAL_CORE_H
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Russell King661f83a2005-07-16 09:30:53 +010024#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/interrupt.h>
26#include <linux/circ_buf.h>
27#include <linux/spinlock.h>
28#include <linux/sched.h>
29#include <linux/tty.h>
Ingo Molnare2862f62006-01-13 21:37:07 +000030#include <linux/mutex.h>
Maciej W. Rozyckib11115c2007-06-01 00:47:07 -070031#include <linux/sysrq.h>
David Howells607ca462012-10-13 10:46:48 +010032#include <uapi/linux/serial_core.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Sourav Poddarcf0ebee02013-05-15 21:05:37 +053034#ifdef CONFIG_SERIAL_CORE_CONSOLE
35#define uart_console(port) \
36 ((port)->cons && (port)->cons->index == (port)->line)
37#else
38#define uart_console(port) (0)
39#endif
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041struct uart_port;
Linus Torvalds1da177e2005-04-16 15:20:36 -070042struct serial_struct;
43struct device;
44
45/*
Kevin Cernekeee759d7c2012-12-26 20:43:42 -080046 * This structure describes all the operations that can be done on the
47 * physical hardware. See Documentation/serial/driver for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 */
49struct uart_ops {
50 unsigned int (*tx_empty)(struct uart_port *);
51 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
52 unsigned int (*get_mctrl)(struct uart_port *);
Russell Kingb129a8c2005-08-31 10:12:14 +010053 void (*stop_tx)(struct uart_port *);
54 void (*start_tx)(struct uart_port *);
Russell King9aba8d5b2012-04-17 17:23:14 +010055 void (*throttle)(struct uart_port *);
56 void (*unthrottle)(struct uart_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 void (*send_xchar)(struct uart_port *, char ch);
58 void (*stop_rx)(struct uart_port *);
59 void (*enable_ms)(struct uart_port *);
60 void (*break_ctl)(struct uart_port *, int ctl);
61 int (*startup)(struct uart_port *);
62 void (*shutdown)(struct uart_port *);
Haavard Skinnemoen6bb0e3a2008-07-16 21:52:36 +010063 void (*flush_buffer)(struct uart_port *);
Alan Cox606d0992006-12-08 02:38:45 -080064 void (*set_termios)(struct uart_port *, struct ktermios *new,
65 struct ktermios *old);
Alan Coxd87d9b72010-06-01 22:52:53 +020066 void (*set_ldisc)(struct uart_port *, int new);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 void (*pm)(struct uart_port *, unsigned int state,
68 unsigned int oldstate);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 /*
71 * Return a string describing the type of the port
72 */
Kevin Cernekeee759d7c2012-12-26 20:43:42 -080073 const char *(*type)(struct uart_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75 /*
76 * Release IO and memory resources used by the port.
77 * This includes iounmap if necessary.
78 */
79 void (*release_port)(struct uart_port *);
80
81 /*
82 * Request IO and memory resources used by the port.
83 * This includes iomapping the port if necessary.
84 */
85 int (*request_port)(struct uart_port *);
86 void (*config_port)(struct uart_port *, int);
87 int (*verify_port)(struct uart_port *, struct serial_struct *);
88 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
Jason Wesself2d937f2008-04-17 20:05:37 +020089#ifdef CONFIG_CONSOLE_POLL
Anton Vorontsovc7f3e702012-09-24 14:27:53 -070090 int (*poll_init)(struct uart_port *);
Kevin Cernekeee759d7c2012-12-26 20:43:42 -080091 void (*poll_put_char)(struct uart_port *, unsigned char);
Jason Wesself2d937f2008-04-17 20:05:37 +020092 int (*poll_get_char)(struct uart_port *);
93#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070094};
95
Jason Wesself5316b42010-05-20 21:04:22 -050096#define NO_POLL_CHAR 0x00ff0000
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#define UART_CONFIG_TYPE (1 << 0)
98#define UART_CONFIG_IRQ (1 << 1)
99
100struct uart_icount {
101 __u32 cts;
102 __u32 dsr;
103 __u32 rng;
104 __u32 dcd;
105 __u32 rx;
106 __u32 tx;
107 __u32 frame;
108 __u32 overrun;
109 __u32 parity;
110 __u32 brk;
111 __u32 buf_overrun;
112};
113
Russell King0077d452006-01-21 23:03:28 +0000114typedef unsigned int __bitwise__ upf_t;
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116struct uart_port {
117 spinlock_t lock; /* port lock */
David Miller0c8946d2008-10-13 10:35:23 +0100118 unsigned long iobase; /* in/out[bwl] */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 unsigned char __iomem *membase; /* read/write[bwl] */
David Daney7d6a07d2009-01-02 13:49:47 +0000120 unsigned int (*serial_in)(struct uart_port *, int);
121 void (*serial_out)(struct uart_port *, int, int);
Philippe Langlais235dae52010-07-29 17:13:57 +0200122 void (*set_termios)(struct uart_port *,
123 struct ktermios *new,
124 struct ktermios *old);
Jamie Ilesa74036f2011-08-15 10:17:51 +0100125 int (*handle_irq)(struct uart_port *);
Manuel Laussc161afe2010-09-25 15:13:45 +0200126 void (*pm)(struct uart_port *, unsigned int state,
127 unsigned int old);
Dan Williamsbf03f652012-04-10 14:10:53 -0700128 void (*handle_break)(struct uart_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 unsigned int irq; /* irq number */
Vikram Pandita1c2f0492009-09-19 13:13:19 -0700130 unsigned long irqflags; /* irq flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 unsigned int uartclk; /* base uart clock */
Russell King947deee2006-07-02 20:45:51 +0100132 unsigned int fifosize; /* tx fifo size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 unsigned char x_char; /* xon/xoff char */
134 unsigned char regshift; /* reg offset shift */
135 unsigned char iotype; /* io access style */
Russell King947deee2006-07-02 20:45:51 +0100136 unsigned char unused1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138#define UPIO_PORT (0)
139#define UPIO_HUB6 (1)
140#define UPIO_MEM (2)
141#define UPIO_MEM32 (3)
John Crispinc4208112013-01-25 19:39:51 +0100142#define UPIO_AU (4) /* Au1x00 and RT288x type IO */
Zang Roy-r619113be91ec2006-06-30 02:29:58 -0700143#define UPIO_TSI (5) /* Tsi108/109 type IO */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144
145 unsigned int read_status_mask; /* driver specific */
146 unsigned int ignore_status_mask; /* driver specific */
Alan Coxebd2c8f2009-09-19 13:13:28 -0700147 struct uart_state *state; /* pointer to parent state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 struct uart_icount icount; /* statistics */
149
150 struct console *cons; /* struct console, if any */
Alexander Beregalov06e82df2009-04-06 17:34:34 +0100151#if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 unsigned long sysrq; /* sysrq timeout */
153#endif
154
Russell King0077d452006-01-21 23:03:28 +0000155 upf_t flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
Russell King0077d452006-01-21 23:03:28 +0000157#define UPF_FOURPORT ((__force upf_t) (1 << 1))
158#define UPF_SAK ((__force upf_t) (1 << 2))
159#define UPF_SPD_MASK ((__force upf_t) (0x1030))
160#define UPF_SPD_HI ((__force upf_t) (0x0010))
161#define UPF_SPD_VHI ((__force upf_t) (0x0020))
162#define UPF_SPD_CUST ((__force upf_t) (0x0030))
163#define UPF_SPD_SHI ((__force upf_t) (0x1000))
164#define UPF_SPD_WARP ((__force upf_t) (0x1010))
165#define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
166#define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
167#define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
168#define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
169#define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
Mauro Carvalho Chehabb6adea32009-02-20 15:38:52 -0800170#define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15))
Russell King0077d452006-01-21 23:03:28 +0000171#define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
Russell Kingdba05832012-04-17 16:41:10 +0100172/* Port has hardware-assisted h/w flow control (iow, auto-RTS *not* auto-CTS) */
173#define UPF_HARD_FLOW ((__force upf_t) (1 << 21))
Russell King2cbacaf2012-04-17 16:34:13 +0100174/* Port has hardware-assisted s/w flow control */
175#define UPF_SOFT_FLOW ((__force upf_t) (1 << 22))
Russell King0077d452006-01-21 23:03:28 +0000176#define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
177#define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
Søren Holm06315342011-09-02 22:55:37 +0200178#define UPF_EXAR_EFR ((__force upf_t) (1 << 25))
Dan Williamsbc02d152012-04-06 11:49:50 -0700179#define UPF_BUG_THRE ((__force upf_t) (1 << 26))
David Daney8e23fcc2009-01-02 13:49:54 +0000180/* The exact UART type is known and should not be probed. */
181#define UPF_FIXED_TYPE ((__force upf_t) (1 << 27))
Russell King0077d452006-01-21 23:03:28 +0000182#define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
David Gibsonabb4a232007-05-06 14:48:49 -0700183#define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
Russell King68ac64c2006-04-30 11:13:50 +0100184#define UPF_DEAD ((__force upf_t) (1 << 30))
Russell King0077d452006-01-21 23:03:28 +0000185#define UPF_IOREMAP ((__force upf_t) (1 << 31))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Russell King0077d452006-01-21 23:03:28 +0000187#define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
188#define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190 unsigned int mctrl; /* current modem ctrl settings */
191 unsigned int timeout; /* character-based timeout */
192 unsigned int type; /* port type */
Russell Kingba899db2006-01-21 22:45:50 +0000193 const struct uart_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 unsigned int custom_divisor;
195 unsigned int line; /* port index */
Josh Boyer4f640ef2007-07-23 18:43:44 -0700196 resource_size_t mapbase; /* for ioremap */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 struct device *dev; /* parent device */
198 unsigned char hub6; /* this should be in the 8250 driver */
Guennadi Liakhovetskib3b708f2007-10-16 01:24:02 -0700199 unsigned char suspended;
Govindraj.R3f960db2010-12-16 18:12:47 +0530200 unsigned char irq_wake;
Guennadi Liakhovetskib3b708f2007-10-16 01:24:02 -0700201 unsigned char unused[2];
Marc St-Jeanbeab6972007-05-06 14:48:45 -0700202 void *private_data; /* generic platform data pointer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203};
204
Paul Gortmaker927353a2012-03-08 19:12:12 -0500205static inline int serial_port_in(struct uart_port *up, int offset)
206{
207 return up->serial_in(up, offset);
208}
209
210static inline void serial_port_out(struct uart_port *up, int offset, int value)
211{
212 up->serial_out(up, offset, value);
213}
214
Linus Walleij6f538fe2012-12-07 11:36:08 +0100215/**
216 * enum uart_pm_state - power states for UARTs
217 * @UART_PM_STATE_ON: UART is powered, up and operational
218 * @UART_PM_STATE_OFF: UART is powered off
219 * @UART_PM_STATE_UNDEFINED: sentinel
220 */
221enum uart_pm_state {
222 UART_PM_STATE_ON = 0,
223 UART_PM_STATE_OFF = 3, /* number taken from ACPI */
224 UART_PM_STATE_UNDEFINED,
225};
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227/*
Alan Coxebd2c8f2009-09-19 13:13:28 -0700228 * This is the state information which is persistent across opens.
Alan Coxebd2c8f2009-09-19 13:13:28 -0700229 */
230struct uart_state {
Alan Coxdf4f4dd2008-07-16 21:53:50 +0100231 struct tty_port port;
Alan Coxebd2c8f2009-09-19 13:13:28 -0700232
Linus Walleij6f538fe2012-12-07 11:36:08 +0100233 enum uart_pm_state pm_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 struct circ_buf xmit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Alan Coxebd2c8f2009-09-19 13:13:28 -0700236 struct uart_port *uart_port;
Alan Coxf7519282009-01-02 13:49:21 +0000237};
238
239#define UART_XMIT_SIZE PAGE_SIZE
240
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242/* number of characters left in xmit buffer before we ask for more */
243#define WAKEUP_CHARS 256
244
245struct module;
246struct tty_driver;
247
248struct uart_driver {
249 struct module *owner;
250 const char *driver_name;
251 const char *dev_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 int major;
253 int minor;
254 int nr;
255 struct console *cons;
256
257 /*
258 * these are private; the low level driver should not
259 * touch these; they should be initialised to NULL
260 */
261 struct uart_state *state;
262 struct tty_driver *tty_driver;
263};
264
265void uart_write_wakeup(struct uart_port *port);
266
267/*
268 * Baud rate helpers.
269 */
270void uart_update_timeout(struct uart_port *port, unsigned int cflag,
271 unsigned int baud);
Alan Cox606d0992006-12-08 02:38:45 -0800272unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
273 struct ktermios *old, unsigned int min,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 unsigned int max);
275unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
276
Anton Vorontsov54381062010-10-01 17:21:25 +0400277/* Base timer interval for polling */
278static inline int uart_poll_timeout(struct uart_port *port)
279{
280 int timeout = port->timeout;
281
282 return timeout > 6 ? (timeout / 2 - 2) : 1;
283}
284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285/*
286 * Console helpers.
287 */
Rob Herring9aac5882014-04-18 17:19:55 -0500288struct earlycon_device {
289 struct console *con;
290 struct uart_port port;
291 char options[16]; /* e.g., 115200n8 */
292 unsigned int baud;
293};
294int setup_earlycon(char *buf, const char *match,
295 int (*setup)(struct earlycon_device *, const char *));
296
Rob Herringb0b6abd2014-03-27 08:06:16 -0500297extern int of_setup_earlycon(unsigned long addr,
298 int (*setup)(struct earlycon_device *, const char *));
299
Rob Herring9aac5882014-04-18 17:19:55 -0500300#define EARLYCON_DECLARE(name, func) \
301static int __init name ## _setup_earlycon(char *buf) \
302{ \
303 return setup_earlycon(buf, __stringify(name), func); \
304} \
305early_param("earlycon", name ## _setup_earlycon);
306
Rob Herringb0b6abd2014-03-27 08:06:16 -0500307#define OF_EARLYCON_DECLARE(name, compat, fn) \
308 _OF_DECLARE(earlycon, name, compat, fn, void *)
309
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310struct uart_port *uart_get_console(struct uart_port *ports, int nr,
311 struct console *c);
312void uart_parse_options(char *options, int *baud, int *parity, int *bits,
313 int *flow);
314int uart_set_options(struct uart_port *port, struct console *co, int baud,
315 int parity, int bits, int flow);
316struct tty_driver *uart_console_device(struct console *co, int *index);
Russell Kingd3587882006-03-20 20:00:09 +0000317void uart_console_write(struct uart_port *port, const char *s,
318 unsigned int count,
319 void (*putchar)(struct uart_port *, int));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
321/*
322 * Port/driver registration/removal
323 */
324int uart_register_driver(struct uart_driver *uart);
325void uart_unregister_driver(struct uart_driver *uart);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
327int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
328int uart_match_port(struct uart_port *port1, struct uart_port *port2);
329
330/*
331 * Power Management
332 */
333int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
334int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
335
336#define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
337#define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
338
339#define uart_circ_chars_pending(circ) \
340 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
341
342#define uart_circ_chars_free(circ) \
343 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
344
Alan Coxf7519282009-01-02 13:49:21 +0000345static inline int uart_tx_stopped(struct uart_port *port)
346{
Alan Coxebd2c8f2009-09-19 13:13:28 -0700347 struct tty_struct *tty = port->state->port.tty;
Alan Coxf7519282009-01-02 13:49:21 +0000348 if(tty->stopped || tty->hw_stopped)
349 return 1;
350 return 0;
351}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
353/*
354 * The following are helper functions for the low level drivers.
355 */
Jiri Slaby027d7da2011-11-09 21:33:43 +0100356
357extern void uart_handle_dcd_change(struct uart_port *uport,
358 unsigned int status);
359extern void uart_handle_cts_change(struct uart_port *uport,
360 unsigned int status);
361
362extern void uart_insert_char(struct uart_port *port, unsigned int status,
363 unsigned int overrun, unsigned int ch, unsigned int flag);
364
365#ifdef SUPPORT_SYSRQ
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366static inline int
David Howells7d12e782006-10-05 14:55:46 +0100367uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368{
369 if (port->sysrq) {
370 if (ch && time_before(jiffies, port->sysrq)) {
Dmitry Torokhovf3353972010-08-17 21:15:47 -0700371 handle_sysrq(ch);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 port->sysrq = 0;
373 return 1;
374 }
375 port->sysrq = 0;
376 }
377 return 0;
378}
Jiri Slaby027d7da2011-11-09 21:33:43 +0100379#else
380#define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
Linus Torvalds4e149182005-09-08 14:47:12 -0700381#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383/*
384 * We do the SysRQ and SAK checking like this...
385 */
386static inline int uart_handle_break(struct uart_port *port)
387{
Alan Coxebd2c8f2009-09-19 13:13:28 -0700388 struct uart_state *state = port->state;
Dan Williamsbf03f652012-04-10 14:10:53 -0700389
390 if (port->handle_break)
391 port->handle_break(port);
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393#ifdef SUPPORT_SYSRQ
394 if (port->cons && port->cons->index == port->line) {
395 if (!port->sysrq) {
396 port->sysrq = jiffies + HZ*5;
397 return 1;
398 }
399 port->sysrq = 0;
400 }
401#endif
Russell King27ae7a72006-01-21 22:54:06 +0000402 if (port->flags & UPF_SAK)
Alan Coxebd2c8f2009-09-19 13:13:28 -0700403 do_SAK(state->port.tty);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 return 0;
405}
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/*
408 * UART_ENABLE_MS - determine if port should enable modem status irqs
409 */
410#define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
411 (cflag) & CRTSCTS || \
412 !((cflag) & CLOCAL))
413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414#endif /* LINUX_SERIAL_CORE_H */