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_MAX_8250 15 /* max port ID */
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.
52 #define PORT_CLPS711X 33
53 #define PORT_SA1100 34
54 #define PORT_UART00 35
57 /* Sparc type numbers. */
58 #define PORT_SUNZILOG 38
59 #define PORT_SUNSAB 39
62 #define PORT_V850E_UART 40
67 /* Parisc type numbers. */
70 /* Macintosh Zilog type numbers */
71 #define PORT_MAC_ZILOG 50 /* m68k : not yet implemented */
72 #define PORT_PMAC_ZILOG 51
79 /* Samsung S3C2410 SoC and derivatives thereof */
80 #define PORT_S3C2410 55
82 /* SGI IP22 aka Indy / Challenge S / Indigo 2 */
83 #define PORT_IP22ZILOG 56
85 /* Sharp LH7a40x -- an ARM9 SoC series */
86 #define PORT_LH7A40X 57
88 /* PPC CPM type number */
91 /* MPC52xx type numbers */
92 #define PORT_MPC52xx 59
97 /* Samsung S3C2440 SoC */
98 #define PORT_S3C2440 61
100 /* Motorola i.MX SoC */
106 /* TXX9 type number */
111 #include <linux/config.h>
112 #include <linux/interrupt.h>
113 #include <linux/circ_buf.h>
114 #include <linux/spinlock.h>
115 #include <linux/sched.h>
116 #include <linux/tty.h>
120 struct serial_struct;
124 * This structure describes all the operations that can be
125 * done on the physical hardware.
128 unsigned int (*tx_empty)(struct uart_port *);
129 void (*set_mctrl)(struct uart_port *, unsigned int mctrl);
130 unsigned int (*get_mctrl)(struct uart_port *);
131 void (*stop_tx)(struct uart_port *, unsigned int tty_stop);
132 void (*start_tx)(struct uart_port *, unsigned int tty_start);
133 void (*send_xchar)(struct uart_port *, char ch);
134 void (*stop_rx)(struct uart_port *);
135 void (*enable_ms)(struct uart_port *);
136 void (*break_ctl)(struct uart_port *, int ctl);
137 int (*startup)(struct uart_port *);
138 void (*shutdown)(struct uart_port *);
139 void (*set_termios)(struct uart_port *, struct termios *new,
140 struct termios *old);
141 void (*pm)(struct uart_port *, unsigned int state,
142 unsigned int oldstate);
143 int (*set_wake)(struct uart_port *, unsigned int state);
146 * Return a string describing the type of the port
148 const char *(*type)(struct uart_port *);
151 * Release IO and memory resources used by the port.
152 * This includes iounmap if necessary.
154 void (*release_port)(struct uart_port *);
157 * Request IO and memory resources used by the port.
158 * This includes iomapping the port if necessary.
160 int (*request_port)(struct uart_port *);
161 void (*config_port)(struct uart_port *, int);
162 int (*verify_port)(struct uart_port *, struct serial_struct *);
163 int (*ioctl)(struct uart_port *, unsigned int, unsigned long);
166 #define UART_CONFIG_TYPE (1 << 0)
167 #define UART_CONFIG_IRQ (1 << 1)
184 spinlock_t lock; /* port lock */
185 unsigned int iobase; /* in/out[bwl] */
186 unsigned char __iomem *membase; /* read/write[bwl] */
187 unsigned int irq; /* irq number */
188 unsigned int uartclk; /* base uart clock */
189 unsigned char fifosize; /* tx fifo size */
190 unsigned char x_char; /* xon/xoff char */
191 unsigned char regshift; /* reg offset shift */
192 unsigned char iotype; /* io access style */
194 #define UPIO_PORT (0)
195 #define UPIO_HUB6 (1)
197 #define UPIO_MEM32 (3)
199 unsigned int read_status_mask; /* driver specific */
200 unsigned int ignore_status_mask; /* driver specific */
201 struct uart_info *info; /* pointer to parent info */
202 struct uart_icount icount; /* statistics */
204 struct console *cons; /* struct console, if any */
205 #ifdef CONFIG_SERIAL_CORE_CONSOLE
206 unsigned long sysrq; /* sysrq timeout */
211 #define UPF_FOURPORT (1 << 1)
212 #define UPF_SAK (1 << 2)
213 #define UPF_SPD_MASK (0x1030)
214 #define UPF_SPD_HI (0x0010)
215 #define UPF_SPD_VHI (0x0020)
216 #define UPF_SPD_CUST (0x0030)
217 #define UPF_SPD_SHI (0x1000)
218 #define UPF_SPD_WARP (0x1010)
219 #define UPF_SKIP_TEST (1 << 6)
220 #define UPF_AUTO_IRQ (1 << 7)
221 #define UPF_HARDPPS_CD (1 << 11)
222 #define UPF_LOW_LATENCY (1 << 13)
223 #define UPF_BUGGY_UART (1 << 14)
224 #define UPF_AUTOPROBE (1 << 15)
225 #define UPF_MAGIC_MULTIPLIER (1 << 16)
226 #define UPF_BOOT_ONLYMCA (1 << 22)
227 #define UPF_CONS_FLOW (1 << 23)
228 #define UPF_SHARE_IRQ (1 << 24)
229 #define UPF_BOOT_AUTOCONF (1 << 28)
230 #define UPF_IOREMAP (1 << 31)
232 #define UPF_CHANGE_MASK (0x17fff)
233 #define UPF_USR_MASK (UPF_SPD_MASK|UPF_LOW_LATENCY)
235 unsigned int mctrl; /* current modem ctrl settings */
236 unsigned int timeout; /* character-based timeout */
237 unsigned int type; /* port type */
238 struct uart_ops *ops;
239 unsigned int custom_divisor;
240 unsigned int line; /* port index */
241 unsigned long mapbase; /* for ioremap */
242 struct device *dev; /* parent device */
243 unsigned char hub6; /* this should be in the 8250 driver */
244 unsigned char unused[3];
248 * This is the state information which is persistent across opens.
249 * The low level driver must not to touch any elements contained
253 unsigned int close_delay; /* msec */
254 unsigned int closing_wait; /* msec */
256 #define USF_CLOSING_WAIT_INF (0)
257 #define USF_CLOSING_WAIT_NONE (~0U)
261 struct uart_info *info;
262 struct uart_port *port;
264 struct semaphore sem;
267 #define UART_XMIT_SIZE PAGE_SIZE
269 * This is the state information which is only valid when the port
270 * is open; it may be freed by the core driver once the device has
271 * been closed. Either the low level driver or the core can modify
275 struct tty_struct *tty;
276 struct circ_buf xmit;
280 * These are the flags that specific to info->flags, and reflect our
281 * internal state. They can not be accessed via port->flags. Low
282 * level drivers must not change these, but may query them instead.
284 #define UIF_CHECK_CD (1 << 25)
285 #define UIF_CTS_FLOW (1 << 26)
286 #define UIF_NORMAL_ACTIVE (1 << 29)
287 #define UIF_INITIALIZED (1 << 31)
291 struct tasklet_struct tlet;
293 wait_queue_head_t open_wait;
294 wait_queue_head_t delta_msr_wait;
297 /* number of characters left in xmit buffer before we ask for more */
298 #define WAKEUP_CHARS 256
304 struct module *owner;
305 const char *driver_name;
306 const char *dev_name;
307 const char *devfs_name;
311 struct console *cons;
314 * these are private; the low level driver should not
315 * touch these; they should be initialised to NULL
317 struct uart_state *state;
318 struct tty_driver *tty_driver;
321 void uart_write_wakeup(struct uart_port *port);
326 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
328 unsigned int uart_get_baud_rate(struct uart_port *port, struct termios *termios,
329 struct termios *old, unsigned int min,
331 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
336 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
338 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
340 int uart_set_options(struct uart_port *port, struct console *co, int baud,
341 int parity, int bits, int flow);
342 struct tty_driver *uart_console_device(struct console *co, int *index);
345 * Port/driver registration/removal
347 int uart_register_driver(struct uart_driver *uart);
348 void uart_unregister_driver(struct uart_driver *uart);
349 void uart_unregister_port(struct uart_driver *reg, int line);
350 int uart_register_port(struct uart_driver *reg, struct uart_port *port);
351 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
352 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
357 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
358 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
360 #define uart_circ_empty(circ) ((circ)->head == (circ)->tail)
361 #define uart_circ_clear(circ) ((circ)->head = (circ)->tail = 0)
363 #define uart_circ_chars_pending(circ) \
364 (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
366 #define uart_circ_chars_free(circ) \
367 (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
369 #define uart_tx_stopped(port) \
370 ((port)->info->tty->stopped || (port)->info->tty->hw_stopped)
373 * The following are helper functions for the low level drivers.
377 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch,
378 struct pt_regs *regs)
381 if (ch && time_before(jiffies, port->sysrq)) {
382 handle_sysrq(ch, regs, NULL);
391 #define uart_handle_sysrq_char(port,ch,regs) (0)
395 * We do the SysRQ and SAK checking like this...
397 static inline int uart_handle_break(struct uart_port *port)
399 struct uart_info *info = port->info;
401 if (port->cons && port->cons->index == port->line) {
403 port->sysrq = jiffies + HZ*5;
409 if (info->flags & UPF_SAK)
415 * uart_handle_dcd_change - handle a change of carrier detect state
416 * @port: uart_port structure for the open port
417 * @status: new carrier detect status, nonzero if active
420 uart_handle_dcd_change(struct uart_port *port, unsigned int status)
422 struct uart_info *info = port->info;
426 #ifdef CONFIG_HARD_PPS
427 if ((port->flags & UPF_HARDPPS_CD) && status)
431 if (info->flags & UIF_CHECK_CD) {
433 wake_up_interruptible(&info->open_wait);
435 tty_hangup(info->tty);
440 * uart_handle_cts_change - handle a change of clear-to-send state
441 * @port: uart_port structure for the open port
442 * @status: new clear to send status, nonzero if active
445 uart_handle_cts_change(struct uart_port *port, unsigned int status)
447 struct uart_info *info = port->info;
448 struct tty_struct *tty = info->tty;
452 if (info->flags & UIF_CTS_FLOW) {
453 if (tty->hw_stopped) {
456 port->ops->start_tx(port, 0);
457 uart_write_wakeup(port);
462 port->ops->stop_tx(port, 0);
469 * UART_ENABLE_MS - determine if port should enable modem status irqs
471 #define UART_ENABLE_MS(port,cflag) ((port)->flags & UPF_HARDPPS_CD || \
472 (cflag) & CRTSCTS || \
477 #endif /* LINUX_SERIAL_CORE_H */