include/linux/serial_core.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *  linux/drivers/char/serial_core.h
   4  *
   5  *  Copyright (C) 2000 Deep Blue Solutions Ltd.
   6  */
   7 #ifndef LINUX_SERIAL_CORE_H
   8 #define LINUX_SERIAL_CORE_H
   9
  10 #include <linux/bitops.h>
  11 #include <linux/compiler.h>
  12 #include <linux/console.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/circ_buf.h>
  15 #include <linux/spinlock.h>
  16 #include <linux/sched.h>
  17 #include <linux/tty.h>
  18 #include <linux/mutex.h>
  19 #include <linux/sysrq.h>
  20 #include <uapi/linux/serial_core.h>
  21
  22 #ifdef CONFIG_SERIAL_CORE_CONSOLE
  23 #define uart_console(port) \
  24         ((port)->cons && (port)->cons->index == (port)->line)
  25 #else
  26 #define uart_console(port)      ({ (void)port; 0; })
  27 #endif
  28
  29 struct uart_port;
  30 struct serial_struct;
  31 struct device;
  32 struct gpio_desc;
  33
  34 /*
  35  * This structure describes all the operations that can be done on the
  36  * physical hardware.  See Documentation/driver-api/serial/driver.rst for details.
  37  */
  38 struct uart_ops {
  39         unsigned int    (*tx_empty)(struct uart_port *);
  40         void            (*set_mctrl)(struct uart_port *, unsigned int mctrl);
  41         unsigned int    (*get_mctrl)(struct uart_port *);
  42         void            (*stop_tx)(struct uart_port *);
  43         void            (*start_tx)(struct uart_port *);
  44         void            (*throttle)(struct uart_port *);
  45         void            (*unthrottle)(struct uart_port *);
  46         void            (*send_xchar)(struct uart_port *, char ch);
  47         void            (*stop_rx)(struct uart_port *);
  48         void            (*enable_ms)(struct uart_port *);
  49         void            (*break_ctl)(struct uart_port *, int ctl);
  50         int             (*startup)(struct uart_port *);
  51         void            (*shutdown)(struct uart_port *);
  52         void            (*flush_buffer)(struct uart_port *);
  53         void            (*set_termios)(struct uart_port *, struct ktermios *new,
  54                                        struct ktermios *old);
  55         void            (*set_ldisc)(struct uart_port *, struct ktermios *);
  56         void            (*pm)(struct uart_port *, unsigned int state,
  57                               unsigned int oldstate);
  58
  59         /*
  60          * Return a string describing the type of the port
  61          */
  62         const char      *(*type)(struct uart_port *);
  63
  64         /*
  65          * Release IO and memory resources used by the port.
  66          * This includes iounmap if necessary.
  67          */
  68         void            (*release_port)(struct uart_port *);
  69
  70         /*
  71          * Request IO and memory resources used by the port.
  72          * This includes iomapping the port if necessary.
  73          */
  74         int             (*request_port)(struct uart_port *);
  75         void            (*config_port)(struct uart_port *, int);
  76         int             (*verify_port)(struct uart_port *, struct serial_struct *);
  77         int             (*ioctl)(struct uart_port *, unsigned int, unsigned long);
  78 #ifdef CONFIG_CONSOLE_POLL
  79         int             (*poll_init)(struct uart_port *);
  80         void            (*poll_put_char)(struct uart_port *, unsigned char);
  81         int             (*poll_get_char)(struct uart_port *);
  82 #endif
  83 };
  84
  85 #define NO_POLL_CHAR            0x00ff0000
  86 #define UART_CONFIG_TYPE        (1 << 0)
  87 #define UART_CONFIG_IRQ         (1 << 1)
  88
  89 struct uart_icount {
  90         __u32   cts;
  91         __u32   dsr;
  92         __u32   rng;
  93         __u32   dcd;
  94         __u32   rx;
  95         __u32   tx;
  96         __u32   frame;
  97         __u32   overrun;
  98         __u32   parity;
  99         __u32   brk;
 100         __u32   buf_overrun;
 101 };
 102
 103 typedef u64 __bitwise upf_t;
 104 typedef unsigned int __bitwise upstat_t;
 105
 106 struct uart_port {
 107         spinlock_t              lock;                   /* port lock */
 108         unsigned long           iobase;                 /* in/out[bwl] */
 109         unsigned char __iomem   *membase;               /* read/write[bwl] */
 110         unsigned int            (*serial_in)(struct uart_port *, int);
 111         void                    (*serial_out)(struct uart_port *, int, int);
 112         void                    (*set_termios)(struct uart_port *,
 113                                                struct ktermios *new,
 114                                                struct ktermios *old);
 115         void                    (*set_ldisc)(struct uart_port *,
 116                                              struct ktermios *);
 117         unsigned int            (*get_mctrl)(struct uart_port *);
 118         void                    (*set_mctrl)(struct uart_port *, unsigned int);
 119         unsigned int            (*get_divisor)(struct uart_port *,
 120                                                unsigned int baud,
 121                                                unsigned int *frac);
 122         void                    (*set_divisor)(struct uart_port *,
 123                                                unsigned int baud,
 124                                                unsigned int quot,
 125                                                unsigned int quot_frac);
 126         int                     (*startup)(struct uart_port *port);
 127         void                    (*shutdown)(struct uart_port *port);
 128         void                    (*throttle)(struct uart_port *port);
 129         void                    (*unthrottle)(struct uart_port *port);
 130         int                     (*handle_irq)(struct uart_port *);
 131         void                    (*pm)(struct uart_port *, unsigned int state,
 132                                       unsigned int old);
 133         void                    (*handle_break)(struct uart_port *);
 134         int                     (*rs485_config)(struct uart_port *,
 135                                                 struct serial_rs485 *rs485);
 136         int                     (*iso7816_config)(struct uart_port *,
 137                                                   struct serial_iso7816 *iso7816);
 138         unsigned int            irq;                    /* irq number */
 139         unsigned long           irqflags;               /* irq flags  */
 140         unsigned int            uartclk;                /* base uart clock */
 141         unsigned int            fifosize;               /* tx fifo size */
 142         unsigned char           x_char;                 /* xon/xoff char */
 143         unsigned char           regshift;               /* reg offset shift */
 144         unsigned char           iotype;                 /* io access style */
 145         unsigned char           quirks;                 /* internal quirks */
 146
 147 #define UPIO_PORT               (SERIAL_IO_PORT)        /* 8b I/O port access */
 148 #define UPIO_HUB6               (SERIAL_IO_HUB6)        /* Hub6 ISA card */
 149 #define UPIO_MEM                (SERIAL_IO_MEM)         /* driver-specific */
 150 #define UPIO_MEM32              (SERIAL_IO_MEM32)       /* 32b little endian */
 151 #define UPIO_AU                 (SERIAL_IO_AU)          /* Au1x00 and RT288x type IO */
 152 #define UPIO_TSI                (SERIAL_IO_TSI)         /* Tsi108/109 type IO */
 153 #define UPIO_MEM32BE            (SERIAL_IO_MEM32BE)     /* 32b big endian */
 154 #define UPIO_MEM16              (SERIAL_IO_MEM16)       /* 16b little endian */
 155
 156         /* quirks must be updated while holding port mutex */
 157 #define UPQ_NO_TXEN_TEST        BIT(0)
 158
 159         unsigned int            read_status_mask;       /* driver specific */
 160         unsigned int            ignore_status_mask;     /* driver specific */
 161         struct uart_state       *state;                 /* pointer to parent state */
 162         struct uart_icount      icount;                 /* statistics */
 163
 164         struct console          *cons;                  /* struct console, if any */
 165         /* flags must be updated while holding port mutex */
 166         upf_t                   flags;
 167
 168         /*
 169          * These flags must be equivalent to the flags defined in
 170          * include/uapi/linux/tty_flags.h which are the userspace definitions
 171          * assigned from the serial_struct flags in uart_set_info()
 172          * [for bit definitions in the UPF_CHANGE_MASK]
 173          *
 174          * Bits [0..UPF_LAST_USER] are userspace defined/visible/changeable
 175          * The remaining bits are serial-core specific and not modifiable by
 176          * userspace.
 177          */
 178 #define UPF_FOURPORT            ((__force upf_t) ASYNC_FOURPORT       /* 1  */ )
 179 #define UPF_SAK                 ((__force upf_t) ASYNC_SAK            /* 2  */ )
 180 #define UPF_SPD_HI              ((__force upf_t) ASYNC_SPD_HI         /* 4  */ )
 181 #define UPF_SPD_VHI             ((__force upf_t) ASYNC_SPD_VHI        /* 5  */ )
 182 #define UPF_SPD_CUST            ((__force upf_t) ASYNC_SPD_CUST   /* 0x0030 */ )
 183 #define UPF_SPD_WARP            ((__force upf_t) ASYNC_SPD_WARP   /* 0x1010 */ )
 184 #define UPF_SPD_MASK            ((__force upf_t) ASYNC_SPD_MASK   /* 0x1030 */ )
 185 #define UPF_SKIP_TEST           ((__force upf_t) ASYNC_SKIP_TEST      /* 6  */ )
 186 #define UPF_AUTO_IRQ            ((__force upf_t) ASYNC_AUTO_IRQ       /* 7  */ )
 187 #define UPF_HARDPPS_CD          ((__force upf_t) ASYNC_HARDPPS_CD     /* 11 */ )
 188 #define UPF_SPD_SHI             ((__force upf_t) ASYNC_SPD_SHI        /* 12 */ )
 189 #define UPF_LOW_LATENCY         ((__force upf_t) ASYNC_LOW_LATENCY    /* 13 */ )
 190 #define UPF_BUGGY_UART          ((__force upf_t) ASYNC_BUGGY_UART     /* 14 */ )
 191 #define UPF_MAGIC_MULTIPLIER    ((__force upf_t) ASYNC_MAGIC_MULTIPLIER /* 16 */ )
 192
 193 #define UPF_NO_THRE_TEST        ((__force upf_t) (1 << 19))
 194 /* Port has hardware-assisted h/w flow control */
 195 #define UPF_AUTO_CTS            ((__force upf_t) (1 << 20))
 196 #define UPF_AUTO_RTS            ((__force upf_t) (1 << 21))
 197 #define UPF_HARD_FLOW           ((__force upf_t) (UPF_AUTO_CTS | UPF_AUTO_RTS))
 198 /* Port has hardware-assisted s/w flow control */
 199 #define UPF_SOFT_FLOW           ((__force upf_t) (1 << 22))
 200 #define UPF_CONS_FLOW           ((__force upf_t) (1 << 23))
 201 #define UPF_SHARE_IRQ           ((__force upf_t) (1 << 24))
 202 #define UPF_EXAR_EFR            ((__force upf_t) (1 << 25))
 203 #define UPF_BUG_THRE            ((__force upf_t) (1 << 26))
 204 /* The exact UART type is known and should not be probed.  */
 205 #define UPF_FIXED_TYPE          ((__force upf_t) (1 << 27))
 206 #define UPF_BOOT_AUTOCONF       ((__force upf_t) (1 << 28))
 207 #define UPF_FIXED_PORT          ((__force upf_t) (1 << 29))
 208 #define UPF_DEAD                ((__force upf_t) (1 << 30))
 209 #define UPF_IOREMAP             ((__force upf_t) (1 << 31))
 210 #define UPF_FULL_PROBE          ((__force upf_t) (1ULL << 32))
 211
 212 #define __UPF_CHANGE_MASK       0x17fff
 213 #define UPF_CHANGE_MASK         ((__force upf_t) __UPF_CHANGE_MASK)
 214 #define UPF_USR_MASK            ((__force upf_t) (UPF_SPD_MASK|UPF_LOW_LATENCY))
 215
 216 #if __UPF_CHANGE_MASK > ASYNC_FLAGS
 217 #error Change mask not equivalent to userspace-visible bit defines
 218 #endif
 219
 220         /*
 221          * Must hold termios_rwsem, port mutex and port lock to change;
 222          * can hold any one lock to read.
 223          */
 224         upstat_t                status;
 225
 226 #define UPSTAT_CTS_ENABLE       ((__force upstat_t) (1 << 0))
 227 #define UPSTAT_DCD_ENABLE       ((__force upstat_t) (1 << 1))
 228 #define UPSTAT_AUTORTS          ((__force upstat_t) (1 << 2))
 229 #define UPSTAT_AUTOCTS          ((__force upstat_t) (1 << 3))
 230 #define UPSTAT_AUTOXOFF         ((__force upstat_t) (1 << 4))
 231 #define UPSTAT_SYNC_FIFO        ((__force upstat_t) (1 << 5))
 232
 233         int                     hw_stopped;             /* sw-assisted CTS flow state */
 234         unsigned int            mctrl;                  /* current modem ctrl settings */
 235         unsigned int            timeout;                /* character-based timeout */
 236         unsigned int            type;                   /* port type */
 237         const struct uart_ops   *ops;
 238         unsigned int            custom_divisor;
 239         unsigned int            line;                   /* port index */
 240         unsigned int            minor;
 241         resource_size_t         mapbase;                /* for ioremap */
 242         resource_size_t         mapsize;
 243         struct device           *dev;                   /* parent device */
 244
 245         unsigned long           sysrq;                  /* sysrq timeout */
 246         unsigned int            sysrq_ch;               /* char for sysrq */
 247         unsigned char           has_sysrq;
 248         unsigned char           sysrq_seq;              /* index in sysrq_toggle_seq */
 249
 250         unsigned char           hub6;                   /* this should be in the 8250 driver */
 251         unsigned char           suspended;
 252         unsigned char           console_reinit;
 253         const char              *name;                  /* port name */
 254         struct attribute_group  *attr_group;            /* port specific attributes */
 255         const struct attribute_group **tty_groups;      /* all attributes (serial core use only) */
 256         struct serial_rs485     rs485;
 257         const struct serial_rs485       *rs485_supported;       /* Supported mask for serial_rs485 */
 258         struct gpio_desc        *rs485_term_gpio;       /* enable RS485 bus termination */
 259         struct serial_iso7816   iso7816;
 260         void                    *private_data;          /* generic platform data pointer */
 261 };
 262
 263 /**
 264  * uart_port_lock - Lock the UART port
 265  * @up:         Pointer to UART port structure
 266  */
 267 static inline void uart_port_lock(struct uart_port *up)
 268 {
 269         spin_lock(&up->lock);
 270 }
 271
 272 /**
 273  * uart_port_lock_irq - Lock the UART port and disable interrupts
 274  * @up:         Pointer to UART port structure
 275  */
 276 static inline void uart_port_lock_irq(struct uart_port *up)
 277 {
 278         spin_lock_irq(&up->lock);
 279 }
 280
 281 /**
 282  * uart_port_lock_irqsave - Lock the UART port, save and disable interrupts
 283  * @up:         Pointer to UART port structure
 284  * @flags:      Pointer to interrupt flags storage
 285  */
 286 static inline void uart_port_lock_irqsave(struct uart_port *up, unsigned long *flags)
 287 {
 288         spin_lock_irqsave(&up->lock, *flags);
 289 }
 290
 291 /**
 292  * uart_port_trylock - Try to lock the UART port
 293  * @up:         Pointer to UART port structure
 294  *
 295  * Returns: True if lock was acquired, false otherwise
 296  */
 297 static inline bool uart_port_trylock(struct uart_port *up)
 298 {
 299         return spin_trylock(&up->lock);
 300 }
 301
 302 /**
 303  * uart_port_trylock_irqsave - Try to lock the UART port, save and disable interrupts
 304  * @up:         Pointer to UART port structure
 305  * @flags:      Pointer to interrupt flags storage
 306  *
 307  * Returns: True if lock was acquired, false otherwise
 308  */
 309 static inline bool uart_port_trylock_irqsave(struct uart_port *up, unsigned long *flags)
 310 {
 311         return spin_trylock_irqsave(&up->lock, *flags);
 312 }
 313
 314 /**
 315  * uart_port_unlock - Unlock the UART port
 316  * @up:         Pointer to UART port structure
 317  */
 318 static inline void uart_port_unlock(struct uart_port *up)
 319 {
 320         spin_unlock(&up->lock);
 321 }
 322
 323 /**
 324  * uart_port_unlock_irq - Unlock the UART port and re-enable interrupts
 325  * @up:         Pointer to UART port structure
 326  */
 327 static inline void uart_port_unlock_irq(struct uart_port *up)
 328 {
 329         spin_unlock_irq(&up->lock);
 330 }
 331
 332 /**
 333  * uart_port_unlock_irqrestore - Unlock the UART port, restore interrupts
 334  * @up:         Pointer to UART port structure
 335  * @flags:      The saved interrupt flags for restore
 336  */
 337 static inline void uart_port_unlock_irqrestore(struct uart_port *up, unsigned long flags)
 338 {
 339         spin_unlock_irqrestore(&up->lock, flags);
 340 }
 341
 342 static inline int serial_port_in(struct uart_port *up, int offset)
 343 {
 344         return up->serial_in(up, offset);
 345 }
 346
 347 static inline void serial_port_out(struct uart_port *up, int offset, int value)
 348 {
 349         up->serial_out(up, offset, value);
 350 }
 351
 352 /**
 353  * enum uart_pm_state - power states for UARTs
 354  * @UART_PM_STATE_ON: UART is powered, up and operational
 355  * @UART_PM_STATE_OFF: UART is powered off
 356  * @UART_PM_STATE_UNDEFINED: sentinel
 357  */
 358 enum uart_pm_state {
 359         UART_PM_STATE_ON = 0,
 360         UART_PM_STATE_OFF = 3, /* number taken from ACPI */
 361         UART_PM_STATE_UNDEFINED,
 362 };
 363
 364 /*
 365  * This is the state information which is persistent across opens.
 366  */
 367 struct uart_state {
 368         struct tty_port         port;
 369
 370         enum uart_pm_state      pm_state;
 371         struct circ_buf         xmit;
 372
 373         atomic_t                refcount;
 374         wait_queue_head_t       remove_wait;
 375         struct uart_port        *uart_port;
 376 };
 377
 378 #define UART_XMIT_SIZE  PAGE_SIZE
 379
 380
 381 /* number of characters left in xmit buffer before we ask for more */
 382 #define WAKEUP_CHARS            256
 383
 384 /**
 385  * uart_xmit_advance - Advance xmit buffer and account Tx'ed chars
 386  * @up: uart_port structure describing the port
 387  * @chars: number of characters sent
 388  *
 389  * This function advances the tail of circular xmit buffer by the number of
 390  * @chars transmitted and handles accounting of transmitted bytes (into
 391  * @up's icount.tx).
 392  */
 393 static inline void uart_xmit_advance(struct uart_port *up, unsigned int chars)
 394 {
 395         struct circ_buf *xmit = &up->state->xmit;
 396
 397         xmit->tail = (xmit->tail + chars) & (UART_XMIT_SIZE - 1);
 398         up->icount.tx += chars;
 399 }
 400
 401 struct module;
 402 struct tty_driver;
 403
 404 struct uart_driver {
 405         struct module           *owner;
 406         const char              *driver_name;
 407         const char              *dev_name;
 408         int                      major;
 409         int                      minor;
 410         int                      nr;
 411         struct console          *cons;
 412
 413         /*
 414          * these are private; the low level driver should not
 415          * touch these; they should be initialised to NULL
 416          */
 417         struct uart_state       *state;
 418         struct tty_driver       *tty_driver;
 419 };
 420
 421 void uart_write_wakeup(struct uart_port *port);
 422
 423 /*
 424  * Baud rate helpers.
 425  */
 426 void uart_update_timeout(struct uart_port *port, unsigned int cflag,
 427                          unsigned int baud);
 428 unsigned int uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
 429                                 struct ktermios *old, unsigned int min,
 430                                 unsigned int max);
 431 unsigned int uart_get_divisor(struct uart_port *port, unsigned int baud);
 432
 433 /* Base timer interval for polling */
 434 static inline int uart_poll_timeout(struct uart_port *port)
 435 {
 436         int timeout = port->timeout;
 437
 438         return timeout > 6 ? (timeout / 2 - 2) : 1;
 439 }
 440
 441 /*
 442  * Console helpers.
 443  */
 444 struct earlycon_device {
 445         struct console *con;
 446         struct uart_port port;
 447         char options[16];               /* e.g., 115200n8 */
 448         unsigned int baud;
 449 };
 450
 451 struct earlycon_id {
 452         char    name[15];
 453         char    name_term;      /* In case compiler didn't '\0' term name */
 454         char    compatible[128];
 455         int     (*setup)(struct earlycon_device *, const char *options);
 456 };
 457
 458 extern const struct earlycon_id *__earlycon_table[];
 459 extern const struct earlycon_id *__earlycon_table_end[];
 460
 461 #if defined(CONFIG_SERIAL_EARLYCON) && !defined(MODULE)
 462 #define EARLYCON_USED_OR_UNUSED __used
 463 #else
 464 #define EARLYCON_USED_OR_UNUSED __maybe_unused
 465 #endif
 466
 467 #define _OF_EARLYCON_DECLARE(_name, compat, fn, unique_id)              \
 468         static const struct earlycon_id unique_id                       \
 469              EARLYCON_USED_OR_UNUSED __initconst                        \
 470                 = { .name = __stringify(_name),                         \
 471                     .compatible = compat,                               \
 472                     .setup = fn  };                                     \
 473         static const struct earlycon_id EARLYCON_USED_OR_UNUSED         \
 474                 __section("__earlycon_table")                           \
 475                 * const __PASTE(__p, unique_id) = &unique_id
 476
 477 #define OF_EARLYCON_DECLARE(_name, compat, fn)                          \
 478         _OF_EARLYCON_DECLARE(_name, compat, fn,                         \
 479                              __UNIQUE_ID(__earlycon_##_name))
 480
 481 #define EARLYCON_DECLARE(_name, fn)     OF_EARLYCON_DECLARE(_name, "", fn)
 482
 483 extern int of_setup_earlycon(const struct earlycon_id *match,
 484                              unsigned long node,
 485                              const char *options);
 486
 487 #ifdef CONFIG_SERIAL_EARLYCON
 488 extern bool earlycon_acpi_spcr_enable __initdata;
 489 int setup_earlycon(char *buf);
 490 #else
 491 static const bool earlycon_acpi_spcr_enable EARLYCON_USED_OR_UNUSED;
 492 static inline int setup_earlycon(char *buf) { return 0; }
 493 #endif
 494
 495 static inline bool uart_console_enabled(struct uart_port *port)
 496 {
 497         return uart_console(port) && (port->cons->flags & CON_ENABLED);
 498 }
 499
 500 struct uart_port *uart_get_console(struct uart_port *ports, int nr,
 501                                    struct console *c);
 502 int uart_parse_earlycon(char *p, unsigned char *iotype, resource_size_t *addr,
 503                         char **options);
 504 void uart_parse_options(const char *options, int *baud, int *parity, int *bits,
 505                         int *flow);
 506 int uart_set_options(struct uart_port *port, struct console *co, int baud,
 507                      int parity, int bits, int flow);
 508 struct tty_driver *uart_console_device(struct console *co, int *index);
 509 void uart_console_write(struct uart_port *port, const char *s,
 510                         unsigned int count,
 511                         void (*putchar)(struct uart_port *, int));
 512
 513 /*
 514  * Port/driver registration/removal
 515  */
 516 int uart_register_driver(struct uart_driver *uart);
 517 void uart_unregister_driver(struct uart_driver *uart);
 518 int uart_add_one_port(struct uart_driver *reg, struct uart_port *port);
 519 int uart_remove_one_port(struct uart_driver *reg, struct uart_port *port);
 520 int uart_match_port(struct uart_port *port1, struct uart_port *port2);
 521
 522 /*
 523  * Power Management
 524  */
 525 int uart_suspend_port(struct uart_driver *reg, struct uart_port *port);
 526 int uart_resume_port(struct uart_driver *reg, struct uart_port *port);
 527
 528 #define uart_circ_empty(circ)           ((circ)->head == (circ)->tail)
 529 #define uart_circ_clear(circ)           ((circ)->head = (circ)->tail = 0)
 530
 531 #define uart_circ_chars_pending(circ)   \
 532         (CIRC_CNT((circ)->head, (circ)->tail, UART_XMIT_SIZE))
 533
 534 #define uart_circ_chars_free(circ)      \
 535         (CIRC_SPACE((circ)->head, (circ)->tail, UART_XMIT_SIZE))
 536
 537 static inline int uart_tx_stopped(struct uart_port *port)
 538 {
 539         struct tty_struct *tty = port->state->port.tty;
 540         if ((tty && tty->stopped) || port->hw_stopped)
 541                 return 1;
 542         return 0;
 543 }
 544
 545 static inline bool uart_cts_enabled(struct uart_port *uport)
 546 {
 547         return !!(uport->status & UPSTAT_CTS_ENABLE);
 548 }
 549
 550 static inline bool uart_softcts_mode(struct uart_port *uport)
 551 {
 552         upstat_t mask = UPSTAT_CTS_ENABLE | UPSTAT_AUTOCTS;
 553
 554         return ((uport->status & mask) == UPSTAT_CTS_ENABLE);
 555 }
 556
 557 /*
 558  * The following are helper functions for the low level drivers.
 559  */
 560
 561 extern void uart_handle_dcd_change(struct uart_port *uport,
 562                 unsigned int status);
 563 extern void uart_handle_cts_change(struct uart_port *uport,
 564                 unsigned int status);
 565
 566 extern void uart_insert_char(struct uart_port *port, unsigned int status,
 567                  unsigned int overrun, unsigned int ch, unsigned int flag);
 568
 569 void uart_xchar_out(struct uart_port *uport, int offset);
 570
 571 #ifdef CONFIG_MAGIC_SYSRQ_SERIAL
 572 #define SYSRQ_TIMEOUT   (HZ * 5)
 573
 574 bool uart_try_toggle_sysrq(struct uart_port *port, unsigned int ch);
 575
 576 static inline int uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
 577 {
 578         if (!port->sysrq)
 579                 return 0;
 580
 581         if (ch && time_before(jiffies, port->sysrq)) {
 582                 if (sysrq_mask()) {
 583                         handle_sysrq(ch);
 584                         port->sysrq = 0;
 585                         return 1;
 586                 }
 587                 if (uart_try_toggle_sysrq(port, ch))
 588                         return 1;
 589         }
 590         port->sysrq = 0;
 591
 592         return 0;
 593 }
 594
 595 static inline int uart_prepare_sysrq_char(struct uart_port *port, unsigned int ch)
 596 {
 597         if (!port->sysrq)
 598                 return 0;
 599
 600         if (ch && time_before(jiffies, port->sysrq)) {
 601                 if (sysrq_mask()) {
 602                         port->sysrq_ch = ch;
 603                         port->sysrq = 0;
 604                         return 1;
 605                 }
 606                 if (uart_try_toggle_sysrq(port, ch))
 607                         return 1;
 608         }
 609         port->sysrq = 0;
 610
 611         return 0;
 612 }
 613
 614 static inline void uart_unlock_and_check_sysrq(struct uart_port *port, unsigned long irqflags)
 615 {
 616         int sysrq_ch;
 617
 618         if (!port->has_sysrq) {
 619                 spin_unlock_irqrestore(&port->lock, irqflags);
 620                 return;
 621         }
 622
 623         sysrq_ch = port->sysrq_ch;
 624         port->sysrq_ch = 0;
 625
 626         spin_unlock_irqrestore(&port->lock, irqflags);
 627
 628         if (sysrq_ch)
 629                 handle_sysrq(sysrq_ch);
 630 }
 631 #else   /* CONFIG_MAGIC_SYSRQ_SERIAL */
 632 static inline int uart_handle_sysrq_char(struct uart_port *port, unsigned int ch)
 633 {
 634         return 0;
 635 }
 636 static inline int uart_prepare_sysrq_char(struct uart_port *port, unsigned int ch)
 637 {
 638         return 0;
 639 }
 640 static inline void uart_unlock_and_check_sysrq(struct uart_port *port, unsigned long irqflags)
 641 {
 642         spin_unlock_irqrestore(&port->lock, irqflags);
 643 }
 644 #endif  /* CONFIG_MAGIC_SYSRQ_SERIAL */
 645
 646 /*
 647  * We do the SysRQ and SAK checking like this...
 648  */
 649 static inline int uart_handle_break(struct uart_port *port)
 650 {
 651         struct uart_state *state = port->state;
 652
 653         if (port->handle_break)
 654                 port->handle_break(port);
 655
 656 #ifdef CONFIG_MAGIC_SYSRQ_SERIAL
 657         if (port->has_sysrq && uart_console(port)) {
 658                 if (!port->sysrq) {
 659                         port->sysrq = jiffies + SYSRQ_TIMEOUT;
 660                         return 1;
 661                 }
 662                 port->sysrq = 0;
 663         }
 664 #endif
 665         if (port->flags & UPF_SAK)
 666                 do_SAK(state->port.tty);
 667         return 0;
 668 }
 669
 670 /*
 671  *      UART_ENABLE_MS - determine if port should enable modem status irqs
 672  */
 673 #define UART_ENABLE_MS(port,cflag)      ((port)->flags & UPF_HARDPPS_CD || \
 674                                          (cflag) & CRTSCTS || \
 675                                          !((cflag) & CLOCAL))
 676
 677 int uart_get_rs485_mode(struct uart_port *port);
 678 #endif /* LINUX_SERIAL_CORE_H */