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
33 #define PORT_16650V2 7
35 #define PORT_STARTECH 9
36 #define PORT_16C950 10
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.
53 #define PORT_CLPS711X 33
54 #define PORT_SA1100 34
55 #define PORT_UART00 35
58 /* Sparc type numbers. */
59 #define PORT_SUNZILOG 38
60 #define PORT_SUNSAB 39
63 #define PORT_V850E_UART 40
68 /* Parisc type numbers. */
71 /* Atmel AT91 / AT32 SoC */
74 /* Macintosh Zilog type numbers */
75 #define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
76 #define PORT_PMAC_ZILOG 51
83 /* Samsung S3C2410 SoC and derivatives thereof */
84 #define PORT_S3C2410 55
86 /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
87 #define PORT_IP22ZILOG 56
89 /* Sharp LH7a40x -- an ARM9 SoC series */
90 #define PORT_LH7A40X 57
92 /* PPC CPM type number */
95 /* MPC52xx type numbers */
96 #define PORT_MPC52xx 59
101 /* Samsung S3C2440 SoC */
102 #define PORT_S3C2440 61
104 /* Motorola i.MX SoC */
110 /* TXX9 type number */
113 /* NEC VR4100 series SIU/DSIU */
114 #define PORT_VR41XX_SIU 65
115 #define PORT_VR41XX_DSIU 66
117 /* Samsung S3C2400 SoC */
118 #define PORT_S3C2400 67
121 #define PORT_M32R_SIO 68
126 #define PORT_PNX8XXX 70
131 /* SUN4V Hypervisor Console */
132 #define PORT_SUNHV 72
134 #define PORT_S3C2412 73
136 /* Xilinx uartlite */
137 #define PORT_UARTLITE 74
141 #include <linux/compiler.h>
142 #include <linux/interrupt.h>
143 #include <linux/circ_buf.h>
144 #include <linux/spinlock.h>
145 #include <linux/sched.h>
146 #include <linux/tty.h>
147 #include <linux/mutex.h>
151 struct serial_struct
;
155 * This structure describes all the operations that can be
156 * done on the physical hardware.
159 unsigned int (*tx_empty
)(struct uart_port
*);
160 void (*set_mctrl
)(struct uart_port
*, unsigned int mctrl
);
161 unsigned int (*get_mctrl
)(struct uart_port
*);
162 void (*stop_tx
)(struct uart_port
*);
163 void (*start_tx
)(struct uart_port
*);
164 void (*send_xchar
)(struct uart_port
*, char ch
);
165 void (*stop_rx
)(struct uart_port
*);
166 void (*enable_ms
)(struct uart_port
*);
167 void (*break_ctl
)(struct uart_port
*, int ctl
);
168 int (*startup
)(struct uart_port
*);
169 void (*shutdown
)(struct uart_port
*);
170 void (*set_termios
)(struct uart_port
*, struct ktermios
*new,
171 struct ktermios
*old
);
172 void (*pm
)(struct uart_port
*, unsigned int state
,
173 unsigned int oldstate
);
174 int (*set_wake
)(struct uart_port
*, unsigned int state
);
177 * Return a string describing the type of the port
179 const char *(*type
)(struct uart_port
*);
182 * Release IO and memory resources used by the port.
183 * This includes iounmap if necessary.
185 void (*release_port
)(struct uart_port
*);
188 * Request IO and memory resources used by the port.
189 * This includes iomapping the port if necessary.
191 int (*request_port
)(struct uart_port
*);
192 void (*config_port
)(struct uart_port
*, int);
193 int (*verify_port
)(struct uart_port
*, struct serial_struct
*);
194 int (*ioctl
)(struct uart_port
*, unsigned int, unsigned long);
197 #define UART_CONFIG_TYPE (1 << 0)
198 #define UART_CONFIG_IRQ (1 << 1)
214 typedef unsigned int __bitwise__ upf_t
;
217 spinlock_t lock
; /* port lock */
218 unsigned int iobase
; /* in/out[bwl] */
219 unsigned char __iomem
*membase
; /* read/write[bwl] */
220 unsigned int irq
; /* irq number */
221 unsigned int uartclk
; /* base uart clock */
222 unsigned int fifosize
; /* tx fifo size */
223 unsigned char x_char
; /* xon/xoff char */
224 unsigned char regshift
; /* reg offset shift */
225 unsigned char iotype
; /* io access style */
226 unsigned char unused1
;
228 #define UPIO_PORT (0)
229 #define UPIO_HUB6 (1)
231 #define UPIO_MEM32 (3)
232 #define UPIO_AU (4) /* Au1x00 type IO */
233 #define UPIO_TSI (5) /* Tsi108/109 type IO */
234 #define UPIO_DWAPB (6) /* DesignWare APB UART */
235 #define UPIO_RM9000 (7) /* RM9000 type IO */
237 unsigned int read_status_mask
; /* driver specific */
238 unsigned int ignore_status_mask
; /* driver specific */
239 struct uart_info
*info
; /* pointer to parent info */
240 struct uart_icount icount
; /* statistics */
242 struct console
*cons
; /* struct console, if any */
243 #ifdef CONFIG_SERIAL_CORE_CONSOLE
244 unsigned long sysrq
; /* sysrq timeout */
249 #define UPF_FOURPORT ((__force upf_t) (1 << 1))
250 #define UPF_SAK ((__force upf_t) (1 << 2))
251 #define UPF_SPD_MASK ((__force upf_t) (0x1030))
252 #define UPF_SPD_HI ((__force upf_t) (0x0010))
253 #define UPF_SPD_VHI ((__force upf_t) (0x0020))
254 #define UPF_SPD_CUST ((__force upf_t) (0x0030))
255 #define UPF_SPD_SHI ((__force upf_t) (0x1000))
256 #define UPF_SPD_WARP ((__force upf_t) (0x1010))
257 #define UPF_SKIP_TEST ((__force upf_t) (1 << 6))
258 #define UPF_AUTO_IRQ ((__force upf_t) (1 << 7))
259 #define UPF_HARDPPS_CD ((__force upf_t) (1 << 11))
260 #define UPF_LOW_LATENCY ((__force upf_t) (1 << 13))
261 #define UPF_BUGGY_UART ((__force upf_t) (1 << 14))
262 #define UPF_MAGIC_MULTIPLIER ((__force upf_t) (1 << 16))
263 #define UPF_CONS_FLOW ((__force upf_t) (1 << 23))
264 #define UPF_SHARE_IRQ ((__force upf_t) (1 << 24))
265 #define UPF_BOOT_AUTOCONF ((__force upf_t) (1 << 28))
266 #define UPF_FIXED_PORT ((__force upf_t) (1 << 29))
267 #define UPF_DEAD ((__force upf_t) (1 << 30))
268 #define UPF_IOREMAP ((__force upf_t) (1 << 31))
270 #define UPF_CHANGE_MASK ((__force upf_t) (0x17fff))
271 #define UPF_USR_MASK ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
273 unsigned int mctrl
; /* current modem ctrl settings */
274 unsigned int timeout
; /* character-based timeout */
275 unsigned int type
; /* port type */
276 const struct uart_ops
*ops
;
277 unsigned int custom_divisor
;
278 unsigned int line
; /* port index */
279 unsigned long mapbase
; /* for ioremap */
280 struct device
*dev
; /* parent device */
281 unsigned char hub6
; /* this should be in the 8250 driver */
282 unsigned char unused
[3];
283 void *private_data
; /* generic platform data pointer */
287 * This is the state information which is persistent across opens.
288 * The low level driver must not to touch any elements contained
292 unsigned int close_delay
; /* msec */
293 unsigned int closing_wait
; /* msec */
295 #define USF_CLOSING_WAIT_INF (0)
296 #define USF_CLOSING_WAIT_NONE (~0U)
300 struct uart_info
*info
;
301 struct uart_port
*port
;
306 #define UART_XMIT_SIZE PAGE_SIZE
308 typedef unsigned int __bitwise__ uif_t
;
311 * This is the state information which is only valid when the port
312 * is open; it may be freed by the core driver once the device has
313 * been closed. Either the low level driver or the core can modify
317 struct tty_struct
*tty
;
318 struct circ_buf xmit
;
322 * Definitions for info->flags. These are _private_ to serial_core, and
323 * are specific to this structure. They may be queried by low level drivers.
325 #define UIF_CHECK_CD ((__force uif_t) (1 << 25))
326 #define UIF_CTS_FLOW ((__force uif_t) (1 << 26))
327 #define UIF_NORMAL_ACTIVE ((__force uif_t) (1 << 29))
328 #define UIF_INITIALIZED ((__force uif_t) (1 << 31))
329 #define UIF_SUSPENDED ((__force uif_t) (1 << 30))
333 struct tasklet_struct tlet
;
335 wait_queue_head_t open_wait
;
336 wait_queue_head_t delta_msr_wait
;
339 /* number of characters left in xmit buffer before we ask for more */
340 #define WAKEUP_CHARS 256
346 struct module
*owner
;
347 const char *driver_name
;
348 const char *dev_name
;
352 struct console
*cons
;
355 * these are private; the low level driver should not
356 * touch these; they should be initialised to NULL
358 struct uart_state
*state
;
359 struct tty_driver
*tty_driver
;
362 void uart_write_wakeup(struct uart_port
*port
);
367 void uart_update_timeout(struct uart_port
*port
, unsigned int cflag
,
369 unsigned int uart_get_baud_rate(struct uart_port
*port
, struct ktermios
*termios
,
370 struct ktermios
*old
, unsigned int min
,
372 unsigned int uart_get_divisor(struct uart_port
*port
, unsigned int baud
);
377 struct uart_port
*uart_get_console(struct uart_port
*ports
, int nr
,
379 void uart_parse_options(char *options
, int *baud
, int *parity
, int *bits
,
381 int uart_set_options(struct uart_port
*port
, struct console
*co
, int baud
,
382 int parity
, int bits
, int flow
);
383 struct tty_driver
*uart_console_device(struct console
*co
, int *index
);
384 void uart_console_write(struct uart_port
*port
, const char *s
,
386 void (*putchar
)(struct uart_port
*, int));
389 * Port/driver registration/removal
391 int uart_register_driver(struct uart_driver
*uart
);
392 void uart_unregister_driver(struct uart_driver
*uart
);
393 int uart_add_one_port(struct uart_driver
*reg
, struct uart_port
*port
);
394 int uart_remove_one_port(struct uart_driver
*reg
, struct uart_port
*port
);
395 int uart_match_port(struct uart_port
*port1
, struct uart_port
*port2
);
400 int uart_suspend_port(struct uart_driver
*reg
, struct uart_port
*port
);
401 int uart_resume_port(struct uart_driver
*reg
, struct uart_port
*port
);
403 #define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
404 #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
406 #define uart_circ_chars_pending(circ) \
407 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
409 #define uart_circ_chars_free(circ) \
410 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
412 #define uart_tx_stopped(port) \
413 ((port)->info->tty->stopped || (port)->info->tty->hw_stopped)
416 * The following are helper functions for the low level drivers.
419 uart_handle_sysrq_char(struct uart_port
*port
, unsigned int ch
)
423 if (ch
&& time_before(jiffies
, port
->sysrq
)) {
424 handle_sysrq(ch
, port
->info
->tty
);
433 #ifndef SUPPORT_SYSRQ
434 #define uart_handle_sysrq_char(port,ch) uart_handle_sysrq_char(port, 0)
438 * We do the SysRQ and SAK checking like this...
440 static inline int uart_handle_break(struct uart_port
*port
)
442 struct uart_info
*info
= port
->info
;
444 if (port
->cons
&& port
->cons
->index
== port
->line
) {
446 port
->sysrq
= jiffies
+ HZ
*5;
452 if (port
->flags
& UPF_SAK
)
458 * uart_handle_dcd_change - handle a change of carrier detect state
459 * @port: uart_port structure for the open port
460 * @status: new carrier detect status, nonzero if active
463 uart_handle_dcd_change(struct uart_port
*port
, unsigned int status
)
465 struct uart_info
*info
= port
->info
;
469 #ifdef CONFIG_HARD_PPS
470 if ((port
->flags
& UPF_HARDPPS_CD
) && status
)
474 if (info
->flags
& UIF_CHECK_CD
) {
476 wake_up_interruptible(&info
->open_wait
);
478 tty_hangup(info
->tty
);
483 * uart_handle_cts_change - handle a change of clear-to-send state
484 * @port: uart_port structure for the open port
485 * @status: new clear to send status, nonzero if active
488 uart_handle_cts_change(struct uart_port
*port
, unsigned int status
)
490 struct uart_info
*info
= port
->info
;
491 struct tty_struct
*tty
= info
->tty
;
495 if (info
->flags
& UIF_CTS_FLOW
) {
496 if (tty
->hw_stopped
) {
499 port
->ops
->start_tx(port
);
500 uart_write_wakeup(port
);
505 port
->ops
->stop_tx(port
);
511 #include <linux/tty_flip.h>
514 uart_insert_char(struct uart_port
*port
, unsigned int status
,
515 unsigned int overrun
, unsigned int ch
, unsigned int flag
)
517 struct tty_struct
*tty
= port
->info
->tty
;
519 if ((status
& port
->ignore_status_mask
& ~overrun
) == 0)
520 tty_insert_flip_char(tty
, ch
, flag
);
523 * Overrun is special. Since it's reported immediately,
524 * it doesn't affect the current character.
526 if (status
& ~port
->ignore_status_mask
& overrun
)
527 tty_insert_flip_char(tty
, 0, TTY_OVERRUN
);
531 * UART_ENABLE_MS - determine if port should enable modem status irqs
533 #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
534 (cflag) & CRTSCTS || \
539 #endif /* LINUX_SERIAL_CORE_H */