Pileus Git - ~andy/linux/blob - include/linux/serial_core.h

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