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