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