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_MAX_8250 18 /* max port ID */
50 * ARM specific type numbers. These are not currently guaranteed
51 * to be implemented, and will change in the future. These are
52 * separate so any additions to the old serial.c that occur before
53 * we are merged can be easily merged here.
57 #define PORT_CLPS711X 33
58 #define PORT_SA1100 34
59 #define PORT_UART00 35
62 /* Sparc type numbers. */
63 #define PORT_SUNZILOG 38
64 #define PORT_SUNSAB 39
70 /* Parisc type numbers. */
73 /* Atmel AT91 / AT32 SoC */
76 /* Macintosh Zilog type numbers */
77 #define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
78 #define PORT_PMAC_ZILOG 51
85 /* Samsung S3C2410 SoC and derivatives thereof */
86 #define PORT_S3C2410 55
88 /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
89 #define PORT_IP22ZILOG 56
91 /* Sharp LH7a40x -- an ARM9 SoC series */
92 #define PORT_LH7A40X 57
94 /* PPC CPM type number */
97 /* MPC52xx type numbers */
98 #define PORT_MPC52xx 59
103 /* Samsung S3C2440 SoC */
104 #define PORT_S3C2440 61
106 /* Motorola i.MX SoC */
112 /* TXX9 type number */
115 /* NEC VR4100 series SIU/DSIU */
116 #define PORT_VR41XX_SIU 65
117 #define PORT_VR41XX_DSIU 66
119 /* Samsung S3C2400 SoC */
120 #define PORT_S3C2400 67
123 #define PORT_M32R_SIO 68
128 #define PORT_PNX8XXX 70
133 /* SUN4V Hypervisor Console */
134 #define PORT_SUNHV 72
136 #define PORT_S3C2412 73
138 /* Xilinx uartlite */
139 #define PORT_UARTLITE 74
145 #define PORT_KS8695 76
147 /* Broadcom SB1250, etc. SOC */
148 #define PORT_SB1250_DUART 77
150 /* Freescale ColdFire */
154 #define PORT_BFIN_SPORT 79
156 /* MN10300 on-chip UART numbers */
157 #define PORT_MN10300 80
158 #define PORT_MN10300_CTS 81
160 #define PORT_SC26XX 82
163 #define PORT_SCIFA 83
165 #define PORT_S3C6400 84
168 #define PORT_NWPSERIAL 85
171 #define PORT_MAX3100 86
173 /* Timberdale UART */
174 #define PORT_TIMBUART 87
176 /* Qualcomm MSM SoCs */
179 /* BCM63xx family SoCs */
180 #define PORT_BCM63XX 89
182 /* Aeroflex Gaisler GRLIB APBUART */
183 #define PORT_APBUART 90
186 #define PORT_ALTERA_JTAGUART 91
187 #define PORT_ALTERA_UART 92
190 #define PORT_MAX3107 94
195 #include <linux/compiler.h>
196 #include <linux/interrupt.h>
197 #include <linux/circ_buf.h>
198 #include <linux/spinlock.h>
199 #include <linux/sched.h>
200 #include <linux/tty.h>
201 #include <linux/mutex.h>
202 #include <linux/sysrq.h>
205 struct serial_struct;
209 * This structure describes all the operations that can be
210 * done on the physical hardware.
213 unsigned int (*tx_empty)(struct uart_port *);
214 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
215 unsigned int (*get_mctrl)(struct uart_port *);
216 void (*stop_tx)(struct uart_port *);
217 void (*start_tx)(struct uart_port *);
218 void (*send_xchar)(struct uart_port *, char ch);
219 void (*stop_rx)(struct uart_port *);
220 void (*enable_ms)(struct uart_port *);
221 void (*break_ctl)(struct uart_port *, int ctl);
222 int (*startup)(struct uart_port *);
223 void (*shutdown)(struct uart_port *);
224 void (*flush_buffer)(struct uart_port *);
225 void (*set_termios)(struct uart_port *, struct ktermios *new,
226 struct ktermios *old);
227 void (*set_ldisc)(struct uart_port *, int new);
228 void (*pm)(struct uart_port *, unsigned int state,
229 unsigned int oldstate);
230 int (*set_wake)(struct uart_port *, unsigned int state);
233 * Return a string describing the type of the port
235 const char *(*type)(struct uart_port *);
238 * Release IO and memory resources used by the port.
239 * This includes iounmap if necessary.
241 void (*release_port)(struct uart_port *);
244 * Request IO and memory resources used by the port.
245 * This includes iomapping the port if necessary.
247 int (*request_port)(struct uart_port *);
248 void (*config_port)(struct uart_port *, int);
249 int (*verify_port)(struct uart_port *, struct serial_struct *);
250 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
251 #ifdef CONFIG_CONSOLE_POLL
252 void (*poll_put_char)(struct uart_port *, unsigned char);
253 int (*poll_get_char)(struct uart_port *);
257 #define NO_POLL_CHAR 0x00ff0000
258 #define UART_CONFIG_TYPE (1 << 0)
259 #define UART_CONFIG_IRQ (1 << 1)
275 typedef unsigned int __bitwise__ upf_t;
278 spinlock_t lock; /* port lock */
279 unsigned long iobase; /* in/out[bwl] */
280 unsigned char __iomem *membase; /* read/write[bwl] */
281 unsigned int (*serial_in)(struct uart_port *, int);
282 void (*serial_out)(struct uart_port *, int, int);
283 unsigned int irq; /* irq number */
284 unsigned long irqflags; /* irq flags */
285 unsigned int uartclk; /* base uart clock */
286 unsigned int fifosize; /* tx fifo size */
287 unsigned char x_char; /* xon/xoff char */
288 unsigned char regshift; /* reg offset shift */
289 unsigned char iotype; /* io access style */
290 unsigned char unused1;
292 #define UPIO_PORT (0)
293 #define UPIO_HUB6 (1)
295 #define UPIO_MEM32 (3)
296 #define UPIO_AU (4) /* Au1x00 type IO */
297 #define UPIO_TSI (5) /* Tsi108/109 type IO */
298 #define UPIO_DWAPB (6) /* DesignWare APB UART */
299 #define UPIO_RM9000 (7) /* RM9000 type IO */
301 unsigned int read_status_mask; /* driver specific */
302 unsigned int ignore_status_mask; /* driver specific */
303 struct uart_state *state; /* pointer to parent state */
304 struct uart_icount icount; /* statistics */
306 struct console *cons; /* struct console, if any */
307 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
308 unsigned long sysrq; /* sysrq timeout */
313 #define UPF_FOURPORT ((__force upf_t) (1 << 1))
314 #define UPF_SAK ((__force upf_t) (1 << 2))
315 #define UPF_SPD_MASK ((__force upf_t) (0x1030))
316 #define UPF_SPD_HI ((__force upf_t) (0x0010))
317 #define UPF_SPD_VHI ((__force upf_t) (0x0020))
318 #define UPF_SPD_CUST ((__force upf_t) (0x0030))
319 #define UPF_SPD_SHI ((__force upf_t) (0x1000))
320 #define UPF_SPD_WARP ((__force upf_t) (0x1010))
321 #define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
322 #define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
323 #define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
324 #define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
325 #define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
326 #define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15))
327 #define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
328 #define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
329 #define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
330 /* The exact UART type is known and should not be probed. */
331 #define UPF_FIXED_TYPE ((__force upf_t) (1 << 27))
332 #define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
333 #define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
334 #define UPF_DEAD ((__force upf_t) (1 << 30))
335 #define UPF_IOREMAP ((__force upf_t) (1 << 31))
337 #define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
338 #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
340 unsigned int mctrl; /* current modem ctrl settings */
341 unsigned int timeout; /* character-based timeout */
342 unsigned int type; /* port type */
343 const struct uart_ops *ops;
344 unsigned int custom_divisor;
345 unsigned int line; /* port index */
346 resource_size_t mapbase; /* for ioremap */
347 struct device *dev; /* parent device */
348 unsigned char hub6; /* this should be in the 8250 driver */
349 unsigned char suspended;
350 unsigned char unused[2];
351 void *private_data; /* generic platform data pointer */
355 * This is the state information which is persistent across opens.
358 struct tty_port port;
361 struct circ_buf xmit;
363 struct tasklet_struct tlet;
364 struct uart_port *uart_port;
367 #define UART_XMIT_SIZE PAGE_SIZE
370 /* number of characters left in xmit buffer before we ask for more */
371 #define WAKEUP_CHARS 256
377 struct module *owner;
378 const char *driver_name;
379 const char *dev_name;
383 struct console *cons;
386 * these are private; the low level driver should not
387 * touch these; they should be initialised to NULL
389 struct uart_state *state;
390 struct tty_driver *tty_driver;
393 void uart_write_wakeup(struct uart_port *port);
398 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
400 unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
401 struct ktermios *old, unsigned int min,
403 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
408 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
410 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
412 int uart_set_options(struct uart_port *port, struct console *co, int baud,
413 int parity, int bits, int flow);
414 struct tty_driver *uart_console_device(struct console *co, int *index);
415 void uart_console_write(struct uart_port *port, const char *s,
417 void (*putchar)(struct uart_port *, int));
420 * Port/driver registration/removal
422 int uart_register_driver(struct uart_driver *uart);
423 void uart_unregister_driver(struct uart_driver *uart);
424 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
425 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
426 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
431 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
432 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
434 #define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
435 #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
437 #define uart_circ_chars_pending(circ) \
438 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
440 #define uart_circ_chars_free(circ) \
441 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
443 static inline int uart_tx_stopped(struct uart_port *port)
445 struct tty_struct *tty = port->state->port.tty;
446 if(tty->stopped || tty->hw_stopped)
452 * The following are helper functions for the low level drivers.
455 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
459 if (ch && time_before(jiffies, port->sysrq)) {
460 handle_sysrq(ch, port->state->port.tty);
469 #ifndef SUPPORT_SYSRQ
470 #define uart_handle_sysrq_char(port,ch) uart_handle_sysrq_char(port, 0)
474 * We do the SysRQ and SAK checking like this...
476 static inline int uart_handle_break(struct uart_port *port)
478 struct uart_state *state = port->state;
480 if (port->cons && port->cons->index == port->line) {
482 port->sysrq = jiffies + HZ*5;
488 if (port->flags & UPF_SAK)
489 do_SAK(state->port.tty);
494 * uart_handle_dcd_change - handle a change of carrier detect state
495 * @uport: uart_port structure for the open port
496 * @status: new carrier detect status, nonzero if active
499 uart_handle_dcd_change(struct uart_port *uport, unsigned int status)
501 struct uart_state *state = uport->state;
502 struct tty_port *port = &state->port;
503 struct tty_ldisc *ld = tty_ldisc_ref(port->tty);
506 if (ld && ld->ops->dcd_change)
510 #ifdef CONFIG_HARD_PPS
511 if ((uport->flags & UPF_HARDPPS_CD) && status)
515 if (port->flags & ASYNC_CHECK_CD) {
517 wake_up_interruptible(&port->open_wait);
519 tty_hangup(port->tty);
522 if (ld && ld->ops->dcd_change)
523 ld->ops->dcd_change(port->tty, status, &ts);
529 * uart_handle_cts_change - handle a change of clear-to-send state
530 * @uport: uart_port structure for the open port
531 * @status: new clear to send status, nonzero if active
534 uart_handle_cts_change(struct uart_port *uport, unsigned int status)
536 struct tty_port *port = &uport->state->port;
537 struct tty_struct *tty = port->tty;
541 if (port->flags & ASYNC_CTS_FLOW) {
542 if (tty->hw_stopped) {
545 uport->ops->start_tx(uport);
546 uart_write_wakeup(uport);
551 uport->ops->stop_tx(uport);
557 #include <linux/tty_flip.h>
560 uart_insert_char(struct uart_port *port, unsigned int status,
561 unsigned int overrun, unsigned int ch, unsigned int flag)
563 struct tty_struct *tty = port->state->port.tty;
565 if ((status & port->ignore_status_mask & ~overrun) == 0)
566 tty_insert_flip_char(tty, ch, flag);
569 * Overrun is special. Since it's reported immediately,
570 * it doesn't affect the current character.
572 if (status & ~port->ignore_status_mask & overrun)
573 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
577 * UART_ENABLE_MS - determine if port should enable modem status irqs
579 #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
580 (cflag) & CRTSCTS || \
585 #endif /* LINUX_SERIAL_CORE_H */