Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 23 | |
Russell King | 661f83a | 2005-07-16 09:30:53 +0100 | [diff] [blame] | 24 | #include <linux/compiler.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | #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 Molnar | e2862f6 | 2006-01-13 21:37:07 +0000 | [diff] [blame] | 30 | #include <linux/mutex.h> |
Maciej W. Rozycki | b11115c | 2007-06-01 00:47:07 -0700 | [diff] [blame] | 31 | #include <linux/sysrq.h> |
David Howells | 607ca46 | 2012-10-13 10:46:48 +0100 | [diff] [blame] | 32 | #include <uapi/linux/serial_core.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | |
Sourav Poddar | cf0ebee0 | 2013-05-15 21:05:37 +0530 | [diff] [blame] | 34 | #ifdef CONFIG_SERIAL_CORE_CONSOLE |
| 35 | #define uart_console(port) \ |
| 36 | ((port)->cons && (port)->cons->index == (port)->line) |
| 37 | #else |
Peter Hurley | 6b3cddc | 2015-04-11 11:02:36 -0400 | [diff] [blame] | 38 | #define uart_console(port) ({ (void)port; 0; }) |
Sourav Poddar | cf0ebee0 | 2013-05-15 21:05:37 +0530 | [diff] [blame] | 39 | #endif |
| 40 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | struct uart_port; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | struct serial_struct; |
| 43 | struct device; |
| 44 | |
| 45 | /* |
Kevin Cernekee | e759d7c | 2012-12-26 20:43:42 -0800 | [diff] [blame] | 46 | * This structure describes all the operations that can be done on the |
| 47 | * physical hardware. See Documentation/serial/driver for details. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | */ |
| 49 | struct 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 King | b129a8c | 2005-08-31 10:12:14 +0100 | [diff] [blame] | 53 | void (*stop_tx)(struct uart_port *); |
| 54 | void (*start_tx)(struct uart_port *); |
Russell King | 9aba8d5b | 2012-04-17 17:23:14 +0100 | [diff] [blame] | 55 | void (*throttle)(struct uart_port *); |
| 56 | void (*unthrottle)(struct uart_port *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | 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 Skinnemoen | 6bb0e3a | 2008-07-16 21:52:36 +0100 | [diff] [blame] | 63 | void (*flush_buffer)(struct uart_port *); |
Alan Cox | 606d099 | 2006-12-08 02:38:45 -0800 | [diff] [blame] | 64 | void (*set_termios)(struct uart_port *, struct ktermios *new, |
| 65 | struct ktermios *old); |
Peter Hurley | 732a84a | 2014-11-05 13:11:43 -0500 | [diff] [blame] | 66 | void (*set_ldisc)(struct uart_port *, struct ktermios *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | void (*pm)(struct uart_port *, unsigned int state, |
| 68 | unsigned int oldstate); |
San Mehat | 108a022 | 2009-07-29 20:21:28 -0700 | [diff] [blame] | 69 | void (*wake_peer)(struct uart_port *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 70 | |
| 71 | /* |
| 72 | * Return a string describing the type of the port |
| 73 | */ |
Kevin Cernekee | e759d7c | 2012-12-26 20:43:42 -0800 | [diff] [blame] | 74 | const char *(*type)(struct uart_port *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | |
| 76 | /* |
| 77 | * Release IO and memory resources used by the port. |
| 78 | * This includes iounmap if necessary. |
| 79 | */ |
| 80 | void (*release_port)(struct uart_port *); |
| 81 | |
| 82 | /* |
| 83 | * Request IO and memory resources used by the port. |
| 84 | * This includes iomapping the port if necessary. |
| 85 | */ |
| 86 | int (*request_port)(struct uart_port *); |
| 87 | void (*config_port)(struct uart_port *, int); |
| 88 | int (*verify_port)(struct uart_port *, struct serial_struct *); |
| 89 | int (*ioctl)(struct uart_port *, unsigned int, unsigned long); |
Jason Wessel | f2d937f | 2008-04-17 20:05:37 +0200 | [diff] [blame] | 90 | #ifdef CONFIG_CONSOLE_POLL |
Anton Vorontsov | c7f3e70 | 2012-09-24 14:27:53 -0700 | [diff] [blame] | 91 | int (*poll_init)(struct uart_port *); |
Kevin Cernekee | e759d7c | 2012-12-26 20:43:42 -0800 | [diff] [blame] | 92 | void (*poll_put_char)(struct uart_port *, unsigned char); |
Jason Wessel | f2d937f | 2008-04-17 20:05:37 +0200 | [diff] [blame] | 93 | int (*poll_get_char)(struct uart_port *); |
| 94 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | }; |
| 96 | |
Jason Wessel | f5316b4 | 2010-05-20 21:04:22 -0500 | [diff] [blame] | 97 | #define NO_POLL_CHAR 0x00ff0000 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 98 | #define UART_CONFIG_TYPE (1 << 0) |
| 99 | #define UART_CONFIG_IRQ (1 << 1) |
| 100 | |
| 101 | struct uart_icount { |
| 102 | __u32 cts; |
| 103 | __u32 dsr; |
| 104 | __u32 rng; |
| 105 | __u32 dcd; |
| 106 | __u32 rx; |
| 107 | __u32 tx; |
| 108 | __u32 frame; |
| 109 | __u32 overrun; |
| 110 | __u32 parity; |
| 111 | __u32 brk; |
| 112 | __u32 buf_overrun; |
| 113 | }; |
| 114 | |
Russell King | 0077d45 | 2006-01-21 23:03:28 +0000 | [diff] [blame] | 115 | typedef unsigned int __bitwise__ upf_t; |
Peter Hurley | 299245a | 2014-09-10 15:06:24 -0400 | [diff] [blame] | 116 | typedef unsigned int __bitwise__ upstat_t; |
Russell King | 0077d45 | 2006-01-21 23:03:28 +0000 | [diff] [blame] | 117 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | struct uart_port { |
| 119 | spinlock_t lock; /* port lock */ |
David Miller | 0c8946d | 2008-10-13 10:35:23 +0100 | [diff] [blame] | 120 | unsigned long iobase; /* in/out[bwl] */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | unsigned char __iomem *membase; /* read/write[bwl] */ |
David Daney | 7d6a07d | 2009-01-02 13:49:47 +0000 | [diff] [blame] | 122 | unsigned int (*serial_in)(struct uart_port *, int); |
| 123 | void (*serial_out)(struct uart_port *, int, int); |
Philippe Langlais | 235dae5 | 2010-07-29 17:13:57 +0200 | [diff] [blame] | 124 | void (*set_termios)(struct uart_port *, |
| 125 | struct ktermios *new, |
| 126 | struct ktermios *old); |
Wan Ahmad Zainie | 144ef5c2 | 2016-04-06 12:06:51 +0800 | [diff] [blame] | 127 | unsigned int (*get_mctrl)(struct uart_port *); |
Peter Hurley | 4bf4ea9 | 2014-12-30 20:28:15 -0500 | [diff] [blame] | 128 | void (*set_mctrl)(struct uart_port *, unsigned int); |
Sebastian Andrzej Siewior | b99b121 | 2014-09-05 21:02:37 +0200 | [diff] [blame] | 129 | int (*startup)(struct uart_port *port); |
| 130 | void (*shutdown)(struct uart_port *port); |
Sebastian Andrzej Siewior | 234abab | 2014-09-10 21:29:56 +0200 | [diff] [blame] | 131 | void (*throttle)(struct uart_port *port); |
| 132 | void (*unthrottle)(struct uart_port *port); |
Jamie Iles | a74036f | 2011-08-15 10:17:51 +0100 | [diff] [blame] | 133 | int (*handle_irq)(struct uart_port *); |
Manuel Lauss | c161afe | 2010-09-25 15:13:45 +0200 | [diff] [blame] | 134 | void (*pm)(struct uart_port *, unsigned int state, |
| 135 | unsigned int old); |
Dan Williams | bf03f65 | 2012-04-10 14:10:53 -0700 | [diff] [blame] | 136 | void (*handle_break)(struct uart_port *); |
Ricardo Ribalda Delgado | a5f276f | 2014-11-06 22:46:13 +0100 | [diff] [blame] | 137 | int (*rs485_config)(struct uart_port *, |
| 138 | struct serial_rs485 *rs485); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 139 | unsigned int irq; /* irq number */ |
Vikram Pandita | 1c2f049 | 2009-09-19 13:13:19 -0700 | [diff] [blame] | 140 | unsigned long irqflags; /* irq flags */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | unsigned int uartclk; /* base uart clock */ |
Russell King | 947deee | 2006-07-02 20:45:51 +0100 | [diff] [blame] | 142 | unsigned int fifosize; /* tx fifo size */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 143 | unsigned char x_char; /* xon/xoff char */ |
| 144 | unsigned char regshift; /* reg offset shift */ |
| 145 | unsigned char iotype; /* io access style */ |
Russell King | 947deee | 2006-07-02 20:45:51 +0100 | [diff] [blame] | 146 | unsigned char unused1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | |
Peter Hurley | 647f162 | 2015-03-01 10:24:28 -0500 | [diff] [blame] | 148 | #define UPIO_PORT (SERIAL_IO_PORT) /* 8b I/O port access */ |
| 149 | #define UPIO_HUB6 (SERIAL_IO_HUB6) /* Hub6 ISA card */ |
Peter Hurley | 858965d | 2015-11-27 21:29:24 -0500 | [diff] [blame] | 150 | #define UPIO_MEM (SERIAL_IO_MEM) /* driver-specific */ |
Peter Hurley | 647f162 | 2015-03-01 10:24:28 -0500 | [diff] [blame] | 151 | #define UPIO_MEM32 (SERIAL_IO_MEM32) /* 32b little endian */ |
| 152 | #define UPIO_AU (SERIAL_IO_AU) /* Au1x00 and RT288x type IO */ |
| 153 | #define UPIO_TSI (SERIAL_IO_TSI) /* Tsi108/109 type IO */ |
| 154 | #define UPIO_MEM32BE (SERIAL_IO_MEM32BE) /* 32b big endian */ |
Masahiro Yamada | bd94c40 | 2015-10-28 12:46:05 +0900 | [diff] [blame] | 155 | #define UPIO_MEM16 (SERIAL_IO_MEM16) /* 16b little endian */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 156 | |
| 157 | unsigned int read_status_mask; /* driver specific */ |
| 158 | unsigned int ignore_status_mask; /* driver specific */ |
Alan Cox | ebd2c8f | 2009-09-19 13:13:28 -0700 | [diff] [blame] | 159 | struct uart_state *state; /* pointer to parent state */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 160 | struct uart_icount icount; /* statistics */ |
| 161 | |
| 162 | struct console *cons; /* struct console, if any */ |
Alexander Beregalov | 06e82df | 2009-04-06 17:34:34 +0100 | [diff] [blame] | 163 | #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | unsigned long sysrq; /* sysrq timeout */ |
| 165 | #endif |
| 166 | |
Peter Hurley | 8a949b0 | 2014-09-02 17:39:19 -0400 | [diff] [blame] | 167 | /* flags must be updated while holding port mutex */ |
Russell King | 0077d45 | 2006-01-21 23:03:28 +0000 | [diff] [blame] | 168 | upf_t flags; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 169 | |
Peter Hurley | 904326e | 2014-10-16 16:54:21 -0400 | [diff] [blame] | 170 | /* |
| 171 | * These flags must be equivalent to the flags defined in |
| 172 | * include/uapi/linux/tty_flags.h which are the userspace definitions |
| 173 | * assigned from the serial_struct flags in uart_set_info() |
| 174 | * [for bit definitions in the UPF_CHANGE_MASK] |
| 175 | * |
| 176 | * Bits [0..UPF_LAST_USER] are userspace defined/visible/changeable |
| 177 | * except bit 15 (UPF_NO_TXEN_TEST) which is masked off. |
| 178 | * The remaining bits are serial-core specific and not modifiable by |
| 179 | * userspace. |
| 180 | */ |
| 181 | #define UPF_FOURPORT ((__force upf_t) ASYNC_FOURPORT /* 1 */ ) |
| 182 | #define UPF_SAK ((__force upf_t) ASYNC_SAK /* 2 */ ) |
| 183 | #define UPF_SPD_HI ((__force upf_t) ASYNC_SPD_HI /* 4 */ ) |
| 184 | #define UPF_SPD_VHI ((__force upf_t) ASYNC_SPD_VHI /* 5 */ ) |
| 185 | #define UPF_SPD_CUST ((__force upf_t) ASYNC_SPD_CUST /* 0x0030 */ ) |
| 186 | #define UPF_SPD_WARP ((__force upf_t) ASYNC_SPD_WARP /* 0x1010 */ ) |
| 187 | #define UPF_SPD_MASK ((__force upf_t) ASYNC_SPD_MASK /* 0x1030 */ ) |
| 188 | #define UPF_SKIP_TEST ((__force upf_t) ASYNC_SKIP_TEST /* 6 */ ) |
| 189 | #define UPF_AUTO_IRQ ((__force upf_t) ASYNC_AUTO_IRQ /* 7 */ ) |
| 190 | #define UPF_HARDPPS_CD ((__force upf_t) ASYNC_HARDPPS_CD /* 11 */ ) |
| 191 | #define UPF_SPD_SHI ((__force upf_t) ASYNC_SPD_SHI /* 12 */ ) |
| 192 | #define UPF_LOW_LATENCY ((__force upf_t) ASYNC_LOW_LATENCY /* 13 */ ) |
| 193 | #define UPF_BUGGY_UART ((__force upf_t) ASYNC_BUGGY_UART /* 14 */ ) |
Mauro Carvalho Chehab | b6adea3 | 2009-02-20 15:38:52 -0800 | [diff] [blame] | 194 | #define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15)) |
Peter Hurley | 904326e | 2014-10-16 16:54:21 -0400 | [diff] [blame] | 195 | #define UPF_MAGIC_MULTIPLIER ((__force upf_t) ASYNC_MAGIC_MULTIPLIER /* 16 */ ) |
| 196 | |
Peter Hurley | 391f93f | 2015-01-25 14:44:51 -0500 | [diff] [blame] | 197 | /* Port has hardware-assisted h/w flow control */ |
| 198 | #define UPF_AUTO_CTS ((__force upf_t) (1 << 20)) |
| 199 | #define UPF_AUTO_RTS ((__force upf_t) (1 << 21)) |
| 200 | #define UPF_HARD_FLOW ((__force upf_t) (UPF_AUTO_CTS | UPF_AUTO_RTS)) |
Russell King | 2cbacaf | 2012-04-17 16:34:13 +0100 | [diff] [blame] | 201 | /* Port has hardware-assisted s/w flow control */ |
| 202 | #define UPF_SOFT_FLOW ((__force upf_t) (1 << 22)) |
Russell King | 0077d45 | 2006-01-21 23:03:28 +0000 | [diff] [blame] | 203 | #define UPF_CONS_FLOW ((__force upf_t) (1 << 23)) |
| 204 | #define UPF_SHARE_IRQ ((__force upf_t) (1 << 24)) |
Søren Holm | 0631534 | 2011-09-02 22:55:37 +0200 | [diff] [blame] | 205 | #define UPF_EXAR_EFR ((__force upf_t) (1 << 25)) |
Dan Williams | bc02d15 | 2012-04-06 11:49:50 -0700 | [diff] [blame] | 206 | #define UPF_BUG_THRE ((__force upf_t) (1 << 26)) |
David Daney | 8e23fcc | 2009-01-02 13:49:54 +0000 | [diff] [blame] | 207 | /* The exact UART type is known and should not be probed. */ |
| 208 | #define UPF_FIXED_TYPE ((__force upf_t) (1 << 27)) |
Russell King | 0077d45 | 2006-01-21 23:03:28 +0000 | [diff] [blame] | 209 | #define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28)) |
David Gibson | abb4a23 | 2007-05-06 14:48:49 -0700 | [diff] [blame] | 210 | #define UPF_FIXED_PORT ((__force upf_t) (1 << 29)) |
Russell King | 68ac64c | 2006-04-30 11:13:50 +0100 | [diff] [blame] | 211 | #define UPF_DEAD ((__force upf_t) (1 << 30)) |
Russell King | 0077d45 | 2006-01-21 23:03:28 +0000 | [diff] [blame] | 212 | #define UPF_IOREMAP ((__force upf_t) (1 << 31)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 213 | |
Peter Hurley | 904326e | 2014-10-16 16:54:21 -0400 | [diff] [blame] | 214 | #define __UPF_CHANGE_MASK 0x17fff |
| 215 | #define UPF_CHANGE_MASK ((__force upf_t) __UPF_CHANGE_MASK) |
Russell King | 0077d45 | 2006-01-21 23:03:28 +0000 | [diff] [blame] | 216 | #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 217 | |
Peter Hurley | 904326e | 2014-10-16 16:54:21 -0400 | [diff] [blame] | 218 | #if __UPF_CHANGE_MASK > ASYNC_FLAGS |
| 219 | #error Change mask not equivalent to userspace-visible bit defines |
| 220 | #endif |
| 221 | |
Peter Hurley | 391f93f | 2015-01-25 14:44:51 -0500 | [diff] [blame] | 222 | /* |
| 223 | * Must hold termios_rwsem, port mutex and port lock to change; |
| 224 | * can hold any one lock to read. |
| 225 | */ |
Peter Hurley | 299245a | 2014-09-10 15:06:24 -0400 | [diff] [blame] | 226 | upstat_t status; |
| 227 | |
| 228 | #define UPSTAT_CTS_ENABLE ((__force upstat_t) (1 << 0)) |
| 229 | #define UPSTAT_DCD_ENABLE ((__force upstat_t) (1 << 1)) |
Peter Hurley | 391f93f | 2015-01-25 14:44:51 -0500 | [diff] [blame] | 230 | #define UPSTAT_AUTORTS ((__force upstat_t) (1 << 2)) |
| 231 | #define UPSTAT_AUTOCTS ((__force upstat_t) (1 << 3)) |
| 232 | #define UPSTAT_AUTOXOFF ((__force upstat_t) (1 << 4)) |
Peter Hurley | 299245a | 2014-09-10 15:06:24 -0400 | [diff] [blame] | 233 | |
Peter Hurley | d01f4d1 | 2014-09-10 15:06:26 -0400 | [diff] [blame] | 234 | int hw_stopped; /* sw-assisted CTS flow state */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 235 | unsigned int mctrl; /* current modem ctrl settings */ |
| 236 | unsigned int timeout; /* character-based timeout */ |
| 237 | unsigned int type; /* port type */ |
Russell King | ba899db | 2006-01-21 22:45:50 +0000 | [diff] [blame] | 238 | const struct uart_ops *ops; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 239 | unsigned int custom_divisor; |
| 240 | unsigned int line; /* port index */ |
Peter Hurley | 959801f | 2015-02-24 14:25:00 -0500 | [diff] [blame] | 241 | unsigned int minor; |
Josh Boyer | 4f640ef | 2007-07-23 18:43:44 -0700 | [diff] [blame] | 242 | resource_size_t mapbase; /* for ioremap */ |
Mans Rullgard | ee97d0e3 | 2015-03-08 14:30:04 +0000 | [diff] [blame] | 243 | resource_size_t mapsize; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 244 | struct device *dev; /* parent device */ |
| 245 | unsigned char hub6; /* this should be in the 8250 driver */ |
Guennadi Liakhovetski | b3b708f | 2007-10-16 01:24:02 -0700 | [diff] [blame] | 246 | unsigned char suspended; |
Govindraj.R | 3f960db | 2010-12-16 18:12:47 +0530 | [diff] [blame] | 247 | unsigned char irq_wake; |
Guennadi Liakhovetski | b3b708f | 2007-10-16 01:24:02 -0700 | [diff] [blame] | 248 | unsigned char unused[2]; |
Greg Kroah-Hartman | 266dcff | 2014-07-16 01:19:34 +0000 | [diff] [blame] | 249 | struct attribute_group *attr_group; /* port specific attributes */ |
| 250 | const struct attribute_group **tty_groups; /* all attributes (serial core use only) */ |
Ricardo Ribalda Delgado | a5f276f | 2014-11-06 22:46:13 +0100 | [diff] [blame] | 251 | struct serial_rs485 rs485; |
Marc St-Jean | beab697 | 2007-05-06 14:48:45 -0700 | [diff] [blame] | 252 | void *private_data; /* generic platform data pointer */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 253 | }; |
| 254 | |
Paul Gortmaker | 927353a | 2012-03-08 19:12:12 -0500 | [diff] [blame] | 255 | static inline int serial_port_in(struct uart_port *up, int offset) |
| 256 | { |
| 257 | return up->serial_in(up, offset); |
| 258 | } |
| 259 | |
| 260 | static inline void serial_port_out(struct uart_port *up, int offset, int value) |
| 261 | { |
| 262 | up->serial_out(up, offset, value); |
| 263 | } |
| 264 | |
Linus Walleij | 6f538fe | 2012-12-07 11:36:08 +0100 | [diff] [blame] | 265 | /** |
| 266 | * enum uart_pm_state - power states for UARTs |
| 267 | * @UART_PM_STATE_ON: UART is powered, up and operational |
| 268 | * @UART_PM_STATE_OFF: UART is powered off |
| 269 | * @UART_PM_STATE_UNDEFINED: sentinel |
| 270 | */ |
| 271 | enum uart_pm_state { |
| 272 | UART_PM_STATE_ON = 0, |
| 273 | UART_PM_STATE_OFF = 3, /* number taken from ACPI */ |
| 274 | UART_PM_STATE_UNDEFINED, |
| 275 | }; |
| 276 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 277 | /* |
Alan Cox | ebd2c8f | 2009-09-19 13:13:28 -0700 | [diff] [blame] | 278 | * This is the state information which is persistent across opens. |
Alan Cox | ebd2c8f | 2009-09-19 13:13:28 -0700 | [diff] [blame] | 279 | */ |
| 280 | struct uart_state { |
Alan Cox | df4f4dd | 2008-07-16 21:53:50 +0100 | [diff] [blame] | 281 | struct tty_port port; |
Alan Cox | ebd2c8f | 2009-09-19 13:13:28 -0700 | [diff] [blame] | 282 | |
Linus Walleij | 6f538fe | 2012-12-07 11:36:08 +0100 | [diff] [blame] | 283 | enum uart_pm_state pm_state; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 284 | struct circ_buf xmit; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 285 | |
Peter Hurley | 9ed1942 | 2016-04-09 18:56:34 -0700 | [diff] [blame] | 286 | atomic_t refcount; |
| 287 | wait_queue_head_t remove_wait; |
Alan Cox | ebd2c8f | 2009-09-19 13:13:28 -0700 | [diff] [blame] | 288 | struct uart_port *uart_port; |
Alan Cox | f751928 | 2009-01-02 13:49:21 +0000 | [diff] [blame] | 289 | }; |
| 290 | |
| 291 | #define UART_XMIT_SIZE PAGE_SIZE |
| 292 | |
| 293 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 294 | /* number of characters left in xmit buffer before we ask for more */ |
| 295 | #define WAKEUP_CHARS 256 |
| 296 | |
| 297 | struct module; |
| 298 | struct tty_driver; |
| 299 | |
| 300 | struct uart_driver { |
| 301 | struct module *owner; |
| 302 | const char *driver_name; |
| 303 | const char *dev_name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 304 | int major; |
| 305 | int minor; |
| 306 | int nr; |
| 307 | struct console *cons; |
| 308 | |
| 309 | /* |
| 310 | * these are private; the low level driver should not |
| 311 | * touch these; they should be initialised to NULL |
| 312 | */ |
| 313 | struct uart_state *state; |
| 314 | struct tty_driver *tty_driver; |
| 315 | }; |
| 316 | |
| 317 | void uart_write_wakeup(struct uart_port *port); |
| 318 | |
| 319 | /* |
| 320 | * Baud rate helpers. |
| 321 | */ |
| 322 | void uart_update_timeout(struct uart_port *port, unsigned int cflag, |
| 323 | unsigned int baud); |
Alan Cox | 606d099 | 2006-12-08 02:38:45 -0800 | [diff] [blame] | 324 | unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios, |
| 325 | struct ktermios *old, unsigned int min, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 326 | unsigned int max); |
| 327 | unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud); |
| 328 | |
Anton Vorontsov | 5438106 | 2010-10-01 17:21:25 +0400 | [diff] [blame] | 329 | /* Base timer interval for polling */ |
| 330 | static inline int uart_poll_timeout(struct uart_port *port) |
| 331 | { |
| 332 | int timeout = port->timeout; |
| 333 | |
| 334 | return timeout > 6 ? (timeout / 2 - 2) : 1; |
| 335 | } |
| 336 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 337 | /* |
| 338 | * Console helpers. |
| 339 | */ |
Rob Herring | 9aac588 | 2014-04-18 17:19:55 -0500 | [diff] [blame] | 340 | struct earlycon_device { |
| 341 | struct console *con; |
| 342 | struct uart_port port; |
| 343 | char options[16]; /* e.g., 115200n8 */ |
| 344 | unsigned int baud; |
| 345 | }; |
Rob Herring | 9aac588 | 2014-04-18 17:19:55 -0500 | [diff] [blame] | 346 | |
Peter Hurley | 470ca0d | 2015-03-09 16:27:21 -0400 | [diff] [blame] | 347 | struct earlycon_id { |
| 348 | char name[16]; |
Peter Hurley | 2eaa790 | 2016-01-16 15:23:39 -0800 | [diff] [blame] | 349 | char compatible[128]; |
Peter Hurley | 470ca0d | 2015-03-09 16:27:21 -0400 | [diff] [blame] | 350 | int (*setup)(struct earlycon_device *, const char *options); |
Peter Hurley | 99492c3 | 2015-04-03 08:57:51 -0400 | [diff] [blame] | 351 | } __aligned(32); |
Peter Hurley | 470ca0d | 2015-03-09 16:27:21 -0400 | [diff] [blame] | 352 | |
Peter Hurley | 2eaa790 | 2016-01-16 15:23:39 -0800 | [diff] [blame] | 353 | extern const struct earlycon_id __earlycon_table[]; |
| 354 | extern const struct earlycon_id __earlycon_table_end[]; |
| 355 | |
Masahiro Yamada | f8ba364 | 2016-06-06 18:41:00 +0900 | [diff] [blame] | 356 | #if defined(CONFIG_SERIAL_EARLYCON) && !defined(MODULE) |
| 357 | #define EARLYCON_USED_OR_UNUSED __used |
| 358 | #else |
| 359 | #define EARLYCON_USED_OR_UNUSED __maybe_unused |
| 360 | #endif |
| 361 | |
Peter Hurley | 2eaa790 | 2016-01-16 15:23:39 -0800 | [diff] [blame] | 362 | #define OF_EARLYCON_DECLARE(_name, compat, fn) \ |
| 363 | static const struct earlycon_id __UNIQUE_ID(__earlycon_##_name) \ |
Masahiro Yamada | f8ba364 | 2016-06-06 18:41:00 +0900 | [diff] [blame] | 364 | EARLYCON_USED_OR_UNUSED __section(__earlycon_table) \ |
Peter Hurley | 2eaa790 | 2016-01-16 15:23:39 -0800 | [diff] [blame] | 365 | = { .name = __stringify(_name), \ |
| 366 | .compatible = compat, \ |
| 367 | .setup = fn } |
| 368 | |
| 369 | #define EARLYCON_DECLARE(_name, fn) OF_EARLYCON_DECLARE(_name, "", fn) |
| 370 | |
Peter Hurley | c90fe9c | 2016-01-16 15:23:44 -0800 | [diff] [blame] | 371 | extern int of_setup_earlycon(const struct earlycon_id *match, |
Peter Hurley | 088da2a | 2016-01-16 15:23:43 -0800 | [diff] [blame] | 372 | unsigned long node, |
Peter Hurley | 4d118c9 | 2016-01-16 15:23:42 -0800 | [diff] [blame] | 373 | const char *options); |
Rob Herring | b0b6abd | 2014-03-27 08:06:16 -0500 | [diff] [blame] | 374 | |
Aleksey Makarov | ad1696f | 2016-09-27 23:54:13 +0300 | [diff] [blame] | 375 | #ifdef CONFIG_SERIAL_EARLYCON |
| 376 | extern bool earlycon_init_is_deferred __initdata; |
| 377 | int setup_earlycon(char *buf); |
| 378 | #else |
| 379 | static const bool earlycon_init_is_deferred; |
| 380 | static inline int setup_earlycon(char *buf) { return 0; } |
| 381 | #endif |
| 382 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 383 | struct uart_port *uart_get_console(struct uart_port *ports, int nr, |
| 384 | struct console *c); |
Alexander Sverdlin | 46e3668 | 2016-09-02 13:20:21 +0200 | [diff] [blame] | 385 | int uart_parse_earlycon(char *p, unsigned char *iotype, resource_size_t *addr, |
Peter Hurley | 73abaf8 | 2015-03-01 11:05:46 -0500 | [diff] [blame] | 386 | char **options); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 387 | void uart_parse_options(char *options, int *baud, int *parity, int *bits, |
| 388 | int *flow); |
| 389 | int uart_set_options(struct uart_port *port, struct console *co, int baud, |
| 390 | int parity, int bits, int flow); |
| 391 | struct tty_driver *uart_console_device(struct console *co, int *index); |
Russell King | d358788 | 2006-03-20 20:00:09 +0000 | [diff] [blame] | 392 | void uart_console_write(struct uart_port *port, const char *s, |
| 393 | unsigned int count, |
| 394 | void (*putchar)(struct uart_port *, int)); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 395 | |
| 396 | /* |
| 397 | * Port/driver registration/removal |
| 398 | */ |
| 399 | int uart_register_driver(struct uart_driver *uart); |
| 400 | void uart_unregister_driver(struct uart_driver *uart); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 401 | int uart_add_one_port(struct uart_driver *reg, struct uart_port *port); |
| 402 | int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port); |
| 403 | int uart_match_port(struct uart_port *port1, struct uart_port *port2); |
| 404 | |
| 405 | /* |
| 406 | * Power Management |
| 407 | */ |
| 408 | int uart_suspend_port(struct uart_driver *reg, struct uart_port *port); |
| 409 | int uart_resume_port(struct uart_driver *reg, struct uart_port *port); |
| 410 | |
| 411 | #define uart_circ_empty(circ) ((circ)->head == (circ)->tail) |
| 412 | #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0) |
| 413 | |
| 414 | #define uart_circ_chars_pending(circ) \ |
| 415 | (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE)) |
| 416 | |
| 417 | #define uart_circ_chars_free(circ) \ |
| 418 | (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE)) |
| 419 | |
Alan Cox | f751928 | 2009-01-02 13:49:21 +0000 | [diff] [blame] | 420 | static inline int uart_tx_stopped(struct uart_port *port) |
| 421 | { |
Alan Cox | ebd2c8f | 2009-09-19 13:13:28 -0700 | [diff] [blame] | 422 | struct tty_struct *tty = port->state->port.tty; |
Rob Herring | a727b02 | 2016-09-09 17:37:02 -0500 | [diff] [blame] | 423 | if ((tty && tty->stopped) || port->hw_stopped) |
Alan Cox | f751928 | 2009-01-02 13:49:21 +0000 | [diff] [blame] | 424 | return 1; |
| 425 | return 0; |
| 426 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 427 | |
Peter Hurley | 299245a | 2014-09-10 15:06:24 -0400 | [diff] [blame] | 428 | static inline bool uart_cts_enabled(struct uart_port *uport) |
| 429 | { |
Peter Hurley | d4260b5 | 2014-10-16 14:19:47 -0400 | [diff] [blame] | 430 | return !!(uport->status & UPSTAT_CTS_ENABLE); |
Peter Hurley | 299245a | 2014-09-10 15:06:24 -0400 | [diff] [blame] | 431 | } |
| 432 | |
Peter Hurley | 391f93f | 2015-01-25 14:44:51 -0500 | [diff] [blame] | 433 | static inline bool uart_softcts_mode(struct uart_port *uport) |
| 434 | { |
| 435 | upstat_t mask = UPSTAT_CTS_ENABLE | UPSTAT_AUTOCTS; |
| 436 | |
| 437 | return ((uport->status & mask) == UPSTAT_CTS_ENABLE); |
| 438 | } |
| 439 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 440 | /* |
| 441 | * The following are helper functions for the low level drivers. |
| 442 | */ |
Jiri Slaby | 027d7da | 2011-11-09 21:33:43 +0100 | [diff] [blame] | 443 | |
| 444 | extern void uart_handle_dcd_change(struct uart_port *uport, |
| 445 | unsigned int status); |
| 446 | extern void uart_handle_cts_change(struct uart_port *uport, |
| 447 | unsigned int status); |
| 448 | |
| 449 | extern void uart_insert_char(struct uart_port *port, unsigned int status, |
| 450 | unsigned int overrun, unsigned int ch, unsigned int flag); |
| 451 | |
| 452 | #ifdef SUPPORT_SYSRQ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 453 | static inline int |
David Howells | 7d12e78 | 2006-10-05 14:55:46 +0100 | [diff] [blame] | 454 | uart_handle_sysrq_char(struct uart_port *port, unsigned int ch) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 455 | { |
| 456 | if (port->sysrq) { |
| 457 | if (ch && time_before(jiffies, port->sysrq)) { |
Dmitry Torokhov | f335397 | 2010-08-17 21:15:47 -0700 | [diff] [blame] | 458 | handle_sysrq(ch); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 459 | port->sysrq = 0; |
| 460 | return 1; |
| 461 | } |
| 462 | port->sysrq = 0; |
| 463 | } |
| 464 | return 0; |
| 465 | } |
Jiri Slaby | 027d7da | 2011-11-09 21:33:43 +0100 | [diff] [blame] | 466 | #else |
| 467 | #define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; }) |
Linus Torvalds | 4e14918 | 2005-09-08 14:47:12 -0700 | [diff] [blame] | 468 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 469 | |
| 470 | /* |
| 471 | * We do the SysRQ and SAK checking like this... |
| 472 | */ |
| 473 | static inline int uart_handle_break(struct uart_port *port) |
| 474 | { |
Alan Cox | ebd2c8f | 2009-09-19 13:13:28 -0700 | [diff] [blame] | 475 | struct uart_state *state = port->state; |
Dan Williams | bf03f65 | 2012-04-10 14:10:53 -0700 | [diff] [blame] | 476 | |
| 477 | if (port->handle_break) |
| 478 | port->handle_break(port); |
| 479 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 480 | #ifdef SUPPORT_SYSRQ |
| 481 | if (port->cons && port->cons->index == port->line) { |
| 482 | if (!port->sysrq) { |
| 483 | port->sysrq = jiffies + HZ*5; |
| 484 | return 1; |
| 485 | } |
| 486 | port->sysrq = 0; |
| 487 | } |
| 488 | #endif |
Russell King | 27ae7a7 | 2006-01-21 22:54:06 +0000 | [diff] [blame] | 489 | if (port->flags & UPF_SAK) |
Alan Cox | ebd2c8f | 2009-09-19 13:13:28 -0700 | [diff] [blame] | 490 | do_SAK(state->port.tty); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 491 | return 0; |
| 492 | } |
| 493 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 494 | /* |
| 495 | * UART_ENABLE_MS - determine if port should enable modem status irqs |
| 496 | */ |
| 497 | #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \ |
| 498 | (cflag) & CRTSCTS || \ |
| 499 | !((cflag) & CLOCAL)) |
| 500 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 501 | #endif /* LINUX_SERIAL_CORE_H */ |