blob: 6fc9d7bee05ee224eea58591f60a5d76140cd061 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Russell Kingd052d1b2005-10-29 19:07:23 +010015#include <linux/platform_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Russell Kingbc49a662005-09-01 15:56:26 +010017/*
18 * This is the platform device platform_data structure
19 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070020struct plat_serial8250_port {
21 unsigned long iobase; /* io base address */
22 void __iomem *membase; /* ioremap cookie or NULL */
Josh Boyer4f640ef2007-07-23 18:43:44 -070023 resource_size_t mapbase; /* resource base */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 unsigned int irq; /* interrupt number */
Vikram Pandita1c2f0492009-09-19 13:13:19 -070025 unsigned long irqflags; /* request_irq flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 unsigned int uartclk; /* UART clock rate */
Will Newton74a197412008-02-04 22:27:50 -080027 void *private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 unsigned char regshift; /* register shift */
29 unsigned char iotype; /* UPIO_* */
Russell Kingec9f47c2005-06-27 11:12:54 +010030 unsigned char hub6;
Russell King0077d452006-01-21 23:03:28 +000031 upf_t flags; /* UPF_* flags */
David Daney8e23fcc2009-01-02 13:49:54 +000032 unsigned int type; /* If UPF_FIXED_TYPE */
David Daney7d6a07d2009-01-02 13:49:47 +000033 unsigned int (*serial_in)(struct uart_port *, int);
34 void (*serial_out)(struct uart_port *, int, int);
Philippe Langlais235dae52010-07-29 17:13:57 +020035 void (*set_termios)(struct uart_port *,
36 struct ktermios *new,
37 struct ktermios *old);
Jamie Iles583d28e2011-08-15 10:17:52 +010038 int (*handle_irq)(struct uart_port *);
Manuel Laussc161afe2010-09-25 15:13:45 +020039 void (*pm)(struct uart_port *, unsigned int state,
40 unsigned old);
Dan Williamsbf03f652012-04-10 14:10:53 -070041 void (*handle_break)(struct uart_port *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042};
43
Russell Kingbc49a662005-09-01 15:56:26 +010044/*
Russell King6df29de2005-09-08 16:04:41 +010045 * Allocate 8250 platform device IDs. Nothing is implied by
46 * the numbering here, except for the legacy entry being -1.
47 */
48enum {
49 PLAT8250_DEV_LEGACY = -1,
50 PLAT8250_DEV_PLATFORM,
51 PLAT8250_DEV_PLATFORM1,
Lennert Buytenhek104c7b032006-03-25 23:03:13 +000052 PLAT8250_DEV_PLATFORM2,
Russell King6df29de2005-09-08 16:04:41 +010053 PLAT8250_DEV_FOURPORT,
54 PLAT8250_DEV_ACCENT,
55 PLAT8250_DEV_BOCA,
Paul B Schroedere0980da2006-12-06 20:37:03 -080056 PLAT8250_DEV_EXAR_ST16C554,
Russell King6df29de2005-09-08 16:04:41 +010057 PLAT8250_DEV_HUB6,
Pantelis Antoniou21c614a2005-11-06 09:07:03 +000058 PLAT8250_DEV_AU1X00,
Magnus Damm61711f82008-04-28 02:14:22 -070059 PLAT8250_DEV_SM501,
Russell King6df29de2005-09-08 16:04:41 +010060};
61
Heikki Krogerus9ee4b832013-01-10 11:25:11 +020062struct uart_8250_dma;
63
Russell King6df29de2005-09-08 16:04:41 +010064/*
Russell Kingbc49a662005-09-01 15:56:26 +010065 * 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 */
Alan Coxce7240e2012-07-17 17:06:20 +010070
71struct 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 */
Yoshihiro YUNOMAEaef9a7b2014-07-16 01:19:36 +000077 bool fifo_bug; /* min RX trigger if enabled */
Alan Coxce7240e2012-07-17 17:06:20 +010078 unsigned int tx_loadsz; /* transmit fifo load size */
79 unsigned char acr;
Yoshihiro YUNOMAEaef9a7b2014-07-16 01:19:36 +000080 unsigned char fcr;
Alan Coxce7240e2012-07-17 17:06:20 +010081 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
88 /*
89 * Some bits in registers are cleared on a read, so they must
90 * be saved whenever the register is read but the bits will not
91 * be immediately processed.
92 */
93#define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
94 unsigned char lsr_saved_flags;
95#define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
96 unsigned char msr_saved_flags;
97
Heikki Krogerus9ee4b832013-01-10 11:25:11 +020098 struct uart_8250_dma *dma;
Ricardo Ribalda Delgadoe6762532014-08-05 11:45:59 +020099 struct serial_rs485 rs485;
Heikki Krogerus9ee4b832013-01-10 11:25:11 +0200100
Alan Coxce7240e2012-07-17 17:06:20 +0100101 /* 8250 specific callbacks */
102 int (*dl_read)(struct uart_8250_port *);
103 void (*dl_write)(struct uart_8250_port *, int);
Ricardo Ribalda Delgadoe6762532014-08-05 11:45:59 +0200104 int (*rs485_config)(struct uart_8250_port *,
105 struct serial_rs485 *rs485);
Alan Coxce7240e2012-07-17 17:06:20 +0100106};
Russell Kingbc49a662005-09-01 15:56:26 +0100107
Andy Shevchenkob1261c82014-07-14 14:26:14 +0300108static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up)
109{
110 return container_of(up, struct uart_8250_port, port);
111}
112
Magnus Dammf73fa052012-05-02 21:47:27 +0900113int serial8250_register_8250_port(struct uart_8250_port *);
Russell Kingbc49a662005-09-01 15:56:26 +0100114void serial8250_unregister_port(int line);
115void serial8250_suspend_port(int line);
116void serial8250_resume_port(int line);
117
Yinghai Lub187f182007-07-18 00:49:10 -0700118extern int early_serial_setup(struct uart_port *port);
119
Yinghai Lu18a8bd92007-07-15 23:37:59 -0700120extern int serial8250_find_port(struct uart_port *p);
121extern int serial8250_find_port_for_earlycon(void);
Noam Camused718712012-11-16 07:03:05 +0200122extern unsigned int serial8250_early_in(struct uart_port *port, int offset);
123extern void serial8250_early_out(struct uart_port *port, int offset, int value);
Yinghai Lu18a8bd92007-07-15 23:37:59 -0700124extern int setup_early_serial8250_console(char *cmdline);
Philippe Langlais235dae52010-07-29 17:13:57 +0200125extern void serial8250_do_set_termios(struct uart_port *port,
126 struct ktermios *termios, struct ktermios *old);
Sebastian Andrzej Siewiorb99b1212014-09-05 21:02:37 +0200127extern int serial8250_do_startup(struct uart_port *port);
128extern void serial8250_do_shutdown(struct uart_port *port);
Manuel Laussc161afe2010-09-25 15:13:45 +0200129extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
130 unsigned int oldstate);
Paul Gortmaker9deaa532011-12-04 18:42:23 -0500131extern int fsl8250_handle_irq(struct uart_port *port);
Jamie Iles583d28e2011-08-15 10:17:52 +0100132int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
Paul Gortmaker3986fb22011-12-04 18:42:20 -0500133unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
134void serial8250_tx_chars(struct uart_8250_port *up);
135unsigned int serial8250_modem_status(struct uart_8250_port *up);
Yinghai Lu18a8bd92007-07-15 23:37:59 -0700136
Alan Coxaf7f3742010-10-18 11:38:02 -0700137extern void serial8250_set_isa_configurator(void (*v)
138 (int port, struct uart_port *up,
139 unsigned short *capabilities));
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141#endif