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