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 #include <linux/compiler.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/circ_buf.h>
  27 #include <linux/spinlock.h>
  28 #include <linux/sched.h>
  29 #include <linux/tty.h>
  30 #include <linux/mutex.h>
  31 #include <linux/sysrq.h>
  32 #include <linux/pps_kernel.h>
  33 #include <uapi/linux/serial_core.h>
  34
  35 struct uart_port;
  36 struct serial_struct;
  37 struct device;
  38
  39 /*
  40  * This structure describes all the operations that can be
  41  * done on the physical hardware.
  42  */
  43 struct uart_ops {
  44         unsigned int    (*tx_empty)(struct uart_port *);
  45         void            (*set_mctrl)(struct uart_port *, unsigned int mctrl);
  46         unsigned int    (*get_mctrl)(struct uart_port *);
  47         void            (*stop_tx)(struct uart_port *);
  48         void            (*start_tx)(struct uart_port *);
  49         void            (*throttle)(struct uart_port *);
  50         void            (*unthrottle)(struct uart_port *);
  51         void            (*send_xchar)(struct uart_port *, char ch);
  52         void            (*stop_rx)(struct uart_port *);
  53         void            (*enable_ms)(struct uart_port *);
  54         void            (*break_ctl)(struct uart_port *, int ctl);
  55         int             (*startup)(struct uart_port *);
  56         void            (*shutdown)(struct uart_port *);
  57         void            (*flush_buffer)(struct uart_port *);
  58         void            (*set_termios)(struct uart_port *, struct ktermios *new,
  59                                        struct ktermios *old);
  60         void            (*set_ldisc)(struct uart_port *, int new);
  61         void            (*pm)(struct uart_port *, unsigned int state,
  62                               unsigned int oldstate);
  63         int             (*set_wake)(struct uart_port *, unsigned int state);
  64         void            (*wake_peer)(struct uart_port *);
  65
  66         /*
  67          * Return a string describing the type of the port
  68          */
  69         const char *(*type)(struct uart_port *);
  70
  71         /*
  72          * Release IO and memory resources used by the port.
  73          * This includes iounmap if necessary.
  74          */
  75         void            (*release_port)(struct uart_port *);
  76
  77         /*
  78          * Request IO and memory resources used by the port.
  79          * This includes iomapping the port if necessary.
  80          */
  81         int             (*request_port)(struct uart_port *);
  82         void            (*config_port)(struct uart_port *, int);
  83         int             (*verify_port)(struct uart_port *, struct serial_struct *);
  84         int             (*ioctl)(struct uart_port *, unsigned int, unsigned long);
  85 #ifdef CONFIG_CONSOLE_POLL
  86         int             (*poll_init)(struct uart_port *);
  87         void    (*poll_put_char)(struct uart_port *, unsigned char);
  88         int             (*poll_get_char)(struct uart_port *);
  89 #endif
  90 };
  91
  92 #define NO_POLL_CHAR            0x00ff0000
  93 #define UART_CONFIG_TYPE        (1 << 0)
  94 #define UART_CONFIG_IRQ         (1 << 1)
  95
  96 struct uart_icount {
  97         __u32   cts;
  98         __u32   dsr;
  99         __u32   rng;
 100         __u32   dcd;
 101         __u32   rx;
 102         __u32   tx;
 103         __u32   frame;
 104         __u32   overrun;
 105         __u32   parity;
 106         __u32   brk;
 107         __u32   buf_overrun;
 108 };
 109
 110 typedef unsigned int __bitwise__ upf_t;
 111
 112 struct uart_port {
 113         spinlock_t              lock;                   /* port lock */
 114         unsigned long           iobase;                 /* in/out[bwl] */
 115         unsigned char __iomem   *membase;               /* read/write[bwl] */
 116         unsigned int            (*serial_in)(struct uart_port *, int);
 117         void                    (*serial_out)(struct uart_port *, int, int);
 118         void                    (*set_termios)(struct uart_port *,
 119                                                struct ktermios *new,
 120                                                struct ktermios *old);
 121         int                     (*handle_irq)(struct uart_port *);
 122         void                    (*pm)(struct uart_port *, unsigned int state,
 123                                       unsigned int old);
 124         void                    (*handle_break)(struct uart_port *);
 125         unsigned int            irq;                    /* irq number */
 126         unsigned long           irqflags;               /* irq flags  */
 127         unsigned int            uartclk;                /* base uart clock */
 128         unsigned int            fifosize;               /* tx fifo size */
 129         unsigned char           x_char;                 /* xon/xoff char */
 130         unsigned char           regshift;               /* reg offset shift */
 131         unsigned char           iotype;                 /* io access style */
 132         unsigned char           unused1;
 133
 134 #define UPIO_PORT               (0)
 135 #define UPIO_HUB6               (1)
 136 #define UPIO_MEM                (2)
 137 #define UPIO_MEM32              (3)
 138 #define UPIO_AU                 (4)                     /* Au1x00 type IO */
 139 #define UPIO_TSI                (5)                     /* Tsi108/109 type IO */
 140 #define UPIO_RM9000             (6)                     /* RM9000 type IO */
 141
 142         unsigned int            read_status_mask;       /* driver specific */
 143         unsigned int            ignore_status_mask;     /* driver specific */
 144         struct uart_state       *state;                 /* pointer to parent state */
 145         struct uart_icount      icount;                 /* statistics */
 146
 147         struct console          *cons;                  /* struct console, if any */
 148 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(SUPPORT_SYSRQ)
 149         unsigned long           sysrq;                  /* sysrq timeout */
 150 #endif
 151
 152         upf_t                   flags;
 153
 154 #define UPF_FOURPORT            ((__force upf_t) (1 << 1))
 155 #define UPF_SAK                 ((__force upf_t) (1 << 2))
 156 #define UPF_SPD_MASK            ((__force upf_t) (0x1030))
 157 #define UPF_SPD_HI              ((__force upf_t) (0x0010))
 158 #define UPF_SPD_VHI             ((__force upf_t) (0x0020))
 159 #define UPF_SPD_CUST            ((__force upf_t) (0x0030))
 160 #define UPF_SPD_SHI             ((__force upf_t) (0x1000))
 161 #define UPF_SPD_WARP            ((__force upf_t) (0x1010))
 162 #define UPF_SKIP_TEST           ((__force upf_t) (1 << 6))
 163 #define UPF_AUTO_IRQ            ((__force upf_t) (1 << 7))
 164 #define UPF_HARDPPS_CD          ((__force upf_t) (1 << 11))
 165 #define UPF_LOW_LATENCY         ((__force upf_t) (1 << 13))
 166 #define UPF_BUGGY_UART          ((__force upf_t) (1 << 14))
 167 #define UPF_NO_TXEN_TEST        ((__force upf_t) (1 << 15))
 168 #define UPF_MAGIC_MULTIPLIER    ((__force upf_t) (1 << 16))
 169 /* Port has hardware-assisted h/w flow control (iow, auto-RTS *not* auto-CTS) */
 170 #define UPF_HARD_FLOW           ((__force upf_t) (1 << 21))
 171 /* Port has hardware-assisted s/w flow control */
 172 #define UPF_SOFT_FLOW           ((__force upf_t) (1 << 22))
 173 #define UPF_CONS_FLOW           ((__force upf_t) (1 << 23))
 174 #define UPF_SHARE_IRQ           ((__force upf_t) (1 << 24))
 175 #define UPF_EXAR_EFR            ((__force upf_t) (1 << 25))
 176 #define UPF_BUG_THRE            ((__force upf_t) (1 << 26))
 177 /* The exact UART type is known and should not be probed.  */
 178 #define UPF_FIXED_TYPE          ((__force upf_t) (1 << 27))
 179 #define UPF_BOOT_AUTOCONF       ((__force upf_t) (1 << 28))
 180 #define UPF_FIXED_PORT          ((__force upf_t) (1 << 29))
 181 #define UPF_DEAD                ((__force upf_t) (1 << 30))
 182 #define UPF_IOREMAP             ((__force upf_t) (1 << 31))
 183
 184 #define UPF_CHANGE_MASK         ((__force upf_t) (0x17fff))
 185 #define UPF_USR_MASK            ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
 186
 187         unsigned int            mctrl;                  /* current modem ctrl settings */
 188         unsigned int            timeout;                /* character-based timeout */
 189         unsigned int            type;                   /* port type */
 190         const struct uart_ops   *ops;
 191         unsigned int            custom_divisor;
 192         unsigned int            line;                   /* port index */
 193         resource_size_t         mapbase;                /* for ioremap */
 194         struct device           *dev;                   /* parent device */
 195         unsigned char           hub6;                   /* this should be in the 8250 driver */
 196         unsigned char           suspended;
 197         unsigned char           irq_wake;
 198         unsigned char           unused[2];
 199         void                    *private_data;          /* generic platform data pointer */
 200 };
 201
 202 static inline int serial_port_in(struct uart_port *up, int offset)
 203 {
 204         return up->serial_in(up, offset);
 205 }
 206
 207 static inline void serial_port_out(struct uart_port *up, int offset, int value)
 208 {
 209         up->serial_out(up, offset, value);
 210 }
 211
 212 /*
 213  * This is the state information which is persistent across opens.
 214  */
 215 struct uart_state {
 216         struct tty_port         port;
 217
 218         int                     pm_state;
 219         struct circ_buf         xmit;
 220
 221         struct uart_port        *uart_port;
 222 };
 223
 224 #define UART_XMIT_SIZE  PAGE_SIZE
 225
 226
 227 /* number of characters left in xmit buffer before we ask for more */
 228 #define WAKEUP_CHARS            256
 229
 230 struct module;
 231 struct tty_driver;
 232
 233 struct uart_driver {
 234         struct module           *owner;
 235         const char              *driver_name;
 236         const char              *dev_name;
 237         int                      major;
 238         int                      minor;
 239         int                      nr;
 240         struct console          *cons;
 241
 242         /*
 243          * these are private; the low level driver should not
 244          * touch these; they should be initialised to NULL
 245          */
 246         struct uart_state       *state;
 247         struct tty_driver       *tty_driver;
 248 };
 249
 250 void uart_write_wakeup(struct uart_port *port);
 251
 252 /*
 253  * Baud rate helpers.
 254  */
 255 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
 256                          unsigned int baud);
 257 unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
 258                                 struct ktermios *old, unsigned int min,
 259                                 unsigned int max);
 260 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
 261
 262 /* Base timer interval for polling */
 263 static inline int uart_poll_timeout(struct uart_port *port)
 264 {
 265         int timeout = port->timeout;
 266
 267         return timeout > 6 ? (timeout / 2 - 2) : 1;
 268 }
 269
 270 /*
 271  * Console helpers.
 272  */
 273 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
 274                                    struct console *c);
 275 void uart_parse_options(char *options, int *baud, int *parity, int *bits,
 276                         int *flow);
 277 int uart_set_options(struct uart_port *port, struct console *co, int baud,
 278                      int parity, int bits, int flow);
 279 struct tty_driver *uart_console_device(struct console *co, int *index);
 280 void uart_console_write(struct uart_port *port, const char *s,
 281                         unsigned int count,
 282                         void (*putchar)(struct uart_port *, int));
 283
 284 /*
 285  * Port/driver registration/removal
 286  */
 287 int uart_register_driver(struct uart_driver *uart);
 288 void uart_unregister_driver(struct uart_driver *uart);
 289 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
 290 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
 291 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
 292
 293 /*
 294  * Power Management
 295  */
 296 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
 297 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
 298
 299 #define uart_circ_empty(circ)           ((circ)->head == (circ)->tail)
 300 #define uart_circ_clear(circ)           ((circ)->head = (circ)->tail = 0)
 301
 302 #define uart_circ_chars_pending(circ)   \
 303         (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
 304
 305 #define uart_circ_chars_free(circ)      \
 306         (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
 307
 308 static inline int uart_tx_stopped(struct uart_port *port)
 309 {
 310         struct tty_struct *tty = port->state->port.tty;
 311         if(tty->stopped || tty->hw_stopped)
 312                 return 1;
 313         return 0;
 314 }
 315
 316 /*
 317  * The following are helper functions for the low level drivers.
 318  */
 319
 320 extern void uart_handle_dcd_change(struct uart_port *uport,
 321                 unsigned int status);
 322 extern void uart_handle_cts_change(struct uart_port *uport,
 323                 unsigned int status);
 324
 325 extern void uart_insert_char(struct uart_port *port, unsigned int status,
 326                  unsigned int overrun, unsigned int ch, unsigned int flag);
 327
 328 #ifdef SUPPORT_SYSRQ
 329 static inline int
 330 uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
 331 {
 332         if (port->sysrq) {
 333                 if (ch && time_before(jiffies, port->sysrq)) {
 334                         handle_sysrq(ch);
 335                         port->sysrq = 0;
 336                         return 1;
 337                 }
 338                 port->sysrq = 0;
 339         }
 340         return 0;
 341 }
 342 #else
 343 #define uart_handle_sysrq_char(port,ch) ({ (void)port; 0; })
 344 #endif
 345
 346 /*
 347  * We do the SysRQ and SAK checking like this...
 348  */
 349 static inline int uart_handle_break(struct uart_port *port)
 350 {
 351         struct uart_state *state = port->state;
 352
 353         if (port->handle_break)
 354                 port->handle_break(port);
 355
 356 #ifdef SUPPORT_SYSRQ
 357         if (port->cons && port->cons->index == port->line) {
 358                 if (!port->sysrq) {
 359                         port->sysrq = jiffies + HZ*5;
 360                         return 1;
 361                 }
 362                 port->sysrq = 0;
 363         }
 364 #endif
 365         if (port->flags & UPF_SAK)
 366                 do_SAK(state->port.tty);
 367         return 0;
 368 }
 369
 370 /*
 371  *      UART_ENABLE_MS - determine if port should enable modem status irqs
 372  */
 373 #define UART_ENABLE_MS(port,cflag)      ((port)->flags & UPF_HARDPPS_CD || \
 374                                          (cflag) & CRTSCTS || \
 375                                          !((cflag) & CLOCAL))
 376
 377 #endif /* LINUX_SERIAL_CORE_H */