include/linux/serial_8250.h

   1 /*
   2  *  linux/include/linux/serial_8250.h
   3  *
   4  *  Copyright (C) 2004 Russell King
   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 #ifndef _LINUX_SERIAL_8250_H
  12 #define _LINUX_SERIAL_8250_H
  13
  14 #include <linux/serial_core.h>
  15 #include <linux/platform_device.h>
  16
  17 /*
  18  * This is the platform device platform_data structure
  19  */
  20 struct plat_serial8250_port {
  21         unsigned long   iobase;         /* io base address */
  22         void __iomem    *membase;       /* ioremap cookie or NULL */
  23         resource_size_t mapbase;        /* resource base */
  24         unsigned int    irq;            /* interrupt number */
  25         unsigned long   irqflags;       /* request_irq flags */
  26         unsigned int    uartclk;        /* UART clock rate */
  27         void            *private_data;
  28         unsigned char   regshift;       /* register shift */
  29         unsigned char   iotype;         /* UPIO_* */
  30         unsigned char   hub6;
  31         upf_t           flags;          /* UPF_* flags */
  32         unsigned int    type;           /* If UPF_FIXED_TYPE */
  33         unsigned int    (*serial_in)(struct uart_port *, int);
  34         void            (*serial_out)(struct uart_port *, int, int);
  35         void            (*set_termios)(struct uart_port *,
  36                                        struct ktermios *new,
  37                                        struct ktermios *old);
  38         int             (*handle_irq)(struct uart_port *);
  39         void            (*pm)(struct uart_port *, unsigned int state,
  40                               unsigned old);
  41         void            (*handle_break)(struct uart_port *);
  42 };
  43
  44 /*
  45  * Allocate 8250 platform device IDs.  Nothing is implied by
  46  * the numbering here, except for the legacy entry being -1.
  47  */
  48 enum {
  49         PLAT8250_DEV_LEGACY = -1,
  50         PLAT8250_DEV_PLATFORM,
  51         PLAT8250_DEV_PLATFORM1,
  52         PLAT8250_DEV_PLATFORM2,
  53         PLAT8250_DEV_FOURPORT,
  54         PLAT8250_DEV_ACCENT,
  55         PLAT8250_DEV_BOCA,
  56         PLAT8250_DEV_EXAR_ST16C554,
  57         PLAT8250_DEV_HUB6,
  58         PLAT8250_DEV_AU1X00,
  59         PLAT8250_DEV_SM501,
  60 };
  61
  62 struct uart_8250_dma;
  63
  64 /*
  65  * This should be used by drivers which want to register
  66  * their own 8250 ports without registering their own
  67  * platform device.  Using these will make your driver
  68  * dependent on the 8250 driver.
  69  */
  70
  71 struct uart_8250_port {
  72         struct uart_port        port;
  73         struct timer_list       timer;          /* "no irq" timer */
  74         struct list_head        list;           /* ports on this IRQ */
  75         unsigned short          capabilities;   /* port capabilities */
  76         unsigned short          bugs;           /* port bugs */
  77         bool                    fifo_bug;       /* min RX trigger if enabled */
  78         unsigned int            tx_loadsz;      /* transmit fifo load size */
  79         unsigned char           acr;
  80         unsigned char           fcr;
  81         unsigned char           ier;
  82         unsigned char           lcr;
  83         unsigned char           mcr;
  84         unsigned char           mcr_mask;       /* mask of user bits */
  85         unsigned char           mcr_force;      /* mask of forced bits */
  86         unsigned char           cur_iotype;     /* Running I/O type */
  87         unsigned int            rpm_tx_active;
  88
  89         /*
  90          * Some bits in registers are cleared on a read, so they must
  91          * be saved whenever the register is read but the bits will not
  92          * be immediately processed.
  93          */
  94 #define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
  95         unsigned char           lsr_saved_flags;
  96 #define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
  97         unsigned char           msr_saved_flags;
  98
  99         struct uart_8250_dma    *dma;
 100         struct serial_rs485     rs485;
 101
 102         /* 8250 specific callbacks */
 103         int                     (*dl_read)(struct uart_8250_port *);
 104         void                    (*dl_write)(struct uart_8250_port *, int);
 105         int                     (*rs485_config)(struct uart_8250_port *,
 106                                                 struct serial_rs485 *rs485);
 107 };
 108
 109 static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up)
 110 {
 111         return container_of(up, struct uart_8250_port, port);
 112 }
 113
 114 int serial8250_register_8250_port(struct uart_8250_port *);
 115 void serial8250_unregister_port(int line);
 116 void serial8250_suspend_port(int line);
 117 void serial8250_resume_port(int line);
 118
 119 extern int early_serial_setup(struct uart_port *port);
 120
 121 extern int serial8250_find_port(struct uart_port *p);
 122 extern int serial8250_find_port_for_earlycon(void);
 123 extern unsigned int serial8250_early_in(struct uart_port *port, int offset);
 124 extern void serial8250_early_out(struct uart_port *port, int offset, int value);
 125 extern int setup_early_serial8250_console(char *cmdline);
 126 extern void serial8250_do_set_termios(struct uart_port *port,
 127                 struct ktermios *termios, struct ktermios *old);
 128 extern int serial8250_do_startup(struct uart_port *port);
 129 extern void serial8250_do_shutdown(struct uart_port *port);
 130 extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
 131                              unsigned int oldstate);
 132 extern int fsl8250_handle_irq(struct uart_port *port);
 133 int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
 134 unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
 135 void serial8250_tx_chars(struct uart_8250_port *up);
 136 unsigned int serial8250_modem_status(struct uart_8250_port *up);
 137
 138 extern void serial8250_set_isa_configurator(void (*v)
 139                                         (int port, struct uart_port *up,
 140                                                 unsigned short *capabilities));
 141
 142 #endif