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_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 */
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.
60 #define PORT_CLPS711X 33
61 #define PORT_SA1100 34
62 #define PORT_UART00 35
65 /* Sparc type numbers. */
66 #define PORT_SUNZILOG 38
67 #define PORT_SUNSAB 39
73 /* Parisc type numbers. */
76 /* Atmel AT91 / AT32 SoC */
79 /* Macintosh Zilog type numbers */
80 #define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
81 #define PORT_PMAC_ZILOG 51
88 /* Samsung S3C2410 SoC and derivatives thereof */
89 #define PORT_S3C2410 55
91 /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
92 #define PORT_IP22ZILOG 56
94 /* Sharp LH7a40x -- an ARM9 SoC series */
95 #define PORT_LH7A40X 57
97 /* PPC CPM type number */
100 /* MPC52xx (and MPC512x) type numbers */
101 #define PORT_MPC52xx 59
106 /* Samsung S3C2440 SoC */
107 #define PORT_S3C2440 61
109 /* Motorola i.MX SoC */
115 /* TXX9 type number */
118 /* NEC VR4100 series SIU/DSIU */
119 #define PORT_VR41XX_SIU 65
120 #define PORT_VR41XX_DSIU 66
122 /* Samsung S3C2400 SoC */
123 #define PORT_S3C2400 67
126 #define PORT_M32R_SIO 68
131 #define PORT_PNX8XXX 70
136 /* SUN4V Hypervisor Console */
137 #define PORT_SUNHV 72
139 #define PORT_S3C2412 73
141 /* Xilinx uartlite */
142 #define PORT_UARTLITE 74
148 #define PORT_KS8695 76
150 /* Broadcom SB1250, etc. SOC */
151 #define PORT_SB1250_DUART 77
153 /* Freescale ColdFire */
157 #define PORT_BFIN_SPORT 79
159 /* MN10300 on-chip UART numbers */
160 #define PORT_MN10300 80
161 #define PORT_MN10300_CTS 81
163 #define PORT_SC26XX 82
166 #define PORT_SCIFA 83
168 #define PORT_S3C6400 84
171 #define PORT_NWPSERIAL 85
174 #define PORT_MAX3100 86
176 /* Timberdale UART */
177 #define PORT_TIMBUART 87
179 /* Qualcomm MSM SoCs */
182 /* BCM63xx family SoCs */
183 #define PORT_BCM63XX 89
185 /* Aeroflex Gaisler GRLIB APBUART */
186 #define PORT_APBUART 90
189 #define PORT_ALTERA_JTAGUART 91
190 #define PORT_ALTERA_UART 92
193 #define PORT_SCIFB 93
196 #define PORT_MAX3107 94
198 /* High Speed UART for Medfield */
205 #define PORT_VT8500 97
207 /* Xilinx PSS UART */
208 #define PORT_XUARTPS 98
210 /* Atheros AR933X SoC */
211 #define PORT_AR933X 99
213 /* Energy Micro efm32 SoC */
214 #define PORT_EFMUART 100
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>
229 struct serial_struct
;
233 * This structure describes all the operations that can be
234 * done on the physical hardware.
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
);
257 * Return a string describing the type of the port
259 const char *(*type
)(struct uart_port
*);
262 * Release IO and memory resources used by the port.
263 * This includes iounmap if necessary.
265 void (*release_port
)(struct uart_port
*);
268 * Request IO and memory resources used by the port.
269 * This includes iomapping the port if necessary.
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
*);
281 #define NO_POLL_CHAR 0x00ff0000
282 #define UART_CONFIG_TYPE (1 << 0)
283 #define UART_CONFIG_IRQ (1 << 1)
299 typedef unsigned int __bitwise__ upf_t
;
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
,
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
;
322 #define UPIO_PORT (0)
323 #define UPIO_HUB6 (1)
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 */
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 */
335 struct console
*cons
; /* struct console, if any */
336 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
337 unsigned long sysrq
; /* sysrq timeout */
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_IIR_ONCE ((__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))
368 #define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
369 #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
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 */
386 static inline int serial_port_in(struct uart_port
*up
, int offset
)
388 return up
->serial_in(up
, offset
);
391 static inline void serial_port_out(struct uart_port
*up
, int offset
, int value
)
393 up
->serial_out(up
, offset
, value
);
397 * This is the state information which is persistent across opens.
400 struct tty_port port
;
403 struct circ_buf xmit
;
405 struct uart_port
*uart_port
;
408 #define UART_XMIT_SIZE PAGE_SIZE
411 /* number of characters left in xmit buffer before we ask for more */
412 #define WAKEUP_CHARS 256
418 struct module
*owner
;
419 const char *driver_name
;
420 const char *dev_name
;
424 struct console
*cons
;
427 * these are private; the low level driver should not
428 * touch these; they should be initialised to NULL
430 struct uart_state
*state
;
431 struct tty_driver
*tty_driver
;
434 void uart_write_wakeup(struct uart_port
*port
);
439 void uart_update_timeout(struct uart_port
*port
, unsigned int cflag
,
441 unsigned int uart_get_baud_rate(struct uart_port
*port
, struct ktermios
*termios
,
442 struct ktermios
*old
, unsigned int min
,
444 unsigned int uart_get_divisor(struct uart_port
*port
, unsigned int baud
);
446 /* Base timer interval for polling */
447 static inline int uart_poll_timeout(struct uart_port
*port
)
449 int timeout
= port
->timeout
;
451 return timeout
> 6 ? (timeout
/ 2 - 2) : 1;
457 struct uart_port
*uart_get_console(struct uart_port
*ports
, int nr
,
459 void uart_parse_options(char *options
, int *baud
, int *parity
, int *bits
,
461 int uart_set_options(struct uart_port
*port
, struct console
*co
, int baud
,
462 int parity
, int bits
, int flow
);
463 struct tty_driver
*uart_console_device(struct console
*co
, int *index
);
464 void uart_console_write(struct uart_port
*port
, const char *s
,
466 void (*putchar
)(struct uart_port
*, int));
469 * Port/driver registration/removal
471 int uart_register_driver(struct uart_driver
*uart
);
472 void uart_unregister_driver(struct uart_driver
*uart
);
473 int uart_add_one_port(struct uart_driver
*reg
, struct uart_port
*port
);
474 int uart_remove_one_port(struct uart_driver
*reg
, struct uart_port
*port
);
475 int uart_match_port(struct uart_port
*port1
, struct uart_port
*port2
);
480 int uart_suspend_port(struct uart_driver
*reg
, struct uart_port
*port
);
481 int uart_resume_port(struct uart_driver
*reg
, struct uart_port
*port
);
483 #define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
484 #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
486 #define uart_circ_chars_pending(circ) \
487 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
489 #define uart_circ_chars_free(circ) \
490 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
492 static inline int uart_tx_stopped(struct uart_port
*port
)
494 struct tty_struct
*tty
= port
->state
->port
.tty
;
495 if(tty
->stopped
|| tty
->hw_stopped
)
501 * The following are helper functions for the low level drivers.
504 extern void uart_handle_dcd_change(struct uart_port
*uport
,
505 unsigned int status
);
506 extern void uart_handle_cts_change(struct uart_port
*uport
,
507 unsigned int status
);
509 extern void uart_insert_char(struct uart_port
*port
, unsigned int status
,
510 unsigned int overrun
, unsigned int ch
, unsigned int flag
);
514 uart_handle_sysrq_char(struct uart_port
*port
, unsigned int ch
)
517 if (ch
&& time_before(jiffies
, port
->sysrq
)) {
527 #define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
531 * We do the SysRQ and SAK checking like this...
533 static inline int uart_handle_break(struct uart_port
*port
)
535 struct uart_state
*state
= port
->state
;
537 if (port
->cons
&& port
->cons
->index
== port
->line
) {
539 port
->sysrq
= jiffies
+ HZ
*5;
545 if (port
->flags
& UPF_SAK
)
546 do_SAK(state
->port
.tty
);
551 * UART_ENABLE_MS - determine if port should enable modem status irqs
553 #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
554 (cflag) & CRTSCTS || \
559 #endif /* LINUX_SERIAL_CORE_H */