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/serial_reg.h> 16 #include <linux/platform_device.h> 17 18 /* 19 * This is the platform device platform_data structure 20 */ 21 struct plat_serial8250_port { 22 unsigned long iobase; /* io base address */ 23 void __iomem *membase; /* ioremap cookie or NULL */ 24 resource_size_t mapbase; /* resource base */ 25 unsigned int irq; /* interrupt number */ 26 unsigned long irqflags; /* request_irq flags */ 27 unsigned int uartclk; /* UART clock rate */ 28 void *private_data; 29 unsigned char regshift; /* register shift */ 30 unsigned char iotype; /* UPIO_* */ 31 unsigned char hub6; 32 upf_t flags; /* UPF_* flags */ 33 unsigned int type; /* If UPF_FIXED_TYPE */ 34 unsigned int (*serial_in)(struct uart_port *, int); 35 void (*serial_out)(struct uart_port *, int, int); 36 void (*set_termios)(struct uart_port *, 37 struct ktermios *new, 38 struct ktermios *old); 39 int (*handle_irq)(struct uart_port *); 40 void (*pm)(struct uart_port *, unsigned int state, 41 unsigned old); 42 void (*handle_break)(struct uart_port *); 43 }; 44 45 /* 46 * Allocate 8250 platform device IDs. Nothing is implied by 47 * the numbering here, except for the legacy entry being -1. 48 */ 49 enum { 50 PLAT8250_DEV_LEGACY = -1, 51 PLAT8250_DEV_PLATFORM, 52 PLAT8250_DEV_PLATFORM1, 53 PLAT8250_DEV_PLATFORM2, 54 PLAT8250_DEV_FOURPORT, 55 PLAT8250_DEV_ACCENT, 56 PLAT8250_DEV_BOCA, 57 PLAT8250_DEV_EXAR_ST16C554, 58 PLAT8250_DEV_HUB6, 59 PLAT8250_DEV_AU1X00, 60 PLAT8250_DEV_SM501, 61 }; 62 63 struct uart_8250_dma; 64 struct uart_8250_port; 65 66 /** 67 * 8250 core driver operations 68 * 69 * @setup_irq() Setup irq handling. The universal 8250 driver links this 70 * port to the irq chain. Other drivers may @request_irq(). 71 * @release_irq() Undo irq handling. The universal 8250 driver unlinks 72 * the port from the irq chain. 73 */ 74 struct uart_8250_ops { 75 int (*setup_irq)(struct uart_8250_port *); 76 void (*release_irq)(struct uart_8250_port *); 77 }; 78 79 /* 80 * This should be used by drivers which want to register 81 * their own 8250 ports without registering their own 82 * platform device. Using these will make your driver 83 * dependent on the 8250 driver. 84 */ 85 86 struct uart_8250_port { 87 struct uart_port port; 88 struct timer_list timer; /* "no irq" timer */ 89 struct list_head list; /* ports on this IRQ */ 90 unsigned short capabilities; /* port capabilities */ 91 unsigned short bugs; /* port bugs */ 92 bool fifo_bug; /* min RX trigger if enabled */ 93 unsigned int tx_loadsz; /* transmit fifo load size */ 94 unsigned char acr; 95 unsigned char fcr; 96 unsigned char ier; 97 unsigned char lcr; 98 unsigned char mcr; 99 unsigned char mcr_mask; /* mask of user bits */ 100 unsigned char mcr_force; /* mask of forced bits */ 101 unsigned char cur_iotype; /* Running I/O type */ 102 unsigned int rpm_tx_active; 103 unsigned char canary; /* non-zero during system sleep 104 * if no_console_suspend 105 */ 106 unsigned char probe; 107 #define UART_PROBE_RSA (1 << 0) 108 109 /* 110 * Some bits in registers are cleared on a read, so they must 111 * be saved whenever the register is read but the bits will not 112 * be immediately processed. 113 */ 114 #define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS 115 unsigned char lsr_saved_flags; 116 #define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA 117 unsigned char msr_saved_flags; 118 119 struct uart_8250_dma *dma; 120 const struct uart_8250_ops *ops; 121 122 /* 8250 specific callbacks */ 123 int (*dl_read)(struct uart_8250_port *); 124 void (*dl_write)(struct uart_8250_port *, int); 125 }; 126 127 static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up) 128 { 129 return container_of(up, struct uart_8250_port, port); 130 } 131 132 int serial8250_register_8250_port(struct uart_8250_port *); 133 void serial8250_unregister_port(int line); 134 void serial8250_suspend_port(int line); 135 void serial8250_resume_port(int line); 136 137 extern int early_serial_setup(struct uart_port *port); 138 139 extern int early_serial8250_setup(struct earlycon_device *device, 140 const char *options); 141 extern void serial8250_do_set_termios(struct uart_port *port, 142 struct ktermios *termios, struct ktermios *old); 143 extern int serial8250_do_startup(struct uart_port *port); 144 extern void serial8250_do_shutdown(struct uart_port *port); 145 extern void serial8250_do_pm(struct uart_port *port, unsigned int state, 146 unsigned int oldstate); 147 extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl); 148 extern int fsl8250_handle_irq(struct uart_port *port); 149 int serial8250_handle_irq(struct uart_port *port, unsigned int iir); 150 unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr); 151 void serial8250_tx_chars(struct uart_8250_port *up); 152 unsigned int serial8250_modem_status(struct uart_8250_port *up); 153 void serial8250_init_port(struct uart_8250_port *up); 154 void serial8250_set_defaults(struct uart_8250_port *up); 155 void serial8250_console_write(struct uart_8250_port *up, const char *s, 156 unsigned int count); 157 int serial8250_console_setup(struct uart_port *port, char *options, bool probe); 158 159 extern void serial8250_set_isa_configurator(void (*v) 160 (int port, struct uart_port *up, 161 unsigned short *capabilities)); 162 163 #endif 164