include/linux/serial_8250.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *  linux/include/linux/serial_8250.h
   4  *
   5  *  Copyright (C) 2004 Russell King
   6  */
   7 #ifndef _LINUX_SERIAL_8250_H
   8 #define _LINUX_SERIAL_8250_H
   9
  10 #include <linux/atomic.h>
  11 #include <linux/serial_core.h>
  12 #include <linux/serial_reg.h>
  13 #include <linux/platform_device.h>
  14
  15 /*
  16  * This is the platform device platform_data structure
  17  */
  18 struct plat_serial8250_port {
  19         unsigned long   iobase;         /* io base address */
  20         void __iomem    *membase;       /* ioremap cookie or NULL */
  21         resource_size_t mapbase;        /* resource base */
  22         unsigned int    irq;            /* interrupt number */
  23         unsigned long   irqflags;       /* request_irq flags */
  24         unsigned int    uartclk;        /* UART clock rate */
  25         void            *private_data;
  26         unsigned char   regshift;       /* register shift */
  27         unsigned char   iotype;         /* UPIO_* */
  28         unsigned char   hub6;
  29         unsigned char   has_sysrq;      /* supports magic SysRq */
  30         upf_t           flags;          /* UPF_* flags */
  31         unsigned int    type;           /* If UPF_FIXED_TYPE */
  32         unsigned int    (*serial_in)(struct uart_port *, int);
  33         void            (*serial_out)(struct uart_port *, int, int);
  34         void            (*set_termios)(struct uart_port *,
  35                                        struct ktermios *new,
  36                                        struct ktermios *old);
  37         void            (*set_ldisc)(struct uart_port *,
  38                                      struct ktermios *);
  39         unsigned int    (*get_mctrl)(struct uart_port *);
  40         int             (*handle_irq)(struct uart_port *);
  41         void            (*pm)(struct uart_port *, unsigned int state,
  42                               unsigned old);
  43         void            (*handle_break)(struct uart_port *);
  44 };
  45
  46 /*
  47  * Allocate 8250 platform device IDs.  Nothing is implied by
  48  * the numbering here, except for the legacy entry being -1.
  49  */
  50 enum {
  51         PLAT8250_DEV_LEGACY = -1,
  52         PLAT8250_DEV_PLATFORM,
  53         PLAT8250_DEV_PLATFORM1,
  54         PLAT8250_DEV_PLATFORM2,
  55         PLAT8250_DEV_FOURPORT,
  56         PLAT8250_DEV_ACCENT,
  57         PLAT8250_DEV_BOCA,
  58         PLAT8250_DEV_EXAR_ST16C554,
  59         PLAT8250_DEV_HUB6,
  60         PLAT8250_DEV_AU1X00,
  61         PLAT8250_DEV_SM501,
  62 };
  63
  64 struct uart_8250_dma;
  65 struct uart_8250_port;
  66
  67 /**
  68  * 8250 core driver operations
  69  *
  70  * @setup_irq()         Setup irq handling. The universal 8250 driver links this
  71  *                      port to the irq chain. Other drivers may @request_irq().
  72  * @release_irq()       Undo irq handling. The universal 8250 driver unlinks
  73  *                      the port from the irq chain.
  74  */
  75 struct uart_8250_ops {
  76         int             (*setup_irq)(struct uart_8250_port *);
  77         void            (*release_irq)(struct uart_8250_port *);
  78         void            (*setup_timer)(struct uart_8250_port *);
  79 };
  80
  81 struct uart_8250_em485 {
  82         struct hrtimer          start_tx_timer; /* "rs485 start tx" timer */
  83         struct hrtimer          stop_tx_timer;  /* "rs485 stop tx" timer */
  84         struct hrtimer          *active_timer;  /* pointer to active timer */
  85         struct uart_8250_port   *port;          /* for hrtimer callbacks */
  86         unsigned int            tx_stopped:1;   /* tx is currently stopped */
  87 };
  88
  89 /*
  90  * This should be used by drivers which want to register
  91  * their own 8250 ports without registering their own
  92  * platform device.  Using these will make your driver
  93  * dependent on the 8250 driver.
  94  */
  95
  96 struct uart_8250_port {
  97         struct uart_port        port;
  98         struct timer_list       timer;          /* "no irq" timer */
  99         struct list_head        list;           /* ports on this IRQ */
 100         u32                     capabilities;   /* port capabilities */
 101         unsigned short          bugs;           /* port bugs */
 102         bool                    fifo_bug;       /* min RX trigger if enabled */
 103         unsigned int            tx_loadsz;      /* transmit fifo load size */
 104         unsigned char           acr;
 105         unsigned char           fcr;
 106         unsigned char           ier;
 107         unsigned char           lcr;
 108         unsigned char           mcr;
 109         unsigned char           mcr_mask;       /* mask of user bits */
 110         unsigned char           mcr_force;      /* mask of forced bits */
 111         unsigned char           cur_iotype;     /* Running I/O type */
 112         unsigned int            rpm_tx_active;
 113         unsigned char           canary;         /* non-zero during system sleep
 114                                                  *   if no_console_suspend
 115                                                  */
 116         unsigned char           probe;
 117         struct mctrl_gpios      *gpios;
 118 #define UART_PROBE_RSA  (1 << 0)
 119
 120         /*
 121          * Some bits in registers are cleared on a read, so they must
 122          * be saved whenever the register is read but the bits will not
 123          * be immediately processed.
 124          */
 125 #define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
 126         unsigned char           lsr_saved_flags;
 127 #define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
 128         unsigned char           msr_saved_flags;
 129
 130         atomic_t                console_printing;
 131
 132         struct uart_8250_dma    *dma;
 133         const struct uart_8250_ops *ops;
 134
 135         /* 8250 specific callbacks */
 136         int                     (*dl_read)(struct uart_8250_port *);
 137         void                    (*dl_write)(struct uart_8250_port *, int);
 138
 139         struct uart_8250_em485 *em485;
 140         void                    (*rs485_start_tx)(struct uart_8250_port *);
 141         void                    (*rs485_stop_tx)(struct uart_8250_port *);
 142
 143         /* Serial port overrun backoff */
 144         struct delayed_work overrun_backoff;
 145         u32 overrun_backoff_time_ms;
 146 };
 147
 148 static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up)
 149 {
 150         return container_of(up, struct uart_8250_port, port);
 151 }
 152
 153 int serial8250_register_8250_port(const struct uart_8250_port *);
 154 void serial8250_unregister_port(int line);
 155 void serial8250_suspend_port(int line);
 156 void serial8250_resume_port(int line);
 157
 158 extern int early_serial_setup(struct uart_port *port);
 159
 160 extern int early_serial8250_setup(struct earlycon_device *device,
 161                                          const char *options);
 162 extern void serial8250_update_uartclk(struct uart_port *port,
 163                                       unsigned int uartclk);
 164 extern void serial8250_do_set_termios(struct uart_port *port,
 165                 struct ktermios *termios, struct ktermios *old);
 166 extern void serial8250_do_set_ldisc(struct uart_port *port,
 167                                     struct ktermios *termios);
 168 extern unsigned int serial8250_do_get_mctrl(struct uart_port *port);
 169 extern int serial8250_do_startup(struct uart_port *port);
 170 extern void serial8250_do_shutdown(struct uart_port *port);
 171 extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
 172                              unsigned int oldstate);
 173 extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
 174 extern void serial8250_do_set_divisor(struct uart_port *port, unsigned int baud,
 175                                       unsigned int quot,
 176                                       unsigned int quot_frac);
 177 extern int fsl8250_handle_irq(struct uart_port *port);
 178 int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
 179 unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
 180 void serial8250_read_char(struct uart_8250_port *up, unsigned char lsr);
 181 void serial8250_tx_chars(struct uart_8250_port *up);
 182 unsigned int serial8250_modem_status(struct uart_8250_port *up);
 183 void serial8250_init_port(struct uart_8250_port *up);
 184 void serial8250_set_defaults(struct uart_8250_port *up);
 185 void serial8250_console_write(struct uart_8250_port *up, const char *s,
 186                               unsigned int count);
 187 void serial8250_console_write_atomic(struct uart_8250_port *up, const char *s,
 188                                      unsigned int count);
 189 int serial8250_console_setup(struct uart_port *port, char *options, bool probe);
 190 int serial8250_console_exit(struct uart_port *port);
 191
 192 extern void serial8250_set_isa_configurator(void (*v)
 193                                         (int port, struct uart_port *up,
 194                                                 u32 *capabilities));
 195
 196 #ifdef CONFIG_SERIAL_8250_RT288X
 197 unsigned int au_serial_in(struct uart_port *p, int offset);
 198 void au_serial_out(struct uart_port *p, int offset, int value);
 199 #endif
 200
 201 #endif