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