2 * linux/drivers/char/serial_core.h
4 * Copyright (C) 2000 Deep Blue Solutions Ltd.
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.
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.
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
20 #ifndef LINUX_SERIAL_CORE_H
21 #define LINUX_SERIAL_CORE_H
23 #include <linux/serial.h>
26 * The type definitions. These are from Ted Ts'o's serial.h
28 #define PORT_UNKNOWN 0
35 #define PORT_16650V2 7
37 #define PORT_STARTECH 9
38 #define PORT_16C950 10
42 #define PORT_NS16550A 14
43 #define PORT_XSCALE 15
44 #define PORT_RM9000 16 /* PMC-Sierra RM9xxx internal UART */
45 #define PORT_OCTEON 17 /* Cavium OCTEON internal UART */
46 #define PORT_AR7 18 /* Texas Instruments AR7 internal UART */
47 #define PORT_U6_16550A 19 /* ST-Ericsson U6xxx internal UART */
48 #define PORT_TEGRA 20 /* NVIDIA Tegra internal UART */
49 #define PORT_XR17D15X 21 /* Exar XR17D15x UART */
50 #define PORT_LPC3220 22 /* NXP LPC32xx SoC "Standard" UART */
51 #define PORT_MAX_8250 22 /* max port ID */
54 * ARM specific type numbers. These are not currently guaranteed
55 * to be implemented, and will change in the future. These are
56 * separate so any additions to the old serial.c that occur before
57 * we are merged can be easily merged here.
61 #define PORT_CLPS711X 33
62 #define PORT_SA1100 34
63 #define PORT_UART00 35
66 /* Sparc type numbers. */
67 #define PORT_SUNZILOG 38
68 #define PORT_SUNSAB 39
74 /* Parisc type numbers. */
77 /* Atmel AT91 / AT32 SoC */
80 /* Macintosh Zilog type numbers */
81 #define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
82 #define PORT_PMAC_ZILOG 51
89 /* Samsung S3C2410 SoC and derivatives thereof */
90 #define PORT_S3C2410 55
92 /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
93 #define PORT_IP22ZILOG 56
95 /* Sharp LH7a40x -- an ARM9 SoC series */
96 #define PORT_LH7A40X 57
98 /* PPC CPM type number */
101 /* MPC52xx (and MPC512x) type numbers */
102 #define PORT_MPC52xx 59
107 /* Samsung S3C2440 SoC */
108 #define PORT_S3C2440 61
110 /* Motorola i.MX SoC */
116 /* TXX9 type number */
119 /* NEC VR4100 series SIU/DSIU */
120 #define PORT_VR41XX_SIU 65
121 #define PORT_VR41XX_DSIU 66
123 /* Samsung S3C2400 SoC */
124 #define PORT_S3C2400 67
127 #define PORT_M32R_SIO 68
132 #define PORT_PNX8XXX 70
137 /* SUN4V Hypervisor Console */
138 #define PORT_SUNHV 72
140 #define PORT_S3C2412 73
142 /* Xilinx uartlite */
143 #define PORT_UARTLITE 74
149 #define PORT_KS8695 76
151 /* Broadcom SB1250, etc. SOC */
152 #define PORT_SB1250_DUART 77
154 /* Freescale ColdFire */
158 #define PORT_BFIN_SPORT 79
160 /* MN10300 on-chip UART numbers */
161 #define PORT_MN10300 80
162 #define PORT_MN10300_CTS 81
164 #define PORT_SC26XX 82
167 #define PORT_SCIFA 83
169 #define PORT_S3C6400 84
172 #define PORT_NWPSERIAL 85
175 #define PORT_MAX3100 86
177 /* Timberdale UART */
178 #define PORT_TIMBUART 87
180 /* Qualcomm MSM SoCs */
183 /* BCM63xx family SoCs */
184 #define PORT_BCM63XX 89
186 /* Aeroflex Gaisler GRLIB APBUART */
187 #define PORT_APBUART 90
190 #define PORT_ALTERA_JTAGUART 91
191 #define PORT_ALTERA_UART 92
194 #define PORT_SCIFB 93
197 #define PORT_MAX3107 94
199 /* High Speed UART for Medfield */
206 #define PORT_VT8500 97
208 /* Xilinx PSS UART */
209 #define PORT_XUARTPS 98
211 /* Atheros AR933X SoC */
212 #define PORT_AR933X 99
214 /* Energy Micro efm32 SoC */
215 #define PORT_EFMUART 100
219 #include <linux/compiler.h>
220 #include <linux/interrupt.h>
221 #include <linux/circ_buf.h>
222 #include <linux/spinlock.h>
223 #include <linux/sched.h>
224 #include <linux/tty.h>
225 #include <linux/mutex.h>
226 #include <linux/sysrq.h>
227 #include <linux/pps_kernel.h>
230 struct serial_struct;
234 * This structure describes all the operations that can be
235 * done on the physical hardware.
238 unsigned int (*tx_empty)(struct uart_port *);
239 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
240 unsigned int (*get_mctrl)(struct uart_port *);
241 void (*stop_tx)(struct uart_port *);
242 void (*start_tx)(struct uart_port *);
243 void (*send_xchar)(struct uart_port *, char ch);
244 void (*stop_rx)(struct uart_port *);
245 void (*enable_ms)(struct uart_port *);
246 void (*break_ctl)(struct uart_port *, int ctl);
247 int (*startup)(struct uart_port *);
248 void (*shutdown)(struct uart_port *);
249 void (*flush_buffer)(struct uart_port *);
250 void (*set_termios)(struct uart_port *, struct ktermios *new,
251 struct ktermios *old);
252 void (*set_ldisc)(struct uart_port *, int new);
253 void (*pm)(struct uart_port *, unsigned int state,
254 unsigned int oldstate);
255 int (*set_wake)(struct uart_port *, unsigned int state);
258 * Return a string describing the type of the port
260 const char *(*type)(struct uart_port *);
263 * Release IO and memory resources used by the port.
264 * This includes iounmap if necessary.
266 void (*release_port)(struct uart_port *);
269 * Request IO and memory resources used by the port.
270 * This includes iomapping the port if necessary.
272 int (*request_port)(struct uart_port *);
273 void (*config_port)(struct uart_port *, int);
274 int (*verify_port)(struct uart_port *, struct serial_struct *);
275 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
276 #ifdef CONFIG_CONSOLE_POLL
277 void (*poll_put_char)(struct uart_port *, unsigned char);
278 int (*poll_get_char)(struct uart_port *);
282 #define NO_POLL_CHAR 0x00ff0000
283 #define UART_CONFIG_TYPE (1 << 0)
284 #define UART_CONFIG_IRQ (1 << 1)
300 typedef unsigned int __bitwise__ upf_t;
303 spinlock_t lock; /* port lock */
304 unsigned long iobase; /* in/out[bwl] */
305 unsigned char __iomem *membase; /* read/write[bwl] */
306 unsigned int (*serial_in)(struct uart_port *, int);
307 void (*serial_out)(struct uart_port *, int, int);
308 void (*set_termios)(struct uart_port *,
309 struct ktermios *new,
310 struct ktermios *old);
311 int (*handle_irq)(struct uart_port *);
312 void (*pm)(struct uart_port *, unsigned int state,
314 void (*handle_break)(struct uart_port *);
315 unsigned int irq; /* irq number */
316 unsigned long irqflags; /* irq flags */
317 unsigned int uartclk; /* base uart clock */
318 unsigned int fifosize; /* tx fifo size */
319 unsigned char x_char; /* xon/xoff char */
320 unsigned char regshift; /* reg offset shift */
321 unsigned char iotype; /* io access style */
322 unsigned char unused1;
324 #define UPIO_PORT (0)
325 #define UPIO_HUB6 (1)
327 #define UPIO_MEM32 (3)
328 #define UPIO_AU (4) /* Au1x00 type IO */
329 #define UPIO_TSI (5) /* Tsi108/109 type IO */
330 #define UPIO_RM9000 (6) /* RM9000 type IO */
332 unsigned int read_status_mask; /* driver specific */
333 unsigned int ignore_status_mask; /* driver specific */
334 struct uart_state *state; /* pointer to parent state */
335 struct uart_icount icount; /* statistics */
337 struct console *cons; /* struct console, if any */
338 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
339 unsigned long sysrq; /* sysrq timeout */
344 #define UPF_FOURPORT ((__force upf_t) (1 << 1))
345 #define UPF_SAK ((__force upf_t) (1 << 2))
346 #define UPF_SPD_MASK ((__force upf_t) (0x1030))
347 #define UPF_SPD_HI ((__force upf_t) (0x0010))
348 #define UPF_SPD_VHI ((__force upf_t) (0x0020))
349 #define UPF_SPD_CUST ((__force upf_t) (0x0030))
350 #define UPF_SPD_SHI ((__force upf_t) (0x1000))
351 #define UPF_SPD_WARP ((__force upf_t) (0x1010))
352 #define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
353 #define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
354 #define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
355 #define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
356 #define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
357 #define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15))
358 #define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
359 #define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
360 #define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
361 #define UPF_EXAR_EFR ((__force upf_t) (1 << 25))
362 #define UPF_BUG_THRE ((__force upf_t) (1 << 26))
363 /* The exact UART type is known and should not be probed. */
364 #define UPF_FIXED_TYPE ((__force upf_t) (1 << 27))
365 #define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
366 #define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
367 #define UPF_DEAD ((__force upf_t) (1 << 30))
368 #define UPF_IOREMAP ((__force upf_t) (1 << 31))
370 #define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
371 #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
373 unsigned int mctrl; /* current modem ctrl settings */
374 unsigned int timeout; /* character-based timeout */
375 unsigned int type; /* port type */
376 const struct uart_ops *ops;
377 unsigned int custom_divisor;
378 unsigned int line; /* port index */
379 resource_size_t mapbase; /* for ioremap */
380 struct device *dev; /* parent device */
381 unsigned char hub6; /* this should be in the 8250 driver */
382 unsigned char suspended;
383 unsigned char irq_wake;
384 unsigned char unused[2];
385 void *private_data; /* generic platform data pointer */
388 static inline int serial_port_in(struct uart_port *up, int offset)
390 return up->serial_in(up, offset);
393 static inline void serial_port_out(struct uart_port *up, int offset, int value)
395 up->serial_out(up, offset, value);
399 * This is the state information which is persistent across opens.
402 struct tty_port port;
405 struct circ_buf xmit;
407 struct uart_port *uart_port;
410 #define UART_XMIT_SIZE PAGE_SIZE
413 /* number of characters left in xmit buffer before we ask for more */
414 #define WAKEUP_CHARS 256
420 struct module *owner;
421 const char *driver_name;
422 const char *dev_name;
426 struct console *cons;
429 * these are private; the low level driver should not
430 * touch these; they should be initialised to NULL
432 struct uart_state *state;
433 struct tty_driver *tty_driver;
436 void uart_write_wakeup(struct uart_port *port);
441 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
443 unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
444 struct ktermios *old, unsigned int min,
446 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
448 /* Base timer interval for polling */
449 static inline int uart_poll_timeout(struct uart_port *port)
451 int timeout = port->timeout;
453 return timeout > 6 ? (timeout / 2 - 2) : 1;
459 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
461 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
463 int uart_set_options(struct uart_port *port, struct console *co, int baud,
464 int parity, int bits, int flow);
465 struct tty_driver *uart_console_device(struct console *co, int *index);
466 void uart_console_write(struct uart_port *port, const char *s,
468 void (*putchar)(struct uart_port *, int));
471 * Port/driver registration/removal
473 int uart_register_driver(struct uart_driver *uart);
474 void uart_unregister_driver(struct uart_driver *uart);
475 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
476 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
477 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
482 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
483 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
485 #define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
486 #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
488 #define uart_circ_chars_pending(circ) \
489 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
491 #define uart_circ_chars_free(circ) \
492 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
494 static inline int uart_tx_stopped(struct uart_port *port)
496 struct tty_struct *tty = port->state->port.tty;
497 if(tty->stopped || tty->hw_stopped)
503 * The following are helper functions for the low level drivers.
506 extern void uart_handle_dcd_change(struct uart_port *uport,
507 unsigned int status);
508 extern void uart_handle_cts_change(struct uart_port *uport,
509 unsigned int status);
511 extern void uart_insert_char(struct uart_port *port, unsigned int status,
512 unsigned int overrun, unsigned int ch, unsigned int flag);
516 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
519 if (ch && time_before(jiffies, port->sysrq)) {
529 #define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
533 * We do the SysRQ and SAK checking like this...
535 static inline int uart_handle_break(struct uart_port *port)
537 struct uart_state *state = port->state;
539 if (port->handle_break)
540 port->handle_break(port);
543 if (port->cons && port->cons->index == port->line) {
545 port->sysrq = jiffies + HZ*5;
551 if (port->flags & UPF_SAK)
552 do_SAK(state->port.tty);
557 * UART_ENABLE_MS - determine if port should enable modem status irqs
559 #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
560 (cflag) & CRTSCTS || \
565 #endif /* LINUX_SERIAL_CORE_H */