blob: e3710d7e260aa6d31b6d5f46f811ca49f3c65b86 [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
70/* Macintosh Zilog type numbers */
71#define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
72#define PORT_PMAC_ZILOG 51
73
74/* SH-SCI */
75#define PORT_SCI 52
76#define PORT_SCIF 53
77#define PORT_IRDA 54
78
79/* Samsung S3C2410 SoC and derivatives thereof */
80#define PORT_S3C2410 55
81
82/* SGI IP22 aka Indy / Challenge S / Indigo 2 */
83#define PORT_IP22ZILOG 56
84
85/* Sharp LH7a40x -- an ARM9 SoC series */
86#define PORT_LH7A40X 57
87
88/* PPC CPM type number */
89#define PORT_CPM 58
90
91/* MPC52xx type numbers */
92#define PORT_MPC52xx 59
93
94/* IBM icom */
95#define PORT_ICOM 60
96
97/* Samsung S3C2440 SoC */
98#define PORT_S3C2440 61
99
100/* Motorola i.MX SoC */
101#define PORT_IMX 62
102
103/* Marvell MPSC */
104#define PORT_MPSC 63
105
106/* TXX9 type number */
Ralf Baechlee5c2d742005-07-27 11:45:19 -0700107#define PORT_TXX9 64
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109/* NEC VR4100 series SIU/DSIU */
110#define PORT_VR41XX_SIU 65
111#define PORT_VR41XX_DSIU 66
112
113/* Samsung S3C2400 SoC */
114#define PORT_S3C2400 67
115
116/* M32R SIO */
117#define PORT_M32R_SIO 68
118
119/*Digi jsm */
Russell King913ade52005-10-31 13:53:26 +0000120#define PORT_JSM 69
121
122#define PORT_IP3106 70
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Sascha Hauerf5417612005-11-28 18:09:44 +0000124/* Hilscher netx */
125#define PORT_NETX 71
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127#ifdef __KERNEL__
128
129#include <linux/config.h>
Russell King661f83a2005-07-16 09:30:53 +0100130#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131#include <linux/interrupt.h>
132#include <linux/circ_buf.h>
133#include <linux/spinlock.h>
134#include <linux/sched.h>
135#include <linux/tty.h>
136
137struct uart_port;
138struct uart_info;
139struct serial_struct;
140struct device;
141
142/*
143 * This structure describes all the operations that can be
144 * done on the physical hardware.
145 */
146struct uart_ops {
147 unsigned int (*tx_empty)(struct uart_port *);
148 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
149 unsigned int (*get_mctrl)(struct uart_port *);
Russell Kingb129a8c2005-08-31 10:12:14 +0100150 void (*stop_tx)(struct uart_port *);
151 void (*start_tx)(struct uart_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 void (*send_xchar)(struct uart_port *, char ch);
153 void (*stop_rx)(struct uart_port *);
154 void (*enable_ms)(struct uart_port *);
155 void (*break_ctl)(struct uart_port *, int ctl);
156 int (*startup)(struct uart_port *);
157 void (*shutdown)(struct uart_port *);
158 void (*set_termios)(struct uart_port *, struct termios *new,
159 struct termios *old);
160 void (*pm)(struct uart_port *, unsigned int state,
161 unsigned int oldstate);
162 int (*set_wake)(struct uart_port *, unsigned int state);
163
164 /*
165 * Return a string describing the type of the port
166 */
167 const char *(*type)(struct uart_port *);
168
169 /*
170 * Release IO and memory resources used by the port.
171 * This includes iounmap if necessary.
172 */
173 void (*release_port)(struct uart_port *);
174
175 /*
176 * Request IO and memory resources used by the port.
177 * This includes iomapping the port if necessary.
178 */
179 int (*request_port)(struct uart_port *);
180 void (*config_port)(struct uart_port *, int);
181 int (*verify_port)(struct uart_port *, struct serial_struct *);
182 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
183};
184
185#define UART_CONFIG_TYPE (1 << 0)
186#define UART_CONFIG_IRQ (1 << 1)
187
188struct uart_icount {
189 __u32 cts;
190 __u32 dsr;
191 __u32 rng;
192 __u32 dcd;
193 __u32 rx;
194 __u32 tx;
195 __u32 frame;
196 __u32 overrun;
197 __u32 parity;
198 __u32 brk;
199 __u32 buf_overrun;
200};
201
202struct uart_port {
203 spinlock_t lock; /* port lock */
204 unsigned int iobase; /* in/out[bwl] */
205 unsigned char __iomem *membase; /* read/write[bwl] */
206 unsigned int irq; /* irq number */
207 unsigned int uartclk; /* base uart clock */
208 unsigned char fifosize; /* tx fifo size */
209 unsigned char x_char; /* xon/xoff char */
210 unsigned char regshift; /* reg offset shift */
211 unsigned char iotype; /* io access style */
212
213#define UPIO_PORT (0)
214#define UPIO_HUB6 (1)
215#define UPIO_MEM (2)
216#define UPIO_MEM32 (3)
Pantelis Antoniou21c614a2005-11-06 09:07:03 +0000217#define UPIO_AU (4) /* Au1x00 type IO */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219 unsigned int read_status_mask; /* driver specific */
220 unsigned int ignore_status_mask; /* driver specific */
221 struct uart_info *info; /* pointer to parent info */
222 struct uart_icount icount; /* statistics */
223
224 struct console *cons; /* struct console, if any */
225#ifdef CONFIG_SERIAL_CORE_CONSOLE
226 unsigned long sysrq; /* sysrq timeout */
227#endif
228
229 unsigned int flags;
230
231#define UPF_FOURPORT (1 << 1)
232#define UPF_SAK (1 << 2)
233#define UPF_SPD_MASK (0x1030)
234#define UPF_SPD_HI (0x0010)
235#define UPF_SPD_VHI (0x0020)
236#define UPF_SPD_CUST (0x0030)
237#define UPF_SPD_SHI (0x1000)
238#define UPF_SPD_WARP (0x1010)
239#define UPF_SKIP_TEST (1 << 6)
240#define UPF_AUTO_IRQ (1 << 7)
241#define UPF_HARDPPS_CD (1 << 11)
242#define UPF_LOW_LATENCY (1 << 13)
243#define UPF_BUGGY_UART (1 << 14)
244#define UPF_AUTOPROBE (1 << 15)
245#define UPF_MAGIC_MULTIPLIER (1 << 16)
246#define UPF_BOOT_ONLYMCA (1 << 22)
247#define UPF_CONS_FLOW (1 << 23)
248#define UPF_SHARE_IRQ (1 << 24)
249#define UPF_BOOT_AUTOCONF (1 << 28)
250#define UPF_IOREMAP (1 << 31)
251
252#define UPF_CHANGE_MASK (0x17fff)
253#define UPF_USR_MASK (UPF_SPD_MASK|UPF_LOW_LATENCY)
254
255 unsigned int mctrl; /* current modem ctrl settings */
256 unsigned int timeout; /* character-based timeout */
257 unsigned int type; /* port type */
258 struct uart_ops *ops;
259 unsigned int custom_divisor;
260 unsigned int line; /* port index */
261 unsigned long mapbase; /* for ioremap */
262 struct device *dev; /* parent device */
263 unsigned char hub6; /* this should be in the 8250 driver */
264 unsigned char unused[3];
265};
266
267/*
268 * This is the state information which is persistent across opens.
269 * The low level driver must not to touch any elements contained
270 * within.
271 */
272struct uart_state {
273 unsigned int close_delay; /* msec */
274 unsigned int closing_wait; /* msec */
275
276#define USF_CLOSING_WAIT_INF (0)
277#define USF_CLOSING_WAIT_NONE (~0U)
278
279 int count;
280 int pm_state;
281 struct uart_info *info;
282 struct uart_port *port;
283
284 struct semaphore sem;
285};
286
287#define UART_XMIT_SIZE PAGE_SIZE
288/*
289 * This is the state information which is only valid when the port
290 * is open; it may be freed by the core driver once the device has
291 * been closed. Either the low level driver or the core can modify
292 * stuff here.
293 */
294struct uart_info {
295 struct tty_struct *tty;
296 struct circ_buf xmit;
297 unsigned int flags;
298
299/*
300 * These are the flags that specific to info->flags, and reflect our
301 * internal state. They can not be accessed via port->flags. Low
302 * level drivers must not change these, but may query them instead.
303 */
304#define UIF_CHECK_CD (1 << 25)
305#define UIF_CTS_FLOW (1 << 26)
306#define UIF_NORMAL_ACTIVE (1 << 29)
307#define UIF_INITIALIZED (1 << 31)
308
309 int blocked_open;
310
311 struct tasklet_struct tlet;
312
313 wait_queue_head_t open_wait;
314 wait_queue_head_t delta_msr_wait;
315};
316
317/* number of characters left in xmit buffer before we ask for more */
318#define WAKEUP_CHARS 256
319
320struct module;
321struct tty_driver;
322
323struct uart_driver {
324 struct module *owner;
325 const char *driver_name;
326 const char *dev_name;
327 const char *devfs_name;
328 int major;
329 int minor;
330 int nr;
331 struct console *cons;
332
333 /*
334 * these are private; the low level driver should not
335 * touch these; they should be initialised to NULL
336 */
337 struct uart_state *state;
338 struct tty_driver *tty_driver;
339};
340
341void uart_write_wakeup(struct uart_port *port);
342
343/*
344 * Baud rate helpers.
345 */
346void uart_update_timeout(struct uart_port *port, unsigned int cflag,
347 unsigned int baud);
348unsigned int uart_get_baud_rate(struct uart_port *port, struct termios *termios,
349 struct termios *old, unsigned int min,
350 unsigned int max);
351unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
352
353/*
354 * Console helpers.
355 */
356struct uart_port *uart_get_console(struct uart_port *ports, int nr,
357 struct console *c);
358void uart_parse_options(char *options, int *baud, int *parity, int *bits,
359 int *flow);
360int uart_set_options(struct uart_port *port, struct console *co, int baud,
361 int parity, int bits, int flow);
362struct tty_driver *uart_console_device(struct console *co, int *index);
363
364/*
365 * Port/driver registration/removal
366 */
367int uart_register_driver(struct uart_driver *uart);
368void uart_unregister_driver(struct uart_driver *uart);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
370int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
371int uart_match_port(struct uart_port *port1, struct uart_port *port2);
372
373/*
374 * Power Management
375 */
376int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
377int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
378
379#define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
380#define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
381
382#define uart_circ_chars_pending(circ) \
383 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
384
385#define uart_circ_chars_free(circ) \
386 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
387
388#define uart_tx_stopped(port) \
389 ((port)->info->tty->stopped || (port)->info->tty->hw_stopped)
390
391/*
392 * The following are helper functions for the low level drivers.
393 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394static inline int
395uart_handle_sysrq_char(struct uart_port *port, unsigned int ch,
396 struct pt_regs *regs)
397{
David S. Miller93c37f22005-09-06 13:57:08 -0700398#ifdef SUPPORT_SYSRQ
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 if (port->sysrq) {
400 if (ch && time_before(jiffies, port->sysrq)) {
401 handle_sysrq(ch, regs, NULL);
402 port->sysrq = 0;
403 return 1;
404 }
405 port->sysrq = 0;
406 }
David S. Miller93c37f22005-09-06 13:57:08 -0700407#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 return 0;
409}
Linus Torvalds4e149182005-09-08 14:47:12 -0700410#ifndef SUPPORT_SYSRQ
411#define uart_handle_sysrq_char(port,ch,regs) uart_handle_sysrq_char(port, 0, NULL)
412#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
414/*
415 * We do the SysRQ and SAK checking like this...
416 */
417static inline int uart_handle_break(struct uart_port *port)
418{
419 struct uart_info *info = port->info;
420#ifdef SUPPORT_SYSRQ
421 if (port->cons && port->cons->index == port->line) {
422 if (!port->sysrq) {
423 port->sysrq = jiffies + HZ*5;
424 return 1;
425 }
426 port->sysrq = 0;
427 }
428#endif
429 if (info->flags & UPF_SAK)
430 do_SAK(info->tty);
431 return 0;
432}
433
434/**
435 * uart_handle_dcd_change - handle a change of carrier detect state
436 * @port: uart_port structure for the open port
437 * @status: new carrier detect status, nonzero if active
438 */
439static inline void
440uart_handle_dcd_change(struct uart_port *port, unsigned int status)
441{
442 struct uart_info *info = port->info;
443
444 port->icount.dcd++;
445
446#ifdef CONFIG_HARD_PPS
447 if ((port->flags & UPF_HARDPPS_CD) && status)
448 hardpps();
449#endif
450
451 if (info->flags & UIF_CHECK_CD) {
452 if (status)
453 wake_up_interruptible(&info->open_wait);
454 else if (info->tty)
455 tty_hangup(info->tty);
456 }
457}
458
459/**
460 * uart_handle_cts_change - handle a change of clear-to-send state
461 * @port: uart_port structure for the open port
462 * @status: new clear to send status, nonzero if active
463 */
464static inline void
465uart_handle_cts_change(struct uart_port *port, unsigned int status)
466{
467 struct uart_info *info = port->info;
468 struct tty_struct *tty = info->tty;
469
470 port->icount.cts++;
471
472 if (info->flags & UIF_CTS_FLOW) {
473 if (tty->hw_stopped) {
474 if (status) {
475 tty->hw_stopped = 0;
Russell Kingb129a8c2005-08-31 10:12:14 +0100476 port->ops->start_tx(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 uart_write_wakeup(port);
478 }
479 } else {
480 if (!status) {
481 tty->hw_stopped = 1;
Russell Kingb129a8c2005-08-31 10:12:14 +0100482 port->ops->stop_tx(port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 }
484 }
485 }
486}
487
Russell King05ab3012005-05-09 23:21:59 +0100488#include <linux/tty_flip.h>
489
490static inline void
491uart_insert_char(struct uart_port *port, unsigned int status,
492 unsigned int overrun, unsigned int ch, unsigned int flag)
493{
494 struct tty_struct *tty = port->info->tty;
495
496 if ((status & port->ignore_status_mask & ~overrun) == 0)
497 tty_insert_flip_char(tty, ch, flag);
498
499 /*
500 * Overrun is special. Since it's reported immediately,
501 * it doesn't affect the current character.
502 */
503 if (status & ~port->ignore_status_mask & overrun)
504 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
505}
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507/*
508 * UART_ENABLE_MS - determine if port should enable modem status irqs
509 */
510#define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
511 (cflag) & CRTSCTS || \
512 !((cflag) & CLOCAL))
513
514#endif
515
516#endif /* LINUX_SERIAL_CORE_H */