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