ia64/kvm: compilation fix. export account_system_vtime.
[pv_ops_mirror.git] / include / linux / serial_core.h
blobd32123ae08adbc9a7ed70613c97be128d0bb5c15
1 /*
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
24 * The type definitions. These are from Ted Ts'o's serial.h
26 #define PORT_UNKNOWN 0
27 #define PORT_8250 1
28 #define PORT_16450 2
29 #define PORT_16550 3
30 #define PORT_16550A 4
31 #define PORT_CIRRUS 5
32 #define PORT_16650 6
33 #define PORT_16650V2 7
34 #define PORT_16750 8
35 #define PORT_STARTECH 9
36 #define PORT_16C950 10
37 #define PORT_16654 11
38 #define PORT_16850 12
39 #define PORT_RSA 13
40 #define PORT_NS16550A 14
41 #define PORT_XSCALE 15
42 #define PORT_RM9000 16 /* PMC-Sierra RM9xxx internal UART */
43 #define PORT_MAX_8250 16 /* max port ID */
46 * ARM specific type numbers. These are not currently guaranteed
47 * to be implemented, and will change in the future. These are
48 * separate so any additions to the old serial.c that occur before
49 * we are merged can be easily merged here.
51 #define PORT_PXA 31
52 #define PORT_AMBA 32
53 #define PORT_CLPS711X 33
54 #define PORT_SA1100 34
55 #define PORT_UART00 35
56 #define PORT_21285 37
58 /* Sparc type numbers. */
59 #define PORT_SUNZILOG 38
60 #define PORT_SUNSAB 39
62 /* NEC v850. */
63 #define PORT_V850E_UART 40
65 /* DEC */
66 #define PORT_DZ 46
67 #define PORT_ZS 47
69 /* Parisc type numbers. */
70 #define PORT_MUX 48
72 /* Atmel AT91 / AT32 SoC */
73 #define PORT_ATMEL 49
75 /* Macintosh Zilog type numbers */
76 #define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
77 #define PORT_PMAC_ZILOG 51
79 /* SH-SCI */
80 #define PORT_SCI 52
81 #define PORT_SCIF 53
82 #define PORT_IRDA 54
84 /* Samsung S3C2410 SoC and derivatives thereof */
85 #define PORT_S3C2410 55
87 /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
88 #define PORT_IP22ZILOG 56
90 /* Sharp LH7a40x -- an ARM9 SoC series */
91 #define PORT_LH7A40X 57
93 /* PPC CPM type number */
94 #define PORT_CPM 58
96 /* MPC52xx type numbers */
97 #define PORT_MPC52xx 59
99 /* IBM icom */
100 #define PORT_ICOM 60
102 /* Samsung S3C2440 SoC */
103 #define PORT_S3C2440 61
105 /* Motorola i.MX SoC */
106 #define PORT_IMX 62
108 /* Marvell MPSC */
109 #define PORT_MPSC 63
111 /* TXX9 type number */
112 #define PORT_TXX9 64
114 /* NEC VR4100 series SIU/DSIU */
115 #define PORT_VR41XX_SIU 65
116 #define PORT_VR41XX_DSIU 66
118 /* Samsung S3C2400 SoC */
119 #define PORT_S3C2400 67
121 /* M32R SIO */
122 #define PORT_M32R_SIO 68
124 /*Digi jsm */
125 #define PORT_JSM 69
127 #define PORT_PNX8XXX 70
129 /* Hilscher netx */
130 #define PORT_NETX 71
132 /* SUN4V Hypervisor Console */
133 #define PORT_SUNHV 72
135 #define PORT_S3C2412 73
137 /* Xilinx uartlite */
138 #define PORT_UARTLITE 74
140 /* Blackfin bf5xx */
141 #define PORT_BFIN 75
143 /* Micrel KS8695 */
144 #define PORT_KS8695 76
146 /* Broadcom SB1250, etc. SOC */
147 #define PORT_SB1250_DUART 77
149 /* Freescale ColdFire */
150 #define PORT_MCF 78
152 /* Blackfin SPORT */
153 #define PORT_BFIN_SPORT 79
155 /* MN10300 on-chip UART numbers */
156 #define PORT_MN10300 80
157 #define PORT_MN10300_CTS 81
159 #define PORT_SC26XX 82
161 #ifdef __KERNEL__
163 #include <linux/compiler.h>
164 #include <linux/interrupt.h>
165 #include <linux/circ_buf.h>
166 #include <linux/spinlock.h>
167 #include <linux/sched.h>
168 #include <linux/tty.h>
169 #include <linux/mutex.h>
170 #include <linux/sysrq.h>
172 struct uart_port;
173 struct uart_info;
174 struct serial_struct;
175 struct device;
178 * This structure describes all the operations that can be
179 * done on the physical hardware.
181 struct uart_ops {
182 unsigned int (*tx_empty)(struct uart_port *);
183 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
184 unsigned int (*get_mctrl)(struct uart_port *);
185 void (*stop_tx)(struct uart_port *);
186 void (*start_tx)(struct uart_port *);
187 void (*send_xchar)(struct uart_port *, char ch);
188 void (*stop_rx)(struct uart_port *);
189 void (*enable_ms)(struct uart_port *);
190 void (*break_ctl)(struct uart_port *, int ctl);
191 int (*startup)(struct uart_port *);
192 void (*shutdown)(struct uart_port *);
193 void (*set_termios)(struct uart_port *, struct ktermios *new,
194 struct ktermios *old);
195 void (*pm)(struct uart_port *, unsigned int state,
196 unsigned int oldstate);
197 int (*set_wake)(struct uart_port *, unsigned int state);
200 * Return a string describing the type of the port
202 const char *(*type)(struct uart_port *);
205 * Release IO and memory resources used by the port.
206 * This includes iounmap if necessary.
208 void (*release_port)(struct uart_port *);
211 * Request IO and memory resources used by the port.
212 * This includes iomapping the port if necessary.
214 int (*request_port)(struct uart_port *);
215 void (*config_port)(struct uart_port *, int);
216 int (*verify_port)(struct uart_port *, struct serial_struct *);
217 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
218 #ifdef CONFIG_CONSOLE_POLL
219 void (*poll_put_char)(struct uart_port *, unsigned char);
220 int (*poll_get_char)(struct uart_port *);
221 #endif
224 #define UART_CONFIG_TYPE (1 << 0)
225 #define UART_CONFIG_IRQ (1 << 1)
227 struct uart_icount {
228 __u32 cts;
229 __u32 dsr;
230 __u32 rng;
231 __u32 dcd;
232 __u32 rx;
233 __u32 tx;
234 __u32 frame;
235 __u32 overrun;
236 __u32 parity;
237 __u32 brk;
238 __u32 buf_overrun;
241 typedef unsigned int __bitwise__ upf_t;
243 struct uart_port {
244 spinlock_t lock; /* port lock */
245 unsigned int iobase; /* in/out[bwl] */
246 unsigned char __iomem *membase; /* read/write[bwl] */
247 unsigned int irq; /* irq number */
248 unsigned int uartclk; /* base uart clock */
249 unsigned int fifosize; /* tx fifo size */
250 unsigned char x_char; /* xon/xoff char */
251 unsigned char regshift; /* reg offset shift */
252 unsigned char iotype; /* io access style */
253 unsigned char unused1;
255 #define UPIO_PORT (0)
256 #define UPIO_HUB6 (1)
257 #define UPIO_MEM (2)
258 #define UPIO_MEM32 (3)
259 #define UPIO_AU (4) /* Au1x00 type IO */
260 #define UPIO_TSI (5) /* Tsi108/109 type IO */
261 #define UPIO_DWAPB (6) /* DesignWare APB UART */
262 #define UPIO_RM9000 (7) /* RM9000 type IO */
264 unsigned int read_status_mask; /* driver specific */
265 unsigned int ignore_status_mask; /* driver specific */
266 struct uart_info *info; /* pointer to parent info */
267 struct uart_icount icount; /* statistics */
269 struct console *cons; /* struct console, if any */
270 #ifdef CONFIG_SERIAL_CORE_CONSOLE
271 unsigned long sysrq; /* sysrq timeout */
272 #endif
274 upf_t flags;
276 #define UPF_FOURPORT ((__force upf_t) (1 << 1))
277 #define UPF_SAK ((__force upf_t) (1 << 2))
278 #define UPF_SPD_MASK ((__force upf_t) (0x1030))
279 #define UPF_SPD_HI ((__force upf_t) (0x0010))
280 #define UPF_SPD_VHI ((__force upf_t) (0x0020))
281 #define UPF_SPD_CUST ((__force upf_t) (0x0030))
282 #define UPF_SPD_SHI ((__force upf_t) (0x1000))
283 #define UPF_SPD_WARP ((__force upf_t) (0x1010))
284 #define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
285 #define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
286 #define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
287 #define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
288 #define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
289 #define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
290 #define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
291 #define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
292 #define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
293 #define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
294 #define UPF_DEAD ((__force upf_t) (1 << 30))
295 #define UPF_IOREMAP ((__force upf_t) (1 << 31))
297 #define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
298 #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
300 unsigned int mctrl; /* current modem ctrl settings */
301 unsigned int timeout; /* character-based timeout */
302 unsigned int type; /* port type */
303 const struct uart_ops *ops;
304 unsigned int custom_divisor;
305 unsigned int line; /* port index */
306 resource_size_t mapbase; /* for ioremap */
307 struct device *dev; /* parent device */
308 unsigned char hub6; /* this should be in the 8250 driver */
309 unsigned char suspended;
310 unsigned char unused[2];
311 void *private_data; /* generic platform data pointer */
315 * This is the state information which is persistent across opens.
316 * The low level driver must not to touch any elements contained
317 * within.
319 struct uart_state {
320 unsigned int close_delay; /* msec */
321 unsigned int closing_wait; /* msec */
323 #define USF_CLOSING_WAIT_INF (0)
324 #define USF_CLOSING_WAIT_NONE (~0U)
326 int count;
327 int pm_state;
328 struct uart_info *info;
329 struct uart_port *port;
331 struct mutex mutex;
334 #define UART_XMIT_SIZE PAGE_SIZE
336 typedef unsigned int __bitwise__ uif_t;
339 * This is the state information which is only valid when the port
340 * is open; it may be freed by the core driver once the device has
341 * been closed. Either the low level driver or the core can modify
342 * stuff here.
344 struct uart_info {
345 struct tty_struct *tty;
346 struct circ_buf xmit;
347 uif_t flags;
350 * Definitions for info->flags. These are _private_ to serial_core, and
351 * are specific to this structure. They may be queried by low level drivers.
353 #define UIF_CHECK_CD ((__force uif_t) (1 << 25))
354 #define UIF_CTS_FLOW ((__force uif_t) (1 << 26))
355 #define UIF_NORMAL_ACTIVE ((__force uif_t) (1 << 29))
356 #define UIF_INITIALIZED ((__force uif_t) (1 << 31))
357 #define UIF_SUSPENDED ((__force uif_t) (1 << 30))
359 int blocked_open;
361 struct tasklet_struct tlet;
363 wait_queue_head_t open_wait;
364 wait_queue_head_t delta_msr_wait;
367 /* number of characters left in xmit buffer before we ask for more */
368 #define WAKEUP_CHARS 256
370 struct module;
371 struct tty_driver;
373 struct uart_driver {
374 struct module *owner;
375 const char *driver_name;
376 const char *dev_name;
377 int major;
378 int minor;
379 int nr;
380 struct console *cons;
383 * these are private; the low level driver should not
384 * touch these; they should be initialised to NULL
386 struct uart_state *state;
387 struct tty_driver *tty_driver;
390 void uart_write_wakeup(struct uart_port *port);
393 * Baud rate helpers.
395 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
396 unsigned int baud);
397 unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
398 struct ktermios *old, unsigned int min,
399 unsigned int max);
400 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
403 * Console helpers.
405 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
406 struct console *c);
407 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
408 int *flow);
409 int uart_set_options(struct uart_port *port, struct console *co, int baud,
410 int parity, int bits, int flow);
411 struct tty_driver *uart_console_device(struct console *co, int *index);
412 void uart_console_write(struct uart_port *port, const char *s,
413 unsigned int count,
414 void (*putchar)(struct uart_port *, int));
417 * Port/driver registration/removal
419 int uart_register_driver(struct uart_driver *uart);
420 void uart_unregister_driver(struct uart_driver *uart);
421 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
422 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
423 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
426 * Power Management
428 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
429 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
431 #define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
432 #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
434 #define uart_circ_chars_pending(circ) \
435 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
437 #define uart_circ_chars_free(circ) \
438 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
440 #define uart_tx_stopped(port) \
441 ((port)->info->tty->stopped || (port)->info->tty->hw_stopped)
444 * The following are helper functions for the low level drivers.
446 static inline int
447 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
449 #ifdef SUPPORT_SYSRQ
450 if (port->sysrq) {
451 if (ch && time_before(jiffies, port->sysrq)) {
452 handle_sysrq(ch, port->info ? port->info->tty : NULL);
453 port->sysrq = 0;
454 return 1;
456 port->sysrq = 0;
458 #endif
459 return 0;
461 #ifndef SUPPORT_SYSRQ
462 #define uart_handle_sysrq_char(port,ch) uart_handle_sysrq_char(port, 0)
463 #endif
466 * We do the SysRQ and SAK checking like this...
468 static inline int uart_handle_break(struct uart_port *port)
470 struct uart_info *info = port->info;
471 #ifdef SUPPORT_SYSRQ
472 if (port->cons && port->cons->index == port->line) {
473 if (!port->sysrq) {
474 port->sysrq = jiffies + HZ*5;
475 return 1;
477 port->sysrq = 0;
479 #endif
480 if (port->flags & UPF_SAK)
481 do_SAK(info->tty);
482 return 0;
486 * uart_handle_dcd_change - handle a change of carrier detect state
487 * @port: uart_port structure for the open port
488 * @status: new carrier detect status, nonzero if active
490 static inline void
491 uart_handle_dcd_change(struct uart_port *port, unsigned int status)
493 struct uart_info *info = port->info;
495 port->icount.dcd++;
497 #ifdef CONFIG_HARD_PPS
498 if ((port->flags & UPF_HARDPPS_CD) && status)
499 hardpps();
500 #endif
502 if (info->flags & UIF_CHECK_CD) {
503 if (status)
504 wake_up_interruptible(&info->open_wait);
505 else if (info->tty)
506 tty_hangup(info->tty);
511 * uart_handle_cts_change - handle a change of clear-to-send state
512 * @port: uart_port structure for the open port
513 * @status: new clear to send status, nonzero if active
515 static inline void
516 uart_handle_cts_change(struct uart_port *port, unsigned int status)
518 struct uart_info *info = port->info;
519 struct tty_struct *tty = info->tty;
521 port->icount.cts++;
523 if (info->flags & UIF_CTS_FLOW) {
524 if (tty->hw_stopped) {
525 if (status) {
526 tty->hw_stopped = 0;
527 port->ops->start_tx(port);
528 uart_write_wakeup(port);
530 } else {
531 if (!status) {
532 tty->hw_stopped = 1;
533 port->ops->stop_tx(port);
539 #include <linux/tty_flip.h>
541 static inline void
542 uart_insert_char(struct uart_port *port, unsigned int status,
543 unsigned int overrun, unsigned int ch, unsigned int flag)
545 struct tty_struct *tty = port->info->tty;
547 if ((status & port->ignore_status_mask & ~overrun) == 0)
548 tty_insert_flip_char(tty, ch, flag);
551 * Overrun is special. Since it's reported immediately,
552 * it doesn't affect the current character.
554 if (status & ~port->ignore_status_mask & overrun)
555 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
559 * UART_ENABLE_MS - determine if port should enable modem status irqs
561 #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
562 (cflag) & CRTSCTS || \
563 !((cflag) & CLOCAL))
565 #endif
567 #endif /* LINUX_SERIAL_CORE_H */