blob: 86501a3de2ac1d771c9b32958ca5b3fdf8a99dee [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
23/*
24 * The type definitions. These are from Ted Ts'o's serial.h
25 */
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
Russell King913ade52005-10-31 13:53:26 +000042#define PORT_MAX_8250 15 /* max port ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44/*
45 * ARM specific type numbers. These are not currently guaranteed
46 * to be implemented, and will change in the future. These are
47 * separate so any additions to the old serial.c that occur before
48 * we are merged can be easily merged here.
49 */
50#define PORT_PXA 31
51#define PORT_AMBA 32
52#define PORT_CLPS711X 33
53#define PORT_SA1100 34
54#define PORT_UART00 35
55#define PORT_21285 37
56
57/* Sparc type numbers. */
58#define PORT_SUNZILOG 38
59#define PORT_SUNSAB 39
60
61/* NEC v850. */
62#define PORT_V850E_UART 40
63
64/* DZ */
65#define PORT_DZ 47
66
67/* Parisc type numbers. */
68#define PORT_MUX 48
69
Andrew Victorafefc412006-06-19 19:53:19 +010070/* Atmel AT91xxx SoC */
71#define PORT_AT91 49
Andrew Victor1e6c9c22006-01-10 16:59:27 +000072
Linus Torvalds1da177e2005-04-16 15:20:36 -070073/* Macintosh Zilog type numbers */
74#define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
75#define PORT_PMAC_ZILOG 51
76
77/* SH-SCI */
78#define PORT_SCI 52
79#define PORT_SCIF 53
80#define PORT_IRDA 54
81
82/* Samsung S3C2410 SoC and derivatives thereof */
83#define PORT_S3C2410 55
84
85/* SGI IP22 aka Indy / Challenge S / Indigo 2 */
86#define PORT_IP22ZILOG 56
87
88/* Sharp LH7a40x -- an ARM9 SoC series */
89#define PORT_LH7A40X 57
90
91/* PPC CPM type number */
92#define PORT_CPM 58
93
94/* MPC52xx type numbers */
95#define PORT_MPC52xx 59
96
97/* IBM icom */
98#define PORT_ICOM 60
99
100/* Samsung S3C2440 SoC */
101#define PORT_S3C2440 61
102
103/* Motorola i.MX SoC */
104#define PORT_IMX 62
105
106/* Marvell MPSC */
107#define PORT_MPSC 63
108
109/* TXX9 type number */
Ralf Baechlee5c2d742005-07-27 11:45:19 -0700110#define PORT_TXX9 64
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112/* NEC VR4100 series SIU/DSIU */
113#define PORT_VR41XX_SIU 65
114#define PORT_VR41XX_DSIU 66
115
116/* Samsung S3C2400 SoC */
117#define PORT_S3C2400 67
118
119/* M32R SIO */
120#define PORT_M32R_SIO 68
121
122/*Digi jsm */
Russell King913ade52005-10-31 13:53:26 +0000123#define PORT_JSM 69
124
125#define PORT_IP3106 70
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Sascha Hauerf5417612005-11-28 18:09:44 +0000127/* Hilscher netx */
128#define PORT_NETX 71
129
David S. Miller02fd4732006-02-11 02:25:21 -0800130/* SUN4V Hypervisor Console */
131#define PORT_SUNHV 72
132
Ben Dooks73e55cb2006-06-24 21:21:32 +0100133#define PORT_S3C2412 73
134
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136#ifdef __KERNEL__
137
Russell King661f83a2005-07-16 09:30:53 +0100138#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139#include <linux/interrupt.h>
140#include <linux/circ_buf.h>
141#include <linux/spinlock.h>
142#include <linux/sched.h>
143#include <linux/tty.h>
Ingo Molnare2862f62006-01-13 21:37:07 +0000144#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
146struct uart_port;
147struct uart_info;
148struct serial_struct;
149struct device;
150
151/*
152 * This structure describes all the operations that can be
153 * done on the physical hardware.
154 */
155struct uart_ops {
156 unsigned int (*tx_empty)(struct uart_port *);
157 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
158 unsigned int (*get_mctrl)(struct uart_port *);
Russell Kingb129a8c2005-08-31 10:12:14 +0100159 void (*stop_tx)(struct uart_port *);
160 void (*start_tx)(struct uart_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 void (*send_xchar)(struct uart_port *, char ch);
162 void (*stop_rx)(struct uart_port *);
163 void (*enable_ms)(struct uart_port *);
164 void (*break_ctl)(struct uart_port *, int ctl);
165 int (*startup)(struct uart_port *);
166 void (*shutdown)(struct uart_port *);
167 void (*set_termios)(struct uart_port *, struct termios *new,
168 struct termios *old);
169 void (*pm)(struct uart_port *, unsigned int state,
170 unsigned int oldstate);
171 int (*set_wake)(struct uart_port *, unsigned int state);
172
173 /*
174 * Return a string describing the type of the port
175 */
176 const char *(*type)(struct uart_port *);
177
178 /*
179 * Release IO and memory resources used by the port.
180 * This includes iounmap if necessary.
181 */
182 void (*release_port)(struct uart_port *);
183
184 /*
185 * Request IO and memory resources used by the port.
186 * This includes iomapping the port if necessary.
187 */
188 int (*request_port)(struct uart_port *);
189 void (*config_port)(struct uart_port *, int);
190 int (*verify_port)(struct uart_port *, struct serial_struct *);
191 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
192};
193
194#define UART_CONFIG_TYPE (1 << 0)
195#define UART_CONFIG_IRQ (1 << 1)
196
197struct uart_icount {
198 __u32 cts;
199 __u32 dsr;
200 __u32 rng;
201 __u32 dcd;
202 __u32 rx;
203 __u32 tx;
204 __u32 frame;
205 __u32 overrun;
206 __u32 parity;
207 __u32 brk;
208 __u32 buf_overrun;
209};
210
Russell King0077d452006-01-21 23:03:28 +0000211typedef unsigned int __bitwise__ upf_t;
212
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213struct uart_port {
214 spinlock_t lock; /* port lock */
215 unsigned int iobase; /* in/out[bwl] */
216 unsigned char __iomem *membase; /* read/write[bwl] */
217 unsigned int irq; /* irq number */
218 unsigned int uartclk; /* base uart clock */
Russell King947deee2006-07-02 20:45:51 +0100219 unsigned int fifosize; /* tx fifo size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 unsigned char x_char; /* xon/xoff char */
221 unsigned char regshift; /* reg offset shift */
222 unsigned char iotype; /* io access style */
Russell King947deee2006-07-02 20:45:51 +0100223 unsigned char unused1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225#define UPIO_PORT (0)
226#define UPIO_HUB6 (1)
227#define UPIO_MEM (2)
228#define UPIO_MEM32 (3)
Pantelis Antoniou21c614a2005-11-06 09:07:03 +0000229#define UPIO_AU (4) /* Au1x00 type IO */
Zang Roy-r619113be91ec2006-06-30 02:29:58 -0700230#define UPIO_TSI (5) /* Tsi108/109 type IO */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232 unsigned int read_status_mask; /* driver specific */
233 unsigned int ignore_status_mask; /* driver specific */
234 struct uart_info *info; /* pointer to parent info */
235 struct uart_icount icount; /* statistics */
236
237 struct console *cons; /* struct console, if any */
238#ifdef CONFIG_SERIAL_CORE_CONSOLE
239 unsigned long sysrq; /* sysrq timeout */
240#endif
241
Russell King0077d452006-01-21 23:03:28 +0000242 upf_t flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Russell King0077d452006-01-21 23:03:28 +0000244#define UPF_FOURPORT ((__force upf_t) (1 << 1))
245#define UPF_SAK ((__force upf_t) (1 << 2))
246#define UPF_SPD_MASK ((__force upf_t) (0x1030))
247#define UPF_SPD_HI ((__force upf_t) (0x0010))
248#define UPF_SPD_VHI ((__force upf_t) (0x0020))
249#define UPF_SPD_CUST ((__force upf_t) (0x0030))
250#define UPF_SPD_SHI ((__force upf_t) (0x1000))
251#define UPF_SPD_WARP ((__force upf_t) (0x1010))
252#define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
253#define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
254#define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
255#define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
256#define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
257#define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
258#define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
259#define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
260#define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
Russell King68ac64c2006-04-30 11:13:50 +0100261#define UPF_DEAD ((__force upf_t) (1 << 30))
Russell King0077d452006-01-21 23:03:28 +0000262#define UPF_IOREMAP ((__force upf_t) (1 << 31))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Russell King0077d452006-01-21 23:03:28 +0000264#define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
265#define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267 unsigned int mctrl; /* current modem ctrl settings */
268 unsigned int timeout; /* character-based timeout */
269 unsigned int type; /* port type */
Russell Kingba899db2006-01-21 22:45:50 +0000270 const struct uart_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 unsigned int custom_divisor;
272 unsigned int line; /* port index */
273 unsigned long mapbase; /* for ioremap */
274 struct device *dev; /* parent device */
275 unsigned char hub6; /* this should be in the 8250 driver */
276 unsigned char unused[3];
277};
278
279/*
280 * This is the state information which is persistent across opens.
281 * The low level driver must not to touch any elements contained
282 * within.
283 */
284struct uart_state {
285 unsigned int close_delay; /* msec */
286 unsigned int closing_wait; /* msec */
287
288#define USF_CLOSING_WAIT_INF (0)
289#define USF_CLOSING_WAIT_NONE (~0U)
290
291 int count;
292 int pm_state;
293 struct uart_info *info;
294 struct uart_port *port;
295
Ingo Molnare2862f62006-01-13 21:37:07 +0000296 struct mutex mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297};
298
299#define UART_XMIT_SIZE PAGE_SIZE
Russell King747c8a52006-01-21 22:50:36 +0000300
301typedef unsigned int __bitwise__ uif_t;
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303/*
304 * This is the state information which is only valid when the port
305 * is open; it may be freed by the core driver once the device has
306 * been closed. Either the low level driver or the core can modify
307 * stuff here.
308 */
309struct uart_info {
310 struct tty_struct *tty;
311 struct circ_buf xmit;
Russell King747c8a52006-01-21 22:50:36 +0000312 uif_t flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314/*
Russell King747c8a52006-01-21 22:50:36 +0000315 * Definitions for info->flags. These are _private_ to serial_core, and
316 * are specific to this structure. They may be queried by low level drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 */
Russell King747c8a52006-01-21 22:50:36 +0000318#define UIF_CHECK_CD ((__force uif_t) (1 << 25))
319#define UIF_CTS_FLOW ((__force uif_t) (1 << 26))
320#define UIF_NORMAL_ACTIVE ((__force uif_t) (1 << 29))
321#define UIF_INITIALIZED ((__force uif_t) (1 << 31))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323 int blocked_open;
324
325 struct tasklet_struct tlet;
326
327 wait_queue_head_t open_wait;
328 wait_queue_head_t delta_msr_wait;
329};
330
331/* number of characters left in xmit buffer before we ask for more */
332#define WAKEUP_CHARS 256
333
334struct module;
335struct tty_driver;
336
337struct uart_driver {
338 struct module *owner;
339 const char *driver_name;
340 const char *dev_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 int major;
342 int minor;
343 int nr;
344 struct console *cons;
345
346 /*
347 * these are private; the low level driver should not
348 * touch these; they should be initialised to NULL
349 */
350 struct uart_state *state;
351 struct tty_driver *tty_driver;
352};
353
354void uart_write_wakeup(struct uart_port *port);
355
356/*
357 * Baud rate helpers.
358 */
359void uart_update_timeout(struct uart_port *port, unsigned int cflag,
360 unsigned int baud);
361unsigned int uart_get_baud_rate(struct uart_port *port, struct termios *termios,
362 struct termios *old, unsigned int min,
363 unsigned int max);
364unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
365
366/*
367 * Console helpers.
368 */
369struct uart_port *uart_get_console(struct uart_port *ports, int nr,
370 struct console *c);
371void uart_parse_options(char *options, int *baud, int *parity, int *bits,
372 int *flow);
373int uart_set_options(struct uart_port *port, struct console *co, int baud,
374 int parity, int bits, int flow);
375struct tty_driver *uart_console_device(struct console *co, int *index);
Russell Kingd3587882006-03-20 20:00:09 +0000376void uart_console_write(struct uart_port *port, const char *s,
377 unsigned int count,
378 void (*putchar)(struct uart_port *, int));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380/*
381 * Port/driver registration/removal
382 */
383int uart_register_driver(struct uart_driver *uart);
384void uart_unregister_driver(struct uart_driver *uart);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
386int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
387int uart_match_port(struct uart_port *port1, struct uart_port *port2);
388
389/*
390 * Power Management
391 */
392int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
393int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
394
395#define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
396#define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
397
398#define uart_circ_chars_pending(circ) \
399 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
400
401#define uart_circ_chars_free(circ) \
402 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
403
404#define uart_tx_stopped(port) \
405 ((port)->info->tty->stopped || (port)->info->tty->hw_stopped)
406
407/*
408 * The following are helper functions for the low level drivers.
409 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410static inline int
411uart_handle_sysrq_char(struct uart_port *port, unsigned int ch,
412 struct pt_regs *regs)
413{
David S. Miller93c37f22005-09-06 13:57:08 -0700414#ifdef SUPPORT_SYSRQ
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 if (port->sysrq) {
416 if (ch && time_before(jiffies, port->sysrq)) {
417 handle_sysrq(ch, regs, NULL);
418 port->sysrq = 0;
419 return 1;
420 }
421 port->sysrq = 0;
422 }
David S. Miller93c37f22005-09-06 13:57:08 -0700423#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 return 0;
425}
Linus Torvalds4e149182005-09-08 14:47:12 -0700426#ifndef SUPPORT_SYSRQ
427#define uart_handle_sysrq_char(port,ch,regs) uart_handle_sysrq_char(port, 0, NULL)
428#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
430/*
431 * We do the SysRQ and SAK checking like this...
432 */
433static inline int uart_handle_break(struct uart_port *port)
434{
435 struct uart_info *info = port->info;
436#ifdef SUPPORT_SYSRQ
437 if (port->cons && port->cons->index == port->line) {
438 if (!port->sysrq) {
439 port->sysrq = jiffies + HZ*5;
440 return 1;
441 }
442 port->sysrq = 0;
443 }
444#endif
Russell King27ae7a72006-01-21 22:54:06 +0000445 if (port->flags & UPF_SAK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 do_SAK(info->tty);
447 return 0;
448}
449
450/**
451 * uart_handle_dcd_change - handle a change of carrier detect state
452 * @port: uart_port structure for the open port
453 * @status: new carrier detect status, nonzero if active
454 */
455static inline void
456uart_handle_dcd_change(struct uart_port *port, unsigned int status)
457{
458 struct uart_info *info = port->info;
459
460 port->icount.dcd++;
461
462#ifdef CONFIG_HARD_PPS
463 if ((port->flags & UPF_HARDPPS_CD) && status)
464 hardpps();
465#endif
466
467 if (info->flags & UIF_CHECK_CD) {
468 if (status)
469 wake_up_interruptible(&info->open_wait);
470 else if (info->tty)
471 tty_hangup(info->tty);
472 }
473}
474
475/**
476 * uart_handle_cts_change - handle a change of clear-to-send state
477 * @port: uart_port structure for the open port
478 * @status: new clear to send status, nonzero if active
479 */
480static inline void
481uart_handle_cts_change(struct uart_port *port, unsigned int status)
482{
483 struct uart_info *info = port->info;
484 struct tty_struct *tty = info->tty;
485
486 port->icount.cts++;
487
488 if (info->flags & UIF_CTS_FLOW) {
489 if (tty->hw_stopped) {
490 if (status) {
491 tty->hw_stopped = 0;
Russell Kingb129a8c2005-08-31 10:12:14 +0100492 port->ops->start_tx(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 uart_write_wakeup(port);
494 }
495 } else {
496 if (!status) {
497 tty->hw_stopped = 1;
Russell Kingb129a8c2005-08-31 10:12:14 +0100498 port->ops->stop_tx(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 }
500 }
501 }
502}
503
Russell King05ab3012005-05-09 23:21:59 +0100504#include <linux/tty_flip.h>
505
506static inline void
507uart_insert_char(struct uart_port *port, unsigned int status,
508 unsigned int overrun, unsigned int ch, unsigned int flag)
509{
510 struct tty_struct *tty = port->info->tty;
511
512 if ((status & port->ignore_status_mask & ~overrun) == 0)
513 tty_insert_flip_char(tty, ch, flag);
514
515 /*
516 * Overrun is special. Since it's reported immediately,
517 * it doesn't affect the current character.
518 */
519 if (status & ~port->ignore_status_mask & overrun)
520 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
521}
522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523/*
524 * UART_ENABLE_MS - determine if port should enable modem status irqs
525 */
526#define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
527 (cflag) & CRTSCTS || \
528 !((cflag) & CLOCAL))
529
530#endif
531
532#endif /* LINUX_SERIAL_CORE_H */