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