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