Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
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#include <linux/serial.h>
24
25/*
26 * The type definitions. These are from Ted Ts'o's serial.h
27 */
28#define PORT_UNKNOWN 0
29#define PORT_8250 1
30#define PORT_16450 2
31#define PORT_16550 3
32#define PORT_16550A 4
33#define PORT_CIRRUS 5
34#define PORT_16650 6
35#define PORT_16650V2 7
36#define PORT_16750 8
37#define PORT_STARTECH 9
38#define PORT_16C950 10
39#define PORT_16654 11
40#define PORT_16850 12
41#define PORT_RSA 13
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_XR17D15X 21 /* Exar XR17D15x UART */
50#define PORT_MAX_8250 21 /* max port ID */
51
52/*
53 * ARM specific type numbers. These are not currently guaranteed
54 * to be implemented, and will change in the future. These are
55 * separate so any additions to the old serial.c that occur before
56 * we are merged can be easily merged here.
57 */
58#define PORT_PXA 31
59#define PORT_AMBA 32
60#define PORT_CLPS711X 33
61#define PORT_SA1100 34
62#define PORT_UART00 35
63#define PORT_21285 37
64
65/* Sparc type numbers. */
66#define PORT_SUNZILOG 38
67#define PORT_SUNSAB 39
68
69/* DEC */
70#define PORT_DZ 46
71#define PORT_ZS 47
72
73/* Parisc type numbers. */
74#define PORT_MUX 48
75
76/* Atmel AT91 / AT32 SoC */
77#define PORT_ATMEL 49
78
79/* Macintosh Zilog type numbers */
80#define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
81#define PORT_PMAC_ZILOG 51
82
83/* SH-SCI */
84#define PORT_SCI 52
85#define PORT_SCIF 53
86#define PORT_IRDA 54
87
88/* Samsung S3C2410 SoC and derivatives thereof */
89#define PORT_S3C2410 55
90
91/* SGI IP22 aka Indy / Challenge S / Indigo 2 */
92#define PORT_IP22ZILOG 56
93
94/* Sharp LH7a40x -- an ARM9 SoC series */
95#define PORT_LH7A40X 57
96
97/* PPC CPM type number */
98#define PORT_CPM 58
99
100/* MPC52xx (and MPC512x) type numbers */
101#define PORT_MPC52xx 59
102
103/* IBM icom */
104#define PORT_ICOM 60
105
106/* Samsung S3C2440 SoC */
107#define PORT_S3C2440 61
108
109/* Motorola i.MX SoC */
110#define PORT_IMX 62
111
112/* Marvell MPSC */
113#define PORT_MPSC 63
114
115/* TXX9 type number */
116#define PORT_TXX9 64
117
118/* NEC VR4100 series SIU/DSIU */
119#define PORT_VR41XX_SIU 65
120#define PORT_VR41XX_DSIU 66
121
122/* Samsung S3C2400 SoC */
123#define PORT_S3C2400 67
124
125/* M32R SIO */
126#define PORT_M32R_SIO 68
127
128/*Digi jsm */
129#define PORT_JSM 69
130
131#define PORT_PNX8XXX 70
132
133/* Hilscher netx */
134#define PORT_NETX 71
135
136/* SUN4V Hypervisor Console */
137#define PORT_SUNHV 72
138
139#define PORT_S3C2412 73
140
141/* Xilinx uartlite */
142#define PORT_UARTLITE 74
143
144/* Blackfin bf5xx */
145#define PORT_BFIN 75
146
147/* Micrel KS8695 */
148#define PORT_KS8695 76
149
150/* Broadcom SB1250, etc. SOC */
151#define PORT_SB1250_DUART 77
152
153/* Freescale ColdFire */
154#define PORT_MCF 78
155
156/* Blackfin SPORT */
157#define PORT_BFIN_SPORT 79
158
159/* MN10300 on-chip UART numbers */
160#define PORT_MN10300 80
161#define PORT_MN10300_CTS 81
162
163#define PORT_SC26XX 82
164
165/* SH-SCI */
166#define PORT_SCIFA 83
167
168#define PORT_S3C6400 84
169
170/* NWPSERIAL */
171#define PORT_NWPSERIAL 85
172
173/* MAX3100 */
174#define PORT_MAX3100 86
175
176/* Timberdale UART */
177#define PORT_TIMBUART 87
178
179/* Qualcomm MSM SoCs */
180#define PORT_MSM 88
181
182/* BCM63xx family SoCs */
183#define PORT_BCM63XX 89
184
185/* Aeroflex Gaisler GRLIB APBUART */
186#define PORT_APBUART 90
187
188/* Altera UARTs */
189#define PORT_ALTERA_JTAGUART 91
190#define PORT_ALTERA_UART 92
191
192/* SH-SCI */
193#define PORT_SCIFB 93
194
195/* MAX3107 */
196#define PORT_MAX3107 94
197
198/* High Speed UART for Medfield */
199#define PORT_MFD 95
200
201/* TI OMAP-UART */
202#define PORT_OMAP 96
203
204/* VIA VT8500 SoC */
205#define PORT_VT8500 97
206
207/* Xilinx PSS UART */
208#define PORT_XUARTPS 98
209
210/* Atheros AR933X SoC */
211#define PORT_AR933X 99
212
213/* Energy Micro efm32 SoC */
214#define PORT_EFMUART 100
215
216#ifdef __KERNEL__
217
218#include <linux/compiler.h>
219#include <linux/interrupt.h>
220#include <linux/circ_buf.h>
221#include <linux/spinlock.h>
222#include <linux/sched.h>
223#include <linux/tty.h>
224#include <linux/mutex.h>
225#include <linux/sysrq.h>
226#include <linux/pps_kernel.h>
227
228struct uart_port;
229struct serial_struct;
230struct device;
231
232/*
233 * This structure describes all the operations that can be
234 * done on the physical hardware.
235 */
236struct uart_ops {
237 unsigned int (*tx_empty)(struct uart_port *);
238 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
239 unsigned int (*get_mctrl)(struct uart_port *);
240 void (*stop_tx)(struct uart_port *);
241 void (*start_tx)(struct uart_port *);
242 void (*send_xchar)(struct uart_port *, char ch);
243 void (*stop_rx)(struct uart_port *);
244 void (*enable_ms)(struct uart_port *);
245 void (*break_ctl)(struct uart_port *, int ctl);
246 int (*startup)(struct uart_port *);
247 void (*shutdown)(struct uart_port *);
248 void (*flush_buffer)(struct uart_port *);
249 void (*set_termios)(struct uart_port *, struct ktermios *new,
250 struct ktermios *old);
251 void (*set_ldisc)(struct uart_port *, int new);
252 void (*pm)(struct uart_port *, unsigned int state,
253 unsigned int oldstate);
254 int (*set_wake)(struct uart_port *, unsigned int state);
255
256 /*
257 * Return a string describing the type of the port
258 */
259 const char *(*type)(struct uart_port *);
260
261 /*
262 * Release IO and memory resources used by the port.
263 * This includes iounmap if necessary.
264 */
265 void (*release_port)(struct uart_port *);
266
267 /*
268 * Request IO and memory resources used by the port.
269 * This includes iomapping the port if necessary.
270 */
271 int (*request_port)(struct uart_port *);
272 void (*config_port)(struct uart_port *, int);
273 int (*verify_port)(struct uart_port *, struct serial_struct *);
274 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
275#ifdef CONFIG_CONSOLE_POLL
276 void (*poll_put_char)(struct uart_port *, unsigned char);
277 int (*poll_get_char)(struct uart_port *);
278#endif
279};
280
281#define NO_POLL_CHAR 0x00ff0000
282#define UART_CONFIG_TYPE (1 << 0)
283#define UART_CONFIG_IRQ (1 << 1)
284
285struct uart_icount {
286 __u32 cts;
287 __u32 dsr;
288 __u32 rng;
289 __u32 dcd;
290 __u32 rx;
291 __u32 tx;
292 __u32 frame;
293 __u32 overrun;
294 __u32 parity;
295 __u32 brk;
296 __u32 buf_overrun;
297};
298
299typedef unsigned int __bitwise__ upf_t;
300
301struct uart_port {
302 spinlock_t lock; /* port lock */
303 unsigned long iobase; /* in/out[bwl] */
304 unsigned char __iomem *membase; /* read/write[bwl] */
305 unsigned int (*serial_in)(struct uart_port *, int);
306 void (*serial_out)(struct uart_port *, int, int);
307 void (*set_termios)(struct uart_port *,
308 struct ktermios *new,
309 struct ktermios *old);
310 int (*handle_irq)(struct uart_port *);
311 void (*pm)(struct uart_port *, unsigned int state,
312 unsigned int old);
313 unsigned int irq; /* irq number */
314 unsigned long irqflags; /* irq flags */
315 unsigned int uartclk; /* base uart clock */
316 unsigned int fifosize; /* tx fifo size */
317 unsigned char x_char; /* xon/xoff char */
318 unsigned char regshift; /* reg offset shift */
319 unsigned char iotype; /* io access style */
320 unsigned char unused1;
321
322#define UPIO_PORT (0)
323#define UPIO_HUB6 (1)
324#define UPIO_MEM (2)
325#define UPIO_MEM32 (3)
326#define UPIO_AU (4) /* Au1x00 type IO */
327#define UPIO_TSI (5) /* Tsi108/109 type IO */
328#define UPIO_RM9000 (6) /* RM9000 type IO */
329
330 unsigned int read_status_mask; /* driver specific */
331 unsigned int ignore_status_mask; /* driver specific */
332 struct uart_state *state; /* pointer to parent state */
333 struct uart_icount icount; /* statistics */
334
335 struct console *cons; /* struct console, if any */
336#if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
337 unsigned long sysrq; /* sysrq timeout */
338#endif
339
340 upf_t flags;
341
342#define UPF_FOURPORT ((__force upf_t) (1 << 1))
343#define UPF_SAK ((__force upf_t) (1 << 2))
344#define UPF_SPD_MASK ((__force upf_t) (0x1030))
345#define UPF_SPD_HI ((__force upf_t) (0x0010))
346#define UPF_SPD_VHI ((__force upf_t) (0x0020))
347#define UPF_SPD_CUST ((__force upf_t) (0x0030))
348#define UPF_SPD_SHI ((__force upf_t) (0x1000))
349#define UPF_SPD_WARP ((__force upf_t) (0x1010))
350#define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
351#define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
352#define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
353#define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
354#define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
355#define UPF_NO_TXEN_TEST ((__force upf_t) (1 << 15))
356#define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
357#define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
358#define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
359#define UPF_EXAR_EFR ((__force upf_t) (1 << 25))
360#define UPF_BUG_THRE ((__force upf_t) (1 << 26))
361/* The exact UART type is known and should not be probed. */
362#define UPF_FIXED_TYPE ((__force upf_t) (1 << 27))
363#define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
364#define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
365#define UPF_DEAD ((__force upf_t) (1 << 30))
366#define UPF_IOREMAP ((__force upf_t) (1 << 31))
367
368#define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
369#define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
370
371 unsigned int mctrl; /* current modem ctrl settings */
372 unsigned int timeout; /* character-based timeout */
373 unsigned int type; /* port type */
374 const struct uart_ops *ops;
375 unsigned int custom_divisor;
376 unsigned int line; /* port index */
377 resource_size_t mapbase; /* for ioremap */
378 struct device *dev; /* parent device */
379 unsigned char hub6; /* this should be in the 8250 driver */
380 unsigned char suspended;
381 unsigned char irq_wake;
382 unsigned char unused[2];
383 void *private_data; /* generic platform data pointer */
384};
385
386static inline int serial_port_in(struct uart_port *up, int offset)
387{
388 return up->serial_in(up, offset);
389}
390
391static inline void serial_port_out(struct uart_port *up, int offset, int value)
392{
393 up->serial_out(up, offset, value);
394}
395
396/*
397 * This is the state information which is persistent across opens.
398 */
399struct uart_state {
400 struct tty_port port;
401
402 int pm_state;
403 struct circ_buf xmit;
404
405 struct uart_port *uart_port;
406};
407
408#define UART_XMIT_SIZE PAGE_SIZE
409
410
411/* number of characters left in xmit buffer before we ask for more */
412#define WAKEUP_CHARS 256
413
414struct module;
415struct tty_driver;
416
417struct uart_driver {
418 struct module *owner;
419 const char *driver_name;
420 const char *dev_name;
421 int major;
422 int minor;
423 int nr;
424 struct console *cons;
425
426 /*
427 * these are private; the low level driver should not
428 * touch these; they should be initialised to NULL
429 */
430 struct uart_state *state;
431 struct tty_driver *tty_driver;
432};
433
434void uart_write_wakeup(struct uart_port *port);
435
436/*
437 * Baud rate helpers.
438 */
439void uart_update_timeout(struct uart_port *port, unsigned int cflag,
440 unsigned int baud);
441unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
442 struct ktermios *old, unsigned int min,
443 unsigned int max);
444unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
445
446/* Base timer interval for polling */
447static inline int uart_poll_timeout(struct uart_port *port)
448{
449 int timeout = port->timeout;
450
451 return timeout > 6 ? (timeout / 2 - 2) : 1;
452}
453
454/*
455 * Console helpers.
456 */
457struct uart_port *uart_get_console(struct uart_port *ports, int nr,
458 struct console *c);
459void uart_parse_options(char *options, int *baud, int *parity, int *bits,
460 int *flow);
461int uart_set_options(struct uart_port *port, struct console *co, int baud,
462 int parity, int bits, int flow);
463struct tty_driver *uart_console_device(struct console *co, int *index);
464void uart_console_write(struct uart_port *port, const char *s,
465 unsigned int count,
466 void (*putchar)(struct uart_port *, int));
467
468/*
469 * Port/driver registration/removal
470 */
471int uart_register_driver(struct uart_driver *uart);
472void uart_unregister_driver(struct uart_driver *uart);
473int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
474int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
475int uart_match_port(struct uart_port *port1, struct uart_port *port2);
476
477/*
478 * Power Management
479 */
480int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
481int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
482
483#define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
484#define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
485
486#define uart_circ_chars_pending(circ) \
487 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
488
489#define uart_circ_chars_free(circ) \
490 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
491
492static inline int uart_tx_stopped(struct uart_port *port)
493{
494 struct tty_struct *tty = port->state->port.tty;
495 if(tty->stopped || tty->hw_stopped)
496 return 1;
497 return 0;
498}
499
500/*
501 * The following are helper functions for the low level drivers.
502 */
503
504extern void uart_handle_dcd_change(struct uart_port *uport,
505 unsigned int status);
506extern void uart_handle_cts_change(struct uart_port *uport,
507 unsigned int status);
508
509extern void uart_insert_char(struct uart_port *port, unsigned int status,
510 unsigned int overrun, unsigned int ch, unsigned int flag);
511
512#ifdef SUPPORT_SYSRQ
513static inline int
514uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
515{
516 if (port->sysrq) {
517 if (ch && time_before(jiffies, port->sysrq)) {
518 handle_sysrq(ch);
519 port->sysrq = 0;
520 return 1;
521 }
522 port->sysrq = 0;
523 }
524 return 0;
525}
526#else
527#define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
528#endif
529
530/*
531 * We do the SysRQ and SAK checking like this...
532 */
533static inline int uart_handle_break(struct uart_port *port)
534{
535 struct uart_state *state = port->state;
536#ifdef SUPPORT_SYSRQ
537 if (port->cons && port->cons->index == port->line) {
538 if (!port->sysrq) {
539 port->sysrq = jiffies + HZ*5;
540 return 1;
541 }
542 port->sysrq = 0;
543 }
544#endif
545 if (port->flags & UPF_SAK)
546 do_SAK(state->port.tty);
547 return 0;
548}
549
550/*
551 * UART_ENABLE_MS - determine if port should enable modem status irqs
552 */
553#define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
554 (cflag) & CRTSCTS || \
555 !((cflag) & CLOCAL))
556
557#endif
558
559#endif /* LINUX_SERIAL_CORE_H */