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