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