drivers/tty/serial/8250/8250.h

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  Driver for 8250/16550-type serial ports
   4  *
   5  *  Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
   6  *
   7  *  Copyright (C) 2001 Russell King.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  */
  14
  15 #include <linux/serial_8250.h>
  16 #include <linux/serial_reg.h>
  17 #include <linux/dmaengine.h>
  18
  19 struct uart_8250_dma {
  20         int (*tx_dma)(struct uart_8250_port *p);
  21         int (*rx_dma)(struct uart_8250_port *p);
  22
  23         /* Filter function */
  24         dma_filter_fn           fn;
  25         /* Parameter to the filter function */
  26         void                    *rx_param;
  27         void                    *tx_param;
  28
  29         struct dma_slave_config rxconf;
  30         struct dma_slave_config txconf;
  31
  32         struct dma_chan         *rxchan;
  33         struct dma_chan         *txchan;
  34
  35         /* Device address base for DMA operations */
  36         phys_addr_t             rx_dma_addr;
  37         phys_addr_t             tx_dma_addr;
  38
  39         /* DMA address of the buffer in memory */
  40         dma_addr_t              rx_addr;
  41         dma_addr_t              tx_addr;
  42
  43         dma_cookie_t            rx_cookie;
  44         dma_cookie_t            tx_cookie;
  45
  46         void                    *rx_buf;
  47
  48         size_t                  rx_size;
  49         size_t                  tx_size;
  50
  51         unsigned char           tx_running;
  52         unsigned char           tx_err;
  53         unsigned char           rx_running;
  54 };
  55
  56 struct old_serial_port {
  57         unsigned int uart;
  58         unsigned int baud_base;
  59         unsigned int port;
  60         unsigned int irq;
  61         upf_t        flags;
  62         unsigned char io_type;
  63         unsigned char __iomem *iomem_base;
  64         unsigned short iomem_reg_shift;
  65 };
  66
  67 struct serial8250_config {
  68         const char      *name;
  69         unsigned short  fifo_size;
  70         unsigned short  tx_loadsz;
  71         unsigned char   fcr;
  72         unsigned char   rxtrig_bytes[UART_FCR_R_TRIG_MAX_STATE];
  73         unsigned int    flags;
  74 };
  75
  76 #define UART_CAP_FIFO   (1 << 8)        /* UART has FIFO */
  77 #define UART_CAP_EFR    (1 << 9)        /* UART has EFR */
  78 #define UART_CAP_SLEEP  (1 << 10)       /* UART has IER sleep */
  79 #define UART_CAP_AFE    (1 << 11)       /* MCR-based hw flow control */
  80 #define UART_CAP_UUE    (1 << 12)       /* UART needs IER bit 6 set (Xscale) */
  81 #define UART_CAP_RTOIE  (1 << 13)       /* UART needs IER bit 4 set (Xscale, Tegra) */
  82 #define UART_CAP_HFIFO  (1 << 14)       /* UART has a "hidden" FIFO */
  83 #define UART_CAP_RPM    (1 << 15)       /* Runtime PM is active while idle */
  84 #define UART_CAP_IRDA   (1 << 16)       /* UART supports IrDA line discipline */
  85 #define UART_CAP_MINI   (1 << 17)       /* Mini UART on BCM283X family lacks:
  86                                          * STOP PARITY EPAR SPAR WLEN5 WLEN6
  87                                          */
  88
  89 #define UART_BUG_QUOT   (1 << 0)        /* UART has buggy quot LSB */
  90 #define UART_BUG_TXEN   (1 << 1)        /* UART has buggy TX IIR status */
  91 #define UART_BUG_NOMSR  (1 << 2)        /* UART has buggy MSR status bits (Au1x00) */
  92 #define UART_BUG_THRE   (1 << 3)        /* UART has buggy THRE reassertion */
  93 #define UART_BUG_PARITY (1 << 4)        /* UART mishandles parity if FIFO enabled */
  94
  95
  96 #ifdef CONFIG_SERIAL_8250_SHARE_IRQ
  97 #define SERIAL8250_SHARE_IRQS 1
  98 #else
  99 #define SERIAL8250_SHARE_IRQS 0
 100 #endif
 101
 102 #define SERIAL8250_PORT_FLAGS(_base, _irq, _flags)              \
 103         {                                                       \
 104                 .iobase         = _base,                        \
 105                 .irq            = _irq,                         \
 106                 .uartclk        = 1843200,                      \
 107                 .iotype         = UPIO_PORT,                    \
 108                 .flags          = UPF_BOOT_AUTOCONF | (_flags), \
 109         }
 110
 111 #define SERIAL8250_PORT(_base, _irq) SERIAL8250_PORT_FLAGS(_base, _irq, 0)
 112
 113
 114 static inline int serial_in(struct uart_8250_port *up, int offset)
 115 {
 116         return up->port.serial_in(&up->port, offset);
 117 }
 118
 119 static inline void serial_out(struct uart_8250_port *up, int offset, int value)
 120 {
 121         up->port.serial_out(&up->port, offset, value);
 122 }
 123
 124 void serial8250_clear_and_reinit_fifos(struct uart_8250_port *p);
 125
 126 static inline int serial_dl_read(struct uart_8250_port *up)
 127 {
 128         return up->dl_read(up);
 129 }
 130
 131 static inline void serial_dl_write(struct uart_8250_port *up, int value)
 132 {
 133         up->dl_write(up, value);
 134 }
 135
 136 struct uart_8250_port *serial8250_get_port(int line);
 137
 138 void serial8250_rpm_get(struct uart_8250_port *p);
 139 void serial8250_rpm_put(struct uart_8250_port *p);
 140
 141 void serial8250_rpm_get_tx(struct uart_8250_port *p);
 142 void serial8250_rpm_put_tx(struct uart_8250_port *p);
 143
 144 int serial8250_em485_init(struct uart_8250_port *p);
 145 void serial8250_em485_destroy(struct uart_8250_port *p);
 146
 147 static inline void serial8250_out_MCR(struct uart_8250_port *up, int value)
 148 {
 149         serial_out(up, UART_MCR, value);
 150 }
 151
 152 static inline int serial8250_in_MCR(struct uart_8250_port *up)
 153 {
 154         return serial_in(up, UART_MCR);
 155 }
 156
 157 #if defined(__alpha__) && !defined(CONFIG_PCI)
 158 /*
 159  * Digital did something really horribly wrong with the OUT1 and OUT2
 160  * lines on at least some ALPHA's.  The failure mode is that if either
 161  * is cleared, the machine locks up with endless interrupts.
 162  */
 163 #define ALPHA_KLUDGE_MCR  (UART_MCR_OUT2 | UART_MCR_OUT1)
 164 #else
 165 #define ALPHA_KLUDGE_MCR 0
 166 #endif
 167
 168 #ifdef CONFIG_SERIAL_8250_PNP
 169 int serial8250_pnp_init(void);
 170 void serial8250_pnp_exit(void);
 171 #else
 172 static inline int serial8250_pnp_init(void) { return 0; }
 173 static inline void serial8250_pnp_exit(void) { }
 174 #endif
 175
 176 #ifdef CONFIG_SERIAL_8250_FINTEK
 177 int fintek_8250_probe(struct uart_8250_port *uart);
 178 #else
 179 static inline int fintek_8250_probe(struct uart_8250_port *uart) { return 0; }
 180 #endif
 181
 182 #ifdef CONFIG_ARCH_OMAP1
 183 static inline int is_omap1_8250(struct uart_8250_port *pt)
 184 {
 185         int res;
 186
 187         switch (pt->port.mapbase) {
 188         case OMAP1_UART1_BASE:
 189         case OMAP1_UART2_BASE:
 190         case OMAP1_UART3_BASE:
 191                 res = 1;
 192                 break;
 193         default:
 194                 res = 0;
 195                 break;
 196         }
 197
 198         return res;
 199 }
 200
 201 static inline int is_omap1510_8250(struct uart_8250_port *pt)
 202 {
 203         if (!cpu_is_omap1510())
 204                 return 0;
 205
 206         return is_omap1_8250(pt);
 207 }
 208 #else
 209 static inline int is_omap1_8250(struct uart_8250_port *pt)
 210 {
 211         return 0;
 212 }
 213 static inline int is_omap1510_8250(struct uart_8250_port *pt)
 214 {
 215         return 0;
 216 }
 217 #endif
 218
 219 #ifdef CONFIG_SERIAL_8250_DMA
 220 extern int serial8250_tx_dma(struct uart_8250_port *);
 221 extern int serial8250_rx_dma(struct uart_8250_port *);
 222 extern void serial8250_rx_dma_flush(struct uart_8250_port *);
 223 extern int serial8250_request_dma(struct uart_8250_port *);
 224 extern void serial8250_release_dma(struct uart_8250_port *);
 225 #else
 226 static inline int serial8250_tx_dma(struct uart_8250_port *p)
 227 {
 228         return -1;
 229 }
 230 static inline int serial8250_rx_dma(struct uart_8250_port *p)
 231 {
 232         return -1;
 233 }
 234 static inline void serial8250_rx_dma_flush(struct uart_8250_port *p) { }
 235 static inline int serial8250_request_dma(struct uart_8250_port *p)
 236 {
 237         return -1;
 238 }
 239 static inline void serial8250_release_dma(struct uart_8250_port *p) { }
 240 #endif
 241
 242 static inline int ns16550a_goto_highspeed(struct uart_8250_port *up)
 243 {
 244         unsigned char status;
 245
 246         status = serial_in(up, 0x04); /* EXCR2 */
 247 #define PRESL(x) ((x) & 0x30)
 248         if (PRESL(status) == 0x10) {
 249                 /* already in high speed mode */
 250                 return 0;
 251         } else {
 252                 status &= ~0xB0; /* Disable LOCK, mask out PRESL[01] */
 253                 status |= 0x10;  /* 1.625 divisor for baud_base --> 921600 */
 254                 serial_out(up, 0x04, status);
 255         }
 256         return 1;
 257 }
 258
 259 static inline int serial_index(struct uart_port *port)
 260 {
 261         return port->minor - 64;
 262 }