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