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_MAX_8250   16      /* max port ID */
  44
  45 /*
  46  * ARM specific type numbers.  These are not currently guaranteed
  47  * to be implemented, and will change in the future.  These are
  48  * separate so any additions to the old serial.c that occur before
  49  * we are merged can be easily merged here.
  50  */
  51 #define PORT_PXA        31
  52 #define PORT_AMBA       32
  53 #define PORT_CLPS711X   33
  54 #define PORT_SA1100     34
  55 #define PORT_UART00     35
  56 #define PORT_21285      37
  57
  58 /* Sparc type numbers.  */
  59 #define PORT_SUNZILOG   38
  60 #define PORT_SUNSAB     39
  61
  62 /* NEC v850.  */
  63 #define PORT_V850E_UART 40
  64
  65 /* DZ */
  66 #define PORT_DZ         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 #ifdef __KERNEL__
 140
 141 #include <linux/compiler.h>
 142 #include <linux/interrupt.h>
 143 #include <linux/circ_buf.h>
 144 #include <linux/spinlock.h>
 145 #include <linux/sched.h>
 146 #include <linux/tty.h>
 147 #include <linux/mutex.h>
 148
 149 struct uart_port;
 150 struct uart_info;
 151 struct serial_struct;
 152 struct device;
 153
 154 /*
 155  * This structure describes all the operations that can be
 156  * done on the physical hardware.
 157  */
 158 struct uart_ops {
 159         unsigned int    (*tx_empty)(struct uart_port *);
 160         void            (*set_mctrl)(struct uart_port *, unsigned int mctrl);
 161         unsigned int    (*get_mctrl)(struct uart_port *);
 162         void            (*stop_tx)(struct uart_port *);
 163         void            (*start_tx)(struct uart_port *);
 164         void            (*send_xchar)(struct uart_port *, char ch);
 165         void            (*stop_rx)(struct uart_port *);
 166         void            (*enable_ms)(struct uart_port *);
 167         void            (*break_ctl)(struct uart_port *, int ctl);
 168         int             (*startup)(struct uart_port *);
 169         void            (*shutdown)(struct uart_port *);
 170         void            (*set_termios)(struct uart_port *, struct ktermios *new,
 171                                        struct ktermios *old);
 172         void            (*pm)(struct uart_port *, unsigned int state,
 173                               unsigned int oldstate);
 174         int             (*set_wake)(struct uart_port *, unsigned int state);
 175
 176         /*
 177          * Return a string describing the type of the port
 178          */
 179         const char *(*type)(struct uart_port *);
 180
 181         /*
 182          * Release IO and memory resources used by the port.
 183          * This includes iounmap if necessary.
 184          */
 185         void            (*release_port)(struct uart_port *);
 186
 187         /*
 188          * Request IO and memory resources used by the port.
 189          * This includes iomapping the port if necessary.
 190          */
 191         int             (*request_port)(struct uart_port *);
 192         void            (*config_port)(struct uart_port *, int);
 193         int             (*verify_port)(struct uart_port *, struct serial_struct *);
 194         int             (*ioctl)(struct uart_port *, unsigned int, unsigned long);
 195 };
 196
 197 #define UART_CONFIG_TYPE        (1 << 0)
 198 #define UART_CONFIG_IRQ         (1 << 1)
 199
 200 struct uart_icount {
 201         __u32   cts;
 202         __u32   dsr;
 203         __u32   rng;
 204         __u32   dcd;
 205         __u32   rx;
 206         __u32   tx;
 207         __u32   frame;
 208         __u32   overrun;
 209         __u32   parity;
 210         __u32   brk;
 211         __u32   buf_overrun;
 212 };
 213
 214 typedef unsigned int __bitwise__ upf_t;
 215
 216 struct uart_port {
 217         spinlock_t              lock;                   /* port lock */
 218         unsigned int            iobase;                 /* in/out[bwl] */
 219         unsigned char __iomem   *membase;               /* read/write[bwl] */
 220         unsigned int            irq;                    /* irq number */
 221         unsigned int            uartclk;                /* base uart clock */
 222         unsigned int            fifosize;               /* tx fifo size */
 223         unsigned char           x_char;                 /* xon/xoff char */
 224         unsigned char           regshift;               /* reg offset shift */
 225         unsigned char           iotype;                 /* io access style */
 226         unsigned char           unused1;
 227
 228 #define UPIO_PORT               (0)
 229 #define UPIO_HUB6               (1)
 230 #define UPIO_MEM                (2)
 231 #define UPIO_MEM32              (3)
 232 #define UPIO_AU                 (4)                     /* Au1x00 type IO */
 233 #define UPIO_TSI                (5)                     /* Tsi108/109 type IO */
 234 #define UPIO_DWAPB              (6)                     /* DesignWare APB UART */
 235 #define UPIO_RM9000             (7)                     /* RM9000 type IO */
 236
 237         unsigned int            read_status_mask;       /* driver specific */
 238         unsigned int            ignore_status_mask;     /* driver specific */
 239         struct uart_info        *info;                  /* pointer to parent info */
 240         struct uart_icount      icount;                 /* statistics */
 241
 242         struct console          *cons;                  /* struct console, if any */
 243 #ifdef CONFIG_SERIAL_CORE_CONSOLE
 244         unsigned long           sysrq;                  /* sysrq timeout */
 245 #endif
 246
 247         upf_t                   flags;
 248
 249 #define UPF_FOURPORT            ((__force upf_t) (1 << 1))
 250 #define UPF_SAK                 ((__force upf_t) (1 << 2))
 251 #define UPF_SPD_MASK            ((__force upf_t) (0x1030))
 252 #define UPF_SPD_HI              ((__force upf_t) (0x0010))
 253 #define UPF_SPD_VHI             ((__force upf_t) (0x0020))
 254 #define UPF_SPD_CUST            ((__force upf_t) (0x0030))
 255 #define UPF_SPD_SHI             ((__force upf_t) (0x1000))
 256 #define UPF_SPD_WARP            ((__force upf_t) (0x1010))
 257 #define UPF_SKIP_TEST           ((__force upf_t) (1 << 6))
 258 #define UPF_AUTO_IRQ            ((__force upf_t) (1 << 7))
 259 #define UPF_HARDPPS_CD          ((__force upf_t) (1 << 11))
 260 #define UPF_LOW_LATENCY         ((__force upf_t) (1 << 13))
 261 #define UPF_BUGGY_UART          ((__force upf_t) (1 << 14))
 262 #define UPF_MAGIC_MULTIPLIER    ((__force upf_t) (1 << 16))
 263 #define UPF_CONS_FLOW           ((__force upf_t) (1 << 23))
 264 #define UPF_SHARE_IRQ           ((__force upf_t) (1 << 24))
 265 #define UPF_BOOT_AUTOCONF       ((__force upf_t) (1 << 28))
 266 #define UPF_DEAD                ((__force upf_t) (1 << 30))
 267 #define UPF_IOREMAP             ((__force upf_t) (1 << 31))
 268
 269 #define UPF_CHANGE_MASK         ((__force upf_t) (0x17fff))
 270 #define UPF_USR_MASK            ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
 271
 272         unsigned int            mctrl;                  /* current modem ctrl settings */
 273         unsigned int            timeout;                /* character-based timeout */
 274         unsigned int            type;                   /* port type */
 275         const struct uart_ops   *ops;
 276         unsigned int            custom_divisor;
 277         unsigned int            line;                   /* port index */
 278         unsigned long           mapbase;                /* for ioremap */
 279         struct device           *dev;                   /* parent device */
 280         unsigned char           hub6;                   /* this should be in the 8250 driver */
 281         unsigned char           unused[3];
 282         void                    *private_data;          /* generic platform data pointer */
 283 };
 284
 285 /*
 286  * This is the state information which is persistent across opens.
 287  * The low level driver must not to touch any elements contained
 288  * within.
 289  */
 290 struct uart_state {
 291         unsigned int            close_delay;            /* msec */
 292         unsigned int            closing_wait;           /* msec */
 293
 294 #define USF_CLOSING_WAIT_INF    (0)
 295 #define USF_CLOSING_WAIT_NONE   (~0U)
 296
 297         int                     count;
 298         int                     pm_state;
 299         struct uart_info        *info;
 300         struct uart_port        *port;
 301
 302         struct mutex            mutex;
 303 };
 304
 305 #define UART_XMIT_SIZE  PAGE_SIZE
 306
 307 typedef unsigned int __bitwise__ uif_t;
 308
 309 /*
 310  * This is the state information which is only valid when the port
 311  * is open; it may be freed by the core driver once the device has
 312  * been closed.  Either the low level driver or the core can modify
 313  * stuff here.
 314  */
 315 struct uart_info {
 316         struct tty_struct       *tty;
 317         struct circ_buf         xmit;
 318         uif_t                   flags;
 319
 320 /*
 321  * Definitions for info->flags.  These are _private_ to serial_core, and
 322  * are specific to this structure.  They may be queried by low level drivers.
 323  */
 324 #define UIF_CHECK_CD            ((__force uif_t) (1 << 25))
 325 #define UIF_CTS_FLOW            ((__force uif_t) (1 << 26))
 326 #define UIF_NORMAL_ACTIVE       ((__force uif_t) (1 << 29))
 327 #define UIF_INITIALIZED         ((__force uif_t) (1 << 31))
 328 #define UIF_SUSPENDED           ((__force uif_t) (1 << 30))
 329
 330         int                     blocked_open;
 331
 332         struct tasklet_struct   tlet;
 333
 334         wait_queue_head_t       open_wait;
 335         wait_queue_head_t       delta_msr_wait;
 336 };
 337
 338 /* number of characters left in xmit buffer before we ask for more */
 339 #define WAKEUP_CHARS            256
 340
 341 struct module;
 342 struct tty_driver;
 343
 344 struct uart_driver {
 345         struct module           *owner;
 346         const char              *driver_name;
 347         const char              *dev_name;
 348         int                      major;
 349         int                      minor;
 350         int                      nr;
 351         struct console          *cons;
 352
 353         /*
 354          * these are private; the low level driver should not
 355          * touch these; they should be initialised to NULL
 356          */
 357         struct uart_state       *state;
 358         struct tty_driver       *tty_driver;
 359 };
 360
 361 void uart_write_wakeup(struct uart_port *port);
 362
 363 /*
 364  * Baud rate helpers.
 365  */
 366 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
 367                          unsigned int baud);
 368 unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
 369                                 struct ktermios *old, unsigned int min,
 370                                 unsigned int max);
 371 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
 372
 373 /*
 374  * Console helpers.
 375  */
 376 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
 377                                    struct console *c);
 378 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
 379                         int *flow);
 380 int uart_set_options(struct uart_port *port, struct console *co, int baud,
 381                      int parity, int bits, int flow);
 382 struct tty_driver *uart_console_device(struct console *co, int *index);
 383 void uart_console_write(struct uart_port *port, const char *s,
 384                         unsigned int count,
 385                         void (*putchar)(struct uart_port *, int));
 386
 387 /*
 388  * Port/driver registration/removal
 389  */
 390 int uart_register_driver(struct uart_driver *uart);
 391 void uart_unregister_driver(struct uart_driver *uart);
 392 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
 393 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
 394 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
 395
 396 /*
 397  * Power Management
 398  */
 399 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
 400 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
 401
 402 #define uart_circ_empty(circ)           ((circ)->head == (circ)->tail)
 403 #define uart_circ_clear(circ)           ((circ)->head = (circ)->tail = 0)
 404
 405 #define uart_circ_chars_pending(circ)   \
 406         (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
 407
 408 #define uart_circ_chars_free(circ)      \
 409         (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
 410
 411 #define uart_tx_stopped(port)           \
 412         ((port)->info->tty->stopped || (port)->info->tty->hw_stopped)
 413
 414 /*
 415  * The following are helper functions for the low level drivers.
 416  */
 417 static inline int
 418 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
 419 {
 420 #ifdef SUPPORT_SYSRQ
 421         if (port->sysrq) {
 422                 if (ch && time_before(jiffies, port->sysrq)) {
 423                         handle_sysrq(ch, port->info->tty);
 424                         port->sysrq = 0;
 425                         return 1;
 426                 }
 427                 port->sysrq = 0;
 428         }
 429 #endif
 430         return 0;
 431 }
 432 #ifndef SUPPORT_SYSRQ
 433 #define uart_handle_sysrq_char(port,ch) uart_handle_sysrq_char(port, 0)
 434 #endif
 435
 436 /*
 437  * We do the SysRQ and SAK checking like this...
 438  */
 439 static inline int uart_handle_break(struct uart_port *port)
 440 {
 441         struct uart_info *info = port->info;
 442 #ifdef SUPPORT_SYSRQ
 443         if (port->cons && port->cons->index == port->line) {
 444                 if (!port->sysrq) {
 445                         port->sysrq = jiffies + HZ*5;
 446                         return 1;
 447                 }
 448                 port->sysrq = 0;
 449         }
 450 #endif
 451         if (port->flags & UPF_SAK)
 452                 do_SAK(info->tty);
 453         return 0;
 454 }
 455
 456 /**
 457  *      uart_handle_dcd_change - handle a change of carrier detect state
 458  *      @port: uart_port structure for the open port
 459  *      @status: new carrier detect status, nonzero if active
 460  */
 461 static inline void
 462 uart_handle_dcd_change(struct uart_port *port, unsigned int status)
 463 {
 464         struct uart_info *info = port->info;
 465
 466         port->icount.dcd++;
 467
 468 #ifdef CONFIG_HARD_PPS
 469         if ((port->flags & UPF_HARDPPS_CD) && status)
 470                 hardpps();
 471 #endif
 472
 473         if (info->flags & UIF_CHECK_CD) {
 474                 if (status)
 475                         wake_up_interruptible(&info->open_wait);
 476                 else if (info->tty)
 477                         tty_hangup(info->tty);
 478         }
 479 }
 480
 481 /**
 482  *      uart_handle_cts_change - handle a change of clear-to-send state
 483  *      @port: uart_port structure for the open port
 484  *      @status: new clear to send status, nonzero if active
 485  */
 486 static inline void
 487 uart_handle_cts_change(struct uart_port *port, unsigned int status)
 488 {
 489         struct uart_info *info = port->info;
 490         struct tty_struct *tty = info->tty;
 491
 492         port->icount.cts++;
 493
 494         if (info->flags & UIF_CTS_FLOW) {
 495                 if (tty->hw_stopped) {
 496                         if (status) {
 497                                 tty->hw_stopped = 0;
 498                                 port->ops->start_tx(port);
 499                                 uart_write_wakeup(port);
 500                         }
 501                 } else {
 502                         if (!status) {
 503                                 tty->hw_stopped = 1;
 504                                 port->ops->stop_tx(port);
 505                         }
 506                 }
 507         }
 508 }
 509
 510 #include <linux/tty_flip.h>
 511
 512 static inline void
 513 uart_insert_char(struct uart_port *port, unsigned int status,
 514                  unsigned int overrun, unsigned int ch, unsigned int flag)
 515 {
 516         struct tty_struct *tty = port->info->tty;
 517
 518         if ((status & port->ignore_status_mask & ~overrun) == 0)
 519                 tty_insert_flip_char(tty, ch, flag);
 520
 521         /*
 522          * Overrun is special.  Since it's reported immediately,
 523          * it doesn't affect the current character.
 524          */
 525         if (status & ~port->ignore_status_mask & overrun)
 526                 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
 527 }
 528
 529 /*
 530  *      UART_ENABLE_MS - determine if port should enable modem status irqs
 531  */
 532 #define UART_ENABLE_MS(port,cflag)      ((port)->flags & UPF_HARDPPS_CD || \
 533                                          (cflag) & CRTSCTS || \
 534                                          !((cflag) & CLOCAL))
 535
 536 #endif
 537
 538 #endif /* LINUX_SERIAL_CORE_H */