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_MAX_8250 20 /* max port ID */
52 * ARM specific type numbers. These are not currently guaranteed
53 * to be implemented, and will change in the future. These are
54 * separate so any additions to the old serial.c that occur before
55 * we are merged can be easily merged here.
59 #define PORT_CLPS711X 33
60 #define PORT_SA1100 34
61 #define PORT_UART00 35
64 /* Sparc type numbers. */
65 #define PORT_SUNZILOG 38
66 #define PORT_SUNSAB 39
72 /* Parisc type numbers. */
75 /* Atmel AT91 / AT32 SoC */
78 /* Macintosh Zilog type numbers */
79 #define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
80 #define PORT_PMAC_ZILOG 51
87 /* Samsung S3C2410 SoC and derivatives thereof */
88 #define PORT_S3C2410 55
90 /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
91 #define PORT_IP22ZILOG 56
93 /* Sharp LH7a40x -- an ARM9 SoC series */
94 #define PORT_LH7A40X 57
96 /* PPC CPM type number */
99 /* MPC52xx (and MPC512x) type numbers */
100 #define PORT_MPC52xx 59
105 /* Samsung S3C2440 SoC */
106 #define PORT_S3C2440 61
108 /* Motorola i.MX SoC */
114 /* TXX9 type number */
117 /* NEC VR4100 series SIU/DSIU */
118 #define PORT_VR41XX_SIU 65
119 #define PORT_VR41XX_DSIU 66
121 /* Samsung S3C2400 SoC */
122 #define PORT_S3C2400 67
125 #define PORT_M32R_SIO 68
130 #define PORT_PNX8XXX 70
135 /* SUN4V Hypervisor Console */
136 #define PORT_SUNHV 72
138 #define PORT_S3C2412 73
140 /* Xilinx uartlite */
141 #define PORT_UARTLITE 74
147 #define PORT_KS8695 76
149 /* Broadcom SB1250, etc. SOC */
150 #define PORT_SB1250_DUART 77
152 /* Freescale ColdFire */
156 #define PORT_BFIN_SPORT 79
158 /* MN10300 on-chip UART numbers */
159 #define PORT_MN10300 80
160 #define PORT_MN10300_CTS 81
162 #define PORT_SC26XX 82
165 #define PORT_SCIFA 83
167 #define PORT_S3C6400 84
170 #define PORT_NWPSERIAL 85
173 #define PORT_MAX3100 86
175 /* Timberdale UART */
176 #define PORT_TIMBUART 87
178 /* Qualcomm MSM SoCs */
181 /* BCM63xx family SoCs */
182 #define PORT_BCM63XX 89
184 #define PORT_RK2818 90
188 /* Aeroflex Gaisler GRLIB APBUART */
189 #define PORT_APBUART 90
192 #define PORT_ALTERA_JTAGUART 91
193 #define PORT_ALTERA_UART 92
196 #define PORT_SCIFB 93
199 #define PORT_MAX3107 94
201 /* High Speed UART for Medfield */
208 #define PORT_VT8500 97
210 /* Xilinx PSS UART */
211 #define PORT_XUARTPS 98
215 #include <linux/compiler.h>
216 #include <linux/interrupt.h>
217 #include <linux/circ_buf.h>
218 #include <linux/spinlock.h>
219 #include <linux/sched.h>
220 #include <linux/tty.h>
221 #include <linux/mutex.h>
222 #include <linux/sysrq.h>
223 #include <linux/pps_kernel.h>
226 struct serial_struct;
230 * This structure describes all the operations that can be
231 * done on the physical hardware.
234 unsigned int (*tx_empty)(struct uart_port *);
235 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
236 unsigned int (*get_mctrl)(struct uart_port *);
237 void (*stop_tx)(struct uart_port *);
238 void (*start_tx)(struct uart_port *);
239 void (*send_xchar)(struct uart_port *, char ch);
240 void (*stop_rx)(struct uart_port *);
241 void (*enable_ms)(struct uart_port *);
242 void (*break_ctl)(struct uart_port *, int ctl);
243 int (*startup)(struct uart_port *);
244 void (*shutdown)(struct uart_port *);
245 void (*flush_buffer)(struct uart_port *);
246 void (*set_termios)(struct uart_port *, struct ktermios *new,
247 struct ktermios *old);
248 void (*set_ldisc)(struct uart_port *, int new);
249 void (*pm)(struct uart_port *, unsigned int state,
250 unsigned int oldstate);
251 int (*set_wake)(struct uart_port *, unsigned int state);
252 void (*wake_peer)(struct uart_port *);
255 * Return a string describing the type of the port
257 const char *(*type)(struct uart_port *);
260 * Release IO and memory resources used by the port.
261 * This includes iounmap if necessary.
263 void (*release_port)(struct uart_port *);
266 * Request IO and memory resources used by the port.
267 * This includes iomapping the port if necessary.
269 int (*request_port)(struct uart_port *);
270 void (*config_port)(struct uart_port *, int);
271 int (*verify_port)(struct uart_port *, struct serial_struct *);
272 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
273 #ifdef CONFIG_CONSOLE_POLL
274 void (*poll_put_char)(struct uart_port *, unsigned char);
275 int (*poll_get_char)(struct uart_port *);
279 #define NO_POLL_CHAR 0x00ff0000
280 #define UART_CONFIG_TYPE (1 << 0)
281 #define UART_CONFIG_IRQ (1 << 1)
297 typedef unsigned int __bitwise__ upf_t;
300 spinlock_t lock; /* port lock */
301 unsigned long iobase; /* in/out[bwl] */
302 unsigned char __iomem *membase; /* read/write[bwl] */
303 unsigned int (*serial_in)(struct uart_port *, int);
304 void (*serial_out)(struct uart_port *, int, int);
305 void (*set_termios)(struct uart_port *,
306 struct ktermios *new,
307 struct ktermios *old);
308 void (*pm)(struct uart_port *, unsigned int state,
310 unsigned int irq; /* irq number */
311 unsigned long irqflags; /* irq flags */
312 unsigned int uartclk; /* base uart clock */
313 unsigned int fifosize; /* tx fifo size */
314 unsigned char x_char; /* xon/xoff char */
315 unsigned char regshift; /* reg offset shift */
316 unsigned char iotype; /* io access style */
317 unsigned char unused1;
319 #define UPIO_PORT (0)
320 #define UPIO_HUB6 (1)
322 #define UPIO_MEM32 (3)
323 #define UPIO_AU (4) /* Au1x00 type IO */
324 #define UPIO_TSI (5) /* Tsi108/109 type IO */
325 #define UPIO_DWAPB (6) /* DesignWare APB UART */
326 #define UPIO_RM9000 (7) /* RM9000 type IO */
327 #define UPIO_DWAPB32 (8) /* DesignWare APB UART (32 bit accesses) */
329 unsigned int read_status_mask; /* driver specific */
330 unsigned int ignore_status_mask; /* driver specific */
331 struct uart_state *state; /* pointer to parent state */
332 struct uart_icount icount; /* statistics */
334 struct console *cons; /* struct console, if any */
335 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
336 unsigned long sysrq; /* sysrq timeout */
341 #define UPF_FOURPORT ((__force upf_t) (1 << 1))
342 #define UPF_SAK ((__force upf_t) (1 << 2))
343 #define UPF_SPD_MASK ((__force upf_t) (0x1030))
344 #define UPF_SPD_HI ((__force upf_t) (0x0010))
345 #define UPF_SPD_VHI ((__force upf_t) (0x0020))
346 #define UPF_SPD_CUST ((__force upf_t) (0x0030))
347 #define UPF_SPD_SHI ((__force upf_t) (0x1000))
348 #define UPF_SPD_WARP ((__force upf_t) (0x1010))
349 #define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
350 #define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
351 #define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
352 #define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
353 #define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
354 #define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15))
355 #define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
356 #define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
357 #define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
358 /* The exact UART type is known and should not be probed. */
359 #define UPF_FIXED_TYPE ((__force upf_t) (1 << 27))
360 #define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
361 #define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
362 #define UPF_DEAD ((__force upf_t) (1 << 30))
363 #define UPF_IOREMAP ((__force upf_t) (1 << 31))
365 #define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
366 #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
368 unsigned int mctrl; /* current modem ctrl settings */
369 unsigned int timeout; /* character-based timeout */
370 unsigned int type; /* port type */
371 const struct uart_ops *ops;
372 unsigned int custom_divisor;
373 unsigned int line; /* port index */
374 resource_size_t mapbase; /* for ioremap */
375 struct device *dev; /* parent device */
376 unsigned char hub6; /* this should be in the 8250 driver */
377 unsigned char suspended;
378 unsigned char irq_wake;
379 unsigned char unused[2];
380 void *private_data; /* generic platform data pointer */
384 * This is the state information which is persistent across opens.
387 struct tty_port port;
390 struct circ_buf xmit;
392 struct tasklet_struct tlet;
393 struct uart_port *uart_port;
396 #define UART_XMIT_SIZE PAGE_SIZE
399 /* number of characters left in xmit buffer before we ask for more */
400 #define WAKEUP_CHARS 256
406 struct module *owner;
407 const char *driver_name;
408 const char *dev_name;
412 struct console *cons;
415 * these are private; the low level driver should not
416 * touch these; they should be initialised to NULL
418 struct uart_state *state;
419 struct tty_driver *tty_driver;
422 void uart_write_wakeup(struct uart_port *port);
427 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
429 unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
430 struct ktermios *old, unsigned int min,
432 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
434 /* Base timer interval for polling */
435 static inline int uart_poll_timeout(struct uart_port *port)
437 int timeout = port->timeout;
439 return timeout > 6 ? (timeout / 2 - 2) : 1;
445 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
447 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
449 int uart_set_options(struct uart_port *port, struct console *co, int baud,
450 int parity, int bits, int flow);
451 struct tty_driver *uart_console_device(struct console *co, int *index);
452 void uart_console_write(struct uart_port *port, const char *s,
454 void (*putchar)(struct uart_port *, int));
457 * Port/driver registration/removal
459 int uart_register_driver(struct uart_driver *uart);
460 void uart_unregister_driver(struct uart_driver *uart);
461 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
462 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
463 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
468 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
469 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
471 #define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
472 #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
474 #define uart_circ_chars_pending(circ) \
475 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
477 #define uart_circ_chars_free(circ) \
478 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
480 static inline int uart_tx_stopped(struct uart_port *port)
482 struct tty_struct *tty = port->state->port.tty;
483 if(tty->stopped || tty->hw_stopped)
489 * The following are helper functions for the low level drivers.
492 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
496 if (ch && time_before(jiffies, port->sysrq)) {
506 #ifndef SUPPORT_SYSRQ
507 #define uart_handle_sysrq_char(port,ch) uart_handle_sysrq_char(port, 0)
511 * We do the SysRQ and SAK checking like this...
513 static inline int uart_handle_break(struct uart_port *port)
515 struct uart_state *state = port->state;
517 if (port->cons && port->cons->index == port->line) {
519 port->sysrq = jiffies + HZ*5;
525 if (port->flags & UPF_SAK)
526 do_SAK(state->port.tty);
531 * uart_handle_dcd_change - handle a change of carrier detect state
532 * @uport: uart_port structure for the open port
533 * @status: new carrier detect status, nonzero if active
536 uart_handle_dcd_change(struct uart_port *uport, unsigned int status)
538 struct uart_state *state = uport->state;
539 struct tty_port *port = &state->port;
540 struct tty_ldisc *ld = tty_ldisc_ref(port->tty);
541 struct pps_event_time ts;
543 if (ld && ld->ops->dcd_change)
547 #ifdef CONFIG_HARD_PPS
548 if ((uport->flags & UPF_HARDPPS_CD) && status)
552 if (port->flags & ASYNC_CHECK_CD) {
554 wake_up_interruptible(&port->open_wait);
556 tty_hangup(port->tty);
559 if (ld && ld->ops->dcd_change)
560 ld->ops->dcd_change(port->tty, status, &ts);
566 * uart_handle_cts_change - handle a change of clear-to-send state
567 * @uport: uart_port structure for the open port
568 * @status: new clear to send status, nonzero if active
571 uart_handle_cts_change(struct uart_port *uport, unsigned int status)
573 struct tty_port *port = &uport->state->port;
574 struct tty_struct *tty = port->tty;
578 if (port->flags & ASYNC_CTS_FLOW) {
579 if (tty->hw_stopped) {
582 uport->ops->start_tx(uport);
583 uart_write_wakeup(uport);
588 uport->ops->stop_tx(uport);
594 #include <linux/tty_flip.h>
597 uart_insert_char(struct uart_port *port, unsigned int status,
598 unsigned int overrun, unsigned int ch, unsigned int flag)
600 struct tty_struct *tty = port->state->port.tty;
602 if ((status & port->ignore_status_mask & ~overrun) == 0)
603 tty_insert_flip_char(tty, ch, flag);
606 * Overrun is special. Since it's reported immediately,
607 * it doesn't affect the current character.
609 if (status & ~port->ignore_status_mask & overrun)
610 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
614 * UART_ENABLE_MS - determine if port should enable modem status irqs
616 #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
617 (cflag) & CRTSCTS || \
622 #endif /* LINUX_SERIAL_CORE_H */