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